2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.47 2003-09-03 11:30:26 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 (c->m_cookie && !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);
149 c->m_last_resultCount = 0;
150 c->m_sr_transform = 0;
152 c->m_resultSetStartPoint = 0;
153 c->timeout(m_idletime);
155 c->m_seqno = parent->m_seqno;
156 if (c->m_server && c->m_server != this)
157 c->m_server->m_client = 0;
160 yaz_log (LOG_DEBUG, "get_client 1 %p %p", this, c);
166 Yaz_ProxyClient *cc = 0;
168 for (c = parent->m_clientPool; c; c = c->m_next)
171 assert (*c->m_prev == c);
172 if (c->m_server == 0 && c->m_cookie == 0 &&
173 !strcmp(m_proxyTarget, c->get_hostname()))
183 yaz_log (LOG_LOG, "Reuse session %d to %d %s",
184 c->m_seqno, parent->m_seqno, c->get_hostname());
186 c->m_seqno = parent->m_seqno;
187 assert(c->m_server == 0);
196 if (apdu->which != Z_APDU_initRequest)
198 yaz_log (LOG_LOG, "no first INIT!");
201 Z_InitRequest *initRequest = apdu->u.initRequest;
203 if (!initRequest->idAuthentication)
205 if (m_proxy_authentication)
207 initRequest->idAuthentication =
208 (Z_IdAuthentication *)
209 odr_malloc (odr_encode(),
210 sizeof(*initRequest->idAuthentication));
211 initRequest->idAuthentication->which =
212 Z_IdAuthentication_open;
213 initRequest->idAuthentication->u.open =
214 odr_strdup (odr_encode(), m_proxy_authentication);
218 // go through list of clients - and find the lowest/oldest one.
219 Yaz_ProxyClient *c_min = 0;
221 int no_of_clients = 0;
222 if (parent->m_clientPool)
223 yaz_log (LOG_LOG, "Existing sessions");
224 for (c = parent->m_clientPool; c; c = c->m_next)
226 yaz_log (LOG_LOG, " Session %-3d wait=%d %s cookie=%s", c->m_seqno,
227 c->m_waiting, c->get_hostname(),
228 c->m_cookie ? c->m_cookie : "");
230 if (min_seq < 0 || c->m_seqno < min_seq)
232 min_seq = c->m_seqno;
236 if (no_of_clients >= parent->m_max_clients)
239 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
241 yaz_log (LOG_LOG, "Replace session %d",
243 if (c->m_server && c->m_server != this)
249 yaz_log (LOG_LOG, "Move session %d to %d %s",
250 c->m_seqno, parent->m_seqno, c->get_hostname());
254 c->m_cookie = xstrdup(cookie);
255 c->m_seqno = parent->m_seqno;
256 if (c->m_server && c->m_server != this)
258 c->m_server->m_client = 0;
262 yaz_log (LOG_DEBUG, "get_client 2 %p %p", this, c);
268 yaz_log (LOG_LOG, "Making session %d %s", parent->m_seqno,
270 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
271 c->m_next = parent->m_clientPool;
273 c->m_next->m_prev = &c->m_next;
274 parent->m_clientPool = c;
275 c->m_prev = &parent->m_clientPool;
281 c->m_cookie = xstrdup(cookie);
283 yaz_log (LOG_LOG, "Connecting to %s", m_proxyTarget);
284 c->m_seqno = parent->m_seqno;
285 c->client(m_proxyTarget);
287 c->m_last_resultCount = 0;
290 c->m_sr_transform = 0;
292 c->m_resultSetStartPoint = 0;
297 yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
301 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
303 if (*m_parent->m_optimize == '0')
304 return apdu; // don't optimize result sets..
305 if (apdu->which == Z_APDU_presentRequest)
307 Z_PresentRequest *pr = apdu->u.presentRequest;
308 Z_NamePlusRecordList *npr;
309 int toget = *pr->numberOfRecordsRequested;
310 int start = *pr->resultSetStartPoint;
312 if (m_client->m_last_resultSetId &&
313 !strcmp(m_client->m_last_resultSetId, pr->resultSetId))
315 if (m_client->m_cache.lookup (odr_encode(), &npr, start, toget,
316 pr->preferredRecordSyntax,
317 pr->recordComposition))
319 yaz_log (LOG_LOG, "Returned cache records for present request");
320 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
321 new_apdu->u.presentResponse->referenceId = pr->referenceId;
323 new_apdu->u.presentResponse->numberOfRecordsReturned
324 = odr_intdup(odr_encode(), toget);
326 new_apdu->u.presentResponse->records = (Z_Records*)
327 odr_malloc(odr_encode(), sizeof(Z_Records));
328 new_apdu->u.presentResponse->records->which = Z_Records_DBOSD;
329 new_apdu->u.presentResponse->records->u.databaseOrSurDiagnostics = npr;
330 new_apdu->u.presentResponse->nextResultSetPosition =
331 odr_intdup(odr_encode(), start+toget);
332 send_Z_PDU(new_apdu);
338 if (apdu->which != Z_APDU_searchRequest)
340 Z_SearchRequest *sr = apdu->u.searchRequest;
341 Yaz_Z_Query *this_query = new Yaz_Z_Query;
342 Yaz_Z_Databases this_databases;
344 this_databases.set(sr->num_databaseNames, (const char **)
347 this_query->set_Z_Query(sr->query);
349 if (m_client->m_last_ok && m_client->m_last_query &&
350 m_client->m_last_query->match(this_query) &&
351 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
352 m_client->m_last_databases.match(this_databases))
355 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
356 m_client->m_last_resultCount < *sr->largeSetLowerBound)
358 Z_NamePlusRecordList *npr;
359 int toget = *sr->mediumSetPresentNumber;
360 Z_RecordComposition *comp = 0;
362 if (toget > m_client->m_last_resultCount)
363 toget = m_client->m_last_resultCount;
365 if (sr->mediumSetElementSetNames)
367 comp = (Z_RecordComposition *)
368 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
369 comp->which = Z_RecordComp_simple;
370 comp->u.simple = sr->mediumSetElementSetNames;
373 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
374 sr->preferredRecordSyntax, comp))
376 yaz_log (LOG_LOG, "Returned cache records for medium set");
377 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
378 new_apdu->u.searchResponse->referenceId = sr->referenceId;
379 new_apdu->u.searchResponse->resultCount =
380 &m_client->m_last_resultCount;
382 new_apdu->u.searchResponse->numberOfRecordsReturned
383 = odr_intdup(odr_encode(), toget);
385 new_apdu->u.searchResponse->presentStatus =
386 odr_intdup(odr_encode(), Z_PresentStatus_success);
387 new_apdu->u.searchResponse->records = (Z_Records*)
388 odr_malloc(odr_encode(), sizeof(Z_Records));
389 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
390 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
391 new_apdu->u.searchResponse->nextResultSetPosition =
392 odr_intdup(odr_encode(), toget+1);
393 send_Z_PDU(new_apdu);
399 // send present request (medium size)
400 yaz_log (LOG_LOG, "Optimizing search for medium set");
402 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
403 Z_PresentRequest *pr = new_apdu->u.presentRequest;
404 pr->referenceId = sr->referenceId;
405 pr->resultSetId = sr->resultSetName;
406 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
407 *pr->numberOfRecordsRequested = toget;
408 pr->recordComposition = comp;
409 m_client->m_sr_transform = 1;
413 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
414 m_client->m_last_resultCount <= 0)
416 // large set. Return pseudo-search response immediately
417 yaz_log (LOG_LOG, "Optimizing search for large set");
418 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
419 new_apdu->u.searchResponse->referenceId = sr->referenceId;
420 new_apdu->u.searchResponse->resultCount =
421 &m_client->m_last_resultCount;
422 send_Z_PDU(new_apdu);
427 Z_NamePlusRecordList *npr;
428 int toget = m_client->m_last_resultCount;
429 Z_RecordComposition *comp = 0;
431 // send a present request (small set)
433 if (sr->smallSetElementSetNames)
435 comp = (Z_RecordComposition *)
436 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
437 comp->which = Z_RecordComp_simple;
438 comp->u.simple = sr->smallSetElementSetNames;
441 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
442 sr->preferredRecordSyntax, comp))
444 yaz_log (LOG_LOG, "Returned cache records for small set");
445 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
446 new_apdu->u.searchResponse->referenceId = sr->referenceId;
447 new_apdu->u.searchResponse->resultCount =
448 &m_client->m_last_resultCount;
450 new_apdu->u.searchResponse->numberOfRecordsReturned
451 = odr_intdup(odr_encode(), toget);
453 new_apdu->u.searchResponse->presentStatus =
454 odr_intdup(odr_encode(), Z_PresentStatus_success);
455 new_apdu->u.searchResponse->records = (Z_Records*)
456 odr_malloc(odr_encode(), sizeof(Z_Records));
457 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
458 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
459 new_apdu->u.searchResponse->nextResultSetPosition =
460 odr_intdup(odr_encode(), toget+1);
461 send_Z_PDU(new_apdu);
466 yaz_log (LOG_LOG, "Optimizing search for small set");
467 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
468 Z_PresentRequest *pr = new_apdu->u.presentRequest;
469 pr->referenceId = sr->referenceId;
470 pr->resultSetId = sr->resultSetName;
471 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
472 *pr->numberOfRecordsRequested = toget;
473 pr->recordComposition = comp;
474 m_client->m_sr_transform = 1;
481 delete m_client->m_last_query;
482 m_client->m_last_query = this_query;
483 m_client->m_last_ok = 0;
484 m_client->m_cache.clear();
485 m_client->m_resultSetStartPoint = 0;
487 xfree (m_client->m_last_resultSetId);
488 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
490 m_client->m_last_databases.set(sr->num_databaseNames,
491 (const char **) sr->databaseNames);
496 static const char *apdu_name(Z_APDU *apdu)
500 case Z_APDU_initRequest:
501 return "initRequest";
502 case Z_APDU_initResponse:
503 return "initResponse";
504 case Z_APDU_searchRequest:
505 return "searchRequest";
506 case Z_APDU_searchResponse:
507 return "searchResponse";
508 case Z_APDU_presentRequest:
509 return "presentRequest";
510 case Z_APDU_presentResponse:
511 return "presentResponse";
512 case Z_APDU_deleteResultSetRequest:
513 return "deleteResultSetRequest";
514 case Z_APDU_deleteResultSetResponse:
515 return "deleteResultSetResponse";
516 case Z_APDU_scanRequest:
517 return "scanRequest";
518 case Z_APDU_scanResponse:
519 return "scanResponse";
520 case Z_APDU_sortRequest:
521 return "sortRequest";
522 case Z_APDU_sortResponse:
523 return "sortResponse";
524 case Z_APDU_extendedServicesRequest:
525 return "extendedServicesRequest";
526 case Z_APDU_extendedServicesResponse:
527 return "extendedServicesResponse";
534 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
536 yaz_log (LOG_LOG, "Receiving %s from client", apdu_name(apdu));
537 // Determine our client.
538 m_client = get_client(apdu);
544 m_client->m_server = this;
546 if (apdu->which == Z_APDU_initRequest)
548 if (m_client->m_init_flag)
550 Z_APDU *apdu = m_client->m_initResponse;
551 apdu->u.initResponse->otherInfo = 0;
552 if (m_client->m_cookie && *m_client->m_cookie)
553 set_otherInformationString(apdu, VAL_COOKIE, 1,
558 m_client->m_init_flag = 1;
560 apdu = result_set_optimize(apdu);
564 yaz_log (LOG_LOG, "Sending %s to %s",
565 apdu_name(apdu), m_client->get_hostname());
567 // delete other info part from PDU before sending to target
568 Z_OtherInformation **oi;
569 get_otherInfoAPDU(apdu, &oi);
573 if (apdu->which == Z_APDU_presentRequest &&
574 m_client->m_resultSetStartPoint == 0)
576 Z_PresentRequest *pr = apdu->u.presentRequest;
577 m_client->m_resultSetStartPoint = *pr->resultSetStartPoint;
578 m_client->m_cache.copy_presentRequest(apdu->u.presentRequest);
580 m_client->m_resultSetStartPoint = 0;
582 if (m_client->send_Z_PDU(apdu) < 0)
589 m_client->m_waiting = 1;
592 void Yaz_Proxy::connectNotify()
596 void Yaz_Proxy::shutdown()
598 // only keep if keep_alive flag is set...
599 if (m_keepalive && m_client && m_client->m_waiting == 0)
601 yaz_log (LOG_LOG, "shutdown (client to proxy) keepalive %s",
602 m_client->get_hostname());
603 assert (m_client->m_waiting != 2);
604 // Tell client (if any) that no server connection is there..
605 m_client->m_server = 0;
609 yaz_log (LOG_LOG, "shutdown (client to proxy) close %s",
610 m_client->get_hostname());
611 assert (m_client->m_waiting != 2);
616 yaz_log (LOG_LOG, "shutdown (client to proxy) bad state");
621 yaz_log (LOG_LOG, "shutdown (client to proxy)");
626 void Yaz_ProxyClient::shutdown()
628 yaz_log (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
633 void Yaz_Proxy::failNotify()
635 yaz_log (LOG_LOG, "Yaz_Proxy connection closed by client");
639 void Yaz_ProxyClient::failNotify()
641 yaz_log (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
645 void Yaz_ProxyClient::connectNotify()
647 yaz_log (LOG_LOG, "Connection accepted by %s", get_hostname());
651 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
652 *the_PDU_Observable, int fd)
654 return new Yaz_ProxyClient(the_PDU_Observable);
657 Yaz_ProxyClient::~Yaz_ProxyClient()
662 m_next->m_prev = m_prev;
663 m_waiting = 2; // for debugging purposes only.
664 odr_destroy(m_init_odr);
666 xfree (m_last_resultSetId);
670 void Yaz_Proxy::timeoutNotify()
672 yaz_log (LOG_LOG, "timeout (client to proxy)");
676 void Yaz_ProxyClient::timeoutNotify()
678 yaz_log (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
682 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
683 Yaz_Z_Assoc (the_PDU_Observable)
690 m_last_resultSetId = 0;
691 m_last_resultCount = 0;
695 m_init_odr = odr_createmem (ODR_DECODE);
697 m_resultSetStartPoint = 0;
700 const char *Yaz_Proxy::option(const char *name, const char *value)
702 if (!strcmp (name, "optimize")) {
705 m_optimize = xstrdup (value);
712 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
715 yaz_log (LOG_LOG, "Receiving %s from %s", apdu_name(apdu),
717 if (apdu->which == Z_APDU_initResponse)
719 NMEM nmem = odr_extract_mem (odr_decode());
720 odr_reset (m_init_odr);
721 nmem_transfer (m_init_odr->mem, nmem);
722 m_initResponse = apdu;
725 if (apdu->which == Z_APDU_searchResponse)
727 Z_SearchResponse *sr = apdu->u.searchResponse;
728 m_last_resultCount = *sr->resultCount;
729 int status = *sr->searchStatus;
730 if (status && (!sr->records || sr->records->which == Z_Records_DBOSD))
734 if (sr->records && sr->records->which == Z_Records_DBOSD)
736 m_cache.add(odr_decode(),
737 sr->records->u.databaseOrSurDiagnostics, 1,
742 if (apdu->which == Z_APDU_presentResponse)
744 Z_PresentResponse *pr = apdu->u.presentResponse;
748 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
749 Z_SearchResponse *sr = new_apdu->u.searchResponse;
750 sr->referenceId = pr->referenceId;
751 *sr->resultCount = m_last_resultCount;
752 sr->records = pr->records;
753 sr->nextResultSetPosition = pr->nextResultSetPosition;
754 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
757 if (pr->records->which == Z_Records_DBOSD && m_resultSetStartPoint)
759 m_cache.add(odr_decode(),
760 pr->records->u.databaseOrSurDiagnostics,
761 m_resultSetStartPoint, -1);
762 m_resultSetStartPoint = 0;
766 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
769 yaz_log (LOG_LOG, "Sending %s to client", apdu_name(apdu));
770 m_server->send_Z_PDU(apdu);
772 if (apdu->which == Z_APDU_close)