1 /* $OpenBSD: http_request.h,v 1.8 2005/03/28 23:26:51 niallo Exp $ */ 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2000-2003 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" must 29 * not be used to endorse or promote products derived from this 30 * software without prior written permission. For written 31 * permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * nor may "Apache" appear in their name, without prior written 35 * permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>. 55 * 56 * Portions of this software are based upon public domain software 57 * originally written at the National Center for Supercomputing Applications, 58 * University of Illinois, Urbana-Champaign. 59 */ 60 61 #ifndef APACHE_HTTP_REQUEST_H 62 #define APACHE_HTTP_REQUEST_H 63 64 #ifdef __cplusplus 65 extern "C" { 66 #endif 67 68 /* http_request.c is the code which handles the main line of request 69 * processing, once a request has been read in (finding the right per- 70 * directory configuration, building it if necessary, and calling all 71 * the module dispatch functions in the right order). 72 * 73 * The pieces here which are public to the modules, allow them to learn 74 * how the server would handle some other file or URI, or perhaps even 75 * direct the server to serve that other file instead of the one the 76 * client requested directly. 77 * 78 * There are two ways to do that. The first is the sub_request mechanism, 79 * which handles looking up files and URIs as adjuncts to some other 80 * request (e.g., directory entries for multiviews and directory listings); 81 * the lookup functions stop short of actually running the request, but 82 * (e.g., for includes), a module may call for the request to be run 83 * by calling run_sub_req. The space allocated to create sub_reqs can be 84 * reclaimed by calling destroy_sub_req --- be sure to copy anything you care 85 * about which was allocated in its pool elsewhere before doing this. 86 */ 87 88 API_EXPORT(request_rec *) ap_sub_req_lookup_uri(const char *new_file, 89 const request_rec *r); 90 API_EXPORT(request_rec *) ap_sub_req_lookup_file(const char *new_file, 91 const request_rec *r); 92 API_EXPORT(request_rec *) ap_sub_req_method_uri(const char *method, 93 const char *new_file, const request_rec *r); 94 API_EXPORT(int) ap_run_sub_req(request_rec *r); 95 API_EXPORT(void) ap_destroy_sub_req(request_rec *r); 96 97 /* 98 * Then there's the case that you want some other request to be served 99 * as the top-level request INSTEAD of what the client requested directly. 100 * If so, call this from a handler, and then immediately return OK. 101 */ 102 103 API_EXPORT(void) ap_internal_redirect(const char *new_uri, request_rec *); 104 API_EXPORT(void) ap_internal_redirect_handler(const char *new_uri, 105 request_rec *); 106 API_EXPORT(int) ap_some_auth_required(request_rec *r); 107 API_EXPORT(int) ap_is_initial_req(request_rec *r); 108 API_EXPORT(time_t) ap_update_mtime(request_rec *r, time_t dependency_mtime); 109 110 #ifdef CORE_PRIVATE 111 /* Function called by main.c to handle first-level request */ 112 API_EXPORT(void) ap_process_request(request_rec *); 113 API_EXPORT(void) ap_die(int type, request_rec *r); 114 #endif 115 116 #ifdef __cplusplus 117 } 118 #endif 119 120 #endif /* !APACHE_HTTP_REQUEST_H */ 121