2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.43 2003-06-25 21:57:45 adam Exp $
12 #include <yaz++/proxy.h>
14 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
15 Yaz_Z_Assoc(the_PDU_Observable)
17 m_PDU_Observable = the_PDU_Observable;
24 m_proxy_authentication = 0;
28 m_optimize = xstrdup ("1");
31 Yaz_Proxy::~Yaz_Proxy()
33 xfree (m_proxyTarget);
34 xfree (m_proxy_authentication);
38 void Yaz_Proxy::set_proxy_target(const char *target)
40 xfree (m_proxyTarget);
43 m_proxyTarget = (char *) xstrdup (target);
46 void Yaz_Proxy::set_proxy_authentication (const char *auth)
48 xfree (m_proxy_authentication);
49 m_proxy_authentication = 0;
51 m_proxy_authentication = (char *) xstrdup (auth);
54 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
55 *the_PDU_Observable, int fd)
57 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
58 new_proxy->m_parent = this;
59 new_proxy->timeout(m_idletime);
60 new_proxy->set_proxy_target(m_proxyTarget);
61 new_proxy->set_APDU_log(get_APDU_log());
62 new_proxy->set_proxy_authentication(m_proxy_authentication);
63 yaz_log (LOG_LOG, "New session p=%p", new_proxy);
67 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
70 Z_OtherInformationUnit *oi;
72 ent.proto = PROTO_Z3950;
73 ent.oclass = CLASS_USERINFO;
74 ent.value = (oid_value) VAL_COOKIE;
75 assert (oid_ent_to_oid (&ent, oid));
77 if (oid_ent_to_oid (&ent, oid) &&
78 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
79 oi->which == Z_OtherInfo_characterInfo)
80 return oi->information.characterInfo;
84 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
87 Z_OtherInformationUnit *oi;
89 ent.proto = PROTO_Z3950;
90 ent.oclass = CLASS_USERINFO;
91 ent.value = (oid_value) VAL_PROXY;
92 if (oid_ent_to_oid (&ent, oid) &&
93 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
94 oi->which == Z_OtherInfo_characterInfo)
95 return oi->information.characterInfo;
99 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
102 Yaz_Proxy *parent = m_parent;
103 Z_OtherInformation **oi;
104 Yaz_ProxyClient *c = m_client;
106 get_otherInfoAPDU(apdu, &oi);
107 char *cookie = get_cookie(oi);
109 const char *proxy_host = get_proxy(oi);
111 set_proxy_target(proxy_host);
113 // no target specified at all?
117 if (!strcmp(m_proxyTarget, "stop"))
119 if (cookie && *cookie)
121 Yaz_ProxyClient *cc = 0;
123 for (c = parent->m_clientPool; c; c = c->m_next)
126 assert (*c->m_prev == c);
127 if (!strcmp(cookie,c->m_cookie) &&
128 !strcmp(m_proxyTarget, c->get_hostname()))
137 // The following handles "cancel"
138 // If connection is busy (waiting for PDU) and
139 // we have an initRequest we can safely do re-open
140 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
142 yaz_log (LOG_LOG, "reopen target=%s", c->get_hostname());
144 c->client(m_proxyTarget);
148 c->m_last_resultCount = 0;
149 c->m_sr_transform = 0;
151 c->timeout(m_idletime);
153 c->m_seqno = parent->m_seqno;
154 if (c->m_server && c->m_server != this)
155 c->m_server->m_client = 0;
158 yaz_log (LOG_DEBUG, "get_client 1 %p %p", this, c);
164 Yaz_ProxyClient *cc = 0;
166 for (c = parent->m_clientPool; c; c = c->m_next)
169 assert (*c->m_prev == c);
170 if (c->m_server == 0 && c->m_cookie[0] == 0 &&
171 !strcmp(m_proxyTarget, c->get_hostname()))
181 yaz_log (LOG_LOG, "Reuse session %d to %d %s",
182 c->m_seqno, parent->m_seqno, c->get_hostname());
184 c->m_seqno = parent->m_seqno;
185 assert(c->m_server == 0);
194 if (apdu->which != Z_APDU_initRequest)
196 yaz_log (LOG_LOG, "no first INIT!");
199 Z_InitRequest *initRequest = apdu->u.initRequest;
201 if (!initRequest->idAuthentication)
203 if (m_proxy_authentication)
205 initRequest->idAuthentication =
206 (Z_IdAuthentication *)
207 odr_malloc (odr_encode(),
208 sizeof(*initRequest->idAuthentication));
209 initRequest->idAuthentication->which =
210 Z_IdAuthentication_open;
211 initRequest->idAuthentication->u.open =
212 odr_strdup (odr_encode(), m_proxy_authentication);
216 // go through list of clients - and find the lowest/oldest one.
217 Yaz_ProxyClient *c_min = 0;
219 int no_of_clients = 0;
220 if (parent->m_clientPool)
221 yaz_log (LOG_LOG, "Existing sessions");
222 for (c = parent->m_clientPool; c; c = c->m_next)
224 yaz_log (LOG_LOG, " Session %-3d wait=%d %s", c->m_seqno,
225 c->m_waiting, c->get_hostname());
227 if (min_seq < 0 || c->m_seqno < min_seq)
229 min_seq = c->m_seqno;
233 if (no_of_clients >= parent->m_max_clients)
236 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
238 yaz_log (LOG_LOG, "Replace session %d",
240 if (c->m_server && c->m_server != this)
246 yaz_log (LOG_LOG, "Move session %d to %d %s",
247 c->m_seqno, parent->m_seqno, c->get_hostname());
249 strcpy (c->m_cookie, cookie);
251 c->m_cookie[0] = '\0';
252 c->m_seqno = parent->m_seqno;
253 if (c->m_server && c->m_server != this)
255 c->m_server->m_client = 0;
259 yaz_log (LOG_DEBUG, "get_client 2 %p %p", this, c);
265 yaz_log (LOG_LOG, "Making session %d %s", parent->m_seqno,
267 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
268 c->m_next = parent->m_clientPool;
270 c->m_next->m_prev = &c->m_next;
271 parent->m_clientPool = c;
272 c->m_prev = &parent->m_clientPool;
275 strcpy (c->m_cookie, cookie);
277 c->m_cookie[0] = '\0';
278 yaz_log (LOG_LOG, "Connecting to %s", m_proxyTarget);
279 c->m_seqno = parent->m_seqno;
280 c->client(m_proxyTarget);
282 c->m_last_resultCount = 0;
284 c->m_sr_transform = 0;
290 yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
294 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
296 if (apdu->which != Z_APDU_searchRequest)
298 if (*m_parent->m_optimize == '0')
299 return apdu; // don't optimize result sets..
300 Z_SearchRequest *sr = apdu->u.searchRequest;
301 Yaz_Z_Query *this_query = new Yaz_Z_Query;
302 Yaz_Z_Databases this_databases;
304 this_databases.set(sr->num_databaseNames, (const char **)
307 this_query->set_Z_Query(sr->query);
309 if (m_client->m_last_ok && m_client->m_last_query &&
310 m_client->m_last_query->match(this_query) &&
311 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
312 m_client->m_last_databases.match(this_databases))
315 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
316 m_client->m_last_resultCount < *sr->largeSetLowerBound)
319 // send present request (medium size)
320 yaz_log (LOG_LOG, "Optimizing search for medium set");
321 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
322 Z_PresentRequest *pr = new_apdu->u.presentRequest;
323 pr->referenceId = sr->referenceId;
324 pr->resultSetId = sr->resultSetName;
325 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
326 if (*sr->mediumSetPresentNumber < m_client->m_last_resultCount)
327 *pr->numberOfRecordsRequested = *sr->mediumSetPresentNumber;
329 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
330 if (sr->mediumSetElementSetNames)
332 pr->recordComposition = (Z_RecordComposition *)
333 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
334 pr->recordComposition->which = Z_RecordComp_simple;
335 pr->recordComposition->u.simple = sr->mediumSetElementSetNames;
337 m_client->m_sr_transform = 1;
340 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
341 m_client->m_last_resultCount <= 0)
343 // large set. Return pseudo-search response immediately
344 yaz_log (LOG_LOG, "Optimizing search for large set");
345 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
346 new_apdu->u.searchResponse->referenceId = sr->referenceId;
347 new_apdu->u.searchResponse->resultCount =
348 &m_client->m_last_resultCount;
349 send_Z_PDU(new_apdu);
355 // send a present request (small set)
356 yaz_log (LOG_LOG, "Optimizing search for small set");
357 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
358 Z_PresentRequest *pr = new_apdu->u.presentRequest;
359 pr->referenceId = sr->referenceId;
360 pr->resultSetId = sr->resultSetName;
361 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
362 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
363 if (sr->smallSetElementSetNames)
365 pr->recordComposition = (Z_RecordComposition *)
366 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
367 pr->recordComposition->which = Z_RecordComp_simple;
368 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
370 m_client->m_sr_transform = 1;
376 delete m_client->m_last_query;
377 m_client->m_last_query = this_query;
378 m_client->m_last_ok = 0;
380 xfree (m_client->m_last_resultSetId);
381 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
383 m_client->m_last_databases.set(sr->num_databaseNames,
384 (const char **) sr->databaseNames);
389 static const char *apdu_name(Z_APDU *apdu)
393 case Z_APDU_initRequest:
394 return "initRequest";
395 case Z_APDU_initResponse:
396 return "initResponse";
397 case Z_APDU_searchRequest:
398 return "searchRequest";
399 case Z_APDU_searchResponse:
400 return "searchResponse";
401 case Z_APDU_presentRequest:
402 return "presentRequest";
403 case Z_APDU_presentResponse:
404 return "presentResponse";
405 case Z_APDU_deleteResultSetRequest:
406 return "deleteResultSetRequest";
407 case Z_APDU_deleteResultSetResponse:
408 return "deleteResultSetResponse";
409 case Z_APDU_scanRequest:
410 return "scanRequest";
411 case Z_APDU_scanResponse:
412 return "scanResponse";
413 case Z_APDU_sortRequest:
414 return "sortRequest";
415 case Z_APDU_sortResponse:
416 return "sortResponse";
417 case Z_APDU_extendedServicesRequest:
418 return "extendedServicesRequest";
419 case Z_APDU_extendedServicesResponse:
420 return "extendedServicesResponse";
427 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
429 yaz_log (LOG_LOG, "Receiving %s from client", apdu_name(apdu));
430 // Determine our client.
431 m_client = get_client(apdu);
437 m_client->m_server = this;
439 if (apdu->which == Z_APDU_initRequest)
441 if (m_client->m_init_flag)
443 Z_APDU *apdu = m_client->m_initResponse;
444 apdu->u.initResponse->otherInfo = 0;
445 if (m_client->m_cookie && *m_client->m_cookie)
446 set_otherInformationString(apdu, VAL_COOKIE, 1,
451 m_client->m_init_flag = 1;
453 apdu = result_set_optimize(apdu);
457 yaz_log (LOG_LOG, "Sending %s to %s",
458 apdu_name(apdu), m_client->get_hostname());
460 // delete other info part from PDU before sending to target
461 Z_OtherInformation **oi;
462 get_otherInfoAPDU(apdu, &oi);
466 if (m_client->send_Z_PDU(apdu) < 0)
473 m_client->m_waiting = 1;
476 void Yaz_Proxy::connectNotify()
480 void Yaz_Proxy::shutdown()
482 // only keep if keep_alive flag is set...
483 if (m_keepalive && m_client && m_client->m_waiting == 0)
485 yaz_log (LOG_LOG, "shutdown (client to proxy) keepalive %s",
486 m_client->get_hostname());
487 assert (m_client->m_waiting != 2);
488 // Tell client (if any) that no server connection is there..
489 m_client->m_server = 0;
493 yaz_log (LOG_LOG, "shutdown (client to proxy) close %s",
494 m_client->get_hostname());
495 assert (m_client->m_waiting != 2);
500 yaz_log (LOG_LOG, "shutdown (client to proxy) bad state");
505 yaz_log (LOG_LOG, "shutdown (client to proxy)");
510 void Yaz_ProxyClient::shutdown()
512 yaz_log (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
517 void Yaz_Proxy::failNotify()
519 yaz_log (LOG_LOG, "Yaz_Proxy connection closed by client");
523 void Yaz_ProxyClient::failNotify()
525 yaz_log (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
529 void Yaz_ProxyClient::connectNotify()
531 yaz_log (LOG_LOG, "Connection accepted by %s", get_hostname());
535 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
536 *the_PDU_Observable, int fd)
538 return new Yaz_ProxyClient(the_PDU_Observable);
541 Yaz_ProxyClient::~Yaz_ProxyClient()
546 m_next->m_prev = m_prev;
547 m_waiting = 2; // for debugging purposes only.
548 odr_destroy(m_init_odr);
550 xfree (m_last_resultSetId);
553 void Yaz_Proxy::timeoutNotify()
555 yaz_log (LOG_LOG, "timeout (client to proxy)");
559 void Yaz_ProxyClient::timeoutNotify()
561 yaz_log (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
565 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
566 Yaz_Z_Assoc (the_PDU_Observable)
573 m_last_resultSetId = 0;
574 m_last_resultCount = 0;
578 m_init_odr = odr_createmem (ODR_DECODE);
582 const char *Yaz_Proxy::option(const char *name, const char *value)
584 if (!strcmp (name, "optimize")) {
587 m_optimize = xstrdup (value);
594 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
597 yaz_log (LOG_LOG, "Receiving %s from %s", apdu_name(apdu),
599 if (apdu->which == Z_APDU_initResponse)
601 NMEM nmem = odr_extract_mem (odr_decode());
602 odr_reset (m_init_odr);
603 nmem_transfer (m_init_odr->mem, nmem);
604 m_initResponse = apdu;
607 if (apdu->which == Z_APDU_searchResponse)
609 m_last_resultCount = *apdu->u.searchResponse->resultCount;
610 int status = *apdu->u.searchResponse->searchStatus;
612 (!apdu->u.searchResponse->records ||
613 apdu->u.searchResponse->records->which == Z_Records_DBOSD))
616 if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
619 Z_PresentResponse *pr = apdu->u.presentResponse;
620 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
621 Z_SearchResponse *sr = new_apdu->u.searchResponse;
622 sr->referenceId = pr->referenceId;
623 *sr->resultCount = m_last_resultCount;
624 sr->records = pr->records;
625 sr->nextResultSetPosition = pr->nextResultSetPosition;
626 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
629 if (m_cookie && *m_cookie)
630 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
633 yaz_log (LOG_LOG, "Sending %s to client", apdu_name(apdu));
634 m_server->send_Z_PDU(apdu);
636 if (apdu->which == Z_APDU_close)