src/http.h

   1
   2 /*
   3  * $Id: http.h,v 1.22 2006/03/07 18:44:12 wessels 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 #if ICAP_CLIENT
  43 #include "ICAP/ICAPServiceRep.h"
  44
  45 class ICAPClientRespmodPrecache;
  46
  47 class ICAPAccessCheck;
  48 #endif
  49
  50 class HttpStateData : public ServerStateData
  51 {
  52
  53 public:
  54     HttpStateData(FwdState *);
  55     ~HttpStateData();
  56
  57     static CWCB SendComplete;
  58     static CWCB SendRequestEntityWrapper;
  59     static IOCB ReadReplyWrapper;
  60     static CBCB RequestBodyHandlerWrapper;
  61     static void httpBuildRequestHeader(HttpRequest * request,
  62                                        HttpRequest * orig_request,
  63                                        StoreEntry * entry,
  64                                        HttpHeader * hdr_out,
  65                                        http_state_flags flags);
  66     /* should be private */
  67     void sendRequest();
  68     void processReplyHeader();
  69     void processReplyBody();
  70     void readReply(size_t len, comm_err_t flag, int xerrno);
  71     void maybeReadData();
  72     int cacheableReply();
  73 #if ICAP_CLIENT
  74
  75     void takeAdaptedHeaders(HttpReply *);
  76     void takeAdaptedBody(MemBuf *);
  77     void doneAdapting();
  78     void abortAdapting();
  79     void icapSpaceAvailable();
  80 #endif
  81
  82     peer *_peer;                /* peer request made to */
  83     int eof;                    /* reached end-of-object? */
  84     HttpRequest *orig_request;
  85     int fd;
  86     http_state_flags flags;
  87     char *request_body_buf;
  88     off_t currentOffset;
  89     size_t read_sz;
  90     int body_bytes_read;        /* to find end of response, independent of StoreEntry */
  91     MemBuf *readBuf;
  92     bool ignoreCacheControl;
  93     bool surrogateNoStore;
  94     void processSurrogateControl(HttpReply *);
  95 #if ICAP_CLIENT
  96
  97     void icapAclCheckDone(ICAPServiceRep::Pointer);
  98     bool icapAccessCheckPending;
  99 #endif
 100
 101     /*
 102      * getReply() public only because it is called from a static function
 103      * as httpState->getReply()
 104      */
 105 #if OLD
 106 const HttpReply * getReply() const { return reply ? reply : entry->getReply(); }
 107
 108 #else
 109     const HttpReply * getReply() const { assert(reply); return reply; }
 110
 111 #endif
 112
 113 private:
 114     enum ConnectionStatus {
 115         INCOMPLETE_MSG,
 116         COMPLETE_PERSISTENT_MSG,
 117         COMPLETE_NONPERSISTENT_MSG
 118     };
 119     ConnectionStatus statusIfComplete() const;
 120     ConnectionStatus persistentConnStatus() const;
 121     void failReply (HttpReply *reply, http_status const &status);
 122     void keepaliveAccounting(HttpReply *);
 123     void checkDateSkew(HttpReply *);
 124     void haveParsedReplyHeaders();
 125     void transactionComplete();
 126     void writeReplyBody(const char *data, int len);
 127     void sendRequestEntityDone(int fd);
 128     void requestBodyHandler(char *buf, ssize_t size);
 129     void sendRequestEntity(int fd, size_t size, comm_err_t errflag);
 130     mb_size_t buildRequestPrefix(HttpRequest * request,
 131                                  HttpRequest * orig_request,
 132                                  StoreEntry * entry,
 133                                  MemBuf * mb,
 134                                  http_state_flags flags);
 135     static bool decideIfWeDoRanges (HttpRequest * orig_request);
 136
 137 private:
 138     CBDATA_CLASS2(HttpStateData);
 139 };
 140
 141 #endif /* SQUID_HTTP_H */