]> git.ipfire.org Git - thirdparty/squid.git/blob - src/client_side_request.cc
Author: Alex Rousskov <rousskov@measurement-factory.com>, Christos Tsantilas <chtsant...
[thirdparty/squid.git] / src / client_side_request.cc
1
2 /*
3 * $Id$
4 *
5 * DEBUG: section 85 Client-side Request Routines
6 * AUTHOR: Robert Collins (Originally Duane Wessels in client_side.c)
7 *
8 * SQUID Web Proxy Cache http://www.squid-cache.org/
9 * ----------------------------------------------------------
10 *
11 * Squid is the result of efforts by numerous individuals from
12 * the Internet community; see the CONTRIBUTORS file for full
13 * details. Many organizations have provided support for Squid's
14 * development; see the SPONSORS file for full details. Squid is
15 * Copyrighted (C) 2001 by the Regents of the University of
16 * California; see the COPYRIGHT file for full details. Squid
17 * incorporates software developed and/or copyrighted by other
18 * sources; see the CREDITS file for full details.
19 *
20 * This program is free software; you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation; either version 2 of the License, or
23 * (at your option) any later version.
24 *
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
29 *
30 * You should have received a copy of the GNU General Public License
31 * along with this program; if not, write to the Free Software
32 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
33 *
34 */
35
36
37 /*
38 * General logic of request processing:
39 *
40 * We run a series of tests to determine if access will be permitted, and to do
41 * any redirection. Then we call into the result clientStream to retrieve data.
42 * From that point on it's up to reply management.
43 */
44
45 #include "squid.h"
46 #include "acl/FilledChecklist.h"
47 #include "acl/Gadgets.h"
48 #if USE_ADAPTATION
49 #include "adaptation/AccessCheck.h"
50 #include "adaptation/Iterator.h"
51 #include "adaptation/Service.h"
52 #if ICAP_CLIENT
53 #include "adaptation/icap/History.h"
54 #endif
55 #endif
56 #include "auth/UserRequest.h"
57 #include "clientStream.h"
58 #include "client_side.h"
59 #include "client_side_reply.h"
60 #include "client_side_request.h"
61 #include "ClientRequestContext.h"
62 #include "compat/inet_pton.h"
63 #include "fde.h"
64 #include "HttpReply.h"
65 #include "HttpRequest.h"
66 #include "ip/QosConfig.h"
67 #include "MemObject.h"
68 #include "ProtoPort.h"
69 #include "Store.h"
70 #include "SquidTime.h"
71 #include "wordlist.h"
72 #include "err_detail_type.h"
73
74
75 #if LINGERING_CLOSE
76 #define comm_close comm_lingering_close
77 #endif
78
79 static const char *const crlf = "\r\n";
80
81 #if FOLLOW_X_FORWARDED_FOR
82 static void
83 clientFollowXForwardedForCheck(int answer, void *data);
84 #endif /* FOLLOW_X_FORWARDED_FOR */
85
86 CBDATA_CLASS_INIT(ClientRequestContext);
87
88 void *
89 ClientRequestContext::operator new (size_t size)
90 {
91 assert (size == sizeof(ClientRequestContext));
92 CBDATA_INIT_TYPE(ClientRequestContext);
93 ClientRequestContext *result = cbdataAlloc(ClientRequestContext);
94 return result;
95 }
96
97 void
98 ClientRequestContext::operator delete (void *address)
99 {
100 ClientRequestContext *t = static_cast<ClientRequestContext *>(address);
101 cbdataFree(t);
102 }
103
104 /* Local functions */
105 /* other */
106 static void clientAccessCheckDoneWrapper(int, void *);
107 static int clientHierarchical(ClientHttpRequest * http);
108 static void clientInterpretRequestHeaders(ClientHttpRequest * http);
109 static RH clientRedirectDoneWrapper;
110 static PF checkNoCacheDoneWrapper;
111 extern "C" CSR clientGetMoreData;
112 extern "C" CSS clientReplyStatus;
113 extern "C" CSD clientReplyDetach;
114 static void checkFailureRatio(err_type, hier_code);
115
116 ClientRequestContext::~ClientRequestContext()
117 {
118 /*
119 * Release our "lock" on our parent, ClientHttpRequest, if we
120 * still have one
121 */
122
123 if (http)
124 cbdataReferenceDone(http);
125
126 debugs(85,3, HERE << this << " ClientRequestContext destructed");
127 }
128
129 ClientRequestContext::ClientRequestContext(ClientHttpRequest *anHttp) : http(cbdataReference(anHttp)), acl_checklist (NULL), redirect_state (REDIRECT_NONE)
130 {
131 http_access_done = false;
132 redirect_done = false;
133 no_cache_done = false;
134 interpreted_req_hdrs = false;
135 debugs(85,3, HERE << this << " ClientRequestContext constructed");
136 }
137
138 CBDATA_CLASS_INIT(ClientHttpRequest);
139
140 void *
141 ClientHttpRequest::operator new (size_t size)
142 {
143 assert (size == sizeof (ClientHttpRequest));
144 CBDATA_INIT_TYPE(ClientHttpRequest);
145 ClientHttpRequest *result = cbdataAlloc(ClientHttpRequest);
146 return result;
147 }
148
149 void
150 ClientHttpRequest::operator delete (void *address)
151 {
152 ClientHttpRequest *t = static_cast<ClientHttpRequest *>(address);
153 cbdataFree(t);
154 }
155
156 ClientHttpRequest::ClientHttpRequest(ConnStateData * aConn) :
157 #if USE_ADAPTATION
158 AsyncJob("ClientHttpRequest"),
159 #endif
160 loggingEntry_(NULL)
161 {
162 start_time = current_time;
163 setConn(aConn);
164 dlinkAdd(this, &active, &ClientActiveRequests);
165 #if USE_ADAPTATION
166 request_satisfaction_mode = false;
167 #endif
168 }
169
170 /*
171 * returns true if client specified that the object must come from the cache
172 * without contacting origin server
173 */
174 bool
175 ClientHttpRequest::onlyIfCached()const
176 {
177 assert(request);
178 return request->cache_control &&
179 EBIT_TEST(request->cache_control->mask, CC_ONLY_IF_CACHED);
180 }
181
182 /*
183 * This function is designed to serve a fairly specific purpose.
184 * Occasionally our vBNS-connected caches can talk to each other, but not
185 * the rest of the world. Here we try to detect frequent failures which
186 * make the cache unusable (e.g. DNS lookup and connect() failures). If
187 * the failure:success ratio goes above 1.0 then we go into "hit only"
188 * mode where we only return UDP_HIT or UDP_MISS_NOFETCH. Neighbors
189 * will only fetch HITs from us if they are using the ICP protocol. We
190 * stay in this mode for 5 minutes.
191 *
192 * Duane W., Sept 16, 1996
193 */
194
195 #define FAILURE_MODE_TIME 300
196
197 static void
198 checkFailureRatio(err_type etype, hier_code hcode)
199 {
200 static double magic_factor = 100.0;
201 double n_good;
202 double n_bad;
203
204 if (hcode == HIER_NONE)
205 return;
206
207 n_good = magic_factor / (1.0 + request_failure_ratio);
208
209 n_bad = magic_factor - n_good;
210
211 switch (etype) {
212
213 case ERR_DNS_FAIL:
214
215 case ERR_CONNECT_FAIL:
216 case ERR_SECURE_CONNECT_FAIL:
217
218 case ERR_READ_ERROR:
219 n_bad++;
220 break;
221
222 default:
223 n_good++;
224 }
225
226 request_failure_ratio = n_bad / n_good;
227
228 if (hit_only_mode_until > squid_curtime)
229 return;
230
231 if (request_failure_ratio < 1.0)
232 return;
233
234 debugs(33, 0, "Failure Ratio at "<< std::setw(4)<<
235 std::setprecision(3) << request_failure_ratio);
236
237 debugs(33, 0, "Going into hit-only-mode for " <<
238 FAILURE_MODE_TIME / 60 << " minutes...");
239
240 hit_only_mode_until = squid_curtime + FAILURE_MODE_TIME;
241
242 request_failure_ratio = 0.8; /* reset to something less than 1.0 */
243 }
244
245 ClientHttpRequest::~ClientHttpRequest()
246 {
247 debugs(33, 3, "httpRequestFree: " << uri);
248 PROF_start(httpRequestFree);
249
250 // Even though freeResources() below may destroy the request,
251 // we no longer set request->body_pipe to NULL here
252 // because we did not initiate that pipe (ConnStateData did)
253
254 /* the ICP check here was erroneous
255 * - StoreEntry::releaseRequest was always called if entry was valid
256 */
257 assert(logType < LOG_TYPE_MAX);
258
259 logRequest();
260
261 loggingEntry(NULL);
262
263 if (request)
264 checkFailureRatio(request->errType, al.hier.code);
265
266 freeResources();
267
268 #if USE_ADAPTATION
269 announceInitiatorAbort(virginHeadSource);
270
271 if (adaptedBodySource != NULL)
272 stopConsumingFrom(adaptedBodySource);
273 #endif
274
275 if (calloutContext)
276 delete calloutContext;
277
278 if (conn_)
279 cbdataReferenceDone(conn_);
280
281 /* moving to the next connection is handled by the context free */
282 dlinkDelete(&active, &ClientActiveRequests);
283
284 PROF_stop(httpRequestFree);
285 }
286
287 /**
288 * Create a request and kick it off
289 *
290 * \retval 0 success
291 * \retval -1 failure
292 *
293 * TODO: Pass in the buffers to be used in the inital Read request, as they are
294 * determined by the user
295 */
296 int
297 clientBeginRequest(const HttpRequestMethod& method, char const *url, CSCB * streamcallback,
298 CSD * streamdetach, ClientStreamData streamdata, HttpHeader const *header,
299 char *tailbuf, size_t taillen)
300 {
301 size_t url_sz;
302 ClientHttpRequest *http = new ClientHttpRequest(NULL);
303 HttpRequest *request;
304 StoreIOBuffer tempBuffer;
305 http->start_time = current_time;
306 /* this is only used to adjust the connection offset in client_side.c */
307 http->req_sz = 0;
308 tempBuffer.length = taillen;
309 tempBuffer.data = tailbuf;
310 /* client stream setup */
311 clientStreamInit(&http->client_stream, clientGetMoreData, clientReplyDetach,
312 clientReplyStatus, new clientReplyContext(http), streamcallback,
313 streamdetach, streamdata, tempBuffer);
314 /* make it visible in the 'current acctive requests list' */
315 /* Set flags */
316 /* internal requests only makes sense in an
317 * accelerator today. TODO: accept flags ? */
318 http->flags.accel = 1;
319 /* allow size for url rewriting */
320 url_sz = strlen(url) + Config.appendDomainLen + 5;
321 http->uri = (char *)xcalloc(url_sz, 1);
322 strcpy(http->uri, url);
323
324 if ((request = HttpRequest::CreateFromUrlAndMethod(http->uri, method)) == NULL) {
325 debugs(85, 5, "Invalid URL: " << http->uri);
326 return -1;
327 }
328
329 /*
330 * now update the headers in request with our supplied headers. urlParse
331 * should return a blank header set, but we use Update to be sure of
332 * correctness.
333 */
334 if (header)
335 request->header.update(header, NULL);
336
337 http->log_uri = xstrdup(urlCanonicalClean(request));
338
339 /* http struct now ready */
340
341 /*
342 * build new header list *? TODO
343 */
344 request->flags.accelerated = http->flags.accel;
345
346 request->flags.internalclient = 1;
347
348 /* this is an internally created
349 * request, not subject to acceleration
350 * target overrides */
351 /*
352 * FIXME? Do we want to detect and handle internal requests of internal
353 * objects ?
354 */
355
356 /* Internally created requests cannot have bodies today */
357 request->content_length = 0;
358
359 request->client_addr.SetNoAddr();
360
361 #if FOLLOW_X_FORWARDED_FOR
362 request->indirect_client_addr.SetNoAddr();
363 #endif /* FOLLOW_X_FORWARDED_FOR */
364
365 request->my_addr.SetNoAddr(); /* undefined for internal requests */
366
367 request->my_addr.SetPort(0);
368
369 /* Our version is HTTP/1.1 */
370 HttpVersion http_ver(1,1);
371 request->http_ver = http_ver;
372
373 http->request = HTTPMSGLOCK(request);
374
375 /* optional - skip the access check ? */
376 http->calloutContext = new ClientRequestContext(http);
377
378 http->calloutContext->http_access_done = false;
379
380 http->calloutContext->redirect_done = true;
381
382 http->calloutContext->no_cache_done = true;
383
384 http->doCallouts();
385
386 return 0;
387 }
388
389 bool
390 ClientRequestContext::httpStateIsValid()
391 {
392 ClientHttpRequest *http_ = http;
393
394 if (cbdataReferenceValid(http_))
395 return true;
396
397 http = NULL;
398
399 cbdataReferenceDone(http_);
400
401 return false;
402 }
403
404 #if FOLLOW_X_FORWARDED_FOR
405 /**
406 * clientFollowXForwardedForCheck() checks the content of X-Forwarded-For:
407 * against the followXFF ACL, or cleans up and passes control to
408 * clientAccessCheck().
409 *
410 * The trust model here is a little ambiguous. So to clarify the logic:
411 * - we may always use the direct client address as the client IP.
412 * - these trust tests merey tell whether we trust given IP enough to believe the
413 * IP string which it appended to the X-Forwarded-For: header.
414 * - if at any point we don't trust what an IP adds we stop looking.
415 * - at that point the current contents of indirect_client_addr are the value set
416 * by the last previously trusted IP.
417 * ++ indirect_client_addr contains the remote direct client from the trusted peers viewpoint.
418 */
419 static void
420 clientFollowXForwardedForCheck(int answer, void *data)
421 {
422 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
423
424 if (!calloutContext->httpStateIsValid())
425 return;
426
427 ClientHttpRequest *http = calloutContext->http;
428 HttpRequest *request = http->request;
429
430 /*
431 * answer should be be ACCESS_ALLOWED or ACCESS_DENIED if we are
432 * called as a result of ACL checks, or -1 if we are called when
433 * there's nothing left to do.
434 */
435 if (answer == ACCESS_ALLOWED &&
436 request->x_forwarded_for_iterator.size () != 0) {
437
438 /*
439 * Remove the last comma-delimited element from the
440 * x_forwarded_for_iterator and use it to repeat the cycle.
441 */
442 const char *p;
443 const char *asciiaddr;
444 int l;
445 Ip::Address addr;
446 p = request->x_forwarded_for_iterator.termedBuf();
447 l = request->x_forwarded_for_iterator.size();
448
449 /*
450 * XXX x_forwarded_for_iterator should really be a list of
451 * IP addresses, but it's a String instead. We have to
452 * walk backwards through the String, biting off the last
453 * comma-delimited part each time. As long as the data is in
454 * a String, we should probably implement and use a variant of
455 * strListGetItem() that walks backwards instead of forwards
456 * through a comma-separated list. But we don't even do that;
457 * we just do the work in-line here.
458 */
459 /* skip trailing space and commas */
460 while (l > 0 && (p[l-1] == ',' || xisspace(p[l-1])))
461 l--;
462 request->x_forwarded_for_iterator.cut(l);
463 /* look for start of last item in list */
464 while (l > 0 && ! (p[l-1] == ',' || xisspace(p[l-1])))
465 l--;
466 asciiaddr = p+l;
467 if ((addr = asciiaddr)) {
468 request->indirect_client_addr = addr;
469 request->x_forwarded_for_iterator.cut(l);
470 calloutContext->acl_checklist = clientAclChecklistCreate(Config.accessList.followXFF, http);
471 if (!Config.onoff.acl_uses_indirect_client) {
472 /* override the default src_addr tested if we have to go deeper than one level into XFF */
473 Filled(calloutContext->acl_checklist)->src_addr = request->indirect_client_addr;
474 }
475 calloutContext->acl_checklist->nonBlockingCheck(clientFollowXForwardedForCheck, data);
476 return;
477 }
478 } /*if (answer == ACCESS_ALLOWED &&
479 request->x_forwarded_for_iterator.size () != 0)*/
480
481 /* clean up, and pass control to clientAccessCheck */
482 if (Config.onoff.log_uses_indirect_client) {
483 /*
484 * Ensure that the access log shows the indirect client
485 * instead of the direct client.
486 */
487 ConnStateData *conn = http->getConn();
488 conn->log_addr = request->indirect_client_addr;
489 }
490 request->x_forwarded_for_iterator.clean();
491 request->flags.done_follow_x_forwarded_for = 1;
492
493 if (answer != ACCESS_ALLOWED && answer != ACCESS_DENIED) {
494 debugs(28, DBG_CRITICAL, "ERROR: Processing X-Forwarded-For. Stopping at IP address: " << request->indirect_client_addr );
495 }
496
497 /* process actual access ACL as normal. */
498 calloutContext->clientAccessCheck();
499 }
500 #endif /* FOLLOW_X_FORWARDED_FOR */
501
502 /* This is the entry point for external users of the client_side routines */
503 void
504 ClientRequestContext::clientAccessCheck()
505 {
506 #if FOLLOW_X_FORWARDED_FOR
507 if (!http->request->flags.done_follow_x_forwarded_for &&
508 Config.accessList.followXFF &&
509 http->request->header.has(HDR_X_FORWARDED_FOR)) {
510
511 /* we always trust the direct client address for actual use */
512 http->request->indirect_client_addr = http->request->client_addr;
513 http->request->indirect_client_addr.SetPort(0);
514
515 /* setup the XFF iterator for processing */
516 http->request->x_forwarded_for_iterator = http->request->header.getList(HDR_X_FORWARDED_FOR);
517
518 /* begin by checking to see if we trust direct client enough to walk XFF */
519 acl_checklist = clientAclChecklistCreate(Config.accessList.followXFF, http);
520 acl_checklist->nonBlockingCheck(clientFollowXForwardedForCheck, this);
521 return;
522 }
523 #endif /* FOLLOW_X_FORWARDED_FOR */
524
525 if (Config.accessList.http) {
526 acl_checklist = clientAclChecklistCreate(Config.accessList.http, http);
527 acl_checklist->nonBlockingCheck(clientAccessCheckDoneWrapper, this);
528 } else {
529 debugs(0, DBG_CRITICAL, "No http_access configuration found. This will block ALL traffic");
530 clientAccessCheckDone(ACCESS_DENIED);
531 }
532 }
533
534 /**
535 * Identical in operation to clientAccessCheck() but performed later using different configured ACL list.
536 * The default here is to allow all. Since the earlier http_access should do a default deny all.
537 * This check is just for a last-minute denial based on adapted request headers.
538 */
539 void
540 ClientRequestContext::clientAccessCheck2()
541 {
542 if (Config.accessList.adapted_http) {
543 acl_checklist = clientAclChecklistCreate(Config.accessList.adapted_http, http);
544 acl_checklist->nonBlockingCheck(clientAccessCheckDoneWrapper, this);
545 } else {
546 debugs(85, 2, HERE << "No adapted_http_access configuration.");
547 clientAccessCheckDone(ACCESS_ALLOWED);
548 }
549 }
550
551 void
552 clientAccessCheckDoneWrapper(int answer, void *data)
553 {
554 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
555
556 if (!calloutContext->httpStateIsValid())
557 return;
558
559 calloutContext->clientAccessCheckDone(answer);
560 }
561
562 void
563 ClientRequestContext::clientAccessCheckDone(int answer)
564 {
565 acl_checklist = NULL;
566 err_type page_id;
567 http_status status;
568 debugs(85, 2, "The request " <<
569 RequestMethodStr(http->request->method) << " " <<
570 http->uri << " is " <<
571 (answer == ACCESS_ALLOWED ? "ALLOWED" : "DENIED") <<
572 ", because it matched '" <<
573 (AclMatchedName ? AclMatchedName : "NO ACL's") << "'" );
574 char const *proxy_auth_msg = "<null>";
575
576 if (http->getConn() != NULL && http->getConn()->auth_user_request != NULL)
577 proxy_auth_msg = http->getConn()->auth_user_request->denyMessage("<null>");
578 else if (http->request->auth_user_request != NULL)
579 proxy_auth_msg = http->request->auth_user_request->denyMessage("<null>");
580
581 if (answer != ACCESS_ALLOWED) {
582 /* Send an error */
583 int require_auth = (answer == ACCESS_REQ_PROXY_AUTH || aclIsProxyAuth(AclMatchedName));
584 debugs(85, 5, "Access Denied: " << http->uri);
585 debugs(85, 5, "AclMatchedName = " << (AclMatchedName ? AclMatchedName : "<null>"));
586
587 if (require_auth)
588 debugs(33, 5, "Proxy Auth Message = " << (proxy_auth_msg ? proxy_auth_msg : "<null>"));
589
590 /*
591 * NOTE: get page_id here, based on AclMatchedName because if
592 * USE_DELAY_POOLS is enabled, then AclMatchedName gets clobbered in
593 * the clientCreateStoreEntry() call just below. Pedro Ribeiro
594 * <pribeiro@isel.pt>
595 */
596 page_id = aclGetDenyInfoPage(&Config.denyInfoList, AclMatchedName, answer != ACCESS_REQ_PROXY_AUTH);
597
598 http->logType = LOG_TCP_DENIED;
599
600 if (require_auth) {
601 if (!http->flags.accel) {
602 /* Proxy authorisation needed */
603 status = HTTP_PROXY_AUTHENTICATION_REQUIRED;
604 } else {
605 /* WWW authorisation needed */
606 status = HTTP_UNAUTHORIZED;
607 }
608
609 if (page_id == ERR_NONE)
610 page_id = ERR_CACHE_ACCESS_DENIED;
611 } else {
612 status = HTTP_FORBIDDEN;
613
614 if (page_id == ERR_NONE)
615 page_id = ERR_ACCESS_DENIED;
616 }
617
618 clientStreamNode *node = (clientStreamNode *)http->client_stream.tail->prev->data;
619 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
620 assert (repContext);
621 Ip::Address tmpnoaddr;
622 tmpnoaddr.SetNoAddr();
623 repContext->setReplyToError(page_id, status,
624 http->request->method, NULL,
625 http->getConn() != NULL ? http->getConn()->peer : tmpnoaddr,
626 http->request,
627 NULL,
628 http->getConn() != NULL && http->getConn()->auth_user_request != NULL ?
629 http->getConn()->auth_user_request : http->request->auth_user_request);
630
631 node = (clientStreamNode *)http->client_stream.tail->data;
632 clientStreamRead(node, http, node->readBuffer);
633 return;
634 }
635
636 /* ACCESS_ALLOWED continues here ... */
637 safe_free(http->uri);
638
639 http->uri = xstrdup(urlCanonical(http->request));
640
641 http->doCallouts();
642 }
643
644 #if USE_ADAPTATION
645 static void
646 adaptationAclCheckDoneWrapper(Adaptation::ServiceGroupPointer g, void *data)
647 {
648 ClientRequestContext *calloutContext = (ClientRequestContext *)data;
649
650 if (!calloutContext->httpStateIsValid())
651 return;
652
653 calloutContext->adaptationAclCheckDone(g);
654 }
655
656 void
657 ClientRequestContext::adaptationAclCheckDone(Adaptation::ServiceGroupPointer g)
658 {
659 debugs(93,3,HERE << this << " adaptationAclCheckDone called");
660 assert(http);
661
662 #if ICAP_CLIENT
663 Adaptation::Icap::History::Pointer ih = http->request->icapHistory();
664 if (ih != NULL) {
665 if (http->getConn() != NULL) {
666 ih->rfc931 = http->getConn()->rfc931;
667 #if USE_SSL
668 ih->ssluser = sslGetUserEmail(fd_table[http->getConn()->fd].ssl);
669 #endif
670 }
671 ih->log_uri = http->log_uri;
672 ih->req_sz = http->req_sz;
673 }
674 #endif
675
676 if (!g) {
677 debugs(85,3, HERE << "no adaptation needed");
678 http->doCallouts();
679 return;
680 }
681
682 http->startAdaptation(g);
683 }
684
685 #endif
686
687 static void
688 clientRedirectAccessCheckDone(int answer, void *data)
689 {
690 ClientRequestContext *context = (ClientRequestContext *)data;
691 ClientHttpRequest *http = context->http;
692 context->acl_checklist = NULL;
693
694 if (answer == ACCESS_ALLOWED)
695 redirectStart(http, clientRedirectDoneWrapper, context);
696 else
697 context->clientRedirectDone(NULL);
698 }
699
700 void
701 ClientRequestContext::clientRedirectStart()
702 {
703 debugs(33, 5, "clientRedirectStart: '" << http->uri << "'");
704
705 if (Config.accessList.redirector) {
706 acl_checklist = clientAclChecklistCreate(Config.accessList.redirector, http);
707 acl_checklist->nonBlockingCheck(clientRedirectAccessCheckDone, this);
708 } else
709 redirectStart(http, clientRedirectDoneWrapper, this);
710 }
711
712 static int
713 clientHierarchical(ClientHttpRequest * http)
714 {
715 const char *url = http->uri;
716 HttpRequest *request = http->request;
717 HttpRequestMethod method = request->method;
718 const wordlist *p = NULL;
719
720 /*
721 * IMS needs a private key, so we can use the hierarchy for IMS only if our
722 * neighbors support private keys
723 */
724
725 if (request->flags.ims && !neighbors_do_private_keys)
726 return 0;
727
728 /*
729 * This is incorrect: authenticating requests can be sent via a hierarchy
730 * (they can even be cached if the correct headers are set on the reply)
731 */
732 if (request->flags.auth)
733 return 0;
734
735 if (method == METHOD_TRACE)
736 return 1;
737
738 if (method != METHOD_GET)
739 return 0;
740
741 /* scan hierarchy_stoplist */
742 for (p = Config.hierarchy_stoplist; p; p = p->next)
743 if (strstr(url, p->key))
744 return 0;
745
746 if (request->flags.loopdetect)
747 return 0;
748
749 if (request->protocol == PROTO_HTTP)
750 return httpCachable(method);
751
752 if (request->protocol == PROTO_GOPHER)
753 return gopherCachable(request);
754
755 if (request->protocol == PROTO_CACHEOBJ)
756 return 0;
757
758 return 1;
759 }
760
761
762 static void
763 clientCheckPinning(ClientHttpRequest * http)
764 {
765 HttpRequest *request = http->request;
766 HttpHeader *req_hdr = &request->header;
767 ConnStateData *http_conn = http->getConn();
768
769 /* Internal requests such as those from ESI includes may be without
770 * a client connection
771 */
772 if (!http_conn)
773 return;
774
775 request->flags.connection_auth_disabled = http_conn->port->connection_auth_disabled;
776 if (!request->flags.connection_auth_disabled) {
777 if (http_conn->pinning.fd != -1) {
778 if (http_conn->pinning.auth) {
779 request->flags.connection_auth = 1;
780 request->flags.auth = 1;
781 } else {
782 request->flags.connection_proxy_auth = 1;
783 }
784 request->setPinnedConnection(http_conn);
785 }
786 }
787
788 /* check if connection auth is used, and flag as candidate for pinning
789 * in such case.
790 * Note: we may need to set flags.connection_auth even if the connection
791 * is already pinned if it was pinned earlier due to proxy auth
792 */
793 if (!request->flags.connection_auth) {
794 if (req_hdr->has(HDR_AUTHORIZATION) || req_hdr->has(HDR_PROXY_AUTHORIZATION)) {
795 HttpHeaderPos pos = HttpHeaderInitPos;
796 HttpHeaderEntry *e;
797 int may_pin = 0;
798 while ((e = req_hdr->getEntry(&pos))) {
799 if (e->id == HDR_AUTHORIZATION || e->id == HDR_PROXY_AUTHORIZATION) {
800 const char *value = e->value.rawBuf();
801 if (strncasecmp(value, "NTLM ", 5) == 0
802 ||
803 strncasecmp(value, "Negotiate ", 10) == 0
804 ||
805 strncasecmp(value, "Kerberos ", 9) == 0) {
806 if (e->id == HDR_AUTHORIZATION) {
807 request->flags.connection_auth = 1;
808 may_pin = 1;
809 } else {
810 request->flags.connection_proxy_auth = 1;
811 may_pin = 1;
812 }
813 }
814 }
815 }
816 if (may_pin && !request->pinnedConnection()) {
817 request->setPinnedConnection(http->getConn());
818 }
819 }
820 }
821 }
822
823 static void
824 clientInterpretRequestHeaders(ClientHttpRequest * http)
825 {
826 HttpRequest *request = http->request;
827 HttpHeader *req_hdr = &request->header;
828 int no_cache = 0;
829 const char *str;
830
831 request->imslen = -1;
832 request->ims = req_hdr->getTime(HDR_IF_MODIFIED_SINCE);
833
834 if (request->ims > 0)
835 request->flags.ims = 1;
836
837 if (!request->flags.ignore_cc) {
838 if (req_hdr->has(HDR_PRAGMA)) {
839 String s = req_hdr->getList(HDR_PRAGMA);
840
841 if (strListIsMember(&s, "no-cache", ','))
842 no_cache++;
843
844 s.clean();
845 }
846
847 if (request->cache_control)
848 if (EBIT_TEST(request->cache_control->mask, CC_NO_CACHE))
849 no_cache++;
850
851 /*
852 * Work around for supporting the Reload button in IE browsers when Squid
853 * is used as an accelerator or transparent proxy, by turning accelerated
854 * IMS request to no-cache requests. Now knows about IE 5.5 fix (is
855 * actually only fixed in SP1, but we can't tell whether we are talking to
856 * SP1 or not so all 5.5 versions are treated 'normally').
857 */
858 if (Config.onoff.ie_refresh) {
859 if (http->flags.accel && request->flags.ims) {
860 if ((str = req_hdr->getStr(HDR_USER_AGENT))) {
861 if (strstr(str, "MSIE 5.01") != NULL)
862 no_cache++;
863 else if (strstr(str, "MSIE 5.0") != NULL)
864 no_cache++;
865 else if (strstr(str, "MSIE 4.") != NULL)
866 no_cache++;
867 else if (strstr(str, "MSIE 3.") != NULL)
868 no_cache++;
869 }
870 }
871 }
872 }
873
874 if (request->method == METHOD_OTHER) {
875 no_cache++;
876 }
877
878 if (no_cache) {
879 #if USE_HTTP_VIOLATIONS
880
881 if (Config.onoff.reload_into_ims)
882 request->flags.nocache_hack = 1;
883 else if (refresh_nocache_hack)
884 request->flags.nocache_hack = 1;
885 else
886 #endif
887
888 request->flags.nocache = 1;
889 }
890
891 /* ignore range header in non-GETs or non-HEADs */
892 if (request->method == METHOD_GET || request->method == METHOD_HEAD) {
893 // XXX: initialize if we got here without HttpRequest::parseHeader()
894 if (!request->range)
895 request->range = req_hdr->getRange();
896
897 if (request->range) {
898 request->flags.range = 1;
899 clientStreamNode *node = (clientStreamNode *)http->client_stream.tail->data;
900 /* XXX: This is suboptimal. We should give the stream the range set,
901 * and thereby let the top of the stream set the offset when the
902 * size becomes known. As it is, we will end up requesting from 0
903 * for evey -X range specification.
904 * RBC - this may be somewhat wrong. We should probably set the range
905 * iter up at this point.
906 */
907 node->readBuffer.offset = request->range->lowestOffset(0);
908 http->range_iter.pos = request->range->begin();
909 http->range_iter.valid = true;
910 }
911 }
912
913 /* Only HEAD and GET requests permit a Range or Request-Range header.
914 * If these headers appear on any other type of request, delete them now.
915 */
916 else {
917 req_hdr->delById(HDR_RANGE);
918 req_hdr->delById(HDR_REQUEST_RANGE);
919 delete request->range;
920 request->range = NULL;
921 }
922
923 if (req_hdr->has(HDR_AUTHORIZATION))
924 request->flags.auth = 1;
925
926 clientCheckPinning(http);
927
928 if (request->login[0] != '\0')
929 request->flags.auth = 1;
930
931 if (req_hdr->has(HDR_VIA)) {
932 String s = req_hdr->getList(HDR_VIA);
933 /*
934 * ThisCache cannot be a member of Via header, "1.0 ThisCache" can.
935 * Note ThisCache2 has a space prepended to the hostname so we don't
936 * accidentally match super-domains.
937 */
938
939 if (strListIsSubstr(&s, ThisCache2, ',')) {
940 debugObj(33, 1, "WARNING: Forwarding loop detected for:\n",
941 request, (ObjPackMethod) & httpRequestPack);
942 request->flags.loopdetect = 1;
943 }
944
945 #if USE_FORW_VIA_DB
946 fvdbCountVia(s.termedBuf());
947
948 #endif
949
950 s.clean();
951 }
952
953 /**
954 \todo --enable-useragent-log and --enable-referer-log. We should
955 probably drop those two as the custom log formats accomplish pretty much the same thing..
956 */
957 #if USE_USERAGENT_LOG
958 if ((str = req_hdr->getStr(HDR_USER_AGENT)))
959 logUserAgent(fqdnFromAddr(http->getConn()->log_addr), str);
960
961 #endif
962 #if USE_REFERER_LOG
963
964 if ((str = req_hdr->getStr(HDR_REFERER)))
965 logReferer(fqdnFromAddr(http->getConn()->log_addr), str, http->log_uri);
966
967 #endif
968 #if USE_FORW_VIA_DB
969
970 if (req_hdr->has(HDR_X_FORWARDED_FOR)) {
971 String s = req_hdr->getList(HDR_X_FORWARDED_FOR);
972 fvdbCountForw(s.termedBuf());
973 s.clean();
974 }
975
976 #endif
977
978 request->flags.cachable = http->request->cacheable();
979
980 if (clientHierarchical(http))
981 request->flags.hierarchical = 1;
982
983 debugs(85, 5, "clientInterpretRequestHeaders: REQ_NOCACHE = " <<
984 (request->flags.nocache ? "SET" : "NOT SET"));
985 debugs(85, 5, "clientInterpretRequestHeaders: REQ_CACHABLE = " <<
986 (request->flags.cachable ? "SET" : "NOT SET"));
987 debugs(85, 5, "clientInterpretRequestHeaders: REQ_HIERARCHICAL = " <<
988 (request->flags.hierarchical ? "SET" : "NOT SET"));
989
990 }
991
992 void
993 clientRedirectDoneWrapper(void *data, char *result)
994 {
995 ClientRequestContext *calloutContext = (ClientRequestContext *)data;
996
997 if (!calloutContext->httpStateIsValid())
998 return;
999
1000 calloutContext->clientRedirectDone(result);
1001 }
1002
1003 void
1004 ClientRequestContext::clientRedirectDone(char *result)
1005 {
1006 HttpRequest *new_request = NULL;
1007 HttpRequest *old_request = http->request;
1008 debugs(85, 5, "clientRedirectDone: '" << http->uri << "' result=" << (result ? result : "NULL"));
1009 assert(redirect_state == REDIRECT_PENDING);
1010 redirect_state = REDIRECT_DONE;
1011
1012 if (result) {
1013 http_status status = (http_status) atoi(result);
1014
1015 if (status == HTTP_MOVED_PERMANENTLY
1016 || status == HTTP_MOVED_TEMPORARILY
1017 || status == HTTP_SEE_OTHER
1018 || status == HTTP_TEMPORARY_REDIRECT) {
1019 char *t = result;
1020
1021 if ((t = strchr(result, ':')) != NULL) {
1022 http->redirect.status = status;
1023 http->redirect.location = xstrdup(t + 1);
1024 // TODO: validate the URL produced here is RFC 2616 compliant absolute URI
1025 } else {
1026 if (old_request->http_ver < HttpVersion(1,1))
1027 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid 302 redirect Location: " << result);
1028 else
1029 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid 303 redirect Location: " << result);
1030 }
1031 } else if (strcmp(result, http->uri)) {
1032 if (!(new_request = HttpRequest::CreateFromUrlAndMethod(result, old_request->method)))
1033 debugs(85, DBG_CRITICAL, "ERROR: URL-rewrite produces invalid request: " <<
1034 old_request->method << " " << result << " HTTP/1.1");
1035 }
1036 }
1037
1038 if (new_request) {
1039 safe_free(http->uri);
1040 http->uri = xstrdup(urlCanonical(new_request));
1041 new_request->http_ver = old_request->http_ver;
1042 new_request->header.append(&old_request->header);
1043 new_request->client_addr = old_request->client_addr;
1044 #if FOLLOW_X_FORWARDED_FOR
1045 new_request->indirect_client_addr = old_request->indirect_client_addr;
1046 #endif /* FOLLOW_X_FORWARDED_FOR */
1047 new_request->my_addr = old_request->my_addr;
1048 new_request->flags = old_request->flags;
1049 new_request->flags.redirected = 1;
1050 new_request->auth_user_request = old_request->auth_user_request;
1051
1052 if (old_request->body_pipe != NULL) {
1053 new_request->body_pipe = old_request->body_pipe;
1054 old_request->body_pipe = NULL;
1055 debugs(0,0,HERE << "redirecting body_pipe " << new_request->body_pipe << " from request " << old_request << " to " << new_request);
1056 }
1057
1058 new_request->content_length = old_request->content_length;
1059 new_request->extacl_user = old_request->extacl_user;
1060 new_request->extacl_passwd = old_request->extacl_passwd;
1061 new_request->flags.proxy_keepalive = old_request->flags.proxy_keepalive;
1062 HTTPMSGUNLOCK(old_request);
1063 http->request = HTTPMSGLOCK(new_request);
1064 }
1065
1066 /* FIXME PIPELINE: This is innacurate during pipelining */
1067
1068 if (http->getConn() != NULL)
1069 fd_note(http->getConn()->fd, http->uri);
1070
1071 assert(http->uri);
1072
1073 http->doCallouts();
1074 }
1075
1076 /** Test cache allow/deny configuration
1077 * Sets flags.cachable=1 if caching is not denied.
1078 */
1079 void
1080 ClientRequestContext::checkNoCache()
1081 {
1082 if (Config.accessList.noCache) {
1083 acl_checklist = clientAclChecklistCreate(Config.accessList.noCache, http);
1084 acl_checklist->nonBlockingCheck(checkNoCacheDoneWrapper, this);
1085 } else {
1086 /* unless otherwise specified, we try to cache. */
1087 checkNoCacheDone(1);
1088 }
1089 }
1090
1091 static void
1092 checkNoCacheDoneWrapper(int answer, void *data)
1093 {
1094 ClientRequestContext *calloutContext = (ClientRequestContext *) data;
1095
1096 if (!calloutContext->httpStateIsValid())
1097 return;
1098
1099 calloutContext->checkNoCacheDone(answer);
1100 }
1101
1102 void
1103 ClientRequestContext::checkNoCacheDone(int answer)
1104 {
1105 acl_checklist = NULL;
1106 http->request->flags.cachable = answer;
1107 http->doCallouts();
1108 }
1109
1110 /*
1111 * Identify requests that do not go through the store and client side stream
1112 * and forward them to the appropriate location. All other requests, request
1113 * them.
1114 */
1115 void
1116 ClientHttpRequest::processRequest()
1117 {
1118 debugs(85, 4, "clientProcessRequest: " << RequestMethodStr(request->method) << " '" << uri << "'");
1119
1120 #if USE_SSL
1121 if (request->method == METHOD_CONNECT && sslBumpNeeded()) {
1122 sslBumpStart();
1123 return;
1124 }
1125 #endif
1126
1127 if (request->method == METHOD_CONNECT && !redirect.status) {
1128 logType = LOG_TCP_MISS;
1129 getConn()->stopReading(); // tunnels read for themselves
1130 tunnelStart(this, &out.size, &al.http.code);
1131 return;
1132 }
1133
1134 httpStart();
1135 }
1136
1137 void
1138 ClientHttpRequest::httpStart()
1139 {
1140 PROF_start(httpStart);
1141 logType = LOG_TAG_NONE;
1142 debugs(85, 4, "ClientHttpRequest::httpStart: " << log_tags[logType] << " for '" << uri << "'");
1143
1144 /* no one should have touched this */
1145 assert(out.offset == 0);
1146 /* Use the Stream Luke */
1147 clientStreamNode *node = (clientStreamNode *)client_stream.tail->data;
1148 clientStreamRead(node, this, node->readBuffer);
1149 PROF_stop(httpStart);
1150 }
1151
1152 #if USE_SSL
1153
1154 // determines whether we should bump the CONNECT request
1155 bool
1156 ClientHttpRequest::sslBumpNeeded() const
1157 {
1158 if (!getConn()->port->sslBump || !Config.accessList.ssl_bump)
1159 return false;
1160
1161 debugs(85, 5, HERE << "SslBump possible, checking ACL");
1162
1163 ACLFilledChecklist check(Config.accessList.ssl_bump, request, NULL);
1164 check.src_addr = request->client_addr;
1165 check.my_addr = request->my_addr;
1166 return check.fastCheck() == 1;
1167 }
1168
1169 // called when comm_write has completed
1170 static void
1171 SslBumpEstablish(int, char *, size_t, comm_err_t errflag, int, void *data)
1172 {
1173 ClientHttpRequest *r = static_cast<ClientHttpRequest*>(data);
1174 debugs(85, 5, HERE << "responded to CONNECT: " << r << " ? " << errflag);
1175
1176 assert(r && cbdataReferenceValid(r));
1177 r->sslBumpEstablish(errflag);
1178 }
1179
1180 void
1181 ClientHttpRequest::sslBumpEstablish(comm_err_t errflag)
1182 {
1183 // Bail out quickly on COMM_ERR_CLOSING - close handlers will tidy up
1184 if (errflag == COMM_ERR_CLOSING)
1185 return;
1186
1187 if (errflag) {
1188 getConn()->startClosing("CONNECT response failure in SslBump");
1189 return;
1190 }
1191
1192 getConn()->switchToHttps();
1193 }
1194
1195 void
1196 ClientHttpRequest::sslBumpStart()
1197 {
1198 debugs(85, 5, HERE << "ClientHttpRequest::sslBumpStart");
1199
1200 // send an HTTP 200 response to kick client SSL negotiation
1201 const int fd = getConn()->fd;
1202 debugs(33, 7, HERE << "Confirming CONNECT tunnel on FD " << fd);
1203
1204 // TODO: Unify with tunnel.cc and add a Server(?) header
1205 static const char *const conn_established =
1206 "HTTP/1.0 200 Connection established\r\n\r\n";
1207 comm_write(fd, conn_established, strlen(conn_established),
1208 &SslBumpEstablish, this, NULL);
1209 }
1210
1211 #endif
1212
1213 bool
1214 ClientHttpRequest::gotEnough() const
1215 {
1216 /** TODO: should be querying the stream. */
1217 int64_t contentLength =
1218 memObject()->getReply()->bodySize(request->method);
1219 assert(contentLength >= 0);
1220
1221 if (out.offset < contentLength)
1222 return false;
1223
1224 return true;
1225 }
1226
1227 void
1228 ClientHttpRequest::storeEntry(StoreEntry *newEntry)
1229 {
1230 entry_ = newEntry;
1231 }
1232
1233 void
1234 ClientHttpRequest::loggingEntry(StoreEntry *newEntry)
1235 {
1236 if (loggingEntry_)
1237 loggingEntry_->unlock();
1238
1239 loggingEntry_ = newEntry;
1240
1241 if (loggingEntry_)
1242 loggingEntry_->lock();
1243 }
1244
1245 /*
1246 * doCallouts() - This function controls the order of "callout"
1247 * executions, including non-blocking access control checks, the
1248 * redirector, and ICAP. Previously, these callouts were chained
1249 * together such that "clientAccessCheckDone()" would call
1250 * "clientRedirectStart()" and so on.
1251 *
1252 * The ClientRequestContext (aka calloutContext) class holds certain
1253 * state data for the callout/callback operations. Previously
1254 * ClientHttpRequest would sort of hand off control to ClientRequestContext
1255 * for a short time. ClientRequestContext would then delete itself
1256 * and pass control back to ClientHttpRequest when all callouts
1257 * were finished.
1258 *
1259 * This caused some problems for ICAP because we want to make the
1260 * ICAP callout after checking ACLs, but before checking the no_cache
1261 * list. We can't stuff the ICAP state into the ClientRequestContext
1262 * class because we still need the ICAP state after ClientRequestContext
1263 * goes away.
1264 *
1265 * Note that ClientRequestContext is created before the first call
1266 * to doCallouts().
1267 *
1268 * If one of the callouts notices that ClientHttpRequest is no
1269 * longer valid, it should call cbdataReferenceDone() so that
1270 * ClientHttpRequest's reference count goes to zero and it will get
1271 * deleted. ClientHttpRequest will then delete ClientRequestContext.
1272 *
1273 * Note that we set the _done flags here before actually starting
1274 * the callout. This is strictly for convenience.
1275 */
1276
1277 extern tos_t aclMapTOS (acl_tos * head, ACLChecklist * ch);
1278 extern nfmark_t aclMapNfmark (acl_nfmark * head, ACLChecklist * ch);
1279
1280 void
1281 ClientHttpRequest::doCallouts()
1282 {
1283 assert(calloutContext);
1284
1285 /*Save the original request for logging purposes*/
1286 if (!calloutContext->http->al.request)
1287 calloutContext->http->al.request = HTTPMSGLOCK(request);
1288
1289 if (!calloutContext->http_access_done) {
1290 debugs(83, 3, HERE << "Doing calloutContext->clientAccessCheck()");
1291 calloutContext->http_access_done = true;
1292 calloutContext->clientAccessCheck();
1293 return;
1294 }
1295
1296 #if USE_ADAPTATION
1297 if (!calloutContext->adaptation_acl_check_done) {
1298 calloutContext->adaptation_acl_check_done = true;
1299 if (Adaptation::AccessCheck::Start(
1300 Adaptation::methodReqmod, Adaptation::pointPreCache,
1301 request, NULL, adaptationAclCheckDoneWrapper, calloutContext))
1302 return; // will call callback
1303 }
1304 #endif
1305
1306 if (!calloutContext->redirect_done) {
1307 calloutContext->redirect_done = true;
1308 assert(calloutContext->redirect_state == REDIRECT_NONE);
1309
1310 if (Config.Program.redirect) {
1311 debugs(83, 3, HERE << "Doing calloutContext->clientRedirectStart()");
1312 calloutContext->redirect_state = REDIRECT_PENDING;
1313 calloutContext->clientRedirectStart();
1314 return;
1315 }
1316 }
1317
1318 if (!calloutContext->adapted_http_access_done) {
1319 debugs(83, 3, HERE << "Doing calloutContext->clientAccessCheck2()");
1320 calloutContext->adapted_http_access_done = true;
1321 calloutContext->clientAccessCheck2();
1322 return;
1323 }
1324
1325 if (!calloutContext->interpreted_req_hdrs) {
1326 debugs(83, 3, HERE << "Doing clientInterpretRequestHeaders()");
1327 calloutContext->interpreted_req_hdrs = 1;
1328 clientInterpretRequestHeaders(this);
1329 }
1330
1331 if (!calloutContext->no_cache_done) {
1332 calloutContext->no_cache_done = true;
1333
1334 if (Config.accessList.noCache && request->flags.cachable) {
1335 debugs(83, 3, HERE << "Doing calloutContext->checkNoCache()");
1336 calloutContext->checkNoCache();
1337 return;
1338 }
1339 }
1340
1341 if (!calloutContext->tosToClientDone) {
1342 calloutContext->tosToClientDone = true;
1343 if (getConn() != NULL) {
1344 ACLFilledChecklist ch(NULL, request, NULL);
1345 ch.src_addr = request->client_addr;
1346 ch.my_addr = request->my_addr;
1347 tos_t tos = aclMapTOS(Ip::Qos::TheConfig.tosToClient, &ch);
1348 if (tos)
1349 Ip::Qos::setSockTos(getConn()->fd, tos);
1350 }
1351 }
1352
1353 if (!calloutContext->nfmarkToClientDone) {
1354 calloutContext->nfmarkToClientDone = true;
1355 if (getConn() != NULL) {
1356 ACLFilledChecklist ch(NULL, request, NULL);
1357 ch.src_addr = request->client_addr;
1358 ch.my_addr = request->my_addr;
1359 nfmark_t mark = aclMapNfmark(Ip::Qos::TheConfig.nfmarkToClient, &ch);
1360 if (mark)
1361 Ip::Qos::setSockNfmark(getConn()->fd, mark);
1362 }
1363 }
1364
1365 cbdataReferenceDone(calloutContext->http);
1366 delete calloutContext;
1367 calloutContext = NULL;
1368 #if HEADERS_LOG
1369
1370 headersLog(0, 1, request->method, request);
1371 #endif
1372
1373 debugs(83, 3, HERE << "calling processRequest()");
1374 processRequest();
1375
1376 #if ICAP_CLIENT
1377 Adaptation::Icap::History::Pointer ih = request->icapHistory();
1378 if (ih != NULL)
1379 ih->logType = logType;
1380 #endif
1381 }
1382
1383 #if !_USE_INLINE_
1384 #include "client_side_request.cci"
1385 #endif
1386
1387 #if USE_ADAPTATION
1388 /// Initiate an asynchronous adaptation transaction which will call us back.
1389 void
1390 ClientHttpRequest::startAdaptation(const Adaptation::ServiceGroupPointer &g)
1391 {
1392 debugs(85, 3, HERE << "adaptation needed for " << this);
1393 assert(!virginHeadSource);
1394 assert(!adaptedBodySource);
1395 virginHeadSource = initiateAdaptation(
1396 new Adaptation::Iterator(request, NULL, g));
1397
1398 // we could try to guess whether we can bypass this adaptation
1399 // initiation failure, but it should not really happen
1400 Must(initiated(virginHeadSource));
1401 }
1402
1403 void
1404 ClientHttpRequest::noteAdaptationAnswer(HttpMsg *msg)
1405 {
1406 assert(cbdataReferenceValid(this)); // indicates bug
1407 assert(msg);
1408
1409 if (HttpRequest *new_req = dynamic_cast<HttpRequest*>(msg)) {
1410 /*
1411 * Replace the old request with the new request.
1412 */
1413 HTTPMSGUNLOCK(request);
1414 request = HTTPMSGLOCK(new_req);
1415 /*
1416 * Store the new URI for logging
1417 */
1418 xfree(uri);
1419 uri = xstrdup(urlCanonical(request));
1420 setLogUri(this, urlCanonicalClean(request));
1421 assert(request->method.id());
1422 } else if (HttpReply *new_rep = dynamic_cast<HttpReply*>(msg)) {
1423 debugs(85,3,HERE << "REQMOD reply is HTTP reply");
1424
1425 // subscribe to receive reply body
1426 if (new_rep->body_pipe != NULL) {
1427 adaptedBodySource = new_rep->body_pipe;
1428 int consumer_ok = adaptedBodySource->setConsumerIfNotLate(this);
1429 assert(consumer_ok);
1430 }
1431
1432 clientStreamNode *node = (clientStreamNode *)client_stream.tail->prev->data;
1433 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1434 repContext->createStoreEntry(request->method, request->flags);
1435
1436 EBIT_CLR(storeEntry()->flags, ENTRY_FWD_HDR_WAIT);
1437 request_satisfaction_mode = true;
1438 request_satisfaction_offset = 0;
1439 storeEntry()->replaceHttpReply(new_rep);
1440 storeEntry()->timestampsSet();
1441
1442 if (!adaptedBodySource) // no body
1443 storeEntry()->complete();
1444 clientGetMoreData(node, this);
1445 }
1446
1447 // we are done with getting headers (but may be receiving body)
1448 clearAdaptation(virginHeadSource);
1449
1450 if (!request_satisfaction_mode)
1451 doCallouts();
1452 }
1453
1454 void
1455 ClientHttpRequest::noteAdaptationQueryAbort(bool final)
1456 {
1457 clearAdaptation(virginHeadSource);
1458 assert(!adaptedBodySource);
1459 handleAdaptationFailure(ERR_DETAIL_ICAP_REQMOD_ABORT, !final);
1460 }
1461
1462 void
1463 ClientHttpRequest::noteMoreBodyDataAvailable(BodyPipe::Pointer)
1464 {
1465 assert(request_satisfaction_mode);
1466 assert(adaptedBodySource != NULL);
1467
1468 if (const size_t contentSize = adaptedBodySource->buf().contentSize()) {
1469 BodyPipeCheckout bpc(*adaptedBodySource);
1470 const StoreIOBuffer ioBuf(&bpc.buf, request_satisfaction_offset);
1471 storeEntry()->write(ioBuf);
1472 // assume can write everything
1473 request_satisfaction_offset += contentSize;
1474 bpc.buf.consume(contentSize);
1475 bpc.checkIn();
1476 }
1477
1478 if (adaptedBodySource->exhausted())
1479 endRequestSatisfaction();
1480 // else wait for more body data
1481 }
1482
1483 void
1484 ClientHttpRequest::noteBodyProductionEnded(BodyPipe::Pointer)
1485 {
1486 assert(!virginHeadSource);
1487 if (adaptedBodySource != NULL) { // did not end request satisfaction yet
1488 // We do not expect more because noteMoreBodyDataAvailable always
1489 // consumes everything. We do not even have a mechanism to consume
1490 // leftovers after noteMoreBodyDataAvailable notifications seize.
1491 assert(adaptedBodySource->exhausted());
1492 endRequestSatisfaction();
1493 }
1494 }
1495
1496 void
1497 ClientHttpRequest::endRequestSatisfaction()
1498 {
1499 debugs(85,4, HERE << this << " ends request satisfaction");
1500 assert(request_satisfaction_mode);
1501 stopConsumingFrom(adaptedBodySource);
1502
1503 // TODO: anything else needed to end store entry formation correctly?
1504 storeEntry()->complete();
1505 }
1506
1507 void
1508 ClientHttpRequest::noteBodyProducerAborted(BodyPipe::Pointer)
1509 {
1510 assert(!virginHeadSource);
1511 stopConsumingFrom(adaptedBodySource);
1512 handleAdaptationFailure(ERR_DETAIL_ICAP_RESPMOD_CLT_SIDE_BODY);
1513 }
1514
1515 void
1516 ClientHttpRequest::handleAdaptationFailure(int errDetail, bool bypassable)
1517 {
1518 debugs(85,3, HERE << "handleAdaptationFailure(" << bypassable << ")");
1519
1520 const bool usedStore = storeEntry() && !storeEntry()->isEmpty();
1521 const bool usedPipe = request->body_pipe != NULL &&
1522 request->body_pipe->consumedSize() > 0;
1523
1524 if (bypassable && !usedStore && !usedPipe) {
1525 debugs(85,3, HERE << "ICAP REQMOD callout failed, bypassing: " << calloutContext);
1526 if (calloutContext)
1527 doCallouts();
1528 return;
1529 }
1530
1531 debugs(85,3, HERE << "ICAP REQMOD callout failed, responding with error");
1532
1533 clientStreamNode *node = (clientStreamNode *)client_stream.tail->prev->data;
1534 clientReplyContext *repContext = dynamic_cast<clientReplyContext *>(node->data.getRaw());
1535 assert(repContext);
1536
1537 // The original author of the code also wanted to pass an errno to
1538 // setReplyToError, but it seems unlikely that the errno reflects the
1539 // true cause of the error at this point, so I did not pass it.
1540 Ip::Address noAddr;
1541 noAddr.SetNoAddr();
1542 ConnStateData * c = getConn();
1543 repContext->setReplyToError(ERR_ICAP_FAILURE, HTTP_INTERNAL_SERVER_ERROR,
1544 request->method, NULL,
1545 (c != NULL ? c->peer : noAddr), request, NULL,
1546 (c != NULL && c->auth_user_request != NULL ?
1547 c->auth_user_request : request->auth_user_request));
1548
1549 request->detailError(ERR_ICAP_FAILURE, errDetail);
1550
1551 node = (clientStreamNode *)client_stream.tail->data;
1552 clientStreamRead(node, this, node->readBuffer);
1553 }
1554
1555 #endif