1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2009 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;
118 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
119 std::list<std::string> databases)
121 std::list<BackendPtr>::const_iterator map_it;
122 map_it = m_backend_list.begin();
123 for (; map_it != m_backend_list.end(); map_it++)
124 if ((*map_it)->m_frontend_databases == databases)
130 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
131 std::list<std::string> databases, int &error_code, std::string &addinfo)
133 BackendPtr b(new Backend);
134 std::list<std::string>::const_iterator db_it = databases.begin();
136 b->m_number_of_sets = 0;
137 b->m_frontend_databases = databases;
138 b->m_named_result_sets = false;
140 bool first_route = true;
142 std::map<std::string,bool> targets_dedup;
143 for (; db_it != databases.end(); db_it++)
145 std::map<std::string, VirtualDB::Map>::iterator map_it;
146 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
147 if (map_it == m_p->m_maps.end()) // database not found
149 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
154 std::list<std::string>::const_iterator t_it =
155 map_it->second.m_targets.begin();
156 for (; t_it != map_it->second.m_targets.end(); t_it++) {
157 if (!targets_dedup[*t_it])
159 targets_dedup[*t_it] = true;
160 b->m_targets.push_back(*t_it);
164 // see if we have a route conflict.
165 if (!first_route && b->m_route != map_it->second.m_route)
167 // we have a conflict..
168 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
172 b->m_route = map_it->second.m_route;
178 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
179 std::list<std::string> databases, mp::Package &package,
180 int &error_code, std::string &addinfo)
182 BackendPtr b = create_backend_from_databases(databases, error_code,
186 Package init_package(b->m_backend_session, package.origin());
187 init_package.copy_filter(package);
191 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
193 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
195 Z_InitRequest *req = init_apdu->u.initRequest;
197 // copy stuff from Frontend Init Request
198 Z_GDU *org_gdu = m_init_gdu.get();
199 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
201 req->idAuthentication = org_init->idAuthentication;
202 req->implementationId = org_init->implementationId;
203 req->implementationName = org_init->implementationName;
204 req->implementationVersion = org_init->implementationVersion;
206 ODR_MASK_SET(req->options, Z_Options_search);
207 ODR_MASK_SET(req->options, Z_Options_present);
208 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
209 ODR_MASK_SET(req->options, Z_Options_scan);
211 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
212 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
213 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
215 init_package.request() = init_apdu;
217 init_package.move(b->m_route); // sending init
219 Z_GDU *gdu = init_package.response().get();
220 // we hope to get an init response
221 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
224 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
225 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
227 b->m_named_result_sets = true;
231 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
232 mp::util::get_init_diagnostics(res, error_code, addinfo);
239 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
240 // addinfo = database;
244 if (init_package.session().is_closed())
246 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
247 // addinfo = database;
252 m_backend_list.push_back(b);
256 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
258 Z_SearchRequest *req = apdu_req->u.searchRequest;
260 std::string resultSetId = req->resultSetName;
263 std::list<std::string> databases;
265 for (i = 0; i<req->num_databaseNames; i++)
266 databases.push_back(req->databaseNames[i]);
268 BackendPtr b; // null for now
269 Sets_it sets_it = m_sets.find(req->resultSetName);
270 if (sets_it != m_sets.end())
272 // result set already exist
273 // if replace indicator is off: we return diagnostic if
274 // result set already exist.
275 if (*req->replaceIndicator == 0)
278 odr.create_searchResponse(
280 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
282 package.response() = apdu;
286 sets_it->second.m_backend->m_number_of_sets--;
288 // pick up any existing backend with a database match
289 std::list<BackendPtr>::const_iterator map_it;
290 map_it = m_backend_list.begin();
291 for (; map_it != m_backend_list.end(); map_it++)
293 BackendPtr tmp = *map_it;
294 if (tmp->m_frontend_databases == databases)
297 if (map_it != m_backend_list.end())
304 // pick up any existing database with named result sets ..
305 // or one which has no result sets.. yet.
306 std::list<BackendPtr>::const_iterator map_it;
307 map_it = m_backend_list.begin();
308 for (; map_it != m_backend_list.end(); map_it++)
310 BackendPtr tmp = *map_it;
311 if (tmp->m_frontend_databases == databases &&
312 (tmp->m_named_result_sets ||
313 tmp->m_number_of_sets == 0))
316 if (map_it != m_backend_list.end())
319 if (!b) // no backend yet. Must create a new one
323 b = init_backend(databases, package, error_code, addinfo);
326 // did not get a backend (unavailable somehow?)
329 odr.create_searchResponse(
330 apdu_req, error_code, addinfo.c_str());
331 package.response() = apdu;
335 m_sets.erase(req->resultSetName);
336 // sending search to backend
337 Package search_package(b->m_backend_session, package.origin());
339 search_package.copy_filter(package);
341 std::string backend_setname;
342 if (b->m_named_result_sets)
344 backend_setname = std::string(req->resultSetName);
348 backend_setname = "default";
349 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
352 // pick first targets spec and move the databases from it ..
353 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
354 if (t_it != b->m_targets.end())
356 mp::util::set_databases_from_zurl(odr, *t_it,
357 &req->num_databaseNames,
358 &req->databaseNames);
361 *req->replaceIndicator = 1;
363 search_package.request() = yazpp_1::GDU(apdu_req);
365 search_package.move(b->m_route);
367 if (search_package.session().is_closed())
369 package.response() = search_package.response();
370 package.session().close();
373 b->m_number_of_sets++;
375 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
376 fixup_package(search_package, b);
377 package.response() = search_package.response();
380 yf::VirtualDB::Frontend::Frontend(Rep *rep)
383 m_is_virtual = false;
386 void yf::VirtualDB::Frontend::close(mp::Package &package)
388 std::list<BackendPtr>::const_iterator b_it;
390 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
392 (*b_it)->m_backend_session.close();
393 Package close_package((*b_it)->m_backend_session, package.origin());
394 close_package.copy_filter(package);
395 close_package.move((*b_it)->m_route);
397 m_backend_list.clear();
400 yf::VirtualDB::Frontend::~Frontend()
404 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
406 boost::mutex::scoped_lock lock(m_mutex);
408 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
412 it = m_clients.find(package.session());
413 if (it == m_clients.end())
416 if (!it->second->m_in_use)
418 it->second->m_in_use = true;
421 m_cond_session_ready.wait(lock);
423 FrontendPtr f(new Frontend(this));
424 m_clients[package.session()] = f;
429 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
431 boost::mutex::scoped_lock lock(m_mutex);
432 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
434 it = m_clients.find(package.session());
435 if (it != m_clients.end())
437 if (package.session().is_closed())
439 it->second->close(package);
444 it->second->m_in_use = false;
446 m_cond_session_ready.notify_all();
450 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
451 : m_backend(b), m_setname(setname)
456 yf::VirtualDB::Set::Set()
461 yf::VirtualDB::Set::~Set()
465 yf::VirtualDB::Map::Map(std::list<std::string> targets, std::string route)
466 : m_targets(targets), m_route(route)
470 yf::VirtualDB::Map::Map()
474 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
476 m_p->pass_vhosts = false;
479 yf::VirtualDB::~VirtualDB() {
482 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
485 if (npr->databaseName)
487 std::string b_database = std::string(npr->databaseName);
489 // consider each of the frontend databases..
490 std::list<std::string>::const_iterator db_it;
491 for (db_it = b->m_frontend_databases.begin();
492 db_it != b->m_frontend_databases.end(); db_it++)
494 // see which target it corresponds to.. (if any)
495 std::map<std::string,VirtualDB::Map>::const_iterator map_it;
497 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
498 if (map_it != m_p->m_maps.end())
500 VirtualDB::Map m = map_it->second;
502 std::list<std::string>::const_iterator t;
503 for (t = m.m_targets.begin(); t != m.m_targets.end(); t++)
505 if (*t == b_database)
507 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[mp::util::database_name_normalize(db)]
674 = VirtualDB::Map(targets, route);
678 void yf::VirtualDB::add_map_db2target(std::string db,
682 std::list<std::string> targets;
683 targets.push_back(target);
685 m_p->m_maps[mp::util::database_name_normalize(db)]
686 = VirtualDB::Map(targets, route);
689 void yf::VirtualDB::process(mp::Package &package) const
691 FrontendPtr f = m_p->get_frontend(package);
693 Z_GDU *gdu = package.request().get();
695 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
696 Z_APDU_initRequest && !f->m_is_virtual)
698 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
700 std::list<std::string> vhosts;
701 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
703 if (vhosts.size() > 0 && m_p->pass_vhosts)
712 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
713 Z_InitResponse *resp = apdu->u.initResponse;
716 static const int masks[] = {
719 Z_Options_namedResultSets,
723 for (i = 0; masks[i] != -1; i++)
724 if (ODR_MASK_GET(req->options, masks[i]))
725 ODR_MASK_SET(resp->options, masks[i]);
727 static const int versions[] = {
733 for (i = 0; versions[i] != -1; i++)
734 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
735 ODR_MASK_SET(resp->protocolVersion, versions[i]);
739 package.response() = apdu;
740 f->m_is_virtual = true;
743 else if (!f->m_is_virtual)
745 else if (gdu && gdu->which == Z_GDU_Z3950)
747 Z_APDU *apdu = gdu->u.z3950;
748 if (apdu->which == Z_APDU_initRequest)
752 package.response() = odr.create_close(
754 Z_Close_protocolError,
757 package.session().close();
759 else if (apdu->which == Z_APDU_searchRequest)
761 f->search(package, apdu);
763 else if (apdu->which == Z_APDU_presentRequest)
765 f->present(package, apdu);
767 else if (apdu->which == Z_APDU_scanRequest)
769 f->scan(package, apdu);
771 else if (apdu->which == Z_APDU_close)
773 package.session().close();
779 package.response() = odr.create_close(
780 apdu, Z_Close_protocolError,
781 "unsupported APDU in filter_virt_db");
783 package.session().close();
786 m_p->release_frontend(package);
790 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
792 for (ptr = ptr->children; ptr; ptr = ptr->next)
794 if (ptr->type != XML_ELEMENT_NODE)
796 if (!strcmp((const char *) ptr->name, "pass-vhosts"))
798 m_p->pass_vhosts = mp::xml::get_bool(ptr->children, false);
800 else if (!strcmp((const char *) ptr->name, "virtual"))
802 std::string database;
803 std::list<std::string> targets;
804 xmlNode *v_node = ptr->children;
805 for (; v_node; v_node = v_node->next)
807 if (v_node->type != XML_ELEMENT_NODE)
810 if (mp::xml::is_element_mp(v_node, "database"))
811 database = mp::xml::get_text(v_node);
812 else if (mp::xml::is_element_mp(v_node, "target"))
813 targets.push_back(mp::xml::get_text(v_node));
815 throw mp::filter::FilterException
817 + std::string((const char *) v_node->name)
818 + " in virtual section"
821 std::string route = mp::xml::get_route(ptr);
822 add_map_db2targets(database, targets, route);
826 throw mp::filter::FilterException
828 + std::string((const char *) ptr->name)
829 + " in virt_db filter");
834 static mp::filter::Base* filter_creator()
836 return new mp::filter::VirtualDB;
840 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
851 * c-file-style: "Stroustrup"
852 * indent-tabs-mode: nil
854 * vim: shiftwidth=4 tabstop=8 expandtab