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