mirror of
https://github.com/apache/httpd.git
synced 2025-08-01 16:41:19 +00:00
3db323656f
from the primary request, redirects and sub-requests. This will significantly reduce opporunities for inconsistancy (such as Ian observed, and as I repaired only a month ago.) This promotes process_request_internal to an ap_ namespace protected entity in server/request.c (from it's old home in http/http_request.c) since this fn has no http specifics. Reviewed (in concept): Cliff Woolley, Ian Holsman git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@90832 13f79535-47bb-0310-9956-ffa450edef68
376 lines
15 KiB
C
376 lines
15 KiB
C
/* ====================================================================
|
|
* The Apache Software License, Version 1.1
|
|
*
|
|
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
|
|
* reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* 3. The end-user documentation included with the redistribution,
|
|
* if any, must include the following acknowledgment:
|
|
* "This product includes software developed by the
|
|
* Apache Software Foundation (http://www.apache.org/)."
|
|
* Alternately, this acknowledgment may appear in the software itself,
|
|
* if and wherever such third-party acknowledgments normally appear.
|
|
*
|
|
* 4. The names "Apache" and "Apache Software Foundation" must
|
|
* not be used to endorse or promote products derived from this
|
|
* software without prior written permission. For written
|
|
* permission, please contact apache@apache.org.
|
|
*
|
|
* 5. Products derived from this software may not be called "Apache",
|
|
* nor may "Apache" appear in their name, without prior written
|
|
* permission of the Apache Software Foundation.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
|
|
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
|
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
* ====================================================================
|
|
*
|
|
* This software consists of voluntary contributions made by many
|
|
* individuals on behalf of the Apache Software Foundation. For more
|
|
* information on the Apache Software Foundation, please see
|
|
* <http://www.apache.org/>.
|
|
*
|
|
* Portions of this software are based upon public domain software
|
|
* originally written at the National Center for Supercomputing Applications,
|
|
* University of Illinois, Urbana-Champaign.
|
|
*/
|
|
|
|
#ifndef APACHE_HTTP_REQUEST_H
|
|
#define APACHE_HTTP_REQUEST_H
|
|
|
|
#include "apr_hooks.h"
|
|
#include "util_filter.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @file http_request.h
|
|
* @brief Apache Request library
|
|
*/
|
|
|
|
/* http_request.c is the code which handles the main line of request
|
|
* processing, once a request has been read in (finding the right per-
|
|
* directory configuration, building it if necessary, and calling all
|
|
* the module dispatch functions in the right order).
|
|
*
|
|
* The pieces here which are public to the modules, allow them to learn
|
|
* how the server would handle some other file or URI, or perhaps even
|
|
* direct the server to serve that other file instead of the one the
|
|
* client requested directly.
|
|
*
|
|
* There are two ways to do that. The first is the sub_request mechanism,
|
|
* which handles looking up files and URIs as adjuncts to some other
|
|
* request (e.g., directory entries for multiviews and directory listings);
|
|
* the lookup functions stop short of actually running the request, but
|
|
* (e.g., for includes), a module may call for the request to be run
|
|
* by calling run_sub_req. The space allocated to create sub_reqs can be
|
|
* reclaimed by calling destroy_sub_req --- be sure to copy anything you care
|
|
* about which was allocated in its apr_pool_t elsewhere before doing this.
|
|
*/
|
|
|
|
/**
|
|
* An internal handler used by the ap_process_request, all sub request mechanisms
|
|
* and the redirect mechanism.
|
|
* @param r The request, subrequest or internal redirect to pre-process
|
|
* @return The return code for the request
|
|
*/
|
|
AP_DECLARE(int) ap_process_request_internal(request_rec *r);
|
|
|
|
/**
|
|
* Create a sub request from the given URI. This sub request can be
|
|
* inspected to find information about the requested URI
|
|
* @param new_file 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
|
|
* @deffunc request_rec * ap_sub_req_lookup_uri(const char *new_file, const request_rec *r)
|
|
*/
|
|
AP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_file,
|
|
const request_rec *r,
|
|
ap_filter_t *next_filter);
|
|
|
|
/**
|
|
* Create a sub request for the given file. This sub request can be
|
|
* inspected to find information about the requested file
|
|
* @param new_file 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
|
|
* @deffunc request_rec * ap_sub_req_lookup_file(const char *new_file, const request_rec *r)
|
|
*/
|
|
AP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file,
|
|
const request_rec *r,
|
|
ap_filter_t *next_filter);
|
|
/**
|
|
* Create a sub request for the given apr_dir_read result. This sub request
|
|
* 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 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
|
|
* @deffunc request_rec * ap_sub_req_lookup_dirent(apr_finfo_t *finfo, const request_rec *r)
|
|
* @tip 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.
|
|
*/
|
|
AP_DECLARE(request_rec *) ap_sub_req_lookup_dirent(const apr_finfo_t *finfo,
|
|
const request_rec *r,
|
|
ap_filter_t *next_filter);
|
|
/**
|
|
* Create a sub request for the given URI using a specific method. This
|
|
* sub request can be inspected to find information about the requested URI
|
|
* @param method The method to use in the new sub request
|
|
* @param new_file 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
|
|
* @deffunc request_rec * ap_sub_req_method_uri(const char *method, const char *new_file, const request_rec *r)
|
|
*/
|
|
AP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method,
|
|
const char *new_file,
|
|
const request_rec *r,
|
|
ap_filter_t *next_filter);
|
|
/**
|
|
* 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
|
|
* @deffunc apr_status_t ap_sub_req_output_filter(ap_filter_t *f, apr_bucket_brigade *bb)
|
|
*/
|
|
AP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f,
|
|
apr_bucket_brigade *bb);
|
|
|
|
/**
|
|
* Run the handler for the sub request
|
|
* @param r The sub request to run
|
|
* @return The return code for the sub request
|
|
* @deffunc int ap_run_sub_req(request_rec *r)
|
|
*/
|
|
AP_DECLARE(int) ap_run_sub_req(request_rec *r);
|
|
|
|
/**
|
|
* Free the memory associated with a sub request
|
|
* @param r The sub request to finish
|
|
* @deffunc void ap_destroy_sub_req(request_rec *r)
|
|
*/
|
|
AP_DECLARE(void) ap_destroy_sub_req(request_rec *r);
|
|
|
|
/*
|
|
* 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
|
|
* @deffunc void ap_internal_redirect(const char *new_uri, request_rec *r)
|
|
*/
|
|
AP_DECLARE(void) ap_internal_redirect(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.
|
|
* @param new_uri The URI to replace the current request with.
|
|
* @param r The current request
|
|
* @deffunc void ap_internal_redirect_handler(const char *new_uri, request_rec *r)
|
|
*/
|
|
AP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r);
|
|
|
|
/**
|
|
* 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
|
|
* @deffunc void ap_internal_fast_redirect(request_rec *sub_req, request_rec *r)
|
|
* @tip 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!
|
|
*/
|
|
AP_DECLARE(void) ap_internal_fast_redirect(request_rec *sub_req, request_rec *r);
|
|
|
|
/**
|
|
* 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
|
|
* @deffunc int ap_some_auth_required(request_rec *r)
|
|
*/
|
|
AP_DECLARE(int) ap_some_auth_required(request_rec *r);
|
|
|
|
/**
|
|
* Determine if the current request is the main request or a sub requests
|
|
* @param r The current request
|
|
* @retrn 1 if this is a main request, 0 otherwise
|
|
* @deffunc int ap_is_initial_req(request_rec *r)
|
|
*/
|
|
AP_DECLARE(int) ap_is_initial_req(request_rec *r);
|
|
|
|
/**
|
|
* 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_time Time to set the mtime to
|
|
* @deffunc void ap_update_mtime(request_rec *r, apr_time_t dependency_mtime)
|
|
*/
|
|
AP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime);
|
|
|
|
/**
|
|
* 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.
|
|
* @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
|
|
* method name to add.
|
|
* @return None.
|
|
* @deffunc void ap_allow_methods(request_rec *r, int reset, ...)
|
|
*/
|
|
AP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...);
|
|
|
|
#define MERGE_ALLOW 0
|
|
#define REPLACE_ALLOW 1
|
|
|
|
#ifdef CORE_PRIVATE
|
|
/* Function called by main.c to handle first-level request */
|
|
void ap_process_request(request_rec *);
|
|
/**
|
|
* Kill the current request
|
|
* @param type Why the request is dieing
|
|
* @param r The current request
|
|
* @deffunc void ap_die(int type, request_rec *r)
|
|
*/
|
|
AP_DECLARE(void) ap_die(int type, request_rec *r);
|
|
#endif
|
|
|
|
/* Hooks */
|
|
|
|
/**
|
|
* Gives modules a chance to create their request_config entry when the
|
|
* request is created.
|
|
* @param r The current request
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,create_request,(request_rec *r))
|
|
|
|
/**
|
|
* 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_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,translate_name,(request_rec *r))
|
|
|
|
/**
|
|
* 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_LAST) will directory_walk and file_walk
|
|
* the r->filename.
|
|
*
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,map_to_storage,(request_rec *r))
|
|
|
|
/**
|
|
* This hook allows modules to check the authentication information sent with
|
|
* the request.
|
|
* @param r The current request
|
|
* @return OK, DECLINED, or HTTP_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
|
|
|
|
/**
|
|
* 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_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,fixups,(request_rec *r))
|
|
|
|
/**
|
|
* This routine is called to determine and/or set the various document type
|
|
* information bits, like Content-type (via r->content_type), language, et
|
|
* cetera.
|
|
* @param r the current request
|
|
* @return OK, DECLINED, or HTTP_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,type_checker,(request_rec *r))
|
|
|
|
/**
|
|
* This routine is called to check for any module-specific restrictions placed
|
|
* upon the requested resource.
|
|
* @param r the current request
|
|
* @return OK, DECLINED, or HTTP_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,access_checker,(request_rec *r))
|
|
|
|
/**
|
|
* This routine is called to check to see if the resource being requested
|
|
* requires authorisation.
|
|
* @param r the current request
|
|
* @return OK, DECLINED, or HTTP_...
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
|
|
|
|
/**
|
|
* This hook allows modules to insert filters for the current request
|
|
* @param r the current request
|
|
* @ingroup hooks
|
|
*/
|
|
AP_DECLARE_HOOK(void,insert_filter,(request_rec *r))
|
|
|
|
AP_DECLARE(int) ap_location_walk(request_rec *r);
|
|
AP_DECLARE(int) ap_directory_walk(request_rec *r);
|
|
AP_DECLARE(int) ap_file_walk(request_rec *r);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* !APACHE_HTTP_REQUEST_H */
|