1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
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
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
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
21 #include <metaproxy/filter.hpp>
22 #include <metaproxy/package.hpp>
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>
31 #include <metaproxy/util.hpp>
32 #include "filter_session_shared.hpp"
36 #include <yaz/otherinfo.h>
37 #include <yaz/diagbib1.h>
38 #include <yazpp/z-query.h>
39 #include <yazpp/record-cache.h>
44 namespace mp = metaproxy_1;
45 namespace yf = metaproxy_1::filter;
47 namespace metaproxy_1 {
50 // key for session.. We'll only share sessions with same InitKey
51 class SessionShared::InitKey {
53 bool operator < (const SessionShared::InitKey &k) const;
54 InitKey(Z_InitRequest *req);
55 InitKey(const InitKey &);
58 char *m_idAuthentication_buf;
59 int m_idAuthentication_size;
60 char *m_otherInfo_buf;
64 // worker thread .. for expiry of sessions
65 class SessionShared::Worker {
67 Worker(SessionShared::Rep *rep);
68 void operator() (void);
70 SessionShared::Rep *m_p;
73 class SessionShared::BackendSet {
75 std::string m_result_set_id;
76 Databases m_databases;
77 int m_result_set_size;
78 yazpp_1::Yaz_Z_Query m_query;
79 time_t m_time_last_use;
81 yazpp_1::RecordCache m_record_cache;
83 const std::string &result_set_id,
84 const Databases &databases,
85 const yazpp_1::Yaz_Z_Query &query);
87 Package &frontend_package,
88 Package &search_package,
89 const Z_APDU *apdu_req,
90 const BackendInstancePtr bp,
91 Z_Records **z_records);
93 // backend connection instance
94 class SessionShared::BackendInstance {
96 friend class BackendClass;
97 friend class BackendSet;
99 mp::Session m_session;
100 BackendSetList m_sets;
103 int m_result_set_sequence;
104 time_t m_time_last_use;
105 mp::Package * m_close_package;
109 // backends of some class (all with same InitKey)
110 class SessionShared::BackendClass : boost::noncopyable {
112 friend struct Frontend;
113 bool m_named_result_sets;
114 BackendInstanceList m_backend_list;
115 BackendInstancePtr create_backend(const Package &package);
116 void remove_backend(BackendInstancePtr b);
117 BackendInstancePtr get_backend(const Package &package);
118 void use_backend(BackendInstancePtr b);
119 void release_backend(BackendInstancePtr b);
121 yazpp_1::GDU m_init_request;
122 yazpp_1::GDU m_init_response;
123 boost::mutex m_mutex_backend_class;
125 time_t m_backend_set_ttl;
126 time_t m_backend_expiry_ttl;
127 size_t m_backend_set_max;
129 BackendClass(const yazpp_1::GDU &init_request,
135 // frontend result set
136 class SessionShared::FrontendSet {
137 Databases m_databases;
138 yazpp_1::Yaz_Z_Query m_query;
140 const Databases &get_databases();
141 const yazpp_1::Yaz_Z_Query &get_query();
143 const Databases &databases,
144 const yazpp_1::Yaz_Z_Query &query);
148 struct SessionShared::Frontend {
153 Z_Options m_init_options;
154 void search(Package &package, Z_APDU *apdu);
155 void present(Package &package, Z_APDU *apdu);
156 void scan(Package &package, Z_APDU *apdu);
158 void get_set(mp::Package &package,
159 const Z_APDU *apdu_req,
160 const Databases &databases,
161 yazpp_1::Yaz_Z_Query &query,
162 BackendInstancePtr &found_backend,
163 BackendSetPtr &found_set);
164 void override_set(BackendInstancePtr &found_backend,
165 std::string &result_set_id,
166 const Databases &databases);
169 BackendClassPtr m_backend_class;
170 FrontendSets m_frontend_sets;
173 class SessionShared::Rep {
174 friend class SessionShared;
175 friend struct Frontend;
177 FrontendPtr get_frontend(Package &package);
178 void release_frontend(Package &package);
183 void init(Package &package, const Z_GDU *gdu,
184 FrontendPtr frontend);
186 boost::mutex m_mutex;
187 boost::condition m_cond_session_ready;
188 std::map<mp::Session, FrontendPtr> m_clients;
190 BackendClassMap m_backend_map;
191 boost::mutex m_mutex_backend_map;
192 boost::thread_group m_thrds;
196 bool m_optimize_search;
201 yf::SessionShared::FrontendSet::FrontendSet(
202 const Databases &databases,
203 const yazpp_1::Yaz_Z_Query &query)
204 : m_databases(databases), m_query(query)
208 const yf::SessionShared::Databases &
209 yf::SessionShared::FrontendSet::get_databases()
214 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
219 yf::SessionShared::InitKey::InitKey(const InitKey &k)
221 m_odr = odr_createmem(ODR_ENCODE);
223 m_idAuthentication_size = k.m_idAuthentication_size;
224 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
225 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
226 m_idAuthentication_size);
228 m_otherInfo_size = k.m_otherInfo_size;
229 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
230 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
234 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
236 m_odr = odr_createmem(ODR_ENCODE);
238 Z_IdAuthentication *t = req->idAuthentication;
239 z_IdAuthentication(m_odr, &t, 1, 0);
240 m_idAuthentication_buf =
241 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
243 Z_OtherInformation *o = req->otherInfo;
244 z_OtherInformation(m_odr, &o, 1, 0);
245 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
248 yf::SessionShared::InitKey::~InitKey()
253 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
257 c = mp::util::memcmp2(
258 (void*) m_idAuthentication_buf, m_idAuthentication_size,
259 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
265 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
266 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
274 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
276 boost::mutex::scoped_lock lock(m_mutex_backend_class);
281 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
283 BackendInstanceList::iterator it = m_backend_list.begin();
285 while (it != m_backend_list.end())
290 (*it)->m_close_package->response() = odr.create_close(
291 0, Z_Close_lackOfActivity, 0);
292 (*it)->m_close_package->session().close();
293 (*it)->m_close_package->move();
295 it = m_backend_list.erase(it);
304 yf::SessionShared::BackendInstancePtr
305 yf::SessionShared::BackendClass::get_backend(
306 const mp::Package &frontend_package)
309 boost::mutex::scoped_lock lock(m_mutex_backend_class);
311 BackendInstanceList::const_iterator it = m_backend_list.begin();
313 BackendInstancePtr backend1; // null
315 for (; it != m_backend_list.end(); it++)
317 if (!(*it)->m_in_use)
320 || (*it)->m_sequence_this < backend1->m_sequence_this)
326 use_backend(backend1);
330 return create_backend(frontend_package);
333 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
335 backend->m_in_use = true;
336 backend->m_sequence_this = m_sequence_top++;
339 void yf::SessionShared::BackendInstance::timestamp()
342 time(&m_time_last_use);
345 yf::SessionShared::BackendInstance::~BackendInstance()
347 delete m_close_package;
350 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
351 const mp::Package &frontend_package)
353 BackendInstancePtr bp(new BackendInstance);
354 BackendInstancePtr null;
356 bp->m_close_package =
357 new mp::Package(bp->m_session, frontend_package.origin());
358 bp->m_close_package->copy_filter(frontend_package);
360 Package init_package(bp->m_session, frontend_package.origin());
362 init_package.copy_filter(frontend_package);
364 yazpp_1::GDU actual_init_request = m_init_request;
365 Z_GDU *init_pdu = actual_init_request.get();
367 assert(init_pdu->which == Z_GDU_Z3950);
368 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
370 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
371 ODR_MASK_ZERO(req->options);
373 ODR_MASK_SET(req->options, Z_Options_search);
374 ODR_MASK_SET(req->options, Z_Options_present);
375 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
376 ODR_MASK_SET(req->options, Z_Options_scan);
378 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
379 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
380 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
382 init_package.request() = init_pdu;
386 boost::mutex::scoped_lock lock(m_mutex_backend_class);
388 m_named_result_sets = false;
389 Z_GDU *gdu = init_package.response().get();
390 if (init_package.session().is_closed())
392 /* already closed. We don't know why */
395 else if (gdu && gdu->which == Z_GDU_Z3950
396 && gdu->u.z3950->which == Z_APDU_initResponse
397 && *gdu->u.z3950->u.initResponse->result)
399 /* successful init response */
400 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
401 m_init_response = gdu->u.z3950;
402 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
404 m_named_result_sets = true;
409 /* not init or init rejected */
410 init_package.copy_filter(frontend_package);
411 init_package.session().close();
416 time(&bp->m_time_last_use);
417 bp->m_sequence_this = 0;
418 bp->m_result_set_sequence = 0;
419 m_backend_list.push_back(bp);
425 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
429 : m_named_result_sets(false), m_init_request(init_request),
430 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
431 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max)
434 yf::SessionShared::BackendClass::~BackendClass()
437 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
438 FrontendPtr frontend)
440 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
442 frontend->m_is_virtual = true;
443 frontend->m_init_options = *req->options;
446 boost::mutex::scoped_lock lock(m_mutex_backend_map);
447 BackendClassMap::const_iterator it;
448 it = m_backend_map.find(k);
449 if (it == m_backend_map.end())
451 BackendClassPtr b(new BackendClass(gdu->u.z3950,
455 m_backend_map[k] = b;
456 frontend->m_backend_class = b;
460 frontend->m_backend_class = it->second;
463 BackendClassPtr bc = frontend->m_backend_class;
464 BackendInstancePtr backend = bc->get_backend(package);
469 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
470 *apdu->u.initResponse->result = 0;
471 package.response() = apdu;
472 package.session().close();
476 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
477 yazpp_1::GDU init_response = bc->m_init_response;
478 Z_GDU *response_gdu = init_response.get();
479 mp::util::transfer_referenceId(odr, gdu->u.z3950,
480 response_gdu->u.z3950);
482 Z_Options *server_options =
483 response_gdu->u.z3950->u.initResponse->options;
484 Z_Options *client_options = &frontend->m_init_options;
487 for (i = 0; i<30; i++)
488 if (!ODR_MASK_GET(client_options, i))
489 ODR_MASK_CLEAR(server_options, i);
490 package.response() = init_response;
493 bc->release_backend(backend);
496 void yf::SessionShared::BackendSet::timestamp()
498 time(&m_time_last_use);
501 yf::SessionShared::BackendSet::BackendSet(
502 const std::string &result_set_id,
503 const Databases &databases,
504 const yazpp_1::Yaz_Z_Query &query) :
505 m_result_set_id(result_set_id),
506 m_databases(databases), m_result_set_size(0), m_query(query)
511 static int get_diagnostic(Z_DefaultDiagFormat *r)
513 return *r->condition;
516 bool yf::SessionShared::BackendSet::search(
517 mp::Package &frontend_package,
518 mp::Package &search_package,
519 const Z_APDU *frontend_apdu,
520 const BackendInstancePtr bp,
521 Z_Records **z_records)
524 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
525 Z_SearchRequest *req = apdu_req->u.searchRequest;
527 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
528 req->query = m_query.get_Z_Query();
530 req->num_databaseNames = m_databases.size();
531 req->databaseNames = (char**)
532 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
533 Databases::const_iterator it = m_databases.begin();
535 for (; it != m_databases.end(); it++)
536 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
538 if (frontend_apdu->which == Z_APDU_searchRequest)
539 req->preferredRecordSyntax =
540 frontend_apdu->u.searchRequest->preferredRecordSyntax;
542 search_package.request() = apdu_req;
544 search_package.move();
546 Z_GDU *gdu = search_package.response().get();
547 if (!search_package.session().is_closed()
548 && gdu && gdu->which == Z_GDU_Z3950
549 && gdu->u.z3950->which == Z_APDU_searchResponse)
551 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
552 *z_records = b_resp->records;
553 m_result_set_size = *b_resp->resultCount;
557 if (frontend_apdu->which == Z_APDU_searchRequest)
558 f_apdu = odr.create_searchResponse(
559 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
560 else if (frontend_apdu->which == Z_APDU_presentRequest)
561 f_apdu = odr.create_presentResponse(
562 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
564 f_apdu = odr.create_close(
565 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
566 frontend_package.response() = f_apdu;
570 void yf::SessionShared::Frontend::override_set(
571 BackendInstancePtr &found_backend,
572 std::string &result_set_id,
573 const Databases &databases)
575 BackendClassPtr bc = m_backend_class;
576 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
580 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
581 for (; it != bc->m_backend_list.end(); it++)
583 if (!(*it)->m_in_use)
585 BackendSetList::iterator set_it = (*it)->m_sets.begin();
586 for (; set_it != (*it)->m_sets.end(); set_it++)
588 if ((max_sets > 1 || (*set_it)->m_databases == databases)
590 (now < (*set_it)->m_time_last_use ||
591 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
594 result_set_id = (*set_it)->m_result_set_id;
595 found_backend->m_sets.erase(set_it);
601 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
603 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
606 if (bc->m_named_result_sets)
608 result_set_id = boost::io::str(
609 boost::format("%1%") %
610 found_backend->m_result_set_sequence);
611 found_backend->m_result_set_sequence++;
614 result_set_id = "default";
620 void yf::SessionShared::Frontend::get_set(mp::Package &package,
621 const Z_APDU *apdu_req,
622 const Databases &databases,
623 yazpp_1::Yaz_Z_Query &query,
624 BackendInstancePtr &found_backend,
625 BackendSetPtr &found_set)
627 bool session_restarted = false;
630 std::string result_set_id;
631 BackendClassPtr bc = m_backend_class;
633 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
635 if (m_p->m_optimize_search)
637 // look at each backend and see if we have a similar search
638 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
639 for (; it != bc->m_backend_list.end(); it++)
641 if (!(*it)->m_in_use)
643 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
644 for (; set_it != (*it)->m_sets.end(); set_it++)
646 if ((*set_it)->m_databases == databases
647 && query.match(&(*set_it)->m_query))
651 bc->use_backend(found_backend);
652 found_set->timestamp();
653 // found matching set. No need to search again
660 override_set(found_backend, result_set_id, databases);
662 bc->use_backend(found_backend);
666 // create a new backend set (and new set)
667 found_backend = bc->create_backend(package);
673 if (apdu_req->which == Z_APDU_searchRequest)
675 f_apdu = odr.create_searchResponse(
676 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
678 else if (apdu_req->which == Z_APDU_presentRequest)
680 f_apdu = odr.create_presentResponse(
681 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
685 f_apdu = odr.create_close(
686 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
688 package.response() = f_apdu;
691 if (bc->m_named_result_sets)
693 result_set_id = boost::io::str(
694 boost::format("%1%") % found_backend->m_result_set_sequence);
695 found_backend->m_result_set_sequence++;
698 result_set_id = "default";
700 found_backend->timestamp();
702 // we must search ...
703 BackendSetPtr new_set(new BackendSet(result_set_id,
705 Z_Records *z_records = 0;
707 Package search_package(found_backend->m_session, package.origin());
708 search_package.copy_filter(package);
710 if (!new_set->search(package, search_package,
711 apdu_req, found_backend, &z_records))
713 bc->remove_backend(found_backend);
714 return; // search error
720 if (z_records->which == Z_Records_NSD)
723 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
725 else if (z_records->which == Z_Records_multipleNSD)
727 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
730 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
731 Z_DiagRec_defaultFormat)
733 condition = get_diagnostic(
734 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
738 if (!session_restarted &&
739 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
741 bc->remove_backend(found_backend);
742 session_restarted = true;
743 found_backend.reset();
751 if (apdu_req->which == Z_APDU_searchRequest)
753 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
755 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
756 *f_resp->searchStatus = Z_SearchResponse_none;
757 f_resp->records = z_records;
758 package.response() = f_apdu;
760 if (apdu_req->which == Z_APDU_presentRequest)
762 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
764 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
765 f_resp->records = z_records;
766 package.response() = f_apdu;
768 bc->release_backend(found_backend);
769 return; // search error
772 if (!session_restarted && new_set->m_result_set_size < 0)
774 bc->remove_backend(found_backend);
775 session_restarted = true;
776 found_backend.reset();
781 found_set->timestamp();
782 found_backend->m_sets.push_back(found_set);
785 void yf::SessionShared::Frontend::search(mp::Package &package,
788 Z_SearchRequest *req = apdu_req->u.searchRequest;
789 FrontendSets::iterator fset_it =
790 m_frontend_sets.find(req->resultSetName);
791 if (fset_it != m_frontend_sets.end())
793 // result set already exist
794 // if replace indicator is off: we return diagnostic if
795 // result set already exist.
796 if (*req->replaceIndicator == 0)
800 odr.create_searchResponse(
802 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
804 package.response() = apdu;
808 m_frontend_sets.erase(fset_it);
811 yazpp_1::Yaz_Z_Query query;
812 query.set_Z_Query(req->query);
815 for (i = 0; i<req->num_databaseNames; i++)
816 databases.push_back(req->databaseNames[i]);
818 BackendSetPtr found_set; // null
819 BackendInstancePtr found_backend; // null
821 get_set(package, apdu_req, databases, query, found_backend, found_set);
826 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
827 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
828 *f_resp->resultCount = found_set->m_result_set_size;
829 package.response() = f_apdu;
831 FrontendSetPtr fset(new FrontendSet(databases, query));
832 m_frontend_sets[req->resultSetName] = fset;
834 m_backend_class->release_backend(found_backend);
837 void yf::SessionShared::Frontend::present(mp::Package &package,
841 Z_PresentRequest *req = apdu_req->u.presentRequest;
843 FrontendSets::iterator fset_it =
844 m_frontend_sets.find(req->resultSetId);
846 if (fset_it == m_frontend_sets.end())
849 odr.create_presentResponse(
851 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
853 package.response() = apdu;
856 FrontendSetPtr fset = fset_it->second;
858 Databases databases = fset->get_databases();
859 yazpp_1::Yaz_Z_Query query = fset->get_query();
861 BackendClassPtr bc = m_backend_class;
862 BackendSetPtr found_set; // null
863 BackendInstancePtr found_backend;
865 get_set(package, apdu_req, databases, query, found_backend, found_set);
869 Z_NamePlusRecordList *npr_res = 0;
870 if (found_set->m_record_cache.lookup(odr, &npr_res,
871 *req->resultSetStartPoint,
872 *req->numberOfRecordsRequested,
873 req->preferredRecordSyntax,
874 req->recordComposition))
876 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
877 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
879 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
880 " records in cache %p",
881 *req->resultSetStartPoint,
882 *req->numberOfRecordsRequested,
883 &found_set->m_record_cache);
885 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
886 *f_resp->nextResultSetPosition =
887 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
888 // f_resp->presentStatus assumed OK.
889 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
890 f_resp->records->which = Z_Records_DBOSD;
891 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
892 package.response() = f_apdu_res;
893 bc->release_backend(found_backend);
897 found_backend->timestamp();
899 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
900 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
901 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
902 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
903 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
904 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
905 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
906 p_req->recordComposition = req->recordComposition;
908 Package present_package(found_backend->m_session, package.origin());
909 present_package.copy_filter(package);
911 present_package.request() = p_apdu;
913 present_package.move();
915 Z_GDU *gdu = present_package.response().get();
916 if (!present_package.session().is_closed()
917 && gdu && gdu->which == Z_GDU_Z3950
918 && gdu->u.z3950->which == Z_APDU_presentResponse)
920 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
921 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
922 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
924 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
925 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
926 f_resp->presentStatus= b_resp->presentStatus;
927 f_resp->records = b_resp->records;
928 f_resp->otherInfo = b_resp->otherInfo;
929 package.response() = f_apdu_res;
931 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
933 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
934 " records to cache %p",
935 *req->resultSetStartPoint,
936 *f_resp->numberOfRecordsReturned,
937 &found_set->m_record_cache);
938 found_set->m_record_cache.add(
940 b_resp->records->u.databaseOrSurDiagnostics,
941 *req->resultSetStartPoint,
942 *f_resp->numberOfRecordsReturned);
944 bc->release_backend(found_backend);
948 bc->remove_backend(found_backend);
950 odr.create_presentResponse(
951 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
952 package.response() = f_apdu_res;
956 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
959 BackendClassPtr bc = m_backend_class;
960 BackendInstancePtr backend = bc->get_backend(frontend_package);
964 Z_APDU *apdu = odr.create_scanResponse(
965 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
966 frontend_package.response() = apdu;
970 Package scan_package(backend->m_session, frontend_package.origin());
971 backend->timestamp();
972 scan_package.copy_filter(frontend_package);
973 scan_package.request() = apdu_req;
975 frontend_package.response() = scan_package.response();
976 if (scan_package.session().is_closed())
978 frontend_package.session().close();
979 bc->remove_backend(backend);
982 bc->release_backend(backend);
986 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
990 void yf::SessionShared::Worker::operator() (void)
995 void yf::SessionShared::BackendClass::expire_class()
999 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1000 BackendInstanceList::iterator bit = m_backend_list.begin();
1001 while (bit != m_backend_list.end())
1003 time_t last_use = (*bit)->m_time_last_use;
1005 if ((*bit)->m_in_use)
1009 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1012 (*bit)->m_close_package->response() = odr.create_close(
1013 0, Z_Close_lackOfActivity, 0);
1014 (*bit)->m_close_package->session().close();
1015 (*bit)->m_close_package->move();
1017 bit = m_backend_list.erase(bit);
1026 void yf::SessionShared::Rep::expire()
1031 boost::xtime_get(&xt, boost::TIME_UTC);
1032 xt.sec += m_session_ttl / 3;
1033 boost::thread::sleep(xt);
1035 BackendClassMap::const_iterator b_it = m_backend_map.begin();
1036 for (; b_it != m_backend_map.end(); b_it++)
1037 b_it->second->expire_class();
1041 yf::SessionShared::Rep::Rep()
1043 m_resultset_ttl = 30;
1044 m_resultset_max = 10;
1046 m_optimize_search = true;
1049 void yf::SessionShared::Rep::start()
1051 yf::SessionShared::Worker w(this);
1052 m_thrds.add_thread(new boost::thread(w));
1055 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1059 yf::SessionShared::~SessionShared() {
1062 void yf::SessionShared::start() const
1067 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1071 yf::SessionShared::Frontend::~Frontend()
1075 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1077 boost::mutex::scoped_lock lock(m_mutex);
1079 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1083 it = m_clients.find(package.session());
1084 if (it == m_clients.end())
1087 if (!it->second->m_in_use)
1089 it->second->m_in_use = true;
1092 m_cond_session_ready.wait(lock);
1094 FrontendPtr f(new Frontend(this));
1095 m_clients[package.session()] = f;
1100 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1102 boost::mutex::scoped_lock lock(m_mutex);
1103 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1105 it = m_clients.find(package.session());
1106 if (it != m_clients.end())
1108 if (package.session().is_closed())
1110 m_clients.erase(it);
1114 it->second->m_in_use = false;
1116 m_cond_session_ready.notify_all();
1121 void yf::SessionShared::process(mp::Package &package) const
1123 FrontendPtr f = m_p->get_frontend(package);
1125 Z_GDU *gdu = package.request().get();
1127 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1128 Z_APDU_initRequest && !f->m_is_virtual)
1130 m_p->init(package, gdu, f);
1132 else if (!f->m_is_virtual)
1134 else if (gdu && gdu->which == Z_GDU_Z3950)
1136 Z_APDU *apdu = gdu->u.z3950;
1137 if (apdu->which == Z_APDU_initRequest)
1141 package.response() = odr.create_close(
1143 Z_Close_protocolError,
1146 package.session().close();
1148 else if (apdu->which == Z_APDU_close)
1152 package.response() = odr.create_close(
1154 Z_Close_peerAbort, "received close from client");
1155 package.session().close();
1157 else if (apdu->which == Z_APDU_searchRequest)
1159 f->search(package, apdu);
1161 else if (apdu->which == Z_APDU_presentRequest)
1163 f->present(package, apdu);
1165 else if (apdu->which == Z_APDU_scanRequest)
1167 f->scan(package, apdu);
1173 package.response() = odr.create_close(
1174 apdu, Z_Close_protocolError,
1175 "unsupported APDU in filter_session_shared");
1177 package.session().close();
1180 m_p->release_frontend(package);
1183 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1186 for (ptr = ptr->children; ptr; ptr = ptr->next)
1188 if (ptr->type != XML_ELEMENT_NODE)
1190 if (!strcmp((const char *) ptr->name, "resultset"))
1192 const struct _xmlAttr *attr;
1193 for (attr = ptr->properties; attr; attr = attr->next)
1195 if (!strcmp((const char *) attr->name, "ttl"))
1196 m_p->m_resultset_ttl =
1197 mp::xml::get_int(attr->children, 30);
1198 else if (!strcmp((const char *) attr->name, "max"))
1200 m_p->m_resultset_max =
1201 mp::xml::get_int(attr->children, 10);
1203 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1205 m_p->m_optimize_search =
1206 mp::xml::get_bool(attr->children, true);
1209 throw mp::filter::FilterException(
1210 "Bad attribute " + std::string((const char *)
1214 else if (!strcmp((const char *) ptr->name, "session"))
1216 const struct _xmlAttr *attr;
1217 for (attr = ptr->properties; attr; attr = attr->next)
1219 if (!strcmp((const char *) attr->name, "ttl"))
1220 m_p->m_session_ttl =
1221 mp::xml::get_int(attr->children, 120);
1223 throw mp::filter::FilterException(
1224 "Bad attribute " + std::string((const char *)
1230 throw mp::filter::FilterException("Bad element "
1231 + std::string((const char *)
1237 static mp::filter::Base* filter_creator()
1239 return new mp::filter::SessionShared;
1243 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1253 * c-file-style: "Stroustrup"
1254 * indent-tabs-mode: nil
1256 * vim: shiftwidth=4 tabstop=8 expandtab