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 sru_version;
68 std::string request_syntax;
69 std::string element_set;
70 std::string record_encoding;
71 std::string transform_xsl_fname;
72 std::string transform_xsl_content;
73 std::string urlRecipe;
74 std::string contentConnector;
75 std::string sortStrategy;
78 CCL_bibset ccl_bibset;
79 std::map<std::string, std::string> sortmap;
80 Searchable(CCL_bibset base);
83 class Zoom::Backend : boost::noncopyable {
85 friend class Frontend;
87 ZOOM_connection m_connection;
88 ZOOM_resultset m_resultset;
89 std::string m_frontend_database;
91 xsltStylesheetPtr xsp;
92 std::string content_session_id;
94 Backend(SearchablePtr sptr);
96 void connect(std::string zurl, int *error, char **addinfo,
98 void search(ZOOM_query q, Odr_int *hits,
99 int *error, char **addinfo, ODR odr);
100 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
101 int *error, char **addinfo, ODR odr);
102 void set_option(const char *name, const char *value);
103 void set_option(const char *name, std::string value);
104 const char *get_option(const char *name);
105 void get_zoom_error(int *error, char **addinfo, ODR odr);
107 class Zoom::Frontend : boost::noncopyable {
112 yazpp_1::GDU m_init_gdu;
113 BackendPtr m_backend;
114 void handle_package(mp::Package &package);
115 void handle_search(mp::Package &package);
116 void handle_present(mp::Package &package);
117 BackendPtr get_backend_from_databases(const mp::Package &package,
118 std::string &database,
124 void prepare_elements(BackendPtr b,
125 Odr_oid *preferredRecordSyntax,
126 const char *element_set_name,
127 bool &enable_pz2_retrieval,
128 bool &enable_pz2_transform,
129 bool &assume_marc8_charset);
131 Z_Records *get_records(Odr_int start,
132 Odr_int number_to_present,
135 Odr_int *number_of_records_returned,
136 ODR odr, BackendPtr b,
137 Odr_oid *preferredRecordSyntax,
138 const char *element_set_name);
140 Frontend(Impl *impl);
144 friend class Frontend;
148 void process(metaproxy_1::Package & package);
149 void configure(const xmlNode * ptr, bool test_only,
152 void configure_local_records(const xmlNode * ptr, bool test_only);
153 FrontendPtr get_frontend(mp::Package &package);
154 void release_frontend(mp::Package &package);
155 SearchablePtr parse_torus_record(const xmlNode *ptr);
156 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
157 std::map<mp::Session, FrontendPtr> m_clients;
158 boost::mutex m_mutex;
159 boost::condition m_cond_session_ready;
160 std::string torus_url;
161 std::string default_realm;
162 std::map<std::string,std::string> fieldmap;
164 std::string file_path;
165 std::string content_proxy_server;
166 std::string content_tmp_file;
169 std::string element_transform;
170 std::string element_raw;
172 std::map<std::string,SearchablePtr> s_map;
177 // define Pimpl wrapper forwarding to Impl
179 yf::Zoom::Zoom() : m_p(new Impl)
184 { // must have a destructor because of boost::scoped_ptr
187 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
190 m_p->configure(xmlnode, test_only, path);
193 void yf::Zoom::process(mp::Package &package) const
195 m_p->process(package);
199 // define Implementation stuff
201 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
203 m_connection = ZOOM_connection_create(0);
208 yf::Zoom::Backend::~Backend()
211 xsltFreeStylesheet(xsp);
212 ZOOM_connection_destroy(m_connection);
213 ZOOM_resultset_destroy(m_resultset);
217 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
221 const char *zoom_addinfo = 0;
222 const char *dset = 0;
223 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
226 if (*error >= ZOOM_ERROR_CONNECT)
228 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
229 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
230 *addinfo = (char *) odr_malloc(
231 odr, 20 + strlen(msg) +
232 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
233 strcpy(*addinfo, msg);
236 strcat(*addinfo, ": ");
237 strcat(*addinfo, zoom_addinfo);
238 strcat(*addinfo, " ");
243 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
244 *error = yaz_diag_srw_to_bib1(*error);
245 *addinfo = (char *) odr_malloc(
246 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
248 if (zoom_addinfo && *zoom_addinfo)
250 strcpy(*addinfo, zoom_addinfo);
251 strcat(*addinfo, " ");
253 strcat(*addinfo, "(backend)");
258 void yf::Zoom::Backend::connect(std::string zurl,
259 int *error, char **addinfo,
262 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
263 get_zoom_error(error, addinfo, odr);
266 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
267 int *error, char **addinfo, ODR odr)
269 m_resultset = ZOOM_connection_search(m_connection, q);
270 get_zoom_error(error, addinfo, odr);
272 *hits = ZOOM_resultset_size(m_resultset);
277 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
279 int *error, char **addinfo, ODR odr)
281 ZOOM_resultset_records(m_resultset, recs, start, number);
282 get_zoom_error(error, addinfo, odr);
285 void yf::Zoom::Backend::set_option(const char *name, const char *value)
287 ZOOM_connection_option_set(m_connection, name, value);
289 ZOOM_resultset_option_set(m_resultset, name, value);
292 void yf::Zoom::Backend::set_option(const char *name, std::string value)
294 set_option(name, value.c_str());
297 const char *yf::Zoom::Backend::get_option(const char *name)
299 return ZOOM_connection_option_get(m_connection, name);
302 yf::Zoom::Searchable::Searchable(CCL_bibset base)
305 use_turbomarc = true;
306 sortStrategy = "embed";
307 ccl_bibset = ccl_qual_dup(base);
310 yf::Zoom::Searchable::~Searchable()
312 ccl_qual_rm(&ccl_bibset);
315 yf::Zoom::Frontend::Frontend(Impl *impl) :
316 m_p(impl), m_is_virtual(false), m_in_use(true)
320 yf::Zoom::Frontend::~Frontend()
324 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
326 boost::mutex::scoped_lock lock(m_mutex);
328 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
332 it = m_clients.find(package.session());
333 if (it == m_clients.end())
336 if (!it->second->m_in_use)
338 it->second->m_in_use = true;
341 m_cond_session_ready.wait(lock);
343 FrontendPtr f(new Frontend(this));
344 m_clients[package.session()] = f;
349 void yf::Zoom::Impl::release_frontend(mp::Package &package)
351 boost::mutex::scoped_lock lock(m_mutex);
352 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
354 it = m_clients.find(package.session());
355 if (it != m_clients.end())
357 if (package.session().is_closed())
363 it->second->m_in_use = false;
365 m_cond_session_ready.notify_all();
369 yf::Zoom::Impl::Impl() :
370 apdu_log(false), element_transform("pz2") , element_raw("raw")
372 bibset = ccl_qual_mk();
374 srand((unsigned int) time(0));
377 yf::Zoom::Impl::~Impl()
379 ccl_qual_rm(&bibset);
382 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
384 Zoom::SearchablePtr s(new Searchable(bibset));
386 for (ptr = ptr->children; ptr; ptr = ptr->next)
388 if (ptr->type != XML_ELEMENT_NODE)
390 if (!strcmp((const char *) ptr->name, "layer"))
392 else if (!strcmp((const char *) ptr->name,
395 s->authentication = mp::xml::get_text(ptr);
397 else if (!strcmp((const char *) ptr->name,
400 s->cfAuth = mp::xml::get_text(ptr);
402 else if (!strcmp((const char *) ptr->name,
405 s->cfProxy = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name,
410 s->cfSubDB = mp::xml::get_text(ptr);
412 else if (!strcmp((const char *) ptr->name,
415 s->contentConnector = mp::xml::get_text(ptr);
417 else if (!strcmp((const char *) ptr->name, "udb"))
419 s->udb = mp::xml::get_text(ptr);
421 else if (!strcmp((const char *) ptr->name, "zurl"))
423 s->target = mp::xml::get_text(ptr);
425 else if (!strcmp((const char *) ptr->name, "sru"))
427 s->sru = mp::xml::get_text(ptr);
429 else if (!strcmp((const char *) ptr->name, "SRUVersion"))
431 s->sru_version = mp::xml::get_text(ptr);
433 else if (!strcmp((const char *) ptr->name,
436 s->query_encoding = mp::xml::get_text(ptr);
438 else if (!strcmp((const char *) ptr->name,
441 s->piggyback = mp::xml::get_bool(ptr, true);
443 else if (!strcmp((const char *) ptr->name,
446 s->request_syntax = mp::xml::get_text(ptr);
448 else if (!strcmp((const char *) ptr->name,
451 s->element_set = mp::xml::get_text(ptr);
453 else if (!strcmp((const char *) ptr->name,
456 s->record_encoding = mp::xml::get_text(ptr);
458 else if (!strcmp((const char *) ptr->name,
461 s->transform_xsl_fname = mp::xml::get_text(ptr);
463 else if (!strcmp((const char *) ptr->name,
466 s->transform_xsl_content = mp::xml::get_text(ptr);
468 else if (!strcmp((const char *) ptr->name,
471 s->urlRecipe = mp::xml::get_text(ptr);
473 else if (!strcmp((const char *) ptr->name,
476 ; // useTurboMarc is ignored
478 else if (!strncmp((const char *) ptr->name,
481 std::string value = mp::xml::get_text(ptr);
482 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
483 (const char *) ptr->name + 7);
485 else if (!strncmp((const char *) ptr->name,
488 std::string value = mp::xml::get_text(ptr);
489 s->sortmap[(const char *) ptr->name + 8] = value;
491 else if (!strcmp((const char *) ptr->name,
494 s->sortStrategy = mp::xml::get_text(ptr);
500 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
502 while (ptr && ptr->type != XML_ELEMENT_NODE)
507 if (!strcmp((const char *) ptr->name, "records"))
509 for (ptr = ptr->children; ptr; ptr = ptr->next)
511 if (ptr->type != XML_ELEMENT_NODE)
513 if (!strcmp((const char *) ptr->name, "record"))
515 SearchablePtr s = parse_torus_record(ptr);
518 std::string udb = s->udb;
523 throw mp::filter::FilterException
524 ("No udb for local torus record");
530 throw mp::filter::FilterException
532 + std::string((const char *) ptr->name)
533 + " in zoom filter inside element "
540 throw mp::filter::FilterException
542 + std::string((const char *) ptr->name)
543 + " in zoom filter inside element <torus>");
548 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
551 content_tmp_file = "/tmp/cf.XXXXXX.p";
556 for (ptr = ptr->children; ptr; ptr = ptr->next)
558 if (ptr->type != XML_ELEMENT_NODE)
560 else if (!strcmp((const char *) ptr->name, "torus"))
562 const struct _xmlAttr *attr;
563 for (attr = ptr->properties; attr; attr = attr->next)
565 if (!strcmp((const char *) attr->name, "url"))
566 torus_url = mp::xml::get_text(attr->children);
567 else if (!strcmp((const char *) attr->name, "realm"))
568 default_realm = mp::xml::get_text(attr->children);
569 else if (!strcmp((const char *) attr->name, "xsldir"))
570 xsldir = mp::xml::get_text(attr->children);
571 else if (!strcmp((const char *) attr->name, "element_transform"))
572 element_transform = mp::xml::get_text(attr->children);
573 else if (!strcmp((const char *) attr->name, "element_raw"))
574 element_raw = mp::xml::get_text(attr->children);
575 else if (!strcmp((const char *) attr->name, "proxy"))
576 proxy = mp::xml::get_text(attr->children);
578 throw mp::filter::FilterException(
579 "Bad attribute " + std::string((const char *)
582 configure_local_records(ptr->children, test_only);
584 else if (!strcmp((const char *) ptr->name, "cclmap"))
586 const char *addinfo = 0;
587 ccl_xml_config(bibset, ptr, &addinfo);
589 else if (!strcmp((const char *) ptr->name, "fieldmap"))
591 const struct _xmlAttr *attr;
592 std::string ccl_field;
593 std::string cql_field;
594 for (attr = ptr->properties; attr; attr = attr->next)
596 if (!strcmp((const char *) attr->name, "ccl"))
597 ccl_field = mp::xml::get_text(attr->children);
598 else if (!strcmp((const char *) attr->name, "cql"))
599 cql_field = mp::xml::get_text(attr->children);
601 throw mp::filter::FilterException(
602 "Bad attribute " + std::string((const char *)
605 if (cql_field.length())
606 fieldmap[cql_field] = ccl_field;
608 else if (!strcmp((const char *) ptr->name, "contentProxy"))
610 const struct _xmlAttr *attr;
611 for (attr = ptr->properties; attr; attr = attr->next)
613 if (!strcmp((const char *) attr->name, "server"))
614 content_proxy_server = mp::xml::get_text(attr->children);
615 else if (!strcmp((const char *) attr->name, "tmp_file"))
616 content_tmp_file = mp::xml::get_text(attr->children);
618 throw mp::filter::FilterException(
619 "Bad attribute " + std::string((const char *)
623 else if (!strcmp((const char *) ptr->name, "log"))
625 const struct _xmlAttr *attr;
626 for (attr = ptr->properties; attr; attr = attr->next)
628 if (!strcmp((const char *) attr->name, "apdu"))
629 apdu_log = mp::xml::get_bool(attr->children, false);
631 throw mp::filter::FilterException(
632 "Bad attribute " + std::string((const char *)
638 throw mp::filter::FilterException
640 + std::string((const char *) ptr->name)
641 + " in zoom filter");
646 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
647 const mp::Package &package,
648 std::string &database, int *error, char **addinfo, ODR odr)
650 std::list<BackendPtr>::const_iterator map_it;
651 if (m_backend && m_backend->m_frontend_database == database)
654 std::string input_args;
655 std::string torus_db;
656 size_t db_arg_pos = database.find(',');
657 if (db_arg_pos != std::string::npos)
659 torus_db = database.substr(0, db_arg_pos);
660 input_args = database.substr(db_arg_pos + 1);
665 std::string authentication;
667 std::string realm = m_p->default_realm;
669 const char *param_user = 0;
670 const char *param_password = 0;
676 if (input_args.length())
677 no_parms = yaz_uri_to_array(input_args.c_str(),
678 odr, &names, &values);
679 // adding 10 because we'll be adding other URL args
680 const char **out_names = (const char **)
681 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
682 const char **out_values = (const char **)
683 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
686 for (i = 0; i < no_parms; i++)
688 const char *name = names[i];
689 const char *value = values[i];
692 if (!strcmp(name, "user"))
694 else if (!strcmp(name, "password"))
695 param_password = value;
696 else if (!strcmp(name, "proxy"))
698 else if (!strcmp(name, "cproxysession"))
700 out_names[no_out_args] = name;
701 out_values[no_out_args++] = value;
703 else if (!strcmp(name, "realm"))
705 else if (name[0] == 'x' && name[1] == '-')
707 out_names[no_out_args] = name;
708 out_values[no_out_args++] = value;
713 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
714 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
715 sprintf(msg, "Bad database argument: %s", name);
722 authentication = std::string(param_user);
724 authentication += "/" + std::string(param_password);
728 std::map<std::string,SearchablePtr>::iterator it;
729 it = m_p->s_map.find(torus_db);
730 if (it != m_p->s_map.end())
732 else if (m_p->torus_url.length() > 0)
734 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm,
738 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
739 *addinfo = odr_strdup(odr, database.c_str());
743 const xmlNode *ptr = xmlDocGetRootElement(doc);
745 { // presumably ptr is a records element node
746 // parse first record in document
747 for (ptr = ptr->children; ptr; ptr = ptr->next)
749 if (ptr->type == XML_ELEMENT_NODE
750 && !strcmp((const char *) ptr->name, "record"))
754 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
755 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
756 sprintf(*addinfo, "multiple records for udb=%s",
762 sptr = m_p->parse_torus_record(ptr);
771 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
772 *addinfo = odr_strdup(odr, database.c_str());
777 xsltStylesheetPtr xsp = 0;
778 if (sptr->transform_xsl_content.length())
780 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
781 sptr->transform_xsl_content.length());
784 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
785 *addinfo = (char *) odr_malloc(odr, 40);
786 sprintf(*addinfo, "xmlParseMemory failed");
790 xsp = xsltParseStylesheetDoc(xsp_doc);
793 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
794 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
800 else if (sptr->transform_xsl_fname.length())
802 const char *path = 0;
804 if (m_p->xsldir.length())
805 path = m_p->xsldir.c_str();
807 path = m_p->file_path.c_str();
811 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
817 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
819 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
820 sprintf(*addinfo, "File could not be read: %s",
821 sptr->transform_xsl_fname.c_str());
825 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
828 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
829 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
830 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
834 xsp = xsltParseStylesheetDoc(xsp_doc);
837 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
838 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
847 BackendPtr b(new Backend(sptr));
850 b->m_frontend_database = database;
852 if (sptr->query_encoding.length())
853 b->set_option("rpnCharset", sptr->query_encoding);
855 b->set_option("timeout", "40");
858 b->set_option("apdulog", "1");
861 b->set_option("count", "1"); /* some SRU servers INSIST on getting
862 maximumRecords > 0 */
863 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
865 if (authentication.length() == 0)
866 authentication = sptr->authentication;
868 if (proxy.length() == 0)
869 proxy = sptr->cfProxy;
871 if (sptr->cfAuth.length())
874 b->set_option("user", sptr->cfAuth);
875 if (authentication.length())
877 size_t found = authentication.find('/');
878 if (found != std::string::npos)
880 out_names[no_out_args] = "user";
881 out_values[no_out_args++] =
882 odr_strdup(odr, authentication.substr(0, found).c_str());
884 out_names[no_out_args] = "password";
885 out_values[no_out_args++] =
886 odr_strdup(odr, authentication.substr(found+1).c_str());
890 out_names[no_out_args] = "user";
891 out_values[no_out_args++] =
892 odr_strdup(odr, authentication.c_str());
897 out_names[no_out_args] = "proxy";
898 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
900 if (sptr->cfSubDB.length())
902 out_names[no_out_args] = "subdatabase";
903 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
908 size_t found = authentication.find('/');
910 if (sptr->sru.length() && found != std::string::npos)
912 b->set_option("user", authentication.substr(0, found));
913 b->set_option("password", authentication.substr(found+1));
916 b->set_option("user", authentication);
919 b->set_option("proxy", proxy);
921 if (b->sptr->contentConnector.length())
923 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
924 strcpy(fname, m_p->content_tmp_file.c_str());
925 char *xx = strstr(fname, "XXXXXX");
928 xx = fname + strlen(fname);
929 strcat(fname, "XXXXXX");
931 char tmp_char = xx[6];
932 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
935 FILE *file = fopen(fname, "w");
938 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
939 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
940 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
941 sprintf(*addinfo, "Could not create %s", fname);
943 BackendPtr backend_null;
946 b->content_session_id.assign(xx, 6);
947 WRBUF w = wrbuf_alloc();
948 wrbuf_puts(w, "#content_proxy\n");
949 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
950 if (authentication.length())
951 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
953 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
954 if (sptr->cfProxy.length())
955 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
957 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
959 package.log("zoom", YLOG_LOG, "file %s created\n", fname);
964 if (sptr->sru.length())
966 url = "http://" + sptr->target;
967 b->set_option("sru", sptr->sru);
969 if (sptr->sru_version.length())
970 b->set_option("sru_version", sptr->sru_version);
979 out_names[no_out_args] = 0; // terminate list
981 yaz_array_to_uri(&x_args, odr, (char **) out_names,
982 (char **) out_values);
983 url += "," + std::string(x_args);
985 package.log("zoom", YLOG_LOG, "url=%s", url.c_str());
986 b->connect(url, error, addinfo, odr);
994 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
995 Odr_oid *preferredRecordSyntax,
996 const char *element_set_name,
997 bool &enable_pz2_retrieval,
998 bool &enable_pz2_transform,
999 bool &assume_marc8_charset)
1002 char oid_name_str[OID_STR_MAX];
1003 const char *syntax_name = 0;
1005 if (preferredRecordSyntax &&
1006 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
1007 && element_set_name)
1009 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
1011 enable_pz2_retrieval = true;
1012 enable_pz2_transform = true;
1014 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
1016 enable_pz2_retrieval = true;
1020 if (enable_pz2_retrieval)
1022 std::string configured_request_syntax = b->sptr->request_syntax;
1023 if (configured_request_syntax.length())
1025 syntax_name = configured_request_syntax.c_str();
1026 const Odr_oid *syntax_oid =
1027 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1028 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1029 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1030 assume_marc8_charset = true;
1033 else if (preferredRecordSyntax)
1035 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1037 if (b->sptr->sru.length())
1038 syntax_name = "XML";
1040 b->set_option("preferredRecordSyntax", syntax_name);
1042 if (enable_pz2_retrieval)
1044 element_set_name = 0;
1045 if (b->sptr->element_set.length())
1046 element_set_name = b->sptr->element_set.c_str();
1049 b->set_option("elementSetName", element_set_name);
1050 if (b->sptr->sru.length() && element_set_name)
1051 b->set_option("schema", element_set_name);
1054 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
1055 Odr_int number_to_present,
1058 Odr_int *number_of_records_returned,
1061 Odr_oid *preferredRecordSyntax,
1062 const char *element_set_name)
1064 *number_of_records_returned = 0;
1065 Z_Records *records = 0;
1066 bool enable_pz2_retrieval = false; // whether target profile is used
1067 bool enable_pz2_transform = false; // whether XSLT is used as well
1068 bool assume_marc8_charset = false;
1070 prepare_elements(b, preferredRecordSyntax,
1072 enable_pz2_retrieval,
1073 enable_pz2_transform,
1074 assume_marc8_charset);
1076 if (start < 0 || number_to_present <=0)
1079 if (number_to_present > 10000)
1080 number_to_present = 10000;
1082 ZOOM_record *recs = (ZOOM_record *)
1083 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1085 b->present(start, number_to_present, recs, error, addinfo, odr);
1090 for (i = 0; i < number_to_present; i++)
1095 { // only return records if no error and at least one record
1096 char *odr_database = odr_strdup(odr,
1097 b->m_frontend_database.c_str());
1098 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1099 odr_malloc(odr, sizeof(*npl));
1100 *number_of_records_returned = i;
1101 npl->num_records = i;
1102 npl->records = (Z_NamePlusRecord **)
1103 odr_malloc(odr, i * sizeof(*npl->records));
1104 for (i = 0; i < number_to_present; i++)
1106 Z_NamePlusRecord *npr = 0;
1107 const char *addinfo;
1108 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1109 &addinfo, 0 /* diagset */);
1113 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1116 else if (enable_pz2_retrieval)
1118 char rec_type_str[100];
1119 const char *record_encoding = 0;
1121 if (b->sptr->record_encoding.length())
1122 record_encoding = b->sptr->record_encoding.c_str();
1123 else if (assume_marc8_charset)
1124 record_encoding = "marc8";
1126 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1127 if (record_encoding)
1129 strcat(rec_type_str, "; charset=");
1130 strcat(rec_type_str, record_encoding);
1134 xmlChar *xmlrec_buf = 0;
1135 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1137 if (!rec_buf && !npr)
1139 std::string addinfo("ZOOM_record_get failed for type ");
1141 addinfo += rec_type_str;
1142 npr = zget_surrogateDiagRec(
1144 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1148 if (rec_buf && b->xsp && enable_pz2_transform)
1150 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1153 npr = zget_surrogateDiagRec(
1155 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1156 "xml parse failed for record");
1161 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1165 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1167 rec_buf = (const char *) xmlrec_buf;
1169 xmlFreeDoc(rec_res);
1173 std::string addinfo;
1175 addinfo = "xslt apply failed for "
1176 + b->sptr->transform_xsl_fname;
1177 npr = zget_surrogateDiagRec(
1179 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1182 xmlFreeDoc(rec_doc);
1188 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1190 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1191 if (res.length() && b->content_session_id.length())
1193 size_t off = res.find_first_of("://");
1194 if (off != std::string::npos)
1197 sprintf(tmp, "%s.%s/",
1198 b->content_session_id.c_str(),
1199 m_p->content_proxy_server.c_str());
1200 res.insert(off + 3, tmp);
1205 xmlNode *ptr = xmlDocGetRootElement(doc);
1206 while (ptr && ptr->type != XML_ELEMENT_NODE)
1209 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1210 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1212 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1216 xmlFree(xmlrec_buf);
1218 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1219 rec_buf = (const char *) xmlrec_buf;
1226 npr = zget_surrogateDiagRec(
1228 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1232 npr = (Z_NamePlusRecord *)
1233 odr_malloc(odr, sizeof(*npr));
1234 npr->databaseName = odr_database;
1235 npr->which = Z_NamePlusRecord_databaseRecord;
1236 npr->u.databaseRecord =
1237 z_ext_record_xml(odr, rec_buf, rec_len);
1241 xmlFree(xmlrec_buf);
1246 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1249 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1250 npr->databaseName = odr_database;
1251 npr->which = Z_NamePlusRecord_databaseRecord;
1252 npr->u.databaseRecord = ext;
1256 npr = zget_surrogateDiagRec(
1258 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1259 "ZOOM_record, type ext");
1262 npl->records[i] = npr;
1264 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1265 records->which = Z_Records_DBOSD;
1266 records->u.databaseOrSurDiagnostics = npl;
1271 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1274 struct cql_node *r = 0;
1282 std::map<std::string,std::string>::const_iterator it;
1283 it = fieldmap.find(cn->u.st.index);
1284 if (it == fieldmap.end())
1286 if (it->second.length())
1287 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1293 r = convert_cql_fields(cn->u.boolean.left, odr);
1295 r = convert_cql_fields(cn->u.boolean.right, odr);
1298 r = convert_cql_fields(cn->u.sort.search, odr);
1304 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1306 Z_GDU *gdu = package.request().get();
1307 Z_APDU *apdu_req = gdu->u.z3950;
1308 Z_APDU *apdu_res = 0;
1310 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1311 if (sr->num_databaseNames != 1)
1313 apdu_res = odr.create_searchResponse(
1314 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1315 package.response() = apdu_res;
1321 std::string db(sr->databaseNames[0]);
1322 BackendPtr b = get_backend_from_databases(package, db, &error,
1327 odr.create_searchResponse(apdu_req, error, addinfo);
1328 package.response() = apdu_res;
1332 b->set_option("setname", "default");
1334 bool enable_pz2_retrieval = false;
1335 bool enable_pz2_transform = false;
1336 bool assume_marc8_charset = false;
1337 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1338 enable_pz2_retrieval,
1339 enable_pz2_transform,
1340 assume_marc8_charset);
1343 Z_Query *query = sr->query;
1344 WRBUF ccl_wrbuf = 0;
1345 WRBUF pqf_wrbuf = 0;
1346 std::string sortkeys;
1348 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1351 pqf_wrbuf = wrbuf_alloc();
1352 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1354 else if (query->which == Z_Query_type_2)
1357 ccl_wrbuf = wrbuf_alloc();
1358 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1359 query->u.type_2->len);
1361 else if (query->which == Z_Query_type_104 &&
1362 query->u.type_104->which == Z_External_CQL)
1365 const char *cql = query->u.type_104->u.cql;
1366 CQL_parser cp = cql_parser_create();
1367 int r = cql_parser_string(cp, cql);
1370 cql_parser_destroy(cp);
1372 odr.create_searchResponse(apdu_req,
1373 YAZ_BIB1_MALFORMED_QUERY,
1374 "CQL syntax error");
1375 package.response() = apdu_res;
1378 struct cql_node *cn = cql_parser_result(cp);
1379 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1382 // hopefully we are getting a ptr to a index+relation+term node
1384 if (cn_error->which == CQL_NODE_ST)
1385 addinfo = cn_error->u.st.index;
1388 odr.create_searchResponse(apdu_req,
1389 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1391 package.response() = apdu_res;
1396 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1399 ccl_wrbuf = wrbuf_alloc();
1400 wrbuf_puts(ccl_wrbuf, ccl_buf);
1402 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1404 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1405 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1406 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1408 wrbuf_destroy(sru_sortkeys_wrbuf);
1410 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1411 yaz_tok_parse_t tp =
1412 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1413 yaz_tok_cfg_destroy(tc);
1415 /* go through sortspec and map fields */
1416 int token = yaz_tok_move(tp);
1417 while (token != YAZ_TOK_EOF)
1419 if (token == YAZ_TOK_STRING)
1421 const char *field = yaz_tok_parse_string(tp);
1422 std::map<std::string,std::string>::iterator it;
1423 it = b->sptr->sortmap.find(field);
1424 if (it != b->sptr->sortmap.end())
1425 sortkeys += it->second;
1430 token = yaz_tok_move(tp);
1431 if (token == YAZ_TOK_STRING)
1433 sortkeys += yaz_tok_parse_string(tp);
1435 if (token != YAZ_TOK_EOF)
1438 token = yaz_tok_move(tp);
1441 yaz_tok_parse_destroy(tp);
1442 wrbuf_destroy(sort_spec_wrbuf);
1444 cql_parser_destroy(cp);
1448 odr.create_searchResponse(apdu_req,
1449 YAZ_BIB1_MALFORMED_QUERY,
1450 "CQL to CCL conversion error");
1451 package.response() = apdu_res;
1458 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1459 package.response() = apdu_res;
1466 assert(pqf_wrbuf == 0);
1468 struct ccl_rpn_node *cn;
1469 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1470 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1472 wrbuf_destroy(ccl_wrbuf);
1475 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1476 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1480 case CCL_ERR_UNKNOWN_QUAL:
1481 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1483 case CCL_ERR_TRUNC_NOT_LEFT:
1484 case CCL_ERR_TRUNC_NOT_RIGHT:
1485 case CCL_ERR_TRUNC_NOT_BOTH:
1486 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1490 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1491 package.response() = apdu_res;
1494 pqf_wrbuf = wrbuf_alloc();
1495 ccl_pquery(pqf_wrbuf, cn);
1496 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1502 ZOOM_query q = ZOOM_query_create();
1503 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1505 if (b->get_option("sru"))
1509 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1510 WRBUF wrb = wrbuf_alloc();
1512 if (!strcmp(b->get_option("sru"), "solr"))
1514 solr_transform_t cqlt = solr_transform_create();
1516 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1518 solr_transform_close(cqlt);
1522 cql_transform_t cqlt = cql_transform_create();
1524 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1526 cql_transform_close(cqlt);
1530 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1531 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1532 b->search(q, &hits, &error, &addinfo, odr);
1534 ZOOM_query_destroy(q);
1537 wrbuf_destroy(pqf_wrbuf);
1541 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1542 "can not convert from RPN to CQL/SOLR");
1543 package.response() = apdu_res;
1549 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
1550 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1551 b->search(q, &hits, &error, &addinfo, odr);
1552 ZOOM_query_destroy(q);
1553 wrbuf_destroy(pqf_wrbuf);
1556 const char *element_set_name = 0;
1557 Odr_int number_to_present = 0;
1559 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1561 Odr_int number_of_records_returned = 0;
1562 Z_Records *records = get_records(
1563 0, number_to_present, &error, &addinfo,
1564 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1566 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1569 apdu_res->u.searchResponse->records = records;
1570 apdu_res->u.searchResponse->numberOfRecordsReturned =
1571 odr_intdup(odr, number_of_records_returned);
1573 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1574 package.response() = apdu_res;
1577 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1579 Z_GDU *gdu = package.request().get();
1580 Z_APDU *apdu_req = gdu->u.z3950;
1581 Z_APDU *apdu_res = 0;
1582 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1587 package.response() = odr.create_presentResponse(
1588 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1591 const char *element_set_name = 0;
1592 Z_RecordComposition *comp = pr->recordComposition;
1593 if (comp && comp->which != Z_RecordComp_simple)
1595 package.response() = odr.create_presentResponse(
1597 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1600 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1601 element_set_name = comp->u.simple->u.generic;
1602 Odr_int number_of_records_returned = 0;
1605 Z_Records *records = get_records(
1606 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1607 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1608 pr->preferredRecordSyntax, element_set_name);
1610 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1613 apdu_res->u.presentResponse->records = records;
1614 apdu_res->u.presentResponse->numberOfRecordsReturned =
1615 odr_intdup(odr, number_of_records_returned);
1617 package.response() = apdu_res;
1620 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1622 Z_GDU *gdu = package.request().get();
1625 else if (gdu->which == Z_GDU_Z3950)
1627 Z_APDU *apdu_req = gdu->u.z3950;
1628 if (apdu_req->which == Z_APDU_initRequest)
1631 package.response() = odr.create_close(
1633 Z_Close_protocolError,
1636 else if (apdu_req->which == Z_APDU_searchRequest)
1638 handle_search(package);
1640 else if (apdu_req->which == Z_APDU_presentRequest)
1642 handle_present(package);
1647 package.response() = odr.create_close(
1649 Z_Close_protocolError,
1650 "zoom filter cannot handle this APDU");
1651 package.session().close();
1656 package.session().close();
1660 void yf::Zoom::Impl::process(mp::Package &package)
1662 FrontendPtr f = get_frontend(package);
1663 Z_GDU *gdu = package.request().get();
1665 if (f->m_is_virtual)
1667 f->handle_package(package);
1669 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1672 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1673 f->m_init_gdu = gdu;
1676 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1677 Z_InitResponse *resp = apdu->u.initResponse;
1680 static const int masks[] = {
1685 for (i = 0; masks[i] != -1; i++)
1686 if (ODR_MASK_GET(req->options, masks[i]))
1687 ODR_MASK_SET(resp->options, masks[i]);
1689 static const int versions[] = {
1690 Z_ProtocolVersion_1,
1691 Z_ProtocolVersion_2,
1692 Z_ProtocolVersion_3,
1695 for (i = 0; versions[i] != -1; i++)
1696 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1697 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1701 *resp->preferredMessageSize = *req->preferredMessageSize;
1702 *resp->maximumRecordSize = *req->maximumRecordSize;
1704 package.response() = apdu;
1705 f->m_is_virtual = true;
1710 release_frontend(package);
1714 static mp::filter::Base* filter_creator()
1716 return new mp::filter::Zoom;
1720 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1731 * c-file-style: "Stroustrup"
1732 * indent-tabs-mode: nil
1734 * vim: shiftwidth=4 tabstop=8 expandtab