]>
Commit | Line | Data |
---|---|---|
774c051c | 1 | /* |
507d0a78 | 2 | * DEBUG: section 93 ICAP (RFC 3507) Client |
774c051c | 3 | */ |
4 | ||
582c2af2 | 5 | #include "squid.h" |
3d93a84d | 6 | #include "AccessLogEntry.h" |
1adcebc3 | 7 | #include "adaptation/Answer.h" |
3d93a84d AJ |
8 | #include "adaptation/History.h" |
9 | #include "adaptation/icap/Client.h" | |
10 | #include "adaptation/icap/Config.h" | |
11 | #include "adaptation/icap/History.h" | |
12 | #include "adaptation/icap/Launcher.h" | |
13 | #include "adaptation/icap/ModXact.h" | |
14 | #include "adaptation/icap/ServiceRep.h" | |
15 | #include "adaptation/Initiator.h" | |
16 | #include "auth/UserRequest.h" | |
17 | #include "base/TextException.h" | |
25f98340 | 18 | #include "base64.h" |
3d93a84d | 19 | #include "ChunkedCodingParser.h" |
774c051c | 20 | #include "comm.h" |
d6327017 | 21 | #include "comm/Connection.h" |
582c2af2 | 22 | #include "err_detail_type.h" |
a5bac1d2 | 23 | #include "HttpHeaderTools.h" |
5f8252d2 | 24 | #include "HttpMsg.h" |
774c051c | 25 | #include "HttpReply.h" |
582c2af2 | 26 | #include "HttpRequest.h" |
985c86bc | 27 | #include "SquidTime.h" |
b1bd952a | 28 | #include "URL.h" |
774c051c | 29 | |
30 | // flow and terminology: | |
31 | // HTTP| --> receive --> encode --> write --> |network | |
32 | // end | <-- send <-- parse <-- read <-- |end | |
33 | ||
774c051c | 34 | // TODO: replace gotEncapsulated() with something faster; we call it often |
35 | ||
26cc52cb AR |
36 | CBDATA_NAMESPACED_CLASS_INIT(Adaptation::Icap, ModXact); |
37 | CBDATA_NAMESPACED_CLASS_INIT(Adaptation::Icap, ModXactLauncher); | |
774c051c | 38 | |
5f8252d2 | 39 | static const size_t TheBackupLimit = BodyPipe::MaxCapacity; |
774c051c | 40 | |
26cc52cb | 41 | Adaptation::Icap::ModXact::State::State() |
774c051c | 42 | { |
09bfe95f | 43 | memset(this, 0, sizeof(*this)); |
774c051c | 44 | } |
45 | ||
4299f876 | 46 | Adaptation::Icap::ModXact::ModXact(HttpMsg *virginHeader, |
af6a12ee | 47 | HttpRequest *virginCause, Adaptation::Icap::ServiceRep::Pointer &aService): |
26cc52cb | 48 | AsyncJob("Adaptation::Icap::ModXact"), |
4299f876 | 49 | Adaptation::Icap::Xaction("Adaptation::Icap::ModXact", aService), |
9e008dda AJ |
50 | virginConsumed(0), |
51 | bodyParser(NULL), | |
3ff65596 | 52 | canStartBypass(false), // too early |
a22e6cd3 | 53 | protectGroupBypass(true), |
bae917ac CT |
54 | replyHttpHeaderSize(-1), |
55 | replyHttpBodySize(-1), | |
3ff65596 | 56 | adaptHistoryId(-1) |
774c051c | 57 | { |
5f8252d2 | 58 | assert(virginHeader); |
774c051c | 59 | |
5f8252d2 | 60 | virgin.setHeader(virginHeader); // sets virgin.body_pipe if needed |
61 | virgin.setCause(virginCause); // may be NULL | |
774c051c | 62 | |
5f8252d2 | 63 | // adapted header and body are initialized when we parse them |
774c051c | 64 | |
26cc52cb | 65 | // writing and reading ends are handled by Adaptation::Icap::Xaction |
774c051c | 66 | |
67 | // encoding | |
68 | // nothing to do because we are using temporary buffers | |
69 | ||
3ff65596 | 70 | // parsing; TODO: do not set until we parse, see ICAPOptXact |
c7d51c86 | 71 | icapReply = new HttpReply; |
774c051c | 72 | icapReply->protoPrefix = "ICAP/"; // TODO: make an IcapReply class? |
73 | ||
192378eb | 74 | debugs(93,7, HERE << "initialized." << status()); |
774c051c | 75 | } |
76 | ||
5f8252d2 | 77 | // initiator wants us to start |
26cc52cb | 78 | void Adaptation::Icap::ModXact::start() |
774c051c | 79 | { |
26cc52cb | 80 | Adaptation::Icap::Xaction::start(); |
774c051c | 81 | |
3ff65596 | 82 | // reserve an adaptation history slot (attempts are known at this time) |
a22e6cd3 | 83 | Adaptation::History::Pointer ah = virginRequest().adaptLogHistory(); |
3ff65596 AR |
84 | if (ah != NULL) |
85 | adaptHistoryId = ah->recordXactStart(service().cfg().key, icap_tr_start, attempts > 1); | |
86 | ||
774c051c | 87 | estimateVirginBody(); // before virgin disappears! |
88 | ||
0bef8dd7 | 89 | canStartBypass = service().cfg().bypass; |
478cfe99 | 90 | |
774c051c | 91 | // it is an ICAP violation to send request to a service w/o known OPTIONS |
2dba5b8e CT |
92 | // and the service may is too busy for us: honor Max-Connections and such |
93 | if (service().up() && service().availableForNew()) | |
774c051c | 94 | startWriting(); |
95 | else | |
96 | waitForService(); | |
774c051c | 97 | } |
98 | ||
26cc52cb | 99 | void Adaptation::Icap::ModXact::waitForService() |
774c051c | 100 | { |
2dba5b8e | 101 | const char *comment; |
774c051c | 102 | Must(!state.serviceWaiting); |
2dba5b8e CT |
103 | |
104 | if (!service().up()) { | |
105 | AsyncCall::Pointer call = JobCallback(93,5, | |
106 | ConnWaiterDialer, this, Adaptation::Icap::ModXact::noteServiceReady); | |
107 | ||
108 | service().callWhenReady(call); | |
109 | comment = "to be up"; | |
110 | } else { | |
111 | //The service is unavailable because of max-connection or other reason | |
112 | ||
113 | if (service().cfg().onOverload != srvWait) { | |
114 | // The service is overloaded, but waiting to be available prohibited by | |
115 | // user configuration (onOverload is set to "block" or "bypass") | |
116 | if (service().cfg().onOverload == srvBlock) | |
117 | disableBypass("not available", true); | |
118 | else //if (service().cfg().onOverload == srvBypass) | |
119 | canStartBypass = true; | |
120 | ||
121 | disableRetries(); | |
122 | disableRepeats("ICAP service is not available"); | |
123 | ||
124 | debugs(93, 7, HERE << "will not wait for the service to be available" << | |
125 | status()); | |
126 | ||
127 | throw TexcHere("ICAP service is not available"); | |
128 | } | |
129 | ||
130 | AsyncCall::Pointer call = JobCallback(93,5, | |
131 | ConnWaiterDialer, this, Adaptation::Icap::ModXact::noteServiceAvailable); | |
132 | service().callWhenAvailable(call, state.waitedForService); | |
133 | comment = "to be available"; | |
134 | } | |
135 | ||
136 | debugs(93, 7, HERE << "will wait for the service " << comment << status()); | |
c7d51c86 | 137 | state.serviceWaiting = true; // after callWhenReady() which may throw |
2dba5b8e | 138 | state.waitedForService = true; |
774c051c | 139 | } |
140 | ||
26cc52cb | 141 | void Adaptation::Icap::ModXact::noteServiceReady() |
774c051c | 142 | { |
774c051c | 143 | Must(state.serviceWaiting); |
144 | state.serviceWaiting = false; | |
c99de607 | 145 | |
2dba5b8e | 146 | if (!service().up()) { |
c824c43b | 147 | disableRetries(); |
3ff65596 | 148 | disableRepeats("ICAP service is unusable"); |
478cfe99 | 149 | throw TexcHere("ICAP service is unusable"); |
c824c43b | 150 | } |
2dba5b8e CT |
151 | |
152 | if (service().availableForOld()) | |
153 | startWriting(); | |
154 | else | |
155 | waitForService(); | |
156 | } | |
157 | ||
158 | void Adaptation::Icap::ModXact::noteServiceAvailable() | |
159 | { | |
160 | Must(state.serviceWaiting); | |
161 | state.serviceWaiting = false; | |
162 | ||
163 | if (service().up() && service().availableForOld()) | |
164 | startWriting(); | |
165 | else | |
166 | waitForService(); | |
774c051c | 167 | } |
168 | ||
26cc52cb | 169 | void Adaptation::Icap::ModXact::startWriting() |
774c051c | 170 | { |
774c051c | 171 | state.writing = State::writingConnect; |
c824c43b | 172 | |
173 | decideOnPreview(); // must be decided before we decideOnRetries | |
174 | decideOnRetries(); | |
175 | ||
774c051c | 176 | openConnection(); |
774c051c | 177 | } |
178 | ||
179 | // connection with the ICAP service established | |
26cc52cb | 180 | void Adaptation::Icap::ModXact::handleCommConnected() |
774c051c | 181 | { |
182 | Must(state.writing == State::writingConnect); | |
183 | ||
184 | startReading(); // wait for early errors from the ICAP server | |
185 | ||
186 | MemBuf requestBuf; | |
187 | requestBuf.init(); | |
188 | ||
189 | makeRequestHeaders(requestBuf); | |
192378eb | 190 | debugs(93, 9, HERE << "will write" << status() << ":\n" << |
774c051c | 191 | (requestBuf.terminate(), requestBuf.content())); |
192 | ||
193 | // write headers | |
194 | state.writing = State::writingHeaders; | |
3ff65596 | 195 | icap_tio_start = current_time; |
774c051c | 196 | scheduleWrite(requestBuf); |
197 | } | |
198 | ||
26cc52cb | 199 | void Adaptation::Icap::ModXact::handleCommWrote(size_t sz) |
774c051c | 200 | { |
b107a5a5 | 201 | debugs(93, 5, HERE << "Wrote " << sz << " bytes"); |
202 | ||
774c051c | 203 | if (state.writing == State::writingHeaders) |
204 | handleCommWroteHeaders(); | |
205 | else | |
206 | handleCommWroteBody(); | |
207 | } | |
208 | ||
26cc52cb | 209 | void Adaptation::Icap::ModXact::handleCommWroteHeaders() |
774c051c | 210 | { |
211 | Must(state.writing == State::writingHeaders); | |
212 | ||
5f8252d2 | 213 | // determine next step |
23e05fb1 AR |
214 | if (preview.enabled()) { |
215 | if (preview.done()) | |
216 | decideWritingAfterPreview("zero-size"); | |
217 | else | |
218 | state.writing = State::writingPreview; | |
219 | } else if (virginBody.expected()) { | |
e1381638 | 220 | state.writing = State::writingPrime; |
23e05fb1 | 221 | } else { |
e1381638 AJ |
222 | stopWriting(true); |
223 | return; | |
224 | } | |
5f8252d2 | 225 | |
226 | writeMore(); | |
774c051c | 227 | } |
228 | ||
26cc52cb | 229 | void Adaptation::Icap::ModXact::writeMore() |
774c051c | 230 | { |
5f8252d2 | 231 | debugs(93, 5, HERE << "checking whether to write more" << status()); |
232 | ||
bd7f2ede | 233 | if (writer != NULL) // already writing something |
774c051c | 234 | return; |
235 | ||
236 | switch (state.writing) { | |
237 | ||
238 | case State::writingInit: // waiting for service OPTIONS | |
239 | Must(state.serviceWaiting); | |
240 | ||
241 | case State::writingConnect: // waiting for the connection to establish | |
242 | ||
243 | case State::writingHeaders: // waiting for the headers to be written | |
244 | ||
245 | case State::writingPaused: // waiting for the ICAP server response | |
246 | ||
c99de607 | 247 | case State::writingReallyDone: // nothing more to write |
248 | return; | |
249 | ||
250 | case State::writingAlmostDone: // was waiting for the last write | |
251 | stopWriting(false); | |
774c051c | 252 | return; |
253 | ||
254 | case State::writingPreview: | |
5f8252d2 | 255 | writePreviewBody(); |
774c051c | 256 | return; |
257 | ||
258 | case State::writingPrime: | |
259 | writePrimeBody(); | |
260 | return; | |
261 | ||
262 | default: | |
26cc52cb | 263 | throw TexcHere("Adaptation::Icap::ModXact in bad writing state"); |
774c051c | 264 | } |
265 | } | |
266 | ||
26cc52cb | 267 | void Adaptation::Icap::ModXact::writePreviewBody() |
774c051c | 268 | { |
5f8252d2 | 269 | debugs(93, 8, HERE << "will write Preview body from " << |
9e008dda | 270 | virgin.body_pipe << status()); |
774c051c | 271 | Must(state.writing == State::writingPreview); |
5f8252d2 | 272 | Must(virgin.body_pipe != NULL); |
774c051c | 273 | |
5f8252d2 | 274 | const size_t sizeMax = (size_t)virgin.body_pipe->buf().contentSize(); |
d85c3078 | 275 | const size_t size = min(preview.debt(), sizeMax); |
774c051c | 276 | writeSomeBody("preview body", size); |
277 | ||
278 | // change state once preview is written | |
279 | ||
23e05fb1 AR |
280 | if (preview.done()) |
281 | decideWritingAfterPreview("body"); | |
282 | } | |
774c051c | 283 | |
23e05fb1 AR |
284 | /// determine state.writing after we wrote the entire preview |
285 | void Adaptation::Icap::ModXact::decideWritingAfterPreview(const char *kind) | |
286 | { | |
287 | if (preview.ieof()) // nothing more to write | |
288 | stopWriting(true); | |
e81d21e0 | 289 | else if (state.parsing == State::psIcapHeader) // did not get a reply yet |
23e05fb1 AR |
290 | state.writing = State::writingPaused; // wait for the ICAP server reply |
291 | else | |
292 | stopWriting(true); // ICAP server reply implies no post-preview writing | |
293 | ||
294 | debugs(93, 6, HERE << "decided on writing after " << kind << " preview" << | |
e81d21e0 | 295 | status()); |
774c051c | 296 | } |
297 | ||
26cc52cb | 298 | void Adaptation::Icap::ModXact::writePrimeBody() |
774c051c | 299 | { |
300 | Must(state.writing == State::writingPrime); | |
5f8252d2 | 301 | Must(virginBodyWriting.active()); |
774c051c | 302 | |
5f8252d2 | 303 | const size_t size = (size_t)virgin.body_pipe->buf().contentSize(); |
774c051c | 304 | writeSomeBody("prime virgin body", size); |
305 | ||
5f8252d2 | 306 | if (virginBodyEndReached(virginBodyWriting)) { |
307 | debugs(93, 5, HERE << "wrote entire body"); | |
c99de607 | 308 | stopWriting(true); |
b107a5a5 | 309 | } |
774c051c | 310 | } |
311 | ||
26cc52cb | 312 | void Adaptation::Icap::ModXact::writeSomeBody(const char *label, size_t size) |
774c051c | 313 | { |
c99de607 | 314 | Must(!writer && state.writing < state.writingAlmostDone); |
5f8252d2 | 315 | Must(virgin.body_pipe != NULL); |
12f4b710 | 316 | debugs(93, 8, HERE << "will write up to " << size << " bytes of " << |
774c051c | 317 | label); |
318 | ||
319 | MemBuf writeBuf; // TODO: suggest a min size based on size and lastChunk | |
320 | ||
321 | writeBuf.init(); // note: we assume that last-chunk will fit | |
322 | ||
5f8252d2 | 323 | const size_t writableSize = virginContentSize(virginBodyWriting); |
d85c3078 | 324 | const size_t chunkSize = min(writableSize, size); |
774c051c | 325 | |
326 | if (chunkSize) { | |
12f4b710 | 327 | debugs(93, 7, HERE << "will write " << chunkSize << |
774c051c | 328 | "-byte chunk of " << label); |
5f8252d2 | 329 | |
330 | openChunk(writeBuf, chunkSize, false); | |
331 | writeBuf.append(virginContentData(virginBodyWriting), chunkSize); | |
332 | closeChunk(writeBuf); | |
333 | ||
334 | virginBodyWriting.progress(chunkSize); | |
335 | virginConsume(); | |
774c051c | 336 | } else { |
192378eb | 337 | debugs(93, 7, HERE << "has no writable " << label << " content"); |
774c051c | 338 | } |
339 | ||
5f8252d2 | 340 | const bool wroteEof = virginBodyEndReached(virginBodyWriting); |
341 | bool lastChunk = wroteEof; | |
342 | if (state.writing == State::writingPreview) { | |
343 | preview.wrote(chunkSize, wroteEof); // even if wrote nothing | |
344 | lastChunk = lastChunk || preview.done(); | |
345 | } | |
774c051c | 346 | |
5f8252d2 | 347 | if (lastChunk) { |
12f4b710 | 348 | debugs(93, 8, HERE << "will write last-chunk of " << label); |
774c051c | 349 | addLastRequestChunk(writeBuf); |
350 | } | |
351 | ||
12f4b710 | 352 | debugs(93, 7, HERE << "will write " << writeBuf.contentSize() |
774c051c | 353 | << " raw bytes of " << label); |
354 | ||
355 | if (writeBuf.hasContent()) { | |
356 | scheduleWrite(writeBuf); // comm will free the chunk | |
357 | } else { | |
358 | writeBuf.clean(); | |
359 | } | |
360 | } | |
361 | ||
26cc52cb | 362 | void Adaptation::Icap::ModXact::addLastRequestChunk(MemBuf &buf) |
774c051c | 363 | { |
c99de607 | 364 | const bool ieof = state.writing == State::writingPreview && preview.ieof(); |
365 | openChunk(buf, 0, ieof); | |
366 | closeChunk(buf); | |
774c051c | 367 | } |
368 | ||
26cc52cb | 369 | void Adaptation::Icap::ModXact::openChunk(MemBuf &buf, size_t chunkSize, bool ieof) |
774c051c | 370 | { |
c99de607 | 371 | buf.Printf((ieof ? "%x; ieof\r\n" : "%x\r\n"), (int) chunkSize); |
774c051c | 372 | } |
373 | ||
26cc52cb | 374 | void Adaptation::Icap::ModXact::closeChunk(MemBuf &buf) |
774c051c | 375 | { |
774c051c | 376 | buf.append(ICAP::crlf, 2); // chunk-terminating CRLF |
377 | } | |
378 | ||
3ff65596 AR |
379 | const HttpRequest &Adaptation::Icap::ModXact::virginRequest() const |
380 | { | |
381 | const HttpRequest *request = virgin.cause ? | |
e1381638 | 382 | virgin.cause : dynamic_cast<const HttpRequest*>(virgin.header); |
3ff65596 AR |
383 | Must(request); |
384 | return *request; | |
385 | } | |
386 | ||
5f8252d2 | 387 | // did the activity reached the end of the virgin body? |
26cc52cb | 388 | bool Adaptation::Icap::ModXact::virginBodyEndReached(const Adaptation::Icap::VirginBodyAct &act) const |
5f8252d2 | 389 | { |
9e008dda | 390 | return |
5f8252d2 | 391 | !act.active() || // did all (assuming it was originally planned) |
392 | !virgin.body_pipe->expectMoreAfter(act.offset()); // wont have more | |
393 | } | |
394 | ||
395 | // the size of buffered virgin body data available for the specified activity | |
396 | // if this size is zero, we may be done or may be waiting for more data | |
26cc52cb | 397 | size_t Adaptation::Icap::ModXact::virginContentSize(const Adaptation::Icap::VirginBodyAct &act) const |
774c051c | 398 | { |
5f8252d2 | 399 | Must(act.active()); |
400 | // asbolute start of unprocessed data | |
b0365bd9 | 401 | const uint64_t dataStart = act.offset(); |
5f8252d2 | 402 | // absolute end of buffered data |
b0365bd9 FC |
403 | const uint64_t dataEnd = virginConsumed + virgin.body_pipe->buf().contentSize(); |
404 | Must(virginConsumed <= dataStart && dataStart <= dataEnd); | |
405 | return static_cast<size_t>(dataEnd - dataStart); | |
774c051c | 406 | } |
407 | ||
5f8252d2 | 408 | // pointer to buffered virgin body data available for the specified activity |
26cc52cb | 409 | const char *Adaptation::Icap::ModXact::virginContentData(const Adaptation::Icap::VirginBodyAct &act) const |
774c051c | 410 | { |
5f8252d2 | 411 | Must(act.active()); |
b0365bd9 FC |
412 | const uint64_t dataStart = act.offset(); |
413 | Must(virginConsumed <= dataStart); | |
414 | return virgin.body_pipe->buf().content() + static_cast<size_t>(dataStart-virginConsumed); | |
774c051c | 415 | } |
416 | ||
26cc52cb | 417 | void Adaptation::Icap::ModXact::virginConsume() |
774c051c | 418 | { |
3ff65596 | 419 | debugs(93, 9, HERE << "consumption guards: " << !virgin.body_pipe << isRetriable << |
a22e6cd3 | 420 | isRepeatable << canStartBypass << protectGroupBypass); |
478cfe99 | 421 | |
5f8252d2 | 422 | if (!virgin.body_pipe) |
c824c43b | 423 | return; // nothing to consume |
424 | ||
425 | if (isRetriable) | |
426 | return; // do not consume if we may have to retry later | |
5f8252d2 | 427 | |
428 | BodyPipe &bp = *virgin.body_pipe; | |
a22e6cd3 | 429 | const bool wantToPostpone = isRepeatable || canStartBypass || protectGroupBypass; |
478cfe99 | 430 | |
431 | // Why > 2? HttpState does not use the last bytes in the buffer | |
9e008dda | 432 | // because delayAwareRead() is arguably broken. See |
478cfe99 | 433 | // HttpStateData::maybeReadVirginBody for more details. |
3ff65596 | 434 | if (wantToPostpone && bp.buf().spaceSize() > 2) { |
478cfe99 | 435 | // Postponing may increase memory footprint and slow the HTTP side |
9e008dda | 436 | // down. Not postponing may increase the number of ICAP errors |
478cfe99 | 437 | // if the ICAP service fails. We may also use "potential" space to |
438 | // postpone more aggressively. Should the trade-off be configurable? | |
439 | debugs(93, 8, HERE << "postponing consumption from " << bp.status()); | |
440 | return; | |
441 | } | |
442 | ||
5f8252d2 | 443 | const size_t have = static_cast<size_t>(bp.buf().contentSize()); |
47f6e231 | 444 | const uint64_t end = virginConsumed + have; |
445 | uint64_t offset = end; | |
774c051c | 446 | |
478cfe99 | 447 | debugs(93, 9, HERE << "max virgin consumption offset=" << offset << |
9e008dda AJ |
448 | " acts " << virginBodyWriting.active() << virginBodySending.active() << |
449 | " consumed=" << virginConsumed << | |
450 | " from " << virgin.body_pipe->status()); | |
478cfe99 | 451 | |
5f8252d2 | 452 | if (virginBodyWriting.active()) |
d85c3078 | 453 | offset = min(virginBodyWriting.offset(), offset); |
774c051c | 454 | |
5f8252d2 | 455 | if (virginBodySending.active()) |
d85c3078 | 456 | offset = min(virginBodySending.offset(), offset); |
774c051c | 457 | |
458 | Must(virginConsumed <= offset && offset <= end); | |
459 | ||
47f6e231 | 460 | if (const size_t size = static_cast<size_t>(offset - virginConsumed)) { |
b107a5a5 | 461 | debugs(93, 8, HERE << "consuming " << size << " out of " << have << |
774c051c | 462 | " virgin body bytes"); |
5f8252d2 | 463 | bp.consume(size); |
774c051c | 464 | virginConsumed += size; |
c824c43b | 465 | Must(!isRetriable); // or we should not be consuming |
3ff65596 | 466 | disableRepeats("consumed content"); |
a22e6cd3 | 467 | disableBypass("consumed content", true); |
774c051c | 468 | } |
469 | } | |
470 | ||
26cc52cb | 471 | void Adaptation::Icap::ModXact::handleCommWroteBody() |
774c051c | 472 | { |
473 | writeMore(); | |
474 | } | |
475 | ||
c99de607 | 476 | // Called when we do not expect to call comm_write anymore. |
477 | // We may have a pending write though. | |
478 | // If stopping nicely, we will just wait for that pending write, if any. | |
26cc52cb | 479 | void Adaptation::Icap::ModXact::stopWriting(bool nicely) |
774c051c | 480 | { |
c99de607 | 481 | if (state.writing == State::writingReallyDone) |
774c051c | 482 | return; |
483 | ||
bd7f2ede | 484 | if (writer != NULL) { |
c99de607 | 485 | if (nicely) { |
5f8252d2 | 486 | debugs(93, 7, HERE << "will wait for the last write" << status()); |
c99de607 | 487 | state.writing = State::writingAlmostDone; // may already be set |
5f8252d2 | 488 | checkConsuming(); |
c99de607 | 489 | return; |
490 | } | |
4932ad93 | 491 | debugs(93, 3, HERE << "will NOT wait for the last write" << status()); |
774c051c | 492 | |
c99de607 | 493 | // Comm does not have an interface to clear the writer callback nicely, |
494 | // but without clearing the writer we cannot recycle the connection. | |
495 | // We prevent connection reuse and hope that we can handle a callback | |
5f8252d2 | 496 | // call at any time, usually in the middle of the destruction sequence! |
497 | // Somebody should add comm_remove_write_handler() to comm API. | |
c99de607 | 498 | reuseConnection = false; |
478cfe99 | 499 | ignoreLastWrite = true; |
c99de607 | 500 | } |
501 | ||
5f8252d2 | 502 | debugs(93, 7, HERE << "will no longer write" << status()); |
5f8252d2 | 503 | if (virginBodyWriting.active()) { |
504 | virginBodyWriting.disable(); | |
505 | virginConsume(); | |
506 | } | |
478cfe99 | 507 | state.writing = State::writingReallyDone; |
508 | checkConsuming(); | |
774c051c | 509 | } |
510 | ||
26cc52cb | 511 | void Adaptation::Icap::ModXact::stopBackup() |
774c051c | 512 | { |
5f8252d2 | 513 | if (!virginBodySending.active()) |
774c051c | 514 | return; |
515 | ||
192378eb | 516 | debugs(93, 7, HERE << "will no longer backup" << status()); |
5f8252d2 | 517 | virginBodySending.disable(); |
774c051c | 518 | virginConsume(); |
519 | } | |
520 | ||
26cc52cb | 521 | bool Adaptation::Icap::ModXact::doneAll() const |
774c051c | 522 | { |
26cc52cb | 523 | return Adaptation::Icap::Xaction::doneAll() && !state.serviceWaiting && |
5f8252d2 | 524 | doneSending() && |
774c051c | 525 | doneReading() && state.doneWriting(); |
526 | } | |
527 | ||
26cc52cb | 528 | void Adaptation::Icap::ModXact::startReading() |
774c051c | 529 | { |
aed188fd | 530 | Must(haveConnection()); |
774c051c | 531 | Must(!reader); |
5f8252d2 | 532 | Must(!adapted.header); |
533 | Must(!adapted.body_pipe); | |
774c051c | 534 | |
535 | // we use the same buffer for headers and body and then consume headers | |
536 | readMore(); | |
537 | } | |
538 | ||
26cc52cb | 539 | void Adaptation::Icap::ModXact::readMore() |
774c051c | 540 | { |
bd7f2ede | 541 | if (reader != NULL || doneReading()) { |
c99de607 | 542 | debugs(93,3,HERE << "returning from readMore because reader or doneReading()"); |
774c051c | 543 | return; |
3b299123 | 544 | } |
774c051c | 545 | |
546 | // do not fill readBuf if we have no space to store the result | |
5f8252d2 | 547 | if (adapted.body_pipe != NULL && |
9e008dda | 548 | !adapted.body_pipe->buf().hasPotentialSpace()) { |
5f8252d2 | 549 | debugs(93,3,HERE << "not reading because ICAP reply pipe is full"); |
774c051c | 550 | return; |
3b299123 | 551 | } |
774c051c | 552 | |
553 | if (readBuf.hasSpace()) | |
554 | scheduleRead(); | |
3b299123 | 555 | else |
c99de607 | 556 | debugs(93,3,HERE << "nothing to do because !readBuf.hasSpace()"); |
774c051c | 557 | } |
558 | ||
559 | // comm module read a portion of the ICAP response for us | |
26cc52cb | 560 | void Adaptation::Icap::ModXact::handleCommRead(size_t) |
774c051c | 561 | { |
562 | Must(!state.doneParsing()); | |
3ff65596 | 563 | icap_tio_finish = current_time; |
774c051c | 564 | parseMore(); |
565 | readMore(); | |
566 | } | |
567 | ||
26cc52cb | 568 | void Adaptation::Icap::ModXact::echoMore() |
774c051c | 569 | { |
570 | Must(state.sending == State::sendingVirgin); | |
5f8252d2 | 571 | Must(adapted.body_pipe != NULL); |
572 | Must(virginBodySending.active()); | |
573 | ||
574 | const size_t sizeMax = virginContentSize(virginBodySending); | |
575 | debugs(93,5, HERE << "will echo up to " << sizeMax << " bytes from " << | |
9e008dda | 576 | virgin.body_pipe->status()); |
5f8252d2 | 577 | debugs(93,5, HERE << "will echo up to " << sizeMax << " bytes to " << |
9e008dda | 578 | adapted.body_pipe->status()); |
5f8252d2 | 579 | |
580 | if (sizeMax > 0) { | |
581 | const size_t size = adapted.body_pipe->putMoreData(virginContentData(virginBodySending), sizeMax); | |
582 | debugs(93,5, HERE << "echoed " << size << " out of " << sizeMax << | |
9e008dda | 583 | " bytes"); |
5f8252d2 | 584 | virginBodySending.progress(size); |
3ff65596 | 585 | disableRepeats("echoed content"); |
a22e6cd3 AR |
586 | disableBypass("echoed content", true); |
587 | virginConsume(); | |
774c051c | 588 | } |
589 | ||
5f8252d2 | 590 | if (virginBodyEndReached(virginBodySending)) { |
192378eb | 591 | debugs(93, 5, HERE << "echoed all" << status()); |
774c051c | 592 | stopSending(true); |
593 | } else { | |
192378eb | 594 | debugs(93, 5, HERE << "has " << |
9e008dda AJ |
595 | virgin.body_pipe->buf().contentSize() << " bytes " << |
596 | "and expects more to echo" << status()); | |
5f8252d2 | 597 | // TODO: timeout if virgin or adapted pipes are broken |
774c051c | 598 | } |
599 | } | |
600 | ||
26cc52cb | 601 | bool Adaptation::Icap::ModXact::doneSending() const |
774c051c | 602 | { |
774c051c | 603 | return state.sending == State::sendingDone; |
604 | } | |
605 | ||
478cfe99 | 606 | // stop (or do not start) sending adapted message body |
26cc52cb | 607 | void Adaptation::Icap::ModXact::stopSending(bool nicely) |
774c051c | 608 | { |
3ff65596 | 609 | debugs(93, 7, HERE << "Enter stop sending "); |
774c051c | 610 | if (doneSending()) |
611 | return; | |
3ff65596 | 612 | debugs(93, 7, HERE << "Proceed with stop sending "); |
774c051c | 613 | |
614 | if (state.sending != State::sendingUndecided) { | |
192378eb | 615 | debugs(93, 7, HERE << "will no longer send" << status()); |
5f8252d2 | 616 | if (adapted.body_pipe != NULL) { |
617 | virginBodySending.disable(); | |
618 | // we may leave debts if we were echoing and the virgin | |
619 | // body_pipe got exhausted before we echoed all planned bytes | |
620 | const bool leftDebts = adapted.body_pipe->needsMoreData(); | |
621 | stopProducingFor(adapted.body_pipe, nicely && !leftDebts); | |
622 | } | |
774c051c | 623 | } else { |
192378eb | 624 | debugs(93, 7, HERE << "will not start sending" << status()); |
5f8252d2 | 625 | Must(!adapted.body_pipe); |
774c051c | 626 | } |
627 | ||
628 | state.sending = State::sendingDone; | |
5f8252d2 | 629 | checkConsuming(); |
774c051c | 630 | } |
631 | ||
5f8252d2 | 632 | // should be called after certain state.writing or state.sending changes |
26cc52cb | 633 | void Adaptation::Icap::ModXact::checkConsuming() |
774c051c | 634 | { |
5f8252d2 | 635 | // quit if we already stopped or are still using the pipe |
636 | if (!virgin.body_pipe || !state.doneConsumingVirgin()) | |
774c051c | 637 | return; |
638 | ||
5f8252d2 | 639 | debugs(93, 7, HERE << "will stop consuming" << status()); |
640 | stopConsumingFrom(virgin.body_pipe); | |
774c051c | 641 | } |
642 | ||
26cc52cb | 643 | void Adaptation::Icap::ModXact::parseMore() |
774c051c | 644 | { |
aa761e5f | 645 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " bytes to parse" << |
774c051c | 646 | status()); |
d5cfacfb | 647 | debugs(93, 5, HERE << "\n" << readBuf.content()); |
774c051c | 648 | |
649 | if (state.parsingHeaders()) | |
650 | parseHeaders(); | |
651 | ||
652 | if (state.parsing == State::psBody) | |
653 | parseBody(); | |
654 | } | |
655 | ||
26cc52cb | 656 | void Adaptation::Icap::ModXact::callException(const std::exception &e) |
478cfe99 | 657 | { |
658 | if (!canStartBypass || isRetriable) { | |
64b66b76 CT |
659 | if (!isRetriable) { |
660 | if (const TextException *te = dynamic_cast<const TextException *>(&e)) | |
661 | detailError(ERR_DETAIL_EXCEPTION_START + te->id()); | |
662 | else | |
663 | detailError(ERR_DETAIL_EXCEPTION_OTHER); | |
664 | } | |
26cc52cb | 665 | Adaptation::Icap::Xaction::callException(e); |
478cfe99 | 666 | return; |
667 | } | |
668 | ||
669 | try { | |
192378eb | 670 | debugs(93, 3, HERE << "bypassing " << inCall << " exception: " << |
af6a12ee | 671 | e.what() << ' ' << status()); |
478cfe99 | 672 | bypassFailure(); |
64b66b76 CT |
673 | } catch (const TextException &bypassTe) { |
674 | detailError(ERR_DETAIL_EXCEPTION_START + bypassTe.id()); | |
675 | Adaptation::Icap::Xaction::callException(bypassTe); | |
9e008dda | 676 | } catch (const std::exception &bypassE) { |
64b66b76 | 677 | detailError(ERR_DETAIL_EXCEPTION_OTHER); |
26cc52cb | 678 | Adaptation::Icap::Xaction::callException(bypassE); |
478cfe99 | 679 | } |
680 | } | |
681 | ||
26cc52cb | 682 | void Adaptation::Icap::ModXact::bypassFailure() |
478cfe99 | 683 | { |
a22e6cd3 | 684 | disableBypass("already started to bypass", false); |
478cfe99 | 685 | |
686 | Must(!isRetriable); // or we should not be bypassing | |
3ff65596 | 687 | // TODO: should the same be enforced for isRepeatable? Check icap_repeat?? |
478cfe99 | 688 | |
689 | prepEchoing(); | |
690 | ||
691 | startSending(); | |
692 | ||
693 | // end all activities associated with the ICAP server | |
694 | ||
695 | stopParsing(); | |
696 | ||
697 | stopWriting(true); // or should we force it? | |
aed188fd | 698 | if (haveConnection()) { |
478cfe99 | 699 | reuseConnection = false; // be conservative |
700 | cancelRead(); // may not work; and we cannot stop connecting either | |
701 | if (!doneWithIo()) | |
192378eb | 702 | debugs(93, 7, HERE << "Warning: bypass failed to stop I/O" << status()); |
478cfe99 | 703 | } |
61cb3565 AR |
704 | |
705 | service().noteFailure(); // we are bypassing, but this is still a failure | |
478cfe99 | 706 | } |
707 | ||
a22e6cd3 | 708 | void Adaptation::Icap::ModXact::disableBypass(const char *reason, bool includingGroupBypass) |
478cfe99 | 709 | { |
710 | if (canStartBypass) { | |
711 | debugs(93,7, HERE << "will never start bypass because " << reason); | |
712 | canStartBypass = false; | |
713 | } | |
a22e6cd3 AR |
714 | if (protectGroupBypass && includingGroupBypass) { |
715 | debugs(93,7, HERE << "not protecting group bypass because " << reason); | |
716 | protectGroupBypass = false; | |
717 | } | |
478cfe99 | 718 | } |
719 | ||
774c051c | 720 | // note that allocation for echoing is done in handle204NoContent() |
26cc52cb | 721 | void Adaptation::Icap::ModXact::maybeAllocateHttpMsg() |
774c051c | 722 | { |
5f8252d2 | 723 | if (adapted.header) // already allocated |
774c051c | 724 | return; |
725 | ||
726 | if (gotEncapsulated("res-hdr")) { | |
5f8252d2 | 727 | adapted.setHeader(new HttpReply); |
3ff65596 | 728 | setOutcome(service().cfg().method == ICAP::methodReqmod ? |
e1381638 | 729 | xoSatisfied : xoModified); |
774c051c | 730 | } else if (gotEncapsulated("req-hdr")) { |
5f8252d2 | 731 | adapted.setHeader(new HttpRequest); |
3ff65596 | 732 | setOutcome(xoModified); |
774c051c | 733 | } else |
734 | throw TexcHere("Neither res-hdr nor req-hdr in maybeAllocateHttpMsg()"); | |
735 | } | |
736 | ||
26cc52cb | 737 | void Adaptation::Icap::ModXact::parseHeaders() |
774c051c | 738 | { |
739 | Must(state.parsingHeaders()); | |
740 | ||
b107a5a5 | 741 | if (state.parsing == State::psIcapHeader) { |
742 | debugs(93, 5, HERE << "parse ICAP headers"); | |
774c051c | 743 | parseIcapHead(); |
b107a5a5 | 744 | } |
774c051c | 745 | |
b107a5a5 | 746 | if (state.parsing == State::psHttpHeader) { |
747 | debugs(93, 5, HERE << "parse HTTP headers"); | |
774c051c | 748 | parseHttpHead(); |
b107a5a5 | 749 | } |
774c051c | 750 | |
751 | if (state.parsingHeaders()) { // need more data | |
752 | Must(mayReadMore()); | |
753 | return; | |
754 | } | |
755 | ||
478cfe99 | 756 | startSending(); |
757 | } | |
758 | ||
759 | // called after parsing all headers or when bypassing an exception | |
26cc52cb | 760 | void Adaptation::Icap::ModXact::startSending() |
478cfe99 | 761 | { |
3ff65596 | 762 | disableRepeats("sent headers"); |
a22e6cd3 | 763 | disableBypass("sent headers", true); |
3af10ac0 | 764 | sendAnswer(Answer::Forward(adapted.header)); |
774c051c | 765 | |
766 | if (state.sending == State::sendingVirgin) | |
767 | echoMore(); | |
768 | } | |
769 | ||
26cc52cb | 770 | void Adaptation::Icap::ModXact::parseIcapHead() |
774c051c | 771 | { |
772 | Must(state.sending == State::sendingUndecided); | |
773 | ||
b248c2a3 | 774 | if (!parseHead(icapReply.getRaw())) |
774c051c | 775 | return; |
776 | ||
fc764d26 | 777 | if (httpHeaderHasConnDir(&icapReply->header, "close")) { |
778 | debugs(93, 5, HERE << "found connection close"); | |
779 | reuseConnection = false; | |
780 | } | |
781 | ||
9b769c67 | 782 | switch (icapReply->sline.status()) { |
774c051c | 783 | |
9b769c67 | 784 | case Http::scContinue: |
774c051c | 785 | handle100Continue(); |
786 | break; | |
787 | ||
9b769c67 AJ |
788 | case Http::scOkay: |
789 | case Http::scCreated: // Symantec Scan Engine 5.0 and later when modifying HTTP msg | |
b559db5d | 790 | |
791 | if (!validate200Ok()) { | |
792 | throw TexcHere("Invalid ICAP Response"); | |
793 | } else { | |
794 | handle200Ok(); | |
795 | } | |
796 | ||
774c051c | 797 | break; |
798 | ||
9b769c67 | 799 | case Http::scNoContent: |
774c051c | 800 | handle204NoContent(); |
801 | break; | |
802 | ||
9b769c67 | 803 | case Http::scPartialContent: |
83c51da9 CT |
804 | handle206PartialContent(); |
805 | break; | |
806 | ||
774c051c | 807 | default: |
9b769c67 | 808 | debugs(93, 5, "ICAP status " << icapReply->sline.status()); |
774c051c | 809 | handleUnknownScode(); |
810 | break; | |
811 | } | |
812 | ||
3ff65596 AR |
813 | const HttpRequest *request = dynamic_cast<HttpRequest*>(adapted.header); |
814 | if (!request) | |
815 | request = &virginRequest(); | |
816 | ||
817 | // update the cross-transactional database if needed (all status codes!) | |
818 | if (const char *xxName = Adaptation::Config::masterx_shared_name) { | |
a22e6cd3 | 819 | Adaptation::History::Pointer ah = request->adaptHistory(true); |
5038f9d8 | 820 | if (ah != NULL) { // TODO: reorder checks to avoid creating history |
3ff65596 AR |
821 | const String val = icapReply->header.getByName(xxName); |
822 | if (val.size() > 0) // XXX: HttpHeader lacks empty value detection | |
823 | ah->updateXxRecord(xxName, val); | |
824 | } | |
825 | } | |
826 | ||
a22e6cd3 AR |
827 | // update the adaptation plan if needed (all status codes!) |
828 | if (service().cfg().routing) { | |
829 | String services; | |
830 | if (icapReply->header.getList(HDR_X_NEXT_SERVICES, &services)) { | |
831 | Adaptation::History::Pointer ah = request->adaptHistory(true); | |
832 | if (ah != NULL) | |
833 | ah->updateNextServices(services); | |
834 | } | |
835 | } // TODO: else warn (occasionally!) if we got HDR_X_NEXT_SERVICES | |
836 | ||
3ff65596 AR |
837 | // We need to store received ICAP headers for <icapLastHeader logformat option. |
838 | // If we already have stored headers from previous ICAP transaction related to this | |
839 | // request, old headers will be replaced with the new one. | |
e1381638 | 840 | |
5038f9d8 AR |
841 | Adaptation::History::Pointer ah = request->adaptLogHistory(); |
842 | if (ah != NULL) | |
843 | ah->recordMeta(&icapReply->header); | |
3ff65596 | 844 | |
774c051c | 845 | // handle100Continue() manages state.writing on its own. |
846 | // Non-100 status means the server needs no postPreview data from us. | |
847 | if (state.writing == State::writingPaused) | |
c99de607 | 848 | stopWriting(true); |
774c051c | 849 | } |
850 | ||
26cc52cb | 851 | bool Adaptation::Icap::ModXact::validate200Ok() |
b559db5d | 852 | { |
0bef8dd7 | 853 | if (ICAP::methodRespmod == service().cfg().method) { |
b559db5d | 854 | if (!gotEncapsulated("res-hdr")) |
855 | return false; | |
856 | ||
857 | return true; | |
858 | } | |
859 | ||
0bef8dd7 | 860 | if (ICAP::methodReqmod == service().cfg().method) { |
b559db5d | 861 | if (!gotEncapsulated("res-hdr") && !gotEncapsulated("req-hdr")) |
862 | return false; | |
863 | ||
864 | return true; | |
865 | } | |
866 | ||
867 | return false; | |
868 | } | |
869 | ||
26cc52cb | 870 | void Adaptation::Icap::ModXact::handle100Continue() |
774c051c | 871 | { |
872 | Must(state.writing == State::writingPaused); | |
5f8252d2 | 873 | // server must not respond before the end of preview: we may send ieof |
774c051c | 874 | Must(preview.enabled() && preview.done() && !preview.ieof()); |
774c051c | 875 | |
83c51da9 CT |
876 | // 100 "Continue" cancels our Preview commitment, |
877 | // but not commitment to handle 204 or 206 outside Preview | |
878 | if (!state.allowedPostview204 && !state.allowedPostview206) | |
774c051c | 879 | stopBackup(); |
880 | ||
c99de607 | 881 | state.parsing = State::psIcapHeader; // eventually |
882 | icapReply->reset(); | |
774c051c | 883 | |
884 | state.writing = State::writingPrime; | |
885 | ||
886 | writeMore(); | |
887 | } | |
888 | ||
26cc52cb | 889 | void Adaptation::Icap::ModXact::handle200Ok() |
774c051c | 890 | { |
891 | state.parsing = State::psHttpHeader; | |
892 | state.sending = State::sendingAdapted; | |
893 | stopBackup(); | |
5f8252d2 | 894 | checkConsuming(); |
774c051c | 895 | } |
896 | ||
26cc52cb | 897 | void Adaptation::Icap::ModXact::handle204NoContent() |
774c051c | 898 | { |
899 | stopParsing(); | |
478cfe99 | 900 | prepEchoing(); |
901 | } | |
902 | ||
83c51da9 CT |
903 | void Adaptation::Icap::ModXact::handle206PartialContent() |
904 | { | |
905 | if (state.writing == State::writingPaused) { | |
906 | Must(preview.enabled()); | |
907 | Must(state.allowedPreview206); | |
908 | debugs(93, 7, HERE << "206 inside preview"); | |
909 | } else { | |
910 | Must(state.writing > State::writingPaused); | |
911 | Must(state.allowedPostview206); | |
912 | debugs(93, 7, HERE << "206 outside preview"); | |
913 | } | |
914 | state.parsing = State::psHttpHeader; | |
915 | state.sending = State::sendingAdapted; | |
916 | state.readyForUob = true; | |
917 | checkConsuming(); | |
918 | } | |
919 | ||
478cfe99 | 920 | // Called when we receive a 204 No Content response and |
921 | // when we are trying to bypass a service failure. | |
922 | // We actually start sending (echoig or not) in startSending. | |
26cc52cb | 923 | void Adaptation::Icap::ModXact::prepEchoing() |
478cfe99 | 924 | { |
3ff65596 | 925 | disableRepeats("preparing to echo content"); |
a22e6cd3 | 926 | disableBypass("preparing to echo content", true); |
3ff65596 | 927 | setOutcome(xoEcho); |
774c051c | 928 | |
929 | // We want to clone the HTTP message, but we do not want | |
5f8252d2 | 930 | // to copy some non-HTTP state parts that HttpMsg kids carry in them. |
774c051c | 931 | // Thus, we cannot use a smart pointer, copy constructor, or equivalent. |
932 | // Instead, we simply write the HTTP message and "clone" it by parsing. | |
a22e6cd3 | 933 | // TODO: use HttpMsg::clone()! |
774c051c | 934 | |
5f8252d2 | 935 | HttpMsg *oldHead = virgin.header; |
192378eb | 936 | debugs(93, 7, HERE << "cloning virgin message " << oldHead); |
774c051c | 937 | |
938 | MemBuf httpBuf; | |
939 | ||
940 | // write the virgin message into a memory buffer | |
941 | httpBuf.init(); | |
942 | packHead(httpBuf, oldHead); | |
943 | ||
c99de607 | 944 | // allocate the adapted message and copy metainfo |
5f8252d2 | 945 | Must(!adapted.header); |
c7d51c86 | 946 | { |
e6f9e263 | 947 | HttpMsg::Pointer newHead; |
73a805c2 | 948 | if (dynamic_cast<const HttpRequest*>(oldHead)) { |
b248c2a3 | 949 | newHead = new HttpRequest; |
e6f9e263 A |
950 | } else if (dynamic_cast<const HttpReply*>(oldHead)) { |
951 | newHead = new HttpReply; | |
952 | } | |
953 | Must(newHead != NULL); | |
774c051c | 954 | |
e6f9e263 | 955 | newHead->inheritProperties(oldHead); |
774c051c | 956 | |
b248c2a3 | 957 | adapted.setHeader(newHead.getRaw()); |
c7d51c86 | 958 | } |
7514268e | 959 | |
774c051c | 960 | // parse the buffer back |
955394ce | 961 | Http::StatusCode error = Http::scNone; |
774c051c | 962 | |
c7d51c86 | 963 | Must(adapted.header->parse(&httpBuf, true, &error)); |
774c051c | 964 | |
73a805c2 CT |
965 | if (HttpRequest *r = dynamic_cast<HttpRequest*>(adapted.header)) |
966 | urlCanonical(r); // parse does not set HttpRequest::canonical | |
967 | ||
c7d51c86 | 968 | Must(adapted.header->hdr_sz == httpBuf.contentSize()); // no leftovers |
774c051c | 969 | |
970 | httpBuf.clean(); | |
971 | ||
192378eb | 972 | debugs(93, 7, HERE << "cloned virgin message " << oldHead << " to " << |
c7d51c86 | 973 | adapted.header); |
5f8252d2 | 974 | |
975 | // setup adapted body pipe if needed | |
976 | if (oldHead->body_pipe != NULL) { | |
977 | debugs(93, 7, HERE << "will echo virgin body from " << | |
9e008dda | 978 | oldHead->body_pipe); |
478cfe99 | 979 | if (!virginBodySending.active()) |
980 | virginBodySending.plan(); // will throw if not possible | |
5f8252d2 | 981 | state.sending = State::sendingVirgin; |
982 | checkConsuming(); | |
478cfe99 | 983 | |
5f8252d2 | 984 | // TODO: optimize: is it possible to just use the oldHead pipe and |
985 | // remove ICAP from the loop? This echoing is probably a common case! | |
986 | makeAdaptedBodyPipe("echoed virgin response"); | |
987 | if (oldHead->body_pipe->bodySizeKnown()) | |
988 | adapted.body_pipe->setBodySize(oldHead->body_pipe->bodySize()); | |
989 | debugs(93, 7, HERE << "will echo virgin body to " << | |
9e008dda | 990 | adapted.body_pipe); |
5f8252d2 | 991 | } else { |
992 | debugs(93, 7, HERE << "no virgin body to echo"); | |
993 | stopSending(true); | |
994 | } | |
774c051c | 995 | } |
996 | ||
83c51da9 CT |
997 | /// Called when we received use-original-body chunk extension in 206 response. |
998 | /// We actually start sending (echoing or not) in startSending(). | |
999 | void Adaptation::Icap::ModXact::prepPartialBodyEchoing(uint64_t pos) | |
1000 | { | |
1001 | Must(virginBodySending.active()); | |
1002 | Must(virgin.header->body_pipe != NULL); | |
1003 | ||
1004 | setOutcome(xoPartEcho); | |
1005 | ||
1006 | debugs(93, 7, HERE << "will echo virgin body suffix from " << | |
1007 | virgin.header->body_pipe << " offset " << pos ); | |
1008 | ||
1009 | // check that use-original-body=N does not point beyond buffered data | |
1010 | const uint64_t virginDataEnd = virginConsumed + | |
7ddcfbab | 1011 | virgin.body_pipe->buf().contentSize(); |
83c51da9 CT |
1012 | Must(pos <= virginDataEnd); |
1013 | virginBodySending.progress(static_cast<size_t>(pos)); | |
1014 | ||
1015 | state.sending = State::sendingVirgin; | |
1016 | checkConsuming(); | |
1017 | ||
1018 | if (virgin.header->body_pipe->bodySizeKnown()) | |
1019 | adapted.body_pipe->expectProductionEndAfter(virgin.header->body_pipe->bodySize() - pos); | |
1020 | ||
1021 | debugs(93, 7, HERE << "will echo virgin body suffix to " << | |
1022 | adapted.body_pipe); | |
1023 | ||
1024 | // Start echoing data | |
1025 | echoMore(); | |
1026 | } | |
1027 | ||
26cc52cb | 1028 | void Adaptation::Icap::ModXact::handleUnknownScode() |
774c051c | 1029 | { |
1030 | stopParsing(); | |
1031 | stopBackup(); | |
1032 | // TODO: mark connection as "bad" | |
1033 | ||
1034 | // Terminate the transaction; we do not know how to handle this response. | |
1035 | throw TexcHere("Unsupported ICAP status code"); | |
1036 | } | |
1037 | ||
26cc52cb | 1038 | void Adaptation::Icap::ModXact::parseHttpHead() |
774c051c | 1039 | { |
1040 | if (gotEncapsulated("res-hdr") || gotEncapsulated("req-hdr")) { | |
bae917ac | 1041 | replyHttpHeaderSize = 0; |
774c051c | 1042 | maybeAllocateHttpMsg(); |
1043 | ||
5f8252d2 | 1044 | if (!parseHead(adapted.header)) |
c99de607 | 1045 | return; // need more header data |
5f8252d2 | 1046 | |
bae917ac CT |
1047 | if (adapted.header) |
1048 | replyHttpHeaderSize = adapted.header->hdr_sz; | |
1049 | ||
d67acb4e | 1050 | if (dynamic_cast<HttpRequest*>(adapted.header)) { |
5f8252d2 | 1051 | const HttpRequest *oldR = dynamic_cast<const HttpRequest*>(virgin.header); |
1052 | Must(oldR); | |
9e008dda AJ |
1053 | // TODO: the adapted request did not really originate from the |
1054 | // client; give proxy admin an option to prevent copying of | |
5f8252d2 | 1055 | // sensitive client information here. See the following thread: |
1056 | // http://www.squid-cache.org/mail-archive/squid-dev/200703/0040.html | |
5f8252d2 | 1057 | } |
d67acb4e | 1058 | |
9e008dda AJ |
1059 | // Maybe adapted.header==NULL if HttpReply and have Http 0.9 .... |
1060 | if (adapted.header) | |
1061 | adapted.header->inheritProperties(virgin.header); | |
774c051c | 1062 | } |
1063 | ||
5f8252d2 | 1064 | decideOnParsingBody(); |
774c051c | 1065 | } |
1066 | ||
c99de607 | 1067 | // parses both HTTP and ICAP headers |
26cc52cb | 1068 | bool Adaptation::Icap::ModXact::parseHead(HttpMsg *head) |
774c051c | 1069 | { |
c99de607 | 1070 | Must(head); |
def17b6a | 1071 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " head bytes to parse" << |
774c051c | 1072 | "; state: " << state.parsing); |
1073 | ||
955394ce | 1074 | Http::StatusCode error = Http::scNone; |
774c051c | 1075 | const bool parsed = head->parse(&readBuf, commEof, &error); |
1076 | Must(parsed || !error); // success or need more data | |
1077 | ||
c99de607 | 1078 | if (!parsed) { // need more data |
b107a5a5 | 1079 | debugs(93, 5, HERE << "parse failed, need more data, return false"); |
774c051c | 1080 | head->reset(); |
1081 | return false; | |
1082 | } | |
1083 | ||
a22e6cd3 AR |
1084 | if (HttpRequest *r = dynamic_cast<HttpRequest*>(head)) |
1085 | urlCanonical(r); // parse does not set HttpRequest::canonical | |
1086 | ||
b107a5a5 | 1087 | debugs(93, 5, HERE << "parse success, consume " << head->hdr_sz << " bytes, return true"); |
774c051c | 1088 | readBuf.consume(head->hdr_sz); |
1089 | return true; | |
1090 | } | |
1091 | ||
26cc52cb | 1092 | void Adaptation::Icap::ModXact::decideOnParsingBody() |
9e008dda | 1093 | { |
200ac359 | 1094 | if (gotEncapsulated("res-body") || gotEncapsulated("req-body")) { |
5f8252d2 | 1095 | debugs(93, 5, HERE << "expecting a body"); |
1096 | state.parsing = State::psBody; | |
bae917ac | 1097 | replyHttpBodySize = 0; |
5f8252d2 | 1098 | bodyParser = new ChunkedCodingParser; |
1099 | makeAdaptedBodyPipe("adapted response from the ICAP server"); | |
1100 | Must(state.sending == State::sendingAdapted); | |
774c051c | 1101 | } else { |
b559db5d | 1102 | debugs(93, 5, HERE << "not expecting a body"); |
5f8252d2 | 1103 | stopParsing(); |
1104 | stopSending(true); | |
774c051c | 1105 | } |
774c051c | 1106 | } |
1107 | ||
26cc52cb | 1108 | void Adaptation::Icap::ModXact::parseBody() |
774c051c | 1109 | { |
5f8252d2 | 1110 | Must(state.parsing == State::psBody); |
1111 | Must(bodyParser); | |
774c051c | 1112 | |
5f8252d2 | 1113 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " body bytes to parse"); |
774c051c | 1114 | |
5f8252d2 | 1115 | // the parser will throw on errors |
1116 | BodyPipeCheckout bpc(*adapted.body_pipe); | |
1117 | const bool parsed = bodyParser->parse(&readBuf, &bpc.buf); | |
1118 | bpc.checkIn(); | |
774c051c | 1119 | |
aa761e5f | 1120 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " body bytes after " << |
774c051c | 1121 | "parse; parsed all: " << parsed); |
bae917ac | 1122 | replyHttpBodySize += adapted.body_pipe->buf().contentSize(); |
774c051c | 1123 | |
478cfe99 | 1124 | // TODO: expose BodyPipe::putSize() to make this check simpler and clearer |
3ff65596 AR |
1125 | // TODO: do we really need this if we disable when sending headers? |
1126 | if (adapted.body_pipe->buf().contentSize() > 0) { // parsed something sometime | |
1127 | disableRepeats("sent adapted content"); | |
a22e6cd3 | 1128 | disableBypass("sent adapted content", true); |
3ff65596 | 1129 | } |
478cfe99 | 1130 | |
5f8252d2 | 1131 | if (parsed) { |
83c51da9 CT |
1132 | if (state.readyForUob && bodyParser->useOriginBody >= 0) { |
1133 | prepPartialBodyEchoing( | |
1134 | static_cast<uint64_t>(bodyParser->useOriginBody)); | |
1135 | stopParsing(); | |
1136 | return; | |
1137 | } | |
1138 | ||
5f8252d2 | 1139 | stopParsing(); |
1140 | stopSending(true); // the parser succeeds only if all parsed data fits | |
1141 | return; | |
1142 | } | |
774c051c | 1143 | |
c99de607 | 1144 | debugs(93,3,HERE << this << " needsMoreData = " << bodyParser->needsMoreData()); |
3b299123 | 1145 | |
1146 | if (bodyParser->needsMoreData()) { | |
c99de607 | 1147 | debugs(93,3,HERE << this); |
774c051c | 1148 | Must(mayReadMore()); |
3b299123 | 1149 | readMore(); |
1150 | } | |
774c051c | 1151 | |
1152 | if (bodyParser->needsMoreSpace()) { | |
1153 | Must(!doneSending()); // can hope for more space | |
5f8252d2 | 1154 | Must(adapted.body_pipe->buf().contentSize() > 0); // paranoid |
1155 | // TODO: there should be a timeout in case the sink is broken | |
1156 | // or cannot consume partial content (while we need more space) | |
774c051c | 1157 | } |
774c051c | 1158 | } |
1159 | ||
26cc52cb | 1160 | void Adaptation::Icap::ModXact::stopParsing() |
774c051c | 1161 | { |
1162 | if (state.parsing == State::psDone) | |
1163 | return; | |
1164 | ||
192378eb | 1165 | debugs(93, 7, HERE << "will no longer parse" << status()); |
774c051c | 1166 | |
1167 | delete bodyParser; | |
1168 | ||
1169 | bodyParser = NULL; | |
1170 | ||
1171 | state.parsing = State::psDone; | |
1172 | } | |
1173 | ||
1174 | // HTTP side added virgin body data | |
26cc52cb | 1175 | void Adaptation::Icap::ModXact::noteMoreBodyDataAvailable(BodyPipe::Pointer) |
774c051c | 1176 | { |
774c051c | 1177 | writeMore(); |
1178 | ||
1179 | if (state.sending == State::sendingVirgin) | |
1180 | echoMore(); | |
774c051c | 1181 | } |
1182 | ||
1183 | // HTTP side sent us all virgin info | |
26cc52cb | 1184 | void Adaptation::Icap::ModXact::noteBodyProductionEnded(BodyPipe::Pointer) |
774c051c | 1185 | { |
5f8252d2 | 1186 | Must(virgin.body_pipe->productionEnded()); |
774c051c | 1187 | |
1188 | // push writer and sender in case we were waiting for the last-chunk | |
1189 | writeMore(); | |
1190 | ||
1191 | if (state.sending == State::sendingVirgin) | |
1192 | echoMore(); | |
774c051c | 1193 | } |
1194 | ||
9e008dda | 1195 | // body producer aborted, but the initiator may still want to know |
585ab260 | 1196 | // the answer, even though the HTTP message has been truncated |
26cc52cb | 1197 | void Adaptation::Icap::ModXact::noteBodyProducerAborted(BodyPipe::Pointer) |
774c051c | 1198 | { |
585ab260 | 1199 | Must(virgin.body_pipe->productionEnded()); |
1200 | ||
1201 | // push writer and sender in case we were waiting for the last-chunk | |
1202 | writeMore(); | |
1203 | ||
1204 | if (state.sending == State::sendingVirgin) | |
1205 | echoMore(); | |
5f8252d2 | 1206 | } |
1207 | ||
9e008dda | 1208 | // adapted body consumer wants more adapted data and |
5f8252d2 | 1209 | // possibly freed some buffer space |
26cc52cb | 1210 | void Adaptation::Icap::ModXact::noteMoreBodySpaceAvailable(BodyPipe::Pointer) |
774c051c | 1211 | { |
774c051c | 1212 | if (state.sending == State::sendingVirgin) |
1213 | echoMore(); | |
3b299123 | 1214 | else if (state.sending == State::sendingAdapted) |
1215 | parseMore(); | |
774c051c | 1216 | else |
3b299123 | 1217 | Must(state.sending == State::sendingUndecided); |
774c051c | 1218 | } |
1219 | ||
5f8252d2 | 1220 | // adapted body consumer aborted |
26cc52cb | 1221 | void Adaptation::Icap::ModXact::noteBodyConsumerAborted(BodyPipe::Pointer) |
774c051c | 1222 | { |
64b66b76 | 1223 | detailError(ERR_DETAIL_ICAP_XACT_BODY_CONSUMER_ABORT); |
5f8252d2 | 1224 | mustStop("adapted body consumer aborted"); |
774c051c | 1225 | } |
1226 | ||
c7d51c86 AR |
1227 | Adaptation::Icap::ModXact::~ModXact() |
1228 | { | |
1229 | delete bodyParser; | |
1230 | } | |
1231 | ||
774c051c | 1232 | // internal cleanup |
26cc52cb | 1233 | void Adaptation::Icap::ModXact::swanSong() |
774c051c | 1234 | { |
5f8252d2 | 1235 | debugs(93, 5, HERE << "swan sings" << status()); |
1236 | ||
c99de607 | 1237 | stopWriting(false); |
c824c43b | 1238 | stopSending(false); |
774c051c | 1239 | |
64b66b76 CT |
1240 | if (theInitiator.set()) // we have not sent the answer to the initiator |
1241 | detailError(ERR_DETAIL_ICAP_XACT_OTHER); | |
1242 | ||
3ff65596 | 1243 | // update adaptation history if start was called and we reserved a slot |
a22e6cd3 | 1244 | Adaptation::History::Pointer ah = virginRequest().adaptLogHistory(); |
3ff65596 AR |
1245 | if (ah != NULL && adaptHistoryId >= 0) |
1246 | ah->recordXactFinish(adaptHistoryId); | |
774c051c | 1247 | |
26cc52cb | 1248 | Adaptation::Icap::Xaction::swanSong(); |
774c051c | 1249 | } |
1250 | ||
41ebd397 | 1251 | void prepareLogWithRequestDetails(HttpRequest *, AccessLogEntry::Pointer &); |
3ff65596 AR |
1252 | |
1253 | void Adaptation::Icap::ModXact::finalizeLogInfo() | |
1254 | { | |
1255 | HttpRequest * request_ = NULL; | |
3ecb654f | 1256 | HttpRequest * adapted_request_ = NULL; |
3ff65596 | 1257 | HttpReply * reply_ = NULL; |
3ecb654f CT |
1258 | request_ = (virgin.cause? virgin.cause: dynamic_cast<HttpRequest*>(virgin.header)); |
1259 | if (!(adapted_request_ = dynamic_cast<HttpRequest*>(adapted.header))) { | |
1260 | adapted_request_ = request_; | |
3ff65596 AR |
1261 | reply_ = dynamic_cast<HttpReply*>(adapted.header); |
1262 | } | |
1263 | ||
1264 | Adaptation::Icap::History::Pointer h = request_->icapHistory(); | |
e1381638 AJ |
1265 | Must(h != NULL); // ICAPXaction::maybeLog calls only if there is a log |
1266 | al.icp.opcode = ICP_INVALID; | |
1267 | al.url = h->log_uri.termedBuf(); | |
1268 | const Adaptation::Icap::ServiceRep &s = service(); | |
1269 | al.icap.reqMethod = s.cfg().method; | |
3ff65596 | 1270 | |
e1381638 | 1271 | al.cache.caddr = request_->client_addr; |
3ff65596 | 1272 | |
b248c2a3 AJ |
1273 | al.request = request_; |
1274 | HTTPMSGLOCK(al.request); | |
3ecb654f CT |
1275 | al.adapted_request = adapted_request_; |
1276 | HTTPMSGLOCK(al.adapted_request); | |
1277 | ||
b248c2a3 AJ |
1278 | if (reply_) { |
1279 | al.reply = reply_; | |
1280 | HTTPMSGLOCK(al.reply); | |
1281 | } else | |
e1381638 | 1282 | al.reply = NULL; |
3ff65596 | 1283 | |
e1381638 AJ |
1284 | if (h->rfc931.size()) |
1285 | al.cache.rfc931 = h->rfc931.termedBuf(); | |
3ff65596 AR |
1286 | |
1287 | #if USE_SSL | |
e1381638 AJ |
1288 | if (h->ssluser.size()) |
1289 | al.cache.ssluser = h->ssluser.termedBuf(); | |
3ff65596 | 1290 | #endif |
e1381638 | 1291 | al.cache.code = h->logType; |
d6df21d2 AJ |
1292 | // XXX: should use icap-specific counters instead ? |
1293 | al.http.clientRequest.payloadDataSz = h->req_sz; | |
bae917ac CT |
1294 | |
1295 | // leave al.icap.bodyBytesRead negative if no body | |
1296 | if (replyHttpHeaderSize >= 0 || replyHttpBodySize >= 0) { | |
1297 | const int64_t zero = 0; // to make max() argument types the same | |
1298 | al.icap.bodyBytesRead = | |
1299 | max(zero, replyHttpHeaderSize) + max(zero, replyHttpBodySize); | |
1300 | } | |
1301 | ||
e1381638 | 1302 | if (reply_) { |
9b769c67 | 1303 | al.http.code = reply_->sline.status(); |
e1381638 | 1304 | al.http.content_type = reply_->content_type.termedBuf(); |
bae917ac | 1305 | if (replyHttpBodySize >= 0) { |
d6df21d2 AJ |
1306 | // XXX: should use icap-specific counters instead ? |
1307 | al.http.adaptedReply.payloadDataSz = replyHttpBodySize; | |
1308 | al.http.adaptedReply.headerSz = reply_->hdr_sz; | |
bae917ac CT |
1309 | al.cache.highOffset = replyHttpBodySize; |
1310 | } | |
e1381638 AJ |
1311 | //don't set al.cache.objectSize because it hasn't exist yet |
1312 | ||
1313 | Packer p; | |
1314 | MemBuf mb; | |
1315 | ||
1316 | mb.init(); | |
1317 | packerToMemInit(&p, &mb); | |
1318 | ||
1319 | reply_->header.packInto(&p); | |
1320 | al.headers.reply = xstrdup(mb.buf); | |
1321 | ||
1322 | packerClean(&p); | |
1323 | mb.clean(); | |
1324 | } | |
3ecb654f | 1325 | prepareLogWithRequestDetails(adapted_request_, alep); |
e1381638 | 1326 | Xaction::finalizeLogInfo(); |
3ff65596 AR |
1327 | } |
1328 | ||
26cc52cb | 1329 | void Adaptation::Icap::ModXact::makeRequestHeaders(MemBuf &buf) |
774c051c | 1330 | { |
cc192b50 | 1331 | char ntoabuf[MAX_IPSTRLEN]; |
12b91c99 | 1332 | /* |
1333 | * XXX These should use HttpHdr interfaces instead of Printfs | |
1334 | */ | |
0bef8dd7 | 1335 | const Adaptation::ServiceConfig &s = service().cfg(); |
2c1fd837 | 1336 | buf.Printf("%s " SQUIDSTRINGPH " ICAP/1.0\r\n", s.methodStr(), SQUIDSTRINGPRINT(s.uri)); |
826a1fed | 1337 | buf.Printf("Host: " SQUIDSTRINGPH ":%d\r\n", SQUIDSTRINGPRINT(s.host), s.port); |
12b91c99 | 1338 | buf.Printf("Date: %s\r\n", mkrfc1123(squid_curtime)); |
1339 | ||
26cc52cb | 1340 | if (!TheConfig.reuse_connections) |
12b91c99 | 1341 | buf.Printf("Connection: close\r\n"); |
1342 | ||
cb72cd25 CT |
1343 | const HttpRequest *request = &virginRequest(); |
1344 | ||
2cdeea82 | 1345 | // we must forward "Proxy-Authenticate" and "Proxy-Authorization" |
1346 | // as ICAP headers. | |
4232c626 FC |
1347 | if (virgin.header->header.has(HDR_PROXY_AUTHENTICATE)) { |
1348 | String vh=virgin.header->header.getByName("Proxy-Authenticate"); | |
826a1fed | 1349 | buf.Printf("Proxy-Authenticate: " SQUIDSTRINGPH "\r\n",SQUIDSTRINGPRINT(vh)); |
4232c626 | 1350 | } |
9e008dda | 1351 | |
4232c626 FC |
1352 | if (virgin.header->header.has(HDR_PROXY_AUTHORIZATION)) { |
1353 | String vh=virgin.header->header.getByName("Proxy-Authorization"); | |
826a1fed | 1354 | buf.Printf("Proxy-Authorization: " SQUIDSTRINGPH "\r\n", SQUIDSTRINGPRINT(vh)); |
cb72cd25 | 1355 | } else if (request->extacl_user.defined() && request->extacl_user.size() && request->extacl_passwd.defined() && request->extacl_passwd.size()) { |
8661a1d0 A |
1356 | char loginbuf[256]; |
1357 | snprintf(loginbuf, sizeof(loginbuf), SQUIDSTRINGPH ":" SQUIDSTRINGPH, | |
1358 | SQUIDSTRINGPRINT(request->extacl_user), | |
1359 | SQUIDSTRINGPRINT(request->extacl_passwd)); | |
1360 | buf.Printf("Proxy-Authorization: Basic %s\r\n", old_base64_encode(loginbuf)); | |
4232c626 | 1361 | } |
2cdeea82 | 1362 | |
3ff65596 AR |
1363 | // share the cross-transactional database records if needed |
1364 | if (Adaptation::Config::masterx_shared_name) { | |
ba8a478d | 1365 | Adaptation::History::Pointer ah = request->adaptHistory(false); |
3ff65596 AR |
1366 | if (ah != NULL) { |
1367 | String name, value; | |
1368 | if (ah->getXxRecord(name, value)) { | |
e1381638 AJ |
1369 | buf.Printf(SQUIDSTRINGPH ": " SQUIDSTRINGPH "\r\n", |
1370 | SQUIDSTRINGPRINT(name), SQUIDSTRINGPRINT(value)); | |
3ff65596 AR |
1371 | } |
1372 | } | |
1373 | } | |
e1381638 | 1374 | |
774c051c | 1375 | buf.Printf("Encapsulated: "); |
1376 | ||
1377 | MemBuf httpBuf; | |
12b91c99 | 1378 | |
774c051c | 1379 | httpBuf.init(); |
1380 | ||
1381 | // build HTTP request header, if any | |
1382 | ICAP::Method m = s.method; | |
1383 | ||
5f8252d2 | 1384 | // to simplify, we could assume that request is always available |
c99de607 | 1385 | |
30abd221 | 1386 | String urlPath; |
c99de607 | 1387 | if (request) { |
1388 | urlPath = request->urlpath; | |
1389 | if (ICAP::methodRespmod == m) | |
1390 | encapsulateHead(buf, "req-hdr", httpBuf, request); | |
e1381638 AJ |
1391 | else if (ICAP::methodReqmod == m) |
1392 | encapsulateHead(buf, "req-hdr", httpBuf, virgin.header); | |
c99de607 | 1393 | } |
774c051c | 1394 | |
1395 | if (ICAP::methodRespmod == m) | |
5f8252d2 | 1396 | if (const HttpMsg *prime = virgin.header) |
774c051c | 1397 | encapsulateHead(buf, "res-hdr", httpBuf, prime); |
1398 | ||
1399 | if (!virginBody.expected()) | |
1dd6edf2 | 1400 | buf.Printf("null-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1401 | else if (ICAP::methodReqmod == m) |
1dd6edf2 | 1402 | buf.Printf("req-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1403 | else |
1dd6edf2 | 1404 | buf.Printf("res-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1405 | |
1406 | buf.append(ICAP::crlf, 2); // terminate Encapsulated line | |
1407 | ||
c824c43b | 1408 | if (preview.enabled()) { |
774c051c | 1409 | buf.Printf("Preview: %d\r\n", (int)preview.ad()); |
83c51da9 | 1410 | if (!virginBody.expected()) // there is no body to preview |
5f8252d2 | 1411 | finishNullOrEmptyBodyPreview(httpBuf); |
774c051c | 1412 | } |
1413 | ||
83c51da9 | 1414 | makeAllowHeader(buf); |
774c051c | 1415 | |
a9044668 | 1416 | if (TheConfig.send_client_ip && request) { |
b7ac5457 | 1417 | Ip::Address client_addr; |
57d76dd4 | 1418 | #if FOLLOW_X_FORWARDED_FOR |
22fff3bf | 1419 | if (TheConfig.use_indirect_client) { |
a9044668 A |
1420 | client_addr = request->indirect_client_addr; |
1421 | } else | |
57d76dd4 | 1422 | #endif |
a9044668 | 1423 | client_addr = request->client_addr; |
4dd643d5 AJ |
1424 | if (!client_addr.isAnyAddr() && !client_addr.isNoAddr()) |
1425 | buf.Printf("X-Client-IP: %s\r\n", client_addr.toStr(ntoabuf,MAX_IPSTRLEN)); | |
57d76dd4 | 1426 | } |
a97e82a8 | 1427 | |
22fff3bf | 1428 | if (TheConfig.send_username && request) |
5f8252d2 | 1429 | makeUsernameHeader(request, buf); |
a97e82a8 | 1430 | |
71be37e0 | 1431 | // Adaptation::Config::metaHeaders |
d7f4a0b7 | 1432 | typedef Notes::iterator ACAMLI; |
71ee0835 | 1433 | for (ACAMLI i = Adaptation::Config::metaHeaders.begin(); i != Adaptation::Config::metaHeaders.end(); ++i) { |
71be37e0 | 1434 | HttpRequest *r = virgin.cause ? |
71ee0835 | 1435 | virgin.cause : dynamic_cast<HttpRequest*>(virgin.header); |
71be37e0 CT |
1436 | Must(r); |
1437 | ||
1438 | HttpReply *reply = dynamic_cast<HttpReply*>(virgin.header); | |
1439 | ||
d7f4a0b7 CT |
1440 | if (const char *value = (*i)->match(r, reply)) { |
1441 | buf.Printf("%s: %s\r\n", (*i)->key.termedBuf(), value); | |
1442 | Adaptation::History::Pointer ah = request->adaptHistory(false); | |
cf9f0261 CT |
1443 | if (ah != NULL) { |
1444 | if (ah->metaHeaders == NULL) | |
1445 | ah->metaHeaders = new NotePairs; | |
1446 | if (!ah->metaHeaders->hasPair((*i)->key.termedBuf(), value)) | |
1447 | ah->metaHeaders->add((*i)->key.termedBuf(), value); | |
1448 | } | |
d7f4a0b7 | 1449 | } |
71be37e0 CT |
1450 | } |
1451 | ||
bb790702 | 1452 | // fprintf(stderr, "%s\n", buf.content()); |
a97e82a8 | 1453 | |
774c051c | 1454 | buf.append(ICAP::crlf, 2); // terminate ICAP header |
1455 | ||
a22e6cd3 AR |
1456 | // fill icapRequest for logging |
1457 | Must(icapRequest->parseCharBuf(buf.content(), buf.contentSize())); | |
1458 | ||
774c051c | 1459 | // start ICAP request body with encapsulated HTTP headers |
1460 | buf.append(httpBuf.content(), httpBuf.contentSize()); | |
1461 | ||
1462 | httpBuf.clean(); | |
1463 | } | |
1464 | ||
83c51da9 CT |
1465 | // decides which Allow values to write and updates the request buffer |
1466 | void Adaptation::Icap::ModXact::makeAllowHeader(MemBuf &buf) | |
1467 | { | |
1468 | const bool allow204in = preview.enabled(); // TODO: add shouldAllow204in() | |
1469 | const bool allow204out = state.allowedPostview204 = shouldAllow204(); | |
1470 | const bool allow206in = state.allowedPreview206 = shouldAllow206in(); | |
1471 | const bool allow206out = state.allowedPostview206 = shouldAllow206out(); | |
1472 | ||
1473 | debugs(93,9, HERE << "Allows: " << allow204in << allow204out << | |
7ddcfbab | 1474 | allow206in << allow206out); |
83c51da9 CT |
1475 | |
1476 | const bool allow204 = allow204in || allow204out; | |
1477 | const bool allow206 = allow206in || allow206out; | |
1478 | ||
1479 | if (!allow204 && !allow206) | |
1480 | return; // nothing to do | |
1481 | ||
1482 | if (virginBody.expected()) // if there is a virgin body, plan to send it | |
1483 | virginBodySending.plan(); | |
1484 | ||
1485 | // writing Preview:... means we will honor 204 inside preview | |
1486 | // writing Allow/204 means we will honor 204 outside preview | |
1487 | // writing Allow:206 means we will honor 206 inside preview | |
1488 | // writing Allow:204,206 means we will honor 206 outside preview | |
1489 | const char *allowHeader = NULL; | |
1490 | if (allow204out && allow206) | |
1491 | allowHeader = "Allow: 204, 206\r\n"; | |
1492 | else if (allow204out) | |
1493 | allowHeader = "Allow: 204\r\n"; | |
1494 | else if (allow206) | |
1495 | allowHeader = "Allow: 206\r\n"; | |
7ddcfbab | 1496 | |
83c51da9 CT |
1497 | if (allowHeader) { // may be nil if only allow204in is true |
1498 | buf.append(allowHeader, strlen(allowHeader)); | |
1499 | debugs(93,5, HERE << "Will write " << allowHeader); | |
1500 | } | |
1501 | } | |
1502 | ||
26cc52cb | 1503 | void Adaptation::Icap::ModXact::makeUsernameHeader(const HttpRequest *request, MemBuf &buf) |
9e008dda | 1504 | { |
74f6c040 | 1505 | #if USE_AUTH |
a33a428a | 1506 | if (request->auth_user_request != NULL) { |
9b275e99 | 1507 | char const *name = request->auth_user_request->username(); |
a33a428a | 1508 | if (name) { |
8bdd0cec | 1509 | const char *value = TheConfig.client_username_encode ? old_base64_encode(name) : name; |
a33a428a | 1510 | buf.Printf("%s: %s\r\n", TheConfig.client_username_header, value); |
5f8252d2 | 1511 | } |
cb72cd25 CT |
1512 | } else if (request->extacl_user.defined() && request->extacl_user.size()) { |
1513 | const char *value = TheConfig.client_username_encode ? old_base64_encode(request->extacl_user.termedBuf()) : request->extacl_user.termedBuf(); | |
1514 | buf.Printf("%s: %s\r\n", TheConfig.client_username_header, value); | |
5f8252d2 | 1515 | } |
74f6c040 | 1516 | #endif |
5f8252d2 | 1517 | } |
1518 | ||
26cc52cb | 1519 | void Adaptation::Icap::ModXact::encapsulateHead(MemBuf &icapBuf, const char *section, MemBuf &httpBuf, const HttpMsg *head) |
774c051c | 1520 | { |
1521 | // update ICAP header | |
7cab7e9f | 1522 | icapBuf.Printf("%s=%d, ", section, (int) httpBuf.contentSize()); |
774c051c | 1523 | |
2cdeea82 | 1524 | // begin cloning |
c7d51c86 | 1525 | HttpMsg::Pointer headClone; |
9e008dda | 1526 | |
2cdeea82 | 1527 | if (const HttpRequest* old_request = dynamic_cast<const HttpRequest*>(head)) { |
c7d51c86 AR |
1528 | HttpRequest::Pointer new_request(new HttpRequest); |
1529 | Must(old_request->canonical); | |
b248c2a3 | 1530 | urlParse(old_request->method, old_request->canonical, new_request.getRaw()); |
2cdeea82 | 1531 | new_request->http_ver = old_request->http_ver; |
b248c2a3 | 1532 | headClone = new_request.getRaw(); |
9e008dda | 1533 | } else if (const HttpReply *old_reply = dynamic_cast<const HttpReply*>(head)) { |
c7d51c86 | 1534 | HttpReply::Pointer new_reply(new HttpReply); |
2cdeea82 | 1535 | new_reply->sline = old_reply->sline; |
b248c2a3 | 1536 | headClone = new_reply.getRaw(); |
2cdeea82 | 1537 | } |
c7d51c86 | 1538 | Must(headClone != NULL); |
d67acb4e | 1539 | headClone->inheritProperties(head); |
9e008dda | 1540 | |
2cdeea82 | 1541 | HttpHeaderPos pos = HttpHeaderInitPos; |
1542 | HttpHeaderEntry* p_head_entry = NULL; | |
1543 | while (NULL != (p_head_entry = head->header.getEntry(&pos)) ) | |
1544 | headClone->header.addEntry(p_head_entry->clone()); | |
1545 | ||
1546 | // end cloning | |
9e008dda | 1547 | |
2cdeea82 | 1548 | // remove all hop-by-hop headers from the clone |
dcf3665b | 1549 | headClone->header.delById(HDR_PROXY_AUTHENTICATE); |
2cdeea82 | 1550 | headClone->header.removeHopByHopEntries(); |
1551 | ||
1552 | // pack polished HTTP header | |
b248c2a3 | 1553 | packHead(httpBuf, headClone.getRaw()); |
2cdeea82 | 1554 | |
c7d51c86 | 1555 | // headClone unlocks and, hence, deletes the message we packed |
774c051c | 1556 | } |
1557 | ||
26cc52cb | 1558 | void Adaptation::Icap::ModXact::packHead(MemBuf &httpBuf, const HttpMsg *head) |
774c051c | 1559 | { |
1560 | Packer p; | |
1561 | packerToMemInit(&p, &httpBuf); | |
1562 | head->packInto(&p, true); | |
1563 | packerClean(&p); | |
1564 | } | |
1565 | ||
1566 | // decides whether to offer a preview and calculates its size | |
26cc52cb | 1567 | void Adaptation::Icap::ModXact::decideOnPreview() |
774c051c | 1568 | { |
26cc52cb | 1569 | if (!TheConfig.preview_enable) { |
7cdbbd47 | 1570 | debugs(93, 5, HERE << "preview disabled by squid.conf"); |
c824c43b | 1571 | return; |
7cdbbd47 | 1572 | } |
1573 | ||
3ff65596 | 1574 | const String urlPath = virginRequest().urlpath; |
5f8252d2 | 1575 | size_t wantedSize; |
c99de607 | 1576 | if (!service().wantsPreview(urlPath, wantedSize)) { |
192378eb | 1577 | debugs(93, 5, HERE << "should not offer preview for " << urlPath); |
c824c43b | 1578 | return; |
774c051c | 1579 | } |
1580 | ||
c824c43b | 1581 | // we decided to do preview, now compute its size |
1582 | ||
774c051c | 1583 | // cannot preview more than we can backup |
d85c3078 | 1584 | size_t ad = min(wantedSize, TheBackupLimit); |
774c051c | 1585 | |
5f8252d2 | 1586 | if (!virginBody.expected()) |
1587 | ad = 0; | |
e1381638 AJ |
1588 | else if (virginBody.knownSize()) |
1589 | ad = min(static_cast<uint64_t>(ad), virginBody.size()); // not more than we have | |
774c051c | 1590 | |
192378eb | 1591 | debugs(93, 5, HERE << "should offer " << ad << "-byte preview " << |
774c051c | 1592 | "(service wanted " << wantedSize << ")"); |
1593 | ||
1594 | preview.enable(ad); | |
5f8252d2 | 1595 | Must(preview.enabled()); |
774c051c | 1596 | } |
1597 | ||
1598 | // decides whether to allow 204 responses | |
26cc52cb | 1599 | bool Adaptation::Icap::ModXact::shouldAllow204() |
774c051c | 1600 | { |
1601 | if (!service().allows204()) | |
1602 | return false; | |
1603 | ||
c824c43b | 1604 | return canBackupEverything(); |
1605 | } | |
1606 | ||
83c51da9 CT |
1607 | // decides whether to allow 206 responses in some mode |
1608 | bool Adaptation::Icap::ModXact::shouldAllow206any() | |
1609 | { | |
1610 | return TheConfig.allow206_enable && service().allows206() && | |
7ddcfbab | 1611 | virginBody.expected(); // no need for 206 without a body |
83c51da9 CT |
1612 | } |
1613 | ||
1614 | // decides whether to allow 206 responses in preview mode | |
1615 | bool Adaptation::Icap::ModXact::shouldAllow206in() | |
1616 | { | |
1617 | return shouldAllow206any() && preview.enabled(); | |
1618 | } | |
1619 | ||
1620 | // decides whether to allow 206 responses outside of preview | |
1621 | bool Adaptation::Icap::ModXact::shouldAllow206out() | |
1622 | { | |
1623 | return shouldAllow206any() && canBackupEverything(); | |
1624 | } | |
1625 | ||
c824c43b | 1626 | // used by shouldAllow204 and decideOnRetries |
26cc52cb | 1627 | bool Adaptation::Icap::ModXact::canBackupEverything() const |
c824c43b | 1628 | { |
774c051c | 1629 | if (!virginBody.expected()) |
c824c43b | 1630 | return true; // no body means no problems with backup |
774c051c | 1631 | |
c824c43b | 1632 | // if there is a body, check whether we can backup it all |
774c051c | 1633 | |
1634 | if (!virginBody.knownSize()) | |
1635 | return false; | |
1636 | ||
1637 | // or should we have a different backup limit? | |
1638 | // note that '<' allows for 0-termination of the "full" backup buffer | |
1639 | return virginBody.size() < TheBackupLimit; | |
1640 | } | |
1641 | ||
c824c43b | 1642 | // Decide whether this transaction can be retried if pconn fails |
1643 | // Must be called after decideOnPreview and before openConnection() | |
26cc52cb | 1644 | void Adaptation::Icap::ModXact::decideOnRetries() |
c824c43b | 1645 | { |
1646 | if (!isRetriable) | |
1647 | return; // no, already decided | |
1648 | ||
1649 | if (preview.enabled()) | |
1650 | return; // yes, because preview provides enough guarantees | |
1651 | ||
1652 | if (canBackupEverything()) | |
1653 | return; // yes, because we can back everything up | |
1654 | ||
1655 | disableRetries(); // no, because we cannot back everything up | |
1656 | } | |
1657 | ||
5f8252d2 | 1658 | // Normally, the body-writing code handles preview body. It can deal with |
1659 | // bodies of unexpected size, including those that turn out to be empty. | |
1660 | // However, that code assumes that the body was expected and body control | |
1661 | // structures were initialized. This is not the case when there is no body | |
1662 | // or the body is known to be empty, because the virgin message will lack a | |
1663 | // body_pipe. So we handle preview of null-body and zero-size bodies here. | |
26cc52cb | 1664 | void Adaptation::Icap::ModXact::finishNullOrEmptyBodyPreview(MemBuf &buf) |
5f8252d2 | 1665 | { |
1666 | Must(!virginBodyWriting.active()); // one reason we handle it here | |
1667 | Must(!virgin.body_pipe); // another reason we handle it here | |
1668 | Must(!preview.ad()); | |
1669 | ||
1670 | // do not add last-chunk because our Encapsulated header says null-body | |
bb790702 | 1671 | // addLastRequestChunk(buf); |
5f8252d2 | 1672 | preview.wrote(0, true); |
1673 | ||
1674 | Must(preview.done()); | |
1675 | Must(preview.ieof()); | |
1676 | } | |
1677 | ||
26cc52cb | 1678 | void Adaptation::Icap::ModXact::fillPendingStatus(MemBuf &buf) const |
774c051c | 1679 | { |
26cc52cb | 1680 | Adaptation::Icap::Xaction::fillPendingStatus(buf); |
c99de607 | 1681 | |
774c051c | 1682 | if (state.serviceWaiting) |
1683 | buf.append("U", 1); | |
1684 | ||
5f8252d2 | 1685 | if (virgin.body_pipe != NULL) |
c99de607 | 1686 | buf.append("R", 1); |
1687 | ||
aed188fd | 1688 | if (haveConnection() && !doneReading()) |
c99de607 | 1689 | buf.append("r", 1); |
1690 | ||
774c051c | 1691 | if (!state.doneWriting() && state.writing != State::writingInit) |
1692 | buf.Printf("w(%d)", state.writing); | |
1693 | ||
1694 | if (preview.enabled()) { | |
1695 | if (!preview.done()) | |
1dd6edf2 | 1696 | buf.Printf("P(%d)", (int) preview.debt()); |
774c051c | 1697 | } |
1698 | ||
5f8252d2 | 1699 | if (virginBodySending.active()) |
774c051c | 1700 | buf.append("B", 1); |
1701 | ||
1702 | if (!state.doneParsing() && state.parsing != State::psIcapHeader) | |
1703 | buf.Printf("p(%d)", state.parsing); | |
1704 | ||
1705 | if (!doneSending() && state.sending != State::sendingUndecided) | |
1706 | buf.Printf("S(%d)", state.sending); | |
478cfe99 | 1707 | |
83c51da9 CT |
1708 | if (state.readyForUob) |
1709 | buf.append("6", 1); | |
1710 | ||
478cfe99 | 1711 | if (canStartBypass) |
9e008dda | 1712 | buf.append("Y", 1); |
a22e6cd3 AR |
1713 | |
1714 | if (protectGroupBypass) | |
1715 | buf.append("G", 1); | |
774c051c | 1716 | } |
1717 | ||
26cc52cb | 1718 | void Adaptation::Icap::ModXact::fillDoneStatus(MemBuf &buf) const |
774c051c | 1719 | { |
26cc52cb | 1720 | Adaptation::Icap::Xaction::fillDoneStatus(buf); |
c99de607 | 1721 | |
5f8252d2 | 1722 | if (!virgin.body_pipe) |
774c051c | 1723 | buf.append("R", 1); |
1724 | ||
1725 | if (state.doneWriting()) | |
1726 | buf.append("w", 1); | |
1727 | ||
1728 | if (preview.enabled()) { | |
1729 | if (preview.done()) | |
1730 | buf.Printf("P%s", preview.ieof() ? "(ieof)" : ""); | |
1731 | } | |
1732 | ||
1733 | if (doneReading()) | |
1734 | buf.append("r", 1); | |
1735 | ||
1736 | if (state.doneParsing()) | |
1737 | buf.append("p", 1); | |
1738 | ||
1739 | if (doneSending()) | |
1740 | buf.append("S", 1); | |
1741 | } | |
1742 | ||
26cc52cb | 1743 | bool Adaptation::Icap::ModXact::gotEncapsulated(const char *section) const |
774c051c | 1744 | { |
a9925b40 | 1745 | return icapReply->header.getByNameListMember("Encapsulated", |
1746 | section, ',').size() > 0; | |
774c051c | 1747 | } |
1748 | ||
1749 | // calculate whether there is a virgin HTTP body and | |
1750 | // whether its expected size is known | |
5f8252d2 | 1751 | // TODO: rename because we do not just estimate |
26cc52cb | 1752 | void Adaptation::Icap::ModXact::estimateVirginBody() |
774c051c | 1753 | { |
5f8252d2 | 1754 | // note: lack of size info may disable previews and 204s |
774c051c | 1755 | |
5f8252d2 | 1756 | HttpMsg *msg = virgin.header; |
1757 | Must(msg); | |
774c051c | 1758 | |
60745f24 | 1759 | HttpRequestMethod method; |
774c051c | 1760 | |
5f8252d2 | 1761 | if (virgin.cause) |
1762 | method = virgin.cause->method; | |
e1381638 AJ |
1763 | else if (HttpRequest *req = dynamic_cast<HttpRequest*>(msg)) |
1764 | method = req->method; | |
774c051c | 1765 | else |
c2a7cefd | 1766 | method = Http::METHOD_NONE; |
774c051c | 1767 | |
47f6e231 | 1768 | int64_t size; |
5f8252d2 | 1769 | // expectingBody returns true for zero-sized bodies, but we will not |
1770 | // get a pipe for that body, so we treat the message as bodyless | |
c2a7cefd | 1771 | if (method != Http::METHOD_NONE && msg->expectingBody(method, size) && size) { |
192378eb | 1772 | debugs(93, 6, HERE << "expects virgin body from " << |
9e008dda | 1773 | virgin.body_pipe << "; size: " << size); |
5f8252d2 | 1774 | |
1775 | virginBody.expect(size); | |
1776 | virginBodyWriting.plan(); | |
1777 | ||
1778 | // sign up as a body consumer | |
1779 | Must(msg->body_pipe != NULL); | |
1780 | Must(msg->body_pipe == virgin.body_pipe); | |
1781 | Must(virgin.body_pipe->setConsumerIfNotLate(this)); | |
1782 | ||
1783 | // make sure TheBackupLimit is in-sync with the buffer size | |
9c175897 | 1784 | Must(TheBackupLimit <= static_cast<size_t>(msg->body_pipe->buf().max_capacity)); |
774c051c | 1785 | } else { |
192378eb | 1786 | debugs(93, 6, HERE << "does not expect virgin body"); |
5f8252d2 | 1787 | Must(msg->body_pipe == NULL); |
1788 | checkConsuming(); | |
774c051c | 1789 | } |
1790 | } | |
1791 | ||
26cc52cb | 1792 | void Adaptation::Icap::ModXact::makeAdaptedBodyPipe(const char *what) |
9e008dda | 1793 | { |
5f8252d2 | 1794 | Must(!adapted.body_pipe); |
1795 | Must(!adapted.header->body_pipe); | |
1796 | adapted.header->body_pipe = new BodyPipe(this); | |
1797 | adapted.body_pipe = adapted.header->body_pipe; | |
1798 | debugs(93, 7, HERE << "will supply " << what << " via " << | |
9e008dda | 1799 | adapted.body_pipe << " pipe"); |
5f8252d2 | 1800 | } |
1801 | ||
26cc52cb | 1802 | // TODO: Move SizedEstimate and Preview elsewhere |
774c051c | 1803 | |
26cc52cb | 1804 | Adaptation::Icap::SizedEstimate::SizedEstimate() |
774c051c | 1805 | : theData(dtUnexpected) |
1806 | {} | |
1807 | ||
26cc52cb | 1808 | void Adaptation::Icap::SizedEstimate::expect(int64_t aSize) |
774c051c | 1809 | { |
47f6e231 | 1810 | theData = (aSize >= 0) ? aSize : (int64_t)dtUnknown; |
774c051c | 1811 | } |
1812 | ||
26cc52cb | 1813 | bool Adaptation::Icap::SizedEstimate::expected() const |
774c051c | 1814 | { |
1815 | return theData != dtUnexpected; | |
1816 | } | |
1817 | ||
26cc52cb | 1818 | bool Adaptation::Icap::SizedEstimate::knownSize() const |
774c051c | 1819 | { |
1820 | Must(expected()); | |
1821 | return theData != dtUnknown; | |
1822 | } | |
1823 | ||
26cc52cb | 1824 | uint64_t Adaptation::Icap::SizedEstimate::size() const |
774c051c | 1825 | { |
1826 | Must(knownSize()); | |
47f6e231 | 1827 | return static_cast<uint64_t>(theData); |
774c051c | 1828 | } |
1829 | ||
26cc52cb | 1830 | Adaptation::Icap::VirginBodyAct::VirginBodyAct(): theStart(0), theState(stUndecided) |
774c051c | 1831 | {} |
1832 | ||
26cc52cb | 1833 | void Adaptation::Icap::VirginBodyAct::plan() |
774c051c | 1834 | { |
478cfe99 | 1835 | Must(!disabled()); |
1836 | Must(!theStart); // not started | |
1837 | theState = stActive; | |
774c051c | 1838 | } |
1839 | ||
26cc52cb | 1840 | void Adaptation::Icap::VirginBodyAct::disable() |
774c051c | 1841 | { |
478cfe99 | 1842 | theState = stDisabled; |
774c051c | 1843 | } |
1844 | ||
26cc52cb | 1845 | void Adaptation::Icap::VirginBodyAct::progress(size_t size) |
774c051c | 1846 | { |
1847 | Must(active()); | |
46e172d9 FC |
1848 | #if SIZEOF_SIZE_T > 4 |
1849 | /* always true for smaller size_t's */ | |
d897ae49 | 1850 | Must(static_cast<int64_t>(size) >= 0); |
46e172d9 | 1851 | #endif |
47f6e231 | 1852 | theStart += static_cast<int64_t>(size); |
774c051c | 1853 | } |
1854 | ||
26cc52cb | 1855 | uint64_t Adaptation::Icap::VirginBodyAct::offset() const |
774c051c | 1856 | { |
1857 | Must(active()); | |
47f6e231 | 1858 | return static_cast<uint64_t>(theStart); |
774c051c | 1859 | } |
1860 | ||
26cc52cb | 1861 | Adaptation::Icap::Preview::Preview(): theWritten(0), theAd(0), theState(stDisabled) |
774c051c | 1862 | {} |
1863 | ||
26cc52cb | 1864 | void Adaptation::Icap::Preview::enable(size_t anAd) |
774c051c | 1865 | { |
1866 | // TODO: check for anAd not exceeding preview size limit | |
774c051c | 1867 | Must(!enabled()); |
1868 | theAd = anAd; | |
1869 | theState = stWriting; | |
1870 | } | |
1871 | ||
26cc52cb | 1872 | bool Adaptation::Icap::Preview::enabled() const |
774c051c | 1873 | { |
1874 | return theState != stDisabled; | |
1875 | } | |
1876 | ||
26cc52cb | 1877 | size_t Adaptation::Icap::Preview::ad() const |
774c051c | 1878 | { |
1879 | Must(enabled()); | |
1880 | return theAd; | |
1881 | } | |
1882 | ||
26cc52cb | 1883 | bool Adaptation::Icap::Preview::done() const |
774c051c | 1884 | { |
1885 | Must(enabled()); | |
1886 | return theState >= stIeof; | |
1887 | } | |
1888 | ||
26cc52cb | 1889 | bool Adaptation::Icap::Preview::ieof() const |
774c051c | 1890 | { |
1891 | Must(enabled()); | |
1892 | return theState == stIeof; | |
1893 | } | |
1894 | ||
26cc52cb | 1895 | size_t Adaptation::Icap::Preview::debt() const |
774c051c | 1896 | { |
1897 | Must(enabled()); | |
1898 | return done() ? 0 : (theAd - theWritten); | |
1899 | } | |
1900 | ||
26cc52cb | 1901 | void Adaptation::Icap::Preview::wrote(size_t size, bool wroteEof) |
774c051c | 1902 | { |
1903 | Must(enabled()); | |
5f8252d2 | 1904 | |
774c051c | 1905 | theWritten += size; |
1906 | ||
9e008dda | 1907 | Must(theWritten <= theAd); |
5f8252d2 | 1908 | |
9e008dda AJ |
1909 | if (wroteEof) |
1910 | theState = stIeof; // written size is irrelevant | |
e1381638 AJ |
1911 | else if (theWritten >= theAd) |
1912 | theState = stDone; | |
774c051c | 1913 | } |
1914 | ||
26cc52cb | 1915 | bool Adaptation::Icap::ModXact::fillVirginHttpHeader(MemBuf &mb) const |
3cfc19b3 | 1916 | { |
5f8252d2 | 1917 | if (virgin.header == NULL) |
3cfc19b3 | 1918 | return false; |
1919 | ||
5f8252d2 | 1920 | virgin.header->firstLineBuf(mb); |
3cfc19b3 | 1921 | |
1922 | return true; | |
1923 | } | |
c824c43b | 1924 | |
64b66b76 CT |
1925 | void Adaptation::Icap::ModXact::detailError(int errDetail) |
1926 | { | |
e9fa5493 AR |
1927 | HttpRequest *request = dynamic_cast<HttpRequest*>(adapted.header); |
1928 | // if no adapted request, update virgin (and inherit its properties later) | |
1929 | // TODO: make this and HttpRequest::detailError constant, like adaptHistory | |
1930 | if (!request) | |
1931 | request = const_cast<HttpRequest*>(&virginRequest()); | |
1932 | ||
1933 | if (request) | |
64b66b76 | 1934 | request->detailError(ERR_ICAP_FAILURE, errDetail); |
64b66b76 | 1935 | } |
c824c43b | 1936 | |
129fe2a1 CT |
1937 | void Adaptation::Icap::ModXact::clearError() |
1938 | { | |
87f237a9 | 1939 | HttpRequest *request = dynamic_cast<HttpRequest*>(adapted.header); |
129fe2a1 CT |
1940 | // if no adapted request, update virgin (and inherit its properties later) |
1941 | if (!request) | |
1942 | request = const_cast<HttpRequest*>(&virginRequest()); | |
1943 | ||
1944 | if (request) | |
1945 | request->clearError(); | |
1946 | } | |
1947 | ||
26cc52cb | 1948 | /* Adaptation::Icap::ModXactLauncher */ |
c824c43b | 1949 | |
4299f876 | 1950 | Adaptation::Icap::ModXactLauncher::ModXactLauncher(HttpMsg *virginHeader, HttpRequest *virginCause, Adaptation::ServicePointer aService): |
26cc52cb | 1951 | AsyncJob("Adaptation::Icap::ModXactLauncher"), |
4299f876 | 1952 | Adaptation::Icap::Launcher("Adaptation::Icap::ModXactLauncher", aService) |
c824c43b | 1953 | { |
1954 | virgin.setHeader(virginHeader); | |
1955 | virgin.setCause(virginCause); | |
3ff65596 | 1956 | updateHistory(true); |
c824c43b | 1957 | } |
1958 | ||
26cc52cb | 1959 | Adaptation::Icap::Xaction *Adaptation::Icap::ModXactLauncher::createXaction() |
c824c43b | 1960 | { |
26cc52cb AR |
1961 | Adaptation::Icap::ServiceRep::Pointer s = |
1962 | dynamic_cast<Adaptation::Icap::ServiceRep*>(theService.getRaw()); | |
0bef8dd7 | 1963 | Must(s != NULL); |
4299f876 | 1964 | return new Adaptation::Icap::ModXact(virgin.header, virgin.cause, s); |
c824c43b | 1965 | } |
3ff65596 | 1966 | |
e1381638 AJ |
1967 | void Adaptation::Icap::ModXactLauncher::swanSong() |
1968 | { | |
3ff65596 AR |
1969 | debugs(93, 5, HERE << "swan sings"); |
1970 | updateHistory(false); | |
1971 | Adaptation::Icap::Launcher::swanSong(); | |
1972 | } | |
1973 | ||
b0365bd9 | 1974 | void Adaptation::Icap::ModXactLauncher::updateHistory(bool doStart) |
e1381638 AJ |
1975 | { |
1976 | HttpRequest *r = virgin.cause ? | |
1977 | virgin.cause : dynamic_cast<HttpRequest*>(virgin.header); | |
1978 | ||
1979 | // r should never be NULL but we play safe; TODO: add Should() | |
1980 | if (r) { | |
1981 | Adaptation::Icap::History::Pointer h = r->icapHistory(); | |
1982 | if (h != NULL) { | |
b0365bd9 | 1983 | if (doStart) |
e1381638 AJ |
1984 | h->start("ICAPModXactLauncher"); |
1985 | else | |
1986 | h->stop("ICAPModXactLauncher"); | |
1987 | } | |
1988 | } | |
3ff65596 | 1989 | } |