1 /* $Id: filter_virt_db.cpp,v 1.30 2006-01-17 13:54:54 adam Exp $
2 Copyright (c) 2005, 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 yf = yp2::filter;
32 Set(BackendPtr b, std::string setname);
37 std::string m_setname;
40 Map(std::list<std::string> targets, std::string route);
42 std::list<std::string> m_targets;
45 struct Virt_db::Backend {
46 yp2::Session m_backend_session;
47 std::list<std::string> m_frontend_databases;
48 std::list<std::string> m_targets;
50 bool m_named_result_sets;
53 struct Virt_db::Frontend {
56 yp2::Session m_session;
59 std::list<BackendPtr> m_backend_list;
60 std::map<std::string,Virt_db::Set> m_sets;
62 void search(Package &package, Z_APDU *apdu);
63 void present(Package &package, Z_APDU *apdu);
64 void scan(Package &package, Z_APDU *apdu);
66 void close(Package &package);
67 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
69 BackendPtr lookup_backend_from_databases(
70 std::list<std::string> databases);
71 BackendPtr create_backend_from_databases(
72 std::list<std::string> databases,
74 std::string &failing_database);
76 BackendPtr init_backend(std::list<std::string> database,
78 int &error_code, std::string &addinfo);
83 friend class Frontend;
85 FrontendPtr get_frontend(Package &package);
86 void release_frontend(Package &package);
88 boost::mutex m_sessions_mutex;
89 std::map<std::string, Virt_db::Map>m_maps;
91 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
94 boost::condition m_cond_session_ready;
95 std::map<yp2::Session, FrontendPtr> m_clients;
102 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::lookup_backend_from_databases(
103 std::list<std::string> databases)
105 std::list<BackendPtr>::const_iterator map_it;
106 map_it = m_backend_list.begin();
107 for (; map_it != m_backend_list.end(); map_it++)
108 if ((*map_it)->m_frontend_databases == databases)
114 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::create_backend_from_databases(
115 std::list<std::string> databases, int &error_code, std::string &addinfo)
117 BackendPtr b(new Backend);
118 std::list<std::string>::const_iterator db_it = databases.begin();
120 b->m_number_of_sets = 0;
121 b->m_frontend_databases = databases;
122 b->m_named_result_sets = false;
124 bool first_route = true;
126 std::map<std::string,bool> targets_dedup;
127 for (; db_it != databases.end(); db_it++)
129 std::map<std::string, Virt_db::Map>::iterator map_it;
130 map_it = m_p->m_maps.find(*db_it);
131 if (map_it == m_p->m_maps.end()) // database not found
133 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
138 std::list<std::string>::const_iterator t_it =
139 map_it->second.m_targets.begin();
140 for (; t_it != map_it->second.m_targets.end(); t_it++)
141 targets_dedup[*t_it] = true;
143 // see if we have a route conflict.
144 if (!first_route && b->m_route != map_it->second.m_route)
146 // we have a conflict..
147 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
151 b->m_route = map_it->second.m_route;
154 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
155 for (; tm_it != targets_dedup.end(); tm_it++)
156 b->m_targets.push_back(tm_it->first);
161 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::init_backend(
162 std::list<std::string> databases, Package &package,
163 int &error_code, std::string &addinfo)
165 BackendPtr b = create_backend_from_databases(databases, error_code,
169 Package init_package(b->m_backend_session, package.origin());
170 init_package.copy_filter(package);
174 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
176 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
178 for (; t_it != b->m_targets.end(); t_it++, cat++)
180 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
181 VAL_PROXY, cat, t_it->c_str());
184 Z_InitRequest *req = init_apdu->u.initRequest;
186 ODR_MASK_SET(req->options, Z_Options_search);
187 ODR_MASK_SET(req->options, Z_Options_present);
188 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
189 ODR_MASK_SET(req->options, Z_Options_scan);
191 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
192 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
193 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
195 init_package.request() = init_apdu;
197 init_package.move(b->m_route); // sending init
199 if (init_package.session().is_closed())
201 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
202 // addinfo = database;
206 Z_GDU *gdu = init_package.response().get();
207 // we hope to get an init response
208 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
211 if (ODR_MASK_GET(gdu->u.z3950->u.initResponse->options,
212 Z_Options_namedResultSets))
214 b->m_named_result_sets = true;
219 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
220 // addinfo = database;
224 m_backend_list.push_back(b);
228 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
230 Z_SearchRequest *req = apdu_req->u.searchRequest;
232 std::string resultSetId = req->resultSetName;
235 std::list<std::string> databases;
237 for (i = 0; i<req->num_databaseNames; i++)
238 databases.push_back(req->databaseNames[i]);
240 BackendPtr b; // null for now
241 Sets_it sets_it = m_sets.find(req->resultSetName);
242 if (sets_it != m_sets.end())
244 // result set already exist
245 // if replace indicator is off: we return diagnostic if
246 // result set already exist.
247 if (*req->replaceIndicator == 0)
250 odr.create_searchResponse(
252 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
254 package.response() = apdu;
258 sets_it->second.m_backend->m_number_of_sets--;
260 // pick up any existing backend with a database match
261 std::list<BackendPtr>::const_iterator map_it;
262 map_it = m_backend_list.begin();
263 for (; map_it != m_backend_list.end(); map_it++)
265 BackendPtr tmp = *map_it;
266 if (tmp->m_frontend_databases == databases)
269 if (map_it != m_backend_list.end())
276 // pick up any existing database with named result sets ..
277 // or one which has no result sets.. yet.
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 &&
284 (tmp->m_named_result_sets ||
285 tmp->m_number_of_sets == 0))
288 if (map_it != m_backend_list.end())
291 if (!b) // no backend yet. Must create a new one
295 b = init_backend(databases, package, error_code, addinfo);
298 // did not get a backend (unavailable somehow?)
301 odr.create_searchResponse(
302 apdu_req, error_code, addinfo.c_str());
303 package.response() = apdu;
307 m_sets.erase(req->resultSetName);
308 // sending search to backend
309 Package search_package(b->m_backend_session, package.origin());
311 search_package.copy_filter(package);
313 std::string backend_setname;
314 if (b->m_named_result_sets)
316 backend_setname = std::string(req->resultSetName);
320 backend_setname = "default";
321 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
324 // pick first targets spec and move the databases from it ..
325 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
326 if (t_it != b->m_targets.end())
328 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
329 &req->num_databaseNames,
330 &req->databaseNames));
333 *req->replaceIndicator = 1;
335 search_package.request() = yazpp_1::GDU(apdu_req);
337 search_package.move(b->m_route);
339 if (search_package.session().is_closed())
341 package.response() = search_package.response();
342 package.session().close();
345 package.response() = search_package.response();
347 b->m_number_of_sets++;
349 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
352 yf::Virt_db::Frontend::Frontend(Rep *rep)
355 m_is_virtual = false;
358 void yf::Virt_db::Frontend::close(Package &package)
360 std::list<BackendPtr>::const_iterator b_it;
362 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
364 (*b_it)->m_backend_session.close();
365 Package close_package((*b_it)->m_backend_session, package.origin());
366 close_package.copy_filter(package);
367 close_package.move((*b_it)->m_route);
369 m_backend_list.clear();
372 yf::Virt_db::Frontend::~Frontend()
376 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
378 boost::mutex::scoped_lock lock(m_mutex);
380 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
384 it = m_clients.find(package.session());
385 if (it == m_clients.end())
388 if (!it->second->m_in_use)
390 it->second->m_in_use = true;
393 m_cond_session_ready.wait(lock);
395 FrontendPtr f(new Frontend(this));
396 m_clients[package.session()] = f;
401 void yf::Virt_db::Rep::release_frontend(Package &package)
403 boost::mutex::scoped_lock lock(m_mutex);
404 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
406 it = m_clients.find(package.session());
407 if (it != m_clients.end())
409 if (package.session().is_closed())
411 it->second->close(package);
416 it->second->m_in_use = false;
418 m_cond_session_ready.notify_all();
422 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
423 : m_backend(b), m_setname(setname)
428 yf::Virt_db::Set::Set()
433 yf::Virt_db::Set::~Set()
437 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
438 : m_targets(targets), m_route(route)
442 yf::Virt_db::Map::Map()
446 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
450 yf::Virt_db::~Virt_db() {
453 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
455 Z_PresentRequest *req = apdu_req->u.presentRequest;
456 std::string resultSetId = req->resultSetId;
459 Sets_it sets_it = m_sets.find(resultSetId);
460 if (sets_it == m_sets.end())
463 odr.create_presentResponse(
465 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
466 resultSetId.c_str());
467 package.response() = apdu;
471 new yp2::Session(sets_it->second.m_backend->m_backend_session);
473 // sending present to backend
474 Package present_package(*id, package.origin());
475 present_package.copy_filter(package);
477 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
479 present_package.request() = yazpp_1::GDU(apdu_req);
481 present_package.move(sets_it->second.m_backend->m_route);
483 if (present_package.session().is_closed())
485 package.response() = present_package.response();
486 package.session().close();
491 package.response() = present_package.response();
496 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
498 Z_ScanRequest *req = apdu_req->u.scanRequest;
502 std::list<std::string> databases;
504 for (i = 0; i<req->num_databaseNames; i++)
505 databases.push_back(req->databaseNames[i]);
508 // pick up any existing backend with a database match
509 std::list<BackendPtr>::const_iterator map_it;
510 map_it = m_backend_list.begin();
511 for (; map_it != m_backend_list.end(); map_it++)
513 BackendPtr tmp = *map_it;
514 if (tmp->m_frontend_databases == databases)
517 if (map_it != m_backend_list.end())
519 if (!b) // no backend yet. Must create a new one
523 b = init_backend(databases, package, error_code, addinfo);
526 // did not get a backend (unavailable somehow?)
528 odr.create_scanResponse(
529 apdu_req, error_code, addinfo.c_str());
530 package.response() = apdu;
535 // sending scan to backend
536 Package scan_package(b->m_backend_session, package.origin());
538 scan_package.copy_filter(package);
540 // pick first targets spec and move the databases from it ..
541 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
542 if (t_it != b->m_targets.end())
544 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
545 &req->num_databaseNames,
546 &req->databaseNames));
548 scan_package.request() = yazpp_1::GDU(apdu_req);
550 scan_package.move(b->m_route);
552 if (scan_package.session().is_closed())
554 package.response() = scan_package.response();
555 package.session().close();
558 package.response() = scan_package.response();
562 void yf::Virt_db::add_map_db2targets(std::string db,
563 std::list<std::string> targets,
566 m_p->m_maps[db] = Virt_db::Map(targets, route);
570 void yf::Virt_db::add_map_db2target(std::string db,
574 std::list<std::string> targets;
575 targets.push_back(target);
577 m_p->m_maps[db] = Virt_db::Map(targets, route);
580 void yf::Virt_db::process(Package &package) const
582 FrontendPtr f = m_p->get_frontend(package);
584 Z_GDU *gdu = package.request().get();
586 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
587 Z_APDU_initRequest && !f->m_is_virtual)
589 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
592 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
596 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
597 Z_InitResponse *resp = apdu->u.initResponse;
600 static const int masks[] = {
603 Z_Options_namedResultSets,
607 for (i = 0; masks[i] != -1; i++)
608 if (ODR_MASK_GET(req->options, masks[i]))
609 ODR_MASK_SET(resp->options, masks[i]);
611 static const int versions[] = {
617 for (i = 0; versions[i] != -1; i++)
618 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
619 ODR_MASK_SET(resp->protocolVersion, versions[i]);
623 package.response() = apdu;
624 f->m_is_virtual = true;
629 else if (!f->m_is_virtual)
631 else if (gdu && gdu->which == Z_GDU_Z3950)
633 Z_APDU *apdu = gdu->u.z3950;
634 if (apdu->which == Z_APDU_initRequest)
638 package.response() = odr.create_close(
640 Z_Close_protocolError,
643 package.session().close();
645 else if (apdu->which == Z_APDU_searchRequest)
647 f->search(package, apdu);
649 else if (apdu->which == Z_APDU_presentRequest)
651 f->present(package, apdu);
653 else if (apdu->which == Z_APDU_scanRequest)
655 f->scan(package, apdu);
661 package.response() = odr.create_close(
662 apdu, Z_Close_protocolError,
663 "unsupported APDU in filter_virt_db");
665 package.session().close();
668 m_p->release_frontend(package);
672 void yp2::filter::Virt_db::configure(const xmlNode * ptr)
674 for (ptr = ptr->children; ptr; ptr = ptr->next)
676 if (ptr->type != XML_ELEMENT_NODE)
678 if (!strcmp((const char *) ptr->name, "virtual"))
680 std::string database;
681 std::list<std::string> targets;
682 xmlNode *v_node = ptr->children;
683 for (; v_node; v_node = v_node->next)
685 if (v_node->type != XML_ELEMENT_NODE)
688 if (yp2::xml::is_element_yp2(v_node, "database"))
689 database = yp2::xml::get_text(v_node);
690 else if (yp2::xml::is_element_yp2(v_node, "target"))
691 targets.push_back(yp2::xml::get_text(v_node));
693 throw yp2::filter::FilterException
695 + std::string((const char *) v_node->name)
696 + " in virtual section"
699 std::string route = yp2::xml::get_route(ptr);
700 add_map_db2targets(database, targets, route);
704 throw yp2::filter::FilterException
706 + std::string((const char *) ptr->name)
707 + " in virt_db filter");
712 static yp2::filter::Base* filter_creator()
714 return new yp2::filter::Virt_db;
718 struct yp2_filter_struct yp2_filter_virt_db = {
729 * indent-tabs-mode: nil
730 * c-file-style: "stroustrup"
732 * vim: shiftwidth=4 tabstop=8 expandtab