]>
Commit | Line | Data |
---|---|---|
774c051c | 1 | /* |
507d0a78 | 2 | * DEBUG: section 93 ICAP (RFC 3507) Client |
774c051c | 3 | */ |
4 | ||
5 | #include "squid.h" | |
6 | #include "comm.h" | |
5f8252d2 | 7 | #include "HttpMsg.h" |
774c051c | 8 | #include "HttpRequest.h" |
9 | #include "HttpReply.h" | |
10 | #include "ICAPServiceRep.h" | |
5f8252d2 | 11 | #include "ICAPInitiator.h" |
c824c43b | 12 | #include "ICAPLauncher.h" |
774c051c | 13 | #include "ICAPModXact.h" |
14 | #include "ICAPClient.h" | |
15 | #include "ChunkedCodingParser.h" | |
16 | #include "TextException.h" | |
a97e82a8 | 17 | #include "AuthUserRequest.h" |
12b91c99 | 18 | #include "ICAPConfig.h" |
985c86bc | 19 | #include "SquidTime.h" |
774c051c | 20 | |
21 | // flow and terminology: | |
22 | // HTTP| --> receive --> encode --> write --> |network | |
23 | // end | <-- send <-- parse <-- read <-- |end | |
24 | ||
774c051c | 25 | // TODO: replace gotEncapsulated() with something faster; we call it often |
26 | ||
27 | CBDATA_CLASS_INIT(ICAPModXact); | |
c824c43b | 28 | CBDATA_CLASS_INIT(ICAPModXactLauncher); |
774c051c | 29 | |
5f8252d2 | 30 | static const size_t TheBackupLimit = BodyPipe::MaxCapacity; |
774c051c | 31 | |
12b91c99 | 32 | extern ICAPConfig TheICAPConfig; |
33 | ||
774c051c | 34 | |
35 | ICAPModXact::State::State() | |
36 | { | |
37 | memset(this, sizeof(*this), 0); | |
38 | } | |
39 | ||
5f8252d2 | 40 | ICAPModXact::ICAPModXact(ICAPInitiator *anInitiator, HttpMsg *virginHeader, |
41 | HttpRequest *virginCause, ICAPServiceRep::Pointer &aService): | |
c824c43b | 42 | ICAPXaction("ICAPModXact", anInitiator, aService), |
5f8252d2 | 43 | icapReply(NULL), |
44 | virginConsumed(0), | |
478cfe99 | 45 | bodyParser(NULL), |
46 | canStartBypass(false) // too early | |
774c051c | 47 | { |
5f8252d2 | 48 | assert(virginHeader); |
774c051c | 49 | |
5f8252d2 | 50 | virgin.setHeader(virginHeader); // sets virgin.body_pipe if needed |
51 | virgin.setCause(virginCause); // may be NULL | |
774c051c | 52 | |
5f8252d2 | 53 | // adapted header and body are initialized when we parse them |
774c051c | 54 | |
55 | // writing and reading ends are handled by ICAPXaction | |
56 | ||
57 | // encoding | |
58 | // nothing to do because we are using temporary buffers | |
59 | ||
60 | // parsing | |
61 | icapReply = new HttpReply; | |
62 | icapReply->protoPrefix = "ICAP/"; // TODO: make an IcapReply class? | |
63 | ||
5f8252d2 | 64 | debugs(93,7, "ICAPModXact initialized." << status()); |
774c051c | 65 | } |
66 | ||
5f8252d2 | 67 | // initiator wants us to start |
68 | void ICAPModXact::start() | |
774c051c | 69 | { |
5f8252d2 | 70 | ICAPXaction::start(); |
774c051c | 71 | |
72 | estimateVirginBody(); // before virgin disappears! | |
73 | ||
478cfe99 | 74 | canStartBypass = service().bypass; |
75 | ||
774c051c | 76 | // it is an ICAP violation to send request to a service w/o known OPTIONS |
77 | ||
78 | if (service().up()) | |
79 | startWriting(); | |
80 | else | |
81 | waitForService(); | |
82 | ||
c824c43b | 83 | // XXX: If commConnectStart in startWriting fails, we may get here |
774c051c | 84 | //_after_ the object got destroyed. Somebody please fix commConnectStart! |
c824c43b | 85 | // TODO: Does re-entrance protection in callStart() solve the above? |
774c051c | 86 | } |
87 | ||
88 | static | |
89 | void ICAPModXact_noteServiceReady(void *data, ICAPServiceRep::Pointer &) | |
90 | { | |
91 | ICAPModXact *x = static_cast<ICAPModXact*>(data); | |
92 | assert(x); | |
93 | x->noteServiceReady(); | |
94 | } | |
95 | ||
96 | void ICAPModXact::waitForService() | |
97 | { | |
98 | Must(!state.serviceWaiting); | |
5f8252d2 | 99 | debugs(93, 7, "ICAPModXact will wait for the ICAP service" << status()); |
774c051c | 100 | state.serviceWaiting = true; |
101 | service().callWhenReady(&ICAPModXact_noteServiceReady, this); | |
102 | } | |
103 | ||
104 | void ICAPModXact::noteServiceReady() | |
105 | { | |
106 | ICAPXaction_Enter(noteServiceReady); | |
107 | ||
108 | Must(state.serviceWaiting); | |
109 | state.serviceWaiting = false; | |
c99de607 | 110 | |
c824c43b | 111 | if (service().up()) { |
112 | startWriting(); | |
113 | } else { | |
114 | disableRetries(); | |
478cfe99 | 115 | throw TexcHere("ICAP service is unusable"); |
c824c43b | 116 | } |
774c051c | 117 | |
118 | ICAPXaction_Exit(); | |
119 | } | |
120 | ||
121 | void ICAPModXact::startWriting() | |
122 | { | |
774c051c | 123 | state.writing = State::writingConnect; |
c824c43b | 124 | |
125 | decideOnPreview(); // must be decided before we decideOnRetries | |
126 | decideOnRetries(); | |
127 | ||
774c051c | 128 | openConnection(); |
129 | // put nothing here as openConnection calls commConnectStart | |
130 | // and that may call us back without waiting for the next select loop | |
131 | } | |
132 | ||
133 | // connection with the ICAP service established | |
134 | void ICAPModXact::handleCommConnected() | |
135 | { | |
136 | Must(state.writing == State::writingConnect); | |
137 | ||
138 | startReading(); // wait for early errors from the ICAP server | |
139 | ||
140 | MemBuf requestBuf; | |
141 | requestBuf.init(); | |
142 | ||
143 | makeRequestHeaders(requestBuf); | |
5f8252d2 | 144 | debugs(93, 9, "ICAPModXact ICAP will write" << status() << ":\n" << |
774c051c | 145 | (requestBuf.terminate(), requestBuf.content())); |
146 | ||
147 | // write headers | |
148 | state.writing = State::writingHeaders; | |
149 | scheduleWrite(requestBuf); | |
150 | } | |
151 | ||
b107a5a5 | 152 | void ICAPModXact::handleCommWrote(size_t sz) |
774c051c | 153 | { |
b107a5a5 | 154 | debugs(93, 5, HERE << "Wrote " << sz << " bytes"); |
155 | ||
774c051c | 156 | if (state.writing == State::writingHeaders) |
157 | handleCommWroteHeaders(); | |
158 | else | |
159 | handleCommWroteBody(); | |
160 | } | |
161 | ||
162 | void ICAPModXact::handleCommWroteHeaders() | |
163 | { | |
164 | Must(state.writing == State::writingHeaders); | |
165 | ||
5f8252d2 | 166 | // determine next step |
167 | if (preview.enabled()) | |
168 | state.writing = preview.done() ? State::writingPaused : State::writingPreview; | |
169 | else | |
170 | if (virginBody.expected()) | |
171 | state.writing = State::writingPrime; | |
172 | else { | |
c99de607 | 173 | stopWriting(true); |
5f8252d2 | 174 | return; |
774c051c | 175 | } |
5f8252d2 | 176 | |
177 | writeMore(); | |
774c051c | 178 | } |
179 | ||
180 | void ICAPModXact::writeMore() | |
181 | { | |
5f8252d2 | 182 | debugs(93, 5, HERE << "checking whether to write more" << status()); |
183 | ||
774c051c | 184 | if (writer) // already writing something |
185 | return; | |
186 | ||
187 | switch (state.writing) { | |
188 | ||
189 | case State::writingInit: // waiting for service OPTIONS | |
190 | Must(state.serviceWaiting); | |
191 | ||
192 | case State::writingConnect: // waiting for the connection to establish | |
193 | ||
194 | case State::writingHeaders: // waiting for the headers to be written | |
195 | ||
196 | case State::writingPaused: // waiting for the ICAP server response | |
197 | ||
c99de607 | 198 | case State::writingReallyDone: // nothing more to write |
199 | return; | |
200 | ||
201 | case State::writingAlmostDone: // was waiting for the last write | |
202 | stopWriting(false); | |
774c051c | 203 | return; |
204 | ||
205 | case State::writingPreview: | |
5f8252d2 | 206 | writePreviewBody(); |
774c051c | 207 | return; |
208 | ||
209 | case State::writingPrime: | |
210 | writePrimeBody(); | |
211 | return; | |
212 | ||
213 | default: | |
214 | throw TexcHere("ICAPModXact in bad writing state"); | |
215 | } | |
216 | } | |
217 | ||
5f8252d2 | 218 | void ICAPModXact::writePreviewBody() |
774c051c | 219 | { |
5f8252d2 | 220 | debugs(93, 8, HERE << "will write Preview body from " << |
221 | virgin.body_pipe << status()); | |
774c051c | 222 | Must(state.writing == State::writingPreview); |
5f8252d2 | 223 | Must(virgin.body_pipe != NULL); |
774c051c | 224 | |
5f8252d2 | 225 | const size_t sizeMax = (size_t)virgin.body_pipe->buf().contentSize(); |
226 | const size_t size = XMIN(preview.debt(), sizeMax); | |
774c051c | 227 | writeSomeBody("preview body", size); |
228 | ||
229 | // change state once preview is written | |
230 | ||
231 | if (preview.done()) { | |
5f8252d2 | 232 | debugs(93, 7, "ICAPModXact wrote entire Preview body" << status()); |
774c051c | 233 | |
234 | if (preview.ieof()) | |
c99de607 | 235 | stopWriting(true); |
774c051c | 236 | else |
237 | state.writing = State::writingPaused; | |
238 | } | |
239 | } | |
240 | ||
241 | void ICAPModXact::writePrimeBody() | |
242 | { | |
243 | Must(state.writing == State::writingPrime); | |
5f8252d2 | 244 | Must(virginBodyWriting.active()); |
774c051c | 245 | |
5f8252d2 | 246 | const size_t size = (size_t)virgin.body_pipe->buf().contentSize(); |
774c051c | 247 | writeSomeBody("prime virgin body", size); |
248 | ||
5f8252d2 | 249 | if (virginBodyEndReached(virginBodyWriting)) { |
250 | debugs(93, 5, HERE << "wrote entire body"); | |
c99de607 | 251 | stopWriting(true); |
b107a5a5 | 252 | } |
774c051c | 253 | } |
254 | ||
255 | void ICAPModXact::writeSomeBody(const char *label, size_t size) | |
256 | { | |
c99de607 | 257 | Must(!writer && state.writing < state.writingAlmostDone); |
5f8252d2 | 258 | Must(virgin.body_pipe != NULL); |
12f4b710 | 259 | debugs(93, 8, HERE << "will write up to " << size << " bytes of " << |
774c051c | 260 | label); |
261 | ||
262 | MemBuf writeBuf; // TODO: suggest a min size based on size and lastChunk | |
263 | ||
264 | writeBuf.init(); // note: we assume that last-chunk will fit | |
265 | ||
5f8252d2 | 266 | const size_t writableSize = virginContentSize(virginBodyWriting); |
c99de607 | 267 | const size_t chunkSize = XMIN(writableSize, size); |
774c051c | 268 | |
269 | if (chunkSize) { | |
12f4b710 | 270 | debugs(93, 7, HERE << "will write " << chunkSize << |
774c051c | 271 | "-byte chunk of " << label); |
5f8252d2 | 272 | |
273 | openChunk(writeBuf, chunkSize, false); | |
274 | writeBuf.append(virginContentData(virginBodyWriting), chunkSize); | |
275 | closeChunk(writeBuf); | |
276 | ||
277 | virginBodyWriting.progress(chunkSize); | |
278 | virginConsume(); | |
774c051c | 279 | } else { |
c99de607 | 280 | debugs(93, 7, "ICAPModXact has no writable " << label << " content"); |
774c051c | 281 | } |
282 | ||
5f8252d2 | 283 | const bool wroteEof = virginBodyEndReached(virginBodyWriting); |
284 | bool lastChunk = wroteEof; | |
285 | if (state.writing == State::writingPreview) { | |
286 | preview.wrote(chunkSize, wroteEof); // even if wrote nothing | |
287 | lastChunk = lastChunk || preview.done(); | |
288 | } | |
774c051c | 289 | |
5f8252d2 | 290 | if (lastChunk) { |
12f4b710 | 291 | debugs(93, 8, HERE << "will write last-chunk of " << label); |
774c051c | 292 | addLastRequestChunk(writeBuf); |
293 | } | |
294 | ||
12f4b710 | 295 | debugs(93, 7, HERE << "will write " << writeBuf.contentSize() |
774c051c | 296 | << " raw bytes of " << label); |
297 | ||
298 | if (writeBuf.hasContent()) { | |
299 | scheduleWrite(writeBuf); // comm will free the chunk | |
300 | } else { | |
301 | writeBuf.clean(); | |
302 | } | |
303 | } | |
304 | ||
774c051c | 305 | void ICAPModXact::addLastRequestChunk(MemBuf &buf) |
306 | { | |
c99de607 | 307 | const bool ieof = state.writing == State::writingPreview && preview.ieof(); |
308 | openChunk(buf, 0, ieof); | |
309 | closeChunk(buf); | |
774c051c | 310 | } |
311 | ||
c99de607 | 312 | void ICAPModXact::openChunk(MemBuf &buf, size_t chunkSize, bool ieof) |
774c051c | 313 | { |
c99de607 | 314 | buf.Printf((ieof ? "%x; ieof\r\n" : "%x\r\n"), (int) chunkSize); |
774c051c | 315 | } |
316 | ||
c99de607 | 317 | void ICAPModXact::closeChunk(MemBuf &buf) |
774c051c | 318 | { |
774c051c | 319 | buf.append(ICAP::crlf, 2); // chunk-terminating CRLF |
320 | } | |
321 | ||
5f8252d2 | 322 | // did the activity reached the end of the virgin body? |
323 | bool ICAPModXact::virginBodyEndReached(const VirginBodyAct &act) const | |
324 | { | |
325 | return | |
326 | !act.active() || // did all (assuming it was originally planned) | |
327 | !virgin.body_pipe->expectMoreAfter(act.offset()); // wont have more | |
328 | } | |
329 | ||
330 | // the size of buffered virgin body data available for the specified activity | |
331 | // if this size is zero, we may be done or may be waiting for more data | |
332 | size_t ICAPModXact::virginContentSize(const VirginBodyAct &act) const | |
774c051c | 333 | { |
5f8252d2 | 334 | Must(act.active()); |
335 | // asbolute start of unprocessed data | |
47f6e231 | 336 | const uint64_t start = act.offset(); |
5f8252d2 | 337 | // absolute end of buffered data |
47f6e231 | 338 | const uint64_t end = virginConsumed + virgin.body_pipe->buf().contentSize(); |
774c051c | 339 | Must(virginConsumed <= start && start <= end); |
47f6e231 | 340 | return static_cast<size_t>(end - start); |
774c051c | 341 | } |
342 | ||
5f8252d2 | 343 | // pointer to buffered virgin body data available for the specified activity |
344 | const char *ICAPModXact::virginContentData(const VirginBodyAct &act) const | |
774c051c | 345 | { |
5f8252d2 | 346 | Must(act.active()); |
47f6e231 | 347 | const uint64_t start = act.offset(); |
774c051c | 348 | Must(virginConsumed <= start); |
47f6e231 | 349 | return virgin.body_pipe->buf().content() + static_cast<size_t>(start-virginConsumed); |
774c051c | 350 | } |
351 | ||
352 | void ICAPModXact::virginConsume() | |
353 | { | |
478cfe99 | 354 | debugs(93, 9, "consumption guards: " << !virgin.body_pipe << isRetriable); |
355 | ||
5f8252d2 | 356 | if (!virgin.body_pipe) |
c824c43b | 357 | return; // nothing to consume |
358 | ||
359 | if (isRetriable) | |
360 | return; // do not consume if we may have to retry later | |
5f8252d2 | 361 | |
362 | BodyPipe &bp = *virgin.body_pipe; | |
478cfe99 | 363 | |
364 | // Why > 2? HttpState does not use the last bytes in the buffer | |
365 | // because delayAwareRead() is arguably broken. See | |
366 | // HttpStateData::maybeReadVirginBody for more details. | |
367 | if (canStartBypass && bp.buf().spaceSize() > 2) { | |
368 | // Postponing may increase memory footprint and slow the HTTP side | |
369 | // down. Not postponing may increase the number of ICAP errors | |
370 | // if the ICAP service fails. We may also use "potential" space to | |
371 | // postpone more aggressively. Should the trade-off be configurable? | |
372 | debugs(93, 8, HERE << "postponing consumption from " << bp.status()); | |
373 | return; | |
374 | } | |
375 | ||
5f8252d2 | 376 | const size_t have = static_cast<size_t>(bp.buf().contentSize()); |
47f6e231 | 377 | const uint64_t end = virginConsumed + have; |
378 | uint64_t offset = end; | |
774c051c | 379 | |
478cfe99 | 380 | debugs(93, 9, HERE << "max virgin consumption offset=" << offset << |
381 | " acts " << virginBodyWriting.active() << virginBodySending.active() << | |
382 | " consumed=" << virginConsumed << | |
383 | " from " << virgin.body_pipe->status()); | |
384 | ||
5f8252d2 | 385 | if (virginBodyWriting.active()) |
386 | offset = XMIN(virginBodyWriting.offset(), offset); | |
774c051c | 387 | |
5f8252d2 | 388 | if (virginBodySending.active()) |
389 | offset = XMIN(virginBodySending.offset(), offset); | |
774c051c | 390 | |
391 | Must(virginConsumed <= offset && offset <= end); | |
392 | ||
47f6e231 | 393 | if (const size_t size = static_cast<size_t>(offset - virginConsumed)) { |
b107a5a5 | 394 | debugs(93, 8, HERE << "consuming " << size << " out of " << have << |
774c051c | 395 | " virgin body bytes"); |
5f8252d2 | 396 | bp.consume(size); |
774c051c | 397 | virginConsumed += size; |
c824c43b | 398 | Must(!isRetriable); // or we should not be consuming |
478cfe99 | 399 | disableBypass("consumed content"); |
774c051c | 400 | } |
401 | } | |
402 | ||
403 | void ICAPModXact::handleCommWroteBody() | |
404 | { | |
405 | writeMore(); | |
406 | } | |
407 | ||
c99de607 | 408 | // Called when we do not expect to call comm_write anymore. |
409 | // We may have a pending write though. | |
410 | // If stopping nicely, we will just wait for that pending write, if any. | |
411 | void ICAPModXact::stopWriting(bool nicely) | |
774c051c | 412 | { |
c99de607 | 413 | if (state.writing == State::writingReallyDone) |
774c051c | 414 | return; |
415 | ||
c99de607 | 416 | if (writer) { |
417 | if (nicely) { | |
5f8252d2 | 418 | debugs(93, 7, HERE << "will wait for the last write" << status()); |
c99de607 | 419 | state.writing = State::writingAlmostDone; // may already be set |
5f8252d2 | 420 | checkConsuming(); |
c99de607 | 421 | return; |
422 | } | |
4932ad93 | 423 | debugs(93, 3, HERE << "will NOT wait for the last write" << status()); |
774c051c | 424 | |
c99de607 | 425 | // Comm does not have an interface to clear the writer callback nicely, |
426 | // but without clearing the writer we cannot recycle the connection. | |
427 | // We prevent connection reuse and hope that we can handle a callback | |
5f8252d2 | 428 | // call at any time, usually in the middle of the destruction sequence! |
429 | // Somebody should add comm_remove_write_handler() to comm API. | |
c99de607 | 430 | reuseConnection = false; |
478cfe99 | 431 | ignoreLastWrite = true; |
c99de607 | 432 | } |
433 | ||
5f8252d2 | 434 | debugs(93, 7, HERE << "will no longer write" << status()); |
5f8252d2 | 435 | if (virginBodyWriting.active()) { |
436 | virginBodyWriting.disable(); | |
437 | virginConsume(); | |
438 | } | |
478cfe99 | 439 | state.writing = State::writingReallyDone; |
440 | checkConsuming(); | |
774c051c | 441 | } |
442 | ||
443 | void ICAPModXact::stopBackup() | |
444 | { | |
5f8252d2 | 445 | if (!virginBodySending.active()) |
774c051c | 446 | return; |
447 | ||
5f8252d2 | 448 | debugs(93, 7, "ICAPModXact will no longer backup" << status()); |
449 | virginBodySending.disable(); | |
774c051c | 450 | virginConsume(); |
451 | } | |
452 | ||
453 | bool ICAPModXact::doneAll() const | |
454 | { | |
455 | return ICAPXaction::doneAll() && !state.serviceWaiting && | |
5f8252d2 | 456 | doneSending() && |
774c051c | 457 | doneReading() && state.doneWriting(); |
458 | } | |
459 | ||
460 | void ICAPModXact::startReading() | |
461 | { | |
462 | Must(connection >= 0); | |
463 | Must(!reader); | |
5f8252d2 | 464 | Must(!adapted.header); |
465 | Must(!adapted.body_pipe); | |
774c051c | 466 | |
467 | // we use the same buffer for headers and body and then consume headers | |
468 | readMore(); | |
469 | } | |
470 | ||
471 | void ICAPModXact::readMore() | |
472 | { | |
3b299123 | 473 | if (reader || doneReading()) { |
c99de607 | 474 | debugs(93,3,HERE << "returning from readMore because reader or doneReading()"); |
774c051c | 475 | return; |
3b299123 | 476 | } |
774c051c | 477 | |
478 | // do not fill readBuf if we have no space to store the result | |
5f8252d2 | 479 | if (adapted.body_pipe != NULL && |
480 | !adapted.body_pipe->buf().hasPotentialSpace()) { | |
481 | debugs(93,3,HERE << "not reading because ICAP reply pipe is full"); | |
774c051c | 482 | return; |
3b299123 | 483 | } |
774c051c | 484 | |
485 | if (readBuf.hasSpace()) | |
486 | scheduleRead(); | |
3b299123 | 487 | else |
c99de607 | 488 | debugs(93,3,HERE << "nothing to do because !readBuf.hasSpace()"); |
774c051c | 489 | } |
490 | ||
491 | // comm module read a portion of the ICAP response for us | |
492 | void ICAPModXact::handleCommRead(size_t) | |
493 | { | |
494 | Must(!state.doneParsing()); | |
495 | parseMore(); | |
496 | readMore(); | |
497 | } | |
498 | ||
499 | void ICAPModXact::echoMore() | |
500 | { | |
501 | Must(state.sending == State::sendingVirgin); | |
5f8252d2 | 502 | Must(adapted.body_pipe != NULL); |
503 | Must(virginBodySending.active()); | |
504 | ||
505 | const size_t sizeMax = virginContentSize(virginBodySending); | |
506 | debugs(93,5, HERE << "will echo up to " << sizeMax << " bytes from " << | |
507 | virgin.body_pipe->status()); | |
508 | debugs(93,5, HERE << "will echo up to " << sizeMax << " bytes to " << | |
509 | adapted.body_pipe->status()); | |
510 | ||
511 | if (sizeMax > 0) { | |
512 | const size_t size = adapted.body_pipe->putMoreData(virginContentData(virginBodySending), sizeMax); | |
513 | debugs(93,5, HERE << "echoed " << size << " out of " << sizeMax << | |
774c051c | 514 | " bytes"); |
5f8252d2 | 515 | virginBodySending.progress(size); |
774c051c | 516 | virginConsume(); |
478cfe99 | 517 | disableBypass("echoed content"); |
774c051c | 518 | } |
519 | ||
5f8252d2 | 520 | if (virginBodyEndReached(virginBodySending)) { |
521 | debugs(93, 5, "ICAPModXact echoed all" << status()); | |
774c051c | 522 | stopSending(true); |
523 | } else { | |
5f8252d2 | 524 | debugs(93, 5, "ICAPModXact has " << |
525 | virgin.body_pipe->buf().contentSize() << " bytes " << | |
526 | "and expects more to echo" << status()); | |
527 | // TODO: timeout if virgin or adapted pipes are broken | |
774c051c | 528 | } |
529 | } | |
530 | ||
531 | bool ICAPModXact::doneSending() const | |
532 | { | |
774c051c | 533 | return state.sending == State::sendingDone; |
534 | } | |
535 | ||
478cfe99 | 536 | // stop (or do not start) sending adapted message body |
774c051c | 537 | void ICAPModXact::stopSending(bool nicely) |
538 | { | |
539 | if (doneSending()) | |
540 | return; | |
541 | ||
542 | if (state.sending != State::sendingUndecided) { | |
5f8252d2 | 543 | debugs(93, 7, "ICAPModXact will no longer send" << status()); |
544 | if (adapted.body_pipe != NULL) { | |
545 | virginBodySending.disable(); | |
546 | // we may leave debts if we were echoing and the virgin | |
547 | // body_pipe got exhausted before we echoed all planned bytes | |
548 | const bool leftDebts = adapted.body_pipe->needsMoreData(); | |
549 | stopProducingFor(adapted.body_pipe, nicely && !leftDebts); | |
550 | } | |
774c051c | 551 | } else { |
5f8252d2 | 552 | debugs(93, 7, "ICAPModXact will not start sending" << status()); |
553 | Must(!adapted.body_pipe); | |
774c051c | 554 | } |
555 | ||
556 | state.sending = State::sendingDone; | |
5f8252d2 | 557 | checkConsuming(); |
774c051c | 558 | } |
559 | ||
5f8252d2 | 560 | // should be called after certain state.writing or state.sending changes |
561 | void ICAPModXact::checkConsuming() | |
774c051c | 562 | { |
5f8252d2 | 563 | // quit if we already stopped or are still using the pipe |
564 | if (!virgin.body_pipe || !state.doneConsumingVirgin()) | |
774c051c | 565 | return; |
566 | ||
5f8252d2 | 567 | debugs(93, 7, HERE << "will stop consuming" << status()); |
568 | stopConsumingFrom(virgin.body_pipe); | |
774c051c | 569 | } |
570 | ||
571 | void ICAPModXact::parseMore() | |
572 | { | |
aa761e5f | 573 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " bytes to parse" << |
774c051c | 574 | status()); |
d5cfacfb | 575 | debugs(93, 5, HERE << "\n" << readBuf.content()); |
774c051c | 576 | |
577 | if (state.parsingHeaders()) | |
578 | parseHeaders(); | |
579 | ||
580 | if (state.parsing == State::psBody) | |
581 | parseBody(); | |
582 | } | |
583 | ||
478cfe99 | 584 | void ICAPModXact::callException(const TextException &e) |
585 | { | |
586 | if (!canStartBypass || isRetriable) { | |
587 | ICAPXaction::callException(e); | |
588 | return; | |
589 | } | |
590 | ||
591 | try { | |
4932ad93 | 592 | debugs(93, 3, "bypassing ICAPModXact::" << inCall << " exception: " << |
478cfe99 | 593 | e.message << ' ' << status()); |
594 | bypassFailure(); | |
595 | } | |
596 | catch (const TextException &bypassE) { | |
597 | ICAPXaction::callException(bypassE); | |
598 | } | |
599 | } | |
600 | ||
601 | void ICAPModXact::bypassFailure() | |
602 | { | |
603 | disableBypass("already started to bypass"); | |
604 | ||
605 | Must(!isRetriable); // or we should not be bypassing | |
606 | ||
607 | prepEchoing(); | |
608 | ||
609 | startSending(); | |
610 | ||
611 | // end all activities associated with the ICAP server | |
612 | ||
613 | stopParsing(); | |
614 | ||
615 | stopWriting(true); // or should we force it? | |
616 | if (connection >= 0) { | |
617 | reuseConnection = false; // be conservative | |
618 | cancelRead(); // may not work; and we cannot stop connecting either | |
619 | if (!doneWithIo()) | |
620 | debugs(93, 7, "Warning: bypass failed to stop I/O" << status()); | |
621 | } | |
622 | } | |
623 | ||
624 | void ICAPModXact::disableBypass(const char *reason) | |
625 | { | |
626 | if (canStartBypass) { | |
627 | debugs(93,7, HERE << "will never start bypass because " << reason); | |
628 | canStartBypass = false; | |
629 | } | |
630 | } | |
631 | ||
632 | ||
633 | ||
774c051c | 634 | // note that allocation for echoing is done in handle204NoContent() |
635 | void ICAPModXact::maybeAllocateHttpMsg() | |
636 | { | |
5f8252d2 | 637 | if (adapted.header) // already allocated |
774c051c | 638 | return; |
639 | ||
640 | if (gotEncapsulated("res-hdr")) { | |
5f8252d2 | 641 | adapted.setHeader(new HttpReply); |
774c051c | 642 | } else if (gotEncapsulated("req-hdr")) { |
5f8252d2 | 643 | adapted.setHeader(new HttpRequest); |
774c051c | 644 | } else |
645 | throw TexcHere("Neither res-hdr nor req-hdr in maybeAllocateHttpMsg()"); | |
646 | } | |
647 | ||
648 | void ICAPModXact::parseHeaders() | |
649 | { | |
650 | Must(state.parsingHeaders()); | |
651 | ||
b107a5a5 | 652 | if (state.parsing == State::psIcapHeader) { |
653 | debugs(93, 5, HERE << "parse ICAP headers"); | |
774c051c | 654 | parseIcapHead(); |
b107a5a5 | 655 | } |
774c051c | 656 | |
b107a5a5 | 657 | if (state.parsing == State::psHttpHeader) { |
658 | debugs(93, 5, HERE << "parse HTTP headers"); | |
774c051c | 659 | parseHttpHead(); |
b107a5a5 | 660 | } |
774c051c | 661 | |
662 | if (state.parsingHeaders()) { // need more data | |
663 | Must(mayReadMore()); | |
664 | return; | |
665 | } | |
666 | ||
478cfe99 | 667 | startSending(); |
668 | } | |
669 | ||
670 | // called after parsing all headers or when bypassing an exception | |
671 | void ICAPModXact::startSending() | |
672 | { | |
673 | disableBypass("sent headers"); | |
c824c43b | 674 | sendAnswer(adapted.header); |
774c051c | 675 | |
676 | if (state.sending == State::sendingVirgin) | |
677 | echoMore(); | |
678 | } | |
679 | ||
680 | void ICAPModXact::parseIcapHead() | |
681 | { | |
682 | Must(state.sending == State::sendingUndecided); | |
683 | ||
684 | if (!parseHead(icapReply)) | |
685 | return; | |
686 | ||
fc764d26 | 687 | if (httpHeaderHasConnDir(&icapReply->header, "close")) { |
688 | debugs(93, 5, HERE << "found connection close"); | |
689 | reuseConnection = false; | |
690 | } | |
691 | ||
774c051c | 692 | switch (icapReply->sline.status) { |
693 | ||
694 | case 100: | |
695 | handle100Continue(); | |
696 | break; | |
697 | ||
698 | case 200: | |
b559db5d | 699 | |
700 | if (!validate200Ok()) { | |
701 | throw TexcHere("Invalid ICAP Response"); | |
702 | } else { | |
703 | handle200Ok(); | |
704 | } | |
705 | ||
774c051c | 706 | break; |
707 | ||
708 | case 204: | |
709 | handle204NoContent(); | |
710 | break; | |
711 | ||
712 | default: | |
b559db5d | 713 | debugs(93, 5, HERE << "ICAP status " << icapReply->sline.status); |
774c051c | 714 | handleUnknownScode(); |
715 | break; | |
716 | } | |
717 | ||
718 | // handle100Continue() manages state.writing on its own. | |
719 | // Non-100 status means the server needs no postPreview data from us. | |
720 | if (state.writing == State::writingPaused) | |
c99de607 | 721 | stopWriting(true); |
774c051c | 722 | |
723 | // TODO: Consider applying a Squid 2.5 patch to recognize 201 responses | |
724 | } | |
725 | ||
b559db5d | 726 | bool ICAPModXact::validate200Ok() |
727 | { | |
728 | if (ICAP::methodRespmod == service().method) { | |
729 | if (!gotEncapsulated("res-hdr")) | |
730 | return false; | |
731 | ||
732 | return true; | |
733 | } | |
734 | ||
735 | if (ICAP::methodReqmod == service().method) { | |
736 | if (!gotEncapsulated("res-hdr") && !gotEncapsulated("req-hdr")) | |
737 | return false; | |
738 | ||
739 | return true; | |
740 | } | |
741 | ||
742 | return false; | |
743 | } | |
744 | ||
774c051c | 745 | void ICAPModXact::handle100Continue() |
746 | { | |
747 | Must(state.writing == State::writingPaused); | |
5f8252d2 | 748 | // server must not respond before the end of preview: we may send ieof |
774c051c | 749 | Must(preview.enabled() && preview.done() && !preview.ieof()); |
774c051c | 750 | |
5f8252d2 | 751 | // 100 "Continue" cancels our preview commitment, not 204s outside preview |
752 | if (!state.allowedPostview204) | |
774c051c | 753 | stopBackup(); |
754 | ||
c99de607 | 755 | state.parsing = State::psIcapHeader; // eventually |
756 | icapReply->reset(); | |
774c051c | 757 | |
758 | state.writing = State::writingPrime; | |
759 | ||
760 | writeMore(); | |
761 | } | |
762 | ||
763 | void ICAPModXact::handle200Ok() | |
764 | { | |
765 | state.parsing = State::psHttpHeader; | |
766 | state.sending = State::sendingAdapted; | |
767 | stopBackup(); | |
5f8252d2 | 768 | checkConsuming(); |
774c051c | 769 | } |
770 | ||
771 | void ICAPModXact::handle204NoContent() | |
772 | { | |
773 | stopParsing(); | |
478cfe99 | 774 | prepEchoing(); |
775 | } | |
776 | ||
777 | // Called when we receive a 204 No Content response and | |
778 | // when we are trying to bypass a service failure. | |
779 | // We actually start sending (echoig or not) in startSending. | |
780 | void ICAPModXact::prepEchoing() | |
781 | { | |
782 | disableBypass("preparing to echo content"); | |
774c051c | 783 | |
784 | // We want to clone the HTTP message, but we do not want | |
5f8252d2 | 785 | // to copy some non-HTTP state parts that HttpMsg kids carry in them. |
774c051c | 786 | // Thus, we cannot use a smart pointer, copy constructor, or equivalent. |
787 | // Instead, we simply write the HTTP message and "clone" it by parsing. | |
788 | ||
5f8252d2 | 789 | HttpMsg *oldHead = virgin.header; |
774c051c | 790 | debugs(93, 7, "ICAPModXact cloning virgin message " << oldHead); |
791 | ||
792 | MemBuf httpBuf; | |
793 | ||
794 | // write the virgin message into a memory buffer | |
795 | httpBuf.init(); | |
796 | packHead(httpBuf, oldHead); | |
797 | ||
c99de607 | 798 | // allocate the adapted message and copy metainfo |
5f8252d2 | 799 | Must(!adapted.header); |
7514268e | 800 | HttpMsg *newHead = NULL; |
c99de607 | 801 | if (const HttpRequest *oldR = dynamic_cast<const HttpRequest*>(oldHead)) { |
802 | HttpRequest *newR = new HttpRequest; | |
5f8252d2 | 803 | inheritVirginProperties(*newR, *oldR); |
c99de607 | 804 | newHead = newR; |
805 | } else | |
806 | if (dynamic_cast<const HttpReply*>(oldHead)) | |
807 | newHead = new HttpReply; | |
774c051c | 808 | Must(newHead); |
809 | ||
5f8252d2 | 810 | adapted.setHeader(newHead); |
7514268e | 811 | |
774c051c | 812 | // parse the buffer back |
813 | http_status error = HTTP_STATUS_NONE; | |
814 | ||
815 | Must(newHead->parse(&httpBuf, true, &error)); | |
816 | ||
817 | Must(newHead->hdr_sz == httpBuf.contentSize()); // no leftovers | |
818 | ||
819 | httpBuf.clean(); | |
820 | ||
5f8252d2 | 821 | debugs(93, 7, "ICAPModXact cloned virgin message " << oldHead << " to " << |
822 | newHead); | |
823 | ||
824 | // setup adapted body pipe if needed | |
825 | if (oldHead->body_pipe != NULL) { | |
826 | debugs(93, 7, HERE << "will echo virgin body from " << | |
827 | oldHead->body_pipe); | |
478cfe99 | 828 | if (!virginBodySending.active()) |
829 | virginBodySending.plan(); // will throw if not possible | |
5f8252d2 | 830 | state.sending = State::sendingVirgin; |
831 | checkConsuming(); | |
478cfe99 | 832 | |
5f8252d2 | 833 | // TODO: optimize: is it possible to just use the oldHead pipe and |
834 | // remove ICAP from the loop? This echoing is probably a common case! | |
835 | makeAdaptedBodyPipe("echoed virgin response"); | |
836 | if (oldHead->body_pipe->bodySizeKnown()) | |
837 | adapted.body_pipe->setBodySize(oldHead->body_pipe->bodySize()); | |
838 | debugs(93, 7, HERE << "will echo virgin body to " << | |
839 | adapted.body_pipe); | |
840 | } else { | |
841 | debugs(93, 7, HERE << "no virgin body to echo"); | |
842 | stopSending(true); | |
843 | } | |
774c051c | 844 | } |
845 | ||
846 | void ICAPModXact::handleUnknownScode() | |
847 | { | |
848 | stopParsing(); | |
849 | stopBackup(); | |
850 | // TODO: mark connection as "bad" | |
851 | ||
852 | // Terminate the transaction; we do not know how to handle this response. | |
853 | throw TexcHere("Unsupported ICAP status code"); | |
854 | } | |
855 | ||
856 | void ICAPModXact::parseHttpHead() | |
857 | { | |
858 | if (gotEncapsulated("res-hdr") || gotEncapsulated("req-hdr")) { | |
859 | maybeAllocateHttpMsg(); | |
860 | ||
5f8252d2 | 861 | if (!parseHead(adapted.header)) |
c99de607 | 862 | return; // need more header data |
5f8252d2 | 863 | |
864 | if (HttpRequest *newHead = dynamic_cast<HttpRequest*>(adapted.header)) { | |
865 | const HttpRequest *oldR = dynamic_cast<const HttpRequest*>(virgin.header); | |
866 | Must(oldR); | |
867 | // TODO: the adapted request did not really originate from the | |
868 | // client; give proxy admin an option to prevent copying of | |
869 | // sensitive client information here. See the following thread: | |
870 | // http://www.squid-cache.org/mail-archive/squid-dev/200703/0040.html | |
871 | inheritVirginProperties(*newHead, *oldR); | |
872 | } | |
774c051c | 873 | } |
874 | ||
5f8252d2 | 875 | decideOnParsingBody(); |
774c051c | 876 | } |
877 | ||
c99de607 | 878 | // parses both HTTP and ICAP headers |
774c051c | 879 | bool ICAPModXact::parseHead(HttpMsg *head) |
880 | { | |
c99de607 | 881 | Must(head); |
def17b6a | 882 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " head bytes to parse" << |
774c051c | 883 | "; state: " << state.parsing); |
884 | ||
885 | http_status error = HTTP_STATUS_NONE; | |
886 | const bool parsed = head->parse(&readBuf, commEof, &error); | |
887 | Must(parsed || !error); // success or need more data | |
888 | ||
c99de607 | 889 | if (!parsed) { // need more data |
b107a5a5 | 890 | debugs(93, 5, HERE << "parse failed, need more data, return false"); |
774c051c | 891 | head->reset(); |
892 | return false; | |
893 | } | |
894 | ||
b107a5a5 | 895 | debugs(93, 5, HERE << "parse success, consume " << head->hdr_sz << " bytes, return true"); |
774c051c | 896 | readBuf.consume(head->hdr_sz); |
897 | return true; | |
898 | } | |
899 | ||
5f8252d2 | 900 | // TODO: Move this method to HttpRequest? |
901 | void ICAPModXact::inheritVirginProperties(HttpRequest &newR, const HttpRequest &oldR) { | |
774c051c | 902 | |
5f8252d2 | 903 | newR.client_addr = oldR.client_addr; |
904 | newR.client_port = oldR.client_port; | |
905 | ||
906 | newR.my_addr = oldR.my_addr; | |
907 | newR.my_port = oldR.my_port; | |
908 | ||
909 | // This may be too conservative for the 204 No Content case | |
910 | // may eventually need cloneNullAdaptationImmune() for that. | |
911 | newR.flags = oldR.flags.cloneAdaptationImmune(); | |
774c051c | 912 | |
5f8252d2 | 913 | if (oldR.auth_user_request) { |
914 | newR.auth_user_request = oldR.auth_user_request; | |
61527519 | 915 | AUTHUSERREQUESTLOCK(newR.auth_user_request, "newR in ICAPModXact"); |
5f8252d2 | 916 | } |
917 | } | |
918 | ||
919 | void ICAPModXact::decideOnParsingBody() { | |
200ac359 | 920 | if (gotEncapsulated("res-body") || gotEncapsulated("req-body")) { |
5f8252d2 | 921 | debugs(93, 5, HERE << "expecting a body"); |
922 | state.parsing = State::psBody; | |
923 | bodyParser = new ChunkedCodingParser; | |
924 | makeAdaptedBodyPipe("adapted response from the ICAP server"); | |
925 | Must(state.sending == State::sendingAdapted); | |
774c051c | 926 | } else { |
b559db5d | 927 | debugs(93, 5, HERE << "not expecting a body"); |
5f8252d2 | 928 | stopParsing(); |
929 | stopSending(true); | |
774c051c | 930 | } |
774c051c | 931 | } |
932 | ||
5f8252d2 | 933 | void ICAPModXact::parseBody() |
774c051c | 934 | { |
5f8252d2 | 935 | Must(state.parsing == State::psBody); |
936 | Must(bodyParser); | |
774c051c | 937 | |
5f8252d2 | 938 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " body bytes to parse"); |
774c051c | 939 | |
5f8252d2 | 940 | // the parser will throw on errors |
941 | BodyPipeCheckout bpc(*adapted.body_pipe); | |
942 | const bool parsed = bodyParser->parse(&readBuf, &bpc.buf); | |
943 | bpc.checkIn(); | |
774c051c | 944 | |
aa761e5f | 945 | debugs(93, 5, HERE << "have " << readBuf.contentSize() << " body bytes after " << |
774c051c | 946 | "parse; parsed all: " << parsed); |
947 | ||
478cfe99 | 948 | // TODO: expose BodyPipe::putSize() to make this check simpler and clearer |
949 | if (adapted.body_pipe->buf().contentSize() > 0) // parsed something sometime | |
950 | disableBypass("sent adapted content"); | |
951 | ||
5f8252d2 | 952 | if (parsed) { |
953 | stopParsing(); | |
954 | stopSending(true); // the parser succeeds only if all parsed data fits | |
955 | return; | |
956 | } | |
774c051c | 957 | |
c99de607 | 958 | debugs(93,3,HERE << this << " needsMoreData = " << bodyParser->needsMoreData()); |
3b299123 | 959 | |
960 | if (bodyParser->needsMoreData()) { | |
c99de607 | 961 | debugs(93,3,HERE << this); |
774c051c | 962 | Must(mayReadMore()); |
3b299123 | 963 | readMore(); |
964 | } | |
774c051c | 965 | |
966 | if (bodyParser->needsMoreSpace()) { | |
967 | Must(!doneSending()); // can hope for more space | |
5f8252d2 | 968 | Must(adapted.body_pipe->buf().contentSize() > 0); // paranoid |
969 | // TODO: there should be a timeout in case the sink is broken | |
970 | // or cannot consume partial content (while we need more space) | |
774c051c | 971 | } |
774c051c | 972 | } |
973 | ||
974 | void ICAPModXact::stopParsing() | |
975 | { | |
976 | if (state.parsing == State::psDone) | |
977 | return; | |
978 | ||
5f8252d2 | 979 | debugs(93, 7, "ICAPModXact will no longer parse" << status()); |
774c051c | 980 | |
981 | delete bodyParser; | |
982 | ||
983 | bodyParser = NULL; | |
984 | ||
985 | state.parsing = State::psDone; | |
986 | } | |
987 | ||
988 | // HTTP side added virgin body data | |
5f8252d2 | 989 | void ICAPModXact::noteMoreBodyDataAvailable(BodyPipe &) |
774c051c | 990 | { |
5f8252d2 | 991 | ICAPXaction_Enter(noteMoreBodyDataAvailable); |
774c051c | 992 | |
774c051c | 993 | writeMore(); |
994 | ||
995 | if (state.sending == State::sendingVirgin) | |
996 | echoMore(); | |
997 | ||
998 | ICAPXaction_Exit(); | |
999 | } | |
1000 | ||
1001 | // HTTP side sent us all virgin info | |
5f8252d2 | 1002 | void ICAPModXact::noteBodyProductionEnded(BodyPipe &) |
774c051c | 1003 | { |
5f8252d2 | 1004 | ICAPXaction_Enter(noteBodyProductionEnded); |
774c051c | 1005 | |
5f8252d2 | 1006 | Must(virgin.body_pipe->productionEnded()); |
774c051c | 1007 | |
1008 | // push writer and sender in case we were waiting for the last-chunk | |
1009 | writeMore(); | |
1010 | ||
1011 | if (state.sending == State::sendingVirgin) | |
1012 | echoMore(); | |
1013 | ||
1014 | ICAPXaction_Exit(); | |
1015 | } | |
1016 | ||
585ab260 | 1017 | // body producer aborted, but the initiator may still want to know |
1018 | // the answer, even though the HTTP message has been truncated | |
5f8252d2 | 1019 | void ICAPModXact::noteBodyProducerAborted(BodyPipe &) |
774c051c | 1020 | { |
5f8252d2 | 1021 | ICAPXaction_Enter(noteBodyProducerAborted); |
1022 | ||
585ab260 | 1023 | Must(virgin.body_pipe->productionEnded()); |
1024 | ||
1025 | // push writer and sender in case we were waiting for the last-chunk | |
1026 | writeMore(); | |
1027 | ||
1028 | if (state.sending == State::sendingVirgin) | |
1029 | echoMore(); | |
774c051c | 1030 | |
5f8252d2 | 1031 | ICAPXaction_Exit(); |
1032 | } | |
1033 | ||
5f8252d2 | 1034 | // adapted body consumer wants more adapted data and |
1035 | // possibly freed some buffer space | |
1036 | void ICAPModXact::noteMoreBodySpaceAvailable(BodyPipe &) | |
774c051c | 1037 | { |
5f8252d2 | 1038 | ICAPXaction_Enter(noteMoreBodySpaceAvailable); |
774c051c | 1039 | |
1040 | if (state.sending == State::sendingVirgin) | |
1041 | echoMore(); | |
3b299123 | 1042 | else if (state.sending == State::sendingAdapted) |
1043 | parseMore(); | |
774c051c | 1044 | else |
3b299123 | 1045 | Must(state.sending == State::sendingUndecided); |
774c051c | 1046 | |
1047 | ICAPXaction_Exit(); | |
1048 | } | |
1049 | ||
5f8252d2 | 1050 | // adapted body consumer aborted |
1051 | void ICAPModXact::noteBodyConsumerAborted(BodyPipe &) | |
774c051c | 1052 | { |
5f8252d2 | 1053 | ICAPXaction_Enter(noteBodyConsumerAborted); |
774c051c | 1054 | |
5f8252d2 | 1055 | mustStop("adapted body consumer aborted"); |
774c051c | 1056 | |
1057 | ICAPXaction_Exit(); | |
1058 | } | |
1059 | ||
1060 | // internal cleanup | |
5f8252d2 | 1061 | void ICAPModXact::swanSong() |
774c051c | 1062 | { |
5f8252d2 | 1063 | debugs(93, 5, HERE << "swan sings" << status()); |
1064 | ||
c99de607 | 1065 | stopWriting(false); |
c824c43b | 1066 | stopSending(false); |
774c051c | 1067 | |
1068 | if (icapReply) { | |
1069 | delete icapReply; | |
1070 | icapReply = NULL; | |
1071 | } | |
1072 | ||
5f8252d2 | 1073 | ICAPXaction::swanSong(); |
774c051c | 1074 | } |
1075 | ||
1076 | void ICAPModXact::makeRequestHeaders(MemBuf &buf) | |
1077 | { | |
12b91c99 | 1078 | /* |
1079 | * XXX These should use HttpHdr interfaces instead of Printfs | |
1080 | */ | |
774c051c | 1081 | const ICAPServiceRep &s = service(); |
30abd221 | 1082 | buf.Printf("%s %s ICAP/1.0\r\n", s.methodStr(), s.uri.buf()); |
1083 | buf.Printf("Host: %s:%d\r\n", s.host.buf(), s.port); | |
12b91c99 | 1084 | buf.Printf("Date: %s\r\n", mkrfc1123(squid_curtime)); |
1085 | ||
1086 | if (!TheICAPConfig.reuse_connections) | |
1087 | buf.Printf("Connection: close\r\n"); | |
1088 | ||
774c051c | 1089 | buf.Printf("Encapsulated: "); |
1090 | ||
1091 | MemBuf httpBuf; | |
12b91c99 | 1092 | |
774c051c | 1093 | httpBuf.init(); |
1094 | ||
1095 | // build HTTP request header, if any | |
1096 | ICAP::Method m = s.method; | |
1097 | ||
5f8252d2 | 1098 | const HttpRequest *request = virgin.cause ? |
1099 | virgin.cause : | |
1100 | dynamic_cast<const HttpRequest*>(virgin.header); | |
c99de607 | 1101 | |
5f8252d2 | 1102 | // to simplify, we could assume that request is always available |
c99de607 | 1103 | |
30abd221 | 1104 | String urlPath; |
c99de607 | 1105 | if (request) { |
1106 | urlPath = request->urlpath; | |
1107 | if (ICAP::methodRespmod == m) | |
1108 | encapsulateHead(buf, "req-hdr", httpBuf, request); | |
1109 | else | |
1110 | if (ICAP::methodReqmod == m) | |
5f8252d2 | 1111 | encapsulateHead(buf, "req-hdr", httpBuf, virgin.header); |
c99de607 | 1112 | } |
774c051c | 1113 | |
1114 | if (ICAP::methodRespmod == m) | |
5f8252d2 | 1115 | if (const HttpMsg *prime = virgin.header) |
774c051c | 1116 | encapsulateHead(buf, "res-hdr", httpBuf, prime); |
1117 | ||
1118 | if (!virginBody.expected()) | |
1dd6edf2 | 1119 | buf.Printf("null-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1120 | else if (ICAP::methodReqmod == m) |
1dd6edf2 | 1121 | buf.Printf("req-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1122 | else |
1dd6edf2 | 1123 | buf.Printf("res-body=%d", (int) httpBuf.contentSize()); |
774c051c | 1124 | |
1125 | buf.append(ICAP::crlf, 2); // terminate Encapsulated line | |
1126 | ||
c824c43b | 1127 | if (preview.enabled()) { |
774c051c | 1128 | buf.Printf("Preview: %d\r\n", (int)preview.ad()); |
5f8252d2 | 1129 | if (virginBody.expected()) // there is a body to preview |
1130 | virginBodySending.plan(); | |
1131 | else | |
1132 | finishNullOrEmptyBodyPreview(httpBuf); | |
774c051c | 1133 | } |
1134 | ||
1135 | if (shouldAllow204()) { | |
5f8252d2 | 1136 | debugs(93,5, HERE << "will allow 204s outside of preview"); |
1137 | state.allowedPostview204 = true; | |
774c051c | 1138 | buf.Printf("Allow: 204\r\n"); |
5f8252d2 | 1139 | if (virginBody.expected()) // there is a body to echo |
1140 | virginBodySending.plan(); | |
774c051c | 1141 | } |
1142 | ||
c99de607 | 1143 | if (TheICAPConfig.send_client_ip && request) |
1144 | if (request->client_addr.s_addr != any_addr.s_addr && | |
1145 | request->client_addr.s_addr != no_addr.s_addr) | |
12b91c99 | 1146 | buf.Printf("X-Client-IP: %s\r\n", inet_ntoa(request->client_addr)); |
a97e82a8 | 1147 | |
c99de607 | 1148 | if (TheICAPConfig.send_client_username && request) |
5f8252d2 | 1149 | makeUsernameHeader(request, buf); |
a97e82a8 | 1150 | |
2dfede9e | 1151 | // fprintf(stderr, "%s\n", buf.content()); |
a97e82a8 | 1152 | |
774c051c | 1153 | buf.append(ICAP::crlf, 2); // terminate ICAP header |
1154 | ||
1155 | // start ICAP request body with encapsulated HTTP headers | |
1156 | buf.append(httpBuf.content(), httpBuf.contentSize()); | |
1157 | ||
1158 | httpBuf.clean(); | |
1159 | } | |
1160 | ||
5f8252d2 | 1161 | void ICAPModXact::makeUsernameHeader(const HttpRequest *request, MemBuf &buf) { |
76f142cd | 1162 | if (const AuthUserRequest *auth = request->auth_user_request) { |
5f8252d2 | 1163 | if (char const *name = auth->username()) { |
1164 | const char *value = TheICAPConfig.client_username_encode ? | |
1165 | base64_encode(name) : name; | |
1166 | buf.Printf("%s: %s\r\n", TheICAPConfig.client_username_header, | |
1167 | value); | |
1168 | } | |
1169 | } | |
1170 | } | |
1171 | ||
774c051c | 1172 | void ICAPModXact::encapsulateHead(MemBuf &icapBuf, const char *section, MemBuf &httpBuf, const HttpMsg *head) |
1173 | { | |
1174 | // update ICAP header | |
7cab7e9f | 1175 | icapBuf.Printf("%s=%d, ", section, (int) httpBuf.contentSize()); |
774c051c | 1176 | |
1177 | // pack HTTP head | |
1178 | packHead(httpBuf, head); | |
1179 | } | |
1180 | ||
1181 | void ICAPModXact::packHead(MemBuf &httpBuf, const HttpMsg *head) | |
1182 | { | |
1183 | Packer p; | |
1184 | packerToMemInit(&p, &httpBuf); | |
1185 | head->packInto(&p, true); | |
1186 | packerClean(&p); | |
1187 | } | |
1188 | ||
1189 | // decides whether to offer a preview and calculates its size | |
c824c43b | 1190 | void ICAPModXact::decideOnPreview() |
774c051c | 1191 | { |
7cdbbd47 | 1192 | if (!TheICAPConfig.preview_enable) { |
1193 | debugs(93, 5, HERE << "preview disabled by squid.conf"); | |
c824c43b | 1194 | return; |
7cdbbd47 | 1195 | } |
1196 | ||
c824c43b | 1197 | const HttpRequest *request = virgin.cause ? |
1198 | virgin.cause : | |
1199 | dynamic_cast<const HttpRequest*>(virgin.header); | |
30abd221 | 1200 | const String urlPath = request ? request->urlpath : String(); |
5f8252d2 | 1201 | size_t wantedSize; |
c99de607 | 1202 | if (!service().wantsPreview(urlPath, wantedSize)) { |
1203 | debugs(93, 5, "ICAPModXact should not offer preview for " << urlPath); | |
c824c43b | 1204 | return; |
774c051c | 1205 | } |
1206 | ||
c824c43b | 1207 | // we decided to do preview, now compute its size |
1208 | ||
774c051c | 1209 | Must(wantedSize >= 0); |
1210 | ||
1211 | // cannot preview more than we can backup | |
1212 | size_t ad = XMIN(wantedSize, TheBackupLimit); | |
1213 | ||
5f8252d2 | 1214 | if (!virginBody.expected()) |
1215 | ad = 0; | |
774c051c | 1216 | else |
5f8252d2 | 1217 | if (virginBody.knownSize()) |
47f6e231 | 1218 | ad = XMIN(static_cast<uint64_t>(ad), virginBody.size()); // not more than we have |
774c051c | 1219 | |
1220 | debugs(93, 5, "ICAPModXact should offer " << ad << "-byte preview " << | |
1221 | "(service wanted " << wantedSize << ")"); | |
1222 | ||
1223 | preview.enable(ad); | |
5f8252d2 | 1224 | Must(preview.enabled()); |
774c051c | 1225 | } |
1226 | ||
1227 | // decides whether to allow 204 responses | |
1228 | bool ICAPModXact::shouldAllow204() | |
1229 | { | |
1230 | if (!service().allows204()) | |
1231 | return false; | |
1232 | ||
c824c43b | 1233 | return canBackupEverything(); |
1234 | } | |
1235 | ||
1236 | // used by shouldAllow204 and decideOnRetries | |
1237 | bool ICAPModXact::canBackupEverything() const | |
1238 | { | |
774c051c | 1239 | if (!virginBody.expected()) |
c824c43b | 1240 | return true; // no body means no problems with backup |
774c051c | 1241 | |
c824c43b | 1242 | // if there is a body, check whether we can backup it all |
774c051c | 1243 | |
1244 | if (!virginBody.knownSize()) | |
1245 | return false; | |
1246 | ||
1247 | // or should we have a different backup limit? | |
1248 | // note that '<' allows for 0-termination of the "full" backup buffer | |
1249 | return virginBody.size() < TheBackupLimit; | |
1250 | } | |
1251 | ||
c824c43b | 1252 | // Decide whether this transaction can be retried if pconn fails |
1253 | // Must be called after decideOnPreview and before openConnection() | |
1254 | void ICAPModXact::decideOnRetries() | |
1255 | { | |
1256 | if (!isRetriable) | |
1257 | return; // no, already decided | |
1258 | ||
1259 | if (preview.enabled()) | |
1260 | return; // yes, because preview provides enough guarantees | |
1261 | ||
1262 | if (canBackupEverything()) | |
1263 | return; // yes, because we can back everything up | |
1264 | ||
1265 | disableRetries(); // no, because we cannot back everything up | |
1266 | } | |
1267 | ||
5f8252d2 | 1268 | // Normally, the body-writing code handles preview body. It can deal with |
1269 | // bodies of unexpected size, including those that turn out to be empty. | |
1270 | // However, that code assumes that the body was expected and body control | |
1271 | // structures were initialized. This is not the case when there is no body | |
1272 | // or the body is known to be empty, because the virgin message will lack a | |
1273 | // body_pipe. So we handle preview of null-body and zero-size bodies here. | |
1274 | void ICAPModXact::finishNullOrEmptyBodyPreview(MemBuf &buf) | |
1275 | { | |
1276 | Must(!virginBodyWriting.active()); // one reason we handle it here | |
1277 | Must(!virgin.body_pipe); // another reason we handle it here | |
1278 | Must(!preview.ad()); | |
1279 | ||
1280 | // do not add last-chunk because our Encapsulated header says null-body | |
1281 | // addLastRequestChunk(buf); | |
1282 | preview.wrote(0, true); | |
1283 | ||
1284 | Must(preview.done()); | |
1285 | Must(preview.ieof()); | |
1286 | } | |
1287 | ||
774c051c | 1288 | void ICAPModXact::fillPendingStatus(MemBuf &buf) const |
1289 | { | |
c99de607 | 1290 | ICAPXaction::fillPendingStatus(buf); |
1291 | ||
774c051c | 1292 | if (state.serviceWaiting) |
1293 | buf.append("U", 1); | |
1294 | ||
5f8252d2 | 1295 | if (virgin.body_pipe != NULL) |
c99de607 | 1296 | buf.append("R", 1); |
1297 | ||
5f8252d2 | 1298 | if (connection > 0 && !doneReading()) |
c99de607 | 1299 | buf.append("r", 1); |
1300 | ||
774c051c | 1301 | if (!state.doneWriting() && state.writing != State::writingInit) |
1302 | buf.Printf("w(%d)", state.writing); | |
1303 | ||
1304 | if (preview.enabled()) { | |
1305 | if (!preview.done()) | |
1dd6edf2 | 1306 | buf.Printf("P(%d)", (int) preview.debt()); |
774c051c | 1307 | } |
1308 | ||
5f8252d2 | 1309 | if (virginBodySending.active()) |
774c051c | 1310 | buf.append("B", 1); |
1311 | ||
1312 | if (!state.doneParsing() && state.parsing != State::psIcapHeader) | |
1313 | buf.Printf("p(%d)", state.parsing); | |
1314 | ||
1315 | if (!doneSending() && state.sending != State::sendingUndecided) | |
1316 | buf.Printf("S(%d)", state.sending); | |
478cfe99 | 1317 | |
1318 | if (canStartBypass) | |
1319 | buf.append("Y", 1); | |
774c051c | 1320 | } |
1321 | ||
1322 | void ICAPModXact::fillDoneStatus(MemBuf &buf) const | |
1323 | { | |
c99de607 | 1324 | ICAPXaction::fillDoneStatus(buf); |
1325 | ||
5f8252d2 | 1326 | if (!virgin.body_pipe) |
774c051c | 1327 | buf.append("R", 1); |
1328 | ||
1329 | if (state.doneWriting()) | |
1330 | buf.append("w", 1); | |
1331 | ||
1332 | if (preview.enabled()) { | |
1333 | if (preview.done()) | |
1334 | buf.Printf("P%s", preview.ieof() ? "(ieof)" : ""); | |
1335 | } | |
1336 | ||
1337 | if (doneReading()) | |
1338 | buf.append("r", 1); | |
1339 | ||
1340 | if (state.doneParsing()) | |
1341 | buf.append("p", 1); | |
1342 | ||
1343 | if (doneSending()) | |
1344 | buf.append("S", 1); | |
1345 | } | |
1346 | ||
1347 | bool ICAPModXact::gotEncapsulated(const char *section) const | |
1348 | { | |
a9925b40 | 1349 | return icapReply->header.getByNameListMember("Encapsulated", |
1350 | section, ',').size() > 0; | |
774c051c | 1351 | } |
1352 | ||
1353 | // calculate whether there is a virgin HTTP body and | |
1354 | // whether its expected size is known | |
5f8252d2 | 1355 | // TODO: rename because we do not just estimate |
774c051c | 1356 | void ICAPModXact::estimateVirginBody() |
1357 | { | |
5f8252d2 | 1358 | // note: lack of size info may disable previews and 204s |
774c051c | 1359 | |
5f8252d2 | 1360 | HttpMsg *msg = virgin.header; |
1361 | Must(msg); | |
774c051c | 1362 | |
1363 | method_t method; | |
1364 | ||
5f8252d2 | 1365 | if (virgin.cause) |
1366 | method = virgin.cause->method; | |
774c051c | 1367 | else |
5f8252d2 | 1368 | if (HttpRequest *req = dynamic_cast<HttpRequest*>(msg)) |
1369 | method = req->method; | |
1370 | else | |
1371 | method = METHOD_NONE; | |
774c051c | 1372 | |
47f6e231 | 1373 | int64_t size; |
5f8252d2 | 1374 | // expectingBody returns true for zero-sized bodies, but we will not |
1375 | // get a pipe for that body, so we treat the message as bodyless | |
1376 | if (method != METHOD_NONE && msg->expectingBody(method, size) && size) { | |
1377 | debugs(93, 6, "ICAPModXact expects virgin body from " << | |
1378 | virgin.body_pipe << "; size: " << size); | |
1379 | ||
1380 | virginBody.expect(size); | |
1381 | virginBodyWriting.plan(); | |
1382 | ||
1383 | // sign up as a body consumer | |
1384 | Must(msg->body_pipe != NULL); | |
1385 | Must(msg->body_pipe == virgin.body_pipe); | |
1386 | Must(virgin.body_pipe->setConsumerIfNotLate(this)); | |
1387 | ||
1388 | // make sure TheBackupLimit is in-sync with the buffer size | |
1389 | Must(TheBackupLimit <= static_cast<size_t>(msg->body_pipe->buf().max_capacity)); | |
774c051c | 1390 | } else { |
1391 | debugs(93, 6, "ICAPModXact does not expect virgin body"); | |
5f8252d2 | 1392 | Must(msg->body_pipe == NULL); |
1393 | checkConsuming(); | |
774c051c | 1394 | } |
1395 | } | |
1396 | ||
5f8252d2 | 1397 | void ICAPModXact::makeAdaptedBodyPipe(const char *what) { |
1398 | Must(!adapted.body_pipe); | |
1399 | Must(!adapted.header->body_pipe); | |
1400 | adapted.header->body_pipe = new BodyPipe(this); | |
1401 | adapted.body_pipe = adapted.header->body_pipe; | |
1402 | debugs(93, 7, HERE << "will supply " << what << " via " << | |
1403 | adapted.body_pipe << " pipe"); | |
1404 | } | |
1405 | ||
774c051c | 1406 | |
1407 | // TODO: Move SizedEstimate, MemBufBackup, and ICAPPreview elsewhere | |
1408 | ||
1409 | SizedEstimate::SizedEstimate() | |
1410 | : theData(dtUnexpected) | |
1411 | {} | |
1412 | ||
47f6e231 | 1413 | void SizedEstimate::expect(int64_t aSize) |
774c051c | 1414 | { |
47f6e231 | 1415 | theData = (aSize >= 0) ? aSize : (int64_t)dtUnknown; |
774c051c | 1416 | } |
1417 | ||
1418 | bool SizedEstimate::expected() const | |
1419 | { | |
1420 | return theData != dtUnexpected; | |
1421 | } | |
1422 | ||
1423 | bool SizedEstimate::knownSize() const | |
1424 | { | |
1425 | Must(expected()); | |
1426 | return theData != dtUnknown; | |
1427 | } | |
1428 | ||
47f6e231 | 1429 | uint64_t SizedEstimate::size() const |
774c051c | 1430 | { |
1431 | Must(knownSize()); | |
47f6e231 | 1432 | return static_cast<uint64_t>(theData); |
774c051c | 1433 | } |
1434 | ||
1435 | ||
1436 | ||
478cfe99 | 1437 | VirginBodyAct::VirginBodyAct(): theStart(0), theState(stUndecided) |
774c051c | 1438 | {} |
1439 | ||
5f8252d2 | 1440 | void VirginBodyAct::plan() |
774c051c | 1441 | { |
478cfe99 | 1442 | Must(!disabled()); |
1443 | Must(!theStart); // not started | |
1444 | theState = stActive; | |
774c051c | 1445 | } |
1446 | ||
5f8252d2 | 1447 | void VirginBodyAct::disable() |
774c051c | 1448 | { |
478cfe99 | 1449 | theState = stDisabled; |
774c051c | 1450 | } |
1451 | ||
5f8252d2 | 1452 | void VirginBodyAct::progress(size_t size) |
774c051c | 1453 | { |
1454 | Must(active()); | |
1455 | Must(size >= 0); | |
47f6e231 | 1456 | theStart += static_cast<int64_t>(size); |
774c051c | 1457 | } |
1458 | ||
47f6e231 | 1459 | uint64_t VirginBodyAct::offset() const |
774c051c | 1460 | { |
1461 | Must(active()); | |
47f6e231 | 1462 | return static_cast<uint64_t>(theStart); |
774c051c | 1463 | } |
1464 | ||
774c051c | 1465 | |
1466 | ICAPPreview::ICAPPreview(): theWritten(0), theAd(0), theState(stDisabled) | |
1467 | {} | |
1468 | ||
1469 | void ICAPPreview::enable(size_t anAd) | |
1470 | { | |
1471 | // TODO: check for anAd not exceeding preview size limit | |
1472 | Must(anAd >= 0); | |
1473 | Must(!enabled()); | |
1474 | theAd = anAd; | |
1475 | theState = stWriting; | |
1476 | } | |
1477 | ||
1478 | bool ICAPPreview::enabled() const | |
1479 | { | |
1480 | return theState != stDisabled; | |
1481 | } | |
1482 | ||
1483 | size_t ICAPPreview::ad() const | |
1484 | { | |
1485 | Must(enabled()); | |
1486 | return theAd; | |
1487 | } | |
1488 | ||
1489 | bool ICAPPreview::done() const | |
1490 | { | |
1491 | Must(enabled()); | |
1492 | return theState >= stIeof; | |
1493 | } | |
1494 | ||
1495 | bool ICAPPreview::ieof() const | |
1496 | { | |
1497 | Must(enabled()); | |
1498 | return theState == stIeof; | |
1499 | } | |
1500 | ||
1501 | size_t ICAPPreview::debt() const | |
1502 | { | |
1503 | Must(enabled()); | |
1504 | return done() ? 0 : (theAd - theWritten); | |
1505 | } | |
1506 | ||
c99de607 | 1507 | void ICAPPreview::wrote(size_t size, bool wroteEof) |
774c051c | 1508 | { |
1509 | Must(enabled()); | |
5f8252d2 | 1510 | |
774c051c | 1511 | theWritten += size; |
1512 | ||
5f8252d2 | 1513 | Must(theWritten <= theAd); |
1514 | ||
1515 | if (wroteEof) | |
1516 | theState = stIeof; // written size is irrelevant | |
1517 | else | |
774c051c | 1518 | if (theWritten >= theAd) |
5f8252d2 | 1519 | theState = stDone; |
774c051c | 1520 | } |
1521 | ||
3cfc19b3 | 1522 | bool ICAPModXact::fillVirginHttpHeader(MemBuf &mb) const |
1523 | { | |
5f8252d2 | 1524 | if (virgin.header == NULL) |
3cfc19b3 | 1525 | return false; |
1526 | ||
5f8252d2 | 1527 | virgin.header->firstLineBuf(mb); |
3cfc19b3 | 1528 | |
1529 | return true; | |
1530 | } | |
c824c43b | 1531 | |
1532 | ||
1533 | /* ICAPModXactLauncher */ | |
1534 | ||
1535 | ICAPModXactLauncher::ICAPModXactLauncher(ICAPInitiator *anInitiator, HttpMsg *virginHeader, HttpRequest *virginCause, ICAPServiceRep::Pointer &aService): | |
1536 | ICAPLauncher("ICAPModXactLauncher", anInitiator, aService) | |
1537 | { | |
1538 | virgin.setHeader(virginHeader); | |
1539 | virgin.setCause(virginCause); | |
1540 | } | |
1541 | ||
1542 | ICAPXaction *ICAPModXactLauncher::createXaction() | |
1543 | { | |
1544 | return new ICAPModXact(this, virgin.header, virgin.cause, theService); | |
1545 | } |