]> granicus.if.org Git - apache/blob - server/protocol.c
core, mod_deflate, mod_sed: Reduce memory usage by reusing bucket
[apache] / server / protocol.c
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
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /*
18  * http_protocol.c --- routines which directly communicate with the client.
19  *
20  * Code originally by Rob McCool; much redone by Robert S. Thau
21  * and the Apache Software Foundation.
22  */
23
24 #include "apr.h"
25 #include "apr_strings.h"
26 #include "apr_buckets.h"
27 #include "apr_lib.h"
28 #include "apr_signal.h"
29 #include "apr_strmatch.h"
30
31 #define APR_WANT_STDIO          /* for sscanf */
32 #define APR_WANT_STRFUNC
33 #define APR_WANT_MEMFUNC
34 #include "apr_want.h"
35
36 #include "util_filter.h"
37 #include "ap_config.h"
38 #include "httpd.h"
39 #include "http_config.h"
40 #include "http_core.h"
41 #include "http_protocol.h"
42 #include "http_main.h"
43 #include "http_request.h"
44 #include "http_vhost.h"
45 #include "http_log.h"           /* For errors detected in basic auth common
46                                  * support code... */
47 #include "mod_core.h"
48 #include "util_charset.h"
49 #include "util_ebcdic.h"
50 #include "scoreboard.h"
51
52 #if APR_HAVE_STDARG_H
53 #include <stdarg.h>
54 #endif
55 #if APR_HAVE_UNISTD_H
56 #include <unistd.h>
57 #endif
58
59
60 APR_HOOK_STRUCT(
61     APR_HOOK_LINK(post_read_request)
62     APR_HOOK_LINK(log_transaction)
63     APR_HOOK_LINK(http_scheme)
64     APR_HOOK_LINK(default_port)
65 )
66
67 AP_DECLARE_DATA ap_filter_rec_t *ap_old_write_func = NULL;
68
69
70 /* Patterns to match in ap_make_content_type() */
71 static const char *needcset[] = {
72     "text/plain",
73     "text/html",
74     NULL
75 };
76 static const apr_strmatch_pattern **needcset_patterns;
77 static const apr_strmatch_pattern *charset_pattern;
78
79 AP_DECLARE(void) ap_setup_make_content_type(apr_pool_t *pool)
80 {
81     int i;
82     for (i = 0; needcset[i]; i++) {
83         continue;
84     }
85     needcset_patterns = (const apr_strmatch_pattern **)
86         apr_palloc(pool, (i + 1) * sizeof(apr_strmatch_pattern *));
87     for (i = 0; needcset[i]; i++) {
88         needcset_patterns[i] = apr_strmatch_precompile(pool, needcset[i], 0);
89     }
90     needcset_patterns[i] = NULL;
91     charset_pattern = apr_strmatch_precompile(pool, "charset=", 0);
92 }
93
94 /*
95  * Builds the content-type that should be sent to the client from the
96  * content-type specified.  The following rules are followed:
97  *    - if type is NULL or "", return NULL (do not set content-type).
98  *    - if charset adding is disabled, stop processing and return type.
99  *    - then, if there are no parameters on type, add the default charset
100  *    - return type
101  */
102 AP_DECLARE(const char *)ap_make_content_type(request_rec *r, const char *type)
103 {
104     const apr_strmatch_pattern **pcset;
105     core_dir_config *conf =
106         (core_dir_config *)ap_get_module_config(r->per_dir_config,
107                                                 &core_module);
108     core_request_config *request_conf;
109     apr_size_t type_len;
110
111     if (!type || *type == '\0') {
112         return NULL;
113     }
114
115     if (conf->add_default_charset != ADD_DEFAULT_CHARSET_ON) {
116         return type;
117     }
118
119     request_conf =
120         ap_get_module_config(r->request_config, &core_module);
121     if (request_conf->suppress_charset) {
122         return type;
123     }
124
125     type_len = strlen(type);
126
127     if (apr_strmatch(charset_pattern, type, type_len) != NULL) {
128         /* already has parameter, do nothing */
129         /* XXX we don't check the validity */
130         ;
131     }
132     else {
133         /* see if it makes sense to add the charset. At present,
134          * we only add it if the Content-type is one of needcset[]
135          */
136         for (pcset = needcset_patterns; *pcset ; pcset++) {
137             if (apr_strmatch(*pcset, type, type_len) != NULL) {
138                 struct iovec concat[3];
139                 concat[0].iov_base = (void *)type;
140                 concat[0].iov_len = type_len;
141                 concat[1].iov_base = (void *)"; charset=";
142                 concat[1].iov_len = sizeof("; charset=") - 1;
143                 concat[2].iov_base = (void *)(conf->add_default_charset_name);
144                 concat[2].iov_len = strlen(conf->add_default_charset_name);
145                 type = apr_pstrcatv(r->pool, concat, 3, NULL);
146                 break;
147             }
148         }
149     }
150
151     return type;
152 }
153
154 AP_DECLARE(void) ap_set_content_length(request_rec *r, apr_off_t clength)
155 {
156     r->clength = clength;
157     apr_table_setn(r->headers_out, "Content-Length",
158                    apr_off_t_toa(r->pool, clength));
159 }
160
161 /*
162  * Return the latest rational time from a request/mtime (modification time)
163  * pair.  We return the mtime unless it's in the future, in which case we
164  * return the current time.  We use the request time as a reference in order
165  * to limit the number of calls to time().  We don't check for futurosity
166  * unless the mtime is at least as new as the reference.
167  */
168 AP_DECLARE(apr_time_t) ap_rationalize_mtime(request_rec *r, apr_time_t mtime)
169 {
170     apr_time_t now;
171
172     /* For all static responses, it's almost certain that the file was
173      * last modified before the beginning of the request.  So there's
174      * no reason to call time(NULL) again.  But if the response has been
175      * created on demand, then it might be newer than the time the request
176      * started.  In this event we really have to call time(NULL) again
177      * so that we can give the clients the most accurate Last-Modified.  If we
178      * were given a time in the future, we return the current time - the
179      * Last-Modified can't be in the future.
180      */
181     now = (mtime < r->request_time) ? r->request_time : apr_time_now();
182     return (mtime > now) ? now : mtime;
183 }
184
185 /* Min # of bytes to allocate when reading a request line */
186 #define MIN_LINE_ALLOC 80
187
188 /* Get a line of protocol input, including any continuation lines
189  * caused by MIME folding (or broken clients) if fold != 0, and place it
190  * in the buffer s, of size n bytes, without the ending newline.
191  *
192  * If s is NULL, ap_rgetline_core will allocate necessary memory from r->pool.
193  *
194  * Returns APR_SUCCESS if there are no problems and sets *read to be
195  * the full length of s.
196  *
197  * APR_ENOSPC is returned if there is not enough buffer space.
198  * Other errors may be returned on other errors.
199  *
200  * The LF is *not* returned in the buffer.  Therefore, a *read of 0
201  * indicates that an empty line was read.
202  *
203  * Notes: Because the buffer uses 1 char for NUL, the most we can return is
204  *        (n - 1) actual characters.
205  *
206  *        If no LF is detected on the last line due to a dropped connection
207  *        or a full buffer, that's considered an error.
208  */
209 AP_DECLARE(apr_status_t) ap_rgetline_core(char **s, apr_size_t n,
210                                           apr_size_t *read, request_rec *r,
211                                           int fold, apr_bucket_brigade *bb)
212 {
213     apr_status_t rv;
214     apr_bucket *e;
215     apr_size_t bytes_handled = 0, current_alloc = 0;
216     char *pos, *last_char = *s;
217     int do_alloc = (*s == NULL), saw_eos = 0;
218
219     /*
220      * Initialize last_char as otherwise a random value will be compared
221      * against APR_ASCII_LF at the end of the loop if bb only contains
222      * zero-length buckets.
223      */
224     if (last_char)
225         *last_char = '\0';
226
227     for (;;) {
228         apr_brigade_cleanup(bb);
229         rv = ap_get_brigade(r->input_filters, bb, AP_MODE_GETLINE,
230                             APR_BLOCK_READ, 0);
231         if (rv != APR_SUCCESS) {
232             return rv;
233         }
234
235         /* Something horribly wrong happened.  Someone didn't block! */
236         if (APR_BRIGADE_EMPTY(bb)) {
237             return APR_EGENERAL;
238         }
239
240         for (e = APR_BRIGADE_FIRST(bb);
241              e != APR_BRIGADE_SENTINEL(bb);
242              e = APR_BUCKET_NEXT(e))
243         {
244             const char *str;
245             apr_size_t len;
246
247             /* If we see an EOS, don't bother doing anything more. */
248             if (APR_BUCKET_IS_EOS(e)) {
249                 saw_eos = 1;
250                 break;
251             }
252
253             rv = apr_bucket_read(e, &str, &len, APR_BLOCK_READ);
254             if (rv != APR_SUCCESS) {
255                 return rv;
256             }
257
258             if (len == 0) {
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
262                  */
263                 continue;
264             }
265
266             /* Would this overrun our buffer?  If so, we'll die. */
267             if (n < bytes_handled + len) {
268                 *read = bytes_handled;
269                 if (*s) {
270                     /* ensure this string is NUL terminated */
271                     if (bytes_handled > 0) {
272                         (*s)[bytes_handled-1] = '\0';
273                     }
274                     else {
275                         (*s)[0] = '\0';
276                     }
277                 }
278                 return APR_ENOSPC;
279             }
280
281             /* Do we have to handle the allocation ourselves? */
282             if (do_alloc) {
283                 /* We'll assume the common case where one bucket is enough. */
284                 if (!*s) {
285                     current_alloc = len;
286                     if (current_alloc < MIN_LINE_ALLOC) {
287                         current_alloc = MIN_LINE_ALLOC;
288                     }
289                     *s = apr_palloc(r->pool, current_alloc);
290                 }
291                 else if (bytes_handled + len > current_alloc) {
292                     /* Increase the buffer size */
293                     apr_size_t new_size = current_alloc * 2;
294                     char *new_buffer;
295
296                     if (bytes_handled + len > new_size) {
297                         new_size = (bytes_handled + len) * 2;
298                     }
299
300                     new_buffer = apr_palloc(r->pool, new_size);
301
302                     /* Copy what we already had. */
303                     memcpy(new_buffer, *s, bytes_handled);
304                     current_alloc = new_size;
305                     *s = new_buffer;
306                 }
307             }
308
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;
313
314             /* We've now processed that new data - update accordingly. */
315             bytes_handled += len;
316         }
317
318         /* If we got a full line of input, stop reading */
319         if (last_char && (*last_char == APR_ASCII_LF)) {
320             break;
321         }
322     }
323
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) {
327         last_char--;
328     }
329     *last_char = '\0';
330     bytes_handled = last_char - *s;
331
332     /* If we're folding, we have more work to do.
333      *
334      * Note that if an EOS was seen, we know we can't have another line.
335      */
336     if (fold && bytes_handled && !saw_eos) {
337         for (;;) {
338             const char *str;
339             apr_size_t len;
340             char c;
341
342             /* Clear the temp brigade for this filter read. */
343             apr_brigade_cleanup(bb);
344
345             /* We only care about the first byte. */
346             rv = ap_get_brigade(r->input_filters, bb, AP_MODE_SPECULATIVE,
347                                 APR_BLOCK_READ, 1);
348             if (rv != APR_SUCCESS) {
349                 return rv;
350             }
351
352             if (APR_BRIGADE_EMPTY(bb)) {
353                 break;
354             }
355
356             e = APR_BRIGADE_FIRST(bb);
357
358             /* If we see an EOS, don't bother doing anything more. */
359             if (APR_BUCKET_IS_EOS(e)) {
360                 break;
361             }
362
363             rv = apr_bucket_read(e, &str, &len, APR_BLOCK_READ);
364             if (rv != APR_SUCCESS) {
365                 apr_brigade_cleanup(bb);
366                 return rv;
367             }
368
369             /* Found one, so call ourselves again to get the next line.
370              *
371              * FIXME: If the folding line is completely blank, should we
372              * stop folding?  Does that require also looking at the next
373              * char?
374              */
375             /* When we call destroy, the buckets are deleted, so save that
376              * one character we need.  This simplifies our execution paths
377              * at the cost of one character read.
378              */
379             c = *str;
380             if (c == APR_ASCII_BLANK || c == APR_ASCII_TAB) {
381                 /* Do we have enough space? We may be full now. */
382                 if (bytes_handled >= n) {
383                     *read = n;
384                     /* ensure this string is terminated */
385                     (*s)[n-1] = '\0';
386                     return APR_ENOSPC;
387                 }
388                 else {
389                     apr_size_t next_size, next_len;
390                     char *tmp;
391
392                     /* If we're doing the allocations for them, we have to
393                      * give ourselves a NULL and copy it on return.
394                      */
395                     if (do_alloc) {
396                         tmp = NULL;
397                     } else {
398                         /* We're null terminated. */
399                         tmp = last_char;
400                     }
401
402                     next_size = n - bytes_handled;
403
404                     rv = ap_rgetline_core(&tmp, next_size,
405                                           &next_len, r, 0, bb);
406                     if (rv != APR_SUCCESS) {
407                         return rv;
408                     }
409
410                     if (do_alloc && next_len > 0) {
411                         char *new_buffer;
412                         apr_size_t new_size = bytes_handled + next_len + 1;
413
414                         /* we need to alloc an extra byte for a null */
415                         new_buffer = apr_palloc(r->pool, new_size);
416
417                         /* Copy what we already had. */
418                         memcpy(new_buffer, *s, bytes_handled);
419
420                         /* copy the new line, including the trailing null */
421                         memcpy(new_buffer + bytes_handled, tmp, next_len + 1);
422                         *s = new_buffer;
423                     }
424
425                     last_char += next_len;
426                     bytes_handled += next_len;
427                 }
428             }
429             else { /* next character is not tab or space */
430                 break;
431             }
432         }
433     }
434
435     *read = bytes_handled;
436     return APR_SUCCESS;
437 }
438
439 #if APR_CHARSET_EBCDIC
440 AP_DECLARE(apr_status_t) ap_rgetline(char **s, apr_size_t n,
441                                      apr_size_t *read, request_rec *r,
442                                      int fold, apr_bucket_brigade *bb)
443 {
444     /* on ASCII boxes, ap_rgetline is a macro which simply invokes
445      * ap_rgetline_core with the same parms
446      *
447      * on EBCDIC boxes, each complete http protocol input line needs to be
448      * translated into the code page used by the compiler.  Since
449      * ap_rgetline_core uses recursion, we do the translation in a wrapper
450      * function to insure that each input character gets translated only once.
451      */
452     apr_status_t rv;
453
454     rv = ap_rgetline_core(s, n, read, r, fold, bb);
455     if (rv == APR_SUCCESS) {
456         ap_xlate_proto_from_ascii(*s, *read);
457     }
458     return rv;
459 }
460 #endif
461
462 AP_DECLARE(int) ap_getline(char *s, int n, request_rec *r, int fold)
463 {
464     char *tmp_s = s;
465     apr_status_t rv;
466     apr_size_t len;
467     apr_bucket_brigade *tmp_bb;
468
469     tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
470     rv = ap_rgetline(&tmp_s, n, &len, r, fold, tmp_bb);
471     apr_brigade_destroy(tmp_bb);
472
473     /* Map the out-of-space condition to the old API. */
474     if (rv == APR_ENOSPC) {
475         return n;
476     }
477
478     /* Anything else is just bad. */
479     if (rv != APR_SUCCESS) {
480         return -1;
481     }
482
483     return (int)len;
484 }
485
486 /* parse_uri: break apart the uri
487  * Side Effects:
488  * - sets r->args to rest after '?' (or NULL if no '?')
489  * - sets r->uri to request uri (without r->args part)
490  * - sets r->hostname (if not set already) from request (scheme://host:port)
491  */
492 AP_CORE_DECLARE(void) ap_parse_uri(request_rec *r, const char *uri)
493 {
494     int status = HTTP_OK;
495
496     r->unparsed_uri = apr_pstrdup(r->pool, uri);
497
498     /* http://issues.apache.org/bugzilla/show_bug.cgi?id=31875
499      * http://issues.apache.org/bugzilla/show_bug.cgi?id=28450
500      *
501      * This is not in fact a URI, it's a path.  That matters in the
502      * case of a leading double-slash.  We need to resolve the issue
503      * by normalising that out before treating it as a URI.
504      */
505     while ((uri[0] == '/') && (uri[1] == '/')) {
506         ++uri ;
507     }
508     if (r->method_number == M_CONNECT) {
509         status = apr_uri_parse_hostinfo(r->pool, uri, &r->parsed_uri);
510     }
511     else {
512         /* Simple syntax Errors in URLs are trapped by
513          * parse_uri_components().
514          */
515         status = apr_uri_parse(r->pool, uri, &r->parsed_uri);
516     }
517
518     if (status == APR_SUCCESS) {
519         /* if it has a scheme we may need to do absoluteURI vhost stuff */
520         if (r->parsed_uri.scheme
521             && !strcasecmp(r->parsed_uri.scheme, ap_http_scheme(r))) {
522             r->hostname = r->parsed_uri.hostname;
523         }
524         else if (r->method_number == M_CONNECT) {
525             r->hostname = r->parsed_uri.hostname;
526         }
527
528         r->args = r->parsed_uri.query;
529         r->uri = r->parsed_uri.path ? r->parsed_uri.path
530                  : apr_pstrdup(r->pool, "/");
531
532 #if defined(OS2) || defined(WIN32)
533         /* Handle path translations for OS/2 and plug security hole.
534          * This will prevent "http://www.wherever.com/..\..\/" from
535          * returning a directory for the root drive.
536          */
537         {
538             char *x;
539
540             for (x = r->uri; (x = strchr(x, '\\')) != NULL; )
541                 *x = '/';
542         }
543 #endif /* OS2 || WIN32 */
544     }
545     else {
546         r->args = NULL;
547         r->hostname = NULL;
548         r->status = HTTP_BAD_REQUEST;             /* set error status */
549         r->uri = apr_pstrdup(r->pool, uri);
550     }
551 }
552
553 static int read_request_line(request_rec *r, apr_bucket_brigade *bb)
554 {
555     const char *ll;
556     const char *uri;
557     const char *pro;
558
559 #if 0
560     conn_rec *conn = r->connection;
561 #endif
562     int major = 1, minor = 0;   /* Assume HTTP/1.0 if non-"HTTP" protocol */
563     char http[5];
564     apr_size_t len;
565     int num_blank_lines = 0;
566     int max_blank_lines = r->server->limit_req_fields;
567
568     if (max_blank_lines <= 0) {
569         max_blank_lines = DEFAULT_LIMIT_REQUEST_FIELDS;
570     }
571
572     /* Read past empty lines until we get a real request line,
573      * a read error, the connection closes (EOF), or we timeout.
574      *
575      * We skip empty lines because browsers have to tack a CRLF on to the end
576      * of POSTs to support old CERN webservers.  But note that we may not
577      * have flushed any previous response completely to the client yet.
578      * We delay the flush as long as possible so that we can improve
579      * performance for clients that are pipelining requests.  If a request
580      * is pipelined then we won't block during the (implicit) read() below.
581      * If the requests aren't pipelined, then the client is still waiting
582      * for the final buffer flush from us, and we will block in the implicit
583      * read().  B_SAFEREAD ensures that the BUFF layer flushes if it will
584      * have to block during a read.
585      */
586
587     do {
588         apr_status_t rv;
589
590         /* insure ap_rgetline allocates memory each time thru the loop
591          * if there are empty lines
592          */
593         r->the_request = NULL;
594         rv = ap_rgetline(&(r->the_request), (apr_size_t)(r->server->limit_req_line + 2),
595                          &len, r, 0, bb);
596
597         if (rv != APR_SUCCESS) {
598             r->request_time = apr_time_now();
599
600             /* ap_rgetline returns APR_ENOSPC if it fills up the
601              * buffer before finding the end-of-line.  This is only going to
602              * happen if it exceeds the configured limit for a request-line.
603              */
604             if (rv == APR_ENOSPC) {
605                 r->status    = HTTP_REQUEST_URI_TOO_LARGE;
606                 r->proto_num = HTTP_VERSION(1,0);
607                 r->protocol  = apr_pstrdup(r->pool, "HTTP/1.0");
608             }
609             else if (rv == APR_TIMEUP) {
610                 r->status = HTTP_REQUEST_TIME_OUT;
611             }
612             return 0;
613         }
614     } while ((len <= 0) && (++num_blank_lines < max_blank_lines));
615
616     /* we've probably got something to do, ignore graceful restart requests */
617
618     r->request_time = apr_time_now();
619     ll = r->the_request;
620     r->method = ap_getword_white(r->pool, &ll);
621
622 #if 0
623 /* XXX If we want to keep track of the Method, the protocol module should do
624  * it.  That support isn't in the scoreboard yet.  Hopefully next week
625  * sometime.   rbb */
626     ap_update_connection_status(AP_CHILD_THREAD_FROM_ID(conn->id), "Method",
627                                 r->method);
628 #endif
629
630     uri = ap_getword_white(r->pool, &ll);
631
632     /* Provide quick information about the request method as soon as known */
633
634     r->method_number = ap_method_number_of(r->method);
635     if (r->method_number == M_GET && r->method[0] == 'H') {
636         r->header_only = 1;
637     }
638
639     ap_parse_uri(r, uri);
640
641     if (ll[0]) {
642         r->assbackwards = 0;
643         pro = ll;
644         len = strlen(ll);
645     } else {
646         r->assbackwards = 1;
647         pro = "HTTP/0.9";
648         len = 8;
649     }
650     r->protocol = apr_pstrmemdup(r->pool, pro, len);
651
652     /* XXX ap_update_connection_status(conn->id, "Protocol", r->protocol); */
653
654     /* Avoid sscanf in the common case */
655     if (len == 8
656         && pro[0] == 'H' && pro[1] == 'T' && pro[2] == 'T' && pro[3] == 'P'
657         && pro[4] == '/' && apr_isdigit(pro[5]) && pro[6] == '.'
658         && apr_isdigit(pro[7])) {
659         r->proto_num = HTTP_VERSION(pro[5] - '0', pro[7] - '0');
660     }
661     else if (3 == sscanf(r->protocol, "%4s/%u.%u", http, &major, &minor)
662              && (strcasecmp("http", http) == 0)
663              && (minor < HTTP_VERSION(1, 0)) ) /* don't allow HTTP/0.1000 */
664         r->proto_num = HTTP_VERSION(major, minor);
665     else
666         r->proto_num = HTTP_VERSION(1, 0);
667
668     return 1;
669 }
670
671 AP_DECLARE(void) ap_get_mime_headers_core(request_rec *r, apr_bucket_brigade *bb)
672 {
673     char *last_field = NULL;
674     apr_size_t last_len = 0;
675     apr_size_t alloc_len = 0;
676     char *field;
677     char *value;
678     apr_size_t len;
679     int fields_read = 0;
680     char *tmp_field;
681
682     /*
683      * Read header lines until we get the empty separator line, a read error,
684      * the connection closes (EOF), reach the server limit, or we timeout.
685      */
686     while(1) {
687         apr_status_t rv;
688         int folded = 0;
689
690         field = NULL;
691         rv = ap_rgetline(&field, r->server->limit_req_fieldsize + 2,
692                          &len, r, 0, bb);
693
694         if (rv != APR_SUCCESS) {
695             if (rv == APR_TIMEUP) {
696                 r->status = HTTP_REQUEST_TIME_OUT;
697             }
698             else {
699                 r->status = HTTP_BAD_REQUEST;
700             }
701
702             /* ap_rgetline returns APR_ENOSPC if it fills up the buffer before
703              * finding the end-of-line.  This is only going to happen if it
704              * exceeds the configured limit for a field size.
705              */
706             if (rv == APR_ENOSPC && field) {
707                 /* insure ap_escape_html will terminate correctly */
708                 field[len - 1] = '\0';
709                 apr_table_setn(r->notes, "error-notes",
710                                apr_pstrcat(r->pool,
711                                            "Size of a request header field "
712                                            "exceeds server limit.<br />\n"
713                                            "<pre>\n",
714                                            ap_escape_html(r->pool, field),
715                                            "</pre>\n", NULL));
716             }
717             return;
718         }
719
720         if (last_field != NULL) {
721             if ((len > 0) && ((*field == '\t') || *field == ' ')) {
722                 /* This line is a continuation of the preceding line(s),
723                  * so append it to the line that we've set aside.
724                  * Note: this uses a power-of-two allocator to avoid
725                  * doing O(n) allocs and using O(n^2) space for
726                  * continuations that span many many lines.
727                  */
728                 apr_size_t fold_len = last_len + len + 1; /* trailing null */
729
730                 if (fold_len >= (apr_size_t)(r->server->limit_req_fieldsize)) {
731                     r->status = HTTP_BAD_REQUEST;
732                     /* report what we have accumulated so far before the
733                      * overflow (last_field) as the field with the problem
734                      */
735                     apr_table_setn(r->notes, "error-notes",
736                                    apr_pstrcat(r->pool,
737                                                "Size of a request header field "
738                                                "after folding "
739                                                "exceeds server limit.<br />\n"
740                                                "<pre>\n",
741                                                ap_escape_html(r->pool, last_field),
742                                                "</pre>\n", NULL));
743                     return;
744                 }
745
746                 if (fold_len > alloc_len) {
747                     char *fold_buf;
748                     alloc_len += alloc_len;
749                     if (fold_len > alloc_len) {
750                         alloc_len = fold_len;
751                     }
752                     fold_buf = (char *)apr_palloc(r->pool, alloc_len);
753                     memcpy(fold_buf, last_field, last_len);
754                     last_field = fold_buf;
755                 }
756                 memcpy(last_field + last_len, field, len +1); /* +1 for nul */
757                 last_len += len;
758                 folded = 1;
759             }
760             else /* not a continuation line */ {
761
762                 if (r->server->limit_req_fields
763                     && (++fields_read > r->server->limit_req_fields)) {
764                     r->status = HTTP_BAD_REQUEST;
765                     apr_table_setn(r->notes, "error-notes",
766                                    "The number of request header fields "
767                                    "exceeds this server's limit.");
768                     return;
769                 }
770
771                 if (!(value = strchr(last_field, ':'))) { /* Find ':' or    */
772                     r->status = HTTP_BAD_REQUEST;      /* abort bad request */
773                     apr_table_setn(r->notes, "error-notes",
774                                    apr_pstrcat(r->pool,
775                                                "Request header field is "
776                                                "missing ':' separator.<br />\n"
777                                                "<pre>\n",
778                                                ap_escape_html(r->pool,
779                                                               last_field),
780                                                "</pre>\n", NULL));
781                     return;
782                 }
783
784                 tmp_field = value - 1; /* last character of field-name */
785
786                 *value++ = '\0'; /* NUL-terminate at colon */
787
788                 while (*value == ' ' || *value == '\t') {
789                     ++value;            /* Skip to start of value   */
790                 }
791
792                 /* Strip LWS after field-name: */
793                 while (tmp_field > last_field
794                        && (*tmp_field == ' ' || *tmp_field == '\t')) {
795                     *tmp_field-- = '\0';
796                 }
797
798                 /* Strip LWS after field-value: */
799                 tmp_field = last_field + last_len - 1;
800                 while (tmp_field > value
801                        && (*tmp_field == ' ' || *tmp_field == '\t')) {
802                     *tmp_field-- = '\0';
803                 }
804
805                 apr_table_addn(r->headers_in, last_field, value);
806
807                 /* reset the alloc_len so that we'll allocate a new
808                  * buffer if we have to do any more folding: we can't
809                  * use the previous buffer because its contents are
810                  * now part of r->headers_in
811                  */
812                 alloc_len = 0;
813
814             } /* end if current line is not a continuation starting with tab */
815         }
816
817         /* Found a blank line, stop. */
818         if (len == 0) {
819             break;
820         }
821
822         /* Keep track of this line so that we can parse it on
823          * the next loop iteration.  (In the folded case, last_field
824          * has been updated already.)
825          */
826         if (!folded) {
827             last_field = field;
828             last_len = len;
829         }
830     }
831
832     apr_table_compress(r->headers_in, APR_OVERLAP_TABLES_MERGE);
833 }
834
835 AP_DECLARE(void) ap_get_mime_headers(request_rec *r)
836 {
837     apr_bucket_brigade *tmp_bb;
838     tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
839     ap_get_mime_headers_core(r, tmp_bb);
840     apr_brigade_destroy(tmp_bb);
841 }
842
843 request_rec *ap_read_request(conn_rec *conn)
844 {
845     request_rec *r;
846     apr_pool_t *p;
847     const char *expect;
848     int access_status;
849     apr_bucket_brigade *tmp_bb;
850     apr_socket_t *csd;
851     apr_interval_time_t cur_timeout;
852
853
854     apr_pool_create(&p, conn->pool);
855     apr_pool_tag(p, "request");
856     r = apr_pcalloc(p, sizeof(request_rec));
857     AP_READ_REQUEST_ENTRY((intptr_t)r, (uintptr_t)conn);
858     r->pool            = p;
859     r->connection      = conn;
860     r->server          = conn->base_server;
861
862     r->user            = NULL;
863     r->ap_auth_type    = NULL;
864
865     r->allowed_methods = ap_make_method_list(p, 2);
866
867     r->headers_in      = apr_table_make(r->pool, 25);
868     r->subprocess_env  = apr_table_make(r->pool, 25);
869     r->headers_out     = apr_table_make(r->pool, 12);
870     r->err_headers_out = apr_table_make(r->pool, 5);
871     r->notes           = apr_table_make(r->pool, 5);
872
873     r->request_config  = ap_create_request_config(r->pool);
874     /* Must be set before we run create request hook */
875
876     r->proto_output_filters = conn->output_filters;
877     r->output_filters  = r->proto_output_filters;
878     r->proto_input_filters = conn->input_filters;
879     r->input_filters   = r->proto_input_filters;
880     ap_run_create_request(r);
881     r->per_dir_config  = r->server->lookup_defaults;
882
883     r->sent_bodyct     = 0;                      /* bytect isn't for body */
884
885     r->read_length     = 0;
886     r->read_body       = REQUEST_NO_BODY;
887
888     r->status          = HTTP_OK;  /* Until further notice */
889     r->the_request     = NULL;
890
891     /* Begin by presuming any module can make its own path_info assumptions,
892      * until some module interjects and changes the value.
893      */
894     r->used_path_info = AP_REQ_DEFAULT_PATH_INFO;
895
896     tmp_bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
897
898     /* Get the request... */
899     if (!read_request_line(r, tmp_bb)) {
900         if (r->status == HTTP_REQUEST_URI_TOO_LARGE) {
901             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
902                           "request failed: URI too long (longer than %d)", r->server->limit_req_line);
903             ap_send_error_response(r, 0);
904             ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
905             ap_run_log_transaction(r);
906             apr_brigade_destroy(tmp_bb);
907             goto traceout;
908         }
909         else if (r->status == HTTP_REQUEST_TIME_OUT) {
910             ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
911             ap_run_log_transaction(r);
912             apr_brigade_destroy(tmp_bb);
913             goto traceout;
914         }
915
916         apr_brigade_destroy(tmp_bb);
917         r = NULL;
918         goto traceout;
919     }
920
921     /* We may have been in keep_alive_timeout mode, so toggle back
922      * to the normal timeout mode as we fetch the header lines,
923      * as necessary.
924      */
925     csd = ap_get_module_config(conn->conn_config, &core_module);
926     apr_socket_timeout_get(csd, &cur_timeout);
927     if (cur_timeout != conn->base_server->timeout) {
928         apr_socket_timeout_set(csd, conn->base_server->timeout);
929         cur_timeout = conn->base_server->timeout;
930     }
931
932     if (!r->assbackwards) {
933         ap_get_mime_headers_core(r, tmp_bb);
934         if (r->status != HTTP_OK) {
935             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
936                           "request failed: error reading the headers");
937             ap_send_error_response(r, 0);
938             ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
939             ap_run_log_transaction(r);
940             apr_brigade_destroy(tmp_bb);
941             goto traceout;
942         }
943
944         if (apr_table_get(r->headers_in, "Transfer-Encoding")
945             && apr_table_get(r->headers_in, "Content-Length")) {
946             /* 2616 section 4.4, point 3: "if both Transfer-Encoding
947              * and Content-Length are received, the latter MUST be
948              * ignored"; so unset it here to prevent any confusion
949              * later. */
950             apr_table_unset(r->headers_in, "Content-Length");
951         }
952     }
953     else {
954         if (r->header_only) {
955             /*
956              * Client asked for headers only with HTTP/0.9, which doesn't send
957              * headers! Have to dink things just to make sure the error message
958              * comes through...
959              */
960             ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
961                           "client sent invalid HTTP/0.9 request: HEAD %s",
962                           r->uri);
963             r->header_only = 0;
964             r->status = HTTP_BAD_REQUEST;
965             ap_send_error_response(r, 0);
966             ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
967             ap_run_log_transaction(r);
968             apr_brigade_destroy(tmp_bb);
969             goto traceout;
970         }
971     }
972
973     apr_brigade_destroy(tmp_bb);
974
975     /* update what we think the virtual host is based on the headers we've
976      * now read. may update status.
977      */
978     ap_update_vhost_from_headers(r);
979
980     /* Toggle to the Host:-based vhost's timeout mode to fetch the
981      * request body and send the response body, if needed.
982      */
983     if (cur_timeout != r->server->timeout) {
984         apr_socket_timeout_set(csd, r->server->timeout);
985         cur_timeout = r->server->timeout;
986     }
987
988     /* we may have switched to another server */
989     r->per_dir_config = r->server->lookup_defaults;
990
991     if ((!r->hostname && (r->proto_num >= HTTP_VERSION(1, 1)))
992         || ((r->proto_num == HTTP_VERSION(1, 1))
993             && !apr_table_get(r->headers_in, "Host"))) {
994         /*
995          * Client sent us an HTTP/1.1 or later request without telling us the
996          * hostname, either with a full URL or a Host: header. We therefore
997          * need to (as per the 1.1 spec) send an error.  As a special case,
998          * HTTP/1.1 mentions twice (S9, S14.23) that a request MUST contain
999          * a Host: header, and the server MUST respond with 400 if it doesn't.
1000          */
1001         r->status = HTTP_BAD_REQUEST;
1002         ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1003                       "client sent HTTP/1.1 request without hostname "
1004                       "(see RFC2616 section 14.23): %s", r->uri);
1005     }
1006
1007     /*
1008      * Add the HTTP_IN filter here to ensure that ap_discard_request_body
1009      * called by ap_die and by ap_send_error_response works correctly on
1010      * status codes that do not cause the connection to be dropped and
1011      * in situations where the connection should be kept alive.
1012      */
1013
1014     ap_add_input_filter_handle(ap_http_input_filter_handle,
1015                                NULL, r, r->connection);
1016
1017     if (r->status != HTTP_OK) {
1018         ap_send_error_response(r, 0);
1019         ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
1020         ap_run_log_transaction(r);
1021         goto traceout;
1022     }
1023
1024     if ((access_status = ap_run_post_read_request(r))) {
1025         ap_die(access_status, r);
1026         ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
1027         ap_run_log_transaction(r);
1028         r = NULL;
1029         goto traceout;
1030     }
1031
1032     if (((expect = apr_table_get(r->headers_in, "Expect")) != NULL)
1033         && (expect[0] != '\0')) {
1034         /*
1035          * The Expect header field was added to HTTP/1.1 after RFC 2068
1036          * as a means to signal when a 100 response is desired and,
1037          * unfortunately, to signal a poor man's mandatory extension that
1038          * the server must understand or return 417 Expectation Failed.
1039          */
1040         if (strcasecmp(expect, "100-continue") == 0) {
1041             r->expecting_100 = 1;
1042         }
1043         else {
1044             r->status = HTTP_EXPECTATION_FAILED;
1045             ap_log_rerror(APLOG_MARK, APLOG_INFO, 0, r,
1046                           "client sent an unrecognized expectation value of "
1047                           "Expect: %s", expect);
1048             ap_send_error_response(r, 0);
1049             ap_update_child_status(conn->sbh, SERVER_BUSY_LOG, r);
1050             ap_run_log_transaction(r);
1051             goto traceout;
1052         }
1053     }
1054
1055     AP_READ_REQUEST_SUCCESS((uintptr_t)r, (char *)r->method, (char *)r->uri, (char *)r->server->defn_name, r->status);
1056     return r;
1057     traceout:
1058     AP_READ_REQUEST_FAILURE((uintptr_t)r);
1059     return r;
1060 }
1061
1062 /* if a request with a body creates a subrequest, clone the original request's
1063  * input headers minus any headers pertaining to the body which has already
1064  * been read.  out-of-line helper function for ap_set_sub_req_protocol.
1065  */
1066
1067 static void clone_headers_no_body(request_rec *rnew,
1068                                   const request_rec *r)
1069 {
1070     rnew->headers_in = apr_table_copy(rnew->pool, r->headers_in);
1071     apr_table_unset(rnew->headers_in, "Content-Encoding");
1072     apr_table_unset(rnew->headers_in, "Content-Language");
1073     apr_table_unset(rnew->headers_in, "Content-Length");
1074     apr_table_unset(rnew->headers_in, "Content-Location");
1075     apr_table_unset(rnew->headers_in, "Content-MD5");
1076     apr_table_unset(rnew->headers_in, "Content-Range");
1077     apr_table_unset(rnew->headers_in, "Content-Type");
1078     apr_table_unset(rnew->headers_in, "Expires");
1079     apr_table_unset(rnew->headers_in, "Last-Modified");
1080     apr_table_unset(rnew->headers_in, "Transfer-Encoding");
1081 }
1082
1083 /*
1084  * A couple of other functions which initialize some of the fields of
1085  * a request structure, as appropriate for adjuncts of one kind or another
1086  * to a request in progress.  Best here, rather than elsewhere, since
1087  * *someone* has to set the protocol-specific fields...
1088  */
1089
1090 AP_DECLARE(void) ap_set_sub_req_protocol(request_rec *rnew,
1091                                          const request_rec *r)
1092 {
1093     rnew->the_request     = r->the_request;  /* Keep original request-line */
1094
1095     rnew->assbackwards    = 1;   /* Don't send headers from this. */
1096     rnew->no_local_copy   = 1;   /* Don't try to send HTTP_NOT_MODIFIED for a
1097                                   * fragment. */
1098     rnew->method          = "GET";
1099     rnew->method_number   = M_GET;
1100     rnew->protocol        = "INCLUDED";
1101
1102     rnew->status          = HTTP_OK;
1103
1104     /* did the original request have a body?  (e.g. POST w/SSI tags)
1105      * if so, make sure the subrequest doesn't inherit body headers
1106      */
1107     if (!r->kept_body && (apr_table_get(r->headers_in, "Content-Length")
1108         || apr_table_get(r->headers_in, "Transfer-Encoding"))) {
1109         clone_headers_no_body(rnew, r);
1110     } else {
1111         /* no body (common case).  clone headers the cheap way */
1112         rnew->headers_in      = r->headers_in;
1113     }
1114     rnew->subprocess_env  = apr_table_copy(rnew->pool, r->subprocess_env);
1115     rnew->headers_out     = apr_table_make(rnew->pool, 5);
1116     rnew->err_headers_out = apr_table_make(rnew->pool, 5);
1117     rnew->notes           = apr_table_make(rnew->pool, 5);
1118
1119     rnew->expecting_100   = r->expecting_100;
1120     rnew->read_length     = r->read_length;
1121     rnew->read_body       = REQUEST_NO_BODY;
1122
1123     rnew->main = (request_rec *) r;
1124 }
1125
1126 static void end_output_stream(request_rec *r)
1127 {
1128     conn_rec *c = r->connection;
1129     apr_bucket_brigade *bb;
1130     apr_bucket *b;
1131
1132     bb = apr_brigade_create(r->pool, c->bucket_alloc);
1133     b = apr_bucket_eos_create(c->bucket_alloc);
1134     APR_BRIGADE_INSERT_TAIL(bb, b);
1135     ap_pass_brigade(r->output_filters, bb);
1136 }
1137
1138 AP_DECLARE(void) ap_finalize_sub_req_protocol(request_rec *sub)
1139 {
1140     /* tell the filter chain there is no more content coming */
1141     if (!sub->eos_sent) {
1142         end_output_stream(sub);
1143     }
1144 }
1145
1146 /* finalize_request_protocol is called at completion of sending the
1147  * response.  Its sole purpose is to send the terminating protocol
1148  * information for any wrappers around the response message body
1149  * (i.e., transfer encodings).  It should have been named finalize_response.
1150  */
1151 AP_DECLARE(void) ap_finalize_request_protocol(request_rec *r)
1152 {
1153     (void) ap_discard_request_body(r);
1154
1155     /* tell the filter chain there is no more content coming */
1156     if (!r->eos_sent) {
1157         end_output_stream(r);
1158     }
1159 }
1160
1161 /*
1162  * Support for the Basic authentication protocol, and a bit for Digest.
1163  */
1164 AP_DECLARE(void) ap_note_auth_failure(request_rec *r)
1165 {
1166     const char *type = ap_auth_type(r);
1167     if (type) {
1168         if (!strcasecmp(type, "Basic"))
1169             ap_note_basic_auth_failure(r);
1170         else if (!strcasecmp(type, "Digest"))
1171             ap_note_digest_auth_failure(r);
1172     }
1173     else {
1174         ap_log_rerror(APLOG_MARK, APLOG_ERR,
1175                       0, r, "need AuthType to note auth failure: %s", r->uri);
1176     }
1177 }
1178
1179 AP_DECLARE(void) ap_note_basic_auth_failure(request_rec *r)
1180 {
1181     const char *type = ap_auth_type(r);
1182
1183     /* if there is no AuthType configure or it is something other than
1184      * Basic, let ap_note_auth_failure() deal with it
1185      */
1186     if (!type || strcasecmp(type, "Basic"))
1187         ap_note_auth_failure(r);
1188     else
1189         apr_table_setn(r->err_headers_out,
1190                        (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate"
1191                                                        : "WWW-Authenticate",
1192                        apr_pstrcat(r->pool, "Basic realm=\"", ap_auth_name(r),
1193                                    "\"", NULL));
1194 }
1195
1196 AP_DECLARE(void) ap_note_digest_auth_failure(request_rec *r)
1197 {
1198     apr_table_setn(r->err_headers_out,
1199                    (PROXYREQ_PROXY == r->proxyreq) ? "Proxy-Authenticate"
1200                                                    : "WWW-Authenticate",
1201                    apr_psprintf(r->pool, "Digest realm=\"%s\", nonce=\""
1202                                 "%" APR_UINT64_T_HEX_FMT "\"",
1203                                 ap_auth_name(r), (apr_uint64_t)r->request_time));
1204 }
1205
1206 AP_DECLARE(int) ap_get_basic_auth_pw(request_rec *r, const char **pw)
1207 {
1208     const char *auth_line = apr_table_get(r->headers_in,
1209                                           (PROXYREQ_PROXY == r->proxyreq)
1210                                               ? "Proxy-Authorization"
1211                                               : "Authorization");
1212     const char *t;
1213
1214     if (!(t = ap_auth_type(r)) || strcasecmp(t, "Basic"))
1215         return DECLINED;
1216
1217     if (!ap_auth_name(r)) {
1218         ap_log_rerror(APLOG_MARK, APLOG_ERR,
1219                       0, r, "need AuthName: %s", r->uri);
1220         return HTTP_INTERNAL_SERVER_ERROR;
1221     }
1222
1223     if (!auth_line) {
1224         ap_note_basic_auth_failure(r);
1225         return HTTP_UNAUTHORIZED;
1226     }
1227
1228     if (strcasecmp(ap_getword(r->pool, &auth_line, ' '), "Basic")) {
1229         /* Client tried to authenticate using wrong auth scheme */
1230         ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r,
1231                       "client used wrong authentication scheme: %s", r->uri);
1232         ap_note_basic_auth_failure(r);
1233         return HTTP_UNAUTHORIZED;
1234     }
1235
1236     while (*auth_line == ' ' || *auth_line == '\t') {
1237         auth_line++;
1238     }
1239
1240     t = ap_pbase64decode(r->pool, auth_line);
1241     r->user = ap_getword_nulls (r->pool, &t, ':');
1242     r->ap_auth_type = "Basic";
1243
1244     *pw = t;
1245
1246     return OK;
1247 }
1248
1249 struct content_length_ctx {
1250     int data_sent;  /* true if the C-L filter has already sent at
1251                      * least one bucket on to the next output filter
1252                      * for this request
1253                      */
1254     apr_bucket_brigade *tmpbb;
1255 };
1256
1257 /* This filter computes the content length, but it also computes the number
1258  * of bytes sent to the client.  This means that this filter will always run
1259  * through all of the buckets in all brigades
1260  */
1261 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_content_length_filter(
1262     ap_filter_t *f,
1263     apr_bucket_brigade *b)
1264 {
1265     request_rec *r = f->r;
1266     struct content_length_ctx *ctx;
1267     apr_bucket *e;
1268     int eos = 0;
1269     apr_read_type_e eblock = APR_NONBLOCK_READ;
1270
1271     ctx = f->ctx;
1272     if (!ctx) {
1273         f->ctx = ctx = apr_palloc(r->pool, sizeof(*ctx));
1274         ctx->data_sent = 0;
1275         ctx->tmpbb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
1276     }
1277
1278     /* Loop through this set of buckets to compute their length
1279      */
1280     e = APR_BRIGADE_FIRST(b);
1281     while (e != APR_BRIGADE_SENTINEL(b)) {
1282         if (APR_BUCKET_IS_EOS(e)) {
1283             eos = 1;
1284             break;
1285         }
1286         if (e->length == (apr_size_t)-1) {
1287             apr_size_t len;
1288             const char *ignored;
1289             apr_status_t rv;
1290
1291             /* This is probably a pipe bucket.  Send everything
1292              * prior to this, and then read the data for this bucket.
1293              */
1294             rv = apr_bucket_read(e, &ignored, &len, eblock);
1295             if (rv == APR_SUCCESS) {
1296                 /* Attempt a nonblocking read next time through */
1297                 eblock = APR_NONBLOCK_READ;
1298                 r->bytes_sent += len;
1299             }
1300             else if (APR_STATUS_IS_EAGAIN(rv)) {
1301                 /* Output everything prior to this bucket, and then
1302                  * do a blocking read on the next batch.
1303                  */
1304                 if (e != APR_BRIGADE_FIRST(b)) {
1305                     apr_brigade_split_ex(b, e, ctx->tmpbb);
1306                     apr_bucket *flush = apr_bucket_flush_create(r->connection->bucket_alloc);
1307
1308                     APR_BRIGADE_INSERT_TAIL(b, flush);
1309                     rv = ap_pass_brigade(f->next, b);
1310                     if (rv != APR_SUCCESS || f->c->aborted) {
1311                         return rv;
1312                     }
1313                     APR_BRIGADE_CONCAT(b, ctx->tmpbb);
1314                     e = APR_BRIGADE_FIRST(b);
1315
1316                     ctx->data_sent = 1;
1317                 }
1318                 eblock = APR_BLOCK_READ;
1319                 continue;
1320             }
1321             else {
1322                 ap_log_rerror(APLOG_MARK, APLOG_ERR, rv, r,
1323                               "ap_content_length_filter: "
1324                               "apr_bucket_read() failed");
1325                 return rv;
1326             }
1327         }
1328         else {
1329             r->bytes_sent += e->length;
1330         }
1331         e = APR_BUCKET_NEXT(e);
1332     }
1333
1334     /* If we've now seen the entire response and it's otherwise
1335      * okay to set the C-L in the response header, then do so now.
1336      *
1337      * We can only set a C-L in the response header if we haven't already
1338      * sent any buckets on to the next output filter for this request.
1339      */
1340     if (ctx->data_sent == 0 && eos &&
1341         /* don't whack the C-L if it has already been set for a HEAD
1342          * by something like proxy.  the brigade only has an EOS bucket
1343          * in this case, making r->bytes_sent zero.
1344          *
1345          * if r->bytes_sent > 0 we have a (temporary) body whose length may
1346          * have been changed by a filter.  the C-L header might not have been
1347          * updated so we do it here.  long term it would be cleaner to have
1348          * such filters update or remove the C-L header, and just use it
1349          * if present.
1350          */
1351         !(r->header_only && r->bytes_sent == 0 &&
1352             apr_table_get(r->headers_out, "Content-Length"))) {
1353         ap_set_content_length(r, r->bytes_sent);
1354     }
1355
1356     ctx->data_sent = 1;
1357     return ap_pass_brigade(f->next, b);
1358 }
1359
1360 /*
1361  * Send the body of a response to the client.
1362  */
1363 AP_DECLARE(apr_status_t) ap_send_fd(apr_file_t *fd, request_rec *r,
1364                                     apr_off_t offset, apr_size_t len,
1365                                     apr_size_t *nbytes)
1366 {
1367     conn_rec *c = r->connection;
1368     apr_bucket_brigade *bb = NULL;
1369     apr_status_t rv;
1370
1371     bb = apr_brigade_create(r->pool, c->bucket_alloc);
1372     
1373     apr_brigade_insert_file(bb, fd, 0, len, r->pool);
1374
1375     rv = ap_pass_brigade(r->output_filters, bb);
1376     if (rv != APR_SUCCESS) {
1377         *nbytes = 0; /* no way to tell how many were actually sent */
1378     }
1379     else {
1380         *nbytes = len;
1381     }
1382
1383     return rv;
1384 }
1385
1386 #if APR_HAS_MMAP
1387 /* send data from an in-memory buffer */
1388 AP_DECLARE(size_t) ap_send_mmap(apr_mmap_t *mm, request_rec *r, size_t offset,
1389                                 size_t length)
1390 {
1391     conn_rec *c = r->connection;
1392     apr_bucket_brigade *bb = NULL;
1393     apr_bucket *b;
1394
1395     bb = apr_brigade_create(r->pool, c->bucket_alloc);
1396     b = apr_bucket_mmap_create(mm, offset, length, c->bucket_alloc);
1397     APR_BRIGADE_INSERT_TAIL(bb, b);
1398     ap_pass_brigade(r->output_filters, bb);
1399
1400     return mm->size; /* XXX - change API to report apr_status_t? */
1401 }
1402 #endif /* APR_HAS_MMAP */
1403
1404 typedef struct {
1405     apr_bucket_brigade *bb;
1406     apr_bucket_brigade *tmpbb;
1407 } old_write_filter_ctx;
1408
1409 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_old_write_filter(
1410     ap_filter_t *f, apr_bucket_brigade *bb)
1411 {
1412     old_write_filter_ctx *ctx = f->ctx;
1413
1414     AP_DEBUG_ASSERT(ctx);
1415
1416     if (ctx->bb != NULL) {
1417         /* whatever is coming down the pipe (we don't care), we
1418          * can simply insert our buffered data at the front and
1419          * pass the whole bundle down the chain.
1420          */
1421         APR_BRIGADE_PREPEND(bb, ctx->bb);
1422     }
1423
1424     return ap_pass_brigade(f->next, bb);
1425 }
1426
1427 static ap_filter_t *insert_old_write_filter(request_rec *r)
1428 {
1429     ap_filter_t *f;
1430     old_write_filter_ctx *ctx;
1431
1432     /* future optimization: record some flags in the request_rec to
1433      * say whether we've added our filter, and whether it is first.
1434      */
1435
1436     /* this will typically exit on the first test */
1437     for (f = r->output_filters; f != NULL; f = f->next) {
1438         if (ap_old_write_func == f->frec)
1439             break;
1440     }
1441
1442     if (f == NULL) {
1443         /* our filter hasn't been added yet */
1444         ctx = apr_pcalloc(r->pool, sizeof(*ctx));
1445         ctx->tmpbb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
1446
1447         ap_add_output_filter("OLD_WRITE", ctx, r, r->connection);
1448         f = r->output_filters;
1449     }
1450
1451     return f;
1452 }
1453
1454 static apr_status_t buffer_output(request_rec *r,
1455                                   const char *str, apr_size_t len)
1456 {
1457     conn_rec *c = r->connection;
1458     ap_filter_t *f;
1459     old_write_filter_ctx *ctx;
1460
1461     if (len == 0)
1462         return APR_SUCCESS;
1463
1464     f = insert_old_write_filter(r);
1465     ctx = f->ctx;
1466
1467     /* if the first filter is not our buffering filter, then we have to
1468      * deliver the content through the normal filter chain
1469      */
1470     if (f != r->output_filters) {
1471         apr_status_t rv;
1472         apr_bucket *b = apr_bucket_transient_create(str, len, c->bucket_alloc);
1473         APR_BRIGADE_INSERT_TAIL(ctx->tmpbb, b);
1474
1475         rv = ap_pass_brigade(r->output_filters, ctx->tmpbb);
1476         apr_brigade_cleanup(ctx->tmpbb);
1477         return rv;
1478     }
1479
1480     if (ctx->bb == NULL) {
1481         ctx->bb = apr_brigade_create(r->pool, c->bucket_alloc);
1482     }
1483
1484     return ap_fwrite(f->next, ctx->bb, str, len);
1485 }
1486
1487 AP_DECLARE(int) ap_rputc(int c, request_rec *r)
1488 {
1489     char c2 = (char)c;
1490
1491     if (r->connection->aborted) {
1492         return -1;
1493     }
1494
1495     if (buffer_output(r, &c2, 1) != APR_SUCCESS)
1496         return -1;
1497
1498     return c;
1499 }
1500
1501 AP_DECLARE(int) ap_rputs(const char *str, request_rec *r)
1502 {
1503     apr_size_t len;
1504
1505     if (r->connection->aborted)
1506         return -1;
1507
1508     if (buffer_output(r, str, len = strlen(str)) != APR_SUCCESS)
1509         return -1;
1510
1511     return len;
1512 }
1513
1514 AP_DECLARE(int) ap_rwrite(const void *buf, int nbyte, request_rec *r)
1515 {
1516     if (r->connection->aborted)
1517         return -1;
1518
1519     if (buffer_output(r, buf, nbyte) != APR_SUCCESS)
1520         return -1;
1521
1522     return nbyte;
1523 }
1524
1525 struct ap_vrprintf_data {
1526     apr_vformatter_buff_t vbuff;
1527     request_rec *r;
1528     char *buff;
1529 };
1530
1531 static apr_status_t r_flush(apr_vformatter_buff_t *buff)
1532 {
1533     /* callback function passed to ap_vformatter to be called when
1534      * vformatter needs to write into buff and buff.curpos > buff.endpos */
1535
1536     /* ap_vrprintf_data passed as a apr_vformatter_buff_t, which is then
1537      * "downcast" to an ap_vrprintf_data */
1538     struct ap_vrprintf_data *vd = (struct ap_vrprintf_data*)buff;
1539
1540     if (vd->r->connection->aborted)
1541         return -1;
1542
1543     /* r_flush is called when vbuff is completely full */
1544     if (buffer_output(vd->r, vd->buff, AP_IOBUFSIZE)) {
1545         return -1;
1546     }
1547
1548     /* reset the buffer position */
1549     vd->vbuff.curpos = vd->buff;
1550     vd->vbuff.endpos = vd->buff + AP_IOBUFSIZE;
1551
1552     return APR_SUCCESS;
1553 }
1554
1555 AP_DECLARE(int) ap_vrprintf(request_rec *r, const char *fmt, va_list va)
1556 {
1557     apr_size_t written;
1558     struct ap_vrprintf_data vd;
1559     char vrprintf_buf[AP_IOBUFSIZE];
1560
1561     vd.vbuff.curpos = vrprintf_buf;
1562     vd.vbuff.endpos = vrprintf_buf + AP_IOBUFSIZE;
1563     vd.r = r;
1564     vd.buff = vrprintf_buf;
1565
1566     if (r->connection->aborted)
1567         return -1;
1568
1569     written = apr_vformatter(r_flush, &vd.vbuff, fmt, va);
1570
1571     if (written != -1) {
1572         int n = vd.vbuff.curpos - vrprintf_buf;
1573
1574         /* last call to buffer_output, to finish clearing the buffer */
1575         if (buffer_output(r, vrprintf_buf,n) != APR_SUCCESS)
1576             return -1;
1577
1578         written += n;
1579     }
1580
1581     return written;
1582 }
1583
1584 AP_DECLARE_NONSTD(int) ap_rprintf(request_rec *r, const char *fmt, ...)
1585 {
1586     va_list va;
1587     int n;
1588
1589     if (r->connection->aborted)
1590         return -1;
1591
1592     va_start(va, fmt);
1593     n = ap_vrprintf(r, fmt, va);
1594     va_end(va);
1595
1596     return n;
1597 }
1598
1599 AP_DECLARE_NONSTD(int) ap_rvputs(request_rec *r, ...)
1600 {
1601     va_list va;
1602     const char *s;
1603     apr_size_t len;
1604     apr_size_t written = 0;
1605
1606     if (r->connection->aborted)
1607         return -1;
1608
1609     /* ### TODO: if the total output is large, put all the strings
1610      * ### into a single brigade, rather than flushing each time we
1611      * ### fill the buffer
1612      */
1613     va_start(va, r);
1614     while (1) {
1615         s = va_arg(va, const char *);
1616         if (s == NULL)
1617             break;
1618
1619         len = strlen(s);
1620         if (buffer_output(r, s, len) != APR_SUCCESS) {
1621             return -1;
1622         }
1623
1624         written += len;
1625     }
1626     va_end(va);
1627
1628     return written;
1629 }
1630
1631 AP_DECLARE(int) ap_rflush(request_rec *r)
1632 {
1633     conn_rec *c = r->connection;
1634     apr_bucket *b;
1635     ap_filter_t *f;
1636     old_write_filter_ctx *ctx;
1637     apr_status_t rv;
1638
1639     f = insert_old_write_filter(r);
1640     ctx = f->ctx;
1641
1642     b = apr_bucket_flush_create(c->bucket_alloc);
1643     APR_BRIGADE_INSERT_TAIL(ctx->tmpbb, b);
1644
1645     rv = ap_pass_brigade(r->output_filters, ctx->tmpbb);
1646     apr_brigade_cleanup(ctx->tmpbb);
1647     if (rv != APR_SUCCESS)
1648         return -1;
1649
1650     return 0;
1651 }
1652
1653 /*
1654  * This function sets the Last-Modified output header field to the value
1655  * of the mtime field in the request structure - rationalized to keep it from
1656  * being in the future.
1657  */
1658 AP_DECLARE(void) ap_set_last_modified(request_rec *r)
1659 {
1660     if (!r->assbackwards) {
1661         apr_time_t mod_time = ap_rationalize_mtime(r, r->mtime);
1662         char *datestr = apr_palloc(r->pool, APR_RFC822_DATE_LEN);
1663
1664         apr_rfc822_date(datestr, mod_time);
1665         apr_table_setn(r->headers_out, "Last-Modified", datestr);
1666     }
1667 }
1668
1669 typedef struct hdr_ptr {
1670     ap_filter_t *f;
1671     apr_bucket_brigade *bb;
1672 } hdr_ptr;
1673 static int send_header(void *data, const char *key, const char *val)
1674 {
1675     ap_fputstrs(((hdr_ptr*)data)->f, ((hdr_ptr*)data)->bb,
1676                 key, ": ", val, CRLF, NULL);
1677     return 1;
1678 }
1679 AP_DECLARE(void) ap_send_interim_response(request_rec *r, int send_headers)
1680 {
1681     hdr_ptr x;
1682     char *status_line = NULL;
1683
1684     if (r->proto_num < 1001) {
1685         /* don't send interim response to HTTP/1.0 Client */
1686         return;
1687     }
1688     if (!ap_is_HTTP_INFO(r->status)) {
1689         ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, NULL,
1690                       "Status is %d - not sending interim response", r->status);
1691         return;
1692     }
1693     if ((r->status == HTTP_CONTINUE) && !r->expecting_100) {
1694         /*
1695          * Don't send 100-Continue when there was no Expect: 100-continue
1696          * in the request headers. For origin servers this is a SHOULD NOT
1697          * for proxies it is a MUST NOT according to RFC 2616 8.2.3
1698          */
1699         return;
1700     }
1701
1702     status_line = apr_pstrcat(r->pool, AP_SERVER_PROTOCOL, " ", r->status_line, CRLF, NULL);
1703     ap_xlate_proto_to_ascii(status_line, strlen(status_line));
1704
1705     x.f = r->connection->output_filters;
1706     x.bb = apr_brigade_create(r->pool, r->connection->bucket_alloc);
1707
1708     ap_fputs(x.f, x.bb, status_line);
1709     if (send_headers) {
1710         apr_table_do(send_header, &x, r->headers_out, NULL);
1711         apr_table_clear(r->headers_out);
1712     }
1713     ap_fputs(x.f, x.bb, CRLF_ASCII);
1714     ap_fflush(x.f, x.bb);
1715     apr_brigade_destroy(x.bb);
1716 }
1717
1718
1719 AP_IMPLEMENT_HOOK_RUN_ALL(int,post_read_request,
1720                           (request_rec *r), (r), OK, DECLINED)
1721 AP_IMPLEMENT_HOOK_RUN_ALL(int,log_transaction,
1722                           (request_rec *r), (r), OK, DECLINED)
1723 AP_IMPLEMENT_HOOK_RUN_FIRST(const char *,http_scheme,
1724                             (const request_rec *r), (r), NULL)
1725 AP_IMPLEMENT_HOOK_RUN_FIRST(unsigned short,default_port,
1726                             (const request_rec *r), (r), 0)