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>
24 #include "filter_zoom.hpp"
26 #include <yaz/yaz-version.h>
27 #include <yaz/tpath.h>
29 #include <metaproxy/package.hpp>
30 #include <metaproxy/util.hpp>
31 #include <metaproxy/xmlutil.hpp>
34 #include <libxslt/xsltutils.h>
35 #include <libxslt/transform.h>
37 #include <boost/thread/mutex.hpp>
38 #include <boost/thread/condition.hpp>
39 #include <yaz/ccl_xml.h>
41 #include <yaz/rpn2cql.h>
42 #include <yaz/rpn2solr.h>
43 #include <yaz/pquery.h>
45 #include <yaz/oid_db.h>
46 #include <yaz/diagbib1.h>
49 #include <yaz/querytowrbuf.h>
51 namespace mp = metaproxy_1;
52 namespace yf = mp::filter;
54 namespace metaproxy_1 {
56 class Zoom::Searchable : boost::noncopyable {
58 std::string authentication;
64 std::string query_encoding;
66 std::string request_syntax;
67 std::string element_set;
68 std::string record_encoding;
69 std::string transform_xsl_fname;
70 std::string urlRecipe;
71 std::string contentConnector;
74 CCL_bibset ccl_bibset;
75 Searchable(CCL_bibset base);
78 class Zoom::Backend : boost::noncopyable {
80 friend class Frontend;
82 ZOOM_connection m_connection;
83 ZOOM_resultset m_resultset;
84 std::string m_frontend_database;
86 xsltStylesheetPtr xsp;
87 std::string content_session_id;
89 Backend(SearchablePtr sptr);
91 void connect(std::string zurl, int *error, char **addinfo,
93 void search_pqf(const char *pqf, Odr_int *hits,
94 int *error, char **addinfo, ODR odr);
95 void search_cql(const char *cql, Odr_int *hits,
96 int *error, char **addinfo, ODR odr);
97 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
98 int *error, char **addinfo, ODR odr);
99 void set_option(const char *name, const char *value);
100 void set_option(const char *name, std::string value);
101 const char *get_option(const char *name);
102 void get_zoom_error(int *error, char **addinfo, ODR odr);
104 class Zoom::Frontend : boost::noncopyable {
109 yazpp_1::GDU m_init_gdu;
110 BackendPtr m_backend;
111 void handle_package(mp::Package &package);
112 void handle_search(mp::Package &package);
113 void handle_present(mp::Package &package);
114 BackendPtr get_backend_from_databases(std::string &database,
118 Z_Records *get_records(Odr_int start,
119 Odr_int number_to_present,
122 Odr_int *number_of_records_returned,
123 ODR odr, BackendPtr b,
124 Odr_oid *preferredRecordSyntax,
125 const char *element_set_name);
127 Frontend(Impl *impl);
131 friend class Frontend;
135 void process(metaproxy_1::Package & package);
136 void configure(const xmlNode * ptr, bool test_only,
139 void configure_local_records(const xmlNode * ptr, bool test_only);
140 FrontendPtr get_frontend(mp::Package &package);
141 void release_frontend(mp::Package &package);
142 SearchablePtr parse_torus_record(const xmlNode *ptr);
143 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
144 std::map<mp::Session, FrontendPtr> m_clients;
145 boost::mutex m_mutex;
146 boost::condition m_cond_session_ready;
147 std::string torus_url;
148 std::map<std::string,std::string> fieldmap;
150 std::string file_path;
151 std::string content_proxy_server;
152 std::string content_tmp_file;
155 std::string element_transform;
156 std::string element_raw;
157 std::map<std::string,SearchablePtr> s_map;
162 // define Pimpl wrapper forwarding to Impl
164 yf::Zoom::Zoom() : m_p(new Impl)
169 { // must have a destructor because of boost::scoped_ptr
172 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
175 m_p->configure(xmlnode, test_only, path);
178 void yf::Zoom::process(mp::Package &package) const
180 m_p->process(package);
184 // define Implementation stuff
186 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
188 m_connection = ZOOM_connection_create(0);
193 yf::Zoom::Backend::~Backend()
196 xsltFreeStylesheet(xsp);
197 ZOOM_connection_destroy(m_connection);
198 ZOOM_resultset_destroy(m_resultset);
202 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
206 const char *zoom_addinfo = 0;
207 const char *dset = 0;
208 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
211 if (*error >= ZOOM_ERROR_CONNECT)
213 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
214 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
215 *addinfo = (char *) odr_malloc(
216 odr, 20 + strlen(msg) +
217 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
218 strcpy(*addinfo, msg);
221 strcat(*addinfo, ": ");
222 strcat(*addinfo, zoom_addinfo);
223 strcat(*addinfo, " ");
228 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
229 *error = yaz_diag_srw_to_bib1(*error);
230 *addinfo = (char *) odr_malloc(
231 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
233 if (zoom_addinfo && *zoom_addinfo)
235 strcpy(*addinfo, zoom_addinfo);
236 strcat(*addinfo, " ");
238 strcat(*addinfo, "(backend)");
243 void yf::Zoom::Backend::connect(std::string zurl,
244 int *error, char **addinfo,
247 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
248 get_zoom_error(error, addinfo, odr);
251 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
252 int *error, char **addinfo, ODR odr)
254 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
255 get_zoom_error(error, addinfo, odr);
257 *hits = ZOOM_resultset_size(m_resultset);
262 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
263 int *error, char **addinfo, ODR odr)
265 ZOOM_query q = ZOOM_query_create();
267 ZOOM_query_cql(q, cql);
269 m_resultset = ZOOM_connection_search(m_connection, q);
270 ZOOM_query_destroy(q);
271 get_zoom_error(error, addinfo, odr);
273 *hits = ZOOM_resultset_size(m_resultset);
278 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
280 int *error, char **addinfo, ODR odr)
282 ZOOM_resultset_records(m_resultset, recs, start, number);
283 get_zoom_error(error, addinfo, odr);
286 void yf::Zoom::Backend::set_option(const char *name, const char *value)
288 ZOOM_connection_option_set(m_connection, name, value);
290 ZOOM_resultset_option_set(m_resultset, name, value);
293 void yf::Zoom::Backend::set_option(const char *name, std::string value)
295 set_option(name, value.c_str());
298 const char *yf::Zoom::Backend::get_option(const char *name)
300 return ZOOM_connection_option_get(m_connection, name);
303 yf::Zoom::Searchable::Searchable(CCL_bibset base)
306 use_turbomarc = true;
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,
432 s->query_encoding = mp::xml::get_text(ptr);
434 else if (!strcmp((const char *) ptr->name,
437 s->piggyback = mp::xml::get_bool(ptr, true);
439 else if (!strcmp((const char *) ptr->name,
442 s->request_syntax = mp::xml::get_text(ptr);
444 else if (!strcmp((const char *) ptr->name,
447 s->element_set = mp::xml::get_text(ptr);
449 else if (!strcmp((const char *) ptr->name,
452 s->record_encoding = mp::xml::get_text(ptr);
454 else if (!strcmp((const char *) ptr->name,
457 s->transform_xsl_fname = mp::xml::get_text(ptr);
459 else if (!strcmp((const char *) ptr->name,
462 s->urlRecipe = mp::xml::get_text(ptr);
464 else if (!strcmp((const char *) ptr->name,
467 ; // useTurboMarc is ignored
469 else if (!strncmp((const char *) ptr->name,
472 std::string value = mp::xml::get_text(ptr);
473 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
474 (const char *) ptr->name + 7);
480 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
482 while (ptr && ptr->type != XML_ELEMENT_NODE)
487 if (!strcmp((const char *) ptr->name, "records"))
489 for (ptr = ptr->children; ptr; ptr = ptr->next)
491 if (ptr->type != XML_ELEMENT_NODE)
493 if (!strcmp((const char *) ptr->name, "record"))
495 SearchablePtr s = parse_torus_record(ptr);
498 std::string udb = s->udb;
503 throw mp::filter::FilterException
504 ("No udb for local torus record");
510 throw mp::filter::FilterException
512 + std::string((const char *) ptr->name)
513 + " in zoom filter inside element "
520 throw mp::filter::FilterException
522 + std::string((const char *) ptr->name)
523 + " in zoom filter inside element <torus>");
528 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
531 content_tmp_file = "/tmp/cf.XXXXXX.p";
536 for (ptr = ptr->children; ptr; ptr = ptr->next)
538 if (ptr->type != XML_ELEMENT_NODE)
540 else if (!strcmp((const char *) ptr->name, "torus"))
542 const struct _xmlAttr *attr;
543 for (attr = ptr->properties; attr; attr = attr->next)
545 if (!strcmp((const char *) attr->name, "url"))
546 torus_url = mp::xml::get_text(attr->children);
547 else if (!strcmp((const char *) attr->name, "xsldir"))
548 xsldir = mp::xml::get_text(attr->children);
549 else if (!strcmp((const char *) attr->name, "element_transform"))
550 element_transform = mp::xml::get_text(attr->children);
551 else if (!strcmp((const char *) attr->name, "element_raw"))
552 element_raw = mp::xml::get_text(attr->children);
554 throw mp::filter::FilterException(
555 "Bad attribute " + std::string((const char *)
558 configure_local_records(ptr->children, test_only);
560 else if (!strcmp((const char *) ptr->name, "cclmap"))
562 const char *addinfo = 0;
563 ccl_xml_config(bibset, ptr, &addinfo);
565 else if (!strcmp((const char *) ptr->name, "fieldmap"))
567 const struct _xmlAttr *attr;
568 std::string ccl_field;
569 std::string cql_field;
570 for (attr = ptr->properties; attr; attr = attr->next)
572 if (!strcmp((const char *) attr->name, "ccl"))
573 ccl_field = mp::xml::get_text(attr->children);
574 else if (!strcmp((const char *) attr->name, "cql"))
575 cql_field = mp::xml::get_text(attr->children);
577 throw mp::filter::FilterException(
578 "Bad attribute " + std::string((const char *)
581 if (cql_field.length())
582 fieldmap[cql_field] = ccl_field;
584 else if (!strcmp((const char *) ptr->name, "contentProxy"))
586 const struct _xmlAttr *attr;
587 for (attr = ptr->properties; attr; attr = attr->next)
589 if (!strcmp((const char *) attr->name, "server"))
590 content_proxy_server = mp::xml::get_text(attr->children);
591 else if (!strcmp((const char *) attr->name, "tmp_file"))
592 content_tmp_file = mp::xml::get_text(attr->children);
594 throw mp::filter::FilterException(
595 "Bad attribute " + std::string((const char *)
599 else if (!strcmp((const char *) ptr->name, "log"))
601 const struct _xmlAttr *attr;
602 for (attr = ptr->properties; attr; attr = attr->next)
604 if (!strcmp((const char *) attr->name, "apdu"))
605 apdu_log = mp::xml::get_bool(attr->children, false);
607 throw mp::filter::FilterException(
608 "Bad attribute " + std::string((const char *)
614 throw mp::filter::FilterException
616 + std::string((const char *) ptr->name)
617 + " in zoom filter");
622 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
623 std::string &database, int *error, char **addinfo, ODR odr)
625 std::list<BackendPtr>::const_iterator map_it;
626 if (m_backend && m_backend->m_frontend_database == database)
630 std::string torus_db;
631 size_t db_arg_pos = database.find(',');
632 if (db_arg_pos != std::string::npos)
634 torus_db = database.substr(0, db_arg_pos);
635 db_args = database.substr(db_arg_pos + 1);
642 std::map<std::string,SearchablePtr>::iterator it;
643 it = m_p->s_map.find(torus_db);
644 if (it != m_p->s_map.end())
648 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
651 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
652 *addinfo = odr_strdup(odr, database.c_str());
656 const xmlNode *ptr = xmlDocGetRootElement(doc);
658 { // presumably ptr is a records element node
659 // parse first record in document
660 for (ptr = ptr->children; ptr; ptr = ptr->next)
662 if (ptr->type == XML_ELEMENT_NODE
663 && !strcmp((const char *) ptr->name, "record"))
665 sptr = m_p->parse_torus_record(ptr);
675 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
676 *addinfo = odr_strdup(odr, database.c_str());
681 xsltStylesheetPtr xsp = 0;
682 if (sptr->transform_xsl_fname.length())
684 const char *path = 0;
686 if (m_p->xsldir.length())
687 path = m_p->xsldir.c_str();
689 path = m_p->file_path.c_str();
693 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
699 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
701 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
702 sprintf(*addinfo, "File could not be read: %s",
703 sptr->transform_xsl_fname.c_str());
707 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
710 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
711 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
712 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
716 xsp = xsltParseStylesheetDoc(xsp_doc);
719 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
720 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
729 BackendPtr b(new Backend(sptr));
732 b->m_frontend_database = database;
734 if (sptr->query_encoding.length())
735 b->set_option("rpnCharset", sptr->query_encoding);
737 b->set_option("timeout", "40");
740 b->set_option("apdulog", "1");
743 b->set_option("count", "10");
744 b->set_option("piggyback", sptr->piggyback ? "1" : "0");
746 std::string authentication = sptr->authentication;
747 std::string proxy = sptr->cfProxy;
749 const char *param_user = 0;
750 const char *param_password = 0;
751 const char *param_proxy = 0;
752 if (db_args.length())
757 int no_parms = yaz_uri_to_array(db_args.c_str(),
758 odr, &names, &values);
759 for (i = 0; i < no_parms; i++)
761 const char *name = names[i];
762 const char *value = values[i];
763 if (!strcmp(name, "user"))
765 else if (!strcmp(name, "password"))
766 param_password = value;
767 else if (!strcmp(name, "proxy"))
769 else if (!strcmp(name, "cproxysession"))
774 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
775 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
776 sprintf(msg, "Bad database argument: %s", name);
783 authentication = std::string(param_user);
785 authentication += "/" + std::string(param_password);
791 if (sptr->cfAuth.length())
794 b->set_option("user", sptr->cfAuth);
795 if (!param_user && !param_password && authentication.length())
797 if (db_args.length())
799 // no database (auth) args specified already.. and the
800 // Torus authentication has it.. Generate the args that CF
802 size_t found = authentication.find('/');
803 if (found != std::string::npos)
806 mp::util::uri_encode(authentication.substr(0, found))
808 mp::util::uri_encode(authentication.substr(found+1));
811 db_args += "user=" + mp::util::uri_encode(authentication);
813 if (!param_proxy && proxy.length())
815 if (db_args.length())
817 db_args += "proxy=" + mp::util::uri_encode(proxy);
819 if (sptr->cfSubDb.length())
821 if (db_args.length())
823 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
828 db_args.clear(); // no arguments to be passed (non-CF)
830 size_t found = authentication.find('/');
832 if (sptr->sru.length() && found != std::string::npos)
834 b->set_option("user", authentication.substr(0, found));
835 b->set_option("password", authentication.substr(found+1));
838 b->set_option("user", authentication);
841 b->set_option("proxy", proxy);
843 if (b->sptr->contentConnector.length())
845 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
846 strcpy(fname, m_p->content_tmp_file.c_str());
847 char *xx = strstr(fname, "XXXXXX");
850 xx = fname + strlen(fname);
851 strcat(fname, "XXXXXX");
853 char tmp_char = xx[6];
854 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
857 int fd = creat(fname, 0666);
860 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
861 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
862 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
863 sprintf(*addinfo, "Could not create %s", fname);
865 BackendPtr backend_null;
868 b->content_session_id.assign(xx, 6);
869 WRBUF w = wrbuf_alloc();
870 wrbuf_puts(w, "#content_proxy\n");
871 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
872 if (authentication.length())
873 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
875 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
876 if (sptr->cfAuth.length())
877 wrbuf_printf(w, "cfauth: %s\n", sptr->cfAuth.c_str());
878 if (sptr->cfProxy.length())
879 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
881 write(fd, wrbuf_buf(w), wrbuf_len(w));
883 yaz_log(YLOG_LOG, "file %s created\n", fname);
888 if (sptr->sru.length())
890 url = "http://" + sptr->target;
891 b->set_option("sru", sptr->sru);
897 if (db_args.length())
898 url += "," + db_args;
899 yaz_log(YLOG_LOG, "url=%s", url.c_str());
900 b->connect(url, error, addinfo, odr);
908 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
909 Odr_int number_to_present,
912 Odr_int *number_of_records_returned,
915 Odr_oid *preferredRecordSyntax,
916 const char *element_set_name)
918 *number_of_records_returned = 0;
919 Z_Records *records = 0;
920 bool enable_pz2_retrieval = false; // whether target profile is used
921 bool enable_pz2_transform = false; // whether XSLT is used as well
922 bool assume_marc8_charset = false;
924 if (start < 0 || number_to_present <= 0)
927 if (number_to_present > 10000)
928 number_to_present = 10000;
930 ZOOM_record *recs = (ZOOM_record *)
931 odr_malloc(odr, (size_t) number_to_present * sizeof(*recs));
933 char oid_name_str[OID_STR_MAX];
934 const char *syntax_name = 0;
936 if (preferredRecordSyntax &&
937 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
940 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
942 enable_pz2_retrieval = true;
943 enable_pz2_transform = true;
945 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
947 enable_pz2_retrieval = true;
951 if (enable_pz2_retrieval)
953 if (b->sptr->request_syntax.length())
955 syntax_name = b->sptr->request_syntax.c_str();
956 const Odr_oid *syntax_oid =
957 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
958 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
959 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
960 assume_marc8_charset = true;
963 else if (preferredRecordSyntax)
965 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
967 b->set_option("preferredRecordSyntax", syntax_name);
969 if (enable_pz2_retrieval)
971 element_set_name = 0;
972 if (b->sptr->element_set.length())
973 element_set_name = b->sptr->element_set.c_str();
976 b->set_option("elementSetName", element_set_name);
978 b->present(start, number_to_present, recs, error, addinfo, odr);
983 for (i = 0; i < number_to_present; i++)
988 { // only return records if no error and at least one record
989 char *odr_database = odr_strdup(odr,
990 b->m_frontend_database.c_str());
991 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
992 odr_malloc(odr, sizeof(*npl));
993 *number_of_records_returned = i;
994 npl->num_records = i;
995 npl->records = (Z_NamePlusRecord **)
996 odr_malloc(odr, i * sizeof(*npl->records));
997 for (i = 0; i < number_to_present; i++)
999 Z_NamePlusRecord *npr = 0;
1000 const char *addinfo;
1001 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1002 &addinfo, 0 /* diagset */);
1006 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1009 else if (enable_pz2_retrieval)
1011 char rec_type_str[100];
1012 const char *record_encoding = 0;
1014 if (b->sptr->record_encoding.length())
1015 record_encoding = b->sptr->record_encoding.c_str();
1016 else if (assume_marc8_charset)
1017 record_encoding = "marc8";
1019 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1020 if (record_encoding)
1022 strcat(rec_type_str, "; charset=");
1023 strcat(rec_type_str, record_encoding);
1027 xmlChar *xmlrec_buf = 0;
1028 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1030 if (!rec_buf && !npr)
1032 std::string addinfo("ZOOM_record_get failed for type ");
1034 addinfo += rec_type_str;
1035 npr = zget_surrogateDiagRec(
1037 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1041 if (rec_buf && b->xsp && enable_pz2_transform)
1043 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1046 npr = zget_surrogateDiagRec(
1048 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1049 "xml parse failed for record");
1054 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1058 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1060 rec_buf = (const char *) xmlrec_buf;
1062 xmlFreeDoc(rec_res);
1066 std::string addinfo;
1068 addinfo = "xslt apply failed for "
1069 + b->sptr->transform_xsl_fname;
1070 npr = zget_surrogateDiagRec(
1072 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1075 xmlFreeDoc(rec_doc);
1081 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1083 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1084 if (res.length() && b->content_session_id.length())
1086 size_t off = res.find_first_of("://");
1087 if (off != std::string::npos)
1090 sprintf(tmp, "%s.%s/",
1091 b->content_session_id.c_str(),
1092 m_p->content_proxy_server.c_str());
1093 res.insert(off + 3, tmp);
1098 xmlNode *ptr = xmlDocGetRootElement(doc);
1099 while (ptr && ptr->type != XML_ELEMENT_NODE)
1102 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1103 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1107 xmlFree(xmlrec_buf);
1109 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1110 rec_buf = (const char *) xmlrec_buf;
1117 npr = zget_surrogateDiagRec(
1119 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1123 npr = (Z_NamePlusRecord *)
1124 odr_malloc(odr, sizeof(*npr));
1125 npr->databaseName = odr_database;
1126 npr->which = Z_NamePlusRecord_databaseRecord;
1127 npr->u.databaseRecord =
1128 z_ext_record_xml(odr, rec_buf, rec_len);
1132 xmlFree(xmlrec_buf);
1137 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1140 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1141 npr->databaseName = odr_database;
1142 npr->which = Z_NamePlusRecord_databaseRecord;
1143 npr->u.databaseRecord = ext;
1147 npr = zget_surrogateDiagRec(
1149 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1150 "ZOOM_record, type ext");
1153 npl->records[i] = npr;
1155 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1156 records->which = Z_Records_DBOSD;
1157 records->u.databaseOrSurDiagnostics = npl;
1162 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1165 struct cql_node *r = 0;
1173 std::map<std::string,std::string>::const_iterator it;
1174 it = fieldmap.find(cn->u.st.index);
1175 if (it == fieldmap.end())
1177 if (it->second.length())
1178 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1184 r = convert_cql_fields(cn->u.boolean.left, odr);
1186 r = convert_cql_fields(cn->u.boolean.right, odr);
1189 r = convert_cql_fields(cn->u.sort.search, odr);
1195 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1197 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1198 /* see cql_sortby_to_sortkeys of YAZ. */
1200 int num_sortspec = 0;
1202 NMEM nmem = nmem_create();
1205 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1206 if (num_sortspec > 0)
1208 WRBUF w = wrbuf_alloc();
1209 for (i = 0; i < num_sortspec; i++)
1214 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1216 if (num_arg > 2 && arg[2][0])
1217 ascending = atoi(arg[2]);
1219 wrbuf_puts(w, "@or @attr 1=");
1220 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1221 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1225 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1226 wrbuf_rewind(pqf_wrbuf);
1227 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1234 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1236 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1237 /* see cql_sortby_to_sortkeys of YAZ. */
1239 int num_sortspec = 0;
1241 NMEM nmem = nmem_create();
1244 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1245 if (num_sortspec > 0)
1247 WRBUF w = wrbuf_alloc();
1248 for (i = 0; i < num_sortspec; i++)
1253 int case_sensitive = 0;
1254 const char *missing = 0;
1255 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1257 if (num_arg > 2 && arg[2][0])
1258 ascending = atoi(arg[2]);
1259 if (num_arg > 3 && arg[3][0])
1260 case_sensitive = atoi(arg[3]);
1261 if (num_arg > 4 && arg[4][0])
1266 wrbuf_puts(w, " sortby ");
1267 wrbuf_puts(w, arg[0]); /* field */
1269 wrbuf_puts(w, ascending ? "ascending" : "descending");
1271 wrbuf_puts(w, "/respectCase");
1274 if (!strcmp(missing, "omit"))
1275 wrbuf_puts(w, "/missingOmit");
1276 else if (!strcmp(missing, "abort"))
1277 wrbuf_puts(w, "/missingFail");
1278 else if (!strcmp(missing, "lowValue"))
1279 wrbuf_puts(w, "/missingLow");
1280 else if (!strcmp(missing, "highValue"))
1281 wrbuf_puts(w, "/missingHigh");
1285 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1291 #if YAZ_VERSIONL < 0x40206
1292 static void wrbuf_vp_puts(const char *buf, void *client_data)
1294 WRBUF b = (WRBUF) client_data;
1299 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1301 Z_GDU *gdu = package.request().get();
1302 Z_APDU *apdu_req = gdu->u.z3950;
1303 Z_APDU *apdu_res = 0;
1305 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1306 if (sr->num_databaseNames != 1)
1308 apdu_res = odr.create_searchResponse(
1309 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1310 package.response() = apdu_res;
1316 std::string db(sr->databaseNames[0]);
1317 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1321 odr.create_searchResponse(apdu_req, error, addinfo);
1322 package.response() = apdu_res;
1326 b->set_option("setname", "default");
1329 Z_Query *query = sr->query;
1330 WRBUF ccl_wrbuf = 0;
1331 WRBUF pqf_wrbuf = 0;
1332 std::string sru_sortkeys;
1334 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1337 pqf_wrbuf = wrbuf_alloc();
1338 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1340 else if (query->which == Z_Query_type_2)
1343 ccl_wrbuf = wrbuf_alloc();
1344 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1345 query->u.type_2->len);
1347 else if (query->which == Z_Query_type_104 &&
1348 query->u.type_104->which == Z_External_CQL)
1351 const char *cql = query->u.type_104->u.cql;
1352 CQL_parser cp = cql_parser_create();
1353 int r = cql_parser_string(cp, cql);
1356 cql_parser_destroy(cp);
1358 odr.create_searchResponse(apdu_req,
1359 YAZ_BIB1_MALFORMED_QUERY,
1360 "CQL syntax error");
1361 package.response() = apdu_res;
1364 struct cql_node *cn = cql_parser_result(cp);
1365 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1368 // hopefully we are getting a ptr to a index+relation+term node
1370 if (cn_error->which == CQL_NODE_ST)
1371 addinfo = cn_error->u.st.index;
1374 odr.create_searchResponse(apdu_req,
1375 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1377 package.response() = apdu_res;
1382 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1385 ccl_wrbuf = wrbuf_alloc();
1386 wrbuf_puts(ccl_wrbuf, ccl_buf);
1388 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1390 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1392 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1393 wrbuf_destroy(sru_sortkeys_wrbuf);
1395 cql_parser_destroy(cp);
1399 odr.create_searchResponse(apdu_req,
1400 YAZ_BIB1_MALFORMED_QUERY,
1401 "CQL to CCL conversion error");
1402 package.response() = apdu_res;
1409 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1410 package.response() = apdu_res;
1417 assert(pqf_wrbuf == 0);
1419 struct ccl_rpn_node *cn;
1420 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1421 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1423 wrbuf_destroy(ccl_wrbuf);
1426 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1427 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1431 case CCL_ERR_UNKNOWN_QUAL:
1432 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1434 case CCL_ERR_TRUNC_NOT_LEFT:
1435 case CCL_ERR_TRUNC_NOT_RIGHT:
1436 case CCL_ERR_TRUNC_NOT_BOTH:
1437 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1441 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1442 package.response() = apdu_res;
1445 pqf_wrbuf = wrbuf_alloc();
1446 ccl_pquery(pqf_wrbuf, cn);
1451 if (b->get_option("sru"))
1455 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1456 WRBUF wrb = wrbuf_alloc();
1458 if (!strcmp(b->get_option("sru"), "solr"))
1460 solr_transform_t cqlt = solr_transform_create();
1462 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1464 solr_transform_close(cqlt);
1468 cql_transform_t cqlt = cql_transform_create();
1470 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1472 cql_transform_close(cqlt);
1475 sort_via_cql(wrb, sru_sortkeys.c_str());
1479 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1480 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1484 wrbuf_destroy(pqf_wrbuf);
1488 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1489 "can not convert from RPN to CQL/SOLR");
1490 package.response() = apdu_res;
1496 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1498 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1499 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1500 wrbuf_destroy(pqf_wrbuf);
1503 const char *element_set_name = 0;
1504 Odr_int number_to_present = 0;
1506 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1508 Odr_int number_of_records_returned = 0;
1509 Z_Records *records = get_records(
1510 0, number_to_present, &error, &addinfo,
1511 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1513 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1516 apdu_res->u.searchResponse->records = records;
1517 apdu_res->u.searchResponse->numberOfRecordsReturned =
1518 odr_intdup(odr, number_of_records_returned);
1520 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1521 package.response() = apdu_res;
1524 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1526 Z_GDU *gdu = package.request().get();
1527 Z_APDU *apdu_req = gdu->u.z3950;
1528 Z_APDU *apdu_res = 0;
1529 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1534 package.response() = odr.create_presentResponse(
1535 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1538 const char *element_set_name = 0;
1539 Z_RecordComposition *comp = pr->recordComposition;
1540 if (comp && comp->which != Z_RecordComp_simple)
1542 package.response() = odr.create_presentResponse(
1544 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1547 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1548 element_set_name = comp->u.simple->u.generic;
1549 Odr_int number_of_records_returned = 0;
1552 Z_Records *records = get_records(
1553 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1554 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1555 pr->preferredRecordSyntax, element_set_name);
1557 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1560 apdu_res->u.presentResponse->records = records;
1561 apdu_res->u.presentResponse->numberOfRecordsReturned =
1562 odr_intdup(odr, number_of_records_returned);
1564 package.response() = apdu_res;
1567 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1569 Z_GDU *gdu = package.request().get();
1572 else if (gdu->which == Z_GDU_Z3950)
1574 Z_APDU *apdu_req = gdu->u.z3950;
1575 if (apdu_req->which == Z_APDU_initRequest)
1578 package.response() = odr.create_close(
1580 Z_Close_protocolError,
1583 else if (apdu_req->which == Z_APDU_searchRequest)
1585 handle_search(package);
1587 else if (apdu_req->which == Z_APDU_presentRequest)
1589 handle_present(package);
1594 package.response() = odr.create_close(
1596 Z_Close_protocolError,
1597 "zoom filter cannot handle this APDU");
1598 package.session().close();
1603 package.session().close();
1607 void yf::Zoom::Impl::process(mp::Package &package)
1609 FrontendPtr f = get_frontend(package);
1610 Z_GDU *gdu = package.request().get();
1612 if (f->m_is_virtual)
1614 f->handle_package(package);
1616 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1619 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1620 f->m_init_gdu = gdu;
1623 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1624 Z_InitResponse *resp = apdu->u.initResponse;
1627 static const int masks[] = {
1632 for (i = 0; masks[i] != -1; i++)
1633 if (ODR_MASK_GET(req->options, masks[i]))
1634 ODR_MASK_SET(resp->options, masks[i]);
1636 static const int versions[] = {
1637 Z_ProtocolVersion_1,
1638 Z_ProtocolVersion_2,
1639 Z_ProtocolVersion_3,
1642 for (i = 0; versions[i] != -1; i++)
1643 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1644 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1648 *resp->preferredMessageSize = *req->preferredMessageSize;
1649 *resp->maximumRecordSize = *req->maximumRecordSize;
1651 package.response() = apdu;
1652 f->m_is_virtual = true;
1657 release_frontend(package);
1661 static mp::filter::Base* filter_creator()
1663 return new mp::filter::Zoom;
1667 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1678 * c-file-style: "Stroustrup"
1679 * indent-tabs-mode: nil
1681 * vim: shiftwidth=4 tabstop=8 expandtab