-/* $Id: filter_session_shared.cpp,v 1.3 2006-01-04 11:19:04 adam Exp $
- Copyright (c) 2005, Index Data.
+/* This file is part of Metaproxy.
+ Copyright (C) 2005-2012 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 <metaproxy/filter.hpp>
+#include <metaproxy/package.hpp>
#include <boost/thread/mutex.hpp>
+#include <boost/thread/condition.hpp>
+#include <boost/thread/thread.hpp>
+#include <boost/thread/xtime.hpp>
#include <boost/shared_ptr.hpp>
+#include <boost/format.hpp>
-#include "util.hpp"
+#include <metaproxy/util.hpp>
#include "filter_session_shared.hpp"
#include <yaz/log.h>
#include <yaz/zgdu.h>
#include <yaz/otherinfo.h>
#include <yaz/diagbib1.h>
-
+#include <yazpp/z-query.h>
+#include <yazpp/record-cache.h>
#include <map>
#include <iostream>
+#include <time.h>
+
+namespace mp = metaproxy_1;
+namespace yf = metaproxy_1::filter;
-namespace yf = yp2::filter;
+namespace metaproxy_1 {
-namespace yp2 {
namespace filter {
- class SessionShared::Rep {
- friend class SessionShared;
- void handle_init(Z_InitRequest *req, Package &package);
- void handle_search(Z_SearchRequest *req, Package &package);
+ // key for session.. We'll only share sessions with same InitKey
+ class SessionShared::InitKey {
public:
- typedef boost::shared_ptr<SessionShared::List> SharedList;
-
- typedef std::map<SessionShared::InitKey,SharedList> InitListMap;
- InitListMap m_init_list_map;
+ bool operator < (const SessionShared::InitKey &k) const;
+ InitKey(Z_InitRequest *req);
+ InitKey(const InitKey &);
+ ~InitKey();
+ private:
+ char *m_idAuthentication_buf;
+ int m_idAuthentication_size;
+ char *m_otherInfo_buf;
+ int m_otherInfo_size;
+ ODR m_odr;
+ };
+ // worker thread .. for expiry of sessions
+ class SessionShared::Worker {
+ public:
+ Worker(SessionShared::Rep *rep);
+ void operator() (void);
+ private:
+ SessionShared::Rep *m_p;
+ };
+ // backend result set
+ class SessionShared::BackendSet {
+ public:
+ std::string m_result_set_id;
+ Databases m_databases;
+ Odr_int m_result_set_size;
+ yazpp_1::Yaz_Z_Query m_query;
+ time_t m_time_last_use;
+ void timestamp();
+ yazpp_1::RecordCache m_record_cache;
+ BackendSet(
+ const std::string &result_set_id,
+ const Databases &databases,
+ const yazpp_1::Yaz_Z_Query &query);
+ bool search(
+ Package &frontend_package,
+ Package &search_package,
+ const Z_APDU *apdu_req,
+ const BackendInstancePtr bp,
+ Z_Records **z_records);
+ };
+ // backend connection instance
+ class SessionShared::BackendInstance {
+ friend class Rep;
+ friend class BackendClass;
+ friend class BackendSet;
+ public:
+ mp::Session m_session;
+ BackendSetList m_sets;
+ bool m_in_use;
+ int m_sequence_this;
+ int m_result_set_sequence;
+ time_t m_time_last_use;
+ mp::Package * m_close_package;
+ ~BackendInstance();
+ void timestamp();
+ };
+ // backends of some class (all with same InitKey)
+ class SessionShared::BackendClass : boost::noncopyable {
+ friend class Rep;
+ friend struct Frontend;
+ bool m_named_result_sets;
+ BackendInstanceList m_backend_list;
+ BackendInstancePtr create_backend(const Package &package);
+ void remove_backend(BackendInstancePtr b);
+ BackendInstancePtr get_backend(const Package &package);
+ void use_backend(BackendInstancePtr b);
+ void release_backend(BackendInstancePtr b);
+ void expire_class();
+ yazpp_1::GDU m_init_request;
+ yazpp_1::GDU m_init_response;
+ boost::mutex m_mutex_backend_class;
+ int m_sequence_top;
+ time_t m_backend_set_ttl;
+ time_t m_backend_expiry_ttl;
+ size_t m_backend_set_max;
+ public:
+ BackendClass(const yazpp_1::GDU &init_request,
+ int resultset_ttl,
+ int resultset_max,
+ int session_ttl);
+ ~BackendClass();
+ };
+ // frontend result set
+ class SessionShared::FrontendSet {
+ Databases m_databases;
+ yazpp_1::Yaz_Z_Query m_query;
+ public:
+ const Databases &get_databases();
+ const yazpp_1::Yaz_Z_Query &get_query();
+ FrontendSet(
+ const Databases &databases,
+ const yazpp_1::Yaz_Z_Query &query);
+ FrontendSet();
+ };
+ // frontend session
+ struct SessionShared::Frontend {
+ Frontend(Rep *rep);
+ ~Frontend();
+ bool m_is_virtual;
+ bool m_in_use;
+ Z_Options m_init_options;
+ void search(Package &package, Z_APDU *apdu);
+ void present(Package &package, Z_APDU *apdu);
+ void scan(Package &package, Z_APDU *apdu);
- typedef std::map<Session,SharedList> SessionListMap;
- SessionListMap m_session_list_map;
+ void get_set(mp::Package &package,
+ const Z_APDU *apdu_req,
+ const Databases &databases,
+ yazpp_1::Yaz_Z_Query &query,
+ BackendInstancePtr &found_backend,
+ BackendSetPtr &found_set);
+ void override_set(BackendInstancePtr &found_backend,
+ std::string &result_set_id,
+ const Databases &databases,
+ bool out_of_sessions);
+ Rep *m_p;
+ BackendClassPtr m_backend_class;
+ FrontendSets m_frontend_sets;
};
- class SessionShared::InitKey {
+ // representation
+ class SessionShared::Rep {
friend class SessionShared;
- friend class SessionShared::Rep;
- std::string m_vhost;
- std::string m_open;
- std::string m_user;
- std::string m_group;
- std::string m_password;
- public:
- bool operator < (const SessionShared::InitKey &k) const;
- };
- class SessionShared::List {
+ friend struct Frontend;
+
+ FrontendPtr get_frontend(Package &package);
+ void release_frontend(Package &package);
+ Rep();
public:
- yazpp_1::GDU m_init_response; // init response for backend
- Session m_session; // session for backend
+ void expire();
+ private:
+ void init(Package &package, const Z_GDU *gdu,
+ FrontendPtr frontend);
+ void start();
+ boost::mutex m_mutex;
+ boost::condition m_cond_session_ready;
+ std::map<mp::Session, FrontendPtr> m_clients;
+
+ BackendClassMap m_backend_map;
+ boost::mutex m_mutex_backend_map;
+ boost::thread_group m_thrds;
+ int m_resultset_ttl;
+ int m_resultset_max;
+ int m_session_ttl;
+ bool m_optimize_search;
+ bool m_restart;
+ int m_session_max;
};
}
-
}
+yf::SessionShared::FrontendSet::FrontendSet(
+ const Databases &databases,
+ const yazpp_1::Yaz_Z_Query &query)
+ : m_databases(databases), m_query(query)
+{
+}
-using namespace yp2;
+const yf::SessionShared::Databases &
+yf::SessionShared::FrontendSet::get_databases()
+{
+ return m_databases;
+}
-bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey
- &k) const
+const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
{
- if (m_vhost < k.m_vhost)
- return true;
- else if (m_vhost < k.m_vhost)
- return false;
+ return m_query;
+}
- if (m_open < k.m_open)
- return true;
- else if (m_open > k.m_open)
- return false;
+yf::SessionShared::InitKey::InitKey(const InitKey &k)
+{
+ m_odr = odr_createmem(ODR_ENCODE);
- if (m_user < k.m_user)
- return true;
- else if (m_user > k.m_user)
- return false;
-
- if (m_group < k.m_group)
+ m_idAuthentication_size = k.m_idAuthentication_size;
+ m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
+ memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
+ m_idAuthentication_size);
+
+ m_otherInfo_size = k.m_otherInfo_size;
+ m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
+ memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
+ m_otherInfo_size);
+}
+
+yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
+{
+ m_odr = odr_createmem(ODR_ENCODE);
+
+ Z_IdAuthentication *t = req->idAuthentication;
+ z_IdAuthentication(m_odr, &t, 1, 0);
+ m_idAuthentication_buf =
+ odr_getbuf(m_odr, &m_idAuthentication_size, 0);
+
+ Z_OtherInformation *o = req->otherInfo;
+ z_OtherInformation(m_odr, &o, 1, 0);
+ m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
+}
+
+yf::SessionShared::InitKey::~InitKey()
+{
+ odr_destroy(m_odr);
+}
+
+bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
+ const
+{
+ int c;
+ c = mp::util::memcmp2(
+ (void*) m_idAuthentication_buf, m_idAuthentication_size,
+ (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
+ if (c < 0)
return true;
- else if (m_group > k.m_group)
+ else if (c > 0)
return false;
- if (m_password < k.m_password)
+ c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
+ (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
+ if (c < 0)
return true;
- else if (m_password > k.m_password)
+ else if (c > 0)
return false;
return false;
}
-yf::SessionShared::SessionShared() : m_p(new Rep)
+void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
{
+ boost::mutex::scoped_lock lock(m_mutex_backend_class);
+ b->m_in_use = false;
}
-yf::SessionShared::~SessionShared()
+
+void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
{
+ BackendInstanceList::iterator it = m_backend_list.begin();
+
+ while (it != m_backend_list.end())
+ {
+ if (*it == b)
+ {
+ mp::odr odr;
+ (*it)->m_close_package->response() = odr.create_close(
+ 0, Z_Close_lackOfActivity, 0);
+ (*it)->m_close_package->session().close();
+ (*it)->m_close_package->move();
+
+ it = m_backend_list.erase(it);
+ }
+ else
+ it++;
+ }
+}
+
+
+
+yf::SessionShared::BackendInstancePtr
+yf::SessionShared::BackendClass::get_backend(
+ const mp::Package &frontend_package)
+{
+ {
+ boost::mutex::scoped_lock lock(m_mutex_backend_class);
+
+ BackendInstanceList::const_iterator it = m_backend_list.begin();
+
+ BackendInstancePtr backend1; // null
+
+ for (; it != m_backend_list.end(); it++)
+ {
+ if (!(*it)->m_in_use)
+ {
+ if (!backend1
+ || (*it)->m_sequence_this < backend1->m_sequence_this)
+ backend1 = *it;
+ }
+ }
+ if (backend1)
+ {
+ use_backend(backend1);
+ return backend1;
+ }
+ }
+ return create_backend(frontend_package);
+}
+
+void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
+{
+ backend->m_in_use = true;
+ backend->m_sequence_this = m_sequence_top++;
+}
+
+void yf::SessionShared::BackendInstance::timestamp()
+{
+ assert(m_in_use);
+ time(&m_time_last_use);
+}
+
+yf::SessionShared::BackendInstance::~BackendInstance()
+{
+ delete m_close_package;
+}
+
+yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
+ const mp::Package &frontend_package)
+{
+ BackendInstancePtr bp(new BackendInstance);
+ BackendInstancePtr null;
+
+ bp->m_close_package =
+ new mp::Package(bp->m_session, frontend_package.origin());
+ bp->m_close_package->copy_filter(frontend_package);
+
+ Package init_package(bp->m_session, frontend_package.origin());
+
+ init_package.copy_filter(frontend_package);
+
+ yazpp_1::GDU actual_init_request = m_init_request;
+ Z_GDU *init_pdu = actual_init_request.get();
+
+ assert(init_pdu->which == Z_GDU_Z3950);
+ assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
+
+ Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
+ ODR_MASK_ZERO(req->options);
+
+ ODR_MASK_SET(req->options, Z_Options_search);
+ ODR_MASK_SET(req->options, Z_Options_present);
+ ODR_MASK_SET(req->options, Z_Options_namedResultSets);
+ ODR_MASK_SET(req->options, Z_Options_scan);
+
+ ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
+ ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
+ ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
+
+ init_package.request() = init_pdu;
+
+ init_package.move();
+
+ boost::mutex::scoped_lock lock(m_mutex_backend_class);
+
+ m_named_result_sets = false;
+ Z_GDU *gdu = init_package.response().get();
+
+ if (gdu && gdu->which == Z_GDU_Z3950
+ && gdu->u.z3950->which == Z_APDU_initResponse)
+ {
+ Z_InitResponse *res = gdu->u.z3950->u.initResponse;
+ m_init_response = gdu->u.z3950;
+ if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
+ {
+ m_named_result_sets = true;
+ }
+ if (*gdu->u.z3950->u.initResponse->result
+ && !init_package.session().is_closed())
+ {
+ bp->m_in_use = true;
+ time(&bp->m_time_last_use);
+ bp->m_sequence_this = 0;
+ bp->m_result_set_sequence = 0;
+ m_backend_list.push_back(bp);
+ return bp;
+ }
+ }
+ else
+ {
+ yazpp_1::GDU empty_gdu;
+ m_init_response = empty_gdu;
+ }
+
+ if (!init_package.session().is_closed())
+ {
+ init_package.copy_filter(frontend_package);
+ init_package.session().close();
+ init_package.move();
+ }
+ return null;
}
-void yf::SessionShared::Rep::handle_search(Z_SearchRequest *req,
- Package &package)
+
+yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
+ int resultset_ttl,
+ int resultset_max,
+ int session_ttl)
+ : m_named_result_sets(false), m_init_request(init_request),
+ m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
+ m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max)
+{}
+
+yf::SessionShared::BackendClass::~BackendClass()
+{}
+
+void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
+ FrontendPtr frontend)
{
- yaz_log(YLOG_LOG, "Got search");
+ Z_InitRequest *req = gdu->u.z3950->u.initRequest;
- SessionListMap::iterator it = m_session_list_map.find(package.session());
- if (it == m_session_list_map.end())
+ frontend->m_is_virtual = true;
+ frontend->m_init_options = *req->options;
+ InitKey k(req);
{
- yp2::odr odr;
- package.response() = odr.create_close(
- Z_Close_protocolError,
- "no session for search request in session_shared");
+ boost::mutex::scoped_lock lock(m_mutex_backend_map);
+ BackendClassMap::const_iterator it;
+ it = m_backend_map.find(k);
+ if (it == m_backend_map.end())
+ {
+ BackendClassPtr b(new BackendClass(gdu->u.z3950,
+ m_resultset_ttl,
+ m_resultset_max,
+ m_session_ttl));
+ m_backend_map[k] = b;
+ frontend->m_backend_class = b;
+ }
+ else
+ {
+ frontend->m_backend_class = it->second;
+ }
+ }
+ BackendClassPtr bc = frontend->m_backend_class;
+ mp::odr odr;
+
+ // we only need to get init response from "first" target in
+ // backend class - the assumption being that init response is
+ // same for all
+ if (bc->m_backend_list.size() == 0)
+ {
+ BackendInstancePtr backend = bc->create_backend(package);
+
+ if (backend)
+ bc->release_backend(backend);
+ }
+
+ yazpp_1::GDU init_response;
+ {
+ boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
+
+ init_response = bc->m_init_response;
+ }
+
+ if (init_response.get())
+ {
+ Z_GDU *response_gdu = init_response.get();
+ mp::util::transfer_referenceId(odr, gdu->u.z3950,
+ response_gdu->u.z3950);
+ Z_Options *server_options =
+ response_gdu->u.z3950->u.initResponse->options;
+ Z_Options *client_options = &frontend->m_init_options;
+ int i;
+ for (i = 0; i < 30; i++)
+ if (!ODR_MASK_GET(client_options, i))
+ ODR_MASK_CLEAR(server_options, i);
+ package.response() = init_response;
+ if (!*response_gdu->u.z3950->u.initResponse->result)
+ package.session().close();
+ }
+ else
+ {
+ Z_APDU *apdu =
+ odr.create_initResponse(
+ gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
+ "session_shared: target closed connection during init");
+ *apdu->u.initResponse->result = 0;
+ package.response() = apdu;
package.session().close();
-
- return;
}
- Package search_package(it->second->m_session, package.origin());
- search_package.copy_filter(package);
- search_package.request() = package.request();
-
- search_package.move();
-
- // transfer to frontend
- package.response() = search_package.response();
}
-void yf::SessionShared::Rep::handle_init(Z_InitRequest *req, Package &package)
+void yf::SessionShared::BackendSet::timestamp()
+{
+ time(&m_time_last_use);
+}
+
+yf::SessionShared::BackendSet::BackendSet(
+ const std::string &result_set_id,
+ const Databases &databases,
+ const yazpp_1::Yaz_Z_Query &query) :
+ m_result_set_id(result_set_id),
+ m_databases(databases), m_result_set_size(0), m_query(query)
+{
+ timestamp();
+}
+
+static int get_diagnostic(Z_DefaultDiagFormat *r)
+{
+ return *r->condition;
+}
+
+bool yf::SessionShared::BackendSet::search(
+ mp::Package &frontend_package,
+ mp::Package &search_package,
+ const Z_APDU *frontend_apdu,
+ const BackendInstancePtr bp,
+ Z_Records **z_records)
{
- yaz_log(YLOG_LOG, "Got init");
+ mp::odr odr;
+ Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
+ Z_SearchRequest *req = apdu_req->u.searchRequest;
+
+ req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
+ req->query = m_query.get_Z_Query();
- SessionShared::InitKey key;
- const char *vhost =
- yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
- if (vhost)
- key.m_vhost = vhost;
+ req->num_databaseNames = m_databases.size();
+ req->databaseNames = (char**)
+ odr_malloc(odr, req->num_databaseNames * sizeof(char *));
+ Databases::const_iterator it = m_databases.begin();
+ size_t i = 0;
+ for (; it != m_databases.end(); it++)
+ req->databaseNames[i++] = odr_strdup(odr, it->c_str());
- if (!req->idAuthentication)
+ if (frontend_apdu->which == Z_APDU_searchRequest)
+ req->preferredRecordSyntax =
+ frontend_apdu->u.searchRequest->preferredRecordSyntax;
+
+ search_package.request() = apdu_req;
+
+ search_package.move();
+
+ Z_GDU *gdu = search_package.response().get();
+ if (!search_package.session().is_closed()
+ && gdu && gdu->which == Z_GDU_Z3950
+ && gdu->u.z3950->which == Z_APDU_searchResponse)
{
- yaz_log(YLOG_LOG, "No authentication");
+ Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
+ *z_records = b_resp->records;
+ m_result_set_size = *b_resp->resultCount;
+ return true;
}
+ Z_APDU *f_apdu = 0;
+ const char *addinfo = "session_shared: "
+ "target closed connection during search";
+ if (frontend_apdu->which == Z_APDU_searchRequest)
+ f_apdu = odr.create_searchResponse(
+ frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
+ else if (frontend_apdu->which == Z_APDU_presentRequest)
+ f_apdu = odr.create_presentResponse(
+ frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
else
+ f_apdu = odr.create_close(
+ frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
+ frontend_package.response() = f_apdu;
+ return false;
+}
+
+void yf::SessionShared::Frontend::override_set(
+ BackendInstancePtr &found_backend,
+ std::string &result_set_id,
+ const Databases &databases,
+ bool out_of_sessions)
+{
+ BackendClassPtr bc = m_backend_class;
+ BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
+ time_t now;
+ time(&now);
+
+ size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
+ for (; it != bc->m_backend_list.end(); it++)
{
- Z_IdAuthentication *auth = req->idAuthentication;
- switch(auth->which)
+ if (!(*it)->m_in_use)
{
- case Z_IdAuthentication_open:
- yaz_log(YLOG_LOG, "open auth open=%s", auth->u.open);
- key.m_open = auth->u.open;
- break;
- case Z_IdAuthentication_idPass:
- yaz_log(YLOG_LOG, "idPass user=%s group=%s pass=%s",
- auth->u.idPass->userId, auth->u.idPass->groupId,
- auth->u.idPass->password);
- if (auth->u.idPass->userId)
- key.m_user = auth->u.idPass->userId;
- if (auth->u.idPass->groupId)
- key.m_group = auth->u.idPass->groupId;
- if (auth->u.idPass->password)
- key.m_password = auth->u.idPass->password;
- break;
- case Z_IdAuthentication_anonymous:
- yaz_log(YLOG_LOG, "anonymous");
- break;
- default:
- yaz_log(YLOG_LOG, "other");
- }
+ BackendSetList::iterator set_it = (*it)->m_sets.begin();
+ for (; set_it != (*it)->m_sets.end(); set_it++)
+ {
+ if ((max_sets > 1 || (*set_it)->m_databases == databases)
+ &&
+ (out_of_sessions ||
+ now < (*set_it)->m_time_last_use ||
+ now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
+ {
+ found_backend = *it;
+ result_set_id = (*set_it)->m_result_set_id;
+ found_backend->m_sets.erase(set_it);
+ return;
+ }
+ }
+ }
}
- InitListMap::iterator it = m_init_list_map.find(key);
- if (it == m_init_list_map.end())
+ for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
{
- yaz_log(YLOG_LOG, "New KEY");
+ if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
+ {
+ found_backend = *it;
+ if (bc->m_named_result_sets)
+ {
+ result_set_id = boost::io::str(
+ boost::format("%1%") %
+ found_backend->m_result_set_sequence);
+ found_backend->m_result_set_sequence++;
+ }
+ else
+ result_set_id = "default";
+ return;
+ }
+ }
+}
- // building new package with original init and new session
- SharedList l(new SessionShared::List); // new session for backend
+void yf::SessionShared::Frontend::get_set(mp::Package &package,
+ const Z_APDU *apdu_req,
+ const Databases &databases,
+ yazpp_1::Yaz_Z_Query &query,
+ BackendInstancePtr &found_backend,
+ BackendSetPtr &found_set)
+{
+ bool session_restarted = false;
- Package init_package(l->m_session, package.origin());
- init_package.copy_filter(package);
- init_package.request() = package.request();
+restart:
+ std::string result_set_id;
+ bool out_of_sessions = false;
+ BackendClassPtr bc = m_backend_class;
+ {
+ boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
- init_package.move();
-
- // transfer to frontend
- package.response() = init_package.response();
-
- // check that we really got Z39.50 Init Response
- Z_GDU *gdu = init_package.response().get();
- if (gdu && gdu->which == Z_GDU_Z3950
- && gdu->u.z3950->which == Z_APDU_initResponse)
+ if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
+ out_of_sessions = true;
+
+ if (m_p->m_optimize_search)
{
- // save the init response
- l->m_init_response = init_package.response();
-
- // save session and init response for later
- m_init_list_map[key] = l;
+ // look at each backend and see if we have a similar search
+ BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
+ for (; it != bc->m_backend_list.end(); it++)
+ {
+ if (!(*it)->m_in_use)
+ {
+ BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
+ for (; set_it != (*it)->m_sets.end(); set_it++)
+ {
+ if ((*set_it)->m_databases == databases
+ && query.match(&(*set_it)->m_query))
+ {
+ found_set = *set_it;
+ found_backend = *it;
+ bc->use_backend(found_backend);
+ // found matching set. No need to search again
+ return;
+ }
+ }
+ }
+ }
+ }
+ override_set(found_backend, result_set_id, databases, out_of_sessions);
+ if (found_backend)
+ bc->use_backend(found_backend);
+ }
+ if (!found_backend)
+ {
+ // create a new backend set (and new set) if we're not out of sessions
+ if (!out_of_sessions)
+ found_backend = bc->create_backend(package);
- m_session_list_map[package.session()] = l;
+ if (!found_backend)
+ {
+ Z_APDU *f_apdu = 0;
+ mp::odr odr;
+ const char *addinfo = 0;
+
+ if (out_of_sessions)
+ addinfo = "session_shared: all sessions in use";
+ else
+ addinfo = "session_shared: could not create backend";
+ if (apdu_req->which == Z_APDU_searchRequest)
+ {
+ f_apdu = odr.create_searchResponse(
+ apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
+ }
+ else if (apdu_req->which == Z_APDU_presentRequest)
+ {
+ f_apdu = odr.create_presentResponse(
+ apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
+ }
+ else
+ {
+ f_apdu = odr.create_close(
+ apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
+ }
+ package.response() = f_apdu;
+ return;
}
+ if (bc->m_named_result_sets)
+ {
+ result_set_id = boost::io::str(
+ boost::format("%1%") % found_backend->m_result_set_sequence);
+ found_backend->m_result_set_sequence++;
+ }
+ else
+ result_set_id = "default";
}
- else
+ found_backend->timestamp();
+
+ // we must search ...
+ BackendSetPtr new_set(new BackendSet(result_set_id,
+ databases, query));
+ Z_Records *z_records = 0;
+
+ Package search_package(found_backend->m_session, package.origin());
+ search_package.copy_filter(package);
+
+ if (!new_set->search(package, search_package,
+ apdu_req, found_backend, &z_records))
+ {
+ bc->remove_backend(found_backend);
+ return; // search error
+ }
+
+ if (z_records)
{
- yaz_log(YLOG_LOG, "Existing KEY");
- package.response() = it->second->m_init_response;
+ int condition = 0;
+ if (z_records->which == Z_Records_NSD)
+ {
+ condition =
+ get_diagnostic(z_records->u.nonSurrogateDiagnostic);
+ }
+ else if (z_records->which == Z_Records_multipleNSD)
+ {
+ if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
+ &&
+
+ z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
+ Z_DiagRec_defaultFormat)
+ {
+ condition = get_diagnostic(
+ z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
+
+ }
+ }
+ if (m_p->m_restart && !session_restarted &&
+ condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
+ {
+ package.log("session_shared", YLOG_LOG, "restart");
+ bc->remove_backend(found_backend);
+ session_restarted = true;
+ found_backend.reset();
+ goto restart;
- m_session_list_map[package.session()] = it->second;
+ }
+
+ if (condition)
+ {
+ mp::odr odr;
+ if (apdu_req->which == Z_APDU_searchRequest)
+ {
+ Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
+ 0, 0);
+ Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
+ *f_resp->searchStatus = Z_SearchResponse_none;
+ f_resp->records = z_records;
+ package.response() = f_apdu;
+ }
+ if (apdu_req->which == Z_APDU_presentRequest)
+ {
+ Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
+ 0, 0);
+ Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
+ f_resp->records = z_records;
+ package.response() = f_apdu;
+ }
+ bc->release_backend(found_backend);
+ return; // search error
+ }
}
+ if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
+ {
+ package.log("session_shared", YLOG_LOG, "restart");
+ bc->remove_backend(found_backend);
+ session_restarted = true;
+ found_backend.reset();
+ goto restart;
+ }
+
+ found_set = new_set;
+ found_set->timestamp();
+ found_backend->m_sets.push_back(found_set);
}
-void yf::SessionShared::process(Package &package) const
+void yf::SessionShared::Frontend::search(mp::Package &package,
+ Z_APDU *apdu_req)
{
- // don't tell the backend if the "fronent" filter closes..
- // we want to keep them alive
- if (package.session().is_closed())
+ Z_SearchRequest *req = apdu_req->u.searchRequest;
+ FrontendSets::iterator fset_it =
+ m_frontend_sets.find(req->resultSetName);
+ if (fset_it != m_frontend_sets.end())
{
- m_p->m_session_list_map.erase(package.session());
+ // result set already exist
+ // if replace indicator is off: we return diagnostic if
+ // result set already exist.
+ if (*req->replaceIndicator == 0)
+ {
+ mp::odr odr;
+ Z_APDU *apdu =
+ odr.create_searchResponse(
+ apdu_req,
+ YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
+ 0);
+ package.response() = apdu;
+
+ return;
+ }
+ m_frontend_sets.erase(fset_it);
+ }
+
+ yazpp_1::Yaz_Z_Query query;
+ query.set_Z_Query(req->query);
+ Databases databases;
+ int i;
+ for (i = 0; i < req->num_databaseNames; i++)
+ databases.push_back(req->databaseNames[i]);
+
+ BackendSetPtr found_set; // null
+ BackendInstancePtr found_backend; // null
+
+ get_set(package, apdu_req, databases, query, found_backend, found_set);
+ if (!found_set)
+ return;
+
+ mp::odr odr;
+ Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
+ Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
+ *f_resp->resultCount = found_set->m_result_set_size;
+ package.response() = f_apdu;
+
+ FrontendSetPtr fset(new FrontendSet(databases, query));
+ m_frontend_sets[req->resultSetName] = fset;
+
+ m_backend_class->release_backend(found_backend);
+}
+
+void yf::SessionShared::Frontend::present(mp::Package &package,
+ Z_APDU *apdu_req)
+{
+ mp::odr odr;
+ Z_PresentRequest *req = apdu_req->u.presentRequest;
+
+ FrontendSets::iterator fset_it =
+ m_frontend_sets.find(req->resultSetId);
+
+ if (fset_it == m_frontend_sets.end())
+ {
+ Z_APDU *apdu =
+ odr.create_presentResponse(
+ apdu_req,
+ YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
+ req->resultSetId);
+ package.response() = apdu;
return;
}
+ FrontendSetPtr fset = fset_it->second;
- Z_GDU *gdu = package.request().get();
+ Databases databases = fset->get_databases();
+ yazpp_1::Yaz_Z_Query query = fset->get_query();
+
+ BackendClassPtr bc = m_backend_class;
+ BackendSetPtr found_set; // null
+ BackendInstancePtr found_backend;
- if (gdu && gdu->which == Z_GDU_Z3950)
+ get_set(package, apdu_req, databases, query, found_backend, found_set);
+ if (!found_set)
+ return;
+
+ Z_NamePlusRecordList *npr_res = 0;
+ if (found_set->m_record_cache.lookup(odr, &npr_res,
+ *req->resultSetStartPoint,
+ *req->numberOfRecordsRequested,
+ req->preferredRecordSyntax,
+ req->recordComposition))
{
- Z_APDU *apdu = gdu->u.z3950;
+ Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
+ Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
+
+ yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
+ " records in cache %p",
+ *req->resultSetStartPoint,
+ *req->numberOfRecordsRequested,
+ &found_set->m_record_cache);
+
+ *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
+ *f_resp->nextResultSetPosition =
+ *req->resultSetStartPoint + *req->numberOfRecordsRequested;
+ // f_resp->presentStatus assumed OK.
+ f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
+ f_resp->records->which = Z_Records_DBOSD;
+ f_resp->records->u.databaseOrSurDiagnostics = npr_res;
+ package.response() = f_apdu_res;
+ bc->release_backend(found_backend);
+ return;
+ }
+
+ found_backend->timestamp();
- switch(apdu->which)
+ Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
+ Z_PresentRequest *p_req = p_apdu->u.presentRequest;
+ p_req->preferredRecordSyntax = req->preferredRecordSyntax;
+ p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
+ *p_req->resultSetStartPoint = *req->resultSetStartPoint;
+ *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
+ p_req->preferredRecordSyntax = req->preferredRecordSyntax;
+ p_req->recordComposition = req->recordComposition;
+
+ Package present_package(found_backend->m_session, package.origin());
+ present_package.copy_filter(package);
+
+ present_package.request() = p_apdu;
+
+ present_package.move();
+
+ Z_GDU *gdu = present_package.response().get();
+ if (!present_package.session().is_closed()
+ && gdu && gdu->which == Z_GDU_Z3950
+ && gdu->u.z3950->which == Z_APDU_presentResponse)
+ {
+ Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
+ Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
+ Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
+
+ f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
+ f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
+ f_resp->presentStatus= b_resp->presentStatus;
+ f_resp->records = b_resp->records;
+ f_resp->otherInfo = b_resp->otherInfo;
+ package.response() = f_apdu_res;
+
+ if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
{
- case Z_APDU_initRequest:
- m_p->handle_init(apdu->u.initRequest, package);
- break;
- case Z_APDU_searchRequest:
- m_p->handle_search(apdu->u.searchRequest, package);
+ yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
+ " records to cache %p",
+ *req->resultSetStartPoint,
+ *f_resp->numberOfRecordsReturned,
+ &found_set->m_record_cache);
+ found_set->m_record_cache.add(
+ odr,
+ b_resp->records->u.databaseOrSurDiagnostics,
+ *req->resultSetStartPoint,
+ *f_resp->numberOfRecordsReturned);
+ }
+ bc->release_backend(found_backend);
+ }
+ else
+ {
+ bc->remove_backend(found_backend);
+ Z_APDU *f_apdu_res =
+ odr.create_presentResponse(
+ apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
+ "session_shared: target closed connection during present");
+ package.response() = f_apdu_res;
+ }
+}
+
+void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
+ Z_APDU *apdu_req)
+{
+ BackendClassPtr bc = m_backend_class;
+ BackendInstancePtr backend = bc->get_backend(frontend_package);
+ if (!backend)
+ {
+ mp::odr odr;
+ Z_APDU *apdu = odr.create_scanResponse(
+ apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
+ frontend_package.response() = apdu;
+ }
+ else
+ {
+ Package scan_package(backend->m_session, frontend_package.origin());
+ backend->timestamp();
+ scan_package.copy_filter(frontend_package);
+ scan_package.request() = apdu_req;
+ scan_package.move();
+ frontend_package.response() = scan_package.response();
+ if (scan_package.session().is_closed())
+ {
+ frontend_package.session().close();
+ bc->remove_backend(backend);
+ }
+ else
+ bc->release_backend(backend);
+ }
+}
+
+yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
+{
+}
+
+void yf::SessionShared::Worker::operator() (void)
+{
+ m_p->expire();
+}
+
+void yf::SessionShared::BackendClass::expire_class()
+{
+ time_t now;
+ time(&now);
+ boost::mutex::scoped_lock lock(m_mutex_backend_class);
+ BackendInstanceList::iterator bit = m_backend_list.begin();
+ while (bit != m_backend_list.end())
+ {
+ time_t last_use = (*bit)->m_time_last_use;
+
+ if ((*bit)->m_in_use)
+ {
+ bit++;
+ }
+ else if (now < last_use || now - last_use > m_backend_expiry_ttl)
+ {
+ mp::odr odr;
+ (*bit)->m_close_package->response() = odr.create_close(
+ 0, Z_Close_lackOfActivity, 0);
+ (*bit)->m_close_package->session().close();
+ (*bit)->m_close_package->move();
+
+ bit = m_backend_list.erase(bit);
+ }
+ else
+ {
+ bit++;
+ }
+ }
+}
+
+void yf::SessionShared::Rep::expire()
+{
+ while (true)
+ {
+ boost::xtime xt;
+ boost::xtime_get(&xt, boost::TIME_UTC);
+ xt.sec += m_session_ttl / 3;
+ boost::thread::sleep(xt);
+
+ BackendClassMap::const_iterator b_it = m_backend_map.begin();
+ for (; b_it != m_backend_map.end(); b_it++)
+ b_it->second->expire_class();
+ }
+}
+
+yf::SessionShared::Rep::Rep()
+{
+ m_resultset_ttl = 30;
+ m_resultset_max = 10;
+ m_session_ttl = 90;
+ m_optimize_search = true;
+ m_restart = false;
+ m_session_max = 100;
+}
+
+void yf::SessionShared::Rep::start()
+{
+ yf::SessionShared::Worker w(this);
+ m_thrds.add_thread(new boost::thread(w));
+}
+
+yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
+{
+}
+
+yf::SessionShared::~SessionShared() {
+}
+
+void yf::SessionShared::start() const
+{
+ m_p->start();
+}
+
+yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
+{
+}
+
+yf::SessionShared::Frontend::~Frontend()
+{
+}
+
+yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
+{
+ boost::mutex::scoped_lock lock(m_mutex);
+
+ std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
+
+ while(true)
+ {
+ it = m_clients.find(package.session());
+ if (it == m_clients.end())
break;
- default:
- yp2::odr odr;
+
+ if (!it->second->m_in_use)
+ {
+ it->second->m_in_use = true;
+ return it->second;
+ }
+ m_cond_session_ready.wait(lock);
+ }
+ FrontendPtr f(new Frontend(this));
+ m_clients[package.session()] = f;
+ f->m_in_use = true;
+ return f;
+}
+
+void yf::SessionShared::Rep::release_frontend(mp::Package &package)
+{
+ boost::mutex::scoped_lock lock(m_mutex);
+ std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
+
+ it = m_clients.find(package.session());
+ if (it != m_clients.end())
+ {
+ if (package.session().is_closed())
+ {
+ m_clients.erase(it);
+ }
+ else
+ {
+ it->second->m_in_use = false;
+ }
+ m_cond_session_ready.notify_all();
+ }
+}
+
+
+void yf::SessionShared::process(mp::Package &package) const
+{
+ FrontendPtr f = m_p->get_frontend(package);
+
+ Z_GDU *gdu = package.request().get();
+
+ if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
+ Z_APDU_initRequest && !f->m_is_virtual)
+ {
+ m_p->init(package, gdu, f);
+ }
+ else if (!f->m_is_virtual)
+ package.move();
+ else if (gdu && gdu->which == Z_GDU_Z3950)
+ {
+ Z_APDU *apdu = gdu->u.z3950;
+ if (apdu->which == Z_APDU_initRequest)
+ {
+ mp::odr odr;
+
package.response() = odr.create_close(
+ apdu,
Z_Close_protocolError,
- "cannot handle a package of this type");
+ "double init");
+
package.session().close();
- break;
-
}
- if (package.session().is_closed()) {
- m_p->m_session_list_map.erase(package.session());
+ else if (apdu->which == Z_APDU_close)
+ {
+ mp::odr odr;
+
+ package.response() = odr.create_close(
+ apdu,
+ Z_Close_peerAbort, "received close from client");
+ package.session().close();
+ }
+ else if (apdu->which == Z_APDU_searchRequest)
+ {
+ f->search(package, apdu);
+ }
+ else if (apdu->which == Z_APDU_presentRequest)
+ {
+ f->present(package, apdu);
+ }
+ else if (apdu->which == Z_APDU_scanRequest)
+ {
+ f->scan(package, apdu);
+ }
+ else
+ {
+ mp::odr odr;
+
+ package.response() = odr.create_close(
+ apdu, Z_Close_protocolError,
+ "unsupported APDU in filter_session_shared");
+
+ package.session().close();
+ }
+ }
+ m_p->release_frontend(package);
+}
+
+void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
+ const char *path)
+{
+ for (ptr = ptr->children; ptr; ptr = ptr->next)
+ {
+ if (ptr->type != XML_ELEMENT_NODE)
+ continue;
+ if (!strcmp((const char *) ptr->name, "resultset"))
+ {
+ const struct _xmlAttr *attr;
+ for (attr = ptr->properties; attr; attr = attr->next)
+ {
+ if (!strcmp((const char *) attr->name, "ttl"))
+ m_p->m_resultset_ttl =
+ mp::xml::get_int(attr->children, 30);
+ else if (!strcmp((const char *) attr->name, "max"))
+ {
+ m_p->m_resultset_max =
+ mp::xml::get_int(attr->children, 10);
+ }
+ else if (!strcmp((const char *) attr->name, "optimizesearch"))
+ {
+ m_p->m_optimize_search =
+ mp::xml::get_bool(attr->children, true);
+ }
+ else if (!strcmp((const char *) attr->name, "restart"))
+ {
+ m_p->m_restart = mp::xml::get_bool(attr->children, true);
+ }
+ else
+ throw mp::filter::FilterException(
+ "Bad attribute " + std::string((const char *)
+ attr->name));
+ }
+ }
+ else if (!strcmp((const char *) ptr->name, "session"))
+ {
+ const struct _xmlAttr *attr;
+ for (attr = ptr->properties; attr; attr = attr->next)
+ {
+ if (!strcmp((const char *) attr->name, "ttl"))
+ m_p->m_session_ttl =
+ mp::xml::get_int(attr->children, 90);
+ else if (!strcmp((const char *) attr->name, "max"))
+ m_p->m_session_max =
+ mp::xml::get_int(attr->children, 100);
+ else
+ throw mp::filter::FilterException(
+ "Bad attribute " + std::string((const char *)
+ attr->name));
+ }
+ }
+ else
+ {
+ throw mp::filter::FilterException("Bad element "
+ + std::string((const char *)
+ ptr->name));
}
}
- else
- package.move(); // Not Z39.50 or not Init
}
-static yp2::filter::Base* filter_creator()
+static mp::filter::Base* filter_creator()
{
- return new yp2::filter::SessionShared;
+ return new mp::filter::SessionShared;
}
extern "C" {
- const struct yp2_filter_struct yp2_filter_session_shared = {
+ struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
0,
"session_shared",
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
*/
+