1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 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);
168 BackendClassPtr m_backend_class;
169 FrontendSets m_frontend_sets;
172 class SessionShared::Rep {
173 friend class SessionShared;
174 friend struct Frontend;
176 FrontendPtr get_frontend(Package &package);
177 void release_frontend(Package &package);
182 void init(Package &package, const Z_GDU *gdu,
183 FrontendPtr frontend);
185 boost::mutex m_mutex;
186 boost::condition m_cond_session_ready;
187 std::map<mp::Session, FrontendPtr> m_clients;
189 BackendClassMap m_backend_map;
190 boost::mutex m_mutex_backend_map;
191 boost::thread_group m_thrds;
195 bool m_optimize_search;
200 yf::SessionShared::FrontendSet::FrontendSet(
201 const Databases &databases,
202 const yazpp_1::Yaz_Z_Query &query)
203 : m_databases(databases), m_query(query)
207 const yf::SessionShared::Databases &
208 yf::SessionShared::FrontendSet::get_databases()
213 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
218 yf::SessionShared::InitKey::InitKey(const InitKey &k)
220 m_odr = odr_createmem(ODR_ENCODE);
222 m_idAuthentication_size = k.m_idAuthentication_size;
223 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
224 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
225 m_idAuthentication_size);
227 m_otherInfo_size = k.m_otherInfo_size;
228 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
229 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
233 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
235 m_odr = odr_createmem(ODR_ENCODE);
237 Z_IdAuthentication *t = req->idAuthentication;
238 z_IdAuthentication(m_odr, &t, 1, 0);
239 m_idAuthentication_buf =
240 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
242 Z_OtherInformation *o = req->otherInfo;
243 z_OtherInformation(m_odr, &o, 1, 0);
244 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
247 yf::SessionShared::InitKey::~InitKey()
252 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
256 c = mp::util::memcmp2(
257 (void*) m_idAuthentication_buf, m_idAuthentication_size,
258 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
264 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
265 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
273 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
275 boost::mutex::scoped_lock lock(m_mutex_backend_class);
280 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
282 BackendInstanceList::iterator it = m_backend_list.begin();
284 while (it != m_backend_list.end())
289 (*it)->m_close_package->response() = odr.create_close(
290 0, Z_Close_lackOfActivity, 0);
291 (*it)->m_close_package->session().close();
292 (*it)->m_close_package->move();
294 it = m_backend_list.erase(it);
303 yf::SessionShared::BackendInstancePtr
304 yf::SessionShared::BackendClass::get_backend(
305 const mp::Package &frontend_package)
308 boost::mutex::scoped_lock lock(m_mutex_backend_class);
310 BackendInstanceList::const_iterator it = m_backend_list.begin();
312 BackendInstancePtr backend1; // null
314 for (; it != m_backend_list.end(); it++)
316 if (!(*it)->m_in_use)
319 || (*it)->m_sequence_this < backend1->m_sequence_this)
325 use_backend(backend1);
329 return create_backend(frontend_package);
332 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
334 backend->m_in_use = true;
335 backend->m_sequence_this = m_sequence_top++;
338 void yf::SessionShared::BackendInstance::timestamp()
341 time(&m_time_last_use);
344 yf::SessionShared::BackendInstance::~BackendInstance()
346 delete m_close_package;
349 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
350 const mp::Package &frontend_package)
352 BackendInstancePtr bp(new BackendInstance);
353 BackendInstancePtr null;
355 bp->m_close_package =
356 new mp::Package(bp->m_session, frontend_package.origin());
357 bp->m_close_package->copy_filter(frontend_package);
359 Package init_package(bp->m_session, frontend_package.origin());
361 init_package.copy_filter(frontend_package);
363 yazpp_1::GDU actual_init_request = m_init_request;
364 Z_GDU *init_pdu = actual_init_request.get();
366 assert(init_pdu->which == Z_GDU_Z3950);
367 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
369 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
370 ODR_MASK_ZERO(req->options);
372 ODR_MASK_SET(req->options, Z_Options_search);
373 ODR_MASK_SET(req->options, Z_Options_present);
374 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
375 ODR_MASK_SET(req->options, Z_Options_scan);
377 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
378 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
379 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
381 init_package.request() = init_pdu;
385 boost::mutex::scoped_lock lock(m_mutex_backend_class);
387 m_named_result_sets = false;
388 Z_GDU *gdu = init_package.response().get();
389 if (init_package.session().is_closed())
391 /* already closed. We don't know why */
394 else if (gdu && gdu->which == Z_GDU_Z3950
395 && gdu->u.z3950->which == Z_APDU_initResponse
396 && *gdu->u.z3950->u.initResponse->result)
398 /* successful init response */
399 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
400 m_init_response = gdu->u.z3950;
401 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
403 m_named_result_sets = true;
408 /* not init or init rejected */
409 init_package.copy_filter(frontend_package);
410 init_package.session().close();
415 time(&bp->m_time_last_use);
416 bp->m_sequence_this = 0;
417 bp->m_result_set_sequence = 0;
418 m_backend_list.push_back(bp);
424 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
428 : m_named_result_sets(false), m_init_request(init_request),
429 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
430 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max)
433 yf::SessionShared::BackendClass::~BackendClass()
436 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
437 FrontendPtr frontend)
439 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
441 frontend->m_is_virtual = true;
442 frontend->m_init_options = *req->options;
445 boost::mutex::scoped_lock lock(m_mutex_backend_map);
446 BackendClassMap::const_iterator it;
447 it = m_backend_map.find(k);
448 if (it == m_backend_map.end())
450 BackendClassPtr b(new BackendClass(gdu->u.z3950,
454 m_backend_map[k] = b;
455 frontend->m_backend_class = b;
459 frontend->m_backend_class = it->second;
462 BackendClassPtr bc = frontend->m_backend_class;
463 BackendInstancePtr backend = bc->get_backend(package);
468 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
469 *apdu->u.initResponse->result = 0;
470 package.response() = apdu;
471 package.session().close();
475 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
476 yazpp_1::GDU init_response = bc->m_init_response;
477 Z_GDU *response_gdu = init_response.get();
478 mp::util::transfer_referenceId(odr, gdu->u.z3950,
479 response_gdu->u.z3950);
481 Z_Options *server_options =
482 response_gdu->u.z3950->u.initResponse->options;
483 Z_Options *client_options = &frontend->m_init_options;
486 for (i = 0; i<30; i++)
487 if (!ODR_MASK_GET(client_options, i))
488 ODR_MASK_CLEAR(server_options, i);
489 package.response() = init_response;
492 bc->release_backend(backend);
495 void yf::SessionShared::BackendSet::timestamp()
497 time(&m_time_last_use);
500 yf::SessionShared::BackendSet::BackendSet(
501 const std::string &result_set_id,
502 const Databases &databases,
503 const yazpp_1::Yaz_Z_Query &query) :
504 m_result_set_id(result_set_id),
505 m_databases(databases), m_result_set_size(0), m_query(query)
510 static int get_diagnostic(Z_DefaultDiagFormat *r)
512 return *r->condition;
515 bool yf::SessionShared::BackendSet::search(
516 mp::Package &frontend_package,
517 mp::Package &search_package,
518 const Z_APDU *frontend_apdu,
519 const BackendInstancePtr bp,
520 Z_Records **z_records)
523 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
524 Z_SearchRequest *req = apdu_req->u.searchRequest;
526 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
527 req->query = m_query.get_Z_Query();
529 req->num_databaseNames = m_databases.size();
530 req->databaseNames = (char**)
531 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
532 Databases::const_iterator it = m_databases.begin();
534 for (; it != m_databases.end(); it++)
535 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
537 if (frontend_apdu->which == Z_APDU_searchRequest)
538 req->preferredRecordSyntax =
539 frontend_apdu->u.searchRequest->preferredRecordSyntax;
541 search_package.request() = apdu_req;
543 search_package.move();
545 Z_GDU *gdu = search_package.response().get();
546 if (!search_package.session().is_closed()
547 && gdu && gdu->which == Z_GDU_Z3950
548 && gdu->u.z3950->which == Z_APDU_searchResponse)
550 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
551 *z_records = b_resp->records;
552 m_result_set_size = *b_resp->resultCount;
556 if (frontend_apdu->which == Z_APDU_searchRequest)
557 f_apdu = odr.create_searchResponse(
558 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
559 else if (frontend_apdu->which == Z_APDU_presentRequest)
560 f_apdu = odr.create_presentResponse(
561 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
563 f_apdu = odr.create_close(
564 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
565 frontend_package.response() = f_apdu;
569 void yf::SessionShared::Frontend::override_set(
570 BackendInstancePtr &found_backend,
571 std::string &result_set_id)
573 BackendClassPtr bc = m_backend_class;
574 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
578 for (; it != bc->m_backend_list.end(); it++)
580 if (!(*it)->m_in_use)
582 BackendSetList::iterator set_it = (*it)->m_sets.begin();
583 for (; set_it != (*it)->m_sets.end(); set_it++)
585 if (now >= (*set_it)->m_time_last_use &&
586 now - (*set_it)->m_time_last_use > bc->m_backend_set_ttl)
589 result_set_id = (*set_it)->m_result_set_id;
590 found_backend->m_sets.erase(set_it);
596 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
597 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
599 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
602 if (bc->m_named_result_sets)
604 result_set_id = boost::io::str(
605 boost::format("%1%") %
606 found_backend->m_result_set_sequence);
607 found_backend->m_result_set_sequence++;
610 result_set_id = "default";
616 void yf::SessionShared::Frontend::get_set(mp::Package &package,
617 const Z_APDU *apdu_req,
618 const Databases &databases,
619 yazpp_1::Yaz_Z_Query &query,
620 BackendInstancePtr &found_backend,
621 BackendSetPtr &found_set)
623 bool session_restarted = false;
626 std::string result_set_id;
627 BackendClassPtr bc = m_backend_class;
629 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
631 if (m_p->m_optimize_search)
633 // look at each backend and see if we have a similar search
634 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
635 for (; it != bc->m_backend_list.end(); it++)
637 if (!(*it)->m_in_use)
639 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
640 for (; set_it != (*it)->m_sets.end(); set_it++)
642 if ((*set_it)->m_databases == databases
643 && query.match(&(*set_it)->m_query))
647 bc->use_backend(found_backend);
648 found_set->timestamp();
649 // found matching set. No need to search again
656 override_set(found_backend, result_set_id);
658 bc->use_backend(found_backend);
662 // create a new backend set (and new set)
663 found_backend = bc->create_backend(package);
669 if (apdu_req->which == Z_APDU_searchRequest)
671 f_apdu = odr.create_searchResponse(
672 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
674 else if (apdu_req->which == Z_APDU_presentRequest)
676 f_apdu = odr.create_presentResponse(
677 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
681 f_apdu = odr.create_close(
682 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
684 package.response() = f_apdu;
687 if (bc->m_named_result_sets)
689 result_set_id = boost::io::str(
690 boost::format("%1%") % found_backend->m_result_set_sequence);
691 found_backend->m_result_set_sequence++;
694 result_set_id = "default";
696 found_backend->timestamp();
698 // we must search ...
699 BackendSetPtr new_set(new BackendSet(result_set_id,
701 Z_Records *z_records = 0;
703 Package search_package(found_backend->m_session, package.origin());
704 search_package.copy_filter(package);
706 if (!new_set->search(package, search_package,
707 apdu_req, found_backend, &z_records))
709 bc->remove_backend(found_backend);
710 return; // search error
716 if (z_records->which == Z_Records_NSD)
719 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
721 else if (z_records->which == Z_Records_multipleNSD)
723 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
726 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
727 Z_DiagRec_defaultFormat)
729 condition = get_diagnostic(
730 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
734 if (!session_restarted &&
735 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
737 bc->remove_backend(found_backend);
738 session_restarted = true;
739 found_backend.reset();
747 if (apdu_req->which == Z_APDU_searchRequest)
749 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
751 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
752 *f_resp->searchStatus = Z_SearchResponse_none;
753 f_resp->records = z_records;
754 package.response() = f_apdu;
756 if (apdu_req->which == Z_APDU_presentRequest)
758 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
760 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
761 f_resp->records = z_records;
762 package.response() = f_apdu;
764 bc->release_backend(found_backend);
765 return; // search error
768 if (!session_restarted && new_set->m_result_set_size < 0)
770 bc->remove_backend(found_backend);
771 session_restarted = true;
772 found_backend.reset();
777 found_set->timestamp();
778 found_backend->m_sets.push_back(found_set);
781 void yf::SessionShared::Frontend::search(mp::Package &package,
784 Z_SearchRequest *req = apdu_req->u.searchRequest;
785 FrontendSets::iterator fset_it =
786 m_frontend_sets.find(req->resultSetName);
787 if (fset_it != m_frontend_sets.end())
789 // result set already exist
790 // if replace indicator is off: we return diagnostic if
791 // result set already exist.
792 if (*req->replaceIndicator == 0)
796 odr.create_searchResponse(
798 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
800 package.response() = apdu;
804 m_frontend_sets.erase(fset_it);
807 yazpp_1::Yaz_Z_Query query;
808 query.set_Z_Query(req->query);
811 for (i = 0; i<req->num_databaseNames; i++)
812 databases.push_back(req->databaseNames[i]);
814 BackendSetPtr found_set; // null
815 BackendInstancePtr found_backend; // null
817 get_set(package, apdu_req, databases, query, found_backend, found_set);
822 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
823 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
824 *f_resp->resultCount = found_set->m_result_set_size;
825 package.response() = f_apdu;
827 FrontendSetPtr fset(new FrontendSet(databases, query));
828 m_frontend_sets[req->resultSetName] = fset;
830 m_backend_class->release_backend(found_backend);
833 void yf::SessionShared::Frontend::present(mp::Package &package,
837 Z_PresentRequest *req = apdu_req->u.presentRequest;
839 FrontendSets::iterator fset_it =
840 m_frontend_sets.find(req->resultSetId);
842 if (fset_it == m_frontend_sets.end())
845 odr.create_presentResponse(
847 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
849 package.response() = apdu;
852 FrontendSetPtr fset = fset_it->second;
854 Databases databases = fset->get_databases();
855 yazpp_1::Yaz_Z_Query query = fset->get_query();
857 BackendClassPtr bc = m_backend_class;
858 BackendSetPtr found_set; // null
859 BackendInstancePtr found_backend;
861 get_set(package, apdu_req, databases, query, found_backend, found_set);
865 Z_NamePlusRecordList *npr_res = 0;
866 if (found_set->m_record_cache.lookup(odr, &npr_res,
867 *req->resultSetStartPoint,
868 *req->numberOfRecordsRequested,
869 req->preferredRecordSyntax,
870 req->recordComposition))
872 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
873 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
875 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
876 " records in cache %p",
877 *req->resultSetStartPoint,
878 *req->numberOfRecordsRequested,
879 &found_set->m_record_cache);
881 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
882 *f_resp->nextResultSetPosition =
883 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
884 // f_resp->presentStatus assumed OK.
885 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
886 f_resp->records->which = Z_Records_DBOSD;
887 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
888 package.response() = f_apdu_res;
889 bc->release_backend(found_backend);
893 found_backend->timestamp();
895 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
896 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
897 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
898 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
899 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
900 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
901 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
902 p_req->recordComposition = req->recordComposition;
904 Package present_package(found_backend->m_session, package.origin());
905 present_package.copy_filter(package);
907 present_package.request() = p_apdu;
909 present_package.move();
911 Z_GDU *gdu = present_package.response().get();
912 if (!present_package.session().is_closed()
913 && gdu && gdu->which == Z_GDU_Z3950
914 && gdu->u.z3950->which == Z_APDU_presentResponse)
916 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
917 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
918 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
920 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
921 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
922 f_resp->presentStatus= b_resp->presentStatus;
923 f_resp->records = b_resp->records;
924 f_resp->otherInfo = b_resp->otherInfo;
925 package.response() = f_apdu_res;
927 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
929 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
930 " records to cache %p",
931 *req->resultSetStartPoint,
932 *f_resp->numberOfRecordsReturned,
933 &found_set->m_record_cache);
934 found_set->m_record_cache.add(
936 b_resp->records->u.databaseOrSurDiagnostics,
937 *req->resultSetStartPoint,
938 *f_resp->numberOfRecordsReturned);
940 bc->release_backend(found_backend);
944 bc->remove_backend(found_backend);
946 odr.create_presentResponse(
947 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
948 package.response() = f_apdu_res;
952 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
955 BackendClassPtr bc = m_backend_class;
956 BackendInstancePtr backend = bc->get_backend(frontend_package);
960 Z_APDU *apdu = odr.create_scanResponse(
961 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
962 frontend_package.response() = apdu;
966 Package scan_package(backend->m_session, frontend_package.origin());
967 backend->timestamp();
968 scan_package.copy_filter(frontend_package);
969 scan_package.request() = apdu_req;
971 frontend_package.response() = scan_package.response();
972 if (scan_package.session().is_closed())
974 frontend_package.session().close();
975 bc->remove_backend(backend);
978 bc->release_backend(backend);
982 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
986 void yf::SessionShared::Worker::operator() (void)
991 void yf::SessionShared::BackendClass::expire_class()
995 boost::mutex::scoped_lock lock(m_mutex_backend_class);
996 BackendInstanceList::iterator bit = m_backend_list.begin();
997 while (bit != m_backend_list.end())
999 time_t last_use = (*bit)->m_time_last_use;
1001 if ((*bit)->m_in_use)
1005 else if ((now >= last_use && now - last_use > m_backend_expiry_ttl)
1006 || (now < last_use))
1009 (*bit)->m_close_package->response() = odr.create_close(
1010 0, Z_Close_lackOfActivity, 0);
1011 (*bit)->m_close_package->session().close();
1012 (*bit)->m_close_package->move();
1014 bit = m_backend_list.erase(bit);
1023 void yf::SessionShared::Rep::expire()
1028 boost::xtime_get(&xt, boost::TIME_UTC);
1029 xt.sec += m_session_ttl / 3;
1030 boost::thread::sleep(xt);
1032 BackendClassMap::const_iterator b_it = m_backend_map.begin();
1033 for (; b_it != m_backend_map.end(); b_it++)
1034 b_it->second->expire_class();
1038 yf::SessionShared::Rep::Rep()
1040 m_resultset_ttl = 30;
1041 m_resultset_max = 10;
1043 m_optimize_search = true;
1046 void yf::SessionShared::Rep::start()
1048 yf::SessionShared::Worker w(this);
1049 m_thrds.add_thread(new boost::thread(w));
1052 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1056 yf::SessionShared::~SessionShared() {
1059 void yf::SessionShared::start() const
1064 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1068 yf::SessionShared::Frontend::~Frontend()
1072 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1074 boost::mutex::scoped_lock lock(m_mutex);
1076 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1080 it = m_clients.find(package.session());
1081 if (it == m_clients.end())
1084 if (!it->second->m_in_use)
1086 it->second->m_in_use = true;
1089 m_cond_session_ready.wait(lock);
1091 FrontendPtr f(new Frontend(this));
1092 m_clients[package.session()] = f;
1097 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1099 boost::mutex::scoped_lock lock(m_mutex);
1100 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1102 it = m_clients.find(package.session());
1103 if (it != m_clients.end())
1105 if (package.session().is_closed())
1107 m_clients.erase(it);
1111 it->second->m_in_use = false;
1113 m_cond_session_ready.notify_all();
1118 void yf::SessionShared::process(mp::Package &package) const
1120 FrontendPtr f = m_p->get_frontend(package);
1122 Z_GDU *gdu = package.request().get();
1124 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1125 Z_APDU_initRequest && !f->m_is_virtual)
1127 m_p->init(package, gdu, f);
1129 else if (!f->m_is_virtual)
1131 else if (gdu && gdu->which == Z_GDU_Z3950)
1133 Z_APDU *apdu = gdu->u.z3950;
1134 if (apdu->which == Z_APDU_initRequest)
1138 package.response() = odr.create_close(
1140 Z_Close_protocolError,
1143 package.session().close();
1145 else if (apdu->which == Z_APDU_close)
1149 package.response() = odr.create_close(
1151 Z_Close_peerAbort, "received close from client");
1152 package.session().close();
1154 else if (apdu->which == Z_APDU_searchRequest)
1156 f->search(package, apdu);
1158 else if (apdu->which == Z_APDU_presentRequest)
1160 f->present(package, apdu);
1162 else if (apdu->which == Z_APDU_scanRequest)
1164 f->scan(package, apdu);
1170 package.response() = odr.create_close(
1171 apdu, Z_Close_protocolError,
1172 "unsupported APDU in filter_session_shared");
1174 package.session().close();
1177 m_p->release_frontend(package);
1180 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1183 for (ptr = ptr->children; ptr; ptr = ptr->next)
1185 if (ptr->type != XML_ELEMENT_NODE)
1187 if (!strcmp((const char *) ptr->name, "resultset"))
1189 const struct _xmlAttr *attr;
1190 for (attr = ptr->properties; attr; attr = attr->next)
1192 if (!strcmp((const char *) attr->name, "ttl"))
1193 m_p->m_resultset_ttl =
1194 mp::xml::get_int(attr->children, 30);
1195 else if (!strcmp((const char *) attr->name, "max"))
1197 m_p->m_resultset_max =
1198 mp::xml::get_int(attr->children, 10);
1200 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1202 m_p->m_optimize_search =
1203 mp::xml::get_bool(attr->children, true);
1206 throw mp::filter::FilterException(
1207 "Bad attribute " + std::string((const char *)
1211 else if (!strcmp((const char *) ptr->name, "session"))
1213 const struct _xmlAttr *attr;
1214 for (attr = ptr->properties; attr; attr = attr->next)
1216 if (!strcmp((const char *) attr->name, "ttl"))
1217 m_p->m_session_ttl =
1218 mp::xml::get_int(attr->children, 120);
1220 throw mp::filter::FilterException(
1221 "Bad attribute " + std::string((const char *)
1227 throw mp::filter::FilterException("Bad element "
1228 + std::string((const char *)
1234 static mp::filter::Base* filter_creator()
1236 return new mp::filter::SessionShared;
1240 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1250 * c-file-style: "Stroustrup"
1251 * indent-tabs-mode: nil
1253 * vim: shiftwidth=4 tabstop=8 expandtab