1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2013 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 Odr_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,
167 bool out_of_sessions);
170 BackendClassPtr m_backend_class;
171 FrontendSets m_frontend_sets;
174 class SessionShared::Rep {
175 friend class SessionShared;
176 friend struct Frontend;
178 FrontendPtr get_frontend(Package &package);
179 void release_frontend(Package &package);
184 void init(Package &package, const Z_GDU *gdu,
185 FrontendPtr frontend);
187 boost::mutex m_mutex;
188 boost::condition m_cond_session_ready;
189 std::map<mp::Session, FrontendPtr> m_clients;
191 BackendClassMap m_backend_map;
192 boost::mutex m_mutex_backend_map;
193 boost::thread_group m_thrds;
197 bool m_optimize_search;
204 yf::SessionShared::FrontendSet::FrontendSet(
205 const Databases &databases,
206 const yazpp_1::Yaz_Z_Query &query)
207 : m_databases(databases), m_query(query)
211 const yf::SessionShared::Databases &
212 yf::SessionShared::FrontendSet::get_databases()
217 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
222 yf::SessionShared::InitKey::InitKey(const InitKey &k)
224 m_odr = odr_createmem(ODR_ENCODE);
226 m_idAuthentication_size = k.m_idAuthentication_size;
227 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
228 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
229 m_idAuthentication_size);
231 m_otherInfo_size = k.m_otherInfo_size;
232 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
233 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
237 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
239 m_odr = odr_createmem(ODR_ENCODE);
241 Z_IdAuthentication *t = req->idAuthentication;
242 z_IdAuthentication(m_odr, &t, 1, 0);
243 m_idAuthentication_buf =
244 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
246 Z_OtherInformation *o = req->otherInfo;
247 z_OtherInformation(m_odr, &o, 1, 0);
248 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
251 yf::SessionShared::InitKey::~InitKey()
256 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
260 c = mp::util::memcmp2(
261 (void*) m_idAuthentication_buf, m_idAuthentication_size,
262 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
268 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
269 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
277 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
279 boost::mutex::scoped_lock lock(m_mutex_backend_class);
284 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
286 BackendInstanceList::iterator it = m_backend_list.begin();
288 while (it != m_backend_list.end())
293 (*it)->m_close_package->response() = odr.create_close(
294 0, Z_Close_lackOfActivity, 0);
295 (*it)->m_close_package->session().close();
296 (*it)->m_close_package->move();
298 it = m_backend_list.erase(it);
307 yf::SessionShared::BackendInstancePtr
308 yf::SessionShared::BackendClass::get_backend(
309 const mp::Package &frontend_package)
312 boost::mutex::scoped_lock lock(m_mutex_backend_class);
314 BackendInstanceList::const_iterator it = m_backend_list.begin();
316 BackendInstancePtr backend1; // null
318 for (; it != m_backend_list.end(); it++)
320 if (!(*it)->m_in_use)
323 || (*it)->m_sequence_this < backend1->m_sequence_this)
329 use_backend(backend1);
333 return create_backend(frontend_package);
336 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
338 backend->m_in_use = true;
339 backend->m_sequence_this = m_sequence_top++;
342 void yf::SessionShared::BackendInstance::timestamp()
345 time(&m_time_last_use);
348 yf::SessionShared::BackendInstance::~BackendInstance()
350 delete m_close_package;
353 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
354 const mp::Package &frontend_package)
356 BackendInstancePtr bp(new BackendInstance);
357 BackendInstancePtr null;
359 bp->m_close_package =
360 new mp::Package(bp->m_session, frontend_package.origin());
361 bp->m_close_package->copy_filter(frontend_package);
363 Package init_package(bp->m_session, frontend_package.origin());
365 init_package.copy_filter(frontend_package);
367 yazpp_1::GDU actual_init_request = m_init_request;
368 Z_GDU *init_pdu = actual_init_request.get();
370 assert(init_pdu->which == Z_GDU_Z3950);
371 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
373 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
374 ODR_MASK_ZERO(req->options);
376 ODR_MASK_SET(req->options, Z_Options_search);
377 ODR_MASK_SET(req->options, Z_Options_present);
378 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
379 ODR_MASK_SET(req->options, Z_Options_scan);
381 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
382 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
383 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
385 init_package.request() = init_pdu;
389 boost::mutex::scoped_lock lock(m_mutex_backend_class);
391 m_named_result_sets = false;
392 Z_GDU *gdu = init_package.response().get();
394 if (gdu && gdu->which == Z_GDU_Z3950
395 && gdu->u.z3950->which == Z_APDU_initResponse)
397 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
398 m_init_response = gdu->u.z3950;
399 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
401 m_named_result_sets = true;
403 if (*gdu->u.z3950->u.initResponse->result
404 && !init_package.session().is_closed())
407 time(&bp->m_time_last_use);
408 bp->m_sequence_this = 0;
409 bp->m_result_set_sequence = 0;
410 m_backend_list.push_back(bp);
416 yazpp_1::GDU empty_gdu;
417 m_init_response = empty_gdu;
420 if (!init_package.session().is_closed())
422 init_package.copy_filter(frontend_package);
423 init_package.session().close();
430 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
434 : m_named_result_sets(false), m_init_request(init_request),
435 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
436 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max)
439 yf::SessionShared::BackendClass::~BackendClass()
442 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
443 FrontendPtr frontend)
445 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
447 frontend->m_is_virtual = true;
448 frontend->m_init_options = *req->options;
451 boost::mutex::scoped_lock lock(m_mutex_backend_map);
452 BackendClassMap::const_iterator it;
453 it = m_backend_map.find(k);
454 if (it == m_backend_map.end())
456 BackendClassPtr b(new BackendClass(gdu->u.z3950,
460 m_backend_map[k] = b;
461 frontend->m_backend_class = b;
465 frontend->m_backend_class = it->second;
468 BackendClassPtr bc = frontend->m_backend_class;
471 // we only need to get init response from "first" target in
472 // backend class - the assumption being that init response is
474 if (bc->m_backend_list.size() == 0)
476 BackendInstancePtr backend = bc->create_backend(package);
479 bc->release_backend(backend);
482 yazpp_1::GDU init_response;
484 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
486 init_response = bc->m_init_response;
489 if (init_response.get())
491 Z_GDU *response_gdu = init_response.get();
492 mp::util::transfer_referenceId(odr, gdu->u.z3950,
493 response_gdu->u.z3950);
494 Z_Options *server_options =
495 response_gdu->u.z3950->u.initResponse->options;
496 Z_Options *client_options = &frontend->m_init_options;
498 for (i = 0; i < 30; i++)
499 if (!ODR_MASK_GET(client_options, i))
500 ODR_MASK_CLEAR(server_options, i);
501 package.response() = init_response;
502 if (!*response_gdu->u.z3950->u.initResponse->result)
503 package.session().close();
508 odr.create_initResponse(
509 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
510 "session_shared: target closed connection during init");
511 *apdu->u.initResponse->result = 0;
512 package.response() = apdu;
513 package.session().close();
517 void yf::SessionShared::BackendSet::timestamp()
519 time(&m_time_last_use);
522 yf::SessionShared::BackendSet::BackendSet(
523 const std::string &result_set_id,
524 const Databases &databases,
525 const yazpp_1::Yaz_Z_Query &query) :
526 m_result_set_id(result_set_id),
527 m_databases(databases), m_result_set_size(0), m_query(query)
532 static int get_diagnostic(Z_DefaultDiagFormat *r)
534 return *r->condition;
537 bool yf::SessionShared::BackendSet::search(
538 mp::Package &frontend_package,
539 mp::Package &search_package,
540 const Z_APDU *frontend_apdu,
541 const BackendInstancePtr bp,
542 Z_Records **z_records)
545 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
546 Z_SearchRequest *req = apdu_req->u.searchRequest;
548 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
549 req->query = m_query.get_Z_Query();
551 req->num_databaseNames = m_databases.size();
552 req->databaseNames = (char**)
553 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
554 Databases::const_iterator it = m_databases.begin();
556 for (; it != m_databases.end(); it++)
557 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
559 if (frontend_apdu->which == Z_APDU_searchRequest)
560 req->preferredRecordSyntax =
561 frontend_apdu->u.searchRequest->preferredRecordSyntax;
563 search_package.request() = apdu_req;
565 search_package.move();
567 Z_GDU *gdu = search_package.response().get();
568 if (!search_package.session().is_closed()
569 && gdu && gdu->which == Z_GDU_Z3950
570 && gdu->u.z3950->which == Z_APDU_searchResponse)
572 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
573 *z_records = b_resp->records;
574 m_result_set_size = *b_resp->resultCount;
578 const char *addinfo = "session_shared: "
579 "target closed connection during search";
580 if (frontend_apdu->which == Z_APDU_searchRequest)
581 f_apdu = odr.create_searchResponse(
582 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
583 else if (frontend_apdu->which == Z_APDU_presentRequest)
584 f_apdu = odr.create_presentResponse(
585 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
587 f_apdu = odr.create_close(
588 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
589 frontend_package.response() = f_apdu;
593 void yf::SessionShared::Frontend::override_set(
594 BackendInstancePtr &found_backend,
595 std::string &result_set_id,
596 const Databases &databases,
597 bool out_of_sessions)
599 BackendClassPtr bc = m_backend_class;
600 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
604 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
605 for (; it != bc->m_backend_list.end(); it++)
607 if (!(*it)->m_in_use)
609 BackendSetList::iterator set_it = (*it)->m_sets.begin();
610 for (; set_it != (*it)->m_sets.end(); set_it++)
612 if ((max_sets > 1 || (*set_it)->m_databases == databases)
615 now < (*set_it)->m_time_last_use ||
616 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
619 result_set_id = (*set_it)->m_result_set_id;
620 found_backend->m_sets.erase(set_it);
626 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
628 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
631 if (bc->m_named_result_sets)
633 result_set_id = boost::io::str(
634 boost::format("%1%") %
635 found_backend->m_result_set_sequence);
636 found_backend->m_result_set_sequence++;
639 result_set_id = "default";
645 void yf::SessionShared::Frontend::get_set(mp::Package &package,
646 const Z_APDU *apdu_req,
647 const Databases &databases,
648 yazpp_1::Yaz_Z_Query &query,
649 BackendInstancePtr &found_backend,
650 BackendSetPtr &found_set)
652 bool session_restarted = false;
655 std::string result_set_id;
656 bool out_of_sessions = false;
657 BackendClassPtr bc = m_backend_class;
659 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
661 if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
662 out_of_sessions = true;
664 if (m_p->m_optimize_search)
666 // look at each backend and see if we have a similar search
667 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
668 for (; it != bc->m_backend_list.end(); it++)
670 if (!(*it)->m_in_use)
672 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
673 for (; set_it != (*it)->m_sets.end(); set_it++)
675 if ((*set_it)->m_databases == databases
676 && query.match(&(*set_it)->m_query))
680 bc->use_backend(found_backend);
681 // found matching set. No need to search again
688 override_set(found_backend, result_set_id, databases, out_of_sessions);
690 bc->use_backend(found_backend);
694 // create a new backend set (and new set) if we're not out of sessions
695 if (!out_of_sessions)
696 found_backend = bc->create_backend(package);
702 const char *addinfo = 0;
705 addinfo = "session_shared: all sessions in use";
707 addinfo = "session_shared: could not create backend";
708 if (apdu_req->which == Z_APDU_searchRequest)
710 f_apdu = odr.create_searchResponse(
711 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
713 else if (apdu_req->which == Z_APDU_presentRequest)
715 f_apdu = odr.create_presentResponse(
716 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
720 f_apdu = odr.create_close(
721 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
723 package.response() = f_apdu;
726 if (bc->m_named_result_sets)
728 result_set_id = boost::io::str(
729 boost::format("%1%") % found_backend->m_result_set_sequence);
730 found_backend->m_result_set_sequence++;
733 result_set_id = "default";
735 found_backend->timestamp();
737 // we must search ...
738 BackendSetPtr new_set(new BackendSet(result_set_id,
740 Z_Records *z_records = 0;
742 Package search_package(found_backend->m_session, package.origin());
743 search_package.copy_filter(package);
745 if (!new_set->search(package, search_package,
746 apdu_req, found_backend, &z_records))
748 bc->remove_backend(found_backend);
749 return; // search error
755 if (z_records->which == Z_Records_NSD)
758 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
760 else if (z_records->which == Z_Records_multipleNSD)
762 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
765 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
766 Z_DiagRec_defaultFormat)
768 condition = get_diagnostic(
769 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
773 if (m_p->m_restart && !session_restarted &&
774 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
776 package.log("session_shared", YLOG_LOG, "restart");
777 bc->remove_backend(found_backend);
778 session_restarted = true;
779 found_backend.reset();
787 if (apdu_req->which == Z_APDU_searchRequest)
789 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
791 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
792 *f_resp->searchStatus = Z_SearchResponse_none;
793 f_resp->records = z_records;
794 package.response() = f_apdu;
796 if (apdu_req->which == Z_APDU_presentRequest)
798 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
800 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
801 f_resp->records = z_records;
802 package.response() = f_apdu;
804 bc->release_backend(found_backend);
805 return; // search error
808 if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
810 package.log("session_shared", YLOG_LOG, "restart");
811 bc->remove_backend(found_backend);
812 session_restarted = true;
813 found_backend.reset();
818 found_set->timestamp();
819 found_backend->m_sets.push_back(found_set);
822 void yf::SessionShared::Frontend::search(mp::Package &package,
825 Z_SearchRequest *req = apdu_req->u.searchRequest;
826 FrontendSets::iterator fset_it =
827 m_frontend_sets.find(req->resultSetName);
828 if (fset_it != m_frontend_sets.end())
830 // result set already exist
831 // if replace indicator is off: we return diagnostic if
832 // result set already exist.
833 if (*req->replaceIndicator == 0)
837 odr.create_searchResponse(
839 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
841 package.response() = apdu;
845 m_frontend_sets.erase(fset_it);
848 yazpp_1::Yaz_Z_Query query;
849 query.set_Z_Query(req->query);
852 for (i = 0; i < req->num_databaseNames; i++)
853 databases.push_back(req->databaseNames[i]);
855 BackendSetPtr found_set; // null
856 BackendInstancePtr found_backend; // null
858 get_set(package, apdu_req, databases, query, found_backend, found_set);
863 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
864 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
865 *f_resp->resultCount = found_set->m_result_set_size;
866 package.response() = f_apdu;
868 FrontendSetPtr fset(new FrontendSet(databases, query));
869 m_frontend_sets[req->resultSetName] = fset;
871 m_backend_class->release_backend(found_backend);
874 void yf::SessionShared::Frontend::present(mp::Package &package,
878 Z_PresentRequest *req = apdu_req->u.presentRequest;
880 FrontendSets::iterator fset_it =
881 m_frontend_sets.find(req->resultSetId);
883 if (fset_it == m_frontend_sets.end())
886 odr.create_presentResponse(
888 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
890 package.response() = apdu;
893 FrontendSetPtr fset = fset_it->second;
895 Databases databases = fset->get_databases();
896 yazpp_1::Yaz_Z_Query query = fset->get_query();
898 BackendClassPtr bc = m_backend_class;
899 BackendSetPtr found_set; // null
900 BackendInstancePtr found_backend;
902 get_set(package, apdu_req, databases, query, found_backend, found_set);
906 Z_NamePlusRecordList *npr_res = 0;
907 if (found_set->m_record_cache.lookup(odr, &npr_res,
908 *req->resultSetStartPoint,
909 *req->numberOfRecordsRequested,
910 req->preferredRecordSyntax,
911 req->recordComposition))
913 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
914 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
916 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
917 " records in cache %p",
918 *req->resultSetStartPoint,
919 *req->numberOfRecordsRequested,
920 &found_set->m_record_cache);
922 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
923 *f_resp->nextResultSetPosition =
924 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
925 // f_resp->presentStatus assumed OK.
926 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
927 f_resp->records->which = Z_Records_DBOSD;
928 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
929 package.response() = f_apdu_res;
930 bc->release_backend(found_backend);
934 found_backend->timestamp();
936 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
937 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
938 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
939 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
940 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
941 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
942 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
943 p_req->recordComposition = req->recordComposition;
945 Package present_package(found_backend->m_session, package.origin());
946 present_package.copy_filter(package);
948 present_package.request() = p_apdu;
950 present_package.move();
952 Z_GDU *gdu = present_package.response().get();
953 if (!present_package.session().is_closed()
954 && gdu && gdu->which == Z_GDU_Z3950
955 && gdu->u.z3950->which == Z_APDU_presentResponse)
957 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
958 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
959 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
961 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
962 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
963 f_resp->presentStatus= b_resp->presentStatus;
964 f_resp->records = b_resp->records;
965 f_resp->otherInfo = b_resp->otherInfo;
966 package.response() = f_apdu_res;
968 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
970 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
971 " records to cache %p",
972 *req->resultSetStartPoint,
973 *f_resp->numberOfRecordsReturned,
974 &found_set->m_record_cache);
975 found_set->m_record_cache.add(
977 b_resp->records->u.databaseOrSurDiagnostics,
978 *req->resultSetStartPoint,
979 *f_resp->numberOfRecordsReturned);
981 bc->release_backend(found_backend);
985 bc->remove_backend(found_backend);
987 odr.create_presentResponse(
988 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
989 "session_shared: target closed connection during present");
990 package.response() = f_apdu_res;
994 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
997 BackendClassPtr bc = m_backend_class;
998 BackendInstancePtr backend = bc->get_backend(frontend_package);
1002 Z_APDU *apdu = odr.create_scanResponse(
1003 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1004 "session_shared: could not create backend");
1005 frontend_package.response() = apdu;
1009 Package scan_package(backend->m_session, frontend_package.origin());
1010 backend->timestamp();
1011 scan_package.copy_filter(frontend_package);
1012 scan_package.request() = apdu_req;
1013 scan_package.move();
1014 frontend_package.response() = scan_package.response();
1015 if (scan_package.session().is_closed())
1017 frontend_package.session().close();
1018 bc->remove_backend(backend);
1021 bc->release_backend(backend);
1025 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1029 void yf::SessionShared::Worker::operator() (void)
1034 void yf::SessionShared::BackendClass::expire_class()
1038 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1039 BackendInstanceList::iterator bit = m_backend_list.begin();
1040 while (bit != m_backend_list.end())
1042 time_t last_use = (*bit)->m_time_last_use;
1044 if ((*bit)->m_in_use)
1048 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1051 (*bit)->m_close_package->response() = odr.create_close(
1052 0, Z_Close_lackOfActivity, 0);
1053 (*bit)->m_close_package->session().close();
1054 (*bit)->m_close_package->move();
1056 bit = m_backend_list.erase(bit);
1065 void yf::SessionShared::Rep::expire()
1070 boost::xtime_get(&xt,
1071 #if BOOST_VERSION >= 105000
1077 xt.sec += m_session_ttl / 3;
1078 boost::thread::sleep(xt);
1080 BackendClassMap::const_iterator b_it = m_backend_map.begin();
1081 for (; b_it != m_backend_map.end(); b_it++)
1082 b_it->second->expire_class();
1086 yf::SessionShared::Rep::Rep()
1088 m_resultset_ttl = 30;
1089 m_resultset_max = 10;
1091 m_optimize_search = true;
1093 m_session_max = 100;
1096 void yf::SessionShared::Rep::start()
1098 yf::SessionShared::Worker w(this);
1099 m_thrds.add_thread(new boost::thread(w));
1102 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1106 yf::SessionShared::~SessionShared() {
1109 void yf::SessionShared::start() const
1114 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1118 yf::SessionShared::Frontend::~Frontend()
1122 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1124 boost::mutex::scoped_lock lock(m_mutex);
1126 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1130 it = m_clients.find(package.session());
1131 if (it == m_clients.end())
1134 if (!it->second->m_in_use)
1136 it->second->m_in_use = true;
1139 m_cond_session_ready.wait(lock);
1141 FrontendPtr f(new Frontend(this));
1142 m_clients[package.session()] = f;
1147 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1149 boost::mutex::scoped_lock lock(m_mutex);
1150 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1152 it = m_clients.find(package.session());
1153 if (it != m_clients.end())
1155 if (package.session().is_closed())
1157 m_clients.erase(it);
1161 it->second->m_in_use = false;
1163 m_cond_session_ready.notify_all();
1168 void yf::SessionShared::process(mp::Package &package) const
1170 FrontendPtr f = m_p->get_frontend(package);
1172 Z_GDU *gdu = package.request().get();
1174 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1175 Z_APDU_initRequest && !f->m_is_virtual)
1177 m_p->init(package, gdu, f);
1179 else if (!f->m_is_virtual)
1181 else if (gdu && gdu->which == Z_GDU_Z3950)
1183 Z_APDU *apdu = gdu->u.z3950;
1184 if (apdu->which == Z_APDU_initRequest)
1188 package.response() = odr.create_close(
1190 Z_Close_protocolError,
1193 package.session().close();
1195 else if (apdu->which == Z_APDU_close)
1199 package.response() = odr.create_close(
1201 Z_Close_peerAbort, "received close from client");
1202 package.session().close();
1204 else if (apdu->which == Z_APDU_searchRequest)
1206 f->search(package, apdu);
1208 else if (apdu->which == Z_APDU_presentRequest)
1210 f->present(package, apdu);
1212 else if (apdu->which == Z_APDU_scanRequest)
1214 f->scan(package, apdu);
1220 package.response() = odr.create_close(
1221 apdu, Z_Close_protocolError,
1222 "unsupported APDU in filter_session_shared");
1224 package.session().close();
1227 m_p->release_frontend(package);
1230 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1233 for (ptr = ptr->children; ptr; ptr = ptr->next)
1235 if (ptr->type != XML_ELEMENT_NODE)
1237 if (!strcmp((const char *) ptr->name, "resultset"))
1239 const struct _xmlAttr *attr;
1240 for (attr = ptr->properties; attr; attr = attr->next)
1242 if (!strcmp((const char *) attr->name, "ttl"))
1243 m_p->m_resultset_ttl =
1244 mp::xml::get_int(attr->children, 30);
1245 else if (!strcmp((const char *) attr->name, "max"))
1247 m_p->m_resultset_max =
1248 mp::xml::get_int(attr->children, 10);
1250 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1252 m_p->m_optimize_search =
1253 mp::xml::get_bool(attr->children, true);
1255 else if (!strcmp((const char *) attr->name, "restart"))
1257 m_p->m_restart = mp::xml::get_bool(attr->children, true);
1260 throw mp::filter::FilterException(
1261 "Bad attribute " + std::string((const char *)
1265 else if (!strcmp((const char *) ptr->name, "session"))
1267 const struct _xmlAttr *attr;
1268 for (attr = ptr->properties; attr; attr = attr->next)
1270 if (!strcmp((const char *) attr->name, "ttl"))
1271 m_p->m_session_ttl =
1272 mp::xml::get_int(attr->children, 90);
1273 else if (!strcmp((const char *) attr->name, "max"))
1274 m_p->m_session_max =
1275 mp::xml::get_int(attr->children, 100);
1277 throw mp::filter::FilterException(
1278 "Bad attribute " + std::string((const char *)
1284 throw mp::filter::FilterException("Bad element "
1285 + std::string((const char *)
1291 static mp::filter::Base* filter_creator()
1293 return new mp::filter::SessionShared;
1297 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1307 * c-file-style: "Stroustrup"
1308 * indent-tabs-mode: nil
1310 * vim: shiftwidth=4 tabstop=8 expandtab