1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
60 #include "ap_config.h"
61 #include "apr_strings.h"
64 #include "http_config.h"
65 #include "http_core.h"
66 #include "http_protocol.h" /* For index_of_response(). Grump. */
67 #include "http_request.h"
68 #include "http_vhost.h"
69 #include "http_main.h" /* For the default_handler below... */
73 #include "apr_fnmatch.h"
74 #include "http_connection.h"
75 #include "ap_buckets.h"
76 #include "util_filter.h"
77 #include "util_ebcdic.h"
82 #ifdef HAVE_SYS_SOCKET_H
83 #include <sys/socket.h>
85 #ifdef HAVE_ARPA_INET_H
86 #include <arpa/inet.h>
92 /* Make sure we don't write less than 4096 bytes at any one time.
94 #define MIN_SIZE_TO_WRITE 9000
96 /* Allow Apache to use ap_mmap */
100 /* mmap support for static files based on ideas from John Heidemann's
101 * patch against 1.0.5. See
102 * <http://www.isi.edu/~johnh/SOFTWARE/APACHE/index.html>.
105 /* Files have to be at least this big before they're mmap()d. This is to deal
106 * with systems where the expense of doing an mmap() and an munmap() outweighs
107 * the benefit for small files. It shouldn't be set lower than 1.
109 #ifndef MMAP_THRESHOLD
111 #define MMAP_THRESHOLD (8*1024)
113 #define MMAP_THRESHOLD 1
115 #endif /* MMAP_THRESHOLD */
117 #define MMAP_LIMIT (4*1024*1024)
119 #endif /* USE_MMAP_FILES */
121 /* LimitXMLRequestBody handling */
122 #define AP_LIMIT_UNSET ((long) -1)
123 #define AP_DEFAULT_LIMIT_XML_BODY ((size_t)1000000)
125 /* Server core module... This module provides support for really basic
126 * server operations, including options and commands which control the
127 * operation of other modules. Consider this the bureaucracy module.
129 * The core module also defines handlers, etc., do handle just enough
130 * to allow a server with the core module ONLY to actually serve documents
131 * (though it slaps DefaultType on all of 'em); this was useful in testing,
132 * but may not be worth preserving.
134 * This file could almost be mod_core.c, except for the stuff which affects
135 * the http_conf_globals.
138 static void *create_core_dir_config(apr_pool_t *a, char *dir)
140 core_dir_config *conf;
142 conf = (core_dir_config *)apr_pcalloc(a, sizeof(core_dir_config));
143 if (!dir || dir[strlen(dir) - 1] == '/') {
146 else if (strncmp(dir, "proxy:", 6) == 0) {
147 conf->d = apr_pstrdup(a, dir);
150 conf->d = apr_pstrcat(a, dir, "/", NULL);
152 conf->d_is_fnmatch = conf->d ? (apr_is_fnmatch(conf->d) != 0) : 0;
153 conf->d_components = conf->d ? ap_count_dirs(conf->d) : 0;
155 conf->opts = dir ? OPT_UNSET : OPT_UNSET|OPT_ALL;
156 conf->opts_add = conf->opts_remove = OPT_NONE;
157 conf->override = dir ? OR_UNSET : OR_UNSET|OR_ALL;
159 conf->content_md5 = 2;
161 conf->use_canonical_name = USE_CANONICAL_NAME_UNSET;
163 conf->hostname_lookups = HOSTNAME_LOOKUP_UNSET;
164 conf->do_rfc1413 = DEFAULT_RFC1413 | 2; /* set bit 1 to indicate default */
165 conf->satisfy = SATISFY_NOSPEC;
168 conf->limit_cpu = NULL;
170 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
171 conf->limit_mem = NULL;
174 conf->limit_nproc = NULL;
177 conf->limit_req_body = 0;
178 conf->limit_xml_body = AP_LIMIT_UNSET;
179 conf->sec = apr_make_array(a, 2, sizeof(void *));
181 conf->script_interpreter_source = INTERPRETER_SOURCE_UNSET;
184 conf->server_signature = srv_sig_unset;
186 conf->add_default_charset = ADD_DEFAULT_CHARSET_UNSET;
187 conf->add_default_charset_name = DEFAULT_ADD_DEFAULT_CHARSET_NAME;
189 conf->filters = apr_make_array(a, 2, sizeof(void *));
190 conf->input_filters = apr_make_array(a, 2, sizeof(void *));
194 static void *merge_core_dir_configs(apr_pool_t *a, void *basev, void *newv)
196 core_dir_config *base = (core_dir_config *)basev;
197 core_dir_config *new = (core_dir_config *)newv;
198 core_dir_config *conf;
201 conf = (core_dir_config *)apr_palloc(a, sizeof(core_dir_config));
202 memcpy((char *)conf, (const char *)base, sizeof(core_dir_config));
203 if (base->response_code_strings) {
204 conf->response_code_strings =
205 apr_palloc(a, sizeof(*conf->response_code_strings)
207 memcpy(conf->response_code_strings, base->response_code_strings,
208 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
212 conf->d_is_fnmatch = new->d_is_fnmatch;
213 conf->d_components = new->d_components;
216 if (new->opts & OPT_UNSET) {
217 /* there was no explicit setting of new->opts, so we merge
218 * preserve the invariant (opts_add & opts_remove) == 0
220 conf->opts_add = (conf->opts_add & ~new->opts_remove) | new->opts_add;
221 conf->opts_remove = (conf->opts_remove & ~new->opts_add)
223 conf->opts = (conf->opts & ~conf->opts_remove) | conf->opts_add;
224 if ((base->opts & OPT_INCNOEXEC) && (new->opts & OPT_INCLUDES)) {
225 conf->opts = (conf->opts & ~OPT_INCNOEXEC) | OPT_INCLUDES;
229 /* otherwise we just copy, because an explicit opts setting
230 * overrides all earlier +/- modifiers
232 conf->opts = new->opts;
233 conf->opts_add = new->opts_add;
234 conf->opts_remove = new->opts_remove;
237 if (!(new->override & OR_UNSET)) {
238 conf->override = new->override;
240 if (new->ap_default_type) {
241 conf->ap_default_type = new->ap_default_type;
244 if (new->ap_auth_type) {
245 conf->ap_auth_type = new->ap_auth_type;
247 if (new->ap_auth_name) {
248 conf->ap_auth_name = new->ap_auth_name;
250 if (new->ap_requires) {
251 conf->ap_requires = new->ap_requires;
254 if (new->response_code_strings) {
255 if (conf->response_code_strings == NULL) {
256 conf->response_code_strings = apr_palloc(a,
257 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
258 memcpy(conf->response_code_strings, new->response_code_strings,
259 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
262 for (i = 0; i < RESPONSE_CODES; ++i) {
263 if (new->response_code_strings[i] != NULL) {
264 conf->response_code_strings[i]
265 = new->response_code_strings[i];
270 if (new->hostname_lookups != HOSTNAME_LOOKUP_UNSET) {
271 conf->hostname_lookups = new->hostname_lookups;
273 if ((new->do_rfc1413 & 2) == 0) {
274 conf->do_rfc1413 = new->do_rfc1413;
276 if ((new->content_md5 & 2) == 0) {
277 conf->content_md5 = new->content_md5;
279 if (new->use_canonical_name != USE_CANONICAL_NAME_UNSET) {
280 conf->use_canonical_name = new->use_canonical_name;
284 if (new->limit_cpu) {
285 conf->limit_cpu = new->limit_cpu;
288 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
289 if (new->limit_mem) {
290 conf->limit_mem = new->limit_mem;
294 if (new->limit_nproc) {
295 conf->limit_nproc = new->limit_nproc;
299 if (new->limit_req_body) {
300 conf->limit_req_body = new->limit_req_body;
303 if (new->limit_xml_body != AP_LIMIT_UNSET)
304 conf->limit_xml_body = new->limit_xml_body;
306 conf->limit_xml_body = base->limit_xml_body;
308 conf->sec = apr_append_arrays(a, base->sec, new->sec);
310 if (new->satisfy != SATISFY_NOSPEC) {
311 conf->satisfy = new->satisfy;
315 if (new->script_interpreter_source != INTERPRETER_SOURCE_UNSET) {
316 conf->script_interpreter_source = new->script_interpreter_source;
320 if (new->server_signature != srv_sig_unset) {
321 conf->server_signature = new->server_signature;
324 if (new->add_default_charset != ADD_DEFAULT_CHARSET_UNSET) {
325 conf->add_default_charset = new->add_default_charset;
326 if (new->add_default_charset_name) {
327 conf->add_default_charset_name = new->add_default_charset_name;
330 conf->filters = apr_append_arrays(a, base->filters, new->filters);
331 conf->input_filters = apr_append_arrays(a, base->input_filters,
337 static void *create_core_server_config(apr_pool_t *a, server_rec *s)
339 core_server_config *conf;
340 int is_virtual = s->is_virtual;
342 conf = (core_server_config *)apr_pcalloc(a, sizeof(core_server_config));
344 conf->gprof_dir = NULL;
346 conf->access_name = is_virtual ? NULL : DEFAULT_ACCESS_FNAME;
347 conf->ap_document_root = is_virtual ? NULL : DOCUMENT_LOCATION;
348 conf->sec = apr_make_array(a, 40, sizeof(void *));
349 conf->sec_url = apr_make_array(a, 40, sizeof(void *));
354 static void *merge_core_server_configs(apr_pool_t *p, void *basev, void *virtv)
356 core_server_config *base = (core_server_config *)basev;
357 core_server_config *virt = (core_server_config *)virtv;
358 core_server_config *conf;
360 conf = (core_server_config *)apr_pcalloc(p, sizeof(core_server_config));
362 if (!conf->access_name) {
363 conf->access_name = base->access_name;
365 if (!conf->ap_document_root) {
366 conf->ap_document_root = base->ap_document_root;
368 conf->sec = apr_append_arrays(p, base->sec, virt->sec);
369 conf->sec_url = apr_append_arrays(p, base->sec_url, virt->sec_url);
374 /* Add per-directory configuration entry (for <directory> section);
375 * these are part of the core server config.
378 AP_CORE_DECLARE(void) ap_add_per_dir_conf(server_rec *s, void *dir_config)
380 core_server_config *sconf = ap_get_module_config(s->module_config,
382 void **new_space = (void **)apr_push_array(sconf->sec);
384 *new_space = dir_config;
387 AP_CORE_DECLARE(void) ap_add_per_url_conf(server_rec *s, void *url_config)
389 core_server_config *sconf = ap_get_module_config(s->module_config,
391 void **new_space = (void **)apr_push_array(sconf->sec_url);
393 *new_space = url_config;
396 AP_CORE_DECLARE(void) ap_add_file_conf(core_dir_config *conf, void *url_config)
398 void **new_space = (void **)apr_push_array(conf->sec);
400 *new_space = url_config;
403 /* core_reorder_directories reorders the directory sections such that the
404 * 1-component sections come first, then the 2-component, and so on, finally
405 * followed by the "special" sections. A section is "special" if it's a regex,
406 * or if it doesn't start with / -- consider proxy: matching. All movements
407 * are in-order to preserve the ordering of the sections from the config files.
408 * See directory_walk().
411 #if defined(HAVE_DRIVE_LETTERS)
412 #define IS_SPECIAL(entry_core) \
413 ((entry_core)->r != NULL \
414 || ((entry_core)->d[0] != '/' && (entry_core)->d[1] != ':'))
415 #elif defined(NETWARE)
416 /* XXX: Fairly certain this is correct... '/' must prefix the path
417 * or else in the case xyz:/ or abc/xyz:/, '/' must follow the ':'.
418 * If there is no leading '/' or embedded ':/', then we are special.
420 #define IS_SPECIAL(entry_core) \
421 ((entry_core)->r != NULL \
422 || ((entry_core)->d[0] != '/' \
423 && strchr((entry_core)->d, ':') \
424 && *(strchr((entry_core)->d, ':') + 1) != '/'))
426 #define IS_SPECIAL(entry_core) \
427 ((entry_core)->r != NULL || (entry_core)->d[0] != '/')
430 /* We need to do a stable sort, qsort isn't stable. So to make it stable
431 * we'll be maintaining the original index into the list, and using it
432 * as the minor key during sorting. The major key is the number of
433 * components (where a "special" section has infinite components).
435 struct reorder_sort_rec {
440 static int reorder_sorter(const void *va, const void *vb)
442 const struct reorder_sort_rec *a = va;
443 const struct reorder_sort_rec *b = vb;
444 core_dir_config *core_a;
445 core_dir_config *core_b;
447 core_a = (core_dir_config *)ap_get_module_config(a->elt, &core_module);
448 core_b = (core_dir_config *)ap_get_module_config(b->elt, &core_module);
449 if (IS_SPECIAL(core_a)) {
450 if (!IS_SPECIAL(core_b)) {
454 else if (IS_SPECIAL(core_b)) {
458 /* we know they're both not special */
459 if (core_a->d_components < core_b->d_components) {
462 else if (core_a->d_components > core_b->d_components) {
466 /* Either they're both special, or they're both not special and have the
467 * same number of components. In any event, we now have to compare
469 return a->orig_index - b->orig_index;
472 void ap_core_reorder_directories(apr_pool_t *p, server_rec *s)
474 core_server_config *sconf;
475 apr_array_header_t *sec;
476 struct reorder_sort_rec *sortbin;
482 sconf = ap_get_module_config(s->module_config, &core_module);
485 elts = (void **)sec->elts;
487 /* we have to allocate tmp space to do a stable sort */
488 apr_create_pool(&tmp, p);
489 sortbin = apr_palloc(tmp, sec->nelts * sizeof(*sortbin));
490 for (i = 0; i < nelts; ++i) {
491 sortbin[i].orig_index = i;
492 sortbin[i].elt = elts[i];
495 qsort(sortbin, nelts, sizeof(*sortbin), reorder_sorter);
497 /* and now copy back to the original array */
498 for (i = 0; i < nelts; ++i) {
499 elts[i] = sortbin[i].elt;
502 apr_destroy_pool(tmp);
505 /*****************************************************************
507 * There are some elements of the core config structures in which
508 * other modules have a legitimate interest (this is ugly, but necessary
509 * to preserve NCSA back-compatibility). So, we have a bunch of accessors
513 AP_DECLARE(int) ap_allow_options(request_rec *r)
515 core_dir_config *conf =
516 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
521 AP_DECLARE(int) ap_allow_overrides(request_rec *r)
523 core_dir_config *conf;
524 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
527 return conf->override;
530 AP_DECLARE(const char *) ap_auth_type(request_rec *r)
532 core_dir_config *conf;
534 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
536 return conf->ap_auth_type;
539 AP_DECLARE(const char *) ap_auth_name(request_rec *r)
541 core_dir_config *conf;
543 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
545 return conf->ap_auth_name;
548 AP_DECLARE(const char *) ap_default_type(request_rec *r)
550 core_dir_config *conf;
552 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
554 return conf->ap_default_type
555 ? conf->ap_default_type
556 : DEFAULT_CONTENT_TYPE;
559 AP_DECLARE(const char *) ap_document_root(request_rec *r) /* Don't use this! */
561 core_server_config *conf;
563 conf = (core_server_config *)ap_get_module_config(r->server->module_config,
565 return conf->ap_document_root;
568 AP_DECLARE(const apr_array_header_t *) ap_requires(request_rec *r)
570 core_dir_config *conf;
572 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
574 return conf->ap_requires;
577 AP_DECLARE(int) ap_satisfies(request_rec *r)
579 core_dir_config *conf;
581 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
584 return conf->satisfy;
587 /* Should probably just get rid of this... the only code that cares is
588 * part of the core anyway (and in fact, it isn't publicised to other
592 char *ap_response_code_string(request_rec *r, int error_index)
594 core_dir_config *conf;
596 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
599 if (conf->response_code_strings == NULL) {
602 return conf->response_code_strings[error_index];
606 /* Code from Harald Hanche-Olsen <hanche@imf.unit.no> */
607 static apr_inline void do_double_reverse (conn_rec *conn)
609 struct hostent *hptr;
611 if (conn->double_reverse) {
615 if (conn->remote_host == NULL || conn->remote_host[0] == '\0') {
616 /* single reverse failed, so don't bother */
617 conn->double_reverse = -1;
620 hptr = gethostbyname(conn->remote_host);
624 for (haddr = hptr->h_addr_list; *haddr; haddr++) {
625 if (((struct in_addr *)(*haddr))->s_addr
626 == conn->remote_addr.sin_addr.s_addr) {
627 conn->double_reverse = 1;
632 conn->double_reverse = -1;
635 AP_DECLARE(const char *) ap_get_remote_host(conn_rec *conn, void *dir_config,
638 struct in_addr *iaddr;
639 struct hostent *hptr;
640 int hostname_lookups;
642 /* If we haven't checked the host name, and we want to */
645 ((core_dir_config *)ap_get_module_config(dir_config, &core_module))
647 if (hostname_lookups == HOSTNAME_LOOKUP_UNSET) {
648 hostname_lookups = HOSTNAME_LOOKUP_OFF;
653 hostname_lookups = HOSTNAME_LOOKUP_OFF;
656 if (type != REMOTE_NOLOOKUP
657 && conn->remote_host == NULL
658 && (type == REMOTE_DOUBLE_REV
659 || hostname_lookups != HOSTNAME_LOOKUP_OFF)) {
660 iaddr = &(conn->remote_addr.sin_addr);
661 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr), AF_INET);
663 conn->remote_host = apr_pstrdup(conn->pool, (void *)hptr->h_name);
664 ap_str_tolower(conn->remote_host);
666 if (hostname_lookups == HOSTNAME_LOOKUP_DOUBLE) {
667 do_double_reverse(conn);
668 if (conn->double_reverse != 1) {
669 conn->remote_host = NULL;
673 /* if failed, set it to the NULL string to indicate error */
674 if (conn->remote_host == NULL) {
675 conn->remote_host = "";
678 if (type == REMOTE_DOUBLE_REV) {
679 do_double_reverse(conn);
680 if (conn->double_reverse == -1) {
686 * Return the desired information; either the remote DNS name, if found,
687 * or either NULL (if the hostname was requested) or the IP address
688 * (if any identifier was requested).
690 if (conn->remote_host != NULL && conn->remote_host[0] != '\0') {
691 return conn->remote_host;
694 if (type == REMOTE_HOST || type == REMOTE_DOUBLE_REV) {
698 return conn->remote_ip;
703 AP_DECLARE(const char *) ap_get_remote_logname(request_rec *r)
705 core_dir_config *dir_conf;
707 if (r->connection->remote_logname != NULL) {
708 return r->connection->remote_logname;
711 /* If we haven't checked the identity, and we want to */
712 dir_conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
715 if (dir_conf->do_rfc1413 & 1) {
716 return ap_rfc1413(r->connection, r->server);
723 /* There are two options regarding what the "name" of a server is. The
724 * "canonical" name as defined by ServerName and Port, or the "client's
725 * name" as supplied by a possible Host: header or full URI. We never
726 * trust the port passed in the client's headers, we always use the
727 * port of the actual socket.
729 * The DNS option to UseCanonicalName causes this routine to do a
730 * reverse lookup on the local IP address of the connectiona and use
731 * that for the ServerName. This makes its value more reliable while
732 * at the same time allowing Demon's magic virtual hosting to work.
733 * The assumption is that DNS lookups are sufficiently quick...
736 AP_DECLARE(const char *) ap_get_server_name(request_rec *r)
738 conn_rec *conn = r->connection;
741 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
744 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF) {
745 return r->hostname ? r->hostname : r->server->server_hostname;
747 if (d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
748 if (conn->local_host == NULL) {
749 struct in_addr *iaddr;
750 struct hostent *hptr;
751 iaddr = &(conn->local_addr.sin_addr);
752 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr),
755 conn->local_host = apr_pstrdup(conn->pool,
756 (void *)hptr->h_name);
757 ap_str_tolower(conn->local_host);
760 conn->local_host = apr_pstrdup(conn->pool,
761 r->server->server_hostname);
764 return conn->local_host;
767 return r->server->server_hostname;
770 AP_DECLARE(unsigned) ap_get_server_port(const request_rec *r)
774 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
776 port = r->server->port ? r->server->port : ap_default_port(r);
778 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF
779 || d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
780 return r->hostname ? ntohs(r->connection->local_addr.sin_port)
787 AP_DECLARE(char *) ap_construct_url(apr_pool_t *p, const char *uri,
790 unsigned port = ap_get_server_port(r);
791 const char *host = ap_get_server_name(r);
793 if (ap_is_default_port(port, r)) {
794 return apr_pstrcat(p, ap_http_method(r), "://", host, uri, NULL);
796 return apr_psprintf(p, "%s://%s:%u%s", ap_http_method(r), host, port, uri);
799 AP_DECLARE(unsigned long) ap_get_limit_req_body(const request_rec *r)
802 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
804 return d->limit_req_body;
808 static apr_status_t get_win32_registry_default_value(apr_pool_t *p, HKEY hkey,
815 DWORD result = RegOpenKeyEx(hkey, relativepath, 0,
816 KEY_QUERY_VALUE, &hkeyOpen);
818 if (result != ERROR_SUCCESS)
819 return APR_FROM_OS_ERROR(result);
821 /* Read to NULL buffer to determine value size */
822 result = RegQueryValueEx(hkeyOpen, "", 0, &type, NULL, &size);
824 if (result == ERROR_SUCCESS) {
825 if ((size < 2) || (type != REG_SZ && type != REG_EXPAND_SZ)) {
826 result = ERROR_INVALID_PARAMETER;
829 *value = apr_palloc(p, size);
830 /* Read value based on size query above */
831 result = RegQueryValueEx(hkeyOpen, "", 0, &type, *value, &size);
835 /* TODO: This might look fine, but we need to provide some warning
836 * somewhere that some environment variables may -not- be translated,
837 * seeing as we may have chopped the environment table down somewhat.
839 if ((result == ERROR_SUCCESS) && (type == REG_EXPAND_SZ))
842 size = ExpandEnvironmentStrings(tmp, *value, 0);
844 *value = apr_palloc(p, size);
845 size = ExpandEnvironmentStrings(tmp, *value, size);
849 RegCloseKey(hkeyOpen);
850 return APR_FROM_OS_ERROR(result);
853 static char* get_interpreter_from_win32_registry(apr_pool_t *p, const char* ext,
854 char** arguments, int strict)
856 char execcgi_path[] = "SHELL\\EXECCGI\\COMMAND";
857 char execopen_path[] = "SHELL\\OPEN\\COMMAND";
858 char typeName[MAX_PATH];
859 int cmdOfName = FALSE;
871 * Future optimization:
872 * When the registry is successfully searched, store the strings for
873 * interpreter and arguments in an ext hash to speed up subsequent look-ups
876 /* Open the key associated with the script filetype extension */
877 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, ext, 0, KEY_QUERY_VALUE,
880 if (result != ERROR_SUCCESS)
883 /* Retrieve the name of the script filetype extension */
884 size = sizeof(typeName);
885 result = RegQueryValueEx(hkeyType, "", NULL, &type, typeName, &size);
887 if (result == ERROR_SUCCESS && type == REG_SZ && typeName[0]) {
888 /* Open the key associated with the script filetype extension */
889 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, typeName, 0,
890 KEY_QUERY_VALUE, &hkeyName);
892 if (result == ERROR_SUCCESS)
896 /* Open the key for the script command path by:
898 * 1) the 'named' filetype key for ExecCGI/Command
899 * 2) the extension's type key for ExecCGI/Command
901 * and if the strict arg is false, then continue trying:
903 * 3) the 'named' filetype key for Open/Command
904 * 4) the extension's type key for Open/Command
908 result = get_win32_registry_default_value(p, hkeyName,
909 execcgi_path, &buffer);
912 if (!cmdOfName || (result != ERROR_SUCCESS)) {
913 result = get_win32_registry_default_value(p, hkeyType,
914 execcgi_path, &buffer);
917 if (!strict && cmdOfName && (result != ERROR_SUCCESS)) {
918 result = get_win32_registry_default_value(p, hkeyName,
919 execopen_path, &buffer);
922 if (!strict && (result != ERROR_SUCCESS)) {
923 result = get_win32_registry_default_value(p, hkeyType,
924 execopen_path, &buffer);
928 RegCloseKey(hkeyName);
930 RegCloseKey(hkeyType);
932 if (result != ERROR_SUCCESS)
936 * The canonical way shell command entries are entered in the Win32
937 * registry is as follows:
938 * shell [options] "%1" [args]
940 * shell - full path name to interpreter or shell to run.
941 * E.g., c:\usr\local\ntreskit\perl\bin\perl.exe
942 * options - optional switches
944 * "%1" - Place holder for file to run the shell against.
946 * options - additional arguments
949 * If we find a %1 or a quoted %1, lop off the remainder to arguments.
951 if (buffer && *buffer) {
952 if ((s = strstr(buffer, "\"%1")))
957 else if ((s = strstr(buffer, "%1")))
960 *arguments = buffer + 2;
963 *arguments = strchr(buffer, '\0');
964 while (**arguments && isspace(**arguments))
971 AP_DECLARE (file_type_e) ap_get_win32_interpreter(const request_rec *r,
981 file_type_e fileType = eFileTypeUNKNOWN;
983 char *exename = NULL;
985 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
988 /* Find the file extension */
989 exename = strrchr(r->filename, '/');
991 exename = strrchr(r->filename, '\\');
994 exename = r->filename;
999 ext = strrchr(exename, '.');
1001 if (ext && (!strcasecmp(ext,".bat") || !strcasecmp(ext,".cmd")))
1003 char *comspec = getenv("COMSPEC");
1005 *interpreter = apr_pstrcat(r->pool, "\"", comspec, "\" /c ", NULL);
1006 return eFileTypeSCRIPT;
1008 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1009 "Failed to start a '%s' file as a script." APR_EOL_STR
1010 "\tCOMSPEC variable is missing from the environment.", ext);
1011 return eFileTypeUNKNOWN;
1014 /* If the file has an extension and it is not .com and not .exe and
1015 * we've been instructed to search the registry, then do it!
1017 if (ext && strcasecmp(ext,".exe") && strcasecmp(ext,".com") &&
1018 (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY ||
1019 d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT)) {
1020 /* Check the registry */
1021 int strict = (d->script_interpreter_source
1022 == INTERPRETER_SOURCE_REGISTRY_STRICT);
1023 *interpreter = get_interpreter_from_win32_registry(r->pool, ext,
1026 return eFileTypeSCRIPT;
1027 else if (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT) {
1028 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1029 "ScriptInterpreterSource config directive set to \"registry-strict\"." APR_EOL_STR
1030 "\tInterpreter not found for files of type '%s'.", ext);
1031 return eFileTypeUNKNOWN;
1035 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1036 "ScriptInterpreterSource config directive set to \"registry\"." APR_EOL_STR
1037 "\tInterpreter not found for files of type '%s', "
1038 "trying \"script\" method...", ext);
1042 /* Need to peek into the file figure out what it really is... */
1043 hFile = CreateFile(r->filename, GENERIC_READ, FILE_SHARE_READ, NULL,
1044 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
1045 if (hFile == INVALID_HANDLE_VALUE) {
1046 return eFileTypeUNKNOWN;
1048 bResult = ReadFile(hFile, (void*) &buffer, sizeof(buffer) - 1,
1050 if (!bResult || (nBytesRead == 0)) {
1051 ap_log_rerror(APLOG_MARK, APLOG_ERR, GetLastError(), r,
1052 "ReadFile(%s) failed", r->filename);
1054 return eFileTypeUNKNOWN;
1057 buffer[nBytesRead] = '\0';
1059 /* Script or executable, that is the question... */
1060 if ((buffer[0] == '#') && (buffer[1] == '!')) {
1061 /* Assuming file is a script since it starts with a shebang */
1062 fileType = eFileTypeSCRIPT;
1063 for (i = 2; i < sizeof(buffer); i++) {
1064 if ((buffer[i] == '\r')
1065 || (buffer[i] == '\n')) {
1070 for (i = 2; buffer[i] == ' ' ; ++i)
1072 *interpreter = apr_pstrdup(r->pool, buffer + i );
1075 /* Not a script, is it an executable? */
1076 IMAGE_DOS_HEADER *hdr = (IMAGE_DOS_HEADER*)buffer;
1077 if ((nBytesRead >= sizeof(IMAGE_DOS_HEADER)) && (hdr->e_magic == IMAGE_DOS_SIGNATURE)) {
1078 if (hdr->e_lfarlc < 0x40)
1079 fileType = eFileTypeEXE16;
1081 fileType = eFileTypeEXE32;
1084 fileType = eFileTypeUNKNOWN;
1091 /*****************************************************************
1093 * Commands... this module handles almost all of the NCSA httpd.conf
1094 * commands, but most of the old srm.conf is in the the modules.
1098 /* returns a parent if it matches the given directive */
1099 static const ap_directive_t * find_parent(const ap_directive_t *dirp,
1102 while (dirp->parent != NULL) {
1103 dirp = dirp->parent;
1104 /* ### it would be nice to have atom-ized directives */
1105 if (strcasecmp(dirp->directive, what) == 0)
1111 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd,
1114 const char *gt = (cmd->cmd->name[0] == '<'
1115 && cmd->cmd->name[strlen(cmd->cmd->name)-1] != '>')
1117 const ap_directive_t *found;
1119 if ((forbidden & NOT_IN_VIRTUALHOST) && cmd->server->is_virtual) {
1120 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1121 " cannot occur within <VirtualHost> section", NULL);
1124 if ((forbidden & NOT_IN_LIMIT) && cmd->limited != -1) {
1125 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1126 " cannot occur within <Limit> section", NULL);
1129 if ((forbidden & NOT_IN_DIR_LOC_FILE) == NOT_IN_DIR_LOC_FILE
1130 && cmd->path != NULL) {
1131 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1132 " cannot occur within <Directory/Location/Files> "
1136 if (((forbidden & NOT_IN_DIRECTORY)
1137 && ((found = find_parent(cmd->directive, "<Directory"))
1138 || (found = find_parent(cmd->directive, "<DirectoryMatch"))))
1139 || ((forbidden & NOT_IN_LOCATION)
1140 && ((found = find_parent(cmd->directive, "<Location"))
1141 || (found = find_parent(cmd->directive, "<LocationMatch"))))
1142 || ((forbidden & NOT_IN_FILES)
1143 && ((found = find_parent(cmd->directive, "<Files"))
1144 || (found = find_parent(cmd->directive, "<FilesMatch"))))) {
1145 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1146 " cannot occur within ", found->directive,
1153 static const char *set_access_name(cmd_parms *cmd, void *dummy,
1156 void *sconf = cmd->server->module_config;
1157 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1159 const char *err = ap_check_cmd_context(cmd,
1160 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1165 conf->access_name = apr_pstrdup(cmd->pool, arg);
1170 static const char *set_gprof_dir(cmd_parms *cmd, void *dummy, char *arg)
1172 void *sconf = cmd->server->module_config;
1173 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1175 const char *err = ap_check_cmd_context(cmd,
1176 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1181 conf->gprof_dir = apr_pstrdup(cmd->pool, arg);
1186 static const char *set_add_default_charset(cmd_parms *cmd,
1187 void *d_, const char *arg)
1189 core_dir_config *d=d_;
1191 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1195 if (!strcasecmp(arg, "Off")) {
1196 d->add_default_charset = ADD_DEFAULT_CHARSET_OFF;
1198 else if (!strcasecmp(arg, "On")) {
1199 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1200 d->add_default_charset_name = DEFAULT_ADD_DEFAULT_CHARSET_NAME;
1203 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1204 d->add_default_charset_name = arg;
1209 static const char *set_document_root(cmd_parms *cmd, void *dummy,
1212 void *sconf = cmd->server->module_config;
1213 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1215 const char *err = ap_check_cmd_context(cmd,
1216 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1221 arg = ap_os_canonical_filename(cmd->pool, arg);
1222 if (/* TODO: ap_configtestonly && ap_docrootcheck && */ !ap_is_directory(arg)) {
1223 if (cmd->server->is_virtual) {
1224 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1225 "Warning: DocumentRoot [%s] does not exist",
1229 return "DocumentRoot must be a directory";
1233 conf->ap_document_root = arg;
1237 AP_DECLARE(void) ap_custom_response(request_rec *r, int status, char *string)
1239 core_dir_config *conf =
1240 ap_get_module_config(r->per_dir_config, &core_module);
1243 if(conf->response_code_strings == NULL) {
1244 conf->response_code_strings =
1245 apr_pcalloc(r->pool,
1246 sizeof(*conf->response_code_strings) *
1250 idx = ap_index_of_response(status);
1252 conf->response_code_strings[idx] =
1253 ((ap_is_url(string) || (*string == '/')) && (*string != '"')) ?
1254 apr_pstrdup(r->pool, string) : apr_pstrcat(r->pool, "\"", string, NULL);
1257 static const char *set_error_document(cmd_parms *cmd, void *conf_,
1258 const char *errno_str, const char *msg)
1260 core_dir_config *conf=conf_;
1261 int error_number, index_number, idx500;
1262 enum { MSG, LOCAL_PATH, REMOTE_PATH } what = MSG;
1264 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1269 /* 1st parameter should be a 3 digit number, which we recognize;
1270 * convert it into an array index
1272 error_number = atoi(errno_str);
1273 idx500 = ap_index_of_response(HTTP_INTERNAL_SERVER_ERROR);
1275 if (error_number == HTTP_INTERNAL_SERVER_ERROR) {
1276 index_number = idx500;
1278 else if ((index_number = ap_index_of_response(error_number)) == idx500) {
1279 return apr_pstrcat(cmd->pool, "Unsupported HTTP response code ",
1283 /* Heuristic to determine second argument. */
1284 if (ap_strchr_c(msg,' '))
1286 else if (msg[0] == '/')
1288 else if (ap_is_url(msg))
1293 /* The entry should be ignored if it is a full URL for a 401 error */
1295 if (error_number == 401 && what == REMOTE_PATH) {
1296 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, cmd->server,
1297 "cannot use a full URL in a 401 ErrorDocument "
1298 "directive --- ignoring!");
1300 else { /* Store it... */
1301 if (conf->response_code_strings == NULL) {
1302 conf->response_code_strings =
1303 apr_pcalloc(cmd->pool,
1304 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
1306 /* hack. Prefix a " if it is a msg; as that is what
1307 * http_protocol.c relies on to distinguish between
1308 * a msg and a (local) path.
1310 conf->response_code_strings[index_number] = (what == MSG) ?
1311 apr_pstrcat(cmd->pool, "\"",msg,NULL) :
1312 apr_pstrdup(cmd->pool, msg);
1318 static const char *set_override(cmd_parms *cmd, void *d_, const char *l)
1320 core_dir_config *d=d_;
1323 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1328 d->override = OR_NONE;
1330 w = ap_getword_conf(cmd->pool, &l);
1331 if (!strcasecmp(w, "Limit")) {
1332 d->override |= OR_LIMIT;
1334 else if (!strcasecmp(w, "Options")) {
1335 d->override |= OR_OPTIONS;
1337 else if (!strcasecmp(w, "FileInfo")) {
1338 d->override |= OR_FILEINFO;
1340 else if (!strcasecmp(w, "AuthConfig")) {
1341 d->override |= OR_AUTHCFG;
1343 else if (!strcasecmp(w, "Indexes")) {
1344 d->override |= OR_INDEXES;
1346 else if (!strcasecmp(w, "None")) {
1347 d->override = OR_NONE;
1349 else if (!strcasecmp(w, "All")) {
1350 d->override = OR_ALL;
1353 return apr_pstrcat(cmd->pool, "Illegal override option ", w, NULL);
1355 d->override &= ~OR_UNSET;
1361 static const char *set_options(cmd_parms *cmd, void *d_, const char *l)
1363 core_dir_config *d=d_;
1364 allow_options_t opt;
1369 char *w = ap_getword_conf(cmd->pool, &l);
1372 if (*w == '+' || *w == '-') {
1380 if (!strcasecmp(w, "Indexes")) {
1383 else if (!strcasecmp(w, "Includes")) {
1386 else if (!strcasecmp(w, "IncludesNOEXEC")) {
1387 opt = (OPT_INCLUDES | OPT_INCNOEXEC);
1389 else if (!strcasecmp(w, "FollowSymLinks")) {
1390 opt = OPT_SYM_LINKS;
1392 else if (!strcasecmp(w, "SymLinksIfOwnerMatch")) {
1393 opt = OPT_SYM_OWNER;
1395 else if (!strcasecmp(w, "execCGI")) {
1398 else if (!strcasecmp(w, "MultiViews")) {
1401 else if (!strcasecmp(w, "RunScripts")) { /* AI backcompat. Yuck */
1402 opt = OPT_MULTI|OPT_EXECCGI;
1404 else if (!strcasecmp(w, "None")) {
1407 else if (!strcasecmp(w, "All")) {
1411 return apr_pstrcat(cmd->pool, "Illegal option ", w, NULL);
1414 /* we ensure the invariant (d->opts_add & d->opts_remove) == 0 */
1415 if (action == '-') {
1416 d->opts_remove |= opt;
1417 d->opts_add &= ~opt;
1420 else if (action == '+') {
1422 d->opts_remove &= ~opt;
1433 static const char *satisfy(cmd_parms *cmd, void *c_, const char *arg)
1435 core_dir_config *c=c_;
1437 if (!strcasecmp(arg, "all")) {
1438 c->satisfy = SATISFY_ALL;
1440 else if (!strcasecmp(arg, "any")) {
1441 c->satisfy = SATISFY_ANY;
1444 return "Satisfy either 'any' or 'all'.";
1449 static const char *require(cmd_parms *cmd, void *c_, const char *arg)
1452 core_dir_config *c=c_;
1454 if (!c->ap_requires) {
1455 c->ap_requires = apr_make_array(cmd->pool, 2, sizeof(require_line));
1457 r = (require_line *)apr_push_array(c->ap_requires);
1458 r->requirement = apr_pstrdup(cmd->pool, arg);
1459 r->method_mask = cmd->limited;
1463 AP_CORE_DECLARE_NONSTD(const char *) ap_limit_section(cmd_parms *cmd, void *dummy,
1465 const char *limited_methods = ap_getword(cmd->pool, &arg, '>');
1466 void *tog = cmd->cmd->cmd_data;
1470 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1475 while (limited_methods[0]) {
1476 char *method = ap_getword_conf(cmd->pool, &limited_methods);
1477 int methnum = ap_method_number_of(method);
1479 if (methnum == M_TRACE && !tog) {
1480 return "TRACE cannot be controlled by <Limit>";
1482 else if (methnum == M_INVALID) {
1484 register int i, j, k;
1487 * Deal with <Limit> by adding the method to the list.
1490 if (cmd->limited_xmethods == NULL) {
1491 cmd->limited_xmethods = apr_make_array(cmd->pool, 2,
1494 xmethod = (char **) apr_push_array(cmd->limited_xmethods);
1495 *xmethod = apr_pstrdup(cmd->pool, method);
1498 * <LimitExcept>, so remove any/all occurrences of the method
1499 * in the extension array.
1501 else if ((cmd->limited_xmethods != NULL)
1502 && (cmd->limited_xmethods->nelts != 0)) {
1503 xmethod = (char **) cmd->limited_xmethods->elts;
1504 for (i = 0; i < cmd->limited_xmethods->nelts; ) {
1505 if (strcmp(xmethod[i], method) == 0) {
1506 for (j = i, k = i + 1;
1507 k < cmd->limited_xmethods->nelts;
1509 xmethod[j] = xmethod[k];
1511 cmd->limited_xmethods->nelts--;
1516 limited |= (1 << methnum);
1519 /* Killing two features with one function,
1520 * if (tog == NULL) <Limit>, else <LimitExcept>
1522 cmd->limited = tog ? ~limited : limited;
1524 errmsg = ap_walk_config(cmd->directive->first_child, cmd, cmd->context);
1531 /* We use this in <DirectoryMatch> and <FilesMatch>, to ensure that
1532 * people don't get bitten by wrong-cased regex matches
1536 #define USE_ICASE REG_ICASE
1542 * Report a missing-'>' syntax error.
1544 static char *unclosed_directive(cmd_parms *cmd)
1546 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1547 "> directive missing closing '>'", NULL);
1550 static const char *dirsection(cmd_parms *cmd, void *mconfig, const char *arg)
1553 const char *endp = ap_strrchr_c(arg, '>');
1554 int old_overrides = cmd->override;
1555 char *old_path = cmd->path;
1556 core_dir_config *conf;
1557 void *new_dir_conf = ap_create_per_dir_config(cmd->pool);
1559 const command_rec *thiscmd = cmd->cmd;
1561 const char *err = ap_check_cmd_context(cmd,
1562 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1568 return unclosed_directive(cmd);
1571 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1573 cmd->path = ap_getword_conf(cmd->pool, &arg);
1574 cmd->override = OR_ALL|ACCESS_CONF;
1576 if (thiscmd->cmd_data) { /* <DirectoryMatch> */
1577 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1579 else if (!strcmp(cmd->path, "~")) {
1580 cmd->path = ap_getword_conf(cmd->pool, &arg);
1581 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1583 #if defined(HAVE_DRIVE_LETTERS) || defined(NETWARE)
1584 else if (strcmp(cmd->path, "/") == 0) {
1585 /* Treat 'default' path / as an inalienable root */
1586 cmd->path = apr_pstrdup(cmd->pool, cmd->path);
1589 #if defined(HAVE_UNC_PATHS)
1590 else if (strcmp(cmd->path, "//") == 0) {
1591 /* Treat UNC path // as an inalienable root */
1592 cmd->path = apr_pstrdup(cmd->pool, cmd->path);
1596 /* Ensure that the pathname is canonical */
1597 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1600 /* initialize our config and fetch it */
1601 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_dir_conf,
1604 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_dir_conf);
1610 ap_add_per_dir_conf(cmd->server, new_dir_conf);
1613 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1614 "> arguments not (yet) supported.", NULL);
1617 cmd->path = old_path;
1618 cmd->override = old_overrides;
1623 static const char *urlsection(cmd_parms *cmd, void *mconfig, const char *arg)
1626 const char *endp = ap_strrchr_c(arg, '>');
1627 int old_overrides = cmd->override;
1628 char *old_path = cmd->path;
1629 core_dir_config *conf;
1631 const command_rec *thiscmd = cmd->cmd;
1633 void *new_url_conf = ap_create_per_dir_config(cmd->pool);
1635 const char *err = ap_check_cmd_context(cmd,
1636 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1642 return unclosed_directive(cmd);
1645 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1647 cmd->path = ap_getword_conf(cmd->pool, &arg);
1648 cmd->override = OR_ALL|ACCESS_CONF;
1650 if (thiscmd->cmd_data) { /* <LocationMatch> */
1651 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1653 else if (!strcmp(cmd->path, "~")) {
1654 cmd->path = ap_getword_conf(cmd->pool, &arg);
1655 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1658 /* initialize our config and fetch it */
1659 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_url_conf,
1662 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_url_conf);
1666 conf->d = apr_pstrdup(cmd->pool, cmd->path); /* No mangling, please */
1667 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1670 ap_add_per_url_conf(cmd->server, new_url_conf);
1673 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1674 "> arguments not (yet) supported.", NULL);
1677 cmd->path = old_path;
1678 cmd->override = old_overrides;
1683 static const char *filesection(cmd_parms *cmd, void *mconfig, const char *arg)
1686 const char *endp = ap_strrchr_c(arg, '>');
1687 int old_overrides = cmd->override;
1688 char *old_path = cmd->path;
1689 core_dir_config *conf;
1691 const command_rec *thiscmd = cmd->cmd;
1692 core_dir_config *c=mconfig;
1694 void *new_file_conf = ap_create_per_dir_config(cmd->pool);
1696 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT|NOT_IN_LOCATION);
1702 return unclosed_directive(cmd);
1705 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1707 cmd->path = ap_getword_conf(cmd->pool, &arg);
1708 /* Only if not an .htaccess file */
1710 cmd->override = OR_ALL|ACCESS_CONF;
1713 if (thiscmd->cmd_data) { /* <FilesMatch> */
1714 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1716 else if (!strcmp(cmd->path, "~")) {
1717 cmd->path = ap_getword_conf(cmd->pool, &arg);
1718 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1721 /* Ensure that the pathname is canonical */
1722 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1725 /* initialize our config and fetch it */
1726 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_file_conf,
1729 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_file_conf);
1733 conf->d = cmd->path;
1734 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1737 ap_add_file_conf(c, new_file_conf);
1740 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1741 "> arguments not (yet) supported.", NULL);
1744 cmd->path = old_path;
1745 cmd->override = old_overrides;
1750 static const char *start_ifmod(cmd_parms *cmd, void *mconfig, const char *arg)
1752 const char *endp = ap_strrchr_c(arg, '>');
1753 int not = (arg[0] == '!');
1757 return unclosed_directive(cmd);
1760 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1766 found = ap_find_linked_module(arg);
1768 if ((!not && found) || (not && !found)) {
1769 ap_directive_t *parent = NULL;
1770 ap_directive_t *current = NULL;
1773 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1774 ¤t, &parent, "<IfModule");
1775 *(ap_directive_t **)mconfig = current;
1779 *(ap_directive_t **)mconfig = NULL;
1780 return ap_soak_end_container(cmd, "<IfModule");
1784 AP_DECLARE(int) ap_exists_config_define(const char *name)
1789 defines = (char **)ap_server_config_defines->elts;
1790 for (i = 0; i < ap_server_config_defines->nelts; i++) {
1791 if (strcmp(defines[i], name) == 0) {
1798 static const char *start_ifdefine(cmd_parms *cmd, void *dummy, const char *arg)
1804 endp = ap_strrchr_c(arg, '>');
1806 return unclosed_directive(cmd);
1809 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1811 if (arg[0] == '!') {
1816 defined = ap_exists_config_define(arg);
1817 if ((!not && defined) || (not && !defined)) {
1818 ap_directive_t *parent = NULL;
1819 ap_directive_t *current = NULL;
1822 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1823 ¤t, &parent, "<IfDefine");
1824 *(ap_directive_t **)dummy = current;
1828 *(ap_directive_t **)dummy = NULL;
1829 return ap_soak_end_container(cmd, "<IfDefine");
1833 /* httpd.conf commands... beginning with the <VirtualHost> business */
1835 static const char *virtualhost_section(cmd_parms *cmd, void *dummy,
1838 server_rec *main_server = cmd->server, *s;
1840 const char *endp = ap_strrchr_c(arg, '>');
1841 apr_pool_t *p = cmd->pool;
1843 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1849 return unclosed_directive(cmd);
1852 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1854 /* FIXME: There's another feature waiting to happen here -- since you
1855 can now put multiple addresses/names on a single <VirtualHost>
1856 you might want to use it to group common definitions and then
1857 define other "subhosts" with their individual differences. But
1858 personally I'd rather just do it with a macro preprocessor. -djg */
1859 if (main_server->is_virtual) {
1860 return "<VirtualHost> doesn't nest!";
1863 errmsg = ap_init_virtual_host(p, arg, main_server, &s);
1868 s->next = main_server->next;
1869 main_server->next = s;
1871 s->defn_name = cmd->directive->filename;
1872 s->defn_line_number = cmd->directive->line_num;
1876 errmsg = ap_walk_config(cmd->directive->first_child, cmd,
1877 s->lookup_defaults);
1879 cmd->server = main_server;
1884 static const char *set_server_alias(cmd_parms *cmd, void *dummy,
1887 if (!cmd->server->names) {
1888 return "ServerAlias only used in <VirtualHost>";
1891 char **item, *name = ap_getword_conf(cmd->pool, &arg);
1892 if (ap_is_matchexp(name)) {
1893 item = (char **)apr_push_array(cmd->server->wild_names);
1896 item = (char **)apr_push_array(cmd->server->names);
1903 static const char *add_filter(cmd_parms *cmd, void *dummy, const char *arg)
1905 core_dir_config *conf = dummy;
1908 newfilter = (char **)apr_push_array(conf->filters);
1909 *newfilter = apr_pstrdup(cmd->pool, arg);
1913 static const char *add_input_filter(cmd_parms *cmd, void *dummy, const char *arg)
1915 core_dir_config *conf = dummy;
1918 newfilter = (char **)apr_push_array(conf->input_filters);
1919 *newfilter = apr_pstrdup(cmd->pool, arg);
1923 static const char *add_module_command(cmd_parms *cmd, void *dummy,
1926 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1931 if (!ap_add_named_module(arg)) {
1932 return apr_pstrcat(cmd->pool, "Cannot add module via name '", arg,
1933 "': not in list of loaded modules", NULL);
1935 *(ap_directive_t **)dummy = NULL;
1939 static const char *clear_module_list_command(cmd_parms *cmd, void *dummy)
1941 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1946 ap_clear_module_list();
1947 *(ap_directive_t **)dummy = NULL;
1951 static const char *set_server_string_slot(cmd_parms *cmd, void *dummy,
1954 /* This one's pretty generic... */
1956 int offset = (int)(long)cmd->info;
1957 char *struct_ptr = (char *)cmd->server;
1959 const char *err = ap_check_cmd_context(cmd,
1960 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1965 *(const char **)(struct_ptr + offset) = arg;
1969 static const char *server_port(cmd_parms *cmd, void *dummy, const char *arg)
1971 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1978 if (port <= 0 || port >= 65536) { /* 65536 == 1<<16 */
1979 return apr_pstrcat(cmd->temp_pool, "The port number \"", arg,
1980 "\" is outside the appropriate range "
1981 "(i.e., 1..65535).", NULL);
1983 cmd->server->port = port;
1987 static const char *set_signature_flag(cmd_parms *cmd, void *d_,
1990 core_dir_config *d=d_;
1992 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1997 if (strcasecmp(arg, "On") == 0) {
1998 d->server_signature = srv_sig_on;
2000 else if (strcasecmp(arg, "Off") == 0) {
2001 d->server_signature = srv_sig_off;
2003 else if (strcasecmp(arg, "EMail") == 0) {
2004 d->server_signature = srv_sig_withmail;
2007 return "ServerSignature: use one of: off | on | email";
2012 static const char *set_server_root(cmd_parms *cmd, void *dummy,
2015 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2021 arg = ap_os_canonical_filename(cmd->pool, arg);
2023 if (!ap_is_directory(arg)) {
2024 return "ServerRoot must be a valid directory";
2026 ap_server_root = arg;
2030 static const char *set_timeout(cmd_parms *cmd, void *dummy, const char *arg)
2032 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2037 cmd->server->timeout = atoi(arg);
2041 static const char *set_keep_alive_timeout(cmd_parms *cmd, void *dummy,
2044 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2049 cmd->server->keep_alive_timeout = atoi(arg);
2053 static const char *set_keep_alive(cmd_parms *cmd, void *dummy,
2056 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2061 /* We've changed it to On/Off, but used to use numbers
2062 * so we accept anything but "Off" or "0" as "On"
2064 if (!strcasecmp(arg, "off") || !strcmp(arg, "0")) {
2065 cmd->server->keep_alive = 0;
2068 cmd->server->keep_alive = 1;
2073 static const char *set_keep_alive_max(cmd_parms *cmd, void *dummy,
2076 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2081 cmd->server->keep_alive_max = atoi(arg);
2085 static const char *set_idcheck(cmd_parms *cmd, void *d_, int arg)
2087 core_dir_config *d=d_;
2088 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2093 d->do_rfc1413 = arg != 0;
2097 static const char *set_hostname_lookups(cmd_parms *cmd, void *d_,
2100 core_dir_config *d=d_;
2102 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2107 if (!strcasecmp(arg, "on")) {
2108 d->hostname_lookups = HOSTNAME_LOOKUP_ON;
2110 else if (!strcasecmp(arg, "off")) {
2111 d->hostname_lookups = HOSTNAME_LOOKUP_OFF;
2113 else if (!strcasecmp(arg, "double")) {
2114 d->hostname_lookups = HOSTNAME_LOOKUP_DOUBLE;
2117 return "parameter must be 'on', 'off', or 'double'";
2122 static const char *set_serverpath(cmd_parms *cmd, void *dummy,
2125 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2130 cmd->server->path = arg;
2131 cmd->server->pathlen = strlen(arg);
2135 static const char *set_content_md5(cmd_parms *cmd, void *d_, int arg)
2137 core_dir_config *d=d_;
2138 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2143 d->content_md5 = arg != 0;
2147 static const char *set_use_canonical_name(cmd_parms *cmd, void *d_,
2150 core_dir_config *d=d_;
2151 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2156 if (strcasecmp(arg, "on") == 0) {
2157 d->use_canonical_name = USE_CANONICAL_NAME_ON;
2159 else if (strcasecmp(arg, "off") == 0) {
2160 d->use_canonical_name = USE_CANONICAL_NAME_OFF;
2162 else if (strcasecmp(arg, "dns") == 0) {
2163 d->use_canonical_name = USE_CANONICAL_NAME_DNS;
2166 return "parameter must be 'on', 'off', or 'dns'";
2172 static const char *include_config (cmd_parms *cmd, void *dummy,
2175 ap_directive_t *conftree = NULL;
2177 ap_process_resource_config(cmd->server,
2178 ap_server_root_relative(cmd->pool, name),
2179 &conftree, cmd->pool, cmd->temp_pool);
2180 *(ap_directive_t **)dummy = conftree;
2184 static const char *set_loglevel(cmd_parms *cmd, void *dummy, const char *arg)
2188 const char *err = ap_check_cmd_context(cmd,
2189 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2194 if ((str = ap_getword_conf(cmd->pool, &arg))) {
2195 if (!strcasecmp(str, "emerg")) {
2196 cmd->server->loglevel = APLOG_EMERG;
2198 else if (!strcasecmp(str, "alert")) {
2199 cmd->server->loglevel = APLOG_ALERT;
2201 else if (!strcasecmp(str, "crit")) {
2202 cmd->server->loglevel = APLOG_CRIT;
2204 else if (!strcasecmp(str, "error")) {
2205 cmd->server->loglevel = APLOG_ERR;
2207 else if (!strcasecmp(str, "warn")) {
2208 cmd->server->loglevel = APLOG_WARNING;
2210 else if (!strcasecmp(str, "notice")) {
2211 cmd->server->loglevel = APLOG_NOTICE;
2213 else if (!strcasecmp(str, "info")) {
2214 cmd->server->loglevel = APLOG_INFO;
2216 else if (!strcasecmp(str, "debug")) {
2217 cmd->server->loglevel = APLOG_DEBUG;
2220 return "LogLevel requires level keyword: one of "
2221 "emerg/alert/crit/error/warn/notice/info/debug";
2225 return "LogLevel requires level keyword";
2231 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r)
2234 core_dir_config *conf;
2236 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
2238 if ((conf->server_signature == srv_sig_off)
2239 || (conf->server_signature == srv_sig_unset)) {
2243 apr_snprintf(sport, sizeof sport, "%u", (unsigned) ap_get_server_port(r));
2245 if (conf->server_signature == srv_sig_withmail) {
2246 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2247 " Server at <A HREF=\"mailto:",
2248 r->server->server_admin, "\">",
2249 ap_get_server_name(r), "</A> Port ", sport,
2250 "</ADDRESS>\n", NULL);
2252 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2253 " Server at ", ap_get_server_name(r), " Port ", sport,
2254 "</ADDRESS>\n", NULL);
2258 * Load an authorisation realm into our location configuration, applying the
2259 * usual rules that apply to realms.
2261 static const char *set_authname(cmd_parms *cmd, void *mconfig,
2264 core_dir_config *aconfig = (core_dir_config *)mconfig;
2266 aconfig->ap_auth_name = ap_escape_quotes(cmd->pool, word1);
2270 #ifdef _OSD_POSIX /* BS2000 Logon Passwd file */
2271 static const char *set_bs2000_account(cmd_parms *cmd, void *dummy, char *name)
2273 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2278 return os_set_account(cmd->pool, name);
2280 #endif /*_OSD_POSIX*/
2283 * Handle a request to include the server's OS platform in the Server
2284 * response header field (the ServerTokens directive). Unfortunately
2285 * this requires a new global in order to communicate the setting back to
2286 * http_main so it can insert the information in the right place in the
2290 static char *server_version = NULL;
2291 static int version_locked = 0;
2293 enum server_token_type {
2294 SrvTk_MIN, /* eg: Apache/1.3.0 */
2295 SrvTk_OS, /* eg: Apache/1.3.0 (UNIX) */
2296 SrvTk_FULL, /* eg: Apache/1.3.0 (UNIX) PHP/3.0 FooBar/1.2b */
2297 SrvTk_PRODUCT_ONLY /* eg: Apache */
2299 static enum server_token_type ap_server_tokens = SrvTk_FULL;
2301 static apr_status_t reset_version(void *dummy)
2304 ap_server_tokens = SrvTk_FULL;
2305 server_version = NULL;
2309 AP_DECLARE(const char *) ap_get_server_version(void)
2311 return (server_version ? server_version : AP_SERVER_BASEVERSION);
2314 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component)
2316 if (! version_locked) {
2318 * If the version string is null, register our cleanup to reset the
2319 * pointer on pool destruction. We also know that, if NULL,
2320 * we are adding the original SERVER_BASEVERSION string.
2322 if (server_version == NULL) {
2323 apr_register_cleanup(pconf, NULL, reset_version,
2325 server_version = apr_pstrdup(pconf, component);
2329 * Tack the given component identifier to the end of
2330 * the existing string.
2332 server_version = apr_pstrcat(pconf, server_version, " ",
2339 * This routine adds the real server base identity to the version string,
2340 * and then locks out changes until the next reconfig.
2342 static void ap_set_version(apr_pool_t *pconf)
2344 if (ap_server_tokens == SrvTk_PRODUCT_ONLY) {
2345 ap_add_version_component(pconf, AP_SERVER_BASEPRODUCT);
2347 else if (ap_server_tokens == SrvTk_MIN) {
2348 ap_add_version_component(pconf, AP_SERVER_BASEVERSION);
2351 ap_add_version_component(pconf, AP_SERVER_BASEVERSION " (" PLATFORM ")");
2354 * Lock the server_version string if we're not displaying
2355 * the full set of tokens
2357 if (ap_server_tokens != SrvTk_FULL) {
2362 static const char *set_serv_tokens(cmd_parms *cmd, void *dummy,
2365 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2370 if (!strcasecmp(arg, "OS")) {
2371 ap_server_tokens = SrvTk_OS;
2373 else if (!strcasecmp(arg, "Min") || !strcasecmp(arg, "Minimal")) {
2374 ap_server_tokens = SrvTk_MIN;
2376 else if (!strcasecmp(arg, "Prod") || !strcasecmp(arg, "ProductOnly")) {
2377 ap_server_tokens = SrvTk_PRODUCT_ONLY;
2380 ap_server_tokens = SrvTk_FULL;
2385 static const char *set_limit_req_line(cmd_parms *cmd, void *dummy,
2388 const char *err = ap_check_cmd_context(cmd,
2389 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2397 return apr_pstrcat(cmd->temp_pool, "LimitRequestLine \"", arg,
2398 "\" must be a non-negative integer", NULL);
2400 if (lim > DEFAULT_LIMIT_REQUEST_LINE) {
2401 return apr_psprintf(cmd->temp_pool, "LimitRequestLine \"%s\" "
2402 "must not exceed the precompiled maximum of %d",
2403 arg, DEFAULT_LIMIT_REQUEST_LINE);
2405 cmd->server->limit_req_line = lim;
2409 static const char *set_limit_req_fieldsize(cmd_parms *cmd, void *dummy,
2412 const char *err = ap_check_cmd_context(cmd,
2413 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2421 return apr_pstrcat(cmd->temp_pool, "LimitRequestFieldsize \"", arg,
2422 "\" must be a non-negative integer (0 = no limit)",
2425 if (lim > DEFAULT_LIMIT_REQUEST_FIELDSIZE) {
2426 return apr_psprintf(cmd->temp_pool, "LimitRequestFieldsize \"%s\" "
2427 "must not exceed the precompiled maximum of %d",
2428 arg, DEFAULT_LIMIT_REQUEST_FIELDSIZE);
2430 cmd->server->limit_req_fieldsize = lim;
2434 static const char *set_limit_req_fields(cmd_parms *cmd, void *dummy,
2437 const char *err = ap_check_cmd_context(cmd,
2438 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2446 return apr_pstrcat(cmd->temp_pool, "LimitRequestFields \"", arg,
2447 "\" must be a non-negative integer (0 = no limit)",
2450 cmd->server->limit_req_fields = lim;
2454 static const char *set_limit_req_body(cmd_parms *cmd, void *conf_,
2457 core_dir_config *conf=conf_;
2458 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2463 /* WTF: If strtoul is not portable, then write a replacement.
2464 * Instead we have an idiotic define in httpd.h that prevents
2465 * it from being used even when it is available. Sheesh.
2467 conf->limit_req_body = (unsigned long)strtol(arg, (char **)NULL, 10);
2471 static const char *set_limit_xml_req_body(cmd_parms *cmd, void *conf_,
2474 core_dir_config *conf = conf_;
2475 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2480 conf->limit_xml_body = atol(arg);
2481 if (conf->limit_xml_body < 0)
2482 return "LimitXMLRequestBody requires a non-negative integer.";
2487 AP_DECLARE(size_t) ap_get_limit_xml_body(const request_rec *r)
2489 core_dir_config *conf;
2491 conf = ap_get_module_config(r->per_dir_config, &core_module);
2492 if (conf->limit_xml_body == AP_LIMIT_UNSET)
2493 return AP_DEFAULT_LIMIT_XML_BODY;
2494 return (size_t)conf->limit_xml_body;
2498 static const char *set_interpreter_source(cmd_parms *cmd, core_dir_config *d,
2501 if (!strcasecmp(arg, "registry")) {
2502 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY;
2503 } else if (!strcasecmp(arg, "registry-strict")) {
2504 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY_STRICT;
2505 } else if (!strcasecmp(arg, "script")) {
2506 d->script_interpreter_source = INTERPRETER_SOURCE_SHEBANG;
2508 return apr_pstrcat(cmd->temp_pool, "ScriptInterpreterSource \"", arg,
2509 "\" must be \"registry\", \"registry-strict\" or "
2510 "\"script\"", NULL);
2516 #if !defined (RLIMIT_CPU) || !(defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)) || !defined (RLIMIT_NPROC)
2517 static const char *no_set_limit(cmd_parms *cmd, core_dir_config *conf,
2518 const char *arg, const char *arg2)
2520 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, cmd->server,
2521 "%s not supported on this platform", cmd->cmd->name);
2527 static const char *set_limit_cpu(cmd_parms *cmd, void *conf_,
2528 const char *arg, const char *arg2)
2530 core_dir_config *conf=conf_;
2532 unixd_set_rlimit(cmd, &conf->limit_cpu, arg, arg2, RLIMIT_CPU);
2537 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)
2538 static const char *set_limit_mem(cmd_parms *cmd, void *conf_,
2539 const char *arg, const char * arg2)
2541 core_dir_config *conf=conf_;
2543 #if defined(RLIMIT_AS)
2544 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2 ,RLIMIT_AS);
2545 #elif defined(RLIMIT_DATA)
2546 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_DATA);
2547 #elif defined(RLIMIT_VMEM)
2548 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_VMEM);
2555 static const char *set_limit_nproc(cmd_parms *cmd, void *conf_,
2556 const char *arg, const char * arg2)
2558 core_dir_config *conf=conf_;
2560 unixd_set_rlimit(cmd, &conf->limit_nproc, arg, arg2, RLIMIT_NPROC);
2565 static apr_status_t writev_it_all(apr_socket_t *s, struct iovec *vec, int nvec,
2566 apr_size_t len, apr_size_t *nbytes)
2568 apr_size_t bytes_written = 0;
2570 apr_ssize_t n = len;
2575 /* XXX handle checking for non-blocking socket */
2576 while (bytes_written != len) {
2577 rv = apr_sendv(s, vec + i, nvec - i, &n);
2579 if (rv != APR_SUCCESS)
2582 /* If the write did not complete, adjust the iovecs and issue
2585 if (bytes_written < len) {
2586 /* Skip over the vectors that have already been written */
2587 apr_size_t cnt = vec[i].iov_len;
2588 while (n >= cnt && i + 1 < nvec) {
2590 cnt += vec[i].iov_len;
2593 /* Handle partial write of vec i */
2594 vec[i].iov_base = (char *) vec[i].iov_base +
2595 (vec[i].iov_len - (cnt - n));
2596 vec[i].iov_len = cnt -n;
2599 n = len - bytes_written;
2606 * Sends the contents of file fd along with header/trailer bytes, if any,
2607 * to the network. send_the_file will return only when all the bytes have been
2608 * sent (i.e., it handles partial writes) or on a network error condition.
2610 static apr_status_t send_the_file(conn_rec *c, apr_file_t *fd,
2611 apr_hdtr_t *hdtr, apr_off_t offset,
2612 apr_size_t length, apr_size_t *nbytes)
2614 apr_status_t rv = APR_SUCCESS;
2615 apr_int32_t togo; /* Remaining number of bytes in the file to send */
2616 apr_size_t sendlen = 0;
2617 apr_size_t bytes_sent;
2619 apr_off_t o; /* Track the file offset for partial writes */
2625 * writev_it_all handles partial writes.
2626 * XXX: optimization... if headers are less than MIN_WRITE_SIZE, copy
2629 if ( hdtr && hdtr->numheaders > 0 ) {
2630 for (i = 0; i < hdtr->numheaders; i++) {
2631 sendlen += hdtr->headers[i].iov_len;
2633 rv = writev_it_all(c->client->bsock, hdtr->headers, hdtr->numheaders,
2634 sendlen, &bytes_sent);
2635 if (rv == APR_SUCCESS)
2636 *nbytes += bytes_sent; /* track total bytes sent */
2639 /* Seek the file to 'offset' */
2640 if (offset != 0 && rv == APR_SUCCESS) {
2641 rv = apr_seek(fd, APR_SET, &offset);
2644 /* Send the file, making sure to handle partial writes */
2646 while (rv == APR_SUCCESS && togo) {
2647 sendlen = togo > sizeof(buffer) ? sizeof(buffer) : togo;
2649 rv = apr_read(fd, buffer, &sendlen);
2650 while (rv == APR_SUCCESS && sendlen) {
2651 bytes_sent = sendlen;
2652 rv = apr_send(c->client->bsock, &buffer[o], &bytes_sent);
2653 if (rv == APR_SUCCESS) {
2654 sendlen -= bytes_sent; /* sendlen != bytes_sent ==> partial write */
2655 o += bytes_sent; /* o is where we are in the buffer */
2656 *nbytes += bytes_sent;
2657 togo -= bytes_sent; /* track how much of the file we've sent */
2662 /* Send the trailers
2663 * XXX: optimization... if it will fit, send this on the last send in the
2667 if ( rv == APR_SUCCESS && hdtr && hdtr->numtrailers > 0 ) {
2668 for (i = 0; i < hdtr->numtrailers; i++) {
2669 sendlen += hdtr->trailers[i].iov_len;
2671 rv = writev_it_all(c->client->bsock, hdtr->trailers, hdtr->numtrailers,
2672 sendlen, &bytes_sent);
2673 if (rv == APR_SUCCESS)
2674 *nbytes += bytes_sent;
2680 /* Note --- ErrorDocument will now work from .htaccess files.
2681 * The AllowOverride of Fileinfo allows webmasters to turn it off
2684 static const command_rec core_cmds[] = {
2686 /* Old access config file commands */
2688 AP_INIT_RAW_ARGS("<Directory", dirsection, NULL, RSRC_CONF,
2689 "Container for directives affecting resources located in the specified "
2691 AP_INIT_RAW_ARGS("<Location", urlsection, NULL, RSRC_CONF,
2692 "Container for directives affecting resources accessed through the "
2693 "specified URL paths"),
2694 AP_INIT_RAW_ARGS("<VirtualHost", virtualhost_section, NULL, RSRC_CONF,
2695 "Container to map directives to a particular virtual host, takes one or "
2696 "more host addresses"),
2697 AP_INIT_RAW_ARGS("<Files", filesection, NULL, OR_ALL,
2698 "Container for directives affecting files matching specified patterns"),
2699 AP_INIT_RAW_ARGS("<Limit", ap_limit_section, NULL, OR_ALL,
2700 "Container for authentication directives when accessed using specified HTTP "
2702 AP_INIT_RAW_ARGS("<LimitExcept", ap_limit_section, (void*)1, OR_ALL,
2703 "Container for authentication directives to be applied when any HTTP "
2704 "method other than those specified is used to access the resource"),
2705 AP_INIT_TAKE1("<IfModule", start_ifmod, NULL, EXEC_ON_READ | OR_ALL,
2706 "Container for directives based on existance of specified modules"),
2707 AP_INIT_TAKE1("<IfDefine", start_ifdefine, NULL, EXEC_ON_READ | OR_ALL,
2708 "Container for directives based on existance of command line defines"),
2709 AP_INIT_RAW_ARGS("<DirectoryMatch", dirsection, (void*)1, RSRC_CONF,
2710 "Container for directives affecting resources located in the "
2711 "specified directories"),
2712 AP_INIT_RAW_ARGS("<LocationMatch", urlsection, (void*)1, RSRC_CONF,
2713 "Container for directives affecting resources accessed through the "
2714 "specified URL paths"),
2715 AP_INIT_RAW_ARGS("<FilesMatch", filesection, (void*)1, OR_ALL,
2716 "Container for directives affecting files matching specified patterns"),
2717 AP_INIT_TAKE1("AuthType", ap_set_string_slot,
2718 (void*)XtOffsetOf(core_dir_config, ap_auth_type), OR_AUTHCFG,
2719 "An HTTP authorization type (e.g., \"Basic\")"),
2720 AP_INIT_TAKE1("AuthName", set_authname, NULL, OR_AUTHCFG,
2721 "The authentication realm (e.g. \"Members Only\")"),
2722 AP_INIT_RAW_ARGS("Require", require, NULL, OR_AUTHCFG,
2723 "Selects which authenticated users or groups may access a protected space"),
2724 AP_INIT_TAKE1("Satisfy", satisfy, NULL, OR_AUTHCFG,
2725 "access policy if both allow and require used ('all' or 'any')"),
2727 AP_INIT_TAKE1("GprofDir", set_gprof_dir, NULL, RSRC_CONF,
2728 "Directory to plop gmon.out files"),
2730 AP_INIT_TAKE1("AddDefaultCharset", set_add_default_charset, NULL, OR_FILEINFO,
2731 "The name of the default charset to add to any Content-Type without one or 'Off' to disable"),
2733 /* Old resource config file commands */
2735 AP_INIT_RAW_ARGS("AccessFileName", set_access_name, NULL, RSRC_CONF,
2736 "Name(s) of per-directory config files (default: .htaccess)"),
2737 AP_INIT_TAKE1("DocumentRoot", set_document_root, NULL, RSRC_CONF,
2738 "Root directory of the document tree"),
2739 AP_INIT_TAKE2("ErrorDocument", set_error_document, NULL, OR_FILEINFO,
2740 "Change responses for HTTP errors"),
2741 AP_INIT_RAW_ARGS("AllowOverride", set_override, NULL, ACCESS_CONF,
2742 "Controls what groups of directives can be configured by per-directory "
2744 AP_INIT_RAW_ARGS("Options", set_options, NULL, OR_OPTIONS,
2745 "Set a number of attributes for a given directory"),
2746 AP_INIT_TAKE1("DefaultType", ap_set_string_slot,
2747 (void*)XtOffsetOf (core_dir_config, ap_default_type),
2748 OR_FILEINFO, "the default MIME type for untypable files"),
2750 /* Old server config file commands */
2752 AP_INIT_TAKE1("Port", server_port, NULL, RSRC_CONF, "A TCP port number"),
2753 AP_INIT_TAKE1("HostnameLookups", set_hostname_lookups, NULL,
2754 ACCESS_CONF|RSRC_CONF,
2755 "\"on\" to enable, \"off\" to disable reverse DNS lookups, or \"double\" to "
2756 "enable double-reverse DNS lookups"),
2757 AP_INIT_TAKE1("ServerAdmin", set_server_string_slot,
2758 (void *)XtOffsetOf (server_rec, server_admin), RSRC_CONF,
2759 "The email address of the server administrator"),
2760 AP_INIT_TAKE1("ServerName", set_server_string_slot,
2761 (void *)XtOffsetOf (server_rec, server_hostname), RSRC_CONF,
2762 "The hostname of the server"),
2763 AP_INIT_TAKE1("ServerSignature", set_signature_flag, NULL, OR_ALL,
2764 "En-/disable server signature (on|off|email)"),
2765 AP_INIT_TAKE1("ServerRoot", set_server_root, NULL, RSRC_CONF,
2766 "Common directory of server-related files (logs, confs, etc.)"),
2767 AP_INIT_TAKE1("ErrorLog", set_server_string_slot,
2768 (void *)XtOffsetOf (server_rec, error_fname), RSRC_CONF,
2769 "The filename of the error log"),
2770 AP_INIT_RAW_ARGS("ServerAlias", set_server_alias, NULL, RSRC_CONF,
2771 "A name or names alternately used to access the server"),
2772 AP_INIT_TAKE1("ServerPath", set_serverpath, NULL, RSRC_CONF,
2773 "The pathname the server can be reached at"),
2774 AP_INIT_TAKE1("Timeout", set_timeout, NULL, RSRC_CONF,
2775 "Timeout duration (sec)"),
2776 AP_INIT_TAKE1("KeepAliveTimeout", set_keep_alive_timeout, NULL, RSRC_CONF,
2777 "Keep-Alive timeout duration (sec)"),
2778 AP_INIT_TAKE1("MaxKeepAliveRequests", set_keep_alive_max, NULL, RSRC_CONF,
2779 "Maximum number of Keep-Alive requests per connection, or 0 for infinite"),
2780 AP_INIT_TAKE1("KeepAlive", set_keep_alive, NULL, RSRC_CONF,
2781 "Whether persistent connections should be On or Off"),
2782 AP_INIT_FLAG("IdentityCheck", set_idcheck, NULL, RSRC_CONF|ACCESS_CONF,
2783 "Enable identd (RFC 1413) user lookups - SLOW"),
2784 AP_INIT_FLAG("ContentDigest", set_content_md5, NULL, OR_OPTIONS,
2785 "whether or not to send a Content-MD5 header with each request"),
2786 AP_INIT_TAKE1("UseCanonicalName", set_use_canonical_name, NULL,
2787 RSRC_CONF|ACCESS_CONF,
2788 "How to work out the ServerName : Port when constructing URLs"),
2789 /* TODO: RlimitFoo should all be part of mod_cgi, not in the core */
2790 AP_INIT_ITERATE("AddModule", add_module_command, NULL,
2791 RSRC_CONF, "The name of a module"),
2792 AP_INIT_NO_ARGS("ClearModuleList", clear_module_list_command, NULL,
2794 /* TODO: ListenBacklog in MPM */
2795 AP_INIT_TAKE1("Include", include_config, NULL,
2796 (RSRC_CONF | ACCESS_CONF | EXEC_ON_READ),
2797 "Name of the config file to be included"),
2798 AP_INIT_TAKE1("LogLevel", set_loglevel, NULL, RSRC_CONF,
2799 "Level of verbosity in error logging"),
2800 AP_INIT_TAKE1("NameVirtualHost", ap_set_name_virtual_host, NULL, RSRC_CONF,
2801 "A numeric IP address:port, or the name of a host"),
2803 AP_INIT_TAKE1("BS2000Account", set_bs2000_account, NULL, RSRC_CONF,
2804 "Name of server User's bs2000 logon account name"),
2807 AP_INIT_TAKE1("ScriptInterpreterSource", set_interpreter_source, NULL,
2809 "Where to find interpreter to run Win32 scripts (Registry or script shebang line)"),
2811 AP_INIT_TAKE1("ServerTokens", set_serv_tokens, NULL, RSRC_CONF,
2812 "Determine tokens displayed in the Server: header - Min(imal), OS or Full"),
2813 AP_INIT_TAKE1("LimitRequestLine", set_limit_req_line, NULL, RSRC_CONF,
2814 "Limit on maximum size of an HTTP request line"),
2815 AP_INIT_TAKE1("LimitRequestFieldsize", set_limit_req_fieldsize, NULL,
2817 "Limit on maximum size of an HTTP request header field"),
2818 AP_INIT_TAKE1("LimitRequestFields", set_limit_req_fields, NULL, RSRC_CONF,
2819 "Limit (0 = unlimited) on max number of header fields in a request message"),
2820 AP_INIT_TAKE1("LimitRequestBody", set_limit_req_body,
2821 (void*)XtOffsetOf(core_dir_config, limit_req_body), OR_ALL,
2822 "Limit (in bytes) on maximum size of request message body"),
2823 AP_INIT_TAKE1("LimitXMLRequestBody", set_limit_xml_req_body, NULL, OR_ALL,
2824 "Limit (in bytes) on maximum size of an XML-based request "
2827 /* System Resource Controls */
2829 AP_INIT_TAKE12("RLimitCPU", set_limit_cpu,
2830 (void*)XtOffsetOf(core_dir_config, limit_cpu),
2831 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2833 AP_INIT_TAKE12("RLimitCPU", no_set_limit, NULL,
2834 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2836 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined (RLIMIT_AS)
2837 AP_INIT_TAKE12("RLimitMEM", set_limit_mem,
2838 (void*)XtOffsetOf(core_dir_config, limit_mem),
2839 OR_ALL, "Soft/hard limits for max memory usage per process"),
2841 AP_INIT_TAKE12("RLimitMEM", no_set_limit, NULL,
2842 OR_ALL, "Soft/hard limits for max memory usage per process"),
2845 AP_INIT_TAKE12("RLimitNPROC", set_limit_nproc,
2846 (void*)XtOffsetOf(core_dir_config, limit_nproc),
2847 OR_ALL, "soft/hard limits for max number of processes per uid"),
2849 AP_INIT_TAKE12("RLimitNPROC", no_set_limit, NULL,
2850 OR_ALL, "soft/hard limits for max number of processes per uid"),
2852 /* XXX These should be allowable in .htaccess files, but currently it won't
2853 * play well with the Options stuff. Until that is fixed, I would prefer
2854 * to leave it just in the conf file. Other should feel free to disagree
2857 AP_INIT_ITERATE("AddOutputFilter", add_filter, NULL, ACCESS_CONF,
2858 "filters to be run"),
2859 AP_INIT_ITERATE("AddInputFilter", add_input_filter, NULL, ACCESS_CONF,
2860 "filters to be run on the request body"),
2864 /*****************************************************************
2866 * Core handlers for various phases of server operation...
2869 AP_DECLARE_NONSTD(int) ap_core_translate(request_rec *r)
2871 void *sconf = r->server->module_config;
2872 core_server_config *conf = ap_get_module_config(sconf, &core_module);
2875 return HTTP_FORBIDDEN;
2877 if ((r->uri[0] != '/') && strcmp(r->uri, "*")) {
2878 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2879 "Invalid URI in request %s", r->the_request);
2880 return HTTP_BAD_REQUEST;
2884 && !strncmp(r->uri, r->server->path, r->server->pathlen)
2885 && (r->server->path[r->server->pathlen - 1] == '/'
2886 || r->uri[r->server->pathlen] == '/'
2887 || r->uri[r->server->pathlen] == '\0')) {
2888 r->filename = apr_pstrcat(r->pool, conf->ap_document_root,
2889 (r->uri + r->server->pathlen), NULL);
2893 * Make sure that we do not mess up the translation by adding two
2894 * /'s in a row. This happens under windows when the document
2895 * root ends with a /
2897 if ((conf->ap_document_root[strlen(conf->ap_document_root)-1] == '/')
2898 && (*(r->uri) == '/')) {
2899 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri+1,
2903 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri,
2911 static int do_nothing(request_rec *r) { return OK; }
2914 * Default handler for MIME types without other handlers. Only GET
2915 * and OPTIONS at this point... anyone who wants to write a generic
2916 * handler for PUT or POST is free to do so, but it seems unwise to provide
2917 * any defaults yet... So, for now, we assume that this will always be
2918 * the last handler called and return 405 or 501.
2921 static int default_handler(request_rec *r)
2923 core_dir_config *d =
2924 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
2925 int rangestatus, errstatus;
2926 apr_file_t *fd = NULL;
2927 apr_status_t status;
2928 #ifdef USE_MMAP_FILES
2929 apr_mmap_t *mm = NULL;
2931 /* XXX if/when somebody writes a content-md5 filter we either need to
2932 * remove this support or coordinate when to use the filter vs.
2933 * when to use this code
2934 * The current choice of when to compute the md5 here matches the 1.3
2935 * support fairly closely (unlike 1.3, we don't handle computing md5
2936 * when the charset is translated).
2938 int bld_content_md5 =
2939 (d->content_md5 & 1) && r->output_filters->frec->ftype != AP_FTYPE_CONTENT;
2941 /* This handler has no use for a request body (yet), but we still
2942 * need to read and discard it if the client sent one.
2944 if ((errstatus = ap_discard_request_body(r)) != OK) {
2948 ap_allow_methods(r, MERGE_ALLOW, "GET", "OPTIONS", NULL);
2950 if (r->method_number == M_INVALID) {
2951 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2952 "Invalid method in request %s", r->the_request);
2953 return HTTP_NOT_IMPLEMENTED;
2955 if (r->method_number == M_OPTIONS) {
2956 return ap_send_http_options(r);
2958 if (r->method_number == M_PUT) {
2959 return HTTP_METHOD_NOT_ALLOWED;
2961 if (r->finfo.protection == 0 || (r->path_info && *r->path_info)) {
2962 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, r,
2963 "File does not exist: %s",r->path_info ?
2964 apr_pstrcat(r->pool, r->filename, r->path_info, NULL)
2966 return HTTP_NOT_FOUND;
2968 if (r->method_number != M_GET) {
2969 return HTTP_METHOD_NOT_ALLOWED;
2972 if ((status = apr_open(&fd, r->filename, APR_READ | APR_BINARY, 0, r->pool)) != APR_SUCCESS) {
2973 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
2974 "file permissions deny server access: %s", r->filename);
2975 return HTTP_FORBIDDEN;
2977 ap_update_mtime(r, r->finfo.mtime);
2978 ap_set_last_modified(r);
2980 apr_table_setn(r->headers_out, "Accept-Ranges", "bytes");
2981 if (((errstatus = ap_meets_conditions(r)) != OK)
2982 || (errstatus = ap_set_content_length(r, r->finfo.size))) {
2987 #ifdef USE_MMAP_FILES
2988 if ((r->finfo.size >= MMAP_THRESHOLD)
2989 && (r->finfo.size < MMAP_LIMIT)
2990 && (!r->header_only || bld_content_md5)) {
2991 /* we need to protect ourselves in case we die while we've got the
2993 apr_status_t status;
2994 if ((status = apr_mmap_create(&mm, fd, 0, r->finfo.size, r->pool)) != APR_SUCCESS) {
2995 ap_log_rerror(APLOG_MARK, APLOG_CRIT, status, r,
2996 "default_handler: mmap failed: %s", r->filename);
3007 if (bld_content_md5) {
3009 apr_table_setn(r->headers_out, "Content-MD5",
3010 ap_md5digest(r->pool, fd, NULL));
3012 apr_table_setn(r->headers_out, "Content-MD5",
3013 ap_md5digest(r->pool, fd));
3014 #endif /* APACHE_XLATE */
3017 rangestatus = ap_set_byterange(r);
3019 ap_send_http_header(r);
3021 if (!r->header_only) {
3022 apr_size_t length = r->finfo.size;
3023 apr_off_t offset = 0;
3024 apr_size_t nbytes = 0;
3027 ap_send_fd(fd, r, offset, length, &nbytes);
3030 while (ap_each_byterange(r, &offset, &length)) {
3031 if ((status = ap_send_fd(fd, r, offset, length, &nbytes)) != APR_SUCCESS) {
3032 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
3033 "error byteserving file: %s", r->filename);
3034 return HTTP_INTERNAL_SERVER_ERROR;
3040 #ifdef USE_MMAP_FILES
3043 unsigned char *addr;
3044 apr_mmap_offset((void**)&addr, mm ,0);
3046 if (bld_content_md5) {
3047 apr_md5_ctx_t context;
3049 apr_MD5Init(&context);
3050 apr_MD5Update(&context, addr, (unsigned int)r->finfo.size);
3051 apr_table_setn(r->headers_out, "Content-MD5",
3052 ap_md5contextTo64(r->pool, &context));
3055 rangestatus = ap_set_byterange(r);
3056 ap_send_http_header(r);
3058 if (!r->header_only) {
3060 ap_send_mmap(mm, r, 0, r->finfo.size);
3065 while (ap_each_byterange(r, &offset, &length)) {
3066 ap_send_mmap(mm, r, offset, length);
3077 * This is a relatively simple filter to coalesce many small buckets into
3078 * one large bucket. This implementation of buffer_filter will only coalesce
3079 * a single contiguous string of coalesable buckets. It will not coalesce
3080 * multiple non-contiguous buckets.
3082 * For example, if a brigade contains 10 small buckets followed by a
3083 * large bucket (or a pipe or file bucket) followed by more small buckets,
3084 * only the first 10 buckets will be coalesced.
3086 typedef struct BUFFER_FILTER_CTX {
3087 char *buf; /* Start of buffer */
3088 char *cur; /* Pointer to next location to write */
3089 apr_ssize_t cnt; /* Number of bytes put in buf */
3090 apr_ssize_t avail; /* Number of bytes available in the buf */
3091 } buffer_filter_ctx_t;
3092 #define FILTER_BUFF_SIZE 8192
3093 #define MIN_BUCKET_SIZE 200
3094 static apr_status_t buffer_filter(ap_filter_t *f, ap_bucket_brigade *b)
3097 apr_pool_t *p = f->r->pool;
3098 ap_bucket *e, *insert_before = NULL, *destroy_me = NULL;
3099 buffer_filter_ctx_t *ctx = f->ctx;
3100 int pass_the_brigade = 0, insert_first = 0;
3103 f->ctx = ctx = apr_pcalloc(p, sizeof(buffer_filter_ctx_t));
3104 ctx->avail = FILTER_BUFF_SIZE;
3111 /* Iterate across the buckets, coalescing the small buckets into a
3114 AP_BRIGADE_FOREACH(e, b) {
3116 ap_bucket_destroy(destroy_me);
3119 if (AP_BUCKET_IS_EOS(e) || AP_BUCKET_IS_FILE(e) ||
3120 AP_BUCKET_IS_PIPE(e)) {
3121 pass_the_brigade = 1;
3126 rv = ap_bucket_read(e, &str, &n, 0);
3127 if (rv != APR_SUCCESS) {
3128 /* XXX: log error */
3131 if ((n < MIN_BUCKET_SIZE) && (n < ctx->avail)) {
3132 /* Coalesce this bucket into the buffer */
3133 if (ctx->buf == NULL) {
3134 ctx->buf = apr_palloc(p, FILTER_BUFF_SIZE);
3135 ctx->cur = ctx->buf;
3138 memcpy(ctx->cur, str, n);
3142 /* If this is the first bucket to be coalesced, don't remove it
3143 * from the brigade. Save it as a marker for where to insert
3144 * ctx->buf into the brigade when we're done.
3146 if (insert_before || insert_first){
3147 AP_BUCKET_REMOVE(e);
3154 else if (insert_before || insert_first) {
3155 /* This bucket was not able to be coalesced because it either
3156 * exceeds MIN_BUCKET_SIZE or its contents will not fit into
3157 * buf. We're done...
3159 pass_the_brigade = 1;
3163 /* If there is even a single bucket that cannot be coalesced,
3164 * then we must pass the brigade down to the next filter.
3166 pass_the_brigade = 1;
3172 ap_bucket_destroy(destroy_me);
3176 if (pass_the_brigade) {
3177 /* Insert ctx->buf into the correct spotin the brigade */
3179 e = ap_bucket_create_transient(ctx->buf, ctx->cnt);
3180 AP_BRIGADE_INSERT_HEAD(b, e);
3182 else if (insert_before) {
3183 e = ap_bucket_create_transient(ctx->buf, ctx->cnt);
3184 AP_BUCKET_INSERT_BEFORE(e, insert_before);
3185 AP_BUCKET_REMOVE(insert_before);
3186 ap_bucket_destroy(insert_before);
3187 insert_before = NULL;
3189 rv = ap_pass_brigade(f->next, b);
3190 if (rv != APR_SUCCESS) {
3191 /* XXX: Log the error */
3194 /* Get ctx->buf ready for the next brigade */
3196 ctx->cur = ctx->buf;
3198 ctx->avail = FILTER_BUFF_SIZE;
3202 if (insert_before) {
3203 AP_BUCKET_REMOVE(insert_before);
3204 ap_bucket_destroy(insert_before);
3206 /* The brigade should be empty now because all the buckets
3207 * were coalesced into the buffer_filter buf
3214 * HTTP/1.1 chunked transfer encoding filter.
3216 static apr_status_t chunk_filter(ap_filter_t *f, ap_bucket_brigade *b)
3218 ap_bucket_brigade *more = NULL;
3222 for (more = NULL; b; b = more, more = NULL) {
3223 apr_off_t bytes = 0;
3224 ap_bucket *eos = NULL;
3225 char chunk_hdr[20]; /* enough space for the snprintf below */
3227 AP_BRIGADE_FOREACH(e, b) {
3228 if (AP_BUCKET_IS_EOS(e)) {
3229 /* there shouldn't be anything after the eos */
3233 else if (e->length == -1) {
3234 /* unknown amount of data (e.g. a pipe) */
3238 rv = ap_bucket_read(e, &data, &len, 1);
3239 if (rv != APR_SUCCESS) {
3244 * There may be a new next bucket representing the
3245 * rest of the data stream on which a read() may
3246 * block so we pass down what we have so far.
3249 more = ap_brigade_split(b, AP_BUCKET_NEXT(e));
3253 /* If there was nothing in this bucket then we can
3254 * safely move on to the next one without pausing
3255 * to pass down what we have counted up so far.
3266 * XXX: if there aren't very many bytes at this point it may
3267 * be a good idea to set them aside and return for more,
3268 * unless we haven't finished counting this brigade yet.
3271 /* if there are content bytes, then wrap them in a chunk */
3276 * Insert the chunk header, specifying the number of bytes in
3279 /* XXX might be nice to have APR_OFF_T_FMT_HEX */
3280 hdr_len = apr_snprintf(chunk_hdr, sizeof(chunk_hdr),
3281 "%qx" CRLF, (apr_uint64_t)bytes);
3282 e = ap_bucket_create_transient(chunk_hdr, hdr_len);
3283 AP_BRIGADE_INSERT_HEAD(b, e);
3286 * Insert the end-of-chunk CRLF before the EOS bucket, or
3287 * appended to the brigade
3289 e = ap_bucket_create_immortal(CRLF, 2);
3291 AP_BUCKET_INSERT_BEFORE(eos, e);
3294 AP_BRIGADE_INSERT_TAIL(b, e);
3298 /* RFC 2616, Section 3.6.1
3300 * If there is an EOS bucket, then prefix it with:
3301 * 1) the last-chunk marker ("0" CRLF)
3303 * 3) the end-of-chunked body CRLF
3305 * If there is no EOS bucket, then do nothing.
3307 * XXX: it would be nice to combine this with the end-of-chunk
3308 * marker above, but this is a bit more straight-forward for
3312 /* XXX: (2) trailers ... does not yet exist */
3313 e = ap_bucket_create_immortal("0" CRLF /* <trailers> */ CRLF, 5);
3314 AP_BUCKET_INSERT_BEFORE(eos, e);
3317 /* pass the brigade to the next filter. */
3318 rv = ap_pass_brigade(f->next, b);
3319 if (rv != APR_SUCCESS || eos != NULL) {
3327 /* This function only understands a length of AP_GET_ANY_AMOUNT. It will
3328 * ignore length values and always return the entire brigade. This is
3329 * pretty safe to do, because we know there always needs to be an intervening
3330 * filter just above this that will only make requests for AP_GET_ANY_AMOUNT
3332 static int core_input_filter(ap_filter_t *f, ap_bucket_brigade *b, apr_ssize_t length)
3334 apr_socket_t *csock = NULL;
3337 if (!f->ctx) { /* If we haven't passed up the socket yet... */
3339 ap_bpop_socket(&csock, f->c->client);
3340 e = ap_bucket_create_socket(csock);
3341 AP_BRIGADE_INSERT_TAIL(b, e);
3345 /* Either some code lost track of the socket
3346 * bucket or we already found out that the
3353 /* Default filter. This filter should almost always be used. Its only job
3354 * is to send the headers if they haven't already been sent, and then send
3357 typedef struct CORE_OUTPUT_FILTER_CTX {
3358 ap_bucket_brigade *b;
3359 } core_output_filter_ctx_t;
3360 #define MAX_IOVEC_TO_WRITE 16
3361 static int core_output_filter(ap_filter_t *f, ap_bucket_brigade *b)
3364 ap_bucket_brigade *more = NULL;
3365 apr_ssize_t bytes_sent = 0, nbytes;
3368 core_output_filter_ctx_t *ctx = f->ctx;
3370 apr_ssize_t nvec = 0;
3371 apr_ssize_t nvec_trailers= 0;
3372 struct iovec vec[MAX_IOVEC_TO_WRITE];
3373 struct iovec vec_trailers[MAX_IOVEC_TO_WRITE];
3375 apr_file_t *fd = NULL;
3376 apr_ssize_t flen = 0;
3377 apr_off_t foffset = 0;
3380 f->ctx = ctx = apr_pcalloc(c->pool, sizeof(core_output_filter_ctx_t));
3382 /* If we have a saved brigade, concatenate the new brigade to it */
3384 AP_BRIGADE_CONCAT(ctx->b, b);
3389 /* Hijack any bytes in BUFF and prepend it to the brigade. */
3390 if (c->client->outcnt) {
3391 e = ap_bucket_create_heap(c->client->outbase,
3392 c->client->outcnt, 1, NULL);
3393 c->client->outcnt = 0;
3394 AP_BRIGADE_INSERT_HEAD(b, e);
3397 /* Iterate over the brigade collecting iovecs */
3399 nbytes = 0; /* in case more points to another brigade */
3401 AP_BRIGADE_FOREACH(e, b) {
3402 if (AP_BUCKET_IS_EOS(e)) {
3405 else if (AP_BUCKET_IS_FILE(e)) {
3406 ap_bucket_file *a = e->data;
3407 /* Assume there is at most one AP_BUCKET_FILE in the brigade */
3410 foffset = a->offset;
3415 rv = ap_bucket_read(e, &str, &n, 0);
3419 vec[nvec].iov_base = (char*) str;
3420 vec[nvec].iov_len = n;
3424 /* The bucket is a trailer to a file bucket */
3425 vec_trailers[nvec_trailers].iov_base = (char*) str;
3426 vec_trailers[nvec_trailers].iov_len = n;
3432 if ((nvec == MAX_IOVEC_TO_WRITE) || (nvec_trailers == MAX_IOVEC_TO_WRITE)) {
3433 /* Split the brigade and break */
3434 if (AP_BUCKET_NEXT(e) != AP_BRIGADE_SENTINEL(b)) {
3435 more = ap_brigade_split(b, AP_BUCKET_NEXT(e));
3441 /* Completed iterating over the brigades, now determine if we want to
3442 * buffer the brigade or send the brigade out on the network
3444 if (!fd && (!more) && (nbytes < MIN_SIZE_TO_WRITE) && !AP_BUCKET_IS_EOS(e)) {
3445 ap_save_brigade(f, &ctx->b, &b);
3450 #if APR_HAS_SENDFILE
3451 apr_int32_t flags = 0;
3454 memset(&hdtr, '\0', sizeof(hdtr));
3456 hdtr.numheaders = nvec;
3459 if (nvec_trailers) {
3460 hdtr.numtrailers = nvec_trailers;
3461 hdtr.trailers = vec_trailers;
3463 #if APR_HAS_SENDFILE
3464 if (!c->keepalive) {
3465 /* Prepare the socket to be reused */
3466 flags |= APR_SENDFILE_DISCONNECT_SOCKET;
3469 rv = apr_sendfile(c->client->bsock,
3470 fd, /* The file to send */
3471 &hdtr, /* Header and trailer iovecs */
3472 &foffset, /* Offset in file to begin sending from */
3475 bytes_sent = nbytes;
3477 /* If apr_sendfile() returns APR_ENOTIMPL, call send_the_file() to
3478 * loop on apr_read/apr_send to send the file. Our Windows binary
3479 * distributions (which work on Windows 9x/NT) are compiled on
3480 * Windows NT. TransmitFile is not available on Windows 95/98 and
3481 * we discover this at runtime when apr_sendfile() returns
3482 * APR_ENOTIMPL. Having apr_sendfile() return APR_ENOTIMPL seems
3483 * the cleanest way to handle this case.
3485 if (rv == APR_ENOTIMPL) {
3488 rv = send_the_file(c, fd, &hdtr, foffset, flen, &bytes_sent);
3490 #if APR_HAS_SENDFILE
3495 rv = writev_it_all(c->client->bsock,
3497 nbytes, &bytes_sent);
3500 ap_brigade_destroy(b);
3501 if (rv != APR_SUCCESS) {
3502 /* XXX: log the error */
3504 ap_brigade_destroy(more);
3511 } /* end while () */
3516 static const handler_rec core_handlers[] = {
3517 { "*/*", default_handler },
3518 { "default-handler", default_handler },
3522 static void core_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp)
3524 ap_init_bucket_types(pconf);
3527 static void core_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3529 ap_set_version(pconf);
3532 static void core_open_logs(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3534 ap_open_logs(s, pconf);
3537 static const char *core_method(const request_rec *r)
3540 static unsigned short core_port(const request_rec *r)
3541 { return DEFAULT_HTTP_PORT; }
3543 static void core_insert_filter(request_rec *r)
3546 core_dir_config *conf = (core_dir_config *)
3547 ap_get_module_config(r->per_dir_config,
3549 char **items = (char **)conf->filters->elts;
3551 for (i = 0; i < conf->filters->nelts; i++) {
3552 char *foobar = items[i];
3553 ap_add_output_filter(foobar, NULL, r, r->connection);
3556 items = (char **)conf->input_filters->elts;
3557 for (i = 0; i < conf->input_filters->nelts; i++) {
3558 char *foobar = items[i];
3559 ap_add_input_filter(foobar, NULL, r, r->connection);
3563 static void register_hooks(void)
3565 ap_hook_pre_config(core_pre_config, NULL, NULL, AP_HOOK_REALLY_FIRST);
3566 ap_hook_post_config(core_post_config,NULL,NULL,AP_HOOK_REALLY_FIRST);
3567 ap_hook_translate_name(ap_core_translate,NULL,NULL,AP_HOOK_REALLY_LAST);
3568 ap_hook_pre_connection(ap_pre_http_connection,NULL,NULL,
3569 AP_HOOK_REALLY_LAST);
3570 ap_hook_process_connection(ap_process_http_connection,NULL,NULL,
3571 AP_HOOK_REALLY_LAST);
3572 ap_hook_http_method(core_method,NULL,NULL,AP_HOOK_REALLY_LAST);
3573 ap_hook_default_port(core_port,NULL,NULL,AP_HOOK_REALLY_LAST);
3574 ap_hook_open_logs(core_open_logs,NULL,NULL,AP_HOOK_MIDDLE);
3575 /* FIXME: I suspect we can eliminate the need for these - Ben */
3576 ap_hook_type_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3577 ap_hook_access_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3579 /* register the core's insert_filter hook and register core-provided
3582 ap_hook_insert_filter(core_insert_filter, NULL, NULL, AP_HOOK_MIDDLE);
3583 ap_register_input_filter("HTTP_IN", http_filter, AP_FTYPE_CONNECTION);
3584 ap_register_input_filter("DECHUNK", dechunk_filter, AP_FTYPE_CONNECTION + 1);
3585 ap_register_input_filter("CORE_IN", core_input_filter, AP_FTYPE_CONNECTION);
3586 ap_register_output_filter("CORE", core_output_filter, AP_FTYPE_CONNECTION + 1);
3587 ap_register_output_filter("SUBREQ_CORE", ap_sub_req_output_filter,
3589 ap_register_output_filter("CHUNK", chunk_filter, AP_FTYPE_CONNECTION);
3590 ap_register_output_filter("BUFFER", buffer_filter, AP_FTYPE_CONNECTION);
3593 AP_DECLARE_DATA module core_module = {
3594 STANDARD20_MODULE_STUFF,
3595 create_core_dir_config, /* create per-directory config structure */
3596 merge_core_dir_configs, /* merge per-directory config structures */
3597 create_core_server_config, /* create per-server config structure */
3598 merge_core_server_configs, /* merge per-server config structures */
3599 core_cmds, /* command apr_table_t */
3600 core_handlers, /* handlers */
3601 register_hooks /* register hooks */