1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 #include "filter_virt_db.hpp"
22 #include <metaproxy/package.hpp>
24 #include <boost/thread/mutex.hpp>
25 #include <boost/thread/condition.hpp>
26 #include <boost/shared_ptr.hpp>
28 #include <metaproxy/util.hpp>
32 #include <yaz/otherinfo.h>
33 #include <yaz/diagbib1.h>
34 #include <yaz/match_glob.h>
35 #include <yaz/query-charset.h>
41 namespace mp = metaproxy_1;
42 namespace yf = mp::filter;
44 namespace metaproxy_1 {
47 struct VirtualDB::Set {
48 Set(BackendPtr b, std::string setname);
53 std::string m_setname;
55 struct VirtualDB::Map {
56 Map(std::string database, std::list<std::string> targets, std::string route);
57 Map(std::string database, std::string target, std::string route);
59 bool match(const std::string db) const;
60 std::string m_dbpattern;
61 std::list<std::string> m_targets;
64 std::string query_encoding;
66 struct VirtualDB::Backend {
67 mp::Session m_backend_session;
68 std::list<std::string> m_frontend_databases;
69 std::list<std::string> m_targets;
71 std::string query_encoding;
72 bool m_named_result_sets;
75 struct VirtualDB::Frontend {
78 mp::Session m_session;
81 yazpp_1::GDU m_init_gdu;
82 std::list<BackendPtr> m_backend_list;
83 std::map<std::string,VirtualDB::Set> m_sets;
85 void search(Package &package, Z_APDU *apdu);
86 void present(Package &package, Z_APDU *apdu);
87 void scan(Package &package, Z_APDU *apdu);
88 int relay_apdu(Package &package, Z_APDU *apdu);
90 void close(Package &package);
91 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
93 void fixup_package(Package &p, BackendPtr b);
94 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
96 void fixup_npr_records(ODR odr, Z_Records *records,
99 BackendPtr lookup_backend_from_databases(
100 std::list<std::string> databases);
101 BackendPtr create_backend_from_databases(
102 std::list<std::string> databases,
104 std::string &failing_database);
106 BackendPtr init_backend(std::list<std::string> database,
108 int &error_code, std::string &addinfo);
111 class VirtualDB::Rep {
112 friend class VirtualDB;
113 friend struct Frontend;
115 FrontendPtr get_frontend(Package &package);
116 void release_frontend(Package &package);
117 void refresh_torus();
119 std::list<VirtualDB::Map>m_maps;
120 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
121 boost::mutex m_mutex;
122 boost::condition m_cond_session_ready;
123 std::map<mp::Session, FrontendPtr> m_clients;
129 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
130 std::list<std::string> databases)
132 std::list<BackendPtr>::const_iterator map_it;
133 map_it = m_backend_list.begin();
134 for (; map_it != m_backend_list.end(); map_it++)
135 if ((*map_it)->m_frontend_databases == databases)
141 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
142 std::list<std::string> databases, int &error_code, std::string &addinfo)
144 BackendPtr b(new Backend);
145 std::list<std::string>::const_iterator db_it = databases.begin();
147 b->m_number_of_sets = 0;
148 b->m_frontend_databases = databases;
149 b->m_named_result_sets = false;
151 bool first_route = true;
153 std::map<std::string,bool> targets_dedup;
154 for (; db_it != databases.end(); db_it++)
156 std::list<VirtualDB::Map>::const_iterator map_it;
157 map_it = m_p->m_maps.begin();
158 while (map_it != m_p->m_maps.end())
160 if (map_it->match(*db_it))
165 if (map_it == m_p->m_maps.end()) // database not found
167 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
172 std::list<std::string>::const_iterator t_it =
173 map_it->m_targets.begin();
174 for (; t_it != map_it->m_targets.end(); t_it++) {
175 if (!targets_dedup[*t_it])
177 targets_dedup[*t_it] = true;
178 b->m_targets.push_back(*t_it);
182 // see if we have a route conflict.
183 if (!first_route && b->m_route != map_it->m_route)
185 // we have a conflict.. routing must be same for all
186 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
190 b->m_route = map_it->m_route;
191 if (!first_route && b->query_encoding != map_it->query_encoding)
193 // we have a conflict. query encoding must be same for all
194 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
198 b->query_encoding = map_it->query_encoding;
204 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
205 std::list<std::string> databases, mp::Package &package,
206 int &error_code, std::string &addinfo)
208 BackendPtr b = create_backend_from_databases(databases, error_code,
212 Package init_package(b->m_backend_session, package.origin());
213 init_package.copy_filter(package);
217 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
219 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
221 Z_InitRequest *req = init_apdu->u.initRequest;
223 // copy stuff from Frontend Init Request
224 Z_GDU *org_gdu = m_init_gdu.get();
225 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
227 req->idAuthentication = org_init->idAuthentication;
228 req->implementationId = org_init->implementationId;
229 req->implementationName = org_init->implementationName;
230 req->implementationVersion = org_init->implementationVersion;
231 *req->preferredMessageSize = *org_init->preferredMessageSize;
232 *req->maximumRecordSize = *org_init->maximumRecordSize;
234 ODR_MASK_SET(req->options, Z_Options_search);
235 ODR_MASK_SET(req->options, Z_Options_present);
236 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
237 ODR_MASK_SET(req->options, Z_Options_scan);
239 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
240 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
241 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
243 init_package.request() = init_apdu;
245 init_package.move(b->m_route); // sending init
247 Z_GDU *gdu = init_package.response().get();
248 // we hope to get an init response
249 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
250 if (gdu && gdu->which == Z_GDU_Z3950
251 && gdu->u.z3950->which == Z_APDU_initResponse)
253 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
254 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
256 b->m_named_result_sets = true;
258 if (*res->result && !init_package.session().is_closed())
260 m_backend_list.push_back(b);
263 mp::util::get_init_diagnostics(res, error_code, addinfo);
265 if (!init_package.session().is_closed())
267 Package close_package(b->m_backend_session, package.origin());
268 close_package.copy_filter(package);
269 close_package.session().close();
270 close_package.move(b->m_route); // closing it
276 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
278 Z_SearchRequest *req = apdu_req->u.searchRequest;
280 std::string resultSetId = req->resultSetName;
283 std::list<std::string> databases;
285 for (i = 0; i<req->num_databaseNames; i++)
286 databases.push_back(req->databaseNames[i]);
288 Sets_it sets_it = m_sets.find(req->resultSetName);
289 if (sets_it != m_sets.end())
291 // result set already exist
292 // if replace indicator is off: we return diagnostic if
293 // result set already exist.
294 if (*req->replaceIndicator == 0)
297 odr.create_searchResponse(
299 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
301 package.response() = apdu;
305 sets_it->second.m_backend->m_number_of_sets--;
307 // pick up any existing database with named result sets ..
308 // or one which has no result sets.. yet.
309 BackendPtr b; // null for now
310 std::list<BackendPtr>::const_iterator map_it;
311 map_it = m_backend_list.begin();
312 for (; map_it != m_backend_list.end(); map_it++)
314 BackendPtr tmp = *map_it;
315 if (tmp->m_frontend_databases == databases &&
316 (tmp->m_named_result_sets ||
317 tmp->m_number_of_sets == 0))
323 if (!b) // no backend yet. Must create a new one
327 b = init_backend(databases, package, error_code, addinfo);
330 // did not get a backend (unavailable somehow?)
333 odr.create_searchResponse(
334 apdu_req, error_code, addinfo.c_str());
335 package.response() = apdu;
339 m_sets.erase(req->resultSetName);
340 // sending search to backend
341 Package search_package(b->m_backend_session, package.origin());
343 search_package.copy_filter(package);
345 std::string backend_setname;
346 if (b->m_named_result_sets)
348 backend_setname = std::string(req->resultSetName);
352 backend_setname = "default";
353 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
356 // pick first targets spec and move the databases from it ..
357 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
358 if (t_it != b->m_targets.end())
360 mp::util::set_databases_from_zurl(odr, *t_it,
361 &req->num_databaseNames,
362 &req->databaseNames);
365 if (b->query_encoding.length() &&
366 (req->query->which == Z_Query_type_1 ||
367 req->query->which == Z_Query_type_101))
369 yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
372 int r = yaz_query_charset_convert_rpnquery_check(
373 req->query->u.type_1, odr, cd);
376 yaz_log(YLOG_LOG, "query could not be converted");
379 *req->replaceIndicator = 1;
381 search_package.request() = yazpp_1::GDU(apdu_req);
383 search_package.move(b->m_route);
385 if (search_package.session().is_closed())
387 package.response() = search_package.response();
388 package.session().close();
391 b->m_number_of_sets++;
393 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
394 fixup_package(search_package, b);
395 package.response() = search_package.response();
398 yf::VirtualDB::Frontend::Frontend(Rep *rep)
401 m_is_virtual = false;
404 void yf::VirtualDB::Frontend::close(mp::Package &package)
406 std::list<BackendPtr>::const_iterator b_it;
408 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
410 (*b_it)->m_backend_session.close();
411 Package close_package((*b_it)->m_backend_session, package.origin());
412 close_package.copy_filter(package);
413 close_package.move((*b_it)->m_route);
415 m_backend_list.clear();
418 yf::VirtualDB::Frontend::~Frontend()
422 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
424 boost::mutex::scoped_lock lock(m_mutex);
426 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
430 it = m_clients.find(package.session());
431 if (it == m_clients.end())
434 if (!it->second->m_in_use)
436 it->second->m_in_use = true;
439 m_cond_session_ready.wait(lock);
441 FrontendPtr f(new Frontend(this));
442 m_clients[package.session()] = f;
447 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
449 boost::mutex::scoped_lock lock(m_mutex);
450 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
452 it = m_clients.find(package.session());
453 if (it != m_clients.end())
455 if (package.session().is_closed())
457 it->second->close(package);
462 it->second->m_in_use = false;
464 m_cond_session_ready.notify_all();
469 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
470 : m_backend(b), m_setname(setname)
475 yf::VirtualDB::Set::Set()
480 yf::VirtualDB::Set::~Set()
484 yf::VirtualDB::Map::Map(std::string database,
485 std::list<std::string> targets, std::string route)
486 : m_dbpattern(database), m_targets(targets), m_route(route)
490 yf::VirtualDB::Map::Map(std::string database,
491 std::string target, std::string route)
492 : m_dbpattern(database), m_route(route)
494 m_targets.push_back(target);
498 yf::VirtualDB::Map::Map()
502 bool yf::VirtualDB::Map::match(const std::string db) const
504 std::string norm_db = mp::util::database_name_normalize(db);
505 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
510 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
512 m_p->pass_vhosts = false;
515 yf::VirtualDB::~VirtualDB() {
518 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
521 if (npr->databaseName)
523 std::string b_database = std::string(npr->databaseName);
525 // consider each of the frontend databases..
526 std::list<std::string>::const_iterator db_it;
527 for (db_it = b->m_frontend_databases.begin();
528 db_it != b->m_frontend_databases.end(); db_it++)
530 // see which target it corresponds to.. (if any)
531 std::list<VirtualDB::Map>::const_iterator map_it =
533 while (map_it != m_p->m_maps.end())
535 if (map_it->match(*db_it))
539 if (map_it != m_p->m_maps.end())
541 std::list<std::string>::const_iterator t
542 = map_it->m_targets.begin();
543 while (t != map_it->m_targets.end())
545 if (*t == b_database)
547 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
555 db_it = b->m_frontend_databases.begin();
556 if (db_it != b->m_frontend_databases.end())
558 std::string database = *db_it;
559 npr->databaseName = odr_strdup(odr, database.c_str());
564 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
567 if (records && records->which == Z_Records_DBOSD)
569 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
571 for (i = 0; i < nprlist->num_records; i++)
573 fixup_npr_record(odr, nprlist->records[i], b);
578 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
580 Z_GDU *gdu = p.response().get();
583 if (gdu && gdu->which == Z_GDU_Z3950)
585 Z_APDU *apdu = gdu->u.z3950;
586 if (apdu->which == Z_APDU_presentResponse)
588 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
591 else if (apdu->which == Z_APDU_searchResponse)
593 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
599 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
601 Z_PresentRequest *req = apdu_req->u.presentRequest;
602 std::string resultSetId = req->resultSetId;
605 Sets_it sets_it = m_sets.find(resultSetId);
606 if (sets_it == m_sets.end())
609 odr.create_presentResponse(
611 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
612 resultSetId.c_str());
613 package.response() = apdu;
617 new mp::Session(sets_it->second.m_backend->m_backend_session);
619 // sending present to backend
620 Package present_package(*id, package.origin());
621 present_package.copy_filter(package);
623 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
625 present_package.request() = yazpp_1::GDU(apdu_req);
627 present_package.move(sets_it->second.m_backend->m_route);
629 fixup_package(present_package, sets_it->second.m_backend);
631 if (present_package.session().is_closed())
633 package.response() = present_package.response();
634 package.session().close();
639 package.response() = present_package.response();
644 int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
647 std::list<BackendPtr>::const_iterator map_it;
648 map_it = m_backend_list.begin();
649 for (; map_it != m_backend_list.end(); map_it++)
651 BackendPtr b = *map_it;
653 Package relay_package(b->m_backend_session, package.origin());
654 relay_package.copy_filter(package);
656 relay_package.request() = yazpp_1::GDU(apdu_req);
658 relay_package.move(b->m_route);
659 package.response() = relay_package.response();
665 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
667 Z_ScanRequest *req = apdu_req->u.scanRequest;
671 std::list<std::string> databases;
673 for (i = 0; i<req->num_databaseNames; i++)
674 databases.push_back(req->databaseNames[i]);
677 // pick up any existing backend with a database match
678 std::list<BackendPtr>::const_iterator map_it;
679 map_it = m_backend_list.begin();
680 for (; map_it != m_backend_list.end(); map_it++)
682 BackendPtr tmp = *map_it;
683 if (tmp->m_frontend_databases == databases)
686 if (map_it != m_backend_list.end())
688 if (!b) // no backend yet. Must create a new one
692 b = init_backend(databases, package, error_code, addinfo);
695 // did not get a backend (unavailable somehow?)
697 odr.create_scanResponse(
698 apdu_req, error_code, addinfo.c_str());
699 package.response() = apdu;
704 // sending scan to backend
705 Package scan_package(b->m_backend_session, package.origin());
707 scan_package.copy_filter(package);
709 // pick first targets spec and move the databases from it ..
710 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
711 if (t_it != b->m_targets.end())
713 mp::util::set_databases_from_zurl(odr, *t_it,
714 &req->num_databaseNames,
715 &req->databaseNames);
718 if (b->query_encoding.length())
720 yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
723 yaz_query_charset_convert_apt(req->termListAndStartPoint, odr, cd);
728 scan_package.request() = yazpp_1::GDU(apdu_req);
730 scan_package.move(b->m_route);
732 if (scan_package.session().is_closed())
734 package.response() = scan_package.response();
735 package.session().close();
738 package.response() = scan_package.response();
742 void yf::VirtualDB::add_map_db2targets(std::string db,
743 std::list<std::string> targets,
746 m_p->m_maps.push_back(
747 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
751 void yf::VirtualDB::add_map_db2target(std::string db,
756 m_p->m_maps.push_back(
757 VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
760 void yf::VirtualDB::process(mp::Package &package) const
762 FrontendPtr f = m_p->get_frontend(package);
764 Z_GDU *gdu = package.request().get();
766 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
767 Z_APDU_initRequest && !f->m_is_virtual)
769 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
771 std::list<std::string> vhosts;
772 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
774 if (vhosts.size() > 0 && m_p->pass_vhosts)
783 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
784 Z_InitResponse *resp = apdu->u.initResponse;
787 static const int masks[] = {
790 Z_Options_namedResultSets,
794 for (i = 0; masks[i] != -1; i++)
795 if (ODR_MASK_GET(req->options, masks[i]))
796 ODR_MASK_SET(resp->options, masks[i]);
798 static const int versions[] = {
804 for (i = 0; versions[i] != -1; i++)
805 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
806 ODR_MASK_SET(resp->protocolVersion, versions[i]);
810 *resp->preferredMessageSize = *req->preferredMessageSize;
811 *resp->maximumRecordSize = *req->maximumRecordSize;
813 package.response() = apdu;
814 f->m_is_virtual = true;
817 else if (!f->m_is_virtual)
819 else if (gdu && gdu->which == Z_GDU_Z3950)
821 Z_APDU *apdu = gdu->u.z3950;
822 if (apdu->which == Z_APDU_initRequest)
826 package.response() = odr.create_close(
828 Z_Close_protocolError,
831 package.session().close();
833 else if (apdu->which == Z_APDU_searchRequest)
835 f->search(package, apdu);
837 else if (apdu->which == Z_APDU_presentRequest)
839 f->present(package, apdu);
841 else if (apdu->which == Z_APDU_scanRequest)
843 f->scan(package, apdu);
845 else if (apdu->which == Z_APDU_close)
847 if (f->relay_apdu(package, apdu) == 0)
851 package.response() = odr.create_close(
852 apdu, Z_Close_finished, "virt_db");
854 package.session().close();
861 package.response() = odr.create_close(
862 apdu, Z_Close_protocolError,
863 "unsupported APDU in filter_virt_db");
865 package.session().close();
868 m_p->release_frontend(package);
871 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
873 for (ptr = ptr->children; ptr; ptr = ptr->next)
875 if (ptr->type != XML_ELEMENT_NODE)
877 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
879 m_p->pass_vhosts = mp::xml::get_bool(ptr, false);
881 else if (!strcmp((const char *) ptr->name, "virtual"))
883 std::string query_encoding;
884 std::string database;
885 std::list<std::string> targets;
886 xmlNode *v_node = ptr->children;
887 for (; v_node; v_node = v_node->next)
889 if (v_node->type != XML_ELEMENT_NODE)
892 if (mp::xml::is_element_mp(v_node, "database"))
893 database = mp::xml::get_text(v_node);
894 else if (mp::xml::is_element_mp(v_node, "target"))
895 targets.push_back(mp::xml::get_text(v_node));
896 else if (mp::xml::is_element_mp(v_node, "query-encoding"))
897 targets.push_back(mp::xml::get_text(v_node));
899 throw mp::filter::FilterException
901 + std::string((const char *) v_node->name)
902 + " in virtual section"
905 std::string route = mp::xml::get_route(ptr);
907 VirtualDB::Map vmap(mp::util::database_name_normalize(database),
909 vmap.query_encoding = query_encoding;
910 m_p->m_maps.push_back(vmap);
914 throw mp::filter::FilterException
916 + std::string((const char *) ptr->name)
917 + " in virt_db filter");
922 static mp::filter::Base* filter_creator()
924 return new mp::filter::VirtualDB;
928 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
939 * c-file-style: "Stroustrup"
940 * indent-tabs-mode: nil
942 * vim: shiftwidth=4 tabstop=8 expandtab