Main Page | Modules | Namespace List | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages | Examples
httpd-2.0.54 / include

http_config.h File Reference

Apache Configuration. More...

#include "apr_hooks.h"
#include "util_cfgtree.h"

Include dependency graph for http_config.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define AP_NO_ARGS   func
#define AP_RAW_ARGS   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_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 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_ALL   (OR_LIMIT|OR_OPTIONS|OR_FILEINFO|OR_AUTHCFG|OR_INDEXES)
#define DECLINE_CMD   "\a\b"
#define STANDARD_MODULE_STUFF   this_module_needs_to_be_ported_to_apache_2_0
#define STANDARD20_MODULE_STUFF
#define MPM20_MODULE_STUFF
#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 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)
#define GLOBAL_ONLY   (NOT_IN_VIRTUALHOST|NOT_IN_LIMIT|NOT_IN_DIR_LOC_FILE)

Typedefs

typedef cmd_parms_struct cmd_parms
typedef const char *(* cmd_func )()
typedef command_struct command_rec
typedef ap_configfile_t ap_configfile_t
typedef module_struct module
typedef ap_conf_vector_t ap_conf_vector_t

Enumerations

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

Functions

 AP_DECLARE (void *) ap_get_module_config(const ap_conf_vector_t *cv
 AP_DECLARE (void) ap_set_module_config(ap_conf_vector_t *cv
 AP_DECLARE_NONSTD (const char *) ap_set_string_slot(cmd_parms *cmd
 AP_DECLARE (int) ap_method_is_limited(cmd_parms *cmd
 AP_DECLARE (char *) ap_server_root_relative(apr_pool_t *p
 AP_DECLARE (const char *) ap_find_module_name(module *m)
 AP_DECLARE (module *) ap_find_linked_module(const char *name)
 AP_DECLARE (apr_status_t) ap_pcfg_openfile(ap_configfile_t **ret_cfg
 AP_DECLARE (ap_configfile_t *) ap_pcfg_open_custom(apr_pool_t *p
 AP_DECLARE_HOOK (int, header_parser,(request_rec *r)) AP_DECLARE_HOOK(int
apr_pool_t apr_pool_t apr_pool_t
*ptemp 		AP_DECLARE_HOOK (int, post_config,(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s)) AP_DECLARE_HOOK(int
apr_pool_t apr_pool_t apr_pool_t
*ptemp apr_pool_t apr_pool_t
apr_pool_t server_rec *s 		AP_DECLARE_HOOK (void, child_init,(apr_pool_t *pchild, server_rec *s)) AP_DECLARE_HOOK(int
apr_pool_t apr_pool_t apr_pool_t
*ptemp apr_pool_t apr_pool_t
apr_pool_t server_rec *s request_rec
*r 		AP_DECLARE_HOOK (int, quick_handler,(request_rec *r, int lookup_uri)) AP_DECLARE_HOOK(void

Variables

const module * m
const module void * val
void * struct_ptr
void const char * arg
const char * method
const char * fname
apr_pool_t * p
apr_pool_t const char * name
const char * descr
const char void * param
const char void int(* getc_func )(void *)
const char void int(*) void *(* gets_func )(void *buf, size_t bufsiz, void *param)
const char void int(*) void
*(*) int(* 		close_func )(void *param))
size_t bufsize
size_t ap_configfile_t * cfp
char * directive
apr_pool_t * temp_pool
apr_pool_t cmd_parms * parms
apr_pool_t cmd_parms ap_directive_t ** current
apr_pool_t cmd_parms ap_directive_t
ap_directive_t ** 		curr_parent
apr_pool_t cmd_parms ap_directive_t
ap_directive_t char * 		orig_directive
apr_pool_t * conf_pool
apr_pool_t apr_pool_t ap_directive_t ** conftree
cmd_parms ap_conf_vector_t * section_vector
unsigned forbidden
 pre_config
apr_pool_t * pconf
apr_pool_t apr_pool_t * plog
apr_pool_t apr_pool_t apr_pool_t
*ptemp 		open_logs
apr_pool_t apr_pool_t apr_pool_t
*ptemp apr_pool_t apr_pool_t
apr_pool_t * 		ptemp
apr_pool_t apr_pool_t apr_pool_t
*ptemp apr_pool_t apr_pool_t
apr_pool_t server_rec *s 		handler
apr_pool_t apr_pool_t apr_pool_t
*ptemp apr_pool_t apr_pool_t
apr_pool_t server_rec *s request_rec
*r 		optional_fn_retrieve

Detailed Description

Apache Configuration.

Definition in file http_config.h.

Define Documentation

#define AP_FLAG   func
 

Definition at line 152 of file http_config.h.

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

Definition at line 444 of file http_config.h.

Referenced by action_handler(), add_alias_internal(), add_auth_info(), add_cache_disable(), add_cache_enable(), add_cern_meta_data(), add_custom_log(), add_ignore_header(), add_include_vars_lazy(), add_module_info(), add_pass(), add_pass_reverse(), add_proxy(), add_redirect_internal(), add_setenvif_core(), anon_authenticate_basic_user(), ap_add_output_filters_by_type(), ap_add_per_proxy_conf(), AP_CORE_DECLARE(), ap_core_reorder_directories(), AP_DECLARE(), AP_DECLARE_NONSTD(), ap_headers_error_filter(), ap_headers_fixup(), ap_headers_insert_error_filter(), ap_headers_insert_output_filter(), ap_headers_output_filter(), ap_logio_add_bytes_out(), ap_process_http_connection(), ap_proxy_connect_handler(), ap_proxy_ftp_handler(), ap_proxy_http_create_connection(), ap_proxy_http_handler(), ap_response_code_string(), apprentice(), APR_OPTIONAL_FN_TYPE(), assign_childuid(), auth_ldap_post_config(), authenticate_basic_user(), authenticate_digest_user(), bucketeer_out_filter(), cache_create_entity(), CACHE_DECLARE(), cache_out_filter(), cache_save_filter(), cache_select_url(), cache_the_file(), CaseFilterEnable(), CaseFilterInEnable(), CaseFilterInInsertFilter(), CaseFilterInsertFilter(), cgi_handler(), cgid_handler(), cgid_server(), check_anon_access(), check_dir_access(), check_speling(), check_user_access(), cmd_rewritecond(), cmd_rewriteengine(), cmd_rewritelog(), cmd_rewriteloglevel(), cmd_rewritemap(), cmd_rewriteoptions(), cmd_rewriterule(), core_create_req(), core_insert_filter(), core_opts_merge(), core_override_type(), create_entity(), dav_fixups(), dav_fs_cmd_davlockdb(), dav_get_lockdb_path(), dav_get_provider(), dav_get_resource(), dav_method_lock(), dav_method_mkcol(), dav_method_propfind(), dbm_authenticate_basic_user(), dbm_check_auth(), default_handler(), define_filter(), deflate_in_filter(), deflate_out_filter(), deflate_set_buffer_size(), deflate_set_compressionlevel(), deflate_set_memlevel(), deflate_set_note(), deflate_set_window_size(), digest_check_auth(), do_cache_negotiated_docs(), dumpio_enable_input(), dumpio_enable_output(), dumpio_pre_conn(), echo_on(), expires_filter(), expires_insert_filter(), file_cache_handler(), file_cache_xlat(), find_code_page(), find_ct(), find_filter_def(), find_more_info(), fixup_dir(), fixup_env_module(), fixup_redir(), flush_all_logs(), get_suexec_id_doer(), handle_autoindex(), handle_echo(), hook_fixup(), hook_uri2file(), imap_handler_internal(), include_cmd(), include_fixup(), includes_filter(), includes_setup(), init_filter_instance(), is_redirect_limit_exceeded(), isapi_handler(), isSecureUpgraded(), LDAP_DECLARE(), load_module(), log_after(), log_before(), log_bytes_in(), log_bytes_out(), log_format(), logio_in_filter(), logio_transaction(), lookup_map(), magic_find_ct(), magic_init(), magic_rsl_add(), magic_rsl_to_request(), make_cookie(), match(), match_headers(), mime_post_config(), mod_auth_ldap_auth_checker(), mod_auth_ldap_check_user_id(), multi_log_transaction(), mva_translate(), net_time_filter(), open_entity(), open_log(), open_multi_logs(), open_rewritelog(), our_cconfig(), our_dconfig(), parse(), parse_accept_headers(), pass_request(), perchild_post_config(), perchild_post_read(), process_echo_connection(), PROXY_DECLARE(), proxy_detect(), proxy_handler(), proxy_trans(), proxy_walk(), reorder_sorter(), rewritelog(), rsl_strdup(), run_cgi_child(), run_rewritemap_programs(), send_req(), set_access_name(), set_allowed_ports(), set_bad_opt(), set_cache_complete(), set_cache_defex(), set_cache_dirlength(), set_cache_dirlevels(), set_cache_exchk(), set_cache_factor(), set_cache_ignore_cachecontrol(), set_cache_ignore_no_last_mod(), set_cache_maxex(), set_cache_maxfs(), set_cache_minfs(), set_cache_root(), set_cache_size(), set_cookie_exp(), set_default_end_tag(), set_default_start_tag(), set_document_root(), set_forensic_log(), set_io_buffer_size(), set_magicfile(), set_max_forwards(), set_preserve_host(), set_proxy_dirconn(), set_proxy_domain(), set_proxy_error_override(), set_proxy_exclude(), set_proxy_req(), set_proxy_timeout(), set_recursion_limit(), set_recv_buffer_size(), set_resource_limits(), set_script_socket(), set_scriptlog(), set_scriptlog_buffer(), set_scriptlog_length(), set_undefined_echo(), set_user_dir(), set_via_opt(), spot_cookie(), ssl_io_filter_Upgrade(), ssl_is_https(), store_body(), store_headers(), translate_alias_redir(), translate_userdir(), util_ldap_child_init(), util_ldap_cleanup_module(), util_ldap_handler(), util_ldap_post_config(), util_ldap_set_cache_bytes(), util_ldap_set_cache_entries(), util_ldap_set_cache_file(), util_ldap_set_cache_ttl(), util_ldap_set_cert_auth(), util_ldap_set_cert_type(), util_ldap_set_connection_timeout(), util_ldap_set_opcache_entries(), util_ldap_set_opcache_ttl(), vhost_alias_set(), xlate_in_filter(), xlate_insert_filter(), and xlate_out_filter().

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

Definition at line 176 of file http_config.h.

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

Definition at line 160 of file http_config.h.

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

Definition at line 166 of file http_config.h.

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

Definition at line 154 of file http_config.h.

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

Definition at line 156 of file http_config.h.

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

Definition at line 158 of file http_config.h.

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

Definition at line 164 of file http_config.h.

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

Definition at line 172 of file http_config.h.

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

Definition at line 168 of file http_config.h.

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

Definition at line 162 of file http_config.h.

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

Definition at line 170 of file http_config.h.

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

Definition at line 174 of file http_config.h.

#define AP_NO_ARGS   func
 

Definition at line 147 of file http_config.h.

#define AP_RAW_ARGS   func
 

Definition at line 148 of file http_config.h.

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

Definition at line 446 of file http_config.h.

Referenced by AP_CORE_DECLARE(), ap_proxy_ftp_handler(), ap_proxy_http_handler(), APR_OPTIONAL_FN_TYPE(), cache_negotiated_docs(), cache_save_filter(), core_create_req(), core_pre_connection(), file_cache_xlat(), find_code_page(), handle_include(), is_redirect_limit_exceeded(), log_before(), logio_pre_conn(), magic_set_config(), match_headers(), mod_auth_ldap_check_user_id(), nwssl_pre_connection(), parse_hdr_and_update_nc(), perchild_post_read(), set_charset_config(), and set_types_config().

#define AP_TAKE1   func
 

Definition at line 149 of file http_config.h.

#define AP_TAKE2   func
 

Definition at line 150 of file http_config.h.

#define AP_TAKE3   func
 

Definition at line 151 of file http_config.h.

#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 238 of file http_config.h.

Referenced by ap_walk_config_sub(), invoke_cmd(), set_dbm_slot(), and set_realm().

Typedef Documentation

typedef struct ap_conf_vector_t ap_conf_vector_t
 

configuration vector structure

Definition at line 418 of file http_config.h.

typedef struct ap_configfile_t ap_configfile_t
 

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

Definition at line 241 of file http_config.h.

typedef const char*(* cmd_func)()
 

Definition at line 145 of file http_config.h.

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 67 of file http_config.h.

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.

Definition at line 185 of file http_config.h.

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 302 of file http_config.h.

Enumeration Type Documentation

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...
Enumeration values:
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

Definition at line 44 of file http_config.h.

Function Documentation

AP_DECLARE (  ap_configfile_t *   ) 
 

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_DECLARE (  apr_status_t   ) 
 

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

AP_DECLARE (  module *   )  const
 

Find a module based on the name of the module

Parameters:
name the name of the module
Returns:
the module structure if found, NULL otherwise

AP_DECLARE (  char *   ) 
 

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 108 of file server/util.c.

References AP_DECLARE, apr_strftime(), f, and MAX_STRING_LEN.

Here is the call graph for this function:

AP_DECLARE (  int   ) 
 

Return true if the specified method is limited by being listed in a <limit> container, or by *not* being listed in a <limiteexcept> 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

Definition at line 445 of file http_protocol.c.

AP_DECLARE (  void   ) 
 

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 1271 of file http_protocol.c.

AP_DECLARE (  void *   )  const
 

Generic accessors for other modules to get 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 get the data for.
Returns:
The module-specific data

apr_pool_t apr_pool_t apr_pool_t* ptemp apr_pool_t apr_pool_t apr_pool_t server_rec* s 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.

apr_pool_t apr_pool_t apr_pool_t* ptemp apr_pool_t apr_pool_t apr_pool_t server_rec* s AP_DECLARE_HOOK (  void  ,
child_init  ,
(apr_pool_t *pchild, server_rec *s) 
) 
 

Run the handler functions for each module

Parameters:
r The request_rec
Remarks:
non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST

apr_pool_t apr_pool_t apr_pool_t* ptemp 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

Parameters:
pconf The config pool
plog The logging streams pool
ptemp The temporary pool
s The list of server_recs
Returns:
OK or DECLINED on success anything else is a error

AP_DECLARE_HOOK (  int  ,
header_parser  ,
(request_rec *r) 
) 
 

Run the pre_config function for each module

Parameters:
pconf The config pool
plog The logging streams pool
ptemp The temporary pool
Returns:
OK or DECLINED on success anything else is a error

AP_DECLARE_NONSTD (  const char *   ) 
 

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

Variable Documentation

void const char * arg
 

Definition at line 75 of file unixd.h.

Referenced by apr_wastrtoastr(), check_args(), main(), parse_args(), post_parse_fixup(), process_tags(), and warrsztoastr().

size_t bufsize
 

Definition at line 622 of file http_config.h.

Referenced by filepath_drive_get(), and mkrecord().

size_t ap_configfile_t* cfp
 

Definition at line 622 of file http_config.h.

Referenced by process_resource_config_nofnmatch().

const char void int(*) void*(*) int(* close_func)(void *param))
 

Definition at line 613 of file http_config.h.

Referenced by AP_DECLARE().

apr_pool_t* conf_pool
 

Definition at line 674 of file http_config.h.

apr_pool_t apr_pool_t ap_directive_t** conftree
 

Definition at line 674 of file http_config.h.

Referenced by include_config().

apr_pool_t cmd_parms ap_directive_t ap_directive_t** curr_parent
 

Definition at line 659 of file http_config.h.