1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <sys/types.h>
23 #include "filter_zoom.hpp"
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include <metaproxy/xmlutil.hpp>
27 #include <yaz/comstack.h>
31 #include <libxslt/xsltutils.h>
32 #include <libxslt/transform.h>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/thread/condition.hpp>
37 #include <yaz/yaz-version.h>
38 #include <yaz/tpath.h>
40 #include <yaz/ccl_xml.h>
42 #include <yaz/rpn2cql.h>
43 #include <yaz/rpn2solr.h>
44 #include <yaz/pquery.h>
46 #include <yaz/oid_db.h>
47 #include <yaz/diagbib1.h>
50 #include <yaz/querytowrbuf.h>
51 #include <yaz/sortspec.h>
52 #include <yaz/tokenizer.h>
55 namespace mp = metaproxy_1;
56 namespace yf = mp::filter;
58 namespace metaproxy_1 {
60 class Zoom::Searchable : boost::noncopyable {
62 std::string authentication;
68 std::string query_encoding;
70 std::string sru_version;
71 std::string request_syntax;
72 std::string element_set;
73 std::string record_encoding;
74 std::string transform_xsl_fname;
75 std::string transform_xsl_content;
76 std::string urlRecipe;
77 std::string contentConnector;
78 std::string sortStrategy;
81 CCL_bibset ccl_bibset;
82 std::map<std::string, std::string> sortmap;
83 Searchable(CCL_bibset base);
86 class Zoom::Backend : boost::noncopyable {
88 friend class Frontend;
90 mp::wrbuf m_apdu_wrbuf;
91 ZOOM_connection m_connection;
92 ZOOM_resultset m_resultset;
93 std::string m_frontend_database;
95 xsltStylesheetPtr xsp;
96 std::string cproxy_host;
103 void connect(std::string zurl, int *error, char **addinfo,
105 void search(ZOOM_query q, Odr_int *hits,
106 int *error, char **addinfo, ODR odr);
107 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
108 int *error, char **addinfo, ODR odr);
109 void set_option(const char *name, const char *value);
110 void set_option(const char *name, std::string value);
111 const char *get_option(const char *name);
112 void get_zoom_error(int *error, char **addinfo, ODR odr);
114 class Zoom::Frontend : boost::noncopyable {
119 yazpp_1::GDU m_init_gdu;
120 BackendPtr m_backend;
121 void handle_package(mp::Package &package);
122 void handle_search(mp::Package &package);
124 BackendPtr explain_search(mp::Package &package,
125 std::string &database,
129 std::string &torus_db,
131 void handle_present(mp::Package &package);
132 BackendPtr get_backend_from_databases(mp::Package &package,
133 std::string &database,
140 bool create_content_session(mp::Package &package,
145 std::string authentication,
149 void prepare_elements(BackendPtr b,
150 Odr_oid *preferredRecordSyntax,
151 const char *element_set_name,
152 bool &enable_pz2_retrieval,
153 bool &enable_pz2_transform,
154 bool &enable_record_transform,
155 bool &assume_marc8_charset);
157 Z_Records *get_records(Package &package,
159 Odr_int number_to_present,
162 Odr_int *number_of_records_returned,
163 ODR odr, BackendPtr b,
164 Odr_oid *preferredRecordSyntax,
165 const char *element_set_name);
166 Z_Records *get_explain_records(Package &package,
168 Odr_int number_to_present,
171 Odr_int *number_of_records_returned,
172 ODR odr, BackendPtr b,
173 Odr_oid *preferredRecordSyntax,
174 const char *element_set_name);
176 void log_diagnostic(mp::Package &package,
177 int error, const char *addinfo);
179 Frontend(Impl *impl);
183 friend class Frontend;
187 void process(metaproxy_1::Package & package);
188 void configure(const xmlNode * ptr, bool test_only,
191 void configure_local_records(const xmlNode * ptr, bool test_only);
192 bool check_proxy(const char *proxy);
193 FrontendPtr get_frontend(mp::Package &package);
194 void release_frontend(mp::Package &package);
195 SearchablePtr parse_torus_record(const xmlNode *ptr);
196 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
197 std::map<mp::Session, FrontendPtr> m_clients;
198 boost::mutex m_mutex;
199 boost::condition m_cond_session_ready;
200 std::string torus_searchable_url;
201 std::string torus_content_url;
202 std::string default_realm;
203 std::map<std::string,std::string> fieldmap;
205 std::string file_path;
206 std::string content_proxy_server;
207 std::string content_tmp_file;
208 std::string content_config_file;
211 std::string element_transform;
212 std::string element_raw;
214 xsltStylesheetPtr explain_xsp;
215 xsltStylesheetPtr record_xsp;
216 std::map<std::string,SearchablePtr> s_map;
217 std::string zoom_timeout;
224 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
228 if (ptr->type == XML_ELEMENT_NODE &&
229 !strcmp((const char *) ptr->name, "recordData"))
235 else // else: we don't want to find nested nodes
237 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
246 // define Pimpl wrapper forwarding to Impl
248 yf::Zoom::Zoom() : m_p(new Impl)
253 { // must have a destructor because of boost::scoped_ptr
256 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
259 m_p->configure(xmlnode, test_only, path);
262 void yf::Zoom::process(mp::Package &package) const
264 m_p->process(package);
268 // define Implementation stuff
270 yf::Zoom::Backend::Backend()
272 m_connection = ZOOM_connection_create(0);
273 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
276 enable_cproxy = true;
277 enable_explain = false;
281 yf::Zoom::Backend::~Backend()
284 xsltFreeStylesheet(xsp);
286 xmlFreeDoc(explain_doc);
287 ZOOM_connection_destroy(m_connection);
288 ZOOM_resultset_destroy(m_resultset);
292 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
296 const char *zoom_addinfo = 0;
297 const char *dset = 0;
298 int error0 = ZOOM_connection_error_x(m_connection, &msg,
299 &zoom_addinfo, &dset);
305 if (!strcmp(dset, "info:srw/diagnostic/1"))
306 *error = yaz_diag_srw_to_bib1(error0);
307 else if (!strcmp(dset, "Bib-1"))
309 else if (!strcmp(dset, "ZOOM"))
311 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
312 if (error0 == ZOOM_ERROR_INIT)
313 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
314 else if (error0 == ZOOM_ERROR_DECODE)
318 if (strstr(zoom_addinfo, "Authentication") ||
319 strstr(zoom_addinfo, "authentication"))
320 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
325 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
327 *addinfo = (char *) odr_malloc(
328 odr, 30 + strlen(dset) + strlen(msg) +
329 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
331 if (zoom_addinfo && *zoom_addinfo)
333 strcpy(*addinfo, zoom_addinfo);
334 strcat(*addinfo, " ");
336 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
340 void yf::Zoom::Backend::connect(std::string zurl,
341 int *error, char **addinfo,
344 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
345 get_zoom_error(error, addinfo, odr);
348 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
349 int *error, char **addinfo, ODR odr)
351 ZOOM_resultset_destroy(m_resultset);
352 m_resultset = ZOOM_connection_search(m_connection, q);
353 get_zoom_error(error, addinfo, odr);
355 *hits = ZOOM_resultset_size(m_resultset);
360 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
362 int *error, char **addinfo, ODR odr)
364 ZOOM_resultset_records(m_resultset, recs, start, number);
365 get_zoom_error(error, addinfo, odr);
368 void yf::Zoom::Backend::set_option(const char *name, const char *value)
370 ZOOM_connection_option_set(m_connection, name, value);
372 ZOOM_resultset_option_set(m_resultset, name, value);
375 void yf::Zoom::Backend::set_option(const char *name, std::string value)
377 set_option(name, value.c_str());
380 const char *yf::Zoom::Backend::get_option(const char *name)
382 return ZOOM_connection_option_get(m_connection, name);
385 yf::Zoom::Searchable::Searchable(CCL_bibset base)
388 use_turbomarc = true;
389 sortStrategy = "embed";
390 ccl_bibset = ccl_qual_dup(base);
393 yf::Zoom::Searchable::~Searchable()
395 ccl_qual_rm(&ccl_bibset);
398 yf::Zoom::Frontend::Frontend(Impl *impl) :
399 m_p(impl), m_is_virtual(false), m_in_use(true)
403 yf::Zoom::Frontend::~Frontend()
407 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
409 boost::mutex::scoped_lock lock(m_mutex);
411 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
415 it = m_clients.find(package.session());
416 if (it == m_clients.end())
419 if (!it->second->m_in_use)
421 it->second->m_in_use = true;
424 m_cond_session_ready.wait(lock);
426 FrontendPtr f(new Frontend(this));
427 m_clients[package.session()] = f;
432 void yf::Zoom::Impl::release_frontend(mp::Package &package)
434 boost::mutex::scoped_lock lock(m_mutex);
435 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
437 it = m_clients.find(package.session());
438 if (it != m_clients.end())
440 if (package.session().is_closed())
446 it->second->m_in_use = false;
448 m_cond_session_ready.notify_all();
452 yf::Zoom::Impl::Impl() :
453 apdu_log(false), element_transform("pz2") , element_raw("raw"),
454 zoom_timeout("40"), proxy_timeout(1)
456 bibset = ccl_qual_mk();
460 srand((unsigned int) time(0));
463 yf::Zoom::Impl::~Impl()
466 xsltFreeStylesheet(explain_xsp);
467 ccl_qual_rm(&bibset);
470 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
472 Zoom::SearchablePtr s(new Searchable(bibset));
474 for (ptr = ptr->children; ptr; ptr = ptr->next)
476 if (ptr->type != XML_ELEMENT_NODE)
478 if (!strcmp((const char *) ptr->name, "layer"))
480 else if (!strcmp((const char *) ptr->name,
483 s->authentication = mp::xml::get_text(ptr);
485 else if (!strcmp((const char *) ptr->name,
488 s->cfAuth = mp::xml::get_text(ptr);
490 else if (!strcmp((const char *) ptr->name,
493 s->cfProxy = mp::xml::get_text(ptr);
495 else if (!strcmp((const char *) ptr->name,
498 s->cfSubDB = mp::xml::get_text(ptr);
500 else if (!strcmp((const char *) ptr->name,
503 s->contentConnector = mp::xml::get_text(ptr);
505 else if (!strcmp((const char *) ptr->name, "udb"))
507 s->udb = mp::xml::get_text(ptr);
509 else if (!strcmp((const char *) ptr->name, "zurl"))
511 s->target = mp::xml::get_text(ptr);
513 else if (!strcmp((const char *) ptr->name, "sru"))
515 s->sru = mp::xml::get_text(ptr);
517 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
518 !strcmp((const char *) ptr->name, "sruVersion"))
520 s->sru_version = mp::xml::get_text(ptr);
522 else if (!strcmp((const char *) ptr->name,
525 s->query_encoding = mp::xml::get_text(ptr);
527 else if (!strcmp((const char *) ptr->name,
530 s->piggyback = mp::xml::get_bool(ptr, true);
532 else if (!strcmp((const char *) ptr->name,
535 s->request_syntax = mp::xml::get_text(ptr);
537 else if (!strcmp((const char *) ptr->name,
540 s->element_set = mp::xml::get_text(ptr);
542 else if (!strcmp((const char *) ptr->name,
545 s->record_encoding = mp::xml::get_text(ptr);
547 else if (!strcmp((const char *) ptr->name,
550 s->transform_xsl_fname = mp::xml::get_text(ptr);
552 else if (!strcmp((const char *) ptr->name,
555 s->transform_xsl_content = mp::xml::get_text(ptr);
557 else if (!strcmp((const char *) ptr->name,
560 s->urlRecipe = mp::xml::get_text(ptr);
562 else if (!strcmp((const char *) ptr->name,
565 ; // useTurboMarc is ignored
567 else if (!strncmp((const char *) ptr->name,
570 std::string value = mp::xml::get_text(ptr);
571 if (value.length() > 0)
573 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
574 (const char *) ptr->name + 7);
577 else if (!strncmp((const char *) ptr->name,
580 std::string value = mp::xml::get_text(ptr);
581 s->sortmap[(const char *) ptr->name + 8] = value;
583 else if (!strcmp((const char *) ptr->name,
586 s->sortStrategy = mp::xml::get_text(ptr);
592 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
594 while (ptr && ptr->type != XML_ELEMENT_NODE)
599 if (!strcmp((const char *) ptr->name, "records"))
601 for (ptr = ptr->children; ptr; ptr = ptr->next)
603 if (ptr->type != XML_ELEMENT_NODE)
605 if (!strcmp((const char *) ptr->name, "record"))
607 SearchablePtr s = parse_torus_record(ptr);
610 std::string udb = s->udb;
615 throw mp::filter::FilterException
616 ("No udb for local torus record");
622 throw mp::filter::FilterException
624 + std::string((const char *) ptr->name)
625 + " in zoom filter inside element "
632 throw mp::filter::FilterException
634 + std::string((const char *) ptr->name)
635 + " in zoom filter inside element <torus>");
640 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
643 std::string explain_xslt_fname;
644 std::string record_xslt_fname;
650 for (ptr = ptr->children; ptr; ptr = ptr->next)
652 if (ptr->type != XML_ELEMENT_NODE)
654 else if (!strcmp((const char *) ptr->name, "torus"))
656 const struct _xmlAttr *attr;
657 for (attr = ptr->properties; attr; attr = attr->next)
659 if (!strcmp((const char *) attr->name, "url"))
660 torus_searchable_url = mp::xml::get_text(attr->children);
661 else if (!strcmp((const char *) attr->name, "content_url"))
662 torus_content_url = mp::xml::get_text(attr->children);
663 else if (!strcmp((const char *) attr->name, "realm"))
664 default_realm = mp::xml::get_text(attr->children);
665 else if (!strcmp((const char *) attr->name, "xsldir"))
666 xsldir = mp::xml::get_text(attr->children);
667 else if (!strcmp((const char *) attr->name, "element_transform"))
668 element_transform = mp::xml::get_text(attr->children);
669 else if (!strcmp((const char *) attr->name, "element_raw"))
670 element_raw = mp::xml::get_text(attr->children);
671 else if (!strcmp((const char *) attr->name, "proxy"))
672 proxy = mp::xml::get_text(attr->children);
673 else if (!strcmp((const char *) attr->name, "explain_xsl"))
674 explain_xslt_fname = mp::xml::get_text(attr->children);
675 else if (!strcmp((const char *) attr->name, "record_xsl"))
676 record_xslt_fname = mp::xml::get_text(attr->children);
678 throw mp::filter::FilterException(
679 "Bad attribute " + std::string((const char *)
682 // If content_url is not given, use value of searchable, to
683 // ensure backwards compatibility
684 if (!torus_content_url.length())
685 torus_content_url = torus_searchable_url;
686 configure_local_records(ptr->children, test_only);
688 else if (!strcmp((const char *) ptr->name, "cclmap"))
690 const char *addinfo = 0;
691 ccl_xml_config(bibset, ptr, &addinfo);
693 else if (!strcmp((const char *) ptr->name, "fieldmap"))
695 const struct _xmlAttr *attr;
696 std::string ccl_field;
697 std::string cql_field;
698 for (attr = ptr->properties; attr; attr = attr->next)
700 if (!strcmp((const char *) attr->name, "ccl"))
701 ccl_field = mp::xml::get_text(attr->children);
702 else if (!strcmp((const char *) attr->name, "cql"))
703 cql_field = mp::xml::get_text(attr->children);
705 throw mp::filter::FilterException(
706 "Bad attribute " + std::string((const char *)
709 if (cql_field.length())
710 fieldmap[cql_field] = ccl_field;
712 else if (!strcmp((const char *) ptr->name, "contentProxy"))
714 const struct _xmlAttr *attr;
715 for (attr = ptr->properties; attr; attr = attr->next)
717 if (!strcmp((const char *) attr->name, "server"))
720 "contentProxy's server attribute is deprecated");
722 "Specify config_file instead. For example:");
724 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
725 content_proxy_server = mp::xml::get_text(attr->children);
727 else if (!strcmp((const char *) attr->name, "tmp_file"))
728 content_tmp_file = mp::xml::get_text(attr->children);
729 else if (!strcmp((const char *) attr->name, "config_file"))
730 content_config_file = mp::xml::get_text(attr->children);
732 throw mp::filter::FilterException(
733 "Bad attribute " + std::string((const char *)
737 else if (!strcmp((const char *) ptr->name, "log"))
739 const struct _xmlAttr *attr;
740 for (attr = ptr->properties; attr; attr = attr->next)
742 if (!strcmp((const char *) attr->name, "apdu"))
743 apdu_log = mp::xml::get_bool(attr->children, false);
745 throw mp::filter::FilterException(
746 "Bad attribute " + std::string((const char *)
750 else if (!strcmp((const char *) ptr->name, "zoom"))
752 const struct _xmlAttr *attr;
753 for (attr = ptr->properties; attr; attr = attr->next)
755 if (!strcmp((const char *) attr->name, "timeout"))
756 zoom_timeout = mp::xml::get_text(attr->children);
757 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
758 proxy_timeout = mp::xml::get_int(attr->children, 1);
760 throw mp::filter::FilterException(
761 "Bad attribute " + std::string((const char *)
767 throw mp::filter::FilterException
769 + std::string((const char *) ptr->name)
770 + " in zoom filter");
774 if (explain_xslt_fname.length())
776 const char *path = 0;
779 path = xsldir.c_str();
781 path = file_path.c_str();
784 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
788 throw mp::filter::FilterException
789 ("Cannot read XSLT " + explain_xslt_fname);
792 xmlDoc *xsp_doc = xmlParseFile(cp);
795 throw mp::filter::FilterException
796 ("Cannot parse XSLT " + explain_xslt_fname);
799 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
803 throw mp::filter::FilterException
804 ("Cannot parse XSLT " + explain_xslt_fname);
809 if (record_xslt_fname.length())
811 const char *path = 0;
814 path = xsldir.c_str();
816 path = file_path.c_str();
819 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
823 throw mp::filter::FilterException
824 ("Cannot read XSLT " + record_xslt_fname);
827 xmlDoc *xsp_doc = xmlParseFile(cp);
830 throw mp::filter::FilterException
831 ("Cannot parse XSLT " + record_xslt_fname);
834 record_xsp = xsltParseStylesheetDoc(xsp_doc);
838 throw mp::filter::FilterException
839 ("Cannot parse XSLT " + record_xslt_fname);
845 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
847 int *error, char **addinfo,
849 std::string authentication,
853 if (b->sptr->contentConnector.length())
855 std::string proxyhostname;
856 std::string tmp_file;
857 bool legacy_format = false;
859 if (m_p->content_proxy_server.length())
861 proxyhostname = m_p->content_proxy_server;
862 legacy_format = true;
865 if (m_p->content_tmp_file.length())
866 tmp_file = m_p->content_tmp_file;
868 if (m_p->content_config_file.length())
870 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
874 while (fgets(buf, sizeof(buf)-1, inf))
877 cp = strchr(buf, '#');
880 cp = strchr(buf, '\n');
883 cp = strchr(buf, ':');
887 while (cp1 != buf && cp1[-1] == ' ')
893 if (!strcmp(buf, "proxyhostname"))
895 if (!strcmp(buf, "sessiondir") && *cp)
897 if (cp[strlen(cp)-1] == '/')
898 cp[strlen(cp)-1] = '\0';
899 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
907 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
908 "unable to open content config %s",
909 m_p->content_config_file.c_str());
910 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
911 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
912 sprintf(*addinfo, "unable to open content config %s",
913 m_p->content_config_file.c_str());
918 if (proxyhostname.length() == 0)
920 package.log("zoom", YLOG_WARN, "no proxyhostname");
923 if (tmp_file.length() == 0)
925 package.log("zoom", YLOG_WARN, "no tmp_file");
929 char *fname = xstrdup(tmp_file.c_str());
930 char *xx = strstr(fname, "XXXXXX");
933 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
934 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
935 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
936 sprintf(*addinfo, "bad format of content tmp_file: %s",
941 char tmp_char = xx[6];
942 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
944 b->cproxy_host = std::string(xx) + "." + proxyhostname;
946 b->cproxy_host = proxyhostname + "/" + xx;
949 FILE *file = fopen(fname, "w");
952 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
953 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
954 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
955 sprintf(*addinfo, "Could not create %s", fname);
960 wrbuf_puts(w, "#content_proxy\n");
961 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
962 if (authentication.length())
963 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
965 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
967 wrbuf_printf(w, "realm: %s\n", realm.c_str());
969 fwrite(w.buf(), 1, w.len(), file);
971 package.log("zoom", YLOG_LOG, "content file: %s", fname);
977 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
978 mp::Package &package,
979 std::string &database, int *error, char **addinfo, mp::odr &odr,
980 int *proxy_step, std::string &proxy)
983 std::list<BackendPtr>::const_iterator map_it;
984 if (m_backend && !m_backend->enable_explain &&
985 m_backend->m_frontend_database == database)
987 m_backend->connect("", error, addinfo, odr);
991 std::string input_args;
992 std::string torus_db;
993 size_t db_arg_pos = database.find(',');
994 if (db_arg_pos != std::string::npos)
996 torus_db = database.substr(0, db_arg_pos);
997 input_args = database.substr(db_arg_pos + 1);
1000 torus_db = database;
1002 std::string authentication;
1003 std::string content_authentication;
1004 std::string content_proxy;
1005 std::string realm = m_p->default_realm;
1007 const char *param_user = 0;
1008 const char *param_password = 0;
1009 const char *param_content_user = 0;
1010 const char *param_content_password = 0;
1011 const char *param_nocproxy = 0;
1016 int no_out_args = 0;
1017 if (input_args.length())
1018 no_parms = yaz_uri_to_array(input_args.c_str(),
1019 odr, &names, &values);
1020 // adding 10 because we'll be adding other URL args
1021 const char **out_names = (const char **)
1022 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1023 const char **out_values = (const char **)
1024 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1026 // may be changed if it's a content connection
1027 std::string torus_url = m_p->torus_searchable_url;
1029 for (i = 0; i < no_parms; i++)
1031 const char *name = names[i];
1032 const char *value = values[i];
1035 if (!strcmp(name, "user"))
1037 else if (!strcmp(name, "password"))
1038 param_password = value;
1039 else if (!strcmp(name, "content-user"))
1040 param_content_user = value;
1041 else if (!strcmp(name, "content-password"))
1042 param_content_password = value;
1043 else if (!strcmp(name, "content-proxy"))
1044 content_proxy = value;
1045 else if (!strcmp(name, "nocproxy"))
1046 param_nocproxy = value;
1047 else if (!strcmp(name, "proxy"))
1051 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1052 if (*proxy_step >= dnum)
1056 proxy = dstr[*proxy_step];
1059 if (*proxy_step == dnum)
1063 else if (!strcmp(name, "cproxysession"))
1065 out_names[no_out_args] = name;
1066 out_values[no_out_args++] = value;
1067 torus_url = m_p->torus_content_url;
1069 else if (!strcmp(name, "realm"))
1071 else if (name[0] == 'x' && name[1] == '-')
1073 out_names[no_out_args] = name;
1074 out_values[no_out_args++] = value;
1078 BackendPtr notfound;
1079 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1080 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1081 sprintf(msg, "Bad database argument: %s", name);
1088 authentication = std::string(param_user);
1090 authentication += "/" + std::string(param_password);
1092 if (param_content_user)
1094 content_authentication = std::string(param_content_user);
1095 if (param_content_password)
1096 content_authentication += "/" + std::string(param_content_password);
1099 if (torus_db.compare("IR-Explain---1") == 0)
1100 return explain_search(package, database, error, addinfo, odr, torus_db,
1105 std::map<std::string,SearchablePtr>::iterator it;
1106 it = m_p->s_map.find(torus_db);
1107 if (it != m_p->s_map.end())
1109 else if (torus_url.length() > 0)
1111 std::string torus_query = "udb==" + torus_db;
1112 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1117 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1118 *addinfo = odr_strdup(odr, torus_db.c_str());
1122 const xmlNode *ptr = xmlDocGetRootElement(doc);
1124 { // presumably ptr is a records element node
1125 // parse first record in document
1126 for (ptr = ptr->children; ptr; ptr = ptr->next)
1128 if (ptr->type == XML_ELEMENT_NODE
1129 && !strcmp((const char *) ptr->name, "record"))
1133 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1134 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1135 sprintf(*addinfo, "multiple records for udb=%s",
1141 sptr = m_p->parse_torus_record(ptr);
1150 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1151 *addinfo = odr_strdup(odr, torus_db.c_str());
1156 xsltStylesheetPtr xsp = 0;
1157 if (sptr->transform_xsl_content.length())
1159 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1160 sptr->transform_xsl_content.length());
1163 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1164 *addinfo = (char *) odr_malloc(odr, 40);
1165 sprintf(*addinfo, "xmlParseMemory failed");
1169 xsp = xsltParseStylesheetDoc(xsp_doc);
1172 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1173 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1175 xmlFreeDoc(xsp_doc);
1179 else if (sptr->transform_xsl_fname.length())
1181 const char *path = 0;
1183 if (m_p->xsldir.length())
1184 path = m_p->xsldir.c_str();
1186 path = m_p->file_path.c_str();
1189 char fullpath[1024];
1190 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1196 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1198 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1199 sprintf(*addinfo, "File could not be read: %s",
1200 sptr->transform_xsl_fname.c_str());
1204 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1207 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1208 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1209 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1213 xsp = xsltParseStylesheetDoc(xsp_doc);
1216 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1217 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1219 xmlFreeDoc(xsp_doc);
1226 BackendPtr b(new Backend);
1230 b->m_frontend_database = database;
1231 b->enable_cproxy = param_nocproxy ? false : true;
1233 if (sptr->query_encoding.length())
1234 b->set_option("rpnCharset", sptr->query_encoding);
1236 b->set_option("timeout", m_p->zoom_timeout.c_str());
1239 b->set_option("apdulog", "1");
1241 if (sptr->piggyback && sptr->sru.length())
1242 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1243 maximumRecords > 0 */
1244 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1246 if (authentication.length() == 0)
1247 authentication = sptr->authentication;
1249 if (proxy.length() == 0)
1250 proxy = sptr->cfProxy;
1252 if (sptr->cfAuth.length())
1255 b->set_option("user", sptr->cfAuth);
1256 if (authentication.length())
1258 size_t found = authentication.find('/');
1259 if (found != std::string::npos)
1261 out_names[no_out_args] = "user";
1262 out_values[no_out_args++] =
1263 odr_strdup(odr, authentication.substr(0, found).c_str());
1265 out_names[no_out_args] = "password";
1266 out_values[no_out_args++] =
1267 odr_strdup(odr, authentication.substr(found+1).c_str());
1271 out_names[no_out_args] = "user";
1272 out_values[no_out_args++] =
1273 odr_strdup(odr, authentication.c_str());
1278 out_names[no_out_args] = "proxy";
1279 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1281 if (sptr->cfSubDB.length())
1283 out_names[no_out_args] = "subdatabase";
1284 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1288 out_names[no_out_args] = "nocproxy";
1289 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1294 size_t found = authentication.find('/');
1296 if (sptr->sru.length() && found != std::string::npos)
1298 b->set_option("user", authentication.substr(0, found));
1299 b->set_option("password", authentication.substr(found+1));
1302 b->set_option("user", authentication);
1305 b->set_option("proxy", proxy);
1308 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1311 if (sptr->sru.length())
1313 url = "http://" + sptr->target;
1314 b->set_option("sru", sptr->sru);
1316 if (sptr->sru_version.length())
1317 b->set_option("sru_version", sptr->sru_version);
1326 out_names[no_out_args] = 0; // terminate list
1328 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1329 (char **) out_values);
1330 url += "," + std::string(x_args);
1332 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1333 b->connect(url, error, addinfo, odr);
1334 if (*error == 0 && b->enable_cproxy)
1335 create_content_session(package, b, error, addinfo, odr,
1336 content_authentication.length() ?
1337 content_authentication : authentication,
1338 content_proxy.length() ? content_proxy : proxy,
1345 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1346 Odr_oid *preferredRecordSyntax,
1347 const char *element_set_name,
1348 bool &enable_pz2_retrieval,
1349 bool &enable_pz2_transform,
1350 bool &enable_record_transform,
1351 bool &assume_marc8_charset)
1353 char oid_name_str[OID_STR_MAX];
1354 const char *syntax_name = 0;
1356 if (preferredRecordSyntax &&
1357 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1359 if (element_set_name &&
1360 !strcmp(element_set_name, m_p->element_transform.c_str()))
1362 enable_pz2_retrieval = true;
1363 enable_pz2_transform = true;
1365 else if (element_set_name &&
1366 !strcmp(element_set_name, m_p->element_raw.c_str()))
1368 enable_pz2_retrieval = true;
1370 else if (m_p->record_xsp)
1372 enable_pz2_retrieval = true;
1373 enable_pz2_transform = true;
1374 enable_record_transform = true;
1378 if (enable_pz2_retrieval)
1380 std::string configured_request_syntax = b->sptr->request_syntax;
1381 if (configured_request_syntax.length())
1383 syntax_name = configured_request_syntax.c_str();
1384 const Odr_oid *syntax_oid =
1385 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1386 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1387 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1388 assume_marc8_charset = true;
1391 else if (preferredRecordSyntax)
1393 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1395 if (b->sptr->sru.length())
1396 syntax_name = "XML";
1398 b->set_option("preferredRecordSyntax", syntax_name);
1400 if (enable_pz2_retrieval)
1402 element_set_name = 0;
1403 if (b->sptr->element_set.length())
1404 element_set_name = b->sptr->element_set.c_str();
1407 b->set_option("elementSetName", element_set_name);
1408 if (b->sptr->sru.length() && element_set_name)
1409 b->set_option("schema", element_set_name);
1412 Z_Records *yf::Zoom::Frontend::get_explain_records(
1415 Odr_int number_to_present,
1418 Odr_int *number_of_records_returned,
1421 Odr_oid *preferredRecordSyntax,
1422 const char *element_set_name)
1425 Z_Records *records = 0;
1427 if (!b->explain_doc)
1431 if (number_to_present > 10000)
1432 number_to_present = 10000;
1434 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1436 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1437 odr_malloc(odr, sizeof(*npl));
1438 npl->records = (Z_NamePlusRecord **)
1439 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1441 for (i = 0; i < number_to_present; i++)
1444 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1447 xmlBufferPtr xml_buf = xmlBufferCreate();
1448 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1449 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1451 Z_NamePlusRecord *npr =
1452 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1453 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1454 npr->which = Z_NamePlusRecord_databaseRecord;
1455 npr->u.databaseRecord =
1456 z_ext_record_xml(odr,
1457 (const char *) xml_buf->content, xml_buf->use);
1458 npl->records[i] = npr;
1459 xmlFreeNode(tmp_node);
1460 xmlBufferFree(xml_buf);
1462 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1463 records->which = Z_Records_DBOSD;
1464 records->u.databaseOrSurDiagnostics = npl;
1466 npl->num_records = i;
1467 *number_of_records_returned = i;
1472 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
1474 Odr_int number_to_present,
1477 Odr_int *number_of_records_returned,
1480 Odr_oid *preferredRecordSyntax,
1481 const char *element_set_name)
1483 *number_of_records_returned = 0;
1484 Z_Records *records = 0;
1485 bool enable_pz2_retrieval = false; // whether target profile is used
1486 bool enable_pz2_transform = false; // whether XSLT is used as well
1487 bool assume_marc8_charset = false;
1488 bool enable_record_transform = false;
1490 prepare_elements(b, preferredRecordSyntax,
1492 enable_pz2_retrieval,
1493 enable_pz2_transform,
1494 enable_record_transform,
1495 assume_marc8_charset);
1497 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1498 enable_pz2_retrieval ? "yes" : "no",
1499 enable_pz2_transform ? "yes" : "no");
1501 if (start < 0 || number_to_present <=0)
1504 if (number_to_present > 10000)
1505 number_to_present = 10000;
1507 ZOOM_record *recs = (ZOOM_record *)
1508 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1510 b->present(start, number_to_present, recs, error, addinfo, odr);
1515 for (i = 0; i < number_to_present; i++)
1520 { // only return records if no error and at least one record
1522 const char *xsl_parms[3];
1523 mp::wrbuf cproxy_host;
1525 if (b->enable_cproxy && b->cproxy_host.length())
1527 wrbuf_puts(cproxy_host, "\"");
1528 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1529 wrbuf_puts(cproxy_host, "/\"");
1531 xsl_parms[0] = "cproxyhost";
1532 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1540 char *odr_database = odr_strdup(odr,
1541 b->m_frontend_database.c_str());
1542 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1543 odr_malloc(odr, sizeof(*npl));
1544 *number_of_records_returned = i;
1545 npl->num_records = i;
1546 npl->records = (Z_NamePlusRecord **)
1547 odr_malloc(odr, i * sizeof(*npl->records));
1548 for (i = 0; i < number_to_present; i++)
1550 Z_NamePlusRecord *npr = 0;
1551 const char *addinfo;
1553 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1554 &addinfo, 0 /* diagset */);
1558 log_diagnostic(package, sur_error, addinfo);
1559 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1562 else if (enable_pz2_retrieval)
1564 char rec_type_str[100];
1565 const char *record_encoding = 0;
1567 if (b->sptr->record_encoding.length())
1568 record_encoding = b->sptr->record_encoding.c_str();
1569 else if (assume_marc8_charset)
1570 record_encoding = "marc8";
1572 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1573 if (record_encoding)
1575 strcat(rec_type_str, "; charset=");
1576 strcat(rec_type_str, record_encoding);
1579 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1582 xmlChar *xmlrec_buf = 0;
1583 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1585 if (!rec_buf && !npr)
1587 std::string addinfo("ZOOM_record_get failed for type ");
1589 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1590 addinfo += rec_type_str;
1591 log_diagnostic(package, error, addinfo.c_str());
1592 npr = zget_surrogateDiagRec(odr, odr_database,
1593 error, addinfo.c_str());
1597 package.log_write(rec_buf, rec_len);
1598 package.log_write("\r\n", 2);
1601 if (rec_buf && b->xsp && enable_pz2_transform)
1603 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1606 const char *addinfo = "xml parse failed for record";
1607 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1608 log_diagnostic(package, error, addinfo);
1609 npr = zget_surrogateDiagRec(
1610 odr, odr_database, error, addinfo);
1614 // first stage XSLT - per target
1615 xsltStylesheetPtr xsp = b->xsp;
1616 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1618 // insert generated-url
1622 mp::xml::url_recipe_handle(rec_res,
1623 b->sptr->urlRecipe);
1626 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1627 while (ptr && ptr->type != XML_ELEMENT_NODE)
1630 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1631 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1633 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1637 // second stage XSLT - common
1638 if (rec_res && m_p->record_xsp &&
1639 enable_record_transform)
1641 xmlDoc *tmp_doc = rec_res;
1643 xsp = m_p->record_xsp;
1644 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1646 xmlFreeDoc(tmp_doc);
1648 // get result out of it
1651 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1653 rec_buf = (const char *) xmlrec_buf;
1654 package.log_write(rec_buf, rec_len);
1656 xmlFreeDoc(rec_res);
1660 std::string addinfo;
1662 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1664 addinfo = "xslt apply failed for "
1665 + b->sptr->transform_xsl_fname;
1666 log_diagnostic(package, error, addinfo.c_str());
1667 npr = zget_surrogateDiagRec(
1668 odr, odr_database, error, addinfo.c_str());
1670 xmlFreeDoc(rec_doc);
1677 npr = zget_surrogateDiagRec(
1679 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1683 npr = (Z_NamePlusRecord *)
1684 odr_malloc(odr, sizeof(*npr));
1685 npr->databaseName = odr_database;
1686 npr->which = Z_NamePlusRecord_databaseRecord;
1687 npr->u.databaseRecord =
1688 z_ext_record_xml(odr, rec_buf, rec_len);
1692 xmlFree(xmlrec_buf);
1697 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1700 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1701 npr->databaseName = odr_database;
1702 npr->which = Z_NamePlusRecord_databaseRecord;
1703 npr->u.databaseRecord = ext;
1707 npr = zget_surrogateDiagRec(
1709 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1710 "ZOOM_record, type ext");
1713 npl->records[i] = npr;
1715 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1716 records->which = Z_Records_DBOSD;
1717 records->u.databaseOrSurDiagnostics = npl;
1722 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1725 struct cql_node *r = 0;
1733 std::map<std::string,std::string>::const_iterator it;
1734 it = fieldmap.find(cn->u.st.index);
1735 if (it == fieldmap.end())
1737 if (it->second.length())
1738 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1744 r = convert_cql_fields(cn->u.boolean.left, odr);
1746 r = convert_cql_fields(cn->u.boolean.right, odr);
1749 r = convert_cql_fields(cn->u.sort.search, odr);
1755 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1756 int error, const char *addinfo)
1758 const char *err_msg = yaz_diag_bib1_str(error);
1760 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1761 error, err_msg, addinfo);
1763 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1767 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1768 std::string &database,
1772 std::string &torus_db,
1777 BackendPtr b(new Backend);
1779 b->m_frontend_database = database;
1780 b->enable_explain = true;
1782 Z_GDU *gdu = package.request().get();
1783 Z_APDU *apdu_req = gdu->u.z3950;
1784 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1785 Z_Query *query = sr->query;
1787 if (!m_p->explain_xsp)
1789 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1791 odr_strdup(odr, "IR-Explain---1 unsupported. "
1792 "Torus explain_xsl not defined");
1795 else if (query->which == Z_Query_type_104 &&
1796 query->u.type_104->which == Z_External_CQL)
1798 std::string torus_url = m_p->torus_searchable_url;
1799 std::string torus_query(query->u.type_104->u.cql);
1800 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1803 if (m_p->explain_xsp)
1805 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1812 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1813 *addinfo = odr_strdup(odr, "IR-Explain---1 problem. "
1814 "Could not obtain Torus records for Explain");
1818 xmlNode *ptr = xmlDocGetRootElement(doc);
1821 xml_node_search(ptr, &hits, 0);
1823 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1824 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1825 package.response() = apdu_res;
1829 xmlFreeDoc(b->explain_doc);
1830 b->explain_doc = doc;
1835 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1836 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1841 static bool wait_conn(COMSTACK cs, int secs)
1843 struct yaz_poll_fd pfd;
1845 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1846 if (cs->io_pending && CS_WANT_WRITE)
1847 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1848 else if (cs->io_pending & CS_WANT_READ)
1849 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1851 pfd.fd = cs_fileno(cs);
1852 pfd.client_data = 0;
1854 int ret = yaz_poll(&pfd, 1, secs, 0);
1858 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1861 const char *uri = "http://localhost/";
1864 bool outcome = false;
1865 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1870 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1871 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1873 if (z_GDU(odr, &gdu, 0, 0))
1876 char *buf = odr_getbuf(odr, &len, 0);
1878 int ret = cs_connect(conn, add);
1879 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
1883 ret = cs_put(conn, buf, len);
1886 if (!wait_conn(conn, proxy_timeout))
1895 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1897 Z_GDU *gdu = package.request().get();
1898 Z_APDU *apdu_req = gdu->u.z3950;
1899 Z_APDU *apdu_res = 0;
1901 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1902 if (sr->num_databaseNames != 1)
1904 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1905 log_diagnostic(package, error, 0);
1906 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1907 package.response() = apdu_res;
1911 int same_retries = 0;
1912 int proxy_retries = 0;
1918 std::string db(sr->databaseNames[0]);
1921 BackendPtr b = get_backend_from_databases(package, db, &error,
1922 &addinfo, odr, &proxy_step,
1927 if (proxy.length() && !m_p->check_proxy(proxy.c_str()))
1929 if (proxy_step) // there is a failover
1932 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
1936 error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1937 addinfo = odr_strdup(odr, "proxy failure");
1939 else if (same_retries == 0 && proxy_retries == 0)
1942 package.log("zoom", YLOG_WARN, "search failed: trying first proxy");
1950 log_diagnostic(package, error, addinfo);
1951 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1952 package.response() = apdu_res;
1955 if (!b || b->enable_explain)
1958 b->set_option("setname", "default");
1960 bool enable_pz2_retrieval = false;
1961 bool enable_pz2_transform = false;
1962 bool enable_record_transform = false;
1963 bool assume_marc8_charset = false;
1964 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1965 enable_pz2_retrieval,
1966 enable_pz2_transform,
1967 enable_record_transform,
1968 assume_marc8_charset);
1971 Z_Query *query = sr->query;
1972 mp::wrbuf ccl_wrbuf;
1973 mp::wrbuf pqf_wrbuf;
1974 std::string sortkeys;
1976 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1979 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1981 else if (query->which == Z_Query_type_2)
1984 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1985 query->u.type_2->len);
1987 else if (query->which == Z_Query_type_104 &&
1988 query->u.type_104->which == Z_External_CQL)
1991 const char *cql = query->u.type_104->u.cql;
1992 CQL_parser cp = cql_parser_create();
1993 int r = cql_parser_string(cp, cql);
1994 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1997 cql_parser_destroy(cp);
1998 error = YAZ_BIB1_MALFORMED_QUERY;
1999 const char *addinfo = "CQL syntax error";
2000 log_diagnostic(package, error, addinfo);
2002 odr.create_searchResponse(apdu_req, error, addinfo);
2003 package.response() = apdu_res;
2006 struct cql_node *cn = cql_parser_result(cp);
2007 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2010 // hopefully we are getting a ptr to a index+relation+term node
2011 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2013 if (cn_error->which == CQL_NODE_ST)
2014 addinfo = cn_error->u.st.index;
2016 log_diagnostic(package, error, addinfo);
2017 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2018 package.response() = apdu_res;
2019 cql_parser_destroy(cp);
2023 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
2026 error = YAZ_BIB1_MALFORMED_QUERY;
2027 const char *addinfo = "CQL to CCL conversion error";
2029 log_diagnostic(package, error, addinfo);
2030 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2031 package.response() = apdu_res;
2032 cql_parser_destroy(cp);
2036 mp::wrbuf sru_sortkeys_wrbuf;
2037 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2039 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2040 const char *addinfo = "CQL to CCL sortby conversion";
2042 log_diagnostic(package, error, addinfo);
2043 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2044 package.response() = apdu_res;
2045 cql_parser_destroy(cp);
2048 mp::wrbuf sort_spec_wrbuf;
2049 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2051 wrbuf_puts(ccl_wrbuf, ccl_buf);
2053 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2054 yaz_tok_parse_t tp =
2055 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2056 yaz_tok_cfg_destroy(tc);
2058 /* go through sortspec and map fields */
2059 int token = yaz_tok_move(tp);
2060 while (token != YAZ_TOK_EOF)
2062 if (token == YAZ_TOK_STRING)
2064 const char *field = yaz_tok_parse_string(tp);
2065 std::map<std::string,std::string>::iterator it;
2066 it = b->sptr->sortmap.find(field);
2067 if (it != b->sptr->sortmap.end())
2068 sortkeys += it->second;
2073 token = yaz_tok_move(tp);
2074 if (token == YAZ_TOK_STRING)
2076 sortkeys += yaz_tok_parse_string(tp);
2078 if (token != YAZ_TOK_EOF)
2081 token = yaz_tok_move(tp);
2084 yaz_tok_parse_destroy(tp);
2085 cql_parser_destroy(cp);
2089 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2090 const char *addinfo = 0;
2091 log_diagnostic(package, error, addinfo);
2092 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2093 package.response() = apdu_res;
2097 if (ccl_wrbuf.len())
2100 assert(pqf_wrbuf.len() == 0);
2102 struct ccl_rpn_node *cn;
2103 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2104 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2108 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2109 error = YAZ_BIB1_MALFORMED_QUERY;
2113 case CCL_ERR_UNKNOWN_QUAL:
2114 case CCL_ERR_TRUNC_NOT_LEFT:
2115 case CCL_ERR_TRUNC_NOT_RIGHT:
2116 case CCL_ERR_TRUNC_NOT_BOTH:
2117 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2118 case CCL_ERR_TRUNC_NOT_EMBED:
2120 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2121 case CCL_ERR_TRUNC_NOT_SINGLE:
2123 error = YAZ_BIB1_UNSUPP_SEARCH;
2126 log_diagnostic(package, error, addinfo);
2127 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2128 package.response() = apdu_res;
2131 ccl_pquery(pqf_wrbuf, cn);
2132 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2136 assert(pqf_wrbuf.len());
2138 ZOOM_query q = ZOOM_query_create();
2139 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2141 if (b->get_option("sru"))
2145 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2148 if (!strcmp(b->get_option("sru"), "solr"))
2150 solr_transform_t cqlt = solr_transform_create();
2152 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2154 solr_transform_close(cqlt);
2158 cql_transform_t cqlt = cql_transform_create();
2160 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
2162 cql_transform_close(cqlt);
2166 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2167 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2168 b->search(q, &hits, &error, &addinfo, odr);
2170 ZOOM_query_destroy(q);
2174 error = YAZ_BIB1_MALFORMED_QUERY;
2175 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2176 log_diagnostic(package, error, addinfo);
2177 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2178 package.response() = apdu_res;
2184 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2185 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2186 b->search(q, &hits, &error, &addinfo, odr);
2187 ZOOM_query_destroy(q);
2192 if (proxy.length() && !m_p->check_proxy(proxy.c_str()))
2194 if (proxy_step) // there is a failover
2197 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2201 error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2202 addinfo = odr_strdup(odr, "proxy failure");
2204 else if (same_retries == 0 && proxy_retries == 0)
2207 package.log("zoom", YLOG_WARN, "search failed: trying first proxy");
2214 const char *element_set_name = 0;
2215 Odr_int number_to_present = 0;
2217 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2219 Odr_int number_of_records_returned = 0;
2220 Z_Records *records = get_records(
2222 0, number_to_present, &error, &addinfo,
2223 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2226 log_diagnostic(package, error, addinfo);
2227 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2230 apdu_res->u.searchResponse->records = records;
2231 apdu_res->u.searchResponse->numberOfRecordsReturned =
2232 odr_intdup(odr, number_of_records_returned);
2234 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2235 package.response() = apdu_res;
2238 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2240 Z_GDU *gdu = package.request().get();
2241 Z_APDU *apdu_req = gdu->u.z3950;
2242 Z_APDU *apdu_res = 0;
2243 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2248 package.response() = odr.create_presentResponse(
2249 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2252 const char *element_set_name = 0;
2253 Z_RecordComposition *comp = pr->recordComposition;
2254 if (comp && comp->which != Z_RecordComp_simple)
2256 package.response() = odr.create_presentResponse(
2258 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2261 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2262 element_set_name = comp->u.simple->u.generic;
2263 Odr_int number_of_records_returned = 0;
2267 if (m_backend->enable_explain)
2269 Z_Records *records =
2270 get_explain_records(
2272 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2273 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2274 pr->preferredRecordSyntax, element_set_name);
2276 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2279 apdu_res->u.presentResponse->records = records;
2280 apdu_res->u.presentResponse->numberOfRecordsReturned =
2281 odr_intdup(odr, number_of_records_returned);
2283 package.response() = apdu_res;
2287 Z_Records *records =
2288 get_records(package,
2289 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2290 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2291 pr->preferredRecordSyntax, element_set_name);
2293 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2296 apdu_res->u.presentResponse->records = records;
2297 apdu_res->u.presentResponse->numberOfRecordsReturned =
2298 odr_intdup(odr, number_of_records_returned);
2300 package.response() = apdu_res;
2304 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2306 Z_GDU *gdu = package.request().get();
2309 else if (gdu->which == Z_GDU_Z3950)
2311 Z_APDU *apdu_req = gdu->u.z3950;
2314 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2315 if (apdu_req->which == Z_APDU_initRequest)
2318 package.response() = odr.create_close(
2320 Z_Close_protocolError,
2323 else if (apdu_req->which == Z_APDU_searchRequest)
2325 handle_search(package);
2327 else if (apdu_req->which == Z_APDU_presentRequest)
2329 handle_present(package);
2334 package.response() = odr.create_close(
2336 Z_Close_protocolError,
2337 "zoom filter cannot handle this APDU");
2338 package.session().close();
2342 WRBUF w = m_backend->m_apdu_wrbuf;
2343 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2348 package.session().close();
2352 void yf::Zoom::Impl::process(mp::Package &package)
2354 FrontendPtr f = get_frontend(package);
2355 Z_GDU *gdu = package.request().get();
2357 if (f->m_is_virtual)
2359 f->handle_package(package);
2361 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2364 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2365 f->m_init_gdu = gdu;
2368 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2369 Z_InitResponse *resp = apdu->u.initResponse;
2372 static const int masks[] = {
2377 for (i = 0; masks[i] != -1; i++)
2378 if (ODR_MASK_GET(req->options, masks[i]))
2379 ODR_MASK_SET(resp->options, masks[i]);
2381 static const int versions[] = {
2382 Z_ProtocolVersion_1,
2383 Z_ProtocolVersion_2,
2384 Z_ProtocolVersion_3,
2387 for (i = 0; versions[i] != -1; i++)
2388 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2389 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2393 *resp->preferredMessageSize = *req->preferredMessageSize;
2394 *resp->maximumRecordSize = *req->maximumRecordSize;
2396 package.response() = apdu;
2397 f->m_is_virtual = true;
2402 release_frontend(package);
2406 static mp::filter::Base* filter_creator()
2408 return new mp::filter::Zoom;
2412 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2423 * c-file-style: "Stroustrup"
2424 * indent-tabs-mode: nil
2426 * vim: shiftwidth=4 tabstop=8 expandtab