1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <metaproxy/filter.hpp>
24 #include <metaproxy/package.hpp>
26 #include <boost/thread/thread.hpp>
27 #include <boost/thread/mutex.hpp>
28 #include <boost/thread/condition.hpp>
29 #include <boost/shared_ptr.hpp>
31 #include <metaproxy/util.hpp>
32 #include "filter_multi.hpp"
35 #include <yaz/otherinfo.h>
36 #include <yaz/diagbib1.h>
37 #include <yaz/match_glob.h>
44 namespace mp = metaproxy_1;
45 namespace yf = mp::filter;
47 namespace metaproxy_1 {
49 enum multi_merge_type {
53 struct Multi::BackendSet {
56 bool operator < (const BackendSet &k) const;
57 bool operator == (const BackendSet &k) const;
59 struct Multi::ScanTermInfo {
60 std::string m_norm_term;
61 std::string m_display_term;
63 bool operator < (const ScanTermInfo &) const;
64 bool operator == (const ScanTermInfo &) const;
65 Z_Entry *get_entry(ODR odr);
67 struct Multi::FrontendSet {
71 int m_pos; // position for backend (1=first, 2=second,..
72 int m_start; // present request start
73 PresentJob(BackendPtr ptr, int pos) :
74 m_backend(ptr), m_pos(pos), m_start(0) {};
76 FrontendSet(std::string setname);
80 void round_robin(int pos, int number, std::list<PresentJob> &job);
81 void serve_order(int pos, int number, std::list<PresentJob> &job);
83 std::list<BackendSet> m_backend_sets;
84 std::string m_setname;
86 struct Multi::Backend {
88 std::string m_backend_database;
92 void operator() (void); // thread operation
94 struct Multi::Frontend {
99 std::list<BackendPtr> m_backend_list;
100 std::map<std::string,Multi::FrontendSet> m_sets;
102 void multi_move(std::list<BackendPtr> &blist);
103 void init(Package &package, Z_GDU *gdu);
104 void close(Package &package);
105 void search(Package &package, Z_APDU *apdu);
106 void present(Package &package, Z_APDU *apdu);
107 void scan1(Package &package, Z_APDU *apdu);
108 void scan2(Package &package, Z_APDU *apdu);
109 void relay_apdu(Package &package, Z_APDU *apdu);
113 std::string m_target_pattern;
117 Map(std::string pattern, std::string route, std::string auth) :
118 m_target_pattern(pattern), m_route(route), m_auth(auth) {};
119 bool match(const std::string target, std::string *ret,
120 std::string *auth) const {
121 if (yaz_match_glob(m_target_pattern.c_str(), target.c_str()))
132 friend struct Frontend;
135 FrontendPtr get_frontend(Package &package);
136 void release_frontend(Package &package);
138 std::list<Multi::Map> m_route_patterns;
139 boost::mutex m_mutex;
140 boost::condition m_cond_session_ready;
141 std::map<mp::Session, FrontendPtr> m_clients;
142 bool m_hide_unavailable;
144 multi_merge_type m_merge_type;
149 yf::Multi::Rep::Rep()
151 m_hide_unavailable = false;
152 m_hide_errors = false;
153 m_merge_type = round_robin;
156 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
158 return m_count < k.m_count;
161 yf::Multi::Frontend::Frontend(Rep *rep)
167 yf::Multi::Frontend::~Frontend()
171 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
173 boost::mutex::scoped_lock lock(m_mutex);
175 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
179 it = m_clients.find(package.session());
180 if (it == m_clients.end())
183 if (!it->second->m_in_use)
185 it->second->m_in_use = true;
188 m_cond_session_ready.wait(lock);
190 FrontendPtr f(new Frontend(this));
191 m_clients[package.session()] = f;
196 void yf::Multi::Rep::release_frontend(mp::Package &package)
198 boost::mutex::scoped_lock lock(m_mutex);
199 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
201 it = m_clients.find(package.session());
202 if (it != m_clients.end())
204 if (package.session().is_closed())
206 it->second->close(package);
211 it->second->m_in_use = false;
213 m_cond_session_ready.notify_all();
217 yf::Multi::FrontendSet::FrontendSet(std::string setname)
223 yf::Multi::FrontendSet::FrontendSet()
228 yf::Multi::FrontendSet::~FrontendSet()
232 yf::Multi::Multi() : m_p(new Multi::Rep)
236 yf::Multi::~Multi() {
240 void yf::Multi::Backend::operator() (void)
242 m_package->move(m_route);
246 void yf::Multi::Frontend::close(mp::Package &package)
248 std::list<BackendPtr>::const_iterator bit;
249 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
253 b->m_package->copy_filter(package);
254 b->m_package->request() = (Z_GDU *) 0;
255 b->m_package->session().close();
256 b->m_package->move(b->m_route);
260 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
262 std::list<BackendPtr>::const_iterator bit;
263 boost::thread_group g;
264 for (bit = blist.begin(); bit != blist.end(); bit++)
266 g.add_thread(new boost::thread(**bit));
271 void yf::Multi::FrontendSet::serve_order(int start, int number,
272 std::list<PresentJob> &jobs)
275 for (i = 0; i < number; i++)
277 std::list<BackendSet>::const_iterator bsit;
279 int offset = start + i - 1;
280 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
283 if (offset >= voffset && offset < voffset + bsit->m_count)
285 PresentJob job(bsit->m_backend, offset - voffset + 1);
289 voffset += bsit->m_count;
294 void yf::Multi::FrontendSet::round_robin(int start, int number,
295 std::list<PresentJob> &jobs)
298 std::list<BackendSet>::const_iterator bsit;
299 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
306 // optimization step!
312 // find min count for each set which is > omin
313 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
315 if (bsit->m_count > omin)
317 if (no_left == 0 || bsit->m_count < min)
322 if (no_left == 0) // if nothing greater than omin, bail out.
324 int skip = no_left * min;
325 if (p + skip > start) // step gets us "into" present range?
327 // Yes. skip until start.. Rounding off is deliberate!
328 min = (start-p) / no_left;
331 // update positions in each set..
332 std::list<int>::iterator psit = pos.begin();
333 for (psit = pos.begin(); psit != pos.end(); psit++)
337 // skip on each set.. before "present range"..
340 std::list<int>::iterator psit = pos.begin();
341 for (psit = pos.begin(); psit != pos.end(); psit++)
344 omin = min; // update so we consider next class (with higher count)
352 std::list<int>::iterator psit = pos.begin();
353 bsit = m_backend_sets.begin();
355 for (; bsit != m_backend_sets.end(); psit++,bsit++)
357 if (fetched >= number)
362 if (*psit <= bsit->m_count)
366 PresentJob job(bsit->m_backend, *psit);
378 void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
380 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
382 std::list<std::string> targets;
384 mp::util::get_vhost_otherinfo(req->otherInfo, targets);
386 if (targets.size() < 1)
392 std::list<std::string>::const_iterator t_it = targets.begin();
393 for (; t_it != targets.end(); t_it++)
396 Backend *b = new Backend;
399 std::list<Multi::Map>::const_iterator it =
400 m_p->m_route_patterns.begin();
401 while (it != m_p->m_route_patterns.end()) {
402 if (it->match(*t_it, &b->m_route, &b->m_auth))
406 // b->m_route = m_p->m_target_route[*t_it];
408 b->m_package = PackagePtr(new Package(s, package.origin()));
410 m_backend_list.push_back(BackendPtr(b));
414 // create init request
415 std::list<BackendPtr>::iterator bit;
416 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
420 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
422 std::list<std::string>vhost_one;
423 vhost_one.push_back(b->m_vhost);
424 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
428 Z_InitRequest *breq = init_apdu->u.initRequest;
430 if (b->m_auth.length())
432 breq->idAuthentication =
433 (Z_IdAuthentication *)
434 odr_malloc(odr, sizeof(*breq->idAuthentication));
435 breq->idAuthentication->which = Z_IdAuthentication_open;
436 breq->idAuthentication->u.open = odr_strdup(odr, b->m_auth.c_str());
439 breq->idAuthentication = req->idAuthentication;
441 *breq->preferredMessageSize = *req->preferredMessageSize;
442 *breq->maximumRecordSize = *req->maximumRecordSize;
444 ODR_MASK_SET(breq->options, Z_Options_search);
445 ODR_MASK_SET(breq->options, Z_Options_present);
446 ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
447 ODR_MASK_SET(breq->options, Z_Options_scan);
449 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
450 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
451 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
453 b->m_package->request() = init_apdu;
455 b->m_package->copy_filter(package);
457 multi_move(m_backend_list);
459 // create the frontend init response based on each backend init response
462 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
463 Z_InitResponse *f_resp = f_apdu->u.initResponse;
465 ODR_MASK_SET(f_resp->options, Z_Options_search);
466 ODR_MASK_SET(f_resp->options, Z_Options_present);
467 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
468 ODR_MASK_SET(f_resp->options, Z_Options_scan);
470 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
471 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
472 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
475 int no_succeeded = 0;
477 Odr_int preferredMessageSize = *req->preferredMessageSize;
478 Odr_int maximumRecordSize = *req->maximumRecordSize;
479 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
481 PackagePtr p = (*bit)->m_package;
483 if (p->session().is_closed())
485 // failed. Remove from list and increment number of failed
487 bit = m_backend_list.erase(bit);
490 Z_GDU *gdu = p->response().get();
491 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
495 Z_APDU *b_apdu = gdu->u.z3950;
496 Z_InitResponse *b_resp = b_apdu->u.initResponse;
498 // common options for all backends
499 for (i = 0; i <= Z_Options_stringSchema; i++)
501 if (!ODR_MASK_GET(b_resp->options, i))
502 ODR_MASK_CLEAR(f_resp->options, i);
504 // common protocol version
505 for (i = 0; i <= Z_ProtocolVersion_3; i++)
506 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
507 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
511 if (preferredMessageSize > *b_resp->preferredMessageSize)
512 preferredMessageSize = *b_resp->preferredMessageSize;
513 if (maximumRecordSize > *b_resp->maximumRecordSize)
514 maximumRecordSize = *b_resp->maximumRecordSize;
518 if (!f_resp->userInformationField
519 && b_resp->userInformationField)
520 f_resp->userInformationField = b_resp->userInformationField;
528 *f_resp->preferredMessageSize = preferredMessageSize;
529 *f_resp->maximumRecordSize = maximumRecordSize;
531 if (m_p->m_hide_unavailable)
533 if (no_succeeded == 0)
536 package.session().close();
544 package.session().close();
547 package.response() = f_apdu;
550 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
552 // create search request
553 Z_SearchRequest *req = apdu_req->u.searchRequest;
555 // save these for later
556 Odr_int smallSetUpperBound = *req->smallSetUpperBound;
557 Odr_int largeSetLowerBound = *req->largeSetLowerBound;
558 Odr_int mediumSetPresentNumber = *req->mediumSetPresentNumber;
560 // they are altered now - to disable piggyback
561 *req->smallSetUpperBound = 0;
562 *req->largeSetLowerBound = 1;
563 *req->mediumSetPresentNumber = 0;
565 int default_num_db = req->num_databaseNames;
566 char **default_db = req->databaseNames;
568 std::list<BackendPtr>::const_iterator bit;
569 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
571 PackagePtr p = (*bit)->m_package;
574 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
575 &req->num_databaseNames,
576 &req->databaseNames))
578 req->num_databaseNames = default_num_db;
579 req->databaseNames = default_db;
581 p->request() = apdu_req;
582 p->copy_filter(package);
584 multi_move(m_backend_list);
586 // look at each response
587 FrontendSet resultSet(std::string(req->resultSetName));
590 Odr_int result_set_size = 0;
591 Z_DiagRecs *z_diag = 0;
592 int no_successful = 0;
595 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
597 PackagePtr p = (*bit)->m_package;
599 // save closing package for at least one target
600 if (p->session().is_closed())
603 Z_GDU *gdu = p->response().get();
604 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
605 Z_APDU_searchResponse)
607 Z_APDU *b_apdu = gdu->u.z3950;
608 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
610 // see we get any errors (AKA diagnstics)
613 if (b_resp->records->which == Z_Records_NSD)
617 z_diag = (Z_DiagRecs *)
618 odr_malloc(odr, sizeof(*z_diag));
619 z_diag->num_diagRecs = 0;
620 z_diag->diagRecs = (Z_DiagRec**)
621 odr_malloc(odr, sizeof(*z_diag->diagRecs));
625 Z_DiagRec **n = (Z_DiagRec **)
627 (1+z_diag->num_diagRecs) * sizeof(*n));
628 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
630 z_diag->diagRecs = n;
632 Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
633 nr->which = Z_DiagRec_defaultFormat;
634 nr->u.defaultFormat =
635 b_resp->records->u.nonSurrogateDiagnostic;
636 z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
638 else if (b_resp->records->which == Z_Records_multipleNSD)
640 // we may set this multiple times (TOO BAD!)
641 z_diag = b_resp->records->u.multipleNonSurDiagnostics;
644 no_successful++; // probably piggyback
647 no_successful++; // no records and no diagnostics
648 BackendSet backendSet;
649 backendSet.m_backend = *bit;
650 backendSet.m_count = *b_resp->resultCount;
651 result_set_size += *b_resp->resultCount;
652 resultSet.m_backend_sets.push_back(backendSet);
656 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
657 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
659 yaz_log(YLOG_LOG, "no_successful=%d is_closed=%s hide_errors=%s",
661 close_p ? "true" : "false",
662 m_p->m_hide_errors ? "true" : "false");
663 *f_resp->resultCount = result_set_size;
664 if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
666 package.session().close();
667 package.response() = close_p->response();
670 if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
672 f_resp->records = (Z_Records *)
673 odr_malloc(odr, sizeof(*f_resp->records));
674 if (z_diag->num_diagRecs > 1)
676 f_resp->records->which = Z_Records_multipleNSD;
677 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
681 f_resp->records->which = Z_Records_NSD;
682 f_resp->records->u.nonSurrogateDiagnostic =
683 z_diag->diagRecs[0]->u.defaultFormat;
687 m_sets[resultSet.m_setname] = resultSet;
690 mp::util::piggyback(smallSetUpperBound,
692 mediumSetPresentNumber,
696 Package pp(package.session(), package.origin());
697 if (z_diag == 0 && number > 0)
699 pp.copy_filter(package);
700 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
701 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
702 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
703 p_req->resultSetId = req->resultSetName;
704 *p_req->resultSetStartPoint = 1;
705 *p_req->numberOfRecordsRequested = number;
706 pp.request() = p_apdu;
709 if (pp.session().is_closed())
710 package.session().close();
712 Z_GDU *gdu = pp.response().get();
713 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
714 Z_APDU_presentResponse)
716 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
717 f_resp->records = p_res->records;
718 *f_resp->numberOfRecordsReturned =
719 *p_res->numberOfRecordsReturned;
720 *f_resp->nextResultSetPosition =
721 *p_res->nextResultSetPosition;
725 package.response() = pp.response();
729 package.response() = f_apdu; // in this scope because of p
732 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
734 // create present request
735 Z_PresentRequest *req = apdu_req->u.presentRequest;
738 it = m_sets.find(std::string(req->resultSetId));
739 if (it == m_sets.end())
743 odr.create_presentResponse(
745 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
747 package.response() = apdu;
750 std::list<Multi::FrontendSet::PresentJob> jobs;
751 int start = *req->resultSetStartPoint;
752 int number = *req->numberOfRecordsRequested;
754 if (m_p->m_merge_type == round_robin)
755 it->second.round_robin(start, number, jobs);
756 else if (m_p->m_merge_type == serve_order)
757 it->second.serve_order(start, number, jobs);
761 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
762 for (jit = jobs.begin(); jit != jobs.end(); jit++)
764 yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
768 std::list<BackendPtr> present_backend_list;
770 std::list<BackendSet>::const_iterator bsit;
771 bsit = it->second.m_backend_sets.begin();
772 for (; bsit != it->second.m_backend_sets.end(); bsit++)
777 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
778 for (jit = jobs.begin(); jit != jobs.end(); jit++)
780 if (jit->m_backend == bsit->m_backend)
782 if (start == -1 || jit->m_pos < start)
784 if (end == -1 || jit->m_pos > end)
791 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
792 for (jit = jobs.begin(); jit != jobs.end(); jit++)
794 if (jit->m_backend == bsit->m_backend)
796 if (jit->m_pos >= start && jit->m_pos <= end)
797 jit->m_start = start;
801 PackagePtr p = bsit->m_backend->m_package;
803 *req->resultSetStartPoint = start;
804 *req->numberOfRecordsRequested = end - start + 1;
806 p->request() = apdu_req;
807 p->copy_filter(package);
809 present_backend_list.push_back(bsit->m_backend);
812 multi_move(present_backend_list);
814 // look at each response
815 Z_Records *z_records_diag = 0;
817 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
818 for (; pbit != present_backend_list.end(); pbit++)
820 PackagePtr p = (*pbit)->m_package;
822 if (p->session().is_closed()) // if any backend closes, close frontend
823 package.session().close();
825 Z_GDU *gdu = p->response().get();
826 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
827 Z_APDU_presentResponse)
829 Z_APDU *b_apdu = gdu->u.z3950;
830 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
832 // see we get any errors (AKA diagnstics)
835 if (b_resp->records->which != Z_Records_DBOSD)
836 z_records_diag = b_resp->records;
837 // we may set this multiple times (TOO BAD!)
842 // if any target does not return present response - return that
843 package.response() = p->response();
849 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
850 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
854 f_resp->records = z_records_diag;
855 *f_resp->presentStatus = Z_PresentStatus_failure;
857 else if (number < 0 || (size_t) number > jobs.size())
860 odr.create_presentResponse(
862 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
867 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
868 Z_Records * records = f_resp->records;
869 records->which = Z_Records_DBOSD;
870 records->u.databaseOrSurDiagnostics =
871 (Z_NamePlusRecordList *)
872 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
873 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
874 nprl->num_records = jobs.size();
875 nprl->records = (Z_NamePlusRecord**)
876 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
878 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
879 for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
881 PackagePtr p = jit->m_backend->m_package;
883 Z_GDU *gdu = p->response().get();
884 Z_APDU *b_apdu = gdu->u.z3950;
885 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
887 nprl->records[i] = (Z_NamePlusRecord*)
888 odr_malloc(odr, sizeof(Z_NamePlusRecord));
889 int inside_pos = jit->m_pos - jit->m_start;
890 if (!b_resp->records || inside_pos >= b_resp->records->
891 u.databaseOrSurDiagnostics->num_records)
893 *nprl->records[i] = *b_resp->records->
894 u.databaseOrSurDiagnostics->records[inside_pos];
895 nprl->records[i]->databaseName =
896 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
898 nprl->num_records = i; // usually same as jobs.size();
899 *f_resp->nextResultSetPosition = start + i;
900 *f_resp->numberOfRecordsReturned = i;
902 package.response() = f_apdu;
905 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
907 if (m_backend_list.size() > 1)
911 odr.create_scanResponse(
912 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
913 package.response() = f_apdu;
916 Z_ScanRequest *req = apdu_req->u.scanRequest;
918 int default_num_db = req->num_databaseNames;
919 char **default_db = req->databaseNames;
921 std::list<BackendPtr>::const_iterator bit;
922 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
924 PackagePtr p = (*bit)->m_package;
927 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
928 &req->num_databaseNames,
929 &req->databaseNames))
931 req->num_databaseNames = default_num_db;
932 req->databaseNames = default_db;
934 p->request() = apdu_req;
935 p->copy_filter(package);
937 multi_move(m_backend_list);
939 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
941 PackagePtr p = (*bit)->m_package;
943 if (p->session().is_closed()) // if any backend closes, close frontend
944 package.session().close();
946 Z_GDU *gdu = p->response().get();
947 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
950 package.response() = p->response();
955 // if any target does not return scan response - return that
956 package.response() = p->response();
962 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
964 return m_norm_term < k.m_norm_term;
967 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
969 return m_norm_term == k.m_norm_term;
972 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
974 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
975 e->which = Z_Entry_termInfo;
977 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
978 t->suggestedAttributes = 0;
980 t->alternativeTerm = 0;
982 t->otherTermInfo = 0;
983 t->globalOccurrences = odr_intdup(odr, m_count);
985 odr_malloc(odr, sizeof(*t->term));
986 t->term->which = Z_Term_general;
988 t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
990 o->len = o->size = m_norm_term.size();
991 o->buf = (unsigned char *) odr_malloc(odr, o->len);
992 memcpy(o->buf, m_norm_term.c_str(), o->len);
996 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
998 std::list<BackendPtr>::const_iterator bit;
999 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1001 PackagePtr p = (*bit)->m_package;
1004 p->request() = apdu_req;
1005 p->copy_filter(package);
1007 multi_move(m_backend_list);
1008 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1010 PackagePtr p = (*bit)->m_package;
1012 if (p->session().is_closed()) // if any backend closes, close frontend
1013 package.session().close();
1015 package.response() = p->response();
1020 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
1022 Z_ScanRequest *req = apdu_req->u.scanRequest;
1024 int default_num_db = req->num_databaseNames;
1025 char **default_db = req->databaseNames;
1027 std::list<BackendPtr>::const_iterator bit;
1028 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1030 PackagePtr p = (*bit)->m_package;
1033 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
1034 &req->num_databaseNames,
1035 &req->databaseNames))
1037 req->num_databaseNames = default_num_db;
1038 req->databaseNames = default_db;
1040 p->request() = apdu_req;
1041 p->copy_filter(package);
1043 multi_move(m_backend_list);
1045 ScanTermInfoList entries_before;
1046 ScanTermInfoList entries_after;
1050 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1052 PackagePtr p = (*bit)->m_package;
1054 if (p->session().is_closed()) // if any backend closes, close frontend
1055 package.session().close();
1057 Z_GDU *gdu = p->response().get();
1058 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1059 Z_APDU_scanResponse)
1061 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
1063 if (res->entries && res->entries->nonsurrogateDiagnostics)
1067 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1068 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1070 f_res->entries->nonsurrogateDiagnostics =
1071 res->entries->nonsurrogateDiagnostics;
1072 f_res->entries->num_nonsurrogateDiagnostics =
1073 res->entries->num_nonsurrogateDiagnostics;
1075 package.response() = f_apdu;
1079 if (res->entries && res->entries->entries)
1081 Z_Entry **entries = res->entries->entries;
1082 int num_entries = res->entries->num_entries;
1084 if (req->preferredPositionInResponse)
1085 position = *req->preferredPositionInResponse;
1086 if (res->positionOfTerm)
1087 position = *res->positionOfTerm;
1091 for (i = 0; i<position-1 && i<num_entries; i++)
1093 Z_Entry *ent = entries[i];
1095 if (ent->which == Z_Entry_termInfo)
1099 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1100 my.m_count = occur ? *occur : 0;
1102 if (ent->u.termInfo->term->which == Z_Term_general)
1104 my.m_norm_term = std::string(
1106 ent->u.termInfo->term->u.general->buf,
1107 ent->u.termInfo->term->u.general->len);
1109 if (my.m_norm_term.length())
1111 ScanTermInfoList::iterator it =
1112 entries_before.begin();
1113 while (it != entries_before.end() && my <*it)
1115 if (it != entries_before.end() && my == *it)
1117 it->m_count += my.m_count;
1121 entries_before.insert(it, my);
1132 for ( ; i<num_entries; i++)
1134 Z_Entry *ent = entries[i];
1136 if (ent->which == Z_Entry_termInfo)
1140 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1141 my.m_count = occur ? *occur : 0;
1143 if (ent->u.termInfo->term->which == Z_Term_general)
1145 my.m_norm_term = std::string(
1147 ent->u.termInfo->term->u.general->buf,
1148 ent->u.termInfo->term->u.general->len);
1150 if (my.m_norm_term.length())
1152 ScanTermInfoList::iterator it =
1153 entries_after.begin();
1154 while (it != entries_after.end() && *it < my)
1156 if (it != entries_after.end() && my == *it)
1158 it->m_count += my.m_count;
1162 entries_after.insert(it, my);
1173 // if any target does not return scan response - return that
1174 package.response() = p->response();
1181 std::cout << "BEFORE\n";
1182 ScanTermInfoList::iterator it = entries_before.begin();
1183 for(; it != entries_before.end(); it++)
1185 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1188 std::cout << "AFTER\n";
1189 it = entries_after.begin();
1190 for(; it != entries_after.end(); it++)
1192 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1199 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1200 package.response() = f_apdu;
1205 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1206 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1208 int number_returned = *req->numberOfTermsRequested;
1209 int position_returned = *req->preferredPositionInResponse;
1211 resp->entries->num_entries = number_returned;
1212 resp->entries->entries = (Z_Entry**)
1213 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1216 int lbefore = entries_before.size();
1217 if (lbefore < position_returned-1)
1218 position_returned = lbefore+1;
1220 ScanTermInfoList::iterator it = entries_before.begin();
1221 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1223 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1226 it = entries_after.begin();
1228 if (position_returned <= 0)
1231 i = position_returned-1;
1232 for (; i<number_returned && it != entries_after.end(); i++, it++)
1234 resp->entries->entries[i] = it->get_entry(odr);
1237 number_returned = i;
1239 resp->positionOfTerm = odr_intdup(odr, position_returned);
1240 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1241 resp->entries->num_entries = number_returned;
1243 package.response() = f_apdu;
1248 void yf::Multi::process(mp::Package &package) const
1250 FrontendPtr f = m_p->get_frontend(package);
1252 Z_GDU *gdu = package.request().get();
1254 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1255 Z_APDU_initRequest && !f->m_is_multi)
1257 f->init(package, gdu);
1259 else if (!f->m_is_multi)
1261 else if (gdu && gdu->which == Z_GDU_Z3950)
1263 Z_APDU *apdu = gdu->u.z3950;
1264 if (apdu->which == Z_APDU_initRequest)
1268 package.response() = odr.create_close(
1270 Z_Close_protocolError,
1273 package.session().close();
1275 else if (apdu->which == Z_APDU_searchRequest)
1277 f->search(package, apdu);
1279 else if (apdu->which == Z_APDU_presentRequest)
1281 f->present(package, apdu);
1283 else if (apdu->which == Z_APDU_scanRequest)
1285 f->scan2(package, apdu);
1287 else if (apdu->which == Z_APDU_close)
1289 f->relay_apdu(package, apdu);
1295 package.response() = odr.create_close(
1296 apdu, Z_Close_protocolError,
1297 "unsupported APDU in filter multi");
1299 package.session().close();
1302 m_p->release_frontend(package);
1305 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1308 for (ptr = ptr->children; ptr; ptr = ptr->next)
1310 if (ptr->type != XML_ELEMENT_NODE)
1312 if (!strcmp((const char *) ptr->name, "target"))
1315 std::string route = mp::xml::get_route(ptr, auth);
1316 std::string target = mp::xml::get_text(ptr);
1317 if (target.length() == 0)
1319 m_p->m_route_patterns.push_back(Multi::Map(target, route, auth));
1321 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1323 m_p->m_hide_unavailable = true;
1325 else if (!strcmp((const char *) ptr->name, "hideerrors"))
1327 m_p->m_hide_errors = true;
1329 else if (!strcmp((const char *) ptr->name, "mergetype"))
1331 std::string mergetype = mp::xml::get_text(ptr);
1332 if (mergetype == "roundrobin")
1333 m_p->m_merge_type = round_robin;
1334 else if (mergetype == "serveorder")
1335 m_p->m_merge_type = serve_order;
1337 throw mp::filter::FilterException
1338 ("Bad mergetype " + mergetype + " in multi filter");
1343 throw mp::filter::FilterException
1345 + std::string((const char *) ptr->name)
1346 + " in multi filter");
1351 static mp::filter::Base* filter_creator()
1353 return new mp::filter::Multi;
1357 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1368 * c-file-style: "Stroustrup"
1369 * indent-tabs-mode: nil
1371 * vim: shiftwidth=4 tabstop=8 expandtab