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"
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include <metaproxy/xmlutil.hpp>
29 #include <libxslt/xsltutils.h>
30 #include <libxslt/transform.h>
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
35 #include <yaz/yaz-version.h>
36 #include <yaz/tpath.h>
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>
53 namespace mp = metaproxy_1;
54 namespace yf = mp::filter;
56 namespace metaproxy_1 {
58 class Zoom::Searchable : boost::noncopyable {
60 std::string authentication;
66 std::string query_encoding;
68 std::string sru_version;
69 std::string request_syntax;
70 std::string element_set;
71 std::string record_encoding;
72 std::string transform_xsl_fname;
73 std::string transform_xsl_content;
74 std::string urlRecipe;
75 std::string contentConnector;
76 std::string sortStrategy;
79 CCL_bibset ccl_bibset;
80 std::map<std::string, std::string> sortmap;
81 Searchable(CCL_bibset base);
84 class Zoom::Backend : boost::noncopyable {
86 friend class Frontend;
89 ZOOM_connection m_connection;
90 ZOOM_resultset m_resultset;
91 std::string m_frontend_database;
93 xsltStylesheetPtr xsp;
94 std::string content_session_id;
96 Backend(SearchablePtr sptr);
98 void connect(std::string zurl, int *error, char **addinfo,
100 void search(ZOOM_query q, Odr_int *hits,
101 int *error, char **addinfo, ODR odr);
102 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
103 int *error, char **addinfo, ODR odr);
104 void set_option(const char *name, const char *value);
105 void set_option(const char *name, std::string value);
106 const char *get_option(const char *name);
107 void get_zoom_error(int *error, char **addinfo, ODR odr);
109 class Zoom::Frontend : boost::noncopyable {
114 yazpp_1::GDU m_init_gdu;
115 BackendPtr m_backend;
116 void handle_package(mp::Package &package);
117 void handle_search(mp::Package &package);
118 void handle_present(mp::Package &package);
119 BackendPtr get_backend_from_databases(mp::Package &package,
120 std::string &database,
125 bool create_content_session(mp::Package &package,
130 std::string authentication,
133 void prepare_elements(BackendPtr b,
134 Odr_oid *preferredRecordSyntax,
135 const char *element_set_name,
136 bool &enable_pz2_retrieval,
137 bool &enable_pz2_transform,
138 bool &assume_marc8_charset);
140 Z_Records *get_records(Odr_int start,
141 Odr_int number_to_present,
144 Odr_int *number_of_records_returned,
145 ODR odr, BackendPtr b,
146 Odr_oid *preferredRecordSyntax,
147 const char *element_set_name);
149 Frontend(Impl *impl);
153 friend class Frontend;
157 void process(metaproxy_1::Package & package);
158 void configure(const xmlNode * ptr, bool test_only,
161 void configure_local_records(const xmlNode * ptr, bool test_only);
162 FrontendPtr get_frontend(mp::Package &package);
163 void release_frontend(mp::Package &package);
164 SearchablePtr parse_torus_record(const xmlNode *ptr);
165 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
166 std::map<mp::Session, FrontendPtr> m_clients;
167 boost::mutex m_mutex;
168 boost::condition m_cond_session_ready;
169 std::string torus_url;
170 std::string default_realm;
171 std::map<std::string,std::string> fieldmap;
173 std::string file_path;
174 std::string content_proxy_server;
175 std::string content_tmp_file;
178 std::string element_transform;
179 std::string element_raw;
181 std::map<std::string,SearchablePtr> s_map;
186 // define Pimpl wrapper forwarding to Impl
188 yf::Zoom::Zoom() : m_p(new Impl)
193 { // must have a destructor because of boost::scoped_ptr
196 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
199 m_p->configure(xmlnode, test_only, path);
202 void yf::Zoom::process(mp::Package &package) const
204 m_p->process(package);
208 // define Implementation stuff
210 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
212 m_apdu_wrbuf = wrbuf_alloc();
213 m_connection = ZOOM_connection_create(0);
214 ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf);
219 yf::Zoom::Backend::~Backend()
222 xsltFreeStylesheet(xsp);
223 ZOOM_connection_destroy(m_connection);
224 ZOOM_resultset_destroy(m_resultset);
228 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
232 const char *zoom_addinfo = 0;
233 const char *dset = 0;
234 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
237 if (*error >= ZOOM_ERROR_CONNECT)
239 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
240 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
241 *addinfo = (char *) odr_malloc(
242 odr, 20 + strlen(msg) +
243 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
244 strcpy(*addinfo, msg);
247 strcat(*addinfo, ": ");
248 strcat(*addinfo, zoom_addinfo);
253 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
254 *error = yaz_diag_srw_to_bib1(*error);
255 *addinfo = (char *) odr_malloc(
256 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
258 if (zoom_addinfo && *zoom_addinfo)
260 strcpy(*addinfo, zoom_addinfo);
261 strcat(*addinfo, " ");
263 strcat(*addinfo, "(backend)");
268 void yf::Zoom::Backend::connect(std::string zurl,
269 int *error, char **addinfo,
272 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
273 get_zoom_error(error, addinfo, odr);
276 void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits,
277 int *error, char **addinfo, ODR odr)
279 m_resultset = ZOOM_connection_search(m_connection, q);
280 get_zoom_error(error, addinfo, odr);
282 *hits = ZOOM_resultset_size(m_resultset);
287 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
289 int *error, char **addinfo, ODR odr)
291 ZOOM_resultset_records(m_resultset, recs, start, number);
292 get_zoom_error(error, addinfo, odr);
295 void yf::Zoom::Backend::set_option(const char *name, const char *value)
297 ZOOM_connection_option_set(m_connection, name, value);
299 ZOOM_resultset_option_set(m_resultset, name, value);
302 void yf::Zoom::Backend::set_option(const char *name, std::string value)
304 set_option(name, value.c_str());
307 const char *yf::Zoom::Backend::get_option(const char *name)
309 return ZOOM_connection_option_get(m_connection, name);
312 yf::Zoom::Searchable::Searchable(CCL_bibset base)
315 use_turbomarc = true;
316 sortStrategy = "embed";
317 ccl_bibset = ccl_qual_dup(base);
320 yf::Zoom::Searchable::~Searchable()
322 ccl_qual_rm(&ccl_bibset);
325 yf::Zoom::Frontend::Frontend(Impl *impl) :
326 m_p(impl), m_is_virtual(false), m_in_use(true)
330 yf::Zoom::Frontend::~Frontend()
334 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
336 boost::mutex::scoped_lock lock(m_mutex);
338 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
342 it = m_clients.find(package.session());
343 if (it == m_clients.end())
346 if (!it->second->m_in_use)
348 it->second->m_in_use = true;
351 m_cond_session_ready.wait(lock);
353 FrontendPtr f(new Frontend(this));
354 m_clients[package.session()] = f;
359 void yf::Zoom::Impl::release_frontend(mp::Package &package)
361 boost::mutex::scoped_lock lock(m_mutex);
362 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
364 it = m_clients.find(package.session());
365 if (it != m_clients.end())
367 if (package.session().is_closed())
373 it->second->m_in_use = false;
375 m_cond_session_ready.notify_all();
379 yf::Zoom::Impl::Impl() :
380 apdu_log(false), element_transform("pz2") , element_raw("raw")
382 bibset = ccl_qual_mk();
384 srand((unsigned int) time(0));
387 yf::Zoom::Impl::~Impl()
389 ccl_qual_rm(&bibset);
392 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
394 Zoom::SearchablePtr s(new Searchable(bibset));
396 for (ptr = ptr->children; ptr; ptr = ptr->next)
398 if (ptr->type != XML_ELEMENT_NODE)
400 if (!strcmp((const char *) ptr->name, "layer"))
402 else if (!strcmp((const char *) ptr->name,
405 s->authentication = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name,
410 s->cfAuth = mp::xml::get_text(ptr);
412 else if (!strcmp((const char *) ptr->name,
415 s->cfProxy = mp::xml::get_text(ptr);
417 else if (!strcmp((const char *) ptr->name,
420 s->cfSubDB = mp::xml::get_text(ptr);
422 else if (!strcmp((const char *) ptr->name,
425 s->contentConnector = mp::xml::get_text(ptr);
427 else if (!strcmp((const char *) ptr->name, "udb"))
429 s->udb = mp::xml::get_text(ptr);
431 else if (!strcmp((const char *) ptr->name, "zurl"))
433 s->target = mp::xml::get_text(ptr);
435 else if (!strcmp((const char *) ptr->name, "sru"))
437 s->sru = mp::xml::get_text(ptr);
439 else if (!strcmp((const char *) ptr->name, "SRUVersion"))
441 s->sru_version = mp::xml::get_text(ptr);
443 else if (!strcmp((const char *) ptr->name,
446 s->query_encoding = mp::xml::get_text(ptr);
448 else if (!strcmp((const char *) ptr->name,
451 s->piggyback = mp::xml::get_bool(ptr, true);
453 else if (!strcmp((const char *) ptr->name,
456 s->request_syntax = mp::xml::get_text(ptr);
458 else if (!strcmp((const char *) ptr->name,
461 s->element_set = mp::xml::get_text(ptr);
463 else if (!strcmp((const char *) ptr->name,
466 s->record_encoding = mp::xml::get_text(ptr);
468 else if (!strcmp((const char *) ptr->name,
471 s->transform_xsl_fname = mp::xml::get_text(ptr);
473 else if (!strcmp((const char *) ptr->name,
476 s->transform_xsl_content = mp::xml::get_text(ptr);
478 else if (!strcmp((const char *) ptr->name,
481 s->urlRecipe = mp::xml::get_text(ptr);
483 else if (!strcmp((const char *) ptr->name,
486 ; // useTurboMarc is ignored
488 else if (!strncmp((const char *) ptr->name,
491 std::string value = mp::xml::get_text(ptr);
492 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
493 (const char *) ptr->name + 7);
495 else if (!strncmp((const char *) ptr->name,
498 std::string value = mp::xml::get_text(ptr);
499 s->sortmap[(const char *) ptr->name + 8] = value;
501 else if (!strcmp((const char *) ptr->name,
504 s->sortStrategy = mp::xml::get_text(ptr);
510 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
512 while (ptr && ptr->type != XML_ELEMENT_NODE)
517 if (!strcmp((const char *) ptr->name, "records"))
519 for (ptr = ptr->children; ptr; ptr = ptr->next)
521 if (ptr->type != XML_ELEMENT_NODE)
523 if (!strcmp((const char *) ptr->name, "record"))
525 SearchablePtr s = parse_torus_record(ptr);
528 std::string udb = s->udb;
533 throw mp::filter::FilterException
534 ("No udb for local torus record");
540 throw mp::filter::FilterException
542 + std::string((const char *) ptr->name)
543 + " in zoom filter inside element "
550 throw mp::filter::FilterException
552 + std::string((const char *) ptr->name)
553 + " in zoom filter inside element <torus>");
558 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
561 content_tmp_file = "/tmp/cf.XXXXXX.p";
566 for (ptr = ptr->children; ptr; ptr = ptr->next)
568 if (ptr->type != XML_ELEMENT_NODE)
570 else if (!strcmp((const char *) ptr->name, "torus"))
572 const struct _xmlAttr *attr;
573 for (attr = ptr->properties; attr; attr = attr->next)
575 if (!strcmp((const char *) attr->name, "url"))
576 torus_url = mp::xml::get_text(attr->children);
577 else if (!strcmp((const char *) attr->name, "realm"))
578 default_realm = mp::xml::get_text(attr->children);
579 else if (!strcmp((const char *) attr->name, "xsldir"))
580 xsldir = mp::xml::get_text(attr->children);
581 else if (!strcmp((const char *) attr->name, "element_transform"))
582 element_transform = mp::xml::get_text(attr->children);
583 else if (!strcmp((const char *) attr->name, "element_raw"))
584 element_raw = mp::xml::get_text(attr->children);
585 else if (!strcmp((const char *) attr->name, "proxy"))
586 proxy = mp::xml::get_text(attr->children);
588 throw mp::filter::FilterException(
589 "Bad attribute " + std::string((const char *)
592 configure_local_records(ptr->children, test_only);
594 else if (!strcmp((const char *) ptr->name, "cclmap"))
596 const char *addinfo = 0;
597 ccl_xml_config(bibset, ptr, &addinfo);
599 else if (!strcmp((const char *) ptr->name, "fieldmap"))
601 const struct _xmlAttr *attr;
602 std::string ccl_field;
603 std::string cql_field;
604 for (attr = ptr->properties; attr; attr = attr->next)
606 if (!strcmp((const char *) attr->name, "ccl"))
607 ccl_field = mp::xml::get_text(attr->children);
608 else if (!strcmp((const char *) attr->name, "cql"))
609 cql_field = mp::xml::get_text(attr->children);
611 throw mp::filter::FilterException(
612 "Bad attribute " + std::string((const char *)
615 if (cql_field.length())
616 fieldmap[cql_field] = ccl_field;
618 else if (!strcmp((const char *) ptr->name, "contentProxy"))
620 const struct _xmlAttr *attr;
621 for (attr = ptr->properties; attr; attr = attr->next)
623 if (!strcmp((const char *) attr->name, "server"))
624 content_proxy_server = mp::xml::get_text(attr->children);
625 else if (!strcmp((const char *) attr->name, "tmp_file"))
626 content_tmp_file = mp::xml::get_text(attr->children);
628 throw mp::filter::FilterException(
629 "Bad attribute " + std::string((const char *)
633 else if (!strcmp((const char *) ptr->name, "log"))
635 const struct _xmlAttr *attr;
636 for (attr = ptr->properties; attr; attr = attr->next)
638 if (!strcmp((const char *) attr->name, "apdu"))
639 apdu_log = mp::xml::get_bool(attr->children, false);
641 throw mp::filter::FilterException(
642 "Bad attribute " + std::string((const char *)
648 throw mp::filter::FilterException
650 + std::string((const char *) ptr->name)
651 + " in zoom filter");
656 bool yf::Zoom::Frontend::create_content_session(mp::Package &package,
658 int *error, char **addinfo,
660 std::string authentication,
663 if (b->sptr->contentConnector.length())
665 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
666 strcpy(fname, m_p->content_tmp_file.c_str());
667 char *xx = strstr(fname, "XXXXXX");
670 xx = fname + strlen(fname);
671 strcat(fname, "XXXXXX");
673 char tmp_char = xx[6];
674 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
677 FILE *file = fopen(fname, "w");
680 package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname);
681 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
682 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
683 sprintf(*addinfo, "Could not create %s", fname);
687 b->content_session_id.assign(xx, 6);
688 WRBUF w = wrbuf_alloc();
689 wrbuf_puts(w, "#content_proxy\n");
690 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
691 if (authentication.length())
692 wrbuf_printf(w, "auth: %s\n", authentication.c_str());
694 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
696 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
698 package.log("zoom", YLOG_LOG, "content file: %s", fname);
704 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
705 mp::Package &package,
706 std::string &database, int *error, char **addinfo, ODR odr)
708 std::list<BackendPtr>::const_iterator map_it;
709 if (m_backend && m_backend->m_frontend_database == database)
712 std::string input_args;
713 std::string torus_db;
714 size_t db_arg_pos = database.find(',');
715 if (db_arg_pos != std::string::npos)
717 torus_db = database.substr(0, db_arg_pos);
718 input_args = database.substr(db_arg_pos + 1);
723 std::string authentication;
725 std::string realm = m_p->default_realm;
727 const char *param_user = 0;
728 const char *param_password = 0;
734 if (input_args.length())
735 no_parms = yaz_uri_to_array(input_args.c_str(),
736 odr, &names, &values);
737 // adding 10 because we'll be adding other URL args
738 const char **out_names = (const char **)
739 odr_malloc(odr, (10 + no_parms) * sizeof(*out_names));
740 const char **out_values = (const char **)
741 odr_malloc(odr, (10 + no_parms) * sizeof(*out_values));
744 for (i = 0; i < no_parms; i++)
746 const char *name = names[i];
747 const char *value = values[i];
750 if (!strcmp(name, "user"))
752 else if (!strcmp(name, "password"))
753 param_password = value;
754 else if (!strcmp(name, "proxy"))
756 else if (!strcmp(name, "cproxysession"))
758 out_names[no_out_args] = name;
759 out_values[no_out_args++] = value;
761 else if (!strcmp(name, "realm"))
763 else if (name[0] == 'x' && name[1] == '-')
765 out_names[no_out_args] = name;
766 out_values[no_out_args++] = value;
771 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
772 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
773 sprintf(msg, "Bad database argument: %s", name);
780 authentication = std::string(param_user);
782 authentication += "/" + std::string(param_password);
786 std::map<std::string,SearchablePtr>::iterator it;
787 it = m_p->s_map.find(torus_db);
788 if (it != m_p->s_map.end())
790 else if (m_p->torus_url.length() > 0)
792 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm,
796 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
797 *addinfo = odr_strdup(odr, database.c_str());
801 const xmlNode *ptr = xmlDocGetRootElement(doc);
803 { // presumably ptr is a records element node
804 // parse first record in document
805 for (ptr = ptr->children; ptr; ptr = ptr->next)
807 if (ptr->type == XML_ELEMENT_NODE
808 && !strcmp((const char *) ptr->name, "record"))
812 *error = YAZ_BIB1_UNSPECIFIED_ERROR;
813 *addinfo = (char*) odr_malloc(odr, 40 + database.length()),
814 sprintf(*addinfo, "multiple records for udb=%s",
820 sptr = m_p->parse_torus_record(ptr);
829 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
830 *addinfo = odr_strdup(odr, database.c_str());
835 xsltStylesheetPtr xsp = 0;
836 if (sptr->transform_xsl_content.length())
838 xmlDoc *xsp_doc = xmlParseMemory(sptr->transform_xsl_content.c_str(),
839 sptr->transform_xsl_content.length());
842 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
843 *addinfo = (char *) odr_malloc(odr, 40);
844 sprintf(*addinfo, "xmlParseMemory failed");
848 xsp = xsltParseStylesheetDoc(xsp_doc);
851 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
852 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
858 else if (sptr->transform_xsl_fname.length())
860 const char *path = 0;
862 if (m_p->xsldir.length())
863 path = m_p->xsldir.c_str();
865 path = m_p->file_path.c_str();
869 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
875 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
877 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
878 sprintf(*addinfo, "File could not be read: %s",
879 sptr->transform_xsl_fname.c_str());
883 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
886 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
887 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
888 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
892 xsp = xsltParseStylesheetDoc(xsp_doc);
895 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
896 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
905 BackendPtr b(new Backend(sptr));
908 b->m_frontend_database = database;
910 if (sptr->query_encoding.length())
911 b->set_option("rpnCharset", sptr->query_encoding);
913 b->set_option("timeout", "40");
916 b->set_option("apdulog", "1");
919 b->set_option("count", "1"); /* some SRU servers INSIST on getting
920 maximumRecords > 0 */
921 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
923 if (authentication.length() == 0)
924 authentication = sptr->authentication;
926 if (proxy.length() == 0)
927 proxy = sptr->cfProxy;
929 if (sptr->cfAuth.length())
932 b->set_option("user", sptr->cfAuth);
933 if (authentication.length())
935 size_t found = authentication.find('/');
936 if (found != std::string::npos)
938 out_names[no_out_args] = "user";
939 out_values[no_out_args++] =
940 odr_strdup(odr, authentication.substr(0, found).c_str());
942 out_names[no_out_args] = "password";
943 out_values[no_out_args++] =
944 odr_strdup(odr, authentication.substr(found+1).c_str());
948 out_names[no_out_args] = "user";
949 out_values[no_out_args++] =
950 odr_strdup(odr, authentication.c_str());
955 out_names[no_out_args] = "proxy";
956 out_values[no_out_args++] = odr_strdup(odr, proxy.c_str());
958 if (sptr->cfSubDB.length())
960 out_names[no_out_args] = "subdatabase";
961 out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str());
966 size_t found = authentication.find('/');
968 if (sptr->sru.length() && found != std::string::npos)
970 b->set_option("user", authentication.substr(0, found));
971 b->set_option("password", authentication.substr(found+1));
974 b->set_option("user", authentication);
977 b->set_option("proxy", proxy);
980 if (sptr->sru.length())
982 url = "http://" + sptr->target;
983 b->set_option("sru", sptr->sru);
985 if (sptr->sru_version.length())
986 b->set_option("sru_version", sptr->sru_version);
995 out_names[no_out_args] = 0; // terminate list
997 yaz_array_to_uri(&x_args, odr, (char **) out_names,
998 (char **) out_values);
999 url += "," + std::string(x_args);
1001 package.log("zoom", YLOG_LOG, "url: %s", url.c_str());
1002 b->connect(url, error, addinfo, odr);
1004 create_content_session(package, b, error, addinfo, odr,
1005 authentication, proxy);
1011 void yf::Zoom::Frontend::prepare_elements(BackendPtr b,
1012 Odr_oid *preferredRecordSyntax,
1013 const char *element_set_name,
1014 bool &enable_pz2_retrieval,
1015 bool &enable_pz2_transform,
1016 bool &assume_marc8_charset)
1019 char oid_name_str[OID_STR_MAX];
1020 const char *syntax_name = 0;
1022 if (preferredRecordSyntax &&
1023 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
1024 && element_set_name)
1026 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
1028 enable_pz2_retrieval = true;
1029 enable_pz2_transform = true;
1031 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
1033 enable_pz2_retrieval = true;
1037 if (enable_pz2_retrieval)
1039 std::string configured_request_syntax = b->sptr->request_syntax;
1040 if (configured_request_syntax.length())
1042 syntax_name = configured_request_syntax.c_str();
1043 const Odr_oid *syntax_oid =
1044 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
1045 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
1046 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
1047 assume_marc8_charset = true;
1050 else if (preferredRecordSyntax)
1052 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
1054 if (b->sptr->sru.length())
1055 syntax_name = "XML";
1057 b->set_option("preferredRecordSyntax", syntax_name);
1059 if (enable_pz2_retrieval)
1061 element_set_name = 0;
1062 if (b->sptr->element_set.length())
1063 element_set_name = b->sptr->element_set.c_str();
1066 b->set_option("elementSetName", element_set_name);
1067 if (b->sptr->sru.length() && element_set_name)
1068 b->set_option("schema", element_set_name);
1071 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
1072 Odr_int number_to_present,
1075 Odr_int *number_of_records_returned,
1078 Odr_oid *preferredRecordSyntax,
1079 const char *element_set_name)
1081 *number_of_records_returned = 0;
1082 Z_Records *records = 0;
1083 bool enable_pz2_retrieval = false; // whether target profile is used
1084 bool enable_pz2_transform = false; // whether XSLT is used as well
1085 bool assume_marc8_charset = false;
1087 prepare_elements(b, preferredRecordSyntax,
1089 enable_pz2_retrieval,
1090 enable_pz2_transform,
1091 assume_marc8_charset);
1093 if (start < 0 || number_to_present <=0)
1096 if (number_to_present > 10000)
1097 number_to_present = 10000;
1099 ZOOM_record *recs = (ZOOM_record *)
1100 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
1102 b->present(start, number_to_present, recs, error, addinfo, odr);
1107 for (i = 0; i < number_to_present; i++)
1112 { // only return records if no error and at least one record
1113 char *odr_database = odr_strdup(odr,
1114 b->m_frontend_database.c_str());
1115 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
1116 odr_malloc(odr, sizeof(*npl));
1117 *number_of_records_returned = i;
1118 npl->num_records = i;
1119 npl->records = (Z_NamePlusRecord **)
1120 odr_malloc(odr, i * sizeof(*npl->records));
1121 for (i = 0; i < number_to_present; i++)
1123 Z_NamePlusRecord *npr = 0;
1124 const char *addinfo;
1125 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1126 &addinfo, 0 /* diagset */);
1130 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1133 else if (enable_pz2_retrieval)
1135 char rec_type_str[100];
1136 const char *record_encoding = 0;
1138 if (b->sptr->record_encoding.length())
1139 record_encoding = b->sptr->record_encoding.c_str();
1140 else if (assume_marc8_charset)
1141 record_encoding = "marc8";
1143 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1144 if (record_encoding)
1146 strcat(rec_type_str, "; charset=");
1147 strcat(rec_type_str, record_encoding);
1151 xmlChar *xmlrec_buf = 0;
1152 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1154 if (!rec_buf && !npr)
1156 std::string addinfo("ZOOM_record_get failed for type ");
1158 addinfo += rec_type_str;
1159 npr = zget_surrogateDiagRec(
1161 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1165 if (rec_buf && b->xsp && enable_pz2_transform)
1167 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1170 npr = zget_surrogateDiagRec(
1172 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1173 "xml parse failed for record");
1178 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1182 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1184 rec_buf = (const char *) xmlrec_buf;
1186 xmlFreeDoc(rec_res);
1190 std::string addinfo;
1192 addinfo = "xslt apply failed for "
1193 + b->sptr->transform_xsl_fname;
1194 npr = zget_surrogateDiagRec(
1196 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1199 xmlFreeDoc(rec_doc);
1205 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1207 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1208 if (res.length() && b->content_session_id.length())
1210 size_t off = res.find_first_of("://");
1211 if (off != std::string::npos)
1214 sprintf(tmp, "%s.%s/",
1215 b->content_session_id.c_str(),
1216 m_p->content_proxy_server.c_str());
1217 res.insert(off + 3, tmp);
1222 xmlNode *ptr = xmlDocGetRootElement(doc);
1223 while (ptr && ptr->type != XML_ELEMENT_NODE)
1226 xmlNewChild(ptr, 0, BAD_CAST "metadata", 0);
1227 xmlNewProp(c, BAD_CAST "type", BAD_CAST
1229 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1233 xmlFree(xmlrec_buf);
1235 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1236 rec_buf = (const char *) xmlrec_buf;
1243 npr = zget_surrogateDiagRec(
1245 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1249 npr = (Z_NamePlusRecord *)
1250 odr_malloc(odr, sizeof(*npr));
1251 npr->databaseName = odr_database;
1252 npr->which = Z_NamePlusRecord_databaseRecord;
1253 npr->u.databaseRecord =
1254 z_ext_record_xml(odr, rec_buf, rec_len);
1258 xmlFree(xmlrec_buf);
1263 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1266 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1267 npr->databaseName = odr_database;
1268 npr->which = Z_NamePlusRecord_databaseRecord;
1269 npr->u.databaseRecord = ext;
1273 npr = zget_surrogateDiagRec(
1275 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1276 "ZOOM_record, type ext");
1279 npl->records[i] = npr;
1281 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1282 records->which = Z_Records_DBOSD;
1283 records->u.databaseOrSurDiagnostics = npl;
1288 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1291 struct cql_node *r = 0;
1299 std::map<std::string,std::string>::const_iterator it;
1300 it = fieldmap.find(cn->u.st.index);
1301 if (it == fieldmap.end())
1303 if (it->second.length())
1304 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1310 r = convert_cql_fields(cn->u.boolean.left, odr);
1312 r = convert_cql_fields(cn->u.boolean.right, odr);
1315 r = convert_cql_fields(cn->u.sort.search, odr);
1321 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1323 Z_GDU *gdu = package.request().get();
1324 Z_APDU *apdu_req = gdu->u.z3950;
1325 Z_APDU *apdu_res = 0;
1327 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1328 if (sr->num_databaseNames != 1)
1330 apdu_res = odr.create_searchResponse(
1331 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1332 package.response() = apdu_res;
1338 std::string db(sr->databaseNames[0]);
1339 BackendPtr b = get_backend_from_databases(package, db, &error,
1344 odr.create_searchResponse(apdu_req, error, addinfo);
1345 package.response() = apdu_res;
1349 b->set_option("setname", "default");
1351 bool enable_pz2_retrieval = false;
1352 bool enable_pz2_transform = false;
1353 bool assume_marc8_charset = false;
1354 prepare_elements(b, sr->preferredRecordSyntax, 0 /*element_set_name */,
1355 enable_pz2_retrieval,
1356 enable_pz2_transform,
1357 assume_marc8_charset);
1360 Z_Query *query = sr->query;
1361 WRBUF ccl_wrbuf = 0;
1362 WRBUF pqf_wrbuf = 0;
1363 std::string sortkeys;
1365 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1368 pqf_wrbuf = wrbuf_alloc();
1369 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1371 else if (query->which == Z_Query_type_2)
1374 ccl_wrbuf = wrbuf_alloc();
1375 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1376 query->u.type_2->len);
1378 else if (query->which == Z_Query_type_104 &&
1379 query->u.type_104->which == Z_External_CQL)
1382 const char *cql = query->u.type_104->u.cql;
1383 CQL_parser cp = cql_parser_create();
1384 int r = cql_parser_string(cp, cql);
1385 package.log("zoom", YLOG_LOG, "CQL: %s", cql);
1388 cql_parser_destroy(cp);
1389 package.log("zoom", YLOG_WARN, "CQL syntax error");
1391 odr.create_searchResponse(apdu_req,
1392 YAZ_BIB1_MALFORMED_QUERY,
1393 "CQL syntax error");
1394 package.response() = apdu_res;
1397 struct cql_node *cn = cql_parser_result(cp);
1398 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1401 // hopefully we are getting a ptr to a index+relation+term node
1403 if (cn_error->which == CQL_NODE_ST)
1404 addinfo = cn_error->u.st.index;
1407 odr.create_searchResponse(apdu_req,
1408 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1410 package.response() = apdu_res;
1415 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1418 ccl_wrbuf = wrbuf_alloc();
1419 wrbuf_puts(ccl_wrbuf, ccl_buf);
1421 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1423 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1424 WRBUF sort_spec_wrbuf = wrbuf_alloc();
1425 yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf),
1427 wrbuf_destroy(sru_sortkeys_wrbuf);
1429 yaz_tok_cfg_t tc = yaz_tok_cfg_create();
1430 yaz_tok_parse_t tp =
1431 yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf));
1432 yaz_tok_cfg_destroy(tc);
1434 /* go through sortspec and map fields */
1435 int token = yaz_tok_move(tp);
1436 while (token != YAZ_TOK_EOF)
1438 if (token == YAZ_TOK_STRING)
1440 const char *field = yaz_tok_parse_string(tp);
1441 std::map<std::string,std::string>::iterator it;
1442 it = b->sptr->sortmap.find(field);
1443 if (it != b->sptr->sortmap.end())
1444 sortkeys += it->second;
1449 token = yaz_tok_move(tp);
1450 if (token == YAZ_TOK_STRING)
1452 sortkeys += yaz_tok_parse_string(tp);
1454 if (token != YAZ_TOK_EOF)
1457 token = yaz_tok_move(tp);
1460 yaz_tok_parse_destroy(tp);
1461 wrbuf_destroy(sort_spec_wrbuf);
1463 cql_parser_destroy(cp);
1467 odr.create_searchResponse(apdu_req,
1468 YAZ_BIB1_MALFORMED_QUERY,
1469 "CQL to CCL conversion error");
1470 package.response() = apdu_res;
1477 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1478 package.response() = apdu_res;
1485 assert(pqf_wrbuf == 0);
1487 struct ccl_rpn_node *cn;
1488 package.log("zoom", YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1489 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1491 wrbuf_destroy(ccl_wrbuf);
1494 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1495 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1499 case CCL_ERR_UNKNOWN_QUAL:
1500 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1502 case CCL_ERR_TRUNC_NOT_LEFT:
1503 case CCL_ERR_TRUNC_NOT_RIGHT:
1504 case CCL_ERR_TRUNC_NOT_BOTH:
1505 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1509 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1510 package.response() = apdu_res;
1513 pqf_wrbuf = wrbuf_alloc();
1514 ccl_pquery(pqf_wrbuf, cn);
1515 package.log("zoom", YLOG_LOG, "RPN: %s", wrbuf_cstr(pqf_wrbuf));
1521 ZOOM_query q = ZOOM_query_create();
1522 ZOOM_query_sortby2(q, b->sptr->sortStrategy.c_str(), sortkeys.c_str());
1524 if (b->get_option("sru"))
1528 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1529 WRBUF wrb = wrbuf_alloc();
1531 if (!strcmp(b->get_option("sru"), "solr"))
1533 solr_transform_t cqlt = solr_transform_create();
1535 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1537 solr_transform_close(cqlt);
1541 cql_transform_t cqlt = cql_transform_create();
1543 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1545 cql_transform_close(cqlt);
1549 ZOOM_query_cql(q, wrbuf_cstr(wrb));
1550 package.log("zoom", YLOG_LOG, "CQL: %s", wrbuf_cstr(wrb));
1551 b->search(q, &hits, &error, &addinfo, odr);
1553 ZOOM_query_destroy(q);
1556 wrbuf_destroy(pqf_wrbuf);
1560 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1561 "can not convert from RPN to CQL/SOLR");
1562 package.response() = apdu_res;
1568 ZOOM_query_prefix(q, wrbuf_cstr(pqf_wrbuf));
1569 package.log("zoom", YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1570 b->search(q, &hits, &error, &addinfo, odr);
1571 ZOOM_query_destroy(q);
1572 wrbuf_destroy(pqf_wrbuf);
1575 const char *element_set_name = 0;
1576 Odr_int number_to_present = 0;
1578 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1580 Odr_int number_of_records_returned = 0;
1581 Z_Records *records = get_records(
1582 0, number_to_present, &error, &addinfo,
1583 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1585 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1588 apdu_res->u.searchResponse->records = records;
1589 apdu_res->u.searchResponse->numberOfRecordsReturned =
1590 odr_intdup(odr, number_of_records_returned);
1592 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1593 package.response() = apdu_res;
1596 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1598 Z_GDU *gdu = package.request().get();
1599 Z_APDU *apdu_req = gdu->u.z3950;
1600 Z_APDU *apdu_res = 0;
1601 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1606 package.response() = odr.create_presentResponse(
1607 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1610 const char *element_set_name = 0;
1611 Z_RecordComposition *comp = pr->recordComposition;
1612 if (comp && comp->which != Z_RecordComp_simple)
1614 package.response() = odr.create_presentResponse(
1616 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1619 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1620 element_set_name = comp->u.simple->u.generic;
1621 Odr_int number_of_records_returned = 0;
1624 Z_Records *records = get_records(
1625 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1626 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1627 pr->preferredRecordSyntax, element_set_name);
1629 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1632 apdu_res->u.presentResponse->records = records;
1633 apdu_res->u.presentResponse->numberOfRecordsReturned =
1634 odr_intdup(odr, number_of_records_returned);
1636 package.response() = apdu_res;
1639 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1641 Z_GDU *gdu = package.request().get();
1644 else if (gdu->which == Z_GDU_Z3950)
1646 Z_APDU *apdu_req = gdu->u.z3950;
1649 wrbuf_rewind(m_backend->m_apdu_wrbuf);
1650 if (apdu_req->which == Z_APDU_initRequest)
1653 package.response() = odr.create_close(
1655 Z_Close_protocolError,
1658 else if (apdu_req->which == Z_APDU_searchRequest)
1660 handle_search(package);
1662 else if (apdu_req->which == Z_APDU_presentRequest)
1664 handle_present(package);
1669 package.response() = odr.create_close(
1671 Z_Close_protocolError,
1672 "zoom filter cannot handle this APDU");
1673 package.session().close();
1677 WRBUF w = m_backend->m_apdu_wrbuf;
1678 package.log_write(wrbuf_buf(w), wrbuf_len(w));
1683 package.session().close();
1687 void yf::Zoom::Impl::process(mp::Package &package)
1689 FrontendPtr f = get_frontend(package);
1690 Z_GDU *gdu = package.request().get();
1692 if (f->m_is_virtual)
1694 f->handle_package(package);
1696 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1699 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1700 f->m_init_gdu = gdu;
1703 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1704 Z_InitResponse *resp = apdu->u.initResponse;
1707 static const int masks[] = {
1712 for (i = 0; masks[i] != -1; i++)
1713 if (ODR_MASK_GET(req->options, masks[i]))
1714 ODR_MASK_SET(resp->options, masks[i]);
1716 static const int versions[] = {
1717 Z_ProtocolVersion_1,
1718 Z_ProtocolVersion_2,
1719 Z_ProtocolVersion_3,
1722 for (i = 0; versions[i] != -1; i++)
1723 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1724 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1728 *resp->preferredMessageSize = *req->preferredMessageSize;
1729 *resp->maximumRecordSize = *req->maximumRecordSize;
1731 package.response() = apdu;
1732 f->m_is_virtual = true;
1737 release_frontend(package);
1741 static mp::filter::Base* filter_creator()
1743 return new mp::filter::Zoom;
1747 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1758 * c-file-style: "Stroustrup"
1759 * indent-tabs-mode: nil
1761 * vim: shiftwidth=4 tabstop=8 expandtab