1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 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>
31 #include <yaz/otherinfo.h>
32 #include <yaz/diagbib1.h>
33 #include <yaz/match_glob.h>
39 namespace mp = metaproxy_1;
40 namespace yf = mp::filter;
42 namespace metaproxy_1 {
45 struct VirtualDB::Set {
46 Set(BackendPtr b, std::string setname);
51 std::string m_setname;
53 struct VirtualDB::Map {
54 Map(std::string database, std::list<std::string> targets, std::string route);
55 Map(std::string database, std::string target, std::string route);
57 bool match(const std::string db) const;
58 std::string m_dbpattern;
59 std::list<std::string> m_targets;
62 struct VirtualDB::Backend {
63 mp::Session m_backend_session;
64 std::list<std::string> m_frontend_databases;
65 std::list<std::string> m_targets;
67 bool m_named_result_sets;
70 struct VirtualDB::Frontend {
73 mp::Session m_session;
76 yazpp_1::GDU m_init_gdu;
77 std::list<BackendPtr> m_backend_list;
78 std::map<std::string,VirtualDB::Set> m_sets;
80 void search(Package &package, Z_APDU *apdu);
81 void present(Package &package, Z_APDU *apdu);
82 void scan(Package &package, Z_APDU *apdu);
83 int relay_apdu(Package &package, Z_APDU *apdu);
85 void close(Package &package);
86 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
88 void fixup_package(Package &p, BackendPtr b);
89 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
91 void fixup_npr_records(ODR odr, Z_Records *records,
94 BackendPtr lookup_backend_from_databases(
95 std::list<std::string> databases);
96 BackendPtr create_backend_from_databases(
97 std::list<std::string> databases,
99 std::string &failing_database);
101 BackendPtr init_backend(std::list<std::string> database,
103 int &error_code, std::string &addinfo);
106 class VirtualDB::Rep {
107 friend class VirtualDB;
108 friend struct Frontend;
110 FrontendPtr get_frontend(Package &package);
111 void release_frontend(Package &package);
112 void refresh_torus();
114 std::list<VirtualDB::Map>m_maps;
115 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
116 boost::mutex m_mutex;
117 boost::condition m_cond_session_ready;
118 std::map<mp::Session, FrontendPtr> m_clients;
124 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
125 std::list<std::string> databases)
127 std::list<BackendPtr>::const_iterator map_it;
128 map_it = m_backend_list.begin();
129 for (; map_it != m_backend_list.end(); map_it++)
130 if ((*map_it)->m_frontend_databases == databases)
136 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
137 std::list<std::string> databases, int &error_code, std::string &addinfo)
139 BackendPtr b(new Backend);
140 std::list<std::string>::const_iterator db_it = databases.begin();
142 b->m_number_of_sets = 0;
143 b->m_frontend_databases = databases;
144 b->m_named_result_sets = false;
146 bool first_route = true;
148 std::map<std::string,bool> targets_dedup;
149 for (; db_it != databases.end(); db_it++)
151 std::list<VirtualDB::Map>::const_iterator map_it;
152 map_it = m_p->m_maps.begin();
153 while (map_it != m_p->m_maps.end())
155 if (map_it->match(*db_it))
160 if (map_it == m_p->m_maps.end()) // database not found
162 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
167 std::list<std::string>::const_iterator t_it =
168 map_it->m_targets.begin();
169 for (; t_it != map_it->m_targets.end(); t_it++) {
170 if (!targets_dedup[*t_it])
172 targets_dedup[*t_it] = true;
173 b->m_targets.push_back(*t_it);
177 // see if we have a route conflict.
178 if (!first_route && b->m_route != map_it->m_route)
180 // we have a conflict.. routing must be same for all
181 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
185 b->m_route = map_it->m_route;
191 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
192 std::list<std::string> databases, mp::Package &package,
193 int &error_code, std::string &addinfo)
195 BackendPtr b = create_backend_from_databases(databases, error_code,
199 Package init_package(b->m_backend_session, package.origin());
200 init_package.copy_filter(package);
204 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
206 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
208 Z_InitRequest *req = init_apdu->u.initRequest;
210 // copy stuff from Frontend Init Request
211 Z_GDU *org_gdu = m_init_gdu.get();
212 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
214 req->idAuthentication = org_init->idAuthentication;
215 req->implementationId = org_init->implementationId;
216 req->implementationName = org_init->implementationName;
217 req->implementationVersion = org_init->implementationVersion;
218 *req->preferredMessageSize = *org_init->preferredMessageSize;
219 *req->maximumRecordSize = *org_init->maximumRecordSize;
221 ODR_MASK_SET(req->options, Z_Options_search);
222 ODR_MASK_SET(req->options, Z_Options_present);
223 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
224 ODR_MASK_SET(req->options, Z_Options_scan);
226 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
227 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
228 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
230 init_package.request() = init_apdu;
232 init_package.move(b->m_route); // sending init
234 Z_GDU *gdu = init_package.response().get();
235 // we hope to get an init response
237 if (gdu && gdu->which == Z_GDU_Z3950
238 && gdu->u.z3950->which == Z_APDU_initResponse)
240 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
241 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
243 b->m_named_result_sets = true;
245 if (*res->result && !init_package.session().is_closed())
247 m_backend_list.push_back(b);
250 mp::util::get_init_diagnostics(res, error_code, addinfo);
254 std::list<std::string>::const_iterator db_it = databases.begin();
255 error_code = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
256 if (db_it != databases.end())
259 if (!init_package.session().is_closed())
261 Package close_package(b->m_backend_session, package.origin());
262 close_package.copy_filter(package);
263 close_package.session().close();
264 close_package.move(b->m_route); // closing it
270 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
272 Z_SearchRequest *req = apdu_req->u.searchRequest;
274 std::string resultSetId = req->resultSetName;
277 std::list<std::string> databases;
279 for (i = 0; i<req->num_databaseNames; i++)
280 databases.push_back(req->databaseNames[i]);
282 Sets_it sets_it = m_sets.find(req->resultSetName);
283 if (sets_it != m_sets.end())
285 // result set already exist
286 // if replace indicator is off: we return diagnostic if
287 // result set already exist.
288 if (*req->replaceIndicator == 0)
291 odr.create_searchResponse(
293 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
295 package.response() = apdu;
299 sets_it->second.m_backend->m_number_of_sets--;
301 // pick up any existing database with named result sets ..
302 // or one which has no result sets.. yet.
303 BackendPtr b; // null for now
304 std::list<BackendPtr>::const_iterator map_it;
305 map_it = m_backend_list.begin();
306 for (; map_it != m_backend_list.end(); map_it++)
308 BackendPtr tmp = *map_it;
309 if (tmp->m_frontend_databases == databases &&
310 (tmp->m_named_result_sets ||
311 tmp->m_number_of_sets == 0))
317 if (!b) // no backend yet. Must create a new one
321 b = init_backend(databases, package, error_code, addinfo);
324 // did not get a backend (unavailable somehow?)
327 odr.create_searchResponse(
328 apdu_req, error_code, addinfo.c_str());
329 package.response() = apdu;
333 m_sets.erase(req->resultSetName);
334 // sending search to backend
335 Package search_package(b->m_backend_session, package.origin());
337 search_package.copy_filter(package);
339 std::string backend_setname;
340 if (b->m_named_result_sets)
342 backend_setname = std::string(req->resultSetName);
346 backend_setname = "default";
347 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
350 // pick first targets spec and move the databases from it ..
351 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
352 if (t_it != b->m_targets.end())
354 mp::util::set_databases_from_zurl(odr, *t_it,
355 &req->num_databaseNames,
356 &req->databaseNames);
359 *req->replaceIndicator = 1;
361 search_package.request() = yazpp_1::GDU(apdu_req);
363 search_package.move(b->m_route);
365 if (search_package.session().is_closed())
367 package.response() = search_package.response();
368 package.session().close();
371 b->m_number_of_sets++;
373 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
374 fixup_package(search_package, b);
375 package.response() = search_package.response();
378 yf::VirtualDB::Frontend::Frontend(Rep *rep)
381 m_is_virtual = false;
384 void yf::VirtualDB::Frontend::close(mp::Package &package)
386 std::list<BackendPtr>::const_iterator b_it;
388 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
390 (*b_it)->m_backend_session.close();
391 Package close_package((*b_it)->m_backend_session, package.origin());
392 close_package.copy_filter(package);
393 close_package.move((*b_it)->m_route);
395 m_backend_list.clear();
398 yf::VirtualDB::Frontend::~Frontend()
402 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
404 boost::mutex::scoped_lock lock(m_mutex);
406 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
410 it = m_clients.find(package.session());
411 if (it == m_clients.end())
414 if (!it->second->m_in_use)
416 it->second->m_in_use = true;
419 m_cond_session_ready.wait(lock);
421 FrontendPtr f(new Frontend(this));
422 m_clients[package.session()] = f;
427 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
429 boost::mutex::scoped_lock lock(m_mutex);
430 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
432 it = m_clients.find(package.session());
433 if (it != m_clients.end())
435 if (package.session().is_closed())
437 it->second->close(package);
442 it->second->m_in_use = false;
444 m_cond_session_ready.notify_all();
449 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
450 : m_backend(b), m_setname(setname)
455 yf::VirtualDB::Set::Set()
460 yf::VirtualDB::Set::~Set()
464 yf::VirtualDB::Map::Map(std::string database,
465 std::list<std::string> targets, std::string route)
466 : m_dbpattern(database), m_targets(targets), m_route(route)
470 yf::VirtualDB::Map::Map(std::string database,
471 std::string target, std::string route)
472 : m_dbpattern(database), m_route(route)
474 m_targets.push_back(target);
478 yf::VirtualDB::Map::Map()
482 bool yf::VirtualDB::Map::match(const std::string db) const
484 std::string norm_db = mp::util::database_name_normalize(db);
485 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
490 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
492 m_p->pass_vhosts = false;
495 yf::VirtualDB::~VirtualDB() {
498 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
501 if (npr->databaseName)
503 std::string b_database = std::string(npr->databaseName);
505 // consider each of the frontend databases..
506 std::list<std::string>::const_iterator db_it;
507 for (db_it = b->m_frontend_databases.begin();
508 db_it != b->m_frontend_databases.end(); db_it++)
510 // see which target it corresponds to.. (if any)
511 std::list<VirtualDB::Map>::const_iterator map_it =
513 while (map_it != m_p->m_maps.end())
515 if (map_it->match(*db_it))
519 if (map_it != m_p->m_maps.end())
521 std::list<std::string>::const_iterator t
522 = map_it->m_targets.begin();
523 while (t != map_it->m_targets.end())
525 if (*t == b_database)
527 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
535 db_it = b->m_frontend_databases.begin();
536 if (db_it != b->m_frontend_databases.end())
538 std::string database = *db_it;
539 npr->databaseName = odr_strdup(odr, database.c_str());
544 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
547 if (records && records->which == Z_Records_DBOSD)
549 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
551 for (i = 0; i < nprlist->num_records; i++)
553 fixup_npr_record(odr, nprlist->records[i], b);
558 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
560 Z_GDU *gdu = p.response().get();
563 if (gdu && gdu->which == Z_GDU_Z3950)
565 Z_APDU *apdu = gdu->u.z3950;
566 if (apdu->which == Z_APDU_presentResponse)
568 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
571 else if (apdu->which == Z_APDU_searchResponse)
573 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
579 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
581 Z_PresentRequest *req = apdu_req->u.presentRequest;
582 std::string resultSetId = req->resultSetId;
585 Sets_it sets_it = m_sets.find(resultSetId);
586 if (sets_it == m_sets.end())
589 odr.create_presentResponse(
591 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
592 resultSetId.c_str());
593 package.response() = apdu;
597 new mp::Session(sets_it->second.m_backend->m_backend_session);
599 // sending present to backend
600 Package present_package(*id, package.origin());
601 present_package.copy_filter(package);
603 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
605 present_package.request() = yazpp_1::GDU(apdu_req);
607 present_package.move(sets_it->second.m_backend->m_route);
609 fixup_package(present_package, sets_it->second.m_backend);
611 if (present_package.session().is_closed())
613 package.response() = present_package.response();
614 package.session().close();
619 package.response() = present_package.response();
624 int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
627 std::list<BackendPtr>::const_iterator map_it;
628 map_it = m_backend_list.begin();
629 for (; map_it != m_backend_list.end(); map_it++)
631 BackendPtr b = *map_it;
633 Package relay_package(b->m_backend_session, package.origin());
634 relay_package.copy_filter(package);
636 relay_package.request() = yazpp_1::GDU(apdu_req);
638 relay_package.move(b->m_route);
639 package.response() = relay_package.response();
645 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
647 Z_ScanRequest *req = apdu_req->u.scanRequest;
651 std::list<std::string> databases;
653 for (i = 0; i<req->num_databaseNames; i++)
654 databases.push_back(req->databaseNames[i]);
657 // pick up any existing backend with a database match
658 std::list<BackendPtr>::const_iterator map_it;
659 map_it = m_backend_list.begin();
660 for (; map_it != m_backend_list.end(); map_it++)
662 BackendPtr tmp = *map_it;
663 if (tmp->m_frontend_databases == databases)
666 if (map_it != m_backend_list.end())
668 if (!b) // no backend yet. Must create a new one
672 b = init_backend(databases, package, error_code, addinfo);
675 // did not get a backend (unavailable somehow?)
677 odr.create_scanResponse(
678 apdu_req, error_code, addinfo.c_str());
679 package.response() = apdu;
684 // sending scan to backend
685 Package scan_package(b->m_backend_session, package.origin());
687 scan_package.copy_filter(package);
689 // pick first targets spec and move the databases from it ..
690 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
691 if (t_it != b->m_targets.end())
693 mp::util::set_databases_from_zurl(odr, *t_it,
694 &req->num_databaseNames,
695 &req->databaseNames);
698 scan_package.request() = yazpp_1::GDU(apdu_req);
700 scan_package.move(b->m_route);
702 if (scan_package.session().is_closed())
704 package.response() = scan_package.response();
705 package.session().close();
708 package.response() = scan_package.response();
712 void yf::VirtualDB::add_map_db2targets(std::string db,
713 std::list<std::string> targets,
716 m_p->m_maps.push_back(
717 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
721 void yf::VirtualDB::add_map_db2target(std::string db,
726 m_p->m_maps.push_back(
727 VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
730 void yf::VirtualDB::process(mp::Package &package) const
732 FrontendPtr f = m_p->get_frontend(package);
734 Z_GDU *gdu = package.request().get();
736 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
737 Z_APDU_initRequest && !f->m_is_virtual)
739 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
741 std::list<std::string> vhosts;
742 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
744 if (vhosts.size() > 0 && m_p->pass_vhosts)
753 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
754 Z_InitResponse *resp = apdu->u.initResponse;
757 static const int masks[] = {
760 Z_Options_namedResultSets,
764 for (i = 0; masks[i] != -1; i++)
765 if (ODR_MASK_GET(req->options, masks[i]))
766 ODR_MASK_SET(resp->options, masks[i]);
768 static const int versions[] = {
774 for (i = 0; versions[i] != -1; i++)
775 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
776 ODR_MASK_SET(resp->protocolVersion, versions[i]);
780 *resp->preferredMessageSize = *req->preferredMessageSize;
781 *resp->maximumRecordSize = *req->maximumRecordSize;
783 package.response() = apdu;
784 f->m_is_virtual = true;
787 else if (!f->m_is_virtual)
789 else if (gdu && gdu->which == Z_GDU_Z3950)
791 Z_APDU *apdu = gdu->u.z3950;
792 if (apdu->which == Z_APDU_initRequest)
796 package.response() = odr.create_close(
798 Z_Close_protocolError,
801 package.session().close();
803 else if (apdu->which == Z_APDU_searchRequest)
805 f->search(package, apdu);
807 else if (apdu->which == Z_APDU_presentRequest)
809 f->present(package, apdu);
811 else if (apdu->which == Z_APDU_scanRequest)
813 f->scan(package, apdu);
815 else if (apdu->which == Z_APDU_close)
817 if (f->relay_apdu(package, apdu) == 0)
821 package.response() = odr.create_close(
822 apdu, Z_Close_finished, "virt_db");
824 package.session().close();
831 package.response() = odr.create_close(
832 apdu, Z_Close_protocolError,
833 "unsupported APDU in filter_virt_db");
835 package.session().close();
838 m_p->release_frontend(package);
841 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only,
844 for (ptr = ptr->children; ptr; ptr = ptr->next)
846 if (ptr->type != XML_ELEMENT_NODE)
848 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
850 m_p->pass_vhosts = mp::xml::get_bool(ptr, false);
852 else if (!strcmp((const char *) ptr->name, "virtual"))
854 std::string database;
855 std::list<std::string> targets;
856 xmlNode *v_node = ptr->children;
857 for (; v_node; v_node = v_node->next)
859 if (v_node->type != XML_ELEMENT_NODE)
862 if (mp::xml::is_element_mp(v_node, "database"))
863 database = mp::xml::get_text(v_node);
864 else if (mp::xml::is_element_mp(v_node, "target"))
865 targets.push_back(mp::xml::get_text(v_node));
867 throw mp::filter::FilterException
869 + std::string((const char *) v_node->name)
870 + " in virtual section"
873 std::string route = mp::xml::get_route(ptr);
875 VirtualDB::Map vmap(mp::util::database_name_normalize(database),
877 m_p->m_maps.push_back(vmap);
881 throw mp::filter::FilterException
883 + std::string((const char *) ptr->name)
884 + " in virt_db filter");
889 static mp::filter::Base* filter_creator()
891 return new mp::filter::VirtualDB;
895 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
906 * c-file-style: "Stroustrup"
907 * indent-tabs-mode: nil
909 * vim: shiftwidth=4 tabstop=8 expandtab