-/* $Id: filter_z3950_client.cpp,v 1.4 2005-10-25 16:01:14 adam Exp $
- Copyright (c) 2005, Index Data.
+/* This file is part of Metaproxy.
+ Copyright (C) 2005-2008 Index Data
-%LICENSE%
- */
+Metaproxy is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
#include "config.hpp"
#include "filter.hpp"
-#include "router.hpp"
#include "package.hpp"
+#include "util.hpp"
+#include "filter_z3950_client.hpp"
-#include <boost/thread/mutex.hpp>
+#include <map>
+#include <stdexcept>
+#include <list>
+#include <iostream>
-#include "filter_z3950_client.hpp"
+#include <boost/thread/mutex.hpp>
+#include <boost/thread/condition.hpp>
+#include <boost/thread/xtime.hpp>
#include <yaz/zgdu.h>
#include <yaz/log.h>
#include <yaz/otherinfo.h>
#include <yaz/diagbib1.h>
-#include <yaz++/socket-manager.h>
-#include <yaz++/pdu-assoc.h>
-#include <yaz++/z-assoc.h>
-
-#include <iostream>
+#include <yazpp/socket-manager.h>
+#include <yazpp/pdu-assoc.h>
+#include <yazpp/z-assoc.h>
-namespace yf = yp2::filter;
+namespace mp = metaproxy_1;
+namespace yf = mp::filter;
-namespace yp2 {
+namespace metaproxy_1 {
namespace filter {
class Z3950Client::Assoc : public yazpp_1::Z_Assoc{
- friend class Pimpl;
- public:
- Assoc(yp2::Session id, yazpp_1::SocketManager *socket_manager,
+ friend class Rep;
+ Assoc(yazpp_1::SocketManager *socket_manager,
yazpp_1::IPDU_Observable *PDU_Observable,
- std::string host);
+ std::string host, int timeout);
~Assoc();
void connectNotify();
void failNotify();
yazpp_1::IPDU_Observer* sessionNotify(
yazpp_1::IPDU_Observable *the_PDU_Observable,
int fd);
- private:
- yp2::Session m_session_id;
+
yazpp_1::SocketManager *m_socket_manager;
yazpp_1::IPDU_Observable *m_PDU_Observable;
Package *m_package;
+ bool m_in_use;
bool m_waiting;
+ bool m_destroyed;
bool m_connected;
+ int m_queue_len;
+ int m_time_elapsed;
+ int m_time_max;
+ int m_time_connect_max;
std::string m_host;
};
- class Z3950Client::Pimpl {
+ class Z3950Client::Rep {
public:
+ // number of seconds to wait before we give up request
+ int m_timeout_sec;
+ int m_max_sockets;
+ std::string m_default_target;
+ std::string m_force_target;
boost::mutex m_mutex;
- std::list<Z3950Client::Assoc *> m_clients;
+ boost::condition m_cond_session_ready;
+ std::map<mp::Session,Z3950Client::Assoc *> m_clients;
Z3950Client::Assoc *get_assoc(Package &package);
void send_and_receive(Package &package,
yf::Z3950Client::Assoc *c);
- void release_assoc(Package &package,
- yf::Z3950Client::Assoc *c);
+ void release_assoc(Package &package);
};
}
}
+using namespace mp;
-yf::Z3950Client::Assoc::Assoc(yp2::Session id,
- yazpp_1::SocketManager *socket_manager,
+yf::Z3950Client::Assoc::Assoc(yazpp_1::SocketManager *socket_manager,
yazpp_1::IPDU_Observable *PDU_Observable,
- std::string host)
- : Z_Assoc(PDU_Observable), m_session_id(id),
+ std::string host, int timeout_sec)
+ : Z_Assoc(PDU_Observable),
m_socket_manager(socket_manager), m_PDU_Observable(PDU_Observable),
- m_package(0), m_waiting(false), m_connected(false),
+ m_package(0), m_in_use(true), m_waiting(false),
+ m_destroyed(false), m_connected(false), m_queue_len(1),
+ m_time_elapsed(0), m_time_max(timeout_sec), m_time_connect_max(10),
m_host(host)
{
// std::cout << "create assoc " << this << "\n";
{
m_waiting = false;
- ODR odr = odr_createmem(ODR_ENCODE);
-
- Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
-
- *apdu->u.close->closeReason = Z_Close_peerAbort;
+ mp::odr odr;
if (m_package)
{
- m_package->response() = apdu;
+ Z_GDU *gdu = m_package->request().get();
+ Z_APDU *apdu = 0;
+ if (gdu && gdu->which == Z_GDU_Z3950)
+ apdu = gdu->u.z3950;
+
+ m_package->response() = odr.create_close(apdu, Z_Close_peerAbort, 0);
m_package->session().close();
}
-
- odr_destroy(odr);
}
void yf::Z3950Client::Assoc::timeoutNotify()
{
- m_waiting = false;
-
- ODR odr = odr_createmem(ODR_ENCODE);
-
- Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
-
- *apdu->u.close->closeReason = Z_Close_lackOfActivity;
-
- if (m_package)
+ m_time_elapsed++;
+ if ((m_connected && m_time_elapsed >= m_time_max)
+ || (!m_connected && m_time_elapsed >= m_time_connect_max))
{
- m_package->response() = apdu;
- m_package->session().close();
+ m_waiting = false;
+
+ mp::odr odr;
+
+ if (m_package)
+ {
+ Z_GDU *gdu = m_package->request().get();
+ Z_APDU *apdu = 0;
+ if (gdu && gdu->which == Z_GDU_Z3950)
+ apdu = gdu->u.z3950;
+
+ if (m_connected)
+ m_package->response() =
+ odr.create_close(apdu, Z_Close_lackOfActivity, 0);
+ else
+ m_package->response() =
+ odr.create_close(apdu, Z_Close_peerAbort, 0);
+
+ m_package->session().close();
+ }
}
- odr_destroy(odr);
}
void yf::Z3950Client::Assoc::recv_GDU(Z_GDU *gdu, int len)
}
-yf::Z3950Client::Z3950Client() {
- m_p = new yf::Z3950Client::Pimpl;
+yf::Z3950Client::Z3950Client() : m_p(new yf::Z3950Client::Rep)
+{
+ m_p->m_timeout_sec = 30;
+ m_p->m_max_sockets = 0;
}
yf::Z3950Client::~Z3950Client() {
- delete m_p;
}
-yf::Z3950Client::Assoc *yf::Z3950Client::Pimpl::get_assoc(Package &package)
+yf::Z3950Client::Assoc *yf::Z3950Client::Rep::get_assoc(Package &package)
{
// only one thread messes with the clients list at a time
boost::mutex::scoped_lock lock(m_mutex);
- std::list<yf::Z3950Client::Assoc *>::iterator it;
-
- for (it = m_clients.begin(); it != m_clients.end(); it++)
- {
- if ((*it)->m_session_id == package.session())
- break;
- }
- if (it != m_clients.end())
- return *it;
-
- // only deal with Z39.50
+ std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
+
Z_GDU *gdu = package.request().get();
-
+ // only deal with Z39.50
if (!gdu || gdu->which != Z_GDU_Z3950)
{
package.move();
return 0;
}
- Z_APDU *apdu = gdu->u.z3950;
+
+ int max_sockets = package.origin().get_max_sockets();
+ if (max_sockets == 0)
+ max_sockets = m_max_sockets;
+
+ std::string host;
+ it = m_clients.find(package.session());
+ if (it != m_clients.end())
+ {
+ it->second->m_queue_len++;
+ while (true)
+ {
+#if 0
+ // double init .. NOT working yet
+ if (gdu && gdu->which == Z_GDU_Z3950 &&
+ gdu->u.z3950->which == Z_APDU_initRequest)
+ {
+ yazpp_1::SocketManager *s = it->second->m_socket_manager;
+ delete it->second; // destroy Z_Assoc
+ delete s; // then manager
+ m_clients.erase(it);
+ break;
+ }
+#endif
+ if (!it->second->m_in_use)
+ {
+ it->second->m_in_use = true;
+ return it->second;
+ }
+ m_cond_session_ready.wait(lock);
+ }
+ }
// new Z39.50 session ..
-
+ Z_APDU *apdu = gdu->u.z3950;
// check that it is init. If not, close
if (apdu->which != Z_APDU_initRequest)
{
- ODR odr = odr_createmem(ODR_ENCODE);
- Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
-
- *apdu->u.close->closeReason = Z_Close_protocolError;
- apdu->u.close->diagnosticInformation =
- odr_strdup(odr, "no init request for session");
-
- package.response() = apdu;
+ mp::odr odr;
+ package.response() = odr.create_close(apdu,
+ Z_Close_protocolError,
+ "First PDU was not an "
+ "Initialize Request");
package.session().close();
- odr_destroy(odr);
return 0;
}
- // check virtual host
- const char *vhost =
- yaz_oi_get_string_oidval(&apdu->u.initRequest->otherInfo,
- VAL_PROXY, 1, 0);
- if (!vhost)
+ std::string target = m_force_target;
+ if (!target.length())
+ {
+ target = m_default_target;
+ std::list<std::string> vhosts;
+ mp::util::remove_vhost_otherinfo(&apdu->u.initRequest->otherInfo,
+ vhosts);
+ size_t no_vhosts = vhosts.size();
+ if (no_vhosts == 1)
+ {
+ std::list<std::string>::const_iterator v_it = vhosts.begin();
+ target = *v_it;
+ }
+ else if (no_vhosts == 0)
+ {
+ if (!target.length())
+ {
+ // no default target. So we don't know where to connect
+ mp::odr odr;
+ package.response() = odr.create_initResponse(
+ apdu,
+ YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
+ "z3950_client: No virtal host given");
+
+ package.session().close();
+ return 0;
+ }
+ }
+ else if (no_vhosts > 1)
+ {
+ mp::odr odr;
+ package.response() = odr.create_initResponse(
+ apdu,
+ YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP,
+ "z3950_client: Can not cope with multiple vhosts");
+ package.session().close();
+ return 0;
+ }
+ }
+
+ std::list<std::string> dblist;
+ mp::util::split_zurl(target, host, dblist);
+
+ if (dblist.size())
+ {
+ ; // z3950_client: Databases in vhost ignored
+ }
+
+ // see if we have reached max number of clients (max-sockets)
+
+ while (max_sockets)
{
- ODR odr = odr_createmem(ODR_ENCODE);
- Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
+ int number = 0;
+ it = m_clients.begin();
+ for (; it != m_clients.end(); it++)
+ {
+ yf::Z3950Client::Assoc *as = it->second;
+ if (!strcmp(as->get_hostname(), host.c_str()))
+ number++;
+ }
+ yaz_log(YLOG_LOG, "Found %d connections for %s", number, host.c_str());
+ if (number < max_sockets)
+ break;
+ boost::xtime xt;
+ xtime_get(&xt, boost::TIME_UTC);
- apdu->u.initResponse->userInformationField =
- zget_init_diagnostics(odr,
- YAZ_BIB1_INIT_NEGOTIATION_OPTION_REQUIRED,
- "Virtual host not given");
- package.response() = apdu;
+ xt.sec += 15;
+ if (!m_cond_session_ready.timed_wait(lock, xt))
+ {
+ mp::odr odr;
- package.session().close();
- odr_destroy(odr);
- return 0;
+ package.response() = odr.create_initResponse(
+ apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "max sessions");
+ package.session().close();
+ return 0;
+ }
}
-
+
yazpp_1::SocketManager *sm = new yazpp_1::SocketManager;
yazpp_1::PDU_Assoc *pdu_as = new yazpp_1::PDU_Assoc(sm);
- yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(package.session(),
- sm, pdu_as,
- vhost);
- m_clients.push_back(as);
+ yf::Z3950Client::Assoc *as = new yf::Z3950Client::Assoc(sm, pdu_as,
+ host.c_str(),
+ m_timeout_sec);
+ m_clients[package.session()] = as;
return as;
}
-void yf::Z3950Client::Pimpl::send_and_receive(Package &package,
- yf::Z3950Client::Assoc *c)
+void yf::Z3950Client::Rep::send_and_receive(Package &package,
+ yf::Z3950Client::Assoc *c)
{
Z_GDU *gdu = package.request().get();
- if (!gdu || gdu->which != Z_GDU_Z3950)
+ if (c->m_destroyed)
return;
- // we should lock c!
+ if (!gdu || gdu->which != Z_GDU_Z3950)
+ return;
+ c->m_time_elapsed = 0;
c->m_package = &package;
c->m_waiting = true;
if (!c->m_connected)
{
c->client(c->m_host.c_str());
+ c->timeout(1); // so timeoutNotify gets called once per second
- while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
+ while (!c->m_destroyed && c->m_waiting
+ && c->m_socket_manager->processEvent() > 0)
;
}
if (!c->m_connected)
}
// prepare response
+ c->m_time_elapsed = 0;
c->m_waiting = true;
// relay the package ..
int len;
c->send_GDU(gdu, &len);
-
- while (c->m_waiting && c->m_socket_manager->processEvent() > 0)
- ;
+
+ switch(gdu->u.z3950->which)
+ {
+ case Z_APDU_triggerResourceControlRequest:
+ // request only..
+ break;
+ default:
+ // for the rest: wait for a response PDU
+ while (!c->m_destroyed && c->m_waiting
+ && c->m_socket_manager->processEvent() > 0)
+ ;
+ break;
+ }
}
-void yf::Z3950Client::Pimpl::release_assoc(Package &package,
- yf::Z3950Client::Assoc *c)
+void yf::Z3950Client::Rep::release_assoc(Package &package)
{
- if (package.session().is_closed())
+ boost::mutex::scoped_lock lock(m_mutex);
+ std::map<mp::Session,yf::Z3950Client::Assoc *>::iterator it;
+
+ it = m_clients.find(package.session());
+ if (it != m_clients.end())
{
- boost::mutex::scoped_lock lock(m_mutex);
- std::list<yf::Z3950Client::Assoc *>::iterator it;
-
- for (it = m_clients.begin(); it != m_clients.end(); it++)
- {
- if ((*it)->m_session_id == package.session())
- break;
+ Z_GDU *gdu = package.request().get();
+ if (gdu && gdu->which == Z_GDU_Z3950)
+ { // only Z39.50 packages lock in get_assoc.. release it
+ it->second->m_in_use = false;
+ it->second->m_queue_len--;
}
- if (it != m_clients.end())
+
+ if (package.session().is_closed())
{
- // the Z_Assoc and PDU_Assoc must be destroyed before
- // the socket manager.. so pull that out.. first..
- yazpp_1::SocketManager *s = (*it)->m_socket_manager;
- delete *it; // destroy Z_Assoc
- delete s; // then manager
- m_clients.erase(it);
+ // destroy hint (send_and_receive)
+ it->second->m_destroyed = true;
+ if (it->second->m_queue_len == 0)
+ {
+ yazpp_1::SocketManager *s = it->second->m_socket_manager;
+ delete it->second; // destroy Z_Assoc
+ delete s; // then manager
+ m_clients.erase(it);
+ }
}
+ m_cond_session_ready.notify_all();
}
}
if (c)
{
m_p->send_and_receive(package, c);
- m_p->release_assoc(package, c);
}
+ m_p->release_assoc(package);
}
+void yf::Z3950Client::configure(const xmlNode *ptr, bool test_only)
+{
+ for (ptr = ptr->children; ptr; ptr = ptr->next)
+ {
+ if (ptr->type != XML_ELEMENT_NODE)
+ continue;
+ if (!strcmp((const char *) ptr->name, "timeout"))
+ {
+ m_p->m_timeout_sec = mp::xml::get_int(ptr->children, 30);
+ }
+ else if (!strcmp((const char *) ptr->name, "default_target"))
+ {
+ m_p->m_default_target = mp::xml::get_text(ptr);
+ }
+ else if (!strcmp((const char *) ptr->name, "force_target"))
+ {
+ m_p->m_force_target = mp::xml::get_text(ptr);
+ }
+ else if (!strcmp((const char *) ptr->name, "max-sockets"))
+ {
+ m_p->m_max_sockets = mp::xml::get_int(ptr->children, 0);
+ }
+ else
+ {
+ throw mp::filter::FilterException("Bad element "
+ + std::string((const char *)
+ ptr->name));
+ }
+ }
+}
+
+static mp::filter::Base* filter_creator()
+{
+ return new mp::filter::Z3950Client;
+}
+
+extern "C" {
+ struct metaproxy_1_filter_struct metaproxy_1_filter_z3950_client = {
+ 0,
+ "z3950_client",
+ filter_creator
+ };
+}
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
- * c-file-style: "stroustrup"
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+