1 /* $Id: filter_virt_db.cpp,v 1.54 2008-02-20 15:07:52 adam Exp $
2 Copyright (c) 2005-2007, Index Data.
4 This file is part of Metaproxy.
6 Metaproxy is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with Metaproxy; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
21 /* $Id: filter_virt_db.cpp,v 1.54 2008-02-20 15:07:52 adam Exp $
22 Copyright (c) 2005-2007, Index Data.
24 See the LICENSE file for details
30 #include "package.hpp"
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
34 #include <boost/shared_ptr.hpp>
37 #include "filter_virt_db.hpp"
40 #include <yaz/otherinfo.h>
41 #include <yaz/diagbib1.h>
46 namespace mp = metaproxy_1;
47 namespace yf = mp::filter;
49 namespace metaproxy_1 {
52 struct VirtualDB::Set {
53 Set(BackendPtr b, std::string setname);
58 std::string m_setname;
60 struct VirtualDB::Map {
61 Map(std::list<std::string> targets, std::string route);
63 std::list<std::string> m_targets;
66 struct VirtualDB::Backend {
67 mp::Session m_backend_session;
68 std::list<std::string> m_frontend_databases;
69 std::list<std::string> m_targets;
71 bool m_named_result_sets;
74 struct VirtualDB::Frontend {
77 mp::Session m_session;
80 yazpp_1::GDU m_init_gdu;
81 std::list<BackendPtr> m_backend_list;
82 std::map<std::string,VirtualDB::Set> m_sets;
84 void search(Package &package, Z_APDU *apdu);
85 void present(Package &package, Z_APDU *apdu);
86 void scan(Package &package, Z_APDU *apdu);
88 void close(Package &package);
89 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
91 void fixup_package(Package &p, BackendPtr b);
92 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
94 void fixup_npr_records(ODR odr, Z_Records *records,
97 BackendPtr lookup_backend_from_databases(
98 std::list<std::string> databases);
99 BackendPtr create_backend_from_databases(
100 std::list<std::string> databases,
102 std::string &failing_database);
104 BackendPtr init_backend(std::list<std::string> database,
106 int &error_code, std::string &addinfo);
109 class VirtualDB::Rep {
110 friend class VirtualDB;
111 friend struct Frontend;
113 FrontendPtr get_frontend(Package &package);
114 void release_frontend(Package &package);
116 std::map<std::string, VirtualDB::Map>m_maps;
117 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
118 boost::mutex m_mutex;
119 boost::condition m_cond_session_ready;
120 std::map<mp::Session, FrontendPtr> m_clients;
125 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
126 std::list<std::string> databases)
128 std::list<BackendPtr>::const_iterator map_it;
129 map_it = m_backend_list.begin();
130 for (; map_it != m_backend_list.end(); map_it++)
131 if ((*map_it)->m_frontend_databases == databases)
137 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
138 std::list<std::string> databases, int &error_code, std::string &addinfo)
140 BackendPtr b(new Backend);
141 std::list<std::string>::const_iterator db_it = databases.begin();
143 b->m_number_of_sets = 0;
144 b->m_frontend_databases = databases;
145 b->m_named_result_sets = false;
147 bool first_route = true;
149 std::map<std::string,bool> targets_dedup;
150 for (; db_it != databases.end(); db_it++)
152 std::map<std::string, VirtualDB::Map>::iterator map_it;
153 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
154 if (map_it == m_p->m_maps.end()) // database not found
156 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
161 std::list<std::string>::const_iterator t_it =
162 map_it->second.m_targets.begin();
163 for (; t_it != map_it->second.m_targets.end(); t_it++) {
164 if (!targets_dedup[*t_it])
166 targets_dedup[*t_it] = true;
167 b->m_targets.push_back(*t_it);
171 // see if we have a route conflict.
172 if (!first_route && b->m_route != map_it->second.m_route)
174 // we have a conflict..
175 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
179 b->m_route = map_it->second.m_route;
185 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
186 std::list<std::string> databases, mp::Package &package,
187 int &error_code, std::string &addinfo)
189 BackendPtr b = create_backend_from_databases(databases, error_code,
193 Package init_package(b->m_backend_session, package.origin());
194 init_package.copy_filter(package);
198 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
200 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
202 Z_InitRequest *req = init_apdu->u.initRequest;
204 // copy stuff from Frontend Init Request
205 Z_GDU *org_gdu = m_init_gdu.get();
206 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
208 req->idAuthentication = org_init->idAuthentication;
209 req->implementationId = org_init->implementationId;
210 req->implementationName = org_init->implementationName;
211 req->implementationVersion = org_init->implementationVersion;
213 ODR_MASK_SET(req->options, Z_Options_search);
214 ODR_MASK_SET(req->options, Z_Options_present);
215 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
216 ODR_MASK_SET(req->options, Z_Options_scan);
218 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
219 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
220 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
222 init_package.request() = init_apdu;
224 init_package.move(b->m_route); // sending init
226 Z_GDU *gdu = init_package.response().get();
227 // we hope to get an init response
228 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
231 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
232 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
234 b->m_named_result_sets = true;
238 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
239 mp::util::get_init_diagnostics(res, error_code, addinfo);
246 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
247 // addinfo = database;
251 if (init_package.session().is_closed())
253 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
254 // addinfo = database;
259 m_backend_list.push_back(b);
263 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
265 Z_SearchRequest *req = apdu_req->u.searchRequest;
267 std::string resultSetId = req->resultSetName;
270 std::list<std::string> databases;
272 for (i = 0; i<req->num_databaseNames; i++)
273 databases.push_back(req->databaseNames[i]);
275 BackendPtr b; // null for now
276 Sets_it sets_it = m_sets.find(req->resultSetName);
277 if (sets_it != m_sets.end())
279 // result set already exist
280 // if replace indicator is off: we return diagnostic if
281 // result set already exist.
282 if (*req->replaceIndicator == 0)
285 odr.create_searchResponse(
287 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
289 package.response() = apdu;
293 sets_it->second.m_backend->m_number_of_sets--;
295 // pick up any existing backend with a database match
296 std::list<BackendPtr>::const_iterator map_it;
297 map_it = m_backend_list.begin();
298 for (; map_it != m_backend_list.end(); map_it++)
300 BackendPtr tmp = *map_it;
301 if (tmp->m_frontend_databases == databases)
304 if (map_it != m_backend_list.end())
311 // pick up any existing database with named result sets ..
312 // or one which has no result sets.. yet.
313 std::list<BackendPtr>::const_iterator map_it;
314 map_it = m_backend_list.begin();
315 for (; map_it != m_backend_list.end(); map_it++)
317 BackendPtr tmp = *map_it;
318 if (tmp->m_frontend_databases == databases &&
319 (tmp->m_named_result_sets ||
320 tmp->m_number_of_sets == 0))
323 if (map_it != m_backend_list.end())
326 if (!b) // no backend yet. Must create a new one
330 b = init_backend(databases, package, error_code, addinfo);
333 // did not get a backend (unavailable somehow?)
336 odr.create_searchResponse(
337 apdu_req, error_code, addinfo.c_str());
338 package.response() = apdu;
342 m_sets.erase(req->resultSetName);
343 // sending search to backend
344 Package search_package(b->m_backend_session, package.origin());
346 search_package.copy_filter(package);
348 std::string backend_setname;
349 if (b->m_named_result_sets)
351 backend_setname = std::string(req->resultSetName);
355 backend_setname = "default";
356 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
359 // pick first targets spec and move the databases from it ..
360 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
361 if (t_it != b->m_targets.end())
363 mp::util::set_databases_from_zurl(odr, *t_it,
364 &req->num_databaseNames,
365 &req->databaseNames);
368 *req->replaceIndicator = 1;
370 search_package.request() = yazpp_1::GDU(apdu_req);
372 search_package.move(b->m_route);
374 if (search_package.session().is_closed())
376 package.response() = search_package.response();
377 package.session().close();
380 b->m_number_of_sets++;
382 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
383 fixup_package(search_package, b);
384 package.response() = search_package.response();
387 yf::VirtualDB::Frontend::Frontend(Rep *rep)
390 m_is_virtual = false;
393 void yf::VirtualDB::Frontend::close(mp::Package &package)
395 std::list<BackendPtr>::const_iterator b_it;
397 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
399 (*b_it)->m_backend_session.close();
400 Package close_package((*b_it)->m_backend_session, package.origin());
401 close_package.copy_filter(package);
402 close_package.move((*b_it)->m_route);
404 m_backend_list.clear();
407 yf::VirtualDB::Frontend::~Frontend()
411 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
413 boost::mutex::scoped_lock lock(m_mutex);
415 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
419 it = m_clients.find(package.session());
420 if (it == m_clients.end())
423 if (!it->second->m_in_use)
425 it->second->m_in_use = true;
428 m_cond_session_ready.wait(lock);
430 FrontendPtr f(new Frontend(this));
431 m_clients[package.session()] = f;
436 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
438 boost::mutex::scoped_lock lock(m_mutex);
439 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
441 it = m_clients.find(package.session());
442 if (it != m_clients.end())
444 if (package.session().is_closed())
446 it->second->close(package);
451 it->second->m_in_use = false;
453 m_cond_session_ready.notify_all();
457 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
458 : m_backend(b), m_setname(setname)
463 yf::VirtualDB::Set::Set()
468 yf::VirtualDB::Set::~Set()
472 yf::VirtualDB::Map::Map(std::list<std::string> targets, std::string route)
473 : m_targets(targets), m_route(route)
477 yf::VirtualDB::Map::Map()
481 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
485 yf::VirtualDB::~VirtualDB() {
488 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
491 if (npr->databaseName)
493 std::string b_database = std::string(npr->databaseName);
495 // consider each of the frontend databases..
496 std::list<std::string>::const_iterator db_it;
497 for (db_it = b->m_frontend_databases.begin();
498 db_it != b->m_frontend_databases.end(); db_it++)
500 // see which target it corresponds to.. (if any)
501 std::map<std::string,VirtualDB::Map>::const_iterator map_it;
503 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
504 if (map_it != m_p->m_maps.end())
506 VirtualDB::Map m = map_it->second;
508 std::list<std::string>::const_iterator t;
509 for (t = m.m_targets.begin(); t != m.m_targets.end(); t++)
511 if (*t == b_database)
513 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
520 db_it = b->m_frontend_databases.begin();
521 if (db_it != b->m_frontend_databases.end())
523 std::string database = *db_it;
524 npr->databaseName = odr_strdup(odr, database.c_str());
529 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
532 if (records && records->which == Z_Records_DBOSD)
534 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
536 for (i = 0; i < nprlist->num_records; i++)
538 fixup_npr_record(odr, nprlist->records[i], b);
543 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
545 Z_GDU *gdu = p.response().get();
548 if (gdu && gdu->which == Z_GDU_Z3950)
550 Z_APDU *apdu = gdu->u.z3950;
551 if (apdu->which == Z_APDU_presentResponse)
553 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
556 else if (apdu->which == Z_APDU_searchResponse)
558 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
564 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
566 Z_PresentRequest *req = apdu_req->u.presentRequest;
567 std::string resultSetId = req->resultSetId;
570 Sets_it sets_it = m_sets.find(resultSetId);
571 if (sets_it == m_sets.end())
574 odr.create_presentResponse(
576 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
577 resultSetId.c_str());
578 package.response() = apdu;
582 new mp::Session(sets_it->second.m_backend->m_backend_session);
584 // sending present to backend
585 Package present_package(*id, package.origin());
586 present_package.copy_filter(package);
588 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
590 present_package.request() = yazpp_1::GDU(apdu_req);
592 present_package.move(sets_it->second.m_backend->m_route);
594 fixup_package(present_package, sets_it->second.m_backend);
596 if (present_package.session().is_closed())
598 package.response() = present_package.response();
599 package.session().close();
604 package.response() = present_package.response();
609 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
611 Z_ScanRequest *req = apdu_req->u.scanRequest;
615 std::list<std::string> databases;
617 for (i = 0; i<req->num_databaseNames; i++)
618 databases.push_back(req->databaseNames[i]);
621 // pick up any existing backend with a database match
622 std::list<BackendPtr>::const_iterator map_it;
623 map_it = m_backend_list.begin();
624 for (; map_it != m_backend_list.end(); map_it++)
626 BackendPtr tmp = *map_it;
627 if (tmp->m_frontend_databases == databases)
630 if (map_it != m_backend_list.end())
632 if (!b) // no backend yet. Must create a new one
636 b = init_backend(databases, package, error_code, addinfo);
639 // did not get a backend (unavailable somehow?)
641 odr.create_scanResponse(
642 apdu_req, error_code, addinfo.c_str());
643 package.response() = apdu;
648 // sending scan to backend
649 Package scan_package(b->m_backend_session, package.origin());
651 scan_package.copy_filter(package);
653 // pick first targets spec and move the databases from it ..
654 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
655 if (t_it != b->m_targets.end())
657 mp::util::set_databases_from_zurl(odr, *t_it,
658 &req->num_databaseNames,
659 &req->databaseNames);
661 scan_package.request() = yazpp_1::GDU(apdu_req);
663 scan_package.move(b->m_route);
665 if (scan_package.session().is_closed())
667 package.response() = scan_package.response();
668 package.session().close();
671 package.response() = scan_package.response();
675 void yf::VirtualDB::add_map_db2targets(std::string db,
676 std::list<std::string> targets,
679 m_p->m_maps[mp::util::database_name_normalize(db)]
680 = VirtualDB::Map(targets, route);
684 void yf::VirtualDB::add_map_db2target(std::string db,
688 std::list<std::string> targets;
689 targets.push_back(target);
691 m_p->m_maps[mp::util::database_name_normalize(db)]
692 = VirtualDB::Map(targets, route);
695 void yf::VirtualDB::process(mp::Package &package) const
697 FrontendPtr f = m_p->get_frontend(package);
699 Z_GDU *gdu = package.request().get();
701 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
702 Z_APDU_initRequest && !f->m_is_virtual)
704 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
706 std::list<std::string> vhosts;
707 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
708 if (vhosts.size() == 0)
713 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
714 Z_InitResponse *resp = apdu->u.initResponse;
717 static const int masks[] = {
720 Z_Options_namedResultSets,
724 for (i = 0; masks[i] != -1; i++)
725 if (ODR_MASK_GET(req->options, masks[i]))
726 ODR_MASK_SET(resp->options, masks[i]);
728 static const int versions[] = {
734 for (i = 0; versions[i] != -1; i++)
735 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
736 ODR_MASK_SET(resp->protocolVersion, versions[i]);
740 package.response() = apdu;
741 f->m_is_virtual = true;
746 else if (!f->m_is_virtual)
748 else if (gdu && gdu->which == Z_GDU_Z3950)
750 Z_APDU *apdu = gdu->u.z3950;
751 if (apdu->which == Z_APDU_initRequest)
755 package.response() = odr.create_close(
757 Z_Close_protocolError,
760 package.session().close();
762 else if (apdu->which == Z_APDU_searchRequest)
764 f->search(package, apdu);
766 else if (apdu->which == Z_APDU_presentRequest)
768 f->present(package, apdu);
770 else if (apdu->which == Z_APDU_scanRequest)
772 f->scan(package, apdu);
774 else if (apdu->which == Z_APDU_close)
776 package.session().close();
782 package.response() = odr.create_close(
783 apdu, Z_Close_protocolError,
784 "unsupported APDU in filter_virt_db");
786 package.session().close();
789 m_p->release_frontend(package);
793 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
795 for (ptr = ptr->children; ptr; ptr = ptr->next)
797 if (ptr->type != XML_ELEMENT_NODE)
799 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 * indent-tabs-mode: nil
851 * c-file-style: "stroustrup"
853 * vim: shiftwidth=4 tabstop=8 expandtab