src/adaptation/ecap/XactionRep.cc

   1 /*
   2  * Copyright (C) 1996-2015 The Squid Software Foundation and contributors
   3  *
   4  * Squid software is distributed under GPLv2+ license and includes
   5  * contributions from numerous individuals and organizations.
   6  * Please see the COPYING and CONTRIBUTORS files for details.
   7  */
   8
   9 /* DEBUG: section 93    eCAP Interface */
  10
  11 #include "squid.h"
  12 #include <libecap/common/area.h>
  13 #include <libecap/common/delay.h>
  14 #include <libecap/common/named_values.h>
  15 #include <libecap/common/names.h>
  16 #include <libecap/adapter/xaction.h>
  17 #include "adaptation/Answer.h"
  18 #include "adaptation/ecap/Config.h"
  19 #include "adaptation/ecap/XactionRep.h"
  20 #include "adaptation/Initiator.h"
  21 #include "base/AsyncJobCalls.h"
  22 #include "base/TextException.h"
  23 #include "format/Format.h"
  24 #include "HttpReply.h"
  25 #include "HttpRequest.h"
  26 #include "SquidTime.h"
  27
  28 CBDATA_NAMESPACED_CLASS_INIT(Adaptation::Ecap::XactionRep, XactionRep);
  29
  30 /// a libecap Visitor for converting adapter transaction options to HttpHeader
  31 class OptionsExtractor: public libecap::NamedValueVisitor
  32 {
  33 public:
  34     typedef libecap::Name Name;
  35     typedef libecap::Area Area;
  36
  37     OptionsExtractor(HttpHeader &aMeta): meta(aMeta) {}
  38
  39     // libecap::NamedValueVisitor API
  40     virtual void visit(const Name &name, const Area &value) {
  41         meta.putExt(name.image().c_str(), value.toString().c_str());
  42     }
  43
  44     HttpHeader &meta; ///< where to put extracted options
  45 };
  46
  47 Adaptation::Ecap::XactionRep::XactionRep(
  48     HttpMsg *virginHeader, HttpRequest *virginCause, AccessLogEntry::Pointer &alp,
  49     const Adaptation::ServicePointer &aService):
  50     AsyncJob("Adaptation::Ecap::XactionRep"),
  51     Adaptation::Initiate("Adaptation::Ecap::XactionRep"),
  52     theService(aService),
  53     theVirginRep(virginHeader), theCauseRep(NULL),
  54     makingVb(opUndecided), proxyingAb(opUndecided),
  55     adaptHistoryId(-1),
  56     vbProductionFinished(false),
  57     abProductionFinished(false), abProductionAtEnd(false),
  58     al(alp)
  59 {
  60     if (virginCause)
  61         theCauseRep = new MessageRep(virginCause);
  62 }
  63
  64 Adaptation::Ecap::XactionRep::~XactionRep()
  65 {
  66     assert(!theMaster);
  67     delete theCauseRep;
  68     theAnswerRep.reset();
  69 }
  70
  71 void
  72 Adaptation::Ecap::XactionRep::master(const AdapterXaction &x)
  73 {
  74     Must(!theMaster);
  75     Must(x != NULL);
  76     theMaster = x;
  77 }
  78
  79 Adaptation::Service &
  80 Adaptation::Ecap::XactionRep::service()
  81 {
  82     Must(theService != NULL);
  83     return *theService;
  84 }
  85
  86 const libecap::Area
  87 Adaptation::Ecap::XactionRep::option(const libecap::Name &name) const
  88 {
  89     if (name == libecap::metaClientIp)
  90         return clientIpValue();
  91     if (name == libecap::metaUserName)
  92         return usernameValue();
  93     if (Adaptation::Config::masterx_shared_name && name == Adaptation::Config::masterx_shared_name)
  94         return masterxSharedValue(name);
  95
  96     // TODO: metaServerIp, metaAuthenticatedUser, and metaAuthenticatedGroups
  97
  98     // If the name is unknown, metaValue returns an emtpy area
  99     return metaValue(name);
 100 }
 101
 102 void
 103 Adaptation::Ecap::XactionRep::visitEachOption(libecap::NamedValueVisitor &visitor) const
 104 {
 105     if (const libecap::Area value = clientIpValue())
 106         visitor.visit(libecap::metaClientIp, value);
 107     if (const libecap::Area value = usernameValue())
 108         visitor.visit(libecap::metaUserName, value);
 109
 110     if (Adaptation::Config::masterx_shared_name) {
 111         const libecap::Name name(Adaptation::Config::masterx_shared_name);
 112         if (const libecap::Area value = masterxSharedValue(name))
 113             visitor.visit(name, value);
 114     }
 115
 116     visitEachMetaHeader(visitor);
 117
 118     // TODO: metaServerIp, metaAuthenticatedUser, and metaAuthenticatedGroups
 119 }
 120
 121 const libecap::Area
 122 Adaptation::Ecap::XactionRep::clientIpValue() const
 123 {
 124     const HttpRequest *request = dynamic_cast<const HttpRequest*>(theCauseRep ?
 125                                  theCauseRep->raw().header : theVirginRep.raw().header);
 126     Must(request);
 127     // TODO: move this logic into HttpRequest::clientIp(bool) and
 128     // HttpRequest::clientIpString(bool) and reuse everywhere
 129     if (TheConfig.send_client_ip && request) {
 130         Ip::Address client_addr;
 131 #if FOLLOW_X_FORWARDED_FOR
 132         if (TheConfig.use_indirect_client) {
 133             client_addr = request->indirect_client_addr;
 134         } else
 135 #endif
 136             client_addr = request->client_addr;
 137         if (!client_addr.isAnyAddr() && !client_addr.isNoAddr()) {
 138             char ntoabuf[MAX_IPSTRLEN] = "";
 139             client_addr.toStr(ntoabuf,MAX_IPSTRLEN);
 140             return libecap::Area::FromTempBuffer(ntoabuf, strlen(ntoabuf));
 141         }
 142     }
 143     return libecap::Area();
 144 }
 145
 146 const libecap::Area
 147 Adaptation::Ecap::XactionRep::usernameValue() const
 148 {
 149 #if USE_AUTH
 150     const HttpRequest *request = dynamic_cast<const HttpRequest*>(theCauseRep ?
 151                                  theCauseRep->raw().header : theVirginRep.raw().header);
 152     Must(request);
 153     if (request->auth_user_request != NULL) {
 154         if (char const *name = request->auth_user_request->username())
 155             return libecap::Area::FromTempBuffer(name, strlen(name));
 156         else if (request->extacl_user.size() > 0)
 157             return libecap::Area::FromTempBuffer(request->extacl_user.rawBuf(),
 158                                                  request->extacl_user.size());
 159     }
 160 #endif
 161     return libecap::Area();
 162 }
 163
 164 const libecap::Area
 165 Adaptation::Ecap::XactionRep::masterxSharedValue(const libecap::Name &name) const
 166 {
 167     const HttpRequest *request = dynamic_cast<const HttpRequest*>(theCauseRep ?
 168                                  theCauseRep->raw().header : theVirginRep.raw().header);
 169     Must(request);
 170     if (name.known()) { // must check to avoid empty names matching unset cfg
 171         Adaptation::History::Pointer ah = request->adaptHistory(false);
 172         if (ah != NULL) {
 173             String name, value;
 174             if (ah->getXxRecord(name, value))
 175                 return libecap::Area::FromTempBuffer(value.rawBuf(), value.size());
 176         }
 177     }
 178     return libecap::Area();
 179 }
 180
 181 const libecap::Area
 182 Adaptation::Ecap::XactionRep::metaValue(const libecap::Name &name) const
 183 {
 184     HttpRequest *request = dynamic_cast<HttpRequest*>(theCauseRep ?
 185                            theCauseRep->raw().header : theVirginRep.raw().header);
 186     Must(request);
 187     HttpReply *reply = dynamic_cast<HttpReply*>(theVirginRep.raw().header);
 188
 189     if (name.known()) { // must check to avoid empty names matching unset cfg
 190         typedef Notes::iterator ACAMLI;
 191         for (ACAMLI i = Adaptation::Config::metaHeaders.begin(); i != Adaptation::Config::metaHeaders.end(); ++i) {
 192             if (name == (*i)->key.termedBuf()) {
 193                 if (const char *value = (*i)->match(request, reply, al))
 194                     return libecap::Area::FromTempString(value);
 195                 else
 196                     return libecap::Area();
 197             }
 198         }
 199     }
 200
 201     return libecap::Area();
 202 }
 203
 204 void
 205 Adaptation::Ecap::XactionRep::visitEachMetaHeader(libecap::NamedValueVisitor &visitor) const
 206 {
 207     HttpRequest *request = dynamic_cast<HttpRequest*>(theCauseRep ?
 208                            theCauseRep->raw().header : theVirginRep.raw().header);
 209     Must(request);
 210     HttpReply *reply = dynamic_cast<HttpReply*>(theVirginRep.raw().header);
 211
 212     typedef Notes::iterator ACAMLI;
 213     for (ACAMLI i = Adaptation::Config::metaHeaders.begin(); i != Adaptation::Config::metaHeaders.end(); ++i) {
 214         const char *v = (*i)->match(request, reply, al);
 215         if (v) {
 216             const libecap::Name name((*i)->key.termedBuf());
 217             const libecap::Area value = libecap::Area::FromTempString(v);
 218             visitor.visit(name, value);
 219         }
 220     }
 221 }
 222
 223 void
 224 Adaptation::Ecap::XactionRep::start()
 225 {
 226     Must(theMaster);
 227
 228     if (!theVirginRep.raw().body_pipe)
 229         makingVb = opNever; // there is nothing to deliver
 230
 231     HttpRequest *request = dynamic_cast<HttpRequest*> (theCauseRep ?
 232                            theCauseRep->raw().header : theVirginRep.raw().header);
 233     Must(request);
 234
 235     HttpReply *reply = dynamic_cast<HttpReply*>(theVirginRep.raw().header);
 236
 237     Adaptation::History::Pointer ah = request->adaptLogHistory();
 238     if (ah != NULL) {
 239         // retrying=false because ecap never retries transactions
 240         adaptHistoryId = ah->recordXactStart(service().cfg().key, current_time, false);
 241         typedef Notes::iterator ACAMLI;
 242         for (ACAMLI i = Adaptation::Config::metaHeaders.begin(); i != Adaptation::Config::metaHeaders.end(); ++i) {
 243             const char *v = (*i)->match(request, reply, al);
 244             if (v) {
 245                 if (ah->metaHeaders == NULL)
 246                     ah->metaHeaders = new NotePairs();
 247                 if (!ah->metaHeaders->hasPair((*i)->key.termedBuf(), v))
 248                     ah->metaHeaders->add((*i)->key.termedBuf(), v);
 249             }
 250         }
 251     }
 252
 253     theMaster->start();
 254 }
 255
 256 void
 257 Adaptation::Ecap::XactionRep::swanSong()
 258 {
 259     // clear body_pipes, if any
 260     // this code does not maintain proxying* and canAccessVb states; should it?
 261
 262     if (theAnswerRep != NULL) {
 263         BodyPipe::Pointer body_pipe = answer().body_pipe;
 264         if (body_pipe != NULL) {
 265             Must(body_pipe->stillProducing(this));
 266             stopProducingFor(body_pipe, false);
 267         }
 268     }
 269
 270     BodyPipe::Pointer &body_pipe = theVirginRep.raw().body_pipe;
 271     if (body_pipe != NULL && body_pipe->stillConsuming(this))
 272         stopConsumingFrom(body_pipe);
 273
 274     terminateMaster();
 275
 276     const HttpRequest *request = dynamic_cast<const HttpRequest*>(theCauseRep ?
 277                                  theCauseRep->raw().header : theVirginRep.raw().header);
 278     Must(request);
 279     Adaptation::History::Pointer ah = request->adaptLogHistory();
 280     if (ah != NULL && adaptHistoryId >= 0)
 281         ah->recordXactFinish(adaptHistoryId);
 282
 283     Adaptation::Initiate::swanSong();
 284 }
 285
 286 void
 287 Adaptation::Ecap::XactionRep::resume()
 288 {
 289     // go async to gain exception protection and done()-based job destruction
 290     typedef NullaryMemFunT<Adaptation::Ecap::XactionRep> Dialer;
 291     AsyncCall::Pointer call = asyncCall(93, 5, "Adaptation::Ecap::XactionRep::doResume",
 292                                         Dialer(this, &Adaptation::Ecap::XactionRep::doResume));
 293     ScheduleCallHere(call);
 294 }
 295
 296 /// the guts of libecap::host::Xaction::resume() API implementation
 297 /// which just goes async in Adaptation::Ecap::XactionRep::resume().
 298 void
 299 Adaptation::Ecap::XactionRep::doResume()
 300 {
 301     Must(theMaster);
 302     theMaster->resume();
 303 }
 304
 305 libecap::Message &
 306 Adaptation::Ecap::XactionRep::virgin()
 307 {
 308     return theVirginRep;
 309 }
 310
 311 const libecap::Message &
 312 Adaptation::Ecap::XactionRep::cause()
 313 {
 314     Must(theCauseRep != NULL);
 315     return *theCauseRep;
 316 }
 317
 318 libecap::Message &
 319 Adaptation::Ecap::XactionRep::adapted()
 320 {
 321     Must(theAnswerRep != NULL);
 322     return *theAnswerRep;
 323 }
 324
 325 Adaptation::Message &
 326 Adaptation::Ecap::XactionRep::answer()
 327 {
 328     MessageRep *rep = dynamic_cast<MessageRep*>(theAnswerRep.get());
 329     Must(rep);
 330     return rep->raw();
 331 }
 332
 333 void
 334 Adaptation::Ecap::XactionRep::terminateMaster()
 335 {
 336     if (theMaster) {
 337         AdapterXaction x = theMaster;
 338         theMaster.reset();
 339         x->stop();
 340     }
 341 }
 342
 343 bool
 344 Adaptation::Ecap::XactionRep::doneAll() const
 345 {
 346     return makingVb >= opComplete && proxyingAb >= opComplete &&
 347            Adaptation::Initiate::doneAll();
 348 }
 349
 350 // stops receiving virgin and enables auto-consumption, dropping any vb bytes
 351 void
 352 Adaptation::Ecap::XactionRep::sinkVb(const char *reason)
 353 {
 354     debugs(93,4, HERE << "sink for " << reason << "; status:" << status());
 355
 356     // we reset raw().body_pipe when we are done, so use this one for checking
 357     const BodyPipePointer &permPipe = theVirginRep.raw().header->body_pipe;
 358     if (permPipe != NULL)
 359         permPipe->enableAutoConsumption();
 360
 361     forgetVb(reason);
 362 }
 363
 364 // stops receiving virgin but preserves it for others to use
 365 void
 366 Adaptation::Ecap::XactionRep::preserveVb(const char *reason)
 367 {
 368     debugs(93,4, HERE << "preserve for " << reason << "; status:" << status());
 369
 370     // we reset raw().body_pipe when we are done, so use this one for checking
 371     const BodyPipePointer &permPipe = theVirginRep.raw().header->body_pipe;
 372     if (permPipe != NULL) {
 373         // if libecap consumed, we cannot preserve
 374         Must(!permPipe->consumedSize());
 375     }
 376
 377     forgetVb(reason);
 378 }
 379
 380 // disassociates us from vb; the last step of sinking or preserving vb
 381 void
 382 Adaptation::Ecap::XactionRep::forgetVb(const char *reason)
 383 {
 384     debugs(93,9, HERE << "forget vb " << reason << "; status:" << status());
 385
 386     BodyPipePointer &p = theVirginRep.raw().body_pipe;
 387     if (p != NULL && p->stillConsuming(this))
 388         stopConsumingFrom(p);
 389
 390     if (makingVb == opUndecided)
 391         makingVb = opNever;
 392     else if (makingVb == opOn)
 393         makingVb = opComplete;
 394 }
 395
 396 void
 397 Adaptation::Ecap::XactionRep::useVirgin()
 398 {
 399     debugs(93,3, HERE << status());
 400     Must(proxyingAb == opUndecided);
 401     proxyingAb = opNever;
 402
 403     preserveVb("useVirgin");
 404
 405     HttpMsg *clone = theVirginRep.raw().header->clone();
 406     // check that clone() copies the pipe so that we do not have to
 407     Must(!theVirginRep.raw().header->body_pipe == !clone->body_pipe);
 408
 409     updateHistory(clone);
 410     sendAnswer(Answer::Forward(clone));
 411     Must(done());
 412 }
 413
 414 void
 415 Adaptation::Ecap::XactionRep::useAdapted(const libecap::shared_ptr<libecap::Message> &m)
 416 {
 417     debugs(93,3, HERE << status());
 418     Must(m);
 419     theAnswerRep = m;
 420     Must(proxyingAb == opUndecided);
 421
 422     HttpMsg *msg = answer().header;
 423     if (!theAnswerRep->body()) { // final, bodyless answer
 424         proxyingAb = opNever;
 425         updateHistory(msg);
 426         sendAnswer(Answer::Forward(msg));
 427     } else { // got answer headers but need to handle body
 428         proxyingAb = opOn;
 429         Must(!msg->body_pipe); // only host can set body pipes
 430         MessageRep *rep = dynamic_cast<MessageRep*>(theAnswerRep.get());
 431         Must(rep);
 432         rep->tieBody(this); // sets us as a producer
 433         Must(msg->body_pipe != NULL); // check tieBody
 434
 435         updateHistory(msg);
 436         sendAnswer(Answer::Forward(msg));
 437
 438         debugs(93,4, HERE << "adapter will produce body" << status());
 439         theMaster->abMake(); // libecap will produce
 440     }
 441 }
 442
 443 void
 444 Adaptation::Ecap::XactionRep::blockVirgin()
 445 {
 446     debugs(93,3, HERE << status());
 447     Must(proxyingAb == opUndecided);
 448     proxyingAb = opNever;
 449
 450     sinkVb("blockVirgin");
 451
 452     updateHistory(NULL);
 453     sendAnswer(Answer::Block(service().cfg().key));
 454     Must(done());
 455 }
 456
 457 /// Called just before sendAnswer() to record adapter meta-information
 458 /// which may affect answer processing and may be needed for logging.
 459 void
 460 Adaptation::Ecap::XactionRep::updateHistory(HttpMsg *adapted)
 461 {
 462     if (!theMaster) // all updates rely on being able to query the adapter
 463         return;
 464
 465     const HttpRequest *request = dynamic_cast<const HttpRequest*>(theCauseRep ?
 466                                  theCauseRep->raw().header : theVirginRep.raw().header);
 467     Must(request);
 468
 469     // TODO: move common ICAP/eCAP logic to Adaptation::Xaction or similar
 470     // TODO: optimize Area-to-String conversion
 471
 472     // update the cross-transactional database if needed
 473     if (const char *xxNameStr = Adaptation::Config::masterx_shared_name) {
 474         Adaptation::History::Pointer ah = request->adaptHistory(true);
 475         if (ah != NULL) {
 476             libecap::Name xxName(xxNameStr); // TODO: optimize?
 477             if (const libecap::Area val = theMaster->option(xxName))
 478                 ah->updateXxRecord(xxNameStr, val.toString().c_str());
 479         }
 480     }
 481
 482     // update the adaptation plan if needed
 483     if (service().cfg().routing) {
 484         String services;
 485         if (const libecap::Area services = theMaster->option(libecap::metaNextServices)) {
 486             Adaptation::History::Pointer ah = request->adaptHistory(true);
 487             if (ah != NULL)
 488                 ah->updateNextServices(services.toString().c_str());
 489         }
 490     } // TODO: else warn (occasionally!) if we got libecap::metaNextServices
 491
 492     // Store received meta headers for adapt::<last_h logformat code use.
 493     // If we already have stored headers from a previous adaptation transaction
 494     // related to the same master transction, they will be replaced.
 495     Adaptation::History::Pointer ah = request->adaptLogHistory();
 496     if (ah != NULL) {
 497         HttpHeader meta(hoReply);
 498         OptionsExtractor extractor(meta);
 499         theMaster->visitEachOption(extractor);
 500         ah->recordMeta(&meta);
 501     }
 502
 503     // Add just-created history to the adapted/cloned request that lacks it.
 504     if (HttpRequest *adaptedReq = dynamic_cast<HttpRequest*>(adapted))
 505         adaptedReq->adaptHistoryImport(*request);
 506 }
 507
 508 void
 509 Adaptation::Ecap::XactionRep::vbDiscard()
 510 {
 511     Must(makingVb == opUndecided);
 512     // if adapter does not need vb, we do not need to send it
 513     sinkVb("vbDiscard");
 514     Must(makingVb == opNever);
 515 }
 516
 517 void
 518 Adaptation::Ecap::XactionRep::vbMake()
 519 {
 520     Must(makingVb == opUndecided);
 521     BodyPipePointer &p = theVirginRep.raw().body_pipe;
 522     Must(p != NULL);
 523     Must(p->setConsumerIfNotLate(this)); // to deliver vb, we must receive vb
 524     makingVb = opOn;
 525 }
 526
 527 void
 528 Adaptation::Ecap::XactionRep::vbStopMaking()
 529 {
 530     Must(makingVb == opOn);
 531     // if adapter does not need vb, we do not need to receive it
 532     sinkVb("vbStopMaking");
 533     Must(makingVb == opComplete);
 534 }
 535
 536 void
 537 Adaptation::Ecap::XactionRep::vbMakeMore()
 538 {
 539     Must(makingVb == opOn); // cannot make more if done proxying
 540     // we cannot guarantee more vb, but we can check that there is a chance
 541     const BodyPipePointer &p = theVirginRep.raw().body_pipe;
 542     Must(p != NULL && p->stillConsuming(this)); // we are plugged in
 543     Must(!p->productionEnded() && p->mayNeedMoreData()); // and may get more
 544 }
 545
 546 libecap::Area
 547 Adaptation::Ecap::XactionRep::vbContent(libecap::size_type o, libecap::size_type s)
 548 {
 549     // We may not be makingVb yet. It should be OK, but see vbContentShift().
 550
 551     const BodyPipePointer &p = theVirginRep.raw().body_pipe;
 552     Must(p != NULL);
 553
 554     // TODO: make MemBuf use size_t?
 555     const size_t haveSize = static_cast<size_t>(p->buf().contentSize());
 556
 557     // convert to Squid types; XXX: check for overflow
 558     const uint64_t offset = static_cast<uint64_t>(o);
 559     Must(offset <= haveSize); // equal iff at the end of content
 560
 561     // nsize means no size limit: all content starting from offset
 562     const size_t size = s == libecap::nsize ?
 563                         haveSize - offset : static_cast<size_t>(s);
 564
 565     // XXX: optimize by making theBody a shared_ptr (see Area::FromTemp*() src)
 566     return libecap::Area::FromTempBuffer(p->buf().content() + offset,
 567                                          min(static_cast<size_t>(haveSize - offset), size));
 568 }
 569
 570 void
 571 Adaptation::Ecap::XactionRep::vbContentShift(libecap::size_type n)
 572 {
 573     // We may not be makingVb yet. It should be OK now, but if BodyPipe
 574     // consume() requirements change, we would have to return empty vbContent
 575     // until the adapter registers as a consumer
 576
 577     BodyPipePointer &p = theVirginRep.raw().body_pipe;
 578     Must(p != NULL);
 579     const size_t size = static_cast<size_t>(n); // XXX: check for overflow
 580     const size_t haveSize = static_cast<size_t>(p->buf().contentSize()); // TODO: make MemBuf use size_t?
 581     p->consume(min(size, haveSize));
 582 }
 583
 584 void
 585 Adaptation::Ecap::XactionRep::noteAbContentDone(bool atEnd)
 586 {
 587     Must(proxyingAb == opOn && !abProductionFinished);
 588     abProductionFinished = true;
 589     abProductionAtEnd = atEnd; // store until ready to stop producing ourselves
 590     debugs(93,5, HERE << "adapted body production ended");
 591     moveAbContent();
 592 }
 593
 594 void
 595 Adaptation::Ecap::XactionRep::noteAbContentAvailable()
 596 {
 597     Must(proxyingAb == opOn && !abProductionFinished);
 598     moveAbContent();
 599 }
 600
 601 #if 0 /* XXX: implement */
 602 void
 603 Adaptation::Ecap::XactionRep::setAdaptedBodySize(const libecap::BodySize &size)
 604 {
 605     Must(answer().body_pipe != NULL);
 606     if (size.known())
 607         answer().body_pipe->setBodySize(size.value());
 608     // else the piped body size is unknown by default
 609 }
 610 #endif
 611
 612 void
 613 Adaptation::Ecap::XactionRep::adaptationDelayed(const libecap::Delay &d)
 614 {
 615     debugs(93,3, HERE << "adapter needs time: " <<
 616            d.state << '/' << d.progress);
 617     // XXX: set timeout?
 618 }
 619
 620 void
 621 Adaptation::Ecap::XactionRep::adaptationAborted()
 622 {
 623     tellQueryAborted(true); // should eCAP support retries?
 624     mustStop("adaptationAborted");
 625 }
 626
 627 void
 628 Adaptation::Ecap::XactionRep::noteMoreBodySpaceAvailable(RefCount<BodyPipe> bp)
 629 {
 630     Must(proxyingAb == opOn);
 631     moveAbContent();
 632 }
 633
 634 void
 635 Adaptation::Ecap::XactionRep::noteBodyConsumerAborted(RefCount<BodyPipe> bp)
 636 {
 637     Must(proxyingAb == opOn);
 638     stopProducingFor(answer().body_pipe, false);
 639     Must(theMaster);
 640     theMaster->abStopMaking();
 641     proxyingAb = opComplete;
 642 }
 643
 644 void
 645 Adaptation::Ecap::XactionRep::noteMoreBodyDataAvailable(RefCount<BodyPipe> bp)
 646 {
 647     Must(makingVb == opOn); // or we would not be registered as a consumer
 648     Must(theMaster);
 649     theMaster->noteVbContentAvailable();
 650 }
 651
 652 void
 653 Adaptation::Ecap::XactionRep::noteBodyProductionEnded(RefCount<BodyPipe> bp)
 654 {
 655     Must(makingVb == opOn); // or we would not be registered as a consumer
 656     Must(theMaster);
 657     theMaster->noteVbContentDone(true);
 658     vbProductionFinished = true;
 659 }
 660
 661 void
 662 Adaptation::Ecap::XactionRep::noteBodyProducerAborted(RefCount<BodyPipe> bp)
 663 {
 664     Must(makingVb == opOn); // or we would not be registered as a consumer
 665     Must(theMaster);
 666     theMaster->noteVbContentDone(false);
 667     vbProductionFinished = true;
 668 }
 669
 670 void
 671 Adaptation::Ecap::XactionRep::noteInitiatorAborted()
 672 {
 673     mustStop("initiator aborted");
 674 }
 675
 676 // get content from the adapter and put it into the adapted pipe
 677 void
 678 Adaptation::Ecap::XactionRep::moveAbContent()
 679 {
 680     Must(proxyingAb == opOn);
 681     const libecap::Area c = theMaster->abContent(0, libecap::nsize);
 682     debugs(93,5, HERE << "up to " << c.size << " bytes");
 683     if (c.size == 0 && abProductionFinished) { // no ab now and in the future
 684         stopProducingFor(answer().body_pipe, abProductionAtEnd);
 685         proxyingAb = opComplete;
 686         debugs(93,5, HERE << "last adapted body data retrieved");
 687     } else if (c.size > 0) {
 688         if (const size_t used = answer().body_pipe->putMoreData(c.start, c.size))
 689             theMaster->abContentShift(used);
 690     }
 691 }
 692
 693 const char *
 694 Adaptation::Ecap::XactionRep::status() const
 695 {
 696     static MemBuf buf;
 697     buf.reset();
 698
 699     buf.append(" [", 2);
 700
 701     if (makingVb)
 702         buf.Printf("M%d", static_cast<int>(makingVb));
 703
 704     const BodyPipePointer &vp = theVirginRep.raw().body_pipe;
 705     if (!vp)
 706         buf.append(" !V", 3);
 707     else if (vp->stillConsuming(const_cast<XactionRep*>(this)))
 708         buf.append(" Vc", 3);
 709     else
 710         buf.append(" V?", 3);
 711
 712     if (vbProductionFinished)
 713         buf.append(".", 1);
 714
 715     buf.Printf(" A%d", static_cast<int>(proxyingAb));
 716
 717     if (proxyingAb == opOn) {
 718         MessageRep *rep = dynamic_cast<MessageRep*>(theAnswerRep.get());
 719         Must(rep);
 720         const BodyPipePointer &ap = rep->raw().body_pipe;
 721         if (!ap)
 722             buf.append(" !A", 3);
 723         else if (ap->stillProducing(const_cast<XactionRep*>(this)))
 724             buf.append(" Ap", 3);
 725         else
 726             buf.append(" A?", 3);
 727     }
 728
 729     buf.Printf(" %s%u]", id.Prefix, id.value);
 730
 731     buf.terminate();
 732
 733     return buf.content();
 734 }
 735