src/http.h

   1
   2 /*
   3  *
   4  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   5  * ----------------------------------------------------------
   6  *
   7  *  Squid is the result of efforts by numerous individuals from
   8  *  the Internet community; see the CONTRIBUTORS file for full
   9  *  details.   Many organizations have provided support for Squid's
  10  *  development; see the SPONSORS file for full details.  Squid is
  11  *  Copyrighted (C) 2001 by the Regents of the University of
  12  *  California; see the COPYRIGHT file for full details.  Squid
  13  *  incorporates software developed and/or copyrighted by other
  14  *  sources; see the CREDITS file for full details.
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License as published by
  18  *  the Free Software Foundation; either version 2 of the License, or
  19  *  (at your option) any later version.
  20  *
  21  *  This program is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  *  GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License
  27  *  along with this program; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  29  *
  30  */
  31
  32 #ifndef SQUID_HTTP_H
  33 #define SQUID_HTTP_H
  34
  35 #include "StoreIOBuffer.h"
  36 #include "comm.h"
  37 #include "comm/forward.h"
  38 #include "forward.h"
  39 #include "Server.h"
  40 #include "ChunkedCodingParser.h"
  41
  42 class HttpStateData : public ServerStateData
  43 {
  44
  45 public:
  46     HttpStateData(FwdState *);
  47     ~HttpStateData();
  48
  49     static void httpBuildRequestHeader(HttpRequest * request,
  50                                        StoreEntry * entry,
  51                                        const AccessLogEntryPointer &al,
  52                                        HttpHeader * hdr_out,
  53                                        const http_state_flags flags);
  54
  55     virtual const Comm::ConnectionPointer & dataConnection() const;
  56     /* should be private */
  57     bool sendRequest();
  58     void processReplyHeader();
  59     void processReplyBody();
  60     void readReply(const CommIoCbParams &io);
  61     virtual void maybeReadVirginBody(); // read response data from the network
  62     int cacheableReply();
  63
  64     CachePeer *_peer;           /* CachePeer request made to */
  65     int eof;                    /* reached end-of-object? */
  66     int lastChunk;              /* reached last chunk of a chunk-encoded reply */
  67     http_state_flags flags;
  68     size_t read_sz;
  69     int header_bytes_read;      // to find end of response,
  70     int64_t reply_bytes_read;   // without relying on StoreEntry
  71     int body_bytes_truncated; // positive when we read more than we wanted
  72     MemBuf *readBuf;
  73     bool ignoreCacheControl;
  74     bool surrogateNoStore;
  75
  76     void processSurrogateControl(HttpReply *);
  77
  78 protected:
  79     void processReply();
  80     void proceedAfter1xx();
  81     void handle1xx(HttpReply *msg);
  82
  83 private:
  84     /**
  85      * The current server connection.
  86      * Maybe open, closed, or NULL.
  87      * Use doneWithServer() to check if the server is available for use.
  88      */
  89     Comm::ConnectionPointer serverConnection;
  90     AsyncCall::Pointer closeHandler;
  91     enum ConnectionStatus {
  92         INCOMPLETE_MSG,
  93         COMPLETE_PERSISTENT_MSG,
  94         COMPLETE_NONPERSISTENT_MSG
  95     };
  96     ConnectionStatus statusIfComplete() const;
  97     ConnectionStatus persistentConnStatus() const;
  98     void keepaliveAccounting(HttpReply *);
  99     void checkDateSkew(HttpReply *);
 100
 101     bool continueAfterParsingHeader();
 102     void truncateVirginBody();
 103
 104     virtual void start();
 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 extern int httpCachable(const HttpRequestMethod&);
 137 extern void httpStart(FwdState *);
 138 extern const char *httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
 139
 140 #endif /* SQUID_HTTP_H */