1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2011 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <sys/types.h>
23 #include "filter_zoom.hpp"
25 #include <yaz/yaz-version.h>
26 #include <yaz/tpath.h>
28 #include <metaproxy/package.hpp>
29 #include <metaproxy/util.hpp>
30 #include <metaproxy/xmlutil.hpp>
33 #include <libxslt/xsltutils.h>
34 #include <libxslt/transform.h>
36 #include <boost/thread/mutex.hpp>
37 #include <boost/thread/condition.hpp>
38 #include <yaz/ccl_xml.h>
40 #include <yaz/rpn2cql.h>
41 #include <yaz/rpn2solr.h>
42 #include <yaz/pquery.h>
44 #include <yaz/oid_db.h>
45 #include <yaz/diagbib1.h>
48 #include <yaz/querytowrbuf.h>
50 namespace mp = metaproxy_1;
51 namespace yf = mp::filter;
53 namespace metaproxy_1 {
55 struct Zoom::Searchable : boost::noncopyable {
56 std::string authentication;
62 std::string query_encoding;
64 std::string request_syntax;
65 std::string element_set;
66 std::string record_encoding;
67 std::string transform_xsl_fname;
68 std::string urlRecipe;
69 std::string contentConnector;
72 CCL_bibset ccl_bibset;
73 Searchable(CCL_bibset base);
76 class Zoom::Backend : boost::noncopyable {
78 friend class Frontend;
80 ZOOM_connection m_connection;
81 ZOOM_resultset m_resultset;
82 std::string m_frontend_database;
84 xsltStylesheetPtr xsp;
85 std::string content_session_id;
87 Backend(SearchablePtr sptr);
89 void connect(std::string zurl, int *error, char **addinfo,
91 void search_pqf(const char *pqf, Odr_int *hits,
92 int *error, char **addinfo, ODR odr);
93 void search_cql(const char *cql, Odr_int *hits,
94 int *error, char **addinfo, ODR odr);
95 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
96 int *error, char **addinfo, ODR odr);
97 void set_option(const char *name, const char *value);
98 void set_option(const char *name, std::string value);
99 const char *get_option(const char *name);
100 void get_zoom_error(int *error, char **addinfo, ODR odr);
102 class Zoom::Frontend : boost::noncopyable {
107 yazpp_1::GDU m_init_gdu;
108 BackendPtr m_backend;
109 void handle_package(mp::Package &package);
110 void handle_search(mp::Package &package);
111 void handle_present(mp::Package &package);
112 BackendPtr get_backend_from_databases(std::string &database,
116 Z_Records *get_records(Odr_int start,
117 Odr_int number_to_present,
120 Odr_int *number_of_records_returned,
121 ODR odr, BackendPtr b,
122 Odr_oid *preferredRecordSyntax,
123 const char *element_set_name);
125 Frontend(Impl *impl);
129 friend class Frontend;
133 void process(metaproxy_1::Package & package);
134 void configure(const xmlNode * ptr, bool test_only,
137 void configure_local_records(const xmlNode * ptr, bool test_only);
138 FrontendPtr get_frontend(mp::Package &package);
139 void release_frontend(mp::Package &package);
140 SearchablePtr parse_torus_record(const xmlNode *ptr);
141 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
142 std::map<mp::Session, FrontendPtr> m_clients;
143 boost::mutex m_mutex;
144 boost::condition m_cond_session_ready;
145 std::string torus_url;
146 std::map<std::string,std::string> fieldmap;
148 std::string file_path;
149 std::string content_proxy_server;
150 std::string content_tmp_file;
153 std::string element_transform;
154 std::string element_raw;
155 std::map<std::string,SearchablePtr> s_map;
160 // define Pimpl wrapper forwarding to Impl
162 yf::Zoom::Zoom() : m_p(new Impl)
167 { // must have a destructor because of boost::scoped_ptr
170 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
173 m_p->configure(xmlnode, test_only, path);
176 void yf::Zoom::process(mp::Package &package) const
178 m_p->process(package);
182 // define Implementation stuff
184 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
186 m_connection = ZOOM_connection_create(0);
191 yf::Zoom::Backend::~Backend()
194 xsltFreeStylesheet(xsp);
195 ZOOM_connection_destroy(m_connection);
196 ZOOM_resultset_destroy(m_resultset);
200 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
204 const char *zoom_addinfo = 0;
205 const char *dset = 0;
206 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
209 if (*error >= ZOOM_ERROR_CONNECT)
211 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
212 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
213 *addinfo = (char *) odr_malloc(
214 odr, 20 + strlen(msg) +
215 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
216 strcpy(*addinfo, msg);
219 strcat(*addinfo, ": ");
220 strcat(*addinfo, zoom_addinfo);
221 strcat(*addinfo, " ");
226 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
227 *error = yaz_diag_srw_to_bib1(*error);
228 *addinfo = (char *) odr_malloc(
229 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
231 if (zoom_addinfo && *zoom_addinfo)
233 strcpy(*addinfo, zoom_addinfo);
234 strcat(*addinfo, " ");
236 strcat(*addinfo, "(backend)");
241 void yf::Zoom::Backend::connect(std::string zurl,
242 int *error, char **addinfo,
245 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
246 get_zoom_error(error, addinfo, odr);
249 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
250 int *error, char **addinfo, ODR odr)
252 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
253 get_zoom_error(error, addinfo, odr);
255 *hits = ZOOM_resultset_size(m_resultset);
260 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
261 int *error, char **addinfo, ODR odr)
263 ZOOM_query q = ZOOM_query_create();
265 ZOOM_query_cql(q, cql);
267 m_resultset = ZOOM_connection_search(m_connection, q);
268 ZOOM_query_destroy(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 ccl_bibset = ccl_qual_dup(base);
308 yf::Zoom::Searchable::~Searchable()
310 ccl_qual_rm(&ccl_bibset);
313 yf::Zoom::Frontend::Frontend(Impl *impl) :
314 m_p(impl), m_is_virtual(false), m_in_use(true)
318 yf::Zoom::Frontend::~Frontend()
322 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
324 boost::mutex::scoped_lock lock(m_mutex);
326 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
330 it = m_clients.find(package.session());
331 if (it == m_clients.end())
334 if (!it->second->m_in_use)
336 it->second->m_in_use = true;
339 m_cond_session_ready.wait(lock);
341 FrontendPtr f(new Frontend(this));
342 m_clients[package.session()] = f;
347 void yf::Zoom::Impl::release_frontend(mp::Package &package)
349 boost::mutex::scoped_lock lock(m_mutex);
350 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
352 it = m_clients.find(package.session());
353 if (it != m_clients.end())
355 if (package.session().is_closed())
361 it->second->m_in_use = false;
363 m_cond_session_ready.notify_all();
367 yf::Zoom::Impl::Impl() :
368 apdu_log(false), element_transform("pz2") , element_raw("raw")
370 bibset = ccl_qual_mk();
375 yf::Zoom::Impl::~Impl()
377 ccl_qual_rm(&bibset);
380 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
382 Zoom::SearchablePtr s(new Searchable(bibset));
384 for (ptr = ptr->children; ptr; ptr = ptr->next)
386 if (ptr->type != XML_ELEMENT_NODE)
388 if (!strcmp((const char *) ptr->name, "layer"))
390 else if (!strcmp((const char *) ptr->name,
393 s->authentication = mp::xml::get_text(ptr);
395 else if (!strcmp((const char *) ptr->name,
398 s->cfAuth = mp::xml::get_text(ptr);
400 else if (!strcmp((const char *) ptr->name,
403 s->cfProxy = mp::xml::get_text(ptr);
405 else if (!strcmp((const char *) ptr->name,
408 s->cfSubDb = mp::xml::get_text(ptr);
410 else if (!strcmp((const char *) ptr->name,
413 s->contentConnector = mp::xml::get_text(ptr);
415 else if (!strcmp((const char *) ptr->name, "udb"))
417 s->udb = mp::xml::get_text(ptr);
419 else if (!strcmp((const char *) ptr->name, "zurl"))
421 s->target = mp::xml::get_text(ptr);
423 else if (!strcmp((const char *) ptr->name, "sru"))
425 s->sru = mp::xml::get_text(ptr);
427 else if (!strcmp((const char *) ptr->name,
430 s->query_encoding = mp::xml::get_text(ptr);
432 else if (!strcmp((const char *) ptr->name,
435 s->piggyback = mp::xml::get_bool(ptr, true);
437 else if (!strcmp((const char *) ptr->name,
440 s->request_syntax = mp::xml::get_text(ptr);
442 else if (!strcmp((const char *) ptr->name,
445 s->element_set = mp::xml::get_text(ptr);
447 else if (!strcmp((const char *) ptr->name,
450 s->record_encoding = mp::xml::get_text(ptr);
452 else if (!strcmp((const char *) ptr->name,
455 s->transform_xsl_fname = mp::xml::get_text(ptr);
457 else if (!strcmp((const char *) ptr->name,
460 s->urlRecipe = mp::xml::get_text(ptr);
462 else if (!strcmp((const char *) ptr->name,
465 ; // useTurboMarc is ignored
467 else if (!strncmp((const char *) ptr->name,
470 std::string value = mp::xml::get_text(ptr);
471 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
472 (const char *) ptr->name + 7);
478 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
480 while (ptr && ptr->type != XML_ELEMENT_NODE)
485 if (!strcmp((const char *) ptr->name, "records"))
487 for (ptr = ptr->children; ptr; ptr = ptr->next)
489 if (ptr->type != XML_ELEMENT_NODE)
491 if (!strcmp((const char *) ptr->name, "record"))
493 SearchablePtr s = parse_torus_record(ptr);
496 std::string udb = s->udb;
501 throw mp::filter::FilterException
502 ("No udb for local torus record");
508 throw mp::filter::FilterException
510 + std::string((const char *) ptr->name)
511 + " in zoom filter inside element "
518 throw mp::filter::FilterException
520 + std::string((const char *) ptr->name)
521 + " in zoom filter inside element <torus>");
526 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
529 content_tmp_file = "/tmp/cf.XXXXXX.p";
534 for (ptr = ptr->children; ptr; ptr = ptr->next)
536 if (ptr->type != XML_ELEMENT_NODE)
538 else if (!strcmp((const char *) ptr->name, "torus"))
540 const struct _xmlAttr *attr;
541 for (attr = ptr->properties; attr; attr = attr->next)
543 if (!strcmp((const char *) attr->name, "url"))
544 torus_url = mp::xml::get_text(attr->children);
545 else if (!strcmp((const char *) attr->name, "xsldir"))
546 xsldir = mp::xml::get_text(attr->children);
547 else if (!strcmp((const char *) attr->name, "element_transform"))
548 element_transform = mp::xml::get_text(attr->children);
549 else if (!strcmp((const char *) attr->name, "element_raw"))
550 element_raw = mp::xml::get_text(attr->children);
552 throw mp::filter::FilterException(
553 "Bad attribute " + std::string((const char *)
556 configure_local_records(ptr->children, test_only);
558 else if (!strcmp((const char *) ptr->name, "cclmap"))
560 const char *addinfo = 0;
561 ccl_xml_config(bibset, ptr, &addinfo);
563 else if (!strcmp((const char *) ptr->name, "fieldmap"))
565 const struct _xmlAttr *attr;
566 std::string ccl_field;
567 std::string cql_field;
568 for (attr = ptr->properties; attr; attr = attr->next)
570 if (!strcmp((const char *) attr->name, "ccl"))
571 ccl_field = mp::xml::get_text(attr->children);
572 else if (!strcmp((const char *) attr->name, "cql"))
573 cql_field = mp::xml::get_text(attr->children);
575 throw mp::filter::FilterException(
576 "Bad attribute " + std::string((const char *)
579 if (cql_field.length())
580 fieldmap[cql_field] = ccl_field;
582 else if (!strcmp((const char *) ptr->name, "contentProxy"))
584 const struct _xmlAttr *attr;
585 for (attr = ptr->properties; attr; attr = attr->next)
587 if (!strcmp((const char *) attr->name, "server"))
588 content_proxy_server = mp::xml::get_text(attr->children);
589 else if (!strcmp((const char *) attr->name, "tmp_file"))
590 content_tmp_file = mp::xml::get_text(attr->children);
592 throw mp::filter::FilterException(
593 "Bad attribute " + std::string((const char *)
597 else if (!strcmp((const char *) ptr->name, "log"))
599 const struct _xmlAttr *attr;
600 for (attr = ptr->properties; attr; attr = attr->next)
602 if (!strcmp((const char *) attr->name, "apdu"))
603 apdu_log = mp::xml::get_bool(attr->children, false);
605 throw mp::filter::FilterException(
606 "Bad attribute " + std::string((const char *)
612 throw mp::filter::FilterException
614 + std::string((const char *) ptr->name)
615 + " in zoom filter");
620 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
621 std::string &database, int *error, char **addinfo, ODR odr)
623 std::list<BackendPtr>::const_iterator map_it;
624 if (m_backend && m_backend->m_frontend_database == database)
628 std::string torus_db;
629 size_t db_arg_pos = database.find(',');
630 if (db_arg_pos != std::string::npos)
632 torus_db = database.substr(0, db_arg_pos);
633 db_args = database.substr(db_arg_pos + 1);
640 std::map<std::string,SearchablePtr>::iterator it;
641 it = m_p->s_map.find(torus_db);
642 if (it != m_p->s_map.end())
646 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
649 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
650 *addinfo = odr_strdup(odr, database.c_str());
654 const xmlNode *ptr = xmlDocGetRootElement(doc);
656 { // presumably ptr is a records element node
657 // parse first record in document
658 for (ptr = ptr->children; ptr; ptr = ptr->next)
660 if (ptr->type == XML_ELEMENT_NODE
661 && !strcmp((const char *) ptr->name, "record"))
663 sptr = m_p->parse_torus_record(ptr);
673 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
674 *addinfo = odr_strdup(odr, database.c_str());
679 xsltStylesheetPtr xsp = 0;
680 if (sptr->transform_xsl_fname.length())
682 const char *path = 0;
684 if (m_p->xsldir.length())
685 path = m_p->xsldir.c_str();
687 path = m_p->file_path.c_str();
691 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
697 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
699 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
700 sprintf(*addinfo, "File could not be read: %s",
701 sptr->transform_xsl_fname.c_str());
705 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
708 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
709 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
710 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
714 xsp = xsltParseStylesheetDoc(xsp_doc);
717 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
718 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
727 BackendPtr b(new Backend(sptr));
730 b->m_frontend_database = database;
732 if (sptr->query_encoding.length())
733 b->set_option("rpnCharset", sptr->query_encoding);
735 b->set_option("timeout", "40");
738 b->set_option("apdulog", "1");
741 b->set_option("count", "10");
742 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
744 std::string authentication = sptr->authentication;
745 std::string proxy = sptr->cfProxy;
747 const char *param_user = 0;
748 const char *param_password = 0;
749 const char *param_proxy = 0;
750 if (db_args.length())
755 int no_parms = yaz_uri_to_array(db_args.c_str(),
756 odr, &names, &values);
757 for (i = 0; i < no_parms; i++)
759 const char *name = names[i];
760 const char *value = values[i];
761 if (!strcmp(name, "user"))
763 else if (!strcmp(name, "password"))
764 param_password = value;
765 else if (!strcmp(name, "proxy"))
767 else if (!strcmp(name, "cproxysession"))
772 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
773 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
774 sprintf(msg, "Bad database argument: %s", name);
781 authentication = std::string(param_user);
783 authentication += "/" + std::string(param_password);
789 if (sptr->cfAuth.length())
792 b->set_option("user", sptr->cfAuth);
793 if (!param_user && !param_password && authentication.length())
795 if (db_args.length())
797 // no database (auth) args specified already.. and the
798 // Torus authentication has it.. Generate the args that CF
800 size_t found = authentication.find('/');
801 if (found != std::string::npos)
804 mp::util::uri_encode(authentication.substr(0, found))
806 mp::util::uri_encode(authentication.substr(found+1));
809 db_args += "user=" + mp::util::uri_encode(authentication);
811 if (!param_proxy && proxy.length())
813 if (db_args.length())
815 db_args += "proxy=" + mp::util::uri_encode(proxy);
817 if (sptr->cfSubDb.length())
819 if (db_args.length())
821 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
826 db_args.clear(); // no arguments to be passed (non-CF)
828 size_t found = authentication.find('/');
830 if (sptr->sru.length() && found != std::string::npos)
832 b->set_option("user", authentication.substr(0, found));
833 b->set_option("password", authentication.substr(found+1));
836 b->set_option("user", authentication);
839 b->set_option("proxy", proxy);
841 if (b->sptr->contentConnector.length())
843 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
844 strcpy(fname, m_p->content_tmp_file.c_str());
845 char *xx = strstr(fname, "XXXXXX");
848 xx = fname + strlen(fname);
849 strcat(fname, "XXXXXX");
851 char tmp_char = xx[6];
852 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
855 FILE *file = fopen(fname, "w");
858 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
859 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
860 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
861 sprintf(*addinfo, "Could not create %s", fname);
863 BackendPtr backend_null;
866 b->content_session_id.assign(xx, 6);
867 WRBUF w = wrbuf_alloc();
868 wrbuf_puts(w, "#content_proxy\n");
869 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
870 if (authentication.length())
871 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
873 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
874 if (sptr->cfProxy.length())
875 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
877 fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file);
879 yaz_log(YLOG_LOG, "file %s created\n", fname);
884 if (sptr->sru.length())
886 url = "http://" + sptr->target;
887 b->set_option("sru", sptr->sru);
893 if (db_args.length())
894 url += "," + db_args;
895 yaz_log(YLOG_LOG, "url=%s", url.c_str());
896 b->connect(url, error, addinfo, odr);
904 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
905 Odr_int number_to_present,
908 Odr_int *number_of_records_returned,
911 Odr_oid *preferredRecordSyntax,
912 const char *element_set_name)
914 *number_of_records_returned = 0;
915 Z_Records *records = 0;
916 bool enable_pz2_retrieval = false; // whether target profile is used
917 bool enable_pz2_transform = false; // whether XSLT is used as well
918 bool assume_marc8_charset = false;
920 if (start < 0 || number_to_present <= 0)
923 if (number_to_present > 10000)
924 number_to_present = 10000;
926 ZOOM_record *recs = (ZOOM_record *)
927 odr_malloc(odr, number_to_present * sizeof(*recs));
929 char oid_name_str[OID_STR_MAX];
930 const char *syntax_name = 0;
932 if (preferredRecordSyntax &&
933 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
936 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
938 enable_pz2_retrieval = true;
939 enable_pz2_transform = true;
941 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
943 enable_pz2_retrieval = true;
947 if (enable_pz2_retrieval)
949 if (b->sptr->request_syntax.length())
951 syntax_name = b->sptr->request_syntax.c_str();
952 const Odr_oid *syntax_oid =
953 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
954 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
955 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
956 assume_marc8_charset = true;
959 else if (preferredRecordSyntax)
961 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
963 b->set_option("preferredRecordSyntax", syntax_name);
965 if (enable_pz2_retrieval)
967 element_set_name = 0;
968 if (b->sptr->element_set.length())
969 element_set_name = b->sptr->element_set.c_str();
972 b->set_option("elementSetName", element_set_name);
974 b->present(start, number_to_present, recs, error, addinfo, odr);
979 for (i = 0; i < number_to_present; i++)
984 { // only return records if no error and at least one record
985 char *odr_database = odr_strdup(odr,
986 b->m_frontend_database.c_str());
987 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
988 odr_malloc(odr, sizeof(*npl));
989 *number_of_records_returned = i;
990 npl->num_records = i;
991 npl->records = (Z_NamePlusRecord **)
992 odr_malloc(odr, i * sizeof(*npl->records));
993 for (i = 0; i < number_to_present; i++)
995 Z_NamePlusRecord *npr = 0;
997 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
998 &addinfo, 0 /* diagset */);
1002 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1005 else if (enable_pz2_retrieval)
1007 char rec_type_str[100];
1008 const char *record_encoding = 0;
1010 if (b->sptr->record_encoding.length())
1011 record_encoding = b->sptr->record_encoding.c_str();
1012 else if (assume_marc8_charset)
1013 record_encoding = "marc8";
1015 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1016 if (record_encoding)
1018 strcat(rec_type_str, "; charset=");
1019 strcat(rec_type_str, record_encoding);
1023 xmlChar *xmlrec_buf = 0;
1024 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1026 if (!rec_buf && !npr)
1028 std::string addinfo("ZOOM_record_get failed for type ");
1030 addinfo += rec_type_str;
1031 npr = zget_surrogateDiagRec(
1033 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1037 if (rec_buf && b->xsp && enable_pz2_transform)
1039 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1042 npr = zget_surrogateDiagRec(
1044 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1045 "xml parse failed for record");
1050 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1054 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1056 rec_buf = (const char *) xmlrec_buf;
1058 xmlFreeDoc(rec_res);
1062 std::string addinfo;
1064 addinfo = "xslt apply failed for "
1065 + b->sptr->transform_xsl_fname;
1066 npr = zget_surrogateDiagRec(
1068 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1071 xmlFreeDoc(rec_doc);
1077 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1079 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1080 if (res.length() && b->content_session_id.length())
1082 size_t off = res.find_first_of("://");
1083 if (off != std::string::npos)
1086 sprintf(tmp, "%s.%s/",
1087 b->content_session_id.c_str(),
1088 m_p->content_proxy_server.c_str());
1089 res.insert(off + 3, tmp);
1094 xmlNode *ptr = xmlDocGetRootElement(doc);
1095 while (ptr && ptr->type != XML_ELEMENT_NODE)
1098 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1099 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1103 xmlFree(xmlrec_buf);
1105 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1106 rec_buf = (const char *) xmlrec_buf;
1113 npr = zget_surrogateDiagRec(
1115 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1119 npr = (Z_NamePlusRecord *)
1120 odr_malloc(odr, sizeof(*npr));
1121 npr->databaseName = odr_database;
1122 npr->which = Z_NamePlusRecord_databaseRecord;
1123 npr->u.databaseRecord =
1124 z_ext_record_xml(odr, rec_buf, rec_len);
1128 xmlFree(xmlrec_buf);
1133 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1136 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1137 npr->databaseName = odr_database;
1138 npr->which = Z_NamePlusRecord_databaseRecord;
1139 npr->u.databaseRecord = ext;
1143 npr = zget_surrogateDiagRec(
1145 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1146 "ZOOM_record, type ext");
1149 npl->records[i] = npr;
1151 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1152 records->which = Z_Records_DBOSD;
1153 records->u.databaseOrSurDiagnostics = npl;
1158 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1161 struct cql_node *r = 0;
1169 std::map<std::string,std::string>::const_iterator it;
1170 it = fieldmap.find(cn->u.st.index);
1171 if (it == fieldmap.end())
1173 if (it->second.length())
1174 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1180 r = convert_cql_fields(cn->u.boolean.left, odr);
1182 r = convert_cql_fields(cn->u.boolean.right, odr);
1185 r = convert_cql_fields(cn->u.sort.search, odr);
1191 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1193 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1194 /* see cql_sortby_to_sortkeys of YAZ. */
1196 int num_sortspec = 0;
1198 NMEM nmem = nmem_create();
1201 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1202 if (num_sortspec > 0)
1204 WRBUF w = wrbuf_alloc();
1205 for (i = 0; i < num_sortspec; i++)
1210 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1212 if (num_arg > 2 && arg[2][0])
1213 ascending = atoi(arg[2]);
1215 wrbuf_puts(w, "@or @attr 1=");
1216 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1217 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1221 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1222 wrbuf_rewind(pqf_wrbuf);
1223 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1230 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1232 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1233 /* see cql_sortby_to_sortkeys of YAZ. */
1235 int num_sortspec = 0;
1237 NMEM nmem = nmem_create();
1240 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1241 if (num_sortspec > 0)
1243 WRBUF w = wrbuf_alloc();
1244 for (i = 0; i < num_sortspec; i++)
1249 int case_sensitive = 0;
1250 const char *missing = 0;
1251 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1253 if (num_arg > 2 && arg[2][0])
1254 ascending = atoi(arg[2]);
1255 if (num_arg > 3 && arg[3][0])
1256 case_sensitive = atoi(arg[3]);
1257 if (num_arg > 4 && arg[4][0])
1262 wrbuf_puts(w, " sortby ");
1263 wrbuf_puts(w, arg[0]); /* field */
1265 wrbuf_puts(w, ascending ? "ascending" : "descending");
1267 wrbuf_puts(w, "/respectCase");
1270 if (!strcmp(missing, "omit"))
1271 wrbuf_puts(w, "/missingOmit");
1272 else if (!strcmp(missing, "abort"))
1273 wrbuf_puts(w, "/missingFail");
1274 else if (!strcmp(missing, "lowValue"))
1275 wrbuf_puts(w, "/missingLow");
1276 else if (!strcmp(missing, "highValue"))
1277 wrbuf_puts(w, "/missingHigh");
1281 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1287 #if YAZ_VERSIONL < 0x40206
1288 static void wrbuf_vp_puts(const char *buf, void *client_data)
1290 WRBUF b = (WRBUF) client_data;
1295 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1297 Z_GDU *gdu = package.request().get();
1298 Z_APDU *apdu_req = gdu->u.z3950;
1299 Z_APDU *apdu_res = 0;
1301 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1302 if (sr->num_databaseNames != 1)
1304 apdu_res = odr.create_searchResponse(
1305 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1306 package.response() = apdu_res;
1312 std::string db(sr->databaseNames[0]);
1313 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1317 odr.create_searchResponse(apdu_req, error, addinfo);
1318 package.response() = apdu_res;
1322 b->set_option("setname", "default");
1325 Z_Query *query = sr->query;
1326 WRBUF ccl_wrbuf = 0;
1327 WRBUF pqf_wrbuf = 0;
1328 std::string sru_sortkeys;
1330 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1333 pqf_wrbuf = wrbuf_alloc();
1334 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1336 else if (query->which == Z_Query_type_2)
1339 ccl_wrbuf = wrbuf_alloc();
1340 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1341 query->u.type_2->len);
1343 else if (query->which == Z_Query_type_104 &&
1344 query->u.type_104->which == Z_External_CQL)
1347 const char *cql = query->u.type_104->u.cql;
1348 CQL_parser cp = cql_parser_create();
1349 int r = cql_parser_string(cp, cql);
1352 cql_parser_destroy(cp);
1354 odr.create_searchResponse(apdu_req,
1355 YAZ_BIB1_MALFORMED_QUERY,
1356 "CQL syntax error");
1357 package.response() = apdu_res;
1360 struct cql_node *cn = cql_parser_result(cp);
1361 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1364 // hopefully we are getting a ptr to a index+relation+term node
1366 if (cn_error->which == CQL_NODE_ST)
1367 addinfo = cn_error->u.st.index;
1370 odr.create_searchResponse(apdu_req,
1371 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1373 package.response() = apdu_res;
1378 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1381 ccl_wrbuf = wrbuf_alloc();
1382 wrbuf_puts(ccl_wrbuf, ccl_buf);
1384 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1386 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1388 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1389 wrbuf_destroy(sru_sortkeys_wrbuf);
1391 cql_parser_destroy(cp);
1395 odr.create_searchResponse(apdu_req,
1396 YAZ_BIB1_MALFORMED_QUERY,
1397 "CQL to CCL conversion error");
1398 package.response() = apdu_res;
1405 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1406 package.response() = apdu_res;
1413 assert(pqf_wrbuf == 0);
1415 struct ccl_rpn_node *cn;
1416 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1417 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1419 wrbuf_destroy(ccl_wrbuf);
1422 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1423 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1427 case CCL_ERR_UNKNOWN_QUAL:
1428 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1430 case CCL_ERR_TRUNC_NOT_LEFT:
1431 case CCL_ERR_TRUNC_NOT_RIGHT:
1432 case CCL_ERR_TRUNC_NOT_BOTH:
1433 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1437 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1438 package.response() = apdu_res;
1441 pqf_wrbuf = wrbuf_alloc();
1442 ccl_pquery(pqf_wrbuf, cn);
1447 if (b->get_option("sru"))
1451 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1452 WRBUF wrb = wrbuf_alloc();
1454 if (!strcmp(b->get_option("sru"), "solr"))
1456 solr_transform_t cqlt = solr_transform_create();
1458 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1460 solr_transform_close(cqlt);
1464 cql_transform_t cqlt = cql_transform_create();
1466 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1468 cql_transform_close(cqlt);
1471 sort_via_cql(wrb, sru_sortkeys.c_str());
1475 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1476 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1480 wrbuf_destroy(pqf_wrbuf);
1484 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1485 "can not convert from RPN to CQL/SOLR");
1486 package.response() = apdu_res;
1492 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1494 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1495 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1496 wrbuf_destroy(pqf_wrbuf);
1499 const char *element_set_name = 0;
1500 Odr_int number_to_present = 0;
1502 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1504 Odr_int number_of_records_returned = 0;
1505 Z_Records *records = get_records(
1506 0, number_to_present, &error, &addinfo,
1507 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1509 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1512 apdu_res->u.searchResponse->records = records;
1513 apdu_res->u.searchResponse->numberOfRecordsReturned =
1514 odr_intdup(odr, number_of_records_returned);
1516 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1517 package.response() = apdu_res;
1520 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1522 Z_GDU *gdu = package.request().get();
1523 Z_APDU *apdu_req = gdu->u.z3950;
1524 Z_APDU *apdu_res = 0;
1525 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1530 package.response() = odr.create_presentResponse(
1531 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1534 const char *element_set_name = 0;
1535 Z_RecordComposition *comp = pr->recordComposition;
1536 if (comp && comp->which != Z_RecordComp_simple)
1538 package.response() = odr.create_presentResponse(
1540 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1543 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1544 element_set_name = comp->u.simple->u.generic;
1545 Odr_int number_of_records_returned = 0;
1548 Z_Records *records = get_records(
1549 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1550 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1551 pr->preferredRecordSyntax, element_set_name);
1553 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1556 apdu_res->u.presentResponse->records = records;
1557 apdu_res->u.presentResponse->numberOfRecordsReturned =
1558 odr_intdup(odr, number_of_records_returned);
1560 package.response() = apdu_res;
1563 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1565 Z_GDU *gdu = package.request().get();
1568 else if (gdu->which == Z_GDU_Z3950)
1570 Z_APDU *apdu_req = gdu->u.z3950;
1571 if (apdu_req->which == Z_APDU_initRequest)
1574 package.response() = odr.create_close(
1576 Z_Close_protocolError,
1579 else if (apdu_req->which == Z_APDU_searchRequest)
1581 handle_search(package);
1583 else if (apdu_req->which == Z_APDU_presentRequest)
1585 handle_present(package);
1590 package.response() = odr.create_close(
1592 Z_Close_protocolError,
1593 "zoom filter cannot handle this APDU");
1594 package.session().close();
1599 package.session().close();
1603 void yf::Zoom::Impl::process(mp::Package &package)
1605 FrontendPtr f = get_frontend(package);
1606 Z_GDU *gdu = package.request().get();
1608 if (f->m_is_virtual)
1610 f->handle_package(package);
1612 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1615 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1616 f->m_init_gdu = gdu;
1619 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1620 Z_InitResponse *resp = apdu->u.initResponse;
1623 static const int masks[] = {
1628 for (i = 0; masks[i] != -1; i++)
1629 if (ODR_MASK_GET(req->options, masks[i]))
1630 ODR_MASK_SET(resp->options, masks[i]);
1632 static const int versions[] = {
1633 Z_ProtocolVersion_1,
1634 Z_ProtocolVersion_2,
1635 Z_ProtocolVersion_3,
1638 for (i = 0; versions[i] != -1; i++)
1639 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1640 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1644 *resp->preferredMessageSize = *req->preferredMessageSize;
1645 *resp->maximumRecordSize = *req->maximumRecordSize;
1647 package.response() = apdu;
1648 f->m_is_virtual = true;
1653 release_frontend(package);
1657 static mp::filter::Base* filter_creator()
1659 return new mp::filter::Zoom;
1663 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1674 * c-file-style: "Stroustrup"
1675 * indent-tabs-mode: nil
1677 * vim: shiftwidth=4 tabstop=8 expandtab