2 * Copyright (c) 1998-2001, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-proxy.cpp,v $
6 * Revision 1.23 2001-03-26 14:43:49 adam
7 * New threaded PDU association.
9 * Revision 1.22 2000/11/20 11:27:33 adam
10 * Fixes for connect operation (timeout and notify fix).
12 * Revision 1.21 2000/11/01 14:22:59 adam
13 * Added fd parameter for method IYaz_PDU_Observer::clone.
15 * Revision 1.20 2000/10/24 12:29:57 adam
16 * Fixed bug in proxy where a Yaz_ProxyClient could be owned by
17 * two Yaz_Proxy's (fatal).
19 * Revision 1.19 2000/10/11 11:58:16 adam
20 * Moved header files to include/yaz++. Switched to libtool and automake.
21 * Configure script creates yaz++-config script.
23 * Revision 1.18 2000/09/08 10:23:42 adam
24 * Added skeleton of yaz-z-server.
26 * Revision 1.17 2000/09/05 13:57:28 adam
27 * Fixed get_otherInfoAPDU to return otherInfo for extended services.
29 * Revision 1.16 2000/09/04 08:29:22 adam
30 * Fixed memory leak(s). Added re-use of associations, rather than
31 * re-init, when maximum number of targets are in use.
33 * Revision 1.15 2000/08/31 14:41:55 adam
34 * Proxy no longer generates cookies (it's up to the client). Proxy
35 * re-opens if target new op is started before previous operation finishes.
37 * Revision 1.14 2000/08/10 08:42:42 adam
38 * Fixes for {set,get}_APDU_log.
40 * Revision 1.13 2000/08/07 14:19:59 adam
41 * Fixed serious bug regarding timeouts. Improved logging for proxy.
43 * Revision 1.12 2000/07/04 13:48:49 adam
44 * Implemented upper-limit on proxy-to-target sessions.
46 * Revision 1.11 1999/12/06 13:52:45 adam
47 * Modified for new location of YAZ header files. Experimental threaded
50 * Revision 1.10 1999/11/10 10:02:34 adam
53 * Revision 1.9 1999/09/13 12:53:44 adam
54 * Proxy removes OtherInfo Proxy Address and Session ID. Other
55 * Otherinfo remains untouched.
57 * Revision 1.8 1999/05/04 10:53:00 adam
58 * Changed the way the PROXY behaves when lost cookie is received.
60 * Revision 1.7 1999/04/28 13:31:17 adam
61 * Better result set optimisation for proxy.
63 * Revision 1.6 1999/04/27 07:52:13 adam
64 * Improved proxy; added query match for result set re-use.
66 * Revision 1.5 1999/04/21 12:09:01 adam
67 * Many improvements. Modified to proxy server to work with "sessions"
70 * Revision 1.4 1999/04/20 10:30:05 adam
71 * Implemented various stuff for client and proxy. Updated calls
72 * to ODR to reflect new name parameter.
74 * Revision 1.3 1999/04/09 11:46:57 adam
75 * Added object Yaz_Z_Assoc. Much more functional client.
77 * Revision 1.2 1999/01/28 13:08:46 adam
78 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
79 * yaz-socket-manager.cc.
81 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
82 * First implementation of YAZ++.
90 #include <yaz++/yaz-proxy.h>
92 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
93 Yaz_Z_Assoc(the_PDU_Observable)
95 m_PDU_Observable = the_PDU_Observable;
106 Yaz_Proxy::~Yaz_Proxy()
108 xfree (m_proxyTarget);
111 void Yaz_Proxy::set_proxyTarget(const char *target)
113 xfree (m_proxyTarget);
116 m_proxyTarget = (char *) xstrdup (target);
119 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
120 *the_PDU_Observable, int fd)
122 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
123 new_proxy->m_parent = this;
124 new_proxy->timeout(500);
125 new_proxy->set_proxyTarget(m_proxyTarget);
126 new_proxy->set_APDU_log(get_APDU_log());
130 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
133 Z_OtherInformationUnit *oi;
135 ent.proto = PROTO_Z3950;
136 ent.oclass = CLASS_USERINFO;
137 ent.value = (oid_value) VAL_COOKIE;
138 assert (oid_ent_to_oid (&ent, oid));
140 if (oid_ent_to_oid (&ent, oid) &&
141 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
142 oi->which == Z_OtherInfo_characterInfo)
143 return oi->information.characterInfo;
147 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
150 Z_OtherInformationUnit *oi;
152 ent.proto = PROTO_Z3950;
153 ent.oclass = CLASS_USERINFO;
154 ent.value = (oid_value) VAL_PROXY;
155 if (oid_ent_to_oid (&ent, oid) &&
156 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
157 oi->which == Z_OtherInfo_characterInfo)
158 return oi->information.characterInfo;
162 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
165 Yaz_Proxy *parent = m_parent;
166 Z_OtherInformation **oi;
167 Yaz_ProxyClient *c = m_client;
169 get_otherInfoAPDU(apdu, &oi);
170 char *cookie = get_cookie(oi);
171 logf (LOG_LOG, "Yaz_Proxy::get_client cookie=%s", cookie ? cookie :
174 const char *proxy_host = get_proxy(oi);
176 set_proxyTarget(proxy_host);
177 logf (LOG_LOG, "proxy_host = %s", m_proxyTarget ? m_proxyTarget:"none");
179 // no target specified at all?
183 if (cookie && *cookie)
185 logf (LOG_LOG, "lookup of clients cookie=%s target=%s",
186 cookie, m_proxyTarget);
187 Yaz_ProxyClient *cc = 0;
189 for (c = parent->m_clientPool; c; c = c->m_next)
191 logf (LOG_LOG, " found client cookie = %s target=%s seqno=%d",
192 c->m_cookie, c->get_hostname(), c->m_seqno);
194 assert (*c->m_prev == c);
195 if (!strcmp(cookie,c->m_cookie) &&
196 !strcmp(m_proxyTarget, c->get_hostname()))
198 logf (LOG_LOG, "found!");
206 // The following handles "cancel"
207 // If connection is busy (waiting for PDU) and
208 // we have an initRequest we can safely do re-open
209 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
211 logf (LOG_LOG, "reopen target=%s", c->get_hostname());
213 c->client(m_proxyTarget);
216 delete c->m_last_query;
218 c->m_last_resultCount = 0;
219 c->m_sr_transform = 0;
223 c->m_seqno = parent->m_seqno;
224 if (c->m_server && c->m_server != this)
225 c->m_server->m_client = 0;
227 c->m_seqno = parent->m_seqno;
229 yaz_log (LOG_LOG, "get_client 1 %p %p", this, c);
235 if (apdu->which != Z_APDU_initRequest)
237 logf (LOG_LOG, "no first INIT!");
240 logf (LOG_LOG, "got InitRequest");
242 // go through list of clients - and find the lowest/oldest one.
243 Yaz_ProxyClient *c_min = 0;
245 int no_of_clients = 0;
246 for (c = parent->m_clientPool; c; c = c->m_next)
249 if (min_seq < 0 || c->m_seqno < min_seq)
251 min_seq = c->m_seqno;
255 if (no_of_clients >= parent->m_max_clients)
258 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
260 logf (LOG_LOG, "Yaz_Proxy::get_client re-init session %d",
262 if (c->m_server && c->m_server != this)
268 logf (LOG_LOG, "Yaz_Proxy::get_client re-use session %d to %d",
269 c->m_seqno, parent->m_seqno);
271 strcpy (c->m_cookie, cookie);
273 c->m_cookie[0] = '\0';
274 c->m_seqno = parent->m_seqno;
275 if (c->m_server && c->m_server != this)
277 c->m_server->m_client = 0;
281 yaz_log (LOG_LOG, "get_client 2 %p %p", this, c);
287 logf (LOG_LOG, "Yaz_Proxy::get_client making session %d",
289 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
290 c->m_next = parent->m_clientPool;
292 c->m_next->m_prev = &c->m_next;
293 parent->m_clientPool = c;
294 c->m_prev = &parent->m_clientPool;
297 strcpy (c->m_cookie, cookie);
299 c->m_cookie[0] = '\0';
300 logf (LOG_LOG, "Yaz_Proxy::get_client connect to %s", m_proxyTarget);
301 c->m_seqno = parent->m_seqno;
302 c->client(m_proxyTarget);
305 delete c->m_last_query;
307 c->m_last_resultCount = 0;
308 c->m_sr_transform = 0;
314 yaz_log (LOG_LOG, "get_client 3 %p %p", this, c);
318 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
320 if (apdu->which != Z_APDU_searchRequest)
322 Z_SearchRequest *sr = apdu->u.searchRequest;
323 Yaz_Z_Query *this_query = new Yaz_Z_Query;
325 this_query->set_Z_Query(sr->query);
327 if (m_client->m_last_query &&
328 m_client->m_last_query->match(this_query))
331 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
332 m_client->m_last_resultCount < *sr->largeSetLowerBound)
335 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize medium set");
336 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
337 Z_PresentRequest *pr = new_apdu->u.presentRequest;
338 pr->referenceId = sr->referenceId;
339 pr->resultSetId = sr->resultSetName;
340 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
341 *pr->numberOfRecordsRequested = *sr->mediumSetPresentNumber;
342 if (sr->mediumSetElementSetNames)
344 pr->recordComposition = (Z_RecordComposition *)
345 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
346 pr->recordComposition->which = Z_RecordComp_simple;
347 pr->recordComposition->u.simple = sr->mediumSetElementSetNames;
349 m_client->m_sr_transform = 1;
352 else if (m_client->m_last_resultCount > *sr->largeSetLowerBound ||
353 m_client->m_last_resultCount == 0)
356 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize large set");
357 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
358 new_apdu->u.searchResponse->referenceId = sr->referenceId;
359 new_apdu->u.searchResponse->resultCount =
360 &m_client->m_last_resultCount;
361 send_Z_PDU(new_apdu);
367 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize small set");
368 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
369 Z_PresentRequest *pr = new_apdu->u.presentRequest;
370 pr->referenceId = sr->referenceId;
371 pr->resultSetId = sr->resultSetName;
372 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
373 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
374 if (sr->smallSetElementSetNames)
376 pr->recordComposition = (Z_RecordComposition *)
377 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
378 pr->recordComposition->which = Z_RecordComp_simple;
379 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
381 m_client->m_sr_transform = 1;
387 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize new set");
388 delete m_client->m_last_query;
389 m_client->m_last_query = this_query;
394 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
396 logf (LOG_LOG, "Yaz_Proxy::recv_Z_PDU");
397 // Determine our client.
398 m_client = get_client(apdu);
404 m_client->m_server = this;
406 if (apdu->which == Z_APDU_initRequest)
408 if (m_client->m_init_flag)
410 Z_APDU *apdu = create_Z_PDU(Z_APDU_initResponse);
411 if (m_client->m_cookie)
412 set_otherInformationString(apdu, VAL_COOKIE, 1,
417 m_client->m_init_flag = 1;
419 apdu = result_set_optimize(apdu);
423 logf (LOG_LOG, "Yaz_ProxyClient::send_Z_PDU %s", m_client->get_hostname());
425 // delete other info part from PDU before sending to target
426 Z_OtherInformation **oi;
427 get_otherInfoAPDU(apdu, &oi);
431 if (m_client->send_Z_PDU(apdu) < 0)
438 m_client->m_waiting = 1;
441 void Yaz_Proxy::connectNotify()
445 void Yaz_Proxy::shutdown()
447 logf (LOG_LOG, "shutdown (client to proxy)");
448 // only keep if keep_alive flag and cookie is set...
449 if (m_keepalive && m_client && m_client->m_cookie[0])
451 if (m_client->m_waiting == 2)
453 // Tell client (if any) that no server connection is there..
454 m_client->m_server = 0;
458 yaz_log (LOG_LOG, "deleting %p %p", this, m_client);
459 if (m_client->m_waiting == 2)
466 void Yaz_ProxyClient::shutdown()
468 logf (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
473 void Yaz_Proxy::failNotify()
475 logf (LOG_LOG, "connection closed by client");
479 void Yaz_ProxyClient::failNotify()
481 logf (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
485 void Yaz_ProxyClient::connectNotify()
487 logf (LOG_LOG, "Yaz_ProxyClient connection accepted by %s",
492 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
493 *the_PDU_Observable, int fd)
495 return new Yaz_ProxyClient(the_PDU_Observable);
498 Yaz_ProxyClient::~Yaz_ProxyClient()
503 m_next->m_prev = m_prev;
504 m_waiting = 2; // for debugging purposes only.
508 void Yaz_Proxy::timeoutNotify()
510 logf (LOG_LOG, "timeout (client to proxy)");
514 void Yaz_ProxyClient::timeoutNotify()
516 logf (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
520 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
521 Yaz_Z_Assoc (the_PDU_Observable)
528 m_last_resultCount = 0;
533 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
536 logf (LOG_LOG, "Yaz_ProxyClient::recv_Z_PDU %s", get_hostname());
537 if (apdu->which == Z_APDU_searchResponse)
538 m_last_resultCount = *apdu->u.searchResponse->resultCount;
539 if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
542 Z_PresentResponse *pr = apdu->u.presentResponse;
543 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
544 Z_SearchResponse *sr = new_apdu->u.searchResponse;
545 sr->referenceId = pr->referenceId;
546 *sr->resultCount = m_last_resultCount;
547 sr->records = pr->records;
548 sr->nextResultSetPosition = pr->nextResultSetPosition;
549 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
553 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
556 logf (LOG_LOG, "Yaz_Proxy::send_Z_PDU");
557 m_server->send_Z_PDU(apdu);