1 /* $Id: filter_virt_db.cpp,v 1.26 2006-01-16 15:51:56 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;
48 std::string m_backend_database;
50 std::list<std::string> m_frontend_databases;
51 std::list<std::string> m_targets;
53 bool m_named_result_sets;
56 struct Virt_db::Frontend {
59 yp2::Session m_session;
62 std::list<BackendPtr> m_backend_list;
63 std::map<std::string,Virt_db::Set> m_sets;
65 void search(Package &package, Z_APDU *apdu);
66 void present(Package &package, Z_APDU *apdu);
67 void scan(Package &package, Z_APDU *apdu);
69 void close(Package &package);
70 typedef std::map<std::string,Virt_db::Set>::iterator Sets_it;
72 BackendPtr lookup_backend_from_databases(
73 std::list<std::string> databases);
74 BackendPtr create_backend_from_databases(
75 std::list<std::string> databases);
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)
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 std::map<std::string,bool> targets_dedup;
126 for (; db_it != databases.end(); db_it++)
128 std::map<std::string, Virt_db::Map>::iterator map_it;
129 map_it = m_p->m_maps.find(*db_it);
130 if (map_it == m_p->m_maps.end()) // database not found
135 std::list<std::string>::const_iterator t_it =
136 map_it->second.m_targets.begin();
137 for (; t_it != map_it->second.m_targets.end(); t_it++)
138 targets_dedup[*t_it] = true;
139 b->m_route = map_it->second.m_route;
141 std::map<std::string,bool>::const_iterator tm_it = targets_dedup.begin();
142 for (; tm_it != targets_dedup.end(); tm_it++)
143 b->m_targets.push_back(tm_it->first);
145 const char *sep = strchr(b->m_vhost.c_str(), '/');
146 std::string backend_database;
148 b->m_backend_database = std::string(sep+1);
150 b->m_backend_database = database;
155 yf::Virt_db::BackendPtr yf::Virt_db::Frontend::init_backend(
156 std::list<std::string> databases, Package &package,
157 int &error_code, std::string &addinfo)
159 BackendPtr b = create_backend_from_databases(databases);
162 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
163 // addinfo = database;
166 Package init_package(b->m_backend_session, package.origin());
167 init_package.copy_filter(package);
171 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
173 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
175 for (; t_it != b->m_targets.end(); t_it++, cat++)
177 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
178 VAL_PROXY, cat, t_it->c_str());
180 Z_InitRequest *req = init_apdu->u.initRequest;
182 ODR_MASK_SET(req->options, Z_Options_search);
183 ODR_MASK_SET(req->options, Z_Options_present);
184 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
185 ODR_MASK_SET(req->options, Z_Options_scan);
187 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
188 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
189 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
191 init_package.request() = init_apdu;
193 init_package.move(b->m_route); // sending init
195 if (init_package.session().is_closed())
197 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
198 // addinfo = database;
202 Z_GDU *gdu = init_package.response().get();
203 // we hope to get an init response
204 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
207 if (ODR_MASK_GET(gdu->u.z3950->u.initResponse->options,
208 Z_Options_namedResultSets))
210 b->m_named_result_sets = true;
215 error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
216 // addinfo = database;
220 m_backend_list.push_back(b);
224 void yf::Virt_db::Frontend::search(Package &package, Z_APDU *apdu_req)
226 Z_SearchRequest *req = apdu_req->u.searchRequest;
228 std::string resultSetId = req->resultSetName;
231 std::list<std::string> databases;
233 for (i = 0; i<req->num_databaseNames; i++)
234 databases.push_back(req->databaseNames[i]);
236 BackendPtr b; // null for now
237 Sets_it sets_it = m_sets.find(req->resultSetName);
238 if (sets_it != m_sets.end())
240 // result set already exist
241 // if replace indicator is off: we return diagnostic if
242 // result set already exist.
243 if (*req->replaceIndicator == 0)
246 odr.create_searchResponse(
248 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
250 package.response() = apdu;
254 sets_it->second.m_backend->m_number_of_sets--;
256 // pick up any existing backend with a database match
257 std::list<BackendPtr>::const_iterator map_it;
258 map_it = m_backend_list.begin();
259 for (; map_it != m_backend_list.end(); map_it++)
261 BackendPtr tmp = *map_it;
262 if (tmp->m_frontend_databases == databases)
265 if (map_it != m_backend_list.end())
272 // pick up any existing database with named result sets ..
273 // or one which has no result sets.. yet.
274 std::list<BackendPtr>::const_iterator map_it;
275 map_it = m_backend_list.begin();
276 for (; map_it != m_backend_list.end(); map_it++)
278 BackendPtr tmp = *map_it;
279 if (tmp->m_frontend_databases == databases &&
280 (tmp->m_named_result_sets ||
281 tmp->m_number_of_sets == 0))
284 if (map_it != m_backend_list.end())
287 if (!b) // no backend yet. Must create a new one
291 b = init_backend(databases, package, error_code, addinfo);
294 // did not get a backend (unavailable somehow?)
297 odr.create_searchResponse(
298 apdu_req, error_code, addinfo.c_str());
299 package.response() = apdu;
303 m_sets.erase(req->resultSetName);
304 // sending search to backend
305 Package search_package(b->m_backend_session, package.origin());
307 search_package.copy_filter(package);
309 std::string backend_setname;
310 if (b->m_named_result_sets)
312 backend_setname = std::string(req->resultSetName);
316 backend_setname = "default";
317 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
321 const char *backend_database = b->m_backend_database.c_str();
322 req->databaseNames[0] = odr_strdup(odr, backend_database);
325 *req->replaceIndicator = 1;
327 search_package.request() = yazpp_1::GDU(apdu_req);
329 search_package.move(b->m_route);
331 if (search_package.session().is_closed())
334 odr.create_searchResponse(
335 apdu_req, YAZ_BIB1_DATABASE_UNAVAILABLE, 0);
336 package.response() = apdu;
339 package.response() = search_package.response();
341 b->m_number_of_sets++;
343 m_sets[resultSetId] = Virt_db::Set(b, backend_setname);
346 yf::Virt_db::Frontend::Frontend(Rep *rep)
349 m_is_virtual = false;
352 void yf::Virt_db::Frontend::close(Package &package)
354 std::list<BackendPtr>::const_iterator b_it;
356 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
358 (*b_it)->m_backend_session.close();
359 Package close_package((*b_it)->m_backend_session, package.origin());
360 close_package.copy_filter(package);
361 close_package.move((*b_it)->m_route);
363 m_backend_list.clear();
366 yf::Virt_db::Frontend::~Frontend()
370 yf::Virt_db::FrontendPtr yf::Virt_db::Rep::get_frontend(Package &package)
372 boost::mutex::scoped_lock lock(m_mutex);
374 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
378 it = m_clients.find(package.session());
379 if (it == m_clients.end())
382 if (!it->second->m_in_use)
384 it->second->m_in_use = true;
387 m_cond_session_ready.wait(lock);
389 FrontendPtr f(new Frontend(this));
390 m_clients[package.session()] = f;
395 void yf::Virt_db::Rep::release_frontend(Package &package)
397 boost::mutex::scoped_lock lock(m_mutex);
398 std::map<yp2::Session,yf::Virt_db::FrontendPtr>::iterator it;
400 it = m_clients.find(package.session());
401 if (it != m_clients.end())
403 if (package.session().is_closed())
405 it->second->close(package);
410 it->second->m_in_use = false;
412 m_cond_session_ready.notify_all();
416 yf::Virt_db::Set::Set(BackendPtr b, std::string setname)
417 : m_backend(b), m_setname(setname)
422 yf::Virt_db::Set::Set()
427 yf::Virt_db::Set::~Set()
431 yf::Virt_db::Map::Map(std::list<std::string> targets, std::string route)
432 : m_targets(targets), m_route(route)
436 yf::Virt_db::Map::Map()
440 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
444 yf::Virt_db::~Virt_db() {
447 void yf::Virt_db::Frontend::present(Package &package, Z_APDU *apdu_req)
449 Z_PresentRequest *req = apdu_req->u.presentRequest;
450 std::string resultSetId = req->resultSetId;
453 Sets_it sets_it = m_sets.find(resultSetId);
454 if (sets_it == m_sets.end())
457 odr.create_presentResponse(
459 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
460 resultSetId.c_str());
461 package.response() = apdu;
465 new yp2::Session(sets_it->second.m_backend->m_backend_session);
467 // sending present to backend
468 Package present_package(*id, package.origin());
469 present_package.copy_filter(package);
471 req->resultSetId = odr_strdup(odr, "default");
472 present_package.request() = yazpp_1::GDU(apdu_req);
474 present_package.move();
476 if (present_package.session().is_closed())
479 odr.create_presentResponse(
481 YAZ_BIB1_RESULT_SET_NO_LONGER_EXISTS_UNILATERALLY_DELETED_BY_,
482 resultSetId.c_str());
483 package.response() = apdu;
484 m_sets.erase(resultSetId);
488 package.response() = present_package.response();
493 void yf::Virt_db::Frontend::scan(Package &package, Z_APDU *apdu_req)
495 Z_ScanRequest *req = apdu_req->u.scanRequest;
499 std::list<std::string> databases;
501 for (i = 0; i<req->num_databaseNames; i++)
502 databases.push_back(req->databaseNames[i]);
505 // pick up any existing backend with a database match
506 std::list<BackendPtr>::const_iterator map_it;
507 map_it = m_backend_list.begin();
508 for (; map_it != m_backend_list.end(); map_it++)
510 BackendPtr tmp = *map_it;
511 if (tmp->m_frontend_databases == databases)
514 if (map_it != m_backend_list.end())
516 if (!b) // no backend yet. Must create a new one
520 b = init_backend(databases, package, error_code, addinfo);
523 // did not get a backend (unavailable somehow?)
525 odr.create_scanResponse(
526 apdu_req, error_code, addinfo.c_str());
527 package.response() = apdu;
532 // sending scan to backend
533 Package scan_package(b->m_backend_session, package.origin());
535 scan_package.copy_filter(package);
538 const char *backend_database = b->m_backend_database.c_str();
539 req->databaseNames[0] = odr_strdup(odr, backend_database);
542 scan_package.request() = yazpp_1::GDU(apdu_req);
544 scan_package.move(b->m_route);
546 if (scan_package.session().is_closed())
549 odr.create_scanResponse(
550 apdu_req, YAZ_BIB1_DATABASE_UNAVAILABLE, 0);
551 package.response() = apdu;
554 package.response() = scan_package.response();
558 void yf::Virt_db::add_map_db2targets(std::string db,
559 std::list<std::string> targets,
562 m_p->m_maps[db] = Virt_db::Map(targets, route);
566 void yf::Virt_db::add_map_db2target(std::string db,
570 std::list<std::string> targets;
571 targets.push_back(target);
573 m_p->m_maps[db] = Virt_db::Map(targets, route);
576 void yf::Virt_db::process(Package &package) const
578 FrontendPtr f = m_p->get_frontend(package);
580 Z_GDU *gdu = package.request().get();
582 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
583 Z_APDU_initRequest && !f->m_is_virtual)
585 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
588 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
592 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
593 Z_InitResponse *resp = apdu->u.initResponse;
596 static const int masks[] = {
599 Z_Options_namedResultSets,
603 for (i = 0; masks[i] != -1; i++)
604 if (ODR_MASK_GET(req->options, masks[i]))
605 ODR_MASK_SET(resp->options, masks[i]);
607 static const int versions[] = {
613 for (i = 0; versions[i] != -1; i++)
614 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
615 ODR_MASK_SET(resp->protocolVersion, versions[i]);
619 package.response() = apdu;
620 f->m_is_virtual = true;
625 else if (!f->m_is_virtual)
627 else if (gdu && gdu->which == Z_GDU_Z3950)
629 Z_APDU *apdu = gdu->u.z3950;
630 if (apdu->which == Z_APDU_initRequest)
634 package.response() = odr.create_close(
636 Z_Close_protocolError,
639 package.session().close();
641 else if (apdu->which == Z_APDU_searchRequest)
643 f->search(package, apdu);
645 else if (apdu->which == Z_APDU_presentRequest)
647 f->present(package, apdu);
649 else if (apdu->which == Z_APDU_scanRequest)
651 f->scan(package, apdu);
657 package.response() = odr.create_close(
658 apdu, Z_Close_protocolError,
659 "unsupported APDU in filter_virt_db");
661 package.session().close();
664 m_p->release_frontend(package);
668 void yp2::filter::Virt_db::configure(const xmlNode * ptr)
670 for (ptr = ptr->children; ptr; ptr = ptr->next)
672 if (ptr->type != XML_ELEMENT_NODE)
674 if (!strcmp((const char *) ptr->name, "virtual"))
676 std::string database;
677 std::list<std::string> targets;
678 xmlNode *v_node = ptr->children;
679 for (; v_node; v_node = v_node->next)
681 if (v_node->type != XML_ELEMENT_NODE)
684 if (yp2::xml::is_element_yp2(v_node, "database"))
685 database = yp2::xml::get_text(v_node);
686 else if (yp2::xml::is_element_yp2(v_node, "target"))
687 targets.push_back(yp2::xml::get_text(v_node));
689 throw yp2::filter::FilterException
691 + std::string((const char *) v_node->name)
692 + " in virtual section"
695 std::string route = yp2::xml::get_route(ptr);
696 add_map_db2targets(database, targets, route);
698 std::cout << "Add " << database << "->" << target
699 << "," << route << "\n";
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