http_request.h revision c3e342e5b0b9fea6617ee16d2da02c3ef2108126
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/* ====================================================================
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * The Apache Software License, Version 1.1
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * reserved.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Redistribution and use in source and binary forms, with or without
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * modification, are permitted provided that the following conditions
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * are met:
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * 1. Redistributions of source code must retain the above copyright
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * notice, this list of conditions and the following disclaimer.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * 2. Redistributions in binary form must reproduce the above copyright
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * notice, this list of conditions and the following disclaimer in
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * the documentation and/or other materials provided with the
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * distribution.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * 3. The end-user documentation included with the redistribution,
2d728410bcf9e6e53698bb035f516e18efd76d8bnd * if any, must include the following acknowledgment:
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * "This product includes software developed by the
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Apache Software Foundation (http://www.apache.org/)."
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Alternately, this acknowledgment may appear in the software itself,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * if and wherever such third-party acknowledgments normally appear.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * 4. The names "Apache" and "Apache Software Foundation" must
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * not be used to endorse or promote products derived from this
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * software without prior written permission. For written
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * permission, please contact apache@apache.org.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * 5. Products derived from this software may not be called "Apache",
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * nor may "Apache" appear in their name, without prior written
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * permission of the Apache Software Foundation.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * SUCH DAMAGE.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * ====================================================================
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * This software consists of voluntary contributions made by many
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * individuals on behalf of the Apache Software Foundation. For more
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * information on the Apache Software Foundation, please see
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * <http://www.apache.org/>.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Portions of this software are based upon public domain software
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * originally written at the National Center for Supercomputing Applications,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * University of Illinois, Urbana-Champaign.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#ifndef APACHE_HTTP_REQUEST_H
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#define APACHE_HTTP_REQUEST_H
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#include "apr_hooks.h"
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#include "util_filter.h"
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#ifdef __cplusplus
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzextern "C" {
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#endif
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @file http_request.h
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @brief Apache Request library
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/* http_request.c is the code which handles the main line of request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * processing, once a request has been read in (finding the right per-
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * directory configuration, building it if necessary, and calling all
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * the module dispatch functions in the right order).
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * The pieces here which are public to the modules, allow them to learn
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * how the server would handle some other file or URI, or perhaps even
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * direct the server to serve that other file instead of the one the
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * client requested directly.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz *
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * There are two ways to do that. The first is the sub_request mechanism,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * which handles looking up files and URIs as adjuncts to some other
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * request (e.g., directory entries for multiviews and directory listings);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * the lookup functions stop short of actually running the request, but
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * (e.g., for includes), a module may call for the request to be run
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * by calling run_sub_req. The space allocated to create sub_reqs can be
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * reclaimed by calling destroy_sub_req --- be sure to copy anything you care
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * about which was allocated in its apr_pool_t elsewhere before doing this.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Create a sub request from the given URI. This sub request can be
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * inspected to find information about the requested URI
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param new_file The URI to lookup
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param next_filter The first filter the sub_request should use. If this is
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * NULL, it defaults to the first filter for the main request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @return The new request record
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc request_rec * ap_sub_req_lookup_uri(const char *new_file, const request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_file,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz const request_rec *r,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz ap_filter_t *next_filter);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Create a sub request for the given file. This sub request can be
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * inspected to find information about the requested file
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param new_file The URI to lookup
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param next_filter The first filter the sub_request should use. If this is
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * NULL, it defaults to the first filter for the main request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @return The new request record
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @deffunc request_rec * ap_sub_req_lookup_file(const char *new_file, const request_rec *r)
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file,
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd const request_rec *r,
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd ap_filter_t *next_filter);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Create a sub request for the given URI using a specific method. This
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * sub request can be inspected to find information about the requested URI
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param method The method to use in the new sub request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param new_file The URI to lookup
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r The current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param next_filter The first filter the sub_request should use. If this is
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * NULL, it defaults to the first filter for the main request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return The new request record
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @deffunc request_rec * ap_sub_req_method_uri(const char *method, const char *new_file, const request_rec *r)
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz const char *new_file,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz const request_rec *r,
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz ap_filter_t *next_filter);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * An output filter to strip EOS buckets from sub-requests. This always
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * has to be inserted at the end of a sub-requests filter stack.
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param f The current filter
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param bb The brigade to filter
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @deffunc apr_status_t ap_sub_req_output_filter(ap_filter_t *f, apr_bucket_brigade *bb)
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f,
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd apr_bucket_brigade *bb);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * Run the handler for the sub request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r The sub request to run
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return The return code for the sub request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @deffunc int ap_run_sub_req(request_rec *r)
2d728410bcf9e6e53698bb035f516e18efd76d8bnd */
2d728410bcf9e6e53698bb035f516e18efd76d8bndAP_DECLARE(int) ap_run_sub_req(request_rec *r);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Free the memory associated with a sub request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The sub request to finish
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_destroy_sub_req(request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_destroy_sub_req(request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/*
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Then there's the case that you want some other request to be served
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * as the top-level request INSTEAD of what the client requested directly.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * If so, call this from a handler, and then immediately return OK.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Redirect the current request to some other uri
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param new_uri The URI to replace the current request with
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_internal_redirect(const char *new_uri, request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * This function is designed for things like actions or CGI scripts, when
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * using AddHandler, and you want to preserve the content type across
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * an internal redirect.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param new_uri The URI to replace the current request with.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_internal_redirect_handler(const char *new_uri, request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Can be used within any handler to determine if any authentication
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * is required for the current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @return 1 if authentication is required, 0 otherwise
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc int ap_some_auth_required(request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(int) ap_some_auth_required(request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Determine if the current request is the main request or a sub requests
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @retrn 1 if this is a main request, 0 otherwise
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc int ap_is_initial_req(request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(int) ap_is_initial_req(request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * Function to set the r->mtime field to the specified value if it's later
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * than what's already there.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param dependency_time Time to set the mtime to
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_update_mtime(request_rec *r, apr_time_t dependency_mtime)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Add one or more methods to the list permitted to access the resource.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Usually executed by the content handler before the response header is
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * sent, but sometimes invoked at an earlier phase if a module knows it
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * can set the list authoritatively. Note that the methods are ADDED
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * to any already permitted unless the reset flag is non-zero. The
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * list is used to generate the Allow response header field when it
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * is needed.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The pointer to the request identifying the resource.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param reset Boolean flag indicating whether this list should
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * completely replace any current settings.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param ... A NULL-terminated list of strings, each identifying a
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * method name to add.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @return None.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_allow_methods(request_rec *r, int reset, ...)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#define MERGE_ALLOW 0
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#define REPLACE_ALLOW 1
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#ifdef CORE_PRIVATE
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/* Function called by main.c to handle first-level request */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzvoid ap_process_request(request_rec *);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * Kill the current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param type Why the request is dieing
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @deffunc void ap_die(int type, request_rec *r)
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(void) ap_die(int type, request_rec *r);
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz#endif
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/* Hooks */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/* XXX: doxygen grouping doesn't appear to work, but it should. Checking with
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * doxygen (Ben).
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * Gives modules a chance to create their request_config entry when the
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * request is created.
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r The current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE_HOOK(int,create_request,(request_rec *r))
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * This hook allow modules an opportunity to translate the URI into an
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * actual filename. If no modules do anything special, the server's default
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * rules will be followed.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r The current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @return OK, DECLINED, or HTTP_...
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE_HOOK(int,translate_name,(request_rec *r))
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * This hook allows modules to check the authentication information sent with
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * the request.
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r The current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return OK, DECLINED, or HTTP_...
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * Allows modules to perform module-specific fixing of header fields. This
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * is invoked just before any content-handler
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r The current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return OK, DECLINED, or HTTP_...
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE_HOOK(int,fixups,(request_rec *r))
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * This routine is called to determine and/or set the various document type
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * information bits, like Content-type (via r->content_type), language, et
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * cetera.
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r the current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return OK, DECLINED, or HTTP_...
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @ingroup hooks
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE_HOOK(int,type_checker,(request_rec *r))
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * This routine is called to check for any module-specific restrictions placed
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * upon the requested resource.
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r the current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return OK, DECLINED, or HTTP_...
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE_HOOK(int,access_checker,(request_rec *r))
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz/**
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * This routine is called to check to see if the resource being requested
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * requires authorisation.
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @param r the current request
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @return OK, DECLINED, or HTTP_...
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd * @ingroup hooks
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd/**
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * This hook allows modules to insert filters for the current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @param r the current request
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz * @ingroup hooks
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz */
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE_HOOK(void,insert_filter,(request_rec *r))
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantz
9fe74ffcdea85800f04a7222f716f78ae60cce51jerenkrantzAP_DECLARE(int) directory_walk(request_rec *r);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE(int) location_walk(request_rec *r);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9ndAP_DECLARE(int) file_walk(request_rec *r);
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd#ifdef __cplusplus
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd}
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd#endif
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd#endif /* !APACHE_HTTP_REQUEST_H */
03bdb4fb430b0d4e502ddfc75f7e9dbd91db72e9nd