src/HttpRequest.h

   1
   2 /*
   3  * $Id: HttpRequest.h,v 1.33 2008/02/26 21:49:34 amosjeffries 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(const HttpRequestMethod& 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(const HttpRequestMethod& aMethod, protocol_t aProtocol, const char *aUrlpath);
  67
  68     virtual HttpRequest *clone() const;
  69
  70     /* are responses to this request potentially cachable */
  71     bool cacheable() const;
  72
  73     /* Now that we care what host contains it is better off being protected. */
  74     /* HACK: These two methods are only inline to get around Makefile dependancies */
  75     /*      caused by HttpRequest being used in places it really shouldn't.        */
  76     /*      ideally they would be methods of URL instead. */
  77     inline void SetHost(const char *src)
  78     {
  79         host_addr.SetEmpty();
  80         host_addr = src;
  81         if( host_addr.IsAnyAddr() ) {
  82             xstrncpy(host, src, SQUIDHOSTNAMELEN);
  83         }
  84         else {
  85             host_addr.ToHostname(host, SQUIDHOSTNAMELEN);
  86             debugs(23, 3, "HttpRequest::SetHost() given IP: " << host_addr);
  87         }
  88     };
  89     inline const char* GetHost(void) const { return host; };
  90
  91 protected:
  92     void clean();
  93
  94     void init();
  95
  96 public:
  97     HttpRequestMethod method;
  98
  99     char login[MAX_LOGIN_SZ];
 100
 101 private:
 102     char host[SQUIDHOSTNAMELEN];
 103
 104 public:
 105     IPAddress host_addr;
 106
 107     AuthUserRequest *auth_user_request;
 108
 109     u_short port;
 110
 111     String urlpath;
 112
 113     char *canonical;
 114
 115     request_flags flags;
 116
 117     HttpHdrRange *range;
 118
 119     time_t ims;
 120
 121     int imslen;
 122
 123     int max_forwards;
 124
 125     IPAddress client_addr;
 126
 127     IPAddress my_addr;
 128
 129     HierarchyLogEntry hier;
 130
 131     err_type errType;
 132
 133     char *peer_login;           /* Configured peer login:password */
 134
 135     time_t lastmod;             /* Used on refreshes */
 136
 137     const char *vary_headers;   /* Used when varying entities are detected. Changes how the store key is calculated */
 138
 139     char *peer_domain;          /* Configured peer forceddomain */
 140
 141     String tag;                 /* Internal tag for this request */
 142
 143     String extacl_user;         /* User name returned by extacl lookup */
 144
 145     String extacl_passwd;       /* Password returned by extacl lookup */
 146
 147     String extacl_log;          /* String to be used for access.log purposes */
 148
 149 public:
 150     bool multipartRangeRequest() const;
 151
 152     bool parseFirstLine(const char *start, const char *end);
 153
 154     int parseHeader(const char *parse_start, int len);
 155
 156     virtual bool expectingBody(const HttpRequestMethod& unused, int64_t&) const;
 157
 158     bool bodyNibbled() const; // the request has a [partially] consumed body
 159
 160     int prefixLen();
 161
 162     void swapOut(StoreEntry * e);
 163
 164     void pack(Packer * p);
 165
 166     static void httpRequestPack(void *obj, Packer *p);
 167
 168     static HttpRequest * CreateFromUrlAndMethod(char * url, const HttpRequestMethod& method);
 169
 170     static HttpRequest * CreateFromUrl(char * url);
 171
 172 private:
 173     const char *packableURI(bool full_uri) const;
 174
 175 protected:
 176     virtual void packFirstLineInto(Packer * p, bool full_uri) const;
 177
 178     virtual bool sanityCheckStartLine(MemBuf *buf, http_status *error);
 179
 180     virtual void hdrCacheInit();
 181
 182 };
 183
 184 MEMPROXY_CLASS_INLINE(HttpRequest)          /**DOCS_NOSEMI*/
 185
 186 #endif /* SQUID_HTTPREQUEST_H */