1 /* $Id: filter_z3950_client.cpp,v 1.18 2006-01-09 21:20:15 adam Exp $
2 Copyright (c) 2005, Index Data.
11 #include "package.hpp"
13 #include "filter_z3950_client.hpp"
20 #include <boost/thread/mutex.hpp>
21 #include <boost/thread/condition.hpp>
25 #include <yaz/otherinfo.h>
26 #include <yaz/diagbib1.h>
28 #include <yaz++/socket-manager.h>
29 #include <yaz++/pdu-assoc.h>
30 #include <yaz++/z-assoc.h>
32 namespace yf = yp2::filter;
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<yp2::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 m_package->response() = odr.create_close(Z_Close_peerAbort, 0);
113 m_package->session().close();
117 void yf::Z3950Client::Assoc::timeoutNotify()
120 if (m_time_elapsed >= m_time_max)
129 m_package->response() = odr.create_close(Z_Close_lackOfActivity, 0);
131 m_package->response() = odr.create_close(Z_Close_peerAbort, 0);
133 m_package->session().close();
138 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
143 m_package->response() = gdu;
146 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
147 yazpp_1::IPDU_Observable *the_PDU_Observable,
154 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
156 m_p->m_timeout_sec = 30;
159 yf::Z3950Client::~Z3950Client() {
162 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
164 // only one thread messes with the clients list at a time
165 boost::mutex::scoped_lock lock(m_mutex);
167 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
169 Z_GDU *gdu = package.request().get();
170 // only deal with Z39.50
171 if (!gdu || gdu->which != Z_GDU_Z3950)
176 it = m_clients.find(package.session());
177 if (it != m_clients.end())
179 it->second->m_queue_len++;
183 if (gdu && gdu->which == Z_GDU_Z3950 &&
184 gdu->u.z3950->which == Z_APDU_initRequest)
186 yazpp_1::SocketManager *s = it->second->m_socket_manager;
187 delete it->second; // destroy Z_Assoc
188 delete s; // then manager
193 if (!it->second->m_in_use)
195 it->second->m_in_use = true;
198 m_cond_session_ready.wait(lock);
201 // new Z39.50 session ..
202 Z_APDU *apdu = gdu->u.z3950;
203 // check that it is init. If not, close
204 if (apdu->which != Z_APDU_initRequest)
208 package.response() = odr.create_close(Z_Close_protocolError,
209 "First PDU was not an "
210 "Initialize Request");
211 package.session().close();
214 // check virtual host
216 yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
218 /* categoryValue */ 1, /* delete */ 1);
222 package.response() = odr.create_initResponse(
223 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
224 "Virtual host not given");
226 package.session().close();
230 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
231 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
232 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as, vhost,
234 m_clients[package.session()] = as;
238 void yf::Z3950Client::Rep::send_and_receive(Package &package,
239 yf::Z3950Client::Assoc *c)
241 Z_GDU *gdu = package.request().get();
246 if (!gdu || gdu->which != Z_GDU_Z3950)
249 c->m_time_elapsed = 0;
250 c->m_package = &package;
254 c->client(c->m_host.c_str());
257 while (!c->m_destroyed && c->m_waiting
258 && c->m_socket_manager->processEvent() > 0)
267 c->m_time_elapsed = 0;
270 // relay the package ..
272 c->send_GDU(gdu, &len);
274 switch(gdu->u.z3950->which)
276 case Z_APDU_triggerResourceControlRequest:
280 // for the rest: wait for a response PDU
281 while (!c->m_destroyed && c->m_waiting
282 && c->m_socket_manager->processEvent() > 0)
288 void yf::Z3950Client::Rep::release_assoc(Package &package)
290 boost::mutex::scoped_lock lock(m_mutex);
291 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
293 it = m_clients.find(package.session());
294 if (it != m_clients.end())
296 Z_GDU *gdu = package.request().get();
297 if (gdu && gdu->which == Z_GDU_Z3950)
298 { // only Z39.50 packages lock in get_assoc.. release it
299 it->second->m_in_use = false;
300 it->second->m_queue_len--;
303 if (package.session().is_closed())
305 // destroy hint (send_and_receive)
306 it->second->m_destroyed = true;
308 // wait until no one is waiting for it.
309 while (it->second->m_queue_len)
310 m_cond_session_ready.wait(lock);
312 // the Z_Assoc and PDU_Assoc must be destroyed before
313 // the socket manager.. so pull that out.. first..
314 yazpp_1::SocketManager *s = it->second->m_socket_manager;
315 delete it->second; // destroy Z_Assoc
316 delete s; // then manager
319 m_cond_session_ready.notify_all();
323 void yf::Z3950Client::process(Package &package) const
325 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
328 m_p->send_and_receive(package, c);
330 m_p->release_assoc(package);
333 void yf::Z3950Client::configure(const xmlNode *ptr)
335 for (ptr = ptr->children; ptr; ptr = ptr->next)
337 if (ptr->type != XML_ELEMENT_NODE)
339 if (!strcmp((const char *) ptr->name, "timeout"))
341 std::string timeout_str = yp2::xml::get_text(ptr);
342 int timeout_sec = atoi(timeout_str.c_str());
344 throw yp2::filter::FilterException("Bad timeout value "
346 m_p->m_timeout_sec = timeout_sec;
350 throw yp2::filter::FilterException("Bad element "
351 + std::string((const char *)
357 static yp2::filter::Base* filter_creator()
359 return new yp2::filter::Z3950Client;
363 struct yp2_filter_struct yp2_filter_z3950_client = {
373 * indent-tabs-mode: nil
374 * c-file-style: "stroustrup"
376 * vim: shiftwidth=4 tabstop=8 expandtab