1 /* $Id: filter_z3950_client.cpp,v 1.28 2006-08-30 12:27:34 adam Exp $
2 Copyright (c) 2005-2006, Index Data.
4 See the LICENSE file for details
10 #include "package.hpp"
12 #include "filter_z3950_client.hpp"
19 #include <boost/thread/mutex.hpp>
20 #include <boost/thread/condition.hpp>
24 #include <yaz/otherinfo.h>
25 #include <yaz/diagbib1.h>
27 #include <yazpp/socket-manager.h>
28 #include <yazpp/pdu-assoc.h>
29 #include <yazpp/z-assoc.h>
31 namespace mp = metaproxy_1;
32 namespace yf = mp::filter;
34 namespace metaproxy_1 {
36 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
38 Assoc(yazpp_1::SocketManager *socket_manager,
39 yazpp_1::IPDU_Observable *PDU_Observable,
40 std::string host, int timeout);
45 void recv_GDU(Z_GDU *gdu, int len);
46 yazpp_1::IPDU_Observer* sessionNotify(
47 yazpp_1::IPDU_Observable *the_PDU_Observable,
50 yazpp_1::SocketManager *m_socket_manager;
51 yazpp_1::IPDU_Observable *m_PDU_Observable;
63 class Z3950Client::Rep {
65 // number of seconds to wait before we give up request
68 boost::condition m_cond_session_ready;
69 std::map<mp::Session,Z3950Client::Assoc *> m_clients;
70 Z3950Client::Assoc *get_assoc(Package &package);
71 void send_and_receive(Package &package,
72 yf::Z3950Client::Assoc *c);
73 void release_assoc(Package &package);
80 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
81 yazpp_1::IPDU_Observable *PDU_Observable,
82 std::string host, int timeout_sec)
83 : Z_Assoc(PDU_Observable),
84 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
85 m_package(0), m_in_use(true), m_waiting(false),
86 m_destroyed(false), m_connected(false), m_queue_len(1),
87 m_time_elapsed(0), m_time_max(timeout_sec),
90 // std::cout << "create assoc " << this << "\n";
93 yf::Z3950Client::Assoc::~Assoc()
95 // std::cout << "destroy assoc " << this << "\n";
98 void yf::Z3950Client::Assoc::connectNotify()
105 void yf::Z3950Client::Assoc::failNotify()
113 Z_GDU *gdu = m_package->request().get();
115 if (gdu && gdu->which == Z_GDU_Z3950)
118 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
119 m_package->session().close();
123 void yf::Z3950Client::Assoc::timeoutNotify()
126 if (m_time_elapsed >= m_time_max)
134 Z_GDU *gdu = m_package->request().get();
136 if (gdu && gdu->which == Z_GDU_Z3950)
140 m_package->response() =
141 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
143 m_package->response() =
144 odr.create_close(apdu, Z_Close_peerAbort, 0);
146 m_package->session().close();
151 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
156 m_package->response() = gdu;
159 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
160 yazpp_1::IPDU_Observable *the_PDU_Observable,
167 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
169 m_p->m_timeout_sec = 30;
172 yf::Z3950Client::~Z3950Client() {
175 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
177 // only one thread messes with the clients list at a time
178 boost::mutex::scoped_lock lock(m_mutex);
180 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
182 Z_GDU *gdu = package.request().get();
183 // only deal with Z39.50
184 if (!gdu || gdu->which != Z_GDU_Z3950)
189 it = m_clients.find(package.session());
190 if (it != m_clients.end())
192 it->second->m_queue_len++;
196 // double init .. NOT working yet
197 if (gdu && gdu->which == Z_GDU_Z3950 &&
198 gdu->u.z3950->which == Z_APDU_initRequest)
200 yazpp_1::SocketManager *s = it->second->m_socket_manager;
201 delete it->second; // destroy Z_Assoc
202 delete s; // then manager
207 if (!it->second->m_in_use)
209 it->second->m_in_use = true;
212 m_cond_session_ready.wait(lock);
215 // new Z39.50 session ..
216 Z_APDU *apdu = gdu->u.z3950;
217 // check that it is init. If not, close
218 if (apdu->which != Z_APDU_initRequest)
222 package.response() = odr.create_close(apdu,
223 Z_Close_protocolError,
224 "First PDU was not an "
225 "Initialize Request");
226 package.session().close();
229 std::list<std::string> vhosts;
230 mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo, vhosts);
231 size_t no_vhosts = vhosts.size();
235 package.response() = odr.create_initResponse(
237 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
238 "z3950_client: No virtal host given");
240 package.session().close();
246 package.response() = odr.create_initResponse(
248 YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
249 "z3950_client: Can not cope with multiple vhosts");
250 package.session().close();
253 std::list<std::string>::const_iterator v_it = vhosts.begin();
254 std::list<std::string> dblist;
256 mp::util::split_zurl(*v_it, host, dblist);
260 ; // z3950_client: Databases in vhost ignored
263 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
264 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
265 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
268 m_clients[package.session()] = as;
272 void yf::Z3950Client::Rep::send_and_receive(Package &package,
273 yf::Z3950Client::Assoc *c)
275 Z_GDU *gdu = package.request().get();
280 if (!gdu || gdu->which != Z_GDU_Z3950)
283 c->m_time_elapsed = 0;
284 c->m_package = &package;
288 c->client(c->m_host.c_str());
289 c->timeout(1); // so timeoutNotify gets called once per second
291 while (!c->m_destroyed && c->m_waiting
292 && c->m_socket_manager->processEvent() > 0)
301 c->m_time_elapsed = 0;
304 // relay the package ..
306 c->send_GDU(gdu, &len);
308 switch(gdu->u.z3950->which)
310 case Z_APDU_triggerResourceControlRequest:
314 // for the rest: wait for a response PDU
315 while (!c->m_destroyed && c->m_waiting
316 && c->m_socket_manager->processEvent() > 0)
322 void yf::Z3950Client::Rep::release_assoc(Package &package)
324 boost::mutex::scoped_lock lock(m_mutex);
325 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
327 it = m_clients.find(package.session());
328 if (it != m_clients.end())
330 Z_GDU *gdu = package.request().get();
331 if (gdu && gdu->which == Z_GDU_Z3950)
332 { // only Z39.50 packages lock in get_assoc.. release it
333 it->second->m_in_use = false;
334 it->second->m_queue_len--;
337 if (package.session().is_closed())
339 // destroy hint (send_and_receive)
340 it->second->m_destroyed = true;
342 // wait until no one is waiting for it.
343 while (it->second->m_queue_len)
344 m_cond_session_ready.wait(lock);
346 // the Z_Assoc and PDU_Assoc must be destroyed before
347 // the socket manager.. so pull that out.. first..
348 yazpp_1::SocketManager *s = it->second->m_socket_manager;
349 delete it->second; // destroy Z_Assoc
350 delete s; // then manager
353 m_cond_session_ready.notify_all();
357 void yf::Z3950Client::process(Package &package) const
359 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
362 m_p->send_and_receive(package, c);
364 m_p->release_assoc(package);
367 void yf::Z3950Client::configure(const xmlNode *ptr)
369 for (ptr = ptr->children; ptr; ptr = ptr->next)
371 if (ptr->type != XML_ELEMENT_NODE)
373 if (!strcmp((const char *) ptr->name, "timeout"))
375 m_p->m_timeout_sec = mp::xml::get_int(ptr->children, 30);
379 throw mp::filter::FilterException("Bad element "
380 + std::string((const char *)
386 static mp::filter::Base* filter_creator()
388 return new mp::filter::Z3950Client;
392 struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
402 * indent-tabs-mode: nil
403 * c-file-style: "stroustrup"
405 * vim: shiftwidth=4 tabstop=8 expandtab