src/HttpRequest.h

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