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 BackendPtr b; // null for now
271 Sets_it sets_it = m_sets.find(req->resultSetName);
272 if (sets_it != m_sets.end())
274 // result set already exist
275 // if replace indicator is off: we return diagnostic if
276 // result set already exist.
277 if (*req->replaceIndicator == 0)
280 odr.create_searchResponse(
282 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
284 package.response() = apdu;
288 sets_it->second.m_backend->m_number_of_sets--;
290 // pick up any existing backend with a database match
291 std::list<BackendPtr>::const_iterator map_it;
292 map_it = m_backend_list.begin();
293 for (; map_it != m_backend_list.end(); map_it++)
295 BackendPtr tmp = *map_it;
296 if (tmp->m_frontend_databases == databases &&
297 (tmp->m_named_result_sets ||
298 tmp->m_number_of_sets == 0))
301 if (map_it != m_backend_list.end())
308 // pick up any existing database with named result sets ..
309 // or one which has no result sets.. yet.
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))
320 if (map_it != m_backend_list.end())
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 *req->replaceIndicator = 1;
367 search_package.request() = yazpp_1::GDU(apdu_req);
369 search_package.move(b->m_route);
371 if (search_package.session().is_closed())
373 package.response() = search_package.response();
374 package.session().close();
377 b->m_number_of_sets++;
379 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
380 fixup_package(search_package, b);
381 package.response() = search_package.response();
384 yf::VirtualDB::Frontend::Frontend(Rep *rep)
387 m_is_virtual = false;
390 void yf::VirtualDB::Frontend::close(mp::Package &package)
392 std::list<BackendPtr>::const_iterator b_it;
394 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
396 (*b_it)->m_backend_session.close();
397 Package close_package((*b_it)->m_backend_session, package.origin());
398 close_package.copy_filter(package);
399 close_package.move((*b_it)->m_route);
401 m_backend_list.clear();
404 yf::VirtualDB::Frontend::~Frontend()
408 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
410 boost::mutex::scoped_lock lock(m_mutex);
412 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
416 it = m_clients.find(package.session());
417 if (it == m_clients.end())
420 if (!it->second->m_in_use)
422 it->second->m_in_use = true;
425 m_cond_session_ready.wait(lock);
427 FrontendPtr f(new Frontend(this));
428 m_clients[package.session()] = f;
433 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
435 boost::mutex::scoped_lock lock(m_mutex);
436 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
438 it = m_clients.find(package.session());
439 if (it != m_clients.end())
441 if (package.session().is_closed())
443 it->second->close(package);
448 it->second->m_in_use = false;
450 m_cond_session_ready.notify_all();
454 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
455 : m_backend(b), m_setname(setname)
460 yf::VirtualDB::Set::Set()
465 yf::VirtualDB::Set::~Set()
469 yf::VirtualDB::Map::Map(std::string database,
470 std::list<std::string> targets, std::string route)
471 : m_dbpattern(database), m_targets(targets), m_route(route)
475 yf::VirtualDB::Map::Map()
479 bool yf::VirtualDB::Map::match(const std::string db) const
481 std::string norm_db = mp::util::database_name_normalize(db);
482 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
487 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
489 m_p->pass_vhosts = false;
492 yf::VirtualDB::~VirtualDB() {
495 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
498 if (npr->databaseName)
500 std::string b_database = std::string(npr->databaseName);
502 // consider each of the frontend databases..
503 std::list<std::string>::const_iterator db_it;
504 for (db_it = b->m_frontend_databases.begin();
505 db_it != b->m_frontend_databases.end(); db_it++)
507 // see which target it corresponds to.. (if any)
508 std::list<VirtualDB::Map>::const_iterator map_it =
510 while (map_it != m_p->m_maps.end())
512 if (map_it->match(*db_it))
516 if (map_it != m_p->m_maps.end())
518 std::list<std::string>::const_iterator t
519 = map_it->m_targets.begin();
520 while (t != map_it->m_targets.end())
522 if (*t == b_database)
524 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
532 db_it = b->m_frontend_databases.begin();
533 if (db_it != b->m_frontend_databases.end())
535 std::string database = *db_it;
536 npr->databaseName = odr_strdup(odr, database.c_str());
541 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
544 if (records && records->which == Z_Records_DBOSD)
546 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
548 for (i = 0; i < nprlist->num_records; i++)
550 fixup_npr_record(odr, nprlist->records[i], b);
555 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
557 Z_GDU *gdu = p.response().get();
560 if (gdu && gdu->which == Z_GDU_Z3950)
562 Z_APDU *apdu = gdu->u.z3950;
563 if (apdu->which == Z_APDU_presentResponse)
565 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
568 else if (apdu->which == Z_APDU_searchResponse)
570 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
576 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
578 Z_PresentRequest *req = apdu_req->u.presentRequest;
579 std::string resultSetId = req->resultSetId;
582 Sets_it sets_it = m_sets.find(resultSetId);
583 if (sets_it == m_sets.end())
586 odr.create_presentResponse(
588 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
589 resultSetId.c_str());
590 package.response() = apdu;
594 new mp::Session(sets_it->second.m_backend->m_backend_session);
596 // sending present to backend
597 Package present_package(*id, package.origin());
598 present_package.copy_filter(package);
600 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
602 present_package.request() = yazpp_1::GDU(apdu_req);
604 present_package.move(sets_it->second.m_backend->m_route);
606 fixup_package(present_package, sets_it->second.m_backend);
608 if (present_package.session().is_closed())
610 package.response() = present_package.response();
611 package.session().close();
616 package.response() = present_package.response();
621 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
623 Z_ScanRequest *req = apdu_req->u.scanRequest;
627 std::list<std::string> databases;
629 for (i = 0; i<req->num_databaseNames; i++)
630 databases.push_back(req->databaseNames[i]);
633 // pick up any existing backend with a database match
634 std::list<BackendPtr>::const_iterator map_it;
635 map_it = m_backend_list.begin();
636 for (; map_it != m_backend_list.end(); map_it++)
638 BackendPtr tmp = *map_it;
639 if (tmp->m_frontend_databases == databases)
642 if (map_it != m_backend_list.end())
644 if (!b) // no backend yet. Must create a new one
648 b = init_backend(databases, package, error_code, addinfo);
651 // did not get a backend (unavailable somehow?)
653 odr.create_scanResponse(
654 apdu_req, error_code, addinfo.c_str());
655 package.response() = apdu;
660 // sending scan to backend
661 Package scan_package(b->m_backend_session, package.origin());
663 scan_package.copy_filter(package);
665 // pick first targets spec and move the databases from it ..
666 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
667 if (t_it != b->m_targets.end())
669 mp::util::set_databases_from_zurl(odr, *t_it,
670 &req->num_databaseNames,
671 &req->databaseNames);
673 scan_package.request() = yazpp_1::GDU(apdu_req);
675 scan_package.move(b->m_route);
677 if (scan_package.session().is_closed())
679 package.response() = scan_package.response();
680 package.session().close();
683 package.response() = scan_package.response();
687 void yf::VirtualDB::add_map_db2targets(std::string db,
688 std::list<std::string> targets,
691 m_p->m_maps.push_back(
692 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
696 void yf::VirtualDB::add_map_db2target(std::string db,
700 std::list<std::string> targets;
701 targets.push_back(target);
703 add_map_db2targets(db, targets, route);
706 void yf::VirtualDB::process(mp::Package &package) const
708 FrontendPtr f = m_p->get_frontend(package);
710 Z_GDU *gdu = package.request().get();
712 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
713 Z_APDU_initRequest && !f->m_is_virtual)
715 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
717 std::list<std::string> vhosts;
718 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
720 if (vhosts.size() > 0 && m_p->pass_vhosts)
729 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
730 Z_InitResponse *resp = apdu->u.initResponse;
733 static const int masks[] = {
736 Z_Options_namedResultSets,
740 for (i = 0; masks[i] != -1; i++)
741 if (ODR_MASK_GET(req->options, masks[i]))
742 ODR_MASK_SET(resp->options, masks[i]);
744 static const int versions[] = {
750 for (i = 0; versions[i] != -1; i++)
751 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
752 ODR_MASK_SET(resp->protocolVersion, versions[i]);
756 package.response() = apdu;
757 f->m_is_virtual = true;
760 else if (!f->m_is_virtual)
762 else if (gdu && gdu->which == Z_GDU_Z3950)
764 Z_APDU *apdu = gdu->u.z3950;
765 if (apdu->which == Z_APDU_initRequest)
769 package.response() = odr.create_close(
771 Z_Close_protocolError,
774 package.session().close();
776 else if (apdu->which == Z_APDU_searchRequest)
778 f->search(package, apdu);
780 else if (apdu->which == Z_APDU_presentRequest)
782 f->present(package, apdu);
784 else if (apdu->which == Z_APDU_scanRequest)
786 f->scan(package, apdu);
788 else if (apdu->which == Z_APDU_close)
790 package.session().close();
796 package.response() = odr.create_close(
797 apdu, Z_Close_protocolError,
798 "unsupported APDU in filter_virt_db");
800 package.session().close();
803 m_p->release_frontend(package);
807 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
809 for (ptr = ptr->children; ptr; ptr = ptr->next)
811 if (ptr->type != XML_ELEMENT_NODE)
813 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
815 m_p->pass_vhosts = mp::xml::get_bool(ptr->children, false);
817 else if (!strcmp((const char *) ptr->name, "virtual"))
819 std::string database;
820 std::list<std::string> targets;
821 xmlNode *v_node = ptr->children;
822 for (; v_node; v_node = v_node->next)
824 if (v_node->type != XML_ELEMENT_NODE)
827 if (mp::xml::is_element_mp(v_node, "database"))
828 database = mp::xml::get_text(v_node);
829 else if (mp::xml::is_element_mp(v_node, "target"))
830 targets.push_back(mp::xml::get_text(v_node));
832 throw mp::filter::FilterException
834 + std::string((const char *) v_node->name)
835 + " in virtual section"
838 std::string route = mp::xml::get_route(ptr);
839 add_map_db2targets(database, targets, route);
843 throw mp::filter::FilterException
845 + std::string((const char *) ptr->name)
846 + " in virt_db filter");
851 static mp::filter::Base* filter_creator()
853 return new mp::filter::VirtualDB;
857 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
868 * c-file-style: "Stroustrup"
869 * indent-tabs-mode: nil
871 * vim: shiftwidth=4 tabstop=8 expandtab