src/filter_virt_db.cpp

   1 /* $Id: filter_virt_db.cpp,v 1.4 2005-10-25 15:19:39 adam Exp $
   2    Copyright (c) 2005, Index Data.
   3
   4 %LICENSE%
   5  */
   6
   7 #include "config.hpp"
   8
   9 #include "filter.hpp"
  10 #include "router.hpp"
  11 #include "package.hpp"
  12
  13 #include <boost/thread/mutex.hpp>
  14
  15 #include "filter_virt_db.hpp"
  16
  17 #include <yaz/zgdu.h>
  18 #include <yaz/log.h>
  19 #include <yaz/otherinfo.h>
  20 #include <yaz/diagbib1.h>
  21
  22 #include <list>
  23 #include <map>
  24 #include <iostream>
  25
  26 namespace yf = yp2::filter;
  27
  28 namespace yp2 {
  29     namespace filter {
  30         struct Virt_db_set {
  31             Virt_db_set(yp2::Session &id, std::string setname,
  32                         std::string vhost);
  33             Virt_db_set();
  34             ~Virt_db_set();
  35
  36             yp2::Session m_session;
  37             std::string m_setname;
  38             std::string m_vhost;
  39         };
  40         struct Virt_db_session {
  41             Virt_db_session(yp2::Session &id, bool use_vhost);
  42             Virt_db_session();
  43             yp2::Session m_session;
  44             bool m_use_vhost;
  45             std::map<std::string,Virt_db_set> m_sets;
  46         };
  47         struct Virt_db_map {
  48             Virt_db_map(std::string vhost);
  49             Virt_db_map();
  50             std::string m_vhost;
  51         };
  52         class Virt_db::Rep {
  53             friend class Virt_db;
  54
  55             void release_session(Package &package);
  56             void init(Package &package, Z_APDU *apdu, bool &move_later);
  57             void search(Package &package, Z_APDU *apdu, bool &move_later);
  58             void present(Package &package, Z_APDU *apdu, bool &move_later);
  59         private:
  60             boost::mutex m_sessions_mutex;
  61             std::map<yp2::Session,Virt_db_session>m_sessions;
  62             std::map<std::string, Virt_db_map>m_maps;
  63
  64             typedef std::map<yp2::Session,Virt_db_session>::iterator Ses_it;
  65             typedef std::map<std::string,Virt_db_set>::iterator Sets_it;
  66         };
  67     }
  68 }
  69
  70 yf::Virt_db_set::Virt_db_set(yp2::Session &id, std::string setname,
  71                              std::string vhost)
  72     :   m_session(id), m_setname(setname), m_vhost(vhost)
  73 {
  74 }
  75
  76
  77 yf::Virt_db_set::Virt_db_set()
  78 {
  79 }
  80
  81
  82 yf::Virt_db_set::~Virt_db_set()
  83 {
  84 }
  85
  86 yf::Virt_db_map::Virt_db_map(std::string vhost)
  87     : m_vhost(vhost)
  88 {
  89 }
  90
  91 yf::Virt_db_map::Virt_db_map()
  92 {
  93 }
  94
  95 yf::Virt_db_session::Virt_db_session()
  96     : m_use_vhost(false)
  97 {
  98
  99 }
 100
 101 yf::Virt_db_session::Virt_db_session(yp2::Session &id,
 102                                      bool use_vhost) :
 103     m_session(id) , m_use_vhost(use_vhost)
 104 {
 105
 106 }
 107
 108 yf::Virt_db::Virt_db() {
 109     m_p = new Virt_db::Rep;
 110 }
 111
 112 yf::Virt_db::~Virt_db() {
 113     delete m_p;
 114 }
 115
 116 void yf::Virt_db::Rep::release_session(Package &package)
 117 {
 118     boost::mutex::scoped_lock lock(m_sessions_mutex);
 119
 120     Ses_it it = m_sessions.find(package.session());
 121
 122     if (it != m_sessions.end())
 123         m_sessions.erase(it);
 124 }
 125
 126 void yf::Virt_db::Rep::present(Package &package, Z_APDU *apdu, bool &move_later){
 127     Session *id = 0;
 128     Z_PresentRequest *req = apdu->u.presentRequest;
 129     {
 130         boost::mutex::scoped_lock lock(m_sessions_mutex);
 131
 132         Ses_it it = m_sessions.find(package.session());
 133         if (it == m_sessions.end())
 134         {
 135             ODR odr = odr_createmem(ODR_ENCODE);
 136
 137             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 138
 139             *apdu->u.close->closeReason = Z_Close_protocolError;
 140             apdu->u.close->diagnosticInformation =
 141                 odr_strdup(odr, "no session for present request");
 142
 143             package.response() = apdu;
 144             package.session().close();
 145             odr_destroy(odr);
 146             assert(false);
 147             return;
 148         }
 149         if (it->second.m_use_vhost)
 150         {
 151             move_later = true;
 152             return;
 153         }
 154         Sets_it sets_it = it->second.m_sets.find(req->resultSetId);
 155         if (sets_it == it->second.m_sets.end())
 156         {
 157             ODR odr = odr_createmem(ODR_ENCODE);
 158             Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
 159
 160             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 161             apdu->u.presentResponse->records = rec;
 162             rec->which = Z_Records_NSD;
 163             rec->u.nonSurrogateDiagnostic =
 164                 zget_DefaultDiagFormat(
 165                     odr,
 166                     YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 167                     req->resultSetId);
 168             package.response() = apdu;
 169             odr_destroy(odr);
 170             return;
 171         }
 172         id = new yp2::Session(it->second.m_session);
 173     }
 174     ODR odr = odr_createmem(ODR_ENCODE);
 175
 176     // sending present to backend
 177     Package present_package(*id, package.origin());
 178     present_package.copy_filter(package);
 179
 180     req->resultSetId = odr_strdup(odr, "default");
 181     present_package.request() = yazpp_1::GDU(apdu);
 182
 183     odr_destroy(odr);
 184
 185     present_package.move();
 186
 187     package.response() = present_package.response();
 188     // must check for a closed present session..
 189     delete id;
 190 }
 191
 192 void yf::Virt_db::Rep::search(Package &package, Z_APDU *apdu, bool &move_later)
 193 {
 194     Z_SearchRequest *req = apdu->u.searchRequest;
 195     std::string vhost;
 196     std::string database;
 197     Session *id = 0;
 198     {
 199         boost::mutex::scoped_lock lock(m_sessions_mutex);
 200
 201         Ses_it it = m_sessions.find(package.session());
 202         if (it == m_sessions.end())
 203         {
 204             ODR odr = odr_createmem(ODR_ENCODE);
 205
 206             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 207
 208             *apdu->u.close->closeReason = Z_Close_protocolError;
 209
 210             package.response() = apdu;
 211             package.session().close();
 212             odr_destroy(odr);
 213             return;
 214         }
 215         if (it->second.m_use_vhost)
 216         {
 217             move_later = true;
 218             return;
 219         }
 220         if (req->num_databaseNames != 1)
 221         {   // exactly one database must be specified
 222             ODR odr = odr_createmem(ODR_ENCODE);
 223             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 224
 225             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 226             apdu->u.searchResponse->records = rec;
 227             rec->which = Z_Records_NSD;
 228             rec->u.nonSurrogateDiagnostic =
 229                 zget_DefaultDiagFormat(
 230                     odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
 231             package.response() = apdu;
 232
 233             odr_destroy(odr);
 234             return;
 235         }
 236         database = req->databaseNames[0];
 237         std::map<std::string, Virt_db_map>::iterator map_it;
 238         map_it = m_maps.find(database);
 239         if (map_it == m_maps.end())
 240         {   // no map for database: return diagnostic
 241             ODR odr = odr_createmem(ODR_ENCODE);
 242             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 243
 244             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 245             apdu->u.searchResponse->records = rec;
 246             rec->which = Z_Records_NSD;
 247             rec->u.nonSurrogateDiagnostic =
 248                 zget_DefaultDiagFormat(
 249                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 250             package.response() = apdu;
 251
 252             odr_destroy(odr);
 253             return;
 254         }
 255         if (*req->replaceIndicator == 0)
 256         {
 257             Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
 258             if (sets_it != it->second.m_sets.end())
 259             {
 260                 ODR odr = odr_createmem(ODR_ENCODE);
 261                 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 262
 263                 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 264                 apdu->u.searchResponse->records = rec;
 265                 rec->which = Z_Records_NSD;
 266                 rec->u.nonSurrogateDiagnostic =
 267                     zget_DefaultDiagFormat(
 268                         odr,
 269                         YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
 270                         0);
 271                 package.response() = apdu;
 272
 273                 odr_destroy(odr);
 274                 return;
 275             }
 276         }
 277         vhost = map_it->second.m_vhost;
 278         id = new Session;
 279
 280         it->second.m_sets[req->resultSetName] =
 281             Virt_db_set(*id, req->resultSetName, vhost);
 282     }
 283     const char *vhost_cstr = vhost.c_str();
 284     if (true)
 285     {  // sending init to backend
 286         Package init_package(*id, package.origin());
 287         init_package.copy_filter(package);
 288
 289         ODR odr = odr_createmem(ODR_ENCODE);
 290         Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
 291
 292         yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
 293                                  VAL_PROXY, 1, vhost_cstr);
 294
 295         init_package.request() = init_apdu;
 296         odr_destroy(odr);
 297
 298         init_package.move();  // sending init
 299
 300         if (init_package.session().is_closed())
 301         {
 302             ODR odr = odr_createmem(ODR_ENCODE);
 303             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 304
 305             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 306             apdu->u.searchResponse->records = rec;
 307             rec->which = Z_Records_NSD;
 308             rec->u.nonSurrogateDiagnostic =
 309                 zget_DefaultDiagFormat(
 310                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 311             package.response() = apdu;
 312
 313             odr_destroy(odr);
 314             return;
 315         }
 316     }
 317     // sending search to backend
 318     Package search_package(*id, package.origin());
 319
 320     search_package.copy_filter(package);
 321     const char *sep = strchr(vhost_cstr, '/');
 322     ODR odr = odr_createmem(ODR_ENCODE);
 323     if (sep)
 324         req->databaseNames[0] = odr_strdup(odr, sep+1);
 325
 326     *req->replaceIndicator = 1;
 327     req->resultSetName = odr_strdup(odr, "default");
 328     search_package.request() = yazpp_1::GDU(apdu);
 329
 330     odr_destroy(odr);
 331
 332     search_package.move();
 333
 334     package.response() = search_package.response();
 335     // must check for a closed search session..
 336     delete id;
 337 }
 338
 339 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
 340 {
 341     release_session(package);
 342     boost::mutex::scoped_lock lock(m_sessions_mutex);
 343
 344     Z_InitRequest *req = apdu->u.initRequest;
 345
 346     const char *vhost =
 347         yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
 348     if (!vhost)
 349     {
 350         ODR odr = odr_createmem(ODR_ENCODE);
 351
 352         Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
 353         Z_InitResponse *resp = apdu->u.initResponse;
 354
 355         int i;
 356         static const int masks[] = {
 357             Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
 358         };
 359         for (i = 0; masks[i] != -1; i++)
 360             if (ODR_MASK_GET(req->options, masks[i]))
 361                 ODR_MASK_SET(resp->options, masks[i]);
 362
 363         static const int versions[] = {
 364             Z_ProtocolVersion_1,
 365             Z_ProtocolVersion_2,
 366             Z_ProtocolVersion_3,
 367             -1
 368         };
 369         for (i = 0; versions[i] != -1; i++)
 370             if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 371                 ODR_MASK_SET(resp->protocolVersion, versions[i]);
 372             else
 373                 break;
 374
 375         package.response() = apdu;
 376
 377         odr_destroy(odr);
 378
 379         m_sessions[package.session()] = Virt_db_session(package.session(), false);
 380     }
 381     else
 382     {
 383         m_sessions[package.session()] = Virt_db_session(package.session(), true);
 384         move_later = true;
 385     }
 386 }
 387
 388 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
 389 {
 390     m_p->m_maps[db] = Virt_db_map(vhost);
 391 }
 392
 393 void yf::Virt_db::process(Package &package) const
 394 {
 395     Z_GDU *gdu = package.request().get();
 396
 397     if (!gdu || gdu->which != Z_GDU_Z3950)
 398         package.move();
 399     else
 400     {
 401         bool move_later = false;
 402         Z_APDU *apdu = gdu->u.z3950;
 403         if (apdu->which == Z_APDU_initRequest)
 404         {
 405             m_p->init(package, apdu, move_later);
 406         }
 407         else if (apdu->which == Z_APDU_searchRequest)
 408         {
 409             m_p->search(package, apdu, move_later);
 410         }
 411         else if (apdu->which == Z_APDU_presentRequest)
 412         {
 413             m_p->present(package, apdu, move_later);
 414         }
 415         else
 416         {
 417             ODR odr = odr_createmem(ODR_ENCODE);
 418
 419             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 420
 421             *apdu->u.close->closeReason = Z_Close_protocolError;
 422
 423             apdu->u.close->diagnosticInformation =
 424                 odr_strdup(odr, "unsupported APDU in filter_virt_db");
 425
 426             package.response() = apdu;
 427             package.session().close();
 428             odr_destroy(odr);
 429         }
 430         if (move_later)
 431             package.move();
 432     }
 433     if (package.session().is_closed())
 434         m_p->release_session(package);
 435 }
 436
 437
 438 /*
 439  * Local variables:
 440  * c-basic-offset: 4
 441  * indent-tabs-mode: nil
 442  * c-file-style: "stroustrup"
 443  * End:
 444  * vim: shiftwidth=4 tabstop=8 expandtab
 445  */