http_config.h revision 1df03415662628022001b7433f4bcbd3b74ebc65
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000 The Apache Software Foundation. All rights
* reserved.
*
* 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
* 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
*
* Portions of this software are based upon public domain software
* originally written at the National Center for Supercomputing Applications,
* University of Illinois, Urbana-Champaign.
*/
#ifndef APACHE_HTTP_CONFIG_H
#define APACHE_HTTP_CONFIG_H
#include "ap_hooks.h"
#include "util_cfgtree.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @package Apache Configuration
*/
/*
* The central data structures around here...
*/
/* Command dispatch structures... */
/**
* How the directives arguments should be parsed.
* @tip 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
* <PRE>
* 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
* </PRE>
* @defvar enum cmd_how
*/
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. </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 */
};
typedef struct cmd_parms_struct cmd_parms;
#ifdef AP_DEBUG
typedef union {
const char *args);
const char *w2);
} cmd_func;
#else
typedef const char *(*cmd_func) ();
# define AP_NO_ARGS func
# define AP_RAW_ARGS func
#endif
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.
*/
struct command_struct {
/** Name of this command */
const char *name;
/** The function to be called when this directive is parsed */
/** Extra data, for functions which implement multiple commands... */
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*/
/** 'usage' message, in case of syntax errors */
const char *errmsg;
};
/* 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 <Directory> or <Location>
* (req_override & ACCESS_CONF) => *.conf inside <Directory> or <Location>
* (req_override & OR_AUTHCFG) => *.conf inside <Directory> or <Location>
* and .htaccess when AllowOverride AuthConfig
* (req_override & OR_LIMIT) => *.conf inside <Directory> or <Location>
* 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
/**
* 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 configfile_t configfile_t;
/** Common structure for reading of config files / passwd files etc. */
struct configfile_t {
/** a getc()-like function
* @deffunc int getch(void *param) */
/** a fgets()-like function
* @deffunc void *getstr(void *buf, size_t bufsize, void *param)*/
/** a close hander function
* @deffunc int close(void *param)*/
void *param;
/** the filename / description */
const char *name;
/** current line number, starting at 1 */
unsigned line_number;
};
/**
* 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*...
*/
struct cmd_parms_struct
{
/** Argument to command from cmd_table */
void *info;
/** Which allow-override bits are set */
int override;
/** Which methods are <Limit>ed */
int limited;
/** Config file structure. */
/** the directive specifying this command */
/** Pool to allocate new storage in */
/** Pool for scratch memory; persists during configuration, but
* wiped before the first request is served... */
/** Server_rec being configured for */
/** If configuring for a directory, pathname of that directory.
* NOPE! That's what it meant previous to the existance 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 */
const command_rec *cmd;
/** per_dir_config vector passed to handle_command */
void *context;
/** directive with syntax error */
const ap_directive_t *err_directive;
};
typedef struct handler_rec handler_rec;
/** This structure records the existence of handlers in a module... */
struct handler_rec {
/** The type of content this handler function will handle.
* MUST be all lower case
*/
const char *content_type;
/** The function to call when this context-type is requested.
* @deffunc int handler(request_rec *)
*/
int (*handler) (request_rec *);
};
typedef struct module_struct module;
/**
* Module structures. Just about everything is dispatched through
* these, directly or indirectly (through the command and handler
* tables).
*/
struct module_struct {
/** 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
* during module init */
int minor_version;
/** Index to this modules structures in config vectors. */
int module_index;
/** The name of the module's C file */
const char *name;
/** The handle for the DSO. Internal use only */
void *dynamic_load_handle;
/** A pointer to the next module in the list;
struct module_struct *next;
/** 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);
*/
/** Function to allow all modules to create per directory configuration
* structures.
* @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(ap_pool_t *p, char *dir)
*/
/** Function to allow all modules to merge the per directory configuration
* structures for two directories.
* @param p The pool to use for all allocations.
* @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(ap_pool_t *p, void *base_conf, void *new_conf)
*/
/** Function to allow all modules to create per server configuration
* structures.
* @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(ap_pool_t *p, server_rec *dir)
*/
/** Function to allow all modules to merge the per server configuration
* structures for two servers.
* @param p The pool to use for all allocations.
* @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(ap_pool_t *p, void *base_conf, void *new_conf)
*/
/** A command_rec table that describes all of the directives this module
* defines. */
const command_rec *cmds;
/** A handler_rec table that describes all of the mime-types this module
* will server responses for. */
const handler_rec *handlers;
/** A hook to allow modules to hook other points in the request processing.
* In this function, modules should call the ap_hook_*() functions to
* register an interest in a specific step in processing the current
* request.
* @deffunc void register_hooks(void)
*/
void (*register_hooks) (void);
};
/* 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
* itself or removal of functionality. The minor number should reflect
* additions of functionality to the existing API. (the server can detect
* an old-format module, and either handle it back-compatibly, or at least
*/
#define STANDARD20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
-1, \
__FILE__, \
NULL, \
NULL, \
NULL /* rewrite args spot */
#define MPM20_MODULE_STUFF MODULE_MAGIC_NUMBER_MAJOR, \
-1, \
__FILE__, \
NULL, \
NULL, \
/* Generic accessors for other modules to get at their own module-specific
* data
*/
#define ap_get_module_config(v,m) \
(((void **)(v))[(m)->module_index])
#define ap_set_module_config(v,m,val) \
((((void **)(v))[(m)->module_index]) = (val))
/* Generic command handling function... */
const char *);
void *, const char *);
/* 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.
*/
/* Finally, the hook for dynamically loading modules in... */
API_EXPORT(void) ap_clear_module_list(void);
/* Open a configfile_t as FILE, return open configfile_t struct pointer */
/* Allocate a configfile_t handle with user defined functions and params */
void *param,
int(*getc_func)(void*),
int(*close_func)(void *param));
/* Read one line from open configfile_t, strip LF, increase line number */
/* Read one char from open configfile_t, increase line number upon LF */
/* Detach from open configfile_t, calling the close handler */
/* for implementing subconfigs and customized config files */
char *orig_directive);
/* ap_check_cmd_context() definitions: */
/* ap_check_cmd_context(): Forbidden in: */
#define NOT_IN_DIR_LOC_FILE (NOT_IN_DIRECTORY|NOT_IN_LOCATION|NOT_IN_FILES) /* <Directory>/<Location>/<Files>*/
#ifdef CORE_PRIVATE
/* For mod_so.c... */
/* For http_main.c... */
API_EXPORT(void) ap_show_directives(void);
API_EXPORT(void) ap_show_modules(void);
API_EXPORT(server_rec*) ap_read_config(process_rec *process, ap_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree);
API_EXPORT(void) ap_pre_config_hook(ap_pool_t *pconf, ap_pool_t *plog, ap_pool_t *ptemp, server_rec *s);
API_EXPORT(void) ap_post_config_hook(ap_pool_t *pconf, ap_pool_t *plog, ap_pool_t *ptemp, server_rec *s);
/* For http_request.c... */
void *ap_create_request_config(ap_pool_t *p);
/* For http_connection.c... */
void *ap_create_conn_config(ap_pool_t *p);
/* For http_core.c... (<Directory> command and virtual hosts) */
const char *path, const char *access_name);
/* For individual MPMs... */
/* Module-method dispatchers, also for http_request.c */
int ap_translate_name(request_rec *);
int ap_invoke_handler(request_rec *);
/* for mod_perl */
#endif
/* Hooks */
AP_DECLARE_HOOK(void,pre_config,
AP_DECLARE_HOOK(void,post_config,
AP_DECLARE_HOOK(void,open_logs,
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_HTTP_CONFIG_H */