src/http.h

   1
   2 /*
   3  * $Id: http.h,v 1.34 2008/02/12 23:55:26 rousskov Exp $
   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 "forward.h"
  40 #include "Server.h"
  41 #include "ChunkedCodingParser.h"
  42
  43 class HttpStateData : public ServerStateData
  44 {
  45
  46 public:
  47     HttpStateData(FwdState *);
  48     ~HttpStateData();
  49
  50     static void httpBuildRequestHeader(HttpRequest * request,
  51                                        HttpRequest * orig_request,
  52                                        StoreEntry * entry,
  53                                        HttpHeader * hdr_out,
  54                                        http_state_flags flags);
  55
  56     virtual int dataDescriptor() 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     HttpRequest *orig_request;
  69     int fd;
  70     http_state_flags flags;
  71     size_t read_sz;
  72     int header_bytes_read;      // to find end of response,
  73     int reply_bytes_read;       // without relying on StoreEntry
  74     MemBuf *readBuf;
  75     bool ignoreCacheControl;
  76     bool surrogateNoStore;
  77
  78     void processSurrogateControl(HttpReply *);
  79
  80 protected:
  81     virtual HttpRequest *originalRequest();
  82
  83 private:
  84     AsyncCall::Pointer closeHandler;
  85     enum ConnectionStatus {
  86         INCOMPLETE_MSG,
  87         COMPLETE_PERSISTENT_MSG,
  88         COMPLETE_NONPERSISTENT_MSG
  89     };
  90     ConnectionStatus statusIfComplete() const;
  91     ConnectionStatus persistentConnStatus() const;
  92     void keepaliveAccounting(HttpReply *);
  93     void checkDateSkew(HttpReply *);
  94
  95     bool continueAfterParsingHeader();
  96
  97     virtual void haveParsedReplyHeaders();
  98     virtual void closeServer(); // end communication with the server
  99     virtual bool doneWithServer() const; // did we end communication?
 100     virtual void abortTransaction(const char *reason); // abnormal termination
 101
 102     // consuming request body
 103     virtual void handleMoreRequestBodyAvailable();
 104     virtual void handleRequestBodyProducerAborted();
 105
 106     void writeReplyBody();
 107     bool decodeAndWriteReplyBody();
 108     void doneSendingRequestBody();
 109     void requestBodyHandler(MemBuf &);
 110     virtual void sentRequestBody(const CommIoCbParams &io);
 111     void sendComplete(const CommIoCbParams &io);
 112     void httpStateConnClosed(const CommCloseCbParams &params);
 113     void httpTimeout(const CommTimeoutCbParams &params);
 114
 115     mb_size_t buildRequestPrefix(HttpRequest * request,
 116                                  HttpRequest * orig_request,
 117                                  StoreEntry * entry,
 118                                  MemBuf * mb,
 119                                  http_state_flags flags);
 120     static bool decideIfWeDoRanges (HttpRequest * orig_request);
 121
 122     ChunkedCodingParser *httpChunkDecoder;
 123 private:
 124     CBDATA_CLASS2(HttpStateData);
 125 };
 126
 127 #endif /* SQUID_HTTP_H */