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>
31 #include <yaz/otherinfo.h>
32 #include <yaz/diagbib1.h>
33 #include <yaz/match_glob.h>
34 #include <yaz/query-charset.h>
40 namespace mp = metaproxy_1;
41 namespace yf = mp::filter;
43 namespace metaproxy_1 {
46 struct VirtualDB::Set {
47 Set(BackendPtr b, std::string setname);
52 std::string m_setname;
54 struct VirtualDB::Map {
55 Map(std::string database, std::list<std::string> targets, std::string route);
56 Map(std::string database, std::string target, std::string route);
58 bool match(const std::string db) const;
59 std::string m_dbpattern;
60 std::list<std::string> m_targets;
63 std::string query_encoding;
65 struct VirtualDB::Backend {
66 mp::Session m_backend_session;
67 std::list<std::string> m_frontend_databases;
68 std::list<std::string> m_targets;
70 std::string query_encoding;
71 bool m_named_result_sets;
74 struct VirtualDB::Frontend {
77 mp::Session m_session;
80 yazpp_1::GDU m_init_gdu;
81 std::list<BackendPtr> m_backend_list;
82 std::map<std::string,VirtualDB::Set> m_sets;
84 void search(Package &package, Z_APDU *apdu);
85 void present(Package &package, Z_APDU *apdu);
86 void scan(Package &package, Z_APDU *apdu);
87 int relay_apdu(Package &package, Z_APDU *apdu);
89 void close(Package &package);
90 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
92 void fixup_package(Package &p, BackendPtr b);
93 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
95 void fixup_npr_records(ODR odr, Z_Records *records,
98 BackendPtr lookup_backend_from_databases(
99 std::list<std::string> databases);
100 BackendPtr create_backend_from_databases(
101 std::list<std::string> databases,
103 std::string &failing_database);
105 BackendPtr init_backend(std::list<std::string> database,
107 int &error_code, std::string &addinfo);
110 class VirtualDB::Rep {
111 friend class VirtualDB;
112 friend struct Frontend;
114 FrontendPtr get_frontend(Package &package);
115 void release_frontend(Package &package);
116 void refresh_torus();
118 std::list<VirtualDB::Map>m_maps;
119 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
120 boost::mutex m_mutex;
121 boost::condition m_cond_session_ready;
122 std::map<mp::Session, FrontendPtr> m_clients;
128 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
129 std::list<std::string> databases)
131 std::list<BackendPtr>::const_iterator map_it;
132 map_it = m_backend_list.begin();
133 for (; map_it != m_backend_list.end(); map_it++)
134 if ((*map_it)->m_frontend_databases == databases)
140 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
141 std::list<std::string> databases, int &error_code, std::string &addinfo)
143 BackendPtr b(new Backend);
144 std::list<std::string>::const_iterator db_it = databases.begin();
146 b->m_number_of_sets = 0;
147 b->m_frontend_databases = databases;
148 b->m_named_result_sets = false;
150 bool first_route = true;
152 std::map<std::string,bool> targets_dedup;
153 for (; db_it != databases.end(); db_it++)
155 std::list<VirtualDB::Map>::const_iterator map_it;
156 map_it = m_p->m_maps.begin();
157 while (map_it != m_p->m_maps.end())
159 if (map_it->match(*db_it))
164 if (map_it == m_p->m_maps.end()) // database not found
166 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
171 std::list<std::string>::const_iterator t_it =
172 map_it->m_targets.begin();
173 for (; t_it != map_it->m_targets.end(); t_it++) {
174 if (!targets_dedup[*t_it])
176 targets_dedup[*t_it] = true;
177 b->m_targets.push_back(*t_it);
181 // see if we have a route conflict.
182 if (!first_route && b->m_route != map_it->m_route)
184 // we have a conflict.. routing must be same for all
185 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
189 b->m_route = map_it->m_route;
190 if (!first_route && b->query_encoding != map_it->query_encoding)
192 // we have a conflict. query encoding must be same for all
193 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
197 b->query_encoding = map_it->query_encoding;
203 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
204 std::list<std::string> databases, mp::Package &package,
205 int &error_code, std::string &addinfo)
207 BackendPtr b = create_backend_from_databases(databases, error_code,
211 Package init_package(b->m_backend_session, package.origin());
212 init_package.copy_filter(package);
216 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
218 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
220 Z_InitRequest *req = init_apdu->u.initRequest;
222 // copy stuff from Frontend Init Request
223 Z_GDU *org_gdu = m_init_gdu.get();
224 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
226 req->idAuthentication = org_init->idAuthentication;
227 req->implementationId = org_init->implementationId;
228 req->implementationName = org_init->implementationName;
229 req->implementationVersion = org_init->implementationVersion;
230 *req->preferredMessageSize = *org_init->preferredMessageSize;
231 *req->maximumRecordSize = *org_init->maximumRecordSize;
233 ODR_MASK_SET(req->options, Z_Options_search);
234 ODR_MASK_SET(req->options, Z_Options_present);
235 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
236 ODR_MASK_SET(req->options, Z_Options_scan);
238 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
239 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
240 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
242 init_package.request() = init_apdu;
244 init_package.move(b->m_route); // sending init
246 Z_GDU *gdu = init_package.response().get();
247 // we hope to get an init response
248 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
249 if (gdu && gdu->which == Z_GDU_Z3950
250 && gdu->u.z3950->which == Z_APDU_initResponse)
252 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
253 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
255 b->m_named_result_sets = true;
257 if (*res->result && !init_package.session().is_closed())
259 m_backend_list.push_back(b);
262 mp::util::get_init_diagnostics(res, error_code, addinfo);
264 if (!init_package.session().is_closed())
266 Package close_package(b->m_backend_session, package.origin());
267 close_package.copy_filter(package);
268 close_package.session().close();
269 close_package.move(b->m_route); // closing it
275 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
277 Z_SearchRequest *req = apdu_req->u.searchRequest;
279 std::string resultSetId = req->resultSetName;
282 std::list<std::string> databases;
284 for (i = 0; i<req->num_databaseNames; i++)
285 databases.push_back(req->databaseNames[i]);
287 Sets_it sets_it = m_sets.find(req->resultSetName);
288 if (sets_it != m_sets.end())
290 // result set already exist
291 // if replace indicator is off: we return diagnostic if
292 // result set already exist.
293 if (*req->replaceIndicator == 0)
296 odr.create_searchResponse(
298 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
300 package.response() = apdu;
304 sets_it->second.m_backend->m_number_of_sets--;
306 // pick up any existing database with named result sets ..
307 // or one which has no result sets.. yet.
308 BackendPtr b; // null for now
309 std::list<BackendPtr>::const_iterator map_it;
310 map_it = m_backend_list.begin();
311 for (; map_it != m_backend_list.end(); map_it++)
313 BackendPtr tmp = *map_it;
314 if (tmp->m_frontend_databases == databases &&
315 (tmp->m_named_result_sets ||
316 tmp->m_number_of_sets == 0))
322 if (!b) // no backend yet. Must create a new one
326 b = init_backend(databases, package, error_code, addinfo);
329 // did not get a backend (unavailable somehow?)
332 odr.create_searchResponse(
333 apdu_req, error_code, addinfo.c_str());
334 package.response() = apdu;
338 m_sets.erase(req->resultSetName);
339 // sending search to backend
340 Package search_package(b->m_backend_session, package.origin());
342 search_package.copy_filter(package);
344 std::string backend_setname;
345 if (b->m_named_result_sets)
347 backend_setname = std::string(req->resultSetName);
351 backend_setname = "default";
352 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
355 // pick first targets spec and move the databases from it ..
356 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
357 if (t_it != b->m_targets.end())
359 mp::util::set_databases_from_zurl(odr, *t_it,
360 &req->num_databaseNames,
361 &req->databaseNames);
364 if (b->query_encoding.length() &&
365 (req->query->which == Z_Query_type_1 ||
366 req->query->which == Z_Query_type_101))
368 yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
371 int r = yaz_query_charset_convert_rpnquery_check(
372 req->query->u.type_1, odr, cd);
375 yaz_log(YLOG_LOG, "query could not be converted");
378 *req->replaceIndicator = 1;
380 search_package.request() = yazpp_1::GDU(apdu_req);
382 search_package.move(b->m_route);
384 if (search_package.session().is_closed())
386 package.response() = search_package.response();
387 package.session().close();
390 b->m_number_of_sets++;
392 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
393 fixup_package(search_package, b);
394 package.response() = search_package.response();
397 yf::VirtualDB::Frontend::Frontend(Rep *rep)
400 m_is_virtual = false;
403 void yf::VirtualDB::Frontend::close(mp::Package &package)
405 std::list<BackendPtr>::const_iterator b_it;
407 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
409 (*b_it)->m_backend_session.close();
410 Package close_package((*b_it)->m_backend_session, package.origin());
411 close_package.copy_filter(package);
412 close_package.move((*b_it)->m_route);
414 m_backend_list.clear();
417 yf::VirtualDB::Frontend::~Frontend()
421 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
423 boost::mutex::scoped_lock lock(m_mutex);
425 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
429 it = m_clients.find(package.session());
430 if (it == m_clients.end())
433 if (!it->second->m_in_use)
435 it->second->m_in_use = true;
438 m_cond_session_ready.wait(lock);
440 FrontendPtr f(new Frontend(this));
441 m_clients[package.session()] = f;
446 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
448 boost::mutex::scoped_lock lock(m_mutex);
449 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
451 it = m_clients.find(package.session());
452 if (it != m_clients.end())
454 if (package.session().is_closed())
456 it->second->close(package);
461 it->second->m_in_use = false;
463 m_cond_session_ready.notify_all();
468 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
469 : m_backend(b), m_setname(setname)
474 yf::VirtualDB::Set::Set()
479 yf::VirtualDB::Set::~Set()
483 yf::VirtualDB::Map::Map(std::string database,
484 std::list<std::string> targets, std::string route)
485 : m_dbpattern(database), m_targets(targets), m_route(route)
489 yf::VirtualDB::Map::Map(std::string database,
490 std::string target, std::string route)
491 : m_dbpattern(database), m_route(route)
493 m_targets.push_back(target);
497 yf::VirtualDB::Map::Map()
501 bool yf::VirtualDB::Map::match(const std::string db) const
503 std::string norm_db = mp::util::database_name_normalize(db);
504 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
509 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
511 m_p->pass_vhosts = false;
514 yf::VirtualDB::~VirtualDB() {
517 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
520 if (npr->databaseName)
522 std::string b_database = std::string(npr->databaseName);
524 // consider each of the frontend databases..
525 std::list<std::string>::const_iterator db_it;
526 for (db_it = b->m_frontend_databases.begin();
527 db_it != b->m_frontend_databases.end(); db_it++)
529 // see which target it corresponds to.. (if any)
530 std::list<VirtualDB::Map>::const_iterator map_it =
532 while (map_it != m_p->m_maps.end())
534 if (map_it->match(*db_it))
538 if (map_it != m_p->m_maps.end())
540 std::list<std::string>::const_iterator t
541 = map_it->m_targets.begin();
542 while (t != map_it->m_targets.end())
544 if (*t == b_database)
546 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
554 db_it = b->m_frontend_databases.begin();
555 if (db_it != b->m_frontend_databases.end())
557 std::string database = *db_it;
558 npr->databaseName = odr_strdup(odr, database.c_str());
563 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
566 if (records && records->which == Z_Records_DBOSD)
568 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
570 for (i = 0; i < nprlist->num_records; i++)
572 fixup_npr_record(odr, nprlist->records[i], b);
577 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
579 Z_GDU *gdu = p.response().get();
582 if (gdu && gdu->which == Z_GDU_Z3950)
584 Z_APDU *apdu = gdu->u.z3950;
585 if (apdu->which == Z_APDU_presentResponse)
587 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
590 else if (apdu->which == Z_APDU_searchResponse)
592 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
598 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
600 Z_PresentRequest *req = apdu_req->u.presentRequest;
601 std::string resultSetId = req->resultSetId;
604 Sets_it sets_it = m_sets.find(resultSetId);
605 if (sets_it == m_sets.end())
608 odr.create_presentResponse(
610 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
611 resultSetId.c_str());
612 package.response() = apdu;
616 new mp::Session(sets_it->second.m_backend->m_backend_session);
618 // sending present to backend
619 Package present_package(*id, package.origin());
620 present_package.copy_filter(package);
622 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
624 present_package.request() = yazpp_1::GDU(apdu_req);
626 present_package.move(sets_it->second.m_backend->m_route);
628 fixup_package(present_package, sets_it->second.m_backend);
630 if (present_package.session().is_closed())
632 package.response() = present_package.response();
633 package.session().close();
638 package.response() = present_package.response();
643 int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
646 std::list<BackendPtr>::const_iterator map_it;
647 map_it = m_backend_list.begin();
648 for (; map_it != m_backend_list.end(); map_it++)
650 BackendPtr b = *map_it;
652 Package relay_package(b->m_backend_session, package.origin());
653 relay_package.copy_filter(package);
655 relay_package.request() = yazpp_1::GDU(apdu_req);
657 relay_package.move(b->m_route);
658 package.response() = relay_package.response();
664 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
666 Z_ScanRequest *req = apdu_req->u.scanRequest;
670 std::list<std::string> databases;
672 for (i = 0; i<req->num_databaseNames; i++)
673 databases.push_back(req->databaseNames[i]);
676 // pick up any existing backend with a database match
677 std::list<BackendPtr>::const_iterator map_it;
678 map_it = m_backend_list.begin();
679 for (; map_it != m_backend_list.end(); map_it++)
681 BackendPtr tmp = *map_it;
682 if (tmp->m_frontend_databases == databases)
685 if (map_it != m_backend_list.end())
687 if (!b) // no backend yet. Must create a new one
691 b = init_backend(databases, package, error_code, addinfo);
694 // did not get a backend (unavailable somehow?)
696 odr.create_scanResponse(
697 apdu_req, error_code, addinfo.c_str());
698 package.response() = apdu;
703 // sending scan to backend
704 Package scan_package(b->m_backend_session, package.origin());
706 scan_package.copy_filter(package);
708 // pick first targets spec and move the databases from it ..
709 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
710 if (t_it != b->m_targets.end())
712 mp::util::set_databases_from_zurl(odr, *t_it,
713 &req->num_databaseNames,
714 &req->databaseNames);
717 if (b->query_encoding.length())
719 yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
722 yaz_query_charset_convert_apt(req->termListAndStartPoint, odr, cd);
727 scan_package.request() = yazpp_1::GDU(apdu_req);
729 scan_package.move(b->m_route);
731 if (scan_package.session().is_closed())
733 package.response() = scan_package.response();
734 package.session().close();
737 package.response() = scan_package.response();
741 void yf::VirtualDB::add_map_db2targets(std::string db,
742 std::list<std::string> targets,
745 m_p->m_maps.push_back(
746 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
750 void yf::VirtualDB::add_map_db2target(std::string db,
755 m_p->m_maps.push_back(
756 VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
759 void yf::VirtualDB::process(mp::Package &package) const
761 FrontendPtr f = m_p->get_frontend(package);
763 Z_GDU *gdu = package.request().get();
765 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
766 Z_APDU_initRequest && !f->m_is_virtual)
768 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
770 std::list<std::string> vhosts;
771 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
773 if (vhosts.size() > 0 && m_p->pass_vhosts)
782 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
783 Z_InitResponse *resp = apdu->u.initResponse;
786 static const int masks[] = {
789 Z_Options_namedResultSets,
793 for (i = 0; masks[i] != -1; i++)
794 if (ODR_MASK_GET(req->options, masks[i]))
795 ODR_MASK_SET(resp->options, masks[i]);
797 static const int versions[] = {
803 for (i = 0; versions[i] != -1; i++)
804 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
805 ODR_MASK_SET(resp->protocolVersion, versions[i]);
809 *resp->preferredMessageSize = *req->preferredMessageSize;
810 *resp->maximumRecordSize = *req->maximumRecordSize;
812 package.response() = apdu;
813 f->m_is_virtual = true;
816 else if (!f->m_is_virtual)
818 else if (gdu && gdu->which == Z_GDU_Z3950)
820 Z_APDU *apdu = gdu->u.z3950;
821 if (apdu->which == Z_APDU_initRequest)
825 package.response() = odr.create_close(
827 Z_Close_protocolError,
830 package.session().close();
832 else if (apdu->which == Z_APDU_searchRequest)
834 f->search(package, apdu);
836 else if (apdu->which == Z_APDU_presentRequest)
838 f->present(package, apdu);
840 else if (apdu->which == Z_APDU_scanRequest)
842 f->scan(package, apdu);
844 else if (apdu->which == Z_APDU_close)
846 if (f->relay_apdu(package, apdu) == 0)
850 package.response() = odr.create_close(
851 apdu, Z_Close_finished, "virt_db");
853 package.session().close();
860 package.response() = odr.create_close(
861 apdu, Z_Close_protocolError,
862 "unsupported APDU in filter_virt_db");
864 package.session().close();
867 m_p->release_frontend(package);
870 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
872 for (ptr = ptr->children; ptr; ptr = ptr->next)
874 if (ptr->type != XML_ELEMENT_NODE)
876 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
878 m_p->pass_vhosts = mp::xml::get_bool(ptr, false);
880 else if (!strcmp((const char *) ptr->name, "virtual"))
882 std::string query_encoding;
883 std::string database;
884 std::list<std::string> targets;
885 xmlNode *v_node = ptr->children;
886 for (; v_node; v_node = v_node->next)
888 if (v_node->type != XML_ELEMENT_NODE)
891 if (mp::xml::is_element_mp(v_node, "database"))
892 database = mp::xml::get_text(v_node);
893 else if (mp::xml::is_element_mp(v_node, "target"))
894 targets.push_back(mp::xml::get_text(v_node));
895 else if (mp::xml::is_element_mp(v_node, "query-encoding"))
896 targets.push_back(mp::xml::get_text(v_node));
898 throw mp::filter::FilterException
900 + std::string((const char *) v_node->name)
901 + " in virtual section"
904 std::string route = mp::xml::get_route(ptr);
906 VirtualDB::Map vmap(mp::util::database_name_normalize(database),
908 vmap.query_encoding = query_encoding;
909 m_p->m_maps.push_back(vmap);
913 throw mp::filter::FilterException
915 + std::string((const char *) ptr->name)
916 + " in virt_db filter");
921 static mp::filter::Base* filter_creator()
923 return new mp::filter::VirtualDB;
927 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
938 * c-file-style: "Stroustrup"
939 * indent-tabs-mode: nil
941 * vim: shiftwidth=4 tabstop=8 expandtab