2 * Copyright (c) 1998-2000, Index Data.
3 * See the file LICENSE for details.
5 * $Log: yaz-proxy.cpp,v $
6 * Revision 1.22 2000-11-20 11:27:33 adam
7 * Fixes for connect operation (timeout and notify fix).
9 * Revision 1.21 2000/11/01 14:22:59 adam
10 * Added fd parameter for method IYaz_PDU_Observer::clone.
12 * Revision 1.20 2000/10/24 12:29:57 adam
13 * Fixed bug in proxy where a Yaz_ProxyClient could be owned by
14 * two Yaz_Proxy's (fatal).
16 * Revision 1.19 2000/10/11 11:58:16 adam
17 * Moved header files to include/yaz++. Switched to libtool and automake.
18 * Configure script creates yaz++-config script.
20 * Revision 1.18 2000/09/08 10:23:42 adam
21 * Added skeleton of yaz-z-server.
23 * Revision 1.17 2000/09/05 13:57:28 adam
24 * Fixed get_otherInfoAPDU to return otherInfo for extended services.
26 * Revision 1.16 2000/09/04 08:29:22 adam
27 * Fixed memory leak(s). Added re-use of associations, rather than
28 * re-init, when maximum number of targets are in use.
30 * Revision 1.15 2000/08/31 14:41:55 adam
31 * Proxy no longer generates cookies (it's up to the client). Proxy
32 * re-opens if target new op is started before previous operation finishes.
34 * Revision 1.14 2000/08/10 08:42:42 adam
35 * Fixes for {set,get}_APDU_log.
37 * Revision 1.13 2000/08/07 14:19:59 adam
38 * Fixed serious bug regarding timeouts. Improved logging for proxy.
40 * Revision 1.12 2000/07/04 13:48:49 adam
41 * Implemented upper-limit on proxy-to-target sessions.
43 * Revision 1.11 1999/12/06 13:52:45 adam
44 * Modified for new location of YAZ header files. Experimental threaded
47 * Revision 1.10 1999/11/10 10:02:34 adam
50 * Revision 1.9 1999/09/13 12:53:44 adam
51 * Proxy removes OtherInfo Proxy Address and Session ID. Other
52 * Otherinfo remains untouched.
54 * Revision 1.8 1999/05/04 10:53:00 adam
55 * Changed the way the PROXY behaves when lost cookie is received.
57 * Revision 1.7 1999/04/28 13:31:17 adam
58 * Better result set optimisation for proxy.
60 * Revision 1.6 1999/04/27 07:52:13 adam
61 * Improved proxy; added query match for result set re-use.
63 * Revision 1.5 1999/04/21 12:09:01 adam
64 * Many improvements. Modified to proxy server to work with "sessions"
67 * Revision 1.4 1999/04/20 10:30:05 adam
68 * Implemented various stuff for client and proxy. Updated calls
69 * to ODR to reflect new name parameter.
71 * Revision 1.3 1999/04/09 11:46:57 adam
72 * Added object Yaz_Z_Assoc. Much more functional client.
74 * Revision 1.2 1999/01/28 13:08:46 adam
75 * Yaz_PDU_Assoc better encapsulated. Memory leak fix in
76 * yaz-socket-manager.cc.
78 * Revision 1.1.1.1 1999/01/28 09:41:07 adam
79 * First implementation of YAZ++.
87 #include <yaz++/yaz-proxy.h>
89 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
90 Yaz_Z_Assoc(the_PDU_Observable)
92 m_PDU_Observable = the_PDU_Observable;
103 Yaz_Proxy::~Yaz_Proxy()
105 xfree (m_proxyTarget);
108 void Yaz_Proxy::set_proxyTarget(const char *target)
110 xfree (m_proxyTarget);
113 m_proxyTarget = (char *) xstrdup (target);
116 IYaz_PDU_Observer *Yaz_Proxy::clone(IYaz_PDU_Observable
117 *the_PDU_Observable, int fd)
119 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
120 new_proxy->m_parent = this;
121 new_proxy->timeout(500);
122 new_proxy->set_proxyTarget(m_proxyTarget);
123 new_proxy->set_APDU_log(get_APDU_log());
127 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
130 Z_OtherInformationUnit *oi;
132 ent.proto = PROTO_Z3950;
133 ent.oclass = CLASS_USERINFO;
134 ent.value = (oid_value) VAL_COOKIE;
135 assert (oid_ent_to_oid (&ent, oid));
137 if (oid_ent_to_oid (&ent, oid) &&
138 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
139 oi->which == Z_OtherInfo_characterInfo)
140 return oi->information.characterInfo;
144 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
147 Z_OtherInformationUnit *oi;
149 ent.proto = PROTO_Z3950;
150 ent.oclass = CLASS_USERINFO;
151 ent.value = (oid_value) VAL_PROXY;
152 if (oid_ent_to_oid (&ent, oid) &&
153 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
154 oi->which == Z_OtherInfo_characterInfo)
155 return oi->information.characterInfo;
159 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
162 Yaz_Proxy *parent = m_parent;
163 Z_OtherInformation **oi;
164 Yaz_ProxyClient *c = m_client;
166 get_otherInfoAPDU(apdu, &oi);
167 char *cookie = get_cookie(oi);
168 logf (LOG_LOG, "Yaz_Proxy::get_client cookie=%s", cookie ? cookie :
171 const char *proxy_host = get_proxy(oi);
173 set_proxyTarget(proxy_host);
174 logf (LOG_LOG, "proxy_host = %s", m_proxyTarget ? m_proxyTarget:"none");
176 // no target specified at all?
180 if (cookie && *cookie)
182 logf (LOG_LOG, "lookup of clients cookie=%s target=%s",
183 cookie, m_proxyTarget);
184 Yaz_ProxyClient *cc = 0;
186 for (c = parent->m_clientPool; c; c = c->m_next)
188 logf (LOG_LOG, " found client cookie = %s target=%s seqno=%d",
189 c->m_cookie, c->get_hostname(), c->m_seqno);
191 assert (*c->m_prev == c);
192 if (!strcmp(cookie,c->m_cookie) &&
193 !strcmp(m_proxyTarget, c->get_hostname()))
195 logf (LOG_LOG, "found!");
203 // The following handles "cancel"
204 // If connection is busy (waiting for PDU) and
205 // we have an initRequest we can safely do re-open
206 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
208 logf (LOG_LOG, "reopen target=%s", c->get_hostname());
210 c->client(m_proxyTarget);
213 delete c->m_last_query;
215 c->m_last_resultCount = 0;
216 c->m_sr_transform = 0;
220 c->m_seqno = parent->m_seqno;
221 if (c->m_server && c->m_server != this)
222 c->m_server->m_client = 0;
224 c->m_seqno = parent->m_seqno;
226 yaz_log (LOG_LOG, "get_client 1 %p %p", this, c);
232 if (apdu->which != Z_APDU_initRequest)
234 logf (LOG_LOG, "no first INIT!");
237 logf (LOG_LOG, "got InitRequest");
239 // go through list of clients - and find the lowest/oldest one.
240 Yaz_ProxyClient *c_min = 0;
242 int no_of_clients = 0;
243 for (c = parent->m_clientPool; c; c = c->m_next)
246 if (min_seq < 0 || c->m_seqno < min_seq)
248 min_seq = c->m_seqno;
252 if (no_of_clients >= parent->m_max_clients)
255 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
257 logf (LOG_LOG, "Yaz_Proxy::get_client re-init session %d",
259 if (c->m_server && c->m_server != this)
265 logf (LOG_LOG, "Yaz_Proxy::get_client re-use session %d to %d",
266 c->m_seqno, parent->m_seqno);
268 strcpy (c->m_cookie, cookie);
270 c->m_cookie[0] = '\0';
271 c->m_seqno = parent->m_seqno;
272 if (c->m_server && c->m_server != this)
274 c->m_server->m_client = 0;
278 yaz_log (LOG_LOG, "get_client 2 %p %p", this, c);
284 logf (LOG_LOG, "Yaz_Proxy::get_client making session %d",
286 c = new Yaz_ProxyClient(m_PDU_Observable->clone());
287 c->m_next = parent->m_clientPool;
289 c->m_next->m_prev = &c->m_next;
290 parent->m_clientPool = c;
291 c->m_prev = &parent->m_clientPool;
294 strcpy (c->m_cookie, cookie);
296 c->m_cookie[0] = '\0';
297 logf (LOG_LOG, "Yaz_Proxy::get_client connect to %s", m_proxyTarget);
298 c->m_seqno = parent->m_seqno;
299 c->client(m_proxyTarget);
302 delete c->m_last_query;
304 c->m_last_resultCount = 0;
305 c->m_sr_transform = 0;
311 yaz_log (LOG_LOG, "get_client 3 %p %p", this, c);
315 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
317 if (apdu->which != Z_APDU_searchRequest)
319 Z_SearchRequest *sr = apdu->u.searchRequest;
320 Yaz_Z_Query *this_query = new Yaz_Z_Query;
322 this_query->set_Z_Query(sr->query);
324 if (m_client->m_last_query &&
325 m_client->m_last_query->match(this_query))
328 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
329 m_client->m_last_resultCount < *sr->largeSetLowerBound)
332 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize medium set");
333 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
334 Z_PresentRequest *pr = new_apdu->u.presentRequest;
335 pr->referenceId = sr->referenceId;
336 pr->resultSetId = sr->resultSetName;
337 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
338 *pr->numberOfRecordsRequested = *sr->mediumSetPresentNumber;
339 if (sr->mediumSetElementSetNames)
341 pr->recordComposition = (Z_RecordComposition *)
342 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
343 pr->recordComposition->which = Z_RecordComp_simple;
344 pr->recordComposition->u.simple = sr->mediumSetElementSetNames;
346 m_client->m_sr_transform = 1;
349 else if (m_client->m_last_resultCount > *sr->largeSetLowerBound ||
350 m_client->m_last_resultCount == 0)
353 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize large set");
354 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
355 new_apdu->u.searchResponse->referenceId = sr->referenceId;
356 new_apdu->u.searchResponse->resultCount =
357 &m_client->m_last_resultCount;
358 send_Z_PDU(new_apdu);
364 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize small set");
365 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
366 Z_PresentRequest *pr = new_apdu->u.presentRequest;
367 pr->referenceId = sr->referenceId;
368 pr->resultSetId = sr->resultSetName;
369 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
370 *pr->numberOfRecordsRequested = m_client->m_last_resultCount;
371 if (sr->smallSetElementSetNames)
373 pr->recordComposition = (Z_RecordComposition *)
374 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
375 pr->recordComposition->which = Z_RecordComp_simple;
376 pr->recordComposition->u.simple = sr->smallSetElementSetNames;
378 m_client->m_sr_transform = 1;
384 logf (LOG_LOG, "Yaz_Proxy::result_set_optimize new set");
385 delete m_client->m_last_query;
386 m_client->m_last_query = this_query;
391 void Yaz_Proxy::recv_Z_PDU(Z_APDU *apdu)
393 logf (LOG_LOG, "Yaz_Proxy::recv_Z_PDU");
394 // Determine our client.
395 m_client = get_client(apdu);
401 m_client->m_server = this;
403 if (apdu->which == Z_APDU_initRequest)
405 if (m_client->m_init_flag)
407 Z_APDU *apdu = create_Z_PDU(Z_APDU_initResponse);
408 if (m_client->m_cookie)
409 set_otherInformationString(apdu, VAL_COOKIE, 1,
414 m_client->m_init_flag = 1;
416 apdu = result_set_optimize(apdu);
420 logf (LOG_LOG, "Yaz_ProxyClient::send_Z_PDU %s", m_client->get_hostname());
422 // delete other info part from PDU before sending to target
423 Z_OtherInformation **oi;
424 get_otherInfoAPDU(apdu, &oi);
428 if (m_client->send_Z_PDU(apdu) < 0)
435 m_client->m_waiting = 1;
438 void Yaz_Proxy::connectNotify()
442 void Yaz_Proxy::shutdown()
444 logf (LOG_LOG, "shutdown (client to proxy)");
445 // only keep if keep_alive flag and cookie is set...
446 if (m_keepalive && m_client && m_client->m_cookie[0])
448 if (m_client->m_waiting == 2)
450 // Tell client (if any) that no server connection is there..
451 m_client->m_server = 0;
455 yaz_log (LOG_LOG, "deleting %p %p", this, m_client);
456 if (m_client->m_waiting == 2)
463 void Yaz_ProxyClient::shutdown()
465 logf (LOG_LOG, "shutdown (proxy to server) %s", get_hostname());
470 void Yaz_Proxy::failNotify()
472 logf (LOG_LOG, "connection closed by client");
476 void Yaz_ProxyClient::failNotify()
478 logf (LOG_LOG, "Yaz_ProxyClient connection closed by %s", get_hostname());
482 void Yaz_ProxyClient::connectNotify()
484 logf (LOG_LOG, "Yaz_ProxyClient connection accepted by %s",
489 IYaz_PDU_Observer *Yaz_ProxyClient::clone(IYaz_PDU_Observable
490 *the_PDU_Observable, int fd)
492 return new Yaz_ProxyClient(the_PDU_Observable);
495 Yaz_ProxyClient::~Yaz_ProxyClient()
500 m_next->m_prev = m_prev;
501 m_waiting = 2; // for debugging purposes only.
505 void Yaz_Proxy::timeoutNotify()
507 logf (LOG_LOG, "timeout (client to proxy)");
511 void Yaz_ProxyClient::timeoutNotify()
513 logf (LOG_LOG, "timeout (proxy to target) %s", get_hostname());
517 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
518 Yaz_Z_Assoc (the_PDU_Observable)
525 m_last_resultCount = 0;
530 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
533 logf (LOG_LOG, "Yaz_ProxyClient::recv_Z_PDU %s", get_hostname());
534 if (apdu->which == Z_APDU_searchResponse)
535 m_last_resultCount = *apdu->u.searchResponse->resultCount;
536 if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
539 Z_PresentResponse *pr = apdu->u.presentResponse;
540 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
541 Z_SearchResponse *sr = new_apdu->u.searchResponse;
542 sr->referenceId = pr->referenceId;
543 *sr->resultCount = m_last_resultCount;
544 sr->records = pr->records;
545 sr->nextResultSetPosition = pr->nextResultSetPosition;
546 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
550 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
553 logf (LOG_LOG, "Yaz_Proxy::send_Z_PDU");
554 m_server->send_Z_PDU(apdu);