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 extraArgs;
80 std::string rpn2cql_fname;
83 CCL_bibset ccl_bibset;
84 std::map<std::string, std::string> sortmap;
85 Searchable(CCL_bibset base);
88 class Zoom::Backend : boost::noncopyable {
90 friend class Frontend;
92 mp::wrbuf m_apdu_wrbuf;
93 ZOOM_connection m_connection;
94 ZOOM_resultset m_resultset;
95 std::string m_frontend_database;
97 xsltStylesheetPtr xsp;
98 std::string cproxy_host;
103 cql_transform_t cqlt;
107 void connect(std::string zurl, int *error, char **addinfo,
109 void search(ZOOM_query q, Odr_int *hits,
110 int *error, char **addinfo, ODR odr);
111 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
112 int *error, char **addinfo, ODR odr);
113 void set_option(const char *name, const char *value);
114 void set_option(const char *name, std::string value);
115 const char *get_option(const char *name);
116 void get_zoom_error(int *error, char **addinfo, ODR odr);
118 class Zoom::Frontend : boost::noncopyable {
123 std::string session_realm;
124 yazpp_1::GDU m_init_gdu;
125 BackendPtr m_backend;
126 void handle_package(mp::Package &package);
127 void handle_search(mp::Package &package);
129 void auth(mp::Package &package, Z_InitRequest *req,
130 int *error, char **addinfo, ODR odr);
132 BackendPtr explain_search(mp::Package &package,
133 std::string &database,
137 std::string torus_url,
138 std::string &torus_db,
140 void handle_present(mp::Package &package);
141 BackendPtr get_backend_from_databases(mp::Package &package,
142 std::string &database,
148 bool create_content_session(mp::Package &package,
153 std::string authentication,
157 void prepare_elements(BackendPtr b,
158 Odr_oid *preferredRecordSyntax,
159 const char *element_set_name,
160 bool &enable_pz2_retrieval,
161 bool &enable_pz2_transform,
162 bool &enable_record_transform,
163 bool &assume_marc8_charset);
165 Z_Records *get_records(Package &package,
167 Odr_int number_to_present,
170 Odr_int *number_of_records_returned,
171 ODR odr, BackendPtr b,
172 Odr_oid *preferredRecordSyntax,
173 const char *element_set_name);
174 Z_Records *get_explain_records(Package &package,
176 Odr_int number_to_present,
179 Odr_int *number_of_records_returned,
180 ODR odr, BackendPtr b,
181 Odr_oid *preferredRecordSyntax,
182 const char *element_set_name);
183 bool retry(mp::Package &package,
186 int &error, char **addinfo,
187 int &proxy_step, int &same_retries,
189 void log_diagnostic(mp::Package &package,
190 int error, const char *addinfo);
192 Frontend(Impl *impl);
196 friend class Frontend;
200 void process(metaproxy_1::Package & package);
201 void configure(const xmlNode * ptr, bool test_only,
204 void configure_local_records(const xmlNode * ptr, bool test_only);
205 bool check_proxy(const char *proxy);
209 FrontendPtr get_frontend(mp::Package &package);
210 void release_frontend(mp::Package &package);
211 SearchablePtr parse_torus_record(const xmlNode *ptr);
212 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
213 std::map<mp::Session, FrontendPtr> m_clients;
214 boost::mutex m_mutex;
215 boost::condition m_cond_session_ready;
216 std::string torus_searchable_url;
217 std::string torus_content_url;
218 std::string torus_auth_url;
219 std::string default_realm;
220 std::map<std::string,std::string> fieldmap;
222 std::string file_path;
223 std::string content_proxy_server;
224 std::string content_tmp_file;
225 std::string content_config_file;
228 std::string element_transform;
229 std::string element_raw;
231 xsltStylesheetPtr explain_xsp;
232 xsltStylesheetPtr record_xsp;
233 std::map<std::string,SearchablePtr> s_map;
234 std::string zoom_timeout;
241 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
245 if (ptr->type == XML_ELEMENT_NODE &&
246 !strcmp((const char *) ptr->name, "recordData"))
252 else // else: we don't want to find nested nodes
254 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
263 // define Pimpl wrapper forwarding to Impl
265 yf::Zoom::Zoom() : m_p(new Impl)
270 { // must have a destructor because of boost::scoped_ptr
273 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
276 m_p->configure(xmlnode, test_only, path);
279 void yf::Zoom::process(mp::Package &package) const
281 m_p->process(package);
285 // define Implementation stuff
287 yf::Zoom::Backend::Backend()
289 m_connection = ZOOM_connection_create(0);
290 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
293 enable_cproxy = true;
294 enable_explain = false;
299 yf::Zoom::Backend::~Backend()
302 xsltFreeStylesheet(xsp);
304 xmlFreeDoc(explain_doc);
305 cql_transform_close(cqlt);
306 ZOOM_connection_destroy(m_connection);
307 ZOOM_resultset_destroy(m_resultset);
311 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
315 const char *zoom_addinfo = 0;
316 const char *dset = 0;
317 int error0 = ZOOM_connection_error_x(m_connection, &msg,
318 &zoom_addinfo, &dset);
324 if (!strcmp(dset, "info:srw/diagnostic/1"))
325 *error = yaz_diag_srw_to_bib1(error0);
326 else if (!strcmp(dset, "Bib-1"))
328 else if (!strcmp(dset, "ZOOM"))
330 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
331 if (error0 == ZOOM_ERROR_INIT)
332 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
333 else if (error0 == ZOOM_ERROR_DECODE)
337 if (strstr(zoom_addinfo, "Authentication") ||
338 strstr(zoom_addinfo, "authentication"))
339 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
344 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
346 *addinfo = (char *) odr_malloc(
347 odr, 30 + strlen(dset) + strlen(msg) +
348 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
350 if (zoom_addinfo && *zoom_addinfo)
352 strcpy(*addinfo, zoom_addinfo);
353 strcat(*addinfo, " ");
355 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
359 void yf::Zoom::Backend::connect(std::string zurl,
360 int *error, char **addinfo,
363 size_t h = zurl.find_first_of('#');
364 if (h != std::string::npos)
366 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
367 get_zoom_error(error, addinfo, odr);
371 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
372 int *error, char **addinfo, ODR odr)
374 ZOOM_resultset_destroy(m_resultset);
375 m_resultset = ZOOM_connection_search(m_connection, q);
376 get_zoom_error(error, addinfo, odr);
378 *hits = ZOOM_resultset_size(m_resultset);
383 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
385 int *error, char **addinfo, ODR odr)
387 ZOOM_resultset_records(m_resultset, recs, start, number);
388 get_zoom_error(error, addinfo, odr);
391 void yf::Zoom::Backend::set_option(const char *name, const char *value)
393 ZOOM_connection_option_set(m_connection, name, value);
395 ZOOM_resultset_option_set(m_resultset, name, value);
398 void yf::Zoom::Backend::set_option(const char *name, std::string value)
400 set_option(name, value.c_str());
403 const char *yf::Zoom::Backend::get_option(const char *name)
405 return ZOOM_connection_option_get(m_connection, name);
408 yf::Zoom::Searchable::Searchable(CCL_bibset base)
411 use_turbomarc = true;
412 sortStrategy = "embed";
413 ccl_bibset = ccl_qual_dup(base);
416 yf::Zoom::Searchable::~Searchable()
418 ccl_qual_rm(&ccl_bibset);
421 yf::Zoom::Frontend::Frontend(Impl *impl) :
422 m_p(impl), m_is_virtual(false), m_in_use(true)
426 yf::Zoom::Frontend::~Frontend()
430 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
432 boost::mutex::scoped_lock lock(m_mutex);
434 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
438 it = m_clients.find(package.session());
439 if (it == m_clients.end())
442 if (!it->second->m_in_use)
444 it->second->m_in_use = true;
447 m_cond_session_ready.wait(lock);
449 FrontendPtr f(new Frontend(this));
450 m_clients[package.session()] = f;
455 void yf::Zoom::Impl::release_frontend(mp::Package &package)
457 boost::mutex::scoped_lock lock(m_mutex);
458 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
460 it = m_clients.find(package.session());
461 if (it != m_clients.end())
463 if (package.session().is_closed())
469 it->second->m_in_use = false;
471 m_cond_session_ready.notify_all();
475 yf::Zoom::Impl::Impl() :
476 apdu_log(false), element_transform("pz2") , element_raw("raw"),
477 zoom_timeout("40"), proxy_timeout(1)
479 bibset = ccl_qual_mk();
483 srand((unsigned int) time(0));
486 yf::Zoom::Impl::~Impl()
489 xsltFreeStylesheet(explain_xsp);
490 ccl_qual_rm(&bibset);
493 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
495 Zoom::SearchablePtr s(new Searchable(bibset));
497 for (ptr = ptr->children; ptr; ptr = ptr->next)
499 if (ptr->type != XML_ELEMENT_NODE)
501 if (!strcmp((const char *) ptr->name, "layer"))
503 else if (!strcmp((const char *) ptr->name,
506 s->authentication = mp::xml::get_text(ptr);
508 else if (!strcmp((const char *) ptr->name,
511 s->cfAuth = mp::xml::get_text(ptr);
513 else if (!strcmp((const char *) ptr->name,
516 s->cfProxy = mp::xml::get_text(ptr);
518 else if (!strcmp((const char *) ptr->name,
521 s->cfSubDB = mp::xml::get_text(ptr);
523 else if (!strcmp((const char *) ptr->name,
526 s->contentConnector = mp::xml::get_text(ptr);
528 else if (!strcmp((const char *) ptr->name, "udb"))
530 s->udb = mp::xml::get_text(ptr);
532 else if (!strcmp((const char *) ptr->name, "zurl"))
534 s->target = mp::xml::get_text(ptr);
536 else if (!strcmp((const char *) ptr->name, "sru"))
538 s->sru = mp::xml::get_text(ptr);
540 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
541 !strcmp((const char *) ptr->name, "sruVersion"))
543 s->sru_version = mp::xml::get_text(ptr);
545 else if (!strcmp((const char *) ptr->name,
548 s->query_encoding = mp::xml::get_text(ptr);
550 else if (!strcmp((const char *) ptr->name,
553 s->piggyback = mp::xml::get_bool(ptr, true);
555 else if (!strcmp((const char *) ptr->name,
558 s->request_syntax = mp::xml::get_text(ptr);
560 else if (!strcmp((const char *) ptr->name,
563 s->element_set = mp::xml::get_text(ptr);
565 else if (!strcmp((const char *) ptr->name,
568 s->record_encoding = mp::xml::get_text(ptr);
570 else if (!strcmp((const char *) ptr->name,
573 s->transform_xsl_fname = mp::xml::get_text(ptr);
575 else if (!strcmp((const char *) ptr->name,
578 s->transform_xsl_content = mp::xml::get_text(ptr);
580 else if (!strcmp((const char *) ptr->name,
583 s->urlRecipe = mp::xml::get_text(ptr);
585 else if (!strcmp((const char *) ptr->name,
588 ; // useTurboMarc is ignored
590 else if (!strncmp((const char *) ptr->name,
593 std::string value = mp::xml::get_text(ptr);
594 if (value.length() > 0)
596 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
597 (const char *) ptr->name + 7);
600 else if (!strncmp((const char *) ptr->name,
603 std::string value = mp::xml::get_text(ptr);
604 s->sortmap[(const char *) ptr->name + 8] = value;
606 else if (!strcmp((const char *) ptr->name,
609 s->sortStrategy = mp::xml::get_text(ptr);
611 else if (!strcmp((const char *) ptr->name,
614 s->extraArgs = mp::xml::get_text(ptr);
616 else if (!strcmp((const char *) ptr->name, "rpn2cql"))
617 s->rpn2cql_fname = mp::xml::get_text(ptr);
622 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
624 while (ptr && ptr->type != XML_ELEMENT_NODE)
629 if (!strcmp((const char *) ptr->name, "records"))
631 for (ptr = ptr->children; ptr; ptr = ptr->next)
633 if (ptr->type != XML_ELEMENT_NODE)
635 if (!strcmp((const char *) ptr->name, "record"))
637 SearchablePtr s = parse_torus_record(ptr);
640 std::string udb = s->udb;
645 throw mp::filter::FilterException
646 ("No udb for local torus record");
652 throw mp::filter::FilterException
654 + std::string((const char *) ptr->name)
655 + " in zoom filter inside element "
662 throw mp::filter::FilterException
664 + std::string((const char *) ptr->name)
665 + " in zoom filter inside element <torus>");
670 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
673 std::string explain_xslt_fname;
674 std::string record_xslt_fname;
680 for (ptr = ptr->children; ptr; ptr = ptr->next)
682 if (ptr->type != XML_ELEMENT_NODE)
684 else if (!strcmp((const char *) ptr->name, "torus"))
686 const struct _xmlAttr *attr;
687 for (attr = ptr->properties; attr; attr = attr->next)
689 if (!strcmp((const char *) attr->name, "url"))
690 torus_searchable_url = mp::xml::get_text(attr->children);
691 else if (!strcmp((const char *) attr->name, "content_url"))
692 torus_content_url = mp::xml::get_text(attr->children);
693 else if (!strcmp((const char *) attr->name, "auth_url"))
694 torus_auth_url = mp::xml::get_text(attr->children);
695 else if (!strcmp((const char *) attr->name, "realm"))
696 default_realm = mp::xml::get_text(attr->children);
697 else if (!strcmp((const char *) attr->name, "xsldir"))
698 xsldir = mp::xml::get_text(attr->children);
699 else if (!strcmp((const char *) attr->name, "element_transform"))
700 element_transform = mp::xml::get_text(attr->children);
701 else if (!strcmp((const char *) attr->name, "element_raw"))
702 element_raw = mp::xml::get_text(attr->children);
703 else if (!strcmp((const char *) attr->name, "proxy"))
704 proxy = mp::xml::get_text(attr->children);
705 else if (!strcmp((const char *) attr->name, "explain_xsl"))
706 explain_xslt_fname = mp::xml::get_text(attr->children);
707 else if (!strcmp((const char *) attr->name, "record_xsl"))
708 record_xslt_fname = mp::xml::get_text(attr->children);
710 throw mp::filter::FilterException(
711 "Bad attribute " + std::string((const char *)
714 // If content_url is not given, use value of searchable, to
715 // ensure backwards compatibility
716 if (!torus_content_url.length())
717 torus_content_url = torus_searchable_url;
718 configure_local_records(ptr->children, test_only);
720 else if (!strcmp((const char *) ptr->name, "cclmap"))
722 const char *addinfo = 0;
723 ccl_xml_config(bibset, ptr, &addinfo);
725 else if (!strcmp((const char *) ptr->name, "fieldmap"))
727 const struct _xmlAttr *attr;
728 std::string ccl_field;
729 std::string cql_field;
730 for (attr = ptr->properties; attr; attr = attr->next)
732 if (!strcmp((const char *) attr->name, "ccl"))
733 ccl_field = mp::xml::get_text(attr->children);
734 else if (!strcmp((const char *) attr->name, "cql"))
735 cql_field = mp::xml::get_text(attr->children);
737 throw mp::filter::FilterException(
738 "Bad attribute " + std::string((const char *)
741 if (cql_field.length())
742 fieldmap[cql_field] = ccl_field;
744 else if (!strcmp((const char *) ptr->name, "contentProxy"))
746 const struct _xmlAttr *attr;
747 for (attr = ptr->properties; attr; attr = attr->next)
749 if (!strcmp((const char *) attr->name, "server"))
752 "contentProxy's server attribute is deprecated");
754 "Specify config_file instead. For example:");
756 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
757 content_proxy_server = mp::xml::get_text(attr->children);
759 else if (!strcmp((const char *) attr->name, "tmp_file"))
760 content_tmp_file = mp::xml::get_text(attr->children);
761 else if (!strcmp((const char *) attr->name, "config_file"))
762 content_config_file = mp::xml::get_text(attr->children);
764 throw mp::filter::FilterException(
765 "Bad attribute " + std::string((const char *)
769 else if (!strcmp((const char *) ptr->name, "log"))
771 const struct _xmlAttr *attr;
772 for (attr = ptr->properties; attr; attr = attr->next)
774 if (!strcmp((const char *) attr->name, "apdu"))
775 apdu_log = mp::xml::get_bool(attr->children, false);
777 throw mp::filter::FilterException(
778 "Bad attribute " + std::string((const char *)
782 else if (!strcmp((const char *) ptr->name, "zoom"))
784 const struct _xmlAttr *attr;
785 for (attr = ptr->properties; attr; attr = attr->next)
787 if (!strcmp((const char *) attr->name, "timeout"))
788 zoom_timeout = mp::xml::get_text(attr->children);
789 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
790 proxy_timeout = mp::xml::get_int(attr->children, 1);
792 throw mp::filter::FilterException(
793 "Bad attribute " + std::string((const char *)
799 throw mp::filter::FilterException
801 + std::string((const char *) ptr->name)
802 + " in zoom filter");
806 if (explain_xslt_fname.length())
808 const char *path = 0;
811 path = xsldir.c_str();
813 path = file_path.c_str();
816 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
820 throw mp::filter::FilterException
821 ("Cannot read XSLT " + explain_xslt_fname);
824 xmlDoc *xsp_doc = xmlParseFile(cp);
827 throw mp::filter::FilterException
828 ("Cannot parse XSLT " + explain_xslt_fname);
831 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
835 throw mp::filter::FilterException
836 ("Cannot parse XSLT " + explain_xslt_fname);
841 if (record_xslt_fname.length())
843 const char *path = 0;
846 path = xsldir.c_str();
848 path = file_path.c_str();
851 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
855 throw mp::filter::FilterException
856 ("Cannot read XSLT " + record_xslt_fname);
859 xmlDoc *xsp_doc = xmlParseFile(cp);
862 throw mp::filter::FilterException
863 ("Cannot parse XSLT " + record_xslt_fname);
866 record_xsp = xsltParseStylesheetDoc(xsp_doc);
870 throw mp::filter::FilterException
871 ("Cannot parse XSLT " + record_xslt_fname);
877 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
879 int *error, char **addinfo,
881 std::string authentication,
885 if (b->sptr->contentConnector.length())
887 std::string proxyhostname;
888 std::string tmp_file;
889 bool legacy_format = false;
891 if (m_p->content_proxy_server.length())
893 proxyhostname = m_p->content_proxy_server;
894 legacy_format = true;
897 if (m_p->content_tmp_file.length())
898 tmp_file = m_p->content_tmp_file;
900 if (m_p->content_config_file.length())
902 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
906 while (fgets(buf, sizeof(buf)-1, inf))
909 cp = strchr(buf, '#');
912 cp = strchr(buf, '\n');
915 cp = strchr(buf, ':');
919 while (cp1 != buf && cp1[-1] == ' ')
925 if (!strcmp(buf, "proxyhostname"))
927 if (!strcmp(buf, "sessiondir") && *cp)
929 if (cp[strlen(cp)-1] == '/')
930 cp[strlen(cp)-1] = '\0';
931 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
939 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
940 "unable to open content config %s",
941 m_p->content_config_file.c_str());
942 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
943 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
944 sprintf(*addinfo, "unable to open content config %s",
945 m_p->content_config_file.c_str());
950 if (proxyhostname.length() == 0)
952 package.log("zoom", YLOG_WARN, "no proxyhostname");
955 if (tmp_file.length() == 0)
957 package.log("zoom", YLOG_WARN, "no tmp_file");
961 char *fname = xstrdup(tmp_file.c_str());
962 char *xx = strstr(fname, "XXXXXX");
965 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
966 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
967 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
968 sprintf(*addinfo, "bad format of content tmp_file: %s",
973 char tmp_char = xx[6];
974 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
976 b->cproxy_host = std::string(xx) + "." + proxyhostname;
978 b->cproxy_host = proxyhostname + "/" + xx;
981 FILE *file = fopen(fname, "w");
984 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
985 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
986 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
987 sprintf(*addinfo, "Could not create %s", fname);
992 wrbuf_puts(w, "#content_proxy\n");
993 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
994 if (authentication.length())
995 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
997 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
999 wrbuf_printf(w, "realm: %s\n", realm.c_str());
1001 fwrite(w.buf(), 1, w.len(), file);
1003 package.log("zoom", YLOG_LOG, "content file: %s", fname);
1009 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
1010 mp::Package &package,
1011 std::string &database, int *error, char **addinfo, mp::odr &odr,
1014 bool connection_reuse = false;
1017 std::list<BackendPtr>::const_iterator map_it;
1018 if (m_backend && !m_backend->enable_explain &&
1019 m_backend->m_frontend_database == database)
1021 connection_reuse = true;
1022 proxy = m_backend->m_proxy;
1025 std::string input_args;
1026 std::string torus_db;
1027 size_t db_arg_pos = database.find(',');
1028 if (db_arg_pos != std::string::npos)
1030 torus_db = database.substr(0, db_arg_pos);
1031 input_args = database.substr(db_arg_pos + 1);
1034 torus_db = database;
1036 std::string authentication;
1037 std::string content_authentication;
1038 std::string content_proxy;
1039 std::string realm = session_realm;
1040 if (realm.length() == 0)
1041 realm = m_p->default_realm;
1043 const char *param_user = 0;
1044 const char *param_password = 0;
1045 const char *param_content_user = 0;
1046 const char *param_content_password = 0;
1047 const char *param_nocproxy = 0;
1052 int no_out_args = 0;
1053 if (input_args.length())
1054 no_parms = yaz_uri_to_array(input_args.c_str(),
1055 odr, &names, &values);
1056 // adding 10 because we'll be adding other URL args
1057 const char **out_names = (const char **)
1058 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1059 const char **out_values = (const char **)
1060 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1062 // may be changed if it's a content connection
1063 std::string torus_url = m_p->torus_searchable_url;
1065 for (i = 0; i < no_parms; i++)
1067 const char *name = names[i];
1068 const char *value = values[i];
1071 if (!strcmp(name, "user"))
1073 else if (!strcmp(name, "password"))
1074 param_password = value;
1075 else if (!strcmp(name, "content-user"))
1076 param_content_user = value;
1077 else if (!strcmp(name, "content-password"))
1078 param_content_password = value;
1079 else if (!strcmp(name, "content-proxy"))
1080 content_proxy = value;
1081 else if (!strcmp(name, "nocproxy"))
1082 param_nocproxy = value;
1083 else if (!strcmp(name, "proxy"))
1087 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1088 if (connection_reuse)
1090 // find the step after our current proxy
1092 for (i = 0; i < dnum; i++)
1093 if (!strcmp(proxy.c_str(), dstr[i]))
1098 *proxy_step = i + 1;
1102 // step is known.. Guess our proxy from it
1103 if (*proxy_step >= dnum)
1107 proxy = dstr[*proxy_step];
1110 if (*proxy_step == dnum)
1115 else if (!strcmp(name, "cproxysession"))
1117 out_names[no_out_args] = name;
1118 out_values[no_out_args++] = value;
1119 torus_url = m_p->torus_content_url;
1121 else if (!strcmp(name, "realm") && session_realm.length() == 0)
1123 else if (!strcmp(name, "torus_url") && session_realm.length() == 0)
1125 else if (name[0] == 'x' && name[1] == '-')
1127 out_names[no_out_args] = name;
1128 out_values[no_out_args++] = value;
1132 BackendPtr notfound;
1133 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1134 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1135 sprintf(msg, "Bad database argument: %s", name);
1141 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1143 if (connection_reuse)
1145 m_backend->connect("", error, addinfo, odr);
1151 authentication = std::string(param_user);
1153 authentication += "/" + std::string(param_password);
1155 if (param_content_user)
1157 content_authentication = std::string(param_content_user);
1158 if (param_content_password)
1159 content_authentication += "/" + std::string(param_content_password);
1162 if (torus_db.compare("IR-Explain---1") == 0)
1163 return explain_search(package, database, error, addinfo, odr, torus_url,
1168 std::map<std::string,SearchablePtr>::iterator it;
1169 it = m_p->s_map.find(torus_db);
1170 if (it != m_p->s_map.end())
1172 else if (torus_url.length() > 0)
1174 std::string torus_query = "udb==" + torus_db;
1175 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1180 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1181 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1182 "incorrectly configured");
1186 const xmlNode *ptr = xmlDocGetRootElement(doc);
1187 if (ptr && ptr->type == XML_ELEMENT_NODE)
1189 if (!strcmp((const char *) ptr->name, "record"))
1191 sptr = m_p->parse_torus_record(ptr);
1193 else if (!strcmp((const char *) ptr->name, "records"))
1195 for (ptr = ptr->children; ptr; ptr = ptr->next)
1197 if (ptr->type == XML_ELEMENT_NODE
1198 && !strcmp((const char *) ptr->name, "record"))
1202 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1204 odr_malloc(odr, 40 + torus_db.length());
1205 sprintf(*addinfo, "multiple records for udb=%s",
1211 sptr = m_p->parse_torus_record(ptr);
1217 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1218 *addinfo = (char*) odr_malloc(
1219 odr, 40 + strlen((const char *) ptr->name));
1220 sprintf(*addinfo, "bad root element for torus: %s", ptr->name);
1231 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1232 *addinfo = odr_strdup(odr, torus_db.c_str());
1237 xsltStylesheetPtr xsp = 0;
1238 if (sptr->transform_xsl_content.length())
1240 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1241 sptr->transform_xsl_content.length());
1244 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1245 *addinfo = (char *) odr_malloc(odr, 40);
1246 sprintf(*addinfo, "xmlParseMemory failed");
1250 xsp = xsltParseStylesheetDoc(xsp_doc);
1253 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1254 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1256 xmlFreeDoc(xsp_doc);
1260 else if (sptr->transform_xsl_fname.length())
1262 const char *path = 0;
1264 if (m_p->xsldir.length())
1265 path = m_p->xsldir.c_str();
1267 path = m_p->file_path.c_str();
1270 char fullpath[1024];
1271 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1277 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1279 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1280 sprintf(*addinfo, "File could not be read: %s",
1281 sptr->transform_xsl_fname.c_str());
1285 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1288 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1289 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1290 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1294 xsp = xsltParseStylesheetDoc(xsp_doc);
1297 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1298 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1300 xmlFreeDoc(xsp_doc);
1305 cql_transform_t cqlt = 0;
1306 if (sptr->rpn2cql_fname.length())
1308 char fullpath[1024];
1309 char *cp = yaz_filepath_resolve(sptr->rpn2cql_fname.c_str(),
1310 m_p->file_path.c_str(), 0, fullpath);
1312 cqlt = cql_transform_open_fname(fullpath);
1315 cqlt = cql_transform_create();
1319 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1320 *addinfo = odr_strdup(odr, "Missing/invalid cql2rpn file");
1322 xsltFreeStylesheet(xsp);
1328 BackendPtr b(new Backend);
1333 b->m_frontend_database = database;
1334 b->enable_cproxy = param_nocproxy ? false : true;
1336 if (sptr->query_encoding.length())
1337 b->set_option("rpnCharset", sptr->query_encoding);
1339 if (sptr->extraArgs.length())
1340 b->set_option("extraArgs", sptr->extraArgs);
1342 b->set_option("timeout", m_p->zoom_timeout.c_str());
1345 b->set_option("apdulog", "1");
1347 if (sptr->piggyback && sptr->sru.length())
1348 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1349 maximumRecords > 0 */
1350 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1352 if (authentication.length() == 0)
1353 authentication = sptr->authentication;
1355 if (proxy.length() == 0)
1356 proxy = sptr->cfProxy;
1359 if (sptr->cfAuth.length())
1362 b->set_option("user", sptr->cfAuth);
1363 if (authentication.length())
1365 size_t found = authentication.find('/');
1366 if (found != std::string::npos)
1368 out_names[no_out_args] = "user";
1369 out_values[no_out_args++] =
1370 odr_strdup(odr, authentication.substr(0, found).c_str());
1372 out_names[no_out_args] = "password";
1373 out_values[no_out_args++] =
1374 odr_strdup(odr, authentication.substr(found+1).c_str());
1378 out_names[no_out_args] = "user";
1379 out_values[no_out_args++] =
1380 odr_strdup(odr, authentication.c_str());
1385 out_names[no_out_args] = "proxy";
1386 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1388 if (sptr->cfSubDB.length())
1390 out_names[no_out_args] = "subdatabase";
1391 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1395 out_names[no_out_args] = "nocproxy";
1396 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1401 size_t found = authentication.find('/');
1403 if (sptr->sru.length() && found != std::string::npos)
1405 b->set_option("user", authentication.substr(0, found));
1406 b->set_option("password", authentication.substr(found+1));
1409 b->set_option("user", authentication);
1412 b->set_option("proxy", proxy);
1415 if (sptr->sru.length())
1417 url = "http://" + sptr->target;
1418 b->set_option("sru", sptr->sru);
1420 if (sptr->sru_version.length())
1421 b->set_option("sru_version", sptr->sru_version);
1430 out_names[no_out_args] = 0; // terminate list
1432 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1433 (char **) out_values);
1434 url += "," + std::string(x_args);
1436 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1437 b->connect(url, error, addinfo, odr);
1438 if (*error == 0 && b->enable_cproxy)
1439 create_content_session(package, b, error, addinfo, odr,
1440 content_authentication.length() ?
1441 content_authentication : authentication,
1442 content_proxy.length() ? content_proxy : proxy,
1449 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1450 Odr_oid *preferredRecordSyntax,
1451 const char *element_set_name,
1452 bool &enable_pz2_retrieval,
1453 bool &enable_pz2_transform,
1454 bool &enable_record_transform,
1455 bool &assume_marc8_charset)
1457 char oid_name_str[OID_STR_MAX];
1458 const char *syntax_name = 0;
1460 if (preferredRecordSyntax &&
1461 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1463 if (element_set_name &&
1464 !strcmp(element_set_name, m_p->element_transform.c_str()))
1466 enable_pz2_retrieval = true;
1467 enable_pz2_transform = true;
1469 else if (element_set_name &&
1470 !strcmp(element_set_name, m_p->element_raw.c_str()))
1472 enable_pz2_retrieval = true;
1474 else if (m_p->record_xsp)
1476 enable_pz2_retrieval = true;
1477 enable_pz2_transform = true;
1478 enable_record_transform = true;
1482 if (enable_pz2_retrieval)
1484 std::string configured_request_syntax = b->sptr->request_syntax;
1485 if (configured_request_syntax.length())
1487 syntax_name = configured_request_syntax.c_str();
1488 const Odr_oid *syntax_oid =
1489 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1490 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1491 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1492 assume_marc8_charset = true;
1495 else if (preferredRecordSyntax)
1497 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1499 if (b->sptr->sru.length())
1500 syntax_name = "XML";
1502 b->set_option("preferredRecordSyntax", syntax_name);
1504 if (enable_pz2_retrieval)
1506 element_set_name = 0;
1507 if (b->sptr->element_set.length())
1508 element_set_name = b->sptr->element_set.c_str();
1511 b->set_option("elementSetName", element_set_name);
1512 if (b->sptr->sru.length() && element_set_name)
1513 b->set_option("schema", element_set_name);
1516 Z_Records *yf::Zoom::Frontend::get_explain_records(
1517 mp::Package &package,
1519 Odr_int number_to_present,
1522 Odr_int *number_of_records_returned,
1525 Odr_oid *preferredRecordSyntax,
1526 const char *element_set_name)
1529 Z_Records *records = 0;
1531 if (!b->explain_doc)
1535 if (number_to_present > 10000)
1536 number_to_present = 10000;
1538 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1540 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1541 odr_malloc(odr, sizeof(*npl));
1542 npl->records = (Z_NamePlusRecord **)
1543 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1545 for (i = 0; i < number_to_present; i++)
1548 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1551 xmlBufferPtr xml_buf = xmlBufferCreate();
1552 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1553 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1555 Z_NamePlusRecord *npr =
1556 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1557 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1558 npr->which = Z_NamePlusRecord_databaseRecord;
1559 npr->u.databaseRecord =
1560 z_ext_record_xml(odr,
1561 (const char *) xml_buf->content, xml_buf->use);
1562 npl->records[i] = npr;
1563 xmlFreeNode(tmp_node);
1564 xmlBufferFree(xml_buf);
1566 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1567 records->which = Z_Records_DBOSD;
1568 records->u.databaseOrSurDiagnostics = npl;
1570 npl->num_records = i;
1571 *number_of_records_returned = i;
1576 Z_Records *yf::Zoom::Frontend::get_records(mp::Package &package,
1578 Odr_int number_to_present,
1581 Odr_int *number_of_records_returned,
1584 Odr_oid *preferredRecordSyntax,
1585 const char *element_set_name)
1587 *number_of_records_returned = 0;
1588 Z_Records *records = 0;
1589 bool enable_pz2_retrieval = false; // whether target profile is used
1590 bool enable_pz2_transform = false; // whether XSLT is used as well
1591 bool assume_marc8_charset = false;
1592 bool enable_record_transform = false;
1594 prepare_elements(b, preferredRecordSyntax,
1596 enable_pz2_retrieval,
1597 enable_pz2_transform,
1598 enable_record_transform,
1599 assume_marc8_charset);
1601 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1602 enable_pz2_retrieval ? "yes" : "no",
1603 enable_pz2_transform ? "yes" : "no");
1605 if (start < 0 || number_to_present <=0)
1608 if (number_to_present > 10000)
1609 number_to_present = 10000;
1611 ZOOM_record *recs = (ZOOM_record *)
1612 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1614 b->present(start, number_to_present, recs, error, addinfo, odr);
1619 for (i = 0; i < number_to_present; i++)
1624 { // only return records if no error and at least one record
1626 const char *xsl_parms[3];
1627 mp::wrbuf cproxy_host;
1629 if (b->enable_cproxy && b->cproxy_host.length())
1631 wrbuf_puts(cproxy_host, "\"");
1632 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1633 wrbuf_puts(cproxy_host, "/\"");
1635 xsl_parms[0] = "cproxyhost";
1636 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1644 char *odr_database = odr_strdup(odr,
1645 b->m_frontend_database.c_str());
1646 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1647 odr_malloc(odr, sizeof(*npl));
1648 *number_of_records_returned = i;
1649 npl->num_records = i;
1650 npl->records = (Z_NamePlusRecord **)
1651 odr_malloc(odr, i * sizeof(*npl->records));
1652 for (i = 0; i < number_to_present; i++)
1654 Z_NamePlusRecord *npr = 0;
1655 const char *addinfo;
1657 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1658 &addinfo, 0 /* diagset */);
1662 log_diagnostic(package, sur_error, addinfo);
1663 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1666 else if (enable_pz2_retrieval)
1668 char rec_type_str[100];
1669 const char *record_encoding = 0;
1671 if (b->sptr->record_encoding.length())
1672 record_encoding = b->sptr->record_encoding.c_str();
1673 else if (assume_marc8_charset)
1674 record_encoding = "marc8";
1676 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1677 if (record_encoding)
1679 strcat(rec_type_str, "; charset=");
1680 strcat(rec_type_str, record_encoding);
1683 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1686 xmlChar *xmlrec_buf = 0;
1687 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1689 if (!rec_buf && !npr)
1691 std::string addinfo("ZOOM_record_get failed for type ");
1693 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1694 addinfo += rec_type_str;
1695 log_diagnostic(package, error, addinfo.c_str());
1696 npr = zget_surrogateDiagRec(odr, odr_database,
1697 error, addinfo.c_str());
1701 package.log_write(rec_buf, rec_len);
1702 package.log_write("\r\n", 2);
1705 if (rec_buf && b->xsp && enable_pz2_transform)
1707 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1710 const char *addinfo = "xml parse failed for record";
1711 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1712 log_diagnostic(package, error, addinfo);
1713 npr = zget_surrogateDiagRec(
1714 odr, odr_database, error, addinfo);
1718 // first stage XSLT - per target
1719 xsltStylesheetPtr xsp = b->xsp;
1720 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1722 // insert generated-url
1726 mp::xml::url_recipe_handle(rec_res,
1727 b->sptr->urlRecipe);
1730 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1731 while (ptr && ptr->type != XML_ELEMENT_NODE)
1734 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1735 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1737 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1741 // second stage XSLT - common
1742 if (rec_res && m_p->record_xsp &&
1743 enable_record_transform)
1745 xmlDoc *tmp_doc = rec_res;
1747 xsp = m_p->record_xsp;
1748 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1750 xmlFreeDoc(tmp_doc);
1752 // get result out of it
1755 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1757 rec_buf = (const char *) xmlrec_buf;
1758 package.log_write(rec_buf, rec_len);
1760 xmlFreeDoc(rec_res);
1764 std::string addinfo;
1766 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1768 addinfo = "xslt apply failed for "
1769 + b->sptr->transform_xsl_fname;
1770 log_diagnostic(package, error, addinfo.c_str());
1771 npr = zget_surrogateDiagRec(
1772 odr, odr_database, error, addinfo.c_str());
1774 xmlFreeDoc(rec_doc);
1781 npr = zget_surrogateDiagRec(
1783 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1787 npr = (Z_NamePlusRecord *)
1788 odr_malloc(odr, sizeof(*npr));
1789 npr->databaseName = odr_database;
1790 npr->which = Z_NamePlusRecord_databaseRecord;
1791 npr->u.databaseRecord =
1792 z_ext_record_xml(odr, rec_buf, rec_len);
1796 xmlFree(xmlrec_buf);
1801 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1804 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1805 npr->databaseName = odr_database;
1806 npr->which = Z_NamePlusRecord_databaseRecord;
1807 npr->u.databaseRecord = ext;
1811 npr = zget_surrogateDiagRec(
1813 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1814 "ZOOM_record, type ext");
1817 npl->records[i] = npr;
1819 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1820 records->which = Z_Records_DBOSD;
1821 records->u.databaseOrSurDiagnostics = npl;
1826 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1829 struct cql_node *r = 0;
1837 std::map<std::string,std::string>::const_iterator it;
1838 it = fieldmap.find(cn->u.st.index);
1839 if (it == fieldmap.end())
1841 if (it->second.length())
1842 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1848 r = convert_cql_fields(cn->u.boolean.left, odr);
1850 r = convert_cql_fields(cn->u.boolean.right, odr);
1853 r = convert_cql_fields(cn->u.sort.search, odr);
1859 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1860 int error, const char *addinfo)
1862 const char *err_msg = yaz_diag_bib1_str(error);
1864 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1865 error, err_msg, addinfo);
1867 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1871 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1872 std::string &database,
1876 std::string torus_url,
1877 std::string &torus_db,
1882 BackendPtr b(new Backend);
1884 b->m_frontend_database = database;
1885 b->enable_explain = true;
1887 Z_GDU *gdu = package.request().get();
1888 Z_APDU *apdu_req = gdu->u.z3950;
1889 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1890 Z_Query *query = sr->query;
1892 if (!m_p->explain_xsp)
1894 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1896 odr_strdup(odr, "IR-Explain---1 unsupported. "
1897 "Torus explain_xsl not defined");
1900 else if (query->which == Z_Query_type_104 &&
1901 query->u.type_104->which == Z_External_CQL)
1903 std::string torus_query(query->u.type_104->u.cql);
1904 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1907 if (m_p->explain_xsp)
1909 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1916 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1917 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1918 "incorrectly configured");
1922 xmlNode *ptr = xmlDocGetRootElement(doc);
1925 xml_node_search(ptr, &hits, 0);
1927 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1928 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1929 package.response() = apdu_res;
1933 xmlFreeDoc(b->explain_doc);
1934 b->explain_doc = doc;
1939 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1940 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1945 static bool wait_conn(COMSTACK cs, int secs)
1947 struct yaz_poll_fd pfd;
1949 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1950 if (cs->io_pending && CS_WANT_WRITE)
1951 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1952 if (cs->io_pending & CS_WANT_READ)
1953 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1955 pfd.fd = cs_fileno(cs);
1956 pfd.client_data = 0;
1958 int ret = yaz_poll(&pfd, 1, secs, 0);
1962 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1965 const char *uri = "http://localhost/";
1968 bool outcome = false;
1969 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1974 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1975 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1977 if (z_GDU(odr, &gdu, 0, 0))
1980 char *buf = odr_getbuf(odr, &len, 0);
1982 int ret = cs_connect(conn, add);
1983 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
1987 ret = cs_put(conn, buf, len);
1990 if (!wait_conn(conn, proxy_timeout))
2001 bool yf::Zoom::Frontend::retry(mp::Package &package,
2004 int &error, char **addinfo,
2005 int &proxy_step, int &same_retries,
2008 if (b && b->m_proxy.length() && !m_p->check_proxy(b->m_proxy.c_str()))
2010 log_diagnostic(package, error, *addinfo);
2011 package.log("zoom", YLOG_LOG, "proxy %s fails", b->m_proxy.c_str());
2013 if (proxy_step) // there is a failover
2016 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2019 error = YAZ_BIB1_PROXY_FAILURE;
2020 *addinfo = odr_strdup(odr, b->m_proxy.c_str());
2022 else if (same_retries == 0 && proxy_retries == 0)
2024 log_diagnostic(package, error, *addinfo);
2026 package.log("zoom", YLOG_WARN, "search failed: retry");
2034 void yf::Zoom::Frontend::handle_search(mp::Package &package)
2036 Z_GDU *gdu = package.request().get();
2037 Z_APDU *apdu_req = gdu->u.z3950;
2038 Z_APDU *apdu_res = 0;
2040 Z_SearchRequest *sr = apdu_req->u.searchRequest;
2041 if (sr->num_databaseNames != 1)
2043 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
2044 log_diagnostic(package, error, 0);
2045 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
2046 package.response() = apdu_res;
2050 int same_retries = 0;
2051 int proxy_retries = 0;
2057 std::string db(sr->databaseNames[0]);
2059 BackendPtr b = get_backend_from_databases(package, db, &error,
2060 &addinfo, odr, &proxy_step);
2063 if (retry(package, odr, b, error, &addinfo, proxy_step,
2064 same_retries, proxy_retries))
2069 log_diagnostic(package, error, addinfo);
2070 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2071 package.response() = apdu_res;
2074 if (!b || b->enable_explain)
2077 b->set_option("setname", "default");
2079 bool enable_pz2_retrieval = false;
2080 bool enable_pz2_transform = false;
2081 bool enable_record_transform = false;
2082 bool assume_marc8_charset = false;
2083 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
2084 enable_pz2_retrieval,
2085 enable_pz2_transform,
2086 enable_record_transform,
2087 assume_marc8_charset);
2090 Z_Query *query = sr->query;
2091 mp::wrbuf ccl_wrbuf;
2092 mp::wrbuf pqf_wrbuf;
2093 std::string sortkeys;
2095 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
2098 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
2100 else if (query->which == Z_Query_type_2)
2103 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
2104 query->u.type_2->len);
2106 else if (query->which == Z_Query_type_104 &&
2107 query->u.type_104->which == Z_External_CQL)
2110 const char *cql = query->u.type_104->u.cql;
2111 CQL_parser cp = cql_parser_create();
2112 int r = cql_parser_string(cp, cql);
2113 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
2116 cql_parser_destroy(cp);
2117 error = YAZ_BIB1_MALFORMED_QUERY;
2118 const char *addinfo = "CQL syntax error";
2119 log_diagnostic(package, error, addinfo);
2121 odr.create_searchResponse(apdu_req, error, addinfo);
2122 package.response() = apdu_res;
2125 struct cql_node *cn = cql_parser_result(cp);
2126 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2129 // hopefully we are getting a ptr to a index+relation+term node
2130 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2132 if (cn_error->which == CQL_NODE_ST)
2133 addinfo = cn_error->u.st.index;
2135 log_diagnostic(package, error, addinfo);
2136 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2137 package.response() = apdu_res;
2138 cql_parser_destroy(cp);
2141 r = cql_to_ccl(cn, wrbuf_vp_puts, ccl_wrbuf);
2144 error = YAZ_BIB1_MALFORMED_QUERY;
2145 const char *addinfo = "CQL to CCL conversion error";
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);
2154 mp::wrbuf sru_sortkeys_wrbuf;
2155 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2157 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2158 const char *addinfo = "CQL to CCL sortby conversion";
2160 log_diagnostic(package, error, addinfo);
2161 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2162 package.response() = apdu_res;
2163 cql_parser_destroy(cp);
2166 mp::wrbuf sort_spec_wrbuf;
2167 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2169 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2170 yaz_tok_parse_t tp =
2171 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2172 yaz_tok_cfg_destroy(tc);
2174 /* go through sortspec and map fields */
2175 int token = yaz_tok_move(tp);
2176 while (token != YAZ_TOK_EOF)
2178 if (token == YAZ_TOK_STRING)
2180 const char *field = yaz_tok_parse_string(tp);
2181 std::map<std::string,std::string>::iterator it;
2182 it = b->sptr->sortmap.find(field);
2183 if (it != b->sptr->sortmap.end())
2184 sortkeys += it->second;
2189 token = yaz_tok_move(tp);
2190 if (token == YAZ_TOK_STRING)
2192 sortkeys += yaz_tok_parse_string(tp);
2194 if (token != YAZ_TOK_EOF)
2197 token = yaz_tok_move(tp);
2200 yaz_tok_parse_destroy(tp);
2201 cql_parser_destroy(cp);
2205 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2206 const char *addinfo = 0;
2207 log_diagnostic(package, error, addinfo);
2208 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2209 package.response() = apdu_res;
2213 if (ccl_wrbuf.len())
2216 assert(pqf_wrbuf.len() == 0);
2218 struct ccl_rpn_node *cn;
2219 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2220 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2224 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2225 error = YAZ_BIB1_MALFORMED_QUERY;
2229 case CCL_ERR_UNKNOWN_QUAL:
2230 case CCL_ERR_TRUNC_NOT_LEFT:
2231 case CCL_ERR_TRUNC_NOT_RIGHT:
2232 case CCL_ERR_TRUNC_NOT_BOTH:
2233 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2234 case CCL_ERR_TRUNC_NOT_EMBED:
2236 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2237 case CCL_ERR_TRUNC_NOT_SINGLE:
2239 error = YAZ_BIB1_UNSUPP_SEARCH;
2242 log_diagnostic(package, error, addinfo);
2243 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2244 package.response() = apdu_res;
2247 ccl_pquery(pqf_wrbuf, cn);
2248 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2252 assert(pqf_wrbuf.len());
2254 ZOOM_query q = ZOOM_query_create();
2255 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2257 if (b->get_option("sru"))
2261 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2264 if (!strcmp(b->get_option("sru"), "solr"))
2266 solr_transform_t cqlt = solr_transform_create();
2268 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2270 solr_transform_close(cqlt);
2274 status = cql_transform_rpn2cql_wrbuf(b->cqlt, wrb, zquery);
2278 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2279 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2280 b->search(q, &hits, &error, &addinfo, odr);
2282 ZOOM_query_destroy(q);
2286 error = YAZ_BIB1_MALFORMED_QUERY;
2287 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2288 log_diagnostic(package, error, addinfo);
2289 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2290 package.response() = apdu_res;
2296 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2297 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2298 b->search(q, &hits, &error, &addinfo, odr);
2299 ZOOM_query_destroy(q);
2304 if (retry(package, odr, b, error, &addinfo, proxy_step,
2305 same_retries, proxy_retries))
2309 const char *element_set_name = 0;
2310 Odr_int number_to_present = 0;
2312 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2314 Odr_int number_of_records_returned = 0;
2315 Z_Records *records = get_records(
2317 0, number_to_present, &error, &addinfo,
2318 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2321 log_diagnostic(package, error, addinfo);
2322 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2325 apdu_res->u.searchResponse->records = records;
2326 apdu_res->u.searchResponse->numberOfRecordsReturned =
2327 odr_intdup(odr, number_of_records_returned);
2329 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2330 package.response() = apdu_res;
2333 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2335 Z_GDU *gdu = package.request().get();
2336 Z_APDU *apdu_req = gdu->u.z3950;
2337 Z_APDU *apdu_res = 0;
2338 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2343 package.response() = odr.create_presentResponse(
2344 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2347 const char *element_set_name = 0;
2348 Z_RecordComposition *comp = pr->recordComposition;
2349 if (comp && comp->which != Z_RecordComp_simple)
2351 package.response() = odr.create_presentResponse(
2353 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2356 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2357 element_set_name = comp->u.simple->u.generic;
2358 Odr_int number_of_records_returned = 0;
2362 if (m_backend->enable_explain)
2364 Z_Records *records =
2365 get_explain_records(
2367 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2368 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2369 pr->preferredRecordSyntax, element_set_name);
2371 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2374 apdu_res->u.presentResponse->records = records;
2375 apdu_res->u.presentResponse->numberOfRecordsReturned =
2376 odr_intdup(odr, number_of_records_returned);
2378 package.response() = apdu_res;
2382 Z_Records *records =
2383 get_records(package,
2384 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2385 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2386 pr->preferredRecordSyntax, element_set_name);
2388 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2391 apdu_res->u.presentResponse->records = records;
2392 apdu_res->u.presentResponse->numberOfRecordsReturned =
2393 odr_intdup(odr, number_of_records_returned);
2395 package.response() = apdu_res;
2399 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2401 Z_GDU *gdu = package.request().get();
2404 else if (gdu->which == Z_GDU_Z3950)
2406 Z_APDU *apdu_req = gdu->u.z3950;
2409 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2410 if (apdu_req->which == Z_APDU_initRequest)
2413 package.response() = odr.create_close(
2415 Z_Close_protocolError,
2418 else if (apdu_req->which == Z_APDU_searchRequest)
2420 handle_search(package);
2422 else if (apdu_req->which == Z_APDU_presentRequest)
2424 handle_present(package);
2429 package.response() = odr.create_close(
2431 Z_Close_protocolError,
2432 "zoom filter cannot handle this APDU");
2433 package.session().close();
2437 WRBUF w = m_backend->m_apdu_wrbuf;
2438 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2443 package.session().close();
2447 std::string escape_cql_term(std::string inp)
2450 size_t l = inp.length();
2452 for (i = 0; i < l; i++)
2454 if (strchr("*?^\"", inp[i]))
2461 void yf::Zoom::Frontend::auth(mp::Package &package, Z_InitRequest *req,
2462 int *error, char **addinfo, ODR odr)
2464 if (m_p->torus_auth_url.length() == 0)
2468 std::string password;
2469 if (req->idAuthentication)
2471 Z_IdAuthentication *auth = req->idAuthentication;
2472 switch (auth->which)
2474 case Z_IdAuthentication_open:
2477 const char *cp = strchr(auth->u.open, '/');
2480 user.assign(auth->u.open, cp - auth->u.open);
2481 password.assign(cp + 1);
2485 case Z_IdAuthentication_idPass:
2486 if (auth->u.idPass->userId)
2487 user.assign(auth->u.idPass->userId);
2488 if (auth->u.idPass->password)
2489 password.assign(auth->u.idPass->password);
2494 std::string ip = package.origin().get_address();
2495 yaz_log(YLOG_LOG, "IP=%s", ip.c_str());
2497 std::string torus_query;
2500 if (user.length() && password.length())
2502 torus_query = "userName==\"" + escape_cql_term(user) +
2503 "\" and password==\"" + escape_cql_term(password) + "\"";
2504 failure_code = YAZ_BIB1_INIT_AC_BAD_USERID_AND_OR_PASSWORD;
2508 const char *ip_cstr = ip.c_str();
2509 const char *cp = strchr(ip_cstr, ':');
2513 torus_query = "ip encloses/net.ipaddress \"";
2514 torus_query += escape_cql_term(std::string(ip_cstr));
2515 torus_query += "\"";
2516 failure_code = YAZ_BIB1_INIT_AC_BLOCKED_NETWORK_ADDRESS;
2519 std::string dummy_db;
2520 std::string dummy_realm;
2521 xmlDoc *doc = mp::get_searchable(package, m_p->torus_auth_url, dummy_db,
2522 torus_query, dummy_realm, m_p->proxy);
2525 // something fundamental broken in lookup.
2526 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2527 *addinfo = odr_strdup(odr, "Torus server unavailable or "
2528 "incorrectly configured");
2531 const xmlNode *ptr = xmlDocGetRootElement(doc);
2532 if (ptr && ptr->type == XML_ELEMENT_NODE)
2534 if (strcmp((const char *) ptr->name, "records") == 0)
2536 ptr = ptr->children;
2537 while (ptr && ptr->type != XML_ELEMENT_NODE)
2540 if (ptr && strcmp((const char *) ptr->name, "record") == 0)
2542 ptr = ptr->children;
2543 while (ptr && ptr->type != XML_ELEMENT_NODE)
2546 if (ptr && strcmp((const char *) ptr->name, "layer") == 0)
2548 ptr = ptr->children;
2549 while (ptr && ptr->type != XML_ELEMENT_NODE)
2554 if (ptr && ptr->type == XML_ELEMENT_NODE &&
2555 !strcmp((const char *) ptr->name, "identityId"))
2562 *error = failure_code;
2565 session_realm = mp::xml::get_text(ptr);
2568 void yf::Zoom::Impl::process(mp::Package &package)
2570 FrontendPtr f = get_frontend(package);
2571 Z_GDU *gdu = package.request().get();
2573 if (f->m_is_virtual)
2575 f->handle_package(package);
2577 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2580 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2581 f->m_init_gdu = gdu;
2584 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2585 Z_InitResponse *resp = apdu->u.initResponse;
2588 static const int masks[] = {
2593 for (i = 0; masks[i] != -1; i++)
2594 if (ODR_MASK_GET(req->options, masks[i]))
2595 ODR_MASK_SET(resp->options, masks[i]);
2597 static const int versions[] = {
2598 Z_ProtocolVersion_1,
2599 Z_ProtocolVersion_2,
2600 Z_ProtocolVersion_3,
2603 for (i = 0; versions[i] != -1; i++)
2604 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2605 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2609 *resp->preferredMessageSize = *req->preferredMessageSize;
2610 *resp->maximumRecordSize = *req->maximumRecordSize;
2614 f->auth(package, req, &error, &addinfo, odr);
2617 resp->userInformationField =
2618 zget_init_diagnostics(odr, error, addinfo);
2620 package.session().close();
2623 f->m_is_virtual = true;
2624 package.response() = apdu;
2629 release_frontend(package);
2633 static mp::filter::Base* filter_creator()
2635 return new mp::filter::Zoom;
2639 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2650 * c-file-style: "Stroustrup"
2651 * indent-tabs-mode: nil
2653 * vim: shiftwidth=4 tabstop=8 expandtab