1 /* $Id: filter_virt_db.cpp,v 1.35 2006-02-02 11:33:46 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 yazpp_1::GDU m_init_gdu;
60 std::list<BackendPtr> m_backend_list;
61 std::map<std::string,Virt_db::Set> m_sets;
63 void search(Package &package, Z_APDU *apdu);
64 void present(Package &package, Z_APDU *apdu);
65 void scan(Package &package, Z_APDU *apdu);
67 void close(Package &package);
68 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
70 BackendPtr lookup_backend_from_databases(
71 std::list<std::string> databases);
72 BackendPtr create_backend_from_databases(
73 std::list<std::string> databases,
75 std::string &failing_database);
77 BackendPtr init_backend(std::list<std::string> database,
79 int &error_code, std::string &addinfo);
84 friend struct Frontend;
86 FrontendPtr get_frontend(Package &package);
87 void release_frontend(Package &package);
89 boost::mutex m_sessions_mutex;
90 std::map<std::string, Virt_db::Map>m_maps;
92 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
95 boost::condition m_cond_session_ready;
96 std::map<yp2::Session, FrontendPtr> m_clients;
103 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::lookup_backend_from_databases(
104 std::list<std::string> databases)
106 std::list<BackendPtr>::const_iterator map_it;
107 map_it = m_backend_list.begin();
108 for (; map_it != m_backend_list.end(); map_it++)
109 if ((*map_it)->m_frontend_databases == databases)
115 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::create_backend_from_databases(
116 std::list<std::string> databases, int &error_code, std::string &addinfo)
118 BackendPtr b(new Backend);
119 std::list<std::string>::const_iterator db_it = databases.begin();
121 b->m_number_of_sets = 0;
122 b->m_frontend_databases = databases;
123 b->m_named_result_sets = false;
125 bool first_route = true;
127 std::map<std::string,bool> targets_dedup;
128 for (; db_it != databases.end(); db_it++)
130 std::map<std::string, Virt_db::Map>::iterator map_it;
131 map_it = m_p->m_maps.find(*db_it);
132 if (map_it == m_p->m_maps.end()) // database not found
134 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
139 std::list<std::string>::const_iterator t_it =
140 map_it->second.m_targets.begin();
141 for (; t_it != map_it->second.m_targets.end(); t_it++)
142 targets_dedup[*t_it] = true;
144 // see if we have a route conflict.
145 if (!first_route && b->m_route != map_it->second.m_route)
147 // we have a conflict..
148 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
152 b->m_route = map_it->second.m_route;
155 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
156 for (; tm_it != targets_dedup.end(); tm_it++)
157 b->m_targets.push_back(tm_it->first);
162 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::init_backend(
163 std::list<std::string> databases, Package &package,
164 int &error_code, std::string &addinfo)
166 BackendPtr b = create_backend_from_databases(databases, error_code,
170 Package init_package(b->m_backend_session, package.origin());
171 init_package.copy_filter(package);
175 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
177 yp2::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
179 Z_InitRequest *req = init_apdu->u.initRequest;
181 // copy stuff from Frontend Init Request
182 Z_GDU *org_gdu = m_init_gdu.get();
183 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
185 req->idAuthentication = org_init->idAuthentication;
186 req->implementationId = org_init->implementationId;
187 req->implementationName = org_init->implementationName;
188 req->implementationVersion = org_init->implementationVersion;
190 ODR_MASK_SET(req->options, Z_Options_search);
191 ODR_MASK_SET(req->options, Z_Options_present);
192 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
193 ODR_MASK_SET(req->options, Z_Options_scan);
195 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
196 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
197 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
199 init_package.request() = init_apdu;
201 init_package.move(b->m_route); // sending init
203 Z_GDU *gdu = init_package.response().get();
204 // we hope to get an init response
205 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
208 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
209 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
211 b->m_named_result_sets = true;
215 yp2::util::get_init_diagnostics(res, error_code, addinfo);
222 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
223 // addinfo = database;
227 if (init_package.session().is_closed())
229 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
230 // addinfo = database;
235 m_backend_list.push_back(b);
239 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
241 Z_SearchRequest *req = apdu_req->u.searchRequest;
243 std::string resultSetId = req->resultSetName;
246 std::list<std::string> databases;
248 for (i = 0; i<req->num_databaseNames; i++)
249 databases.push_back(req->databaseNames[i]);
251 BackendPtr b; // null for now
252 Sets_it sets_it = m_sets.find(req->resultSetName);
253 if (sets_it != m_sets.end())
255 // result set already exist
256 // if replace indicator is off: we return diagnostic if
257 // result set already exist.
258 if (*req->replaceIndicator == 0)
261 odr.create_searchResponse(
263 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
265 package.response() = apdu;
269 sets_it->second.m_backend->m_number_of_sets--;
271 // pick up any existing backend with a database match
272 std::list<BackendPtr>::const_iterator map_it;
273 map_it = m_backend_list.begin();
274 for (; map_it != m_backend_list.end(); map_it++)
276 BackendPtr tmp = *map_it;
277 if (tmp->m_frontend_databases == databases)
280 if (map_it != m_backend_list.end())
287 // pick up any existing database with named result sets ..
288 // or one which has no result sets.. yet.
289 std::list<BackendPtr>::const_iterator map_it;
290 map_it = m_backend_list.begin();
291 for (; map_it != m_backend_list.end(); map_it++)
293 BackendPtr tmp = *map_it;
294 if (tmp->m_frontend_databases == databases &&
295 (tmp->m_named_result_sets ||
296 tmp->m_number_of_sets == 0))
299 if (map_it != m_backend_list.end())
302 if (!b) // no backend yet. Must create a new one
306 b = init_backend(databases, package, error_code, addinfo);
309 // did not get a backend (unavailable somehow?)
312 odr.create_searchResponse(
313 apdu_req, error_code, addinfo.c_str());
314 package.response() = apdu;
318 m_sets.erase(req->resultSetName);
319 // sending search to backend
320 Package search_package(b->m_backend_session, package.origin());
322 search_package.copy_filter(package);
324 std::string backend_setname;
325 if (b->m_named_result_sets)
327 backend_setname = std::string(req->resultSetName);
331 backend_setname = "default";
332 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
335 // pick first targets spec and move the databases from it ..
336 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
337 if (t_it != b->m_targets.end())
339 yp2::util::set_databases_from_zurl(odr, *t_it,
340 &req->num_databaseNames,
341 &req->databaseNames);
344 *req->replaceIndicator = 1;
346 search_package.request() = yazpp_1::GDU(apdu_req);
348 search_package.move(b->m_route);
350 if (search_package.session().is_closed())
352 package.response() = search_package.response();
353 package.session().close();
356 package.response() = search_package.response();
358 b->m_number_of_sets++;
360 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
363 yf::Virt_db::Frontend::Frontend(Rep *rep)
366 m_is_virtual = false;
369 void yf::Virt_db::Frontend::close(Package &package)
371 std::list<BackendPtr>::const_iterator b_it;
373 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
375 (*b_it)->m_backend_session.close();
376 Package close_package((*b_it)->m_backend_session, package.origin());
377 close_package.copy_filter(package);
378 close_package.move((*b_it)->m_route);
380 m_backend_list.clear();
383 yf::Virt_db::Frontend::~Frontend()
387 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
389 boost::mutex::scoped_lock lock(m_mutex);
391 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
395 it = m_clients.find(package.session());
396 if (it == m_clients.end())
399 if (!it->second->m_in_use)
401 it->second->m_in_use = true;
404 m_cond_session_ready.wait(lock);
406 FrontendPtr f(new Frontend(this));
407 m_clients[package.session()] = f;
412 void yf::Virt_db::Rep::release_frontend(Package &package)
414 boost::mutex::scoped_lock lock(m_mutex);
415 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
417 it = m_clients.find(package.session());
418 if (it != m_clients.end())
420 if (package.session().is_closed())
422 it->second->close(package);
427 it->second->m_in_use = false;
429 m_cond_session_ready.notify_all();
433 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
434 : m_backend(b), m_setname(setname)
439 yf::Virt_db::Set::Set()
444 yf::Virt_db::Set::~Set()
448 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
449 : m_targets(targets), m_route(route)
453 yf::Virt_db::Map::Map()
457 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
461 yf::Virt_db::~Virt_db() {
464 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
466 Z_PresentRequest *req = apdu_req->u.presentRequest;
467 std::string resultSetId = req->resultSetId;
470 Sets_it sets_it = m_sets.find(resultSetId);
471 if (sets_it == m_sets.end())
474 odr.create_presentResponse(
476 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
477 resultSetId.c_str());
478 package.response() = apdu;
482 new yp2::Session(sets_it->second.m_backend->m_backend_session);
484 // sending present to backend
485 Package present_package(*id, package.origin());
486 present_package.copy_filter(package);
488 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
490 present_package.request() = yazpp_1::GDU(apdu_req);
492 present_package.move(sets_it->second.m_backend->m_route);
494 if (present_package.session().is_closed())
496 package.response() = present_package.response();
497 package.session().close();
502 package.response() = present_package.response();
507 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
509 Z_ScanRequest *req = apdu_req->u.scanRequest;
513 std::list<std::string> databases;
515 for (i = 0; i<req->num_databaseNames; i++)
516 databases.push_back(req->databaseNames[i]);
519 // pick up any existing backend with a database match
520 std::list<BackendPtr>::const_iterator map_it;
521 map_it = m_backend_list.begin();
522 for (; map_it != m_backend_list.end(); map_it++)
524 BackendPtr tmp = *map_it;
525 if (tmp->m_frontend_databases == databases)
528 if (map_it != m_backend_list.end())
530 if (!b) // no backend yet. Must create a new one
534 b = init_backend(databases, package, error_code, addinfo);
537 // did not get a backend (unavailable somehow?)
539 odr.create_scanResponse(
540 apdu_req, error_code, addinfo.c_str());
541 package.response() = apdu;
546 // sending scan to backend
547 Package scan_package(b->m_backend_session, package.origin());
549 scan_package.copy_filter(package);
551 // pick first targets spec and move the databases from it ..
552 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
553 if (t_it != b->m_targets.end())
555 yp2::util::set_databases_from_zurl(odr, *t_it,
556 &req->num_databaseNames,
557 &req->databaseNames);
559 scan_package.request() = yazpp_1::GDU(apdu_req);
561 scan_package.move(b->m_route);
563 if (scan_package.session().is_closed())
565 package.response() = scan_package.response();
566 package.session().close();
569 package.response() = scan_package.response();
573 void yf::Virt_db::add_map_db2targets(std::string db,
574 std::list<std::string> targets,
577 m_p->m_maps[db] = Virt_db::Map(targets, route);
581 void yf::Virt_db::add_map_db2target(std::string db,
585 std::list<std::string> targets;
586 targets.push_back(target);
588 m_p->m_maps[db] = Virt_db::Map(targets, route);
591 void yf::Virt_db::process(Package &package) const
593 FrontendPtr f = m_p->get_frontend(package);
595 Z_GDU *gdu = package.request().get();
597 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
598 Z_APDU_initRequest && !f->m_is_virtual)
600 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
602 std::list<std::string> vhosts;
603 yp2::util::get_vhost_otherinfo(&req->otherInfo, false, vhosts);
604 if (vhosts.size() == 0)
609 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
610 Z_InitResponse *resp = apdu->u.initResponse;
613 static const int masks[] = {
616 Z_Options_namedResultSets,
620 for (i = 0; masks[i] != -1; i++)
621 if (ODR_MASK_GET(req->options, masks[i]))
622 ODR_MASK_SET(resp->options, masks[i]);
624 static const int versions[] = {
630 for (i = 0; versions[i] != -1; i++)
631 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
632 ODR_MASK_SET(resp->protocolVersion, versions[i]);
636 package.response() = apdu;
637 f->m_is_virtual = true;
642 else if (!f->m_is_virtual)
644 else if (gdu && gdu->which == Z_GDU_Z3950)
646 Z_APDU *apdu = gdu->u.z3950;
647 if (apdu->which == Z_APDU_initRequest)
651 package.response() = odr.create_close(
653 Z_Close_protocolError,
656 package.session().close();
658 else if (apdu->which == Z_APDU_searchRequest)
660 f->search(package, apdu);
662 else if (apdu->which == Z_APDU_presentRequest)
664 f->present(package, apdu);
666 else if (apdu->which == Z_APDU_scanRequest)
668 f->scan(package, apdu);
674 package.response() = odr.create_close(
675 apdu, Z_Close_protocolError,
676 "unsupported APDU in filter_virt_db");
678 package.session().close();
681 m_p->release_frontend(package);
685 void yp2::filter::Virt_db::configure(const xmlNode * ptr)
687 for (ptr = ptr->children; ptr; ptr = ptr->next)
689 if (ptr->type != XML_ELEMENT_NODE)
691 if (!strcmp((const char *) ptr->name, "virtual"))
693 std::string database;
694 std::list<std::string> targets;
695 xmlNode *v_node = ptr->children;
696 for (; v_node; v_node = v_node->next)
698 if (v_node->type != XML_ELEMENT_NODE)
701 if (yp2::xml::is_element_yp2(v_node, "database"))
702 database = yp2::xml::get_text(v_node);
703 else if (yp2::xml::is_element_yp2(v_node, "target"))
704 targets.push_back(yp2::xml::get_text(v_node));
706 throw yp2::filter::FilterException
708 + std::string((const char *) v_node->name)
709 + " in virtual section"
712 std::string route = yp2::xml::get_route(ptr);
713 add_map_db2targets(database, targets, route);
717 throw yp2::filter::FilterException
719 + std::string((const char *) ptr->name)
720 + " in virt_db filter");
725 static yp2::filter::Base* filter_creator()
727 return new yp2::filter::Virt_db;
731 struct yp2_filter_struct yp2_filter_virt_db = {
742 * indent-tabs-mode: nil
743 * c-file-style: "stroustrup"
745 * vim: shiftwidth=4 tabstop=8 expandtab