1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <sys/types.h>
23 #include "filter_zoom.hpp"
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include <metaproxy/xmlutil.hpp>
27 #include <yaz/comstack.h>
31 #include <libxslt/xsltutils.h>
32 #include <libxslt/transform.h>
34 #include <boost/thread/mutex.hpp>
35 #include <boost/thread/condition.hpp>
37 #include <yaz/yaz-version.h>
38 #include <yaz/tpath.h>
40 #include <yaz/ccl_xml.h>
42 #include <yaz/rpn2cql.h>
43 #include <yaz/rpn2solr.h>
44 #include <yaz/pquery.h>
46 #include <yaz/oid_db.h>
47 #include <yaz/diagbib1.h>
50 #include <yaz/querytowrbuf.h>
51 #include <yaz/sortspec.h>
52 #include <yaz/tokenizer.h>
55 namespace mp = metaproxy_1;
56 namespace yf = mp::filter;
58 namespace metaproxy_1 {
60 class Zoom::Searchable : boost::noncopyable {
62 std::string authentication;
68 std::string query_encoding;
70 std::string sru_version;
71 std::string request_syntax;
72 std::string element_set;
73 std::string record_encoding;
74 std::string transform_xsl_fname;
75 std::string transform_xsl_content;
76 std::string urlRecipe;
77 std::string contentConnector;
78 std::string sortStrategy;
79 std::string extraArgs;
80 std::string rpn2cql_fname;
83 CCL_bibset ccl_bibset;
84 std::map<std::string, std::string> sortmap;
85 Searchable(CCL_bibset base);
88 class Zoom::Backend : boost::noncopyable {
90 friend class Frontend;
92 mp::wrbuf m_apdu_wrbuf;
93 ZOOM_connection m_connection;
94 ZOOM_resultset m_resultset;
95 std::string m_frontend_database;
97 xsltStylesheetPtr xsp;
98 std::string cproxy_host;
103 cql_transform_t cqlt;
107 void connect(std::string zurl, int *error, char **addinfo,
109 void search(ZOOM_query q, Odr_int *hits,
110 int *error, char **addinfo, ODR odr);
111 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
112 int *error, char **addinfo, ODR odr);
113 void set_option(const char *name, const char *value);
114 void set_option(const char *name, std::string value);
115 const char *get_option(const char *name);
116 void get_zoom_error(int *error, char **addinfo, ODR odr);
118 class Zoom::Frontend : boost::noncopyable {
123 std::string session_realm;
124 yazpp_1::GDU m_init_gdu;
125 BackendPtr m_backend;
126 void handle_package(mp::Package &package);
127 void handle_search(mp::Package &package);
129 void auth(mp::Package &package, Z_InitRequest *req,
130 int *error, char **addinfo, ODR odr);
132 BackendPtr explain_search(mp::Package &package,
133 std::string &database,
137 std::string torus_url,
138 std::string &torus_db,
140 void handle_present(mp::Package &package);
141 BackendPtr get_backend_from_databases(mp::Package &package,
142 std::string &database,
148 bool create_content_session(mp::Package &package,
153 std::string authentication,
157 void prepare_elements(BackendPtr b,
158 Odr_oid *preferredRecordSyntax,
159 const char *element_set_name,
160 bool &enable_pz2_retrieval,
161 bool &enable_pz2_transform,
162 bool &enable_record_transform,
163 bool &assume_marc8_charset);
165 Z_Records *get_records(Package &package,
167 Odr_int number_to_present,
170 Odr_int *number_of_records_returned,
171 ODR odr, BackendPtr b,
172 Odr_oid *preferredRecordSyntax,
173 const char *element_set_name);
174 Z_Records *get_explain_records(Package &package,
176 Odr_int number_to_present,
179 Odr_int *number_of_records_returned,
180 ODR odr, BackendPtr b,
181 Odr_oid *preferredRecordSyntax,
182 const char *element_set_name);
183 bool retry(mp::Package &package,
186 int &error, char **addinfo,
187 int &proxy_step, int &same_retries,
189 void log_diagnostic(mp::Package &package,
190 int error, const char *addinfo);
192 Frontend(Impl *impl);
196 friend class Frontend;
200 void process(metaproxy_1::Package & package);
201 void configure(const xmlNode * ptr, bool test_only,
204 void configure_local_records(const xmlNode * ptr, bool test_only);
205 bool check_proxy(const char *proxy);
209 FrontendPtr get_frontend(mp::Package &package);
210 void release_frontend(mp::Package &package);
211 SearchablePtr parse_torus_record(const xmlNode *ptr);
212 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
213 std::map<mp::Session, FrontendPtr> m_clients;
214 boost::mutex m_mutex;
215 boost::condition m_cond_session_ready;
216 std::string torus_searchable_url;
217 std::string torus_content_url;
218 std::string torus_auth_url;
219 std::string default_realm;
220 std::map<std::string,std::string> fieldmap;
222 std::string file_path;
223 std::string content_proxy_server;
224 std::string content_tmp_file;
225 std::string content_config_file;
228 std::string element_transform;
229 std::string element_raw;
230 std::string element_passthru;
232 xsltStylesheetPtr explain_xsp;
233 xsltStylesheetPtr record_xsp;
234 std::map<std::string,SearchablePtr> s_map;
235 std::string zoom_timeout;
242 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
246 if (ptr->type == XML_ELEMENT_NODE &&
247 !strcmp((const char *) ptr->name, "recordData"))
253 else // else: we don't want to find nested nodes
255 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
264 // define Pimpl wrapper forwarding to Impl
266 yf::Zoom::Zoom() : m_p(new Impl)
271 { // must have a destructor because of boost::scoped_ptr
274 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
277 m_p->configure(xmlnode, test_only, path);
280 void yf::Zoom::process(mp::Package &package) const
282 m_p->process(package);
286 // define Implementation stuff
288 yf::Zoom::Backend::Backend()
290 m_connection = ZOOM_connection_create(0);
291 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
294 enable_cproxy = true;
295 enable_explain = false;
300 yf::Zoom::Backend::~Backend()
303 xsltFreeStylesheet(xsp);
305 xmlFreeDoc(explain_doc);
306 cql_transform_close(cqlt);
307 ZOOM_connection_destroy(m_connection);
308 ZOOM_resultset_destroy(m_resultset);
312 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
316 const char *zoom_addinfo = 0;
317 const char *dset = 0;
318 int error0 = ZOOM_connection_error_x(m_connection, &msg,
319 &zoom_addinfo, &dset);
325 if (!strcmp(dset, "info:srw/diagnostic/1"))
326 *error = yaz_diag_srw_to_bib1(error0);
327 else if (!strcmp(dset, "Bib-1"))
329 else if (!strcmp(dset, "ZOOM"))
331 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
332 if (error0 == ZOOM_ERROR_INIT)
333 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
334 else if (error0 == ZOOM_ERROR_DECODE)
338 if (strstr(zoom_addinfo, "Authentication") ||
339 strstr(zoom_addinfo, "authentication"))
340 *error = YAZ_BIB1_INIT_AC_AUTHENTICATION_SYSTEM_ERROR;
345 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
347 *addinfo = (char *) odr_malloc(
348 odr, 30 + strlen(dset) + strlen(msg) +
349 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
351 if (zoom_addinfo && *zoom_addinfo)
353 strcpy(*addinfo, zoom_addinfo);
354 strcat(*addinfo, " ");
356 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
360 void yf::Zoom::Backend::connect(std::string zurl,
361 int *error, char **addinfo,
364 size_t h = zurl.find_first_of('#');
365 if (h != std::string::npos)
367 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
368 get_zoom_error(error, addinfo, odr);
372 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
373 int *error, char **addinfo, ODR odr)
375 ZOOM_resultset_destroy(m_resultset);
376 m_resultset = ZOOM_connection_search(m_connection, q);
377 get_zoom_error(error, addinfo, odr);
379 *hits = ZOOM_resultset_size(m_resultset);
384 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
386 int *error, char **addinfo, ODR odr)
388 ZOOM_resultset_records(m_resultset, recs, start, number);
389 get_zoom_error(error, addinfo, odr);
392 void yf::Zoom::Backend::set_option(const char *name, const char *value)
394 ZOOM_connection_option_set(m_connection, name, value);
396 ZOOM_resultset_option_set(m_resultset, name, value);
399 void yf::Zoom::Backend::set_option(const char *name, std::string value)
401 set_option(name, value.c_str());
404 const char *yf::Zoom::Backend::get_option(const char *name)
406 return ZOOM_connection_option_get(m_connection, name);
409 yf::Zoom::Searchable::Searchable(CCL_bibset base)
412 use_turbomarc = true;
413 sortStrategy = "embed";
414 ccl_bibset = ccl_qual_dup(base);
417 yf::Zoom::Searchable::~Searchable()
419 ccl_qual_rm(&ccl_bibset);
422 yf::Zoom::Frontend::Frontend(Impl *impl) :
423 m_p(impl), m_is_virtual(false), m_in_use(true)
427 yf::Zoom::Frontend::~Frontend()
431 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
433 boost::mutex::scoped_lock lock(m_mutex);
435 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
439 it = m_clients.find(package.session());
440 if (it == m_clients.end())
443 if (!it->second->m_in_use)
445 it->second->m_in_use = true;
448 m_cond_session_ready.wait(lock);
450 FrontendPtr f(new Frontend(this));
451 m_clients[package.session()] = f;
456 void yf::Zoom::Impl::release_frontend(mp::Package &package)
458 boost::mutex::scoped_lock lock(m_mutex);
459 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
461 it = m_clients.find(package.session());
462 if (it != m_clients.end())
464 if (package.session().is_closed())
470 it->second->m_in_use = false;
472 m_cond_session_ready.notify_all();
476 yf::Zoom::Impl::Impl() :
477 apdu_log(false), element_transform("pz2") , element_raw("raw") ,
478 element_passthru("F"),
479 zoom_timeout("40"), proxy_timeout(1)
481 bibset = ccl_qual_mk();
485 srand((unsigned int) time(0));
488 yf::Zoom::Impl::~Impl()
491 xsltFreeStylesheet(explain_xsp);
492 ccl_qual_rm(&bibset);
495 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
497 Zoom::SearchablePtr s(new Searchable(bibset));
499 for (ptr = ptr->children; ptr; ptr = ptr->next)
501 if (ptr->type != XML_ELEMENT_NODE)
503 if (!strcmp((const char *) ptr->name, "layer"))
505 else if (!strcmp((const char *) ptr->name,
508 s->authentication = mp::xml::get_text(ptr);
510 else if (!strcmp((const char *) ptr->name,
513 s->cfAuth = mp::xml::get_text(ptr);
515 else if (!strcmp((const char *) ptr->name,
518 s->cfProxy = mp::xml::get_text(ptr);
520 else if (!strcmp((const char *) ptr->name,
523 s->cfSubDB = mp::xml::get_text(ptr);
525 else if (!strcmp((const char *) ptr->name,
528 s->contentConnector = mp::xml::get_text(ptr);
530 else if (!strcmp((const char *) ptr->name, "udb"))
532 s->udb = mp::xml::get_text(ptr);
534 else if (!strcmp((const char *) ptr->name, "zurl"))
536 s->target = mp::xml::get_text(ptr);
538 else if (!strcmp((const char *) ptr->name, "sru"))
540 s->sru = mp::xml::get_text(ptr);
542 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
543 !strcmp((const char *) ptr->name, "sruVersion"))
545 s->sru_version = mp::xml::get_text(ptr);
547 else if (!strcmp((const char *) ptr->name,
550 s->query_encoding = mp::xml::get_text(ptr);
552 else if (!strcmp((const char *) ptr->name,
555 s->piggyback = mp::xml::get_bool(ptr, true);
557 else if (!strcmp((const char *) ptr->name,
560 s->request_syntax = mp::xml::get_text(ptr);
562 else if (!strcmp((const char *) ptr->name,
565 s->element_set = mp::xml::get_text(ptr);
567 else if (!strcmp((const char *) ptr->name,
570 s->record_encoding = mp::xml::get_text(ptr);
572 else if (!strcmp((const char *) ptr->name,
575 s->transform_xsl_fname = mp::xml::get_text(ptr);
577 else if (!strcmp((const char *) ptr->name,
580 s->transform_xsl_content = mp::xml::get_text(ptr);
582 else if (!strcmp((const char *) ptr->name,
585 s->urlRecipe = mp::xml::get_text(ptr);
587 else if (!strcmp((const char *) ptr->name,
590 ; // useTurboMarc is ignored
592 else if (!strncmp((const char *) ptr->name,
595 std::string value = mp::xml::get_text(ptr);
596 if (value.length() > 0)
598 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
599 (const char *) ptr->name + 7);
602 else if (!strncmp((const char *) ptr->name,
605 std::string value = mp::xml::get_text(ptr);
606 s->sortmap[(const char *) ptr->name + 8] = value;
608 else if (!strcmp((const char *) ptr->name,
611 s->sortStrategy = mp::xml::get_text(ptr);
613 else if (!strcmp((const char *) ptr->name,
616 s->extraArgs = mp::xml::get_text(ptr);
618 else if (!strcmp((const char *) ptr->name, "rpn2cql"))
619 s->rpn2cql_fname = mp::xml::get_text(ptr);
624 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
626 while (ptr && ptr->type != XML_ELEMENT_NODE)
631 if (!strcmp((const char *) ptr->name, "records"))
633 for (ptr = ptr->children; ptr; ptr = ptr->next)
635 if (ptr->type != XML_ELEMENT_NODE)
637 if (!strcmp((const char *) ptr->name, "record"))
639 SearchablePtr s = parse_torus_record(ptr);
642 std::string udb = s->udb;
647 throw mp::filter::FilterException
648 ("No udb for local torus record");
654 throw mp::filter::FilterException
656 + std::string((const char *) ptr->name)
657 + " in zoom filter inside element "
664 throw mp::filter::FilterException
666 + std::string((const char *) ptr->name)
667 + " in zoom filter inside element <torus>");
672 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
675 std::string explain_xslt_fname;
676 std::string record_xslt_fname;
682 for (ptr = ptr->children; ptr; ptr = ptr->next)
684 if (ptr->type != XML_ELEMENT_NODE)
686 else if (!strcmp((const char *) ptr->name, "torus"))
688 const struct _xmlAttr *attr;
689 for (attr = ptr->properties; attr; attr = attr->next)
691 if (!strcmp((const char *) attr->name, "url"))
692 torus_searchable_url = mp::xml::get_text(attr->children);
693 else if (!strcmp((const char *) attr->name, "content_url"))
694 torus_content_url = mp::xml::get_text(attr->children);
695 else if (!strcmp((const char *) attr->name, "auth_url"))
696 torus_auth_url = mp::xml::get_text(attr->children);
697 else if (!strcmp((const char *) attr->name, "realm"))
698 default_realm = mp::xml::get_text(attr->children);
699 else if (!strcmp((const char *) attr->name, "xsldir"))
700 xsldir = mp::xml::get_text(attr->children);
701 else if (!strcmp((const char *) attr->name, "element_transform"))
702 element_transform = mp::xml::get_text(attr->children);
703 else if (!strcmp((const char *) attr->name, "element_raw"))
704 element_raw = mp::xml::get_text(attr->children);
705 else if (!strcmp((const char *) attr->name, "element_passthru"))
706 element_passthru = mp::xml::get_text(attr->children);
707 else if (!strcmp((const char *) attr->name, "proxy"))
708 proxy = mp::xml::get_text(attr->children);
709 else if (!strcmp((const char *) attr->name, "explain_xsl"))
710 explain_xslt_fname = mp::xml::get_text(attr->children);
711 else if (!strcmp((const char *) attr->name, "record_xsl"))
712 record_xslt_fname = mp::xml::get_text(attr->children);
714 throw mp::filter::FilterException(
715 "Bad attribute " + std::string((const char *)
718 // If content_url is not given, use value of searchable, to
719 // ensure backwards compatibility
720 if (!torus_content_url.length())
721 torus_content_url = torus_searchable_url;
722 configure_local_records(ptr->children, test_only);
724 else if (!strcmp((const char *) ptr->name, "cclmap"))
726 const char *addinfo = 0;
727 ccl_xml_config(bibset, ptr, &addinfo);
729 else if (!strcmp((const char *) ptr->name, "fieldmap"))
731 const struct _xmlAttr *attr;
732 std::string ccl_field;
733 std::string cql_field;
734 for (attr = ptr->properties; attr; attr = attr->next)
736 if (!strcmp((const char *) attr->name, "ccl"))
737 ccl_field = mp::xml::get_text(attr->children);
738 else if (!strcmp((const char *) attr->name, "cql"))
739 cql_field = mp::xml::get_text(attr->children);
741 throw mp::filter::FilterException(
742 "Bad attribute " + std::string((const char *)
745 if (cql_field.length())
746 fieldmap[cql_field] = ccl_field;
748 else if (!strcmp((const char *) ptr->name, "contentProxy"))
750 const struct _xmlAttr *attr;
751 for (attr = ptr->properties; attr; attr = attr->next)
753 if (!strcmp((const char *) attr->name, "server"))
756 "contentProxy's server attribute is deprecated");
758 "Specify config_file instead. For example:");
760 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
761 content_proxy_server = mp::xml::get_text(attr->children);
763 else if (!strcmp((const char *) attr->name, "tmp_file"))
764 content_tmp_file = mp::xml::get_text(attr->children);
765 else if (!strcmp((const char *) attr->name, "config_file"))
766 content_config_file = mp::xml::get_text(attr->children);
768 throw mp::filter::FilterException(
769 "Bad attribute " + std::string((const char *)
773 else if (!strcmp((const char *) ptr->name, "log"))
775 const struct _xmlAttr *attr;
776 for (attr = ptr->properties; attr; attr = attr->next)
778 if (!strcmp((const char *) attr->name, "apdu"))
779 apdu_log = mp::xml::get_bool(attr->children, false);
781 throw mp::filter::FilterException(
782 "Bad attribute " + std::string((const char *)
786 else if (!strcmp((const char *) ptr->name, "zoom"))
788 const struct _xmlAttr *attr;
789 for (attr = ptr->properties; attr; attr = attr->next)
791 if (!strcmp((const char *) attr->name, "timeout"))
792 zoom_timeout = mp::xml::get_text(attr->children);
793 else if (!strcmp((const char *) attr->name, "proxy_timeout"))
794 proxy_timeout = mp::xml::get_int(attr->children, 1);
796 throw mp::filter::FilterException(
797 "Bad attribute " + std::string((const char *)
803 throw mp::filter::FilterException
805 + std::string((const char *) ptr->name)
806 + " in zoom filter");
810 if (explain_xslt_fname.length())
812 const char *path = 0;
815 path = xsldir.c_str();
817 path = file_path.c_str();
820 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
824 throw mp::filter::FilterException
825 ("Cannot read XSLT " + explain_xslt_fname);
828 xmlDoc *xsp_doc = xmlParseFile(cp);
831 throw mp::filter::FilterException
832 ("Cannot parse XSLT " + explain_xslt_fname);
835 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
839 throw mp::filter::FilterException
840 ("Cannot parse XSLT " + explain_xslt_fname);
845 if (record_xslt_fname.length())
847 const char *path = 0;
850 path = xsldir.c_str();
852 path = file_path.c_str();
855 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
859 throw mp::filter::FilterException
860 ("Cannot read XSLT " + record_xslt_fname);
863 xmlDoc *xsp_doc = xmlParseFile(cp);
866 throw mp::filter::FilterException
867 ("Cannot parse XSLT " + record_xslt_fname);
870 record_xsp = xsltParseStylesheetDoc(xsp_doc);
874 throw mp::filter::FilterException
875 ("Cannot parse XSLT " + record_xslt_fname);
881 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
883 int *error, char **addinfo,
885 std::string authentication,
889 if (b->sptr->contentConnector.length())
891 std::string proxyhostname;
892 std::string tmp_file;
893 bool legacy_format = false;
895 if (m_p->content_proxy_server.length())
897 proxyhostname = m_p->content_proxy_server;
898 legacy_format = true;
901 if (m_p->content_tmp_file.length())
902 tmp_file = m_p->content_tmp_file;
904 if (m_p->content_config_file.length())
906 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
910 while (fgets(buf, sizeof(buf)-1, inf))
913 cp = strchr(buf, '#');
916 cp = strchr(buf, '\n');
919 cp = strchr(buf, ':');
923 while (cp1 != buf && cp1[-1] == ' ')
929 if (!strcmp(buf, "proxyhostname"))
931 if (!strcmp(buf, "sessiondir") && *cp)
933 if (cp[strlen(cp)-1] == '/')
934 cp[strlen(cp)-1] = '\0';
935 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
943 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
944 "unable to open content config %s",
945 m_p->content_config_file.c_str());
946 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
947 *addinfo = (char *) odr_malloc(odr, 70 + tmp_file.length());
948 sprintf(*addinfo, "zoom: unable to open content config %s",
949 m_p->content_config_file.c_str());
954 if (proxyhostname.length() == 0)
956 package.log("zoom", YLOG_WARN, "no proxyhostname");
959 if (tmp_file.length() == 0)
961 package.log("zoom", YLOG_WARN, "no tmp_file");
965 char *fname = xstrdup(tmp_file.c_str());
966 char *xx = strstr(fname, "XXXXXX");
969 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
970 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
971 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
972 sprintf(*addinfo, "zoom: bad format of content tmp_file: %s",
977 char tmp_char = xx[6];
978 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
980 b->cproxy_host = std::string(xx) + "." + proxyhostname;
982 b->cproxy_host = proxyhostname + "/" + xx;
985 FILE *file = fopen(fname, "w");
988 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
989 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
990 *addinfo = (char *) odr_malloc(odr, 50 + strlen(fname));
991 sprintf(*addinfo, "zoom: could not create %s", fname);
996 wrbuf_puts(w, "#content_proxy\n");
997 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
998 if (authentication.length())
999 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
1001 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
1003 wrbuf_printf(w, "realm: %s\n", realm.c_str());
1005 fwrite(w.buf(), 1, w.len(), file);
1007 package.log("zoom", YLOG_LOG, "content file: %s", fname);
1013 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
1014 mp::Package &package,
1015 std::string &database, int *error, char **addinfo, mp::odr &odr,
1018 bool connection_reuse = false;
1021 std::list<BackendPtr>::const_iterator map_it;
1022 if (m_backend && !m_backend->enable_explain &&
1023 m_backend->m_frontend_database == database)
1025 connection_reuse = true;
1026 proxy = m_backend->m_proxy;
1029 std::string input_args;
1030 std::string torus_db;
1031 size_t db_arg_pos = database.find(',');
1032 if (db_arg_pos != std::string::npos)
1034 torus_db = database.substr(0, db_arg_pos);
1035 input_args = database.substr(db_arg_pos + 1);
1038 torus_db = database;
1040 std::string authentication;
1041 std::string content_authentication;
1042 std::string content_proxy;
1043 std::string realm = session_realm;
1044 if (realm.length() == 0)
1045 realm = m_p->default_realm;
1047 const char *param_user = 0;
1048 const char *param_password = 0;
1049 const char *param_content_user = 0;
1050 const char *param_content_password = 0;
1051 const char *param_nocproxy = 0;
1056 int no_out_args = 0;
1057 if (input_args.length())
1058 no_parms = yaz_uri_to_array(input_args.c_str(),
1059 odr, &names, &values);
1060 // adding 10 because we'll be adding other URL args
1061 const char **out_names = (const char **)
1062 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1063 const char **out_values = (const char **)
1064 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1066 // may be changed if it's a content connection
1067 std::string torus_url = m_p->torus_searchable_url;
1069 for (i = 0; i < no_parms; i++)
1071 const char *name = names[i];
1072 const char *value = values[i];
1075 if (!strcmp(name, "user"))
1077 else if (!strcmp(name, "password"))
1078 param_password = value;
1079 else if (!strcmp(name, "content-user"))
1080 param_content_user = value;
1081 else if (!strcmp(name, "content-password"))
1082 param_content_password = value;
1083 else if (!strcmp(name, "content-proxy"))
1084 content_proxy = value;
1085 else if (!strcmp(name, "nocproxy"))
1086 param_nocproxy = value;
1087 else if (!strcmp(name, "proxy"))
1091 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1092 if (connection_reuse)
1094 // find the step after our current proxy
1096 for (i = 0; i < dnum; i++)
1097 if (!strcmp(proxy.c_str(), dstr[i]))
1102 *proxy_step = i + 1;
1106 // step is known.. Guess our proxy from it
1107 if (*proxy_step >= dnum)
1111 proxy = dstr[*proxy_step];
1114 if (*proxy_step == dnum)
1119 else if (!strcmp(name, "cproxysession"))
1121 out_names[no_out_args] = name;
1122 out_values[no_out_args++] = value;
1123 torus_url = m_p->torus_content_url;
1125 else if (!strcmp(name, "realm") && session_realm.length() == 0)
1127 else if (!strcmp(name, "torus_url") && session_realm.length() == 0)
1129 else if (name[0] == 'x' && name[1] == '-')
1131 out_names[no_out_args] = name;
1132 out_values[no_out_args++] = value;
1136 BackendPtr notfound;
1137 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1138 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1139 sprintf(msg, "zoom: bad database argument: %s", name);
1145 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1147 if (connection_reuse)
1149 m_backend->connect("", error, addinfo, odr);
1155 authentication = std::string(param_user);
1157 authentication += "/" + std::string(param_password);
1159 if (param_content_user)
1161 content_authentication = std::string(param_content_user);
1162 if (param_content_password)
1163 content_authentication += "/" + std::string(param_content_password);
1166 if (torus_db.compare("IR-Explain---1") == 0)
1167 return explain_search(package, database, error, addinfo, odr, torus_url,
1172 std::map<std::string,SearchablePtr>::iterator it;
1173 it = m_p->s_map.find(torus_db);
1174 if (it != m_p->s_map.end())
1176 else if (torus_url.length() > 0)
1178 std::string torus_query = "udb==" + torus_db;
1179 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1184 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1185 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1186 "incorrectly configured");
1190 const xmlNode *ptr = xmlDocGetRootElement(doc);
1191 if (ptr && ptr->type == XML_ELEMENT_NODE)
1193 if (!strcmp((const char *) ptr->name, "record"))
1195 sptr = m_p->parse_torus_record(ptr);
1197 else if (!strcmp((const char *) ptr->name, "records"))
1199 for (ptr = ptr->children; ptr; ptr = ptr->next)
1201 if (ptr->type == XML_ELEMENT_NODE
1202 && !strcmp((const char *) ptr->name, "record"))
1206 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1208 odr_malloc(odr, 40 + torus_db.length());
1209 sprintf(*addinfo, "multiple records for udb=%s",
1215 sptr = m_p->parse_torus_record(ptr);
1221 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1222 *addinfo = (char*) odr_malloc(
1223 odr, 40 + strlen((const char *) ptr->name));
1224 sprintf(*addinfo, "bad root element for torus: %s", ptr->name);
1235 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1236 *addinfo = odr_strdup(odr, torus_db.c_str());
1241 xsltStylesheetPtr xsp = 0;
1242 if (sptr->transform_xsl_content.length())
1244 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1245 sptr->transform_xsl_content.length());
1248 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1249 *addinfo = odr_strdup(odr, "zoom: xmlParseMemory failed "
1250 "for literalTransform XSL");
1254 xsp = xsltParseStylesheetDoc(xsp_doc);
1257 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1259 odr_strdup(odr,"zoom: xsltParseStylesheetDoc failed "
1260 "for literalTransform XSL");
1262 xmlFreeDoc(xsp_doc);
1266 else if (sptr->transform_xsl_fname.length())
1268 const char *path = 0;
1270 if (m_p->xsldir.length())
1271 path = m_p->xsldir.c_str();
1273 path = m_p->file_path.c_str();
1276 char fullpath[1024];
1277 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1283 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1285 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1286 sprintf(*addinfo, "zoom: could not open file %s",
1287 sptr->transform_xsl_fname.c_str());
1291 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1294 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1295 *addinfo = (char *) odr_malloc(odr, 50 + fname.length());
1296 sprintf(*addinfo, "zoom: xmlParseFile failed for file %s",
1301 xsp = xsltParseStylesheetDoc(xsp_doc);
1304 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1305 *addinfo = (char *) odr_malloc(odr, 50 + fname.length());
1306 sprintf(*addinfo, "zoom: xsltParseStylesheetDoc failed "
1307 "for file %s", fname.c_str());
1309 xmlFreeDoc(xsp_doc);
1314 cql_transform_t cqlt = 0;
1315 if (sptr->rpn2cql_fname.length())
1317 char fullpath[1024];
1318 char *cp = yaz_filepath_resolve(sptr->rpn2cql_fname.c_str(),
1319 m_p->file_path.c_str(), 0, fullpath);
1321 cqlt = cql_transform_open_fname(fullpath);
1324 cqlt = cql_transform_create();
1328 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1329 *addinfo = odr_strdup(odr, "zoom: missing/invalid cql2rpn file");
1331 xsltFreeStylesheet(xsp);
1337 BackendPtr b(new Backend);
1342 b->m_frontend_database = database;
1343 b->enable_cproxy = param_nocproxy ? false : true;
1345 if (sptr->query_encoding.length())
1346 b->set_option("rpnCharset", sptr->query_encoding);
1348 if (sptr->extraArgs.length())
1349 b->set_option("extraArgs", sptr->extraArgs);
1351 b->set_option("timeout", m_p->zoom_timeout.c_str());
1354 b->set_option("apdulog", "1");
1356 if (sptr->piggyback && sptr->sru.length())
1357 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1358 maximumRecords > 0 */
1359 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1361 if (authentication.length() == 0)
1362 authentication = sptr->authentication;
1364 if (proxy.length() == 0)
1365 proxy = sptr->cfProxy;
1368 if (sptr->cfAuth.length())
1371 b->set_option("user", sptr->cfAuth);
1372 if (authentication.length())
1374 size_t found = authentication.find('/');
1375 if (found != std::string::npos)
1377 out_names[no_out_args] = "user";
1378 out_values[no_out_args++] =
1379 odr_strdup(odr, authentication.substr(0, found).c_str());
1381 out_names[no_out_args] = "password";
1382 out_values[no_out_args++] =
1383 odr_strdup(odr, authentication.substr(found+1).c_str());
1387 out_names[no_out_args] = "user";
1388 out_values[no_out_args++] =
1389 odr_strdup(odr, authentication.c_str());
1394 out_names[no_out_args] = "proxy";
1395 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1397 if (sptr->cfSubDB.length())
1399 out_names[no_out_args] = "subdatabase";
1400 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1404 out_names[no_out_args] = "nocproxy";
1405 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1410 size_t found = authentication.find('/');
1412 if (sptr->sru.length() && found != std::string::npos)
1414 b->set_option("user", authentication.substr(0, found));
1415 b->set_option("password", authentication.substr(found+1));
1418 b->set_option("user", authentication);
1421 b->set_option("proxy", proxy);
1424 if (sptr->sru.length())
1426 url = "http://" + sptr->target;
1427 b->set_option("sru", sptr->sru);
1429 if (sptr->sru_version.length())
1430 b->set_option("sru_version", sptr->sru_version);
1439 out_names[no_out_args] = 0; // terminate list
1441 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1442 (char **) out_values);
1443 url += "," + std::string(x_args);
1445 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1446 b->connect(url, error, addinfo, odr);
1447 if (*error == 0 && b->enable_cproxy)
1448 create_content_session(package, b, error, addinfo, odr,
1449 content_authentication.length() ?
1450 content_authentication : authentication,
1451 content_proxy.length() ? content_proxy : proxy,
1458 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1459 Odr_oid *preferredRecordSyntax,
1460 const char *element_set_name,
1461 bool &enable_pz2_retrieval,
1462 bool &enable_pz2_transform,
1463 bool &enable_record_transform,
1464 bool &assume_marc8_charset)
1466 char oid_name_str[OID_STR_MAX];
1467 const char *syntax_name = 0;
1469 if (preferredRecordSyntax &&
1470 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1472 if (element_set_name &&
1473 !strcmp(element_set_name, m_p->element_transform.c_str()))
1475 enable_pz2_retrieval = true;
1476 enable_pz2_transform = true;
1478 else if (element_set_name &&
1479 !strcmp(element_set_name, m_p->element_raw.c_str()))
1481 enable_pz2_retrieval = true;
1483 else if (m_p->record_xsp)
1485 enable_pz2_retrieval = true;
1486 enable_pz2_transform = true;
1487 enable_record_transform = true;
1491 if (enable_pz2_retrieval)
1493 std::string configured_request_syntax = b->sptr->request_syntax;
1494 if (configured_request_syntax.length())
1496 syntax_name = configured_request_syntax.c_str();
1497 const Odr_oid *syntax_oid =
1498 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1499 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1500 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1501 assume_marc8_charset = true;
1504 else if (preferredRecordSyntax)
1506 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1508 if (b->sptr->sru.length())
1509 syntax_name = "XML";
1511 b->set_option("preferredRecordSyntax", syntax_name);
1513 if (enable_pz2_retrieval)
1515 if (element_set_name && !strcmp(element_set_name,
1516 m_p->element_passthru.c_str()))
1520 element_set_name = 0;
1521 if (b->sptr->element_set.length())
1522 element_set_name = b->sptr->element_set.c_str();
1526 b->set_option("elementSetName", element_set_name);
1527 if (b->sptr->sru.length() && element_set_name)
1528 b->set_option("schema", element_set_name);
1531 Z_Records *yf::Zoom::Frontend::get_explain_records(
1532 mp::Package &package,
1534 Odr_int number_to_present,
1537 Odr_int *number_of_records_returned,
1540 Odr_oid *preferredRecordSyntax,
1541 const char *element_set_name)
1544 Z_Records *records = 0;
1546 if (!b->explain_doc)
1550 if (number_to_present > 10000)
1551 number_to_present = 10000;
1553 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1555 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1556 odr_malloc(odr, sizeof(*npl));
1557 npl->records = (Z_NamePlusRecord **)
1558 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1560 for (i = 0; i < number_to_present; i++)
1563 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1566 xmlBufferPtr xml_buf = xmlBufferCreate();
1567 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1568 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1570 Z_NamePlusRecord *npr =
1571 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1572 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1573 npr->which = Z_NamePlusRecord_databaseRecord;
1574 npr->u.databaseRecord =
1575 z_ext_record_xml(odr,
1576 (const char *) xml_buf->content, xml_buf->use);
1577 npl->records[i] = npr;
1578 xmlFreeNode(tmp_node);
1579 xmlBufferFree(xml_buf);
1581 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1582 records->which = Z_Records_DBOSD;
1583 records->u.databaseOrSurDiagnostics = npl;
1585 npl->num_records = i;
1586 *number_of_records_returned = i;
1591 Z_Records *yf::Zoom::Frontend::get_records(mp::Package &package,
1593 Odr_int number_to_present,
1596 Odr_int *number_of_records_returned,
1599 Odr_oid *preferredRecordSyntax,
1600 const char *element_set_name)
1602 *number_of_records_returned = 0;
1603 Z_Records *records = 0;
1604 bool enable_pz2_retrieval = false; // whether target profile is used
1605 bool enable_pz2_transform = false; // whether XSLT is used as well
1606 bool assume_marc8_charset = false;
1607 bool enable_record_transform = false;
1609 prepare_elements(b, preferredRecordSyntax,
1611 enable_pz2_retrieval,
1612 enable_pz2_transform,
1613 enable_record_transform,
1614 assume_marc8_charset);
1616 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1617 enable_pz2_retrieval ? "yes" : "no",
1618 enable_pz2_transform ? "yes" : "no");
1620 if (start < 0 || number_to_present <=0)
1623 if (number_to_present > 10000)
1624 number_to_present = 10000;
1626 ZOOM_record *recs = (ZOOM_record *)
1627 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1629 b->present(start, number_to_present, recs, error, addinfo, odr);
1634 for (i = 0; i < number_to_present; i++)
1639 { // only return records if no error and at least one record
1641 const char *xsl_parms[3];
1642 mp::wrbuf cproxy_host;
1644 if (b->enable_cproxy && b->cproxy_host.length())
1646 wrbuf_puts(cproxy_host, "\"");
1647 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1648 wrbuf_puts(cproxy_host, "/\"");
1650 xsl_parms[0] = "cproxyhost";
1651 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1659 char *odr_database = odr_strdup(odr,
1660 b->m_frontend_database.c_str());
1661 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1662 odr_malloc(odr, sizeof(*npl));
1663 *number_of_records_returned = i;
1664 npl->num_records = i;
1665 npl->records = (Z_NamePlusRecord **)
1666 odr_malloc(odr, i * sizeof(*npl->records));
1667 for (i = 0; i < number_to_present; i++)
1669 Z_NamePlusRecord *npr = 0;
1670 const char *addinfo;
1672 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1673 &addinfo, 0 /* diagset */);
1677 log_diagnostic(package, sur_error, addinfo);
1678 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1681 else if (enable_pz2_retrieval)
1683 char rec_type_str[100];
1684 const char *record_encoding = 0;
1686 if (b->sptr->record_encoding.length())
1687 record_encoding = b->sptr->record_encoding.c_str();
1688 else if (assume_marc8_charset)
1689 record_encoding = "marc8";
1691 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1692 if (record_encoding)
1694 strcat(rec_type_str, "; charset=");
1695 strcat(rec_type_str, record_encoding);
1698 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1701 xmlChar *xmlrec_buf = 0;
1702 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1704 if (!rec_buf && !npr)
1706 std::string addinfo("ZOOM_record_get failed for type ");
1708 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1709 addinfo += rec_type_str;
1710 log_diagnostic(package, error, addinfo.c_str());
1711 npr = zget_surrogateDiagRec(odr, odr_database,
1712 error, addinfo.c_str());
1716 package.log_write(rec_buf, rec_len);
1717 package.log_write("\r\n", 2);
1720 if (rec_buf && b->xsp && enable_pz2_transform)
1722 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1725 const char *addinfo = "xml parse failed for record";
1726 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1727 log_diagnostic(package, error, addinfo);
1728 npr = zget_surrogateDiagRec(
1729 odr, odr_database, error, addinfo);
1733 // first stage XSLT - per target
1734 xsltStylesheetPtr xsp = b->xsp;
1735 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1737 // insert generated-url
1741 mp::xml::url_recipe_handle(rec_res,
1742 b->sptr->urlRecipe);
1745 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1746 while (ptr && ptr->type != XML_ELEMENT_NODE)
1749 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1750 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1752 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1756 // second stage XSLT - common
1757 if (rec_res && m_p->record_xsp &&
1758 enable_record_transform)
1760 xmlDoc *tmp_doc = rec_res;
1762 xsp = m_p->record_xsp;
1763 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1765 xmlFreeDoc(tmp_doc);
1767 // get result out of it
1770 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1772 rec_buf = (const char *) xmlrec_buf;
1773 package.log_write(rec_buf, rec_len);
1775 xmlFreeDoc(rec_res);
1779 std::string addinfo;
1781 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1783 addinfo = "xslt apply failed for "
1784 + b->sptr->transform_xsl_fname;
1785 log_diagnostic(package, error, addinfo.c_str());
1786 npr = zget_surrogateDiagRec(
1787 odr, odr_database, error, addinfo.c_str());
1789 xmlFreeDoc(rec_doc);
1796 npr = zget_surrogateDiagRec(
1798 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1802 npr = (Z_NamePlusRecord *)
1803 odr_malloc(odr, sizeof(*npr));
1804 npr->databaseName = odr_database;
1805 npr->which = Z_NamePlusRecord_databaseRecord;
1806 npr->u.databaseRecord =
1807 z_ext_record_xml(odr, rec_buf, rec_len);
1811 xmlFree(xmlrec_buf);
1816 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1819 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1820 npr->databaseName = odr_database;
1821 npr->which = Z_NamePlusRecord_databaseRecord;
1822 npr->u.databaseRecord = ext;
1826 npr = zget_surrogateDiagRec(
1828 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1829 "ZOOM_record, type ext");
1832 npl->records[i] = npr;
1834 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1835 records->which = Z_Records_DBOSD;
1836 records->u.databaseOrSurDiagnostics = npl;
1841 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1844 struct cql_node *r = 0;
1852 std::map<std::string,std::string>::const_iterator it;
1853 it = fieldmap.find(cn->u.st.index);
1854 if (it == fieldmap.end())
1856 if (it->second.length())
1857 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1863 r = convert_cql_fields(cn->u.boolean.left, odr);
1865 r = convert_cql_fields(cn->u.boolean.right, odr);
1868 r = convert_cql_fields(cn->u.sort.search, odr);
1874 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1875 int error, const char *addinfo)
1877 const char *err_msg = yaz_diag_bib1_str(error);
1879 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1880 error, err_msg, addinfo);
1882 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1886 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1887 std::string &database,
1891 std::string torus_url,
1892 std::string &torus_db,
1897 BackendPtr b(new Backend);
1899 b->m_frontend_database = database;
1900 b->enable_explain = true;
1902 Z_GDU *gdu = package.request().get();
1903 Z_APDU *apdu_req = gdu->u.z3950;
1904 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1905 Z_Query *query = sr->query;
1907 if (!m_p->explain_xsp)
1909 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1911 odr_strdup(odr, "IR-Explain---1 unsupported. "
1912 "Torus explain_xsl not defined");
1915 else if (query->which == Z_Query_type_104 &&
1916 query->u.type_104->which == Z_External_CQL)
1918 std::string torus_query(query->u.type_104->u.cql);
1919 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1922 if (m_p->explain_xsp)
1924 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1931 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1932 *addinfo = odr_strdup(odr, "Torus server unavailable or "
1933 "incorrectly configured");
1937 xmlNode *ptr = xmlDocGetRootElement(doc);
1940 xml_node_search(ptr, &hits, 0);
1942 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1943 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1944 package.response() = apdu_res;
1948 xmlFreeDoc(b->explain_doc);
1949 b->explain_doc = doc;
1954 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1955 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1960 static bool wait_conn(COMSTACK cs, int secs)
1962 struct yaz_poll_fd pfd;
1964 yaz_poll_add(pfd.input_mask, yaz_poll_except);
1965 if (cs->io_pending && CS_WANT_WRITE)
1966 yaz_poll_add(pfd.input_mask, yaz_poll_write);
1967 if (cs->io_pending & CS_WANT_READ)
1968 yaz_poll_add(pfd.input_mask, yaz_poll_read);
1970 pfd.fd = cs_fileno(cs);
1971 pfd.client_data = 0;
1973 int ret = yaz_poll(&pfd, 1, secs, 0);
1977 bool yf::Zoom::Impl::check_proxy(const char *proxy)
1980 const char *uri = "http://localhost/";
1983 bool outcome = false;
1984 conn = cs_create_host_proxy(uri, 0, &add, proxy);
1989 Z_GDU *gdu = z_get_HTTP_Request_uri(odr, uri, 0, 1);
1990 gdu->u.HTTP_Request->method = odr_strdup(odr, "GET");
1992 if (z_GDU(odr, &gdu, 0, 0))
1995 char *buf = odr_getbuf(odr, &len, 0);
1997 int ret = cs_connect(conn, add);
1998 if (ret > 0 || (ret == 0 && wait_conn(conn, 1)))
2002 ret = cs_put(conn, buf, len);
2005 if (!wait_conn(conn, proxy_timeout))
2016 bool yf::Zoom::Frontend::retry(mp::Package &package,
2019 int &error, char **addinfo,
2020 int &proxy_step, int &same_retries,
2023 if (b && b->m_proxy.length() && !m_p->check_proxy(b->m_proxy.c_str()))
2025 log_diagnostic(package, error, *addinfo);
2026 package.log("zoom", YLOG_LOG, "proxy %s fails", b->m_proxy.c_str());
2028 if (proxy_step) // there is a failover
2031 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2034 error = YAZ_BIB1_PROXY_FAILURE;
2035 *addinfo = odr_strdup(odr, b->m_proxy.c_str());
2037 else if (same_retries == 0 && proxy_retries == 0)
2039 log_diagnostic(package, error, *addinfo);
2041 package.log("zoom", YLOG_WARN, "search failed: retry");
2049 void yf::Zoom::Frontend::handle_search(mp::Package &package)
2051 Z_GDU *gdu = package.request().get();
2052 Z_APDU *apdu_req = gdu->u.z3950;
2053 Z_APDU *apdu_res = 0;
2055 Z_SearchRequest *sr = apdu_req->u.searchRequest;
2056 if (sr->num_databaseNames != 1)
2058 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
2059 log_diagnostic(package, error, 0);
2060 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
2061 package.response() = apdu_res;
2065 int same_retries = 0;
2066 int proxy_retries = 0;
2072 std::string db(sr->databaseNames[0]);
2074 BackendPtr b = get_backend_from_databases(package, db, &error,
2075 &addinfo, odr, &proxy_step);
2078 if (retry(package, odr, b, error, &addinfo, proxy_step,
2079 same_retries, proxy_retries))
2084 log_diagnostic(package, error, addinfo);
2085 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2086 package.response() = apdu_res;
2089 if (!b || b->enable_explain)
2092 b->set_option("setname", "default");
2094 bool enable_pz2_retrieval = false;
2095 bool enable_pz2_transform = false;
2096 bool enable_record_transform = false;
2097 bool assume_marc8_charset = false;
2098 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
2099 enable_pz2_retrieval,
2100 enable_pz2_transform,
2101 enable_record_transform,
2102 assume_marc8_charset);
2105 Z_Query *query = sr->query;
2106 mp::wrbuf ccl_wrbuf;
2107 mp::wrbuf pqf_wrbuf;
2108 std::string sortkeys;
2110 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
2113 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
2115 else if (query->which == Z_Query_type_2)
2118 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
2119 query->u.type_2->len);
2121 else if (query->which == Z_Query_type_104 &&
2122 query->u.type_104->which == Z_External_CQL)
2125 const char *cql = query->u.type_104->u.cql;
2126 CQL_parser cp = cql_parser_create();
2127 int r = cql_parser_string(cp, cql);
2128 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
2131 cql_parser_destroy(cp);
2132 error = YAZ_BIB1_MALFORMED_QUERY;
2133 const char *addinfo = "CQL syntax error";
2134 log_diagnostic(package, error, addinfo);
2136 odr.create_searchResponse(apdu_req, error, addinfo);
2137 package.response() = apdu_res;
2140 struct cql_node *cn = cql_parser_result(cp);
2141 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
2144 // hopefully we are getting a ptr to a index+relation+term node
2145 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
2147 if (cn_error->which == CQL_NODE_ST)
2148 addinfo = cn_error->u.st.index;
2150 log_diagnostic(package, error, addinfo);
2151 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2152 package.response() = apdu_res;
2153 cql_parser_destroy(cp);
2156 r = cql_to_ccl(cn, wrbuf_vp_puts, ccl_wrbuf);
2159 error = YAZ_BIB1_MALFORMED_QUERY;
2160 const char *addinfo = "CQL to CCL conversion error";
2162 log_diagnostic(package, error, addinfo);
2163 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2164 package.response() = apdu_res;
2165 cql_parser_destroy(cp);
2169 mp::wrbuf sru_sortkeys_wrbuf;
2170 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
2172 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
2173 const char *addinfo = "CQL to CCL sortby conversion";
2175 log_diagnostic(package, error, addinfo);
2176 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2177 package.response() = apdu_res;
2178 cql_parser_destroy(cp);
2181 mp::wrbuf sort_spec_wrbuf;
2182 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
2184 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
2185 yaz_tok_parse_t tp =
2186 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
2187 yaz_tok_cfg_destroy(tc);
2189 /* go through sortspec and map fields */
2190 int token = yaz_tok_move(tp);
2191 while (token != YAZ_TOK_EOF)
2193 if (token == YAZ_TOK_STRING)
2195 const char *field = yaz_tok_parse_string(tp);
2196 std::map<std::string,std::string>::iterator it;
2197 it = b->sptr->sortmap.find(field);
2198 if (it != b->sptr->sortmap.end())
2199 sortkeys += it->second;
2204 token = yaz_tok_move(tp);
2205 if (token == YAZ_TOK_STRING)
2207 sortkeys += yaz_tok_parse_string(tp);
2209 if (token != YAZ_TOK_EOF)
2212 token = yaz_tok_move(tp);
2215 yaz_tok_parse_destroy(tp);
2216 cql_parser_destroy(cp);
2220 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
2221 const char *addinfo = 0;
2222 log_diagnostic(package, error, addinfo);
2223 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2224 package.response() = apdu_res;
2228 if (ccl_wrbuf.len())
2231 assert(pqf_wrbuf.len() == 0);
2233 struct ccl_rpn_node *cn;
2234 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2235 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2239 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2240 error = YAZ_BIB1_MALFORMED_QUERY;
2244 case CCL_ERR_UNKNOWN_QUAL:
2245 case CCL_ERR_TRUNC_NOT_LEFT:
2246 case CCL_ERR_TRUNC_NOT_RIGHT:
2247 case CCL_ERR_TRUNC_NOT_BOTH:
2248 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2249 case CCL_ERR_TRUNC_NOT_EMBED:
2251 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2252 case CCL_ERR_TRUNC_NOT_SINGLE:
2254 error = YAZ_BIB1_UNSUPP_SEARCH;
2257 log_diagnostic(package, error, addinfo);
2258 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2259 package.response() = apdu_res;
2262 ccl_pquery(pqf_wrbuf, cn);
2263 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2267 assert(pqf_wrbuf.len());
2269 ZOOM_query q = ZOOM_query_create();
2270 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2272 if (b->get_option("sru"))
2276 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2279 if (!strcmp(b->get_option("sru"), "solr"))
2281 solr_transform_t cqlt = solr_transform_create();
2283 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2285 solr_transform_close(cqlt);
2289 status = cql_transform_rpn2cql_wrbuf(b->cqlt, wrb, zquery);
2293 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2294 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2295 b->search(q, &hits, &error, &addinfo, odr);
2297 ZOOM_query_destroy(q);
2301 error = YAZ_BIB1_MALFORMED_QUERY;
2302 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2303 log_diagnostic(package, error, addinfo);
2304 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2305 package.response() = apdu_res;
2311 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2312 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2313 b->search(q, &hits, &error, &addinfo, odr);
2314 ZOOM_query_destroy(q);
2319 if (retry(package, odr, b, error, &addinfo, proxy_step,
2320 same_retries, proxy_retries))
2324 const char *element_set_name = 0;
2325 Odr_int number_to_present = 0;
2327 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2329 Odr_int number_of_records_returned = 0;
2330 Z_Records *records = get_records(
2332 0, number_to_present, &error, &addinfo,
2333 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2336 log_diagnostic(package, error, addinfo);
2337 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2340 apdu_res->u.searchResponse->records = records;
2341 apdu_res->u.searchResponse->numberOfRecordsReturned =
2342 odr_intdup(odr, number_of_records_returned);
2344 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2345 package.response() = apdu_res;
2348 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2350 Z_GDU *gdu = package.request().get();
2351 Z_APDU *apdu_req = gdu->u.z3950;
2352 Z_APDU *apdu_res = 0;
2353 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2358 package.response() = odr.create_presentResponse(
2359 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2362 const char *element_set_name = 0;
2363 Z_RecordComposition *comp = pr->recordComposition;
2364 if (comp && comp->which != Z_RecordComp_simple)
2366 package.response() = odr.create_presentResponse(
2368 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2371 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2372 element_set_name = comp->u.simple->u.generic;
2373 Odr_int number_of_records_returned = 0;
2377 if (m_backend->enable_explain)
2379 Z_Records *records =
2380 get_explain_records(
2382 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2383 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2384 pr->preferredRecordSyntax, element_set_name);
2386 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2389 apdu_res->u.presentResponse->records = records;
2390 apdu_res->u.presentResponse->numberOfRecordsReturned =
2391 odr_intdup(odr, number_of_records_returned);
2393 package.response() = apdu_res;
2397 Z_Records *records =
2398 get_records(package,
2399 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2400 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2401 pr->preferredRecordSyntax, element_set_name);
2403 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2406 apdu_res->u.presentResponse->records = records;
2407 apdu_res->u.presentResponse->numberOfRecordsReturned =
2408 odr_intdup(odr, number_of_records_returned);
2410 package.response() = apdu_res;
2414 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2416 Z_GDU *gdu = package.request().get();
2419 else if (gdu->which == Z_GDU_Z3950)
2421 Z_APDU *apdu_req = gdu->u.z3950;
2424 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2425 if (apdu_req->which == Z_APDU_initRequest)
2428 package.response() = odr.create_close(
2430 Z_Close_protocolError,
2433 else if (apdu_req->which == Z_APDU_searchRequest)
2435 handle_search(package);
2437 else if (apdu_req->which == Z_APDU_presentRequest)
2439 handle_present(package);
2444 package.response() = odr.create_close(
2446 Z_Close_protocolError,
2447 "zoom filter cannot handle this APDU");
2448 package.session().close();
2452 WRBUF w = m_backend->m_apdu_wrbuf;
2453 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2458 package.session().close();
2462 std::string escape_cql_term(std::string inp)
2465 size_t l = inp.length();
2467 for (i = 0; i < l; i++)
2469 if (strchr("*?^\"", inp[i]))
2476 void yf::Zoom::Frontend::auth(mp::Package &package, Z_InitRequest *req,
2477 int *error, char **addinfo, ODR odr)
2479 if (m_p->torus_auth_url.length() == 0)
2483 std::string password;
2484 if (req->idAuthentication)
2486 Z_IdAuthentication *auth = req->idAuthentication;
2487 switch (auth->which)
2489 case Z_IdAuthentication_open:
2492 const char *cp = strchr(auth->u.open, '/');
2495 user.assign(auth->u.open, cp - auth->u.open);
2496 password.assign(cp + 1);
2500 case Z_IdAuthentication_idPass:
2501 if (auth->u.idPass->userId)
2502 user.assign(auth->u.idPass->userId);
2503 if (auth->u.idPass->password)
2504 password.assign(auth->u.idPass->password);
2509 std::string ip = package.origin().get_address();
2510 yaz_log(YLOG_LOG, "IP=%s", ip.c_str());
2512 std::string torus_query;
2515 if (user.length() && password.length())
2517 torus_query = "userName==\"" + escape_cql_term(user) +
2518 "\" and password==\"" + escape_cql_term(password) + "\"";
2519 failure_code = YAZ_BIB1_INIT_AC_BAD_USERID_AND_OR_PASSWORD;
2523 const char *ip_cstr = ip.c_str();
2524 const char *cp = strchr(ip_cstr, ':');
2528 torus_query = "ip encloses/net.ipaddress \"";
2529 torus_query += escape_cql_term(std::string(ip_cstr));
2530 torus_query += "\"";
2531 failure_code = YAZ_BIB1_INIT_AC_BLOCKED_NETWORK_ADDRESS;
2534 std::string dummy_db;
2535 std::string dummy_realm;
2536 xmlDoc *doc = mp::get_searchable(package, m_p->torus_auth_url, dummy_db,
2537 torus_query, dummy_realm, m_p->proxy);
2540 // something fundamental broken in lookup.
2541 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2542 *addinfo = odr_strdup(odr, "zoom: torus server unavailable or "
2543 "incorrectly configured.");
2546 const xmlNode *ptr = xmlDocGetRootElement(doc);
2547 if (ptr && ptr->type == XML_ELEMENT_NODE)
2549 if (strcmp((const char *) ptr->name, "records") == 0)
2551 ptr = ptr->children;
2552 while (ptr && ptr->type != XML_ELEMENT_NODE)
2555 if (ptr && strcmp((const char *) ptr->name, "record") == 0)
2557 ptr = ptr->children;
2558 while (ptr && ptr->type != XML_ELEMENT_NODE)
2561 if (ptr && strcmp((const char *) ptr->name, "layer") == 0)
2563 ptr = ptr->children;
2564 while (ptr && ptr->type != XML_ELEMENT_NODE)
2569 if (ptr && ptr->type == XML_ELEMENT_NODE &&
2570 !strcmp((const char *) ptr->name, "identityId"))
2577 *error = failure_code;
2580 session_realm = mp::xml::get_text(ptr);
2583 void yf::Zoom::Impl::process(mp::Package &package)
2585 FrontendPtr f = get_frontend(package);
2586 Z_GDU *gdu = package.request().get();
2588 if (f->m_is_virtual)
2590 f->handle_package(package);
2592 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2595 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2596 f->m_init_gdu = gdu;
2599 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2600 Z_InitResponse *resp = apdu->u.initResponse;
2603 static const int masks[] = {
2608 for (i = 0; masks[i] != -1; i++)
2609 if (ODR_MASK_GET(req->options, masks[i]))
2610 ODR_MASK_SET(resp->options, masks[i]);
2612 static const int versions[] = {
2613 Z_ProtocolVersion_1,
2614 Z_ProtocolVersion_2,
2615 Z_ProtocolVersion_3,
2618 for (i = 0; versions[i] != -1; i++)
2619 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2620 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2624 *resp->preferredMessageSize = *req->preferredMessageSize;
2625 *resp->maximumRecordSize = *req->maximumRecordSize;
2629 f->auth(package, req, &error, &addinfo, odr);
2632 resp->userInformationField =
2633 zget_init_diagnostics(odr, error, addinfo);
2635 package.session().close();
2638 f->m_is_virtual = true;
2639 package.response() = apdu;
2644 release_frontend(package);
2648 static mp::filter::Base* filter_creator()
2650 return new mp::filter::Zoom;
2654 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2665 * c-file-style: "Stroustrup"
2666 * indent-tabs-mode: nil
2668 * vim: shiftwidth=4 tabstop=8 expandtab