2 * Copyright (c) 1998-2001, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-proxy.cpp,v $
6 * Revision 1.24 2001-04-10 10:48:08 adam
7 * Fixed problem where proxy could cash bad result sets.
9 * Revision 1.23 2001/03/26 14:43:49 adam
10 * New threaded PDU association.
12 * Revision 1.22 2000/11/20 11:27:33 adam
13 * Fixes for connect operation (timeout and notify fix).
15 * Revision 1.21 2000/11/01 14:22:59 adam
16 * Added fd parameter for method IYaz_PDU_Observer::clone.
18 * Revision 1.20 2000/10/24 12:29:57 adam
19 * Fixed bug in proxy where a Yaz_ProxyClient could be owned by
20 * two Yaz_Proxy's (fatal).
22 * Revision 1.19 2000/10/11 11:58:16 adam
23 * Moved header files to include/yaz++. Switched to libtool and automake.
24 * Configure script creates yaz++-config script.
26 * Revision 1.18 2000/09/08 10:23:42 adam
27 * Added skeleton of yaz-z-server.
29 * Revision 1.17 2000/09/05 13:57:28 adam
30 * Fixed get_otherInfoAPDU to return otherInfo for extended services.
32 * Revision 1.16 2000/09/04 08:29:22 adam
33 * Fixed memory leak(s). Added re-use of associations, rather than
34 * re-init, when maximum number of targets are in use.
36 * Revision 1.15 2000/08/31 14:41:55 adam
37 * Proxy no longer generates cookies (it's up to the client). Proxy
38 * re-opens if target new op is started before previous operation finishes.
40 * Revision 1.14 2000/08/10 08:42:42 adam
41 * Fixes for {set,get}_APDU_log.
43 * Revision 1.13 2000/08/07 14:19:59 adam
44 * Fixed serious bug regarding timeouts. Improved logging for proxy.
46 * Revision 1.12 2000/07/04 13:48:49 adam
47 * Implemented upper-limit on proxy-to-target sessions.
49 * Revision 1.11 1999/12/06 13:52:45 adam
50 * Modified for new location of YAZ header files. Experimental threaded
53 * Revision 1.10 1999/11/10 10:02:34 adam
56 * Revision 1.9 1999/09/13 12:53:44 adam
57 * Proxy removes OtherInfo Proxy Address and Session ID. Other
58 * Otherinfo remains untouched.
60 * Revision 1.8 1999/05/04 10:53:00 adam
61 * Changed the way the PROXY behaves when lost cookie is received.
63 * Revision 1.7 1999/04/28 13:31:17 adam
64 * Better result set optimisation for proxy.
66 * Revision 1.6 1999/04/27 07:52:13 adam
67 * Improved proxy; added query match for result set re-use.
69 * Revision 1.5 1999/04/21 12:09:01 adam
70 * Many improvements. Modified to proxy server to work with "sessions"
73 * Revision 1.4 1999/04/20 10:30:05 adam
74 * Implemented various stuff for client and proxy. Updated calls
75 * to ODR to reflect new name parameter.
77 * Revision 1.3 1999/04/09 11:46:57 adam
78 * Added object Yaz_Z_Assoc. Much more functional client.
80 * Revision 1.2 1999/01/28 13:08:46 adam
81 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
82 * yaz-socket-manager.cc.
84 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
85 * First implementation of YAZ++.
93 #include <yaz++/yaz-proxy.h>
95 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
96 Yaz_Z_Assoc(the_PDU_Observable)
98 m_PDU_Observable = the_PDU_Observable;
109 Yaz_Proxy::~Yaz_Proxy()
111 xfree (m_proxyTarget);
114 void Yaz_Proxy::set_proxyTarget(const char *target)
116 xfree (m_proxyTarget);
119 m_proxyTarget = (char *) xstrdup (target);
122 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
123 *the_PDU_Observable, int fd)
125 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
126 new_proxy->m_parent = this;
127 new_proxy->timeout(500);
128 new_proxy->set_proxyTarget(m_proxyTarget);
129 new_proxy->set_APDU_log(get_APDU_log());
133 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
136 Z_OtherInformationUnit *oi;
138 ent.proto = PROTO_Z3950;
139 ent.oclass = CLASS_USERINFO;
140 ent.value = (oid_value) VAL_COOKIE;
141 assert (oid_ent_to_oid (&ent, oid));
143 if (oid_ent_to_oid (&ent, oid) &&
144 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
145 oi->which == Z_OtherInfo_characterInfo)
146 return oi->information.characterInfo;
150 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
153 Z_OtherInformationUnit *oi;
155 ent.proto = PROTO_Z3950;
156 ent.oclass = CLASS_USERINFO;
157 ent.value = (oid_value) VAL_PROXY;
158 if (oid_ent_to_oid (&ent, oid) &&
159 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
160 oi->which == Z_OtherInfo_characterInfo)
161 return oi->information.characterInfo;
165 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
168 Yaz_Proxy *parent = m_parent;
169 Z_OtherInformation **oi;
170 Yaz_ProxyClient *c = m_client;
172 get_otherInfoAPDU(apdu, &oi);
173 char *cookie = get_cookie(oi);
174 logf (LOG_LOG, "Yaz_Proxy::get_client cookie=%s", cookie ? cookie :
177 const char *proxy_host = get_proxy(oi);
179 set_proxyTarget(proxy_host);
180 logf (LOG_LOG, "proxy_host = %s", m_proxyTarget ? m_proxyTarget:"none");
182 // no target specified at all?
186 if (cookie && *cookie)
188 logf (LOG_LOG, "lookup of clients cookie=%s target=%s",
189 cookie, m_proxyTarget);
190 Yaz_ProxyClient *cc = 0;
192 for (c = parent->m_clientPool; c; c = c->m_next)
194 logf (LOG_LOG, " found client cookie = %s target=%s seqno=%d",
195 c->m_cookie, c->get_hostname(), c->m_seqno);
197 assert (*c->m_prev == c);
198 if (!strcmp(cookie,c->m_cookie) &&
199 !strcmp(m_proxyTarget, c->get_hostname()))
201 logf (LOG_LOG, "found!");
209 // The following handles "cancel"
210 // If connection is busy (waiting for PDU) and
211 // we have an initRequest we can safely do re-open
212 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
214 logf (LOG_LOG, "reopen target=%s", c->get_hostname());
216 c->client(m_proxyTarget);
219 delete c->m_last_query;
221 c->m_last_resultCount = 0;
222 c->m_sr_transform = 0;
226 c->m_seqno = parent->m_seqno;
227 if (c->m_server && c->m_server != this)
228 c->m_server->m_client = 0;
230 c->m_seqno = parent->m_seqno;
232 yaz_log (LOG_LOG, "get_client 1 %p %p", this, c);
238 if (apdu->which != Z_APDU_initRequest)
240 logf (LOG_LOG, "no first INIT!");
243 logf (LOG_LOG, "got InitRequest");
245 // go through list of clients - and find the lowest/oldest one.
246 Yaz_ProxyClient *c_min = 0;
248 int no_of_clients = 0;
249 for (c = parent->m_clientPool; c; c = c->m_next)
252 if (min_seq < 0 || c->m_seqno < min_seq)
254 min_seq = c->m_seqno;
258 if (no_of_clients >= parent->m_max_clients)
261 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
263 logf (LOG_LOG, "Yaz_Proxy::get_client re-init session %d",
265 if (c->m_server && c->m_server != this)
271 logf (LOG_LOG, "Yaz_Proxy::get_client re-use session %d to %d",
272 c->m_seqno, parent->m_seqno);
274 strcpy (c->m_cookie, cookie);
276 c->m_cookie[0] = '\0';
277 c->m_seqno = parent->m_seqno;
278 if (c->m_server && c->m_server != this)
280 c->m_server->m_client = 0;
284 yaz_log (LOG_LOG, "get_client 2 %p %p", this, c);
290 logf (LOG_LOG, "Yaz_Proxy::get_client making session %d",
292 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
293 c->m_next = parent->m_clientPool;
295 c->m_next->m_prev = &c->m_next;
296 parent->m_clientPool = c;
297 c->m_prev = &parent->m_clientPool;
300 strcpy (c->m_cookie, cookie);
302 c->m_cookie[0] = '\0';
303 logf (LOG_LOG, "Yaz_Proxy::get_client connect to %s", m_proxyTarget);
304 c->m_seqno = parent->m_seqno;
305 c->client(m_proxyTarget);
308 delete c->m_last_query;
310 c->m_last_resultCount = 0;
311 c->m_sr_transform = 0;
317 yaz_log (LOG_LOG, "get_client 3 %p %p", this, c);
321 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
323 if (apdu->which != Z_APDU_searchRequest)
325 Z_SearchRequest *sr = apdu->u.searchRequest;
326 Yaz_Z_Query *this_query = new Yaz_Z_Query;
328 this_query->set_Z_Query(sr->query);
330 if (m_client->m_last_query &&
331 m_client->m_last_query->match(this_query))
334 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
335 m_client->m_last_resultCount < *sr->largeSetLowerBound)
338 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize medium set");
339 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
340 Z_PresentRequest *pr = new_apdu->u.presentRequest;
341 pr->referenceId = sr->referenceId;
342 pr->resultSetId = sr->resultSetName;
343 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
344 *pr->numberOfRecordsRequested = *sr->mediumSetPresentNumber;
345 if (sr->mediumSetElementSetNames)
347 pr->recordComposition = (Z_RecordComposition *)
348 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
349 pr->recordComposition->which = Z_RecordComp_simple;
350 pr->recordComposition->u.simple = sr->mediumSetElementSetNames;
352 m_client->m_sr_transform = 1;
355 else if (m_client->m_last_resultCount > *sr->largeSetLowerBound ||
356 m_client->m_last_resultCount == 0)
359 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize large set");
360 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
361 new_apdu->u.searchResponse->referenceId = sr->referenceId;
362 new_apdu->u.searchResponse->resultCount =
363 &m_client->m_last_resultCount;
364 send_Z_PDU(new_apdu);
370 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize small set");
371 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
372 Z_PresentRequest *pr = new_apdu->u.presentRequest;
373 pr->referenceId = sr->referenceId;
374 pr->resultSetId = sr->resultSetName;
375 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
376 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
377 if (sr->smallSetElementSetNames)
379 pr->recordComposition = (Z_RecordComposition *)
380 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
381 pr->recordComposition->which = Z_RecordComp_simple;
382 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
384 m_client->m_sr_transform = 1;
390 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize new set");
391 delete m_client->m_last_query;
392 m_client->m_last_query = this_query;
397 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
399 logf (LOG_LOG, "Yaz_Proxy::recv_Z_PDU");
400 // Determine our client.
401 m_client = get_client(apdu);
407 m_client->m_server = this;
409 if (apdu->which == Z_APDU_initRequest)
411 if (m_client->m_init_flag)
413 Z_APDU *apdu = create_Z_PDU(Z_APDU_initResponse);
414 if (m_client->m_cookie)
415 set_otherInformationString(apdu, VAL_COOKIE, 1,
420 m_client->m_init_flag = 1;
422 apdu = result_set_optimize(apdu);
426 logf (LOG_LOG, "Yaz_ProxyClient::send_Z_PDU %s", m_client->get_hostname());
428 // delete other info part from PDU before sending to target
429 Z_OtherInformation **oi;
430 get_otherInfoAPDU(apdu, &oi);
434 if (m_client->send_Z_PDU(apdu) < 0)
441 m_client->m_waiting = 1;
444 void Yaz_Proxy::connectNotify()
448 void Yaz_Proxy::shutdown()
450 logf (LOG_LOG, "shutdown (client to proxy)");
451 // only keep if keep_alive flag and cookie is set...
452 if (m_keepalive && m_client && m_client->m_cookie[0])
454 if (m_client->m_waiting == 2)
456 // Tell client (if any) that no server connection is there..
457 m_client->m_server = 0;
461 yaz_log (LOG_LOG, "deleting %p %p", this, m_client);
462 if (m_client->m_waiting == 2)
469 void Yaz_ProxyClient::shutdown()
471 logf (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
476 void Yaz_Proxy::failNotify()
478 logf (LOG_LOG, "connection closed by client");
482 void Yaz_ProxyClient::failNotify()
484 logf (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
488 void Yaz_ProxyClient::connectNotify()
490 logf (LOG_LOG, "Yaz_ProxyClient connection accepted by %s",
495 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
496 *the_PDU_Observable, int fd)
498 return new Yaz_ProxyClient(the_PDU_Observable);
501 Yaz_ProxyClient::~Yaz_ProxyClient()
506 m_next->m_prev = m_prev;
507 m_waiting = 2; // for debugging purposes only.
511 void Yaz_Proxy::timeoutNotify()
513 logf (LOG_LOG, "timeout (client to proxy)");
517 void Yaz_ProxyClient::timeoutNotify()
519 logf (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
523 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
524 Yaz_Z_Assoc (the_PDU_Observable)
531 m_last_resultCount = 0;
536 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
539 logf (LOG_LOG, "Yaz_ProxyClient::recv_Z_PDU %s", get_hostname());
540 if (apdu->which == Z_APDU_searchResponse)
542 m_last_resultCount = *apdu->u.searchResponse->resultCount;
543 int status = *apdu->u.searchResponse->searchStatus;
545 apdu->u.searchResponse->records &&
546 apdu->u.searchResponse->records->which != Z_Records_DBOSD))
552 if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
555 Z_PresentResponse *pr = apdu->u.presentResponse;
556 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
557 Z_SearchResponse *sr = new_apdu->u.searchResponse;
558 sr->referenceId = pr->referenceId;
559 *sr->resultCount = m_last_resultCount;
560 sr->records = pr->records;
561 sr->nextResultSetPosition = pr->nextResultSetPosition;
562 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
566 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
569 logf (LOG_LOG, "Yaz_Proxy::send_Z_PDU");
570 m_server->send_Z_PDU(apdu);