src/filter_virt_db.cpp

   1 /* $Id: filter_virt_db.cpp,v 1.6 2005-10-25 21:32:01 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     m_sessions.erase(package.session());
 121 }
 122
 123 void yf::Virt_db::Rep::present(Package &package, Z_APDU *apdu, bool &move_later){
 124     Session *id = 0;
 125     Z_PresentRequest *req = apdu->u.presentRequest;
 126     {
 127         boost::mutex::scoped_lock lock(m_sessions_mutex);
 128
 129         Ses_it it = m_sessions.find(package.session());
 130         if (it == m_sessions.end())
 131         {
 132             ODR odr = odr_createmem(ODR_ENCODE);
 133
 134             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 135
 136             *apdu->u.close->closeReason = Z_Close_protocolError;
 137             apdu->u.close->diagnosticInformation =
 138                 odr_strdup(odr, "no session for present request");
 139
 140             package.response() = apdu;
 141             package.session().close();
 142             odr_destroy(odr);
 143             assert(false);
 144             return;
 145         }
 146         if (it->second.m_use_vhost)
 147         {
 148             move_later = true;
 149             return;
 150         }
 151         Sets_it sets_it = it->second.m_sets.find(req->resultSetId);
 152         if (sets_it == it->second.m_sets.end())
 153         {
 154             ODR odr = odr_createmem(ODR_ENCODE);
 155             Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
 156
 157             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 158             apdu->u.presentResponse->records = rec;
 159             rec->which = Z_Records_NSD;
 160             rec->u.nonSurrogateDiagnostic =
 161                 zget_DefaultDiagFormat(
 162                     odr,
 163                     YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 164                     req->resultSetId);
 165             package.response() = apdu;
 166             odr_destroy(odr);
 167             return;
 168         }
 169         id = new yp2::Session(sets_it->second.m_session);
 170     }
 171     ODR odr = odr_createmem(ODR_ENCODE);
 172
 173     // sending present to backend
 174     Package present_package(*id, package.origin());
 175     present_package.copy_filter(package);
 176
 177     req->resultSetId = odr_strdup(odr, "default");
 178     present_package.request() = yazpp_1::GDU(apdu);
 179
 180     odr_destroy(odr);
 181
 182     present_package.move();
 183
 184     package.response() = present_package.response();
 185     // must check for a closed present session..
 186     delete id;
 187 }
 188
 189 void yf::Virt_db::Rep::search(Package &package, Z_APDU *apdu, bool &move_later)
 190 {
 191     Z_SearchRequest *req = apdu->u.searchRequest;
 192     std::string vhost;
 193     std::string database;
 194     Session *id = 0;
 195     {
 196         boost::mutex::scoped_lock lock(m_sessions_mutex);
 197
 198         Ses_it it = m_sessions.find(package.session());
 199         if (it == m_sessions.end())
 200         {
 201             ODR odr = odr_createmem(ODR_ENCODE);
 202
 203             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 204
 205             *apdu->u.close->closeReason = Z_Close_protocolError;
 206             apdu->u.close->diagnosticInformation =
 207                 odr_strdup(odr, "no session for search request");
 208
 209             package.response() = apdu;
 210             package.session().close();
 211             odr_destroy(odr);
 212             return;
 213         }
 214         if (it->second.m_use_vhost)
 215         {
 216             move_later = true;
 217             return;
 218         }
 219         if (req->num_databaseNames != 1)
 220         {   // exactly one database must be specified
 221             ODR odr = odr_createmem(ODR_ENCODE);
 222             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 223
 224             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 225             apdu->u.searchResponse->records = rec;
 226             rec->which = Z_Records_NSD;
 227             rec->u.nonSurrogateDiagnostic =
 228                 zget_DefaultDiagFormat(
 229                     odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
 230             package.response() = apdu;
 231
 232             odr_destroy(odr);
 233             return;
 234         }
 235         database = req->databaseNames[0];
 236         std::map<std::string, Virt_db_map>::iterator map_it;
 237         map_it = m_maps.find(database);
 238         if (map_it == m_maps.end())
 239         {   // no map for database: return diagnostic
 240             ODR odr = odr_createmem(ODR_ENCODE);
 241             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 242
 243             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 244             apdu->u.searchResponse->records = rec;
 245             rec->which = Z_Records_NSD;
 246             rec->u.nonSurrogateDiagnostic =
 247                 zget_DefaultDiagFormat(
 248                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 249             package.response() = apdu;
 250
 251             odr_destroy(odr);
 252             return;
 253         }
 254         if (*req->replaceIndicator == 0)
 255         {
 256             Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
 257             if (sets_it != it->second.m_sets.end())
 258             {
 259                 ODR odr = odr_createmem(ODR_ENCODE);
 260                 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 261
 262                 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 263                 apdu->u.searchResponse->records = rec;
 264                 rec->which = Z_Records_NSD;
 265                 rec->u.nonSurrogateDiagnostic =
 266                     zget_DefaultDiagFormat(
 267                         odr,
 268                         YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
 269                         0);
 270                 package.response() = apdu;
 271
 272                 odr_destroy(odr);
 273                 return;
 274             }
 275         }
 276         vhost = map_it->second.m_vhost;
 277         id = new Session;
 278
 279         it->second.m_sets[req->resultSetName] =
 280             Virt_db_set(*id, req->resultSetName, vhost);
 281     }
 282     const char *vhost_cstr = vhost.c_str();
 283     if (true)
 284     {  // sending init to backend
 285         Package init_package(*id, package.origin());
 286         init_package.copy_filter(package);
 287
 288         ODR odr = odr_createmem(ODR_ENCODE);
 289         Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
 290
 291         yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
 292                                  VAL_PROXY, 1, vhost_cstr);
 293
 294         init_package.request() = init_apdu;
 295         odr_destroy(odr);
 296
 297         init_package.move();  // sending init
 298
 299         if (init_package.session().is_closed())
 300         {
 301             ODR odr = odr_createmem(ODR_ENCODE);
 302             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 303
 304             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 305             apdu->u.searchResponse->records = rec;
 306             rec->which = Z_Records_NSD;
 307             rec->u.nonSurrogateDiagnostic =
 308                 zget_DefaultDiagFormat(
 309                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 310             package.response() = apdu;
 311
 312             odr_destroy(odr);
 313             return;
 314         }
 315     }
 316     // sending search to backend
 317     Package search_package(*id, package.origin());
 318
 319     search_package.copy_filter(package);
 320     const char *sep = strchr(vhost_cstr, '/');
 321     ODR odr = odr_createmem(ODR_ENCODE);
 322     if (sep)
 323         req->databaseNames[0] = odr_strdup(odr, sep+1);
 324
 325     *req->replaceIndicator = 1;
 326     req->resultSetName = odr_strdup(odr, "default");
 327     search_package.request() = yazpp_1::GDU(apdu);
 328
 329     odr_destroy(odr);
 330
 331     search_package.move();
 332
 333     package.response() = search_package.response();
 334     // must check for a closed search session..
 335     delete id;
 336 }
 337
 338 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
 339 {
 340     release_session(package);
 341     boost::mutex::scoped_lock lock(m_sessions_mutex);
 342
 343     Z_InitRequest *req = apdu->u.initRequest;
 344
 345     const char *vhost =
 346         yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
 347     if (!vhost)
 348     {
 349         ODR odr = odr_createmem(ODR_ENCODE);
 350
 351         Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
 352         Z_InitResponse *resp = apdu->u.initResponse;
 353
 354         int i;
 355         static const int masks[] = {
 356             Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
 357         };
 358         for (i = 0; masks[i] != -1; i++)
 359             if (ODR_MASK_GET(req->options, masks[i]))
 360                 ODR_MASK_SET(resp->options, masks[i]);
 361
 362         static const int versions[] = {
 363             Z_ProtocolVersion_1,
 364             Z_ProtocolVersion_2,
 365             Z_ProtocolVersion_3,
 366             -1
 367         };
 368         for (i = 0; versions[i] != -1; i++)
 369             if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 370                 ODR_MASK_SET(resp->protocolVersion, versions[i]);
 371             else
 372                 break;
 373
 374         package.response() = apdu;
 375
 376         odr_destroy(odr);
 377
 378         m_sessions[package.session()] = Virt_db_session(package.session(), false);
 379     }
 380     else
 381     {
 382         m_sessions[package.session()] = Virt_db_session(package.session(), true);
 383         move_later = true;
 384     }
 385 }
 386
 387 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
 388 {
 389     m_p->m_maps[db] = Virt_db_map(vhost);
 390 }
 391
 392 void yf::Virt_db::process(Package &package) const
 393 {
 394     Z_GDU *gdu = package.request().get();
 395
 396     if (!gdu || gdu->which != Z_GDU_Z3950)
 397         package.move();
 398     else
 399     {
 400         bool move_later = false;
 401         Z_APDU *apdu = gdu->u.z3950;
 402         if (apdu->which == Z_APDU_initRequest)
 403         {
 404             m_p->init(package, apdu, move_later);
 405         }
 406         else if (apdu->which == Z_APDU_searchRequest)
 407         {
 408             m_p->search(package, apdu, move_later);
 409         }
 410         else if (apdu->which == Z_APDU_presentRequest)
 411         {
 412             m_p->present(package, apdu, move_later);
 413         }
 414         else
 415         {
 416             ODR odr = odr_createmem(ODR_ENCODE);
 417
 418             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 419
 420             *apdu->u.close->closeReason = Z_Close_protocolError;
 421
 422             apdu->u.close->diagnosticInformation =
 423                 odr_strdup(odr, "unsupported APDU in filter_virt_db");
 424
 425             package.response() = apdu;
 426             package.session().close();
 427             odr_destroy(odr);
 428         }
 429         if (move_later)
 430             package.move();
 431     }
 432     if (package.session().is_closed())
 433         m_p->release_session(package);
 434 }
 435
 436
 437 /*
 438  * Local variables:
 439  * c-basic-offset: 4
 440  * indent-tabs-mode: nil
 441  * c-file-style: "stroustrup"
 442  * End:
 443  * vim: shiftwidth=4 tabstop=8 expandtab
 444  */