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 transform_xsl_content;
70 std::string urlRecipe;
71 std::string contentConnector;
74 CCL_bibset ccl_bibset;
75 Searchable(CCL_bibset base);
78 class Zoom::Backend : boost::noncopyable {
80 friend class Frontend;
82 ZOOM_connection m_connection;
83 ZOOM_resultset m_resultset;
84 std::string m_frontend_database;
86 xsltStylesheetPtr xsp;
87 std::string content_session_id;
89 Backend(SearchablePtr sptr);
91 void connect(std::string zurl, int *error, char **addinfo,
93 void search_pqf(const char *pqf, Odr_int *hits,
94 int *error, char **addinfo, ODR odr);
95 void search_cql(const char *cql, Odr_int *hits,
96 int *error, char **addinfo, ODR odr);
97 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
98 int *error, char **addinfo, ODR odr);
99 void set_option(const char *name, const char *value);
100 void set_option(const char *name, std::string value);
101 const char *get_option(const char *name);
102 void get_zoom_error(int *error, char **addinfo, ODR odr);
104 class Zoom::Frontend : boost::noncopyable {
109 yazpp_1::GDU m_init_gdu;
110 BackendPtr m_backend;
111 void handle_package(mp::Package &package);
112 void handle_search(mp::Package &package);
113 void handle_present(mp::Package &package);
114 BackendPtr get_backend_from_databases(std::string &database,
120 void prepare_elements(BackendPtr b,
121 Odr_oid *preferredRecordSyntax,
122 const char *element_set_name,
123 bool &enable_pz2_retrieval,
124 bool &enable_pz2_transform,
125 bool &assume_marc8_charset);
127 Z_Records *get_records(Odr_int start,
128 Odr_int number_to_present,
131 Odr_int *number_of_records_returned,
132 ODR odr, BackendPtr b,
133 Odr_oid *preferredRecordSyntax,
134 const char *element_set_name);
136 Frontend(Impl *impl);
140 friend class Frontend;
144 void process(metaproxy_1::Package & package);
145 void configure(const xmlNode * ptr, bool test_only,
148 void configure_local_records(const xmlNode * ptr, bool test_only);
149 FrontendPtr get_frontend(mp::Package &package);
150 void release_frontend(mp::Package &package);
151 SearchablePtr parse_torus_record(const xmlNode *ptr);
152 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
153 std::map<mp::Session, FrontendPtr> m_clients;
154 boost::mutex m_mutex;
155 boost::condition m_cond_session_ready;
156 std::string torus_url;
157 std::map<std::string,std::string> fieldmap;
159 std::string file_path;
160 std::string content_proxy_server;
161 std::string content_tmp_file;
164 std::string element_transform;
165 std::string element_raw;
167 std::map<std::string,SearchablePtr> s_map;
172 // define Pimpl wrapper forwarding to Impl
174 yf::Zoom::Zoom() : m_p(new Impl)
179 { // must have a destructor because of boost::scoped_ptr
182 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
185 m_p->configure(xmlnode, test_only, path);
188 void yf::Zoom::process(mp::Package &package) const
190 m_p->process(package);
194 // define Implementation stuff
196 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
198 m_connection = ZOOM_connection_create(0);
203 yf::Zoom::Backend::~Backend()
206 xsltFreeStylesheet(xsp);
207 ZOOM_connection_destroy(m_connection);
208 ZOOM_resultset_destroy(m_resultset);
212 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
216 const char *zoom_addinfo = 0;
217 const char *dset = 0;
218 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
221 if (*error >= ZOOM_ERROR_CONNECT)
223 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
224 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
225 *addinfo = (char *) odr_malloc(
226 odr, 20 + strlen(msg) +
227 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
228 strcpy(*addinfo, msg);
231 strcat(*addinfo, ": ");
232 strcat(*addinfo, zoom_addinfo);
233 strcat(*addinfo, " ");
238 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
239 *error = yaz_diag_srw_to_bib1(*error);
240 *addinfo = (char *) odr_malloc(
241 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
243 if (zoom_addinfo && *zoom_addinfo)
245 strcpy(*addinfo, zoom_addinfo);
246 strcat(*addinfo, " ");
248 strcat(*addinfo, "(backend)");
253 void yf::Zoom::Backend::connect(std::string zurl,
254 int *error, char **addinfo,
257 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
258 get_zoom_error(error, addinfo, odr);
261 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
262 int *error, char **addinfo, ODR odr)
264 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
265 get_zoom_error(error, addinfo, odr);
267 *hits = ZOOM_resultset_size(m_resultset);
272 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
273 int *error, char **addinfo, ODR odr)
275 ZOOM_query q = ZOOM_query_create();
277 ZOOM_query_cql(q, cql);
279 m_resultset = ZOOM_connection_search(m_connection, q);
280 ZOOM_query_destroy(q);
281 get_zoom_error(error, addinfo, odr);
283 *hits = ZOOM_resultset_size(m_resultset);
288 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
290 int *error, char **addinfo, ODR odr)
292 ZOOM_resultset_records(m_resultset, recs, start, number);
293 get_zoom_error(error, addinfo, odr);
296 void yf::Zoom::Backend::set_option(const char *name, const char *value)
298 ZOOM_connection_option_set(m_connection, name, value);
300 ZOOM_resultset_option_set(m_resultset, name, value);
303 void yf::Zoom::Backend::set_option(const char *name, std::string value)
305 set_option(name, value.c_str());
308 const char *yf::Zoom::Backend::get_option(const char *name)
310 return ZOOM_connection_option_get(m_connection, name);
313 yf::Zoom::Searchable::Searchable(CCL_bibset base)
316 use_turbomarc = true;
317 ccl_bibset = ccl_qual_dup(base);
320 yf::Zoom::Searchable::~Searchable()
322 ccl_qual_rm(&ccl_bibset);
325 yf::Zoom::Frontend::Frontend(Impl *impl) :
326 m_p(impl), m_is_virtual(false), m_in_use(true)
330 yf::Zoom::Frontend::~Frontend()
334 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
336 boost::mutex::scoped_lock lock(m_mutex);
338 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
342 it = m_clients.find(package.session());
343 if (it == m_clients.end())
346 if (!it->second->m_in_use)
348 it->second->m_in_use = true;
351 m_cond_session_ready.wait(lock);
353 FrontendPtr f(new Frontend(this));
354 m_clients[package.session()] = f;
359 void yf::Zoom::Impl::release_frontend(mp::Package &package)
361 boost::mutex::scoped_lock lock(m_mutex);
362 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
364 it = m_clients.find(package.session());
365 if (it != m_clients.end())
367 if (package.session().is_closed())
373 it->second->m_in_use = false;
375 m_cond_session_ready.notify_all();
379 yf::Zoom::Impl::Impl() :
380 apdu_log(false), element_transform("pz2") , element_raw("raw")
382 bibset = ccl_qual_mk();
384 srand((unsigned int) time(0));
387 yf::Zoom::Impl::~Impl()
389 ccl_qual_rm(&bibset);
392 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
394 Zoom::SearchablePtr s(new Searchable(bibset));
396 for (ptr = ptr->children; ptr; ptr = ptr->next)
398 if (ptr->type != XML_ELEMENT_NODE)
400 if (!strcmp((const char *) ptr->name, "layer"))
402 else if (!strcmp((const char *) ptr->name,
405 s->authentication = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name,
410 s->cfAuth = mp::xml::get_text(ptr);
412 else if (!strcmp((const char *) ptr->name,
415 s->cfProxy = mp::xml::get_text(ptr);
417 else if (!strcmp((const char *) ptr->name,
420 s->cfSubDb = mp::xml::get_text(ptr);
422 else if (!strcmp((const char *) ptr->name,
425 s->contentConnector = mp::xml::get_text(ptr);
427 else if (!strcmp((const char *) ptr->name, "udb"))
429 s->udb = mp::xml::get_text(ptr);
431 else if (!strcmp((const char *) ptr->name, "zurl"))
433 s->target = mp::xml::get_text(ptr);
435 else if (!strcmp((const char *) ptr->name, "sru"))
437 s->sru = mp::xml::get_text(ptr);
439 else if (!strcmp((const char *) ptr->name,
442 s->query_encoding = mp::xml::get_text(ptr);
444 else if (!strcmp((const char *) ptr->name,
447 s->piggyback = mp::xml::get_bool(ptr, true);
449 else if (!strcmp((const char *) ptr->name,
452 s->request_syntax = mp::xml::get_text(ptr);
454 else if (!strcmp((const char *) ptr->name,
457 s->element_set = mp::xml::get_text(ptr);
459 else if (!strcmp((const char *) ptr->name,
462 s->record_encoding = mp::xml::get_text(ptr);
464 else if (!strcmp((const char *) ptr->name,
467 s->transform_xsl_fname = mp::xml::get_text(ptr);
469 else if (!strcmp((const char *) ptr->name,
472 s->transform_xsl_content = mp::xml::get_text(ptr);
474 else if (!strcmp((const char *) ptr->name,
477 s->urlRecipe = mp::xml::get_text(ptr);
479 else if (!strcmp((const char *) ptr->name,
482 ; // useTurboMarc is ignored
484 else if (!strncmp((const char *) ptr->name,
487 std::string value = mp::xml::get_text(ptr);
488 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
489 (const char *) ptr->name + 7);
495 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
497 while (ptr && ptr->type != XML_ELEMENT_NODE)
502 if (!strcmp((const char *) ptr->name, "records"))
504 for (ptr = ptr->children; ptr; ptr = ptr->next)
506 if (ptr->type != XML_ELEMENT_NODE)
508 if (!strcmp((const char *) ptr->name, "record"))
510 SearchablePtr s = parse_torus_record(ptr);
513 std::string udb = s->udb;
518 throw mp::filter::FilterException
519 ("No udb for local torus record");
525 throw mp::filter::FilterException
527 + std::string((const char *) ptr->name)
528 + " in zoom filter inside element "
535 throw mp::filter::FilterException
537 + std::string((const char *) ptr->name)
538 + " in zoom filter inside element <torus>");
543 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
546 content_tmp_file = "/tmp/cf.XXXXXX.p";
551 for (ptr = ptr->children; ptr; ptr = ptr->next)
553 if (ptr->type != XML_ELEMENT_NODE)
555 else if (!strcmp((const char *) ptr->name, "torus"))
557 const struct _xmlAttr *attr;
558 for (attr = ptr->properties; attr; attr = attr->next)
560 if (!strcmp((const char *) attr->name, "url"))
561 torus_url = mp::xml::get_text(attr->children);
562 else if (!strcmp((const char *) attr->name, "xsldir"))
563 xsldir = mp::xml::get_text(attr->children);
564 else if (!strcmp((const char *) attr->name, "element_transform"))
565 element_transform = mp::xml::get_text(attr->children);
566 else if (!strcmp((const char *) attr->name, "element_raw"))
567 element_raw = mp::xml::get_text(attr->children);
568 else if (!strcmp((const char *) attr->name, "proxy"))
569 proxy = mp::xml::get_text(attr->children);
571 throw mp::filter::FilterException(
572 "Bad attribute " + std::string((const char *)
575 configure_local_records(ptr->children, test_only);
577 else if (!strcmp((const char *) ptr->name, "cclmap"))
579 const char *addinfo = 0;
580 ccl_xml_config(bibset, ptr, &addinfo);
582 else if (!strcmp((const char *) ptr->name, "fieldmap"))
584 const struct _xmlAttr *attr;
585 std::string ccl_field;
586 std::string cql_field;
587 for (attr = ptr->properties; attr; attr = attr->next)
589 if (!strcmp((const char *) attr->name, "ccl"))
590 ccl_field = mp::xml::get_text(attr->children);
591 else if (!strcmp((const char *) attr->name, "cql"))
592 cql_field = mp::xml::get_text(attr->children);
594 throw mp::filter::FilterException(
595 "Bad attribute " + std::string((const char *)
598 if (cql_field.length())
599 fieldmap[cql_field] = ccl_field;
601 else if (!strcmp((const char *) ptr->name, "contentProxy"))
603 const struct _xmlAttr *attr;
604 for (attr = ptr->properties; attr; attr = attr->next)
606 if (!strcmp((const char *) attr->name, "server"))
607 content_proxy_server = mp::xml::get_text(attr->children);
608 else if (!strcmp((const char *) attr->name, "tmp_file"))
609 content_tmp_file = mp::xml::get_text(attr->children);
611 throw mp::filter::FilterException(
612 "Bad attribute " + std::string((const char *)
616 else if (!strcmp((const char *) ptr->name, "log"))
618 const struct _xmlAttr *attr;
619 for (attr = ptr->properties; attr; attr = attr->next)
621 if (!strcmp((const char *) attr->name, "apdu"))
622 apdu_log = mp::xml::get_bool(attr->children, false);
624 throw mp::filter::FilterException(
625 "Bad attribute " + std::string((const char *)
631 throw mp::filter::FilterException
633 + std::string((const char *) ptr->name)
634 + " in zoom filter");
639 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
640 std::string &database, int *error, char **addinfo, ODR odr)
642 std::list<BackendPtr>::const_iterator map_it;
643 if (m_backend && m_backend->m_frontend_database == database)
647 std::string torus_db;
648 size_t db_arg_pos = database.find(',');
649 if (db_arg_pos != std::string::npos)
651 torus_db = database.substr(0, db_arg_pos);
652 db_args = database.substr(db_arg_pos + 1);
659 std::map<std::string,SearchablePtr>::iterator it;
660 it = m_p->s_map.find(torus_db);
661 if (it != m_p->s_map.end())
665 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, m_p->proxy);
668 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
669 *addinfo = odr_strdup(odr, database.c_str());
673 const xmlNode *ptr = xmlDocGetRootElement(doc);
675 { // presumably ptr is a records element node
676 // parse first record in document
677 for (ptr = ptr->children; ptr; ptr = ptr->next)
679 if (ptr->type == XML_ELEMENT_NODE
680 && !strcmp((const char *) ptr->name, "record"))
684 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
685 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
686 sprintf(*addinfo, "multiple records for udb=%s",
692 sptr = m_p->parse_torus_record(ptr);
701 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
702 *addinfo = odr_strdup(odr, database.c_str());
707 xsltStylesheetPtr xsp = 0;
708 if (sptr->transform_xsl_content.length())
710 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
711 sptr->transform_xsl_content.length());
714 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
715 *addinfo = (char *) odr_malloc(odr, 40);
716 sprintf(*addinfo, "xmlParseMemory failed");
720 xsp = xsltParseStylesheetDoc(xsp_doc);
723 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
724 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
730 else if (sptr->transform_xsl_fname.length())
732 const char *path = 0;
734 if (m_p->xsldir.length())
735 path = m_p->xsldir.c_str();
737 path = m_p->file_path.c_str();
741 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
747 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
749 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
750 sprintf(*addinfo, "File could not be read: %s",
751 sptr->transform_xsl_fname.c_str());
755 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
758 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
759 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
760 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
764 xsp = xsltParseStylesheetDoc(xsp_doc);
767 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
768 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
777 BackendPtr b(new Backend(sptr));
780 b->m_frontend_database = database;
782 if (sptr->query_encoding.length())
783 b->set_option("rpnCharset", sptr->query_encoding);
785 b->set_option("timeout", "40");
788 b->set_option("apdulog", "1");
791 b->set_option("count", "1"); /* some SRU servers INSIST on getting
792 maximumRecords > 0 */
793 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
795 std::string authentication = sptr->authentication;
796 std::string proxy = sptr->cfProxy;
798 const char *param_user = 0;
799 const char *param_password = 0;
800 const char *param_proxy = 0;
801 if (db_args.length())
806 int no_parms = yaz_uri_to_array(db_args.c_str(),
807 odr, &names, &values);
808 for (i = 0; i < no_parms; i++)
810 const char *name = names[i];
811 const char *value = values[i];
812 if (!strcmp(name, "user"))
814 else if (!strcmp(name, "password"))
815 param_password = value;
816 else if (!strcmp(name, "proxy"))
818 else if (!strcmp(name, "cproxysession"))
823 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
824 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
825 sprintf(msg, "Bad database argument: %s", name);
832 authentication = std::string(param_user);
834 authentication += "/" + std::string(param_password);
840 if (sptr->cfAuth.length())
843 b->set_option("user", sptr->cfAuth);
844 if (!param_user && !param_password && authentication.length())
846 if (db_args.length())
848 // no database (auth) args specified already.. and the
849 // Torus authentication has it.. Generate the args that CF
851 size_t found = authentication.find('/');
852 if (found != std::string::npos)
855 mp::util::uri_encode(authentication.substr(0, found))
857 mp::util::uri_encode(authentication.substr(found+1));
860 db_args += "user=" + mp::util::uri_encode(authentication);
862 if (!param_proxy && proxy.length())
864 if (db_args.length())
866 db_args += "proxy=" + mp::util::uri_encode(proxy);
868 if (sptr->cfSubDb.length())
870 if (db_args.length())
872 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
877 db_args.clear(); // no arguments to be passed (non-CF)
879 size_t found = authentication.find('/');
881 if (sptr->sru.length() && found != std::string::npos)
883 b->set_option("user", authentication.substr(0, found));
884 b->set_option("password", authentication.substr(found+1));
887 b->set_option("user", authentication);
890 b->set_option("proxy", proxy);
892 if (b->sptr->contentConnector.length())
894 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
895 strcpy(fname, m_p->content_tmp_file.c_str());
896 char *xx = strstr(fname, "XXXXXX");
899 xx = fname + strlen(fname);
900 strcat(fname, "XXXXXX");
902 char tmp_char = xx[6];
903 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
906 FILE *file = fopen(fname, "w");
909 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
910 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
911 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
912 sprintf(*addinfo, "Could not create %s", fname);
914 BackendPtr backend_null;
917 b->content_session_id.assign(xx, 6);
918 WRBUF w = wrbuf_alloc();
919 wrbuf_puts(w, "#content_proxy\n");
920 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
921 if (authentication.length())
922 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
924 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
925 if (sptr->cfProxy.length())
926 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
928 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
930 yaz_log(YLOG_LOG, "file %s created\n", fname);
935 if (sptr->sru.length())
937 url = "http://" + sptr->target;
938 b->set_option("sru", sptr->sru);
944 if (db_args.length())
945 url += "," + db_args;
946 yaz_log(YLOG_LOG, "url=%s", url.c_str());
947 b->connect(url, error, addinfo, odr);
955 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
956 Odr_oid *preferredRecordSyntax,
957 const char *element_set_name,
958 bool &enable_pz2_retrieval,
959 bool &enable_pz2_transform,
960 bool &assume_marc8_charset)
963 char oid_name_str[OID_STR_MAX];
964 const char *syntax_name = 0;
966 if (preferredRecordSyntax &&
967 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
970 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
972 enable_pz2_retrieval = true;
973 enable_pz2_transform = true;
975 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
977 enable_pz2_retrieval = true;
981 if (enable_pz2_retrieval)
983 std::string configured_request_syntax = b->sptr->request_syntax;
984 if (configured_request_syntax.length())
986 syntax_name = configured_request_syntax.c_str();
987 const Odr_oid *syntax_oid =
988 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
989 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
990 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
991 assume_marc8_charset = true;
994 else if (preferredRecordSyntax)
996 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
998 if (b->sptr->sru.length())
1001 b->set_option("preferredRecordSyntax", syntax_name);
1003 if (enable_pz2_retrieval)
1005 element_set_name = 0;
1006 if (b->sptr->element_set.length())
1007 element_set_name = b->sptr->element_set.c_str();
1010 b->set_option("elementSetName", element_set_name);
1011 if (b->sptr->sru.length() && element_set_name)
1012 b->set_option("schema", element_set_name);
1015 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
1016 Odr_int number_to_present,
1019 Odr_int *number_of_records_returned,
1022 Odr_oid *preferredRecordSyntax,
1023 const char *element_set_name)
1025 *number_of_records_returned = 0;
1026 Z_Records *records = 0;
1027 bool enable_pz2_retrieval = false; // whether target profile is used
1028 bool enable_pz2_transform = false; // whether XSLT is used as well
1029 bool assume_marc8_charset = false;
1031 prepare_elements(b, preferredRecordSyntax,
1033 enable_pz2_retrieval,
1034 enable_pz2_transform,
1035 assume_marc8_charset);
1037 if (start < 0 || number_to_present <=0)
1040 if (number_to_present > 10000)
1041 number_to_present = 10000;
1043 ZOOM_record *recs = (ZOOM_record *)
1044 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1046 b->present(start, number_to_present, recs, error, addinfo, odr);
1051 for (i = 0; i < number_to_present; i++)
1056 { // only return records if no error and at least one record
1057 char *odr_database = odr_strdup(odr,
1058 b->m_frontend_database.c_str());
1059 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1060 odr_malloc(odr, sizeof(*npl));
1061 *number_of_records_returned = i;
1062 npl->num_records = i;
1063 npl->records = (Z_NamePlusRecord **)
1064 odr_malloc(odr, i * sizeof(*npl->records));
1065 for (i = 0; i < number_to_present; i++)
1067 Z_NamePlusRecord *npr = 0;
1068 const char *addinfo;
1069 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1070 &addinfo, 0 /* diagset */);
1074 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1077 else if (enable_pz2_retrieval)
1079 char rec_type_str[100];
1080 const char *record_encoding = 0;
1082 if (b->sptr->record_encoding.length())
1083 record_encoding = b->sptr->record_encoding.c_str();
1084 else if (assume_marc8_charset)
1085 record_encoding = "marc8";
1087 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1088 if (record_encoding)
1090 strcat(rec_type_str, "; charset=");
1091 strcat(rec_type_str, record_encoding);
1095 xmlChar *xmlrec_buf = 0;
1096 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1098 if (!rec_buf && !npr)
1100 std::string addinfo("ZOOM_record_get failed for type ");
1102 addinfo += rec_type_str;
1103 npr = zget_surrogateDiagRec(
1105 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1109 if (rec_buf && b->xsp && enable_pz2_transform)
1111 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1114 npr = zget_surrogateDiagRec(
1116 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1117 "xml parse failed for record");
1122 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1126 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1128 rec_buf = (const char *) xmlrec_buf;
1130 xmlFreeDoc(rec_res);
1134 std::string addinfo;
1136 addinfo = "xslt apply failed for "
1137 + b->sptr->transform_xsl_fname;
1138 npr = zget_surrogateDiagRec(
1140 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1143 xmlFreeDoc(rec_doc);
1149 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1151 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1152 if (res.length() && b->content_session_id.length())
1154 size_t off = res.find_first_of("://");
1155 if (off != std::string::npos)
1158 sprintf(tmp, "%s.%s/",
1159 b->content_session_id.c_str(),
1160 m_p->content_proxy_server.c_str());
1161 res.insert(off + 3, tmp);
1166 xmlNode *ptr = xmlDocGetRootElement(doc);
1167 while (ptr && ptr->type != XML_ELEMENT_NODE)
1170 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1171 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1175 xmlFree(xmlrec_buf);
1177 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1178 rec_buf = (const char *) xmlrec_buf;
1185 npr = zget_surrogateDiagRec(
1187 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1191 npr = (Z_NamePlusRecord *)
1192 odr_malloc(odr, sizeof(*npr));
1193 npr->databaseName = odr_database;
1194 npr->which = Z_NamePlusRecord_databaseRecord;
1195 npr->u.databaseRecord =
1196 z_ext_record_xml(odr, rec_buf, rec_len);
1200 xmlFree(xmlrec_buf);
1205 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1208 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1209 npr->databaseName = odr_database;
1210 npr->which = Z_NamePlusRecord_databaseRecord;
1211 npr->u.databaseRecord = ext;
1215 npr = zget_surrogateDiagRec(
1217 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1218 "ZOOM_record, type ext");
1221 npl->records[i] = npr;
1223 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1224 records->which = Z_Records_DBOSD;
1225 records->u.databaseOrSurDiagnostics = npl;
1230 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1233 struct cql_node *r = 0;
1241 std::map<std::string,std::string>::const_iterator it;
1242 it = fieldmap.find(cn->u.st.index);
1243 if (it == fieldmap.end())
1245 if (it->second.length())
1246 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1252 r = convert_cql_fields(cn->u.boolean.left, odr);
1254 r = convert_cql_fields(cn->u.boolean.right, odr);
1257 r = convert_cql_fields(cn->u.sort.search, odr);
1263 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1265 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1266 /* see cql_sortby_to_sortkeys of YAZ. */
1268 int num_sortspec = 0;
1270 NMEM nmem = nmem_create();
1273 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1274 if (num_sortspec > 0)
1276 WRBUF w = wrbuf_alloc();
1277 for (i = 0; i < num_sortspec; i++)
1282 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1284 if (num_arg > 2 && arg[2][0])
1285 ascending = atoi(arg[2]);
1287 wrbuf_puts(w, "@or @attr 1=");
1288 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1289 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1293 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1294 wrbuf_rewind(pqf_wrbuf);
1295 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1302 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1304 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1305 /* see cql_sortby_to_sortkeys of YAZ. */
1307 int num_sortspec = 0;
1309 NMEM nmem = nmem_create();
1312 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1313 if (num_sortspec > 0)
1315 WRBUF w = wrbuf_alloc();
1316 for (i = 0; i < num_sortspec; i++)
1321 int case_sensitive = 0;
1322 const char *missing = 0;
1323 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1325 if (num_arg > 2 && arg[2][0])
1326 ascending = atoi(arg[2]);
1327 if (num_arg > 3 && arg[3][0])
1328 case_sensitive = atoi(arg[3]);
1329 if (num_arg > 4 && arg[4][0])
1334 wrbuf_puts(w, " sortby ");
1335 wrbuf_puts(w, arg[0]); /* field */
1337 wrbuf_puts(w, ascending ? "ascending" : "descending");
1339 wrbuf_puts(w, "/respectCase");
1342 if (!strcmp(missing, "omit"))
1343 wrbuf_puts(w, "/missingOmit");
1344 else if (!strcmp(missing, "abort"))
1345 wrbuf_puts(w, "/missingFail");
1346 else if (!strcmp(missing, "lowValue"))
1347 wrbuf_puts(w, "/missingLow");
1348 else if (!strcmp(missing, "highValue"))
1349 wrbuf_puts(w, "/missingHigh");
1353 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1359 #if YAZ_VERSIONL < 0x40206
1360 static void wrbuf_vp_puts(const char *buf, void *client_data)
1362 WRBUF b = (WRBUF) client_data;
1367 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1369 Z_GDU *gdu = package.request().get();
1370 Z_APDU *apdu_req = gdu->u.z3950;
1371 Z_APDU *apdu_res = 0;
1373 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1374 if (sr->num_databaseNames != 1)
1376 apdu_res = odr.create_searchResponse(
1377 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1378 package.response() = apdu_res;
1384 std::string db(sr->databaseNames[0]);
1385 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1389 odr.create_searchResponse(apdu_req, error, addinfo);
1390 package.response() = apdu_res;
1394 b->set_option("setname", "default");
1396 bool enable_pz2_retrieval = false;
1397 bool enable_pz2_transform = false;
1398 bool assume_marc8_charset = false;
1399 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1400 enable_pz2_retrieval,
1401 enable_pz2_transform,
1402 assume_marc8_charset);
1405 Z_Query *query = sr->query;
1406 WRBUF ccl_wrbuf = 0;
1407 WRBUF pqf_wrbuf = 0;
1408 std::string sru_sortkeys;
1410 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1413 pqf_wrbuf = wrbuf_alloc();
1414 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1416 else if (query->which == Z_Query_type_2)
1419 ccl_wrbuf = wrbuf_alloc();
1420 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1421 query->u.type_2->len);
1423 else if (query->which == Z_Query_type_104 &&
1424 query->u.type_104->which == Z_External_CQL)
1427 const char *cql = query->u.type_104->u.cql;
1428 CQL_parser cp = cql_parser_create();
1429 int r = cql_parser_string(cp, cql);
1432 cql_parser_destroy(cp);
1434 odr.create_searchResponse(apdu_req,
1435 YAZ_BIB1_MALFORMED_QUERY,
1436 "CQL syntax error");
1437 package.response() = apdu_res;
1440 struct cql_node *cn = cql_parser_result(cp);
1441 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1444 // hopefully we are getting a ptr to a index+relation+term node
1446 if (cn_error->which == CQL_NODE_ST)
1447 addinfo = cn_error->u.st.index;
1450 odr.create_searchResponse(apdu_req,
1451 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1453 package.response() = apdu_res;
1458 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1461 ccl_wrbuf = wrbuf_alloc();
1462 wrbuf_puts(ccl_wrbuf, ccl_buf);
1464 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1466 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1468 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1469 wrbuf_destroy(sru_sortkeys_wrbuf);
1471 cql_parser_destroy(cp);
1475 odr.create_searchResponse(apdu_req,
1476 YAZ_BIB1_MALFORMED_QUERY,
1477 "CQL to CCL conversion error");
1478 package.response() = apdu_res;
1485 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1486 package.response() = apdu_res;
1493 assert(pqf_wrbuf == 0);
1495 struct ccl_rpn_node *cn;
1496 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1497 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1499 wrbuf_destroy(ccl_wrbuf);
1502 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1503 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1507 case CCL_ERR_UNKNOWN_QUAL:
1508 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1510 case CCL_ERR_TRUNC_NOT_LEFT:
1511 case CCL_ERR_TRUNC_NOT_RIGHT:
1512 case CCL_ERR_TRUNC_NOT_BOTH:
1513 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1517 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1518 package.response() = apdu_res;
1521 pqf_wrbuf = wrbuf_alloc();
1522 ccl_pquery(pqf_wrbuf, cn);
1523 yaz_log(YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1528 if (b->get_option("sru"))
1532 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1533 WRBUF wrb = wrbuf_alloc();
1535 if (!strcmp(b->get_option("sru"), "solr"))
1537 solr_transform_t cqlt = solr_transform_create();
1539 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1541 solr_transform_close(cqlt);
1545 cql_transform_t cqlt = cql_transform_create();
1547 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1549 cql_transform_close(cqlt);
1552 sort_via_cql(wrb, sru_sortkeys.c_str());
1556 yaz_log(YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1557 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1561 wrbuf_destroy(pqf_wrbuf);
1565 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1566 "can not convert from RPN to CQL/SOLR");
1567 package.response() = apdu_res;
1573 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1575 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1576 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1577 wrbuf_destroy(pqf_wrbuf);
1580 const char *element_set_name = 0;
1581 Odr_int number_to_present = 0;
1583 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1585 Odr_int number_of_records_returned = 0;
1586 Z_Records *records = get_records(
1587 0, number_to_present, &error, &addinfo,
1588 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1590 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1593 apdu_res->u.searchResponse->records = records;
1594 apdu_res->u.searchResponse->numberOfRecordsReturned =
1595 odr_intdup(odr, number_of_records_returned);
1597 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1598 package.response() = apdu_res;
1601 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1603 Z_GDU *gdu = package.request().get();
1604 Z_APDU *apdu_req = gdu->u.z3950;
1605 Z_APDU *apdu_res = 0;
1606 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1611 package.response() = odr.create_presentResponse(
1612 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1615 const char *element_set_name = 0;
1616 Z_RecordComposition *comp = pr->recordComposition;
1617 if (comp && comp->which != Z_RecordComp_simple)
1619 package.response() = odr.create_presentResponse(
1621 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1624 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1625 element_set_name = comp->u.simple->u.generic;
1626 Odr_int number_of_records_returned = 0;
1629 Z_Records *records = get_records(
1630 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1631 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1632 pr->preferredRecordSyntax, element_set_name);
1634 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1637 apdu_res->u.presentResponse->records = records;
1638 apdu_res->u.presentResponse->numberOfRecordsReturned =
1639 odr_intdup(odr, number_of_records_returned);
1641 package.response() = apdu_res;
1644 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1646 Z_GDU *gdu = package.request().get();
1649 else if (gdu->which == Z_GDU_Z3950)
1651 Z_APDU *apdu_req = gdu->u.z3950;
1652 if (apdu_req->which == Z_APDU_initRequest)
1655 package.response() = odr.create_close(
1657 Z_Close_protocolError,
1660 else if (apdu_req->which == Z_APDU_searchRequest)
1662 handle_search(package);
1664 else if (apdu_req->which == Z_APDU_presentRequest)
1666 handle_present(package);
1671 package.response() = odr.create_close(
1673 Z_Close_protocolError,
1674 "zoom filter cannot handle this APDU");
1675 package.session().close();
1680 package.session().close();
1684 void yf::Zoom::Impl::process(mp::Package &package)
1686 FrontendPtr f = get_frontend(package);
1687 Z_GDU *gdu = package.request().get();
1689 if (f->m_is_virtual)
1691 f->handle_package(package);
1693 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1696 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1697 f->m_init_gdu = gdu;
1700 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1701 Z_InitResponse *resp = apdu->u.initResponse;
1704 static const int masks[] = {
1709 for (i = 0; masks[i] != -1; i++)
1710 if (ODR_MASK_GET(req->options, masks[i]))
1711 ODR_MASK_SET(resp->options, masks[i]);
1713 static const int versions[] = {
1714 Z_ProtocolVersion_1,
1715 Z_ProtocolVersion_2,
1716 Z_ProtocolVersion_3,
1719 for (i = 0; versions[i] != -1; i++)
1720 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1721 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1725 *resp->preferredMessageSize = *req->preferredMessageSize;
1726 *resp->maximumRecordSize = *req->maximumRecordSize;
1728 package.response() = apdu;
1729 f->m_is_virtual = true;
1734 release_frontend(package);
1738 static mp::filter::Base* filter_creator()
1740 return new mp::filter::Zoom;
1744 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1755 * c-file-style: "Stroustrup"
1756 * indent-tabs-mode: nil
1758 * vim: shiftwidth=4 tabstop=8 expandtab