-/* $Id: filter_multi.cpp,v 1.26 2007-03-07 22:50:12 adam Exp $
- Copyright (c) 2005-2007, Index Data.
+/* This file is part of Metaproxy.
+ Copyright (C) 2005-2012 Index Data
- See the LICENSE file for details
- */
+Metaproxy is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#include <yaz/log.h>
#include "config.hpp"
-#include "filter.hpp"
-#include "package.hpp"
+#include <metaproxy/filter.hpp>
+#include <metaproxy/package.hpp>
#include <boost/thread/thread.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition.hpp>
#include <boost/shared_ptr.hpp>
-#include "util.hpp"
+#include <metaproxy/util.hpp>
#include "filter_multi.hpp"
#include <yaz/zgdu.h>
#include <yaz/otherinfo.h>
#include <yaz/diagbib1.h>
+#include <yaz/match_glob.h>
#include <vector>
#include <algorithm>
namespace metaproxy_1 {
namespace filter {
-
+ enum multi_merge_type {
+ round_robin,
+ serve_order
+ };
struct Multi::BackendSet {
BackendPtr m_backend;
int m_count;
Z_Entry *get_entry(ODR odr);
};
struct Multi::FrontendSet {
- struct PresentJob {
+ class PresentJob {
+ public:
BackendPtr m_backend;
- int m_pos;
- int m_inside_pos;
+ int m_pos; // position for backend (1=first, 2=second,..
+ int m_start; // present request start
+ PresentJob(BackendPtr ptr, int pos) :
+ m_backend(ptr), m_pos(pos), m_start(0) {};
};
FrontendSet(std::string setname);
FrontendSet();
~FrontendSet();
void round_robin(int pos, int number, std::list<PresentJob> &job);
+ void serve_order(int pos, int number, std::list<PresentJob> &job);
std::list<BackendSet> m_backend_sets;
std::string m_setname;
void present(Package &package, Z_APDU *apdu);
void scan1(Package &package, Z_APDU *apdu);
void scan2(Package &package, Z_APDU *apdu);
+ void relay_apdu(Package &package, Z_APDU *apdu);
Rep *m_p;
};
- struct Multi::Map {
- Map(std::list<std::string> hosts, std::string route);
- Map();
- std::list<std::string> m_hosts;
+ class Multi::Map {
+ std::string m_target_pattern;
std::string m_route;
+ public:
+ Map(std::string pattern, std::string route) :
+ m_target_pattern(pattern), m_route(route) {};
+ bool match(const std::string target, std::string *ret) const {
+ if (yaz_match_glob(m_target_pattern.c_str(), target.c_str()))
+ {
+ *ret = m_route;
+ return true;
+ }
+ return false;
+ };
};
class Multi::Rep {
friend class Multi;
FrontendPtr get_frontend(Package &package);
void release_frontend(Package &package);
private:
- std::map<std::string,std::string> m_target_route;
+ std::list<Multi::Map> m_route_patterns;
boost::mutex m_mutex;
boost::condition m_cond_session_ready;
std::map<mp::Session, FrontendPtr> m_clients;
bool m_hide_unavailable;
+ bool m_hide_errors;
+ multi_merge_type m_merge_type;
};
}
}
yf::Multi::Rep::Rep()
{
m_hide_unavailable = false;
+ m_hide_errors = false;
+ m_merge_type = round_robin;
}
bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
{
}
-yf::Multi::Map::Map(std::list<std::string> hosts, std::string route)
- : m_hosts(hosts), m_route(route)
-{
-}
-
-yf::Multi::Map::Map()
-{
-}
-
yf::Multi::Multi() : m_p(new Multi::Rep)
{
}
g.join_all();
}
+void yf::Multi::FrontendSet::serve_order(int start, int number,
+ std::list<PresentJob> &jobs)
+{
+ int i;
+ for (i = 0; i < number; i++)
+ {
+ std::list<BackendSet>::const_iterator bsit;
+ int voffset = 0;
+ int offset = start + i - 1;
+ for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end();
+ bsit++)
+ {
+ if (offset >= voffset && offset < voffset + bsit->m_count)
+ {
+ PresentJob job(bsit->m_backend, offset - voffset + 1);
+ jobs.push_back(job);
+ break;
+ }
+ voffset += bsit->m_count;
+ }
+ }
+}
+
void yf::Multi::FrontendSet::round_robin(int start, int number,
std::list<PresentJob> &jobs)
{
std::list<int> pos;
- std::list<int> inside_pos;
std::list<BackendSet>::const_iterator bsit;
for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
{
pos.push_back(1);
- inside_pos.push_back(0);
}
int p = 1;
// skip on each set.. before "present range"..
p = p + skip;
- std::cout << "\nSKIP min=" << min << " no_left=" << no_left << "\n\n";
-
std::list<int>::iterator psit = pos.begin();
for (psit = pos.begin(); psit != pos.end(); psit++)
*psit += min;
{
more = false;
std::list<int>::iterator psit = pos.begin();
- std::list<int>::iterator esit = inside_pos.begin();
bsit = m_backend_sets.begin();
- for (; bsit != m_backend_sets.end(); psit++,esit++,bsit++)
+ for (; bsit != m_backend_sets.end(); psit++,bsit++)
{
if (fetched >= number)
{
{
if (p >= start)
{
- PresentJob job;
- job.m_backend = bsit->m_backend;
- job.m_pos = *psit;
- job.m_inside_pos = *esit;
+ PresentJob job(bsit->m_backend, *psit);
jobs.push_back(job);
- (*esit)++;
fetched++;
}
(*psit)++;
Backend *b = new Backend;
b->m_vhost = *t_it;
- b->m_route = m_p->m_target_route[*t_it];
+ std::list<Multi::Map>::const_iterator it =
+ m_p->m_route_patterns.begin();
+ while (it != m_p->m_route_patterns.end()) {
+ if (it->match(*t_it, &b->m_route))
+ break;
+ it++;
+ }
+ // b->m_route = m_p->m_target_route[*t_it];
// b->m_route unset
b->m_package = PackagePtr(new Package(s, package.origin()));
mp::util::set_vhost_otherinfo(&init_apdu->u.initRequest->otherInfo,
odr, vhost_one);
- Z_InitRequest *req = init_apdu->u.initRequest;
+
+ Z_InitRequest *breq = init_apdu->u.initRequest;
+
+ breq->idAuthentication = req->idAuthentication;
- ODR_MASK_SET(req->options, Z_Options_search);
- ODR_MASK_SET(req->options, Z_Options_present);
- ODR_MASK_SET(req->options, Z_Options_namedResultSets);
- ODR_MASK_SET(req->options, Z_Options_scan);
+ *breq->preferredMessageSize = *req->preferredMessageSize;
+ *breq->maximumRecordSize = *req->maximumRecordSize;
+
+ ODR_MASK_SET(breq->options, Z_Options_search);
+ ODR_MASK_SET(breq->options, Z_Options_present);
+ ODR_MASK_SET(breq->options, Z_Options_namedResultSets);
+ ODR_MASK_SET(breq->options, Z_Options_scan);
- ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
- ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
- ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
+ ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_1);
+ ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_2);
+ ODR_MASK_SET(breq->protocolVersion, Z_ProtocolVersion_3);
b->m_package->request() = init_apdu;
ODR_MASK_SET(f_resp->options, Z_Options_search);
ODR_MASK_SET(f_resp->options, Z_Options_present);
ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
+ ODR_MASK_SET(f_resp->options, Z_Options_scan);
ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
int no_failed = 0;
int no_succeeded = 0;
+
+ Odr_int preferredMessageSize = *req->preferredMessageSize;
+ Odr_int maximumRecordSize = *req->maximumRecordSize;
for (bit = m_backend_list.begin(); bit != m_backend_list.end(); )
{
PackagePtr p = (*bit)->m_package;
bit = m_backend_list.erase(bit);
continue;
}
- no_succeeded++;
-
Z_GDU *gdu = p->response().get();
if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
Z_APDU_initResponse)
for (i = 0; i <= Z_ProtocolVersion_3; i++)
if (!ODR_MASK_GET(b_resp->protocolVersion, i))
ODR_MASK_CLEAR(f_resp->protocolVersion, i);
- // reject if any of the backends reject
- if (!*b_resp->result)
- *f_resp->result = 0;
+ if (*b_resp->result)
+ {
+ no_succeeded++;
+ if (preferredMessageSize > *b_resp->preferredMessageSize)
+ preferredMessageSize = *b_resp->preferredMessageSize;
+ if (maximumRecordSize > *b_resp->maximumRecordSize)
+ maximumRecordSize = *b_resp->maximumRecordSize;
+ }
+ else
+ no_failed++;
}
else
- {
- // if any target does not return init return that (close or
- // similar )
- package.response() = p->response();
- return;
- }
+ no_failed++;
bit++;
}
+ *f_resp->preferredMessageSize = preferredMessageSize;
+ *f_resp->maximumRecordSize = maximumRecordSize;
+
if (m_p->m_hide_unavailable)
{
if (no_succeeded == 0)
+ {
+ *f_resp->result = 0;
package.session().close();
+ }
}
else
{
if (no_failed)
+ {
+ *f_resp->result = 0;
package.session().close();
+ }
}
package.response() = f_apdu;
}
Z_SearchRequest *req = apdu_req->u.searchRequest;
// save these for later
- int smallSetUpperBound = *req->smallSetUpperBound;
- int largeSetLowerBound = *req->largeSetLowerBound;
- int mediumSetPresentNumber = *req->mediumSetPresentNumber;
+ Odr_int smallSetUpperBound = *req->smallSetUpperBound;
+ Odr_int largeSetLowerBound = *req->largeSetLowerBound;
+ Odr_int mediumSetPresentNumber = *req->mediumSetPresentNumber;
// they are altered now - to disable piggyback
*req->smallSetUpperBound = 0;
// look at each response
FrontendSet resultSet(std::string(req->resultSetName));
- int result_set_size = 0;
- Z_Records *z_records_diag = 0; // no diagnostics (yet)
+ mp::odr odr;
+ Odr_int result_set_size = 0;
+ Z_DiagRecs *z_diag = 0;
+ int no_successful = 0;
+ PackagePtr close_p;
+
for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
{
PackagePtr p = (*bit)->m_package;
- if (p->session().is_closed()) // if any backend closes, close frontend
- package.session().close();
-
+ // save closing package for at least one target
+ if (p->session().is_closed())
+ close_p = p;
+
Z_GDU *gdu = p->response().get();
if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
Z_APDU_searchResponse)
{
Z_APDU *b_apdu = gdu->u.z3950;
Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
-
+
// see we get any errors (AKA diagnstics)
if (b_resp->records)
{
- if (b_resp->records->which == Z_Records_NSD
- || b_resp->records->which == Z_Records_multipleNSD)
- z_records_diag = b_resp->records;
- // we may set this multiple times (TOO BAD!)
+ if (b_resp->records->which == Z_Records_NSD)
+ {
+ if (!z_diag)
+ {
+ z_diag = (Z_DiagRecs *)
+ odr_malloc(odr, sizeof(*z_diag));
+ z_diag->num_diagRecs = 0;
+ z_diag->diagRecs = (Z_DiagRec**)
+ odr_malloc(odr, sizeof(*z_diag->diagRecs));
+ }
+ else
+ {
+ Z_DiagRec **n = (Z_DiagRec **)
+ odr_malloc(odr,
+ (1+z_diag->num_diagRecs) * sizeof(*n));
+ memcpy(n, z_diag->diagRecs, z_diag->num_diagRecs
+ * sizeof(*n));
+ z_diag->diagRecs = n;
+ }
+ Z_DiagRec *nr = (Z_DiagRec *) odr_malloc(odr, sizeof(*nr));
+ nr->which = Z_DiagRec_defaultFormat;
+ nr->u.defaultFormat =
+ b_resp->records->u.nonSurrogateDiagnostic;
+ z_diag->diagRecs[z_diag->num_diagRecs++] = nr;
+ }
+ else if (b_resp->records->which == Z_Records_multipleNSD)
+ {
+ // we may set this multiple times (TOO BAD!)
+ z_diag = b_resp->records->u.multipleNonSurDiagnostics;
+ }
+ else
+ no_successful++; // probably piggyback
}
+ else
+ no_successful++; // no records and no diagnostics
BackendSet backendSet;
backendSet.m_backend = *bit;
backendSet.m_count = *b_resp->resultCount;
result_set_size += *b_resp->resultCount;
resultSet.m_backend_sets.push_back(backendSet);
}
- else
- {
- // if any target does not return search response - return that
- package.response() = p->response();
- return;
- }
}
- mp::odr odr;
Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
+ yaz_log(YLOG_LOG, "no_successful=%d is_closed=%s hide_errors=%s",
+ no_successful,
+ close_p ? "true" : "false",
+ m_p->m_hide_errors ? "true" : "false");
*f_resp->resultCount = result_set_size;
- if (z_records_diag)
+ if (close_p && (no_successful == 0 || !m_p->m_hide_errors))
{
- // search error
- f_resp->records = z_records_diag;
- package.response() = f_apdu;
+ package.session().close();
+ package.response() = close_p->response();
return;
}
+ if (z_diag && (no_successful == 0 || !m_p->m_hide_errors))
+ {
+ f_resp->records = (Z_Records *)
+ odr_malloc(odr, sizeof(*f_resp->records));
+ if (z_diag->num_diagRecs > 1)
+ {
+ f_resp->records->which = Z_Records_multipleNSD;
+ f_resp->records->u.multipleNonSurDiagnostics = z_diag;
+ }
+ else
+ {
+ f_resp->records->which = Z_Records_NSD;
+ f_resp->records->u.nonSurrogateDiagnostic =
+ z_diag->diagRecs[0]->u.defaultFormat;
+ }
+ }
// assume OK
m_sets[resultSet.m_setname] = resultSet;
- int number;
+ Odr_int number;
mp::util::piggyback(smallSetUpperBound,
- largeSetLowerBound,
- mediumSetPresentNumber,
- result_set_size,
- number);
+ largeSetLowerBound,
+ mediumSetPresentNumber,
+ 0, 0,
+ result_set_size,
+ number, 0);
Package pp(package.session(), package.origin());
- if (number > 0)
+ if (z_diag == 0 && number > 0)
{
pp.copy_filter(package);
Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
std::list<Multi::FrontendSet::PresentJob> jobs;
int start = *req->resultSetStartPoint;
int number = *req->numberOfRecordsRequested;
- it->second.round_robin(start, number, jobs);
+
+ if (m_p->m_merge_type == round_robin)
+ it->second.round_robin(start, number, jobs);
+ else if (m_p->m_merge_type == serve_order)
+ it->second.serve_order(start, number, jobs);
+
+ if (0)
+ {
+ std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
+ for (jit = jobs.begin(); jit != jobs.end(); jit++)
+ {
+ yaz_log(YLOG_LOG, "job pos=%d", jit->m_pos);
+ }
+ }
std::list<BackendPtr> present_backend_list;
bsit = it->second.m_backend_sets.begin();
for (; bsit != it->second.m_backend_sets.end(); bsit++)
{
- std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
int start = -1;
int end = -1;
-
- for (jit = jobs.begin(); jit != jobs.end(); jit++)
{
- if (jit->m_backend == bsit->m_backend)
+ std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
+ for (jit = jobs.begin(); jit != jobs.end(); jit++)
{
- if (start == -1 || jit->m_pos < start)
- start = jit->m_pos;
- if (end == -1 || jit->m_pos > end)
- end = jit->m_pos;
+ if (jit->m_backend == bsit->m_backend)
+ {
+ if (start == -1 || jit->m_pos < start)
+ start = jit->m_pos;
+ if (end == -1 || jit->m_pos > end)
+ end = jit->m_pos;
+ }
}
}
if (start != -1)
{
+ std::list<Multi::FrontendSet::PresentJob>::iterator jit;
+ for (jit = jobs.begin(); jit != jobs.end(); jit++)
+ {
+ if (jit->m_backend == bsit->m_backend)
+ {
+ if (jit->m_pos >= start && jit->m_pos <= end)
+ jit->m_start = start;
+ }
+ }
+
PackagePtr p = bsit->m_backend->m_package;
*req->resultSetStartPoint = start;
f_resp->records = z_records_diag;
*f_resp->presentStatus = Z_PresentStatus_failure;
}
+ else if (number < 0 || (size_t) number > jobs.size())
+ {
+ f_apdu =
+ odr.create_presentResponse(
+ apdu_req,
+ YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
+ 0);
+ }
else
{
f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
nprl->records[i] = (Z_NamePlusRecord*)
odr_malloc(odr, sizeof(Z_NamePlusRecord));
- int inside_pos = jit->m_inside_pos;
+ int inside_pos = jit->m_pos - jit->m_start;
if (inside_pos >= b_resp->records->
u.databaseOrSurDiagnostics->num_records)
break;
return e;
}
+void yf::Multi::Frontend::relay_apdu(mp::Package &package, Z_APDU *apdu_req)
+{
+ std::list<BackendPtr>::const_iterator bit;
+ for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
+ {
+ PackagePtr p = (*bit)->m_package;
+ mp::odr odr;
+
+ p->request() = apdu_req;
+ p->copy_filter(package);
+ }
+ multi_move(m_backend_list);
+ for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
+ {
+ PackagePtr p = (*bit)->m_package;
+
+ if (p->session().is_closed()) // if any backend closes, close frontend
+ package.session().close();
+
+ package.response() = p->response();
+ }
+}
+
+
void yf::Multi::Frontend::scan2(mp::Package &package, Z_APDU *apdu_req)
{
Z_ScanRequest *req = apdu_req->u.scanRequest;
{
ScanTermInfo my;
- int *occur = ent->u.termInfo->globalOccurrences;
+ Odr_int *occur = ent->u.termInfo->globalOccurrences;
my.m_count = occur ? *occur : 0;
if (ent->u.termInfo->term->which == Z_Term_general)
{
ScanTermInfo my;
- int *occur = ent->u.termInfo->globalOccurrences;
+ Odr_int *occur = ent->u.termInfo->globalOccurrences;
my.m_count = occur ? *occur : 0;
if (ent->u.termInfo->term->which == Z_Term_general)
}
}
- if (true)
+ if (false)
{
std::cout << "BEFORE\n";
ScanTermInfoList::iterator it = entries_before.begin();
{
f->scan2(package, apdu);
}
+ else if (apdu->which == Z_APDU_close)
+ {
+ f->relay_apdu(package, apdu);
+ }
else
{
mp::odr odr;
m_p->release_frontend(package);
}
-void mp::filter::Multi::configure(const xmlNode * ptr)
+void mp::filter::Multi::configure(const xmlNode * ptr, bool test_only,
+ const char *path)
{
for (ptr = ptr->children; ptr; ptr = ptr->next)
{
{
std::string route = mp::xml::get_route(ptr);
std::string target = mp::xml::get_text(ptr);
- std::cout << "route=" << route << " target=" << target << "\n";
- m_p->m_target_route[target] = route;
+ m_p->m_route_patterns.push_back(Multi::Map(target, route));
}
else if (!strcmp((const char *) ptr->name, "hideunavailable"))
{
m_p->m_hide_unavailable = true;
}
+ else if (!strcmp((const char *) ptr->name, "hideerrors"))
+ {
+ m_p->m_hide_errors = true;
+ }
+ else if (!strcmp((const char *) ptr->name, "mergetype"))
+ {
+ std::string mergetype = mp::xml::get_text(ptr);
+ if (mergetype == "roundrobin")
+ m_p->m_merge_type = round_robin;
+ else if (mergetype == "serveorder")
+ m_p->m_merge_type = serve_order;
+ else
+ throw mp::filter::FilterException
+ ("Bad mergetype " + mergetype + " in multi filter");
+
+ }
else
{
throw mp::filter::FilterException
("Bad element "
+ std::string((const char *) ptr->name)
- + " in virt_db filter");
+ + " in multi filter");
}
}
}
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
- * c-file-style: "stroustrup"
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+