src/http.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_HTTP_H
  35 #define SQUID_HTTP_H
  36
  37 #include "StoreIOBuffer.h"
  38 #include "comm.h"
  39 #include "comm/forward.h"
  40 #include "forward.h"
  41 #include "Server.h"
  42 #include "ChunkedCodingParser.h"
  43
  44 class HttpStateData : public ServerStateData
  45 {
  46
  47 public:
  48     HttpStateData(FwdState *);
  49     ~HttpStateData();
  50
  51     static void httpBuildRequestHeader(HttpRequest * request,
  52                                        StoreEntry * entry,
  53                                        const AccessLogEntryPointer &al,
  54                                        HttpHeader * hdr_out,
  55                                        const http_state_flags flags);
  56
  57     virtual const Comm::ConnectionPointer & dataConnection() const;
  58     /* should be private */
  59     bool sendRequest();
  60     void processReplyHeader();
  61     void processReplyBody();
  62     void readReply(const CommIoCbParams &io);
  63     virtual void maybeReadVirginBody(); // read response data from the network
  64     int cacheableReply();
  65
  66     peer *_peer;                /* peer request made to */
  67     int eof;                    /* reached end-of-object? */
  68     int lastChunk;              /* reached last chunk of a chunk-encoded reply */
  69     http_state_flags flags;
  70     size_t read_sz;
  71     int header_bytes_read;      // to find end of response,
  72     int64_t reply_bytes_read;   // without relying on StoreEntry
  73     int body_bytes_truncated; // positive when we read more than we wanted
  74     MemBuf *readBuf;
  75     bool ignoreCacheControl;
  76     bool surrogateNoStore;
  77
  78     void processSurrogateControl(HttpReply *);
  79
  80 protected:
  81     void processReply();
  82     void proceedAfter1xx();
  83     void handle1xx(HttpReply *msg);
  84
  85 private:
  86     /**
  87      * The current server connection.
  88      * Maybe open, closed, or NULL.
  89      * Use doneWithServer() to check if the server is available for use.
  90      */
  91     Comm::ConnectionPointer serverConnection;
  92     AsyncCall::Pointer closeHandler;
  93     enum ConnectionStatus {
  94         INCOMPLETE_MSG,
  95         COMPLETE_PERSISTENT_MSG,
  96         COMPLETE_NONPERSISTENT_MSG
  97     };
  98     ConnectionStatus statusIfComplete() const;
  99     ConnectionStatus persistentConnStatus() const;
 100     void keepaliveAccounting(HttpReply *);
 101     void checkDateSkew(HttpReply *);
 102
 103     bool continueAfterParsingHeader();
 104     void truncateVirginBody();
 105
 106     virtual void start();
 107     virtual void haveParsedReplyHeaders();
 108     virtual bool getMoreRequestBody(MemBuf &buf);
 109     virtual void closeServer(); // end communication with the server
 110     virtual bool doneWithServer() const; // did we end communication?
 111     virtual void abortTransaction(const char *reason); // abnormal termination
 112
 113     // consuming request body
 114     virtual void handleMoreRequestBodyAvailable();
 115     virtual void handleRequestBodyProducerAborted();
 116
 117     void writeReplyBody();
 118     bool decodeAndWriteReplyBody();
 119     bool finishingBrokenPost();
 120     bool finishingChunkedRequest();
 121     void doneSendingRequestBody();
 122     void requestBodyHandler(MemBuf &);
 123     virtual void sentRequestBody(const CommIoCbParams &io);
 124     void wroteLast(const CommIoCbParams &io);
 125     void sendComplete();
 126     void httpStateConnClosed(const CommCloseCbParams &params);
 127     void httpTimeout(const CommTimeoutCbParams &params);
 128
 129     mb_size_t buildRequestPrefix(MemBuf * mb);
 130     static bool decideIfWeDoRanges (HttpRequest * orig_request);
 131     bool peerSupportsConnectionPinning() const;
 132
 133     ChunkedCodingParser *httpChunkDecoder;
 134 private:
 135     CBDATA_CLASS2(HttpStateData);
 136 };
 137
 138 extern int httpCachable(const HttpRequestMethod&);
 139 extern void httpStart(FwdState *);
 140 extern const char *httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
 141
 142 #endif /* SQUID_HTTP_H */