1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 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));
569 Odr_int result_set_size = 0;
570 Z_Records *z_records_diag = 0; // no diagnostics (yet)
571 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
573 PackagePtr p = (*bit)->m_package;
575 if (p->session().is_closed()) // if any backend closes, close frontend
576 package.session().close();
578 Z_GDU *gdu = p->response().get();
579 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
580 Z_APDU_searchResponse)
582 Z_APDU *b_apdu = gdu->u.z3950;
583 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
585 // see we get any errors (AKA diagnstics)
588 if (b_resp->records->which == Z_Records_NSD
589 || b_resp->records->which == Z_Records_multipleNSD)
590 z_records_diag = b_resp->records;
591 // we may set this multiple times (TOO BAD!)
593 BackendSet backendSet;
594 backendSet.m_backend = *bit;
595 backendSet.m_count = *b_resp->resultCount;
596 result_set_size += *b_resp->resultCount;
597 resultSet.m_backend_sets.push_back(backendSet);
601 // if any target does not return search response - return that
602 package.response() = p->response();
608 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
609 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
611 *f_resp->resultCount = result_set_size;
615 f_resp->records = z_records_diag;
616 package.response() = f_apdu;
620 m_sets[resultSet.m_setname] = resultSet;
623 mp::util::piggyback(smallSetUpperBound,
625 mediumSetPresentNumber,
629 Package pp(package.session(), package.origin());
632 pp.copy_filter(package);
633 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
634 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
635 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
636 p_req->resultSetId = req->resultSetName;
637 *p_req->resultSetStartPoint = 1;
638 *p_req->numberOfRecordsRequested = number;
639 pp.request() = p_apdu;
642 if (pp.session().is_closed())
643 package.session().close();
645 Z_GDU *gdu = pp.response().get();
646 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
647 Z_APDU_presentResponse)
649 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
650 f_resp->records = p_res->records;
651 *f_resp->numberOfRecordsReturned =
652 *p_res->numberOfRecordsReturned;
653 *f_resp->nextResultSetPosition =
654 *p_res->nextResultSetPosition;
658 package.response() = pp.response();
662 package.response() = f_apdu; // in this scope because of p
665 void yf::Multi::Frontend::present(mp::Package &package, Z_APDU *apdu_req)
667 // create present request
668 Z_PresentRequest *req = apdu_req->u.presentRequest;
671 it = m_sets.find(std::string(req->resultSetId));
672 if (it == m_sets.end())
676 odr.create_presentResponse(
678 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
680 package.response() = apdu;
683 std::list<Multi::FrontendSet::PresentJob> jobs;
684 int start = *req->resultSetStartPoint;
685 int number = *req->numberOfRecordsRequested;
687 if (m_p->m_merge_type == round_robin)
688 it->second.round_robin(start, number, jobs);
689 else if (m_p->m_merge_type == serve_order)
690 it->second.serve_order(start, number, jobs);
694 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
695 for (jit = jobs.begin(); jit != jobs.end(); jit++)
697 yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
701 std::list<BackendPtr> present_backend_list;
703 std::list<BackendSet>::const_iterator bsit;
704 bsit = it->second.m_backend_sets.begin();
705 for (; bsit != it->second.m_backend_sets.end(); bsit++)
710 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
711 for (jit = jobs.begin(); jit != jobs.end(); jit++)
713 if (jit->m_backend == bsit->m_backend)
715 if (start == -1 || jit->m_pos < start)
717 if (end == -1 || jit->m_pos > end)
724 std::list<Multi::FrontendSet::PresentJob>::iterator jit;
725 for (jit = jobs.begin(); jit != jobs.end(); jit++)
727 if (jit->m_backend == bsit->m_backend)
729 if (jit->m_pos >= start && jit->m_pos <= end)
730 jit->m_start = start;
734 PackagePtr p = bsit->m_backend->m_package;
736 *req->resultSetStartPoint = start;
737 *req->numberOfRecordsRequested = end - start + 1;
739 p->request() = apdu_req;
740 p->copy_filter(package);
742 present_backend_list.push_back(bsit->m_backend);
745 multi_move(present_backend_list);
747 // look at each response
748 Z_Records *z_records_diag = 0;
750 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
751 for (; pbit != present_backend_list.end(); pbit++)
753 PackagePtr p = (*pbit)->m_package;
755 if (p->session().is_closed()) // if any backend closes, close frontend
756 package.session().close();
758 Z_GDU *gdu = p->response().get();
759 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
760 Z_APDU_presentResponse)
762 Z_APDU *b_apdu = gdu->u.z3950;
763 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
765 // see we get any errors (AKA diagnstics)
768 if (b_resp->records->which != Z_Records_DBOSD)
769 z_records_diag = b_resp->records;
770 // we may set this multiple times (TOO BAD!)
775 // if any target does not return present response - return that
776 package.response() = p->response();
782 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
783 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
787 f_resp->records = z_records_diag;
788 *f_resp->presentStatus = Z_PresentStatus_failure;
790 else if (number < 0 || (size_t) number > jobs.size())
793 odr.create_presentResponse(
795 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
800 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
801 Z_Records * records = f_resp->records;
802 records->which = Z_Records_DBOSD;
803 records->u.databaseOrSurDiagnostics =
804 (Z_NamePlusRecordList *)
805 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
806 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
807 nprl->num_records = jobs.size();
808 nprl->records = (Z_NamePlusRecord**)
809 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
811 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
812 for (jit = jobs.begin(); jit != jobs.end(); jit++, i++)
814 PackagePtr p = jit->m_backend->m_package;
816 Z_GDU *gdu = p->response().get();
817 Z_APDU *b_apdu = gdu->u.z3950;
818 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
820 nprl->records[i] = (Z_NamePlusRecord*)
821 odr_malloc(odr, sizeof(Z_NamePlusRecord));
822 int inside_pos = jit->m_pos - jit->m_start;
823 if (inside_pos >= b_resp->records->
824 u.databaseOrSurDiagnostics->num_records)
826 *nprl->records[i] = *b_resp->records->
827 u.databaseOrSurDiagnostics->records[inside_pos];
828 nprl->records[i]->databaseName =
829 odr_strdup(odr, jit->m_backend->m_vhost.c_str());
831 nprl->num_records = i; // usually same as jobs.size();
832 *f_resp->nextResultSetPosition = start + i;
833 *f_resp->numberOfRecordsReturned = i;
835 package.response() = f_apdu;
838 void yf::Multi::Frontend::scan1(mp::Package &package, Z_APDU *apdu_req)
840 if (m_backend_list.size() > 1)
844 odr.create_scanResponse(
845 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
846 package.response() = f_apdu;
849 Z_ScanRequest *req = apdu_req->u.scanRequest;
851 int default_num_db = req->num_databaseNames;
852 char **default_db = req->databaseNames;
854 std::list<BackendPtr>::const_iterator bit;
855 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
857 PackagePtr p = (*bit)->m_package;
860 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
861 &req->num_databaseNames,
862 &req->databaseNames))
864 req->num_databaseNames = default_num_db;
865 req->databaseNames = default_db;
867 p->request() = apdu_req;
868 p->copy_filter(package);
870 multi_move(m_backend_list);
872 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
874 PackagePtr p = (*bit)->m_package;
876 if (p->session().is_closed()) // if any backend closes, close frontend
877 package.session().close();
879 Z_GDU *gdu = p->response().get();
880 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
883 package.response() = p->response();
888 // if any target does not return scan response - return that
889 package.response() = p->response();
895 bool yf::Multi::ScanTermInfo::operator < (const ScanTermInfo &k) const
897 return m_norm_term < k.m_norm_term;
900 bool yf::Multi::ScanTermInfo::operator == (const ScanTermInfo &k) const
902 return m_norm_term == k.m_norm_term;
905 Z_Entry *yf::Multi::ScanTermInfo::get_entry(ODR odr)
907 Z_Entry *e = (Z_Entry *)odr_malloc(odr, sizeof(*e));
908 e->which = Z_Entry_termInfo;
910 t = e->u.termInfo = (Z_TermInfo *) odr_malloc(odr, sizeof(*t));
911 t->suggestedAttributes = 0;
913 t->alternativeTerm = 0;
915 t->otherTermInfo = 0;
916 t->globalOccurrences = odr_intdup(odr, m_count);
918 odr_malloc(odr, sizeof(*t->term));
919 t->term->which = Z_Term_general;
921 t->term->u.general = o = (Odr_oct *)odr_malloc(odr, sizeof(Odr_oct));
923 o->len = o->size = m_norm_term.size();
924 o->buf = (unsigned char *) odr_malloc(odr, o->len);
925 memcpy(o->buf, m_norm_term.c_str(), o->len);
929 void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
931 std::list<BackendPtr>::const_iterator bit;
932 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
934 PackagePtr p = (*bit)->m_package;
937 p->request() = apdu_req;
938 p->copy_filter(package);
940 multi_move(m_backend_list);
941 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
943 PackagePtr p = (*bit)->m_package;
945 if (p->session().is_closed()) // if any backend closes, close frontend
946 package.session().close();
948 package.response() = p->response();
953 void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
955 Z_ScanRequest *req = apdu_req->u.scanRequest;
957 int default_num_db = req->num_databaseNames;
958 char **default_db = req->databaseNames;
960 std::list<BackendPtr>::const_iterator bit;
961 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
963 PackagePtr p = (*bit)->m_package;
966 if (!mp::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
967 &req->num_databaseNames,
968 &req->databaseNames))
970 req->num_databaseNames = default_num_db;
971 req->databaseNames = default_db;
973 p->request() = apdu_req;
974 p->copy_filter(package);
976 multi_move(m_backend_list);
978 ScanTermInfoList entries_before;
979 ScanTermInfoList entries_after;
983 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
985 PackagePtr p = (*bit)->m_package;
987 if (p->session().is_closed()) // if any backend closes, close frontend
988 package.session().close();
990 Z_GDU *gdu = p->response().get();
991 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
994 Z_ScanResponse *res = gdu->u.z3950->u.scanResponse;
996 if (res->entries && res->entries->nonsurrogateDiagnostics)
1000 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, 0);
1001 Z_ScanResponse *f_res = f_apdu->u.scanResponse;
1003 f_res->entries->nonsurrogateDiagnostics =
1004 res->entries->nonsurrogateDiagnostics;
1005 f_res->entries->num_nonsurrogateDiagnostics =
1006 res->entries->num_nonsurrogateDiagnostics;
1008 package.response() = f_apdu;
1012 if (res->entries && res->entries->entries)
1014 Z_Entry **entries = res->entries->entries;
1015 int num_entries = res->entries->num_entries;
1017 if (req->preferredPositionInResponse)
1018 position = *req->preferredPositionInResponse;
1019 if (res->positionOfTerm)
1020 position = *res->positionOfTerm;
1024 for (i = 0; i<position-1 && i<num_entries; i++)
1026 Z_Entry *ent = entries[i];
1028 if (ent->which == Z_Entry_termInfo)
1032 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1033 my.m_count = occur ? *occur : 0;
1035 if (ent->u.termInfo->term->which == Z_Term_general)
1037 my.m_norm_term = std::string(
1039 ent->u.termInfo->term->u.general->buf,
1040 ent->u.termInfo->term->u.general->len);
1042 if (my.m_norm_term.length())
1044 ScanTermInfoList::iterator it =
1045 entries_before.begin();
1046 while (it != entries_before.end() && my <*it)
1050 it->m_count += my.m_count;
1054 entries_before.insert(it, my);
1065 for ( ; i<num_entries; i++)
1067 Z_Entry *ent = entries[i];
1069 if (ent->which == Z_Entry_termInfo)
1073 Odr_int *occur = ent->u.termInfo->globalOccurrences;
1074 my.m_count = occur ? *occur : 0;
1076 if (ent->u.termInfo->term->which == Z_Term_general)
1078 my.m_norm_term = std::string(
1080 ent->u.termInfo->term->u.general->buf,
1081 ent->u.termInfo->term->u.general->len);
1083 if (my.m_norm_term.length())
1085 ScanTermInfoList::iterator it =
1086 entries_after.begin();
1087 while (it != entries_after.end() && *it < my)
1091 it->m_count += my.m_count;
1095 entries_after.insert(it, my);
1106 // if any target does not return scan response - return that
1107 package.response() = p->response();
1114 std::cout << "BEFORE\n";
1115 ScanTermInfoList::iterator it = entries_before.begin();
1116 for(; it != entries_before.end(); it++)
1118 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1121 std::cout << "AFTER\n";
1122 it = entries_after.begin();
1123 for(; it != entries_after.end(); it++)
1125 std::cout << " " << it->m_norm_term << " " << it->m_count << "\n";
1132 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 1, "not implemented");
1133 package.response() = f_apdu;
1138 Z_APDU *f_apdu = odr.create_scanResponse(apdu_req, 0, 0);
1139 Z_ScanResponse *resp = f_apdu->u.scanResponse;
1141 int number_returned = *req->numberOfTermsRequested;
1142 int position_returned = *req->preferredPositionInResponse;
1144 resp->entries->num_entries = number_returned;
1145 resp->entries->entries = (Z_Entry**)
1146 odr_malloc(odr, sizeof(Z_Entry*) * number_returned);
1149 int lbefore = entries_before.size();
1150 if (lbefore < position_returned-1)
1151 position_returned = lbefore+1;
1153 ScanTermInfoList::iterator it = entries_before.begin();
1154 for (i = 0; i<position_returned-1 && it != entries_before.end(); i++, it++)
1156 resp->entries->entries[position_returned-2-i] = it->get_entry(odr);
1159 it = entries_after.begin();
1161 if (position_returned <= 0)
1164 i = position_returned-1;
1165 for (; i<number_returned && it != entries_after.end(); i++, it++)
1167 resp->entries->entries[i] = it->get_entry(odr);
1170 number_returned = i;
1172 resp->positionOfTerm = odr_intdup(odr, position_returned);
1173 resp->numberOfEntriesReturned = odr_intdup(odr, number_returned);
1174 resp->entries->num_entries = number_returned;
1176 package.response() = f_apdu;
1181 void yf::Multi::process(mp::Package &package) const
1183 FrontendPtr f = m_p->get_frontend(package);
1185 Z_GDU *gdu = package.request().get();
1187 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1188 Z_APDU_initRequest && !f->m_is_multi)
1190 f->init(package, gdu);
1192 else if (!f->m_is_multi)
1194 else if (gdu && gdu->which == Z_GDU_Z3950)
1196 Z_APDU *apdu = gdu->u.z3950;
1197 if (apdu->which == Z_APDU_initRequest)
1201 package.response() = odr.create_close(
1203 Z_Close_protocolError,
1206 package.session().close();
1208 else if (apdu->which == Z_APDU_searchRequest)
1210 f->search(package, apdu);
1212 else if (apdu->which == Z_APDU_presentRequest)
1214 f->present(package, apdu);
1216 else if (apdu->which == Z_APDU_scanRequest)
1218 f->scan2(package, apdu);
1220 else if (apdu->which == Z_APDU_close)
1222 f->relay_apdu(package, apdu);
1228 package.response() = odr.create_close(
1229 apdu, Z_Close_protocolError,
1230 "unsupported APDU in filter multi");
1232 package.session().close();
1235 m_p->release_frontend(package);
1238 void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
1241 for (ptr = ptr->children; ptr; ptr = ptr->next)
1243 if (ptr->type != XML_ELEMENT_NODE)
1245 if (!strcmp((const char *) ptr->name, "target"))
1247 std::string route = mp::xml::get_route(ptr);
1248 std::string target = mp::xml::get_text(ptr);
1249 m_p->m_route_patterns.push_back(Multi::Map(target, route));
1251 else if (!strcmp((const char *) ptr->name, "hideunavailable"))
1253 m_p->m_hide_unavailable = true;
1255 else if (!strcmp((const char *) ptr->name, "mergetype"))
1257 std::string mergetype = mp::xml::get_text(ptr);
1258 if (mergetype == "roundrobin")
1259 m_p->m_merge_type = round_robin;
1260 else if (mergetype == "serveorder")
1261 m_p->m_merge_type = serve_order;
1263 throw mp::filter::FilterException
1264 ("Bad mergetype " + mergetype + " in multi filter");
1269 throw mp::filter::FilterException
1271 + std::string((const char *) ptr->name)
1272 + " in multi filter");
1277 static mp::filter::Base* filter_creator()
1279 return new mp::filter::Multi;
1283 struct metaproxy_1_filter_struct metaproxy_1_filter_multi = {
1294 * c-file-style: "Stroustrup"
1295 * indent-tabs-mode: nil
1297 * vim: shiftwidth=4 tabstop=8 expandtab