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>
49 #include <yaz/sortspec.h>
50 #include <yaz/tokenizer.h>
52 namespace mp = metaproxy_1;
53 namespace yf = mp::filter;
55 namespace metaproxy_1 {
57 class Zoom::Searchable : boost::noncopyable {
59 std::string authentication;
65 std::string query_encoding;
67 std::string request_syntax;
68 std::string element_set;
69 std::string record_encoding;
70 std::string transform_xsl_fname;
71 std::string transform_xsl_content;
72 std::string urlRecipe;
73 std::string contentConnector;
74 std::string sortStrategy;
77 CCL_bibset ccl_bibset;
78 std::map<std::string, std::string> sortmap;
79 Searchable(CCL_bibset base);
82 class Zoom::Backend : boost::noncopyable {
84 friend class Frontend;
86 ZOOM_connection m_connection;
87 ZOOM_resultset m_resultset;
88 std::string m_frontend_database;
90 xsltStylesheetPtr xsp;
91 std::string content_session_id;
93 Backend(SearchablePtr sptr);
95 void connect(std::string zurl, int *error, char **addinfo,
97 void search(ZOOM_query q, Odr_int *hits,
98 int *error, char **addinfo, ODR odr);
99 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
100 int *error, char **addinfo, ODR odr);
101 void set_option(const char *name, const char *value);
102 void set_option(const char *name, std::string value);
103 const char *get_option(const char *name);
104 void get_zoom_error(int *error, char **addinfo, ODR odr);
106 class Zoom::Frontend : boost::noncopyable {
111 yazpp_1::GDU m_init_gdu;
112 BackendPtr m_backend;
113 void handle_package(mp::Package &package);
114 void handle_search(mp::Package &package);
115 void handle_present(mp::Package &package);
116 BackendPtr get_backend_from_databases(const mp::Package &package,
117 std::string &database,
123 void prepare_elements(BackendPtr b,
124 Odr_oid *preferredRecordSyntax,
125 const char *element_set_name,
126 bool &enable_pz2_retrieval,
127 bool &enable_pz2_transform,
128 bool &assume_marc8_charset);
130 Z_Records *get_records(Odr_int start,
131 Odr_int number_to_present,
134 Odr_int *number_of_records_returned,
135 ODR odr, BackendPtr b,
136 Odr_oid *preferredRecordSyntax,
137 const char *element_set_name);
139 Frontend(Impl *impl);
143 friend class Frontend;
147 void process(metaproxy_1::Package & package);
148 void configure(const xmlNode * ptr, bool test_only,
151 void configure_local_records(const xmlNode * ptr, bool test_only);
152 FrontendPtr get_frontend(mp::Package &package);
153 void release_frontend(mp::Package &package);
154 SearchablePtr parse_torus_record(const xmlNode *ptr);
155 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
156 std::map<mp::Session, FrontendPtr> m_clients;
157 boost::mutex m_mutex;
158 boost::condition m_cond_session_ready;
159 std::string torus_url;
160 std::string default_realm;
161 std::map<std::string,std::string> fieldmap;
163 std::string file_path;
164 std::string content_proxy_server;
165 std::string content_tmp_file;
168 std::string element_transform;
169 std::string element_raw;
171 std::map<std::string,SearchablePtr> s_map;
176 // define Pimpl wrapper forwarding to Impl
178 yf::Zoom::Zoom() : m_p(new Impl)
183 { // must have a destructor because of boost::scoped_ptr
186 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
189 m_p->configure(xmlnode, test_only, path);
192 void yf::Zoom::process(mp::Package &package) const
194 m_p->process(package);
198 // define Implementation stuff
200 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
202 m_connection = ZOOM_connection_create(0);
207 yf::Zoom::Backend::~Backend()
210 xsltFreeStylesheet(xsp);
211 ZOOM_connection_destroy(m_connection);
212 ZOOM_resultset_destroy(m_resultset);
216 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
220 const char *zoom_addinfo = 0;
221 const char *dset = 0;
222 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
225 if (*error >= ZOOM_ERROR_CONNECT)
227 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
228 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
229 *addinfo = (char *) odr_malloc(
230 odr, 20 + strlen(msg) +
231 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
232 strcpy(*addinfo, msg);
235 strcat(*addinfo, ": ");
236 strcat(*addinfo, zoom_addinfo);
237 strcat(*addinfo, " ");
242 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
243 *error = yaz_diag_srw_to_bib1(*error);
244 *addinfo = (char *) odr_malloc(
245 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
247 if (zoom_addinfo && *zoom_addinfo)
249 strcpy(*addinfo, zoom_addinfo);
250 strcat(*addinfo, " ");
252 strcat(*addinfo, "(backend)");
257 void yf::Zoom::Backend::connect(std::string zurl,
258 int *error, char **addinfo,
261 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
262 get_zoom_error(error, addinfo, odr);
265 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
266 int *error, char **addinfo, ODR odr)
268 m_resultset = ZOOM_connection_search(m_connection, q);
269 get_zoom_error(error, addinfo, odr);
271 *hits = ZOOM_resultset_size(m_resultset);
276 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
278 int *error, char **addinfo, ODR odr)
280 ZOOM_resultset_records(m_resultset, recs, start, number);
281 get_zoom_error(error, addinfo, odr);
284 void yf::Zoom::Backend::set_option(const char *name, const char *value)
286 ZOOM_connection_option_set(m_connection, name, value);
288 ZOOM_resultset_option_set(m_resultset, name, value);
291 void yf::Zoom::Backend::set_option(const char *name, std::string value)
293 set_option(name, value.c_str());
296 const char *yf::Zoom::Backend::get_option(const char *name)
298 return ZOOM_connection_option_get(m_connection, name);
301 yf::Zoom::Searchable::Searchable(CCL_bibset base)
304 use_turbomarc = true;
305 sortStrategy = "embed";
306 ccl_bibset = ccl_qual_dup(base);
309 yf::Zoom::Searchable::~Searchable()
311 ccl_qual_rm(&ccl_bibset);
314 yf::Zoom::Frontend::Frontend(Impl *impl) :
315 m_p(impl), m_is_virtual(false), m_in_use(true)
319 yf::Zoom::Frontend::~Frontend()
323 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
325 boost::mutex::scoped_lock lock(m_mutex);
327 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
331 it = m_clients.find(package.session());
332 if (it == m_clients.end())
335 if (!it->second->m_in_use)
337 it->second->m_in_use = true;
340 m_cond_session_ready.wait(lock);
342 FrontendPtr f(new Frontend(this));
343 m_clients[package.session()] = f;
348 void yf::Zoom::Impl::release_frontend(mp::Package &package)
350 boost::mutex::scoped_lock lock(m_mutex);
351 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
353 it = m_clients.find(package.session());
354 if (it != m_clients.end())
356 if (package.session().is_closed())
362 it->second->m_in_use = false;
364 m_cond_session_ready.notify_all();
368 yf::Zoom::Impl::Impl() :
369 apdu_log(false), element_transform("pz2") , element_raw("raw")
371 bibset = ccl_qual_mk();
373 srand((unsigned int) time(0));
376 yf::Zoom::Impl::~Impl()
378 ccl_qual_rm(&bibset);
381 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
383 Zoom::SearchablePtr s(new Searchable(bibset));
385 for (ptr = ptr->children; ptr; ptr = ptr->next)
387 if (ptr->type != XML_ELEMENT_NODE)
389 if (!strcmp((const char *) ptr->name, "layer"))
391 else if (!strcmp((const char *) ptr->name,
394 s->authentication = mp::xml::get_text(ptr);
396 else if (!strcmp((const char *) ptr->name,
399 s->cfAuth = mp::xml::get_text(ptr);
401 else if (!strcmp((const char *) ptr->name,
404 s->cfProxy = mp::xml::get_text(ptr);
406 else if (!strcmp((const char *) ptr->name,
409 s->cfSubDB = mp::xml::get_text(ptr);
411 else if (!strcmp((const char *) ptr->name,
414 s->contentConnector = mp::xml::get_text(ptr);
416 else if (!strcmp((const char *) ptr->name, "udb"))
418 s->udb = mp::xml::get_text(ptr);
420 else if (!strcmp((const char *) ptr->name, "zurl"))
422 s->target = mp::xml::get_text(ptr);
424 else if (!strcmp((const char *) ptr->name, "sru"))
426 s->sru = mp::xml::get_text(ptr);
428 else if (!strcmp((const char *) ptr->name,
431 s->query_encoding = mp::xml::get_text(ptr);
433 else if (!strcmp((const char *) ptr->name,
436 s->piggyback = mp::xml::get_bool(ptr, true);
438 else if (!strcmp((const char *) ptr->name,
441 s->request_syntax = mp::xml::get_text(ptr);
443 else if (!strcmp((const char *) ptr->name,
446 s->element_set = mp::xml::get_text(ptr);
448 else if (!strcmp((const char *) ptr->name,
451 s->record_encoding = mp::xml::get_text(ptr);
453 else if (!strcmp((const char *) ptr->name,
456 s->transform_xsl_fname = mp::xml::get_text(ptr);
458 else if (!strcmp((const char *) ptr->name,
461 s->transform_xsl_content = mp::xml::get_text(ptr);
463 else if (!strcmp((const char *) ptr->name,
466 s->urlRecipe = mp::xml::get_text(ptr);
468 else if (!strcmp((const char *) ptr->name,
471 ; // useTurboMarc is ignored
473 else if (!strncmp((const char *) ptr->name,
476 std::string value = mp::xml::get_text(ptr);
477 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
478 (const char *) ptr->name + 7);
480 else if (!strncmp((const char *) ptr->name,
483 std::string value = mp::xml::get_text(ptr);
484 s->sortmap[(const char *) ptr->name + 8] = value;
486 else if (!strcmp((const char *) ptr->name,
489 s->sortStrategy = mp::xml::get_text(ptr);
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, "realm"))
563 default_realm = mp::xml::get_text(attr->children);
564 else if (!strcmp((const char *) attr->name, "xsldir"))
565 xsldir = mp::xml::get_text(attr->children);
566 else if (!strcmp((const char *) attr->name, "element_transform"))
567 element_transform = mp::xml::get_text(attr->children);
568 else if (!strcmp((const char *) attr->name, "element_raw"))
569 element_raw = mp::xml::get_text(attr->children);
570 else if (!strcmp((const char *) attr->name, "proxy"))
571 proxy = mp::xml::get_text(attr->children);
573 throw mp::filter::FilterException(
574 "Bad attribute " + std::string((const char *)
577 configure_local_records(ptr->children, test_only);
579 else if (!strcmp((const char *) ptr->name, "cclmap"))
581 const char *addinfo = 0;
582 ccl_xml_config(bibset, ptr, &addinfo);
584 else if (!strcmp((const char *) ptr->name, "fieldmap"))
586 const struct _xmlAttr *attr;
587 std::string ccl_field;
588 std::string cql_field;
589 for (attr = ptr->properties; attr; attr = attr->next)
591 if (!strcmp((const char *) attr->name, "ccl"))
592 ccl_field = mp::xml::get_text(attr->children);
593 else if (!strcmp((const char *) attr->name, "cql"))
594 cql_field = mp::xml::get_text(attr->children);
596 throw mp::filter::FilterException(
597 "Bad attribute " + std::string((const char *)
600 if (cql_field.length())
601 fieldmap[cql_field] = ccl_field;
603 else if (!strcmp((const char *) ptr->name, "contentProxy"))
605 const struct _xmlAttr *attr;
606 for (attr = ptr->properties; attr; attr = attr->next)
608 if (!strcmp((const char *) attr->name, "server"))
609 content_proxy_server = mp::xml::get_text(attr->children);
610 else if (!strcmp((const char *) attr->name, "tmp_file"))
611 content_tmp_file = mp::xml::get_text(attr->children);
613 throw mp::filter::FilterException(
614 "Bad attribute " + std::string((const char *)
618 else if (!strcmp((const char *) ptr->name, "log"))
620 const struct _xmlAttr *attr;
621 for (attr = ptr->properties; attr; attr = attr->next)
623 if (!strcmp((const char *) attr->name, "apdu"))
624 apdu_log = mp::xml::get_bool(attr->children, false);
626 throw mp::filter::FilterException(
627 "Bad attribute " + std::string((const char *)
633 throw mp::filter::FilterException
635 + std::string((const char *) ptr->name)
636 + " in zoom filter");
641 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
642 const mp::Package &package,
643 std::string &database, int *error, char **addinfo, ODR odr)
645 std::list<BackendPtr>::const_iterator map_it;
646 if (m_backend && m_backend->m_frontend_database == database)
649 std::string input_args;
650 std::string torus_db;
651 size_t db_arg_pos = database.find(',');
652 if (db_arg_pos != std::string::npos)
654 torus_db = database.substr(0, db_arg_pos);
655 input_args = database.substr(db_arg_pos + 1);
660 std::string authentication;
662 std::string realm = m_p->default_realm;
664 const char *param_user = 0;
665 const char *param_password = 0;
671 if (input_args.length())
672 no_parms = yaz_uri_to_array(input_args.c_str(),
673 odr, &names, &values);
674 // adding 10 because we'll be adding other URL args
675 const char **out_names = (const char **)
676 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
677 const char **out_values = (const char **)
678 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
681 for (i = 0; i < no_parms; i++)
683 const char *name = names[i];
684 const char *value = values[i];
687 if (!strcmp(name, "user"))
689 else if (!strcmp(name, "password"))
690 param_password = value;
691 else if (!strcmp(name, "proxy"))
693 else if (!strcmp(name, "cproxysession"))
695 out_names[no_out_args] = name;
696 out_values[no_out_args++] = value;
698 else if (!strcmp(name, "realm"))
700 else if (name[0] == 'x' && name[1] == '-')
702 out_names[no_out_args] = name;
703 out_values[no_out_args++] = value;
708 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
709 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
710 sprintf(msg, "Bad database argument: %s", name);
717 authentication = std::string(param_user);
719 authentication += "/" + std::string(param_password);
723 std::map<std::string,SearchablePtr>::iterator it;
724 it = m_p->s_map.find(torus_db);
725 if (it != m_p->s_map.end())
727 else if (m_p->torus_url.length() > 0)
729 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm,
733 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
734 *addinfo = odr_strdup(odr, database.c_str());
738 const xmlNode *ptr = xmlDocGetRootElement(doc);
740 { // presumably ptr is a records element node
741 // parse first record in document
742 for (ptr = ptr->children; ptr; ptr = ptr->next)
744 if (ptr->type == XML_ELEMENT_NODE
745 && !strcmp((const char *) ptr->name, "record"))
749 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
750 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
751 sprintf(*addinfo, "multiple records for udb=%s",
757 sptr = m_p->parse_torus_record(ptr);
766 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
767 *addinfo = odr_strdup(odr, database.c_str());
772 xsltStylesheetPtr xsp = 0;
773 if (sptr->transform_xsl_content.length())
775 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
776 sptr->transform_xsl_content.length());
779 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
780 *addinfo = (char *) odr_malloc(odr, 40);
781 sprintf(*addinfo, "xmlParseMemory failed");
785 xsp = xsltParseStylesheetDoc(xsp_doc);
788 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
789 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
795 else if (sptr->transform_xsl_fname.length())
797 const char *path = 0;
799 if (m_p->xsldir.length())
800 path = m_p->xsldir.c_str();
802 path = m_p->file_path.c_str();
806 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
812 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
814 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
815 sprintf(*addinfo, "File could not be read: %s",
816 sptr->transform_xsl_fname.c_str());
820 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
823 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
824 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
825 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
829 xsp = xsltParseStylesheetDoc(xsp_doc);
832 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
833 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
842 BackendPtr b(new Backend(sptr));
845 b->m_frontend_database = database;
847 if (sptr->query_encoding.length())
848 b->set_option("rpnCharset", sptr->query_encoding);
850 b->set_option("timeout", "40");
853 b->set_option("apdulog", "1");
856 b->set_option("count", "1"); /* some SRU servers INSIST on getting
857 maximumRecords > 0 */
858 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
860 if (authentication.length() == 0)
861 authentication = sptr->authentication;
863 if (proxy.length() == 0)
864 proxy = sptr->cfProxy;
866 if (sptr->cfAuth.length())
869 b->set_option("user", sptr->cfAuth);
870 if (authentication.length())
872 size_t found = authentication.find('/');
873 if (found != std::string::npos)
875 out_names[no_out_args] = "user";
876 out_values[no_out_args++] =
877 odr_strdup(odr, authentication.substr(0, found).c_str());
879 out_names[no_out_args] = "password";
880 out_values[no_out_args++] =
881 odr_strdup(odr, authentication.substr(found+1).c_str());
885 out_names[no_out_args] = "user";
886 out_values[no_out_args++] =
887 odr_strdup(odr, authentication.c_str());
892 out_names[no_out_args] = "proxy";
893 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
895 if (sptr->cfSubDB.length())
897 out_names[no_out_args] = "subdatabase";
898 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
903 size_t found = authentication.find('/');
905 if (sptr->sru.length() && found != std::string::npos)
907 b->set_option("user", authentication.substr(0, found));
908 b->set_option("password", authentication.substr(found+1));
911 b->set_option("user", authentication);
914 b->set_option("proxy", proxy);
916 if (b->sptr->contentConnector.length())
918 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
919 strcpy(fname, m_p->content_tmp_file.c_str());
920 char *xx = strstr(fname, "XXXXXX");
923 xx = fname + strlen(fname);
924 strcat(fname, "XXXXXX");
926 char tmp_char = xx[6];
927 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
930 FILE *file = fopen(fname, "w");
933 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
934 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
935 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
936 sprintf(*addinfo, "Could not create %s", fname);
938 BackendPtr backend_null;
941 b->content_session_id.assign(xx, 6);
942 WRBUF w = wrbuf_alloc();
943 wrbuf_puts(w, "#content_proxy\n");
944 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
945 if (authentication.length())
946 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
948 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
949 if (sptr->cfProxy.length())
950 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
952 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
954 package.log("zoom", YLOG_LOG, "file %s created\n", fname);
959 if (sptr->sru.length())
961 url = "http://" + sptr->target;
962 b->set_option("sru", sptr->sru);
971 out_names[no_out_args] = 0; // terminate list
973 yaz_array_to_uri(&x_args, odr, (char **) out_names,
974 (char **) out_values);
975 url += "," + std::string(x_args);
977 package.log("zoom", YLOG_LOG, "url=%s", url.c_str());
978 b->connect(url, error, addinfo, odr);
986 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
987 Odr_oid *preferredRecordSyntax,
988 const char *element_set_name,
989 bool &enable_pz2_retrieval,
990 bool &enable_pz2_transform,
991 bool &assume_marc8_charset)
994 char oid_name_str[OID_STR_MAX];
995 const char *syntax_name = 0;
997 if (preferredRecordSyntax &&
998 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
1001 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
1003 enable_pz2_retrieval = true;
1004 enable_pz2_transform = true;
1006 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
1008 enable_pz2_retrieval = true;
1012 if (enable_pz2_retrieval)
1014 std::string configured_request_syntax = b->sptr->request_syntax;
1015 if (configured_request_syntax.length())
1017 syntax_name = configured_request_syntax.c_str();
1018 const Odr_oid *syntax_oid =
1019 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1020 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1021 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1022 assume_marc8_charset = true;
1025 else if (preferredRecordSyntax)
1027 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1029 if (b->sptr->sru.length())
1030 syntax_name = "XML";
1032 b->set_option("preferredRecordSyntax", syntax_name);
1034 if (enable_pz2_retrieval)
1036 element_set_name = 0;
1037 if (b->sptr->element_set.length())
1038 element_set_name = b->sptr->element_set.c_str();
1041 b->set_option("elementSetName", element_set_name);
1042 if (b->sptr->sru.length() && element_set_name)
1043 b->set_option("schema", element_set_name);
1046 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
1047 Odr_int number_to_present,
1050 Odr_int *number_of_records_returned,
1053 Odr_oid *preferredRecordSyntax,
1054 const char *element_set_name)
1056 *number_of_records_returned = 0;
1057 Z_Records *records = 0;
1058 bool enable_pz2_retrieval = false; // whether target profile is used
1059 bool enable_pz2_transform = false; // whether XSLT is used as well
1060 bool assume_marc8_charset = false;
1062 prepare_elements(b, preferredRecordSyntax,
1064 enable_pz2_retrieval,
1065 enable_pz2_transform,
1066 assume_marc8_charset);
1068 if (start < 0 || number_to_present <=0)
1071 if (number_to_present > 10000)
1072 number_to_present = 10000;
1074 ZOOM_record *recs = (ZOOM_record *)
1075 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1077 b->present(start, number_to_present, recs, error, addinfo, odr);
1082 for (i = 0; i < number_to_present; i++)
1087 { // only return records if no error and at least one record
1088 char *odr_database = odr_strdup(odr,
1089 b->m_frontend_database.c_str());
1090 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1091 odr_malloc(odr, sizeof(*npl));
1092 *number_of_records_returned = i;
1093 npl->num_records = i;
1094 npl->records = (Z_NamePlusRecord **)
1095 odr_malloc(odr, i * sizeof(*npl->records));
1096 for (i = 0; i < number_to_present; i++)
1098 Z_NamePlusRecord *npr = 0;
1099 const char *addinfo;
1100 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1101 &addinfo, 0 /* diagset */);
1105 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1108 else if (enable_pz2_retrieval)
1110 char rec_type_str[100];
1111 const char *record_encoding = 0;
1113 if (b->sptr->record_encoding.length())
1114 record_encoding = b->sptr->record_encoding.c_str();
1115 else if (assume_marc8_charset)
1116 record_encoding = "marc8";
1118 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1119 if (record_encoding)
1121 strcat(rec_type_str, "; charset=");
1122 strcat(rec_type_str, record_encoding);
1126 xmlChar *xmlrec_buf = 0;
1127 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1129 if (!rec_buf && !npr)
1131 std::string addinfo("ZOOM_record_get failed for type ");
1133 addinfo += rec_type_str;
1134 npr = zget_surrogateDiagRec(
1136 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1140 if (rec_buf && b->xsp && enable_pz2_transform)
1142 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1145 npr = zget_surrogateDiagRec(
1147 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1148 "xml parse failed for record");
1153 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1157 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1159 rec_buf = (const char *) xmlrec_buf;
1161 xmlFreeDoc(rec_res);
1165 std::string addinfo;
1167 addinfo = "xslt apply failed for "
1168 + b->sptr->transform_xsl_fname;
1169 npr = zget_surrogateDiagRec(
1171 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1174 xmlFreeDoc(rec_doc);
1180 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1182 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1183 if (res.length() && b->content_session_id.length())
1185 size_t off = res.find_first_of("://");
1186 if (off != std::string::npos)
1189 sprintf(tmp, "%s.%s/",
1190 b->content_session_id.c_str(),
1191 m_p->content_proxy_server.c_str());
1192 res.insert(off + 3, tmp);
1197 xmlNode *ptr = xmlDocGetRootElement(doc);
1198 while (ptr && ptr->type != XML_ELEMENT_NODE)
1201 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1202 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1204 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1208 xmlFree(xmlrec_buf);
1210 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1211 rec_buf = (const char *) xmlrec_buf;
1218 npr = zget_surrogateDiagRec(
1220 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1224 npr = (Z_NamePlusRecord *)
1225 odr_malloc(odr, sizeof(*npr));
1226 npr->databaseName = odr_database;
1227 npr->which = Z_NamePlusRecord_databaseRecord;
1228 npr->u.databaseRecord =
1229 z_ext_record_xml(odr, rec_buf, rec_len);
1233 xmlFree(xmlrec_buf);
1238 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1241 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1242 npr->databaseName = odr_database;
1243 npr->which = Z_NamePlusRecord_databaseRecord;
1244 npr->u.databaseRecord = ext;
1248 npr = zget_surrogateDiagRec(
1250 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1251 "ZOOM_record, type ext");
1254 npl->records[i] = npr;
1256 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1257 records->which = Z_Records_DBOSD;
1258 records->u.databaseOrSurDiagnostics = npl;
1263 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1266 struct cql_node *r = 0;
1274 std::map<std::string,std::string>::const_iterator it;
1275 it = fieldmap.find(cn->u.st.index);
1276 if (it == fieldmap.end())
1278 if (it->second.length())
1279 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1285 r = convert_cql_fields(cn->u.boolean.left, odr);
1287 r = convert_cql_fields(cn->u.boolean.right, odr);
1290 r = convert_cql_fields(cn->u.sort.search, odr);
1296 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1298 Z_GDU *gdu = package.request().get();
1299 Z_APDU *apdu_req = gdu->u.z3950;
1300 Z_APDU *apdu_res = 0;
1302 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1303 if (sr->num_databaseNames != 1)
1305 apdu_res = odr.create_searchResponse(
1306 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1307 package.response() = apdu_res;
1313 std::string db(sr->databaseNames[0]);
1314 BackendPtr b = get_backend_from_databases(package, db, &error,
1319 odr.create_searchResponse(apdu_req, error, addinfo);
1320 package.response() = apdu_res;
1324 b->set_option("setname", "default");
1326 bool enable_pz2_retrieval = false;
1327 bool enable_pz2_transform = false;
1328 bool assume_marc8_charset = false;
1329 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1330 enable_pz2_retrieval,
1331 enable_pz2_transform,
1332 assume_marc8_charset);
1335 Z_Query *query = sr->query;
1336 WRBUF ccl_wrbuf = 0;
1337 WRBUF pqf_wrbuf = 0;
1338 std::string sortkeys;
1340 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1343 pqf_wrbuf = wrbuf_alloc();
1344 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1346 else if (query->which == Z_Query_type_2)
1349 ccl_wrbuf = wrbuf_alloc();
1350 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1351 query->u.type_2->len);
1353 else if (query->which == Z_Query_type_104 &&
1354 query->u.type_104->which == Z_External_CQL)
1357 const char *cql = query->u.type_104->u.cql;
1358 CQL_parser cp = cql_parser_create();
1359 int r = cql_parser_string(cp, cql);
1362 cql_parser_destroy(cp);
1364 odr.create_searchResponse(apdu_req,
1365 YAZ_BIB1_MALFORMED_QUERY,
1366 "CQL syntax error");
1367 package.response() = apdu_res;
1370 struct cql_node *cn = cql_parser_result(cp);
1371 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1374 // hopefully we are getting a ptr to a index+relation+term node
1376 if (cn_error->which == CQL_NODE_ST)
1377 addinfo = cn_error->u.st.index;
1380 odr.create_searchResponse(apdu_req,
1381 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1383 package.response() = apdu_res;
1388 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1391 ccl_wrbuf = wrbuf_alloc();
1392 wrbuf_puts(ccl_wrbuf, ccl_buf);
1394 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1396 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1397 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1398 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1400 wrbuf_destroy(sru_sortkeys_wrbuf);
1402 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1403 yaz_tok_parse_t tp =
1404 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1405 yaz_tok_cfg_destroy(tc);
1407 /* go through sortspec and map fields */
1408 int token = yaz_tok_move(tp);
1409 while (token != YAZ_TOK_EOF)
1411 if (token == YAZ_TOK_STRING)
1413 const char *field = yaz_tok_parse_string(tp);
1414 std::map<std::string,std::string>::iterator it;
1415 it = b->sptr->sortmap.find(field);
1416 if (it != b->sptr->sortmap.end())
1417 sortkeys += it->second;
1422 token = yaz_tok_move(tp);
1423 if (token == YAZ_TOK_STRING)
1425 sortkeys += yaz_tok_parse_string(tp);
1427 if (token != YAZ_TOK_EOF)
1430 token = yaz_tok_move(tp);
1433 yaz_tok_parse_destroy(tp);
1434 wrbuf_destroy(sort_spec_wrbuf);
1436 cql_parser_destroy(cp);
1440 odr.create_searchResponse(apdu_req,
1441 YAZ_BIB1_MALFORMED_QUERY,
1442 "CQL to CCL conversion error");
1443 package.response() = apdu_res;
1450 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1451 package.response() = apdu_res;
1458 assert(pqf_wrbuf == 0);
1460 struct ccl_rpn_node *cn;
1461 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1462 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1464 wrbuf_destroy(ccl_wrbuf);
1467 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1468 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1472 case CCL_ERR_UNKNOWN_QUAL:
1473 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1475 case CCL_ERR_TRUNC_NOT_LEFT:
1476 case CCL_ERR_TRUNC_NOT_RIGHT:
1477 case CCL_ERR_TRUNC_NOT_BOTH:
1478 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1482 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1483 package.response() = apdu_res;
1486 pqf_wrbuf = wrbuf_alloc();
1487 ccl_pquery(pqf_wrbuf, cn);
1488 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1494 ZOOM_query q = ZOOM_query_create();
1495 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1497 if (b->get_option("sru"))
1501 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1502 WRBUF wrb = wrbuf_alloc();
1504 if (!strcmp(b->get_option("sru"), "solr"))
1506 solr_transform_t cqlt = solr_transform_create();
1508 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1510 solr_transform_close(cqlt);
1514 cql_transform_t cqlt = cql_transform_create();
1516 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1518 cql_transform_close(cqlt);
1522 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1523 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1524 b->search(q, &hits, &error, &addinfo, odr);
1526 ZOOM_query_destroy(q);
1529 wrbuf_destroy(pqf_wrbuf);
1533 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1534 "can not convert from RPN to CQL/SOLR");
1535 package.response() = apdu_res;
1541 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
1542 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1543 b->search(q, &hits, &error, &addinfo, odr);
1544 ZOOM_query_destroy(q);
1545 wrbuf_destroy(pqf_wrbuf);
1548 const char *element_set_name = 0;
1549 Odr_int number_to_present = 0;
1551 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1553 Odr_int number_of_records_returned = 0;
1554 Z_Records *records = get_records(
1555 0, number_to_present, &error, &addinfo,
1556 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1558 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1561 apdu_res->u.searchResponse->records = records;
1562 apdu_res->u.searchResponse->numberOfRecordsReturned =
1563 odr_intdup(odr, number_of_records_returned);
1565 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1566 package.response() = apdu_res;
1569 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1571 Z_GDU *gdu = package.request().get();
1572 Z_APDU *apdu_req = gdu->u.z3950;
1573 Z_APDU *apdu_res = 0;
1574 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1579 package.response() = odr.create_presentResponse(
1580 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1583 const char *element_set_name = 0;
1584 Z_RecordComposition *comp = pr->recordComposition;
1585 if (comp && comp->which != Z_RecordComp_simple)
1587 package.response() = odr.create_presentResponse(
1589 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1592 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1593 element_set_name = comp->u.simple->u.generic;
1594 Odr_int number_of_records_returned = 0;
1597 Z_Records *records = get_records(
1598 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1599 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1600 pr->preferredRecordSyntax, element_set_name);
1602 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1605 apdu_res->u.presentResponse->records = records;
1606 apdu_res->u.presentResponse->numberOfRecordsReturned =
1607 odr_intdup(odr, number_of_records_returned);
1609 package.response() = apdu_res;
1612 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1614 Z_GDU *gdu = package.request().get();
1617 else if (gdu->which == Z_GDU_Z3950)
1619 Z_APDU *apdu_req = gdu->u.z3950;
1620 if (apdu_req->which == Z_APDU_initRequest)
1623 package.response() = odr.create_close(
1625 Z_Close_protocolError,
1628 else if (apdu_req->which == Z_APDU_searchRequest)
1630 handle_search(package);
1632 else if (apdu_req->which == Z_APDU_presentRequest)
1634 handle_present(package);
1639 package.response() = odr.create_close(
1641 Z_Close_protocolError,
1642 "zoom filter cannot handle this APDU");
1643 package.session().close();
1648 package.session().close();
1652 void yf::Zoom::Impl::process(mp::Package &package)
1654 FrontendPtr f = get_frontend(package);
1655 Z_GDU *gdu = package.request().get();
1657 if (f->m_is_virtual)
1659 f->handle_package(package);
1661 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1664 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1665 f->m_init_gdu = gdu;
1668 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1669 Z_InitResponse *resp = apdu->u.initResponse;
1672 static const int masks[] = {
1677 for (i = 0; masks[i] != -1; i++)
1678 if (ODR_MASK_GET(req->options, masks[i]))
1679 ODR_MASK_SET(resp->options, masks[i]);
1681 static const int versions[] = {
1682 Z_ProtocolVersion_1,
1683 Z_ProtocolVersion_2,
1684 Z_ProtocolVersion_3,
1687 for (i = 0; versions[i] != -1; i++)
1688 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1689 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1693 *resp->preferredMessageSize = *req->preferredMessageSize;
1694 *resp->maximumRecordSize = *req->maximumRecordSize;
1696 package.response() = apdu;
1697 f->m_is_virtual = true;
1702 release_frontend(package);
1706 static mp::filter::Base* filter_creator()
1708 return new mp::filter::Zoom;
1712 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1723 * c-file-style: "Stroustrup"
1724 * indent-tabs-mode: nil
1726 * vim: shiftwidth=4 tabstop=8 expandtab