1 /* $Id: filter_z3950_client.cpp,v 1.20 2006-01-13 15:09:35 adam Exp $
2 Copyright (c) 2005, 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 <yaz++/socket-manager.h>
28 #include <yaz++/pdu-assoc.h>
29 #include <yaz++/z-assoc.h>
31 namespace yf = yp2::filter;
35 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
37 Assoc(yazpp_1::SocketManager *socket_manager,
38 yazpp_1::IPDU_Observable *PDU_Observable,
39 std::string host, int timeout);
44 void recv_GDU(Z_GDU *gdu, int len);
45 yazpp_1::IPDU_Observer* sessionNotify(
46 yazpp_1::IPDU_Observable *the_PDU_Observable,
49 yazpp_1::SocketManager *m_socket_manager;
50 yazpp_1::IPDU_Observable *m_PDU_Observable;
62 class Z3950Client::Rep {
66 boost::condition m_cond_session_ready;
67 std::map<yp2::Session,Z3950Client::Assoc *> m_clients;
68 Z3950Client::Assoc *get_assoc(Package &package);
69 void send_and_receive(Package &package,
70 yf::Z3950Client::Assoc *c);
71 void release_assoc(Package &package);
78 yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
79 yazpp_1::IPDU_Observable *PDU_Observable,
80 std::string host, int timeout_sec)
81 : Z_Assoc(PDU_Observable),
82 m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
83 m_package(0), m_in_use(true), m_waiting(false),
84 m_destroyed(false), m_connected(false), m_queue_len(1),
85 m_time_elapsed(0), m_time_max(timeout_sec),
88 // std::cout << "create assoc " << this << "\n";
91 yf::Z3950Client::Assoc::~Assoc()
93 // std::cout << "destroy assoc " << this << "\n";
96 void yf::Z3950Client::Assoc::connectNotify()
103 void yf::Z3950Client::Assoc::failNotify()
111 Z_GDU *gdu = m_package->request().get();
113 if (gdu && gdu->which == Z_GDU_Z3950)
116 m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
117 m_package->session().close();
121 void yf::Z3950Client::Assoc::timeoutNotify()
124 if (m_time_elapsed >= m_time_max)
132 Z_GDU *gdu = m_package->request().get();
134 if (gdu && gdu->which == Z_GDU_Z3950)
138 m_package->response() =
139 odr.create_close(apdu, Z_Close_lackOfActivity, 0);
141 m_package->response() =
142 odr.create_close(apdu, Z_Close_peerAbort, 0);
144 m_package->session().close();
149 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
154 m_package->response() = gdu;
157 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
158 yazpp_1::IPDU_Observable *the_PDU_Observable,
165 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
167 m_p->m_timeout_sec = 30;
170 yf::Z3950Client::~Z3950Client() {
173 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
175 // only one thread messes with the clients list at a time
176 boost::mutex::scoped_lock lock(m_mutex);
178 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
180 Z_GDU *gdu = package.request().get();
181 // only deal with Z39.50
182 if (!gdu || gdu->which != Z_GDU_Z3950)
187 it = m_clients.find(package.session());
188 if (it != m_clients.end())
190 it->second->m_queue_len++;
194 if (gdu && gdu->which == Z_GDU_Z3950 &&
195 gdu->u.z3950->which == Z_APDU_initRequest)
197 yazpp_1::SocketManager *s = it->second->m_socket_manager;
198 delete it->second; // destroy Z_Assoc
199 delete s; // then manager
204 if (!it->second->m_in_use)
206 it->second->m_in_use = true;
209 m_cond_session_ready.wait(lock);
212 // new Z39.50 session ..
213 Z_APDU *apdu = gdu->u.z3950;
214 // check that it is init. If not, close
215 if (apdu->which != Z_APDU_initRequest)
219 package.response() = odr.create_close(apdu,
220 Z_Close_protocolError,
221 "First PDU was not an "
222 "Initialize Request");
223 package.session().close();
226 // check virtual host
228 yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
230 /* categoryValue */ 1, /* delete */ 1);
234 package.response() = odr.create_initResponse(
236 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
237 "Virtual host not given");
239 package.session().close();
243 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
244 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
245 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as, vhost,
247 m_clients[package.session()] = as;
251 void yf::Z3950Client::Rep::send_and_receive(Package &package,
252 yf::Z3950Client::Assoc *c)
254 Z_GDU *gdu = package.request().get();
259 if (!gdu || gdu->which != Z_GDU_Z3950)
262 c->m_time_elapsed = 0;
263 c->m_package = &package;
267 c->client(c->m_host.c_str());
270 while (!c->m_destroyed && c->m_waiting
271 && c->m_socket_manager->processEvent() > 0)
280 c->m_time_elapsed = 0;
283 // relay the package ..
285 c->send_GDU(gdu, &len);
287 switch(gdu->u.z3950->which)
289 case Z_APDU_triggerResourceControlRequest:
293 // for the rest: wait for a response PDU
294 while (!c->m_destroyed && c->m_waiting
295 && c->m_socket_manager->processEvent() > 0)
301 void yf::Z3950Client::Rep::release_assoc(Package &package)
303 boost::mutex::scoped_lock lock(m_mutex);
304 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
306 it = m_clients.find(package.session());
307 if (it != m_clients.end())
309 Z_GDU *gdu = package.request().get();
310 if (gdu && gdu->which == Z_GDU_Z3950)
311 { // only Z39.50 packages lock in get_assoc.. release it
312 it->second->m_in_use = false;
313 it->second->m_queue_len--;
316 if (package.session().is_closed())
318 // destroy hint (send_and_receive)
319 it->second->m_destroyed = true;
321 // wait until no one is waiting for it.
322 while (it->second->m_queue_len)
323 m_cond_session_ready.wait(lock);
325 // the Z_Assoc and PDU_Assoc must be destroyed before
326 // the socket manager.. so pull that out.. first..
327 yazpp_1::SocketManager *s = it->second->m_socket_manager;
328 delete it->second; // destroy Z_Assoc
329 delete s; // then manager
332 m_cond_session_ready.notify_all();
336 void yf::Z3950Client::process(Package &package) const
338 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
341 m_p->send_and_receive(package, c);
343 m_p->release_assoc(package);
346 void yf::Z3950Client::configure(const xmlNode *ptr)
348 for (ptr = ptr->children; ptr; ptr = ptr->next)
350 if (ptr->type != XML_ELEMENT_NODE)
352 if (!strcmp((const char *) ptr->name, "timeout"))
354 std::string timeout_str = yp2::xml::get_text(ptr);
355 int timeout_sec = atoi(timeout_str.c_str());
357 throw yp2::filter::FilterException("Bad timeout value "
359 m_p->m_timeout_sec = timeout_sec;
363 throw yp2::filter::FilterException("Bad element "
364 + std::string((const char *)
370 static yp2::filter::Base* filter_creator()
372 return new yp2::filter::Z3950Client;
376 struct yp2_filter_struct yp2_filter_z3950_client = {
386 * indent-tabs-mode: nil
387 * c-file-style: "stroustrup"
389 * vim: shiftwidth=4 tabstop=8 expandtab