1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2010 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>
38 namespace mp = metaproxy_1;
39 namespace yf = mp::filter;
41 namespace metaproxy_1 {
44 struct VirtualDB::Set {
45 Set(BackendPtr b, std::string setname);
50 std::string m_setname;
52 struct VirtualDB::Map {
53 Map(std::string database, std::list<std::string> targets, std::string route);
55 bool match(const std::string db) const;
56 std::string m_dbpattern;
57 std::list<std::string> m_targets;
60 struct VirtualDB::Backend {
61 mp::Session m_backend_session;
62 std::list<std::string> m_frontend_databases;
63 std::list<std::string> m_targets;
65 bool m_named_result_sets;
68 struct VirtualDB::Frontend {
71 mp::Session m_session;
74 yazpp_1::GDU m_init_gdu;
75 std::list<BackendPtr> m_backend_list;
76 std::map<std::string,VirtualDB::Set> m_sets;
78 void search(Package &package, Z_APDU *apdu);
79 void present(Package &package, Z_APDU *apdu);
80 void scan(Package &package, Z_APDU *apdu);
82 void close(Package &package);
83 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
85 void fixup_package(Package &p, BackendPtr b);
86 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
88 void fixup_npr_records(ODR odr, Z_Records *records,
91 BackendPtr lookup_backend_from_databases(
92 std::list<std::string> databases);
93 BackendPtr create_backend_from_databases(
94 std::list<std::string> databases,
96 std::string &failing_database);
98 BackendPtr init_backend(std::list<std::string> database,
100 int &error_code, std::string &addinfo);
103 class VirtualDB::Rep {
104 friend class VirtualDB;
105 friend struct Frontend;
107 FrontendPtr get_frontend(Package &package);
108 void release_frontend(Package &package);
110 std::list<VirtualDB::Map>m_maps;
111 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
112 boost::mutex m_mutex;
113 boost::condition m_cond_session_ready;
114 std::map<mp::Session, FrontendPtr> m_clients;
120 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
121 std::list<std::string> databases)
123 std::list<BackendPtr>::const_iterator map_it;
124 map_it = m_backend_list.begin();
125 for (; map_it != m_backend_list.end(); map_it++)
126 if ((*map_it)->m_frontend_databases == databases)
132 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
133 std::list<std::string> databases, int &error_code, std::string &addinfo)
135 BackendPtr b(new Backend);
136 std::list<std::string>::const_iterator db_it = databases.begin();
138 b->m_number_of_sets = 0;
139 b->m_frontend_databases = databases;
140 b->m_named_result_sets = false;
142 bool first_route = true;
144 std::map<std::string,bool> targets_dedup;
145 for (; db_it != databases.end(); db_it++)
147 std::list<VirtualDB::Map>::const_iterator map_it;
148 map_it = m_p->m_maps.begin();
149 while (map_it != m_p->m_maps.end())
151 if (map_it->match(*db_it))
156 if (map_it == m_p->m_maps.end()) // database not found
158 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
163 std::list<std::string>::const_iterator t_it =
164 map_it->m_targets.begin();
165 for (; t_it != map_it->m_targets.end(); t_it++) {
166 if (!targets_dedup[*t_it])
168 targets_dedup[*t_it] = true;
169 b->m_targets.push_back(*t_it);
173 // see if we have a route conflict.
174 if (!first_route && b->m_route != map_it->m_route)
176 // we have a conflict..
177 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
181 b->m_route = map_it->m_route;
187 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
188 std::list<std::string> databases, mp::Package &package,
189 int &error_code, std::string &addinfo)
191 BackendPtr b = create_backend_from_databases(databases, error_code,
195 Package init_package(b->m_backend_session, package.origin());
196 init_package.copy_filter(package);
200 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
202 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
204 Z_InitRequest *req = init_apdu->u.initRequest;
206 // copy stuff from Frontend Init Request
207 Z_GDU *org_gdu = m_init_gdu.get();
208 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
210 req->idAuthentication = org_init->idAuthentication;
211 req->implementationId = org_init->implementationId;
212 req->implementationName = org_init->implementationName;
213 req->implementationVersion = org_init->implementationVersion;
215 ODR_MASK_SET(req->options, Z_Options_search);
216 ODR_MASK_SET(req->options, Z_Options_present);
217 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
218 ODR_MASK_SET(req->options, Z_Options_scan);
220 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
221 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
222 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
224 init_package.request() = init_apdu;
226 init_package.move(b->m_route); // sending init
228 Z_GDU *gdu = init_package.response().get();
229 // we hope to get an init response
230 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
233 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
234 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
236 b->m_named_result_sets = true;
240 m_backend_list.push_back(b);
244 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
245 mp::util::get_init_diagnostics(res, error_code, addinfo);
247 if (!init_package.session().is_closed())
249 Package close_package(b->m_backend_session, package.origin());
250 close_package.copy_filter(package);
251 close_package.session().close();
252 close_package.move(b->m_route); // closing it
258 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
260 Z_SearchRequest *req = apdu_req->u.searchRequest;
262 std::string resultSetId = req->resultSetName;
265 std::list<std::string> databases;
267 for (i = 0; i<req->num_databaseNames; i++)
268 databases.push_back(req->databaseNames[i]);
270 Sets_it sets_it = m_sets.find(req->resultSetName);
271 if (sets_it != m_sets.end())
273 // result set already exist
274 // if replace indicator is off: we return diagnostic if
275 // result set already exist.
276 if (*req->replaceIndicator == 0)
279 odr.create_searchResponse(
281 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
283 package.response() = apdu;
287 sets_it->second.m_backend->m_number_of_sets--;
289 // pick up any existing database with named result sets ..
290 // or one which has no result sets.. yet.
291 BackendPtr b; // null for now
292 std::list<BackendPtr>::const_iterator map_it;
293 map_it = m_backend_list.begin();
294 for (; map_it != m_backend_list.end(); map_it++)
296 BackendPtr tmp = *map_it;
297 if (tmp->m_frontend_databases == databases &&
298 (tmp->m_named_result_sets ||
299 tmp->m_number_of_sets == 0))
305 if (!b) // no backend yet. Must create a new one
309 b = init_backend(databases, package, error_code, addinfo);
312 // did not get a backend (unavailable somehow?)
315 odr.create_searchResponse(
316 apdu_req, error_code, addinfo.c_str());
317 package.response() = apdu;
321 m_sets.erase(req->resultSetName);
322 // sending search to backend
323 Package search_package(b->m_backend_session, package.origin());
325 search_package.copy_filter(package);
327 std::string backend_setname;
328 if (b->m_named_result_sets)
330 backend_setname = std::string(req->resultSetName);
334 backend_setname = "default";
335 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
338 // pick first targets spec and move the databases from it ..
339 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
340 if (t_it != b->m_targets.end())
342 mp::util::set_databases_from_zurl(odr, *t_it,
343 &req->num_databaseNames,
344 &req->databaseNames);
347 *req->replaceIndicator = 1;
349 search_package.request() = yazpp_1::GDU(apdu_req);
351 search_package.move(b->m_route);
353 if (search_package.session().is_closed())
355 package.response() = search_package.response();
356 package.session().close();
359 b->m_number_of_sets++;
361 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
362 fixup_package(search_package, b);
363 package.response() = search_package.response();
366 yf::VirtualDB::Frontend::Frontend(Rep *rep)
369 m_is_virtual = false;
372 void yf::VirtualDB::Frontend::close(mp::Package &package)
374 std::list<BackendPtr>::const_iterator b_it;
376 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
378 (*b_it)->m_backend_session.close();
379 Package close_package((*b_it)->m_backend_session, package.origin());
380 close_package.copy_filter(package);
381 close_package.move((*b_it)->m_route);
383 m_backend_list.clear();
386 yf::VirtualDB::Frontend::~Frontend()
390 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
392 boost::mutex::scoped_lock lock(m_mutex);
394 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
398 it = m_clients.find(package.session());
399 if (it == m_clients.end())
402 if (!it->second->m_in_use)
404 it->second->m_in_use = true;
407 m_cond_session_ready.wait(lock);
409 FrontendPtr f(new Frontend(this));
410 m_clients[package.session()] = f;
415 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
417 boost::mutex::scoped_lock lock(m_mutex);
418 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
420 it = m_clients.find(package.session());
421 if (it != m_clients.end())
423 if (package.session().is_closed())
425 it->second->close(package);
430 it->second->m_in_use = false;
432 m_cond_session_ready.notify_all();
436 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
437 : m_backend(b), m_setname(setname)
442 yf::VirtualDB::Set::Set()
447 yf::VirtualDB::Set::~Set()
451 yf::VirtualDB::Map::Map(std::string database,
452 std::list<std::string> targets, std::string route)
453 : m_dbpattern(database), m_targets(targets), m_route(route)
457 yf::VirtualDB::Map::Map()
461 bool yf::VirtualDB::Map::match(const std::string db) const
463 std::string norm_db = mp::util::database_name_normalize(db);
464 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
469 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
471 m_p->pass_vhosts = false;
474 yf::VirtualDB::~VirtualDB() {
477 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
480 if (npr->databaseName)
482 std::string b_database = std::string(npr->databaseName);
484 // consider each of the frontend databases..
485 std::list<std::string>::const_iterator db_it;
486 for (db_it = b->m_frontend_databases.begin();
487 db_it != b->m_frontend_databases.end(); db_it++)
489 // see which target it corresponds to.. (if any)
490 std::list<VirtualDB::Map>::const_iterator map_it =
492 while (map_it != m_p->m_maps.end())
494 if (map_it->match(*db_it))
498 if (map_it != m_p->m_maps.end())
500 std::list<std::string>::const_iterator t
501 = map_it->m_targets.begin();
502 while (t != map_it->m_targets.end())
504 if (*t == b_database)
506 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
514 db_it = b->m_frontend_databases.begin();
515 if (db_it != b->m_frontend_databases.end())
517 std::string database = *db_it;
518 npr->databaseName = odr_strdup(odr, database.c_str());
523 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
526 if (records && records->which == Z_Records_DBOSD)
528 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
530 for (i = 0; i < nprlist->num_records; i++)
532 fixup_npr_record(odr, nprlist->records[i], b);
537 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
539 Z_GDU *gdu = p.response().get();
542 if (gdu && gdu->which == Z_GDU_Z3950)
544 Z_APDU *apdu = gdu->u.z3950;
545 if (apdu->which == Z_APDU_presentResponse)
547 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
550 else if (apdu->which == Z_APDU_searchResponse)
552 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
558 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
560 Z_PresentRequest *req = apdu_req->u.presentRequest;
561 std::string resultSetId = req->resultSetId;
564 Sets_it sets_it = m_sets.find(resultSetId);
565 if (sets_it == m_sets.end())
568 odr.create_presentResponse(
570 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
571 resultSetId.c_str());
572 package.response() = apdu;
576 new mp::Session(sets_it->second.m_backend->m_backend_session);
578 // sending present to backend
579 Package present_package(*id, package.origin());
580 present_package.copy_filter(package);
582 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
584 present_package.request() = yazpp_1::GDU(apdu_req);
586 present_package.move(sets_it->second.m_backend->m_route);
588 fixup_package(present_package, sets_it->second.m_backend);
590 if (present_package.session().is_closed())
592 package.response() = present_package.response();
593 package.session().close();
598 package.response() = present_package.response();
603 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
605 Z_ScanRequest *req = apdu_req->u.scanRequest;
609 std::list<std::string> databases;
611 for (i = 0; i<req->num_databaseNames; i++)
612 databases.push_back(req->databaseNames[i]);
615 // pick up any existing backend with a database match
616 std::list<BackendPtr>::const_iterator map_it;
617 map_it = m_backend_list.begin();
618 for (; map_it != m_backend_list.end(); map_it++)
620 BackendPtr tmp = *map_it;
621 if (tmp->m_frontend_databases == databases)
624 if (map_it != m_backend_list.end())
626 if (!b) // no backend yet. Must create a new one
630 b = init_backend(databases, package, error_code, addinfo);
633 // did not get a backend (unavailable somehow?)
635 odr.create_scanResponse(
636 apdu_req, error_code, addinfo.c_str());
637 package.response() = apdu;
642 // sending scan to backend
643 Package scan_package(b->m_backend_session, package.origin());
645 scan_package.copy_filter(package);
647 // pick first targets spec and move the databases from it ..
648 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
649 if (t_it != b->m_targets.end())
651 mp::util::set_databases_from_zurl(odr, *t_it,
652 &req->num_databaseNames,
653 &req->databaseNames);
655 scan_package.request() = yazpp_1::GDU(apdu_req);
657 scan_package.move(b->m_route);
659 if (scan_package.session().is_closed())
661 package.response() = scan_package.response();
662 package.session().close();
665 package.response() = scan_package.response();
669 void yf::VirtualDB::add_map_db2targets(std::string db,
670 std::list<std::string> targets,
673 m_p->m_maps.push_back(
674 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
678 void yf::VirtualDB::add_map_db2target(std::string db,
682 std::list<std::string> targets;
683 targets.push_back(target);
685 add_map_db2targets(db, targets, route);
688 void yf::VirtualDB::process(mp::Package &package) const
690 FrontendPtr f = m_p->get_frontend(package);
692 Z_GDU *gdu = package.request().get();
694 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
695 Z_APDU_initRequest && !f->m_is_virtual)
697 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
699 std::list<std::string> vhosts;
700 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
702 if (vhosts.size() > 0 && m_p->pass_vhosts)
711 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
712 Z_InitResponse *resp = apdu->u.initResponse;
715 static const int masks[] = {
718 Z_Options_namedResultSets,
722 for (i = 0; masks[i] != -1; i++)
723 if (ODR_MASK_GET(req->options, masks[i]))
724 ODR_MASK_SET(resp->options, masks[i]);
726 static const int versions[] = {
732 for (i = 0; versions[i] != -1; i++)
733 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
734 ODR_MASK_SET(resp->protocolVersion, versions[i]);
738 package.response() = apdu;
739 f->m_is_virtual = true;
742 else if (!f->m_is_virtual)
744 else if (gdu && gdu->which == Z_GDU_Z3950)
746 Z_APDU *apdu = gdu->u.z3950;
747 if (apdu->which == Z_APDU_initRequest)
751 package.response() = odr.create_close(
753 Z_Close_protocolError,
756 package.session().close();
758 else if (apdu->which == Z_APDU_searchRequest)
760 f->search(package, apdu);
762 else if (apdu->which == Z_APDU_presentRequest)
764 f->present(package, apdu);
766 else if (apdu->which == Z_APDU_scanRequest)
768 f->scan(package, apdu);
770 else if (apdu->which == Z_APDU_close)
772 package.session().close();
778 package.response() = odr.create_close(
779 apdu, Z_Close_protocolError,
780 "unsupported APDU in filter_virt_db");
782 package.session().close();
785 m_p->release_frontend(package);
789 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
791 for (ptr = ptr->children; ptr; ptr = ptr->next)
793 if (ptr->type != XML_ELEMENT_NODE)
795 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
797 m_p->pass_vhosts = mp::xml::get_bool(ptr->children, false);
799 else if (!strcmp((const char *) ptr->name, "virtual"))
801 std::string database;
802 std::list<std::string> targets;
803 xmlNode *v_node = ptr->children;
804 for (; v_node; v_node = v_node->next)
806 if (v_node->type != XML_ELEMENT_NODE)
809 if (mp::xml::is_element_mp(v_node, "database"))
810 database = mp::xml::get_text(v_node);
811 else if (mp::xml::is_element_mp(v_node, "target"))
812 targets.push_back(mp::xml::get_text(v_node));
814 throw mp::filter::FilterException
816 + std::string((const char *) v_node->name)
817 + " in virtual section"
820 std::string route = mp::xml::get_route(ptr);
821 add_map_db2targets(database, targets, route);
825 throw mp::filter::FilterException
827 + std::string((const char *) ptr->name)
828 + " in virt_db filter");
833 static mp::filter::Base* filter_creator()
835 return new mp::filter::VirtualDB;
839 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
850 * c-file-style: "Stroustrup"
851 * indent-tabs-mode: nil
853 * vim: shiftwidth=4 tabstop=8 expandtab