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);
110 void record_diagnostics(Z_Records *records,
111 Z_DiagRecs * &z_diag,
117 std::string m_target_pattern;
121 Map(std::string pattern, std::string route, std::string auth) :
122 m_target_pattern(pattern), m_route(route), m_auth(auth) {};
123 bool match(const std::string target, std::string *ret,
124 std::string *auth) const {
125 if (yaz_match_glob(m_target_pattern.c_str(), target.c_str()))
136 friend struct Frontend;
139 FrontendPtr get_frontend(Package &package);
140 void release_frontend(Package &package);
142 std::list<Multi::Map> m_route_patterns;
143 boost::mutex m_mutex;
144 boost::condition m_cond_session_ready;
145 std::map<mp::Session, FrontendPtr> m_clients;
146 bool m_hide_unavailable;
148 multi_merge_type m_merge_type;
153 yf::Multi::Rep::Rep()
155 m_hide_unavailable = false;
156 m_hide_errors = false;
157 m_merge_type = round_robin;
160 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
162 return m_count < k.m_count;
165 yf::Multi::Frontend::Frontend(Rep *rep)
171 yf::Multi::Frontend::~Frontend()
175 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
177 boost::mutex::scoped_lock lock(m_mutex);
179 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
183 it = m_clients.find(package.session());
184 if (it == m_clients.end())
187 if (!it->second->m_in_use)
189 it->second->m_in_use = true;
192 m_cond_session_ready.wait(lock);
194 FrontendPtr f(new Frontend(this));
195 m_clients[package.session()] = f;
200 void yf::Multi::Rep::release_frontend(mp::Package &package)
202 boost::mutex::scoped_lock lock(m_mutex);
203 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
205 it = m_clients.find(package.session());
206 if (it != m_clients.end())
208 if (package.session().is_closed())
210 it->second->close(package);
215 it->second->m_in_use = false;
217 m_cond_session_ready.notify_all();
221 yf::Multi::FrontendSet::FrontendSet(std::string setname)
227 yf::Multi::FrontendSet::FrontendSet()
232 yf::Multi::FrontendSet::~FrontendSet()
236 yf::Multi::Multi() : m_p(new Multi::Rep)
240 yf::Multi::~Multi() {
244 void yf::Multi::Backend::operator() (void)
246 m_package->move(m_route);
250 void yf::Multi::Frontend::close(mp::Package &package)
252 std::list<BackendPtr>::const_iterator bit;
253 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
257 b->m_package->copy_filter(package);
258 b->m_package->request() = (Z_GDU *) 0;
259 b->m_package->session().close();
260 b->m_package->move(b->m_route);
264 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
266 std::list<BackendPtr>::const_iterator bit;
267 boost::thread_group g;
268 for (bit = blist.begin(); bit != blist.end(); bit++)
270 g.add_thread(new boost::thread(**bit));
275 void yf::Multi::FrontendSet::serve_order(int start, int number,
276 std::list<PresentJob> &jobs)
279 for (i = 0; i < number; i++)
281 std::list<BackendSet>::const_iterator bsit;
283 int offset = start + i - 1;
284 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
287 if (offset >= voffset && offset < voffset + bsit->m_count)
289 PresentJob job(bsit->m_backend, offset - voffset + 1);
293 voffset += bsit->m_count;
298 void yf::Multi::FrontendSet::round_robin(int start, int number,
299 std::list<PresentJob> &jobs)
302 std::list<BackendSet>::const_iterator bsit;
303 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
310 // optimization step!
316 // find min count for each set which is > omin
317 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
319 if (bsit->m_count > omin)
321 if (no_left == 0 || bsit->m_count < min)
326 if (no_left == 0) // if nothing greater than omin, bail out.
328 int skip = no_left * min;
329 if (p + skip > start) // step gets us "into" present range?
331 // Yes. skip until start.. Rounding off is deliberate!
332 min = (start-p) / no_left;
335 // update positions in each set..
336 std::list<int>::iterator psit = pos.begin();
337 for (psit = pos.begin(); psit != pos.end(); psit++)
341 // skip on each set.. before "present range"..
344 std::list<int>::iterator psit = pos.begin();
345 for (psit = pos.begin(); psit != pos.end(); psit++)
348 omin = min; // update so we consider next class (with higher count)
356 std::list<int>::iterator psit = pos.begin();
357 bsit = m_backend_sets.begin();
359 for (; bsit != m_backend_sets.end(); psit++,bsit++)
361 if (fetched >= number)
366 if (*psit <= bsit->m_count)
370 PresentJob job(bsit->m_backend, *psit);
382 void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
384 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
386 std::list<std::string> targets;
388 mp::util::get_vhost_otherinfo(req->otherInfo, targets);
390 if (targets.size() < 1)
396 std::list<std::string>::const_iterator t_it = targets.begin();
397 for (; t_it != targets.end(); t_it++)
400 Backend *b = new Backend;
403 std::list<Multi::Map>::const_iterator it =
404 m_p->m_route_patterns.begin();
405 while (it != m_p->m_route_patterns.end()) {
406 if (it->match(*t_it, &b->m_route, &b->m_auth))
410 // b->m_route = m_p->m_target_route[*t_it];
412 b->m_package = PackagePtr(new Package(s, package.origin()));
414 m_backend_list.push_back(BackendPtr(b));
418 // create init request
419 std::list<BackendPtr>::iterator bit;
420 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
424 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
426 std::list<std::string>vhost_one;
427 vhost_one.push_back(b->m_vhost);
428 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
432 Z_InitRequest *breq = init_apdu->u.initRequest;
434 if (b->m_auth.length())
436 breq->idAuthentication =
437 (Z_IdAuthentication *)
438 odr_malloc(odr, sizeof(*breq->idAuthentication));
439 breq->idAuthentication->which = Z_IdAuthentication_open;
440 breq->idAuthentication->u.open = odr_strdup(odr, b->m_auth.c_str());
443 breq->idAuthentication = req->idAuthentication;
445 *breq->preferredMessageSize = *req->preferredMessageSize;
446 *breq->maximumRecordSize = *req->maximumRecordSize;
448 ODR_MASK_SET(breq->options, Z_Options_search);
449 ODR_MASK_SET(breq->options, Z_Options_present);
450 ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
451 ODR_MASK_SET(breq->options, Z_Options_scan);
453 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
454 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
455 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
457 b->m_package->request() = init_apdu;
459 b->m_package->copy_filter(package);
461 multi_move(m_backend_list);
463 // create the frontend init response based on each backend init response
466 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
467 Z_InitResponse *f_resp = f_apdu->u.initResponse;
469 ODR_MASK_SET(f_resp->options, Z_Options_search);
470 ODR_MASK_SET(f_resp->options, Z_Options_present);
471 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
472 ODR_MASK_SET(f_resp->options, Z_Options_scan);
474 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
475 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
476 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
479 int no_succeeded = 0;
481 Odr_int preferredMessageSize = *req->preferredMessageSize;
482 Odr_int maximumRecordSize = *req->maximumRecordSize;
483 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
485 PackagePtr p = (*bit)->m_package;
487 if (p->session().is_closed())
489 // failed. Remove from list and increment number of failed
491 bit = m_backend_list.erase(bit);
494 Z_GDU *gdu = p->response().get();
495 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
499 Z_APDU *b_apdu = gdu->u.z3950;
500 Z_InitResponse *b_resp = b_apdu->u.initResponse;
502 // common options for all backends
503 for (i = 0; i <= Z_Options_stringSchema; i++)
505 if (!ODR_MASK_GET(b_resp->options, i))
506 ODR_MASK_CLEAR(f_resp->options, i);
508 // common protocol version
509 for (i = 0; i <= Z_ProtocolVersion_3; i++)
510 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
511 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
515 if (preferredMessageSize > *b_resp->preferredMessageSize)
516 preferredMessageSize = *b_resp->preferredMessageSize;
517 if (maximumRecordSize > *b_resp->maximumRecordSize)
518 maximumRecordSize = *b_resp->maximumRecordSize;
522 if (!f_resp->userInformationField
523 && b_resp->userInformationField)
524 f_resp->userInformationField = b_resp->userInformationField;
532 *f_resp->preferredMessageSize = preferredMessageSize;
533 *f_resp->maximumRecordSize = maximumRecordSize;
535 if (m_p->m_hide_unavailable)
537 if (no_succeeded == 0)
540 package.session().close();
548 package.session().close();
551 package.response() = f_apdu;
554 void yf::Multi::Frontend::record_diagnostics(Z_Records *records,
555 Z_DiagRecs * &z_diag,
559 // see we get any errors (AKA diagnstics)
562 if (records->which == Z_Records_NSD)
566 z_diag = (Z_DiagRecs *)
567 odr_malloc(odr, sizeof(*z_diag));
568 z_diag->num_diagRecs = 0;
569 z_diag->diagRecs = (Z_DiagRec**)
570 odr_malloc(odr, sizeof(*z_diag->diagRecs));
574 Z_DiagRec **n = (Z_DiagRec **)
576 (1+z_diag->num_diagRecs) * sizeof(*n));
577 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
579 z_diag->diagRecs = n;
581 Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
582 nr->which = Z_DiagRec_defaultFormat;
583 nr->u.defaultFormat =
584 records->u.nonSurrogateDiagnostic;
585 z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
587 else if (records->which == Z_Records_multipleNSD)
589 // we may set this multiple times (TOO BAD!)
590 z_diag = records->u.multipleNonSurDiagnostics;
593 no_successful++; // probably piggyback
596 no_successful++; // no records and no diagnostics
599 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
601 // create search request
602 Z_SearchRequest *req = apdu_req->u.searchRequest;
604 // save these for later
605 Odr_int smallSetUpperBound = *req->smallSetUpperBound;
606 Odr_int largeSetLowerBound = *req->largeSetLowerBound;
607 Odr_int mediumSetPresentNumber = *req->mediumSetPresentNumber;
609 // they are altered now - to disable piggyback
610 *req->smallSetUpperBound = 0;
611 *req->largeSetLowerBound = 1;
612 *req->mediumSetPresentNumber = 0;
614 int default_num_db = req->num_databaseNames;
615 char **default_db = req->databaseNames;
617 std::list<BackendPtr>::const_iterator bit;
618 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
620 PackagePtr p = (*bit)->m_package;
623 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
624 &req->num_databaseNames,
625 &req->databaseNames))
627 req->num_databaseNames = default_num_db;
628 req->databaseNames = default_db;
630 p->request() = apdu_req;
631 p->copy_filter(package);
633 multi_move(m_backend_list);
635 // look at each response
636 FrontendSet resultSet(std::string(req->resultSetName));
639 Odr_int result_set_size = 0;
640 Z_DiagRecs *z_diag = 0;
641 int no_successful = 0;
644 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
646 PackagePtr p = (*bit)->m_package;
648 // save closing package for at least one target
649 if (p->session().is_closed())
652 Z_GDU *gdu = p->response().get();
653 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
654 Z_APDU_searchResponse)
656 Z_APDU *b_apdu = gdu->u.z3950;
657 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
659 record_diagnostics(b_resp->records, z_diag, odr, no_successful);
661 BackendSet backendSet;
662 backendSet.m_backend = *bit;
663 backendSet.m_count = *b_resp->resultCount;
664 result_set_size += *b_resp->resultCount;
665 resultSet.m_backend_sets.push_back(backendSet);
669 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
670 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
672 yaz_log(YLOG_LOG, "no_successful=%d is_closed=%s hide_errors=%s",
674 close_p ? "true" : "false",
675 m_p->m_hide_errors ? "true" : "false");
676 *f_resp->resultCount = result_set_size;
677 if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
679 package.session().close();
680 package.response() = close_p->response();
683 if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
685 f_resp->records = (Z_Records *)
686 odr_malloc(odr, sizeof(*f_resp->records));
687 if (z_diag->num_diagRecs > 1)
689 f_resp->records->which = Z_Records_multipleNSD;
690 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
694 f_resp->records->which = Z_Records_NSD;
695 f_resp->records->u.nonSurrogateDiagnostic =
696 z_diag->diagRecs[0]->u.defaultFormat;
700 m_sets[resultSet.m_setname] = resultSet;
703 mp::util::piggyback(smallSetUpperBound,
705 mediumSetPresentNumber,
709 Package pp(package.session(), package.origin());
710 if (z_diag == 0 && number > 0)
712 pp.copy_filter(package);
713 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
714 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
715 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
716 p_req->resultSetId = req->resultSetName;
717 *p_req->resultSetStartPoint = 1;
718 *p_req->numberOfRecordsRequested = number;
719 pp.request() = p_apdu;
722 if (pp.session().is_closed())
723 package.session().close();
725 Z_GDU *gdu = pp.response().get();
726 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
727 Z_APDU_presentResponse)
729 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
730 f_resp->records = p_res->records;
731 *f_resp->numberOfRecordsReturned =
732 *p_res->numberOfRecordsReturned;
733 *f_resp->nextResultSetPosition =
734 *p_res->nextResultSetPosition;
738 package.response() = pp.response();
742 package.response() = f_apdu; // in this scope because of p
745 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
747 // create present request
748 Z_PresentRequest *req = apdu_req->u.presentRequest;
751 it = m_sets.find(std::string(req->resultSetId));
752 if (it == m_sets.end())
756 odr.create_presentResponse(
758 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
760 package.response() = apdu;
763 std::list<Multi::FrontendSet::PresentJob> jobs;
764 int start = *req->resultSetStartPoint;
765 int number = *req->numberOfRecordsRequested;
767 if (m_p->m_merge_type == round_robin)
768 it->second.round_robin(start, number, jobs);
769 else if (m_p->m_merge_type == serve_order)
770 it->second.serve_order(start, number, jobs);
774 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
775 for (jit = jobs.begin(); jit != jobs.end(); jit++)
777 yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
781 std::list<BackendPtr> present_backend_list;
783 std::list<BackendSet>::const_iterator bsit;
784 bsit = it->second.m_backend_sets.begin();
785 for (; bsit != it->second.m_backend_sets.end(); bsit++)
790 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
791 for (jit = jobs.begin(); jit != jobs.end(); jit++)
793 if (jit->m_backend == bsit->m_backend)
795 if (start == -1 || jit->m_pos < start)
797 if (end == -1 || jit->m_pos > end)
804 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
805 for (jit = jobs.begin(); jit != jobs.end(); jit++)
807 if (jit->m_backend == bsit->m_backend)
809 if (jit->m_pos >= start && jit->m_pos <= end)
810 jit->m_start = start;
814 PackagePtr p = bsit->m_backend->m_package;
816 *req->resultSetStartPoint = start;
817 *req->numberOfRecordsRequested = end - start + 1;
819 p->request() = apdu_req;
820 p->copy_filter(package);
822 present_backend_list.push_back(bsit->m_backend);
825 multi_move(present_backend_list);
827 // look at each response
828 Z_DiagRecs *z_diag = 0;
829 int no_successful = 0;
833 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
834 for (; pbit != present_backend_list.end(); pbit++)
836 PackagePtr p = (*pbit)->m_package;
838 // save closing package for at least one target
839 if (p->session().is_closed())
842 Z_GDU *gdu = p->response().get();
843 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
844 Z_APDU_presentResponse)
846 Z_APDU *b_apdu = gdu->u.z3950;
847 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
849 record_diagnostics(b_resp->records, z_diag, odr, no_successful);
853 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
854 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
856 if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
858 package.session().close();
859 package.response() = close_p->response();
862 if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
864 f_resp->records = (Z_Records *)
865 odr_malloc(odr, sizeof(*f_resp->records));
866 if (z_diag->num_diagRecs > 1)
868 f_resp->records->which = Z_Records_multipleNSD;
869 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
873 f_resp->records->which = Z_Records_NSD;
874 f_resp->records->u.nonSurrogateDiagnostic =
875 z_diag->diagRecs[0]->u.defaultFormat;
878 else if (number < 0 || (size_t) number > jobs.size())
881 odr.create_presentResponse(
883 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
888 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
889 Z_Records * records = f_resp->records;
890 records->which = Z_Records_DBOSD;
891 records->u.databaseOrSurDiagnostics =
892 (Z_NamePlusRecordList *)
893 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
894 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
895 nprl->num_records = jobs.size();
896 nprl->records = (Z_NamePlusRecord**)
897 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
899 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
900 for (jit = jobs.begin(); jit != jobs.end(); jit++)
902 PackagePtr p = jit->m_backend->m_package;
904 Z_GDU *gdu = p->response().get();
905 Z_APDU *b_apdu = gdu->u.z3950;
906 int inside_pos = jit->m_pos - jit->m_start;
907 Z_Records *records = b_apdu->u.presentResponse->records;
909 if (records && records->which == Z_Records_DBOSD
911 records->u.databaseOrSurDiagnostics->num_records)
913 nprl->records[i] = (Z_NamePlusRecord*)
914 odr_malloc(odr, sizeof(Z_NamePlusRecord));
915 *nprl->records[i] = *records->
916 u.databaseOrSurDiagnostics->records[inside_pos];
917 nprl->records[i]->databaseName =
918 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
922 nprl->num_records = i; // usually same as jobs.size();
923 *f_resp->nextResultSetPosition = start + i;
924 *f_resp->numberOfRecordsReturned = i;
926 package.response() = f_apdu;
929 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
931 if (m_backend_list.size() > 1)
935 odr.create_scanResponse(
936 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
937 package.response() = f_apdu;
940 Z_ScanRequest *req = apdu_req->u.scanRequest;
942 int default_num_db = req->num_databaseNames;
943 char **default_db = req->databaseNames;
945 std::list<BackendPtr>::const_iterator bit;
946 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
948 PackagePtr p = (*bit)->m_package;
951 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
952 &req->num_databaseNames,
953 &req->databaseNames))
955 req->num_databaseNames = default_num_db;
956 req->databaseNames = default_db;
958 p->request() = apdu_req;
959 p->copy_filter(package);
961 multi_move(m_backend_list);
963 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
965 PackagePtr p = (*bit)->m_package;
967 if (p->session().is_closed()) // if any backend closes, close frontend
968 package.session().close();
970 Z_GDU *gdu = p->response().get();
971 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
974 package.response() = p->response();
979 // if any target does not return scan response - return that
980 package.response() = p->response();
986 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
988 return m_norm_term < k.m_norm_term;
991 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
993 return m_norm_term == k.m_norm_term;
996 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
998 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
999 e->which = Z_Entry_termInfo;
1001 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
1002 t->suggestedAttributes = 0;
1004 t->alternativeTerm = 0;
1005 t->byAttributes = 0;
1006 t->otherTermInfo = 0;
1007 t->globalOccurrences = odr_intdup(odr, m_count);
1008 t->term = (Z_Term *)
1009 odr_malloc(odr, sizeof(*t->term));
1010 t->term->which = Z_Term_general;
1012 t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
1014 o->len = o->size = m_norm_term.size();
1015 o->buf = (unsigned char *) odr_malloc(odr, o->len);
1016 memcpy(o->buf, m_norm_term.c_str(), o->len);
1020 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
1022 std::list<BackendPtr>::const_iterator bit;
1023 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1025 PackagePtr p = (*bit)->m_package;
1028 p->request() = apdu_req;
1029 p->copy_filter(package);
1031 multi_move(m_backend_list);
1032 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1034 PackagePtr p = (*bit)->m_package;
1036 if (p->session().is_closed()) // if any backend closes, close frontend
1037 package.session().close();
1039 package.response() = p->response();
1044 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
1046 Z_ScanRequest *req = apdu_req->u.scanRequest;
1048 int default_num_db = req->num_databaseNames;
1049 char **default_db = req->databaseNames;
1051 std::list<BackendPtr>::const_iterator bit;
1052 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1054 PackagePtr p = (*bit)->m_package;
1057 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
1058 &req->num_databaseNames,
1059 &req->databaseNames))
1061 req->num_databaseNames = default_num_db;
1062 req->databaseNames = default_db;
1064 p->request() = apdu_req;
1065 p->copy_filter(package);
1067 multi_move(m_backend_list);
1069 ScanTermInfoList entries_before;
1070 ScanTermInfoList entries_after;
1074 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1076 PackagePtr p = (*bit)->m_package;
1078 if (p->session().is_closed()) // if any backend closes, close frontend
1079 package.session().close();
1081 Z_GDU *gdu = p->response().get();
1082 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1083 Z_APDU_scanResponse)
1085 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
1087 if (res->entries && res->entries->nonsurrogateDiagnostics)
1091 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1092 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1094 f_res->entries->nonsurrogateDiagnostics =
1095 res->entries->nonsurrogateDiagnostics;
1096 f_res->entries->num_nonsurrogateDiagnostics =
1097 res->entries->num_nonsurrogateDiagnostics;
1099 package.response() = f_apdu;
1103 if (res->entries && res->entries->entries)
1105 Z_Entry **entries = res->entries->entries;
1106 int num_entries = res->entries->num_entries;
1108 if (req->preferredPositionInResponse)
1109 position = *req->preferredPositionInResponse;
1110 if (res->positionOfTerm)
1111 position = *res->positionOfTerm;
1115 for (i = 0; i<position-1 && i<num_entries; i++)
1117 Z_Entry *ent = entries[i];
1119 if (ent->which == Z_Entry_termInfo)
1123 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1124 my.m_count = occur ? *occur : 0;
1126 if (ent->u.termInfo->term->which == Z_Term_general)
1128 my.m_norm_term = std::string(
1130 ent->u.termInfo->term->u.general->buf,
1131 ent->u.termInfo->term->u.general->len);
1133 if (my.m_norm_term.length())
1135 ScanTermInfoList::iterator it =
1136 entries_before.begin();
1137 while (it != entries_before.end() && my <*it)
1139 if (it != entries_before.end() && my == *it)
1141 it->m_count += my.m_count;
1145 entries_before.insert(it, my);
1156 for ( ; i<num_entries; i++)
1158 Z_Entry *ent = entries[i];
1160 if (ent->which == Z_Entry_termInfo)
1164 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1165 my.m_count = occur ? *occur : 0;
1167 if (ent->u.termInfo->term->which == Z_Term_general)
1169 my.m_norm_term = std::string(
1171 ent->u.termInfo->term->u.general->buf,
1172 ent->u.termInfo->term->u.general->len);
1174 if (my.m_norm_term.length())
1176 ScanTermInfoList::iterator it =
1177 entries_after.begin();
1178 while (it != entries_after.end() && *it < my)
1180 if (it != entries_after.end() && my == *it)
1182 it->m_count += my.m_count;
1186 entries_after.insert(it, my);
1197 // if any target does not return scan response - return that
1198 package.response() = p->response();
1205 std::cout << "BEFORE\n";
1206 ScanTermInfoList::iterator it = entries_before.begin();
1207 for(; it != entries_before.end(); it++)
1209 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1212 std::cout << "AFTER\n";
1213 it = entries_after.begin();
1214 for(; it != entries_after.end(); it++)
1216 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1223 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1224 package.response() = f_apdu;
1229 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1230 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1232 int number_returned = *req->numberOfTermsRequested;
1233 int position_returned = *req->preferredPositionInResponse;
1235 resp->entries->num_entries = number_returned;
1236 resp->entries->entries = (Z_Entry**)
1237 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1240 int lbefore = entries_before.size();
1241 if (lbefore < position_returned-1)
1242 position_returned = lbefore+1;
1244 ScanTermInfoList::iterator it = entries_before.begin();
1245 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1247 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1250 it = entries_after.begin();
1252 if (position_returned <= 0)
1255 i = position_returned-1;
1256 for (; i<number_returned && it != entries_after.end(); i++, it++)
1258 resp->entries->entries[i] = it->get_entry(odr);
1261 number_returned = i;
1263 resp->positionOfTerm = odr_intdup(odr, position_returned);
1264 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1265 resp->entries->num_entries = number_returned;
1267 package.response() = f_apdu;
1272 void yf::Multi::process(mp::Package &package) const
1274 FrontendPtr f = m_p->get_frontend(package);
1276 Z_GDU *gdu = package.request().get();
1278 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1279 Z_APDU_initRequest && !f->m_is_multi)
1281 f->init(package, gdu);
1283 else if (!f->m_is_multi)
1285 else if (gdu && gdu->which == Z_GDU_Z3950)
1287 Z_APDU *apdu = gdu->u.z3950;
1288 if (apdu->which == Z_APDU_initRequest)
1292 package.response() = odr.create_close(
1294 Z_Close_protocolError,
1297 package.session().close();
1299 else if (apdu->which == Z_APDU_searchRequest)
1301 f->search(package, apdu);
1303 else if (apdu->which == Z_APDU_presentRequest)
1305 f->present(package, apdu);
1307 else if (apdu->which == Z_APDU_scanRequest)
1309 f->scan2(package, apdu);
1311 else if (apdu->which == Z_APDU_close)
1313 f->relay_apdu(package, apdu);
1319 package.response() = odr.create_close(
1320 apdu, Z_Close_protocolError,
1321 "unsupported APDU in filter multi");
1323 package.session().close();
1326 m_p->release_frontend(package);
1329 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1332 for (ptr = ptr->children; ptr; ptr = ptr->next)
1334 if (ptr->type != XML_ELEMENT_NODE)
1336 if (!strcmp((const char *) ptr->name, "target"))
1339 std::string route = mp::xml::get_route(ptr, auth);
1340 std::string target = mp::xml::get_text(ptr);
1341 if (target.length() == 0)
1343 m_p->m_route_patterns.push_back(Multi::Map(target, route, auth));
1345 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1347 m_p->m_hide_unavailable = true;
1349 else if (!strcmp((const char *) ptr->name, "hideerrors"))
1351 m_p->m_hide_errors = true;
1353 else if (!strcmp((const char *) ptr->name, "mergetype"))
1355 std::string mergetype = mp::xml::get_text(ptr);
1356 if (mergetype == "roundrobin")
1357 m_p->m_merge_type = round_robin;
1358 else if (mergetype == "serveorder")
1359 m_p->m_merge_type = serve_order;
1361 throw mp::filter::FilterException
1362 ("Bad mergetype " + mergetype + " in multi filter");
1367 throw mp::filter::FilterException
1369 + std::string((const char *) ptr->name)
1370 + " in multi filter");
1375 static mp::filter::Base* filter_creator()
1377 return new mp::filter::Multi;
1381 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1392 * c-file-style: "Stroustrup"
1393 * indent-tabs-mode: nil
1395 * vim: shiftwidth=4 tabstop=8 expandtab