2 * Copyright (c) 1998-2003, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.44 2003-07-18 13:27:20 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);
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] == 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", c->m_seqno,
227 c->m_waiting, c->get_hostname());
229 if (min_seq < 0 || c->m_seqno < min_seq)
231 min_seq = c->m_seqno;
235 if (no_of_clients >= parent->m_max_clients)
238 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
240 yaz_log (LOG_LOG, "Replace session %d",
242 if (c->m_server && c->m_server != this)
248 yaz_log (LOG_LOG, "Move session %d to %d %s",
249 c->m_seqno, parent->m_seqno, c->get_hostname());
251 strcpy (c->m_cookie, cookie);
253 c->m_cookie[0] = '\0';
254 c->m_seqno = parent->m_seqno;
255 if (c->m_server && c->m_server != this)
257 c->m_server->m_client = 0;
261 yaz_log (LOG_DEBUG, "get_client 2 %p %p", this, c);
267 yaz_log (LOG_LOG, "Making session %d %s", parent->m_seqno,
269 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
270 c->m_next = parent->m_clientPool;
272 c->m_next->m_prev = &c->m_next;
273 parent->m_clientPool = c;
274 c->m_prev = &parent->m_clientPool;
277 strcpy (c->m_cookie, cookie);
279 c->m_cookie[0] = '\0';
280 yaz_log (LOG_LOG, "Connecting to %s", m_proxyTarget);
281 c->m_seqno = parent->m_seqno;
282 c->client(m_proxyTarget);
284 c->m_last_resultCount = 0;
287 c->m_sr_transform = 0;
289 c->m_resultSetStartPoint = 0;
294 yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
298 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
300 if (*m_parent->m_optimize == '0')
301 return apdu; // don't optimize result sets..
302 if (apdu->which == Z_APDU_presentRequest)
304 Z_PresentRequest *pr = apdu->u.presentRequest;
305 Z_NamePlusRecordList *npr;
306 int toget = *pr->numberOfRecordsRequested;
307 int start = *pr->resultSetStartPoint;
309 if (!strcmp(m_client->m_last_resultSetId, pr->resultSetId))
311 if (m_client->m_cache.lookup (odr_encode(), &npr, start, toget,
312 pr->preferredRecordSyntax))
314 yaz_log (LOG_LOG, "Returned cache records for present request");
315 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
316 new_apdu->u.presentResponse->referenceId = pr->referenceId;
318 new_apdu->u.presentResponse->numberOfRecordsReturned
319 = odr_intdup(odr_encode(), toget);
321 new_apdu->u.presentResponse->records = (Z_Records*)
322 odr_malloc(odr_encode(), sizeof(Z_Records));
323 new_apdu->u.presentResponse->records->which = Z_Records_DBOSD;
324 new_apdu->u.presentResponse->records->u.databaseOrSurDiagnostics = npr;
325 new_apdu->u.presentResponse->nextResultSetPosition =
326 odr_intdup(odr_encode(), start+toget);
327 send_Z_PDU(new_apdu);
333 if (apdu->which != Z_APDU_searchRequest)
335 Z_SearchRequest *sr = apdu->u.searchRequest;
336 Yaz_Z_Query *this_query = new Yaz_Z_Query;
337 Yaz_Z_Databases this_databases;
339 this_databases.set(sr->num_databaseNames, (const char **)
342 this_query->set_Z_Query(sr->query);
344 if (m_client->m_last_ok && m_client->m_last_query &&
345 m_client->m_last_query->match(this_query) &&
346 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
347 m_client->m_last_databases.match(this_databases))
350 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
351 m_client->m_last_resultCount < *sr->largeSetLowerBound)
353 Z_NamePlusRecordList *npr;
354 int toget = *sr->mediumSetPresentNumber;
356 if (toget > m_client->m_last_resultCount)
357 toget = m_client->m_last_resultCount;
359 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
360 sr->preferredRecordSyntax))
362 yaz_log (LOG_LOG, "Returned cache records for medium set");
363 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
364 new_apdu->u.searchResponse->referenceId = sr->referenceId;
365 new_apdu->u.searchResponse->resultCount =
366 &m_client->m_last_resultCount;
368 new_apdu->u.searchResponse->numberOfRecordsReturned
369 = odr_intdup(odr_encode(), toget);
371 new_apdu->u.searchResponse->records = (Z_Records*)
372 odr_malloc(odr_encode(), sizeof(Z_Records));
373 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
374 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
375 new_apdu->u.searchResponse->nextResultSetPosition =
376 odr_intdup(odr_encode(), toget+1);
377 send_Z_PDU(new_apdu);
383 // send present request (medium size)
384 yaz_log (LOG_LOG, "Optimizing search for medium set");
386 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
387 Z_PresentRequest *pr = new_apdu->u.presentRequest;
388 pr->referenceId = sr->referenceId;
389 pr->resultSetId = sr->resultSetName;
390 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
391 *pr->numberOfRecordsRequested = toget;
392 if (sr->mediumSetElementSetNames)
394 pr->recordComposition = (Z_RecordComposition *)
395 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
396 pr->recordComposition->which = Z_RecordComp_simple;
397 pr->recordComposition->u.simple =
398 sr->mediumSetElementSetNames;
400 m_client->m_sr_transform = 1;
404 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
405 m_client->m_last_resultCount <= 0)
407 // large set. Return pseudo-search response immediately
408 yaz_log (LOG_LOG, "Optimizing search for large set");
409 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
410 new_apdu->u.searchResponse->referenceId = sr->referenceId;
411 new_apdu->u.searchResponse->resultCount =
412 &m_client->m_last_resultCount;
413 send_Z_PDU(new_apdu);
418 Z_NamePlusRecordList *npr;
419 int toget = m_client->m_last_resultCount;
421 // send a present request (small set)
423 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
424 sr->preferredRecordSyntax))
426 yaz_log (LOG_LOG, "Returned cache records for small set");
427 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
428 new_apdu->u.searchResponse->referenceId = sr->referenceId;
429 new_apdu->u.searchResponse->resultCount =
430 &m_client->m_last_resultCount;
432 new_apdu->u.searchResponse->numberOfRecordsReturned
433 = odr_intdup(odr_encode(), toget);
435 new_apdu->u.searchResponse->records = (Z_Records*)
436 odr_malloc(odr_encode(), sizeof(Z_Records));
437 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
438 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
439 new_apdu->u.searchResponse->nextResultSetPosition =
440 odr_intdup(odr_encode(), toget+1);
441 send_Z_PDU(new_apdu);
446 yaz_log (LOG_LOG, "Optimizing search for small set");
447 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
448 Z_PresentRequest *pr = new_apdu->u.presentRequest;
449 pr->referenceId = sr->referenceId;
450 pr->resultSetId = sr->resultSetName;
451 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
452 *pr->numberOfRecordsRequested = toget;
453 if (sr->smallSetElementSetNames)
455 pr->recordComposition = (Z_RecordComposition *)
456 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
457 pr->recordComposition->which = Z_RecordComp_simple;
458 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
460 m_client->m_sr_transform = 1;
467 delete m_client->m_last_query;
468 m_client->m_last_query = this_query;
469 m_client->m_last_ok = 0;
470 m_client->m_cache.clear();
471 m_client->m_resultSetStartPoint = 0;
473 xfree (m_client->m_last_resultSetId);
474 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
476 m_client->m_last_databases.set(sr->num_databaseNames,
477 (const char **) sr->databaseNames);
482 static const char *apdu_name(Z_APDU *apdu)
486 case Z_APDU_initRequest:
487 return "initRequest";
488 case Z_APDU_initResponse:
489 return "initResponse";
490 case Z_APDU_searchRequest:
491 return "searchRequest";
492 case Z_APDU_searchResponse:
493 return "searchResponse";
494 case Z_APDU_presentRequest:
495 return "presentRequest";
496 case Z_APDU_presentResponse:
497 return "presentResponse";
498 case Z_APDU_deleteResultSetRequest:
499 return "deleteResultSetRequest";
500 case Z_APDU_deleteResultSetResponse:
501 return "deleteResultSetResponse";
502 case Z_APDU_scanRequest:
503 return "scanRequest";
504 case Z_APDU_scanResponse:
505 return "scanResponse";
506 case Z_APDU_sortRequest:
507 return "sortRequest";
508 case Z_APDU_sortResponse:
509 return "sortResponse";
510 case Z_APDU_extendedServicesRequest:
511 return "extendedServicesRequest";
512 case Z_APDU_extendedServicesResponse:
513 return "extendedServicesResponse";
520 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
522 yaz_log (LOG_LOG, "Receiving %s from client", apdu_name(apdu));
523 // Determine our client.
524 m_client = get_client(apdu);
530 m_client->m_server = this;
532 if (apdu->which == Z_APDU_initRequest)
534 if (m_client->m_init_flag)
536 Z_APDU *apdu = m_client->m_initResponse;
537 apdu->u.initResponse->otherInfo = 0;
538 if (m_client->m_cookie && *m_client->m_cookie)
539 set_otherInformationString(apdu, VAL_COOKIE, 1,
544 m_client->m_init_flag = 1;
546 apdu = result_set_optimize(apdu);
550 yaz_log (LOG_LOG, "Sending %s to %s",
551 apdu_name(apdu), m_client->get_hostname());
553 // delete other info part from PDU before sending to target
554 Z_OtherInformation **oi;
555 get_otherInfoAPDU(apdu, &oi);
559 if (apdu->which == Z_APDU_presentRequest &&
560 m_client->m_resultSetStartPoint == 0)
562 Z_PresentRequest *pr = apdu->u.presentRequest;
563 m_client->m_resultSetStartPoint = *pr->resultSetStartPoint;
565 m_client->m_resultSetStartPoint = 0;
567 if (m_client->send_Z_PDU(apdu) < 0)
574 m_client->m_waiting = 1;
577 void Yaz_Proxy::connectNotify()
581 void Yaz_Proxy::shutdown()
583 // only keep if keep_alive flag is set...
584 if (m_keepalive && m_client && m_client->m_waiting == 0)
586 yaz_log (LOG_LOG, "shutdown (client to proxy) keepalive %s",
587 m_client->get_hostname());
588 assert (m_client->m_waiting != 2);
589 // Tell client (if any) that no server connection is there..
590 m_client->m_server = 0;
594 yaz_log (LOG_LOG, "shutdown (client to proxy) close %s",
595 m_client->get_hostname());
596 assert (m_client->m_waiting != 2);
601 yaz_log (LOG_LOG, "shutdown (client to proxy) bad state");
606 yaz_log (LOG_LOG, "shutdown (client to proxy)");
611 void Yaz_ProxyClient::shutdown()
613 yaz_log (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
618 void Yaz_Proxy::failNotify()
620 yaz_log (LOG_LOG, "Yaz_Proxy connection closed by client");
624 void Yaz_ProxyClient::failNotify()
626 yaz_log (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
630 void Yaz_ProxyClient::connectNotify()
632 yaz_log (LOG_LOG, "Connection accepted by %s", get_hostname());
636 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
637 *the_PDU_Observable, int fd)
639 return new Yaz_ProxyClient(the_PDU_Observable);
642 Yaz_ProxyClient::~Yaz_ProxyClient()
647 m_next->m_prev = m_prev;
648 m_waiting = 2; // for debugging purposes only.
649 odr_destroy(m_init_odr);
651 xfree (m_last_resultSetId);
654 void Yaz_Proxy::timeoutNotify()
656 yaz_log (LOG_LOG, "timeout (client to proxy)");
660 void Yaz_ProxyClient::timeoutNotify()
662 yaz_log (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
666 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
667 Yaz_Z_Assoc (the_PDU_Observable)
674 m_last_resultSetId = 0;
675 m_last_resultCount = 0;
679 m_init_odr = odr_createmem (ODR_DECODE);
681 m_resultSetStartPoint = 0;
684 const char *Yaz_Proxy::option(const char *name, const char *value)
686 if (!strcmp (name, "optimize")) {
689 m_optimize = xstrdup (value);
696 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
699 yaz_log (LOG_LOG, "Receiving %s from %s", apdu_name(apdu),
701 if (apdu->which == Z_APDU_initResponse)
703 NMEM nmem = odr_extract_mem (odr_decode());
704 odr_reset (m_init_odr);
705 nmem_transfer (m_init_odr->mem, nmem);
706 m_initResponse = apdu;
709 if (apdu->which == Z_APDU_searchResponse)
711 Z_SearchResponse *sr = apdu->u.searchResponse;
712 m_last_resultCount = *sr->resultCount;
713 int status = *sr->searchStatus;
714 if (status && (!sr->records || sr->records->which == Z_Records_DBOSD))
718 if (sr->records && sr->records->which == Z_Records_DBOSD)
720 m_cache.add(odr_decode(),
721 sr->records->u.databaseOrSurDiagnostics, 1);
725 if (apdu->which == Z_APDU_presentResponse)
727 Z_PresentResponse *pr = apdu->u.presentResponse;
731 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
732 Z_SearchResponse *sr = new_apdu->u.searchResponse;
733 sr->referenceId = pr->referenceId;
734 *sr->resultCount = m_last_resultCount;
735 sr->records = pr->records;
736 sr->nextResultSetPosition = pr->nextResultSetPosition;
737 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
740 if (pr->records->which == Z_Records_DBOSD && m_resultSetStartPoint)
742 m_cache.add(odr_decode(),
743 pr->records->u.databaseOrSurDiagnostics,
744 m_resultSetStartPoint);
745 m_resultSetStartPoint = 0;
748 if (m_cookie && *m_cookie)
749 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
752 yaz_log (LOG_LOG, "Sending %s to client", apdu_name(apdu));
753 m_server->send_Z_PDU(apdu);
755 if (apdu->which == Z_APDU_close)