http_request.h revision 8476daed795d573496033d88015364df09fe9c68
6ae232055d4d8a97267517c5e50074c2c819941and/* ====================================================================
6ae232055d4d8a97267517c5e50074c2c819941and * The Apache Software License, Version 1.1
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
6ae232055d4d8a97267517c5e50074c2c819941and * reserved.
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * Redistribution and use in source and binary forms, with or without
6ae232055d4d8a97267517c5e50074c2c819941and * modification, are permitted provided that the following conditions
6ae232055d4d8a97267517c5e50074c2c819941and * are met:
6ae232055d4d8a97267517c5e50074c2c819941and *
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * 1. Redistributions of source code must retain the above copyright
2e545ce2450a9953665f701bb05350f0d3f26275nd * notice, this list of conditions and the following disclaimer.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen *
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen * 2. Redistributions in binary form must reproduce the above copyright
6ae232055d4d8a97267517c5e50074c2c819941and * notice, this list of conditions and the following disclaimer in
6ae232055d4d8a97267517c5e50074c2c819941and * the documentation and/or other materials provided with the
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen * distribution.
3f08db06526d6901aa08c110b5bc7dde6bc39905nd *
6ae232055d4d8a97267517c5e50074c2c819941and * 3. The end-user documentation included with the redistribution,
6ae232055d4d8a97267517c5e50074c2c819941and * if any, must include the following acknowledgment:
6ae232055d4d8a97267517c5e50074c2c819941and * "This product includes software developed by the
b43f840409794ed298e8634f6284741f193b6c4ftakashi * Apache Software Foundation (http://www.apache.org/)."
6ae232055d4d8a97267517c5e50074c2c819941and * Alternately, this acknowledgment may appear in the software itself,
b43f840409794ed298e8634f6284741f193b6c4ftakashi * if and wherever such third-party acknowledgments normally appear.
25dc1b1dfaeed1c7f8c5f51ba2970dd201b63893nd *
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung * 4. The names "Apache" and "Apache Software Foundation" must
6ae232055d4d8a97267517c5e50074c2c819941and * not be used to endorse or promote products derived from this
b43f840409794ed298e8634f6284741f193b6c4ftakashi * software without prior written permission. For written
b43f840409794ed298e8634f6284741f193b6c4ftakashi * permission, please contact apache@apache.org.
b43f840409794ed298e8634f6284741f193b6c4ftakashi *
b43f840409794ed298e8634f6284741f193b6c4ftakashi * 5. Products derived from this software may not be called "Apache",
6ae232055d4d8a97267517c5e50074c2c819941and * nor may "Apache" appear in their name, without prior written
6ae232055d4d8a97267517c5e50074c2c819941and * permission of the Apache Software Foundation.
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
6ae232055d4d8a97267517c5e50074c2c819941and * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
6ae232055d4d8a97267517c5e50074c2c819941and * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
6ae232055d4d8a97267517c5e50074c2c819941and * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
6ae232055d4d8a97267517c5e50074c2c819941and * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
6ae232055d4d8a97267517c5e50074c2c819941and * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
6ae232055d4d8a97267517c5e50074c2c819941and * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
6ae232055d4d8a97267517c5e50074c2c819941and * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
6ae232055d4d8a97267517c5e50074c2c819941and * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
6ae232055d4d8a97267517c5e50074c2c819941and * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
6ae232055d4d8a97267517c5e50074c2c819941and * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
6ae232055d4d8a97267517c5e50074c2c819941and * SUCH DAMAGE.
6ae232055d4d8a97267517c5e50074c2c819941and * ====================================================================
6ae232055d4d8a97267517c5e50074c2c819941and *
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * This software consists of voluntary contributions made by many
6ae232055d4d8a97267517c5e50074c2c819941and * individuals on behalf of the Apache Software Foundation. For more
6ae232055d4d8a97267517c5e50074c2c819941and * information on the Apache Software Foundation, please see
6ae232055d4d8a97267517c5e50074c2c819941and * <http://www.apache.org/>.
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim *
6ae232055d4d8a97267517c5e50074c2c819941and * Portions of this software are based upon public domain software
6ae232055d4d8a97267517c5e50074c2c819941and * originally written at the National Center for Supercomputing Applications,
6ae232055d4d8a97267517c5e50074c2c819941and * University of Illinois, Urbana-Champaign.
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#ifndef APACHE_HTTP_REQUEST_H
6ae232055d4d8a97267517c5e50074c2c819941and#define APACHE_HTTP_REQUEST_H
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
6ae232055d4d8a97267517c5e50074c2c819941and#include "apr_hooks.h"
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim#include "util_filter.h"
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#ifdef __cplusplus
6ae232055d4d8a97267517c5e50074c2c819941andextern "C" {
6ae232055d4d8a97267517c5e50074c2c819941and#endif
6ae232055d4d8a97267517c5e50074c2c819941and
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh#define AP_SUBREQ_NO_ARGS 0
6ae232055d4d8a97267517c5e50074c2c819941and#define AP_SUBREQ_MERGE_ARGS 1
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * @file http_request.h
6ae232055d4d8a97267517c5e50074c2c819941and * @brief Apache Request library
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/* http_request.c is the code which handles the main line of request
6ae232055d4d8a97267517c5e50074c2c819941and * processing, once a request has been read in (finding the right per-
6ae232055d4d8a97267517c5e50074c2c819941and * directory configuration, building it if necessary, and calling all
6ae232055d4d8a97267517c5e50074c2c819941and * the module dispatch functions in the right order).
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * The pieces here which are public to the modules, allow them to learn
6ae232055d4d8a97267517c5e50074c2c819941and * how the server would handle some other file or URI, or perhaps even
6ae232055d4d8a97267517c5e50074c2c819941and * direct the server to serve that other file instead of the one the
6ae232055d4d8a97267517c5e50074c2c819941and * client requested directly.
6ae232055d4d8a97267517c5e50074c2c819941and *
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * There are two ways to do that. The first is the sub_request mechanism,
6ae232055d4d8a97267517c5e50074c2c819941and * which handles looking up files and URIs as adjuncts to some other
6ae232055d4d8a97267517c5e50074c2c819941and * request (e.g., directory entries for multiviews and directory listings);
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * the lookup functions stop short of actually running the request, but
6ae232055d4d8a97267517c5e50074c2c819941and * (e.g., for includes), a module may call for the request to be run
6ae232055d4d8a97267517c5e50074c2c819941and * by calling run_sub_req. The space allocated to create sub_reqs can be
6ae232055d4d8a97267517c5e50074c2c819941and * reclaimed by calling destroy_sub_req --- be sure to copy anything you care
6ae232055d4d8a97267517c5e50074c2c819941and * about which was allocated in its apr_pool_t elsewhere before doing this.
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * An internal handler used by the ap_process_request, all sub request mechanisms
6ae232055d4d8a97267517c5e50074c2c819941and * and the redirect mechanism.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The request, subrequest or internal redirect to pre-process
6ae232055d4d8a97267517c5e50074c2c819941and * @return The return code for the request
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_process_request_internal(request_rec *r);
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Create a sub request from the given URI. This sub request can be
6ae232055d4d8a97267517c5e50074c2c819941and * inspected to find information about the requested URI
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param new_file The URI to lookup
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param next_filter The first filter the sub_request should use. If this is
6ae232055d4d8a97267517c5e50074c2c819941and * NULL, it defaults to the first filter for the main request
6ae232055d4d8a97267517c5e50074c2c819941and * @return The new request record
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc request_rec * ap_sub_req_lookup_uri(const char *new_file, const request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_file,
6ae232055d4d8a97267517c5e50074c2c819941and const request_rec *r,
6ae232055d4d8a97267517c5e50074c2c819941and ap_filter_t *next_filter);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Create a sub request for the given file. This sub request can be
6ae232055d4d8a97267517c5e50074c2c819941and * inspected to find information about the requested file
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param new_file The URI to lookup
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param next_filter The first filter the sub_request should use. If this is
6ae232055d4d8a97267517c5e50074c2c819941and * NULL, it defaults to the first filter for the main request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @return The new request record
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc request_rec * ap_sub_req_lookup_file(const char *new_file, const request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file,
6ae232055d4d8a97267517c5e50074c2c819941and const request_rec *r,
6ae232055d4d8a97267517c5e50074c2c819941and ap_filter_t *next_filter);
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Create a sub request for the given apr_dir_read result. This sub request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * can be inspected to find information about the requested file
6ae232055d4d8a97267517c5e50074c2c819941and * @param finfo The apr_dir_read result to lookup
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param r The current request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param subtype What type of subrequest to perform, one of;
6ae232055d4d8a97267517c5e50074c2c819941and * <PRE>
6ae232055d4d8a97267517c5e50074c2c819941and * AP_SUBREQ_NO_ARGS ignore r->args and r->path_info
6ae232055d4d8a97267517c5e50074c2c819941and * AP_SUBREQ_MERGE_ARGS merge r->args and r->path_info
6ae232055d4d8a97267517c5e50074c2c819941and * </PRE>
6ae232055d4d8a97267517c5e50074c2c819941and * @param next_filter The first filter the sub_request should use. If this is
6ae232055d4d8a97267517c5e50074c2c819941and * NULL, it defaults to the first filter for the main request
6ae232055d4d8a97267517c5e50074c2c819941and * @return The new request record
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc request_rec * ap_sub_req_lookup_dirent(apr_finfo_t *finfo, int subtype, const request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and * @tip The apr_dir_read flags value APR_FINFO_MIN|APR_FINFO_NAME flag is the
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * minimum recommended query if the results will be passed to apr_dir_read.
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * The file info passed must include the name, and must have the same relative
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * directory as the current request.
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(request_rec *) ap_sub_req_lookup_dirent(const apr_finfo_t *finfo,
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim const request_rec *r,
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim int subtype,
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim ap_filter_t *next_filter);
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim/**
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * Create a sub request for the given URI using a specific method. This
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * sub request can be inspected to find information about the requested URI
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param method The method to use in the new sub request
6ae232055d4d8a97267517c5e50074c2c819941and * @param new_file The URI to lookup
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param next_filter The first filter the sub_request should use. If this is
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * NULL, it defaults to the first filter for the main request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @return The new request record
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @deffunc request_rec * ap_sub_req_method_uri(const char *method, const char *new_file, const request_rec *r)
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method,
6ae232055d4d8a97267517c5e50074c2c819941and const char *new_file,
6ae232055d4d8a97267517c5e50074c2c819941and const request_rec *r,
6ae232055d4d8a97267517c5e50074c2c819941and ap_filter_t *next_filter);
6ae232055d4d8a97267517c5e50074c2c819941and/**
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * An output filter to strip EOS buckets from sub-requests. This always
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * has to be inserted at the end of a sub-requests filter stack.
6ae232055d4d8a97267517c5e50074c2c819941and * @param f The current filter
6ae232055d4d8a97267517c5e50074c2c819941and * @param bb The brigade to filter
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc apr_status_t ap_sub_req_output_filter(ap_filter_t *f, apr_bucket_brigade *bb)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f,
6ae232055d4d8a97267517c5e50074c2c819941and apr_bucket_brigade *bb);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Run the handler for the sub request
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The sub request to run
6ae232055d4d8a97267517c5e50074c2c819941and * @return The return code for the sub request
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc int ap_run_sub_req(request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_run_sub_req(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Free the memory associated with a sub request
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The sub request to finish
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @deffunc void ap_destroy_sub_req(request_rec *r)
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim */
27d778df0b517e1578f907d2e51eb961cd8ee5fbjimAP_DECLARE(void) ap_destroy_sub_req(request_rec *r);
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim/*
6ae232055d4d8a97267517c5e50074c2c819941and * Then there's the case that you want some other request to be served
6ae232055d4d8a97267517c5e50074c2c819941and * as the top-level request INSTEAD of what the client requested directly.
6ae232055d4d8a97267517c5e50074c2c819941and * If so, call this from a handler, and then immediately return OK.
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Redirect the current request to some other uri
6ae232055d4d8a97267517c5e50074c2c819941and * @param new_uri The URI to replace the current request with
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_internal_redirect(const char *new_uri, request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This function is designed for things like actions or CGI scripts, when
6ae232055d4d8a97267517c5e50074c2c819941and * using AddHandler, and you want to preserve the content type across
6ae232055d4d8a97267517c5e50074c2c819941and * an internal redirect.
6ae232055d4d8a97267517c5e50074c2c819941and * @param new_uri The URI to replace the current request with.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_internal_redirect_handler(const char *new_uri, request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Redirect the current request to a sub_req, merging the pools
6ae232055d4d8a97267517c5e50074c2c819941and * @param sub_req A subrequest created from this request
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_internal_fast_redirect(request_rec *sub_req, request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and * @tip the sub_req's pool will be merged into r's pool, be very careful
6ae232055d4d8a97267517c5e50074c2c819941and * not to destroy this subrequest, it will be destroyed with the main request!
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_internal_fast_redirect(request_rec *sub_req, request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Can be used within any handler to determine if any authentication
6ae232055d4d8a97267517c5e50074c2c819941and * is required for the current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return 1 if authentication is required, 0 otherwise
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc int ap_some_auth_required(request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_some_auth_required(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Determine if the current request is the main request or a sub requests
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @retrn 1 if this is a main request, 0 otherwise
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc int ap_is_initial_req(request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_is_initial_req(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Function to set the r->mtime field to the specified value if it's later
6ae232055d4d8a97267517c5e50074c2c819941and * than what's already there.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param dependency_time Time to set the mtime to
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_update_mtime(request_rec *r, apr_time_t dependency_mtime)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Add one or more methods to the list permitted to access the resource.
6ae232055d4d8a97267517c5e50074c2c819941and * Usually executed by the content handler before the response header is
6ae232055d4d8a97267517c5e50074c2c819941and * sent, but sometimes invoked at an earlier phase if a module knows it
6ae232055d4d8a97267517c5e50074c2c819941and * can set the list authoritatively. Note that the methods are ADDED
6ae232055d4d8a97267517c5e50074c2c819941and * to any already permitted unless the reset flag is non-zero. The
6ae232055d4d8a97267517c5e50074c2c819941and * list is used to generate the Allow response header field when it
6ae232055d4d8a97267517c5e50074c2c819941and * is needed.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The pointer to the request identifying the resource.
6ae232055d4d8a97267517c5e50074c2c819941and * @param reset Boolean flag indicating whether this list should
6ae232055d4d8a97267517c5e50074c2c819941and * completely replace any current settings.
6ae232055d4d8a97267517c5e50074c2c819941and * @param ... A NULL-terminated list of strings, each identifying a
6ae232055d4d8a97267517c5e50074c2c819941and * method name to add.
6ae232055d4d8a97267517c5e50074c2c819941and * @return None.
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_allow_methods(request_rec *r, int reset, ...)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Add one or more methods to the list permitted to access the resource.
6ae232055d4d8a97267517c5e50074c2c819941and * Usually executed by the content handler before the response header is
6ae232055d4d8a97267517c5e50074c2c819941and * sent, but sometimes invoked at an earlier phase if a module knows it
6ae232055d4d8a97267517c5e50074c2c819941and * can set the list authoritatively. Note that the methods are ADDED
6ae232055d4d8a97267517c5e50074c2c819941and * to any already permitted unless the reset flag is non-zero. The
6ae232055d4d8a97267517c5e50074c2c819941and * list is used to generate the Allow response header field when it
6ae232055d4d8a97267517c5e50074c2c819941and * is needed.
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param r The pointer to the request identifying the resource.
6ae232055d4d8a97267517c5e50074c2c819941and * @param reset Boolean flag indicating whether this list should
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * completely replace any current settings.
6ae232055d4d8a97267517c5e50074c2c819941and * @param ... A list of method identifiers, from the "M_" series
6ae232055d4d8a97267517c5e50074c2c819941and * defined in httpd.h, terminated with a value of -1
6ae232055d4d8a97267517c5e50074c2c819941and * (e.g., "M_GET, M_POST, M_OPTIONS, -1")
6ae232055d4d8a97267517c5e50074c2c819941and * @return None.
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_allow_standard_methods(request_rec *r, int reset, ...)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#define MERGE_ALLOW 0
6ae232055d4d8a97267517c5e50074c2c819941and#define REPLACE_ALLOW 1
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#ifdef CORE_PRIVATE
6ae232055d4d8a97267517c5e50074c2c819941and/* Function called by main.c to handle first-level request */
6ae232055d4d8a97267517c5e50074c2c819941andvoid ap_process_request(request_rec *);
6ae232055d4d8a97267517c5e50074c2c819941and/**
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * Kill the current request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param type Why the request is dieing
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @deffunc void ap_die(int type, request_rec *r)
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(void) ap_die(int type, request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and#endif
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/* Hooks */
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Gives modules a chance to create their request_config entry when the
6ae232055d4d8a97267517c5e50074c2c819941and * request is created.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,create_request,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This hook allow modules an opportunity to translate the URI into an
6ae232055d4d8a97267517c5e50074c2c819941and * actual filename. If no modules do anything special, the server's default
6ae232055d4d8a97267517c5e50074c2c819941and * rules will be followed.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return OK, DECLINED, or HTTP_...
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim */
27d778df0b517e1578f907d2e51eb961cd8ee5fbjimAP_DECLARE_HOOK(int,translate_name,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * This hook allow modules to set the per_dir_config based on their own
6ae232055d4d8a97267517c5e50074c2c819941and * context (such as <Proxy > sections) and responds to contextless requests
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * such as TRACE that need no security or filesystem mapping.
6ae232055d4d8a97267517c5e50074c2c819941and * based on the filesystem.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return DONE (or HTTP_) if this contextless request was just fulfilled
6ae232055d4d8a97267517c5e50074c2c819941and * (such as TRACE), OK if this is not a file, and DECLINED if this is a file.
6ae232055d4d8a97267517c5e50074c2c819941and * The core map_to_storage (HOOK_RUN_LAST) will directory_walk and file_walk
6ae232055d4d8a97267517c5e50074c2c819941and * the r->filename.
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,map_to_storage,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This hook is used to analyze the request headers, authenticate the user,
6ae232055d4d8a97267517c5e50074c2c819941and * and set the user information in the request record (r->user and
6ae232055d4d8a97267517c5e50074c2c819941and * r->ap_auth_type). This hook is only run when Apache determines that
6ae232055d4d8a97267517c5e50074c2c819941and * authentication/authorization is required for this resource (as determined
6ae232055d4d8a97267517c5e50074c2c819941and * by the 'Require' directive). It runs after the access_checker hook, and
6ae232055d4d8a97267517c5e50074c2c819941and * before the auth_checker hook.
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim *
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return OK, DECLINED, or HTTP_...
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * Allows modules to perform module-specific fixing of header fields. This
6ae232055d4d8a97267517c5e50074c2c819941and * is invoked just before any content-handler
6ae232055d4d8a97267517c5e50074c2c819941and * @param r The current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return OK, DECLINED, or HTTP_...
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,fixups,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This routine is called to determine and/or set the various document type
6ae232055d4d8a97267517c5e50074c2c819941and * information bits, like Content-type (via r->content_type), language, et
6ae232055d4d8a97267517c5e50074c2c819941and * cetera.
6ae232055d4d8a97267517c5e50074c2c819941and * @param r the current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return OK, DECLINED, or HTTP_...
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,type_checker,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This hook is used to apply additional access control to this resource.
6ae232055d4d8a97267517c5e50074c2c819941and * It runs *before* a user is authenticated, so this hook is really to
6ae232055d4d8a97267517c5e50074c2c819941and * apply additional restrictions independent of a user. It also runs
6ae232055d4d8a97267517c5e50074c2c819941and * independent of 'Require' directive usage.
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim *
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @param r the current request
6ae232055d4d8a97267517c5e50074c2c819941and * @return OK, DECLINED, or HTTP_...
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @ingroup hooks
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim */
27d778df0b517e1578f907d2e51eb961cd8ee5fbjimAP_DECLARE_HOOK(int,access_checker,(request_rec *r))
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This hook is used to check to see if the resource being requested
6ae232055d4d8a97267517c5e50074c2c819941and * is available for the authenticated user (r->user and r->ap_auth_type).
6ae232055d4d8a97267517c5e50074c2c819941and * It runs after the access_checker and check_user_id hooks. Note that
6ae232055d4d8a97267517c5e50074c2c819941and * it will *only* be called if Apache determines that access control has
6ae232055d4d8a97267517c5e50074c2c819941and * been applied to this resource (through a 'Require' directive).
6ae232055d4d8a97267517c5e50074c2c819941and *
6ae232055d4d8a97267517c5e50074c2c819941and * @param r the current request
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @return OK, DECLINED, or HTTP_...
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
27d778df0b517e1578f907d2e51eb961cd8ee5fbjim
6ae232055d4d8a97267517c5e50074c2c819941and/**
6ae232055d4d8a97267517c5e50074c2c819941and * This hook allows modules to insert filters for the current request
6ae232055d4d8a97267517c5e50074c2c819941and * @param r the current request
6ae232055d4d8a97267517c5e50074c2c819941and * @ingroup hooks
6ae232055d4d8a97267517c5e50074c2c819941and */
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE_HOOK(void,insert_filter,(request_rec *r))
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_location_walk(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_directory_walk(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941andAP_DECLARE(int) ap_file_walk(request_rec *r);
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#ifdef __cplusplus
6ae232055d4d8a97267517c5e50074c2c819941and}
6ae232055d4d8a97267517c5e50074c2c819941and#endif
6ae232055d4d8a97267517c5e50074c2c819941and
6ae232055d4d8a97267517c5e50074c2c819941and#endif /* !APACHE_HTTP_REQUEST_H */
6ae232055d4d8a97267517c5e50074c2c819941and