1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * http_protocol.c --- routines which directly communicate with the client.
20 * Code originally by Rob McCool; much redone by Robert S. Thau
21 * and the Apache Software Foundation.
25 #include "apr_strings.h"
26 #include "apr_buckets.h"
28 #include "apr_signal.h"
29 #include "apr_strmatch.h"
31 #define APR_WANT_STDIO /* for sscanf */
32 #define APR_WANT_STRFUNC
33 #define APR_WANT_MEMFUNC
37 #include "util_filter.h"
38 #include "ap_config.h"
40 #include "http_config.h"
41 #include "http_core.h"
42 #include "http_protocol.h"
43 #include "http_main.h"
44 #include "http_request.h"
45 #include "http_vhost.h"
46 #include "http_log.h" /* For errors detected in basic auth common
49 #include "util_charset.h"
50 #include "util_ebcdic.h"
51 #include "scoreboard.h"
62 APR_HOOK_LINK(post_read_request)
63 APR_HOOK_LINK(log_transaction)
64 APR_HOOK_LINK(http_method)
65 APR_HOOK_LINK(default_port)
68 AP_DECLARE_DATA ap_filter_rec_t *ap_old_write_func = NULL;
71 /* Patterns to match in ap_make_content_type() */
72 static const char *needcset[] = {
77 static const apr_strmatch_pattern **needcset_patterns;
78 static const apr_strmatch_pattern *charset_pattern;
80 AP_DECLARE(void) ap_setup_make_content_type(apr_pool_t *pool)
83 for (i = 0; needcset[i]; i++) {
86 needcset_patterns = (const apr_strmatch_pattern **)
87 apr_palloc(pool, (i + 1) * sizeof(apr_strmatch_pattern *));
88 for (i = 0; needcset[i]; i++) {
89 needcset_patterns[i] = apr_strmatch_precompile(pool, needcset[i], 0);
91 needcset_patterns[i] = NULL;
92 charset_pattern = apr_strmatch_precompile(pool, "charset=", 0);
96 * Builds the content-type that should be sent to the client from the
97 * content-type specified. The following rules are followed:
98 * - if type is NULL, type is set to ap_default_type(r)
99 * - if charset adding is disabled, stop processing and return type.
100 * - then, if there are no parameters on type, add the default charset
103 AP_DECLARE(const char *)ap_make_content_type(request_rec *r, const char *type)
105 const apr_strmatch_pattern **pcset;
106 core_dir_config *conf =
107 (core_dir_config *)ap_get_module_config(r->per_dir_config,
109 core_request_config *request_conf;
113 type = ap_default_type(r);
116 if (conf->add_default_charset != ADD_DEFAULT_CHARSET_ON) {
121 ap_get_module_config(r->request_config, &core_module);
122 if (request_conf->suppress_charset) {
126 type_len = strlen(type);
128 if (apr_strmatch(charset_pattern, type, type_len) != NULL) {
129 /* already has parameter, do nothing */
130 /* XXX we don't check the validity */
134 /* see if it makes sense to add the charset. At present,
135 * we only add it if the Content-type is one of needcset[]
137 for (pcset = needcset_patterns; *pcset ; pcset++) {
138 if (apr_strmatch(*pcset, type, type_len) != NULL) {
139 struct iovec concat[3];
140 concat[0].iov_base = (void *)type;
141 concat[0].iov_len = type_len;
142 concat[1].iov_base = (void *)"; charset=";
143 concat[1].iov_len = sizeof("; charset=") - 1;
144 concat[2].iov_base = (void *)(conf->add_default_charset_name);
145 concat[2].iov_len = strlen(conf->add_default_charset_name);
146 type = apr_pstrcatv(r->pool, concat, 3, NULL);
155 AP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t clength)
157 r->clength = clength;
158 apr_table_setn(r->headers_out, "Content-Length",
159 apr_off_t_toa(r->pool, clength));
163 * Return the latest rational time from a request/mtime (modification time)
164 * pair. We return the mtime unless it's in the future, in which case we
165 * return the current time. We use the request time as a reference in order
166 * to limit the number of calls to time(). We don't check for futurosity
167 * unless the mtime is at least as new as the reference.
169 AP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime)
173 /* For all static responses, it's almost certain that the file was
174 * last modified before the beginning of the request. So there's
175 * no reason to call time(NULL) again. But if the response has been
176 * created on demand, then it might be newer than the time the request
177 * started. In this event we really have to call time(NULL) again
178 * so that we can give the clients the most accurate Last-Modified. If we
179 * were given a time in the future, we return the current time - the
180 * Last-Modified can't be in the future.
182 now = (mtime < r->request_time) ? r->request_time : apr_time_now();
183 return (mtime > now) ? now : mtime;
186 /* Min # of bytes to allocate when reading a request line */
187 #define MIN_LINE_ALLOC 80
189 /* Get a line of protocol input, including any continuation lines
190 * caused by MIME folding (or broken clients) if fold != 0, and place it
191 * in the buffer s, of size n bytes, without the ending newline.
193 * If s is NULL, ap_rgetline_core will allocate necessary memory from r->pool.
195 * Returns APR_SUCCESS if there are no problems and sets *read to be
196 * the full length of s.
198 * APR_ENOSPC is returned if there is not enough buffer space.
199 * Other errors may be returned on other errors.
201 * The LF is *not* returned in the buffer. Therefore, a *read of 0
202 * indicates that an empty line was read.
204 * Notes: Because the buffer uses 1 char for NUL, the most we can return is
205 * (n - 1) actual characters.
207 * If no LF is detected on the last line due to a dropped connection
208 * or a full buffer, that's considered an error.
210 AP_DECLARE(apr_status_t) ap_rgetline_core(char **s, apr_size_t n,
211 apr_size_t *read, request_rec *r,
212 int fold, apr_bucket_brigade *bb)
216 apr_size_t bytes_handled = 0, current_alloc = 0;
217 char *pos, *last_char = *s;
218 int do_alloc = (*s == NULL), saw_eos = 0;
221 * Initialize last_char as otherwise a random value will be compared
222 * against APR_ASCII_LF at the end of the loop if bb only contains
223 * zero-length buckets.
229 apr_brigade_cleanup(bb);
230 rv = ap_get_brigade(r->input_filters, bb, AP_MODE_GETLINE,
233 if (rv != APR_SUCCESS) {
237 /* Something horribly wrong happened. Someone didn't block! */
238 if (APR_BRIGADE_EMPTY(bb)) {
242 APR_BRIGADE_FOREACH(e, bb) {
246 /* If we see an EOS, don't bother doing anything more. */
247 if (APR_BUCKET_IS_EOS(e)) {
252 rv = apr_bucket_read(e, &str, &len, APR_BLOCK_READ);
254 if (rv != APR_SUCCESS) {
259 /* no use attempting a zero-byte alloc (hurts when
260 * using --with-efence --enable-pool-debug) or
261 * doing any of the other logic either
266 /* Would this overrun our buffer? If so, we'll die. */
267 if (n < bytes_handled + len) {
268 *read = bytes_handled;
270 /* ensure this string is NUL terminated */
271 if (bytes_handled > 0) {
272 (*s)[bytes_handled-1] = '\0';
281 /* Do we have to handle the allocation ourselves? */
283 /* We'll assume the common case where one bucket is enough. */
286 if (current_alloc < MIN_LINE_ALLOC) {
287 current_alloc = MIN_LINE_ALLOC;
289 *s = apr_palloc(r->pool, current_alloc);
291 else if (bytes_handled + len > current_alloc) {
292 /* Increase the buffer size */
293 apr_size_t new_size = current_alloc * 2;
296 if (bytes_handled + len > new_size) {
297 new_size = (bytes_handled + len) * 2;
300 new_buffer = apr_palloc(r->pool, new_size);
302 /* Copy what we already had. */
303 memcpy(new_buffer, *s, bytes_handled);
304 current_alloc = new_size;
309 /* Just copy the rest of the data to the end of the old buffer. */
310 pos = *s + bytes_handled;
311 memcpy(pos, str, len);
312 last_char = pos + len - 1;
314 /* We've now processed that new data - update accordingly. */
315 bytes_handled += len;
318 /* If we got a full line of input, stop reading */
319 if (last_char && (*last_char == APR_ASCII_LF)) {
324 /* Now NUL-terminate the string at the end of the line;
325 * if the last-but-one character is a CR, terminate there */
326 if (last_char > *s && last_char[-1] == APR_ASCII_CR) {
330 bytes_handled = last_char - *s;
332 /* If we're folding, we have more work to do.
334 * Note that if an EOS was seen, we know we can't have another line.
336 if (fold && bytes_handled && !saw_eos) {
342 /* Clear the temp brigade for this filter read. */
343 apr_brigade_cleanup(bb);
345 /* We only care about the first byte. */
346 rv = ap_get_brigade(r->input_filters, bb, AP_MODE_SPECULATIVE,
349 if (rv != APR_SUCCESS) {
353 if (APR_BRIGADE_EMPTY(bb)) {
357 e = APR_BRIGADE_FIRST(bb);
359 /* If we see an EOS, don't bother doing anything more. */
360 if (APR_BUCKET_IS_EOS(e)) {
364 rv = apr_bucket_read(e, &str, &len, APR_BLOCK_READ);
366 if (rv != APR_SUCCESS) {
367 apr_brigade_cleanup(bb);
371 /* Found one, so call ourselves again to get the next line.
373 * FIXME: If the folding line is completely blank, should we
374 * stop folding? Does that require also looking at the next
377 /* When we call destroy, the buckets are deleted, so save that
378 * one character we need. This simplifies our execution paths
379 * at the cost of one character read.
382 if (c == APR_ASCII_BLANK || c == APR_ASCII_TAB) {
383 /* Do we have enough space? We may be full now. */
384 if (bytes_handled >= n) {
386 /* ensure this string is terminated */
391 apr_size_t next_size, next_len;
394 /* If we're doing the allocations for them, we have to
395 * give ourselves a NULL and copy it on return.
400 /* We're null terminated. */
404 next_size = n - bytes_handled;
406 rv = ap_rgetline_core(&tmp, next_size,
407 &next_len, r, 0, bb);
409 if (rv != APR_SUCCESS) {
413 if (do_alloc && next_len > 0) {
415 apr_size_t new_size = bytes_handled + next_len + 1;
417 /* we need to alloc an extra byte for a null */
418 new_buffer = apr_palloc(r->pool, new_size);
420 /* Copy what we already had. */
421 memcpy(new_buffer, *s, bytes_handled);
423 /* copy the new line, including the trailing null */
424 memcpy(new_buffer + bytes_handled, tmp, next_len + 1);
428 bytes_handled += next_len;
431 else { /* next character is not tab or space */
437 *read = bytes_handled;
441 #if APR_CHARSET_EBCDIC
442 AP_DECLARE(apr_status_t) ap_rgetline(char **s, apr_size_t n,
443 apr_size_t *read, request_rec *r,
444 int fold, apr_bucket_brigade *bb)
446 /* on ASCII boxes, ap_rgetline is a macro which simply invokes
447 * ap_rgetline_core with the same parms
449 * on EBCDIC boxes, each complete http protocol input line needs to be
450 * translated into the code page used by the compiler. Since
451 * ap_rgetline_core uses recursion, we do the translation in a wrapper
452 * function to insure that each input character gets translated only once.
456 rv = ap_rgetline_core(s, n, read, r, fold, bb);
457 if (rv == APR_SUCCESS) {
458 ap_xlate_proto_from_ascii(*s, *read);
464 AP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold)
469 apr_bucket_brigade *tmp_bb;
471 tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
472 rv = ap_rgetline(&tmp_s, n, &len, r, fold, tmp_bb);
473 apr_brigade_destroy(tmp_bb);
475 /* Map the out-of-space condition to the old API. */
476 if (rv == APR_ENOSPC) {
480 /* Anything else is just bad. */
481 if (rv != APR_SUCCESS) {
488 /* parse_uri: break apart the uri
490 * - sets r->args to rest after '?' (or NULL if no '?')
491 * - sets r->uri to request uri (without r->args part)
492 * - sets r->hostname (if not set already) from request (scheme://host:port)
494 AP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri)
496 int status = HTTP_OK;
498 r->unparsed_uri = apr_pstrdup(r->pool, uri);
500 if (r->method_number == M_CONNECT) {
501 status = apr_uri_parse_hostinfo(r->pool, uri, &r->parsed_uri);
504 /* Simple syntax Errors in URLs are trapped by
505 * parse_uri_components().
507 status = apr_uri_parse(r->pool, uri, &r->parsed_uri);
510 if (status == APR_SUCCESS) {
511 /* if it has a scheme we may need to do absoluteURI vhost stuff */
512 if (r->parsed_uri.scheme
513 && !strcasecmp(r->parsed_uri.scheme, ap_http_method(r))) {
514 r->hostname = r->parsed_uri.hostname;
516 else if (r->method_number == M_CONNECT) {
517 r->hostname = r->parsed_uri.hostname;
520 r->args = r->parsed_uri.query;
521 r->uri = r->parsed_uri.path ? r->parsed_uri.path
522 : apr_pstrdup(r->pool, "/");
524 #if defined(OS2) || defined(WIN32)
525 /* Handle path translations for OS/2 and plug security hole.
526 * This will prevent "http://www.wherever.com/..\..\/" from
527 * returning a directory for the root drive.
532 for (x = r->uri; (x = strchr(x, '\\')) != NULL; )
535 #endif /* OS2 || WIN32 */
540 r->status = HTTP_BAD_REQUEST; /* set error status */
541 r->uri = apr_pstrdup(r->pool, uri);
545 static int read_request_line(request_rec *r, apr_bucket_brigade *bb)
552 conn_rec *conn = r->connection;
554 int major = 1, minor = 0; /* Assume HTTP/1.0 if non-"HTTP" protocol */
557 int num_blank_lines = 0;
558 int max_blank_lines = r->server->limit_req_fields;
560 if (max_blank_lines <= 0) {
561 max_blank_lines = DEFAULT_LIMIT_REQUEST_FIELDS;
564 /* Read past empty lines until we get a real request line,
565 * a read error, the connection closes (EOF), or we timeout.
567 * We skip empty lines because browsers have to tack a CRLF on to the end
568 * of POSTs to support old CERN webservers. But note that we may not
569 * have flushed any previous response completely to the client yet.
570 * We delay the flush as long as possible so that we can improve
571 * performance for clients that are pipelining requests. If a request
572 * is pipelined then we won't block during the (implicit) read() below.
573 * If the requests aren't pipelined, then the client is still waiting
574 * for the final buffer flush from us, and we will block in the implicit
575 * read(). B_SAFEREAD ensures that the BUFF layer flushes if it will
576 * have to block during a read.
582 /* insure ap_rgetline allocates memory each time thru the loop
583 * if there are empty lines
585 r->the_request = NULL;
586 rv = ap_rgetline(&(r->the_request), (apr_size_t)(r->server->limit_req_line + 2),
589 if (rv != APR_SUCCESS) {
590 r->request_time = apr_time_now();
592 /* ap_rgetline returns APR_ENOSPC if it fills up the
593 * buffer before finding the end-of-line. This is only going to
594 * happen if it exceeds the configured limit for a request-line.
596 if (rv == APR_ENOSPC) {
597 r->status = HTTP_REQUEST_URI_TOO_LARGE;
598 r->proto_num = HTTP_VERSION(1,0);
599 r->protocol = apr_pstrdup(r->pool, "HTTP/1.0");
604 } while ((len <= 0) && (++num_blank_lines < max_blank_lines));
606 /* we've probably got something to do, ignore graceful restart requests */
608 r->request_time = apr_time_now();
610 r->method = ap_getword_white(r->pool, &ll);
613 /* XXX If we want to keep track of the Method, the protocol module should do
614 * it. That support isn't in the scoreboard yet. Hopefully next week
616 ap_update_connection_status(AP_CHILD_THREAD_FROM_ID(conn->id), "Method",
620 uri = ap_getword_white(r->pool, &ll);
622 /* Provide quick information about the request method as soon as known */
624 r->method_number = ap_method_number_of(r->method);
625 if (r->method_number == M_GET && r->method[0] == 'H') {
629 ap_parse_uri(r, uri);
640 r->protocol = apr_pstrmemdup(r->pool, pro, len);
642 /* XXX ap_update_connection_status(conn->id, "Protocol", r->protocol); */
644 /* Avoid sscanf in the common case */
646 && pro[0] == 'H' && pro[1] == 'T' && pro[2] == 'T' && pro[3] == 'P'
647 && pro[4] == '/' && apr_isdigit(pro[5]) && pro[6] == '.'
648 && apr_isdigit(pro[7])) {
649 r->proto_num = HTTP_VERSION(pro[5] - '0', pro[7] - '0');
651 else if (3 == sscanf(r->protocol, "%4s/%u.%u", http, &major, &minor)
652 && (strcasecmp("http", http) == 0)
653 && (minor < HTTP_VERSION(1, 0)) ) /* don't allow HTTP/0.1000 */
654 r->proto_num = HTTP_VERSION(major, minor);
656 r->proto_num = HTTP_VERSION(1, 0);
661 AP_DECLARE(void) ap_get_mime_headers_core(request_rec *r, apr_bucket_brigade *bb)
663 char *last_field = NULL;
664 apr_size_t last_len = 0;
665 apr_size_t alloc_len = 0;
673 * Read header lines until we get the empty separator line, a read error,
674 * the connection closes (EOF), reach the server limit, or we timeout.
681 rv = ap_rgetline(&field, r->server->limit_req_fieldsize + 2,
684 /* ap_rgetline returns APR_ENOSPC if it fills up the buffer before
685 * finding the end-of-line. This is only going to happen if it
686 * exceeds the configured limit for a field size.
688 if (rv == APR_ENOSPC && field) {
689 r->status = HTTP_BAD_REQUEST;
690 /* insure ap_escape_html will terminate correctly */
691 field[len - 1] = '\0';
692 apr_table_setn(r->notes, "error-notes",
694 "Size of a request header field "
695 "exceeds server limit.<br />\n"
697 ap_escape_html(r->pool, field),
702 if (rv != APR_SUCCESS) {
703 r->status = HTTP_BAD_REQUEST;
707 if (last_field != NULL) {
708 if ((len > 0) && ((*field == '\t') || *field == ' ')) {
709 /* This line is a continuation of the preceding line(s),
710 * so append it to the line that we've set aside.
711 * Note: this uses a power-of-two allocator to avoid
712 * doing O(n) allocs and using O(n^2) space for
713 * continuations that span many many lines.
715 apr_size_t fold_len = last_len + len + 1; /* trailing null */
717 if ((fold_len - 1) > r->server->limit_req_fieldsize) {
718 r->status = HTTP_BAD_REQUEST;
719 /* report what we have accumulated so far before the
720 * overflow (last_field) as the field with the problem
722 apr_table_setn(r->notes, "error-notes",
724 "Size of a request header field "
726 "exceeds server limit.<br />\n"
728 ap_escape_html(r->pool, last_field),
733 if (fold_len > alloc_len) {
735 alloc_len += alloc_len;
736 if (fold_len > alloc_len) {
737 alloc_len = fold_len;
739 fold_buf = (char *)apr_palloc(r->pool, alloc_len);
740 memcpy(fold_buf, last_field, last_len);
741 last_field = fold_buf;
743 memcpy(last_field + last_len, field, len +1); /* +1 for nul */
747 else /* not a continuation line */ {
749 if (r->server->limit_req_fields
750 && (++fields_read > r->server->limit_req_fields)) {
751 r->status = HTTP_BAD_REQUEST;
752 apr_table_setn(r->notes, "error-notes",
753 "The number of request header fields "
754 "exceeds this server's limit.");
758 if (!(value = strchr(last_field, ':'))) { /* Find ':' or */
759 r->status = HTTP_BAD_REQUEST; /* abort bad request */
760 apr_table_setn(r->notes, "error-notes",
762 "Request header field is "
763 "missing ':' separator.<br />\n"
765 ap_escape_html(r->pool,
771 tmp_field = value - 1; /* last character of field-name */
773 *value++ = '\0'; /* NUL-terminate at colon */
775 while (*value == ' ' || *value == '\t') {
776 ++value; /* Skip to start of value */
779 /* Strip LWS after field-name: */
780 while (tmp_field > last_field
781 && (*tmp_field == ' ' || *tmp_field == '\t')) {
785 /* Strip LWS after field-value: */
786 tmp_field = last_field + last_len - 1;
787 while (tmp_field > value
788 && (*tmp_field == ' ' || *tmp_field == '\t')) {
792 apr_table_addn(r->headers_in, last_field, value);
794 /* reset the alloc_len so that we'll allocate a new
795 * buffer if we have to do any more folding: we can't
796 * use the previous buffer because its contents are
797 * now part of r->headers_in
801 } /* end if current line is not a continuation starting with tab */
804 /* Found a blank line, stop. */
809 /* Keep track of this line so that we can parse it on
810 * the next loop iteration. (In the folded case, last_field
811 * has been updated already.)
819 apr_table_compress(r->headers_in, APR_OVERLAP_TABLES_MERGE);
822 AP_DECLARE(void) ap_get_mime_headers(request_rec *r)
824 apr_bucket_brigade *tmp_bb;
825 tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
826 ap_get_mime_headers_core(r, tmp_bb);
827 apr_brigade_destroy(tmp_bb);
830 request_rec *ap_read_request(conn_rec *conn)
836 apr_bucket_brigade *tmp_bb;
838 apr_pool_create(&p, conn->pool);
839 apr_pool_tag(p, "request");
840 r = apr_pcalloc(p, sizeof(request_rec));
842 r->connection = conn;
843 r->server = conn->base_server;
846 r->ap_auth_type = NULL;
848 r->allowed_methods = ap_make_method_list(p, 2);
850 r->headers_in = apr_table_make(r->pool, 25);
851 r->subprocess_env = apr_table_make(r->pool, 25);
852 r->headers_out = apr_table_make(r->pool, 12);
853 r->err_headers_out = apr_table_make(r->pool, 5);
854 r->notes = apr_table_make(r->pool, 5);
856 r->request_config = ap_create_request_config(r->pool);
857 /* Must be set before we run create request hook */
859 r->proto_output_filters = conn->output_filters;
860 r->output_filters = r->proto_output_filters;
861 r->proto_input_filters = conn->input_filters;
862 r->input_filters = r->proto_input_filters;
863 ap_run_create_request(r);
864 r->per_dir_config = r->server->lookup_defaults;
866 r->sent_bodyct = 0; /* bytect isn't for body */
869 r->read_body = REQUEST_NO_BODY;
871 r->status = HTTP_REQUEST_TIME_OUT; /* Until we get a request */
872 r->the_request = NULL;
874 tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
876 /* Get the request... */
877 if (!read_request_line(r, tmp_bb)) {
878 if (r->status == HTTP_REQUEST_URI_TOO_LARGE) {
879 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
880 "request failed: URI too long (longer than %d)", r->server->limit_req_line);
881 ap_send_error_response(r, 0);
882 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
883 ap_run_log_transaction(r);
884 apr_brigade_destroy(tmp_bb);
888 apr_brigade_destroy(tmp_bb);
892 if (!r->assbackwards) {
893 ap_get_mime_headers_core(r, tmp_bb);
894 if (r->status != HTTP_REQUEST_TIME_OUT) {
895 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
896 "request failed: error reading the headers");
897 ap_send_error_response(r, 0);
898 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
899 ap_run_log_transaction(r);
900 apr_brigade_destroy(tmp_bb);
904 if (apr_table_get(r->headers_in, "Transfer-Encoding")
905 && apr_table_get(r->headers_in, "Content-Length")) {
906 /* 2616 section 4.4, point 3: "if both Transfer-Encoding
907 * and Content-Length are received, the latter MUST be
908 * ignored"; so unset it here to prevent any confusion
910 apr_table_unset(r->headers_in, "Content-Length");
914 if (r->header_only) {
916 * Client asked for headers only with HTTP/0.9, which doesn't send
917 * headers! Have to dink things just to make sure the error message
920 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
921 "client sent invalid HTTP/0.9 request: HEAD %s",
924 r->status = HTTP_BAD_REQUEST;
925 ap_send_error_response(r, 0);
926 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
927 ap_run_log_transaction(r);
928 apr_brigade_destroy(tmp_bb);
933 apr_brigade_destroy(tmp_bb);
935 r->status = HTTP_OK; /* Until further notice. */
937 /* update what we think the virtual host is based on the headers we've
938 * now read. may update status.
940 ap_update_vhost_from_headers(r);
942 /* we may have switched to another server */
943 r->per_dir_config = r->server->lookup_defaults;
945 if ((!r->hostname && (r->proto_num >= HTTP_VERSION(1, 1)))
946 || ((r->proto_num == HTTP_VERSION(1, 1))
947 && !apr_table_get(r->headers_in, "Host"))) {
949 * Client sent us an HTTP/1.1 or later request without telling us the
950 * hostname, either with a full URL or a Host: header. We therefore
951 * need to (as per the 1.1 spec) send an error. As a special case,
952 * HTTP/1.1 mentions twice (S9, S14.23) that a request MUST contain
953 * a Host: header, and the server MUST respond with 400 if it doesn't.
955 r->status = HTTP_BAD_REQUEST;
956 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
957 "client sent HTTP/1.1 request without hostname "
958 "(see RFC2616 section 14.23): %s", r->uri);
961 if (r->status != HTTP_OK) {
962 ap_send_error_response(r, 0);
963 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
964 ap_run_log_transaction(r);
968 if (((expect = apr_table_get(r->headers_in, "Expect")) != NULL)
969 && (expect[0] != '\0')) {
971 * The Expect header field was added to HTTP/1.1 after RFC 2068
972 * as a means to signal when a 100 response is desired and,
973 * unfortunately, to signal a poor man's mandatory extension that
974 * the server must understand or return 417 Expectation Failed.
976 if (strcasecmp(expect, "100-continue") == 0) {
977 r->expecting_100 = 1;
980 r->status = HTTP_EXPECTATION_FAILED;
981 ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
982 "client sent an unrecognized expectation value of "
983 "Expect: %s", expect);
984 ap_send_error_response(r, 0);
985 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
986 ap_run_log_transaction(r);
991 ap_add_input_filter_handle(ap_http_input_filter_handle,
992 NULL, r, r->connection);
994 if ((access_status = ap_run_post_read_request(r))) {
995 ap_die(access_status, r);
996 ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
997 ap_run_log_transaction(r);
1005 * A couple of other functions which initialize some of the fields of
1006 * a request structure, as appropriate for adjuncts of one kind or another
1007 * to a request in progress. Best here, rather than elsewhere, since
1008 * *someone* has to set the protocol-specific fields...
1011 AP_DECLARE(void) ap_set_sub_req_protocol(request_rec *rnew,
1012 const request_rec *r)
1014 rnew->the_request = r->the_request; /* Keep original request-line */
1016 rnew->assbackwards = 1; /* Don't send headers from this. */
1017 rnew->no_local_copy = 1; /* Don't try to send HTTP_NOT_MODIFIED for a
1019 rnew->method = "GET";
1020 rnew->method_number = M_GET;
1021 rnew->protocol = "INCLUDED";
1023 rnew->status = HTTP_OK;
1025 rnew->headers_in = apr_table_copy(rnew->pool, r->headers_in);
1026 rnew->subprocess_env = apr_table_copy(rnew->pool, r->subprocess_env);
1027 rnew->headers_out = apr_table_make(rnew->pool, 5);
1028 rnew->err_headers_out = apr_table_make(rnew->pool, 5);
1029 rnew->notes = apr_table_make(rnew->pool, 5);
1031 rnew->expecting_100 = r->expecting_100;
1032 rnew->read_length = r->read_length;
1033 rnew->read_body = REQUEST_NO_BODY;
1035 rnew->main = (request_rec *) r;
1038 static void end_output_stream(request_rec *r)
1040 conn_rec *c = r->connection;
1041 apr_bucket_brigade *bb;
1044 bb = apr_brigade_create(r->pool, c->bucket_alloc);
1045 b = apr_bucket_eos_create(c->bucket_alloc);
1046 APR_BRIGADE_INSERT_TAIL(bb, b);
1047 ap_pass_brigade(r->output_filters, bb);
1050 AP_DECLARE(void) ap_finalize_sub_req_protocol(request_rec *sub)
1052 /* tell the filter chain there is no more content coming */
1053 if (!sub->eos_sent) {
1054 end_output_stream(sub);
1058 /* finalize_request_protocol is called at completion of sending the
1059 * response. Its sole purpose is to send the terminating protocol
1060 * information for any wrappers around the response message body
1061 * (i.e., transfer encodings). It should have been named finalize_response.
1063 AP_DECLARE(void) ap_finalize_request_protocol(request_rec *r)
1065 (void) ap_discard_request_body(r);
1067 /* tell the filter chain there is no more content coming */
1069 end_output_stream(r);
1074 * Support for the Basic authentication protocol, and a bit for Digest.
1076 AP_DECLARE(void) ap_note_auth_failure(request_rec *r)
1078 const char *type = ap_auth_type(r);
1080 if (!strcasecmp(type, "Basic"))
1081 ap_note_basic_auth_failure(r);
1082 else if (!strcasecmp(type, "Digest"))
1083 ap_note_digest_auth_failure(r);
1086 ap_log_rerror(APLOG_MARK, APLOG_ERR,
1087 0, r, "need AuthType to note auth failure: %s", r->uri);
1091 AP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r)
1093 const char *type = ap_auth_type(r);
1095 /* if there is no AuthType configure or it is something other than
1096 * Basic, let ap_note_auth_failure() deal with it
1098 if (!type || strcasecmp(type, "Basic"))
1099 ap_note_auth_failure(r);
1101 apr_table_setn(r->err_headers_out,
1102 (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate"
1103 : "WWW-Authenticate",
1104 apr_pstrcat(r->pool, "Basic realm=\"", ap_auth_name(r),
1108 AP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r)
1110 apr_table_setn(r->err_headers_out,
1111 (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate"
1112 : "WWW-Authenticate",
1113 /* need APR_TIME_T_FMT_HEX */
1114 apr_psprintf(r->pool, "Digest realm=\"%s\", nonce=\"%llx\"",
1115 ap_auth_name(r), r->request_time));
1118 AP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw)
1120 const char *auth_line = apr_table_get(r->headers_in,
1121 (PROXYREQ_PROXY == r->proxyreq)
1122 ? "Proxy-Authorization"
1126 if (!(t = ap_auth_type(r)) || strcasecmp(t, "Basic"))
1129 if (!ap_auth_name(r)) {
1130 ap_log_rerror(APLOG_MARK, APLOG_ERR,
1131 0, r, "need AuthName: %s", r->uri);
1132 return HTTP_INTERNAL_SERVER_ERROR;
1136 ap_note_basic_auth_failure(r);
1137 return HTTP_UNAUTHORIZED;
1140 if (strcasecmp(ap_getword(r->pool, &auth_line, ' '), "Basic")) {
1141 /* Client tried to authenticate using wrong auth scheme */
1142 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1143 "client used wrong authentication scheme: %s", r->uri);
1144 ap_note_basic_auth_failure(r);
1145 return HTTP_UNAUTHORIZED;
1148 while (*auth_line == ' ' || *auth_line == '\t') {
1152 t = ap_pbase64decode(r->pool, auth_line);
1153 r->user = ap_getword_nulls (r->pool, &t, ':');
1154 r->ap_auth_type = "Basic";
1161 struct content_length_ctx {
1162 int data_sent; /* true if the C-L filter has already sent at
1163 * least one bucket on to the next output filter
1168 /* This filter computes the content length, but it also computes the number
1169 * of bytes sent to the client. This means that this filter will always run
1170 * through all of the buckets in all brigades
1172 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_content_length_filter(
1174 apr_bucket_brigade *b)
1176 request_rec *r = f->r;
1177 struct content_length_ctx *ctx;
1180 apr_read_type_e eblock = APR_NONBLOCK_READ;
1184 f->ctx = ctx = apr_palloc(r->pool, sizeof(*ctx));
1188 /* Loop through this set of buckets to compute their length
1190 e = APR_BRIGADE_FIRST(b);
1191 while (e != APR_BRIGADE_SENTINEL(b)) {
1192 if (APR_BUCKET_IS_EOS(e)) {
1196 if (e->length == (apr_size_t)-1) {
1198 const char *ignored;
1201 /* This is probably a pipe bucket. Send everything
1202 * prior to this, and then read the data for this bucket.
1204 rv = apr_bucket_read(e, &ignored, &len, eblock);
1205 if (rv == APR_SUCCESS) {
1206 /* Attempt a nonblocking read next time through */
1207 eblock = APR_NONBLOCK_READ;
1208 r->bytes_sent += len;
1210 else if (APR_STATUS_IS_EAGAIN(rv)) {
1211 /* Output everything prior to this bucket, and then
1212 * do a blocking read on the next batch.
1214 if (e != APR_BRIGADE_FIRST(b)) {
1215 apr_bucket_brigade *split = apr_brigade_split(b, e);
1216 apr_bucket *flush = apr_bucket_flush_create(r->connection->bucket_alloc);
1218 APR_BRIGADE_INSERT_TAIL(b, flush);
1219 rv = ap_pass_brigade(f->next, b);
1220 if (rv != APR_SUCCESS || f->c->aborted) {
1221 apr_brigade_destroy(split);
1225 e = APR_BRIGADE_FIRST(b);
1229 eblock = APR_BLOCK_READ;
1233 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
1234 "ap_content_length_filter: "
1235 "apr_bucket_read() failed");
1240 r->bytes_sent += e->length;
1242 e = APR_BUCKET_NEXT(e);
1245 /* If we've now seen the entire response and it's otherwise
1246 * okay to set the C-L in the response header, then do so now.
1248 * We can only set a C-L in the response header if we haven't already
1249 * sent any buckets on to the next output filter for this request.
1251 if (ctx->data_sent == 0 && eos &&
1252 /* don't whack the C-L if it has already been set for a HEAD
1253 * by something like proxy. the brigade only has an EOS bucket
1254 * in this case, making r->bytes_sent zero.
1256 * if r->bytes_sent > 0 we have a (temporary) body whose length may
1257 * have been changed by a filter. the C-L header might not have been
1258 * updated so we do it here. long term it would be cleaner to have
1259 * such filters update or remove the C-L header, and just use it
1262 !(r->header_only && r->bytes_sent == 0 &&
1263 apr_table_get(r->headers_out, "Content-Length"))) {
1264 ap_set_content_length(r, r->bytes_sent);
1268 return ap_pass_brigade(f->next, b);
1272 * Send the body of a response to the client.
1274 AP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r,
1275 apr_off_t offset, apr_size_t len,
1278 conn_rec *c = r->connection;
1279 apr_bucket_brigade *bb = NULL;
1283 bb = apr_brigade_create(r->pool, c->bucket_alloc);
1284 b = apr_bucket_file_create(fd, offset, len, r->pool, c->bucket_alloc);
1285 APR_BRIGADE_INSERT_TAIL(bb, b);
1287 rv = ap_pass_brigade(r->output_filters, bb);
1288 if (rv != APR_SUCCESS) {
1289 *nbytes = 0; /* no way to tell how many were actually sent */
1299 /* send data from an in-memory buffer */
1300 AP_DECLARE(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset,
1303 conn_rec *c = r->connection;
1304 apr_bucket_brigade *bb = NULL;
1307 bb = apr_brigade_create(r->pool, c->bucket_alloc);
1308 b = apr_bucket_mmap_create(mm, offset, length, c->bucket_alloc);
1309 APR_BRIGADE_INSERT_TAIL(bb, b);
1310 ap_pass_brigade(r->output_filters, bb);
1312 return mm->size; /* XXX - change API to report apr_status_t? */
1314 #endif /* APR_HAS_MMAP */
1317 apr_bucket_brigade *bb;
1318 } old_write_filter_ctx;
1320 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(
1321 ap_filter_t *f, apr_bucket_brigade *bb)
1323 old_write_filter_ctx *ctx = f->ctx;
1325 AP_DEBUG_ASSERT(ctx);
1328 /* whatever is coming down the pipe (we don't care), we
1329 * can simply insert our buffered data at the front and
1330 * pass the whole bundle down the chain.
1332 APR_BRIGADE_CONCAT(ctx->bb, bb);
1337 return ap_pass_brigade(f->next, bb);
1340 static apr_status_t buffer_output(request_rec *r,
1341 const char *str, apr_size_t len)
1343 conn_rec *c = r->connection;
1345 old_write_filter_ctx *ctx;
1350 /* future optimization: record some flags in the request_rec to
1351 * say whether we've added our filter, and whether it is first.
1354 /* this will typically exit on the first test */
1355 for (f = r->output_filters; f != NULL; f = f->next) {
1356 if (ap_old_write_func == f->frec)
1361 /* our filter hasn't been added yet */
1362 ctx = apr_pcalloc(r->pool, sizeof(*ctx));
1363 ap_add_output_filter("OLD_WRITE", ctx, r, r->connection);
1364 f = r->output_filters;
1367 /* if the first filter is not our buffering filter, then we have to
1368 * deliver the content through the normal filter chain
1370 if (f != r->output_filters) {
1371 apr_bucket_brigade *bb = apr_brigade_create(r->pool, c->bucket_alloc);
1372 apr_bucket *b = apr_bucket_transient_create(str, len, c->bucket_alloc);
1373 APR_BRIGADE_INSERT_TAIL(bb, b);
1375 return ap_pass_brigade(r->output_filters, bb);
1378 /* grab the context from our filter */
1379 ctx = r->output_filters->ctx;
1381 if (ctx->bb == NULL) {
1382 ctx->bb = apr_brigade_create(r->pool, c->bucket_alloc);
1385 return ap_fwrite(f->next, ctx->bb, str, len);
1388 AP_DECLARE(int) ap_rputc(int c, request_rec *r)
1392 if (r->connection->aborted) {
1396 if (buffer_output(r, &c2, 1) != APR_SUCCESS)
1402 AP_DECLARE(int) ap_rputs(const char *str, request_rec *r)
1406 if (r->connection->aborted)
1409 if (buffer_output(r, str, len = strlen(str)) != APR_SUCCESS)
1415 AP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r)
1417 if (r->connection->aborted)
1420 if (buffer_output(r, buf, nbyte) != APR_SUCCESS)
1426 struct ap_vrprintf_data {
1427 apr_vformatter_buff_t vbuff;
1432 static apr_status_t r_flush(apr_vformatter_buff_t *buff)
1434 /* callback function passed to ap_vformatter to be called when
1435 * vformatter needs to write into buff and buff.curpos > buff.endpos */
1437 /* ap_vrprintf_data passed as a apr_vformatter_buff_t, which is then
1438 * "downcast" to an ap_vrprintf_data */
1439 struct ap_vrprintf_data *vd = (struct ap_vrprintf_data*)buff;
1441 if (vd->r->connection->aborted)
1444 /* r_flush is called when vbuff is completely full */
1445 if (buffer_output(vd->r, vd->buff, AP_IOBUFSIZE)) {
1449 /* reset the buffer position */
1450 vd->vbuff.curpos = vd->buff;
1451 vd->vbuff.endpos = vd->buff + AP_IOBUFSIZE;
1456 AP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list va)
1459 struct ap_vrprintf_data vd;
1460 char vrprintf_buf[AP_IOBUFSIZE];
1462 vd.vbuff.curpos = vrprintf_buf;
1463 vd.vbuff.endpos = vrprintf_buf + AP_IOBUFSIZE;
1465 vd.buff = vrprintf_buf;
1467 if (r->connection->aborted)
1470 written = apr_vformatter(r_flush, &vd.vbuff, fmt, va);
1472 /* tack on null terminator on remaining string */
1473 *(vd.vbuff.curpos) = '\0';
1475 if (written != -1) {
1476 int n = vd.vbuff.curpos - vrprintf_buf;
1478 /* last call to buffer_output, to finish clearing the buffer */
1479 if (buffer_output(r, vrprintf_buf,n) != APR_SUCCESS)
1488 AP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt, ...)
1493 if (r->connection->aborted)
1497 n = ap_vrprintf(r, fmt, va);
1503 AP_DECLARE_NONSTD(int) ap_rvputs(request_rec *r, ...)
1508 apr_size_t written = 0;
1510 if (r->connection->aborted)
1513 /* ### TODO: if the total output is large, put all the strings
1514 * ### into a single brigade, rather than flushing each time we
1515 * ### fill the buffer
1519 s = va_arg(va, const char *);
1524 if (buffer_output(r, s, len) != APR_SUCCESS) {
1535 AP_DECLARE(int) ap_rflush(request_rec *r)
1537 conn_rec *c = r->connection;
1538 apr_bucket_brigade *bb;
1541 bb = apr_brigade_create(r->pool, c->bucket_alloc);
1542 b = apr_bucket_flush_create(c->bucket_alloc);
1543 APR_BRIGADE_INSERT_TAIL(bb, b);
1544 if (ap_pass_brigade(r->output_filters, bb) != APR_SUCCESS)
1551 * This function sets the Last-Modified output header field to the value
1552 * of the mtime field in the request structure - rationalized to keep it from
1553 * being in the future.
1555 AP_DECLARE(void) ap_set_last_modified(request_rec *r)
1557 if (!r->assbackwards) {
1558 apr_time_t mod_time = ap_rationalize_mtime(r, r->mtime);
1559 char *datestr = apr_palloc(r->pool, APR_RFC822_DATE_LEN);
1561 apr_rfc822_date(datestr, mod_time);
1562 apr_table_setn(r->headers_out, "Last-Modified", datestr);
1566 AP_IMPLEMENT_HOOK_RUN_ALL(int,post_read_request,
1567 (request_rec *r), (r), OK, DECLINED)
1568 AP_IMPLEMENT_HOOK_RUN_ALL(int,log_transaction,
1569 (request_rec *r), (r), OK, DECLINED)
1570 AP_IMPLEMENT_HOOK_RUN_FIRST(const char *,http_method,
1571 (const request_rec *r), (r), NULL)
1572 AP_IMPLEMENT_HOOK_RUN_FIRST(unsigned short,default_port,
1573 (const request_rec *r), (r), 0)