2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-proxy.cpp,v $
6 * Revision 1.20 2000-10-24 12:29:57 adam
7 * Fixed bug in proxy where a Yaz_ProxyClient could be owned by
8 * two Yaz_Proxy's (fatal).
10 * Revision 1.19 2000/10/11 11:58:16 adam
11 * Moved header files to include/yaz++. Switched to libtool and automake.
12 * Configure script creates yaz++-config script.
14 * Revision 1.18 2000/09/08 10:23:42 adam
15 * Added skeleton of yaz-z-server.
17 * Revision 1.17 2000/09/05 13:57:28 adam
18 * Fixed get_otherInfoAPDU to return otherInfo for extended services.
20 * Revision 1.16 2000/09/04 08:29:22 adam
21 * Fixed memory leak(s). Added re-use of associations, rather than
22 * re-init, when maximum number of targets are in use.
24 * Revision 1.15 2000/08/31 14:41:55 adam
25 * Proxy no longer generates cookies (it's up to the client). Proxy
26 * re-opens if target new op is started before previous operation finishes.
28 * Revision 1.14 2000/08/10 08:42:42 adam
29 * Fixes for {set,get}_APDU_log.
31 * Revision 1.13 2000/08/07 14:19:59 adam
32 * Fixed serious bug regarding timeouts. Improved logging for proxy.
34 * Revision 1.12 2000/07/04 13:48:49 adam
35 * Implemented upper-limit on proxy-to-target sessions.
37 * Revision 1.11 1999/12/06 13:52:45 adam
38 * Modified for new location of YAZ header files. Experimental threaded
41 * Revision 1.10 1999/11/10 10:02:34 adam
44 * Revision 1.9 1999/09/13 12:53:44 adam
45 * Proxy removes OtherInfo Proxy Address and Session ID. Other
46 * Otherinfo remains untouched.
48 * Revision 1.8 1999/05/04 10:53:00 adam
49 * Changed the way the PROXY behaves when lost cookie is received.
51 * Revision 1.7 1999/04/28 13:31:17 adam
52 * Better result set optimisation for proxy.
54 * Revision 1.6 1999/04/27 07:52:13 adam
55 * Improved proxy; added query match for result set re-use.
57 * Revision 1.5 1999/04/21 12:09:01 adam
58 * Many improvements. Modified to proxy server to work with "sessions"
61 * Revision 1.4 1999/04/20 10:30:05 adam
62 * Implemented various stuff for client and proxy. Updated calls
63 * to ODR to reflect new name parameter.
65 * Revision 1.3 1999/04/09 11:46:57 adam
66 * Added object Yaz_Z_Assoc. Much more functional client.
68 * Revision 1.2 1999/01/28 13:08:46 adam
69 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
70 * yaz-socket-manager.cc.
72 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
73 * First implementation of YAZ++.
81 #include <yaz++/yaz-proxy.h>
83 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
84 Yaz_Z_Assoc(the_PDU_Observable)
86 m_PDU_Observable = the_PDU_Observable;
97 Yaz_Proxy::~Yaz_Proxy()
99 xfree (m_proxyTarget);
102 void Yaz_Proxy::set_proxyTarget(const char *target)
104 xfree (m_proxyTarget);
107 m_proxyTarget = (char *) xstrdup (target);
110 IYaz_PDU_Observer *Yaz_Proxy::clone(IYaz_PDU_Observable
113 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
114 new_proxy->m_parent = this;
115 new_proxy->timeout(500);
116 new_proxy->set_proxyTarget(m_proxyTarget);
117 new_proxy->set_APDU_log(get_APDU_log());
121 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
124 Z_OtherInformationUnit *oi;
126 ent.proto = PROTO_Z3950;
127 ent.oclass = CLASS_USERINFO;
128 ent.value = (oid_value) VAL_COOKIE;
129 assert (oid_ent_to_oid (&ent, oid));
131 if (oid_ent_to_oid (&ent, oid) &&
132 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
133 oi->which == Z_OtherInfo_characterInfo)
134 return oi->information.characterInfo;
138 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
141 Z_OtherInformationUnit *oi;
143 ent.proto = PROTO_Z3950;
144 ent.oclass = CLASS_USERINFO;
145 ent.value = (oid_value) VAL_PROXY;
146 if (oid_ent_to_oid (&ent, oid) &&
147 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
148 oi->which == Z_OtherInfo_characterInfo)
149 return oi->information.characterInfo;
153 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
156 Yaz_Proxy *parent = m_parent;
157 Z_OtherInformation **oi;
158 Yaz_ProxyClient *c = m_client;
160 get_otherInfoAPDU(apdu, &oi);
161 char *cookie = get_cookie(oi);
162 logf (LOG_LOG, "Yaz_Proxy::get_client cookie=%s", cookie ? cookie :
165 const char *proxy_host = get_proxy(oi);
167 set_proxyTarget(proxy_host);
168 logf (LOG_LOG, "proxy_host = %s", m_proxyTarget ? m_proxyTarget:"none");
170 // no target specified at all?
174 if (cookie && *cookie)
176 logf (LOG_LOG, "lookup of clients cookie=%s target=%s",
177 cookie, m_proxyTarget);
178 Yaz_ProxyClient *cc = 0;
180 for (c = parent->m_clientPool; c; c = c->m_next)
182 logf (LOG_LOG, " found client cookie = %s target=%s seqno=%d",
183 c->m_cookie, c->get_hostname(), c->m_seqno);
185 assert (*c->m_prev == c);
186 if (!strcmp(cookie,c->m_cookie) &&
187 !strcmp(m_proxyTarget, c->get_hostname()))
189 logf (LOG_LOG, "found!");
197 // The following handles "cancel"
198 // If connection is busy (waiting for PDU) and
199 // we have an initRequest we can safely do re-open
200 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
202 logf (LOG_LOG, "reopen target=%s", c->get_hostname());
204 c->client(m_proxyTarget);
207 delete c->m_last_query;
209 c->m_last_resultCount = 0;
210 c->m_sr_transform = 0;
214 c->m_seqno = parent->m_seqno;
215 if (c->m_server && c->m_server != this)
216 c->m_server->m_client = 0;
218 c->m_seqno = parent->m_seqno;
220 yaz_log (LOG_LOG, "get_client 1 %p %p", this, c);
226 if (apdu->which != Z_APDU_initRequest)
228 logf (LOG_LOG, "no first INIT!");
231 logf (LOG_LOG, "got InitRequest");
233 // go through list of clients - and find the lowest/oldest one.
234 Yaz_ProxyClient *c_min = 0;
236 int no_of_clients = 0;
237 for (c = parent->m_clientPool; c; c = c->m_next)
240 if (min_seq < 0 || c->m_seqno < min_seq)
242 min_seq = c->m_seqno;
246 if (no_of_clients >= parent->m_max_clients)
249 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
251 logf (LOG_LOG, "Yaz_Proxy::get_client re-init session %d",
253 if (c->m_server && c->m_server != this)
259 logf (LOG_LOG, "Yaz_Proxy::get_client re-use session %d to %d",
260 c->m_seqno, parent->m_seqno);
262 strcpy (c->m_cookie, cookie);
264 c->m_cookie[0] = '\0';
265 c->m_seqno = parent->m_seqno;
266 if (c->m_server && c->m_server != this)
268 c->m_server->m_client = 0;
272 yaz_log (LOG_LOG, "get_client 2 %p %p", this, c);
278 logf (LOG_LOG, "Yaz_Proxy::get_client making session %d",
280 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
281 c->m_next = parent->m_clientPool;
283 c->m_next->m_prev = &c->m_next;
284 parent->m_clientPool = c;
285 c->m_prev = &parent->m_clientPool;
288 strcpy (c->m_cookie, cookie);
290 c->m_cookie[0] = '\0';
291 logf (LOG_LOG, "Yaz_Proxy::get_client connect to %s", m_proxyTarget);
292 c->m_seqno = parent->m_seqno;
293 c->client(m_proxyTarget);
296 delete c->m_last_query;
298 c->m_last_resultCount = 0;
299 c->m_sr_transform = 0;
305 yaz_log (LOG_LOG, "get_client 3 %p %p", this, c);
309 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
311 if (apdu->which != Z_APDU_searchRequest)
313 Z_SearchRequest *sr = apdu->u.searchRequest;
314 Yaz_Z_Query *this_query = new Yaz_Z_Query;
316 this_query->set_Z_Query(sr->query);
318 if (m_client->m_last_query &&
319 m_client->m_last_query->match(this_query))
322 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
323 m_client->m_last_resultCount < *sr->largeSetLowerBound)
326 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize medium set");
327 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
328 Z_PresentRequest *pr = new_apdu->u.presentRequest;
329 pr->referenceId = sr->referenceId;
330 pr->resultSetId = sr->resultSetName;
331 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
332 *pr->numberOfRecordsRequested = *sr->mediumSetPresentNumber;
333 if (sr->mediumSetElementSetNames)
335 pr->recordComposition = (Z_RecordComposition *)
336 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
337 pr->recordComposition->which = Z_RecordComp_simple;
338 pr->recordComposition->u.simple = sr->mediumSetElementSetNames;
340 m_client->m_sr_transform = 1;
343 else if (m_client->m_last_resultCount > *sr->largeSetLowerBound ||
344 m_client->m_last_resultCount == 0)
347 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize large set");
348 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
349 new_apdu->u.searchResponse->referenceId = sr->referenceId;
350 new_apdu->u.searchResponse->resultCount =
351 &m_client->m_last_resultCount;
352 send_Z_PDU(new_apdu);
358 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize small set");
359 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
360 Z_PresentRequest *pr = new_apdu->u.presentRequest;
361 pr->referenceId = sr->referenceId;
362 pr->resultSetId = sr->resultSetName;
363 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
364 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
365 if (sr->smallSetElementSetNames)
367 pr->recordComposition = (Z_RecordComposition *)
368 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
369 pr->recordComposition->which = Z_RecordComp_simple;
370 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
372 m_client->m_sr_transform = 1;
378 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize new set");
379 delete m_client->m_last_query;
380 m_client->m_last_query = this_query;
385 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
387 logf (LOG_LOG, "Yaz_Proxy::recv_Z_PDU");
388 // Determine our client.
389 m_client = get_client(apdu);
395 m_client->m_server = this;
397 if (apdu->which == Z_APDU_initRequest)
399 if (m_client->m_init_flag)
401 Z_APDU *apdu = create_Z_PDU(Z_APDU_initResponse);
402 if (m_client->m_cookie)
403 set_otherInformationString(apdu, VAL_COOKIE, 1,
408 m_client->m_init_flag = 1;
410 apdu = result_set_optimize(apdu);
414 logf (LOG_LOG, "Yaz_ProxyClient::send_Z_PDU %s", m_client->get_hostname());
416 // delete other info part from PDU before sending to target
417 Z_OtherInformation **oi;
418 get_otherInfoAPDU(apdu, &oi);
422 if (m_client->send_Z_PDU(apdu) < 0)
429 m_client->m_waiting = 1;
432 void Yaz_Proxy::connectNotify()
436 void Yaz_Proxy::shutdown()
438 logf (LOG_LOG, "shutdown (client to proxy)");
439 // only keep if keep_alive flag and cookie is set...
440 if (m_keepalive && m_client && m_client->m_cookie[0])
442 if (m_client->m_waiting == 2)
444 // Tell client (if any) that no server connection is there..
445 m_client->m_server = 0;
449 yaz_log (LOG_LOG, "deleting %p %p", this, m_client);
450 if (m_client->m_waiting == 2)
457 void Yaz_ProxyClient::shutdown()
459 logf (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
464 void Yaz_Proxy::failNotify()
466 logf (LOG_LOG, "connection closed by client");
470 void Yaz_ProxyClient::failNotify()
472 logf (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
476 void Yaz_ProxyClient::connectNotify()
478 logf (LOG_LOG, "Yaz_ProxyClient connection accept by %s", get_hostname());
481 IYaz_PDU_Observer *Yaz_ProxyClient::clone(IYaz_PDU_Observable
484 return new Yaz_ProxyClient(the_PDU_Observable);
487 Yaz_ProxyClient::~Yaz_ProxyClient()
492 m_next->m_prev = m_prev;
493 m_waiting = 2; // for debugging purposes only.
497 void Yaz_Proxy::timeoutNotify()
499 logf (LOG_LOG, "timeout (client to proxy)");
503 void Yaz_ProxyClient::timeoutNotify()
505 logf (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
509 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
510 Yaz_Z_Assoc (the_PDU_Observable)
517 m_last_resultCount = 0;
522 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
525 logf (LOG_LOG, "Yaz_ProxyClient::recv_Z_PDU %s", get_hostname());
526 if (apdu->which == Z_APDU_searchResponse)
527 m_last_resultCount = *apdu->u.searchResponse->resultCount;
528 if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
531 Z_PresentResponse *pr = apdu->u.presentResponse;
532 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
533 Z_SearchResponse *sr = new_apdu->u.searchResponse;
534 sr->referenceId = pr->referenceId;
535 *sr->resultCount = m_last_resultCount;
536 sr->records = pr->records;
537 sr->nextResultSetPosition = pr->nextResultSetPosition;
538 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
542 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
545 logf (LOG_LOG, "Yaz_Proxy::send_Z_PDU");
546 m_server->send_Z_PDU(apdu);