1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2008 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
22 #include "package.hpp"
24 #include <boost/thread/mutex.hpp>
25 #include <boost/thread/condition.hpp>
26 #include <boost/shared_ptr.hpp>
29 #include "filter_virt_db.hpp"
32 #include <yaz/otherinfo.h>
33 #include <yaz/diagbib1.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::list<std::string> targets, std::string route);
55 std::list<std::string> m_targets;
58 struct VirtualDB::Backend {
59 mp::Session m_backend_session;
60 std::list<std::string> m_frontend_databases;
61 std::list<std::string> m_targets;
63 bool m_named_result_sets;
66 struct VirtualDB::Frontend {
69 mp::Session m_session;
72 yazpp_1::GDU m_init_gdu;
73 std::list<BackendPtr> m_backend_list;
74 std::map<std::string,VirtualDB::Set> m_sets;
76 void search(Package &package, Z_APDU *apdu);
77 void present(Package &package, Z_APDU *apdu);
78 void scan(Package &package, Z_APDU *apdu);
80 void close(Package &package);
81 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
83 void fixup_package(Package &p, BackendPtr b);
84 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
86 void fixup_npr_records(ODR odr, Z_Records *records,
89 BackendPtr lookup_backend_from_databases(
90 std::list<std::string> databases);
91 BackendPtr create_backend_from_databases(
92 std::list<std::string> databases,
94 std::string &failing_database);
96 BackendPtr init_backend(std::list<std::string> database,
98 int &error_code, std::string &addinfo);
101 class VirtualDB::Rep {
102 friend class VirtualDB;
103 friend struct Frontend;
105 FrontendPtr get_frontend(Package &package);
106 void release_frontend(Package &package);
108 std::map<std::string, VirtualDB::Map>m_maps;
109 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
110 boost::mutex m_mutex;
111 boost::condition m_cond_session_ready;
112 std::map<mp::Session, FrontendPtr> m_clients;
117 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
118 std::list<std::string> databases)
120 std::list<BackendPtr>::const_iterator map_it;
121 map_it = m_backend_list.begin();
122 for (; map_it != m_backend_list.end(); map_it++)
123 if ((*map_it)->m_frontend_databases == databases)
129 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
130 std::list<std::string> databases, int &error_code, std::string &addinfo)
132 BackendPtr b(new Backend);
133 std::list<std::string>::const_iterator db_it = databases.begin();
135 b->m_number_of_sets = 0;
136 b->m_frontend_databases = databases;
137 b->m_named_result_sets = false;
139 bool first_route = true;
141 std::map<std::string,bool> targets_dedup;
142 for (; db_it != databases.end(); db_it++)
144 std::map<std::string, VirtualDB::Map>::iterator map_it;
145 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
146 if (map_it == m_p->m_maps.end()) // database not found
148 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
153 std::list<std::string>::const_iterator t_it =
154 map_it->second.m_targets.begin();
155 for (; t_it != map_it->second.m_targets.end(); t_it++) {
156 if (!targets_dedup[*t_it])
158 targets_dedup[*t_it] = true;
159 b->m_targets.push_back(*t_it);
163 // see if we have a route conflict.
164 if (!first_route && b->m_route != map_it->second.m_route)
166 // we have a conflict..
167 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
171 b->m_route = map_it->second.m_route;
177 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
178 std::list<std::string> databases, mp::Package &package,
179 int &error_code, std::string &addinfo)
181 BackendPtr b = create_backend_from_databases(databases, error_code,
185 Package init_package(b->m_backend_session, package.origin());
186 init_package.copy_filter(package);
190 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
192 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
194 Z_InitRequest *req = init_apdu->u.initRequest;
196 // copy stuff from Frontend Init Request
197 Z_GDU *org_gdu = m_init_gdu.get();
198 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
200 req->idAuthentication = org_init->idAuthentication;
201 req->implementationId = org_init->implementationId;
202 req->implementationName = org_init->implementationName;
203 req->implementationVersion = org_init->implementationVersion;
205 ODR_MASK_SET(req->options, Z_Options_search);
206 ODR_MASK_SET(req->options, Z_Options_present);
207 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
208 ODR_MASK_SET(req->options, Z_Options_scan);
210 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
211 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
212 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
214 init_package.request() = init_apdu;
216 init_package.move(b->m_route); // sending init
218 Z_GDU *gdu = init_package.response().get();
219 // we hope to get an init response
220 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
223 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
224 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
226 b->m_named_result_sets = true;
230 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
231 mp::util::get_init_diagnostics(res, error_code, addinfo);
238 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
239 // addinfo = database;
243 if (init_package.session().is_closed())
245 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
246 // addinfo = database;
251 m_backend_list.push_back(b);
255 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
257 Z_SearchRequest *req = apdu_req->u.searchRequest;
259 std::string resultSetId = req->resultSetName;
262 std::list<std::string> databases;
264 for (i = 0; i<req->num_databaseNames; i++)
265 databases.push_back(req->databaseNames[i]);
267 BackendPtr b; // null for now
268 Sets_it sets_it = m_sets.find(req->resultSetName);
269 if (sets_it != m_sets.end())
271 // result set already exist
272 // if replace indicator is off: we return diagnostic if
273 // result set already exist.
274 if (*req->replaceIndicator == 0)
277 odr.create_searchResponse(
279 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
281 package.response() = apdu;
285 sets_it->second.m_backend->m_number_of_sets--;
287 // pick up any existing backend with a database match
288 std::list<BackendPtr>::const_iterator map_it;
289 map_it = m_backend_list.begin();
290 for (; map_it != m_backend_list.end(); map_it++)
292 BackendPtr tmp = *map_it;
293 if (tmp->m_frontend_databases == databases)
296 if (map_it != m_backend_list.end())
303 // pick up any existing database with named result sets ..
304 // or one which has no result sets.. yet.
305 std::list<BackendPtr>::const_iterator map_it;
306 map_it = m_backend_list.begin();
307 for (; map_it != m_backend_list.end(); map_it++)
309 BackendPtr tmp = *map_it;
310 if (tmp->m_frontend_databases == databases &&
311 (tmp->m_named_result_sets ||
312 tmp->m_number_of_sets == 0))
315 if (map_it != m_backend_list.end())
318 if (!b) // no backend yet. Must create a new one
322 b = init_backend(databases, package, error_code, addinfo);
325 // did not get a backend (unavailable somehow?)
328 odr.create_searchResponse(
329 apdu_req, error_code, addinfo.c_str());
330 package.response() = apdu;
334 m_sets.erase(req->resultSetName);
335 // sending search to backend
336 Package search_package(b->m_backend_session, package.origin());
338 search_package.copy_filter(package);
340 std::string backend_setname;
341 if (b->m_named_result_sets)
343 backend_setname = std::string(req->resultSetName);
347 backend_setname = "default";
348 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
351 // pick first targets spec and move the databases from it ..
352 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
353 if (t_it != b->m_targets.end())
355 mp::util::set_databases_from_zurl(odr, *t_it,
356 &req->num_databaseNames,
357 &req->databaseNames);
360 *req->replaceIndicator = 1;
362 search_package.request() = yazpp_1::GDU(apdu_req);
364 search_package.move(b->m_route);
366 if (search_package.session().is_closed())
368 package.response() = search_package.response();
369 package.session().close();
372 b->m_number_of_sets++;
374 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
375 fixup_package(search_package, b);
376 package.response() = search_package.response();
379 yf::VirtualDB::Frontend::Frontend(Rep *rep)
382 m_is_virtual = false;
385 void yf::VirtualDB::Frontend::close(mp::Package &package)
387 std::list<BackendPtr>::const_iterator b_it;
389 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
391 (*b_it)->m_backend_session.close();
392 Package close_package((*b_it)->m_backend_session, package.origin());
393 close_package.copy_filter(package);
394 close_package.move((*b_it)->m_route);
396 m_backend_list.clear();
399 yf::VirtualDB::Frontend::~Frontend()
403 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
405 boost::mutex::scoped_lock lock(m_mutex);
407 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
411 it = m_clients.find(package.session());
412 if (it == m_clients.end())
415 if (!it->second->m_in_use)
417 it->second->m_in_use = true;
420 m_cond_session_ready.wait(lock);
422 FrontendPtr f(new Frontend(this));
423 m_clients[package.session()] = f;
428 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
430 boost::mutex::scoped_lock lock(m_mutex);
431 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
433 it = m_clients.find(package.session());
434 if (it != m_clients.end())
436 if (package.session().is_closed())
438 it->second->close(package);
443 it->second->m_in_use = false;
445 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::list<std::string> targets, std::string route)
465 : m_targets(targets), m_route(route)
469 yf::VirtualDB::Map::Map()
473 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
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::map<std::string,VirtualDB::Map>::const_iterator map_it;
495 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
496 if (map_it != m_p->m_maps.end())
498 VirtualDB::Map m = map_it->second;
500 std::list<std::string>::const_iterator t;
501 for (t = m.m_targets.begin(); t != m.m_targets.end(); t++)
503 if (*t == b_database)
505 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
512 db_it = b->m_frontend_databases.begin();
513 if (db_it != b->m_frontend_databases.end())
515 std::string database = *db_it;
516 npr->databaseName = odr_strdup(odr, database.c_str());
521 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
524 if (records && records->which == Z_Records_DBOSD)
526 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
528 for (i = 0; i < nprlist->num_records; i++)
530 fixup_npr_record(odr, nprlist->records[i], b);
535 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
537 Z_GDU *gdu = p.response().get();
540 if (gdu && gdu->which == Z_GDU_Z3950)
542 Z_APDU *apdu = gdu->u.z3950;
543 if (apdu->which == Z_APDU_presentResponse)
545 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
548 else if (apdu->which == Z_APDU_searchResponse)
550 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
556 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
558 Z_PresentRequest *req = apdu_req->u.presentRequest;
559 std::string resultSetId = req->resultSetId;
562 Sets_it sets_it = m_sets.find(resultSetId);
563 if (sets_it == m_sets.end())
566 odr.create_presentResponse(
568 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
569 resultSetId.c_str());
570 package.response() = apdu;
574 new mp::Session(sets_it->second.m_backend->m_backend_session);
576 // sending present to backend
577 Package present_package(*id, package.origin());
578 present_package.copy_filter(package);
580 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
582 present_package.request() = yazpp_1::GDU(apdu_req);
584 present_package.move(sets_it->second.m_backend->m_route);
586 fixup_package(present_package, sets_it->second.m_backend);
588 if (present_package.session().is_closed())
590 package.response() = present_package.response();
591 package.session().close();
596 package.response() = present_package.response();
601 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
603 Z_ScanRequest *req = apdu_req->u.scanRequest;
607 std::list<std::string> databases;
609 for (i = 0; i<req->num_databaseNames; i++)
610 databases.push_back(req->databaseNames[i]);
613 // pick up any existing backend with a database match
614 std::list<BackendPtr>::const_iterator map_it;
615 map_it = m_backend_list.begin();
616 for (; map_it != m_backend_list.end(); map_it++)
618 BackendPtr tmp = *map_it;
619 if (tmp->m_frontend_databases == databases)
622 if (map_it != m_backend_list.end())
624 if (!b) // no backend yet. Must create a new one
628 b = init_backend(databases, package, error_code, addinfo);
631 // did not get a backend (unavailable somehow?)
633 odr.create_scanResponse(
634 apdu_req, error_code, addinfo.c_str());
635 package.response() = apdu;
640 // sending scan to backend
641 Package scan_package(b->m_backend_session, package.origin());
643 scan_package.copy_filter(package);
645 // pick first targets spec and move the databases from it ..
646 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
647 if (t_it != b->m_targets.end())
649 mp::util::set_databases_from_zurl(odr, *t_it,
650 &req->num_databaseNames,
651 &req->databaseNames);
653 scan_package.request() = yazpp_1::GDU(apdu_req);
655 scan_package.move(b->m_route);
657 if (scan_package.session().is_closed())
659 package.response() = scan_package.response();
660 package.session().close();
663 package.response() = scan_package.response();
667 void yf::VirtualDB::add_map_db2targets(std::string db,
668 std::list<std::string> targets,
671 m_p->m_maps[mp::util::database_name_normalize(db)]
672 = VirtualDB::Map(targets, route);
676 void yf::VirtualDB::add_map_db2target(std::string db,
680 std::list<std::string> targets;
681 targets.push_back(target);
683 m_p->m_maps[mp::util::database_name_normalize(db)]
684 = VirtualDB::Map(targets, route);
687 void yf::VirtualDB::process(mp::Package &package) const
689 FrontendPtr f = m_p->get_frontend(package);
691 Z_GDU *gdu = package.request().get();
693 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
694 Z_APDU_initRequest && !f->m_is_virtual)
696 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
698 std::list<std::string> vhosts;
699 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
700 if (vhosts.size() == 0)
705 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
706 Z_InitResponse *resp = apdu->u.initResponse;
709 static const int masks[] = {
712 Z_Options_namedResultSets,
716 for (i = 0; masks[i] != -1; i++)
717 if (ODR_MASK_GET(req->options, masks[i]))
718 ODR_MASK_SET(resp->options, masks[i]);
720 static const int versions[] = {
726 for (i = 0; versions[i] != -1; i++)
727 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
728 ODR_MASK_SET(resp->protocolVersion, versions[i]);
732 package.response() = apdu;
733 f->m_is_virtual = true;
738 else if (!f->m_is_virtual)
740 else if (gdu && gdu->which == Z_GDU_Z3950)
742 Z_APDU *apdu = gdu->u.z3950;
743 if (apdu->which == Z_APDU_initRequest)
747 package.response() = odr.create_close(
749 Z_Close_protocolError,
752 package.session().close();
754 else if (apdu->which == Z_APDU_searchRequest)
756 f->search(package, apdu);
758 else if (apdu->which == Z_APDU_presentRequest)
760 f->present(package, apdu);
762 else if (apdu->which == Z_APDU_scanRequest)
764 f->scan(package, apdu);
766 else if (apdu->which == Z_APDU_close)
768 package.session().close();
774 package.response() = odr.create_close(
775 apdu, Z_Close_protocolError,
776 "unsupported APDU in filter_virt_db");
778 package.session().close();
781 m_p->release_frontend(package);
785 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
787 for (ptr = ptr->children; ptr; ptr = ptr->next)
789 if (ptr->type != XML_ELEMENT_NODE)
791 if (!strcmp((const char *) ptr->name, "virtual"))
793 std::string database;
794 std::list<std::string> targets;
795 xmlNode *v_node = ptr->children;
796 for (; v_node; v_node = v_node->next)
798 if (v_node->type != XML_ELEMENT_NODE)
801 if (mp::xml::is_element_mp(v_node, "database"))
802 database = mp::xml::get_text(v_node);
803 else if (mp::xml::is_element_mp(v_node, "target"))
804 targets.push_back(mp::xml::get_text(v_node));
806 throw mp::filter::FilterException
808 + std::string((const char *) v_node->name)
809 + " in virtual section"
812 std::string route = mp::xml::get_route(ptr);
813 add_map_db2targets(database, targets, route);
817 throw mp::filter::FilterException
819 + std::string((const char *) ptr->name)
820 + " in virt_db filter");
825 static mp::filter::Base* filter_creator()
827 return new mp::filter::VirtualDB;
831 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
842 * indent-tabs-mode: nil
843 * c-file-style: "stroustrup"
845 * vim: shiftwidth=4 tabstop=8 expandtab