src/filter_virt_db.cpp

   1 /* This file is part of Metaproxy.
   2    Copyright (C) 2005-2011 Index Data
   3
   4 Metaproxy is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19 #include "config.hpp"
  20
  21 #include "filter_virt_db.hpp"
  22 #include <metaproxy/package.hpp>
  23
  24 #include <boost/thread/mutex.hpp>
  25 #include <boost/thread/condition.hpp>
  26 #include <boost/shared_ptr.hpp>
  27
  28 #include <metaproxy/util.hpp>
  29 #include "torus.hpp"
  30
  31 #include <yaz/zgdu.h>
  32 #include <yaz/otherinfo.h>
  33 #include <yaz/diagbib1.h>
  34 #include <yaz/match_glob.h>
  35 #include <yaz/query-charset.h>
  36 #include <yaz/log.h>
  37
  38 #include <map>
  39 #include <iostream>
  40
  41 namespace mp = metaproxy_1;
  42 namespace yf = mp::filter;
  43
  44 namespace metaproxy_1 {
  45     namespace filter {
  46
  47         struct VirtualDB::Set {
  48             Set(BackendPtr b, std::string setname);
  49             Set();
  50             ~Set();
  51
  52             BackendPtr m_backend;
  53             std::string m_setname;
  54         };
  55         struct VirtualDB::Map {
  56             Map(std::string database, std::list<std::string> targets, std::string route);
  57             Map(std::string database, std::string target, std::string route);
  58             Map();
  59             bool match(const std::string db) const;
  60             std::string m_dbpattern;
  61             std::list<std::string> m_targets;
  62             std::string m_route;
  63         public:
  64             std::string query_encoding;
  65         };
  66         struct VirtualDB::Backend {
  67             mp::Session m_backend_session;
  68             std::list<std::string> m_frontend_databases;
  69             std::list<std::string> m_targets;
  70             std::string m_route;
  71             std::string query_encoding;
  72             bool m_named_result_sets;
  73             int m_number_of_sets;
  74         };
  75         struct VirtualDB::Frontend {
  76             Frontend(Rep *rep);
  77             ~Frontend();
  78             mp::Session m_session;
  79             bool m_is_virtual;
  80             bool m_in_use;
  81             yazpp_1::GDU m_init_gdu;
  82             std::list<BackendPtr> m_backend_list;
  83             std::map<std::string,VirtualDB::Set> m_sets;
  84
  85             void search(Package &package, Z_APDU *apdu);
  86             void present(Package &package, Z_APDU *apdu);
  87             void scan(Package &package, Z_APDU *apdu);
  88             int relay_apdu(Package &package, Z_APDU *apdu);
  89
  90             void close(Package &package);
  91             typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
  92
  93             void fixup_package(Package &p, BackendPtr b);
  94             void fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
  95                                   BackendPtr b);
  96             void fixup_npr_records(ODR odr, Z_Records *records,
  97                                    BackendPtr b);
  98
  99             BackendPtr lookup_backend_from_databases(
 100                 std::list<std::string> databases);
 101             BackendPtr create_backend_from_databases(
 102                 std::list<std::string> databases,
 103                 int &error_code,
 104                 std::string &failing_database);
 105
 106             BackendPtr init_backend(std::list<std::string> database,
 107                                     Package &package,
 108                                     int &error_code, std::string &addinfo);
 109             Rep *m_p;
 110         };
 111         class VirtualDB::Rep {
 112             friend class VirtualDB;
 113             friend struct Frontend;
 114
 115             FrontendPtr get_frontend(Package &package);
 116             void release_frontend(Package &package);
 117             void refresh_torus();
 118         private:
 119             std::list<VirtualDB::Map>m_maps;
 120             typedef std::map<std::string,VirtualDB::Set>::iterator Sets_it;
 121             boost::mutex m_mutex;
 122             boost::condition m_cond_session_ready;
 123             std::map<mp::Session, FrontendPtr> m_clients;
 124             bool pass_vhosts;
 125         };
 126     }
 127 }
 128
 129 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::lookup_backend_from_databases(
 130     std::list<std::string> databases)
 131 {
 132     std::list<BackendPtr>::const_iterator map_it;
 133     map_it = m_backend_list.begin();
 134     for (; map_it != m_backend_list.end(); map_it++)
 135         if ((*map_it)->m_frontend_databases == databases)
 136             return *map_it;
 137     BackendPtr null;
 138     return null;
 139 }
 140
 141 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::create_backend_from_databases(
 142     std::list<std::string> databases, int &error_code, std::string &addinfo)
 143 {
 144     BackendPtr b(new Backend);
 145     std::list<std::string>::const_iterator db_it = databases.begin();
 146
 147     b->m_number_of_sets = 0;
 148     b->m_frontend_databases = databases;
 149     b->m_named_result_sets = false;
 150
 151     bool first_route = true;
 152
 153     std::map<std::string,bool> targets_dedup;
 154     for (; db_it != databases.end(); db_it++)
 155     {
 156         std::list<VirtualDB::Map>::const_iterator map_it;
 157         map_it = m_p->m_maps.begin();
 158         while (map_it != m_p->m_maps.end())
 159         {
 160             if (map_it->match(*db_it))
 161                 break;
 162             map_it++;
 163         }
 164
 165         if (map_it == m_p->m_maps.end())  // database not found
 166         {
 167             error_code = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
 168             addinfo = *db_it;
 169             BackendPtr ptr;
 170             return ptr;
 171         }
 172         std::list<std::string>::const_iterator t_it =
 173             map_it->m_targets.begin();
 174         for (; t_it != map_it->m_targets.end(); t_it++) {
 175             if (!targets_dedup[*t_it])
 176             {
 177                 targets_dedup[*t_it] = true;
 178                 b->m_targets.push_back(*t_it);
 179             }
 180         }
 181
 182         // see if we have a route conflict.
 183         if (!first_route && b->m_route != map_it->m_route)
 184         {
 185             // we have a conflict.. routing must be same for all
 186             error_code =  YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
 187             BackendPtr ptr;
 188             return ptr;
 189         }
 190         b->m_route = map_it->m_route;
 191         if (!first_route && b->query_encoding != map_it->query_encoding)
 192         {
 193             // we have a conflict. query encoding must be same for all
 194             error_code =  YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
 195             BackendPtr ptr;
 196             return ptr;
 197         }
 198         b->query_encoding = map_it->query_encoding;
 199         first_route = false;
 200     }
 201     return b;
 202 }
 203
 204 yf::VirtualDB::BackendPtr yf::VirtualDB::Frontend::init_backend(
 205     std::list<std::string> databases, mp::Package &package,
 206     int &error_code, std::string &addinfo)
 207 {
 208     BackendPtr b = create_backend_from_databases(databases, error_code,
 209                                                  addinfo);
 210     if (!b)
 211         return b;
 212     Package init_package(b->m_backend_session, package.origin());
 213     init_package.copy_filter(package);
 214
 215     mp::odr odr;
 216
 217     Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
 218
 219     mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo, odr,
 220                                    b->m_targets);
 221     Z_InitRequest *req = init_apdu->u.initRequest;
 222
 223     // copy stuff from Frontend Init Request
 224     Z_GDU *org_gdu = m_init_gdu.get();
 225     Z_InitRequest *org_init = org_gdu->u.z3950->u.initRequest;
 226
 227     req->idAuthentication = org_init->idAuthentication;
 228     req->implementationId = org_init->implementationId;
 229     req->implementationName = org_init->implementationName;
 230     req->implementationVersion = org_init->implementationVersion;
 231     *req->preferredMessageSize = *org_init->preferredMessageSize;
 232     *req->maximumRecordSize = *org_init->maximumRecordSize;
 233
 234     ODR_MASK_SET(req->options, Z_Options_search);
 235     ODR_MASK_SET(req->options, Z_Options_present);
 236     ODR_MASK_SET(req->options, Z_Options_namedResultSets);
 237     ODR_MASK_SET(req->options, Z_Options_scan);
 238
 239     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
 240     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
 241     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
 242
 243     init_package.request() = init_apdu;
 244
 245     init_package.move(b->m_route);  // sending init
 246
 247     Z_GDU *gdu = init_package.response().get();
 248     // we hope to get an init response
 249     error_code = YAZ_BIB1_DATABASE_UNAVAILABLE;
 250     if (gdu && gdu->which == Z_GDU_Z3950
 251         && gdu->u.z3950->which == Z_APDU_initResponse
 252         && *gdu->u.z3950->u.initResponse->result)
 253     {
 254         Z_InitResponse *res = gdu->u.z3950->u.initResponse;
 255         if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
 256         {
 257             b->m_named_result_sets = true;
 258         }
 259         if (*res->result && !init_package.session().is_closed())
 260         {
 261             m_backend_list.push_back(b);
 262             return b;
 263         }
 264         mp::util::get_init_diagnostics(res, error_code, addinfo);
 265     }
 266     if (!init_package.session().is_closed())
 267     {
 268         Package close_package(b->m_backend_session, package.origin());
 269         close_package.copy_filter(package);
 270         close_package.session().close();
 271         close_package.move(b->m_route);  // closing it
 272     }
 273     BackendPtr null;
 274     return null;
 275 }
 276
 277 void yf::VirtualDB::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
 278 {
 279     Z_SearchRequest *req = apdu_req->u.searchRequest;
 280     std::string vhost;
 281     std::string resultSetId = req->resultSetName;
 282     mp::odr odr;
 283
 284     std::list<std::string> databases;
 285     int i;
 286     for (i = 0; i<req->num_databaseNames; i++)
 287         databases.push_back(req->databaseNames[i]);
 288
 289     Sets_it sets_it = m_sets.find(req->resultSetName);
 290     if (sets_it != m_sets.end())
 291     {
 292         // result set already exist
 293         // if replace indicator is off: we return diagnostic if
 294         // result set already exist.
 295         if (*req->replaceIndicator == 0)
 296         {
 297             Z_APDU *apdu =
 298                 odr.create_searchResponse(
 299                     apdu_req,
 300                     YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
 301                     0);
 302             package.response() = apdu;
 303
 304             return;
 305         }
 306         sets_it->second.m_backend->m_number_of_sets--;
 307     }
 308     // pick up any existing database with named result sets ..
 309     // or one which has no result sets.. yet.
 310     BackendPtr b; // null for now
 311     std::list<BackendPtr>::const_iterator map_it;
 312     map_it = m_backend_list.begin();
 313     for (; map_it != m_backend_list.end(); map_it++)
 314     {
 315         BackendPtr tmp = *map_it;
 316         if (tmp->m_frontend_databases == databases &&
 317             (tmp->m_named_result_sets ||
 318              tmp->m_number_of_sets == 0))
 319         {
 320             b = *map_it;
 321             break;
 322         }
 323     }
 324     if (!b)  // no backend yet. Must create a new one
 325     {
 326         int error_code;
 327         std::string addinfo;
 328         b = init_backend(databases, package, error_code, addinfo);
 329         if (!b)
 330         {
 331             // did not get a backend (unavailable somehow?)
 332
 333             Z_APDU *apdu =
 334                 odr.create_searchResponse(
 335                     apdu_req, error_code, addinfo.c_str());
 336             package.response() = apdu;
 337             return;
 338         }
 339     }
 340     m_sets.erase(req->resultSetName);
 341     // sending search to backend
 342     Package search_package(b->m_backend_session, package.origin());
 343
 344     search_package.copy_filter(package);
 345
 346     std::string backend_setname;
 347     if (b->m_named_result_sets)
 348     {
 349         backend_setname = std::string(req->resultSetName);
 350     }
 351     else
 352     {
 353         backend_setname = "default";
 354         req->resultSetName = odr_strdup(odr, backend_setname.c_str());
 355     }
 356
 357     // pick first targets spec and move the databases from it ..
 358     std::list<std::string>::const_iterator t_it = b->m_targets.begin();
 359     if (t_it != b->m_targets.end())
 360     {
 361         mp::util::set_databases_from_zurl(odr, *t_it,
 362                                                 &req->num_databaseNames,
 363                                                 &req->databaseNames);
 364     }
 365
 366     if (b->query_encoding.length() &&
 367         (req->query->which == Z_Query_type_1 ||
 368          req->query->which == Z_Query_type_101))
 369     {
 370         yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
 371         if (cd)
 372         {
 373             int r = yaz_query_charset_convert_rpnquery_check(
 374                 req->query->u.type_1, odr, cd);
 375             yaz_iconv_close(cd);
 376             if (r)
 377                 yaz_log(YLOG_LOG, "query could not be converted");
 378         }
 379     }
 380     *req->replaceIndicator = 1;
 381
 382     search_package.request() = yazpp_1::GDU(apdu_req);
 383
 384     search_package.move(b->m_route);
 385
 386     if (search_package.session().is_closed())
 387     {
 388         package.response() = search_package.response();
 389         package.session().close();
 390         return;
 391     }
 392     b->m_number_of_sets++;
 393
 394     m_sets[resultSetId] = VirtualDB::Set(b, backend_setname);
 395     fixup_package(search_package, b);
 396     package.response() = search_package.response();
 397 }
 398
 399 yf::VirtualDB::Frontend::Frontend(Rep *rep)
 400 {
 401     m_p = rep;
 402     m_is_virtual = false;
 403 }
 404
 405 void yf::VirtualDB::Frontend::close(mp::Package &package)
 406 {
 407     std::list<BackendPtr>::const_iterator b_it;
 408
 409     for (b_it = m_backend_list.begin(); b_it != m_backend_list.end(); b_it++)
 410     {
 411         (*b_it)->m_backend_session.close();
 412         Package close_package((*b_it)->m_backend_session, package.origin());
 413         close_package.copy_filter(package);
 414         close_package.move((*b_it)->m_route);
 415     }
 416     m_backend_list.clear();
 417 }
 418
 419 yf::VirtualDB::Frontend::~Frontend()
 420 {
 421 }
 422
 423 yf::VirtualDB::FrontendPtr yf::VirtualDB::Rep::get_frontend(mp::Package &package)
 424 {
 425     boost::mutex::scoped_lock lock(m_mutex);
 426
 427     std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
 428
 429     while(true)
 430     {
 431         it = m_clients.find(package.session());
 432         if (it == m_clients.end())
 433             break;
 434
 435         if (!it->second->m_in_use)
 436         {
 437             it->second->m_in_use = true;
 438             return it->second;
 439         }
 440         m_cond_session_ready.wait(lock);
 441     }
 442     FrontendPtr f(new Frontend(this));
 443     m_clients[package.session()] = f;
 444     f->m_in_use = true;
 445     return f;
 446 }
 447
 448 void yf::VirtualDB::Rep::release_frontend(mp::Package &package)
 449 {
 450     boost::mutex::scoped_lock lock(m_mutex);
 451     std::map<mp::Session,yf::VirtualDB::FrontendPtr>::iterator it;
 452
 453     it = m_clients.find(package.session());
 454     if (it != m_clients.end())
 455     {
 456         if (package.session().is_closed())
 457         {
 458             it->second->close(package);
 459             m_clients.erase(it);
 460         }
 461         else
 462         {
 463             it->second->m_in_use = false;
 464         }
 465         m_cond_session_ready.notify_all();
 466     }
 467 }
 468
 469
 470 yf::VirtualDB::Set::Set(BackendPtr b, std::string setname)
 471     :  m_backend(b), m_setname(setname)
 472 {
 473 }
 474
 475
 476 yf::VirtualDB::Set::Set()
 477 {
 478 }
 479
 480
 481 yf::VirtualDB::Set::~Set()
 482 {
 483 }
 484
 485 yf::VirtualDB::Map::Map(std::string database,
 486                         std::list<std::string> targets, std::string route)
 487     : m_dbpattern(database), m_targets(targets), m_route(route)
 488 {
 489 }
 490
 491 yf::VirtualDB::Map::Map(std::string database,
 492                         std::string target, std::string route)
 493     : m_dbpattern(database), m_route(route)
 494 {
 495     m_targets.push_back(target);
 496 }
 497
 498
 499 yf::VirtualDB::Map::Map()
 500 {
 501 }
 502
 503 bool yf::VirtualDB::Map::match(const std::string db) const
 504 {
 505     std::string norm_db = mp::util::database_name_normalize(db);
 506     if (yaz_match_glob(m_dbpattern.c_str(), norm_db.c_str()))
 507         return true;
 508     return false;
 509 }
 510
 511 yf::VirtualDB::VirtualDB() : m_p(new VirtualDB::Rep)
 512 {
 513     m_p->pass_vhosts = false;
 514 }
 515
 516 yf::VirtualDB::~VirtualDB() {
 517 }
 518
 519 void yf::VirtualDB::Frontend::fixup_npr_record(ODR odr, Z_NamePlusRecord *npr,
 520                                              BackendPtr b)
 521 {
 522     if (npr->databaseName)
 523     {
 524         std::string b_database = std::string(npr->databaseName);
 525
 526         // consider each of the frontend databases..
 527         std::list<std::string>::const_iterator db_it;
 528         for (db_it = b->m_frontend_databases.begin();
 529              db_it != b->m_frontend_databases.end(); db_it++)
 530         {
 531             // see which target it corresponds to.. (if any)
 532             std::list<VirtualDB::Map>::const_iterator map_it =
 533                 m_p->m_maps.begin();
 534             while (map_it != m_p->m_maps.end())
 535             {
 536                 if (map_it->match(*db_it))
 537                     break;
 538                 map_it++;
 539             }
 540             if (map_it != m_p->m_maps.end())
 541             {
 542                 std::list<std::string>::const_iterator t
 543                     = map_it->m_targets.begin();
 544                 while (t != map_it->m_targets.end())
 545                 {
 546                     if (*t == b_database)
 547                     {
 548                         npr->databaseName = odr_strdup(odr, (*db_it).c_str());
 549                         return;
 550                     }
 551                     t++;
 552                 }
 553             }
 554
 555         }
 556         db_it = b->m_frontend_databases.begin();
 557         if (db_it != b->m_frontend_databases.end())
 558         {
 559             std::string database = *db_it;
 560             npr->databaseName = odr_strdup(odr, database.c_str());
 561         }
 562     }
 563 }
 564
 565 void yf::VirtualDB::Frontend::fixup_npr_records(ODR odr, Z_Records *records,
 566                                               BackendPtr b)
 567 {
 568     if (records && records->which == Z_Records_DBOSD)
 569     {
 570         Z_NamePlusRecordList *nprlist = records->u.databaseOrSurDiagnostics;
 571         int i;
 572         for (i = 0; i < nprlist->num_records; i++)
 573         {
 574             fixup_npr_record(odr, nprlist->records[i], b);
 575         }
 576     }
 577 }
 578
 579 void yf::VirtualDB::Frontend::fixup_package(mp::Package &p, BackendPtr b)
 580 {
 581     Z_GDU *gdu = p.response().get();
 582     mp::odr odr;
 583
 584     if (gdu && gdu->which == Z_GDU_Z3950)
 585     {
 586         Z_APDU *apdu = gdu->u.z3950;
 587         if (apdu->which == Z_APDU_presentResponse)
 588         {
 589             fixup_npr_records(odr, apdu->u.presentResponse->records, b);
 590             p.response() = gdu;
 591         }
 592         else if (apdu->which == Z_APDU_searchResponse)
 593         {
 594             fixup_npr_records(odr,  apdu->u.searchResponse->records, b);
 595             p.response() = gdu;
 596         }
 597     }
 598 }
 599
 600 void yf::VirtualDB::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
 601 {
 602     Z_PresentRequest *req = apdu_req->u.presentRequest;
 603     std::string resultSetId = req->resultSetId;
 604     mp::odr odr;
 605
 606     Sets_it sets_it = m_sets.find(resultSetId);
 607     if (sets_it == m_sets.end())
 608     {
 609         Z_APDU *apdu =
 610             odr.create_presentResponse(
 611                 apdu_req,
 612                 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 613                 resultSetId.c_str());
 614         package.response() = apdu;
 615         return;
 616     }
 617     Session *id =
 618         new mp::Session(sets_it->second.m_backend->m_backend_session);
 619
 620     // sending present to backend
 621     Package present_package(*id, package.origin());
 622     present_package.copy_filter(package);
 623
 624     req->resultSetId = odr_strdup(odr, sets_it->second.m_setname.c_str());
 625
 626     present_package.request() = yazpp_1::GDU(apdu_req);
 627
 628     present_package.move(sets_it->second.m_backend->m_route);
 629
 630     fixup_package(present_package, sets_it->second.m_backend);
 631
 632     if (present_package.session().is_closed())
 633     {
 634         package.response() = present_package.response();
 635         package.session().close();
 636         return;
 637     }
 638     else
 639     {
 640         package.response() = present_package.response();
 641     }
 642     delete id;
 643 }
 644
 645 int yf::VirtualDB::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
 646 {
 647     int no = 0;
 648     std::list<BackendPtr>::const_iterator map_it;
 649     map_it = m_backend_list.begin();
 650     for (; map_it != m_backend_list.end(); map_it++)
 651     {
 652         BackendPtr b = *map_it;
 653
 654         Package relay_package(b->m_backend_session, package.origin());
 655         relay_package.copy_filter(package);
 656
 657         relay_package.request() = yazpp_1::GDU(apdu_req);
 658
 659         relay_package.move(b->m_route);
 660         package.response() = relay_package.response();
 661         no++;
 662     }
 663     return no;
 664 }
 665
 666 void yf::VirtualDB::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
 667 {
 668     Z_ScanRequest *req = apdu_req->u.scanRequest;
 669     std::string vhost;
 670     mp::odr odr;
 671
 672     std::list<std::string> databases;
 673     int i;
 674     for (i = 0; i<req->num_databaseNames; i++)
 675         databases.push_back(req->databaseNames[i]);
 676
 677     BackendPtr b;
 678     // pick up any existing backend with a database match
 679     std::list<BackendPtr>::const_iterator map_it;
 680     map_it = m_backend_list.begin();
 681     for (; map_it != m_backend_list.end(); map_it++)
 682     {
 683         BackendPtr tmp = *map_it;
 684         if (tmp->m_frontend_databases == databases)
 685             break;
 686     }
 687     if (map_it != m_backend_list.end())
 688         b = *map_it;
 689     if (!b)  // no backend yet. Must create a new one
 690     {
 691         int error_code;
 692         std::string addinfo;
 693         b = init_backend(databases, package, error_code, addinfo);
 694         if (!b)
 695         {
 696             // did not get a backend (unavailable somehow?)
 697             Z_APDU *apdu =
 698                 odr.create_scanResponse(
 699                     apdu_req, error_code, addinfo.c_str());
 700             package.response() = apdu;
 701
 702             return;
 703         }
 704     }
 705     // sending scan to backend
 706     Package scan_package(b->m_backend_session, package.origin());
 707
 708     scan_package.copy_filter(package);
 709
 710     // pick first targets spec and move the databases from it ..
 711     std::list<std::string>::const_iterator t_it = b->m_targets.begin();
 712     if (t_it != b->m_targets.end())
 713     {
 714         mp::util::set_databases_from_zurl(odr, *t_it,
 715                                                 &req->num_databaseNames,
 716                                                 &req->databaseNames);
 717     }
 718
 719     if (b->query_encoding.length())
 720     {
 721         yaz_iconv_t cd = yaz_iconv_open(b->query_encoding.c_str(), "UTF-8");
 722         if (cd)
 723         {
 724             yaz_query_charset_convert_apt(req->termListAndStartPoint, odr, cd);
 725             yaz_iconv_close(cd);
 726         }
 727     }
 728
 729     scan_package.request() = yazpp_1::GDU(apdu_req);
 730
 731     scan_package.move(b->m_route);
 732
 733     if (scan_package.session().is_closed())
 734     {
 735         package.response() = scan_package.response();
 736         package.session().close();
 737         return;
 738     }
 739     package.response() = scan_package.response();
 740 }
 741
 742
 743 void yf::VirtualDB::add_map_db2targets(std::string db,
 744                                        std::list<std::string> targets,
 745                                        std::string route)
 746 {
 747     m_p->m_maps.push_back(
 748         VirtualDB::Map(mp::util::database_name_normalize(db), targets, route));
 749 }
 750
 751
 752 void yf::VirtualDB::add_map_db2target(std::string db,
 753                                       std::string target,
 754                                       std::string route)
 755
 756 {
 757     m_p->m_maps.push_back(
 758         VirtualDB::Map(mp::util::database_name_normalize(db), target, route));
 759 }
 760
 761 void yf::VirtualDB::process(mp::Package &package) const
 762 {
 763     FrontendPtr f = m_p->get_frontend(package);
 764
 765     Z_GDU *gdu = package.request().get();
 766
 767     if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
 768         Z_APDU_initRequest && !f->m_is_virtual)
 769     {
 770         Z_InitRequest *req = gdu->u.z3950->u.initRequest;
 771
 772         std::list<std::string> vhosts;
 773         mp::util::get_vhost_otherinfo(req->otherInfo, vhosts);
 774
 775         if (vhosts.size() > 0 && m_p->pass_vhosts)
 776         {
 777             package.move();
 778         }
 779         else
 780         {
 781             f->m_init_gdu = gdu;
 782
 783             mp::odr odr;
 784             Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
 785             Z_InitResponse *resp = apdu->u.initResponse;
 786
 787             int i;
 788             static const int masks[] = {
 789                 Z_Options_search,
 790                 Z_Options_present,
 791                 Z_Options_namedResultSets,
 792                 Z_Options_scan,
 793                 -1
 794             };
 795             for (i = 0; masks[i] != -1; i++)
 796                 if (ODR_MASK_GET(req->options, masks[i]))
 797                     ODR_MASK_SET(resp->options, masks[i]);
 798
 799             static const int versions[] = {
 800                 Z_ProtocolVersion_1,
 801                 Z_ProtocolVersion_2,
 802                 Z_ProtocolVersion_3,
 803                 -1
 804             };
 805             for (i = 0; versions[i] != -1; i++)
 806                 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 807                     ODR_MASK_SET(resp->protocolVersion, versions[i]);
 808                 else
 809                     break;
 810
 811             *resp->preferredMessageSize = *req->preferredMessageSize;
 812             *resp->maximumRecordSize = *req->maximumRecordSize;
 813
 814             package.response() = apdu;
 815             f->m_is_virtual = true;
 816         }
 817     }
 818     else if (!f->m_is_virtual)
 819         package.move();
 820     else if (gdu && gdu->which == Z_GDU_Z3950)
 821     {
 822         Z_APDU *apdu = gdu->u.z3950;
 823         if (apdu->which == Z_APDU_initRequest)
 824         {
 825             mp::odr odr;
 826
 827             package.response() = odr.create_close(
 828                 apdu,
 829                 Z_Close_protocolError,
 830                 "double init");
 831
 832             package.session().close();
 833         }
 834         else if (apdu->which == Z_APDU_searchRequest)
 835         {
 836             f->search(package, apdu);
 837         }
 838         else if (apdu->which == Z_APDU_presentRequest)
 839         {
 840             f->present(package, apdu);
 841         }
 842         else if (apdu->which == Z_APDU_scanRequest)
 843         {
 844             f->scan(package, apdu);
 845         }
 846         else if (apdu->which == Z_APDU_close)
 847         {
 848             if (f->relay_apdu(package, apdu) == 0)
 849             {
 850                 mp::odr odr;
 851
 852                 package.response() = odr.create_close(
 853                     apdu, Z_Close_finished, "virt_db");
 854
 855                 package.session().close();
 856             }
 857         }
 858         else
 859         {
 860             mp::odr odr;
 861
 862             package.response() = odr.create_close(
 863                 apdu, Z_Close_protocolError,
 864                 "unsupported APDU in filter_virt_db");
 865
 866             package.session().close();
 867         }
 868     }
 869     m_p->release_frontend(package);
 870 }
 871
 872 void mp::filter::VirtualDB::configure(const xmlNode * ptr, bool test_only)
 873 {
 874     for (ptr = ptr->children; ptr; ptr = ptr->next)
 875     {
 876         if (ptr->type != XML_ELEMENT_NODE)
 877             continue;
 878         if (!strcmp((const char *) ptr->name, "pass-vhosts"))
 879         {
 880             m_p->pass_vhosts = mp::xml::get_bool(ptr, false);
 881         }
 882         else if (!strcmp((const char *) ptr->name, "virtual"))
 883         {
 884             std::string query_encoding;
 885             std::string database;
 886             std::list<std::string> targets;
 887             xmlNode *v_node = ptr->children;
 888             for (; v_node; v_node = v_node->next)
 889             {
 890                 if (v_node->type != XML_ELEMENT_NODE)
 891                     continue;
 892
 893                 if (mp::xml::is_element_mp(v_node, "database"))
 894                     database = mp::xml::get_text(v_node);
 895                 else if (mp::xml::is_element_mp(v_node, "target"))
 896                     targets.push_back(mp::xml::get_text(v_node));
 897                 else if (mp::xml::is_element_mp(v_node, "query-encoding"))
 898                     targets.push_back(mp::xml::get_text(v_node));
 899                 else
 900                     throw mp::filter::FilterException
 901                         ("Bad element "
 902                          + std::string((const char *) v_node->name)
 903                          + " in virtual section"
 904                             );
 905             }
 906             std::string route = mp::xml::get_route(ptr);
 907
 908             VirtualDB::Map vmap(mp::util::database_name_normalize(database),
 909                                 targets, route);
 910             vmap.query_encoding = query_encoding;
 911             m_p->m_maps.push_back(vmap);
 912         }
 913         else
 914         {
 915             throw mp::filter::FilterException
 916                 ("Bad element "
 917                  + std::string((const char *) ptr->name)
 918                  + " in virt_db filter");
 919         }
 920     }
 921 }
 922
 923 static mp::filter::Base* filter_creator()
 924 {
 925     return new mp::filter::VirtualDB;
 926 }
 927
 928 extern "C" {
 929     struct metaproxy_1_filter_struct metaproxy_1_filter_virt_db = {
 930         0,
 931         "virt_db",
 932         filter_creator
 933     };
 934 }
 935
 936
 937 /*
 938  * Local variables:
 939  * c-basic-offset: 4
 940  * c-file-style: "Stroustrup"
 941  * indent-tabs-mode: nil
 942  * End:
 943  * vim: shiftwidth=4 tabstop=8 expandtab
 944  */
 945