src/HttpReply.h

   1 /*
   2  * $Id: HttpReply.h,v 1.24 2008/02/26 21:49:34 amosjeffries Exp $
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32 #ifndef SQUID_HTTPREPLY_H
  33 #define SQUID_HTTPREPLY_H
  34
  35 #include "HttpMsg.h"
  36 #include "HttpStatusLine.h"
  37
  38 extern void httpReplyInitModule(void);
  39
  40 /** do everything in one call: init, set, pack, clean, return MemBuf */
  41 extern MemBuf *httpPackedReply(HttpVersion ver, http_status status, const char *ctype, int64_t clen, time_t lmt, time_t expires);
  42
  43 /* Sync changes here with HttpReply.cc */
  44
  45 class HttpHdrContRange;
  46
  47 class HttpHdrSc;
  48
  49 class HttpReply: public HttpMsg
  50 {
  51
  52 public:
  53     MEMPROXY_CLASS(HttpReply);
  54     HttpReply();
  55     ~HttpReply();
  56
  57     virtual void reset();
  58
  59     /// \par use HTTPMSGLOCK() instead of calling this directly
  60     virtual HttpReply *_lock() {
  61         return static_cast<HttpReply*>(HttpMsg::_lock());
  62     };
  63
  64     //virtual void unlock();  // only needed for debugging
  65
  66     /**
  67      \retval true on success
  68      \retval false and sets *error to zero when needs more data
  69      \retval false and sets *error to a positive http_status code on error
  70      */
  71     virtual bool sanityCheckStartLine(MemBuf *buf, http_status *error);
  72
  73     /** \par public, readable; never update these or their .hdr equivalents directly */
  74     time_t date;
  75
  76     time_t last_modified;
  77
  78     time_t expires;
  79
  80     String content_type;
  81
  82     HttpHdrSc *surrogate_control;
  83
  84     HttpHdrContRange *content_range;
  85
  86     short int keep_alive;
  87
  88     /** \par public, writable, but use httpReply* interfaces when possible */
  89     HttpStatusLine sline;
  90
  91     HttpBody body;              /**< for small constant memory-resident text bodies only */
  92
  93     String protoPrefix;         /**< e.g., "HTTP/"  */
  94
  95     bool do_clean;
  96
  97 public:
  98     virtual int httpMsgParseError();
  99
 100     virtual bool expectingBody(const HttpRequestMethod&, int64_t&) const;
 101
 102     virtual bool inheritProperties(const HttpMsg *aMsg);
 103
 104     void updateOnNotModified(HttpReply const *other);
 105
 106     /** set commonly used info with one call */
 107     void setHeaders(HttpVersion ver, http_status status,
 108                     const char *reason, const char *ctype, int64_t clen, time_t lmt, time_t expires);
 109
 110     /** \return a ready to use mem buffer with a packed reply */
 111     MemBuf *pack();
 112
 113     /** construct a 304 reply and return it */
 114     HttpReply *make304() const;
 115
 116     void redirect(http_status, const char *);
 117
 118     int64_t bodySize(const HttpRequestMethod&) const;
 119
 120     /** Checks whether received body exceeds known maximum size.
 121      * Requires a prior call to calcMaxBodySize().
 122      */
 123     bool receivedBodyTooLarge(HttpRequest&, int64_t receivedBodySize);
 124
 125     /** Checks whether expected body exceeds known maximum size.
 126      * Requires a prior call to calcMaxBodySize().
 127      */
 128     bool expectedBodyTooLarge(HttpRequest& request);
 129
 130     int validatorsMatch (HttpReply const *other) const;
 131
 132     void packHeadersInto(Packer * p) const;
 133
 134     /** Clone this reply.
 135      *  Could be done as a copy-contructor but we do not want to accidently copy a HttpReply..
 136      */
 137     HttpReply *clone() const;
 138
 139 private:
 140     /** initialize */
 141     void init();
 142
 143     void clean();
 144
 145     void hdrCacheClean();
 146
 147     void packInto(Packer * p);
 148
 149     /* ez-routines */
 150     /** \return construct 304 reply and pack it into a MemBuf */
 151     MemBuf *packed304Reply();
 152
 153     /* header manipulation */
 154     time_t hdrExpirationTime();
 155
 156     /** Calculates and stores maximum body size if needed.
 157      * Used by receivedBodyTooLarge() and expectedBodyTooLarge().
 158      */
 159     void calcMaxBodySize(HttpRequest& request);
 160
 161     mutable int64_t bodySizeMax; /**< cached result of calcMaxBodySize */
 162
 163 protected:
 164     virtual void packFirstLineInto(Packer * p, bool) const;
 165
 166     virtual bool parseFirstLine(const char *start, const char *end);
 167
 168     virtual void hdrCacheInit();
 169 };
 170
 171 MEMPROXY_CLASS_INLINE(HttpReply);
 172
 173 #endif /* SQUID_HTTPREPLY_H */