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 const Z_APDU *apdu_req,
89 const BackendInstancePtr bp,
90 Z_Records **z_records);
92 // backend connection instance
93 class SessionShared::BackendInstance {
95 friend class BackendClass;
96 friend class BackendSet;
98 mp::Session m_session;
99 BackendSetList m_sets;
102 int m_result_set_sequence;
103 time_t m_time_last_use;
104 mp::Package * m_close_package;
107 // backends of some class (all with same InitKey)
108 class SessionShared::BackendClass : boost::noncopyable {
110 friend struct Frontend;
111 bool m_named_result_sets;
112 BackendInstanceList m_backend_list;
113 BackendInstancePtr create_backend(const Package &package);
114 void remove_backend(BackendInstancePtr b);
115 BackendInstancePtr get_backend(const Package &package);
116 void use_backend(BackendInstancePtr b);
117 void release_backend(BackendInstancePtr b);
119 yazpp_1::GDU m_init_request;
120 yazpp_1::GDU m_init_response;
121 boost::mutex m_mutex_backend_class;
123 time_t m_backend_set_ttl;
124 time_t m_backend_expiry_ttl;
125 size_t m_backend_set_max;
127 BackendClass(const yazpp_1::GDU &init_request,
133 // frontend result set
134 class SessionShared::FrontendSet {
135 Databases m_databases;
136 yazpp_1::Yaz_Z_Query m_query;
138 const Databases &get_databases();
139 const yazpp_1::Yaz_Z_Query &get_query();
141 const Databases &databases,
142 const yazpp_1::Yaz_Z_Query &query);
146 struct SessionShared::Frontend {
151 Z_Options m_init_options;
152 void search(Package &package, Z_APDU *apdu);
153 void present(Package &package, Z_APDU *apdu);
154 void scan(Package &package, Z_APDU *apdu);
156 void get_set(mp::Package &package,
157 const Z_APDU *apdu_req,
158 const Databases &databases,
159 yazpp_1::Yaz_Z_Query &query,
160 BackendInstancePtr &found_backend,
161 BackendSetPtr &found_set);
162 void override_set(BackendInstancePtr &found_backend,
163 std::string &result_set_id);
166 BackendClassPtr m_backend_class;
167 FrontendSets m_frontend_sets;
170 class SessionShared::Rep {
171 friend class SessionShared;
172 friend struct Frontend;
174 FrontendPtr get_frontend(Package &package);
175 void release_frontend(Package &package);
180 void init(Package &package, const Z_GDU *gdu,
181 FrontendPtr frontend);
183 boost::mutex m_mutex;
184 boost::condition m_cond_session_ready;
185 std::map<mp::Session, FrontendPtr> m_clients;
187 BackendClassMap m_backend_map;
188 boost::mutex m_mutex_backend_map;
189 boost::thread_group m_thrds;
193 bool m_optimize_search;
198 yf::SessionShared::FrontendSet::FrontendSet(
199 const Databases &databases,
200 const yazpp_1::Yaz_Z_Query &query)
201 : m_databases(databases), m_query(query)
205 const yf::SessionShared::Databases &
206 yf::SessionShared::FrontendSet::get_databases()
211 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
216 yf::SessionShared::InitKey::InitKey(const InitKey &k)
218 m_odr = odr_createmem(ODR_ENCODE);
220 m_idAuthentication_size = k.m_idAuthentication_size;
221 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
222 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
223 m_idAuthentication_size);
225 m_otherInfo_size = k.m_otherInfo_size;
226 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
227 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
231 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
233 m_odr = odr_createmem(ODR_ENCODE);
235 Z_IdAuthentication *t = req->idAuthentication;
236 z_IdAuthentication(m_odr, &t, 1, 0);
237 m_idAuthentication_buf =
238 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
240 Z_OtherInformation *o = req->otherInfo;
241 z_OtherInformation(m_odr, &o, 1, 0);
242 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
245 yf::SessionShared::InitKey::~InitKey()
250 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
254 c = mp::util::memcmp2(
255 (void*) m_idAuthentication_buf, m_idAuthentication_size,
256 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
262 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
263 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
271 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
273 boost::mutex::scoped_lock lock(m_mutex_backend_class);
278 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
280 BackendInstanceList::iterator it = m_backend_list.begin();
282 while (it != m_backend_list.end())
287 (*it)->m_close_package->response() = odr.create_close(
288 0, Z_Close_lackOfActivity, 0);
289 (*it)->m_close_package->session().close();
290 (*it)->m_close_package->move();
292 it = m_backend_list.erase(it);
301 yf::SessionShared::BackendInstancePtr
302 yf::SessionShared::BackendClass::get_backend(
303 const mp::Package &frontend_package)
306 boost::mutex::scoped_lock lock(m_mutex_backend_class);
308 BackendInstanceList::const_iterator it = m_backend_list.begin();
310 BackendInstancePtr backend1; // null
312 for (; it != m_backend_list.end(); it++)
314 if (!(*it)->m_in_use)
317 || (*it)->m_sequence_this < backend1->m_sequence_this)
323 use_backend(backend1);
327 return create_backend(frontend_package);
330 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
332 backend->m_in_use = true;
333 time(&backend->m_time_last_use);
334 backend->m_sequence_this = m_sequence_top++;
337 yf::SessionShared::BackendInstance::~BackendInstance()
339 delete m_close_package;
342 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
343 const mp::Package &frontend_package)
345 BackendInstancePtr bp(new BackendInstance);
346 BackendInstancePtr null;
348 bp->m_close_package =
349 new mp::Package(bp->m_session, frontend_package.origin());
350 bp->m_close_package->copy_filter(frontend_package);
352 Package init_package(bp->m_session, frontend_package.origin());
354 init_package.copy_filter(frontend_package);
356 yazpp_1::GDU actual_init_request = m_init_request;
357 Z_GDU *init_pdu = actual_init_request.get();
359 assert(init_pdu->which == Z_GDU_Z3950);
360 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
362 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
363 ODR_MASK_ZERO(req->options);
365 ODR_MASK_SET(req->options, Z_Options_search);
366 ODR_MASK_SET(req->options, Z_Options_present);
367 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
368 ODR_MASK_SET(req->options, Z_Options_scan);
370 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
371 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
372 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
374 init_package.request() = init_pdu;
378 boost::mutex::scoped_lock lock(m_mutex_backend_class);
380 m_named_result_sets = false;
381 Z_GDU *gdu = init_package.response().get();
382 if (init_package.session().is_closed())
384 /* already closed. We don't know why */
387 else if (gdu && gdu->which == Z_GDU_Z3950
388 && gdu->u.z3950->which == Z_APDU_initResponse
389 && *gdu->u.z3950->u.initResponse->result)
391 /* successful init response */
392 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
393 m_init_response = gdu->u.z3950;
394 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
396 m_named_result_sets = true;
401 /* not init or init rejected */
402 init_package.copy_filter(frontend_package);
403 init_package.session().close();
408 time(&bp->m_time_last_use);
409 bp->m_sequence_this = 0;
410 bp->m_result_set_sequence = 0;
411 m_backend_list.push_back(bp);
417 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
421 : m_named_result_sets(false), m_init_request(init_request),
422 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
423 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max)
426 yf::SessionShared::BackendClass::~BackendClass()
429 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
430 FrontendPtr frontend)
432 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
434 frontend->m_is_virtual = true;
435 frontend->m_init_options = *req->options;
438 boost::mutex::scoped_lock lock(m_mutex_backend_map);
439 BackendClassMap::const_iterator it;
440 it = m_backend_map.find(k);
441 if (it == m_backend_map.end())
443 BackendClassPtr b(new BackendClass(gdu->u.z3950,
447 m_backend_map[k] = b;
448 frontend->m_backend_class = b;
452 frontend->m_backend_class = it->second;
455 BackendClassPtr bc = frontend->m_backend_class;
456 BackendInstancePtr backend = bc->get_backend(package);
461 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
462 *apdu->u.initResponse->result = 0;
463 package.response() = apdu;
464 package.session().close();
468 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
469 yazpp_1::GDU init_response = bc->m_init_response;
470 Z_GDU *response_gdu = init_response.get();
471 mp::util::transfer_referenceId(odr, gdu->u.z3950,
472 response_gdu->u.z3950);
474 Z_Options *server_options =
475 response_gdu->u.z3950->u.initResponse->options;
476 Z_Options *client_options = &frontend->m_init_options;
479 for (i = 0; i<30; i++)
480 if (!ODR_MASK_GET(client_options, i))
481 ODR_MASK_CLEAR(server_options, i);
482 package.response() = init_response;
485 bc->release_backend(backend);
488 void yf::SessionShared::BackendSet::timestamp()
490 time(&m_time_last_use);
493 yf::SessionShared::BackendSet::BackendSet(
494 const std::string &result_set_id,
495 const Databases &databases,
496 const yazpp_1::Yaz_Z_Query &query) :
497 m_result_set_id(result_set_id),
498 m_databases(databases), m_result_set_size(0), m_query(query)
503 static int get_diagnostic(Z_DefaultDiagFormat *r)
505 return *r->condition;
508 bool yf::SessionShared::BackendSet::search(
509 mp::Package &frontend_package,
510 const Z_APDU *frontend_apdu,
511 const BackendInstancePtr bp,
512 Z_Records **z_records)
514 Package search_package(bp->m_session, frontend_package.origin());
516 search_package.copy_filter(frontend_package);
519 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
520 Z_SearchRequest *req = apdu_req->u.searchRequest;
522 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
523 req->query = m_query.get_Z_Query();
525 req->num_databaseNames = m_databases.size();
526 req->databaseNames = (char**)
527 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
528 Databases::const_iterator it = m_databases.begin();
530 for (; it != m_databases.end(); it++)
531 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
533 search_package.request() = apdu_req;
535 search_package.move();
537 Z_GDU *gdu = search_package.response().get();
538 if (!search_package.session().is_closed()
539 && gdu && gdu->which == Z_GDU_Z3950
540 && gdu->u.z3950->which == Z_APDU_searchResponse)
542 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
543 *z_records = b_resp->records;
544 m_result_set_size = *b_resp->resultCount;
548 if (frontend_apdu->which == Z_APDU_searchRequest)
549 f_apdu = odr.create_searchResponse(
550 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
551 else if (frontend_apdu->which == Z_APDU_presentRequest)
552 f_apdu = odr.create_presentResponse(
553 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
555 f_apdu = odr.create_close(
556 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
557 frontend_package.response() = f_apdu;
561 void yf::SessionShared::Frontend::override_set(
562 BackendInstancePtr &found_backend,
563 std::string &result_set_id)
565 BackendClassPtr bc = m_backend_class;
566 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
570 for (; it != bc->m_backend_list.end(); it++)
572 if (!(*it)->m_in_use)
574 BackendSetList::iterator set_it = (*it)->m_sets.begin();
575 for (; set_it != (*it)->m_sets.end(); set_it++)
577 if (now >= (*set_it)->m_time_last_use &&
578 now - (*set_it)->m_time_last_use > bc->m_backend_set_ttl)
581 result_set_id = (*set_it)->m_result_set_id;
582 found_backend->m_sets.erase(set_it);
588 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
589 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
591 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
594 if (bc->m_named_result_sets)
596 result_set_id = boost::io::str(
597 boost::format("%1%") %
598 found_backend->m_result_set_sequence);
599 found_backend->m_result_set_sequence++;
602 result_set_id = "default";
608 void yf::SessionShared::Frontend::get_set(mp::Package &package,
609 const Z_APDU *apdu_req,
610 const Databases &databases,
611 yazpp_1::Yaz_Z_Query &query,
612 BackendInstancePtr &found_backend,
613 BackendSetPtr &found_set)
615 bool session_restarted = false;
618 std::string result_set_id;
619 BackendClassPtr bc = m_backend_class;
621 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
623 if (m_p->m_optimize_search)
625 // look at each backend and see if we have a similar search
626 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
627 for (; it != bc->m_backend_list.end(); it++)
629 if (!(*it)->m_in_use)
631 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
632 for (; set_it != (*it)->m_sets.end(); set_it++)
634 if ((*set_it)->m_databases == databases
635 && query.match(&(*set_it)->m_query))
639 bc->use_backend(found_backend);
640 found_set->timestamp();
641 // found matching set. No need to search again
648 override_set(found_backend, result_set_id);
650 bc->use_backend(found_backend);
654 // create a new backend set (and new set)
655 found_backend = bc->create_backend(package);
661 if (apdu_req->which == Z_APDU_searchRequest)
663 f_apdu = odr.create_searchResponse(
664 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
666 else if (apdu_req->which == Z_APDU_presentRequest)
668 f_apdu = odr.create_presentResponse(
669 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
673 f_apdu = odr.create_close(
674 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
676 package.response() = f_apdu;
679 if (bc->m_named_result_sets)
681 result_set_id = boost::io::str(
682 boost::format("%1%") % found_backend->m_result_set_sequence);
683 found_backend->m_result_set_sequence++;
686 result_set_id = "default";
688 // we must search ...
689 BackendSetPtr new_set(new BackendSet(result_set_id,
691 Z_Records *z_records = 0;
692 if (!new_set->search(package, apdu_req, found_backend, &z_records))
694 bc->remove_backend(found_backend);
695 return; // search error
701 if (z_records->which == Z_Records_NSD)
704 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
706 else if (z_records->which == Z_Records_multipleNSD)
708 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
711 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
712 Z_DiagRec_defaultFormat)
714 condition = get_diagnostic(
715 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
719 if (!session_restarted &&
720 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
722 bc->remove_backend(found_backend);
723 session_restarted = true;
724 found_backend.reset();
732 if (apdu_req->which == Z_APDU_searchRequest)
734 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
736 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
737 *f_resp->searchStatus = Z_SearchResponse_none;
738 f_resp->records = z_records;
739 package.response() = f_apdu;
741 if (apdu_req->which == Z_APDU_presentRequest)
743 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
745 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
746 f_resp->records = z_records;
747 package.response() = f_apdu;
749 bc->release_backend(found_backend);
750 return; // search error
753 if (!session_restarted && new_set->m_result_set_size < 0)
755 bc->remove_backend(found_backend);
756 session_restarted = true;
757 found_backend.reset();
762 found_set->timestamp();
763 found_backend->m_sets.push_back(found_set);
766 void yf::SessionShared::Frontend::search(mp::Package &package,
769 Z_SearchRequest *req = apdu_req->u.searchRequest;
770 FrontendSets::iterator fset_it =
771 m_frontend_sets.find(req->resultSetName);
772 if (fset_it != m_frontend_sets.end())
774 // result set already exist
775 // if replace indicator is off: we return diagnostic if
776 // result set already exist.
777 if (*req->replaceIndicator == 0)
781 odr.create_searchResponse(
783 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
785 package.response() = apdu;
789 m_frontend_sets.erase(fset_it);
792 yazpp_1::Yaz_Z_Query query;
793 query.set_Z_Query(req->query);
796 for (i = 0; i<req->num_databaseNames; i++)
797 databases.push_back(req->databaseNames[i]);
799 BackendSetPtr found_set; // null
800 BackendInstancePtr found_backend; // null
802 get_set(package, apdu_req, databases, query, found_backend, found_set);
807 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
808 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
809 *f_resp->resultCount = found_set->m_result_set_size;
810 package.response() = f_apdu;
812 FrontendSetPtr fset(new FrontendSet(databases, query));
813 m_frontend_sets[req->resultSetName] = fset;
815 m_backend_class->release_backend(found_backend);
818 void yf::SessionShared::Frontend::present(mp::Package &package,
822 Z_PresentRequest *req = apdu_req->u.presentRequest;
824 FrontendSets::iterator fset_it =
825 m_frontend_sets.find(req->resultSetId);
827 if (fset_it == m_frontend_sets.end())
830 odr.create_presentResponse(
832 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
834 package.response() = apdu;
837 FrontendSetPtr fset = fset_it->second;
839 Databases databases = fset->get_databases();
840 yazpp_1::Yaz_Z_Query query = fset->get_query();
842 BackendClassPtr bc = m_backend_class;
843 BackendSetPtr found_set; // null
844 BackendInstancePtr found_backend;
846 get_set(package, apdu_req, databases, query, found_backend, found_set);
850 Z_NamePlusRecordList *npr_res = 0;
851 if (found_set->m_record_cache.lookup(odr, &npr_res,
852 *req->resultSetStartPoint,
853 *req->numberOfRecordsRequested,
854 req->preferredRecordSyntax,
855 req->recordComposition))
857 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
858 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
860 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
861 " records in cache %p",
862 *req->resultSetStartPoint,
863 *req->numberOfRecordsRequested,
864 &found_set->m_record_cache);
866 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
867 *f_resp->nextResultSetPosition =
868 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
869 // f_resp->presentStatus assumed OK.
870 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
871 f_resp->records->which = Z_Records_DBOSD;
872 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
873 package.response() = f_apdu_res;
874 bc->release_backend(found_backend);
878 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
879 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
880 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
881 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
882 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
883 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
884 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
885 p_req->recordComposition = req->recordComposition;
887 Package present_package(found_backend->m_session, package.origin());
888 present_package.copy_filter(package);
890 present_package.request() = p_apdu;
892 present_package.move();
894 Z_GDU *gdu = present_package.response().get();
895 if (!present_package.session().is_closed()
896 && gdu && gdu->which == Z_GDU_Z3950
897 && gdu->u.z3950->which == Z_APDU_presentResponse)
899 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
900 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
901 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
903 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
904 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
905 f_resp->presentStatus= b_resp->presentStatus;
906 f_resp->records = b_resp->records;
907 f_resp->otherInfo = b_resp->otherInfo;
908 package.response() = f_apdu_res;
910 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
912 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
913 " records to cache %p",
914 *req->resultSetStartPoint,
915 *f_resp->numberOfRecordsReturned,
916 &found_set->m_record_cache);
917 found_set->m_record_cache.add(
919 b_resp->records->u.databaseOrSurDiagnostics,
920 *req->resultSetStartPoint,
921 *f_resp->numberOfRecordsReturned);
923 bc->release_backend(found_backend);
927 bc->remove_backend(found_backend);
929 odr.create_presentResponse(
930 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
931 package.response() = f_apdu_res;
935 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
938 BackendClassPtr bc = m_backend_class;
939 BackendInstancePtr backend = bc->get_backend(frontend_package);
943 Z_APDU *apdu = odr.create_scanResponse(
944 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, 0);
945 frontend_package.response() = apdu;
949 Package scan_package(backend->m_session, frontend_package.origin());
950 scan_package.copy_filter(frontend_package);
951 scan_package.request() = apdu_req;
953 frontend_package.response() = scan_package.response();
954 if (scan_package.session().is_closed())
956 frontend_package.session().close();
957 bc->remove_backend(backend);
960 bc->release_backend(backend);
964 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
968 void yf::SessionShared::Worker::operator() (void)
973 void yf::SessionShared::BackendClass::expire_class()
977 boost::mutex::scoped_lock lock(m_mutex_backend_class);
978 BackendInstanceList::iterator bit = m_backend_list.begin();
979 while (bit != m_backend_list.end())
981 time_t last_use = (*bit)->m_time_last_use;
983 if ((*bit)->m_in_use)
987 else if ((now >= last_use && now - last_use > m_backend_expiry_ttl)
991 (*bit)->m_close_package->response() = odr.create_close(
992 0, Z_Close_lackOfActivity, 0);
993 (*bit)->m_close_package->session().close();
994 (*bit)->m_close_package->move();
996 bit = m_backend_list.erase(bit);
1005 void yf::SessionShared::Rep::expire()
1010 boost::xtime_get(&xt, boost::TIME_UTC);
1012 boost::thread::sleep(xt);
1014 BackendClassMap::const_iterator b_it = m_backend_map.begin();
1015 for (; b_it != m_backend_map.end(); b_it++)
1016 b_it->second->expire_class();
1020 yf::SessionShared::Rep::Rep()
1022 m_resultset_ttl = 30;
1023 m_resultset_max = 10;
1025 m_optimize_search = true;
1028 void yf::SessionShared::Rep::start()
1030 yf::SessionShared::Worker w(this);
1031 m_thrds.add_thread(new boost::thread(w));
1034 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1038 yf::SessionShared::~SessionShared() {
1041 void yf::SessionShared::start() const
1046 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1050 yf::SessionShared::Frontend::~Frontend()
1054 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1056 boost::mutex::scoped_lock lock(m_mutex);
1058 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1062 it = m_clients.find(package.session());
1063 if (it == m_clients.end())
1066 if (!it->second->m_in_use)
1068 it->second->m_in_use = true;
1071 m_cond_session_ready.wait(lock);
1073 FrontendPtr f(new Frontend(this));
1074 m_clients[package.session()] = f;
1079 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1081 boost::mutex::scoped_lock lock(m_mutex);
1082 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1084 it = m_clients.find(package.session());
1085 if (it != m_clients.end())
1087 if (package.session().is_closed())
1089 m_clients.erase(it);
1093 it->second->m_in_use = false;
1095 m_cond_session_ready.notify_all();
1100 void yf::SessionShared::process(mp::Package &package) const
1102 FrontendPtr f = m_p->get_frontend(package);
1104 Z_GDU *gdu = package.request().get();
1106 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1107 Z_APDU_initRequest && !f->m_is_virtual)
1109 m_p->init(package, gdu, f);
1111 else if (!f->m_is_virtual)
1113 else if (gdu && gdu->which == Z_GDU_Z3950)
1115 Z_APDU *apdu = gdu->u.z3950;
1116 if (apdu->which == Z_APDU_initRequest)
1120 package.response() = odr.create_close(
1122 Z_Close_protocolError,
1125 package.session().close();
1127 else if (apdu->which == Z_APDU_close)
1131 package.response() = odr.create_close(
1133 Z_Close_peerAbort, "received close from client");
1134 package.session().close();
1136 else if (apdu->which == Z_APDU_searchRequest)
1138 f->search(package, apdu);
1140 else if (apdu->which == Z_APDU_presentRequest)
1142 f->present(package, apdu);
1144 else if (apdu->which == Z_APDU_scanRequest)
1146 f->scan(package, apdu);
1152 package.response() = odr.create_close(
1153 apdu, Z_Close_protocolError,
1154 "unsupported APDU in filter_session_shared");
1156 package.session().close();
1159 m_p->release_frontend(package);
1162 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only)
1164 for (ptr = ptr->children; ptr; ptr = ptr->next)
1166 if (ptr->type != XML_ELEMENT_NODE)
1168 if (!strcmp((const char *) ptr->name, "resultset"))
1170 const struct _xmlAttr *attr;
1171 for (attr = ptr->properties; attr; attr = attr->next)
1173 if (!strcmp((const char *) attr->name, "ttl"))
1174 m_p->m_resultset_ttl =
1175 mp::xml::get_int(attr->children, 30);
1176 else if (!strcmp((const char *) attr->name, "max"))
1178 m_p->m_resultset_max =
1179 mp::xml::get_int(attr->children, 10);
1181 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1183 m_p->m_optimize_search =
1184 mp::xml::get_bool(attr->children, true);
1187 throw mp::filter::FilterException(
1188 "Bad attribute " + std::string((const char *)
1192 else if (!strcmp((const char *) ptr->name, "session"))
1194 const struct _xmlAttr *attr;
1195 for (attr = ptr->properties; attr; attr = attr->next)
1197 if (!strcmp((const char *) attr->name, "ttl"))
1198 m_p->m_session_ttl =
1199 mp::xml::get_int(attr->children, 120);
1201 throw mp::filter::FilterException(
1202 "Bad attribute " + std::string((const char *)
1208 throw mp::filter::FilterException("Bad element "
1209 + std::string((const char *)
1215 static mp::filter::Base* filter_creator()
1217 return new mp::filter::SessionShared;
1221 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1231 * c-file-style: "Stroustrup"
1232 * indent-tabs-mode: nil
1234 * vim: shiftwidth=4 tabstop=8 expandtab