1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "filter_z3950_client.hpp"
22 #include <metaproxy/package.hpp>
23 #include <metaproxy/util.hpp>
30 #include <boost/thread/mutex.hpp>
31 #include <boost/thread/condition.hpp>
32 #include <boost/thread/xtime.hpp>
36 #include <yaz/otherinfo.h>
37 #include <yaz/diagbib1.h>
39 #include <yazpp/socket-manager.h>
40 #include <yazpp/pdu-assoc.h>
41 #include <yazpp/z-assoc.h>
43 namespace mp = metaproxy_1;
44 namespace yf = mp::filter;
46 namespace metaproxy_1 {
48 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
50 Assoc(yazpp_1::SocketManager *socket_manager,
51 yazpp_1::IPDU_Observable *PDU_Observable,
52 std::string host, int timeout);
57 void recv_GDU(Z_GDU *gdu, int len);
58 void fixup_nsd(ODR odr, Z_Records *records);
59 void fixup_init(ODR odr, Z_InitResponse *initrs);
60 yazpp_1::IPDU_Observer* sessionNotify(
61 yazpp_1::IPDU_Observable *the_PDU_Observable,
64 yazpp_1::SocketManager *m_socket_manager;
65 yazpp_1::IPDU_Observable *m_PDU_Observable;
75 int m_time_connect_max;
79 class Z3950Client::Rep {
81 // number of seconds to wait before we give up request
85 std::string m_default_target;
86 std::string m_force_target;
88 boost::condition m_cond_session_ready;
89 std::map<mp::Session,Z3950Client::Assoc *> m_clients;
90 Z3950Client::Assoc *get_assoc(Package &package);
91 void send_and_receive(Package &package,
92 yf::Z3950Client::Assoc *c);
93 void release_assoc(Package &package);
100 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
101 yazpp_1::IPDU_Observable *PDU_Observable,
102 std::string host, int timeout_sec)
103 : Z_Assoc(PDU_Observable),
104 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
105 m_package(0), m_in_use(true), m_waiting(false),
106 m_destroyed(false), m_connected(false), m_has_closed(false),
108 m_time_elapsed(0), m_time_max(timeout_sec), m_time_connect_max(10),
111 // std::cout << "create assoc " << this << "\n";
114 yf::Z3950Client::Assoc::~Assoc()
116 // std::cout << "destroy assoc " << this << "\n";
119 void yf::Z3950Client::Assoc::connectNotify()
126 void yf::Z3950Client::Assoc::failNotify()
134 Z_GDU *gdu = m_package->request().get();
136 if (gdu && gdu->which == Z_GDU_Z3950)
139 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
140 m_package->session().close();
144 void yf::Z3950Client::Assoc::timeoutNotify()
147 if ((m_connected && m_time_elapsed >= m_time_max)
148 || (!m_connected && m_time_elapsed >= m_time_connect_max))
156 Z_GDU *gdu = m_package->request().get();
158 if (gdu && gdu->which == Z_GDU_Z3950)
162 m_package->response() =
163 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
165 m_package->response() =
166 odr.create_close(apdu, Z_Close_peerAbort, 0);
168 m_package->session().close();
173 void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_Records *records)
175 if (records && records->which == Z_Records_NSD)
177 Z_DefaultDiagFormat *nsd = records->u.nonSurrogateDiagnostic;
180 // should really check for nsd->which.. But union has two members
181 // containing almost same data
182 const char *v2Addinfo = nsd->u.v2Addinfo;
183 // Z_InternationalString *v3Addinfo;
185 if (v2Addinfo && *v2Addinfo)
187 addinfo.assign(nsd->u.v2Addinfo);
190 addinfo += "(backend=" + m_host + ")";
191 nsd->u.v2Addinfo = odr_strdup(odr, addinfo.c_str());
195 void yf::Z3950Client::Assoc::fixup_init(ODR odr, Z_InitResponse *initrs)
197 Z_External *uif = initrs->userInformationField;
199 if (uif && uif->which == Z_External_userInfo1)
201 Z_OtherInformation *ui = uif->u.userInfo1;
203 for (i = 0; i < ui->num_elements; i++)
205 Z_OtherInformationUnit *unit = ui->list[i];
206 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
207 unit->information.externallyDefinedInfo &&
208 unit->information.externallyDefinedInfo->which ==
211 Z_DiagnosticFormat *diag =
212 unit->information.externallyDefinedInfo->u.diag1;
214 for (j = 0; j < diag->num; j++)
216 Z_DiagnosticFormat_s *ds = diag->elements[j];
217 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
219 Z_DefaultDiagFormat *r = ds->u.defaultDiagRec;
220 char *oaddinfo = r->u.v2Addinfo;
221 char *naddinfo = (char *) odr_malloc(
223 (oaddinfo ? strlen(oaddinfo) : 0) + 20 +
225 if (oaddinfo && *oaddinfo)
227 strcpy(naddinfo, oaddinfo);
228 strcat(naddinfo, " ");
230 strcat(naddinfo, "(backend=");
231 strcat(naddinfo, m_host.c_str());
232 strcat(naddinfo, ")");
234 r->u.v2Addinfo = naddinfo;
242 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
248 mp::odr odr; // must be in scope for response() = assignment
249 if (gdu && gdu->which == Z_GDU_Z3950)
251 Z_APDU *apdu = gdu->u.z3950;
254 case Z_APDU_searchResponse:
255 fixup_nsd(odr, apdu->u.searchResponse->records);
257 case Z_APDU_presentResponse:
258 fixup_nsd(odr, apdu->u.presentResponse->records);
260 case Z_APDU_initResponse:
261 fixup_init(odr, apdu->u.initResponse);
265 m_package->response() = gdu;
269 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
270 yazpp_1::IPDU_Observable *the_PDU_Observable,
277 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
279 m_p->m_timeout_sec = 30;
280 m_p->m_max_sockets = 0;
281 m_p->m_force_close = false;
284 yf::Z3950Client::~Z3950Client() {
287 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
289 // only one thread messes with the clients list at a time
290 boost::mutex::scoped_lock lock(m_mutex);
292 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
294 Z_GDU *gdu = package.request().get();
296 int max_sockets = package.origin().get_max_sockets();
297 if (max_sockets == 0)
298 max_sockets = m_max_sockets;
300 it = m_clients.find(package.session());
301 if (it != m_clients.end())
303 it->second->m_queue_len++;
307 // double init .. NOT working yet
308 if (gdu && gdu->which == Z_GDU_Z3950 &&
309 gdu->u.z3950->which == Z_APDU_initRequest)
311 yazpp_1::SocketManager *s = it->second->m_socket_manager;
312 delete it->second; // destroy Z_Assoc
313 delete s; // then manager
318 if (!it->second->m_in_use)
320 it->second->m_in_use = true;
323 m_cond_session_ready.wait(lock);
326 if (!gdu || gdu->which != Z_GDU_Z3950)
331 // new Z39.50 session ..
332 Z_APDU *apdu = gdu->u.z3950;
333 // check that it is init. If not, close
334 if (apdu->which != Z_APDU_initRequest)
338 package.response() = odr.create_close(apdu,
339 Z_Close_protocolError,
340 "First PDU was not an "
341 "Initialize Request");
342 package.session().close();
345 std::string target = m_force_target;
346 if (!target.length())
348 target = m_default_target;
349 std::list<std::string> vhosts;
350 mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
352 size_t no_vhosts = vhosts.size();
355 std::list<std::string>::const_iterator v_it = vhosts.begin();
358 else if (no_vhosts == 0)
360 if (!target.length())
362 // no default target. So we don't know where to connect
364 package.response() = odr.create_initResponse(
366 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
367 "z3950_client: No vhost given");
369 package.session().close();
373 else if (no_vhosts > 1)
376 package.response() = odr.create_initResponse(
378 YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
379 "z3950_client: Can not cope with multiple vhosts");
380 package.session().close();
385 // see if we have reached max number of clients (max-sockets)
389 int no_not_in_use = 0;
391 it = m_clients.begin();
392 for (; it != m_clients.end(); it++)
394 yf::Z3950Client::Assoc *as = it->second;
395 if (!strcmp(as->m_host.c_str(), target.c_str()))
402 yaz_log(YLOG_LOG, "Found %d/%d connections for %s", number, max_sockets,
404 if (number < max_sockets)
406 if (no_not_in_use == 0) // all in use..
410 package.response() = odr.create_initResponse(
411 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "max sessions");
412 package.session().close();
416 xtime_get(&xt, boost::TIME_UTC);
419 if (!m_cond_session_ready.timed_wait(lock, xt))
423 package.response() = odr.create_initResponse(
424 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "max sessions");
425 package.session().close();
430 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
431 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
432 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
435 m_clients[package.session()] = as;
439 void yf::Z3950Client::Rep::send_and_receive(Package &package,
440 yf::Z3950Client::Assoc *c)
445 c->m_package = &package;
447 if (package.session().is_closed() && c->m_connected && !c->m_has_closed
452 package.request() = odr.create_close(
453 0, Z_Close_finished, "z3950_client");
454 c->m_package = 0; // don't inspect response
456 Z_GDU *gdu = package.request().get();
458 if (!gdu || gdu->which != Z_GDU_Z3950)
461 if (gdu->u.z3950->which == Z_APDU_close)
462 c->m_has_closed = true;
465 c->m_time_elapsed = 0;
469 if (c->client(c->m_host.c_str()))
473 odr.create_close(gdu->u.z3950, Z_Close_peerAbort, 0);
474 package.session().close();
477 c->timeout(1); // so timeoutNotify gets called once per second
480 while (!c->m_destroyed && c->m_waiting
481 && c->m_socket_manager->processEvent() > 0)
490 c->m_time_elapsed = 0;
493 // relay the package ..
495 c->send_GDU(gdu, &len);
497 switch (gdu->u.z3950->which)
499 case Z_APDU_triggerResourceControlRequest:
503 // for the rest: wait for a response PDU
504 while (!c->m_destroyed && c->m_waiting
505 && c->m_socket_manager->processEvent() > 0)
511 void yf::Z3950Client::Rep::release_assoc(Package &package)
513 boost::mutex::scoped_lock lock(m_mutex);
514 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
516 it = m_clients.find(package.session());
517 if (it != m_clients.end())
519 it->second->m_in_use = false;
520 it->second->m_queue_len--;
522 if (package.session().is_closed())
524 // destroy hint (send_and_receive)
525 it->second->m_destroyed = true;
526 if (it->second->m_queue_len == 0)
528 yazpp_1::SocketManager *s = it->second->m_socket_manager;
529 delete it->second; // destroy Z_Assoc
530 delete s; // then manager
534 m_cond_session_ready.notify_all();
538 void yf::Z3950Client::process(Package &package) const
540 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
543 m_p->send_and_receive(package, c);
544 m_p->release_assoc(package);
548 void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only,
551 for (ptr = ptr->children; ptr; ptr = ptr->next)
553 if (ptr->type != XML_ELEMENT_NODE)
555 if (!strcmp((const char *) ptr->name, "timeout"))
557 m_p->m_timeout_sec = mp::xml::get_int(ptr, 30);
559 else if (!strcmp((const char *) ptr->name, "default_target"))
561 m_p->m_default_target = mp::xml::get_text(ptr);
563 else if (!strcmp((const char *) ptr->name, "force_target"))
565 m_p->m_force_target = mp::xml::get_text(ptr);
567 else if (!strcmp((const char *) ptr->name, "max-sockets"))
569 m_p->m_max_sockets = mp::xml::get_int(ptr, 0);
571 else if (!strcmp((const char *) ptr->name, "force_close"))
573 m_p->m_force_close = mp::xml::get_bool(ptr, 0);
577 throw mp::filter::FilterException("Bad element "
578 + std::string((const char *)
584 static mp::filter::Base* filter_creator()
586 return new mp::filter::Z3950Client;
590 struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
600 * c-file-style: "Stroustrup"
601 * indent-tabs-mode: nil
603 * vim: shiftwidth=4 tabstop=8 expandtab