1 /* This file is part of Metaproxy.
2 Copyright (C) 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"
34 #include <yaz/copy_types.h>
37 #include <yaz/otherinfo.h>
38 #include <yaz/diagbib1.h>
39 #include <yazpp/z-query.h>
40 #include <yazpp/record-cache.h>
46 namespace mp = metaproxy_1;
47 namespace yf = metaproxy_1::filter;
49 namespace metaproxy_1 {
52 // key for session.. We'll only share sessions with same InitKey
53 class SessionShared::InitKey {
55 bool operator < (const SessionShared::InitKey &k) const;
56 InitKey(Z_InitRequest *req);
57 InitKey(const InitKey &);
60 char *m_idAuthentication_buf;
61 int m_idAuthentication_size;
62 char *m_otherInfo_buf;
66 // worker thread .. for expiry of sessions
67 class SessionShared::Worker {
69 Worker(SessionShared::Rep *rep);
70 void operator() (void);
72 SessionShared::Rep *m_p;
75 class SessionShared::BackendSet {
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;
83 yazpp_1::RecordCache m_record_cache;
85 Z_OtherInformation *additionalSearchInfoRequest;
86 Z_OtherInformation *additionalSearchInfoResponse;
87 NMEM mem_additionalSearchInfo;
89 const std::string &result_set_id,
90 const Databases &databases,
91 const yazpp_1::Yaz_Z_Query &query,
92 Z_OtherInformation *additionalSearchInfoRequest);
95 Package &frontend_package,
96 Package &search_package,
97 const Z_APDU *apdu_req,
98 const BackendInstancePtr bp,
99 Z_Records **z_records);
101 // backend connection instance
102 class SessionShared::BackendInstance {
104 friend class BackendClass;
105 friend class BackendSet;
107 mp::Session m_session;
108 BackendSetList m_sets;
111 int m_result_set_sequence;
112 time_t m_time_last_use;
113 mp::Package * m_close_package;
117 // backends of some class (all with same InitKey)
118 class SessionShared::BackendClass : boost::noncopyable {
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;
133 time_t m_backend_set_ttl;
134 time_t m_backend_expiry_ttl;
135 size_t m_backend_set_max;
136 Odr_int m_preferredMessageSize;
137 Odr_int m_maximumRecordSize;
139 BackendClass(const yazpp_1::GDU &init_request,
143 Odr_int preferredRecordSize,
144 Odr_int maximumRecordSize);
147 // frontend result set
148 class SessionShared::FrontendSet {
149 Databases m_databases;
150 yazpp_1::Yaz_Z_Query m_query;
152 const Databases &get_databases();
153 const yazpp_1::Yaz_Z_Query &get_query();
155 const Databases &databases,
156 const yazpp_1::Yaz_Z_Query &query);
160 struct SessionShared::Frontend {
165 Z_Options m_init_options;
166 void search(Package &package, Z_APDU *apdu);
167 void present(Package &package, Z_APDU *apdu);
168 void scan(Package &package, Z_APDU *apdu);
170 int result_set_ref(ODR o,
171 const Databases &databases,
172 Z_RPNStructure *s, std::string &rset);
173 void get_set(mp::Package &package,
174 const Z_APDU *apdu_req,
175 const Databases &databases,
176 yazpp_1::Yaz_Z_Query &query,
177 BackendInstancePtr &found_backend,
178 BackendSetPtr &found_set);
179 void override_set(BackendInstancePtr &found_backend,
180 std::string &result_set_id,
181 const Databases &databases,
182 bool out_of_sessions);
185 BackendClassPtr m_backend_class;
186 FrontendSets m_frontend_sets;
189 class SessionShared::Rep {
190 friend class SessionShared;
191 friend struct Frontend;
193 FrontendPtr get_frontend(Package &package);
194 void release_frontend(Package &package);
200 void expire_classes();
202 void init(Package &package, const Z_GDU *gdu,
203 FrontendPtr frontend);
205 boost::mutex m_mutex;
206 boost::condition m_cond_session_ready;
207 boost::condition m_cond_expire_ready;
208 std::map<mp::Session, FrontendPtr> m_clients;
210 BackendClassMap m_backend_map;
211 boost::mutex m_mutex_backend_map;
212 boost::thread_group m_thrds;
216 bool m_optimize_search;
219 Odr_int m_preferredMessageSize;
220 Odr_int m_maximumRecordSize;
226 yf::SessionShared::FrontendSet::FrontendSet(
227 const Databases &databases,
228 const yazpp_1::Yaz_Z_Query &query)
229 : m_databases(databases), m_query(query)
233 const yf::SessionShared::Databases &
234 yf::SessionShared::FrontendSet::get_databases()
239 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
244 yf::SessionShared::InitKey::InitKey(const InitKey &k)
246 m_odr = odr_createmem(ODR_ENCODE);
248 m_idAuthentication_size = k.m_idAuthentication_size;
249 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
250 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
251 m_idAuthentication_size);
253 m_otherInfo_size = k.m_otherInfo_size;
254 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
255 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
259 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
261 m_odr = odr_createmem(ODR_ENCODE);
263 Z_IdAuthentication *t = req->idAuthentication;
264 z_IdAuthentication(m_odr, &t, 1, 0);
265 m_idAuthentication_buf =
266 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
268 Z_OtherInformation *o = req->otherInfo;
269 z_OtherInformation(m_odr, &o, 1, 0);
270 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
273 yf::SessionShared::InitKey::~InitKey()
278 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
282 c = mp::util::memcmp2(
283 (void*) m_idAuthentication_buf, m_idAuthentication_size,
284 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
290 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
291 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
299 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
301 boost::mutex::scoped_lock lock(m_mutex_backend_class);
306 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
309 boost::mutex::scoped_lock lock(m_mutex_backend_class);
310 BackendInstanceList::iterator it = m_backend_list.begin();
313 if (it == m_backend_list.end())
317 it = m_backend_list.erase(it);
324 b->m_close_package->response() = odr.create_close(
325 0, Z_Close_lackOfActivity, 0);
326 b->m_close_package->session().close();
327 b->m_close_package->move();
331 yf::SessionShared::BackendInstancePtr
332 yf::SessionShared::BackendClass::get_backend(
333 const mp::Package &frontend_package)
336 boost::mutex::scoped_lock lock(m_mutex_backend_class);
338 BackendInstanceList::const_iterator it = m_backend_list.begin();
340 BackendInstancePtr backend1; // null
342 for (; it != m_backend_list.end(); it++)
344 if (!(*it)->m_in_use)
347 || (*it)->m_sequence_this < backend1->m_sequence_this)
353 use_backend(backend1);
357 return create_backend(frontend_package);
360 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
362 backend->m_in_use = true;
363 backend->m_sequence_this = m_sequence_top++;
366 void yf::SessionShared::BackendInstance::timestamp()
369 time(&m_time_last_use);
372 yf::SessionShared::BackendInstance::~BackendInstance()
374 delete m_close_package;
377 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
378 const mp::Package &frontend_package)
380 BackendInstancePtr bp(new BackendInstance);
381 BackendInstancePtr null;
383 bp->m_close_package =
384 new mp::Package(bp->m_session, frontend_package.origin());
385 bp->m_close_package->copy_filter(frontend_package);
387 Package init_package(bp->m_session, frontend_package.origin());
389 init_package.copy_filter(frontend_package);
391 yazpp_1::GDU actual_init_request = m_init_request;
392 Z_GDU *init_pdu = actual_init_request.get();
394 assert(init_pdu->which == Z_GDU_Z3950);
395 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
397 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
398 ODR_MASK_ZERO(req->options);
400 ODR_MASK_SET(req->options, Z_Options_search);
401 ODR_MASK_SET(req->options, Z_Options_present);
402 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
403 ODR_MASK_SET(req->options, Z_Options_scan);
405 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
406 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
407 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
409 if (m_preferredMessageSize)
410 *req->preferredMessageSize = m_preferredMessageSize;
411 if (m_maximumRecordSize)
412 *req->maximumRecordSize = m_maximumRecordSize;
414 init_package.request() = init_pdu;
418 boost::mutex::scoped_lock lock(m_mutex_backend_class);
420 m_named_result_sets = false;
421 Z_GDU *gdu = init_package.response().get();
423 if (gdu && gdu->which == Z_GDU_Z3950
424 && gdu->u.z3950->which == Z_APDU_initResponse)
426 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
427 m_init_response = gdu->u.z3950;
428 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
430 m_named_result_sets = true;
432 if (*gdu->u.z3950->u.initResponse->result
433 && !init_package.session().is_closed())
436 time(&bp->m_time_last_use);
437 bp->m_sequence_this = 0;
438 bp->m_result_set_sequence = 0;
439 m_backend_list.push_back(bp);
445 yazpp_1::GDU empty_gdu;
446 m_init_response = empty_gdu;
449 if (!init_package.session().is_closed())
451 init_package.copy_filter(frontend_package);
452 init_package.session().close();
459 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
463 Odr_int preferredMessageSize,
464 Odr_int maximumRecordSize)
465 : m_named_result_sets(false), m_init_request(init_request),
466 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
467 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max),
468 m_preferredMessageSize(preferredMessageSize),
469 m_maximumRecordSize(maximumRecordSize)
472 yf::SessionShared::BackendClass::~BackendClass()
475 void yf::SessionShared::Rep::stat()
478 int no_instances = 0;
479 BackendClassMap::const_iterator it;
481 boost::mutex::scoped_lock lock(m_mutex_backend_map);
482 for (it = m_backend_map.begin(); it != m_backend_map.end(); it++)
484 BackendClassPtr bc = it->second;
486 BackendInstanceList::iterator bit = bc->m_backend_list.begin();
487 for (; bit != bc->m_backend_list.end(); bit++)
493 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
494 FrontendPtr frontend)
496 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
498 frontend->m_is_virtual = true;
499 frontend->m_init_options = *req->options;
502 boost::mutex::scoped_lock lock(m_mutex_backend_map);
503 BackendClassMap::const_iterator it;
504 it = m_backend_map.find(k);
505 if (it == m_backend_map.end())
507 BackendClassPtr b(new BackendClass(gdu->u.z3950,
511 m_preferredMessageSize,
512 m_maximumRecordSize));
513 m_backend_map[k] = b;
514 frontend->m_backend_class = b;
518 frontend->m_backend_class = it->second;
521 BackendClassPtr bc = frontend->m_backend_class;
524 // we only need to get init response from "first" target in
525 // backend class - the assumption being that init response is
527 if (bc->m_backend_list.size() == 0)
529 BackendInstancePtr backend = bc->create_backend(package);
531 bc->release_backend(backend);
534 yazpp_1::GDU init_response;
536 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
538 init_response = bc->m_init_response;
541 if (init_response.get())
543 Z_GDU *response_gdu = init_response.get();
544 mp::util::transfer_referenceId(odr, gdu->u.z3950,
545 response_gdu->u.z3950);
546 Z_InitResponse *init_res = response_gdu->u.z3950->u.initResponse;
547 Z_Options *server_options = init_res->options;
548 Z_Options *client_options = &frontend->m_init_options;
550 for (i = 0; i < 30; i++)
551 if (!ODR_MASK_GET(client_options, i))
552 ODR_MASK_CLEAR(server_options, i);
554 if (!m_preferredMessageSize ||
555 *init_res->preferredMessageSize > *req->preferredMessageSize)
556 *init_res->preferredMessageSize = *req->preferredMessageSize;
558 if (!m_maximumRecordSize ||
559 *init_res->maximumRecordSize > *req->maximumRecordSize)
560 *init_res->maximumRecordSize = *req->maximumRecordSize;
562 package.response() = init_response;
563 if (!*response_gdu->u.z3950->u.initResponse->result)
564 package.session().close();
569 odr.create_initResponse(
570 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
571 "session_shared: target closed connection during init");
572 *apdu->u.initResponse->result = 0;
573 package.response() = apdu;
574 package.session().close();
578 void yf::SessionShared::BackendSet::timestamp()
580 time(&m_time_last_use);
583 yf::SessionShared::BackendSet::BackendSet(
584 const std::string &result_set_id,
585 const Databases &databases,
586 const yazpp_1::Yaz_Z_Query &query,
587 Z_OtherInformation *additionalSearchInfo) :
588 m_result_set_id(result_set_id),
589 m_databases(databases), m_result_set_size(0), m_query(query)
592 mem_additionalSearchInfo = nmem_create();
593 additionalSearchInfoResponse = 0;
594 additionalSearchInfoRequest =
595 yaz_clone_z_OtherInformation(additionalSearchInfo,
596 mem_additionalSearchInfo);
599 yf::SessionShared::BackendSet::~BackendSet()
601 nmem_destroy(mem_additionalSearchInfo);
604 static int get_diagnostic(Z_DefaultDiagFormat *r)
606 return *r->condition;
609 bool yf::SessionShared::BackendSet::search(
610 mp::Package &frontend_package,
611 mp::Package &search_package,
612 const Z_APDU *frontend_apdu,
613 const BackendInstancePtr bp,
614 Z_Records **z_records)
617 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
618 Z_SearchRequest *req = apdu_req->u.searchRequest;
620 req->additionalSearchInfo = additionalSearchInfoRequest;
621 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
622 req->query = m_query.get_Z_Query();
624 req->num_databaseNames = m_databases.size();
625 req->databaseNames = (char**)
626 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
627 Databases::const_iterator it = m_databases.begin();
629 for (; it != m_databases.end(); it++)
630 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
632 if (frontend_apdu->which == Z_APDU_searchRequest)
633 req->preferredRecordSyntax =
634 frontend_apdu->u.searchRequest->preferredRecordSyntax;
636 search_package.request() = apdu_req;
638 search_package.move();
640 Z_GDU *gdu = search_package.response().get();
641 if (!search_package.session().is_closed()
642 && gdu && gdu->which == Z_GDU_Z3950
643 && gdu->u.z3950->which == Z_APDU_searchResponse)
645 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
646 *z_records = b_resp->records;
647 m_result_set_size = *b_resp->resultCount;
649 additionalSearchInfoResponse = yaz_clone_z_OtherInformation(
650 b_resp->additionalSearchInfo, mem_additionalSearchInfo);
654 const char *addinfo = "session_shared: "
655 "target closed connection during search";
656 if (frontend_apdu->which == Z_APDU_searchRequest)
657 f_apdu = odr.create_searchResponse(
658 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
659 else if (frontend_apdu->which == Z_APDU_presentRequest)
660 f_apdu = odr.create_presentResponse(
661 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
663 f_apdu = odr.create_close(
664 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
665 frontend_package.response() = f_apdu;
669 void yf::SessionShared::Frontend::override_set(
670 BackendInstancePtr &found_backend,
671 std::string &result_set_id,
672 const Databases &databases,
673 bool out_of_sessions)
675 BackendClassPtr bc = m_backend_class;
676 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
680 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
681 for (; it != bc->m_backend_list.end(); it++)
683 if (!(*it)->m_in_use)
685 BackendSetList::iterator set_it = (*it)->m_sets.begin();
686 for (; set_it != (*it)->m_sets.end(); set_it++)
688 if ((max_sets > 1 || (*set_it)->m_databases == databases)
691 now < (*set_it)->m_time_last_use ||
692 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
695 result_set_id = (*set_it)->m_result_set_id;
696 found_backend->m_sets.erase(set_it);
702 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
704 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
707 if (bc->m_named_result_sets)
709 result_set_id = boost::io::str(
710 boost::format("%1%") %
711 found_backend->m_result_set_sequence);
712 found_backend->m_result_set_sequence++;
715 result_set_id = "default";
721 void yf::SessionShared::Frontend::get_set(mp::Package &package,
722 const Z_APDU *apdu_req,
723 const Databases &databases,
724 yazpp_1::Yaz_Z_Query &query,
725 BackendInstancePtr &found_backend,
726 BackendSetPtr &found_set)
728 bool session_restarted = false;
729 Z_OtherInformation *additionalSearchInfo = 0;
731 if (apdu_req->which == Z_APDU_searchRequest)
732 additionalSearchInfo = apdu_req->u.searchRequest->additionalSearchInfo;
735 std::string result_set_id;
736 bool out_of_sessions = false;
737 BackendClassPtr bc = m_backend_class;
739 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
741 if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
742 out_of_sessions = true;
744 if (m_p->m_optimize_search)
746 // look at each backend and see if we have a similar search
747 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
748 for (; it != bc->m_backend_list.end(); it++)
750 if (!(*it)->m_in_use)
752 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
753 for (; set_it != (*it)->m_sets.end(); set_it++)
755 // for real present request we don't care
756 // if additionalSearchInfo matches: same records
757 if ((*set_it)->m_databases == databases
758 && query.match(&(*set_it)->m_query)
759 && (apdu_req->which != Z_APDU_searchRequest ||
760 yaz_compare_z_OtherInformation(
761 additionalSearchInfo,
762 (*set_it)->additionalSearchInfoRequest)))
766 bc->use_backend(found_backend);
767 // found matching set. No need to search again
774 override_set(found_backend, result_set_id, databases, out_of_sessions);
776 bc->use_backend(found_backend);
780 // create a new backend set (and new set) if we're not out of sessions
781 if (!out_of_sessions)
782 found_backend = bc->create_backend(package);
788 const char *addinfo = 0;
791 addinfo = "session_shared: all sessions in use";
793 addinfo = "session_shared: could not create backend";
794 if (apdu_req->which == Z_APDU_searchRequest)
796 f_apdu = odr.create_searchResponse(
797 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
799 else if (apdu_req->which == Z_APDU_presentRequest)
801 f_apdu = odr.create_presentResponse(
802 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
806 f_apdu = odr.create_close(
807 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
809 package.response() = f_apdu;
812 if (bc->m_named_result_sets)
814 result_set_id = boost::io::str(
815 boost::format("%1%") % found_backend->m_result_set_sequence);
816 found_backend->m_result_set_sequence++;
819 result_set_id = "default";
821 found_backend->timestamp();
823 // we must search ...
824 BackendSetPtr new_set(new BackendSet(result_set_id,
826 additionalSearchInfo));
827 Z_Records *z_records = 0;
829 Package search_package(found_backend->m_session, package.origin());
830 search_package.copy_filter(package);
832 if (!new_set->search(package, search_package,
833 apdu_req, found_backend, &z_records))
835 bc->remove_backend(found_backend);
836 return; // search error
842 if (z_records->which == Z_Records_NSD)
845 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
847 else if (z_records->which == Z_Records_multipleNSD)
849 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
852 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
853 Z_DiagRec_defaultFormat)
855 condition = get_diagnostic(
856 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
860 if (m_p->m_restart && !session_restarted &&
861 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
863 package.log("session_shared", YLOG_LOG, "restart");
864 bc->remove_backend(found_backend);
865 session_restarted = true;
866 found_backend.reset();
874 if (apdu_req->which == Z_APDU_searchRequest)
876 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
878 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
879 *f_resp->searchStatus = Z_SearchResponse_none;
880 f_resp->records = z_records;
881 package.response() = f_apdu;
883 if (apdu_req->which == Z_APDU_presentRequest)
885 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
887 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
888 f_resp->records = z_records;
889 package.response() = f_apdu;
891 bc->release_backend(found_backend);
892 return; // search error
895 if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
897 package.log("session_shared", YLOG_LOG, "restart");
898 bc->remove_backend(found_backend);
899 session_restarted = true;
900 found_backend.reset();
905 found_set->timestamp();
906 found_backend->m_sets.push_back(found_set);
909 int yf::SessionShared::Frontend::result_set_ref(ODR o,
910 const Databases &databases,
917 case Z_RPNStructure_simple:
918 if (s->u.simple->which == Z_Operand_resultSetId)
920 const char *id = s->u.simple->u.resultSetId;
923 FrontendSets::iterator fset_it = m_frontend_sets.find(id);
924 if (fset_it == m_frontend_sets.end())
926 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
928 else if (fset_it->second->get_databases() != databases)
930 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
934 yazpp_1::Yaz_Z_Query query = fset_it->second->get_query();
935 Z_Query *q = yaz_copy_Z_Query(query.get_Z_Query(), o);
936 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
938 s->which = q->u.type_1->RPNStructure->which;
939 s->u.simple = q->u.type_1->RPNStructure->u.simple;
943 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
948 case Z_RPNStructure_complex:
949 ret = result_set_ref(o, databases, s->u.complex->s1, rset);
951 ret = result_set_ref(o, databases, s->u.complex->s2, rset);
957 void yf::SessionShared::Frontend::search(mp::Package &package,
960 Z_SearchRequest *req = apdu_req->u.searchRequest;
961 FrontendSets::iterator fset_it =
962 m_frontend_sets.find(req->resultSetName);
963 if (fset_it != m_frontend_sets.end())
965 // result set already exist
966 // if replace indicator is off: we return diagnostic if
967 // result set already exist.
968 if (*req->replaceIndicator == 0)
972 odr.create_searchResponse(
974 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
976 package.response() = apdu;
979 m_frontend_sets.erase(fset_it);
984 for (i = 0; i < req->num_databaseNames; i++)
985 databases.push_back(req->databaseNames[i]);
988 yazpp_1::Yaz_Z_Query query;
989 query.set_Z_Query(req->query);
991 Z_Query *q = query.get_Z_Query();
992 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
996 int diag = result_set_ref(odr, databases, q->u.type_1->RPNStructure,
1001 odr.create_searchResponse(
1005 package.response() = apdu;
1008 query.set_Z_Query(q);
1011 BackendSetPtr found_set; // null
1012 BackendInstancePtr found_backend; // null
1014 get_set(package, apdu_req, databases, query, found_backend, found_set);
1019 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
1020 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
1021 *f_resp->resultCount = found_set->m_result_set_size;
1022 f_resp->additionalSearchInfo = found_set->additionalSearchInfoResponse;
1023 package.response() = f_apdu;
1025 FrontendSetPtr fset(new FrontendSet(databases, query));
1026 m_frontend_sets[req->resultSetName] = fset;
1028 m_backend_class->release_backend(found_backend);
1031 void yf::SessionShared::Frontend::present(mp::Package &package,
1035 Z_PresentRequest *req = apdu_req->u.presentRequest;
1037 FrontendSets::iterator fset_it =
1038 m_frontend_sets.find(req->resultSetId);
1040 if (fset_it == m_frontend_sets.end())
1043 odr.create_presentResponse(
1045 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1047 package.response() = apdu;
1050 FrontendSetPtr fset = fset_it->second;
1052 Databases databases = fset->get_databases();
1053 yazpp_1::Yaz_Z_Query query = fset->get_query();
1055 BackendClassPtr bc = m_backend_class;
1056 BackendSetPtr found_set; // null
1057 BackendInstancePtr found_backend;
1059 get_set(package, apdu_req, databases, query, found_backend, found_set);
1063 Z_NamePlusRecordList *npr_res = 0;
1064 // record_cache.lookup types are int's. Avoid non-fitting values
1065 if (*req->resultSetStartPoint > 0
1066 && *req->resultSetStartPoint < INT_MAX
1067 && *req->numberOfRecordsRequested > 0
1068 && *req->numberOfRecordsRequested < INT_MAX
1069 && found_set->m_record_cache.lookup(odr, &npr_res,
1070 *req->resultSetStartPoint,
1071 *req->numberOfRecordsRequested,
1072 req->preferredRecordSyntax,
1073 req->recordComposition))
1075 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1076 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1078 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1079 " records in cache %p",
1080 *req->resultSetStartPoint,
1081 *req->numberOfRecordsRequested,
1082 &found_set->m_record_cache);
1084 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
1085 *f_resp->nextResultSetPosition =
1086 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
1087 // f_resp->presentStatus assumed OK.
1088 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
1089 f_resp->records->which = Z_Records_DBOSD;
1090 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
1091 package.response() = f_apdu_res;
1092 bc->release_backend(found_backend);
1096 found_backend->timestamp();
1098 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
1099 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
1100 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1101 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
1102 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
1103 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
1104 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1105 p_req->recordComposition = req->recordComposition;
1107 Package present_package(found_backend->m_session, package.origin());
1108 present_package.copy_filter(package);
1110 present_package.request() = p_apdu;
1112 present_package.move();
1114 Z_GDU *gdu = present_package.response().get();
1115 if (!present_package.session().is_closed()
1116 && gdu && gdu->which == Z_GDU_Z3950
1117 && gdu->u.z3950->which == Z_APDU_presentResponse)
1119 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
1120 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1121 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1123 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
1124 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
1125 f_resp->presentStatus= b_resp->presentStatus;
1126 f_resp->records = b_resp->records;
1127 f_resp->otherInfo = b_resp->otherInfo;
1128 package.response() = f_apdu_res;
1130 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
1132 Z_NamePlusRecordList *npr =
1133 b_resp->records->u.databaseOrSurDiagnostics;
1134 // record_cache.add types are int's. Avoid non-fitting values
1135 if (*req->resultSetStartPoint > 0
1136 && npr->num_records + *req->resultSetStartPoint < INT_MAX)
1139 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1140 " records to cache %p",
1141 *req->resultSetStartPoint,
1142 *f_resp->numberOfRecordsReturned,
1143 &found_set->m_record_cache);
1145 found_set->m_record_cache.add(
1146 odr, npr, *req->resultSetStartPoint,
1147 p_req->recordComposition);
1150 bc->release_backend(found_backend);
1154 bc->remove_backend(found_backend);
1155 Z_APDU *f_apdu_res =
1156 odr.create_presentResponse(
1157 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1158 "session_shared: target closed connection during present");
1159 package.response() = f_apdu_res;
1163 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
1166 BackendClassPtr bc = m_backend_class;
1167 BackendInstancePtr backend = bc->get_backend(frontend_package);
1171 Z_APDU *apdu = odr.create_scanResponse(
1172 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1173 "session_shared: could not create backend");
1174 frontend_package.response() = apdu;
1178 Package scan_package(backend->m_session, frontend_package.origin());
1179 backend->timestamp();
1180 scan_package.copy_filter(frontend_package);
1181 scan_package.request() = apdu_req;
1182 scan_package.move();
1183 frontend_package.response() = scan_package.response();
1184 if (scan_package.session().is_closed())
1186 frontend_package.session().close();
1187 bc->remove_backend(backend);
1190 bc->release_backend(backend);
1194 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1198 void yf::SessionShared::Worker::operator() (void)
1203 bool yf::SessionShared::BackendClass::expire_instances()
1207 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1208 BackendInstanceList::iterator bit = m_backend_list.begin();
1209 while (bit != m_backend_list.end())
1211 time_t last_use = (*bit)->m_time_last_use;
1213 if ((*bit)->m_in_use)
1217 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1220 (*bit)->m_close_package->response() = odr.create_close(
1221 0, Z_Close_lackOfActivity, 0);
1222 (*bit)->m_close_package->session().close();
1223 (*bit)->m_close_package->move();
1225 bit = m_backend_list.erase(bit);
1232 if (m_backend_list.empty())
1237 void yf::SessionShared::Rep::expire_classes()
1239 boost::mutex::scoped_lock lock(m_mutex_backend_map);
1240 BackendClassMap::iterator b_it = m_backend_map.begin();
1241 while (b_it != m_backend_map.end())
1243 if (b_it->second->expire_instances())
1245 m_backend_map.erase(b_it);
1246 b_it = m_backend_map.begin();
1253 void yf::SessionShared::Rep::expire()
1258 boost::xtime_get(&xt,
1259 #if BOOST_VERSION >= 105000
1265 xt.sec += m_session_ttl / 3;
1267 boost::mutex::scoped_lock lock(m_mutex);
1268 m_cond_expire_ready.timed_wait(lock, xt);
1277 yf::SessionShared::Rep::Rep()
1279 m_resultset_ttl = 30;
1280 m_resultset_max = 10;
1282 m_optimize_search = true;
1284 m_session_max = 100;
1285 m_preferredMessageSize = 0;
1286 m_maximumRecordSize = 0;
1290 yf::SessionShared::Rep::~Rep()
1293 boost::mutex::scoped_lock lock(m_mutex);
1295 m_cond_expire_ready.notify_all();
1300 void yf::SessionShared::Rep::start()
1302 yf::SessionShared::Worker w(this);
1303 m_thrds.add_thread(new boost::thread(w));
1306 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1310 yf::SessionShared::~SessionShared() {
1313 void yf::SessionShared::start() const
1318 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1322 yf::SessionShared::Frontend::~Frontend()
1326 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1328 boost::mutex::scoped_lock lock(m_mutex);
1330 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1334 it = m_clients.find(package.session());
1335 if (it == m_clients.end())
1338 if (!it->second->m_in_use)
1340 it->second->m_in_use = true;
1343 m_cond_session_ready.wait(lock);
1345 FrontendPtr f(new Frontend(this));
1346 m_clients[package.session()] = f;
1351 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1353 boost::mutex::scoped_lock lock(m_mutex);
1354 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1356 it = m_clients.find(package.session());
1357 if (it != m_clients.end())
1359 if (package.session().is_closed())
1361 m_clients.erase(it);
1365 it->second->m_in_use = false;
1367 m_cond_session_ready.notify_all();
1372 void yf::SessionShared::process(mp::Package &package) const
1374 FrontendPtr f = m_p->get_frontend(package);
1376 Z_GDU *gdu = package.request().get();
1378 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1379 Z_APDU_initRequest && !f->m_is_virtual)
1381 m_p->init(package, gdu, f);
1383 else if (!f->m_is_virtual)
1385 else if (gdu && gdu->which == Z_GDU_Z3950)
1387 Z_APDU *apdu = gdu->u.z3950;
1388 if (apdu->which == Z_APDU_initRequest)
1392 package.response() = odr.create_close(
1394 Z_Close_protocolError,
1397 package.session().close();
1399 else if (apdu->which == Z_APDU_close)
1403 package.response() = odr.create_close(
1405 Z_Close_peerAbort, "received close from client");
1406 package.session().close();
1408 else if (apdu->which == Z_APDU_searchRequest)
1410 f->search(package, apdu);
1412 else if (apdu->which == Z_APDU_presentRequest)
1414 f->present(package, apdu);
1416 else if (apdu->which == Z_APDU_scanRequest)
1418 f->scan(package, apdu);
1424 package.response() = odr.create_close(
1425 apdu, Z_Close_protocolError,
1426 "unsupported APDU in filter_session_shared");
1428 package.session().close();
1431 m_p->release_frontend(package);
1434 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1437 for (ptr = ptr->children; ptr; ptr = ptr->next)
1439 if (ptr->type != XML_ELEMENT_NODE)
1441 if (!strcmp((const char *) ptr->name, "resultset"))
1443 const struct _xmlAttr *attr;
1444 for (attr = ptr->properties; attr; attr = attr->next)
1446 if (!strcmp((const char *) attr->name, "ttl"))
1447 m_p->m_resultset_ttl =
1448 mp::xml::get_int(attr->children, 30);
1449 else if (!strcmp((const char *) attr->name, "max"))
1451 m_p->m_resultset_max =
1452 mp::xml::get_int(attr->children, 10);
1454 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1456 m_p->m_optimize_search =
1457 mp::xml::get_bool(attr->children, true);
1459 else if (!strcmp((const char *) attr->name, "restart"))
1461 m_p->m_restart = mp::xml::get_bool(attr->children, true);
1464 throw mp::filter::FilterException(
1465 "Bad attribute " + std::string((const char *)
1469 else if (!strcmp((const char *) ptr->name, "session"))
1471 const struct _xmlAttr *attr;
1472 for (attr = ptr->properties; attr; attr = attr->next)
1474 if (!strcmp((const char *) attr->name, "ttl"))
1475 m_p->m_session_ttl =
1476 mp::xml::get_int(attr->children, 90);
1477 else if (!strcmp((const char *) attr->name, "max"))
1478 m_p->m_session_max =
1479 mp::xml::get_int(attr->children, 100);
1481 throw mp::filter::FilterException(
1482 "Bad attribute " + std::string((const char *)
1486 else if (!strcmp((const char *) ptr->name, "init"))
1488 const struct _xmlAttr *attr;
1489 for (attr = ptr->properties; attr; attr = attr->next)
1491 if (!strcmp((const char *) attr->name, "maximum-record-size"))
1492 m_p->m_maximumRecordSize =
1493 mp::xml::get_int(attr->children, 0);
1494 else if (!strcmp((const char *) attr->name,
1495 "preferred-message-size"))
1496 m_p->m_preferredMessageSize =
1497 mp::xml::get_int(attr->children, 0);
1499 throw mp::filter::FilterException(
1500 "Bad attribute " + std::string((const char *)
1506 throw mp::filter::FilterException("Bad element "
1507 + std::string((const char *)
1513 static mp::filter::Base* filter_creator()
1515 return new mp::filter::SessionShared;
1519 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1529 * c-file-style: "Stroustrup"
1530 * indent-tabs-mode: nil
1532 * vim: shiftwidth=4 tabstop=8 expandtab