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