src/HttpReply.h

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