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;
140 multi_merge_type m_merge_type;
145 yf::Multi::Rep::Rep()
147 m_hide_unavailable = false;
148 m_hide_errors = false;
149 m_merge_type = round_robin;
152 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
154 return m_count < k.m_count;
157 yf::Multi::Frontend::Frontend(Rep *rep)
163 yf::Multi::Frontend::~Frontend()
167 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(mp::Package &package)
169 boost::mutex::scoped_lock lock(m_mutex);
171 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
175 it = m_clients.find(package.session());
176 if (it == m_clients.end())
179 if (!it->second->m_in_use)
181 it->second->m_in_use = true;
184 m_cond_session_ready.wait(lock);
186 FrontendPtr f(new Frontend(this));
187 m_clients[package.session()] = f;
192 void yf::Multi::Rep::release_frontend(mp::Package &package)
194 boost::mutex::scoped_lock lock(m_mutex);
195 std::map<mp::Session,yf::Multi::FrontendPtr>::iterator it;
197 it = m_clients.find(package.session());
198 if (it != m_clients.end())
200 if (package.session().is_closed())
202 it->second->close(package);
207 it->second->m_in_use = false;
209 m_cond_session_ready.notify_all();
213 yf::Multi::FrontendSet::FrontendSet(std::string setname)
219 yf::Multi::FrontendSet::FrontendSet()
224 yf::Multi::FrontendSet::~FrontendSet()
228 yf::Multi::Multi() : m_p(new Multi::Rep)
232 yf::Multi::~Multi() {
236 void yf::Multi::Backend::operator() (void)
238 m_package->move(m_route);
242 void yf::Multi::Frontend::close(mp::Package &package)
244 std::list<BackendPtr>::const_iterator bit;
245 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
249 b->m_package->copy_filter(package);
250 b->m_package->request() = (Z_GDU *) 0;
251 b->m_package->session().close();
252 b->m_package->move(b->m_route);
256 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
258 std::list<BackendPtr>::const_iterator bit;
259 boost::thread_group g;
260 for (bit = blist.begin(); bit != blist.end(); bit++)
262 g.add_thread(new boost::thread(**bit));
267 void yf::Multi::FrontendSet::serve_order(int start, int number,
268 std::list<PresentJob> &jobs)
271 for (i = 0; i < number; i++)
273 std::list<BackendSet>::const_iterator bsit;
275 int offset = start + i - 1;
276 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
279 if (offset >= voffset && offset < voffset + bsit->m_count)
281 PresentJob job(bsit->m_backend, offset - voffset + 1);
285 voffset += bsit->m_count;
290 void yf::Multi::FrontendSet::round_robin(int start, int number,
291 std::list<PresentJob> &jobs)
294 std::list<BackendSet>::const_iterator bsit;
295 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
302 // optimization step!
308 // find min count for each set which is > omin
309 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
311 if (bsit->m_count > omin)
313 if (no_left == 0 || bsit->m_count < min)
318 if (no_left == 0) // if nothing greater than omin, bail out.
320 int skip = no_left * min;
321 if (p + skip > start) // step gets us "into" present range?
323 // Yes. skip until start.. Rounding off is deliberate!
324 min = (start-p) / no_left;
327 // update positions in each set..
328 std::list<int>::iterator psit = pos.begin();
329 for (psit = pos.begin(); psit != pos.end(); psit++)
333 // skip on each set.. before "present range"..
336 std::list<int>::iterator psit = pos.begin();
337 for (psit = pos.begin(); psit != pos.end(); psit++)
340 omin = min; // update so we consider next class (with higher count)
348 std::list<int>::iterator psit = pos.begin();
349 bsit = m_backend_sets.begin();
351 for (; bsit != m_backend_sets.end(); psit++,bsit++)
353 if (fetched >= number)
358 if (*psit <= bsit->m_count)
362 PresentJob job(bsit->m_backend, *psit);
374 void yf::Multi::Frontend::init(mp::Package &package, Z_GDU *gdu)
376 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
378 std::list<std::string> targets;
380 mp::util::get_vhost_otherinfo(req->otherInfo, targets);
382 if (targets.size() < 1)
388 std::list<std::string>::const_iterator t_it = targets.begin();
389 for (; t_it != targets.end(); t_it++)
392 Backend *b = new Backend;
395 std::list<Multi::Map>::const_iterator it =
396 m_p->m_route_patterns.begin();
397 while (it != m_p->m_route_patterns.end()) {
398 if (it->match(*t_it, &b->m_route))
402 // b->m_route = m_p->m_target_route[*t_it];
404 b->m_package = PackagePtr(new Package(s, package.origin()));
406 m_backend_list.push_back(BackendPtr(b));
410 // create init request
411 std::list<BackendPtr>::iterator bit;
412 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
416 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
418 std::list<std::string>vhost_one;
419 vhost_one.push_back(b->m_vhost);
420 mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
424 Z_InitRequest *breq = init_apdu->u.initRequest;
426 breq->idAuthentication = req->idAuthentication;
428 *breq->preferredMessageSize = *req->preferredMessageSize;
429 *breq->maximumRecordSize = *req->maximumRecordSize;
431 ODR_MASK_SET(breq->options, Z_Options_search);
432 ODR_MASK_SET(breq->options, Z_Options_present);
433 ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
434 ODR_MASK_SET(breq->options, Z_Options_scan);
436 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
437 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
438 ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
440 b->m_package->request() = init_apdu;
442 b->m_package->copy_filter(package);
444 multi_move(m_backend_list);
446 // create the frontend init response based on each backend init response
449 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
450 Z_InitResponse *f_resp = f_apdu->u.initResponse;
452 ODR_MASK_SET(f_resp->options, Z_Options_search);
453 ODR_MASK_SET(f_resp->options, Z_Options_present);
454 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
455 ODR_MASK_SET(f_resp->options, Z_Options_scan);
457 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
458 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
459 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
462 int no_succeeded = 0;
464 Odr_int preferredMessageSize = *req->preferredMessageSize;
465 Odr_int maximumRecordSize = *req->maximumRecordSize;
466 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
468 PackagePtr p = (*bit)->m_package;
470 if (p->session().is_closed())
472 // failed. Remove from list and increment number of failed
474 bit = m_backend_list.erase(bit);
477 Z_GDU *gdu = p->response().get();
478 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
482 Z_APDU *b_apdu = gdu->u.z3950;
483 Z_InitResponse *b_resp = b_apdu->u.initResponse;
485 // common options for all backends
486 for (i = 0; i <= Z_Options_stringSchema; i++)
488 if (!ODR_MASK_GET(b_resp->options, i))
489 ODR_MASK_CLEAR(f_resp->options, i);
491 // common protocol version
492 for (i = 0; i <= Z_ProtocolVersion_3; i++)
493 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
494 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
498 if (preferredMessageSize > *b_resp->preferredMessageSize)
499 preferredMessageSize = *b_resp->preferredMessageSize;
500 if (maximumRecordSize > *b_resp->maximumRecordSize)
501 maximumRecordSize = *b_resp->maximumRecordSize;
510 *f_resp->preferredMessageSize = preferredMessageSize;
511 *f_resp->maximumRecordSize = maximumRecordSize;
513 if (m_p->m_hide_unavailable)
515 if (no_succeeded == 0)
518 package.session().close();
526 package.session().close();
529 package.response() = f_apdu;
532 void yf::Multi::Frontend::search(mp::Package &package, Z_APDU *apdu_req)
534 // create search request
535 Z_SearchRequest *req = apdu_req->u.searchRequest;
537 // save these for later
538 Odr_int smallSetUpperBound = *req->smallSetUpperBound;
539 Odr_int largeSetLowerBound = *req->largeSetLowerBound;
540 Odr_int mediumSetPresentNumber = *req->mediumSetPresentNumber;
542 // they are altered now - to disable piggyback
543 *req->smallSetUpperBound = 0;
544 *req->largeSetLowerBound = 1;
545 *req->mediumSetPresentNumber = 1;
547 int default_num_db = req->num_databaseNames;
548 char **default_db = req->databaseNames;
550 std::list<BackendPtr>::const_iterator bit;
551 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
553 PackagePtr p = (*bit)->m_package;
556 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
557 &req->num_databaseNames,
558 &req->databaseNames))
560 req->num_databaseNames = default_num_db;
561 req->databaseNames = default_db;
563 p->request() = apdu_req;
564 p->copy_filter(package);
566 multi_move(m_backend_list);
568 // look at each response
569 FrontendSet resultSet(std::string(req->resultSetName));
572 Odr_int result_set_size = 0;
573 Z_DiagRecs *z_diag = 0;
574 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
576 PackagePtr p = (*bit)->m_package;
578 if (p->session().is_closed()) // if any backend closes, close frontend
579 package.session().close();
581 Z_GDU *gdu = p->response().get();
582 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
583 Z_APDU_searchResponse)
585 Z_APDU *b_apdu = gdu->u.z3950;
586 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
588 // see we get any errors (AKA diagnstics)
591 if (b_resp->records->which == Z_Records_NSD)
595 z_diag = (Z_DiagRecs *)
596 odr_malloc(odr, sizeof(*z_diag));
597 z_diag->num_diagRecs = 0;
598 z_diag->diagRecs = (Z_DiagRec**)
599 odr_malloc(odr, sizeof(*z_diag->diagRecs));
603 Z_DiagRec **n = (Z_DiagRec **)
605 (1+z_diag->num_diagRecs) * sizeof(*n));
606 memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
608 z_diag->diagRecs = n;
610 Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
611 nr->which = Z_DiagRec_defaultFormat;
612 nr->u.defaultFormat =
613 b_resp->records->u.nonSurrogateDiagnostic;
614 z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
616 if (b_resp->records->which == Z_Records_multipleNSD)
618 // we may set this multiple times (TOO BAD!)
619 z_diag = b_resp->records->u.multipleNonSurDiagnostics;
622 BackendSet backendSet;
623 backendSet.m_backend = *bit;
624 backendSet.m_count = *b_resp->resultCount;
625 result_set_size += *b_resp->resultCount;
626 resultSet.m_backend_sets.push_back(backendSet);
630 // if any target does not return search response - return that
631 package.response() = p->response();
636 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
637 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
639 *f_resp->resultCount = result_set_size;
642 f_resp->records = (Z_Records *)
643 odr_malloc(odr, sizeof(*f_resp->records));
644 if (z_diag->num_diagRecs > 1)
646 f_resp->records->which = Z_Records_multipleNSD;
647 f_resp->records->u.multipleNonSurDiagnostics = z_diag;
651 f_resp->records->which = Z_Records_NSD;
652 f_resp->records->u.nonSurrogateDiagnostic =
653 z_diag->diagRecs[0]->u.defaultFormat;
657 m_sets[resultSet.m_setname] = resultSet;
660 mp::util::piggyback(smallSetUpperBound,
662 mediumSetPresentNumber,
666 Package pp(package.session(), package.origin());
667 if (z_diag == 0 && number > 0)
669 pp.copy_filter(package);
670 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
671 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
672 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
673 p_req->resultSetId = req->resultSetName;
674 *p_req->resultSetStartPoint = 1;
675 *p_req->numberOfRecordsRequested = number;
676 pp.request() = p_apdu;
679 if (pp.session().is_closed())
680 package.session().close();
682 Z_GDU *gdu = pp.response().get();
683 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
684 Z_APDU_presentResponse)
686 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
687 f_resp->records = p_res->records;
688 *f_resp->numberOfRecordsReturned =
689 *p_res->numberOfRecordsReturned;
690 *f_resp->nextResultSetPosition =
691 *p_res->nextResultSetPosition;
695 package.response() = pp.response();
699 package.response() = f_apdu; // in this scope because of p
702 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
704 // create present request
705 Z_PresentRequest *req = apdu_req->u.presentRequest;
708 it = m_sets.find(std::string(req->resultSetId));
709 if (it == m_sets.end())
713 odr.create_presentResponse(
715 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
717 package.response() = apdu;
720 std::list<Multi::FrontendSet::PresentJob> jobs;
721 int start = *req->resultSetStartPoint;
722 int number = *req->numberOfRecordsRequested;
724 if (m_p->m_merge_type == round_robin)
725 it->second.round_robin(start, number, jobs);
726 else if (m_p->m_merge_type == serve_order)
727 it->second.serve_order(start, number, jobs);
731 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
732 for (jit = jobs.begin(); jit != jobs.end(); jit++)
734 yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
738 std::list<BackendPtr> present_backend_list;
740 std::list<BackendSet>::const_iterator bsit;
741 bsit = it->second.m_backend_sets.begin();
742 for (; bsit != it->second.m_backend_sets.end(); bsit++)
747 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
748 for (jit = jobs.begin(); jit != jobs.end(); jit++)
750 if (jit->m_backend == bsit->m_backend)
752 if (start == -1 || jit->m_pos < start)
754 if (end == -1 || jit->m_pos > end)
761 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
762 for (jit = jobs.begin(); jit != jobs.end(); jit++)
764 if (jit->m_backend == bsit->m_backend)
766 if (jit->m_pos >= start && jit->m_pos <= end)
767 jit->m_start = start;
771 PackagePtr p = bsit->m_backend->m_package;
773 *req->resultSetStartPoint = start;
774 *req->numberOfRecordsRequested = end - start + 1;
776 p->request() = apdu_req;
777 p->copy_filter(package);
779 present_backend_list.push_back(bsit->m_backend);
782 multi_move(present_backend_list);
784 // look at each response
785 Z_Records *z_records_diag = 0;
787 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
788 for (; pbit != present_backend_list.end(); pbit++)
790 PackagePtr p = (*pbit)->m_package;
792 if (p->session().is_closed()) // if any backend closes, close frontend
793 package.session().close();
795 Z_GDU *gdu = p->response().get();
796 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
797 Z_APDU_presentResponse)
799 Z_APDU *b_apdu = gdu->u.z3950;
800 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
802 // see we get any errors (AKA diagnstics)
805 if (b_resp->records->which != Z_Records_DBOSD)
806 z_records_diag = b_resp->records;
807 // we may set this multiple times (TOO BAD!)
812 // if any target does not return present response - return that
813 package.response() = p->response();
819 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
820 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
824 f_resp->records = z_records_diag;
825 *f_resp->presentStatus = Z_PresentStatus_failure;
827 else if (number < 0 || (size_t) number > jobs.size())
830 odr.create_presentResponse(
832 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
837 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
838 Z_Records * records = f_resp->records;
839 records->which = Z_Records_DBOSD;
840 records->u.databaseOrSurDiagnostics =
841 (Z_NamePlusRecordList *)
842 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
843 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
844 nprl->num_records = jobs.size();
845 nprl->records = (Z_NamePlusRecord**)
846 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
848 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
849 for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
851 PackagePtr p = jit->m_backend->m_package;
853 Z_GDU *gdu = p->response().get();
854 Z_APDU *b_apdu = gdu->u.z3950;
855 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
857 nprl->records[i] = (Z_NamePlusRecord*)
858 odr_malloc(odr, sizeof(Z_NamePlusRecord));
859 int inside_pos = jit->m_pos - jit->m_start;
860 if (inside_pos >= b_resp->records->
861 u.databaseOrSurDiagnostics->num_records)
863 *nprl->records[i] = *b_resp->records->
864 u.databaseOrSurDiagnostics->records[inside_pos];
865 nprl->records[i]->databaseName =
866 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
868 nprl->num_records = i; // usually same as jobs.size();
869 *f_resp->nextResultSetPosition = start + i;
870 *f_resp->numberOfRecordsReturned = i;
872 package.response() = f_apdu;
875 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
877 if (m_backend_list.size() > 1)
881 odr.create_scanResponse(
882 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
883 package.response() = f_apdu;
886 Z_ScanRequest *req = apdu_req->u.scanRequest;
888 int default_num_db = req->num_databaseNames;
889 char **default_db = req->databaseNames;
891 std::list<BackendPtr>::const_iterator bit;
892 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
894 PackagePtr p = (*bit)->m_package;
897 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
898 &req->num_databaseNames,
899 &req->databaseNames))
901 req->num_databaseNames = default_num_db;
902 req->databaseNames = default_db;
904 p->request() = apdu_req;
905 p->copy_filter(package);
907 multi_move(m_backend_list);
909 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
911 PackagePtr p = (*bit)->m_package;
913 if (p->session().is_closed()) // if any backend closes, close frontend
914 package.session().close();
916 Z_GDU *gdu = p->response().get();
917 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
920 package.response() = p->response();
925 // if any target does not return scan response - return that
926 package.response() = p->response();
932 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
934 return m_norm_term < k.m_norm_term;
937 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
939 return m_norm_term == k.m_norm_term;
942 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
944 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
945 e->which = Z_Entry_termInfo;
947 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
948 t->suggestedAttributes = 0;
950 t->alternativeTerm = 0;
952 t->otherTermInfo = 0;
953 t->globalOccurrences = odr_intdup(odr, m_count);
955 odr_malloc(odr, sizeof(*t->term));
956 t->term->which = Z_Term_general;
958 t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
960 o->len = o->size = m_norm_term.size();
961 o->buf = (unsigned char *) odr_malloc(odr, o->len);
962 memcpy(o->buf, m_norm_term.c_str(), o->len);
966 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
968 std::list<BackendPtr>::const_iterator bit;
969 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
971 PackagePtr p = (*bit)->m_package;
974 p->request() = apdu_req;
975 p->copy_filter(package);
977 multi_move(m_backend_list);
978 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
980 PackagePtr p = (*bit)->m_package;
982 if (p->session().is_closed()) // if any backend closes, close frontend
983 package.session().close();
985 package.response() = p->response();
990 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
992 Z_ScanRequest *req = apdu_req->u.scanRequest;
994 int default_num_db = req->num_databaseNames;
995 char **default_db = req->databaseNames;
997 std::list<BackendPtr>::const_iterator bit;
998 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1000 PackagePtr p = (*bit)->m_package;
1003 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
1004 &req->num_databaseNames,
1005 &req->databaseNames))
1007 req->num_databaseNames = default_num_db;
1008 req->databaseNames = default_db;
1010 p->request() = apdu_req;
1011 p->copy_filter(package);
1013 multi_move(m_backend_list);
1015 ScanTermInfoList entries_before;
1016 ScanTermInfoList entries_after;
1020 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
1022 PackagePtr p = (*bit)->m_package;
1024 if (p->session().is_closed()) // if any backend closes, close frontend
1025 package.session().close();
1027 Z_GDU *gdu = p->response().get();
1028 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1029 Z_APDU_scanResponse)
1031 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
1033 if (res->entries && res->entries->nonsurrogateDiagnostics)
1037 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1038 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1040 f_res->entries->nonsurrogateDiagnostics =
1041 res->entries->nonsurrogateDiagnostics;
1042 f_res->entries->num_nonsurrogateDiagnostics =
1043 res->entries->num_nonsurrogateDiagnostics;
1045 package.response() = f_apdu;
1049 if (res->entries && res->entries->entries)
1051 Z_Entry **entries = res->entries->entries;
1052 int num_entries = res->entries->num_entries;
1054 if (req->preferredPositionInResponse)
1055 position = *req->preferredPositionInResponse;
1056 if (res->positionOfTerm)
1057 position = *res->positionOfTerm;
1061 for (i = 0; i<position-1 && i<num_entries; i++)
1063 Z_Entry *ent = entries[i];
1065 if (ent->which == Z_Entry_termInfo)
1069 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1070 my.m_count = occur ? *occur : 0;
1072 if (ent->u.termInfo->term->which == Z_Term_general)
1074 my.m_norm_term = std::string(
1076 ent->u.termInfo->term->u.general->buf,
1077 ent->u.termInfo->term->u.general->len);
1079 if (my.m_norm_term.length())
1081 ScanTermInfoList::iterator it =
1082 entries_before.begin();
1083 while (it != entries_before.end() && my <*it)
1087 it->m_count += my.m_count;
1091 entries_before.insert(it, my);
1102 for ( ; i<num_entries; i++)
1104 Z_Entry *ent = entries[i];
1106 if (ent->which == Z_Entry_termInfo)
1110 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1111 my.m_count = occur ? *occur : 0;
1113 if (ent->u.termInfo->term->which == Z_Term_general)
1115 my.m_norm_term = std::string(
1117 ent->u.termInfo->term->u.general->buf,
1118 ent->u.termInfo->term->u.general->len);
1120 if (my.m_norm_term.length())
1122 ScanTermInfoList::iterator it =
1123 entries_after.begin();
1124 while (it != entries_after.end() && *it < my)
1128 it->m_count += my.m_count;
1132 entries_after.insert(it, my);
1143 // if any target does not return scan response - return that
1144 package.response() = p->response();
1151 std::cout << "BEFORE\n";
1152 ScanTermInfoList::iterator it = entries_before.begin();
1153 for(; it != entries_before.end(); it++)
1155 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1158 std::cout << "AFTER\n";
1159 it = entries_after.begin();
1160 for(; it != entries_after.end(); it++)
1162 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1169 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1170 package.response() = f_apdu;
1175 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1176 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1178 int number_returned = *req->numberOfTermsRequested;
1179 int position_returned = *req->preferredPositionInResponse;
1181 resp->entries->num_entries = number_returned;
1182 resp->entries->entries = (Z_Entry**)
1183 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1186 int lbefore = entries_before.size();
1187 if (lbefore < position_returned-1)
1188 position_returned = lbefore+1;
1190 ScanTermInfoList::iterator it = entries_before.begin();
1191 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1193 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1196 it = entries_after.begin();
1198 if (position_returned <= 0)
1201 i = position_returned-1;
1202 for (; i<number_returned && it != entries_after.end(); i++, it++)
1204 resp->entries->entries[i] = it->get_entry(odr);
1207 number_returned = i;
1209 resp->positionOfTerm = odr_intdup(odr, position_returned);
1210 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1211 resp->entries->num_entries = number_returned;
1213 package.response() = f_apdu;
1218 void yf::Multi::process(mp::Package &package) const
1220 FrontendPtr f = m_p->get_frontend(package);
1222 Z_GDU *gdu = package.request().get();
1224 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1225 Z_APDU_initRequest && !f->m_is_multi)
1227 f->init(package, gdu);
1229 else if (!f->m_is_multi)
1231 else if (gdu && gdu->which == Z_GDU_Z3950)
1233 Z_APDU *apdu = gdu->u.z3950;
1234 if (apdu->which == Z_APDU_initRequest)
1238 package.response() = odr.create_close(
1240 Z_Close_protocolError,
1243 package.session().close();
1245 else if (apdu->which == Z_APDU_searchRequest)
1247 f->search(package, apdu);
1249 else if (apdu->which == Z_APDU_presentRequest)
1251 f->present(package, apdu);
1253 else if (apdu->which == Z_APDU_scanRequest)
1255 f->scan2(package, apdu);
1257 else if (apdu->which == Z_APDU_close)
1259 f->relay_apdu(package, apdu);
1265 package.response() = odr.create_close(
1266 apdu, Z_Close_protocolError,
1267 "unsupported APDU in filter multi");
1269 package.session().close();
1272 m_p->release_frontend(package);
1275 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1278 for (ptr = ptr->children; ptr; ptr = ptr->next)
1280 if (ptr->type != XML_ELEMENT_NODE)
1282 if (!strcmp((const char *) ptr->name, "target"))
1284 std::string route = mp::xml::get_route(ptr);
1285 std::string target = mp::xml::get_text(ptr);
1286 m_p->m_route_patterns.push_back(Multi::Map(target, route));
1288 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1290 m_p->m_hide_unavailable = true;
1292 else if (!strcmp((const char *) ptr->name, "hideerrors"))
1294 m_p->m_hide_errors = true;
1296 else if (!strcmp((const char *) ptr->name, "mergetype"))
1298 std::string mergetype = mp::xml::get_text(ptr);
1299 if (mergetype == "roundrobin")
1300 m_p->m_merge_type = round_robin;
1301 else if (mergetype == "serveorder")
1302 m_p->m_merge_type = serve_order;
1304 throw mp::filter::FilterException
1305 ("Bad mergetype " + mergetype + " in multi filter");
1310 throw mp::filter::FilterException
1312 + std::string((const char *) ptr->name)
1313 + " in multi filter");
1318 static mp::filter::Base* filter_creator()
1320 return new mp::filter::Multi;
1324 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1335 * c-file-style: "Stroustrup"
1336 * indent-tabs-mode: nil
1338 * vim: shiftwidth=4 tabstop=8 expandtab