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

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