http_request.h revision ed72af7cd93249aab8473c538fb3ec6d870badb2
* An internal handler used by the ap_process_request, all subrequest mechanisms * and the redirect mechanism. * @param r The request, subrequest or internal redirect to pre-process * @return The return code for the request * Create a subrequest from the given URI. This subrequest can be * inspected to find information about the requested URI * @param new_uri The URI to lookup * @param r The current request * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record * Create a subrequest for the given file. This subrequest can be * inspected to find information about the requested file * @param new_file The file to lookup * @param r The current request * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record * Create a subrequest for the given apr_dir_read result. This subrequest * can be inspected to find information about the requested file * @param finfo The apr_dir_read result to lookup * @param r The current request * @param subtype What 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 * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return 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. * Create a subrequest for the given URI using a specific method. This * subrequest can be inspected to find information about the requested URI * @param method The method to use in the new subrequest * @param new_uri The URI to lookup * @param r The current request * @param next_filter The first filter the sub_request should use. If this is * NULL, it defaults to the first filter for the main request * @return The new request record * 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. * @param f The current filter * @param bb The brigade to filter * Run the handler for the subrequest * @param r The subrequest to run * @return The return code for the subrequest * Free the memory associated with a subrequest * @param r The subrequest to finish * Then there's the case that you want some other request to be served * as the top-level request INSTEAD of what the client requested directly. * If so, call this from a handler, and then immediately return OK. * Redirect the current request to some other uri * @param new_uri The URI to replace the current request with * @param r The current request * This function is designed for things like actions or CGI scripts, when * using AddHandler, and you want to preserve the content type across * @param new_uri The URI to replace the current request with. * @param r The current request * Redirect the current request to a sub_req, merging the pools * @param sub_req A subrequest created from this request * @param r The 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! * Can be used within any handler to determine if any authentication * is required for the current request * @param r The current request * @return 1 if authentication is required, 0 otherwise * @defgroup APACHE_CORE_REQ_AUTH Access Control for Sub-Requests and * @ingroup APACHE_CORE_REQ internal requests with URIs distinct from that of initial configurations distinct from that of initial request */ * Clear flag which determines when access control hooks will be run for * Determine whether access control hooks will be run for all internal * requests with URIs distinct from that of the initial request, or only * those for which different configurations apply than those which applied * to the initial request. To accomodate legacy external modules which * may expect access control hooks to be run for all internal requests * with distinct URIs, this is the default behaviour unless all access * control hooks and authentication and authorization providers are * registered with AP_AUTH_INTERNAL_PER_CONF. * @param ptemp Pool used for temporary allocations * Register an authentication or authorization provider with the global * @param pool The pool to create any storage from * @param provider_group The group to store the provider in * @param provider_name The name for this provider * @param provider_version The version for this provider * @param provider Opaque structure for this provider * @param type Internal request processing mode, either * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF * @return APR_SUCCESS if all went well /* Optional functions coming from mod_authn_core and mod_authz_core * that list all registered authn/z providers. * Determine if the current request is the main request or a subrequest * @param r The current request * @return 1 if this is the main request, 0 otherwise * Function to set the r->mtime field to the specified value if it's later * than what's already there. * @param r The current request * @param dependency_mtime Time to set the mtime to * 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 * @param r The pointer to the request identifying the resource. * @param reset Boolean flag indicating whether this list should * completely replace any current settings. * @param ... A NULL-terminated list of strings, each identifying a * 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 * @param r The pointer to the request identifying the resource. * @param reset Boolean flag indicating whether this list should * completely replace any current settings. * @param ... 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") * Process a top-level request from a client, and synchronously write * the response to the client * @param r The current request * 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 * @param r The current request * Kill the current request * @param type Why the request is dieing * @param r The current request * Gives modules a chance to create their request_config entry when the * @param r The current request * This hook allow modules an opportunity to translate the URI into an * actual filename. If no modules do anything special, the server's default * rules will be followed. * @param r The current request * @return OK, DECLINED, or HTTP_... * This hook allow modules to set the per_dir_config based on their own * context (such as "<Proxy>" sections) and responds to contextless requests * such as TRACE that need no security or filesystem mapping. * based on the filesystem. * @param r The current request * @return DONE (or HTTP_) if this contextless request was just fulfilled * (such as TRACE), OK if this is not a file, and DECLINED if this is a file. * The core map_to_storage (HOOK_RUN_REALLY_LAST) will directory_walk * and file_walk the r->filename. * This hook is used to analyze the request headers, authenticate the user, * and set the user information in the request record (r->user and * r->ap_auth_type). This hook is only run when Apache determines that * by the 'Require' directive). It runs after the access_checker hook, and * before the auth_checker hook. This hook should be registered with * @param r The current request * @return OK, DECLINED, or HTTP_... * @see ap_hook_check_authn * Allows modules to perform module-specific fixing of header fields. This * is invoked just before any content-handler * @param r The current request * @return OK, DECLINED, or HTTP_... * This routine is called to determine and/or set the various document type * information bits, like Content-type (via r->content_type), language, et * @param r the current request * @return OK, DECLINED, or HTTP_... * This hook is used to apply additional access control to this resource. * It runs *before* a user is authenticated, so this hook is really to * apply additional restrictions independent of a user. It also runs * independent of 'Require' directive usage. This hook should be registered * with ap_hook_check_access(). * @param r the current request * @return OK, DECLINED, or HTTP_... * @see ap_hook_check_access * This hook is used to check to see if the resource being requested * is available for the authenticated user (r->user and r->ap_auth_type). * It runs after the access_checker and check_user_id hooks. Note that * it will *only* be called if Apache determines that access control has * been applied to this resource (through a 'Require' directive). This * hook should be registered with ap_hook_check_authz(). * @param r the current request * @return OK, DECLINED, or HTTP_... * @see ap_hook_check_authz * Register a hook function that will apply additional access control to * @param pf An access_checker hook function * @param aszPre A NULL-terminated array of strings that name modules whose * hooks should precede this one * @param aszSucc A NULL-terminated array of strings that name modules whose * hooks should succeed this one * @param nOrder An integer determining order before honouring aszPre and * aszSucc (for example, HOOK_MIDDLE) * @param type Internal request processing mode, either * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF * Register a hook function that will analyze the request headers, * authenticate the user, and set the user information in the request record. * @param pf A check_user_id hook function * @param aszPre A NULL-terminated array of strings that name modules whose * hooks should precede this one * @param aszSucc A NULL-terminated array of strings that name modules whose * hooks should succeed this one * @param nOrder An integer determining order before honouring aszPre and * aszSucc (for example, HOOK_MIDDLE) * @param type Internal request processing mode, either * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF * Register a hook function that determine if the resource being requested * is available for the currently authenticated user. * @param pf An auth_checker hook function * @param aszPre A NULL-terminated array of strings that name modules whose * hooks should precede this one * @param aszSucc A NULL-terminated array of strings that name modules whose * hooks should succeed this one * @param nOrder An integer determining order before honouring aszPre and * aszSucc (for example, HOOK_MIDDLE) * @param type Internal request processing mode, either * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF * This hook allows modules to insert filters for the current request * @param r the current request /** End Of REQUEST (EOR) bucket */ * Determine if a bucket is an End Of REQUEST (EOR) bucket * @param e The bucket to inspect * Make the bucket passed in an End Of REQUEST (EOR) bucket * @param b The bucket to make into an EOR bucket * @param r The request to destroy when this bucket is destroyed * @return The new bucket, or NULL if allocation failed * 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. * @param list The freelist from which this bucket should be allocated * @param r The request to destroy when this bucket is destroyed * @return The new bucket, or NULL if allocation failed #
endif /* !APACHE_HTTP_REQUEST_H */