1 /* $Id: filter_z3950_client.cpp,v 1.17 2006-01-09 18:19:09 adam Exp $
2 Copyright (c) 2005, Index Data.
12 #include "package.hpp"
14 #include "filter_z3950_client.hpp"
21 #include <boost/thread/mutex.hpp>
22 #include <boost/thread/condition.hpp>
26 #include <yaz/otherinfo.h>
27 #include <yaz/diagbib1.h>
29 #include <yaz++/socket-manager.h>
30 #include <yaz++/pdu-assoc.h>
31 #include <yaz++/z-assoc.h>
33 namespace yf = yp2::filter;
37 class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
39 Assoc(yazpp_1::SocketManager *socket_manager,
40 yazpp_1::IPDU_Observable *PDU_Observable,
41 std::string host, int timeout);
46 void recv_GDU(Z_GDU *gdu, int len);
47 yazpp_1::IPDU_Observer* sessionNotify(
48 yazpp_1::IPDU_Observable *the_PDU_Observable,
51 yazpp_1::SocketManager *m_socket_manager;
52 yazpp_1::IPDU_Observable *m_PDU_Observable;
64 class Z3950Client::Rep {
68 boost::condition m_cond_session_ready;
69 std::map<yp2::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 m_package->response() = odr.create_close(Z_Close_peerAbort, 0);
114 m_package->session().close();
118 void yf::Z3950Client::Assoc::timeoutNotify()
121 if (m_time_elapsed >= m_time_max)
130 m_package->response() = odr.create_close(Z_Close_lackOfActivity, 0);
132 m_package->response() = odr.create_close(Z_Close_peerAbort, 0);
134 m_package->session().close();
139 void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
144 m_package->response() = gdu;
147 yazpp_1::IPDU_Observer *yf::Z3950Client::Assoc::sessionNotify(
148 yazpp_1::IPDU_Observable *the_PDU_Observable,
155 yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
157 m_p->m_timeout_sec = 30;
160 yf::Z3950Client::~Z3950Client() {
163 yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
165 // only one thread messes with the clients list at a time
166 boost::mutex::scoped_lock lock(m_mutex);
168 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
170 Z_GDU *gdu = package.request().get();
171 // only deal with Z39.50
172 if (!gdu || gdu->which != Z_GDU_Z3950)
177 it = m_clients.find(package.session());
178 if (it != m_clients.end())
180 it->second->m_queue_len++;
184 if (gdu && gdu->which == Z_GDU_Z3950 &&
185 gdu->u.z3950->which == Z_APDU_initRequest)
187 yazpp_1::SocketManager *s = it->second->m_socket_manager;
188 delete it->second; // destroy Z_Assoc
189 delete s; // then manager
194 if (!it->second->m_in_use)
196 it->second->m_in_use = true;
199 m_cond_session_ready.wait(lock);
202 // new Z39.50 session ..
203 Z_APDU *apdu = gdu->u.z3950;
204 // check that it is init. If not, close
205 if (apdu->which != Z_APDU_initRequest)
209 package.response() = odr.create_close(Z_Close_protocolError,
210 "First PDU was not an "
211 "Initialize Request");
212 package.session().close();
215 // check virtual host
217 yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
219 /* categoryValue */ 1, /* delete */ 1);
223 package.response() = odr.create_initResponse(
224 YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
225 "Virtual host not given");
227 package.session().close();
231 yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
232 yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
233 yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as, vhost,
235 m_clients[package.session()] = as;
239 void yf::Z3950Client::Rep::send_and_receive(Package &package,
240 yf::Z3950Client::Assoc *c)
242 Z_GDU *gdu = package.request().get();
247 if (!gdu || gdu->which != Z_GDU_Z3950)
250 c->m_time_elapsed = 0;
251 c->m_package = &package;
255 c->client(c->m_host.c_str());
258 while (!c->m_destroyed && c->m_waiting
259 && c->m_socket_manager->processEvent() > 0)
268 c->m_time_elapsed = 0;
271 // relay the package ..
273 c->send_GDU(gdu, &len);
275 switch(gdu->u.z3950->which)
277 case Z_APDU_triggerResourceControlRequest:
281 // for the rest: wait for a response PDU
282 while (!c->m_destroyed && c->m_waiting
283 && c->m_socket_manager->processEvent() > 0)
289 void yf::Z3950Client::Rep::release_assoc(Package &package)
291 boost::mutex::scoped_lock lock(m_mutex);
292 std::map<yp2::Session,yf::Z3950Client::Assoc *>::iterator it;
294 it = m_clients.find(package.session());
295 if (it != m_clients.end())
297 Z_GDU *gdu = package.request().get();
298 if (gdu && gdu->which == Z_GDU_Z3950)
299 { // only Z39.50 packages lock in get_assoc.. release it
300 it->second->m_in_use = false;
301 it->second->m_queue_len--;
304 if (package.session().is_closed())
306 // destroy hint (send_and_receive)
307 it->second->m_destroyed = true;
309 // wait until no one is waiting for it.
310 while (it->second->m_queue_len)
311 m_cond_session_ready.wait(lock);
313 // the Z_Assoc and PDU_Assoc must be destroyed before
314 // the socket manager.. so pull that out.. first..
315 yazpp_1::SocketManager *s = it->second->m_socket_manager;
316 delete it->second; // destroy Z_Assoc
317 delete s; // then manager
320 m_cond_session_ready.notify_all();
324 void yf::Z3950Client::process(Package &package) const
326 yf::Z3950Client::Assoc *c = m_p->get_assoc(package);
329 m_p->send_and_receive(package, c);
331 m_p->release_assoc(package);
334 void yf::Z3950Client::configure(const xmlNode *ptr)
336 for (ptr = ptr->children; ptr; ptr = ptr->next)
338 if (ptr->type != XML_ELEMENT_NODE)
340 if (!strcmp((const char *) ptr->name, "timeout"))
342 std::string timeout_str = yp2::xml::get_text(ptr);
343 int timeout_sec = atoi(timeout_str.c_str());
345 throw yp2::filter::FilterException("Bad timeout value "
347 m_p->m_timeout_sec = timeout_sec;
351 throw yp2::filter::FilterException("Bad element "
352 + std::string((const char *)
358 static yp2::filter::Base* filter_creator()
360 return new yp2::filter::Z3950Client;
364 struct yp2_filter_struct yp2_filter_z3950_client = {
374 * indent-tabs-mode: nil
375 * c-file-style: "stroustrup"
377 * vim: shiftwidth=4 tabstop=8 expandtab