src/Server.cc

   1 /*
   2  * $Id$
   3  *
   4  * DEBUG:
   5  * AUTHOR: Duane Wessels
   6  *
   7  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   8  * ----------------------------------------------------------
   9  *
  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.
  18  *
  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.
  23  *
  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.
  28  *
  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.
  32  *
  33  */
  34
  35 #include "squid.h"
  36 #include "base/TextException.h"
  37 #include "comm/Connection.h"
  38 #include "comm/forward.h"
  39 #include "Server.h"
  40 #include "Store.h"
  41 //#include "fde.h" /* for fd_table[fd].closing */
  42 #include "HttpRequest.h"
  43 #include "HttpReply.h"
  44 #include "errorpage.h"
  45 #include "SquidTime.h"
  46
  47 #if USE_ADAPTATION
  48 #include "adaptation/AccessCheck.h"
  49 #include "adaptation/Iterator.h"
  50 #endif
  51
  52 // implemented in client_side_reply.cc until sides have a common parent
  53 extern void purgeEntriesByUrl(HttpRequest * req, const char *url);
  54
  55
  56 ServerStateData::ServerStateData(FwdState *theFwdState): AsyncJob("ServerStateData"),
  57         requestSender(NULL),
  58 #if USE_ADAPTATION
  59         adaptedHeadSource(NULL),
  60         adaptationAccessCheckPending(false),
  61         startedAdaptation(false),
  62 #endif
  63         receivedWholeRequestBody(false)
  64 {
  65     fwd = theFwdState;
  66     entry = fwd->entry;
  67
  68     entry->lock();
  69
  70     request = HTTPMSGLOCK(fwd->request);
  71 }
  72
  73 ServerStateData::~ServerStateData()
  74 {
  75     // paranoid: check that swanSong has been called
  76     assert(!requestBodySource);
  77 #if USE_ADAPTATION
  78     assert(!virginBodyDestination);
  79     assert(!adaptedBodySource);
  80 #endif
  81
  82     entry->unlock();
  83
  84     HTTPMSGUNLOCK(request);
  85     HTTPMSGUNLOCK(theVirginReply);
  86     HTTPMSGUNLOCK(theFinalReply);
  87
  88     fwd = NULL; // refcounted
  89
  90     if (responseBodyBuffer != NULL) {
  91         delete responseBodyBuffer;
  92         responseBodyBuffer = NULL;
  93     }
  94 }
  95
  96 void
  97 ServerStateData::swanSong()
  98 {
  99     // get rid of our piping obligations
 100     if (requestBodySource != NULL)
 101         stopConsumingFrom(requestBodySource);
 102
 103 #if USE_ADAPTATION
 104     cleanAdaptation();
 105 #endif
 106
 107     BodyConsumer::swanSong();
 108 #if USE_ADAPTATION
 109     Initiator::swanSong();
 110     BodyProducer::swanSong();
 111 #endif
 112
 113     // paranoid: check that swanSong has been called
 114     // extra paranoid: yeah, I really mean it. they MUST pass here.
 115     assert(!requestBodySource);
 116 #if USE_ADAPTATION
 117     assert(!virginBodyDestination);
 118     assert(!adaptedBodySource);
 119 #endif
 120 }
 121
 122
 123 HttpReply *
 124 ServerStateData::virginReply()
 125 {
 126     assert(theVirginReply);
 127     return theVirginReply;
 128 }
 129
 130 const HttpReply *
 131 ServerStateData::virginReply() const
 132 {
 133     assert(theVirginReply);
 134     return theVirginReply;
 135 }
 136
 137 HttpReply *
 138 ServerStateData::setVirginReply(HttpReply *rep)
 139 {
 140     debugs(11,5, HERE << this << " setting virgin reply to " << rep);
 141     assert(!theVirginReply);
 142     assert(rep);
 143     theVirginReply = HTTPMSGLOCK(rep);
 144     return theVirginReply;
 145 }
 146
 147 HttpReply *
 148 ServerStateData::finalReply()
 149 {
 150     assert(theFinalReply);
 151     return theFinalReply;
 152 }
 153
 154 HttpReply *
 155 ServerStateData::setFinalReply(HttpReply *rep)
 156 {
 157     debugs(11,5, HERE << this << " setting final reply to " << rep);
 158
 159     assert(!theFinalReply);
 160     assert(rep);
 161     theFinalReply = HTTPMSGLOCK(rep);
 162
 163     entry->replaceHttpReply(theFinalReply);
 164     haveParsedReplyHeaders();
 165
 166     return theFinalReply;
 167 }
 168
 169 // called when no more server communication is expected; may quit
 170 void
 171 ServerStateData::serverComplete()
 172 {
 173     debugs(11,5,HERE << "serverComplete " << this);
 174
 175     if (!doneWithServer()) {
 176         closeServer();
 177         assert(doneWithServer());
 178     }
 179
 180     completed = true;
 181
 182     HttpRequest *r = originalRequest();
 183     r->hier.total_response_time = r->hier.first_conn_start.tv_sec ?
 184                                   tvSubMsec(r->hier.first_conn_start, current_time) : -1;
 185
 186     if (requestBodySource != NULL)
 187         stopConsumingFrom(requestBodySource);
 188
 189     if (responseBodyBuffer != NULL)
 190         return;
 191
 192     serverComplete2();
 193 }
 194
 195 void
 196 ServerStateData::serverComplete2()
 197 {
 198     debugs(11,5,HERE << "serverComplete2 " << this);
 199
 200 #if USE_ADAPTATION
 201     if (virginBodyDestination != NULL)
 202         stopProducingFor(virginBodyDestination, true);
 203
 204     if (!doneWithAdaptation())
 205         return;
 206 #endif
 207
 208     completeForwarding();
 209     quitIfAllDone();
 210 }
 211
 212 // When we are done talking to the primary server, we may be still talking
 213 // to the ICAP service. And vice versa. Here, we quit only if we are done
 214 // talking to both.
 215 void ServerStateData::quitIfAllDone()
 216 {
 217 #if USE_ADAPTATION
 218     if (!doneWithAdaptation()) {
 219         debugs(11,5, HERE << "transaction not done: still talking to ICAP");
 220         return;
 221     }
 222 #endif
 223
 224     if (!doneWithServer()) {
 225         debugs(11,5, HERE << "transaction not done: still talking to server");
 226         return;
 227     }
 228
 229     debugs(11,3, HERE << "transaction done");
 230
 231     deleteThis("ServerStateData::quitIfAllDone");
 232 }
 233
 234 // FTP side overloads this to work around multiple calls to fwd->complete
 235 void
 236 ServerStateData::completeForwarding()
 237 {
 238     debugs(11,5, HERE << "completing forwarding for "  << fwd);
 239     assert(fwd != NULL);
 240     fwd->complete();
 241 }
 242
 243 // Register to receive request body
 244 bool ServerStateData::startRequestBodyFlow()
 245 {
 246     HttpRequest *r = originalRequest();
 247     assert(r->body_pipe != NULL);
 248     requestBodySource = r->body_pipe;
 249     if (requestBodySource->setConsumerIfNotLate(this)) {
 250         debugs(11,3, HERE << "expecting request body from " <<
 251                requestBodySource->status());
 252         return true;
 253     }
 254
 255     debugs(11,3, HERE << "aborting on partially consumed request body: " <<
 256            requestBodySource->status());
 257     requestBodySource = NULL;
 258     return false;
 259 }
 260
 261 // Entry-dependent callbacks use this check to quit if the entry went bad
 262 bool
 263 ServerStateData::abortOnBadEntry(const char *abortReason)
 264 {
 265     if (entry->isAccepting())
 266         return false;
 267
 268     debugs(11,5, HERE << "entry is not Accepting!");
 269     abortTransaction(abortReason);
 270     return true;
 271 }
 272
 273 // more request or adapted response body is available
 274 void
 275 ServerStateData::noteMoreBodyDataAvailable(BodyPipe::Pointer bp)
 276 {
 277 #if USE_ADAPTATION
 278     if (adaptedBodySource == bp) {
 279         handleMoreAdaptedBodyAvailable();
 280         return;
 281     }
 282 #endif
 283     handleMoreRequestBodyAvailable();
 284 }
 285
 286 // the entire request or adapted response body was provided, successfully
 287 void
 288 ServerStateData::noteBodyProductionEnded(BodyPipe::Pointer bp)
 289 {
 290 #if USE_ADAPTATION
 291     if (adaptedBodySource == bp) {
 292         handleAdaptedBodyProductionEnded();
 293         return;
 294     }
 295 #endif
 296     handleRequestBodyProductionEnded();
 297 }
 298
 299 // premature end of the request or adapted response body production
 300 void
 301 ServerStateData::noteBodyProducerAborted(BodyPipe::Pointer bp)
 302 {
 303 #if USE_ADAPTATION
 304     if (adaptedBodySource == bp) {
 305         handleAdaptedBodyProducerAborted();
 306         return;
 307     }
 308 #endif
 309     handleRequestBodyProducerAborted();
 310 }
 311
 312
 313 // more origin request body data is available
 314 void
 315 ServerStateData::handleMoreRequestBodyAvailable()
 316 {
 317     if (!requestSender)
 318         sendMoreRequestBody();
 319     else
 320         debugs(9,3, HERE << "waiting for request body write to complete");
 321 }
 322
 323 // there will be no more handleMoreRequestBodyAvailable calls
 324 void
 325 ServerStateData::handleRequestBodyProductionEnded()
 326 {
 327     receivedWholeRequestBody = true;
 328     if (!requestSender)
 329         doneSendingRequestBody();
 330     else
 331         debugs(9,3, HERE << "waiting for request body write to complete");
 332 }
 333
 334 // called when we are done sending request body; kids extend this
 335 void
 336 ServerStateData::doneSendingRequestBody()
 337 {
 338     debugs(9,3, HERE << "done sending request body");
 339     assert(requestBodySource != NULL);
 340     stopConsumingFrom(requestBodySource);
 341
 342     // kids extend this
 343 }
 344
 345 // called when body producers aborts; kids extend this
 346 void
 347 ServerStateData::handleRequestBodyProducerAborted()
 348 {
 349     if (requestSender != NULL)
 350         debugs(9,3, HERE << "fyi: request body aborted while we were sending");
 351
 352     fwd->dontRetry(true); // the problem is not with the server
 353     stopConsumingFrom(requestBodySource); // requestSender, if any, will notice
 354
 355     // kids extend this
 356 }
 357
 358 // called when we wrote request headers(!) or a part of the body
 359 void
 360 ServerStateData::sentRequestBody(const CommIoCbParams &io)
 361 {
 362     debugs(11, 5, "sentRequestBody: FD " << io.fd << ": size " << io.size << ": errflag " << io.flag << ".");
 363     debugs(32,3,HERE << "sentRequestBody called");
 364
 365     requestSender = NULL;
 366
 367     if (io.size > 0) {
 368         fd_bytes(io.fd, io.size, FD_WRITE);
 369         kb_incr(&statCounter.server.all.kbytes_out, io.size);
 370         // kids should increment their counters
 371     }
 372
 373     if (io.flag == COMM_ERR_CLOSING)
 374         return;
 375
 376     if (!requestBodySource) {
 377         debugs(9,3, HERE << "detected while-we-were-sending abort");
 378         return; // do nothing;
 379     }
 380
 381     if (io.flag) {
 382         debugs(11, 1, "sentRequestBody error: FD " << io.fd << ": " << xstrerr(errno));
 383         ErrorState *err;
 384         err = errorCon(ERR_WRITE_ERROR, HTTP_BAD_GATEWAY, fwd->request);
 385         err->xerrno = errno;
 386         fwd->fail(err);
 387         abortTransaction("I/O error while sending request body");
 388         return;
 389     }
 390
 391     if (EBIT_TEST(entry->flags, ENTRY_ABORTED)) {
 392         abortTransaction("store entry aborted while sending request body");
 393         return;
 394     }
 395
 396     if (!requestBodySource->exhausted())
 397         sendMoreRequestBody();
 398     else if (receivedWholeRequestBody)
 399         doneSendingRequestBody();
 400     else
 401         debugs(9,3, HERE << "waiting for body production end or abort");
 402 }
 403
 404 void
 405 ServerStateData::sendMoreRequestBody()
 406 {
 407     assert(requestBodySource != NULL);
 408     assert(!requestSender);
 409
 410     const Comm::ConnectionPointer conn = dataDescriptor();
 411
 412     if (!Comm::IsConnOpen(conn)) {
 413         debugs(9,3, HERE << "cannot send request body to closing " << conn);
 414         return; // wait for the kid's close handler; TODO: assert(closer);
 415     }
 416
 417     MemBuf buf;
 418     if (getMoreRequestBody(buf) && buf.contentSize() > 0) {
 419         debugs(9,3, HERE << "will write " << buf.contentSize() << " request body bytes");
 420         typedef CommCbMemFunT<ServerStateData, CommIoCbParams> Dialer;
 421         requestSender = JobCallback(93,3, Dialer, this, ServerStateData::sentRequestBody);
 422         comm_write_mbuf(conn, &buf, requestSender);
 423     } else {
 424         debugs(9,3, HERE << "will wait for more request body bytes or eof");
 425         requestSender = NULL;
 426     }
 427 }
 428
 429 /// either fill buf with available [encoded] request body bytes or return false
 430 bool
 431 ServerStateData::getMoreRequestBody(MemBuf &buf)
 432 {
 433     // default implementation does not encode request body content
 434     Must(requestBodySource != NULL);
 435     return requestBodySource->getMoreData(buf);
 436 }
 437
 438 // Compares hosts in urls, returns false if different, no sheme, or no host.
 439 static bool
 440 sameUrlHosts(const char *url1, const char *url2)
 441 {
 442     // XXX: Want urlHostname() here, but it uses static storage and copying
 443     const char *host1 = strchr(url1, ':');
 444     const char *host2 = strchr(url2, ':');
 445
 446     if (host1 && host2) {
 447         // skip scheme slashes
 448         do {
 449             ++host1;
 450             ++host2;
 451         } while (*host1 == '/' && *host2 == '/');
 452
 453         if (!*host1)
 454             return false; // no host
 455
 456         // increment while the same until we reach the end of the URL/host
 457         while (*host1 && *host1 != '/' && *host1 == *host2) {
 458             ++host1;
 459             ++host2;
 460         }
 461         return *host1 == *host2;
 462     }
 463
 464     return false; // no URL scheme
 465 }
 466
 467 // purges entries that match the value of a given HTTP [response] header
 468 static void
 469 purgeEntriesByHeader(HttpRequest *req, const char *reqUrl, HttpMsg *rep, http_hdr_type hdr)
 470 {
 471     const char *hdrUrl, *absUrl;
 472
 473     absUrl = NULL;
 474     hdrUrl = rep->header.getStr(hdr);
 475     if (hdrUrl == NULL) {
 476         return;
 477     }
 478
 479     /*
 480      * If the URL is relative, make it absolute so we can find it.
 481      * If it's absolute, make sure the host parts match to avoid DOS attacks
 482      * as per RFC 2616 13.10.
 483      */
 484     if (urlIsRelative(hdrUrl)) {
 485         absUrl = urlMakeAbsolute(req, hdrUrl);
 486         if (absUrl != NULL) {
 487             hdrUrl = absUrl;
 488         }
 489     } else if (!sameUrlHosts(reqUrl, hdrUrl)) {
 490         return;
 491     }
 492
 493     purgeEntriesByUrl(req, hdrUrl);
 494
 495     if (absUrl != NULL) {
 496         safe_free(absUrl);
 497     }
 498 }
 499
 500 // some HTTP methods should purge matching cache entries
 501 void
 502 ServerStateData::maybePurgeOthers()
 503 {
 504     // only some HTTP methods should purge matching cache entries
 505     if (!request->method.purgesOthers())
 506         return;
 507
 508     // and probably only if the response was successful
 509     if (theFinalReply->sline.status >= 400)
 510         return;
 511
 512     // XXX: should we use originalRequest() here?
 513     const char *reqUrl = urlCanonical(request);
 514     debugs(88, 5, "maybe purging due to " << RequestMethodStr(request->method) << ' ' << reqUrl);
 515     purgeEntriesByUrl(request, reqUrl);
 516     purgeEntriesByHeader(request, reqUrl, theFinalReply, HDR_LOCATION);
 517     purgeEntriesByHeader(request, reqUrl, theFinalReply, HDR_CONTENT_LOCATION);
 518 }
 519
 520 // called (usually by kids) when we have final (possibly adapted) reply headers
 521 void
 522 ServerStateData::haveParsedReplyHeaders()
 523 {
 524     Must(theFinalReply);
 525     maybePurgeOthers();
 526 }
 527
 528 HttpRequest *
 529 ServerStateData::originalRequest()
 530 {
 531     return request;
 532 }
 533
 534 #if USE_ADAPTATION
 535 /// Initiate an asynchronous adaptation transaction which will call us back.
 536 void
 537 ServerStateData::startAdaptation(const Adaptation::ServiceGroupPointer &group, HttpRequest *cause)
 538 {
 539     debugs(11, 5, "ServerStateData::startAdaptation() called");
 540     // check whether we should be sending a body as well
 541     // start body pipe to feed ICAP transaction if needed
 542     assert(!virginBodyDestination);
 543     HttpReply *vrep = virginReply();
 544     assert(!vrep->body_pipe);
 545     int64_t size = 0;
 546     if (vrep->expectingBody(cause->method, size) && size) {
 547         virginBodyDestination = new BodyPipe(this);
 548         vrep->body_pipe = virginBodyDestination;
 549         debugs(93, 6, HERE << "will send virgin reply body to " <<
 550                virginBodyDestination << "; size: " << size);
 551         if (size > 0)
 552             virginBodyDestination->setBodySize(size);
 553     }
 554
 555     adaptedHeadSource = initiateAdaptation(
 556                             new Adaptation::Iterator(vrep, cause, group));
 557     startedAdaptation = initiated(adaptedHeadSource);
 558     Must(startedAdaptation);
 559 }
 560
 561 // properly cleans up ICAP-related state
 562 // may be called multiple times
 563 void ServerStateData::cleanAdaptation()
 564 {
 565     debugs(11,5, HERE << "cleaning ICAP; ACL: " << adaptationAccessCheckPending);
 566
 567     if (virginBodyDestination != NULL)
 568         stopProducingFor(virginBodyDestination, false);
 569
 570     announceInitiatorAbort(adaptedHeadSource);
 571
 572     if (adaptedBodySource != NULL)
 573         stopConsumingFrom(adaptedBodySource);
 574
 575     if (!adaptationAccessCheckPending) // we cannot cancel a pending callback
 576         assert(doneWithAdaptation()); // make sure the two methods are in sync
 577 }
 578
 579 bool
 580 ServerStateData::doneWithAdaptation() const
 581 {
 582     return !adaptationAccessCheckPending &&
 583            !virginBodyDestination && !adaptedHeadSource && !adaptedBodySource;
 584 }
 585
 586 // sends virgin reply body to ICAP, buffering excesses if needed
 587 void
 588 ServerStateData::adaptVirginReplyBody(const char *data, ssize_t len)
 589 {
 590     assert(startedAdaptation);
 591
 592     if (!virginBodyDestination) {
 593         debugs(11,3, HERE << "ICAP does not want more virgin body");
 594         return;
 595     }
 596
 597     // grow overflow area if already overflowed
 598     if (responseBodyBuffer) {
 599         responseBodyBuffer->append(data, len);
 600         data = responseBodyBuffer->content();
 601         len = responseBodyBuffer->contentSize();
 602     }
 603
 604     const ssize_t putSize = virginBodyDestination->putMoreData(data, len);
 605     data += putSize;
 606     len -= putSize;
 607
 608     // if we had overflow area, shrink it as necessary
 609     if (responseBodyBuffer) {
 610         if (putSize == responseBodyBuffer->contentSize()) {
 611             delete responseBodyBuffer;
 612             responseBodyBuffer = NULL;
 613         } else {
 614             responseBodyBuffer->consume(putSize);
 615         }
 616         return;
 617     }
 618
 619     // if we did not have an overflow area, create it as needed
 620     if (len > 0) {
 621         assert(!responseBodyBuffer);
 622         responseBodyBuffer = new MemBuf;
 623         responseBodyBuffer->init(4096, SQUID_TCP_SO_RCVBUF * 10);
 624         responseBodyBuffer->append(data, len);
 625     }
 626 }
 627
 628 // can supply more virgin response body data
 629 void
 630 ServerStateData::noteMoreBodySpaceAvailable(BodyPipe::Pointer)
 631 {
 632     if (responseBodyBuffer) {
 633         addVirginReplyBody(NULL, 0); // kick the buffered fragment alive again
 634         if (completed && !responseBodyBuffer) {
 635             serverComplete2();
 636             return;
 637         }
 638     }
 639     maybeReadVirginBody();
 640 }
 641
 642 // the consumer of our virgin response body aborted
 643 void
 644 ServerStateData::noteBodyConsumerAborted(BodyPipe::Pointer)
 645 {
 646     stopProducingFor(virginBodyDestination, false);
 647
 648     // do not force closeServer here in case we need to bypass AdaptationQueryAbort
 649
 650     if (doneWithAdaptation()) // we may still be receiving adapted response
 651         handleAdaptationCompleted();
 652 }
 653
 654 // received adapted response headers (body may follow)
 655 void
 656 ServerStateData::noteAdaptationAnswer(HttpMsg *msg)
 657 {
 658     clearAdaptation(adaptedHeadSource); // we do not expect more messages
 659
 660     if (abortOnBadEntry("entry went bad while waiting for adapted headers"))
 661         return;
 662
 663     HttpReply *rep = dynamic_cast<HttpReply*>(msg);
 664     assert(rep);
 665     debugs(11,5, HERE << this << " setting adapted reply to " << rep);
 666     setFinalReply(rep);
 667
 668     assert(!adaptedBodySource);
 669     if (rep->body_pipe != NULL) {
 670         // subscribe to receive adapted body
 671         adaptedBodySource = rep->body_pipe;
 672         // assume that ICAP does not auto-consume on failures
 673         assert(adaptedBodySource->setConsumerIfNotLate(this));
 674     } else {
 675         // no body
 676         if (doneWithAdaptation()) // we may still be sending virgin response
 677             handleAdaptationCompleted();
 678     }
 679 }
 680
 681 // will not receive adapted response headers (and, hence, body)
 682 void
 683 ServerStateData::noteAdaptationQueryAbort(bool final)
 684 {
 685     clearAdaptation(adaptedHeadSource);
 686     handleAdaptationAborted(!final);
 687 }
 688
 689 // more adapted response body is available
 690 void
 691 ServerStateData::handleMoreAdaptedBodyAvailable()
 692 {
 693     const size_t contentSize = adaptedBodySource->buf().contentSize();
 694
 695     debugs(11,5, HERE << "consuming " << contentSize << " bytes of adapted " <<
 696            "response body at offset " << adaptedBodySource->consumedSize());
 697
 698     if (abortOnBadEntry("entry refuses adapted body"))
 699         return;
 700
 701     assert(entry);
 702     BodyPipeCheckout bpc(*adaptedBodySource);
 703     const StoreIOBuffer ioBuf(&bpc.buf, currentOffset);
 704     currentOffset += bpc.buf.size;
 705     entry->write(ioBuf);
 706     bpc.buf.consume(contentSize);
 707     bpc.checkIn();
 708 }
 709
 710 // the entire adapted response body was produced, successfully
 711 void
 712 ServerStateData::handleAdaptedBodyProductionEnded()
 713 {
 714     stopConsumingFrom(adaptedBodySource);
 715
 716     if (abortOnBadEntry("entry went bad while waiting for adapted body eof"))
 717         return;
 718
 719     handleAdaptationCompleted();
 720 }
 721
 722 // premature end of the adapted response body
 723 void ServerStateData::handleAdaptedBodyProducerAborted()
 724 {
 725     stopConsumingFrom(adaptedBodySource);
 726     handleAdaptationAborted();
 727 }
 728
 729 // common part of noteAdaptationAnswer and handleAdaptedBodyProductionEnded
 730 void
 731 ServerStateData::handleAdaptationCompleted()
 732 {
 733     debugs(11,5, HERE << "handleAdaptationCompleted");
 734     cleanAdaptation();
 735
 736     // We stop reading origin response because we have no place to put it and
 737     // cannot use it. If some origin servers do not like that or if we want to
 738     // reuse more pconns, we can add code to discard unneeded origin responses.
 739     if (!doneWithServer()) {
 740         debugs(11,3, HERE << "closing origin conn due to ICAP completion");
 741         closeServer();
 742     }
 743
 744     completeForwarding();
 745     quitIfAllDone();
 746 }
 747
 748
 749 // common part of noteAdaptation*Aborted and noteBodyConsumerAborted methods
 750 void
 751 ServerStateData::handleAdaptationAborted(bool bypassable)
 752 {
 753     debugs(11,5, HERE << "handleAdaptationAborted; bypassable: " << bypassable <<
 754            ", entry empty: " << entry->isEmpty());
 755
 756     if (abortOnBadEntry("entry went bad while ICAP aborted"))
 757         return;
 758
 759     // TODO: bypass if possible
 760
 761     if (entry->isEmpty()) {
 762         debugs(11,9, HERE << "creating ICAP error entry after ICAP failure");
 763         ErrorState *err = errorCon(ERR_ICAP_FAILURE, HTTP_INTERNAL_SERVER_ERROR, request);
 764         err->xerrno = errno;
 765         fwd->fail(err);
 766         fwd->dontRetry(true);
 767     }
 768
 769     abortTransaction("ICAP failure");
 770 }
 771
 772 void
 773 ServerStateData::adaptationAclCheckDone(Adaptation::ServiceGroupPointer group)
 774 {
 775     adaptationAccessCheckPending = false;
 776
 777     if (abortOnBadEntry("entry went bad while waiting for ICAP ACL check"))
 778         return;
 779
 780     // TODO: Should nonICAP and postICAP path check this on the server-side?
 781     // That check now only happens on client-side, in processReplyAccess().
 782     if (virginReply()->expectedBodyTooLarge(*request)) {
 783         sendBodyIsTooLargeError();
 784         return;
 785     }
 786     // TODO: Should we check receivedBodyTooLarge on the server-side as well?
 787
 788     if (!group) {
 789         debugs(11,3, HERE << "no adapation needed");
 790         setFinalReply(virginReply());
 791         processReplyBody();
 792         return;
 793     }
 794
 795     startAdaptation(group, originalRequest());
 796     processReplyBody();
 797 }
 798
 799 void
 800 ServerStateData::adaptationAclCheckDoneWrapper(Adaptation::ServiceGroupPointer group, void *data)
 801 {
 802     ServerStateData *state = (ServerStateData *)data;
 803     state->adaptationAclCheckDone(group);
 804 }
 805 #endif
 806
 807 void
 808 ServerStateData::sendBodyIsTooLargeError()
 809 {
 810     ErrorState *err = errorCon(ERR_TOO_BIG, HTTP_FORBIDDEN, request);
 811     err->xerrno = errno;
 812     fwd->fail(err);
 813     fwd->dontRetry(true);
 814     abortTransaction("Virgin body too large.");
 815 }
 816
 817 // TODO: when HttpStateData sends all errors to ICAP,
 818 // we should be able to move this at the end of setVirginReply().
 819 void
 820 ServerStateData::adaptOrFinalizeReply()
 821 {
 822 #if USE_ADAPTATION
 823     // TODO: merge with client side and return void to hide the on/off logic?
 824     // The callback can be called with a NULL service if adaptation is off.
 825     adaptationAccessCheckPending = Adaptation::AccessCheck::Start(
 826                                        Adaptation::methodRespmod, Adaptation::pointPreCache,
 827                                        request, virginReply(), adaptationAclCheckDoneWrapper, this);
 828     debugs(11,5, HERE << "adaptationAccessCheckPending=" << adaptationAccessCheckPending);
 829     if (adaptationAccessCheckPending)
 830         return;
 831 #endif
 832
 833     setFinalReply(virginReply());
 834 }
 835
 836 /// initializes bodyBytesRead stats if needed and applies delta
 837 void
 838 ServerStateData::adjustBodyBytesRead(const int64_t delta)
 839 {
 840     int64_t &bodyBytesRead = originalRequest()->hier.bodyBytesRead;
 841
 842     // if we got here, do not log a dash even if we got nothing from the server
 843     if (bodyBytesRead < 0)
 844         bodyBytesRead = 0;
 845
 846     bodyBytesRead += delta; // supports negative and zero deltas
 847
 848     // check for overflows ("infinite" response?) and undeflows (a bug)
 849     Must(bodyBytesRead >= 0);
 850 }
 851
 852 void
 853 ServerStateData::addVirginReplyBody(const char *data, ssize_t len)
 854 {
 855     adjustBodyBytesRead(len);
 856
 857 #if USE_ADAPTATION
 858     assert(!adaptationAccessCheckPending); // or would need to buffer while waiting
 859     if (startedAdaptation) {
 860         adaptVirginReplyBody(data, len);
 861         return;
 862     }
 863 #endif
 864     storeReplyBody(data, len);
 865 }
 866
 867 // writes virgin or adapted reply body to store
 868 void
 869 ServerStateData::storeReplyBody(const char *data, ssize_t len)
 870 {
 871     // write even if len is zero to push headers towards the client side
 872     entry->write (StoreIOBuffer(len, currentOffset, (char*)data));
 873
 874     currentOffset += len;
 875 }
 876
 877 size_t ServerStateData::replyBodySpace(const MemBuf &readBuf,
 878                                        const size_t minSpace) const
 879 {
 880     size_t space = readBuf.spaceSize(); // available space w/o heroic measures
 881     if (space < minSpace) {
 882         const size_t maxSpace = readBuf.potentialSpaceSize(); // absolute best
 883         space = min(minSpace, maxSpace); // do not promise more than asked
 884     }
 885
 886 #if USE_ADAPTATION
 887     if (responseBodyBuffer) {
 888         return 0;       // Stop reading if already overflowed waiting for ICAP to catch up
 889     }
 890
 891     if (virginBodyDestination != NULL) {
 892         /*
 893          * BodyPipe buffer has a finite size limit.  We
 894          * should not read more data from the network than will fit
 895          * into the pipe buffer or we _lose_ what did not fit if
 896          * the response ends sooner that BodyPipe frees up space:
 897          * There is no code to keep pumping data into the pipe once
 898          * response ends and serverComplete() is called.
 899          *
 900          * If the pipe is totally full, don't register the read handler.
 901          * The BodyPipe will call our noteMoreBodySpaceAvailable() method
 902          * when it has free space again.
 903          */
 904         size_t adaptation_space =
 905             virginBodyDestination->buf().potentialSpaceSize();
 906
 907         debugs(11,9, "ServerStateData may read up to min(" <<
 908                adaptation_space << ", " << space << ") bytes");
 909
 910         if (adaptation_space < space)
 911             space = adaptation_space;
 912     }
 913 #endif
 914
 915     return space;
 916 }