1 /* This file is part of Metaproxy.
2 Copyright (C) Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
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>
38 #include <yaz/oid_db.h>
45 namespace mp = metaproxy_1;
46 namespace yf = mp::filter;
48 namespace metaproxy_1 {
50 enum multi_merge_type {
54 struct Multi::BackendSet {
57 bool operator < (const BackendSet &k) const;
58 bool operator == (const BackendSet &k) const;
60 struct Multi::ScanTermInfo {
61 std::string m_norm_term;
62 std::string m_display_term;
64 bool operator < (const ScanTermInfo &) const;
65 bool operator == (const ScanTermInfo &) const;
66 Z_Entry *get_entry(ODR odr);
68 struct Multi::FrontendSet {
72 int m_pos; // position for backend (1=first, 2=second,..
73 int m_start; // present request start
74 PresentJob(BackendPtr ptr, int pos) :
75 m_backend(ptr), m_pos(pos), m_start(0) {};
77 FrontendSet(std::string setname);
81 void round_robin(int pos, int number, std::list<PresentJob> &job);
82 void serve_order(int pos, int number, std::list<PresentJob> &job);
84 std::list<BackendSet> m_backend_sets;
85 std::string m_setname;
87 struct Multi::Backend {
89 std::string m_backend_database;
93 void operator() (void); // thread operation
95 struct Multi::Frontend {
100 std::list<BackendPtr> m_backend_list;
101 std::map<std::string,Multi::FrontendSet> m_sets;
103 void multi_move(std::list<BackendPtr> &blist);
104 void init(Package &package, Z_GDU *gdu);
105 void close(Package &package);
106 void search(Package &package, Z_APDU *apdu);
107 void present(Package &package, Z_APDU *apdu);
108 void scan(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;
449 const char *peer_name = yaz_oi_get_string_oid(
450 &req->otherInfo, yaz_oid_userinfo_client_ip, 1, 0);
452 yaz_oi_set_string_oid(&breq->otherInfo, odr,
453 yaz_oid_userinfo_client_ip, 1, peer_name);
455 ODR_MASK_SET(breq->options, Z_Options_search);
456 ODR_MASK_SET(breq->options, Z_Options_present);
457 ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
458 ODR_MASK_SET(breq->options, Z_Options_scan);
460 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
461 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
462 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
464 b->m_package->request() = init_apdu;
466 b->m_package->copy_filter(package);
468 multi_move(m_backend_list);
470 // create the frontend init response based on each backend init response
473 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
474 Z_InitResponse *f_resp = f_apdu->u.initResponse;
476 ODR_MASK_SET(f_resp->options, Z_Options_search);
477 ODR_MASK_SET(f_resp->options, Z_Options_present);
478 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
479 ODR_MASK_SET(f_resp->options, Z_Options_scan);
481 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
482 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
483 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
486 int no_succeeded = 0;
488 Odr_int preferredMessageSize = *req->preferredMessageSize;
489 Odr_int maximumRecordSize = *req->maximumRecordSize;
490 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
492 PackagePtr p = (*bit)->m_package;
494 if (p->session().is_closed())
496 // failed. Remove from list and increment number of failed
498 bit = m_backend_list.erase(bit);
501 Z_GDU *gdu = p->response().get();
502 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
506 Z_APDU *b_apdu = gdu->u.z3950;
507 Z_InitResponse *b_resp = b_apdu->u.initResponse;
509 // common options for all backends
510 for (i = 0; i <= Z_Options_stringSchema; i++)
512 if (!ODR_MASK_GET(b_resp->options, i))
513 ODR_MASK_CLEAR(f_resp->options, i);
515 // common protocol version
516 for (i = 0; i <= Z_ProtocolVersion_3; i++)
517 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
518 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
522 if (preferredMessageSize > *b_resp->preferredMessageSize)
523 preferredMessageSize = *b_resp->preferredMessageSize;
524 if (maximumRecordSize > *b_resp->maximumRecordSize)
525 maximumRecordSize = *b_resp->maximumRecordSize;
529 if (!f_resp->userInformationField
530 && b_resp->userInformationField)
531 f_resp->userInformationField = b_resp->userInformationField;
539 *f_resp->preferredMessageSize = preferredMessageSize;
540 *f_resp->maximumRecordSize = maximumRecordSize;
542 if (m_p->m_hide_unavailable)
544 if (no_succeeded == 0)
547 package.session().close();
555 package.session().close();
558 package.response() = f_apdu;
561 void yf::Multi::Frontend::record_diagnostics(Z_Records *records,
562 Z_DiagRecs * &z_diag,
566 // see we get any errors (AKA diagnstics)
569 if (records->which == Z_Records_NSD)
573 z_diag = (Z_DiagRecs *)
574 odr_malloc(odr, sizeof(*z_diag));
575 z_diag->num_diagRecs = 0;
576 z_diag->diagRecs = (Z_DiagRec**)
577 odr_malloc(odr, sizeof(*z_diag->diagRecs));
581 Z_DiagRec **n = (Z_DiagRec **)
583 (1 + z_diag->num_diagRecs) * sizeof(*n));
584 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
586 z_diag->diagRecs = n;
588 Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
589 nr->which = Z_DiagRec_defaultFormat;
590 nr->u.defaultFormat =
591 records->u.nonSurrogateDiagnostic;
592 z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
594 else if (records->which == Z_Records_multipleNSD)
596 Z_DiagRecs * dr =records->u.multipleNonSurDiagnostics;
600 z_diag = (Z_DiagRecs *) odr_malloc(odr, sizeof(*z_diag));
601 z_diag->num_diagRecs = 0;
602 z_diag->diagRecs = 0;
604 Z_DiagRec **n = (Z_DiagRec **)
606 (dr->num_diagRecs + z_diag->num_diagRecs) *
608 if (z_diag->num_diagRecs)
609 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs * sizeof(*n));
610 memcpy(n + z_diag->num_diagRecs,
611 dr->diagRecs, dr->num_diagRecs * sizeof(*n));
612 z_diag->diagRecs = n;
613 z_diag->num_diagRecs += dr->num_diagRecs;
616 no_successful++; // probably piggyback
619 no_successful++; // no records and no diagnostics
622 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
624 // create search request
625 Z_SearchRequest *req = apdu_req->u.searchRequest;
627 std::list<BackendPtr>::const_iterator bit;
628 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
630 PackagePtr p = (*bit)->m_package;
631 yazpp_1::GDU gdu1(apdu_req);
633 Z_SearchRequest *req1 = gdu1.get()->u.z3950->u.searchRequest;
635 // they are altered now - to disable piggyback
636 *req1->smallSetUpperBound = 0;
637 *req1->largeSetLowerBound = 1;
638 *req1->mediumSetPresentNumber = 0;
640 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
641 &req1->num_databaseNames,
642 &req1->databaseNames))
644 req1->num_databaseNames = req->num_databaseNames;
645 req1->databaseNames = req->databaseNames;
648 p->copy_filter(package);
650 multi_move(m_backend_list);
652 // look at each response
653 FrontendSet resultSet(std::string(req->resultSetName));
656 Odr_int result_set_size = 0;
657 Z_DiagRecs *z_diag = 0;
658 int no_successful = 0;
661 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
663 PackagePtr p = (*bit)->m_package;
665 // save closing package for at least one target
666 if (p->session().is_closed())
669 Z_GDU *gdu = p->response().get();
670 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
671 Z_APDU_searchResponse)
673 Z_APDU *b_apdu = gdu->u.z3950;
674 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
676 record_diagnostics(b_resp->records, z_diag, odr, no_successful);
678 BackendSet backendSet;
679 backendSet.m_backend = *bit;
680 backendSet.m_count = *b_resp->resultCount;
681 result_set_size += *b_resp->resultCount;
682 resultSet.m_backend_sets.push_back(backendSet);
686 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
687 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
689 yaz_log(YLOG_DEBUG, "no_successful=%d is_closed=%s hide_errors=%s",
691 close_p ? "true" : "false",
692 m_p->m_hide_errors ? "true" : "false");
693 *f_resp->resultCount = result_set_size;
694 if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
696 package.session().close();
697 package.response() = close_p->response();
700 if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
702 f_resp->records = (Z_Records *)
703 odr_malloc(odr, sizeof(*f_resp->records));
704 if (z_diag->num_diagRecs > 1)
706 f_resp->records->which = Z_Records_multipleNSD;
707 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
711 f_resp->records->which = Z_Records_NSD;
712 f_resp->records->u.nonSurrogateDiagnostic =
713 z_diag->diagRecs[0]->u.defaultFormat;
717 m_sets[resultSet.m_setname] = resultSet;
720 mp::util::piggyback(*req->smallSetUpperBound,
721 *req->largeSetLowerBound,
722 *req->mediumSetPresentNumber,
726 Package pp(package.session(), package.origin());
727 if (z_diag == 0 && number > 0)
729 pp.copy_filter(package);
730 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
731 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
732 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
733 p_req->resultSetId = req->resultSetName;
734 *p_req->resultSetStartPoint = 1;
735 *p_req->numberOfRecordsRequested = number;
736 pp.request() = p_apdu;
739 if (pp.session().is_closed())
740 package.session().close();
742 Z_GDU *gdu = pp.response().get();
743 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
744 Z_APDU_presentResponse)
746 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
747 f_resp->records = p_res->records;
748 *f_resp->numberOfRecordsReturned =
749 *p_res->numberOfRecordsReturned;
750 *f_resp->nextResultSetPosition =
751 *p_res->nextResultSetPosition;
755 package.response() = pp.response();
759 package.response() = f_apdu; // in this scope because of p
762 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
764 // create present request
765 Z_PresentRequest *req = apdu_req->u.presentRequest;
768 it = m_sets.find(std::string(req->resultSetId));
769 if (it == m_sets.end())
773 odr.create_presentResponse(
775 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
777 package.response() = apdu;
780 std::list<Multi::FrontendSet::PresentJob> jobs;
781 int start = *req->resultSetStartPoint;
782 int number = *req->numberOfRecordsRequested;
784 if (m_p->m_merge_type == round_robin)
785 it->second.round_robin(start, number, jobs);
786 else if (m_p->m_merge_type == serve_order)
787 it->second.serve_order(start, number, jobs);
791 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
792 for (jit = jobs.begin(); jit != jobs.end(); jit++)
794 yaz_log(YLOG_DEBUG, "job pos=%d", jit->m_pos);
798 std::list<BackendPtr> present_backend_list;
800 std::list<BackendSet>::const_iterator bsit;
801 bsit = it->second.m_backend_sets.begin();
802 for (; bsit != it->second.m_backend_sets.end(); bsit++)
807 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
808 for (jit = jobs.begin(); jit != jobs.end(); jit++)
810 if (jit->m_backend == bsit->m_backend)
812 if (start == -1 || jit->m_pos < start)
814 if (end == -1 || jit->m_pos > end)
821 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
822 for (jit = jobs.begin(); jit != jobs.end(); jit++)
824 if (jit->m_backend == bsit->m_backend)
826 if (jit->m_pos >= start && jit->m_pos <= end)
827 jit->m_start = start;
831 PackagePtr p = bsit->m_backend->m_package;
833 *req->resultSetStartPoint = start;
834 *req->numberOfRecordsRequested = end - start + 1;
836 p->request() = apdu_req;
837 p->copy_filter(package);
839 present_backend_list.push_back(bsit->m_backend);
842 multi_move(present_backend_list);
844 // look at each response
845 Z_DiagRecs *z_diag = 0;
846 int no_successful = 0;
850 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
851 for (; pbit != present_backend_list.end(); pbit++)
853 PackagePtr p = (*pbit)->m_package;
855 // save closing package for at least one target
856 if (p->session().is_closed())
859 Z_GDU *gdu = p->response().get();
860 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
861 Z_APDU_presentResponse)
863 Z_APDU *b_apdu = gdu->u.z3950;
864 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
866 record_diagnostics(b_resp->records, z_diag, odr, no_successful);
870 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
871 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
873 if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
875 package.session().close();
876 package.response() = close_p->response();
879 if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
881 f_resp->records = (Z_Records *)
882 odr_malloc(odr, sizeof(*f_resp->records));
883 if (z_diag->num_diagRecs > 1)
885 f_resp->records->which = Z_Records_multipleNSD;
886 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
890 f_resp->records->which = Z_Records_NSD;
891 f_resp->records->u.nonSurrogateDiagnostic =
892 z_diag->diagRecs[0]->u.defaultFormat;
895 else if (number < 0 || (size_t) number > jobs.size())
898 odr.create_presentResponse(
900 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
905 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
906 Z_Records * records = f_resp->records;
907 records->which = Z_Records_DBOSD;
908 records->u.databaseOrSurDiagnostics =
909 (Z_NamePlusRecordList *)
910 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
911 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
912 nprl->num_records = jobs.size();
913 nprl->records = (Z_NamePlusRecord**)
914 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
916 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
917 for (jit = jobs.begin(); jit != jobs.end(); jit++)
919 PackagePtr p = jit->m_backend->m_package;
921 Z_GDU *gdu = p->response().get();
922 Z_APDU *b_apdu = gdu->u.z3950;
923 int inside_pos = jit->m_pos - jit->m_start;
924 Z_Records *records = b_apdu->u.presentResponse->records;
926 if (records && records->which == Z_Records_DBOSD
928 records->u.databaseOrSurDiagnostics->num_records)
930 nprl->records[i] = (Z_NamePlusRecord*)
931 odr_malloc(odr, sizeof(Z_NamePlusRecord));
932 *nprl->records[i] = *records->
933 u.databaseOrSurDiagnostics->records[inside_pos];
934 nprl->records[i]->databaseName =
935 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
939 nprl->num_records = i; // usually same as jobs.size();
940 *f_resp->nextResultSetPosition = start + i;
941 *f_resp->numberOfRecordsReturned = i;
943 package.response() = f_apdu;
946 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
948 return m_norm_term < k.m_norm_term;
951 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
953 return m_norm_term == k.m_norm_term;
956 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
958 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
959 e->which = Z_Entry_termInfo;
961 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
962 t->suggestedAttributes = 0;
964 t->alternativeTerm = 0;
966 t->otherTermInfo = 0;
967 t->globalOccurrences = odr_intdup(odr, m_count);
968 t->term = (Z_Term *) odr_malloc(odr, sizeof(*t->term));
969 t->term->which = Z_Term_general;
970 t->term->u.general = odr_create_Odr_oct(odr,
971 #if YAZ_VERSIONL < 0x50000
974 m_norm_term.c_str(), m_norm_term.size());
978 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
980 std::list<BackendPtr>::const_iterator bit;
981 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
983 PackagePtr p = (*bit)->m_package;
986 p->request() = apdu_req;
987 p->copy_filter(package);
989 multi_move(m_backend_list);
990 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
992 PackagePtr p = (*bit)->m_package;
994 if (p->session().is_closed()) // if any backend closes, close frontend
995 package.session().close();
997 package.response() = p->response();
1002 void yf::Multi::Frontend::scan(mp::Package &package, Z_APDU *apdu_req)
1004 Z_ScanRequest *req = apdu_req->u.scanRequest;
1006 std::list<BackendPtr>::const_iterator bit;
1007 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1009 PackagePtr p = (*bit)->m_package;
1010 yazpp_1::GDU gdu1(apdu_req);
1012 Z_ScanRequest *req1 = gdu1.get()->u.z3950->u.scanRequest;
1014 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
1015 &req1->num_databaseNames,
1016 &req1->databaseNames))
1018 req1->num_databaseNames = req->num_databaseNames;
1019 req1->databaseNames = req->databaseNames;
1021 p->request() = gdu1;
1022 p->copy_filter(package);
1024 multi_move(m_backend_list);
1026 ScanTermInfoList entries_before;
1027 ScanTermInfoList entries_after;
1031 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1033 PackagePtr p = (*bit)->m_package;
1035 if (p->session().is_closed()) // if any backend closes, close frontend
1036 package.session().close();
1038 Z_GDU *gdu = p->response().get();
1039 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1040 Z_APDU_scanResponse)
1042 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
1044 if (res->entries && res->entries->nonsurrogateDiagnostics)
1048 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1049 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1051 f_res->entries->nonsurrogateDiagnostics =
1052 res->entries->nonsurrogateDiagnostics;
1053 f_res->entries->num_nonsurrogateDiagnostics =
1054 res->entries->num_nonsurrogateDiagnostics;
1056 package.response() = f_apdu;
1060 if (res->entries && res->entries->entries)
1062 Z_Entry **entries = res->entries->entries;
1063 int num_entries = res->entries->num_entries;
1065 if (req->preferredPositionInResponse)
1066 position = *req->preferredPositionInResponse;
1067 if (res->positionOfTerm)
1068 position = *res->positionOfTerm;
1072 for (i = 0; i<position-1 && i<num_entries; i++)
1074 Z_Entry *ent = entries[i];
1076 if (ent->which == Z_Entry_termInfo)
1080 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1081 my.m_count = occur ? *occur : 0;
1083 if (ent->u.termInfo->term->which == Z_Term_general)
1085 my.m_norm_term = std::string(
1087 ent->u.termInfo->term->u.general->buf,
1088 ent->u.termInfo->term->u.general->len);
1090 if (my.m_norm_term.length())
1092 ScanTermInfoList::iterator it =
1093 entries_before.begin();
1094 while (it != entries_before.end() && my <*it)
1096 if (it != entries_before.end() && my == *it)
1098 it->m_count += my.m_count;
1102 entries_before.insert(it, my);
1113 for ( ; i<num_entries; i++)
1115 Z_Entry *ent = entries[i];
1117 if (ent->which == Z_Entry_termInfo)
1121 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1122 my.m_count = occur ? *occur : 0;
1124 if (ent->u.termInfo->term->which == Z_Term_general)
1126 my.m_norm_term = std::string(
1128 ent->u.termInfo->term->u.general->buf,
1129 ent->u.termInfo->term->u.general->len);
1131 if (my.m_norm_term.length())
1133 ScanTermInfoList::iterator it =
1134 entries_after.begin();
1135 while (it != entries_after.end() && *it < my)
1137 if (it != entries_after.end() && my == *it)
1139 it->m_count += my.m_count;
1143 entries_after.insert(it, my);
1154 // if any target does not return scan response - return that
1155 package.response() = p->response();
1162 std::cout << "BEFORE\n";
1163 ScanTermInfoList::iterator it = entries_before.begin();
1164 for(; it != entries_before.end(); it++)
1166 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1169 std::cout << "AFTER\n";
1170 it = entries_after.begin();
1171 for(; it != entries_after.end(); it++)
1173 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1180 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1181 package.response() = f_apdu;
1186 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1187 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1189 int number_returned = *req->numberOfTermsRequested;
1190 int position_returned = *req->preferredPositionInResponse;
1192 resp->entries->num_entries = number_returned;
1193 resp->entries->entries = (Z_Entry**)
1194 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1197 int lbefore = entries_before.size();
1198 if (lbefore < position_returned-1)
1199 position_returned = lbefore+1;
1201 ScanTermInfoList::iterator it = entries_before.begin();
1202 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1204 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1207 it = entries_after.begin();
1209 if (position_returned <= 0)
1212 i = position_returned-1;
1213 for (; i<number_returned && it != entries_after.end(); i++, it++)
1215 resp->entries->entries[i] = it->get_entry(odr);
1218 number_returned = i;
1220 resp->positionOfTerm = odr_intdup(odr, position_returned);
1221 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1222 resp->entries->num_entries = number_returned;
1224 package.response() = f_apdu;
1229 void yf::Multi::process(mp::Package &package) const
1231 FrontendPtr f = m_p->get_frontend(package);
1233 Z_GDU *gdu = package.request().get();
1235 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1236 Z_APDU_initRequest && !f->m_is_multi)
1238 f->init(package, gdu);
1240 else if (!f->m_is_multi)
1242 else if (gdu && gdu->which == Z_GDU_Z3950)
1244 Z_APDU *apdu = gdu->u.z3950;
1245 if (apdu->which == Z_APDU_initRequest)
1249 package.response() = odr.create_close(
1251 Z_Close_protocolError,
1254 package.session().close();
1256 else if (apdu->which == Z_APDU_searchRequest)
1258 f->search(package, apdu);
1260 else if (apdu->which == Z_APDU_presentRequest)
1262 f->present(package, apdu);
1264 else if (apdu->which == Z_APDU_scanRequest)
1266 f->scan(package, apdu);
1268 else if (apdu->which == Z_APDU_close)
1270 f->relay_apdu(package, apdu);
1276 package.response() = odr.create_close(
1277 apdu, Z_Close_protocolError,
1278 "unsupported APDU in filter multi");
1280 package.session().close();
1283 m_p->release_frontend(package);
1286 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1289 for (ptr = ptr->children; ptr; ptr = ptr->next)
1291 if (ptr->type != XML_ELEMENT_NODE)
1293 if (!strcmp((const char *) ptr->name, "target"))
1296 std::string route = mp::xml::get_route(ptr, auth);
1297 std::string target = mp::xml::get_text(ptr);
1298 if (target.length() == 0)
1300 m_p->m_route_patterns.push_back(Multi::Map(target, route, auth));
1302 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1304 m_p->m_hide_unavailable = true;
1306 else if (!strcmp((const char *) ptr->name, "hideerrors"))
1308 m_p->m_hide_errors = true;
1310 else if (!strcmp((const char *) ptr->name, "mergetype"))
1312 std::string mergetype = mp::xml::get_text(ptr);
1313 if (mergetype == "roundrobin")
1314 m_p->m_merge_type = round_robin;
1315 else if (mergetype == "serveorder")
1316 m_p->m_merge_type = serve_order;
1318 throw mp::filter::FilterException
1319 ("Bad mergetype " + mergetype + " in multi filter");
1324 throw mp::filter::FilterException
1326 + std::string((const char *) ptr->name)
1327 + " in multi filter");
1332 static mp::filter::Base* filter_creator()
1334 return new mp::filter::Multi;
1338 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1349 * c-file-style: "Stroustrup"
1350 * indent-tabs-mode: nil
1352 * vim: shiftwidth=4 tabstop=8 expandtab