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.
59 #ifndef APACHE_HTTP_CONFIG_H
60 #define APACHE_HTTP_CONFIG_H
63 #include "util_cfgtree.h"
70 * @package Apache Configuration
74 * The central data structures around here...
77 /* Command dispatch structures... */
80 * How the directives arguments should be parsed.
81 * @tip Note that for all of these except RAW_ARGS, the config routine is
82 * passed a freshly allocated string which can be modified or stored
83 * or whatever... it's only necessary to do pstrdup() stuff with
85 * RAW_ARGS -- cmd_func parses command line itself
86 * TAKE1 -- one argument only
87 * TAKE2 -- two arguments only
88 * ITERATE -- one argument, occuring multiple times
89 * * (e.g., IndexIgnore)
90 * ITERATE2 -- two arguments, 2nd occurs multiple times
92 * FLAG -- One of 'On' or 'Off'
93 * NO_ARGS -- No args at all, e.g. </Directory>
94 * TAKE12 -- one or two arguments
95 * TAKE3 -- three arguments only
96 * TAKE23 -- two or three arguments
97 * TAKE123 -- one, two or three arguments
98 * TAKE13 -- one or three arguments
100 * @defvar enum cmd_how
103 RAW_ARGS, /* cmd_func parses command line itself */
104 TAKE1, /* one argument only */
105 TAKE2, /* two arguments only */
106 ITERATE, /* one argument, occuring multiple times
107 * (e.g., IndexIgnore)
109 ITERATE2, /* two arguments, 2nd occurs multiple times
112 FLAG, /* One of 'On' or 'Off' */
113 NO_ARGS, /* No args at all, e.g. </Directory> */
114 TAKE12, /* one or two arguments */
115 TAKE3, /* three arguments only */
116 TAKE23, /* two or three arguments */
117 TAKE123, /* one, two or three arguments */
118 TAKE13 /* one or three arguments */
121 typedef struct cmd_parms_struct cmd_parms;
126 const char *(*no_args) (cmd_parms *parms, void *mconfig);
127 const char *(*raw_args) (cmd_parms *parms, void *mconfig,
129 const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
130 const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
132 const char *(*take3) (cmd_parms *parms, void *mconfig, const char *w,
133 const char *w2, const char *w3);
134 const char *(*flag) (cmd_parms *parms, void *mconfig, int on);
137 # define AP_NO_ARGS func.no_args
138 # define AP_RAW_ARGS func.raw_args
139 # define AP_TAKE1 func.take1
140 # define AP_TAKE2 func.take2
141 # define AP_TAKE3 func.take3
142 # define AP_FLAG func.flag
144 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
145 { directive, { .no_args=func }, mconfig, where, RAW_ARGS, help }
146 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
147 { directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
148 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
149 { directive, { .take1=func }, mconfig, where, TAKE1, help }
150 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
151 { directive, { .take1=func }, mconfig, where, ITERATE, help }
152 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
153 { directive, { .take2=func }, mconfig, where, TAKE2, help }
154 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
155 { directive, { .take2=func }, mconfig, where, TAKE12, help }
156 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
157 { directive, { .take2=func }, mconfig, where, ITERATE2, help }
158 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
159 { directive, { .take3=func }, mconfig, where, TAKE23, help }
160 # define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
161 { directive, { .take3=func }, mconfig, where, TAKE3, help }
162 # define AP_INIT_FLAG(directive, func, mconfig, where, help) \
163 { directive, { .flag=func }, mconfig, where, FLAG, help }
167 typedef const char *(*cmd_func) ();
169 # define AP_NO_ARGS func
170 # define AP_RAW_ARGS func
171 # define AP_TAKE1 func
172 # define AP_TAKE2 func
173 # define AP_TAKE3 func
174 # define AP_FLAG func
176 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
177 { directive, func, mconfig, where, RAW_ARGS, help }
178 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
179 { directive, func, mconfig, where, RAW_ARGS, help }
180 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
181 { directive, func, mconfig, where, TAKE1, help }
182 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
183 { directive, func, mconfig, where, ITERATE, help }
184 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
185 { directive, func, mconfig, where, TAKE2, help }
186 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
187 { directive, func, mconfig, where, TAKE12, help }
188 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
189 { directive, func, mconfig, where, ITERATE2, help }
190 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
191 { directive, func, mconfig, where, TAKE23, 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 }
199 typedef struct command_struct command_rec;
201 * The command record structure. Each modules can define a table of these
202 * to define the directives it will implement.
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 * @defvar cmd_how args_how*/
215 enum cmd_how args_how;
217 /** 'usage' message, in case of syntax errors */
221 /* The allowed locations for a configuration directive are the union of
222 * those indicated by each set bit in the req_override mask.
224 * (req_override & RSRC_CONF) => *.conf outside <Directory> or <Location>
225 * (req_override & ACCESS_CONF) => *.conf inside <Directory> or <Location>
226 * (req_override & OR_AUTHCFG) => *.conf inside <Directory> or <Location>
227 * and .htaccess when AllowOverride AuthConfig
228 * (req_override & OR_LIMIT) => *.conf inside <Directory> or <Location>
229 * and .htaccess when AllowOverride Limit
230 * (req_override & OR_OPTIONS) => *.conf anywhere
231 * and .htaccess when AllowOverride Options
232 * (req_override & OR_FILEINFO) => *.conf anywhere
233 * and .htaccess when AllowOverride FileInfo
234 * (req_override & OR_INDEXES) => *.conf anywhere
235 * and .htaccess when AllowOverride Indexes
240 #define OR_FILEINFO 4
242 #define OR_INDEXES 16
244 #define ACCESS_CONF 64
245 #define RSRC_CONF 128
246 #define EXEC_ON_READ 256
247 #define OR_ALL (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
250 * This can be returned by a function if they don't wish to handle
251 * a command. Make it something not likely someone will actually use
253 * @defvar DECLINE_CMD "\a\b"
255 #define DECLINE_CMD "\a\b"
257 typedef struct configfile_t configfile_t;
258 /** Common structure for reading of config files / passwd files etc. */
259 struct configfile_t {
260 /** a getc()-like function
261 * @deffunc int getch(void *param) */
262 int (*getch) (void *param);
263 /** a fgets()-like function
264 * @deffunc void *getstr(void *buf, size_t bufsize, void *param)*/
265 void *(*getstr) (void *buf, size_t bufsiz, void *param);
266 /** a close hander function
267 * @deffunc int close(void *param)*/
268 int (*close) (void *param);
269 /** the argument passed to getch/getstr/close */
271 /** the filename / description */
273 /** current line number, starting at 1 */
274 unsigned line_number;
278 * This structure is passed to a command which is being invoked,
279 * to carry a large variety of miscellaneous data which is all of
280 * use to *somebody*...
282 struct cmd_parms_struct {
283 /** Argument to command from cmd_table */
285 /** Which allow-override bits are set */
287 /** Which methods are <Limit>ed */
289 apr_array_header_t *limited_xmethods;
290 ap_method_list_t *xlimited;
292 /** Config file structure. */
293 configfile_t *config_file;
294 /** the directive specifying this command */
295 ap_directive_t *directive;
297 /** Pool to allocate new storage in */
299 /** Pool for scratch memory; persists during configuration, but
300 * wiped before the first request is served... */
301 apr_pool_t *temp_pool;
302 /** Server_rec being configured for */
304 /** If configuring for a directory, pathname of that directory.
305 * NOPE! That's what it meant previous to the existance of <Files>,
306 * <Location> and regex matching. Now the only usefulness that can be
307 * derived from this field is whether a command is being called in a
308 * server context (path == NULL) or being called in a dir context
311 /** configuration command */
312 const command_rec *cmd;
314 /** per_dir_config vector passed to handle_command */
316 /** directive with syntax error */
317 const ap_directive_t *err_directive;
320 typedef struct module_struct module;
322 * Module structures. Just about everything is dispatched through
323 * these, directly or indirectly (through the command and handler
326 struct module_struct {
327 /** API version, *not* module version; check that module is
328 * compatible with this version of the server.
331 /** API minor version. Provides API feature milestones. Not checked
332 * during module init */
334 /** Index to this modules structures in config vectors. */
337 /** The name of the module's C file */
339 /** The handle for the DSO. Internal use only */
340 void *dynamic_load_handle;
342 /** A pointer to the next module in the list
343 * @defvar module_struct *next */
344 struct module_struct *next;
346 /** Magic Cookie to identify a module structure; It's mainly
347 * important for the DSO facility (see also mod_so). */
350 /** Function to allow MPMs to re-write command line arguments. This
351 * hook is only available to MPMs.
352 * @param The process that the server is running in.
353 * @deffunc void rewrite_args(process_rec *process);
355 void (*rewrite_args) (process_rec *process);
356 /** Function to allow all modules to create per directory configuration
358 * @param p The pool to use for all allocations.
359 * @param dir The directory currently being processed.
360 * @return The per-directory structure created
361 * @deffunc void *create_dir_config(apr_pool_t *p, char *dir)
363 void *(*create_dir_config) (apr_pool_t *p, char *dir);
364 /** Function to allow all modules to merge the per directory configuration
365 * structures for two directories.
366 * @param p The pool to use for all allocations.
367 * @param base_conf The directory structure created for the parent directory.
368 * @param new_conf The directory structure currently being processed.
369 * @return The new per-directory structure created
370 * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
372 void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *new_conf);
373 /** Function to allow all modules to create per server configuration
375 * @param p The pool to use for all allocations.
376 * @param s The server currently being processed.
377 * @return The per-server structure created
378 * @deffunc void *create_server_config(apr_pool_t *p, server_rec *dir)
380 void *(*create_server_config) (apr_pool_t *p, server_rec *s);
381 /** Function to allow all modules to merge the per server configuration
382 * structures for two servers.
383 * @param p The pool to use for all allocations.
384 * @param base_conf The directory structure created for the parent directory.
385 * @param new_conf The directory structure currently being processed.
386 * @return The new per-directory structure created
387 * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
389 void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void *new_conf);
391 /** A command_rec table that describes all of the directives this module
393 const command_rec *cmds;
395 /** A hook to allow modules to hook other points in the request processing.
396 * In this function, modules should call the ap_hook_*() functions to
397 * register an interest in a specific step in processing the current
399 * @deffunc void register_hooks(void)
401 void (*register_hooks) (void);
404 /* Initializer for the first few module slots, which are only
405 * really set up once we start running. Note that the first two slots
406 * provide a version check; this should allow us to deal with changes to
407 * the API. The major number should reflect changes to the API handler table
408 * itself or removal of functionality. The minor number should reflect
409 * additions of functionality to the existing API. (the server can detect
410 * an old-format module, and either handle it back-compatibly, or at least
411 * signal an error). See src/include/ap_mmn.h for MMN version history.
414 #define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
416 #define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
417 MODULE_MAGIC_NUMBER_MINOR, \
422 MODULE_MAGIC_COOKIE, \
423 NULL /* rewrite args spot */
425 #define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
426 MODULE_MAGIC_NUMBER_MINOR, \
435 * Generic accessors for other modules to get at their own module-specific
437 * @param conf_vector The vector in which the modules configuration is stored.
438 * usually r->per_dir_config or s->module_config
439 * @param m The module to get the data for.
440 * @return The module-specific data
441 * @deffunc void *ap_get_module_config(void *conf_vector, module *m)
443 AP_DECLARE(void *) ap_get_module_config(void *conf_vector, module *m);
447 * Generic accessors for other modules to set at their own module-specific
449 * @param conf_vector The vector in which the modules configuration is stored.
450 * usually r->per_dir_config or s->module_config
451 * @param m The module to set the data for.
452 * @param val The module-specific data to set
453 * @deffunc void ap_set_module_config(void *conf_vector, module *m, void *val)
455 AP_DECLARE(void) ap_set_module_config(void *conf_vector, module *m, void *val);
458 #define ap_get_module_config(v,m) \
459 (((void **)(v))[(m)->module_index])
460 #define ap_set_module_config(v,m,val) \
461 ((((void **)(v))[(m)->module_index]) = (val))
464 * Generic command handling function for strings
465 * @param cmd The command parameters for this directive
466 * @param struct_ptr pointer into a given type
467 * @param arg The argument to the directive
468 * @return An error string or NULL on success
469 * @deffunc const char *ap_set_string_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
471 AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *, void *,
475 * Return true if the specified method is limited by being listed in
476 * a <Limit> container, or by *not* being listed in a <LimiteExcept>
479 * @param method Pointer to a string specifying the method to check.
480 * @param cmd Pointer to the cmd_parms structure passed to the
482 * @return 0 if the method is not limited in the current scope
483 * @deffunc ap_method_is_limited(cmd_parms *cmd, const char *method)
485 AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
488 * Generic command handling function for strings, always sets the value
489 * to a lowercase string
490 * @param cmd The command parameters for this directive
491 * @param struct_ptr pointer into a given type
492 * @param arg The argument to the directive
493 * @return An error string or NULL on success
494 * @deffunc const char *ap_set_string_slot_lower(cmd_parms *cmd, void *struct_ptr, const char *arg)
496 AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *,
497 void *, const char *);
499 * Generic command handling function for flags
500 * @param cmd The command parameters for this directive
501 * @param struct_ptr pointer into a given type
502 * @param arg The argument to the directive (either 1 or 0)
503 * @return An error string or NULL on success
504 * @deffunc const char *ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg)
506 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *, void *, int);
508 * Generic command handling function for files
509 * @param cmd The command parameters for this directive
510 * @param struct_ptr pointer into a given type
511 * @param arg The argument to the directive
512 * @return An error string or NULL on success
513 * @deffunc const char *ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
515 AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *, void *, const char *);
518 * For modules which need to read config files, open logs, etc. ...
519 * this returns the fname argument if it begins with '/'; otherwise
520 * it relativizes it wrt server_root.
521 * @param p pool to allocate data out of
522 * @param fname The file name
523 * @deffunc const char *ap_server_root_relative(apr_pool_t *p, const char *fname)
525 AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
527 /* Finally, the hook for dynamically loading modules in... */
530 * Add a module to the server
531 * @param m the module structure of the module to add
532 * @deffunc void ap_add_module(module *m)
534 AP_DECLARE(void) ap_add_module(module *m);
536 * Remove a module from the server. There are some caveats:
537 * when the module is removed, its slot is lost so all the current
538 * per-dir and per-server configurations are invalid. So we should
539 * only ever call this function when you are invalidating almost
540 * all our current data. I.e. when doing a restart.
541 * @param m the module structure of the module to remove
542 * @deffunc void ap_remove_module(module *m)
544 AP_DECLARE(void) ap_remove_module(module *m);
546 * Add a module to the chained modules list and the list of loaded modules
547 * @param m the module structure of the module to add
548 * @deffunc void ap_add_loaded_module(module *m)
550 AP_DECLARE(void) ap_add_loaded_module(module *mod);
552 * Remove a module fromthe chained modules list and the list of loaded modules
553 * @param m the module structure of the module to remove
554 * @deffunc void ap_remove_loaded_module(module *m)
556 AP_DECLARE(void) ap_remove_loaded_module(module *mod);
558 * Add a module to the list of loaded module based on the name of the
560 * @param name The name of the module
561 * @return 1 on success, 0 on failure
562 * @deffunc int ap_add_named_module(const char *name)
564 AP_DECLARE(int) ap_add_named_module(const char *name);
566 * Clear all of the modules from the loaded module list
567 * @deffunc void ap_add_named_module(void)
569 AP_DECLARE(void) ap_clear_module_list(void);
571 * Find the name of the specified module
572 * @param m The module to get the name for
573 * @return the name of the module
574 * @deffunc const char *ap_find_module_name(module *m)
576 AP_DECLARE(const char *) ap_find_module_name(module *m);
578 * Find a module based on the name of the module
579 * @param name the name of the module
580 * @return the module structure if found, NULL otherwise
581 * @deffunc module *ap_find_linked_module(const char *name)
583 AP_DECLARE(module *) ap_find_linked_module(const char *name);
586 * Open a configfile_t as apr_file_t
587 * @param ret_cfg open configfile_t struct pointer
588 * @param p The pool to allocate the structure out of
589 * @param name the name of the file to open
590 * @deffunc apr_status_t ap_pcfg_openfile(configfile_t **ret_cfg, apr_pool_t *p, const char *name)
592 AP_DECLARE(apr_status_t) ap_pcfg_openfile(configfile_t **, apr_pool_t *p, const char *name);
595 * Allocate a configfile_t handle with user defined functions and params
596 * @param p The pool to allocate out of
597 * @param descr The name of the file
598 * @param param The argument passed to getch/getstr/close
599 * @param getc_func The getch function
600 * @param gets_func The getstr function
601 * @param close_func The close function
602 * @deffunc configfile_t *ap_pcfg_open_custom(apr_pool_t *p, const char *descr, void *param, int(*getc_func)(void*), void *(*gets_func) (void *buf, size_t bufsiz, void *param), int(*close_func)(void *param))
604 AP_DECLARE(configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
606 int(*getc_func)(void*),
607 void *(*gets_func) (void *buf, size_t bufsiz, void *param),
608 int(*close_func)(void *param));
611 * Read one line from open configfile_t, strip LF, increase line number
612 * @param buf place to store the line read
613 * @param bufsize size of the buffer
614 * @param cfp File to read from
615 * @return 1 on success, 0 on failure
616 * @deffunc int ap_cfg_getline(char *buf, size_t bufsize, configfile_t *cfp)
618 AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, configfile_t *cfp);
621 * Read one char from open configfile_t, increase line number upon LF
622 * @param cfp The file to read from
623 * @return the character read
624 * @deffunc int ap_cfg_getc(configfile_t *cfp)
626 AP_DECLARE(int) ap_cfg_getc(configfile_t *cfp);
629 * Detach from open configfile_t, calling the close handler
630 * @param cfp The file to close
631 * @return 1 on sucess, 0 on failure
632 * @deffunc int ap_cfg_closefile(configfile_t *cfp)
634 AP_DECLARE(int) ap_cfg_closefile(configfile_t *cfp);
637 * Read all data between the current <foo> and the matching </foo>. All
638 * of this data is forgotten immediately.
639 * @param cmd The cmd_parms to pass to the directives inside the container
640 * @param directive The directive name to read until
641 * @retrn Error string on failure, NULL on success
642 * @deffunc const char *ap_soak_end_container(cmd_parms *cmd, char *directive)
644 AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
647 * Read all data between the current <foo> and the matching </foo> and build
648 * a config tree out of it
649 * @param p pool to allocate out of
650 * @param temp_pool Temporary pool to allocate out of
651 * @param parms The cmd_parms to pass to all directives read
652 * @param current The current node in the tree
653 * @param curr_parent The current parent node
654 * @param orig_directive The directive to read until hit.
655 * @return Error string on failure, NULL on success
656 * @deffunc char *ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool, cmd_parms *parms, ap_directive_t **current, ap_directive_t **curr_parent, char *orig_directive)
658 const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
660 ap_directive_t **current,
661 ap_directive_t **curr_parent,
662 char *orig_directive);
665 * Build a config tree from a config file
666 * @param parms The cmd_parms to pass to all of the directives in the file
667 * @param conf_pool The pconf pool
668 * @param temp_pool The temporary pool
669 * @param conftree Place to store the root node of the config tree
670 * @return Error string on erro, NULL otherwise
671 * @deffunc const char *ap_build_config(cmd_parms *parms, apr_pool_t *conf_pool, apr_pool_t *temp_pool, ap_directive_t **conftree)
673 AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
674 apr_pool_t *conf_pool,
675 apr_pool_t *temp_pool,
676 ap_directive_t **conftree);
679 * Walk a config tree and setup the server's internal structures
680 * @param conftree The config tree to walk
681 * @param parms The cmd_parms to pass to all functions
682 * @param config The parms context
683 * @return Error string on error, NULL otherwise
684 * @deffunc const char *ap_walk_config(ap_directive_t *conftree, cmd_parms *parms, void *config)
686 AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
687 cmd_parms *parms, void *config);
690 * ap_check_cmd_context() definitions:
691 * @param cmd The cmd_context to check
692 * @param forbidden Where the command is forbidden. One of:
699 * NOT_IN_DIR_LOC_FILE
702 * @return Error string on error, NULL on success
703 * @deffunc const char *ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden)
705 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
707 /* ap_check_cmd_context(): Forbidden in: */
708 #define NOT_IN_VIRTUALHOST 0x01 /* <Virtualhost> */
709 #define NOT_IN_LIMIT 0x02 /* <Limit> */
710 #define NOT_IN_DIRECTORY 0x04 /* <Directory> */
711 #define NOT_IN_LOCATION 0x08 /* <Location> */
712 #define NOT_IN_FILES 0x10 /* <Files> */
713 #define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES) /* <Directory>/<Location>/<Files>*/
714 #define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
720 * The topmost module in the list
721 * @defvar module *top_module
723 extern AP_DECLARE_DATA module *top_module;
726 * Array of all statically linked modules
727 * @defvar module *ap_prelinked_modules[]
729 extern AP_DECLARE_DATA module *ap_prelinked_modules[];
731 * Array of all preloaded modules
732 * @defvar module *ap_preloaded_modules[]
734 extern AP_DECLARE_DATA module *ap_preloaded_modules[];
736 * Array of all loaded modules
737 * @defvar module **ap_loaded_modules
739 extern AP_DECLARE_DATA module **ap_loaded_modules;
741 /* For mod_so.c... */
742 /** Run a single module's two create_config hooks
743 * @param p the pool to allocate out of
744 * @param s The server to configure for.
745 * @param m The module to configure
747 void ap_single_module_configure(apr_pool_t *p, server_rec *s, module *m);
749 /* For http_main.c... */
751 * Add all of the prelinked modules into the loaded module list
752 * @param process The process that is currently running the server
753 * @deffunc void ap_setup_prelinked_modules(process_rec *process)
755 AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
758 *Show the preloaded configuration directives, the help string explaining
759 * the directive arguments, in what module they are handled, and in
760 * what parts of the configuration they are allowed. Used for httpd -h.
761 * @deffunc void ap_show_directives(void)
763 AP_DECLARE(void) ap_show_directives(void);
766 * Show the preloaded module names. Used for httpd -l.
767 * @deffunc void ap_show_modules(void)
769 AP_DECLARE(void) ap_show_modules(void);
772 * Read all config files and setup the server
773 * @param process The process running the server
774 * @param temp_pool A pool to allocate temporary data out of.
775 * @param config_name The name of the config file
776 * @param conftree Place to store the root of the config tree
777 * @return The setup server_rec list.
778 * @deffunc server_rec *ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
780 AP_DECLARE(server_rec*) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
783 * Run all post config hooks for loaded modules.
784 * @param pconf The configuration pool
785 * @param plog The logging pool
786 * @param ptemp The temporary pool
787 * @param s The list of server_rec structures
788 * @deffunc void ap_post_config_hook(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
790 AP_DECLARE(void) ap_post_config_hook(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s);
793 * Run all rewrite args hooks for loaded modules
794 * @param process The process currently running the server
795 * @deffunc void ap_run_rewrite_args(process_rec *process)
797 AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
800 * Run the register hooks function for a specified module
801 * @param m The module to run the register hooks function fo
802 * @deffunc void ap_register_hooks(module *m)
804 AP_DECLARE(void) ap_register_hooks(module *m);
807 * Setup all virtual hosts
808 * @param p The pool to allocate out of
809 * @param main_server The head of the server_rec list
810 * @deffunc void ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server)
812 AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
814 /* For http_request.c... */
817 * Setup the config vector for a request_rec
818 * @param p The pool to allocate the config vector out of
819 * @return The config vector
821 void *ap_create_request_config(apr_pool_t *p);
824 * Setup the config vector for per dir module configs
825 * @param p The pool to allocate the config vector out of
826 * @return The config vector
827 * @deffunc void *ap_create_per_dir_config(apr_pool_t *p)
829 AP_CORE_DECLARE(void *) ap_create_per_dir_config(apr_pool_t *p);
832 * Run all of the modules merge per dir config functions
833 * @param p The pool to pass to the merge functions
834 * @param base The base directory config structure
835 * @param new The new directory config structure
837 void *ap_merge_per_dir_configs(apr_pool_t *p, void *base, void *new);
839 /* For http_connection.c... */
841 * Setup the config vector for a connection_rec
842 * @param p The pool to allocate the config vector out of
843 * @return The config vector
845 void *ap_create_conn_config(apr_pool_t *p);
847 /* For http_core.c... (<Directory> command and virtual hosts) */
850 * parse an htaccess file
851 * @param resulting htaccess_result
852 * @param r The request currently being served
853 * @param override Which overrides are active
854 * @param path The path to the htaccess file
855 * @param access_name The list of possible names for .htaccess files
856 * int The status of the current request
858 int ap_parse_htaccess(void **result, request_rec *r, int override,
859 const char *path, const char *access_name);
862 * Setup a virtual host
863 * @param p The pool to allocate all memory out of
864 * @param hostname The hostname of the virtual hsot
865 * @param main_server The main server for this Apache configuration
866 * @param ps Place to store the new server_rec
867 * return Error string on error, NULL on success
868 * @deffunc const char *ap_init_virtual_host(apr_pool_t *p, const char *hostname, server_rec *main_server, server_rec **ps)
870 AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
871 server_rec *main_server, server_rec **);
874 * Process the config file for Apache
875 * @param s The server rec to use for the command parms
876 * @param fname The name of the config file
877 * @param conftree The root node of the created config tree
878 * @param p Pool for general allocation
879 * @param ptem Pool for temporary allocation
881 void ap_process_resource_config(server_rec *s, const char *fname,
882 ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
885 * Process all directives in the config tree
886 * @param s The server rec to use in the command parms
887 * @param conftree The config tree to process
888 * @param p The pool for general allocation
889 * @param ptemp The pool for temporary allocations
891 AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
892 apr_pool_t *p, apr_pool_t *ptemp);
895 /* For individual MPMs... */
897 * Run all child init hooks
898 * @param pchild The pool for child process allocations
899 * @param s The list of all server_recs
901 void ap_child_init_hook(apr_pool_t *pchild, server_rec *s);
903 /* Module-method dispatchers, also for http_request.c */
905 * Run the handler phase of each module until a module accepts the
906 * responsibility of serving the request
907 * @param r The current request
908 * @return The status of the current request
910 int ap_invoke_handler(request_rec *);
915 * Find a given directive in a command_rec table
916 * @param name The directive to search for
917 * @param cmds The table to search
918 * @return The directive definition of the specified directive
919 * @deffunc const command_rec *ap_find_command(const char *name, const command_rec *cmds)
921 AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
924 * Find a given directive in a list module
925 * @param cmd_name The directive to search for
926 * @param mod The module list to search
927 * @return The directive definition of the specified directive
928 * @deffunc const command_rec *ap_find_command_in_modules(const char *cmd_name,module **mod)
930 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
933 * Add a per_dir and per_server config vector to a given module
934 * @param parms The command_parms to use
935 * @param config The config vector
936 * @param mod The module to add the vector for.
937 * @return The new config vector
938 * @deffunc void *ap_set_config_vectors(cmd_parms *parms, void *config, module *mod)
940 AP_CORE_DECLARE(void *) ap_set_config_vectors(cmd_parms *parms, void *config, module *mod);
947 * Run the header parser functions for each module
948 * @param r The current request
949 * @return OK or DECLINED
950 * @deffunc int ap_run_header_parser(request_rec *r)
952 AP_DECLARE_HOOK(int,header_parser,(request_rec *))
955 * Run the pre_config function for each module
956 * @param pconf The config pool
957 * @param plog The logging streams pool
958 * @param ptemp The temporary pool
959 * @deffunc void ap_run_pre_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp)
961 AP_DECLARE_HOOK(void,pre_config,
962 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp))
965 * Run the post_config function for each module
966 * @param pconf The config pool
967 * @param plog The logging streams pool
968 * @param ptemp The temporary pool
969 * @param s The list of server_recs
970 * @deffunc void ap_run_post_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
972 AP_DECLARE_HOOK(void,post_config,
973 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
976 * Run the open_logs functions for each module
977 * @param pconf The config pool
978 * @param plog The logging streams pool
979 * @param ptemp The temporary pool
980 * @param s The list of server_recs
981 * @deffunc void ap_run_open_logs(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
983 AP_DECLARE_HOOK(void,open_logs,
984 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
987 * Run the child_init functions for each module
988 * @param pchild The child pool
989 * @param s The list of server_recs in this server
990 * @deffunc void ap_run_child_init(apr_pool_t *pchild, server_rec *s)
992 AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
995 * Run the handler functions for each module
996 * @param r The request_rec
997 * @deffunc void ap_run_handler(request_rec *r)
998 * @tip non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
1000 AP_DECLARE_HOOK(int,handler,(request_rec *))
1006 #endif /* !APACHE_HTTP_CONFIG_H */