2 * Copyright (c) 2002-2007 Niels Provos <provos@citi.umich.edu>
3 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "event2/event-config.h"
29 #include "evconfig-private.h"
31 #ifdef EVENT__HAVE_SYS_PARAM_H
32 #include <sys/param.h>
34 #ifdef EVENT__HAVE_SYS_TYPES_H
35 #include <sys/types.h>
38 #ifdef HAVE_SYS_IOCCOM_H
39 #include <sys/ioccom.h>
41 #ifdef EVENT__HAVE_SYS_RESOURCE_H
42 #include <sys/resource.h>
44 #ifdef EVENT__HAVE_SYS_TIME_H
47 #ifdef EVENT__HAVE_SYS_WAIT_H
52 #include <sys/socket.h>
59 #include <sys/queue.h>
61 #ifdef EVENT__HAVE_NETINET_IN_H
62 #include <netinet/in.h>
64 #ifdef EVENT__HAVE_ARPA_INET_H
65 #include <arpa/inet.h>
67 #ifdef EVENT__HAVE_NETDB_H
84 #ifdef EVENT__HAVE_UNISTD_H
87 #ifdef EVENT__HAVE_FCNTL_H
91 #undef timeout_pending
92 #undef timeout_initialized
94 #include "strlcpy-internal.h"
95 #include "event2/http.h"
96 #include "event2/event.h"
97 #include "event2/buffer.h"
98 #include "event2/bufferevent.h"
99 #include "event2/http_struct.h"
100 #include "event2/http_compat.h"
101 #include "event2/util.h"
102 #include "event2/listener.h"
103 #include "log-internal.h"
104 #include "util-internal.h"
105 #include "http-internal.h"
106 #include "mm-internal.h"
107 #include "bufferevent-internal.h"
109 #ifndef EVENT__HAVE_GETNAMEINFO
110 #define NI_MAXSERV 32
111 #define NI_MAXHOST 1025
113 #ifndef NI_NUMERICHOST
114 #define NI_NUMERICHOST 1
117 #ifndef NI_NUMERICSERV
118 #define NI_NUMERICSERV 2
122 fake_getnameinfo(const struct sockaddr *sa, size_t salen, char *host,
123 size_t hostlen, char *serv, size_t servlen, int flags)
125 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
129 evutil_snprintf(tmpserv, sizeof(tmpserv),
130 "%d", ntohs(sin->sin_port));
131 if (strlcpy(serv, tmpserv, servlen) >= servlen)
136 if (flags & NI_NUMERICHOST) {
137 if (strlcpy(host, inet_ntoa(sin->sin_addr),
144 hp = gethostbyaddr((char *)&sin->sin_addr,
145 sizeof(struct in_addr), AF_INET);
149 if (strlcpy(host, hp->h_name, hostlen) >= hostlen)
160 #define REQ_VERSION_BEFORE(req, major_v, minor_v) \
161 ((req)->major < (major_v) || \
162 ((req)->major == (major_v) && (req)->minor < (minor_v)))
164 #define REQ_VERSION_ATLEAST(req, major_v, minor_v) \
165 ((req)->major > (major_v) || \
166 ((req)->major == (major_v) && (req)->minor >= (minor_v)))
169 #define MIN(a,b) (((a)<(b))?(a):(b))
174 static evutil_socket_t bind_socket_ai(struct evutil_addrinfo *, int reuse);
175 static evutil_socket_t bind_socket(const char *, ev_uint16_t, int reuse);
176 static void name_from_addr(struct sockaddr *, ev_socklen_t, char **, char **);
177 static int evhttp_associate_new_request_with_connection(
178 struct evhttp_connection *evcon);
179 static void evhttp_connection_start_detectclose(
180 struct evhttp_connection *evcon);
181 static void evhttp_connection_stop_detectclose(
182 struct evhttp_connection *evcon);
183 static void evhttp_request_dispatch(struct evhttp_connection* evcon);
184 static void evhttp_read_firstline(struct evhttp_connection *evcon,
185 struct evhttp_request *req);
186 static void evhttp_read_header(struct evhttp_connection *evcon,
187 struct evhttp_request *req);
188 static int evhttp_add_header_internal(struct evkeyvalq *headers,
189 const char *key, const char *value);
190 static const char *evhttp_response_phrase_internal(int code);
191 static void evhttp_get_request(struct evhttp *, evutil_socket_t, struct sockaddr *, ev_socklen_t);
192 static void evhttp_write_buffer(struct evhttp_connection *,
193 void (*)(struct evhttp_connection *, void *), void *);
194 static void evhttp_make_header(struct evhttp_connection *, struct evhttp_request *);
196 /* callbacks for bufferevent */
197 static void evhttp_read_cb(struct bufferevent *, void *);
198 static void evhttp_write_cb(struct bufferevent *, void *);
199 static void evhttp_error_cb(struct bufferevent *bufev, short what, void *arg);
200 static int evhttp_find_vhost(struct evhttp *http, struct evhttp **outhttp,
201 const char *hostname);
203 #ifndef EVENT__HAVE_STRSEP
204 /* strsep replacement for platforms that lack it. Only works if
205 * del is one character long. */
207 strsep(char **s, const char *del)
210 EVUTIL_ASSERT(strlen(del) == 1);
214 d = strstr(tok, del);
225 html_replace(const char ch, const char **escaped)
251 * Replaces <, >, ", ' and & with <, >, ",
252 * ' and & correspondingly.
254 * The returned string needs to be freed by the caller.
258 evhttp_htmlescape(const char *html)
261 size_t new_size = 0, old_size = 0;
262 char *escaped_html, *p;
267 old_size = strlen(html);
268 for (i = 0; i < old_size; ++i) {
269 const char *replaced = NULL;
270 const size_t replace_size = html_replace(html[i], &replaced);
271 if (replace_size > EV_SIZE_MAX - new_size) {
272 event_warn("%s: html_replace overflow", __func__);
275 new_size += replace_size;
278 if (new_size == EV_SIZE_MAX)
280 p = escaped_html = mm_malloc(new_size + 1);
281 if (escaped_html == NULL) {
282 event_warn("%s: malloc(%lu)", __func__,
283 (unsigned long)(new_size + 1));
286 for (i = 0; i < old_size; ++i) {
287 const char *replaced = &html[i];
288 const size_t len = html_replace(html[i], &replaced);
289 memcpy(p, replaced, len);
295 return (escaped_html);
298 /** Given an evhttp_cmd_type, returns a constant string containing the
299 * equivalent HTTP command, or NULL if the evhttp_command_type is
302 evhttp_method(enum evhttp_cmd_type type)
310 case EVHTTP_REQ_POST:
313 case EVHTTP_REQ_HEAD:
319 case EVHTTP_REQ_DELETE:
322 case EVHTTP_REQ_OPTIONS:
325 case EVHTTP_REQ_TRACE:
328 case EVHTTP_REQ_CONNECT:
331 case EVHTTP_REQ_PATCH:
343 * Determines if a response should have a body.
344 * Follows the rules in RFC 2616 section 4.3.
345 * @return 1 if the response MUST have a body; 0 if the response MUST NOT have
349 evhttp_response_needs_body(struct evhttp_request *req)
351 return (req->response_code != HTTP_NOCONTENT &&
352 req->response_code != HTTP_NOTMODIFIED &&
353 (req->response_code < 100 || req->response_code >= 200) &&
354 req->type != EVHTTP_REQ_HEAD);
357 /** Helper: called after we've added some data to an evcon's bufferevent's
358 * output buffer. Sets the evconn's writing-is-done callback, and puts
359 * the bufferevent into writing mode.
362 evhttp_write_buffer(struct evhttp_connection *evcon,
363 void (*cb)(struct evhttp_connection *, void *), void *arg)
365 event_debug(("%s: preparing to write buffer\n", __func__));
371 /* Disable the read callback: we don't actually care about data;
372 * we only care about close detection. (We don't disable reading,
373 * since we *do* want to learn about any close events.) */
374 bufferevent_setcb(evcon->bufev,
380 bufferevent_enable(evcon->bufev, EV_WRITE);
384 evhttp_send_continue_done(struct evhttp_connection *evcon, void *arg)
386 bufferevent_disable(evcon->bufev, EV_WRITE);
390 evhttp_send_continue(struct evhttp_connection *evcon,
391 struct evhttp_request *req)
393 bufferevent_enable(evcon->bufev, EV_WRITE);
394 evbuffer_add_printf(bufferevent_get_output(evcon->bufev),
395 "HTTP/%d.%d 100 Continue\r\n\r\n",
396 req->major, req->minor);
397 evcon->cb = evhttp_send_continue_done;
398 evcon->cb_arg = NULL;
399 bufferevent_setcb(evcon->bufev,
406 /** Helper: returns true iff evconn is in any connected state. */
408 evhttp_connected(struct evhttp_connection *evcon)
410 switch (evcon->state) {
411 case EVCON_DISCONNECTED:
412 case EVCON_CONNECTING:
415 case EVCON_READING_FIRSTLINE:
416 case EVCON_READING_HEADERS:
417 case EVCON_READING_BODY:
418 case EVCON_READING_TRAILER:
425 /* Create the headers needed for an outgoing HTTP request, adds them to
426 * the request's header list, and writes the request line to the
427 * connection's output buffer.
430 evhttp_make_header_request(struct evhttp_connection *evcon,
431 struct evhttp_request *req)
435 evhttp_remove_header(req->output_headers, "Proxy-Connection");
437 /* Generate request line */
438 method = evhttp_method(req->type);
439 evbuffer_add_printf(bufferevent_get_output(evcon->bufev),
440 "%s %s HTTP/%d.%d\r\n",
441 method, req->uri, req->major, req->minor);
443 /* Add the content length on a post or put request if missing */
444 if ((req->type == EVHTTP_REQ_POST || req->type == EVHTTP_REQ_PUT) &&
445 evhttp_find_header(req->output_headers, "Content-Length") == NULL){
447 evutil_snprintf(size, sizeof(size), EV_SIZE_FMT,
448 EV_SIZE_ARG(evbuffer_get_length(req->output_buffer)));
449 evhttp_add_header(req->output_headers, "Content-Length", size);
453 /** Return true if the list of headers in 'headers', intepreted with respect
454 * to flags, means that we should send a "connection: close" when the request
457 evhttp_is_connection_close(int flags, struct evkeyvalq* headers)
459 if (flags & EVHTTP_PROXY_REQUEST) {
460 /* proxy connection */
461 const char *connection = evhttp_find_header(headers, "Proxy-Connection");
462 return (connection == NULL || evutil_ascii_strcasecmp(connection, "keep-alive") != 0);
464 const char *connection = evhttp_find_header(headers, "Connection");
465 return (connection != NULL && evutil_ascii_strcasecmp(connection, "close") == 0);
469 evhttp_is_request_connection_close(struct evhttp_request *req)
472 evhttp_is_connection_close(req->flags, req->input_headers) ||
473 evhttp_is_connection_close(req->flags, req->output_headers);
476 /* Return true iff 'headers' contains 'Connection: keep-alive' */
478 evhttp_is_connection_keepalive(struct evkeyvalq* headers)
480 const char *connection = evhttp_find_header(headers, "Connection");
481 return (connection != NULL
482 && evutil_ascii_strncasecmp(connection, "keep-alive", 10) == 0);
485 /* Add a correct "Date" header to headers, unless it already has one. */
487 evhttp_maybe_add_date_header(struct evkeyvalq *headers)
489 if (evhttp_find_header(headers, "Date") == NULL) {
495 time_t t = time(NULL);
502 if (strftime(date, sizeof(date),
503 "%a, %d %b %Y %H:%M:%S GMT", cur_p) != 0) {
504 evhttp_add_header(headers, "Date", date);
509 /* Add a "Content-Length" header with value 'content_length' to headers,
510 * unless it already has a content-length or transfer-encoding header. */
512 evhttp_maybe_add_content_length_header(struct evkeyvalq *headers,
513 size_t content_length)
515 if (evhttp_find_header(headers, "Transfer-Encoding") == NULL &&
516 evhttp_find_header(headers, "Content-Length") == NULL) {
518 evutil_snprintf(len, sizeof(len), EV_SIZE_FMT,
519 EV_SIZE_ARG(content_length));
520 evhttp_add_header(headers, "Content-Length", len);
525 * Create the headers needed for an HTTP reply in req->output_headers,
526 * and write the first HTTP response for req line to evcon.
529 evhttp_make_header_response(struct evhttp_connection *evcon,
530 struct evhttp_request *req)
532 int is_keepalive = evhttp_is_connection_keepalive(req->input_headers);
533 evbuffer_add_printf(bufferevent_get_output(evcon->bufev),
534 "HTTP/%d.%d %d %s\r\n",
535 req->major, req->minor, req->response_code,
536 req->response_code_line);
538 if (req->major == 1) {
540 evhttp_maybe_add_date_header(req->output_headers);
543 * if the protocol is 1.0; and the connection was keep-alive
544 * we need to add a keep-alive header, too.
546 if (req->minor == 0 && is_keepalive)
547 evhttp_add_header(req->output_headers,
548 "Connection", "keep-alive");
550 if ((req->minor >= 1 || is_keepalive) &&
551 evhttp_response_needs_body(req)) {
553 * we need to add the content length if the
554 * user did not give it, this is required for
555 * persistent connections to work.
557 evhttp_maybe_add_content_length_header(
559 evbuffer_get_length(req->output_buffer));
563 /* Potentially add headers for unidentified content. */
564 if (evhttp_response_needs_body(req)) {
565 if (evhttp_find_header(req->output_headers,
566 "Content-Type") == NULL
567 && evcon->http_server->default_content_type) {
568 evhttp_add_header(req->output_headers,
570 evcon->http_server->default_content_type);
574 /* if the request asked for a close, we send a close, too */
575 if (evhttp_is_connection_close(req->flags, req->input_headers)) {
576 evhttp_remove_header(req->output_headers, "Connection");
577 if (!(req->flags & EVHTTP_PROXY_REQUEST))
578 evhttp_add_header(req->output_headers, "Connection", "close");
579 evhttp_remove_header(req->output_headers, "Proxy-Connection");
583 /** Generate all headers appropriate for sending the http request in req (or
584 * the response, if we're sending a response), and write them to evcon's
585 * bufferevent. Also writes all data from req->output_buffer */
587 evhttp_make_header(struct evhttp_connection *evcon, struct evhttp_request *req)
589 struct evkeyval *header;
590 struct evbuffer *output = bufferevent_get_output(evcon->bufev);
593 * Depending if this is a HTTP request or response, we might need to
594 * add some new headers or remove existing headers.
596 if (req->kind == EVHTTP_REQUEST) {
597 evhttp_make_header_request(evcon, req);
599 evhttp_make_header_response(evcon, req);
602 TAILQ_FOREACH(header, req->output_headers, next) {
603 evbuffer_add_printf(output, "%s: %s\r\n",
604 header->key, header->value);
606 evbuffer_add(output, "\r\n", 2);
608 if (evbuffer_get_length(req->output_buffer) > 0) {
610 * For a request, we add the POST data, for a reply, this
611 * is the regular data.
613 /* XXX We might want to support waiting (a limited amount of
614 time) for a continue status line from the server before
615 sending POST/PUT message bodies. */
616 evbuffer_add_buffer(output, req->output_buffer);
621 evhttp_connection_set_max_headers_size(struct evhttp_connection *evcon,
622 ev_ssize_t new_max_headers_size)
624 if (new_max_headers_size<0)
625 evcon->max_headers_size = EV_SIZE_MAX;
627 evcon->max_headers_size = new_max_headers_size;
630 evhttp_connection_set_max_body_size(struct evhttp_connection* evcon,
631 ev_ssize_t new_max_body_size)
633 if (new_max_body_size<0)
634 evcon->max_body_size = EV_UINT64_MAX;
636 evcon->max_body_size = new_max_body_size;
640 evhttp_connection_incoming_fail(struct evhttp_request *req,
641 enum evhttp_request_error error)
644 case EVREQ_HTTP_DATA_TOO_LONG:
645 req->response_code = HTTP_ENTITYTOOLARGE;
648 req->response_code = HTTP_BADREQUEST;
652 case EVREQ_HTTP_TIMEOUT:
655 * these are cases in which we probably should just
656 * close the connection and not send a reply. this
657 * case may happen when a browser keeps a persistent
658 * connection open and we timeout on the read. when
659 * the request is still being used for sending, we
660 * need to disassociated it from the connection here.
662 if (!req->userdone) {
663 /* remove it so that it will not be freed */
664 TAILQ_REMOVE(&req->evcon->requests, req, next);
665 /* indicate that this request no longer has a
671 case EVREQ_HTTP_INVALID_HEADER:
672 case EVREQ_HTTP_BUFFER_ERROR:
673 case EVREQ_HTTP_REQUEST_CANCEL:
674 case EVREQ_HTTP_DATA_TOO_LONG:
675 default: /* xxx: probably should just error on default */
676 /* the callback looks at the uri to determine errors */
681 if (req->uri_elems) {
682 evhttp_uri_free(req->uri_elems);
683 req->uri_elems = NULL;
687 * the callback needs to send a reply, once the reply has
688 * been send, the connection should get freed.
690 (*req->cb)(req, req->cb_arg);
696 /* Free connection ownership of which can be acquired by user using
697 * evhttp_request_own(). */
699 evhttp_request_free_auto(struct evhttp_request *req)
701 if (!(req->flags & EVHTTP_USER_OWNED))
702 evhttp_request_free(req);
706 evhttp_request_free_(struct evhttp_connection *evcon, struct evhttp_request *req)
708 TAILQ_REMOVE(&evcon->requests, req, next);
709 evhttp_request_free_auto(req);
712 /* Called when evcon has experienced a (non-recoverable? -NM) error, as
713 * given in error. If it's an outgoing connection, reset the connection,
714 * retry any pending requests, and inform the user. If it's incoming,
715 * delegates to evhttp_connection_incoming_fail(). */
717 evhttp_connection_fail_(struct evhttp_connection *evcon,
718 enum evhttp_request_error error)
720 const int errsave = EVUTIL_SOCKET_ERROR();
721 struct evhttp_request* req = TAILQ_FIRST(&evcon->requests);
722 void (*cb)(struct evhttp_request *, void *);
724 void (*error_cb)(enum evhttp_request_error, void *);
726 EVUTIL_ASSERT(req != NULL);
728 bufferevent_disable(evcon->bufev, EV_READ|EV_WRITE);
730 if (evcon->flags & EVHTTP_CON_INCOMING) {
732 * for incoming requests, there are two different
733 * failure cases. it's either a network level error
734 * or an http layer error. for problems on the network
735 * layer like timeouts we just drop the connections.
736 * For HTTP problems, we might have to send back a
737 * reply before the connection can be freed.
739 if (evhttp_connection_incoming_fail(req, error) == -1)
740 evhttp_connection_free(evcon);
744 error_cb = req->error_cb;
745 error_cb_arg = req->cb_arg;
746 /* when the request was canceled, the callback is not executed */
747 if (error != EVREQ_HTTP_REQUEST_CANCEL) {
748 /* save the callback for later; the cb might free our object */
750 cb_arg = req->cb_arg;
756 /* do not fail all requests; the next request is going to get
757 * send over a new connection. when a user cancels a request,
758 * all other pending requests should be processed as normal
760 evhttp_request_free_(evcon, req);
762 /* reset the connection */
763 evhttp_connection_reset_(evcon);
765 /* We are trying the next request that was queued on us */
766 if (TAILQ_FIRST(&evcon->requests) != NULL)
767 evhttp_connection_connect_(evcon);
769 /* The call to evhttp_connection_reset_ overwrote errno.
770 * Let's restore the original errno, so that the user's
771 * callback can have a better idea of what the error was.
773 EVUTIL_SET_SOCKET_ERROR(errsave);
775 /* inform the user */
776 if (error_cb != NULL)
777 error_cb(error, error_cb_arg);
782 /* Bufferevent callback: invoked when any data has been written from an
783 * http connection's bufferevent */
785 evhttp_write_cb(struct bufferevent *bufev, void *arg)
787 struct evhttp_connection *evcon = arg;
789 /* Activate our call back */
790 if (evcon->cb != NULL)
791 (*evcon->cb)(evcon, evcon->cb_arg);
795 * Advance the connection state.
796 * - If this is an outgoing connection, we've just processed the response;
797 * idle or close the connection.
798 * - If this is an incoming connection, we've just processed the request;
802 evhttp_connection_done(struct evhttp_connection *evcon)
804 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
805 int con_outgoing = evcon->flags & EVHTTP_CON_OUTGOING;
809 /* idle or close the connection */
810 int need_close = evhttp_is_request_connection_close(req);
811 TAILQ_REMOVE(&evcon->requests, req, next);
814 evcon->state = EVCON_IDLE;
816 /* check if we got asked to close the connection */
818 evhttp_connection_reset_(evcon);
820 if (TAILQ_FIRST(&evcon->requests) != NULL) {
822 * We have more requests; reset the connection
823 * and deal with the next request.
825 if (!evhttp_connected(evcon))
826 evhttp_connection_connect_(evcon);
828 evhttp_request_dispatch(evcon);
829 } else if (!need_close) {
831 * The connection is going to be persistent, but we
832 * need to detect if the other side closes it.
834 evhttp_connection_start_detectclose(evcon);
835 } else if ((evcon->flags & EVHTTP_CON_AUTOFREE)) {
837 * If we have no more requests that need completion
838 * and we're not waiting for the connection to close
844 * incoming connection - we need to leave the request on the
845 * connection so that we can reply to it.
847 evcon->state = EVCON_WRITING;
850 /* notify the user of the request */
851 (*req->cb)(req, req->cb_arg);
853 /* if this was an outgoing request, we own and it's done. so free it. */
855 evhttp_request_free_auto(req);
858 /* If this was the last request of an outgoing connection and we're
859 * not waiting to receive a connection close event and we want to
860 * automatically free the connection. We check to ensure our request
861 * list is empty one last time just in case our callback added a
864 if (free_evcon && TAILQ_FIRST(&evcon->requests) == NULL) {
865 evhttp_connection_free(evcon);
870 * Handles reading from a chunked request.
871 * return ALL_DATA_READ:
872 * all data has been read
873 * return MORE_DATA_EXPECTED:
874 * more data is expected
875 * return DATA_CORRUPTED:
877 * return REQUEST_CANCELED:
878 * request was canceled by the user calling evhttp_cancel_request
879 * return DATA_TOO_LONG:
880 * ran over the maximum limit
883 static enum message_read_status
884 evhttp_handle_chunked_read(struct evhttp_request *req, struct evbuffer *buf)
886 if (req == NULL || buf == NULL) {
887 return DATA_CORRUPTED;
893 if ((buflen = evbuffer_get_length(buf)) == 0) {
897 /* evbuffer_get_length returns size_t, but len variable is ssize_t,
898 * check for overflow conditions */
899 if (buflen > EV_SSIZE_MAX) {
900 return DATA_CORRUPTED;
903 if (req->ntoread < 0) {
904 /* Read chunk size */
906 char *p = evbuffer_readln(buf, NULL, EVBUFFER_EOL_CRLF);
911 /* the last chunk is on a new line? */
912 if (strlen(p) == 0) {
916 ntoread = evutil_strtoll(p, &endp, 16);
917 error = (*p == '\0' ||
918 (*endp != '\0' && *endp != ' ') ||
922 /* could not get chunk size */
923 return (DATA_CORRUPTED);
926 /* ntoread is signed int64, body_size is unsigned size_t, check for under/overflow conditions */
927 if ((ev_uint64_t)ntoread > EV_SIZE_MAX - req->body_size) {
928 return DATA_CORRUPTED;
931 if (req->body_size + (size_t)ntoread > req->evcon->max_body_size) {
932 /* failed body length test */
933 event_debug(("Request body is too long"));
934 return (DATA_TOO_LONG);
937 req->body_size += (size_t)ntoread;
938 req->ntoread = ntoread;
939 if (req->ntoread == 0) {
941 return (ALL_DATA_READ);
946 /* req->ntoread is signed int64, len is ssize_t, based on arch,
947 * ssize_t could only be 32b, check for these conditions */
948 if (req->ntoread > EV_SSIZE_MAX) {
949 return DATA_CORRUPTED;
952 /* don't have enough to complete a chunk; wait for more */
953 if (req->ntoread > 0 && buflen < (ev_uint64_t)req->ntoread)
954 return (MORE_DATA_EXPECTED);
956 /* Completed chunk */
957 evbuffer_remove_buffer(buf, req->input_buffer, (size_t)req->ntoread);
959 if (req->chunk_cb != NULL) {
960 req->flags |= EVHTTP_REQ_DEFER_FREE;
961 (*req->chunk_cb)(req, req->cb_arg);
962 evbuffer_drain(req->input_buffer,
963 evbuffer_get_length(req->input_buffer));
964 req->flags &= ~EVHTTP_REQ_DEFER_FREE;
965 if ((req->flags & EVHTTP_REQ_NEEDS_FREE) != 0) {
966 return (REQUEST_CANCELED);
971 return (MORE_DATA_EXPECTED);
975 evhttp_read_trailer(struct evhttp_connection *evcon, struct evhttp_request *req)
977 struct evbuffer *buf = bufferevent_get_input(evcon->bufev);
979 switch (evhttp_parse_headers_(req, buf)) {
982 evhttp_connection_fail_(evcon, EVREQ_HTTP_DATA_TOO_LONG);
985 bufferevent_disable(evcon->bufev, EV_READ);
986 evhttp_connection_done(evcon);
988 case MORE_DATA_EXPECTED:
989 case REQUEST_CANCELED: /* ??? */
996 evhttp_lingering_close(struct evhttp_connection *evcon,
997 struct evhttp_request *req)
999 struct evbuffer *buf = bufferevent_get_input(evcon->bufev);
1001 size_t n = evbuffer_get_length(buf);
1002 if (n > (size_t) req->ntoread)
1003 n = (size_t) req->ntoread;
1005 req->body_size += n;
1007 event_debug(("Request body is too long, left " EV_SIZE_FMT,
1008 EV_SIZE_ARG(req->ntoread)));
1010 evbuffer_drain(buf, n);
1012 evhttp_connection_fail_(evcon, EVREQ_HTTP_DATA_TOO_LONG);
1015 evhttp_lingering_fail(struct evhttp_connection *evcon,
1016 struct evhttp_request *req)
1018 if (evcon->flags & EVHTTP_CON_LINGERING_CLOSE)
1019 evhttp_lingering_close(evcon, req);
1021 evhttp_connection_fail_(evcon, EVREQ_HTTP_DATA_TOO_LONG);
1025 evhttp_read_body(struct evhttp_connection *evcon, struct evhttp_request *req)
1027 struct evbuffer *buf = bufferevent_get_input(evcon->bufev);
1030 switch (evhttp_handle_chunked_read(req, buf)) {
1032 /* finished last chunk */
1033 evcon->state = EVCON_READING_TRAILER;
1034 evhttp_read_trailer(evcon, req);
1036 case DATA_CORRUPTED:
1038 /* corrupted data */
1039 evhttp_connection_fail_(evcon,
1040 EVREQ_HTTP_DATA_TOO_LONG);
1042 case REQUEST_CANCELED:
1043 /* request canceled */
1044 evhttp_request_free_auto(req);
1046 case MORE_DATA_EXPECTED:
1050 } else if (req->ntoread < 0) {
1051 /* Read until connection close. */
1052 if ((size_t)(req->body_size + evbuffer_get_length(buf)) < req->body_size) {
1053 evhttp_connection_fail_(evcon, EVREQ_HTTP_INVALID_HEADER);
1057 req->body_size += evbuffer_get_length(buf);
1058 evbuffer_add_buffer(req->input_buffer, buf);
1059 } else if (req->chunk_cb != NULL || evbuffer_get_length(buf) >= (size_t)req->ntoread) {
1060 /* XXX: the above get_length comparison has to be fixed for overflow conditions! */
1061 /* We've postponed moving the data until now, but we're
1062 * about to use it. */
1063 size_t n = evbuffer_get_length(buf);
1065 if (n > (size_t) req->ntoread)
1066 n = (size_t) req->ntoread;
1068 req->body_size += n;
1069 evbuffer_remove_buffer(buf, req->input_buffer, n);
1072 if (req->body_size > req->evcon->max_body_size ||
1073 (!req->chunked && req->ntoread >= 0 &&
1074 (size_t)req->ntoread > req->evcon->max_body_size)) {
1075 /* XXX: The above casted comparison must checked for overflow */
1076 /* failed body length test */
1078 evhttp_lingering_fail(evcon, req);
1082 if (evbuffer_get_length(req->input_buffer) > 0 && req->chunk_cb != NULL) {
1083 req->flags |= EVHTTP_REQ_DEFER_FREE;
1084 (*req->chunk_cb)(req, req->cb_arg);
1085 req->flags &= ~EVHTTP_REQ_DEFER_FREE;
1086 evbuffer_drain(req->input_buffer,
1087 evbuffer_get_length(req->input_buffer));
1088 if ((req->flags & EVHTTP_REQ_NEEDS_FREE) != 0) {
1089 evhttp_request_free_auto(req);
1094 if (!req->ntoread) {
1095 bufferevent_disable(evcon->bufev, EV_READ);
1096 /* Completed content length */
1097 evhttp_connection_done(evcon);
1102 #define get_deferred_queue(evcon) \
1106 * Gets called when more data becomes available
1110 evhttp_read_cb(struct bufferevent *bufev, void *arg)
1112 struct evhttp_connection *evcon = arg;
1113 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
1115 /* Cancel if it's pending. */
1116 event_deferred_cb_cancel_(get_deferred_queue(evcon),
1117 &evcon->read_more_deferred_cb);
1119 switch (evcon->state) {
1120 case EVCON_READING_FIRSTLINE:
1121 evhttp_read_firstline(evcon, req);
1122 /* note the request may have been freed in
1123 * evhttp_read_body */
1125 case EVCON_READING_HEADERS:
1126 evhttp_read_header(evcon, req);
1127 /* note the request may have been freed in
1128 * evhttp_read_body */
1130 case EVCON_READING_BODY:
1131 evhttp_read_body(evcon, req);
1132 /* note the request may have been freed in
1133 * evhttp_read_body */
1135 case EVCON_READING_TRAILER:
1136 evhttp_read_trailer(evcon, req);
1141 struct evbuffer *input;
1144 input = bufferevent_get_input(evcon->bufev);
1145 total_len = evbuffer_get_length(input);
1146 event_debug(("%s: read "EV_SIZE_FMT
1147 " bytes in EVCON_IDLE state,"
1148 " resetting connection",
1149 __func__, EV_SIZE_ARG(total_len)));
1152 evhttp_connection_reset_(evcon);
1155 case EVCON_DISCONNECTED:
1156 case EVCON_CONNECTING:
1159 event_errx(1, "%s: illegal connection state %d",
1160 __func__, evcon->state);
1165 evhttp_deferred_read_cb(struct event_callback *cb, void *data)
1167 struct evhttp_connection *evcon = data;
1168 evhttp_read_cb(evcon->bufev, evcon);
1172 evhttp_write_connectioncb(struct evhttp_connection *evcon, void *arg)
1174 /* This is after writing the request to the server */
1175 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
1176 EVUTIL_ASSERT(req != NULL);
1178 EVUTIL_ASSERT(evcon->state == EVCON_WRITING);
1180 /* We need to wait until we've written all of our output data before we can continue */
1181 if (evbuffer_get_length(bufferevent_get_output(evcon->bufev)) > 0) { return; }
1183 /* We are done writing our header and are now expecting the response */
1184 req->kind = EVHTTP_RESPONSE;
1186 evhttp_start_read_(evcon);
1190 * Clean up a connection object
1194 evhttp_connection_free(struct evhttp_connection *evcon)
1196 struct evhttp_request *req;
1198 /* notify interested parties that this connection is going down */
1199 if (evcon->fd != -1) {
1200 if (evhttp_connected(evcon) && evcon->closecb != NULL)
1201 (*evcon->closecb)(evcon, evcon->closecb_arg);
1204 /* remove all requests that might be queued on this
1205 * connection. for server connections, this should be empty.
1206 * because it gets dequeued either in evhttp_connection_done or
1207 * evhttp_connection_fail_.
1209 while ((req = TAILQ_FIRST(&evcon->requests)) != NULL) {
1210 evhttp_request_free_(evcon, req);
1213 if (evcon->http_server != NULL) {
1214 struct evhttp *http = evcon->http_server;
1215 TAILQ_REMOVE(&http->connections, evcon, next);
1218 if (event_initialized(&evcon->retry_ev)) {
1219 event_del(&evcon->retry_ev);
1220 event_debug_unassign(&evcon->retry_ev);
1223 if (evcon->bufev != NULL)
1224 bufferevent_free(evcon->bufev);
1226 event_deferred_cb_cancel_(get_deferred_queue(evcon),
1227 &evcon->read_more_deferred_cb);
1229 if (evcon->fd != -1) {
1230 bufferevent_disable(evcon->bufev, EV_READ|EV_WRITE);
1231 shutdown(evcon->fd, EVUTIL_SHUT_WR);
1232 if (!(bufferevent_get_options_(evcon->bufev) & BEV_OPT_CLOSE_ON_FREE)) {
1233 evutil_closesocket(evcon->fd);
1237 if (evcon->bind_address != NULL)
1238 mm_free(evcon->bind_address);
1240 if (evcon->address != NULL)
1241 mm_free(evcon->address);
1247 evhttp_connection_free_on_completion(struct evhttp_connection *evcon) {
1248 evcon->flags |= EVHTTP_CON_AUTOFREE;
1252 evhttp_connection_set_local_address(struct evhttp_connection *evcon,
1253 const char *address)
1255 EVUTIL_ASSERT(evcon->state == EVCON_DISCONNECTED);
1256 if (evcon->bind_address)
1257 mm_free(evcon->bind_address);
1258 if ((evcon->bind_address = mm_strdup(address)) == NULL)
1259 event_warn("%s: strdup", __func__);
1263 evhttp_connection_set_local_port(struct evhttp_connection *evcon,
1266 EVUTIL_ASSERT(evcon->state == EVCON_DISCONNECTED);
1267 evcon->bind_port = port;
1271 evhttp_request_dispatch(struct evhttp_connection* evcon)
1273 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
1275 /* this should not usually happy but it's possible */
1279 /* delete possible close detection events */
1280 evhttp_connection_stop_detectclose(evcon);
1282 /* we assume that the connection is connected already */
1283 EVUTIL_ASSERT(evcon->state == EVCON_IDLE);
1285 evcon->state = EVCON_WRITING;
1287 /* Create the header from the store arguments */
1288 evhttp_make_header(evcon, req);
1290 evhttp_write_buffer(evcon, evhttp_write_connectioncb, NULL);
1293 /* Reset our connection state: disables reading/writing, closes our fd (if
1294 * any), clears out buffers, and puts us in state DISCONNECTED. */
1296 evhttp_connection_reset_(struct evhttp_connection *evcon)
1298 struct evbuffer *tmp;
1300 /* XXXX This is not actually an optimal fix. Instead we ought to have
1301 an API for "stop connecting", or use bufferevent_setfd to turn off
1302 connecting. But for Libevent 2.0, this seems like a minimal change
1303 least likely to disrupt the rest of the bufferevent and http code.
1305 Why is this here? If the fd is set in the bufferevent, and the
1306 bufferevent is connecting, then you can't actually stop the
1307 bufferevent from trying to connect with bufferevent_disable(). The
1308 connect will never trigger, since we close the fd, but the timeout
1309 might. That caused an assertion failure in evhttp_connection_fail_.
1311 bufferevent_disable_hard_(evcon->bufev, EV_READ|EV_WRITE);
1313 if (evcon->fd != -1) {
1314 /* inform interested parties about connection close */
1315 if (evhttp_connected(evcon) && evcon->closecb != NULL)
1316 (*evcon->closecb)(evcon, evcon->closecb_arg);
1318 shutdown(evcon->fd, EVUTIL_SHUT_WR);
1319 evutil_closesocket(evcon->fd);
1320 bufferevent_setfd(evcon->bufev, -1);
1324 /* we need to clean up any buffered data */
1325 tmp = bufferevent_get_output(evcon->bufev);
1326 EVUTIL_ASSERT(!evbuffer_drain(tmp, -1));
1327 tmp = bufferevent_get_input(evcon->bufev);
1328 EVUTIL_ASSERT(!evbuffer_drain(tmp, -1));
1330 evcon->state = EVCON_DISCONNECTED;
1334 evhttp_connection_start_detectclose(struct evhttp_connection *evcon)
1336 evcon->flags |= EVHTTP_CON_CLOSEDETECT;
1338 bufferevent_enable(evcon->bufev, EV_READ);
1342 evhttp_connection_stop_detectclose(struct evhttp_connection *evcon)
1344 evcon->flags &= ~EVHTTP_CON_CLOSEDETECT;
1346 bufferevent_disable(evcon->bufev, EV_READ);
1350 evhttp_connection_retry(evutil_socket_t fd, short what, void *arg)
1352 struct evhttp_connection *evcon = arg;
1354 evcon->state = EVCON_DISCONNECTED;
1355 evhttp_connection_connect_(evcon);
1359 evhttp_connection_cb_cleanup(struct evhttp_connection *evcon)
1361 struct evcon_requestq requests;
1363 evhttp_connection_reset_(evcon);
1364 if (evcon->retry_max < 0 || evcon->retry_cnt < evcon->retry_max) {
1365 struct timeval tv_retry = evcon->initial_retry_timeout;
1367 evtimer_assign(&evcon->retry_ev, evcon->base, evhttp_connection_retry, evcon);
1368 /* XXXX handle failure from evhttp_add_event */
1369 for (i=0; i < evcon->retry_cnt; ++i) {
1370 tv_retry.tv_usec *= 2;
1371 if (tv_retry.tv_usec > 1000000) {
1372 tv_retry.tv_usec -= 1000000;
1373 tv_retry.tv_sec += 1;
1375 tv_retry.tv_sec *= 2;
1376 if (tv_retry.tv_sec > 3600) {
1377 tv_retry.tv_sec = 3600;
1378 tv_retry.tv_usec = 0;
1381 event_add(&evcon->retry_ev, &tv_retry);
1387 * User callback can do evhttp_make_request() on the same
1388 * evcon so new request will be added to evcon->requests. To
1389 * avoid freeing it prematurely we iterate over the copy of
1392 TAILQ_INIT(&requests);
1393 while (TAILQ_FIRST(&evcon->requests) != NULL) {
1394 struct evhttp_request *request = TAILQ_FIRST(&evcon->requests);
1395 TAILQ_REMOVE(&evcon->requests, request, next);
1396 TAILQ_INSERT_TAIL(&requests, request, next);
1399 /* for now, we just signal all requests by executing their callbacks */
1400 while (TAILQ_FIRST(&requests) != NULL) {
1401 struct evhttp_request *request = TAILQ_FIRST(&requests);
1402 TAILQ_REMOVE(&requests, request, next);
1403 request->evcon = NULL;
1405 /* we might want to set an error here */
1406 request->cb(request, request->cb_arg);
1407 evhttp_request_free_auto(request);
1412 evhttp_connection_read_on_write_error(struct evhttp_connection *evcon,
1413 struct evhttp_request *req)
1415 struct evbuffer *buf;
1417 evcon->state = EVCON_READING_FIRSTLINE;
1418 req->kind = EVHTTP_RESPONSE;
1420 buf = bufferevent_get_output(evcon->bufev);
1421 evbuffer_unfreeze(buf, 1);
1422 evbuffer_drain(buf, evbuffer_get_length(buf));
1423 evbuffer_freeze(buf, 1);
1425 bufferevent_setcb(evcon->bufev,
1427 NULL, /* evhttp_write_cb */
1430 evhttp_connection_start_detectclose(evcon);
1434 evhttp_error_cb(struct bufferevent *bufev, short what, void *arg)
1436 struct evhttp_connection *evcon = arg;
1437 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
1439 if (evcon->fd == -1)
1440 evcon->fd = bufferevent_getfd(bufev);
1442 switch (evcon->state) {
1443 case EVCON_CONNECTING:
1444 if (what & BEV_EVENT_TIMEOUT) {
1445 event_debug(("%s: connection timeout for \"%s:%d\" on "
1447 __func__, evcon->address, evcon->port,
1448 EV_SOCK_ARG(evcon->fd)));
1449 evhttp_connection_cb_cleanup(evcon);
1454 case EVCON_READING_BODY:
1455 if (!req->chunked && req->ntoread < 0
1456 && what == (BEV_EVENT_READING|BEV_EVENT_EOF)) {
1457 /* EOF on read can be benign */
1458 evhttp_connection_done(evcon);
1463 case EVCON_DISCONNECTED:
1465 case EVCON_READING_FIRSTLINE:
1466 case EVCON_READING_HEADERS:
1467 case EVCON_READING_TRAILER:
1473 /* when we are in close detect mode, a read error means that
1474 * the other side closed their connection.
1476 if (evcon->flags & EVHTTP_CON_CLOSEDETECT) {
1477 evcon->flags &= ~EVHTTP_CON_CLOSEDETECT;
1478 EVUTIL_ASSERT(evcon->http_server == NULL);
1479 /* For connections from the client, we just
1480 * reset the connection so that it becomes
1483 EVUTIL_ASSERT(evcon->state == EVCON_IDLE);
1484 evhttp_connection_reset_(evcon);
1487 * If we have no more requests that need completion
1488 * and we want to auto-free the connection when all
1489 * requests have been completed.
1491 if (TAILQ_FIRST(&evcon->requests) == NULL
1492 && (evcon->flags & EVHTTP_CON_OUTGOING)
1493 && (evcon->flags & EVHTTP_CON_AUTOFREE)) {
1494 evhttp_connection_free(evcon);
1499 if (what & BEV_EVENT_TIMEOUT) {
1500 evhttp_connection_fail_(evcon, EVREQ_HTTP_TIMEOUT);
1501 } else if (what & (BEV_EVENT_EOF|BEV_EVENT_ERROR)) {
1502 if (what & BEV_EVENT_WRITING &&
1503 evcon->flags & EVHTTP_CON_READ_ON_WRITE_ERROR) {
1504 evhttp_connection_read_on_write_error(evcon, req);
1508 evhttp_connection_fail_(evcon, EVREQ_HTTP_EOF);
1509 } else if (what == BEV_EVENT_CONNECTED) {
1511 evhttp_connection_fail_(evcon, EVREQ_HTTP_BUFFER_ERROR);
1516 * Event callback for asynchronous connection attempt.
1519 evhttp_connection_cb(struct bufferevent *bufev, short what, void *arg)
1521 struct evhttp_connection *evcon = arg;
1523 ev_socklen_t errsz = sizeof(error);
1525 if (evcon->fd == -1)
1526 evcon->fd = bufferevent_getfd(bufev);
1528 if (!(what & BEV_EVENT_CONNECTED)) {
1529 /* some operating systems return ECONNREFUSED immediately
1530 * when connecting to a local address. the cleanup is going
1531 * to reschedule this function call.
1534 if (errno == ECONNREFUSED)
1537 evhttp_error_cb(bufev, what, arg);
1541 if (evcon->fd == -1) {
1542 event_debug(("%s: bufferevent_getfd returned -1",
1547 /* Check if the connection completed */
1548 if (getsockopt(evcon->fd, SOL_SOCKET, SO_ERROR, (void*)&error,
1550 event_debug(("%s: getsockopt for \"%s:%d\" on "EV_SOCK_FMT,
1551 __func__, evcon->address, evcon->port,
1552 EV_SOCK_ARG(evcon->fd)));
1557 event_debug(("%s: connect failed for \"%s:%d\" on "
1559 __func__, evcon->address, evcon->port,
1560 EV_SOCK_ARG(evcon->fd),
1561 evutil_socket_error_to_string(error)));
1565 /* We are connected to the server now */
1566 event_debug(("%s: connected to \"%s:%d\" on "EV_SOCK_FMT"\n",
1567 __func__, evcon->address, evcon->port,
1568 EV_SOCK_ARG(evcon->fd)));
1570 /* Reset the retry count as we were successful in connecting */
1571 evcon->retry_cnt = 0;
1572 evcon->state = EVCON_IDLE;
1574 /* reset the bufferevent cbs */
1575 bufferevent_setcb(evcon->bufev,
1581 if (!evutil_timerisset(&evcon->timeout)) {
1582 const struct timeval read_tv = { HTTP_READ_TIMEOUT, 0 };
1583 const struct timeval write_tv = { HTTP_WRITE_TIMEOUT, 0 };
1584 bufferevent_set_timeouts(evcon->bufev, &read_tv, &write_tv);
1586 bufferevent_set_timeouts(evcon->bufev, &evcon->timeout, &evcon->timeout);
1589 /* try to start requests that have queued up on this connection */
1590 evhttp_request_dispatch(evcon);
1594 evhttp_connection_cb_cleanup(evcon);
1598 * Check if we got a valid response code.
1602 evhttp_valid_response_code(int code)
1611 evhttp_parse_http_version(const char *version, struct evhttp_request *req)
1615 int n = sscanf(version, "HTTP/%d.%d%c", &major, &minor, &ch);
1616 if (n != 2 || major > 1) {
1617 event_debug(("%s: bad version %s on message %p from %s",
1618 __func__, version, req, req->remote_host));
1626 /* Parses the status line of a web server */
1629 evhttp_parse_response_line(struct evhttp_request *req, char *line)
1633 const char *readable = "";
1635 protocol = strsep(&line, " ");
1638 number = strsep(&line, " ");
1642 if (evhttp_parse_http_version(protocol, req) < 0)
1645 req->response_code = atoi(number);
1646 if (!evhttp_valid_response_code(req->response_code)) {
1647 event_debug(("%s: bad response code \"%s\"",
1652 if ((req->response_code_line = mm_strdup(readable)) == NULL) {
1653 event_warn("%s: strdup", __func__);
1660 /* Parse the first line of a HTTP request */
1663 evhttp_parse_request_line(struct evhttp_request *req, char *line)
1668 const char *hostname;
1671 enum evhttp_cmd_type type;
1673 /* Parse the request line */
1674 method = strsep(&line, " ");
1677 uri = strsep(&line, " ");
1680 version = strsep(&line, " ");
1684 method_len = (uri - method) - 1;
1685 type = EVHTTP_REQ_UNKNOWN_;
1688 switch (method_len) {
1690 /* The length of the method string is 3, meaning it can only be one of two methods: GET or PUT */
1692 /* Since both GET and PUT share the same character 'T' at the end,
1693 * if the string doesn't have 'T', we can immediately determine this
1694 * is an invalid HTTP method */
1696 if (method[2] != 'T') {
1702 /* This first byte is 'G', so make sure the next byte is
1703 * 'E', if it isn't then this isn't a valid method */
1705 if (method[1] == 'E') {
1706 type = EVHTTP_REQ_GET;
1711 /* First byte is P, check second byte for 'U', if not,
1712 * we know it's an invalid method */
1713 if (method[1] == 'U') {
1714 type = EVHTTP_REQ_PUT;
1722 /* The method length is 4 bytes, leaving only the methods "POST" and "HEAD" */
1725 if (method[3] == 'T' && method[2] == 'S' && method[1] == 'O') {
1726 type = EVHTTP_REQ_POST;
1730 if (method[3] == 'D' && method[2] == 'A' && method[1] == 'E') {
1731 type = EVHTTP_REQ_HEAD;
1739 /* Method length is 5 bytes, which can only encompass PATCH and TRACE */
1742 if (method[4] == 'H' && method[3] == 'C' && method[2] == 'T' && method[1] == 'A') {
1743 type = EVHTTP_REQ_PATCH;
1747 if (method[4] == 'E' && method[3] == 'C' && method[2] == 'A' && method[1] == 'R') {
1748 type = EVHTTP_REQ_TRACE;
1757 /* Method length is 6, only valid method 6 bytes in length is DELEte */
1759 /* If the first byte isn't 'D' then it's invalid */
1760 if (*method != 'D') {
1764 if (method[5] == 'E' && method[4] == 'T' && method[3] == 'E' && method[2] == 'L' && method[1] == 'E') {
1765 type = EVHTTP_REQ_DELETE;
1770 /* Method length is 7, only valid methods are "OPTIONS" and "CONNECT" */
1773 if (method[6] == 'S' && method[5] == 'N' && method[4] == 'O' &&
1774 method[3] == 'I' && method[2] == 'T' && method[1] == 'P') {
1775 type = EVHTTP_REQ_OPTIONS;
1780 if (method[6] == 'T' && method[5] == 'C' && method[4] == 'E' &&
1781 method[3] == 'N' && method[2] == 'N' && method[1] == 'O') {
1782 type = EVHTTP_REQ_CONNECT;
1792 if ((int)type == EVHTTP_REQ_UNKNOWN_) {
1793 event_debug(("%s: bad method %s on request %p from %s",
1794 __func__, method, req, req->remote_host));
1795 /* No error yet; we'll give a better error later when
1796 * we see that req->type is unsupported. */
1801 if (evhttp_parse_http_version(version, req) < 0)
1804 if ((req->uri = mm_strdup(uri)) == NULL) {
1805 event_debug(("%s: mm_strdup", __func__));
1809 if ((req->uri_elems = evhttp_uri_parse_with_flags(req->uri,
1810 EVHTTP_URI_NONCONFORMANT)) == NULL) {
1814 /* If we have an absolute-URI, check to see if it is an http request
1815 for a known vhost or server alias. If we don't know about this
1816 host, we consider it a proxy request. */
1817 scheme = evhttp_uri_get_scheme(req->uri_elems);
1818 hostname = evhttp_uri_get_host(req->uri_elems);
1819 if (scheme && (!evutil_ascii_strcasecmp(scheme, "http") ||
1820 !evutil_ascii_strcasecmp(scheme, "https")) &&
1822 !evhttp_find_vhost(req->evcon->http_server, NULL, hostname))
1823 req->flags |= EVHTTP_PROXY_REQUEST;
1829 evhttp_find_header(const struct evkeyvalq *headers, const char *key)
1831 struct evkeyval *header;
1833 TAILQ_FOREACH(header, headers, next) {
1834 if (evutil_ascii_strcasecmp(header->key, key) == 0)
1835 return (header->value);
1842 evhttp_clear_headers(struct evkeyvalq *headers)
1844 struct evkeyval *header;
1846 for (header = TAILQ_FIRST(headers);
1848 header = TAILQ_FIRST(headers)) {
1849 TAILQ_REMOVE(headers, header, next);
1850 mm_free(header->key);
1851 mm_free(header->value);
1857 * Returns 0, if the header was successfully removed.
1858 * Returns -1, if the header could not be found.
1862 evhttp_remove_header(struct evkeyvalq *headers, const char *key)
1864 struct evkeyval *header;
1866 TAILQ_FOREACH(header, headers, next) {
1867 if (evutil_ascii_strcasecmp(header->key, key) == 0)
1874 /* Free and remove the header that we found */
1875 TAILQ_REMOVE(headers, header, next);
1876 mm_free(header->key);
1877 mm_free(header->value);
1884 evhttp_header_is_valid_value(const char *value)
1886 const char *p = value;
1888 while ((p = strpbrk(p, "\r\n")) != NULL) {
1889 /* we really expect only one new line */
1890 p += strspn(p, "\r\n");
1891 /* we expect a space or tab for continuation */
1892 if (*p != ' ' && *p != '\t')
1899 evhttp_add_header(struct evkeyvalq *headers,
1900 const char *key, const char *value)
1902 event_debug(("%s: key: %s val: %s\n", __func__, key, value));
1904 if (strchr(key, '\r') != NULL || strchr(key, '\n') != NULL) {
1905 /* drop illegal headers */
1906 event_debug(("%s: dropping illegal header key\n", __func__));
1910 if (!evhttp_header_is_valid_value(value)) {
1911 event_debug(("%s: dropping illegal header value\n", __func__));
1915 return (evhttp_add_header_internal(headers, key, value));
1919 evhttp_add_header_internal(struct evkeyvalq *headers,
1920 const char *key, const char *value)
1922 struct evkeyval *header = mm_calloc(1, sizeof(struct evkeyval));
1923 if (header == NULL) {
1924 event_warn("%s: calloc", __func__);
1927 if ((header->key = mm_strdup(key)) == NULL) {
1929 event_warn("%s: strdup", __func__);
1932 if ((header->value = mm_strdup(value)) == NULL) {
1933 mm_free(header->key);
1935 event_warn("%s: strdup", __func__);
1939 TAILQ_INSERT_TAIL(headers, header, next);
1945 * Parses header lines from a request or a response into the specified
1946 * request object given an event buffer.
1949 * DATA_CORRUPTED on error
1950 * MORE_DATA_EXPECTED when we need to read more headers
1951 * ALL_DATA_READ when all headers have been read.
1954 enum message_read_status
1955 evhttp_parse_firstline_(struct evhttp_request *req, struct evbuffer *buffer)
1958 enum message_read_status status = ALL_DATA_READ;
1962 line = evbuffer_readln(buffer, &line_length, EVBUFFER_EOL_CRLF);
1964 if (req->evcon != NULL &&
1965 evbuffer_get_length(buffer) > req->evcon->max_headers_size)
1966 return (DATA_TOO_LONG);
1968 return (MORE_DATA_EXPECTED);
1971 if (req->evcon != NULL &&
1972 line_length > req->evcon->max_headers_size) {
1974 return (DATA_TOO_LONG);
1977 req->headers_size = line_length;
1979 switch (req->kind) {
1980 case EVHTTP_REQUEST:
1981 if (evhttp_parse_request_line(req, line) == -1)
1982 status = DATA_CORRUPTED;
1984 case EVHTTP_RESPONSE:
1985 if (evhttp_parse_response_line(req, line) == -1)
1986 status = DATA_CORRUPTED;
1989 status = DATA_CORRUPTED;
1997 evhttp_append_to_last_header(struct evkeyvalq *headers, char *line)
1999 struct evkeyval *header = TAILQ_LAST(headers, evkeyvalq);
2001 size_t old_len, line_len;
2006 old_len = strlen(header->value);
2008 /* Strip space from start and end of line. */
2009 while (*line == ' ' || *line == '\t')
2011 evutil_rtrim_lws_(line);
2013 line_len = strlen(line);
2015 newval = mm_realloc(header->value, old_len + line_len + 2);
2019 newval[old_len] = ' ';
2020 memcpy(newval + old_len + 1, line, line_len + 1);
2021 header->value = newval;
2026 enum message_read_status
2027 evhttp_parse_headers_(struct evhttp_request *req, struct evbuffer* buffer)
2029 enum message_read_status errcode = DATA_CORRUPTED;
2031 enum message_read_status status = MORE_DATA_EXPECTED;
2033 struct evkeyvalq* headers = req->input_headers;
2035 while ((line = evbuffer_readln(buffer, &line_length, EVBUFFER_EOL_CRLF))
2037 char *skey, *svalue;
2039 req->headers_size += line_length;
2041 if (req->evcon != NULL &&
2042 req->headers_size > req->evcon->max_headers_size) {
2043 errcode = DATA_TOO_LONG;
2047 if (*line == '\0') { /* Last header - Done */
2048 status = ALL_DATA_READ;
2053 /* Check if this is a continuation line */
2054 if (*line == ' ' || *line == '\t') {
2055 if (evhttp_append_to_last_header(headers, line) == -1)
2061 /* Processing of header lines */
2063 skey = strsep(&svalue, ":");
2067 svalue += strspn(svalue, " ");
2068 evutil_rtrim_lws_(svalue);
2070 if (evhttp_add_header(headers, skey, svalue) == -1)
2076 if (status == MORE_DATA_EXPECTED) {
2077 if (req->evcon != NULL &&
2078 req->headers_size + evbuffer_get_length(buffer) > req->evcon->max_headers_size)
2079 return (DATA_TOO_LONG);
2090 evhttp_get_body_length(struct evhttp_request *req)
2092 struct evkeyvalq *headers = req->input_headers;
2093 const char *content_length;
2094 const char *connection;
2096 content_length = evhttp_find_header(headers, "Content-Length");
2097 connection = evhttp_find_header(headers, "Connection");
2099 if (content_length == NULL && connection == NULL)
2101 else if (content_length == NULL &&
2102 evutil_ascii_strcasecmp(connection, "Close") != 0) {
2103 /* Bad combination, we don't know when it will end */
2104 event_warnx("%s: we got no content length, but the "
2105 "server wants to keep the connection open: %s.",
2106 __func__, connection);
2108 } else if (content_length == NULL) {
2112 ev_int64_t ntoread = evutil_strtoll(content_length, &endp, 10);
2113 if (*content_length == '\0' || *endp != '\0' || ntoread < 0) {
2114 event_debug(("%s: illegal content length: %s",
2115 __func__, content_length));
2118 req->ntoread = ntoread;
2121 event_debug(("%s: bytes to read: "EV_I64_FMT" (in buffer "EV_SIZE_FMT")\n",
2122 __func__, EV_I64_ARG(req->ntoread),
2123 EV_SIZE_ARG(evbuffer_get_length(bufferevent_get_input(req->evcon->bufev)))));
2129 evhttp_method_may_have_body(enum evhttp_cmd_type type)
2132 case EVHTTP_REQ_POST:
2133 case EVHTTP_REQ_PUT:
2134 case EVHTTP_REQ_PATCH:
2136 case EVHTTP_REQ_TRACE:
2138 /* XXX May any of the below methods have a body? */
2139 case EVHTTP_REQ_GET:
2140 case EVHTTP_REQ_HEAD:
2141 case EVHTTP_REQ_DELETE:
2142 case EVHTTP_REQ_OPTIONS:
2143 case EVHTTP_REQ_CONNECT:
2151 evhttp_get_body(struct evhttp_connection *evcon, struct evhttp_request *req)
2153 const char *xfer_enc;
2155 /* If this is a request without a body, then we are done */
2156 if (req->kind == EVHTTP_REQUEST &&
2157 !evhttp_method_may_have_body(req->type)) {
2158 evhttp_connection_done(evcon);
2161 evcon->state = EVCON_READING_BODY;
2162 xfer_enc = evhttp_find_header(req->input_headers, "Transfer-Encoding");
2163 if (xfer_enc != NULL && evutil_ascii_strcasecmp(xfer_enc, "chunked") == 0) {
2167 if (evhttp_get_body_length(req) == -1) {
2168 evhttp_connection_fail_(evcon,
2169 EVREQ_HTTP_INVALID_HEADER);
2172 if (req->kind == EVHTTP_REQUEST && req->ntoread < 1) {
2173 /* An incoming request with no content-length and no
2174 * transfer-encoding has no body. */
2175 evhttp_connection_done(evcon);
2180 /* Should we send a 100 Continue status line? */
2181 if (req->kind == EVHTTP_REQUEST && REQ_VERSION_ATLEAST(req, 1, 1)) {
2184 expect = evhttp_find_header(req->input_headers, "Expect");
2186 if (!evutil_ascii_strcasecmp(expect, "100-continue")) {
2187 /* XXX It would be nice to do some sanity
2188 checking here. Does the resource exist?
2189 Should the resource accept post requests? If
2190 no, we should respond with an error. For
2191 now, just optimistically tell the client to
2192 send their message body. */
2193 if (req->ntoread > 0) {
2194 /* ntoread is ev_int64_t, max_body_size is ev_uint64_t */
2195 if ((req->evcon->max_body_size <= EV_INT64_MAX) && (ev_uint64_t)req->ntoread > req->evcon->max_body_size) {
2196 evhttp_lingering_fail(evcon, req);
2200 if (!evbuffer_get_length(bufferevent_get_input(evcon->bufev)))
2201 evhttp_send_continue(evcon, req);
2203 evhttp_send_error(req, HTTP_EXPECTATIONFAILED,
2210 evhttp_read_body(evcon, req);
2211 /* note the request may have been freed in evhttp_read_body */
2215 evhttp_read_firstline(struct evhttp_connection *evcon,
2216 struct evhttp_request *req)
2218 enum message_read_status res;
2220 res = evhttp_parse_firstline_(req, bufferevent_get_input(evcon->bufev));
2221 if (res == DATA_CORRUPTED || res == DATA_TOO_LONG) {
2222 /* Error while reading, terminate */
2223 event_debug(("%s: bad header lines on "EV_SOCK_FMT"\n",
2224 __func__, EV_SOCK_ARG(evcon->fd)));
2225 evhttp_connection_fail_(evcon, EVREQ_HTTP_INVALID_HEADER);
2227 } else if (res == MORE_DATA_EXPECTED) {
2228 /* Need more header lines */
2232 evcon->state = EVCON_READING_HEADERS;
2233 evhttp_read_header(evcon, req);
2237 evhttp_read_header(struct evhttp_connection *evcon,
2238 struct evhttp_request *req)
2240 enum message_read_status res;
2241 evutil_socket_t fd = evcon->fd;
2243 res = evhttp_parse_headers_(req, bufferevent_get_input(evcon->bufev));
2244 if (res == DATA_CORRUPTED || res == DATA_TOO_LONG) {
2245 /* Error while reading, terminate */
2246 event_debug(("%s: bad header lines on "EV_SOCK_FMT"\n",
2247 __func__, EV_SOCK_ARG(fd)));
2248 evhttp_connection_fail_(evcon, EVREQ_HTTP_INVALID_HEADER);
2250 } else if (res == MORE_DATA_EXPECTED) {
2251 /* Need more header lines */
2255 /* Callback can shut down connection with negative return value */
2256 if (req->header_cb != NULL) {
2257 if ((*req->header_cb)(req, req->cb_arg) < 0) {
2258 evhttp_connection_fail_(evcon, EVREQ_HTTP_EOF);
2263 /* Done reading headers, do the real work */
2264 switch (req->kind) {
2265 case EVHTTP_REQUEST:
2266 event_debug(("%s: checking for post data on "EV_SOCK_FMT"\n",
2267 __func__, EV_SOCK_ARG(fd)));
2268 evhttp_get_body(evcon, req);
2269 /* note the request may have been freed in evhttp_get_body */
2272 case EVHTTP_RESPONSE:
2273 /* Start over if we got a 100 Continue response. */
2274 if (req->response_code == 100) {
2275 evhttp_start_read_(evcon);
2278 if (!evhttp_response_needs_body(req)) {
2279 event_debug(("%s: skipping body for code %d\n",
2280 __func__, req->response_code));
2281 evhttp_connection_done(evcon);
2283 event_debug(("%s: start of read body for %s on "
2285 __func__, req->remote_host, EV_SOCK_ARG(fd)));
2286 evhttp_get_body(evcon, req);
2287 /* note the request may have been freed in
2288 * evhttp_get_body */
2293 event_warnx("%s: bad header on "EV_SOCK_FMT, __func__,
2295 evhttp_connection_fail_(evcon, EVREQ_HTTP_INVALID_HEADER);
2298 /* request may have been freed above */
2302 * Creates a TCP connection to the specified port and executes a callback
2303 * when finished. Failure or success is indicate by the passed connection
2306 * Although this interface accepts a hostname, it is intended to take
2307 * only numeric hostnames so that non-blocking DNS resolution can
2311 struct evhttp_connection *
2312 evhttp_connection_new(const char *address, unsigned short port)
2314 return (evhttp_connection_base_new(NULL, NULL, address, port));
2317 struct evhttp_connection *
2318 evhttp_connection_base_bufferevent_new(struct event_base *base, struct evdns_base *dnsbase, struct bufferevent* bev,
2319 const char *address, unsigned short port)
2321 struct evhttp_connection *evcon = NULL;
2323 event_debug(("Attempting connection to %s:%d\n", address, port));
2325 if ((evcon = mm_calloc(1, sizeof(struct evhttp_connection))) == NULL) {
2326 event_warn("%s: calloc failed", __func__);
2333 evcon->max_headers_size = EV_SIZE_MAX;
2334 evcon->max_body_size = EV_SIZE_MAX;
2336 evutil_timerclear(&evcon->timeout);
2337 evcon->retry_cnt = evcon->retry_max = 0;
2339 if ((evcon->address = mm_strdup(address)) == NULL) {
2340 event_warn("%s: strdup failed", __func__);
2345 if (!(bev = bufferevent_socket_new(base, -1, 0))) {
2346 event_warn("%s: bufferevent_socket_new failed", __func__);
2351 bufferevent_setcb(bev, evhttp_read_cb, evhttp_write_cb, evhttp_error_cb, evcon);
2354 evcon->state = EVCON_DISCONNECTED;
2355 TAILQ_INIT(&evcon->requests);
2357 evcon->initial_retry_timeout.tv_sec = 2;
2358 evcon->initial_retry_timeout.tv_usec = 0;
2362 if (bufferevent_get_base(bev) != base)
2363 bufferevent_base_set(base, evcon->bufev);
2366 event_deferred_cb_init_(
2367 &evcon->read_more_deferred_cb,
2368 bufferevent_get_priority(bev),
2369 evhttp_deferred_read_cb, evcon);
2371 evcon->dns_base = dnsbase;
2372 evcon->ai_family = AF_UNSPEC;
2378 evhttp_connection_free(evcon);
2382 struct bufferevent* evhttp_connection_get_bufferevent(struct evhttp_connection *evcon)
2384 return evcon->bufev;
2388 evhttp_connection_get_server(struct evhttp_connection *evcon)
2390 return evcon->http_server;
2393 struct evhttp_connection *
2394 evhttp_connection_base_new(struct event_base *base, struct evdns_base *dnsbase,
2395 const char *address, unsigned short port)
2397 return evhttp_connection_base_bufferevent_new(base, dnsbase, NULL, address, port);
2400 void evhttp_connection_set_family(struct evhttp_connection *evcon,
2403 evcon->ai_family = family;
2406 int evhttp_connection_set_flags(struct evhttp_connection *evcon,
2409 int avail_flags = 0;
2410 avail_flags |= EVHTTP_CON_REUSE_CONNECTED_ADDR;
2411 avail_flags |= EVHTTP_CON_READ_ON_WRITE_ERROR;
2413 if (flags & ~avail_flags || flags > EVHTTP_CON_PUBLIC_FLAGS_END)
2415 evcon->flags &= ~avail_flags;
2417 evcon->flags |= flags;
2423 evhttp_connection_set_base(struct evhttp_connection *evcon,
2424 struct event_base *base)
2426 EVUTIL_ASSERT(evcon->base == NULL);
2427 EVUTIL_ASSERT(evcon->state == EVCON_DISCONNECTED);
2429 bufferevent_base_set(base, evcon->bufev);
2433 evhttp_connection_set_timeout(struct evhttp_connection *evcon,
2434 int timeout_in_secs)
2436 if (timeout_in_secs == -1)
2437 evhttp_connection_set_timeout_tv(evcon, NULL);
2440 tv.tv_sec = timeout_in_secs;
2442 evhttp_connection_set_timeout_tv(evcon, &tv);
2447 evhttp_connection_set_timeout_tv(struct evhttp_connection *evcon,
2448 const struct timeval* tv)
2451 evcon->timeout = *tv;
2452 bufferevent_set_timeouts(evcon->bufev, &evcon->timeout, &evcon->timeout);
2454 const struct timeval read_tv = { HTTP_READ_TIMEOUT, 0 };
2455 const struct timeval write_tv = { HTTP_WRITE_TIMEOUT, 0 };
2456 evutil_timerclear(&evcon->timeout);
2457 bufferevent_set_timeouts(evcon->bufev, &read_tv, &write_tv);
2462 evhttp_connection_set_initial_retry_tv(struct evhttp_connection *evcon,
2463 const struct timeval *tv)
2466 evcon->initial_retry_timeout = *tv;
2468 evutil_timerclear(&evcon->initial_retry_timeout);
2469 evcon->initial_retry_timeout.tv_sec = 2;
2474 evhttp_connection_set_retries(struct evhttp_connection *evcon,
2477 evcon->retry_max = retry_max;
2481 evhttp_connection_set_closecb(struct evhttp_connection *evcon,
2482 void (*cb)(struct evhttp_connection *, void *), void *cbarg)
2484 evcon->closecb = cb;
2485 evcon->closecb_arg = cbarg;
2489 evhttp_connection_get_peer(struct evhttp_connection *evcon,
2490 char **address, ev_uint16_t *port)
2492 *address = evcon->address;
2493 *port = evcon->port;
2496 const struct sockaddr*
2497 evhttp_connection_get_addr(struct evhttp_connection *evcon)
2499 return bufferevent_socket_get_conn_address_(evcon->bufev);
2503 evhttp_connection_connect_(struct evhttp_connection *evcon)
2505 int old_state = evcon->state;
2506 const char *address = evcon->address;
2507 const struct sockaddr *sa = evhttp_connection_get_addr(evcon);
2510 if (evcon->state == EVCON_CONNECTING)
2513 evhttp_connection_reset_(evcon);
2515 EVUTIL_ASSERT(!(evcon->flags & EVHTTP_CON_INCOMING));
2516 evcon->flags |= EVHTTP_CON_OUTGOING;
2518 if (evcon->bind_address || evcon->bind_port) {
2519 evcon->fd = bind_socket(
2520 evcon->bind_address, evcon->bind_port, 0 /*reuse*/);
2521 if (evcon->fd == -1) {
2522 event_debug(("%s: failed to bind to \"%s\"",
2523 __func__, evcon->bind_address));
2527 bufferevent_setfd(evcon->bufev, evcon->fd);
2529 bufferevent_setfd(evcon->bufev, -1);
2532 /* Set up a callback for successful connection setup */
2533 bufferevent_setcb(evcon->bufev,
2534 NULL /* evhttp_read_cb */,
2535 NULL /* evhttp_write_cb */,
2536 evhttp_connection_cb,
2538 if (!evutil_timerisset(&evcon->timeout)) {
2539 const struct timeval conn_tv = { HTTP_CONNECT_TIMEOUT, 0 };
2540 bufferevent_set_timeouts(evcon->bufev, &conn_tv, &conn_tv);
2542 bufferevent_set_timeouts(evcon->bufev, &evcon->timeout, &evcon->timeout);
2544 /* make sure that we get a write callback */
2545 bufferevent_enable(evcon->bufev, EV_WRITE);
2547 evcon->state = EVCON_CONNECTING;
2549 if (evcon->flags & EVHTTP_CON_REUSE_CONNECTED_ADDR &&
2551 (sa->sa_family == AF_INET || sa->sa_family == AF_INET6)) {
2552 int socklen = sizeof(struct sockaddr_in);
2553 if (sa->sa_family == AF_INET6) {
2554 socklen = sizeof(struct sockaddr_in6);
2556 ret = bufferevent_socket_connect(evcon->bufev, sa, socklen);
2558 ret = bufferevent_socket_connect_hostname(evcon->bufev,
2559 evcon->dns_base, evcon->ai_family, address, evcon->port);
2563 evcon->state = old_state;
2564 event_sock_warn(evcon->fd, "%s: connection to \"%s\" failed",
2565 __func__, evcon->address);
2566 /* some operating systems return ECONNREFUSED immediately
2567 * when connecting to a local address. the cleanup is going
2568 * to reschedule this function call.
2570 evhttp_connection_cb_cleanup(evcon);
2578 * Starts an HTTP request on the provided evhttp_connection object.
2579 * If the connection object is not connected to the web server already,
2580 * this will start the connection.
2584 evhttp_make_request(struct evhttp_connection *evcon,
2585 struct evhttp_request *req,
2586 enum evhttp_cmd_type type, const char *uri)
2588 /* We are making a request */
2589 req->kind = EVHTTP_REQUEST;
2591 if (req->uri != NULL)
2593 if ((req->uri = mm_strdup(uri)) == NULL) {
2594 event_warn("%s: strdup", __func__);
2595 evhttp_request_free_auto(req);
2599 /* Set the protocol version if it is not supplied */
2600 if (!req->major && !req->minor) {
2605 EVUTIL_ASSERT(req->evcon == NULL);
2607 EVUTIL_ASSERT(!(req->flags & EVHTTP_REQ_OWN_CONNECTION));
2609 TAILQ_INSERT_TAIL(&evcon->requests, req, next);
2611 /* If the connection object is not connected; make it so */
2612 if (!evhttp_connected(evcon)) {
2613 int res = evhttp_connection_connect_(evcon);
2614 /* evhttp_connection_fail_(), which is called through
2615 * evhttp_connection_connect_(), assumes that req lies in
2616 * evcon->requests. Thus, enqueue the request in advance and
2617 * remove it in the error case. */
2619 TAILQ_REMOVE(&evcon->requests, req, next);
2625 * If it's connected already and we are the first in the queue,
2626 * then we can dispatch this request immediately. Otherwise, it
2627 * will be dispatched once the pending requests are completed.
2629 if (TAILQ_FIRST(&evcon->requests) == req)
2630 evhttp_request_dispatch(evcon);
2636 evhttp_cancel_request(struct evhttp_request *req)
2638 struct evhttp_connection *evcon = req->evcon;
2639 if (evcon != NULL) {
2640 /* We need to remove it from the connection */
2641 if (TAILQ_FIRST(&evcon->requests) == req) {
2642 /* it's currently being worked on, so reset
2645 evhttp_connection_fail_(evcon,
2646 EVREQ_HTTP_REQUEST_CANCEL);
2648 /* connection fail freed the request */
2651 /* otherwise, we can just remove it from the
2654 TAILQ_REMOVE(&evcon->requests, req, next);
2658 evhttp_request_free_auto(req);
2662 * Reads data from file descriptor into request structure
2663 * Request structure needs to be set up correctly.
2667 evhttp_start_read_(struct evhttp_connection *evcon)
2669 bufferevent_disable(evcon->bufev, EV_WRITE);
2670 bufferevent_enable(evcon->bufev, EV_READ);
2672 evcon->state = EVCON_READING_FIRSTLINE;
2673 /* Reset the bufferevent callbacks */
2674 bufferevent_setcb(evcon->bufev,
2680 /* If there's still data pending, process it next time through the
2681 * loop. Don't do it now; that could get recusive. */
2682 if (evbuffer_get_length(bufferevent_get_input(evcon->bufev))) {
2683 event_deferred_cb_schedule_(get_deferred_queue(evcon),
2684 &evcon->read_more_deferred_cb);
2689 evhttp_send_done(struct evhttp_connection *evcon, void *arg)
2692 struct evhttp_request *req = TAILQ_FIRST(&evcon->requests);
2693 TAILQ_REMOVE(&evcon->requests, req, next);
2695 if (req->on_complete_cb != NULL) {
2696 req->on_complete_cb(req, req->on_complete_cb_arg);
2700 (REQ_VERSION_BEFORE(req, 1, 1) &&
2701 !evhttp_is_connection_keepalive(req->input_headers)) ||
2702 evhttp_is_request_connection_close(req);
2704 EVUTIL_ASSERT(req->flags & EVHTTP_REQ_OWN_CONNECTION);
2705 evhttp_request_free(req);
2708 evhttp_connection_free(evcon);
2712 /* we have a persistent connection; try to accept another request. */
2713 if (evhttp_associate_new_request_with_connection(evcon) == -1) {
2714 evhttp_connection_free(evcon);
2719 * Returns an error page.
2723 evhttp_send_error(struct evhttp_request *req, int error, const char *reason)
2726 #define ERR_FORMAT "<HTML><HEAD>\n" \
2727 "<TITLE>%d %s</TITLE>\n" \
2732 struct evbuffer *buf = evbuffer_new();
2734 /* if we cannot allocate memory; we just drop the connection */
2735 evhttp_connection_free(req->evcon);
2738 if (reason == NULL) {
2739 reason = evhttp_response_phrase_internal(error);
2742 evhttp_response_code_(req, error, reason);
2744 evbuffer_add_printf(buf, ERR_FORMAT, error, reason, reason);
2746 evhttp_send_page_(req, buf);
2752 /* Requires that headers and response code are already set up */
2755 evhttp_send(struct evhttp_request *req, struct evbuffer *databuf)
2757 struct evhttp_connection *evcon = req->evcon;
2759 if (evcon == NULL) {
2760 evhttp_request_free(req);
2764 EVUTIL_ASSERT(TAILQ_FIRST(&evcon->requests) == req);
2766 /* we expect no more calls form the user on this request */
2769 /* xxx: not sure if we really should expose the data buffer this way */
2770 if (databuf != NULL)
2771 evbuffer_add_buffer(req->output_buffer, databuf);
2773 /* Adds headers to the response */
2774 evhttp_make_header(evcon, req);
2776 evhttp_write_buffer(evcon, evhttp_send_done, NULL);
2780 evhttp_send_reply(struct evhttp_request *req, int code, const char *reason,
2781 struct evbuffer *databuf)
2783 evhttp_response_code_(req, code, reason);
2785 evhttp_send(req, databuf);
2789 evhttp_send_reply_start(struct evhttp_request *req, int code,
2792 evhttp_response_code_(req, code, reason);
2793 if (evhttp_find_header(req->output_headers, "Content-Length") == NULL &&
2794 REQ_VERSION_ATLEAST(req, 1, 1) &&
2795 evhttp_response_needs_body(req)) {
2797 * prefer HTTP/1.1 chunked encoding to closing the connection;
2798 * note RFC 2616 section 4.4 forbids it with Content-Length:
2799 * and it's not necessary then anyway.
2801 evhttp_add_header(req->output_headers, "Transfer-Encoding",
2807 evhttp_make_header(req->evcon, req);
2808 evhttp_write_buffer(req->evcon, NULL, NULL);
2812 evhttp_send_reply_chunk_with_cb(struct evhttp_request *req, struct evbuffer *databuf,
2813 void (*cb)(struct evhttp_connection *, void *), void *arg)
2815 struct evhttp_connection *evcon = req->evcon;
2816 struct evbuffer *output;
2821 output = bufferevent_get_output(evcon->bufev);
2823 if (evbuffer_get_length(databuf) == 0)
2825 if (!evhttp_response_needs_body(req))
2828 evbuffer_add_printf(output, "%x\r\n",
2829 (unsigned)evbuffer_get_length(databuf));
2831 evbuffer_add_buffer(output, databuf);
2833 evbuffer_add(output, "\r\n", 2);
2835 evhttp_write_buffer(evcon, cb, arg);
2839 evhttp_send_reply_chunk(struct evhttp_request *req, struct evbuffer *databuf)
2841 evhttp_send_reply_chunk_with_cb(req, databuf, NULL, NULL);
2844 evhttp_send_reply_end(struct evhttp_request *req)
2846 struct evhttp_connection *evcon = req->evcon;
2847 struct evbuffer *output;
2849 if (evcon == NULL) {
2850 evhttp_request_free(req);
2854 output = bufferevent_get_output(evcon->bufev);
2856 /* we expect no more calls form the user on this request */
2860 evbuffer_add(output, "0\r\n\r\n", 5);
2861 evhttp_write_buffer(req->evcon, evhttp_send_done, NULL);
2863 } else if (evbuffer_get_length(output) == 0) {
2864 /* let the connection know that we are done with the request */
2865 evhttp_send_done(evcon, NULL);
2867 /* make the callback execute after all data has been written */
2868 evcon->cb = evhttp_send_done;
2869 evcon->cb_arg = NULL;
2873 static const char *informational_phrases[] = {
2874 /* 100 */ "Continue",
2875 /* 101 */ "Switching Protocols"
2878 static const char *success_phrases[] = {
2880 /* 201 */ "Created",
2881 /* 202 */ "Accepted",
2882 /* 203 */ "Non-Authoritative Information",
2883 /* 204 */ "No Content",
2884 /* 205 */ "Reset Content",
2885 /* 206 */ "Partial Content"
2888 static const char *redirection_phrases[] = {
2889 /* 300 */ "Multiple Choices",
2890 /* 301 */ "Moved Permanently",
2892 /* 303 */ "See Other",
2893 /* 304 */ "Not Modified",
2894 /* 305 */ "Use Proxy",
2895 /* 307 */ "Temporary Redirect"
2898 static const char *client_error_phrases[] = {
2899 /* 400 */ "Bad Request",
2900 /* 401 */ "Unauthorized",
2901 /* 402 */ "Payment Required",
2902 /* 403 */ "Forbidden",
2903 /* 404 */ "Not Found",
2904 /* 405 */ "Method Not Allowed",
2905 /* 406 */ "Not Acceptable",
2906 /* 407 */ "Proxy Authentication Required",
2907 /* 408 */ "Request Time-out",
2908 /* 409 */ "Conflict",
2910 /* 411 */ "Length Required",
2911 /* 412 */ "Precondition Failed",
2912 /* 413 */ "Request Entity Too Large",
2913 /* 414 */ "Request-URI Too Large",
2914 /* 415 */ "Unsupported Media Type",
2915 /* 416 */ "Requested range not satisfiable",
2916 /* 417 */ "Expectation Failed"
2919 static const char *server_error_phrases[] = {
2920 /* 500 */ "Internal Server Error",
2921 /* 501 */ "Not Implemented",
2922 /* 502 */ "Bad Gateway",
2923 /* 503 */ "Service Unavailable",
2924 /* 504 */ "Gateway Time-out",
2925 /* 505 */ "HTTP Version not supported"
2928 struct response_class {
2930 size_t num_responses;
2931 const char **responses;
2935 #define MEMBERSOF(x) (sizeof(x)/sizeof(x[0]))
2938 static const struct response_class response_classes[] = {
2939 /* 1xx */ { "Informational", MEMBERSOF(informational_phrases), informational_phrases },
2940 /* 2xx */ { "Success", MEMBERSOF(success_phrases), success_phrases },
2941 /* 3xx */ { "Redirection", MEMBERSOF(redirection_phrases), redirection_phrases },
2942 /* 4xx */ { "Client Error", MEMBERSOF(client_error_phrases), client_error_phrases },
2943 /* 5xx */ { "Server Error", MEMBERSOF(server_error_phrases), server_error_phrases }
2947 evhttp_response_phrase_internal(int code)
2949 int klass = code / 100 - 1;
2950 int subcode = code % 100;
2952 /* Unknown class - can't do any better here */
2953 if (klass < 0 || klass >= (int) MEMBERSOF(response_classes))
2954 return "Unknown Status Class";
2956 /* Unknown sub-code, return class name at least */
2957 if (subcode >= (int) response_classes[klass].num_responses)
2958 return response_classes[klass].name;
2960 return response_classes[klass].responses[subcode];
2964 evhttp_response_code_(struct evhttp_request *req, int code, const char *reason)
2966 req->kind = EVHTTP_RESPONSE;
2967 req->response_code = code;
2968 if (req->response_code_line != NULL)
2969 mm_free(req->response_code_line);
2971 reason = evhttp_response_phrase_internal(code);
2972 req->response_code_line = mm_strdup(reason);
2973 if (req->response_code_line == NULL) {
2974 event_warn("%s: strdup", __func__);
2975 /* XXX what else can we do? */
2980 evhttp_send_page_(struct evhttp_request *req, struct evbuffer *databuf)
2982 if (!req->major || !req->minor) {
2987 if (req->kind != EVHTTP_RESPONSE)
2988 evhttp_response_code_(req, 200, "OK");
2990 evhttp_clear_headers(req->output_headers);
2991 evhttp_add_header(req->output_headers, "Content-Type", "text/html");
2992 evhttp_add_header(req->output_headers, "Connection", "close");
2994 evhttp_send(req, databuf);
2997 static const char uri_chars[256] = {
2999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3000 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3001 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 0,
3002 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0,
3004 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
3005 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1,
3006 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
3007 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 0,
3009 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3010 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3011 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3012 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3014 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3015 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3016 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3017 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
3020 #define CHAR_IS_UNRESERVED(c) \
3021 (uri_chars[(unsigned char)(c)])
3024 * Helper functions to encode/decode a string for inclusion in a URI.
3025 * The returned string must be freed by the caller.
3028 evhttp_uriencode(const char *uri, ev_ssize_t len, int space_as_plus)
3030 struct evbuffer *buf = evbuffer_new();
3031 const char *p, *end;
3040 end = uri+strlen(uri);
3042 for (p = uri; p < end; p++) {
3043 if (CHAR_IS_UNRESERVED(*p)) {
3044 evbuffer_add(buf, p, 1);
3045 } else if (*p == ' ' && space_as_plus) {
3046 evbuffer_add(buf, "+", 1);
3048 evbuffer_add_printf(buf, "%%%02X", (unsigned char)(*p));
3051 evbuffer_add(buf, "", 1); /* NUL-terminator. */
3052 result = mm_malloc(evbuffer_get_length(buf));
3054 evbuffer_remove(buf, result, evbuffer_get_length(buf));
3061 evhttp_encode_uri(const char *str)
3063 return evhttp_uriencode(str, -1, 0);
3067 * @param decode_plus_ctl: if 1, we decode plus into space. If 0, we don't.
3068 * If -1, when true we transform plus to space only after we've seen
3069 * a ?. -1 is deprecated.
3070 * @return the number of bytes written to 'ret'.
3073 evhttp_decode_uri_internal(
3074 const char *uri, size_t length, char *ret, int decode_plus_ctl)
3078 int decode_plus = (decode_plus_ctl == 1) ? 1: 0;
3081 for (i = j = 0; i < length; i++) {
3084 if (decode_plus_ctl < 0)
3086 } else if (c == '+' && decode_plus) {
3088 } else if ((i + 2) < length && c == '%' &&
3089 EVUTIL_ISXDIGIT_(uri[i+1]) && EVUTIL_ISXDIGIT_(uri[i+2])) {
3094 c = (char)strtol(tmp, NULL, 16);
3106 evhttp_decode_uri(const char *uri)
3110 if ((ret = mm_malloc(strlen(uri) + 1)) == NULL) {
3111 event_warn("%s: malloc(%lu)", __func__,
3112 (unsigned long)(strlen(uri) + 1));
3116 evhttp_decode_uri_internal(uri, strlen(uri),
3117 ret, -1 /*always_decode_plus*/);
3123 evhttp_uridecode(const char *uri, int decode_plus, size_t *size_out)
3128 if ((ret = mm_malloc(strlen(uri) + 1)) == NULL) {
3129 event_warn("%s: malloc(%lu)", __func__,
3130 (unsigned long)(strlen(uri) + 1));
3134 n = evhttp_decode_uri_internal(uri, strlen(uri),
3135 ret, !!decode_plus/*always_decode_plus*/);
3138 EVUTIL_ASSERT(n >= 0);
3139 *size_out = (size_t)n;
3146 * Helper function to parse out arguments in a query.
3147 * The arguments are separated by key and value.
3151 evhttp_parse_query_impl(const char *str, struct evkeyvalq *headers,
3157 const char *query_part;
3159 struct evhttp_uri *uri=NULL;
3161 TAILQ_INIT(headers);
3164 uri = evhttp_uri_parse(str);
3167 query_part = evhttp_uri_get_query(uri);
3172 /* No arguments - we are done */
3173 if (!query_part || !strlen(query_part)) {
3178 if ((line = mm_strdup(query_part)) == NULL) {
3179 event_warn("%s: strdup", __func__);
3183 p = argument = line;
3184 while (p != NULL && *p != '\0') {
3185 char *key, *value, *decoded_value;
3186 argument = strsep(&p, "&");
3189 key = strsep(&value, "=");
3190 if (value == NULL || *key == '\0') {
3194 if ((decoded_value = mm_malloc(strlen(value) + 1)) == NULL) {
3195 event_warn("%s: mm_malloc", __func__);
3198 evhttp_decode_uri_internal(value, strlen(value),
3199 decoded_value, 1 /*always_decode_plus*/);
3200 event_debug(("Query Param: %s -> %s\n", key, decoded_value));
3201 evhttp_add_header_internal(headers, key, decoded_value);
3202 mm_free(decoded_value);
3208 evhttp_clear_headers(headers);
3213 evhttp_uri_free(uri);
3218 evhttp_parse_query(const char *uri, struct evkeyvalq *headers)
3220 return evhttp_parse_query_impl(uri, headers, 1);
3223 evhttp_parse_query_str(const char *uri, struct evkeyvalq *headers)
3225 return evhttp_parse_query_impl(uri, headers, 0);
3228 static struct evhttp_cb *
3229 evhttp_dispatch_callback(struct httpcbq *callbacks, struct evhttp_request *req)
3231 struct evhttp_cb *cb;
3236 /* Test for different URLs */
3237 path = evhttp_uri_get_path(req->uri_elems);
3238 offset = strlen(path);
3239 if ((translated = mm_malloc(offset + 1)) == NULL)
3241 evhttp_decode_uri_internal(path, offset, translated,
3242 0 /* decode_plus */);
3244 TAILQ_FOREACH(cb, callbacks, next) {
3245 if (!strcmp(cb->what, translated)) {
3246 mm_free(translated);
3251 mm_free(translated);
3257 prefix_suffix_match(const char *pattern, const char *name, int ignorecase)
3262 switch (c = *pattern++) {
3264 return *name == '\0';
3267 while (*name != '\0') {
3268 if (prefix_suffix_match(pattern, name,
3277 EVUTIL_TOLOWER_(c) != EVUTIL_TOLOWER_(*name))
3287 Search the vhost hierarchy beginning with http for a server alias
3288 matching hostname. If a match is found, and outhttp is non-null,
3289 outhttp is set to the matching http object and 1 is returned.
3293 evhttp_find_alias(struct evhttp *http, struct evhttp **outhttp,
3294 const char *hostname)
3296 struct evhttp_server_alias *alias;
3297 struct evhttp *vhost;
3299 TAILQ_FOREACH(alias, &http->aliases, next) {
3300 /* XXX Do we need to handle IP addresses? */
3301 if (!evutil_ascii_strcasecmp(alias->alias, hostname)) {
3308 /* XXX It might be good to avoid recursion here, but I don't
3309 see a way to do that w/o a list. */
3310 TAILQ_FOREACH(vhost, &http->virtualhosts, next_vhost) {
3311 if (evhttp_find_alias(vhost, outhttp, hostname))
3319 Attempts to find the best http object to handle a request for a hostname.
3320 All aliases for the root http object and vhosts are searched for an exact
3321 match. Then, the vhost hierarchy is traversed again for a matching
3324 If an alias or vhost is matched, 1 is returned, and outhttp, if non-null,
3325 is set with the best matching http object. If there are no matches, the
3326 root http object is stored in outhttp and 0 is returned.
3330 evhttp_find_vhost(struct evhttp *http, struct evhttp **outhttp,
3331 const char *hostname)
3333 struct evhttp *vhost;
3334 struct evhttp *oldhttp;
3335 int match_found = 0;
3337 if (evhttp_find_alias(http, outhttp, hostname))
3342 TAILQ_FOREACH(vhost, &http->virtualhosts, next_vhost) {
3343 if (prefix_suffix_match(vhost->vhost_pattern,
3344 hostname, 1 /* ignorecase */)) {
3350 } while (oldhttp != http);
3359 evhttp_handle_request(struct evhttp_request *req, void *arg)
3361 struct evhttp *http = arg;
3362 struct evhttp_cb *cb = NULL;
3363 const char *hostname;
3365 /* we have a new request on which the user needs to take action */
3368 if (req->type == 0 || req->uri == NULL) {
3369 evhttp_send_error(req, req->response_code, NULL);
3373 if ((http->allowed_methods & req->type) == 0) {
3374 event_debug(("Rejecting disallowed method %x (allowed: %x)\n",
3375 (unsigned)req->type, (unsigned)http->allowed_methods));
3376 evhttp_send_error(req, HTTP_NOTIMPLEMENTED, NULL);
3380 /* handle potential virtual hosts */
3381 hostname = evhttp_request_get_host(req);
3382 if (hostname != NULL) {
3383 evhttp_find_vhost(http, &http, hostname);
3386 if ((cb = evhttp_dispatch_callback(&http->callbacks, req)) != NULL) {
3387 (*cb->cb)(req, cb->cbarg);
3391 /* Generic call back */
3393 (*http->gencb)(req, http->gencbarg);
3396 /* We need to send a 404 here */
3397 #define ERR_FORMAT "<html><head>" \
3398 "<title>404 Not Found</title>" \
3400 "<h1>Not Found</h1>" \
3401 "<p>The requested URL %s was not found on this server.</p>"\
3405 struct evbuffer *buf;
3407 if ((escaped_html = evhttp_htmlescape(req->uri)) == NULL) {
3408 evhttp_connection_free(req->evcon);
3412 if ((buf = evbuffer_new()) == NULL) {
3413 mm_free(escaped_html);
3414 evhttp_connection_free(req->evcon);
3418 evhttp_response_code_(req, HTTP_NOTFOUND, "Not Found");
3420 evbuffer_add_printf(buf, ERR_FORMAT, escaped_html);
3422 mm_free(escaped_html);
3424 evhttp_send_page_(req, buf);
3431 /* Listener callback when a connection arrives at a server. */
3433 accept_socket_cb(struct evconnlistener *listener, evutil_socket_t nfd, struct sockaddr *peer_sa, int peer_socklen, void *arg)
3435 struct evhttp *http = arg;
3437 evhttp_get_request(http, nfd, peer_sa, peer_socklen);
3441 evhttp_bind_socket(struct evhttp *http, const char *address, ev_uint16_t port)
3443 struct evhttp_bound_socket *bound =
3444 evhttp_bind_socket_with_handle(http, address, port);
3450 struct evhttp_bound_socket *
3451 evhttp_bind_socket_with_handle(struct evhttp *http, const char *address, ev_uint16_t port)
3454 struct evhttp_bound_socket *bound;
3456 if ((fd = bind_socket(address, port, 1 /*reuse*/)) == -1)
3459 if (listen(fd, 128) == -1) {
3460 event_sock_warn(fd, "%s: listen", __func__);
3461 evutil_closesocket(fd);
3465 bound = evhttp_accept_socket_with_handle(http, fd);
3467 if (bound != NULL) {
3468 event_debug(("Bound to port %d - Awaiting connections ... ",
3477 evhttp_accept_socket(struct evhttp *http, evutil_socket_t fd)
3479 struct evhttp_bound_socket *bound =
3480 evhttp_accept_socket_with_handle(http, fd);
3487 evhttp_foreach_bound_socket(struct evhttp *http,
3488 evhttp_bound_socket_foreach_fn *function,
3491 struct evhttp_bound_socket *bound;
3493 TAILQ_FOREACH(bound, &http->sockets, next)
3494 function(bound, argument);
3497 struct evhttp_bound_socket *
3498 evhttp_accept_socket_with_handle(struct evhttp *http, evutil_socket_t fd)
3500 struct evhttp_bound_socket *bound;
3501 struct evconnlistener *listener;
3503 LEV_OPT_REUSEABLE|LEV_OPT_CLOSE_ON_EXEC|LEV_OPT_CLOSE_ON_FREE;
3505 listener = evconnlistener_new(http->base, NULL, NULL,
3507 0, /* Backlog is '0' because we already said 'listen' */
3512 bound = evhttp_bind_listener(http, listener);
3514 evconnlistener_free(listener);
3520 struct evhttp_bound_socket *
3521 evhttp_bind_listener(struct evhttp *http, struct evconnlistener *listener)
3523 struct evhttp_bound_socket *bound;
3525 bound = mm_malloc(sizeof(struct evhttp_bound_socket));
3529 bound->listener = listener;
3530 TAILQ_INSERT_TAIL(&http->sockets, bound, next);
3532 evconnlistener_set_cb(listener, accept_socket_cb, http);
3537 evhttp_bound_socket_get_fd(struct evhttp_bound_socket *bound)
3539 return evconnlistener_get_fd(bound->listener);
3542 struct evconnlistener *
3543 evhttp_bound_socket_get_listener(struct evhttp_bound_socket *bound)
3545 return bound->listener;
3549 evhttp_del_accept_socket(struct evhttp *http, struct evhttp_bound_socket *bound)
3551 TAILQ_REMOVE(&http->sockets, bound, next);
3552 evconnlistener_free(bound->listener);
3556 static struct evhttp*
3557 evhttp_new_object(void)
3559 struct evhttp *http = NULL;
3561 if ((http = mm_calloc(1, sizeof(struct evhttp))) == NULL) {
3562 event_warn("%s: calloc", __func__);
3566 evutil_timerclear(&http->timeout);
3567 evhttp_set_max_headers_size(http, EV_SIZE_MAX);
3568 evhttp_set_max_body_size(http, EV_SIZE_MAX);
3569 evhttp_set_default_content_type(http, "text/html; charset=ISO-8859-1");
3570 evhttp_set_allowed_methods(http,
3577 TAILQ_INIT(&http->sockets);
3578 TAILQ_INIT(&http->callbacks);
3579 TAILQ_INIT(&http->connections);
3580 TAILQ_INIT(&http->virtualhosts);
3581 TAILQ_INIT(&http->aliases);
3587 evhttp_new(struct event_base *base)
3589 struct evhttp *http = NULL;
3591 http = evhttp_new_object();
3600 * Start a web server on the specified address and port.
3604 evhttp_start(const char *address, unsigned short port)
3606 struct evhttp *http = NULL;
3608 http = evhttp_new_object();
3611 if (evhttp_bind_socket(http, address, port) == -1) {
3620 evhttp_free(struct evhttp* http)
3622 struct evhttp_cb *http_cb;
3623 struct evhttp_connection *evcon;
3624 struct evhttp_bound_socket *bound;
3625 struct evhttp* vhost;
3626 struct evhttp_server_alias *alias;
3628 /* Remove the accepting part */
3629 while ((bound = TAILQ_FIRST(&http->sockets)) != NULL) {
3630 TAILQ_REMOVE(&http->sockets, bound, next);
3632 evconnlistener_free(bound->listener);
3637 while ((evcon = TAILQ_FIRST(&http->connections)) != NULL) {
3638 /* evhttp_connection_free removes the connection */
3639 evhttp_connection_free(evcon);
3642 while ((http_cb = TAILQ_FIRST(&http->callbacks)) != NULL) {
3643 TAILQ_REMOVE(&http->callbacks, http_cb, next);
3644 mm_free(http_cb->what);
3648 while ((vhost = TAILQ_FIRST(&http->virtualhosts)) != NULL) {
3649 TAILQ_REMOVE(&http->virtualhosts, vhost, next_vhost);
3654 if (http->vhost_pattern != NULL)
3655 mm_free(http->vhost_pattern);
3657 while ((alias = TAILQ_FIRST(&http->aliases)) != NULL) {
3658 TAILQ_REMOVE(&http->aliases, alias, next);
3659 mm_free(alias->alias);
3667 evhttp_add_virtual_host(struct evhttp* http, const char *pattern,
3668 struct evhttp* vhost)
3670 /* a vhost can only be a vhost once and should not have bound sockets */
3671 if (vhost->vhost_pattern != NULL ||
3672 TAILQ_FIRST(&vhost->sockets) != NULL)
3675 vhost->vhost_pattern = mm_strdup(pattern);
3676 if (vhost->vhost_pattern == NULL)
3679 TAILQ_INSERT_TAIL(&http->virtualhosts, vhost, next_vhost);
3685 evhttp_remove_virtual_host(struct evhttp* http, struct evhttp* vhost)
3687 if (vhost->vhost_pattern == NULL)
3690 TAILQ_REMOVE(&http->virtualhosts, vhost, next_vhost);
3692 mm_free(vhost->vhost_pattern);
3693 vhost->vhost_pattern = NULL;
3699 evhttp_add_server_alias(struct evhttp *http, const char *alias)
3701 struct evhttp_server_alias *evalias;
3703 evalias = mm_calloc(1, sizeof(*evalias));
3707 evalias->alias = mm_strdup(alias);
3708 if (!evalias->alias) {
3713 TAILQ_INSERT_TAIL(&http->aliases, evalias, next);
3719 evhttp_remove_server_alias(struct evhttp *http, const char *alias)
3721 struct evhttp_server_alias *evalias;
3723 TAILQ_FOREACH(evalias, &http->aliases, next) {
3724 if (evutil_ascii_strcasecmp(evalias->alias, alias) == 0) {
3725 TAILQ_REMOVE(&http->aliases, evalias, next);
3726 mm_free(evalias->alias);
3736 evhttp_set_timeout(struct evhttp* http, int timeout_in_secs)
3738 if (timeout_in_secs == -1) {
3739 evhttp_set_timeout_tv(http, NULL);
3742 tv.tv_sec = timeout_in_secs;
3744 evhttp_set_timeout_tv(http, &tv);
3749 evhttp_set_timeout_tv(struct evhttp* http, const struct timeval* tv)
3752 http->timeout = *tv;
3754 evutil_timerclear(&http->timeout);
3758 int evhttp_set_flags(struct evhttp *http, int flags)
3760 int avail_flags = 0;
3761 avail_flags |= EVHTTP_SERVER_LINGERING_CLOSE;
3763 if (flags & ~avail_flags)
3765 http->flags &= ~avail_flags;
3767 http->flags |= flags;
3773 evhttp_set_max_headers_size(struct evhttp* http, ev_ssize_t max_headers_size)
3775 if (max_headers_size < 0)
3776 http->default_max_headers_size = EV_SIZE_MAX;
3778 http->default_max_headers_size = max_headers_size;
3782 evhttp_set_max_body_size(struct evhttp* http, ev_ssize_t max_body_size)
3784 if (max_body_size < 0)
3785 http->default_max_body_size = EV_UINT64_MAX;
3787 http->default_max_body_size = max_body_size;
3791 evhttp_set_default_content_type(struct evhttp *http,
3792 const char *content_type) {
3793 http->default_content_type = content_type;
3797 evhttp_set_allowed_methods(struct evhttp* http, ev_uint16_t methods)
3799 http->allowed_methods = methods;
3803 evhttp_set_cb(struct evhttp *http, const char *uri,
3804 void (*cb)(struct evhttp_request *, void *), void *cbarg)
3806 struct evhttp_cb *http_cb;
3808 TAILQ_FOREACH(http_cb, &http->callbacks, next) {
3809 if (strcmp(http_cb->what, uri) == 0)
3813 if ((http_cb = mm_calloc(1, sizeof(struct evhttp_cb))) == NULL) {
3814 event_warn("%s: calloc", __func__);
3818 http_cb->what = mm_strdup(uri);
3819 if (http_cb->what == NULL) {
3820 event_warn("%s: strdup", __func__);
3825 http_cb->cbarg = cbarg;
3827 TAILQ_INSERT_TAIL(&http->callbacks, http_cb, next);
3833 evhttp_del_cb(struct evhttp *http, const char *uri)
3835 struct evhttp_cb *http_cb;
3837 TAILQ_FOREACH(http_cb, &http->callbacks, next) {
3838 if (strcmp(http_cb->what, uri) == 0)
3841 if (http_cb == NULL)
3844 TAILQ_REMOVE(&http->callbacks, http_cb, next);
3845 mm_free(http_cb->what);
3852 evhttp_set_gencb(struct evhttp *http,
3853 void (*cb)(struct evhttp_request *, void *), void *cbarg)
3856 http->gencbarg = cbarg;
3860 evhttp_set_bevcb(struct evhttp *http,
3861 struct bufferevent* (*cb)(struct event_base *, void *), void *cbarg)
3864 http->bevcbarg = cbarg;
3868 * Request related functions
3871 struct evhttp_request *
3872 evhttp_request_new(void (*cb)(struct evhttp_request *, void *), void *arg)
3874 struct evhttp_request *req = NULL;
3876 /* Allocate request structure */
3877 if ((req = mm_calloc(1, sizeof(struct evhttp_request))) == NULL) {
3878 event_warn("%s: calloc", __func__);
3882 req->headers_size = 0;
3885 req->kind = EVHTTP_RESPONSE;
3886 req->input_headers = mm_calloc(1, sizeof(struct evkeyvalq));
3887 if (req->input_headers == NULL) {
3888 event_warn("%s: calloc", __func__);
3891 TAILQ_INIT(req->input_headers);
3893 req->output_headers = mm_calloc(1, sizeof(struct evkeyvalq));
3894 if (req->output_headers == NULL) {
3895 event_warn("%s: calloc", __func__);
3898 TAILQ_INIT(req->output_headers);
3900 if ((req->input_buffer = evbuffer_new()) == NULL) {
3901 event_warn("%s: evbuffer_new", __func__);
3905 if ((req->output_buffer = evbuffer_new()) == NULL) {
3906 event_warn("%s: evbuffer_new", __func__);
3917 evhttp_request_free(req);
3922 evhttp_request_free(struct evhttp_request *req)
3924 if ((req->flags & EVHTTP_REQ_DEFER_FREE) != 0) {
3925 req->flags |= EVHTTP_REQ_NEEDS_FREE;
3929 if (req->remote_host != NULL)
3930 mm_free(req->remote_host);
3931 if (req->uri != NULL)
3933 if (req->uri_elems != NULL)
3934 evhttp_uri_free(req->uri_elems);
3935 if (req->response_code_line != NULL)
3936 mm_free(req->response_code_line);
3937 if (req->host_cache != NULL)
3938 mm_free(req->host_cache);
3940 evhttp_clear_headers(req->input_headers);
3941 mm_free(req->input_headers);
3943 evhttp_clear_headers(req->output_headers);
3944 mm_free(req->output_headers);
3946 if (req->input_buffer != NULL)
3947 evbuffer_free(req->input_buffer);
3949 if (req->output_buffer != NULL)
3950 evbuffer_free(req->output_buffer);
3956 evhttp_request_own(struct evhttp_request *req)
3958 req->flags |= EVHTTP_USER_OWNED;
3962 evhttp_request_is_owned(struct evhttp_request *req)
3964 return (req->flags & EVHTTP_USER_OWNED) != 0;
3967 struct evhttp_connection *
3968 evhttp_request_get_connection(struct evhttp_request *req)
3974 evhttp_connection_get_base(struct evhttp_connection *conn)
3980 evhttp_request_set_chunked_cb(struct evhttp_request *req,
3981 void (*cb)(struct evhttp_request *, void *))
3987 evhttp_request_set_header_cb(struct evhttp_request *req,
3988 int (*cb)(struct evhttp_request *, void *))
3990 req->header_cb = cb;
3994 evhttp_request_set_error_cb(struct evhttp_request *req,
3995 void (*cb)(enum evhttp_request_error, void *))
4001 evhttp_request_set_on_complete_cb(struct evhttp_request *req,
4002 void (*cb)(struct evhttp_request *, void *), void *cb_arg)
4004 req->on_complete_cb = cb;
4005 req->on_complete_cb_arg = cb_arg;
4009 * Allows for inspection of the request URI
4013 evhttp_request_get_uri(const struct evhttp_request *req) {
4014 if (req->uri == NULL)
4015 event_debug(("%s: request %p has no uri\n", __func__, req));
4019 const struct evhttp_uri *
4020 evhttp_request_get_evhttp_uri(const struct evhttp_request *req) {
4021 if (req->uri_elems == NULL)
4022 event_debug(("%s: request %p has no uri elems\n",
4024 return (req->uri_elems);
4028 evhttp_request_get_host(struct evhttp_request *req)
4030 const char *host = NULL;
4032 if (req->host_cache)
4033 return req->host_cache;
4036 host = evhttp_uri_get_host(req->uri_elems);
4037 if (!host && req->input_headers) {
4041 host = evhttp_find_header(req->input_headers, "Host");
4042 /* The Host: header may include a port. Remove it here
4043 to be consistent with uri_elems case above. */
4045 p = host + strlen(host) - 1;
4046 while (p > host && EVUTIL_ISDIGIT_(*p))
4048 if (p > host && *p == ':') {
4050 req->host_cache = mm_malloc(len + 1);
4051 if (!req->host_cache) {
4052 event_warn("%s: malloc", __func__);
4055 memcpy(req->host_cache, host, len);
4056 req->host_cache[len] = '\0';
4057 host = req->host_cache;
4065 enum evhttp_cmd_type
4066 evhttp_request_get_command(const struct evhttp_request *req) {
4071 evhttp_request_get_response_code(const struct evhttp_request *req)
4073 return req->response_code;
4077 evhttp_request_get_response_code_line(const struct evhttp_request *req)
4079 return req->response_code_line;
4082 /** Returns the input headers */
4083 struct evkeyvalq *evhttp_request_get_input_headers(struct evhttp_request *req)
4085 return (req->input_headers);
4088 /** Returns the output headers */
4089 struct evkeyvalq *evhttp_request_get_output_headers(struct evhttp_request *req)
4091 return (req->output_headers);
4094 /** Returns the input buffer */
4095 struct evbuffer *evhttp_request_get_input_buffer(struct evhttp_request *req)
4097 return (req->input_buffer);
4100 /** Returns the output buffer */
4101 struct evbuffer *evhttp_request_get_output_buffer(struct evhttp_request *req)
4103 return (req->output_buffer);
4108 * Takes a file descriptor to read a request from.
4109 * The callback is executed once the whole request has been read.
4112 static struct evhttp_connection*
4113 evhttp_get_request_connection(
4114 struct evhttp* http,
4115 evutil_socket_t fd, struct sockaddr *sa, ev_socklen_t salen)
4117 struct evhttp_connection *evcon;
4118 char *hostname = NULL, *portname = NULL;
4119 struct bufferevent* bev = NULL;
4121 name_from_addr(sa, salen, &hostname, &portname);
4122 if (hostname == NULL || portname == NULL) {
4123 if (hostname) mm_free(hostname);
4124 if (portname) mm_free(portname);
4128 event_debug(("%s: new request from %s:%s on "EV_SOCK_FMT"\n",
4129 __func__, hostname, portname, EV_SOCK_ARG(fd)));
4131 /* we need a connection object to put the http request on */
4132 if (http->bevcb != NULL) {
4133 bev = (*http->bevcb)(http->base, http->bevcbarg);
4135 evcon = evhttp_connection_base_bufferevent_new(
4136 http->base, NULL, bev, hostname, atoi(portname));
4142 evcon->max_headers_size = http->default_max_headers_size;
4143 evcon->max_body_size = http->default_max_body_size;
4144 if (http->flags & EVHTTP_SERVER_LINGERING_CLOSE)
4145 evcon->flags |= EVHTTP_CON_LINGERING_CLOSE;
4147 evcon->flags |= EVHTTP_CON_INCOMING;
4148 evcon->state = EVCON_READING_FIRSTLINE;
4152 bufferevent_enable(evcon->bufev, EV_READ);
4153 bufferevent_disable(evcon->bufev, EV_WRITE);
4154 bufferevent_setfd(evcon->bufev, fd);
4160 evhttp_associate_new_request_with_connection(struct evhttp_connection *evcon)
4162 struct evhttp *http = evcon->http_server;
4163 struct evhttp_request *req;
4164 if ((req = evhttp_request_new(evhttp_handle_request, http)) == NULL)
4167 if ((req->remote_host = mm_strdup(evcon->address)) == NULL) {
4168 event_warn("%s: strdup", __func__);
4169 evhttp_request_free(req);
4172 req->remote_port = evcon->port;
4174 req->evcon = evcon; /* the request ends up owning the connection */
4175 req->flags |= EVHTTP_REQ_OWN_CONNECTION;
4177 /* We did not present the request to the user user yet, so treat it as
4178 * if the user was done with the request. This allows us to free the
4179 * request on a persistent connection if the client drops it without
4180 * sending a request.
4184 TAILQ_INSERT_TAIL(&evcon->requests, req, next);
4186 req->kind = EVHTTP_REQUEST;
4189 evhttp_start_read_(evcon);
4195 evhttp_get_request(struct evhttp *http, evutil_socket_t fd,
4196 struct sockaddr *sa, ev_socklen_t salen)
4198 struct evhttp_connection *evcon;
4200 evcon = evhttp_get_request_connection(http, fd, sa, salen);
4201 if (evcon == NULL) {
4202 event_sock_warn(fd, "%s: cannot get connection on "EV_SOCK_FMT,
4203 __func__, EV_SOCK_ARG(fd));
4204 evutil_closesocket(fd);
4208 /* the timeout can be used by the server to close idle connections */
4209 if (evutil_timerisset(&http->timeout))
4210 evhttp_connection_set_timeout_tv(evcon, &http->timeout);
4213 * if we want to accept more than one request on a connection,
4214 * we need to know which http server it belongs to.
4216 evcon->http_server = http;
4217 TAILQ_INSERT_TAIL(&http->connections, evcon, next);
4219 if (evhttp_associate_new_request_with_connection(evcon) == -1)
4220 evhttp_connection_free(evcon);
4225 * Network helper functions that we do not want to export to the rest of
4230 name_from_addr(struct sockaddr *sa, ev_socklen_t salen,
4231 char **phost, char **pport)
4233 char ntop[NI_MAXHOST];
4234 char strport[NI_MAXSERV];
4237 #ifdef EVENT__HAVE_GETNAMEINFO
4238 ni_result = getnameinfo(sa, salen,
4239 ntop, sizeof(ntop), strport, sizeof(strport),
4240 NI_NUMERICHOST|NI_NUMERICSERV);
4242 if (ni_result != 0) {
4244 /* Windows doesn't have an EAI_SYSTEM. */
4245 if (ni_result == EAI_SYSTEM)
4246 event_err(1, "getnameinfo failed");
4249 event_errx(1, "getnameinfo failed: %s", gai_strerror(ni_result));
4253 ni_result = fake_getnameinfo(sa, salen,
4254 ntop, sizeof(ntop), strport, sizeof(strport),
4255 NI_NUMERICHOST|NI_NUMERICSERV);
4260 *phost = mm_strdup(ntop);
4261 *pport = mm_strdup(strport);
4264 /* Create a non-blocking socket and bind it */
4265 /* todo: rename this function */
4266 static evutil_socket_t
4267 bind_socket_ai(struct evutil_addrinfo *ai, int reuse)
4274 /* Create listen socket */
4275 fd = evutil_socket_(ai ? ai->ai_family : AF_INET,
4276 SOCK_STREAM|EVUTIL_SOCK_NONBLOCK|EVUTIL_SOCK_CLOEXEC, 0);
4278 event_sock_warn(-1, "socket");
4282 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE, (void *)&on, sizeof(on))<0)
4285 if (evutil_make_listen_socket_reuseable(fd) < 0)
4290 r = bind(fd, ai->ai_addr, (ev_socklen_t)ai->ai_addrlen);
4298 serrno = EVUTIL_SOCKET_ERROR();
4299 evutil_closesocket(fd);
4300 EVUTIL_SET_SOCKET_ERROR(serrno);
4304 static struct evutil_addrinfo *
4305 make_addrinfo(const char *address, ev_uint16_t port)
4307 struct evutil_addrinfo *ai = NULL;
4309 struct evutil_addrinfo hints;
4310 char strport[NI_MAXSERV];
4313 memset(&hints, 0, sizeof(hints));
4314 hints.ai_family = AF_UNSPEC;
4315 hints.ai_socktype = SOCK_STREAM;
4316 /* turn NULL hostname into INADDR_ANY, and skip looking up any address
4317 * types we don't have an interface to connect to. */
4318 hints.ai_flags = EVUTIL_AI_PASSIVE|EVUTIL_AI_ADDRCONFIG;
4319 evutil_snprintf(strport, sizeof(strport), "%d", port);
4320 if ((ai_result = evutil_getaddrinfo(address, strport, &hints, &ai))
4322 if (ai_result == EVUTIL_EAI_SYSTEM)
4323 event_warn("getaddrinfo");
4325 event_warnx("getaddrinfo: %s",
4326 evutil_gai_strerror(ai_result));
4333 static evutil_socket_t
4334 bind_socket(const char *address, ev_uint16_t port, int reuse)
4337 struct evutil_addrinfo *aitop = NULL;
4339 /* just create an unbound socket */
4340 if (address == NULL && port == 0)
4341 return bind_socket_ai(NULL, 0);
4343 aitop = make_addrinfo(address, port);
4348 fd = bind_socket_ai(aitop, reuse);
4350 evutil_freeaddrinfo(aitop);
4357 char *scheme; /* scheme; e.g http, ftp etc */
4358 char *userinfo; /* userinfo (typically username:pass), or NULL */
4359 char *host; /* hostname, IP address, or NULL */
4360 int port; /* port, or zero */
4361 char *path; /* path, or "". */
4362 char *query; /* query, or NULL */
4363 char *fragment; /* fragment or NULL */
4367 evhttp_uri_new(void)
4369 struct evhttp_uri *uri = mm_calloc(sizeof(struct evhttp_uri), 1);
4376 evhttp_uri_set_flags(struct evhttp_uri *uri, unsigned flags)
4381 /* Return true if the string starting at s and ending immediately before eos
4382 * is a valid URI scheme according to RFC3986
4385 scheme_ok(const char *s, const char *eos)
4387 /* scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." ) */
4388 EVUTIL_ASSERT(eos >= s);
4391 if (!EVUTIL_ISALPHA_(*s))
4394 if (! EVUTIL_ISALNUM_(*s) &&
4395 *s != '+' && *s != '-' && *s != '.')
4401 #define SUBDELIMS "!$&'()*+,;="
4403 /* Return true iff [s..eos) is a valid userinfo */
4405 userinfo_ok(const char *s, const char *eos)
4408 if (CHAR_IS_UNRESERVED(*s) ||
4409 strchr(SUBDELIMS, *s) ||
4412 else if (*s == '%' && s+2 < eos &&
4413 EVUTIL_ISXDIGIT_(s[1]) &&
4414 EVUTIL_ISXDIGIT_(s[2]))
4423 regname_ok(const char *s, const char *eos)
4425 while (s && s<eos) {
4426 if (CHAR_IS_UNRESERVED(*s) ||
4427 strchr(SUBDELIMS, *s))
4429 else if (*s == '%' &&
4430 EVUTIL_ISXDIGIT_(s[1]) &&
4431 EVUTIL_ISXDIGIT_(s[2]))
4440 parse_port(const char *s, const char *eos)
4444 if (! EVUTIL_ISDIGIT_(*s))
4446 portnum = (portnum * 10) + (*s - '0');
4449 if (portnum > 65535)
4456 /* returns 0 for bad, 1 for ipv6, 2 for IPvFuture */
4458 bracket_addr_ok(const char *s, const char *eos)
4460 if (s + 3 > eos || *s != '[' || *(eos-1) != ']')
4463 /* IPvFuture, or junk.
4464 "v" 1*HEXDIG "." 1*( unreserved / sub-delims / ":" )
4466 s += 2; /* skip [v */
4468 if (!EVUTIL_ISXDIGIT_(*s)) /*require at least one*/
4470 while (s < eos && *s != '.') {
4471 if (EVUTIL_ISXDIGIT_(*s))
4480 if (CHAR_IS_UNRESERVED(*s) ||
4481 strchr(SUBDELIMS, *s) ||
4491 ev_ssize_t n_chars = eos-s-2;
4492 struct in6_addr in6;
4493 if (n_chars >= 64) /* way too long */
4495 memcpy(buf, s+1, n_chars);
4497 return (evutil_inet_pton(AF_INET6,buf,&in6)==1) ? 1 : 0;
4502 parse_authority(struct evhttp_uri *uri, char *s, char *eos)
4507 uri->host = mm_strdup("");
4508 if (uri->host == NULL) {
4509 event_warn("%s: strdup", __func__);
4515 /* Optionally, we start with "userinfo@" */
4517 cp = strchr(s, '@');
4518 if (cp && cp < eos) {
4519 if (! userinfo_ok(s,cp))
4522 uri->userinfo = mm_strdup(s);
4523 if (uri->userinfo == NULL) {
4524 event_warn("%s: strdup", __func__);
4530 /* Optionally, we end with ":port" */
4531 for (port=eos-1; port >= cp && EVUTIL_ISDIGIT_(*port); --port)
4533 if (port >= cp && *port == ':') {
4534 if (port+1 == eos) /* Leave port unspecified; the RFC allows a
4537 else if ((uri->port = parse_port(port+1, eos))<0)
4541 /* Now, cp..eos holds the "host" port, which can be an IPv4Address,
4542 * an IP-Literal, or a reg-name */
4543 EVUTIL_ASSERT(eos >= cp);
4544 if (*cp == '[' && eos >= cp+2 && *(eos-1) == ']') {
4545 /* IPv6address, IP-Literal, or junk. */
4546 if (! bracket_addr_ok(cp, eos))
4549 /* Make sure the host part is ok. */
4550 if (! regname_ok(cp,eos)) /* Match IPv4Address or reg-name */
4553 uri->host = mm_malloc(eos-cp+1);
4554 if (uri->host == NULL) {
4555 event_warn("%s: malloc", __func__);
4558 memcpy(uri->host, cp, eos-cp);
4559 uri->host[eos-cp] = '\0';
4565 end_of_authority(char *cp)
4568 if (*cp == '?' || *cp == '#' || *cp == '/')
4581 /* Return the character after the longest prefix of 'cp' that matches...
4582 * *pchar / "/" if allow_qchars is false, or
4583 * *(pchar / "/" / "?") if allow_qchars is true.
4586 end_of_path(char *cp, enum uri_part part, unsigned flags)
4588 if (flags & EVHTTP_URI_NONCONFORMANT) {
4589 /* If NONCONFORMANT:
4590 * Path is everything up to a # or ? or nul.
4591 * Query is everything up a # or nul
4592 * Fragment is everything up to a nul.
4596 while (*cp && *cp != '#' && *cp != '?')
4600 while (*cp && *cp != '#')
4611 if (CHAR_IS_UNRESERVED(*cp) ||
4612 strchr(SUBDELIMS, *cp) ||
4613 *cp == ':' || *cp == '@' || *cp == '/')
4615 else if (*cp == '%' && EVUTIL_ISXDIGIT_(cp[1]) &&
4616 EVUTIL_ISXDIGIT_(cp[2]))
4618 else if (*cp == '?' && part != PART_PATH)
4627 path_matches_noscheme(const char *cp)
4632 else if (*cp == '/')
4640 evhttp_uri_parse(const char *source_uri)
4642 return evhttp_uri_parse_with_flags(source_uri, 0);
4646 evhttp_uri_parse_with_flags(const char *source_uri, unsigned flags)
4648 char *readbuf = NULL, *readp = NULL, *token = NULL, *query = NULL;
4649 char *path = NULL, *fragment = NULL;
4650 int got_authority = 0;
4652 struct evhttp_uri *uri = mm_calloc(1, sizeof(struct evhttp_uri));
4654 event_warn("%s: calloc", __func__);
4660 readbuf = mm_strdup(source_uri);
4661 if (readbuf == NULL) {
4662 event_warn("%s: strdup", __func__);
4669 /* We try to follow RFC3986 here as much as we can, and match
4672 URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
4674 relative-ref = relative-part [ "?" query ] [ "#" fragment ]
4678 token = strchr(readp, ':');
4679 if (token && scheme_ok(readp,token)) {
4681 uri->scheme = mm_strdup(readp);
4682 if (uri->scheme == NULL) {
4683 event_warn("%s: strdup", __func__);
4686 readp = token+1; /* eat : */
4689 /* 2. Optionally, "//" then an 'authority' part. */
4690 if (readp[0]=='/' && readp[1] == '/') {
4694 path = end_of_authority(readp);
4695 if (parse_authority(uri, authority, path) < 0)
4701 /* 3. Query: path-abempty, path-absolute, path-rootless, or path-empty
4704 readp = end_of_path(path, PART_PATH, flags);
4707 if (*readp == '?') {
4711 readp = end_of_path(readp, PART_QUERY, flags);
4714 if (*readp == '#') {
4718 readp = end_of_path(readp, PART_FRAGMENT, flags);
4720 if (*readp != '\0') {
4724 /* These next two cases may be unreachable; I'm leaving them
4725 * in to be defensive. */
4726 /* If you didn't get an authority, the path can't begin with "//" */
4727 if (!got_authority && path[0]=='/' && path[1]=='/')
4729 /* If you did get an authority, the path must begin with "/" or be
4731 if (got_authority && path[0] != '/' && path[0] != '\0')
4733 /* (End of maybe-unreachable cases) */
4735 /* If there was no scheme, the first part of the path (if any) must
4736 * have no colon in it. */
4737 if (! uri->scheme && !path_matches_noscheme(path))
4740 EVUTIL_ASSERT(path);
4741 uri->path = mm_strdup(path);
4742 if (uri->path == NULL) {
4743 event_warn("%s: strdup", __func__);
4748 uri->query = mm_strdup(query);
4749 if (uri->query == NULL) {
4750 event_warn("%s: strdup", __func__);
4755 uri->fragment = mm_strdup(fragment);
4756 if (uri->fragment == NULL) {
4757 event_warn("%s: strdup", __func__);
4767 evhttp_uri_free(uri);
4774 evhttp_uri_free(struct evhttp_uri *uri)
4776 #define URI_FREE_STR_(f) \
4781 URI_FREE_STR_(scheme);
4782 URI_FREE_STR_(userinfo);
4783 URI_FREE_STR_(host);
4784 URI_FREE_STR_(path);
4785 URI_FREE_STR_(query);
4786 URI_FREE_STR_(fragment);
4789 #undef URI_FREE_STR_
4793 evhttp_uri_join(struct evhttp_uri *uri, char *buf, size_t limit)
4795 struct evbuffer *tmp = 0;
4796 size_t joined_size = 0;
4797 char *output = NULL;
4799 #define URI_ADD_(f) evbuffer_add(tmp, uri->f, strlen(uri->f))
4801 if (!uri || !buf || !limit)
4804 tmp = evbuffer_new();
4810 evbuffer_add(tmp, ":", 1);
4813 evbuffer_add(tmp, "//", 2);
4815 evbuffer_add_printf(tmp,"%s@", uri->userinfo);
4818 evbuffer_add_printf(tmp,":%d", uri->port);
4820 if (uri->path && uri->path[0] != '/' && uri->path[0] != '\0')
4828 evbuffer_add(tmp, "?", 1);
4832 if (uri->fragment) {
4833 evbuffer_add(tmp, "#", 1);
4837 evbuffer_add(tmp, "\0", 1); /* NUL */
4839 joined_size = evbuffer_get_length(tmp);
4841 if (joined_size > limit) {
4842 /* It doesn't fit. */
4846 evbuffer_remove(tmp, buf, joined_size);
4857 evhttp_uri_get_scheme(const struct evhttp_uri *uri)
4862 evhttp_uri_get_userinfo(const struct evhttp_uri *uri)
4864 return uri->userinfo;
4867 evhttp_uri_get_host(const struct evhttp_uri *uri)
4872 evhttp_uri_get_port(const struct evhttp_uri *uri)
4877 evhttp_uri_get_path(const struct evhttp_uri *uri)
4882 evhttp_uri_get_query(const struct evhttp_uri *uri)
4887 evhttp_uri_get_fragment(const struct evhttp_uri *uri)
4889 return uri->fragment;
4892 #define URI_SET_STR_(f) do { \
4896 if ((uri->f = mm_strdup(f)) == NULL) { \
4897 event_warn("%s: strdup()", __func__); \
4906 evhttp_uri_set_scheme(struct evhttp_uri *uri, const char *scheme)
4908 if (scheme && !scheme_ok(scheme, scheme+strlen(scheme)))
4911 URI_SET_STR_(scheme);
4915 evhttp_uri_set_userinfo(struct evhttp_uri *uri, const char *userinfo)
4917 if (userinfo && !userinfo_ok(userinfo, userinfo+strlen(userinfo)))
4919 URI_SET_STR_(userinfo);
4923 evhttp_uri_set_host(struct evhttp_uri *uri, const char *host)
4926 if (host[0] == '[') {
4927 if (! bracket_addr_ok(host, host+strlen(host)))
4930 if (! regname_ok(host, host+strlen(host)))
4939 evhttp_uri_set_port(struct evhttp_uri *uri, int port)
4946 #define end_of_cpath(cp,p,f) \
4947 ((const char*)(end_of_path(((char*)(cp)), (p), (f))))
4950 evhttp_uri_set_path(struct evhttp_uri *uri, const char *path)
4952 if (path && end_of_cpath(path, PART_PATH, uri->flags) != path+strlen(path))
4959 evhttp_uri_set_query(struct evhttp_uri *uri, const char *query)
4961 if (query && end_of_cpath(query, PART_QUERY, uri->flags) != query+strlen(query))
4963 URI_SET_STR_(query);
4967 evhttp_uri_set_fragment(struct evhttp_uri *uri, const char *fragment)
4969 if (fragment && end_of_cpath(fragment, PART_FRAGMENT, uri->flags) != fragment+strlen(fragment))
4971 URI_SET_STR_(fragment);