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>
32 #include <yaz/oid_db.h>
33 #include <yaz/diagbib1.h>
36 #include <yaz/querytowrbuf.h>
38 namespace mp = metaproxy_1;
39 namespace yf = mp::filter;
41 namespace metaproxy_1 {
43 struct Zoom::Searchable : boost::noncopyable {
46 std::string query_encoding;
48 std::string request_syntax;
49 std::string element_set;
50 std::string record_encoding;
51 std::string transform_xsl_fname;
54 CCL_bibset ccl_bibset;
58 class Zoom::Backend : boost::noncopyable {
60 friend class Frontend;
62 ZOOM_connection m_connection;
63 ZOOM_resultset m_resultset;
64 std::string m_frontend_database;
66 xsltStylesheetPtr xsp;
68 Backend(SearchablePtr sptr);
70 void connect(std::string zurl, int *error, const char **addinfo);
71 void search_pqf(const char *pqf, Odr_int *hits,
72 int *error, const char **addinfo);
73 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
74 int *error, const char **addinfo);
75 void set_option(const char *name, const char *value);
76 int get_error(const char **addinfo);
78 class Zoom::Frontend : boost::noncopyable {
83 yazpp_1::GDU m_init_gdu;
85 void handle_package(mp::Package &package);
86 void handle_search(mp::Package &package);
87 void handle_present(mp::Package &package);
88 BackendPtr get_backend_from_databases(std::string &database,
90 const char **addinfo);
91 Z_Records *get_records(Odr_int start,
92 Odr_int number_to_present,
95 Odr_int *number_of_records_returned,
96 ODR odr, BackendPtr b,
97 Odr_oid *preferredRecordSyntax,
98 const char *element_set_name);
100 Frontend(Impl *impl);
104 friend class Frontend;
108 void process(metaproxy_1::Package & package);
109 void configure(const xmlNode * ptr, bool test_only);
111 FrontendPtr get_frontend(mp::Package &package);
112 void release_frontend(mp::Package &package);
113 void parse_torus(const xmlNode *ptr);
115 std::list<Zoom::SearchablePtr>m_searchables;
117 std::map<mp::Session, FrontendPtr> m_clients;
118 boost::mutex m_mutex;
119 boost::condition m_cond_session_ready;
125 // define Pimpl wrapper forwarding to Impl
127 yf::Zoom::Zoom() : m_p(new Impl)
132 { // must have a destructor because of boost::scoped_ptr
135 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
137 m_p->configure(xmlnode, test_only);
140 void yf::Zoom::process(mp::Package &package) const
142 m_p->process(package);
146 // define Implementation stuff
148 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
150 m_connection = ZOOM_connection_create(0);
155 yf::Zoom::Backend::~Backend()
158 xsltFreeStylesheet(xsp);
159 ZOOM_connection_destroy(m_connection);
160 ZOOM_resultset_destroy(m_resultset);
163 void yf::Zoom::Backend::connect(std::string zurl,
164 int *error, const char **addinfo)
166 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
167 *error = ZOOM_connection_error(m_connection, 0, addinfo);
170 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
171 int *error, const char **addinfo)
173 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
174 *error = ZOOM_connection_error(m_connection, 0, addinfo);
176 *hits = ZOOM_resultset_size(m_resultset);
181 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
183 int *error, const char **addinfo)
185 ZOOM_resultset_records(m_resultset, recs, start, number);
186 *error = ZOOM_connection_error(m_connection, 0, addinfo);
189 void yf::Zoom::Backend::set_option(const char *name, const char *value)
191 ZOOM_connection_option_set(m_connection, name, value);
193 ZOOM_resultset_option_set(m_resultset, name, value);
196 int yf::Zoom::Backend::get_error(const char **addinfo)
198 return ZOOM_connection_error(m_connection, 0, addinfo);
201 yf::Zoom::Searchable::Searchable()
204 use_turbomarc = false;
205 ccl_bibset = ccl_qual_mk();
208 yf::Zoom::Searchable::~Searchable()
210 ccl_qual_rm(&ccl_bibset);
213 yf::Zoom::Frontend::Frontend(Impl *impl) :
214 m_p(impl), m_is_virtual(false), m_in_use(true)
218 yf::Zoom::Frontend::~Frontend()
222 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
224 boost::mutex::scoped_lock lock(m_mutex);
226 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
230 it = m_clients.find(package.session());
231 if (it == m_clients.end())
234 if (!it->second->m_in_use)
236 it->second->m_in_use = true;
239 m_cond_session_ready.wait(lock);
241 FrontendPtr f(new Frontend(this));
242 m_clients[package.session()] = f;
247 void yf::Zoom::Impl::release_frontend(mp::Package &package)
249 boost::mutex::scoped_lock lock(m_mutex);
250 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
252 it = m_clients.find(package.session());
253 if (it != m_clients.end())
255 if (package.session().is_closed())
261 it->second->m_in_use = false;
263 m_cond_session_ready.notify_all();
267 yf::Zoom::Impl::Impl()
271 yf::Zoom::Impl::~Impl()
275 void yf::Zoom::Impl::parse_torus(const xmlNode *ptr1)
279 for (ptr1 = ptr1->children; ptr1; ptr1 = ptr1->next)
281 if (ptr1->type != XML_ELEMENT_NODE)
283 if (!strcmp((const char *) ptr1->name, "record"))
285 const xmlNode *ptr2 = ptr1;
286 for (ptr2 = ptr2->children; ptr2; ptr2 = ptr2->next)
288 if (ptr2->type != XML_ELEMENT_NODE)
290 if (!strcmp((const char *) ptr2->name, "layer"))
292 Zoom::SearchablePtr s(new Searchable);
294 const xmlNode *ptr3 = ptr2;
295 for (ptr3 = ptr3->children; ptr3; ptr3 = ptr3->next)
297 if (ptr3->type != XML_ELEMENT_NODE)
299 if (!strcmp((const char *) ptr3->name, "id"))
301 s->database = mp::xml::get_text(ptr3);
303 else if (!strcmp((const char *) ptr3->name, "zurl"))
305 s->target = mp::xml::get_text(ptr3);
307 else if (!strcmp((const char *) ptr3->name, "sru"))
309 s->sru = mp::xml::get_text(ptr3);
311 else if (!strcmp((const char *) ptr3->name,
314 s->query_encoding = mp::xml::get_text(ptr3);
316 else if (!strcmp((const char *) ptr3->name,
319 s->piggyback = mp::xml::get_bool(ptr3, true);
321 else if (!strcmp((const char *) ptr3->name,
324 s->request_syntax = mp::xml::get_text(ptr3);
326 else if (!strcmp((const char *) ptr3->name,
329 s->element_set = mp::xml::get_text(ptr3);
331 else if (!strcmp((const char *) ptr3->name,
334 s->record_encoding = mp::xml::get_text(ptr3);
336 else if (!strcmp((const char *) ptr3->name,
339 s->transform_xsl_fname = mp::xml::get_text(ptr3);
341 else if (!strcmp((const char *) ptr3->name,
344 s->use_turbomarc = mp::xml::get_bool(ptr3, false);
346 else if (!strncmp((const char *) ptr3->name,
349 std::string value = mp::xml::get_text(ptr3);
350 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
351 (const char *) ptr3->name + 7);
354 if (s->database.length() && s->target.length())
356 yaz_log(YLOG_LOG, "add db=%s target=%s turbomarc=%s",
357 s->database.c_str(), s->target.c_str(),
358 s->use_turbomarc ? "1" : "0");
359 m_searchables.push_back(s);
367 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
369 for (ptr = ptr->children; ptr; ptr = ptr->next)
371 if (ptr->type != XML_ELEMENT_NODE)
373 if (!strcmp((const char *) ptr->name, "records"))
377 else if (!strcmp((const char *) ptr->name, "torus"))
380 const struct _xmlAttr *attr;
381 for (attr = ptr->properties; attr; attr = attr->next)
383 if (!strcmp((const char *) attr->name, "url"))
384 url = mp::xml::get_text(attr->children);
386 throw mp::filter::FilterException(
387 "Bad attribute " + std::string((const char *)
390 torus.read_searchables(url);
391 xmlDoc *doc = torus.get_doc();
394 xmlNode *ptr = xmlDocGetRootElement(doc);
400 throw mp::filter::FilterException
402 + std::string((const char *) ptr->name)
403 + " in zoom filter");
408 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
409 std::string &database, int *error, const char **addinfo)
411 std::list<BackendPtr>::const_iterator map_it;
412 if (m_backend && m_backend->m_frontend_database == database)
415 std::list<Zoom::SearchablePtr>::iterator map_s =
416 m_p->m_searchables.begin();
418 std::string c_db = mp::util::database_name_normalize(database);
420 while (map_s != m_p->m_searchables.end())
422 if (c_db.compare((*map_s)->database) == 0)
426 if (map_s == m_p->m_searchables.end())
428 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
429 *addinfo = database.c_str();
434 xsltStylesheetPtr xsp = 0;
435 if ((*map_s)->transform_xsl_fname.length())
437 xmlDoc *xsp_doc = xmlParseFile((*map_s)->transform_xsl_fname.c_str());
440 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
441 *addinfo = "xmlParseFile failed";
445 xsp = xsltParseStylesheetDoc(xsp_doc);
448 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
449 *addinfo = "xsltParseStylesheetDoc failed";
456 SearchablePtr sptr = *map_s;
460 BackendPtr b(new Backend(sptr));
463 b->m_frontend_database = database;
465 if (sptr->query_encoding.length())
466 b->set_option("rpnCharset", sptr->query_encoding.c_str());
469 if (sptr->sru.length())
471 url = "http://" + sptr->target;
472 b->set_option("sru", sptr->sru.c_str());
477 b->connect(url, error, addinfo);
485 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
486 Odr_int number_to_present,
488 const char **addinfo,
489 Odr_int *number_of_records_returned,
492 Odr_oid *preferredRecordSyntax,
493 const char *element_set_name)
495 *number_of_records_returned = 0;
496 Z_Records *records = 0;
497 bool enable_pz2_transform = false;
499 if (start < 0 || number_to_present <= 0)
502 if (number_to_present > 10000)
503 number_to_present = 10000;
505 ZOOM_record *recs = (ZOOM_record *)
506 odr_malloc(odr, number_to_present * sizeof(*recs));
508 char oid_name_str[OID_STR_MAX];
509 const char *syntax_name = 0;
511 if (preferredRecordSyntax)
513 if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
514 && !strcmp(element_set_name, "pz2"))
516 if (b->sptr->request_syntax.length())
518 syntax_name = b->sptr->request_syntax.c_str();
519 enable_pz2_transform = true;
525 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
529 b->set_option("preferredRecordSyntax", syntax_name);
531 if (enable_pz2_transform)
533 element_set_name = "F";
534 if (b->sptr->element_set.length())
535 element_set_name = b->sptr->element_set.c_str();
538 b->set_option("elementSetName", element_set_name);
540 b->present(start, number_to_present, recs, error, addinfo);
545 for (i = 0; i < number_to_present; i++)
550 { // only return records if no error and at least one record
551 char *odr_database = odr_strdup(odr,
552 b->m_frontend_database.c_str());
553 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
554 odr_malloc(odr, sizeof(*npl));
555 *number_of_records_returned = i;
556 npl->num_records = i;
557 npl->records = (Z_NamePlusRecord **)
558 odr_malloc(odr, i * sizeof(*npl->records));
559 for (i = 0; i < number_to_present; i++)
561 Z_NamePlusRecord *npr = 0;
563 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
564 &addinfo, 0 /* diagset */);
568 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
571 else if (enable_pz2_transform)
573 char rec_type_str[100];
575 strcpy(rec_type_str, b->sptr->use_turbomarc ?
578 // prevent buffer overflow ...
579 if (b->sptr->record_encoding.length() > 0 &&
580 b->sptr->record_encoding.length() <
581 (sizeof(rec_type_str)-20))
583 strcat(rec_type_str, "; charset=");
584 strcat(rec_type_str, b->sptr->record_encoding.c_str());
588 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
590 if (rec_buf && b->xsp)
592 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
596 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
599 xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
606 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
607 npr->databaseName = odr_database;
608 npr->which = Z_NamePlusRecord_databaseRecord;
609 npr->u.databaseRecord =
610 z_ext_record_xml(odr, rec_buf, rec_len);
614 npr = zget_surrogateDiagRec(
616 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
623 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
626 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
627 npr->databaseName = odr_database;
628 npr->which = Z_NamePlusRecord_databaseRecord;
629 npr->u.databaseRecord = ext;
633 npr = zget_surrogateDiagRec(
635 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
636 "ZOOM_record, type ext");
639 npl->records[i] = npr;
641 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
642 records->which = Z_Records_DBOSD;
643 records->u.databaseOrSurDiagnostics = npl;
649 void yf::Zoom::Frontend::handle_search(mp::Package &package)
651 Z_GDU *gdu = package.request().get();
652 Z_APDU *apdu_req = gdu->u.z3950;
653 Z_APDU *apdu_res = 0;
655 Z_SearchRequest *sr = apdu_req->u.searchRequest;
656 if (sr->num_databaseNames != 1)
658 apdu_res = odr.create_searchResponse(
659 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
660 package.response() = apdu_res;
665 const char *addinfo = 0;
666 std::string db(sr->databaseNames[0]);
667 BackendPtr b = get_backend_from_databases(db, &error, &addinfo);
671 odr.create_searchResponse(
672 apdu_req, error, addinfo);
673 package.response() = apdu_res;
677 b->set_option("setname", "default");
680 Z_Query *query = sr->query;
681 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
684 WRBUF w = wrbuf_alloc();
685 yaz_rpnquery_to_wrbuf(w, query->u.type_1);
687 b->search_pqf(wrbuf_cstr(w), &hits, &error, &addinfo);
691 else if (query->which == Z_Query_type_2)
694 WRBUF w = wrbuf_alloc();
695 wrbuf_write(w, (const char *) query->u.type_2->buf,
696 query->u.type_2->len);
698 struct ccl_rpn_node *cn;
699 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(w), &cerror, &cpos);
704 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
707 odr.create_searchResponse(apdu_req,
708 YAZ_BIB1_MALFORMED_QUERY,
710 package.response() = apdu_res;
716 b->search_pqf(wrbuf_cstr(w), &hits, &error, &addinfo);
724 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
725 package.response() = apdu_res;
729 const char *element_set_name = 0;
730 Odr_int number_to_present = 0;
732 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
734 Odr_int number_of_records_returned = 0;
735 Z_Records *records = get_records(
736 0, number_to_present, &error, &addinfo,
737 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
739 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
742 apdu_res->u.searchResponse->records = records;
743 apdu_res->u.searchResponse->numberOfRecordsReturned =
744 odr_intdup(odr, number_of_records_returned);
746 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
747 package.response() = apdu_res;
750 void yf::Zoom::Frontend::handle_present(mp::Package &package)
752 Z_GDU *gdu = package.request().get();
753 Z_APDU *apdu_req = gdu->u.z3950;
754 Z_APDU *apdu_res = 0;
755 Z_PresentRequest *pr = apdu_req->u.presentRequest;
760 package.response() = odr.create_presentResponse(
761 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
764 const char *element_set_name = 0;
765 Z_RecordComposition *comp = pr->recordComposition;
766 if (comp && comp->which != Z_RecordComp_simple)
768 package.response() = odr.create_presentResponse(
770 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
773 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
774 element_set_name = comp->u.simple->u.generic;
775 Odr_int number_of_records_returned = 0;
777 const char *addinfo = 0;
778 Z_Records *records = get_records(
779 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
780 &error, &addinfo, &number_of_records_returned, odr, m_backend,
781 pr->preferredRecordSyntax, element_set_name);
783 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
786 apdu_res->u.presentResponse->records = records;
787 apdu_res->u.presentResponse->numberOfRecordsReturned =
788 odr_intdup(odr, number_of_records_returned);
790 package.response() = apdu_res;
793 void yf::Zoom::Frontend::handle_package(mp::Package &package)
795 Z_GDU *gdu = package.request().get();
798 else if (gdu->which == Z_GDU_Z3950)
800 Z_APDU *apdu_req = gdu->u.z3950;
801 if (apdu_req->which == Z_APDU_initRequest)
804 package.response() = odr.create_close(
806 Z_Close_protocolError,
809 else if (apdu_req->which == Z_APDU_searchRequest)
811 handle_search(package);
813 else if (apdu_req->which == Z_APDU_presentRequest)
815 handle_present(package);
820 package.response() = odr.create_close(
822 Z_Close_protocolError,
823 "zoom filter cannot handle this APDU");
824 package.session().close();
829 package.session().close();
833 void yf::Zoom::Impl::process(mp::Package &package)
835 FrontendPtr f = get_frontend(package);
836 Z_GDU *gdu = package.request().get();
840 f->handle_package(package);
842 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
845 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
849 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
850 Z_InitResponse *resp = apdu->u.initResponse;
853 static const int masks[] = {
858 for (i = 0; masks[i] != -1; i++)
859 if (ODR_MASK_GET(req->options, masks[i]))
860 ODR_MASK_SET(resp->options, masks[i]);
862 static const int versions[] = {
868 for (i = 0; versions[i] != -1; i++)
869 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
870 ODR_MASK_SET(resp->protocolVersion, versions[i]);
874 *resp->preferredMessageSize = *req->preferredMessageSize;
875 *resp->maximumRecordSize = *req->maximumRecordSize;
877 package.response() = apdu;
878 f->m_is_virtual = true;
883 release_frontend(package);
887 static mp::filter::Base* filter_creator()
889 return new mp::filter::Zoom;
893 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
904 * c-file-style: "Stroustrup"
905 * indent-tabs-mode: nil
907 * vim: shiftwidth=4 tabstop=8 expandtab