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 yazpp_1::GDU m_init_gdu;
123 BackendPtr m_backend;
124 void handle_package(mp::Package &package);
125 void handle_search(mp::Package &package);
127 BackendPtr explain_search(mp::Package &package,
128 std::string &database,
132 std::string &torus_db,
134 void handle_present(mp::Package &package);
135 BackendPtr get_backend_from_databases(mp::Package &package,
136 std::string &database,
142 bool create_content_session(mp::Package &package,
147 std::string authentication,
151 void prepare_elements(BackendPtr b,
152 Odr_oid *preferredRecordSyntax,
153 const char *element_set_name,
154 bool &enable_pz2_retrieval,
155 bool &enable_pz2_transform,
156 bool &enable_record_transform,
157 bool &assume_marc8_charset);
159 Z_Records *get_records(Package &package,
161 Odr_int number_to_present,
164 Odr_int *number_of_records_returned,
165 ODR odr, BackendPtr b,
166 Odr_oid *preferredRecordSyntax,
167 const char *element_set_name);
168 Z_Records *get_explain_records(Package &package,
170 Odr_int number_to_present,
173 Odr_int *number_of_records_returned,
174 ODR odr, BackendPtr b,
175 Odr_oid *preferredRecordSyntax,
176 const char *element_set_name);
177 bool retry(mp::Package &package,
180 int &error, char **addinfo,
181 int &proxy_step, int &same_retries,
183 void log_diagnostic(mp::Package &package,
184 int error, const char *addinfo);
186 Frontend(Impl *impl);
190 friend class Frontend;
194 void process(metaproxy_1::Package & package);
195 void configure(const xmlNode * ptr, bool test_only,
198 void configure_local_records(const xmlNode * ptr, bool test_only);
199 bool check_proxy(const char *proxy);
203 FrontendPtr get_frontend(mp::Package &package);
204 void release_frontend(mp::Package &package);
205 SearchablePtr parse_torus_record(const xmlNode *ptr);
206 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
207 std::map<mp::Session, FrontendPtr> m_clients;
208 boost::mutex m_mutex;
209 boost::condition m_cond_session_ready;
210 std::string torus_searchable_url;
211 std::string torus_content_url;
212 std::string default_realm;
213 std::map<std::string,std::string> fieldmap;
215 std::string file_path;
216 std::string content_proxy_server;
217 std::string content_tmp_file;
218 std::string content_config_file;
221 std::string element_transform;
222 std::string element_raw;
224 xsltStylesheetPtr explain_xsp;
225 xsltStylesheetPtr record_xsp;
226 std::map<std::string,SearchablePtr> s_map;
227 std::string zoom_timeout;
234 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
238 if (ptr->type == XML_ELEMENT_NODE &&
239 !strcmp((const char *) ptr->name, "recordData"))
245 else // else: we don't want to find nested nodes
247 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
256 // define Pimpl wrapper forwarding to Impl
258 yf::Zoom::Zoom() : m_p(new Impl)
263 { // must have a destructor because of boost::scoped_ptr
266 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
269 m_p->configure(xmlnode, test_only, path);
272 void yf::Zoom::process(mp::Package &package) const
274 m_p->process(package);
278 // define Implementation stuff
280 yf::Zoom::Backend::Backend()
282 m_connection = ZOOM_connection_create(0);
283 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
286 enable_cproxy = true;
287 enable_explain = false;
291 yf::Zoom::Backend::~Backend()
294 xsltFreeStylesheet(xsp);
296 xmlFreeDoc(explain_doc);
297 cql_transform_close(cqlt);
298 ZOOM_connection_destroy(m_connection);
299 ZOOM_resultset_destroy(m_resultset);
303 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
307 const char *zoom_addinfo = 0;
308 const char *dset = 0;
309 int error0 = ZOOM_connection_error_x(m_connection, &msg,
310 &zoom_addinfo, &dset);
316 if (!strcmp(dset, "info:srw/diagnostic/1"))
317 *error = yaz_diag_srw_to_bib1(error0);
318 else if (!strcmp(dset, "Bib-1"))
320 else if (!strcmp(dset, "ZOOM"))
322 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
323 if (error0 == ZOOM_ERROR_INIT)
324 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
325 else if (error0 == ZOOM_ERROR_DECODE)
329 if (strstr(zoom_addinfo, "Authentication") ||
330 strstr(zoom_addinfo, "authentication"))
331 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
336 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
338 *addinfo = (char *) odr_malloc(
339 odr, 30 + strlen(dset) + strlen(msg) +
340 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
342 if (zoom_addinfo && *zoom_addinfo)
344 strcpy(*addinfo, zoom_addinfo);
345 strcat(*addinfo, " ");
347 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
351 void yf::Zoom::Backend::connect(std::string zurl,
352 int *error, char **addinfo,
355 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
356 get_zoom_error(error, addinfo, odr);
359 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
360 int *error, char **addinfo, ODR odr)
362 ZOOM_resultset_destroy(m_resultset);
363 m_resultset = ZOOM_connection_search(m_connection, q);
364 get_zoom_error(error, addinfo, odr);
366 *hits = ZOOM_resultset_size(m_resultset);
371 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
373 int *error, char **addinfo, ODR odr)
375 ZOOM_resultset_records(m_resultset, recs, start, number);
376 get_zoom_error(error, addinfo, odr);
379 void yf::Zoom::Backend::set_option(const char *name, const char *value)
381 ZOOM_connection_option_set(m_connection, name, value);
383 ZOOM_resultset_option_set(m_resultset, name, value);
386 void yf::Zoom::Backend::set_option(const char *name, std::string value)
388 set_option(name, value.c_str());
391 const char *yf::Zoom::Backend::get_option(const char *name)
393 return ZOOM_connection_option_get(m_connection, name);
396 yf::Zoom::Searchable::Searchable(CCL_bibset base)
399 use_turbomarc = true;
400 sortStrategy = "embed";
401 ccl_bibset = ccl_qual_dup(base);
404 yf::Zoom::Searchable::~Searchable()
406 ccl_qual_rm(&ccl_bibset);
409 yf::Zoom::Frontend::Frontend(Impl *impl) :
410 m_p(impl), m_is_virtual(false), m_in_use(true)
414 yf::Zoom::Frontend::~Frontend()
418 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
420 boost::mutex::scoped_lock lock(m_mutex);
422 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
426 it = m_clients.find(package.session());
427 if (it == m_clients.end())
430 if (!it->second->m_in_use)
432 it->second->m_in_use = true;
435 m_cond_session_ready.wait(lock);
437 FrontendPtr f(new Frontend(this));
438 m_clients[package.session()] = f;
443 void yf::Zoom::Impl::release_frontend(mp::Package &package)
445 boost::mutex::scoped_lock lock(m_mutex);
446 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
448 it = m_clients.find(package.session());
449 if (it != m_clients.end())
451 if (package.session().is_closed())
457 it->second->m_in_use = false;
459 m_cond_session_ready.notify_all();
463 yf::Zoom::Impl::Impl() :
464 apdu_log(false), element_transform("pz2") , element_raw("raw"),
465 zoom_timeout("40"), proxy_timeout(1)
467 bibset = ccl_qual_mk();
471 srand((unsigned int) time(0));
474 yf::Zoom::Impl::~Impl()
477 xsltFreeStylesheet(explain_xsp);
478 ccl_qual_rm(&bibset);
481 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
483 Zoom::SearchablePtr s(new Searchable(bibset));
485 for (ptr = ptr->children; ptr; ptr = ptr->next)
487 if (ptr->type != XML_ELEMENT_NODE)
489 if (!strcmp((const char *) ptr->name, "layer"))
491 else if (!strcmp((const char *) ptr->name,
494 s->authentication = mp::xml::get_text(ptr);
496 else if (!strcmp((const char *) ptr->name,
499 s->cfAuth = mp::xml::get_text(ptr);
501 else if (!strcmp((const char *) ptr->name,
504 s->cfProxy = mp::xml::get_text(ptr);
506 else if (!strcmp((const char *) ptr->name,
509 s->cfSubDB = mp::xml::get_text(ptr);
511 else if (!strcmp((const char *) ptr->name,
514 s->contentConnector = mp::xml::get_text(ptr);
516 else if (!strcmp((const char *) ptr->name, "udb"))
518 s->udb = mp::xml::get_text(ptr);
520 else if (!strcmp((const char *) ptr->name, "zurl"))
522 s->target = mp::xml::get_text(ptr);
524 else if (!strcmp((const char *) ptr->name, "sru"))
526 s->sru = mp::xml::get_text(ptr);
528 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
529 !strcmp((const char *) ptr->name, "sruVersion"))
531 s->sru_version = mp::xml::get_text(ptr);
533 else if (!strcmp((const char *) ptr->name,
536 s->query_encoding = mp::xml::get_text(ptr);
538 else if (!strcmp((const char *) ptr->name,
541 s->piggyback = mp::xml::get_bool(ptr, true);
543 else if (!strcmp((const char *) ptr->name,
546 s->request_syntax = mp::xml::get_text(ptr);
548 else if (!strcmp((const char *) ptr->name,
551 s->element_set = mp::xml::get_text(ptr);
553 else if (!strcmp((const char *) ptr->name,
556 s->record_encoding = mp::xml::get_text(ptr);
558 else if (!strcmp((const char *) ptr->name,
561 s->transform_xsl_fname = mp::xml::get_text(ptr);
563 else if (!strcmp((const char *) ptr->name,
566 s->transform_xsl_content = mp::xml::get_text(ptr);
568 else if (!strcmp((const char *) ptr->name,
571 s->urlRecipe = mp::xml::get_text(ptr);
573 else if (!strcmp((const char *) ptr->name,
576 ; // useTurboMarc is ignored
578 else if (!strncmp((const char *) ptr->name,
581 std::string value = mp::xml::get_text(ptr);
582 if (value.length() > 0)
584 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
585 (const char *) ptr->name + 7);
588 else if (!strncmp((const char *) ptr->name,
591 std::string value = mp::xml::get_text(ptr);
592 s->sortmap[(const char *) ptr->name + 8] = value;
594 else if (!strcmp((const char *) ptr->name,
597 s->sortStrategy = mp::xml::get_text(ptr);
599 else if (!strcmp((const char *) ptr->name, "rpn2cql"))
600 s->rpn2cql_fname = mp::xml::get_text(ptr);
605 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
607 while (ptr && ptr->type != XML_ELEMENT_NODE)
612 if (!strcmp((const char *) ptr->name, "records"))
614 for (ptr = ptr->children; ptr; ptr = ptr->next)
616 if (ptr->type != XML_ELEMENT_NODE)
618 if (!strcmp((const char *) ptr->name, "record"))
620 SearchablePtr s = parse_torus_record(ptr);
623 std::string udb = s->udb;
628 throw mp::filter::FilterException
629 ("No udb for local torus record");
635 throw mp::filter::FilterException
637 + std::string((const char *) ptr->name)
638 + " in zoom filter inside element "
645 throw mp::filter::FilterException
647 + std::string((const char *) ptr->name)
648 + " in zoom filter inside element <torus>");
653 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
656 std::string explain_xslt_fname;
657 std::string record_xslt_fname;
663 for (ptr = ptr->children; ptr; ptr = ptr->next)
665 if (ptr->type != XML_ELEMENT_NODE)
667 else if (!strcmp((const char *) ptr->name, "torus"))
669 const struct _xmlAttr *attr;
670 for (attr = ptr->properties; attr; attr = attr->next)
672 if (!strcmp((const char *) attr->name, "url"))
673 torus_searchable_url = mp::xml::get_text(attr->children);
674 else if (!strcmp((const char *) attr->name, "content_url"))
675 torus_content_url = mp::xml::get_text(attr->children);
676 else if (!strcmp((const char *) attr->name, "realm"))
677 default_realm = mp::xml::get_text(attr->children);
678 else if (!strcmp((const char *) attr->name, "xsldir"))
679 xsldir = mp::xml::get_text(attr->children);
680 else if (!strcmp((const char *) attr->name, "element_transform"))
681 element_transform = mp::xml::get_text(attr->children);
682 else if (!strcmp((const char *) attr->name, "element_raw"))
683 element_raw = mp::xml::get_text(attr->children);
684 else if (!strcmp((const char *) attr->name, "proxy"))
685 proxy = mp::xml::get_text(attr->children);
686 else if (!strcmp((const char *) attr->name, "explain_xsl"))
687 explain_xslt_fname = mp::xml::get_text(attr->children);
688 else if (!strcmp((const char *) attr->name, "record_xsl"))
689 record_xslt_fname = mp::xml::get_text(attr->children);
691 throw mp::filter::FilterException(
692 "Bad attribute " + std::string((const char *)
695 // If content_url is not given, use value of searchable, to
696 // ensure backwards compatibility
697 if (!torus_content_url.length())
698 torus_content_url = torus_searchable_url;
699 configure_local_records(ptr->children, test_only);
701 else if (!strcmp((const char *) ptr->name, "cclmap"))
703 const char *addinfo = 0;
704 ccl_xml_config(bibset, ptr, &addinfo);
706 else if (!strcmp((const char *) ptr->name, "fieldmap"))
708 const struct _xmlAttr *attr;
709 std::string ccl_field;
710 std::string cql_field;
711 for (attr = ptr->properties; attr; attr = attr->next)
713 if (!strcmp((const char *) attr->name, "ccl"))
714 ccl_field = mp::xml::get_text(attr->children);
715 else if (!strcmp((const char *) attr->name, "cql"))
716 cql_field = mp::xml::get_text(attr->children);
718 throw mp::filter::FilterException(
719 "Bad attribute " + std::string((const char *)
722 if (cql_field.length())
723 fieldmap[cql_field] = ccl_field;
725 else if (!strcmp((const char *) ptr->name, "contentProxy"))
727 const struct _xmlAttr *attr;
728 for (attr = ptr->properties; attr; attr = attr->next)
730 if (!strcmp((const char *) attr->name, "server"))
733 "contentProxy's server attribute is deprecated");
735 "Specify config_file instead. For example:");
737 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
738 content_proxy_server = mp::xml::get_text(attr->children);
740 else if (!strcmp((const char *) attr->name, "tmp_file"))
741 content_tmp_file = mp::xml::get_text(attr->children);
742 else if (!strcmp((const char *) attr->name, "config_file"))
743 content_config_file = mp::xml::get_text(attr->children);
745 throw mp::filter::FilterException(
746 "Bad attribute " + std::string((const char *)
750 else if (!strcmp((const char *) ptr->name, "log"))
752 const struct _xmlAttr *attr;
753 for (attr = ptr->properties; attr; attr = attr->next)
755 if (!strcmp((const char *) attr->name, "apdu"))
756 apdu_log = mp::xml::get_bool(attr->children, false);
758 throw mp::filter::FilterException(
759 "Bad attribute " + std::string((const char *)
763 else if (!strcmp((const char *) ptr->name, "zoom"))
765 const struct _xmlAttr *attr;
766 for (attr = ptr->properties; attr; attr = attr->next)
768 if (!strcmp((const char *) attr->name, "timeout"))
769 zoom_timeout = mp::xml::get_text(attr->children);
770 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
771 proxy_timeout = mp::xml::get_int(attr->children, 1);
773 throw mp::filter::FilterException(
774 "Bad attribute " + std::string((const char *)
780 throw mp::filter::FilterException
782 + std::string((const char *) ptr->name)
783 + " in zoom filter");
787 if (explain_xslt_fname.length())
789 const char *path = 0;
792 path = xsldir.c_str();
794 path = file_path.c_str();
797 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
801 throw mp::filter::FilterException
802 ("Cannot read XSLT " + explain_xslt_fname);
805 xmlDoc *xsp_doc = xmlParseFile(cp);
808 throw mp::filter::FilterException
809 ("Cannot parse XSLT " + explain_xslt_fname);
812 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
816 throw mp::filter::FilterException
817 ("Cannot parse XSLT " + explain_xslt_fname);
822 if (record_xslt_fname.length())
824 const char *path = 0;
827 path = xsldir.c_str();
829 path = file_path.c_str();
832 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
836 throw mp::filter::FilterException
837 ("Cannot read XSLT " + record_xslt_fname);
840 xmlDoc *xsp_doc = xmlParseFile(cp);
843 throw mp::filter::FilterException
844 ("Cannot parse XSLT " + record_xslt_fname);
847 record_xsp = xsltParseStylesheetDoc(xsp_doc);
851 throw mp::filter::FilterException
852 ("Cannot parse XSLT " + record_xslt_fname);
858 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
860 int *error, char **addinfo,
862 std::string authentication,
866 if (b->sptr->contentConnector.length())
868 std::string proxyhostname;
869 std::string tmp_file;
870 bool legacy_format = false;
872 if (m_p->content_proxy_server.length())
874 proxyhostname = m_p->content_proxy_server;
875 legacy_format = true;
878 if (m_p->content_tmp_file.length())
879 tmp_file = m_p->content_tmp_file;
881 if (m_p->content_config_file.length())
883 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
887 while (fgets(buf, sizeof(buf)-1, inf))
890 cp = strchr(buf, '#');
893 cp = strchr(buf, '\n');
896 cp = strchr(buf, ':');
900 while (cp1 != buf && cp1[-1] == ' ')
906 if (!strcmp(buf, "proxyhostname"))
908 if (!strcmp(buf, "sessiondir") && *cp)
910 if (cp[strlen(cp)-1] == '/')
911 cp[strlen(cp)-1] = '\0';
912 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
920 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
921 "unable to open content config %s",
922 m_p->content_config_file.c_str());
923 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
924 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
925 sprintf(*addinfo, "unable to open content config %s",
926 m_p->content_config_file.c_str());
931 if (proxyhostname.length() == 0)
933 package.log("zoom", YLOG_WARN, "no proxyhostname");
936 if (tmp_file.length() == 0)
938 package.log("zoom", YLOG_WARN, "no tmp_file");
942 char *fname = xstrdup(tmp_file.c_str());
943 char *xx = strstr(fname, "XXXXXX");
946 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
947 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
948 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
949 sprintf(*addinfo, "bad format of content tmp_file: %s",
954 char tmp_char = xx[6];
955 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
957 b->cproxy_host = std::string(xx) + "." + proxyhostname;
959 b->cproxy_host = proxyhostname + "/" + xx;
962 FILE *file = fopen(fname, "w");
965 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
966 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
967 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
968 sprintf(*addinfo, "Could not create %s", fname);
973 wrbuf_puts(w, "#content_proxy\n");
974 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
975 if (authentication.length())
976 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
978 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
980 wrbuf_printf(w, "realm: %s\n", realm.c_str());
982 fwrite(w.buf(), 1, w.len(), file);
984 package.log("zoom", YLOG_LOG, "content file: %s", fname);
990 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
991 mp::Package &package,
992 std::string &database, int *error, char **addinfo, mp::odr &odr,
995 bool connection_reuse = false;
998 std::list<BackendPtr>::const_iterator map_it;
999 if (m_backend && !m_backend->enable_explain &&
1000 m_backend->m_frontend_database == database)
1002 connection_reuse = true;
1003 proxy = m_backend->m_proxy;
1006 std::string input_args;
1007 std::string torus_db;
1008 size_t db_arg_pos = database.find(',');
1009 if (db_arg_pos != std::string::npos)
1011 torus_db = database.substr(0, db_arg_pos);
1012 input_args = database.substr(db_arg_pos + 1);
1015 torus_db = database;
1017 std::string authentication;
1018 std::string content_authentication;
1019 std::string content_proxy;
1020 std::string realm = m_p->default_realm;
1022 const char *param_user = 0;
1023 const char *param_password = 0;
1024 const char *param_content_user = 0;
1025 const char *param_content_password = 0;
1026 const char *param_nocproxy = 0;
1031 int no_out_args = 0;
1032 if (input_args.length())
1033 no_parms = yaz_uri_to_array(input_args.c_str(),
1034 odr, &names, &values);
1035 // adding 10 because we'll be adding other URL args
1036 const char **out_names = (const char **)
1037 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1038 const char **out_values = (const char **)
1039 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1041 // may be changed if it's a content connection
1042 std::string torus_url = m_p->torus_searchable_url;
1044 for (i = 0; i < no_parms; i++)
1046 const char *name = names[i];
1047 const char *value = values[i];
1050 if (!strcmp(name, "user"))
1052 else if (!strcmp(name, "password"))
1053 param_password = value;
1054 else if (!strcmp(name, "content-user"))
1055 param_content_user = value;
1056 else if (!strcmp(name, "content-password"))
1057 param_content_password = value;
1058 else if (!strcmp(name, "content-proxy"))
1059 content_proxy = value;
1060 else if (!strcmp(name, "nocproxy"))
1061 param_nocproxy = value;
1062 else if (!strcmp(name, "proxy"))
1066 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1067 if (connection_reuse)
1069 // find the step after our current proxy
1071 for (i = 0; i < dnum; i++)
1072 if (!strcmp(proxy.c_str(), dstr[i]))
1077 *proxy_step = i + 1;
1081 // step is known.. Guess our proxy from it
1082 if (*proxy_step >= dnum)
1086 proxy = dstr[*proxy_step];
1089 if (*proxy_step == dnum)
1094 else if (!strcmp(name, "cproxysession"))
1096 out_names[no_out_args] = name;
1097 out_values[no_out_args++] = value;
1098 torus_url = m_p->torus_content_url;
1100 else if (!strcmp(name, "realm"))
1102 else if (name[0] == 'x' && name[1] == '-')
1104 out_names[no_out_args] = name;
1105 out_values[no_out_args++] = value;
1109 BackendPtr notfound;
1110 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1111 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1112 sprintf(msg, "Bad database argument: %s", name);
1118 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1120 if (connection_reuse)
1122 m_backend->connect("", error, addinfo, odr);
1128 authentication = std::string(param_user);
1130 authentication += "/" + std::string(param_password);
1132 if (param_content_user)
1134 content_authentication = std::string(param_content_user);
1135 if (param_content_password)
1136 content_authentication += "/" + std::string(param_content_password);
1139 if (torus_db.compare("IR-Explain---1") == 0)
1140 return explain_search(package, database, error, addinfo, odr, torus_db,
1145 std::map<std::string,SearchablePtr>::iterator it;
1146 it = m_p->s_map.find(torus_db);
1147 if (it != m_p->s_map.end())
1149 else if (torus_url.length() > 0)
1151 std::string torus_query = "udb==" + torus_db;
1152 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1157 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1158 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1159 "incorrectly configured");
1163 const xmlNode *ptr = xmlDocGetRootElement(doc);
1165 { // presumably ptr is a records element node
1166 // parse first record in document
1167 for (ptr = ptr->children; ptr; ptr = ptr->next)
1169 if (ptr->type == XML_ELEMENT_NODE
1170 && !strcmp((const char *) ptr->name, "record"))
1174 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1175 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1176 sprintf(*addinfo, "multiple records for udb=%s",
1182 sptr = m_p->parse_torus_record(ptr);
1191 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1192 *addinfo = odr_strdup(odr, torus_db.c_str());
1197 xsltStylesheetPtr xsp = 0;
1198 if (sptr->transform_xsl_content.length())
1200 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1201 sptr->transform_xsl_content.length());
1204 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1205 *addinfo = (char *) odr_malloc(odr, 40);
1206 sprintf(*addinfo, "xmlParseMemory failed");
1210 xsp = xsltParseStylesheetDoc(xsp_doc);
1213 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1214 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1216 xmlFreeDoc(xsp_doc);
1220 else if (sptr->transform_xsl_fname.length())
1222 const char *path = 0;
1224 if (m_p->xsldir.length())
1225 path = m_p->xsldir.c_str();
1227 path = m_p->file_path.c_str();
1230 char fullpath[1024];
1231 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1237 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1239 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1240 sprintf(*addinfo, "File could not be read: %s",
1241 sptr->transform_xsl_fname.c_str());
1245 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1248 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1249 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1250 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1254 xsp = xsltParseStylesheetDoc(xsp_doc);
1257 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1258 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1260 xmlFreeDoc(xsp_doc);
1265 cql_transform_t cqlt = 0;
1266 if (sptr->rpn2cql_fname.length())
1268 char fullpath[1024];
1269 char *cp = yaz_filepath_resolve(sptr->rpn2cql_fname.c_str(),
1270 m_p->file_path.c_str(), 0, fullpath);
1272 cqlt = cql_transform_open_fname(fullpath);
1275 cqlt = cql_transform_create();
1279 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1280 *addinfo = odr_strdup(odr, "Missing/invalid cql2rpn file");
1282 xsltFreeStylesheet(xsp);
1288 BackendPtr b(new Backend);
1293 b->m_frontend_database = database;
1294 b->enable_cproxy = param_nocproxy ? false : true;
1296 if (sptr->query_encoding.length())
1297 b->set_option("rpnCharset", sptr->query_encoding);
1299 b->set_option("timeout", m_p->zoom_timeout.c_str());
1302 b->set_option("apdulog", "1");
1304 if (sptr->piggyback && sptr->sru.length())
1305 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1306 maximumRecords > 0 */
1307 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1309 if (authentication.length() == 0)
1310 authentication = sptr->authentication;
1312 if (proxy.length() == 0)
1313 proxy = sptr->cfProxy;
1316 if (sptr->cfAuth.length())
1319 b->set_option("user", sptr->cfAuth);
1320 if (authentication.length())
1322 size_t found = authentication.find('/');
1323 if (found != std::string::npos)
1325 out_names[no_out_args] = "user";
1326 out_values[no_out_args++] =
1327 odr_strdup(odr, authentication.substr(0, found).c_str());
1329 out_names[no_out_args] = "password";
1330 out_values[no_out_args++] =
1331 odr_strdup(odr, authentication.substr(found+1).c_str());
1335 out_names[no_out_args] = "user";
1336 out_values[no_out_args++] =
1337 odr_strdup(odr, authentication.c_str());
1342 out_names[no_out_args] = "proxy";
1343 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1345 if (sptr->cfSubDB.length())
1347 out_names[no_out_args] = "subdatabase";
1348 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1352 out_names[no_out_args] = "nocproxy";
1353 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1358 size_t found = authentication.find('/');
1360 if (sptr->sru.length() && found != std::string::npos)
1362 b->set_option("user", authentication.substr(0, found));
1363 b->set_option("password", authentication.substr(found+1));
1366 b->set_option("user", authentication);
1369 b->set_option("proxy", proxy);
1372 if (sptr->sru.length())
1374 url = "http://" + sptr->target;
1375 b->set_option("sru", sptr->sru);
1377 if (sptr->sru_version.length())
1378 b->set_option("sru_version", sptr->sru_version);
1387 out_names[no_out_args] = 0; // terminate list
1389 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1390 (char **) out_values);
1391 url += "," + std::string(x_args);
1393 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1394 b->connect(url, error, addinfo, odr);
1395 if (*error == 0 && b->enable_cproxy)
1396 create_content_session(package, b, error, addinfo, odr,
1397 content_authentication.length() ?
1398 content_authentication : authentication,
1399 content_proxy.length() ? content_proxy : proxy,
1406 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1407 Odr_oid *preferredRecordSyntax,
1408 const char *element_set_name,
1409 bool &enable_pz2_retrieval,
1410 bool &enable_pz2_transform,
1411 bool &enable_record_transform,
1412 bool &assume_marc8_charset)
1414 char oid_name_str[OID_STR_MAX];
1415 const char *syntax_name = 0;
1417 if (preferredRecordSyntax &&
1418 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1420 if (element_set_name &&
1421 !strcmp(element_set_name, m_p->element_transform.c_str()))
1423 enable_pz2_retrieval = true;
1424 enable_pz2_transform = true;
1426 else if (element_set_name &&
1427 !strcmp(element_set_name, m_p->element_raw.c_str()))
1429 enable_pz2_retrieval = true;
1431 else if (m_p->record_xsp)
1433 enable_pz2_retrieval = true;
1434 enable_pz2_transform = true;
1435 enable_record_transform = true;
1439 if (enable_pz2_retrieval)
1441 std::string configured_request_syntax = b->sptr->request_syntax;
1442 if (configured_request_syntax.length())
1444 syntax_name = configured_request_syntax.c_str();
1445 const Odr_oid *syntax_oid =
1446 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1447 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1448 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1449 assume_marc8_charset = true;
1452 else if (preferredRecordSyntax)
1454 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1456 if (b->sptr->sru.length())
1457 syntax_name = "XML";
1459 b->set_option("preferredRecordSyntax", syntax_name);
1461 if (enable_pz2_retrieval)
1463 element_set_name = 0;
1464 if (b->sptr->element_set.length())
1465 element_set_name = b->sptr->element_set.c_str();
1468 b->set_option("elementSetName", element_set_name);
1469 if (b->sptr->sru.length() && element_set_name)
1470 b->set_option("schema", element_set_name);
1473 Z_Records *yf::Zoom::Frontend::get_explain_records(
1474 mp::Package &package,
1476 Odr_int number_to_present,
1479 Odr_int *number_of_records_returned,
1482 Odr_oid *preferredRecordSyntax,
1483 const char *element_set_name)
1486 Z_Records *records = 0;
1488 if (!b->explain_doc)
1492 if (number_to_present > 10000)
1493 number_to_present = 10000;
1495 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1497 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1498 odr_malloc(odr, sizeof(*npl));
1499 npl->records = (Z_NamePlusRecord **)
1500 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1502 for (i = 0; i < number_to_present; i++)
1505 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1508 xmlBufferPtr xml_buf = xmlBufferCreate();
1509 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1510 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1512 Z_NamePlusRecord *npr =
1513 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1514 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1515 npr->which = Z_NamePlusRecord_databaseRecord;
1516 npr->u.databaseRecord =
1517 z_ext_record_xml(odr,
1518 (const char *) xml_buf->content, xml_buf->use);
1519 npl->records[i] = npr;
1520 xmlFreeNode(tmp_node);
1521 xmlBufferFree(xml_buf);
1523 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1524 records->which = Z_Records_DBOSD;
1525 records->u.databaseOrSurDiagnostics = npl;
1527 npl->num_records = i;
1528 *number_of_records_returned = i;
1533 Z_Records *yf::Zoom::Frontend::get_records(mp::Package &package,
1535 Odr_int number_to_present,
1538 Odr_int *number_of_records_returned,
1541 Odr_oid *preferredRecordSyntax,
1542 const char *element_set_name)
1544 *number_of_records_returned = 0;
1545 Z_Records *records = 0;
1546 bool enable_pz2_retrieval = false; // whether target profile is used
1547 bool enable_pz2_transform = false; // whether XSLT is used as well
1548 bool assume_marc8_charset = false;
1549 bool enable_record_transform = false;
1551 prepare_elements(b, preferredRecordSyntax,
1553 enable_pz2_retrieval,
1554 enable_pz2_transform,
1555 enable_record_transform,
1556 assume_marc8_charset);
1558 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1559 enable_pz2_retrieval ? "yes" : "no",
1560 enable_pz2_transform ? "yes" : "no");
1562 if (start < 0 || number_to_present <=0)
1565 if (number_to_present > 10000)
1566 number_to_present = 10000;
1568 ZOOM_record *recs = (ZOOM_record *)
1569 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1571 b->present(start, number_to_present, recs, error, addinfo, odr);
1576 for (i = 0; i < number_to_present; i++)
1581 { // only return records if no error and at least one record
1583 const char *xsl_parms[3];
1584 mp::wrbuf cproxy_host;
1586 if (b->enable_cproxy && b->cproxy_host.length())
1588 wrbuf_puts(cproxy_host, "\"");
1589 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1590 wrbuf_puts(cproxy_host, "/\"");
1592 xsl_parms[0] = "cproxyhost";
1593 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1601 char *odr_database = odr_strdup(odr,
1602 b->m_frontend_database.c_str());
1603 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1604 odr_malloc(odr, sizeof(*npl));
1605 *number_of_records_returned = i;
1606 npl->num_records = i;
1607 npl->records = (Z_NamePlusRecord **)
1608 odr_malloc(odr, i * sizeof(*npl->records));
1609 for (i = 0; i < number_to_present; i++)
1611 Z_NamePlusRecord *npr = 0;
1612 const char *addinfo;
1614 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1615 &addinfo, 0 /* diagset */);
1619 log_diagnostic(package, sur_error, addinfo);
1620 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1623 else if (enable_pz2_retrieval)
1625 char rec_type_str[100];
1626 const char *record_encoding = 0;
1628 if (b->sptr->record_encoding.length())
1629 record_encoding = b->sptr->record_encoding.c_str();
1630 else if (assume_marc8_charset)
1631 record_encoding = "marc8";
1633 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1634 if (record_encoding)
1636 strcat(rec_type_str, "; charset=");
1637 strcat(rec_type_str, record_encoding);
1640 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1643 xmlChar *xmlrec_buf = 0;
1644 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1646 if (!rec_buf && !npr)
1648 std::string addinfo("ZOOM_record_get failed for type ");
1650 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1651 addinfo += rec_type_str;
1652 log_diagnostic(package, error, addinfo.c_str());
1653 npr = zget_surrogateDiagRec(odr, odr_database,
1654 error, addinfo.c_str());
1658 package.log_write(rec_buf, rec_len);
1659 package.log_write("\r\n", 2);
1662 if (rec_buf && b->xsp && enable_pz2_transform)
1664 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1667 const char *addinfo = "xml parse failed for record";
1668 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1669 log_diagnostic(package, error, addinfo);
1670 npr = zget_surrogateDiagRec(
1671 odr, odr_database, error, addinfo);
1675 // first stage XSLT - per target
1676 xsltStylesheetPtr xsp = b->xsp;
1677 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1679 // insert generated-url
1683 mp::xml::url_recipe_handle(rec_res,
1684 b->sptr->urlRecipe);
1687 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1688 while (ptr && ptr->type != XML_ELEMENT_NODE)
1691 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1692 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1694 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1698 // second stage XSLT - common
1699 if (rec_res && m_p->record_xsp &&
1700 enable_record_transform)
1702 xmlDoc *tmp_doc = rec_res;
1704 xsp = m_p->record_xsp;
1705 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1707 xmlFreeDoc(tmp_doc);
1709 // get result out of it
1712 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1714 rec_buf = (const char *) xmlrec_buf;
1715 package.log_write(rec_buf, rec_len);
1717 xmlFreeDoc(rec_res);
1721 std::string addinfo;
1723 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1725 addinfo = "xslt apply failed for "
1726 + b->sptr->transform_xsl_fname;
1727 log_diagnostic(package, error, addinfo.c_str());
1728 npr = zget_surrogateDiagRec(
1729 odr, odr_database, error, addinfo.c_str());
1731 xmlFreeDoc(rec_doc);
1738 npr = zget_surrogateDiagRec(
1740 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1744 npr = (Z_NamePlusRecord *)
1745 odr_malloc(odr, sizeof(*npr));
1746 npr->databaseName = odr_database;
1747 npr->which = Z_NamePlusRecord_databaseRecord;
1748 npr->u.databaseRecord =
1749 z_ext_record_xml(odr, rec_buf, rec_len);
1753 xmlFree(xmlrec_buf);
1758 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1761 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1762 npr->databaseName = odr_database;
1763 npr->which = Z_NamePlusRecord_databaseRecord;
1764 npr->u.databaseRecord = ext;
1768 npr = zget_surrogateDiagRec(
1770 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1771 "ZOOM_record, type ext");
1774 npl->records[i] = npr;
1776 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1777 records->which = Z_Records_DBOSD;
1778 records->u.databaseOrSurDiagnostics = npl;
1783 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1786 struct cql_node *r = 0;
1794 std::map<std::string,std::string>::const_iterator it;
1795 it = fieldmap.find(cn->u.st.index);
1796 if (it == fieldmap.end())
1798 if (it->second.length())
1799 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1805 r = convert_cql_fields(cn->u.boolean.left, odr);
1807 r = convert_cql_fields(cn->u.boolean.right, odr);
1810 r = convert_cql_fields(cn->u.sort.search, odr);
1816 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1817 int error, const char *addinfo)
1819 const char *err_msg = yaz_diag_bib1_str(error);
1821 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1822 error, err_msg, addinfo);
1824 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1828 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1829 std::string &database,
1833 std::string &torus_db,
1838 BackendPtr b(new Backend);
1840 b->m_frontend_database = database;
1841 b->enable_explain = true;
1843 Z_GDU *gdu = package.request().get();
1844 Z_APDU *apdu_req = gdu->u.z3950;
1845 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1846 Z_Query *query = sr->query;
1848 if (!m_p->explain_xsp)
1850 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1852 odr_strdup(odr, "IR-Explain---1 unsupported. "
1853 "Torus explain_xsl not defined");
1856 else if (query->which == Z_Query_type_104 &&
1857 query->u.type_104->which == Z_External_CQL)
1859 std::string torus_url = m_p->torus_searchable_url;
1860 std::string torus_query(query->u.type_104->u.cql);
1861 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1864 if (m_p->explain_xsp)
1866 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1873 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1874 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1875 "incorrectly configured");
1879 xmlNode *ptr = xmlDocGetRootElement(doc);
1882 xml_node_search(ptr, &hits, 0);
1884 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1885 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1886 package.response() = apdu_res;
1890 xmlFreeDoc(b->explain_doc);
1891 b->explain_doc = doc;
1896 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1897 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1902 static bool wait_conn(COMSTACK cs, int secs)
1904 struct yaz_poll_fd pfd;
1906 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1907 if (cs->io_pending && CS_WANT_WRITE)
1908 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1909 if (cs->io_pending & CS_WANT_READ)
1910 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1912 pfd.fd = cs_fileno(cs);
1913 pfd.client_data = 0;
1915 int ret = yaz_poll(&pfd, 1, secs, 0);
1919 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1922 const char *uri = "http://localhost/";
1925 bool outcome = false;
1926 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1931 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1932 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1934 if (z_GDU(odr, &gdu, 0, 0))
1937 char *buf = odr_getbuf(odr, &len, 0);
1939 int ret = cs_connect(conn, add);
1940 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
1944 ret = cs_put(conn, buf, len);
1947 if (!wait_conn(conn, proxy_timeout))
1958 bool yf::Zoom::Frontend::retry(mp::Package &package,
1961 int &error, char **addinfo,
1962 int &proxy_step, int &same_retries,
1965 if (b && b->m_proxy.length() && !m_p->check_proxy(b->m_proxy.c_str()))
1967 log_diagnostic(package, error, *addinfo);
1968 package.log("zoom", YLOG_LOG, "proxy %s fails", b->m_proxy.c_str());
1970 if (proxy_step) // there is a failover
1973 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
1976 error = YAZ_BIB1_PROXY_FAILURE;
1977 *addinfo = odr_strdup(odr, b->m_proxy.c_str());
1979 else if (same_retries == 0 && proxy_retries == 0)
1981 log_diagnostic(package, error, *addinfo);
1983 package.log("zoom", YLOG_WARN, "search failed: retry");
1991 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1993 Z_GDU *gdu = package.request().get();
1994 Z_APDU *apdu_req = gdu->u.z3950;
1995 Z_APDU *apdu_res = 0;
1997 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1998 if (sr->num_databaseNames != 1)
2000 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
2001 log_diagnostic(package, error, 0);
2002 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
2003 package.response() = apdu_res;
2007 int same_retries = 0;
2008 int proxy_retries = 0;
2014 std::string db(sr->databaseNames[0]);
2016 BackendPtr b = get_backend_from_databases(package, db, &error,
2017 &addinfo, odr, &proxy_step);
2020 if (retry(package, odr, b, error, &addinfo, proxy_step,
2021 same_retries, proxy_retries))
2026 log_diagnostic(package, error, addinfo);
2027 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2028 package.response() = apdu_res;
2031 if (!b || b->enable_explain)
2034 b->set_option("setname", "default");
2036 bool enable_pz2_retrieval = false;
2037 bool enable_pz2_transform = false;
2038 bool enable_record_transform = false;
2039 bool assume_marc8_charset = false;
2040 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
2041 enable_pz2_retrieval,
2042 enable_pz2_transform,
2043 enable_record_transform,
2044 assume_marc8_charset);
2047 Z_Query *query = sr->query;
2048 mp::wrbuf ccl_wrbuf;
2049 mp::wrbuf pqf_wrbuf;
2050 std::string sortkeys;
2052 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
2055 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
2057 else if (query->which == Z_Query_type_2)
2060 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
2061 query->u.type_2->len);
2063 else if (query->which == Z_Query_type_104 &&
2064 query->u.type_104->which == Z_External_CQL)
2067 const char *cql = query->u.type_104->u.cql;
2068 CQL_parser cp = cql_parser_create();
2069 int r = cql_parser_string(cp, cql);
2070 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
2073 cql_parser_destroy(cp);
2074 error = YAZ_BIB1_MALFORMED_QUERY;
2075 const char *addinfo = "CQL syntax error";
2076 log_diagnostic(package, error, addinfo);
2078 odr.create_searchResponse(apdu_req, error, addinfo);
2079 package.response() = apdu_res;
2082 struct cql_node *cn = cql_parser_result(cp);
2083 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2086 // hopefully we are getting a ptr to a index+relation+term node
2087 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2089 if (cn_error->which == CQL_NODE_ST)
2090 addinfo = cn_error->u.st.index;
2092 log_diagnostic(package, error, addinfo);
2093 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2094 package.response() = apdu_res;
2095 cql_parser_destroy(cp);
2098 r = cql_to_ccl(cn, wrbuf_vp_puts, ccl_wrbuf);
2101 error = YAZ_BIB1_MALFORMED_QUERY;
2102 const char *addinfo = "CQL to CCL conversion error";
2104 log_diagnostic(package, error, addinfo);
2105 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2106 package.response() = apdu_res;
2107 cql_parser_destroy(cp);
2111 mp::wrbuf sru_sortkeys_wrbuf;
2112 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2114 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2115 const char *addinfo = "CQL to CCL sortby conversion";
2117 log_diagnostic(package, error, addinfo);
2118 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2119 package.response() = apdu_res;
2120 cql_parser_destroy(cp);
2123 mp::wrbuf sort_spec_wrbuf;
2124 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2126 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2127 yaz_tok_parse_t tp =
2128 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2129 yaz_tok_cfg_destroy(tc);
2131 /* go through sortspec and map fields */
2132 int token = yaz_tok_move(tp);
2133 while (token != YAZ_TOK_EOF)
2135 if (token == YAZ_TOK_STRING)
2137 const char *field = yaz_tok_parse_string(tp);
2138 std::map<std::string,std::string>::iterator it;
2139 it = b->sptr->sortmap.find(field);
2140 if (it != b->sptr->sortmap.end())
2141 sortkeys += it->second;
2146 token = yaz_tok_move(tp);
2147 if (token == YAZ_TOK_STRING)
2149 sortkeys += yaz_tok_parse_string(tp);
2151 if (token != YAZ_TOK_EOF)
2154 token = yaz_tok_move(tp);
2157 yaz_tok_parse_destroy(tp);
2158 cql_parser_destroy(cp);
2162 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2163 const char *addinfo = 0;
2164 log_diagnostic(package, error, addinfo);
2165 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2166 package.response() = apdu_res;
2170 if (ccl_wrbuf.len())
2173 assert(pqf_wrbuf.len() == 0);
2175 struct ccl_rpn_node *cn;
2176 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2177 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2181 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2182 error = YAZ_BIB1_MALFORMED_QUERY;
2186 case CCL_ERR_UNKNOWN_QUAL:
2187 case CCL_ERR_TRUNC_NOT_LEFT:
2188 case CCL_ERR_TRUNC_NOT_RIGHT:
2189 case CCL_ERR_TRUNC_NOT_BOTH:
2190 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2191 case CCL_ERR_TRUNC_NOT_EMBED:
2193 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2194 case CCL_ERR_TRUNC_NOT_SINGLE:
2196 error = YAZ_BIB1_UNSUPP_SEARCH;
2199 log_diagnostic(package, error, addinfo);
2200 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2201 package.response() = apdu_res;
2204 ccl_pquery(pqf_wrbuf, cn);
2205 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2209 assert(pqf_wrbuf.len());
2211 ZOOM_query q = ZOOM_query_create();
2212 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2214 if (b->get_option("sru"))
2218 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2221 if (!strcmp(b->get_option("sru"), "solr"))
2223 solr_transform_t cqlt = solr_transform_create();
2225 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2227 solr_transform_close(cqlt);
2231 status = cql_transform_rpn2cql_wrbuf(b->cqlt, wrb, zquery);
2235 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2236 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2237 b->search(q, &hits, &error, &addinfo, odr);
2239 ZOOM_query_destroy(q);
2243 error = YAZ_BIB1_MALFORMED_QUERY;
2244 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2245 log_diagnostic(package, error, addinfo);
2246 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2247 package.response() = apdu_res;
2253 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2254 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2255 b->search(q, &hits, &error, &addinfo, odr);
2256 ZOOM_query_destroy(q);
2261 if (retry(package, odr, b, error, &addinfo, proxy_step,
2262 same_retries, proxy_retries))
2266 const char *element_set_name = 0;
2267 Odr_int number_to_present = 0;
2269 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2271 Odr_int number_of_records_returned = 0;
2272 Z_Records *records = get_records(
2274 0, number_to_present, &error, &addinfo,
2275 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2278 log_diagnostic(package, error, addinfo);
2279 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2282 apdu_res->u.searchResponse->records = records;
2283 apdu_res->u.searchResponse->numberOfRecordsReturned =
2284 odr_intdup(odr, number_of_records_returned);
2286 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2287 package.response() = apdu_res;
2290 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2292 Z_GDU *gdu = package.request().get();
2293 Z_APDU *apdu_req = gdu->u.z3950;
2294 Z_APDU *apdu_res = 0;
2295 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2300 package.response() = odr.create_presentResponse(
2301 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2304 const char *element_set_name = 0;
2305 Z_RecordComposition *comp = pr->recordComposition;
2306 if (comp && comp->which != Z_RecordComp_simple)
2308 package.response() = odr.create_presentResponse(
2310 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2313 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2314 element_set_name = comp->u.simple->u.generic;
2315 Odr_int number_of_records_returned = 0;
2319 if (m_backend->enable_explain)
2321 Z_Records *records =
2322 get_explain_records(
2324 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2325 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2326 pr->preferredRecordSyntax, element_set_name);
2328 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2331 apdu_res->u.presentResponse->records = records;
2332 apdu_res->u.presentResponse->numberOfRecordsReturned =
2333 odr_intdup(odr, number_of_records_returned);
2335 package.response() = apdu_res;
2339 Z_Records *records =
2340 get_records(package,
2341 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2342 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2343 pr->preferredRecordSyntax, element_set_name);
2345 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2348 apdu_res->u.presentResponse->records = records;
2349 apdu_res->u.presentResponse->numberOfRecordsReturned =
2350 odr_intdup(odr, number_of_records_returned);
2352 package.response() = apdu_res;
2356 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2358 Z_GDU *gdu = package.request().get();
2361 else if (gdu->which == Z_GDU_Z3950)
2363 Z_APDU *apdu_req = gdu->u.z3950;
2366 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2367 if (apdu_req->which == Z_APDU_initRequest)
2370 package.response() = odr.create_close(
2372 Z_Close_protocolError,
2375 else if (apdu_req->which == Z_APDU_searchRequest)
2377 handle_search(package);
2379 else if (apdu_req->which == Z_APDU_presentRequest)
2381 handle_present(package);
2386 package.response() = odr.create_close(
2388 Z_Close_protocolError,
2389 "zoom filter cannot handle this APDU");
2390 package.session().close();
2394 WRBUF w = m_backend->m_apdu_wrbuf;
2395 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2400 package.session().close();
2404 void yf::Zoom::Impl::process(mp::Package &package)
2406 FrontendPtr f = get_frontend(package);
2407 Z_GDU *gdu = package.request().get();
2409 if (f->m_is_virtual)
2411 f->handle_package(package);
2413 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2416 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2417 f->m_init_gdu = gdu;
2420 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2421 Z_InitResponse *resp = apdu->u.initResponse;
2424 static const int masks[] = {
2429 for (i = 0; masks[i] != -1; i++)
2430 if (ODR_MASK_GET(req->options, masks[i]))
2431 ODR_MASK_SET(resp->options, masks[i]);
2433 static const int versions[] = {
2434 Z_ProtocolVersion_1,
2435 Z_ProtocolVersion_2,
2436 Z_ProtocolVersion_3,
2439 for (i = 0; versions[i] != -1; i++)
2440 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2441 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2445 *resp->preferredMessageSize = *req->preferredMessageSize;
2446 *resp->maximumRecordSize = *req->maximumRecordSize;
2448 package.response() = apdu;
2449 f->m_is_virtual = true;
2454 release_frontend(package);
2458 static mp::filter::Base* filter_creator()
2460 return new mp::filter::Zoom;
2464 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2475 * c-file-style: "Stroustrup"
2476 * indent-tabs-mode: nil
2478 * vim: shiftwidth=4 tabstop=8 expandtab