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>
31 #include <yaz/oid_db.h>
32 #include <yaz/diagbib1.h>
35 #include <yaz/querytowrbuf.h>
37 namespace mp = metaproxy_1;
38 namespace yf = mp::filter;
40 namespace metaproxy_1 {
42 struct Zoom::Searchable {
45 std::string query_encoding;
47 std::string request_syntax;
48 std::string element_set;
49 std::string record_encoding;
50 std::string transform_xsl_fname;
58 friend class Frontend;
60 ZOOM_connection m_connection;
61 ZOOM_resultset m_resultset;
62 std::string m_frontend_database;
64 xsltStylesheetPtr xsp;
66 Backend(SearchablePtr sptr);
68 void connect(std::string zurl, int *error, const char **addinfo);
69 void search_pqf(const char *pqf, Odr_int *hits,
70 int *error, const char **addinfo);
71 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
72 int *error, const char **addinfo);
73 void set_option(const char *name, const char *value);
74 int get_error(const char **addinfo);
76 class Zoom::Frontend {
81 yazpp_1::GDU m_init_gdu;
83 void handle_package(mp::Package &package);
84 void handle_search(mp::Package &package);
85 void handle_present(mp::Package &package);
86 BackendPtr get_backend_from_databases(std::string &database,
88 const char **addinfo);
89 Z_Records *get_records(Odr_int start,
90 Odr_int number_to_present,
93 Odr_int *number_of_records_returned,
94 ODR odr, BackendPtr b,
95 Odr_oid *preferredRecordSyntax,
96 const char *element_set_name);
102 friend class Frontend;
106 void process(metaproxy_1::Package & package);
107 void configure(const xmlNode * ptr, bool test_only);
109 FrontendPtr get_frontend(mp::Package &package);
110 void release_frontend(mp::Package &package);
111 void parse_torus(const xmlNode *ptr);
113 std::list<Zoom::SearchablePtr>m_searchables;
115 std::map<mp::Session, FrontendPtr> m_clients;
116 boost::mutex m_mutex;
117 boost::condition m_cond_session_ready;
123 // define Pimpl wrapper forwarding to Impl
125 yf::Zoom::Zoom() : m_p(new Impl)
130 { // must have a destructor because of boost::scoped_ptr
133 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
135 m_p->configure(xmlnode, test_only);
138 void yf::Zoom::process(mp::Package &package) const
140 m_p->process(package);
144 // define Implementation stuff
146 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
148 m_connection = ZOOM_connection_create(0);
152 yf::Zoom::Backend::~Backend()
155 xsltFreeStylesheet(xsp);
156 ZOOM_connection_destroy(m_connection);
157 ZOOM_resultset_destroy(m_resultset);
160 void yf::Zoom::Backend::connect(std::string zurl,
161 int *error, const char **addinfo)
163 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
164 *error = ZOOM_connection_error(m_connection, 0, addinfo);
167 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
168 int *error, const char **addinfo)
170 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
171 *error = ZOOM_connection_error(m_connection, 0, addinfo);
173 *hits = ZOOM_resultset_size(m_resultset);
178 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
180 int *error, const char **addinfo)
182 ZOOM_resultset_records(m_resultset, recs, start, number);
183 *error = ZOOM_connection_error(m_connection, 0, addinfo);
186 void yf::Zoom::Backend::set_option(const char *name, const char *value)
188 ZOOM_connection_option_set(m_connection, name, value);
190 ZOOM_resultset_option_set(m_resultset, name, value);
193 int yf::Zoom::Backend::get_error(const char **addinfo)
195 return ZOOM_connection_error(m_connection, 0, addinfo);
198 yf::Zoom::Searchable::Searchable()
201 use_turbomarc = false;
204 yf::Zoom::Searchable::~Searchable()
208 yf::Zoom::Frontend::Frontend(Impl *impl) :
209 m_p(impl), m_is_virtual(false), m_in_use(true)
213 yf::Zoom::Frontend::~Frontend()
217 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
219 boost::mutex::scoped_lock lock(m_mutex);
221 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
225 it = m_clients.find(package.session());
226 if (it == m_clients.end())
229 if (!it->second->m_in_use)
231 it->second->m_in_use = true;
234 m_cond_session_ready.wait(lock);
236 FrontendPtr f(new Frontend(this));
237 m_clients[package.session()] = f;
242 void yf::Zoom::Impl::release_frontend(mp::Package &package)
244 boost::mutex::scoped_lock lock(m_mutex);
245 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
247 it = m_clients.find(package.session());
248 if (it != m_clients.end())
250 if (package.session().is_closed())
256 it->second->m_in_use = false;
258 m_cond_session_ready.notify_all();
262 yf::Zoom::Impl::Impl()
266 yf::Zoom::Impl::~Impl()
270 void yf::Zoom::Impl::parse_torus(const xmlNode *ptr1)
274 for (ptr1 = ptr1->children; ptr1; ptr1 = ptr1->next)
276 if (ptr1->type != XML_ELEMENT_NODE)
278 if (!strcmp((const char *) ptr1->name, "record"))
280 const xmlNode *ptr2 = ptr1;
281 for (ptr2 = ptr2->children; ptr2; ptr2 = ptr2->next)
283 if (ptr2->type != XML_ELEMENT_NODE)
285 if (!strcmp((const char *) ptr2->name, "layer"))
287 Zoom::SearchablePtr s(new Searchable);
289 const xmlNode *ptr3 = ptr2;
290 for (ptr3 = ptr3->children; ptr3; ptr3 = ptr3->next)
292 if (ptr3->type != XML_ELEMENT_NODE)
294 if (!strcmp((const char *) ptr3->name, "id"))
296 s->database = mp::xml::get_text(ptr3);
298 else if (!strcmp((const char *) ptr3->name, "zurl"))
300 s->target = mp::xml::get_text(ptr3);
302 else if (!strcmp((const char *) ptr3->name, "sru"))
304 s->sru = mp::xml::get_text(ptr3);
306 else if (!strcmp((const char *) ptr3->name,
309 s->query_encoding = mp::xml::get_text(ptr3);
311 else if (!strcmp((const char *) ptr3->name,
314 s->piggyback = mp::xml::get_bool(ptr3, true);
316 else if (!strcmp((const char *) ptr3->name,
319 s->request_syntax = mp::xml::get_text(ptr3);
321 else if (!strcmp((const char *) ptr3->name,
324 s->element_set = mp::xml::get_text(ptr3);
326 else if (!strcmp((const char *) ptr3->name,
329 s->record_encoding = mp::xml::get_text(ptr3);
331 else if (!strcmp((const char *) ptr3->name,
334 s->transform_xsl_fname = mp::xml::get_text(ptr3);
336 else if (!strcmp((const char *) ptr3->name,
339 yaz_log(YLOG_LOG, "seeing useTurboMarc");
340 s->use_turbomarc = mp::xml::get_bool(ptr3, false);
341 yaz_log(YLOG_LOG, "value=%s",
342 s->use_turbomarc ? "1" : "0");
346 if (s->database.length() && s->target.length())
348 yaz_log(YLOG_LOG, "add db=%s target=%s turbomarc=%s",
349 s->database.c_str(), s->target.c_str(),
350 s->use_turbomarc ? "1" : "0");
351 m_searchables.push_back(s);
360 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
362 for (ptr = ptr->children; ptr; ptr = ptr->next)
364 if (ptr->type != XML_ELEMENT_NODE)
366 if (!strcmp((const char *) ptr->name, "records"))
370 else if (!strcmp((const char *) ptr->name, "torus"))
373 const struct _xmlAttr *attr;
374 for (attr = ptr->properties; attr; attr = attr->next)
376 if (!strcmp((const char *) attr->name, "url"))
377 url = mp::xml::get_text(attr->children);
379 throw mp::filter::FilterException(
380 "Bad attribute " + std::string((const char *)
383 torus.read_searchables(url);
384 xmlDoc *doc = torus.get_doc();
387 xmlNode *ptr = xmlDocGetRootElement(doc);
393 throw mp::filter::FilterException
395 + std::string((const char *) ptr->name)
396 + " in zoom filter");
401 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
402 std::string &database, int *error, const char **addinfo)
404 std::list<BackendPtr>::const_iterator map_it;
405 if (m_backend && m_backend->m_frontend_database == database)
408 std::list<Zoom::SearchablePtr>::iterator map_s =
409 m_p->m_searchables.begin();
411 std::string c_db = mp::util::database_name_normalize(database);
413 while (map_s != m_p->m_searchables.end())
415 if (c_db.compare((*map_s)->database) == 0)
419 if (map_s == m_p->m_searchables.end())
421 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
422 *addinfo = database.c_str();
427 xsltStylesheetPtr xsp = 0;
428 if ((*map_s)->transform_xsl_fname.length())
430 xmlDoc *xsp_doc = xmlParseFile((*map_s)->transform_xsl_fname.c_str());
433 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
434 *addinfo = "xmlParseFile failed";
438 xsp = xsltParseStylesheetDoc(xsp_doc);
441 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
442 *addinfo = "xsltParseStylesheetDoc failed";
449 SearchablePtr sptr = *map_s;
453 BackendPtr b(new Backend(sptr));
456 b->m_frontend_database = database;
458 if (sptr->query_encoding.length())
459 b->set_option("rpnCharset", sptr->query_encoding.c_str());
462 if (sptr->sru.length())
464 url = "http://" + sptr->target;
465 b->set_option("sru", sptr->sru.c_str());
470 b->connect(url, error, addinfo);
478 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
479 Odr_int number_to_present,
481 const char **addinfo,
482 Odr_int *number_of_records_returned,
485 Odr_oid *preferredRecordSyntax,
486 const char *element_set_name)
488 *number_of_records_returned = 0;
489 Z_Records *records = 0;
490 bool enable_pz2_transform = false;
492 if (start < 0 || number_to_present <= 0)
495 if (number_to_present > 10000)
496 number_to_present = 10000;
498 ZOOM_record *recs = (ZOOM_record *)
499 odr_malloc(odr, number_to_present * sizeof(*recs));
501 char oid_name_str[OID_STR_MAX];
502 const char *syntax_name = 0;
504 if (preferredRecordSyntax)
506 if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
507 && !strcmp(element_set_name, "pz2"))
509 if (b->sptr->request_syntax.length())
511 syntax_name = b->sptr->request_syntax.c_str();
512 enable_pz2_transform = true;
518 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
522 yaz_log(YLOG_LOG, "enable_pz2_transform %s", enable_pz2_transform ?
523 "enabled" : "disabled");
525 b->set_option("preferredRecordSyntax", syntax_name);
527 if (enable_pz2_transform)
529 element_set_name = "F";
530 if (b->sptr->element_set.length())
531 element_set_name = b->sptr->element_set.c_str();
534 b->set_option("elementSetName", element_set_name);
536 b->present(start, number_to_present, recs, error, addinfo);
541 for (i = 0; i < number_to_present; i++)
546 { // only return records if no error and at least one record
547 char *odr_database = odr_strdup(odr,
548 b->m_frontend_database.c_str());
549 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
550 odr_malloc(odr, sizeof(*npl));
551 *number_of_records_returned = i;
552 npl->num_records = i;
553 npl->records = (Z_NamePlusRecord **)
554 odr_malloc(odr, i * sizeof(*npl->records));
555 for (i = 0; i < number_to_present; i++)
557 Z_NamePlusRecord *npr = 0;
559 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
560 &addinfo, 0 /* diagset */);
564 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
567 else if (enable_pz2_transform)
569 char rec_type_str[100];
571 strcpy(rec_type_str, b->sptr->use_turbomarc ?
574 // prevent buffer overflow ...
575 if (b->sptr->record_encoding.length() > 0 &&
576 b->sptr->record_encoding.length() <
577 (sizeof(rec_type_str)-20))
579 strcat(rec_type_str, "; charset=");
580 strcat(rec_type_str, b->sptr->record_encoding.c_str());
584 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
586 if (rec_buf && b->xsp)
588 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
592 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
595 xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
602 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
603 npr->databaseName = odr_database;
604 npr->which = Z_NamePlusRecord_databaseRecord;
605 npr->u.databaseRecord =
606 z_ext_record_xml(odr, rec_buf, rec_len);
610 npr = zget_surrogateDiagRec(
612 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
619 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
622 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
623 npr->databaseName = odr_database;
624 npr->which = Z_NamePlusRecord_databaseRecord;
625 npr->u.databaseRecord = ext;
629 npr = zget_surrogateDiagRec(
631 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
632 "ZOOM_record, type ext");
635 npl->records[i] = npr;
637 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
638 records->which = Z_Records_DBOSD;
639 records->u.databaseOrSurDiagnostics = npl;
645 void yf::Zoom::Frontend::handle_search(mp::Package &package)
647 Z_GDU *gdu = package.request().get();
648 Z_APDU *apdu_req = gdu->u.z3950;
649 Z_APDU *apdu_res = 0;
651 Z_SearchRequest *sr = apdu_req->u.searchRequest;
652 if (sr->num_databaseNames != 1)
654 apdu_res = odr.create_searchResponse(
655 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
656 package.response() = apdu_res;
661 const char *addinfo = 0;
662 std::string db(sr->databaseNames[0]);
663 BackendPtr b = get_backend_from_databases(db, &error, &addinfo);
667 odr.create_searchResponse(
668 apdu_req, error, addinfo);
669 package.response() = apdu_res;
673 b->set_option("setname", "default");
676 Z_Query *query = sr->query;
677 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
679 WRBUF w = wrbuf_alloc();
680 yaz_rpnquery_to_wrbuf(w, query->u.type_1);
682 b->search_pqf(wrbuf_cstr(w), &hits, &error, &addinfo);
688 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
689 package.response() = apdu_res;
693 const char *element_set_name = 0;
694 Odr_int number_to_present = 0;
696 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
698 Odr_int number_of_records_returned = 0;
699 Z_Records *records = get_records(
700 0, number_to_present, &error, &addinfo,
701 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
703 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
706 apdu_res->u.searchResponse->records = records;
707 apdu_res->u.searchResponse->numberOfRecordsReturned =
708 odr_intdup(odr, number_of_records_returned);
710 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
711 package.response() = apdu_res;
714 void yf::Zoom::Frontend::handle_present(mp::Package &package)
716 Z_GDU *gdu = package.request().get();
717 Z_APDU *apdu_req = gdu->u.z3950;
718 Z_APDU *apdu_res = 0;
719 Z_PresentRequest *pr = apdu_req->u.presentRequest;
724 package.response() = odr.create_presentResponse(
725 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
728 const char *element_set_name = 0;
729 Z_RecordComposition *comp = pr->recordComposition;
730 if (comp && comp->which != Z_RecordComp_simple)
732 package.response() = odr.create_presentResponse(
734 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
737 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
738 element_set_name = comp->u.simple->u.generic;
739 Odr_int number_of_records_returned = 0;
741 const char *addinfo = 0;
742 Z_Records *records = get_records(
743 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
744 &error, &addinfo, &number_of_records_returned, odr, m_backend,
745 pr->preferredRecordSyntax, element_set_name);
747 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
750 apdu_res->u.presentResponse->records = records;
751 apdu_res->u.presentResponse->numberOfRecordsReturned =
752 odr_intdup(odr, number_of_records_returned);
754 package.response() = apdu_res;
757 void yf::Zoom::Frontend::handle_package(mp::Package &package)
759 Z_GDU *gdu = package.request().get();
762 else if (gdu->which == Z_GDU_Z3950)
764 Z_APDU *apdu_req = gdu->u.z3950;
765 if (apdu_req->which == Z_APDU_initRequest)
768 package.response() = odr.create_close(
770 Z_Close_protocolError,
773 else if (apdu_req->which == Z_APDU_searchRequest)
775 handle_search(package);
777 else if (apdu_req->which == Z_APDU_presentRequest)
779 handle_present(package);
784 package.response() = odr.create_close(
786 Z_Close_protocolError,
787 "zoom filter cannot handle this APDU");
788 package.session().close();
793 package.session().close();
797 void yf::Zoom::Impl::process(mp::Package &package)
799 FrontendPtr f = get_frontend(package);
800 Z_GDU *gdu = package.request().get();
804 f->handle_package(package);
806 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
809 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
813 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
814 Z_InitResponse *resp = apdu->u.initResponse;
817 static const int masks[] = {
822 for (i = 0; masks[i] != -1; i++)
823 if (ODR_MASK_GET(req->options, masks[i]))
824 ODR_MASK_SET(resp->options, masks[i]);
826 static const int versions[] = {
832 for (i = 0; versions[i] != -1; i++)
833 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
834 ODR_MASK_SET(resp->protocolVersion, versions[i]);
838 *resp->preferredMessageSize = *req->preferredMessageSize;
839 *resp->maximumRecordSize = *req->maximumRecordSize;
841 package.response() = apdu;
842 f->m_is_virtual = true;
847 release_frontend(package);
851 static mp::filter::Base* filter_creator()
853 return new mp::filter::Zoom;
857 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
868 * c-file-style: "Stroustrup"
869 * indent-tabs-mode: nil
871 * vim: shiftwidth=4 tabstop=8 expandtab