granicus.if.org Git - apache/blob - include/http_request.h

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  *
  54  * Portions of this software are based upon public domain software
  55  * originally written at the National Center for Supercomputing Applications,
  56  * University of Illinois, Urbana-Champaign.
  57  */
  58
  59 #ifndef APACHE_HTTP_REQUEST_H
  60 #define APACHE_HTTP_REQUEST_H
  61
  62 #include "ap_hooks.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 ap_pool_t 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,
  94                                                 const request_rec *r);
  95 API_EXPORT(int) ap_run_sub_req(request_rec *r);
  96 API_EXPORT(void) ap_destroy_sub_req(request_rec *r);
  97
  98 /*
  99  * Then there's the case that you want some other request to be served
 100  * as the top-level request INSTEAD of what the client requested directly.
 101  * If so, call this from a handler, and then immediately return OK.
 102  */
 103
 104 API_EXPORT(void) ap_internal_redirect(const char *new_uri, request_rec *);
 105 API_EXPORT(void) ap_internal_redirect_handler(const char *new_uri, 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(void) ap_update_mtime(request_rec *r, ap_time_t dependency_mtime);
 109
 110 #ifdef CORE_PRIVATE
 111 /* Function called by main.c to handle first-level request */
 112 void ap_process_request(request_rec *);
 113 API_EXPORT(void) ap_die(int type, request_rec *r);
 114 #endif
 115
 116   /* Hooks */
 117 AP_DECLARE_HOOK(int,translate_name,(request_rec *))
 118 AP_DECLARE_HOOK(int,check_user_id,(request_rec *))
 119 AP_DECLARE_HOOK(int,fixups,(request_rec *))
 120 AP_DECLARE_HOOK(int,type_checker,(request_rec *))
 121 AP_DECLARE_HOOK(int,access_checker,(request_rec *))
 122 AP_DECLARE_HOOK(int,auth_checker,(request_rec *))
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif  /* !APACHE_HTTP_REQUEST_H */