src/http.h

   1
   2 /*
   3  * $Id: http.h,v 1.31 2007/07/23 19:58:46 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
  42 class HttpStateData : public ServerStateData
  43 {
  44
  45 public:
  46     HttpStateData(FwdState *);
  47     ~HttpStateData();
  48
  49     static IOCB SendComplete;
  50     static IOCB ReadReplyWrapper;
  51     static void httpBuildRequestHeader(HttpRequest * request,
  52                                        HttpRequest * orig_request,
  53                                        StoreEntry * entry,
  54                                        HttpHeader * hdr_out,
  55                                        http_state_flags flags);
  56
  57     virtual int dataDescriptor() const;
  58     /* should be private */
  59     bool sendRequest();
  60     void processReplyHeader();
  61     void processReplyBody();
  62     void readReply(size_t len, comm_err_t flag, int xerrno);
  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     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     /*
  81      * getReply() public only because it is called from a static function
  82      * as httpState->getReply()
  83      */
  84     const HttpReply * getReply() const { assert(reply); return reply; }
  85
  86 protected:
  87     virtual HttpRequest *originalRequest();
  88
  89 private:
  90     enum ConnectionStatus {
  91         INCOMPLETE_MSG,
  92         COMPLETE_PERSISTENT_MSG,
  93         COMPLETE_NONPERSISTENT_MSG
  94     };
  95     ConnectionStatus statusIfComplete() const;
  96     ConnectionStatus persistentConnStatus() const;
  97     void keepaliveAccounting(HttpReply *);
  98     void checkDateSkew(HttpReply *);
  99
 100     bool continueAfterParsingHeader();
 101
 102     virtual void haveParsedReplyHeaders();
 103     virtual void closeServer(); // end communication with the server
 104     virtual bool doneWithServer() const; // did we end communication?
 105     virtual void abortTransaction(const char *reason); // abnormal termination
 106
 107     // consuming request body
 108     virtual void handleMoreRequestBodyAvailable();
 109     virtual void handleRequestBodyProducerAborted();
 110
 111     void writeReplyBody();
 112     void doneSendingRequestBody();
 113     void requestBodyHandler(MemBuf &);
 114     virtual void sentRequestBody(int fd, size_t size, comm_err_t errflag);
 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 private:
 123     CBDATA_CLASS2(HttpStateData);
 124 };
 125
 126 #endif /* SQUID_HTTP_H */