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

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2001 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  * @file http_config.h
  71  * @brief Apache Configuration
  72  */
  73
  74 /*
  75  * The central data structures around here...
  76  */
  77
  78 /* Command dispatch structures... */
  79
  80 /**
  81  * How the directives arguments should be parsed.
  82  * @remark Note that for all of these except RAW_ARGS, the config routine is
  83  *      passed a freshly allocated string which can be modified or stored
  84  *      or whatever...
  85  */
  86 enum cmd_how {
  87     RAW_ARGS,                   /**< cmd_func parses command line itself */
  88     TAKE1,                      /**< one argument only */
  89     TAKE2,                      /**< two arguments only */
  90     ITERATE,                    /**< one argument, occuring multiple times
  91                                  * (e.g., IndexIgnore)
  92                                  */
  93     ITERATE2,                   /**< two arguments, 2nd occurs multiple times
  94                                  * (e.g., AddIcon)
  95                                  */
  96     FLAG,                       /**< One of 'On' or 'Off' */
  97     NO_ARGS,                    /**< No args at all, e.g. </Directory> */
  98     TAKE12,                     /**< one or two arguments */
  99     TAKE3,                      /**< three arguments only */
 100     TAKE23,                     /**< two or three arguments */
 101     TAKE123,                    /**< one, two or three arguments */
 102     TAKE13                      /**< one or three arguments */
 103 };
 104 /**
 105  * This structure is passed to a command which is being invoked,
 106  * to carry a large variety of miscellaneous data which is all of
 107  * use to *somebody*...
 108  */
 109 typedef struct cmd_parms_struct cmd_parms;
 110
 111 #if defined(AP_HAVE_DESIGNATED_INITIALIZER) || defined(DOXYGEN)
 112
 113 /**
 114  * All the types of functions that can be used in directives
 115  * @internal
 116  */
 117 typedef union {
 118     /** function to call for a no-args */
 119     const char *(*no_args) (cmd_parms *parms, void *mconfig);
 120     /** function to call for a raw-args */
 121     const char *(*raw_args) (cmd_parms *parms, void *mconfig,
 122                              const char *args);
 123     /** function to call for a take1 */
 124     const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
 125     /** function to call for a take2 */
 126     const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
 127                           const char *w2);
 128     /** function to call for a take3 */
 129     const char *(*take3) (cmd_parms *parms, void *mconfig, const char *w,
 130                           const char *w2, const char *w3);
 131     /** function to call for a flag */
 132     const char *(*flag) (cmd_parms *parms, void *mconfig, int on);
 133 } cmd_func;
 134
 135 /** This configuration directive does not take any arguments */
 136 # define AP_NO_ARGS     func.no_args
 137 /** This configuration directive will handle it's own parsing of arguments*/
 138 # define AP_RAW_ARGS    func.raw_args
 139 /** This configuration directive takes 1 argument*/
 140 # define AP_TAKE1       func.take1
 141 /** This configuration directive takes 2 arguments */
 142 # define AP_TAKE2       func.take2
 143 /** This configuration directive takes 3 arguments */
 144 # define AP_TAKE3       func.take3
 145 /** This configuration directive takes a flag (on/off) as a argument*/
 146 # define AP_FLAG        func.flag
 147
 148 /** method of declaring a directive with no arguments */
 149 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
 150     { directive, { .no_args=func }, mconfig, where, RAW_ARGS, help }
 151 /** method of declaring a directive with raw argument parsing */
 152 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
 153     { directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
 154 /** method of declaring a directive which takes 1 argument */
 155 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
 156     { directive, { .take1=func }, mconfig, where, TAKE1, help }
 157 /** method of declaring a directive which takes multiple arguments */
 158 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
 159     { directive, { .take1=func }, mconfig, where, ITERATE, help }
 160 /** method of declaring a directive which takes 2 arguments */
 161 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
 162     { directive, { .take2=func }, mconfig, where, TAKE2, help }
 163 /** method of declaring a directive which takes 1 or 2 arguments */
 164 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
 165     { directive, { .take2=func }, mconfig, where, TAKE12, help }
 166 /** method of declaring a directive which takes multiple 2 arguments */
 167 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
 168     { directive, { .take2=func }, mconfig, where, ITERATE2, help }
 169 /** method of declaring a directive which takes 2 or 3 arguments */
 170 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
 171     { directive, { .take3=func }, mconfig, where, TAKE23, help }
 172 /** method of declaring a directive which takes 3 arguments */
 173 # define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
 174     { directive, { .take3=func }, mconfig, where, TAKE3, help }
 175 /** method of declaring a directive which takes a flag (on/off) as a argument*/
 176 # define AP_INIT_FLAG(directive, func, mconfig, where, help) \
 177     { directive, { .flag=func }, mconfig, where, FLAG, help }
 178
 179 #else /* AP_HAVE_DESIGNATED_INITIALIZER */
 180
 181 typedef const char *(*cmd_func) ();
 182
 183 # define AP_NO_ARGS  func
 184 # define AP_RAW_ARGS func
 185 # define AP_TAKE1    func
 186 # define AP_TAKE2    func
 187 # define AP_TAKE3    func
 188 # define AP_FLAG     func
 189
 190 # define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
 191     { directive, func, mconfig, where, RAW_ARGS, help }
 192 # define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
 193     { directive, func, mconfig, where, RAW_ARGS, help }
 194 # define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
 195     { directive, func, mconfig, where, TAKE1, help }
 196 # define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
 197     { directive, func, mconfig, where, ITERATE, help }
 198 # define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
 199     { directive, func, mconfig, where, TAKE2, help }
 200 # define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
 201     { directive, func, mconfig, where, TAKE12, help }
 202 # define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
 203     { directive, func, mconfig, where, ITERATE2, help }
 204 # define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
 205     { directive, func, mconfig, where, TAKE23, help }
 206 # define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
 207     { directive, func, mconfig, where, TAKE3, help }
 208 # define AP_INIT_FLAG(directive, func, mconfig, where, help) \
 209     { directive, func, mconfig, where, FLAG, help }
 210
 211 #endif /* AP_HAVE_DESIGNATED_INITIALIZER */
 212
 213 /**
 214  * The command record structure.  Each modules can define a table of these
 215  * to define the directives it will implement.
 216  */
 217 typedef struct command_struct command_rec;
 218 struct command_struct {
 219     /** Name of this command */
 220     const char *name;
 221     /** The function to be called when this directive is parsed */
 222     cmd_func func;
 223     /** Extra data, for functions which implement multiple commands... */
 224     void *cmd_data;
 225     /** What overrides need to be allowed to enable this command. */
 226     int req_override;
 227     /** What the command expects as arguments
 228      *  @defvar cmd_how args_how*/
 229     enum cmd_how args_how;
 230
 231     /** 'usage' message, in case of syntax errors */
 232     const char *errmsg;
 233 };
 234
 235 /**
 236  * @defgroup ConfigDirectives Allowed locations for configuration directives.
 237  *
 238  * The allowed locations for a configuration directive are the union of
 239  * those indicated by each set bit in the req_override mask.
 240  *
 241  * @{
 242  */
 243 #define OR_NONE 0             /**< *.conf is not available anywhere in this override */
 244 #define OR_LIMIT 1           /**< *.conf inside <Directory> or <Location>
 245                                 and .htaccess when AllowOverride Limit */
 246 #define OR_OPTIONS 2         /**< *.conf anywhere
 247                                 and .htaccess when AllowOverride Options */
 248 #define OR_FILEINFO 4        /**< *.conf anywhere
 249                                 and .htaccess when AllowOverride FileInfo */
 250 #define OR_AUTHCFG 8         /**< *.conf inside <Directory> or <Location>
 251                                 and .htaccess when AllowOverride AuthConfig */
 252 #define OR_INDEXES 16        /**< *.conf anywhere
 253                                 and .htaccess when AllowOverride Indexes */
 254 #define OR_UNSET 32          /**< unset a directive (in Allow) */
 255 #define ACCESS_CONF 64       /**< *.conf inside <Directory> or <Location> */
 256 #define RSRC_CONF 128        /**< *.conf outside <Directory> or <Location> */
 257 #define EXEC_ON_READ 256     /**< force directive to execute a command
 258                 which would modify the conifguration (like including another
 259                 file, or IFModule */
 260 /** this directive can be placed anywhere */
 261 #define OR_ALL (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
 262
 263 /** @} */
 264
 265 /**
 266  * This can be returned by a function if they don't wish to handle
 267  * a command. Make it something not likely someone will actually use
 268  * as an error code.
 269  */
 270 #define DECLINE_CMD "\a\b"
 271
 272 /** Common structure for reading of config files / passwd files etc. */
 273 typedef struct ap_configfile_t ap_configfile_t;
 274 struct ap_configfile_t {
 275     int (*getch) (void *param);     /**< a getc()-like function */
 276     void *(*getstr) (void *buf, size_t bufsiz, void *param);
 277                                     /**< a fgets()-like function */
 278     int (*close) (void *param);     /**< a close handler function */
 279     void *param;                    /**< the argument passed to getch/getstr/close */
 280     const char *name;               /**< the filename / description */
 281     unsigned line_number;           /**< current line number, starting at 1 */
 282 };
 283
 284 /**
 285  * This structure is passed to a command which is being invoked,
 286  * to carry a large variety of miscellaneous data which is all of
 287  * use to *somebody*...
 288  */
 289 struct cmd_parms_struct {
 290     /** Argument to command from cmd_table */
 291     void *info;
 292     /** Which allow-override bits are set */
 293     int override;
 294     /** Which methods are <Limit>ed */
 295     apr_int64_t limited;
 296     /** methods which are limited */
 297     apr_array_header_t *limited_xmethods;
 298     /** methods which are xlimited */
 299     ap_method_list_t *xlimited;
 300
 301     /** Config file structure. */
 302     ap_configfile_t *config_file;
 303     /** the directive specifying this command */
 304     ap_directive_t *directive;
 305
 306     /** Pool to allocate new storage in */
 307     apr_pool_t *pool;
 308     /** Pool for scratch memory; persists during configuration, but
 309      *  wiped before the first request is served...  */
 310     apr_pool_t *temp_pool;
 311     /** Server_rec being configured for */
 312     server_rec *server;
 313     /** If configuring for a directory, pathname of that directory.
 314      *  NOPE!  That's what it meant previous to the existance of <Files>,
 315      * <Location> and regex matching.  Now the only usefulness that can be
 316      * derived from this field is whether a command is being called in a
 317      * server context (path == NULL) or being called in a dir context
 318      * (path != NULL).  */
 319     char *path;
 320     /** configuration command */
 321     const command_rec *cmd;
 322
 323     /** per_dir_config vector passed to handle_command */
 324     struct ap_conf_vector_t *context;
 325     /** directive with syntax error */
 326     const ap_directive_t *err_directive;
 327 };
 328
 329 /**
 330  * Module structures.  Just about everything is dispatched through
 331  * these, directly or indirectly (through the command and handler
 332  * tables).
 333  */
 334 typedef struct module_struct module;
 335 struct module_struct {
 336     /** API version, *not* module version; check that module is
 337      * compatible with this version of the server.
 338      */
 339     int version;
 340     /** API minor version. Provides API feature milestones. Not checked
 341      *  during module init */
 342     int minor_version;
 343     /** Index to this modules structures in config vectors.  */
 344     int module_index;
 345
 346     /** The name of the module's C file */
 347     const char *name;
 348     /** The handle for the DSO.  Internal use only */
 349     void *dynamic_load_handle;
 350
 351     /** A pointer to the next module in the list
 352      *  @defvar module_struct *next */
 353     struct module_struct *next;
 354
 355     /** Magic Cookie to identify a module structure;  It's mainly
 356      *  important for the DSO facility (see also mod_so).  */
 357     unsigned long magic;
 358
 359     /** Function to allow MPMs to re-write command line arguments.  This
 360      *  hook is only available to MPMs.
 361      *  @param The process that the server is running in.
 362      */
 363     void (*rewrite_args) (process_rec *process);
 364     /** Function to allow all modules to create per directory configuration
 365      *  structures.
 366      *  @param p The pool to use for all allocations.
 367      *  @param dir The directory currently being processed.
 368      *  @return The per-directory structure created
 369      */
 370     void *(*create_dir_config) (apr_pool_t *p, char *dir);
 371     /** Function to allow all modules to merge the per directory configuration
 372      *  structures for two directories.
 373      *  @param p The pool to use for all allocations.
 374      *  @param base_conf The directory structure created for the parent directory.
 375      *  @param new_conf The directory structure currently being processed.
 376      *  @return The new per-directory structure created
 377      */
 378     void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *new_conf);
 379     /** Function to allow all modules to create per server configuration
 380      *  structures.
 381      *  @param p The pool to use for all allocations.
 382      *  @param s The server currently being processed.
 383      *  @return The per-server structure created
 384      */
 385     void *(*create_server_config) (apr_pool_t *p, server_rec *s);
 386     /** Function to allow all modules to merge the per server configuration
 387      *  structures for two servers.
 388      *  @param p The pool to use for all allocations.
 389      *  @param base_conf The directory structure created for the parent directory.
 390      *  @param new_conf The directory structure currently being processed.
 391      *  @return The new per-directory structure created
 392      */
 393     void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void *new_conf);
 394
 395     /** A command_rec table that describes all of the directives this module
 396      * defines. */
 397     const command_rec *cmds;
 398
 399     /** A hook to allow modules to hook other points in the request processing.
 400      *  In this function, modules should call the ap_hook_*() functions to
 401      *  register an interest in a specific step in processing the current
 402      *  request.
 403      *  @param p the pool to use for all allocations
 404      */
 405     void (*register_hooks) (apr_pool_t *p);
 406 };
 407
 408 /**
 409  * @defgroup ModuleInit Module structure initializers
 410  *
 411  * Initializer for the first few module slots, which are only
 412  * really set up once we start running.  Note that the first two slots
 413  * provide a version check; this should allow us to deal with changes to
 414  * the API. The major number should reflect changes to the API handler table
 415  * itself or removal of functionality. The minor number should reflect
 416  * additions of functionality to the existing API. (the server can detect
 417  * an old-format module, and either handle it back-compatibly, or at least
 418  * signal an error). See src/include/ap_mmn.h for MMN version history.
 419  * @{
 420  */
 421
 422 /** The one used in Apache 1.3, which will deliberately cause an error */
 423 #define STANDARD_MODULE_STUFF   this_module_needs_to_be_ported_to_apache_2_0
 424
 425 /** Use this in all standard modules */
 426 #define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
 427                                 MODULE_MAGIC_NUMBER_MINOR, \
 428                                 -1, \
 429                                 __FILE__, \
 430                                 NULL, \
 431                                 NULL, \
 432                                 MODULE_MAGIC_COOKIE, \
 433                                 NULL      /* rewrite args spot */
 434
 435 /** Use this only in MPMs */
 436 #define MPM20_MODULE_STUFF      MODULE_MAGIC_NUMBER_MAJOR, \
 437                                 MODULE_MAGIC_NUMBER_MINOR, \
 438                                 -1, \
 439                                 __FILE__, \
 440                                 NULL, \
 441                                 NULL, \
 442                                 MODULE_MAGIC_COOKIE
 443
 444 /** @} */
 445
 446 /* CONFIGURATION VECTOR FUNCTIONS */
 447
 448 /** configuration vector structure */
 449 typedef struct ap_conf_vector_t ap_conf_vector_t;
 450
 451 #if defined(AP_DEBUG) || defined(DOXYGEN)
 452 /**
 453  * Generic accessors for other modules to get at their own module-specific
 454  * data
 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 get the data for.
 458  * @return The module-specific data
 459  */
 460 AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
 461                                         const module *m);
 462
 463 /**
 464  * Generic accessors for other modules to set at their own module-specific
 465  * data
 466  * @param conf_vector The vector in which the modules configuration is stored.
 467  *        usually r->per_dir_config or s->module_config
 468  * @param m The module to set the data for.
 469  * @param val The module-specific data to set
 470  */
 471 AP_DECLARE(void) ap_set_module_config(ap_conf_vector_t *cv, const module *m,
 472                                       void *val);
 473
 474 #else /* AP_DEBUG */
 475
 476 #define ap_get_module_config(v,m)       \
 477     (((void **)(v))[(m)->module_index])
 478 #define ap_set_module_config(v,m,val)   \
 479     ((((void **)(v))[(m)->module_index]) = (val))
 480
 481 #endif /* AP_DEBUG */
 482
 483
 484 /**
 485  * Generic command handling function for strings
 486  * @param cmd The command parameters for this directive
 487  * @param struct_ptr pointer into a given type
 488  * @param arg The argument to the directive
 489  * @return An error string or NULL on success
 490  */
 491 AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_ptr,
 492                                                    const char *arg);
 493
 494 /**
 495  * Generic command handling function for integers
 496  * @param cmd The command parameters for this directive
 497  * @param struct_ptr pointer into a given type
 498  * @param arg The argument to the directive
 499  * @return An error string or NULL on success
 500  */
 501 AP_DECLARE_NONSTD(const char *) ap_set_int_slot(cmd_parms *cmd,
 502                                                 void *struct_ptr,
 503                                                 const char *arg);
 504
 505 /**
 506  * Return true if the specified method is limited by being listed in
 507  * a <Limit> container, or by *not* being listed in a <LimiteExcept>
 508  * container.
 509  *
 510  * @param   method  Pointer to a string specifying the method to check.
 511  * @param   cmd     Pointer to the cmd_parms structure passed to the
 512  *                  directive handler.
 513  * @return  0 if the method is not limited in the current scope
 514  */
 515 AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
 516
 517 /**
 518  * Generic command handling function for strings, always sets the value
 519  * to a lowercase string
 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  */
 525 AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
 526                                                          void *struct_ptr, const char *arg);
 527 /**
 528  * Generic command handling function for flags
 529  * @param cmd The command parameters for this directive
 530  * @param struct_ptr pointer into a given type
 531  * @param arg The argument to the directive (either 1 or 0)
 532  * @return An error string or NULL on success
 533  */
 534 AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg);
 535 /**
 536  * Generic command handling function for files
 537  * @param cmd The command parameters for this directive
 538  * @param struct_ptr pointer into a given type
 539  * @param arg The argument to the directive
 540  * @return An error string or NULL on success
 541  */
 542 AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg);
 543 /**
 544  * Generic command handling function to respond with cmd->help as an error
 545  * @param cmd The command parameters for this directive
 546  * @param struct_ptr pointer into a given type
 547  * @param arg The argument to the directive
 548  * @return The cmd->help value as the error string
 549  * @tip This allows simple declarations such as;
 550  * <pre>
 551  *     AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
 552  *         "The Foo directive is no longer supported, use Bar"),
 553  * </pre>
 554  */
 555 AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd, void *struct_ptr, const char *arg);
 556 /**
 557  * For modules which need to read config files, open logs, etc. this returns
 558  * the canonical form of fname made absolute to ap_server_root.
 559  * @param p pool to allocate data from
 560  * @param fname The file name
 561  */
 562 AP_DECLARE(char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
 563
 564 /* Finally, the hook for dynamically loading modules in... */
 565
 566 /**
 567  * Add a module to the server
 568  * @param m The module structure of the module to add
 569  * @param p The pool of the same lifetime as the module
 570  */
 571 AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
 572
 573 /**
 574  * Remove a module from the server.  There are some caveats:
 575  * when the module is removed, its slot is lost so all the current
 576  * per-dir and per-server configurations are invalid. So we should
 577  * only ever call this function when you are invalidating almost
 578  * all our current data. I.e. when doing a restart.
 579  * @param m the module structure of the module to remove
 580  */
 581 AP_DECLARE(void) ap_remove_module(module *m);
 582 /**
 583  * Add a module to the chained modules list and the list of loaded modules
 584  * @param m The module structure of the module to add
 585  * @param p The pool with the same lifetime as the module
 586  */
 587 AP_DECLARE(void) ap_add_loaded_module(module *mod, apr_pool_t *p);
 588 /**
 589  * Remove a module fromthe chained modules list and the list of loaded modules
 590  * @param m the module structure of the module to remove
 591  */
 592 AP_DECLARE(void) ap_remove_loaded_module(module *mod);
 593 /**
 594  * Add a module to the list of loaded module based on the name of the
 595  * module
 596  * @param name The name of the module
 597  * @param p The pool valid for the lifetime of the module
 598  * @return 1 on success, 0 on failure
 599  */
 600 AP_DECLARE(int) ap_add_named_module(const char *name, apr_pool_t *p);
 601 /**
 602  * Find the name of the specified module
 603  * @param m The module to get the name for
 604  * @return the name of the module
 605  */
 606 AP_DECLARE(const char *) ap_find_module_name(module *m);
 607 /**
 608  * Find a module based on the name of the module
 609  * @param name the name of the module
 610  * @return the module structure if found, NULL otherwise
 611  */
 612 AP_DECLARE(module *) ap_find_linked_module(const char *name);
 613
 614 /**
 615  * Open a ap_configfile_t as apr_file_t
 616  * @param ret_cfg open ap_configfile_t struct pointer
 617  * @param p The pool to allocate the structure from
 618  * @param name the name of the file to open
 619  */
 620 AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name);
 621
 622 /**
 623  * Allocate a ap_configfile_t handle with user defined functions and params
 624  * @param p The pool to allocate from
 625  * @param descr The name of the file
 626  * @param param The argument passed to getch/getstr/close
 627  * @param getc_func The getch function
 628  * @param gets_func The getstr function
 629  * @param close_func The close function
 630  */
 631 AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
 632     void *param,
 633     int(*getc_func)(void*),
 634     void *(*gets_func) (void *buf, size_t bufsiz, void *param),
 635     int(*close_func)(void *param));
 636
 637 /**
 638  * Read one line from open ap_configfile_t, strip LF, increase line number
 639  * @param buf place to store the line read
 640  * @param bufsize size of the buffer
 641  * @param cfp File to read from
 642  * @return 1 on success, 0 on failure
 643  */
 644 AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp);
 645
 646 /**
 647  * Read one char from open configfile_t, increase line number upon LF
 648  * @param cfp The file to read from
 649  * @return the character read
 650  */
 651 AP_DECLARE(int) ap_cfg_getc(ap_configfile_t *cfp);
 652
 653 /**
 654  * Detach from open ap_configfile_t, calling the close handler
 655  * @param cfp The file to close
 656  * @return 1 on sucess, 0 on failure
 657  */
 658 AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
 659
 660 /**
 661  * Read all data between the current <foo> and the matching </foo>.  All
 662  * of this data is forgotten immediately.
 663  * @param cmd The cmd_parms to pass to the directives inside the container
 664  * @param directive The directive name to read until
 665  * @return Error string on failure, NULL on success
 666  */
 667 AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
 668
 669 /**
 670  * Read all data between the current <foo> and the matching </foo> and build
 671  * a config tree from it
 672  * @param p pool to allocate from
 673  * @param temp_pool Temporary pool to allocate from
 674  * @param parms The cmd_parms to pass to all directives read
 675  * @param current The current node in the tree
 676  * @param curr_parent The current parent node
 677  * @param orig_directive The directive to read until hit.
 678  * @return Error string on failure, NULL on success
 679 */
 680 AP_DECLARE(const char *) ap_build_cont_config(apr_pool_t *p,
 681                                   apr_pool_t *temp_pool,
 682                                   cmd_parms *parms,
 683                                   ap_directive_t **current,
 684                                   ap_directive_t **curr_parent,
 685                                   char *orig_directive);
 686
 687 /**
 688  * Build a config tree from a config file
 689  * @param parms The cmd_parms to pass to all of the directives in the file
 690  * @param conf_pool The pconf pool
 691  * @param temp_pool The temporary pool
 692  * @param conftree Place to store the root node of the config tree
 693  * @return Error string on erro, NULL otherwise
 694  */
 695 AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
 696                                          apr_pool_t *conf_pool,
 697                                          apr_pool_t *temp_pool,
 698                                          ap_directive_t **conftree);
 699
 700 /**
 701  * Walk a config tree and setup the server's internal structures
 702  * @param conftree The config tree to walk
 703  * @param parms The cmd_parms to pass to all functions
 704  * @param section_vector The per-section config vector.
 705  * @return Error string on error, NULL otherwise
 706  */
 707 AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
 708                                         cmd_parms *parms,
 709                                         ap_conf_vector_t *section_vector);
 710
 711 /**
 712  * @defgroup ap_check_cmd_context ap_check_cmd_context
 713  * @{
 714  */
 715 /**
 716  * Check the context a command is used in.
 717  * @param cmd The command to check
 718  * @param forbidden Where the command is forbidden.
 719  * @return Error string on error, NULL on success
 720  */
 721 AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
 722
 723 #define  NOT_IN_VIRTUALHOST     0x01 /**< Forbidden in <Virtualhost> */
 724 #define  NOT_IN_LIMIT           0x02 /**< Forbidden in <Limit> */
 725 #define  NOT_IN_DIRECTORY       0x04 /**< Forbidden in <Directory> */
 726 #define  NOT_IN_LOCATION        0x08 /**< Forbidden in <Location> */
 727 #define  NOT_IN_FILES           0x10 /**< Forbidden in <Files> */
 728 /** Forbidden in <Directory>/<Location>/<Files>*/
 729 #define  NOT_IN_DIR_LOC_FILE    (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES)
 730 /** Forbidden in <VirtualHost>/<Limit>/Directory>/<Location>/<Files> */
 731 #define  GLOBAL_ONLY            (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
 732
 733 /** @} */
 734
 735 #ifdef CORE_PRIVATE
 736
 737 /**
 738  * The topmost module in the list
 739  * @defvar module *ap_top_module
 740  */
 741 AP_DECLARE_DATA extern module *ap_top_module;
 742
 743 /**
 744  * Array of all statically linked modules
 745  * @defvar module *ap_prelinked_modules[]
 746  */
 747 AP_DECLARE_DATA extern module *ap_prelinked_modules[];
 748 /**
 749  * Array of all preloaded modules
 750  * @defvar module *ap_preloaded_modules[]
 751  */
 752 AP_DECLARE_DATA extern module *ap_preloaded_modules[];
 753 /**
 754  * Array of all loaded modules
 755  * @defvar module **ap_loaded_modules
 756  */
 757 AP_DECLARE_DATA extern module **ap_loaded_modules;
 758
 759 /* For mod_so.c... */
 760 /** Run a single module's two create_config hooks
 761  *  @param p the pool to allocate from
 762  *  @param s The server to configure for.
 763  *  @param m The module to configure
 764  */
 765 AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
 766                                             module *m);
 767
 768 /* For http_main.c... */
 769 /**
 770  * Add all of the prelinked modules into the loaded module list
 771  * @param process The process that is currently running the server
 772  */
 773 AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
 774
 775 /**
 776  * Show the preloaded configuration directives, the help string explaining
 777  * the directive arguments, in what module they are handled, and in
 778  * what parts of the configuration they are allowed.  Used for httpd -h.
 779  */
 780 AP_DECLARE(void) ap_show_directives(void);
 781
 782 /**
 783  * Show the preloaded module names.  Used for httpd -l.
 784  */
 785 AP_DECLARE(void) ap_show_modules(void);
 786
 787 /**
 788  * Show the MPM name.  Used in reporting modules such as mod_info to
 789  * provide extra information to the user
 790  */
 791 AP_DECLARE(const char *) ap_show_mpm(void);
 792
 793 /**
 794  * Read all config files and setup the server
 795  * @param process The process running the server
 796  * @param temp_pool A pool to allocate temporary data from.
 797  * @param config_name The name of the config file
 798  * @param conftree Place to store the root of the config tree
 799  * @return The setup server_rec list.
 800  */
 801 AP_DECLARE(server_rec *) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
 802
 803 /**
 804  * Run all rewrite args hooks for loaded modules
 805  * @param process The process currently running the server
 806  */
 807 AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
 808
 809 /**
 810  * Run the register hooks function for a specified module
 811  * @param m The module to run the register hooks function fo
 812  * @param p The pool valid for the lifetime of the module
 813  */
 814 AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
 815
 816 /**
 817  * Setup all virtual hosts
 818  * @param p The pool to allocate from
 819  * @param main_server The head of the server_rec list
 820  */
 821 AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
 822
 823 /* For http_request.c... */
 824
 825 /**
 826  * Setup the config vector for a request_rec
 827  * @param p The pool to allocate the config vector from
 828  * @return The config vector
 829  */
 830 AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_request_config(apr_pool_t *p);
 831
 832 /**
 833  * Setup the config vector for per dir module configs
 834  * @param p The pool to allocate the config vector from
 835  * @return The config vector
 836  */
 837 AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
 838
 839 /**
 840  * Run all of the modules merge per dir config functions
 841  * @param p The pool to pass to the merge functions
 842  * @param base The base directory config structure
 843  * @param new_conf The new directory config structure
 844  */
 845 AP_CORE_DECLARE(ap_conf_vector_t*) ap_merge_per_dir_configs(apr_pool_t *p,
 846                                            ap_conf_vector_t *base,
 847                                            ap_conf_vector_t *new_conf);
 848
 849 /* For http_connection.c... */
 850 /**
 851  * Setup the config vector for a connection_rec
 852  * @param p The pool to allocate the config vector from
 853  * @return The config vector
 854  */
 855 AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
 856
 857 /* For http_core.c... (<Directory> command and virtual hosts) */
 858
 859 /**
 860  * parse an htaccess file
 861  * @param resulting htaccess_result
 862  * @param r The request currently being served
 863  * @param override Which overrides are active
 864  * @param path The path to the htaccess file
 865  * @param access_name The list of possible names for .htaccess files
 866  * int The status of the current request
 867  */
 868 AP_CORE_DECLARE(int) ap_parse_htaccess(ap_conf_vector_t **result,
 869                       request_rec *r, int override,
 870                       const char *path, const char *access_name);
 871
 872 /**
 873  * Setup a virtual host
 874  * @param p The pool to allocate all memory from
 875  * @param hostname The hostname of the virtual hsot
 876  * @param main_server The main server for this Apache configuration
 877  * @param ps Place to store the new server_rec
 878  * return Error string on error, NULL on success
 879  */
 880 AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
 881                                 server_rec *main_server, server_rec **);
 882
 883 /**
 884  * Process the config file for Apache
 885  * @param s The server rec to use for the command parms
 886  * @param fname The name of the config file
 887  * @param conftree The root node of the created config tree
 888  * @param p Pool for general allocation
 889  * @param ptem Pool for temporary allocation
 890  */
 891 AP_DECLARE(void) ap_process_resource_config(server_rec *s, const char *fname,
 892                  ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
 893
 894 /**
 895  * Process all directives in the config tree
 896  * @param s The server rec to use in the command parms
 897  * @param conftree The config tree to process
 898  * @param p The pool for general allocation
 899  * @param ptemp The pool for temporary allocations
 900  */
 901 AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
 902                                         apr_pool_t *p, apr_pool_t *ptemp);
 903
 904 /* Module-method dispatchers, also for http_request.c */
 905 /**
 906  * Run the handler phase of each module until a module accepts the
 907  * responsibility of serving the request
 908  * @param r The current request
 909  * @return The status of the current request
 910  */
 911 AP_CORE_DECLARE(int) ap_invoke_handler(request_rec *r);
 912
 913 /* for mod_perl */
 914
 915 /**
 916  * Find a given directive in a command_rec table
 917  * @param name The directive to search for
 918  * @param cmds The table to search
 919  * @return The directive definition of the specified directive
 920  */
 921 AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
 922
 923 /**
 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  */
 929 AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
 930
 931 /**
 932  * Ask a module to create per-server and per-section (dir/loc/file) configs
 933  * (if it hasn't happened already). The results are stored in the server's
 934  * config, and the specified per-section config vector.
 935  * @param server The server to operate upon.
 936  * @param section_vector The per-section config vector.
 937  * @param section Which section to create a config for.
 938  * @param mod The module which is defining the config data.
 939  * @param pconf A pool for all configuration allocations.
 940  * @return The (new) per-section config data.
 941  */
 942 AP_CORE_DECLARE(void *) ap_set_config_vectors(server_rec *server,
 943                                               ap_conf_vector_t *section_vector,
 944                                               const char *section,
 945                                               module *mod, apr_pool_t *pconf);
 946
 947 #endif
 948
 949   /* Hooks */
 950
 951 /**
 952  * Run the header parser functions for each module
 953  * @param r The current request
 954  * @return OK or DECLINED
 955  */
 956 AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
 957
 958 /**
 959  * Run the pre_config function for each module
 960  * @param pconf The config pool
 961  * @param plog The logging streams pool
 962  * @param ptemp The temporary pool
 963  */
 964 AP_DECLARE_HOOK(void,pre_config,(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  */
 973 AP_DECLARE_HOOK(void,post_config,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
 974
 975 /**
 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  */
 982 AP_DECLARE_HOOK(void,open_logs,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
 983
 984 /**
 985  * Run the child_init functions for each module
 986  * @param pchild The child pool
 987  * @param s The list of server_recs in this server
 988  */
 989 AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
 990
 991 /**
 992  * Run the handler functions for each module
 993  * @param r The request_rec
 994  * @remark non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
 995  */
 996 AP_DECLARE_HOOK(int,handler,(request_rec *r))
 997
 998 /**
 999  * Run the quick handler functions for each module. The quick_handler
1000  * is run before any other requests hooks are called (location_walk,
1001  * directory_walk, access checking, et. al.). This hook was added
1002  * to provide a quick way to serve content from a URI keyed cache.
1003  * @param r The request_rec
1004  */
1005 AP_DECLARE_HOOK(int,quick_handler,(request_rec *r))
1006
1007 /**
1008  * Retrieve the optional functions for each module.
1009  * This is run immediately before the server starts. Optional functions should
1010  * be registered during the hook registration phase.
1011  */
1012 AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
1013
1014 #ifdef __cplusplus
1015 }
1016 #endif
1017
1018 #endif  /* !APACHE_HTTP_CONFIG_H */