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;
79 std::string rpn2cql_fname;
82 CCL_bibset ccl_bibset;
83 std::map<std::string, std::string> sortmap;
84 Searchable(CCL_bibset base);
87 class Zoom::Backend : boost::noncopyable {
89 friend class Frontend;
91 mp::wrbuf m_apdu_wrbuf;
92 ZOOM_connection m_connection;
93 ZOOM_resultset m_resultset;
94 std::string m_frontend_database;
96 xsltStylesheetPtr xsp;
97 std::string cproxy_host;
102 cql_transform_t cqlt;
106 void connect(std::string zurl, int *error, char **addinfo,
108 void search(ZOOM_query q, Odr_int *hits,
109 int *error, char **addinfo, ODR odr);
110 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
111 int *error, char **addinfo, ODR odr);
112 void set_option(const char *name, const char *value);
113 void set_option(const char *name, std::string value);
114 const char *get_option(const char *name);
115 void get_zoom_error(int *error, char **addinfo, ODR odr);
117 class Zoom::Frontend : boost::noncopyable {
122 std::string session_realm;
123 yazpp_1::GDU m_init_gdu;
124 BackendPtr m_backend;
125 void handle_package(mp::Package &package);
126 void handle_search(mp::Package &package);
128 void auth(mp::Package &package, Z_InitRequest *req,
129 int *error, char **addinfo, ODR odr);
131 BackendPtr explain_search(mp::Package &package,
132 std::string &database,
136 std::string torus_url,
137 std::string &torus_db,
139 void handle_present(mp::Package &package);
140 BackendPtr get_backend_from_databases(mp::Package &package,
141 std::string &database,
147 bool create_content_session(mp::Package &package,
152 std::string authentication,
156 void prepare_elements(BackendPtr b,
157 Odr_oid *preferredRecordSyntax,
158 const char *element_set_name,
159 bool &enable_pz2_retrieval,
160 bool &enable_pz2_transform,
161 bool &enable_record_transform,
162 bool &assume_marc8_charset);
164 Z_Records *get_records(Package &package,
166 Odr_int number_to_present,
169 Odr_int *number_of_records_returned,
170 ODR odr, BackendPtr b,
171 Odr_oid *preferredRecordSyntax,
172 const char *element_set_name);
173 Z_Records *get_explain_records(Package &package,
175 Odr_int number_to_present,
178 Odr_int *number_of_records_returned,
179 ODR odr, BackendPtr b,
180 Odr_oid *preferredRecordSyntax,
181 const char *element_set_name);
182 bool retry(mp::Package &package,
185 int &error, char **addinfo,
186 int &proxy_step, int &same_retries,
188 void log_diagnostic(mp::Package &package,
189 int error, const char *addinfo);
191 Frontend(Impl *impl);
195 friend class Frontend;
199 void process(metaproxy_1::Package & package);
200 void configure(const xmlNode * ptr, bool test_only,
203 void configure_local_records(const xmlNode * ptr, bool test_only);
204 bool check_proxy(const char *proxy);
208 FrontendPtr get_frontend(mp::Package &package);
209 void release_frontend(mp::Package &package);
210 SearchablePtr parse_torus_record(const xmlNode *ptr);
211 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
212 std::map<mp::Session, FrontendPtr> m_clients;
213 boost::mutex m_mutex;
214 boost::condition m_cond_session_ready;
215 std::string torus_searchable_url;
216 std::string torus_content_url;
217 std::string torus_auth_url;
218 std::string default_realm;
219 std::map<std::string,std::string> fieldmap;
221 std::string file_path;
222 std::string content_proxy_server;
223 std::string content_tmp_file;
224 std::string content_config_file;
227 std::string element_transform;
228 std::string element_raw;
230 xsltStylesheetPtr explain_xsp;
231 xsltStylesheetPtr record_xsp;
232 std::map<std::string,SearchablePtr> s_map;
233 std::string zoom_timeout;
240 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
244 if (ptr->type == XML_ELEMENT_NODE &&
245 !strcmp((const char *) ptr->name, "recordData"))
251 else // else: we don't want to find nested nodes
253 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
262 // define Pimpl wrapper forwarding to Impl
264 yf::Zoom::Zoom() : m_p(new Impl)
269 { // must have a destructor because of boost::scoped_ptr
272 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
275 m_p->configure(xmlnode, test_only, path);
278 void yf::Zoom::process(mp::Package &package) const
280 m_p->process(package);
284 // define Implementation stuff
286 yf::Zoom::Backend::Backend()
288 m_connection = ZOOM_connection_create(0);
289 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
292 enable_cproxy = true;
293 enable_explain = false;
298 yf::Zoom::Backend::~Backend()
301 xsltFreeStylesheet(xsp);
303 xmlFreeDoc(explain_doc);
304 cql_transform_close(cqlt);
305 ZOOM_connection_destroy(m_connection);
306 ZOOM_resultset_destroy(m_resultset);
310 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
314 const char *zoom_addinfo = 0;
315 const char *dset = 0;
316 int error0 = ZOOM_connection_error_x(m_connection, &msg,
317 &zoom_addinfo, &dset);
323 if (!strcmp(dset, "info:srw/diagnostic/1"))
324 *error = yaz_diag_srw_to_bib1(error0);
325 else if (!strcmp(dset, "Bib-1"))
327 else if (!strcmp(dset, "ZOOM"))
329 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
330 if (error0 == ZOOM_ERROR_INIT)
331 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
332 else if (error0 == ZOOM_ERROR_DECODE)
336 if (strstr(zoom_addinfo, "Authentication") ||
337 strstr(zoom_addinfo, "authentication"))
338 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
343 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
345 *addinfo = (char *) odr_malloc(
346 odr, 30 + strlen(dset) + strlen(msg) +
347 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
349 if (zoom_addinfo && *zoom_addinfo)
351 strcpy(*addinfo, zoom_addinfo);
352 strcat(*addinfo, " ");
354 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
358 void yf::Zoom::Backend::connect(std::string zurl,
359 int *error, char **addinfo,
362 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
363 get_zoom_error(error, addinfo, odr);
366 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
367 int *error, char **addinfo, ODR odr)
369 ZOOM_resultset_destroy(m_resultset);
370 m_resultset = ZOOM_connection_search(m_connection, q);
371 get_zoom_error(error, addinfo, odr);
373 *hits = ZOOM_resultset_size(m_resultset);
378 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
380 int *error, char **addinfo, ODR odr)
382 ZOOM_resultset_records(m_resultset, recs, start, number);
383 get_zoom_error(error, addinfo, odr);
386 void yf::Zoom::Backend::set_option(const char *name, const char *value)
388 ZOOM_connection_option_set(m_connection, name, value);
390 ZOOM_resultset_option_set(m_resultset, name, value);
393 void yf::Zoom::Backend::set_option(const char *name, std::string value)
395 set_option(name, value.c_str());
398 const char *yf::Zoom::Backend::get_option(const char *name)
400 return ZOOM_connection_option_get(m_connection, name);
403 yf::Zoom::Searchable::Searchable(CCL_bibset base)
406 use_turbomarc = true;
407 sortStrategy = "embed";
408 ccl_bibset = ccl_qual_dup(base);
411 yf::Zoom::Searchable::~Searchable()
413 ccl_qual_rm(&ccl_bibset);
416 yf::Zoom::Frontend::Frontend(Impl *impl) :
417 m_p(impl), m_is_virtual(false), m_in_use(true)
421 yf::Zoom::Frontend::~Frontend()
425 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
427 boost::mutex::scoped_lock lock(m_mutex);
429 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
433 it = m_clients.find(package.session());
434 if (it == m_clients.end())
437 if (!it->second->m_in_use)
439 it->second->m_in_use = true;
442 m_cond_session_ready.wait(lock);
444 FrontendPtr f(new Frontend(this));
445 m_clients[package.session()] = f;
450 void yf::Zoom::Impl::release_frontend(mp::Package &package)
452 boost::mutex::scoped_lock lock(m_mutex);
453 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
455 it = m_clients.find(package.session());
456 if (it != m_clients.end())
458 if (package.session().is_closed())
464 it->second->m_in_use = false;
466 m_cond_session_ready.notify_all();
470 yf::Zoom::Impl::Impl() :
471 apdu_log(false), element_transform("pz2") , element_raw("raw"),
472 zoom_timeout("40"), proxy_timeout(1)
474 bibset = ccl_qual_mk();
478 srand((unsigned int) time(0));
481 yf::Zoom::Impl::~Impl()
484 xsltFreeStylesheet(explain_xsp);
485 ccl_qual_rm(&bibset);
488 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
490 Zoom::SearchablePtr s(new Searchable(bibset));
492 for (ptr = ptr->children; ptr; ptr = ptr->next)
494 if (ptr->type != XML_ELEMENT_NODE)
496 if (!strcmp((const char *) ptr->name, "layer"))
498 else if (!strcmp((const char *) ptr->name,
501 s->authentication = mp::xml::get_text(ptr);
503 else if (!strcmp((const char *) ptr->name,
506 s->cfAuth = mp::xml::get_text(ptr);
508 else if (!strcmp((const char *) ptr->name,
511 s->cfProxy = mp::xml::get_text(ptr);
513 else if (!strcmp((const char *) ptr->name,
516 s->cfSubDB = mp::xml::get_text(ptr);
518 else if (!strcmp((const char *) ptr->name,
521 s->contentConnector = mp::xml::get_text(ptr);
523 else if (!strcmp((const char *) ptr->name, "udb"))
525 s->udb = mp::xml::get_text(ptr);
527 else if (!strcmp((const char *) ptr->name, "zurl"))
529 s->target = mp::xml::get_text(ptr);
531 else if (!strcmp((const char *) ptr->name, "sru"))
533 s->sru = mp::xml::get_text(ptr);
535 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
536 !strcmp((const char *) ptr->name, "sruVersion"))
538 s->sru_version = mp::xml::get_text(ptr);
540 else if (!strcmp((const char *) ptr->name,
543 s->query_encoding = mp::xml::get_text(ptr);
545 else if (!strcmp((const char *) ptr->name,
548 s->piggyback = mp::xml::get_bool(ptr, true);
550 else if (!strcmp((const char *) ptr->name,
553 s->request_syntax = mp::xml::get_text(ptr);
555 else if (!strcmp((const char *) ptr->name,
558 s->element_set = mp::xml::get_text(ptr);
560 else if (!strcmp((const char *) ptr->name,
563 s->record_encoding = mp::xml::get_text(ptr);
565 else if (!strcmp((const char *) ptr->name,
568 s->transform_xsl_fname = mp::xml::get_text(ptr);
570 else if (!strcmp((const char *) ptr->name,
573 s->transform_xsl_content = mp::xml::get_text(ptr);
575 else if (!strcmp((const char *) ptr->name,
578 s->urlRecipe = mp::xml::get_text(ptr);
580 else if (!strcmp((const char *) ptr->name,
583 ; // useTurboMarc is ignored
585 else if (!strncmp((const char *) ptr->name,
588 std::string value = mp::xml::get_text(ptr);
589 if (value.length() > 0)
591 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
592 (const char *) ptr->name + 7);
595 else if (!strncmp((const char *) ptr->name,
598 std::string value = mp::xml::get_text(ptr);
599 s->sortmap[(const char *) ptr->name + 8] = value;
601 else if (!strcmp((const char *) ptr->name,
604 s->sortStrategy = mp::xml::get_text(ptr);
606 else if (!strcmp((const char *) ptr->name, "rpn2cql"))
607 s->rpn2cql_fname = mp::xml::get_text(ptr);
612 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
614 while (ptr && ptr->type != XML_ELEMENT_NODE)
619 if (!strcmp((const char *) ptr->name, "records"))
621 for (ptr = ptr->children; ptr; ptr = ptr->next)
623 if (ptr->type != XML_ELEMENT_NODE)
625 if (!strcmp((const char *) ptr->name, "record"))
627 SearchablePtr s = parse_torus_record(ptr);
630 std::string udb = s->udb;
635 throw mp::filter::FilterException
636 ("No udb for local torus record");
642 throw mp::filter::FilterException
644 + std::string((const char *) ptr->name)
645 + " in zoom filter inside element "
652 throw mp::filter::FilterException
654 + std::string((const char *) ptr->name)
655 + " in zoom filter inside element <torus>");
660 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
663 std::string explain_xslt_fname;
664 std::string record_xslt_fname;
670 for (ptr = ptr->children; ptr; ptr = ptr->next)
672 if (ptr->type != XML_ELEMENT_NODE)
674 else if (!strcmp((const char *) ptr->name, "torus"))
676 const struct _xmlAttr *attr;
677 for (attr = ptr->properties; attr; attr = attr->next)
679 if (!strcmp((const char *) attr->name, "url"))
680 torus_searchable_url = mp::xml::get_text(attr->children);
681 else if (!strcmp((const char *) attr->name, "content_url"))
682 torus_content_url = mp::xml::get_text(attr->children);
683 else if (!strcmp((const char *) attr->name, "auth_url"))
684 torus_auth_url = mp::xml::get_text(attr->children);
685 else if (!strcmp((const char *) attr->name, "realm"))
686 default_realm = mp::xml::get_text(attr->children);
687 else if (!strcmp((const char *) attr->name, "xsldir"))
688 xsldir = mp::xml::get_text(attr->children);
689 else if (!strcmp((const char *) attr->name, "element_transform"))
690 element_transform = mp::xml::get_text(attr->children);
691 else if (!strcmp((const char *) attr->name, "element_raw"))
692 element_raw = mp::xml::get_text(attr->children);
693 else if (!strcmp((const char *) attr->name, "proxy"))
694 proxy = mp::xml::get_text(attr->children);
695 else if (!strcmp((const char *) attr->name, "explain_xsl"))
696 explain_xslt_fname = mp::xml::get_text(attr->children);
697 else if (!strcmp((const char *) attr->name, "record_xsl"))
698 record_xslt_fname = mp::xml::get_text(attr->children);
700 throw mp::filter::FilterException(
701 "Bad attribute " + std::string((const char *)
704 // If content_url is not given, use value of searchable, to
705 // ensure backwards compatibility
706 if (!torus_content_url.length())
707 torus_content_url = torus_searchable_url;
708 configure_local_records(ptr->children, test_only);
710 else if (!strcmp((const char *) ptr->name, "cclmap"))
712 const char *addinfo = 0;
713 ccl_xml_config(bibset, ptr, &addinfo);
715 else if (!strcmp((const char *) ptr->name, "fieldmap"))
717 const struct _xmlAttr *attr;
718 std::string ccl_field;
719 std::string cql_field;
720 for (attr = ptr->properties; attr; attr = attr->next)
722 if (!strcmp((const char *) attr->name, "ccl"))
723 ccl_field = mp::xml::get_text(attr->children);
724 else if (!strcmp((const char *) attr->name, "cql"))
725 cql_field = mp::xml::get_text(attr->children);
727 throw mp::filter::FilterException(
728 "Bad attribute " + std::string((const char *)
731 if (cql_field.length())
732 fieldmap[cql_field] = ccl_field;
734 else if (!strcmp((const char *) ptr->name, "contentProxy"))
736 const struct _xmlAttr *attr;
737 for (attr = ptr->properties; attr; attr = attr->next)
739 if (!strcmp((const char *) attr->name, "server"))
742 "contentProxy's server attribute is deprecated");
744 "Specify config_file instead. For example:");
746 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
747 content_proxy_server = mp::xml::get_text(attr->children);
749 else if (!strcmp((const char *) attr->name, "tmp_file"))
750 content_tmp_file = mp::xml::get_text(attr->children);
751 else if (!strcmp((const char *) attr->name, "config_file"))
752 content_config_file = mp::xml::get_text(attr->children);
754 throw mp::filter::FilterException(
755 "Bad attribute " + std::string((const char *)
759 else if (!strcmp((const char *) ptr->name, "log"))
761 const struct _xmlAttr *attr;
762 for (attr = ptr->properties; attr; attr = attr->next)
764 if (!strcmp((const char *) attr->name, "apdu"))
765 apdu_log = mp::xml::get_bool(attr->children, false);
767 throw mp::filter::FilterException(
768 "Bad attribute " + std::string((const char *)
772 else if (!strcmp((const char *) ptr->name, "zoom"))
774 const struct _xmlAttr *attr;
775 for (attr = ptr->properties; attr; attr = attr->next)
777 if (!strcmp((const char *) attr->name, "timeout"))
778 zoom_timeout = mp::xml::get_text(attr->children);
779 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
780 proxy_timeout = mp::xml::get_int(attr->children, 1);
782 throw mp::filter::FilterException(
783 "Bad attribute " + std::string((const char *)
789 throw mp::filter::FilterException
791 + std::string((const char *) ptr->name)
792 + " in zoom filter");
796 if (explain_xslt_fname.length())
798 const char *path = 0;
801 path = xsldir.c_str();
803 path = file_path.c_str();
806 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
810 throw mp::filter::FilterException
811 ("Cannot read XSLT " + explain_xslt_fname);
814 xmlDoc *xsp_doc = xmlParseFile(cp);
817 throw mp::filter::FilterException
818 ("Cannot parse XSLT " + explain_xslt_fname);
821 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
825 throw mp::filter::FilterException
826 ("Cannot parse XSLT " + explain_xslt_fname);
831 if (record_xslt_fname.length())
833 const char *path = 0;
836 path = xsldir.c_str();
838 path = file_path.c_str();
841 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
845 throw mp::filter::FilterException
846 ("Cannot read XSLT " + record_xslt_fname);
849 xmlDoc *xsp_doc = xmlParseFile(cp);
852 throw mp::filter::FilterException
853 ("Cannot parse XSLT " + record_xslt_fname);
856 record_xsp = xsltParseStylesheetDoc(xsp_doc);
860 throw mp::filter::FilterException
861 ("Cannot parse XSLT " + record_xslt_fname);
867 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
869 int *error, char **addinfo,
871 std::string authentication,
875 if (b->sptr->contentConnector.length())
877 std::string proxyhostname;
878 std::string tmp_file;
879 bool legacy_format = false;
881 if (m_p->content_proxy_server.length())
883 proxyhostname = m_p->content_proxy_server;
884 legacy_format = true;
887 if (m_p->content_tmp_file.length())
888 tmp_file = m_p->content_tmp_file;
890 if (m_p->content_config_file.length())
892 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
896 while (fgets(buf, sizeof(buf)-1, inf))
899 cp = strchr(buf, '#');
902 cp = strchr(buf, '\n');
905 cp = strchr(buf, ':');
909 while (cp1 != buf && cp1[-1] == ' ')
915 if (!strcmp(buf, "proxyhostname"))
917 if (!strcmp(buf, "sessiondir") && *cp)
919 if (cp[strlen(cp)-1] == '/')
920 cp[strlen(cp)-1] = '\0';
921 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
929 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
930 "unable to open content config %s",
931 m_p->content_config_file.c_str());
932 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
933 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
934 sprintf(*addinfo, "unable to open content config %s",
935 m_p->content_config_file.c_str());
940 if (proxyhostname.length() == 0)
942 package.log("zoom", YLOG_WARN, "no proxyhostname");
945 if (tmp_file.length() == 0)
947 package.log("zoom", YLOG_WARN, "no tmp_file");
951 char *fname = xstrdup(tmp_file.c_str());
952 char *xx = strstr(fname, "XXXXXX");
955 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
956 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
957 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
958 sprintf(*addinfo, "bad format of content tmp_file: %s",
963 char tmp_char = xx[6];
964 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
966 b->cproxy_host = std::string(xx) + "." + proxyhostname;
968 b->cproxy_host = proxyhostname + "/" + xx;
971 FILE *file = fopen(fname, "w");
974 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
975 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
976 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
977 sprintf(*addinfo, "Could not create %s", fname);
982 wrbuf_puts(w, "#content_proxy\n");
983 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
984 if (authentication.length())
985 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
987 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
989 wrbuf_printf(w, "realm: %s\n", realm.c_str());
991 fwrite(w.buf(), 1, w.len(), file);
993 package.log("zoom", YLOG_LOG, "content file: %s", fname);
999 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
1000 mp::Package &package,
1001 std::string &database, int *error, char **addinfo, mp::odr &odr,
1004 bool connection_reuse = false;
1007 std::list<BackendPtr>::const_iterator map_it;
1008 if (m_backend && !m_backend->enable_explain &&
1009 m_backend->m_frontend_database == database)
1011 connection_reuse = true;
1012 proxy = m_backend->m_proxy;
1015 std::string input_args;
1016 std::string torus_db;
1017 size_t db_arg_pos = database.find(',');
1018 if (db_arg_pos != std::string::npos)
1020 torus_db = database.substr(0, db_arg_pos);
1021 input_args = database.substr(db_arg_pos + 1);
1024 torus_db = database;
1026 std::string authentication;
1027 std::string content_authentication;
1028 std::string content_proxy;
1029 std::string realm = session_realm;
1030 if (realm.length() == 0)
1031 realm = m_p->default_realm;
1033 const char *param_user = 0;
1034 const char *param_password = 0;
1035 const char *param_content_user = 0;
1036 const char *param_content_password = 0;
1037 const char *param_nocproxy = 0;
1042 int no_out_args = 0;
1043 if (input_args.length())
1044 no_parms = yaz_uri_to_array(input_args.c_str(),
1045 odr, &names, &values);
1046 // adding 10 because we'll be adding other URL args
1047 const char **out_names = (const char **)
1048 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1049 const char **out_values = (const char **)
1050 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1052 // may be changed if it's a content connection
1053 std::string torus_url = m_p->torus_searchable_url;
1055 for (i = 0; i < no_parms; i++)
1057 const char *name = names[i];
1058 const char *value = values[i];
1061 if (!strcmp(name, "user"))
1063 else if (!strcmp(name, "password"))
1064 param_password = value;
1065 else if (!strcmp(name, "content-user"))
1066 param_content_user = value;
1067 else if (!strcmp(name, "content-password"))
1068 param_content_password = value;
1069 else if (!strcmp(name, "content-proxy"))
1070 content_proxy = value;
1071 else if (!strcmp(name, "nocproxy"))
1072 param_nocproxy = value;
1073 else if (!strcmp(name, "proxy"))
1077 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1078 if (connection_reuse)
1080 // find the step after our current proxy
1082 for (i = 0; i < dnum; i++)
1083 if (!strcmp(proxy.c_str(), dstr[i]))
1088 *proxy_step = i + 1;
1092 // step is known.. Guess our proxy from it
1093 if (*proxy_step >= dnum)
1097 proxy = dstr[*proxy_step];
1100 if (*proxy_step == dnum)
1105 else if (!strcmp(name, "cproxysession"))
1107 out_names[no_out_args] = name;
1108 out_values[no_out_args++] = value;
1109 torus_url = m_p->torus_content_url;
1111 else if (!strcmp(name, "realm") && session_realm.length() == 0)
1113 else if (!strcmp(name, "torus_url") && session_realm.length() == 0)
1115 else if (name[0] == 'x' && name[1] == '-')
1117 out_names[no_out_args] = name;
1118 out_values[no_out_args++] = value;
1122 BackendPtr notfound;
1123 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1124 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1125 sprintf(msg, "Bad database argument: %s", name);
1131 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1133 if (connection_reuse)
1135 m_backend->connect("", error, addinfo, odr);
1141 authentication = std::string(param_user);
1143 authentication += "/" + std::string(param_password);
1145 if (param_content_user)
1147 content_authentication = std::string(param_content_user);
1148 if (param_content_password)
1149 content_authentication += "/" + std::string(param_content_password);
1152 if (torus_db.compare("IR-Explain---1") == 0)
1153 return explain_search(package, database, error, addinfo, odr, torus_url,
1158 std::map<std::string,SearchablePtr>::iterator it;
1159 it = m_p->s_map.find(torus_db);
1160 if (it != m_p->s_map.end())
1162 else if (torus_url.length() > 0)
1164 std::string torus_query = "udb==" + torus_db;
1165 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1170 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1171 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1172 "incorrectly configured");
1176 const xmlNode *ptr = xmlDocGetRootElement(doc);
1177 if (ptr && ptr->type == XML_ELEMENT_NODE)
1179 if (!strcmp((const char *) ptr->name, "record"))
1181 sptr = m_p->parse_torus_record(ptr);
1183 else if (!strcmp((const char *) ptr->name, "records"))
1185 for (ptr = ptr->children; ptr; ptr = ptr->next)
1187 if (ptr->type == XML_ELEMENT_NODE
1188 && !strcmp((const char *) ptr->name, "record"))
1192 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1194 odr_malloc(odr, 40 + torus_db.length());
1195 sprintf(*addinfo, "multiple records for udb=%s",
1201 sptr = m_p->parse_torus_record(ptr);
1207 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1208 *addinfo = (char*) odr_malloc(
1209 odr, 40 + strlen((const char *) ptr->name));
1210 sprintf(*addinfo, "bad root element for torus: %s", ptr->name);
1221 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1222 *addinfo = odr_strdup(odr, torus_db.c_str());
1227 xsltStylesheetPtr xsp = 0;
1228 if (sptr->transform_xsl_content.length())
1230 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1231 sptr->transform_xsl_content.length());
1234 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1235 *addinfo = (char *) odr_malloc(odr, 40);
1236 sprintf(*addinfo, "xmlParseMemory failed");
1240 xsp = xsltParseStylesheetDoc(xsp_doc);
1243 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1244 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1246 xmlFreeDoc(xsp_doc);
1250 else if (sptr->transform_xsl_fname.length())
1252 const char *path = 0;
1254 if (m_p->xsldir.length())
1255 path = m_p->xsldir.c_str();
1257 path = m_p->file_path.c_str();
1260 char fullpath[1024];
1261 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1267 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1269 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1270 sprintf(*addinfo, "File could not be read: %s",
1271 sptr->transform_xsl_fname.c_str());
1275 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1278 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1279 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1280 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1284 xsp = xsltParseStylesheetDoc(xsp_doc);
1287 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1288 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1290 xmlFreeDoc(xsp_doc);
1295 cql_transform_t cqlt = 0;
1296 if (sptr->rpn2cql_fname.length())
1298 char fullpath[1024];
1299 char *cp = yaz_filepath_resolve(sptr->rpn2cql_fname.c_str(),
1300 m_p->file_path.c_str(), 0, fullpath);
1302 cqlt = cql_transform_open_fname(fullpath);
1305 cqlt = cql_transform_create();
1309 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1310 *addinfo = odr_strdup(odr, "Missing/invalid cql2rpn file");
1312 xsltFreeStylesheet(xsp);
1318 BackendPtr b(new Backend);
1323 b->m_frontend_database = database;
1324 b->enable_cproxy = param_nocproxy ? false : true;
1326 if (sptr->query_encoding.length())
1327 b->set_option("rpnCharset", sptr->query_encoding);
1329 b->set_option("timeout", m_p->zoom_timeout.c_str());
1332 b->set_option("apdulog", "1");
1334 if (sptr->piggyback && sptr->sru.length())
1335 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1336 maximumRecords > 0 */
1337 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1339 if (authentication.length() == 0)
1340 authentication = sptr->authentication;
1342 if (proxy.length() == 0)
1343 proxy = sptr->cfProxy;
1346 if (sptr->cfAuth.length())
1349 b->set_option("user", sptr->cfAuth);
1350 if (authentication.length())
1352 size_t found = authentication.find('/');
1353 if (found != std::string::npos)
1355 out_names[no_out_args] = "user";
1356 out_values[no_out_args++] =
1357 odr_strdup(odr, authentication.substr(0, found).c_str());
1359 out_names[no_out_args] = "password";
1360 out_values[no_out_args++] =
1361 odr_strdup(odr, authentication.substr(found+1).c_str());
1365 out_names[no_out_args] = "user";
1366 out_values[no_out_args++] =
1367 odr_strdup(odr, authentication.c_str());
1372 out_names[no_out_args] = "proxy";
1373 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1375 if (sptr->cfSubDB.length())
1377 out_names[no_out_args] = "subdatabase";
1378 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1382 out_names[no_out_args] = "nocproxy";
1383 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1388 size_t found = authentication.find('/');
1390 if (sptr->sru.length() && found != std::string::npos)
1392 b->set_option("user", authentication.substr(0, found));
1393 b->set_option("password", authentication.substr(found+1));
1396 b->set_option("user", authentication);
1399 b->set_option("proxy", proxy);
1402 if (sptr->sru.length())
1404 url = "http://" + sptr->target;
1405 b->set_option("sru", sptr->sru);
1407 if (sptr->sru_version.length())
1408 b->set_option("sru_version", sptr->sru_version);
1417 out_names[no_out_args] = 0; // terminate list
1419 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1420 (char **) out_values);
1421 url += "," + std::string(x_args);
1423 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1424 b->connect(url, error, addinfo, odr);
1425 if (*error == 0 && b->enable_cproxy)
1426 create_content_session(package, b, error, addinfo, odr,
1427 content_authentication.length() ?
1428 content_authentication : authentication,
1429 content_proxy.length() ? content_proxy : proxy,
1436 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1437 Odr_oid *preferredRecordSyntax,
1438 const char *element_set_name,
1439 bool &enable_pz2_retrieval,
1440 bool &enable_pz2_transform,
1441 bool &enable_record_transform,
1442 bool &assume_marc8_charset)
1444 char oid_name_str[OID_STR_MAX];
1445 const char *syntax_name = 0;
1447 if (preferredRecordSyntax &&
1448 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1450 if (element_set_name &&
1451 !strcmp(element_set_name, m_p->element_transform.c_str()))
1453 enable_pz2_retrieval = true;
1454 enable_pz2_transform = true;
1456 else if (element_set_name &&
1457 !strcmp(element_set_name, m_p->element_raw.c_str()))
1459 enable_pz2_retrieval = true;
1461 else if (m_p->record_xsp)
1463 enable_pz2_retrieval = true;
1464 enable_pz2_transform = true;
1465 enable_record_transform = true;
1469 if (enable_pz2_retrieval)
1471 std::string configured_request_syntax = b->sptr->request_syntax;
1472 if (configured_request_syntax.length())
1474 syntax_name = configured_request_syntax.c_str();
1475 const Odr_oid *syntax_oid =
1476 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1477 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1478 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1479 assume_marc8_charset = true;
1482 else if (preferredRecordSyntax)
1484 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1486 if (b->sptr->sru.length())
1487 syntax_name = "XML";
1489 b->set_option("preferredRecordSyntax", syntax_name);
1491 if (enable_pz2_retrieval)
1493 element_set_name = 0;
1494 if (b->sptr->element_set.length())
1495 element_set_name = b->sptr->element_set.c_str();
1498 b->set_option("elementSetName", element_set_name);
1499 if (b->sptr->sru.length() && element_set_name)
1500 b->set_option("schema", element_set_name);
1503 Z_Records *yf::Zoom::Frontend::get_explain_records(
1504 mp::Package &package,
1506 Odr_int number_to_present,
1509 Odr_int *number_of_records_returned,
1512 Odr_oid *preferredRecordSyntax,
1513 const char *element_set_name)
1516 Z_Records *records = 0;
1518 if (!b->explain_doc)
1522 if (number_to_present > 10000)
1523 number_to_present = 10000;
1525 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1527 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1528 odr_malloc(odr, sizeof(*npl));
1529 npl->records = (Z_NamePlusRecord **)
1530 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1532 for (i = 0; i < number_to_present; i++)
1535 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1538 xmlBufferPtr xml_buf = xmlBufferCreate();
1539 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1540 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1542 Z_NamePlusRecord *npr =
1543 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1544 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1545 npr->which = Z_NamePlusRecord_databaseRecord;
1546 npr->u.databaseRecord =
1547 z_ext_record_xml(odr,
1548 (const char *) xml_buf->content, xml_buf->use);
1549 npl->records[i] = npr;
1550 xmlFreeNode(tmp_node);
1551 xmlBufferFree(xml_buf);
1553 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1554 records->which = Z_Records_DBOSD;
1555 records->u.databaseOrSurDiagnostics = npl;
1557 npl->num_records = i;
1558 *number_of_records_returned = i;
1563 Z_Records *yf::Zoom::Frontend::get_records(mp::Package &package,
1565 Odr_int number_to_present,
1568 Odr_int *number_of_records_returned,
1571 Odr_oid *preferredRecordSyntax,
1572 const char *element_set_name)
1574 *number_of_records_returned = 0;
1575 Z_Records *records = 0;
1576 bool enable_pz2_retrieval = false; // whether target profile is used
1577 bool enable_pz2_transform = false; // whether XSLT is used as well
1578 bool assume_marc8_charset = false;
1579 bool enable_record_transform = false;
1581 prepare_elements(b, preferredRecordSyntax,
1583 enable_pz2_retrieval,
1584 enable_pz2_transform,
1585 enable_record_transform,
1586 assume_marc8_charset);
1588 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1589 enable_pz2_retrieval ? "yes" : "no",
1590 enable_pz2_transform ? "yes" : "no");
1592 if (start < 0 || number_to_present <=0)
1595 if (number_to_present > 10000)
1596 number_to_present = 10000;
1598 ZOOM_record *recs = (ZOOM_record *)
1599 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1601 b->present(start, number_to_present, recs, error, addinfo, odr);
1606 for (i = 0; i < number_to_present; i++)
1611 { // only return records if no error and at least one record
1613 const char *xsl_parms[3];
1614 mp::wrbuf cproxy_host;
1616 if (b->enable_cproxy && b->cproxy_host.length())
1618 wrbuf_puts(cproxy_host, "\"");
1619 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1620 wrbuf_puts(cproxy_host, "/\"");
1622 xsl_parms[0] = "cproxyhost";
1623 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1631 char *odr_database = odr_strdup(odr,
1632 b->m_frontend_database.c_str());
1633 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1634 odr_malloc(odr, sizeof(*npl));
1635 *number_of_records_returned = i;
1636 npl->num_records = i;
1637 npl->records = (Z_NamePlusRecord **)
1638 odr_malloc(odr, i * sizeof(*npl->records));
1639 for (i = 0; i < number_to_present; i++)
1641 Z_NamePlusRecord *npr = 0;
1642 const char *addinfo;
1644 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1645 &addinfo, 0 /* diagset */);
1649 log_diagnostic(package, sur_error, addinfo);
1650 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1653 else if (enable_pz2_retrieval)
1655 char rec_type_str[100];
1656 const char *record_encoding = 0;
1658 if (b->sptr->record_encoding.length())
1659 record_encoding = b->sptr->record_encoding.c_str();
1660 else if (assume_marc8_charset)
1661 record_encoding = "marc8";
1663 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1664 if (record_encoding)
1666 strcat(rec_type_str, "; charset=");
1667 strcat(rec_type_str, record_encoding);
1670 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1673 xmlChar *xmlrec_buf = 0;
1674 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1676 if (!rec_buf && !npr)
1678 std::string addinfo("ZOOM_record_get failed for type ");
1680 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1681 addinfo += rec_type_str;
1682 log_diagnostic(package, error, addinfo.c_str());
1683 npr = zget_surrogateDiagRec(odr, odr_database,
1684 error, addinfo.c_str());
1688 package.log_write(rec_buf, rec_len);
1689 package.log_write("\r\n", 2);
1692 if (rec_buf && b->xsp && enable_pz2_transform)
1694 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1697 const char *addinfo = "xml parse failed for record";
1698 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1699 log_diagnostic(package, error, addinfo);
1700 npr = zget_surrogateDiagRec(
1701 odr, odr_database, error, addinfo);
1705 // first stage XSLT - per target
1706 xsltStylesheetPtr xsp = b->xsp;
1707 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1709 // insert generated-url
1713 mp::xml::url_recipe_handle(rec_res,
1714 b->sptr->urlRecipe);
1717 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1718 while (ptr && ptr->type != XML_ELEMENT_NODE)
1721 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1722 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1724 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1728 // second stage XSLT - common
1729 if (rec_res && m_p->record_xsp &&
1730 enable_record_transform)
1732 xmlDoc *tmp_doc = rec_res;
1734 xsp = m_p->record_xsp;
1735 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1737 xmlFreeDoc(tmp_doc);
1739 // get result out of it
1742 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1744 rec_buf = (const char *) xmlrec_buf;
1745 package.log_write(rec_buf, rec_len);
1747 xmlFreeDoc(rec_res);
1751 std::string addinfo;
1753 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1755 addinfo = "xslt apply failed for "
1756 + b->sptr->transform_xsl_fname;
1757 log_diagnostic(package, error, addinfo.c_str());
1758 npr = zget_surrogateDiagRec(
1759 odr, odr_database, error, addinfo.c_str());
1761 xmlFreeDoc(rec_doc);
1768 npr = zget_surrogateDiagRec(
1770 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1774 npr = (Z_NamePlusRecord *)
1775 odr_malloc(odr, sizeof(*npr));
1776 npr->databaseName = odr_database;
1777 npr->which = Z_NamePlusRecord_databaseRecord;
1778 npr->u.databaseRecord =
1779 z_ext_record_xml(odr, rec_buf, rec_len);
1783 xmlFree(xmlrec_buf);
1788 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1791 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1792 npr->databaseName = odr_database;
1793 npr->which = Z_NamePlusRecord_databaseRecord;
1794 npr->u.databaseRecord = ext;
1798 npr = zget_surrogateDiagRec(
1800 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1801 "ZOOM_record, type ext");
1804 npl->records[i] = npr;
1806 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1807 records->which = Z_Records_DBOSD;
1808 records->u.databaseOrSurDiagnostics = npl;
1813 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1816 struct cql_node *r = 0;
1824 std::map<std::string,std::string>::const_iterator it;
1825 it = fieldmap.find(cn->u.st.index);
1826 if (it == fieldmap.end())
1828 if (it->second.length())
1829 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1835 r = convert_cql_fields(cn->u.boolean.left, odr);
1837 r = convert_cql_fields(cn->u.boolean.right, odr);
1840 r = convert_cql_fields(cn->u.sort.search, odr);
1846 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1847 int error, const char *addinfo)
1849 const char *err_msg = yaz_diag_bib1_str(error);
1851 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1852 error, err_msg, addinfo);
1854 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1858 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1859 std::string &database,
1863 std::string torus_url,
1864 std::string &torus_db,
1869 BackendPtr b(new Backend);
1871 b->m_frontend_database = database;
1872 b->enable_explain = true;
1874 Z_GDU *gdu = package.request().get();
1875 Z_APDU *apdu_req = gdu->u.z3950;
1876 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1877 Z_Query *query = sr->query;
1879 if (!m_p->explain_xsp)
1881 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1883 odr_strdup(odr, "IR-Explain---1 unsupported. "
1884 "Torus explain_xsl not defined");
1887 else if (query->which == Z_Query_type_104 &&
1888 query->u.type_104->which == Z_External_CQL)
1890 std::string torus_query(query->u.type_104->u.cql);
1891 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1894 if (m_p->explain_xsp)
1896 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1903 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1904 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1905 "incorrectly configured");
1909 xmlNode *ptr = xmlDocGetRootElement(doc);
1912 xml_node_search(ptr, &hits, 0);
1914 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1915 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1916 package.response() = apdu_res;
1920 xmlFreeDoc(b->explain_doc);
1921 b->explain_doc = doc;
1926 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1927 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1932 static bool wait_conn(COMSTACK cs, int secs)
1934 struct yaz_poll_fd pfd;
1936 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1937 if (cs->io_pending && CS_WANT_WRITE)
1938 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1939 if (cs->io_pending & CS_WANT_READ)
1940 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1942 pfd.fd = cs_fileno(cs);
1943 pfd.client_data = 0;
1945 int ret = yaz_poll(&pfd, 1, secs, 0);
1949 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1952 const char *uri = "http://localhost/";
1955 bool outcome = false;
1956 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1961 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1962 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1964 if (z_GDU(odr, &gdu, 0, 0))
1967 char *buf = odr_getbuf(odr, &len, 0);
1969 int ret = cs_connect(conn, add);
1970 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
1974 ret = cs_put(conn, buf, len);
1977 if (!wait_conn(conn, proxy_timeout))
1988 bool yf::Zoom::Frontend::retry(mp::Package &package,
1991 int &error, char **addinfo,
1992 int &proxy_step, int &same_retries,
1995 if (b && b->m_proxy.length() && !m_p->check_proxy(b->m_proxy.c_str()))
1997 log_diagnostic(package, error, *addinfo);
1998 package.log("zoom", YLOG_LOG, "proxy %s fails", b->m_proxy.c_str());
2000 if (proxy_step) // there is a failover
2003 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2006 error = YAZ_BIB1_PROXY_FAILURE;
2007 *addinfo = odr_strdup(odr, b->m_proxy.c_str());
2009 else if (same_retries == 0 && proxy_retries == 0)
2011 log_diagnostic(package, error, *addinfo);
2013 package.log("zoom", YLOG_WARN, "search failed: retry");
2021 void yf::Zoom::Frontend::handle_search(mp::Package &package)
2023 Z_GDU *gdu = package.request().get();
2024 Z_APDU *apdu_req = gdu->u.z3950;
2025 Z_APDU *apdu_res = 0;
2027 Z_SearchRequest *sr = apdu_req->u.searchRequest;
2028 if (sr->num_databaseNames != 1)
2030 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
2031 log_diagnostic(package, error, 0);
2032 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
2033 package.response() = apdu_res;
2037 int same_retries = 0;
2038 int proxy_retries = 0;
2044 std::string db(sr->databaseNames[0]);
2046 BackendPtr b = get_backend_from_databases(package, db, &error,
2047 &addinfo, odr, &proxy_step);
2050 if (retry(package, odr, b, error, &addinfo, proxy_step,
2051 same_retries, proxy_retries))
2056 log_diagnostic(package, error, addinfo);
2057 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2058 package.response() = apdu_res;
2061 if (!b || b->enable_explain)
2064 b->set_option("setname", "default");
2066 bool enable_pz2_retrieval = false;
2067 bool enable_pz2_transform = false;
2068 bool enable_record_transform = false;
2069 bool assume_marc8_charset = false;
2070 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
2071 enable_pz2_retrieval,
2072 enable_pz2_transform,
2073 enable_record_transform,
2074 assume_marc8_charset);
2077 Z_Query *query = sr->query;
2078 mp::wrbuf ccl_wrbuf;
2079 mp::wrbuf pqf_wrbuf;
2080 std::string sortkeys;
2082 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
2085 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
2087 else if (query->which == Z_Query_type_2)
2090 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
2091 query->u.type_2->len);
2093 else if (query->which == Z_Query_type_104 &&
2094 query->u.type_104->which == Z_External_CQL)
2097 const char *cql = query->u.type_104->u.cql;
2098 CQL_parser cp = cql_parser_create();
2099 int r = cql_parser_string(cp, cql);
2100 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
2103 cql_parser_destroy(cp);
2104 error = YAZ_BIB1_MALFORMED_QUERY;
2105 const char *addinfo = "CQL syntax error";
2106 log_diagnostic(package, error, addinfo);
2108 odr.create_searchResponse(apdu_req, error, addinfo);
2109 package.response() = apdu_res;
2112 struct cql_node *cn = cql_parser_result(cp);
2113 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2116 // hopefully we are getting a ptr to a index+relation+term node
2117 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2119 if (cn_error->which == CQL_NODE_ST)
2120 addinfo = cn_error->u.st.index;
2122 log_diagnostic(package, error, addinfo);
2123 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2124 package.response() = apdu_res;
2125 cql_parser_destroy(cp);
2128 r = cql_to_ccl(cn, wrbuf_vp_puts, ccl_wrbuf);
2131 error = YAZ_BIB1_MALFORMED_QUERY;
2132 const char *addinfo = "CQL to CCL conversion error";
2134 log_diagnostic(package, error, addinfo);
2135 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2136 package.response() = apdu_res;
2137 cql_parser_destroy(cp);
2141 mp::wrbuf sru_sortkeys_wrbuf;
2142 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2144 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2145 const char *addinfo = "CQL to CCL sortby conversion";
2147 log_diagnostic(package, error, addinfo);
2148 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2149 package.response() = apdu_res;
2150 cql_parser_destroy(cp);
2153 mp::wrbuf sort_spec_wrbuf;
2154 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2156 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2157 yaz_tok_parse_t tp =
2158 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2159 yaz_tok_cfg_destroy(tc);
2161 /* go through sortspec and map fields */
2162 int token = yaz_tok_move(tp);
2163 while (token != YAZ_TOK_EOF)
2165 if (token == YAZ_TOK_STRING)
2167 const char *field = yaz_tok_parse_string(tp);
2168 std::map<std::string,std::string>::iterator it;
2169 it = b->sptr->sortmap.find(field);
2170 if (it != b->sptr->sortmap.end())
2171 sortkeys += it->second;
2176 token = yaz_tok_move(tp);
2177 if (token == YAZ_TOK_STRING)
2179 sortkeys += yaz_tok_parse_string(tp);
2181 if (token != YAZ_TOK_EOF)
2184 token = yaz_tok_move(tp);
2187 yaz_tok_parse_destroy(tp);
2188 cql_parser_destroy(cp);
2192 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2193 const char *addinfo = 0;
2194 log_diagnostic(package, error, addinfo);
2195 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2196 package.response() = apdu_res;
2200 if (ccl_wrbuf.len())
2203 assert(pqf_wrbuf.len() == 0);
2205 struct ccl_rpn_node *cn;
2206 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2207 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2211 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2212 error = YAZ_BIB1_MALFORMED_QUERY;
2216 case CCL_ERR_UNKNOWN_QUAL:
2217 case CCL_ERR_TRUNC_NOT_LEFT:
2218 case CCL_ERR_TRUNC_NOT_RIGHT:
2219 case CCL_ERR_TRUNC_NOT_BOTH:
2220 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2221 case CCL_ERR_TRUNC_NOT_EMBED:
2223 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2224 case CCL_ERR_TRUNC_NOT_SINGLE:
2226 error = YAZ_BIB1_UNSUPP_SEARCH;
2229 log_diagnostic(package, error, addinfo);
2230 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2231 package.response() = apdu_res;
2234 ccl_pquery(pqf_wrbuf, cn);
2235 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2239 assert(pqf_wrbuf.len());
2241 ZOOM_query q = ZOOM_query_create();
2242 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2244 if (b->get_option("sru"))
2248 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2251 if (!strcmp(b->get_option("sru"), "solr"))
2253 solr_transform_t cqlt = solr_transform_create();
2255 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2257 solr_transform_close(cqlt);
2261 status = cql_transform_rpn2cql_wrbuf(b->cqlt, wrb, zquery);
2265 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2266 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2267 b->search(q, &hits, &error, &addinfo, odr);
2269 ZOOM_query_destroy(q);
2273 error = YAZ_BIB1_MALFORMED_QUERY;
2274 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2275 log_diagnostic(package, error, addinfo);
2276 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2277 package.response() = apdu_res;
2283 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2284 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2285 b->search(q, &hits, &error, &addinfo, odr);
2286 ZOOM_query_destroy(q);
2291 if (retry(package, odr, b, error, &addinfo, proxy_step,
2292 same_retries, proxy_retries))
2296 const char *element_set_name = 0;
2297 Odr_int number_to_present = 0;
2299 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2301 Odr_int number_of_records_returned = 0;
2302 Z_Records *records = get_records(
2304 0, number_to_present, &error, &addinfo,
2305 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2308 log_diagnostic(package, error, addinfo);
2309 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2312 apdu_res->u.searchResponse->records = records;
2313 apdu_res->u.searchResponse->numberOfRecordsReturned =
2314 odr_intdup(odr, number_of_records_returned);
2316 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2317 package.response() = apdu_res;
2320 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2322 Z_GDU *gdu = package.request().get();
2323 Z_APDU *apdu_req = gdu->u.z3950;
2324 Z_APDU *apdu_res = 0;
2325 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2330 package.response() = odr.create_presentResponse(
2331 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2334 const char *element_set_name = 0;
2335 Z_RecordComposition *comp = pr->recordComposition;
2336 if (comp && comp->which != Z_RecordComp_simple)
2338 package.response() = odr.create_presentResponse(
2340 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2343 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2344 element_set_name = comp->u.simple->u.generic;
2345 Odr_int number_of_records_returned = 0;
2349 if (m_backend->enable_explain)
2351 Z_Records *records =
2352 get_explain_records(
2354 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2355 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2356 pr->preferredRecordSyntax, element_set_name);
2358 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2361 apdu_res->u.presentResponse->records = records;
2362 apdu_res->u.presentResponse->numberOfRecordsReturned =
2363 odr_intdup(odr, number_of_records_returned);
2365 package.response() = apdu_res;
2369 Z_Records *records =
2370 get_records(package,
2371 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2372 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2373 pr->preferredRecordSyntax, element_set_name);
2375 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2378 apdu_res->u.presentResponse->records = records;
2379 apdu_res->u.presentResponse->numberOfRecordsReturned =
2380 odr_intdup(odr, number_of_records_returned);
2382 package.response() = apdu_res;
2386 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2388 Z_GDU *gdu = package.request().get();
2391 else if (gdu->which == Z_GDU_Z3950)
2393 Z_APDU *apdu_req = gdu->u.z3950;
2396 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2397 if (apdu_req->which == Z_APDU_initRequest)
2400 package.response() = odr.create_close(
2402 Z_Close_protocolError,
2405 else if (apdu_req->which == Z_APDU_searchRequest)
2407 handle_search(package);
2409 else if (apdu_req->which == Z_APDU_presentRequest)
2411 handle_present(package);
2416 package.response() = odr.create_close(
2418 Z_Close_protocolError,
2419 "zoom filter cannot handle this APDU");
2420 package.session().close();
2424 WRBUF w = m_backend->m_apdu_wrbuf;
2425 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2430 package.session().close();
2434 std::string escape_cql_term(std::string inp)
2437 size_t l = inp.length();
2439 for (i = 0; i < l; i++)
2441 if (strchr("*?^\"", inp[i]))
2448 void yf::Zoom::Frontend::auth(mp::Package &package, Z_InitRequest *req,
2449 int *error, char **addinfo, ODR odr)
2451 if (m_p->torus_auth_url.length() == 0)
2455 std::string password;
2456 if (req->idAuthentication)
2458 Z_IdAuthentication *auth = req->idAuthentication;
2459 switch (auth->which)
2461 case Z_IdAuthentication_open:
2464 const char *cp = strchr(auth->u.open, '/');
2467 user.assign(auth->u.open, cp - auth->u.open);
2468 password.assign(cp + 1);
2472 case Z_IdAuthentication_idPass:
2473 if (auth->u.idPass->userId)
2474 user.assign(auth->u.idPass->userId);
2475 if (auth->u.idPass->password)
2476 password.assign(auth->u.idPass->password);
2481 std::string ip = package.origin().get_address();
2482 yaz_log(YLOG_LOG, "IP=%s", ip.c_str());
2484 std::string torus_query;
2487 if (user.length() && password.length())
2489 torus_query = "userName==\"" + escape_cql_term(user) +
2490 "\" and password==\"" + escape_cql_term(password) + "\"";
2491 failure_code = YAZ_BIB1_INIT_AC_BAD_USERID_AND_OR_PASSWORD;
2495 const char *ip_cstr = ip.c_str();
2496 const char *cp = strchr(ip_cstr, ':');
2500 torus_query = "ip encloses/net.ipaddress \"";
2501 torus_query += escape_cql_term(std::string(ip_cstr));
2502 torus_query += "\"";
2503 failure_code = YAZ_BIB1_INIT_AC_BLOCKED_NETWORK_ADDRESS;
2506 std::string dummy_db;
2507 std::string dummy_realm;
2508 xmlDoc *doc = mp::get_searchable(package, m_p->torus_auth_url, dummy_db,
2509 torus_query, dummy_realm, m_p->proxy);
2512 // something fundamental broken in lookup.
2513 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2514 *addinfo = odr_strdup(odr, "Torus server unavailable or "
2515 "incorrectly configured");
2518 const xmlNode *ptr = xmlDocGetRootElement(doc);
2519 if (ptr && ptr->type == XML_ELEMENT_NODE)
2521 if (strcmp((const char *) ptr->name, "records") == 0)
2523 ptr = ptr->children;
2524 while (ptr && ptr->type != XML_ELEMENT_NODE)
2527 if (ptr && strcmp((const char *) ptr->name, "record") == 0)
2529 ptr = ptr->children;
2530 while (ptr && ptr->type != XML_ELEMENT_NODE)
2533 if (ptr && strcmp((const char *) ptr->name, "layer") == 0)
2535 ptr = ptr->children;
2536 while (ptr && ptr->type != XML_ELEMENT_NODE)
2541 if (ptr && ptr->type == XML_ELEMENT_NODE &&
2542 !strcmp((const char *) ptr->name, "identityId"))
2549 *error = failure_code;
2552 session_realm = mp::xml::get_text(ptr);
2555 void yf::Zoom::Impl::process(mp::Package &package)
2557 FrontendPtr f = get_frontend(package);
2558 Z_GDU *gdu = package.request().get();
2560 if (f->m_is_virtual)
2562 f->handle_package(package);
2564 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2567 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2568 f->m_init_gdu = gdu;
2571 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2572 Z_InitResponse *resp = apdu->u.initResponse;
2575 static const int masks[] = {
2580 for (i = 0; masks[i] != -1; i++)
2581 if (ODR_MASK_GET(req->options, masks[i]))
2582 ODR_MASK_SET(resp->options, masks[i]);
2584 static const int versions[] = {
2585 Z_ProtocolVersion_1,
2586 Z_ProtocolVersion_2,
2587 Z_ProtocolVersion_3,
2590 for (i = 0; versions[i] != -1; i++)
2591 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2592 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2596 *resp->preferredMessageSize = *req->preferredMessageSize;
2597 *resp->maximumRecordSize = *req->maximumRecordSize;
2601 f->auth(package, req, &error, &addinfo, odr);
2604 resp->userInformationField =
2605 zget_init_diagnostics(odr, error, addinfo);
2607 package.session().close();
2610 f->m_is_virtual = true;
2611 package.response() = apdu;
2616 release_frontend(package);
2620 static mp::filter::Base* filter_creator()
2622 return new mp::filter::Zoom;
2626 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2637 * c-file-style: "Stroustrup"
2638 * indent-tabs-mode: nil
2640 * vim: shiftwidth=4 tabstop=8 expandtab