| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000 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 "ap_hooks.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /* 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 ap_pool_t elsewhere before doing this. |
| */ |
| |
| API_EXPORT(request_rec *) ap_sub_req_lookup_uri(const char *new_file, |
| const request_rec *r); |
| API_EXPORT(request_rec *) ap_sub_req_lookup_file(const char *new_file, |
| const request_rec *r); |
| API_EXPORT(request_rec *) ap_sub_req_method_uri(const char *method, |
| const char *new_file, |
| const request_rec *r); |
| API_EXPORT(int) ap_run_sub_req(request_rec *r); |
| API_EXPORT(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. |
| */ |
| |
| API_EXPORT(void) ap_internal_redirect(const char *new_uri, request_rec *); |
| API_EXPORT(void) ap_internal_redirect_handler(const char *new_uri, request_rec *); |
| API_EXPORT(int) ap_some_auth_required(request_rec *r); |
| API_EXPORT(int) ap_is_initial_req(request_rec *r); |
| API_EXPORT(void) ap_update_mtime(request_rec *r, ap_time_t dependency_mtime); |
| |
| #ifdef CORE_PRIVATE |
| /* Function called by main.c to handle first-level request */ |
| void ap_process_request(request_rec *); |
| API_EXPORT(void) ap_die(int type, request_rec *r); |
| #endif |
| |
| /* Hooks */ |
| DECLARE_HOOK(int,translate_name,(request_rec *)) |
| DECLARE_HOOK(int,check_user_id,(request_rec *)) |
| DECLARE_HOOK(int,fixups,(request_rec *)) |
| DECLARE_HOOK(int,type_checker,(request_rec *)) |
| DECLARE_HOOK(int,access_checker,(request_rec *)) |
| DECLARE_HOOK(int,auth_checker,(request_rec *)) |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* !APACHE_HTTP_REQUEST_H */ |