src/HttpRequest.h

   1
   2 /*
   3  * $Id: HttpRequest.h,v 1.25 2007/04/06 04:50:04 rousskov Exp $
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  */
  33
  34 #ifndef SQUID_HTTPREQUEST_H
  35 #define SQUID_HTTPREQUEST_H
  36
  37 #include "HttpMsg.h"
  38 #include "client_side.h"
  39 #include "HierarchyLogEntry.h"
  40 #include "HttpRequestMethod.h"
  41
  42 /*  Http Request */
  43 extern int httpRequestHdrAllowed(const HttpHeaderEntry * e, String * strConnection);
  44 extern int httpRequestHdrAllowedByName(http_hdr_type id);
  45 extern void httpRequestPack(void *obj, Packer *p);
  46
  47
  48 class HttpHdrRange;
  49
  50 class HttpRequest: public HttpMsg
  51 {
  52
  53 public:
  54     MEMPROXY_CLASS(HttpRequest);
  55     HttpRequest();
  56     HttpRequest(method_t aMethod, protocol_t aProtocol, const char *aUrlpath);
  57     ~HttpRequest();
  58     virtual void reset();
  59
  60     // use HTTPMSGLOCK() instead of calling this directly
  61     virtual HttpRequest *_lock()
  62     {
  63         return static_cast<HttpRequest*>(HttpMsg::_lock());
  64     };
  65
  66     void initHTTP(method_t aMethod, protocol_t aProtocol, const char *aUrlpath);
  67
  68     /* are responses to this request potentially cachable */
  69     bool cacheable() const;
  70
  71 protected:
  72     void clean();
  73
  74     void init();
  75
  76 public:
  77     method_t method;
  78
  79     char login[MAX_LOGIN_SZ];
  80
  81     char host[SQUIDHOSTNAMELEN + 1];
  82
  83     auth_user_request_t *auth_user_request;
  84
  85     u_short port;
  86
  87     String urlpath;
  88
  89     char *canonical;
  90
  91     request_flags flags;
  92
  93     HttpHdrRange *range;
  94
  95     time_t ims;
  96
  97     int imslen;
  98
  99     int max_forwards;
 100
 101     /* these in_addr's could probably be sockaddr_in's */
 102
 103     struct IN_ADDR client_addr;
 104
 105     struct IN_ADDR my_addr;
 106
 107     unsigned short my_port;
 108
 109     unsigned short client_port;
 110
 111     HierarchyLogEntry hier;
 112
 113     err_type errType;
 114
 115     char *peer_login;           /* Configured peer login:password */
 116
 117     time_t lastmod;             /* Used on refreshes */
 118
 119     const char *vary_headers;   /* Used when varying entities are detected. Changes how the store key is calculated */
 120
 121     char *peer_domain;          /* Configured peer forceddomain */
 122
 123     String tag;                 /* Internal tag for this request */
 124
 125     String extacl_user;         /* User name returned by extacl lookup */
 126
 127     String extacl_passwd;       /* Password returned by extacl lookup */
 128
 129     String extacl_log;          /* String to be used for access.log purposes */
 130
 131 public:
 132     bool multipartRangeRequest() const;
 133
 134     bool parseFirstLine(const char *start, const char *end);
 135
 136     int parseHeader(const char *parse_start, int len);
 137
 138     virtual bool expectingBody(method_t unused, ssize_t&) const;
 139
 140     int prefixLen();
 141
 142     void swapOut(StoreEntry * e);
 143
 144     void pack(Packer * p);
 145
 146     static void httpRequestPack(void *obj, Packer *p);
 147
 148     static HttpRequest * CreateFromUrlAndMethod(char * url, method_t method);
 149
 150     static HttpRequest * CreateFromUrl(char * url);
 151
 152 private:
 153     const char *packableURI(bool full_uri) const;
 154
 155 protected:
 156     virtual void packFirstLineInto(Packer * p, bool full_uri) const;
 157
 158     virtual bool sanityCheckStartLine(MemBuf *buf, http_status *error);
 159
 160     virtual void hdrCacheInit();
 161
 162 };
 163
 164 MEMPROXY_CLASS_INLINE(HttpRequest)
 165
 166 #endif /* SQUID_HTTPREQUEST_H */