src/filter_virt_db.cpp

   1 /* $Id: filter_virt_db.cpp,v 1.5 2005-10-25 16:00:58 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(sets_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             apdu->u.close->diagnosticInformation =
 210                 odr_strdup(odr, "no session for search request");
 211
 212             package.response() = apdu;
 213             package.session().close();
 214             odr_destroy(odr);
 215             return;
 216         }
 217         if (it->second.m_use_vhost)
 218         {
 219             move_later = true;
 220             return;
 221         }
 222         if (req->num_databaseNames != 1)
 223         {   // exactly one database must be specified
 224             ODR odr = odr_createmem(ODR_ENCODE);
 225             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 226
 227             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 228             apdu->u.searchResponse->records = rec;
 229             rec->which = Z_Records_NSD;
 230             rec->u.nonSurrogateDiagnostic =
 231                 zget_DefaultDiagFormat(
 232                     odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
 233             package.response() = apdu;
 234
 235             odr_destroy(odr);
 236             return;
 237         }
 238         database = req->databaseNames[0];
 239         std::map<std::string, Virt_db_map>::iterator map_it;
 240         map_it = m_maps.find(database);
 241         if (map_it == m_maps.end())
 242         {   // no map for database: return diagnostic
 243             ODR odr = odr_createmem(ODR_ENCODE);
 244             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 245
 246             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 247             apdu->u.searchResponse->records = rec;
 248             rec->which = Z_Records_NSD;
 249             rec->u.nonSurrogateDiagnostic =
 250                 zget_DefaultDiagFormat(
 251                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 252             package.response() = apdu;
 253
 254             odr_destroy(odr);
 255             return;
 256         }
 257         if (*req->replaceIndicator == 0)
 258         {
 259             Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
 260             if (sets_it != it->second.m_sets.end())
 261             {
 262                 ODR odr = odr_createmem(ODR_ENCODE);
 263                 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 264
 265                 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 266                 apdu->u.searchResponse->records = rec;
 267                 rec->which = Z_Records_NSD;
 268                 rec->u.nonSurrogateDiagnostic =
 269                     zget_DefaultDiagFormat(
 270                         odr,
 271                         YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
 272                         0);
 273                 package.response() = apdu;
 274
 275                 odr_destroy(odr);
 276                 return;
 277             }
 278         }
 279         vhost = map_it->second.m_vhost;
 280         id = new Session;
 281
 282         it->second.m_sets[req->resultSetName] =
 283             Virt_db_set(*id, req->resultSetName, vhost);
 284     }
 285     const char *vhost_cstr = vhost.c_str();
 286     if (true)
 287     {  // sending init to backend
 288         Package init_package(*id, package.origin());
 289         init_package.copy_filter(package);
 290
 291         ODR odr = odr_createmem(ODR_ENCODE);
 292         Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
 293
 294         yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
 295                                  VAL_PROXY, 1, vhost_cstr);
 296
 297         init_package.request() = init_apdu;
 298         odr_destroy(odr);
 299
 300         init_package.move();  // sending init
 301
 302         if (init_package.session().is_closed())
 303         {
 304             ODR odr = odr_createmem(ODR_ENCODE);
 305             Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
 306
 307             Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 308             apdu->u.searchResponse->records = rec;
 309             rec->which = Z_Records_NSD;
 310             rec->u.nonSurrogateDiagnostic =
 311                 zget_DefaultDiagFormat(
 312                     odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
 313             package.response() = apdu;
 314
 315             odr_destroy(odr);
 316             return;
 317         }
 318     }
 319     // sending search to backend
 320     Package search_package(*id, package.origin());
 321
 322     search_package.copy_filter(package);
 323     const char *sep = strchr(vhost_cstr, '/');
 324     ODR odr = odr_createmem(ODR_ENCODE);
 325     if (sep)
 326         req->databaseNames[0] = odr_strdup(odr, sep+1);
 327
 328     *req->replaceIndicator = 1;
 329     req->resultSetName = odr_strdup(odr, "default");
 330     search_package.request() = yazpp_1::GDU(apdu);
 331
 332     odr_destroy(odr);
 333
 334     search_package.move();
 335
 336     package.response() = search_package.response();
 337     // must check for a closed search session..
 338     delete id;
 339 }
 340
 341 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
 342 {
 343     release_session(package);
 344     boost::mutex::scoped_lock lock(m_sessions_mutex);
 345
 346     Z_InitRequest *req = apdu->u.initRequest;
 347
 348     const char *vhost =
 349         yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
 350     if (!vhost)
 351     {
 352         ODR odr = odr_createmem(ODR_ENCODE);
 353
 354         Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
 355         Z_InitResponse *resp = apdu->u.initResponse;
 356
 357         int i;
 358         static const int masks[] = {
 359             Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
 360         };
 361         for (i = 0; masks[i] != -1; i++)
 362             if (ODR_MASK_GET(req->options, masks[i]))
 363                 ODR_MASK_SET(resp->options, masks[i]);
 364
 365         static const int versions[] = {
 366             Z_ProtocolVersion_1,
 367             Z_ProtocolVersion_2,
 368             Z_ProtocolVersion_3,
 369             -1
 370         };
 371         for (i = 0; versions[i] != -1; i++)
 372             if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 373                 ODR_MASK_SET(resp->protocolVersion, versions[i]);
 374             else
 375                 break;
 376
 377         package.response() = apdu;
 378
 379         odr_destroy(odr);
 380
 381         m_sessions[package.session()] = Virt_db_session(package.session(), false);
 382     }
 383     else
 384     {
 385         m_sessions[package.session()] = Virt_db_session(package.session(), true);
 386         move_later = true;
 387     }
 388 }
 389
 390 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
 391 {
 392     m_p->m_maps[db] = Virt_db_map(vhost);
 393 }
 394
 395 void yf::Virt_db::process(Package &package) const
 396 {
 397     Z_GDU *gdu = package.request().get();
 398
 399     if (!gdu || gdu->which != Z_GDU_Z3950)
 400         package.move();
 401     else
 402     {
 403         bool move_later = false;
 404         Z_APDU *apdu = gdu->u.z3950;
 405         if (apdu->which == Z_APDU_initRequest)
 406         {
 407             m_p->init(package, apdu, move_later);
 408         }
 409         else if (apdu->which == Z_APDU_searchRequest)
 410         {
 411             m_p->search(package, apdu, move_later);
 412         }
 413         else if (apdu->which == Z_APDU_presentRequest)
 414         {
 415             m_p->present(package, apdu, move_later);
 416         }
 417         else
 418         {
 419             ODR odr = odr_createmem(ODR_ENCODE);
 420
 421             Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
 422
 423             *apdu->u.close->closeReason = Z_Close_protocolError;
 424
 425             apdu->u.close->diagnosticInformation =
 426                 odr_strdup(odr, "unsupported APDU in filter_virt_db");
 427
 428             package.response() = apdu;
 429             package.session().close();
 430             odr_destroy(odr);
 431         }
 432         if (move_later)
 433             package.move();
 434     }
 435     if (package.session().is_closed())
 436         m_p->release_session(package);
 437 }
 438
 439
 440 /*
 441  * Local variables:
 442  * c-basic-offset: 4
 443  * indent-tabs-mode: nil
 444  * c-file-style: "stroustrup"
 445  * End:
 446  * vim: shiftwidth=4 tabstop=8 expandtab
 447  */