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>
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);
56 bool match(const std::string db) const;
57 std::string m_dbpattern;
58 std::list<std::string> m_targets;
61 struct VirtualDB::Backend {
62 mp::Session m_backend_session;
63 std::list<std::string> m_frontend_databases;
64 std::list<std::string> m_targets;
66 bool m_named_result_sets;
69 struct VirtualDB::Frontend {
72 mp::Session m_session;
75 yazpp_1::GDU m_init_gdu;
76 std::list<BackendPtr> m_backend_list;
77 std::map<std::string,VirtualDB::Set> m_sets;
79 void search(Package &package, Z_APDU *apdu);
80 void present(Package &package, Z_APDU *apdu);
81 void scan(Package &package, Z_APDU *apdu);
83 void close(Package &package);
84 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
86 void fixup_package(Package &p, BackendPtr b);
87 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
89 void fixup_npr_records(ODR odr, Z_Records *records,
92 BackendPtr lookup_backend_from_databases(
93 std::list<std::string> databases);
94 BackendPtr create_backend_from_databases(
95 std::list<std::string> databases,
97 std::string &failing_database);
99 BackendPtr init_backend(std::list<std::string> database,
101 int &error_code, std::string &addinfo);
104 class VirtualDB::Rep {
105 friend class VirtualDB;
106 friend struct Frontend;
108 FrontendPtr get_frontend(Package &package);
109 void release_frontend(Package &package);
111 std::list<VirtualDB::Map>m_maps;
112 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
113 boost::mutex m_mutex;
114 boost::condition m_cond_session_ready;
115 std::map<mp::Session, FrontendPtr> m_clients;
121 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
122 std::list<std::string> databases)
124 std::list<BackendPtr>::const_iterator map_it;
125 map_it = m_backend_list.begin();
126 for (; map_it != m_backend_list.end(); map_it++)
127 if ((*map_it)->m_frontend_databases == databases)
133 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
134 std::list<std::string> databases, int &error_code, std::string &addinfo)
136 BackendPtr b(new Backend);
137 std::list<std::string>::const_iterator db_it = databases.begin();
139 b->m_number_of_sets = 0;
140 b->m_frontend_databases = databases;
141 b->m_named_result_sets = false;
143 bool first_route = true;
145 std::map<std::string,bool> targets_dedup;
146 for (; db_it != databases.end(); db_it++)
148 std::list<VirtualDB::Map>::const_iterator map_it;
149 map_it = m_p->m_maps.begin();
150 while (map_it != m_p->m_maps.end())
152 if (map_it->match(*db_it))
157 if (map_it == m_p->m_maps.end()) // database not found
159 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
164 std::list<std::string>::const_iterator t_it =
165 map_it->m_targets.begin();
166 for (; t_it != map_it->m_targets.end(); t_it++) {
167 if (!targets_dedup[*t_it])
169 targets_dedup[*t_it] = true;
170 b->m_targets.push_back(*t_it);
174 // see if we have a route conflict.
175 if (!first_route && b->m_route != map_it->m_route)
177 // we have a conflict..
178 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
182 b->m_route = map_it->m_route;
188 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
189 std::list<std::string> databases, mp::Package &package,
190 int &error_code, std::string &addinfo)
192 BackendPtr b = create_backend_from_databases(databases, error_code,
196 Package init_package(b->m_backend_session, package.origin());
197 init_package.copy_filter(package);
201 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
203 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
205 Z_InitRequest *req = init_apdu->u.initRequest;
207 // copy stuff from Frontend Init Request
208 Z_GDU *org_gdu = m_init_gdu.get();
209 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
211 req->idAuthentication = org_init->idAuthentication;
212 req->implementationId = org_init->implementationId;
213 req->implementationName = org_init->implementationName;
214 req->implementationVersion = org_init->implementationVersion;
215 *req->preferredMessageSize = *org_init->preferredMessageSize;
216 *req->maximumRecordSize = *org_init->maximumRecordSize;
218 ODR_MASK_SET(req->options, Z_Options_search);
219 ODR_MASK_SET(req->options, Z_Options_present);
220 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
221 ODR_MASK_SET(req->options, Z_Options_scan);
223 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
224 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
225 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
227 init_package.request() = init_apdu;
229 init_package.move(b->m_route); // sending init
231 Z_GDU *gdu = init_package.response().get();
232 // we hope to get an init response
233 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
234 if (gdu && gdu->which == Z_GDU_Z3950
235 && gdu->u.z3950->which == Z_APDU_initResponse
236 && *gdu->u.z3950->u.initResponse->result)
238 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
239 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
241 b->m_named_result_sets = true;
243 if (*res->result && !init_package.session().is_closed())
245 m_backend_list.push_back(b);
248 mp::util::get_init_diagnostics(res, error_code, addinfo);
250 if (!init_package.session().is_closed())
252 Package close_package(b->m_backend_session, package.origin());
253 close_package.copy_filter(package);
254 close_package.session().close();
255 close_package.move(b->m_route); // closing it
261 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
263 Z_SearchRequest *req = apdu_req->u.searchRequest;
265 std::string resultSetId = req->resultSetName;
268 std::list<std::string> databases;
270 for (i = 0; i<req->num_databaseNames; i++)
271 databases.push_back(req->databaseNames[i]);
273 Sets_it sets_it = m_sets.find(req->resultSetName);
274 if (sets_it != m_sets.end())
276 // result set already exist
277 // if replace indicator is off: we return diagnostic if
278 // result set already exist.
279 if (*req->replaceIndicator == 0)
282 odr.create_searchResponse(
284 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
286 package.response() = apdu;
290 sets_it->second.m_backend->m_number_of_sets--;
292 // pick up any existing database with named result sets ..
293 // or one which has no result sets.. yet.
294 BackendPtr b; // null for now
295 std::list<BackendPtr>::const_iterator map_it;
296 map_it = m_backend_list.begin();
297 for (; map_it != m_backend_list.end(); map_it++)
299 BackendPtr tmp = *map_it;
300 if (tmp->m_frontend_databases == databases &&
301 (tmp->m_named_result_sets ||
302 tmp->m_number_of_sets == 0))
308 if (!b) // no backend yet. Must create a new one
312 b = init_backend(databases, package, error_code, addinfo);
315 // did not get a backend (unavailable somehow?)
318 odr.create_searchResponse(
319 apdu_req, error_code, addinfo.c_str());
320 package.response() = apdu;
324 m_sets.erase(req->resultSetName);
325 // sending search to backend
326 Package search_package(b->m_backend_session, package.origin());
328 search_package.copy_filter(package);
330 std::string backend_setname;
331 if (b->m_named_result_sets)
333 backend_setname = std::string(req->resultSetName);
337 backend_setname = "default";
338 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
341 // pick first targets spec and move the databases from it ..
342 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
343 if (t_it != b->m_targets.end())
345 mp::util::set_databases_from_zurl(odr, *t_it,
346 &req->num_databaseNames,
347 &req->databaseNames);
350 *req->replaceIndicator = 1;
352 search_package.request() = yazpp_1::GDU(apdu_req);
354 search_package.move(b->m_route);
356 if (search_package.session().is_closed())
358 package.response() = search_package.response();
359 package.session().close();
362 b->m_number_of_sets++;
364 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
365 fixup_package(search_package, b);
366 package.response() = search_package.response();
369 yf::VirtualDB::Frontend::Frontend(Rep *rep)
372 m_is_virtual = false;
375 void yf::VirtualDB::Frontend::close(mp::Package &package)
377 std::list<BackendPtr>::const_iterator b_it;
379 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
381 (*b_it)->m_backend_session.close();
382 Package close_package((*b_it)->m_backend_session, package.origin());
383 close_package.copy_filter(package);
384 close_package.move((*b_it)->m_route);
386 m_backend_list.clear();
389 yf::VirtualDB::Frontend::~Frontend()
393 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
395 boost::mutex::scoped_lock lock(m_mutex);
397 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
401 it = m_clients.find(package.session());
402 if (it == m_clients.end())
405 if (!it->second->m_in_use)
407 it->second->m_in_use = true;
410 m_cond_session_ready.wait(lock);
412 FrontendPtr f(new Frontend(this));
413 m_clients[package.session()] = f;
418 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
420 boost::mutex::scoped_lock lock(m_mutex);
421 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
423 it = m_clients.find(package.session());
424 if (it != m_clients.end())
426 if (package.session().is_closed())
428 it->second->close(package);
433 it->second->m_in_use = false;
435 m_cond_session_ready.notify_all();
439 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
440 : m_backend(b), m_setname(setname)
445 yf::VirtualDB::Set::Set()
450 yf::VirtualDB::Set::~Set()
454 yf::VirtualDB::Map::Map(std::string database,
455 std::list<std::string> targets, std::string route)
456 : m_dbpattern(database), m_targets(targets), m_route(route)
460 yf::VirtualDB::Map::Map()
464 bool yf::VirtualDB::Map::match(const std::string db) const
466 std::string norm_db = mp::util::database_name_normalize(db);
467 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
472 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
474 m_p->pass_vhosts = false;
477 yf::VirtualDB::~VirtualDB() {
480 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
483 if (npr->databaseName)
485 std::string b_database = std::string(npr->databaseName);
487 // consider each of the frontend databases..
488 std::list<std::string>::const_iterator db_it;
489 for (db_it = b->m_frontend_databases.begin();
490 db_it != b->m_frontend_databases.end(); db_it++)
492 // see which target it corresponds to.. (if any)
493 std::list<VirtualDB::Map>::const_iterator map_it =
495 while (map_it != m_p->m_maps.end())
497 if (map_it->match(*db_it))
501 if (map_it != m_p->m_maps.end())
503 std::list<std::string>::const_iterator t
504 = map_it->m_targets.begin();
505 while (t != map_it->m_targets.end())
507 if (*t == b_database)
509 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
517 db_it = b->m_frontend_databases.begin();
518 if (db_it != b->m_frontend_databases.end())
520 std::string database = *db_it;
521 npr->databaseName = odr_strdup(odr, database.c_str());
526 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
529 if (records && records->which == Z_Records_DBOSD)
531 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
533 for (i = 0; i < nprlist->num_records; i++)
535 fixup_npr_record(odr, nprlist->records[i], b);
540 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
542 Z_GDU *gdu = p.response().get();
545 if (gdu && gdu->which == Z_GDU_Z3950)
547 Z_APDU *apdu = gdu->u.z3950;
548 if (apdu->which == Z_APDU_presentResponse)
550 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
553 else if (apdu->which == Z_APDU_searchResponse)
555 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
561 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
563 Z_PresentRequest *req = apdu_req->u.presentRequest;
564 std::string resultSetId = req->resultSetId;
567 Sets_it sets_it = m_sets.find(resultSetId);
568 if (sets_it == m_sets.end())
571 odr.create_presentResponse(
573 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
574 resultSetId.c_str());
575 package.response() = apdu;
579 new mp::Session(sets_it->second.m_backend->m_backend_session);
581 // sending present to backend
582 Package present_package(*id, package.origin());
583 present_package.copy_filter(package);
585 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
587 present_package.request() = yazpp_1::GDU(apdu_req);
589 present_package.move(sets_it->second.m_backend->m_route);
591 fixup_package(present_package, sets_it->second.m_backend);
593 if (present_package.session().is_closed())
595 package.response() = present_package.response();
596 package.session().close();
601 package.response() = present_package.response();
606 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
608 Z_ScanRequest *req = apdu_req->u.scanRequest;
612 std::list<std::string> databases;
614 for (i = 0; i<req->num_databaseNames; i++)
615 databases.push_back(req->databaseNames[i]);
618 // pick up any existing backend with a database match
619 std::list<BackendPtr>::const_iterator map_it;
620 map_it = m_backend_list.begin();
621 for (; map_it != m_backend_list.end(); map_it++)
623 BackendPtr tmp = *map_it;
624 if (tmp->m_frontend_databases == databases)
627 if (map_it != m_backend_list.end())
629 if (!b) // no backend yet. Must create a new one
633 b = init_backend(databases, package, error_code, addinfo);
636 // did not get a backend (unavailable somehow?)
638 odr.create_scanResponse(
639 apdu_req, error_code, addinfo.c_str());
640 package.response() = apdu;
645 // sending scan to backend
646 Package scan_package(b->m_backend_session, package.origin());
648 scan_package.copy_filter(package);
650 // pick first targets spec and move the databases from it ..
651 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
652 if (t_it != b->m_targets.end())
654 mp::util::set_databases_from_zurl(odr, *t_it,
655 &req->num_databaseNames,
656 &req->databaseNames);
658 scan_package.request() = yazpp_1::GDU(apdu_req);
660 scan_package.move(b->m_route);
662 if (scan_package.session().is_closed())
664 package.response() = scan_package.response();
665 package.session().close();
668 package.response() = scan_package.response();
672 void yf::VirtualDB::add_map_db2targets(std::string db,
673 std::list<std::string> targets,
676 m_p->m_maps.push_back(
677 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
681 void yf::VirtualDB::add_map_db2target(std::string db,
685 std::list<std::string> targets;
686 targets.push_back(target);
688 add_map_db2targets(db, targets, route);
691 void yf::VirtualDB::process(mp::Package &package) const
693 FrontendPtr f = m_p->get_frontend(package);
695 Z_GDU *gdu = package.request().get();
697 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
698 Z_APDU_initRequest && !f->m_is_virtual)
700 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
702 std::list<std::string> vhosts;
703 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
705 if (vhosts.size() > 0 && m_p->pass_vhosts)
714 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
715 Z_InitResponse *resp = apdu->u.initResponse;
718 static const int masks[] = {
721 Z_Options_namedResultSets,
725 for (i = 0; masks[i] != -1; i++)
726 if (ODR_MASK_GET(req->options, masks[i]))
727 ODR_MASK_SET(resp->options, masks[i]);
729 static const int versions[] = {
735 for (i = 0; versions[i] != -1; i++)
736 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
737 ODR_MASK_SET(resp->protocolVersion, versions[i]);
741 *resp->preferredMessageSize = *req->preferredMessageSize;
742 *resp->maximumRecordSize = *req->maximumRecordSize;
744 package.response() = apdu;
745 f->m_is_virtual = true;
748 else if (!f->m_is_virtual)
750 else if (gdu && gdu->which == Z_GDU_Z3950)
752 Z_APDU *apdu = gdu->u.z3950;
753 if (apdu->which == Z_APDU_initRequest)
757 package.response() = odr.create_close(
759 Z_Close_protocolError,
762 package.session().close();
764 else if (apdu->which == Z_APDU_searchRequest)
766 f->search(package, apdu);
768 else if (apdu->which == Z_APDU_presentRequest)
770 f->present(package, apdu);
772 else if (apdu->which == Z_APDU_scanRequest)
774 f->scan(package, apdu);
776 else if (apdu->which == Z_APDU_close)
778 package.session().close();
784 package.response() = odr.create_close(
785 apdu, Z_Close_protocolError,
786 "unsupported APDU in filter_virt_db");
788 package.session().close();
791 m_p->release_frontend(package);
795 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
797 for (ptr = ptr->children; ptr; ptr = ptr->next)
799 if (ptr->type != XML_ELEMENT_NODE)
801 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
803 m_p->pass_vhosts = mp::xml::get_bool(ptr->children, false);
805 else if (!strcmp((const char *) ptr->name, "virtual"))
807 std::string database;
808 std::list<std::string> targets;
809 xmlNode *v_node = ptr->children;
810 for (; v_node; v_node = v_node->next)
812 if (v_node->type != XML_ELEMENT_NODE)
815 if (mp::xml::is_element_mp(v_node, "database"))
816 database = mp::xml::get_text(v_node);
817 else if (mp::xml::is_element_mp(v_node, "target"))
818 targets.push_back(mp::xml::get_text(v_node));
820 throw mp::filter::FilterException
822 + std::string((const char *) v_node->name)
823 + " in virtual section"
826 std::string route = mp::xml::get_route(ptr);
827 add_map_db2targets(database, targets, route);
831 throw mp::filter::FilterException
833 + std::string((const char *) ptr->name)
834 + " in virt_db filter");
839 static mp::filter::Base* filter_creator()
841 return new mp::filter::VirtualDB;
845 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
856 * c-file-style: "Stroustrup"
857 * indent-tabs-mode: nil
859 * vim: shiftwidth=4 tabstop=8 expandtab