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 &assume_marc8_charset);
153 Z_Records *get_records(Package &package,
155 Odr_int number_to_present,
158 Odr_int *number_of_records_returned,
159 ODR odr, BackendPtr b,
160 Odr_oid *preferredRecordSyntax,
161 const char *element_set_name);
162 Z_Records *get_explain_records(Package &package,
164 Odr_int number_to_present,
167 Odr_int *number_of_records_returned,
168 ODR odr, BackendPtr b,
169 Odr_oid *preferredRecordSyntax,
170 const char *element_set_name);
172 void log_diagnostic(mp::Package &package,
173 int error, const char *addinfo);
175 Frontend(Impl *impl);
179 friend class Frontend;
183 void process(metaproxy_1::Package & package);
184 void configure(const xmlNode * ptr, bool test_only,
187 void configure_local_records(const xmlNode * ptr, bool test_only);
188 FrontendPtr get_frontend(mp::Package &package);
189 void release_frontend(mp::Package &package);
190 SearchablePtr parse_torus_record(const xmlNode *ptr);
191 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
192 std::map<mp::Session, FrontendPtr> m_clients;
193 boost::mutex m_mutex;
194 boost::condition m_cond_session_ready;
195 std::string torus_searchable_url;
196 std::string torus_content_url;
197 std::string default_realm;
198 std::map<std::string,std::string> fieldmap;
200 std::string file_path;
201 std::string content_proxy_server;
202 std::string content_tmp_file;
205 std::string element_transform;
206 std::string element_raw;
208 xsltStylesheetPtr explain_xsp;
209 std::map<std::string,SearchablePtr> s_map;
215 static xmlNode *xml_node_search(xmlNode *ptr, int *num, int m)
219 if (ptr->type == XML_ELEMENT_NODE &&
220 !strcmp((const char *) ptr->name, "recordData"))
226 else // else: we don't want to find nested nodes
228 xmlNode *ret_node = xml_node_search(ptr->children, num, m);
237 // define Pimpl wrapper forwarding to Impl
239 yf::Zoom::Zoom() : m_p(new Impl)
244 { // must have a destructor because of boost::scoped_ptr
247 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
250 m_p->configure(xmlnode, test_only, path);
253 void yf::Zoom::process(mp::Package &package) const
255 m_p->process(package);
259 // define Implementation stuff
261 yf::Zoom::Backend::Backend()
263 m_apdu_wrbuf = wrbuf_alloc();
264 m_connection = ZOOM_connection_create(0);
265 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
268 enable_cproxy = true;
269 enable_explain = false;
273 yf::Zoom::Backend::~Backend()
276 xsltFreeStylesheet(xsp);
278 xmlFreeDoc(explain_doc);
279 ZOOM_connection_destroy(m_connection);
280 ZOOM_resultset_destroy(m_resultset);
281 wrbuf_destroy(m_apdu_wrbuf);
285 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
289 const char *zoom_addinfo = 0;
290 const char *dset = 0;
291 int error0 = ZOOM_connection_error_x(m_connection, &msg,
292 &zoom_addinfo, &dset);
298 if (!strcmp(dset, "info:srw/diagnostic/1"))
299 *error = yaz_diag_srw_to_bib1(error0);
300 else if (!strcmp(dset, "Bib-1"))
303 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
305 *addinfo = (char *) odr_malloc(
306 odr, 30 + strlen(dset) + strlen(msg) +
307 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
309 if (zoom_addinfo && *zoom_addinfo)
311 strcpy(*addinfo, zoom_addinfo);
312 strcat(*addinfo, " ");
314 sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg);
318 void yf::Zoom::Backend::connect(std::string zurl,
319 int *error, char **addinfo,
322 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
323 get_zoom_error(error, addinfo, odr);
326 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
327 int *error, char **addinfo, ODR odr)
329 ZOOM_resultset_destroy(m_resultset);
330 m_resultset = ZOOM_connection_search(m_connection, q);
331 get_zoom_error(error, addinfo, odr);
333 *hits = ZOOM_resultset_size(m_resultset);
338 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
340 int *error, char **addinfo, ODR odr)
342 ZOOM_resultset_records(m_resultset, recs, start, number);
343 get_zoom_error(error, addinfo, odr);
346 void yf::Zoom::Backend::set_option(const char *name, const char *value)
348 ZOOM_connection_option_set(m_connection, name, value);
350 ZOOM_resultset_option_set(m_resultset, name, value);
353 void yf::Zoom::Backend::set_option(const char *name, std::string value)
355 set_option(name, value.c_str());
358 const char *yf::Zoom::Backend::get_option(const char *name)
360 return ZOOM_connection_option_get(m_connection, name);
363 yf::Zoom::Searchable::Searchable(CCL_bibset base)
366 use_turbomarc = true;
367 sortStrategy = "embed";
368 urlRecipe = "${md-electronic-url}";
369 ccl_bibset = ccl_qual_dup(base);
372 yf::Zoom::Searchable::~Searchable()
374 ccl_qual_rm(&ccl_bibset);
377 yf::Zoom::Frontend::Frontend(Impl *impl) :
378 m_p(impl), m_is_virtual(false), m_in_use(true)
382 yf::Zoom::Frontend::~Frontend()
386 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
388 boost::mutex::scoped_lock lock(m_mutex);
390 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
394 it = m_clients.find(package.session());
395 if (it == m_clients.end())
398 if (!it->second->m_in_use)
400 it->second->m_in_use = true;
403 m_cond_session_ready.wait(lock);
405 FrontendPtr f(new Frontend(this));
406 m_clients[package.session()] = f;
411 void yf::Zoom::Impl::release_frontend(mp::Package &package)
413 boost::mutex::scoped_lock lock(m_mutex);
414 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
416 it = m_clients.find(package.session());
417 if (it != m_clients.end())
419 if (package.session().is_closed())
425 it->second->m_in_use = false;
427 m_cond_session_ready.notify_all();
431 yf::Zoom::Impl::Impl() :
432 apdu_log(false), element_transform("pz2") , element_raw("raw")
434 bibset = ccl_qual_mk();
437 srand((unsigned int) time(0));
440 yf::Zoom::Impl::~Impl()
443 xsltFreeStylesheet(explain_xsp);
444 ccl_qual_rm(&bibset);
447 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
449 Zoom::SearchablePtr s(new Searchable(bibset));
451 for (ptr = ptr->children; ptr; ptr = ptr->next)
453 if (ptr->type != XML_ELEMENT_NODE)
455 if (!strcmp((const char *) ptr->name, "layer"))
457 else if (!strcmp((const char *) ptr->name,
460 s->authentication = mp::xml::get_text(ptr);
462 else if (!strcmp((const char *) ptr->name,
465 s->cfAuth = mp::xml::get_text(ptr);
467 else if (!strcmp((const char *) ptr->name,
470 s->cfProxy = mp::xml::get_text(ptr);
472 else if (!strcmp((const char *) ptr->name,
475 s->cfSubDB = mp::xml::get_text(ptr);
477 else if (!strcmp((const char *) ptr->name,
480 s->contentConnector = mp::xml::get_text(ptr);
482 else if (!strcmp((const char *) ptr->name, "udb"))
484 s->udb = mp::xml::get_text(ptr);
486 else if (!strcmp((const char *) ptr->name, "zurl"))
488 s->target = mp::xml::get_text(ptr);
490 else if (!strcmp((const char *) ptr->name, "sru"))
492 s->sru = mp::xml::get_text(ptr);
494 else if (!strcmp((const char *) ptr->name, "SRUVersion") ||
495 !strcmp((const char *) ptr->name, "sruVersion"))
497 s->sru_version = mp::xml::get_text(ptr);
499 else if (!strcmp((const char *) ptr->name,
502 s->query_encoding = mp::xml::get_text(ptr);
504 else if (!strcmp((const char *) ptr->name,
507 s->piggyback = mp::xml::get_bool(ptr, true);
509 else if (!strcmp((const char *) ptr->name,
512 s->request_syntax = mp::xml::get_text(ptr);
514 else if (!strcmp((const char *) ptr->name,
517 s->element_set = mp::xml::get_text(ptr);
519 else if (!strcmp((const char *) ptr->name,
522 s->record_encoding = mp::xml::get_text(ptr);
524 else if (!strcmp((const char *) ptr->name,
527 s->transform_xsl_fname = mp::xml::get_text(ptr);
529 else if (!strcmp((const char *) ptr->name,
532 s->transform_xsl_content = mp::xml::get_text(ptr);
534 else if (!strcmp((const char *) ptr->name,
537 s->urlRecipe = mp::xml::get_text(ptr);
539 else if (!strcmp((const char *) ptr->name,
542 ; // useTurboMarc is ignored
544 else if (!strncmp((const char *) ptr->name,
547 std::string value = mp::xml::get_text(ptr);
548 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
549 (const char *) ptr->name + 7);
551 else if (!strncmp((const char *) ptr->name,
554 std::string value = mp::xml::get_text(ptr);
555 s->sortmap[(const char *) ptr->name + 8] = value;
557 else if (!strcmp((const char *) ptr->name,
560 s->sortStrategy = mp::xml::get_text(ptr);
566 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
568 while (ptr && ptr->type != XML_ELEMENT_NODE)
573 if (!strcmp((const char *) ptr->name, "records"))
575 for (ptr = ptr->children; ptr; ptr = ptr->next)
577 if (ptr->type != XML_ELEMENT_NODE)
579 if (!strcmp((const char *) ptr->name, "record"))
581 SearchablePtr s = parse_torus_record(ptr);
584 std::string udb = s->udb;
589 throw mp::filter::FilterException
590 ("No udb for local torus record");
596 throw mp::filter::FilterException
598 + std::string((const char *) ptr->name)
599 + " in zoom filter inside element "
606 throw mp::filter::FilterException
608 + std::string((const char *) ptr->name)
609 + " in zoom filter inside element <torus>");
614 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
617 std::string explain_xslt_fname;
619 content_tmp_file = "/tmp/cf.XXXXXX.p";
624 for (ptr = ptr->children; ptr; ptr = ptr->next)
626 if (ptr->type != XML_ELEMENT_NODE)
628 else if (!strcmp((const char *) ptr->name, "torus"))
630 const struct _xmlAttr *attr;
631 for (attr = ptr->properties; attr; attr = attr->next)
633 if (!strcmp((const char *) attr->name, "url"))
634 torus_searchable_url = mp::xml::get_text(attr->children);
635 else if (!strcmp((const char *) attr->name, "content_url"))
636 torus_content_url = mp::xml::get_text(attr->children);
637 else if (!strcmp((const char *) attr->name, "realm"))
638 default_realm = mp::xml::get_text(attr->children);
639 else if (!strcmp((const char *) attr->name, "xsldir"))
640 xsldir = mp::xml::get_text(attr->children);
641 else if (!strcmp((const char *) attr->name, "element_transform"))
642 element_transform = mp::xml::get_text(attr->children);
643 else if (!strcmp((const char *) attr->name, "element_raw"))
644 element_raw = mp::xml::get_text(attr->children);
645 else if (!strcmp((const char *) attr->name, "proxy"))
646 proxy = mp::xml::get_text(attr->children);
647 else if (!strcmp((const char *) attr->name, "explain_xsl"))
648 explain_xslt_fname = mp::xml::get_text(attr->children);
650 throw mp::filter::FilterException(
651 "Bad attribute " + std::string((const char *)
654 // If content_url is not given, use value of searchable, to
655 // ensure backwards compatibility
656 if (!torus_content_url.length())
657 torus_content_url = torus_searchable_url;
658 configure_local_records(ptr->children, test_only);
660 else if (!strcmp((const char *) ptr->name, "cclmap"))
662 const char *addinfo = 0;
663 ccl_xml_config(bibset, ptr, &addinfo);
665 else if (!strcmp((const char *) ptr->name, "fieldmap"))
667 const struct _xmlAttr *attr;
668 std::string ccl_field;
669 std::string cql_field;
670 for (attr = ptr->properties; attr; attr = attr->next)
672 if (!strcmp((const char *) attr->name, "ccl"))
673 ccl_field = mp::xml::get_text(attr->children);
674 else if (!strcmp((const char *) attr->name, "cql"))
675 cql_field = mp::xml::get_text(attr->children);
677 throw mp::filter::FilterException(
678 "Bad attribute " + std::string((const char *)
681 if (cql_field.length())
682 fieldmap[cql_field] = ccl_field;
684 else if (!strcmp((const char *) ptr->name, "contentProxy"))
686 const struct _xmlAttr *attr;
687 for (attr = ptr->properties; attr; attr = attr->next)
689 if (!strcmp((const char *) attr->name, "server"))
690 content_proxy_server = mp::xml::get_text(attr->children);
691 else if (!strcmp((const char *) attr->name, "tmp_file"))
692 content_tmp_file = mp::xml::get_text(attr->children);
694 throw mp::filter::FilterException(
695 "Bad attribute " + std::string((const char *)
699 else if (!strcmp((const char *) ptr->name, "log"))
701 const struct _xmlAttr *attr;
702 for (attr = ptr->properties; attr; attr = attr->next)
704 if (!strcmp((const char *) attr->name, "apdu"))
705 apdu_log = mp::xml::get_bool(attr->children, false);
707 throw mp::filter::FilterException(
708 "Bad attribute " + std::string((const char *)
714 throw mp::filter::FilterException
716 + std::string((const char *) ptr->name)
717 + " in zoom filter");
721 if (explain_xslt_fname.length())
723 const char *path = 0;
726 path = xsldir.c_str();
728 path = file_path.c_str();
731 char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(),
735 throw mp::filter::FilterException
736 ("Cannot read XSLT " + explain_xslt_fname);
739 xmlDoc *xsp_doc = xmlParseFile(cp);
742 throw mp::filter::FilterException
743 ("Cannot parse XSLT " + explain_xslt_fname);
746 explain_xsp = xsltParseStylesheetDoc(xsp_doc);
750 throw mp::filter::FilterException
751 ("Cannot parse XSLT " + explain_xslt_fname);
757 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
759 int *error, char **addinfo,
761 std::string authentication,
765 if (b->sptr->contentConnector.length())
767 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
768 strcpy(fname, m_p->content_tmp_file.c_str());
769 char *xx = strstr(fname, "XXXXXX");
772 xx = fname + strlen(fname);
773 strcat(fname, "XXXXXX");
775 char tmp_char = xx[6];
776 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
779 FILE *file = fopen(fname, "w");
782 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
783 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
784 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
785 sprintf(*addinfo, "Could not create %s", fname);
789 b->content_session_id.assign(xx, 6);
790 WRBUF w = wrbuf_alloc();
791 wrbuf_puts(w, "#content_proxy\n");
792 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
793 if (authentication.length())
794 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
796 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
798 wrbuf_printf(w, "realm: %s\n", realm.c_str());
800 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
802 package.log("zoom", YLOG_LOG, "content file: %s", fname);
809 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
810 mp::Package &package,
811 std::string &database, int *error, char **addinfo, mp::odr &odr,
814 std::list<BackendPtr>::const_iterator map_it;
815 if (m_backend && m_backend->m_frontend_database == database)
818 std::string input_args;
819 std::string torus_db;
820 size_t db_arg_pos = database.find(',');
821 if (db_arg_pos != std::string::npos)
823 torus_db = database.substr(0, db_arg_pos);
824 input_args = database.substr(db_arg_pos + 1);
829 std::string authentication;
830 std::string content_authentication;
832 std::string content_proxy;
833 std::string realm = m_p->default_realm;
835 const char *param_user = 0;
836 const char *param_password = 0;
837 const char *param_content_user = 0;
838 const char *param_content_password = 0;
839 const char *param_nocproxy = 0;
845 if (input_args.length())
846 no_parms = yaz_uri_to_array(input_args.c_str(),
847 odr, &names, &values);
848 // adding 10 because we'll be adding other URL args
849 const char **out_names = (const char **)
850 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
851 const char **out_values = (const char **)
852 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
854 // may be changed if it's a content connection
855 std::string torus_url = m_p->torus_searchable_url;
857 for (i = 0; i < no_parms; i++)
859 const char *name = names[i];
860 const char *value = values[i];
863 if (!strcmp(name, "user"))
865 else if (!strcmp(name, "password"))
866 param_password = value;
867 else if (!strcmp(name, "content-user"))
868 param_content_user = value;
869 else if (!strcmp(name, "content-password"))
870 param_content_password = value;
871 else if (!strcmp(name, "content-proxy"))
872 content_proxy = value;
873 else if (!strcmp(name, "nocproxy"))
874 param_nocproxy = value;
875 else if (!strcmp(name, "proxy"))
879 nmem_strsplit(((ODR) odr)->mem, ",", value, &dstr, &dnum);
880 if (*proxy_step >= dnum)
884 proxy = dstr[*proxy_step];
887 if (*proxy_step == dnum)
891 else if (!strcmp(name, "cproxysession"))
893 out_names[no_out_args] = name;
894 out_values[no_out_args++] = value;
895 torus_url = m_p->torus_content_url;
897 else if (!strcmp(name, "realm"))
899 else if (name[0] == 'x' && name[1] == '-')
901 out_names[no_out_args] = name;
902 out_values[no_out_args++] = value;
907 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
908 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
909 sprintf(msg, "Bad database argument: %s", name);
916 authentication = std::string(param_user);
918 authentication += "/" + std::string(param_password);
920 if (param_content_user)
922 content_authentication = std::string(param_content_user);
923 if (param_content_password)
924 content_authentication += "/" + std::string(param_content_password);
927 if (torus_db.compare("IR-Explain---1") == 0)
928 return explain_search(package, database, error, addinfo, odr, torus_db,
933 std::map<std::string,SearchablePtr>::iterator it;
934 it = m_p->s_map.find(torus_db);
935 if (it != m_p->s_map.end())
937 else if (torus_url.length() > 0)
939 std::string torus_query = "udb==" + torus_db;
940 xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db,
945 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
946 *addinfo = odr_strdup(odr, database.c_str());
950 const xmlNode *ptr = xmlDocGetRootElement(doc);
952 { // presumably ptr is a records element node
953 // parse first record in document
954 for (ptr = ptr->children; ptr; ptr = ptr->next)
956 if (ptr->type == XML_ELEMENT_NODE
957 && !strcmp((const char *) ptr->name, "record"))
961 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
962 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
963 sprintf(*addinfo, "multiple records for udb=%s",
969 sptr = m_p->parse_torus_record(ptr);
978 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
979 *addinfo = odr_strdup(odr, database.c_str());
984 xsltStylesheetPtr xsp = 0;
985 if (sptr->transform_xsl_content.length())
987 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
988 sptr->transform_xsl_content.length());
991 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
992 *addinfo = (char *) odr_malloc(odr, 40);
993 sprintf(*addinfo, "xmlParseMemory failed");
997 xsp = xsltParseStylesheetDoc(xsp_doc);
1000 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1001 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1003 xmlFreeDoc(xsp_doc);
1007 else if (sptr->transform_xsl_fname.length())
1009 const char *path = 0;
1011 if (m_p->xsldir.length())
1012 path = m_p->xsldir.c_str();
1014 path = m_p->file_path.c_str();
1017 char fullpath[1024];
1018 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
1024 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1026 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
1027 sprintf(*addinfo, "File could not be read: %s",
1028 sptr->transform_xsl_fname.c_str());
1032 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
1035 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1036 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
1037 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
1041 xsp = xsltParseStylesheetDoc(xsp_doc);
1044 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
1045 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
1047 xmlFreeDoc(xsp_doc);
1054 BackendPtr b(new Backend);
1058 b->m_frontend_database = database;
1059 b->enable_cproxy = param_nocproxy ? false : true;
1061 if (sptr->query_encoding.length())
1062 b->set_option("rpnCharset", sptr->query_encoding);
1064 b->set_option("timeout", "40");
1067 b->set_option("apdulog", "1");
1069 if (sptr->piggyback && sptr->sru.length())
1070 b->set_option("count", "1"); /* some SRU servers INSIST on getting
1071 maximumRecords > 0 */
1072 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
1074 if (authentication.length() == 0)
1075 authentication = sptr->authentication;
1077 if (proxy.length() == 0)
1078 proxy = sptr->cfProxy;
1080 if (sptr->cfAuth.length())
1083 b->set_option("user", sptr->cfAuth);
1084 if (authentication.length())
1086 size_t found = authentication.find('/');
1087 if (found != std::string::npos)
1089 out_names[no_out_args] = "user";
1090 out_values[no_out_args++] =
1091 odr_strdup(odr, authentication.substr(0, found).c_str());
1093 out_names[no_out_args] = "password";
1094 out_values[no_out_args++] =
1095 odr_strdup(odr, authentication.substr(found+1).c_str());
1099 out_names[no_out_args] = "user";
1100 out_values[no_out_args++] =
1101 odr_strdup(odr, authentication.c_str());
1106 out_names[no_out_args] = "proxy";
1107 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
1109 if (sptr->cfSubDB.length())
1111 out_names[no_out_args] = "subdatabase";
1112 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
1116 out_names[no_out_args] = "nocproxy";
1117 out_values[no_out_args++] = odr_strdup(odr, param_nocproxy);
1122 size_t found = authentication.find('/');
1124 if (sptr->sru.length() && found != std::string::npos)
1126 b->set_option("user", authentication.substr(0, found));
1127 b->set_option("password", authentication.substr(found+1));
1130 b->set_option("user", authentication);
1133 b->set_option("proxy", proxy);
1136 package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str());
1139 if (sptr->sru.length())
1141 url = "http://" + sptr->target;
1142 b->set_option("sru", sptr->sru);
1144 if (sptr->sru_version.length())
1145 b->set_option("sru_version", sptr->sru_version);
1154 out_names[no_out_args] = 0; // terminate list
1156 yaz_array_to_uri(&x_args, odr, (char **) out_names,
1157 (char **) out_values);
1158 url += "," + std::string(x_args);
1160 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1161 b->connect(url, error, addinfo, odr);
1162 if (*error == 0 && b->enable_cproxy)
1163 create_content_session(package, b, error, addinfo, odr,
1164 content_authentication.length() ?
1165 content_authentication : authentication,
1166 content_proxy.length() ? content_proxy : proxy,
1173 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1174 Odr_oid *preferredRecordSyntax,
1175 const char *element_set_name,
1176 bool &enable_pz2_retrieval,
1177 bool &enable_pz2_transform,
1178 bool &assume_marc8_charset)
1181 char oid_name_str[OID_STR_MAX];
1182 const char *syntax_name = 0;
1184 if (preferredRecordSyntax &&
1185 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
1186 && element_set_name)
1188 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
1190 enable_pz2_retrieval = true;
1191 enable_pz2_transform = true;
1193 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
1195 enable_pz2_retrieval = true;
1199 if (enable_pz2_retrieval)
1201 std::string configured_request_syntax = b->sptr->request_syntax;
1202 if (configured_request_syntax.length())
1204 syntax_name = configured_request_syntax.c_str();
1205 const Odr_oid *syntax_oid =
1206 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1207 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1208 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1209 assume_marc8_charset = true;
1212 else if (preferredRecordSyntax)
1214 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1216 if (b->sptr->sru.length())
1217 syntax_name = "XML";
1219 b->set_option("preferredRecordSyntax", syntax_name);
1221 if (enable_pz2_retrieval)
1223 element_set_name = 0;
1224 if (b->sptr->element_set.length())
1225 element_set_name = b->sptr->element_set.c_str();
1228 b->set_option("elementSetName", element_set_name);
1229 if (b->sptr->sru.length() && element_set_name)
1230 b->set_option("schema", element_set_name);
1233 Z_Records *yf::Zoom::Frontend::get_explain_records(
1236 Odr_int number_to_present,
1239 Odr_int *number_of_records_returned,
1242 Odr_oid *preferredRecordSyntax,
1243 const char *element_set_name)
1246 Z_Records *records = 0;
1248 if (!b->explain_doc)
1252 if (number_to_present > 10000)
1253 number_to_present = 10000;
1255 xmlNode *ptr = xmlDocGetRootElement(b->explain_doc);
1257 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1258 odr_malloc(odr, sizeof(*npl));
1259 npl->records = (Z_NamePlusRecord **)
1260 odr_malloc(odr, number_to_present * sizeof(*npl->records));
1262 for (i = 0; i < number_to_present; i++)
1265 xmlNode *res = xml_node_search(ptr, &num, start + i + 1);
1268 xmlBufferPtr xml_buf = xmlBufferCreate();
1269 xmlNode *tmp_node = xmlCopyNode(res->children, 1);
1270 xmlNodeDump(xml_buf, tmp_node->doc, tmp_node, 0, 0);
1272 Z_NamePlusRecord *npr =
1273 (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1274 npr->databaseName = odr_strdup(odr, b->m_frontend_database.c_str());
1275 npr->which = Z_NamePlusRecord_databaseRecord;
1276 npr->u.databaseRecord =
1277 z_ext_record_xml(odr,
1278 (const char *) xml_buf->content, xml_buf->use);
1279 npl->records[i] = npr;
1280 xmlFreeNode(tmp_node);
1281 xmlBufferFree(xml_buf);
1283 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1284 records->which = Z_Records_DBOSD;
1285 records->u.databaseOrSurDiagnostics = npl;
1287 npl->num_records = i;
1288 *number_of_records_returned = i;
1293 Z_Records *yf::Zoom::Frontend::get_records(Package &package,
1295 Odr_int number_to_present,
1298 Odr_int *number_of_records_returned,
1301 Odr_oid *preferredRecordSyntax,
1302 const char *element_set_name)
1304 *number_of_records_returned = 0;
1305 Z_Records *records = 0;
1306 bool enable_pz2_retrieval = false; // whether target profile is used
1307 bool enable_pz2_transform = false; // whether XSLT is used as well
1308 bool assume_marc8_charset = false;
1310 prepare_elements(b, preferredRecordSyntax,
1312 enable_pz2_retrieval,
1313 enable_pz2_transform,
1314 assume_marc8_charset);
1316 package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s",
1317 enable_pz2_retrieval ? "yes" : "no",
1318 enable_pz2_transform ? "yes" : "no");
1320 if (start < 0 || number_to_present <=0)
1323 if (number_to_present > 10000)
1324 number_to_present = 10000;
1326 ZOOM_record *recs = (ZOOM_record *)
1327 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1329 b->present(start, number_to_present, recs, error, addinfo, odr);
1334 for (i = 0; i < number_to_present; i++)
1339 { // only return records if no error and at least one record
1340 char *odr_database = odr_strdup(odr,
1341 b->m_frontend_database.c_str());
1342 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1343 odr_malloc(odr, sizeof(*npl));
1344 *number_of_records_returned = i;
1345 npl->num_records = i;
1346 npl->records = (Z_NamePlusRecord **)
1347 odr_malloc(odr, i * sizeof(*npl->records));
1348 for (i = 0; i < number_to_present; i++)
1350 Z_NamePlusRecord *npr = 0;
1351 const char *addinfo;
1353 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1354 &addinfo, 0 /* diagset */);
1358 log_diagnostic(package, sur_error, addinfo);
1359 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1362 else if (enable_pz2_retrieval)
1364 char rec_type_str[100];
1365 const char *record_encoding = 0;
1367 if (b->sptr->record_encoding.length())
1368 record_encoding = b->sptr->record_encoding.c_str();
1369 else if (assume_marc8_charset)
1370 record_encoding = "marc8";
1372 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1373 if (record_encoding)
1375 strcat(rec_type_str, "; charset=");
1376 strcat(rec_type_str, record_encoding);
1379 package.log("zoom", YLOG_LOG, "Getting record of type %s",
1382 xmlChar *xmlrec_buf = 0;
1383 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1385 if (!rec_buf && !npr)
1387 std::string addinfo("ZOOM_record_get failed for type ");
1389 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1390 addinfo += rec_type_str;
1391 log_diagnostic(package, error, addinfo.c_str());
1392 npr = zget_surrogateDiagRec(odr, odr_database,
1393 error, addinfo.c_str());
1397 package.log_write(rec_buf, rec_len);
1398 package.log_write("\r\n", 2);
1401 if (rec_buf && b->xsp && enable_pz2_transform)
1403 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1406 const char *addinfo = "xml parse failed for record";
1407 int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1408 log_diagnostic(package, error, addinfo);
1409 npr = zget_surrogateDiagRec(
1410 odr, odr_database, error, addinfo);
1415 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1419 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1421 rec_buf = (const char *) xmlrec_buf;
1422 package.log("zoom", YLOG_LOG, "xslt successful");
1423 package.log_write(rec_buf, rec_len);
1425 xmlFreeDoc(rec_res);
1429 std::string addinfo;
1431 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1433 addinfo = "xslt apply failed for "
1434 + b->sptr->transform_xsl_fname;
1435 log_diagnostic(package, error, addinfo.c_str());
1436 npr = zget_surrogateDiagRec(
1437 odr, odr_database, error, addinfo.c_str());
1439 xmlFreeDoc(rec_doc);
1443 if (rec_buf && b->enable_cproxy)
1445 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1447 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1448 if (res.length() && b->content_session_id.length())
1450 size_t off = res.find_first_of("://");
1451 if (off != std::string::npos)
1454 sprintf(tmp, "%s.%s/",
1455 b->content_session_id.c_str(),
1456 m_p->content_proxy_server.c_str());
1457 res.insert(off + 3, tmp);
1462 xmlNode *ptr = xmlDocGetRootElement(doc);
1463 while (ptr && ptr->type != XML_ELEMENT_NODE)
1466 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1467 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1469 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1473 xmlFree(xmlrec_buf);
1475 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1476 rec_buf = (const char *) xmlrec_buf;
1483 npr = zget_surrogateDiagRec(
1485 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1489 npr = (Z_NamePlusRecord *)
1490 odr_malloc(odr, sizeof(*npr));
1491 npr->databaseName = odr_database;
1492 npr->which = Z_NamePlusRecord_databaseRecord;
1493 npr->u.databaseRecord =
1494 z_ext_record_xml(odr, rec_buf, rec_len);
1498 xmlFree(xmlrec_buf);
1503 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1506 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1507 npr->databaseName = odr_database;
1508 npr->which = Z_NamePlusRecord_databaseRecord;
1509 npr->u.databaseRecord = ext;
1513 npr = zget_surrogateDiagRec(
1515 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1516 "ZOOM_record, type ext");
1519 npl->records[i] = npr;
1521 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1522 records->which = Z_Records_DBOSD;
1523 records->u.databaseOrSurDiagnostics = npl;
1528 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1531 struct cql_node *r = 0;
1539 std::map<std::string,std::string>::const_iterator it;
1540 it = fieldmap.find(cn->u.st.index);
1541 if (it == fieldmap.end())
1543 if (it->second.length())
1544 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1550 r = convert_cql_fields(cn->u.boolean.left, odr);
1552 r = convert_cql_fields(cn->u.boolean.right, odr);
1555 r = convert_cql_fields(cn->u.sort.search, odr);
1561 void yf::Zoom::Frontend::log_diagnostic(mp::Package &package,
1562 int error, const char *addinfo)
1564 const char *err_msg = yaz_diag_bib1_str(error);
1566 package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s",
1567 error, err_msg, addinfo);
1569 package.log("zoom", YLOG_WARN, "Diagnostic %d %s:",
1573 yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package,
1574 std::string &database,
1578 std::string &torus_db,
1583 BackendPtr b(new Backend);
1585 b->m_frontend_database = database;
1586 b->enable_explain = true;
1588 Z_GDU *gdu = package.request().get();
1589 Z_APDU *apdu_req = gdu->u.z3950;
1590 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1591 Z_Query *query = sr->query;
1593 if (!m_p->explain_xsp)
1595 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1597 odr_strdup(odr, "IR-Explain---1 unsupported. torus explain_xsl not defined");
1600 else if (query->which == Z_Query_type_104 &&
1601 query->u.type_104->which == Z_External_CQL)
1603 std::string torus_url = m_p->torus_searchable_url;
1604 std::string torus_query(query->u.type_104->u.cql);
1605 xmlDoc *doc = mp::get_searchable(package, torus_url, "",
1608 if (m_p->explain_xsp)
1610 xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0);
1617 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
1618 *addinfo = odr_strdup(odr, "IR-Explain--1 problem. "
1619 "Could not obtain Torus records for Explain");
1623 xmlNode *ptr = xmlDocGetRootElement(doc);
1626 xml_node_search(ptr, &hits, 0);
1628 Z_APDU *apdu_res = odr.create_searchResponse(apdu_req, 0, 0);
1629 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1630 package.response() = apdu_res;
1634 xmlFreeDoc(b->explain_doc);
1635 b->explain_doc = doc;
1640 *error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1641 *addinfo = odr_strdup(odr, "IR-Explain---1 only supports CQL");
1646 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1648 Z_GDU *gdu = package.request().get();
1649 Z_APDU *apdu_req = gdu->u.z3950;
1650 Z_APDU *apdu_res = 0;
1652 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1653 if (sr->num_databaseNames != 1)
1655 int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED;
1656 log_diagnostic(package, error, 0);
1657 apdu_res = odr.create_searchResponse(apdu_req, error, 0);
1658 package.response() = apdu_res;
1667 std::string db(sr->databaseNames[0]);
1669 BackendPtr b = get_backend_from_databases(package, db, &error,
1670 &addinfo, odr, &proxy_step);
1671 if (error && proxy_step)
1673 package.log("zoom", YLOG_WARN,
1674 "create backend failed: trying next proxy");
1679 log_diagnostic(package, error, addinfo);
1680 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1681 package.response() = apdu_res;
1684 if (!b || b->enable_explain)
1687 b->set_option("setname", "default");
1689 bool enable_pz2_retrieval = false;
1690 bool enable_pz2_transform = false;
1691 bool assume_marc8_charset = false;
1692 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1693 enable_pz2_retrieval,
1694 enable_pz2_transform,
1695 assume_marc8_charset);
1698 Z_Query *query = sr->query;
1699 WRBUF ccl_wrbuf = 0;
1700 WRBUF pqf_wrbuf = 0;
1701 std::string sortkeys;
1703 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1706 pqf_wrbuf = wrbuf_alloc();
1707 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1709 else if (query->which == Z_Query_type_2)
1712 ccl_wrbuf = wrbuf_alloc();
1713 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1714 query->u.type_2->len);
1716 else if (query->which == Z_Query_type_104 &&
1717 query->u.type_104->which == Z_External_CQL)
1720 const char *cql = query->u.type_104->u.cql;
1721 CQL_parser cp = cql_parser_create();
1722 int r = cql_parser_string(cp, cql);
1723 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1726 cql_parser_destroy(cp);
1727 error = YAZ_BIB1_MALFORMED_QUERY;
1728 const char *addinfo = "CQL syntax error";
1729 log_diagnostic(package, error, addinfo);
1731 odr.create_searchResponse(apdu_req, error, addinfo);
1732 package.response() = apdu_res;
1735 struct cql_node *cn = cql_parser_result(cp);
1736 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1739 // hopefully we are getting a ptr to a index+relation+term node
1740 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1742 if (cn_error->which == CQL_NODE_ST)
1743 addinfo = cn_error->u.st.index;
1745 log_diagnostic(package, error, addinfo);
1746 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1747 package.response() = apdu_res;
1748 cql_parser_destroy(cp);
1752 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1755 error = YAZ_BIB1_MALFORMED_QUERY;
1756 const char *addinfo = "CQL to CCL conversion error";
1758 log_diagnostic(package, error, addinfo);
1759 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1760 package.response() = apdu_res;
1761 cql_parser_destroy(cp);
1765 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1766 if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf))
1768 error = YAZ_BIB1_ILLEGAL_SORT_RELATION;
1769 const char *addinfo = "CQL to CCL sortby conversion";
1771 log_diagnostic(package, error, addinfo);
1772 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1773 package.response() = apdu_res;
1774 wrbuf_destroy(sru_sortkeys_wrbuf);
1775 cql_parser_destroy(cp);
1778 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1779 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1781 wrbuf_destroy(sru_sortkeys_wrbuf);
1783 ccl_wrbuf = wrbuf_alloc();
1784 wrbuf_puts(ccl_wrbuf, ccl_buf);
1786 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1787 yaz_tok_parse_t tp =
1788 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1789 yaz_tok_cfg_destroy(tc);
1791 /* go through sortspec and map fields */
1792 int token = yaz_tok_move(tp);
1793 while (token != YAZ_TOK_EOF)
1795 if (token == YAZ_TOK_STRING)
1797 const char *field = yaz_tok_parse_string(tp);
1798 std::map<std::string,std::string>::iterator it;
1799 it = b->sptr->sortmap.find(field);
1800 if (it != b->sptr->sortmap.end())
1801 sortkeys += it->second;
1806 token = yaz_tok_move(tp);
1807 if (token == YAZ_TOK_STRING)
1809 sortkeys += yaz_tok_parse_string(tp);
1811 if (token != YAZ_TOK_EOF)
1814 token = yaz_tok_move(tp);
1817 yaz_tok_parse_destroy(tp);
1818 wrbuf_destroy(sort_spec_wrbuf);
1820 cql_parser_destroy(cp);
1824 error = YAZ_BIB1_QUERY_TYPE_UNSUPP;
1825 const char *addinfo = 0;
1826 log_diagnostic(package, error, addinfo);
1827 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1828 package.response() = apdu_res;
1835 assert(pqf_wrbuf == 0);
1837 struct ccl_rpn_node *cn;
1838 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1839 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1841 wrbuf_destroy(ccl_wrbuf);
1844 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1845 error = YAZ_BIB1_MALFORMED_QUERY;
1849 case CCL_ERR_UNKNOWN_QUAL:
1850 error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1852 case CCL_ERR_TRUNC_NOT_LEFT:
1853 case CCL_ERR_TRUNC_NOT_RIGHT:
1854 case CCL_ERR_TRUNC_NOT_BOTH:
1855 error = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1858 log_diagnostic(package, error, addinfo);
1859 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1860 package.response() = apdu_res;
1863 pqf_wrbuf = wrbuf_alloc();
1864 ccl_pquery(pqf_wrbuf, cn);
1865 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1871 ZOOM_query q = ZOOM_query_create();
1872 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1874 if (b->get_option("sru"))
1878 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1879 WRBUF wrb = wrbuf_alloc();
1881 if (!strcmp(b->get_option("sru"), "solr"))
1883 solr_transform_t cqlt = solr_transform_create();
1885 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1887 solr_transform_close(cqlt);
1891 cql_transform_t cqlt = cql_transform_create();
1893 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1895 cql_transform_close(cqlt);
1899 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1900 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1901 b->search(q, &hits, &error, &addinfo, odr);
1903 ZOOM_query_destroy(q);
1906 wrbuf_destroy(pqf_wrbuf);
1909 error = YAZ_BIB1_MALFORMED_QUERY;
1910 const char *addinfo = "can not convert from RPN to CQL/SOLR";
1911 log_diagnostic(package, error, addinfo);
1912 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1913 package.response() = apdu_res;
1919 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
1920 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1921 b->search(q, &hits, &error, &addinfo, odr);
1922 ZOOM_query_destroy(q);
1923 wrbuf_destroy(pqf_wrbuf);
1926 if (error && proxy_step)
1928 // reset below prevent reuse in get_backend_from_databases
1930 package.log("zoom", YLOG_WARN, "search failed: trying next proxy");
1934 const char *element_set_name = 0;
1935 Odr_int number_to_present = 0;
1937 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1939 Odr_int number_of_records_returned = 0;
1940 Z_Records *records = get_records(
1942 0, number_to_present, &error, &addinfo,
1943 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1946 log_diagnostic(package, error, addinfo);
1947 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1950 apdu_res->u.searchResponse->records = records;
1951 apdu_res->u.searchResponse->numberOfRecordsReturned =
1952 odr_intdup(odr, number_of_records_returned);
1954 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1955 package.response() = apdu_res;
1958 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1960 Z_GDU *gdu = package.request().get();
1961 Z_APDU *apdu_req = gdu->u.z3950;
1962 Z_APDU *apdu_res = 0;
1963 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1968 package.response() = odr.create_presentResponse(
1969 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1972 const char *element_set_name = 0;
1973 Z_RecordComposition *comp = pr->recordComposition;
1974 if (comp && comp->which != Z_RecordComp_simple)
1976 package.response() = odr.create_presentResponse(
1978 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1981 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1982 element_set_name = comp->u.simple->u.generic;
1983 Odr_int number_of_records_returned = 0;
1987 if (m_backend->enable_explain)
1989 Z_Records *records =
1990 get_explain_records(
1992 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1993 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1994 pr->preferredRecordSyntax, element_set_name);
1996 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1999 apdu_res->u.presentResponse->records = records;
2000 apdu_res->u.presentResponse->numberOfRecordsReturned =
2001 odr_intdup(odr, number_of_records_returned);
2003 package.response() = apdu_res;
2007 Z_Records *records =
2008 get_records(package,
2009 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
2010 &error, &addinfo, &number_of_records_returned, odr, m_backend,
2011 pr->preferredRecordSyntax, element_set_name);
2013 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
2016 apdu_res->u.presentResponse->records = records;
2017 apdu_res->u.presentResponse->numberOfRecordsReturned =
2018 odr_intdup(odr, number_of_records_returned);
2020 package.response() = apdu_res;
2024 void yf::Zoom::Frontend::handle_package(mp::Package &package)
2026 Z_GDU *gdu = package.request().get();
2029 else if (gdu->which == Z_GDU_Z3950)
2031 Z_APDU *apdu_req = gdu->u.z3950;
2034 wrbuf_rewind(m_backend->m_apdu_wrbuf);
2035 if (apdu_req->which == Z_APDU_initRequest)
2038 package.response() = odr.create_close(
2040 Z_Close_protocolError,
2043 else if (apdu_req->which == Z_APDU_searchRequest)
2045 handle_search(package);
2047 else if (apdu_req->which == Z_APDU_presentRequest)
2049 handle_present(package);
2054 package.response() = odr.create_close(
2056 Z_Close_protocolError,
2057 "zoom filter cannot handle this APDU");
2058 package.session().close();
2062 WRBUF w = m_backend->m_apdu_wrbuf;
2063 package.log_write(wrbuf_buf(w), wrbuf_len(w));
2068 package.session().close();
2072 void yf::Zoom::Impl::process(mp::Package &package)
2074 FrontendPtr f = get_frontend(package);
2075 Z_GDU *gdu = package.request().get();
2077 if (f->m_is_virtual)
2079 f->handle_package(package);
2081 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
2084 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
2085 f->m_init_gdu = gdu;
2088 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
2089 Z_InitResponse *resp = apdu->u.initResponse;
2092 static const int masks[] = {
2097 for (i = 0; masks[i] != -1; i++)
2098 if (ODR_MASK_GET(req->options, masks[i]))
2099 ODR_MASK_SET(resp->options, masks[i]);
2101 static const int versions[] = {
2102 Z_ProtocolVersion_1,
2103 Z_ProtocolVersion_2,
2104 Z_ProtocolVersion_3,
2107 for (i = 0; versions[i] != -1; i++)
2108 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
2109 ODR_MASK_SET(resp->protocolVersion, versions[i]);
2113 *resp->preferredMessageSize = *req->preferredMessageSize;
2114 *resp->maximumRecordSize = *req->maximumRecordSize;
2116 package.response() = apdu;
2117 f->m_is_virtual = true;
2122 release_frontend(package);
2126 static mp::filter::Base* filter_creator()
2128 return new mp::filter::Zoom;
2132 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
2143 * c-file-style: "Stroustrup"
2144 * indent-tabs-mode: nil
2146 * vim: shiftwidth=4 tabstop=8 expandtab