22 #include <metaproxy/package.hpp>
24 #include <boost/thread/mutex.hpp>
25 #include <boost/thread/condition.hpp>
26 #include <boost/shared_ptr.hpp>
28 #include <metaproxy/util.hpp>
31 #include <yaz/otherinfo.h>
32 #include <yaz/diagbib1.h>
33 #include <yaz/match_glob.h>
35 #include <yaz/oid_db.h>
41 namespace yf = mp::filter;
55 Map(std::string database, std::list<std::string> targets, std::string route);
56 Map(std::string database, std::string target, std::string route);
58 bool match(
const std::string db)
const;
78 std::map<std::string,VirtualDB::Set>
m_sets;
80 void search(Package &package, Z_APDU *apdu);
81 void present(Package &package, Z_APDU *apdu);
82 void scan(Package &package, Z_APDU *apdu);
83 int relay_apdu(Package &package, Z_APDU *apdu);
85 void close(Package &package);
86 typedef std::map<std::string,VirtualDB::Set>::iterator
Sets_it;
95 std::list<std::string> databases,
97 std::string &failing_database);
101 int &error_code, std::string &addinfo);
113 typedef std::map<std::string,VirtualDB::Set>::iterator
Sets_it;
122 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
123 std::list<std::string> databases,
int &error_code, std::string &addinfo)
126 std::list<std::string>::const_iterator db_it = databases.begin();
128 b->m_frontend_databases = databases;
129 b->m_named_result_sets =
false;
131 bool first_route =
true;
133 std::map<std::string,bool> targets_dedup;
134 for (; db_it != databases.end(); db_it++)
136 std::list<VirtualDB::Map>::const_iterator map_it;
137 map_it = m_p->m_maps.begin();
138 while (map_it != m_p->m_maps.end())
140 if (map_it->match(*db_it))
145 if (map_it == m_p->m_maps.end())
147 error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
152 std::list<std::string>::const_iterator t_it =
153 map_it->m_targets.begin();
154 for (; t_it != map_it->m_targets.end(); t_it++) {
155 if (!targets_dedup[*t_it])
157 targets_dedup[*t_it] =
true;
158 b->m_targets.push_back(*t_it);
163 if (!first_route && b->m_route != map_it->m_route)
166 error_code = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
170 b->m_route = map_it->m_route;
176 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
177 std::list<std::string> databases, mp::Package &package,
178 int &error_code, std::string &addinfo)
180 BackendPtr b = create_backend_from_databases(databases, error_code,
184 Package init_package(b->m_backend_session, package.origin());
185 init_package.copy_filter(package);
189 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
191 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
193 Z_InitRequest *req = init_apdu->u.initRequest;
196 Z_GDU *org_gdu = m_init_gdu.get();
197 Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
200 const char *peer_name = yaz_oi_get_string_oid(
201 &org_init->otherInfo, yaz_oid_userinfo_client_ip, 1, 0);
203 yaz_oi_set_string_oid(&init_apdu->u.initRequest->otherInfo, odr,
204 yaz_oid_userinfo_client_ip, 1, peer_name);
206 req->idAuthentication = org_init->idAuthentication;
207 req->implementationId = org_init->implementationId;
208 req->implementationName = org_init->implementationName;
209 req->implementationVersion = org_init->implementationVersion;
210 *req->preferredMessageSize = *org_init->preferredMessageSize;
211 *req->maximumRecordSize = *org_init->maximumRecordSize;
213 ODR_MASK_SET(req->options, Z_Options_search);
214 ODR_MASK_SET(req->options, Z_Options_present);
215 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
216 ODR_MASK_SET(req->options, Z_Options_scan);
218 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
219 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
220 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
222 init_package.request() = init_apdu;
224 init_package.move(b->m_route);
226 Z_GDU *gdu = init_package.response().get();
229 if (gdu && gdu->which == Z_GDU_Z3950
230 && gdu->u.z3950->which == Z_APDU_initResponse)
232 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
233 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
235 b->m_named_result_sets =
true;
237 if (*res->result && !init_package.session().is_closed())
239 m_backend_list.push_back(b);
242 mp::util::get_init_diagnostics(res, error_code, addinfo);
246 std::list<std::string>::const_iterator db_it = databases.begin();
247 error_code = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
248 if (db_it != databases.end())
251 if (!init_package.session().is_closed())
253 Package close_package(b->m_backend_session, package.origin());
254 close_package.copy_filter(package);
255 close_package.session().close();
256 close_package.move(b->m_route);
262 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
264 yazpp_1::GDU ngdu(apdu_req);
265 Z_SearchRequest *req = ngdu.get()->u.z3950->u.searchRequest;
267 std::string resultSetId = req->resultSetName;
270 std::list<std::string> databases;
272 for (i = 0; i<req->num_databaseNames; i++)
273 databases.push_back(req->databaseNames[i]);
275 Sets_it sets_it = m_sets.find(req->resultSetName);
276 bool override_set =
false;
277 if (sets_it != m_sets.end())
282 if (*req->replaceIndicator == 0)
285 odr.create_searchResponse(
287 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
289 package.response() = apdu;
298 std::list<BackendPtr>::const_iterator map_it;
299 map_it = m_backend_list.begin();
300 for (; map_it != m_backend_list.end(); map_it++)
303 if (mp::util::match(tmp->m_frontend_databases, databases) &&
304 (tmp->m_named_result_sets || override_set))
314 b = init_backend(databases, package, error_code, addinfo);
320 odr.create_searchResponse(
321 apdu_req, error_code, addinfo.c_str());
322 package.response() = apdu;
326 m_sets.erase(req->resultSetName);
328 Package search_package(b->m_backend_session, package.origin());
330 search_package.copy_filter(package);
332 std::string backend_setname;
333 if (b->m_named_result_sets)
335 backend_setname = std::string(req->resultSetName);
339 backend_setname =
"default";
340 req->resultSetName = odr_strdup(odr, backend_setname.c_str());
344 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
345 if (t_it != b->m_targets.end())
347 mp::util::set_databases_from_zurl(odr, *t_it,
348 &req->num_databaseNames,
349 &req->databaseNames);
352 *req->replaceIndicator = 1;
354 search_package.request() = ngdu;
356 search_package.move(b->m_route);
358 if (search_package.session().is_closed())
360 package.response() = search_package.response();
361 package.session().close();
365 Z_GDU *gdu = search_package.response().get();
366 if (gdu && gdu->which == Z_GDU_Z3950
367 && gdu->u.z3950->which == Z_APDU_searchResponse)
369 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
370 Z_Records *z_records = b_resp->records;
371 if (!z_records || (z_records && z_records->which == Z_Records_DBOSD))
374 fixup_package(search_package, b);
377 package.response() = search_package.response();
380 yf::VirtualDB::Frontend::Frontend(
Rep *rep)
383 m_is_virtual =
false;
386 void yf::VirtualDB::Frontend::close(mp::Package &package)
388 std::list<BackendPtr>::const_iterator b_it;
390 for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
392 (*b_it)->m_backend_session.close();
393 Package close_package((*b_it)->m_backend_session, package.origin());
394 close_package.copy_filter(package);
395 close_package.move((*b_it)->m_route);
397 m_backend_list.clear();
400 yf::VirtualDB::Frontend::~Frontend()
404 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
406 boost::mutex::scoped_lock lock(m_mutex);
408 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
412 it = m_clients.find(package.session());
413 if (it == m_clients.end())
416 if (!it->second->m_in_use)
418 it->second->m_in_use =
true;
421 m_cond_session_ready.wait(lock);
424 m_clients[package.session()] = f;
429 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
431 boost::mutex::scoped_lock lock(m_mutex);
432 std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
434 it = m_clients.find(package.session());
435 if (it != m_clients.end())
437 if (package.session().is_closed())
439 it->second->close(package);
444 it->second->m_in_use =
false;
446 m_cond_session_ready.notify_all();
452 : m_backend(b), m_setname(setname)
457 yf::VirtualDB::Set::Set()
462 yf::VirtualDB::Set::~Set()
466 yf::VirtualDB::Map::Map(std::string database,
467 std::list<std::string> targets, std::string route)
468 : m_dbpattern(database), m_targets(targets), m_route(route)
472 yf::VirtualDB::Map::Map(std::string database,
473 std::string target, std::string route)
474 : m_dbpattern(database), m_route(route)
480 yf::VirtualDB::Map::Map()
484 bool yf::VirtualDB::Map::match(
const std::string db)
const
486 std::string norm_db = mp::util::database_name_normalize(db);
487 if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
494 m_p->pass_vhosts =
false;
497 yf::VirtualDB::~VirtualDB() {
500 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
503 if (npr->databaseName)
505 std::string b_database = std::string(npr->databaseName);
508 std::list<std::string>::const_iterator db_it;
509 for (db_it = b->m_frontend_databases.begin();
510 db_it != b->m_frontend_databases.end(); db_it++)
513 std::list<VirtualDB::Map>::const_iterator map_it =
515 while (map_it != m_p->m_maps.end())
517 if (map_it->match(*db_it))
521 if (map_it != m_p->m_maps.end())
523 std::list<std::string>::const_iterator t
524 = map_it->m_targets.begin();
525 while (t != map_it->m_targets.end())
527 if (*t == b_database)
529 npr->databaseName = odr_strdup(odr, (*db_it).c_str());
537 db_it = b->m_frontend_databases.begin();
538 if (db_it != b->m_frontend_databases.end())
540 std::string database = *db_it;
541 npr->databaseName = odr_strdup(odr, database.c_str());
546 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
549 if (records && records->which == Z_Records_DBOSD)
551 Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
553 for (i = 0; i < nprlist->num_records; i++)
555 fixup_npr_record(odr, nprlist->records[i], b);
560 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p,
BackendPtr b)
562 Z_GDU *gdu = p.response().get();
565 if (gdu && gdu->which == Z_GDU_Z3950)
567 Z_APDU *apdu = gdu->u.z3950;
568 if (apdu->which == Z_APDU_presentResponse)
570 fixup_npr_records(odr, apdu->u.presentResponse->records, b);
573 else if (apdu->which == Z_APDU_searchResponse)
575 fixup_npr_records(odr, apdu->u.searchResponse->records, b);
581 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
583 yazpp_1::GDU ngdu(apdu_req);
584 Z_PresentRequest *req = ngdu.get()->u.z3950->u.presentRequest;
585 std::string resultSetId = req->resultSetId;
588 Sets_it sets_it = m_sets.find(resultSetId);
589 if (sets_it == m_sets.end())
592 odr.create_presentResponse(
594 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
595 resultSetId.c_str());
596 package.response() = apdu;
600 new mp::Session(sets_it->second.m_backend->m_backend_session);
603 Package present_package(*
id, package.origin());
604 present_package.copy_filter(package);
606 req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
608 present_package.request() = ngdu;
610 present_package.move(sets_it->second.m_backend->m_route);
612 fixup_package(present_package, sets_it->second.m_backend);
614 if (present_package.session().is_closed())
616 package.response() = present_package.response();
617 package.session().close();
621 package.response() = present_package.response();
626 int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
629 std::list<BackendPtr>::const_iterator map_it;
630 map_it = m_backend_list.begin();
631 for (; map_it != m_backend_list.end(); map_it++)
635 Package relay_package(b->m_backend_session, package.origin());
636 relay_package.copy_filter(package);
638 relay_package.request() = yazpp_1::GDU(apdu_req);
640 relay_package.move(b->m_route);
641 package.response() = relay_package.response();
647 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
649 yazpp_1::GDU ngdu(apdu_req);
650 Z_ScanRequest *req = ngdu.get()->u.z3950->u.scanRequest;
654 std::list<std::string> databases;
656 for (i = 0; i<req->num_databaseNames; i++)
657 databases.push_back(req->databaseNames[i]);
661 std::list<BackendPtr>::const_iterator map_it;
662 map_it = m_backend_list.begin();
663 for (; map_it != m_backend_list.end(); map_it++)
666 if (mp::util::match(tmp->m_frontend_databases, databases))
669 if (map_it != m_backend_list.end())
675 b = init_backend(databases, package, error_code, addinfo);
680 odr.create_scanResponse(
681 apdu_req, error_code, addinfo.c_str());
682 package.response() = apdu;
688 Package scan_package(b->m_backend_session, package.origin());
690 scan_package.copy_filter(package);
693 std::list<std::string>::const_iterator t_it = b->m_targets.begin();
694 if (t_it != b->m_targets.end())
696 mp::util::set_databases_from_zurl(odr, *t_it,
697 &req->num_databaseNames,
698 &req->databaseNames);
701 scan_package.request() = ngdu;
703 scan_package.move(b->m_route);
705 if (scan_package.session().is_closed())
707 package.response() = scan_package.response();
708 package.session().close();
711 package.response() = scan_package.response();
715 void yf::VirtualDB::add_map_db2targets(std::string db,
716 std::list<std::string> targets,
719 m_p->m_maps.push_back(
720 VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
724 void yf::VirtualDB::add_map_db2target(std::string db,
729 m_p->m_maps.push_back(
730 VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
733 void yf::VirtualDB::process(mp::Package &package)
const
737 Z_GDU *gdu = package.request().get();
739 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
740 Z_APDU_initRequest && !f->m_is_virtual)
742 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
744 std::list<std::string> vhosts;
745 mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
747 if (vhosts.size() > 0 && m_p->pass_vhosts)
756 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
757 Z_InitResponse *resp = apdu->u.initResponse;
760 static const int masks[] = {
763 Z_Options_namedResultSets,
767 for (i = 0; masks[i] != -1; i++)
768 if (ODR_MASK_GET(req->options, masks[i]))
769 ODR_MASK_SET(resp->options, masks[i]);
771 static const int versions[] = {
777 for (i = 0; versions[i] != -1; i++)
778 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
779 ODR_MASK_SET(resp->protocolVersion, versions[i]);
783 *resp->preferredMessageSize = *req->preferredMessageSize;
784 *resp->maximumRecordSize = *req->maximumRecordSize;
786 package.response() = apdu;
787 f->m_is_virtual =
true;
790 else if (!f->m_is_virtual)
792 else if (gdu && gdu->which == Z_GDU_Z3950)
794 Z_APDU *apdu = gdu->u.z3950;
795 if (apdu->which == Z_APDU_initRequest)
799 package.response() = odr.create_close(
801 Z_Close_protocolError,
804 package.session().close();
806 else if (apdu->which == Z_APDU_searchRequest)
808 f->search(package, apdu);
810 else if (apdu->which == Z_APDU_presentRequest)
812 f->present(package, apdu);
814 else if (apdu->which == Z_APDU_scanRequest)
816 f->scan(package, apdu);
818 else if (apdu->which == Z_APDU_close)
820 if (f->relay_apdu(package, apdu) == 0)
824 package.response() = odr.create_close(
825 apdu, Z_Close_finished,
"virt_db");
827 package.session().close();
834 package.response() = odr.create_close(
835 apdu, Z_Close_protocolError,
836 "unsupported APDU in filter_virt_db");
838 package.session().close();
841 m_p->release_frontend(package);
844 void mp::filter::VirtualDB::configure(
const xmlNode * ptr,
bool test_only,
847 for (ptr = ptr->children; ptr; ptr = ptr->next)
849 if (ptr->type != XML_ELEMENT_NODE)
851 if (!strcmp((
const char *) ptr->name,
"pass-vhosts"))
853 m_p->pass_vhosts = mp::xml::get_bool(ptr,
false);
855 else if (!strcmp((
const char *) ptr->name,
"virtual"))
857 std::string database;
858 std::list<std::string> targets;
859 xmlNode *v_node = ptr->children;
860 for (; v_node; v_node = v_node->next)
862 if (v_node->type != XML_ELEMENT_NODE)
865 if (mp::xml::is_element_mp(v_node,
"database"))
866 database = mp::xml::get_text(v_node);
867 else if (mp::xml::is_element_mp(v_node,
"target"))
868 targets.push_back(mp::xml::get_text(v_node));
870 throw mp::filter::FilterException
872 + std::string((
const char *) v_node->name)
873 +
" in virtual section"
876 std::string route = mp::xml::get_route(ptr);
880 m_p->m_maps.push_back(vmap);
884 throw mp::filter::FilterException
886 + std::string((
const char *) ptr->name)
887 +
" in virt_db filter");
894 return new mp::filter::VirtualDB;
static mp::filter::Base * filter_creator()
struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db