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 struct Zoom::Searchable : boost::noncopyable {
57 std::string authentication;
63 std::string query_encoding;
65 std::string request_syntax;
66 std::string element_set;
67 std::string record_encoding;
68 std::string transform_xsl_fname;
69 std::string urlRecipe;
70 std::string contentConnector;
73 CCL_bibset ccl_bibset;
74 Searchable(CCL_bibset base);
77 class Zoom::Backend : boost::noncopyable {
79 friend class Frontend;
81 ZOOM_connection m_connection;
82 ZOOM_resultset m_resultset;
83 std::string m_frontend_database;
85 xsltStylesheetPtr xsp;
86 std::string content_session_id;
88 Backend(SearchablePtr sptr);
90 void connect(std::string zurl, int *error, char **addinfo,
92 void search_pqf(const char *pqf, Odr_int *hits,
93 int *error, char **addinfo, ODR odr);
94 void search_cql(const char *cql, Odr_int *hits,
95 int *error, char **addinfo, ODR odr);
96 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
97 int *error, char **addinfo, ODR odr);
98 void set_option(const char *name, const char *value);
99 void set_option(const char *name, std::string value);
100 const char *get_option(const char *name);
101 void get_zoom_error(int *error, char **addinfo, ODR odr);
103 class Zoom::Frontend : boost::noncopyable {
108 yazpp_1::GDU m_init_gdu;
109 BackendPtr m_backend;
110 void handle_package(mp::Package &package);
111 void handle_search(mp::Package &package);
112 void handle_present(mp::Package &package);
113 BackendPtr get_backend_from_databases(std::string &database,
117 Z_Records *get_records(Odr_int start,
118 Odr_int number_to_present,
121 Odr_int *number_of_records_returned,
122 ODR odr, BackendPtr b,
123 Odr_oid *preferredRecordSyntax,
124 const char *element_set_name);
126 Frontend(Impl *impl);
130 friend class Frontend;
134 void process(metaproxy_1::Package & package);
135 void configure(const xmlNode * ptr, bool test_only,
138 void configure_local_records(const xmlNode * ptr, bool test_only);
139 FrontendPtr get_frontend(mp::Package &package);
140 void release_frontend(mp::Package &package);
141 SearchablePtr parse_torus_record(const xmlNode *ptr);
142 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
143 std::map<mp::Session, FrontendPtr> m_clients;
144 boost::mutex m_mutex;
145 boost::condition m_cond_session_ready;
146 std::string torus_url;
147 std::map<std::string,std::string> fieldmap;
149 std::string file_path;
150 std::string content_proxy_server;
151 std::string content_tmp_file;
154 std::string element_transform;
155 std::string element_raw;
156 std::map<std::string,SearchablePtr> s_map;
161 // define Pimpl wrapper forwarding to Impl
163 yf::Zoom::Zoom() : m_p(new Impl)
168 { // must have a destructor because of boost::scoped_ptr
171 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
174 m_p->configure(xmlnode, test_only, path);
177 void yf::Zoom::process(mp::Package &package) const
179 m_p->process(package);
183 // define Implementation stuff
185 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
187 m_connection = ZOOM_connection_create(0);
192 yf::Zoom::Backend::~Backend()
195 xsltFreeStylesheet(xsp);
196 ZOOM_connection_destroy(m_connection);
197 ZOOM_resultset_destroy(m_resultset);
201 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
205 const char *zoom_addinfo = 0;
206 const char *dset = 0;
207 *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset);
210 if (*error >= ZOOM_ERROR_CONNECT)
212 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
213 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
214 *addinfo = (char *) odr_malloc(
215 odr, 20 + strlen(msg) +
216 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
217 strcpy(*addinfo, msg);
220 strcat(*addinfo, ": ");
221 strcat(*addinfo, zoom_addinfo);
222 strcat(*addinfo, " ");
227 if (dset && !strcmp(dset, "info:srw/diagnostic/1"))
228 *error = yaz_diag_srw_to_bib1(*error);
229 *addinfo = (char *) odr_malloc(
230 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
232 if (zoom_addinfo && *zoom_addinfo)
234 strcpy(*addinfo, zoom_addinfo);
235 strcat(*addinfo, " ");
237 strcat(*addinfo, "(backend)");
242 void yf::Zoom::Backend::connect(std::string zurl,
243 int *error, char **addinfo,
246 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
247 get_zoom_error(error, addinfo, odr);
250 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
251 int *error, char **addinfo, ODR odr)
253 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
254 get_zoom_error(error, addinfo, odr);
256 *hits = ZOOM_resultset_size(m_resultset);
261 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
262 int *error, char **addinfo, ODR odr)
264 ZOOM_query q = ZOOM_query_create();
266 ZOOM_query_cql(q, cql);
268 m_resultset = ZOOM_connection_search(m_connection, q);
269 ZOOM_query_destroy(q);
270 get_zoom_error(error, addinfo, odr);
272 *hits = ZOOM_resultset_size(m_resultset);
277 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
279 int *error, char **addinfo, ODR odr)
281 ZOOM_resultset_records(m_resultset, recs, start, number);
282 get_zoom_error(error, addinfo, odr);
285 void yf::Zoom::Backend::set_option(const char *name, const char *value)
287 ZOOM_connection_option_set(m_connection, name, value);
289 ZOOM_resultset_option_set(m_resultset, name, value);
292 void yf::Zoom::Backend::set_option(const char *name, std::string value)
294 set_option(name, value.c_str());
297 const char *yf::Zoom::Backend::get_option(const char *name)
299 return ZOOM_connection_option_get(m_connection, name);
302 yf::Zoom::Searchable::Searchable(CCL_bibset base)
305 use_turbomarc = true;
306 ccl_bibset = ccl_qual_dup(base);
309 yf::Zoom::Searchable::~Searchable()
311 ccl_qual_rm(&ccl_bibset);
314 yf::Zoom::Frontend::Frontend(Impl *impl) :
315 m_p(impl), m_is_virtual(false), m_in_use(true)
319 yf::Zoom::Frontend::~Frontend()
323 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
325 boost::mutex::scoped_lock lock(m_mutex);
327 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
331 it = m_clients.find(package.session());
332 if (it == m_clients.end())
335 if (!it->second->m_in_use)
337 it->second->m_in_use = true;
340 m_cond_session_ready.wait(lock);
342 FrontendPtr f(new Frontend(this));
343 m_clients[package.session()] = f;
348 void yf::Zoom::Impl::release_frontend(mp::Package &package)
350 boost::mutex::scoped_lock lock(m_mutex);
351 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
353 it = m_clients.find(package.session());
354 if (it != m_clients.end())
356 if (package.session().is_closed())
362 it->second->m_in_use = false;
364 m_cond_session_ready.notify_all();
368 yf::Zoom::Impl::Impl() :
369 apdu_log(false), element_transform("pz2") , element_raw("raw")
371 bibset = ccl_qual_mk();
376 yf::Zoom::Impl::~Impl()
378 ccl_qual_rm(&bibset);
381 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
383 Zoom::SearchablePtr s(new Searchable(bibset));
385 for (ptr = ptr->children; ptr; ptr = ptr->next)
387 if (ptr->type != XML_ELEMENT_NODE)
389 if (!strcmp((const char *) ptr->name, "layer"))
391 else if (!strcmp((const char *) ptr->name,
394 s->authentication = mp::xml::get_text(ptr);
396 else if (!strcmp((const char *) ptr->name,
399 s->cfAuth = mp::xml::get_text(ptr);
401 else if (!strcmp((const char *) ptr->name,
404 s->cfProxy = mp::xml::get_text(ptr);
406 else if (!strcmp((const char *) ptr->name,
409 s->cfSubDb = mp::xml::get_text(ptr);
411 else if (!strcmp((const char *) ptr->name,
414 s->contentConnector = mp::xml::get_text(ptr);
416 else if (!strcmp((const char *) ptr->name, "udb"))
418 s->udb = mp::xml::get_text(ptr);
420 else if (!strcmp((const char *) ptr->name, "zurl"))
422 s->target = mp::xml::get_text(ptr);
424 else if (!strcmp((const char *) ptr->name, "sru"))
426 s->sru = mp::xml::get_text(ptr);
428 else if (!strcmp((const char *) ptr->name,
431 s->query_encoding = mp::xml::get_text(ptr);
433 else if (!strcmp((const char *) ptr->name,
436 s->piggyback = mp::xml::get_bool(ptr, true);
438 else if (!strcmp((const char *) ptr->name,
441 s->request_syntax = mp::xml::get_text(ptr);
443 else if (!strcmp((const char *) ptr->name,
446 s->element_set = mp::xml::get_text(ptr);
448 else if (!strcmp((const char *) ptr->name,
451 s->record_encoding = mp::xml::get_text(ptr);
453 else if (!strcmp((const char *) ptr->name,
456 s->transform_xsl_fname = mp::xml::get_text(ptr);
458 else if (!strcmp((const char *) ptr->name,
461 s->urlRecipe = mp::xml::get_text(ptr);
463 else if (!strcmp((const char *) ptr->name,
466 ; // useTurboMarc is ignored
468 else if (!strncmp((const char *) ptr->name,
471 std::string value = mp::xml::get_text(ptr);
472 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
473 (const char *) ptr->name + 7);
479 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
481 while (ptr && ptr->type != XML_ELEMENT_NODE)
486 if (!strcmp((const char *) ptr->name, "records"))
488 for (ptr = ptr->children; ptr; ptr = ptr->next)
490 if (ptr->type != XML_ELEMENT_NODE)
492 if (!strcmp((const char *) ptr->name, "record"))
494 SearchablePtr s = parse_torus_record(ptr);
497 std::string udb = s->udb;
502 throw mp::filter::FilterException
503 ("No udb for local torus record");
509 throw mp::filter::FilterException
511 + std::string((const char *) ptr->name)
512 + " in zoom filter inside element "
519 throw mp::filter::FilterException
521 + std::string((const char *) ptr->name)
522 + " in zoom filter inside element <torus>");
527 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
530 content_tmp_file = "/tmp/cf.XXXXXX.p";
535 for (ptr = ptr->children; ptr; ptr = ptr->next)
537 if (ptr->type != XML_ELEMENT_NODE)
539 else if (!strcmp((const char *) ptr->name, "torus"))
541 const struct _xmlAttr *attr;
542 for (attr = ptr->properties; attr; attr = attr->next)
544 if (!strcmp((const char *) attr->name, "url"))
545 torus_url = mp::xml::get_text(attr->children);
546 else if (!strcmp((const char *) attr->name, "xsldir"))
547 xsldir = mp::xml::get_text(attr->children);
548 else if (!strcmp((const char *) attr->name, "element_transform"))
549 element_transform = mp::xml::get_text(attr->children);
550 else if (!strcmp((const char *) attr->name, "element_raw"))
551 element_raw = mp::xml::get_text(attr->children);
553 throw mp::filter::FilterException(
554 "Bad attribute " + std::string((const char *)
557 configure_local_records(ptr->children, test_only);
559 else if (!strcmp((const char *) ptr->name, "cclmap"))
561 const char *addinfo = 0;
562 ccl_xml_config(bibset, ptr, &addinfo);
564 else if (!strcmp((const char *) ptr->name, "fieldmap"))
566 const struct _xmlAttr *attr;
567 std::string ccl_field;
568 std::string cql_field;
569 for (attr = ptr->properties; attr; attr = attr->next)
571 if (!strcmp((const char *) attr->name, "ccl"))
572 ccl_field = mp::xml::get_text(attr->children);
573 else if (!strcmp((const char *) attr->name, "cql"))
574 cql_field = mp::xml::get_text(attr->children);
576 throw mp::filter::FilterException(
577 "Bad attribute " + std::string((const char *)
580 if (cql_field.length())
581 fieldmap[cql_field] = ccl_field;
583 else if (!strcmp((const char *) ptr->name, "contentProxy"))
585 const struct _xmlAttr *attr;
586 for (attr = ptr->properties; attr; attr = attr->next)
588 if (!strcmp((const char *) attr->name, "server"))
589 content_proxy_server = mp::xml::get_text(attr->children);
590 else if (!strcmp((const char *) attr->name, "tmp_file"))
591 content_tmp_file = mp::xml::get_text(attr->children);
593 throw mp::filter::FilterException(
594 "Bad attribute " + std::string((const char *)
598 else if (!strcmp((const char *) ptr->name, "log"))
600 const struct _xmlAttr *attr;
601 for (attr = ptr->properties; attr; attr = attr->next)
603 if (!strcmp((const char *) attr->name, "apdu"))
604 apdu_log = mp::xml::get_bool(attr->children, false);
606 throw mp::filter::FilterException(
607 "Bad attribute " + std::string((const char *)
613 throw mp::filter::FilterException
615 + std::string((const char *) ptr->name)
616 + " in zoom filter");
621 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
622 std::string &database, int *error, char **addinfo, ODR odr)
624 std::list<BackendPtr>::const_iterator map_it;
625 if (m_backend && m_backend->m_frontend_database == database)
629 std::string torus_db;
630 size_t db_arg_pos = database.find(',');
631 if (db_arg_pos != std::string::npos)
633 torus_db = database.substr(0, db_arg_pos);
634 db_args = database.substr(db_arg_pos + 1);
641 std::map<std::string,SearchablePtr>::iterator it;
642 it = m_p->s_map.find(torus_db);
643 if (it != m_p->s_map.end())
647 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
650 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
651 *addinfo = odr_strdup(odr, database.c_str());
655 const xmlNode *ptr = xmlDocGetRootElement(doc);
657 { // presumably ptr is a records element node
658 // parse first record in document
659 for (ptr = ptr->children; ptr; ptr = ptr->next)
661 if (ptr->type == XML_ELEMENT_NODE
662 && !strcmp((const char *) ptr->name, "record"))
664 sptr = m_p->parse_torus_record(ptr);
674 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
675 *addinfo = odr_strdup(odr, database.c_str());
680 xsltStylesheetPtr xsp = 0;
681 if (sptr->transform_xsl_fname.length())
683 const char *path = 0;
685 if (m_p->xsldir.length())
686 path = m_p->xsldir.c_str();
688 path = m_p->file_path.c_str();
692 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
698 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
700 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
701 sprintf(*addinfo, "File could not be read: %s",
702 sptr->transform_xsl_fname.c_str());
706 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
709 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
710 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
711 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
715 xsp = xsltParseStylesheetDoc(xsp_doc);
718 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
719 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
728 BackendPtr b(new Backend(sptr));
731 b->m_frontend_database = database;
733 if (sptr->query_encoding.length())
734 b->set_option("rpnCharset", sptr->query_encoding);
736 b->set_option("timeout", "40");
739 b->set_option("apdulog", "1");
741 std::string authentication = sptr->authentication;
742 std::string proxy = sptr->cfProxy;
744 const char *param_user = 0;
745 const char *param_password = 0;
746 const char *param_proxy = 0;
747 if (db_args.length())
752 int no_parms = yaz_uri_to_array(db_args.c_str(),
753 odr, &names, &values);
754 for (i = 0; i < no_parms; i++)
756 const char *name = names[i];
757 const char *value = values[i];
758 if (!strcmp(name, "user"))
760 else if (!strcmp(name, "password"))
761 param_password = value;
762 else if (!strcmp(name, "proxy"))
764 else if (!strcmp(name, "cproxysession"))
769 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
770 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
771 sprintf(msg, "Bad database argument: %s", name);
778 authentication = std::string(param_user);
780 authentication += "/" + std::string(param_password);
786 if (sptr->cfAuth.length())
789 b->set_option("user", sptr->cfAuth);
790 if (!param_user && !param_password && authentication.length())
792 if (db_args.length())
794 // no database (auth) args specified already.. and the
795 // Torus authentication has it.. Generate the args that CF
797 size_t found = authentication.find('/');
798 if (found != std::string::npos)
801 mp::util::uri_encode(authentication.substr(0, found))
803 mp::util::uri_encode(authentication.substr(found+1));
806 db_args += "user=" + mp::util::uri_encode(authentication);
808 if (!param_proxy && proxy.length())
810 if (db_args.length())
812 db_args += "proxy=" + mp::util::uri_encode(proxy);
814 if (sptr->cfSubDb.length())
816 if (db_args.length())
818 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
823 db_args.clear(); // no arguments to be passed (non-CF)
825 size_t found = authentication.find('/');
827 if (sptr->sru.length() && found != std::string::npos)
829 b->set_option("user", authentication.substr(0, found));
830 b->set_option("password", authentication.substr(found+1));
833 b->set_option("user", authentication);
836 b->set_option("proxy", proxy);
838 if (b->sptr->contentConnector.length())
840 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
841 strcpy(fname, m_p->content_tmp_file.c_str());
843 char *xx = strstr(fname, "XXXXXX");
845 suffixlen = strlen(xx) - 6;
849 xx = fname + strlen(fname);
850 strcat(fname, "XXXXXX");
852 char tmp_char = xx[6];
853 sprintf(xx, "%06d", ((unsigned) rand()) % 1000000);
856 int fd = creat(fname, 0666);
859 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
860 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
861 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
862 sprintf(*addinfo, "Could not create %s", fname);
864 BackendPtr backend_null;
867 b->content_session_id.assign(xx, 6);
868 WRBUF w = wrbuf_alloc();
869 wrbuf_puts(w, "#content_proxy\n");
870 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
871 if (authentication.length())
872 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
874 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
875 if (sptr->cfAuth.length())
876 wrbuf_printf(w, "cfauth: %s\n", sptr->cfAuth.c_str());
877 if (sptr->cfProxy.length())
878 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
880 write(fd, wrbuf_buf(w), wrbuf_len(w));
882 yaz_log(YLOG_LOG, "file %s created\n", fname);
887 if (sptr->sru.length())
889 url = "http://" + sptr->target;
890 b->set_option("sru", sptr->sru);
896 if (db_args.length())
897 url += "," + db_args;
898 yaz_log(YLOG_LOG, "url=%s", url.c_str());
899 b->connect(url, error, addinfo, odr);
907 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
908 Odr_int number_to_present,
911 Odr_int *number_of_records_returned,
914 Odr_oid *preferredRecordSyntax,
915 const char *element_set_name)
917 *number_of_records_returned = 0;
918 Z_Records *records = 0;
919 bool enable_pz2_retrieval = false; // whether target profile is used
920 bool enable_pz2_transform = false; // whether XSLT is used as well
921 bool assume_marc8_charset = false;
923 if (start < 0 || number_to_present <= 0)
926 if (number_to_present > 10000)
927 number_to_present = 10000;
929 ZOOM_record *recs = (ZOOM_record *)
930 odr_malloc(odr, number_to_present * sizeof(*recs));
932 char oid_name_str[OID_STR_MAX];
933 const char *syntax_name = 0;
935 if (preferredRecordSyntax &&
936 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
939 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
941 enable_pz2_retrieval = true;
942 enable_pz2_transform = true;
944 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
946 enable_pz2_retrieval = true;
950 if (enable_pz2_retrieval)
952 if (b->sptr->request_syntax.length())
954 syntax_name = b->sptr->request_syntax.c_str();
955 const Odr_oid *syntax_oid =
956 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
957 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
958 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
959 assume_marc8_charset = true;
962 else if (preferredRecordSyntax)
964 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
966 b->set_option("preferredRecordSyntax", syntax_name);
968 if (enable_pz2_retrieval)
970 element_set_name = 0;
971 if (b->sptr->element_set.length())
972 element_set_name = b->sptr->element_set.c_str();
975 b->set_option("elementSetName", element_set_name);
977 b->present(start, number_to_present, recs, error, addinfo, odr);
982 for (i = 0; i < number_to_present; i++)
987 { // only return records if no error and at least one record
988 char *odr_database = odr_strdup(odr,
989 b->m_frontend_database.c_str());
990 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
991 odr_malloc(odr, sizeof(*npl));
992 *number_of_records_returned = i;
993 npl->num_records = i;
994 npl->records = (Z_NamePlusRecord **)
995 odr_malloc(odr, i * sizeof(*npl->records));
996 for (i = 0; i < number_to_present; i++)
998 Z_NamePlusRecord *npr = 0;
1000 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
1001 &addinfo, 0 /* diagset */);
1005 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
1008 else if (enable_pz2_retrieval)
1010 char rec_type_str[100];
1011 const char *record_encoding = 0;
1013 if (b->sptr->record_encoding.length())
1014 record_encoding = b->sptr->record_encoding.c_str();
1015 else if (assume_marc8_charset)
1016 record_encoding = "marc8";
1018 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
1019 if (record_encoding)
1021 strcat(rec_type_str, "; charset=");
1022 strcat(rec_type_str, record_encoding);
1026 xmlChar *xmlrec_buf = 0;
1027 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
1029 if (!rec_buf && !npr)
1031 std::string addinfo("ZOOM_record_get failed for type ");
1033 addinfo += rec_type_str;
1034 npr = zget_surrogateDiagRec(
1036 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1040 if (rec_buf && b->xsp && enable_pz2_transform)
1042 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
1045 npr = zget_surrogateDiagRec(
1047 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1048 "xml parse failed for record");
1053 xsltApplyStylesheet(b->xsp, rec_doc, 0);
1057 xsltSaveResultToString(&xmlrec_buf, &rec_len,
1059 rec_buf = (const char *) xmlrec_buf;
1061 xmlFreeDoc(rec_res);
1065 std::string addinfo;
1067 addinfo = "xslt apply failed for "
1068 + b->sptr->transform_xsl_fname;
1069 npr = zget_surrogateDiagRec(
1071 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1074 xmlFreeDoc(rec_doc);
1080 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
1082 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
1083 if (res.length() && b->content_session_id.length())
1085 size_t off = res.find_first_of("://");
1086 if (off != std::string::npos)
1089 sprintf(tmp, "%s.%s/",
1090 b->content_session_id.c_str(),
1091 m_p->content_proxy_server.c_str());
1092 res.insert(off + 3, tmp);
1097 xmlNode *ptr = xmlDocGetRootElement(doc);
1098 while (ptr && ptr->type != XML_ELEMENT_NODE)
1101 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1102 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1106 xmlFree(xmlrec_buf);
1108 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1109 rec_buf = (const char *) xmlrec_buf;
1116 npr = zget_surrogateDiagRec(
1118 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1122 npr = (Z_NamePlusRecord *)
1123 odr_malloc(odr, sizeof(*npr));
1124 npr->databaseName = odr_database;
1125 npr->which = Z_NamePlusRecord_databaseRecord;
1126 npr->u.databaseRecord =
1127 z_ext_record_xml(odr, rec_buf, rec_len);
1131 xmlFree(xmlrec_buf);
1136 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1139 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1140 npr->databaseName = odr_database;
1141 npr->which = Z_NamePlusRecord_databaseRecord;
1142 npr->u.databaseRecord = ext;
1146 npr = zget_surrogateDiagRec(
1148 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1149 "ZOOM_record, type ext");
1152 npl->records[i] = npr;
1154 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1155 records->which = Z_Records_DBOSD;
1156 records->u.databaseOrSurDiagnostics = npl;
1161 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1164 struct cql_node *r = 0;
1172 std::map<std::string,std::string>::const_iterator it;
1173 it = fieldmap.find(cn->u.st.index);
1174 if (it == fieldmap.end())
1176 if (it->second.length())
1177 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1183 r = convert_cql_fields(cn->u.boolean.left, odr);
1185 r = convert_cql_fields(cn->u.boolean.right, odr);
1188 r = convert_cql_fields(cn->u.sort.search, odr);
1194 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1196 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1197 /* see cql_sortby_to_sortkeys of YAZ. */
1199 int num_sortspec = 0;
1201 NMEM nmem = nmem_create();
1204 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1205 if (num_sortspec > 0)
1207 WRBUF w = wrbuf_alloc();
1208 for (i = 0; i < num_sortspec; i++)
1213 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1215 if (num_arg > 2 && arg[2][0])
1216 ascending = atoi(arg[2]);
1218 wrbuf_puts(w, "@or @attr 1=");
1219 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1220 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1224 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1225 wrbuf_rewind(pqf_wrbuf);
1226 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1233 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1235 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1236 /* see cql_sortby_to_sortkeys of YAZ. */
1238 int num_sortspec = 0;
1240 NMEM nmem = nmem_create();
1243 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1244 if (num_sortspec > 0)
1246 WRBUF w = wrbuf_alloc();
1247 for (i = 0; i < num_sortspec; i++)
1252 int case_sensitive = 0;
1253 const char *missing = 0;
1254 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1256 if (num_arg > 2 && arg[2][0])
1257 ascending = atoi(arg[2]);
1258 if (num_arg > 3 && arg[3][0])
1259 case_sensitive = atoi(arg[3]);
1260 if (num_arg > 4 && arg[4][0])
1265 wrbuf_puts(w, " sortby ");
1266 wrbuf_puts(w, arg[0]); /* field */
1268 wrbuf_puts(w, ascending ? "ascending" : "descending");
1270 wrbuf_puts(w, "/respectCase");
1273 if (!strcmp(missing, "omit"))
1274 wrbuf_puts(w, "/missingOmit");
1275 else if (!strcmp(missing, "abort"))
1276 wrbuf_puts(w, "/missingFail");
1277 else if (!strcmp(missing, "lowValue"))
1278 wrbuf_puts(w, "/missingLow");
1279 else if (!strcmp(missing, "highValue"))
1280 wrbuf_puts(w, "/missingHigh");
1284 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1290 #if YAZ_VERSIONL < 0x40206
1291 static void wrbuf_vp_puts(const char *buf, void *client_data)
1293 WRBUF b = (WRBUF) client_data;
1298 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1300 Z_GDU *gdu = package.request().get();
1301 Z_APDU *apdu_req = gdu->u.z3950;
1302 Z_APDU *apdu_res = 0;
1304 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1305 if (sr->num_databaseNames != 1)
1307 apdu_res = odr.create_searchResponse(
1308 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1309 package.response() = apdu_res;
1315 std::string db(sr->databaseNames[0]);
1316 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1320 odr.create_searchResponse(apdu_req, error, addinfo);
1321 package.response() = apdu_res;
1325 b->set_option("setname", "default");
1328 Z_Query *query = sr->query;
1329 WRBUF ccl_wrbuf = 0;
1330 WRBUF pqf_wrbuf = 0;
1331 std::string sru_sortkeys;
1333 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1336 pqf_wrbuf = wrbuf_alloc();
1337 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1339 else if (query->which == Z_Query_type_2)
1342 ccl_wrbuf = wrbuf_alloc();
1343 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1344 query->u.type_2->len);
1346 else if (query->which == Z_Query_type_104 &&
1347 query->u.type_104->which == Z_External_CQL)
1350 const char *cql = query->u.type_104->u.cql;
1351 CQL_parser cp = cql_parser_create();
1352 int r = cql_parser_string(cp, cql);
1355 cql_parser_destroy(cp);
1357 odr.create_searchResponse(apdu_req,
1358 YAZ_BIB1_MALFORMED_QUERY,
1359 "CQL syntax error");
1360 package.response() = apdu_res;
1363 struct cql_node *cn = cql_parser_result(cp);
1364 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1367 // hopefully we are getting a ptr to a index+relation+term node
1369 if (cn_error->which == CQL_NODE_ST)
1370 addinfo = cn_error->u.st.index;
1373 odr.create_searchResponse(apdu_req,
1374 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1376 package.response() = apdu_res;
1381 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1384 ccl_wrbuf = wrbuf_alloc();
1385 wrbuf_puts(ccl_wrbuf, ccl_buf);
1387 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1389 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1391 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1392 wrbuf_destroy(sru_sortkeys_wrbuf);
1394 cql_parser_destroy(cp);
1398 odr.create_searchResponse(apdu_req,
1399 YAZ_BIB1_MALFORMED_QUERY,
1400 "CQL to CCL conversion error");
1401 package.response() = apdu_res;
1408 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1409 package.response() = apdu_res;
1416 assert(pqf_wrbuf == 0);
1418 struct ccl_rpn_node *cn;
1419 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1420 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1422 wrbuf_destroy(ccl_wrbuf);
1425 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1426 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1430 case CCL_ERR_UNKNOWN_QUAL:
1431 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1433 case CCL_ERR_TRUNC_NOT_LEFT:
1434 case CCL_ERR_TRUNC_NOT_RIGHT:
1435 case CCL_ERR_TRUNC_NOT_BOTH:
1436 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1440 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1441 package.response() = apdu_res;
1444 pqf_wrbuf = wrbuf_alloc();
1445 ccl_pquery(pqf_wrbuf, cn);
1450 if (b->get_option("sru"))
1454 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1455 WRBUF wrb = wrbuf_alloc();
1457 if (!strcmp(b->get_option("sru"), "solr"))
1459 solr_transform_t cqlt = solr_transform_create();
1461 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1463 solr_transform_close(cqlt);
1467 cql_transform_t cqlt = cql_transform_create();
1469 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1471 cql_transform_close(cqlt);
1474 sort_via_cql(wrb, sru_sortkeys.c_str());
1478 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1479 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1483 wrbuf_destroy(pqf_wrbuf);
1487 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1488 "can not convert from RPN to CQL/SOLR");
1489 package.response() = apdu_res;
1495 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1497 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1498 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1499 wrbuf_destroy(pqf_wrbuf);
1502 const char *element_set_name = 0;
1503 Odr_int number_to_present = 0;
1505 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1507 Odr_int number_of_records_returned = 0;
1508 Z_Records *records = get_records(
1509 0, number_to_present, &error, &addinfo,
1510 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1512 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1515 apdu_res->u.searchResponse->records = records;
1516 apdu_res->u.searchResponse->numberOfRecordsReturned =
1517 odr_intdup(odr, number_of_records_returned);
1519 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1520 package.response() = apdu_res;
1523 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1525 Z_GDU *gdu = package.request().get();
1526 Z_APDU *apdu_req = gdu->u.z3950;
1527 Z_APDU *apdu_res = 0;
1528 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1533 package.response() = odr.create_presentResponse(
1534 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1537 const char *element_set_name = 0;
1538 Z_RecordComposition *comp = pr->recordComposition;
1539 if (comp && comp->which != Z_RecordComp_simple)
1541 package.response() = odr.create_presentResponse(
1543 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1546 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1547 element_set_name = comp->u.simple->u.generic;
1548 Odr_int number_of_records_returned = 0;
1551 Z_Records *records = get_records(
1552 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1553 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1554 pr->preferredRecordSyntax, element_set_name);
1556 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1559 apdu_res->u.presentResponse->records = records;
1560 apdu_res->u.presentResponse->numberOfRecordsReturned =
1561 odr_intdup(odr, number_of_records_returned);
1563 package.response() = apdu_res;
1566 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1568 Z_GDU *gdu = package.request().get();
1571 else if (gdu->which == Z_GDU_Z3950)
1573 Z_APDU *apdu_req = gdu->u.z3950;
1574 if (apdu_req->which == Z_APDU_initRequest)
1577 package.response() = odr.create_close(
1579 Z_Close_protocolError,
1582 else if (apdu_req->which == Z_APDU_searchRequest)
1584 handle_search(package);
1586 else if (apdu_req->which == Z_APDU_presentRequest)
1588 handle_present(package);
1593 package.response() = odr.create_close(
1595 Z_Close_protocolError,
1596 "zoom filter cannot handle this APDU");
1597 package.session().close();
1602 package.session().close();
1606 void yf::Zoom::Impl::process(mp::Package &package)
1608 FrontendPtr f = get_frontend(package);
1609 Z_GDU *gdu = package.request().get();
1611 if (f->m_is_virtual)
1613 f->handle_package(package);
1615 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1618 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1619 f->m_init_gdu = gdu;
1622 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1623 Z_InitResponse *resp = apdu->u.initResponse;
1626 static const int masks[] = {
1631 for (i = 0; masks[i] != -1; i++)
1632 if (ODR_MASK_GET(req->options, masks[i]))
1633 ODR_MASK_SET(resp->options, masks[i]);
1635 static const int versions[] = {
1636 Z_ProtocolVersion_1,
1637 Z_ProtocolVersion_2,
1638 Z_ProtocolVersion_3,
1641 for (i = 0; versions[i] != -1; i++)
1642 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1643 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1647 *resp->preferredMessageSize = *req->preferredMessageSize;
1648 *resp->maximumRecordSize = *req->maximumRecordSize;
1650 package.response() = apdu;
1651 f->m_is_virtual = true;
1656 release_frontend(package);
1660 static mp::filter::Base* filter_creator()
1662 return new mp::filter::Zoom;
1666 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1677 * c-file-style: "Stroustrup"
1678 * indent-tabs-mode: nil
1680 * vim: shiftwidth=4 tabstop=8 expandtab