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"
43 #include "auth/UserRequest.h"
44 #include "client_side.h"
45 #include "client_side_reply.h"
46 #include "clientStream.h"
48 #include "DelayPools.h"
50 #include "errorpage.h"
56 #include "HttpReply.h"
57 #include "HttpRequest.h"
58 #include "ip/QosConfig.h"
59 #include "MemObject.h"
60 #include "SquidTime.h"
61 #include "StoreClient.h"
64 CBDATA_CLASS_INIT(clientReplyContext
);
67 extern "C" CSS clientReplyStatus
;
68 extern ErrorState
*clientBuildError(err_type
, http_status
, char const *, Ip::Address
&, HttpRequest
*);
72 clientReplyContext::~clientReplyContext()
75 /* This may trigger a callback back into SendMoreData as the cbdata
78 removeClientStoreReference(&sc
, http
);
79 /* old_entry might still be set if we didn't yet get the reply
80 * code in HandleIMSReply() */
81 removeStoreReference(&old_sc
, &old_entry
);
82 safe_free(tempBuffer
.data
);
83 cbdataReferenceDone(http
);
87 clientReplyContext::clientReplyContext(ClientHttpRequest
*clientContext
) : http (cbdataReference(clientContext
)), old_entry (NULL
), old_sc(NULL
), deleting(false)
90 /** Create an error in the store awaiting the client side to read it.
92 * This may be better placed in the clientStream logic, but it has not been
96 clientReplyContext::setReplyToError(
97 err_type err
, http_status status
, const HttpRequestMethod
& method
, char const *uri
,
98 Ip::Address
&addr
, HttpRequest
* failedrequest
, const char *unparsedrequest
,
99 AuthUserRequest::Pointer auth_user_request
)
101 ErrorState
*errstate
= clientBuildError(err
, status
, uri
, addr
, failedrequest
);
104 errstate
->request_hdrs
= xstrdup(unparsedrequest
);
106 if (status
== HTTP_NOT_IMPLEMENTED
&& http
->request
)
107 /* prevent confusion over whether we default to persistent or not */
108 http
->request
->flags
.proxy_keepalive
= 0;
110 http
->al
.http
.code
= errstate
->httpStatus
;
112 createStoreEntry(method
, request_flags());
114 errstate
->auth_user_request
= auth_user_request
;
116 assert(errstate
->callback_data
== NULL
);
117 errorAppendEntry(http
->storeEntry(), errstate
);
118 /* Now the caller reads to get this */
122 clientReplyContext::removeStoreReference(store_client
** scp
,
126 store_client
*sc_tmp
= *scp
;
128 if ((e
= *ep
) != NULL
) {
130 storeUnregister(sc_tmp
, e
, this);
137 clientReplyContext::removeClientStoreReference(store_client
**scp
, ClientHttpRequest
*aHttpRequest
)
139 StoreEntry
*reference
= aHttpRequest
->storeEntry();
140 removeStoreReference(scp
, &reference
);
141 aHttpRequest
->storeEntry(reference
);
145 clientReplyContext::operator new (size_t byteCount
)
147 /* derived classes with different sizes must implement their own new */
148 assert (byteCount
== sizeof (clientReplyContext
));
149 CBDATA_INIT_TYPE(clientReplyContext
);
150 return cbdataAlloc(clientReplyContext
);
154 clientReplyContext::operator delete (void *address
)
156 clientReplyContext
* tmp
= (clientReplyContext
*)address
;
161 clientReplyContext::saveState()
163 assert(old_sc
== NULL
);
164 debugs(88, 3, "clientReplyContext::saveState: saving store context");
165 old_entry
= http
->storeEntry();
167 old_reqsize
= reqsize
;
168 tempBuffer
.offset
= reqofs
;
169 /* Prevent accessing the now saved entries */
170 http
->storeEntry(NULL
);
177 clientReplyContext::restoreState()
179 assert(old_sc
!= NULL
);
180 debugs(88, 3, "clientReplyContext::restoreState: Restoring store context");
181 removeClientStoreReference(&sc
, http
);
182 http
->storeEntry(old_entry
);
184 reqsize
= old_reqsize
;
185 reqofs
= tempBuffer
.offset
;
186 /* Prevent accessed the old saved entries */
190 tempBuffer
.offset
= 0;
194 clientReplyContext::startError(ErrorState
* err
)
196 createStoreEntry(http
->request
->method
, request_flags());
197 triggerInitialStoreRead();
198 errorAppendEntry(http
->storeEntry(), err
);
202 clientReplyContext::getNextNode() const
204 return (clientStreamNode
*)ourNode
->node
.next
->data
;
207 /* This function is wrong - the client parameters don't include the
211 clientReplyContext::triggerInitialStoreRead()
213 /* when confident, 0 becomes reqofs, and then this factors into
217 StoreIOBuffer
localTempBuffer (next()->readBuffer
.length
, 0, next()->readBuffer
.data
);
218 storeClientCopy(sc
, http
->storeEntry(), localTempBuffer
, SendMoreData
, this);
221 /* there is an expired entry in the store.
222 * setup a temporary buffer area and perform an IMS to the origin
225 clientReplyContext::processExpired()
227 char *url
= http
->uri
;
228 StoreEntry
*entry
= NULL
;
229 debugs(88, 3, "clientReplyContext::processExpired: '" << http
->uri
<< "'");
230 assert(http
->storeEntry()->lastmod
>= 0);
232 * check if we are allowed to contact other servers
233 * @?@: Instead of a 504 (Gateway Timeout) reply, we may want to return
234 * a stale entry *if* it matches client requirements
237 if (http
->onlyIfCached()) {
238 processOnlyIfCachedMiss();
242 http
->request
->flags
.refresh
= 1;
243 #if STORE_CLIENT_LIST_DEBUG
244 /* Prevent a race with the store client memory free routines
246 assert(storeClientIsThisAClient(sc
, this));
248 /* Prepare to make a new temporary request */
250 entry
= storeCreateEntry(url
,
251 http
->log_uri
, http
->request
->flags
, http
->request
->method
);
252 /* NOTE, don't call StoreEntry->lock(), storeCreateEntry() does it */
253 sc
= storeClientListAdd(entry
, this);
255 /* delay_id is already set on original store client */
256 sc
->setDelayId(DelayId::DelayClient(http
));
259 http
->request
->lastmod
= old_entry
->lastmod
;
260 debugs(88, 5, "clientReplyContext::processExpired : lastmod " << entry
->lastmod
);
261 http
->storeEntry(entry
);
262 assert(http
->out
.offset
== 0);
264 http
->request
->clientConnection
= http
->getConn();
267 * A refcounted pointer so that FwdState stays around as long as
268 * this clientReplyContext does
270 Comm::ConnectionPointer conn
= http
->getConn() != NULL
? http
->getConn()->clientConn
: NULL
;
271 FwdState::fwdStart(conn
, http
->storeEntry(), http
->request
);
273 /* Register with storage manager to receive updates when data comes in. */
274 if (EBIT_TEST(entry
->flags
, ENTRY_ABORTED
))
275 debugs(88, 0, "clientReplyContext::processExpired: Found ENTRY_ABORTED object");
278 /* start counting the length from 0 */
279 StoreIOBuffer
localTempBuffer(HTTP_REQBUF_SZ
, 0, tempbuf
);
280 storeClientCopy(sc
, entry
, localTempBuffer
, HandleIMSReply
, this);
286 clientReplyContext::sendClientUpstreamResponse()
288 StoreIOBuffer tempresult
;
289 removeStoreReference(&old_sc
, &old_entry
);
290 /* here the data to send is the data we just received */
291 tempBuffer
.offset
= 0;
293 /* sendMoreData tracks the offset as well.
294 * Force it back to zero */
296 assert(!EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
));
297 /* TODO: provide sendMoreData with the ready parsed reply */
298 tempresult
.length
= reqsize
;
299 tempresult
.data
= tempbuf
;
300 sendMoreData(tempresult
);
304 clientReplyContext::HandleIMSReply(void *data
, StoreIOBuffer result
)
306 clientReplyContext
*context
= (clientReplyContext
*)data
;
307 context
->handleIMSReply(result
);
311 clientReplyContext::sendClientOldEntry()
313 /* Get the old request back */
315 /* here the data to send is in the next nodes buffers already */
316 assert(!EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
));
317 /* sendMoreData tracks the offset as well.
318 * Force it back to zero */
320 StoreIOBuffer
tempresult (reqsize
, reqofs
, next()->readBuffer
.data
);
321 sendMoreData(tempresult
);
324 /* This is the workhorse of the HandleIMSReply callback.
326 * It is called when we've got data back from the origin following our
327 * IMS request to revalidate a stale entry.
330 clientReplyContext::handleIMSReply(StoreIOBuffer result
)
335 debugs(88, 3, "handleIMSReply: " << http
->storeEntry()->url() << ", " << (long unsigned) result
.length
<< " bytes" );
337 if (http
->storeEntry() == NULL
)
340 if (result
.flags
.error
&& !EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
))
343 /* update size of the request */
344 reqsize
= result
.length
+ reqofs
;
346 const http_status status
= http
->storeEntry()->getReply()->sline
.status
;
348 // request to origin was aborted
349 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) {
350 debugs(88, 3, "handleIMSReply: request to origin aborted '" << http
->storeEntry()->url() << "', sending old entry to client" );
351 http
->logType
= LOG_TCP_REFRESH_FAIL_OLD
;
352 sendClientOldEntry();
355 HttpReply
*old_rep
= (HttpReply
*) old_entry
->getReply();
357 // origin replied 304
358 if (status
== HTTP_NOT_MODIFIED
) {
359 http
->logType
= LOG_TCP_REFRESH_UNMODIFIED
;
361 // update headers on existing entry
362 old_rep
->updateOnNotModified(http
->storeEntry()->getReply());
363 old_entry
->timestampsSet();
365 // if client sent IMS
367 if (http
->request
->flags
.ims
&& !old_entry
->modifiedSince(http
->request
)) {
368 // forward the 304 from origin
369 debugs(88, 3, "handleIMSReply: origin replied 304, revalidating existing entry and forwarding 304 to client");
370 sendClientUpstreamResponse();
372 // send existing entry, it's still valid
373 debugs(88, 3, "handleIMSReply: origin replied 304, revalidating existing entry and sending " <<
374 old_rep
->sline
.status
<< " to client");
375 sendClientOldEntry();
379 // origin replied with a non-error code
380 else if (status
> HTTP_STATUS_NONE
&& status
< HTTP_INTERNAL_SERVER_ERROR
) {
381 // forward response from origin
382 http
->logType
= LOG_TCP_REFRESH_MODIFIED
;
383 debugs(88, 3, "handleIMSReply: origin replied " << status
<< ", replacing existing entry and forwarding to client");
384 sendClientUpstreamResponse();
387 // origin replied with an error
388 else if (http
->request
->flags
.fail_on_validation_err
) {
389 http
->logType
= LOG_TCP_REFRESH_FAIL_ERR
;
390 debugs(88, 3, "handleIMSReply: origin replied with error " << status
<<
391 ", forwarding to client due to fail_on_validation_err");
392 sendClientUpstreamResponse();
394 // ignore and let client have old entry
395 http
->logType
= LOG_TCP_REFRESH_FAIL_OLD
;
396 debugs(88, 3, "handleIMSReply: origin replied with error " <<
397 status
<< ", sending old entry (" << old_rep
->sline
.status
<< ") to client");
398 sendClientOldEntry();
402 extern "C" CSR clientGetMoreData
;
403 extern "C" CSD clientReplyDetach
;
406 * clientReplyContext::cacheHit Should only be called until the HTTP reply headers
407 * have been parsed. Normally this should be a single call, but
408 * it might take more than one. As soon as we have the headers,
409 * we hand off to clientSendMoreData, processExpired, or
413 clientReplyContext::CacheHit(void *data
, StoreIOBuffer result
)
415 clientReplyContext
*context
= (clientReplyContext
*)data
;
416 context
->cacheHit(result
);
420 * Process a possible cache HIT.
423 clientReplyContext::cacheHit(StoreIOBuffer result
)
425 /** Ignore if the HIT object is being deleted. */
429 StoreEntry
*e
= http
->storeEntry();
431 HttpRequest
*r
= http
->request
;
433 debugs(88, 3, "clientCacheHit: " << http
->uri
<< ", " << result
.length
<< " bytes");
435 if (http
->storeEntry() == NULL
) {
436 debugs(88, 3, "clientCacheHit: request aborted");
438 } else if (result
.flags
.error
) {
439 /* swap in failure */
440 debugs(88, 3, "clientCacheHit: swapin failure for " << http
->uri
);
441 http
->logType
= LOG_TCP_SWAPFAIL_MISS
;
442 removeClientStoreReference(&sc
, http
);
447 if (result
.length
== 0) {
448 /* the store couldn't get enough data from the file for us to id the
451 /* treat as a miss */
452 http
->logType
= LOG_TCP_MISS
;
457 assert(!EBIT_TEST(e
->flags
, ENTRY_ABORTED
));
458 /* update size of the request */
459 reqsize
= result
.length
+ reqofs
;
462 * Got the headers, now grok them
464 assert(http
->logType
== LOG_TCP_HIT
);
466 if (strcmp(e
->mem_obj
->url
, urlCanonical(r
)) != 0) {
467 debugs(33, 1, "clientProcessHit: URL mismatch, '" << e
->mem_obj
->url
<< "' != '" << urlCanonical(r
) << "'");
472 switch (varyEvaluateMatch(e
, r
)) {
475 /* No variance detected. Continue as normal */
479 /* This is the correct entity for this request. Continue */
480 debugs(88, 2, "clientProcessHit: Vary MATCH!");
484 /* This is not the correct entity for this request. We need
485 * to requery the cache.
487 removeClientStoreReference(&sc
, http
);
489 /* Note: varyEvalyateMatch updates the request with vary information
490 * so we only get here once. (it also takes care of cancelling loops)
492 debugs(88, 2, "clientProcessHit: Vary detected!");
493 clientGetMoreData(ourNode
, http
);
497 /* varyEvaluateMatch found a object loop. Process as miss */
498 debugs(88, 1, "clientProcessHit: Vary object loop!");
503 if (r
->method
== METHOD_PURGE
) {
504 removeClientStoreReference(&sc
, http
);
510 if (e
->checkNegativeHit()
511 #if USE_HTTP_VIOLATIONS
512 && !r
->flags
.nocache_hack
515 http
->logType
= LOG_TCP_NEGATIVE_HIT
;
516 sendMoreData(result
);
517 } else if (!http
->flags
.internal
&& refreshCheckHTTP(e
, r
)) {
518 debugs(88, 5, "clientCacheHit: in refreshCheck() block");
520 * We hold a stale copy; it needs to be validated
523 * The 'need_validation' flag is used to prevent forwarding
524 * loops between siblings. If our copy of the object is stale,
525 * then we should probably only use parents for the validation
526 * request. Otherwise two siblings could generate a loop if
527 * both have a stale version of the object.
529 r
->flags
.need_validation
= 1;
531 if (e
->lastmod
< 0) {
533 * Previous reply didn't have a Last-Modified header,
534 * we cannot revalidate it.
536 http
->logType
= LOG_TCP_MISS
;
538 } else if (r
->flags
.nocache
) {
540 * This did not match a refresh pattern that overrides no-cache
541 * we should honour the client no-cache header.
543 http
->logType
= LOG_TCP_CLIENT_REFRESH_MISS
;
545 } else if (r
->protocol
== PROTO_HTTP
) {
547 * Object needs to be revalidated
548 * XXX This could apply to FTP as well, if Last-Modified is known.
553 * We don't know how to re-validate other protocols. Handle
554 * them as if the object has expired.
556 http
->logType
= LOG_TCP_MISS
;
559 } else if (r
->flags
.ims
) {
561 * Handle If-Modified-Since requests from the client
564 if (e
->getReply()->sline
.status
!= HTTP_OK
) {
565 debugs(88, 4, "clientCacheHit: Reply code " <<
566 e
->getReply()->sline
.status
<< " != 200");
567 http
->logType
= LOG_TCP_MISS
;
569 } else if (e
->modifiedSince(http
->request
)) {
570 http
->logType
= LOG_TCP_IMS_HIT
;
571 sendMoreData(result
);
573 time_t const timestamp
= e
->timestamp
;
574 HttpReply
*temprep
= e
->getReply()->make304();
575 http
->logType
= LOG_TCP_IMS_HIT
;
576 removeClientStoreReference(&sc
, http
);
577 createStoreEntry(http
->request
->method
,
579 e
= http
->storeEntry();
581 * Copy timestamp from the original entry so the 304
582 * reply has a meaningful Age: header.
584 e
->timestamp
= timestamp
;
585 e
->replaceHttpReply(temprep
);
587 /* TODO: why put this in the store and then serialise it and then parse it again.
588 * Simply mark the request complete in our context and
589 * write the reply struct to the client side
591 triggerInitialStoreRead();
595 * plain ol' cache hit
599 if (e
->store_status
!= STORE_OK
)
600 http
->logType
= LOG_TCP_MISS
;
603 if (e
->mem_status
== IN_MEMORY
)
604 http
->logType
= LOG_TCP_MEM_HIT
;
605 else if (Config
.onoff
.offline
)
606 http
->logType
= LOG_TCP_OFFLINE_HIT
;
608 sendMoreData(result
);
613 * Prepare to fetch the object as it's a cache miss of some kind.
616 clientReplyContext::processMiss()
618 char *url
= http
->uri
;
619 HttpRequest
*r
= http
->request
;
620 ErrorState
*err
= NULL
;
621 debugs(88, 4, "clientProcessMiss: '" << RequestMethodStr(r
->method
) << " " << url
<< "'");
624 * We might have a left-over StoreEntry from a failed cache hit
627 if (http
->storeEntry()) {
628 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_SPECIAL
)) {
629 debugs(88, 0, "clientProcessMiss: miss on a special object (" << url
<< ").");
630 debugs(88, 0, "\tlog_type = " << log_tags
[http
->logType
]);
631 http
->storeEntry()->dump(1);
634 removeClientStoreReference(&sc
, http
);
637 /** Check if its a PURGE request to be actioned. */
638 if (r
->method
== METHOD_PURGE
) {
643 /** Check if its an 'OTHER' request. Purge all cached entries if so and continue. */
644 if (r
->method
== METHOD_OTHER
) {
648 /** Check if 'only-if-cached' flag is set. Action if so. */
649 if (http
->onlyIfCached()) {
650 processOnlyIfCachedMiss();
654 /// Deny loops for accelerator and interceptor. TODO: deny in all modes?
655 if (r
->flags
.loopdetect
&&
656 (http
->flags
.accel
|| http
->flags
.intercepted
)) {
657 http
->al
.http
.code
= HTTP_FORBIDDEN
;
658 err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
, http
->getConn()->peer
, http
->request
);
659 createStoreEntry(r
->method
, request_flags());
660 errorAppendEntry(http
->storeEntry(), err
);
661 triggerInitialStoreRead();
664 assert(http
->out
.offset
== 0);
665 createStoreEntry(r
->method
, r
->flags
);
666 triggerInitialStoreRead();
668 if (http
->redirect
.status
) {
669 HttpReply
*rep
= new HttpReply
;
670 #if LOG_TCP_REDIRECTS
672 http
->logType
= LOG_TCP_REDIRECT
;
675 http
->storeEntry()->releaseRequest();
676 rep
->redirect(http
->redirect
.status
, http
->redirect
.location
);
677 http
->storeEntry()->replaceHttpReply(rep
);
678 http
->storeEntry()->complete();
682 /** Check for internal requests. Update Protocol info if so. */
683 if (http
->flags
.internal
)
684 r
->protocol
= PROTO_INTERNAL
;
686 r
->clientConnection
= http
->getConn();
688 /** Start forwarding to get the new object from network */
689 Comm::ConnectionPointer conn
= http
->getConn() != NULL
? http
->getConn()->clientConn
: NULL
;
690 FwdState::fwdStart(conn
, http
->storeEntry(), r
);
695 * client issued a request with an only-if-cached cache-control directive;
696 * we did not find a cached object that can be returned without
697 * contacting other servers;
698 * respond with a 504 (Gateway Timeout) as suggested in [RFC 2068]
701 clientReplyContext::processOnlyIfCachedMiss()
703 ErrorState
*err
= NULL
;
704 debugs(88, 4, "clientProcessOnlyIfCachedMiss: '" <<
705 RequestMethodStr(http
->request
->method
) << " " << http
->uri
<< "'");
706 http
->al
.http
.code
= HTTP_GATEWAY_TIMEOUT
;
707 err
= clientBuildError(ERR_ONLY_IF_CACHED_MISS
, HTTP_GATEWAY_TIMEOUT
, NULL
, http
->getConn()->peer
, http
->request
);
708 removeClientStoreReference(&sc
, http
);
713 clientReplyContext::purgeRequestFindObjectToPurge()
715 /* Try to find a base entry */
716 http
->flags
.purging
= 1;
719 // TODO: can we use purgeAllCached() here instead of doing the
720 // getPublicByRequestMethod() dance?
721 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_GET
);
724 // Purges all entries with a given url
725 // TODO: move to SideAgent parent, when we have one
727 * We probably cannot purge Vary-affected responses because their MD5
728 * keys depend on vary headers.
731 purgeEntriesByUrl(HttpRequest
* req
, const char *url
)
734 bool get_or_head_sent
= false;
737 for (HttpRequestMethod
m(METHOD_NONE
); m
!= METHOD_ENUM_END
; ++m
) {
738 if (m
.isCacheble()) {
739 if (StoreEntry
*entry
= storeGetPublic(url
, m
)) {
740 debugs(88, 5, "purging " << RequestMethodStr(m
) << ' ' << url
);
742 neighborsHtcpClear(entry
, url
, req
, m
, HTCP_CLR_INVALIDATION
);
743 if (m
== METHOD_GET
|| m
== METHOD_HEAD
) {
744 get_or_head_sent
= true;
753 if (!get_or_head_sent
) {
754 neighborsHtcpClear(NULL
, url
, req
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_INVALIDATION
);
760 clientReplyContext::purgeAllCached()
762 const char *url
= urlCanonical(http
->request
);
763 purgeEntriesByUrl(http
->request
, url
);
767 clientReplyContext::created(StoreEntry
*newEntry
)
769 if (lookingforstore
== 1)
770 purgeFoundGet(newEntry
);
771 else if (lookingforstore
== 2)
772 purgeFoundHead(newEntry
);
773 else if (lookingforstore
== 3)
774 purgeDoPurgeGet(newEntry
);
775 else if (lookingforstore
== 4)
776 purgeDoPurgeHead(newEntry
);
777 else if (lookingforstore
== 5)
778 identifyFoundObject(newEntry
);
782 clientReplyContext::purgeFoundGet(StoreEntry
*newEntry
)
784 if (newEntry
->isNull()) {
786 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_HEAD
);
788 purgeFoundObject (newEntry
);
792 clientReplyContext::purgeFoundHead(StoreEntry
*newEntry
)
794 if (newEntry
->isNull())
797 purgeFoundObject (newEntry
);
801 clientReplyContext::purgeFoundObject(StoreEntry
*entry
)
803 assert (entry
&& !entry
->isNull());
805 if (EBIT_TEST(entry
->flags
, ENTRY_SPECIAL
)) {
806 http
->logType
= LOG_TCP_DENIED
;
807 ErrorState
*err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
, http
->getConn()->peer
, http
->request
);
812 StoreIOBuffer localTempBuffer
;
813 /* Swap in the metadata */
814 http
->storeEntry(entry
);
816 http
->storeEntry()->lock();
817 http
->storeEntry()->createMemObject(http
->uri
, http
->log_uri
);
819 http
->storeEntry()->mem_obj
->method
= http
->request
->method
;
821 sc
= storeClientListAdd(http
->storeEntry(), this);
823 http
->logType
= LOG_TCP_HIT
;
827 localTempBuffer
.offset
= http
->out
.offset
;
829 localTempBuffer
.length
= next()->readBuffer
.length
;
831 localTempBuffer
.data
= next()->readBuffer
.data
;
833 storeClientCopy(sc
, http
->storeEntry(),
834 localTempBuffer
, CacheHit
, this);
838 clientReplyContext::purgeRequest()
840 debugs(88, 3, "Config2.onoff.enable_purge = " <<
841 Config2
.onoff
.enable_purge
);
843 if (!Config2
.onoff
.enable_purge
) {
844 http
->logType
= LOG_TCP_DENIED
;
845 ErrorState
*err
= clientBuildError(ERR_ACCESS_DENIED
, HTTP_FORBIDDEN
, NULL
, http
->getConn()->peer
, http
->request
);
850 /* Release both IP cache */
851 ipcacheInvalidate(http
->request
->GetHost());
853 if (!http
->flags
.purging
)
854 purgeRequestFindObjectToPurge();
860 clientReplyContext::purgeDoMissPurge()
862 http
->logType
= LOG_TCP_MISS
;
864 StoreEntry::getPublicByRequestMethod(this,http
->request
, METHOD_GET
);
868 clientReplyContext::purgeDoPurgeGet(StoreEntry
*newEntry
)
871 /* Move to new() when that is created */
872 purgeStatus
= HTTP_NOT_FOUND
;
874 if (!newEntry
->isNull()) {
875 /* Release the cached URI */
876 debugs(88, 4, "clientPurgeRequest: GET '" << newEntry
->url() << "'" );
878 neighborsHtcpClear(newEntry
, NULL
, http
->request
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_PURGE
);
881 purgeStatus
= HTTP_OK
;
885 StoreEntry::getPublicByRequestMethod(this, http
->request
, METHOD_HEAD
);
889 clientReplyContext::purgeDoPurgeHead(StoreEntry
*newEntry
)
891 if (newEntry
&& !newEntry
->isNull()) {
892 debugs(88, 4, "clientPurgeRequest: HEAD '" << newEntry
->url() << "'" );
894 neighborsHtcpClear(newEntry
, NULL
, http
->request
, HttpRequestMethod(METHOD_HEAD
), HTCP_CLR_PURGE
);
897 purgeStatus
= HTTP_OK
;
900 /* And for Vary, release the base URI if none of the headers was included in the request */
902 if (http
->request
->vary_headers
903 && !strstr(http
->request
->vary_headers
, "=")) {
904 StoreEntry
*entry
= storeGetPublic(urlCanonical(http
->request
), METHOD_GET
);
907 debugs(88, 4, "clientPurgeRequest: Vary GET '" << entry
->url() << "'" );
909 neighborsHtcpClear(entry
, NULL
, http
->request
, HttpRequestMethod(METHOD_GET
), HTCP_CLR_PURGE
);
912 purgeStatus
= HTTP_OK
;
915 entry
= storeGetPublic(urlCanonical(http
->request
), METHOD_HEAD
);
918 debugs(88, 4, "clientPurgeRequest: Vary HEAD '" << entry
->url() << "'" );
920 neighborsHtcpClear(entry
, NULL
, http
->request
, HttpRequestMethod(METHOD_HEAD
), HTCP_CLR_PURGE
);
923 purgeStatus
= HTTP_OK
;
928 * Make a new entry to hold the reply to be written
931 /* FIXME: This doesn't need to go through the store. Simply
932 * push down the client chain
934 createStoreEntry(http
->request
->method
, request_flags());
936 triggerInitialStoreRead();
938 HttpReply
*rep
= new HttpReply
;
939 rep
->setHeaders(purgeStatus
, NULL
, NULL
, 0, 0, -1);
940 http
->storeEntry()->replaceHttpReply(rep
);
941 http
->storeEntry()->complete();
945 clientReplyContext::traceReply(clientStreamNode
* node
)
947 clientStreamNode
*nextNode
= (clientStreamNode
*)node
->node
.next
->data
;
948 StoreIOBuffer localTempBuffer
;
949 assert(http
->request
->max_forwards
== 0);
950 createStoreEntry(http
->request
->method
, request_flags());
951 localTempBuffer
.offset
= nextNode
->readBuffer
.offset
+ headers_sz
;
952 localTempBuffer
.length
= nextNode
->readBuffer
.length
;
953 localTempBuffer
.data
= nextNode
->readBuffer
.data
;
954 storeClientCopy(sc
, http
->storeEntry(),
955 localTempBuffer
, SendMoreData
, this);
956 http
->storeEntry()->releaseRequest();
957 http
->storeEntry()->buffer();
958 HttpReply
*rep
= new HttpReply
;
959 rep
->setHeaders(HTTP_OK
, NULL
, "text/plain", http
->request
->prefixLen(), 0, squid_curtime
);
960 http
->storeEntry()->replaceHttpReply(rep
);
961 http
->request
->swapOut(http
->storeEntry());
962 http
->storeEntry()->complete();
965 #define SENDING_BODY 0
966 #define SENDING_HDRSONLY 1
968 clientReplyContext::checkTransferDone()
970 StoreEntry
*entry
= http
->storeEntry();
976 * For now, 'done_copying' is used for special cases like
977 * Range and HEAD requests.
979 if (http
->flags
.done_copying
)
982 if (http
->request
->flags
.chunked_reply
&& !flags
.complete
) {
983 // last-chunk was not sent
988 * Handle STORE_OK objects.
989 * objectLen(entry) will be set proprely.
990 * RC: Does objectLen(entry) include the Headers?
993 if (entry
->store_status
== STORE_OK
) {
994 return storeOKTransferDone();
996 return storeNotOKTransferDone();
1001 clientReplyContext::storeOKTransferDone() const
1003 if (http
->out
.offset
>= http
->storeEntry()->objectLen() - headers_sz
) {
1004 debugs(88,3,HERE
<< "storeOKTransferDone " <<
1005 " out.offset=" << http
->out
.offset
<<
1006 " objectLen()=" << http
->storeEntry()->objectLen() <<
1007 " headers_sz=" << headers_sz
);
1015 clientReplyContext::storeNotOKTransferDone() const
1018 * Now, handle STORE_PENDING objects
1020 MemObject
*mem
= http
->storeEntry()->mem_obj
;
1021 assert(mem
!= NULL
);
1022 assert(http
->request
!= NULL
);
1023 /* mem->reply was wrong because it uses the UPSTREAM header length!!! */
1024 HttpReply
const *curReply
= mem
->getReply();
1026 if (headers_sz
== 0)
1027 /* haven't found end of headers yet */
1030 int sending
= SENDING_BODY
;
1032 if (curReply
->sline
.status
== HTTP_NO_CONTENT
||
1033 curReply
->sline
.status
== HTTP_NOT_MODIFIED
||
1034 curReply
->sline
.status
< HTTP_OK
||
1035 http
->request
->method
== METHOD_HEAD
)
1036 sending
= SENDING_HDRSONLY
;
1039 * Figure out how much data we are supposed to send.
1040 * If we are sending a body and we don't have a content-length,
1041 * then we must wait for the object to become STORE_OK.
1043 if (curReply
->content_length
< 0)
1046 int64_t expectedLength
= curReply
->content_length
+ http
->out
.headers_sz
;
1048 if (http
->out
.size
< expectedLength
)
1051 debugs(88,3,HERE
<< "storeNotOKTransferDone " <<
1052 " out.size=" << http
->out
.size
<<
1053 " expectedLength=" << expectedLength
);
1059 /* A write has completed, what is the next status based on the
1060 * canonical request data?
1061 * 1 something is wrong
1062 * 0 nothing is wrong.
1066 clientHttpRequestStatus(int fd
, ClientHttpRequest
const *http
)
1068 #if SIZEOF_INT64_T == 4
1069 if (http
->out
.size
> 0x7FFF0000) {
1070 debugs(88, 1, "WARNING: closing FD " << fd
<< " to prevent out.size counter overflow");
1071 debugs(88, 1, "\tclient " << http
->getConn()->peer
);
1072 debugs(88, 1, "\treceived " << http
->out
.size
<< " bytes");
1073 debugs(88, 1, "\tURI " << http
->log_uri
);
1077 if (http
->out
.offset
> 0x7FFF0000) {
1078 debugs(88, 1, "WARNING: closing FD " << fd
< " to prevent out.offset counter overflow");
1079 debugs(88, 1, "\tclient " << http
->getConn()->peer
);
1080 debugs(88, 1, "\treceived " << http
->out
.size
<< " bytes, offset " << http
->out
.offset
);
1081 debugs(88, 1, "\tURI " << http
->log_uri
);
1090 * *http is a valid structure.
1091 * fd is either -1, or an open fd.
1093 * TODO: enumify this
1095 * This function is used by any http request sink, to determine the status
1098 clientStream_status_t
1099 clientReplyStatus(clientStreamNode
* aNode
, ClientHttpRequest
* http
)
1101 clientReplyContext
*context
= dynamic_cast<clientReplyContext
*>(aNode
->data
.getRaw());
1103 assert (context
->http
== http
);
1104 return context
->replyStatus();
1107 clientStream_status_t
1108 clientReplyContext::replyStatus()
1111 /* Here because lower nodes don't need it */
1113 if (http
->storeEntry() == NULL
) {
1114 debugs(88, 5, "clientReplyStatus: no storeEntry");
1115 return STREAM_FAILED
; /* yuck, but what can we do? */
1118 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) {
1119 /* TODO: Could upstream read errors (result.flags.error) be
1120 * lost, and result in undersize requests being considered
1121 * complete. Should we tcp reset such connections ?
1123 debugs(88, 5, "clientReplyStatus: aborted storeEntry");
1124 return STREAM_FAILED
;
1127 if ((done
= checkTransferDone()) != 0 || flags
.complete
) {
1128 debugs(88, 5, "clientReplyStatus: transfer is DONE");
1129 /* Ok we're finished, but how? */
1131 const int64_t expectedBodySize
=
1132 http
->storeEntry()->getReply()->bodySize(http
->request
->method
);
1133 if (!http
->request
->flags
.proxy_keepalive
&& expectedBodySize
< 0) {
1134 debugs(88, 5, "clientReplyStatus: closing, content_length < 0");
1135 return STREAM_FAILED
;
1139 debugs(88, 5, "clientReplyStatus: closing, !done, but read 0 bytes");
1140 return STREAM_FAILED
;
1143 if (expectedBodySize
>= 0 && !http
->gotEnough()) {
1144 debugs(88, 5, "clientReplyStatus: client didn't get all it expected");
1145 return STREAM_UNPLANNED_COMPLETE
;
1148 if (http
->request
->flags
.proxy_keepalive
) {
1149 debugs(88, 5, "clientReplyStatus: stream complete and can keepalive");
1150 return STREAM_COMPLETE
;
1153 debugs(88, 5, "clientReplyStatus: stream was not expected to complete!");
1154 return STREAM_UNPLANNED_COMPLETE
;
1157 // XXX: Should this be checked earlier? We could return above w/o checking.
1158 if (reply
->receivedBodyTooLarge(*http
->request
, http
->out
.offset
- 4096)) {
1159 /* 4096 is a margin for the HTTP headers included in out.offset */
1160 debugs(88, 5, "clientReplyStatus: client reply body is too large");
1161 return STREAM_FAILED
;
1167 /* Responses with no body will not have a content-type header,
1168 * which breaks the rep_mime_type acl, which
1169 * coincidentally, is the most common acl for reply access lists.
1170 * A better long term fix for this is to allow acl matchs on the various
1171 * status codes, and then supply a default ruleset that puts these
1172 * codes before any user defines access entries. That way the user
1173 * can choose to block these responses where appropriate, but won't get
1174 * mysterious breakages.
1177 clientReplyContext::alwaysAllowResponse(http_status sline
) const
1185 case HTTP_SWITCHING_PROTOCOLS
:
1187 case HTTP_PROCESSING
:
1189 case HTTP_NO_CONTENT
:
1191 case HTTP_NOT_MODIFIED
:
1203 * Generate the reply headers sent to client.
1205 * Filters out unwanted entries and hop-by-hop from original reply header
1206 * then adds extra entries if we have more info than origin server
1207 * then adds Squid specific entries
1210 clientReplyContext::buildReplyHeader()
1212 HttpHeader
*hdr
= &reply
->header
;
1213 int is_hit
= logTypeIsATcpHit(http
->logType
);
1214 HttpRequest
*request
= http
->request
;
1215 #if DONT_FILTER_THESE
1216 /* but you might want to if you run Squid as an HTTP accelerator */
1217 /* hdr->delById(HDR_ACCEPT_RANGES); */
1218 hdr
->delById(HDR_ETAG
);
1222 hdr
->delById(HDR_SET_COOKIE
);
1224 // if there is not configured a peer proxy with login=PASS option enabled
1225 // remove the Proxy-Authenticate header
1226 if ( !(request
->peer_login
&& strcmp(request
->peer_login
,"PASS") ==0))
1227 reply
->header
.delById(HDR_PROXY_AUTHENTICATE
);
1229 reply
->header
.removeHopByHopEntries();
1231 // if (request->range)
1232 // clientBuildRangeHeader(http, reply);
1235 * Add a estimated Age header on cache hits.
1239 * Remove any existing Age header sent by upstream caches
1240 * (note that the existing header is passed along unmodified
1243 hdr
->delById(HDR_AGE
);
1245 * This adds the calculated object age. Note that the details of the
1246 * age calculation is performed by adjusting the timestamp in
1247 * StoreEntry::timestampsSet(), not here.
1250 // XXX: realy useless? or is there a bug now that this is detatched from the below if-sequence ?
1251 // looks like this pre-if was supposed to be the browser workaround...
1252 if (NULL
== http
->storeEntry())
1254 else if (http
->storeEntry()->timestamp
< 0)
1258 if (EBIT_TEST(http
->storeEntry()->flags
, ENTRY_SPECIAL
)) {
1259 hdr
->delById(HDR_DATE
);
1260 hdr
->insertTime(HDR_DATE
, squid_curtime
);
1261 } else if (http
->storeEntry()->timestamp
<= squid_curtime
) {
1262 hdr
->putInt(HDR_AGE
,
1263 squid_curtime
- http
->storeEntry()->timestamp
);
1264 /* Signal old objects. NB: rfc 2616 is not clear,
1265 * by implication, on whether we should do this to all
1266 * responses, or only cache hits.
1267 * 14.46 states it ONLY applys for heuristically caclulated
1268 * freshness values, 13.2.4 doesn't specify the same limitation.
1269 * We interpret RFC 2616 under the combination.
1271 /* TODO: if maxage or s-maxage is present, don't do this */
1273 if (squid_curtime
- http
->storeEntry()->timestamp
>= 86400) {
1275 snprintf (tbuf
, sizeof(tbuf
), "%s %s %s",
1277 "This cache hit is still fresh and more than 1 day old");
1278 hdr
->putStr(HDR_WARNING
, tbuf
);
1283 /* RFC 2616: Section 14.18
1285 * Add a Date: header if missing.
1286 * We have access to a clock therefore are required to amend any shortcoming in servers.
1288 * NP: done after Age: to prevent ENTRY_SPECIAL double-handling this header.
1290 if ( !hdr
->has(HDR_DATE
) ) {
1291 if (!http
->storeEntry())
1292 hdr
->insertTime(HDR_DATE
, squid_curtime
);
1293 else if (http
->storeEntry()->timestamp
> 0)
1294 hdr
->insertTime(HDR_DATE
, http
->storeEntry()->timestamp
);
1296 debugs(88,1,"WARNING: An error inside Squid has caused an HTTP reply without Date:. Please report this");
1297 /* TODO: dump something useful about the problem */
1301 // add Warnings required by RFC 2616 if serving a stale hit
1302 if (http
->request
->flags
.stale_if_hit
&& logTypeIsATcpHit(http
->logType
)) {
1303 hdr
->putWarning(110, "Response is stale");
1304 if (http
->request
->flags
.need_validation
)
1305 hdr
->putWarning(111, "Revalidation failed");
1308 /* Filter unproxyable authentication types */
1310 if (http
->logType
!= LOG_TCP_DENIED
&&
1311 hdr
->has(HDR_WWW_AUTHENTICATE
)) {
1312 HttpHeaderPos pos
= HttpHeaderInitPos
;
1315 int connection_auth_blocked
= 0;
1316 while ((e
= hdr
->getEntry(&pos
))) {
1317 if (e
->id
== HDR_WWW_AUTHENTICATE
) {
1318 const char *value
= e
->value
.rawBuf();
1320 if ((strncasecmp(value
, "NTLM", 4) == 0 &&
1321 (value
[4] == '\0' || value
[4] == ' '))
1323 (strncasecmp(value
, "Negotiate", 9) == 0 &&
1324 (value
[9] == '\0' || value
[9] == ' '))
1326 (strncasecmp(value
, "Kerberos", 8) == 0 &&
1327 (value
[8] == '\0' || value
[8] == ' '))) {
1328 if (request
->flags
.connection_auth_disabled
) {
1329 hdr
->delAt(pos
, connection_auth_blocked
);
1332 request
->flags
.must_keepalive
= 1;
1333 if (!request
->flags
.accelerated
&& !request
->flags
.intercepted
) {
1334 httpHeaderPutStrf(hdr
, HDR_PROXY_SUPPORT
, "Session-Based-Authentication");
1336 We send "[Proxy-]Connection: Proxy-Support" header to mark
1337 Proxy-Support as a hop-by-hop header for intermediaries that do not
1338 understand the semantics of this header. The RFC should have included
1339 this recommendation.
1341 httpHeaderPutStrf(hdr
, HDR_CONNECTION
, "Proxy-support");
1348 if (connection_auth_blocked
)
1352 /* Handle authentication headers */
1353 if (http
->logType
== LOG_TCP_DENIED
&&
1354 ( reply
->sline
.status
== HTTP_PROXY_AUTHENTICATION_REQUIRED
||
1355 reply
->sline
.status
== HTTP_UNAUTHORIZED
)
1357 /* Add authentication header */
1358 /*! \todo alter errorstate to be accel on|off aware. The 0 on the next line
1359 * depends on authenticate behaviour: all schemes to date send no extra
1360 * data on 407/401 responses, and do not check the accel state on 401/407
1363 authenticateFixHeader(reply
, request
->auth_user_request
, request
, 0, 1);
1364 } else if (request
->auth_user_request
!= NULL
)
1365 authenticateFixHeader(reply
, request
->auth_user_request
, request
, http
->flags
.accel
, 0);
1367 /* Append X-Cache */
1368 httpHeaderPutStrf(hdr
, HDR_X_CACHE
, "%s from %s",
1369 is_hit
? "HIT" : "MISS", getMyHostname());
1371 #if USE_CACHE_DIGESTS
1372 /* Append X-Cache-Lookup: -- temporary hack, to be removed @?@ @?@ */
1373 httpHeaderPutStrf(hdr
, HDR_X_CACHE_LOOKUP
, "%s from %s:%d",
1374 lookup_type
? lookup_type
: "NONE",
1375 getMyHostname(), getMyPort());
1379 const bool maySendChunkedReply
= !request
->multipartRangeRequest() &&
1380 (request
->http_ver
>= HttpVersion(1, 1));
1382 /* Check whether we should send keep-alive */
1383 if (!Config
.onoff
.error_pconns
&& reply
->sline
.status
>= 400 && !request
->flags
.must_keepalive
) {
1384 debugs(33, 3, "clientBuildReplyHeader: Error, don't keep-alive");
1385 request
->flags
.proxy_keepalive
= 0;
1386 } else if (!Config
.onoff
.client_pconns
&& !request
->flags
.must_keepalive
) {
1387 debugs(33, 2, "clientBuildReplyHeader: Connection Keep-Alive not requested by admin or client");
1388 request
->flags
.proxy_keepalive
= 0;
1389 } else if (request
->flags
.proxy_keepalive
&& shutting_down
) {
1390 debugs(88, 3, "clientBuildReplyHeader: Shutting down, don't keep-alive.");
1391 request
->flags
.proxy_keepalive
= 0;
1392 } else if (request
->flags
.connection_auth
&& !reply
->keep_alive
) {
1393 debugs(33, 2, "clientBuildReplyHeader: Connection oriented auth but server side non-persistent");
1394 request
->flags
.proxy_keepalive
= 0;
1395 } else if (reply
->bodySize(request
->method
) < 0 && !maySendChunkedReply
) {
1396 debugs(88, 3, "clientBuildReplyHeader: can't keep-alive, unknown body size" );
1397 request
->flags
.proxy_keepalive
= 0;
1398 } else if (fdUsageHigh()&& !request
->flags
.must_keepalive
) {
1399 debugs(88, 3, "clientBuildReplyHeader: Not many unused FDs, can't keep-alive");
1400 request
->flags
.proxy_keepalive
= 0;
1403 // Decide if we send chunked reply
1404 if (maySendChunkedReply
&&
1405 request
->flags
.proxy_keepalive
&&
1406 reply
->bodySize(request
->method
) < 0) {
1407 debugs(88, 3, "clientBuildReplyHeader: chunked reply");
1408 request
->flags
.chunked_reply
= 1;
1409 hdr
->putStr(HDR_TRANSFER_ENCODING
, "chunked");
1413 if (Config
.onoff
.via
) {
1414 LOCAL_ARRAY(char, bbuf
, MAX_URL
+ 32);
1416 hdr
->getList(HDR_VIA
, &strVia
);
1417 snprintf(bbuf
, MAX_URL
+ 32, "%d.%d %s",
1418 reply
->sline
.version
.major
,
1419 reply
->sline
.version
.minor
,
1421 strListAdd(&strVia
, bbuf
, ',');
1422 hdr
->delById(HDR_VIA
);
1423 hdr
->putStr(HDR_VIA
, strVia
.termedBuf());
1425 /* Signal keep-alive or close explicitly */
1426 hdr
->putStr(HDR_CONNECTION
, request
->flags
.proxy_keepalive
? "keep-alive" : "close");
1428 #if ADD_X_REQUEST_URI
1430 * Knowing the URI of the request is useful when debugging persistent
1431 * connections in a client; we cannot guarantee the order of http headers,
1432 * but X-Request-URI is likely to be the very last header to ease use from a
1433 * debugger [hdr->entries.count-1].
1435 hdr
->putStr(HDR_X_REQUEST_URI
,
1436 http
->memOjbect()->url
? http
->memObject()->url
: http
->uri
);
1440 /* Surrogate-Control requires Surrogate-Capability from upstream to pass on */
1441 if ( hdr
->has(HDR_SURROGATE_CONTROL
) ) {
1442 if (!request
->header
.has(HDR_SURROGATE_CAPABILITY
)) {
1443 hdr
->delById(HDR_SURROGATE_CONTROL
);
1445 /* TODO: else case: drop any controls intended specifically for our surrogate ID */
1448 httpHdrMangleList(hdr
, request
, ROR_REPLY
);
1453 clientReplyContext::cloneReply()
1455 assert(reply
== NULL
);
1457 HttpReply
*rep
= http
->storeEntry()->getReply()->clone();
1459 reply
= HTTPMSGLOCK(rep
);
1461 if (reply
->sline
.protocol
== PROTO_HTTP
) {
1462 /* RFC 2616 requires us to advertise our 1.1 version (but only on real HTTP traffic) */
1463 reply
->sline
.version
= HttpVersion(1,1);
1466 /* do header conversions */
1471 clientReplyContext::identifyStoreObject()
1473 HttpRequest
*r
= http
->request
;
1475 if (r
->flags
.cachable
|| r
->flags
.internal
) {
1476 lookingforstore
= 5;
1477 StoreEntry::getPublicByRequest (this, r
);
1479 identifyFoundObject (NullStoreEntry::getInstance());
1484 * Check state of the current StoreEntry object.
1485 * to see if we can determine the final status of the request.
1488 clientReplyContext::identifyFoundObject(StoreEntry
*newEntry
)
1490 StoreEntry
*e
= newEntry
;
1491 HttpRequest
*r
= http
->request
;
1493 /** \li If the entry received isNull() then we ignore it. */
1495 http
->storeEntry(NULL
);
1497 http
->storeEntry(e
);
1500 e
= http
->storeEntry();
1502 /* Release IP-cache entries on reload */
1503 /** \li If the request has no-cache flag set or some no_cache HACK in operation we
1504 * 'invalidate' the cached IP entries for this request ???
1506 if (r
->flags
.nocache
) {
1510 ipcacheInvalidate(r
->GetHost());
1514 ipcacheInvalidateNegative(r
->GetHost());
1516 #endif /* USE_DNSSERVERS */
1520 #if USE_HTTP_VIOLATIONS
1522 else if (r
->flags
.nocache_hack
) {
1526 ipcacheInvalidate(r
->GetHost());
1530 ipcacheInvalidateNegative(r
->GetHost());
1532 #endif /* USE_DNSSERVERS */
1536 #endif /* USE_HTTP_VIOLATIONS */
1537 #if USE_CACHE_DIGESTS
1539 lookup_type
= http
->storeEntry() ? "HIT" : "MISS";
1543 if (NULL
== http
->storeEntry()) {
1544 /** \li If no StoreEntry object is current assume this object isn't in the cache set MISS*/
1545 debugs(85, 3, "clientProcessRequest2: StoreEntry is NULL - MISS");
1546 http
->logType
= LOG_TCP_MISS
;
1551 if (Config
.onoff
.offline
) {
1552 /** \li If we are running in offline mode set to HIT */
1553 debugs(85, 3, "clientProcessRequest2: offline HIT");
1554 http
->logType
= LOG_TCP_HIT
;
1559 if (http
->redirect
.status
) {
1560 /** \li If redirection status is True force this to be a MISS */
1561 debugs(85, 3, "clientProcessRequest2: redirectStatus forced StoreEntry to NULL - MISS");
1562 http
->storeEntry(NULL
);
1563 http
->logType
= LOG_TCP_MISS
;
1568 if (!e
->validToSend()) {
1569 debugs(85, 3, "clientProcessRequest2: !storeEntryValidToSend MISS" );
1570 http
->storeEntry(NULL
);
1571 http
->logType
= LOG_TCP_MISS
;
1576 if (EBIT_TEST(e
->flags
, ENTRY_SPECIAL
)) {
1577 /* \li Special entries are always hits, no matter what the client says */
1578 debugs(85, 3, "clientProcessRequest2: ENTRY_SPECIAL HIT");
1579 http
->logType
= LOG_TCP_HIT
;
1584 if (r
->flags
.nocache
) {
1585 debugs(85, 3, "clientProcessRequest2: no-cache REFRESH MISS");
1586 http
->storeEntry(NULL
);
1587 http
->logType
= LOG_TCP_CLIENT_REFRESH_MISS
;
1592 debugs(85, 3, "clientProcessRequest2: default HIT");
1593 http
->logType
= LOG_TCP_HIT
;
1598 * Request more data from the store for the client Stream
1599 * This is *the* entry point to this module.
1602 * - This is the head of the list.
1603 * - There is at least one more node.
1604 * - Data context is not null
1607 clientGetMoreData(clientStreamNode
* aNode
, ClientHttpRequest
* http
)
1609 /* Test preconditions */
1610 assert(aNode
!= NULL
);
1611 assert(cbdataReferenceValid(aNode
));
1612 assert(aNode
->node
.prev
== NULL
);
1613 assert(aNode
->node
.next
!= NULL
);
1614 clientReplyContext
*context
= dynamic_cast<clientReplyContext
*>(aNode
->data
.getRaw());
1616 assert(context
->http
== http
);
1619 clientStreamNode
*next
= ( clientStreamNode
*)aNode
->node
.next
->data
;
1621 if (!context
->ourNode
)
1622 context
->ourNode
= aNode
;
1624 /* no cbdatareference, this is only used once, and safely */
1625 if (context
->flags
.storelogiccomplete
) {
1626 StoreIOBuffer tempBuffer
;
1627 tempBuffer
.offset
= next
->readBuffer
.offset
+ context
->headers_sz
;
1628 tempBuffer
.length
= next
->readBuffer
.length
;
1629 tempBuffer
.data
= next
->readBuffer
.data
;
1631 storeClientCopy(context
->sc
, http
->storeEntry(),
1632 tempBuffer
, clientReplyContext::SendMoreData
, context
);
1636 if (context
->http
->request
->method
== METHOD_PURGE
) {
1637 context
->purgeRequest();
1641 // OPTIONS with Max-Forwards:0 handled in clientProcessRequest()
1643 if (context
->http
->request
->method
== METHOD_TRACE
) {
1644 if (context
->http
->request
->max_forwards
== 0) {
1645 context
->traceReply(aNode
);
1649 /* continue forwarding, not finished yet. */
1650 http
->logType
= LOG_TCP_MISS
;
1652 context
->doGetMoreData();
1654 context
->identifyStoreObject();
1658 clientReplyContext::doGetMoreData()
1660 /* We still have to do store logic processing - vary, cache hit etc */
1661 if (http
->storeEntry() != NULL
) {
1662 /* someone found the object in the cache for us */
1663 StoreIOBuffer localTempBuffer
;
1665 http
->storeEntry()->lock();
1667 if (http
->storeEntry()->mem_obj
== NULL
) {
1669 * This if-block exists because we don't want to clobber
1670 * a preexiting mem_obj->method value if the mem_obj
1671 * already exists. For example, when a HEAD request
1672 * is a cache hit for a GET response, we want to keep
1673 * the method as GET.
1675 http
->storeEntry()->createMemObject(http
->uri
, http
->log_uri
);
1676 http
->storeEntry()->mem_obj
->method
= http
->request
->method
;
1679 sc
= storeClientListAdd(http
->storeEntry(), this);
1682 sc
->setDelayId(DelayId::DelayClient(http
));
1685 assert(http
->logType
== LOG_TCP_HIT
);
1687 /* guarantee nothing has been sent yet! */
1688 assert(http
->out
.size
== 0);
1689 assert(http
->out
.offset
== 0);
1691 if (Ip::Qos::TheConfig
.isHitTosActive()) {
1692 Ip::Qos::doTosLocalHit(http
->getConn()->clientConn
);
1695 if (Ip::Qos::TheConfig
.isHitNfmarkActive()) {
1696 Ip::Qos::doNfmarkLocalHit(http
->getConn()->clientConn
);
1699 localTempBuffer
.offset
= reqofs
;
1700 localTempBuffer
.length
= getNextNode()->readBuffer
.length
;
1701 localTempBuffer
.data
= getNextNode()->readBuffer
.data
;
1702 storeClientCopy(sc
, http
->storeEntry(), localTempBuffer
, CacheHit
, this);
1704 /* MISS CASE, http->logType is already set! */
1709 /** The next node has removed itself from the stream. */
1711 clientReplyDetach(clientStreamNode
* node
, ClientHttpRequest
* http
)
1713 /** detach from the stream */
1714 clientStreamDetach(node
, http
);
1718 * Accepts chunk of a http message in buf, parses prefix, filters headers and
1719 * such, writes processed message to the message recipient
1722 clientReplyContext::SendMoreData(void *data
, StoreIOBuffer result
)
1724 clientReplyContext
*context
= static_cast<clientReplyContext
*>(data
);
1725 context
->sendMoreData (result
);
1729 clientReplyContext::makeThisHead()
1731 /* At least, I think thats what this does */
1732 dlinkDelete(&http
->active
, &ClientActiveRequests
);
1733 dlinkAdd(http
, &http
->active
, &ClientActiveRequests
);
1737 clientReplyContext::errorInStream(StoreIOBuffer
const &result
, size_t const &sizeToProcess
)const
1739 return /* aborted request */
1740 (http
->storeEntry() && EBIT_TEST(http
->storeEntry()->flags
, ENTRY_ABORTED
)) ||
1741 /* Upstream read error */ (result
.flags
.error
) ||
1742 /* Upstream EOF */ (sizeToProcess
== 0);
1746 clientReplyContext::sendStreamError(StoreIOBuffer
const &result
)
1748 /** call clientWriteComplete so the client socket gets closed
1750 * We call into the stream, because we don't know that there is a
1753 debugs(88, 5, "clientReplyContext::sendStreamError: A stream error has occured, marking as complete and sending no data.");
1754 StoreIOBuffer localTempBuffer
;
1756 http
->request
->flags
.stream_error
= 1;
1757 localTempBuffer
.flags
.error
= result
.flags
.error
;
1758 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
, http
, NULL
,
1763 clientReplyContext::pushStreamData(StoreIOBuffer
const &result
, char *source
)
1765 StoreIOBuffer localTempBuffer
;
1767 if (result
.length
== 0) {
1768 debugs(88, 5, "clientReplyContext::pushStreamData: marking request as complete due to 0 length store result");
1772 assert(result
.offset
- headers_sz
== next()->readBuffer
.offset
);
1773 localTempBuffer
.offset
= result
.offset
- headers_sz
;
1774 localTempBuffer
.length
= result
.length
;
1776 if (localTempBuffer
.length
)
1777 localTempBuffer
.data
= source
;
1779 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
, http
, NULL
,
1784 clientReplyContext::next() const
1786 assert ( (clientStreamNode
*)http
->client_stream
.head
->next
->data
== getNextNode());
1787 return getNextNode();
1791 clientReplyContext::sendBodyTooLargeError()
1793 Ip::Address tmp_noaddr
;
1794 tmp_noaddr
.SetNoAddr(); // TODO: make a global const
1795 http
->logType
= LOG_TCP_DENIED_REPLY
;
1796 ErrorState
*err
= clientBuildError(ERR_TOO_BIG
, HTTP_FORBIDDEN
, NULL
,
1797 http
->getConn() != NULL
? http
->getConn()->peer
: tmp_noaddr
,
1799 removeClientStoreReference(&(sc
), http
);
1800 HTTPMSGUNLOCK(reply
);
1806 clientReplyContext::processReplyAccess ()
1808 /* NP: this should probably soft-fail to a zero-sized-reply error ?? */
1811 /** Don't block our own responses or HTTP status messages */
1812 if (http
->logType
== LOG_TCP_DENIED
||
1813 http
->logType
== LOG_TCP_DENIED_REPLY
||
1814 alwaysAllowResponse(reply
->sline
.status
)) {
1815 headers_sz
= reply
->hdr_sz
;
1816 processReplyAccessResult(1);
1820 /** Check for reply to big error */
1821 if (reply
->expectedBodyTooLarge(*http
->request
)) {
1822 sendBodyTooLargeError();
1826 headers_sz
= reply
->hdr_sz
;
1828 /** check for absent access controls (permit by default) */
1829 if (!Config
.accessList
.reply
) {
1830 processReplyAccessResult(1);
1834 /** Process http_reply_access lists */
1835 ACLFilledChecklist
*replyChecklist
=
1836 clientAclChecklistCreate(Config
.accessList
.reply
, http
);
1837 replyChecklist
->reply
= HTTPMSGLOCK(reply
);
1838 replyChecklist
->nonBlockingCheck(ProcessReplyAccessResult
, this);
1842 clientReplyContext::ProcessReplyAccessResult (int rv
, void *voidMe
)
1844 clientReplyContext
*me
= static_cast<clientReplyContext
*>(voidMe
);
1845 me
->processReplyAccessResult(rv
);
1849 clientReplyContext::processReplyAccessResult(bool accessAllowed
)
1851 debugs(88, 2, "The reply for " << RequestMethodStr(http
->request
->method
)
1852 << " " << http
->uri
<< " is "
1853 << ( accessAllowed
? "ALLOWED" : "DENIED")
1854 << ", because it matched '"
1855 << (AclMatchedName
? AclMatchedName
: "NO ACL's") << "'" );
1857 if (!accessAllowed
) {
1860 page_id
= aclGetDenyInfoPage(&Config
.denyInfoList
, AclMatchedName
, 1);
1862 http
->logType
= LOG_TCP_DENIED_REPLY
;
1864 if (page_id
== ERR_NONE
)
1865 page_id
= ERR_ACCESS_DENIED
;
1867 Ip::Address tmp_noaddr
;
1868 tmp_noaddr
.SetNoAddr();
1869 err
= clientBuildError(page_id
, HTTP_FORBIDDEN
, NULL
,
1870 http
->getConn() != NULL
? http
->getConn()->peer
: tmp_noaddr
,
1873 removeClientStoreReference(&sc
, http
);
1875 HTTPMSGUNLOCK(reply
);
1883 /* Ok, the reply is allowed, */
1884 http
->loggingEntry(http
->storeEntry());
1886 ssize_t body_size
= reqofs
- reply
->hdr_sz
;
1887 if (body_size
< 0) {
1888 reqofs
= reply
->hdr_sz
;
1892 debugs(88, 3, "clientReplyContext::sendMoreData: Appending " <<
1893 (int) body_size
<< " bytes after " << reply
->hdr_sz
<<
1894 " bytes of headers");
1898 if (http
->flags
.accel
&& reply
->sline
.status
!= HTTP_FORBIDDEN
&&
1899 !alwaysAllowResponse(reply
->sline
.status
) &&
1900 esiEnableProcessing(reply
)) {
1901 debugs(88, 2, "Enabling ESI processing for " << http
->uri
);
1902 clientStreamInsertHead(&http
->client_stream
, esiStreamRead
,
1903 esiProcessStream
, esiStreamDetach
, esiStreamStatus
, NULL
);
1908 if (http
->request
->method
== METHOD_HEAD
) {
1909 /* do not forward body for HEAD replies */
1911 http
->flags
.done_copying
= 1;
1915 assert (!flags
.headersSent
);
1916 flags
.headersSent
= true;
1918 StoreIOBuffer localTempBuffer
;
1919 char *buf
= next()->readBuffer
.data
;
1920 char *body_buf
= buf
+ reply
->hdr_sz
;
1922 //Server side may disable ranges under some circumstances.
1924 if ((!http
->request
->range
))
1925 next()->readBuffer
.offset
= 0;
1927 body_buf
-= next()->readBuffer
.offset
;
1929 if (next()->readBuffer
.offset
!= 0) {
1930 if (next()->readBuffer
.offset
> body_size
) {
1931 /* Can't use any of the body we received. send nothing */
1932 localTempBuffer
.length
= 0;
1933 localTempBuffer
.data
= NULL
;
1935 localTempBuffer
.length
= body_size
- next()->readBuffer
.offset
;
1936 localTempBuffer
.data
= body_buf
+ next()->readBuffer
.offset
;
1939 localTempBuffer
.length
= body_size
;
1940 localTempBuffer
.data
= body_buf
;
1943 /* TODO??: move the data in the buffer back by the request header size */
1944 clientStreamCallback((clientStreamNode
*)http
->client_stream
.head
->data
,
1945 http
, reply
, localTempBuffer
);
1951 clientReplyContext::sendMoreData (StoreIOBuffer result
)
1956 StoreEntry
*entry
= http
->storeEntry();
1958 ConnStateData
* conn
= http
->getConn();
1960 // AYJ: this seems a bit weird to ignore CLOSED but drop on closing.
1961 if (conn
!= NULL
&& Comm::IsConnOpen(conn
->clientConn
) && fd_table
[conn
->clientConn
->fd
].closing()) {
1962 // too late, our conn is closing
1963 // TODO: should we also quit?
1964 debugs(33,3, HERE
<< "not sending more data to a closing " << conn
->clientConn
);
1968 char *buf
= next()->readBuffer
.data
;
1970 char *body_buf
= buf
;
1972 if (buf
!= result
.data
) {
1973 /* we've got to copy some data */
1974 assert(result
.length
<= next()->readBuffer
.length
);
1975 xmemcpy(buf
, result
.data
, result
.length
);
1979 if (reqofs
==0 && !logTypeIsATcpHit(http
->logType
)) {
1980 assert(conn
!= NULL
&& Comm::IsConnOpen(conn
->clientConn
)); // the beginning of this method implies FD may be closed.
1981 if (Ip::Qos::TheConfig
.isHitTosActive()) {
1982 Ip::Qos::doTosLocalMiss(conn
->clientConn
, http
->request
->hier
.code
);
1984 if (Ip::Qos::TheConfig
.isHitNfmarkActive()) {
1985 Ip::Qos::doNfmarkLocalMiss(conn
->clientConn
, http
->request
->hier
.code
);
1989 /* We've got the final data to start pushing... */
1990 flags
.storelogiccomplete
= 1;
1992 reqofs
+= result
.length
;
1994 assert(reqofs
<= HTTP_REQBUF_SZ
|| flags
.headersSent
);
1996 assert(http
->request
!= NULL
);
1998 /* ESI TODO: remove this assert once everything is stable */
1999 assert(http
->client_stream
.head
->data
2000 && cbdataReferenceValid(http
->client_stream
.head
->data
));
2004 debugs(88, 5, "clientReplyContext::sendMoreData: " << http
->uri
<< ", " <<
2005 reqofs
<< " bytes (" << result
.length
<<
2007 debugs(88, 5, "clientReplyContext::sendMoreData:"
2008 << conn
->clientConn
<<
2009 " '" << entry
->url() << "'" <<
2010 " out.offset=" << http
->out
.offset
);
2012 /* update size of the request */
2015 if (errorInStream(result
, reqofs
)) {
2016 sendStreamError(result
);
2020 if (flags
.headersSent
) {
2021 pushStreamData (result
, buf
);
2027 /* handle headers */
2029 if (Config
.onoff
.log_mime_hdrs
) {
2032 if ((k
= headersEnd(buf
, reqofs
))) {
2033 safe_free(http
->al
.headers
.reply
);
2034 http
->al
.headers
.reply
= (char *)xcalloc(k
+ 1, 1);
2035 xstrncpy(http
->al
.headers
.reply
, buf
, k
);
2039 holdingBuffer
= result
;
2040 processReplyAccess();
2044 /* Using this breaks the client layering just a little!
2047 clientReplyContext::createStoreEntry(const HttpRequestMethod
& m
, request_flags reqFlags
)
2049 assert(http
!= NULL
);
2051 * For erroneous requests, we might not have a h->request,
2052 * so make a fake one.
2055 if (http
->request
== NULL
)
2056 http
->request
= HTTPMSGLOCK(new HttpRequest(m
, PROTO_NONE
, null_string
));
2058 StoreEntry
*e
= storeCreateEntry(http
->uri
, http
->log_uri
, reqFlags
, m
);
2060 sc
= storeClientListAdd(e
, this);
2064 sc
->setDelayId(DelayId::DelayClient(http
));
2072 /* I don't think this is actually needed! -- adrian */
2073 /* http->reqbuf = http->norm_reqbuf; */
2074 // assert(http->reqbuf == http->norm_reqbuf);
2075 /* The next line is illegal because we don't know if the client stream
2076 * buffers have been set up
2078 // storeClientCopy(http->sc, e, 0, HTTP_REQBUF_SZ, http->reqbuf,
2079 // SendMoreData, this);
2080 /* So, we mark the store logic as complete */
2081 flags
.storelogiccomplete
= 1;
2083 /* and get the caller to request a read, from whereever they are */
2084 /* NOTE: after ANY data flows down the pipe, even one step,
2085 * this function CAN NOT be used to manage errors
2087 http
->storeEntry(e
);
2091 clientBuildError(err_type page_id
, http_status status
, char const *url
,
2092 Ip::Address
&src_addr
, HttpRequest
* request
)
2094 ErrorState
*err
= errorCon(page_id
, status
, request
);
2095 err
->src_addr
= src_addr
;
2098 err
->url
= xstrdup(url
);