1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 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
62 #include "apr_hooks.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 ap_configfile_t ap_configfile_t;
258 /** Common structure for reading of config files / passwd files etc. */
259 struct ap_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 ap_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 */
315 struct ap_conf_vector_t *context;
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 * @param p the pool to use for all allocations
400 * @deffunc void register_hooks(void)
402 void (*register_hooks) (apr_pool_t *p);
405 /* Initializer for the first few module slots, which are only
406 * really set up once we start running. Note that the first two slots
407 * provide a version check; this should allow us to deal with changes to
408 * the API. The major number should reflect changes to the API handler table
409 * itself or removal of functionality. The minor number should reflect
410 * additions of functionality to the existing API. (the server can detect
411 * an old-format module, and either handle it back-compatibly, or at least
412 * signal an error). See src/include/ap_mmn.h for MMN version history.
415 #define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
417 #define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
418 MODULE_MAGIC_NUMBER_MINOR, \
423 MODULE_MAGIC_COOKIE, \
424 NULL /* rewrite args spot */
426 #define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
427 MODULE_MAGIC_NUMBER_MINOR, \
435 /* CONFIGURATION VECTOR FUNCTIONS */
437 typedef struct ap_conf_vector_t ap_conf_vector_t;
441 * Generic accessors for other modules to get at their own module-specific
443 * @param conf_vector The vector in which the modules configuration is stored.
444 * usually r->per_dir_config or s->module_config
445 * @param m The module to get the data for.
446 * @return The module-specific data
447 * @deffunc void *ap_get_module_config(const ap_conf_vector_t *cv, module *m)
449 AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
453 * Generic accessors for other modules to set at their own module-specific
455 * @param conf_vector The vector in which the modules configuration is stored.
456 * usually r->per_dir_config or s->module_config
457 * @param m The module to set the data for.
458 * @param val The module-specific data to set
459 * @deffunc void ap_set_module_config(ap_conf_vector_t *cv, const module *m, void *val)
461 AP_DECLARE(void) ap_set_module_config(ap_conf_vector_t *cv, const module *m,
466 #define ap_get_module_config(v,m) \
467 (((void **)(v))[(m)->module_index])
468 #define ap_set_module_config(v,m,val) \
469 ((((void **)(v))[(m)->module_index]) = (val))
471 #endif /* AP_DEBUG */
475 * Generic command handling function for strings
476 * @param cmd The command parameters for this directive
477 * @param struct_ptr pointer into a given type
478 * @param arg The argument to the directive
479 * @return An error string or NULL on success
480 * @deffunc const char *ap_set_string_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
482 AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_ptr,
486 * Return true if the specified method is limited by being listed in
487 * a <Limit> container, or by *not* being listed in a <LimiteExcept>
490 * @param method Pointer to a string specifying the method to check.
491 * @param cmd Pointer to the cmd_parms structure passed to the
493 * @return 0 if the method is not limited in the current scope
494 * @deffunc ap_method_is_limited(cmd_parms *cmd, const char *method)
496 AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
499 * Generic command handling function for strings, always sets the value
500 * to a lowercase string
501 * @param cmd The command parameters for this directive
502 * @param struct_ptr pointer into a given type
503 * @param arg The argument to the directive
504 * @return An error string or NULL on success
505 * @deffunc const char *ap_set_string_slot_lower(cmd_parms *cmd, void *struct_ptr, const char *arg)
507 AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
508 void *struct_ptr, const char *arg);
510 * Generic command handling function for flags
511 * @param cmd The command parameters for this directive
512 * @param struct_ptr pointer into a given type
513 * @param arg The argument to the directive (either 1 or 0)
514 * @return An error string or NULL on success
515 * @deffunc const char *ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg)
517 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg);
519 * Generic command handling function for files
520 * @param cmd The command parameters for this directive
521 * @param struct_ptr pointer into a given type
522 * @param arg The argument to the directive
523 * @return An error string or NULL on success
524 * @deffunc const char *ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
526 AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg);
529 * For modules which need to read config files, open logs, etc. ...
530 * this returns the fname argument if it begins with '/'; otherwise
531 * it relativizes it wrt server_root.
532 * @param p pool to allocate data out of
533 * @param fname The file name
534 * @deffunc const char *ap_server_root_relative(apr_pool_t *p, const char *fname)
536 AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
538 /* Finally, the hook for dynamically loading modules in... */
541 * Add a module to the server
542 * @param m The module structure of the module to add
543 * @param p The pool of the same lifetime as the module
544 * @deffunc void ap_add_module(module *m, apr_pool_t *p)
546 AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
549 * Remove a module from the server. There are some caveats:
550 * when the module is removed, its slot is lost so all the current
551 * per-dir and per-server configurations are invalid. So we should
552 * only ever call this function when you are invalidating almost
553 * all our current data. I.e. when doing a restart.
554 * @param m the module structure of the module to remove
555 * @deffunc void ap_remove_module(module *m)
557 AP_DECLARE(void) ap_remove_module(module *m);
559 * Add a module to the chained modules list and the list of loaded modules
560 * @param m The module structure of the module to add
561 * @param p The pool with the same lifetime as the module
562 * @deffunc void ap_add_loaded_module(module *m, apr_pool_t *p)
564 AP_DECLARE(void) ap_add_loaded_module(module *mod, apr_pool_t *p);
566 * Remove a module fromthe chained modules list and the list of loaded modules
567 * @param m the module structure of the module to remove
568 * @deffunc void ap_remove_loaded_module(module *m)
570 AP_DECLARE(void) ap_remove_loaded_module(module *mod);
572 * Add a module to the list of loaded module based on the name of the
574 * @param name The name of the module
575 * @param p The pool valid for the lifetime of the module
576 * @return 1 on success, 0 on failure
577 * @deffunc int ap_add_named_module(const char *name, apr_pool_t *p)
579 AP_DECLARE(int) ap_add_named_module(const char *name, apr_pool_t *p);
581 * Find the name of the specified module
582 * @param m The module to get the name for
583 * @return the name of the module
584 * @deffunc const char *ap_find_module_name(module *m)
586 AP_DECLARE(const char *) ap_find_module_name(module *m);
588 * Find a module based on the name of the module
589 * @param name the name of the module
590 * @return the module structure if found, NULL otherwise
591 * @deffunc module *ap_find_linked_module(const char *name)
593 AP_DECLARE(module *) ap_find_linked_module(const char *name);
596 * Open a ap_configfile_t as apr_file_t
597 * @param ret_cfg open ap_configfile_t struct pointer
598 * @param p The pool to allocate the structure out of
599 * @param name the name of the file to open
600 * @deffunc apr_status_t ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name)
602 AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name);
605 * Allocate a ap_configfile_t handle with user defined functions and params
606 * @param p The pool to allocate out of
607 * @param descr The name of the file
608 * @param param The argument passed to getch/getstr/close
609 * @param getc_func The getch function
610 * @param gets_func The getstr function
611 * @param close_func The close function
612 * @deffunc ap_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))
614 AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
616 int(*getc_func)(void*),
617 void *(*gets_func) (void *buf, size_t bufsiz, void *param),
618 int(*close_func)(void *param));
621 * Read one line from open ap_configfile_t, strip LF, increase line number
622 * @param buf place to store the line read
623 * @param bufsize size of the buffer
624 * @param cfp File to read from
625 * @return 1 on success, 0 on failure
626 * @deffunc int ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp)
628 AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp);
631 * Read one char from open configfile_t, increase line number upon LF
632 * @param cfp The file to read from
633 * @return the character read
634 * @deffunc int ap_cfg_getc(ap_configfile_t *cfp)
636 AP_DECLARE(int) ap_cfg_getc(ap_configfile_t *cfp);
639 * Detach from open ap_configfile_t, calling the close handler
640 * @param cfp The file to close
641 * @return 1 on sucess, 0 on failure
642 * @deffunc int ap_cfg_closefile(ap_configfile_t *cfp)
644 AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
647 * Read all data between the current <foo> and the matching </foo>. All
648 * of this data is forgotten immediately.
649 * @param cmd The cmd_parms to pass to the directives inside the container
650 * @param directive The directive name to read until
651 * @retrn Error string on failure, NULL on success
652 * @deffunc const char *ap_soak_end_container(cmd_parms *cmd, char *directive)
654 AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
657 * Read all data between the current <foo> and the matching </foo> and build
658 * a config tree out of it
659 * @param p pool to allocate out of
660 * @param temp_pool Temporary pool to allocate out of
661 * @param parms The cmd_parms to pass to all directives read
662 * @param current The current node in the tree
663 * @param curr_parent The current parent node
664 * @param orig_directive The directive to read until hit.
665 * @return Error string on failure, NULL on success
666 * @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)
668 const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
670 ap_directive_t **current,
671 ap_directive_t **curr_parent,
672 char *orig_directive);
675 * Build a config tree from a config file
676 * @param parms The cmd_parms to pass to all of the directives in the file
677 * @param conf_pool The pconf pool
678 * @param temp_pool The temporary pool
679 * @param conftree Place to store the root node of the config tree
680 * @return Error string on erro, NULL otherwise
681 * @deffunc const char *ap_build_config(cmd_parms *parms, apr_pool_t *conf_pool, apr_pool_t *temp_pool, ap_directive_t **conftree)
683 AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
684 apr_pool_t *conf_pool,
685 apr_pool_t *temp_pool,
686 ap_directive_t **conftree);
689 * Walk a config tree and setup the server's internal structures
690 * @param conftree The config tree to walk
691 * @param parms The cmd_parms to pass to all functions
692 * @param section_vector The per-section config vector.
693 * @return Error string on error, NULL otherwise
694 * @deffunc const char *ap_walk_config(ap_directive_t *conftree, cmd_parms *parms, ap_conf_vector_t *section_vector)
696 AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
698 ap_conf_vector_t *section_vector);
701 * ap_check_cmd_context() definitions:
702 * @param cmd The cmd_context to check
703 * @param forbidden Where the command is forbidden. One of:
710 * NOT_IN_DIR_LOC_FILE
713 * @return Error string on error, NULL on success
714 * @deffunc const char *ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden)
716 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
718 /* ap_check_cmd_context(): Forbidden in: */
719 #define NOT_IN_VIRTUALHOST 0x01 /* <Virtualhost> */
720 #define NOT_IN_LIMIT 0x02 /* <Limit> */
721 #define NOT_IN_DIRECTORY 0x04 /* <Directory> */
722 #define NOT_IN_LOCATION 0x08 /* <Location> */
723 #define NOT_IN_FILES 0x10 /* <Files> */
724 #define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES) /* <Directory>/<Location>/<Files>*/
725 #define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
731 * The topmost module in the list
732 * @defvar module *ap_top_module
734 AP_DECLARE_DATA extern module *ap_top_module;
737 * Array of all statically linked modules
738 * @defvar module *ap_prelinked_modules[]
740 AP_DECLARE_DATA extern module *ap_prelinked_modules[];
742 * Array of all preloaded modules
743 * @defvar module *ap_preloaded_modules[]
745 AP_DECLARE_DATA extern module *ap_preloaded_modules[];
747 * Array of all loaded modules
748 * @defvar module **ap_loaded_modules
750 AP_DECLARE_DATA extern module **ap_loaded_modules;
752 /* For mod_so.c... */
753 /** Run a single module's two create_config hooks
754 * @param p the pool to allocate out of
755 * @param s The server to configure for.
756 * @param m The module to configure
758 AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
761 /* For http_main.c... */
763 * Add all of the prelinked modules into the loaded module list
764 * @param process The process that is currently running the server
765 * @deffunc void ap_setup_prelinked_modules(process_rec *process)
767 AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
770 *Show the preloaded configuration directives, the help string explaining
771 * the directive arguments, in what module they are handled, and in
772 * what parts of the configuration they are allowed. Used for httpd -h.
773 * @deffunc void ap_show_directives(void)
775 AP_DECLARE(void) ap_show_directives(void);
778 * Show the preloaded module names. Used for httpd -l.
779 * @deffunc void ap_show_modules(void)
781 AP_DECLARE(void) ap_show_modules(void);
784 * Read all config files and setup the server
785 * @param process The process running the server
786 * @param temp_pool A pool to allocate temporary data out of.
787 * @param config_name The name of the config file
788 * @param conftree Place to store the root of the config tree
789 * @return The setup server_rec list.
790 * @deffunc server_rec *ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
792 AP_DECLARE(server_rec *) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
795 * Run all rewrite args hooks for loaded modules
796 * @param process The process currently running the server
797 * @deffunc void ap_run_rewrite_args(process_rec *process)
799 AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
802 * Run the register hooks function for a specified module
803 * @param m The module to run the register hooks function fo
804 * @param p The pool valid for the lifetime of the module
805 * @deffunc void ap_register_hooks(module *m, apr_pool_t *p)
807 AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
810 * Setup all virtual hosts
811 * @param p The pool to allocate out of
812 * @param main_server The head of the server_rec list
813 * @deffunc void ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server)
815 AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
817 /* For http_request.c... */
820 * Setup the config vector for a request_rec
821 * @param p The pool to allocate the config vector out of
822 * @return The config vector
824 ap_conf_vector_t *ap_create_request_config(apr_pool_t *p);
827 * Setup the config vector for per dir module configs
828 * @param p The pool to allocate the config vector out of
829 * @return The config vector
830 * @deffunc ap_conf_vector_t *ap_create_per_dir_config(apr_pool_t *p)
832 AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
835 * Run all of the modules merge per dir config functions
836 * @param p The pool to pass to the merge functions
837 * @param base The base directory config structure
838 * @param new_conf The new directory config structure
840 ap_conf_vector_t *ap_merge_per_dir_configs(apr_pool_t *p,
841 ap_conf_vector_t *base,
842 ap_conf_vector_t *new_conf);
844 /* For http_connection.c... */
846 * Setup the config vector for a connection_rec
847 * @param p The pool to allocate the config vector out of
848 * @return The config vector
850 ap_conf_vector_t *ap_create_conn_config(apr_pool_t *p);
852 /* For http_core.c... (<Directory> command and virtual hosts) */
855 * parse an htaccess file
856 * @param resulting htaccess_result
857 * @param r The request currently being served
858 * @param override Which overrides are active
859 * @param path The path to the htaccess file
860 * @param access_name The list of possible names for .htaccess files
861 * int The status of the current request
863 int ap_parse_htaccess(ap_conf_vector_t **result, request_rec *r, int override,
864 const char *path, const char *access_name);
867 * Setup a virtual host
868 * @param p The pool to allocate all memory out of
869 * @param hostname The hostname of the virtual hsot
870 * @param main_server The main server for this Apache configuration
871 * @param ps Place to store the new server_rec
872 * return Error string on error, NULL on success
873 * @deffunc const char *ap_init_virtual_host(apr_pool_t *p, const char *hostname, server_rec *main_server, server_rec **ps)
875 AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
876 server_rec *main_server, server_rec **);
879 * Process the config file for Apache
880 * @param s The server rec to use for the command parms
881 * @param fname The name of the config file
882 * @param conftree The root node of the created config tree
883 * @param p Pool for general allocation
884 * @param ptem Pool for temporary allocation
886 void ap_process_resource_config(server_rec *s, const char *fname,
887 ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
890 * Process all directives in the config tree
891 * @param s The server rec to use in the command parms
892 * @param conftree The config tree to process
893 * @param p The pool for general allocation
894 * @param ptemp The pool for temporary allocations
896 AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
897 apr_pool_t *p, apr_pool_t *ptemp);
899 /* Module-method dispatchers, also for http_request.c */
901 * Run the handler phase of each module until a module accepts the
902 * responsibility of serving the request
903 * @param r The current request
904 * @return The status of the current request
906 int ap_invoke_handler(request_rec *);
911 * Find a given directive in a command_rec table
912 * @param name The directive to search for
913 * @param cmds The table to search
914 * @return The directive definition of the specified directive
915 * @deffunc const command_rec *ap_find_command(const char *name, const command_rec *cmds)
917 AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
920 * Find a given directive in a list module
921 * @param cmd_name The directive to search for
922 * @param mod The module list to search
923 * @return The directive definition of the specified directive
924 * @deffunc const command_rec *ap_find_command_in_modules(const char *cmd_name,module **mod)
926 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
929 * Ask a module to create per-server and per-section (dir/loc/file) configs
930 * (if it hasn't happened already). The results are stored in the server's
931 * config, and the specified per-section config vector.
932 * @param server The server to operate upon.
933 * @param section_vector The per-section config vector.
934 * @param section Which section to create a config for.
935 * @param mod The module which is defining the config data.
936 * @param pconf A pool for all configuration allocations.
937 * @return The (new) per-section config data.
938 * @deffunc void *ap_set_config_vectors(server_rec *server, ap_conf_vector_t *section_vector, const char *dir, module *mod, apr_pool_t *pconf)
940 AP_CORE_DECLARE(void *) ap_set_config_vectors(server_rec *server,
941 ap_conf_vector_t *section_vector,
943 module *mod, apr_pool_t *pconf);
950 * Run the header parser functions for each module
951 * @param r The current request
952 * @return OK or DECLINED
953 * @deffunc int ap_run_header_parser(request_rec *r)
955 AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
958 * Run the pre_config function for each module
959 * @param pconf The config pool
960 * @param plog The logging streams pool
961 * @param ptemp The temporary pool
962 * @deffunc void ap_run_pre_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp)
964 AP_DECLARE_HOOK(void,pre_config,
965 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp))
968 * Run the post_config function for each module
969 * @param pconf The config pool
970 * @param plog The logging streams pool
971 * @param ptemp The temporary pool
972 * @param s The list of server_recs
973 * @deffunc void ap_run_post_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
975 AP_DECLARE_HOOK(void,post_config,
976 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
979 * Run the open_logs functions for each module
980 * @param pconf The config pool
981 * @param plog The logging streams pool
982 * @param ptemp The temporary pool
983 * @param s The list of server_recs
984 * @deffunc void ap_run_open_logs(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
986 AP_DECLARE_HOOK(void,open_logs,
987 (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
990 * Run the child_init functions for each module
991 * @param pchild The child pool
992 * @param s The list of server_recs in this server
993 * @deffunc void ap_run_child_init(apr_pool_t *pchild, server_rec *s)
995 AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
998 * Run the handler functions for each module
999 * @param r The request_rec
1000 * @tip non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
1001 * @deffunc void ap_run_handler(request_rec *r)
1003 AP_DECLARE_HOOK(int,handler,(request_rec *r))
1006 * Run the quick handler functions for each module. The quick_handler
1007 * is run before any other requests hooks are called (location_walk,
1008 * directory_walk, access checking, et. al.). This hook was added
1009 * to provide a quick way to serve content out of a URI keyed cache.
1010 * @param r The request_rec
1011 * @deffunc void ap_run_quick_handler(request_rec *r)
1013 AP_DECLARE_HOOK(int,quick_handler,(request_rec *r))
1016 * Retrieve the optional functions for each module.
1017 * This is run immediately before the server starts. Optional functions should
1018 * be registered during the hook registration phase.
1019 * @deffunc void ap_run_optional_fn_retrieve(void)
1021 AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
1027 #endif /* !APACHE_HTTP_CONFIG_H */