1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief Apache Configuration
21 * @defgroup APACHE_CORE_CONFIG Configuration
22 * @ingroup APACHE_CORE
26 #ifndef APACHE_HTTP_CONFIG_H
27 #define APACHE_HTTP_CONFIG_H
29 #include "util_cfgtree.h"
30 #include "ap_config.h"
31 #include "apr_tables.h"
38 * The central data structures around here...
41 /* Command dispatch structures... */
44 * How the directives arguments should be parsed.
45 * @remark Note that for all of these except RAW_ARGS, the config routine is
46 * passed a freshly allocated string which can be modified or stored
50 RAW_ARGS, /**< cmd_func parses command line itself */
51 TAKE1, /**< one argument only */
52 TAKE2, /**< two arguments only */
53 ITERATE, /**< one argument, occuring multiple times
56 ITERATE2, /**< two arguments, 2nd occurs multiple times
59 FLAG, /**< One of 'On' or 'Off' */
60 NO_ARGS, /**< No args at all, e.g. </Directory> */
61 TAKE12, /**< one or two arguments */
62 TAKE3, /**< three arguments only */
63 TAKE23, /**< two or three arguments */
64 TAKE123, /**< one, two or three arguments */
65 TAKE13, /**< one or three arguments */
66 TAKE_ARGV /**< an argc and argv are passed */
70 * This structure is passed to a command which is being invoked,
71 * to carry a large variety of miscellaneous data which is all of
72 * use to *somebody*...
74 typedef struct cmd_parms_struct cmd_parms;
76 #if defined(AP_HAVE_DESIGNATED_INITIALIZER) || defined(DOXYGEN)
79 * All the types of functions that can be used in directives
83 /** function to call for a no-args */
84 const char *(*no_args) (cmd_parms *parms, void *mconfig);
85 /** function to call for a raw-args */
86 const char *(*raw_args) (cmd_parms *parms, void *mconfig,
88 /** function to call for a argv/argc */
89 const char *(*take_argv) (cmd_parms *parms, void *mconfig,
90 int argc, char *const argv[]);
91 /** function to call for a take1 */
92 const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
93 /** function to call for a take2 */
94 const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
96 /** function to call for a take3 */
97 const char *(*take3) (cmd_parms *parms, void *mconfig, const char *w,
98 const char *w2, const char *w3);
99 /** function to call for a flag */
100 const char *(*flag) (cmd_parms *parms, void *mconfig, int on);
103 /** This configuration directive does not take any arguments */
104 # define AP_NO_ARGS func.no_args
105 /** This configuration directive will handle its own parsing of arguments*/
106 # define AP_RAW_ARGS func.raw_args
107 /** This configuration directive will handle its own parsing of arguments*/
108 # define AP_TAKE_ARGV func.take_argv
109 /** This configuration directive takes 1 argument*/
110 # define AP_TAKE1 func.take1
111 /** This configuration directive takes 2 arguments */
112 # define AP_TAKE2 func.take2
113 /** This configuration directive takes 3 arguments */
114 # define AP_TAKE3 func.take3
115 /** This configuration directive takes a flag (on/off) as a argument*/
116 # define AP_FLAG func.flag
118 /** mechanism for declaring a directive with no arguments */
119 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
120 { directive, { .no_args=func }, mconfig, where, NO_ARGS, help }
121 /** mechanism for declaring a directive with raw argument parsing */
122 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
123 { directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
124 /** mechanism for declaring a directive with raw argument parsing */
125 # define AP_INIT_TAKE_ARGV(directive, func, mconfig, where, help) \
126 { directive, { .take_argv=func }, mconfig, where, TAKE_ARGV, help }
127 /** mechanism for declaring a directive which takes 1 argument */
128 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
129 { directive, { .take1=func }, mconfig, where, TAKE1, help }
130 /** mechanism for declaring a directive which takes multiple arguments */
131 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
132 { directive, { .take1=func }, mconfig, where, ITERATE, help }
133 /** mechanism for declaring a directive which takes 2 arguments */
134 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
135 { directive, { .take2=func }, mconfig, where, TAKE2, help }
136 /** mechanism for declaring a directive which takes 1 or 2 arguments */
137 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
138 { directive, { .take2=func }, mconfig, where, TAKE12, help }
139 /** mechanism for declaring a directive which takes multiple 2 arguments */
140 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
141 { directive, { .take2=func }, mconfig, where, ITERATE2, help }
142 /** mechanism for declaring a directive which takes 1 or 3 arguments */
143 # define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
144 { directive, { .take3=func }, mconfig, where, TAKE13, help }
145 /** mechanism for declaring a directive which takes 2 or 3 arguments */
146 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
147 { directive, { .take3=func }, mconfig, where, TAKE23, help }
148 /** mechanism for declaring a directive which takes 1 to 3 arguments */
149 # define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
150 { directive, { .take3=func }, mconfig, where, TAKE123, help }
151 /** mechanism for declaring a directive which takes 3 arguments */
152 # define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
153 { directive, { .take3=func }, mconfig, where, TAKE3, help }
154 /** mechanism for declaring a directive which takes a flag (on/off) argument */
155 # define AP_INIT_FLAG(directive, func, mconfig, where, help) \
156 { directive, { .flag=func }, mconfig, where, FLAG, help }
158 #else /* AP_HAVE_DESIGNATED_INITIALIZER */
160 typedef const char *(*cmd_func) ();
162 # define AP_NO_ARGS func
163 # define AP_RAW_ARGS func
164 # define AP_TAKE_ARGV func
165 # define AP_TAKE1 func
166 # define AP_TAKE2 func
167 # define AP_TAKE3 func
168 # define AP_FLAG func
170 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
171 { directive, func, mconfig, where, NO_ARGS, help }
172 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
173 { directive, func, mconfig, where, RAW_ARGS, help }
174 # define AP_INIT_TAKE_ARGV(directive, func, mconfig, where, help) \
175 { directive, func, mconfig, where, TAKE_ARGV, help }
176 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
177 { directive, func, mconfig, where, TAKE1, help }
178 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
179 { directive, func, mconfig, where, ITERATE, help }
180 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
181 { directive, func, mconfig, where, TAKE2, help }
182 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
183 { directive, func, mconfig, where, TAKE12, help }
184 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
185 { directive, func, mconfig, where, ITERATE2, help }
186 # define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
187 { directive, func, mconfig, where, TAKE13, help }
188 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
189 { directive, func, mconfig, where, TAKE23, help }
190 # define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
191 { directive, func, mconfig, where, TAKE123, help }
192 # define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
193 { directive, func, mconfig, where, TAKE3, help }
194 # define AP_INIT_FLAG(directive, func, mconfig, where, help) \
195 { directive, func, mconfig, where, FLAG, help }
197 #endif /* AP_HAVE_DESIGNATED_INITIALIZER */
200 * The command record structure. Modules can define a table of these
201 * to define the directives it will implement.
203 typedef struct command_struct command_rec;
204 struct command_struct {
205 /** Name of this command */
207 /** The function to be called when this directive is parsed */
209 /** Extra data, for functions which implement multiple commands... */
211 /** What overrides need to be allowed to enable this command. */
213 /** What the command expects as arguments */
214 enum cmd_how args_how;
216 /** 'usage' message, in case of syntax errors */
221 * @defgroup ConfigDirectives Allowed locations for configuration directives.
223 * The allowed locations for a configuration directive are the union of
224 * those indicated by each set bit in the req_override mask.
228 #define OR_NONE 0 /**< *.conf is not available anywhere in this override */
229 #define OR_LIMIT 1 /**< *.conf inside <Directory> or <Location>
230 and .htaccess when AllowOverride Limit */
231 #define OR_OPTIONS 2 /**< *.conf anywhere
232 and .htaccess when AllowOverride Options */
233 #define OR_FILEINFO 4 /**< *.conf anywhere
234 and .htaccess when AllowOverride FileInfo */
235 #define OR_AUTHCFG 8 /**< *.conf inside <Directory> or <Location>
236 and .htaccess when AllowOverride AuthConfig */
237 #define OR_INDEXES 16 /**< *.conf anywhere
238 and .htaccess when AllowOverride Indexes */
239 #define OR_UNSET 32 /**< bit to indicate that AllowOverride has not been set */
240 #define ACCESS_CONF 64 /**< *.conf inside <Directory> or <Location> */
241 #define RSRC_CONF 128 /**< *.conf outside <Directory> or <Location> */
242 #define EXEC_ON_READ 256 /**< force directive to execute a command
243 which would modify the configuration (like including another
245 /* Flags to determine whether syntax errors in .htaccess should be
246 * treated as nonfatal (log and ignore errors)
248 #define NONFATAL_OVERRIDE 512 /* Violation of AllowOverride rule */
249 #define NONFATAL_UNKNOWN 1024 /* Unrecognised directive */
250 #define NONFATAL_ALL (NONFATAL_OVERRIDE|NONFATAL_UNKNOWN)
252 #define PROXY_CONF 2048 /**< *.conf inside <Proxy> only */
254 /** this directive can be placed anywhere */
255 #define OR_ALL (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
260 * This can be returned by a function if they don't wish to handle
261 * a command. Make it something not likely someone will actually use
264 #define DECLINE_CMD "\a\b"
266 /** Common structure for reading of config files / passwd files etc. */
267 typedef struct ap_configfile_t ap_configfile_t;
268 struct ap_configfile_t {
269 /**< an apr_file_getc()-like function */
270 apr_status_t (*getch) (char *ch, void *param);
271 /**< an apr_file_gets()-like function */
272 apr_status_t (*getstr) (void *buf, apr_size_t bufsiz, void *param);
273 /**< a close handler function */
274 apr_status_t (*close) (void *param);
275 /**< the argument passed to getch/getstr/close */
277 /**< the filename / description */
279 /**< current line number, starting at 1 */
280 unsigned line_number;
284 * This structure is passed to a command which is being invoked,
285 * to carry a large variety of miscellaneous data which is all of
286 * use to *somebody*...
288 struct cmd_parms_struct {
289 /** Argument to command from cmd_table */
291 /** Which allow-override bits are set */
293 /** Which allow-override-opts bits are set */
295 /** Table of directives allowed per AllowOverrideList */
296 apr_table_t *override_list;
297 /** Which methods are <Limit>ed */
299 /** methods which are limited */
300 apr_array_header_t *limited_xmethods;
301 /** methods which are xlimited */
302 ap_method_list_t *xlimited;
304 /** Config file structure. */
305 ap_configfile_t *config_file;
306 /** the directive specifying this command */
307 ap_directive_t *directive;
309 /** Pool to allocate new storage in */
311 /** Pool for scratch memory; persists during configuration, but
312 * wiped before the first request is served... */
313 apr_pool_t *temp_pool;
314 /** Server_rec being configured for */
316 /** If configuring for a directory, pathname of that directory.
317 * NOPE! That's what it meant previous to the existence of <Files>,
318 * <Location> and regex matching. Now the only usefulness that can be
319 * derived from this field is whether a command is being called in a
320 * server context (path == NULL) or being called in a dir context
323 /** configuration command */
324 const command_rec *cmd;
326 /** per_dir_config vector passed to handle_command */
327 struct ap_conf_vector_t *context;
328 /** directive with syntax error */
329 const ap_directive_t *err_directive;
331 /** If the current directive is EXEC_ON_READ, this is the last
332 (non-EXEC_ON_READ) enclosing directive */
333 ap_directive_t *parent;
337 * Module structures. Just about everything is dispatched through
338 * these, directly or indirectly (through the command and handler
341 typedef struct module_struct module;
342 struct module_struct {
343 /** API version, *not* module version; check that module is
344 * compatible with this version of the server.
347 /** API minor version. Provides API feature milestones. Not checked
348 * during module init */
350 /** Index to this modules structures in config vectors. */
353 /** The name of the module's C file */
355 /** The handle for the DSO. Internal use only */
356 void *dynamic_load_handle;
358 /** A pointer to the next module in the list
359 * @var module_struct *next
361 struct module_struct *next;
363 /** Magic Cookie to identify a module structure; It's mainly
364 * important for the DSO facility (see also mod_so). */
367 /** Function to allow MPMs to re-write command line arguments. This
368 * hook is only available to MPMs.
369 * @param The process that the server is running in.
371 void (*rewrite_args) (process_rec *process);
372 /** Function to allow all modules to create per directory configuration
374 * @param p The pool to use for all allocations.
375 * @param dir The directory currently being processed.
376 * @return The per-directory structure created
378 void *(*create_dir_config) (apr_pool_t *p, char *dir);
379 /** Function to allow all modules to merge the per directory configuration
380 * structures for two directories.
381 * @param p The pool to use for all allocations.
382 * @param base_conf The directory structure created for the parent directory.
383 * @param new_conf The directory structure currently being processed.
384 * @return The new per-directory structure created
386 void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *new_conf);
387 /** Function to allow all modules to create per server configuration
389 * @param p The pool to use for all allocations.
390 * @param s The server currently being processed.
391 * @return The per-server structure created
393 void *(*create_server_config) (apr_pool_t *p, server_rec *s);
394 /** Function to allow all modules to merge the per server configuration
395 * structures for two servers.
396 * @param p The pool to use for all allocations.
397 * @param base_conf The directory structure created for the parent directory.
398 * @param new_conf The directory structure currently being processed.
399 * @return The new per-directory structure created
401 void *(*merge_server_config) (apr_pool_t *p, void *base_conf,
404 /** A command_rec table that describes all of the directives this module
406 const command_rec *cmds;
408 /** A hook to allow modules to hook other points in the request processing.
409 * In this function, modules should call the ap_hook_*() functions to
410 * register an interest in a specific step in processing the current
412 * @param p the pool to use for all allocations
414 void (*register_hooks) (apr_pool_t *p);
418 * The AP_MAYBE_USELESS macro is used vor variable declarations that
419 * might potentially exhibit "unused var" warnings on some compilers if
421 * Since static intializers are not part of the C language (C89), making
422 * (void) usage is not possible. However many compiler have proprietary
423 * mechanism to suppress those warnings.
425 #ifdef AP_MAYBE_USELESS
426 #elif defined(__GNUC__)
427 # define AP_MAYBE_USELESS(x) x __attribute__((unused))
428 #elif defined(__LCLINT__)
429 # define AP_MAYBE_USELESS(x) /*@unused@*/ x
431 # define AP_MAYBE_USELESS(x) x
435 * The APLOG_USE_MODULE macro is used choose which module a file belongs to.
436 * This is necessary to allow per-module loglevel configuration.
438 * APLOG_USE_MODULE indirectly sets APLOG_MODULE_INDEX and APLOG_MARK.
440 * If a module should be backward compatible with versions before 2.3.6,
441 * APLOG_USE_MODULE needs to be enclosed in a ifdef APLOG_USE_MODULE block.
443 * @param foo name of the module symbol of the current module, without the
444 * trailing "_module" part
447 #define APLOG_USE_MODULE(foo) \
448 extern module AP_MODULE_DECLARE_DATA foo##_module; \
449 AP_MAYBE_USELESS(static int * const aplog_module_index) = &(foo##_module.module_index)
452 * AP_DECLARE_MODULE is a convenience macro that combines a call of
453 * APLOG_USE_MODULE with the definition of the module symbol.
455 * If a module should be backward compatible with versions before 2.3.6,
456 * APLOG_USE_MODULE should be used explicitly instead of AP_DECLARE_MODULE.
458 #define AP_DECLARE_MODULE(foo) \
459 APLOG_USE_MODULE(foo); \
460 module AP_MODULE_DECLARE_DATA foo##_module
463 * @defgroup ModuleInit Module structure initializers
465 * Initializer for the first few module slots, which are only
466 * really set up once we start running. Note that the first two slots
467 * provide a version check; this should allow us to deal with changes to
468 * the API. The major number should reflect changes to the API handler table
469 * itself or removal of functionality. The minor number should reflect
470 * additions of functionality to the existing API. (the server can detect
471 * an old-format module, and either handle it back-compatibly, or at least
472 * signal an error). See src/include/ap_mmn.h for MMN version history.
476 /** The one used in Apache 1.3, which will deliberately cause an error */
477 #define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
479 /** Use this in all standard modules */
480 #define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
481 MODULE_MAGIC_NUMBER_MINOR, \
486 MODULE_MAGIC_COOKIE, \
487 NULL /* rewrite args spot */
489 /** Use this only in MPMs */
490 #define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
491 MODULE_MAGIC_NUMBER_MINOR, \
500 /* CONFIGURATION VECTOR FUNCTIONS */
502 /** configuration vector structure */
503 typedef struct ap_conf_vector_t ap_conf_vector_t;
506 * Generic accessors for other modules to get at their own module-specific
508 * @param cv The vector in which the modules configuration is stored.
509 * usually r->per_dir_config or s->module_config
510 * @param m The module to get the data for.
511 * @return The module-specific data
513 AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
517 * Generic accessors for other modules to set their own module-specific
519 * @param cv The vector in which the modules configuration is stored.
520 * usually r->per_dir_config or s->module_config
521 * @param m The module to set the data for.
522 * @param val The module-specific data to set
524 AP_DECLARE(void) ap_set_module_config(ap_conf_vector_t *cv, const module *m,
527 #if !defined(AP_DEBUG)
529 #define ap_get_module_config(v,m) \
530 (((void **)(v))[(m)->module_index])
531 #define ap_set_module_config(v,m,val) \
532 ((((void **)(v))[(m)->module_index]) = (val))
534 #endif /* AP_DEBUG */
538 * Generic accessor for modules to get the module-specific loglevel
539 * @param s The server from which to get the loglevel.
540 * @param index The module_index of the module to get the loglevel for.
541 * @return The module-specific loglevel
543 AP_DECLARE(int) ap_get_server_module_loglevel(const server_rec *s, int index);
546 * Generic accessor for modules the module-specific loglevel
547 * @param c The connection from which to get the loglevel.
548 * @param index The module_index of the module to get the loglevel for.
549 * @return The module-specific loglevel
551 AP_DECLARE(int) ap_get_conn_module_loglevel(const conn_rec *c, int index);
554 * Generic accessor for modules the module-specific loglevel
555 * @param c The connection from which to get the loglevel.
556 * @param s The server from which to get the loglevel if c does not have a
557 * specific loglevel configuration.
558 * @param index The module_index of the module to get the loglevel for.
559 * @return The module-specific loglevel
561 AP_DECLARE(int) ap_get_conn_server_module_loglevel(const conn_rec *c,
566 * Generic accessor for modules to get the module-specific loglevel
567 * @param r The request from which to get the loglevel.
568 * @param index The module_index of the module to get the loglevel for.
569 * @return The module-specific loglevel
571 AP_DECLARE(int) ap_get_request_module_loglevel(const request_rec *r, int index);
574 * Accessor to set module-specific loglevel
576 * @param l The ap_logconf struct to modify.
577 * @param index The module_index of the module to set the loglevel for.
578 * @param level The new log level
580 AP_DECLARE(void) ap_set_module_loglevel(apr_pool_t *p, struct ap_logconf *l,
581 int index, int level);
583 #if !defined(AP_DEBUG)
585 #define ap_get_conn_logconf(c) \
586 ((c)->log ? (c)->log : \
587 &(c)->base_server->log)
589 #define ap_get_conn_server_logconf(c,s) \
590 ( ( (c)->log != &(c)->base_server->log && (c)->log != NULL ) ? \
594 #define ap_get_request_logconf(r) \
595 ((r)->log ? (r)->log : \
596 (r)->connection->log ? (r)->connection->log : \
599 #define ap_get_module_loglevel(l,i) \
600 (((i) < 0 || (l)->module_levels == NULL || (l)->module_levels[i] < 0) ? \
602 (l)->module_levels[i])
604 #define ap_get_server_module_loglevel(s,i) \
605 (ap_get_module_loglevel(&(s)->log,i))
607 #define ap_get_conn_module_loglevel(c,i) \
608 (ap_get_module_loglevel(ap_get_conn_logconf(c),i))
610 #define ap_get_conn_server_module_loglevel(c,s,i) \
611 (ap_get_module_loglevel(ap_get_conn_server_logconf(c,s),i))
613 #define ap_get_request_module_loglevel(r,i) \
614 (ap_get_module_loglevel(ap_get_request_logconf(r),i))
616 #endif /* AP_DEBUG */
619 * Set all module-specific loglevels to val
620 * @param l The log config for which to set the loglevels.
621 * @param val the value to set all loglevels to
623 AP_DECLARE(void) ap_reset_module_loglevels(struct ap_logconf *l, int val);
626 * Generic command handling function for strings
627 * @param cmd The command parameters for this directive
628 * @param struct_ptr pointer into a given type
629 * @param arg The argument to the directive
630 * @return An error string or NULL on success
632 AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd,
637 * Generic command handling function for integers
638 * @param cmd The command parameters for this directive
639 * @param struct_ptr pointer into a given type
640 * @param arg The argument to the directive
641 * @return An error string or NULL on success
643 AP_DECLARE_NONSTD(const char *) ap_set_int_slot(cmd_parms *cmd,
648 * Parsing function for log level
649 * @param str The string to parse
650 * @param val The parsed log level
651 * @return An error string or NULL on success
653 AP_DECLARE(const char *) ap_parse_log_level(const char *str, int *val);
656 * Return true if the specified method is limited by being listed in
657 * a <Limit> container, or by *not* being listed in a <LimitExcept>
660 * @param method Pointer to a string specifying the method to check.
661 * @param cmd Pointer to the cmd_parms structure passed to the
663 * @return 0 if the method is not limited in the current scope
665 AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
668 * Generic command handling function for strings, always sets the value
669 * to a lowercase string
670 * @param cmd The command parameters for this directive
671 * @param struct_ptr pointer into a given type
672 * @param arg The argument to the directive
673 * @return An error string or NULL on success
675 AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
679 * Generic command handling function for flags stored in an int
680 * @param cmd The command parameters for this directive
681 * @param struct_ptr pointer into a given type
682 * @param arg The argument to the directive (either 1 or 0)
683 * @return An error string or NULL on success
685 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd,
689 * Generic command handling function for flags stored in a char
690 * @param cmd The command parameters for this directive
691 * @param struct_ptr pointer into a given type
692 * @param arg The argument to the directive (either 1 or 0)
693 * @return An error string or NULL on success
695 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot_char(cmd_parms *cmd,
699 * Generic command handling function for files
700 * @param cmd The command parameters for this directive
701 * @param struct_ptr pointer into a given type
702 * @param arg The argument to the directive
703 * @return An error string or NULL on success
705 AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd,
709 * Generic command handling function to respond with cmd->help as an error
710 * @param cmd The command parameters for this directive
711 * @param struct_ptr pointer into a given type
712 * @param arg The argument to the directive
713 * @return The cmd->help value as the error string
714 * @note This allows simple declarations such as:
716 * AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
717 * "The Foo directive is no longer supported, use Bar"),
720 AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd,
724 * For modules which need to read config files, open logs, etc. this returns
725 * the canonical form of fname made absolute to ap_server_root.
726 * @param p pool to allocate data from
727 * @param fname The file name
729 AP_DECLARE(char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
732 * Compute the name of a run-time file (e.g., shared memory "file") relative
733 * to the appropriate run-time directory. Absolute paths are returned as-is.
734 * The run-time directory is configured via the DefaultRuntimeDir directive or
737 AP_DECLARE(char *) ap_runtime_dir_relative(apr_pool_t *p, const char *fname);
739 /* Finally, the hook for dynamically loading modules in... */
742 * Add a module to the server
743 * @param m The module structure of the module to add
744 * @param p The pool of the same lifetime as the module
745 * @param s The module's symbol name (used for logging)
747 AP_DECLARE(const char *) ap_add_module(module *m, apr_pool_t *p,
751 * Remove a module from the server. There are some caveats:
752 * when the module is removed, its slot is lost so all the current
753 * per-dir and per-server configurations are invalid. So we should
754 * only ever call this function when you are invalidating almost
755 * all our current data. I.e. when doing a restart.
756 * @param m the module structure of the module to remove
758 AP_DECLARE(void) ap_remove_module(module *m);
760 * Add a module to the chained modules list and the list of loaded modules
761 * @param mod The module structure of the module to add
762 * @param p The pool with the same lifetime as the module
763 * @param s The module's symbol name (used for logging)
765 AP_DECLARE(const char *) ap_add_loaded_module(module *mod, apr_pool_t *p,
768 * Remove a module fromthe chained modules list and the list of loaded modules
769 * @param mod the module structure of the module to remove
771 AP_DECLARE(void) ap_remove_loaded_module(module *mod);
773 * Find the name of the specified module
774 * @param m The module to get the name for
775 * @return the name of the module
777 AP_DECLARE(const char *) ap_find_module_name(module *m);
779 * Find the short name of the module identified by the specified module index
780 * @param module_index The module index to get the name for
781 * @return the name of the module, NULL if not found
783 AP_DECLARE(const char *) ap_find_module_short_name(int module_index);
785 * Find a module based on the name of the module
786 * @param name the name of the module
787 * @return the module structure if found, NULL otherwise
789 AP_DECLARE(module *) ap_find_linked_module(const char *name);
792 * Open a ap_configfile_t as apr_file_t
793 * @param ret_cfg open ap_configfile_t struct pointer
794 * @param p The pool to allocate the structure from
795 * @param name the name of the file to open
797 AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg,
798 apr_pool_t *p, const char *name);
801 * Allocate a ap_configfile_t handle with user defined functions and params
802 * @param p The pool to allocate from
803 * @param descr The name of the file
804 * @param param The argument passed to getch/getstr/close
805 * @param getc_func The getch function
806 * @param gets_func The getstr function
807 * @param close_func The close function
809 AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p,
812 apr_status_t (*getc_func) (char *ch, void *param),
813 apr_status_t (*gets_func) (void *buf, apr_size_t bufsiz, void *param),
814 apr_status_t (*close_func) (void *param));
817 * Read one line from open ap_configfile_t, strip leading and trailing
818 * whitespace, increase line number
819 * @param buf place to store the line read
820 * @param bufsize size of the buffer
821 * @param cfp File to read from
822 * @return error status, APR_ENOSPC if bufsize is too small for the line
824 AP_DECLARE(apr_status_t) ap_cfg_getline(char *buf, apr_size_t bufsize, ap_configfile_t *cfp);
827 * Read one char from open configfile_t, increase line number upon LF
828 * @param ch place to store the char read
829 * @param cfp The file to read from
830 * @return error status
832 AP_DECLARE(apr_status_t) ap_cfg_getc(char *ch, ap_configfile_t *cfp);
835 * Detach from open ap_configfile_t, calling the close handler
836 * @param cfp The file to close
837 * @return 1 on sucess, 0 on failure
839 AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
842 * Convert a return value from ap_cfg_getline or ap_cfg_getc to a user friendly
844 * @param p The pool to allocate the string from
845 * @param cfp The config file
846 * @param rc The return value to convert
847 * @return The error string, NULL if rc == APR_SUCCESS
849 AP_DECLARE(const char *) ap_pcfg_strerror(apr_pool_t *p, ap_configfile_t *cfp,
853 * Read all data between the current <foo> and the matching </foo>. All
854 * of this data is forgotten immediately.
855 * @param cmd The cmd_parms to pass to the directives inside the container
856 * @param directive The directive name to read until
857 * @return Error string on failure, NULL on success
858 * @note If cmd->pool == cmd->temp_pool, ap_soak_end_container() will assume
859 * .htaccess context and use a lower maximum line length.
861 AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
864 * Read all data between the current <foo> and the matching </foo> and build
865 * a config tree from it
866 * @param p pool to allocate from
867 * @param temp_pool Temporary pool to allocate from
868 * @param parms The cmd_parms to pass to all directives read
869 * @param current The current node in the tree
870 * @param curr_parent The current parent node
871 * @param orig_directive The directive to read until hit.
872 * @return Error string on failure, NULL on success
873 * @note If p == temp_pool, ap_build_cont_config() will assume .htaccess
874 * context and use a lower maximum line length.
876 AP_DECLARE(const char *) ap_build_cont_config(apr_pool_t *p,
877 apr_pool_t *temp_pool,
879 ap_directive_t **current,
880 ap_directive_t **curr_parent,
881 char *orig_directive);
884 * Build a config tree from a config file
885 * @param parms The cmd_parms to pass to all of the directives in the file
886 * @param conf_pool The pconf pool
887 * @param temp_pool The temporary pool
888 * @param conftree Place to store the root node of the config tree
889 * @return Error string on erro, NULL otherwise
890 * @note If conf_pool == temp_pool, ap_build_config() will assume .htaccess
891 * context and use a lower maximum line length.
893 AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
894 apr_pool_t *conf_pool,
895 apr_pool_t *temp_pool,
896 ap_directive_t **conftree);
899 * Walk a config tree and setup the server's internal structures
900 * @param conftree The config tree to walk
901 * @param parms The cmd_parms to pass to all functions
902 * @param section_vector The per-section config vector.
903 * @return Error string on error, NULL otherwise
905 AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
907 ap_conf_vector_t *section_vector);
910 * @defgroup ap_check_cmd_context Check command context
914 * Check the context a command is used in.
915 * @param cmd The command to check
916 * @param forbidden Where the command is forbidden.
917 * @return Error string on error, NULL on success
919 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd,
922 #define NOT_IN_VIRTUALHOST 0x01 /**< Forbidden in <VirtualHost> */
923 #define NOT_IN_LIMIT 0x02 /**< Forbidden in <Limit> */
924 #define NOT_IN_DIRECTORY 0x04 /**< Forbidden in <Directory> */
925 #define NOT_IN_LOCATION 0x08 /**< Forbidden in <Location> */
926 #define NOT_IN_FILES 0x10 /**< Forbidden in <Files> or <If>*/
927 #define NOT_IN_HTACCESS 0x20 /**< Forbidden in .htaccess files */
928 #define NOT_IN_PROXY 0x40 /**< Forbidden in <Proxy> */
929 /** Forbidden in <Directory>/<Location>/<Files><If><Proxy>*/
930 #define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES|NOT_IN_PROXY)
931 /** Forbidden in <VirtualHost>/<Limit>/<Directory>/<Location>/<Files>/<If><Proxy>*/
932 #define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
937 * @brief This structure is used to assign symbol names to module pointers
942 } ap_module_symbol_t;
945 * The topmost module in the list
946 * @var module *ap_top_module
948 AP_DECLARE_DATA extern module *ap_top_module;
951 * Array of all statically linked modules
952 * @var module *ap_prelinked_modules[]
954 AP_DECLARE_DATA extern module *ap_prelinked_modules[];
956 * Array of all statically linked modulenames (symbols)
957 * @var ap_module_symbol_t ap_prelinked_module_symbols[]
959 AP_DECLARE_DATA extern ap_module_symbol_t ap_prelinked_module_symbols[];
961 * Array of all preloaded modules
962 * @var module *ap_preloaded_modules[]
964 AP_DECLARE_DATA extern module *ap_preloaded_modules[];
966 * Array of all loaded modules
967 * @var module **ap_loaded_modules
969 AP_DECLARE_DATA extern module **ap_loaded_modules;
971 /* For mod_so.c... */
972 /** Run a single module's two create_config hooks
973 * @param p the pool to allocate from
974 * @param s The server to configure for.
975 * @param m The module to configure
977 AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
980 /* For http_main.c... */
982 * Add all of the prelinked modules into the loaded module list
983 * @param process The process that is currently running the server
985 AP_DECLARE(const char *) ap_setup_prelinked_modules(process_rec *process);
988 * Show the preloaded configuration directives, the help string explaining
989 * the directive arguments, in what module they are handled, and in
990 * what parts of the configuration they are allowed. Used for httpd -h.
992 AP_DECLARE(void) ap_show_directives(void);
995 * Show the preloaded module names. Used for httpd -l.
997 AP_DECLARE(void) ap_show_modules(void);
1000 * Show the MPM name. Used in reporting modules such as mod_info to
1001 * provide extra information to the user
1003 AP_DECLARE(const char *) ap_show_mpm(void);
1006 * Read all config files and setup the server
1007 * @param process The process running the server
1008 * @param temp_pool A pool to allocate temporary data from.
1009 * @param config_name The name of the config file
1010 * @param conftree Place to store the root of the config tree
1011 * @return The setup server_rec list.
1013 AP_DECLARE(server_rec *) ap_read_config(process_rec *process,
1014 apr_pool_t *temp_pool,
1015 const char *config_name,
1016 ap_directive_t **conftree);
1019 * Run all rewrite args hooks for loaded modules
1020 * @param process The process currently running the server
1022 AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
1025 * Run the register hooks function for a specified module
1026 * @param m The module to run the register hooks function fo
1027 * @param p The pool valid for the lifetime of the module
1029 AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
1032 * Setup all virtual hosts
1033 * @param p The pool to allocate from
1034 * @param main_server The head of the server_rec list
1036 AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p,
1037 server_rec *main_server);
1040 * Reserve some modules slots for modules loaded by other means than
1041 * EXEC_ON_READ directives.
1042 * Relevant modules should call this in the pre_config stage.
1043 * @param count The number of slots to reserve.
1045 AP_DECLARE(void) ap_reserve_module_slots(int count);
1048 * Reserve some modules slots for modules loaded by a specific
1049 * non-EXEC_ON_READ config directive.
1050 * This counts how often the given directive is used in the config and calls
1051 * ap_reserve_module_slots() accordingly.
1052 * @param directive The name of the directive
1054 AP_DECLARE(void) ap_reserve_module_slots_directive(const char *directive);
1056 /* For http_request.c... */
1059 * Setup the config vector for a request_rec
1060 * @param p The pool to allocate the config vector from
1061 * @return The config vector
1063 AP_DECLARE(ap_conf_vector_t*) ap_create_request_config(apr_pool_t *p);
1066 * Setup the config vector for per dir module configs
1067 * @param p The pool to allocate the config vector from
1068 * @return The config vector
1070 AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
1073 * Run all of the modules merge per dir config functions
1074 * @param p The pool to pass to the merge functions
1075 * @param base The base directory config structure
1076 * @param new_conf The new directory config structure
1078 AP_CORE_DECLARE(ap_conf_vector_t*) ap_merge_per_dir_configs(apr_pool_t *p,
1079 ap_conf_vector_t *base,
1080 ap_conf_vector_t *new_conf);
1083 * Allocate new ap_logconf and make (deep) copy of old ap_logconf
1084 * @param p The pool to alloc from
1085 * @param old The ap_logconf to copy (may be NULL)
1086 * @return The new ap_logconf struct
1088 AP_DECLARE(struct ap_logconf *) ap_new_log_config(apr_pool_t *p,
1089 const struct ap_logconf *old);
1092 * Merge old ap_logconf into new ap_logconf.
1093 * old and new must have the same life time.
1094 * @param old_conf The ap_logconf to merge from
1095 * @param new_conf The ap_logconf to merge into
1097 AP_DECLARE(void) ap_merge_log_config(const struct ap_logconf *old_conf,
1098 struct ap_logconf *new_conf);
1100 /* For http_connection.c... */
1102 * Setup the config vector for a connection_rec
1103 * @param p The pool to allocate the config vector from
1104 * @return The config vector
1106 AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
1108 /* For http_core.c... (<Directory> command and virtual hosts) */
1111 * parse an htaccess file
1112 * @param result htaccess_result
1113 * @param r The request currently being served
1114 * @param override Which overrides are active
1115 * @param override_opts Which allow-override-opts bits are set
1116 * @param override_list Table of directives allowed for override
1117 * @param path The path to the htaccess file
1118 * @param access_name The list of possible names for .htaccess files
1119 * int The status of the current request
1121 AP_CORE_DECLARE(int) ap_parse_htaccess(ap_conf_vector_t **result,
1125 apr_table_t *override_list,
1127 const char *access_name);
1130 * Setup a virtual host
1131 * @param p The pool to allocate all memory from
1132 * @param hostname The hostname of the virtual hsot
1133 * @param main_server The main server for this Apache configuration
1134 * @param ps Place to store the new server_rec
1135 * return Error string on error, NULL on success
1137 AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p,
1138 const char *hostname,
1139 server_rec *main_server,
1143 * Process a config file for Apache
1144 * @param s The server rec to use for the command parms
1145 * @param fname The name of the config file
1146 * @param conftree The root node of the created config tree
1147 * @param p Pool for general allocation
1148 * @param ptemp Pool for temporary allocation
1150 AP_DECLARE(const char *) ap_process_resource_config(server_rec *s,
1152 ap_directive_t **conftree,
1157 * Process all matching files as Apache configs
1158 * @param s The server rec to use for the command parms
1159 * @param fname The filename pattern of the config file
1160 * @param conftree The root node of the created config tree
1161 * @param p Pool for general allocation
1162 * @param ptemp Pool for temporary allocation
1163 * @param optional Whether a no-match wildcard is allowed
1164 * @see apr_fnmatch for pattern handling
1166 AP_DECLARE(const char *) ap_process_fnmatch_configs(server_rec *s,
1168 ap_directive_t **conftree,
1174 * Process all directives in the config tree
1175 * @param s The server rec to use in the command parms
1176 * @param conftree The config tree to process
1177 * @param p The pool for general allocation
1178 * @param ptemp The pool for temporary allocations
1179 * @return OK if no problems
1181 AP_DECLARE(int) ap_process_config_tree(server_rec *s,
1182 ap_directive_t *conftree,
1187 * Store data which will be retained across unload/load of modules
1188 * @param key The unique key associated with this module's retained data
1189 * @param size in bytes of the retained data (to be allocated)
1190 * @return Address of new retained data structure, initially cleared
1192 AP_DECLARE(void *) ap_retained_data_create(const char *key, apr_size_t size);
1195 * Retrieve data which was stored by ap_retained_data_create()
1196 * @param key The unique key associated with this module's retained data
1197 * @return Address of previously retained data structure, or NULL if not yet saved
1199 AP_DECLARE(void *) ap_retained_data_get(const char *key);
1201 /* Module-method dispatchers, also for http_request.c */
1203 * Run the handler phase of each module until a module accepts the
1204 * responsibility of serving the request
1205 * @param r The current request
1206 * @return The status of the current request
1208 AP_CORE_DECLARE(int) ap_invoke_handler(request_rec *r);
1213 * Find a given directive in a command_rec table
1214 * @param name The directive to search for
1215 * @param cmds The table to search
1216 * @return The directive definition of the specified directive
1218 AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name,
1219 const command_rec *cmds);
1222 * Find a given directive in a list of modules.
1223 * @param cmd_name The directive to search for
1224 * @param mod Pointer to the first module in the linked list; will be set to
1225 * the module providing cmd_name
1226 * @return The directive definition of the specified directive.
1227 * *mod will be changed to point to the module containing the
1230 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name,
1234 * Ask a module to create per-server and per-section (dir/loc/file) configs
1235 * (if it hasn't happened already). The results are stored in the server's
1236 * config, and the specified per-section config vector.
1237 * @param server The server to operate upon.
1238 * @param section_vector The per-section config vector.
1239 * @param section Which section to create a config for.
1240 * @param mod The module which is defining the config data.
1241 * @param pconf A pool for all configuration allocations.
1242 * @return The (new) per-section config data.
1244 AP_CORE_DECLARE(void *) ap_set_config_vectors(server_rec *server,
1245 ap_conf_vector_t *section_vector,
1246 const char *section,
1247 module *mod, apr_pool_t *pconf);
1252 * Run the header parser functions for each module
1253 * @param r The current request
1254 * @return OK or DECLINED
1257 AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
1260 * Run the pre_config function for each module
1261 * @param pconf The config pool
1262 * @param plog The logging streams pool
1263 * @param ptemp The temporary pool
1264 * @return OK or DECLINED on success anything else is a error
1267 AP_DECLARE_HOOK(int,pre_config,(apr_pool_t *pconf,apr_pool_t *plog,
1271 * Run the check_config function for each module
1272 * @param pconf The config pool
1273 * @param plog The logging streams pool
1274 * @param ptemp The temporary pool
1275 * @param s the server to operate upon
1276 * @return OK or DECLINED on success anything else is a error
1279 AP_DECLARE_HOOK(int,check_config,(apr_pool_t *pconf, apr_pool_t *plog,
1280 apr_pool_t *ptemp, server_rec *s))
1283 * Run the test_config function for each module; this hook is run
1284 * only if the server was invoked to test the configuration syntax.
1285 * @param pconf The config pool
1286 * @param s The list of server_recs
1287 * @note To avoid reordering problems due to different buffering, hook
1288 * functions should only apr_file_*() to print to stdout/stderr and
1289 * not simple printf()/fprintf().
1292 AP_DECLARE_HOOK(void,test_config,(apr_pool_t *pconf, server_rec *s))
1295 * Run the post_config function for each module
1296 * @param pconf The config pool
1297 * @param plog The logging streams pool
1298 * @param ptemp The temporary pool
1299 * @param s The list of server_recs
1300 * @return OK or DECLINED on success anything else is a error
1303 AP_DECLARE_HOOK(int,post_config,(apr_pool_t *pconf,apr_pool_t *plog,
1304 apr_pool_t *ptemp,server_rec *s))
1307 * Run the open_logs functions for each module
1308 * @param pconf The config pool
1309 * @param plog The logging streams pool
1310 * @param ptemp The temporary pool
1311 * @param s The list of server_recs
1312 * @return OK or DECLINED on success anything else is a error
1315 AP_DECLARE_HOOK(int,open_logs,(apr_pool_t *pconf,apr_pool_t *plog,
1316 apr_pool_t *ptemp,server_rec *s))
1319 * Run the child_init functions for each module
1320 * @param pchild The child pool
1321 * @param s The list of server_recs in this server
1324 AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
1327 * Run the handler functions for each module
1328 * @param r The request_rec
1329 * @remark non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
1332 AP_DECLARE_HOOK(int,handler,(request_rec *r))
1335 * Run the quick handler functions for each module. The quick_handler
1336 * is run before any other requests hooks are called (location_walk,
1337 * directory_walk, access checking, et. al.). This hook was added
1338 * to provide a quick way to serve content from a URI keyed cache.
1340 * @param r The request_rec
1341 * @param lookup_uri Controls whether the caller actually wants content or not.
1342 * lookup is set when the quick_handler is called out of
1343 * ap_sub_req_lookup_uri()
1346 AP_DECLARE_HOOK(int,quick_handler,(request_rec *r, int lookup_uri))
1349 * Retrieve the optional functions for each module.
1350 * This is run immediately before the server starts. Optional functions should
1351 * be registered during the hook registration phase.
1354 AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
1357 * Allow modules to open htaccess files or perform operations before doing so
1358 * @param r The current request
1359 * @param dir_name The directory for which the htaccess file should be opened
1360 * @param access_name The filename for which the htaccess file should be opened
1361 * @param conffile Where the pointer to the opened ap_configfile_t must be
1363 * @param full_name Where the full file name of the htaccess file must be
1365 * @return APR_SUCCESS on success,
1366 * APR_ENOENT or APR_ENOTDIR if no htaccess file exists,
1367 * AP_DECLINED to let later modules do the opening,
1368 * any other error code on error.
1371 AP_DECLARE_HOOK(apr_status_t,open_htaccess,
1372 (request_rec *r, const char *dir_name, const char *access_name,
1373 ap_configfile_t **conffile, const char **full_name))
1376 * Core internal function, use ap_run_open_htaccess() instead.
1378 apr_status_t ap_open_htaccess(request_rec *r, const char *dir_name,
1379 const char *access_name, ap_configfile_t **conffile,
1380 const char **full_name);
1383 * A generic pool cleanup that will reset a pointer to NULL. For use with
1384 * apr_pool_cleanup_register.
1385 * @param data The address of the pointer
1386 * @return APR_SUCCESS
1388 AP_DECLARE_NONSTD(apr_status_t) ap_pool_cleanup_set_null(void *data);
1394 #endif /* !APACHE_HTTP_CONFIG_H */