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 {
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;
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 {
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 yaz_log(YLOG_LOG, "seeing useTurboMarc");
345 s->use_turbomarc = mp::xml::get_bool(ptr3, false);
346 yaz_log(YLOG_LOG, "value=%s",
347 s->use_turbomarc ? "1" : "0");
350 else if (!strncmp((const char *) ptr3->name,
353 std::string value = mp::xml::get_text(ptr3);
354 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
355 (const char *) ptr3->name + 7);
358 if (s->database.length() && s->target.length())
360 yaz_log(YLOG_LOG, "add db=%s target=%s turbomarc=%s",
361 s->database.c_str(), s->target.c_str(),
362 s->use_turbomarc ? "1" : "0");
363 m_searchables.push_back(s);
372 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
374 for (ptr = ptr->children; ptr; ptr = ptr->next)
376 if (ptr->type != XML_ELEMENT_NODE)
378 if (!strcmp((const char *) ptr->name, "records"))
382 else if (!strcmp((const char *) ptr->name, "torus"))
385 const struct _xmlAttr *attr;
386 for (attr = ptr->properties; attr; attr = attr->next)
388 if (!strcmp((const char *) attr->name, "url"))
389 url = mp::xml::get_text(attr->children);
391 throw mp::filter::FilterException(
392 "Bad attribute " + std::string((const char *)
395 torus.read_searchables(url);
396 xmlDoc *doc = torus.get_doc();
399 xmlNode *ptr = xmlDocGetRootElement(doc);
405 throw mp::filter::FilterException
407 + std::string((const char *) ptr->name)
408 + " in zoom filter");
413 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
414 std::string &database, int *error, const char **addinfo)
416 std::list<BackendPtr>::const_iterator map_it;
417 if (m_backend && m_backend->m_frontend_database == database)
420 std::list<Zoom::SearchablePtr>::iterator map_s =
421 m_p->m_searchables.begin();
423 std::string c_db = mp::util::database_name_normalize(database);
425 while (map_s != m_p->m_searchables.end())
427 if (c_db.compare((*map_s)->database) == 0)
431 if (map_s == m_p->m_searchables.end())
433 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
434 *addinfo = database.c_str();
439 xsltStylesheetPtr xsp = 0;
440 if ((*map_s)->transform_xsl_fname.length())
442 xmlDoc *xsp_doc = xmlParseFile((*map_s)->transform_xsl_fname.c_str());
445 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
446 *addinfo = "xmlParseFile failed";
450 xsp = xsltParseStylesheetDoc(xsp_doc);
453 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
454 *addinfo = "xsltParseStylesheetDoc failed";
461 SearchablePtr sptr = *map_s;
465 BackendPtr b(new Backend(sptr));
468 b->m_frontend_database = database;
470 if (sptr->query_encoding.length())
471 b->set_option("rpnCharset", sptr->query_encoding.c_str());
474 if (sptr->sru.length())
476 url = "http://" + sptr->target;
477 b->set_option("sru", sptr->sru.c_str());
482 b->connect(url, error, addinfo);
490 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
491 Odr_int number_to_present,
493 const char **addinfo,
494 Odr_int *number_of_records_returned,
497 Odr_oid *preferredRecordSyntax,
498 const char *element_set_name)
500 *number_of_records_returned = 0;
501 Z_Records *records = 0;
502 bool enable_pz2_transform = false;
504 if (start < 0 || number_to_present <= 0)
507 if (number_to_present > 10000)
508 number_to_present = 10000;
510 ZOOM_record *recs = (ZOOM_record *)
511 odr_malloc(odr, number_to_present * sizeof(*recs));
513 char oid_name_str[OID_STR_MAX];
514 const char *syntax_name = 0;
516 if (preferredRecordSyntax)
518 if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
519 && !strcmp(element_set_name, "pz2"))
521 if (b->sptr->request_syntax.length())
523 syntax_name = b->sptr->request_syntax.c_str();
524 enable_pz2_transform = true;
530 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
534 yaz_log(YLOG_LOG, "enable_pz2_transform %s", enable_pz2_transform ?
535 "enabled" : "disabled");
537 b->set_option("preferredRecordSyntax", syntax_name);
539 if (enable_pz2_transform)
541 element_set_name = "F";
542 if (b->sptr->element_set.length())
543 element_set_name = b->sptr->element_set.c_str();
546 b->set_option("elementSetName", element_set_name);
548 b->present(start, number_to_present, recs, error, addinfo);
553 for (i = 0; i < number_to_present; i++)
558 { // only return records if no error and at least one record
559 char *odr_database = odr_strdup(odr,
560 b->m_frontend_database.c_str());
561 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
562 odr_malloc(odr, sizeof(*npl));
563 *number_of_records_returned = i;
564 npl->num_records = i;
565 npl->records = (Z_NamePlusRecord **)
566 odr_malloc(odr, i * sizeof(*npl->records));
567 for (i = 0; i < number_to_present; i++)
569 Z_NamePlusRecord *npr = 0;
571 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
572 &addinfo, 0 /* diagset */);
576 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
579 else if (enable_pz2_transform)
581 char rec_type_str[100];
583 strcpy(rec_type_str, b->sptr->use_turbomarc ?
586 // prevent buffer overflow ...
587 if (b->sptr->record_encoding.length() > 0 &&
588 b->sptr->record_encoding.length() <
589 (sizeof(rec_type_str)-20))
591 strcat(rec_type_str, "; charset=");
592 strcat(rec_type_str, b->sptr->record_encoding.c_str());
596 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
598 if (rec_buf && b->xsp)
600 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
604 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
607 xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
614 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
615 npr->databaseName = odr_database;
616 npr->which = Z_NamePlusRecord_databaseRecord;
617 npr->u.databaseRecord =
618 z_ext_record_xml(odr, rec_buf, rec_len);
622 npr = zget_surrogateDiagRec(
624 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
631 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
634 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
635 npr->databaseName = odr_database;
636 npr->which = Z_NamePlusRecord_databaseRecord;
637 npr->u.databaseRecord = ext;
641 npr = zget_surrogateDiagRec(
643 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
644 "ZOOM_record, type ext");
647 npl->records[i] = npr;
649 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
650 records->which = Z_Records_DBOSD;
651 records->u.databaseOrSurDiagnostics = npl;
657 void yf::Zoom::Frontend::handle_search(mp::Package &package)
659 Z_GDU *gdu = package.request().get();
660 Z_APDU *apdu_req = gdu->u.z3950;
661 Z_APDU *apdu_res = 0;
663 Z_SearchRequest *sr = apdu_req->u.searchRequest;
664 if (sr->num_databaseNames != 1)
666 apdu_res = odr.create_searchResponse(
667 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
668 package.response() = apdu_res;
673 const char *addinfo = 0;
674 std::string db(sr->databaseNames[0]);
675 BackendPtr b = get_backend_from_databases(db, &error, &addinfo);
679 odr.create_searchResponse(
680 apdu_req, error, addinfo);
681 package.response() = apdu_res;
685 b->set_option("setname", "default");
688 Z_Query *query = sr->query;
689 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
692 WRBUF w = wrbuf_alloc();
693 yaz_rpnquery_to_wrbuf(w, query->u.type_1);
695 b->search_pqf(wrbuf_cstr(w), &hits, &error, &addinfo);
699 else if (query->which == Z_Query_type_2)
702 WRBUF w = wrbuf_alloc();
703 wrbuf_write(w, (const char *) query->u.type_2->buf,
704 query->u.type_2->len);
706 struct ccl_rpn_node *cn;
707 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(w), &cerror, &cpos);
712 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
715 odr.create_searchResponse(apdu_req,
716 YAZ_BIB1_MALFORMED_QUERY,
718 package.response() = apdu_res;
724 b->search_pqf(wrbuf_cstr(w), &hits, &error, &addinfo);
732 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
733 package.response() = apdu_res;
737 const char *element_set_name = 0;
738 Odr_int number_to_present = 0;
740 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
742 Odr_int number_of_records_returned = 0;
743 Z_Records *records = get_records(
744 0, number_to_present, &error, &addinfo,
745 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
747 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
750 apdu_res->u.searchResponse->records = records;
751 apdu_res->u.searchResponse->numberOfRecordsReturned =
752 odr_intdup(odr, number_of_records_returned);
754 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
755 package.response() = apdu_res;
758 void yf::Zoom::Frontend::handle_present(mp::Package &package)
760 Z_GDU *gdu = package.request().get();
761 Z_APDU *apdu_req = gdu->u.z3950;
762 Z_APDU *apdu_res = 0;
763 Z_PresentRequest *pr = apdu_req->u.presentRequest;
768 package.response() = odr.create_presentResponse(
769 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
772 const char *element_set_name = 0;
773 Z_RecordComposition *comp = pr->recordComposition;
774 if (comp && comp->which != Z_RecordComp_simple)
776 package.response() = odr.create_presentResponse(
778 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
781 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
782 element_set_name = comp->u.simple->u.generic;
783 Odr_int number_of_records_returned = 0;
785 const char *addinfo = 0;
786 Z_Records *records = get_records(
787 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
788 &error, &addinfo, &number_of_records_returned, odr, m_backend,
789 pr->preferredRecordSyntax, element_set_name);
791 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
794 apdu_res->u.presentResponse->records = records;
795 apdu_res->u.presentResponse->numberOfRecordsReturned =
796 odr_intdup(odr, number_of_records_returned);
798 package.response() = apdu_res;
801 void yf::Zoom::Frontend::handle_package(mp::Package &package)
803 Z_GDU *gdu = package.request().get();
806 else if (gdu->which == Z_GDU_Z3950)
808 Z_APDU *apdu_req = gdu->u.z3950;
809 if (apdu_req->which == Z_APDU_initRequest)
812 package.response() = odr.create_close(
814 Z_Close_protocolError,
817 else if (apdu_req->which == Z_APDU_searchRequest)
819 handle_search(package);
821 else if (apdu_req->which == Z_APDU_presentRequest)
823 handle_present(package);
828 package.response() = odr.create_close(
830 Z_Close_protocolError,
831 "zoom filter cannot handle this APDU");
832 package.session().close();
837 package.session().close();
841 void yf::Zoom::Impl::process(mp::Package &package)
843 FrontendPtr f = get_frontend(package);
844 Z_GDU *gdu = package.request().get();
848 f->handle_package(package);
850 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
853 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
857 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
858 Z_InitResponse *resp = apdu->u.initResponse;
861 static const int masks[] = {
866 for (i = 0; masks[i] != -1; i++)
867 if (ODR_MASK_GET(req->options, masks[i]))
868 ODR_MASK_SET(resp->options, masks[i]);
870 static const int versions[] = {
876 for (i = 0; versions[i] != -1; i++)
877 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
878 ODR_MASK_SET(resp->protocolVersion, versions[i]);
882 *resp->preferredMessageSize = *req->preferredMessageSize;
883 *resp->maximumRecordSize = *req->maximumRecordSize;
885 package.response() = apdu;
886 f->m_is_virtual = true;
891 release_frontend(package);
895 static mp::filter::Base* filter_creator()
897 return new mp::filter::Zoom;
901 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
912 * c-file-style: "Stroustrup"
913 * indent-tabs-mode: nil
915 * vim: shiftwidth=4 tabstop=8 expandtab