1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 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
20 #include "filter_zoom.hpp"
22 #include <yaz/yaz-version.h>
23 #include <yaz/tpath.h>
25 #include <metaproxy/package.hpp>
26 #include <metaproxy/util.hpp>
27 #include <metaproxy/xmlutil.hpp>
30 #include <libxslt/xsltutils.h>
31 #include <libxslt/transform.h>
33 #include <boost/thread/mutex.hpp>
34 #include <boost/thread/condition.hpp>
35 #include <yaz/ccl_xml.h>
37 #include <yaz/rpn2cql.h>
38 #include <yaz/rpn2solr.h>
39 #include <yaz/pquery.h>
41 #include <yaz/oid_db.h>
42 #include <yaz/diagbib1.h>
45 #include <yaz/querytowrbuf.h>
47 namespace mp = metaproxy_1;
48 namespace yf = mp::filter;
50 namespace metaproxy_1 {
52 struct Zoom::Searchable : boost::noncopyable {
53 std::string authentication;
59 std::string query_encoding;
61 std::string request_syntax;
62 std::string element_set;
63 std::string record_encoding;
64 std::string transform_xsl_fname;
65 std::string urlRecipe;
66 std::string contentConnector;
69 CCL_bibset ccl_bibset;
70 Searchable(CCL_bibset base);
73 class Zoom::Backend : boost::noncopyable {
75 friend class Frontend;
77 ZOOM_connection m_connection;
78 ZOOM_resultset m_resultset;
79 std::string m_frontend_database;
81 xsltStylesheetPtr xsp;
82 std::string content_session_id;
84 Backend(SearchablePtr sptr);
86 void connect(std::string zurl, int *error, char **addinfo,
88 void search_pqf(const char *pqf, Odr_int *hits,
89 int *error, char **addinfo, ODR odr);
90 void search_cql(const char *cql, Odr_int *hits,
91 int *error, char **addinfo, ODR odr);
92 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
93 int *error, char **addinfo, ODR odr);
94 void set_option(const char *name, const char *value);
95 void set_option(const char *name, std::string value);
96 const char *get_option(const char *name);
97 void get_zoom_error(int *error, char **addinfo, ODR odr);
99 class Zoom::Frontend : boost::noncopyable {
104 yazpp_1::GDU m_init_gdu;
105 BackendPtr m_backend;
106 void handle_package(mp::Package &package);
107 void handle_search(mp::Package &package);
108 void handle_present(mp::Package &package);
109 BackendPtr get_backend_from_databases(std::string &database,
113 Z_Records *get_records(Odr_int start,
114 Odr_int number_to_present,
117 Odr_int *number_of_records_returned,
118 ODR odr, BackendPtr b,
119 Odr_oid *preferredRecordSyntax,
120 const char *element_set_name);
122 Frontend(Impl *impl);
126 friend class Frontend;
130 void process(metaproxy_1::Package & package);
131 void configure(const xmlNode * ptr, bool test_only,
134 void configure_local_records(const xmlNode * ptr, bool test_only);
135 FrontendPtr get_frontend(mp::Package &package);
136 void release_frontend(mp::Package &package);
137 SearchablePtr parse_torus_record(const xmlNode *ptr);
138 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
139 std::map<mp::Session, FrontendPtr> m_clients;
140 boost::mutex m_mutex;
141 boost::condition m_cond_session_ready;
142 std::string torus_url;
143 std::map<std::string,std::string> fieldmap;
145 std::string file_path;
146 std::string content_proxy_server;
147 std::string content_tmp_file;
150 std::string element_transform;
151 std::string element_raw;
152 std::map<std::string,SearchablePtr> s_map;
157 // define Pimpl wrapper forwarding to Impl
159 yf::Zoom::Zoom() : m_p(new Impl)
164 { // must have a destructor because of boost::scoped_ptr
167 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
170 m_p->configure(xmlnode, test_only, path);
173 void yf::Zoom::process(mp::Package &package) const
175 m_p->process(package);
179 // define Implementation stuff
181 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
183 m_connection = ZOOM_connection_create(0);
188 yf::Zoom::Backend::~Backend()
191 xsltFreeStylesheet(xsp);
192 ZOOM_connection_destroy(m_connection);
193 ZOOM_resultset_destroy(m_resultset);
197 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
201 const char *zoom_addinfo = 0;
202 const char *dset = 0;
203 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
206 if (*error >= ZOOM_ERROR_CONNECT)
208 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
209 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
210 *addinfo = (char *) odr_malloc(
211 odr, 20 + strlen(msg) +
212 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
213 strcpy(*addinfo, msg);
216 strcat(*addinfo, ": ");
217 strcat(*addinfo, zoom_addinfo);
218 strcat(*addinfo, " ");
223 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
224 *error = yaz_diag_srw_to_bib1(*error);
225 *addinfo = (char *) odr_malloc(
226 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
228 if (zoom_addinfo && *zoom_addinfo)
230 strcpy(*addinfo, zoom_addinfo);
231 strcat(*addinfo, " ");
233 strcat(*addinfo, "(backend)");
238 void yf::Zoom::Backend::connect(std::string zurl,
239 int *error, char **addinfo,
242 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
243 get_zoom_error(error, addinfo, odr);
246 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
247 int *error, char **addinfo, ODR odr)
249 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
250 get_zoom_error(error, addinfo, odr);
252 *hits = ZOOM_resultset_size(m_resultset);
257 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
258 int *error, char **addinfo, ODR odr)
260 ZOOM_query q = ZOOM_query_create();
262 ZOOM_query_cql(q, cql);
264 m_resultset = ZOOM_connection_search(m_connection, q);
265 ZOOM_query_destroy(q);
266 get_zoom_error(error, addinfo, odr);
268 *hits = ZOOM_resultset_size(m_resultset);
273 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
275 int *error, char **addinfo, ODR odr)
277 ZOOM_resultset_records(m_resultset, recs, start, number);
278 get_zoom_error(error, addinfo, odr);
281 void yf::Zoom::Backend::set_option(const char *name, const char *value)
283 ZOOM_connection_option_set(m_connection, name, value);
285 ZOOM_resultset_option_set(m_resultset, name, value);
288 void yf::Zoom::Backend::set_option(const char *name, std::string value)
290 set_option(name, value.c_str());
293 const char *yf::Zoom::Backend::get_option(const char *name)
295 return ZOOM_connection_option_get(m_connection, name);
298 yf::Zoom::Searchable::Searchable(CCL_bibset base)
301 use_turbomarc = true;
302 ccl_bibset = ccl_qual_dup(base);
305 yf::Zoom::Searchable::~Searchable()
307 ccl_qual_rm(&ccl_bibset);
310 yf::Zoom::Frontend::Frontend(Impl *impl) :
311 m_p(impl), m_is_virtual(false), m_in_use(true)
315 yf::Zoom::Frontend::~Frontend()
319 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
321 boost::mutex::scoped_lock lock(m_mutex);
323 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
327 it = m_clients.find(package.session());
328 if (it == m_clients.end())
331 if (!it->second->m_in_use)
333 it->second->m_in_use = true;
336 m_cond_session_ready.wait(lock);
338 FrontendPtr f(new Frontend(this));
339 m_clients[package.session()] = f;
344 void yf::Zoom::Impl::release_frontend(mp::Package &package)
346 boost::mutex::scoped_lock lock(m_mutex);
347 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
349 it = m_clients.find(package.session());
350 if (it != m_clients.end())
352 if (package.session().is_closed())
358 it->second->m_in_use = false;
360 m_cond_session_ready.notify_all();
364 yf::Zoom::Impl::Impl() :
365 apdu_log(false), element_transform("pz2") , element_raw("raw")
367 bibset = ccl_qual_mk();
370 yf::Zoom::Impl::~Impl()
372 ccl_qual_rm(&bibset);
375 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
377 Zoom::SearchablePtr s(new Searchable(bibset));
379 for (ptr = ptr->children; ptr; ptr = ptr->next)
381 if (ptr->type != XML_ELEMENT_NODE)
383 if (!strcmp((const char *) ptr->name, "layer"))
385 else if (!strcmp((const char *) ptr->name,
388 s->authentication = mp::xml::get_text(ptr);
390 else if (!strcmp((const char *) ptr->name,
393 s->cfAuth = mp::xml::get_text(ptr);
395 else if (!strcmp((const char *) ptr->name,
398 s->cfProxy = mp::xml::get_text(ptr);
400 else if (!strcmp((const char *) ptr->name,
403 s->cfSubDb = mp::xml::get_text(ptr);
405 else if (!strcmp((const char *) ptr->name,
408 s->contentConnector = mp::xml::get_text(ptr);
410 else if (!strcmp((const char *) ptr->name, "udb"))
412 s->udb = mp::xml::get_text(ptr);
414 else if (!strcmp((const char *) ptr->name, "zurl"))
416 s->target = mp::xml::get_text(ptr);
418 else if (!strcmp((const char *) ptr->name, "sru"))
420 s->sru = mp::xml::get_text(ptr);
422 else if (!strcmp((const char *) ptr->name,
425 s->query_encoding = mp::xml::get_text(ptr);
427 else if (!strcmp((const char *) ptr->name,
430 s->piggyback = mp::xml::get_bool(ptr, true);
432 else if (!strcmp((const char *) ptr->name,
435 s->request_syntax = mp::xml::get_text(ptr);
437 else if (!strcmp((const char *) ptr->name,
440 s->element_set = mp::xml::get_text(ptr);
442 else if (!strcmp((const char *) ptr->name,
445 s->record_encoding = mp::xml::get_text(ptr);
447 else if (!strcmp((const char *) ptr->name,
450 s->transform_xsl_fname = mp::xml::get_text(ptr);
452 else if (!strcmp((const char *) ptr->name,
455 s->urlRecipe = mp::xml::get_text(ptr);
457 else if (!strcmp((const char *) ptr->name,
460 ; // useTurboMarc is ignored
462 else if (!strncmp((const char *) ptr->name,
465 std::string value = mp::xml::get_text(ptr);
466 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
467 (const char *) ptr->name + 7);
473 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
475 while (ptr && ptr->type != XML_ELEMENT_NODE)
480 if (!strcmp((const char *) ptr->name, "records"))
482 for (ptr = ptr->children; ptr; ptr = ptr->next)
484 if (ptr->type != XML_ELEMENT_NODE)
486 if (!strcmp((const char *) ptr->name, "record"))
488 SearchablePtr s = parse_torus_record(ptr);
491 std::string udb = s->udb;
496 throw mp::filter::FilterException
497 ("No udb for local torus record");
503 throw mp::filter::FilterException
505 + std::string((const char *) ptr->name)
506 + " in zoom filter inside element "
513 throw mp::filter::FilterException
515 + std::string((const char *) ptr->name)
516 + " in zoom filter inside element <torus>");
521 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
524 content_tmp_file = "/tmp/cf.XXXXXX.p";
529 for (ptr = ptr->children; ptr; ptr = ptr->next)
531 if (ptr->type != XML_ELEMENT_NODE)
533 else if (!strcmp((const char *) ptr->name, "torus"))
535 const struct _xmlAttr *attr;
536 for (attr = ptr->properties; attr; attr = attr->next)
538 if (!strcmp((const char *) attr->name, "url"))
539 torus_url = mp::xml::get_text(attr->children);
540 else if (!strcmp((const char *) attr->name, "xsldir"))
541 xsldir = mp::xml::get_text(attr->children);
542 else if (!strcmp((const char *) attr->name, "element_transform"))
543 element_transform = mp::xml::get_text(attr->children);
544 else if (!strcmp((const char *) attr->name, "element_raw"))
545 element_raw = mp::xml::get_text(attr->children);
547 throw mp::filter::FilterException(
548 "Bad attribute " + std::string((const char *)
551 configure_local_records(ptr->children, test_only);
553 else if (!strcmp((const char *) ptr->name, "cclmap"))
555 const char *addinfo = 0;
556 ccl_xml_config(bibset, ptr, &addinfo);
558 else if (!strcmp((const char *) ptr->name, "fieldmap"))
560 const struct _xmlAttr *attr;
561 std::string ccl_field;
562 std::string cql_field;
563 for (attr = ptr->properties; attr; attr = attr->next)
565 if (!strcmp((const char *) attr->name, "ccl"))
566 ccl_field = mp::xml::get_text(attr->children);
567 else if (!strcmp((const char *) attr->name, "cql"))
568 cql_field = mp::xml::get_text(attr->children);
570 throw mp::filter::FilterException(
571 "Bad attribute " + std::string((const char *)
574 if (cql_field.length())
575 fieldmap[cql_field] = ccl_field;
577 else if (!strcmp((const char *) ptr->name, "contentProxy"))
579 const struct _xmlAttr *attr;
580 for (attr = ptr->properties; attr; attr = attr->next)
582 if (!strcmp((const char *) attr->name, "server"))
583 content_proxy_server = mp::xml::get_text(attr->children);
584 else if (!strcmp((const char *) attr->name, "tmp_file"))
585 content_tmp_file = mp::xml::get_text(attr->children);
587 throw mp::filter::FilterException(
588 "Bad attribute " + std::string((const char *)
592 else if (!strcmp((const char *) ptr->name, "log"))
594 const struct _xmlAttr *attr;
595 for (attr = ptr->properties; attr; attr = attr->next)
597 if (!strcmp((const char *) attr->name, "apdu"))
598 apdu_log = mp::xml::get_bool(attr->children, false);
600 throw mp::filter::FilterException(
601 "Bad attribute " + std::string((const char *)
607 throw mp::filter::FilterException
609 + std::string((const char *) ptr->name)
610 + " in zoom filter");
615 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
616 std::string &database, int *error, char **addinfo, ODR odr)
618 std::list<BackendPtr>::const_iterator map_it;
619 if (m_backend && m_backend->m_frontend_database == database)
623 std::string torus_db;
624 size_t db_arg_pos = database.find(',');
625 if (db_arg_pos != std::string::npos)
627 torus_db = database.substr(0, db_arg_pos);
628 db_args = database.substr(db_arg_pos + 1);
635 std::map<std::string,SearchablePtr>::iterator it;
636 it = m_p->s_map.find(torus_db);
637 if (it != m_p->s_map.end())
641 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
644 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
645 *addinfo = odr_strdup(odr, database.c_str());
649 const xmlNode *ptr = xmlDocGetRootElement(doc);
651 { // presumably ptr is a records element node
652 // parse first record in document
653 for (ptr = ptr->children; ptr; ptr = ptr->next)
655 if (ptr->type == XML_ELEMENT_NODE
656 && !strcmp((const char *) ptr->name, "record"))
658 sptr = m_p->parse_torus_record(ptr);
668 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
669 *addinfo = odr_strdup(odr, database.c_str());
674 xsltStylesheetPtr xsp = 0;
675 if (sptr->transform_xsl_fname.length())
677 const char *path = 0;
679 if (m_p->xsldir.length())
680 path = m_p->xsldir.c_str();
682 path = m_p->file_path.c_str();
686 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
692 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
694 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
695 sprintf(*addinfo, "File could not be read: %s",
696 sptr->transform_xsl_fname.c_str());
700 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
703 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
704 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
705 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
709 xsp = xsltParseStylesheetDoc(xsp_doc);
712 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
713 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
722 BackendPtr b(new Backend(sptr));
725 b->m_frontend_database = database;
727 if (sptr->query_encoding.length())
728 b->set_option("rpnCharset", sptr->query_encoding);
730 b->set_option("timeout", "40");
733 b->set_option("apdulog", "1");
735 std::string authentication = sptr->authentication;
736 std::string proxy = sptr->cfProxy;
738 const char *param_user = 0;
739 const char *param_password = 0;
740 const char *param_proxy = 0;
741 if (db_args.length())
746 int no_parms = yaz_uri_to_array(db_args.c_str(),
747 odr, &names, &values);
748 for (i = 0; i < no_parms; i++)
750 const char *name = names[i];
751 const char *value = values[i];
752 if (!strcmp(name, "user"))
754 else if (!strcmp(name, "password"))
755 param_password = value;
756 else if (!strcmp(name, "proxy"))
758 else if (!strcmp(name, "cproxysession"))
763 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
764 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
765 sprintf(msg, "Bad database argument: %s", name);
772 authentication = std::string(param_user);
774 authentication += "/" + std::string(param_password);
780 if (sptr->cfAuth.length())
783 b->set_option("user", sptr->cfAuth);
784 if (!param_user && !param_password && authentication.length())
786 if (db_args.length())
788 // no database (auth) args specified already.. and the
789 // Torus authentication has it.. Generate the args that CF
791 size_t found = authentication.find('/');
792 if (found != std::string::npos)
795 mp::util::uri_encode(authentication.substr(0, found))
797 mp::util::uri_encode(authentication.substr(found+1));
800 db_args += "user=" + mp::util::uri_encode(authentication);
802 if (!param_proxy && proxy.length())
804 if (db_args.length())
806 db_args += "proxy=" + mp::util::uri_encode(proxy);
808 if (sptr->cfSubDb.length())
810 if (db_args.length())
812 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
817 db_args.clear(); // no arguments to be passed (non-CF)
819 size_t found = authentication.find('/');
821 if (sptr->sru.length() && found != std::string::npos)
823 b->set_option("user", authentication.substr(0, found));
824 b->set_option("password", authentication.substr(found+1));
827 b->set_option("user", authentication);
830 b->set_option("proxy", proxy);
832 if (b->sptr->contentConnector.length())
834 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
835 strcpy(fname, m_p->content_tmp_file.c_str());
837 char *xx = strstr(fname, "XXXXXX");
839 suffixlen = strlen(xx) - 6;
843 xx = fname + strlen(fname);
844 strcat(fname, "XXXXXX");
846 int fd = mkstemps(fname, suffixlen);
849 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
850 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
851 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
852 sprintf(*addinfo, "Could not create %s", fname);
854 BackendPtr backend_null;
857 b->content_session_id.assign(xx, 6);
858 WRBUF w = wrbuf_alloc();
859 wrbuf_puts(w, "#content_proxy\n");
860 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
861 if (authentication.length())
862 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
864 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
865 if (sptr->cfAuth.length())
866 wrbuf_printf(w, "cfauth: %s\n", sptr->cfAuth.c_str());
867 if (sptr->cfProxy.length())
868 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
870 write(fd, wrbuf_buf(w), wrbuf_len(w));
872 yaz_log(YLOG_LOG, "file %s created\n", fname);
877 if (sptr->sru.length())
879 url = "http://" + sptr->target;
880 b->set_option("sru", sptr->sru);
886 if (db_args.length())
887 url += "," + db_args;
888 yaz_log(YLOG_LOG, "url=%s", url.c_str());
889 b->connect(url, error, addinfo, odr);
897 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
898 Odr_int number_to_present,
901 Odr_int *number_of_records_returned,
904 Odr_oid *preferredRecordSyntax,
905 const char *element_set_name)
907 *number_of_records_returned = 0;
908 Z_Records *records = 0;
909 bool enable_pz2_retrieval = false; // whether target profile is used
910 bool enable_pz2_transform = false; // whether XSLT is used as well
911 bool assume_marc8_charset = false;
913 if (start < 0 || number_to_present <= 0)
916 if (number_to_present > 10000)
917 number_to_present = 10000;
919 ZOOM_record *recs = (ZOOM_record *)
920 odr_malloc(odr, number_to_present * sizeof(*recs));
922 char oid_name_str[OID_STR_MAX];
923 const char *syntax_name = 0;
925 if (preferredRecordSyntax &&
926 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
929 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
931 enable_pz2_retrieval = true;
932 enable_pz2_transform = true;
934 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
936 enable_pz2_retrieval = true;
940 if (enable_pz2_retrieval)
942 if (b->sptr->request_syntax.length())
944 syntax_name = b->sptr->request_syntax.c_str();
945 const Odr_oid *syntax_oid =
946 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
947 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
948 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
949 assume_marc8_charset = true;
952 else if (preferredRecordSyntax)
954 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
956 b->set_option("preferredRecordSyntax", syntax_name);
958 if (enable_pz2_retrieval)
960 element_set_name = 0;
961 if (b->sptr->element_set.length())
962 element_set_name = b->sptr->element_set.c_str();
965 b->set_option("elementSetName", element_set_name);
967 b->present(start, number_to_present, recs, error, addinfo, odr);
972 for (i = 0; i < number_to_present; i++)
977 { // only return records if no error and at least one record
978 char *odr_database = odr_strdup(odr,
979 b->m_frontend_database.c_str());
980 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
981 odr_malloc(odr, sizeof(*npl));
982 *number_of_records_returned = i;
983 npl->num_records = i;
984 npl->records = (Z_NamePlusRecord **)
985 odr_malloc(odr, i * sizeof(*npl->records));
986 for (i = 0; i < number_to_present; i++)
988 Z_NamePlusRecord *npr = 0;
990 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
991 &addinfo, 0 /* diagset */);
995 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
998 else if (enable_pz2_retrieval)
1000 char rec_type_str[100];
1001 const char *record_encoding = 0;
1003 if (b->sptr->record_encoding.length())
1004 record_encoding = b->sptr->record_encoding.c_str();
1005 else if (assume_marc8_charset)
1006 record_encoding = "marc8";
1008 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1009 if (record_encoding)
1011 strcat(rec_type_str, "; charset=");
1012 strcat(rec_type_str, record_encoding);
1016 xmlChar *xmlrec_buf = 0;
1017 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1019 if (!rec_buf && !npr)
1021 std::string addinfo("ZOOM_record_get failed for type ");
1023 addinfo += rec_type_str;
1024 npr = zget_surrogateDiagRec(
1026 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1030 if (rec_buf && b->xsp && enable_pz2_transform)
1032 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1035 npr = zget_surrogateDiagRec(
1037 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1038 "xml parse failed for record");
1043 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1047 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1049 rec_buf = (const char *) xmlrec_buf;
1051 xmlFreeDoc(rec_res);
1055 std::string addinfo;
1057 addinfo = "xslt apply failed for "
1058 + b->sptr->transform_xsl_fname;
1059 npr = zget_surrogateDiagRec(
1061 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1064 xmlFreeDoc(rec_doc);
1070 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1072 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1073 if (res.length() && b->content_session_id.length())
1075 size_t off = res.find_first_of("://");
1076 if (off != std::string::npos)
1079 sprintf(tmp, "%s.%s/",
1080 b->content_session_id.c_str(),
1081 m_p->content_proxy_server.c_str());
1082 res.insert(off + 3, tmp);
1087 xmlNode *ptr = xmlDocGetRootElement(doc);
1088 while (ptr && ptr->type != XML_ELEMENT_NODE)
1091 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1092 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1096 xmlFree(xmlrec_buf);
1098 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1099 rec_buf = (const char *) xmlrec_buf;
1106 npr = zget_surrogateDiagRec(
1108 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1112 npr = (Z_NamePlusRecord *)
1113 odr_malloc(odr, sizeof(*npr));
1114 npr->databaseName = odr_database;
1115 npr->which = Z_NamePlusRecord_databaseRecord;
1116 npr->u.databaseRecord =
1117 z_ext_record_xml(odr, rec_buf, rec_len);
1121 xmlFree(xmlrec_buf);
1126 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1129 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1130 npr->databaseName = odr_database;
1131 npr->which = Z_NamePlusRecord_databaseRecord;
1132 npr->u.databaseRecord = ext;
1136 npr = zget_surrogateDiagRec(
1138 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1139 "ZOOM_record, type ext");
1142 npl->records[i] = npr;
1144 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1145 records->which = Z_Records_DBOSD;
1146 records->u.databaseOrSurDiagnostics = npl;
1151 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1154 struct cql_node *r = 0;
1162 std::map<std::string,std::string>::const_iterator it;
1163 it = fieldmap.find(cn->u.st.index);
1164 if (it == fieldmap.end())
1166 if (it->second.length())
1167 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1173 r = convert_cql_fields(cn->u.boolean.left, odr);
1175 r = convert_cql_fields(cn->u.boolean.right, odr);
1178 r = convert_cql_fields(cn->u.sort.search, odr);
1184 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1186 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1187 /* see cql_sortby_to_sortkeys of YAZ. */
1189 int num_sortspec = 0;
1191 NMEM nmem = nmem_create();
1194 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1195 if (num_sortspec > 0)
1197 WRBUF w = wrbuf_alloc();
1198 for (i = 0; i < num_sortspec; i++)
1203 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1205 if (num_arg > 2 && arg[2][0])
1206 ascending = atoi(arg[2]);
1208 wrbuf_puts(w, "@or @attr 1=");
1209 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1210 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1214 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1215 wrbuf_rewind(pqf_wrbuf);
1216 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1223 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1225 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1226 /* see cql_sortby_to_sortkeys of YAZ. */
1228 int num_sortspec = 0;
1230 NMEM nmem = nmem_create();
1233 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1234 if (num_sortspec > 0)
1236 WRBUF w = wrbuf_alloc();
1237 for (i = 0; i < num_sortspec; i++)
1242 int case_sensitive = 0;
1243 const char *missing = 0;
1244 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1246 if (num_arg > 2 && arg[2][0])
1247 ascending = atoi(arg[2]);
1248 if (num_arg > 3 && arg[3][0])
1249 case_sensitive = atoi(arg[3]);
1250 if (num_arg > 4 && arg[4][0])
1255 wrbuf_puts(w, " sortby ");
1256 wrbuf_puts(w, arg[0]); /* field */
1258 wrbuf_puts(w, ascending ? "ascending" : "descending");
1260 wrbuf_puts(w, "/respectCase");
1263 if (!strcmp(missing, "omit"))
1264 wrbuf_puts(w, "/missingOmit");
1265 else if (!strcmp(missing, "abort"))
1266 wrbuf_puts(w, "/missingFail");
1267 else if (!strcmp(missing, "lowValue"))
1268 wrbuf_puts(w, "/missingLow");
1269 else if (!strcmp(missing, "highValue"))
1270 wrbuf_puts(w, "/missingHigh");
1274 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1280 #if YAZ_VERSIONL < 0x40206
1281 static void wrbuf_vp_puts(const char *buf, void *client_data)
1283 WRBUF b = (WRBUF) client_data;
1288 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1290 Z_GDU *gdu = package.request().get();
1291 Z_APDU *apdu_req = gdu->u.z3950;
1292 Z_APDU *apdu_res = 0;
1294 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1295 if (sr->num_databaseNames != 1)
1297 apdu_res = odr.create_searchResponse(
1298 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1299 package.response() = apdu_res;
1305 std::string db(sr->databaseNames[0]);
1306 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1310 odr.create_searchResponse(apdu_req, error, addinfo);
1311 package.response() = apdu_res;
1315 b->set_option("setname", "default");
1318 Z_Query *query = sr->query;
1319 WRBUF ccl_wrbuf = 0;
1320 WRBUF pqf_wrbuf = 0;
1321 std::string sru_sortkeys;
1323 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1326 pqf_wrbuf = wrbuf_alloc();
1327 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1329 else if (query->which == Z_Query_type_2)
1332 ccl_wrbuf = wrbuf_alloc();
1333 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1334 query->u.type_2->len);
1336 else if (query->which == Z_Query_type_104 &&
1337 query->u.type_104->which == Z_External_CQL)
1340 const char *cql = query->u.type_104->u.cql;
1341 CQL_parser cp = cql_parser_create();
1342 int r = cql_parser_string(cp, cql);
1345 cql_parser_destroy(cp);
1347 odr.create_searchResponse(apdu_req,
1348 YAZ_BIB1_MALFORMED_QUERY,
1349 "CQL syntax error");
1350 package.response() = apdu_res;
1353 struct cql_node *cn = cql_parser_result(cp);
1354 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1357 // hopefully we are getting a ptr to a index+relation+term node
1359 if (cn_error->which == CQL_NODE_ST)
1360 addinfo = cn_error->u.st.index;
1363 odr.create_searchResponse(apdu_req,
1364 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1366 package.response() = apdu_res;
1371 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1374 ccl_wrbuf = wrbuf_alloc();
1375 wrbuf_puts(ccl_wrbuf, ccl_buf);
1377 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1379 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1381 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1382 wrbuf_destroy(sru_sortkeys_wrbuf);
1384 cql_parser_destroy(cp);
1388 odr.create_searchResponse(apdu_req,
1389 YAZ_BIB1_MALFORMED_QUERY,
1390 "CQL to CCL conversion error");
1391 package.response() = apdu_res;
1398 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1399 package.response() = apdu_res;
1406 assert(pqf_wrbuf == 0);
1408 struct ccl_rpn_node *cn;
1409 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1410 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1412 wrbuf_destroy(ccl_wrbuf);
1415 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1416 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1420 case CCL_ERR_UNKNOWN_QUAL:
1421 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1423 case CCL_ERR_TRUNC_NOT_LEFT:
1424 case CCL_ERR_TRUNC_NOT_RIGHT:
1425 case CCL_ERR_TRUNC_NOT_BOTH:
1426 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1430 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1431 package.response() = apdu_res;
1434 pqf_wrbuf = wrbuf_alloc();
1435 ccl_pquery(pqf_wrbuf, cn);
1440 if (b->get_option("sru"))
1444 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1445 WRBUF wrb = wrbuf_alloc();
1447 if (!strcmp(b->get_option("sru"), "solr"))
1449 solr_transform_t cqlt = solr_transform_create();
1451 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1453 solr_transform_close(cqlt);
1457 cql_transform_t cqlt = cql_transform_create();
1459 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1461 cql_transform_close(cqlt);
1464 sort_via_cql(wrb, sru_sortkeys.c_str());
1468 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1469 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1473 wrbuf_destroy(pqf_wrbuf);
1477 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1478 "can not convert from RPN to CQL/SOLR");
1479 package.response() = apdu_res;
1485 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1487 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1488 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1489 wrbuf_destroy(pqf_wrbuf);
1492 const char *element_set_name = 0;
1493 Odr_int number_to_present = 0;
1495 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1497 Odr_int number_of_records_returned = 0;
1498 Z_Records *records = get_records(
1499 0, number_to_present, &error, &addinfo,
1500 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1502 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1505 apdu_res->u.searchResponse->records = records;
1506 apdu_res->u.searchResponse->numberOfRecordsReturned =
1507 odr_intdup(odr, number_of_records_returned);
1509 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1510 package.response() = apdu_res;
1513 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1515 Z_GDU *gdu = package.request().get();
1516 Z_APDU *apdu_req = gdu->u.z3950;
1517 Z_APDU *apdu_res = 0;
1518 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1523 package.response() = odr.create_presentResponse(
1524 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1527 const char *element_set_name = 0;
1528 Z_RecordComposition *comp = pr->recordComposition;
1529 if (comp && comp->which != Z_RecordComp_simple)
1531 package.response() = odr.create_presentResponse(
1533 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1536 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1537 element_set_name = comp->u.simple->u.generic;
1538 Odr_int number_of_records_returned = 0;
1541 Z_Records *records = get_records(
1542 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1543 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1544 pr->preferredRecordSyntax, element_set_name);
1546 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1549 apdu_res->u.presentResponse->records = records;
1550 apdu_res->u.presentResponse->numberOfRecordsReturned =
1551 odr_intdup(odr, number_of_records_returned);
1553 package.response() = apdu_res;
1556 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1558 Z_GDU *gdu = package.request().get();
1561 else if (gdu->which == Z_GDU_Z3950)
1563 Z_APDU *apdu_req = gdu->u.z3950;
1564 if (apdu_req->which == Z_APDU_initRequest)
1567 package.response() = odr.create_close(
1569 Z_Close_protocolError,
1572 else if (apdu_req->which == Z_APDU_searchRequest)
1574 handle_search(package);
1576 else if (apdu_req->which == Z_APDU_presentRequest)
1578 handle_present(package);
1583 package.response() = odr.create_close(
1585 Z_Close_protocolError,
1586 "zoom filter cannot handle this APDU");
1587 package.session().close();
1592 package.session().close();
1596 void yf::Zoom::Impl::process(mp::Package &package)
1598 FrontendPtr f = get_frontend(package);
1599 Z_GDU *gdu = package.request().get();
1601 if (f->m_is_virtual)
1603 f->handle_package(package);
1605 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1608 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1609 f->m_init_gdu = gdu;
1612 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1613 Z_InitResponse *resp = apdu->u.initResponse;
1616 static const int masks[] = {
1621 for (i = 0; masks[i] != -1; i++)
1622 if (ODR_MASK_GET(req->options, masks[i]))
1623 ODR_MASK_SET(resp->options, masks[i]);
1625 static const int versions[] = {
1626 Z_ProtocolVersion_1,
1627 Z_ProtocolVersion_2,
1628 Z_ProtocolVersion_3,
1631 for (i = 0; versions[i] != -1; i++)
1632 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1633 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1637 *resp->preferredMessageSize = *req->preferredMessageSize;
1638 *resp->maximumRecordSize = *req->maximumRecordSize;
1640 package.response() = apdu;
1641 f->m_is_virtual = true;
1646 release_frontend(package);
1650 static mp::filter::Base* filter_creator()
1652 return new mp::filter::Zoom;
1656 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1667 * c-file-style: "Stroustrup"
1668 * indent-tabs-mode: nil
1670 * vim: shiftwidth=4 tabstop=8 expandtab