1 /* This file is part of Metaproxy.
2 Copyright (C) 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>
38 #include <yaz/oid_db.h>
40 #include <yazpp/socket-manager.h>
41 #include <yazpp/pdu-assoc.h>
42 #include <yazpp/z-assoc.h>
44 namespace mp = metaproxy_1;
45 namespace yf = mp::filter;
47 namespace metaproxy_1 {
49 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
51 Assoc(yazpp_1::SocketManager *socket_manager,
52 yazpp_1::IPDU_Observable *PDU_Observable,
53 std::string host, int timeout);
58 void recv_GDU(Z_GDU *gdu, int len);
59 void fixup_nsd(ODR odr, Z_Records *records);
60 void fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd);
61 void fixup_init(ODR odr, Z_InitResponse *initrs);
62 yazpp_1::IPDU_Observer* sessionNotify(
63 yazpp_1::IPDU_Observable *the_PDU_Observable,
66 yazpp_1::SocketManager *m_socket_manager;
67 yazpp_1::IPDU_Observable *m_PDU_Observable;
77 int m_time_connect_max;
81 class Z3950Client::Rep {
83 // number of seconds to wait before we give up request
88 std::string m_default_target;
89 std::string m_force_target;
91 boost::condition m_cond_session_ready;
92 std::map<mp::Session,Z3950Client::Assoc *> m_clients;
93 Z3950Client::Assoc *get_assoc(Package &package);
94 void send_and_receive(Package &package,
95 yf::Z3950Client::Assoc *c);
96 void release_assoc(Package &package);
103 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
104 yazpp_1::IPDU_Observable *PDU_Observable,
105 std::string host, int timeout_sec)
106 : Z_Assoc(PDU_Observable),
107 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
108 m_package(0), m_in_use(true), m_waiting(false),
109 m_destroyed(false), m_connected(false), m_has_closed(false),
111 m_time_elapsed(0), m_time_max(timeout_sec), m_time_connect_max(10),
114 // std::cout << "create assoc " << this << "\n";
117 yf::Z3950Client::Assoc::~Assoc()
119 // std::cout << "destroy assoc " << this << "\n";
122 void yf::Z3950Client::Assoc::connectNotify()
129 void yf::Z3950Client::Assoc::failNotify()
137 Z_GDU *gdu = m_package->request().get();
139 if (gdu && gdu->which == Z_GDU_Z3950)
142 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
143 m_package->session().close();
147 void yf::Z3950Client::Assoc::timeoutNotify()
150 if ((m_connected && m_time_elapsed >= m_time_max)
151 || (!m_connected && m_time_elapsed >= m_time_connect_max))
159 Z_GDU *gdu = m_package->request().get();
161 if (gdu && gdu->which == Z_GDU_Z3950)
165 m_package->response() =
166 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
168 m_package->response() =
169 odr.create_close(apdu, Z_Close_peerAbort, 0);
171 m_package->session().close();
176 void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd)
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;
184 if (v2Addinfo && *v2Addinfo)
186 addinfo.assign(nsd->u.v2Addinfo);
189 addinfo += "(backend=" + m_host + ")";
190 nsd->u.v2Addinfo = odr_strdup(odr, addinfo.c_str());
193 void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_Records *records)
195 if (records && records->which == Z_Records_NSD)
197 fixup_nsd(odr, records->u.nonSurrogateDiagnostic);
199 if (records && records->which == Z_Records_multipleNSD)
201 Z_DiagRecs *drecs = records->u.multipleNonSurDiagnostics;
203 for (i = 0; i < drecs->num_diagRecs; i++)
205 Z_DiagRec *dr = drecs->diagRecs[i];
207 if (dr->which == Z_DiagRec_defaultFormat)
208 fixup_nsd(odr, dr->u.defaultFormat);
213 void yf::Z3950Client::Assoc::fixup_init(ODR odr, Z_InitResponse *initrs)
215 Z_External *uif = initrs->userInformationField;
217 if (uif && uif->which == Z_External_userInfo1)
219 Z_OtherInformation *ui = uif->u.userInfo1;
221 for (i = 0; i < ui->num_elements; i++)
223 Z_OtherInformationUnit *unit = ui->list[i];
224 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
225 unit->information.externallyDefinedInfo &&
226 unit->information.externallyDefinedInfo->which ==
229 Z_DiagnosticFormat *diag =
230 unit->information.externallyDefinedInfo->u.diag1;
232 for (j = 0; j < diag->num; j++)
234 Z_DiagnosticFormat_s *ds = diag->elements[j];
235 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
237 Z_DefaultDiagFormat *r = ds->u.defaultDiagRec;
238 char *oaddinfo = r->u.v2Addinfo;
239 char *naddinfo = (char *) odr_malloc(
241 (oaddinfo ? strlen(oaddinfo) : 0) + 20 +
244 if (oaddinfo && *oaddinfo)
246 strcat(naddinfo, oaddinfo);
247 strcat(naddinfo, " ");
249 strcat(naddinfo, "(backend=");
250 strcat(naddinfo, m_host.c_str());
251 strcat(naddinfo, ")");
253 r->u.v2Addinfo = naddinfo;
261 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
267 mp::odr odr; // must be in scope for response() = assignment
268 if (gdu && gdu->which == Z_GDU_Z3950)
270 Z_APDU *apdu = gdu->u.z3950;
273 case Z_APDU_searchResponse:
274 fixup_nsd(odr, apdu->u.searchResponse->records);
276 case Z_APDU_presentResponse:
277 fixup_nsd(odr, apdu->u.presentResponse->records);
279 case Z_APDU_initResponse:
280 fixup_init(odr, apdu->u.initResponse);
284 m_package->response() = gdu;
288 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
289 yazpp_1::IPDU_Observable *the_PDU_Observable,
296 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
298 m_p->m_timeout_sec = 30;
299 m_p->m_max_sockets = 0;
300 m_p->m_force_close = false;
301 m_p->m_client_ip = false;
304 yf::Z3950Client::~Z3950Client() {
307 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
309 // only one thread messes with the clients list at a time
310 boost::mutex::scoped_lock lock(m_mutex);
312 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
314 Z_GDU *gdu = package.request().get();
316 int max_sockets = package.origin().get_max_sockets();
317 if (max_sockets == 0)
318 max_sockets = m_max_sockets;
320 it = m_clients.find(package.session());
321 if (it != m_clients.end())
323 it->second->m_queue_len++;
327 // double init .. NOT working yet
328 if (gdu && gdu->which == Z_GDU_Z3950 &&
329 gdu->u.z3950->which == Z_APDU_initRequest)
331 yazpp_1::SocketManager *s = it->second->m_socket_manager;
332 delete it->second; // destroy Z_Assoc
333 delete s; // then manager
338 if (!it->second->m_in_use)
340 it->second->m_in_use = true;
343 m_cond_session_ready.wait(lock);
346 if (!gdu || gdu->which != Z_GDU_Z3950)
351 // new Z39.50 session ..
352 Z_APDU *apdu = gdu->u.z3950;
353 // check that it is init. If not, close
354 if (apdu->which != Z_APDU_initRequest)
358 package.response() = odr.create_close(apdu,
359 Z_Close_protocolError,
360 "First PDU was not an "
361 "Initialize Request");
362 package.session().close();
365 std::string target = m_force_target;
366 if (!target.length())
368 target = m_default_target;
369 std::list<std::string> vhosts;
370 mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
372 size_t no_vhosts = vhosts.size();
375 std::list<std::string>::const_iterator v_it = vhosts.begin();
378 else if (no_vhosts == 0)
380 if (!target.length())
382 // no default target. So we don't know where to connect
384 package.response() = odr.create_initResponse(
386 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
387 "z3950_client: No vhost given");
389 package.session().close();
393 else if (no_vhosts > 1)
396 package.response() = odr.create_initResponse(
398 YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
399 "z3950_client: Can not cope with multiple vhosts");
400 package.session().close();
405 // see if we have reached max number of clients (max-sockets)
409 int no_not_in_use = 0;
411 it = m_clients.begin();
412 for (; it != m_clients.end(); it++)
414 yf::Z3950Client::Assoc *as = it->second;
415 if (!strcmp(as->m_host.c_str(), target.c_str()))
422 yaz_log(YLOG_LOG, "Found %d/%d connections for %s", number, max_sockets,
424 if (number < max_sockets)
426 if (no_not_in_use == 0) // all in use..
430 package.response() = odr.create_initResponse(
431 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
432 "z3950_client: max sessions");
433 package.session().close();
438 #if BOOST_VERSION >= 105000
446 if (!m_cond_session_ready.timed_wait(lock, xt))
450 package.response() = odr.create_initResponse(
451 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
452 "z3950_client: max sessions");
453 package.session().close();
458 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
459 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
460 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
463 m_clients[package.session()] = as;
467 void yf::Z3950Client::Rep::send_and_receive(Package &package,
468 yf::Z3950Client::Assoc *c)
473 c->m_package = &package;
475 if (package.session().is_closed() && c->m_connected && !c->m_has_closed
480 package.request() = odr.create_close(
481 0, Z_Close_finished, "z3950_client");
482 c->m_package = 0; // don't inspect response
484 Z_GDU *gdu = package.request().get();
486 if (!gdu || gdu->which != Z_GDU_Z3950)
489 if (gdu->u.z3950->which == Z_APDU_close)
490 c->m_has_closed = true;
492 Z_APDU *apdu = gdu->u.z3950;
495 c->m_time_elapsed = 0;
499 if (c->client(c->m_host.c_str()))
503 odr.create_close(gdu->u.z3950, Z_Close_peerAbort, 0);
504 package.session().close();
507 c->timeout(1); // so timeoutNotify gets called once per second
510 while (!c->m_destroyed && c->m_waiting
511 && c->m_socket_manager->processEvent() > 0)
521 std::string peer_name2 = package.origin().get_address();
522 if (apdu->which == Z_APDU_initRequest && peer_name2.length())
524 Z_OtherInformation **oi = &apdu->u.initRequest->otherInfo;
526 yaz_oi_get_string_oid(oi, yaz_oid_userinfo_client_ip, 1, 1);
530 pcomb.append(peer_name1);
533 pcomb.append(peer_name2);
534 yaz_oi_set_string_oid(&apdu->u.initRequest->otherInfo,
535 odr, yaz_oid_userinfo_client_ip,
540 c->m_time_elapsed = 0;
543 // relay the package ..
545 c->send_GDU(gdu, &len);
547 switch (gdu->u.z3950->which)
549 case Z_APDU_triggerResourceControlRequest:
553 // for the rest: wait for a response PDU
554 while (!c->m_destroyed && c->m_waiting
555 && c->m_socket_manager->processEvent() > 0)
561 void yf::Z3950Client::Rep::release_assoc(Package &package)
563 boost::mutex::scoped_lock lock(m_mutex);
564 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
566 it = m_clients.find(package.session());
567 if (it != m_clients.end())
569 it->second->m_in_use = false;
570 it->second->m_queue_len--;
572 if (package.session().is_closed())
574 // destroy hint (send_and_receive)
575 it->second->m_destroyed = true;
576 if (it->second->m_queue_len == 0)
578 yazpp_1::SocketManager *s = it->second->m_socket_manager;
579 delete it->second; // destroy Z_Assoc
580 delete s; // then manager
584 m_cond_session_ready.notify_all();
588 void yf::Z3950Client::process(Package &package) const
590 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
593 m_p->send_and_receive(package, c);
594 m_p->release_assoc(package);
598 void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only,
601 for (ptr = ptr->children; ptr; ptr = ptr->next)
603 if (ptr->type != XML_ELEMENT_NODE)
605 if (!strcmp((const char *) ptr->name, "timeout"))
607 m_p->m_timeout_sec = mp::xml::get_int(ptr, 30);
609 else if (!strcmp((const char *) ptr->name, "default_target"))
611 m_p->m_default_target = mp::xml::get_text(ptr);
613 else if (!strcmp((const char *) ptr->name, "force_target"))
615 m_p->m_force_target = mp::xml::get_text(ptr);
617 else if (!strcmp((const char *) ptr->name, "max-sockets"))
619 m_p->m_max_sockets = mp::xml::get_int(ptr, 0);
621 else if (!strcmp((const char *) ptr->name, "force_close"))
623 m_p->m_force_close = mp::xml::get_bool(ptr, 0);
625 else if (!strcmp((const char *) ptr->name, "client_ip"))
627 m_p->m_client_ip = mp::xml::get_bool(ptr, 0);
631 throw mp::filter::FilterException("Bad element "
632 + std::string((const char *)
638 static mp::filter::Base* filter_creator()
640 return new mp::filter::Z3950Client;
644 struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
654 * c-file-style: "Stroustrup"
655 * indent-tabs-mode: nil
657 * vim: shiftwidth=4 tabstop=8 expandtab