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