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>
27 #include <yaz/comstack.h>
31 #include <libxslt/xsltutils.h>
32 #include <libxslt/transform.h>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/thread/condition.hpp>
37 #include <yaz/yaz-version.h>
38 #include <yaz/tpath.h>
40 #include <yaz/ccl_xml.h>
42 #include <yaz/rpn2cql.h>
43 #include <yaz/rpn2solr.h>
44 #include <yaz/pquery.h>
46 #include <yaz/oid_db.h>
47 #include <yaz/diagbib1.h>
50 #include <yaz/querytowrbuf.h>
51 #include <yaz/sortspec.h>
52 #include <yaz/tokenizer.h>
55 namespace mp = metaproxy_1;
56 namespace yf = mp::filter;
58 namespace metaproxy_1 {
60 class Zoom::Searchable : boost::noncopyable {
62 std::string authentication;
68 std::string query_encoding;
70 std::string sru_version;
71 std::string request_syntax;
72 std::string element_set;
73 std::string record_encoding;
74 std::string transform_xsl_fname;
75 std::string transform_xsl_content;
76 std::string urlRecipe;
77 std::string contentConnector;
78 std::string sortStrategy;
81 CCL_bibset ccl_bibset;
82 std::map<std::string, std::string> sortmap;
83 Searchable(CCL_bibset base);
86 class Zoom::Backend : boost::noncopyable {
88 friend class Frontend;
90 mp::wrbuf m_apdu_wrbuf;
91 ZOOM_connection m_connection;
92 ZOOM_resultset m_resultset;
93 std::string m_frontend_database;
95 xsltStylesheetPtr xsp;
96 std::string cproxy_host;
104 void connect(std::string zurl, int *error, char **addinfo,
106 void search(ZOOM_query q, Odr_int *hits,
107 int *error, char **addinfo, ODR odr);
108 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
109 int *error, char **addinfo, ODR odr);
110 void set_option(const char *name, const char *value);
111 void set_option(const char *name, std::string value);
112 const char *get_option(const char *name);
113 void get_zoom_error(int *error, char **addinfo, ODR odr);
115 class Zoom::Frontend : boost::noncopyable {
120 yazpp_1::GDU m_init_gdu;
121 BackendPtr m_backend;
122 void handle_package(mp::Package &package);
123 void handle_search(mp::Package &package);
125 BackendPtr explain_search(mp::Package &package,
126 std::string &database,
130 std::string &torus_db,
132 void handle_present(mp::Package &package);
133 BackendPtr get_backend_from_databases(mp::Package &package,
134 std::string &database,
140 bool create_content_session(mp::Package &package,
145 std::string authentication,
149 void prepare_elements(BackendPtr b,
150 Odr_oid *preferredRecordSyntax,
151 const char *element_set_name,
152 bool &enable_pz2_retrieval,
153 bool &enable_pz2_transform,
154 bool &enable_record_transform,
155 bool &assume_marc8_charset);
157 Z_Records *get_records(Package &package,
159 Odr_int number_to_present,
162 Odr_int *number_of_records_returned,
163 ODR odr, BackendPtr b,
164 Odr_oid *preferredRecordSyntax,
165 const char *element_set_name);
166 Z_Records *get_explain_records(Package &package,
168 Odr_int number_to_present,
171 Odr_int *number_of_records_returned,
172 ODR odr, BackendPtr b,
173 Odr_oid *preferredRecordSyntax,
174 const char *element_set_name);
175 bool retry(mp::Package &package,
178 int &error, char **addinfo,
179 int &proxy_step, int &same_retries,
181 void log_diagnostic(mp::Package &package,
182 int error, const char *addinfo);
184 Frontend(Impl *impl);
188 friend class Frontend;
192 void process(metaproxy_1::Package & package);
193 void configure(const xmlNode * ptr, bool test_only,
196 void configure_local_records(const xmlNode * ptr, bool test_only);
197 bool check_proxy(const char *proxy);
201 FrontendPtr get_frontend(mp::Package &package);
202 void release_frontend(mp::Package &package);
203 SearchablePtr parse_torus_record(const xmlNode *ptr);
204 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
205 std::map<mp::Session, FrontendPtr> m_clients;
206 boost::mutex m_mutex;
207 boost::condition m_cond_session_ready;
208 std::string torus_searchable_url;
209 std::string torus_content_url;
210 std::string default_realm;
211 std::map<std::string,std::string> fieldmap;
213 std::string file_path;
214 std::string content_proxy_server;
215 std::string content_tmp_file;
216 std::string content_config_file;
219 std::string element_transform;
220 std::string element_raw;
222 xsltStylesheetPtr explain_xsp;
223 xsltStylesheetPtr record_xsp;
224 std::map<std::string,SearchablePtr> s_map;
225 std::string zoom_timeout;
232 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
236 if (ptr->type == XML_ELEMENT_NODE &&
237 !strcmp((const char *) ptr->name, "recordData"))
243 else // else: we don't want to find nested nodes
245 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
254 // define Pimpl wrapper forwarding to Impl
256 yf::Zoom::Zoom() : m_p(new Impl)
261 { // must have a destructor because of boost::scoped_ptr
264 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
267 m_p->configure(xmlnode, test_only, path);
270 void yf::Zoom::process(mp::Package &package) const
272 m_p->process(package);
276 // define Implementation stuff
278 yf::Zoom::Backend::Backend()
280 m_connection = ZOOM_connection_create(0);
281 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
284 enable_cproxy = true;
285 enable_explain = false;
289 yf::Zoom::Backend::~Backend()
292 xsltFreeStylesheet(xsp);
294 xmlFreeDoc(explain_doc);
295 ZOOM_connection_destroy(m_connection);
296 ZOOM_resultset_destroy(m_resultset);
300 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
304 const char *zoom_addinfo = 0;
305 const char *dset = 0;
306 int error0 = ZOOM_connection_error_x(m_connection, &msg,
307 &zoom_addinfo, &dset);
313 if (!strcmp(dset, "info:srw/diagnostic/1"))
314 *error = yaz_diag_srw_to_bib1(error0);
315 else if (!strcmp(dset, "Bib-1"))
317 else if (!strcmp(dset, "ZOOM"))
319 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
320 if (error0 == ZOOM_ERROR_INIT)
321 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
322 else if (error0 == ZOOM_ERROR_DECODE)
326 if (strstr(zoom_addinfo, "Authentication") ||
327 strstr(zoom_addinfo, "authentication"))
328 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
333 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
335 *addinfo = (char *) odr_malloc(
336 odr, 30 + strlen(dset) + strlen(msg) +
337 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
339 if (zoom_addinfo && *zoom_addinfo)
341 strcpy(*addinfo, zoom_addinfo);
342 strcat(*addinfo, " ");
344 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
348 void yf::Zoom::Backend::connect(std::string zurl,
349 int *error, char **addinfo,
352 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
353 get_zoom_error(error, addinfo, odr);
356 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
357 int *error, char **addinfo, ODR odr)
359 ZOOM_resultset_destroy(m_resultset);
360 m_resultset = ZOOM_connection_search(m_connection, q);
361 get_zoom_error(error, addinfo, odr);
363 *hits = ZOOM_resultset_size(m_resultset);
368 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
370 int *error, char **addinfo, ODR odr)
372 ZOOM_resultset_records(m_resultset, recs, start, number);
373 get_zoom_error(error, addinfo, odr);
376 void yf::Zoom::Backend::set_option(const char *name, const char *value)
378 ZOOM_connection_option_set(m_connection, name, value);
380 ZOOM_resultset_option_set(m_resultset, name, value);
383 void yf::Zoom::Backend::set_option(const char *name, std::string value)
385 set_option(name, value.c_str());
388 const char *yf::Zoom::Backend::get_option(const char *name)
390 return ZOOM_connection_option_get(m_connection, name);
393 yf::Zoom::Searchable::Searchable(CCL_bibset base)
396 use_turbomarc = true;
397 sortStrategy = "embed";
398 ccl_bibset = ccl_qual_dup(base);
401 yf::Zoom::Searchable::~Searchable()
403 ccl_qual_rm(&ccl_bibset);
406 yf::Zoom::Frontend::Frontend(Impl *impl) :
407 m_p(impl), m_is_virtual(false), m_in_use(true)
411 yf::Zoom::Frontend::~Frontend()
415 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
417 boost::mutex::scoped_lock lock(m_mutex);
419 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
423 it = m_clients.find(package.session());
424 if (it == m_clients.end())
427 if (!it->second->m_in_use)
429 it->second->m_in_use = true;
432 m_cond_session_ready.wait(lock);
434 FrontendPtr f(new Frontend(this));
435 m_clients[package.session()] = f;
440 void yf::Zoom::Impl::release_frontend(mp::Package &package)
442 boost::mutex::scoped_lock lock(m_mutex);
443 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
445 it = m_clients.find(package.session());
446 if (it != m_clients.end())
448 if (package.session().is_closed())
454 it->second->m_in_use = false;
456 m_cond_session_ready.notify_all();
460 yf::Zoom::Impl::Impl() :
461 apdu_log(false), element_transform("pz2") , element_raw("raw"),
462 zoom_timeout("40"), proxy_timeout(1)
464 bibset = ccl_qual_mk();
468 srand((unsigned int) time(0));
471 yf::Zoom::Impl::~Impl()
474 xsltFreeStylesheet(explain_xsp);
475 ccl_qual_rm(&bibset);
478 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
480 Zoom::SearchablePtr s(new Searchable(bibset));
482 for (ptr = ptr->children; ptr; ptr = ptr->next)
484 if (ptr->type != XML_ELEMENT_NODE)
486 if (!strcmp((const char *) ptr->name, "layer"))
488 else if (!strcmp((const char *) ptr->name,
491 s->authentication = mp::xml::get_text(ptr);
493 else if (!strcmp((const char *) ptr->name,
496 s->cfAuth = mp::xml::get_text(ptr);
498 else if (!strcmp((const char *) ptr->name,
501 s->cfProxy = mp::xml::get_text(ptr);
503 else if (!strcmp((const char *) ptr->name,
506 s->cfSubDB = mp::xml::get_text(ptr);
508 else if (!strcmp((const char *) ptr->name,
511 s->contentConnector = mp::xml::get_text(ptr);
513 else if (!strcmp((const char *) ptr->name, "udb"))
515 s->udb = mp::xml::get_text(ptr);
517 else if (!strcmp((const char *) ptr->name, "zurl"))
519 s->target = mp::xml::get_text(ptr);
521 else if (!strcmp((const char *) ptr->name, "sru"))
523 s->sru = mp::xml::get_text(ptr);
525 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
526 !strcmp((const char *) ptr->name, "sruVersion"))
528 s->sru_version = mp::xml::get_text(ptr);
530 else if (!strcmp((const char *) ptr->name,
533 s->query_encoding = mp::xml::get_text(ptr);
535 else if (!strcmp((const char *) ptr->name,
538 s->piggyback = mp::xml::get_bool(ptr, true);
540 else if (!strcmp((const char *) ptr->name,
543 s->request_syntax = mp::xml::get_text(ptr);
545 else if (!strcmp((const char *) ptr->name,
548 s->element_set = mp::xml::get_text(ptr);
550 else if (!strcmp((const char *) ptr->name,
553 s->record_encoding = mp::xml::get_text(ptr);
555 else if (!strcmp((const char *) ptr->name,
558 s->transform_xsl_fname = mp::xml::get_text(ptr);
560 else if (!strcmp((const char *) ptr->name,
563 s->transform_xsl_content = mp::xml::get_text(ptr);
565 else if (!strcmp((const char *) ptr->name,
568 s->urlRecipe = mp::xml::get_text(ptr);
570 else if (!strcmp((const char *) ptr->name,
573 ; // useTurboMarc is ignored
575 else if (!strncmp((const char *) ptr->name,
578 std::string value = mp::xml::get_text(ptr);
579 if (value.length() > 0)
581 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
582 (const char *) ptr->name + 7);
585 else if (!strncmp((const char *) ptr->name,
588 std::string value = mp::xml::get_text(ptr);
589 s->sortmap[(const char *) ptr->name + 8] = value;
591 else if (!strcmp((const char *) ptr->name,
594 s->sortStrategy = mp::xml::get_text(ptr);
600 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
602 while (ptr && ptr->type != XML_ELEMENT_NODE)
607 if (!strcmp((const char *) ptr->name, "records"))
609 for (ptr = ptr->children; ptr; ptr = ptr->next)
611 if (ptr->type != XML_ELEMENT_NODE)
613 if (!strcmp((const char *) ptr->name, "record"))
615 SearchablePtr s = parse_torus_record(ptr);
618 std::string udb = s->udb;
623 throw mp::filter::FilterException
624 ("No udb for local torus record");
630 throw mp::filter::FilterException
632 + std::string((const char *) ptr->name)
633 + " in zoom filter inside element "
640 throw mp::filter::FilterException
642 + std::string((const char *) ptr->name)
643 + " in zoom filter inside element <torus>");
648 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
651 std::string explain_xslt_fname;
652 std::string record_xslt_fname;
658 for (ptr = ptr->children; ptr; ptr = ptr->next)
660 if (ptr->type != XML_ELEMENT_NODE)
662 else if (!strcmp((const char *) ptr->name, "torus"))
664 const struct _xmlAttr *attr;
665 for (attr = ptr->properties; attr; attr = attr->next)
667 if (!strcmp((const char *) attr->name, "url"))
668 torus_searchable_url = mp::xml::get_text(attr->children);
669 else if (!strcmp((const char *) attr->name, "content_url"))
670 torus_content_url = mp::xml::get_text(attr->children);
671 else if (!strcmp((const char *) attr->name, "realm"))
672 default_realm = mp::xml::get_text(attr->children);
673 else if (!strcmp((const char *) attr->name, "xsldir"))
674 xsldir = mp::xml::get_text(attr->children);
675 else if (!strcmp((const char *) attr->name, "element_transform"))
676 element_transform = mp::xml::get_text(attr->children);
677 else if (!strcmp((const char *) attr->name, "element_raw"))
678 element_raw = mp::xml::get_text(attr->children);
679 else if (!strcmp((const char *) attr->name, "proxy"))
680 proxy = mp::xml::get_text(attr->children);
681 else if (!strcmp((const char *) attr->name, "explain_xsl"))
682 explain_xslt_fname = mp::xml::get_text(attr->children);
683 else if (!strcmp((const char *) attr->name, "record_xsl"))
684 record_xslt_fname = mp::xml::get_text(attr->children);
686 throw mp::filter::FilterException(
687 "Bad attribute " + std::string((const char *)
690 // If content_url is not given, use value of searchable, to
691 // ensure backwards compatibility
692 if (!torus_content_url.length())
693 torus_content_url = torus_searchable_url;
694 configure_local_records(ptr->children, test_only);
696 else if (!strcmp((const char *) ptr->name, "cclmap"))
698 const char *addinfo = 0;
699 ccl_xml_config(bibset, ptr, &addinfo);
701 else if (!strcmp((const char *) ptr->name, "fieldmap"))
703 const struct _xmlAttr *attr;
704 std::string ccl_field;
705 std::string cql_field;
706 for (attr = ptr->properties; attr; attr = attr->next)
708 if (!strcmp((const char *) attr->name, "ccl"))
709 ccl_field = mp::xml::get_text(attr->children);
710 else if (!strcmp((const char *) attr->name, "cql"))
711 cql_field = mp::xml::get_text(attr->children);
713 throw mp::filter::FilterException(
714 "Bad attribute " + std::string((const char *)
717 if (cql_field.length())
718 fieldmap[cql_field] = ccl_field;
720 else if (!strcmp((const char *) ptr->name, "contentProxy"))
722 const struct _xmlAttr *attr;
723 for (attr = ptr->properties; attr; attr = attr->next)
725 if (!strcmp((const char *) attr->name, "server"))
728 "contentProxy's server attribute is deprecated");
730 "Specify config_file instead. For example:");
732 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
733 content_proxy_server = mp::xml::get_text(attr->children);
735 else if (!strcmp((const char *) attr->name, "tmp_file"))
736 content_tmp_file = mp::xml::get_text(attr->children);
737 else if (!strcmp((const char *) attr->name, "config_file"))
738 content_config_file = mp::xml::get_text(attr->children);
740 throw mp::filter::FilterException(
741 "Bad attribute " + std::string((const char *)
745 else if (!strcmp((const char *) ptr->name, "log"))
747 const struct _xmlAttr *attr;
748 for (attr = ptr->properties; attr; attr = attr->next)
750 if (!strcmp((const char *) attr->name, "apdu"))
751 apdu_log = mp::xml::get_bool(attr->children, false);
753 throw mp::filter::FilterException(
754 "Bad attribute " + std::string((const char *)
758 else if (!strcmp((const char *) ptr->name, "zoom"))
760 const struct _xmlAttr *attr;
761 for (attr = ptr->properties; attr; attr = attr->next)
763 if (!strcmp((const char *) attr->name, "timeout"))
764 zoom_timeout = mp::xml::get_text(attr->children);
765 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
766 proxy_timeout = mp::xml::get_int(attr->children, 1);
768 throw mp::filter::FilterException(
769 "Bad attribute " + std::string((const char *)
775 throw mp::filter::FilterException
777 + std::string((const char *) ptr->name)
778 + " in zoom filter");
782 if (explain_xslt_fname.length())
784 const char *path = 0;
787 path = xsldir.c_str();
789 path = file_path.c_str();
792 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
796 throw mp::filter::FilterException
797 ("Cannot read XSLT " + explain_xslt_fname);
800 xmlDoc *xsp_doc = xmlParseFile(cp);
803 throw mp::filter::FilterException
804 ("Cannot parse XSLT " + explain_xslt_fname);
807 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
811 throw mp::filter::FilterException
812 ("Cannot parse XSLT " + explain_xslt_fname);
817 if (record_xslt_fname.length())
819 const char *path = 0;
822 path = xsldir.c_str();
824 path = file_path.c_str();
827 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
831 throw mp::filter::FilterException
832 ("Cannot read XSLT " + record_xslt_fname);
835 xmlDoc *xsp_doc = xmlParseFile(cp);
838 throw mp::filter::FilterException
839 ("Cannot parse XSLT " + record_xslt_fname);
842 record_xsp = xsltParseStylesheetDoc(xsp_doc);
846 throw mp::filter::FilterException
847 ("Cannot parse XSLT " + record_xslt_fname);
853 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
855 int *error, char **addinfo,
857 std::string authentication,
861 if (b->sptr->contentConnector.length())
863 std::string proxyhostname;
864 std::string tmp_file;
865 bool legacy_format = false;
867 if (m_p->content_proxy_server.length())
869 proxyhostname = m_p->content_proxy_server;
870 legacy_format = true;
873 if (m_p->content_tmp_file.length())
874 tmp_file = m_p->content_tmp_file;
876 if (m_p->content_config_file.length())
878 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
882 while (fgets(buf, sizeof(buf)-1, inf))
885 cp = strchr(buf, '#');
888 cp = strchr(buf, '\n');
891 cp = strchr(buf, ':');
895 while (cp1 != buf && cp1[-1] == ' ')
901 if (!strcmp(buf, "proxyhostname"))
903 if (!strcmp(buf, "sessiondir") && *cp)
905 if (cp[strlen(cp)-1] == '/')
906 cp[strlen(cp)-1] = '\0';
907 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
915 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
916 "unable to open content config %s",
917 m_p->content_config_file.c_str());
918 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
919 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
920 sprintf(*addinfo, "unable to open content config %s",
921 m_p->content_config_file.c_str());
926 if (proxyhostname.length() == 0)
928 package.log("zoom", YLOG_WARN, "no proxyhostname");
931 if (tmp_file.length() == 0)
933 package.log("zoom", YLOG_WARN, "no tmp_file");
937 char *fname = xstrdup(tmp_file.c_str());
938 char *xx = strstr(fname, "XXXXXX");
941 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
942 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
943 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
944 sprintf(*addinfo, "bad format of content tmp_file: %s",
949 char tmp_char = xx[6];
950 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
952 b->cproxy_host = std::string(xx) + "." + proxyhostname;
954 b->cproxy_host = proxyhostname + "/" + xx;
957 FILE *file = fopen(fname, "w");
960 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
961 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
962 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
963 sprintf(*addinfo, "Could not create %s", fname);
968 wrbuf_puts(w, "#content_proxy\n");
969 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
970 if (authentication.length())
971 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
973 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
975 wrbuf_printf(w, "realm: %s\n", realm.c_str());
977 fwrite(w.buf(), 1, w.len(), file);
979 package.log("zoom", YLOG_LOG, "content file: %s", fname);
985 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
986 mp::Package &package,
987 std::string &database, int *error, char **addinfo, mp::odr &odr,
990 bool connection_reuse = false;
993 std::list<BackendPtr>::const_iterator map_it;
994 if (m_backend && !m_backend->enable_explain &&
995 m_backend->m_frontend_database == database)
997 connection_reuse = true;
998 proxy = m_backend->m_proxy;
1001 std::string input_args;
1002 std::string torus_db;
1003 size_t db_arg_pos = database.find(',');
1004 if (db_arg_pos != std::string::npos)
1006 torus_db = database.substr(0, db_arg_pos);
1007 input_args = database.substr(db_arg_pos + 1);
1010 torus_db = database;
1012 std::string authentication;
1013 std::string content_authentication;
1014 std::string content_proxy;
1015 std::string realm = m_p->default_realm;
1017 const char *param_user = 0;
1018 const char *param_password = 0;
1019 const char *param_content_user = 0;
1020 const char *param_content_password = 0;
1021 const char *param_nocproxy = 0;
1026 int no_out_args = 0;
1027 if (input_args.length())
1028 no_parms = yaz_uri_to_array(input_args.c_str(),
1029 odr, &names, &values);
1030 // adding 10 because we'll be adding other URL args
1031 const char **out_names = (const char **)
1032 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1033 const char **out_values = (const char **)
1034 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1036 // may be changed if it's a content connection
1037 std::string torus_url = m_p->torus_searchable_url;
1039 for (i = 0; i < no_parms; i++)
1041 const char *name = names[i];
1042 const char *value = values[i];
1045 if (!strcmp(name, "user"))
1047 else if (!strcmp(name, "password"))
1048 param_password = value;
1049 else if (!strcmp(name, "content-user"))
1050 param_content_user = value;
1051 else if (!strcmp(name, "content-password"))
1052 param_content_password = value;
1053 else if (!strcmp(name, "content-proxy"))
1054 content_proxy = value;
1055 else if (!strcmp(name, "nocproxy"))
1056 param_nocproxy = value;
1057 else if (!strcmp(name, "proxy"))
1061 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1062 if (connection_reuse)
1064 // find the step after our current proxy
1066 for (i = 0; i < dnum; i++)
1067 if (!strcmp(proxy.c_str(), dstr[i]))
1072 *proxy_step = i + 1;
1076 // step is known.. Guess our proxy from it
1077 if (*proxy_step >= dnum)
1081 proxy = dstr[*proxy_step];
1084 if (*proxy_step == dnum)
1089 else if (!strcmp(name, "cproxysession"))
1091 out_names[no_out_args] = name;
1092 out_values[no_out_args++] = value;
1093 torus_url = m_p->torus_content_url;
1095 else if (!strcmp(name, "realm"))
1097 else if (name[0] == 'x' && name[1] == '-')
1099 out_names[no_out_args] = name;
1100 out_values[no_out_args++] = value;
1104 BackendPtr notfound;
1105 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1106 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1107 sprintf(msg, "Bad database argument: %s", name);
1113 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1115 if (connection_reuse)
1117 m_backend->connect("", error, addinfo, odr);
1123 authentication = std::string(param_user);
1125 authentication += "/" + std::string(param_password);
1127 if (param_content_user)
1129 content_authentication = std::string(param_content_user);
1130 if (param_content_password)
1131 content_authentication += "/" + std::string(param_content_password);
1134 if (torus_db.compare("IR-Explain---1") == 0)
1135 return explain_search(package, database, error, addinfo, odr, torus_db,
1140 std::map<std::string,SearchablePtr>::iterator it;
1141 it = m_p->s_map.find(torus_db);
1142 if (it != m_p->s_map.end())
1144 else if (torus_url.length() > 0)
1146 std::string torus_query = "udb==" + torus_db;
1147 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1152 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1153 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1154 "incorrectly configured");
1158 const xmlNode *ptr = xmlDocGetRootElement(doc);
1160 { // presumably ptr is a records element node
1161 // parse first record in document
1162 for (ptr = ptr->children; ptr; ptr = ptr->next)
1164 if (ptr->type == XML_ELEMENT_NODE
1165 && !strcmp((const char *) ptr->name, "record"))
1169 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1170 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1171 sprintf(*addinfo, "multiple records for udb=%s",
1177 sptr = m_p->parse_torus_record(ptr);
1186 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1187 *addinfo = odr_strdup(odr, torus_db.c_str());
1192 xsltStylesheetPtr xsp = 0;
1193 if (sptr->transform_xsl_content.length())
1195 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1196 sptr->transform_xsl_content.length());
1199 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1200 *addinfo = (char *) odr_malloc(odr, 40);
1201 sprintf(*addinfo, "xmlParseMemory failed");
1205 xsp = xsltParseStylesheetDoc(xsp_doc);
1208 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1209 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1211 xmlFreeDoc(xsp_doc);
1215 else if (sptr->transform_xsl_fname.length())
1217 const char *path = 0;
1219 if (m_p->xsldir.length())
1220 path = m_p->xsldir.c_str();
1222 path = m_p->file_path.c_str();
1225 char fullpath[1024];
1226 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1232 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1234 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1235 sprintf(*addinfo, "File could not be read: %s",
1236 sptr->transform_xsl_fname.c_str());
1240 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1243 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1244 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1245 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1249 xsp = xsltParseStylesheetDoc(xsp_doc);
1252 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1253 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1255 xmlFreeDoc(xsp_doc);
1262 BackendPtr b(new Backend);
1266 b->m_frontend_database = database;
1267 b->enable_cproxy = param_nocproxy ? false : true;
1269 if (sptr->query_encoding.length())
1270 b->set_option("rpnCharset", sptr->query_encoding);
1272 b->set_option("timeout", m_p->zoom_timeout.c_str());
1275 b->set_option("apdulog", "1");
1277 if (sptr->piggyback && sptr->sru.length())
1278 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1279 maximumRecords > 0 */
1280 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1282 if (authentication.length() == 0)
1283 authentication = sptr->authentication;
1285 if (proxy.length() == 0)
1286 proxy = sptr->cfProxy;
1289 if (sptr->cfAuth.length())
1292 b->set_option("user", sptr->cfAuth);
1293 if (authentication.length())
1295 size_t found = authentication.find('/');
1296 if (found != std::string::npos)
1298 out_names[no_out_args] = "user";
1299 out_values[no_out_args++] =
1300 odr_strdup(odr, authentication.substr(0, found).c_str());
1302 out_names[no_out_args] = "password";
1303 out_values[no_out_args++] =
1304 odr_strdup(odr, authentication.substr(found+1).c_str());
1308 out_names[no_out_args] = "user";
1309 out_values[no_out_args++] =
1310 odr_strdup(odr, authentication.c_str());
1315 out_names[no_out_args] = "proxy";
1316 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1318 if (sptr->cfSubDB.length())
1320 out_names[no_out_args] = "subdatabase";
1321 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1325 out_names[no_out_args] = "nocproxy";
1326 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1331 size_t found = authentication.find('/');
1333 if (sptr->sru.length() && found != std::string::npos)
1335 b->set_option("user", authentication.substr(0, found));
1336 b->set_option("password", authentication.substr(found+1));
1339 b->set_option("user", authentication);
1342 b->set_option("proxy", proxy);
1345 if (sptr->sru.length())
1347 url = "http://" + sptr->target;
1348 b->set_option("sru", sptr->sru);
1350 if (sptr->sru_version.length())
1351 b->set_option("sru_version", sptr->sru_version);
1360 out_names[no_out_args] = 0; // terminate list
1362 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1363 (char **) out_values);
1364 url += "," + std::string(x_args);
1366 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1367 b->connect(url, error, addinfo, odr);
1368 if (*error == 0 && b->enable_cproxy)
1369 create_content_session(package, b, error, addinfo, odr,
1370 content_authentication.length() ?
1371 content_authentication : authentication,
1372 content_proxy.length() ? content_proxy : proxy,
1379 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1380 Odr_oid *preferredRecordSyntax,
1381 const char *element_set_name,
1382 bool &enable_pz2_retrieval,
1383 bool &enable_pz2_transform,
1384 bool &enable_record_transform,
1385 bool &assume_marc8_charset)
1387 char oid_name_str[OID_STR_MAX];
1388 const char *syntax_name = 0;
1390 if (preferredRecordSyntax &&
1391 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1393 if (element_set_name &&
1394 !strcmp(element_set_name, m_p->element_transform.c_str()))
1396 enable_pz2_retrieval = true;
1397 enable_pz2_transform = true;
1399 else if (element_set_name &&
1400 !strcmp(element_set_name, m_p->element_raw.c_str()))
1402 enable_pz2_retrieval = true;
1404 else if (m_p->record_xsp)
1406 enable_pz2_retrieval = true;
1407 enable_pz2_transform = true;
1408 enable_record_transform = true;
1412 if (enable_pz2_retrieval)
1414 std::string configured_request_syntax = b->sptr->request_syntax;
1415 if (configured_request_syntax.length())
1417 syntax_name = configured_request_syntax.c_str();
1418 const Odr_oid *syntax_oid =
1419 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1420 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1421 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1422 assume_marc8_charset = true;
1425 else if (preferredRecordSyntax)
1427 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1429 if (b->sptr->sru.length())
1430 syntax_name = "XML";
1432 b->set_option("preferredRecordSyntax", syntax_name);
1434 if (enable_pz2_retrieval)
1436 element_set_name = 0;
1437 if (b->sptr->element_set.length())
1438 element_set_name = b->sptr->element_set.c_str();
1441 b->set_option("elementSetName", element_set_name);
1442 if (b->sptr->sru.length() && element_set_name)
1443 b->set_option("schema", element_set_name);
1446 Z_Records *yf::Zoom::Frontend::get_explain_records(
1447 mp::Package &package,
1449 Odr_int number_to_present,
1452 Odr_int *number_of_records_returned,
1455 Odr_oid *preferredRecordSyntax,
1456 const char *element_set_name)
1459 Z_Records *records = 0;
1461 if (!b->explain_doc)
1465 if (number_to_present > 10000)
1466 number_to_present = 10000;
1468 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1470 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1471 odr_malloc(odr, sizeof(*npl));
1472 npl->records = (Z_NamePlusRecord **)
1473 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1475 for (i = 0; i < number_to_present; i++)
1478 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1481 xmlBufferPtr xml_buf = xmlBufferCreate();
1482 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1483 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1485 Z_NamePlusRecord *npr =
1486 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1487 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1488 npr->which = Z_NamePlusRecord_databaseRecord;
1489 npr->u.databaseRecord =
1490 z_ext_record_xml(odr,
1491 (const char *) xml_buf->content, xml_buf->use);
1492 npl->records[i] = npr;
1493 xmlFreeNode(tmp_node);
1494 xmlBufferFree(xml_buf);
1496 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1497 records->which = Z_Records_DBOSD;
1498 records->u.databaseOrSurDiagnostics = npl;
1500 npl->num_records = i;
1501 *number_of_records_returned = i;
1506 Z_Records *yf::Zoom::Frontend::get_records(mp::Package &package,
1508 Odr_int number_to_present,
1511 Odr_int *number_of_records_returned,
1514 Odr_oid *preferredRecordSyntax,
1515 const char *element_set_name)
1517 *number_of_records_returned = 0;
1518 Z_Records *records = 0;
1519 bool enable_pz2_retrieval = false; // whether target profile is used
1520 bool enable_pz2_transform = false; // whether XSLT is used as well
1521 bool assume_marc8_charset = false;
1522 bool enable_record_transform = false;
1524 prepare_elements(b, preferredRecordSyntax,
1526 enable_pz2_retrieval,
1527 enable_pz2_transform,
1528 enable_record_transform,
1529 assume_marc8_charset);
1531 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1532 enable_pz2_retrieval ? "yes" : "no",
1533 enable_pz2_transform ? "yes" : "no");
1535 if (start < 0 || number_to_present <=0)
1538 if (number_to_present > 10000)
1539 number_to_present = 10000;
1541 ZOOM_record *recs = (ZOOM_record *)
1542 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1544 b->present(start, number_to_present, recs, error, addinfo, odr);
1549 for (i = 0; i < number_to_present; i++)
1554 { // only return records if no error and at least one record
1556 const char *xsl_parms[3];
1557 mp::wrbuf cproxy_host;
1559 if (b->enable_cproxy && b->cproxy_host.length())
1561 wrbuf_puts(cproxy_host, "\"");
1562 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1563 wrbuf_puts(cproxy_host, "/\"");
1565 xsl_parms[0] = "cproxyhost";
1566 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1574 char *odr_database = odr_strdup(odr,
1575 b->m_frontend_database.c_str());
1576 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1577 odr_malloc(odr, sizeof(*npl));
1578 *number_of_records_returned = i;
1579 npl->num_records = i;
1580 npl->records = (Z_NamePlusRecord **)
1581 odr_malloc(odr, i * sizeof(*npl->records));
1582 for (i = 0; i < number_to_present; i++)
1584 Z_NamePlusRecord *npr = 0;
1585 const char *addinfo;
1587 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1588 &addinfo, 0 /* diagset */);
1592 log_diagnostic(package, sur_error, addinfo);
1593 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1596 else if (enable_pz2_retrieval)
1598 char rec_type_str[100];
1599 const char *record_encoding = 0;
1601 if (b->sptr->record_encoding.length())
1602 record_encoding = b->sptr->record_encoding.c_str();
1603 else if (assume_marc8_charset)
1604 record_encoding = "marc8";
1606 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1607 if (record_encoding)
1609 strcat(rec_type_str, "; charset=");
1610 strcat(rec_type_str, record_encoding);
1613 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1616 xmlChar *xmlrec_buf = 0;
1617 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1619 if (!rec_buf && !npr)
1621 std::string addinfo("ZOOM_record_get failed for type ");
1623 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1624 addinfo += rec_type_str;
1625 log_diagnostic(package, error, addinfo.c_str());
1626 npr = zget_surrogateDiagRec(odr, odr_database,
1627 error, addinfo.c_str());
1631 package.log_write(rec_buf, rec_len);
1632 package.log_write("\r\n", 2);
1635 if (rec_buf && b->xsp && enable_pz2_transform)
1637 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1640 const char *addinfo = "xml parse failed for record";
1641 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1642 log_diagnostic(package, error, addinfo);
1643 npr = zget_surrogateDiagRec(
1644 odr, odr_database, error, addinfo);
1648 // first stage XSLT - per target
1649 xsltStylesheetPtr xsp = b->xsp;
1650 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1652 // insert generated-url
1656 mp::xml::url_recipe_handle(rec_res,
1657 b->sptr->urlRecipe);
1660 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1661 while (ptr && ptr->type != XML_ELEMENT_NODE)
1664 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1665 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1667 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1671 // second stage XSLT - common
1672 if (rec_res && m_p->record_xsp &&
1673 enable_record_transform)
1675 xmlDoc *tmp_doc = rec_res;
1677 xsp = m_p->record_xsp;
1678 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1680 xmlFreeDoc(tmp_doc);
1682 // get result out of it
1685 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1687 rec_buf = (const char *) xmlrec_buf;
1688 package.log_write(rec_buf, rec_len);
1690 xmlFreeDoc(rec_res);
1694 std::string addinfo;
1696 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1698 addinfo = "xslt apply failed for "
1699 + b->sptr->transform_xsl_fname;
1700 log_diagnostic(package, error, addinfo.c_str());
1701 npr = zget_surrogateDiagRec(
1702 odr, odr_database, error, addinfo.c_str());
1704 xmlFreeDoc(rec_doc);
1711 npr = zget_surrogateDiagRec(
1713 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1717 npr = (Z_NamePlusRecord *)
1718 odr_malloc(odr, sizeof(*npr));
1719 npr->databaseName = odr_database;
1720 npr->which = Z_NamePlusRecord_databaseRecord;
1721 npr->u.databaseRecord =
1722 z_ext_record_xml(odr, rec_buf, rec_len);
1726 xmlFree(xmlrec_buf);
1731 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1734 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1735 npr->databaseName = odr_database;
1736 npr->which = Z_NamePlusRecord_databaseRecord;
1737 npr->u.databaseRecord = ext;
1741 npr = zget_surrogateDiagRec(
1743 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1744 "ZOOM_record, type ext");
1747 npl->records[i] = npr;
1749 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1750 records->which = Z_Records_DBOSD;
1751 records->u.databaseOrSurDiagnostics = npl;
1756 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1759 struct cql_node *r = 0;
1767 std::map<std::string,std::string>::const_iterator it;
1768 it = fieldmap.find(cn->u.st.index);
1769 if (it == fieldmap.end())
1771 if (it->second.length())
1772 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1778 r = convert_cql_fields(cn->u.boolean.left, odr);
1780 r = convert_cql_fields(cn->u.boolean.right, odr);
1783 r = convert_cql_fields(cn->u.sort.search, odr);
1789 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1790 int error, const char *addinfo)
1792 const char *err_msg = yaz_diag_bib1_str(error);
1794 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1795 error, err_msg, addinfo);
1797 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1801 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1802 std::string &database,
1806 std::string &torus_db,
1811 BackendPtr b(new Backend);
1813 b->m_frontend_database = database;
1814 b->enable_explain = true;
1816 Z_GDU *gdu = package.request().get();
1817 Z_APDU *apdu_req = gdu->u.z3950;
1818 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1819 Z_Query *query = sr->query;
1821 if (!m_p->explain_xsp)
1823 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1825 odr_strdup(odr, "IR-Explain---1 unsupported. "
1826 "Torus explain_xsl not defined");
1829 else if (query->which == Z_Query_type_104 &&
1830 query->u.type_104->which == Z_External_CQL)
1832 std::string torus_url = m_p->torus_searchable_url;
1833 std::string torus_query(query->u.type_104->u.cql);
1834 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1837 if (m_p->explain_xsp)
1839 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1846 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1847 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1848 "incorrectly configured");
1852 xmlNode *ptr = xmlDocGetRootElement(doc);
1855 xml_node_search(ptr, &hits, 0);
1857 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1858 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1859 package.response() = apdu_res;
1863 xmlFreeDoc(b->explain_doc);
1864 b->explain_doc = doc;
1869 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1870 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1875 static bool wait_conn(COMSTACK cs, int secs)
1877 struct yaz_poll_fd pfd;
1879 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1880 if (cs->io_pending && CS_WANT_WRITE)
1881 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1882 if (cs->io_pending & CS_WANT_READ)
1883 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1885 pfd.fd = cs_fileno(cs);
1886 pfd.client_data = 0;
1888 int ret = yaz_poll(&pfd, 1, secs, 0);
1892 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1895 const char *uri = "http://localhost/";
1898 bool outcome = false;
1899 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1904 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1905 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1907 if (z_GDU(odr, &gdu, 0, 0))
1910 char *buf = odr_getbuf(odr, &len, 0);
1912 int ret = cs_connect(conn, add);
1913 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
1917 ret = cs_put(conn, buf, len);
1920 if (!wait_conn(conn, proxy_timeout))
1931 bool yf::Zoom::Frontend::retry(mp::Package &package,
1934 int &error, char **addinfo,
1935 int &proxy_step, int &same_retries,
1938 if (b && b->m_proxy.length() && !m_p->check_proxy(b->m_proxy.c_str()))
1940 log_diagnostic(package, error, *addinfo);
1941 package.log("zoom", YLOG_LOG, "proxy %s fails", b->m_proxy.c_str());
1943 if (proxy_step) // there is a failover
1946 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
1949 error = YAZ_BIB1_PROXY_FAILURE;
1950 *addinfo = odr_strdup(odr, b->m_proxy.c_str());
1952 else if (same_retries == 0 && proxy_retries == 0)
1954 log_diagnostic(package, error, *addinfo);
1956 package.log("zoom", YLOG_WARN, "search failed: retry");
1964 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1966 Z_GDU *gdu = package.request().get();
1967 Z_APDU *apdu_req = gdu->u.z3950;
1968 Z_APDU *apdu_res = 0;
1970 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1971 if (sr->num_databaseNames != 1)
1973 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1974 log_diagnostic(package, error, 0);
1975 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1976 package.response() = apdu_res;
1980 int same_retries = 0;
1981 int proxy_retries = 0;
1987 std::string db(sr->databaseNames[0]);
1989 BackendPtr b = get_backend_from_databases(package, db, &error,
1990 &addinfo, odr, &proxy_step);
1993 if (retry(package, odr, b, error, &addinfo, proxy_step,
1994 same_retries, proxy_retries))
1999 log_diagnostic(package, error, addinfo);
2000 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2001 package.response() = apdu_res;
2004 if (!b || b->enable_explain)
2007 b->set_option("setname", "default");
2009 bool enable_pz2_retrieval = false;
2010 bool enable_pz2_transform = false;
2011 bool enable_record_transform = false;
2012 bool assume_marc8_charset = false;
2013 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
2014 enable_pz2_retrieval,
2015 enable_pz2_transform,
2016 enable_record_transform,
2017 assume_marc8_charset);
2020 Z_Query *query = sr->query;
2021 mp::wrbuf ccl_wrbuf;
2022 mp::wrbuf pqf_wrbuf;
2023 std::string sortkeys;
2025 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
2028 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
2030 else if (query->which == Z_Query_type_2)
2033 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
2034 query->u.type_2->len);
2036 else if (query->which == Z_Query_type_104 &&
2037 query->u.type_104->which == Z_External_CQL)
2040 const char *cql = query->u.type_104->u.cql;
2041 CQL_parser cp = cql_parser_create();
2042 int r = cql_parser_string(cp, cql);
2043 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
2046 cql_parser_destroy(cp);
2047 error = YAZ_BIB1_MALFORMED_QUERY;
2048 const char *addinfo = "CQL syntax error";
2049 log_diagnostic(package, error, addinfo);
2051 odr.create_searchResponse(apdu_req, error, addinfo);
2052 package.response() = apdu_res;
2055 struct cql_node *cn = cql_parser_result(cp);
2056 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2059 // hopefully we are getting a ptr to a index+relation+term node
2060 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2062 if (cn_error->which == CQL_NODE_ST)
2063 addinfo = cn_error->u.st.index;
2065 log_diagnostic(package, error, addinfo);
2066 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2067 package.response() = apdu_res;
2068 cql_parser_destroy(cp);
2071 r = cql_to_ccl(cn, wrbuf_vp_puts, ccl_wrbuf);
2074 error = YAZ_BIB1_MALFORMED_QUERY;
2075 const char *addinfo = "CQL to CCL conversion error";
2077 log_diagnostic(package, error, addinfo);
2078 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2079 package.response() = apdu_res;
2080 cql_parser_destroy(cp);
2084 mp::wrbuf sru_sortkeys_wrbuf;
2085 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2087 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2088 const char *addinfo = "CQL to CCL sortby conversion";
2090 log_diagnostic(package, error, addinfo);
2091 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2092 package.response() = apdu_res;
2093 cql_parser_destroy(cp);
2096 mp::wrbuf sort_spec_wrbuf;
2097 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2099 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2100 yaz_tok_parse_t tp =
2101 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2102 yaz_tok_cfg_destroy(tc);
2104 /* go through sortspec and map fields */
2105 int token = yaz_tok_move(tp);
2106 while (token != YAZ_TOK_EOF)
2108 if (token == YAZ_TOK_STRING)
2110 const char *field = yaz_tok_parse_string(tp);
2111 std::map<std::string,std::string>::iterator it;
2112 it = b->sptr->sortmap.find(field);
2113 if (it != b->sptr->sortmap.end())
2114 sortkeys += it->second;
2119 token = yaz_tok_move(tp);
2120 if (token == YAZ_TOK_STRING)
2122 sortkeys += yaz_tok_parse_string(tp);
2124 if (token != YAZ_TOK_EOF)
2127 token = yaz_tok_move(tp);
2130 yaz_tok_parse_destroy(tp);
2131 cql_parser_destroy(cp);
2135 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2136 const char *addinfo = 0;
2137 log_diagnostic(package, error, addinfo);
2138 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2139 package.response() = apdu_res;
2143 if (ccl_wrbuf.len())
2146 assert(pqf_wrbuf.len() == 0);
2148 struct ccl_rpn_node *cn;
2149 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2150 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2154 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2155 error = YAZ_BIB1_MALFORMED_QUERY;
2159 case CCL_ERR_UNKNOWN_QUAL:
2160 case CCL_ERR_TRUNC_NOT_LEFT:
2161 case CCL_ERR_TRUNC_NOT_RIGHT:
2162 case CCL_ERR_TRUNC_NOT_BOTH:
2163 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2164 case CCL_ERR_TRUNC_NOT_EMBED:
2166 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2167 case CCL_ERR_TRUNC_NOT_SINGLE:
2169 error = YAZ_BIB1_UNSUPP_SEARCH;
2172 log_diagnostic(package, error, addinfo);
2173 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2174 package.response() = apdu_res;
2177 ccl_pquery(pqf_wrbuf, cn);
2178 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2182 assert(pqf_wrbuf.len());
2184 ZOOM_query q = ZOOM_query_create();
2185 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2187 if (b->get_option("sru"))
2191 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2194 if (!strcmp(b->get_option("sru"), "solr"))
2196 solr_transform_t cqlt = solr_transform_create();
2198 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2200 solr_transform_close(cqlt);
2204 cql_transform_t cqlt = cql_transform_create();
2206 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
2208 cql_transform_close(cqlt);
2212 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2213 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2214 b->search(q, &hits, &error, &addinfo, odr);
2216 ZOOM_query_destroy(q);
2220 error = YAZ_BIB1_MALFORMED_QUERY;
2221 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2222 log_diagnostic(package, error, addinfo);
2223 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2224 package.response() = apdu_res;
2230 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2231 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2232 b->search(q, &hits, &error, &addinfo, odr);
2233 ZOOM_query_destroy(q);
2238 if (retry(package, odr, b, error, &addinfo, proxy_step,
2239 same_retries, proxy_retries))
2243 const char *element_set_name = 0;
2244 Odr_int number_to_present = 0;
2246 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2248 Odr_int number_of_records_returned = 0;
2249 Z_Records *records = get_records(
2251 0, number_to_present, &error, &addinfo,
2252 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2255 log_diagnostic(package, error, addinfo);
2256 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2259 apdu_res->u.searchResponse->records = records;
2260 apdu_res->u.searchResponse->numberOfRecordsReturned =
2261 odr_intdup(odr, number_of_records_returned);
2263 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2264 package.response() = apdu_res;
2267 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2269 Z_GDU *gdu = package.request().get();
2270 Z_APDU *apdu_req = gdu->u.z3950;
2271 Z_APDU *apdu_res = 0;
2272 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2277 package.response() = odr.create_presentResponse(
2278 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2281 const char *element_set_name = 0;
2282 Z_RecordComposition *comp = pr->recordComposition;
2283 if (comp && comp->which != Z_RecordComp_simple)
2285 package.response() = odr.create_presentResponse(
2287 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2290 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2291 element_set_name = comp->u.simple->u.generic;
2292 Odr_int number_of_records_returned = 0;
2296 if (m_backend->enable_explain)
2298 Z_Records *records =
2299 get_explain_records(
2301 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2302 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2303 pr->preferredRecordSyntax, element_set_name);
2305 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2308 apdu_res->u.presentResponse->records = records;
2309 apdu_res->u.presentResponse->numberOfRecordsReturned =
2310 odr_intdup(odr, number_of_records_returned);
2312 package.response() = apdu_res;
2316 Z_Records *records =
2317 get_records(package,
2318 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2319 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2320 pr->preferredRecordSyntax, element_set_name);
2322 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2325 apdu_res->u.presentResponse->records = records;
2326 apdu_res->u.presentResponse->numberOfRecordsReturned =
2327 odr_intdup(odr, number_of_records_returned);
2329 package.response() = apdu_res;
2333 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2335 Z_GDU *gdu = package.request().get();
2338 else if (gdu->which == Z_GDU_Z3950)
2340 Z_APDU *apdu_req = gdu->u.z3950;
2343 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2344 if (apdu_req->which == Z_APDU_initRequest)
2347 package.response() = odr.create_close(
2349 Z_Close_protocolError,
2352 else if (apdu_req->which == Z_APDU_searchRequest)
2354 handle_search(package);
2356 else if (apdu_req->which == Z_APDU_presentRequest)
2358 handle_present(package);
2363 package.response() = odr.create_close(
2365 Z_Close_protocolError,
2366 "zoom filter cannot handle this APDU");
2367 package.session().close();
2371 WRBUF w = m_backend->m_apdu_wrbuf;
2372 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2377 package.session().close();
2381 void yf::Zoom::Impl::process(mp::Package &package)
2383 FrontendPtr f = get_frontend(package);
2384 Z_GDU *gdu = package.request().get();
2386 if (f->m_is_virtual)
2388 f->handle_package(package);
2390 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2393 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2394 f->m_init_gdu = gdu;
2397 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2398 Z_InitResponse *resp = apdu->u.initResponse;
2401 static const int masks[] = {
2406 for (i = 0; masks[i] != -1; i++)
2407 if (ODR_MASK_GET(req->options, masks[i]))
2408 ODR_MASK_SET(resp->options, masks[i]);
2410 static const int versions[] = {
2411 Z_ProtocolVersion_1,
2412 Z_ProtocolVersion_2,
2413 Z_ProtocolVersion_3,
2416 for (i = 0; versions[i] != -1; i++)
2417 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2418 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2422 *resp->preferredMessageSize = *req->preferredMessageSize;
2423 *resp->maximumRecordSize = *req->maximumRecordSize;
2425 package.response() = apdu;
2426 f->m_is_virtual = true;
2431 release_frontend(package);
2435 static mp::filter::Base* filter_creator()
2437 return new mp::filter::Zoom;
2441 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2452 * c-file-style: "Stroustrup"
2453 * indent-tabs-mode: nil
2455 * vim: shiftwidth=4 tabstop=8 expandtab