granicus.if.org Git - apache/blob - include/http_config.h

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  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
  17  *    distribution.
  18  *
  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.
  25  *
  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.
  30  *
  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.
  34  *
  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
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  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/>.
  53  *
  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.
  57  */
  58
  59 #ifndef APACHE_HTTP_CONFIG_H
  60 #define APACHE_HTTP_CONFIG_H
  61
  62 #include "apr_hooks.h"
  63 #include "util_cfgtree.h"
  64
  65 #ifdef __cplusplus
  66 extern "C" {
  67 #endif
  68
  69 /**
  70  * @package Apache Configuration
  71  */
  72
  73 /*
  74  * The central data structures around here...
  75  */
  76
  77 /* Command dispatch structures... */
  78
  79 /**
  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
  84  * <PRE>
  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
  91  *                               * (e.g., AddIcon)
  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
  99  * </PRE>
 100  * @defvar enum cmd_how
 101  */
 102 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)
 108                                  */
 109     ITERATE2,                   /* two arguments, 2nd occurs multiple times
 110                                  * (e.g., AddIcon)
 111                                  */
 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 */
 119 };
 120
 121 typedef struct cmd_parms_struct cmd_parms;
 122
 123 #ifdef AP_DEBUG
 124
 125 typedef union {
 126     const char *(*no_args) (cmd_parms *parms, void *mconfig);
 127     const char *(*raw_args) (cmd_parms *parms, void *mconfig,
 128                              const char *args);
 129     const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
 130     const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
 131                           const char *w2);
 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);
 135 } cmd_func;
 136
 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
 143
 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 }
 164
 165 #else
 166
 167 typedef const char *(*cmd_func) ();
 168
 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
 175
 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 }
 196
 197 #endif
 198
 199 typedef struct command_struct command_rec;
 200 /**
 201  * The command record structure.  Each modules can define a table of these
 202  * to define the directives it will implement.
 203  */
 204 struct command_struct {
 205     /** Name of this command */
 206     const char *name;
 207     /** The function to be called when this directive is parsed */
 208     cmd_func func;
 209     /** Extra data, for functions which implement multiple commands... */
 210     void *cmd_data;
 211     /** What overrides need to be allowed to enable this command. */
 212     int req_override;
 213     /** What the command expects as arguments
 214      *  @defvar cmd_how args_how*/
 215     enum cmd_how args_how;
 216
 217     /** 'usage' message, in case of syntax errors */
 218     const char *errmsg;
 219 };
 220
 221 /* The allowed locations for a configuration directive are the union of
 222  * those indicated by each set bit in the req_override mask.
 223  *
 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
 236  */
 237 #define OR_NONE 0
 238 #define OR_LIMIT 1
 239 #define OR_OPTIONS 2
 240 #define OR_FILEINFO 4
 241 #define OR_AUTHCFG 8
 242 #define OR_INDEXES 16
 243 #define OR_UNSET 32
 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)
 248
 249 /**
 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
 252  * as an error code.
 253  * @defvar DECLINE_CMD "\a\b"
 254  */
 255 #define DECLINE_CMD "\a\b"
 256
 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 */
 270     void *param;
 271     /** the filename / description */
 272     const char *name;
 273     /** current line number, starting at 1 */
 274     unsigned line_number;
 275 };
 276
 277 /**
 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*...
 281  */
 282 struct cmd_parms_struct {
 283     /** Argument to command from cmd_table */
 284     void *info;
 285     /** Which allow-override bits are set */
 286     int override;
 287     /** Which methods are <Limit>ed */
 288     int limited;
 289     apr_array_header_t *limited_xmethods;
 290     ap_method_list_t *xlimited;
 291
 292     /** Config file structure. */
 293     configfile_t *config_file;
 294     /** the directive specifying this command */
 295     ap_directive_t *directive;
 296
 297     /** Pool to allocate new storage in */
 298     apr_pool_t *pool;
 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 */
 303     server_rec *server;
 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
 309      * (path != NULL).  */
 310     char *path;
 311     /** configuration command */
 312     const command_rec *cmd;
 313
 314     /** per_dir_config vector passed to handle_command */
 315     void *context;
 316     /** directive with syntax error */
 317     const ap_directive_t *err_directive;
 318 };
 319
 320 typedef struct module_struct module;
 321 /**
 322  * Module structures.  Just about everything is dispatched through
 323  * these, directly or indirectly (through the command and handler
 324  * tables).
 325  */
 326 struct module_struct {
 327     /** API version, *not* module version; check that module is
 328      * compatible with this version of the server.
 329      */
 330     int version;
 331     /** API minor version. Provides API feature milestones. Not checked
 332      *  during module init */
 333     int minor_version;
 334     /** Index to this modules structures in config vectors.  */
 335     int module_index;
 336
 337     /** The name of the module's C file */
 338     const char *name;
 339     /** The handle for the DSO.  Internal use only */
 340     void *dynamic_load_handle;
 341
 342     /** A pointer to the next module in the list
 343      *  @defvar module_struct *next */
 344     struct module_struct *next;
 345
 346     /** Magic Cookie to identify a module structure;  It's mainly
 347      *  important for the DSO facility (see also mod_so).  */
 348     unsigned long magic;
 349
 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);
 354      */
 355     void (*rewrite_args) (process_rec *process);
 356     /** Function to allow all modules to create per directory configuration
 357      *  structures.
 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)
 362      */
 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)
 371      */
 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
 374      *  structures.
 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)
 379      */
 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)
 388      */
 389     void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void *new_conf);
 390
 391     /** A command_rec table that describes all of the directives this module
 392      * defines. */
 393     const command_rec *cmds;
 394
 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
 398      *  request.
 399      *  @param p the pool to use for all allocations
 400      *  @deffunc void register_hooks(void)
 401      */
 402     void (*register_hooks) (apr_pool_t *p);
 403 };
 404
 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.
 413  */
 414
 415 #define STANDARD_MODULE_STUFF   this_module_needs_to_be_ported_to_apache_2_0
 416
 417 #define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
 418                                 MODULE_MAGIC_NUMBER_MINOR, \
 419                                 -1, \
 420                                 __FILE__, \
 421                                 NULL, \
 422                                 NULL, \
 423                                 MODULE_MAGIC_COOKIE, \
 424                                 NULL      /* rewrite args spot */
 425
 426 #define MPM20_MODULE_STUFF      MODULE_MAGIC_NUMBER_MAJOR, \
 427                                 MODULE_MAGIC_NUMBER_MINOR, \
 428                                 -1, \
 429                                 __FILE__, \
 430                                 NULL, \
 431                                 NULL, \
 432                                 MODULE_MAGIC_COOKIE
 433
 434 #if AP_RBB_HACK
 435 /**
 436  * Generic accessors for other modules to get at their own module-specific
 437  * data
 438  * @param conf_vector The vector in which the modules configuration is stored.
 439  *        usually r->per_dir_config or s->module_config
 440  * @param m The module to get the data for.
 441  * @return The module-specific data
 442  * @deffunc void *ap_get_module_config(void *conf_vector, module *m)
 443  */
 444 AP_DECLARE(void *) ap_get_module_config(void *conf_vector, module *m);
 445 #endif
 446 #if AP_RBB_HACK
 447 /**
 448  * Generic accessors for other modules to set at their own module-specific
 449  * data
 450  * @param conf_vector The vector in which the modules configuration is stored.
 451  *        usually r->per_dir_config or s->module_config
 452  * @param m The module to set the data for.
 453  * @param val The module-specific data to set
 454  * @deffunc void ap_set_module_config(void *conf_vector, module *m, void *val)
 455  */
 456 AP_DECLARE(void) ap_set_module_config(void *conf_vector, module *m, void *val);
 457 #endif
 458
 459 #define ap_get_module_config(v,m)       \
 460     (((void **)(v))[(m)->module_index])
 461 #define ap_set_module_config(v,m,val)   \
 462     ((((void **)(v))[(m)->module_index]) = (val))
 463
 464 /**
 465  * Generic command handling function for strings
 466  * @param cmd The command parameters for this directive
 467  * @param struct_ptr pointer into a given type
 468  * @param arg The argument to the directive
 469  * @return An error string or NULL on success
 470  * @deffunc const char *ap_set_string_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
 471  */
 472 AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_ptr,
 473                                                    const char *arg);
 474
 475 /**
 476  * Return true if the specified method is limited by being listed in
 477  * a <Limit> container, or by *not* being listed in a <LimiteExcept>
 478  * container.
 479  *
 480  * @param   method  Pointer to a string specifying the method to check.
 481  * @param   cmd     Pointer to the cmd_parms structure passed to the
 482  *                  directive handler.
 483  * @return  0 if the method is not limited in the current scope
 484  * @deffunc ap_method_is_limited(cmd_parms *cmd, const char *method)
 485  */
 486 AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
 487
 488 /**
 489  * Generic command handling function for strings, always sets the value
 490  * to a lowercase string
 491  * @param cmd The command parameters for this directive
 492  * @param struct_ptr pointer into a given type
 493  * @param arg The argument to the directive
 494  * @return An error string or NULL on success
 495  * @deffunc const char *ap_set_string_slot_lower(cmd_parms *cmd, void *struct_ptr, const char *arg)
 496  */
 497 AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
 498                                                          void *struct_ptr, const char *arg);
 499 /**
 500  * Generic command handling function for flags
 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 (either 1 or 0)
 504  * @return An error string or NULL on success
 505  * @deffunc const char *ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg)
 506  */
 507 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg);
 508 /**
 509  * Generic command handling function for files
 510  * @param cmd The command parameters for this directive
 511  * @param struct_ptr pointer into a given type
 512  * @param arg The argument to the directive
 513  * @return An error string or NULL on success
 514  * @deffunc const char *ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
 515  */
 516 AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg);
 517
 518 /**
 519  * For modules which need to read config files, open logs, etc. ...
 520  * this returns the fname argument if it begins with '/'; otherwise
 521  * it relativizes it wrt server_root.
 522  * @param p pool to allocate data out of
 523  * @param fname The file name
 524  * @deffunc const char *ap_server_root_relative(apr_pool_t *p, const char *fname)
 525  */
 526 AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
 527
 528 /* Finally, the hook for dynamically loading modules in... */
 529
 530 /**
 531  * Add a module to the server
 532  * @param m The module structure of the module to add
 533  * @param p The pool of the same lifetime as the module
 534  * @deffunc void ap_add_module(module *m, apr_pool_t *p)
 535  */
 536 AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
 537
 538 /**
 539  * Remove a module from the server.  There are some caveats:
 540  * when the module is removed, its slot is lost so all the current
 541  * per-dir and per-server configurations are invalid. So we should
 542  * only ever call this function when you are invalidating almost
 543  * all our current data. I.e. when doing a restart.
 544  * @param m the module structure of the module to remove
 545  * @deffunc void ap_remove_module(module *m)
 546  */
 547 AP_DECLARE(void) ap_remove_module(module *m);
 548 /**
 549  * Add a module to the chained modules list and the list of loaded modules
 550  * @param m The module structure of the module to add
 551  * @param p The pool with the same lifetime as the module
 552  * @deffunc void ap_add_loaded_module(module *m, apr_pool_t *p)
 553  */
 554 AP_DECLARE(void) ap_add_loaded_module(module *mod, apr_pool_t *p);
 555 /**
 556  * Remove a module fromthe chained modules list and the list of loaded modules
 557  * @param m the module structure of the module to remove
 558  * @deffunc void ap_remove_loaded_module(module *m)
 559  */
 560 AP_DECLARE(void) ap_remove_loaded_module(module *mod);
 561 /**
 562  * Add a module to the list of loaded module based on the name of the
 563  * module
 564  * @param name The name of the module
 565  * @param p The pool valid for the lifetime of the module
 566  * @return 1 on success, 0 on failure
 567  * @deffunc int ap_add_named_module(const char *name, apr_pool_t *p)
 568  */
 569 AP_DECLARE(int) ap_add_named_module(const char *name, apr_pool_t *p);
 570 /**
 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)
 575  */
 576 AP_DECLARE(const char *) ap_find_module_name(module *m);
 577 /**
 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)
 582  */
 583 AP_DECLARE(module *) ap_find_linked_module(const char *name);
 584
 585 /**
 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)
 591  */
 592 AP_DECLARE(apr_status_t) ap_pcfg_openfile(configfile_t **ret_cfg, apr_pool_t *p, const char *name);
 593
 594 /**
 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))
 603  */
 604 AP_DECLARE(configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
 605     void *param,
 606     int(*getc_func)(void*),
 607     void *(*gets_func) (void *buf, size_t bufsiz, void *param),
 608     int(*close_func)(void *param));
 609
 610 /**
 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)
 617  */
 618 AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, configfile_t *cfp);
 619
 620 /**
 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)
 625  */
 626 AP_DECLARE(int) ap_cfg_getc(configfile_t *cfp);
 627
 628 /**
 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)
 633  */
 634 AP_DECLARE(int) ap_cfg_closefile(configfile_t *cfp);
 635
 636 /**
 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)
 643  */
 644 AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
 645
 646 /**
 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)
 657 */
 658 const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
 659                                         cmd_parms *parms,
 660                                         ap_directive_t **current,
 661                                         ap_directive_t **curr_parent,
 662                                         char *orig_directive);
 663
 664 /**
 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)
 672  */
 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);
 677
 678 /**
 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)
 685  */
 686 AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
 687                                         cmd_parms *parms, void *config);
 688
 689 /**
 690  * ap_check_cmd_context() definitions:
 691  * @param cmd The cmd_context to check
 692  * @param forbidden Where the command is forbidden.  One of:
 693  * <PRE>
 694  *                NOT_IN_VIRTUALHOST
 695  *                NOT_IN_LIMIT
 696  *                NOT_IN_DIRECTORY
 697  *                NOT_IN_LOCATION
 698  *                NOT_IN_FILES
 699  *                NOT_IN_DIR_LOC_FILE
 700  *                GLOBAL_ONLY
 701  * </PRE>
 702  * @return Error string on error, NULL on success
 703  * @deffunc const char *ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden)
 704  */
 705 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
 706
 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)
 715
 716
 717 #ifdef CORE_PRIVATE
 718
 719 /**
 720  * The topmost module in the list
 721  * @defvar module *top_module
 722  */
 723 AP_DECLARE_DATA extern module *top_module;
 724
 725 /**
 726  * Array of all statically linked modules
 727  * @defvar module *ap_prelinked_modules[]
 728  */
 729 AP_DECLARE_DATA extern module *ap_prelinked_modules[];
 730 /**
 731  * Array of all preloaded modules
 732  * @defvar module *ap_preloaded_modules[]
 733  */
 734 AP_DECLARE_DATA extern module *ap_preloaded_modules[];
 735 /**
 736  * Array of all loaded modules
 737  * @defvar module **ap_loaded_modules
 738  */
 739 AP_DECLARE_DATA extern module **ap_loaded_modules;
 740
 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
 746  */
 747 AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
 748                                             module *m);
 749
 750 /* For http_main.c... */
 751 /**
 752  * Add all of the prelinked modules into the loaded module list
 753  * @param process The process that is currently running the server
 754  * @deffunc void ap_setup_prelinked_modules(process_rec *process)
 755  */
 756 AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
 757
 758 /**
 759  *Show the preloaded configuration directives, the help string explaining
 760  * the directive arguments, in what module they are handled, and in
 761  * what parts of the configuration they are allowed.  Used for httpd -h.
 762  * @deffunc void ap_show_directives(void)
 763  */
 764 AP_DECLARE(void) ap_show_directives(void);
 765
 766 /**
 767  * Show the preloaded module names.  Used for httpd -l.
 768  * @deffunc void ap_show_modules(void)
 769  */
 770 AP_DECLARE(void) ap_show_modules(void);
 771
 772 /**
 773  * Read all config files and setup the server
 774  * @param process The process running the server
 775  * @param temp_pool A pool to allocate temporary data out of.
 776  * @param config_name The name of the config file
 777  * @param conftree Place to store the root of the config tree
 778  * @return The setup server_rec list.
 779  * @deffunc server_rec *ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
 780  */
 781 AP_DECLARE(server_rec*) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
 782
 783 /**
 784  * Run all post config hooks for loaded modules.
 785  * @param pconf The configuration pool
 786  * @param plog The logging pool
 787  * @param ptemp The temporary pool
 788  * @param s The list of server_rec structures
 789  * @deffunc void ap_post_config_hook(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
 790  */
 791 AP_DECLARE(void) ap_post_config_hook(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s);
 792
 793 /**
 794  * Run all rewrite args hooks for loaded modules
 795  * @param process The process currently running the server
 796  * @deffunc void ap_run_rewrite_args(process_rec *process)
 797  */
 798 AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
 799
 800 /**
 801  * Run the register hooks function for a specified module
 802  * @param m The module to run the register hooks function fo
 803  * @param p The pool valid for the lifetime of the module
 804  * @deffunc void ap_register_hooks(module *m, apr_pool_t *p)
 805  */
 806 AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
 807
 808 /**
 809  * Setup all virtual hosts
 810  * @param p The pool to allocate out of
 811  * @param main_server The head of the server_rec list
 812  * @deffunc void ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server)
 813  */
 814 AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
 815
 816 /* For http_request.c... */
 817
 818 /**
 819  * Setup the config vector for a request_rec
 820  * @param p The pool to allocate the config vector out of
 821  * @return The config vector
 822  */
 823 void *ap_create_request_config(apr_pool_t *p);
 824
 825 /**
 826  * Setup the config vector for per dir module configs
 827  * @param p The pool to allocate the config vector out of
 828  * @return The config vector
 829  * @deffunc void *ap_create_per_dir_config(apr_pool_t *p)
 830  */
 831 AP_CORE_DECLARE(void *) ap_create_per_dir_config(apr_pool_t *p);
 832
 833 /**
 834  * Run all of the modules merge per dir config functions
 835  * @param p The pool to pass to the merge functions
 836  * @param base The base directory config structure
 837  * @param new The new directory config structure
 838  */
 839 void *ap_merge_per_dir_configs(apr_pool_t *p, void *base, void *new);
 840
 841 /* For http_connection.c... */
 842 /**
 843  * Setup the config vector for a connection_rec
 844  * @param p The pool to allocate the config vector out of
 845  * @return The config vector
 846  */
 847 void *ap_create_conn_config(apr_pool_t *p);
 848
 849 /* For http_core.c... (<Directory> command and virtual hosts) */
 850
 851 /**
 852  * parse an htaccess file
 853  * @param resulting htaccess_result
 854  * @param r The request currently being served
 855  * @param override Which overrides are active
 856  * @param path The path to the htaccess file
 857  * @param access_name The list of possible names for .htaccess files
 858  * int The status of the current request
 859  */
 860 int ap_parse_htaccess(void **result, request_rec *r, int override,
 861                 const char *path, const char *access_name);
 862
 863 /**
 864  * Setup a virtual host
 865  * @param p The pool to allocate all memory out of
 866  * @param hostname The hostname of the virtual hsot
 867  * @param main_server The main server for this Apache configuration
 868  * @param ps Place to store the new server_rec
 869  * return Error string on error, NULL on success
 870  * @deffunc const char *ap_init_virtual_host(apr_pool_t *p, const char *hostname, server_rec *main_server, server_rec **ps)
 871  */
 872 AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
 873                                 server_rec *main_server, server_rec **);
 874
 875 /**
 876  * Process the config file for Apache
 877  * @param s The server rec to use for the command parms
 878  * @param fname The name of the config file
 879  * @param conftree The root node of the created config tree
 880  * @param p Pool for general allocation
 881  * @param ptem Pool for temporary allocation
 882  */
 883 void ap_process_resource_config(server_rec *s, const char *fname,
 884                  ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
 885
 886 /**
 887  * Process all directives in the config tree
 888  * @param s The server rec to use in the command parms
 889  * @param conftree The config tree to process
 890  * @param p The pool for general allocation
 891  * @param ptemp The pool for temporary allocations
 892  */
 893 AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
 894                                         apr_pool_t *p, apr_pool_t *ptemp);
 895
 896
 897 /* For individual MPMs... */
 898 /**
 899  * Run all child init hooks
 900  * @param pchild The pool for child process allocations
 901  * @param s The list of all server_recs
 902  */
 903 void ap_child_init_hook(apr_pool_t *pchild, server_rec *s);
 904
 905 /* Module-method dispatchers, also for http_request.c */
 906 /**
 907  * Run the handler phase of each module until a module accepts the
 908  * responsibility of serving the request
 909  * @param r The current request
 910  * @return The status of the current request
 911  */
 912 int ap_invoke_handler(request_rec *);
 913
 914 /* for mod_perl */
 915
 916 /**
 917  * Find a given directive in a command_rec table
 918  * @param name The directive to search for
 919  * @param cmds The table to search
 920  * @return The directive definition of the specified directive
 921  * @deffunc const command_rec *ap_find_command(const char *name, const command_rec *cmds)
 922  */
 923 AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
 924
 925 /**
 926  * Find a given directive in a list module
 927  * @param cmd_name The directive to search for
 928  * @param mod The module list to search
 929  * @return The directive definition of the specified directive
 930  * @deffunc const command_rec *ap_find_command_in_modules(const char *cmd_name,module **mod)
 931  */
 932 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
 933
 934 /**
 935  * Add a per_dir and per_server config vector to a given module
 936  * @param parms The command_parms to use
 937  * @param config The config vector
 938  * @param mod The module to add the vector for.
 939  * @return The new config vector
 940  * @deffunc void *ap_set_config_vectors(cmd_parms *parms, void *config, module *mod)
 941  */
 942 AP_CORE_DECLARE(void *) ap_set_config_vectors(cmd_parms *parms, void *config, module *mod);
 943
 944 #endif
 945
 946   /* Hooks */
 947
 948 /**
 949  * Run the header parser functions for each module
 950  * @param r The current request
 951  * @return OK or DECLINED
 952  * @deffunc int ap_run_header_parser(request_rec *r)
 953  */
 954 AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
 955
 956 /**
 957  * Run the pre_config function for each module
 958  * @param pconf The config pool
 959  * @param plog The logging streams pool
 960  * @param ptemp The temporary pool
 961  * @deffunc void ap_run_pre_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp)
 962  */
 963 AP_DECLARE_HOOK(void,pre_config,
 964              (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp))
 965
 966 /**
 967  * Run the post_config function for each module
 968  * @param pconf The config pool
 969  * @param plog The logging streams pool
 970  * @param ptemp The temporary pool
 971  * @param s The list of server_recs
 972  * @deffunc void ap_run_post_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
 973  */
 974 AP_DECLARE_HOOK(void,post_config,
 975              (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
 976
 977 /**
 978  * Run the open_logs functions for each module
 979  * @param pconf The config pool
 980  * @param plog The logging streams pool
 981  * @param ptemp The temporary pool
 982  * @param s The list of server_recs
 983  * @deffunc void ap_run_open_logs(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
 984  */
 985 AP_DECLARE_HOOK(void,open_logs,
 986              (apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
 987
 988 /**
 989  * Run the child_init functions for each module
 990  * @param pchild The child pool
 991  * @param s The list of server_recs in this server
 992  * @deffunc void ap_run_child_init(apr_pool_t *pchild, server_rec *s)
 993  */
 994 AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
 995
 996 /**
 997  * Run the handler functions for each module
 998  * @param r The request_rec
 999  * @tip non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
1000  * @deffunc void ap_run_handler(request_rec *r)
1001  */
1002 AP_DECLARE_HOOK(int,handler,(request_rec *r))
1003
1004 /**
1005  * Retrieve the optional functions for each module.
1006  * This is run immediately before the server starts. Optional functions should
1007  * be registered during the hook registration phase.
1008  * @deffunc void ap_run_optional_fn_retrieve(void)
1009  */
1010 AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
1011
1012 #ifdef __cplusplus
1013 }
1014 #endif
1015
1016 #endif  /* !APACHE_HTTP_CONFIG_H */