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>
29 #include <libxslt/xsltutils.h>
30 #include <libxslt/transform.h>
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
35 #include <yaz/yaz-version.h>
36 #include <yaz/tpath.h>
38 #include <yaz/ccl_xml.h>
40 #include <yaz/rpn2cql.h>
41 #include <yaz/rpn2solr.h>
42 #include <yaz/pquery.h>
44 #include <yaz/oid_db.h>
45 #include <yaz/diagbib1.h>
48 #include <yaz/querytowrbuf.h>
49 #include <yaz/sortspec.h>
50 #include <yaz/tokenizer.h>
53 namespace mp = metaproxy_1;
54 namespace yf = mp::filter;
56 namespace metaproxy_1 {
58 class Zoom::Searchable : boost::noncopyable {
60 std::string authentication;
66 std::string query_encoding;
68 std::string sru_version;
69 std::string request_syntax;
70 std::string element_set;
71 std::string record_encoding;
72 std::string transform_xsl_fname;
73 std::string transform_xsl_content;
74 std::string urlRecipe;
75 std::string contentConnector;
76 std::string sortStrategy;
79 CCL_bibset ccl_bibset;
80 std::map<std::string, std::string> sortmap;
81 Searchable(CCL_bibset base);
84 class Zoom::Backend : boost::noncopyable {
86 friend class Frontend;
88 mp::wrbuf m_apdu_wrbuf;
89 ZOOM_connection m_connection;
90 ZOOM_resultset m_resultset;
91 std::string m_frontend_database;
93 xsltStylesheetPtr xsp;
94 std::string cproxy_host;
101 void connect(std::string zurl, int *error, char **addinfo,
103 void search(ZOOM_query q, Odr_int *hits,
104 int *error, char **addinfo, ODR odr);
105 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
106 int *error, char **addinfo, ODR odr);
107 void set_option(const char *name, const char *value);
108 void set_option(const char *name, std::string value);
109 const char *get_option(const char *name);
110 void get_zoom_error(int *error, char **addinfo, ODR odr);
112 class Zoom::Frontend : boost::noncopyable {
117 yazpp_1::GDU m_init_gdu;
118 BackendPtr m_backend;
119 void handle_package(mp::Package &package);
120 void handle_search(mp::Package &package);
122 BackendPtr explain_search(mp::Package &package,
123 std::string &database,
127 std::string &torus_db,
129 void handle_present(mp::Package &package);
130 BackendPtr get_backend_from_databases(mp::Package &package,
131 std::string &database,
137 bool create_content_session(mp::Package &package,
142 std::string authentication,
146 void prepare_elements(BackendPtr b,
147 Odr_oid *preferredRecordSyntax,
148 const char *element_set_name,
149 bool &enable_pz2_retrieval,
150 bool &enable_pz2_transform,
151 bool &enable_record_transform,
152 bool &assume_marc8_charset);
154 Z_Records *get_records(Package &package,
156 Odr_int number_to_present,
159 Odr_int *number_of_records_returned,
160 ODR odr, BackendPtr b,
161 Odr_oid *preferredRecordSyntax,
162 const char *element_set_name);
163 Z_Records *get_explain_records(Package &package,
165 Odr_int number_to_present,
168 Odr_int *number_of_records_returned,
169 ODR odr, BackendPtr b,
170 Odr_oid *preferredRecordSyntax,
171 const char *element_set_name);
173 void log_diagnostic(mp::Package &package,
174 int error, const char *addinfo);
176 Frontend(Impl *impl);
180 friend class Frontend;
184 void process(metaproxy_1::Package & package);
185 void configure(const xmlNode * ptr, bool test_only,
188 void configure_local_records(const xmlNode * ptr, bool test_only);
189 FrontendPtr get_frontend(mp::Package &package);
190 void release_frontend(mp::Package &package);
191 SearchablePtr parse_torus_record(const xmlNode *ptr);
192 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
193 std::map<mp::Session, FrontendPtr> m_clients;
194 boost::mutex m_mutex;
195 boost::condition m_cond_session_ready;
196 std::string torus_searchable_url;
197 std::string torus_content_url;
198 std::string default_realm;
199 std::map<std::string,std::string> fieldmap;
201 std::string file_path;
202 std::string content_proxy_server;
203 std::string content_tmp_file;
204 std::string content_config_file;
207 std::string element_transform;
208 std::string element_raw;
210 xsltStylesheetPtr explain_xsp;
211 xsltStylesheetPtr record_xsp;
212 std::map<std::string,SearchablePtr> s_map;
213 std::string zoom_timeout;
219 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
223 if (ptr->type == XML_ELEMENT_NODE &&
224 !strcmp((const char *) ptr->name, "recordData"))
230 else // else: we don't want to find nested nodes
232 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
241 // define Pimpl wrapper forwarding to Impl
243 yf::Zoom::Zoom() : m_p(new Impl)
248 { // must have a destructor because of boost::scoped_ptr
251 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
254 m_p->configure(xmlnode, test_only, path);
257 void yf::Zoom::process(mp::Package &package) const
259 m_p->process(package);
263 // define Implementation stuff
265 yf::Zoom::Backend::Backend()
267 m_connection = ZOOM_connection_create(0);
268 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
271 enable_cproxy = true;
272 enable_explain = false;
276 yf::Zoom::Backend::~Backend()
279 xsltFreeStylesheet(xsp);
281 xmlFreeDoc(explain_doc);
282 ZOOM_connection_destroy(m_connection);
283 ZOOM_resultset_destroy(m_resultset);
287 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
291 const char *zoom_addinfo = 0;
292 const char *dset = 0;
293 int error0 = ZOOM_connection_error_x(m_connection, &msg,
294 &zoom_addinfo, &dset);
300 if (!strcmp(dset, "info:srw/diagnostic/1"))
301 *error = yaz_diag_srw_to_bib1(error0);
302 else if (!strcmp(dset, "Bib-1"))
305 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
307 *addinfo = (char *) odr_malloc(
308 odr, 30 + strlen(dset) + strlen(msg) +
309 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
311 if (zoom_addinfo && *zoom_addinfo)
313 strcpy(*addinfo, zoom_addinfo);
314 strcat(*addinfo, " ");
316 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
320 void yf::Zoom::Backend::connect(std::string zurl,
321 int *error, char **addinfo,
324 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
325 get_zoom_error(error, addinfo, odr);
328 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
329 int *error, char **addinfo, ODR odr)
331 ZOOM_resultset_destroy(m_resultset);
332 m_resultset = ZOOM_connection_search(m_connection, q);
333 get_zoom_error(error, addinfo, odr);
335 *hits = ZOOM_resultset_size(m_resultset);
340 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
342 int *error, char **addinfo, ODR odr)
344 ZOOM_resultset_records(m_resultset, recs, start, number);
345 get_zoom_error(error, addinfo, odr);
348 void yf::Zoom::Backend::set_option(const char *name, const char *value)
350 ZOOM_connection_option_set(m_connection, name, value);
352 ZOOM_resultset_option_set(m_resultset, name, value);
355 void yf::Zoom::Backend::set_option(const char *name, std::string value)
357 set_option(name, value.c_str());
360 const char *yf::Zoom::Backend::get_option(const char *name)
362 return ZOOM_connection_option_get(m_connection, name);
365 yf::Zoom::Searchable::Searchable(CCL_bibset base)
368 use_turbomarc = true;
369 sortStrategy = "embed";
370 ccl_bibset = ccl_qual_dup(base);
373 yf::Zoom::Searchable::~Searchable()
375 ccl_qual_rm(&ccl_bibset);
378 yf::Zoom::Frontend::Frontend(Impl *impl) :
379 m_p(impl), m_is_virtual(false), m_in_use(true)
383 yf::Zoom::Frontend::~Frontend()
387 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
389 boost::mutex::scoped_lock lock(m_mutex);
391 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
395 it = m_clients.find(package.session());
396 if (it == m_clients.end())
399 if (!it->second->m_in_use)
401 it->second->m_in_use = true;
404 m_cond_session_ready.wait(lock);
406 FrontendPtr f(new Frontend(this));
407 m_clients[package.session()] = f;
412 void yf::Zoom::Impl::release_frontend(mp::Package &package)
414 boost::mutex::scoped_lock lock(m_mutex);
415 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
417 it = m_clients.find(package.session());
418 if (it != m_clients.end())
420 if (package.session().is_closed())
426 it->second->m_in_use = false;
428 m_cond_session_ready.notify_all();
432 yf::Zoom::Impl::Impl() :
433 apdu_log(false), element_transform("pz2") , element_raw("raw"),
436 bibset = ccl_qual_mk();
440 srand((unsigned int) time(0));
443 yf::Zoom::Impl::~Impl()
446 xsltFreeStylesheet(explain_xsp);
447 ccl_qual_rm(&bibset);
450 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
452 Zoom::SearchablePtr s(new Searchable(bibset));
454 for (ptr = ptr->children; ptr; ptr = ptr->next)
456 if (ptr->type != XML_ELEMENT_NODE)
458 if (!strcmp((const char *) ptr->name, "layer"))
460 else if (!strcmp((const char *) ptr->name,
463 s->authentication = mp::xml::get_text(ptr);
465 else if (!strcmp((const char *) ptr->name,
468 s->cfAuth = mp::xml::get_text(ptr);
470 else if (!strcmp((const char *) ptr->name,
473 s->cfProxy = mp::xml::get_text(ptr);
475 else if (!strcmp((const char *) ptr->name,
478 s->cfSubDB = mp::xml::get_text(ptr);
480 else if (!strcmp((const char *) ptr->name,
483 s->contentConnector = mp::xml::get_text(ptr);
485 else if (!strcmp((const char *) ptr->name, "udb"))
487 s->udb = mp::xml::get_text(ptr);
489 else if (!strcmp((const char *) ptr->name, "zurl"))
491 s->target = mp::xml::get_text(ptr);
493 else if (!strcmp((const char *) ptr->name, "sru"))
495 s->sru = mp::xml::get_text(ptr);
497 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
498 !strcmp((const char *) ptr->name, "sruVersion"))
500 s->sru_version = mp::xml::get_text(ptr);
502 else if (!strcmp((const char *) ptr->name,
505 s->query_encoding = mp::xml::get_text(ptr);
507 else if (!strcmp((const char *) ptr->name,
510 s->piggyback = mp::xml::get_bool(ptr, true);
512 else if (!strcmp((const char *) ptr->name,
515 s->request_syntax = mp::xml::get_text(ptr);
517 else if (!strcmp((const char *) ptr->name,
520 s->element_set = mp::xml::get_text(ptr);
522 else if (!strcmp((const char *) ptr->name,
525 s->record_encoding = mp::xml::get_text(ptr);
527 else if (!strcmp((const char *) ptr->name,
530 s->transform_xsl_fname = mp::xml::get_text(ptr);
532 else if (!strcmp((const char *) ptr->name,
535 s->transform_xsl_content = mp::xml::get_text(ptr);
537 else if (!strcmp((const char *) ptr->name,
540 s->urlRecipe = mp::xml::get_text(ptr);
542 else if (!strcmp((const char *) ptr->name,
545 ; // useTurboMarc is ignored
547 else if (!strncmp((const char *) ptr->name,
550 std::string value = mp::xml::get_text(ptr);
551 if (value.length() > 0)
553 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
554 (const char *) ptr->name + 7);
557 else if (!strncmp((const char *) ptr->name,
560 std::string value = mp::xml::get_text(ptr);
561 s->sortmap[(const char *) ptr->name + 8] = value;
563 else if (!strcmp((const char *) ptr->name,
566 s->sortStrategy = mp::xml::get_text(ptr);
572 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
574 while (ptr && ptr->type != XML_ELEMENT_NODE)
579 if (!strcmp((const char *) ptr->name, "records"))
581 for (ptr = ptr->children; ptr; ptr = ptr->next)
583 if (ptr->type != XML_ELEMENT_NODE)
585 if (!strcmp((const char *) ptr->name, "record"))
587 SearchablePtr s = parse_torus_record(ptr);
590 std::string udb = s->udb;
595 throw mp::filter::FilterException
596 ("No udb for local torus record");
602 throw mp::filter::FilterException
604 + std::string((const char *) ptr->name)
605 + " in zoom filter inside element "
612 throw mp::filter::FilterException
614 + std::string((const char *) ptr->name)
615 + " in zoom filter inside element <torus>");
620 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
623 std::string explain_xslt_fname;
624 std::string record_xslt_fname;
630 for (ptr = ptr->children; ptr; ptr = ptr->next)
632 if (ptr->type != XML_ELEMENT_NODE)
634 else if (!strcmp((const char *) ptr->name, "torus"))
636 const struct _xmlAttr *attr;
637 for (attr = ptr->properties; attr; attr = attr->next)
639 if (!strcmp((const char *) attr->name, "url"))
640 torus_searchable_url = mp::xml::get_text(attr->children);
641 else if (!strcmp((const char *) attr->name, "content_url"))
642 torus_content_url = mp::xml::get_text(attr->children);
643 else if (!strcmp((const char *) attr->name, "realm"))
644 default_realm = mp::xml::get_text(attr->children);
645 else if (!strcmp((const char *) attr->name, "xsldir"))
646 xsldir = mp::xml::get_text(attr->children);
647 else if (!strcmp((const char *) attr->name, "element_transform"))
648 element_transform = mp::xml::get_text(attr->children);
649 else if (!strcmp((const char *) attr->name, "element_raw"))
650 element_raw = mp::xml::get_text(attr->children);
651 else if (!strcmp((const char *) attr->name, "proxy"))
652 proxy = mp::xml::get_text(attr->children);
653 else if (!strcmp((const char *) attr->name, "explain_xsl"))
654 explain_xslt_fname = mp::xml::get_text(attr->children);
655 else if (!strcmp((const char *) attr->name, "record_xsl"))
656 record_xslt_fname = mp::xml::get_text(attr->children);
658 throw mp::filter::FilterException(
659 "Bad attribute " + std::string((const char *)
662 // If content_url is not given, use value of searchable, to
663 // ensure backwards compatibility
664 if (!torus_content_url.length())
665 torus_content_url = torus_searchable_url;
666 configure_local_records(ptr->children, test_only);
668 else if (!strcmp((const char *) ptr->name, "cclmap"))
670 const char *addinfo = 0;
671 ccl_xml_config(bibset, ptr, &addinfo);
673 else if (!strcmp((const char *) ptr->name, "fieldmap"))
675 const struct _xmlAttr *attr;
676 std::string ccl_field;
677 std::string cql_field;
678 for (attr = ptr->properties; attr; attr = attr->next)
680 if (!strcmp((const char *) attr->name, "ccl"))
681 ccl_field = mp::xml::get_text(attr->children);
682 else if (!strcmp((const char *) attr->name, "cql"))
683 cql_field = mp::xml::get_text(attr->children);
685 throw mp::filter::FilterException(
686 "Bad attribute " + std::string((const char *)
689 if (cql_field.length())
690 fieldmap[cql_field] = ccl_field;
692 else if (!strcmp((const char *) ptr->name, "contentProxy"))
694 const struct _xmlAttr *attr;
695 for (attr = ptr->properties; attr; attr = attr->next)
697 if (!strcmp((const char *) attr->name, "server"))
700 "contentProxy's server attribute is deprecated");
702 "Specify config_file instead. For example:");
704 " content_file=\"/etc/cf-proxy/cproxy.cfg\"");
705 content_proxy_server = mp::xml::get_text(attr->children);
707 else if (!strcmp((const char *) attr->name, "tmp_file"))
708 content_tmp_file = mp::xml::get_text(attr->children);
709 else if (!strcmp((const char *) attr->name, "config_file"))
710 content_config_file = mp::xml::get_text(attr->children);
712 throw mp::filter::FilterException(
713 "Bad attribute " + std::string((const char *)
717 else if (!strcmp((const char *) ptr->name, "log"))
719 const struct _xmlAttr *attr;
720 for (attr = ptr->properties; attr; attr = attr->next)
722 if (!strcmp((const char *) attr->name, "apdu"))
723 apdu_log = mp::xml::get_bool(attr->children, false);
725 throw mp::filter::FilterException(
726 "Bad attribute " + std::string((const char *)
730 else if (!strcmp((const char *) ptr->name, "zoom"))
732 const struct _xmlAttr *attr;
733 for (attr = ptr->properties; attr; attr = attr->next)
735 if (!strcmp((const char *) attr->name, "timeout"))
736 zoom_timeout = mp::xml::get_text(attr->children);
738 throw mp::filter::FilterException(
739 "Bad attribute " + std::string((const char *)
745 throw mp::filter::FilterException
747 + std::string((const char *) ptr->name)
748 + " in zoom filter");
752 if (explain_xslt_fname.length())
754 const char *path = 0;
757 path = xsldir.c_str();
759 path = file_path.c_str();
762 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
766 throw mp::filter::FilterException
767 ("Cannot read XSLT " + explain_xslt_fname);
770 xmlDoc *xsp_doc = xmlParseFile(cp);
773 throw mp::filter::FilterException
774 ("Cannot parse XSLT " + explain_xslt_fname);
777 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
781 throw mp::filter::FilterException
782 ("Cannot parse XSLT " + explain_xslt_fname);
787 if (record_xslt_fname.length())
789 const char *path = 0;
792 path = xsldir.c_str();
794 path = file_path.c_str();
797 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
801 throw mp::filter::FilterException
802 ("Cannot read XSLT " + record_xslt_fname);
805 xmlDoc *xsp_doc = xmlParseFile(cp);
808 throw mp::filter::FilterException
809 ("Cannot parse XSLT " + record_xslt_fname);
812 record_xsp = xsltParseStylesheetDoc(xsp_doc);
816 throw mp::filter::FilterException
817 ("Cannot parse XSLT " + record_xslt_fname);
823 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
825 int *error, char **addinfo,
827 std::string authentication,
831 if (b->sptr->contentConnector.length())
833 std::string proxyhostname;
834 std::string tmp_file;
835 bool legacy_format = false;
837 if (m_p->content_proxy_server.length())
839 proxyhostname = m_p->content_proxy_server;
840 legacy_format = true;
843 if (m_p->content_tmp_file.length())
844 tmp_file = m_p->content_tmp_file;
846 if (m_p->content_config_file.length())
848 FILE *inf = fopen(m_p->content_config_file.c_str(), "r");
852 while (fgets(buf, sizeof(buf)-1, inf))
855 cp = strchr(buf, '#');
858 cp = strchr(buf, '\n');
861 cp = strchr(buf, ':');
865 while (cp1 != buf && cp1[-1] == ' ')
871 if (!strcmp(buf, "proxyhostname"))
873 if (!strcmp(buf, "sessiondir") && *cp)
875 if (cp[strlen(cp)-1] == '/')
876 cp[strlen(cp)-1] = '\0';
877 tmp_file = std::string(cp) + std::string("/cf.XXXXXX.p");
885 package.log("zoom", YLOG_WARN|YLOG_ERRNO,
886 "unable to open content config %s",
887 m_p->content_config_file.c_str());
888 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
889 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
890 sprintf(*addinfo, "unable to open content config %s",
891 m_p->content_config_file.c_str());
896 if (proxyhostname.length() == 0)
898 package.log("zoom", YLOG_WARN, "no proxyhostname");
901 if (tmp_file.length() == 0)
903 package.log("zoom", YLOG_WARN, "no tmp_file");
907 char *fname = xstrdup(tmp_file.c_str());
908 char *xx = strstr(fname, "XXXXXX");
911 package.log("zoom", YLOG_WARN, "bad tmp_file %s", tmp_file.c_str());
912 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
913 *addinfo = (char *) odr_malloc(odr, 60 + tmp_file.length());
914 sprintf(*addinfo, "bad format of content tmp_file: %s",
919 char tmp_char = xx[6];
920 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
922 b->cproxy_host = std::string(xx) + "." + proxyhostname;
924 b->cproxy_host = proxyhostname + "/" + xx;
927 FILE *file = fopen(fname, "w");
930 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
931 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
932 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
933 sprintf(*addinfo, "Could not create %s", fname);
938 wrbuf_puts(w, "#content_proxy\n");
939 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
940 if (authentication.length())
941 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
943 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
945 wrbuf_printf(w, "realm: %s\n", realm.c_str());
947 fwrite(w.buf(), 1, w.len(), file);
949 package.log("zoom", YLOG_LOG, "content file: %s", fname);
955 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
956 mp::Package &package,
957 std::string &database, int *error, char **addinfo, mp::odr &odr,
960 std::list<BackendPtr>::const_iterator map_it;
961 if (m_backend && !m_backend->enable_explain &&
962 m_backend->m_frontend_database == database)
964 m_backend->connect("", error, addinfo, odr);
968 std::string input_args;
969 std::string torus_db;
970 size_t db_arg_pos = database.find(',');
971 if (db_arg_pos != std::string::npos)
973 torus_db = database.substr(0, db_arg_pos);
974 input_args = database.substr(db_arg_pos + 1);
979 std::string authentication;
980 std::string content_authentication;
982 std::string content_proxy;
983 std::string realm = m_p->default_realm;
985 const char *param_user = 0;
986 const char *param_password = 0;
987 const char *param_content_user = 0;
988 const char *param_content_password = 0;
989 const char *param_nocproxy = 0;
995 if (input_args.length())
996 no_parms = yaz_uri_to_array(input_args.c_str(),
997 odr, &names, &values);
998 // adding 10 because we'll be adding other URL args
999 const char **out_names = (const char **)
1000 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
1001 const char **out_values = (const char **)
1002 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
1004 // may be changed if it's a content connection
1005 std::string torus_url = m_p->torus_searchable_url;
1007 for (i = 0; i < no_parms; i++)
1009 const char *name = names[i];
1010 const char *value = values[i];
1013 if (!strcmp(name, "user"))
1015 else if (!strcmp(name, "password"))
1016 param_password = value;
1017 else if (!strcmp(name, "content-user"))
1018 param_content_user = value;
1019 else if (!strcmp(name, "content-password"))
1020 param_content_password = value;
1021 else if (!strcmp(name, "content-proxy"))
1022 content_proxy = value;
1023 else if (!strcmp(name, "nocproxy"))
1024 param_nocproxy = value;
1025 else if (!strcmp(name, "proxy"))
1029 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
1030 if (*proxy_step >= dnum)
1034 proxy = dstr[*proxy_step];
1037 if (*proxy_step == dnum)
1041 else if (!strcmp(name, "cproxysession"))
1043 out_names[no_out_args] = name;
1044 out_values[no_out_args++] = value;
1045 torus_url = m_p->torus_content_url;
1047 else if (!strcmp(name, "realm"))
1049 else if (name[0] == 'x' && name[1] == '-')
1051 out_names[no_out_args] = name;
1052 out_values[no_out_args++] = value;
1056 BackendPtr notfound;
1057 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
1058 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1059 sprintf(msg, "Bad database argument: %s", name);
1066 authentication = std::string(param_user);
1068 authentication += "/" + std::string(param_password);
1070 if (param_content_user)
1072 content_authentication = std::string(param_content_user);
1073 if (param_content_password)
1074 content_authentication += "/" + std::string(param_content_password);
1077 if (torus_db.compare("IR-Explain---1") == 0)
1078 return explain_search(package, database, error, addinfo, odr, torus_db,
1083 std::map<std::string,SearchablePtr>::iterator it;
1084 it = m_p->s_map.find(torus_db);
1085 if (it != m_p->s_map.end())
1087 else if (torus_url.length() > 0)
1089 std::string torus_query = "udb==" + torus_db;
1090 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1095 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1096 *addinfo = odr_strdup(odr, torus_db.c_str());
1100 const xmlNode *ptr = xmlDocGetRootElement(doc);
1102 { // presumably ptr is a records element node
1103 // parse first record in document
1104 for (ptr = ptr->children; ptr; ptr = ptr->next)
1106 if (ptr->type == XML_ELEMENT_NODE
1107 && !strcmp((const char *) ptr->name, "record"))
1111 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1112 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1113 sprintf(*addinfo, "multiple records for udb=%s",
1119 sptr = m_p->parse_torus_record(ptr);
1128 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1129 *addinfo = odr_strdup(odr, torus_db.c_str());
1134 xsltStylesheetPtr xsp = 0;
1135 if (sptr->transform_xsl_content.length())
1137 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1138 sptr->transform_xsl_content.length());
1141 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1142 *addinfo = (char *) odr_malloc(odr, 40);
1143 sprintf(*addinfo, "xmlParseMemory failed");
1147 xsp = xsltParseStylesheetDoc(xsp_doc);
1150 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1151 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1153 xmlFreeDoc(xsp_doc);
1157 else if (sptr->transform_xsl_fname.length())
1159 const char *path = 0;
1161 if (m_p->xsldir.length())
1162 path = m_p->xsldir.c_str();
1164 path = m_p->file_path.c_str();
1167 char fullpath[1024];
1168 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1174 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1176 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1177 sprintf(*addinfo, "File could not be read: %s",
1178 sptr->transform_xsl_fname.c_str());
1182 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1185 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1186 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1187 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1191 xsp = xsltParseStylesheetDoc(xsp_doc);
1194 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1195 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1197 xmlFreeDoc(xsp_doc);
1204 BackendPtr b(new Backend);
1208 b->m_frontend_database = database;
1209 b->enable_cproxy = param_nocproxy ? false : true;
1211 if (sptr->query_encoding.length())
1212 b->set_option("rpnCharset", sptr->query_encoding);
1214 b->set_option("timeout", m_p->zoom_timeout.c_str());
1217 b->set_option("apdulog", "1");
1219 if (sptr->piggyback && sptr->sru.length())
1220 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1221 maximumRecords > 0 */
1222 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1224 if (authentication.length() == 0)
1225 authentication = sptr->authentication;
1227 if (proxy.length() == 0)
1228 proxy = sptr->cfProxy;
1230 if (sptr->cfAuth.length())
1233 b->set_option("user", sptr->cfAuth);
1234 if (authentication.length())
1236 size_t found = authentication.find('/');
1237 if (found != std::string::npos)
1239 out_names[no_out_args] = "user";
1240 out_values[no_out_args++] =
1241 odr_strdup(odr, authentication.substr(0, found).c_str());
1243 out_names[no_out_args] = "password";
1244 out_values[no_out_args++] =
1245 odr_strdup(odr, authentication.substr(found+1).c_str());
1249 out_names[no_out_args] = "user";
1250 out_values[no_out_args++] =
1251 odr_strdup(odr, authentication.c_str());
1256 out_names[no_out_args] = "proxy";
1257 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1259 if (sptr->cfSubDB.length())
1261 out_names[no_out_args] = "subdatabase";
1262 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1266 out_names[no_out_args] = "nocproxy";
1267 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1272 size_t found = authentication.find('/');
1274 if (sptr->sru.length() && found != std::string::npos)
1276 b->set_option("user", authentication.substr(0, found));
1277 b->set_option("password", authentication.substr(found+1));
1280 b->set_option("user", authentication);
1283 b->set_option("proxy", proxy);
1286 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1289 if (sptr->sru.length())
1291 url = "http://" + sptr->target;
1292 b->set_option("sru", sptr->sru);
1294 if (sptr->sru_version.length())
1295 b->set_option("sru_version", sptr->sru_version);
1304 out_names[no_out_args] = 0; // terminate list
1306 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1307 (char **) out_values);
1308 url += "," + std::string(x_args);
1310 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1311 b->connect(url, error, addinfo, odr);
1312 if (*error == 0 && b->enable_cproxy)
1313 create_content_session(package, b, error, addinfo, odr,
1314 content_authentication.length() ?
1315 content_authentication : authentication,
1316 content_proxy.length() ? content_proxy : proxy,
1323 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1324 Odr_oid *preferredRecordSyntax,
1325 const char *element_set_name,
1326 bool &enable_pz2_retrieval,
1327 bool &enable_pz2_transform,
1328 bool &enable_record_transform,
1329 bool &assume_marc8_charset)
1331 char oid_name_str[OID_STR_MAX];
1332 const char *syntax_name = 0;
1334 if (preferredRecordSyntax &&
1335 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1337 if (element_set_name &&
1338 !strcmp(element_set_name, m_p->element_transform.c_str()))
1340 enable_pz2_retrieval = true;
1341 enable_pz2_transform = true;
1343 else if (element_set_name &&
1344 !strcmp(element_set_name, m_p->element_raw.c_str()))
1346 enable_pz2_retrieval = true;
1348 else if (m_p->record_xsp)
1350 enable_pz2_retrieval = true;
1351 enable_pz2_transform = true;
1352 enable_record_transform = true;
1356 if (enable_pz2_retrieval)
1358 std::string configured_request_syntax = b->sptr->request_syntax;
1359 if (configured_request_syntax.length())
1361 syntax_name = configured_request_syntax.c_str();
1362 const Odr_oid *syntax_oid =
1363 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1364 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1365 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1366 assume_marc8_charset = true;
1369 else if (preferredRecordSyntax)
1371 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1373 if (b->sptr->sru.length())
1374 syntax_name = "XML";
1376 b->set_option("preferredRecordSyntax", syntax_name);
1378 if (enable_pz2_retrieval)
1380 element_set_name = 0;
1381 if (b->sptr->element_set.length())
1382 element_set_name = b->sptr->element_set.c_str();
1385 b->set_option("elementSetName", element_set_name);
1386 if (b->sptr->sru.length() && element_set_name)
1387 b->set_option("schema", element_set_name);
1390 Z_Records *yf::Zoom::Frontend::get_explain_records(
1393 Odr_int number_to_present,
1396 Odr_int *number_of_records_returned,
1399 Odr_oid *preferredRecordSyntax,
1400 const char *element_set_name)
1403 Z_Records *records = 0;
1405 if (!b->explain_doc)
1409 if (number_to_present > 10000)
1410 number_to_present = 10000;
1412 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1414 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1415 odr_malloc(odr, sizeof(*npl));
1416 npl->records = (Z_NamePlusRecord **)
1417 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1419 for (i = 0; i < number_to_present; i++)
1422 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1425 xmlBufferPtr xml_buf = xmlBufferCreate();
1426 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1427 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1429 Z_NamePlusRecord *npr =
1430 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1431 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1432 npr->which = Z_NamePlusRecord_databaseRecord;
1433 npr->u.databaseRecord =
1434 z_ext_record_xml(odr,
1435 (const char *) xml_buf->content, xml_buf->use);
1436 npl->records[i] = npr;
1437 xmlFreeNode(tmp_node);
1438 xmlBufferFree(xml_buf);
1440 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1441 records->which = Z_Records_DBOSD;
1442 records->u.databaseOrSurDiagnostics = npl;
1444 npl->num_records = i;
1445 *number_of_records_returned = i;
1450 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
1452 Odr_int number_to_present,
1455 Odr_int *number_of_records_returned,
1458 Odr_oid *preferredRecordSyntax,
1459 const char *element_set_name)
1461 *number_of_records_returned = 0;
1462 Z_Records *records = 0;
1463 bool enable_pz2_retrieval = false; // whether target profile is used
1464 bool enable_pz2_transform = false; // whether XSLT is used as well
1465 bool assume_marc8_charset = false;
1466 bool enable_record_transform = false;
1468 prepare_elements(b, preferredRecordSyntax,
1470 enable_pz2_retrieval,
1471 enable_pz2_transform,
1472 enable_record_transform,
1473 assume_marc8_charset);
1475 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1476 enable_pz2_retrieval ? "yes" : "no",
1477 enable_pz2_transform ? "yes" : "no");
1479 if (start < 0 || number_to_present <=0)
1482 if (number_to_present > 10000)
1483 number_to_present = 10000;
1485 ZOOM_record *recs = (ZOOM_record *)
1486 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1488 b->present(start, number_to_present, recs, error, addinfo, odr);
1493 for (i = 0; i < number_to_present; i++)
1498 { // only return records if no error and at least one record
1500 const char *xsl_parms[3];
1501 mp::wrbuf cproxy_host;
1503 if (b->enable_cproxy && b->cproxy_host.length())
1505 wrbuf_puts(cproxy_host, "\"");
1506 wrbuf_puts(cproxy_host, b->cproxy_host.c_str());
1507 wrbuf_puts(cproxy_host, "/\"");
1509 xsl_parms[0] = "cproxyhost";
1510 xsl_parms[1] = wrbuf_cstr(cproxy_host);
1518 char *odr_database = odr_strdup(odr,
1519 b->m_frontend_database.c_str());
1520 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1521 odr_malloc(odr, sizeof(*npl));
1522 *number_of_records_returned = i;
1523 npl->num_records = i;
1524 npl->records = (Z_NamePlusRecord **)
1525 odr_malloc(odr, i * sizeof(*npl->records));
1526 for (i = 0; i < number_to_present; i++)
1528 Z_NamePlusRecord *npr = 0;
1529 const char *addinfo;
1531 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1532 &addinfo, 0 /* diagset */);
1536 log_diagnostic(package, sur_error, addinfo);
1537 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1540 else if (enable_pz2_retrieval)
1542 char rec_type_str[100];
1543 const char *record_encoding = 0;
1545 if (b->sptr->record_encoding.length())
1546 record_encoding = b->sptr->record_encoding.c_str();
1547 else if (assume_marc8_charset)
1548 record_encoding = "marc8";
1550 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1551 if (record_encoding)
1553 strcat(rec_type_str, "; charset=");
1554 strcat(rec_type_str, record_encoding);
1557 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1560 xmlChar *xmlrec_buf = 0;
1561 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1563 if (!rec_buf && !npr)
1565 std::string addinfo("ZOOM_record_get failed for type ");
1567 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1568 addinfo += rec_type_str;
1569 log_diagnostic(package, error, addinfo.c_str());
1570 npr = zget_surrogateDiagRec(odr, odr_database,
1571 error, addinfo.c_str());
1575 package.log_write(rec_buf, rec_len);
1576 package.log_write("\r\n", 2);
1579 if (rec_buf && b->xsp && enable_pz2_transform)
1581 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1584 const char *addinfo = "xml parse failed for record";
1585 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1586 log_diagnostic(package, error, addinfo);
1587 npr = zget_surrogateDiagRec(
1588 odr, odr_database, error, addinfo);
1592 // first stage XSLT - per target
1593 xsltStylesheetPtr xsp = b->xsp;
1594 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1596 // insert generated-url
1600 mp::xml::url_recipe_handle(rec_res,
1601 b->sptr->urlRecipe);
1604 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1605 while (ptr && ptr->type != XML_ELEMENT_NODE)
1608 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1609 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1611 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1615 // second stage XSLT - common
1616 if (rec_res && m_p->record_xsp &&
1617 enable_record_transform)
1619 xmlDoc *tmp_doc = rec_res;
1621 xsp = m_p->record_xsp;
1622 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1624 xmlFreeDoc(tmp_doc);
1626 // get result out of it
1629 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1631 rec_buf = (const char *) xmlrec_buf;
1632 package.log_write(rec_buf, rec_len);
1634 xmlFreeDoc(rec_res);
1638 std::string addinfo;
1640 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1642 addinfo = "xslt apply failed for "
1643 + b->sptr->transform_xsl_fname;
1644 log_diagnostic(package, error, addinfo.c_str());
1645 npr = zget_surrogateDiagRec(
1646 odr, odr_database, error, addinfo.c_str());
1648 xmlFreeDoc(rec_doc);
1655 npr = zget_surrogateDiagRec(
1657 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1661 npr = (Z_NamePlusRecord *)
1662 odr_malloc(odr, sizeof(*npr));
1663 npr->databaseName = odr_database;
1664 npr->which = Z_NamePlusRecord_databaseRecord;
1665 npr->u.databaseRecord =
1666 z_ext_record_xml(odr, rec_buf, rec_len);
1670 xmlFree(xmlrec_buf);
1675 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1678 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1679 npr->databaseName = odr_database;
1680 npr->which = Z_NamePlusRecord_databaseRecord;
1681 npr->u.databaseRecord = ext;
1685 npr = zget_surrogateDiagRec(
1687 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1688 "ZOOM_record, type ext");
1691 npl->records[i] = npr;
1693 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1694 records->which = Z_Records_DBOSD;
1695 records->u.databaseOrSurDiagnostics = npl;
1700 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1703 struct cql_node *r = 0;
1711 std::map<std::string,std::string>::const_iterator it;
1712 it = fieldmap.find(cn->u.st.index);
1713 if (it == fieldmap.end())
1715 if (it->second.length())
1716 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1722 r = convert_cql_fields(cn->u.boolean.left, odr);
1724 r = convert_cql_fields(cn->u.boolean.right, odr);
1727 r = convert_cql_fields(cn->u.sort.search, odr);
1733 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1734 int error, const char *addinfo)
1736 const char *err_msg = yaz_diag_bib1_str(error);
1738 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1739 error, err_msg, addinfo);
1741 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1745 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1746 std::string &database,
1750 std::string &torus_db,
1755 BackendPtr b(new Backend);
1757 b->m_frontend_database = database;
1758 b->enable_explain = true;
1760 Z_GDU *gdu = package.request().get();
1761 Z_APDU *apdu_req = gdu->u.z3950;
1762 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1763 Z_Query *query = sr->query;
1765 if (!m_p->explain_xsp)
1767 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1769 odr_strdup(odr, "IR-Explain---1 unsupported. "
1770 "Torus explain_xsl not defined");
1773 else if (query->which == Z_Query_type_104 &&
1774 query->u.type_104->which == Z_External_CQL)
1776 std::string torus_url = m_p->torus_searchable_url;
1777 std::string torus_query(query->u.type_104->u.cql);
1778 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1781 if (m_p->explain_xsp)
1783 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1790 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1791 *addinfo = odr_strdup(odr, "IR-Explain---1 problem. "
1792 "Could not obtain Torus records for Explain");
1796 xmlNode *ptr = xmlDocGetRootElement(doc);
1799 xml_node_search(ptr, &hits, 0);
1801 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1802 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1803 package.response() = apdu_res;
1807 xmlFreeDoc(b->explain_doc);
1808 b->explain_doc = doc;
1813 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1814 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1819 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1821 Z_GDU *gdu = package.request().get();
1822 Z_APDU *apdu_req = gdu->u.z3950;
1823 Z_APDU *apdu_res = 0;
1825 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1826 if (sr->num_databaseNames != 1)
1828 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1829 log_diagnostic(package, error, 0);
1830 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1831 package.response() = apdu_res;
1840 std::string db(sr->databaseNames[0]);
1842 BackendPtr b = get_backend_from_databases(package, db, &error,
1843 &addinfo, odr, &proxy_step);
1844 if (error && proxy_step)
1846 package.log("zoom", YLOG_WARN,
1847 "create backend failed: trying next proxy");
1852 log_diagnostic(package, error, addinfo);
1853 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1854 package.response() = apdu_res;
1857 if (!b || b->enable_explain)
1860 b->set_option("setname", "default");
1862 bool enable_pz2_retrieval = false;
1863 bool enable_pz2_transform = false;
1864 bool enable_record_transform = false;
1865 bool assume_marc8_charset = false;
1866 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1867 enable_pz2_retrieval,
1868 enable_pz2_transform,
1869 enable_record_transform,
1870 assume_marc8_charset);
1873 Z_Query *query = sr->query;
1874 mp::wrbuf ccl_wrbuf;
1875 mp::wrbuf pqf_wrbuf;
1876 std::string sortkeys;
1878 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1881 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1883 else if (query->which == Z_Query_type_2)
1886 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1887 query->u.type_2->len);
1889 else if (query->which == Z_Query_type_104 &&
1890 query->u.type_104->which == Z_External_CQL)
1893 const char *cql = query->u.type_104->u.cql;
1894 CQL_parser cp = cql_parser_create();
1895 int r = cql_parser_string(cp, cql);
1896 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1899 cql_parser_destroy(cp);
1900 error = YAZ_BIB1_MALFORMED_QUERY;
1901 const char *addinfo = "CQL syntax error";
1902 log_diagnostic(package, error, addinfo);
1904 odr.create_searchResponse(apdu_req, error, addinfo);
1905 package.response() = apdu_res;
1908 struct cql_node *cn = cql_parser_result(cp);
1909 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1912 // hopefully we are getting a ptr to a index+relation+term node
1913 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1915 if (cn_error->which == CQL_NODE_ST)
1916 addinfo = cn_error->u.st.index;
1918 log_diagnostic(package, error, addinfo);
1919 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1920 package.response() = apdu_res;
1921 cql_parser_destroy(cp);
1925 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1928 error = YAZ_BIB1_MALFORMED_QUERY;
1929 const char *addinfo = "CQL to CCL conversion error";
1931 log_diagnostic(package, error, addinfo);
1932 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1933 package.response() = apdu_res;
1934 cql_parser_destroy(cp);
1938 mp::wrbuf sru_sortkeys_wrbuf;
1939 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
1941 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
1942 const char *addinfo = "CQL to CCL sortby conversion";
1944 log_diagnostic(package, error, addinfo);
1945 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1946 package.response() = apdu_res;
1947 cql_parser_destroy(cp);
1950 mp::wrbuf sort_spec_wrbuf;
1951 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1953 wrbuf_puts(ccl_wrbuf, ccl_buf);
1955 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1956 yaz_tok_parse_t tp =
1957 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1958 yaz_tok_cfg_destroy(tc);
1960 /* go through sortspec and map fields */
1961 int token = yaz_tok_move(tp);
1962 while (token != YAZ_TOK_EOF)
1964 if (token == YAZ_TOK_STRING)
1966 const char *field = yaz_tok_parse_string(tp);
1967 std::map<std::string,std::string>::iterator it;
1968 it = b->sptr->sortmap.find(field);
1969 if (it != b->sptr->sortmap.end())
1970 sortkeys += it->second;
1975 token = yaz_tok_move(tp);
1976 if (token == YAZ_TOK_STRING)
1978 sortkeys += yaz_tok_parse_string(tp);
1980 if (token != YAZ_TOK_EOF)
1983 token = yaz_tok_move(tp);
1986 yaz_tok_parse_destroy(tp);
1987 cql_parser_destroy(cp);
1991 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1992 const char *addinfo = 0;
1993 log_diagnostic(package, error, addinfo);
1994 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1995 package.response() = apdu_res;
1999 if (ccl_wrbuf.len())
2002 assert(pqf_wrbuf.len() == 0);
2004 struct ccl_rpn_node *cn;
2005 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
2006 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
2010 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
2011 error = YAZ_BIB1_MALFORMED_QUERY;
2015 case CCL_ERR_UNKNOWN_QUAL:
2016 case CCL_ERR_TRUNC_NOT_LEFT:
2017 case CCL_ERR_TRUNC_NOT_RIGHT:
2018 case CCL_ERR_TRUNC_NOT_BOTH:
2019 #ifdef CCL_ERR_TRUNC_NOT_EMBED
2020 case CCL_ERR_TRUNC_NOT_EMBED:
2022 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
2023 case CCL_ERR_TRUNC_NOT_SINGLE:
2025 error = YAZ_BIB1_UNSUPP_SEARCH;
2028 log_diagnostic(package, error, addinfo);
2029 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2030 package.response() = apdu_res;
2033 ccl_pquery(pqf_wrbuf, cn);
2034 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
2038 assert(pqf_wrbuf.len());
2040 ZOOM_query q = ZOOM_query_create();
2041 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
2043 if (b->get_option("sru"))
2047 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
2050 if (!strcmp(b->get_option("sru"), "solr"))
2052 solr_transform_t cqlt = solr_transform_create();
2054 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
2056 solr_transform_close(cqlt);
2060 cql_transform_t cqlt = cql_transform_create();
2062 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
2064 cql_transform_close(cqlt);
2068 ZOOM_query_cql(q, wrbuf_cstr(wrb));
2069 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2070 b->search(q, &hits, &error, &addinfo, odr);
2072 ZOOM_query_destroy(q);
2076 error = YAZ_BIB1_MALFORMED_QUERY;
2077 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2078 log_diagnostic(package, error, addinfo);
2079 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2080 package.response() = apdu_res;
2086 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2087 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2088 b->search(q, &hits, &error, &addinfo, odr);
2089 ZOOM_query_destroy(q);
2092 if (error && proxy_step)
2094 // reset below prevent reuse in get_backend_from_databases
2096 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2100 const char *element_set_name = 0;
2101 Odr_int number_to_present = 0;
2103 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2105 Odr_int number_of_records_returned = 0;
2106 Z_Records *records = get_records(
2108 0, number_to_present, &error, &addinfo,
2109 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2112 log_diagnostic(package, error, addinfo);
2113 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2116 apdu_res->u.searchResponse->records = records;
2117 apdu_res->u.searchResponse->numberOfRecordsReturned =
2118 odr_intdup(odr, number_of_records_returned);
2120 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2121 package.response() = apdu_res;
2124 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2126 Z_GDU *gdu = package.request().get();
2127 Z_APDU *apdu_req = gdu->u.z3950;
2128 Z_APDU *apdu_res = 0;
2129 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2134 package.response() = odr.create_presentResponse(
2135 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2138 const char *element_set_name = 0;
2139 Z_RecordComposition *comp = pr->recordComposition;
2140 if (comp && comp->which != Z_RecordComp_simple)
2142 package.response() = odr.create_presentResponse(
2144 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2147 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2148 element_set_name = comp->u.simple->u.generic;
2149 Odr_int number_of_records_returned = 0;
2153 if (m_backend->enable_explain)
2155 Z_Records *records =
2156 get_explain_records(
2158 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2159 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2160 pr->preferredRecordSyntax, element_set_name);
2162 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2165 apdu_res->u.presentResponse->records = records;
2166 apdu_res->u.presentResponse->numberOfRecordsReturned =
2167 odr_intdup(odr, number_of_records_returned);
2169 package.response() = apdu_res;
2173 Z_Records *records =
2174 get_records(package,
2175 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2176 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2177 pr->preferredRecordSyntax, element_set_name);
2179 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2182 apdu_res->u.presentResponse->records = records;
2183 apdu_res->u.presentResponse->numberOfRecordsReturned =
2184 odr_intdup(odr, number_of_records_returned);
2186 package.response() = apdu_res;
2190 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2192 Z_GDU *gdu = package.request().get();
2195 else if (gdu->which == Z_GDU_Z3950)
2197 Z_APDU *apdu_req = gdu->u.z3950;
2200 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2201 if (apdu_req->which == Z_APDU_initRequest)
2204 package.response() = odr.create_close(
2206 Z_Close_protocolError,
2209 else if (apdu_req->which == Z_APDU_searchRequest)
2211 handle_search(package);
2213 else if (apdu_req->which == Z_APDU_presentRequest)
2215 handle_present(package);
2220 package.response() = odr.create_close(
2222 Z_Close_protocolError,
2223 "zoom filter cannot handle this APDU");
2224 package.session().close();
2228 WRBUF w = m_backend->m_apdu_wrbuf;
2229 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2234 package.session().close();
2238 void yf::Zoom::Impl::process(mp::Package &package)
2240 FrontendPtr f = get_frontend(package);
2241 Z_GDU *gdu = package.request().get();
2243 if (f->m_is_virtual)
2245 f->handle_package(package);
2247 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2250 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2251 f->m_init_gdu = gdu;
2254 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2255 Z_InitResponse *resp = apdu->u.initResponse;
2258 static const int masks[] = {
2263 for (i = 0; masks[i] != -1; i++)
2264 if (ODR_MASK_GET(req->options, masks[i]))
2265 ODR_MASK_SET(resp->options, masks[i]);
2267 static const int versions[] = {
2268 Z_ProtocolVersion_1,
2269 Z_ProtocolVersion_2,
2270 Z_ProtocolVersion_3,
2273 for (i = 0; versions[i] != -1; i++)
2274 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2275 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2279 *resp->preferredMessageSize = *req->preferredMessageSize;
2280 *resp->maximumRecordSize = *req->maximumRecordSize;
2282 package.response() = apdu;
2283 f->m_is_virtual = true;
2288 release_frontend(package);
2292 static mp::filter::Base* filter_creator()
2294 return new mp::filter::Zoom;
2298 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2309 * c-file-style: "Stroustrup"
2310 * indent-tabs-mode: nil
2312 * vim: shiftwidth=4 tabstop=8 expandtab