1 /* $Id: filter_virt_db.cpp,v 1.36 2006-03-16 10:40:59 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 BackendPtr lookup_backend_from_databases(
72 std::list<std::string> databases);
73 BackendPtr create_backend_from_databases(
74 std::list<std::string> databases,
76 std::string &failing_database);
78 BackendPtr init_backend(std::list<std::string> database,
80 int &error_code, std::string &addinfo);
85 friend struct Frontend;
87 FrontendPtr get_frontend(Package &package);
88 void release_frontend(Package &package);
90 boost::mutex m_sessions_mutex;
91 std::map<std::string, Virt_db::Map>m_maps;
93 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
96 boost::condition m_cond_session_ready;
97 std::map<mp::Session, FrontendPtr> m_clients;
104 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::lookup_backend_from_databases(
105 std::list<std::string> databases)
107 std::list<BackendPtr>::const_iterator map_it;
108 map_it = m_backend_list.begin();
109 for (; map_it != m_backend_list.end(); map_it++)
110 if ((*map_it)->m_frontend_databases == databases)
116 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::create_backend_from_databases(
117 std::list<std::string> databases, int &error_code, std::string &addinfo)
119 BackendPtr b(new Backend);
120 std::list<std::string>::const_iterator db_it = databases.begin();
122 b->m_number_of_sets = 0;
123 b->m_frontend_databases = databases;
124 b->m_named_result_sets = false;
126 bool first_route = true;
128 std::map<std::string,bool> targets_dedup;
129 for (; db_it != databases.end(); db_it++)
131 std::map<std::string, Virt_db::Map>::iterator map_it;
132 map_it = m_p->m_maps.find(*db_it);
133 if (map_it == m_p->m_maps.end()) // database not found
135 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
140 std::list<std::string>::const_iterator t_it =
141 map_it->second.m_targets.begin();
142 for (; t_it != map_it->second.m_targets.end(); t_it++)
143 targets_dedup[*t_it] = true;
145 // see if we have a route conflict.
146 if (!first_route && b->m_route != map_it->second.m_route)
148 // we have a conflict..
149 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
153 b->m_route = map_it->second.m_route;
156 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
157 for (; tm_it != targets_dedup.end(); tm_it++)
158 b->m_targets.push_back(tm_it->first);
163 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::init_backend(
164 std::list<std::string> databases, Package &package,
165 int &error_code, std::string &addinfo)
167 BackendPtr b = create_backend_from_databases(databases, error_code,
171 Package init_package(b->m_backend_session, package.origin());
172 init_package.copy_filter(package);
176 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
178 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
180 Z_InitRequest *req = init_apdu->u.initRequest;
182 // copy stuff from Frontend Init Request
183 Z_GDU *org_gdu = m_init_gdu.get();
184 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
186 req->idAuthentication = org_init->idAuthentication;
187 req->implementationId = org_init->implementationId;
188 req->implementationName = org_init->implementationName;
189 req->implementationVersion = org_init->implementationVersion;
191 ODR_MASK_SET(req->options, Z_Options_search);
192 ODR_MASK_SET(req->options, Z_Options_present);
193 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
194 ODR_MASK_SET(req->options, Z_Options_scan);
196 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
197 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
198 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
200 init_package.request() = init_apdu;
202 init_package.move(b->m_route); // sending init
204 Z_GDU *gdu = init_package.response().get();
205 // we hope to get an init response
206 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
209 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
210 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
212 b->m_named_result_sets = true;
216 mp::util::get_init_diagnostics(res, error_code, addinfo);
223 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
224 // addinfo = database;
228 if (init_package.session().is_closed())
230 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
231 // addinfo = database;
236 m_backend_list.push_back(b);
240 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
242 Z_SearchRequest *req = apdu_req->u.searchRequest;
244 std::string resultSetId = req->resultSetName;
247 std::list<std::string> databases;
249 for (i = 0; i<req->num_databaseNames; i++)
250 databases.push_back(req->databaseNames[i]);
252 BackendPtr b; // null for now
253 Sets_it sets_it = m_sets.find(req->resultSetName);
254 if (sets_it != m_sets.end())
256 // result set already exist
257 // if replace indicator is off: we return diagnostic if
258 // result set already exist.
259 if (*req->replaceIndicator == 0)
262 odr.create_searchResponse(
264 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
266 package.response() = apdu;
270 sets_it->second.m_backend->m_number_of_sets--;
272 // pick up any existing backend with a database match
273 std::list<BackendPtr>::const_iterator map_it;
274 map_it = m_backend_list.begin();
275 for (; map_it != m_backend_list.end(); map_it++)
277 BackendPtr tmp = *map_it;
278 if (tmp->m_frontend_databases == databases)
281 if (map_it != m_backend_list.end())
288 // pick up any existing database with named result sets ..
289 // or one which has no result sets.. yet.
290 std::list<BackendPtr>::const_iterator map_it;
291 map_it = m_backend_list.begin();
292 for (; map_it != m_backend_list.end(); map_it++)
294 BackendPtr tmp = *map_it;
295 if (tmp->m_frontend_databases == databases &&
296 (tmp->m_named_result_sets ||
297 tmp->m_number_of_sets == 0))
300 if (map_it != m_backend_list.end())
303 if (!b) // no backend yet. Must create a new one
307 b = init_backend(databases, package, error_code, addinfo);
310 // did not get a backend (unavailable somehow?)
313 odr.create_searchResponse(
314 apdu_req, error_code, addinfo.c_str());
315 package.response() = apdu;
319 m_sets.erase(req->resultSetName);
320 // sending search to backend
321 Package search_package(b->m_backend_session, package.origin());
323 search_package.copy_filter(package);
325 std::string backend_setname;
326 if (b->m_named_result_sets)
328 backend_setname = std::string(req->resultSetName);
332 backend_setname = "default";
333 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
336 // pick first targets spec and move the databases from it ..
337 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
338 if (t_it != b->m_targets.end())
340 mp::util::set_databases_from_zurl(odr, *t_it,
341 &req->num_databaseNames,
342 &req->databaseNames);
345 *req->replaceIndicator = 1;
347 search_package.request() = yazpp_1::GDU(apdu_req);
349 search_package.move(b->m_route);
351 if (search_package.session().is_closed())
353 package.response() = search_package.response();
354 package.session().close();
357 package.response() = search_package.response();
359 b->m_number_of_sets++;
361 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
364 yf::Virt_db::Frontend::Frontend(Rep *rep)
367 m_is_virtual = false;
370 void yf::Virt_db::Frontend::close(Package &package)
372 std::list<BackendPtr>::const_iterator b_it;
374 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
376 (*b_it)->m_backend_session.close();
377 Package close_package((*b_it)->m_backend_session, package.origin());
378 close_package.copy_filter(package);
379 close_package.move((*b_it)->m_route);
381 m_backend_list.clear();
384 yf::Virt_db::Frontend::~Frontend()
388 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
390 boost::mutex::scoped_lock lock(m_mutex);
392 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
396 it = m_clients.find(package.session());
397 if (it == m_clients.end())
400 if (!it->second->m_in_use)
402 it->second->m_in_use = true;
405 m_cond_session_ready.wait(lock);
407 FrontendPtr f(new Frontend(this));
408 m_clients[package.session()] = f;
413 void yf::Virt_db::Rep::release_frontend(Package &package)
415 boost::mutex::scoped_lock lock(m_mutex);
416 std::map<mp::Session,yf::Virt_db::FrontendPtr>::iterator it;
418 it = m_clients.find(package.session());
419 if (it != m_clients.end())
421 if (package.session().is_closed())
423 it->second->close(package);
428 it->second->m_in_use = false;
430 m_cond_session_ready.notify_all();
434 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
435 : m_backend(b), m_setname(setname)
440 yf::Virt_db::Set::Set()
445 yf::Virt_db::Set::~Set()
449 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
450 : m_targets(targets), m_route(route)
454 yf::Virt_db::Map::Map()
458 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
462 yf::Virt_db::~Virt_db() {
465 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
467 Z_PresentRequest *req = apdu_req->u.presentRequest;
468 std::string resultSetId = req->resultSetId;
471 Sets_it sets_it = m_sets.find(resultSetId);
472 if (sets_it == m_sets.end())
475 odr.create_presentResponse(
477 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
478 resultSetId.c_str());
479 package.response() = apdu;
483 new mp::Session(sets_it->second.m_backend->m_backend_session);
485 // sending present to backend
486 Package present_package(*id, package.origin());
487 present_package.copy_filter(package);
489 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
491 present_package.request() = yazpp_1::GDU(apdu_req);
493 present_package.move(sets_it->second.m_backend->m_route);
495 if (present_package.session().is_closed())
497 package.response() = present_package.response();
498 package.session().close();
503 package.response() = present_package.response();
508 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
510 Z_ScanRequest *req = apdu_req->u.scanRequest;
514 std::list<std::string> databases;
516 for (i = 0; i<req->num_databaseNames; i++)
517 databases.push_back(req->databaseNames[i]);
520 // pick up any existing backend with a database match
521 std::list<BackendPtr>::const_iterator map_it;
522 map_it = m_backend_list.begin();
523 for (; map_it != m_backend_list.end(); map_it++)
525 BackendPtr tmp = *map_it;
526 if (tmp->m_frontend_databases == databases)
529 if (map_it != m_backend_list.end())
531 if (!b) // no backend yet. Must create a new one
535 b = init_backend(databases, package, error_code, addinfo);
538 // did not get a backend (unavailable somehow?)
540 odr.create_scanResponse(
541 apdu_req, error_code, addinfo.c_str());
542 package.response() = apdu;
547 // sending scan to backend
548 Package scan_package(b->m_backend_session, package.origin());
550 scan_package.copy_filter(package);
552 // pick first targets spec and move the databases from it ..
553 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
554 if (t_it != b->m_targets.end())
556 mp::util::set_databases_from_zurl(odr, *t_it,
557 &req->num_databaseNames,
558 &req->databaseNames);
560 scan_package.request() = yazpp_1::GDU(apdu_req);
562 scan_package.move(b->m_route);
564 if (scan_package.session().is_closed())
566 package.response() = scan_package.response();
567 package.session().close();
570 package.response() = scan_package.response();
574 void yf::Virt_db::add_map_db2targets(std::string db,
575 std::list<std::string> targets,
578 m_p->m_maps[db] = Virt_db::Map(targets, route);
582 void yf::Virt_db::add_map_db2target(std::string db,
586 std::list<std::string> targets;
587 targets.push_back(target);
589 m_p->m_maps[db] = Virt_db::Map(targets, route);
592 void yf::Virt_db::process(Package &package) const
594 FrontendPtr f = m_p->get_frontend(package);
596 Z_GDU *gdu = package.request().get();
598 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
599 Z_APDU_initRequest && !f->m_is_virtual)
601 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
603 std::list<std::string> vhosts;
604 mp::util::get_vhost_otherinfo(&req->otherInfo, false, vhosts);
605 if (vhosts.size() == 0)
610 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
611 Z_InitResponse *resp = apdu->u.initResponse;
614 static const int masks[] = {
617 Z_Options_namedResultSets,
621 for (i = 0; masks[i] != -1; i++)
622 if (ODR_MASK_GET(req->options, masks[i]))
623 ODR_MASK_SET(resp->options, masks[i]);
625 static const int versions[] = {
631 for (i = 0; versions[i] != -1; i++)
632 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
633 ODR_MASK_SET(resp->protocolVersion, versions[i]);
637 package.response() = apdu;
638 f->m_is_virtual = true;
643 else if (!f->m_is_virtual)
645 else if (gdu && gdu->which == Z_GDU_Z3950)
647 Z_APDU *apdu = gdu->u.z3950;
648 if (apdu->which == Z_APDU_initRequest)
652 package.response() = odr.create_close(
654 Z_Close_protocolError,
657 package.session().close();
659 else if (apdu->which == Z_APDU_searchRequest)
661 f->search(package, apdu);
663 else if (apdu->which == Z_APDU_presentRequest)
665 f->present(package, apdu);
667 else if (apdu->which == Z_APDU_scanRequest)
669 f->scan(package, apdu);
675 package.response() = odr.create_close(
676 apdu, Z_Close_protocolError,
677 "unsupported APDU in filter_virt_db");
679 package.session().close();
682 m_p->release_frontend(package);
686 void mp::filter::Virt_db::configure(const xmlNode * ptr)
688 for (ptr = ptr->children; ptr; ptr = ptr->next)
690 if (ptr->type != XML_ELEMENT_NODE)
692 if (!strcmp((const char *) ptr->name, "virtual"))
694 std::string database;
695 std::list<std::string> targets;
696 xmlNode *v_node = ptr->children;
697 for (; v_node; v_node = v_node->next)
699 if (v_node->type != XML_ELEMENT_NODE)
702 if (mp::xml::is_element_yp2(v_node, "database"))
703 database = mp::xml::get_text(v_node);
704 else if (mp::xml::is_element_yp2(v_node, "target"))
705 targets.push_back(mp::xml::get_text(v_node));
707 throw mp::filter::FilterException
709 + std::string((const char *) v_node->name)
710 + " in virtual section"
713 std::string route = mp::xml::get_route(ptr);
714 add_map_db2targets(database, targets, route);
718 throw mp::filter::FilterException
720 + std::string((const char *) ptr->name)
721 + " in virt_db filter");
726 static mp::filter::Base* filter_creator()
728 return new mp::filter::Virt_db;
732 struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
743 * indent-tabs-mode: nil
744 * c-file-style: "stroustrup"
746 * vim: shiftwidth=4 tabstop=8 expandtab