1 /* $Id: filter_virt_db.cpp,v 1.32 2006-01-18 10:30:28 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 class 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 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
179 for (; t_it != b->m_targets.end(); t_it++, cat++)
181 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
182 VAL_PROXY, cat, t_it->c_str());
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;
219 std::cout << "GOT INIT res=" << *res->result << "\n";
222 yp2::util::get_init_diagnostics(res, error_code, addinfo);
229 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
230 // addinfo = database;
234 if (init_package.session().is_closed())
236 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
237 // addinfo = database;
242 m_backend_list.push_back(b);
246 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
248 Z_SearchRequest *req = apdu_req->u.searchRequest;
250 std::string resultSetId = req->resultSetName;
253 std::list<std::string> databases;
255 for (i = 0; i<req->num_databaseNames; i++)
256 databases.push_back(req->databaseNames[i]);
258 BackendPtr b; // null for now
259 Sets_it sets_it = m_sets.find(req->resultSetName);
260 if (sets_it != m_sets.end())
262 // result set already exist
263 // if replace indicator is off: we return diagnostic if
264 // result set already exist.
265 if (*req->replaceIndicator == 0)
268 odr.create_searchResponse(
270 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
272 package.response() = apdu;
276 sets_it->second.m_backend->m_number_of_sets--;
278 // pick up any existing backend with a database match
279 std::list<BackendPtr>::const_iterator map_it;
280 map_it = m_backend_list.begin();
281 for (; map_it != m_backend_list.end(); map_it++)
283 BackendPtr tmp = *map_it;
284 if (tmp->m_frontend_databases == databases)
287 if (map_it != m_backend_list.end())
294 // pick up any existing database with named result sets ..
295 // or one which has no result sets.. yet.
296 std::list<BackendPtr>::const_iterator map_it;
297 map_it = m_backend_list.begin();
298 for (; map_it != m_backend_list.end(); map_it++)
300 BackendPtr tmp = *map_it;
301 if (tmp->m_frontend_databases == databases &&
302 (tmp->m_named_result_sets ||
303 tmp->m_number_of_sets == 0))
306 if (map_it != m_backend_list.end())
309 if (!b) // no backend yet. Must create a new one
313 b = init_backend(databases, package, error_code, addinfo);
316 // did not get a backend (unavailable somehow?)
319 odr.create_searchResponse(
320 apdu_req, error_code, addinfo.c_str());
321 package.response() = apdu;
325 m_sets.erase(req->resultSetName);
326 // sending search to backend
327 Package search_package(b->m_backend_session, package.origin());
329 search_package.copy_filter(package);
331 std::string backend_setname;
332 if (b->m_named_result_sets)
334 backend_setname = std::string(req->resultSetName);
338 backend_setname = "default";
339 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
342 // pick first targets spec and move the databases from it ..
343 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
344 if (t_it != b->m_targets.end())
346 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
347 &req->num_databaseNames,
348 &req->databaseNames));
351 *req->replaceIndicator = 1;
353 search_package.request() = yazpp_1::GDU(apdu_req);
355 search_package.move(b->m_route);
357 if (search_package.session().is_closed())
359 package.response() = search_package.response();
360 package.session().close();
363 package.response() = search_package.response();
365 b->m_number_of_sets++;
367 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
370 yf::Virt_db::Frontend::Frontend(Rep *rep)
373 m_is_virtual = false;
376 void yf::Virt_db::Frontend::close(Package &package)
378 std::list<BackendPtr>::const_iterator b_it;
380 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
382 (*b_it)->m_backend_session.close();
383 Package close_package((*b_it)->m_backend_session, package.origin());
384 close_package.copy_filter(package);
385 close_package.move((*b_it)->m_route);
387 m_backend_list.clear();
390 yf::Virt_db::Frontend::~Frontend()
394 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
396 boost::mutex::scoped_lock lock(m_mutex);
398 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
402 it = m_clients.find(package.session());
403 if (it == m_clients.end())
406 if (!it->second->m_in_use)
408 it->second->m_in_use = true;
411 m_cond_session_ready.wait(lock);
413 FrontendPtr f(new Frontend(this));
414 m_clients[package.session()] = f;
419 void yf::Virt_db::Rep::release_frontend(Package &package)
421 boost::mutex::scoped_lock lock(m_mutex);
422 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
424 it = m_clients.find(package.session());
425 if (it != m_clients.end())
427 if (package.session().is_closed())
429 it->second->close(package);
434 it->second->m_in_use = false;
436 m_cond_session_ready.notify_all();
440 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
441 : m_backend(b), m_setname(setname)
446 yf::Virt_db::Set::Set()
451 yf::Virt_db::Set::~Set()
455 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
456 : m_targets(targets), m_route(route)
460 yf::Virt_db::Map::Map()
464 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
468 yf::Virt_db::~Virt_db() {
471 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
473 Z_PresentRequest *req = apdu_req->u.presentRequest;
474 std::string resultSetId = req->resultSetId;
477 Sets_it sets_it = m_sets.find(resultSetId);
478 if (sets_it == m_sets.end())
481 odr.create_presentResponse(
483 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
484 resultSetId.c_str());
485 package.response() = apdu;
489 new yp2::Session(sets_it->second.m_backend->m_backend_session);
491 // sending present to backend
492 Package present_package(*id, package.origin());
493 present_package.copy_filter(package);
495 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
497 present_package.request() = yazpp_1::GDU(apdu_req);
499 present_package.move(sets_it->second.m_backend->m_route);
501 if (present_package.session().is_closed())
503 package.response() = present_package.response();
504 package.session().close();
509 package.response() = present_package.response();
514 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
516 Z_ScanRequest *req = apdu_req->u.scanRequest;
520 std::list<std::string> databases;
522 for (i = 0; i<req->num_databaseNames; i++)
523 databases.push_back(req->databaseNames[i]);
526 // pick up any existing backend with a database match
527 std::list<BackendPtr>::const_iterator map_it;
528 map_it = m_backend_list.begin();
529 for (; map_it != m_backend_list.end(); map_it++)
531 BackendPtr tmp = *map_it;
532 if (tmp->m_frontend_databases == databases)
535 if (map_it != m_backend_list.end())
537 if (!b) // no backend yet. Must create a new one
541 b = init_backend(databases, package, error_code, addinfo);
544 // did not get a backend (unavailable somehow?)
546 odr.create_scanResponse(
547 apdu_req, error_code, addinfo.c_str());
548 package.response() = apdu;
553 // sending scan to backend
554 Package scan_package(b->m_backend_session, package.origin());
556 scan_package.copy_filter(package);
558 // pick first targets spec and move the databases from it ..
559 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
560 if (t_it != b->m_targets.end())
562 if (!yp2::util::set_databases_from_zurl(odr, *t_it,
563 &req->num_databaseNames,
564 &req->databaseNames));
566 scan_package.request() = yazpp_1::GDU(apdu_req);
568 scan_package.move(b->m_route);
570 if (scan_package.session().is_closed())
572 package.response() = scan_package.response();
573 package.session().close();
576 package.response() = scan_package.response();
580 void yf::Virt_db::add_map_db2targets(std::string db,
581 std::list<std::string> targets,
584 m_p->m_maps[db] = Virt_db::Map(targets, route);
588 void yf::Virt_db::add_map_db2target(std::string db,
592 std::list<std::string> targets;
593 targets.push_back(target);
595 m_p->m_maps[db] = Virt_db::Map(targets, route);
598 void yf::Virt_db::process(Package &package) const
600 FrontendPtr f = m_p->get_frontend(package);
602 Z_GDU *gdu = package.request().get();
604 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
605 Z_APDU_initRequest && !f->m_is_virtual)
607 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
610 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
616 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
617 Z_InitResponse *resp = apdu->u.initResponse;
620 static const int masks[] = {
623 Z_Options_namedResultSets,
627 for (i = 0; masks[i] != -1; i++)
628 if (ODR_MASK_GET(req->options, masks[i]))
629 ODR_MASK_SET(resp->options, masks[i]);
631 static const int versions[] = {
637 for (i = 0; versions[i] != -1; i++)
638 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
639 ODR_MASK_SET(resp->protocolVersion, versions[i]);
643 package.response() = apdu;
644 f->m_is_virtual = true;
649 else if (!f->m_is_virtual)
651 else if (gdu && gdu->which == Z_GDU_Z3950)
653 Z_APDU *apdu = gdu->u.z3950;
654 if (apdu->which == Z_APDU_initRequest)
658 package.response() = odr.create_close(
660 Z_Close_protocolError,
663 package.session().close();
665 else if (apdu->which == Z_APDU_searchRequest)
667 f->search(package, apdu);
669 else if (apdu->which == Z_APDU_presentRequest)
671 f->present(package, apdu);
673 else if (apdu->which == Z_APDU_scanRequest)
675 f->scan(package, apdu);
681 package.response() = odr.create_close(
682 apdu, Z_Close_protocolError,
683 "unsupported APDU in filter_virt_db");
685 package.session().close();
688 m_p->release_frontend(package);
692 void yp2::filter::Virt_db::configure(const xmlNode * ptr)
694 for (ptr = ptr->children; ptr; ptr = ptr->next)
696 if (ptr->type != XML_ELEMENT_NODE)
698 if (!strcmp((const char *) ptr->name, "virtual"))
700 std::string database;
701 std::list<std::string> targets;
702 xmlNode *v_node = ptr->children;
703 for (; v_node; v_node = v_node->next)
705 if (v_node->type != XML_ELEMENT_NODE)
708 if (yp2::xml::is_element_yp2(v_node, "database"))
709 database = yp2::xml::get_text(v_node);
710 else if (yp2::xml::is_element_yp2(v_node, "target"))
711 targets.push_back(yp2::xml::get_text(v_node));
713 throw yp2::filter::FilterException
715 + std::string((const char *) v_node->name)
716 + " in virtual section"
719 std::string route = yp2::xml::get_route(ptr);
720 add_map_db2targets(database, targets, route);
724 throw yp2::filter::FilterException
726 + std::string((const char *) ptr->name)
727 + " in virt_db filter");
732 static yp2::filter::Base* filter_creator()
734 return new yp2::filter::Virt_db;
738 struct yp2_filter_struct yp2_filter_virt_db = {
749 * indent-tabs-mode: nil
750 * c-file-style: "stroustrup"
752 * vim: shiftwidth=4 tabstop=8 expandtab