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)
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 db_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;
666 const char *param_proxy = 0;
667 char *x_args = 0; // all x-args to be passed to backend
669 if (db_args.length())
673 int no_parms = yaz_uri_to_array(db_args.c_str(),
674 odr, &names, &values);
675 const char **x_names = (const char **)
676 odr_malloc(odr, (1 + no_parms) * sizeof(*x_names));
677 const char **x_values = (const char **)
678 odr_malloc(odr, (1 + no_parms) * sizeof(*x_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 else if (!strcmp(name, "realm"))
697 else if (name[0] == 'x' && name[1] == '-')
699 x_names[no_x_names] = name;
700 x_values[no_x_names] = value;
706 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
707 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
708 sprintf(msg, "Bad database argument: %s", name);
715 x_names[no_x_names] = 0; // terminate list
716 yaz_array_to_uri(&x_args, odr, (char **) x_names,
721 authentication = std::string(param_user);
723 authentication += "/" + std::string(param_password);
731 std::map<std::string,SearchablePtr>::iterator it;
732 it = m_p->s_map.find(torus_db);
733 if (it != m_p->s_map.end())
735 else if (m_p->torus_url.length() > 0)
737 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm,
741 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
742 *addinfo = odr_strdup(odr, database.c_str());
746 const xmlNode *ptr = xmlDocGetRootElement(doc);
748 { // presumably ptr is a records element node
749 // parse first record in document
750 for (ptr = ptr->children; ptr; ptr = ptr->next)
752 if (ptr->type == XML_ELEMENT_NODE
753 && !strcmp((const char *) ptr->name, "record"))
757 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
758 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
759 sprintf(*addinfo, "multiple records for udb=%s",
765 sptr = m_p->parse_torus_record(ptr);
774 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
775 *addinfo = odr_strdup(odr, database.c_str());
780 xsltStylesheetPtr xsp = 0;
781 if (sptr->transform_xsl_content.length())
783 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
784 sptr->transform_xsl_content.length());
787 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
788 *addinfo = (char *) odr_malloc(odr, 40);
789 sprintf(*addinfo, "xmlParseMemory failed");
793 xsp = xsltParseStylesheetDoc(xsp_doc);
796 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
797 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
803 else if (sptr->transform_xsl_fname.length())
805 const char *path = 0;
807 if (m_p->xsldir.length())
808 path = m_p->xsldir.c_str();
810 path = m_p->file_path.c_str();
814 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
820 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
822 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
823 sprintf(*addinfo, "File could not be read: %s",
824 sptr->transform_xsl_fname.c_str());
828 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
831 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
832 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
833 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
837 xsp = xsltParseStylesheetDoc(xsp_doc);
840 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
841 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
850 BackendPtr b(new Backend(sptr));
853 b->m_frontend_database = database;
855 if (sptr->query_encoding.length())
856 b->set_option("rpnCharset", sptr->query_encoding);
858 b->set_option("timeout", "40");
861 b->set_option("apdulog", "1");
864 b->set_option("count", "1"); /* some SRU servers INSIST on getting
865 maximumRecords > 0 */
866 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
868 if (authentication.length() == 0)
869 authentication = sptr->authentication;
871 if (proxy.length() == 0)
872 proxy = sptr->cfProxy;
874 if (sptr->cfAuth.length())
877 b->set_option("user", sptr->cfAuth);
878 if (!param_user && !param_password && authentication.length())
880 if (db_args.length())
882 // no database (auth) args specified already.. and the
883 // Torus authentication has it.. Generate the args that CF
885 size_t found = authentication.find('/');
886 if (found != std::string::npos)
889 mp::util::uri_encode(authentication.substr(0, found))
891 mp::util::uri_encode(authentication.substr(found+1));
894 db_args += "user=" + mp::util::uri_encode(authentication);
896 if (!param_proxy && proxy.length())
898 if (db_args.length())
900 db_args += "proxy=" + mp::util::uri_encode(proxy);
902 if (sptr->cfSubDb.length())
904 if (db_args.length())
906 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
911 db_args.clear(); // Only x-args to be passed (non-CF)
915 size_t found = authentication.find('/');
917 if (sptr->sru.length() && found != std::string::npos)
919 b->set_option("user", authentication.substr(0, found));
920 b->set_option("password", authentication.substr(found+1));
923 b->set_option("user", authentication);
926 b->set_option("proxy", proxy);
928 if (b->sptr->contentConnector.length())
930 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
931 strcpy(fname, m_p->content_tmp_file.c_str());
932 char *xx = strstr(fname, "XXXXXX");
935 xx = fname + strlen(fname);
936 strcat(fname, "XXXXXX");
938 char tmp_char = xx[6];
939 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
942 FILE *file = fopen(fname, "w");
945 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
946 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
947 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
948 sprintf(*addinfo, "Could not create %s", fname);
950 BackendPtr backend_null;
953 b->content_session_id.assign(xx, 6);
954 WRBUF w = wrbuf_alloc();
955 wrbuf_puts(w, "#content_proxy\n");
956 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
957 if (authentication.length())
958 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
960 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
961 if (sptr->cfProxy.length())
962 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
964 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
966 package.log("zoom", YLOG_LOG, "file %s created\n", fname);
971 if (sptr->sru.length())
973 url = "http://" + sptr->target;
974 b->set_option("sru", sptr->sru);
980 if (db_args.length())
981 url += "," + db_args;
982 package.log("zoom", YLOG_LOG, "url=%s", url.c_str());
983 b->connect(url, error, addinfo, odr);
991 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
992 Odr_oid *preferredRecordSyntax,
993 const char *element_set_name,
994 bool &enable_pz2_retrieval,
995 bool &enable_pz2_transform,
996 bool &assume_marc8_charset)
999 char oid_name_str[OID_STR_MAX];
1000 const char *syntax_name = 0;
1002 if (preferredRecordSyntax &&
1003 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
1004 && element_set_name)
1006 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
1008 enable_pz2_retrieval = true;
1009 enable_pz2_transform = true;
1011 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
1013 enable_pz2_retrieval = true;
1017 if (enable_pz2_retrieval)
1019 std::string configured_request_syntax = b->sptr->request_syntax;
1020 if (configured_request_syntax.length())
1022 syntax_name = configured_request_syntax.c_str();
1023 const Odr_oid *syntax_oid =
1024 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1025 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1026 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1027 assume_marc8_charset = true;
1030 else if (preferredRecordSyntax)
1032 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1034 if (b->sptr->sru.length())
1035 syntax_name = "XML";
1037 b->set_option("preferredRecordSyntax", syntax_name);
1039 if (enable_pz2_retrieval)
1041 element_set_name = 0;
1042 if (b->sptr->element_set.length())
1043 element_set_name = b->sptr->element_set.c_str();
1046 b->set_option("elementSetName", element_set_name);
1047 if (b->sptr->sru.length() && element_set_name)
1048 b->set_option("schema", element_set_name);
1051 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
1052 Odr_int number_to_present,
1055 Odr_int *number_of_records_returned,
1058 Odr_oid *preferredRecordSyntax,
1059 const char *element_set_name)
1061 *number_of_records_returned = 0;
1062 Z_Records *records = 0;
1063 bool enable_pz2_retrieval = false; // whether target profile is used
1064 bool enable_pz2_transform = false; // whether XSLT is used as well
1065 bool assume_marc8_charset = false;
1067 prepare_elements(b, preferredRecordSyntax,
1069 enable_pz2_retrieval,
1070 enable_pz2_transform,
1071 assume_marc8_charset);
1073 if (start < 0 || number_to_present <=0)
1076 if (number_to_present > 10000)
1077 number_to_present = 10000;
1079 ZOOM_record *recs = (ZOOM_record *)
1080 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1082 b->present(start, number_to_present, recs, error, addinfo, odr);
1087 for (i = 0; i < number_to_present; i++)
1092 { // only return records if no error and at least one record
1093 char *odr_database = odr_strdup(odr,
1094 b->m_frontend_database.c_str());
1095 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1096 odr_malloc(odr, sizeof(*npl));
1097 *number_of_records_returned = i;
1098 npl->num_records = i;
1099 npl->records = (Z_NamePlusRecord **)
1100 odr_malloc(odr, i * sizeof(*npl->records));
1101 for (i = 0; i < number_to_present; i++)
1103 Z_NamePlusRecord *npr = 0;
1104 const char *addinfo;
1105 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1106 &addinfo, 0 /* diagset */);
1110 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1113 else if (enable_pz2_retrieval)
1115 char rec_type_str[100];
1116 const char *record_encoding = 0;
1118 if (b->sptr->record_encoding.length())
1119 record_encoding = b->sptr->record_encoding.c_str();
1120 else if (assume_marc8_charset)
1121 record_encoding = "marc8";
1123 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1124 if (record_encoding)
1126 strcat(rec_type_str, "; charset=");
1127 strcat(rec_type_str, record_encoding);
1131 xmlChar *xmlrec_buf = 0;
1132 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1134 if (!rec_buf && !npr)
1136 std::string addinfo("ZOOM_record_get failed for type ");
1138 addinfo += rec_type_str;
1139 npr = zget_surrogateDiagRec(
1141 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1145 if (rec_buf && b->xsp && enable_pz2_transform)
1147 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1150 npr = zget_surrogateDiagRec(
1152 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1153 "xml parse failed for record");
1158 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1162 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1164 rec_buf = (const char *) xmlrec_buf;
1166 xmlFreeDoc(rec_res);
1170 std::string addinfo;
1172 addinfo = "xslt apply failed for "
1173 + b->sptr->transform_xsl_fname;
1174 npr = zget_surrogateDiagRec(
1176 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1179 xmlFreeDoc(rec_doc);
1185 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1187 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1188 if (res.length() && b->content_session_id.length())
1190 size_t off = res.find_first_of("://");
1191 if (off != std::string::npos)
1194 sprintf(tmp, "%s.%s/",
1195 b->content_session_id.c_str(),
1196 m_p->content_proxy_server.c_str());
1197 res.insert(off + 3, tmp);
1202 xmlNode *ptr = xmlDocGetRootElement(doc);
1203 while (ptr && ptr->type != XML_ELEMENT_NODE)
1206 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1207 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1209 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1213 xmlFree(xmlrec_buf);
1215 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1216 rec_buf = (const char *) xmlrec_buf;
1223 npr = zget_surrogateDiagRec(
1225 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1229 npr = (Z_NamePlusRecord *)
1230 odr_malloc(odr, sizeof(*npr));
1231 npr->databaseName = odr_database;
1232 npr->which = Z_NamePlusRecord_databaseRecord;
1233 npr->u.databaseRecord =
1234 z_ext_record_xml(odr, rec_buf, rec_len);
1238 xmlFree(xmlrec_buf);
1243 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1246 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1247 npr->databaseName = odr_database;
1248 npr->which = Z_NamePlusRecord_databaseRecord;
1249 npr->u.databaseRecord = ext;
1253 npr = zget_surrogateDiagRec(
1255 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1256 "ZOOM_record, type ext");
1259 npl->records[i] = npr;
1261 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1262 records->which = Z_Records_DBOSD;
1263 records->u.databaseOrSurDiagnostics = npl;
1268 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1271 struct cql_node *r = 0;
1279 std::map<std::string,std::string>::const_iterator it;
1280 it = fieldmap.find(cn->u.st.index);
1281 if (it == fieldmap.end())
1283 if (it->second.length())
1284 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1290 r = convert_cql_fields(cn->u.boolean.left, odr);
1292 r = convert_cql_fields(cn->u.boolean.right, odr);
1295 r = convert_cql_fields(cn->u.sort.search, odr);
1301 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1303 Z_GDU *gdu = package.request().get();
1304 Z_APDU *apdu_req = gdu->u.z3950;
1305 Z_APDU *apdu_res = 0;
1307 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1308 if (sr->num_databaseNames != 1)
1310 apdu_res = odr.create_searchResponse(
1311 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1312 package.response() = apdu_res;
1318 std::string db(sr->databaseNames[0]);
1319 BackendPtr b = get_backend_from_databases(package, db, &error,
1324 odr.create_searchResponse(apdu_req, error, addinfo);
1325 package.response() = apdu_res;
1329 b->set_option("setname", "default");
1331 bool enable_pz2_retrieval = false;
1332 bool enable_pz2_transform = false;
1333 bool assume_marc8_charset = false;
1334 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1335 enable_pz2_retrieval,
1336 enable_pz2_transform,
1337 assume_marc8_charset);
1340 Z_Query *query = sr->query;
1341 WRBUF ccl_wrbuf = 0;
1342 WRBUF pqf_wrbuf = 0;
1343 std::string sortkeys;
1345 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1348 pqf_wrbuf = wrbuf_alloc();
1349 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1351 else if (query->which == Z_Query_type_2)
1354 ccl_wrbuf = wrbuf_alloc();
1355 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1356 query->u.type_2->len);
1358 else if (query->which == Z_Query_type_104 &&
1359 query->u.type_104->which == Z_External_CQL)
1362 const char *cql = query->u.type_104->u.cql;
1363 CQL_parser cp = cql_parser_create();
1364 int r = cql_parser_string(cp, cql);
1367 cql_parser_destroy(cp);
1369 odr.create_searchResponse(apdu_req,
1370 YAZ_BIB1_MALFORMED_QUERY,
1371 "CQL syntax error");
1372 package.response() = apdu_res;
1375 struct cql_node *cn = cql_parser_result(cp);
1376 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1379 // hopefully we are getting a ptr to a index+relation+term node
1381 if (cn_error->which == CQL_NODE_ST)
1382 addinfo = cn_error->u.st.index;
1385 odr.create_searchResponse(apdu_req,
1386 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1388 package.response() = apdu_res;
1393 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1396 ccl_wrbuf = wrbuf_alloc();
1397 wrbuf_puts(ccl_wrbuf, ccl_buf);
1399 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1401 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1402 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1403 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1405 wrbuf_destroy(sru_sortkeys_wrbuf);
1407 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1408 yaz_tok_parse_t tp =
1409 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1410 yaz_tok_cfg_destroy(tc);
1412 /* go through sortspec and map fields */
1413 int token = yaz_tok_move(tp);
1414 while (token != YAZ_TOK_EOF)
1416 if (token == YAZ_TOK_STRING)
1418 const char *field = yaz_tok_parse_string(tp);
1419 std::map<std::string,std::string>::iterator it;
1420 it = b->sptr->sortmap.find(field);
1421 if (it != b->sptr->sortmap.end())
1422 sortkeys += it->second;
1427 token = yaz_tok_move(tp);
1428 if (token == YAZ_TOK_STRING)
1430 sortkeys += yaz_tok_parse_string(tp);
1432 if (token != YAZ_TOK_EOF)
1435 token = yaz_tok_move(tp);
1438 yaz_tok_parse_destroy(tp);
1439 wrbuf_destroy(sort_spec_wrbuf);
1441 cql_parser_destroy(cp);
1445 odr.create_searchResponse(apdu_req,
1446 YAZ_BIB1_MALFORMED_QUERY,
1447 "CQL to CCL conversion error");
1448 package.response() = apdu_res;
1455 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1456 package.response() = apdu_res;
1463 assert(pqf_wrbuf == 0);
1465 struct ccl_rpn_node *cn;
1466 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1467 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1469 wrbuf_destroy(ccl_wrbuf);
1472 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1473 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1477 case CCL_ERR_UNKNOWN_QUAL:
1478 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1480 case CCL_ERR_TRUNC_NOT_LEFT:
1481 case CCL_ERR_TRUNC_NOT_RIGHT:
1482 case CCL_ERR_TRUNC_NOT_BOTH:
1483 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1487 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1488 package.response() = apdu_res;
1491 pqf_wrbuf = wrbuf_alloc();
1492 ccl_pquery(pqf_wrbuf, cn);
1493 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1499 ZOOM_query q = ZOOM_query_create();
1500 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1502 if (b->get_option("sru"))
1506 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1507 WRBUF wrb = wrbuf_alloc();
1509 if (!strcmp(b->get_option("sru"), "solr"))
1511 solr_transform_t cqlt = solr_transform_create();
1513 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1515 solr_transform_close(cqlt);
1519 cql_transform_t cqlt = cql_transform_create();
1521 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1523 cql_transform_close(cqlt);
1527 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1528 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1529 b->search(q, &hits, &error, &addinfo, odr);
1531 ZOOM_query_destroy(q);
1534 wrbuf_destroy(pqf_wrbuf);
1538 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1539 "can not convert from RPN to CQL/SOLR");
1540 package.response() = apdu_res;
1546 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
1547 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1548 b->search(q, &hits, &error, &addinfo, odr);
1549 ZOOM_query_destroy(q);
1550 wrbuf_destroy(pqf_wrbuf);
1553 const char *element_set_name = 0;
1554 Odr_int number_to_present = 0;
1556 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1558 Odr_int number_of_records_returned = 0;
1559 Z_Records *records = get_records(
1560 0, number_to_present, &error, &addinfo,
1561 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1563 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1566 apdu_res->u.searchResponse->records = records;
1567 apdu_res->u.searchResponse->numberOfRecordsReturned =
1568 odr_intdup(odr, number_of_records_returned);
1570 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1571 package.response() = apdu_res;
1574 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1576 Z_GDU *gdu = package.request().get();
1577 Z_APDU *apdu_req = gdu->u.z3950;
1578 Z_APDU *apdu_res = 0;
1579 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1584 package.response() = odr.create_presentResponse(
1585 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1588 const char *element_set_name = 0;
1589 Z_RecordComposition *comp = pr->recordComposition;
1590 if (comp && comp->which != Z_RecordComp_simple)
1592 package.response() = odr.create_presentResponse(
1594 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1597 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1598 element_set_name = comp->u.simple->u.generic;
1599 Odr_int number_of_records_returned = 0;
1602 Z_Records *records = get_records(
1603 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1604 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1605 pr->preferredRecordSyntax, element_set_name);
1607 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1610 apdu_res->u.presentResponse->records = records;
1611 apdu_res->u.presentResponse->numberOfRecordsReturned =
1612 odr_intdup(odr, number_of_records_returned);
1614 package.response() = apdu_res;
1617 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1619 Z_GDU *gdu = package.request().get();
1622 else if (gdu->which == Z_GDU_Z3950)
1624 Z_APDU *apdu_req = gdu->u.z3950;
1625 if (apdu_req->which == Z_APDU_initRequest)
1628 package.response() = odr.create_close(
1630 Z_Close_protocolError,
1633 else if (apdu_req->which == Z_APDU_searchRequest)
1635 handle_search(package);
1637 else if (apdu_req->which == Z_APDU_presentRequest)
1639 handle_present(package);
1644 package.response() = odr.create_close(
1646 Z_Close_protocolError,
1647 "zoom filter cannot handle this APDU");
1648 package.session().close();
1653 package.session().close();
1657 void yf::Zoom::Impl::process(mp::Package &package)
1659 FrontendPtr f = get_frontend(package);
1660 Z_GDU *gdu = package.request().get();
1662 if (f->m_is_virtual)
1664 f->handle_package(package);
1666 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1669 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1670 f->m_init_gdu = gdu;
1673 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1674 Z_InitResponse *resp = apdu->u.initResponse;
1677 static const int masks[] = {
1682 for (i = 0; masks[i] != -1; i++)
1683 if (ODR_MASK_GET(req->options, masks[i]))
1684 ODR_MASK_SET(resp->options, masks[i]);
1686 static const int versions[] = {
1687 Z_ProtocolVersion_1,
1688 Z_ProtocolVersion_2,
1689 Z_ProtocolVersion_3,
1692 for (i = 0; versions[i] != -1; i++)
1693 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1694 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1698 *resp->preferredMessageSize = *req->preferredMessageSize;
1699 *resp->maximumRecordSize = *req->maximumRecordSize;
1701 package.response() = apdu;
1702 f->m_is_virtual = true;
1707 release_frontend(package);
1711 static mp::filter::Base* filter_creator()
1713 return new mp::filter::Zoom;
1717 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1728 * c-file-style: "Stroustrup"
1729 * indent-tabs-mode: nil
1731 * vim: shiftwidth=4 tabstop=8 expandtab