1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 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
22 #include <sys/types.h>
23 #include "filter_zoom.hpp"
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include <metaproxy/xmlutil.hpp>
29 #include <libxslt/xsltutils.h>
30 #include <libxslt/transform.h>
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
35 #include <yaz/yaz-version.h>
36 #include <yaz/tpath.h>
38 #include <yaz/ccl_xml.h>
40 #include <yaz/rpn2cql.h>
41 #include <yaz/rpn2solr.h>
42 #include <yaz/pquery.h>
44 #include <yaz/oid_db.h>
45 #include <yaz/diagbib1.h>
48 #include <yaz/querytowrbuf.h>
49 #include <yaz/sortspec.h>
50 #include <yaz/tokenizer.h>
53 namespace mp = metaproxy_1;
54 namespace yf = mp::filter;
56 namespace metaproxy_1 {
58 class Zoom::Searchable : boost::noncopyable {
60 std::string authentication;
66 std::string query_encoding;
68 std::string sru_version;
69 std::string request_syntax;
70 std::string element_set;
71 std::string record_encoding;
72 std::string transform_xsl_fname;
73 std::string transform_xsl_content;
74 std::string urlRecipe;
75 std::string contentConnector;
76 std::string sortStrategy;
79 CCL_bibset ccl_bibset;
80 std::map<std::string, std::string> sortmap;
81 Searchable(CCL_bibset base);
84 class Zoom::Backend : boost::noncopyable {
86 friend class Frontend;
88 mp::wrbuf m_apdu_wrbuf;
89 ZOOM_connection m_connection;
90 ZOOM_resultset m_resultset;
91 std::string m_frontend_database;
93 xsltStylesheetPtr xsp;
94 std::string cproxy_host;
101 void connect(std::string zurl, int *error, char **addinfo,
103 void search(ZOOM_query q, Odr_int *hits,
104 int *error, char **addinfo, ODR odr);
105 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
106 int *error, char **addinfo, ODR odr);
107 void set_option(const char *name, const char *value);
108 void set_option(const char *name, std::string value);
109 const char *get_option(const char *name);
110 void get_zoom_error(int *error, char **addinfo, ODR odr);
112 class Zoom::Frontend : boost::noncopyable {
117 yazpp_1::GDU m_init_gdu;
118 BackendPtr m_backend;
119 void handle_package(mp::Package &package);
120 void handle_search(mp::Package &package);
122 BackendPtr explain_search(mp::Package &package,
123 std::string &database,
127 std::string &torus_db,
129 void handle_present(mp::Package &package);
130 BackendPtr get_backend_from_databases(mp::Package &package,
131 std::string &database,
137 bool create_content_session(mp::Package &package,
142 std::string authentication,
146 void prepare_elements(BackendPtr b,
147 Odr_oid *preferredRecordSyntax,
148 const char *element_set_name,
149 bool &enable_pz2_retrieval,
150 bool &enable_pz2_transform,
151 bool &enable_record_transform,
152 bool &assume_marc8_charset);
154 Z_Records *get_records(Package &package,
156 Odr_int number_to_present,
159 Odr_int *number_of_records_returned,
160 ODR odr, BackendPtr b,
161 Odr_oid *preferredRecordSyntax,
162 const char *element_set_name);
163 Z_Records *get_explain_records(Package &package,
165 Odr_int number_to_present,
168 Odr_int *number_of_records_returned,
169 ODR odr, BackendPtr b,
170 Odr_oid *preferredRecordSyntax,
171 const char *element_set_name);
173 void log_diagnostic(mp::Package &package,
174 int error, const char *addinfo);
176 Frontend(Impl *impl);
180 friend class Frontend;
184 void process(metaproxy_1::Package & package);
185 void configure(const xmlNode * ptr, bool test_only,
188 void configure_local_records(const xmlNode * ptr, bool test_only);
189 FrontendPtr get_frontend(mp::Package &package);
190 void release_frontend(mp::Package &package);
191 SearchablePtr parse_torus_record(const xmlNode *ptr);
192 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
193 std::map<mp::Session, FrontendPtr> m_clients;
194 boost::mutex m_mutex;
195 boost::condition m_cond_session_ready;
196 std::string torus_searchable_url;
197 std::string torus_content_url;
198 std::string default_realm;
199 std::map<std::string,std::string> fieldmap;
201 std::string file_path;
202 std::string content_proxy_server;
203 std::string content_tmp_file;
204 std::string content_config_file;
207 std::string element_transform;
208 std::string element_raw;
210 xsltStylesheetPtr explain_xsp;
211 xsltStylesheetPtr record_xsp;
212 std::map<std::string,SearchablePtr> s_map;
213 std::string zoom_timeout;
219 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
223 if (ptr->type == XML_ELEMENT_NODE &&
224 !strcmp((const char *) ptr->name, "recordData"))
230 else // else: we don't want to find nested nodes
232 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
241 // define Pimpl wrapper forwarding to Impl
243 yf::Zoom::Zoom() : m_p(new Impl)
248 { // must have a destructor because of boost::scoped_ptr
251 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
254 m_p->configure(xmlnode, test_only, path);
257 void yf::Zoom::process(mp::Package &package) const
259 m_p->process(package);
263 // define Implementation stuff
265 yf::Zoom::Backend::Backend()
267 m_connection = ZOOM_connection_create(0);
268 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
271 enable_cproxy = true;
272 enable_explain = false;
276 yf::Zoom::Backend::~Backend()
279 xsltFreeStylesheet(xsp);
281 xmlFreeDoc(explain_doc);
282 ZOOM_connection_destroy(m_connection);
283 ZOOM_resultset_destroy(m_resultset);
287 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
291 const char *zoom_addinfo = 0;
292 const char *dset = 0;
293 int error0 = ZOOM_connection_error_x(m_connection, &msg,
294 &zoom_addinfo, &dset);
300 if (!strcmp(dset, "info:srw/diagnostic/1"))
301 *error = yaz_diag_srw_to_bib1(error0);
302 else if (!strcmp(dset, "Bib-1"))
304 else if (!strcmp(dset, "ZOOM"))
306 if (error0 == ZOOM_ERROR_INIT)
307 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
309 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
312 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
314 *addinfo = (char *) odr_malloc(
315 odr, 30 + strlen(dset) + strlen(msg) +
316 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
318 if (zoom_addinfo && *zoom_addinfo)
320 strcpy(*addinfo, zoom_addinfo);
321 strcat(*addinfo, " ");
323 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
327 void yf::Zoom::Backend::connect(std::string zurl,
328 int *error, char **addinfo,
331 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
332 get_zoom_error(error, addinfo, odr);
335 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
336 int *error, char **addinfo, ODR odr)
338 ZOOM_resultset_destroy(m_resultset);
339 m_resultset = ZOOM_connection_search(m_connection, q);
340 get_zoom_error(error, addinfo, odr);
342 *hits = ZOOM_resultset_size(m_resultset);
347 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
349 int *error, char **addinfo, ODR odr)
351 ZOOM_resultset_records(m_resultset, recs, start, number);
352 get_zoom_error(error, addinfo, odr);
355 void yf::Zoom::Backend::set_option(const char *name, const char *value)
357 ZOOM_connection_option_set(m_connection, name, value);
359 ZOOM_resultset_option_set(m_resultset, name, value);
362 void yf::Zoom::Backend::set_option(const char *name, std::string value)
364 set_option(name, value.c_str());
367 const char *yf::Zoom::Backend::get_option(const char *name)
369 return ZOOM_connection_option_get(m_connection, name);
372 yf::Zoom::Searchable::Searchable(CCL_bibset base)
375 use_turbomarc = true;
376 sortStrategy = "embed";
377 ccl_bibset = ccl_qual_dup(base);
380 yf::Zoom::Searchable::~Searchable()
382 ccl_qual_rm(&ccl_bibset);
385 yf::Zoom::Frontend::Frontend(Impl *impl) :
386 m_p(impl), m_is_virtual(false), m_in_use(true)
390 yf::Zoom::Frontend::~Frontend()
394 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
396 boost::mutex::scoped_lock lock(m_mutex);
398 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
402 it = m_clients.find(package.session());
403 if (it == m_clients.end())
406 if (!it->second->m_in_use)
408 it->second->m_in_use = true;
411 m_cond_session_ready.wait(lock);
413 FrontendPtr f(new Frontend(this));
414 m_clients[package.session()] = f;
419 void yf::Zoom::Impl::release_frontend(mp::Package &package)
421 boost::mutex::scoped_lock lock(m_mutex);
422 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
424 it = m_clients.find(package.session());
425 if (it != m_clients.end())
427 if (package.session().is_closed())
433 it->second->m_in_use = false;
435 m_cond_session_ready.notify_all();
439 yf::Zoom::Impl::Impl() :
440 apdu_log(false), element_transform("pz2") , element_raw("raw"),
443 bibset = ccl_qual_mk();
447 srand((unsigned int) time(0));
450 yf::Zoom::Impl::~Impl()
453 xsltFreeStylesheet(explain_xsp);
454 ccl_qual_rm(&bibset);
457 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
459 Zoom::SearchablePtr s(new Searchable(bibset));
461 for (ptr = ptr->children; ptr; ptr = ptr->next)
463 if (ptr->type != XML_ELEMENT_NODE)
465 if (!strcmp((const char *) ptr->name, "layer"))
467 else if (!strcmp((const char *) ptr->name,
470 s->authentication = mp::xml::get_text(ptr);
472 else if (!strcmp((const char *) ptr->name,
475 s->cfAuth = mp::xml::get_text(ptr);
477 else if (!strcmp((const char *) ptr->name,
480 s->cfProxy = mp::xml::get_text(ptr);
482 else if (!strcmp((const char *) ptr->name,
485 s->cfSubDB = mp::xml::get_text(ptr);
487 else if (!strcmp((const char *) ptr->name,
490 s->contentConnector = mp::xml::get_text(ptr);
492 else if (!strcmp((const char *) ptr->name, "udb"))
494 s->udb = mp::xml::get_text(ptr);
496 else if (!strcmp((const char *) ptr->name, "zurl"))
498 s->target = mp::xml::get_text(ptr);
500 else if (!strcmp((const char *) ptr->name, "sru"))
502 s->sru = mp::xml::get_text(ptr);
504 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
505 !strcmp((const char *) ptr->name, "sruVersion"))
507 s->sru_version = mp::xml::get_text(ptr);
509 else if (!strcmp((const char *) ptr->name,
512 s->query_encoding = mp::xml::get_text(ptr);
514 else if (!strcmp((const char *) ptr->name,
517 s->piggyback = mp::xml::get_bool(ptr, true);
519 else if (!strcmp((const char *) ptr->name,
522 s->request_syntax = mp::xml::get_text(ptr);
524 else if (!strcmp((const char *) ptr->name,
527 s->element_set = mp::xml::get_text(ptr);
529 else if (!strcmp((const char *) ptr->name,
532 s->record_encoding = mp::xml::get_text(ptr);
534 else if (!strcmp((const char *) ptr->name,
537 s->transform_xsl_fname = mp::xml::get_text(ptr);
539 else if (!strcmp((const char *) ptr->name,
542 s->transform_xsl_content = mp::xml::get_text(ptr);
544 else if (!strcmp((const char *) ptr->name,
547 s->urlRecipe = mp::xml::get_text(ptr);
549 else if (!strcmp((const char *) ptr->name,
552 ; // useTurboMarc is ignored
554 else if (!strncmp((const char *) ptr->name,
557 std::string value = mp::xml::get_text(ptr);
558 if (value.length() > 0)
560 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
561 (const char *) ptr->name + 7);
564 else if (!strncmp((const char *) ptr->name,
567 std::string value = mp::xml::get_text(ptr);
568 s->sortmap[(const char *) ptr->name + 8] = value;
570 else if (!strcmp((const char *) ptr->name,
573 s->sortStrategy = mp::xml::get_text(ptr);
579 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
581 while (ptr && ptr->type != XML_ELEMENT_NODE)
586 if (!strcmp((const char *) ptr->name, "records"))
588 for (ptr = ptr->children; ptr; ptr = ptr->next)
590 if (ptr->type != XML_ELEMENT_NODE)
592 if (!strcmp((const char *) ptr->name, "record"))
594 SearchablePtr s = parse_torus_record(ptr);
597 std::string udb = s->udb;
602 throw mp::filter::FilterException
603 ("No udb for local torus record");
609 throw mp::filter::FilterException
611 + std::string((const char *) ptr->name)
612 + " in zoom filter inside element "
619 throw mp::filter::FilterException
621 + std::string((const char *) ptr->name)
622 + " in zoom filter inside element <torus>");
627 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
630 std::string explain_xslt_fname;
631 std::string record_xslt_fname;
637 for (ptr = ptr->children; ptr; ptr = ptr->next)
639 if (ptr->type != XML_ELEMENT_NODE)
641 else if (!strcmp((const char *) ptr->name, "torus"))
643 const struct _xmlAttr *attr;
644 for (attr = ptr->properties; attr; attr = attr->next)
646 if (!strcmp((const char *) attr->name, "url"))
647 torus_searchable_url = mp::xml::get_text(attr->children);
648 else if (!strcmp((const char *) attr->name, "content_url"))
649 torus_content_url = mp::xml::get_text(attr->children);
650 else if (!strcmp((const char *) attr->name, "realm"))
651 default_realm = mp::xml::get_text(attr->children);
652 else if (!strcmp((const char *) attr->name, "xsldir"))
653 xsldir = mp::xml::get_text(attr->children);
654 else if (!strcmp((const char *) attr->name, "element_transform"))
655 element_transform = mp::xml::get_text(attr->children);
656 else if (!strcmp((const char *) attr->name, "element_raw"))
657 element_raw = mp::xml::get_text(attr->children);
658 else if (!strcmp((const char *) attr->name, "proxy"))
659 proxy = mp::xml::get_text(attr->children);
660 else if (!strcmp((const char *) attr->name, "explain_xsl"))
661 explain_xslt_fname = mp::xml::get_text(attr->children);
662 else if (!strcmp((const char *) attr->name, "record_xsl"))
663 record_xslt_fname = mp::xml::get_text(attr->children);
665 throw mp::filter::FilterException(
666 "Bad attribute " + std::string((const char *)
669 // If content_url is not given, use value of searchable, to
670 // ensure backwards compatibility
671 if (!torus_content_url.length())
672 torus_content_url = torus_searchable_url;
673 configure_local_records(ptr->children, test_only);
675 else if (!strcmp((const char *) ptr->name, "cclmap"))
677 const char *addinfo = 0;
678 ccl_xml_config(bibset, ptr, &addinfo);
680 else if (!strcmp((const char *) ptr->name, "fieldmap"))
682 const struct _xmlAttr *attr;
683 std::string ccl_field;
684 std::string cql_field;
685 for (attr = ptr->properties; attr; attr = attr->next)
687 if (!strcmp((const char *) attr->name, "ccl"))
688 ccl_field = mp::xml::get_text(attr->children);
689 else if (!strcmp((const char *) attr->name, "cql"))
690 cql_field = mp::xml::get_text(attr->children);
692 throw mp::filter::FilterException(
693 "Bad attribute " + std::string((const char *)
696 if (cql_field.length())
697 fieldmap[cql_field] = ccl_field;
699 else if (!strcmp((const char *) ptr->name, "contentProxy"))
701 const struct _xmlAttr *attr;
702 for (attr = ptr->properties; attr; attr = attr->next)
704 if (!strcmp((const char *) attr->name, "server"))
707 "contentProxy's server attribute is deprecated");
709 "Specify config_file instead. For example:");
711 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
712 content_proxy_server = mp::xml::get_text(attr->children);
714 else if (!strcmp((const char *) attr->name, "tmp_file"))
715 content_tmp_file = mp::xml::get_text(attr->children);
716 else if (!strcmp((const char *) attr->name, "config_file"))
717 content_config_file = mp::xml::get_text(attr->children);
719 throw mp::filter::FilterException(
720 "Bad attribute " + std::string((const char *)
724 else if (!strcmp((const char *) ptr->name, "log"))
726 const struct _xmlAttr *attr;
727 for (attr = ptr->properties; attr; attr = attr->next)
729 if (!strcmp((const char *) attr->name, "apdu"))
730 apdu_log = mp::xml::get_bool(attr->children, false);
732 throw mp::filter::FilterException(
733 "Bad attribute " + std::string((const char *)
737 else if (!strcmp((const char *) ptr->name, "zoom"))
739 const struct _xmlAttr *attr;
740 for (attr = ptr->properties; attr; attr = attr->next)
742 if (!strcmp((const char *) attr->name, "timeout"))
743 zoom_timeout = mp::xml::get_text(attr->children);
745 throw mp::filter::FilterException(
746 "Bad attribute " + std::string((const char *)
752 throw mp::filter::FilterException
754 + std::string((const char *) ptr->name)
755 + " in zoom filter");
759 if (explain_xslt_fname.length())
761 const char *path = 0;
764 path = xsldir.c_str();
766 path = file_path.c_str();
769 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
773 throw mp::filter::FilterException
774 ("Cannot read XSLT " + explain_xslt_fname);
777 xmlDoc *xsp_doc = xmlParseFile(cp);
780 throw mp::filter::FilterException
781 ("Cannot parse XSLT " + explain_xslt_fname);
784 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
788 throw mp::filter::FilterException
789 ("Cannot parse XSLT " + explain_xslt_fname);
794 if (record_xslt_fname.length())
796 const char *path = 0;
799 path = xsldir.c_str();
801 path = file_path.c_str();
804 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
808 throw mp::filter::FilterException
809 ("Cannot read XSLT " + record_xslt_fname);
812 xmlDoc *xsp_doc = xmlParseFile(cp);
815 throw mp::filter::FilterException
816 ("Cannot parse XSLT " + record_xslt_fname);
819 record_xsp = xsltParseStylesheetDoc(xsp_doc);
823 throw mp::filter::FilterException
824 ("Cannot parse XSLT " + record_xslt_fname);
830 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
832 int *error, char **addinfo,
834 std::string authentication,
838 if (b->sptr->contentConnector.length())
840 std::string proxyhostname;
841 std::string tmp_file;
842 bool legacy_format = false;
844 if (m_p->content_proxy_server.length())
846 proxyhostname = m_p->content_proxy_server;
847 legacy_format = true;
850 if (m_p->content_tmp_file.length())
851 tmp_file = m_p->content_tmp_file;
853 if (m_p->content_config_file.length())
855 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
859 while (fgets(buf, sizeof(buf)-1, inf))
862 cp = strchr(buf, '#');
865 cp = strchr(buf, '\n');
868 cp = strchr(buf, ':');
872 while (cp1 != buf && cp1[-1] == ' ')
878 if (!strcmp(buf, "proxyhostname"))
880 if (!strcmp(buf, "sessiondir") && *cp)
882 if (cp[strlen(cp)-1] == '/')
883 cp[strlen(cp)-1] = '\0';
884 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
892 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
893 "unable to open content config %s",
894 m_p->content_config_file.c_str());
895 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
896 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
897 sprintf(*addinfo, "unable to open content config %s",
898 m_p->content_config_file.c_str());
903 if (proxyhostname.length() == 0)
905 package.log("zoom", YLOG_WARN, "no proxyhostname");
908 if (tmp_file.length() == 0)
910 package.log("zoom", YLOG_WARN, "no tmp_file");
914 char *fname = xstrdup(tmp_file.c_str());
915 char *xx = strstr(fname, "XXXXXX");
918 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
919 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
920 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
921 sprintf(*addinfo, "bad format of content tmp_file: %s",
926 char tmp_char = xx[6];
927 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
929 b->cproxy_host = std::string(xx) + "." + proxyhostname;
931 b->cproxy_host = proxyhostname + "/" + xx;
934 FILE *file = fopen(fname, "w");
937 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
938 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
939 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
940 sprintf(*addinfo, "Could not create %s", fname);
945 wrbuf_puts(w, "#content_proxy\n");
946 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
947 if (authentication.length())
948 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
950 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
952 wrbuf_printf(w, "realm: %s\n", realm.c_str());
954 fwrite(w.buf(), 1, w.len(), file);
956 package.log("zoom", YLOG_LOG, "content file: %s", fname);
962 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
963 mp::Package &package,
964 std::string &database, int *error, char **addinfo, mp::odr &odr,
967 std::list<BackendPtr>::const_iterator map_it;
968 if (m_backend && !m_backend->enable_explain &&
969 m_backend->m_frontend_database == database)
971 m_backend->connect("", error, addinfo, odr);
975 std::string input_args;
976 std::string torus_db;
977 size_t db_arg_pos = database.find(',');
978 if (db_arg_pos != std::string::npos)
980 torus_db = database.substr(0, db_arg_pos);
981 input_args = database.substr(db_arg_pos + 1);
986 std::string authentication;
987 std::string content_authentication;
989 std::string content_proxy;
990 std::string realm = m_p->default_realm;
992 const char *param_user = 0;
993 const char *param_password = 0;
994 const char *param_content_user = 0;
995 const char *param_content_password = 0;
996 const char *param_nocproxy = 0;
1001 int no_out_args = 0;
1002 if (input_args.length())
1003 no_parms = yaz_uri_to_array(input_args.c_str(),
1004 odr, &names, &values);
1005 // adding 10 because we'll be adding other URL args
1006 const char **out_names = (const char **)
1007 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1008 const char **out_values = (const char **)
1009 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1011 // may be changed if it's a content connection
1012 std::string torus_url = m_p->torus_searchable_url;
1014 for (i = 0; i < no_parms; i++)
1016 const char *name = names[i];
1017 const char *value = values[i];
1020 if (!strcmp(name, "user"))
1022 else if (!strcmp(name, "password"))
1023 param_password = value;
1024 else if (!strcmp(name, "content-user"))
1025 param_content_user = value;
1026 else if (!strcmp(name, "content-password"))
1027 param_content_password = value;
1028 else if (!strcmp(name, "content-proxy"))
1029 content_proxy = value;
1030 else if (!strcmp(name, "nocproxy"))
1031 param_nocproxy = value;
1032 else if (!strcmp(name, "proxy"))
1036 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1037 if (*proxy_step >= dnum)
1041 proxy = dstr[*proxy_step];
1044 if (*proxy_step == dnum)
1048 else if (!strcmp(name, "cproxysession"))
1050 out_names[no_out_args] = name;
1051 out_values[no_out_args++] = value;
1052 torus_url = m_p->torus_content_url;
1054 else if (!strcmp(name, "realm"))
1056 else if (name[0] == 'x' && name[1] == '-')
1058 out_names[no_out_args] = name;
1059 out_values[no_out_args++] = value;
1063 BackendPtr notfound;
1064 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1065 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1066 sprintf(msg, "Bad database argument: %s", name);
1073 authentication = std::string(param_user);
1075 authentication += "/" + std::string(param_password);
1077 if (param_content_user)
1079 content_authentication = std::string(param_content_user);
1080 if (param_content_password)
1081 content_authentication += "/" + std::string(param_content_password);
1084 if (torus_db.compare("IR-Explain---1") == 0)
1085 return explain_search(package, database, error, addinfo, odr, torus_db,
1090 std::map<std::string,SearchablePtr>::iterator it;
1091 it = m_p->s_map.find(torus_db);
1092 if (it != m_p->s_map.end())
1094 else if (torus_url.length() > 0)
1096 std::string torus_query = "udb==" + torus_db;
1097 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1102 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1103 *addinfo = odr_strdup(odr, torus_db.c_str());
1107 const xmlNode *ptr = xmlDocGetRootElement(doc);
1109 { // presumably ptr is a records element node
1110 // parse first record in document
1111 for (ptr = ptr->children; ptr; ptr = ptr->next)
1113 if (ptr->type == XML_ELEMENT_NODE
1114 && !strcmp((const char *) ptr->name, "record"))
1118 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1119 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1120 sprintf(*addinfo, "multiple records for udb=%s",
1126 sptr = m_p->parse_torus_record(ptr);
1135 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1136 *addinfo = odr_strdup(odr, torus_db.c_str());
1141 xsltStylesheetPtr xsp = 0;
1142 if (sptr->transform_xsl_content.length())
1144 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1145 sptr->transform_xsl_content.length());
1148 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1149 *addinfo = (char *) odr_malloc(odr, 40);
1150 sprintf(*addinfo, "xmlParseMemory failed");
1154 xsp = xsltParseStylesheetDoc(xsp_doc);
1157 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1158 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1160 xmlFreeDoc(xsp_doc);
1164 else if (sptr->transform_xsl_fname.length())
1166 const char *path = 0;
1168 if (m_p->xsldir.length())
1169 path = m_p->xsldir.c_str();
1171 path = m_p->file_path.c_str();
1174 char fullpath[1024];
1175 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1181 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1183 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1184 sprintf(*addinfo, "File could not be read: %s",
1185 sptr->transform_xsl_fname.c_str());
1189 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1192 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1193 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1194 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1198 xsp = xsltParseStylesheetDoc(xsp_doc);
1201 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1202 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1204 xmlFreeDoc(xsp_doc);
1211 BackendPtr b(new Backend);
1215 b->m_frontend_database = database;
1216 b->enable_cproxy = param_nocproxy ? false : true;
1218 if (sptr->query_encoding.length())
1219 b->set_option("rpnCharset", sptr->query_encoding);
1221 b->set_option("timeout", m_p->zoom_timeout.c_str());
1224 b->set_option("apdulog", "1");
1226 if (sptr->piggyback && sptr->sru.length())
1227 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1228 maximumRecords > 0 */
1229 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1231 if (authentication.length() == 0)
1232 authentication = sptr->authentication;
1234 if (proxy.length() == 0)
1235 proxy = sptr->cfProxy;
1237 if (sptr->cfAuth.length())
1240 b->set_option("user", sptr->cfAuth);
1241 if (authentication.length())
1243 size_t found = authentication.find('/');
1244 if (found != std::string::npos)
1246 out_names[no_out_args] = "user";
1247 out_values[no_out_args++] =
1248 odr_strdup(odr, authentication.substr(0, found).c_str());
1250 out_names[no_out_args] = "password";
1251 out_values[no_out_args++] =
1252 odr_strdup(odr, authentication.substr(found+1).c_str());
1256 out_names[no_out_args] = "user";
1257 out_values[no_out_args++] =
1258 odr_strdup(odr, authentication.c_str());
1263 out_names[no_out_args] = "proxy";
1264 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1266 if (sptr->cfSubDB.length())
1268 out_names[no_out_args] = "subdatabase";
1269 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1273 out_names[no_out_args] = "nocproxy";
1274 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1279 size_t found = authentication.find('/');
1281 if (sptr->sru.length() && found != std::string::npos)
1283 b->set_option("user", authentication.substr(0, found));
1284 b->set_option("password", authentication.substr(found+1));
1287 b->set_option("user", authentication);
1290 b->set_option("proxy", proxy);
1293 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1296 if (sptr->sru.length())
1298 url = "http://" + sptr->target;
1299 b->set_option("sru", sptr->sru);
1301 if (sptr->sru_version.length())
1302 b->set_option("sru_version", sptr->sru_version);
1311 out_names[no_out_args] = 0; // terminate list
1313 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1314 (char **) out_values);
1315 url += "," + std::string(x_args);
1317 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1318 b->connect(url, error, addinfo, odr);
1319 if (*error == 0 && b->enable_cproxy)
1320 create_content_session(package, b, error, addinfo, odr,
1321 content_authentication.length() ?
1322 content_authentication : authentication,
1323 content_proxy.length() ? content_proxy : proxy,
1330 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1331 Odr_oid *preferredRecordSyntax,
1332 const char *element_set_name,
1333 bool &enable_pz2_retrieval,
1334 bool &enable_pz2_transform,
1335 bool &enable_record_transform,
1336 bool &assume_marc8_charset)
1338 char oid_name_str[OID_STR_MAX];
1339 const char *syntax_name = 0;
1341 if (preferredRecordSyntax &&
1342 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1344 if (element_set_name &&
1345 !strcmp(element_set_name, m_p->element_transform.c_str()))
1347 enable_pz2_retrieval = true;
1348 enable_pz2_transform = true;
1350 else if (element_set_name &&
1351 !strcmp(element_set_name, m_p->element_raw.c_str()))
1353 enable_pz2_retrieval = true;
1355 else if (m_p->record_xsp)
1357 enable_pz2_retrieval = true;
1358 enable_pz2_transform = true;
1359 enable_record_transform = true;
1363 if (enable_pz2_retrieval)
1365 std::string configured_request_syntax = b->sptr->request_syntax;
1366 if (configured_request_syntax.length())
1368 syntax_name = configured_request_syntax.c_str();
1369 const Odr_oid *syntax_oid =
1370 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1371 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1372 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1373 assume_marc8_charset = true;
1376 else if (preferredRecordSyntax)
1378 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1380 if (b->sptr->sru.length())
1381 syntax_name = "XML";
1383 b->set_option("preferredRecordSyntax", syntax_name);
1385 if (enable_pz2_retrieval)
1387 element_set_name = 0;
1388 if (b->sptr->element_set.length())
1389 element_set_name = b->sptr->element_set.c_str();
1392 b->set_option("elementSetName", element_set_name);
1393 if (b->sptr->sru.length() && element_set_name)
1394 b->set_option("schema", element_set_name);
1397 Z_Records *yf::Zoom::Frontend::get_explain_records(
1400 Odr_int number_to_present,
1403 Odr_int *number_of_records_returned,
1406 Odr_oid *preferredRecordSyntax,
1407 const char *element_set_name)
1410 Z_Records *records = 0;
1412 if (!b->explain_doc)
1416 if (number_to_present > 10000)
1417 number_to_present = 10000;
1419 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1421 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1422 odr_malloc(odr, sizeof(*npl));
1423 npl->records = (Z_NamePlusRecord **)
1424 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1426 for (i = 0; i < number_to_present; i++)
1429 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1432 xmlBufferPtr xml_buf = xmlBufferCreate();
1433 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1434 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1436 Z_NamePlusRecord *npr =
1437 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1438 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1439 npr->which = Z_NamePlusRecord_databaseRecord;
1440 npr->u.databaseRecord =
1441 z_ext_record_xml(odr,
1442 (const char *) xml_buf->content, xml_buf->use);
1443 npl->records[i] = npr;
1444 xmlFreeNode(tmp_node);
1445 xmlBufferFree(xml_buf);
1447 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1448 records->which = Z_Records_DBOSD;
1449 records->u.databaseOrSurDiagnostics = npl;
1451 npl->num_records = i;
1452 *number_of_records_returned = i;
1457 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
1459 Odr_int number_to_present,
1462 Odr_int *number_of_records_returned,
1465 Odr_oid *preferredRecordSyntax,
1466 const char *element_set_name)
1468 *number_of_records_returned = 0;
1469 Z_Records *records = 0;
1470 bool enable_pz2_retrieval = false; // whether target profile is used
1471 bool enable_pz2_transform = false; // whether XSLT is used as well
1472 bool assume_marc8_charset = false;
1473 bool enable_record_transform = false;
1475 prepare_elements(b, preferredRecordSyntax,
1477 enable_pz2_retrieval,
1478 enable_pz2_transform,
1479 enable_record_transform,
1480 assume_marc8_charset);
1482 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1483 enable_pz2_retrieval ? "yes" : "no",
1484 enable_pz2_transform ? "yes" : "no");
1486 if (start < 0 || number_to_present <=0)
1489 if (number_to_present > 10000)
1490 number_to_present = 10000;
1492 ZOOM_record *recs = (ZOOM_record *)
1493 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1495 b->present(start, number_to_present, recs, error, addinfo, odr);
1500 for (i = 0; i < number_to_present; i++)
1505 { // only return records if no error and at least one record
1507 const char *xsl_parms[3];
1508 mp::wrbuf cproxy_host;
1510 if (b->enable_cproxy && b->cproxy_host.length())
1512 wrbuf_puts(cproxy_host, "\"");
1513 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1514 wrbuf_puts(cproxy_host, "/\"");
1516 xsl_parms[0] = "cproxyhost";
1517 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1525 char *odr_database = odr_strdup(odr,
1526 b->m_frontend_database.c_str());
1527 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1528 odr_malloc(odr, sizeof(*npl));
1529 *number_of_records_returned = i;
1530 npl->num_records = i;
1531 npl->records = (Z_NamePlusRecord **)
1532 odr_malloc(odr, i * sizeof(*npl->records));
1533 for (i = 0; i < number_to_present; i++)
1535 Z_NamePlusRecord *npr = 0;
1536 const char *addinfo;
1538 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1539 &addinfo, 0 /* diagset */);
1543 log_diagnostic(package, sur_error, addinfo);
1544 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1547 else if (enable_pz2_retrieval)
1549 char rec_type_str[100];
1550 const char *record_encoding = 0;
1552 if (b->sptr->record_encoding.length())
1553 record_encoding = b->sptr->record_encoding.c_str();
1554 else if (assume_marc8_charset)
1555 record_encoding = "marc8";
1557 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1558 if (record_encoding)
1560 strcat(rec_type_str, "; charset=");
1561 strcat(rec_type_str, record_encoding);
1564 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1567 xmlChar *xmlrec_buf = 0;
1568 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1570 if (!rec_buf && !npr)
1572 std::string addinfo("ZOOM_record_get failed for type ");
1574 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1575 addinfo += rec_type_str;
1576 log_diagnostic(package, error, addinfo.c_str());
1577 npr = zget_surrogateDiagRec(odr, odr_database,
1578 error, addinfo.c_str());
1582 package.log_write(rec_buf, rec_len);
1583 package.log_write("\r\n", 2);
1586 if (rec_buf && b->xsp && enable_pz2_transform)
1588 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1591 const char *addinfo = "xml parse failed for record";
1592 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1593 log_diagnostic(package, error, addinfo);
1594 npr = zget_surrogateDiagRec(
1595 odr, odr_database, error, addinfo);
1599 // first stage XSLT - per target
1600 xsltStylesheetPtr xsp = b->xsp;
1601 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1603 // insert generated-url
1607 mp::xml::url_recipe_handle(rec_res,
1608 b->sptr->urlRecipe);
1611 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1612 while (ptr && ptr->type != XML_ELEMENT_NODE)
1615 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1616 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1618 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1622 // second stage XSLT - common
1623 if (rec_res && m_p->record_xsp &&
1624 enable_record_transform)
1626 xmlDoc *tmp_doc = rec_res;
1628 xsp = m_p->record_xsp;
1629 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1631 xmlFreeDoc(tmp_doc);
1633 // get result out of it
1636 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1638 rec_buf = (const char *) xmlrec_buf;
1639 package.log_write(rec_buf, rec_len);
1641 xmlFreeDoc(rec_res);
1645 std::string addinfo;
1647 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1649 addinfo = "xslt apply failed for "
1650 + b->sptr->transform_xsl_fname;
1651 log_diagnostic(package, error, addinfo.c_str());
1652 npr = zget_surrogateDiagRec(
1653 odr, odr_database, error, addinfo.c_str());
1655 xmlFreeDoc(rec_doc);
1662 npr = zget_surrogateDiagRec(
1664 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1668 npr = (Z_NamePlusRecord *)
1669 odr_malloc(odr, sizeof(*npr));
1670 npr->databaseName = odr_database;
1671 npr->which = Z_NamePlusRecord_databaseRecord;
1672 npr->u.databaseRecord =
1673 z_ext_record_xml(odr, rec_buf, rec_len);
1677 xmlFree(xmlrec_buf);
1682 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1685 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1686 npr->databaseName = odr_database;
1687 npr->which = Z_NamePlusRecord_databaseRecord;
1688 npr->u.databaseRecord = ext;
1692 npr = zget_surrogateDiagRec(
1694 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1695 "ZOOM_record, type ext");
1698 npl->records[i] = npr;
1700 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1701 records->which = Z_Records_DBOSD;
1702 records->u.databaseOrSurDiagnostics = npl;
1707 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1710 struct cql_node *r = 0;
1718 std::map<std::string,std::string>::const_iterator it;
1719 it = fieldmap.find(cn->u.st.index);
1720 if (it == fieldmap.end())
1722 if (it->second.length())
1723 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1729 r = convert_cql_fields(cn->u.boolean.left, odr);
1731 r = convert_cql_fields(cn->u.boolean.right, odr);
1734 r = convert_cql_fields(cn->u.sort.search, odr);
1740 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1741 int error, const char *addinfo)
1743 const char *err_msg = yaz_diag_bib1_str(error);
1745 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1746 error, err_msg, addinfo);
1748 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1752 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1753 std::string &database,
1757 std::string &torus_db,
1762 BackendPtr b(new Backend);
1764 b->m_frontend_database = database;
1765 b->enable_explain = true;
1767 Z_GDU *gdu = package.request().get();
1768 Z_APDU *apdu_req = gdu->u.z3950;
1769 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1770 Z_Query *query = sr->query;
1772 if (!m_p->explain_xsp)
1774 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1776 odr_strdup(odr, "IR-Explain---1 unsupported. "
1777 "Torus explain_xsl not defined");
1780 else if (query->which == Z_Query_type_104 &&
1781 query->u.type_104->which == Z_External_CQL)
1783 std::string torus_url = m_p->torus_searchable_url;
1784 std::string torus_query(query->u.type_104->u.cql);
1785 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1788 if (m_p->explain_xsp)
1790 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1797 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1798 *addinfo = odr_strdup(odr, "IR-Explain---1 problem. "
1799 "Could not obtain Torus records for Explain");
1803 xmlNode *ptr = xmlDocGetRootElement(doc);
1806 xml_node_search(ptr, &hits, 0);
1808 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1809 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1810 package.response() = apdu_res;
1814 xmlFreeDoc(b->explain_doc);
1815 b->explain_doc = doc;
1820 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1821 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1826 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1828 Z_GDU *gdu = package.request().get();
1829 Z_APDU *apdu_req = gdu->u.z3950;
1830 Z_APDU *apdu_res = 0;
1832 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1833 if (sr->num_databaseNames != 1)
1835 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1836 log_diagnostic(package, error, 0);
1837 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1838 package.response() = apdu_res;
1847 std::string db(sr->databaseNames[0]);
1849 BackendPtr b = get_backend_from_databases(package, db, &error,
1850 &addinfo, odr, &proxy_step);
1851 if (error && proxy_step)
1853 package.log("zoom", YLOG_WARN,
1854 "create backend failed: trying next proxy");
1859 log_diagnostic(package, error, addinfo);
1860 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1861 package.response() = apdu_res;
1864 if (!b || b->enable_explain)
1867 b->set_option("setname", "default");
1869 bool enable_pz2_retrieval = false;
1870 bool enable_pz2_transform = false;
1871 bool enable_record_transform = false;
1872 bool assume_marc8_charset = false;
1873 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1874 enable_pz2_retrieval,
1875 enable_pz2_transform,
1876 enable_record_transform,
1877 assume_marc8_charset);
1880 Z_Query *query = sr->query;
1881 mp::wrbuf ccl_wrbuf;
1882 mp::wrbuf pqf_wrbuf;
1883 std::string sortkeys;
1885 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1888 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1890 else if (query->which == Z_Query_type_2)
1893 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1894 query->u.type_2->len);
1896 else if (query->which == Z_Query_type_104 &&
1897 query->u.type_104->which == Z_External_CQL)
1900 const char *cql = query->u.type_104->u.cql;
1901 CQL_parser cp = cql_parser_create();
1902 int r = cql_parser_string(cp, cql);
1903 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1906 cql_parser_destroy(cp);
1907 error = YAZ_BIB1_MALFORMED_QUERY;
1908 const char *addinfo = "CQL syntax error";
1909 log_diagnostic(package, error, addinfo);
1911 odr.create_searchResponse(apdu_req, error, addinfo);
1912 package.response() = apdu_res;
1915 struct cql_node *cn = cql_parser_result(cp);
1916 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1919 // hopefully we are getting a ptr to a index+relation+term node
1920 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1922 if (cn_error->which == CQL_NODE_ST)
1923 addinfo = cn_error->u.st.index;
1925 log_diagnostic(package, error, addinfo);
1926 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1927 package.response() = apdu_res;
1928 cql_parser_destroy(cp);
1932 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1935 error = YAZ_BIB1_MALFORMED_QUERY;
1936 const char *addinfo = "CQL to CCL conversion error";
1938 log_diagnostic(package, error, addinfo);
1939 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1940 package.response() = apdu_res;
1941 cql_parser_destroy(cp);
1945 mp::wrbuf sru_sortkeys_wrbuf;
1946 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
1948 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
1949 const char *addinfo = "CQL to CCL sortby conversion";
1951 log_diagnostic(package, error, addinfo);
1952 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1953 package.response() = apdu_res;
1954 cql_parser_destroy(cp);
1957 mp::wrbuf sort_spec_wrbuf;
1958 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1960 wrbuf_puts(ccl_wrbuf, ccl_buf);
1962 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1963 yaz_tok_parse_t tp =
1964 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1965 yaz_tok_cfg_destroy(tc);
1967 /* go through sortspec and map fields */
1968 int token = yaz_tok_move(tp);
1969 while (token != YAZ_TOK_EOF)
1971 if (token == YAZ_TOK_STRING)
1973 const char *field = yaz_tok_parse_string(tp);
1974 std::map<std::string,std::string>::iterator it;
1975 it = b->sptr->sortmap.find(field);
1976 if (it != b->sptr->sortmap.end())
1977 sortkeys += it->second;
1982 token = yaz_tok_move(tp);
1983 if (token == YAZ_TOK_STRING)
1985 sortkeys += yaz_tok_parse_string(tp);
1987 if (token != YAZ_TOK_EOF)
1990 token = yaz_tok_move(tp);
1993 yaz_tok_parse_destroy(tp);
1994 cql_parser_destroy(cp);
1998 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1999 const char *addinfo = 0;
2000 log_diagnostic(package, error, addinfo);
2001 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2002 package.response() = apdu_res;
2006 if (ccl_wrbuf.len())
2009 assert(pqf_wrbuf.len() == 0);
2011 struct ccl_rpn_node *cn;
2012 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2013 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2017 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2018 error = YAZ_BIB1_MALFORMED_QUERY;
2022 case CCL_ERR_UNKNOWN_QUAL:
2023 case CCL_ERR_TRUNC_NOT_LEFT:
2024 case CCL_ERR_TRUNC_NOT_RIGHT:
2025 case CCL_ERR_TRUNC_NOT_BOTH:
2026 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2027 case CCL_ERR_TRUNC_NOT_EMBED:
2029 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2030 case CCL_ERR_TRUNC_NOT_SINGLE:
2032 error = YAZ_BIB1_UNSUPP_SEARCH;
2035 log_diagnostic(package, error, addinfo);
2036 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2037 package.response() = apdu_res;
2040 ccl_pquery(pqf_wrbuf, cn);
2041 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2045 assert(pqf_wrbuf.len());
2047 ZOOM_query q = ZOOM_query_create();
2048 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2050 if (b->get_option("sru"))
2054 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2057 if (!strcmp(b->get_option("sru"), "solr"))
2059 solr_transform_t cqlt = solr_transform_create();
2061 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2063 solr_transform_close(cqlt);
2067 cql_transform_t cqlt = cql_transform_create();
2069 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
2071 cql_transform_close(cqlt);
2075 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2076 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2077 b->search(q, &hits, &error, &addinfo, odr);
2079 ZOOM_query_destroy(q);
2083 error = YAZ_BIB1_MALFORMED_QUERY;
2084 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2085 log_diagnostic(package, error, addinfo);
2086 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2087 package.response() = apdu_res;
2093 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2094 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2095 b->search(q, &hits, &error, &addinfo, odr);
2096 ZOOM_query_destroy(q);
2099 if (error && proxy_step)
2101 // reset below prevent reuse in get_backend_from_databases
2103 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2107 const char *element_set_name = 0;
2108 Odr_int number_to_present = 0;
2110 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2112 Odr_int number_of_records_returned = 0;
2113 Z_Records *records = get_records(
2115 0, number_to_present, &error, &addinfo,
2116 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2119 log_diagnostic(package, error, addinfo);
2120 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2123 apdu_res->u.searchResponse->records = records;
2124 apdu_res->u.searchResponse->numberOfRecordsReturned =
2125 odr_intdup(odr, number_of_records_returned);
2127 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2128 package.response() = apdu_res;
2131 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2133 Z_GDU *gdu = package.request().get();
2134 Z_APDU *apdu_req = gdu->u.z3950;
2135 Z_APDU *apdu_res = 0;
2136 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2141 package.response() = odr.create_presentResponse(
2142 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2145 const char *element_set_name = 0;
2146 Z_RecordComposition *comp = pr->recordComposition;
2147 if (comp && comp->which != Z_RecordComp_simple)
2149 package.response() = odr.create_presentResponse(
2151 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2154 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2155 element_set_name = comp->u.simple->u.generic;
2156 Odr_int number_of_records_returned = 0;
2160 if (m_backend->enable_explain)
2162 Z_Records *records =
2163 get_explain_records(
2165 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2166 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2167 pr->preferredRecordSyntax, element_set_name);
2169 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2172 apdu_res->u.presentResponse->records = records;
2173 apdu_res->u.presentResponse->numberOfRecordsReturned =
2174 odr_intdup(odr, number_of_records_returned);
2176 package.response() = apdu_res;
2180 Z_Records *records =
2181 get_records(package,
2182 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2183 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2184 pr->preferredRecordSyntax, element_set_name);
2186 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2189 apdu_res->u.presentResponse->records = records;
2190 apdu_res->u.presentResponse->numberOfRecordsReturned =
2191 odr_intdup(odr, number_of_records_returned);
2193 package.response() = apdu_res;
2197 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2199 Z_GDU *gdu = package.request().get();
2202 else if (gdu->which == Z_GDU_Z3950)
2204 Z_APDU *apdu_req = gdu->u.z3950;
2207 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2208 if (apdu_req->which == Z_APDU_initRequest)
2211 package.response() = odr.create_close(
2213 Z_Close_protocolError,
2216 else if (apdu_req->which == Z_APDU_searchRequest)
2218 handle_search(package);
2220 else if (apdu_req->which == Z_APDU_presentRequest)
2222 handle_present(package);
2227 package.response() = odr.create_close(
2229 Z_Close_protocolError,
2230 "zoom filter cannot handle this APDU");
2231 package.session().close();
2235 WRBUF w = m_backend->m_apdu_wrbuf;
2236 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2241 package.session().close();
2245 void yf::Zoom::Impl::process(mp::Package &package)
2247 FrontendPtr f = get_frontend(package);
2248 Z_GDU *gdu = package.request().get();
2250 if (f->m_is_virtual)
2252 f->handle_package(package);
2254 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2257 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2258 f->m_init_gdu = gdu;
2261 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2262 Z_InitResponse *resp = apdu->u.initResponse;
2265 static const int masks[] = {
2270 for (i = 0; masks[i] != -1; i++)
2271 if (ODR_MASK_GET(req->options, masks[i]))
2272 ODR_MASK_SET(resp->options, masks[i]);
2274 static const int versions[] = {
2275 Z_ProtocolVersion_1,
2276 Z_ProtocolVersion_2,
2277 Z_ProtocolVersion_3,
2280 for (i = 0; versions[i] != -1; i++)
2281 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2282 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2286 *resp->preferredMessageSize = *req->preferredMessageSize;
2287 *resp->maximumRecordSize = *req->maximumRecordSize;
2289 package.response() = apdu;
2290 f->m_is_virtual = true;
2295 release_frontend(package);
2299 static mp::filter::Base* filter_creator()
2301 return new mp::filter::Zoom;
2305 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2316 * c-file-style: "Stroustrup"
2317 * indent-tabs-mode: nil
2319 * vim: shiftwidth=4 tabstop=8 expandtab