1 /* $Id: filter_virt_db.cpp,v 1.31 2006-01-17 16:45:49 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 Z_GDU *gdu = init_package.response().get();
200 // we hope to get an init response
201 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
204 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
205 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
207 b->m_named_result_sets = true;
209 std::cout << "GOT INIT res=" << *res->result << "\n";
212 yp2::util::get_init_diagnostics(res, error_code, addinfo);
219 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
220 // addinfo = database;
224 if (init_package.session().is_closed())
226 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
227 // addinfo = database;
232 m_backend_list.push_back(b);
236 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
238 Z_SearchRequest *req = apdu_req->u.searchRequest;
240 std::string resultSetId = req->resultSetName;
243 std::list<std::string> databases;
245 for (i = 0; i<req->num_databaseNames; i++)
246 databases.push_back(req->databaseNames[i]);
248 BackendPtr b; // null for now
249 Sets_it sets_it = m_sets.find(req->resultSetName);
250 if (sets_it != m_sets.end())
252 // result set already exist
253 // if replace indicator is off: we return diagnostic if
254 // result set already exist.
255 if (*req->replaceIndicator == 0)
258 odr.create_searchResponse(
260 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
262 package.response() = apdu;
266 sets_it->second.m_backend->m_number_of_sets--;
268 // pick up any existing backend with a database match
269 std::list<BackendPtr>::const_iterator map_it;
270 map_it = m_backend_list.begin();
271 for (; map_it != m_backend_list.end(); map_it++)
273 BackendPtr tmp = *map_it;
274 if (tmp->m_frontend_databases == databases)
277 if (map_it != m_backend_list.end())
284 // pick up any existing database with named result sets ..
285 // or one which has no result sets.. yet.
286 std::list<BackendPtr>::const_iterator map_it;
287 map_it = m_backend_list.begin();
288 for (; map_it != m_backend_list.end(); map_it++)
290 BackendPtr tmp = *map_it;
291 if (tmp->m_frontend_databases == databases &&
292 (tmp->m_named_result_sets ||
293 tmp->m_number_of_sets == 0))
296 if (map_it != m_backend_list.end())
299 if (!b) // no backend yet. Must create a new one
303 b = init_backend(databases, package, error_code, addinfo);
306 // did not get a backend (unavailable somehow?)
309 odr.create_searchResponse(
310 apdu_req, error_code, addinfo.c_str());
311 package.response() = apdu;
315 m_sets.erase(req->resultSetName);
316 // sending search to backend
317 Package search_package(b->m_backend_session, package.origin());
319 search_package.copy_filter(package);
321 std::string backend_setname;
322 if (b->m_named_result_sets)
324 backend_setname = std::string(req->resultSetName);
328 backend_setname = "default";
329 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
332 // pick first targets spec and move the databases from it ..
333 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
334 if (t_it != b->m_targets.end())
336 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
337 &req->num_databaseNames,
338 &req->databaseNames));
341 *req->replaceIndicator = 1;
343 search_package.request() = yazpp_1::GDU(apdu_req);
345 search_package.move(b->m_route);
347 if (search_package.session().is_closed())
349 package.response() = search_package.response();
350 package.session().close();
353 package.response() = search_package.response();
355 b->m_number_of_sets++;
357 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
360 yf::Virt_db::Frontend::Frontend(Rep *rep)
363 m_is_virtual = false;
366 void yf::Virt_db::Frontend::close(Package &package)
368 std::list<BackendPtr>::const_iterator b_it;
370 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
372 (*b_it)->m_backend_session.close();
373 Package close_package((*b_it)->m_backend_session, package.origin());
374 close_package.copy_filter(package);
375 close_package.move((*b_it)->m_route);
377 m_backend_list.clear();
380 yf::Virt_db::Frontend::~Frontend()
384 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
386 boost::mutex::scoped_lock lock(m_mutex);
388 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
392 it = m_clients.find(package.session());
393 if (it == m_clients.end())
396 if (!it->second->m_in_use)
398 it->second->m_in_use = true;
401 m_cond_session_ready.wait(lock);
403 FrontendPtr f(new Frontend(this));
404 m_clients[package.session()] = f;
409 void yf::Virt_db::Rep::release_frontend(Package &package)
411 boost::mutex::scoped_lock lock(m_mutex);
412 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
414 it = m_clients.find(package.session());
415 if (it != m_clients.end())
417 if (package.session().is_closed())
419 it->second->close(package);
424 it->second->m_in_use = false;
426 m_cond_session_ready.notify_all();
430 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
431 : m_backend(b), m_setname(setname)
436 yf::Virt_db::Set::Set()
441 yf::Virt_db::Set::~Set()
445 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
446 : m_targets(targets), m_route(route)
450 yf::Virt_db::Map::Map()
454 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
458 yf::Virt_db::~Virt_db() {
461 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
463 Z_PresentRequest *req = apdu_req->u.presentRequest;
464 std::string resultSetId = req->resultSetId;
467 Sets_it sets_it = m_sets.find(resultSetId);
468 if (sets_it == m_sets.end())
471 odr.create_presentResponse(
473 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
474 resultSetId.c_str());
475 package.response() = apdu;
479 new yp2::Session(sets_it->second.m_backend->m_backend_session);
481 // sending present to backend
482 Package present_package(*id, package.origin());
483 present_package.copy_filter(package);
485 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
487 present_package.request() = yazpp_1::GDU(apdu_req);
489 present_package.move(sets_it->second.m_backend->m_route);
491 if (present_package.session().is_closed())
493 package.response() = present_package.response();
494 package.session().close();
499 package.response() = present_package.response();
504 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
506 Z_ScanRequest *req = apdu_req->u.scanRequest;
510 std::list<std::string> databases;
512 for (i = 0; i<req->num_databaseNames; i++)
513 databases.push_back(req->databaseNames[i]);
516 // pick up any existing backend with a database match
517 std::list<BackendPtr>::const_iterator map_it;
518 map_it = m_backend_list.begin();
519 for (; map_it != m_backend_list.end(); map_it++)
521 BackendPtr tmp = *map_it;
522 if (tmp->m_frontend_databases == databases)
525 if (map_it != m_backend_list.end())
527 if (!b) // no backend yet. Must create a new one
531 b = init_backend(databases, package, error_code, addinfo);
534 // did not get a backend (unavailable somehow?)
536 odr.create_scanResponse(
537 apdu_req, error_code, addinfo.c_str());
538 package.response() = apdu;
543 // sending scan to backend
544 Package scan_package(b->m_backend_session, package.origin());
546 scan_package.copy_filter(package);
548 // pick first targets spec and move the databases from it ..
549 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
550 if (t_it != b->m_targets.end())
552 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
553 &req->num_databaseNames,
554 &req->databaseNames));
556 scan_package.request() = yazpp_1::GDU(apdu_req);
558 scan_package.move(b->m_route);
560 if (scan_package.session().is_closed())
562 package.response() = scan_package.response();
563 package.session().close();
566 package.response() = scan_package.response();
570 void yf::Virt_db::add_map_db2targets(std::string db,
571 std::list<std::string> targets,
574 m_p->m_maps[db] = Virt_db::Map(targets, route);
578 void yf::Virt_db::add_map_db2target(std::string db,
582 std::list<std::string> targets;
583 targets.push_back(target);
585 m_p->m_maps[db] = Virt_db::Map(targets, route);
588 void yf::Virt_db::process(Package &package) const
590 FrontendPtr f = m_p->get_frontend(package);
592 Z_GDU *gdu = package.request().get();
594 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
595 Z_APDU_initRequest && !f->m_is_virtual)
597 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
600 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
604 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
605 Z_InitResponse *resp = apdu->u.initResponse;
608 static const int masks[] = {
611 Z_Options_namedResultSets,
615 for (i = 0; masks[i] != -1; i++)
616 if (ODR_MASK_GET(req->options, masks[i]))
617 ODR_MASK_SET(resp->options, masks[i]);
619 static const int versions[] = {
625 for (i = 0; versions[i] != -1; i++)
626 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
627 ODR_MASK_SET(resp->protocolVersion, versions[i]);
631 package.response() = apdu;
632 f->m_is_virtual = true;
637 else if (!f->m_is_virtual)
639 else if (gdu && gdu->which == Z_GDU_Z3950)
641 Z_APDU *apdu = gdu->u.z3950;
642 if (apdu->which == Z_APDU_initRequest)
646 package.response() = odr.create_close(
648 Z_Close_protocolError,
651 package.session().close();
653 else if (apdu->which == Z_APDU_searchRequest)
655 f->search(package, apdu);
657 else if (apdu->which == Z_APDU_presentRequest)
659 f->present(package, apdu);
661 else if (apdu->which == Z_APDU_scanRequest)
663 f->scan(package, apdu);
669 package.response() = odr.create_close(
670 apdu, Z_Close_protocolError,
671 "unsupported APDU in filter_virt_db");
673 package.session().close();
676 m_p->release_frontend(package);
680 void yp2::filter::Virt_db::configure(const xmlNode * ptr)
682 for (ptr = ptr->children; ptr; ptr = ptr->next)
684 if (ptr->type != XML_ELEMENT_NODE)
686 if (!strcmp((const char *) ptr->name, "virtual"))
688 std::string database;
689 std::list<std::string> targets;
690 xmlNode *v_node = ptr->children;
691 for (; v_node; v_node = v_node->next)
693 if (v_node->type != XML_ELEMENT_NODE)
696 if (yp2::xml::is_element_yp2(v_node, "database"))
697 database = yp2::xml::get_text(v_node);
698 else if (yp2::xml::is_element_yp2(v_node, "target"))
699 targets.push_back(yp2::xml::get_text(v_node));
701 throw yp2::filter::FilterException
703 + std::string((const char *) v_node->name)
704 + " in virtual section"
707 std::string route = yp2::xml::get_route(ptr);
708 add_map_db2targets(database, targets, route);
712 throw yp2::filter::FilterException
714 + std::string((const char *) ptr->name)
715 + " in virt_db filter");
720 static yp2::filter::Base* filter_creator()
722 return new yp2::filter::Virt_db;
726 struct yp2_filter_struct yp2_filter_virt_db = {
737 * indent-tabs-mode: nil
738 * c-file-style: "stroustrup"
740 * vim: shiftwidth=4 tabstop=8 expandtab