X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=include%2Fhttp_config.h;h=aec29d3e695f8e973402b06b2e8db54f65f6ac21;hb=cdb37c5e4d684dd22c702a1d8ae65ab875603d40;hp=4b7c5b2de54694a07fe9387169b2c802ed97733a;hpb=cd7883893c7ca99e22a3a114d8796117435f7d2c;p=apache
diff --git a/include/http_config.h b/include/http_config.h
index 4b7c5b2de5..aec29d3e69 100644
--- a/include/http_config.h
+++ b/include/http_config.h
@@ -1,75 +1,38 @@
-/* ====================================================================
- * The Apache Software License, Version 1.1
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
*
- * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
- * reserved.
+ * http://www.apache.org/licenses/LICENSE-2.0
*
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Apache" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation. For more
- * information on the Apache Software Foundation, please see
- * .
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file http_config.h
+ * @brief Apache Configuration
*
- * Portions of this software are based upon public domain software
- * originally written at the National Center for Supercomputing Applications,
- * University of Illinois, Urbana-Champaign.
+ * @defgroup APACHE_CORE_CONFIG Configuration
+ * @ingroup APACHE_CORE
+ * @{
*/
#ifndef APACHE_HTTP_CONFIG_H
#define APACHE_HTTP_CONFIG_H
-#include "apr_hooks.h"
#include "util_cfgtree.h"
+#include "ap_config.h"
#ifdef __cplusplus
extern "C" {
#endif
-/**
- * @package Apache Configuration
- */
-
/*
* The central data structures around here...
*/
@@ -78,96 +41,126 @@ extern "C" {
/**
* How the directives arguments should be parsed.
- * @tip Note that for all of these except RAW_ARGS, the config routine is
+ * @remark Note that for all of these except RAW_ARGS, the config routine is
* passed a freshly allocated string which can be modified or stored
- * or whatever... it's only necessary to do pstrdup() stuff with
- *
- * RAW_ARGS -- cmd_func parses command line itself
- * TAKE1 -- one argument only
- * TAKE2 -- two arguments only
- * ITERATE -- one argument, occuring multiple times
- * * (e.g., IndexIgnore)
- * ITERATE2 -- two arguments, 2nd occurs multiple times
- * * (e.g., AddIcon)
- * FLAG -- One of 'On' or 'Off'
- * NO_ARGS -- No args at all, e.g.
- * TAKE12 -- one or two arguments
- * TAKE3 -- three arguments only
- * TAKE23 -- two or three arguments
- * TAKE123 -- one, two or three arguments
- * TAKE13 -- one or three arguments
- *
- * @defvar enum cmd_how
+ * or whatever...
*/
enum cmd_how {
- RAW_ARGS, /* cmd_func parses command line itself */
- TAKE1, /* one argument only */
- TAKE2, /* two arguments only */
- ITERATE, /* one argument, occuring multiple times
- * (e.g., IndexIgnore)
- */
- ITERATE2, /* two arguments, 2nd occurs multiple times
- * (e.g., AddIcon)
- */
- FLAG, /* One of 'On' or 'Off' */
- NO_ARGS, /* No args at all, e.g. */
- TAKE12, /* one or two arguments */
- TAKE3, /* three arguments only */
- TAKE23, /* two or three arguments */
- TAKE123, /* one, two or three arguments */
- TAKE13 /* one or three arguments */
+ RAW_ARGS, /**< cmd_func parses command line itself */
+ TAKE1, /**< one argument only */
+ TAKE2, /**< two arguments only */
+ ITERATE, /**< one argument, occuring multiple times
+ * (e.g., IndexIgnore)
+ */
+ ITERATE2, /**< two arguments, 2nd occurs multiple times
+ * (e.g., AddIcon)
+ */
+ FLAG, /**< One of 'On' or 'Off' */
+ NO_ARGS, /**< No args at all, e.g. </Directory> */
+ TAKE12, /**< one or two arguments */
+ TAKE3, /**< three arguments only */
+ TAKE23, /**< two or three arguments */
+ TAKE123, /**< one, two or three arguments */
+ TAKE13, /**< one or three arguments */
+ TAKE_ARGV /**< an argc and argv are passed */
};
+/**
+ * This structure is passed to a command which is being invoked,
+ * to carry a large variety of miscellaneous data which is all of
+ * use to *somebody*...
+ */
typedef struct cmd_parms_struct cmd_parms;
-#ifdef AP_DEBUG
+#if defined(AP_HAVE_DESIGNATED_INITIALIZER) || defined(DOXYGEN)
+/**
+ * All the types of functions that can be used in directives
+ * @internal
+ */
typedef union {
+ /** function to call for a no-args */
const char *(*no_args) (cmd_parms *parms, void *mconfig);
+ /** function to call for a raw-args */
const char *(*raw_args) (cmd_parms *parms, void *mconfig,
- const char *args);
+ const char *args);
+ /** function to call for a argv/argc */
+ const char *(*take_argv) (cmd_parms *parms, void *mconfig,
+ int argc, char *const argv[]);
+ /** function to call for a take1 */
const char *(*take1) (cmd_parms *parms, void *mconfig, const char *w);
+ /** function to call for a take2 */
const char *(*take2) (cmd_parms *parms, void *mconfig, const char *w,
- const char *w2);
+ const char *w2);
+ /** function to call for a take3 */
const char *(*take3) (cmd_parms *parms, void *mconfig, const char *w,
- const char *w2, const char *w3);
+ const char *w2, const char *w3);
+ /** function to call for a flag */
const char *(*flag) (cmd_parms *parms, void *mconfig, int on);
} cmd_func;
-# define AP_NO_ARGS func.no_args
-# define AP_RAW_ARGS func.raw_args
-# define AP_TAKE1 func.take1
-# define AP_TAKE2 func.take2
-# define AP_TAKE3 func.take3
-# define AP_FLAG func.flag
-
+/** This configuration directive does not take any arguments */
+# define AP_NO_ARGS func.no_args
+/** This configuration directive will handle its own parsing of arguments*/
+# define AP_RAW_ARGS func.raw_args
+/** This configuration directive will handle its own parsing of arguments*/
+# define AP_TAKE_ARGV func.take_argv
+/** This configuration directive takes 1 argument*/
+# define AP_TAKE1 func.take1
+/** This configuration directive takes 2 arguments */
+# define AP_TAKE2 func.take2
+/** This configuration directive takes 3 arguments */
+# define AP_TAKE3 func.take3
+/** This configuration directive takes a flag (on/off) as a argument*/
+# define AP_FLAG func.flag
+
+/** mechanism for declaring a directive with no arguments */
# define AP_INIT_NO_ARGS(directive, func, mconfig, where, help) \
{ directive, { .no_args=func }, mconfig, where, RAW_ARGS, help }
+/** mechanism for declaring a directive with raw argument parsing */
# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
{ directive, { .raw_args=func }, mconfig, where, RAW_ARGS, help }
+/** mechanism for declaring a directive with raw argument parsing */
+# define AP_INIT_TAKE_ARGV(directive, func, mconfig, where, help) \
+ { directive, { .take_argv=func }, mconfig, where, TAKE_ARGV, help }
+/** mechanism for declaring a directive which takes 1 argument */
# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
{ directive, { .take1=func }, mconfig, where, TAKE1, help }
+/** mechanism for declaring a directive which takes multiple arguments */
# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
{ directive, { .take1=func }, mconfig, where, ITERATE, help }
+/** mechanism for declaring a directive which takes 2 arguments */
# define AP_INIT_TAKE2(directive, func, mconfig, where, help) \
{ directive, { .take2=func }, mconfig, where, TAKE2, help }
+/** mechanism for declaring a directive which takes 1 or 2 arguments */
# define AP_INIT_TAKE12(directive, func, mconfig, where, help) \
{ directive, { .take2=func }, mconfig, where, TAKE12, help }
+/** mechanism for declaring a directive which takes multiple 2 arguments */
# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
{ directive, { .take2=func }, mconfig, where, ITERATE2, help }
+/** mechanism for declaring a directive which takes 1 or 3 arguments */
+# define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
+ { directive, { .take3=func }, mconfig, where, TAKE13, help }
+/** mechanism for declaring a directive which takes 2 or 3 arguments */
# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
{ directive, { .take3=func }, mconfig, where, TAKE23, help }
+/** mechanism for declaring a directive which takes 1 to 3 arguments */
+# define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
+ { directive, { .take3=func }, mconfig, where, TAKE123, help }
+/** mechanism for declaring a directive which takes 3 arguments */
# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
{ directive, { .take3=func }, mconfig, where, TAKE3, help }
+/** mechanism for declaring a directive which takes a flag (on/off) argument */
# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
{ directive, { .flag=func }, mconfig, where, FLAG, help }
-#else
+#else /* AP_HAVE_DESIGNATED_INITIALIZER */
typedef const char *(*cmd_func) ();
# define AP_NO_ARGS func
# define AP_RAW_ARGS func
+# define AP_TAKE_ARGV func
# define AP_TAKE1 func
# define AP_TAKE2 func
# define AP_TAKE3 func
@@ -177,6 +170,8 @@ typedef const char *(*cmd_func) ();
{ directive, func, mconfig, where, RAW_ARGS, help }
# define AP_INIT_RAW_ARGS(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, RAW_ARGS, help }
+# define AP_INIT_TAKE_ARGV(directive, func, mconfig, where, help) \
+ { directive, func, mconfig, where, TAKE_ARGV, help }
# define AP_INIT_TAKE1(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, TAKE1, help }
# define AP_INIT_ITERATE(directive, func, mconfig, where, help) \
@@ -187,90 +182,91 @@ typedef const char *(*cmd_func) ();
{ directive, func, mconfig, where, TAKE12, help }
# define AP_INIT_ITERATE2(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, ITERATE2, help }
+# define AP_INIT_TAKE13(directive, func, mconfig, where, help) \
+ { directive, func, mconfig, where, TAKE13, help }
# define AP_INIT_TAKE23(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, TAKE23, help }
+# define AP_INIT_TAKE123(directive, func, mconfig, where, help) \
+ { directive, func, mconfig, where, TAKE123, help }
# define AP_INIT_TAKE3(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, TAKE3, help }
# define AP_INIT_FLAG(directive, func, mconfig, where, help) \
{ directive, func, mconfig, where, FLAG, help }
-#endif
+#endif /* AP_HAVE_DESIGNATED_INITIALIZER */
-typedef struct command_struct command_rec;
/**
* The command record structure. Each modules can define a table of these
* to define the directives it will implement.
*/
+typedef struct command_struct command_rec;
struct command_struct {
/** Name of this command */
const char *name;
/** The function to be called when this directive is parsed */
cmd_func func;
/** Extra data, for functions which implement multiple commands... */
- void *cmd_data;
+ void *cmd_data;
/** What overrides need to be allowed to enable this command. */
int req_override;
- /** What the command expects as arguments
- * @defvar cmd_how args_how*/
+ /** What the command expects as arguments */
enum cmd_how args_how;
/** 'usage' message, in case of syntax errors */
const char *errmsg;
};
-/* The allowed locations for a configuration directive are the union of
+/**
+ * @defgroup ConfigDirectives Allowed locations for configuration directives.
+ *
+ * The allowed locations for a configuration directive are the union of
* those indicated by each set bit in the req_override mask.
*
- * (req_override & RSRC_CONF) => *.conf outside or
- * (req_override & ACCESS_CONF) => *.conf inside or
- * (req_override & OR_AUTHCFG) => *.conf inside or
- * and .htaccess when AllowOverride AuthConfig
- * (req_override & OR_LIMIT) => *.conf inside or
- * and .htaccess when AllowOverride Limit
- * (req_override & OR_OPTIONS) => *.conf anywhere
- * and .htaccess when AllowOverride Options
- * (req_override & OR_FILEINFO) => *.conf anywhere
- * and .htaccess when AllowOverride FileInfo
- * (req_override & OR_INDEXES) => *.conf anywhere
- * and .htaccess when AllowOverride Indexes
- */
-#define OR_NONE 0
-#define OR_LIMIT 1
-#define OR_OPTIONS 2
-#define OR_FILEINFO 4
-#define OR_AUTHCFG 8
-#define OR_INDEXES 16
-#define OR_UNSET 32
-#define ACCESS_CONF 64
-#define RSRC_CONF 128
-#define EXEC_ON_READ 256
+ * @{
+ */
+#define OR_NONE 0 /**< *.conf is not available anywhere in this override */
+#define OR_LIMIT 1 /**< *.conf inside <Directory> or <Location>
+ and .htaccess when AllowOverride Limit */
+#define OR_OPTIONS 2 /**< *.conf anywhere
+ and .htaccess when AllowOverride Options */
+#define OR_FILEINFO 4 /**< *.conf anywhere
+ and .htaccess when AllowOverride FileInfo */
+#define OR_AUTHCFG 8 /**< *.conf inside <Directory> or <Location>
+ and .htaccess when AllowOverride AuthConfig */
+#define OR_INDEXES 16 /**< *.conf anywhere
+ and .htaccess when AllowOverride Indexes */
+#define OR_UNSET 32 /**< bit to indicate that AllowOverride has not been set */
+#define ACCESS_CONF 64 /**< *.conf inside <Directory> or <Location> */
+#define RSRC_CONF 128 /**< *.conf outside <Directory> or <Location> */
+#define EXEC_ON_READ 256 /**< force directive to execute a command
+ which would modify the configuration (like including another
+ file, or IFModule */
+/** this directive can be placed anywhere */
#define OR_ALL (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
+/** @} */
+
/**
* This can be returned by a function if they don't wish to handle
* a command. Make it something not likely someone will actually use
* as an error code.
- * @defvar DECLINE_CMD "\a\b"
*/
#define DECLINE_CMD "\a\b"
-typedef struct ap_configfile_t ap_configfile_t;
/** Common structure for reading of config files / passwd files etc. */
+typedef struct ap_configfile_t ap_configfile_t;
struct ap_configfile_t {
- /** a getc()-like function
- * @deffunc int getch(void *param) */
- int (*getch) (void *param);
- /** a fgets()-like function
- * @deffunc void *getstr(void *buf, size_t bufsize, void *param)*/
- void *(*getstr) (void *buf, size_t bufsiz, void *param);
- /** a close hander function
- * @deffunc int close(void *param)*/
- int (*close) (void *param);
- /** the argument passed to getch/getstr/close */
+ /**< an apr_file_getc()-like function */
+ apr_status_t (*getch) (char *ch, void *param);
+ /**< an apr_file_gets()-like function */
+ apr_status_t (*getstr) (void *buf, size_t bufsiz, void *param);
+ /**< a close handler function */
+ apr_status_t (*close) (void *param);
+ /**< the argument passed to getch/getstr/close */
void *param;
- /** the filename / description */
+ /**< the filename / description */
const char *name;
- /** current line number, starting at 1 */
+ /**< current line number, starting at 1 */
unsigned line_number;
};
@@ -284,9 +280,13 @@ struct cmd_parms_struct {
void *info;
/** Which allow-override bits are set */
int override;
- /** Which methods are ed */
- int limited;
+ /** Which allow-override-opts bits are set */
+ int override_opts;
+ /** Which methods are <Limit>ed */
+ apr_int64_t limited;
+ /** methods which are limited */
apr_array_header_t *limited_xmethods;
+ /** methods which are xlimited */
ap_method_list_t *xlimited;
/** Config file structure. */
@@ -296,16 +296,16 @@ struct cmd_parms_struct {
/** Pool to allocate new storage in */
apr_pool_t *pool;
- /** Pool for scratch memory; persists during configuration, but
+ /** Pool for scratch memory; persists during configuration, but
* wiped before the first request is served... */
apr_pool_t *temp_pool;
/** Server_rec being configured for */
server_rec *server;
- /** If configuring for a directory, pathname of that directory.
- * NOPE! That's what it meant previous to the existance of ,
- * and regex matching. Now the only usefulness that can be
- * derived from this field is whether a command is being called in a
- * server context (path == NULL) or being called in a dir context
+ /** If configuring for a directory, pathname of that directory.
+ * NOPE! That's what it meant previous to the existence of <Files>,
+ * <Location> and regex matching. Now the only usefulness that can be
+ * derived from this field is whether a command is being called in a
+ * server context (path == NULL) or being called in a dir context
* (path != NULL). */
char *path;
/** configuration command */
@@ -315,20 +315,21 @@ struct cmd_parms_struct {
struct ap_conf_vector_t *context;
/** directive with syntax error */
const ap_directive_t *err_directive;
+
};
-typedef struct module_struct module;
/**
* Module structures. Just about everything is dispatched through
* these, directly or indirectly (through the command and handler
* tables).
*/
+typedef struct module_struct module;
struct module_struct {
- /** API version, *not* module version; check that module is
+ /** API version, *not* module version; check that module is
* compatible with this version of the server.
*/
int version;
- /** API minor version. Provides API feature milestones. Not checked
+ /** API minor version. Provides API feature milestones. Not checked
* during module init */
int minor_version;
/** Index to this modules structures in config vectors. */
@@ -340,17 +341,17 @@ struct module_struct {
void *dynamic_load_handle;
/** A pointer to the next module in the list
- * @defvar module_struct *next */
+ * @var module_struct *next
+ */
struct module_struct *next;
- /** Magic Cookie to identify a module structure; It's mainly
+ /** Magic Cookie to identify a module structure; It's mainly
* important for the DSO facility (see also mod_so). */
unsigned long magic;
/** Function to allow MPMs to re-write command line arguments. This
* hook is only available to MPMs.
* @param The process that the server is running in.
- * @deffunc void rewrite_args(process_rec *process);
*/
void (*rewrite_args) (process_rec *process);
/** Function to allow all modules to create per directory configuration
@@ -358,7 +359,6 @@ struct module_struct {
* @param p The pool to use for all allocations.
* @param dir The directory currently being processed.
* @return The per-directory structure created
- * @deffunc void *create_dir_config(apr_pool_t *p, char *dir)
*/
void *(*create_dir_config) (apr_pool_t *p, char *dir);
/** Function to allow all modules to merge the per directory configuration
@@ -367,7 +367,6 @@ struct module_struct {
* @param base_conf The directory structure created for the parent directory.
* @param new_conf The directory structure currently being processed.
* @return The new per-directory structure created
- * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
*/
void *(*merge_dir_config) (apr_pool_t *p, void *base_conf, void *new_conf);
/** Function to allow all modules to create per server configuration
@@ -375,7 +374,6 @@ struct module_struct {
* @param p The pool to use for all allocations.
* @param s The server currently being processed.
* @return The per-server structure created
- * @deffunc void *create_server_config(apr_pool_t *p, server_rec *dir)
*/
void *(*create_server_config) (apr_pool_t *p, server_rec *s);
/** Function to allow all modules to merge the per server configuration
@@ -384,9 +382,9 @@ struct module_struct {
* @param base_conf The directory structure created for the parent directory.
* @param new_conf The directory structure currently being processed.
* @return The new per-directory structure created
- * @deffunc void *merge_dir_config(apr_pool_t *p, void *base_conf, void *new_conf)
*/
- void *(*merge_server_config) (apr_pool_t *p, void *base_conf, void *new_conf);
+ void *(*merge_server_config) (apr_pool_t *p, void *base_conf,
+ void *new_conf);
/** A command_rec table that describes all of the directives this module
* defines. */
@@ -397,12 +395,42 @@ struct module_struct {
* register an interest in a specific step in processing the current
* request.
* @param p the pool to use for all allocations
- * @deffunc void register_hooks(void)
*/
void (*register_hooks) (apr_pool_t *p);
};
-/* Initializer for the first few module slots, which are only
+/**
+ * The APLOG_USE_MODULE macro is used choose which module a file belongs to.
+ * This is necessary to allow per-module loglevel configuration.
+ *
+ * APLOG_USE_MODULE indirectly sets APLOG_MODULE_INDEX and APLOG_MARK.
+ *
+ * If a module should be backward compatible with versions before 2.3.6,
+ * APLOG_USE_MODULE needs to be enclosed in a ifdef APLOG_USE_MODULE block.
+ *
+ * @param foo name of the module symbol of the current module, without the
+ * trailing "_module" part
+ * @see APLOG_MARK
+ */
+#define APLOG_USE_MODULE(foo) \
+ extern module AP_MODULE_DECLARE_DATA foo##_module; \
+ static int * const aplog_module_index = &(foo##_module.module_index)
+
+/**
+ * AP_DECLARE_MODULE is a convenience macro that combines a call of
+ * APLOG_USE_MODULE with the definition of the module symbol.
+ *
+ * If a module should be backward compatible with versions before 2.3.6,
+ * APLOG_USE_MODULE should be used explicitly instead of AP_DECLARE_MODULE.
+ */
+#define AP_DECLARE_MODULE(foo) \
+ APLOG_USE_MODULE(foo); \
+ module AP_MODULE_DECLARE_DATA foo##_module
+
+/**
+ * @defgroup ModuleInit Module structure initializers
+ *
+ * Initializer for the first few module slots, which are only
* really set up once we start running. Note that the first two slots
* provide a version check; this should allow us to deal with changes to
* the API. The major number should reflect changes to the API handler table
@@ -410,41 +438,45 @@ struct module_struct {
* additions of functionality to the existing API. (the server can detect
* an old-format module, and either handle it back-compatibly, or at least
* signal an error). See src/include/ap_mmn.h for MMN version history.
+ * @{
*/
-#define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
+/** The one used in Apache 1.3, which will deliberately cause an error */
+#define STANDARD_MODULE_STUFF this_module_needs_to_be_ported_to_apache_2_0
-#define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
- MODULE_MAGIC_NUMBER_MINOR, \
- -1, \
- __FILE__, \
- NULL, \
- NULL, \
- MODULE_MAGIC_COOKIE, \
+/** Use this in all standard modules */
+#define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
+ MODULE_MAGIC_NUMBER_MINOR, \
+ -1, \
+ __FILE__, \
+ NULL, \
+ NULL, \
+ MODULE_MAGIC_COOKIE, \
NULL /* rewrite args spot */
-#define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
- MODULE_MAGIC_NUMBER_MINOR, \
- -1, \
- __FILE__, \
- NULL, \
- NULL, \
- MODULE_MAGIC_COOKIE
+/** Use this only in MPMs */
+#define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
+ MODULE_MAGIC_NUMBER_MINOR, \
+ -1, \
+ __FILE__, \
+ NULL, \
+ NULL, \
+ MODULE_MAGIC_COOKIE
+/** @} */
/* CONFIGURATION VECTOR FUNCTIONS */
+/** configuration vector structure */
typedef struct ap_conf_vector_t ap_conf_vector_t;
-#ifdef AP_DEBUG
/**
* Generic accessors for other modules to get at their own module-specific
* data
- * @param conf_vector The vector in which the modules configuration is stored.
+ * @param cv The vector in which the modules configuration is stored.
* usually r->per_dir_config or s->module_config
* @param m The module to get the data for.
* @return The module-specific data
- * @deffunc void *ap_get_module_config(const ap_conf_vector_t *cv, module *m)
*/
AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
const module *m);
@@ -452,35 +484,122 @@ AP_DECLARE(void *) ap_get_module_config(const ap_conf_vector_t *cv,
/**
* Generic accessors for other modules to set at their own module-specific
* data
- * @param conf_vector The vector in which the modules configuration is stored.
+ * @param cv The vector in which the modules configuration is stored.
* usually r->per_dir_config or s->module_config
* @param m The module to set the data for.
* @param val The module-specific data to set
- * @deffunc void ap_set_module_config(ap_conf_vector_t *cv, const module *m, void *val)
*/
AP_DECLARE(void) ap_set_module_config(ap_conf_vector_t *cv, const module *m,
void *val);
-#else /* AP_DEBUG */
+#if !defined(AP_DEBUG)
-#define ap_get_module_config(v,m) \
+#define ap_get_module_config(v,m) \
(((void **)(v))[(m)->module_index])
-#define ap_set_module_config(v,m,val) \
+#define ap_set_module_config(v,m,val) \
((((void **)(v))[(m)->module_index]) = (val))
#endif /* AP_DEBUG */
+/**
+ * Generic accessor for modules to get the module-specific loglevel
+ * @param s The server from which to get the loglevel.
+ * @param index The module_index of the module to get the loglevel for.
+ * @return The module-specific loglevel
+ */
+AP_DECLARE(int) ap_get_server_module_loglevel(const server_rec *s, int index);
+
+/**
+ * Generic accessor for modules the module-specific loglevel
+ * @param c The connection from which to get the loglevel.
+ * @param index The module_index of the module to get the loglevel for.
+ * @return The module-specific loglevel
+ */
+AP_DECLARE(int) ap_get_conn_module_loglevel(const conn_rec *c, int index);
+
+/**
+ * Generic accessor for modules the module-specific loglevel
+ * @param c The connection from which to get the loglevel.
+ * @param s The server from which to get the loglevel if c does not have a
+ * specific loglevel configuration.
+ * @param index The module_index of the module to get the loglevel for.
+ * @return The module-specific loglevel
+ */
+AP_DECLARE(int) ap_get_conn_server_module_loglevel(const conn_rec *c,
+ const server_rec *s,
+ int index);
+
+/**
+ * Generic accessor for modules to get the module-specific loglevel
+ * @param r The request from which to get the loglevel.
+ * @param index The module_index of the module to get the loglevel for.
+ * @return The module-specific loglevel
+ */
+AP_DECLARE(int) ap_get_request_module_loglevel(const request_rec *r, int index);
+
+/**
+ * Accessor to set module-specific loglevel
+ * @param p A pool
+ * @param l The ap_logconf struct to modify.
+ * @param index The module_index of the module to set the loglevel for.
+ * @param level The new log level
+ */
+AP_DECLARE(void) ap_set_module_loglevel(apr_pool_t *p, struct ap_logconf *l,
+ int index, int level);
+
+#if !defined(AP_DEBUG)
+
+#define ap_get_conn_logconf(c) \
+ ((c)->log ? (c)->log : \
+ &(c)->base_server->log)
+
+#define ap_get_conn_server_logconf(c,s) \
+ ( ( (c)->log != &(c)->base_server->log && (c)->log != NULL ) ? \
+ (c)->log : \
+ &(s)->log )
+
+#define ap_get_request_logconf(r) \
+ ((r)->log ? (r)->log : \
+ (r)->connection->log ? (r)->connection->log : \
+ &(r)->server->log)
+
+#define ap_get_module_loglevel(l,i) \
+ (((i) < 0 || (l)->module_levels == NULL || (l)->module_levels[i] < 0) ? \
+ (l)->level : \
+ (l)->module_levels[i])
+
+#define ap_get_server_module_loglevel(s,i) \
+ (ap_get_module_loglevel(&(s)->log,i))
+
+#define ap_get_conn_module_loglevel(c,i) \
+ (ap_get_module_loglevel(ap_get_conn_logconf(c),i))
+
+#define ap_get_conn_server_module_loglevel(c,s,i) \
+ (ap_get_module_loglevel(ap_get_conn_server_logconf(c,s),i))
+
+#define ap_get_request_module_loglevel(r,i) \
+ (ap_get_module_loglevel(ap_get_request_logconf(r),i))
+
+#endif /* AP_DEBUG */
+
+/**
+ * Set all module-specific loglevels to val
+ * @param l The log config for which to set the loglevels.
+ * @param val the value to set all loglevels to
+ */
+AP_DECLARE(void) ap_reset_module_loglevels(struct ap_logconf *l, int val);
+
/**
* Generic command handling function for strings
* @param cmd The command parameters for this directive
* @param struct_ptr pointer into a given type
* @param arg The argument to the directive
* @return An error string or NULL on success
- * @deffunc const char *ap_set_string_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
-AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_ptr,
- const char *arg);
+AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd,
+ void *struct_ptr,
+ const char *arg);
/**
* Generic command handling function for integers
@@ -488,22 +607,28 @@ AP_DECLARE_NONSTD(const char *) ap_set_string_slot(cmd_parms *cmd, void *struct_
* @param struct_ptr pointer into a given type
* @param arg The argument to the directive
* @return An error string or NULL on success
- * @deffunc const char *ap_set_int_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
-AP_DECLARE_NONSTD(const char *) ap_set_int_slot(cmd_parms *cmd,
+AP_DECLARE_NONSTD(const char *) ap_set_int_slot(cmd_parms *cmd,
void *struct_ptr,
const char *arg);
+/**
+ * Parsing function for log level
+ * @param str The string to parse
+ * @param val The parsed log level
+ * @return An error string or NULL on success
+ */
+AP_DECLARE(const char *) ap_parse_log_level(const char *str, int *val);
+
/**
* Return true if the specified method is limited by being listed in
- * a container, or by *not* being listed in a
+ * a <Limit> container, or by *not* being listed in a <LimitExcept>
* container.
*
* @param method Pointer to a string specifying the method to check.
* @param cmd Pointer to the cmd_parms structure passed to the
* directive handler.
* @return 0 if the method is not limited in the current scope
- * @deffunc ap_method_is_limited(cmd_parms *cmd, const char *method)
*/
AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
@@ -514,38 +639,62 @@ AP_DECLARE(int) ap_method_is_limited(cmd_parms *cmd, const char *method);
* @param struct_ptr pointer into a given type
* @param arg The argument to the directive
* @return An error string or NULL on success
- * @deffunc const char *ap_set_string_slot_lower(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
-AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
- void *struct_ptr, const char *arg);
+AP_DECLARE_NONSTD(const char *) ap_set_string_slot_lower(cmd_parms *cmd,
+ void *struct_ptr,
+ const char *arg);
+/**
+ * Generic command handling function for flags stored in an int
+ * @param cmd The command parameters for this directive
+ * @param struct_ptr pointer into a given type
+ * @param arg The argument to the directive (either 1 or 0)
+ * @return An error string or NULL on success
+ */
+AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd,
+ void *struct_ptr,
+ int arg);
/**
- * Generic command handling function for flags
+ * Generic command handling function for flags stored in a char
* @param cmd The command parameters for this directive
* @param struct_ptr pointer into a given type
* @param arg The argument to the directive (either 1 or 0)
* @return An error string or NULL on success
- * @deffunc const char *ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg)
*/
-AP_DECLARE_NONSTD(const char *) ap_set_flag_slot(cmd_parms *cmd, void *struct_ptr, int arg);
+AP_DECLARE_NONSTD(const char *) ap_set_flag_slot_char(cmd_parms *cmd,
+ void *struct_ptr,
+ int arg);
/**
* Generic command handling function for files
* @param cmd The command parameters for this directive
* @param struct_ptr pointer into a given type
* @param arg The argument to the directive
* @return An error string or NULL on success
- * @deffunc const char *ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg)
*/
-AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd, void *struct_ptr, const char *arg);
-
+AP_DECLARE_NONSTD(const char *) ap_set_file_slot(cmd_parms *cmd,
+ void *struct_ptr,
+ const char *arg);
/**
- * For modules which need to read config files, open logs, etc. ...
- * this returns the fname argument if it begins with '/'; otherwise
- * it relativizes it wrt server_root.
- * @param p pool to allocate data out of
+ * Generic command handling function to respond with cmd->help as an error
+ * @param cmd The command parameters for this directive
+ * @param struct_ptr pointer into a given type
+ * @param arg The argument to the directive
+ * @return The cmd->help value as the error string
+ * @note This allows simple declarations such as:
+ * @code
+ * AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
+ * "The Foo directive is no longer supported, use Bar"),
+ * @endcode
+ */
+AP_DECLARE_NONSTD(const char *) ap_set_deprecated(cmd_parms *cmd,
+ void *struct_ptr,
+ const char *arg);
+/**
+ * For modules which need to read config files, open logs, etc. this returns
+ * the canonical form of fname made absolute to ap_server_root.
+ * @param p pool to allocate data from
* @param fname The file name
- * @deffunc const char *ap_server_root_relative(apr_pool_t *p, const char *fname)
*/
-AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
+AP_DECLARE(char *) ap_server_root_relative(apr_pool_t *p, const char *fname);
/* Finally, the hook for dynamically loading modules in... */
@@ -553,9 +702,10 @@ AP_DECLARE(const char *) ap_server_root_relative(apr_pool_t *p, const char *fnam
* Add a module to the server
* @param m The module structure of the module to add
* @param p The pool of the same lifetime as the module
- * @deffunc void ap_add_module(module *m, apr_pool_t *p)
+ * @param s The module's symbol name (used for logging)
*/
-AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
+AP_DECLARE(const char *) ap_add_module(module *m, apr_pool_t *p,
+ const char *s);
/**
* Remove a module from the server. There are some caveats:
@@ -564,124 +714,126 @@ AP_DECLARE(void) ap_add_module(module *m, apr_pool_t *p);
* only ever call this function when you are invalidating almost
* all our current data. I.e. when doing a restart.
* @param m the module structure of the module to remove
- * @deffunc void ap_remove_module(module *m)
*/
AP_DECLARE(void) ap_remove_module(module *m);
/**
* Add a module to the chained modules list and the list of loaded modules
- * @param m The module structure of the module to add
+ * @param mod The module structure of the module to add
* @param p The pool with the same lifetime as the module
- * @deffunc void ap_add_loaded_module(module *m, apr_pool_t *p)
+ * @param s The module's symbol name (used for logging)
*/
-AP_DECLARE(void) ap_add_loaded_module(module *mod, apr_pool_t *p);
+AP_DECLARE(const char *) ap_add_loaded_module(module *mod, apr_pool_t *p,
+ const char *s);
/**
* Remove a module fromthe chained modules list and the list of loaded modules
- * @param m the module structure of the module to remove
- * @deffunc void ap_remove_loaded_module(module *m)
+ * @param mod the module structure of the module to remove
*/
AP_DECLARE(void) ap_remove_loaded_module(module *mod);
-/**
- * Add a module to the list of loaded module based on the name of the
- * module
- * @param name The name of the module
- * @param p The pool valid for the lifetime of the module
- * @return 1 on success, 0 on failure
- * @deffunc int ap_add_named_module(const char *name, apr_pool_t *p)
- */
-AP_DECLARE(int) ap_add_named_module(const char *name, apr_pool_t *p);
/**
* Find the name of the specified module
* @param m The module to get the name for
* @return the name of the module
- * @deffunc const char *ap_find_module_name(module *m)
*/
AP_DECLARE(const char *) ap_find_module_name(module *m);
+/**
+ * Find the short name of the module identified by the specified module index
+ * @param module_index The module index to get the name for
+ * @return the name of the module, NULL if not found
+ */
+AP_DECLARE(const char *) ap_find_module_short_name(int module_index);
/**
* Find a module based on the name of the module
* @param name the name of the module
* @return the module structure if found, NULL otherwise
- * @deffunc module *ap_find_linked_module(const char *name)
*/
AP_DECLARE(module *) ap_find_linked_module(const char *name);
/**
* Open a ap_configfile_t as apr_file_t
* @param ret_cfg open ap_configfile_t struct pointer
- * @param p The pool to allocate the structure out of
+ * @param p The pool to allocate the structure from
* @param name the name of the file to open
- * @deffunc apr_status_t ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name)
*/
-AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name);
+AP_DECLARE(apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg,
+ apr_pool_t *p, const char *name);
/**
- * Allocate a ap_configfile_t handle with user defined functions and params
- * @param p The pool to allocate out of
+ * Allocate a ap_configfile_t handle with user defined functions and params
+ * @param p The pool to allocate from
* @param descr The name of the file
* @param param The argument passed to getch/getstr/close
* @param getc_func The getch function
* @param gets_func The getstr function
* @param close_func The close function
- * @deffunc ap_configfile_t *ap_pcfg_open_custom(apr_pool_t *p, const char *descr, void *param, int(*getc_func)(void*), void *(*gets_func) (void *buf, size_t bufsiz, void *param), int(*close_func)(void *param))
*/
-AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p, const char *descr,
+AP_DECLARE(ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p,
+ const char *descr,
void *param,
- int(*getc_func)(void*),
- void *(*gets_func) (void *buf, size_t bufsiz, void *param),
- int(*close_func)(void *param));
+ apr_status_t (*getc_func) (char *ch, void *param),
+ apr_status_t (*gets_func) (void *buf, size_t bufsiz, void *param),
+ apr_status_t (*close_func) (void *param));
/**
- * Read one line from open ap_configfile_t, strip LF, increase line number
+ * Read one line from open ap_configfile_t, strip leading and trailing
+ * whitespace, increase line number
* @param buf place to store the line read
* @param bufsize size of the buffer
* @param cfp File to read from
- * @return 1 on success, 0 on failure
- * @deffunc int ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp)
+ * @return error status, APR_ENOSPC if bufsize is too small for the line
*/
-AP_DECLARE(int) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp);
+AP_DECLARE(apr_status_t) ap_cfg_getline(char *buf, size_t bufsize, ap_configfile_t *cfp);
/**
- * Read one char from open configfile_t, increase line number upon LF
+ * Read one char from open configfile_t, increase line number upon LF
+ * @param ch place to store the char read
* @param cfp The file to read from
- * @return the character read
- * @deffunc int ap_cfg_getc(ap_configfile_t *cfp)
+ * @return error status
*/
-AP_DECLARE(int) ap_cfg_getc(ap_configfile_t *cfp);
+AP_DECLARE(apr_status_t) ap_cfg_getc(char *ch, ap_configfile_t *cfp);
/**
* Detach from open ap_configfile_t, calling the close handler
* @param cfp The file to close
* @return 1 on sucess, 0 on failure
- * @deffunc int ap_cfg_closefile(ap_configfile_t *cfp)
*/
AP_DECLARE(int) ap_cfg_closefile(ap_configfile_t *cfp);
/**
- * Read all data between the current and the matching . All
- * of this data is forgotten immediately.
+ * Convert a return value from ap_cfg_getline or ap_cfg_getc to a user friendly
+ * string.
+ * @param p The pool to allocate the string from
+ * @param cfp The config file
+ * @return The error string, NULL if rc == APR_SUCCESS
+ */
+AP_DECLARE(const char *) ap_pcfg_strerror(apr_pool_t *p, ap_configfile_t *cfp,
+ apr_status_t rc);
+
+/**
+ * Read all data between the current <foo> and the matching </foo>. All
+ * of this data is forgotten immediately.
* @param cmd The cmd_parms to pass to the directives inside the container
* @param directive The directive name to read until
- * @retrn Error string on failure, NULL on success
- * @deffunc const char *ap_soak_end_container(cmd_parms *cmd, char *directive)
+ * @return Error string on failure, NULL on success
*/
AP_DECLARE(const char *) ap_soak_end_container(cmd_parms *cmd, char *directive);
/**
- * Read all data between the current and the matching and build
- * a config tree out of it
- * @param p pool to allocate out of
- * @param temp_pool Temporary pool to allocate out of
+ * Read all data between the current <foo> and the matching </foo> and build
+ * a config tree from it
+ * @param p pool to allocate from
+ * @param temp_pool Temporary pool to allocate from
* @param parms The cmd_parms to pass to all directives read
* @param current The current node in the tree
* @param curr_parent The current parent node
* @param orig_directive The directive to read until hit.
* @return Error string on failure, NULL on success
- * @deffunc char *ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool, cmd_parms *parms, ap_directive_t **current, ap_directive_t **curr_parent, char *orig_directive)
*/
-const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
- cmd_parms *parms,
- ap_directive_t **current,
- ap_directive_t **curr_parent,
- char *orig_directive);
+AP_DECLARE(const char *) ap_build_cont_config(apr_pool_t *p,
+ apr_pool_t *temp_pool,
+ cmd_parms *parms,
+ ap_directive_t **current,
+ ap_directive_t **curr_parent,
+ char *orig_directive);
/**
* Build a config tree from a config file
@@ -690,12 +842,11 @@ const char * ap_build_cont_config(apr_pool_t *p, apr_pool_t *temp_pool,
* @param temp_pool The temporary pool
* @param conftree Place to store the root node of the config tree
* @return Error string on erro, NULL otherwise
- * @deffunc const char *ap_build_config(cmd_parms *parms, apr_pool_t *conf_pool, apr_pool_t *temp_pool, ap_directive_t **conftree)
*/
AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
- apr_pool_t *conf_pool,
- apr_pool_t *temp_pool,
- ap_directive_t **conftree);
+ apr_pool_t *conf_pool,
+ apr_pool_t *temp_pool,
+ ap_directive_t **conftree);
/**
* Walk a config tree and setup the server's internal structures
@@ -703,117 +854,121 @@ AP_DECLARE(const char *) ap_build_config(cmd_parms *parms,
* @param parms The cmd_parms to pass to all functions
* @param section_vector The per-section config vector.
* @return Error string on error, NULL otherwise
- * @deffunc const char *ap_walk_config(ap_directive_t *conftree, cmd_parms *parms, ap_conf_vector_t *section_vector)
*/
AP_DECLARE(const char *) ap_walk_config(ap_directive_t *conftree,
- cmd_parms *parms,
+ cmd_parms *parms,
ap_conf_vector_t *section_vector);
/**
- * ap_check_cmd_context() definitions:
- * @param cmd The cmd_context to check
- * @param forbidden Where the command is forbidden. One of:
- *
- * NOT_IN_VIRTUALHOST
- * NOT_IN_LIMIT
- * NOT_IN_DIRECTORY
- * NOT_IN_LOCATION
- * NOT_IN_FILES
- * NOT_IN_DIR_LOC_FILE
- * GLOBAL_ONLY
- *
+ * @defgroup ap_check_cmd_context Check command context
+ * @{
+ */
+/**
+ * Check the context a command is used in.
+ * @param cmd The command to check
+ * @param forbidden Where the command is forbidden.
* @return Error string on error, NULL on success
- * @deffunc const char *ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden)
*/
-AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd, unsigned forbidden);
-
-/* ap_check_cmd_context(): Forbidden in: */
-#define NOT_IN_VIRTUALHOST 0x01 /* */
-#define NOT_IN_LIMIT 0x02 /* */
-#define NOT_IN_DIRECTORY 0x04 /* */
-#define NOT_IN_LOCATION 0x08 /* */
-#define NOT_IN_FILES 0x10 /* */
-#define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES) /* //*/
+AP_DECLARE(const char *) ap_check_cmd_context(cmd_parms *cmd,
+ unsigned forbidden);
+
+#define NOT_IN_VIRTUALHOST 0x01 /**< Forbidden in <VirtualHost> */
+#define NOT_IN_LIMIT 0x02 /**< Forbidden in <Limit> */
+#define NOT_IN_DIRECTORY 0x04 /**< Forbidden in <Directory> */
+#define NOT_IN_LOCATION 0x08 /**< Forbidden in <Location> */
+#define NOT_IN_FILES 0x10 /**< Forbidden in <Files> */
+/** Forbidden in <Directory>/<Location>/<Files>*/
+#define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES)
+/** Forbidden in <VirtualHost>/<Limit>/<Directory>/<Location>/<Files> */
#define GLOBAL_ONLY (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)
+/** @} */
-#ifdef CORE_PRIVATE
+/**
+ * @brief This structure is used to assign symbol names to module pointers
+ */
+typedef struct {
+ const char *name;
+ module *modp;
+} ap_module_symbol_t;
/**
* The topmost module in the list
- * @defvar module *ap_top_module
+ * @var module *ap_top_module
*/
AP_DECLARE_DATA extern module *ap_top_module;
/**
* Array of all statically linked modules
- * @defvar module *ap_prelinked_modules[]
+ * @var module *ap_prelinked_modules[]
*/
AP_DECLARE_DATA extern module *ap_prelinked_modules[];
+/**
+ * Array of all statically linked modulenames (symbols)
+ * @var ap_module_symbol_t ap_prelinked_module_symbols[]
+ */
+AP_DECLARE_DATA extern ap_module_symbol_t ap_prelinked_module_symbols[];
/**
* Array of all preloaded modules
- * @defvar module *ap_preloaded_modules[]
+ * @var module *ap_preloaded_modules[]
*/
AP_DECLARE_DATA extern module *ap_preloaded_modules[];
/**
* Array of all loaded modules
- * @defvar module **ap_loaded_modules
+ * @var module **ap_loaded_modules
*/
AP_DECLARE_DATA extern module **ap_loaded_modules;
/* For mod_so.c... */
/** Run a single module's two create_config hooks
- * @param p the pool to allocate out of
+ * @param p the pool to allocate from
* @param s The server to configure for.
* @param m The module to configure
*/
-AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
+AP_DECLARE(void) ap_single_module_configure(apr_pool_t *p, server_rec *s,
module *m);
/* For http_main.c... */
/**
* Add all of the prelinked modules into the loaded module list
* @param process The process that is currently running the server
- * @deffunc void ap_setup_prelinked_modules(process_rec *process)
*/
-AP_DECLARE(void) ap_setup_prelinked_modules(process_rec *process);
+AP_DECLARE(const char *) ap_setup_prelinked_modules(process_rec *process);
/**
- *Show the preloaded configuration directives, the help string explaining
+ * Show the preloaded configuration directives, the help string explaining
* the directive arguments, in what module they are handled, and in
* what parts of the configuration they are allowed. Used for httpd -h.
- * @deffunc void ap_show_directives(void)
*/
AP_DECLARE(void) ap_show_directives(void);
-/**
- * Show the preloaded module names. Used for httpd -l.
- * @deffunc void ap_show_modules(void)
+/**
+ * Show the preloaded module names. Used for httpd -l.
*/
AP_DECLARE(void) ap_show_modules(void);
-/**
+/**
* Show the MPM name. Used in reporting modules such as mod_info to
* provide extra information to the user
- * @deffunc const char *ap_show_mpm(void)
*/
AP_DECLARE(const char *) ap_show_mpm(void);
/**
* Read all config files and setup the server
* @param process The process running the server
- * @param temp_pool A pool to allocate temporary data out of.
+ * @param temp_pool A pool to allocate temporary data from.
* @param config_name The name of the config file
* @param conftree Place to store the root of the config tree
* @return The setup server_rec list.
- * @deffunc server_rec *ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
*/
-AP_DECLARE(server_rec *) ap_read_config(process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
+AP_DECLARE(server_rec *) ap_read_config(process_rec *process,
+ apr_pool_t *temp_pool,
+ const char *config_name,
+ ap_directive_t **conftree);
/**
* Run all rewrite args hooks for loaded modules
* @param process The process currently running the server
- * @deffunc void ap_run_rewrite_args(process_rec *process)
*/
AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
@@ -821,32 +976,47 @@ AP_DECLARE(void) ap_run_rewrite_args(process_rec *process);
* Run the register hooks function for a specified module
* @param m The module to run the register hooks function fo
* @param p The pool valid for the lifetime of the module
- * @deffunc void ap_register_hooks(module *m, apr_pool_t *p)
*/
AP_DECLARE(void) ap_register_hooks(module *m, apr_pool_t *p);
/**
* Setup all virtual hosts
- * @param p The pool to allocate out of
+ * @param p The pool to allocate from
* @param main_server The head of the server_rec list
- * @deffunc void ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server)
*/
-AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p, server_rec *main_server);
+AP_DECLARE(void) ap_fixup_virtual_hosts(apr_pool_t *p,
+ server_rec *main_server);
+
+/**
+ * Reserve some modules slots for modules loaded by other means than
+ * EXEC_ON_READ directives.
+ * Relevant modules should call this in the pre_config stage.
+ * @param count The number of slots to reserve.
+ */
+AP_DECLARE(void) ap_reserve_module_slots(int count);
+
+/**
+ * Reserve some modules slots for modules loaded by a specific
+ * non-EXEC_ON_READ config directive.
+ * This counts how often the given directive is used in the config and calls
+ * ap_reserve_module_slots() accordingly.
+ * @param directive The name of the directive
+ */
+AP_DECLARE(void) ap_reserve_module_slots_directive(const char *directive);
/* For http_request.c... */
/**
* Setup the config vector for a request_rec
- * @param p The pool to allocate the config vector out of
+ * @param p The pool to allocate the config vector from
* @return The config vector
*/
-ap_conf_vector_t *ap_create_request_config(apr_pool_t *p);
+AP_DECLARE(ap_conf_vector_t*) ap_create_request_config(apr_pool_t *p);
/**
* Setup the config vector for per dir module configs
- * @param p The pool to allocate the config vector out of
+ * @param p The pool to allocate the config vector from
* @return The config vector
- * @deffunc ap_conf_vector_t *ap_create_per_dir_config(apr_pool_t *p)
*/
AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
@@ -856,54 +1026,98 @@ AP_CORE_DECLARE(ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p);
* @param base The base directory config structure
* @param new_conf The new directory config structure
*/
-ap_conf_vector_t *ap_merge_per_dir_configs(apr_pool_t *p,
+AP_CORE_DECLARE(ap_conf_vector_t*) ap_merge_per_dir_configs(apr_pool_t *p,
ap_conf_vector_t *base,
ap_conf_vector_t *new_conf);
+/**
+ * Allocate new ap_logconf and make (deep) copy of old ap_logconf
+ * @param p The pool to alloc from
+ * @param old The ap_logconf to copy (may be NULL)
+ * @return The new ap_logconf struct
+ */
+AP_DECLARE(struct ap_logconf *) ap_new_log_config(apr_pool_t *p,
+ const struct ap_logconf *old);
+
+/**
+ * Merge old ap_logconf into new ap_logconf.
+ * old and new must have the same life time.
+ * @param old_conf The ap_logconf to merge from
+ * @param new_conf The ap_logconf to merge into
+ */
+AP_DECLARE(void) ap_merge_log_config(const struct ap_logconf *old_conf,
+ struct ap_logconf *new_conf);
+
/* For http_connection.c... */
/**
* Setup the config vector for a connection_rec
- * @param p The pool to allocate the config vector out of
+ * @param p The pool to allocate the config vector from
* @return The config vector
*/
-ap_conf_vector_t *ap_create_conn_config(apr_pool_t *p);
+AP_CORE_DECLARE(ap_conf_vector_t*) ap_create_conn_config(apr_pool_t *p);
-/* For http_core.c... ( command and virtual hosts) */
+/* For http_core.c... (<Directory> command and virtual hosts) */
/**
* parse an htaccess file
- * @param resulting htaccess_result
+ * @param result htaccess_result
* @param r The request currently being served
* @param override Which overrides are active
+ * @param override_opts Which allow-override-opts bits are set
* @param path The path to the htaccess file
* @param access_name The list of possible names for .htaccess files
* int The status of the current request
*/
-int ap_parse_htaccess(ap_conf_vector_t **result, request_rec *r, int override,
- const char *path, const char *access_name);
+AP_CORE_DECLARE(int) ap_parse_htaccess(ap_conf_vector_t **result,
+ request_rec *r,
+ int override,
+ int override_opts,
+ const char *path,
+ const char *access_name);
/**
* Setup a virtual host
- * @param p The pool to allocate all memory out of
+ * @param p The pool to allocate all memory from
* @param hostname The hostname of the virtual hsot
* @param main_server The main server for this Apache configuration
* @param ps Place to store the new server_rec
* return Error string on error, NULL on success
- * @deffunc const char *ap_init_virtual_host(apr_pool_t *p, const char *hostname, server_rec *main_server, server_rec **ps)
*/
-AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p, const char *hostname,
- server_rec *main_server, server_rec **);
+AP_CORE_DECLARE(const char *) ap_init_virtual_host(apr_pool_t *p,
+ const char *hostname,
+ server_rec *main_server,
+ server_rec **ps);
/**
- * Process the config file for Apache
+ * Process a config file for Apache
* @param s The server rec to use for the command parms
* @param fname The name of the config file
* @param conftree The root node of the created config tree
* @param p Pool for general allocation
- * @param ptem Pool for temporary allocation
+ * @param ptemp Pool for temporary allocation
*/
-void ap_process_resource_config(server_rec *s, const char *fname,
- ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp);
+AP_DECLARE(const char *) ap_process_resource_config(server_rec *s,
+ const char *fname,
+ ap_directive_t **conftree,
+ apr_pool_t *p,
+ apr_pool_t *ptemp);
+
+/**
+ * Process all matching files as Apache configs
+ * @param s The server rec to use for the command parms
+ * @param fname The filename pattern of the config file
+ * @param conftree The root node of the created config tree
+ * @param p Pool for general allocation
+ * @param ptemp Pool for temporary allocation
+ * @param optional Whether a no-match wildcard is allowed
+ * @see apr_fnmatch for pattern handling
+ */
+AP_DECLARE(const char *) ap_process_fnmatch_configs(server_rec *s,
+ const char *fname,
+ ap_directive_t **conftree,
+ apr_pool_t *p,
+ apr_pool_t *ptemp,
+ int optional);
/**
* Process all directives in the config tree
@@ -911,9 +1125,27 @@ void ap_process_resource_config(server_rec *s, const char *fname,
* @param conftree The config tree to process
* @param p The pool for general allocation
* @param ptemp The pool for temporary allocations
+ * @return OK if no problems
*/
-AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
- apr_pool_t *p, apr_pool_t *ptemp);
+AP_DECLARE(int) ap_process_config_tree(server_rec *s,
+ ap_directive_t *conftree,
+ apr_pool_t *p,
+ apr_pool_t *ptemp);
+
+/**
+ * Store data which will be retained across unload/load of modules
+ * @param key The unique key associated with this module's retained data
+ * @param size in bytes of the retained data (to be allocated)
+ * @return Address of new retained data structure, initially cleared
+ */
+AP_DECLARE(void *) ap_retained_data_create(const char *key, apr_size_t size);
+
+/**
+ * Retrieve data which was stored by ap_retained_data_create()
+ * @param key The unique key associated with this module's retained data
+ * @return Address of previously retained data structure, or NULL if not yet saved
+ */
+AP_DECLARE(void *) ap_retained_data_get(const char *key);
/* Module-method dispatchers, also for http_request.c */
/**
@@ -922,7 +1154,7 @@ AP_DECLARE(void) ap_process_config_tree(server_rec *s, ap_directive_t *conftree,
* @param r The current request
* @return The status of the current request
*/
-int ap_invoke_handler(request_rec *);
+AP_CORE_DECLARE(int) ap_invoke_handler(request_rec *r);
/* for mod_perl */
@@ -931,18 +1163,18 @@ int ap_invoke_handler(request_rec *);
* @param name The directive to search for
* @param cmds The table to search
* @return The directive definition of the specified directive
- * @deffunc const command_rec *ap_find_command(const char *name, const command_rec *cmds)
*/
-AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name, const command_rec *cmds);
+AP_CORE_DECLARE(const command_rec *) ap_find_command(const char *name,
+ const command_rec *cmds);
/**
* Find a given directive in a list module
* @param cmd_name The directive to search for
* @param mod The module list to search
* @return The directive definition of the specified directive
- * @deffunc const command_rec *ap_find_command_in_modules(const char *cmd_name,module **mod)
*/
-AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name, module **mod);
+AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_name,
+ module **mod);
/**
* Ask a module to create per-server and per-section (dir/loc/file) configs
@@ -954,22 +1186,18 @@ AP_CORE_DECLARE(const command_rec *) ap_find_command_in_modules(const char *cmd_
* @param mod The module which is defining the config data.
* @param pconf A pool for all configuration allocations.
* @return The (new) per-section config data.
- * @deffunc void *ap_set_config_vectors(server_rec *server, ap_conf_vector_t *section_vector, const char *dir, module *mod, apr_pool_t *pconf)
*/
AP_CORE_DECLARE(void *) ap_set_config_vectors(server_rec *server,
ap_conf_vector_t *section_vector,
const char *section,
module *mod, apr_pool_t *pconf);
-#endif
-
/* Hooks */
/**
* Run the header parser functions for each module
* @param r The current request
* @return OK or DECLINED
- * @deffunc int ap_run_header_parser(request_rec *r)
*/
AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
@@ -978,9 +1206,29 @@ AP_DECLARE_HOOK(int,header_parser,(request_rec *r))
* @param pconf The config pool
* @param plog The logging streams pool
* @param ptemp The temporary pool
- * @deffunc void ap_run_pre_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp)
+ * @return OK or DECLINED on success anything else is a error
+ */
+AP_DECLARE_HOOK(int,pre_config,(apr_pool_t *pconf,apr_pool_t *plog,
+ apr_pool_t *ptemp))
+
+/**
+ * Run the check_config function for each module
+ * @param pconf The config pool
+ * @param plog The logging streams pool
+ * @param ptemp The temporary pool
+ * @param s the server to operate upon
+ * @return OK or DECLINED on success anything else is a error
*/
-AP_DECLARE_HOOK(void,pre_config,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp))
+AP_DECLARE_HOOK(int,check_config,(apr_pool_t *pconf, apr_pool_t *plog,
+ apr_pool_t *ptemp, server_rec *s))
+
+/**
+ * Run the test_config function for each module; this hook is run
+ * only if the server was invoked to test the configuration syntax.
+ * @param pconf The config pool
+ * @param s The list of server_recs
+ */
+AP_DECLARE_HOOK(void,test_config,(apr_pool_t *pconf, server_rec *s))
/**
* Run the post_config function for each module
@@ -988,9 +1236,10 @@ AP_DECLARE_HOOK(void,pre_config,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *
* @param plog The logging streams pool
* @param ptemp The temporary pool
* @param s The list of server_recs
- * @deffunc void ap_run_post_config(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
+ * @return OK or DECLINED on success anything else is a error
*/
-AP_DECLARE_HOOK(void,post_config,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
+AP_DECLARE_HOOK(int,post_config,(apr_pool_t *pconf,apr_pool_t *plog,
+ apr_pool_t *ptemp,server_rec *s))
/**
* Run the open_logs functions for each module
@@ -998,23 +1247,22 @@ AP_DECLARE_HOOK(void,post_config,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t
* @param plog The logging streams pool
* @param ptemp The temporary pool
* @param s The list of server_recs
- * @deffunc void ap_run_open_logs(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp, server_rec *s)
+ * @return OK or DECLINED on success anything else is a error
*/
-AP_DECLARE_HOOK(void,open_logs,(apr_pool_t *pconf,apr_pool_t *plog,apr_pool_t *ptemp,server_rec *s))
+AP_DECLARE_HOOK(int,open_logs,(apr_pool_t *pconf,apr_pool_t *plog,
+ apr_pool_t *ptemp,server_rec *s))
/**
* Run the child_init functions for each module
* @param pchild The child pool
- * @param s The list of server_recs in this server
- * @deffunc void ap_run_child_init(apr_pool_t *pchild, server_rec *s)
+ * @param s The list of server_recs in this server
*/
AP_DECLARE_HOOK(void,child_init,(apr_pool_t *pchild, server_rec *s))
/**
* Run the handler functions for each module
* @param r The request_rec
- * @tip non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
- * @deffunc void ap_run_handler(request_rec *r)
+ * @remark non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST
*/
AP_DECLARE_HOOK(int,handler,(request_rec *r))
@@ -1022,22 +1270,33 @@ AP_DECLARE_HOOK(int,handler,(request_rec *r))
* Run the quick handler functions for each module. The quick_handler
* is run before any other requests hooks are called (location_walk,
* directory_walk, access checking, et. al.). This hook was added
- * to provide a quick way to serve content out of a URI keyed cache.
+ * to provide a quick way to serve content from a URI keyed cache.
+ *
* @param r The request_rec
- * @deffunc void ap_run_quick_handler(request_rec *r)
+ * @param lookup_uri Controls whether the caller actually wants content or not.
+ * lookup is set when the quick_handler is called out of
+ * ap_sub_req_lookup_uri()
*/
-AP_DECLARE_HOOK(int,quick_handler,(request_rec *r))
+AP_DECLARE_HOOK(int,quick_handler,(request_rec *r, int lookup_uri))
/**
* Retrieve the optional functions for each module.
* This is run immediately before the server starts. Optional functions should
* be registered during the hook registration phase.
- * @deffunc void ap_run_optional_fn_retrieve(void)
*/
AP_DECLARE_HOOK(void,optional_fn_retrieve,(void))
+/**
+ * A generic pool cleanup that will reset a pointer to NULL. For use with
+ * apr_pool_cleanup_register.
+ * @param data The address of the pointer
+ * @return APR_SUCCESS
+ */
+AP_DECLARE_NONSTD(apr_status_t) ap_pool_cleanup_set_null(void *data);
+
#ifdef __cplusplus
}
#endif
-#endif /* !APACHE_HTTP_CONFIG_H */
+#endif /* !APACHE_HTTP_CONFIG_H */
+/** @} */