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