1 /* $Id: filter_virt_db.cpp,v 1.50 2007-01-25 14:05:54 adam Exp $
2 Copyright (c) 2005-2007, Index Data.
4 See the LICENSE file for details
10 #include "package.hpp"
12 #include <boost/thread/mutex.hpp>
13 #include <boost/thread/condition.hpp>
14 #include <boost/shared_ptr.hpp>
17 #include "filter_virt_db.hpp"
20 #include <yaz/otherinfo.h>
21 #include <yaz/diagbib1.h>
26 namespace mp = metaproxy_1;
27 namespace yf = mp::filter;
29 namespace metaproxy_1 {
32 struct VirtualDB::Set {
33 Set(BackendPtr b, std::string setname);
38 std::string m_setname;
40 struct VirtualDB::Map {
41 Map(std::list<std::string> targets, std::string route);
43 std::list<std::string> m_targets;
46 struct VirtualDB::Backend {
47 mp::Session m_backend_session;
48 std::list<std::string> m_frontend_databases;
49 std::list<std::string> m_targets;
51 bool m_named_result_sets;
54 struct VirtualDB::Frontend {
57 mp::Session m_session;
60 yazpp_1::GDU m_init_gdu;
61 std::list<BackendPtr> m_backend_list;
62 std::map<std::string,VirtualDB::Set> m_sets;
64 void search(Package &package, Z_APDU *apdu);
65 void present(Package &package, Z_APDU *apdu);
66 void scan(Package &package, Z_APDU *apdu);
68 void close(Package &package);
69 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
71 void fixup_package(Package &p, BackendPtr b);
72 void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
74 void fixup_npr_records(ODR odr, Z_Records *records,
77 BackendPtr lookup_backend_from_databases(
78 std::list<std::string> databases);
79 BackendPtr create_backend_from_databases(
80 std::list<std::string> databases,
82 std::string &failing_database);
84 BackendPtr init_backend(std::list<std::string> database,
86 int &error_code, std::string &addinfo);
89 class VirtualDB::Rep {
90 friend class VirtualDB;
91 friend struct Frontend;
93 FrontendPtr get_frontend(Package &package);
94 void release_frontend(Package &package);
96 std::map<std::string, VirtualDB::Map>m_maps;
97 typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
99 boost::condition m_cond_session_ready;
100 std::map<mp::Session, FrontendPtr> m_clients;
105 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
106 std::list<std::string> databases)
108 std::list<BackendPtr>::const_iterator map_it;
109 map_it = m_backend_list.begin();
110 for (; map_it != m_backend_list.end(); map_it++)
111 if ((*map_it)->m_frontend_databases == databases)
117 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
118 std::list<std::string> databases, int &error_code, std::string &addinfo)
120 BackendPtr b(new Backend);
121 std::list<std::string>::const_iterator db_it = databases.begin();
123 b->m_number_of_sets = 0;
124 b->m_frontend_databases = databases;
125 b->m_named_result_sets = false;
127 bool first_route = true;
129 std::map<std::string,bool> targets_dedup;
130 for (; db_it != databases.end(); db_it++)
132 std::map<std::string, VirtualDB::Map>::iterator map_it;
133 map_it = m_p->m_maps.find(mp::util::database_name_normalize(*db_it));
134 if (map_it == m_p->m_maps.end()) // database not found
136 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
141 std::list<std::string>::const_iterator t_it =
142 map_it->second.m_targets.begin();
143 for (; t_it != map_it->second.m_targets.end(); t_it++)
144 targets_dedup[*t_it] = true;
146 // see if we have a route conflict.
147 if (!first_route && b->m_route != map_it->second.m_route)
149 // we have a conflict..
150 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
154 b->m_route = map_it->second.m_route;
157 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
158 for (; tm_it != targets_dedup.end(); tm_it++)
159 b->m_targets.push_back(tm_it->first);
164 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
165 std::list<std::string> databases, mp::Package &package,
166 int &error_code, std::string &addinfo)
168 BackendPtr b = create_backend_from_databases(databases, error_code,
172 Package init_package(b->m_backend_session, package.origin());
173 init_package.copy_filter(package);
177 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
179 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
181 Z_InitRequest *req = init_apdu->u.initRequest;
183 // copy stuff from Frontend Init Request
184 Z_GDU *org_gdu = m_init_gdu.get();
185 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
187 req->idAuthentication = org_init->idAuthentication;
188 req->implementationId = org_init->implementationId;
189 req->implementationName = org_init->implementationName;
190 req->implementationVersion = org_init->implementationVersion;
192 ODR_MASK_SET(req->options, Z_Options_search);
193 ODR_MASK_SET(req->options, Z_Options_present);
194 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
195 ODR_MASK_SET(req->options, Z_Options_scan);
197 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
198 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
199 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
201 init_package.request() = init_apdu;
203 init_package.move(b->m_route); // sending init
205 Z_GDU *gdu = init_package.response().get();
206 // we hope to get an init response
207 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
210 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
211 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
213 b->m_named_result_sets = true;
217 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
218 mp::util::get_init_diagnostics(res, error_code, addinfo);
225 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
226 // addinfo = database;
230 if (init_package.session().is_closed())
232 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
233 // addinfo = database;
238 m_backend_list.push_back(b);
242 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
244 Z_SearchRequest *req = apdu_req->u.searchRequest;
246 std::string resultSetId = req->resultSetName;
249 std::list<std::string> databases;
251 for (i = 0; i<req->num_databaseNames; i++)
252 databases.push_back(req->databaseNames[i]);
254 BackendPtr b; // null for now
255 Sets_it sets_it = m_sets.find(req->resultSetName);
256 if (sets_it != m_sets.end())
258 // result set already exist
259 // if replace indicator is off: we return diagnostic if
260 // result set already exist.
261 if (*req->replaceIndicator == 0)
264 odr.create_searchResponse(
266 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
268 package.response() = apdu;
272 sets_it->second.m_backend->m_number_of_sets--;
274 // pick up any existing backend with a database match
275 std::list<BackendPtr>::const_iterator map_it;
276 map_it = m_backend_list.begin();
277 for (; map_it != m_backend_list.end(); map_it++)
279 BackendPtr tmp = *map_it;
280 if (tmp->m_frontend_databases == databases)
283 if (map_it != m_backend_list.end())
290 // pick up any existing database with named result sets ..
291 // or one which has no result sets.. yet.
292 std::list<BackendPtr>::const_iterator map_it;
293 map_it = m_backend_list.begin();
294 for (; map_it != m_backend_list.end(); map_it++)
296 BackendPtr tmp = *map_it;
297 if (tmp->m_frontend_databases == databases &&
298 (tmp->m_named_result_sets ||
299 tmp->m_number_of_sets == 0))
302 if (map_it != m_backend_list.end())
305 if (!b) // no backend yet. Must create a new one
309 b = init_backend(databases, package, error_code, addinfo);
312 // did not get a backend (unavailable somehow?)
315 odr.create_searchResponse(
316 apdu_req, error_code, addinfo.c_str());
317 package.response() = apdu;
321 m_sets.erase(req->resultSetName);
322 // sending search to backend
323 Package search_package(b->m_backend_session, package.origin());
325 search_package.copy_filter(package);
327 std::string backend_setname;
328 if (b->m_named_result_sets)
330 backend_setname = std::string(req->resultSetName);
334 backend_setname = "default";
335 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
338 // pick first targets spec and move the databases from it ..
339 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
340 if (t_it != b->m_targets.end())
342 mp::util::set_databases_from_zurl(odr, *t_it,
343 &req->num_databaseNames,
344 &req->databaseNames);
347 *req->replaceIndicator = 1;
349 search_package.request() = yazpp_1::GDU(apdu_req);
351 search_package.move(b->m_route);
353 if (search_package.session().is_closed())
355 package.response() = search_package.response();
356 package.session().close();
359 b->m_number_of_sets++;
361 m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
362 fixup_package(search_package, b);
363 package.response() = search_package.response();
366 yf::VirtualDB::Frontend::Frontend(Rep *rep)
369 m_is_virtual = false;
372 void yf::VirtualDB::Frontend::close(mp::Package &package)
374 std::list<BackendPtr>::const_iterator b_it;
376 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
378 (*b_it)->m_backend_session.close();
379 Package close_package((*b_it)->m_backend_session, package.origin());
380 close_package.copy_filter(package);
381 close_package.move((*b_it)->m_route);
383 m_backend_list.clear();
386 yf::VirtualDB::Frontend::~Frontend()
390 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
392 boost::mutex::scoped_lock lock(m_mutex);
394 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
398 it = m_clients.find(package.session());
399 if (it == m_clients.end())
402 if (!it->second->m_in_use)
404 it->second->m_in_use = true;
407 m_cond_session_ready.wait(lock);
409 FrontendPtr f(new Frontend(this));
410 m_clients[package.session()] = f;
415 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
417 boost::mutex::scoped_lock lock(m_mutex);
418 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
420 it = m_clients.find(package.session());
421 if (it != m_clients.end())
423 if (package.session().is_closed())
425 it->second->close(package);
430 it->second->m_in_use = false;
432 m_cond_session_ready.notify_all();
436 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
437 : m_backend(b), m_setname(setname)
442 yf::VirtualDB::Set::Set()
447 yf::VirtualDB::Set::~Set()
451 yf::VirtualDB::Map::Map(std::list<std::string> targets, std::string route)
452 : m_targets(targets), m_route(route)
456 yf::VirtualDB::Map::Map()
460 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
464 yf::VirtualDB::~VirtualDB() {
467 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
470 if (npr->databaseName)
472 std::string b_database = std::string(npr->databaseName);
474 // consider each of the frontend databases..
475 std::list<std::string>::const_iterator db_it;
476 for (db_it = b->m_frontend_databases.begin();
477 db_it != b->m_frontend_databases.end(); db_it++)
479 // see which target it corresponds to.. (if any)
480 std::map<std::string,VirtualDB::Map>::const_iterator map_it;
481 map_it = m_p->m_maps.find(*db_it);
482 if (map_it != m_p->m_maps.end())
484 VirtualDB::Map m = map_it->second;
486 std::list<std::string>::const_iterator t;
487 for (t = m.m_targets.begin(); t != m.m_targets.end(); t++)
489 if (*t == b_database)
491 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
498 db_it = b->m_frontend_databases.begin();
499 if (db_it != b->m_frontend_databases.end())
501 std::string database = *db_it;
502 npr->databaseName = odr_strdup(odr, database.c_str());
507 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
510 if (records && records->which == Z_Records_DBOSD)
512 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
514 for (i = 0; i < nprlist->num_records; i++)
516 fixup_npr_record(odr, nprlist->records[i], b);
521 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
523 Z_GDU *gdu = p.response().get();
526 if (gdu && gdu->which == Z_GDU_Z3950)
528 Z_APDU *apdu = gdu->u.z3950;
529 if (apdu->which == Z_APDU_presentResponse)
531 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
534 else if (apdu->which == Z_APDU_searchResponse)
536 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
542 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
544 Z_PresentRequest *req = apdu_req->u.presentRequest;
545 std::string resultSetId = req->resultSetId;
548 Sets_it sets_it = m_sets.find(resultSetId);
549 if (sets_it == m_sets.end())
552 odr.create_presentResponse(
554 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
555 resultSetId.c_str());
556 package.response() = apdu;
560 new mp::Session(sets_it->second.m_backend->m_backend_session);
562 // sending present to backend
563 Package present_package(*id, package.origin());
564 present_package.copy_filter(package);
566 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
568 present_package.request() = yazpp_1::GDU(apdu_req);
570 present_package.move(sets_it->second.m_backend->m_route);
572 fixup_package(present_package, sets_it->second.m_backend);
574 if (present_package.session().is_closed())
576 package.response() = present_package.response();
577 package.session().close();
582 package.response() = present_package.response();
587 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
589 Z_ScanRequest *req = apdu_req->u.scanRequest;
593 std::list<std::string> databases;
595 for (i = 0; i<req->num_databaseNames; i++)
596 databases.push_back(req->databaseNames[i]);
599 // pick up any existing backend with a database match
600 std::list<BackendPtr>::const_iterator map_it;
601 map_it = m_backend_list.begin();
602 for (; map_it != m_backend_list.end(); map_it++)
604 BackendPtr tmp = *map_it;
605 if (tmp->m_frontend_databases == databases)
608 if (map_it != m_backend_list.end())
610 if (!b) // no backend yet. Must create a new one
614 b = init_backend(databases, package, error_code, addinfo);
617 // did not get a backend (unavailable somehow?)
619 odr.create_scanResponse(
620 apdu_req, error_code, addinfo.c_str());
621 package.response() = apdu;
626 // sending scan to backend
627 Package scan_package(b->m_backend_session, package.origin());
629 scan_package.copy_filter(package);
631 // pick first targets spec and move the databases from it ..
632 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
633 if (t_it != b->m_targets.end())
635 mp::util::set_databases_from_zurl(odr, *t_it,
636 &req->num_databaseNames,
637 &req->databaseNames);
639 scan_package.request() = yazpp_1::GDU(apdu_req);
641 scan_package.move(b->m_route);
643 if (scan_package.session().is_closed())
645 package.response() = scan_package.response();
646 package.session().close();
649 package.response() = scan_package.response();
653 void yf::VirtualDB::add_map_db2targets(std::string db,
654 std::list<std::string> targets,
657 m_p->m_maps[mp::util::database_name_normalize(db)]
658 = VirtualDB::Map(targets, route);
662 void yf::VirtualDB::add_map_db2target(std::string db,
666 std::list<std::string> targets;
667 targets.push_back(target);
669 m_p->m_maps[mp::util::database_name_normalize(db)]
670 = VirtualDB::Map(targets, route);
673 void yf::VirtualDB::process(mp::Package &package) const
675 FrontendPtr f = m_p->get_frontend(package);
677 Z_GDU *gdu = package.request().get();
679 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
680 Z_APDU_initRequest && !f->m_is_virtual)
682 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
684 std::list<std::string> vhosts;
685 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
686 if (vhosts.size() == 0)
691 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
692 Z_InitResponse *resp = apdu->u.initResponse;
695 static const int masks[] = {
698 Z_Options_namedResultSets,
702 for (i = 0; masks[i] != -1; i++)
703 if (ODR_MASK_GET(req->options, masks[i]))
704 ODR_MASK_SET(resp->options, masks[i]);
706 static const int versions[] = {
712 for (i = 0; versions[i] != -1; i++)
713 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
714 ODR_MASK_SET(resp->protocolVersion, versions[i]);
718 package.response() = apdu;
719 f->m_is_virtual = true;
724 else if (!f->m_is_virtual)
726 else if (gdu && gdu->which == Z_GDU_Z3950)
728 Z_APDU *apdu = gdu->u.z3950;
729 if (apdu->which == Z_APDU_initRequest)
733 package.response() = odr.create_close(
735 Z_Close_protocolError,
738 package.session().close();
740 else if (apdu->which == Z_APDU_searchRequest)
742 f->search(package, apdu);
744 else if (apdu->which == Z_APDU_presentRequest)
746 f->present(package, apdu);
748 else if (apdu->which == Z_APDU_scanRequest)
750 f->scan(package, apdu);
752 else if (apdu->which == Z_APDU_close)
754 package.session().close();
760 package.response() = odr.create_close(
761 apdu, Z_Close_protocolError,
762 "unsupported APDU in filter_virt_db");
764 package.session().close();
767 m_p->release_frontend(package);
771 void mp::filter::VirtualDB::configure(const xmlNode * ptr)
773 for (ptr = ptr->children; ptr; ptr = ptr->next)
775 if (ptr->type != XML_ELEMENT_NODE)
777 if (!strcmp((const char *) ptr->name, "virtual"))
779 std::string database;
780 std::list<std::string> targets;
781 xmlNode *v_node = ptr->children;
782 for (; v_node; v_node = v_node->next)
784 if (v_node->type != XML_ELEMENT_NODE)
787 if (mp::xml::is_element_mp(v_node, "database"))
788 database = mp::xml::get_text(v_node);
789 else if (mp::xml::is_element_mp(v_node, "target"))
790 targets.push_back(mp::xml::get_text(v_node));
792 throw mp::filter::FilterException
794 + std::string((const char *) v_node->name)
795 + " in virtual section"
798 std::string route = mp::xml::get_route(ptr);
799 add_map_db2targets(database, targets, route);
803 throw mp::filter::FilterException
805 + std::string((const char *) ptr->name)
806 + " in virt_db filter");
811 static mp::filter::Base* filter_creator()
813 return new mp::filter::VirtualDB;
817 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
828 * indent-tabs-mode: nil
829 * c-file-style: "stroustrup"
831 * vim: shiftwidth=4 tabstop=8 expandtab