4 * DEBUG: section 88 Client-side Reply Routines
5 * AUTHOR: Robert Collins (Originally Duane Wessels in client_side.c)
7 * SQUID Web Proxy Cache http://www.squid-cache.org/
8 * ----------------------------------------------------------
10 * Squid is the result of efforts by numerous individuals from
11 * the Internet community; see the CONTRIBUTORS file for full
12 * details. Many organizations have provided support for Squid's
13 * development; see the SPONSORS file for full details. Squid is
14 * Copyrighted (C) 2001 by the Regents of the University of
15 * California; see the COPYRIGHT file for full details. Squid
16 * incorporates software developed and/or copyrighted by other
17 * sources; see the CREDITS file for full details.
19 * This program is free software; you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation; either version 2 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program; if not, write to the Free Software
31 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
36 /* for ClientActiveRequests global */
39 /* old includes without reasons given. */
41 #include "acl/FilledChecklist.h"
42 #include "acl/Gadgets.h"
44 #include "auth/UserRequest.h"
46 #include "client_side.h"
47 #include "client_side_reply.h"
48 #include "clientStream.h"
50 #include "DelayPools.h"
52 #include "errorpage.h"
58 #include "format/Token.h"
59 #include "HttpReply.h"
60 #include "HttpRequest.h"
61 #include "ip/QosConfig.h"
63 #include "MemObject.h"
64 #include "ProtoPort.h"
65 #include "SquidTime.h"
66 #include "StoreClient.h"
69 CBDATA_CLASS_INIT(clientReplyContext
);
72 extern "C" CSS clientReplyStatus
;
73 extern ErrorState
*clientBuildError(err_type
, http_status
, char const *, Ip::Address
&, HttpRequest
*);
77 clientReplyContext::~clientReplyContext()
80 /* This may trigger a callback back into SendMoreData as the cbdata
83 removeClientStoreReference(&sc
, http
);
84 /* old_entry might still be set if we didn't yet get the reply
85 * code in HandleIMSReply() */
86 removeStoreReference(&old_sc
, &old_entry
);
87 safe_free(tempBuffer
.data
);
88 cbdataReferenceDone(http
);
92 clientReplyContext::clientReplyContext(ClientHttpRequest
*clientContext
) : http (cbdataReference(clientContext
)), old_entry (NULL
), old_sc(NULL
), deleting(false)
95 /** Create an error in the store awaiting the client side to read it.
97 * This may be better placed in the clientStream logic, but it has not been
101 clientReplyContext::setReplyToError(
102 err_type err
, http_status status
, const HttpRequestMethod
& method
, char const *uri
,
103 Ip::Address
&addr
, HttpRequest
* failedrequest
, const char *unparsedrequest
,
105 Auth::UserRequest::Pointer auth_user_request
111 ErrorState
*errstate
= clientBuildError(err
, status
, uri
, addr
, failedrequest
);
114 errstate
->request_hdrs
= xstrdup(unparsedrequest
);
116 if (status
== HTTP_NOT_IMPLEMENTED
&& http
->request
)
117 /* prevent confusion over whether we default to persistent or not */
118 http
->request
->flags
.proxy_keepalive
= 0;
120 http
->al
.http
.code
= errstate
->httpStatus
;
122 createStoreEntry(method
, request_flags());
124 errstate
->auth_user_request
= auth_user_request
;
126 assert(errstate
->callback_data
== NULL
);
127 errorAppendEntry(http
->storeEntry(), errstate
);
128 /* Now the caller reads to get this */
132 clientReplyContext::removeStoreReference(store_client
** scp
,
136 store_client
*sc_tmp
= *scp
;
138 if ((e
= *ep
) != NULL
) {
140 storeUnregister(sc_tmp
, e
, this);
147 clientReplyContext::removeClientStoreReference(store_client
**scp
, ClientHttpRequest
*aHttpRequest
)
149 StoreEntry
*reference
= aHttpRequest
->storeEntry();
150 removeStoreReference(scp
, &reference
);
151 aHttpRequest
->storeEntry(reference
);
155 clientReplyContext::operator new (size_t byteCount
)
157 /* derived classes with different sizes must implement their own new */
158 assert (byteCount
== sizeof (clientReplyContext
));
159 CBDATA_INIT_TYPE(clientReplyContext
);
160 return cbdataAlloc(clientReplyContext
);
164 clientReplyContext::operator delete (void *address
)
166 clientReplyContext
* tmp
= (clientReplyContext
*)address
;
171 clientReplyContext::saveState()
173 assert(old_sc
== NULL
);
174 debugs(88, 3, "clientReplyContext::saveState: saving store context");
175 old_entry
= http
->storeEntry();
177 old_reqsize
= reqsize
;
178 tempBuffer
.offset
= reqofs
;
179 /* Prevent accessing the now saved entries */
180 http
->storeEntry(NULL
);
187 clientReplyContext::restoreState()
189 assert(old_sc
!= NULL
);
190 debugs(88, 3, "clientReplyContext::restoreState: Restoring store context");
191 removeClientStoreReference(&sc
, http
);
192 http
->storeEntry(old_entry
);
194 reqsize
= old_reqsize
;
195 reqofs
= tempBuffer
.offset
;
196 /* Prevent accessed the old saved entries */
200 tempBuffer
.offset
= 0;
204 clientReplyContext::startError(ErrorState
* err
)
206 createStoreEntry(http
->request
->method
, request_flags());
207 triggerInitialStoreRead();
208 errorAppendEntry(http
->storeEntry(), err
);
212 clientReplyContext::getNextNode() const
214 return (clientStreamNode
*)ourNode
->node
.next
->data
;
217 /* This function is wrong - the client parameters don't include the
221 clientReplyContext::triggerInitialStoreRead()
223 /* when confident, 0 becomes reqofs, and then this factors into
227 StoreIOBuffer
localTempBuffer (next()->readBuffer
.length
, 0, next()->readBuffer
.data
);
228 storeClientCopy(sc
, http
->storeEntry(), localTempBuffer
, SendMoreData
, this);
231 /* there is an expired entry in the store.
232 * setup a temporary buffer area and perform an IMS to the origin
235 clientReplyContext::processExpired()
237 char *url
= http
->uri
;
238 StoreEntry
*entry
= NULL
;
239 debugs(88, 3, "clientReplyContext::processExpired: '" << http
->uri
<< "'");
240 assert(http
->storeEntry()->lastmod
>= 0);
242 * check if we are allowed to contact other servers
243 * @?@: Instead of a 504 (Gateway Timeout) reply, we may want to return
244 * a stale entry *if* it matches client requirements
247 if (http
->onlyIfCached()) {
248 processOnlyIfCachedMiss();
252 http
->request
->flags
.refresh
= 1;
253 #if STORE_CLIENT_LIST_DEBUG
254 /* Prevent a race with the store client memory free routines
256 assert(storeClientIsThisAClient(sc
, this));
258 /* Prepare to make a new temporary request */
260 entry
= storeCreateEntry(url
,
261 http
->log_uri
, http
->request
->flags
, http
->request
->method
);
262 /* NOTE, don't call StoreEntry->lock(), storeCreateEntry() does it */
263 sc
= storeClientListAdd(entry
, this);
265 /* delay_id is already set on original store client */
266 sc
->setDelayId(DelayId::DelayClient(http
));
269 http
->request
->lastmod
= old_entry
->lastmod
;
270 debugs(88, 5, "clientReplyContext::processExpired : lastmod " << entry
->lastmod
);
271 http
->storeEntry(entry
);
272 assert(http
->out
.offset
== 0);
273 assert(http
->request
->clientConnectionManager
== http
->getConn());
276 * A refcounted pointer so that FwdState stays around as long as
277 * this clientReplyContext does
279 Comm::ConnectionPointer conn
= http
->getConn() != NULL
? http
->getConn()->clientConnection
: NULL
;
280 FwdState::fwdStart(conn
, http
->storeEntry(), http
->request
);
282 /* Register with storage manager to receive updates when data comes in. */
284 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
))
285 debugs(88, 0, "clientReplyContext::processExpired: Found ENTRY_ABORTED object");
288 /* start counting the length from 0 */
289 StoreIOBuffer
localTempBuffer(HTTP_REQBUF_SZ
, 0, tempbuf
);
290 storeClientCopy(sc
, entry
, localTempBuffer
, HandleIMSReply
, this);
296 clientReplyContext::sendClientUpstreamResponse()
298 StoreIOBuffer tempresult
;
299 removeStoreReference(&old_sc
, &old_entry
);
300 /* here the data to send is the data we just received */
301 tempBuffer
.offset
= 0;
303 /* sendMoreData tracks the offset as well.
304 * Force it back to zero */
306 assert(!EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
));
307 /* TODO: provide sendMoreData with the ready parsed reply */
308 tempresult
.length
= reqsize
;
309 tempresult
.data
= tempbuf
;
310 sendMoreData(tempresult
);
314 clientReplyContext::HandleIMSReply(void *data
, StoreIOBuffer result
)
316 clientReplyContext
*context
= (clientReplyContext
*)data
;
317 context
->handleIMSReply(result
);
321 clientReplyContext::sendClientOldEntry()
323 /* Get the old request back */
325 /* here the data to send is in the next nodes buffers already */
326 assert(!EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
));
327 /* sendMoreData tracks the offset as well.
328 * Force it back to zero */
330 StoreIOBuffer
tempresult (reqsize
, reqofs
, next()->readBuffer
.data
);
331 sendMoreData(tempresult
);
334 /* This is the workhorse of the HandleIMSReply callback.
336 * It is called when we've got data back from the origin following our
337 * IMS request to revalidate a stale entry.
340 clientReplyContext::handleIMSReply(StoreIOBuffer result
)
345 debugs(88, 3, "handleIMSReply: " << http
->storeEntry()->url() << ", " << (long unsigned) result
.length
<< " bytes" );
347 if (http
->storeEntry() == NULL
)
350 if (result
.flags
.error
&& !EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
))
353 /* update size of the request */
354 reqsize
= result
.length
+ reqofs
;
356 const http_status status
= http
->storeEntry()->getReply()->sline
.status
;
358 // request to origin was aborted
359 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) {
360 debugs(88, 3, "handleIMSReply: request to origin aborted '" << http
->storeEntry()->url() << "', sending old entry to client" );
361 http
->logType
= LOG_TCP_REFRESH_FAIL_OLD
;
362 sendClientOldEntry();
365 HttpReply
*old_rep
= (HttpReply
*) old_entry
->getReply();
367 // origin replied 304
368 if (status
== HTTP_NOT_MODIFIED
) {
369 http
->logType
= LOG_TCP_REFRESH_UNMODIFIED
;
370 http
->request
->flags
.stale_if_hit
= 0; // old_entry is no longer stale
372 // update headers on existing entry
373 old_rep
->updateOnNotModified(http
->storeEntry()->getReply());
374 old_entry
->timestampsSet();
376 // if client sent IMS
378 if (http
->request
->flags
.ims
&& !old_entry
->modifiedSince(http
->request
)) {
379 // forward the 304 from origin
380 debugs(88, 3, "handleIMSReply: origin replied 304, revalidating existing entry and forwarding 304 to client");
381 sendClientUpstreamResponse();
383 // send existing entry, it's still valid
384 debugs(88, 3, "handleIMSReply: origin replied 304, revalidating existing entry and sending " <<
385 old_rep
->sline
.status
<< " to client");
386 sendClientOldEntry();
390 // origin replied with a non-error code
391 else if (status
> HTTP_STATUS_NONE
&& status
< HTTP_INTERNAL_SERVER_ERROR
) {
392 // forward response from origin
393 http
->logType
= LOG_TCP_REFRESH_MODIFIED
;
394 debugs(88, 3, "handleIMSReply: origin replied " << status
<< ", replacing existing entry and forwarding to client");
395 sendClientUpstreamResponse();
398 // origin replied with an error
399 else if (http
->request
->flags
.fail_on_validation_err
) {
400 http
->logType
= LOG_TCP_REFRESH_FAIL_ERR
;
401 debugs(88, 3, "handleIMSReply: origin replied with error " << status
<<
402 ", forwarding to client due to fail_on_validation_err");
403 sendClientUpstreamResponse();
405 // ignore and let client have old entry
406 http
->logType
= LOG_TCP_REFRESH_FAIL_OLD
;
407 debugs(88, 3, "handleIMSReply: origin replied with error " <<
408 status
<< ", sending old entry (" << old_rep
->sline
.status
<< ") to client");
409 sendClientOldEntry();
413 extern "C" CSR clientGetMoreData
;
414 extern "C" CSD clientReplyDetach
;
417 * clientReplyContext::cacheHit Should only be called until the HTTP reply headers
418 * have been parsed. Normally this should be a single call, but
419 * it might take more than one. As soon as we have the headers,
420 * we hand off to clientSendMoreData, processExpired, or
424 clientReplyContext::CacheHit(void *data
, StoreIOBuffer result
)
426 clientReplyContext
*context
= (clientReplyContext
*)data
;
427 context
->cacheHit(result
);
431 * Process a possible cache HIT.
434 clientReplyContext::cacheHit(StoreIOBuffer result
)
436 /** Ignore if the HIT object is being deleted. */
440 StoreEntry
*e
= http
->storeEntry();
442 HttpRequest
*r
= http
->request
;
444 debugs(88, 3, "clientCacheHit: " << http
->uri
<< ", " << result
.length
<< " bytes");
446 if (http
->storeEntry() == NULL
) {
447 debugs(88, 3, "clientCacheHit: request aborted");
449 } else if (result
.flags
.error
) {
450 /* swap in failure */
451 debugs(88, 3, "clientCacheHit: swapin failure for " << http
->uri
);
452 http
->logType
= LOG_TCP_SWAPFAIL_MISS
;
453 removeClientStoreReference(&sc
, http
);
458 if (result
.length
== 0) {
459 /* the store couldn't get enough data from the file for us to id the
462 /* treat as a miss */
463 http
->logType
= LOG_TCP_MISS
;
468 assert(!EBIT_TEST(e
->flags
, ENTRY_ABORTED
));
469 /* update size of the request */
470 reqsize
= result
.length
+ reqofs
;
473 * Got the headers, now grok them
475 assert(http
->logType
== LOG_TCP_HIT
);
477 if (strcmp(e
->mem_obj
->url
, urlCanonical(r
)) != 0) {
478 debugs(33, 1, "clientProcessHit: URL mismatch, '" << e
->mem_obj
->url
<< "' != '" << urlCanonical(r
) << "'");
483 switch (varyEvaluateMatch(e
, r
)) {
486 /* No variance detected. Continue as normal */
490 /* This is the correct entity for this request. Continue */
491 debugs(88, 2, "clientProcessHit: Vary MATCH!");
495 /* This is not the correct entity for this request. We need
496 * to requery the cache.
498 removeClientStoreReference(&sc
, http
);
500 /* Note: varyEvalyateMatch updates the request with vary information
501 * so we only get here once. (it also takes care of cancelling loops)
503 debugs(88, 2, "clientProcessHit: Vary detected!");
504 clientGetMoreData(ourNode
, http
);
508 /* varyEvaluateMatch found a object loop. Process as miss */
509 debugs(88, 1, "clientProcessHit: Vary object loop!");
514 if (r
->method
== METHOD_PURGE
) {
515 removeClientStoreReference(&sc
, http
);
521 if (e
->checkNegativeHit()
522 #if USE_HTTP_VIOLATIONS
523 && !r
->flags
.nocache_hack
526 http
->logType
= LOG_TCP_NEGATIVE_HIT
;
527 sendMoreData(result
);
528 } else if (!http
->flags
.internal
&& refreshCheckHTTP(e
, r
)) {
529 debugs(88, 5, "clientCacheHit: in refreshCheck() block");
531 * We hold a stale copy; it needs to be validated
534 * The 'need_validation' flag is used to prevent forwarding
535 * loops between siblings. If our copy of the object is stale,
536 * then we should probably only use parents for the validation
537 * request. Otherwise two siblings could generate a loop if
538 * both have a stale version of the object.
540 r
->flags
.need_validation
= 1;
542 if (e
->lastmod
< 0) {
544 * Previous reply didn't have a Last-Modified header,
545 * we cannot revalidate it.
547 http
->logType
= LOG_TCP_MISS
;
549 } else if (r
->flags
.nocache
) {
551 * This did not match a refresh pattern that overrides no-cache
552 * we should honour the client no-cache header.
554 http
->logType
= LOG_TCP_CLIENT_REFRESH_MISS
;
556 } else if (r
->protocol
== AnyP::PROTO_HTTP
) {
558 * Object needs to be revalidated
559 * XXX This could apply to FTP as well, if Last-Modified is known.
564 * We don't know how to re-validate other protocols. Handle
565 * them as if the object has expired.
567 http
->logType
= LOG_TCP_MISS
;
570 } else if (r
->conditional())
571 processConditional(result
);
574 * plain ol' cache hit
578 if (e
->store_status
!= STORE_OK
)
579 http
->logType
= LOG_TCP_MISS
;
582 if (e
->mem_status
== IN_MEMORY
)
583 http
->logType
= LOG_TCP_MEM_HIT
;
584 else if (Config
.onoff
.offline
)
585 http
->logType
= LOG_TCP_OFFLINE_HIT
;
587 sendMoreData(result
);
592 * Prepare to fetch the object as it's a cache miss of some kind.
595 clientReplyContext::processMiss()
597 char *url
= http
->uri
;
598 HttpRequest
*r
= http
->request
;
599 ErrorState
*err
= NULL
;
600 debugs(88, 4, "clientProcessMiss: '" << RequestMethodStr(r
->method
) << " " << url
<< "'");
603 * We might have a left-over StoreEntry from a failed cache hit
606 if (http
->storeEntry()) {
607 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_SPECIAL
)) {
608 debugs(88, 0, "clientProcessMiss: miss on a special object (" << url
<< ").");
609 debugs(88, 0, "\tlog_type = " << Format::log_tags
[http
->logType
]);
610 http
->storeEntry()->dump(1);
613 removeClientStoreReference(&sc
, http
);
616 /** Check if its a PURGE request to be actioned. */
617 if (r
->method
== METHOD_PURGE
) {
622 /** Check if its an 'OTHER' request. Purge all cached entries if so and continue. */
623 if (r
->method
== METHOD_OTHER
) {
627 /** Check if 'only-if-cached' flag is set. Action if so. */
628 if (http
->onlyIfCached()) {
629 processOnlyIfCachedMiss();
633 /// Deny loops for accelerator and interceptor. TODO: deny in all modes?
634 if (r
->flags
.loopdetect
&&
635 (http
->flags
.accel
|| http
->flags
.intercepted
)) {
636 http
->al
.http
.code
= HTTP_FORBIDDEN
;
637 err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
, http
->getConn()->clientConnection
->remote
, http
->request
);
638 createStoreEntry(r
->method
, request_flags());
639 errorAppendEntry(http
->storeEntry(), err
);
640 triggerInitialStoreRead();
643 assert(http
->out
.offset
== 0);
644 createStoreEntry(r
->method
, r
->flags
);
645 triggerInitialStoreRead();
647 if (http
->redirect
.status
) {
648 HttpReply
*rep
= new HttpReply
;
649 #if LOG_TCP_REDIRECTS
651 http
->logType
= LOG_TCP_REDIRECT
;
654 http
->storeEntry()->releaseRequest();
655 rep
->redirect(http
->redirect
.status
, http
->redirect
.location
);
656 http
->storeEntry()->replaceHttpReply(rep
);
657 http
->storeEntry()->complete();
661 /** Check for internal requests. Update Protocol info if so. */
662 if (http
->flags
.internal
)
663 r
->protocol
= AnyP::PROTO_INTERNAL
;
665 assert(r
->clientConnectionManager
== http
->getConn());
667 /** Start forwarding to get the new object from network */
668 Comm::ConnectionPointer conn
= http
->getConn() != NULL
? http
->getConn()->clientConnection
: NULL
;
669 FwdState::fwdStart(conn
, http
->storeEntry(), r
);
674 * client issued a request with an only-if-cached cache-control directive;
675 * we did not find a cached object that can be returned without
676 * contacting other servers;
677 * respond with a 504 (Gateway Timeout) as suggested in [RFC 2068]
680 clientReplyContext::processOnlyIfCachedMiss()
682 debugs(88, 4, "clientProcessOnlyIfCachedMiss: '" <<
683 RequestMethodStr(http
->request
->method
) << " " << http
->uri
<< "'");
684 http
->al
.http
.code
= HTTP_GATEWAY_TIMEOUT
;
685 ErrorState
*err
= clientBuildError(ERR_ONLY_IF_CACHED_MISS
, HTTP_GATEWAY_TIMEOUT
, NULL
,
686 http
->getConn()->clientConnection
->remote
, http
->request
);
687 removeClientStoreReference(&sc
, http
);
691 /// process conditional request from client
693 clientReplyContext::processConditional(StoreIOBuffer
&result
)
695 StoreEntry
*const e
= http
->storeEntry();
697 if (e
->getReply()->sline
.status
!= HTTP_OK
) {
698 debugs(88, 4, "clientReplyContext::processConditional: Reply code " <<
699 e
->getReply()->sline
.status
<< " != 200");
700 http
->logType
= LOG_TCP_MISS
;
705 HttpRequest
&r
= *http
->request
;
707 if (r
.header
.has(HDR_IF_MATCH
) && !e
->hasIfMatchEtag(r
)) {
708 // RFC 2616: reply with 412 Precondition Failed if If-Match did not match
709 sendPreconditionFailedError();
713 bool matchedIfNoneMatch
= false;
714 if (r
.header
.has(HDR_IF_NONE_MATCH
)) {
715 if (!e
->hasIfNoneMatchEtag(r
)) {
716 // RFC 2616: ignore IMS if If-None-Match did not match
720 r
.header
.delById(HDR_IF_MODIFIED_SINCE
);
721 http
->logType
= LOG_TCP_MISS
;
722 sendMoreData(result
);
727 // RFC 2616: if If-None-Match matched and there is no IMS,
728 // reply with 304 Not Modified or 412 Precondition Failed
729 sendNotModifiedOrPreconditionFailedError();
733 // otherwise check IMS below to decide if we reply with 304 or 412
734 matchedIfNoneMatch
= true;
738 // handle If-Modified-Since requests from the client
739 if (e
->modifiedSince(&r
)) {
740 http
->logType
= LOG_TCP_IMS_HIT
;
741 sendMoreData(result
);
745 if (matchedIfNoneMatch
) {
746 // If-None-Match matched, reply with 304 Not Modified or
747 // 412 Precondition Failed
748 sendNotModifiedOrPreconditionFailedError();
752 // otherwise reply with 304 Not Modified
758 clientReplyContext::purgeRequestFindObjectToPurge()
760 /* Try to find a base entry */
761 http
->flags
.purging
= 1;
764 // TODO: can we use purgeAllCached() here instead of doing the
765 // getPublicByRequestMethod() dance?
766 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_GET
);
769 // Purges all entries with a given url
770 // TODO: move to SideAgent parent, when we have one
772 * We probably cannot purge Vary-affected responses because their MD5
773 * keys depend on vary headers.
776 purgeEntriesByUrl(HttpRequest
* req
, const char *url
)
779 bool get_or_head_sent
= false;
782 for (HttpRequestMethod
m(METHOD_NONE
); m
!= METHOD_ENUM_END
; ++m
) {
783 if (m
.isCacheble()) {
784 if (StoreEntry
*entry
= storeGetPublic(url
, m
)) {
785 debugs(88, 5, "purging " << RequestMethodStr(m
) << ' ' << url
);
787 neighborsHtcpClear(entry
, url
, req
, m
, HTCP_CLR_INVALIDATION
);
788 if (m
== METHOD_GET
|| m
== METHOD_HEAD
) {
789 get_or_head_sent
= true;
798 if (!get_or_head_sent
) {
799 neighborsHtcpClear(NULL
, url
, req
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_INVALIDATION
);
805 clientReplyContext::purgeAllCached()
807 const char *url
= urlCanonical(http
->request
);
808 purgeEntriesByUrl(http
->request
, url
);
812 clientReplyContext::created(StoreEntry
*newEntry
)
814 if (lookingforstore
== 1)
815 purgeFoundGet(newEntry
);
816 else if (lookingforstore
== 2)
817 purgeFoundHead(newEntry
);
818 else if (lookingforstore
== 3)
819 purgeDoPurgeGet(newEntry
);
820 else if (lookingforstore
== 4)
821 purgeDoPurgeHead(newEntry
);
822 else if (lookingforstore
== 5)
823 identifyFoundObject(newEntry
);
827 clientReplyContext::purgeFoundGet(StoreEntry
*newEntry
)
829 if (newEntry
->isNull()) {
831 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_HEAD
);
833 purgeFoundObject (newEntry
);
837 clientReplyContext::purgeFoundHead(StoreEntry
*newEntry
)
839 if (newEntry
->isNull())
842 purgeFoundObject (newEntry
);
846 clientReplyContext::purgeFoundObject(StoreEntry
*entry
)
848 assert (entry
&& !entry
->isNull());
850 if (EBIT_TEST(entry
->flags
, ENTRY_SPECIAL
)) {
851 http
->logType
= LOG_TCP_DENIED
;
852 ErrorState
*err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
,
853 http
->getConn()->clientConnection
->remote
, http
->request
);
858 StoreIOBuffer localTempBuffer
;
859 /* Swap in the metadata */
860 http
->storeEntry(entry
);
862 http
->storeEntry()->lock();
863 http
->storeEntry()->createMemObject(http
->uri
, http
->log_uri
);
865 http
->storeEntry()->mem_obj
->method
= http
->request
->method
;
867 sc
= storeClientListAdd(http
->storeEntry(), this);
869 http
->logType
= LOG_TCP_HIT
;
873 localTempBuffer
.offset
= http
->out
.offset
;
875 localTempBuffer
.length
= next()->readBuffer
.length
;
877 localTempBuffer
.data
= next()->readBuffer
.data
;
879 storeClientCopy(sc
, http
->storeEntry(),
880 localTempBuffer
, CacheHit
, this);
884 clientReplyContext::purgeRequest()
886 debugs(88, 3, "Config2.onoff.enable_purge = " <<
887 Config2
.onoff
.enable_purge
);
889 if (!Config2
.onoff
.enable_purge
) {
890 http
->logType
= LOG_TCP_DENIED
;
891 ErrorState
*err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
, http
->getConn()->clientConnection
->remote
, http
->request
);
896 /* Release both IP cache */
897 ipcacheInvalidate(http
->request
->GetHost());
899 if (!http
->flags
.purging
)
900 purgeRequestFindObjectToPurge();
906 clientReplyContext::purgeDoMissPurge()
908 http
->logType
= LOG_TCP_MISS
;
910 StoreEntry::getPublicByRequestMethod(this,http
->request
, METHOD_GET
);
914 clientReplyContext::purgeDoPurgeGet(StoreEntry
*newEntry
)
917 /* Move to new() when that is created */
918 purgeStatus
= HTTP_NOT_FOUND
;
920 if (!newEntry
->isNull()) {
921 /* Release the cached URI */
922 debugs(88, 4, "clientPurgeRequest: GET '" << newEntry
->url() << "'" );
924 neighborsHtcpClear(newEntry
, NULL
, http
->request
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_PURGE
);
927 purgeStatus
= HTTP_OK
;
931 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_HEAD
);
935 clientReplyContext::purgeDoPurgeHead(StoreEntry
*newEntry
)
937 if (newEntry
&& !newEntry
->isNull()) {
938 debugs(88, 4, "clientPurgeRequest: HEAD '" << newEntry
->url() << "'" );
940 neighborsHtcpClear(newEntry
, NULL
, http
->request
, HttpRequestMethod(METHOD_HEAD
), HTCP_CLR_PURGE
);
943 purgeStatus
= HTTP_OK
;
946 /* And for Vary, release the base URI if none of the headers was included in the request */
948 if (http
->request
->vary_headers
949 && !strstr(http
->request
->vary_headers
, "=")) {
950 StoreEntry
*entry
= storeGetPublic(urlCanonical(http
->request
), METHOD_GET
);
953 debugs(88, 4, "clientPurgeRequest: Vary GET '" << entry
->url() << "'" );
955 neighborsHtcpClear(entry
, NULL
, http
->request
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_PURGE
);
958 purgeStatus
= HTTP_OK
;
961 entry
= storeGetPublic(urlCanonical(http
->request
), METHOD_HEAD
);
964 debugs(88, 4, "clientPurgeRequest: Vary HEAD '" << entry
->url() << "'" );
966 neighborsHtcpClear(entry
, NULL
, http
->request
, HttpRequestMethod(METHOD_HEAD
), HTCP_CLR_PURGE
);
969 purgeStatus
= HTTP_OK
;
974 * Make a new entry to hold the reply to be written
977 /* FIXME: This doesn't need to go through the store. Simply
978 * push down the client chain
980 createStoreEntry(http
->request
->method
, request_flags());
982 triggerInitialStoreRead();
984 HttpReply
*rep
= new HttpReply
;
985 rep
->setHeaders(purgeStatus
, NULL
, NULL
, 0, 0, -1);
986 http
->storeEntry()->replaceHttpReply(rep
);
987 http
->storeEntry()->complete();
991 clientReplyContext::traceReply(clientStreamNode
* node
)
993 clientStreamNode
*nextNode
= (clientStreamNode
*)node
->node
.next
->data
;
994 StoreIOBuffer localTempBuffer
;
995 createStoreEntry(http
->request
->method
, request_flags());
996 localTempBuffer
.offset
= nextNode
->readBuffer
.offset
+ headers_sz
;
997 localTempBuffer
.length
= nextNode
->readBuffer
.length
;
998 localTempBuffer
.data
= nextNode
->readBuffer
.data
;
999 storeClientCopy(sc
, http
->storeEntry(),
1000 localTempBuffer
, SendMoreData
, this);
1001 http
->storeEntry()->releaseRequest();
1002 http
->storeEntry()->buffer();
1003 HttpReply
*rep
= new HttpReply
;
1004 rep
->setHeaders(HTTP_OK
, NULL
, "text/plain", http
->request
->prefixLen(), 0, squid_curtime
);
1005 http
->storeEntry()->replaceHttpReply(rep
);
1006 http
->request
->swapOut(http
->storeEntry());
1007 http
->storeEntry()->complete();
1010 #define SENDING_BODY 0
1011 #define SENDING_HDRSONLY 1
1013 clientReplyContext::checkTransferDone()
1015 StoreEntry
*entry
= http
->storeEntry();
1021 * For now, 'done_copying' is used for special cases like
1022 * Range and HEAD requests.
1024 if (http
->flags
.done_copying
)
1027 if (http
->request
->flags
.chunked_reply
&& !flags
.complete
) {
1028 // last-chunk was not sent
1033 * Handle STORE_OK objects.
1034 * objectLen(entry) will be set proprely.
1035 * RC: Does objectLen(entry) include the Headers?
1038 if (entry
->store_status
== STORE_OK
) {
1039 return storeOKTransferDone();
1041 return storeNotOKTransferDone();
1046 clientReplyContext::storeOKTransferDone() const
1048 assert(http
->storeEntry()->objectLen() >= 0);
1049 assert(http
->storeEntry()->objectLen() >= headers_sz
);
1050 if (http
->out
.offset
>= http
->storeEntry()->objectLen() - headers_sz
) {
1051 debugs(88,3,HERE
<< "storeOKTransferDone " <<
1052 " out.offset=" << http
->out
.offset
<<
1053 " objectLen()=" << http
->storeEntry()->objectLen() <<
1054 " headers_sz=" << headers_sz
);
1062 clientReplyContext::storeNotOKTransferDone() const
1065 * Now, handle STORE_PENDING objects
1067 MemObject
*mem
= http
->storeEntry()->mem_obj
;
1068 assert(mem
!= NULL
);
1069 assert(http
->request
!= NULL
);
1070 /* mem->reply was wrong because it uses the UPSTREAM header length!!! */
1071 HttpReply
const *curReply
= mem
->getReply();
1073 if (headers_sz
== 0)
1074 /* haven't found end of headers yet */
1078 * Figure out how much data we are supposed to send.
1079 * If we are sending a body and we don't have a content-length,
1080 * then we must wait for the object to become STORE_OK.
1082 if (curReply
->content_length
< 0)
1085 int64_t expectedLength
= curReply
->content_length
+ http
->out
.headers_sz
;
1087 if (http
->out
.size
< expectedLength
)
1090 debugs(88,3,HERE
<< "storeNotOKTransferDone " <<
1091 " out.size=" << http
->out
.size
<<
1092 " expectedLength=" << expectedLength
);
1098 /* A write has completed, what is the next status based on the
1099 * canonical request data?
1100 * 1 something is wrong
1101 * 0 nothing is wrong.
1105 clientHttpRequestStatus(int fd
, ClientHttpRequest
const *http
)
1107 #if SIZEOF_INT64_T == 4
1108 if (http
->out
.size
> 0x7FFF0000) {
1109 debugs(88, 1, "WARNING: closing FD " << fd
<< " to prevent out.size counter overflow");
1110 debugs(88, 1, "\tclient " << http
->getConn()->peer
);
1111 debugs(88, 1, "\treceived " << http
->out
.size
<< " bytes");
1112 debugs(88, 1, "\tURI " << http
->log_uri
);
1116 if (http
->out
.offset
> 0x7FFF0000) {
1117 debugs(88, 1, "WARNING: closing FD " << fd
< " to prevent out.offset counter overflow");
1118 debugs(88, 1, "\tclient " << http
->getConn()->peer
);
1119 debugs(88, 1, "\treceived " << http
->out
.size
<< " bytes, offset " << http
->out
.offset
);
1120 debugs(88, 1, "\tURI " << http
->log_uri
);
1129 * *http is a valid structure.
1130 * fd is either -1, or an open fd.
1132 * TODO: enumify this
1134 * This function is used by any http request sink, to determine the status
1137 clientStream_status_t
1138 clientReplyStatus(clientStreamNode
* aNode
, ClientHttpRequest
* http
)
1140 clientReplyContext
*context
= dynamic_cast<clientReplyContext
*>(aNode
->data
.getRaw());
1142 assert (context
->http
== http
);
1143 return context
->replyStatus();
1146 clientStream_status_t
1147 clientReplyContext::replyStatus()
1150 /* Here because lower nodes don't need it */
1152 if (http
->storeEntry() == NULL
) {
1153 debugs(88, 5, "clientReplyStatus: no storeEntry");
1154 return STREAM_FAILED
; /* yuck, but what can we do? */
1157 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) {
1158 /* TODO: Could upstream read errors (result.flags.error) be
1159 * lost, and result in undersize requests being considered
1160 * complete. Should we tcp reset such connections ?
1162 debugs(88, 5, "clientReplyStatus: aborted storeEntry");
1163 return STREAM_FAILED
;
1166 if ((done
= checkTransferDone()) != 0 || flags
.complete
) {
1167 debugs(88, 5, "clientReplyStatus: transfer is DONE");
1168 /* Ok we're finished, but how? */
1170 const int64_t expectedBodySize
=
1171 http
->storeEntry()->getReply()->bodySize(http
->request
->method
);
1172 if (!http
->request
->flags
.proxy_keepalive
&& expectedBodySize
< 0) {
1173 debugs(88, 5, "clientReplyStatus: closing, content_length < 0");
1174 return STREAM_FAILED
;
1178 debugs(88, 5, "clientReplyStatus: closing, !done, but read 0 bytes");
1179 return STREAM_FAILED
;
1182 if (expectedBodySize
>= 0 && !http
->gotEnough()) {
1183 debugs(88, 5, "clientReplyStatus: client didn't get all it expected");
1184 return STREAM_UNPLANNED_COMPLETE
;
1187 if (http
->request
->flags
.proxy_keepalive
) {
1188 debugs(88, 5, "clientReplyStatus: stream complete and can keepalive");
1189 return STREAM_COMPLETE
;
1192 debugs(88, 5, "clientReplyStatus: stream was not expected to complete!");
1193 return STREAM_UNPLANNED_COMPLETE
;
1196 // XXX: Should this be checked earlier? We could return above w/o checking.
1197 if (reply
->receivedBodyTooLarge(*http
->request
, http
->out
.offset
- 4096)) {
1198 /* 4096 is a margin for the HTTP headers included in out.offset */
1199 debugs(88, 5, "clientReplyStatus: client reply body is too large");
1200 return STREAM_FAILED
;
1206 /* Responses with no body will not have a content-type header,
1207 * which breaks the rep_mime_type acl, which
1208 * coincidentally, is the most common acl for reply access lists.
1209 * A better long term fix for this is to allow acl matchs on the various
1210 * status codes, and then supply a default ruleset that puts these
1211 * codes before any user defines access entries. That way the user
1212 * can choose to block these responses where appropriate, but won't get
1213 * mysterious breakages.
1216 clientReplyContext::alwaysAllowResponse(http_status sline
) const
1224 case HTTP_SWITCHING_PROTOCOLS
:
1226 case HTTP_PROCESSING
:
1228 case HTTP_NO_CONTENT
:
1230 case HTTP_NOT_MODIFIED
:
1242 * Generate the reply headers sent to client.
1244 * Filters out unwanted entries and hop-by-hop from original reply header
1245 * then adds extra entries if we have more info than origin server
1246 * then adds Squid specific entries
1249 clientReplyContext::buildReplyHeader()
1251 HttpHeader
*hdr
= &reply
->header
;
1252 int is_hit
= logTypeIsATcpHit(http
->logType
);
1253 HttpRequest
*request
= http
->request
;
1254 #if DONT_FILTER_THESE
1255 /* but you might want to if you run Squid as an HTTP accelerator */
1256 /* hdr->delById(HDR_ACCEPT_RANGES); */
1257 hdr
->delById(HDR_ETAG
);
1261 hdr
->delById(HDR_SET_COOKIE
);
1262 // TODO: RFC 2965 : Must honour Cache-Control: no-cache="set-cookie2" and remove header.
1264 // if there is not configured a peer proxy with login=PASS or login=PASSTHRU option enabled
1265 // remove the Proxy-Authenticate header
1266 if ( !request
->peer_login
|| (strcmp(request
->peer_login
,"PASS") != 0 && strcmp(request
->peer_login
,"PASSTHRU") != 0))
1267 reply
->header
.delById(HDR_PROXY_AUTHENTICATE
);
1269 reply
->header
.removeHopByHopEntries();
1271 // if (request->range)
1272 // clientBuildRangeHeader(http, reply);
1275 * Add a estimated Age header on cache hits.
1279 * Remove any existing Age header sent by upstream caches
1280 * (note that the existing header is passed along unmodified
1283 hdr
->delById(HDR_AGE
);
1285 * This adds the calculated object age. Note that the details of the
1286 * age calculation is performed by adjusting the timestamp in
1287 * StoreEntry::timestampsSet(), not here.
1290 // XXX: realy useless? or is there a bug now that this is detatched from the below if-sequence ?
1291 // looks like this pre-if was supposed to be the browser workaround...
1292 if (NULL
== http
->storeEntry())
1294 else if (http
->storeEntry()->timestamp
< 0)
1298 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_SPECIAL
)) {
1299 hdr
->delById(HDR_DATE
);
1300 hdr
->insertTime(HDR_DATE
, squid_curtime
);
1301 } else if (http
->getConn() && http
->getConn()->port
->actAsOrigin
) {
1302 // Swap the Date: header to current time if we are simulating an origin
1303 HttpHeaderEntry
*h
= hdr
->findEntry(HDR_DATE
);
1305 hdr
->putExt("X-Origin-Date", h
->value
.termedBuf());
1306 hdr
->delById(HDR_DATE
);
1307 hdr
->insertTime(HDR_DATE
, squid_curtime
);
1308 h
= hdr
->findEntry(HDR_EXPIRES
);
1309 if (h
&& http
->storeEntry()->expires
>= 0) {
1310 hdr
->putExt("X-Origin-Expires", h
->value
.termedBuf());
1311 hdr
->delById(HDR_EXPIRES
);
1312 hdr
->insertTime(HDR_EXPIRES
, squid_curtime
+ http
->storeEntry()->expires
- http
->storeEntry()->timestamp
);
1314 if (http
->storeEntry()->timestamp
<= squid_curtime
) {
1315 // put X-Cache-Age: instead of Age:
1317 snprintf(age
, sizeof(age
), "%ld", (long int) squid_curtime
- http
->storeEntry()->timestamp
);
1318 hdr
->putExt("X-Cache-Age", age
);
1320 } else if (http
->storeEntry()->timestamp
<= squid_curtime
) {
1321 hdr
->putInt(HDR_AGE
,
1322 squid_curtime
- http
->storeEntry()->timestamp
);
1323 /* Signal old objects. NB: rfc 2616 is not clear,
1324 * by implication, on whether we should do this to all
1325 * responses, or only cache hits.
1326 * 14.46 states it ONLY applys for heuristically caclulated
1327 * freshness values, 13.2.4 doesn't specify the same limitation.
1328 * We interpret RFC 2616 under the combination.
1330 /* TODO: if maxage or s-maxage is present, don't do this */
1332 if (squid_curtime
- http
->storeEntry()->timestamp
>= 86400) {
1334 snprintf (tbuf
, sizeof(tbuf
), "%s %s %s",
1336 "This cache hit is still fresh and more than 1 day old");
1337 hdr
->putStr(HDR_WARNING
, tbuf
);
1342 /* RFC 2616: Section 14.18
1344 * Add a Date: header if missing.
1345 * We have access to a clock therefore are required to amend any shortcoming in servers.
1347 * NP: done after Age: to prevent ENTRY_SPECIAL double-handling this header.
1349 if ( !hdr
->has(HDR_DATE
) ) {
1350 if (!http
->storeEntry())
1351 hdr
->insertTime(HDR_DATE
, squid_curtime
);
1352 else if (http
->storeEntry()->timestamp
> 0)
1353 hdr
->insertTime(HDR_DATE
, http
->storeEntry()->timestamp
);
1355 debugs(88,DBG_IMPORTANT
,"WARNING: An error inside Squid has caused an HTTP reply without Date:. Please report this:");
1356 /* dump something useful about the problem */
1357 http
->storeEntry()->dump(DBG_IMPORTANT
);
1361 // add Warnings required by RFC 2616 if serving a stale hit
1362 if (http
->request
->flags
.stale_if_hit
&& logTypeIsATcpHit(http
->logType
)) {
1363 hdr
->putWarning(110, "Response is stale");
1364 if (http
->request
->flags
.need_validation
)
1365 hdr
->putWarning(111, "Revalidation failed");
1368 /* Filter unproxyable authentication types */
1369 if (http
->logType
!= LOG_TCP_DENIED
&&
1370 hdr
->has(HDR_WWW_AUTHENTICATE
)) {
1371 HttpHeaderPos pos
= HttpHeaderInitPos
;
1374 int connection_auth_blocked
= 0;
1375 while ((e
= hdr
->getEntry(&pos
))) {
1376 if (e
->id
== HDR_WWW_AUTHENTICATE
) {
1377 const char *value
= e
->value
.rawBuf();
1379 if ((strncasecmp(value
, "NTLM", 4) == 0 &&
1380 (value
[4] == '\0' || value
[4] == ' '))
1382 (strncasecmp(value
, "Negotiate", 9) == 0 &&
1383 (value
[9] == '\0' || value
[9] == ' '))
1385 (strncasecmp(value
, "Kerberos", 8) == 0 &&
1386 (value
[8] == '\0' || value
[8] == ' '))) {
1387 if (request
->flags
.connection_auth_disabled
) {
1388 hdr
->delAt(pos
, connection_auth_blocked
);
1391 request
->flags
.must_keepalive
= 1;
1392 if (!request
->flags
.accelerated
&& !request
->flags
.intercepted
) {
1393 httpHeaderPutStrf(hdr
, HDR_PROXY_SUPPORT
, "Session-Based-Authentication");
1395 We send "[Proxy-]Connection: Proxy-Support" header to mark
1396 Proxy-Support as a hop-by-hop header for intermediaries that do not
1397 understand the semantics of this header. The RFC should have included
1398 this recommendation.
1400 httpHeaderPutStrf(hdr
, HDR_CONNECTION
, "Proxy-support");
1407 if (connection_auth_blocked
)
1412 /* Handle authentication headers */
1413 if (http
->logType
== LOG_TCP_DENIED
&&
1414 ( reply
->sline
.status
== HTTP_PROXY_AUTHENTICATION_REQUIRED
||
1415 reply
->sline
.status
== HTTP_UNAUTHORIZED
)
1417 /* Add authentication header */
1418 /*! \todo alter errorstate to be accel on|off aware. The 0 on the next line
1419 * depends on authenticate behaviour: all schemes to date send no extra
1420 * data on 407/401 responses, and do not check the accel state on 401/407
1423 authenticateFixHeader(reply
, request
->auth_user_request
, request
, 0, 1);
1424 } else if (request
->auth_user_request
!= NULL
)
1425 authenticateFixHeader(reply
, request
->auth_user_request
, request
, http
->flags
.accel
, 0);
1428 /* Append X-Cache */
1429 httpHeaderPutStrf(hdr
, HDR_X_CACHE
, "%s from %s",
1430 is_hit
? "HIT" : "MISS", getMyHostname());
1432 #if USE_CACHE_DIGESTS
1433 /* Append X-Cache-Lookup: -- temporary hack, to be removed @?@ @?@ */
1434 httpHeaderPutStrf(hdr
, HDR_X_CACHE_LOOKUP
, "%s from %s:%d",
1435 lookup_type
? lookup_type
: "NONE",
1436 getMyHostname(), getMyPort());
1440 const bool maySendChunkedReply
= !request
->multipartRangeRequest() &&
1441 (request
->http_ver
>= HttpVersion(1, 1));
1443 /* Check whether we should send keep-alive */
1444 if (!Config
.onoff
.error_pconns
&& reply
->sline
.status
>= 400 && !request
->flags
.must_keepalive
) {
1445 debugs(33, 3, "clientBuildReplyHeader: Error, don't keep-alive");
1446 request
->flags
.proxy_keepalive
= 0;
1447 } else if (!Config
.onoff
.client_pconns
&& !request
->flags
.must_keepalive
) {
1448 debugs(33, 2, "clientBuildReplyHeader: Connection Keep-Alive not requested by admin or client");
1449 request
->flags
.proxy_keepalive
= 0;
1450 } else if (request
->flags
.proxy_keepalive
&& shutting_down
) {
1451 debugs(88, 3, "clientBuildReplyHeader: Shutting down, don't keep-alive.");
1452 request
->flags
.proxy_keepalive
= 0;
1453 } else if (request
->flags
.connection_auth
&& !reply
->keep_alive
) {
1454 debugs(33, 2, "clientBuildReplyHeader: Connection oriented auth but server side non-persistent");
1455 request
->flags
.proxy_keepalive
= 0;
1456 } else if (reply
->bodySize(request
->method
) < 0 && !maySendChunkedReply
) {
1457 debugs(88, 3, "clientBuildReplyHeader: can't keep-alive, unknown body size" );
1458 request
->flags
.proxy_keepalive
= 0;
1459 } else if (fdUsageHigh()&& !request
->flags
.must_keepalive
) {
1460 debugs(88, 3, "clientBuildReplyHeader: Not many unused FDs, can't keep-alive");
1461 request
->flags
.proxy_keepalive
= 0;
1464 // Decide if we send chunked reply
1465 if (maySendChunkedReply
&&
1466 request
->flags
.proxy_keepalive
&&
1467 reply
->bodySize(request
->method
) < 0) {
1468 debugs(88, 3, "clientBuildReplyHeader: chunked reply");
1469 request
->flags
.chunked_reply
= 1;
1470 hdr
->putStr(HDR_TRANSFER_ENCODING
, "chunked");
1474 if (Config
.onoff
.via
) {
1475 LOCAL_ARRAY(char, bbuf
, MAX_URL
+ 32);
1477 hdr
->getList(HDR_VIA
, &strVia
);
1478 snprintf(bbuf
, MAX_URL
+ 32, "%d.%d %s",
1479 reply
->sline
.version
.major
,
1480 reply
->sline
.version
.minor
,
1482 strListAdd(&strVia
, bbuf
, ',');
1483 hdr
->delById(HDR_VIA
);
1484 hdr
->putStr(HDR_VIA
, strVia
.termedBuf());
1486 /* Signal keep-alive or close explicitly */
1487 hdr
->putStr(HDR_CONNECTION
, request
->flags
.proxy_keepalive
? "keep-alive" : "close");
1489 #if ADD_X_REQUEST_URI
1491 * Knowing the URI of the request is useful when debugging persistent
1492 * connections in a client; we cannot guarantee the order of http headers,
1493 * but X-Request-URI is likely to be the very last header to ease use from a
1494 * debugger [hdr->entries.count-1].
1496 hdr
->putStr(HDR_X_REQUEST_URI
,
1497 http
->memOjbect()->url
? http
->memObject()->url
: http
->uri
);
1501 /* Surrogate-Control requires Surrogate-Capability from upstream to pass on */
1502 if ( hdr
->has(HDR_SURROGATE_CONTROL
) ) {
1503 if (!request
->header
.has(HDR_SURROGATE_CAPABILITY
)) {
1504 hdr
->delById(HDR_SURROGATE_CONTROL
);
1506 /* TODO: else case: drop any controls intended specifically for our surrogate ID */
1509 httpHdrMangleList(hdr
, request
, ROR_REPLY
);
1514 clientReplyContext::cloneReply()
1516 assert(reply
== NULL
);
1518 HttpReply
*rep
= http
->storeEntry()->getReply()->clone();
1520 reply
= HTTPMSGLOCK(rep
);
1522 if (reply
->sline
.protocol
== AnyP::PROTO_HTTP
) {
1523 /* RFC 2616 requires us to advertise our 1.1 version (but only on real HTTP traffic) */
1524 reply
->sline
.version
= HttpVersion(1,1);
1527 /* do header conversions */
1532 clientReplyContext::identifyStoreObject()
1534 HttpRequest
*r
= http
->request
;
1536 if (r
->flags
.cachable
|| r
->flags
.internal
) {
1537 lookingforstore
= 5;
1538 StoreEntry::getPublicByRequest (this, r
);
1540 identifyFoundObject (NullStoreEntry::getInstance());
1545 * Check state of the current StoreEntry object.
1546 * to see if we can determine the final status of the request.
1549 clientReplyContext::identifyFoundObject(StoreEntry
*newEntry
)
1551 StoreEntry
*e
= newEntry
;
1552 HttpRequest
*r
= http
->request
;
1554 /** \li If the entry received isNull() then we ignore it. */
1556 http
->storeEntry(NULL
);
1558 http
->storeEntry(e
);
1561 e
= http
->storeEntry();
1563 /* Release IP-cache entries on reload */
1564 /** \li If the request has no-cache flag set or some no_cache HACK in operation we
1565 * 'invalidate' the cached IP entries for this request ???
1567 if (r
->flags
.nocache
) {
1570 ipcacheInvalidate(r
->GetHost());
1572 ipcacheInvalidateNegative(r
->GetHost());
1573 #endif /* USE_DNSHELPER */
1577 #if USE_HTTP_VIOLATIONS
1579 else if (r
->flags
.nocache_hack
) {
1582 ipcacheInvalidate(r
->GetHost());
1584 ipcacheInvalidateNegative(r
->GetHost());
1585 #endif /* USE_DNSHELPER */
1589 #endif /* USE_HTTP_VIOLATIONS */
1590 #if USE_CACHE_DIGESTS
1592 lookup_type
= http
->storeEntry() ? "HIT" : "MISS";
1596 if (NULL
== http
->storeEntry()) {
1597 /** \li If no StoreEntry object is current assume this object isn't in the cache set MISS*/
1598 debugs(85, 3, "clientProcessRequest2: StoreEntry is NULL - MISS");
1599 http
->logType
= LOG_TCP_MISS
;
1604 if (Config
.onoff
.offline
) {
1605 /** \li If we are running in offline mode set to HIT */
1606 debugs(85, 3, "clientProcessRequest2: offline HIT");
1607 http
->logType
= LOG_TCP_HIT
;
1612 if (http
->redirect
.status
) {
1613 /** \li If redirection status is True force this to be a MISS */
1614 debugs(85, 3, "clientProcessRequest2: redirectStatus forced StoreEntry to NULL - MISS");
1615 http
->storeEntry(NULL
);
1616 http
->logType
= LOG_TCP_MISS
;
1621 if (!e
->validToSend()) {
1622 debugs(85, 3, "clientProcessRequest2: !storeEntryValidToSend MISS" );
1623 http
->storeEntry(NULL
);
1624 http
->logType
= LOG_TCP_MISS
;
1629 if (EBIT_TEST(e
->flags
, ENTRY_SPECIAL
)) {
1630 /* \li Special entries are always hits, no matter what the client says */
1631 debugs(85, 3, "clientProcessRequest2: ENTRY_SPECIAL HIT");
1632 http
->logType
= LOG_TCP_HIT
;
1637 if (r
->flags
.nocache
) {
1638 debugs(85, 3, "clientProcessRequest2: no-cache REFRESH MISS");
1639 http
->storeEntry(NULL
);
1640 http
->logType
= LOG_TCP_CLIENT_REFRESH_MISS
;
1645 debugs(85, 3, "clientProcessRequest2: default HIT");
1646 http
->logType
= LOG_TCP_HIT
;
1651 * Request more data from the store for the client Stream
1652 * This is *the* entry point to this module.
1655 * - This is the head of the list.
1656 * - There is at least one more node.
1657 * - Data context is not null
1660 clientGetMoreData(clientStreamNode
* aNode
, ClientHttpRequest
* http
)
1662 /* Test preconditions */
1663 assert(aNode
!= NULL
);
1664 assert(cbdataReferenceValid(aNode
));
1665 assert(aNode
->node
.prev
== NULL
);
1666 assert(aNode
->node
.next
!= NULL
);
1667 clientReplyContext
*context
= dynamic_cast<clientReplyContext
*>(aNode
->data
.getRaw());
1669 assert(context
->http
== http
);
1672 clientStreamNode
*next
= ( clientStreamNode
*)aNode
->node
.next
->data
;
1674 if (!context
->ourNode
)
1675 context
->ourNode
= aNode
;
1677 /* no cbdatareference, this is only used once, and safely */
1678 if (context
->flags
.storelogiccomplete
) {
1679 StoreIOBuffer tempBuffer
;
1680 tempBuffer
.offset
= next
->readBuffer
.offset
+ context
->headers_sz
;
1681 tempBuffer
.length
= next
->readBuffer
.length
;
1682 tempBuffer
.data
= next
->readBuffer
.data
;
1684 storeClientCopy(context
->sc
, http
->storeEntry(),
1685 tempBuffer
, clientReplyContext::SendMoreData
, context
);
1689 if (context
->http
->request
->method
== METHOD_PURGE
) {
1690 context
->purgeRequest();
1694 // OPTIONS with Max-Forwards:0 handled in clientProcessRequest()
1696 if (context
->http
->request
->method
== METHOD_TRACE
) {
1697 if (context
->http
->request
->header
.getInt64(HDR_MAX_FORWARDS
) == 0) {
1698 context
->traceReply(aNode
);
1702 /* continue forwarding, not finished yet. */
1703 http
->logType
= LOG_TCP_MISS
;
1705 context
->doGetMoreData();
1707 context
->identifyStoreObject();
1711 clientReplyContext::doGetMoreData()
1713 /* We still have to do store logic processing - vary, cache hit etc */
1714 if (http
->storeEntry() != NULL
) {
1715 /* someone found the object in the cache for us */
1716 StoreIOBuffer localTempBuffer
;
1718 http
->storeEntry()->lock();
1720 if (http
->storeEntry()->mem_obj
== NULL
) {
1722 * This if-block exists because we don't want to clobber
1723 * a preexiting mem_obj->method value if the mem_obj
1724 * already exists. For example, when a HEAD request
1725 * is a cache hit for a GET response, we want to keep
1726 * the method as GET.
1728 http
->storeEntry()->createMemObject(http
->uri
, http
->log_uri
);
1729 http
->storeEntry()->mem_obj
->method
= http
->request
->method
;
1732 sc
= storeClientListAdd(http
->storeEntry(), this);
1734 sc
->setDelayId(DelayId::DelayClient(http
));
1737 assert(http
->logType
== LOG_TCP_HIT
);
1739 /* guarantee nothing has been sent yet! */
1740 assert(http
->out
.size
== 0);
1741 assert(http
->out
.offset
== 0);
1743 if (Ip::Qos::TheConfig
.isHitTosActive()) {
1744 Ip::Qos::doTosLocalHit(http
->getConn()->clientConnection
);
1747 if (Ip::Qos::TheConfig
.isHitNfmarkActive()) {
1748 Ip::Qos::doNfmarkLocalHit(http
->getConn()->clientConnection
);
1751 localTempBuffer
.offset
= reqofs
;
1752 localTempBuffer
.length
= getNextNode()->readBuffer
.length
;
1753 localTempBuffer
.data
= getNextNode()->readBuffer
.data
;
1754 storeClientCopy(sc
, http
->storeEntry(), localTempBuffer
, CacheHit
, this);
1756 /* MISS CASE, http->logType is already set! */
1761 /** The next node has removed itself from the stream. */
1763 clientReplyDetach(clientStreamNode
* node
, ClientHttpRequest
* http
)
1765 /** detach from the stream */
1766 clientStreamDetach(node
, http
);
1770 * Accepts chunk of a http message in buf, parses prefix, filters headers and
1771 * such, writes processed message to the message recipient
1774 clientReplyContext::SendMoreData(void *data
, StoreIOBuffer result
)
1776 clientReplyContext
*context
= static_cast<clientReplyContext
*>(data
);
1777 context
->sendMoreData (result
);
1781 clientReplyContext::makeThisHead()
1783 /* At least, I think thats what this does */
1784 dlinkDelete(&http
->active
, &ClientActiveRequests
);
1785 dlinkAdd(http
, &http
->active
, &ClientActiveRequests
);
1789 clientReplyContext::errorInStream(StoreIOBuffer
const &result
, size_t const &sizeToProcess
)const
1791 return /* aborted request */
1792 (http
->storeEntry() && EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) ||
1793 /* Upstream read error */ (result
.flags
.error
) ||
1794 /* Upstream EOF */ (sizeToProcess
== 0);
1798 clientReplyContext::sendStreamError(StoreIOBuffer
const &result
)
1800 /** call clientWriteComplete so the client socket gets closed
1802 * We call into the stream, because we don't know that there is a
1805 debugs(88, 5, "clientReplyContext::sendStreamError: A stream error has occured, marking as complete and sending no data.");
1806 StoreIOBuffer localTempBuffer
;
1808 http
->request
->flags
.stream_error
= 1;
1809 localTempBuffer
.flags
.error
= result
.flags
.error
;
1810 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
, http
, NULL
,
1815 clientReplyContext::pushStreamData(StoreIOBuffer
const &result
, char *source
)
1817 StoreIOBuffer localTempBuffer
;
1819 if (result
.length
== 0) {
1820 debugs(88, 5, "clientReplyContext::pushStreamData: marking request as complete due to 0 length store result");
1824 assert(result
.offset
- headers_sz
== next()->readBuffer
.offset
);
1825 localTempBuffer
.offset
= result
.offset
- headers_sz
;
1826 localTempBuffer
.length
= result
.length
;
1828 if (localTempBuffer
.length
)
1829 localTempBuffer
.data
= source
;
1831 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
, http
, NULL
,
1836 clientReplyContext::next() const
1838 assert ( (clientStreamNode
*)http
->client_stream
.head
->next
->data
== getNextNode());
1839 return getNextNode();
1843 clientReplyContext::sendBodyTooLargeError()
1845 Ip::Address tmp_noaddr
;
1846 tmp_noaddr
.SetNoAddr(); // TODO: make a global const
1847 http
->logType
= LOG_TCP_DENIED_REPLY
;
1848 ErrorState
*err
= clientBuildError(ERR_TOO_BIG
, HTTP_FORBIDDEN
, NULL
,
1849 http
->getConn() != NULL
? http
->getConn()->clientConnection
->remote
: tmp_noaddr
,
1851 removeClientStoreReference(&(sc
), http
);
1852 HTTPMSGUNLOCK(reply
);
1857 /// send 412 (Precondition Failed) to client
1859 clientReplyContext::sendPreconditionFailedError()
1861 http
->logType
= LOG_TCP_HIT
;
1862 ErrorState
*const err
=
1863 clientBuildError(ERR_PRECONDITION_FAILED
, HTTP_PRECONDITION_FAILED
,
1864 NULL
, http
->getConn()->clientConnection
->remote
, http
->request
);
1865 removeClientStoreReference(&sc
, http
);
1866 HTTPMSGUNLOCK(reply
);
1870 /// send 304 (Not Modified) to client
1872 clientReplyContext::sendNotModified()
1874 StoreEntry
*e
= http
->storeEntry();
1875 const time_t timestamp
= e
->timestamp
;
1876 HttpReply
*const temprep
= e
->getReply()->make304();
1877 http
->logType
= LOG_TCP_IMS_HIT
;
1878 removeClientStoreReference(&sc
, http
);
1879 createStoreEntry(http
->request
->method
, request_flags());
1880 e
= http
->storeEntry();
1881 // Copy timestamp from the original entry so the 304
1882 // reply has a meaningful Age: header.
1884 e
->timestamp
= timestamp
;
1885 e
->replaceHttpReply(temprep
);
1888 * TODO: why put this in the store and then serialise it and
1889 * then parse it again. Simply mark the request complete in
1890 * our context and write the reply struct to the client side.
1892 triggerInitialStoreRead();
1895 /// send 304 (Not Modified) or 412 (Precondition Failed) to client
1896 /// depending on request method
1898 clientReplyContext::sendNotModifiedOrPreconditionFailedError()
1900 if (http
->request
->method
== METHOD_GET
||
1901 http
->request
->method
== METHOD_HEAD
)
1904 sendPreconditionFailedError();
1908 clientReplyContext::processReplyAccess ()
1910 /* NP: this should probably soft-fail to a zero-sized-reply error ?? */
1913 /** Don't block our own responses or HTTP status messages */
1914 if (http
->logType
== LOG_TCP_DENIED
||
1915 http
->logType
== LOG_TCP_DENIED_REPLY
||
1916 alwaysAllowResponse(reply
->sline
.status
)) {
1917 headers_sz
= reply
->hdr_sz
;
1918 processReplyAccessResult(ACCESS_ALLOWED
);
1922 /** Check for reply to big error */
1923 if (reply
->expectedBodyTooLarge(*http
->request
)) {
1924 sendBodyTooLargeError();
1928 headers_sz
= reply
->hdr_sz
;
1930 /** check for absent access controls (permit by default) */
1931 if (!Config
.accessList
.reply
) {
1932 processReplyAccessResult(ACCESS_ALLOWED
);
1936 /** Process http_reply_access lists */
1937 ACLFilledChecklist
*replyChecklist
=
1938 clientAclChecklistCreate(Config
.accessList
.reply
, http
);
1939 replyChecklist
->reply
= HTTPMSGLOCK(reply
);
1940 replyChecklist
->nonBlockingCheck(ProcessReplyAccessResult
, this);
1944 clientReplyContext::ProcessReplyAccessResult(allow_t rv
, void *voidMe
)
1946 clientReplyContext
*me
= static_cast<clientReplyContext
*>(voidMe
);
1947 me
->processReplyAccessResult(rv
);
1951 clientReplyContext::processReplyAccessResult(const allow_t
&accessAllowed
)
1953 debugs(88, 2, "The reply for " << RequestMethodStr(http
->request
->method
)
1954 << " " << http
->uri
<< " is " << accessAllowed
<< ", because it matched '"
1955 << (AclMatchedName
? AclMatchedName
: "NO ACL's") << "'" );
1957 if (accessAllowed
!= ACCESS_ALLOWED
) {
1960 page_id
= aclGetDenyInfoPage(&Config
.denyInfoList
, AclMatchedName
, 1);
1962 http
->logType
= LOG_TCP_DENIED_REPLY
;
1964 if (page_id
== ERR_NONE
)
1965 page_id
= ERR_ACCESS_DENIED
;
1967 Ip::Address tmp_noaddr
;
1968 tmp_noaddr
.SetNoAddr();
1969 err
= clientBuildError(page_id
, HTTP_FORBIDDEN
, NULL
,
1970 http
->getConn() != NULL
? http
->getConn()->clientConnection
->remote
: tmp_noaddr
,
1973 removeClientStoreReference(&sc
, http
);
1975 HTTPMSGUNLOCK(reply
);
1983 /* Ok, the reply is allowed, */
1984 http
->loggingEntry(http
->storeEntry());
1986 ssize_t body_size
= reqofs
- reply
->hdr_sz
;
1987 if (body_size
< 0) {
1988 reqofs
= reply
->hdr_sz
;
1992 debugs(88, 3, "clientReplyContext::sendMoreData: Appending " <<
1993 (int) body_size
<< " bytes after " << reply
->hdr_sz
<<
1994 " bytes of headers");
1998 if (http
->flags
.accel
&& reply
->sline
.status
!= HTTP_FORBIDDEN
&&
1999 !alwaysAllowResponse(reply
->sline
.status
) &&
2000 esiEnableProcessing(reply
)) {
2001 debugs(88, 2, "Enabling ESI processing for " << http
->uri
);
2002 clientStreamInsertHead(&http
->client_stream
, esiStreamRead
,
2003 esiProcessStream
, esiStreamDetach
, esiStreamStatus
, NULL
);
2008 if (http
->request
->method
== METHOD_HEAD
) {
2009 /* do not forward body for HEAD replies */
2011 http
->flags
.done_copying
= 1;
2015 assert (!flags
.headersSent
);
2016 flags
.headersSent
= true;
2018 StoreIOBuffer localTempBuffer
;
2019 char *buf
= next()->readBuffer
.data
;
2020 char *body_buf
= buf
+ reply
->hdr_sz
;
2022 //Server side may disable ranges under some circumstances.
2024 if ((!http
->request
->range
))
2025 next()->readBuffer
.offset
= 0;
2027 body_buf
-= next()->readBuffer
.offset
;
2029 if (next()->readBuffer
.offset
!= 0) {
2030 if (next()->readBuffer
.offset
> body_size
) {
2031 /* Can't use any of the body we received. send nothing */
2032 localTempBuffer
.length
= 0;
2033 localTempBuffer
.data
= NULL
;
2035 localTempBuffer
.length
= body_size
- next()->readBuffer
.offset
;
2036 localTempBuffer
.data
= body_buf
+ next()->readBuffer
.offset
;
2039 localTempBuffer
.length
= body_size
;
2040 localTempBuffer
.data
= body_buf
;
2043 /* TODO??: move the data in the buffer back by the request header size */
2044 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
,
2045 http
, reply
, localTempBuffer
);
2051 clientReplyContext::sendMoreData (StoreIOBuffer result
)
2056 StoreEntry
*entry
= http
->storeEntry();
2058 ConnStateData
* conn
= http
->getConn();
2060 if (conn
== NULL
|| !conn
->isOpen()) {
2061 // too late, our conn is closing
2062 // TODO: should we also quit?
2063 debugs(33,3, HERE
<< "not sending more data to a closing " << conn
->clientConnection
);
2067 char *buf
= next()->readBuffer
.data
;
2069 if (buf
!= result
.data
) {
2070 /* we've got to copy some data */
2071 assert(result
.length
<= next()->readBuffer
.length
);
2072 memcpy(buf
, result
.data
, result
.length
);
2075 if (reqofs
==0 && !logTypeIsATcpHit(http
->logType
) && Comm::IsConnOpen(conn
->clientConnection
)) {
2076 if (Ip::Qos::TheConfig
.isHitTosActive()) {
2077 Ip::Qos::doTosLocalMiss(conn
->clientConnection
, http
->request
->hier
.code
);
2079 if (Ip::Qos::TheConfig
.isHitNfmarkActive()) {
2080 Ip::Qos::doNfmarkLocalMiss(conn
->clientConnection
, http
->request
->hier
.code
);
2084 /* We've got the final data to start pushing... */
2085 flags
.storelogiccomplete
= 1;
2087 reqofs
+= result
.length
;
2089 assert(reqofs
<= HTTP_REQBUF_SZ
|| flags
.headersSent
);
2091 assert(http
->request
!= NULL
);
2093 /* ESI TODO: remove this assert once everything is stable */
2094 assert(http
->client_stream
.head
->data
2095 && cbdataReferenceValid(http
->client_stream
.head
->data
));
2099 debugs(88, 5, "clientReplyContext::sendMoreData: " << http
->uri
<< ", " <<
2100 reqofs
<< " bytes (" << result
.length
<<
2102 debugs(88, 5, "clientReplyContext::sendMoreData:"
2103 << conn
->clientConnection
<<
2104 " '" << entry
->url() << "'" <<
2105 " out.offset=" << http
->out
.offset
);
2107 /* update size of the request */
2110 if (errorInStream(result
, reqofs
)) {
2111 sendStreamError(result
);
2115 if (flags
.headersSent
) {
2116 pushStreamData (result
, buf
);
2122 /* handle headers */
2124 if (Config
.onoff
.log_mime_hdrs
) {
2127 if ((k
= headersEnd(buf
, reqofs
))) {
2128 safe_free(http
->al
.headers
.reply
);
2129 http
->al
.headers
.reply
= (char *)xcalloc(k
+ 1, 1);
2130 xstrncpy(http
->al
.headers
.reply
, buf
, k
);
2134 holdingBuffer
= result
;
2135 processReplyAccess();
2141 /* Using this breaks the client layering just a little!
2144 clientReplyContext::createStoreEntry(const HttpRequestMethod
& m
, request_flags reqFlags
)
2146 assert(http
!= NULL
);
2148 * For erroneous requests, we might not have a h->request,
2149 * so make a fake one.
2152 if (http
->request
== NULL
)
2153 http
->request
= HTTPMSGLOCK(new HttpRequest(m
, AnyP::PROTO_NONE
, null_string
));
2155 StoreEntry
*e
= storeCreateEntry(http
->uri
, http
->log_uri
, reqFlags
, m
);
2157 sc
= storeClientListAdd(e
, this);
2160 sc
->setDelayId(DelayId::DelayClient(http
));
2167 /* I don't think this is actually needed! -- adrian */
2168 /* http->reqbuf = http->norm_reqbuf; */
2169 // assert(http->reqbuf == http->norm_reqbuf);
2170 /* The next line is illegal because we don't know if the client stream
2171 * buffers have been set up
2173 // storeClientCopy(http->sc, e, 0, HTTP_REQBUF_SZ, http->reqbuf,
2174 // SendMoreData, this);
2175 /* So, we mark the store logic as complete */
2176 flags
.storelogiccomplete
= 1;
2178 /* and get the caller to request a read, from whereever they are */
2179 /* NOTE: after ANY data flows down the pipe, even one step,
2180 * this function CAN NOT be used to manage errors
2182 http
->storeEntry(e
);
2186 clientBuildError(err_type page_id
, http_status status
, char const *url
,
2187 Ip::Address
&src_addr
, HttpRequest
* request
)
2189 ErrorState
*err
= new ErrorState(page_id
, status
, request
);
2190 err
->src_addr
= src_addr
;
2193 err
->url
= xstrdup(url
);