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