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>
39 #include <yaz/charneg.h>
41 #include <yazpp/socket-manager.h>
42 #include <yazpp/pdu-assoc.h>
43 #include <yazpp/z-assoc.h>
45 namespace mp = metaproxy_1;
46 namespace yf = mp::filter;
48 namespace metaproxy_1 {
50 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
52 Assoc(yazpp_1::SocketManager *socket_manager,
53 yazpp_1::IPDU_Observable *PDU_Observable,
54 std::string host, int timeout);
59 void recv_GDU(Z_GDU *gdu, int len);
60 void fixup_nsd(ODR odr, Z_Records *records);
61 void fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd);
62 void fixup_init(ODR odr, Z_InitResponse *initrs);
63 yazpp_1::IPDU_Observer* sessionNotify(
64 yazpp_1::IPDU_Observable *the_PDU_Observable,
67 yazpp_1::SocketManager *m_socket_manager;
68 yazpp_1::IPDU_Observable *m_PDU_Observable;
78 int m_time_connect_max;
82 class Z3950Client::Rep {
84 // number of seconds to wait before we give up request
90 std::string m_charset;
91 std::string m_default_target;
92 std::string m_force_target;
94 boost::condition m_cond_session_ready;
95 std::map<mp::Session,Z3950Client::Assoc *> m_clients;
96 Z3950Client::Assoc *get_assoc(Package &package);
97 void send_and_receive(Package &package,
98 yf::Z3950Client::Assoc *c);
99 void release_assoc(Package &package);
106 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
107 yazpp_1::IPDU_Observable *PDU_Observable,
108 std::string host, int timeout_sec)
109 : Z_Assoc(PDU_Observable),
110 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
111 m_package(0), m_in_use(true), m_waiting(false),
112 m_destroyed(false), m_connected(false), m_has_closed(false),
114 m_time_elapsed(0), m_time_max(timeout_sec), m_time_connect_max(10),
117 // std::cout << "create assoc " << this << "\n";
120 yf::Z3950Client::Assoc::~Assoc()
122 // std::cout << "destroy assoc " << this << "\n";
125 void yf::Z3950Client::Assoc::connectNotify()
132 void yf::Z3950Client::Assoc::failNotify()
140 Z_GDU *gdu = m_package->request().get();
142 if (gdu && gdu->which == Z_GDU_Z3950)
145 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
146 m_package->session().close();
150 void yf::Z3950Client::Assoc::timeoutNotify()
153 if ((m_connected && m_time_elapsed >= m_time_max)
154 || (!m_connected && m_time_elapsed >= m_time_connect_max))
162 Z_GDU *gdu = m_package->request().get();
164 if (gdu && gdu->which == Z_GDU_Z3950)
168 m_package->response() =
169 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
171 m_package->response() =
172 odr.create_close(apdu, Z_Close_peerAbort, 0);
174 m_package->session().close();
179 void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_DefaultDiagFormat *nsd)
183 // should really check for nsd->which.. But union has two members
184 // containing almost same data
185 const char *v2Addinfo = nsd->u.v2Addinfo;
186 // Z_InternationalString *v3Addinfo;
187 if (v2Addinfo && *v2Addinfo)
189 addinfo.assign(nsd->u.v2Addinfo);
192 addinfo += "(backend=" + m_host + ")";
193 nsd->u.v2Addinfo = odr_strdup(odr, addinfo.c_str());
196 void yf::Z3950Client::Assoc::fixup_nsd(ODR odr, Z_Records *records)
198 if (records && records->which == Z_Records_NSD)
200 fixup_nsd(odr, records->u.nonSurrogateDiagnostic);
202 if (records && records->which == Z_Records_multipleNSD)
204 Z_DiagRecs *drecs = records->u.multipleNonSurDiagnostics;
206 for (i = 0; i < drecs->num_diagRecs; i++)
208 Z_DiagRec *dr = drecs->diagRecs[i];
210 if (dr->which == Z_DiagRec_defaultFormat)
211 fixup_nsd(odr, dr->u.defaultFormat);
216 void yf::Z3950Client::Assoc::fixup_init(ODR odr, Z_InitResponse *initrs)
218 Z_External *uif = initrs->userInformationField;
220 if (uif && uif->which == Z_External_userInfo1)
222 Z_OtherInformation *ui = uif->u.userInfo1;
224 for (i = 0; i < ui->num_elements; i++)
226 Z_OtherInformationUnit *unit = ui->list[i];
227 if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
228 unit->information.externallyDefinedInfo &&
229 unit->information.externallyDefinedInfo->which ==
232 Z_DiagnosticFormat *diag =
233 unit->information.externallyDefinedInfo->u.diag1;
235 for (j = 0; j < diag->num; j++)
237 Z_DiagnosticFormat_s *ds = diag->elements[j];
238 if (ds->which == Z_DiagnosticFormat_s_defaultDiagRec)
240 Z_DefaultDiagFormat *r = ds->u.defaultDiagRec;
241 char *oaddinfo = r->u.v2Addinfo;
242 char *naddinfo = (char *) odr_malloc(
244 (oaddinfo ? strlen(oaddinfo) : 0) + 20 +
247 if (oaddinfo && *oaddinfo)
249 strcat(naddinfo, oaddinfo);
250 strcat(naddinfo, " ");
252 strcat(naddinfo, "(backend=");
253 strcat(naddinfo, m_host.c_str());
254 strcat(naddinfo, ")");
256 r->u.v2Addinfo = naddinfo;
264 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
270 mp::odr odr; // must be in scope for response() = assignment
271 if (gdu && gdu->which == Z_GDU_Z3950)
273 Z_APDU *apdu = gdu->u.z3950;
276 case Z_APDU_searchResponse:
277 fixup_nsd(odr, apdu->u.searchResponse->records);
279 case Z_APDU_presentResponse:
280 fixup_nsd(odr, apdu->u.presentResponse->records);
282 case Z_APDU_initResponse:
283 fixup_init(odr, apdu->u.initResponse);
287 m_package->response() = gdu;
291 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
292 yazpp_1::IPDU_Observable *the_PDU_Observable,
299 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
301 m_p->m_timeout_sec = 30;
302 m_p->m_max_sockets = 0;
303 m_p->m_force_close = false;
304 m_p->m_client_ip = false;
305 m_p->m_bind_host = false;
308 yf::Z3950Client::~Z3950Client() {
311 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
313 // only one thread messes with the clients list at a time
314 boost::mutex::scoped_lock lock(m_mutex);
316 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
318 Z_GDU *gdu = package.request().get();
320 int max_sockets = package.origin().get_max_sockets();
321 if (max_sockets == 0)
322 max_sockets = m_max_sockets;
324 it = m_clients.find(package.session());
325 if (it != m_clients.end())
327 it->second->m_queue_len++;
331 // double init .. NOT working yet
332 if (gdu && gdu->which == Z_GDU_Z3950 &&
333 gdu->u.z3950->which == Z_APDU_initRequest)
335 yazpp_1::SocketManager *s = it->second->m_socket_manager;
336 delete it->second; // destroy Z_Assoc
337 delete s; // then manager
342 if (!it->second->m_in_use)
344 it->second->m_in_use = true;
347 m_cond_session_ready.wait(lock);
350 if (!gdu || gdu->which != Z_GDU_Z3950)
355 // new Z39.50 session ..
356 Z_APDU *apdu = gdu->u.z3950;
357 // check that it is init. If not, close
358 if (apdu->which != Z_APDU_initRequest)
362 package.response() = odr.create_close(apdu,
363 Z_Close_protocolError,
364 "First PDU was not an "
365 "Initialize Request");
366 package.session().close();
369 std::string target = m_force_target;
370 if (!target.length())
372 target = m_default_target;
373 std::list<std::string> vhosts;
374 mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
376 size_t no_vhosts = vhosts.size();
379 std::list<std::string>::const_iterator v_it = vhosts.begin();
382 else if (no_vhosts == 0)
384 if (!target.length())
386 // no default target. So we don't know where to connect
388 package.response() = odr.create_initResponse(
390 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
391 "z3950_client: No vhost given");
393 package.session().close();
397 else if (no_vhosts > 1)
400 package.response() = odr.create_initResponse(
402 YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
403 "z3950_client: Can not cope with multiple vhosts");
404 package.session().close();
409 // see if we have reached max number of clients (max-sockets)
413 int no_not_in_use = 0;
415 it = m_clients.begin();
416 for (; it != m_clients.end(); it++)
418 yf::Z3950Client::Assoc *as = it->second;
419 if (!strcmp(as->m_host.c_str(), target.c_str()))
426 yaz_log(YLOG_LOG, "Found %d/%d connections for %s", number, max_sockets,
428 if (number < max_sockets)
430 if (no_not_in_use == 0) // all in use..
434 package.response() = odr.create_initResponse(
435 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
436 "z3950_client: max sessions");
437 package.session().close();
442 #if BOOST_VERSION >= 105000
450 if (!m_cond_session_ready.timed_wait(lock, xt))
454 package.response() = odr.create_initResponse(
455 apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
456 "z3950_client: max sessions");
457 package.session().close();
462 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
463 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
464 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
467 m_clients[package.session()] = as;
471 static void set_charset_proposal(ODR odr, Z_InitRequest *req, const char *charset)
473 Z_OtherInformation **p = &req->otherInfo;
474 Z_OtherInformationUnit *oi;
479 for (i = 0; i < (*p)->num_elements; i++)
481 Z_External *ext = (*p)->list[i]->information.externallyDefinedInfo;
482 if ((*p)->list[i]->which == Z_OtherInfo_externallyDefinedInfo
484 ext->which == Z_External_charSetandLanguageNegotiation)
488 if ((oi = yaz_oi_update(p, odr, 0, 0, 0)))
490 ODR_MASK_SET(req->options, Z_Options_negotiationModel);
491 oi->which = Z_OtherInfo_externallyDefinedInfo;
492 oi->information.externallyDefinedInfo =
493 yaz_set_proposal_charneg_list(odr, ",",
496 1 /* records included */);
500 void yf::Z3950Client::Rep::send_and_receive(Package &package,
501 yf::Z3950Client::Assoc *c)
506 c->m_package = &package;
508 if (package.session().is_closed() && c->m_connected && !c->m_has_closed
513 package.request() = odr.create_close(
514 0, Z_Close_finished, "z3950_client");
515 c->m_package = 0; // don't inspect response
517 Z_GDU *gdu = package.request().get();
519 if (!gdu || gdu->which != Z_GDU_Z3950)
522 if (gdu->u.z3950->which == Z_APDU_close)
523 c->m_has_closed = true;
525 Z_APDU *apdu = gdu->u.z3950;
528 c->m_time_elapsed = 0;
532 std::string host(c->m_host);
536 std::string bind_host = package.origin().get_bind_address();
537 if (bind_host.length())
540 host.append(bind_host);
543 if (c->client(host.c_str()))
547 odr.create_close(gdu->u.z3950, Z_Close_peerAbort, 0);
548 package.session().close();
551 c->timeout(1); // so timeoutNotify gets called once per second
554 while (!c->m_destroyed && c->m_waiting
555 && c->m_socket_manager->processEvent() > 0)
565 std::string peer_name2 = package.origin().get_address();
566 if (apdu->which == Z_APDU_initRequest && peer_name2.length())
568 Z_OtherInformation **oi = &apdu->u.initRequest->otherInfo;
570 yaz_oi_get_string_oid(oi, yaz_oid_userinfo_client_ip, 1, 1);
574 pcomb.append(peer_name1);
577 pcomb.append(peer_name2);
578 yaz_oi_set_string_oid(&apdu->u.initRequest->otherInfo,
579 odr, yaz_oid_userinfo_client_ip,
583 if (apdu->which == Z_APDU_initRequest && m_charset.length() > 0)
584 set_charset_proposal(odr, apdu->u.initRequest, m_charset.c_str());
587 c->m_time_elapsed = 0;
590 // relay the package ..
592 c->send_GDU(gdu, &len);
594 switch (gdu->u.z3950->which)
596 case Z_APDU_triggerResourceControlRequest:
600 // for the rest: wait for a response PDU
601 while (!c->m_destroyed && c->m_waiting
602 && c->m_socket_manager->processEvent() > 0)
608 void yf::Z3950Client::Rep::release_assoc(Package &package)
610 boost::mutex::scoped_lock lock(m_mutex);
611 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
613 it = m_clients.find(package.session());
614 if (it != m_clients.end())
616 it->second->m_in_use = false;
617 it->second->m_queue_len--;
619 if (package.session().is_closed())
621 // destroy hint (send_and_receive)
622 it->second->m_destroyed = true;
623 if (it->second->m_queue_len == 0)
625 yazpp_1::SocketManager *s = it->second->m_socket_manager;
626 delete it->second; // destroy Z_Assoc
627 delete s; // then manager
631 m_cond_session_ready.notify_all();
635 void yf::Z3950Client::process(Package &package) const
637 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
640 m_p->send_and_receive(package, c);
641 m_p->release_assoc(package);
645 void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only,
648 for (ptr = ptr->children; ptr; ptr = ptr->next)
650 if (ptr->type != XML_ELEMENT_NODE)
652 if (!strcmp((const char *) ptr->name, "timeout"))
654 m_p->m_timeout_sec = mp::xml::get_int(ptr, 30);
656 else if (!strcmp((const char *) ptr->name, "default_target"))
658 m_p->m_default_target = mp::xml::get_text(ptr);
660 else if (!strcmp((const char *) ptr->name, "force_target"))
662 m_p->m_force_target = mp::xml::get_text(ptr);
664 else if (!strcmp((const char *) ptr->name, "max-sockets"))
666 m_p->m_max_sockets = mp::xml::get_int(ptr, 0);
668 else if (!strcmp((const char *) ptr->name, "force_close"))
670 m_p->m_force_close = mp::xml::get_bool(ptr, 0);
672 else if (!strcmp((const char *) ptr->name, "client_ip"))
674 m_p->m_client_ip = mp::xml::get_bool(ptr, 0);
676 else if (!strcmp((const char *) ptr->name, "charset"))
678 m_p->m_charset = mp::xml::get_text(ptr);
680 else if (!strcmp((const char *) ptr->name, "bind_host"))
682 m_p->m_bind_host = mp::xml::get_bool(ptr, 0);
686 throw mp::filter::FilterException("Bad element "
687 + std::string((const char *)
693 static mp::filter::Base* filter_creator()
695 return new mp::filter::Z3950Client;
699 struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
709 * c-file-style: "Stroustrup"
710 * indent-tabs-mode: nil
712 * vim: shiftwidth=4 tabstop=8 expandtab