2 * SQUID Web Proxy Cache http://www.squid-cache.org/
3 * ----------------------------------------------------------
5 * Squid is the result of efforts by numerous individuals from
6 * the Internet community; see the CONTRIBUTORS file for full
7 * details. Many organizations have provided support for Squid's
8 * development; see the SPONSORS file for full details. Squid is
9 * Copyrighted (C) 2001 by the Regents of the University of
10 * California; see the COPYRIGHT file for full details. Squid
11 * incorporates software developed and/or copyrighted by other
12 * sources; see the CREDITS file for full details.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
28 * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
31 #ifndef SQUID_CLIENTSIDEREPLY_H
32 #define SQUID_CLIENTSIDEREPLY_H
34 #include "acl/forward.h"
35 #include "client_side_request.h"
36 #include "ip/forward.h"
37 #include "RequestFlags.h"
38 #include "StoreClient.h"
42 /* XXX make static method */
44 class clientReplyContext
: public RefCountable
, public StoreClient
49 static STCB HandleIMSReply
;
50 static STCB SendMoreData
;
52 clientReplyContext(ClientHttpRequest
*);
53 ~clientReplyContext();
58 void purgeRequestFindObjectToPurge();
59 void purgeDoMissPurge();
60 void purgeFoundGet(StoreEntry
*newEntry
);
61 void purgeFoundHead(StoreEntry
*newEntry
);
62 void purgeFoundObject(StoreEntry
*entry
);
63 void sendClientUpstreamResponse();
64 void purgeDoPurgeGet(StoreEntry
*entry
);
65 void purgeDoPurgeHead(StoreEntry
*entry
);
67 void identifyStoreObject();
68 void identifyFoundObject(StoreEntry
*entry
);
69 int storeOKTransferDone() const;
70 int storeNotOKTransferDone() const;
71 /// replaces current response store entry with the given one
72 void setReplyToStoreEntry(StoreEntry
*e
, const char *reason
);
73 /// builds error using clientBuildError() and calls setReplyToError() below
74 void setReplyToError(err_type
, Http::StatusCode
, const HttpRequestMethod
&, char const *, Ip::Address
&, HttpRequest
*, const char *,
76 Auth::UserRequest::Pointer
);
80 /// creates a store entry for the reply and appends err to it
81 void setReplyToError(const HttpRequestMethod
& method
, ErrorState
*err
);
82 void createStoreEntry(const HttpRequestMethod
& m
, RequestFlags flags
);
83 void removeStoreReference(store_client
** scp
, StoreEntry
** ep
);
84 void removeClientStoreReference(store_client
**scp
, ClientHttpRequest
*http
);
85 void startError(ErrorState
* err
);
86 void processExpired();
87 clientStream_status_t
replyStatus();
89 void traceReply(clientStreamNode
* node
);
90 const char *storeId() const { return (http
->store_id
.size() > 0 ? http
->store_id
.termedBuf() : http
->uri
); }
92 Http::StatusCode purgeStatus
;
94 /* state variable - replace with class to handle storeentries at some point */
96 virtual void created (StoreEntry
*newEntry
);
98 ClientHttpRequest
*http
;
100 store_client
*sc
; /* The store_client we're using */
101 StoreIOBuffer tempBuffer
; /* For use in validating requests via IMS */
102 int old_reqsize
; /* ... again, for the buffer */
105 char tempbuf
[HTTP_REQBUF_SZ
]; /* a temporary buffer if we need working storage */
106 #if USE_CACHE_DIGESTS
108 const char *lookup_type
; /* temporary hack: storeGet() result: HIT/MISS/NONE */
113 unsigned storelogiccomplete
:1;
115 unsigned complete
:1; /* we have read all we can from upstream */
118 clientStreamNode
*ourNode
; /* This will go away if/when this file gets refactored some more */
121 clientStreamNode
*getNextNode() const;
123 bool errorInStream(StoreIOBuffer
const &result
, size_t const &sizeToProcess
)const ;
124 void sendStreamError(StoreIOBuffer
const &result
);
125 void pushStreamData(StoreIOBuffer
const &result
, char *source
);
126 clientStreamNode
* next() const;
127 StoreIOBuffer holdingBuffer
;
129 void processReplyAccess();
130 static ACLCB ProcessReplyAccessResult
;
131 void processReplyAccessResult(const allow_t
&accessAllowed
);
133 void buildReplyHeader ();
134 bool alwaysAllowResponse(Http::StatusCode sline
) const;
135 int checkTransferDone();
136 void processOnlyIfCachedMiss();
137 void processConditional(StoreIOBuffer
&result
);
138 void cacheHit(StoreIOBuffer result
);
139 void handleIMSReply(StoreIOBuffer result
);
140 void sendMoreData(StoreIOBuffer result
);
141 void triggerInitialStoreRead();
142 void sendClientOldEntry();
143 void purgeAllCached();
145 bool blockedHit() const;
147 void sendBodyTooLargeError();
148 void sendPreconditionFailedError();
149 void sendNotModified();
150 void sendNotModifiedOrPreconditionFailedError();
152 StoreEntry
*old_entry
;
153 store_client
*old_sc
; /* ... for entry to be validated */
156 CBDATA_CLASS2(clientReplyContext
);
159 #endif /* SQUID_CLIENTSIDEREPLY_H */