src/filter_session_shared.cpp

   1 /* This file is part of Metaproxy.
   2    Copyright (C) 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 <metaproxy/filter.hpp>
  22 #include <metaproxy/package.hpp>
  23
  24 #include <boost/thread/mutex.hpp>
  25 #include <boost/thread/condition.hpp>
  26 #include <boost/thread/thread.hpp>
  27 #include <boost/thread/xtime.hpp>
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/format.hpp>
  30
  31 #include <metaproxy/util.hpp>
  32 #include "filter_session_shared.hpp"
  33
  34 #include <yaz/copy_types.h>
  35 #include <yaz/log.h>
  36 #include <yaz/zgdu.h>
  37 #include <yaz/otherinfo.h>
  38 #include <yaz/diagbib1.h>
  39 #include <yazpp/z-query.h>
  40 #include <yazpp/record-cache.h>
  41 #include <map>
  42 #include <iostream>
  43 #include <time.h>
  44 #include <limits.h>
  45
  46 namespace mp = metaproxy_1;
  47 namespace yf = metaproxy_1::filter;
  48
  49 namespace metaproxy_1 {
  50
  51     namespace filter {
  52         // key for session.. We'll only share sessions with same InitKey
  53         class SessionShared::InitKey {
  54         public:
  55             bool operator < (const SessionShared::InitKey &k) const;
  56             InitKey(Z_InitRequest *req);
  57             InitKey(const InitKey &);
  58             ~InitKey();
  59         private:
  60             char *m_idAuthentication_buf;
  61             int m_idAuthentication_size;
  62             char *m_otherInfo_buf;
  63             int m_otherInfo_size;
  64             ODR m_odr;
  65         };
  66         // worker thread .. for expiry of sessions
  67         class SessionShared::Worker {
  68         public:
  69             Worker(SessionShared::Rep *rep);
  70             void operator() (void);
  71         private:
  72             SessionShared::Rep *m_p;
  73         };
  74         // backend result set
  75         class SessionShared::BackendSet {
  76         public:
  77             std::string m_result_set_id;
  78             Databases m_databases;
  79             Odr_int m_result_set_size;
  80             yazpp_1::Yaz_Z_Query m_query;
  81             time_t m_time_last_use;
  82             void timestamp();
  83             yazpp_1::RecordCache m_record_cache;
  84
  85             Z_OtherInformation *additionalSearchInfoRequest;
  86             Z_OtherInformation *additionalSearchInfoResponse;
  87             NMEM mem_additionalSearchInfo;
  88             BackendSet(
  89                 const std::string &result_set_id,
  90                 const Databases &databases,
  91                 const yazpp_1::Yaz_Z_Query &query,
  92                 Z_OtherInformation *additionalSearchInfoRequest);
  93             ~BackendSet();
  94             bool search(
  95                 Package &frontend_package,
  96                 Package &search_package,
  97                 const Z_APDU *apdu_req,
  98                 const BackendInstancePtr bp,
  99                 Z_Records **z_records);
 100         };
 101         // backend connection instance
 102         class SessionShared::BackendInstance {
 103             friend class Rep;
 104             friend class BackendClass;
 105             friend class BackendSet;
 106         public:
 107             mp::Session m_session;
 108             BackendSetList m_sets;
 109             bool m_in_use;
 110             int m_sequence_this;
 111             int m_result_set_sequence;
 112             time_t m_time_last_use;
 113             mp::Package * m_close_package;
 114             ~BackendInstance();
 115             void timestamp();
 116         };
 117         // backends of some class (all with same InitKey)
 118         class SessionShared::BackendClass : boost::noncopyable {
 119             friend class Rep;
 120             friend struct Frontend;
 121             bool m_named_result_sets;
 122             BackendInstanceList m_backend_list;
 123             BackendInstancePtr create_backend(const Package &package);
 124             void remove_backend(BackendInstancePtr b);
 125             BackendInstancePtr get_backend(const Package &package);
 126             void use_backend(BackendInstancePtr b);
 127             void release_backend(BackendInstancePtr b);
 128             bool expire_instances();
 129             yazpp_1::GDU m_init_request;
 130             yazpp_1::GDU m_init_response;
 131             boost::mutex m_mutex_backend_class;
 132             boost::condition m_cond_set_ready;
 133             int m_sequence_top;
 134             time_t m_backend_set_ttl;
 135             time_t m_backend_expiry_ttl;
 136             size_t m_backend_set_max;
 137             Odr_int m_preferredMessageSize;
 138             Odr_int m_maximumRecordSize;
 139             int m_no_failed;
 140             int m_no_succeeded;
 141             int m_no_init;
 142         public:
 143             BackendClass(const yazpp_1::GDU &init_request,
 144                          int resultset_ttl,
 145                          int resultset_max,
 146                          int session_ttl,
 147                          Odr_int preferredRecordSize,
 148                          Odr_int maximumRecordSize);
 149             ~BackendClass();
 150         };
 151         // frontend result set
 152         class SessionShared::FrontendSet {
 153             Databases m_databases;
 154             yazpp_1::Yaz_Z_Query m_query;
 155         public:
 156             const Databases &get_databases();
 157             const yazpp_1::Yaz_Z_Query &get_query();
 158             FrontendSet(
 159                 const Databases &databases,
 160                 const yazpp_1::Yaz_Z_Query &query);
 161             FrontendSet();
 162         };
 163         // frontend session
 164         struct SessionShared::Frontend {
 165             Frontend(Rep *rep);
 166             ~Frontend();
 167             bool m_is_virtual;
 168             bool m_in_use;
 169             Z_Options m_init_options;
 170             void search(Package &package, Z_APDU *apdu);
 171             void present(Package &package, Z_APDU *apdu);
 172             void scan(Package &package, Z_APDU *apdu);
 173
 174             int result_set_ref(ODR o,
 175                                const Databases &databases,
 176                                Z_RPNStructure *s, std::string &rset);
 177             void get_set(mp::Package &package,
 178                          const Z_APDU *apdu_req,
 179                          const Databases &databases,
 180                          yazpp_1::Yaz_Z_Query &query,
 181                          BackendInstancePtr &found_backend,
 182                          BackendSetPtr &found_set);
 183             void override_set(BackendInstancePtr &found_backend,
 184                               std::string &result_set_id,
 185                               const Databases &databases,
 186                               bool out_of_sessions);
 187
 188             Rep *m_p;
 189             BackendClassPtr m_backend_class;
 190             FrontendSets m_frontend_sets;
 191         };
 192         // representation
 193         class SessionShared::Rep {
 194             friend class SessionShared;
 195             friend struct Frontend;
 196
 197             FrontendPtr get_frontend(Package &package);
 198             void release_frontend(Package &package);
 199             Rep();
 200         public:
 201             ~Rep();
 202             void expire();
 203         private:
 204             void expire_classes();
 205             void stat();
 206             void init(Package &package, const Z_GDU *gdu,
 207                       FrontendPtr frontend);
 208             void start();
 209             boost::mutex m_mutex;
 210             boost::condition m_cond_session_ready;
 211             boost::condition m_cond_expire_ready;
 212             std::map<mp::Session, FrontendPtr> m_clients;
 213
 214             BackendClassMap m_backend_map;
 215             boost::mutex m_mutex_backend_map;
 216             boost::thread_group m_thrds;
 217             int m_resultset_ttl;
 218             int m_resultset_max;
 219             int m_session_ttl;
 220             bool m_optimize_search;
 221             bool m_restart;
 222             int m_session_max;
 223             Odr_int m_preferredMessageSize;
 224             Odr_int m_maximumRecordSize;
 225             bool close_down;
 226         };
 227     }
 228 }
 229
 230 yf::SessionShared::FrontendSet::FrontendSet(
 231     const Databases &databases,
 232     const yazpp_1::Yaz_Z_Query &query)
 233     : m_databases(databases), m_query(query)
 234 {
 235 }
 236
 237 const yf::SessionShared::Databases &
 238 yf::SessionShared::FrontendSet::get_databases()
 239 {
 240     return m_databases;
 241 }
 242
 243 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
 244 {
 245     return m_query;
 246 }
 247
 248 yf::SessionShared::InitKey::InitKey(const InitKey &k)
 249 {
 250     m_odr = odr_createmem(ODR_ENCODE);
 251
 252     m_idAuthentication_size =  k.m_idAuthentication_size;
 253     m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
 254     memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
 255            m_idAuthentication_size);
 256
 257     m_otherInfo_size =  k.m_otherInfo_size;
 258     m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
 259     memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
 260            m_otherInfo_size);
 261 }
 262
 263 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
 264 {
 265     m_odr = odr_createmem(ODR_ENCODE);
 266
 267     Z_IdAuthentication *t = req->idAuthentication;
 268     z_IdAuthentication(m_odr, &t, 1, 0);
 269     m_idAuthentication_buf =
 270         odr_getbuf(m_odr, &m_idAuthentication_size, 0);
 271
 272     Z_OtherInformation *o = req->otherInfo;
 273     z_OtherInformation(m_odr, &o, 1, 0);
 274     m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
 275 }
 276
 277 yf::SessionShared::InitKey::~InitKey()
 278 {
 279     odr_destroy(m_odr);
 280 }
 281
 282 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
 283     const
 284 {
 285     int c;
 286     c = mp::util::memcmp2(
 287         (void*) m_idAuthentication_buf, m_idAuthentication_size,
 288         (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
 289     if (c < 0)
 290         return true;
 291     else if (c > 0)
 292         return false;
 293
 294     c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
 295                           (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
 296     if (c < 0)
 297         return true;
 298     else if (c > 0)
 299         return false;
 300     return false;
 301 }
 302
 303 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
 304 {
 305     boost::mutex::scoped_lock lock(m_mutex_backend_class);
 306     m_cond_set_ready.notify_all();
 307     b->m_in_use = false;
 308 }
 309
 310
 311 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
 312 {
 313     {
 314         boost::mutex::scoped_lock lock(m_mutex_backend_class);
 315         BackendInstanceList::iterator it = m_backend_list.begin();
 316         for (;;)
 317         {
 318             if (it == m_backend_list.end())
 319                 return;
 320             if (*it == b)
 321             {
 322                 it = m_backend_list.erase(it);
 323                 break;
 324             }
 325             it++;
 326         }
 327     }
 328     mp::odr odr;
 329     b->m_close_package->response() = odr.create_close(
 330         0, Z_Close_lackOfActivity, 0);
 331     b->m_close_package->session().close();
 332     b->m_close_package->move();
 333 }
 334
 335
 336 yf::SessionShared::BackendInstancePtr
 337 yf::SessionShared::BackendClass::get_backend(
 338     const mp::Package &frontend_package)
 339 {
 340     {
 341         boost::mutex::scoped_lock lock(m_mutex_backend_class);
 342
 343         BackendInstanceList::const_iterator it = m_backend_list.begin();
 344
 345         BackendInstancePtr backend1; // null
 346
 347         for (; it != m_backend_list.end(); it++)
 348         {
 349             if (!(*it)->m_in_use)
 350             {
 351                 if (!backend1
 352                     || (*it)->m_sequence_this < backend1->m_sequence_this)
 353                     backend1 = *it;
 354             }
 355         }
 356         if (backend1)
 357         {
 358             use_backend(backend1);
 359             return backend1;
 360         }
 361     }
 362     return create_backend(frontend_package);
 363 }
 364
 365 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
 366 {
 367     backend->m_in_use = true;
 368     backend->m_sequence_this = m_sequence_top++;
 369 }
 370
 371 void yf::SessionShared::BackendInstance::timestamp()
 372 {
 373     assert(m_in_use);
 374     time(&m_time_last_use);
 375 }
 376
 377 yf::SessionShared::BackendInstance::~BackendInstance()
 378 {
 379     if (m_close_package)
 380     {
 381         mp::odr odr;
 382         m_close_package->response() = odr.create_close(
 383             0, Z_Close_lackOfActivity, 0);
 384         m_close_package->session().close();
 385         m_close_package->move();
 386     }
 387     delete m_close_package;
 388 }
 389
 390 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
 391     const mp::Package &frontend_package)
 392 {
 393     BackendInstancePtr null;
 394     {
 395         boost::mutex::scoped_lock lock(m_mutex_backend_class);
 396         if (m_no_failed && !m_no_succeeded)
 397         {
 398             m_no_failed++;
 399             return null;
 400         }
 401     }
 402     BackendInstancePtr bp(new BackendInstance);
 403     bp->m_close_package =
 404         new mp::Package(bp->m_session, frontend_package.origin());
 405     bp->m_close_package->copy_filter(frontend_package);
 406
 407     Package init_package(bp->m_session, frontend_package.origin());
 408
 409     init_package.copy_filter(frontend_package);
 410
 411     yazpp_1::GDU actual_init_request = m_init_request;
 412     Z_GDU *init_pdu = actual_init_request.get();
 413
 414     assert(init_pdu->which == Z_GDU_Z3950);
 415     assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
 416
 417     Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
 418     ODR_MASK_ZERO(req->options);
 419
 420     ODR_MASK_SET(req->options, Z_Options_search);
 421     ODR_MASK_SET(req->options, Z_Options_present);
 422     ODR_MASK_SET(req->options, Z_Options_namedResultSets);
 423     ODR_MASK_SET(req->options, Z_Options_scan);
 424
 425     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
 426     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
 427     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
 428
 429     if (m_preferredMessageSize)
 430         *req->preferredMessageSize = m_preferredMessageSize;
 431     if (m_maximumRecordSize)
 432         *req->maximumRecordSize = m_maximumRecordSize;
 433
 434     init_package.request() = init_pdu;
 435
 436     {
 437         boost::mutex::scoped_lock lock(m_mutex_backend_class);
 438         m_no_init++;
 439     }
 440
 441     init_package.move();
 442
 443     boost::mutex::scoped_lock lock(m_mutex_backend_class);
 444
 445     m_named_result_sets = false;
 446     Z_GDU *gdu = init_package.response().get();
 447
 448     if (gdu && gdu->which == Z_GDU_Z3950
 449         && gdu->u.z3950->which == Z_APDU_initResponse)
 450     {
 451         Z_InitResponse *res = gdu->u.z3950->u.initResponse;
 452         m_init_response = gdu->u.z3950;
 453         if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
 454         {
 455             m_named_result_sets = true;
 456         }
 457         if (*gdu->u.z3950->u.initResponse->result
 458             && !init_package.session().is_closed())
 459         {
 460             bp->m_in_use = true;
 461             time(&bp->m_time_last_use);
 462             bp->m_sequence_this = 0;
 463             bp->m_result_set_sequence = 0;
 464             m_backend_list.push_back(bp);
 465             m_no_succeeded++;
 466             return bp;
 467         }
 468     }
 469     else
 470     {
 471         yazpp_1::GDU empty_gdu;
 472         m_init_response = empty_gdu;
 473     }
 474
 475     if (!init_package.session().is_closed())
 476     {
 477         init_package.copy_filter(frontend_package);
 478         init_package.session().close();
 479         init_package.move();
 480     }
 481     m_no_failed++;
 482     return null;
 483 }
 484
 485
 486 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
 487                                               int resultset_ttl,
 488                                               int resultset_max,
 489                                               int session_ttl,
 490                                               Odr_int preferredMessageSize,
 491                                               Odr_int maximumRecordSize)
 492     : m_named_result_sets(false), m_init_request(init_request),
 493       m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
 494       m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max),
 495       m_preferredMessageSize(preferredMessageSize),
 496       m_maximumRecordSize(maximumRecordSize),
 497       m_no_failed(0), m_no_succeeded(0), m_no_init(0)
 498 {}
 499
 500 yf::SessionShared::BackendClass::~BackendClass()
 501 {}
 502
 503 void yf::SessionShared::Rep::stat()
 504 {
 505     int no_classes = 0;
 506     int no_instances = 0;
 507     BackendClassMap::const_iterator it;
 508     {
 509         boost::mutex::scoped_lock lock(m_mutex_backend_map);
 510         for (it = m_backend_map.begin(); it != m_backend_map.end(); it++)
 511         {
 512             BackendClassPtr bc = it->second;
 513             no_classes++;
 514             BackendInstanceList::iterator bit = bc->m_backend_list.begin();
 515             for (; bit != bc->m_backend_list.end(); bit++)
 516                 no_instances++;
 517         }
 518     }
 519 }
 520
 521 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
 522                                   FrontendPtr frontend)
 523 {
 524     Z_InitRequest *req = gdu->u.z3950->u.initRequest;
 525
 526     frontend->m_is_virtual = true;
 527     frontend->m_init_options = *req->options;
 528     InitKey k(req);
 529     {
 530         boost::mutex::scoped_lock lock(m_mutex_backend_map);
 531         BackendClassMap::const_iterator it;
 532         it = m_backend_map.find(k);
 533         if (it == m_backend_map.end())
 534         {
 535             BackendClassPtr b(new BackendClass(gdu->u.z3950,
 536                                                m_resultset_ttl,
 537                                                m_resultset_max,
 538                                                m_session_ttl,
 539                                                m_preferredMessageSize,
 540                                                m_maximumRecordSize));
 541             m_backend_map[k] = b;
 542             frontend->m_backend_class = b;
 543         }
 544         else
 545         {
 546             frontend->m_backend_class = it->second;
 547         }
 548     }
 549     BackendClassPtr bc = frontend->m_backend_class;
 550     mp::odr odr;
 551
 552     // we only need to get init response from "first" target in
 553     // backend class - the assumption being that init response is
 554     // same for all
 555     bool create_first_one = false;
 556     {
 557         boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
 558         if (!bc->m_no_failed && !bc->m_no_succeeded && !bc->m_no_init)
 559             create_first_one = true;
 560         else
 561         {
 562             // first for first one to finish
 563             while (!bc->m_no_failed && !bc->m_no_succeeded && bc->m_no_init)
 564             {
 565                 bc->m_cond_set_ready.wait(lock);
 566             }
 567         }
 568     }
 569     if (create_first_one)
 570     {
 571         BackendInstancePtr backend = bc->create_backend(package);
 572         if (backend)
 573             bc->release_backend(backend);
 574     }
 575     yazpp_1::GDU init_response;
 576     {
 577         boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
 578
 579         init_response = bc->m_init_response;
 580     }
 581
 582     if (init_response.get())
 583     {
 584         Z_GDU *response_gdu = init_response.get();
 585         mp::util::transfer_referenceId(odr, gdu->u.z3950,
 586                                        response_gdu->u.z3950);
 587         Z_InitResponse *init_res = response_gdu->u.z3950->u.initResponse;
 588         Z_Options *server_options = init_res->options;
 589         Z_Options *client_options = &frontend->m_init_options;
 590         int i;
 591         for (i = 0; i < 30; i++)
 592             if (!ODR_MASK_GET(client_options, i))
 593                 ODR_MASK_CLEAR(server_options, i);
 594
 595         if (!m_preferredMessageSize ||
 596             *init_res->preferredMessageSize > *req->preferredMessageSize)
 597             *init_res->preferredMessageSize = *req->preferredMessageSize;
 598
 599         if (!m_maximumRecordSize ||
 600             *init_res->maximumRecordSize > *req->maximumRecordSize)
 601             *init_res->maximumRecordSize = *req->maximumRecordSize;
 602
 603         package.response() = init_response;
 604         if (!*response_gdu->u.z3950->u.initResponse->result)
 605             package.session().close();
 606     }
 607     else
 608     {
 609         Z_APDU *apdu =
 610             odr.create_initResponse(
 611                 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
 612                 "session_shared: target closed connection during init");
 613         *apdu->u.initResponse->result = 0;
 614         package.response() = apdu;
 615         package.session().close();
 616     }
 617 }
 618
 619 void yf::SessionShared::BackendSet::timestamp()
 620 {
 621     time(&m_time_last_use);
 622 }
 623
 624 yf::SessionShared::BackendSet::BackendSet(
 625     const std::string &result_set_id,
 626     const Databases &databases,
 627     const yazpp_1::Yaz_Z_Query &query,
 628     Z_OtherInformation *additionalSearchInfo) :
 629     m_result_set_id(result_set_id),
 630     m_databases(databases), m_result_set_size(0), m_query(query)
 631 {
 632     timestamp();
 633     mem_additionalSearchInfo = nmem_create();
 634     additionalSearchInfoResponse = 0;
 635     additionalSearchInfoRequest =
 636         yaz_clone_z_OtherInformation(additionalSearchInfo,
 637                                      mem_additionalSearchInfo);
 638 }
 639
 640 yf::SessionShared::BackendSet::~BackendSet()
 641 {
 642     nmem_destroy(mem_additionalSearchInfo);
 643 }
 644
 645 static int get_diagnostic(Z_DefaultDiagFormat *r)
 646 {
 647     return *r->condition;
 648 }
 649
 650 bool yf::SessionShared::BackendSet::search(
 651     mp::Package &frontend_package,
 652     mp::Package &search_package,
 653     const Z_APDU *frontend_apdu,
 654     const BackendInstancePtr bp,
 655     Z_Records **z_records)
 656 {
 657     mp::odr odr;
 658     Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
 659     Z_SearchRequest *req = apdu_req->u.searchRequest;
 660
 661     req->additionalSearchInfo = additionalSearchInfoRequest;
 662     req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
 663     req->query = m_query.get_Z_Query();
 664
 665     req->num_databaseNames = m_databases.size();
 666     req->databaseNames = (char**)
 667         odr_malloc(odr, req->num_databaseNames * sizeof(char *));
 668     Databases::const_iterator it = m_databases.begin();
 669     size_t i = 0;
 670     for (; it != m_databases.end(); it++)
 671         req->databaseNames[i++] = odr_strdup(odr, it->c_str());
 672
 673     if (frontend_apdu->which == Z_APDU_searchRequest)
 674         req->preferredRecordSyntax =
 675             frontend_apdu->u.searchRequest->preferredRecordSyntax;
 676
 677     search_package.request() = apdu_req;
 678
 679     search_package.move();
 680
 681     Z_GDU *gdu = search_package.response().get();
 682     if (!search_package.session().is_closed()
 683         && gdu && gdu->which == Z_GDU_Z3950
 684         && gdu->u.z3950->which == Z_APDU_searchResponse)
 685     {
 686         Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
 687         *z_records = b_resp->records;
 688         m_result_set_size = *b_resp->resultCount;
 689
 690         additionalSearchInfoResponse = yaz_clone_z_OtherInformation(
 691             b_resp->additionalSearchInfo, mem_additionalSearchInfo);
 692         return true;
 693     }
 694     Z_APDU *f_apdu = 0;
 695     const char *addinfo = "session_shared: "
 696         "target closed connection during search";
 697     if (frontend_apdu->which == Z_APDU_searchRequest)
 698         f_apdu = odr.create_searchResponse(
 699             frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 700     else if (frontend_apdu->which == Z_APDU_presentRequest)
 701         f_apdu = odr.create_presentResponse(
 702             frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 703     else
 704         f_apdu = odr.create_close(
 705             frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 706     frontend_package.response() = f_apdu;
 707     return false;
 708 }
 709
 710 void yf::SessionShared::Frontend::override_set(
 711     BackendInstancePtr &found_backend,
 712     std::string &result_set_id,
 713     const Databases &databases,
 714     bool out_of_sessions)
 715 {
 716     BackendClassPtr bc = m_backend_class;
 717     BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
 718     time_t now;
 719     time(&now);
 720
 721     size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
 722     for (; it != bc->m_backend_list.end(); it++)
 723     {
 724         if (!(*it)->m_in_use)
 725         {
 726             BackendSetList::iterator set_it = (*it)->m_sets.begin();
 727             for (; set_it != (*it)->m_sets.end(); set_it++)
 728             {
 729                 if ((max_sets > 1 || (*set_it)->m_databases == databases)
 730                     &&
 731                     (out_of_sessions ||
 732                      now < (*set_it)->m_time_last_use ||
 733                      now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
 734                 {
 735                     found_backend = *it;
 736                     result_set_id = (*set_it)->m_result_set_id;
 737                     found_backend->m_sets.erase(set_it);
 738                     return;
 739                 }
 740             }
 741         }
 742     }
 743     for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
 744     {
 745         if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
 746         {
 747             found_backend = *it;
 748             if (bc->m_named_result_sets)
 749             {
 750                 result_set_id = boost::io::str(
 751                     boost::format("%1%") %
 752                     found_backend->m_result_set_sequence);
 753                 found_backend->m_result_set_sequence++;
 754             }
 755             else
 756                 result_set_id = "default";
 757             return;
 758         }
 759     }
 760 }
 761
 762 void yf::SessionShared::Frontend::get_set(mp::Package &package,
 763                                           const Z_APDU *apdu_req,
 764                                           const Databases &databases,
 765                                           yazpp_1::Yaz_Z_Query &query,
 766                                           BackendInstancePtr &found_backend,
 767                                           BackendSetPtr &found_set)
 768 {
 769     bool session_restarted = false;
 770     Z_OtherInformation *additionalSearchInfo = 0;
 771
 772     if (apdu_req->which == Z_APDU_searchRequest)
 773         additionalSearchInfo = apdu_req->u.searchRequest->additionalSearchInfo;
 774
 775 restart:
 776     std::string result_set_id;
 777     bool out_of_sessions = false;
 778     BackendClassPtr bc = m_backend_class;
 779     {
 780         boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
 781
 782         if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
 783             out_of_sessions = true;
 784
 785         if (m_p->m_optimize_search)
 786         {
 787             // look at each backend and see if we have a similar search
 788             BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
 789             while (it != bc->m_backend_list.end())
 790             {
 791                 bool restart = false;
 792                 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
 793                 for (; set_it != (*it)->m_sets.end(); set_it++)
 794                 {
 795                     // for real present request we don't care
 796                     // if additionalSearchInfo matches: same records
 797                     if ((*set_it)->m_databases == databases
 798                         && query.match(&(*set_it)->m_query)
 799                         && (apdu_req->which != Z_APDU_searchRequest ||
 800                             yaz_compare_z_OtherInformation(
 801                                 additionalSearchInfo,
 802                                 (*set_it)->additionalSearchInfoRequest)))
 803                     {
 804                         if ((*it)->m_in_use)
 805                         {
 806                             bc->m_cond_set_ready.wait(lock);
 807                             restart = true;
 808                             break;
 809                         }
 810                         else
 811                         {
 812                             found_set = *set_it;
 813                             found_backend = *it;
 814                             bc->use_backend(found_backend);
 815                             // found matching set. No need to search again
 816                             return;
 817                         }
 818                     }
 819                 }
 820                 if (restart)
 821                     it = bc->m_backend_list.begin();
 822                 else
 823                     it++;
 824             }
 825         }
 826         override_set(found_backend, result_set_id, databases, out_of_sessions);
 827         if (found_backend)
 828             bc->use_backend(found_backend);
 829     }
 830     if (!found_backend)
 831     {
 832         // create a new backend set (and new set) if we're not out of sessions
 833         if (!out_of_sessions)
 834             found_backend = bc->create_backend(package);
 835
 836         if (!found_backend)
 837         {
 838             Z_APDU *f_apdu = 0;
 839             mp::odr odr;
 840             const char *addinfo = 0;
 841
 842             if (out_of_sessions)
 843                 addinfo = "session_shared: all sessions in use";
 844             else
 845                 addinfo = "session_shared: could not create backend";
 846             if (apdu_req->which == Z_APDU_searchRequest)
 847             {
 848                 f_apdu = odr.create_searchResponse(
 849                     apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 850             }
 851             else if (apdu_req->which == Z_APDU_presentRequest)
 852             {
 853                 f_apdu = odr.create_presentResponse(
 854                     apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 855             }
 856             else
 857             {
 858                 f_apdu = odr.create_close(
 859                     apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
 860             }
 861             package.response() = f_apdu;
 862             return;
 863         }
 864         if (bc->m_named_result_sets)
 865         {
 866             result_set_id = boost::io::str(
 867                 boost::format("%1%") % found_backend->m_result_set_sequence);
 868             found_backend->m_result_set_sequence++;
 869         }
 870         else
 871             result_set_id = "default";
 872     }
 873     found_backend->timestamp();
 874
 875     // we must search ...
 876     BackendSetPtr new_set(new BackendSet(result_set_id,
 877                                          databases, query,
 878                                          additionalSearchInfo));
 879
 880     found_set = new_set;
 881     found_set->timestamp();
 882
 883     Z_Records *z_records = 0;
 884
 885     Package search_package(found_backend->m_session, package.origin());
 886     search_package.copy_filter(package);
 887
 888     if (!new_set->search(package, search_package,
 889                          apdu_req, found_backend, &z_records))
 890     {
 891         bc->remove_backend(found_backend);
 892         return; // search error
 893     }
 894
 895     if (z_records)
 896     {
 897         int condition = 0;
 898         if (z_records->which == Z_Records_NSD)
 899         {
 900             condition =
 901                 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
 902         }
 903         else if (z_records->which == Z_Records_multipleNSD)
 904         {
 905             if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
 906                 &&
 907
 908                 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
 909                 Z_DiagRec_defaultFormat)
 910             {
 911                 condition = get_diagnostic(
 912                     z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
 913
 914             }
 915         }
 916         if (m_p->m_restart && !session_restarted &&
 917             condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
 918         {
 919             package.log("session_shared", YLOG_LOG, "restart");
 920             bc->remove_backend(found_backend);
 921             session_restarted = true;
 922             found_backend.reset();
 923             goto restart;
 924
 925         }
 926
 927         if (condition)
 928         {
 929             mp::odr odr;
 930             if (apdu_req->which == Z_APDU_searchRequest)
 931             {
 932                 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
 933                                                            0, 0);
 934                 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
 935                 *f_resp->searchStatus = Z_SearchResponse_none;
 936                 f_resp->records = z_records;
 937                 package.response() = f_apdu;
 938             }
 939             if (apdu_req->which == Z_APDU_presentRequest)
 940             {
 941                 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
 942                                                             0, 0);
 943                 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
 944                 f_resp->records = z_records;
 945                 package.response() = f_apdu;
 946             }
 947             bc->release_backend(found_backend);
 948             found_set.reset();
 949             return; // search error
 950         }
 951     }
 952     if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
 953     {
 954         package.log("session_shared", YLOG_LOG, "restart");
 955         bc->remove_backend(found_backend);
 956         session_restarted = true;
 957         found_backend.reset();
 958         goto restart;
 959     }
 960     found_backend->m_sets.push_back(found_set);
 961 }
 962
 963 int yf::SessionShared::Frontend::result_set_ref(ODR o,
 964                                                 const Databases &databases,
 965                                                 Z_RPNStructure *s,
 966                                                 std::string &rset)
 967 {
 968     int ret = 0;
 969     switch (s->which)
 970     {
 971     case Z_RPNStructure_simple:
 972         if (s->u.simple->which == Z_Operand_resultSetId)
 973         {
 974             const char *id = s->u.simple->u.resultSetId;
 975             rset = id;
 976
 977             FrontendSets::iterator fset_it = m_frontend_sets.find(id);
 978             if (fset_it == m_frontend_sets.end())
 979             {
 980                 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
 981             }
 982             else if (fset_it->second->get_databases() != databases)
 983             {
 984                 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
 985             }
 986             else
 987             {
 988                 yazpp_1::Yaz_Z_Query query = fset_it->second->get_query();
 989                 Z_Query *q = yaz_copy_Z_Query(query.get_Z_Query(), o);
 990                 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
 991                 {
 992                     s->which = q->u.type_1->RPNStructure->which;
 993                     s->u.simple = q->u.type_1->RPNStructure->u.simple;
 994                 }
 995                 else
 996                 {
 997                     ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
 998                 }
 999             }
1000         }
1001         break;
1002     case Z_RPNStructure_complex:
1003         ret = result_set_ref(o, databases, s->u.complex->s1, rset);
1004         if (!ret)
1005             ret = result_set_ref(o, databases, s->u.complex->s2, rset);
1006         break;
1007     }
1008     return ret;
1009 }
1010
1011 void yf::SessionShared::Frontend::search(mp::Package &package,
1012                                          Z_APDU *apdu_req)
1013 {
1014     Z_SearchRequest *req = apdu_req->u.searchRequest;
1015     FrontendSets::iterator fset_it =
1016         m_frontend_sets.find(req->resultSetName);
1017     if (fset_it != m_frontend_sets.end())
1018     {
1019         // result set already exist
1020         // if replace indicator is off: we return diagnostic if
1021         // result set already exist.
1022         if (*req->replaceIndicator == 0)
1023         {
1024             mp::odr odr;
1025             Z_APDU *apdu =
1026                 odr.create_searchResponse(
1027                     apdu_req,
1028                     YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
1029                     0);
1030             package.response() = apdu;
1031             return;
1032         }
1033         m_frontend_sets.erase(fset_it);
1034     }
1035
1036     Databases databases;
1037     int i;
1038     for (i = 0; i < req->num_databaseNames; i++)
1039         databases.push_back(req->databaseNames[i]);
1040
1041
1042     yazpp_1::Yaz_Z_Query query;
1043     query.set_Z_Query(req->query);
1044
1045     Z_Query *q = query.get_Z_Query();
1046     if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
1047     {
1048         mp::odr odr;
1049         std::string rset;
1050         int diag = result_set_ref(odr, databases, q->u.type_1->RPNStructure,
1051                                   rset);
1052         if (diag)
1053         {
1054             Z_APDU *apdu =
1055                 odr.create_searchResponse(
1056                     apdu_req,
1057                     diag,
1058                     rset.c_str());
1059             package.response() = apdu;
1060             return;
1061         }
1062         query.set_Z_Query(q);
1063     }
1064
1065     BackendSetPtr found_set; // null
1066     BackendInstancePtr found_backend; // null
1067
1068     get_set(package, apdu_req, databases, query, found_backend, found_set);
1069     if (!found_set)
1070         return;
1071
1072     mp::odr odr;
1073     Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
1074     Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
1075     *f_resp->resultCount = found_set->m_result_set_size;
1076     f_resp->additionalSearchInfo = found_set->additionalSearchInfoResponse;
1077     package.response() = f_apdu;
1078
1079     FrontendSetPtr fset(new FrontendSet(databases, query));
1080     m_frontend_sets[req->resultSetName] = fset;
1081
1082     m_backend_class->release_backend(found_backend);
1083 }
1084
1085 void yf::SessionShared::Frontend::present(mp::Package &package,
1086                                           Z_APDU *apdu_req)
1087 {
1088     mp::odr odr;
1089     Z_PresentRequest *req = apdu_req->u.presentRequest;
1090
1091     FrontendSets::iterator fset_it =
1092         m_frontend_sets.find(req->resultSetId);
1093
1094     if (fset_it == m_frontend_sets.end())
1095     {
1096         Z_APDU *apdu =
1097             odr.create_presentResponse(
1098                 apdu_req,
1099                 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1100                 req->resultSetId);
1101         package.response() = apdu;
1102         return;
1103     }
1104     FrontendSetPtr fset = fset_it->second;
1105
1106     Databases databases = fset->get_databases();
1107     yazpp_1::Yaz_Z_Query query = fset->get_query();
1108
1109     BackendClassPtr bc = m_backend_class;
1110     BackendSetPtr found_set; // null
1111     BackendInstancePtr found_backend;
1112
1113     get_set(package, apdu_req, databases, query, found_backend, found_set);
1114     if (!found_set)
1115         return;
1116
1117     Z_NamePlusRecordList *npr_res = 0;
1118     // record_cache.lookup types are int's. Avoid non-fitting values
1119     if (*req->resultSetStartPoint > 0
1120         && *req->resultSetStartPoint < INT_MAX
1121         && *req->numberOfRecordsRequested > 0
1122         && *req->numberOfRecordsRequested < INT_MAX
1123         && found_set->m_record_cache.lookup(odr, &npr_res,
1124                                             *req->resultSetStartPoint,
1125                                             *req->numberOfRecordsRequested,
1126                                             req->preferredRecordSyntax,
1127                                             req->recordComposition))
1128     {
1129         Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1130         Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1131
1132         yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1133                 " records in cache %p",
1134                 *req->resultSetStartPoint,
1135                 *req->numberOfRecordsRequested,
1136                 &found_set->m_record_cache);
1137
1138         *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
1139         *f_resp->nextResultSetPosition =
1140             *req->resultSetStartPoint + *req->numberOfRecordsRequested;
1141         // f_resp->presentStatus assumed OK.
1142         f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
1143         f_resp->records->which = Z_Records_DBOSD;
1144         f_resp->records->u.databaseOrSurDiagnostics = npr_res;
1145         package.response() = f_apdu_res;
1146         bc->release_backend(found_backend);
1147         return;
1148     }
1149
1150     found_backend->timestamp();
1151
1152     Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
1153     Z_PresentRequest *p_req = p_apdu->u.presentRequest;
1154     p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1155     p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
1156     *p_req->resultSetStartPoint = *req->resultSetStartPoint;
1157     *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
1158     p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1159     p_req->recordComposition = req->recordComposition;
1160
1161     Package present_package(found_backend->m_session, package.origin());
1162     present_package.copy_filter(package);
1163
1164     present_package.request() = p_apdu;
1165
1166     present_package.move();
1167
1168     Z_GDU *gdu = present_package.response().get();
1169     if (!present_package.session().is_closed()
1170         && gdu && gdu->which == Z_GDU_Z3950
1171         && gdu->u.z3950->which == Z_APDU_presentResponse)
1172     {
1173         Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
1174         Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1175         Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1176
1177         f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
1178         f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
1179         f_resp->presentStatus= b_resp->presentStatus;
1180         f_resp->records = b_resp->records;
1181         f_resp->otherInfo = b_resp->otherInfo;
1182         package.response() = f_apdu_res;
1183
1184         if (b_resp->records && b_resp->records->which ==  Z_Records_DBOSD)
1185         {
1186             Z_NamePlusRecordList *npr =
1187                 b_resp->records->u.databaseOrSurDiagnostics;
1188             // record_cache.add types are int's. Avoid non-fitting values
1189             if (*req->resultSetStartPoint > 0
1190                 && npr->num_records + *req->resultSetStartPoint < INT_MAX)
1191             {
1192 #if 0
1193                 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1194                         " records to cache %p",
1195                         *req->resultSetStartPoint,
1196                         *f_resp->numberOfRecordsReturned,
1197                         &found_set->m_record_cache);
1198 #endif
1199                 found_set->m_record_cache.add(
1200                     odr, npr, *req->resultSetStartPoint,
1201                     p_req->recordComposition);
1202             }
1203         }
1204         bc->release_backend(found_backend);
1205     }
1206     else
1207     {
1208         bc->remove_backend(found_backend);
1209         Z_APDU *f_apdu_res =
1210             odr.create_presentResponse(
1211                 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1212                 "session_shared: target closed connection during present");
1213         package.response() = f_apdu_res;
1214     }
1215 }
1216
1217 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
1218                                        Z_APDU *apdu_req)
1219 {
1220     BackendClassPtr bc = m_backend_class;
1221     BackendInstancePtr backend = bc->get_backend(frontend_package);
1222     if (!backend)
1223     {
1224         mp::odr odr;
1225         Z_APDU *apdu = odr.create_scanResponse(
1226             apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1227             "session_shared: could not create backend");
1228         frontend_package.response() = apdu;
1229     }
1230     else
1231     {
1232         Package scan_package(backend->m_session, frontend_package.origin());
1233         backend->timestamp();
1234         scan_package.copy_filter(frontend_package);
1235         scan_package.request() = apdu_req;
1236         scan_package.move();
1237         frontend_package.response() = scan_package.response();
1238         if (scan_package.session().is_closed())
1239         {
1240             frontend_package.session().close();
1241             bc->remove_backend(backend);
1242         }
1243         else
1244             bc->release_backend(backend);
1245     }
1246 }
1247
1248 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1249 {
1250 }
1251
1252 void yf::SessionShared::Worker::operator() (void)
1253 {
1254     m_p->expire();
1255 }
1256
1257 bool yf::SessionShared::BackendClass::expire_instances()
1258 {
1259     time_t now;
1260     time(&now);
1261     boost::mutex::scoped_lock lock(m_mutex_backend_class);
1262     BackendInstanceList::iterator bit = m_backend_list.begin();
1263     while (bit != m_backend_list.end())
1264     {
1265         time_t last_use = (*bit)->m_time_last_use;
1266
1267         if ((*bit)->m_in_use)
1268         {
1269             bit++;
1270         }
1271         else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1272         {
1273             bit = m_backend_list.erase(bit);
1274         }
1275         else
1276         {
1277             bit++;
1278         }
1279     }
1280     if (m_backend_list.empty())
1281         return true;
1282     return false;
1283 }
1284
1285 void yf::SessionShared::Rep::expire_classes()
1286 {
1287     boost::mutex::scoped_lock lock(m_mutex_backend_map);
1288     BackendClassMap::iterator b_it = m_backend_map.begin();
1289     while (b_it != m_backend_map.end())
1290     {
1291         if (b_it->second->expire_instances())
1292         {
1293             m_backend_map.erase(b_it);
1294             b_it = m_backend_map.begin();
1295         }
1296         else
1297             b_it++;
1298     }
1299 }
1300
1301 void yf::SessionShared::Rep::expire()
1302 {
1303     while (true)
1304     {
1305         boost::xtime xt;
1306         boost::xtime_get(&xt,
1307 #if BOOST_VERSION >= 105000
1308                 boost::TIME_UTC_
1309 #else
1310                 boost::TIME_UTC
1311 #endif
1312                   );
1313         xt.sec += m_session_ttl;
1314         {
1315             boost::mutex::scoped_lock lock(m_mutex);
1316             m_cond_expire_ready.timed_wait(lock, xt);
1317             if (close_down)
1318                 break;
1319         }
1320         stat();
1321         expire_classes();
1322     }
1323 }
1324
1325 yf::SessionShared::Rep::Rep()
1326 {
1327     m_resultset_ttl = 30;
1328     m_resultset_max = 10;
1329     m_session_ttl = 90;
1330     m_optimize_search = true;
1331     m_restart = false;
1332     m_session_max = 100;
1333     m_preferredMessageSize = 0;
1334     m_maximumRecordSize = 0;
1335     close_down = false;
1336 }
1337
1338 yf::SessionShared::Rep::~Rep()
1339 {
1340     {
1341         boost::mutex::scoped_lock lock(m_mutex);
1342         close_down = true;
1343         m_cond_expire_ready.notify_all();
1344     }
1345     m_thrds.join_all();
1346 }
1347
1348 void yf::SessionShared::Rep::start()
1349 {
1350     yf::SessionShared::Worker w(this);
1351     m_thrds.add_thread(new boost::thread(w));
1352 }
1353
1354 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1355 {
1356 }
1357
1358 yf::SessionShared::~SessionShared() {
1359 }
1360
1361 void yf::SessionShared::start() const
1362 {
1363     m_p->start();
1364 }
1365
1366 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1367 {
1368 }
1369
1370 yf::SessionShared::Frontend::~Frontend()
1371 {
1372 }
1373
1374 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1375 {
1376     boost::mutex::scoped_lock lock(m_mutex);
1377
1378     std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1379
1380     while(true)
1381     {
1382         it = m_clients.find(package.session());
1383         if (it == m_clients.end())
1384             break;
1385
1386         if (!it->second->m_in_use)
1387         {
1388             it->second->m_in_use = true;
1389             return it->second;
1390         }
1391         m_cond_session_ready.wait(lock);
1392     }
1393     FrontendPtr f(new Frontend(this));
1394     m_clients[package.session()] = f;
1395     f->m_in_use = true;
1396     return f;
1397 }
1398
1399 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1400 {
1401     boost::mutex::scoped_lock lock(m_mutex);
1402     std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1403
1404     it = m_clients.find(package.session());
1405     if (it != m_clients.end())
1406     {
1407         if (package.session().is_closed())
1408         {
1409             m_clients.erase(it);
1410         }
1411         else
1412         {
1413             it->second->m_in_use = false;
1414         }
1415         m_cond_session_ready.notify_all();
1416     }
1417 }
1418
1419
1420 void yf::SessionShared::process(mp::Package &package) const
1421 {
1422     FrontendPtr f = m_p->get_frontend(package);
1423
1424     Z_GDU *gdu = package.request().get();
1425
1426     if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1427         Z_APDU_initRequest && !f->m_is_virtual)
1428     {
1429         m_p->init(package, gdu, f);
1430     }
1431     else if (!f->m_is_virtual)
1432         package.move();
1433     else if (gdu && gdu->which == Z_GDU_Z3950)
1434     {
1435         Z_APDU *apdu = gdu->u.z3950;
1436         if (apdu->which == Z_APDU_initRequest)
1437         {
1438             mp::odr odr;
1439
1440             package.response() = odr.create_close(
1441                 apdu,
1442                 Z_Close_protocolError,
1443                 "double init");
1444
1445             package.session().close();
1446         }
1447         else if (apdu->which == Z_APDU_close)
1448         {
1449             mp::odr odr;
1450
1451             package.response() = odr.create_close(
1452                 apdu,
1453                 Z_Close_peerAbort, "received close from client");
1454             package.session().close();
1455         }
1456         else if (apdu->which == Z_APDU_searchRequest)
1457         {
1458             f->search(package, apdu);
1459         }
1460         else if (apdu->which == Z_APDU_presentRequest)
1461         {
1462             f->present(package, apdu);
1463         }
1464         else if (apdu->which == Z_APDU_scanRequest)
1465         {
1466             f->scan(package, apdu);
1467         }
1468         else
1469         {
1470             mp::odr odr;
1471
1472             package.response() = odr.create_close(
1473                 apdu, Z_Close_protocolError,
1474                 "unsupported APDU in filter_session_shared");
1475
1476             package.session().close();
1477         }
1478     }
1479     m_p->release_frontend(package);
1480 }
1481
1482 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1483                                   const char *path)
1484 {
1485     for (ptr = ptr->children; ptr; ptr = ptr->next)
1486     {
1487         if (ptr->type != XML_ELEMENT_NODE)
1488             continue;
1489         if (!strcmp((const char *) ptr->name, "resultset"))
1490         {
1491             const struct _xmlAttr *attr;
1492             for (attr = ptr->properties; attr; attr = attr->next)
1493             {
1494                 if (!strcmp((const char *) attr->name, "ttl"))
1495                     m_p->m_resultset_ttl =
1496                         mp::xml::get_int(attr->children, 30);
1497                 else if (!strcmp((const char *) attr->name, "max"))
1498                 {
1499                     m_p->m_resultset_max =
1500                         mp::xml::get_int(attr->children, 10);
1501                 }
1502                 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1503                 {
1504                     m_p->m_optimize_search =
1505                         mp::xml::get_bool(attr->children, true);
1506                 }
1507                 else if (!strcmp((const char *) attr->name, "restart"))
1508                 {
1509                     m_p->m_restart = mp::xml::get_bool(attr->children, true);
1510                 }
1511                 else
1512                     throw mp::filter::FilterException(
1513                         "Bad attribute " + std::string((const char *)
1514                                                        attr->name));
1515             }
1516         }
1517         else if (!strcmp((const char *) ptr->name, "session"))
1518         {
1519             const struct _xmlAttr *attr;
1520             for (attr = ptr->properties; attr; attr = attr->next)
1521             {
1522                 if (!strcmp((const char *) attr->name, "ttl"))
1523                     m_p->m_session_ttl =
1524                         mp::xml::get_int(attr->children, 90);
1525                 else if (!strcmp((const char *) attr->name, "max"))
1526                     m_p->m_session_max =
1527                         mp::xml::get_int(attr->children, 100);
1528                 else
1529                     throw mp::filter::FilterException(
1530                         "Bad attribute " + std::string((const char *)
1531                                                        attr->name));
1532             }
1533         }
1534         else if (!strcmp((const char *) ptr->name, "init"))
1535         {
1536             const struct _xmlAttr *attr;
1537             for (attr = ptr->properties; attr; attr = attr->next)
1538             {
1539                 if (!strcmp((const char *) attr->name, "maximum-record-size"))
1540                     m_p->m_maximumRecordSize =
1541                         mp::xml::get_int(attr->children, 0);
1542                 else if (!strcmp((const char *) attr->name,
1543                                  "preferred-message-size"))
1544                     m_p->m_preferredMessageSize =
1545                         mp::xml::get_int(attr->children, 0);
1546                 else
1547                     throw mp::filter::FilterException(
1548                         "Bad attribute " + std::string((const char *)
1549                                                        attr->name));
1550             }
1551         }
1552         else
1553         {
1554             throw mp::filter::FilterException("Bad element "
1555                                                + std::string((const char *)
1556                                                              ptr->name));
1557         }
1558     }
1559 }
1560
1561 static mp::filter::Base* filter_creator()
1562 {
1563     return new mp::filter::SessionShared;
1564 }
1565
1566 extern "C" {
1567     struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1568         0,
1569         "session_shared",
1570         filter_creator
1571     };
1572 }
1573
1574 /*
1575  * Local variables:
1576  * c-basic-offset: 4
1577  * c-file-style: "Stroustrup"
1578  * indent-tabs-mode: nil
1579  * End:
1580  * vim: shiftwidth=4 tabstop=8 expandtab
1581  */
1582