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;
91 void operator() (void); // thread operation
93 struct Multi::Frontend {
98 std::list<BackendPtr> m_backend_list;
99 std::map<std::string,Multi::FrontendSet> m_sets;
101 void multi_move(std::list<BackendPtr> &blist);
102 void init(Package &package, Z_GDU *gdu);
103 void close(Package &package);
104 void search(Package &package, Z_APDU *apdu);
105 void present(Package &package, Z_APDU *apdu);
106 void scan1(Package &package, Z_APDU *apdu);
107 void scan2(Package &package, Z_APDU *apdu);
108 void relay_apdu(Package &package, Z_APDU *apdu);
112 std::string m_target_pattern;
115 Map(std::string pattern, std::string route) :
116 m_target_pattern(pattern), m_route(route) {};
117 bool match(const std::string target, std::string *ret) const {
118 if (yaz_match_glob(m_target_pattern.c_str(), target.c_str()))
128 friend struct Frontend;
131 FrontendPtr get_frontend(Package &package);
132 void release_frontend(Package &package);
134 std::list<Multi::Map> m_route_patterns;
135 boost::mutex m_mutex;
136 boost::condition m_cond_session_ready;
137 std::map<mp::Session, FrontendPtr> m_clients;
138 bool m_hide_unavailable;
139 multi_merge_type m_merge_type;
144 yf::Multi::Rep::Rep()
146 m_hide_unavailable = false;
147 m_merge_type = round_robin;
150 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
152 return m_count < k.m_count;
155 yf::Multi::Frontend::Frontend(Rep *rep)
161 yf::Multi::Frontend::~Frontend()
165 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
167 boost::mutex::scoped_lock lock(m_mutex);
169 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
173 it = m_clients.find(package.session());
174 if (it == m_clients.end())
177 if (!it->second->m_in_use)
179 it->second->m_in_use = true;
182 m_cond_session_ready.wait(lock);
184 FrontendPtr f(new Frontend(this));
185 m_clients[package.session()] = f;
190 void yf::Multi::Rep::release_frontend(mp::Package &package)
192 boost::mutex::scoped_lock lock(m_mutex);
193 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
195 it = m_clients.find(package.session());
196 if (it != m_clients.end())
198 if (package.session().is_closed())
200 it->second->close(package);
205 it->second->m_in_use = false;
207 m_cond_session_ready.notify_all();
211 yf::Multi::FrontendSet::FrontendSet(std::string setname)
217 yf::Multi::FrontendSet::FrontendSet()
222 yf::Multi::FrontendSet::~FrontendSet()
226 yf::Multi::Multi() : m_p(new Multi::Rep)
230 yf::Multi::~Multi() {
234 void yf::Multi::Backend::operator() (void)
236 m_package->move(m_route);
240 void yf::Multi::Frontend::close(mp::Package &package)
242 std::list<BackendPtr>::const_iterator bit;
243 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
247 b->m_package->copy_filter(package);
248 b->m_package->request() = (Z_GDU *) 0;
249 b->m_package->session().close();
250 b->m_package->move(b->m_route);
254 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
256 std::list<BackendPtr>::const_iterator bit;
257 boost::thread_group g;
258 for (bit = blist.begin(); bit != blist.end(); bit++)
260 g.add_thread(new boost::thread(**bit));
265 void yf::Multi::FrontendSet::serve_order(int start, int number,
266 std::list<PresentJob> &jobs)
269 for (i = 0; i < number; i++)
271 std::list<BackendSet>::const_iterator bsit;
273 int offset = start + i - 1;
274 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
277 if (offset >= voffset && offset < voffset + bsit->m_count)
279 PresentJob job(bsit->m_backend, offset - voffset + 1);
283 voffset += bsit->m_count;
288 void yf::Multi::FrontendSet::round_robin(int start, int number,
289 std::list<PresentJob> &jobs)
292 std::list<BackendSet>::const_iterator bsit;
293 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
300 // optimization step!
306 // find min count for each set which is > omin
307 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
309 if (bsit->m_count > omin)
311 if (no_left == 0 || bsit->m_count < min)
316 if (no_left == 0) // if nothing greater than omin, bail out.
318 int skip = no_left * min;
319 if (p + skip > start) // step gets us "into" present range?
321 // Yes. skip until start.. Rounding off is deliberate!
322 min = (start-p) / no_left;
325 // update positions in each set..
326 std::list<int>::iterator psit = pos.begin();
327 for (psit = pos.begin(); psit != pos.end(); psit++)
331 // skip on each set.. before "present range"..
334 std::list<int>::iterator psit = pos.begin();
335 for (psit = pos.begin(); psit != pos.end(); psit++)
338 omin = min; // update so we consider next class (with higher count)
346 std::list<int>::iterator psit = pos.begin();
347 bsit = m_backend_sets.begin();
349 for (; bsit != m_backend_sets.end(); psit++,bsit++)
351 if (fetched >= number)
356 if (*psit <= bsit->m_count)
360 PresentJob job(bsit->m_backend, *psit);
372 void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
374 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
376 std::list<std::string> targets;
378 mp::util::get_vhost_otherinfo(req->otherInfo, targets);
380 if (targets.size() < 1)
386 std::list<std::string>::const_iterator t_it = targets.begin();
387 for (; t_it != targets.end(); t_it++)
390 Backend *b = new Backend;
393 std::list<Multi::Map>::const_iterator it =
394 m_p->m_route_patterns.begin();
395 while (it != m_p->m_route_patterns.end()) {
396 if (it->match(*t_it, &b->m_route))
400 // b->m_route = m_p->m_target_route[*t_it];
402 b->m_package = PackagePtr(new Package(s, package.origin()));
404 m_backend_list.push_back(BackendPtr(b));
408 // create init request
409 std::list<BackendPtr>::iterator bit;
410 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
414 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
416 std::list<std::string>vhost_one;
417 vhost_one.push_back(b->m_vhost);
418 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
422 Z_InitRequest *breq = init_apdu->u.initRequest;
424 breq->idAuthentication = req->idAuthentication;
426 *breq->preferredMessageSize = *req->preferredMessageSize;
427 *breq->maximumRecordSize = *req->maximumRecordSize;
429 ODR_MASK_SET(breq->options, Z_Options_search);
430 ODR_MASK_SET(breq->options, Z_Options_present);
431 ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
432 ODR_MASK_SET(breq->options, Z_Options_scan);
434 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
435 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
436 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
438 b->m_package->request() = init_apdu;
440 b->m_package->copy_filter(package);
442 multi_move(m_backend_list);
444 // create the frontend init response based on each backend init response
447 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
448 Z_InitResponse *f_resp = f_apdu->u.initResponse;
450 ODR_MASK_SET(f_resp->options, Z_Options_search);
451 ODR_MASK_SET(f_resp->options, Z_Options_present);
452 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
453 ODR_MASK_SET(f_resp->options, Z_Options_scan);
455 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
456 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
457 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
460 int no_succeeded = 0;
462 Odr_int preferredMessageSize = *req->preferredMessageSize;
463 Odr_int maximumRecordSize = *req->maximumRecordSize;
464 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
466 PackagePtr p = (*bit)->m_package;
468 if (p->session().is_closed())
470 // failed. Remove from list and increment number of failed
472 bit = m_backend_list.erase(bit);
475 Z_GDU *gdu = p->response().get();
476 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
480 Z_APDU *b_apdu = gdu->u.z3950;
481 Z_InitResponse *b_resp = b_apdu->u.initResponse;
483 // common options for all backends
484 for (i = 0; i <= Z_Options_stringSchema; i++)
486 if (!ODR_MASK_GET(b_resp->options, i))
487 ODR_MASK_CLEAR(f_resp->options, i);
489 // common protocol version
490 for (i = 0; i <= Z_ProtocolVersion_3; i++)
491 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
492 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
496 if (preferredMessageSize > *b_resp->preferredMessageSize)
497 preferredMessageSize = *b_resp->preferredMessageSize;
498 if (maximumRecordSize > *b_resp->maximumRecordSize)
499 maximumRecordSize = *b_resp->maximumRecordSize;
508 *f_resp->preferredMessageSize = preferredMessageSize;
509 *f_resp->maximumRecordSize = maximumRecordSize;
511 if (m_p->m_hide_unavailable)
513 if (no_succeeded == 0)
516 package.session().close();
524 package.session().close();
527 package.response() = f_apdu;
530 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
532 // create search request
533 Z_SearchRequest *req = apdu_req->u.searchRequest;
535 // save these for later
536 Odr_int smallSetUpperBound = *req->smallSetUpperBound;
537 Odr_int largeSetLowerBound = *req->largeSetLowerBound;
538 Odr_int mediumSetPresentNumber = *req->mediumSetPresentNumber;
540 // they are altered now - to disable piggyback
541 *req->smallSetUpperBound = 0;
542 *req->largeSetLowerBound = 1;
543 *req->mediumSetPresentNumber = 1;
545 int default_num_db = req->num_databaseNames;
546 char **default_db = req->databaseNames;
548 std::list<BackendPtr>::const_iterator bit;
549 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
551 PackagePtr p = (*bit)->m_package;
554 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
555 &req->num_databaseNames,
556 &req->databaseNames))
558 req->num_databaseNames = default_num_db;
559 req->databaseNames = default_db;
561 p->request() = apdu_req;
562 p->copy_filter(package);
564 multi_move(m_backend_list);
566 // look at each response
567 FrontendSet resultSet(std::string(req->resultSetName));
570 Odr_int result_set_size = 0;
571 Z_DiagRecs *z_diag = 0;
572 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
574 PackagePtr p = (*bit)->m_package;
576 if (p->session().is_closed()) // if any backend closes, close frontend
577 package.session().close();
579 Z_GDU *gdu = p->response().get();
580 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
581 Z_APDU_searchResponse)
583 Z_APDU *b_apdu = gdu->u.z3950;
584 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
586 // see we get any errors (AKA diagnstics)
589 if (b_resp->records->which == Z_Records_NSD)
593 z_diag = (Z_DiagRecs *)
594 odr_malloc(odr, sizeof(*z_diag));
595 z_diag->num_diagRecs = 0;
596 z_diag->diagRecs = (Z_DiagRec**)
597 odr_malloc(odr, sizeof(*z_diag->diagRecs));
601 Z_DiagRec **n = (Z_DiagRec **)
603 (1+z_diag->num_diagRecs) * sizeof(*n));
604 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
606 z_diag->diagRecs = n;
608 Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
609 nr->which = Z_DiagRec_defaultFormat;
610 nr->u.defaultFormat =
611 b_resp->records->u.nonSurrogateDiagnostic;
612 z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
614 if (b_resp->records->which == Z_Records_multipleNSD)
616 // we may set this multiple times (TOO BAD!)
617 z_diag = b_resp->records->u.multipleNonSurDiagnostics;
620 BackendSet backendSet;
621 backendSet.m_backend = *bit;
622 backendSet.m_count = *b_resp->resultCount;
623 result_set_size += *b_resp->resultCount;
624 resultSet.m_backend_sets.push_back(backendSet);
628 // if any target does not return search response - return that
629 package.response() = p->response();
634 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
635 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
637 *f_resp->resultCount = result_set_size;
640 f_resp->records = (Z_Records *)
641 odr_malloc(odr, sizeof(*f_resp->records));
642 if (z_diag->num_diagRecs > 1)
644 f_resp->records->which = Z_Records_multipleNSD;
645 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
649 f_resp->records->which = Z_Records_NSD;
650 f_resp->records->u.nonSurrogateDiagnostic =
651 z_diag->diagRecs[0]->u.defaultFormat;
655 m_sets[resultSet.m_setname] = resultSet;
658 mp::util::piggyback(smallSetUpperBound,
660 mediumSetPresentNumber,
664 Package pp(package.session(), package.origin());
665 if (z_diag == 0 && number > 0)
667 pp.copy_filter(package);
668 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
669 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
670 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
671 p_req->resultSetId = req->resultSetName;
672 *p_req->resultSetStartPoint = 1;
673 *p_req->numberOfRecordsRequested = number;
674 pp.request() = p_apdu;
677 if (pp.session().is_closed())
678 package.session().close();
680 Z_GDU *gdu = pp.response().get();
681 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
682 Z_APDU_presentResponse)
684 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
685 f_resp->records = p_res->records;
686 *f_resp->numberOfRecordsReturned =
687 *p_res->numberOfRecordsReturned;
688 *f_resp->nextResultSetPosition =
689 *p_res->nextResultSetPosition;
693 package.response() = pp.response();
697 package.response() = f_apdu; // in this scope because of p
700 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
702 // create present request
703 Z_PresentRequest *req = apdu_req->u.presentRequest;
706 it = m_sets.find(std::string(req->resultSetId));
707 if (it == m_sets.end())
711 odr.create_presentResponse(
713 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
715 package.response() = apdu;
718 std::list<Multi::FrontendSet::PresentJob> jobs;
719 int start = *req->resultSetStartPoint;
720 int number = *req->numberOfRecordsRequested;
722 if (m_p->m_merge_type == round_robin)
723 it->second.round_robin(start, number, jobs);
724 else if (m_p->m_merge_type == serve_order)
725 it->second.serve_order(start, number, jobs);
729 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
730 for (jit = jobs.begin(); jit != jobs.end(); jit++)
732 yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
736 std::list<BackendPtr> present_backend_list;
738 std::list<BackendSet>::const_iterator bsit;
739 bsit = it->second.m_backend_sets.begin();
740 for (; bsit != it->second.m_backend_sets.end(); bsit++)
745 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
746 for (jit = jobs.begin(); jit != jobs.end(); jit++)
748 if (jit->m_backend == bsit->m_backend)
750 if (start == -1 || jit->m_pos < start)
752 if (end == -1 || jit->m_pos > end)
759 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
760 for (jit = jobs.begin(); jit != jobs.end(); jit++)
762 if (jit->m_backend == bsit->m_backend)
764 if (jit->m_pos >= start && jit->m_pos <= end)
765 jit->m_start = start;
769 PackagePtr p = bsit->m_backend->m_package;
771 *req->resultSetStartPoint = start;
772 *req->numberOfRecordsRequested = end - start + 1;
774 p->request() = apdu_req;
775 p->copy_filter(package);
777 present_backend_list.push_back(bsit->m_backend);
780 multi_move(present_backend_list);
782 // look at each response
783 Z_Records *z_records_diag = 0;
785 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
786 for (; pbit != present_backend_list.end(); pbit++)
788 PackagePtr p = (*pbit)->m_package;
790 if (p->session().is_closed()) // if any backend closes, close frontend
791 package.session().close();
793 Z_GDU *gdu = p->response().get();
794 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
795 Z_APDU_presentResponse)
797 Z_APDU *b_apdu = gdu->u.z3950;
798 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
800 // see we get any errors (AKA diagnstics)
803 if (b_resp->records->which != Z_Records_DBOSD)
804 z_records_diag = b_resp->records;
805 // we may set this multiple times (TOO BAD!)
810 // if any target does not return present response - return that
811 package.response() = p->response();
817 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
818 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
822 f_resp->records = z_records_diag;
823 *f_resp->presentStatus = Z_PresentStatus_failure;
825 else if (number < 0 || (size_t) number > jobs.size())
828 odr.create_presentResponse(
830 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
835 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
836 Z_Records * records = f_resp->records;
837 records->which = Z_Records_DBOSD;
838 records->u.databaseOrSurDiagnostics =
839 (Z_NamePlusRecordList *)
840 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
841 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
842 nprl->num_records = jobs.size();
843 nprl->records = (Z_NamePlusRecord**)
844 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
846 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
847 for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
849 PackagePtr p = jit->m_backend->m_package;
851 Z_GDU *gdu = p->response().get();
852 Z_APDU *b_apdu = gdu->u.z3950;
853 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
855 nprl->records[i] = (Z_NamePlusRecord*)
856 odr_malloc(odr, sizeof(Z_NamePlusRecord));
857 int inside_pos = jit->m_pos - jit->m_start;
858 if (inside_pos >= b_resp->records->
859 u.databaseOrSurDiagnostics->num_records)
861 *nprl->records[i] = *b_resp->records->
862 u.databaseOrSurDiagnostics->records[inside_pos];
863 nprl->records[i]->databaseName =
864 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
866 nprl->num_records = i; // usually same as jobs.size();
867 *f_resp->nextResultSetPosition = start + i;
868 *f_resp->numberOfRecordsReturned = i;
870 package.response() = f_apdu;
873 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
875 if (m_backend_list.size() > 1)
879 odr.create_scanResponse(
880 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
881 package.response() = f_apdu;
884 Z_ScanRequest *req = apdu_req->u.scanRequest;
886 int default_num_db = req->num_databaseNames;
887 char **default_db = req->databaseNames;
889 std::list<BackendPtr>::const_iterator bit;
890 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
892 PackagePtr p = (*bit)->m_package;
895 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
896 &req->num_databaseNames,
897 &req->databaseNames))
899 req->num_databaseNames = default_num_db;
900 req->databaseNames = default_db;
902 p->request() = apdu_req;
903 p->copy_filter(package);
905 multi_move(m_backend_list);
907 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
909 PackagePtr p = (*bit)->m_package;
911 if (p->session().is_closed()) // if any backend closes, close frontend
912 package.session().close();
914 Z_GDU *gdu = p->response().get();
915 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
918 package.response() = p->response();
923 // if any target does not return scan response - return that
924 package.response() = p->response();
930 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
932 return m_norm_term < k.m_norm_term;
935 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
937 return m_norm_term == k.m_norm_term;
940 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
942 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
943 e->which = Z_Entry_termInfo;
945 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
946 t->suggestedAttributes = 0;
948 t->alternativeTerm = 0;
950 t->otherTermInfo = 0;
951 t->globalOccurrences = odr_intdup(odr, m_count);
953 odr_malloc(odr, sizeof(*t->term));
954 t->term->which = Z_Term_general;
956 t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
958 o->len = o->size = m_norm_term.size();
959 o->buf = (unsigned char *) odr_malloc(odr, o->len);
960 memcpy(o->buf, m_norm_term.c_str(), o->len);
964 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
966 std::list<BackendPtr>::const_iterator bit;
967 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
969 PackagePtr p = (*bit)->m_package;
972 p->request() = apdu_req;
973 p->copy_filter(package);
975 multi_move(m_backend_list);
976 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
978 PackagePtr p = (*bit)->m_package;
980 if (p->session().is_closed()) // if any backend closes, close frontend
981 package.session().close();
983 package.response() = p->response();
988 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
990 Z_ScanRequest *req = apdu_req->u.scanRequest;
992 int default_num_db = req->num_databaseNames;
993 char **default_db = req->databaseNames;
995 std::list<BackendPtr>::const_iterator bit;
996 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
998 PackagePtr p = (*bit)->m_package;
1001 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
1002 &req->num_databaseNames,
1003 &req->databaseNames))
1005 req->num_databaseNames = default_num_db;
1006 req->databaseNames = default_db;
1008 p->request() = apdu_req;
1009 p->copy_filter(package);
1011 multi_move(m_backend_list);
1013 ScanTermInfoList entries_before;
1014 ScanTermInfoList entries_after;
1018 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1020 PackagePtr p = (*bit)->m_package;
1022 if (p->session().is_closed()) // if any backend closes, close frontend
1023 package.session().close();
1025 Z_GDU *gdu = p->response().get();
1026 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1027 Z_APDU_scanResponse)
1029 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
1031 if (res->entries && res->entries->nonsurrogateDiagnostics)
1035 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1036 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1038 f_res->entries->nonsurrogateDiagnostics =
1039 res->entries->nonsurrogateDiagnostics;
1040 f_res->entries->num_nonsurrogateDiagnostics =
1041 res->entries->num_nonsurrogateDiagnostics;
1043 package.response() = f_apdu;
1047 if (res->entries && res->entries->entries)
1049 Z_Entry **entries = res->entries->entries;
1050 int num_entries = res->entries->num_entries;
1052 if (req->preferredPositionInResponse)
1053 position = *req->preferredPositionInResponse;
1054 if (res->positionOfTerm)
1055 position = *res->positionOfTerm;
1059 for (i = 0; i<position-1 && i<num_entries; i++)
1061 Z_Entry *ent = entries[i];
1063 if (ent->which == Z_Entry_termInfo)
1067 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1068 my.m_count = occur ? *occur : 0;
1070 if (ent->u.termInfo->term->which == Z_Term_general)
1072 my.m_norm_term = std::string(
1074 ent->u.termInfo->term->u.general->buf,
1075 ent->u.termInfo->term->u.general->len);
1077 if (my.m_norm_term.length())
1079 ScanTermInfoList::iterator it =
1080 entries_before.begin();
1081 while (it != entries_before.end() && my <*it)
1085 it->m_count += my.m_count;
1089 entries_before.insert(it, my);
1100 for ( ; i<num_entries; i++)
1102 Z_Entry *ent = entries[i];
1104 if (ent->which == Z_Entry_termInfo)
1108 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1109 my.m_count = occur ? *occur : 0;
1111 if (ent->u.termInfo->term->which == Z_Term_general)
1113 my.m_norm_term = std::string(
1115 ent->u.termInfo->term->u.general->buf,
1116 ent->u.termInfo->term->u.general->len);
1118 if (my.m_norm_term.length())
1120 ScanTermInfoList::iterator it =
1121 entries_after.begin();
1122 while (it != entries_after.end() && *it < my)
1126 it->m_count += my.m_count;
1130 entries_after.insert(it, my);
1141 // if any target does not return scan response - return that
1142 package.response() = p->response();
1149 std::cout << "BEFORE\n";
1150 ScanTermInfoList::iterator it = entries_before.begin();
1151 for(; it != entries_before.end(); it++)
1153 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1156 std::cout << "AFTER\n";
1157 it = entries_after.begin();
1158 for(; it != entries_after.end(); it++)
1160 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1167 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1168 package.response() = f_apdu;
1173 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1174 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1176 int number_returned = *req->numberOfTermsRequested;
1177 int position_returned = *req->preferredPositionInResponse;
1179 resp->entries->num_entries = number_returned;
1180 resp->entries->entries = (Z_Entry**)
1181 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1184 int lbefore = entries_before.size();
1185 if (lbefore < position_returned-1)
1186 position_returned = lbefore+1;
1188 ScanTermInfoList::iterator it = entries_before.begin();
1189 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1191 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1194 it = entries_after.begin();
1196 if (position_returned <= 0)
1199 i = position_returned-1;
1200 for (; i<number_returned && it != entries_after.end(); i++, it++)
1202 resp->entries->entries[i] = it->get_entry(odr);
1205 number_returned = i;
1207 resp->positionOfTerm = odr_intdup(odr, position_returned);
1208 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1209 resp->entries->num_entries = number_returned;
1211 package.response() = f_apdu;
1216 void yf::Multi::process(mp::Package &package) const
1218 FrontendPtr f = m_p->get_frontend(package);
1220 Z_GDU *gdu = package.request().get();
1222 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1223 Z_APDU_initRequest && !f->m_is_multi)
1225 f->init(package, gdu);
1227 else if (!f->m_is_multi)
1229 else if (gdu && gdu->which == Z_GDU_Z3950)
1231 Z_APDU *apdu = gdu->u.z3950;
1232 if (apdu->which == Z_APDU_initRequest)
1236 package.response() = odr.create_close(
1238 Z_Close_protocolError,
1241 package.session().close();
1243 else if (apdu->which == Z_APDU_searchRequest)
1245 f->search(package, apdu);
1247 else if (apdu->which == Z_APDU_presentRequest)
1249 f->present(package, apdu);
1251 else if (apdu->which == Z_APDU_scanRequest)
1253 f->scan2(package, apdu);
1255 else if (apdu->which == Z_APDU_close)
1257 f->relay_apdu(package, apdu);
1263 package.response() = odr.create_close(
1264 apdu, Z_Close_protocolError,
1265 "unsupported APDU in filter multi");
1267 package.session().close();
1270 m_p->release_frontend(package);
1273 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1276 for (ptr = ptr->children; ptr; ptr = ptr->next)
1278 if (ptr->type != XML_ELEMENT_NODE)
1280 if (!strcmp((const char *) ptr->name, "target"))
1282 std::string route = mp::xml::get_route(ptr);
1283 std::string target = mp::xml::get_text(ptr);
1284 m_p->m_route_patterns.push_back(Multi::Map(target, route));
1286 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1288 m_p->m_hide_unavailable = true;
1290 else if (!strcmp((const char *) ptr->name, "mergetype"))
1292 std::string mergetype = mp::xml::get_text(ptr);
1293 if (mergetype == "roundrobin")
1294 m_p->m_merge_type = round_robin;
1295 else if (mergetype == "serveorder")
1296 m_p->m_merge_type = serve_order;
1298 throw mp::filter::FilterException
1299 ("Bad mergetype " + mergetype + " in multi filter");
1304 throw mp::filter::FilterException
1306 + std::string((const char *) ptr->name)
1307 + " in multi filter");
1312 static mp::filter::Base* filter_creator()
1314 return new mp::filter::Multi;
1318 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1329 * c-file-style: "Stroustrup"
1330 * indent-tabs-mode: nil
1332 * vim: shiftwidth=4 tabstop=8 expandtab