Apache HTTPD
Modules | Classes | Macros | Typedefs | Functions | Variables
Apache Request Processing

Modules

 Access Control for Sub-Requests and
 

Classes

struct  ap_LINK_create_request_t
 
struct  ap_LINK_pre_translate_name_t
 
struct  ap_LINK_translate_name_t
 
struct  ap_LINK_map_to_storage_t
 
struct  ap_LINK_check_user_id_t
 
struct  ap_LINK_fixups_t
 
struct  ap_LINK_type_checker_t
 
struct  ap_LINK_access_checker_t
 
struct  ap_LINK_access_checker_ex_t
 
struct  ap_LINK_auth_checker_t
 
struct  ap_LINK_insert_filter_t
 
struct  ap_LINK_post_perdir_config_t
 
struct  ap_LINK_force_authn_t
 
struct  ap_LINK_dirwalk_stat_t
 

Macros

#define AP_SUBREQ_NO_ARGS   0
 
#define AP_SUBREQ_MERGE_ARGS   1
 
#define MERGE_ALLOW   0
 
#define REPLACE_ALLOW   1
 
#define AP_BUCKET_IS_EOR(e)   ((e)->type == &ap_bucket_type_eor)
 

Typedefs

typedef apr_array_header_t *() apr_OFN_authn_ap_list_provider_names_t(apr_pool_t *ptemp)
 
typedef apr_array_header_t *() apr_OFN_authz_ap_list_provider_names_t(apr_pool_t *ptemp)
 
typedef struct ap_LINK_create_request_t ap_LINK_create_request_t
 
typedef struct ap_LINK_pre_translate_name_t ap_LINK_pre_translate_name_t
 
typedef struct ap_LINK_translate_name_t ap_LINK_translate_name_t
 
typedef struct ap_LINK_map_to_storage_t ap_LINK_map_to_storage_t
 
typedef struct ap_LINK_check_user_id_t ap_LINK_check_user_id_t
 
typedef struct ap_LINK_fixups_t ap_LINK_fixups_t
 
typedef struct ap_LINK_type_checker_t ap_LINK_type_checker_t
 
typedef struct ap_LINK_access_checker_t ap_LINK_access_checker_t
 
typedef struct ap_LINK_access_checker_ex_t ap_LINK_access_checker_ex_t
 
typedef struct ap_LINK_auth_checker_t ap_LINK_auth_checker_t
 
typedef struct ap_LINK_insert_filter_t ap_LINK_insert_filter_t
 
typedef struct ap_LINK_post_perdir_config_t ap_LINK_post_perdir_config_t
 
typedef struct ap_LINK_force_authn_t ap_LINK_force_authn_t
 
typedef struct ap_LINK_dirwalk_stat_t ap_LINK_dirwalk_stat_t
 

Functions

int ap_process_request_internal (request_rec *r)
 
request_recap_sub_req_lookup_uri (const char *new_uri, const request_rec *r, ap_filter_t *next_filter)
 
request_recap_sub_req_lookup_file (const char *new_file, const request_rec *r, ap_filter_t *next_filter)
 
request_recap_sub_req_lookup_dirent (const apr_finfo_t *finfo, const request_rec *r, int subtype, ap_filter_t *next_filter)
 
request_recap_sub_req_method_uri (const char *method, const char *new_uri, const request_rec *r, ap_filter_t *next_filter)
 
apr_status_t ap_sub_req_output_filter (ap_filter_t *f, apr_bucket_brigade *bb)
 
int ap_run_sub_req (request_rec *r)
 
void ap_destroy_sub_req (request_rec *r)
 
void ap_internal_redirect (const char *new_uri, request_rec *r)
 
void ap_internal_redirect_handler (const char *new_uri, request_rec *r)
 
void ap_internal_fast_redirect (request_rec *sub_req, request_rec *r)
 
int ap_some_auth_required (request_rec *r)
 
int ap_is_initial_req (request_rec *r)
 
void ap_update_mtime (request_rec *r, apr_time_t dependency_mtime)
 
void ap_allow_methods (request_rec *r, int reset,...)
 
void ap_allow_standard_methods (request_rec *r, int reset,...)
 
void ap_process_request (request_rec *r)
 
void ap_process_request_after_handler (request_rec *r)
 
void ap_process_async_request (request_rec *r)
 
void ap_die (int type, request_rec *r)
 
apr_status_t ap_check_pipeline (conn_rec *c, apr_bucket_brigade *bb, unsigned int max_blank_lines)
 
void ap_hook_create_request (ap_HOOK_create_request_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_create_request (request_rec *r)
 
apr_array_header_tap_hook_get_create_request (void)
 
void ap_hook_pre_translate_name (ap_HOOK_pre_translate_name_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_pre_translate_name (request_rec *r)
 
apr_array_header_tap_hook_get_pre_translate_name (void)
 
void ap_hook_translate_name (ap_HOOK_translate_name_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_translate_name (request_rec *r)
 
apr_array_header_tap_hook_get_translate_name (void)
 
void ap_hook_map_to_storage (ap_HOOK_map_to_storage_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_map_to_storage (request_rec *r)
 
apr_array_header_tap_hook_get_map_to_storage (void)
 
void ap_hook_check_user_id (ap_HOOK_check_user_id_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_check_user_id (request_rec *r)
 
apr_array_header_tap_hook_get_check_user_id (void)
 
void ap_hook_fixups (ap_HOOK_fixups_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_fixups (request_rec *r)
 
apr_array_header_tap_hook_get_fixups (void)
 
void ap_hook_type_checker (ap_HOOK_type_checker_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_type_checker (request_rec *r)
 
apr_array_header_tap_hook_get_type_checker (void)
 
void ap_hook_access_checker (ap_HOOK_access_checker_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_access_checker (request_rec *r)
 
apr_array_header_tap_hook_get_access_checker (void)
 
void ap_hook_access_checker_ex (ap_HOOK_access_checker_ex_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_access_checker_ex (request_rec *r)
 
apr_array_header_tap_hook_get_access_checker_ex (void)
 
void ap_hook_auth_checker (ap_HOOK_auth_checker_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_auth_checker (request_rec *r)
 
apr_array_header_tap_hook_get_auth_checker (void)
 
void ap_hook_check_access (ap_HOOK_access_checker_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder, int type)
 
void ap_hook_check_access_ex (ap_HOOK_access_checker_ex_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder, int type)
 
void ap_hook_check_authn (ap_HOOK_check_user_id_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder, int type)
 
void ap_hook_check_authz (ap_HOOK_auth_checker_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder, int type)
 
void ap_hook_insert_filter (ap_HOOK_insert_filter_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
void ap_run_insert_filter (request_rec *r)
 
apr_array_header_tap_hook_get_insert_filter (void)
 
void ap_hook_post_perdir_config (ap_HOOK_post_perdir_config_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_post_perdir_config (request_rec *r)
 
apr_array_header_tap_hook_get_post_perdir_config (void)
 
void ap_hook_force_authn (ap_HOOK_force_authn_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
int ap_run_force_authn (request_rec *r)
 
apr_array_header_tap_hook_get_force_authn (void)
 
void ap_hook_dirwalk_stat (ap_HOOK_dirwalk_stat_t *pf, const char *const *aszPre, const char *const *aszSucc, int nOrder)
 
apr_status_t ap_run_dirwalk_stat (apr_finfo_t *finfo, request_rec *r, apr_int32_t wanted)
 
apr_array_header_tap_hook_get_dirwalk_stat (void)
 
int ap_location_walk (request_rec *r)
 
int ap_directory_walk (request_rec *r)
 
int ap_file_walk (request_rec *r)
 
int ap_if_walk (request_rec *r)
 
apr_bucketap_bucket_eor_make (apr_bucket *b, request_rec *r)
 
apr_bucketap_bucket_eor_create (apr_bucket_alloc_t *list, request_rec *r)
 
int ap_some_authn_required (request_rec *r)
 

Variables

const apr_bucket_type_t ap_bucket_type_eor
 

Detailed Description

Macro Definition Documentation

◆ AP_BUCKET_IS_EOR

#define AP_BUCKET_IS_EOR (   e)    ((e)->type == &ap_bucket_type_eor)

Determine if a bucket is an End Of REQUEST (EOR) bucket

Parameters
eThe bucket to inspect
Returns
true or false

Definition at line 604 of file http_request.h.

◆ AP_SUBREQ_MERGE_ARGS

#define AP_SUBREQ_MERGE_ARGS   1

Definition at line 58 of file http_request.h.

◆ AP_SUBREQ_NO_ARGS

#define AP_SUBREQ_NO_ARGS   0

Definition at line 57 of file http_request.h.

◆ MERGE_ALLOW

#define MERGE_ALLOW   0

Definition at line 310 of file http_request.h.

◆ REPLACE_ALLOW

#define REPLACE_ALLOW   1

Definition at line 311 of file http_request.h.

Typedef Documentation

◆ ap_LINK_access_checker_ex_t

◆ ap_LINK_access_checker_t

◆ ap_LINK_auth_checker_t

◆ ap_LINK_check_user_id_t

◆ ap_LINK_create_request_t

◆ ap_LINK_dirwalk_stat_t

◆ ap_LINK_fixups_t

◆ ap_LINK_force_authn_t

◆ ap_LINK_insert_filter_t

◆ ap_LINK_map_to_storage_t

◆ ap_LINK_post_perdir_config_t

◆ ap_LINK_pre_translate_name_t

◆ ap_LINK_translate_name_t

◆ ap_LINK_type_checker_t

◆ apr_OFN_authn_ap_list_provider_names_t

typedef apr_array_header_t *() apr_OFN_authn_ap_list_provider_names_t(apr_pool_t *ptemp)

Definition at line 255 of file http_request.h.

◆ apr_OFN_authz_ap_list_provider_names_t

typedef apr_array_header_t *() apr_OFN_authz_ap_list_provider_names_t(apr_pool_t *ptemp)

Definition at line 257 of file http_request.h.

Function Documentation

◆ ap_allow_methods()

void ap_allow_methods ( request_rec r,
int  reset,
  ... 
)

Add one or more methods to the list permitted to access the resource. Usually executed by the content handler before the response header is sent, but sometimes invoked at an earlier phase if a module knows it can set the list authoritatively. Note that the methods are ADDED to any already permitted unless the reset flag is non-zero. The list is used to generate the Allow response header field when it is needed.

Parameters
rThe pointer to the request identifying the resource.
resetBoolean flag indicating whether this list should completely replace any current settings.
...A NULL-terminated list of strings, each identifying a method name to add.
Returns
None.

Definition at line 819 of file http_request.c.

◆ ap_allow_standard_methods()

void ap_allow_standard_methods ( request_rec r,
int  reset,
  ... 
)

Add one or more methods to the list permitted to access the resource. Usually executed by the content handler before the response header is sent, but sometimes invoked at an earlier phase if a module knows it can set the list authoritatively. Note that the methods are ADDED to any already permitted unless the reset flag is non-zero. The list is used to generate the Allow response header field when it is needed.

Parameters
rThe pointer to the request identifying the resource.
resetBoolean flag indicating whether this list should completely replace any current settings.
...A list of method identifiers, from the "M_" series defined in httpd.h, terminated with a value of -1 (e.g., "M_GET, M_POST, M_OPTIONS, -1")
Returns
None.

Definition at line 839 of file http_request.c.

◆ ap_bucket_eor_create()

apr_bucket * ap_bucket_eor_create ( apr_bucket_alloc_t list,
request_rec r 
)

Create a bucket referring to an End Of REQUEST (EOR). This bucket holds a pointer to the request_rec, so that the request can be destroyed right after all of the output has been sent to the client.

Parameters
listThe freelist from which this bucket should be allocated
rThe request to destroy when this bucket is destroyed
Returns
The new bucket, or NULL if allocation failed

Definition at line 68 of file eor_bucket.c.

◆ ap_bucket_eor_make()

apr_bucket * ap_bucket_eor_make ( apr_bucket b,
request_rec r 
)

Make the bucket passed in an End Of REQUEST (EOR) bucket

Parameters
bThe bucket to make into an EOR bucket
rThe request to destroy when this bucket is destroyed
Returns
The new bucket, or NULL if allocation failed

Definition at line 56 of file eor_bucket.c.

◆ ap_check_pipeline()

apr_status_t ap_check_pipeline ( conn_rec c,
apr_bucket_brigade bb,
unsigned int  max_blank_lines 
)

Check whether a connection is still established and has data available, optionally consuming blank lines ([CR]LF).

Parameters
cThe current connection
bbThe brigade to filter
max_blank_linesMax number of blank lines to consume, or zero to consider them as data (single read).
Returns
APR_SUCCESS: connection established with data available, APR_EAGAIN: connection established and empty, APR_NOTFOUND: too much blank lines, APR_E*: connection/general error.

Definition at line 237 of file http_request.c.

◆ ap_destroy_sub_req()

void ap_destroy_sub_req ( request_rec r)

Free the memory associated with a subrequest

Parameters
rThe subrequest to finish

Definition at line 2547 of file request.c.

◆ ap_die()

void ap_die ( int  type,
request_rec r 
)

Kill the current request

Parameters
typeWhy the request is dying
rThe current request

Definition at line 232 of file http_request.c.

◆ ap_directory_walk()

int ap_directory_walk ( request_rec r)

< Module has handled this stage.

< Module has handled this stage.

< type, mtime, ctime, atime, size

< type, mtime, ctime, atime, size

< ->name in proper case

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

< Module has handled this stage.

< Module has handled this stage.

< Type

< Slash must be matched by slash.

< type, mtime, ctime, atime, size

< ->name in proper case

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

< Type

< ->name in proper case

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

Definition at line 661 of file request.c.

◆ ap_file_walk()

int ap_file_walk ( request_rec r)

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Slash must be matched by slash.

< Module has handled this stage.

< Module has handled this stage.

Definition at line 1655 of file request.c.

◆ ap_hook_access_checker()

void ap_hook_access_checker ( ap_HOOK_access_checker_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 91 of file request.c.

◆ ap_hook_access_checker_ex()

void ap_hook_access_checker_ex ( ap_HOOK_access_checker_ex_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 93 of file request.c.

◆ ap_hook_auth_checker()

void ap_hook_auth_checker ( ap_HOOK_auth_checker_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 95 of file request.c.

◆ ap_hook_check_access()

void ap_hook_check_access ( ap_HOOK_access_checker_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder,
int  type 
)

Register a hook function that will apply additional access control to the current request.

Parameters
pfAn access_checker hook function
aszPreA NULL-terminated array of strings that name modules whose hooks should precede this one
aszSuccA NULL-terminated array of strings that name modules whose hooks should succeed this one
nOrderAn integer determining order before honouring aszPre and aszSucc (for example, HOOK_MIDDLE)
typeInternal request processing mode, either AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF

< mask to extract internal request processing mode

< Run access control hooks only on internal requests with configurations distinct from that of initial request

Definition at line 2194 of file request.c.

◆ ap_hook_check_access_ex()

void ap_hook_check_access_ex ( ap_HOOK_access_checker_ex_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder,
int  type 
)

Register a hook function that will apply additional access control and/or bypass authentication for the current request.

Parameters
pfAn access_checker_ex hook function
aszPreA NULL-terminated array of strings that name modules whose hooks should precede this one
aszSuccA NULL-terminated array of strings that name modules whose hooks should succeed this one
nOrderAn integer determining order before honouring aszPre and aszSucc (for example, HOOK_MIDDLE)
typeInternal request processing mode, either AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF

< mask to extract internal request processing mode

< Run access control hooks only on internal requests with configurations distinct from that of initial request

Definition at line 2206 of file request.c.

◆ ap_hook_check_authn()

void ap_hook_check_authn ( ap_HOOK_check_user_id_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder,
int  type 
)

Register a hook function that will analyze the request headers, authenticate the user, and set the user information in the request record.

Parameters
pfA check_user_id hook function
aszPreA NULL-terminated array of strings that name modules whose hooks should precede this one
aszSuccA NULL-terminated array of strings that name modules whose hooks should succeed this one
nOrderAn integer determining order before honouring aszPre and aszSucc (for example, HOOK_MIDDLE)
typeInternal request processing mode, either AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF

< mask to extract internal request processing mode

< Run access control hooks only on internal requests with configurations distinct from that of initial request

Definition at line 2218 of file request.c.

◆ ap_hook_check_authz()

void ap_hook_check_authz ( ap_HOOK_auth_checker_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder,
int  type 
)

Register a hook function that determine if the resource being requested is available for the currently authenticated user.

Parameters
pfAn auth_checker hook function
aszPreA NULL-terminated array of strings that name modules whose hooks should precede this one
aszSuccA NULL-terminated array of strings that name modules whose hooks should succeed this one
nOrderAn integer determining order before honouring aszPre and aszSucc (for example, HOOK_MIDDLE)
typeInternal request processing mode, either AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF

< mask to extract internal request processing mode

< Run access control hooks only on internal requests with configurations distinct from that of initial request

Definition at line 2230 of file request.c.

◆ ap_hook_check_user_id()

void ap_hook_check_user_id ( ap_HOOK_check_user_id_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 85 of file request.c.

◆ ap_hook_create_request()

void ap_hook_create_request ( ap_HOOK_create_request_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 98 of file request.c.

◆ ap_hook_dirwalk_stat()

void ap_hook_dirwalk_stat ( ap_HOOK_dirwalk_stat_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 103 of file request.c.

◆ ap_hook_fixups()

void ap_hook_fixups ( ap_HOOK_fixups_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 87 of file request.c.

◆ ap_hook_force_authn()

void ap_hook_force_authn ( ap_HOOK_force_authn_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 105 of file request.c.

◆ ap_hook_get_access_checker()

apr_array_header_t * ap_hook_get_access_checker ( void  )

Definition at line 91 of file request.c.

◆ ap_hook_get_access_checker_ex()

apr_array_header_t * ap_hook_get_access_checker_ex ( void  )

Definition at line 93 of file request.c.

◆ ap_hook_get_auth_checker()

apr_array_header_t * ap_hook_get_auth_checker ( void  )

Definition at line 95 of file request.c.

◆ ap_hook_get_check_user_id()

apr_array_header_t * ap_hook_get_check_user_id ( void  )

Definition at line 85 of file request.c.

◆ ap_hook_get_create_request()

apr_array_header_t * ap_hook_get_create_request ( void  )

Definition at line 98 of file request.c.

◆ ap_hook_get_dirwalk_stat()

apr_array_header_t * ap_hook_get_dirwalk_stat ( void  )

Definition at line 103 of file request.c.

◆ ap_hook_get_fixups()

apr_array_header_t * ap_hook_get_fixups ( void  )

Definition at line 87 of file request.c.

◆ ap_hook_get_force_authn()

apr_array_header_t * ap_hook_get_force_authn ( void  )

Definition at line 105 of file request.c.

◆ ap_hook_get_insert_filter()

apr_array_header_t * ap_hook_get_insert_filter ( void  )

Definition at line 96 of file request.c.

◆ ap_hook_get_map_to_storage()

apr_array_header_t * ap_hook_get_map_to_storage ( void  )

Definition at line 83 of file request.c.

◆ ap_hook_get_post_perdir_config()

apr_array_header_t * ap_hook_get_post_perdir_config ( void  )

Definition at line 100 of file request.c.

◆ ap_hook_get_pre_translate_name()

apr_array_header_t * ap_hook_get_pre_translate_name ( void  )

Definition at line 79 of file request.c.

◆ ap_hook_get_translate_name()

apr_array_header_t * ap_hook_get_translate_name ( void  )

Definition at line 81 of file request.c.

◆ ap_hook_get_type_checker()

apr_array_header_t * ap_hook_get_type_checker ( void  )

Definition at line 89 of file request.c.

◆ ap_hook_insert_filter()

void ap_hook_insert_filter ( ap_HOOK_insert_filter_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 96 of file request.c.

◆ ap_hook_map_to_storage()

void ap_hook_map_to_storage ( ap_HOOK_map_to_storage_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 83 of file request.c.

◆ ap_hook_post_perdir_config()

void ap_hook_post_perdir_config ( ap_HOOK_post_perdir_config_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 100 of file request.c.

◆ ap_hook_pre_translate_name()

void ap_hook_pre_translate_name ( ap_HOOK_pre_translate_name_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 79 of file request.c.

◆ ap_hook_translate_name()

void ap_hook_translate_name ( ap_HOOK_translate_name_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 81 of file request.c.

◆ ap_hook_type_checker()

void ap_hook_type_checker ( ap_HOOK_type_checker_t pf,
const char *const aszPre,
const char *const aszSucc,
int  nOrder 
)

Definition at line 89 of file request.c.

◆ ap_if_walk()

int ap_if_walk ( request_rec r)

Definition at line 1992 of file request.c.

◆ ap_internal_fast_redirect()

void ap_internal_fast_redirect ( request_rec sub_req,
request_rec r 
)

Redirect the current request to a sub_req, merging the pools

Parameters
sub_reqA subrequest created from this request
rThe current request
Note
the sub_req's pool will be merged into r's pool, be very careful not to destroy this subrequest, it will be destroyed with the main request!

Definition at line 692 of file http_request.c.

◆ ap_internal_redirect()

void ap_internal_redirect ( const char new_uri,
request_rec r 
)

Redirect the current request to some other uri

Parameters
new_uriThe URI to replace the current request with
rThe current request

< Module declines to handle

< Module has handled this stage.

Definition at line 774 of file http_request.c.

◆ ap_internal_redirect_handler()

void ap_internal_redirect_handler ( const char new_uri,
request_rec r 
)

This function is designed for things like actions or CGI scripts, when using AddHandler, and you want to preserve the content type across an internal redirect.

Parameters
new_uriThe URI to replace the current request with.
rThe current request

< Module has handled this stage.

Definition at line 800 of file http_request.c.

◆ ap_is_initial_req()

int ap_is_initial_req ( request_rec r)

Determine if the current request is the main request or a subrequest

Parameters
rThe current request
Returns
1 if this is the main request, 0 otherwise

Definition at line 2567 of file request.c.

◆ ap_location_walk()

int ap_location_walk ( request_rec r)

< Module has handled this stage.

< Module has handled this stage.

< Slash must be matched by slash.

< Module has handled this stage.

< Module has handled this stage.

Definition at line 1452 of file request.c.

◆ ap_process_async_request()

void ap_process_async_request ( request_rec r)

Process a top-level request from a client, allowing some or all of the response to remain buffered in the core output filter for later, asynchronous write completion

Parameters
rThe current request

< Module declines to handle

< Module has handled this stage.

< Module will handle the remainder of the request. * The core will never invoke the request again,

Definition at line 407 of file http_request.c.

◆ ap_process_request()

void ap_process_request ( request_rec r)

Process a top-level request from a client, and synchronously write the response to the client

Parameters
rThe current request

Definition at line 480 of file http_request.c.

◆ ap_process_request_after_handler()

void ap_process_request_after_handler ( request_rec r)

Definition at line 358 of file http_request.c.

◆ ap_process_request_internal()

int ap_process_request_internal ( request_rec r)

An internal handler used by the ap_process_request, all subrequest mechanisms and the redirect mechanism.

Parameters
rThe request, subrequest or internal redirect to pre-process
Returns
The return code for the request

< Module declines to handle

< Module has served the response completely * - it's safe to die() with no more output

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

< Module has handled this stage.

Definition at line 187 of file request.c.

◆ ap_run_access_checker()

int ap_run_access_checker ( 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 91 of file request.c.

◆ ap_run_access_checker_ex()

int ap_run_access_checker_ex ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 93 of file request.c.

◆ ap_run_auth_checker()

int ap_run_auth_checker ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 95 of file request.c.

◆ ap_run_check_user_id()

int ap_run_check_user_id ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 85 of file request.c.

◆ ap_run_create_request()

int ap_run_create_request ( 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 98 of file request.c.

◆ ap_run_dirwalk_stat()

apr_status_t ap_run_dirwalk_stat ( apr_finfo_t finfo,
request_rec r,
apr_int32_t  wanted 
)

Definition at line 103 of file request.c.

◆ ap_run_fixups()

int ap_run_fixups ( 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 87 of file request.c.

◆ ap_run_force_authn()

int ap_run_force_authn ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 105 of file request.c.

◆ ap_run_insert_filter()

void ap_run_insert_filter ( request_rec r)

Definition at line 96 of file request.c.

◆ ap_run_map_to_storage()

int ap_run_map_to_storage ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 83 of file request.c.

◆ ap_run_post_perdir_config()

int ap_run_post_perdir_config ( 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 100 of file request.c.

◆ ap_run_pre_translate_name()

int ap_run_pre_translate_name ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 79 of file request.c.

◆ ap_run_sub_req()

int ap_run_sub_req ( request_rec r)

Run the handler for the subrequest

Parameters
rThe subrequest to run
Returns
The return code for the subrequest

< Module declines to handle

< Module has handled this stage.

< Module has served the response completely * - it's safe to die() with no more output

< Module has handled this stage.

Definition at line 2528 of file request.c.

◆ ap_run_translate_name()

int ap_run_translate_name ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 81 of file request.c.

◆ ap_run_type_checker()

int ap_run_type_checker ( request_rec r)

< Module declines to handle

< Module declines to handle

Definition at line 89 of file request.c.

◆ ap_some_auth_required()

int ap_some_auth_required ( request_rec r)

Can be used within any handler to determine if any authentication is required for the current request

Parameters
rThe current request
Returns
1 if authentication is required, 0 otherwise
Bug:
Behavior changed in 2.4.x refactoring, API no longer usable
Deprecated:
See also
ap_some_authn_required()

Definition at line 2125 of file request.c.

◆ ap_some_authn_required()

int ap_some_authn_required ( request_rec r)

Can be used within any handler to determine if any authentication is required for the current request. Note that if used with an access_checker hook, an access_checker_ex hook or an authz provider; the caller should take steps to avoid a loop since this function is implemented by calling these hooks.

Parameters
rThe current request
Returns
TRUE if authentication is required, FALSE otherwise

< Module has handled this stage.

< Module declines to handle

< Module has handled this stage.

< Module declines to handle

Definition at line 127 of file request.c.

◆ ap_sub_req_lookup_dirent()

request_rec * ap_sub_req_lookup_dirent ( const apr_finfo_t finfo,
const request_rec r,
int  subtype,
ap_filter_t next_filter 
)

Create a subrequest for the given apr_dir_read result. This subrequest can be inspected to find information about the requested file

Parameters
finfoThe apr_dir_read result to lookup
rThe current request
subtypeWhat type of subrequest to perform, one of;
     AP_SUBREQ_NO_ARGS     ignore r->args and r->path_info
     AP_SUBREQ_MERGE_ARGS  merge r->args and r->path_info
next_filterThe first filter the sub_request should use. If this is NULL, it defaults to the first filter for the main request
Returns
The new request record
Note
The apr_dir_read flags value APR_FINFO_MIN|APR_FINFO_NAME flag is the minimum recommended query if the results will be passed to apr_dir_read. The file info passed must include the name, and must have the same relative directory as the current request.

< type, mtime, ctime, atime, size

< type, mtime, ctime, atime, size

< type, mtime, ctime, atime, size

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

< type, mtime, ctime, atime, size

< Module has handled this stage.

Definition at line 2304 of file request.c.

◆ ap_sub_req_lookup_file()

request_rec * ap_sub_req_lookup_file ( const char new_file,
const request_rec r,
ap_filter_t next_filter 
)

Create a subrequest for the given file. This subrequest can be inspected to find information about the requested file

Parameters
new_fileThe file to lookup
rThe current request
next_filterThe first filter the sub_request should use. If this is NULL, it defaults to the first filter for the main request
Returns
The new request record

< type, mtime, ctime, atime, size

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

< type, mtime, ctime, atime, size

Definition at line 2433 of file request.c.

◆ ap_sub_req_lookup_uri()

request_rec * ap_sub_req_lookup_uri ( const char new_uri,
const request_rec r,
ap_filter_t next_filter 
)

Create a subrequest from the given URI. This subrequest can be inspected to find information about the requested URI

Parameters
new_uriThe URI to lookup
rThe current request
next_filterThe first filter the sub_request should use. If this is NULL, it defaults to the first filter for the main request
Returns
The new request record

Definition at line 2297 of file request.c.

◆ ap_sub_req_method_uri()

request_rec * ap_sub_req_method_uri ( const char method,
const char new_uri,
const request_rec r,
ap_filter_t next_filter 
)

Create a subrequest for the given URI using a specific method. This subrequest can be inspected to find information about the requested URI

Parameters
methodThe method to use in the new subrequest
new_uriThe URI to lookup
rThe current request
next_filterThe first filter the sub_request should use. If this is NULL, it defaults to the first filter for the main request
Returns
The new request record

< Module has handled this stage.

Definition at line 2242 of file request.c.

◆ ap_sub_req_output_filter()

apr_status_t ap_sub_req_output_filter ( ap_filter_t f,
apr_bucket_brigade bb 
)

An output filter to strip EOS buckets from sub-requests. This always has to be inserted at the end of a sub-requests filter stack.

Parameters
fThe current filter
bbThe brigade to filter
Returns
status code

Definition at line 2107 of file request.c.

◆ ap_update_mtime()

void ap_update_mtime ( request_rec r,
apr_time_t  dependency_mtime 
)

Function to set the r->mtime field to the specified value if it's later than what's already there.

Parameters
rThe current request
dependency_mtimeTime to set the mtime to

Definition at line 2557 of file request.c.

Variable Documentation

◆ ap_bucket_type_eor

const apr_bucket_type_t ap_bucket_type_eor
extern

End Of REQUEST (EOR) bucket

Definition at line 107 of file eor_bucket.c.