1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * ====================================================================
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
60 #include "ap_config.h"
61 #include "apr_strings.h"
64 #include "http_config.h"
65 #include "http_core.h"
66 #include "http_protocol.h" /* For index_of_response(). Grump. */
67 #include "http_request.h"
68 #include "http_vhost.h"
69 #include "http_main.h" /* For the default_handler below... */
73 #include "apr_fnmatch.h"
74 #include "http_connection.h"
75 #include "ap_buckets.h"
76 #include "util_filter.h"
77 #include "util_ebcdic.h"
82 #ifdef HAVE_SYS_SOCKET_H
83 #include <sys/socket.h>
85 #ifdef HAVE_ARPA_INET_H
86 #include <arpa/inet.h>
92 /* Make sure we don't write less than 4096 bytes at any one time.
94 #define MIN_SIZE_TO_WRITE 9000
96 /* Allow Apache to use ap_mmap */
100 /* mmap support for static files based on ideas from John Heidemann's
101 * patch against 1.0.5. See
102 * <http://www.isi.edu/~johnh/SOFTWARE/APACHE/index.html>.
105 /* Files have to be at least this big before they're mmap()d. This is to deal
106 * with systems where the expense of doing an mmap() and an munmap() outweighs
107 * the benefit for small files. It shouldn't be set lower than 1.
109 #ifndef MMAP_THRESHOLD
111 #define MMAP_THRESHOLD (8*1024)
113 #define MMAP_THRESHOLD 1
115 #endif /* MMAP_THRESHOLD */
117 #define MMAP_LIMIT (4*1024*1024)
119 #endif /* USE_MMAP_FILES */
121 /* LimitXMLRequestBody handling */
122 #define AP_LIMIT_UNSET ((long) -1)
123 #define AP_DEFAULT_LIMIT_XML_BODY ((size_t)1000000)
125 /* Server core module... This module provides support for really basic
126 * server operations, including options and commands which control the
127 * operation of other modules. Consider this the bureaucracy module.
129 * The core module also defines handlers, etc., do handle just enough
130 * to allow a server with the core module ONLY to actually serve documents
131 * (though it slaps DefaultType on all of 'em); this was useful in testing,
132 * but may not be worth preserving.
134 * This file could almost be mod_core.c, except for the stuff which affects
135 * the http_conf_globals.
138 static void *create_core_dir_config(apr_pool_t *a, char *dir)
140 core_dir_config *conf;
142 conf = (core_dir_config *)apr_pcalloc(a, sizeof(core_dir_config));
143 if (!dir || dir[strlen(dir) - 1] == '/') {
146 else if (strncmp(dir, "proxy:", 6) == 0) {
147 conf->d = apr_pstrdup(a, dir);
150 conf->d = apr_pstrcat(a, dir, "/", NULL);
152 conf->d_is_fnmatch = conf->d ? (apr_is_fnmatch(conf->d) != 0) : 0;
153 conf->d_components = conf->d ? ap_count_dirs(conf->d) : 0;
155 conf->opts = dir ? OPT_UNSET : OPT_UNSET|OPT_ALL;
156 conf->opts_add = conf->opts_remove = OPT_NONE;
157 conf->override = dir ? OR_UNSET : OR_UNSET|OR_ALL;
159 conf->content_md5 = 2;
161 conf->use_canonical_name = USE_CANONICAL_NAME_UNSET;
163 conf->hostname_lookups = HOSTNAME_LOOKUP_UNSET;
164 conf->do_rfc1413 = DEFAULT_RFC1413 | 2; /* set bit 1 to indicate default */
165 conf->satisfy = SATISFY_NOSPEC;
168 conf->limit_cpu = NULL;
170 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
171 conf->limit_mem = NULL;
174 conf->limit_nproc = NULL;
177 conf->limit_req_body = 0;
178 conf->limit_xml_body = AP_LIMIT_UNSET;
179 conf->sec = apr_make_array(a, 2, sizeof(void *));
181 conf->script_interpreter_source = INTERPRETER_SOURCE_UNSET;
184 conf->server_signature = srv_sig_unset;
186 conf->add_default_charset = ADD_DEFAULT_CHARSET_UNSET;
187 conf->add_default_charset_name = DEFAULT_ADD_DEFAULT_CHARSET_NAME;
189 conf->filters = apr_make_array(a, 2, sizeof(void *));
190 conf->input_filters = apr_make_array(a, 2, sizeof(void *));
194 static void *merge_core_dir_configs(apr_pool_t *a, void *basev, void *newv)
196 core_dir_config *base = (core_dir_config *)basev;
197 core_dir_config *new = (core_dir_config *)newv;
198 core_dir_config *conf;
201 conf = (core_dir_config *)apr_palloc(a, sizeof(core_dir_config));
202 memcpy((char *)conf, (const char *)base, sizeof(core_dir_config));
203 if (base->response_code_strings) {
204 conf->response_code_strings =
205 apr_palloc(a, sizeof(*conf->response_code_strings)
207 memcpy(conf->response_code_strings, base->response_code_strings,
208 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
212 conf->d_is_fnmatch = new->d_is_fnmatch;
213 conf->d_components = new->d_components;
216 if (new->opts & OPT_UNSET) {
217 /* there was no explicit setting of new->opts, so we merge
218 * preserve the invariant (opts_add & opts_remove) == 0
220 conf->opts_add = (conf->opts_add & ~new->opts_remove) | new->opts_add;
221 conf->opts_remove = (conf->opts_remove & ~new->opts_add)
223 conf->opts = (conf->opts & ~conf->opts_remove) | conf->opts_add;
224 if ((base->opts & OPT_INCNOEXEC) && (new->opts & OPT_INCLUDES)) {
225 conf->opts = (conf->opts & ~OPT_INCNOEXEC) | OPT_INCLUDES;
229 /* otherwise we just copy, because an explicit opts setting
230 * overrides all earlier +/- modifiers
232 conf->opts = new->opts;
233 conf->opts_add = new->opts_add;
234 conf->opts_remove = new->opts_remove;
237 if (!(new->override & OR_UNSET)) {
238 conf->override = new->override;
240 if (new->ap_default_type) {
241 conf->ap_default_type = new->ap_default_type;
244 if (new->ap_auth_type) {
245 conf->ap_auth_type = new->ap_auth_type;
247 if (new->ap_auth_name) {
248 conf->ap_auth_name = new->ap_auth_name;
250 if (new->ap_requires) {
251 conf->ap_requires = new->ap_requires;
254 if (new->response_code_strings) {
255 if (conf->response_code_strings == NULL) {
256 conf->response_code_strings = apr_palloc(a,
257 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
258 memcpy(conf->response_code_strings, new->response_code_strings,
259 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
262 for (i = 0; i < RESPONSE_CODES; ++i) {
263 if (new->response_code_strings[i] != NULL) {
264 conf->response_code_strings[i]
265 = new->response_code_strings[i];
270 if (new->hostname_lookups != HOSTNAME_LOOKUP_UNSET) {
271 conf->hostname_lookups = new->hostname_lookups;
273 if ((new->do_rfc1413 & 2) == 0) {
274 conf->do_rfc1413 = new->do_rfc1413;
276 if ((new->content_md5 & 2) == 0) {
277 conf->content_md5 = new->content_md5;
279 if (new->use_canonical_name != USE_CANONICAL_NAME_UNSET) {
280 conf->use_canonical_name = new->use_canonical_name;
284 if (new->limit_cpu) {
285 conf->limit_cpu = new->limit_cpu;
288 #if defined(RLIMIT_DATA) || defined(RLIMIT_VMEM) || defined(RLIMIT_AS)
289 if (new->limit_mem) {
290 conf->limit_mem = new->limit_mem;
294 if (new->limit_nproc) {
295 conf->limit_nproc = new->limit_nproc;
299 if (new->limit_req_body) {
300 conf->limit_req_body = new->limit_req_body;
303 if (new->limit_xml_body != AP_LIMIT_UNSET)
304 conf->limit_xml_body = new->limit_xml_body;
306 conf->limit_xml_body = base->limit_xml_body;
308 conf->sec = apr_append_arrays(a, base->sec, new->sec);
310 if (new->satisfy != SATISFY_NOSPEC) {
311 conf->satisfy = new->satisfy;
315 if (new->script_interpreter_source != INTERPRETER_SOURCE_UNSET) {
316 conf->script_interpreter_source = new->script_interpreter_source;
320 if (new->server_signature != srv_sig_unset) {
321 conf->server_signature = new->server_signature;
324 if (new->add_default_charset != ADD_DEFAULT_CHARSET_UNSET) {
325 conf->add_default_charset = new->add_default_charset;
326 if (new->add_default_charset_name) {
327 conf->add_default_charset_name = new->add_default_charset_name;
330 conf->filters = apr_append_arrays(a, base->filters, new->filters);
331 conf->input_filters = apr_append_arrays(a, base->input_filters,
337 static void *create_core_server_config(apr_pool_t *a, server_rec *s)
339 core_server_config *conf;
340 int is_virtual = s->is_virtual;
342 conf = (core_server_config *)apr_pcalloc(a, sizeof(core_server_config));
344 conf->gprof_dir = NULL;
346 conf->access_name = is_virtual ? NULL : DEFAULT_ACCESS_FNAME;
347 conf->ap_document_root = is_virtual ? NULL : DOCUMENT_LOCATION;
348 conf->sec = apr_make_array(a, 40, sizeof(void *));
349 conf->sec_url = apr_make_array(a, 40, sizeof(void *));
354 static void *merge_core_server_configs(apr_pool_t *p, void *basev, void *virtv)
356 core_server_config *base = (core_server_config *)basev;
357 core_server_config *virt = (core_server_config *)virtv;
358 core_server_config *conf;
360 conf = (core_server_config *)apr_pcalloc(p, sizeof(core_server_config));
362 if (!conf->access_name) {
363 conf->access_name = base->access_name;
365 if (!conf->ap_document_root) {
366 conf->ap_document_root = base->ap_document_root;
368 conf->sec = apr_append_arrays(p, base->sec, virt->sec);
369 conf->sec_url = apr_append_arrays(p, base->sec_url, virt->sec_url);
374 /* Add per-directory configuration entry (for <directory> section);
375 * these are part of the core server config.
378 CORE_EXPORT(void) ap_add_per_dir_conf(server_rec *s, void *dir_config)
380 core_server_config *sconf = ap_get_module_config(s->module_config,
382 void **new_space = (void **)apr_push_array(sconf->sec);
384 *new_space = dir_config;
387 CORE_EXPORT(void) ap_add_per_url_conf(server_rec *s, void *url_config)
389 core_server_config *sconf = ap_get_module_config(s->module_config,
391 void **new_space = (void **)apr_push_array(sconf->sec_url);
393 *new_space = url_config;
396 CORE_EXPORT(void) ap_add_file_conf(core_dir_config *conf, void *url_config)
398 void **new_space = (void **)apr_push_array(conf->sec);
400 *new_space = url_config;
403 /* core_reorder_directories reorders the directory sections such that the
404 * 1-component sections come first, then the 2-component, and so on, finally
405 * followed by the "special" sections. A section is "special" if it's a regex,
406 * or if it doesn't start with / -- consider proxy: matching. All movements
407 * are in-order to preserve the ordering of the sections from the config files.
408 * See directory_walk().
411 #ifdef HAVE_DRIVE_LETTERS
412 #define IS_SPECIAL(entry_core) \
413 ((entry_core)->r != NULL \
414 || ((entry_core)->d[0] != '/' && (entry_core)->d[1] != ':'))
416 #define IS_SPECIAL(entry_core) \
417 ((entry_core)->r != NULL || (entry_core)->d[0] != '/')
420 /* We need to do a stable sort, qsort isn't stable. So to make it stable
421 * we'll be maintaining the original index into the list, and using it
422 * as the minor key during sorting. The major key is the number of
423 * components (where a "special" section has infinite components).
425 struct reorder_sort_rec {
430 static int reorder_sorter(const void *va, const void *vb)
432 const struct reorder_sort_rec *a = va;
433 const struct reorder_sort_rec *b = vb;
434 core_dir_config *core_a;
435 core_dir_config *core_b;
437 core_a = (core_dir_config *)ap_get_module_config(a->elt, &core_module);
438 core_b = (core_dir_config *)ap_get_module_config(b->elt, &core_module);
439 if (IS_SPECIAL(core_a)) {
440 if (!IS_SPECIAL(core_b)) {
444 else if (IS_SPECIAL(core_b)) {
448 /* we know they're both not special */
449 if (core_a->d_components < core_b->d_components) {
452 else if (core_a->d_components > core_b->d_components) {
456 /* Either they're both special, or they're both not special and have the
457 * same number of components. In any event, we now have to compare
459 return a->orig_index - b->orig_index;
462 void ap_core_reorder_directories(apr_pool_t *p, server_rec *s)
464 core_server_config *sconf;
465 apr_array_header_t *sec;
466 struct reorder_sort_rec *sortbin;
472 sconf = ap_get_module_config(s->module_config, &core_module);
475 elts = (void **)sec->elts;
477 /* we have to allocate tmp space to do a stable sort */
478 apr_create_pool(&tmp, p);
479 sortbin = apr_palloc(tmp, sec->nelts * sizeof(*sortbin));
480 for (i = 0; i < nelts; ++i) {
481 sortbin[i].orig_index = i;
482 sortbin[i].elt = elts[i];
485 qsort(sortbin, nelts, sizeof(*sortbin), reorder_sorter);
487 /* and now copy back to the original array */
488 for (i = 0; i < nelts; ++i) {
489 elts[i] = sortbin[i].elt;
492 apr_destroy_pool(tmp);
495 /*****************************************************************
497 * There are some elements of the core config structures in which
498 * other modules have a legitimate interest (this is ugly, but necessary
499 * to preserve NCSA back-compatibility). So, we have a bunch of accessors
503 API_EXPORT(int) ap_allow_options(request_rec *r)
505 core_dir_config *conf =
506 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
511 API_EXPORT(int) ap_allow_overrides(request_rec *r)
513 core_dir_config *conf;
514 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
517 return conf->override;
520 API_EXPORT(const char *) ap_auth_type(request_rec *r)
522 core_dir_config *conf;
524 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
526 return conf->ap_auth_type;
529 API_EXPORT(const char *) ap_auth_name(request_rec *r)
531 core_dir_config *conf;
533 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
535 return conf->ap_auth_name;
538 API_EXPORT(const char *) ap_default_type(request_rec *r)
540 core_dir_config *conf;
542 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
544 return conf->ap_default_type
545 ? conf->ap_default_type
546 : DEFAULT_CONTENT_TYPE;
549 API_EXPORT(const char *) ap_document_root(request_rec *r) /* Don't use this! */
551 core_server_config *conf;
553 conf = (core_server_config *)ap_get_module_config(r->server->module_config,
555 return conf->ap_document_root;
558 API_EXPORT(const apr_array_header_t *) ap_requires(request_rec *r)
560 core_dir_config *conf;
562 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
564 return conf->ap_requires;
567 API_EXPORT(int) ap_satisfies(request_rec *r)
569 core_dir_config *conf;
571 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
574 return conf->satisfy;
577 /* Should probably just get rid of this... the only code that cares is
578 * part of the core anyway (and in fact, it isn't publicised to other
582 char *ap_response_code_string(request_rec *r, int error_index)
584 core_dir_config *conf;
586 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
589 if (conf->response_code_strings == NULL) {
592 return conf->response_code_strings[error_index];
596 /* Code from Harald Hanche-Olsen <hanche@imf.unit.no> */
597 static apr_inline void do_double_reverse (conn_rec *conn)
599 struct hostent *hptr;
601 if (conn->double_reverse) {
605 if (conn->remote_host == NULL || conn->remote_host[0] == '\0') {
606 /* single reverse failed, so don't bother */
607 conn->double_reverse = -1;
610 hptr = gethostbyname(conn->remote_host);
614 for (haddr = hptr->h_addr_list; *haddr; haddr++) {
615 if (((struct in_addr *)(*haddr))->s_addr
616 == conn->remote_addr.sin_addr.s_addr) {
617 conn->double_reverse = 1;
622 conn->double_reverse = -1;
625 API_EXPORT(const char *) ap_get_remote_host(conn_rec *conn, void *dir_config,
628 struct in_addr *iaddr;
629 struct hostent *hptr;
630 int hostname_lookups;
632 /* If we haven't checked the host name, and we want to */
635 ((core_dir_config *)ap_get_module_config(dir_config, &core_module))
637 if (hostname_lookups == HOSTNAME_LOOKUP_UNSET) {
638 hostname_lookups = HOSTNAME_LOOKUP_OFF;
643 hostname_lookups = HOSTNAME_LOOKUP_OFF;
646 if (type != REMOTE_NOLOOKUP
647 && conn->remote_host == NULL
648 && (type == REMOTE_DOUBLE_REV
649 || hostname_lookups != HOSTNAME_LOOKUP_OFF)) {
650 iaddr = &(conn->remote_addr.sin_addr);
651 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr), AF_INET);
653 conn->remote_host = apr_pstrdup(conn->pool, (void *)hptr->h_name);
654 ap_str_tolower(conn->remote_host);
656 if (hostname_lookups == HOSTNAME_LOOKUP_DOUBLE) {
657 do_double_reverse(conn);
658 if (conn->double_reverse != 1) {
659 conn->remote_host = NULL;
663 /* if failed, set it to the NULL string to indicate error */
664 if (conn->remote_host == NULL) {
665 conn->remote_host = "";
668 if (type == REMOTE_DOUBLE_REV) {
669 do_double_reverse(conn);
670 if (conn->double_reverse == -1) {
676 * Return the desired information; either the remote DNS name, if found,
677 * or either NULL (if the hostname was requested) or the IP address
678 * (if any identifier was requested).
680 if (conn->remote_host != NULL && conn->remote_host[0] != '\0') {
681 return conn->remote_host;
684 if (type == REMOTE_HOST || type == REMOTE_DOUBLE_REV) {
688 return conn->remote_ip;
693 API_EXPORT(const char *) ap_get_remote_logname(request_rec *r)
695 core_dir_config *dir_conf;
697 if (r->connection->remote_logname != NULL) {
698 return r->connection->remote_logname;
701 /* If we haven't checked the identity, and we want to */
702 dir_conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
705 if (dir_conf->do_rfc1413 & 1) {
706 return ap_rfc1413(r->connection, r->server);
713 /* There are two options regarding what the "name" of a server is. The
714 * "canonical" name as defined by ServerName and Port, or the "client's
715 * name" as supplied by a possible Host: header or full URI. We never
716 * trust the port passed in the client's headers, we always use the
717 * port of the actual socket.
719 * The DNS option to UseCanonicalName causes this routine to do a
720 * reverse lookup on the local IP address of the connectiona and use
721 * that for the ServerName. This makes its value more reliable while
722 * at the same time allowing Demon's magic virtual hosting to work.
723 * The assumption is that DNS lookups are sufficiently quick...
726 API_EXPORT(const char *) ap_get_server_name(request_rec *r)
728 conn_rec *conn = r->connection;
731 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
734 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF) {
735 return r->hostname ? r->hostname : r->server->server_hostname;
737 if (d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
738 if (conn->local_host == NULL) {
739 struct in_addr *iaddr;
740 struct hostent *hptr;
741 iaddr = &(conn->local_addr.sin_addr);
742 hptr = gethostbyaddr((char *)iaddr, sizeof(struct in_addr),
745 conn->local_host = apr_pstrdup(conn->pool,
746 (void *)hptr->h_name);
747 ap_str_tolower(conn->local_host);
750 conn->local_host = apr_pstrdup(conn->pool,
751 r->server->server_hostname);
754 return conn->local_host;
757 return r->server->server_hostname;
760 API_EXPORT(unsigned) ap_get_server_port(const request_rec *r)
764 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
766 port = r->server->port ? r->server->port : ap_default_port(r);
768 if (d->use_canonical_name == USE_CANONICAL_NAME_OFF
769 || d->use_canonical_name == USE_CANONICAL_NAME_DNS) {
770 return r->hostname ? ntohs(r->connection->local_addr.sin_port)
777 API_EXPORT(char *) ap_construct_url(apr_pool_t *p, const char *uri,
780 unsigned port = ap_get_server_port(r);
781 const char *host = ap_get_server_name(r);
783 if (ap_is_default_port(port, r)) {
784 return apr_pstrcat(p, ap_http_method(r), "://", host, uri, NULL);
786 return apr_psprintf(p, "%s://%s:%u%s", ap_http_method(r), host, port, uri);
789 API_EXPORT(unsigned long) ap_get_limit_req_body(const request_rec *r)
792 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
794 return d->limit_req_body;
798 static apr_status_t get_win32_registry_default_value(apr_pool_t *p, HKEY hkey,
805 DWORD result = RegOpenKeyEx(hkey, relativepath, 0,
806 KEY_QUERY_VALUE, &hkeyOpen);
808 if (result != ERROR_SUCCESS)
809 return APR_FROM_OS_ERROR(result);
811 /* Read to NULL buffer to determine value size */
812 result = RegQueryValueEx(hkeyOpen, "", 0, &type, NULL, &size);
814 if (result == ERROR_SUCCESS) {
815 if ((size < 2) || (type != REG_SZ && type != REG_EXPAND_SZ)) {
816 result = ERROR_INVALID_PARAMETER;
819 *value = apr_palloc(p, size);
820 /* Read value based on size query above */
821 result = RegQueryValueEx(hkeyOpen, "", 0, &type, *value, &size);
825 /* TODO: This might look fine, but we need to provide some warning
826 * somewhere that some environment variables may -not- be translated,
827 * seeing as we may have chopped the environment table down somewhat.
829 if ((result == ERROR_SUCCESS) && (type == REG_EXPAND_SZ))
832 size = ExpandEnvironmentStrings(tmp, *value, 0);
834 *value = apr_palloc(p, size);
835 size = ExpandEnvironmentStrings(tmp, *value, size);
839 RegCloseKey(hkeyOpen);
840 return APR_FROM_OS_ERROR(result);
843 static char* get_interpreter_from_win32_registry(apr_pool_t *p, const char* ext,
844 char** arguments, int strict)
846 char execcgi_path[] = "SHELL\\EXECCGI\\COMMAND";
847 char execopen_path[] = "SHELL\\OPEN\\COMMAND";
848 char typeName[MAX_PATH];
849 int cmdOfName = FALSE;
861 * Future optimization:
862 * When the registry is successfully searched, store the strings for
863 * interpreter and arguments in an ext hash to speed up subsequent look-ups
866 /* Open the key associated with the script filetype extension */
867 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, ext, 0, KEY_QUERY_VALUE,
870 if (result != ERROR_SUCCESS)
873 /* Retrieve the name of the script filetype extension */
874 size = sizeof(typeName);
875 result = RegQueryValueEx(hkeyType, "", NULL, &type, typeName, &size);
877 if (result == ERROR_SUCCESS && type == REG_SZ && typeName[0]) {
878 /* Open the key associated with the script filetype extension */
879 result = RegOpenKeyEx(HKEY_CLASSES_ROOT, typeName, 0,
880 KEY_QUERY_VALUE, &hkeyName);
882 if (result == ERROR_SUCCESS)
886 /* Open the key for the script command path by:
888 * 1) the 'named' filetype key for ExecCGI/Command
889 * 2) the extension's type key for ExecCGI/Command
891 * and if the strict arg is false, then continue trying:
893 * 3) the 'named' filetype key for Open/Command
894 * 4) the extension's type key for Open/Command
898 result = get_win32_registry_default_value(p, hkeyName,
899 execcgi_path, &buffer);
902 if (!cmdOfName || (result != ERROR_SUCCESS)) {
903 result = get_win32_registry_default_value(p, hkeyType,
904 execcgi_path, &buffer);
907 if (!strict && cmdOfName && (result != ERROR_SUCCESS)) {
908 result = get_win32_registry_default_value(p, hkeyName,
909 execopen_path, &buffer);
912 if (!strict && (result != ERROR_SUCCESS)) {
913 result = get_win32_registry_default_value(p, hkeyType,
914 execopen_path, &buffer);
918 RegCloseKey(hkeyName);
920 RegCloseKey(hkeyType);
922 if (result != ERROR_SUCCESS)
926 * The canonical way shell command entries are entered in the Win32
927 * registry is as follows:
928 * shell [options] "%1" [args]
930 * shell - full path name to interpreter or shell to run.
931 * E.g., c:\usr\local\ntreskit\perl\bin\perl.exe
932 * options - optional switches
934 * "%1" - Place holder for file to run the shell against.
936 * options - additional arguments
939 * If we find a %1 or a quoted %1, lop off the remainder to arguments.
941 if (buffer && *buffer) {
942 if ((s = strstr(buffer, "\"%1")))
947 else if ((s = strstr(buffer, "%1")))
950 *arguments = buffer + 2;
953 *arguments = strchr(buffer, '\0');
954 while (**arguments && isspace(**arguments))
961 API_EXPORT (file_type_e) ap_get_win32_interpreter(const request_rec *r,
971 file_type_e fileType = eFileTypeUNKNOWN;
973 char *exename = NULL;
975 d = (core_dir_config *)ap_get_module_config(r->per_dir_config,
978 /* Find the file extension */
979 exename = strrchr(r->filename, '/');
981 exename = strrchr(r->filename, '\\');
984 exename = r->filename;
989 ext = strrchr(exename, '.');
991 if (ext && (!strcasecmp(ext,".bat") || !strcasecmp(ext,".cmd")))
993 char *comspec = getenv("COMSPEC");
995 *interpreter = apr_pstrcat(r->pool, "\"", comspec, "\" /c ", NULL);
996 return eFileTypeSCRIPT;
998 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
999 "Failed to start a '%s' file as a script." APR_EOL_STR
1000 "\tCOMSPEC variable is missing from the environment.", ext);
1001 return eFileTypeUNKNOWN;
1004 /* If the file has an extension and it is not .com and not .exe and
1005 * we've been instructed to search the registry, then do it!
1007 if (ext && strcasecmp(ext,".exe") && strcasecmp(ext,".com") &&
1008 (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY ||
1009 d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT)) {
1010 /* Check the registry */
1011 int strict = (d->script_interpreter_source
1012 == INTERPRETER_SOURCE_REGISTRY_STRICT);
1013 *interpreter = get_interpreter_from_win32_registry(r->pool, ext,
1016 return eFileTypeSCRIPT;
1017 else if (d->script_interpreter_source == INTERPRETER_SOURCE_REGISTRY_STRICT) {
1018 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1019 "ScriptInterpreterSource config directive set to \"registry-strict\"." APR_EOL_STR
1020 "\tInterpreter not found for files of type '%s'.", ext);
1021 return eFileTypeUNKNOWN;
1025 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_INFO, 0, r->server,
1026 "ScriptInterpreterSource config directive set to \"registry\"." APR_EOL_STR
1027 "\tInterpreter not found for files of type '%s', "
1028 "trying \"script\" method...", ext);
1032 /* Need to peek into the file figure out what it really is... */
1033 hFile = CreateFile(r->filename, GENERIC_READ, FILE_SHARE_READ, NULL,
1034 OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
1035 if (hFile == INVALID_HANDLE_VALUE) {
1036 return eFileTypeUNKNOWN;
1038 bResult = ReadFile(hFile, (void*) &buffer, sizeof(buffer) - 1,
1040 if (!bResult || (nBytesRead == 0)) {
1041 ap_log_rerror(APLOG_MARK, APLOG_ERR, GetLastError(), r,
1042 "ReadFile(%s) failed", r->filename);
1044 return eFileTypeUNKNOWN;
1047 buffer[nBytesRead] = '\0';
1049 /* Script or executable, that is the question... */
1050 if ((buffer[0] == '#') && (buffer[1] == '!')) {
1051 /* Assuming file is a script since it starts with a shebang */
1052 fileType = eFileTypeSCRIPT;
1053 for (i = 2; i < sizeof(buffer); i++) {
1054 if ((buffer[i] == '\r')
1055 || (buffer[i] == '\n')) {
1060 for (i = 2; buffer[i] == ' ' ; ++i)
1062 *interpreter = apr_pstrdup(r->pool, buffer + i );
1065 /* Not a script, is it an executable? */
1066 IMAGE_DOS_HEADER *hdr = (IMAGE_DOS_HEADER*)buffer;
1067 if ((nBytesRead >= sizeof(IMAGE_DOS_HEADER)) && (hdr->e_magic == IMAGE_DOS_SIGNATURE)) {
1068 if (hdr->e_lfarlc < 0x40)
1069 fileType = eFileTypeEXE16;
1071 fileType = eFileTypeEXE32;
1074 fileType = eFileTypeUNKNOWN;
1081 /*****************************************************************
1083 * Commands... this module handles almost all of the NCSA httpd.conf
1084 * commands, but most of the old srm.conf is in the the modules.
1088 /* returns a parent if it matches the given directive */
1089 static const ap_directive_t * find_parent(const ap_directive_t *dirp,
1092 while (dirp->parent != NULL) {
1093 dirp = dirp->parent;
1094 /* ### it would be nice to have atom-ized directives */
1095 if (strcasecmp(dirp->directive, what) == 0)
1101 API_EXPORT(const char *) ap_check_cmd_context(cmd_parms *cmd,
1104 const char *gt = (cmd->cmd->name[0] == '<'
1105 && cmd->cmd->name[strlen(cmd->cmd->name)-1] != '>')
1107 const ap_directive_t *found;
1109 if ((forbidden & NOT_IN_VIRTUALHOST) && cmd->server->is_virtual) {
1110 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1111 " cannot occur within <VirtualHost> section", NULL);
1114 if ((forbidden & NOT_IN_LIMIT) && cmd->limited != -1) {
1115 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1116 " cannot occur within <Limit> section", NULL);
1119 if ((forbidden & NOT_IN_DIR_LOC_FILE) == NOT_IN_DIR_LOC_FILE
1120 && cmd->path != NULL) {
1121 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1122 " cannot occur within <Directory/Location/Files> "
1126 if (((forbidden & NOT_IN_DIRECTORY)
1127 && ((found = find_parent(cmd->directive, "<Directory"))
1128 || (found = find_parent(cmd->directive, "<DirectoryMatch"))))
1129 || ((forbidden & NOT_IN_LOCATION)
1130 && ((found = find_parent(cmd->directive, "<Location"))
1131 || (found = find_parent(cmd->directive, "<LocationMatch"))))
1132 || ((forbidden & NOT_IN_FILES)
1133 && ((found = find_parent(cmd->directive, "<Files"))
1134 || (found = find_parent(cmd->directive, "<FilesMatch"))))) {
1135 return apr_pstrcat(cmd->pool, cmd->cmd->name, gt,
1136 " cannot occur within ", found->directive,
1143 static const char *set_access_name(cmd_parms *cmd, void *dummy,
1146 void *sconf = cmd->server->module_config;
1147 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1149 const char *err = ap_check_cmd_context(cmd,
1150 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1155 conf->access_name = apr_pstrdup(cmd->pool, arg);
1160 static const char *set_gprof_dir(cmd_parms *cmd, void *dummy, char *arg)
1162 void *sconf = cmd->server->module_config;
1163 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1165 const char *err = ap_check_cmd_context(cmd,
1166 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1171 conf->gprof_dir = apr_pstrdup(cmd->pool, arg);
1176 static const char *set_add_default_charset(cmd_parms *cmd,
1177 void *d_, const char *arg)
1179 core_dir_config *d=d_;
1181 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1185 if (!strcasecmp(arg, "Off")) {
1186 d->add_default_charset = ADD_DEFAULT_CHARSET_OFF;
1188 else if (!strcasecmp(arg, "On")) {
1189 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1190 d->add_default_charset_name = DEFAULT_ADD_DEFAULT_CHARSET_NAME;
1193 d->add_default_charset = ADD_DEFAULT_CHARSET_ON;
1194 d->add_default_charset_name = arg;
1199 static const char *set_document_root(cmd_parms *cmd, void *dummy,
1202 void *sconf = cmd->server->module_config;
1203 core_server_config *conf = ap_get_module_config(sconf, &core_module);
1205 const char *err = ap_check_cmd_context(cmd,
1206 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1211 arg = ap_os_canonical_filename(cmd->pool, arg);
1212 if (/* TODO: ap_configtestonly && ap_docrootcheck && */ !ap_is_directory(arg)) {
1213 if (cmd->server->is_virtual) {
1214 ap_log_error(APLOG_MARK, APLOG_STARTUP | APLOG_NOERRNO, 0, NULL,
1215 "Warning: DocumentRoot [%s] does not exist",
1219 return "DocumentRoot must be a directory";
1223 conf->ap_document_root = arg;
1227 API_EXPORT(void) ap_custom_response(request_rec *r, int status, char *string)
1229 core_dir_config *conf =
1230 ap_get_module_config(r->per_dir_config, &core_module);
1233 if(conf->response_code_strings == NULL) {
1234 conf->response_code_strings =
1235 apr_pcalloc(r->pool,
1236 sizeof(*conf->response_code_strings) *
1240 idx = ap_index_of_response(status);
1242 conf->response_code_strings[idx] =
1243 ((ap_is_url(string) || (*string == '/')) && (*string != '"')) ?
1244 apr_pstrdup(r->pool, string) : apr_pstrcat(r->pool, "\"", string, NULL);
1247 static const char *set_error_document(cmd_parms *cmd, void *conf_,
1248 const char *errno_str, const char *msg)
1250 core_dir_config *conf=conf_;
1251 int error_number, index_number, idx500;
1252 enum { MSG, LOCAL_PATH, REMOTE_PATH } what = MSG;
1254 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1259 /* 1st parameter should be a 3 digit number, which we recognize;
1260 * convert it into an array index
1262 error_number = atoi(errno_str);
1263 idx500 = ap_index_of_response(HTTP_INTERNAL_SERVER_ERROR);
1265 if (error_number == HTTP_INTERNAL_SERVER_ERROR) {
1266 index_number = idx500;
1268 else if ((index_number = ap_index_of_response(error_number)) == idx500) {
1269 return apr_pstrcat(cmd->pool, "Unsupported HTTP response code ",
1273 /* Heuristic to determine second argument. */
1274 if (ap_strchr_c(msg,' '))
1276 else if (msg[0] == '/')
1278 else if (ap_is_url(msg))
1283 /* The entry should be ignored if it is a full URL for a 401 error */
1285 if (error_number == 401 && what == REMOTE_PATH) {
1286 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_NOTICE, 0, cmd->server,
1287 "cannot use a full URL in a 401 ErrorDocument "
1288 "directive --- ignoring!");
1290 else { /* Store it... */
1291 if (conf->response_code_strings == NULL) {
1292 conf->response_code_strings =
1293 apr_pcalloc(cmd->pool,
1294 sizeof(*conf->response_code_strings) * RESPONSE_CODES);
1296 /* hack. Prefix a " if it is a msg; as that is what
1297 * http_protocol.c relies on to distinguish between
1298 * a msg and a (local) path.
1300 conf->response_code_strings[index_number] = (what == MSG) ?
1301 apr_pstrcat(cmd->pool, "\"",msg,NULL) :
1302 apr_pstrdup(cmd->pool, msg);
1308 static const char *set_override(cmd_parms *cmd, void *d_, const char *l)
1310 core_dir_config *d=d_;
1313 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1318 d->override = OR_NONE;
1320 w = ap_getword_conf(cmd->pool, &l);
1321 if (!strcasecmp(w, "Limit")) {
1322 d->override |= OR_LIMIT;
1324 else if (!strcasecmp(w, "Options")) {
1325 d->override |= OR_OPTIONS;
1327 else if (!strcasecmp(w, "FileInfo")) {
1328 d->override |= OR_FILEINFO;
1330 else if (!strcasecmp(w, "AuthConfig")) {
1331 d->override |= OR_AUTHCFG;
1333 else if (!strcasecmp(w, "Indexes")) {
1334 d->override |= OR_INDEXES;
1336 else if (!strcasecmp(w, "None")) {
1337 d->override = OR_NONE;
1339 else if (!strcasecmp(w, "All")) {
1340 d->override = OR_ALL;
1343 return apr_pstrcat(cmd->pool, "Illegal override option ", w, NULL);
1345 d->override &= ~OR_UNSET;
1351 static const char *set_options(cmd_parms *cmd, void *d_, const char *l)
1353 core_dir_config *d=d_;
1354 allow_options_t opt;
1359 char *w = ap_getword_conf(cmd->pool, &l);
1362 if (*w == '+' || *w == '-') {
1370 if (!strcasecmp(w, "Indexes")) {
1373 else if (!strcasecmp(w, "Includes")) {
1376 else if (!strcasecmp(w, "IncludesNOEXEC")) {
1377 opt = (OPT_INCLUDES | OPT_INCNOEXEC);
1379 else if (!strcasecmp(w, "FollowSymLinks")) {
1380 opt = OPT_SYM_LINKS;
1382 else if (!strcasecmp(w, "SymLinksIfOwnerMatch")) {
1383 opt = OPT_SYM_OWNER;
1385 else if (!strcasecmp(w, "execCGI")) {
1388 else if (!strcasecmp(w, "MultiViews")) {
1391 else if (!strcasecmp(w, "RunScripts")) { /* AI backcompat. Yuck */
1392 opt = OPT_MULTI|OPT_EXECCGI;
1394 else if (!strcasecmp(w, "None")) {
1397 else if (!strcasecmp(w, "All")) {
1401 return apr_pstrcat(cmd->pool, "Illegal option ", w, NULL);
1404 /* we ensure the invariant (d->opts_add & d->opts_remove) == 0 */
1405 if (action == '-') {
1406 d->opts_remove |= opt;
1407 d->opts_add &= ~opt;
1410 else if (action == '+') {
1412 d->opts_remove &= ~opt;
1423 static const char *satisfy(cmd_parms *cmd, void *c_, const char *arg)
1425 core_dir_config *c=c_;
1427 if (!strcasecmp(arg, "all")) {
1428 c->satisfy = SATISFY_ALL;
1430 else if (!strcasecmp(arg, "any")) {
1431 c->satisfy = SATISFY_ANY;
1434 return "Satisfy either 'any' or 'all'.";
1439 static const char *require(cmd_parms *cmd, void *c_, const char *arg)
1442 core_dir_config *c=c_;
1444 if (!c->ap_requires) {
1445 c->ap_requires = apr_make_array(cmd->pool, 2, sizeof(require_line));
1447 r = (require_line *)apr_push_array(c->ap_requires);
1448 r->requirement = apr_pstrdup(cmd->pool, arg);
1449 r->method_mask = cmd->limited;
1453 CORE_EXPORT_NONSTD(const char *) ap_limit_section(cmd_parms *cmd, void *dummy,
1455 const char *limited_methods = ap_getword(cmd->pool, &arg, '>');
1456 void *tog = cmd->cmd->cmd_data;
1460 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1465 while (limited_methods[0]) {
1466 char *method = ap_getword_conf(cmd->pool, &limited_methods);
1467 int methnum = ap_method_number_of(method);
1469 if (methnum == M_TRACE && !tog) {
1470 return "TRACE cannot be controlled by <Limit>";
1472 else if (methnum == M_INVALID) {
1474 register int i, j, k;
1477 * Deal with <Limit> by adding the method to the list.
1480 if (cmd->limited_xmethods == NULL) {
1481 cmd->limited_xmethods = apr_make_array(cmd->pool, 2,
1484 xmethod = (char **) apr_push_array(cmd->limited_xmethods);
1485 *xmethod = apr_pstrdup(cmd->pool, method);
1488 * <LimitExcept>, so remove any/all occurrences of the method
1489 * in the extension array.
1491 else if ((cmd->limited_xmethods != NULL)
1492 && (cmd->limited_xmethods->nelts != 0)) {
1493 xmethod = (char **) cmd->limited_xmethods->elts;
1494 for (i = 0; i < cmd->limited_xmethods->nelts; ) {
1495 if (strcmp(xmethod[i], method) == 0) {
1496 for (j = i, k = i + 1;
1497 k < cmd->limited_xmethods->nelts;
1499 xmethod[j] = xmethod[k];
1501 cmd->limited_xmethods->nelts--;
1506 limited |= (1 << methnum);
1509 /* Killing two features with one function,
1510 * if (tog == NULL) <Limit>, else <LimitExcept>
1512 cmd->limited = tog ? ~limited : limited;
1514 errmsg = ap_walk_config(cmd->directive->first_child, cmd, cmd->context);
1521 /* We use this in <DirectoryMatch> and <FilesMatch>, to ensure that
1522 * people don't get bitten by wrong-cased regex matches
1526 #define USE_ICASE REG_ICASE
1532 * Report a missing-'>' syntax error.
1534 static char *unclosed_directive(cmd_parms *cmd)
1536 return apr_pstrcat(cmd->pool, cmd->cmd->name,
1537 "> directive missing closing '>'", NULL);
1540 static const char *dirsection(cmd_parms *cmd, void *mconfig, const char *arg)
1543 const char *endp = ap_strrchr_c(arg, '>');
1544 int old_overrides = cmd->override;
1545 char *old_path = cmd->path;
1546 core_dir_config *conf;
1547 void *new_dir_conf = ap_create_per_dir_config(cmd->pool);
1549 const command_rec *thiscmd = cmd->cmd;
1551 const char *err = ap_check_cmd_context(cmd,
1552 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1558 return unclosed_directive(cmd);
1561 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1563 cmd->path = ap_getword_conf(cmd->pool, &arg);
1564 cmd->override = OR_ALL|ACCESS_CONF;
1566 if (thiscmd->cmd_data) { /* <DirectoryMatch> */
1567 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1569 else if (!strcmp(cmd->path, "~")) {
1570 cmd->path = ap_getword_conf(cmd->pool, &arg);
1571 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1574 /* Ensure that the pathname is canonical */
1575 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1578 /* initialize our config and fetch it */
1579 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_dir_conf,
1582 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_dir_conf);
1588 ap_add_per_dir_conf(cmd->server, new_dir_conf);
1591 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1592 "> arguments not (yet) supported.", NULL);
1595 cmd->path = old_path;
1596 cmd->override = old_overrides;
1601 static const char *urlsection(cmd_parms *cmd, void *mconfig, const char *arg)
1604 const char *endp = ap_strrchr_c(arg, '>');
1605 int old_overrides = cmd->override;
1606 char *old_path = cmd->path;
1607 core_dir_config *conf;
1609 const command_rec *thiscmd = cmd->cmd;
1611 void *new_url_conf = ap_create_per_dir_config(cmd->pool);
1613 const char *err = ap_check_cmd_context(cmd,
1614 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1620 return unclosed_directive(cmd);
1623 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1625 cmd->path = ap_getword_conf(cmd->pool, &arg);
1626 cmd->override = OR_ALL|ACCESS_CONF;
1628 if (thiscmd->cmd_data) { /* <LocationMatch> */
1629 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1631 else if (!strcmp(cmd->path, "~")) {
1632 cmd->path = ap_getword_conf(cmd->pool, &arg);
1633 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED);
1636 /* initialize our config and fetch it */
1637 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_url_conf,
1640 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_url_conf);
1644 conf->d = apr_pstrdup(cmd->pool, cmd->path); /* No mangling, please */
1645 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1648 ap_add_per_url_conf(cmd->server, new_url_conf);
1651 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1652 "> arguments not (yet) supported.", NULL);
1655 cmd->path = old_path;
1656 cmd->override = old_overrides;
1661 static const char *filesection(cmd_parms *cmd, void *mconfig, const char *arg)
1664 const char *endp = ap_strrchr_c(arg, '>');
1665 int old_overrides = cmd->override;
1666 char *old_path = cmd->path;
1667 core_dir_config *conf;
1669 const command_rec *thiscmd = cmd->cmd;
1670 core_dir_config *c=mconfig;
1672 void *new_file_conf = ap_create_per_dir_config(cmd->pool);
1674 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT|NOT_IN_LOCATION);
1680 return unclosed_directive(cmd);
1683 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1685 cmd->path = ap_getword_conf(cmd->pool, &arg);
1686 /* Only if not an .htaccess file */
1688 cmd->override = OR_ALL|ACCESS_CONF;
1691 if (thiscmd->cmd_data) { /* <FilesMatch> */
1692 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1694 else if (!strcmp(cmd->path, "~")) {
1695 cmd->path = ap_getword_conf(cmd->pool, &arg);
1696 r = ap_pregcomp(cmd->pool, cmd->path, REG_EXTENDED|USE_ICASE);
1699 /* Ensure that the pathname is canonical */
1700 cmd->path = ap_os_canonical_filename(cmd->pool, cmd->path);
1703 /* initialize our config and fetch it */
1704 conf = (core_dir_config *)ap_set_config_vectors(cmd, new_file_conf,
1707 errmsg = ap_walk_config(cmd->directive->first_child, cmd, new_file_conf);
1711 conf->d = cmd->path;
1712 conf->d_is_fnmatch = apr_is_fnmatch(conf->d) != 0;
1715 ap_add_file_conf(c, new_file_conf);
1718 return apr_pstrcat(cmd->pool, "Multiple ", thiscmd->name,
1719 "> arguments not (yet) supported.", NULL);
1722 cmd->path = old_path;
1723 cmd->override = old_overrides;
1728 static const char *start_ifmod(cmd_parms *cmd, void *mconfig, const char *arg)
1730 const char *endp = ap_strrchr_c(arg, '>');
1731 int not = (arg[0] == '!');
1735 return unclosed_directive(cmd);
1738 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1744 found = ap_find_linked_module(arg);
1746 if ((!not && found) || (not && !found)) {
1747 ap_directive_t *parent = NULL;
1748 ap_directive_t *current = NULL;
1751 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1752 ¤t, &parent, "<IfModule");
1753 *(ap_directive_t **)mconfig = current;
1757 *(ap_directive_t **)mconfig = NULL;
1758 return ap_soak_end_container(cmd, "<IfModule");
1762 API_EXPORT(int) ap_exists_config_define(const char *name)
1767 defines = (char **)ap_server_config_defines->elts;
1768 for (i = 0; i < ap_server_config_defines->nelts; i++) {
1769 if (strcmp(defines[i], name) == 0) {
1776 static const char *start_ifdefine(cmd_parms *cmd, void *dummy, const char *arg)
1782 endp = ap_strrchr_c(arg, '>');
1784 return unclosed_directive(cmd);
1787 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1789 if (arg[0] == '!') {
1794 defined = ap_exists_config_define(arg);
1795 if ((!not && defined) || (not && !defined)) {
1796 ap_directive_t *parent = NULL;
1797 ap_directive_t *current = NULL;
1800 retval = ap_build_cont_config(cmd->pool, cmd->temp_pool, cmd,
1801 ¤t, &parent, "<IfDefine");
1802 *(ap_directive_t **)dummy = current;
1806 *(ap_directive_t **)dummy = NULL;
1807 return ap_soak_end_container(cmd, "<IfDefine");
1811 /* httpd.conf commands... beginning with the <VirtualHost> business */
1813 static const char *virtualhost_section(cmd_parms *cmd, void *dummy,
1816 server_rec *main_server = cmd->server, *s;
1818 const char *endp = ap_strrchr_c(arg, '>');
1819 apr_pool_t *p = cmd->pool;
1821 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1827 return unclosed_directive(cmd);
1830 arg=apr_pstrndup(cmd->pool, arg, endp-arg);
1832 /* FIXME: There's another feature waiting to happen here -- since you
1833 can now put multiple addresses/names on a single <VirtualHost>
1834 you might want to use it to group common definitions and then
1835 define other "subhosts" with their individual differences. But
1836 personally I'd rather just do it with a macro preprocessor. -djg */
1837 if (main_server->is_virtual) {
1838 return "<VirtualHost> doesn't nest!";
1841 errmsg = ap_init_virtual_host(p, arg, main_server, &s);
1846 s->next = main_server->next;
1847 main_server->next = s;
1849 s->defn_name = cmd->directive->filename;
1850 s->defn_line_number = cmd->directive->line_num;
1854 errmsg = ap_walk_config(cmd->directive->first_child, cmd,
1855 s->lookup_defaults);
1857 cmd->server = main_server;
1862 static const char *set_server_alias(cmd_parms *cmd, void *dummy,
1865 if (!cmd->server->names) {
1866 return "ServerAlias only used in <VirtualHost>";
1869 char **item, *name = ap_getword_conf(cmd->pool, &arg);
1870 if (ap_is_matchexp(name)) {
1871 item = (char **)apr_push_array(cmd->server->wild_names);
1874 item = (char **)apr_push_array(cmd->server->names);
1881 static const char *add_filter(cmd_parms *cmd, void *dummy, const char *arg)
1883 core_dir_config *conf = dummy;
1886 newfilter = (char **)apr_push_array(conf->filters);
1887 *newfilter = apr_pstrdup(cmd->pool, arg);
1891 static const char *add_input_filter(cmd_parms *cmd, void *dummy, const char *arg)
1893 core_dir_config *conf = dummy;
1896 newfilter = (char **)apr_push_array(conf->input_filters);
1897 *newfilter = apr_pstrdup(cmd->pool, arg);
1901 static const char *add_module_command(cmd_parms *cmd, void *dummy,
1904 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1909 if (!ap_add_named_module(arg)) {
1910 return apr_pstrcat(cmd->pool, "Cannot add module via name '", arg,
1911 "': not in list of loaded modules", NULL);
1913 *(ap_directive_t **)dummy = NULL;
1917 static const char *clear_module_list_command(cmd_parms *cmd, void *dummy)
1919 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1924 ap_clear_module_list();
1925 *(ap_directive_t **)dummy = NULL;
1929 static const char *set_server_string_slot(cmd_parms *cmd, void *dummy,
1932 /* This one's pretty generic... */
1934 int offset = (int)(long)cmd->info;
1935 char *struct_ptr = (char *)cmd->server;
1937 const char *err = ap_check_cmd_context(cmd,
1938 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1943 *(const char **)(struct_ptr + offset) = arg;
1947 static const char *server_port(cmd_parms *cmd, void *dummy, const char *arg)
1949 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
1956 if (port <= 0 || port >= 65536) { /* 65536 == 1<<16 */
1957 return apr_pstrcat(cmd->temp_pool, "The port number \"", arg,
1958 "\" is outside the appropriate range "
1959 "(i.e., 1..65535).", NULL);
1961 cmd->server->port = port;
1965 static const char *set_signature_flag(cmd_parms *cmd, void *d_,
1968 core_dir_config *d=d_;
1970 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
1975 if (strcasecmp(arg, "On") == 0) {
1976 d->server_signature = srv_sig_on;
1978 else if (strcasecmp(arg, "Off") == 0) {
1979 d->server_signature = srv_sig_off;
1981 else if (strcasecmp(arg, "EMail") == 0) {
1982 d->server_signature = srv_sig_withmail;
1985 return "ServerSignature: use one of: off | on | email";
1990 static const char *set_server_root(cmd_parms *cmd, void *dummy,
1993 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
1999 arg = ap_os_canonical_filename(cmd->pool, arg);
2001 if (!ap_is_directory(arg)) {
2002 return "ServerRoot must be a valid directory";
2004 ap_server_root = arg;
2008 static const char *set_timeout(cmd_parms *cmd, void *dummy, const char *arg)
2010 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2015 cmd->server->timeout = atoi(arg);
2019 static const char *set_keep_alive_timeout(cmd_parms *cmd, void *dummy,
2022 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2027 cmd->server->keep_alive_timeout = atoi(arg);
2031 static const char *set_keep_alive(cmd_parms *cmd, void *dummy,
2034 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2039 /* We've changed it to On/Off, but used to use numbers
2040 * so we accept anything but "Off" or "0" as "On"
2042 if (!strcasecmp(arg, "off") || !strcmp(arg, "0")) {
2043 cmd->server->keep_alive = 0;
2046 cmd->server->keep_alive = 1;
2051 static const char *set_keep_alive_max(cmd_parms *cmd, void *dummy,
2054 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2059 cmd->server->keep_alive_max = atoi(arg);
2063 static const char *set_idcheck(cmd_parms *cmd, void *d_, int arg)
2065 core_dir_config *d=d_;
2066 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2071 d->do_rfc1413 = arg != 0;
2075 static const char *set_hostname_lookups(cmd_parms *cmd, void *d_,
2078 core_dir_config *d=d_;
2080 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2085 if (!strcasecmp(arg, "on")) {
2086 d->hostname_lookups = HOSTNAME_LOOKUP_ON;
2088 else if (!strcasecmp(arg, "off")) {
2089 d->hostname_lookups = HOSTNAME_LOOKUP_OFF;
2091 else if (!strcasecmp(arg, "double")) {
2092 d->hostname_lookups = HOSTNAME_LOOKUP_DOUBLE;
2095 return "parameter must be 'on', 'off', or 'double'";
2100 static const char *set_serverpath(cmd_parms *cmd, void *dummy,
2103 const char *err = ap_check_cmd_context(cmd, NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2108 cmd->server->path = arg;
2109 cmd->server->pathlen = strlen(arg);
2113 static const char *set_content_md5(cmd_parms *cmd, void *d_, int arg)
2115 core_dir_config *d=d_;
2116 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2121 d->content_md5 = arg != 0;
2125 static const char *set_use_canonical_name(cmd_parms *cmd, void *d_,
2128 core_dir_config *d=d_;
2129 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2134 if (strcasecmp(arg, "on") == 0) {
2135 d->use_canonical_name = USE_CANONICAL_NAME_ON;
2137 else if (strcasecmp(arg, "off") == 0) {
2138 d->use_canonical_name = USE_CANONICAL_NAME_OFF;
2140 else if (strcasecmp(arg, "dns") == 0) {
2141 d->use_canonical_name = USE_CANONICAL_NAME_DNS;
2144 return "parameter must be 'on', 'off', or 'dns'";
2150 static const char *include_config (cmd_parms *cmd, void *dummy,
2153 ap_directive_t *conftree = NULL;
2155 ap_process_resource_config(cmd->server,
2156 ap_server_root_relative(cmd->pool, name),
2157 &conftree, cmd->pool, cmd->temp_pool);
2158 *(ap_directive_t **)dummy = conftree;
2162 static const char *set_loglevel(cmd_parms *cmd, void *dummy, const char *arg)
2166 const char *err = ap_check_cmd_context(cmd,
2167 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2172 if ((str = ap_getword_conf(cmd->pool, &arg))) {
2173 if (!strcasecmp(str, "emerg")) {
2174 cmd->server->loglevel = APLOG_EMERG;
2176 else if (!strcasecmp(str, "alert")) {
2177 cmd->server->loglevel = APLOG_ALERT;
2179 else if (!strcasecmp(str, "crit")) {
2180 cmd->server->loglevel = APLOG_CRIT;
2182 else if (!strcasecmp(str, "error")) {
2183 cmd->server->loglevel = APLOG_ERR;
2185 else if (!strcasecmp(str, "warn")) {
2186 cmd->server->loglevel = APLOG_WARNING;
2188 else if (!strcasecmp(str, "notice")) {
2189 cmd->server->loglevel = APLOG_NOTICE;
2191 else if (!strcasecmp(str, "info")) {
2192 cmd->server->loglevel = APLOG_INFO;
2194 else if (!strcasecmp(str, "debug")) {
2195 cmd->server->loglevel = APLOG_DEBUG;
2198 return "LogLevel requires level keyword: one of "
2199 "emerg/alert/crit/error/warn/notice/info/debug";
2203 return "LogLevel requires level keyword";
2209 API_EXPORT(const char *) ap_psignature(const char *prefix, request_rec *r)
2212 core_dir_config *conf;
2214 conf = (core_dir_config *)ap_get_module_config(r->per_dir_config,
2216 if ((conf->server_signature == srv_sig_off)
2217 || (conf->server_signature == srv_sig_unset)) {
2221 apr_snprintf(sport, sizeof sport, "%u", (unsigned) ap_get_server_port(r));
2223 if (conf->server_signature == srv_sig_withmail) {
2224 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2225 " Server at <A HREF=\"mailto:",
2226 r->server->server_admin, "\">",
2227 ap_get_server_name(r), "</A> Port ", sport,
2228 "</ADDRESS>\n", NULL);
2230 return apr_pstrcat(r->pool, prefix, "<ADDRESS>" AP_SERVER_BASEVERSION
2231 " Server at ", ap_get_server_name(r), " Port ", sport,
2232 "</ADDRESS>\n", NULL);
2236 * Load an authorisation realm into our location configuration, applying the
2237 * usual rules that apply to realms.
2239 static const char *set_authname(cmd_parms *cmd, void *mconfig,
2242 core_dir_config *aconfig = (core_dir_config *)mconfig;
2244 aconfig->ap_auth_name = ap_escape_quotes(cmd->pool, word1);
2248 #ifdef _OSD_POSIX /* BS2000 Logon Passwd file */
2249 static const char *set_bs2000_account(cmd_parms *cmd, void *dummy, char *name)
2251 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2256 return os_set_account(cmd->pool, name);
2258 #endif /*_OSD_POSIX*/
2261 * Handle a request to include the server's OS platform in the Server
2262 * response header field (the ServerTokens directive). Unfortunately
2263 * this requires a new global in order to communicate the setting back to
2264 * http_main so it can insert the information in the right place in the
2268 static char *server_version = NULL;
2269 static int version_locked = 0;
2271 enum server_token_type {
2272 SrvTk_MIN, /* eg: Apache/1.3.0 */
2273 SrvTk_OS, /* eg: Apache/1.3.0 (UNIX) */
2274 SrvTk_FULL, /* eg: Apache/1.3.0 (UNIX) PHP/3.0 FooBar/1.2b */
2275 SrvTk_PRODUCT_ONLY /* eg: Apache */
2277 static enum server_token_type ap_server_tokens = SrvTk_FULL;
2279 static apr_status_t reset_version(void *dummy)
2282 ap_server_tokens = SrvTk_FULL;
2283 server_version = NULL;
2287 API_EXPORT(const char *) ap_get_server_version(void)
2289 return (server_version ? server_version : AP_SERVER_BASEVERSION);
2292 API_EXPORT(void) ap_add_version_component(apr_pool_t *pconf, const char *component)
2294 if (! version_locked) {
2296 * If the version string is null, register our cleanup to reset the
2297 * pointer on pool destruction. We also know that, if NULL,
2298 * we are adding the original SERVER_BASEVERSION string.
2300 if (server_version == NULL) {
2301 apr_register_cleanup(pconf, NULL, reset_version,
2303 server_version = apr_pstrdup(pconf, component);
2307 * Tack the given component identifier to the end of
2308 * the existing string.
2310 server_version = apr_pstrcat(pconf, server_version, " ",
2317 * This routine adds the real server base identity to the version string,
2318 * and then locks out changes until the next reconfig.
2320 static void ap_set_version(apr_pool_t *pconf)
2322 if (ap_server_tokens == SrvTk_PRODUCT_ONLY) {
2323 ap_add_version_component(pconf, AP_SERVER_BASEPRODUCT);
2325 else if (ap_server_tokens == SrvTk_MIN) {
2326 ap_add_version_component(pconf, AP_SERVER_BASEVERSION);
2329 ap_add_version_component(pconf, AP_SERVER_BASEVERSION " (" PLATFORM ")");
2332 * Lock the server_version string if we're not displaying
2333 * the full set of tokens
2335 if (ap_server_tokens != SrvTk_FULL) {
2340 static const char *set_serv_tokens(cmd_parms *cmd, void *dummy,
2343 const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
2348 if (!strcasecmp(arg, "OS")) {
2349 ap_server_tokens = SrvTk_OS;
2351 else if (!strcasecmp(arg, "Min") || !strcasecmp(arg, "Minimal")) {
2352 ap_server_tokens = SrvTk_MIN;
2354 else if (!strcasecmp(arg, "Prod") || !strcasecmp(arg, "ProductOnly")) {
2355 ap_server_tokens = SrvTk_PRODUCT_ONLY;
2358 ap_server_tokens = SrvTk_FULL;
2363 static const char *set_limit_req_line(cmd_parms *cmd, void *dummy,
2366 const char *err = ap_check_cmd_context(cmd,
2367 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2375 return apr_pstrcat(cmd->temp_pool, "LimitRequestLine \"", arg,
2376 "\" must be a non-negative integer", NULL);
2378 if (lim > DEFAULT_LIMIT_REQUEST_LINE) {
2379 return apr_psprintf(cmd->temp_pool, "LimitRequestLine \"%s\" "
2380 "must not exceed the precompiled maximum of %d",
2381 arg, DEFAULT_LIMIT_REQUEST_LINE);
2383 cmd->server->limit_req_line = lim;
2387 static const char *set_limit_req_fieldsize(cmd_parms *cmd, void *dummy,
2390 const char *err = ap_check_cmd_context(cmd,
2391 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2399 return apr_pstrcat(cmd->temp_pool, "LimitRequestFieldsize \"", arg,
2400 "\" must be a non-negative integer (0 = no limit)",
2403 if (lim > DEFAULT_LIMIT_REQUEST_FIELDSIZE) {
2404 return apr_psprintf(cmd->temp_pool, "LimitRequestFieldsize \"%s\" "
2405 "must not exceed the precompiled maximum of %d",
2406 arg, DEFAULT_LIMIT_REQUEST_FIELDSIZE);
2408 cmd->server->limit_req_fieldsize = lim;
2412 static const char *set_limit_req_fields(cmd_parms *cmd, void *dummy,
2415 const char *err = ap_check_cmd_context(cmd,
2416 NOT_IN_DIR_LOC_FILE|NOT_IN_LIMIT);
2424 return apr_pstrcat(cmd->temp_pool, "LimitRequestFields \"", arg,
2425 "\" must be a non-negative integer (0 = no limit)",
2428 cmd->server->limit_req_fields = lim;
2432 static const char *set_limit_req_body(cmd_parms *cmd, void *conf_,
2435 core_dir_config *conf=conf_;
2436 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2441 /* WTF: If strtoul is not portable, then write a replacement.
2442 * Instead we have an idiotic define in httpd.h that prevents
2443 * it from being used even when it is available. Sheesh.
2445 conf->limit_req_body = (unsigned long)strtol(arg, (char **)NULL, 10);
2449 static const char *set_limit_xml_req_body(cmd_parms *cmd, void *conf_,
2452 core_dir_config *conf = conf_;
2453 const char *err = ap_check_cmd_context(cmd, NOT_IN_LIMIT);
2458 conf->limit_xml_body = atol(arg);
2459 if (conf->limit_xml_body < 0)
2460 return "LimitXMLRequestBody requires a non-negative integer.";
2465 API_EXPORT(size_t) ap_get_limit_xml_body(const request_rec *r)
2467 core_dir_config *conf;
2469 conf = ap_get_module_config(r->per_dir_config, &core_module);
2470 if (conf->limit_xml_body == AP_LIMIT_UNSET)
2471 return AP_DEFAULT_LIMIT_XML_BODY;
2472 return (size_t)conf->limit_xml_body;
2476 static const char *set_interpreter_source(cmd_parms *cmd, core_dir_config *d,
2479 if (!strcasecmp(arg, "registry")) {
2480 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY;
2481 } else if (!strcasecmp(arg, "registry-strict")) {
2482 d->script_interpreter_source = INTERPRETER_SOURCE_REGISTRY_STRICT;
2483 } else if (!strcasecmp(arg, "script")) {
2484 d->script_interpreter_source = INTERPRETER_SOURCE_SHEBANG;
2486 return apr_pstrcat(cmd->temp_pool, "ScriptInterpreterSource \"", arg,
2487 "\" must be \"registry\", \"registry-strict\" or "
2488 "\"script\"", NULL);
2494 #if !defined (RLIMIT_CPU) || !(defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)) || !defined (RLIMIT_NPROC)
2495 static const char *no_set_limit(cmd_parms *cmd, core_dir_config *conf,
2496 char *arg, char *arg2)
2498 ap_log_error(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, cmd->server,
2499 "%s not supported on this platform", cmd->cmd->name);
2505 static const char *set_limit_cpu(cmd_parms *cmd, void *conf_,
2506 const char *arg, const char *arg2)
2508 core_dir_config *conf=conf_;
2510 unixd_set_rlimit(cmd, &conf->limit_cpu, arg, arg2, RLIMIT_CPU);
2515 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)
2516 static const char *set_limit_mem(cmd_parms *cmd, void *conf_,
2517 const char *arg, const char * arg2)
2519 core_dir_config *conf=conf_;
2521 #if defined(RLIMIT_AS)
2522 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2 ,RLIMIT_AS);
2523 #elif defined(RLIMIT_DATA)
2524 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_DATA);
2525 #elif defined(RLIMIT_VMEM)
2526 unixd_set_rlimit(cmd, &conf->limit_mem, arg, arg2, RLIMIT_VMEM);
2533 static const char *set_limit_nproc(cmd_parms *cmd, void *conf_,
2534 const char *arg, const char * arg2)
2536 core_dir_config *conf=conf_;
2538 unixd_set_rlimit(cmd, &conf->limit_nproc, arg, arg2, RLIMIT_NPROC);
2543 static apr_status_t writev_it_all(apr_socket_t *s, struct iovec *vec, int nvec,
2544 apr_size_t len, apr_size_t *nbytes)
2546 apr_size_t bytes_written = 0;
2548 apr_ssize_t n = len;
2551 /* XXX handle checking for non-blocking socket */
2552 while (bytes_written != len) {
2553 rv = apr_sendv(s, vec + i, nvec - i, &n);
2555 if (rv != APR_SUCCESS)
2558 /* If the write did not complete, adjust the iovecs and issue
2561 if (bytes_written < len) {
2562 /* Skip over the vectors that have already been written */
2563 apr_size_t cnt = vec[i].iov_len;
2564 while (n >= cnt && i + 1 < nvec) {
2566 cnt += vec[i].iov_len;
2569 /* Handle partial write of vec i */
2570 vec[i].iov_base = (char *) vec[i].iov_base +
2571 (vec[i].iov_len - (cnt - n));
2572 vec[i].iov_len = cnt -n;
2575 n = len - bytes_written;
2580 /* XXX handle partial writes */
2581 static apr_status_t send_the_file(conn_rec *c, apr_file_t *fd,
2582 apr_hdtr_t *hdtr, apr_off_t offset,
2583 apr_size_t length, apr_size_t *nbytes)
2585 apr_status_t rv = APR_SUCCESS;
2586 apr_size_t n = length;
2587 apr_int32_t sendlen = 0;
2591 if ( hdtr && hdtr->numheaders > 0 ) {
2592 rv = apr_sendv(c->client->bsock, hdtr->headers, hdtr->numheaders,
2596 if (offset != 0 && rv == APR_SUCCESS) {
2597 rv = apr_seek(fd, APR_SET, &offset);
2603 while (rv == APR_SUCCESS && togo > 0) {
2604 sendlen = togo > sizeof(buffer) ? sizeof(buffer) : togo;
2605 rv = apr_read(fd, buffer, &sendlen);
2607 if (rv == APR_SUCCESS) {
2609 rv = apr_send(c->client->bsock, buffer, &sendlen);
2614 if ( rv == APR_SUCCESS && hdtr && hdtr->numtrailers > 0 ) {
2615 rv = apr_sendv(c->client->bsock, hdtr->trailers, hdtr->numtrailers,
2623 /* Note --- ErrorDocument will now work from .htaccess files.
2624 * The AllowOverride of Fileinfo allows webmasters to turn it off
2627 static const command_rec core_cmds[] = {
2629 /* Old access config file commands */
2631 AP_INIT_RAW_ARGS("<Directory", dirsection, NULL, RSRC_CONF,
2632 "Container for directives affecting resources located in the specified "
2634 AP_INIT_RAW_ARGS("<Location", urlsection, NULL, RSRC_CONF,
2635 "Container for directives affecting resources accessed through the "
2636 "specified URL paths"),
2637 AP_INIT_RAW_ARGS("<VirtualHost", virtualhost_section, NULL, RSRC_CONF,
2638 "Container to map directives to a particular virtual host, takes one or "
2639 "more host addresses"),
2640 AP_INIT_RAW_ARGS("<Files", filesection, NULL, OR_ALL,
2641 "Container for directives affecting files matching specified patterns"),
2642 AP_INIT_RAW_ARGS("<Limit", ap_limit_section, NULL, OR_ALL,
2643 "Container for authentication directives when accessed using specified HTTP "
2645 AP_INIT_RAW_ARGS("<LimitExcept", ap_limit_section, (void*)1, OR_ALL,
2646 "Container for authentication directives to be applied when any HTTP "
2647 "method other than those specified is used to access the resource"),
2648 AP_INIT_TAKE1("<IfModule", start_ifmod, NULL, EXEC_ON_READ | OR_ALL,
2649 "Container for directives based on existance of specified modules"),
2650 AP_INIT_TAKE1("<IfDefine", start_ifdefine, NULL, EXEC_ON_READ | OR_ALL,
2651 "Container for directives based on existance of command line defines"),
2652 AP_INIT_RAW_ARGS("<DirectoryMatch", dirsection, (void*)1, RSRC_CONF,
2653 "Container for directives affecting resources located in the "
2654 "specified directories"),
2655 AP_INIT_RAW_ARGS("<LocationMatch", urlsection, (void*)1, RSRC_CONF,
2656 "Container for directives affecting resources accessed through the "
2657 "specified URL paths"),
2658 AP_INIT_RAW_ARGS("<FilesMatch", filesection, (void*)1, OR_ALL,
2659 "Container for directives affecting files matching specified patterns"),
2660 AP_INIT_TAKE1("AuthType", ap_set_string_slot,
2661 (void*)XtOffsetOf(core_dir_config, ap_auth_type), OR_AUTHCFG,
2662 "An HTTP authorization type (e.g., \"Basic\")"),
2663 AP_INIT_TAKE1("AuthName", set_authname, NULL, OR_AUTHCFG,
2664 "The authentication realm (e.g. \"Members Only\")"),
2665 AP_INIT_RAW_ARGS("Require", require, NULL, OR_AUTHCFG,
2666 "Selects which authenticated users or groups may access a protected space"),
2667 AP_INIT_TAKE1("Satisfy", satisfy, NULL, OR_AUTHCFG,
2668 "access policy if both allow and require used ('all' or 'any')"),
2670 AP_INIT_TAKE1("GprofDir", set_gprof_dir, NULL, RSRC_CONF,
2671 "Directory to plop gmon.out files"),
2673 AP_INIT_TAKE1("AddDefaultCharset", set_add_default_charset, NULL, OR_FILEINFO,
2674 "The name of the default charset to add to any Content-Type without one or 'Off' to disable"),
2676 /* Old resource config file commands */
2678 AP_INIT_RAW_ARGS("AccessFileName", set_access_name, NULL, RSRC_CONF,
2679 "Name(s) of per-directory config files (default: .htaccess)"),
2680 AP_INIT_TAKE1("DocumentRoot", set_document_root, NULL, RSRC_CONF,
2681 "Root directory of the document tree"),
2682 AP_INIT_TAKE2("ErrorDocument", set_error_document, NULL, OR_FILEINFO,
2683 "Change responses for HTTP errors"),
2684 AP_INIT_RAW_ARGS("AllowOverride", set_override, NULL, ACCESS_CONF,
2685 "Controls what groups of directives can be configured by per-directory "
2687 AP_INIT_RAW_ARGS("Options", set_options, NULL, OR_OPTIONS,
2688 "Set a number of attributes for a given directory"),
2689 AP_INIT_TAKE1("DefaultType", ap_set_string_slot,
2690 (void*)XtOffsetOf (core_dir_config, ap_default_type),
2691 OR_FILEINFO, "the default MIME type for untypable files"),
2693 /* Old server config file commands */
2695 AP_INIT_TAKE1("Port", server_port, NULL, RSRC_CONF, "A TCP port number"),
2696 AP_INIT_TAKE1("HostnameLookups", set_hostname_lookups, NULL,
2697 ACCESS_CONF|RSRC_CONF,
2698 "\"on\" to enable, \"off\" to disable reverse DNS lookups, or \"double\" to "
2699 "enable double-reverse DNS lookups"),
2700 AP_INIT_TAKE1("ServerAdmin", set_server_string_slot,
2701 (void *)XtOffsetOf (server_rec, server_admin), RSRC_CONF,
2702 "The email address of the server administrator"),
2703 AP_INIT_TAKE1("ServerName", set_server_string_slot,
2704 (void *)XtOffsetOf (server_rec, server_hostname), RSRC_CONF,
2705 "The hostname of the server"),
2706 AP_INIT_TAKE1("ServerSignature", set_signature_flag, NULL, OR_ALL,
2707 "En-/disable server signature (on|off|email)"),
2708 AP_INIT_TAKE1("ServerRoot", set_server_root, NULL, RSRC_CONF,
2709 "Common directory of server-related files (logs, confs, etc.)"),
2710 AP_INIT_TAKE1("ErrorLog", set_server_string_slot,
2711 (void *)XtOffsetOf (server_rec, error_fname), RSRC_CONF,
2712 "The filename of the error log"),
2713 AP_INIT_RAW_ARGS("ServerAlias", set_server_alias, NULL, RSRC_CONF,
2714 "A name or names alternately used to access the server"),
2715 AP_INIT_TAKE1("ServerPath", set_serverpath, NULL, RSRC_CONF,
2716 "The pathname the server can be reached at"),
2717 AP_INIT_TAKE1("Timeout", set_timeout, NULL, RSRC_CONF,
2718 "Timeout duration (sec)"),
2719 AP_INIT_TAKE1("KeepAliveTimeout", set_keep_alive_timeout, NULL, RSRC_CONF,
2720 "Keep-Alive timeout duration (sec)"),
2721 AP_INIT_TAKE1("MaxKeepAliveRequests", set_keep_alive_max, NULL, RSRC_CONF,
2722 "Maximum number of Keep-Alive requests per connection, or 0 for infinite"),
2723 AP_INIT_TAKE1("KeepAlive", set_keep_alive, NULL, RSRC_CONF,
2724 "Whether persistent connections should be On or Off"),
2725 AP_INIT_FLAG("IdentityCheck", set_idcheck, NULL, RSRC_CONF|ACCESS_CONF,
2726 "Enable identd (RFC 1413) user lookups - SLOW"),
2727 AP_INIT_FLAG("ContentDigest", set_content_md5, NULL, OR_OPTIONS,
2728 "whether or not to send a Content-MD5 header with each request"),
2729 AP_INIT_TAKE1("UseCanonicalName", set_use_canonical_name, NULL,
2730 RSRC_CONF|ACCESS_CONF,
2731 "How to work out the ServerName : Port when constructing URLs"),
2732 /* TODO: RlimitFoo should all be part of mod_cgi, not in the core */
2733 AP_INIT_ITERATE("AddModule", add_module_command, NULL,
2734 RSRC_CONF, "The name of a module"),
2735 AP_INIT_NO_ARGS("ClearModuleList", clear_module_list_command, NULL,
2737 /* TODO: ListenBacklog in MPM */
2738 AP_INIT_TAKE1("Include", include_config, NULL,
2739 (RSRC_CONF | ACCESS_CONF | EXEC_ON_READ),
2740 "Name of the config file to be included"),
2741 AP_INIT_TAKE1("LogLevel", set_loglevel, NULL, RSRC_CONF,
2742 "Level of verbosity in error logging"),
2743 AP_INIT_TAKE1("NameVirtualHost", ap_set_name_virtual_host, NULL, RSRC_CONF,
2744 "A numeric IP address:port, or the name of a host"),
2746 AP_INIT_TAKE1("BS2000Account", set_bs2000_account, NULL, RSRC_CONF,
2747 "Name of server User's bs2000 logon account name"),
2750 AP_INIT_TAKE1("ScriptInterpreterSource", set_interpreter_source, NULL,
2752 "Where to find interpreter to run Win32 scripts (Registry or script shebang line)"),
2754 AP_INIT_TAKE1("ServerTokens", set_serv_tokens, NULL, RSRC_CONF,
2755 "Determine tokens displayed in the Server: header - Min(imal), OS or Full"),
2756 AP_INIT_TAKE1("LimitRequestLine", set_limit_req_line, NULL, RSRC_CONF,
2757 "Limit on maximum size of an HTTP request line"),
2758 AP_INIT_TAKE1("LimitRequestFieldsize", set_limit_req_fieldsize, NULL,
2760 "Limit on maximum size of an HTTP request header field"),
2761 AP_INIT_TAKE1("LimitRequestFields", set_limit_req_fields, NULL, RSRC_CONF,
2762 "Limit (0 = unlimited) on max number of header fields in a request message"),
2763 AP_INIT_TAKE1("LimitRequestBody", set_limit_req_body,
2764 (void*)XtOffsetOf(core_dir_config, limit_req_body), OR_ALL,
2765 "Limit (in bytes) on maximum size of request message body"),
2766 AP_INIT_TAKE1("LimitXMLRequestBody", set_limit_xml_req_body, NULL, OR_ALL,
2767 "Limit (in bytes) on maximum size of an XML-based request "
2770 /* System Resource Controls */
2772 AP_INIT_TAKE12("RLimitCPU", set_limit_cpu,
2773 (void*)XtOffsetOf(core_dir_config, limit_cpu),
2774 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2776 AP_INIT_TAKE12("RLimitCPU", no_set_limit, NULL,
2777 OR_ALL, "Soft/hard limits for max CPU usage in seconds"),
2779 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined (RLIMIT_AS)
2780 AP_INIT_TAKE12("RLimitMEM", set_limit_mem,
2781 (void*)XtOffsetOf(core_dir_config, limit_mem),
2782 OR_ALL, "Soft/hard limits for max memory usage per process"),
2784 AP_INIT_TAKE12("RLimitMEM", no_set_limit, NULL,
2785 OR_ALL, "Soft/hard limits for max memory usage per process"),
2788 AP_INIT_TAKE12("RLimitNPROC", set_limit_nproc,
2789 (void*)XtOffsetOf(core_dir_config, limit_nproc),
2790 OR_ALL, "soft/hard limits for max number of processes per uid"),
2792 AP_INIT_TAKE12("RLimitNPROC", no_set_limit, NULL,
2793 OR_ALL, "soft/hard limits for max number of processes per uid"),
2795 /* XXX These should be allowable in .htaccess files, but currently it won't
2796 * play well with the Options stuff. Until that is fixed, I would prefer
2797 * to leave it just in the conf file. Other should feel free to disagree
2800 AP_INIT_ITERATE("AddOutputFilter", add_filter, NULL, ACCESS_CONF,
2801 "filters to be run"),
2802 AP_INIT_ITERATE("AddInputFilter", add_input_filter, NULL, ACCESS_CONF,
2803 "filters to be run on the request body"),
2807 /*****************************************************************
2809 * Core handlers for various phases of server operation...
2812 API_EXPORT_NONSTD(int) ap_core_translate(request_rec *r)
2814 void *sconf = r->server->module_config;
2815 core_server_config *conf = ap_get_module_config(sconf, &core_module);
2818 return HTTP_FORBIDDEN;
2820 if ((r->uri[0] != '/') && strcmp(r->uri, "*")) {
2821 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2822 "Invalid URI in request %s", r->the_request);
2823 return HTTP_BAD_REQUEST;
2827 && !strncmp(r->uri, r->server->path, r->server->pathlen)
2828 && (r->server->path[r->server->pathlen - 1] == '/'
2829 || r->uri[r->server->pathlen] == '/'
2830 || r->uri[r->server->pathlen] == '\0')) {
2831 r->filename = apr_pstrcat(r->pool, conf->ap_document_root,
2832 (r->uri + r->server->pathlen), NULL);
2836 * Make sure that we do not mess up the translation by adding two
2837 * /'s in a row. This happens under windows when the document
2838 * root ends with a /
2840 if ((conf->ap_document_root[strlen(conf->ap_document_root)-1] == '/')
2841 && (*(r->uri) == '/')) {
2842 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri+1,
2846 r->filename = apr_pstrcat(r->pool, conf->ap_document_root, r->uri,
2854 static int do_nothing(request_rec *r) { return OK; }
2857 * Default handler for MIME types without other handlers. Only GET
2858 * and OPTIONS at this point... anyone who wants to write a generic
2859 * handler for PUT or POST is free to do so, but it seems unwise to provide
2860 * any defaults yet... So, for now, we assume that this will always be
2861 * the last handler called and return 405 or 501.
2864 static int default_handler(request_rec *r)
2866 core_dir_config *d =
2867 (core_dir_config *)ap_get_module_config(r->per_dir_config, &core_module);
2868 int rangestatus, errstatus;
2869 apr_file_t *fd = NULL;
2870 apr_status_t status;
2871 #ifdef USE_MMAP_FILES
2872 apr_mmap_t *mm = NULL;
2874 /* XXX if/when somebody writes a content-md5 filter we either need to
2875 * remove this support or coordinate when to use the filter vs.
2876 * when to use this code
2877 * The current choice of when to compute the md5 here matches the 1.3
2878 * support fairly closely (unlike 1.3, we don't handle computing md5
2879 * when the charset is translated).
2881 int bld_content_md5 =
2882 (d->content_md5 & 1) && r->output_filters->frec->ftype != AP_FTYPE_CONTENT;
2884 /* This handler has no use for a request body (yet), but we still
2885 * need to read and discard it if the client sent one.
2887 if ((errstatus = ap_discard_request_body(r)) != OK) {
2891 ap_allow_methods(r, MERGE_ALLOW, "GET", "OPTIONS", NULL);
2893 if (r->method_number == M_INVALID) {
2894 ap_log_rerror(APLOG_MARK, APLOG_NOERRNO|APLOG_ERR, 0, r,
2895 "Invalid method in request %s", r->the_request);
2896 return HTTP_NOT_IMPLEMENTED;
2898 if (r->method_number == M_OPTIONS) {
2899 return ap_send_http_options(r);
2901 if (r->method_number == M_PUT) {
2902 return HTTP_METHOD_NOT_ALLOWED;
2904 if (r->finfo.protection == 0 || (r->path_info && *r->path_info)) {
2905 ap_log_rerror(APLOG_MARK, APLOG_ERR|APLOG_NOERRNO, 0, r,
2906 "File does not exist: %s",r->path_info ?
2907 apr_pstrcat(r->pool, r->filename, r->path_info, NULL)
2909 return HTTP_NOT_FOUND;
2911 if (r->method_number != M_GET) {
2912 return HTTP_METHOD_NOT_ALLOWED;
2915 if ((status = apr_open(&fd, r->filename, APR_READ | APR_BINARY, 0, r->pool)) != APR_SUCCESS) {
2916 ap_log_rerror(APLOG_MARK, APLOG_ERR, status, r,
2917 "file permissions deny server access: %s", r->filename);
2918 return HTTP_FORBIDDEN;
2920 ap_update_mtime(r, r->finfo.mtime);
2921 ap_set_last_modified(r);
2923 apr_table_setn(r->headers_out, "Accept-Ranges", "bytes");
2924 if (((errstatus = ap_meets_conditions(r)) != OK)
2925 || (errstatus = ap_set_content_length(r, r->finfo.size))) {
2930 #ifdef USE_MMAP_FILES
2931 if ((r->finfo.size >= MMAP_THRESHOLD)
2932 && (r->finfo.size < MMAP_LIMIT)
2933 && (!r->header_only || bld_content_md5)) {
2934 /* we need to protect ourselves in case we die while we've got the
2936 apr_status_t status;
2937 if ((status = apr_mmap_create(&mm, fd, 0, r->finfo.size, r->pool)) != APR_SUCCESS) {
2938 ap_log_rerror(APLOG_MARK, APLOG_CRIT, status, r,
2939 "default_handler: mmap failed: %s", r->filename);
2950 if (bld_content_md5) {
2952 apr_table_setn(r->headers_out, "Content-MD5",
2953 ap_md5digest(r->pool, fd, NULL));
2955 apr_table_setn(r->headers_out, "Content-MD5",
2956 ap_md5digest(r->pool, fd));
2957 #endif /* APACHE_XLATE */
2960 rangestatus = ap_set_byterange(r);
2962 ap_send_http_header(r);
2964 if (!r->header_only) {
2965 apr_size_t length = r->finfo.size;
2966 apr_off_t offset = 0;
2967 apr_size_t nbytes = 0;
2970 ap_send_fd(fd, r, offset, length, &nbytes);
2973 while (ap_each_byterange(r, &offset, &length)) {
2974 if ((status = ap_send_fd(fd, r, offset, length, &nbytes)) != APR_SUCCESS) {
2975 ap_log_error(APLOG_MARK, APLOG_ERR, status, r->server,
2976 "error byteserving file: %s", r->filename);
2977 return HTTP_INTERNAL_SERVER_ERROR;
2983 #ifdef USE_MMAP_FILES
2986 unsigned char *addr;
2987 apr_mmap_offset((void**)&addr, mm ,0);
2989 if (bld_content_md5) {
2990 apr_md5_ctx_t context;
2992 apr_MD5Init(&context);
2993 apr_MD5Update(&context, addr, (unsigned int)r->finfo.size);
2994 apr_table_setn(r->headers_out, "Content-MD5",
2995 ap_md5contextTo64(r->pool, &context));
2998 rangestatus = ap_set_byterange(r);
2999 ap_send_http_header(r);
3001 if (!r->header_only) {
3003 ap_send_mmap(mm, r, 0, r->finfo.size);
3008 while (ap_each_byterange(r, &offset, &length)) {
3009 ap_send_mmap(mm, r, offset, length);
3020 * This is a relatively simple filter to coalesce many small buckets into
3021 * one large bucket. This implementation of buffer_filter will only coalesce
3022 * a single contiguous string of coalesable buckets. It will not coalesce
3023 * multiple non-contiguous buckets.
3025 * For example, if a brigade contains 10 small buckets followed by a
3026 * large bucket (or a pipe or file bucket) followed by more small buckets,
3027 * only the first 10 buckets will be coalesced.
3029 typedef struct BUFFER_FILTER_CTX {
3030 char *buf; /* Start of buffer */
3031 char *cur; /* Pointer to next location to write */
3032 apr_ssize_t cnt; /* Number of bytes put in buf */
3033 apr_ssize_t avail; /* Number of bytes available in the buf */
3034 } buffer_filter_ctx_t;
3035 #define FILTER_BUFF_SIZE 8192
3036 #define MIN_BUCKET_SIZE 200
3037 static apr_status_t buffer_filter(ap_filter_t *f, ap_bucket_brigade *b)
3040 apr_pool_t *p = f->r->pool;
3041 ap_bucket *e, *insert_before = NULL, *destroy_me = NULL;
3042 buffer_filter_ctx_t *ctx = f->ctx;
3043 int pass_the_brigade = 0, insert_first = 0;
3046 f->ctx = ctx = apr_pcalloc(p, sizeof(buffer_filter_ctx_t));
3047 ctx->avail = FILTER_BUFF_SIZE;
3054 /* Iterate across the buckets, coalescing the small buckets into a
3057 AP_BRIGADE_FOREACH(e, b) {
3059 ap_bucket_destroy(destroy_me);
3062 if ((e->type == AP_BUCKET_EOS) || (e->type == AP_BUCKET_FILE) ||
3063 (e->type == AP_BUCKET_PIPE)) {
3064 pass_the_brigade = 1;
3069 rv = e->read(e, &str, &n, 0);
3070 if (rv != APR_SUCCESS) {
3071 /* XXX: log error */
3074 if ((n < MIN_BUCKET_SIZE) && (n < ctx->avail)) {
3075 /* Coalesce this bucket into the buffer */
3076 if (ctx->buf == NULL) {
3077 ctx->buf = apr_palloc(p, FILTER_BUFF_SIZE);
3078 ctx->cur = ctx->buf;
3081 memcpy(ctx->cur, str, n);
3085 /* If this is the first bucket to be coalesced, don't remove it
3086 * from the brigade. Save it as a marker for where to insert
3087 * ctx->buf into the brigade when we're done.
3089 if (insert_before || insert_first){
3090 AP_BUCKET_REMOVE(e);
3097 else if (insert_before || insert_first) {
3098 /* This bucket was not able to be coalesced because it either
3099 * exceeds MIN_BUCKET_SIZE or its contents will not fit into
3100 * buf. We're done...
3102 pass_the_brigade = 1;
3106 /* If there is even a single bucket that cannot be coalesced,
3107 * then we must pass the brigade down to the next filter.
3109 pass_the_brigade = 1;
3115 ap_bucket_destroy(destroy_me);
3119 if (pass_the_brigade) {
3120 /* Insert ctx->buf into the correct spotin the brigade */
3122 e = ap_bucket_create_transient(ctx->buf, ctx->cnt);
3123 AP_BRIGADE_INSERT_HEAD(b, e);
3125 else if (insert_before) {
3126 e = ap_bucket_create_transient(ctx->buf, ctx->cnt);
3127 AP_BUCKET_INSERT_BEFORE(e, insert_before);
3128 AP_BUCKET_REMOVE(insert_before);
3129 ap_bucket_destroy(insert_before);
3130 insert_before = NULL;
3132 rv = ap_pass_brigade(f->next, b);
3133 if (rv != APR_SUCCESS) {
3134 /* XXX: Log the error */
3137 /* Get ctx->buf ready for the next brigade */
3139 ctx->cur = ctx->buf;
3141 ctx->avail = FILTER_BUFF_SIZE;
3145 if (insert_before) {
3146 AP_BUCKET_REMOVE(insert_before);
3147 ap_bucket_destroy(insert_before);
3149 /* The brigade should be empty now because all the buckets
3150 * were coalesced into the buffer_filter buf
3157 * HTTP/1.1 chunked transfer encoding filter.
3159 static apr_status_t chunk_filter(ap_filter_t *f, ap_bucket_brigade *b)
3161 ap_bucket_brigade *more = NULL;
3165 for (more = NULL; b; b = more, more = NULL) {
3166 apr_off_t bytes = 0;
3167 ap_bucket *eos = NULL;
3168 char chunk_hdr[20]; /* enough space for the snprintf below */
3170 AP_BRIGADE_FOREACH(e, b) {
3171 if (e->type == AP_BUCKET_EOS) {
3172 /* there shouldn't be anything after the eos */
3176 else if (e->length == -1) {
3177 /* unknown amount of data (e.g. a pipe) */
3181 rv = e->read(e, &data, &len, 1);
3182 if (rv != APR_SUCCESS) {
3187 * There may be a new next bucket representing the
3188 * rest of the data stream on which a read() may
3189 * block so we pass down what we have so far.
3192 more = ap_brigade_split(b, AP_BUCKET_NEXT(e));
3196 /* If there was nothing in this bucket then we can
3197 * safely move on to the next one without pausing
3198 * to pass down what we have counted up so far.
3209 * XXX: if there aren't very many bytes at this point it may
3210 * be a good idea to set them aside and return for more,
3211 * unless we haven't finished counting this brigade yet.
3214 /* if there are content bytes, then wrap them in a chunk */
3219 * Insert the chunk header, specifying the number of bytes in
3222 /* XXX might be nice to have APR_OFF_T_FMT_HEX */
3223 hdr_len = apr_snprintf(chunk_hdr, sizeof(chunk_hdr),
3224 "%qx" CRLF, (apr_uint64_t)bytes);
3225 e = ap_bucket_create_transient(chunk_hdr, hdr_len);
3226 AP_BRIGADE_INSERT_HEAD(b, e);
3229 * Insert the end-of-chunk CRLF before the EOS bucket, or
3230 * appended to the brigade
3232 e = ap_bucket_create_immortal(CRLF, 2);
3234 AP_BUCKET_INSERT_BEFORE(eos, e);
3237 AP_BRIGADE_INSERT_TAIL(b, e);
3241 /* RFC 2616, Section 3.6.1
3243 * If there is an EOS bucket, then prefix it with:
3244 * 1) the last-chunk marker ("0" CRLF)
3246 * 3) the end-of-chunked body CRLF
3248 * If there is no EOS bucket, then do nothing.
3250 * XXX: it would be nice to combine this with the end-of-chunk
3251 * marker above, but this is a bit more straight-forward for
3255 /* XXX: (2) trailers ... does not yet exist */
3256 e = ap_bucket_create_immortal("0" CRLF /* <trailers> */ CRLF, 5);
3257 AP_BUCKET_INSERT_BEFORE(eos, e);
3260 /* pass the brigade to the next filter. */
3261 rv = ap_pass_brigade(f->next, b);
3262 if (rv != APR_SUCCESS || eos != NULL) {
3270 static int core_input_filter(ap_filter_t *f, ap_bucket_brigade *b)
3272 /* XXX this needs to be moved to a common header file, but this is an ugly
3273 * hack just for today.
3275 #define ASCII_LF '\012'
3277 apr_ssize_t length = HUGE_STRING_LEN, templen;
3278 apr_socket_t *csock = NULL;
3282 /* As soon as we have pool buckets, this should become a palloc. */
3283 buff = apr_palloc(f->c->pool, HUGE_STRING_LEN);
3284 ap_bpop_socket(&csock, f->c->client);
3286 rv = apr_recv(csock, buff, &length);
3287 if (rv == APR_SUCCESS) {
3289 templen = length - 1;
3290 while (buff[templen] != ASCII_LF) {
3291 rv = apr_recv(csock, buff + templen + 1, &length);
3295 /* This should probably be a pool bucket, but using a transient is
3296 * actually okay here too. We know the pool we are using will always
3297 * be available as long as the connection is open.
3299 e = ap_bucket_create_transient(buff, templen + 1);
3300 AP_BRIGADE_INSERT_TAIL(b, e);
3303 /* XXX need to trigger EOS/EOF processing;
3304 * for now, return empty brigade because that is what
3305 * getline() looks for */
3309 /* XXX need to trigger error processing */
3310 /* leave the brigade empty for now; return error code
3315 /* Default filter. This filter should almost always be used. Its only job
3316 * is to send the headers if they haven't already been sent, and then send
3319 #define MAX_IOVEC_TO_WRITE 16
3320 static int core_output_filter(ap_filter_t *f, ap_bucket_brigade *b)
3323 ap_bucket_brigade *more = NULL;
3324 apr_ssize_t bytes_sent = 0, nbytes;
3328 apr_ssize_t nvec = 0;
3329 apr_ssize_t nvec_trailers= 0;
3330 struct iovec vec[MAX_IOVEC_TO_WRITE];
3331 struct iovec vec_trailers[MAX_IOVEC_TO_WRITE];
3333 apr_file_t *fd = NULL;
3334 apr_ssize_t flen = 0;
3335 apr_off_t foffset = 0;
3337 /* If we have a saved brigade, concatenate the new brigade to it */
3338 if (c->client_data) {
3339 AP_BRIGADE_CONCAT(c->client_data, b);
3341 c->client_data = NULL;
3344 /* Hijack any bytes in BUFF and prepend it to the brigade. */
3345 if (c->client->outcnt) {
3346 e = ap_bucket_create_heap(c->client->outbase,
3347 c->client->outcnt, 1, NULL);
3348 c->client->outcnt = 0;
3349 AP_BRIGADE_INSERT_HEAD(b, e);
3352 /* Iterate over the brigade collecting iovecs */
3354 nbytes = 0; /* in case more points to another brigade */
3356 AP_BRIGADE_FOREACH(e, b) {
3357 if (e->type == AP_BUCKET_EOS) {
3360 else if (e->type == AP_BUCKET_FILE) {
3361 /* Assume there is at most one AP_BUCKET_FILE in the brigade */
3364 foffset = e->offset;
3369 rv = e->read(e, &str, &n, 0);
3373 vec[nvec].iov_base = (char*) str;
3374 vec[nvec].iov_len = n;
3378 /* The bucket is a trailer to a file bucket */
3379 vec_trailers[nvec_trailers].iov_base = (char*) str;
3380 vec_trailers[nvec_trailers].iov_len = n;
3386 if ((nvec == MAX_IOVEC_TO_WRITE) || (nvec_trailers == MAX_IOVEC_TO_WRITE)) {
3387 /* Split the brigade and break */
3388 if (AP_BUCKET_NEXT(e) != AP_BRIGADE_SENTINEL(b)) {
3389 more = ap_brigade_split(b, AP_BUCKET_NEXT(e));
3395 /* Completed iterating over the brigades, now determine if we want to
3396 * buffer the brigade or send the brigade out on the network
3398 if (!fd && (!more) && (nbytes < MIN_SIZE_TO_WRITE) && (e->type != AP_BUCKET_EOS)) {
3399 ap_save_brigade(f, &c->client_data, &b);
3404 apr_int32_t flags = 0;
3406 memset(&hdtr, '\0', sizeof(hdtr));
3408 hdtr.numheaders = nvec;
3411 if (nvec_trailers) {
3412 hdtr.numtrailers = nvec_trailers;
3413 hdtr.trailers = vec_trailers;
3415 #if APR_HAS_SENDFILE
3416 if (!c->keepalive) {
3417 /* Prepare the socket to be reused */
3418 flags |= APR_SENDFILE_DISCONNECT_SOCKET;
3421 rv = apr_sendfile(c->client->bsock,
3422 fd, /* The file to send */
3423 &hdtr, /* Header and trailer iovecs */
3424 &foffset, /* Offset in file to begin sending from */
3427 bytes_sent = nbytes;
3429 /* If apr_sendfile() returns APR_ENOTIMPL, call send_the_file() to
3430 * loop on apr_read/apr_send to send the file. Our Windows binary
3431 * distributions (which work on Windows 9x/NT) are compiled on
3432 * Windows NT. TransmitFile is not available on Windows 95/98 and
3433 * we discover this at runtime when apr_sendfile() returns
3434 * APR_ENOTIMPL. Having apr_sendfile() return APR_ENOTIMPL seems
3435 * the cleanest way to handle this case.
3437 if (rv == APR_ENOTIMPL) {
3440 rv = send_the_file(c, fd, &hdtr, foffset, flen, &bytes_sent);
3442 #if APR_HAS_SENDFILE
3447 rv = writev_it_all(c->client->bsock,
3449 nbytes, &bytes_sent);
3452 ap_brigade_destroy(b);
3453 if (rv != APR_SUCCESS) {
3454 /* XXX: log the error */
3456 ap_brigade_destroy(more);
3463 } /* end while () */
3468 static const handler_rec core_handlers[] = {
3469 { "*/*", default_handler },
3470 { "default-handler", default_handler },
3474 static void core_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3476 ap_set_version(pconf);
3479 static void core_open_logs(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
3481 ap_open_logs(s, pconf);
3484 static const char *core_method(const request_rec *r)
3487 static unsigned short core_port(const request_rec *r)
3488 { return DEFAULT_HTTP_PORT; }
3490 static void core_register_filter(request_rec *r)
3493 core_dir_config *conf = (core_dir_config *)
3494 ap_get_module_config(r->per_dir_config,
3496 char **items = (char **)conf->filters->elts;
3498 for (i = 0; i < conf->filters->nelts; i++) {
3499 char *foobar = items[i];
3500 ap_add_output_filter(foobar, NULL, r, r->connection);
3503 items = (char **)conf->input_filters->elts;
3504 for (i = 0; i < conf->input_filters->nelts; i++) {
3505 char *foobar = items[i];
3506 ap_add_input_filter(foobar, NULL, r, r->connection);
3510 static void register_hooks(void)
3512 ap_hook_post_config(core_post_config,NULL,NULL,AP_HOOK_REALLY_FIRST);
3513 ap_hook_translate_name(ap_core_translate,NULL,NULL,AP_HOOK_REALLY_LAST);
3514 ap_hook_pre_connection(ap_pre_http_connection,NULL,NULL,
3515 AP_HOOK_REALLY_LAST);
3516 ap_hook_process_connection(ap_process_http_connection,NULL,NULL,
3517 AP_HOOK_REALLY_LAST);
3518 ap_hook_http_method(core_method,NULL,NULL,AP_HOOK_REALLY_LAST);
3519 ap_hook_default_port(core_port,NULL,NULL,AP_HOOK_REALLY_LAST);
3520 ap_hook_open_logs(core_open_logs,NULL,NULL,AP_HOOK_MIDDLE);
3521 /* FIXME: I suspect we can eliminate the need for these - Ben */
3522 ap_hook_type_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3523 ap_hook_access_checker(do_nothing,NULL,NULL,AP_HOOK_REALLY_LAST);
3525 /* define the CORE filter, then register a hook to insert it at
3526 * request-processing time.
3528 ap_hook_insert_filter(core_register_filter, NULL, NULL, AP_HOOK_MIDDLE);
3529 ap_register_input_filter("HTTP_IN", http_filter, AP_FTYPE_CONNECTION);
3530 ap_register_input_filter("CORE_IN", core_input_filter, AP_FTYPE_CONNECTION);
3531 ap_register_output_filter("CORE", core_output_filter, AP_FTYPE_CONNECTION + 1);
3532 ap_register_output_filter("CHUNK", chunk_filter, AP_FTYPE_CONNECTION);
3533 ap_register_output_filter("BUFFER", buffer_filter, AP_FTYPE_CONNECTION);
3536 API_VAR_EXPORT module core_module = {
3537 STANDARD20_MODULE_STUFF,
3538 create_core_dir_config, /* create per-directory config structure */
3539 merge_core_dir_configs, /* merge per-directory config structures */
3540 create_core_server_config, /* create per-server config structure */
3541 merge_core_server_configs, /* merge per-server config structures */
3542 core_cmds, /* command apr_table_t */
3543 core_handlers, /* handlers */
3544 register_hooks /* register hooks */