1 /* $Id: filter_virt_db.cpp,v 1.37 2006-04-29 08:09:13 adam Exp $
2 Copyright (c) 2005-2006, Index Data.
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_npr(Package &p, BackendPtr b);
73 void fixup_npr(Z_Records *records, std::string database,
76 BackendPtr lookup_backend_from_databases(
77 std::list<std::string> databases);
78 BackendPtr create_backend_from_databases(
79 std::list<std::string> databases,
81 std::string &failing_database);
83 BackendPtr init_backend(std::list<std::string> database,
85 int &error_code, std::string &addinfo);
90 friend struct Frontend;
92 FrontendPtr get_frontend(Package &package);
93 void release_frontend(Package &package);
95 boost::mutex m_sessions_mutex;
96 std::map<std::string, Virt_db::Map>m_maps;
98 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
100 boost::mutex m_mutex;
101 boost::condition m_cond_session_ready;
102 std::map<mp::Session, FrontendPtr> m_clients;
109 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::lookup_backend_from_databases(
110 std::list<std::string> databases)
112 std::list<BackendPtr>::const_iterator map_it;
113 map_it = m_backend_list.begin();
114 for (; map_it != m_backend_list.end(); map_it++)
115 if ((*map_it)->m_frontend_databases == databases)
121 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::create_backend_from_databases(
122 std::list<std::string> databases, int &error_code, std::string &addinfo)
124 BackendPtr b(new Backend);
125 std::list<std::string>::const_iterator db_it = databases.begin();
127 b->m_number_of_sets = 0;
128 b->m_frontend_databases = databases;
129 b->m_named_result_sets = false;
131 bool first_route = true;
133 std::map<std::string,bool> targets_dedup;
134 for (; db_it != databases.end(); db_it++)
136 std::map<std::string, Virt_db::Map>::iterator map_it;
137 map_it = m_p->m_maps.find(*db_it);
138 if (map_it == m_p->m_maps.end()) // database not found
140 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
145 std::list<std::string>::const_iterator t_it =
146 map_it->second.m_targets.begin();
147 for (; t_it != map_it->second.m_targets.end(); t_it++)
148 targets_dedup[*t_it] = true;
150 // see if we have a route conflict.
151 if (!first_route && b->m_route != map_it->second.m_route)
153 // we have a conflict..
154 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
158 b->m_route = map_it->second.m_route;
161 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
162 for (; tm_it != targets_dedup.end(); tm_it++)
163 b->m_targets.push_back(tm_it->first);
168 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::init_backend(
169 std::list<std::string> databases, Package &package,
170 int &error_code, std::string &addinfo)
172 BackendPtr b = create_backend_from_databases(databases, error_code,
176 Package init_package(b->m_backend_session, package.origin());
177 init_package.copy_filter(package);
181 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
183 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
185 Z_InitRequest *req = init_apdu->u.initRequest;
187 // copy stuff from Frontend Init Request
188 Z_GDU *org_gdu = m_init_gdu.get();
189 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
191 req->idAuthentication = org_init->idAuthentication;
192 req->implementationId = org_init->implementationId;
193 req->implementationName = org_init->implementationName;
194 req->implementationVersion = org_init->implementationVersion;
196 ODR_MASK_SET(req->options, Z_Options_search);
197 ODR_MASK_SET(req->options, Z_Options_present);
198 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
199 ODR_MASK_SET(req->options, Z_Options_scan);
201 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
202 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
203 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
205 init_package.request() = init_apdu;
207 init_package.move(b->m_route); // sending init
209 Z_GDU *gdu = init_package.response().get();
210 // we hope to get an init response
211 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
214 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
215 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
217 b->m_named_result_sets = true;
221 mp::util::get_init_diagnostics(res, error_code, addinfo);
228 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
229 // addinfo = database;
233 if (init_package.session().is_closed())
235 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
236 // addinfo = database;
241 m_backend_list.push_back(b);
245 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
247 Z_SearchRequest *req = apdu_req->u.searchRequest;
249 std::string resultSetId = req->resultSetName;
252 std::list<std::string> databases;
254 for (i = 0; i<req->num_databaseNames; i++)
255 databases.push_back(req->databaseNames[i]);
257 BackendPtr b; // null for now
258 Sets_it sets_it = m_sets.find(req->resultSetName);
259 if (sets_it != m_sets.end())
261 // result set already exist
262 // if replace indicator is off: we return diagnostic if
263 // result set already exist.
264 if (*req->replaceIndicator == 0)
267 odr.create_searchResponse(
269 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
271 package.response() = apdu;
275 sets_it->second.m_backend->m_number_of_sets--;
277 // pick up any existing backend with a database match
278 std::list<BackendPtr>::const_iterator map_it;
279 map_it = m_backend_list.begin();
280 for (; map_it != m_backend_list.end(); map_it++)
282 BackendPtr tmp = *map_it;
283 if (tmp->m_frontend_databases == databases)
286 if (map_it != m_backend_list.end())
293 // pick up any existing database with named result sets ..
294 // or one which has no result sets.. yet.
295 std::list<BackendPtr>::const_iterator map_it;
296 map_it = m_backend_list.begin();
297 for (; map_it != m_backend_list.end(); map_it++)
299 BackendPtr tmp = *map_it;
300 if (tmp->m_frontend_databases == databases &&
301 (tmp->m_named_result_sets ||
302 tmp->m_number_of_sets == 0))
305 if (map_it != m_backend_list.end())
308 if (!b) // no backend yet. Must create a new one
312 b = init_backend(databases, package, error_code, addinfo);
315 // did not get a backend (unavailable somehow?)
318 odr.create_searchResponse(
319 apdu_req, error_code, addinfo.c_str());
320 package.response() = apdu;
324 m_sets.erase(req->resultSetName);
325 // sending search to backend
326 Package search_package(b->m_backend_session, package.origin());
328 search_package.copy_filter(package);
330 std::string backend_setname;
331 if (b->m_named_result_sets)
333 backend_setname = std::string(req->resultSetName);
337 backend_setname = "default";
338 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
341 // pick first targets spec and move the databases from it ..
342 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
343 if (t_it != b->m_targets.end())
345 mp::util::set_databases_from_zurl(odr, *t_it,
346 &req->num_databaseNames,
347 &req->databaseNames);
350 *req->replaceIndicator = 1;
352 search_package.request() = yazpp_1::GDU(apdu_req);
354 search_package.move(b->m_route);
356 if (search_package.session().is_closed())
358 package.response() = search_package.response();
359 package.session().close();
362 b->m_number_of_sets++;
364 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
365 fixup_npr(search_package, b);
366 package.response() = search_package.response();
369 yf::Virt_db::Frontend::Frontend(Rep *rep)
372 m_is_virtual = false;
375 void yf::Virt_db::Frontend::close(Package &package)
377 std::list<BackendPtr>::const_iterator b_it;
379 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
381 (*b_it)->m_backend_session.close();
382 Package close_package((*b_it)->m_backend_session, package.origin());
383 close_package.copy_filter(package);
384 close_package.move((*b_it)->m_route);
386 m_backend_list.clear();
389 yf::Virt_db::Frontend::~Frontend()
393 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
395 boost::mutex::scoped_lock lock(m_mutex);
397 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
401 it = m_clients.find(package.session());
402 if (it == m_clients.end())
405 if (!it->second->m_in_use)
407 it->second->m_in_use = true;
410 m_cond_session_ready.wait(lock);
412 FrontendPtr f(new Frontend(this));
413 m_clients[package.session()] = f;
418 void yf::Virt_db::Rep::release_frontend(Package &package)
420 boost::mutex::scoped_lock lock(m_mutex);
421 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
423 it = m_clients.find(package.session());
424 if (it != m_clients.end())
426 if (package.session().is_closed())
428 it->second->close(package);
433 it->second->m_in_use = false;
435 m_cond_session_ready.notify_all();
439 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
440 : m_backend(b), m_setname(setname)
445 yf::Virt_db::Set::Set()
450 yf::Virt_db::Set::~Set()
454 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
455 : m_targets(targets), m_route(route)
459 yf::Virt_db::Map::Map()
463 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
467 yf::Virt_db::~Virt_db() {
471 void yf::Virt_db::Frontend::fixup_npr(Z_Records *records, std::string database,
474 if (records && records->which == Z_Records_DBOSD)
476 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
478 for (i = 0; i < nprlist->num_records; i++)
480 Z_NamePlusRecord *npr = nprlist->records[i];
481 npr->databaseName = odr_strdup(odr, database.c_str());
486 void yf::Virt_db::Frontend::fixup_npr(Package &p, BackendPtr b)
488 Z_GDU *gdu = p.response().get();
490 std::string database = "dummy";
491 std::list<std::string>::const_iterator db_it =
492 b->m_frontend_databases.begin();
493 if (db_it != b->m_frontend_databases.end())
496 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
497 Z_APDU_presentResponse)
499 fixup_npr(gdu->u.z3950->u.presentResponse->records, database, odr);
502 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
503 Z_APDU_searchResponse)
505 fixup_npr(gdu->u.z3950->u.searchResponse->records, database, odr);
511 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
513 Z_PresentRequest *req = apdu_req->u.presentRequest;
514 std::string resultSetId = req->resultSetId;
517 Sets_it sets_it = m_sets.find(resultSetId);
518 if (sets_it == m_sets.end())
521 odr.create_presentResponse(
523 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
524 resultSetId.c_str());
525 package.response() = apdu;
529 new mp::Session(sets_it->second.m_backend->m_backend_session);
531 // sending present to backend
532 Package present_package(*id, package.origin());
533 present_package.copy_filter(package);
535 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
537 present_package.request() = yazpp_1::GDU(apdu_req);
539 present_package.move(sets_it->second.m_backend->m_route);
541 fixup_npr(present_package, sets_it->second.m_backend);
543 if (present_package.session().is_closed())
545 package.response() = present_package.response();
546 package.session().close();
551 package.response() = present_package.response();
556 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
558 Z_ScanRequest *req = apdu_req->u.scanRequest;
562 std::list<std::string> databases;
564 for (i = 0; i<req->num_databaseNames; i++)
565 databases.push_back(req->databaseNames[i]);
568 // pick up any existing backend with a database match
569 std::list<BackendPtr>::const_iterator map_it;
570 map_it = m_backend_list.begin();
571 for (; map_it != m_backend_list.end(); map_it++)
573 BackendPtr tmp = *map_it;
574 if (tmp->m_frontend_databases == databases)
577 if (map_it != m_backend_list.end())
579 if (!b) // no backend yet. Must create a new one
583 b = init_backend(databases, package, error_code, addinfo);
586 // did not get a backend (unavailable somehow?)
588 odr.create_scanResponse(
589 apdu_req, error_code, addinfo.c_str());
590 package.response() = apdu;
595 // sending scan to backend
596 Package scan_package(b->m_backend_session, package.origin());
598 scan_package.copy_filter(package);
600 // pick first targets spec and move the databases from it ..
601 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
602 if (t_it != b->m_targets.end())
604 mp::util::set_databases_from_zurl(odr, *t_it,
605 &req->num_databaseNames,
606 &req->databaseNames);
608 scan_package.request() = yazpp_1::GDU(apdu_req);
610 scan_package.move(b->m_route);
612 if (scan_package.session().is_closed())
614 package.response() = scan_package.response();
615 package.session().close();
618 package.response() = scan_package.response();
622 void yf::Virt_db::add_map_db2targets(std::string db,
623 std::list<std::string> targets,
626 m_p->m_maps[db] = Virt_db::Map(targets, route);
630 void yf::Virt_db::add_map_db2target(std::string db,
634 std::list<std::string> targets;
635 targets.push_back(target);
637 m_p->m_maps[db] = Virt_db::Map(targets, route);
640 void yf::Virt_db::process(Package &package) const
642 FrontendPtr f = m_p->get_frontend(package);
644 Z_GDU *gdu = package.request().get();
646 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
647 Z_APDU_initRequest && !f->m_is_virtual)
649 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
651 std::list<std::string> vhosts;
652 mp::util::get_vhost_otherinfo(&req->otherInfo, false, vhosts);
653 if (vhosts.size() == 0)
658 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
659 Z_InitResponse *resp = apdu->u.initResponse;
662 static const int masks[] = {
665 Z_Options_namedResultSets,
669 for (i = 0; masks[i] != -1; i++)
670 if (ODR_MASK_GET(req->options, masks[i]))
671 ODR_MASK_SET(resp->options, masks[i]);
673 static const int versions[] = {
679 for (i = 0; versions[i] != -1; i++)
680 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
681 ODR_MASK_SET(resp->protocolVersion, versions[i]);
685 package.response() = apdu;
686 f->m_is_virtual = true;
691 else if (!f->m_is_virtual)
693 else if (gdu && gdu->which == Z_GDU_Z3950)
695 Z_APDU *apdu = gdu->u.z3950;
696 if (apdu->which == Z_APDU_initRequest)
700 package.response() = odr.create_close(
702 Z_Close_protocolError,
705 package.session().close();
707 else if (apdu->which == Z_APDU_searchRequest)
709 f->search(package, apdu);
711 else if (apdu->which == Z_APDU_presentRequest)
713 f->present(package, apdu);
715 else if (apdu->which == Z_APDU_scanRequest)
717 f->scan(package, apdu);
723 package.response() = odr.create_close(
724 apdu, Z_Close_protocolError,
725 "unsupported APDU in filter_virt_db");
727 package.session().close();
730 m_p->release_frontend(package);
734 void mp::filter::Virt_db::configure(const xmlNode * ptr)
736 for (ptr = ptr->children; ptr; ptr = ptr->next)
738 if (ptr->type != XML_ELEMENT_NODE)
740 if (!strcmp((const char *) ptr->name, "virtual"))
742 std::string database;
743 std::list<std::string> targets;
744 xmlNode *v_node = ptr->children;
745 for (; v_node; v_node = v_node->next)
747 if (v_node->type != XML_ELEMENT_NODE)
750 if (mp::xml::is_element_yp2(v_node, "database"))
751 database = mp::xml::get_text(v_node);
752 else if (mp::xml::is_element_yp2(v_node, "target"))
753 targets.push_back(mp::xml::get_text(v_node));
755 throw mp::filter::FilterException
757 + std::string((const char *) v_node->name)
758 + " in virtual section"
761 std::string route = mp::xml::get_route(ptr);
762 add_map_db2targets(database, targets, route);
766 throw mp::filter::FilterException
768 + std::string((const char *) ptr->name)
769 + " in virt_db filter");
774 static mp::filter::Base* filter_creator()
776 return new mp::filter::Virt_db;
780 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
791 * indent-tabs-mode: nil
792 * c-file-style: "stroustrup"
794 * vim: shiftwidth=4 tabstop=8 expandtab