Configuration

Modules
	Allowed locations for configuration directives.
	Module structure initializers
	Check command context
	Config Tree Package

Classes
struct	command_struct
struct	ap_configfile_t
struct	cmd_parms_struct
struct	module_struct
struct	ap_module_symbol_t
	This structure is used to assign symbol names to module pointers. More...
struct	ap_LINK_header_parser_t
struct	ap_LINK_pre_config_t
struct	ap_LINK_check_config_t
struct	ap_LINK_test_config_t
struct	ap_LINK_post_config_t
struct	ap_LINK_open_logs_t
struct	ap_LINK_child_init_t
struct	ap_LINK_handler_t
struct	ap_LINK_quick_handler_t
struct	ap_LINK_optional_fn_retrieve_t
struct	ap_LINK_open_htaccess_t

Macros
#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
#define	AP_FLAG   func
#define	AP_INIT_NO_ARGS(directive, func, mconfig, where, help)    { 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)    { directive, func, mconfig, where, ITERATE, help }
#define	AP_INIT_TAKE2(directive, func, mconfig, where, help)    { directive, func, mconfig, where, TAKE2, help }
#define	AP_INIT_TAKE12(directive, func, mconfig, where, help)    { 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 }
#define	DECLINE_CMD   "\a\b"
#define	AP_MODULE_FLAG_NONE   (0)
#define	AP_MODULE_FLAG_ALWAYS_MERGE   (1 << 0)
#define	AP_MAYBE_UNUSED(x)   x
#define	APLOG_USE_MODULE(foo)
#define	AP_DECLARE_MODULE(foo)
#define	AP_MODULE_FLAGS_MMN_MAJOR   20120211
#define	AP_MODULE_FLAGS_MMN_MINOR   70
#define	AP_MODULE_HAS_FLAGS(m)
#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))
#define	ap_get_conn_logconf(c)
#define	ap_get_conn_server_logconf(c, s)
#define	ap_get_request_logconf(r)
#define	ap_get_module_loglevel(l, 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))

Typedefs
typedef struct cmd_parms_struct	cmd_parms
typedef const char *(*	cmd_func) ()
typedef struct command_struct	command_rec
typedef struct ap_configfile_t	ap_configfile_t
typedef struct module_struct	module
typedef struct ap_conf_vector_t	ap_conf_vector_t
typedef struct ap_LINK_header_parser_t	ap_LINK_header_parser_t
typedef struct ap_LINK_pre_config_t	ap_LINK_pre_config_t
typedef struct ap_LINK_check_config_t	ap_LINK_check_config_t
typedef struct ap_LINK_test_config_t	ap_LINK_test_config_t
typedef struct ap_LINK_post_config_t	ap_LINK_post_config_t
typedef struct ap_LINK_open_logs_t	ap_LINK_open_logs_t
typedef struct ap_LINK_child_init_t	ap_LINK_child_init_t
typedef struct ap_LINK_handler_t	ap_LINK_handler_t
typedef struct ap_LINK_quick_handler_t	ap_LINK_quick_handler_t
typedef struct ap_LINK_optional_fn_retrieve_t	ap_LINK_optional_fn_retrieve_t
typedef struct ap_LINK_open_htaccess_t	ap_LINK_open_htaccess_t

Enumerations
enum	cmd_how {   RAW_ARGS , TAKE1 , TAKE2 , ITERATE ,   ITERATE2 , FLAG , NO_ARGS , TAKE12 ,   TAKE3 , TAKE23 , TAKE123 , TAKE13 ,   TAKE_ARGV }

Functions
void *	ap_get_module_config (const ap_conf_vector_t *cv, const module *m)
void	ap_set_module_config (ap_conf_vector_t *cv, const module *m, void *val)
int	ap_get_module_flags (const module *m)
int	ap_get_server_module_loglevel (const server_rec *s, int index)
int	ap_get_conn_module_loglevel (const conn_rec *c, int index)
int	ap_get_conn_server_module_loglevel (const conn_rec *c, const server_rec *s, int index)
int	ap_get_request_module_loglevel (const request_rec *r, int index)
void	ap_set_module_loglevel (apr_pool_t *p, struct ap_logconf *l, int index, int level)
void	ap_reset_module_loglevels (struct ap_logconf *l, int val)
const char *	ap_set_string_slot (cmd_parms *cmd, void *struct_ptr, const char *arg)
const char *	ap_set_int_slot (cmd_parms *cmd, void *struct_ptr, const char *arg)
const char *	ap_parse_log_level (const char *str, int *val)
int	ap_method_is_limited (cmd_parms *cmd, const char *method)
const char *	ap_set_string_slot_lower (cmd_parms *cmd, void *struct_ptr, const char *arg)
const char *	ap_set_flag_slot (cmd_parms *cmd, void *struct_ptr, int arg)
const char *	ap_set_flag_slot_char (cmd_parms *cmd, void *struct_ptr, int arg)
const char *	ap_set_file_slot (cmd_parms *cmd, void *struct_ptr, const char *arg)
const char *	ap_set_deprecated (cmd_parms *cmd, void *struct_ptr, const char *arg)
char *	ap_server_root_relative (apr_pool_t *p, const char *fname)
char *	ap_runtime_dir_relative (apr_pool_t *p, const char *fname)
const char *	ap_add_module (module *m, apr_pool_t *p, const char *s)
void	ap_remove_module (module *m)
const char *	ap_add_loaded_module (module *mod, apr_pool_t *p, const char *s)
void	ap_remove_loaded_module (module *mod)
const char *	ap_find_module_name (module *m)
const char *	ap_find_module_short_name (int module_index)
apr_status_t	ap_pcfg_openfile (ap_configfile_t **ret_cfg, apr_pool_t *p, const char *name)
ap_configfile_t *	ap_pcfg_open_custom (apr_pool_t *p, const char *descr, void *param, apr_status_t(*getc_func)(char *ch, void *param), apr_status_t(*gets_func)(void *buf, apr_size_t bufsiz, void *param), apr_status_t(*close_func)(void *param))
apr_status_t	ap_cfg_getline (char *buf, apr_size_t bufsize, ap_configfile_t *cfp)
apr_status_t	ap_cfg_getc (char *ch, ap_configfile_t *cfp)
int	ap_cfg_closefile (ap_configfile_t *cfp)
const char *	ap_pcfg_strerror (apr_pool_t *p, ap_configfile_t *cfp, apr_status_t rc)
const char *	ap_soak_end_container (cmd_parms *cmd, char *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)
const char *	ap_build_config (cmd_parms *parms, apr_pool_t *conf_pool, apr_pool_t *temp_pool, ap_directive_t **conftree)
const char *	ap_walk_config (ap_directive_t *conftree, cmd_parms *parms, ap_conf_vector_t *section_vector)
ap_dir_match_t *	ap_dir_cfgmatch (cmd_parms *cmd, int flags, const char *(*cb)(ap_dir_match_t *w, const char *fname), void *ctx) __attribute__((nonnull(1
void	ap_single_module_configure (apr_pool_t *p, server_rec *s, module *m)
const char *	ap_setup_prelinked_modules (process_rec *process)
void	ap_show_directives (void)
int	ap_exists_directive (apr_pool_t *p, const char *name)
void	ap_show_modules (void)
const char *	ap_show_mpm (void)
server_rec *	ap_read_config (process_rec *process, apr_pool_t *temp_pool, const char *config_name, ap_directive_t **conftree)
void	ap_run_rewrite_args (process_rec *process)
void	ap_register_hooks (module *m, apr_pool_t *p)
void	ap_fixup_virtual_hosts (apr_pool_t *p, server_rec *main_server)
void	ap_reserve_module_slots (int count)
void	ap_reserve_module_slots_directive (const char *directive)
ap_conf_vector_t *	ap_create_request_config (apr_pool_t *p)
	AP_CORE_DECLARE (ap_conf_vector_t *) ap_create_per_dir_config(apr_pool_t *p)
struct ap_logconf *	ap_new_log_config (apr_pool_t *p, const struct ap_logconf *old)
void	ap_merge_log_config (const struct ap_logconf *old_conf, struct ap_logconf *new_conf)
	AP_CORE_DECLARE (int) ap_parse_htaccess(ap_conf_vector_t **result
	AP_CORE_DECLARE (const char *) ap_init_virtual_host(apr_pool_t *p
const char *	ap_process_resource_config (server_rec *s, const char *fname, ap_directive_t **conftree, apr_pool_t *p, apr_pool_t *ptemp)
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)
int	ap_process_config_tree (server_rec *s, ap_directive_t *conftree, apr_pool_t *p, apr_pool_t *ptemp)
void *	ap_retained_data_create (const char *key, apr_size_t size)
void *	ap_retained_data_get (const char *key)
	AP_CORE_DECLARE (const command_rec *) ap_find_command(const char *name
	AP_CORE_DECLARE (void *) ap_set_config_vectors(server_rec *server
void	ap_hook_header_parser (ap_HOOK_header_parser_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_header_parser (request_rec *r)
apr_array_header_t *	ap_hook_get_header_parser (void)
void	ap_hook_pre_config (ap_HOOK_pre_config_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_pre_config (apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp)
apr_array_header_t *	ap_hook_get_pre_config (void)
void	ap_hook_check_config (ap_HOOK_check_config_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_check_config (apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
apr_array_header_t *	ap_hook_get_check_config (void)
void	ap_hook_test_config (ap_HOOK_test_config_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
void	ap_run_test_config (apr_pool_t *pconf, server_rec *s)
apr_array_header_t *	ap_hook_get_test_config (void)
void	ap_hook_post_config (ap_HOOK_post_config_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_post_config (apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
apr_array_header_t *	ap_hook_get_post_config (void)
void	ap_hook_open_logs (ap_HOOK_open_logs_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_open_logs (apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)
apr_array_header_t *	ap_hook_get_open_logs (void)
void	ap_hook_child_init (ap_HOOK_child_init_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
void	ap_run_child_init (apr_pool_t *pchild, server_rec *s)
apr_array_header_t *	ap_hook_get_child_init (void)
void	ap_hook_handler (ap_HOOK_handler_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_handler (request_rec *r)
apr_array_header_t *	ap_hook_get_handler (void)
void	ap_hook_quick_handler (ap_HOOK_quick_handler_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
int	ap_run_quick_handler (request_rec *r, int lookup_uri)
apr_array_header_t *	ap_hook_get_quick_handler (void)
void	ap_hook_optional_fn_retrieve (ap_HOOK_optional_fn_retrieve_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
void	ap_run_optional_fn_retrieve (void)
apr_array_header_t *	ap_hook_get_optional_fn_retrieve (void)
void	ap_hook_open_htaccess (ap_HOOK_open_htaccess_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
apr_status_t	ap_run_open_htaccess (request_rec *r, const char *dir_name, const char *access_name, ap_configfile_t **conffile, const char **full_name)
apr_array_header_t *	ap_hook_get_open_htaccess (void)
apr_status_t	ap_open_htaccess (request_rec *r, const char *dir_name, const char *access_name, ap_configfile_t **conffile, const char **full_name)
apr_status_t	ap_pool_cleanup_set_null (void *data)

Variables
ap_module_symbol_t	ap_prelinked_module_symbols []
ap_conf_vector_t *	base
ap_conf_vector_t ap_conf_vector_t *	new_conf
request_rec *	r
request_rec int	override
request_rec int int	override_opts
request_rec int int apr_table_t *	override_list
request_rec int int apr_table_t const char *	path
request_rec int int apr_table_t const char const char *	access_name
const char *	hostname
const char server_rec *	main_server
const char server_rec server_rec **	ps
const command_rec *	cmds
ap_conf_vector_t *	section_vector
ap_conf_vector_t const char *	section

Detailed Description

Macro Definition Documentation

AP_DECLARE_MODULE

#define AP_DECLARE_MODULE

(

foo

)

Value:

    APLOG_USE_MODULE(foo);                         \
    module AP_MODULE_DECLARE_DATA foo##_module

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.

Definition at line 464 of file http_config.h.

AP_FLAG

#define AP_FLAG   func

Definition at line 168 of file http_config.h.

ap_get_conn_logconf

#define ap_get_conn_logconf

(

c

)

Value:

    ((c)->log             ? (c)->log             : \
     &(c)->base_server->log)

Definition at line 606 of file http_config.h.

ap_get_conn_module_loglevel

#define ap_get_conn_module_loglevel	(		c,
			i
	)		(ap_get_module_loglevel(ap_get_conn_logconf(c),i))

Definition at line 628 of file http_config.h.

ap_get_conn_server_logconf

#define ap_get_conn_server_logconf	(		c,
			s
	)

Value:

    ( ( (c)->log != &(c)->base_server->log && (c)->log != NULL )  ? \
      (c)->log                                                    : \
      &(s)->log )

Definition at line 610 of file http_config.h.

ap_get_conn_server_module_loglevel

#define ap_get_conn_server_module_loglevel	(		c,
			s,
			i
	)		(ap_get_module_loglevel(ap_get_conn_server_logconf(c,s),i))

Definition at line 631 of file http_config.h.

ap_get_module_config

#define ap_get_module_config	(		v,
			m
	)		(((void **)(v))[(m)->module_index])

Definition at line 550 of file http_config.h.

ap_get_module_loglevel

#define ap_get_module_loglevel	(		l,
			i
	)

Value:

    (((i) < 0 || (l)->module_levels == NULL || (l)->module_levels[i] < 0) ?  \
     (l)->level :                                                         \
     (l)->module_levels[i])

Definition at line 620 of file http_config.h.

ap_get_request_logconf

#define ap_get_request_logconf

(

r

)

Value:

    ((r)->log             ? (r)->log             : \
     (r)->connection->log ? (r)->connection->log : \
     &(r)->server->log)

Definition at line 615 of file http_config.h.

ap_get_request_module_loglevel

#define ap_get_request_module_loglevel	(		r,
			i
	)		(ap_get_module_loglevel(ap_get_request_logconf(r),i))

Definition at line 634 of file http_config.h.

ap_get_server_module_loglevel

#define ap_get_server_module_loglevel	(		s,
			i
	)		(ap_get_module_loglevel(&(s)->log,i))

Definition at line 625 of file http_config.h.

AP_INIT_FLAG

#define AP_INIT_FLAG	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, FLAG, help }

Definition at line 194 of file http_config.h.

AP_INIT_ITERATE

#define AP_INIT_ITERATE	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, ITERATE, help }

Definition at line 178 of file http_config.h.

AP_INIT_ITERATE2

#define AP_INIT_ITERATE2	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, ITERATE2, help }

Definition at line 184 of file http_config.h.

AP_INIT_NO_ARGS

#define AP_INIT_NO_ARGS	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, RAW_ARGS, help }

Definition at line 170 of file http_config.h.

AP_INIT_RAW_ARGS

#define AP_INIT_RAW_ARGS	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, RAW_ARGS, help }

Definition at line 172 of file http_config.h.

AP_INIT_TAKE1

#define AP_INIT_TAKE1	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE1, help }

Definition at line 176 of file http_config.h.

AP_INIT_TAKE12

#define AP_INIT_TAKE12	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE12, help }

Definition at line 182 of file http_config.h.

AP_INIT_TAKE123

#define AP_INIT_TAKE123	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE123, help }

Definition at line 190 of file http_config.h.

AP_INIT_TAKE13

#define AP_INIT_TAKE13	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE13, help }

Definition at line 186 of file http_config.h.

AP_INIT_TAKE2

#define AP_INIT_TAKE2	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE2, help }

Definition at line 180 of file http_config.h.

AP_INIT_TAKE23

#define AP_INIT_TAKE23	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE23, help }

Definition at line 188 of file http_config.h.

AP_INIT_TAKE3

#define AP_INIT_TAKE3	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE3, help }

Definition at line 192 of file http_config.h.

AP_INIT_TAKE_ARGV

#define AP_INIT_TAKE_ARGV	(		directive,
			func,
			mconfig,
			where,
			help
	)		{ directive, func, mconfig, where, TAKE_ARGV, help }

Definition at line 174 of file http_config.h.

AP_MAYBE_UNUSED

#define AP_MAYBE_UNUSED

(

x

)

x

The AP_MAYBE_UNUSED macro is used for variable declarations that might potentially exhibit "unused var" warnings on some compilers if left untreated. Since static intializers are not part of the C language (C89), making (void) usage is not possible. However many compiler have proprietary mechanism to suppress those warnings.

Definition at line 437 of file http_config.h.

AP_MODULE_FLAG_ALWAYS_MERGE

#define AP_MODULE_FLAG_ALWAYS_MERGE   (1 << 0)

Definition at line 337 of file http_config.h.

AP_MODULE_FLAG_NONE

#define AP_MODULE_FLAG_NONE   (0)

Flags associated with a module.

Definition at line 336 of file http_config.h.

AP_MODULE_FLAGS_MMN_MAJOR

#define AP_MODULE_FLAGS_MMN_MAJOR   20120211

When module flags have been introduced, and a way to check this.

Definition at line 536 of file http_config.h.

AP_MODULE_FLAGS_MMN_MINOR

#define AP_MODULE_FLAGS_MMN_MINOR   70

Definition at line 537 of file http_config.h.

AP_MODULE_HAS_FLAGS

#define AP_MODULE_HAS_FLAGS

(

m

)

Value:

        AP_MODULE_MAGIC_AT_LEAST(AP_MODULE_FLAGS_MMN_MAJOR, \
                                 AP_MODULE_FLAGS_MMN_MINOR)

Definition at line 538 of file http_config.h.

AP_NO_ARGS

#define AP_NO_ARGS   func

Definition at line 162 of file http_config.h.

AP_RAW_ARGS

#define AP_RAW_ARGS   func

Definition at line 163 of file http_config.h.

ap_set_module_config

#define ap_set_module_config	(		v,
			m,
			val
	)		((((void **)(v))[(m)->module_index]) = (val))

Definition at line 552 of file http_config.h.

AP_TAKE1

#define AP_TAKE1   func

Definition at line 165 of file http_config.h.

AP_TAKE2

#define AP_TAKE2   func

Definition at line 166 of file http_config.h.

AP_TAKE3

#define AP_TAKE3   func

Definition at line 167 of file http_config.h.

AP_TAKE_ARGV

#define AP_TAKE_ARGV   func

Definition at line 164 of file http_config.h.

APLOG_USE_MODULE

#define APLOG_USE_MODULE

(

foo

)

Value:

    extern module AP_MODULE_DECLARE_DATA foo##_module;                  \
    AP_MAYBE_UNUSED(static int * const aplog_module_index) = &(foo##_module.module_index)

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.

Parameters

foo	name of the module symbol of the current module, without the trailing "_module" part

See also

APLOG_MARK

Definition at line 453 of file http_config.h.

DECLINE_CMD

#define DECLINE_CMD   "\a\b"

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.

Definition at line 264 of file http_config.h.

Typedef Documentation

ap_conf_vector_t

typedef struct ap_conf_vector_t ap_conf_vector_t

configuration vector structure

Definition at line 509 of file http_config.h.

ap_configfile_t

typedef struct ap_configfile_t ap_configfile_t

Common structure for reading of config files / passwd files etc.

Definition at line 267 of file http_config.h.

ap_LINK_check_config_t

typedef struct ap_LINK_check_config_t ap_LINK_check_config_t

ap_LINK_child_init_t

typedef struct ap_LINK_child_init_t ap_LINK_child_init_t

ap_LINK_handler_t

typedef struct ap_LINK_handler_t ap_LINK_handler_t

ap_LINK_header_parser_t

typedef struct ap_LINK_header_parser_t ap_LINK_header_parser_t

ap_LINK_open_htaccess_t

typedef struct ap_LINK_open_htaccess_t ap_LINK_open_htaccess_t

ap_LINK_open_logs_t

typedef struct ap_LINK_open_logs_t ap_LINK_open_logs_t

ap_LINK_optional_fn_retrieve_t

typedef struct ap_LINK_optional_fn_retrieve_t ap_LINK_optional_fn_retrieve_t

ap_LINK_post_config_t

typedef struct ap_LINK_post_config_t ap_LINK_post_config_t

ap_LINK_pre_config_t

typedef struct ap_LINK_pre_config_t ap_LINK_pre_config_t

ap_LINK_quick_handler_t

typedef struct ap_LINK_quick_handler_t ap_LINK_quick_handler_t

ap_LINK_test_config_t

typedef struct ap_LINK_test_config_t ap_LINK_test_config_t

cmd_func

typedef const char *(* cmd_func) ()

Definition at line 160 of file http_config.h.

cmd_parms

typedef struct cmd_parms_struct cmd_parms

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...

Definition at line 74 of file http_config.h.

command_rec

typedef struct command_struct command_rec

The command record structure. Modules can define a table of these to define the directives it will implement.

Definition at line 203 of file http_config.h.

module

typedef struct module_struct module

Module structures. Just about everything is dispatched through these, directly or indirectly (through the command and handler tables).

Definition at line 344 of file http_config.h.

Enumeration Type Documentation

cmd_how

enum cmd_how

How the directives arguments should be parsed.

Remarks

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...

Enumerator
RAW_ARGS	cmd_func parses command line itself
TAKE1	one argument only
TAKE2	two arguments only
ITERATE	one argument, occurring 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

Definition at line 49 of file http_config.h.

Function Documentation

ap_add_loaded_module()

const char * ap_add_loaded_module	(	module *	mod,
		apr_pool_t *	p,
		const char *	s
	)

Add a module to the chained modules list and the list of loaded modules

Parameters

mod	The module structure of the module to add
p	The pool with the same lifetime as the module
s	The module's symbol name (used for logging)

Definition at line 703 of file config.c.

ap_add_module()

const char * ap_add_module	(	module *	m,
		apr_pool_t *	p,
		const char *	s
	)

Add a module to the server

Parameters

m	The module structure of the module to add
p	The pool of the same lifetime as the module
s	The module's symbol name (used for logging)

Definition at line 558 of file config.c.

ap_build_config()

const char * ap_build_config	(	cmd_parms *	parms,
		apr_pool_t *	conf_pool,
		apr_pool_t *	temp_pool,
		ap_directive_t **	conftree
	)

Build a config tree from a config file

Parameters

parms	The cmd_parms to pass to all of the directives in the file
conf_pool	The pconf pool
temp_pool	The temporary pool
conftree	Place to store the root node of the config tree

Returns

Error string on error, NULL otherwise

Note

If conf_pool == temp_pool, ap_build_config() will assume .htaccess context and use a lower maximum line length.

Definition at line 1387 of file config.c.

ap_build_cont_config()

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
	)

Read all data between the current <foo> and the matching </foo> and build a config tree from it

Parameters

p	pool to allocate from
temp_pool	Temporary pool to allocate from
parms	The cmd_parms to pass to all directives read
current	The current node in the tree
curr_parent	The current parent node
orig_directive	The directive to read until hit.

Returns

Error string on failure, NULL on success

Note

If p == temp_pool, ap_build_cont_config() will assume .htaccess context and use a lower maximum line length.

Definition at line 1251 of file config.c.

ap_cfg_closefile()

int ap_cfg_closefile

(

ap_configfile_t *

cfp

)

Detach from open ap_configfile_t, calling the close handler

Parameters

cfp	The file to close

Returns

1 on success, 0 on failure

Definition at line 931 of file util.c.

ap_cfg_getc()

apr_status_t ap_cfg_getc	(	char *	ch,
		ap_configfile_t *	cfp
	)

Read one char from open configfile_t, increase line number upon LF

Parameters

ch	place to store the char read
cfp	The file to read from

Returns

error status

Definition at line 1055 of file util.c.

ap_cfg_getline()

apr_status_t ap_cfg_getline	(	char *	buf,
		apr_size_t	bufsize,
		ap_configfile_t *	cfp
	)

Read one line from open ap_configfile_t, strip leading and trailing whitespace, increase line number

Parameters

buf	place to store the line read
bufsize	size of the buffer
cfp	File to read from

Returns

error status, APR_ENOSPC if bufsize is too small for the line

Definition at line 1198 of file util.c.

AP_CORE_DECLARE() [1/5]

AP_CORE_DECLARE

(

ap_conf_vector_t *

)

Setup the config vector for per dir module configs

Parameters

p	The pool to allocate the config vector from

Returns

The config vector

Run all of the modules merge per dir config functions

Parameters

p	The pool to pass to the merge functions
base	The base directory config structure
new_conf	The new directory config structure

Setup the config vector for a connection_rec

Parameters

p	The pool to allocate the config vector from

Returns

The config vector

AP_CORE_DECLARE() [2/5]

AP_CORE_DECLARE

(

const char *

)

Setup a virtual host

Parameters

p	The pool to allocate all memory from
hostname	The hostname of the virtual hsot
main_server	The main server for this Apache configuration
ps	Place to store the new server_rec return Error string on error, NULL on success

AP_CORE_DECLARE() [3/5]

AP_CORE_DECLARE

(

const command_rec *

)

const

Find a given directive in a command_rec table

Parameters

name	The directive to search for
cmds	The table to search

Returns

The directive definition of the specified directive

Find a given directive in a list of modules.

Parameters

cmd_name	The directive to search for
mod	Pointer to the first module in the linked list; will be set to the module providing cmd_name

Returns

The directive definition of the specified directive. *mod will be changed to point to the module containing the directive.

AP_CORE_DECLARE() [4/5]

AP_CORE_DECLARE

(

int

)

parse an htaccess file

Parameters

result	htaccess_result
r	The request currently being served
override	Which overrides are active
override_opts	Which allow-override-opts bits are set
override_list	Table of directives allowed for override
path	The path to the htaccess file
access_name	The list of possible names for .htaccess files int The status of the current request

Run the handler phase of each module until a module accepts the responsibility of serving the request

Parameters

r	The current request

Returns

The status of the current request

AP_CORE_DECLARE() [5/5]

AP_CORE_DECLARE

(

void *

)

Ask a module to create per-server and per-section (dir/loc/file) configs (if it hasn't happened already). The results are stored in the server's config, and the specified per-section config vector.

Parameters

server	The server to operate upon.
section_vector	The per-section config vector.
section	Which section to create a config for.
mod	The module which is defining the config data.
pconf	A pool for all configuration allocations.

Returns

The (new) per-section config data.

ap_create_request_config()

ap_conf_vector_t * ap_create_request_config

(

apr_pool_t *

p

)

Setup the config vector for a request_rec

Parameters

p	The pool to allocate the config vector from

Returns

The config vector

Definition at line 356 of file config.c.

ap_dir_cfgmatch()

ap_dir_match_t * ap_dir_cfgmatch	(	cmd_parms *	cmd,
		int	flags,
		const char *(*)(ap_dir_match_t *w, const char *fname)	cb,
		void *	ctx
	)

Convenience function to create a ap_dir_match_t structure from a cmd_parms.

Parameters

cmd	The command.
flags	Flags to indicate whether optional or recursive.
cb	Callback for each file found that matches the wildcard. Return NULL on success, an error string on error.
ctx	Context for the callback.

Returns

Structure ap_dir_match_t with fields populated, allocated from the cmd->temp_pool.

ap_exists_directive()

int ap_exists_directive	(	apr_pool_t *	p,
		const char *	name
	)

Returns non-zero if a configuration directive of the given name has been registered by a module at the time of calling.

Parameters

p	Pool for temporary allocations
name	Directive name

Definition at line 2509 of file config.c.

ap_find_module_name()

const char * ap_find_module_name

(

module *

m

)

Find the name of the specified module

Parameters

m	The module to get the name for

Returns

the name of the module

Definition at line 818 of file config.c.

ap_find_module_short_name()

const char * ap_find_module_short_name

(

int

module_index

)

Find the short name of the module identified by the specified module index

Parameters

module_index

The module index to get the name for

Returns

the name of the module, NULL if not found

Definition at line 823 of file config.c.

ap_fixup_virtual_hosts()

void ap_fixup_virtual_hosts	(	apr_pool_t *	p,
		server_rec *	main_server
	)

Setup all virtual hosts

Parameters

p	The pool to allocate from
main_server	The head of the server_rec list

Definition at line 2163 of file config.c.

ap_get_conn_module_loglevel()

int ap_get_conn_module_loglevel	(	const conn_rec *	c,
		int	index
	)

Generic accessor for modules the module-specific loglevel

Parameters

c	The connection from which to get the loglevel.
index	The module_index of the module to get the loglevel for.

Returns

The module-specific loglevel

Definition at line 153 of file util_debug.c.

ap_get_conn_server_module_loglevel()

int ap_get_conn_server_module_loglevel	(	const conn_rec *	c,
		const server_rec *	s,
		int	index
	)

Generic accessor for modules the module-specific loglevel

Parameters

c	The connection from which to get the loglevel.
s	The server from which to get the loglevel if c does not have a specific loglevel configuration.
index	The module_index of the module to get the loglevel for.

Returns

The module-specific loglevel

Definition at line 172 of file util_debug.c.

ap_get_module_config()

void * ap_get_module_config	(	const ap_conf_vector_t *	cv,
		const module *	m
	)

Generic accessors for other modules to get at their own module-specific data

Parameters

cv	The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config
m	The module to get the data for.

Returns

The module-specific data

Definition at line 104 of file util_debug.c.

ap_get_module_flags()

int ap_get_module_flags

(

const module *

m

)

Generic accessor for the module's flags

Parameters

m	The module to get the flags from.

Returns

The module-specific flags

Definition at line 110 of file util_debug.c.

ap_get_request_module_loglevel()

int ap_get_request_module_loglevel	(	const request_rec *	r,
		int	index
	)

Generic accessor for modules to get the module-specific loglevel

Parameters

r	The request from which to get the loglevel.
index	The module_index of the module to get the loglevel for.

Returns

The module-specific loglevel

Definition at line 192 of file util_debug.c.

ap_get_server_module_loglevel()

int ap_get_server_module_loglevel	(	const server_rec *	s,
		int	index
	)

Generic accessor for modules to get the module-specific loglevel

Parameters

s	The server from which to get the loglevel.
index	The module_index of the module to get the loglevel for.

Returns

The module-specific loglevel

Definition at line 137 of file util_debug.c.

ap_hook_check_config()

void ap_hook_check_config	(	ap_HOOK_check_config_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 96 of file config.c.

ap_hook_child_init()

void ap_hook_child_init	(	ap_HOOK_child_init_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 167 of file config.c.

ap_hook_get_check_config()

apr_array_header_t * ap_hook_get_check_config

(

void

)

Definition at line 96 of file config.c.

ap_hook_get_child_init()

apr_array_header_t * ap_hook_get_child_init

(

void

)

Definition at line 167 of file config.c.

ap_hook_get_handler()

apr_array_header_t * ap_hook_get_handler

(

void

)

Definition at line 170 of file config.c.

ap_hook_get_header_parser()

apr_array_header_t * ap_hook_get_header_parser

(

void

)

Definition at line 86 of file config.c.

ap_hook_get_open_htaccess()

apr_array_header_t * ap_hook_get_open_htaccess

(

void

)

Definition at line 179 of file config.c.

ap_hook_get_open_logs()

apr_array_header_t * ap_hook_get_open_logs

(

void

)

Definition at line 163 of file config.c.

ap_hook_get_optional_fn_retrieve()

apr_array_header_t * ap_hook_get_optional_fn_retrieve

(

void

)

Definition at line 195 of file config.c.

ap_hook_get_post_config()

apr_array_header_t * ap_hook_get_post_config

(

void

)

Definition at line 105 of file config.c.

ap_hook_get_pre_config()

apr_array_header_t * ap_hook_get_pre_config

(

void

)

Definition at line 91 of file config.c.

ap_hook_get_quick_handler()

apr_array_header_t * ap_hook_get_quick_handler

(

void

)

Definition at line 173 of file config.c.

ap_hook_get_test_config()

apr_array_header_t * ap_hook_get_test_config

(

void

)

Definition at line 100 of file config.c.

ap_hook_handler()

void ap_hook_handler	(	ap_HOOK_handler_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 170 of file config.c.

ap_hook_header_parser()

void ap_hook_header_parser	(	ap_HOOK_header_parser_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 86 of file config.c.

ap_hook_open_htaccess()

void ap_hook_open_htaccess	(	ap_HOOK_open_htaccess_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 179 of file config.c.

ap_hook_open_logs()

void ap_hook_open_logs	(	ap_HOOK_open_logs_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 163 of file config.c.

ap_hook_optional_fn_retrieve()

void ap_hook_optional_fn_retrieve	(	ap_HOOK_optional_fn_retrieve_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 195 of file config.c.

ap_hook_post_config()

void ap_hook_post_config	(	ap_HOOK_post_config_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 105 of file config.c.

ap_hook_pre_config()

void ap_hook_pre_config	(	ap_HOOK_pre_config_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 91 of file config.c.

ap_hook_quick_handler()

void ap_hook_quick_handler	(	ap_HOOK_quick_handler_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 173 of file config.c.

ap_hook_test_config()

void ap_hook_test_config	(	ap_HOOK_test_config_t *	pf,
		const char *const *	aszPre,
		const char *const *	aszSucc,
		int	nOrder
	)

Definition at line 100 of file config.c.

ap_merge_log_config()

void ap_merge_log_config	(	const struct ap_logconf *	old_conf,
		struct ap_logconf *	new_conf
	)

Merge old ap_logconf into new ap_logconf. old and new must have the same life time.

Parameters

old_conf	The ap_logconf to merge from
new_conf	The ap_logconf to merge into

Definition at line 2140 of file config.c.

ap_method_is_limited()

int ap_method_is_limited	(	cmd_parms *	cmd,
		const char *	method
	)

Return true if the specified method is limited by being listed in a <Limit> container, or by not being listed in a <LimitExcept> container.

Parameters

method	Pointer to a string specifying the method to check.
cmd	Pointer to the cmd_parms structure passed to the directive handler.

Returns

0 if the method is not limited in the current scope

no valid method

Definition at line 472 of file config.c.

ap_new_log_config()

struct ap_logconf * ap_new_log_config	(	apr_pool_t *	p,
		const struct ap_logconf *	old
	)

Allocate new ap_logconf and make (deep) copy of old ap_logconf

Parameters

p	The pool to alloc from
old	The ap_logconf to copy (may be NULL)

Returns

The new ap_logconf struct

Definition at line 2123 of file config.c.

ap_open_htaccess()

apr_status_t ap_open_htaccess	(	request_rec *	r,
		const char *	dir_name,
		const char *	access_name,
		ap_configfile_t **	conffile,
		const char **	full_name
	)

Core internal function, use ap_run_open_htaccess() instead.

Definition at line 1986 of file config.c.

ap_parse_log_level()

const char * ap_parse_log_level	(	const char *	str,
		int *	val
	)

Parsing function for log level

Parameters

str	The string to parse
val	The parsed log level

Returns

An error string or NULL on success

Definition at line 1983 of file log.c.

ap_pcfg_open_custom()

ap_configfile_t * ap_pcfg_open_custom	(	apr_pool_t *	p,
		const char *	descr,
		void *	param,
		apr_status_t(*)(char *ch, void *param)	getc_func,
		apr_status_t(*)(void *buf, apr_size_t bufsiz, void *param)	gets_func,
		apr_status_t(*)(void *param)	close_func
	)

Allocate a ap_configfile_t handle with user defined functions and params

Parameters

p	The pool to allocate from
descr	The name of the file
param	The argument passed to getch/getstr/close
getc_func	The getch function
gets_func	The getstr function
close_func	The close function

ap_pcfg_openfile()

apr_status_t ap_pcfg_openfile	(	ap_configfile_t **	ret_cfg,
		apr_pool_t *	p,
		const char *	name
	)

Open a ap_configfile_t as apr_file_t

Parameters

ret_cfg	open ap_configfile_t struct pointer
p	The pool to allocate the structure from
name	the name of the file to open

< Open the file for reading

<

Deprecated:

See also

APR_FOPEN_READ

< Open the file for buffered I/O

<

Deprecated:

See also

APR_FOPEN_BUFFERED

< use OS's default permissions

<

Deprecated:

See also

APR_FPROT_OS_DEFAULT

< Type

Definition at line 957 of file util.c.

ap_pcfg_strerror()

const char * ap_pcfg_strerror	(	apr_pool_t *	p,
		ap_configfile_t *	cfp,
		apr_status_t	rc
	)

Convert a return value from ap_cfg_getline or ap_cfg_getc to a user friendly string.

Parameters

p	The pool to allocate the string from
cfp	The config file
rc	The return value to convert

Returns

The error string, NULL if rc == APR_SUCCESS

Definition at line 1063 of file util.c.

ap_pool_cleanup_set_null()

apr_status_t ap_pool_cleanup_set_null

(

void *

data

)

A generic pool cleanup that will reset a pointer to NULL. For use with apr_pool_cleanup_register.

Parameters

data	The address of the pointer

Returns

APR_SUCCESS

Definition at line 2710 of file util.c.

ap_process_config_tree()

int ap_process_config_tree	(	server_rec *	s,
		ap_directive_t *	conftree,
		apr_pool_t *	p,
		apr_pool_t *	ptemp
	)

Process all directives in the config tree

Parameters

s	The server rec to use in the command parms
conftree	The config tree to process
p	The pool for general allocation
ptemp	The pool for temporary allocations

Returns

OK if no problems

< *.conf outside <Directory> or <Location>

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride Limit

< *.conf anywhere and .htaccess when AllowOverride Options

< *.conf anywhere and .htaccess when AllowOverride FileInfo

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride AuthConfig

< *.conf anywhere and .htaccess when AllowOverride Indexes

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride AuthConfig

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride Limit

< Module has handled this stage.

Definition at line 1956 of file config.c.

ap_process_fnmatch_configs()

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 matching files as Apache configs

Parameters

s	The server rec to use for the command parms
fname	The filename pattern of the config file
conftree	The root node of the created config tree
p	Pool for general allocation
ptemp	Pool for temporary allocation
optional	Whether a no-match wildcard is allowed

See also

Filename Matching Functions for pattern handling

< Stat the link not the file itself if it is a link

< Type

Definition at line 1902 of file config.c.

ap_process_resource_config()

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 a config file for Apache

Parameters

s	The server rec to use for the command parms
fname	The name of the config file
conftree	The root node of the created config tree
p	Pool for general allocation
ptemp	Pool for temporary allocation

< *.conf outside <Directory> or <Location>

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride Limit

< *.conf anywhere and .htaccess when AllowOverride Options

< *.conf anywhere and .htaccess when AllowOverride FileInfo

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride AuthConfig

< *.conf anywhere and .htaccess when AllowOverride Indexes

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride AuthConfig

< *.conf inside <Directory> or <Location> and .htaccess when AllowOverride Limit

Definition at line 1847 of file config.c.

ap_read_config()

server_rec * ap_read_config	(	process_rec *	process,
		apr_pool_t *	temp_pool,
		const char *	config_name,
		ap_directive_t **	conftree
	)

Read all config files and setup the server

Parameters

process	The process running the server
temp_pool	A pool to allocate temporary data from.
config_name	The name of the config file
conftree	Place to store the root of the config tree

Returns

The setup server_rec list.

Definition at line 2294 of file config.c.

ap_register_hooks()

void ap_register_hooks	(	module *	m,
		apr_pool_t *	p
	)

Run the register hooks function for a specified module

Parameters

m	The module to run the register hooks function from
p	The pool valid for the lifetime of the module

Definition at line 489 of file config.c.

ap_remove_loaded_module()

void ap_remove_loaded_module

(

module *

mod

)

Remove a module from the chained modules list and the list of loaded modules

Parameters

mod	the module structure of the module to remove

Definition at line 733 of file config.c.

ap_remove_module()

void ap_remove_module

(

module *

m

)

Remove a module from the server. There are some caveats: when the module is removed, its slot is lost so all the current per-dir and per-server configurations are invalid. So we should only ever call this function when you are invalidating almost all our current data. I.e. when doing a restart.

Parameters

m	the module structure of the module to remove

Definition at line 662 of file config.c.

ap_reserve_module_slots()

void ap_reserve_module_slots

(

int

count

)

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.

Parameters

count

The number of slots to reserve.

Definition at line 2549 of file config.c.

ap_reserve_module_slots_directive()

void ap_reserve_module_slots_directive

(

const char *

directive

)

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.

Parameters

directive

The name of the directive

Definition at line 2554 of file config.c.

ap_reset_module_loglevels()

void ap_reset_module_loglevels	(	struct ap_logconf *	l,
		int	val
	)

Set all module-specific loglevels to val

Parameters

l	The log config for which to set the loglevels.
val	the value to set all loglevels to

Definition at line 1564 of file config.c.

ap_retained_data_create()

void * ap_retained_data_create	(	const char *	key,
		apr_size_t	size
	)

Store data which will be retained across unload/load of modules

Parameters

key	The unique key associated with this module's retained data
size	in bytes of the retained data (to be allocated)

Returns

Address of new retained data structure, initially cleared

Definition at line 2527 of file config.c.

ap_retained_data_get()

void * ap_retained_data_get

(

const char *

key

)

Retrieve data which was stored by ap_retained_data_create()

Parameters

key	The unique key associated with this module's retained data

Returns

Address of previously retained data structure, or NULL if not yet saved

Definition at line 2519 of file config.c.

ap_run_check_config()

int ap_run_check_config	(	apr_pool_t *	pconf,
		apr_pool_t *	plog,
		apr_pool_t *	ptemp,
		server_rec *	s
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 96 of file config.c.

ap_run_child_init()

void ap_run_child_init	(	apr_pool_t *	pchild,
		server_rec *	s
	)

Definition at line 167 of file config.c.

ap_run_handler()

int ap_run_handler

(

request_rec *

r

)

< Module declines to handle

< Module declines to handle

Definition at line 170 of file config.c.

ap_run_header_parser()

int ap_run_header_parser

(

request_rec *

r

)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 86 of file config.c.

ap_run_open_htaccess()

apr_status_t ap_run_open_htaccess	(	request_rec *	r,
		const char *	dir_name,
		const char *	access_name,
		ap_configfile_t **	conffile,
		const char **	full_name
	)

Definition at line 179 of file config.c.

ap_run_open_logs()

int ap_run_open_logs	(	apr_pool_t *	pconf,
		apr_pool_t *	plog,
		apr_pool_t *	ptemp,
		server_rec *	s
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 163 of file config.c.

ap_run_optional_fn_retrieve()

void ap_run_optional_fn_retrieve

(

void

)

Definition at line 195 of file config.c.

ap_run_post_config()

int ap_run_post_config	(	apr_pool_t *	pconf,
		apr_pool_t *	plog,
		apr_pool_t *	ptemp,
		server_rec *	s
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 105 of file config.c.

ap_run_pre_config()

int ap_run_pre_config	(	apr_pool_t *	pconf,
		apr_pool_t *	plog,
		apr_pool_t *	ptemp
	)

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

Definition at line 91 of file config.c.

ap_run_quick_handler()

int ap_run_quick_handler	(	request_rec *	r,
		int	lookup_uri
	)

< Module declines to handle

< Module declines to handle

Definition at line 173 of file config.c.

ap_run_rewrite_args()

void ap_run_rewrite_args

(

process_rec *

process

)

Run all rewrite args hooks for loaded modules

Parameters

process

The process currently running the server

Definition at line 2379 of file config.c.

ap_run_test_config()

void ap_run_test_config	(	apr_pool_t *	pconf,
		server_rec *	s
	)

Definition at line 100 of file config.c.

ap_runtime_dir_relative()

char * ap_runtime_dir_relative	(	apr_pool_t *	p,
		const char *	fname
	)

Compute the name of a run-time file (e.g., shared memory "file") relative to the appropriate run-time directory. Absolute paths are returned as-is. The run-time directory is configured via the DefaultRuntimeDir directive or at build time.

Definition at line 1610 of file config.c.

ap_server_root_relative()

char * ap_server_root_relative	(	apr_pool_t *	p,
		const char *	fname
	)

For modules which need to read config files, open logs, etc. this returns the canonical form of fname made absolute to ap_server_root.

Parameters

p	pool to allocate data from
fname	The file name

Definition at line 1594 of file config.c.

ap_set_deprecated()

const char * ap_set_deprecated	(	cmd_parms *	cmd,
		void *	struct_ptr,
		const char *	arg
	)

Generic command handling function to respond with cmd->help as an error

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive

Returns

The cmd->help value as the error string

Note

This allows simple declarations such as:

AP_INIT_RAW_ARGS("Foo", ap_set_deprecated, NULL, OR_ALL,
    "The Foo directive is no longer supported, use Bar"),

Definition at line 1557 of file config.c.

ap_set_file_slot()

const char * ap_set_file_slot	(	cmd_parms *	cmd,
		void *	struct_ptr,
		const char *	arg
	)

Generic command handling function for files

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive

Returns

An error string or NULL on success

Definition at line 1535 of file config.c.

ap_set_flag_slot()

const char * ap_set_flag_slot	(	cmd_parms *	cmd,
		void *	struct_ptr,
		int	arg
	)

Generic command handling function for flags stored in an int

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive (either 1 or 0)

Returns

An error string or NULL on success

Definition at line 1512 of file config.c.

ap_set_flag_slot_char()

const char * ap_set_flag_slot_char	(	cmd_parms *	cmd,
		void *	struct_ptr,
		int	arg
	)

Generic command handling function for flags stored in a char

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive (either 1 or 0)

Returns

An error string or NULL on success

Definition at line 1523 of file config.c.

ap_set_int_slot()

const char * ap_set_int_slot	(	cmd_parms *	cmd,
		void *	struct_ptr,
		const char *	arg
	)

Generic command handling function for integers

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive

Returns

An error string or NULL on success

Definition at line 1480 of file config.c.

ap_set_module_config()

void ap_set_module_config	(	ap_conf_vector_t *	cv,
		const module *	m,
		void *	val
	)

Generic accessors for other modules to set their own module-specific data

Parameters

cv	The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config
m	The module to set the data for.
val	The module-specific data to set

Generic accessors for other modules to set at their own module-specific data

Parameters

conf_vector	The vector in which the modules configuration is stored. usually r->per_dir_config or s->module_config
m	The module to set the data for.
val	The module-specific data to set

Definition at line 221 of file util_debug.c.

ap_set_module_loglevel()

void ap_set_module_loglevel	(	apr_pool_t *	p,
		struct ap_logconf *	l,
		int	index,
		int	level
	)

Accessor to set module-specific loglevel

Parameters

p	A pool
l	The ap_logconf struct to modify.
index	The module_index of the module to set the loglevel for.
level	The new log level

Definition at line 1570 of file config.c.

ap_set_string_slot()

const char * ap_set_string_slot	(	cmd_parms *	cmd,
		void *	struct_ptr,
		const char *	arg
	)

Generic command handling function for strings

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive

Returns

An error string or NULL on success

Definition at line 1469 of file config.c.

ap_set_string_slot_lower()

const char * ap_set_string_slot_lower	(	cmd_parms *	cmd,
		void *	struct_ptr,
		const char *	arg
	)

Generic command handling function for strings, always sets the value to a lowercase string

Parameters

cmd	The command parameters for this directive
struct_ptr	pointer into a given type
arg	The argument to the directive

Returns

An error string or NULL on success

Definition at line 1499 of file config.c.

ap_setup_prelinked_modules()

const char * ap_setup_prelinked_modules

(

process_rec *

process

)

Add all of the prelinked modules into the loaded module list

Parameters

process

The process that is currently running the server

Definition at line 763 of file config.c.

ap_show_directives()

void ap_show_directives

(

void

)

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.

Definition at line 2482 of file config.c.

ap_show_modules()

void ap_show_modules

(

void

)

Show the preloaded module names. Used for httpd -l.

Definition at line 2500 of file config.c.

ap_show_mpm()

const char * ap_show_mpm

(

void

)

Show the MPM name. Used in reporting modules such as mod_info to provide extra information to the user

Definition at line 548 of file mpm_common.c.

ap_single_module_configure()

void ap_single_module_configure	(	apr_pool_t *	p,
		server_rec *	s,
		module *	m
	)

Run a single module's two create_config hooks

Parameters

p	the pool to allocate from
s	The server to configure for.
m	The module to configure

Definition at line 2367 of file config.c.

ap_soak_end_container()

const char * ap_soak_end_container	(	cmd_parms *	cmd,
		char *	directive
	)

Read all data between the current <foo> and the matching </foo>. All of this data is forgotten immediately.

Parameters

cmd	The cmd_parms to pass to the directives inside the container
directive	The directive name to read until

Returns

Error string on failure, NULL on success

Note

If cmd->pool == cmd->temp_pool, ap_soak_end_container() will assume .htaccess context and use a lower maximum line length.

Definition at line 1629 of file config.c.

ap_walk_config()

const char * ap_walk_config	(	ap_directive_t *	conftree,
		cmd_parms *	parms,
		ap_conf_vector_t *	section_vector
	)

Walk a config tree and setup the server's internal structures

Parameters

conftree	The config tree to walk
parms	The cmd_parms to pass to all functions
section_vector	The per-section config vector.

Returns

Error string on error, NULL otherwise

Definition at line 1360 of file config.c.

Variable Documentation

access_name

request_rec int int apr_table_t const char const char* access_name

Definition at line 1173 of file http_config.h.

ap_prelinked_module_symbols

ap_module_symbol_t ap_prelinked_module_symbols[]

extern

Array of all statically linked modulenames (symbols)

base

ap_conf_vector_t* base

Definition at line 1125 of file http_config.h.

cmds

const command_rec* cmds

Definition at line 1265 of file http_config.h.

hostname

const char* hostname

Definition at line 1184 of file http_config.h.

main_server

const char server_rec* main_server

Definition at line 1185 of file http_config.h.

new_conf

ap_conf_vector_t ap_conf_vector_t* new_conf

Definition at line 1126 of file http_config.h.

override

request_rec int override

Definition at line 1169 of file http_config.h.

override_list

request_rec int int apr_table_t* override_list

Definition at line 1171 of file http_config.h.

override_opts

request_rec int int override_opts

Definition at line 1170 of file http_config.h.

path

request_rec int int apr_table_t const char* path

Definition at line 1172 of file http_config.h.

ps

const char server_rec server_rec** ps

Definition at line 1186 of file http_config.h.

r

request_rec* r

Definition at line 1168 of file http_config.h.

section

ap_conf_vector_t const char* section

Definition at line 1292 of file http_config.h.

section_vector

ap_conf_vector_t* section_vector

Definition at line 1291 of file http_config.h.