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;
89 ZOOM_connection m_connection;
90 ZOOM_resultset m_resultset;
91 std::string m_frontend_database;
93 xsltStylesheetPtr xsp;
94 std::string content_session_id;
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;
206 std::string element_transform;
207 std::string element_raw;
209 xsltStylesheetPtr explain_xsp;
210 xsltStylesheetPtr record_xsp;
211 std::map<std::string,SearchablePtr> s_map;
212 std::string zoom_timeout;
218 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
222 if (ptr->type == XML_ELEMENT_NODE &&
223 !strcmp((const char *) ptr->name, "recordData"))
229 else // else: we don't want to find nested nodes
231 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
240 // define Pimpl wrapper forwarding to Impl
242 yf::Zoom::Zoom() : m_p(new Impl)
247 { // must have a destructor because of boost::scoped_ptr
250 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
253 m_p->configure(xmlnode, test_only, path);
256 void yf::Zoom::process(mp::Package &package) const
258 m_p->process(package);
262 // define Implementation stuff
264 yf::Zoom::Backend::Backend()
266 m_apdu_wrbuf = wrbuf_alloc();
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);
284 wrbuf_destroy(m_apdu_wrbuf);
288 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
292 const char *zoom_addinfo = 0;
293 const char *dset = 0;
294 int error0 = ZOOM_connection_error_x(m_connection, &msg,
295 &zoom_addinfo, &dset);
301 if (!strcmp(dset, "info:srw/diagnostic/1"))
302 *error = yaz_diag_srw_to_bib1(error0);
303 else if (!strcmp(dset, "Bib-1"))
306 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
308 *addinfo = (char *) odr_malloc(
309 odr, 30 + strlen(dset) + strlen(msg) +
310 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
312 if (zoom_addinfo && *zoom_addinfo)
314 strcpy(*addinfo, zoom_addinfo);
315 strcat(*addinfo, " ");
317 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
321 void yf::Zoom::Backend::connect(std::string zurl,
322 int *error, char **addinfo,
325 ZOOM_connection_connect(m_connection, zurl.length() ? zurl.c_str() : 0, 0);
326 get_zoom_error(error, addinfo, odr);
329 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
330 int *error, char **addinfo, ODR odr)
332 ZOOM_resultset_destroy(m_resultset);
333 m_resultset = ZOOM_connection_search(m_connection, q);
334 get_zoom_error(error, addinfo, odr);
336 *hits = ZOOM_resultset_size(m_resultset);
341 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
343 int *error, char **addinfo, ODR odr)
345 ZOOM_resultset_records(m_resultset, recs, start, number);
346 get_zoom_error(error, addinfo, odr);
349 void yf::Zoom::Backend::set_option(const char *name, const char *value)
351 ZOOM_connection_option_set(m_connection, name, value);
353 ZOOM_resultset_option_set(m_resultset, name, value);
356 void yf::Zoom::Backend::set_option(const char *name, std::string value)
358 set_option(name, value.c_str());
361 const char *yf::Zoom::Backend::get_option(const char *name)
363 return ZOOM_connection_option_get(m_connection, name);
366 yf::Zoom::Searchable::Searchable(CCL_bibset base)
369 use_turbomarc = true;
370 sortStrategy = "embed";
371 ccl_bibset = ccl_qual_dup(base);
374 yf::Zoom::Searchable::~Searchable()
376 ccl_qual_rm(&ccl_bibset);
379 yf::Zoom::Frontend::Frontend(Impl *impl) :
380 m_p(impl), m_is_virtual(false), m_in_use(true)
384 yf::Zoom::Frontend::~Frontend()
388 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
390 boost::mutex::scoped_lock lock(m_mutex);
392 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
396 it = m_clients.find(package.session());
397 if (it == m_clients.end())
400 if (!it->second->m_in_use)
402 it->second->m_in_use = true;
405 m_cond_session_ready.wait(lock);
407 FrontendPtr f(new Frontend(this));
408 m_clients[package.session()] = f;
413 void yf::Zoom::Impl::release_frontend(mp::Package &package)
415 boost::mutex::scoped_lock lock(m_mutex);
416 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
418 it = m_clients.find(package.session());
419 if (it != m_clients.end())
421 if (package.session().is_closed())
427 it->second->m_in_use = false;
429 m_cond_session_ready.notify_all();
433 yf::Zoom::Impl::Impl() :
434 apdu_log(false), element_transform("pz2") , element_raw("raw"),
437 bibset = ccl_qual_mk();
441 srand((unsigned int) time(0));
444 yf::Zoom::Impl::~Impl()
447 xsltFreeStylesheet(explain_xsp);
448 ccl_qual_rm(&bibset);
451 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
453 Zoom::SearchablePtr s(new Searchable(bibset));
455 for (ptr = ptr->children; ptr; ptr = ptr->next)
457 if (ptr->type != XML_ELEMENT_NODE)
459 if (!strcmp((const char *) ptr->name, "layer"))
461 else if (!strcmp((const char *) ptr->name,
464 s->authentication = mp::xml::get_text(ptr);
466 else if (!strcmp((const char *) ptr->name,
469 s->cfAuth = mp::xml::get_text(ptr);
471 else if (!strcmp((const char *) ptr->name,
474 s->cfProxy = mp::xml::get_text(ptr);
476 else if (!strcmp((const char *) ptr->name,
479 s->cfSubDB = mp::xml::get_text(ptr);
481 else if (!strcmp((const char *) ptr->name,
484 s->contentConnector = mp::xml::get_text(ptr);
486 else if (!strcmp((const char *) ptr->name, "udb"))
488 s->udb = mp::xml::get_text(ptr);
490 else if (!strcmp((const char *) ptr->name, "zurl"))
492 s->target = mp::xml::get_text(ptr);
494 else if (!strcmp((const char *) ptr->name, "sru"))
496 s->sru = mp::xml::get_text(ptr);
498 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
499 !strcmp((const char *) ptr->name, "sruVersion"))
501 s->sru_version = mp::xml::get_text(ptr);
503 else if (!strcmp((const char *) ptr->name,
506 s->query_encoding = mp::xml::get_text(ptr);
508 else if (!strcmp((const char *) ptr->name,
511 s->piggyback = mp::xml::get_bool(ptr, true);
513 else if (!strcmp((const char *) ptr->name,
516 s->request_syntax = mp::xml::get_text(ptr);
518 else if (!strcmp((const char *) ptr->name,
521 s->element_set = mp::xml::get_text(ptr);
523 else if (!strcmp((const char *) ptr->name,
526 s->record_encoding = mp::xml::get_text(ptr);
528 else if (!strcmp((const char *) ptr->name,
531 s->transform_xsl_fname = mp::xml::get_text(ptr);
533 else if (!strcmp((const char *) ptr->name,
536 s->transform_xsl_content = mp::xml::get_text(ptr);
538 else if (!strcmp((const char *) ptr->name,
541 s->urlRecipe = mp::xml::get_text(ptr);
543 else if (!strcmp((const char *) ptr->name,
546 ; // useTurboMarc is ignored
548 else if (!strncmp((const char *) ptr->name,
551 std::string value = mp::xml::get_text(ptr);
552 if (value.length() > 0)
554 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
555 (const char *) ptr->name + 7);
558 else if (!strncmp((const char *) ptr->name,
561 std::string value = mp::xml::get_text(ptr);
562 s->sortmap[(const char *) ptr->name + 8] = value;
564 else if (!strcmp((const char *) ptr->name,
567 s->sortStrategy = mp::xml::get_text(ptr);
573 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
575 while (ptr && ptr->type != XML_ELEMENT_NODE)
580 if (!strcmp((const char *) ptr->name, "records"))
582 for (ptr = ptr->children; ptr; ptr = ptr->next)
584 if (ptr->type != XML_ELEMENT_NODE)
586 if (!strcmp((const char *) ptr->name, "record"))
588 SearchablePtr s = parse_torus_record(ptr);
591 std::string udb = s->udb;
596 throw mp::filter::FilterException
597 ("No udb for local torus record");
603 throw mp::filter::FilterException
605 + std::string((const char *) ptr->name)
606 + " in zoom filter inside element "
613 throw mp::filter::FilterException
615 + std::string((const char *) ptr->name)
616 + " in zoom filter inside element <torus>");
621 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
624 std::string explain_xslt_fname;
625 std::string record_xslt_fname;
627 content_tmp_file = "/tmp/cf.XXXXXX.p";
632 for (ptr = ptr->children; ptr; ptr = ptr->next)
634 if (ptr->type != XML_ELEMENT_NODE)
636 else if (!strcmp((const char *) ptr->name, "torus"))
638 const struct _xmlAttr *attr;
639 for (attr = ptr->properties; attr; attr = attr->next)
641 if (!strcmp((const char *) attr->name, "url"))
642 torus_searchable_url = mp::xml::get_text(attr->children);
643 else if (!strcmp((const char *) attr->name, "content_url"))
644 torus_content_url = mp::xml::get_text(attr->children);
645 else if (!strcmp((const char *) attr->name, "realm"))
646 default_realm = mp::xml::get_text(attr->children);
647 else if (!strcmp((const char *) attr->name, "xsldir"))
648 xsldir = mp::xml::get_text(attr->children);
649 else if (!strcmp((const char *) attr->name, "element_transform"))
650 element_transform = mp::xml::get_text(attr->children);
651 else if (!strcmp((const char *) attr->name, "element_raw"))
652 element_raw = mp::xml::get_text(attr->children);
653 else if (!strcmp((const char *) attr->name, "proxy"))
654 proxy = mp::xml::get_text(attr->children);
655 else if (!strcmp((const char *) attr->name, "explain_xsl"))
656 explain_xslt_fname = mp::xml::get_text(attr->children);
657 else if (!strcmp((const char *) attr->name, "record_xsl"))
658 record_xslt_fname = mp::xml::get_text(attr->children);
660 throw mp::filter::FilterException(
661 "Bad attribute " + std::string((const char *)
664 // If content_url is not given, use value of searchable, to
665 // ensure backwards compatibility
666 if (!torus_content_url.length())
667 torus_content_url = torus_searchable_url;
668 configure_local_records(ptr->children, test_only);
670 else if (!strcmp((const char *) ptr->name, "cclmap"))
672 const char *addinfo = 0;
673 ccl_xml_config(bibset, ptr, &addinfo);
675 else if (!strcmp((const char *) ptr->name, "fieldmap"))
677 const struct _xmlAttr *attr;
678 std::string ccl_field;
679 std::string cql_field;
680 for (attr = ptr->properties; attr; attr = attr->next)
682 if (!strcmp((const char *) attr->name, "ccl"))
683 ccl_field = mp::xml::get_text(attr->children);
684 else if (!strcmp((const char *) attr->name, "cql"))
685 cql_field = mp::xml::get_text(attr->children);
687 throw mp::filter::FilterException(
688 "Bad attribute " + std::string((const char *)
691 if (cql_field.length())
692 fieldmap[cql_field] = ccl_field;
694 else if (!strcmp((const char *) ptr->name, "contentProxy"))
696 const struct _xmlAttr *attr;
697 for (attr = ptr->properties; attr; attr = attr->next)
699 if (!strcmp((const char *) attr->name, "server"))
700 content_proxy_server = mp::xml::get_text(attr->children);
701 else if (!strcmp((const char *) attr->name, "tmp_file"))
702 content_tmp_file = mp::xml::get_text(attr->children);
704 throw mp::filter::FilterException(
705 "Bad attribute " + std::string((const char *)
709 else if (!strcmp((const char *) ptr->name, "log"))
711 const struct _xmlAttr *attr;
712 for (attr = ptr->properties; attr; attr = attr->next)
714 if (!strcmp((const char *) attr->name, "apdu"))
715 apdu_log = mp::xml::get_bool(attr->children, false);
717 throw mp::filter::FilterException(
718 "Bad attribute " + std::string((const char *)
722 else if (!strcmp((const char *) ptr->name, "zoom"))
724 const struct _xmlAttr *attr;
725 for (attr = ptr->properties; attr; attr = attr->next)
727 if (!strcmp((const char *) attr->name, "timeout"))
728 zoom_timeout = mp::xml::get_text(attr->children);
730 throw mp::filter::FilterException(
731 "Bad attribute " + std::string((const char *)
737 throw mp::filter::FilterException
739 + std::string((const char *) ptr->name)
740 + " in zoom filter");
744 if (explain_xslt_fname.length())
746 const char *path = 0;
749 path = xsldir.c_str();
751 path = file_path.c_str();
754 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
758 throw mp::filter::FilterException
759 ("Cannot read XSLT " + explain_xslt_fname);
762 xmlDoc *xsp_doc = xmlParseFile(cp);
765 throw mp::filter::FilterException
766 ("Cannot parse XSLT " + explain_xslt_fname);
769 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
773 throw mp::filter::FilterException
774 ("Cannot parse XSLT " + explain_xslt_fname);
779 if (record_xslt_fname.length())
781 const char *path = 0;
784 path = xsldir.c_str();
786 path = file_path.c_str();
789 char *cp = yaz_filepath_resolve(record_xslt_fname.c_str(),
793 throw mp::filter::FilterException
794 ("Cannot read XSLT " + record_xslt_fname);
797 xmlDoc *xsp_doc = xmlParseFile(cp);
800 throw mp::filter::FilterException
801 ("Cannot parse XSLT " + record_xslt_fname);
804 record_xsp = xsltParseStylesheetDoc(xsp_doc);
808 throw mp::filter::FilterException
809 ("Cannot parse XSLT " + record_xslt_fname);
815 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
817 int *error, char **addinfo,
819 std::string authentication,
823 if (b->sptr->contentConnector.length())
825 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
826 strcpy(fname, m_p->content_tmp_file.c_str());
827 char *xx = strstr(fname, "XXXXXX");
830 xx = fname + strlen(fname);
831 strcat(fname, "XXXXXX");
833 char tmp_char = xx[6];
834 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
837 FILE *file = fopen(fname, "w");
840 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
841 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
842 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
843 sprintf(*addinfo, "Could not create %s", fname);
847 b->content_session_id.assign(xx, 6);
848 WRBUF w = wrbuf_alloc();
849 wrbuf_puts(w, "#content_proxy\n");
850 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
851 if (authentication.length())
852 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
854 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
856 wrbuf_printf(w, "realm: %s\n", realm.c_str());
858 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
860 package.log("zoom", YLOG_LOG, "content file: %s", fname);
867 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
868 mp::Package &package,
869 std::string &database, int *error, char **addinfo, mp::odr &odr,
872 std::list<BackendPtr>::const_iterator map_it;
873 if (m_backend && !m_backend->enable_explain &&
874 m_backend->m_frontend_database == database)
876 m_backend->connect("", error, addinfo, odr);
880 std::string input_args;
881 std::string torus_db;
882 size_t db_arg_pos = database.find(',');
883 if (db_arg_pos != std::string::npos)
885 torus_db = database.substr(0, db_arg_pos);
886 input_args = database.substr(db_arg_pos + 1);
891 std::string authentication;
892 std::string content_authentication;
894 std::string content_proxy;
895 std::string realm = m_p->default_realm;
897 const char *param_user = 0;
898 const char *param_password = 0;
899 const char *param_content_user = 0;
900 const char *param_content_password = 0;
901 const char *param_nocproxy = 0;
907 if (input_args.length())
908 no_parms = yaz_uri_to_array(input_args.c_str(),
909 odr, &names, &values);
910 // adding 10 because we'll be adding other URL args
911 const char **out_names = (const char **)
912 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
913 const char **out_values = (const char **)
914 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
916 // may be changed if it's a content connection
917 std::string torus_url = m_p->torus_searchable_url;
919 for (i = 0; i < no_parms; i++)
921 const char *name = names[i];
922 const char *value = values[i];
925 if (!strcmp(name, "user"))
927 else if (!strcmp(name, "password"))
928 param_password = value;
929 else if (!strcmp(name, "content-user"))
930 param_content_user = value;
931 else if (!strcmp(name, "content-password"))
932 param_content_password = value;
933 else if (!strcmp(name, "content-proxy"))
934 content_proxy = value;
935 else if (!strcmp(name, "nocproxy"))
936 param_nocproxy = value;
937 else if (!strcmp(name, "proxy"))
941 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
942 if (*proxy_step >= dnum)
946 proxy = dstr[*proxy_step];
949 if (*proxy_step == dnum)
953 else if (!strcmp(name, "cproxysession"))
955 out_names[no_out_args] = name;
956 out_values[no_out_args++] = value;
957 torus_url = m_p->torus_content_url;
959 else if (!strcmp(name, "realm"))
961 else if (name[0] == 'x' && name[1] == '-')
963 out_names[no_out_args] = name;
964 out_values[no_out_args++] = value;
969 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
970 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
971 sprintf(msg, "Bad database argument: %s", name);
978 authentication = std::string(param_user);
980 authentication += "/" + std::string(param_password);
982 if (param_content_user)
984 content_authentication = std::string(param_content_user);
985 if (param_content_password)
986 content_authentication += "/" + std::string(param_content_password);
989 if (torus_db.compare("IR-Explain---1") == 0)
990 return explain_search(package, database, error, addinfo, odr, torus_db,
995 std::map<std::string,SearchablePtr>::iterator it;
996 it = m_p->s_map.find(torus_db);
997 if (it != m_p->s_map.end())
999 else if (torus_url.length() > 0)
1001 std::string torus_query = "udb==" + torus_db;
1002 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
1007 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1008 *addinfo = odr_strdup(odr, torus_db.c_str());
1012 const xmlNode *ptr = xmlDocGetRootElement(doc);
1014 { // presumably ptr is a records element node
1015 // parse first record in document
1016 for (ptr = ptr->children; ptr; ptr = ptr->next)
1018 if (ptr->type == XML_ELEMENT_NODE
1019 && !strcmp((const char *) ptr->name, "record"))
1023 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1024 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
1025 sprintf(*addinfo, "multiple records for udb=%s",
1031 sptr = m_p->parse_torus_record(ptr);
1040 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1041 *addinfo = odr_strdup(odr, torus_db.c_str());
1046 xsltStylesheetPtr xsp = 0;
1047 if (sptr->transform_xsl_content.length())
1049 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
1050 sptr->transform_xsl_content.length());
1053 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1054 *addinfo = (char *) odr_malloc(odr, 40);
1055 sprintf(*addinfo, "xmlParseMemory failed");
1059 xsp = xsltParseStylesheetDoc(xsp_doc);
1062 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1063 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1065 xmlFreeDoc(xsp_doc);
1069 else if (sptr->transform_xsl_fname.length())
1071 const char *path = 0;
1073 if (m_p->xsldir.length())
1074 path = m_p->xsldir.c_str();
1076 path = m_p->file_path.c_str();
1079 char fullpath[1024];
1080 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1086 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1088 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1089 sprintf(*addinfo, "File could not be read: %s",
1090 sptr->transform_xsl_fname.c_str());
1094 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1097 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1098 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1099 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1103 xsp = xsltParseStylesheetDoc(xsp_doc);
1106 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1107 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1109 xmlFreeDoc(xsp_doc);
1116 BackendPtr b(new Backend);
1120 b->m_frontend_database = database;
1121 b->enable_cproxy = param_nocproxy ? false : true;
1123 if (sptr->query_encoding.length())
1124 b->set_option("rpnCharset", sptr->query_encoding);
1126 b->set_option("timeout", m_p->zoom_timeout.c_str());
1129 b->set_option("apdulog", "1");
1131 if (sptr->piggyback && sptr->sru.length())
1132 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1133 maximumRecords > 0 */
1134 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1136 if (authentication.length() == 0)
1137 authentication = sptr->authentication;
1139 if (proxy.length() == 0)
1140 proxy = sptr->cfProxy;
1142 if (sptr->cfAuth.length())
1145 b->set_option("user", sptr->cfAuth);
1146 if (authentication.length())
1148 size_t found = authentication.find('/');
1149 if (found != std::string::npos)
1151 out_names[no_out_args] = "user";
1152 out_values[no_out_args++] =
1153 odr_strdup(odr, authentication.substr(0, found).c_str());
1155 out_names[no_out_args] = "password";
1156 out_values[no_out_args++] =
1157 odr_strdup(odr, authentication.substr(found+1).c_str());
1161 out_names[no_out_args] = "user";
1162 out_values[no_out_args++] =
1163 odr_strdup(odr, authentication.c_str());
1168 out_names[no_out_args] = "proxy";
1169 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1171 if (sptr->cfSubDB.length())
1173 out_names[no_out_args] = "subdatabase";
1174 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1178 out_names[no_out_args] = "nocproxy";
1179 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1184 size_t found = authentication.find('/');
1186 if (sptr->sru.length() && found != std::string::npos)
1188 b->set_option("user", authentication.substr(0, found));
1189 b->set_option("password", authentication.substr(found+1));
1192 b->set_option("user", authentication);
1195 b->set_option("proxy", proxy);
1198 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1201 if (sptr->sru.length())
1203 url = "http://" + sptr->target;
1204 b->set_option("sru", sptr->sru);
1206 if (sptr->sru_version.length())
1207 b->set_option("sru_version", sptr->sru_version);
1216 out_names[no_out_args] = 0; // terminate list
1218 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1219 (char **) out_values);
1220 url += "," + std::string(x_args);
1222 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1223 b->connect(url, error, addinfo, odr);
1224 if (*error == 0 && b->enable_cproxy)
1225 create_content_session(package, b, error, addinfo, odr,
1226 content_authentication.length() ?
1227 content_authentication : authentication,
1228 content_proxy.length() ? content_proxy : proxy,
1235 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1236 Odr_oid *preferredRecordSyntax,
1237 const char *element_set_name,
1238 bool &enable_pz2_retrieval,
1239 bool &enable_pz2_transform,
1240 bool &enable_record_transform,
1241 bool &assume_marc8_charset)
1243 char oid_name_str[OID_STR_MAX];
1244 const char *syntax_name = 0;
1246 if (preferredRecordSyntax &&
1247 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
1249 if (element_set_name &&
1250 !strcmp(element_set_name, m_p->element_transform.c_str()))
1252 enable_pz2_retrieval = true;
1253 enable_pz2_transform = true;
1255 else if (element_set_name &&
1256 !strcmp(element_set_name, m_p->element_raw.c_str()))
1258 enable_pz2_retrieval = true;
1260 else if (m_p->record_xsp)
1262 enable_pz2_retrieval = true;
1263 enable_pz2_transform = true;
1264 enable_record_transform = true;
1268 if (enable_pz2_retrieval)
1270 std::string configured_request_syntax = b->sptr->request_syntax;
1271 if (configured_request_syntax.length())
1273 syntax_name = configured_request_syntax.c_str();
1274 const Odr_oid *syntax_oid =
1275 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1276 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1277 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1278 assume_marc8_charset = true;
1281 else if (preferredRecordSyntax)
1283 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1285 if (b->sptr->sru.length())
1286 syntax_name = "XML";
1288 b->set_option("preferredRecordSyntax", syntax_name);
1290 if (enable_pz2_retrieval)
1292 element_set_name = 0;
1293 if (b->sptr->element_set.length())
1294 element_set_name = b->sptr->element_set.c_str();
1297 b->set_option("elementSetName", element_set_name);
1298 if (b->sptr->sru.length() && element_set_name)
1299 b->set_option("schema", element_set_name);
1302 Z_Records *yf::Zoom::Frontend::get_explain_records(
1305 Odr_int number_to_present,
1308 Odr_int *number_of_records_returned,
1311 Odr_oid *preferredRecordSyntax,
1312 const char *element_set_name)
1315 Z_Records *records = 0;
1317 if (!b->explain_doc)
1321 if (number_to_present > 10000)
1322 number_to_present = 10000;
1324 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1326 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1327 odr_malloc(odr, sizeof(*npl));
1328 npl->records = (Z_NamePlusRecord **)
1329 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1331 for (i = 0; i < number_to_present; i++)
1334 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1337 xmlBufferPtr xml_buf = xmlBufferCreate();
1338 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1339 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1341 Z_NamePlusRecord *npr =
1342 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1343 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1344 npr->which = Z_NamePlusRecord_databaseRecord;
1345 npr->u.databaseRecord =
1346 z_ext_record_xml(odr,
1347 (const char *) xml_buf->content, xml_buf->use);
1348 npl->records[i] = npr;
1349 xmlFreeNode(tmp_node);
1350 xmlBufferFree(xml_buf);
1352 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1353 records->which = Z_Records_DBOSD;
1354 records->u.databaseOrSurDiagnostics = npl;
1356 npl->num_records = i;
1357 *number_of_records_returned = i;
1362 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
1364 Odr_int number_to_present,
1367 Odr_int *number_of_records_returned,
1370 Odr_oid *preferredRecordSyntax,
1371 const char *element_set_name)
1373 *number_of_records_returned = 0;
1374 Z_Records *records = 0;
1375 bool enable_pz2_retrieval = false; // whether target profile is used
1376 bool enable_pz2_transform = false; // whether XSLT is used as well
1377 bool assume_marc8_charset = false;
1378 bool enable_record_transform = false;
1380 prepare_elements(b, preferredRecordSyntax,
1382 enable_pz2_retrieval,
1383 enable_pz2_transform,
1384 enable_record_transform,
1385 assume_marc8_charset);
1387 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1388 enable_pz2_retrieval ? "yes" : "no",
1389 enable_pz2_transform ? "yes" : "no");
1391 if (start < 0 || number_to_present <=0)
1394 if (number_to_present > 10000)
1395 number_to_present = 10000;
1397 ZOOM_record *recs = (ZOOM_record *)
1398 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1400 b->present(start, number_to_present, recs, error, addinfo, odr);
1405 for (i = 0; i < number_to_present; i++)
1410 { // only return records if no error and at least one record
1412 const char *xsl_parms[3];
1413 char cproxy_host[1024];
1415 if (b->enable_cproxy && b->content_session_id.length())
1417 sprintf(cproxy_host, "%s.%s/",
1418 b->content_session_id.c_str(),
1419 m_p->content_proxy_server.c_str());
1421 char *q_cproxy_host = (char *)
1422 odr_malloc(odr, strlen(cproxy_host) + 3);
1423 strcpy(q_cproxy_host, "\"");
1424 strcat(q_cproxy_host, cproxy_host);
1425 strcat(q_cproxy_host, "\"");
1427 xsl_parms[0] = "cproxyhost";
1428 xsl_parms[1] = q_cproxy_host;
1434 *cproxy_host = '\0';
1437 char *odr_database = odr_strdup(odr,
1438 b->m_frontend_database.c_str());
1439 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1440 odr_malloc(odr, sizeof(*npl));
1441 *number_of_records_returned = i;
1442 npl->num_records = i;
1443 npl->records = (Z_NamePlusRecord **)
1444 odr_malloc(odr, i * sizeof(*npl->records));
1445 for (i = 0; i < number_to_present; i++)
1447 Z_NamePlusRecord *npr = 0;
1448 const char *addinfo;
1450 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1451 &addinfo, 0 /* diagset */);
1455 log_diagnostic(package, sur_error, addinfo);
1456 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1459 else if (enable_pz2_retrieval)
1461 char rec_type_str[100];
1462 const char *record_encoding = 0;
1464 if (b->sptr->record_encoding.length())
1465 record_encoding = b->sptr->record_encoding.c_str();
1466 else if (assume_marc8_charset)
1467 record_encoding = "marc8";
1469 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1470 if (record_encoding)
1472 strcat(rec_type_str, "; charset=");
1473 strcat(rec_type_str, record_encoding);
1476 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1479 xmlChar *xmlrec_buf = 0;
1480 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1482 if (!rec_buf && !npr)
1484 std::string addinfo("ZOOM_record_get failed for type ");
1486 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1487 addinfo += rec_type_str;
1488 log_diagnostic(package, error, addinfo.c_str());
1489 npr = zget_surrogateDiagRec(odr, odr_database,
1490 error, addinfo.c_str());
1494 package.log_write(rec_buf, rec_len);
1495 package.log_write("\r\n", 2);
1498 if (rec_buf && b->xsp && enable_pz2_transform)
1500 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1503 const char *addinfo = "xml parse failed for record";
1504 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1505 log_diagnostic(package, error, addinfo);
1506 npr = zget_surrogateDiagRec(
1507 odr, odr_database, error, addinfo);
1511 // first stage XSLT - per target
1512 xsltStylesheetPtr xsp = b->xsp;
1513 xmlDoc *rec_res = xsltApplyStylesheet(xsp, rec_doc,
1515 // insert generated-url
1519 mp::xml::url_recipe_handle(rec_res,
1520 b->sptr->urlRecipe);
1523 xmlNode *ptr = xmlDocGetRootElement(rec_res);
1524 while (ptr && ptr->type != XML_ELEMENT_NODE)
1527 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1528 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1530 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1534 // second stage XSLT - common
1535 if (rec_res && m_p->record_xsp &&
1536 enable_record_transform)
1538 xmlDoc *tmp_doc = rec_res;
1540 xsp = m_p->record_xsp;
1541 rec_res = xsltApplyStylesheet(xsp, tmp_doc,
1543 xmlFreeDoc(tmp_doc);
1545 // get result out of it
1548 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1550 rec_buf = (const char *) xmlrec_buf;
1551 package.log("zoom", YLOG_LOG, "xslt successful");
1552 package.log_write(rec_buf, rec_len);
1554 xmlFreeDoc(rec_res);
1558 std::string addinfo;
1560 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1562 addinfo = "xslt apply failed for "
1563 + b->sptr->transform_xsl_fname;
1564 log_diagnostic(package, error, addinfo.c_str());
1565 npr = zget_surrogateDiagRec(
1566 odr, odr_database, error, addinfo.c_str());
1568 xmlFreeDoc(rec_doc);
1575 npr = zget_surrogateDiagRec(
1577 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1581 npr = (Z_NamePlusRecord *)
1582 odr_malloc(odr, sizeof(*npr));
1583 npr->databaseName = odr_database;
1584 npr->which = Z_NamePlusRecord_databaseRecord;
1585 npr->u.databaseRecord =
1586 z_ext_record_xml(odr, rec_buf, rec_len);
1590 xmlFree(xmlrec_buf);
1595 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1598 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1599 npr->databaseName = odr_database;
1600 npr->which = Z_NamePlusRecord_databaseRecord;
1601 npr->u.databaseRecord = ext;
1605 npr = zget_surrogateDiagRec(
1607 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1608 "ZOOM_record, type ext");
1611 npl->records[i] = npr;
1613 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1614 records->which = Z_Records_DBOSD;
1615 records->u.databaseOrSurDiagnostics = npl;
1620 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1623 struct cql_node *r = 0;
1631 std::map<std::string,std::string>::const_iterator it;
1632 it = fieldmap.find(cn->u.st.index);
1633 if (it == fieldmap.end())
1635 if (it->second.length())
1636 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1642 r = convert_cql_fields(cn->u.boolean.left, odr);
1644 r = convert_cql_fields(cn->u.boolean.right, odr);
1647 r = convert_cql_fields(cn->u.sort.search, odr);
1653 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1654 int error, const char *addinfo)
1656 const char *err_msg = yaz_diag_bib1_str(error);
1658 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1659 error, err_msg, addinfo);
1661 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1665 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1666 std::string &database,
1670 std::string &torus_db,
1675 BackendPtr b(new Backend);
1677 b->m_frontend_database = database;
1678 b->enable_explain = true;
1680 Z_GDU *gdu = package.request().get();
1681 Z_APDU *apdu_req = gdu->u.z3950;
1682 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1683 Z_Query *query = sr->query;
1685 if (!m_p->explain_xsp)
1687 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1689 odr_strdup(odr, "IR-Explain---1 unsupported. "
1690 "Torus explain_xsl not defined");
1693 else if (query->which == Z_Query_type_104 &&
1694 query->u.type_104->which == Z_External_CQL)
1696 std::string torus_url = m_p->torus_searchable_url;
1697 std::string torus_query(query->u.type_104->u.cql);
1698 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1701 if (m_p->explain_xsp)
1703 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1710 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1711 *addinfo = odr_strdup(odr, "IR-Explain---1 problem. "
1712 "Could not obtain Torus records for Explain");
1716 xmlNode *ptr = xmlDocGetRootElement(doc);
1719 xml_node_search(ptr, &hits, 0);
1721 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1722 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1723 package.response() = apdu_res;
1727 xmlFreeDoc(b->explain_doc);
1728 b->explain_doc = doc;
1733 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1734 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1739 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1741 Z_GDU *gdu = package.request().get();
1742 Z_APDU *apdu_req = gdu->u.z3950;
1743 Z_APDU *apdu_res = 0;
1745 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1746 if (sr->num_databaseNames != 1)
1748 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1749 log_diagnostic(package, error, 0);
1750 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1751 package.response() = apdu_res;
1760 std::string db(sr->databaseNames[0]);
1762 BackendPtr b = get_backend_from_databases(package, db, &error,
1763 &addinfo, odr, &proxy_step);
1764 if (error && proxy_step)
1766 package.log("zoom", YLOG_WARN,
1767 "create backend failed: trying next proxy");
1772 log_diagnostic(package, error, addinfo);
1773 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1774 package.response() = apdu_res;
1777 if (!b || b->enable_explain)
1780 b->set_option("setname", "default");
1782 bool enable_pz2_retrieval = false;
1783 bool enable_pz2_transform = false;
1784 bool enable_record_transform = false;
1785 bool assume_marc8_charset = false;
1786 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1787 enable_pz2_retrieval,
1788 enable_pz2_transform,
1789 enable_record_transform,
1790 assume_marc8_charset);
1793 Z_Query *query = sr->query;
1794 WRBUF ccl_wrbuf = 0;
1795 WRBUF pqf_wrbuf = 0;
1796 std::string sortkeys;
1798 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1801 pqf_wrbuf = wrbuf_alloc();
1802 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1804 else if (query->which == Z_Query_type_2)
1807 ccl_wrbuf = wrbuf_alloc();
1808 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1809 query->u.type_2->len);
1811 else if (query->which == Z_Query_type_104 &&
1812 query->u.type_104->which == Z_External_CQL)
1815 const char *cql = query->u.type_104->u.cql;
1816 CQL_parser cp = cql_parser_create();
1817 int r = cql_parser_string(cp, cql);
1818 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1821 cql_parser_destroy(cp);
1822 error = YAZ_BIB1_MALFORMED_QUERY;
1823 const char *addinfo = "CQL syntax error";
1824 log_diagnostic(package, error, addinfo);
1826 odr.create_searchResponse(apdu_req, error, addinfo);
1827 package.response() = apdu_res;
1830 struct cql_node *cn = cql_parser_result(cp);
1831 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1834 // hopefully we are getting a ptr to a index+relation+term node
1835 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1837 if (cn_error->which == CQL_NODE_ST)
1838 addinfo = cn_error->u.st.index;
1840 log_diagnostic(package, error, addinfo);
1841 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1842 package.response() = apdu_res;
1843 cql_parser_destroy(cp);
1847 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1850 error = YAZ_BIB1_MALFORMED_QUERY;
1851 const char *addinfo = "CQL to CCL conversion error";
1853 log_diagnostic(package, error, addinfo);
1854 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1855 package.response() = apdu_res;
1856 cql_parser_destroy(cp);
1860 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1861 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
1863 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
1864 const char *addinfo = "CQL to CCL sortby conversion";
1866 log_diagnostic(package, error, addinfo);
1867 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1868 package.response() = apdu_res;
1869 wrbuf_destroy(sru_sortkeys_wrbuf);
1870 cql_parser_destroy(cp);
1873 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1874 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1876 wrbuf_destroy(sru_sortkeys_wrbuf);
1878 ccl_wrbuf = wrbuf_alloc();
1879 wrbuf_puts(ccl_wrbuf, ccl_buf);
1881 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1882 yaz_tok_parse_t tp =
1883 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1884 yaz_tok_cfg_destroy(tc);
1886 /* go through sortspec and map fields */
1887 int token = yaz_tok_move(tp);
1888 while (token != YAZ_TOK_EOF)
1890 if (token == YAZ_TOK_STRING)
1892 const char *field = yaz_tok_parse_string(tp);
1893 std::map<std::string,std::string>::iterator it;
1894 it = b->sptr->sortmap.find(field);
1895 if (it != b->sptr->sortmap.end())
1896 sortkeys += it->second;
1901 token = yaz_tok_move(tp);
1902 if (token == YAZ_TOK_STRING)
1904 sortkeys += yaz_tok_parse_string(tp);
1906 if (token != YAZ_TOK_EOF)
1909 token = yaz_tok_move(tp);
1912 yaz_tok_parse_destroy(tp);
1913 wrbuf_destroy(sort_spec_wrbuf);
1915 cql_parser_destroy(cp);
1919 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1920 const char *addinfo = 0;
1921 log_diagnostic(package, error, addinfo);
1922 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1923 package.response() = apdu_res;
1930 assert(pqf_wrbuf == 0);
1932 struct ccl_rpn_node *cn;
1933 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1934 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1936 wrbuf_destroy(ccl_wrbuf);
1939 char *addinfo = odr_strdup_null(odr, ccl_err_msg(cerror));
1940 error = YAZ_BIB1_MALFORMED_QUERY;
1944 case CCL_ERR_UNKNOWN_QUAL:
1945 case CCL_ERR_TRUNC_NOT_LEFT:
1946 case CCL_ERR_TRUNC_NOT_RIGHT:
1947 case CCL_ERR_TRUNC_NOT_BOTH:
1948 #ifdef CCL_ERR_TRUNC_NOT_EMBED
1949 case CCL_ERR_TRUNC_NOT_EMBED:
1951 #ifdef CCL_ERR_TRUNC_NOT_SINGLE
1952 case CCL_ERR_TRUNC_NOT_SINGLE:
1954 error = YAZ_BIB1_UNSUPP_SEARCH;
1957 log_diagnostic(package, error, addinfo);
1958 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1959 package.response() = apdu_res;
1962 pqf_wrbuf = wrbuf_alloc();
1963 ccl_pquery(pqf_wrbuf, cn);
1964 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1970 ZOOM_query q = ZOOM_query_create();
1971 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1973 if (b->get_option("sru"))
1977 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1978 WRBUF wrb = wrbuf_alloc();
1980 if (!strcmp(b->get_option("sru"), "solr"))
1982 solr_transform_t cqlt = solr_transform_create();
1984 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1986 solr_transform_close(cqlt);
1990 cql_transform_t cqlt = cql_transform_create();
1992 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1994 cql_transform_close(cqlt);
1998 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1999 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
2000 b->search(q, &hits, &error, &addinfo, odr);
2002 ZOOM_query_destroy(q);
2005 wrbuf_destroy(pqf_wrbuf);
2008 error = YAZ_BIB1_MALFORMED_QUERY;
2009 const char *addinfo = "can not convert from RPN to CQL/SOLR";
2010 log_diagnostic(package, error, addinfo);
2011 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2012 package.response() = apdu_res;
2018 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
2019 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
2020 b->search(q, &hits, &error, &addinfo, odr);
2021 ZOOM_query_destroy(q);
2022 wrbuf_destroy(pqf_wrbuf);
2025 if (error && proxy_step)
2027 // reset below prevent reuse in get_backend_from_databases
2029 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
2033 const char *element_set_name = 0;
2034 Odr_int number_to_present = 0;
2036 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
2038 Odr_int number_of_records_returned = 0;
2039 Z_Records *records = get_records(
2041 0, number_to_present, &error, &addinfo,
2042 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
2045 log_diagnostic(package, error, addinfo);
2046 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
2049 apdu_res->u.searchResponse->records = records;
2050 apdu_res->u.searchResponse->numberOfRecordsReturned =
2051 odr_intdup(odr, number_of_records_returned);
2053 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
2054 package.response() = apdu_res;
2057 void yf::Zoom::Frontend::handle_present(mp::Package &package)
2059 Z_GDU *gdu = package.request().get();
2060 Z_APDU *apdu_req = gdu->u.z3950;
2061 Z_APDU *apdu_res = 0;
2062 Z_PresentRequest *pr = apdu_req->u.presentRequest;
2067 package.response() = odr.create_presentResponse(
2068 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
2071 const char *element_set_name = 0;
2072 Z_RecordComposition *comp = pr->recordComposition;
2073 if (comp && comp->which != Z_RecordComp_simple)
2075 package.response() = odr.create_presentResponse(
2077 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
2080 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
2081 element_set_name = comp->u.simple->u.generic;
2082 Odr_int number_of_records_returned = 0;
2086 if (m_backend->enable_explain)
2088 Z_Records *records =
2089 get_explain_records(
2091 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2092 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2093 pr->preferredRecordSyntax, element_set_name);
2095 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2098 apdu_res->u.presentResponse->records = records;
2099 apdu_res->u.presentResponse->numberOfRecordsReturned =
2100 odr_intdup(odr, number_of_records_returned);
2102 package.response() = apdu_res;
2106 Z_Records *records =
2107 get_records(package,
2108 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2109 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2110 pr->preferredRecordSyntax, element_set_name);
2112 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2115 apdu_res->u.presentResponse->records = records;
2116 apdu_res->u.presentResponse->numberOfRecordsReturned =
2117 odr_intdup(odr, number_of_records_returned);
2119 package.response() = apdu_res;
2123 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2125 Z_GDU *gdu = package.request().get();
2128 else if (gdu->which == Z_GDU_Z3950)
2130 Z_APDU *apdu_req = gdu->u.z3950;
2133 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2134 if (apdu_req->which == Z_APDU_initRequest)
2137 package.response() = odr.create_close(
2139 Z_Close_protocolError,
2142 else if (apdu_req->which == Z_APDU_searchRequest)
2144 handle_search(package);
2146 else if (apdu_req->which == Z_APDU_presentRequest)
2148 handle_present(package);
2153 package.response() = odr.create_close(
2155 Z_Close_protocolError,
2156 "zoom filter cannot handle this APDU");
2157 package.session().close();
2161 WRBUF w = m_backend->m_apdu_wrbuf;
2162 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2167 package.session().close();
2171 void yf::Zoom::Impl::process(mp::Package &package)
2173 FrontendPtr f = get_frontend(package);
2174 Z_GDU *gdu = package.request().get();
2176 if (f->m_is_virtual)
2178 f->handle_package(package);
2180 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2183 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2184 f->m_init_gdu = gdu;
2187 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2188 Z_InitResponse *resp = apdu->u.initResponse;
2191 static const int masks[] = {
2196 for (i = 0; masks[i] != -1; i++)
2197 if (ODR_MASK_GET(req->options, masks[i]))
2198 ODR_MASK_SET(resp->options, masks[i]);
2200 static const int versions[] = {
2201 Z_ProtocolVersion_1,
2202 Z_ProtocolVersion_2,
2203 Z_ProtocolVersion_3,
2206 for (i = 0; versions[i] != -1; i++)
2207 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2208 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2212 *resp->preferredMessageSize = *req->preferredMessageSize;
2213 *resp->maximumRecordSize = *req->maximumRecordSize;
2215 package.response() = apdu;
2216 f->m_is_virtual = true;
2221 release_frontend(package);
2225 static mp::filter::Base* filter_creator()
2227 return new mp::filter::Zoom;
2231 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2242 * c-file-style: "Stroustrup"
2243 * indent-tabs-mode: nil
2245 * vim: shiftwidth=4 tabstop=8 expandtab