ACE/apps/JAWS/clients/WebSTONE/src/nsapi-includes/frame/req.h

   1 /*
   2  * Copyright (c) 1994, 1995.  Netscape Communications Corporation.  All
   3  * rights reserved.
   4  *
   5  * Use of this software is governed by the terms of the license agreement for
   6  * the Netscape Communications or Netscape Comemrce Server between the
   7  * parties.
   8  */
   9
  10
  11 /* ------------------------------------------------------------------------ */
  12
  13
  14 /*
  15  * req.h: Request-specific data structures and functions
  16  *
  17  * Rob McCool
  18  */
  19
  20
  21 #ifndef REQ_H
  22 #define REQ_H
  23
  24
  25 #include "netsite.h"
  26 #include "base/pblock.h"
  27 #include "base/session.h"
  28 #include "frame/objset.h"
  29
  30 #include <sys/stat.h>
  31
  32
  33 /* ------------------------------ Constants ------------------------------- */
  34
  35
  36 #define REQ_HASHSIZE 10
  37 #define REQ_MAX_LINE 4096
  38
  39
  40 /*
  41  * The REQ_ return codes. These codes are used to determine what the server
  42  * should do after a particular module completes its task.
  43  *
  44  * Func type functions return these as do many internal functions.
  45  */
  46
  47 /* The function performed its task, proceed with the request */
  48 #define REQ_PROCEED 0
  49 /* The entire request should be aborted: An error occurred */
  50 #define REQ_ABORTED -1
  51 /* The function performed no task, but proceed anyway. */
  52 #define REQ_NOACTION -2
  53 /* Tear down the session and exit */
  54 #define REQ_EXIT -3
  55
  56
  57 /* ------------------------------ Structures ------------------------------ */
  58
  59
  60 typedef struct {
  61     /* Server working variables */
  62     pblock *vars;
  63
  64     /* The method, URI, and protocol revision of this request */
  65     pblock *reqpb;
  66     /* Protocol specific headers */
  67     int loadhdrs;
  68     pblock *headers;
  69
  70     /* Server's response headers */
  71     pblock *srvhdrs;
  72
  73     /* The object set constructed to fulfill this request */
  74     httpd_objset *os;
  75     /* Array of objects that were created from .nsconfig files */
  76     httpd_objset *tmpos;
  77
  78     /* The stat last returned by request_stat_path */
  79     char *statpath;
  80     char *staterr;
  81     struct stat *finfo;
  82
  83 #ifdef MCC_PROXY
  84     /* SOCKS request data */
  85     void *socks_rq;
  86 #endif
  87
  88 } Request;
  89
  90
  91 /* ------------------------------ Prototypes ------------------------------ */
  92
  93
  94 /*
  95  * request_create creates a new request structure.
  96  */
  97
  98 Request *request_create();
  99
 100 /*
 101  * request_free destroys a request structure.
 102  */
 103
 104 void request_free(Request *req);
 105
 106
 107 /*
 108  * Restarts a request for a given URI internally. If rq is non-NULL, the
 109  * function will keep the old request's headers and protocol, but with a new
 110  * URI and method of GET. If the previous method was HEAD, this is preserved.
 111  * Any other method becomes GET. You may assume that if you give it a request
 112  * structure that it will use the same structure.
 113  *
 114  * Once you have this new Request, you must then do what you want with
 115  * it (e.g. send the object back, perform uri2path translation, etc.)
 116  */
 117
 118 Request *request_restart_internal(char *uri, Request *rq);
 119
 120
 121 /*
 122  * request_translate_uri performs virtual to physical mapping on the given
 123  * uri and returns either a path string or NULL depending on whether it was
 124  * successful or not.
 125  */
 126
 127 char *request_translate_uri(char *uri, Session *sn);
 128
 129
 130 /*
 131  * request_header finds the named header depending on the requesting
 132  * protocol. If possible, it will not load headers until the first is
 133  * requested. You have to watch out because this can return REQ_ABORTED.
 134  */
 135
 136 int request_header(char *name, char **value, Session *sn, Request *rq);
 137
 138 /*
 139  * request_loadheaders just makes sure the headers have been loaded.
 140  */
 141
 142 int request_loadheaders(Session *sn, Request *rq);
 143
 144
 145 /*
 146  * request_stat_path tries to stat path. If path is NULL, it will look in
 147  * the vars pblock for "path". If the stat is successful, it returns the stat
 148  * structure. If not, returns NULL and leaves a message in rq->staterr. If a
 149  * previous call to this function was successful, and path is the same, the
 150  * function will simply return the previously found value.
 151  *
 152  * User functions should not free this structure.
 153  */
 154
 155 struct stat *request_stat_path(char *path, Request *rq);
 156
 157
 158 /*
 159  * Parses the URI parameter in rq->vars and finds out what objects it
 160  * references (using NameTrans). Builds the request's object set.
 161  */
 162
 163 int request_uri2path(Session *sn, Request *rq);
 164
 165 /*
 166  * Performs any path checks needed for this request.
 167  */
 168
 169 int request_pathchecks(Session *sn, Request *rq);
 170
 171 /*
 172  * Does all the ObjectType directives for a request
 173  */
 174
 175 int request_fileinfo(Session *sn, Request *rq);
 176
 177
 178 /*
 179  * request_handle_processed takes a Request structure with its reqpb
 180  * block filled in and handles the request.
 181  */
 182
 183 int request_handle_processed(Session *sn, Request *rq);
 184
 185
 186 /*
 187  * Complete a request by finding the service function and using it. Returns
 188  * REQ_NOACTION if no matching function was found.
 189  */
 190
 191 int request_service(Session *sn, Request *rq);
 192
 193
 194 /*
 195  * request_handle handles one request from the session's inbuf.
 196  */
 197
 198 void request_handle(Session *sn);
 199
 200 /*
 201  * Moved here due to problems with interdependency. See object.h for
 202  * description.
 203  */
 204
 205 int object_findnext(Session *sn, Request *rq, httpd_object *obj);
 206 int object_pathcheck(Session *sn, Request *rq, httpd_object *obj);
 207 int object_findinfo(Session *sn, Request *rq, httpd_object *obj);
 208 int object_findservice(Session *sn, Request *rq, httpd_object *obj);
 209 int object_finderror(Session *sn, Request *rq, httpd_object *obj);
 210 int object_findlogs(Session *sn, Request *rq, httpd_object *obj);
 211
 212 #endif