1 /* $Id: filter_z3950_client.cpp,v 1.25 2006-03-29 13:44:45 adam Exp $
2 Copyright (c) 2005-2006, Index Data.
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 {
67 boost::condition m_cond_session_ready;
68 std::map<mp::Session,Z3950Client::Assoc *> m_clients;
69 Z3950Client::Assoc *get_assoc(Package &package);
70 void send_and_receive(Package &package,
71 yf::Z3950Client::Assoc *c);
72 void release_assoc(Package &package);
79 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
80 yazpp_1::IPDU_Observable *PDU_Observable,
81 std::string host, int timeout_sec)
82 : Z_Assoc(PDU_Observable),
83 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
84 m_package(0), m_in_use(true), m_waiting(false),
85 m_destroyed(false), m_connected(false), m_queue_len(1),
86 m_time_elapsed(0), m_time_max(timeout_sec),
89 // std::cout << "create assoc " << this << "\n";
92 yf::Z3950Client::Assoc::~Assoc()
94 // std::cout << "destroy assoc " << this << "\n";
97 void yf::Z3950Client::Assoc::connectNotify()
104 void yf::Z3950Client::Assoc::failNotify()
112 Z_GDU *gdu = m_package->request().get();
114 if (gdu && gdu->which == Z_GDU_Z3950)
117 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
118 m_package->session().close();
122 void yf::Z3950Client::Assoc::timeoutNotify()
125 if (m_time_elapsed >= m_time_max)
133 Z_GDU *gdu = m_package->request().get();
135 if (gdu && gdu->which == Z_GDU_Z3950)
139 m_package->response() =
140 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
142 m_package->response() =
143 odr.create_close(apdu, Z_Close_peerAbort, 0);
145 m_package->session().close();
150 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
155 m_package->response() = gdu;
158 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
159 yazpp_1::IPDU_Observable *the_PDU_Observable,
166 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
168 m_p->m_timeout_sec = 30;
171 yf::Z3950Client::~Z3950Client() {
174 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
176 // only one thread messes with the clients list at a time
177 boost::mutex::scoped_lock lock(m_mutex);
179 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
181 Z_GDU *gdu = package.request().get();
182 // only deal with Z39.50
183 if (!gdu || gdu->which != Z_GDU_Z3950)
188 it = m_clients.find(package.session());
189 if (it != m_clients.end())
191 it->second->m_queue_len++;
195 if (gdu && gdu->which == Z_GDU_Z3950 &&
196 gdu->u.z3950->which == Z_APDU_initRequest)
198 yazpp_1::SocketManager *s = it->second->m_socket_manager;
199 delete it->second; // destroy Z_Assoc
200 delete s; // then manager
205 if (!it->second->m_in_use)
207 it->second->m_in_use = true;
210 m_cond_session_ready.wait(lock);
213 // new Z39.50 session ..
214 Z_APDU *apdu = gdu->u.z3950;
215 // check that it is init. If not, close
216 if (apdu->which != Z_APDU_initRequest)
220 package.response() = odr.create_close(apdu,
221 Z_Close_protocolError,
222 "First PDU was not an "
223 "Initialize Request");
224 package.session().close();
227 std::list<std::string> vhosts;
228 mp::util::get_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
230 size_t no_vhosts = vhosts.size();
234 package.response() = odr.create_initResponse(
236 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
237 "z3950_client: No virtal host given");
239 package.session().close();
245 package.response() = odr.create_initResponse(
247 YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
248 "z3950_client: Can not cope with multiple vhosts");
249 package.session().close();
252 std::list<std::string>::const_iterator v_it = vhosts.begin();
253 std::list<std::string> dblist;
255 mp::util::split_zurl(*v_it, host, dblist);
259 ; // z3950_client: Databases in vhost ignored
262 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
263 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
264 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
267 m_clients[package.session()] = as;
271 void yf::Z3950Client::Rep::send_and_receive(Package &package,
272 yf::Z3950Client::Assoc *c)
274 Z_GDU *gdu = package.request().get();
279 if (!gdu || gdu->which != Z_GDU_Z3950)
282 c->m_time_elapsed = 0;
283 c->m_package = &package;
287 c->client(c->m_host.c_str());
290 while (!c->m_destroyed && c->m_waiting
291 && c->m_socket_manager->processEvent() > 0)
300 c->m_time_elapsed = 0;
303 // relay the package ..
305 c->send_GDU(gdu, &len);
307 switch(gdu->u.z3950->which)
309 case Z_APDU_triggerResourceControlRequest:
313 // for the rest: wait for a response PDU
314 while (!c->m_destroyed && c->m_waiting
315 && c->m_socket_manager->processEvent() > 0)
321 void yf::Z3950Client::Rep::release_assoc(Package &package)
323 boost::mutex::scoped_lock lock(m_mutex);
324 std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
326 it = m_clients.find(package.session());
327 if (it != m_clients.end())
329 Z_GDU *gdu = package.request().get();
330 if (gdu && gdu->which == Z_GDU_Z3950)
331 { // only Z39.50 packages lock in get_assoc.. release it
332 it->second->m_in_use = false;
333 it->second->m_queue_len--;
336 if (package.session().is_closed())
338 // destroy hint (send_and_receive)
339 it->second->m_destroyed = true;
341 // wait until no one is waiting for it.
342 while (it->second->m_queue_len)
343 m_cond_session_ready.wait(lock);
345 // the Z_Assoc and PDU_Assoc must be destroyed before
346 // the socket manager.. so pull that out.. first..
347 yazpp_1::SocketManager *s = it->second->m_socket_manager;
348 delete it->second; // destroy Z_Assoc
349 delete s; // then manager
352 m_cond_session_ready.notify_all();
356 void yf::Z3950Client::process(Package &package) const
358 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
361 m_p->send_and_receive(package, c);
363 m_p->release_assoc(package);
366 void yf::Z3950Client::configure(const xmlNode *ptr)
368 for (ptr = ptr->children; ptr; ptr = ptr->next)
370 if (ptr->type != XML_ELEMENT_NODE)
372 if (!strcmp((const char *) ptr->name, "timeout"))
374 std::string timeout_str = mp::xml::get_text(ptr);
375 int timeout_sec = atoi(timeout_str.c_str());
377 throw mp::filter::FilterException("Bad timeout value "
379 m_p->m_timeout_sec = timeout_sec;
383 throw mp::filter::FilterException("Bad element "
384 + std::string((const char *)
390 static mp::filter::Base* filter_creator()
392 return new mp::filter::Z3950Client;
396 struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
406 * indent-tabs-mode: nil
407 * c-file-style: "stroustrup"
409 * vim: shiftwidth=4 tabstop=8 expandtab