1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
|
/*
* SQUID Web Proxy Cache http://www.squid-cache.org/
* ----------------------------------------------------------
*
* Squid is the result of efforts by numerous individuals from
* the Internet community; see the CONTRIBUTORS file for full
* details. Many organizations have provided support for Squid's
* development; see the SPONSORS file for full details. Squid is
* Copyrighted (C) 2001 by the Regents of the University of
* California; see the COPYRIGHT file for full details. Squid
* incorporates software developed and/or copyrighted by other
* sources; see the CREDITS file for full details.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
*
*/
#ifndef SQUID_CLIENTSIDEREQUEST_H
#define SQUID_CLIENTSIDEREQUEST_H
#include "acl/forward.h"
#include "AccessLogEntry.h"
#include "clientStream.h"
#include "client_side.h"
#include "HttpHeaderRange.h"
#include "LogTags.h"
#if USE_ADAPTATION
#include "adaptation/forward.h"
#include "adaptation/Initiator.h"
class HttpMsg;
#endif
class ClientRequestContext;
class ConnStateData;
class MemObject;
/* client_side_request.c - client side request related routines (pure logic) */
int clientBeginRequest(const HttpRequestMethod&, char const *, CSCB *, CSD *, ClientStreamData, HttpHeader const *, char *, size_t);
class ClientHttpRequest
#if USE_ADAPTATION
: public Adaptation::Initiator, // to start adaptation transactions
public BodyConsumer // to receive reply bodies in request satisf. mode
#endif
{
public:
ClientHttpRequest(ConnStateData *csd);
~ClientHttpRequest();
/* Not implemented - present to prevent synthetic operations */
ClientHttpRequest(ClientHttpRequest const &);
ClientHttpRequest& operator=(ClientHttpRequest const &);
String rangeBoundaryStr() const;
void freeResources();
void updateCounters();
void logRequest();
_SQUID_INLINE_ MemObject * memObject() const;
bool multipartRangeRequest() const;
void processRequest();
void httpStart();
bool onlyIfCached()const;
bool gotEnough() const;
_SQUID_INLINE_ StoreEntry *storeEntry() const;
void storeEntry(StoreEntry *);
_SQUID_INLINE_ StoreEntry *loggingEntry() const;
void loggingEntry(StoreEntry *);
_SQUID_INLINE_ ConnStateData * getConn() const;
_SQUID_INLINE_ void setConn(ConnStateData *);
/** Details of the client socket which produced us.
* Treat as read-only for the lifetime of this HTTP request.
*/
Comm::ConnectionPointer clientConnection;
HttpRequest *request; /* Parsed URL ... */
char *uri;
char *log_uri;
String store_id; /* StoreID for transactions where the request member is nil */
struct {
int64_t offset;
int64_t size;
size_t headers_sz;
} out;
HttpHdrRangeIter range_iter; /* data for iterating thru range specs */
size_t req_sz; /* raw request size on input, not current request size */
/// the processing tags associated with this request transaction.
// NP: still an enum so each stage altering it must take care when replacing it.
LogTags logType;
struct timeval start_time;
AccessLogEntry::Pointer al; ///< access.log entry
struct {
bool accel;
//bool intercepted; //XXX: it's apparently never used.
//bool spoof_client_ip; //XXX: it's apparently never used.
bool internal;
bool done_copying;
bool purging;
} flags;
struct {
Http::StatusCode status;
char *location;
} redirect;
dlink_node active;
dlink_list client_stream;
int mRangeCLen();
ClientRequestContext *calloutContext;
void doCallouts();
#if USE_ADAPTATION
// AsyncJob virtual methods
virtual bool doneAll() const {
return Initiator::doneAll() &&
BodyConsumer::doneAll() && false;
}
#endif
private:
int64_t maxReplyBodySize_;
StoreEntry *entry_;
StoreEntry *loggingEntry_;
ConnStateData * conn_;
#if USE_SSL
/// whether (and how) the request needs to be bumped
Ssl::BumpMode sslBumpNeed_;
public:
/// returns raw sslBump mode value
Ssl::BumpMode sslBumpNeed() const { return sslBumpNeed_; }
/// returns true if and only if the request needs to be bumped
bool sslBumpNeeded() const { return sslBumpNeed_ == Ssl::bumpServerFirst || sslBumpNeed_ == Ssl::bumpClientFirst; }
/// set the sslBumpNeeded state
void sslBumpNeed(Ssl::BumpMode mode);
void sslBumpStart();
void sslBumpEstablish(comm_err_t errflag);
#endif
#if USE_ADAPTATION
public:
void startAdaptation(const Adaptation::ServiceGroupPointer &g);
// private but exposed for ClientRequestContext
void handleAdaptationFailure(int errDetail, bool bypassable = false);
private:
// Adaptation::Initiator API
virtual void noteAdaptationAnswer(const Adaptation::Answer &answer);
void handleAdaptedHeader(HttpMsg *msg);
void handleAdaptationBlock(const Adaptation::Answer &answer);
virtual void noteAdaptationAclCheckDone(Adaptation::ServiceGroupPointer group);
// BodyConsumer API, called by BodyPipe
virtual void noteMoreBodyDataAvailable(BodyPipe::Pointer);
virtual void noteBodyProductionEnded(BodyPipe::Pointer);
virtual void noteBodyProducerAborted(BodyPipe::Pointer);
void endRequestSatisfaction();
/// called by StoreEntry when it has more buffer space available
void resumeBodyStorage();
private:
CbcPointer<Adaptation::Initiate> virginHeadSource;
BodyPipe::Pointer adaptedBodySource;
bool request_satisfaction_mode;
int64_t request_satisfaction_offset;
#endif
private:
CBDATA_CLASS2(ClientHttpRequest);
};
/* client http based routines */
char *clientConstructTraceEcho(ClientHttpRequest *);
ACLFilledChecklist *clientAclChecklistCreate(const acl_access * acl,ClientHttpRequest * http);
int clientHttpRequestStatus(int fd, ClientHttpRequest const *http);
void clientAccessCheck(ClientHttpRequest *);
/* ones that should be elsewhere */
void tunnelStart(ClientHttpRequest *, int64_t *, int *, const AccessLogEntry::Pointer &al);
#if _USE_INLINE_
#include "Store.h"
#include "client_side_request.cci"
#endif
#endif /* SQUID_CLIENTSIDEREQUEST_H */
|