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
20 #include "filter_zoom.hpp"
22 #include <metaproxy/package.hpp>
23 #include <metaproxy/util.hpp>
26 #include <libxslt/xsltutils.h>
27 #include <libxslt/transform.h>
29 #include <boost/thread/mutex.hpp>
30 #include <boost/thread/condition.hpp>
33 #include <yaz/oid_db.h>
34 #include <yaz/diagbib1.h>
37 #include <yaz/querytowrbuf.h>
39 namespace mp = metaproxy_1;
40 namespace yf = mp::filter;
42 namespace metaproxy_1 {
44 struct Zoom::Searchable : boost::noncopyable {
45 std::string authentication;
48 std::string query_encoding;
50 std::string request_syntax;
51 std::string element_set;
52 std::string record_encoding;
53 std::string transform_xsl_fname;
56 CCL_bibset ccl_bibset;
60 class Zoom::Backend : boost::noncopyable {
62 friend class Frontend;
64 ZOOM_connection m_connection;
65 ZOOM_resultset m_resultset;
66 std::string m_frontend_database;
68 xsltStylesheetPtr xsp;
70 Backend(SearchablePtr sptr);
72 void connect(std::string zurl, int *error, const char **addinfo);
73 void search_pqf(const char *pqf, Odr_int *hits,
74 int *error, const char **addinfo);
75 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
76 int *error, const char **addinfo);
77 void set_option(const char *name, const char *value);
78 int get_error(const char **addinfo);
80 class Zoom::Frontend : boost::noncopyable {
85 yazpp_1::GDU m_init_gdu;
87 void handle_package(mp::Package &package);
88 void handle_search(mp::Package &package);
89 void handle_present(mp::Package &package);
90 BackendPtr get_backend_from_databases(std::string &database,
92 const char **addinfo);
93 Z_Records *get_records(Odr_int start,
94 Odr_int number_to_present,
97 Odr_int *number_of_records_returned,
98 ODR odr, BackendPtr b,
99 Odr_oid *preferredRecordSyntax,
100 const char *element_set_name);
102 Frontend(Impl *impl);
106 friend class Frontend;
110 void process(metaproxy_1::Package & package);
111 void configure(const xmlNode * ptr, bool test_only);
113 FrontendPtr get_frontend(mp::Package &package);
114 void release_frontend(mp::Package &package);
115 void parse_torus(const xmlNode *ptr);
117 std::list<Zoom::SearchablePtr>m_searchables;
119 std::map<mp::Session, FrontendPtr> m_clients;
120 boost::mutex m_mutex;
121 boost::condition m_cond_session_ready;
127 // define Pimpl wrapper forwarding to Impl
129 yf::Zoom::Zoom() : m_p(new Impl)
134 { // must have a destructor because of boost::scoped_ptr
137 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
139 m_p->configure(xmlnode, test_only);
142 void yf::Zoom::process(mp::Package &package) const
144 m_p->process(package);
148 // define Implementation stuff
150 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
152 m_connection = ZOOM_connection_create(0);
157 yf::Zoom::Backend::~Backend()
160 xsltFreeStylesheet(xsp);
161 ZOOM_connection_destroy(m_connection);
162 ZOOM_resultset_destroy(m_resultset);
165 void yf::Zoom::Backend::connect(std::string zurl,
166 int *error, const char **addinfo)
168 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
169 *error = ZOOM_connection_error(m_connection, 0, addinfo);
172 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
173 int *error, const char **addinfo)
175 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
176 *error = ZOOM_connection_error(m_connection, 0, addinfo);
178 *hits = ZOOM_resultset_size(m_resultset);
183 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
185 int *error, const char **addinfo)
187 ZOOM_resultset_records(m_resultset, recs, start, number);
188 *error = ZOOM_connection_error(m_connection, 0, addinfo);
191 void yf::Zoom::Backend::set_option(const char *name, const char *value)
193 ZOOM_connection_option_set(m_connection, name, value);
195 ZOOM_resultset_option_set(m_resultset, name, value);
198 int yf::Zoom::Backend::get_error(const char **addinfo)
200 return ZOOM_connection_error(m_connection, 0, addinfo);
203 yf::Zoom::Searchable::Searchable()
206 use_turbomarc = true;
207 ccl_bibset = ccl_qual_mk();
210 yf::Zoom::Searchable::~Searchable()
212 ccl_qual_rm(&ccl_bibset);
215 yf::Zoom::Frontend::Frontend(Impl *impl) :
216 m_p(impl), m_is_virtual(false), m_in_use(true)
220 yf::Zoom::Frontend::~Frontend()
224 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
226 boost::mutex::scoped_lock lock(m_mutex);
228 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
232 it = m_clients.find(package.session());
233 if (it == m_clients.end())
236 if (!it->second->m_in_use)
238 it->second->m_in_use = true;
241 m_cond_session_ready.wait(lock);
243 FrontendPtr f(new Frontend(this));
244 m_clients[package.session()] = f;
249 void yf::Zoom::Impl::release_frontend(mp::Package &package)
251 boost::mutex::scoped_lock lock(m_mutex);
252 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
254 it = m_clients.find(package.session());
255 if (it != m_clients.end())
257 if (package.session().is_closed())
263 it->second->m_in_use = false;
265 m_cond_session_ready.notify_all();
269 yf::Zoom::Impl::Impl()
273 yf::Zoom::Impl::~Impl()
277 void yf::Zoom::Impl::parse_torus(const xmlNode *ptr1)
281 for (ptr1 = ptr1->children; ptr1; ptr1 = ptr1->next)
283 if (ptr1->type != XML_ELEMENT_NODE)
285 if (!strcmp((const char *) ptr1->name, "record"))
287 const xmlNode *ptr2 = ptr1;
288 for (ptr2 = ptr2->children; ptr2; ptr2 = ptr2->next)
290 if (ptr2->type != XML_ELEMENT_NODE)
292 if (!strcmp((const char *) ptr2->name, "layer"))
294 Zoom::SearchablePtr s(new Searchable);
296 const xmlNode *ptr3 = ptr2;
297 for (ptr3 = ptr3->children; ptr3; ptr3 = ptr3->next)
299 if (ptr3->type != XML_ELEMENT_NODE)
301 if (!strcmp((const char *) ptr3->name,
304 s->authentication = mp::xml::get_text(ptr3);
306 else if (!strcmp((const char *) ptr3->name, "id"))
308 s->database = mp::xml::get_text(ptr3);
310 else if (!strcmp((const char *) ptr3->name, "zurl"))
312 s->target = mp::xml::get_text(ptr3);
314 else if (!strcmp((const char *) ptr3->name, "sru"))
316 s->sru = mp::xml::get_text(ptr3);
318 else if (!strcmp((const char *) ptr3->name,
321 s->query_encoding = mp::xml::get_text(ptr3);
323 else if (!strcmp((const char *) ptr3->name,
326 s->piggyback = mp::xml::get_bool(ptr3, true);
328 else if (!strcmp((const char *) ptr3->name,
331 s->request_syntax = mp::xml::get_text(ptr3);
333 else if (!strcmp((const char *) ptr3->name,
336 s->element_set = mp::xml::get_text(ptr3);
338 else if (!strcmp((const char *) ptr3->name,
341 s->record_encoding = mp::xml::get_text(ptr3);
343 else if (!strcmp((const char *) ptr3->name,
346 s->transform_xsl_fname = mp::xml::get_text(ptr3);
348 else if (!strcmp((const char *) ptr3->name,
351 ; // useTurboMarc is ignored
353 else if (!strncmp((const char *) ptr3->name,
356 std::string value = mp::xml::get_text(ptr3);
357 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
358 (const char *) ptr3->name + 7);
361 if (s->database.length() && s->target.length())
363 yaz_log(YLOG_LOG, "add db=%s target=%s turbomarc=%s",
364 s->database.c_str(), s->target.c_str(),
365 s->use_turbomarc ? "1" : "0");
366 m_searchables.push_back(s);
374 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
376 for (ptr = ptr->children; ptr; ptr = ptr->next)
378 if (ptr->type != XML_ELEMENT_NODE)
380 if (!strcmp((const char *) ptr->name, "records"))
384 else if (!strcmp((const char *) ptr->name, "torus"))
387 const struct _xmlAttr *attr;
388 for (attr = ptr->properties; attr; attr = attr->next)
390 if (!strcmp((const char *) attr->name, "url"))
391 url = mp::xml::get_text(attr->children);
393 throw mp::filter::FilterException(
394 "Bad attribute " + std::string((const char *)
397 torus.read_searchables(url);
398 xmlDoc *doc = torus.get_doc();
401 xmlNode *ptr = xmlDocGetRootElement(doc);
407 throw mp::filter::FilterException
409 + std::string((const char *) ptr->name)
410 + " in zoom filter");
415 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
416 std::string &database, int *error, const char **addinfo)
418 std::list<BackendPtr>::const_iterator map_it;
419 if (m_backend && m_backend->m_frontend_database == database)
422 std::list<Zoom::SearchablePtr>::iterator map_s =
423 m_p->m_searchables.begin();
425 std::string c_db = mp::util::database_name_normalize(database);
427 while (map_s != m_p->m_searchables.end())
429 if (c_db.compare((*map_s)->database) == 0)
433 if (map_s == m_p->m_searchables.end())
435 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
436 *addinfo = database.c_str();
441 xsltStylesheetPtr xsp = 0;
442 if ((*map_s)->transform_xsl_fname.length())
444 xmlDoc *xsp_doc = xmlParseFile((*map_s)->transform_xsl_fname.c_str());
447 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
448 *addinfo = "xmlParseFile failed";
452 xsp = xsltParseStylesheetDoc(xsp_doc);
455 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
456 *addinfo = "xsltParseStylesheetDoc failed";
463 SearchablePtr sptr = *map_s;
467 BackendPtr b(new Backend(sptr));
470 b->m_frontend_database = database;
472 if (sptr->query_encoding.length())
473 b->set_option("rpnCharset", sptr->query_encoding.c_str());
475 if (sptr->authentication.length())
476 b->set_option("user", sptr->authentication.c_str());
479 if (sptr->sru.length())
481 url = "http://" + sptr->target;
482 b->set_option("sru", sptr->sru.c_str());
487 b->connect(url, error, addinfo);
495 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
496 Odr_int number_to_present,
498 const char **addinfo,
499 Odr_int *number_of_records_returned,
502 Odr_oid *preferredRecordSyntax,
503 const char *element_set_name)
505 *number_of_records_returned = 0;
506 Z_Records *records = 0;
507 bool enable_pz2_transform = false;
509 if (start < 0 || number_to_present <= 0)
512 if (number_to_present > 10000)
513 number_to_present = 10000;
515 ZOOM_record *recs = (ZOOM_record *)
516 odr_malloc(odr, number_to_present * sizeof(*recs));
518 char oid_name_str[OID_STR_MAX];
519 const char *syntax_name = 0;
521 if (preferredRecordSyntax)
523 if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
524 && !strcmp(element_set_name, "pz2"))
526 if (b->sptr->request_syntax.length())
528 syntax_name = b->sptr->request_syntax.c_str();
529 enable_pz2_transform = true;
535 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
539 b->set_option("preferredRecordSyntax", syntax_name);
541 if (enable_pz2_transform)
543 element_set_name = "F";
544 if (b->sptr->element_set.length())
545 element_set_name = b->sptr->element_set.c_str();
548 b->set_option("elementSetName", element_set_name);
550 b->present(start, number_to_present, recs, error, addinfo);
555 for (i = 0; i < number_to_present; i++)
560 { // only return records if no error and at least one record
561 char *odr_database = odr_strdup(odr,
562 b->m_frontend_database.c_str());
563 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
564 odr_malloc(odr, sizeof(*npl));
565 *number_of_records_returned = i;
566 npl->num_records = i;
567 npl->records = (Z_NamePlusRecord **)
568 odr_malloc(odr, i * sizeof(*npl->records));
569 for (i = 0; i < number_to_present; i++)
571 Z_NamePlusRecord *npr = 0;
573 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
574 &addinfo, 0 /* diagset */);
578 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
581 else if (enable_pz2_transform)
583 char rec_type_str[100];
585 strcpy(rec_type_str, b->sptr->use_turbomarc ?
588 // prevent buffer overflow ...
589 if (b->sptr->record_encoding.length() > 0 &&
590 b->sptr->record_encoding.length() <
591 (sizeof(rec_type_str)-20))
593 strcat(rec_type_str, "; charset=");
594 strcat(rec_type_str, b->sptr->record_encoding.c_str());
598 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
600 if (rec_buf && b->xsp)
602 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
606 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
609 xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
616 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
617 npr->databaseName = odr_database;
618 npr->which = Z_NamePlusRecord_databaseRecord;
619 npr->u.databaseRecord =
620 z_ext_record_xml(odr, rec_buf, rec_len);
624 npr = zget_surrogateDiagRec(
626 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
633 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
636 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
637 npr->databaseName = odr_database;
638 npr->which = Z_NamePlusRecord_databaseRecord;
639 npr->u.databaseRecord = ext;
643 npr = zget_surrogateDiagRec(
645 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
646 "ZOOM_record, type ext");
649 npl->records[i] = npr;
651 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
652 records->which = Z_Records_DBOSD;
653 records->u.databaseOrSurDiagnostics = npl;
659 void yf::Zoom::Frontend::handle_search(mp::Package &package)
661 Z_GDU *gdu = package.request().get();
662 Z_APDU *apdu_req = gdu->u.z3950;
663 Z_APDU *apdu_res = 0;
665 Z_SearchRequest *sr = apdu_req->u.searchRequest;
666 if (sr->num_databaseNames != 1)
668 apdu_res = odr.create_searchResponse(
669 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
670 package.response() = apdu_res;
675 const char *addinfo = 0;
676 std::string db(sr->databaseNames[0]);
677 BackendPtr b = get_backend_from_databases(db, &error, &addinfo);
681 odr.create_searchResponse(
682 apdu_req, error, addinfo);
683 package.response() = apdu_res;
687 b->set_option("setname", "default");
690 Z_Query *query = sr->query;
694 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
697 pqf_wrbuf = wrbuf_alloc();
698 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
700 else if (query->which == Z_Query_type_2)
703 ccl_wrbuf = wrbuf_alloc();
704 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
705 query->u.type_2->len);
707 else if (query->which == Z_Query_type_104 &&
708 query->u.type_104->which == Z_External_CQL)
711 const char *cql = query->u.type_104->u.cql;
712 CQL_parser cp = cql_parser_create();
713 int r = cql_parser_string(cp, cql);
716 cql_parser_destroy(cp);
718 odr.create_searchResponse(apdu_req,
719 YAZ_BIB1_MALFORMED_QUERY,
721 package.response() = apdu_res;
724 struct cql_node *cn = cql_parser_result(cp);
727 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
728 yaz_log(YLOG_LOG, "cql_to_ccl_buf returned %d", r);
731 ccl_wrbuf = wrbuf_alloc();
732 wrbuf_puts(ccl_wrbuf, ccl_buf);
734 cql_parser_destroy(cp);
738 odr.create_searchResponse(apdu_req,
739 YAZ_BIB1_MALFORMED_QUERY,
740 "CQL to CCL conversion error");
741 package.response() = apdu_res;
748 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
749 package.response() = apdu_res;
756 assert(pqf_wrbuf == 0);
758 struct ccl_rpn_node *cn;
759 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
761 wrbuf_destroy(ccl_wrbuf);
764 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
767 odr.create_searchResponse(apdu_req,
768 YAZ_BIB1_MALFORMED_QUERY,
770 package.response() = apdu_res;
773 pqf_wrbuf = wrbuf_alloc();
774 ccl_pquery(pqf_wrbuf, cn);
779 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo);
781 wrbuf_destroy(pqf_wrbuf);
783 const char *element_set_name = 0;
784 Odr_int number_to_present = 0;
786 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
788 Odr_int number_of_records_returned = 0;
789 Z_Records *records = get_records(
790 0, number_to_present, &error, &addinfo,
791 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
793 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
796 apdu_res->u.searchResponse->records = records;
797 apdu_res->u.searchResponse->numberOfRecordsReturned =
798 odr_intdup(odr, number_of_records_returned);
800 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
801 package.response() = apdu_res;
804 void yf::Zoom::Frontend::handle_present(mp::Package &package)
806 Z_GDU *gdu = package.request().get();
807 Z_APDU *apdu_req = gdu->u.z3950;
808 Z_APDU *apdu_res = 0;
809 Z_PresentRequest *pr = apdu_req->u.presentRequest;
814 package.response() = odr.create_presentResponse(
815 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
818 const char *element_set_name = 0;
819 Z_RecordComposition *comp = pr->recordComposition;
820 if (comp && comp->which != Z_RecordComp_simple)
822 package.response() = odr.create_presentResponse(
824 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
827 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
828 element_set_name = comp->u.simple->u.generic;
829 Odr_int number_of_records_returned = 0;
831 const char *addinfo = 0;
832 Z_Records *records = get_records(
833 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
834 &error, &addinfo, &number_of_records_returned, odr, m_backend,
835 pr->preferredRecordSyntax, element_set_name);
837 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
840 apdu_res->u.presentResponse->records = records;
841 apdu_res->u.presentResponse->numberOfRecordsReturned =
842 odr_intdup(odr, number_of_records_returned);
844 package.response() = apdu_res;
847 void yf::Zoom::Frontend::handle_package(mp::Package &package)
849 Z_GDU *gdu = package.request().get();
852 else if (gdu->which == Z_GDU_Z3950)
854 Z_APDU *apdu_req = gdu->u.z3950;
855 if (apdu_req->which == Z_APDU_initRequest)
858 package.response() = odr.create_close(
860 Z_Close_protocolError,
863 else if (apdu_req->which == Z_APDU_searchRequest)
865 handle_search(package);
867 else if (apdu_req->which == Z_APDU_presentRequest)
869 handle_present(package);
874 package.response() = odr.create_close(
876 Z_Close_protocolError,
877 "zoom filter cannot handle this APDU");
878 package.session().close();
883 package.session().close();
887 void yf::Zoom::Impl::process(mp::Package &package)
889 FrontendPtr f = get_frontend(package);
890 Z_GDU *gdu = package.request().get();
894 f->handle_package(package);
896 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
899 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
903 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
904 Z_InitResponse *resp = apdu->u.initResponse;
907 static const int masks[] = {
912 for (i = 0; masks[i] != -1; i++)
913 if (ODR_MASK_GET(req->options, masks[i]))
914 ODR_MASK_SET(resp->options, masks[i]);
916 static const int versions[] = {
922 for (i = 0; versions[i] != -1; i++)
923 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
924 ODR_MASK_SET(resp->protocolVersion, versions[i]);
928 *resp->preferredMessageSize = *req->preferredMessageSize;
929 *resp->maximumRecordSize = *req->maximumRecordSize;
931 package.response() = apdu;
932 f->m_is_virtual = true;
937 release_frontend(package);
941 static mp::filter::Base* filter_creator()
943 return new mp::filter::Zoom;
947 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
958 * c-file-style: "Stroustrup"
959 * indent-tabs-mode: nil
961 * vim: shiftwidth=4 tabstop=8 expandtab