1 /* $Id: filter_virt_db.cpp,v 1.44 2006-08-01 13:24:53 adam Exp $
2 Copyright (c) 2005-2006, 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 {
33 Set(BackendPtr b, std::string setname);
38 std::string m_setname;
41 Map(std::list<std::string> targets, std::string route);
43 std::list<std::string> m_targets;
46 struct Virt_db::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 Virt_db::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,Virt_db::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,Virt_db::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);
91 friend struct Frontend;
93 FrontendPtr get_frontend(Package &package);
94 void release_frontend(Package &package);
96 std::map<std::string, Virt_db::Map>m_maps;
97 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
99 boost::condition m_cond_session_ready;
100 std::map<mp::Session, FrontendPtr> m_clients;
105 yf::Virt_db::BackendPtr yf::Virt_db::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::Virt_db::BackendPtr yf::Virt_db::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, Virt_db::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_UNAVAILABLE;
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::Virt_db::BackendPtr yf::Virt_db::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 mp::util::get_init_diagnostics(res, error_code, addinfo);
224 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
225 // addinfo = database;
229 if (init_package.session().is_closed())
231 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
232 // addinfo = database;
237 m_backend_list.push_back(b);
241 void yf::Virt_db::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
243 Z_SearchRequest *req = apdu_req->u.searchRequest;
245 std::string resultSetId = req->resultSetName;
248 std::list<std::string> databases;
250 for (i = 0; i<req->num_databaseNames; i++)
251 databases.push_back(req->databaseNames[i]);
253 BackendPtr b; // null for now
254 Sets_it sets_it = m_sets.find(req->resultSetName);
255 if (sets_it != m_sets.end())
257 // result set already exist
258 // if replace indicator is off: we return diagnostic if
259 // result set already exist.
260 if (*req->replaceIndicator == 0)
263 odr.create_searchResponse(
265 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
267 package.response() = apdu;
271 sets_it->second.m_backend->m_number_of_sets--;
273 // pick up any existing backend with a database match
274 std::list<BackendPtr>::const_iterator map_it;
275 map_it = m_backend_list.begin();
276 for (; map_it != m_backend_list.end(); map_it++)
278 BackendPtr tmp = *map_it;
279 if (tmp->m_frontend_databases == databases)
282 if (map_it != m_backend_list.end())
289 // pick up any existing database with named result sets ..
290 // or one which has no result sets.. yet.
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())
304 if (!b) // no backend yet. Must create a new one
308 b = init_backend(databases, package, error_code, addinfo);
311 // did not get a backend (unavailable somehow?)
314 odr.create_searchResponse(
315 apdu_req, error_code, addinfo.c_str());
316 package.response() = apdu;
320 m_sets.erase(req->resultSetName);
321 // sending search to backend
322 Package search_package(b->m_backend_session, package.origin());
324 search_package.copy_filter(package);
326 std::string backend_setname;
327 if (b->m_named_result_sets)
329 backend_setname = std::string(req->resultSetName);
333 backend_setname = "default";
334 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
337 // pick first targets spec and move the databases from it ..
338 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
339 if (t_it != b->m_targets.end())
341 mp::util::set_databases_from_zurl(odr, *t_it,
342 &req->num_databaseNames,
343 &req->databaseNames);
346 *req->replaceIndicator = 1;
348 search_package.request() = yazpp_1::GDU(apdu_req);
350 search_package.move(b->m_route);
352 if (search_package.session().is_closed())
354 package.response() = search_package.response();
355 package.session().close();
358 b->m_number_of_sets++;
360 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
361 fixup_package(search_package, b);
362 package.response() = search_package.response();
365 yf::Virt_db::Frontend::Frontend(Rep *rep)
368 m_is_virtual = false;
371 void yf::Virt_db::Frontend::close(mp::Package &package)
373 std::list<BackendPtr>::const_iterator b_it;
375 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
377 (*b_it)->m_backend_session.close();
378 Package close_package((*b_it)->m_backend_session, package.origin());
379 close_package.copy_filter(package);
380 close_package.move((*b_it)->m_route);
382 m_backend_list.clear();
385 yf::Virt_db::Frontend::~Frontend()
389 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(mp::Package &package)
391 boost::mutex::scoped_lock lock(m_mutex);
393 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
397 it = m_clients.find(package.session());
398 if (it == m_clients.end())
401 if (!it->second->m_in_use)
403 it->second->m_in_use = true;
406 m_cond_session_ready.wait(lock);
408 FrontendPtr f(new Frontend(this));
409 m_clients[package.session()] = f;
414 void yf::Virt_db::Rep::release_frontend(mp::Package &package)
416 boost::mutex::scoped_lock lock(m_mutex);
417 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
419 it = m_clients.find(package.session());
420 if (it != m_clients.end())
422 if (package.session().is_closed())
424 it->second->close(package);
429 it->second->m_in_use = false;
431 m_cond_session_ready.notify_all();
435 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
436 : m_backend(b), m_setname(setname)
441 yf::Virt_db::Set::Set()
446 yf::Virt_db::Set::~Set()
450 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
451 : m_targets(targets), m_route(route)
455 yf::Virt_db::Map::Map()
459 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
463 yf::Virt_db::~Virt_db() {
466 void yf::Virt_db::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
469 if (npr->databaseName)
471 std::string b_database = std::string(npr->databaseName);
473 // consider each of the frontend databases..
474 std::list<std::string>::const_iterator db_it;
475 for (db_it = b->m_frontend_databases.begin();
476 db_it != b->m_frontend_databases.end(); db_it++)
478 // see which target it corresponds to.. (if any)
479 std::map<std::string,Virt_db::Map>::const_iterator map_it;
480 map_it = m_p->m_maps.find(*db_it);
481 if (map_it != m_p->m_maps.end())
483 Virt_db::Map m = map_it->second;
485 std::list<std::string>::const_iterator t;
486 for (t = m.m_targets.begin(); t != m.m_targets.end(); t++)
488 if (*t == b_database)
490 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
497 db_it = b->m_frontend_databases.begin();
498 if (db_it != b->m_frontend_databases.end())
500 std::string database = *db_it;
501 npr->databaseName = odr_strdup(odr, database.c_str());
506 void yf::Virt_db::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
509 if (records && records->which == Z_Records_DBOSD)
511 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
513 for (i = 0; i < nprlist->num_records; i++)
515 fixup_npr_record(odr, nprlist->records[i], b);
520 void yf::Virt_db::Frontend::fixup_package(mp::Package &p, BackendPtr b)
522 Z_GDU *gdu = p.response().get();
525 if (gdu && gdu->which == Z_GDU_Z3950)
527 Z_APDU *apdu = gdu->u.z3950;
528 if (apdu->which == Z_APDU_presentResponse)
530 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
533 else if (apdu->which == Z_APDU_searchResponse)
535 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
541 void yf::Virt_db::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
543 Z_PresentRequest *req = apdu_req->u.presentRequest;
544 std::string resultSetId = req->resultSetId;
547 Sets_it sets_it = m_sets.find(resultSetId);
548 if (sets_it == m_sets.end())
551 odr.create_presentResponse(
553 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
554 resultSetId.c_str());
555 package.response() = apdu;
559 new mp::Session(sets_it->second.m_backend->m_backend_session);
561 // sending present to backend
562 Package present_package(*id, package.origin());
563 present_package.copy_filter(package);
565 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
567 present_package.request() = yazpp_1::GDU(apdu_req);
569 present_package.move(sets_it->second.m_backend->m_route);
571 fixup_package(present_package, sets_it->second.m_backend);
573 if (present_package.session().is_closed())
575 package.response() = present_package.response();
576 package.session().close();
581 package.response() = present_package.response();
586 void yf::Virt_db::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
588 Z_ScanRequest *req = apdu_req->u.scanRequest;
592 std::list<std::string> databases;
594 for (i = 0; i<req->num_databaseNames; i++)
595 databases.push_back(req->databaseNames[i]);
598 // pick up any existing backend with a database match
599 std::list<BackendPtr>::const_iterator map_it;
600 map_it = m_backend_list.begin();
601 for (; map_it != m_backend_list.end(); map_it++)
603 BackendPtr tmp = *map_it;
604 if (tmp->m_frontend_databases == databases)
607 if (map_it != m_backend_list.end())
609 if (!b) // no backend yet. Must create a new one
613 b = init_backend(databases, package, error_code, addinfo);
616 // did not get a backend (unavailable somehow?)
618 odr.create_scanResponse(
619 apdu_req, error_code, addinfo.c_str());
620 package.response() = apdu;
625 // sending scan to backend
626 Package scan_package(b->m_backend_session, package.origin());
628 scan_package.copy_filter(package);
630 // pick first targets spec and move the databases from it ..
631 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
632 if (t_it != b->m_targets.end())
634 mp::util::set_databases_from_zurl(odr, *t_it,
635 &req->num_databaseNames,
636 &req->databaseNames);
638 scan_package.request() = yazpp_1::GDU(apdu_req);
640 scan_package.move(b->m_route);
642 if (scan_package.session().is_closed())
644 package.response() = scan_package.response();
645 package.session().close();
648 package.response() = scan_package.response();
652 void yf::Virt_db::add_map_db2targets(std::string db,
653 std::list<std::string> targets,
656 m_p->m_maps[mp::util::database_name_normalize(db)]
657 = Virt_db::Map(targets, route);
661 void yf::Virt_db::add_map_db2target(std::string db,
665 std::list<std::string> targets;
666 targets.push_back(target);
668 m_p->m_maps[mp::util::database_name_normalize(db)]
669 = Virt_db::Map(targets, route);
672 void yf::Virt_db::process(mp::Package &package) const
674 FrontendPtr f = m_p->get_frontend(package);
676 Z_GDU *gdu = package.request().get();
678 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
679 Z_APDU_initRequest && !f->m_is_virtual)
681 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
683 std::list<std::string> vhosts;
684 mp::util::get_vhost_otherinfo(&req->otherInfo, false, vhosts);
685 if (vhosts.size() == 0)
690 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
691 Z_InitResponse *resp = apdu->u.initResponse;
694 static const int masks[] = {
697 Z_Options_namedResultSets,
701 for (i = 0; masks[i] != -1; i++)
702 if (ODR_MASK_GET(req->options, masks[i]))
703 ODR_MASK_SET(resp->options, masks[i]);
705 static const int versions[] = {
711 for (i = 0; versions[i] != -1; i++)
712 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
713 ODR_MASK_SET(resp->protocolVersion, versions[i]);
717 package.response() = apdu;
718 f->m_is_virtual = true;
723 else if (!f->m_is_virtual)
725 else if (gdu && gdu->which == Z_GDU_Z3950)
727 Z_APDU *apdu = gdu->u.z3950;
728 if (apdu->which == Z_APDU_initRequest)
732 package.response() = odr.create_close(
734 Z_Close_protocolError,
737 package.session().close();
739 else if (apdu->which == Z_APDU_searchRequest)
741 f->search(package, apdu);
743 else if (apdu->which == Z_APDU_presentRequest)
745 f->present(package, apdu);
747 else if (apdu->which == Z_APDU_scanRequest)
749 f->scan(package, apdu);
751 else if (apdu->which == Z_APDU_close)
753 package.session().close();
759 package.response() = odr.create_close(
760 apdu, Z_Close_protocolError,
761 "unsupported APDU in filter_virt_db");
763 package.session().close();
766 m_p->release_frontend(package);
770 void mp::filter::Virt_db::configure(const xmlNode * ptr)
772 for (ptr = ptr->children; ptr; ptr = ptr->next)
774 if (ptr->type != XML_ELEMENT_NODE)
776 if (!strcmp((const char *) ptr->name, "virtual"))
778 std::string database;
779 std::list<std::string> targets;
780 xmlNode *v_node = ptr->children;
781 for (; v_node; v_node = v_node->next)
783 if (v_node->type != XML_ELEMENT_NODE)
786 if (mp::xml::is_element_yp2(v_node, "database"))
787 database = mp::xml::get_text(v_node);
788 else if (mp::xml::is_element_yp2(v_node, "target"))
789 targets.push_back(mp::xml::get_text(v_node));
791 throw mp::filter::FilterException
793 + std::string((const char *) v_node->name)
794 + " in virtual section"
797 std::string route = mp::xml::get_route(ptr);
798 add_map_db2targets(database, targets, route);
802 throw mp::filter::FilterException
804 + std::string((const char *) ptr->name)
805 + " in virt_db filter");
810 static mp::filter::Base* filter_creator()
812 return new mp::filter::Virt_db;
816 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
827 * indent-tabs-mode: nil
828 * c-file-style: "stroustrup"
830 * vim: shiftwidth=4 tabstop=8 expandtab