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
22 #include <sys/types.h>
23 #include "filter_zoom.hpp"
25 #include <yaz/yaz-version.h>
26 #include <yaz/tpath.h>
28 #include <metaproxy/package.hpp>
29 #include <metaproxy/util.hpp>
30 #include <metaproxy/xmlutil.hpp>
33 #include <libxslt/xsltutils.h>
34 #include <libxslt/transform.h>
36 #include <boost/thread/mutex.hpp>
37 #include <boost/thread/condition.hpp>
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>
50 namespace mp = metaproxy_1;
51 namespace yf = mp::filter;
53 namespace metaproxy_1 {
55 class Zoom::Searchable : boost::noncopyable {
57 std::string authentication;
63 std::string query_encoding;
65 std::string request_syntax;
66 std::string element_set;
67 std::string record_encoding;
68 std::string transform_xsl_fname;
69 std::string urlRecipe;
70 std::string contentConnector;
73 CCL_bibset ccl_bibset;
74 Searchable(CCL_bibset base);
77 class Zoom::Backend : boost::noncopyable {
79 friend class Frontend;
81 ZOOM_connection m_connection;
82 ZOOM_resultset m_resultset;
83 std::string m_frontend_database;
85 xsltStylesheetPtr xsp;
86 std::string content_session_id;
88 Backend(SearchablePtr sptr);
90 void connect(std::string zurl, int *error, char **addinfo,
92 void search_pqf(const char *pqf, Odr_int *hits,
93 int *error, char **addinfo, ODR odr);
94 void search_cql(const char *cql, Odr_int *hits,
95 int *error, char **addinfo, ODR odr);
96 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
97 int *error, char **addinfo, ODR odr);
98 void set_option(const char *name, const char *value);
99 void set_option(const char *name, std::string value);
100 const char *get_option(const char *name);
101 void get_zoom_error(int *error, char **addinfo, ODR odr);
103 class Zoom::Frontend : boost::noncopyable {
108 yazpp_1::GDU m_init_gdu;
109 BackendPtr m_backend;
110 void handle_package(mp::Package &package);
111 void handle_search(mp::Package &package);
112 void handle_present(mp::Package &package);
113 BackendPtr get_backend_from_databases(std::string &database,
119 void prepare_elements(BackendPtr b,
120 Odr_oid *preferredRecordSyntax,
121 const char *element_set_name,
122 bool &enable_pz2_retrieval,
123 bool &enable_pz2_transform,
124 bool &assume_marc8_charset);
126 Z_Records *get_records(Odr_int start,
127 Odr_int number_to_present,
130 Odr_int *number_of_records_returned,
131 ODR odr, BackendPtr b,
132 Odr_oid *preferredRecordSyntax,
133 const char *element_set_name);
135 Frontend(Impl *impl);
139 friend class Frontend;
143 void process(metaproxy_1::Package & package);
144 void configure(const xmlNode * ptr, bool test_only,
147 void configure_local_records(const xmlNode * ptr, bool test_only);
148 FrontendPtr get_frontend(mp::Package &package);
149 void release_frontend(mp::Package &package);
150 SearchablePtr parse_torus_record(const xmlNode *ptr);
151 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
152 std::map<mp::Session, FrontendPtr> m_clients;
153 boost::mutex m_mutex;
154 boost::condition m_cond_session_ready;
155 std::string torus_url;
156 std::map<std::string,std::string> fieldmap;
158 std::string file_path;
159 std::string content_proxy_server;
160 std::string content_tmp_file;
163 std::string element_transform;
164 std::string element_raw;
166 std::map<std::string,SearchablePtr> s_map;
171 // define Pimpl wrapper forwarding to Impl
173 yf::Zoom::Zoom() : m_p(new Impl)
178 { // must have a destructor because of boost::scoped_ptr
181 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
184 m_p->configure(xmlnode, test_only, path);
187 void yf::Zoom::process(mp::Package &package) const
189 m_p->process(package);
193 // define Implementation stuff
195 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
197 m_connection = ZOOM_connection_create(0);
202 yf::Zoom::Backend::~Backend()
205 xsltFreeStylesheet(xsp);
206 ZOOM_connection_destroy(m_connection);
207 ZOOM_resultset_destroy(m_resultset);
211 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
215 const char *zoom_addinfo = 0;
216 const char *dset = 0;
217 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
220 if (*error >= ZOOM_ERROR_CONNECT)
222 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
223 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
224 *addinfo = (char *) odr_malloc(
225 odr, 20 + strlen(msg) +
226 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
227 strcpy(*addinfo, msg);
230 strcat(*addinfo, ": ");
231 strcat(*addinfo, zoom_addinfo);
232 strcat(*addinfo, " ");
237 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
238 *error = yaz_diag_srw_to_bib1(*error);
239 *addinfo = (char *) odr_malloc(
240 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
242 if (zoom_addinfo && *zoom_addinfo)
244 strcpy(*addinfo, zoom_addinfo);
245 strcat(*addinfo, " ");
247 strcat(*addinfo, "(backend)");
252 void yf::Zoom::Backend::connect(std::string zurl,
253 int *error, char **addinfo,
256 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
257 get_zoom_error(error, addinfo, odr);
260 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
261 int *error, char **addinfo, ODR odr)
263 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
264 get_zoom_error(error, addinfo, odr);
266 *hits = ZOOM_resultset_size(m_resultset);
271 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
272 int *error, char **addinfo, ODR odr)
274 ZOOM_query q = ZOOM_query_create();
276 ZOOM_query_cql(q, cql);
278 m_resultset = ZOOM_connection_search(m_connection, q);
279 ZOOM_query_destroy(q);
280 get_zoom_error(error, addinfo, odr);
282 *hits = ZOOM_resultset_size(m_resultset);
287 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
289 int *error, char **addinfo, ODR odr)
291 ZOOM_resultset_records(m_resultset, recs, start, number);
292 get_zoom_error(error, addinfo, odr);
295 void yf::Zoom::Backend::set_option(const char *name, const char *value)
297 ZOOM_connection_option_set(m_connection, name, value);
299 ZOOM_resultset_option_set(m_resultset, name, value);
302 void yf::Zoom::Backend::set_option(const char *name, std::string value)
304 set_option(name, value.c_str());
307 const char *yf::Zoom::Backend::get_option(const char *name)
309 return ZOOM_connection_option_get(m_connection, name);
312 yf::Zoom::Searchable::Searchable(CCL_bibset base)
315 use_turbomarc = true;
316 ccl_bibset = ccl_qual_dup(base);
319 yf::Zoom::Searchable::~Searchable()
321 ccl_qual_rm(&ccl_bibset);
324 yf::Zoom::Frontend::Frontend(Impl *impl) :
325 m_p(impl), m_is_virtual(false), m_in_use(true)
329 yf::Zoom::Frontend::~Frontend()
333 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
335 boost::mutex::scoped_lock lock(m_mutex);
337 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
341 it = m_clients.find(package.session());
342 if (it == m_clients.end())
345 if (!it->second->m_in_use)
347 it->second->m_in_use = true;
350 m_cond_session_ready.wait(lock);
352 FrontendPtr f(new Frontend(this));
353 m_clients[package.session()] = f;
358 void yf::Zoom::Impl::release_frontend(mp::Package &package)
360 boost::mutex::scoped_lock lock(m_mutex);
361 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
363 it = m_clients.find(package.session());
364 if (it != m_clients.end())
366 if (package.session().is_closed())
372 it->second->m_in_use = false;
374 m_cond_session_ready.notify_all();
378 yf::Zoom::Impl::Impl() :
379 apdu_log(false), element_transform("pz2") , element_raw("raw")
381 bibset = ccl_qual_mk();
383 srand((unsigned int) time(0));
386 yf::Zoom::Impl::~Impl()
388 ccl_qual_rm(&bibset);
391 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
393 Zoom::SearchablePtr s(new Searchable(bibset));
395 for (ptr = ptr->children; ptr; ptr = ptr->next)
397 if (ptr->type != XML_ELEMENT_NODE)
399 if (!strcmp((const char *) ptr->name, "layer"))
401 else if (!strcmp((const char *) ptr->name,
404 s->authentication = mp::xml::get_text(ptr);
406 else if (!strcmp((const char *) ptr->name,
409 s->cfAuth = mp::xml::get_text(ptr);
411 else if (!strcmp((const char *) ptr->name,
414 s->cfProxy = mp::xml::get_text(ptr);
416 else if (!strcmp((const char *) ptr->name,
419 s->cfSubDb = mp::xml::get_text(ptr);
421 else if (!strcmp((const char *) ptr->name,
424 s->contentConnector = mp::xml::get_text(ptr);
426 else if (!strcmp((const char *) ptr->name, "udb"))
428 s->udb = mp::xml::get_text(ptr);
430 else if (!strcmp((const char *) ptr->name, "zurl"))
432 s->target = mp::xml::get_text(ptr);
434 else if (!strcmp((const char *) ptr->name, "sru"))
436 s->sru = mp::xml::get_text(ptr);
438 else if (!strcmp((const char *) ptr->name,
441 s->query_encoding = mp::xml::get_text(ptr);
443 else if (!strcmp((const char *) ptr->name,
446 s->piggyback = mp::xml::get_bool(ptr, true);
448 else if (!strcmp((const char *) ptr->name,
451 s->request_syntax = mp::xml::get_text(ptr);
453 else if (!strcmp((const char *) ptr->name,
456 s->element_set = mp::xml::get_text(ptr);
458 else if (!strcmp((const char *) ptr->name,
461 s->record_encoding = mp::xml::get_text(ptr);
463 else if (!strcmp((const char *) ptr->name,
466 s->transform_xsl_fname = mp::xml::get_text(ptr);
468 else if (!strcmp((const char *) ptr->name,
471 s->urlRecipe = mp::xml::get_text(ptr);
473 else if (!strcmp((const char *) ptr->name,
476 ; // useTurboMarc is ignored
478 else if (!strncmp((const char *) ptr->name,
481 std::string value = mp::xml::get_text(ptr);
482 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
483 (const char *) ptr->name + 7);
489 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
491 while (ptr && ptr->type != XML_ELEMENT_NODE)
496 if (!strcmp((const char *) ptr->name, "records"))
498 for (ptr = ptr->children; ptr; ptr = ptr->next)
500 if (ptr->type != XML_ELEMENT_NODE)
502 if (!strcmp((const char *) ptr->name, "record"))
504 SearchablePtr s = parse_torus_record(ptr);
507 std::string udb = s->udb;
512 throw mp::filter::FilterException
513 ("No udb for local torus record");
519 throw mp::filter::FilterException
521 + std::string((const char *) ptr->name)
522 + " in zoom filter inside element "
529 throw mp::filter::FilterException
531 + std::string((const char *) ptr->name)
532 + " in zoom filter inside element <torus>");
537 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
540 content_tmp_file = "/tmp/cf.XXXXXX.p";
545 for (ptr = ptr->children; ptr; ptr = ptr->next)
547 if (ptr->type != XML_ELEMENT_NODE)
549 else if (!strcmp((const char *) ptr->name, "torus"))
551 const struct _xmlAttr *attr;
552 for (attr = ptr->properties; attr; attr = attr->next)
554 if (!strcmp((const char *) attr->name, "url"))
555 torus_url = mp::xml::get_text(attr->children);
556 else if (!strcmp((const char *) attr->name, "xsldir"))
557 xsldir = mp::xml::get_text(attr->children);
558 else if (!strcmp((const char *) attr->name, "element_transform"))
559 element_transform = mp::xml::get_text(attr->children);
560 else if (!strcmp((const char *) attr->name, "element_raw"))
561 element_raw = mp::xml::get_text(attr->children);
562 else if (!strcmp((const char *) attr->name, "proxy"))
563 proxy = mp::xml::get_text(attr->children);
565 throw mp::filter::FilterException(
566 "Bad attribute " + std::string((const char *)
569 configure_local_records(ptr->children, test_only);
571 else if (!strcmp((const char *) ptr->name, "cclmap"))
573 const char *addinfo = 0;
574 ccl_xml_config(bibset, ptr, &addinfo);
576 else if (!strcmp((const char *) ptr->name, "fieldmap"))
578 const struct _xmlAttr *attr;
579 std::string ccl_field;
580 std::string cql_field;
581 for (attr = ptr->properties; attr; attr = attr->next)
583 if (!strcmp((const char *) attr->name, "ccl"))
584 ccl_field = mp::xml::get_text(attr->children);
585 else if (!strcmp((const char *) attr->name, "cql"))
586 cql_field = mp::xml::get_text(attr->children);
588 throw mp::filter::FilterException(
589 "Bad attribute " + std::string((const char *)
592 if (cql_field.length())
593 fieldmap[cql_field] = ccl_field;
595 else if (!strcmp((const char *) ptr->name, "contentProxy"))
597 const struct _xmlAttr *attr;
598 for (attr = ptr->properties; attr; attr = attr->next)
600 if (!strcmp((const char *) attr->name, "server"))
601 content_proxy_server = mp::xml::get_text(attr->children);
602 else if (!strcmp((const char *) attr->name, "tmp_file"))
603 content_tmp_file = mp::xml::get_text(attr->children);
605 throw mp::filter::FilterException(
606 "Bad attribute " + std::string((const char *)
610 else if (!strcmp((const char *) ptr->name, "log"))
612 const struct _xmlAttr *attr;
613 for (attr = ptr->properties; attr; attr = attr->next)
615 if (!strcmp((const char *) attr->name, "apdu"))
616 apdu_log = mp::xml::get_bool(attr->children, false);
618 throw mp::filter::FilterException(
619 "Bad attribute " + std::string((const char *)
625 throw mp::filter::FilterException
627 + std::string((const char *) ptr->name)
628 + " in zoom filter");
633 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
634 std::string &database, int *error, char **addinfo, ODR odr)
636 std::list<BackendPtr>::const_iterator map_it;
637 if (m_backend && m_backend->m_frontend_database == database)
641 std::string torus_db;
642 size_t db_arg_pos = database.find(',');
643 if (db_arg_pos != std::string::npos)
645 torus_db = database.substr(0, db_arg_pos);
646 db_args = database.substr(db_arg_pos + 1);
653 std::map<std::string,SearchablePtr>::iterator it;
654 it = m_p->s_map.find(torus_db);
655 if (it != m_p->s_map.end())
659 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, m_p->proxy);
662 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
663 *addinfo = odr_strdup(odr, database.c_str());
667 const xmlNode *ptr = xmlDocGetRootElement(doc);
669 { // presumably ptr is a records element node
670 // parse first record in document
671 for (ptr = ptr->children; ptr; ptr = ptr->next)
673 if (ptr->type == XML_ELEMENT_NODE
674 && !strcmp((const char *) ptr->name, "record"))
678 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
679 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
680 sprintf(*addinfo, "multiple records for udb=%s",
686 sptr = m_p->parse_torus_record(ptr);
695 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
696 *addinfo = odr_strdup(odr, database.c_str());
701 xsltStylesheetPtr xsp = 0;
702 if (sptr->transform_xsl_fname.length())
704 const char *path = 0;
706 if (m_p->xsldir.length())
707 path = m_p->xsldir.c_str();
709 path = m_p->file_path.c_str();
713 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
719 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
721 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
722 sprintf(*addinfo, "File could not be read: %s",
723 sptr->transform_xsl_fname.c_str());
727 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
730 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
731 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
732 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
736 xsp = xsltParseStylesheetDoc(xsp_doc);
739 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
740 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
749 BackendPtr b(new Backend(sptr));
752 b->m_frontend_database = database;
754 if (sptr->query_encoding.length())
755 b->set_option("rpnCharset", sptr->query_encoding);
757 b->set_option("timeout", "40");
760 b->set_option("apdulog", "1");
763 b->set_option("count", "1"); /* some SRU servers INSIST on getting
764 maximumRecords > 0 */
765 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
767 std::string authentication = sptr->authentication;
768 std::string proxy = sptr->cfProxy;
770 const char *param_user = 0;
771 const char *param_password = 0;
772 const char *param_proxy = 0;
773 if (db_args.length())
778 int no_parms = yaz_uri_to_array(db_args.c_str(),
779 odr, &names, &values);
780 for (i = 0; i < no_parms; i++)
782 const char *name = names[i];
783 const char *value = values[i];
784 if (!strcmp(name, "user"))
786 else if (!strcmp(name, "password"))
787 param_password = value;
788 else if (!strcmp(name, "proxy"))
790 else if (!strcmp(name, "cproxysession"))
795 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
796 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
797 sprintf(msg, "Bad database argument: %s", name);
804 authentication = std::string(param_user);
806 authentication += "/" + std::string(param_password);
812 if (sptr->cfAuth.length())
815 b->set_option("user", sptr->cfAuth);
816 if (!param_user && !param_password && authentication.length())
818 if (db_args.length())
820 // no database (auth) args specified already.. and the
821 // Torus authentication has it.. Generate the args that CF
823 size_t found = authentication.find('/');
824 if (found != std::string::npos)
827 mp::util::uri_encode(authentication.substr(0, found))
829 mp::util::uri_encode(authentication.substr(found+1));
832 db_args += "user=" + mp::util::uri_encode(authentication);
834 if (!param_proxy && proxy.length())
836 if (db_args.length())
838 db_args += "proxy=" + mp::util::uri_encode(proxy);
840 if (sptr->cfSubDb.length())
842 if (db_args.length())
844 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
849 db_args.clear(); // no arguments to be passed (non-CF)
851 size_t found = authentication.find('/');
853 if (sptr->sru.length() && found != std::string::npos)
855 b->set_option("user", authentication.substr(0, found));
856 b->set_option("password", authentication.substr(found+1));
859 b->set_option("user", authentication);
862 b->set_option("proxy", proxy);
864 if (b->sptr->contentConnector.length())
866 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
867 strcpy(fname, m_p->content_tmp_file.c_str());
868 char *xx = strstr(fname, "XXXXXX");
871 xx = fname + strlen(fname);
872 strcat(fname, "XXXXXX");
874 char tmp_char = xx[6];
875 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
878 FILE *file = fopen(fname, "w");
881 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
882 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
883 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
884 sprintf(*addinfo, "Could not create %s", fname);
886 BackendPtr backend_null;
889 b->content_session_id.assign(xx, 6);
890 WRBUF w = wrbuf_alloc();
891 wrbuf_puts(w, "#content_proxy\n");
892 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
893 if (authentication.length())
894 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
896 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
897 if (sptr->cfProxy.length())
898 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
900 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
902 yaz_log(YLOG_LOG, "file %s created\n", fname);
907 if (sptr->sru.length())
909 url = "http://" + sptr->target;
910 b->set_option("sru", sptr->sru);
916 if (db_args.length())
917 url += "," + db_args;
918 yaz_log(YLOG_LOG, "url=%s", url.c_str());
919 b->connect(url, error, addinfo, odr);
927 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
928 Odr_oid *preferredRecordSyntax,
929 const char *element_set_name,
930 bool &enable_pz2_retrieval,
931 bool &enable_pz2_transform,
932 bool &assume_marc8_charset)
935 char oid_name_str[OID_STR_MAX];
936 const char *syntax_name = 0;
938 if (preferredRecordSyntax &&
939 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
942 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
944 enable_pz2_retrieval = true;
945 enable_pz2_transform = true;
947 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
949 enable_pz2_retrieval = true;
953 if (enable_pz2_retrieval)
955 std::string configured_request_syntax = b->sptr->request_syntax;
956 if (configured_request_syntax.length())
958 syntax_name = configured_request_syntax.c_str();
959 const Odr_oid *syntax_oid =
960 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
961 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
962 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
963 assume_marc8_charset = true;
966 else if (preferredRecordSyntax)
968 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
970 if (b->sptr->sru.length())
973 b->set_option("preferredRecordSyntax", syntax_name);
975 if (enable_pz2_retrieval)
977 element_set_name = 0;
978 if (b->sptr->element_set.length())
979 element_set_name = b->sptr->element_set.c_str();
982 b->set_option("elementSetName", element_set_name);
986 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
987 Odr_int number_to_present,
990 Odr_int *number_of_records_returned,
993 Odr_oid *preferredRecordSyntax,
994 const char *element_set_name)
996 *number_of_records_returned = 0;
997 Z_Records *records = 0;
998 bool enable_pz2_retrieval = false; // whether target profile is used
999 bool enable_pz2_transform = false; // whether XSLT is used as well
1000 bool assume_marc8_charset = false;
1002 prepare_elements(b, preferredRecordSyntax,
1004 enable_pz2_retrieval,
1005 enable_pz2_transform,
1006 assume_marc8_charset);
1008 if (start < 0 || number_to_present <=0)
1011 if (number_to_present > 10000)
1012 number_to_present = 10000;
1014 ZOOM_record *recs = (ZOOM_record *)
1015 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1017 b->present(start, number_to_present, recs, error, addinfo, odr);
1022 for (i = 0; i < number_to_present; i++)
1027 { // only return records if no error and at least one record
1028 char *odr_database = odr_strdup(odr,
1029 b->m_frontend_database.c_str());
1030 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1031 odr_malloc(odr, sizeof(*npl));
1032 *number_of_records_returned = i;
1033 npl->num_records = i;
1034 npl->records = (Z_NamePlusRecord **)
1035 odr_malloc(odr, i * sizeof(*npl->records));
1036 for (i = 0; i < number_to_present; i++)
1038 Z_NamePlusRecord *npr = 0;
1039 const char *addinfo;
1040 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1041 &addinfo, 0 /* diagset */);
1045 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1048 else if (enable_pz2_retrieval)
1050 char rec_type_str[100];
1051 const char *record_encoding = 0;
1053 if (b->sptr->record_encoding.length())
1054 record_encoding = b->sptr->record_encoding.c_str();
1055 else if (assume_marc8_charset)
1056 record_encoding = "marc8";
1058 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1059 if (record_encoding)
1061 strcat(rec_type_str, "; charset=");
1062 strcat(rec_type_str, record_encoding);
1066 xmlChar *xmlrec_buf = 0;
1067 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1069 if (!rec_buf && !npr)
1071 std::string addinfo("ZOOM_record_get failed for type ");
1073 addinfo += rec_type_str;
1074 npr = zget_surrogateDiagRec(
1076 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1080 if (rec_buf && b->xsp && enable_pz2_transform)
1082 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1085 npr = zget_surrogateDiagRec(
1087 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1088 "xml parse failed for record");
1093 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1097 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1099 rec_buf = (const char *) xmlrec_buf;
1101 xmlFreeDoc(rec_res);
1105 std::string addinfo;
1107 addinfo = "xslt apply failed for "
1108 + b->sptr->transform_xsl_fname;
1109 npr = zget_surrogateDiagRec(
1111 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1114 xmlFreeDoc(rec_doc);
1120 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1122 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1123 if (res.length() && b->content_session_id.length())
1125 size_t off = res.find_first_of("://");
1126 if (off != std::string::npos)
1129 sprintf(tmp, "%s.%s/",
1130 b->content_session_id.c_str(),
1131 m_p->content_proxy_server.c_str());
1132 res.insert(off + 3, tmp);
1137 xmlNode *ptr = xmlDocGetRootElement(doc);
1138 while (ptr && ptr->type != XML_ELEMENT_NODE)
1141 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1142 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1146 xmlFree(xmlrec_buf);
1148 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1149 rec_buf = (const char *) xmlrec_buf;
1156 npr = zget_surrogateDiagRec(
1158 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1162 npr = (Z_NamePlusRecord *)
1163 odr_malloc(odr, sizeof(*npr));
1164 npr->databaseName = odr_database;
1165 npr->which = Z_NamePlusRecord_databaseRecord;
1166 npr->u.databaseRecord =
1167 z_ext_record_xml(odr, rec_buf, rec_len);
1171 xmlFree(xmlrec_buf);
1176 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1179 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1180 npr->databaseName = odr_database;
1181 npr->which = Z_NamePlusRecord_databaseRecord;
1182 npr->u.databaseRecord = ext;
1186 npr = zget_surrogateDiagRec(
1188 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1189 "ZOOM_record, type ext");
1192 npl->records[i] = npr;
1194 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1195 records->which = Z_Records_DBOSD;
1196 records->u.databaseOrSurDiagnostics = npl;
1201 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1204 struct cql_node *r = 0;
1212 std::map<std::string,std::string>::const_iterator it;
1213 it = fieldmap.find(cn->u.st.index);
1214 if (it == fieldmap.end())
1216 if (it->second.length())
1217 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1223 r = convert_cql_fields(cn->u.boolean.left, odr);
1225 r = convert_cql_fields(cn->u.boolean.right, odr);
1228 r = convert_cql_fields(cn->u.sort.search, odr);
1234 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1236 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1237 /* see cql_sortby_to_sortkeys of YAZ. */
1239 int num_sortspec = 0;
1241 NMEM nmem = nmem_create();
1244 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1245 if (num_sortspec > 0)
1247 WRBUF w = wrbuf_alloc();
1248 for (i = 0; i < num_sortspec; i++)
1253 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1255 if (num_arg > 2 && arg[2][0])
1256 ascending = atoi(arg[2]);
1258 wrbuf_puts(w, "@or @attr 1=");
1259 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1260 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1264 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1265 wrbuf_rewind(pqf_wrbuf);
1266 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1273 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1275 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1276 /* see cql_sortby_to_sortkeys of YAZ. */
1278 int num_sortspec = 0;
1280 NMEM nmem = nmem_create();
1283 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1284 if (num_sortspec > 0)
1286 WRBUF w = wrbuf_alloc();
1287 for (i = 0; i < num_sortspec; i++)
1292 int case_sensitive = 0;
1293 const char *missing = 0;
1294 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1296 if (num_arg > 2 && arg[2][0])
1297 ascending = atoi(arg[2]);
1298 if (num_arg > 3 && arg[3][0])
1299 case_sensitive = atoi(arg[3]);
1300 if (num_arg > 4 && arg[4][0])
1305 wrbuf_puts(w, " sortby ");
1306 wrbuf_puts(w, arg[0]); /* field */
1308 wrbuf_puts(w, ascending ? "ascending" : "descending");
1310 wrbuf_puts(w, "/respectCase");
1313 if (!strcmp(missing, "omit"))
1314 wrbuf_puts(w, "/missingOmit");
1315 else if (!strcmp(missing, "abort"))
1316 wrbuf_puts(w, "/missingFail");
1317 else if (!strcmp(missing, "lowValue"))
1318 wrbuf_puts(w, "/missingLow");
1319 else if (!strcmp(missing, "highValue"))
1320 wrbuf_puts(w, "/missingHigh");
1324 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1330 #if YAZ_VERSIONL < 0x40206
1331 static void wrbuf_vp_puts(const char *buf, void *client_data)
1333 WRBUF b = (WRBUF) client_data;
1338 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1340 Z_GDU *gdu = package.request().get();
1341 Z_APDU *apdu_req = gdu->u.z3950;
1342 Z_APDU *apdu_res = 0;
1344 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1345 if (sr->num_databaseNames != 1)
1347 apdu_res = odr.create_searchResponse(
1348 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1349 package.response() = apdu_res;
1355 std::string db(sr->databaseNames[0]);
1356 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1360 odr.create_searchResponse(apdu_req, error, addinfo);
1361 package.response() = apdu_res;
1365 b->set_option("setname", "default");
1367 bool enable_pz2_retrieval = false;
1368 bool enable_pz2_transform = false;
1369 bool assume_marc8_charset = false;
1370 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1371 enable_pz2_retrieval,
1372 enable_pz2_transform,
1373 assume_marc8_charset);
1376 Z_Query *query = sr->query;
1377 WRBUF ccl_wrbuf = 0;
1378 WRBUF pqf_wrbuf = 0;
1379 std::string sru_sortkeys;
1381 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1384 pqf_wrbuf = wrbuf_alloc();
1385 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1387 else if (query->which == Z_Query_type_2)
1390 ccl_wrbuf = wrbuf_alloc();
1391 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1392 query->u.type_2->len);
1394 else if (query->which == Z_Query_type_104 &&
1395 query->u.type_104->which == Z_External_CQL)
1398 const char *cql = query->u.type_104->u.cql;
1399 CQL_parser cp = cql_parser_create();
1400 int r = cql_parser_string(cp, cql);
1403 cql_parser_destroy(cp);
1405 odr.create_searchResponse(apdu_req,
1406 YAZ_BIB1_MALFORMED_QUERY,
1407 "CQL syntax error");
1408 package.response() = apdu_res;
1411 struct cql_node *cn = cql_parser_result(cp);
1412 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1415 // hopefully we are getting a ptr to a index+relation+term node
1417 if (cn_error->which == CQL_NODE_ST)
1418 addinfo = cn_error->u.st.index;
1421 odr.create_searchResponse(apdu_req,
1422 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1424 package.response() = apdu_res;
1429 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1432 ccl_wrbuf = wrbuf_alloc();
1433 wrbuf_puts(ccl_wrbuf, ccl_buf);
1435 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1437 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1439 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1440 wrbuf_destroy(sru_sortkeys_wrbuf);
1442 cql_parser_destroy(cp);
1446 odr.create_searchResponse(apdu_req,
1447 YAZ_BIB1_MALFORMED_QUERY,
1448 "CQL to CCL conversion error");
1449 package.response() = apdu_res;
1456 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1457 package.response() = apdu_res;
1464 assert(pqf_wrbuf == 0);
1466 struct ccl_rpn_node *cn;
1467 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1468 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1470 wrbuf_destroy(ccl_wrbuf);
1473 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1474 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1478 case CCL_ERR_UNKNOWN_QUAL:
1479 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1481 case CCL_ERR_TRUNC_NOT_LEFT:
1482 case CCL_ERR_TRUNC_NOT_RIGHT:
1483 case CCL_ERR_TRUNC_NOT_BOTH:
1484 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1488 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1489 package.response() = apdu_res;
1492 pqf_wrbuf = wrbuf_alloc();
1493 ccl_pquery(pqf_wrbuf, cn);
1498 if (b->get_option("sru"))
1502 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1503 WRBUF wrb = wrbuf_alloc();
1505 if (!strcmp(b->get_option("sru"), "solr"))
1507 solr_transform_t cqlt = solr_transform_create();
1509 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1511 solr_transform_close(cqlt);
1515 cql_transform_t cqlt = cql_transform_create();
1517 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1519 cql_transform_close(cqlt);
1522 sort_via_cql(wrb, sru_sortkeys.c_str());
1526 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1527 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1531 wrbuf_destroy(pqf_wrbuf);
1535 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1536 "can not convert from RPN to CQL/SOLR");
1537 package.response() = apdu_res;
1543 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1545 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1546 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1547 wrbuf_destroy(pqf_wrbuf);
1550 const char *element_set_name = 0;
1551 Odr_int number_to_present = 0;
1553 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1555 Odr_int number_of_records_returned = 0;
1556 Z_Records *records = get_records(
1557 0, number_to_present, &error, &addinfo,
1558 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1560 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1563 apdu_res->u.searchResponse->records = records;
1564 apdu_res->u.searchResponse->numberOfRecordsReturned =
1565 odr_intdup(odr, number_of_records_returned);
1567 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1568 package.response() = apdu_res;
1571 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1573 Z_GDU *gdu = package.request().get();
1574 Z_APDU *apdu_req = gdu->u.z3950;
1575 Z_APDU *apdu_res = 0;
1576 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1581 package.response() = odr.create_presentResponse(
1582 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1585 const char *element_set_name = 0;
1586 Z_RecordComposition *comp = pr->recordComposition;
1587 if (comp && comp->which != Z_RecordComp_simple)
1589 package.response() = odr.create_presentResponse(
1591 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1594 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1595 element_set_name = comp->u.simple->u.generic;
1596 Odr_int number_of_records_returned = 0;
1599 Z_Records *records = get_records(
1600 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1601 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1602 pr->preferredRecordSyntax, element_set_name);
1604 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1607 apdu_res->u.presentResponse->records = records;
1608 apdu_res->u.presentResponse->numberOfRecordsReturned =
1609 odr_intdup(odr, number_of_records_returned);
1611 package.response() = apdu_res;
1614 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1616 Z_GDU *gdu = package.request().get();
1619 else if (gdu->which == Z_GDU_Z3950)
1621 Z_APDU *apdu_req = gdu->u.z3950;
1622 if (apdu_req->which == Z_APDU_initRequest)
1625 package.response() = odr.create_close(
1627 Z_Close_protocolError,
1630 else if (apdu_req->which == Z_APDU_searchRequest)
1632 handle_search(package);
1634 else if (apdu_req->which == Z_APDU_presentRequest)
1636 handle_present(package);
1641 package.response() = odr.create_close(
1643 Z_Close_protocolError,
1644 "zoom filter cannot handle this APDU");
1645 package.session().close();
1650 package.session().close();
1654 void yf::Zoom::Impl::process(mp::Package &package)
1656 FrontendPtr f = get_frontend(package);
1657 Z_GDU *gdu = package.request().get();
1659 if (f->m_is_virtual)
1661 f->handle_package(package);
1663 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1666 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1667 f->m_init_gdu = gdu;
1670 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1671 Z_InitResponse *resp = apdu->u.initResponse;
1674 static const int masks[] = {
1679 for (i = 0; masks[i] != -1; i++)
1680 if (ODR_MASK_GET(req->options, masks[i]))
1681 ODR_MASK_SET(resp->options, masks[i]);
1683 static const int versions[] = {
1684 Z_ProtocolVersion_1,
1685 Z_ProtocolVersion_2,
1686 Z_ProtocolVersion_3,
1689 for (i = 0; versions[i] != -1; i++)
1690 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1691 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1695 *resp->preferredMessageSize = *req->preferredMessageSize;
1696 *resp->maximumRecordSize = *req->maximumRecordSize;
1698 package.response() = apdu;
1699 f->m_is_virtual = true;
1704 release_frontend(package);
1708 static mp::filter::Base* filter_creator()
1710 return new mp::filter::Zoom;
1714 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1725 * c-file-style: "Stroustrup"
1726 * indent-tabs-mode: nil
1728 * vim: shiftwidth=4 tabstop=8 expandtab