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 */
97 #ifdef AP_USE_MMAP_FILES
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 /* AP_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->output_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->output_filters = apr_append_arrays(a, base->output_filters,
331 new->output_filters);
332 conf->input_filters = apr_append_arrays(a, base->input_filters,
338 static void *create_core_server_config(apr_pool_t *a, server_rec *s)
340 core_server_config *conf;
341 int is_virtual = s->is_virtual;
343 conf = (core_server_config *)apr_pcalloc(a, sizeof(core_server_config));
345 conf->gprof_dir = NULL;
347 conf->access_name = is_virtual ? NULL : DEFAULT_ACCESS_FNAME;
348 conf->ap_document_root = is_virtual ? NULL : DOCUMENT_LOCATION;
349 conf->sec = apr_make_array(a, 40, sizeof(void *));
350 conf->sec_url = apr_make_array(a, 40, sizeof(void *));
355 static void *merge_core_server_configs(apr_pool_t *p, void *basev, void *virtv)
357 core_server_config *base = (core_server_config *)basev;
358 core_server_config *virt = (core_server_config *)virtv;
359 core_server_config *conf;
361 conf = (core_server_config *)apr_pcalloc(p, sizeof(core_server_config));
363 if (!conf->access_name) {
364 conf->access_name = base->access_name;
366 if (!conf->ap_document_root) {
367 conf->ap_document_root = base->ap_document_root;
369 conf->sec = apr_append_arrays(p, base->sec, virt->sec);
370 conf->sec_url = apr_append_arrays(p, base->sec_url, virt->sec_url);
375 /* Add per-directory configuration entry (for <directory> section);
376 * these are part of the core server config.
379 AP_CORE_DECLARE(void) ap_add_per_dir_conf(server_rec *s, void *dir_config)
381 core_server_config *sconf = ap_get_module_config(s->module_config,
383 void **new_space = (void **)apr_push_array(sconf->sec);
385 *new_space = dir_config;
388 AP_CORE_DECLARE(void) ap_add_per_url_conf(server_rec *s, void *url_config)
390 core_server_config *sconf = ap_get_module_config(s->module_config,
392 void **new_space = (void **)apr_push_array(sconf->sec_url);
394 *new_space = url_config;
397 AP_CORE_DECLARE(void) ap_add_file_conf(core_dir_config *conf, void *url_config)
399 void **new_space = (void **)apr_push_array(conf->sec);
401 *new_space = url_config;
404 /* core_reorder_directories reorders the directory sections such that the
405 * 1-component sections come first, then the 2-component, and so on, finally
406 * followed by the "special" sections. A section is "special" if it's a regex,
407 * or if it doesn't start with / -- consider proxy: matching. All movements
408 * are in-order to preserve the ordering of the sections from the config files.
409 * See directory_walk().
412 #if defined(HAVE_DRIVE_LETTERS)
413 #define IS_SPECIAL(entry_core) \
414 ((entry_core)->r != NULL \
415 || ((entry_core)->d[0] != '/' && (entry_core)->d[1] != ':'))
416 #elif defined(NETWARE)
417 /* XXX: Fairly certain this is correct... '/' must prefix the path
418 * or else in the case xyz:/ or abc/xyz:/, '/' must follow the ':'.
419 * If there is no leading '/' or embedded ':/', then we are special.
421 #define IS_SPECIAL(entry_core) \
422 ((entry_core)->r != NULL \
423 || ((entry_core)->d[0] != '/' \
424 && strchr((entry_core)->d, ':') \
425 && *(strchr((entry_core)->d, ':') + 1) != '/'))
427 #define IS_SPECIAL(entry_core) \
428 ((entry_core)->r != NULL || (entry_core)->d[0] != '/')
431 /* We need to do a stable sort, qsort isn't stable. So to make it stable
432 * we'll be maintaining the original index into the list, and using it
433 * as the minor key during sorting. The major key is the number of
434 * components (where a "special" section has infinite components).
436 struct reorder_sort_rec {
441 static int reorder_sorter(const void *va, const void *vb)
443 const struct reorder_sort_rec *a = va;
444 const struct reorder_sort_rec *b = vb;
445 core_dir_config *core_a;
446 core_dir_config *core_b;
448 core_a = (core_dir_config *)ap_get_module_config(a->elt, &core_module);
449 core_b = (core_dir_config *)ap_get_module_config(b->elt, &core_module);
450 if (IS_SPECIAL(core_a)) {
451 if (!IS_SPECIAL(core_b)) {
455 else if (IS_SPECIAL(core_b)) {
459 /* we know they're both not special */
460 if (core_a->d_components < core_b->d_components) {
463 else if (core_a->d_components > core_b->d_components) {
467 /* Either they're both special, or they're both not special and have the
468 * same number of components. In any event, we now have to compare
470 return a->orig_index - b->orig_index;
473 void ap_core_reorder_directories(apr_pool_t *p, server_rec *s)
475 core_server_config *sconf;
476 apr_array_header_t *sec;
477 struct reorder_sort_rec *sortbin;
483 sconf = ap_get_module_config(s->module_config, &core_module);
486 elts = (void **)sec->elts;
488 /* we have to allocate tmp space to do a stable sort */
489 apr_create_pool(&tmp, p);
490 sortbin = apr_palloc(tmp, sec->nelts * sizeof(*sortbin));
491 for (i = 0; i < nelts; ++i) {
492 sortbin[i].orig_index = i;
493 sortbin[i].elt = elts[i];
496 qsort(sortbin, nelts, sizeof(*sortbin), reorder_sorter);
498 /* and now copy back to the original array */
499 for (i = 0; i < nelts; ++i) {
500 elts[i] = sortbin[i].elt;
503 apr_destroy_pool(tmp);
506 /*****************************************************************
508 * There are some elements of the core config structures in which
509 * other modules have a legitimate interest (this is ugly, but necessary
510 * to preserve NCSA back-compatibility). So, we have a bunch of accessors
514 AP_DECLARE(int) ap_allow_options(request_rec *r)
516 core_dir_config *conf =
517 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
522 AP_DECLARE(int) ap_allow_overrides(request_rec *r)
524 core_dir_config *conf;
525 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
528 return conf->override;
531 AP_DECLARE(const char *) ap_auth_type(request_rec *r)
533 core_dir_config *conf;
535 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
537 return conf->ap_auth_type;
540 AP_DECLARE(const char *) ap_auth_name(request_rec *r)
542 core_dir_config *conf;
544 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
546 return conf->ap_auth_name;
549 AP_DECLARE(const char *) ap_default_type(request_rec *r)
551 core_dir_config *conf;
553 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
555 return conf->ap_default_type
556 ? conf->ap_default_type
557 : DEFAULT_CONTENT_TYPE;
560 AP_DECLARE(const char *) ap_document_root(request_rec *r) /* Don't use this! */
562 core_server_config *conf;
564 conf = (core_server_config *)ap_get_module_config(r->server->module_config,
566 return conf->ap_document_root;
569 AP_DECLARE(const apr_array_header_t *) ap_requires(request_rec *r)
571 core_dir_config *conf;
573 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
575 return conf->ap_requires;
578 AP_DECLARE(int) ap_satisfies(request_rec *r)
580 core_dir_config *conf;
582 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
585 return conf->satisfy;
588 /* Should probably just get rid of this... the only code that cares is
589 * part of the core anyway (and in fact, it isn't publicised to other
593 char *ap_response_code_string(request_rec *r, int error_index)
595 core_dir_config *conf;
597 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
600 if (conf->response_code_strings == NULL) {
603 return conf->response_code_strings[error_index];
607 /* Code from Harald Hanche-Olsen <hanche@imf.unit.no> */
608 static apr_inline void do_double_reverse (conn_rec *conn)
610 struct hostent *hptr;
612 if (conn->double_reverse) {
616 if (conn->remote_host == NULL || conn->remote_host[0] == '\0') {
617 /* single reverse failed, so don't bother */
618 conn->double_reverse = -1;
621 hptr = gethostbyname(conn->remote_host);
625 for (haddr = hptr->h_addr_list; *haddr; haddr++) {
626 if (((struct in_addr *)(*haddr))->s_addr
627 == conn->remote_addr.sin_addr.s_addr) {
628 conn->double_reverse = 1;
633 conn->double_reverse = -1;
636 AP_DECLARE(const char *) ap_get_remote_host(conn_rec *conn, void *dir_config,
639 struct in_addr *iaddr;
640 struct hostent *hptr;
641 int hostname_lookups;
643 /* If we haven't checked the host name, and we want to */
646 ((core_dir_config *)ap_get_module_config(dir_config, &core_module))
648 if (hostname_lookups == HOSTNAME_LOOKUP_UNSET) {
649 hostname_lookups = HOSTNAME_LOOKUP_OFF;
654 hostname_lookups = HOSTNAME_LOOKUP_OFF;
657 if (type != REMOTE_NOLOOKUP
658 && conn->remote_host == NULL
659 && (type == REMOTE_DOUBLE_REV
660 || hostname_lookups != HOSTNAME_LOOKUP_OFF)) {
661 iaddr = &(conn->remote_addr.sin_addr);
662 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr), AF_INET);
664 conn->remote_host = apr_pstrdup(conn->pool, (void *)hptr->h_name);
665 ap_str_tolower(conn->remote_host);
667 if (hostname_lookups == HOSTNAME_LOOKUP_DOUBLE) {
668 do_double_reverse(conn);
669 if (conn->double_reverse != 1) {
670 conn->remote_host = NULL;
674 /* if failed, set it to the NULL string to indicate error */
675 if (conn->remote_host == NULL) {
676 conn->remote_host = "";
679 if (type == REMOTE_DOUBLE_REV) {
680 do_double_reverse(conn);
681 if (conn->double_reverse == -1) {
687 * Return the desired information; either the remote DNS name, if found,
688 * or either NULL (if the hostname was requested) or the IP address
689 * (if any identifier was requested).
691 if (conn->remote_host != NULL && conn->remote_host[0] != '\0') {
692 return conn->remote_host;
695 if (type == REMOTE_HOST || type == REMOTE_DOUBLE_REV) {
699 return conn->remote_ip;
704 AP_DECLARE(const char *) ap_get_remote_logname(request_rec *r)
706 core_dir_config *dir_conf;
708 if (r->connection->remote_logname != NULL) {
709 return r->connection->remote_logname;
712 /* If we haven't checked the identity, and we want to */
713 dir_conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
716 if (dir_conf->do_rfc1413 & 1) {
717 return ap_rfc1413(r->connection, r->server);
724 /* There are two options regarding what the "name" of a server is. The
725 * "canonical" name as defined by ServerName and Port, or the "client's
726 * name" as supplied by a possible Host: header or full URI. We never
727 * trust the port passed in the client's headers, we always use the
728 * port of the actual socket.
730 * The DNS option to UseCanonicalName causes this routine to do a
731 * reverse lookup on the local IP address of the connectiona and use
732 * that for the ServerName. This makes its value more reliable while
733 * at the same time allowing Demon's magic virtual hosting to work.
734 * The assumption is that DNS lookups are sufficiently quick...
737 AP_DECLARE(const char *) ap_get_server_name(request_rec *r)
739 conn_rec *conn = r->connection;
742 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
745 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF) {
746 return r->hostname ? r->hostname : r->server->server_hostname;
748 if (d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
749 if (conn->local_host == NULL) {
750 struct in_addr *iaddr;
751 struct hostent *hptr;
752 iaddr = &(conn->local_addr.sin_addr);
753 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr),
756 conn->local_host = apr_pstrdup(conn->pool,
757 (void *)hptr->h_name);
758 ap_str_tolower(conn->local_host);
761 conn->local_host = apr_pstrdup(conn->pool,
762 r->server->server_hostname);
765 return conn->local_host;
768 return r->server->server_hostname;
771 AP_DECLARE(unsigned) ap_get_server_port(const request_rec *r)
775 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
777 port = r->server->port ? r->server->port : ap_default_port(r);
779 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF
780 || d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
781 return r->hostname ? ntohs(r->connection->local_addr.sin_port)
788 AP_DECLARE(char *) ap_construct_url(apr_pool_t *p, const char *uri,
791 unsigned port = ap_get_server_port(r);
792 const char *host = ap_get_server_name(r);
794 if (ap_is_default_port(port, r)) {
795 return apr_pstrcat(p, ap_http_method(r), "://", host, uri, NULL);
797 return apr_psprintf(p, "%s://%s:%u%s", ap_http_method(r), host, port, uri);
800 AP_DECLARE(unsigned long) ap_get_limit_req_body(const request_rec *r)
803 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
805 return d->limit_req_body;
809 static apr_status_t get_win32_registry_default_value(apr_pool_t *p, HKEY hkey,
816 DWORD result = RegOpenKeyEx(hkey, relativepath, 0,
817 KEY_QUERY_VALUE, &hkeyOpen);
819 if (result != ERROR_SUCCESS)
820 return APR_FROM_OS_ERROR(result);
822 /* Read to NULL buffer to determine value size */
823 result = RegQueryValueEx(hkeyOpen, "", 0, &type, NULL, &size);
825 if (result == ERROR_SUCCESS) {
826 if ((size < 2) || (type != REG_SZ && type != REG_EXPAND_SZ)) {
827 result = ERROR_INVALID_PARAMETER;
830 *value = apr_palloc(p, size);
831 /* Read value based on size query above */
832 result = RegQueryValueEx(hkeyOpen, "", 0, &type, *value, &size);
836 /* TODO: This might look fine, but we need to provide some warning
837 * somewhere that some environment variables may -not- be translated,
838 * seeing as we may have chopped the environment table down somewhat.
840 if ((result == ERROR_SUCCESS) && (type == REG_EXPAND_SZ))
843 size = ExpandEnvironmentStrings(tmp, *value, 0);
845 *value = apr_palloc(p, size);
846 size = ExpandEnvironmentStrings(tmp, *value, size);
850 RegCloseKey(hkeyOpen);
851 return APR_FROM_OS_ERROR(result);
854 static char* get_interpreter_from_win32_registry(apr_pool_t *p, const char* ext,
855 char** arguments, int strict)
857 char execcgi_path[] = "SHELL\\EXECCGI\\COMMAND";
858 char execopen_path[] = "SHELL\\OPEN\\COMMAND";
859 char typeName[MAX_PATH];
860 int cmdOfName = FALSE;
872 * Future optimization:
873 * When the registry is successfully searched, store the strings for
874 * interpreter and arguments in an ext hash to speed up subsequent look-ups
877 /* Open the key associated with the script filetype extension */
878 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, ext, 0, KEY_QUERY_VALUE,
881 if (result != ERROR_SUCCESS)
884 /* Retrieve the name of the script filetype extension */
885 size = sizeof(typeName);
886 result = RegQueryValueEx(hkeyType, "", NULL, &type, typeName, &size);
888 if (result == ERROR_SUCCESS && type == REG_SZ && typeName[0]) {
889 /* Open the key associated with the script filetype extension */
890 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, typeName, 0,
891 KEY_QUERY_VALUE, &hkeyName);
893 if (result == ERROR_SUCCESS)
897 /* Open the key for the script command path by:
899 * 1) the 'named' filetype key for ExecCGI/Command
900 * 2) the extension's type key for ExecCGI/Command
902 * and if the strict arg is false, then continue trying:
904 * 3) the 'named' filetype key for Open/Command
905 * 4) the extension's type key for Open/Command
909 result = get_win32_registry_default_value(p, hkeyName,
910 execcgi_path, &buffer);
913 if (!cmdOfName || (result != ERROR_SUCCESS)) {
914 result = get_win32_registry_default_value(p, hkeyType,
915 execcgi_path, &buffer);
918 if (!strict && cmdOfName && (result != ERROR_SUCCESS)) {
919 result = get_win32_registry_default_value(p, hkeyName,
920 execopen_path, &buffer);
923 if (!strict && (result != ERROR_SUCCESS)) {
924 result = get_win32_registry_default_value(p, hkeyType,
925 execopen_path, &buffer);
929 RegCloseKey(hkeyName);
931 RegCloseKey(hkeyType);
933 if (result != ERROR_SUCCESS)
937 * The canonical way shell command entries are entered in the Win32
938 * registry is as follows:
939 * shell [options] "%1" [args]
941 * shell - full path name to interpreter or shell to run.
942 * E.g., c:\usr\local\ntreskit\perl\bin\perl.exe
943 * options - optional switches
945 * "%1" - Place holder for file to run the shell against.
947 * options - additional arguments
950 * If we find a %1 or a quoted %1, lop off the remainder to arguments.
952 if (buffer && *buffer) {
953 if ((s = strstr(buffer, "\"%1")))
958 else if ((s = strstr(buffer, "%1")))
961 *arguments = buffer + 2;
964 *arguments = strchr(buffer, '\0');
965 while (**arguments && isspace(**arguments))
972 AP_DECLARE (file_type_e) ap_get_win32_interpreter(const request_rec *r,
982 file_type_e fileType = eFileTypeUNKNOWN;
984 char *exename = NULL;
986 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
989 /* Find the file extension */
990 exename = strrchr(r->filename, '/');
992 exename = strrchr(r->filename, '\\');
995 exename = r->filename;
1000 ext = strrchr(exename, '.');
1002 if (ext && (!strcasecmp(ext,".bat") || !strcasecmp(ext,".cmd")))
1004 char *comspec = getenv("COMSPEC");
1006 *interpreter = apr_pstrcat(r->pool, "\"", comspec, "\" /c ", NULL);
1007 return eFileTypeSCRIPT;
1009 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1010 "Failed to start a '%s' file as a script." APR_EOL_STR
1011 "\tCOMSPEC variable is missing from the environment.", ext);
1012 return eFileTypeUNKNOWN;
1015 /* If the file has an extension and it is not .com and not .exe and
1016 * we've been instructed to search the registry, then do it!
1018 if (ext && strcasecmp(ext,".exe") && strcasecmp(ext,".com") &&
1019 (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY ||
1020 d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT)) {
1021 /* Check the registry */
1022 int strict = (d->script_interpreter_source
1023 == INTERPRETER_SOURCE_REGISTRY_STRICT);
1024 *interpreter = get_interpreter_from_win32_registry(r->pool, ext,
1027 return eFileTypeSCRIPT;
1028 else if (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT) {
1029 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1030 "ScriptInterpreterSource config directive set to \"registry-strict\"." APR_EOL_STR
1031 "\tInterpreter not found for files of type '%s'.", ext);
1032 return eFileTypeUNKNOWN;
1036 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1037 "ScriptInterpreterSource config directive set to \"registry\"." APR_EOL_STR
1038 "\tInterpreter not found for files of type '%s', "
1039 "trying \"script\" method...", ext);
1043 /* Need to peek into the file figure out what it really is... */
1044 hFile = CreateFile(r->filename, GENERIC_READ, FILE_SHARE_READ, NULL,
1045 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
1046 if (hFile == INVALID_HANDLE_VALUE) {
1047 return eFileTypeUNKNOWN;
1049 bResult = ReadFile(hFile, (void*) &buffer, sizeof(buffer) - 1,
1051 if (!bResult || (nBytesRead == 0)) {
1052 ap_log_rerror(APLOG_MARK, APLOG_ERR, GetLastError(), r,
1053 "ReadFile(%s) failed", r->filename);
1055 return eFileTypeUNKNOWN;
1058 buffer[nBytesRead] = '\0';
1060 /* Script or executable, that is the question... */
1061 if ((buffer[0] == '#') && (buffer[1] == '!')) {
1062 /* Assuming file is a script since it starts with a shebang */
1063 fileType = eFileTypeSCRIPT;
1064 for (i = 2; i < sizeof(buffer); i++) {
1065 if ((buffer[i] == '\r')
1066 || (buffer[i] == '\n')) {
1071 for (i = 2; buffer[i] == ' ' ; ++i)
1073 *interpreter = apr_pstrdup(r->pool, buffer + i );
1076 /* Not a script, is it an executable? */
1077 IMAGE_DOS_HEADER *hdr = (IMAGE_DOS_HEADER*)buffer;
1078 if ((nBytesRead >= sizeof(IMAGE_DOS_HEADER)) && (hdr->e_magic == IMAGE_DOS_SIGNATURE)) {
1079 if (hdr->e_lfarlc < 0x40)
1080 fileType = eFileTypeEXE16;
1082 fileType = eFileTypeEXE32;
1085 fileType = eFileTypeUNKNOWN;
1092 /*****************************************************************
1094 * Commands... this module handles almost all of the NCSA httpd.conf
1095 * commands, but most of the old srm.conf is in the the modules.
1099 /* returns a parent if it matches the given directive */
1100 static const ap_directive_t * find_parent(const ap_directive_t *dirp,
1103 while (dirp->parent != NULL) {
1104 dirp = dirp->parent;
1105 /* ### it would be nice to have atom-ized directives */
1106 if (strcasecmp(dirp->directive, what) == 0)
1112 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd,
1115 const char *gt = (cmd->cmd->name[0] == '<'
1116 && cmd->cmd->name[strlen(cmd->cmd->name)-1] != '>')
1118 const ap_directive_t *found;
1120 if ((forbidden & NOT_IN_VIRTUALHOST) && cmd->server->is_virtual) {
1121 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1122 " cannot occur within <VirtualHost> section", NULL);
1125 if ((forbidden & NOT_IN_LIMIT) && cmd->limited != -1) {
1126 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1127 " cannot occur within <Limit> section", NULL);
1130 if ((forbidden & NOT_IN_DIR_LOC_FILE) == NOT_IN_DIR_LOC_FILE
1131 && cmd->path != NULL) {
1132 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1133 " cannot occur within <Directory/Location/Files> "
1137 if (((forbidden & NOT_IN_DIRECTORY)
1138 && ((found = find_parent(cmd->directive, "<Directory"))
1139 || (found = find_parent(cmd->directive, "<DirectoryMatch"))))
1140 || ((forbidden & NOT_IN_LOCATION)
1141 && ((found = find_parent(cmd->directive, "<Location"))
1142 || (found = find_parent(cmd->directive, "<LocationMatch"))))
1143 || ((forbidden & NOT_IN_FILES)
1144 && ((found = find_parent(cmd->directive, "<Files"))
1145 || (found = find_parent(cmd->directive, "<FilesMatch"))))) {
1146 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1147 " cannot occur within ", found->directive,
1154 static const char *set_access_name(cmd_parms *cmd, void *dummy,
1157 void *sconf = cmd->server->module_config;
1158 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1160 const char *err = ap_check_cmd_context(cmd,
1161 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1166 conf->access_name = apr_pstrdup(cmd->pool, arg);
1171 static const char *set_gprof_dir(cmd_parms *cmd, void *dummy, char *arg)
1173 void *sconf = cmd->server->module_config;
1174 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1176 const char *err = ap_check_cmd_context(cmd,
1177 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1182 conf->gprof_dir = apr_pstrdup(cmd->pool, arg);
1187 static const char *set_add_default_charset(cmd_parms *cmd,
1188 void *d_, const char *arg)
1190 core_dir_config *d=d_;
1192 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1196 if (!strcasecmp(arg, "Off")) {
1197 d->add_default_charset = ADD_DEFAULT_CHARSET_OFF;
1199 else if (!strcasecmp(arg, "On")) {
1200 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1201 d->add_default_charset_name = DEFAULT_ADD_DEFAULT_CHARSET_NAME;
1204 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1205 d->add_default_charset_name = arg;
1210 static const char *set_document_root(cmd_parms *cmd, void *dummy,
1213 void *sconf = cmd->server->module_config;
1214 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1216 const char *err = ap_check_cmd_context(cmd,
1217 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1222 arg = ap_os_canonical_filename(cmd->pool, arg);
1223 if (/* TODO: ap_configtestonly && ap_docrootcheck && */ !ap_is_directory(arg)) {
1224 if (cmd->server->is_virtual) {
1225 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1226 "Warning: DocumentRoot [%s] does not exist",
1230 return "DocumentRoot must be a directory";
1234 conf->ap_document_root = arg;
1238 AP_DECLARE(void) ap_custom_response(request_rec *r, int status, char *string)
1240 core_dir_config *conf =
1241 ap_get_module_config(r->per_dir_config, &core_module);
1244 if(conf->response_code_strings == NULL) {
1245 conf->response_code_strings =
1246 apr_pcalloc(r->pool,
1247 sizeof(*conf->response_code_strings) *
1251 idx = ap_index_of_response(status);
1253 conf->response_code_strings[idx] =
1254 ((ap_is_url(string) || (*string == '/')) && (*string != '"')) ?
1255 apr_pstrdup(r->pool, string) : apr_pstrcat(r->pool, "\"", string, NULL);
1258 static const char *set_error_document(cmd_parms *cmd, void *conf_,
1259 const char *errno_str, const char *msg)
1261 core_dir_config *conf=conf_;
1262 int error_number, index_number, idx500;
1263 enum { MSG, LOCAL_PATH, REMOTE_PATH } what = MSG;
1265 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1270 /* 1st parameter should be a 3 digit number, which we recognize;
1271 * convert it into an array index
1273 error_number = atoi(errno_str);
1274 idx500 = ap_index_of_response(HTTP_INTERNAL_SERVER_ERROR);
1276 if (error_number == HTTP_INTERNAL_SERVER_ERROR) {
1277 index_number = idx500;
1279 else if ((index_number = ap_index_of_response(error_number)) == idx500) {
1280 return apr_pstrcat(cmd->pool, "Unsupported HTTP response code ",
1284 /* Heuristic to determine second argument. */
1285 if (ap_strchr_c(msg,' '))
1287 else if (msg[0] == '/')
1289 else if (ap_is_url(msg))
1294 /* The entry should be ignored if it is a full URL for a 401 error */
1296 if (error_number == 401 && what == REMOTE_PATH) {
1297 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, cmd->server,
1298 "cannot use a full URL in a 401 ErrorDocument "
1299 "directive --- ignoring!");
1301 else { /* Store it... */
1302 if (conf->response_code_strings == NULL) {
1303 conf->response_code_strings =
1304 apr_pcalloc(cmd->pool,
1305 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
1307 /* hack. Prefix a " if it is a msg; as that is what
1308 * http_protocol.c relies on to distinguish between
1309 * a msg and a (local) path.
1311 conf->response_code_strings[index_number] = (what == MSG) ?
1312 apr_pstrcat(cmd->pool, "\"",msg,NULL) :
1313 apr_pstrdup(cmd->pool, msg);
1319 static const char *set_override(cmd_parms *cmd, void *d_, const char *l)
1321 core_dir_config *d=d_;
1324 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1329 d->override = OR_NONE;
1331 w = ap_getword_conf(cmd->pool, &l);
1332 if (!strcasecmp(w, "Limit")) {
1333 d->override |= OR_LIMIT;
1335 else if (!strcasecmp(w, "Options")) {
1336 d->override |= OR_OPTIONS;
1338 else if (!strcasecmp(w, "FileInfo")) {
1339 d->override |= OR_FILEINFO;
1341 else if (!strcasecmp(w, "AuthConfig")) {
1342 d->override |= OR_AUTHCFG;
1344 else if (!strcasecmp(w, "Indexes")) {
1345 d->override |= OR_INDEXES;
1347 else if (!strcasecmp(w, "None")) {
1348 d->override = OR_NONE;
1350 else if (!strcasecmp(w, "All")) {
1351 d->override = OR_ALL;
1354 return apr_pstrcat(cmd->pool, "Illegal override option ", w, NULL);
1356 d->override &= ~OR_UNSET;
1362 static const char *set_options(cmd_parms *cmd, void *d_, const char *l)
1364 core_dir_config *d=d_;
1365 allow_options_t opt;
1370 char *w = ap_getword_conf(cmd->pool, &l);
1373 if (*w == '+' || *w == '-') {
1381 if (!strcasecmp(w, "Indexes")) {
1384 else if (!strcasecmp(w, "Includes")) {
1387 else if (!strcasecmp(w, "IncludesNOEXEC")) {
1388 opt = (OPT_INCLUDES | OPT_INCNOEXEC);
1390 else if (!strcasecmp(w, "FollowSymLinks")) {
1391 opt = OPT_SYM_LINKS;
1393 else if (!strcasecmp(w, "SymLinksIfOwnerMatch")) {
1394 opt = OPT_SYM_OWNER;
1396 else if (!strcasecmp(w, "execCGI")) {
1399 else if (!strcasecmp(w, "MultiViews")) {
1402 else if (!strcasecmp(w, "RunScripts")) { /* AI backcompat. Yuck */
1403 opt = OPT_MULTI|OPT_EXECCGI;
1405 else if (!strcasecmp(w, "None")) {
1408 else if (!strcasecmp(w, "All")) {
1412 return apr_pstrcat(cmd->pool, "Illegal option ", w, NULL);
1415 /* we ensure the invariant (d->opts_add & d->opts_remove) == 0 */
1416 if (action == '-') {
1417 d->opts_remove |= opt;
1418 d->opts_add &= ~opt;
1421 else if (action == '+') {
1423 d->opts_remove &= ~opt;
1434 static const char *satisfy(cmd_parms *cmd, void *c_, const char *arg)
1436 core_dir_config *c=c_;
1438 if (!strcasecmp(arg, "all")) {
1439 c->satisfy = SATISFY_ALL;
1441 else if (!strcasecmp(arg, "any")) {
1442 c->satisfy = SATISFY_ANY;
1445 return "Satisfy either 'any' or 'all'.";
1450 static const char *require(cmd_parms *cmd, void *c_, const char *arg)
1453 core_dir_config *c=c_;
1455 if (!c->ap_requires) {
1456 c->ap_requires = apr_make_array(cmd->pool, 2, sizeof(require_line));
1458 r = (require_line *)apr_push_array(c->ap_requires);
1459 r->requirement = apr_pstrdup(cmd->pool, arg);
1460 r->method_mask = cmd->limited;
1464 AP_CORE_DECLARE_NONSTD(const char *) ap_limit_section(cmd_parms *cmd, void *dummy,
1466 const char *limited_methods = ap_getword(cmd->pool, &arg, '>');
1467 void *tog = cmd->cmd->cmd_data;
1471 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1476 while (limited_methods[0]) {
1477 char *method = ap_getword_conf(cmd->pool, &limited_methods);
1478 int methnum = ap_method_number_of(method);
1480 if (methnum == M_TRACE && !tog) {
1481 return "TRACE cannot be controlled by <Limit>";
1483 else if (methnum == M_INVALID) {
1485 register int i, j, k;
1488 * Deal with <Limit> by adding the method to the list.
1491 if (cmd->limited_xmethods == NULL) {
1492 cmd->limited_xmethods = apr_make_array(cmd->pool, 2,
1495 xmethod = (char **) apr_push_array(cmd->limited_xmethods);
1496 *xmethod = apr_pstrdup(cmd->pool, method);
1499 * <LimitExcept>, so remove any/all occurrences of the method
1500 * in the extension array.
1502 else if ((cmd->limited_xmethods != NULL)
1503 && (cmd->limited_xmethods->nelts != 0)) {
1504 xmethod = (char **) cmd->limited_xmethods->elts;
1505 for (i = 0; i < cmd->limited_xmethods->nelts; ) {
1506 if (strcmp(xmethod[i], method) == 0) {
1507 for (j = i, k = i + 1;
1508 k < cmd->limited_xmethods->nelts;
1510 xmethod[j] = xmethod[k];
1512 cmd->limited_xmethods->nelts--;
1517 limited |= (1 << methnum);
1520 /* Killing two features with one function,
1521 * if (tog == NULL) <Limit>, else <LimitExcept>
1523 cmd->limited = tog ? ~limited : limited;
1525 errmsg = ap_walk_config(cmd->directive->first_child, cmd, cmd->context);
1532 /* We use this in <DirectoryMatch> and <FilesMatch>, to ensure that
1533 * people don't get bitten by wrong-cased regex matches
1537 #define USE_ICASE REG_ICASE
1543 * Report a missing-'>' syntax error.
1545 static char *unclosed_directive(cmd_parms *cmd)
1547 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1548 "> directive missing closing '>'", NULL);
1551 static const char *dirsection(cmd_parms *cmd, void *mconfig, const char *arg)
1554 const char *endp = ap_strrchr_c(arg, '>');
1555 int old_overrides = cmd->override;
1556 char *old_path = cmd->path;
1557 core_dir_config *conf;
1558 void *new_dir_conf = ap_create_per_dir_config(cmd->pool);
1560 const command_rec *thiscmd = cmd->cmd;
1562 const char *err = ap_check_cmd_context(cmd,
1563 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1569 return unclosed_directive(cmd);
1572 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1574 cmd->path = ap_getword_conf(cmd->pool, &arg);
1575 cmd->override = OR_ALL|ACCESS_CONF;
1577 if (thiscmd->cmd_data) { /* <DirectoryMatch> */
1578 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1580 else if (!strcmp(cmd->path, "~")) {
1581 cmd->path = ap_getword_conf(cmd->pool, &arg);
1582 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1584 #if defined(HAVE_DRIVE_LETTERS) || defined(NETWARE)
1585 else if (strcmp(cmd->path, "/") == 0) {
1586 /* Treat 'default' path / as an inalienable root */
1587 cmd->path = apr_pstrdup(cmd->pool, cmd->path);
1590 #if defined(HAVE_UNC_PATHS)
1591 else if (strcmp(cmd->path, "//") == 0) {
1592 /* Treat UNC path // as an inalienable root */
1593 cmd->path = apr_pstrdup(cmd->pool, cmd->path);
1597 /* Ensure that the pathname is canonical */
1598 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1601 /* initialize our config and fetch it */
1602 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_dir_conf,
1605 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_dir_conf);
1611 ap_add_per_dir_conf(cmd->server, new_dir_conf);
1614 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1615 "> arguments not (yet) supported.", NULL);
1618 cmd->path = old_path;
1619 cmd->override = old_overrides;
1624 static const char *urlsection(cmd_parms *cmd, void *mconfig, const char *arg)
1627 const char *endp = ap_strrchr_c(arg, '>');
1628 int old_overrides = cmd->override;
1629 char *old_path = cmd->path;
1630 core_dir_config *conf;
1632 const command_rec *thiscmd = cmd->cmd;
1634 void *new_url_conf = ap_create_per_dir_config(cmd->pool);
1636 const char *err = ap_check_cmd_context(cmd,
1637 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1643 return unclosed_directive(cmd);
1646 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1648 cmd->path = ap_getword_conf(cmd->pool, &arg);
1649 cmd->override = OR_ALL|ACCESS_CONF;
1651 if (thiscmd->cmd_data) { /* <LocationMatch> */
1652 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1654 else if (!strcmp(cmd->path, "~")) {
1655 cmd->path = ap_getword_conf(cmd->pool, &arg);
1656 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1659 /* initialize our config and fetch it */
1660 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_url_conf,
1663 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_url_conf);
1667 conf->d = apr_pstrdup(cmd->pool, cmd->path); /* No mangling, please */
1668 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1671 ap_add_per_url_conf(cmd->server, new_url_conf);
1674 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1675 "> arguments not (yet) supported.", NULL);
1678 cmd->path = old_path;
1679 cmd->override = old_overrides;
1684 static const char *filesection(cmd_parms *cmd, void *mconfig, const char *arg)
1687 const char *endp = ap_strrchr_c(arg, '>');
1688 int old_overrides = cmd->override;
1689 char *old_path = cmd->path;
1690 core_dir_config *conf;
1692 const command_rec *thiscmd = cmd->cmd;
1693 core_dir_config *c=mconfig;
1695 void *new_file_conf = ap_create_per_dir_config(cmd->pool);
1697 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT|NOT_IN_LOCATION);
1703 return unclosed_directive(cmd);
1706 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1708 cmd->path = ap_getword_conf(cmd->pool, &arg);
1709 /* Only if not an .htaccess file */
1711 cmd->override = OR_ALL|ACCESS_CONF;
1714 if (thiscmd->cmd_data) { /* <FilesMatch> */
1715 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1717 else if (!strcmp(cmd->path, "~")) {
1718 cmd->path = ap_getword_conf(cmd->pool, &arg);
1719 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1722 /* Ensure that the pathname is canonical */
1723 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1726 /* initialize our config and fetch it */
1727 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_file_conf,
1730 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_file_conf);
1734 conf->d = cmd->path;
1735 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1738 ap_add_file_conf(c, new_file_conf);
1741 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1742 "> arguments not (yet) supported.", NULL);
1745 cmd->path = old_path;
1746 cmd->override = old_overrides;
1751 static const char *start_ifmod(cmd_parms *cmd, void *mconfig, const char *arg)
1753 const char *endp = ap_strrchr_c(arg, '>');
1754 int not = (arg[0] == '!');
1758 return unclosed_directive(cmd);
1761 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1767 found = ap_find_linked_module(arg);
1769 if ((!not && found) || (not && !found)) {
1770 ap_directive_t *parent = NULL;
1771 ap_directive_t *current = NULL;
1774 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1775 ¤t, &parent, "<IfModule");
1776 *(ap_directive_t **)mconfig = current;
1780 *(ap_directive_t **)mconfig = NULL;
1781 return ap_soak_end_container(cmd, "<IfModule");
1785 AP_DECLARE(int) ap_exists_config_define(const char *name)
1790 defines = (char **)ap_server_config_defines->elts;
1791 for (i = 0; i < ap_server_config_defines->nelts; i++) {
1792 if (strcmp(defines[i], name) == 0) {
1799 static const char *start_ifdefine(cmd_parms *cmd, void *dummy, const char *arg)
1805 endp = ap_strrchr_c(arg, '>');
1807 return unclosed_directive(cmd);
1810 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1812 if (arg[0] == '!') {
1817 defined = ap_exists_config_define(arg);
1818 if ((!not && defined) || (not && !defined)) {
1819 ap_directive_t *parent = NULL;
1820 ap_directive_t *current = NULL;
1823 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1824 ¤t, &parent, "<IfDefine");
1825 *(ap_directive_t **)dummy = current;
1829 *(ap_directive_t **)dummy = NULL;
1830 return ap_soak_end_container(cmd, "<IfDefine");
1834 /* httpd.conf commands... beginning with the <VirtualHost> business */
1836 static const char *virtualhost_section(cmd_parms *cmd, void *dummy,
1839 server_rec *main_server = cmd->server, *s;
1841 const char *endp = ap_strrchr_c(arg, '>');
1842 apr_pool_t *p = cmd->pool;
1844 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1850 return unclosed_directive(cmd);
1853 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1855 /* FIXME: There's another feature waiting to happen here -- since you
1856 can now put multiple addresses/names on a single <VirtualHost>
1857 you might want to use it to group common definitions and then
1858 define other "subhosts" with their individual differences. But
1859 personally I'd rather just do it with a macro preprocessor. -djg */
1860 if (main_server->is_virtual) {
1861 return "<VirtualHost> doesn't nest!";
1864 errmsg = ap_init_virtual_host(p, arg, main_server, &s);
1869 s->next = main_server->next;
1870 main_server->next = s;
1872 s->defn_name = cmd->directive->filename;
1873 s->defn_line_number = cmd->directive->line_num;
1877 errmsg = ap_walk_config(cmd->directive->first_child, cmd,
1878 s->lookup_defaults);
1880 cmd->server = main_server;
1885 static const char *set_server_alias(cmd_parms *cmd, void *dummy,
1888 if (!cmd->server->names) {
1889 return "ServerAlias only used in <VirtualHost>";
1892 char **item, *name = ap_getword_conf(cmd->pool, &arg);
1893 if (ap_is_matchexp(name)) {
1894 item = (char **)apr_push_array(cmd->server->wild_names);
1897 item = (char **)apr_push_array(cmd->server->names);
1904 static const char *add_filter(cmd_parms *cmd, void *dummy, const char *arg)
1906 core_dir_config *conf = dummy;
1909 newfilter = (char **)apr_push_array(conf->output_filters);
1910 *newfilter = apr_pstrdup(cmd->pool, arg);
1914 static const char *add_input_filter(cmd_parms *cmd, void *dummy, const char *arg)
1916 core_dir_config *conf = dummy;
1919 newfilter = (char **)apr_push_array(conf->input_filters);
1920 *newfilter = apr_pstrdup(cmd->pool, arg);
1924 static const char *add_module_command(cmd_parms *cmd, void *dummy,
1927 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1932 if (!ap_add_named_module(arg)) {
1933 return apr_pstrcat(cmd->pool, "Cannot add module via name '", arg,
1934 "': not in list of loaded modules", NULL);
1936 *(ap_directive_t **)dummy = NULL;
1940 static const char *clear_module_list_command(cmd_parms *cmd, void *dummy)
1942 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1947 ap_clear_module_list();
1948 *(ap_directive_t **)dummy = NULL;
1952 static const char *set_server_string_slot(cmd_parms *cmd, void *dummy,
1955 /* This one's pretty generic... */
1957 int offset = (int)(long)cmd->info;
1958 char *struct_ptr = (char *)cmd->server;
1960 const char *err = ap_check_cmd_context(cmd,
1961 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1966 *(const char **)(struct_ptr + offset) = arg;
1970 static const char *server_port(cmd_parms *cmd, void *dummy, const char *arg)
1972 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1979 if (port <= 0 || port >= 65536) { /* 65536 == 1<<16 */
1980 return apr_pstrcat(cmd->temp_pool, "The port number \"", arg,
1981 "\" is outside the appropriate range "
1982 "(i.e., 1..65535).", NULL);
1984 cmd->server->port = port;
1988 static const char *set_signature_flag(cmd_parms *cmd, void *d_,
1991 core_dir_config *d=d_;
1993 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1998 if (strcasecmp(arg, "On") == 0) {
1999 d->server_signature = srv_sig_on;
2001 else if (strcasecmp(arg, "Off") == 0) {
2002 d->server_signature = srv_sig_off;
2004 else if (strcasecmp(arg, "EMail") == 0) {
2005 d->server_signature = srv_sig_withmail;
2008 return "ServerSignature: use one of: off | on | email";
2013 static const char *set_server_root(cmd_parms *cmd, void *dummy,
2016 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2022 arg = ap_os_canonical_filename(cmd->pool, arg);
2024 if (!ap_is_directory(arg)) {
2025 return "ServerRoot must be a valid directory";
2027 ap_server_root = arg;
2031 static const char *set_timeout(cmd_parms *cmd, void *dummy, const char *arg)
2033 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2038 cmd->server->timeout = atoi(arg);
2042 static const char *set_keep_alive_timeout(cmd_parms *cmd, void *dummy,
2045 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2050 cmd->server->keep_alive_timeout = atoi(arg);
2054 static const char *set_keep_alive(cmd_parms *cmd, void *dummy,
2057 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2062 /* We've changed it to On/Off, but used to use numbers
2063 * so we accept anything but "Off" or "0" as "On"
2065 if (!strcasecmp(arg, "off") || !strcmp(arg, "0")) {
2066 cmd->server->keep_alive = 0;
2069 cmd->server->keep_alive = 1;
2074 static const char *set_keep_alive_max(cmd_parms *cmd, void *dummy,
2077 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2082 cmd->server->keep_alive_max = atoi(arg);
2086 static const char *set_idcheck(cmd_parms *cmd, void *d_, int arg)
2088 core_dir_config *d=d_;
2089 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2094 d->do_rfc1413 = arg != 0;
2098 static const char *set_hostname_lookups(cmd_parms *cmd, void *d_,
2101 core_dir_config *d=d_;
2103 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2108 if (!strcasecmp(arg, "on")) {
2109 d->hostname_lookups = HOSTNAME_LOOKUP_ON;
2111 else if (!strcasecmp(arg, "off")) {
2112 d->hostname_lookups = HOSTNAME_LOOKUP_OFF;
2114 else if (!strcasecmp(arg, "double")) {
2115 d->hostname_lookups = HOSTNAME_LOOKUP_DOUBLE;
2118 return "parameter must be 'on', 'off', or 'double'";
2123 static const char *set_serverpath(cmd_parms *cmd, void *dummy,
2126 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2131 cmd->server->path = arg;
2132 cmd->server->pathlen = strlen(arg);
2136 static const char *set_content_md5(cmd_parms *cmd, void *d_, int arg)
2138 core_dir_config *d=d_;
2139 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2144 d->content_md5 = arg != 0;
2148 static const char *set_use_canonical_name(cmd_parms *cmd, void *d_,
2151 core_dir_config *d=d_;
2152 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2157 if (strcasecmp(arg, "on") == 0) {
2158 d->use_canonical_name = USE_CANONICAL_NAME_ON;
2160 else if (strcasecmp(arg, "off") == 0) {
2161 d->use_canonical_name = USE_CANONICAL_NAME_OFF;
2163 else if (strcasecmp(arg, "dns") == 0) {
2164 d->use_canonical_name = USE_CANONICAL_NAME_DNS;
2167 return "parameter must be 'on', 'off', or 'dns'";
2173 static const char *include_config (cmd_parms *cmd, void *dummy,
2176 ap_directive_t *conftree = NULL;
2178 ap_process_resource_config(cmd->server,
2179 ap_server_root_relative(cmd->pool, name),
2180 &conftree, cmd->pool, cmd->temp_pool);
2181 *(ap_directive_t **)dummy = conftree;
2185 static const char *set_loglevel(cmd_parms *cmd, void *dummy, const char *arg)
2189 const char *err = ap_check_cmd_context(cmd,
2190 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2195 if ((str = ap_getword_conf(cmd->pool, &arg))) {
2196 if (!strcasecmp(str, "emerg")) {
2197 cmd->server->loglevel = APLOG_EMERG;
2199 else if (!strcasecmp(str, "alert")) {
2200 cmd->server->loglevel = APLOG_ALERT;
2202 else if (!strcasecmp(str, "crit")) {
2203 cmd->server->loglevel = APLOG_CRIT;
2205 else if (!strcasecmp(str, "error")) {
2206 cmd->server->loglevel = APLOG_ERR;
2208 else if (!strcasecmp(str, "warn")) {
2209 cmd->server->loglevel = APLOG_WARNING;
2211 else if (!strcasecmp(str, "notice")) {
2212 cmd->server->loglevel = APLOG_NOTICE;
2214 else if (!strcasecmp(str, "info")) {
2215 cmd->server->loglevel = APLOG_INFO;
2217 else if (!strcasecmp(str, "debug")) {
2218 cmd->server->loglevel = APLOG_DEBUG;
2221 return "LogLevel requires level keyword: one of "
2222 "emerg/alert/crit/error/warn/notice/info/debug";
2226 return "LogLevel requires level keyword";
2232 AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r)
2235 core_dir_config *conf;
2237 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
2239 if ((conf->server_signature == srv_sig_off)
2240 || (conf->server_signature == srv_sig_unset)) {
2244 apr_snprintf(sport, sizeof sport, "%u", (unsigned) ap_get_server_port(r));
2246 if (conf->server_signature == srv_sig_withmail) {
2247 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2248 " Server at <A HREF=\"mailto:",
2249 r->server->server_admin, "\">",
2250 ap_get_server_name(r), "</A> Port ", sport,
2251 "</ADDRESS>\n", NULL);
2253 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2254 " Server at ", ap_get_server_name(r), " Port ", sport,
2255 "</ADDRESS>\n", NULL);
2259 * Load an authorisation realm into our location configuration, applying the
2260 * usual rules that apply to realms.
2262 static const char *set_authname(cmd_parms *cmd, void *mconfig,
2265 core_dir_config *aconfig = (core_dir_config *)mconfig;
2267 aconfig->ap_auth_name = ap_escape_quotes(cmd->pool, word1);
2271 #ifdef _OSD_POSIX /* BS2000 Logon Passwd file */
2272 static const char *set_bs2000_account(cmd_parms *cmd, void *dummy, char *name)
2274 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2279 return os_set_account(cmd->pool, name);
2281 #endif /*_OSD_POSIX*/
2284 * Handle a request to include the server's OS platform in the Server
2285 * response header field (the ServerTokens directive). Unfortunately
2286 * this requires a new global in order to communicate the setting back to
2287 * http_main so it can insert the information in the right place in the
2291 static char *server_version = NULL;
2292 static int version_locked = 0;
2294 enum server_token_type {
2295 SrvTk_MIN, /* eg: Apache/1.3.0 */
2296 SrvTk_OS, /* eg: Apache/1.3.0 (UNIX) */
2297 SrvTk_FULL, /* eg: Apache/1.3.0 (UNIX) PHP/3.0 FooBar/1.2b */
2298 SrvTk_PRODUCT_ONLY /* eg: Apache */
2300 static enum server_token_type ap_server_tokens = SrvTk_FULL;
2302 static apr_status_t reset_version(void *dummy)
2305 ap_server_tokens = SrvTk_FULL;
2306 server_version = NULL;
2310 AP_DECLARE(const char *) ap_get_server_version(void)
2312 return (server_version ? server_version : AP_SERVER_BASEVERSION);
2315 AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component)
2317 if (! version_locked) {
2319 * If the version string is null, register our cleanup to reset the
2320 * pointer on pool destruction. We also know that, if NULL,
2321 * we are adding the original SERVER_BASEVERSION string.
2323 if (server_version == NULL) {
2324 apr_register_cleanup(pconf, NULL, reset_version,
2326 server_version = apr_pstrdup(pconf, component);
2330 * Tack the given component identifier to the end of
2331 * the existing string.
2333 server_version = apr_pstrcat(pconf, server_version, " ",
2340 * This routine adds the real server base identity to the version string,
2341 * and then locks out changes until the next reconfig.
2343 static void ap_set_version(apr_pool_t *pconf)
2345 if (ap_server_tokens == SrvTk_PRODUCT_ONLY) {
2346 ap_add_version_component(pconf, AP_SERVER_BASEPRODUCT);
2348 else if (ap_server_tokens == SrvTk_MIN) {
2349 ap_add_version_component(pconf, AP_SERVER_BASEVERSION);
2352 ap_add_version_component(pconf, AP_SERVER_BASEVERSION " (" PLATFORM ")");
2355 * Lock the server_version string if we're not displaying
2356 * the full set of tokens
2358 if (ap_server_tokens != SrvTk_FULL) {
2363 static const char *set_serv_tokens(cmd_parms *cmd, void *dummy,
2366 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2371 if (!strcasecmp(arg, "OS")) {
2372 ap_server_tokens = SrvTk_OS;
2374 else if (!strcasecmp(arg, "Min") || !strcasecmp(arg, "Minimal")) {
2375 ap_server_tokens = SrvTk_MIN;
2377 else if (!strcasecmp(arg, "Prod") || !strcasecmp(arg, "ProductOnly")) {
2378 ap_server_tokens = SrvTk_PRODUCT_ONLY;
2381 ap_server_tokens = SrvTk_FULL;
2386 static const char *set_limit_req_line(cmd_parms *cmd, void *dummy,
2389 const char *err = ap_check_cmd_context(cmd,
2390 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2398 return apr_pstrcat(cmd->temp_pool, "LimitRequestLine \"", arg,
2399 "\" must be a non-negative integer", NULL);
2401 if (lim > DEFAULT_LIMIT_REQUEST_LINE) {
2402 return apr_psprintf(cmd->temp_pool, "LimitRequestLine \"%s\" "
2403 "must not exceed the precompiled maximum of %d",
2404 arg, DEFAULT_LIMIT_REQUEST_LINE);
2406 cmd->server->limit_req_line = lim;
2410 static const char *set_limit_req_fieldsize(cmd_parms *cmd, void *dummy,
2413 const char *err = ap_check_cmd_context(cmd,
2414 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2422 return apr_pstrcat(cmd->temp_pool, "LimitRequestFieldsize \"", arg,
2423 "\" must be a non-negative integer (0 = no limit)",
2426 if (lim > DEFAULT_LIMIT_REQUEST_FIELDSIZE) {
2427 return apr_psprintf(cmd->temp_pool, "LimitRequestFieldsize \"%s\" "
2428 "must not exceed the precompiled maximum of %d",
2429 arg, DEFAULT_LIMIT_REQUEST_FIELDSIZE);
2431 cmd->server->limit_req_fieldsize = lim;
2435 static const char *set_limit_req_fields(cmd_parms *cmd, void *dummy,
2438 const char *err = ap_check_cmd_context(cmd,
2439 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2447 return apr_pstrcat(cmd->temp_pool, "LimitRequestFields \"", arg,
2448 "\" must be a non-negative integer (0 = no limit)",
2451 cmd->server->limit_req_fields = lim;
2455 static const char *set_limit_req_body(cmd_parms *cmd, void *conf_,
2458 core_dir_config *conf=conf_;
2459 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2464 /* WTF: If strtoul is not portable, then write a replacement.
2465 * Instead we have an idiotic define in httpd.h that prevents
2466 * it from being used even when it is available. Sheesh.
2468 conf->limit_req_body = (unsigned long)strtol(arg, (char **)NULL, 10);
2472 static const char *set_limit_xml_req_body(cmd_parms *cmd, void *conf_,
2475 core_dir_config *conf = conf_;
2476 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2481 conf->limit_xml_body = atol(arg);
2482 if (conf->limit_xml_body < 0)
2483 return "LimitXMLRequestBody requires a non-negative integer.";
2488 AP_DECLARE(size_t) ap_get_limit_xml_body(const request_rec *r)
2490 core_dir_config *conf;
2492 conf = ap_get_module_config(r->per_dir_config, &core_module);
2493 if (conf->limit_xml_body == AP_LIMIT_UNSET)
2494 return AP_DEFAULT_LIMIT_XML_BODY;
2495 return (size_t)conf->limit_xml_body;
2499 static const char *set_interpreter_source(cmd_parms *cmd, core_dir_config *d,
2502 if (!strcasecmp(arg, "registry")) {
2503 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY;
2504 } else if (!strcasecmp(arg, "registry-strict")) {
2505 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY_STRICT;
2506 } else if (!strcasecmp(arg, "script")) {
2507 d->script_interpreter_source = INTERPRETER_SOURCE_SHEBANG;
2509 return apr_pstrcat(cmd->temp_pool, "ScriptInterpreterSource \"", arg,
2510 "\" must be \"registry\", \"registry-strict\" or "
2511 "\"script\"", NULL);
2517 #if !defined (RLIMIT_CPU) || !(defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)) || !defined (RLIMIT_NPROC)
2518 static const char *no_set_limit(cmd_parms *cmd, void *conf_,
2519 const char *arg, const char *arg2)
2521 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, cmd->server,
2522 "%s not supported on this platform", cmd->cmd->name);
2528 static const char *set_limit_cpu(cmd_parms *cmd, void *conf_,
2529 const char *arg, const char *arg2)
2531 core_dir_config *conf=conf_;
2533 unixd_set_rlimit(cmd, &conf->limit_cpu, arg, arg2, RLIMIT_CPU);
2538 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)
2539 static const char *set_limit_mem(cmd_parms *cmd, void *conf_,
2540 const char *arg, const char * arg2)
2542 core_dir_config *conf=conf_;
2544 #if defined(RLIMIT_AS)
2545 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2 ,RLIMIT_AS);
2546 #elif defined(RLIMIT_DATA)
2547 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_DATA);
2548 #elif defined(RLIMIT_VMEM)
2549 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_VMEM);
2556 static const char *set_limit_nproc(cmd_parms *cmd, void *conf_,
2557 const char *arg, const char * arg2)
2559 core_dir_config *conf=conf_;
2561 unixd_set_rlimit(cmd, &conf->limit_nproc, arg, arg2, RLIMIT_NPROC);
2566 static apr_status_t writev_it_all(apr_socket_t *s, struct iovec *vec, int nvec,
2567 apr_size_t len, apr_size_t *nbytes)
2569 apr_size_t bytes_written = 0;
2571 apr_ssize_t n = len;
2576 /* XXX handle checking for non-blocking socket */
2577 while (bytes_written != len) {
2578 rv = apr_sendv(s, vec + i, nvec - i, &n);
2580 if (rv != APR_SUCCESS)
2583 /* If the write did not complete, adjust the iovecs and issue
2586 if (bytes_written < len) {
2587 /* Skip over the vectors that have already been written */
2588 apr_size_t cnt = vec[i].iov_len;
2589 while (n >= cnt && i + 1 < nvec) {
2591 cnt += vec[i].iov_len;
2594 /* Handle partial write of vec i */
2595 vec[i].iov_base = (char *) vec[i].iov_base +
2596 (vec[i].iov_len - (cnt - n));
2597 vec[i].iov_len = cnt -n;
2600 n = len - bytes_written;
2607 * Sends the contents of file fd along with header/trailer bytes, if any,
2608 * to the network. send_the_file will return only when all the bytes have been
2609 * sent (i.e., it handles partial writes) or on a network error condition.
2611 static apr_status_t send_the_file(conn_rec *c, apr_file_t *fd,
2612 apr_hdtr_t *hdtr, apr_off_t offset,
2613 apr_size_t length, apr_size_t *nbytes)
2615 apr_status_t rv = APR_SUCCESS;
2616 apr_int32_t togo; /* Remaining number of bytes in the file to send */
2617 apr_size_t sendlen = 0;
2618 apr_size_t bytes_sent;
2620 apr_off_t o; /* Track the file offset for partial writes */
2626 * writev_it_all handles partial writes.
2627 * XXX: optimization... if headers are less than MIN_WRITE_SIZE, copy
2630 if ( hdtr && hdtr->numheaders > 0 ) {
2631 for (i = 0; i < hdtr->numheaders; i++) {
2632 sendlen += hdtr->headers[i].iov_len;
2634 rv = writev_it_all(c->client_socket, hdtr->headers, hdtr->numheaders,
2635 sendlen, &bytes_sent);
2636 if (rv == APR_SUCCESS)
2637 *nbytes += bytes_sent; /* track total bytes sent */
2640 /* Seek the file to 'offset' */
2641 if (offset != 0 && rv == APR_SUCCESS) {
2642 rv = apr_seek(fd, APR_SET, &offset);
2645 /* Send the file, making sure to handle partial writes */
2647 while (rv == APR_SUCCESS && togo) {
2648 sendlen = togo > sizeof(buffer) ? sizeof(buffer) : togo;
2650 rv = apr_read(fd, buffer, &sendlen);
2651 while (rv == APR_SUCCESS && sendlen) {
2652 bytes_sent = sendlen;
2653 rv = apr_send(c->client_socket, &buffer[o], &bytes_sent);
2654 if (rv == APR_SUCCESS) {
2655 sendlen -= bytes_sent; /* sendlen != bytes_sent ==> partial write */
2656 o += bytes_sent; /* o is where we are in the buffer */
2657 *nbytes += bytes_sent;
2658 togo -= bytes_sent; /* track how much of the file we've sent */
2663 /* Send the trailers
2664 * XXX: optimization... if it will fit, send this on the last send in the
2668 if ( rv == APR_SUCCESS && hdtr && hdtr->numtrailers > 0 ) {
2669 for (i = 0; i < hdtr->numtrailers; i++) {
2670 sendlen += hdtr->trailers[i].iov_len;
2672 rv = writev_it_all(c->client_socket, hdtr->trailers, hdtr->numtrailers,
2673 sendlen, &bytes_sent);
2674 if (rv == APR_SUCCESS)
2675 *nbytes += bytes_sent;
2681 /* Note --- ErrorDocument will now work from .htaccess files.
2682 * The AllowOverride of Fileinfo allows webmasters to turn it off
2685 static const command_rec core_cmds[] = {
2687 /* Old access config file commands */
2689 AP_INIT_RAW_ARGS("<Directory", dirsection, NULL, RSRC_CONF,
2690 "Container for directives affecting resources located in the specified "
2692 AP_INIT_RAW_ARGS("<Location", urlsection, NULL, RSRC_CONF,
2693 "Container for directives affecting resources accessed through the "
2694 "specified URL paths"),
2695 AP_INIT_RAW_ARGS("<VirtualHost", virtualhost_section, NULL, RSRC_CONF,
2696 "Container to map directives to a particular virtual host, takes one or "
2697 "more host addresses"),
2698 AP_INIT_RAW_ARGS("<Files", filesection, NULL, OR_ALL,
2699 "Container for directives affecting files matching specified patterns"),
2700 AP_INIT_RAW_ARGS("<Limit", ap_limit_section, NULL, OR_ALL,
2701 "Container for authentication directives when accessed using specified HTTP "
2703 AP_INIT_RAW_ARGS("<LimitExcept", ap_limit_section, (void*)1, OR_ALL,
2704 "Container for authentication directives to be applied when any HTTP "
2705 "method other than those specified is used to access the resource"),
2706 AP_INIT_TAKE1("<IfModule", start_ifmod, NULL, EXEC_ON_READ | OR_ALL,
2707 "Container for directives based on existance of specified modules"),
2708 AP_INIT_TAKE1("<IfDefine", start_ifdefine, NULL, EXEC_ON_READ | OR_ALL,
2709 "Container for directives based on existance of command line defines"),
2710 AP_INIT_RAW_ARGS("<DirectoryMatch", dirsection, (void*)1, RSRC_CONF,
2711 "Container for directives affecting resources located in the "
2712 "specified directories"),
2713 AP_INIT_RAW_ARGS("<LocationMatch", urlsection, (void*)1, RSRC_CONF,
2714 "Container for directives affecting resources accessed through the "
2715 "specified URL paths"),
2716 AP_INIT_RAW_ARGS("<FilesMatch", filesection, (void*)1, OR_ALL,
2717 "Container for directives affecting files matching specified patterns"),
2718 AP_INIT_TAKE1("AuthType", ap_set_string_slot,
2719 (void*)XtOffsetOf(core_dir_config, ap_auth_type), OR_AUTHCFG,
2720 "An HTTP authorization type (e.g., \"Basic\")"),
2721 AP_INIT_TAKE1("AuthName", set_authname, NULL, OR_AUTHCFG,
2722 "The authentication realm (e.g. \"Members Only\")"),
2723 AP_INIT_RAW_ARGS("Require", require, NULL, OR_AUTHCFG,
2724 "Selects which authenticated users or groups may access a protected space"),
2725 AP_INIT_TAKE1("Satisfy", satisfy, NULL, OR_AUTHCFG,
2726 "access policy if both allow and require used ('all' or 'any')"),
2728 AP_INIT_TAKE1("GprofDir", set_gprof_dir, NULL, RSRC_CONF,
2729 "Directory to plop gmon.out files"),
2731 AP_INIT_TAKE1("AddDefaultCharset", set_add_default_charset, NULL, OR_FILEINFO,
2732 "The name of the default charset to add to any Content-Type without one or 'Off' to disable"),
2734 /* Old resource config file commands */
2736 AP_INIT_RAW_ARGS("AccessFileName", set_access_name, NULL, RSRC_CONF,
2737 "Name(s) of per-directory config files (default: .htaccess)"),
2738 AP_INIT_TAKE1("DocumentRoot", set_document_root, NULL, RSRC_CONF,
2739 "Root directory of the document tree"),
2740 AP_INIT_TAKE2("ErrorDocument", set_error_document, NULL, OR_FILEINFO,
2741 "Change responses for HTTP errors"),
2742 AP_INIT_RAW_ARGS("AllowOverride", set_override, NULL, ACCESS_CONF,
2743 "Controls what groups of directives can be configured by per-directory "
2745 AP_INIT_RAW_ARGS("Options", set_options, NULL, OR_OPTIONS,
2746 "Set a number of attributes for a given directory"),
2747 AP_INIT_TAKE1("DefaultType", ap_set_string_slot,
2748 (void*)XtOffsetOf (core_dir_config, ap_default_type),
2749 OR_FILEINFO, "the default MIME type for untypable files"),
2751 /* Old server config file commands */
2753 AP_INIT_TAKE1("Port", server_port, NULL, RSRC_CONF, "A TCP port number"),
2754 AP_INIT_TAKE1("HostnameLookups", set_hostname_lookups, NULL,
2755 ACCESS_CONF|RSRC_CONF,
2756 "\"on\" to enable, \"off\" to disable reverse DNS lookups, or \"double\" to "
2757 "enable double-reverse DNS lookups"),
2758 AP_INIT_TAKE1("ServerAdmin", set_server_string_slot,
2759 (void *)XtOffsetOf (server_rec, server_admin), RSRC_CONF,
2760 "The email address of the server administrator"),
2761 AP_INIT_TAKE1("ServerName", set_server_string_slot,
2762 (void *)XtOffsetOf (server_rec, server_hostname), RSRC_CONF,
2763 "The hostname of the server"),
2764 AP_INIT_TAKE1("ServerSignature", set_signature_flag, NULL, OR_ALL,
2765 "En-/disable server signature (on|off|email)"),
2766 AP_INIT_TAKE1("ServerRoot", set_server_root, NULL, RSRC_CONF,
2767 "Common directory of server-related files (logs, confs, etc.)"),
2768 AP_INIT_TAKE1("ErrorLog", set_server_string_slot,
2769 (void *)XtOffsetOf (server_rec, error_fname), RSRC_CONF,
2770 "The filename of the error log"),
2771 AP_INIT_RAW_ARGS("ServerAlias", set_server_alias, NULL, RSRC_CONF,
2772 "A name or names alternately used to access the server"),
2773 AP_INIT_TAKE1("ServerPath", set_serverpath, NULL, RSRC_CONF,
2774 "The pathname the server can be reached at"),
2775 AP_INIT_TAKE1("Timeout", set_timeout, NULL, RSRC_CONF,
2776 "Timeout duration (sec)"),
2777 AP_INIT_TAKE1("KeepAliveTimeout", set_keep_alive_timeout, NULL, RSRC_CONF,
2778 "Keep-Alive timeout duration (sec)"),
2779 AP_INIT_TAKE1("MaxKeepAliveRequests", set_keep_alive_max, NULL, RSRC_CONF,
2780 "Maximum number of Keep-Alive requests per connection, or 0 for infinite"),
2781 AP_INIT_TAKE1("KeepAlive", set_keep_alive, NULL, RSRC_CONF,
2782 "Whether persistent connections should be On or Off"),
2783 AP_INIT_FLAG("IdentityCheck", set_idcheck, NULL, RSRC_CONF|ACCESS_CONF,
2784 "Enable identd (RFC 1413) user lookups - SLOW"),
2785 AP_INIT_FLAG("ContentDigest", set_content_md5, NULL, OR_OPTIONS,
2786 "whether or not to send a Content-MD5 header with each request"),
2787 AP_INIT_TAKE1("UseCanonicalName", set_use_canonical_name, NULL,
2788 RSRC_CONF|ACCESS_CONF,
2789 "How to work out the ServerName : Port when constructing URLs"),
2790 /* TODO: RlimitFoo should all be part of mod_cgi, not in the core */
2791 AP_INIT_ITERATE("AddModule", add_module_command, NULL,
2792 RSRC_CONF, "The name of a module"),
2793 AP_INIT_NO_ARGS("ClearModuleList", clear_module_list_command, NULL,
2795 /* TODO: ListenBacklog in MPM */
2796 AP_INIT_TAKE1("Include", include_config, NULL,
2797 (RSRC_CONF | ACCESS_CONF | EXEC_ON_READ),
2798 "Name of the config file to be included"),
2799 AP_INIT_TAKE1("LogLevel", set_loglevel, NULL, RSRC_CONF,
2800 "Level of verbosity in error logging"),
2801 AP_INIT_TAKE1("NameVirtualHost", ap_set_name_virtual_host, NULL, RSRC_CONF,
2802 "A numeric IP address:port, or the name of a host"),
2804 AP_INIT_TAKE1("BS2000Account", set_bs2000_account, NULL, RSRC_CONF,
2805 "Name of server User's bs2000 logon account name"),
2808 AP_INIT_TAKE1("ScriptInterpreterSource", set_interpreter_source, NULL,
2810 "Where to find interpreter to run Win32 scripts (Registry or script shebang line)"),
2812 AP_INIT_TAKE1("ServerTokens", set_serv_tokens, NULL, RSRC_CONF,
2813 "Determine tokens displayed in the Server: header - Min(imal), OS or Full"),
2814 AP_INIT_TAKE1("LimitRequestLine", set_limit_req_line, NULL, RSRC_CONF,
2815 "Limit on maximum size of an HTTP request line"),
2816 AP_INIT_TAKE1("LimitRequestFieldsize", set_limit_req_fieldsize, NULL,
2818 "Limit on maximum size of an HTTP request header field"),
2819 AP_INIT_TAKE1("LimitRequestFields", set_limit_req_fields, NULL, RSRC_CONF,
2820 "Limit (0 = unlimited) on max number of header fields in a request message"),
2821 AP_INIT_TAKE1("LimitRequestBody", set_limit_req_body,
2822 (void*)XtOffsetOf(core_dir_config, limit_req_body), OR_ALL,
2823 "Limit (in bytes) on maximum size of request message body"),
2824 AP_INIT_TAKE1("LimitXMLRequestBody", set_limit_xml_req_body, NULL, OR_ALL,
2825 "Limit (in bytes) on maximum size of an XML-based request "
2828 /* System Resource Controls */
2830 AP_INIT_TAKE12("RLimitCPU", set_limit_cpu,
2831 (void*)XtOffsetOf(core_dir_config, limit_cpu),
2832 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2834 AP_INIT_TAKE12("RLimitCPU", no_set_limit, NULL,
2835 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2837 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined (RLIMIT_AS)
2838 AP_INIT_TAKE12("RLimitMEM", set_limit_mem,
2839 (void*)XtOffsetOf(core_dir_config, limit_mem),
2840 OR_ALL, "Soft/hard limits for max memory usage per process"),
2842 AP_INIT_TAKE12("RLimitMEM", no_set_limit, NULL,
2843 OR_ALL, "Soft/hard limits for max memory usage per process"),
2846 AP_INIT_TAKE12("RLimitNPROC", set_limit_nproc,
2847 (void*)XtOffsetOf(core_dir_config, limit_nproc),
2848 OR_ALL, "soft/hard limits for max number of processes per uid"),
2850 AP_INIT_TAKE12("RLimitNPROC", no_set_limit, NULL,
2851 OR_ALL, "soft/hard limits for max number of processes per uid"),
2853 /* XXX These should be allowable in .htaccess files, but currently it won't
2854 * play well with the Options stuff. Until that is fixed, I would prefer
2855 * to leave it just in the conf file. Other should feel free to disagree
2858 AP_INIT_ITERATE("AddOutputFilter", add_filter, NULL, ACCESS_CONF,
2859 "filters to be run"),
2860 AP_INIT_ITERATE("AddInputFilter", add_input_filter, NULL, ACCESS_CONF,
2861 "filters to be run on the request body"),
2865 /*****************************************************************
2867 * Core handlers for various phases of server operation...
2870 AP_DECLARE_NONSTD(int) ap_core_translate(request_rec *r)
2872 void *sconf = r->server->module_config;
2873 core_server_config *conf = ap_get_module_config(sconf, &core_module);
2876 return HTTP_FORBIDDEN;
2878 if ((r->uri[0] != '/') && strcmp(r->uri, "*")) {
2879 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2880 "Invalid URI in request %s", r->the_request);
2881 return HTTP_BAD_REQUEST;
2885 && !strncmp(r->uri, r->server->path, r->server->pathlen)
2886 && (r->server->path[r->server->pathlen - 1] == '/'
2887 || r->uri[r->server->pathlen] == '/'
2888 || r->uri[r->server->pathlen] == '\0')) {
2889 r->filename = apr_pstrcat(r->pool, conf->ap_document_root,
2890 (r->uri + r->server->pathlen), NULL);
2894 * Make sure that we do not mess up the translation by adding two
2895 * /'s in a row. This happens under windows when the document
2896 * root ends with a /
2898 if ((conf->ap_document_root[strlen(conf->ap_document_root)-1] == '/')
2899 && (*(r->uri) == '/')) {
2900 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri+1,
2904 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri,
2912 static int do_nothing(request_rec *r) { return OK; }
2915 * Default handler for MIME types without other handlers. Only GET
2916 * and OPTIONS at this point... anyone who wants to write a generic
2917 * handler for PUT or POST is free to do so, but it seems unwise to provide
2918 * any defaults yet... So, for now, we assume that this will always be
2919 * the last handler called and return 405 or 501.
2922 static int default_handler(request_rec *r)
2924 core_dir_config *d =
2925 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
2926 int rangestatus, errstatus;
2927 apr_file_t *fd = NULL;
2928 apr_status_t status;
2929 #ifdef AP_USE_MMAP_FILES
2930 apr_mmap_t *mm = NULL;
2932 /* XXX if/when somebody writes a content-md5 filter we either need to
2933 * remove this support or coordinate when to use the filter vs.
2934 * when to use this code
2935 * The current choice of when to compute the md5 here matches the 1.3
2936 * support fairly closely (unlike 1.3, we don't handle computing md5
2937 * when the charset is translated).
2939 int bld_content_md5 =
2940 (d->content_md5 & 1) && r->output_filters->frec->ftype != AP_FTYPE_CONTENT;
2942 /* This handler has no use for a request body (yet), but we still
2943 * need to read and discard it if the client sent one.
2945 if ((errstatus = ap_discard_request_body(r)) != OK) {
2949 ap_allow_methods(r, MERGE_ALLOW, "GET", "OPTIONS", NULL);
2951 if (r->method_number == M_INVALID) {
2952 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2953 "Invalid method in request %s", r->the_request);
2954 return HTTP_NOT_IMPLEMENTED;
2956 if (r->method_number == M_OPTIONS) {
2957 return ap_send_http_options(r);
2959 if (r->method_number == M_PUT) {
2960 return HTTP_METHOD_NOT_ALLOWED;
2962 if (r->finfo.protection == 0 || (r->path_info && *r->path_info)) {
2963 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, r,
2964 "File does not exist: %s",r->path_info ?
2965 apr_pstrcat(r->pool, r->filename, r->path_info, NULL)
2967 return HTTP_NOT_FOUND;
2969 if (r->method_number != M_GET) {
2970 return HTTP_METHOD_NOT_ALLOWED;
2973 if ((status = apr_open(&fd, r->filename, APR_READ | APR_BINARY, 0, r->pool)) != APR_SUCCESS) {
2974 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
2975 "file permissions deny server access: %s", r->filename);
2976 return HTTP_FORBIDDEN;
2978 ap_update_mtime(r, r->finfo.mtime);
2979 ap_set_last_modified(r);
2981 apr_table_setn(r->headers_out, "Accept-Ranges", "bytes");
2982 if (((errstatus = ap_meets_conditions(r)) != OK)
2983 || (errstatus = ap_set_content_length(r, r->finfo.size))) {
2988 #ifdef AP_USE_MMAP_FILES
2989 if ((r->finfo.size >= MMAP_THRESHOLD)
2990 && (r->finfo.size < MMAP_LIMIT)
2991 && (!r->header_only || bld_content_md5)) {
2992 /* we need to protect ourselves in case we die while we've got the
2994 apr_status_t status;
2995 if ((status = apr_mmap_create(&mm, fd, 0, r->finfo.size, r->pool)) != APR_SUCCESS) {
2996 ap_log_rerror(APLOG_MARK, APLOG_CRIT, status, r,
2997 "default_handler: mmap failed: %s", r->filename);
3008 if (bld_content_md5) {
3009 apr_table_setn(r->headers_out, "Content-MD5",
3010 ap_md5digest(r->pool, fd));
3013 rangestatus = ap_set_byterange(r);
3015 ap_send_http_header(r);
3017 if (!r->header_only) {
3018 apr_size_t length = r->finfo.size;
3019 apr_off_t offset = 0;
3020 apr_size_t nbytes = 0;
3023 ap_send_fd(fd, r, offset, length, &nbytes);
3026 while (ap_each_byterange(r, &offset, &length)) {
3027 if ((status = ap_send_fd(fd, r, offset, length, &nbytes)) != APR_SUCCESS) {
3028 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
3029 "error byteserving file: %s", r->filename);
3030 return HTTP_INTERNAL_SERVER_ERROR;
3036 #ifdef AP_USE_MMAP_FILES
3039 unsigned char *addr;
3040 apr_mmap_offset((void**)&addr, mm ,0);
3042 if (bld_content_md5) {
3043 apr_md5_ctx_t context;
3045 apr_MD5Init(&context);
3046 apr_MD5Update(&context, addr, (unsigned int)r->finfo.size);
3047 apr_table_setn(r->headers_out, "Content-MD5",
3048 ap_md5contextTo64(r->pool, &context));
3051 rangestatus = ap_set_byterange(r);
3052 ap_send_http_header(r);
3054 if (!r->header_only) {
3056 ap_send_mmap(mm, r, 0, r->finfo.size);
3061 while (ap_each_byterange(r, &offset, &length)) {
3062 ap_send_mmap(mm, r, offset, length);
3074 * This is a simple filter to coalesce many small buckets into one large
3078 * This implementation of coalesce_filter will only coalesce a single
3079 * contiguous string of coalesable buckets. It will not coalesce multiple
3080 * non-contiguous buckets. For example, if a brigade contains 10 small
3081 * buckets followed by a large bucket (or a pipe or file bucket) followed
3082 * by more small buckets, only the first 10 buckets will be coalesced.
3084 typedef struct COALESCE_FILTER_CTX {
3085 char *buf; /* Start of buffer */
3086 char *cur; /* Pointer to next location to write */
3087 apr_ssize_t cnt; /* Number of bytes put in buf */
3088 apr_ssize_t avail; /* Number of bytes available in the buf */
3089 } coalesce_filter_ctx_t;
3090 #define FILTER_BUFF_SIZE 8192
3091 #define MIN_BUCKET_SIZE 200
3092 static apr_status_t coalesce_filter(ap_filter_t *f, ap_bucket_brigade *b)
3095 apr_pool_t *p = f->r->pool;
3096 ap_bucket *e, *insert_before = NULL, *destroy_me = NULL;
3097 coalesce_filter_ctx_t *ctx = f->ctx;
3098 int pass_the_brigade = 0, insert_first = 0;
3101 f->ctx = ctx = apr_pcalloc(p, sizeof(coalesce_filter_ctx_t));
3102 ctx->avail = FILTER_BUFF_SIZE;
3109 /* Iterate across the buckets, coalescing the small buckets into a
3112 AP_BRIGADE_FOREACH(e, b) {
3114 ap_bucket_destroy(destroy_me);
3117 if (AP_BUCKET_IS_EOS(e) || AP_BUCKET_IS_FILE(e) ||
3118 AP_BUCKET_IS_PIPE(e) || AP_BUCKET_IS_FLUSH(e)) {
3119 pass_the_brigade = 1;
3124 rv = ap_bucket_read(e, &str, &n, 0);
3125 if (rv != APR_SUCCESS) {
3126 /* XXX: log error */
3129 if ((n < MIN_BUCKET_SIZE) && (n < ctx->avail)) {
3130 /* Coalesce this bucket into the buffer */
3131 if (ctx->buf == NULL) {
3132 ctx->buf = apr_palloc(p, FILTER_BUFF_SIZE);
3133 ctx->cur = ctx->buf;
3136 memcpy(ctx->cur, str, n);
3140 /* If this is the first bucket to be coalesced, don't remove it
3141 * from the brigade. Save it as a marker for where to insert
3142 * ctx->buf into the brigade when we're done.
3144 if (insert_before || insert_first){
3145 AP_BUCKET_REMOVE(e);
3152 else if (insert_before || insert_first) {
3153 /* This bucket was not able to be coalesced because it either
3154 * exceeds MIN_BUCKET_SIZE or its contents will not fit into
3155 * buf. We're done...
3157 pass_the_brigade = 1;
3161 /* If there is even a single bucket that cannot be coalesced,
3162 * then we must pass the brigade down to the next filter.
3164 pass_the_brigade = 1;
3170 ap_bucket_destroy(destroy_me);
3174 if (pass_the_brigade) {
3175 /* Insert ctx->buf into the correct spotin the brigade */
3177 e = ap_bucket_create_pool(ctx->buf, ctx->cnt, p);
3178 AP_BRIGADE_INSERT_HEAD(b, e);
3180 else if (insert_before) {
3181 e = ap_bucket_create_pool(ctx->buf, ctx->cnt, p);
3182 AP_BUCKET_INSERT_BEFORE(e, insert_before);
3183 AP_BUCKET_REMOVE(insert_before);
3184 ap_bucket_destroy(insert_before);
3185 insert_before = NULL;
3187 rv = ap_pass_brigade(f->next, b);
3188 if (rv != APR_SUCCESS) {
3189 /* XXX: Log the error */
3192 /* Get ctx->buf ready for the next brigade */
3194 ctx->cur = ctx->buf;
3196 ctx->avail = FILTER_BUFF_SIZE;
3200 if (insert_before) {
3201 AP_BUCKET_REMOVE(insert_before);
3202 ap_bucket_destroy(insert_before);
3204 /* The brigade should be empty now because all the buckets
3205 * were coalesced into the coalesce_filter buf
3212 * HTTP/1.1 chunked transfer encoding filter.
3214 static apr_status_t chunk_filter(ap_filter_t *f, ap_bucket_brigade *b)
3216 #define ASCII_CRLF "\015\012"
3217 #define ASCII_ZERO "\060"
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 ap_xlate_proto_to_ascii(chunk_hdr, hdr_len);
3283 e = ap_bucket_create_transient(chunk_hdr, hdr_len);
3284 AP_BRIGADE_INSERT_HEAD(b, e);
3287 * Insert the end-of-chunk CRLF before the EOS bucket, or
3288 * appended to the brigade
3290 e = ap_bucket_create_immortal(ASCII_CRLF, 2);
3292 AP_BUCKET_INSERT_BEFORE(eos, e);
3295 AP_BRIGADE_INSERT_TAIL(b, e);
3299 /* RFC 2616, Section 3.6.1
3301 * If there is an EOS bucket, then prefix it with:
3302 * 1) the last-chunk marker ("0" CRLF)
3304 * 3) the end-of-chunked body CRLF
3306 * If there is no EOS bucket, then do nothing.
3308 * XXX: it would be nice to combine this with the end-of-chunk
3309 * marker above, but this is a bit more straight-forward for
3313 /* XXX: (2) trailers ... does not yet exist */
3314 e = ap_bucket_create_immortal(ASCII_ZERO ASCII_CRLF /* <trailers> */ ASCII_CRLF, 5);
3315 AP_BUCKET_INSERT_BEFORE(eos, e);
3318 /* pass the brigade to the next filter. */
3319 rv = ap_pass_brigade(f->next, b);
3320 if (rv != APR_SUCCESS || eos != NULL) {
3328 static int core_input_filter(ap_filter_t *f, ap_bucket_brigade *b, ap_input_mode_t mode)
3332 if (!f->ctx) { /* If we haven't passed up the socket yet... */
3334 e = ap_bucket_create_socket(f->c->client_socket);
3335 AP_BRIGADE_INSERT_TAIL(b, e);
3339 /* Either some code lost track of the socket
3340 * bucket or we already found out that the
3347 /* Default filter. This filter should almost always be used. Its only job
3348 * is to send the headers if they haven't already been sent, and then send
3351 typedef struct CORE_OUTPUT_FILTER_CTX {
3352 ap_bucket_brigade *b;
3353 } core_output_filter_ctx_t;
3354 #define MAX_IOVEC_TO_WRITE 16
3355 static apr_status_t core_output_filter(ap_filter_t *f, ap_bucket_brigade *b)
3358 ap_bucket_brigade *more = NULL;
3359 apr_ssize_t bytes_sent = 0, nbytes;
3362 core_output_filter_ctx_t *ctx = f->ctx;
3364 apr_ssize_t nvec = 0;
3365 apr_ssize_t nvec_trailers= 0;
3366 struct iovec vec[MAX_IOVEC_TO_WRITE];
3367 struct iovec vec_trailers[MAX_IOVEC_TO_WRITE];
3369 apr_file_t *fd = NULL;
3370 apr_ssize_t flen = 0;
3371 apr_off_t foffset = 0;
3374 f->ctx = ctx = apr_pcalloc(c->pool, sizeof(core_output_filter_ctx_t));
3376 /* If we have a saved brigade, concatenate the new brigade to it */
3378 AP_BRIGADE_CONCAT(ctx->b, b);
3383 /* Hijack any bytes in BUFF and prepend it to the brigade. */
3384 if (c->client->outcnt) {
3385 e = ap_bucket_create_pool(c->client->outbase,
3386 c->client->outcnt, c->client->pool);
3387 c->client->outcnt = 0;
3388 AP_BRIGADE_INSERT_HEAD(b, e);
3391 /* Iterate over the brigade collecting iovecs */
3393 nbytes = 0; /* in case more points to another brigade */
3395 AP_BRIGADE_FOREACH(e, b) {
3396 if (AP_BUCKET_IS_EOS(e)) {
3399 else if (AP_BUCKET_IS_FILE(e)) {
3400 ap_bucket_file *a = e->data;
3401 /* Assume there is at most one AP_BUCKET_FILE in the brigade */
3404 foffset = a->offset;
3409 rv = ap_bucket_read(e, &str, &n, 0);
3413 vec[nvec].iov_base = (char*) str;
3414 vec[nvec].iov_len = n;
3418 /* The bucket is a trailer to a file bucket */
3419 vec_trailers[nvec_trailers].iov_base = (char*) str;
3420 vec_trailers[nvec_trailers].iov_len = n;
3426 if ((nvec == MAX_IOVEC_TO_WRITE) || (nvec_trailers == MAX_IOVEC_TO_WRITE)) {
3427 /* Split the brigade and break */
3428 if (AP_BUCKET_NEXT(e) != AP_BRIGADE_SENTINEL(b)) {
3429 more = ap_brigade_split(b, AP_BUCKET_NEXT(e));
3435 /* Completed iterating over the brigades, now determine if we want to
3436 * buffer the brigade or send the brigade out on the network
3438 if (!fd && (!more) && (nbytes < MIN_SIZE_TO_WRITE) && !AP_BUCKET_IS_EOS(e) && !AP_BUCKET_IS_FLUSH(e)) {
3439 ap_save_brigade(f, &ctx->b, &b);
3444 #if APR_HAS_SENDFILE
3445 apr_int32_t flags = 0;
3448 memset(&hdtr, '\0', sizeof(hdtr));
3450 hdtr.numheaders = nvec;
3453 if (nvec_trailers) {
3454 hdtr.numtrailers = nvec_trailers;
3455 hdtr.trailers = vec_trailers;
3457 #if APR_HAS_SENDFILE
3458 if (!c->keepalive) {
3459 /* Prepare the socket to be reused */
3460 flags |= APR_SENDFILE_DISCONNECT_SOCKET;
3463 rv = apr_sendfile(c->client_socket,
3464 fd, /* The file to send */
3465 &hdtr, /* Header and trailer iovecs */
3466 &foffset, /* Offset in file to begin sending from */
3469 bytes_sent = nbytes;
3471 /* If apr_sendfile() returns APR_ENOTIMPL, call send_the_file() to
3472 * loop on apr_read/apr_send to send the file. Our Windows binary
3473 * distributions (which work on Windows 9x/NT) are compiled on
3474 * Windows NT. TransmitFile is not available on Windows 95/98 and
3475 * we discover this at runtime when apr_sendfile() returns
3476 * APR_ENOTIMPL. Having apr_sendfile() return APR_ENOTIMPL seems
3477 * the cleanest way to handle this case.
3479 if (rv == APR_ENOTIMPL) {
3482 rv = send_the_file(c, fd, &hdtr, foffset, flen, &bytes_sent);
3484 #if APR_HAS_SENDFILE
3489 rv = writev_it_all(c->client_socket,
3491 nbytes, &bytes_sent);
3494 ap_brigade_destroy(b);
3495 if (rv != APR_SUCCESS) {
3496 /* XXX: log the error */
3498 ap_brigade_destroy(more);
3505 } /* end while () */
3510 static const handler_rec core_handlers[] = {
3511 { "*/*", default_handler },
3512 { "default-handler", default_handler },
3516 static void core_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp)
3518 ap_init_bucket_types(pconf);
3521 static void core_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3523 ap_set_version(pconf);
3526 static void core_open_logs(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3528 ap_open_logs(s, pconf);
3531 static const char *core_method(const request_rec *r)
3534 static unsigned short core_port(const request_rec *r)
3535 { return DEFAULT_HTTP_PORT; }
3537 static void core_insert_filter(request_rec *r)
3540 core_dir_config *conf = (core_dir_config *)
3541 ap_get_module_config(r->per_dir_config,
3543 char **items = (char **)conf->output_filters->elts;
3545 for (i = 0; i < conf->output_filters->nelts; i++) {
3546 char *foobar = items[i];
3547 ap_add_output_filter(foobar, NULL, r, r->connection);
3550 items = (char **)conf->input_filters->elts;
3551 for (i = 0; i < conf->input_filters->nelts; i++) {
3552 char *foobar = items[i];
3553 ap_add_input_filter(foobar, NULL, r, r->connection);
3557 static void register_hooks(void)
3559 ap_hook_pre_config(core_pre_config, NULL, NULL, AP_HOOK_REALLY_FIRST);
3560 ap_hook_post_config(core_post_config,NULL,NULL,AP_HOOK_REALLY_FIRST);
3561 ap_hook_translate_name(ap_core_translate,NULL,NULL,AP_HOOK_REALLY_LAST);
3562 ap_hook_pre_connection(ap_pre_http_connection,NULL,NULL,
3563 AP_HOOK_REALLY_LAST);
3564 ap_hook_process_connection(ap_process_http_connection,NULL,NULL,
3565 AP_HOOK_REALLY_LAST);
3566 ap_hook_http_method(core_method,NULL,NULL,AP_HOOK_REALLY_LAST);
3567 ap_hook_default_port(core_port,NULL,NULL,AP_HOOK_REALLY_LAST);
3568 ap_hook_open_logs(core_open_logs,NULL,NULL,AP_HOOK_MIDDLE);
3569 /* FIXME: I suspect we can eliminate the need for these - Ben */
3570 ap_hook_type_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3571 ap_hook_access_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3573 /* register the core's insert_filter hook and register core-provided
3576 ap_hook_insert_filter(core_insert_filter, NULL, NULL, AP_HOOK_MIDDLE);
3577 ap_register_input_filter("HTTP_IN", ap_http_filter, AP_FTYPE_CONNECTION);
3578 ap_register_input_filter("DECHUNK", ap_dechunk_filter, AP_FTYPE_TRANSCODE);
3579 ap_register_input_filter("CORE_IN", core_input_filter, AP_FTYPE_NETWORK);
3580 ap_register_output_filter("HTTP_HEADER", ap_http_header_filter, AP_FTYPE_HTTP_HEADER);
3581 ap_register_output_filter("CORE", core_output_filter, AP_FTYPE_NETWORK);
3582 ap_register_output_filter("SUBREQ_CORE", ap_sub_req_output_filter,
3584 ap_register_output_filter("CHUNK", chunk_filter, AP_FTYPE_TRANSCODE);
3585 ap_register_output_filter("COALESCE", coalesce_filter, AP_FTYPE_CONNECTION);
3588 AP_DECLARE_DATA module core_module = {
3589 STANDARD20_MODULE_STUFF,
3590 create_core_dir_config, /* create per-directory config structure */
3591 merge_core_dir_configs, /* merge per-directory config structures */
3592 create_core_server_config, /* create per-server config structure */
3593 merge_core_server_configs, /* merge per-server config structures */
3594 core_cmds, /* command apr_table_t */
3595 core_handlers, /* handlers */
3596 register_hooks /* register hooks */