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
20 #include "filter_zoom.hpp"
22 #include <yaz/yaz-version.h>
23 #include <yaz/tpath.h>
25 #include <metaproxy/package.hpp>
26 #include <metaproxy/util.hpp>
27 #include <metaproxy/xmlutil.hpp>
30 #include <libxslt/xsltutils.h>
31 #include <libxslt/transform.h>
33 #include <boost/thread/mutex.hpp>
34 #include <boost/thread/condition.hpp>
35 #include <yaz/ccl_xml.h>
37 #include <yaz/rpn2cql.h>
38 #include <yaz/rpn2solr.h>
39 #include <yaz/pquery.h>
41 #include <yaz/oid_db.h>
42 #include <yaz/diagbib1.h>
45 #include <yaz/querytowrbuf.h>
47 namespace mp = metaproxy_1;
48 namespace yf = mp::filter;
50 namespace metaproxy_1 {
52 struct Zoom::Searchable : boost::noncopyable {
53 std::string authentication;
59 std::string query_encoding;
61 std::string request_syntax;
62 std::string element_set;
63 std::string record_encoding;
64 std::string transform_xsl_fname;
65 std::string urlRecipe;
66 std::string contentConnector;
69 CCL_bibset ccl_bibset;
70 Searchable(CCL_bibset base);
73 class Zoom::Backend : boost::noncopyable {
75 friend class Frontend;
77 ZOOM_connection m_connection;
78 ZOOM_resultset m_resultset;
79 std::string m_frontend_database;
81 xsltStylesheetPtr xsp;
82 std::string content_session_id;
84 Backend(SearchablePtr sptr);
86 void connect(std::string zurl, int *error, char **addinfo,
88 void search_pqf(const char *pqf, Odr_int *hits,
89 int *error, char **addinfo, ODR odr);
90 void search_cql(const char *cql, Odr_int *hits,
91 int *error, char **addinfo, ODR odr);
92 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
93 int *error, char **addinfo, ODR odr);
94 void set_option(const char *name, const char *value);
95 const char *get_option(const char *name);
96 void get_zoom_error(int *error, char **addinfo, ODR odr);
98 class Zoom::Frontend : boost::noncopyable {
103 yazpp_1::GDU m_init_gdu;
104 BackendPtr m_backend;
105 void handle_package(mp::Package &package);
106 void handle_search(mp::Package &package);
107 void handle_present(mp::Package &package);
108 BackendPtr get_backend_from_databases(std::string &database,
112 Z_Records *get_records(Odr_int start,
113 Odr_int number_to_present,
116 Odr_int *number_of_records_returned,
117 ODR odr, BackendPtr b,
118 Odr_oid *preferredRecordSyntax,
119 const char *element_set_name);
121 Frontend(Impl *impl);
125 friend class Frontend;
129 void process(metaproxy_1::Package & package);
130 void configure(const xmlNode * ptr, bool test_only,
133 void configure_local_records(const xmlNode * ptr, bool test_only);
134 FrontendPtr get_frontend(mp::Package &package);
135 void release_frontend(mp::Package &package);
136 SearchablePtr parse_torus_record(const xmlNode *ptr);
137 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
138 std::map<mp::Session, FrontendPtr> m_clients;
139 boost::mutex m_mutex;
140 boost::condition m_cond_session_ready;
141 std::string torus_url;
142 std::map<std::string,std::string> fieldmap;
144 std::string file_path;
145 std::string content_proxy_server;
146 std::string content_tmp_file;
148 std::string element_transform;
149 std::string element_raw;
150 std::map<std::string,SearchablePtr> s_map;
155 // define Pimpl wrapper forwarding to Impl
157 yf::Zoom::Zoom() : m_p(new Impl)
162 { // must have a destructor because of boost::scoped_ptr
165 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
168 m_p->configure(xmlnode, test_only, path);
171 void yf::Zoom::process(mp::Package &package) const
173 m_p->process(package);
177 // define Implementation stuff
179 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
181 m_connection = ZOOM_connection_create(0);
186 yf::Zoom::Backend::~Backend()
189 xsltFreeStylesheet(xsp);
190 ZOOM_connection_destroy(m_connection);
191 ZOOM_resultset_destroy(m_resultset);
195 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
199 const char *zoom_addinfo = 0;
200 *error = ZOOM_connection_error(m_connection, &msg, &zoom_addinfo);
203 if (*error >= ZOOM_ERROR_CONNECT)
205 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
206 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
207 *addinfo = (char *) odr_malloc(
208 odr, 20 + strlen(msg) +
209 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
210 strcpy(*addinfo, msg);
213 strcat(*addinfo, ": ");
214 strcat(*addinfo, zoom_addinfo);
215 strcat(*addinfo, " ");
220 *addinfo = (char *) odr_malloc(
221 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
223 if (zoom_addinfo && *zoom_addinfo)
225 strcpy(*addinfo, zoom_addinfo);
226 strcat(*addinfo, " ");
228 strcat(*addinfo, "(backend)");
233 void yf::Zoom::Backend::connect(std::string zurl,
234 int *error, char **addinfo,
237 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
238 get_zoom_error(error, addinfo, odr);
241 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
242 int *error, char **addinfo, ODR odr)
244 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
245 get_zoom_error(error, addinfo, odr);
247 *hits = ZOOM_resultset_size(m_resultset);
252 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
253 int *error, char **addinfo, ODR odr)
255 ZOOM_query q = ZOOM_query_create();
257 ZOOM_query_cql(q, cql);
259 m_resultset = ZOOM_connection_search(m_connection, q);
260 ZOOM_query_destroy(q);
261 get_zoom_error(error, addinfo, odr);
263 *hits = ZOOM_resultset_size(m_resultset);
268 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
270 int *error, char **addinfo, ODR odr)
272 ZOOM_resultset_records(m_resultset, recs, start, number);
273 get_zoom_error(error, addinfo, odr);
276 void yf::Zoom::Backend::set_option(const char *name, const char *value)
278 ZOOM_connection_option_set(m_connection, name, value);
280 ZOOM_resultset_option_set(m_resultset, name, value);
283 const char *yf::Zoom::Backend::get_option(const char *name)
285 return ZOOM_connection_option_get(m_connection, name);
288 yf::Zoom::Searchable::Searchable(CCL_bibset base)
291 use_turbomarc = true;
292 ccl_bibset = ccl_qual_dup(base);
295 yf::Zoom::Searchable::~Searchable()
297 ccl_qual_rm(&ccl_bibset);
300 yf::Zoom::Frontend::Frontend(Impl *impl) :
301 m_p(impl), m_is_virtual(false), m_in_use(true)
305 yf::Zoom::Frontend::~Frontend()
309 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
311 boost::mutex::scoped_lock lock(m_mutex);
313 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
317 it = m_clients.find(package.session());
318 if (it == m_clients.end())
321 if (!it->second->m_in_use)
323 it->second->m_in_use = true;
326 m_cond_session_ready.wait(lock);
328 FrontendPtr f(new Frontend(this));
329 m_clients[package.session()] = f;
334 void yf::Zoom::Impl::release_frontend(mp::Package &package)
336 boost::mutex::scoped_lock lock(m_mutex);
337 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
339 it = m_clients.find(package.session());
340 if (it != m_clients.end())
342 if (package.session().is_closed())
348 it->second->m_in_use = false;
350 m_cond_session_ready.notify_all();
354 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
356 bibset = ccl_qual_mk();
359 yf::Zoom::Impl::~Impl()
361 ccl_qual_rm(&bibset);
364 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
366 Zoom::SearchablePtr s(new Searchable(bibset));
368 for (ptr = ptr->children; ptr; ptr = ptr->next)
370 if (ptr->type != XML_ELEMENT_NODE)
372 if (!strcmp((const char *) ptr->name, "layer"))
374 else if (!strcmp((const char *) ptr->name,
377 s->authentication = mp::xml::get_text(ptr);
379 else if (!strcmp((const char *) ptr->name,
382 s->cfAuth = mp::xml::get_text(ptr);
384 else if (!strcmp((const char *) ptr->name,
387 s->cfProxy = mp::xml::get_text(ptr);
389 else if (!strcmp((const char *) ptr->name,
392 s->cfSubDb = mp::xml::get_text(ptr);
394 else if (!strcmp((const char *) ptr->name,
397 s->contentConnector = mp::xml::get_text(ptr);
399 else if (!strcmp((const char *) ptr->name, "udb"))
401 s->udb = mp::xml::get_text(ptr);
403 else if (!strcmp((const char *) ptr->name, "zurl"))
405 s->target = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name, "sru"))
409 s->sru = mp::xml::get_text(ptr);
411 else if (!strcmp((const char *) ptr->name,
414 s->query_encoding = mp::xml::get_text(ptr);
416 else if (!strcmp((const char *) ptr->name,
419 s->piggyback = mp::xml::get_bool(ptr, true);
421 else if (!strcmp((const char *) ptr->name,
424 s->request_syntax = mp::xml::get_text(ptr);
426 else if (!strcmp((const char *) ptr->name,
429 s->element_set = mp::xml::get_text(ptr);
431 else if (!strcmp((const char *) ptr->name,
434 s->record_encoding = mp::xml::get_text(ptr);
436 else if (!strcmp((const char *) ptr->name,
439 s->transform_xsl_fname = mp::xml::get_text(ptr);
441 else if (!strcmp((const char *) ptr->name,
444 s->urlRecipe = mp::xml::get_text(ptr);
446 else if (!strcmp((const char *) ptr->name,
449 ; // useTurboMarc is ignored
451 else if (!strncmp((const char *) ptr->name,
454 std::string value = mp::xml::get_text(ptr);
455 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
456 (const char *) ptr->name + 7);
462 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
464 while (ptr && ptr->type != XML_ELEMENT_NODE)
469 if (!strcmp((const char *) ptr->name, "records"))
471 for (ptr = ptr->children; ptr; ptr = ptr->next)
473 if (ptr->type != XML_ELEMENT_NODE)
475 if (!strcmp((const char *) ptr->name, "record"))
477 SearchablePtr s = parse_torus_record(ptr);
480 std::string udb = s->udb;
485 throw mp::filter::FilterException
486 ("No udb for local torus record");
492 throw mp::filter::FilterException
494 + std::string((const char *) ptr->name)
495 + " in zoom filter inside element "
502 throw mp::filter::FilterException
504 + std::string((const char *) ptr->name)
505 + " in zoom filter inside element <torus>");
510 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
513 content_tmp_file = "/tmp/mp_content_proxy.";
518 for (ptr = ptr->children; ptr; ptr = ptr->next)
520 if (ptr->type != XML_ELEMENT_NODE)
522 else if (!strcmp((const char *) ptr->name, "torus"))
524 const struct _xmlAttr *attr;
525 for (attr = ptr->properties; attr; attr = attr->next)
527 if (!strcmp((const char *) attr->name, "url"))
528 torus_url = mp::xml::get_text(attr->children);
529 else if (!strcmp((const char *) attr->name, "xsldir"))
530 xsldir = mp::xml::get_text(attr->children);
531 else if (!strcmp((const char *) attr->name, "element_transform"))
532 element_transform = mp::xml::get_text(attr->children);
533 else if (!strcmp((const char *) attr->name, "element_raw"))
534 element_raw = mp::xml::get_text(attr->children);
536 throw mp::filter::FilterException(
537 "Bad attribute " + std::string((const char *)
540 configure_local_records(ptr->children, test_only);
542 else if (!strcmp((const char *) ptr->name, "cclmap"))
544 const char *addinfo = 0;
545 ccl_xml_config(bibset, ptr, &addinfo);
547 else if (!strcmp((const char *) ptr->name, "fieldmap"))
549 const struct _xmlAttr *attr;
550 std::string ccl_field;
551 std::string cql_field;
552 for (attr = ptr->properties; attr; attr = attr->next)
554 if (!strcmp((const char *) attr->name, "ccl"))
555 ccl_field = mp::xml::get_text(attr->children);
556 else if (!strcmp((const char *) attr->name, "cql"))
557 cql_field = mp::xml::get_text(attr->children);
559 throw mp::filter::FilterException(
560 "Bad attribute " + std::string((const char *)
563 if (cql_field.length())
564 fieldmap[cql_field] = ccl_field;
566 else if (!strcmp((const char *) ptr->name, "contentProxy"))
568 const struct _xmlAttr *attr;
569 for (attr = ptr->properties; attr; attr = attr->next)
571 if (!strcmp((const char *) attr->name, "server"))
572 content_proxy_server = mp::xml::get_text(attr->children);
573 else if (!strcmp((const char *) attr->name, "tmp_file"))
574 content_tmp_file = mp::xml::get_text(attr->children);
576 throw mp::filter::FilterException(
577 "Bad attribute " + std::string((const char *)
583 throw mp::filter::FilterException
585 + std::string((const char *) ptr->name)
586 + " in zoom filter");
591 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
592 std::string &database, int *error, char **addinfo, ODR odr)
594 std::list<BackendPtr>::const_iterator map_it;
595 if (m_backend && m_backend->m_frontend_database == database)
599 std::string torus_db;
600 size_t db_arg_pos = database.find(',');
601 if (db_arg_pos != std::string::npos)
603 torus_db = database.substr(0, db_arg_pos);
604 db_args = database.substr(db_arg_pos + 1);
611 std::map<std::string,SearchablePtr>::iterator it;
612 it = m_p->s_map.find(torus_db);
613 if (it != m_p->s_map.end())
617 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
620 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
621 *addinfo = odr_strdup(odr, database.c_str());
625 const xmlNode *ptr = xmlDocGetRootElement(doc);
627 { // presumably ptr is a records element node
628 // parse first record in document
629 for (ptr = ptr->children; ptr; ptr = ptr->next)
631 if (ptr->type == XML_ELEMENT_NODE
632 && !strcmp((const char *) ptr->name, "record"))
634 sptr = m_p->parse_torus_record(ptr);
644 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
645 *addinfo = odr_strdup(odr, database.c_str());
650 xsltStylesheetPtr xsp = 0;
651 if (sptr->transform_xsl_fname.length())
653 const char *path = 0;
655 if (m_p->xsldir.length())
656 path = m_p->xsldir.c_str();
658 path = m_p->file_path.c_str();
662 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
668 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
670 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
671 sprintf(*addinfo, "File could not be read: %s",
672 sptr->transform_xsl_fname.c_str());
676 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
679 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
680 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
681 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
685 xsp = xsltParseStylesheetDoc(xsp_doc);
688 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
689 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
698 BackendPtr b(new Backend(sptr));
701 b->m_frontend_database = database;
703 if (sptr->query_encoding.length())
704 b->set_option("rpnCharset", sptr->query_encoding.c_str());
706 b->set_option("timeout", "40");
709 std::string authentication = sptr->authentication;
710 std::string proxy = sptr->cfProxy;
712 const char *param_user = 0;
713 const char *param_password = 0;
714 const char *param_proxy = 0;
715 if (db_args.length())
720 int no_parms = yaz_uri_to_array(db_args.c_str(),
721 odr, &names, &values);
722 for (i = 0; i < no_parms; i++)
724 const char *name = names[i];
725 const char *value = values[i];
726 if (!strcmp(name, "user"))
728 else if (!strcmp(name, "password"))
729 param_password = value;
730 else if (!strcmp(name, "proxy"))
735 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
736 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
737 sprintf(msg, "Bad database argument: %s", name);
742 if (param_user && param_password)
744 authentication = std::string(param_user)
745 + "/" + std::string(param_password);
751 if (sptr->cfAuth.length())
754 b->set_option("user", sptr->cfAuth.c_str());
755 if (!param_user && !param_password && authentication.length())
757 if (db_args.length())
759 // no database (auth) args specified already.. and the
760 // Torus authentication has it.. Generate the args that CF
762 size_t found = authentication.find('/');
763 if (found != std::string::npos)
766 mp::util::uri_encode(authentication.substr(0, found))
768 mp::util::uri_encode(authentication.substr(found+1));
771 db_args += "user=" + mp::util::uri_encode(authentication);
773 if (!param_proxy && proxy.length())
775 if (db_args.length())
777 db_args += "proxy=" + mp::util::uri_encode(proxy);
779 if (sptr->cfSubDb.length())
781 if (db_args.length())
783 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
788 db_args.clear(); // no arguments to be passed (non-CF)
790 if (authentication.length())
791 b->set_option("user", authentication.c_str());
793 b->set_option("proxy", proxy.c_str());
795 if (b->sptr->contentConnector.length())
799 char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8);
800 strcpy(fname, m_p->content_tmp_file.c_str());
801 strcat(fname, "XXXXXX");
806 yaz_log(YLOG_WARN|YLOG_ERRNO, "create %s", fname);
807 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
808 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname));
809 sprintf(*addinfo, "Could not create %s", fname);
811 BackendPtr backend_null;
814 b->content_session_id.assign(fname + (strlen(fname) - 6));
815 WRBUF w = wrbuf_alloc();
816 wrbuf_puts(w, "#content_proxy\n");
817 wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str());
818 if (authentication.length())
819 wrbuf_printf(w, "authentication: %s\n", authentication.c_str());
821 wrbuf_printf(w, "proxy: %s\n", proxy.c_str());
822 if (sptr->cfAuth.length())
823 wrbuf_printf(w, "cfauth: %s\n", sptr->cfAuth.c_str());
824 if (sptr->cfProxy.length())
825 wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str());
827 write(fd, wrbuf_buf(w), wrbuf_len(w));
829 yaz_log(YLOG_LOG, "file %s created\n", fname);
835 if (sptr->sru.length())
837 url = "http://" + sptr->target;
838 b->set_option("sru", sptr->sru.c_str());
844 if (db_args.length())
845 url += "," + db_args;
846 yaz_log(YLOG_LOG, "url=%s", url.c_str());
847 b->connect(url, error, addinfo, odr);
855 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
856 Odr_int number_to_present,
859 Odr_int *number_of_records_returned,
862 Odr_oid *preferredRecordSyntax,
863 const char *element_set_name)
865 *number_of_records_returned = 0;
866 Z_Records *records = 0;
867 bool enable_pz2_retrieval = false; // whether target profile is used
868 bool enable_pz2_transform = false; // whether XSLT is used as well
869 bool assume_marc8_charset = false;
871 if (start < 0 || number_to_present <= 0)
874 if (number_to_present > 10000)
875 number_to_present = 10000;
877 ZOOM_record *recs = (ZOOM_record *)
878 odr_malloc(odr, number_to_present * sizeof(*recs));
880 char oid_name_str[OID_STR_MAX];
881 const char *syntax_name = 0;
883 if (preferredRecordSyntax &&
884 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
887 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
889 enable_pz2_retrieval = true;
890 enable_pz2_transform = true;
892 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
894 enable_pz2_retrieval = true;
898 if (enable_pz2_retrieval)
900 if (b->sptr->request_syntax.length())
902 syntax_name = b->sptr->request_syntax.c_str();
903 const Odr_oid *syntax_oid =
904 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
905 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
906 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
907 assume_marc8_charset = true;
910 else if (preferredRecordSyntax)
912 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
914 b->set_option("preferredRecordSyntax", syntax_name);
916 if (enable_pz2_retrieval)
918 element_set_name = 0;
919 if (b->sptr->element_set.length())
920 element_set_name = b->sptr->element_set.c_str();
923 b->set_option("elementSetName", element_set_name);
925 b->present(start, number_to_present, recs, error, addinfo, odr);
930 for (i = 0; i < number_to_present; i++)
935 { // only return records if no error and at least one record
936 char *odr_database = odr_strdup(odr,
937 b->m_frontend_database.c_str());
938 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
939 odr_malloc(odr, sizeof(*npl));
940 *number_of_records_returned = i;
941 npl->num_records = i;
942 npl->records = (Z_NamePlusRecord **)
943 odr_malloc(odr, i * sizeof(*npl->records));
944 for (i = 0; i < number_to_present; i++)
946 Z_NamePlusRecord *npr = 0;
948 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
949 &addinfo, 0 /* diagset */);
953 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
956 else if (enable_pz2_retrieval)
958 char rec_type_str[100];
959 const char *record_encoding = 0;
961 if (b->sptr->record_encoding.length())
962 record_encoding = b->sptr->record_encoding.c_str();
963 else if (assume_marc8_charset)
964 record_encoding = "marc8";
966 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
969 strcat(rec_type_str, "; charset=");
970 strcat(rec_type_str, record_encoding);
974 xmlChar *xmlrec_buf = 0;
975 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
977 if (rec_buf && b->xsp && enable_pz2_transform)
979 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
983 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
986 xsltSaveResultToString(&xmlrec_buf, &rec_len,
988 rec_buf = (const char *) xmlrec_buf;
996 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
998 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
999 if (res.length() && b->content_session_id.length())
1001 size_t off = res.find_first_of("://");
1002 if (off != std::string::npos)
1005 sprintf(tmp, "%s.%s/",
1006 b->content_session_id.c_str(),
1007 m_p->content_proxy_server.c_str());
1008 res.insert(off + 3, tmp);
1013 xmlNode *ptr = xmlDocGetRootElement(doc);
1014 while (ptr && ptr->type != XML_ELEMENT_NODE)
1017 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
1018 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
1022 xmlFree(xmlrec_buf);
1024 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
1025 rec_buf = (const char *) xmlrec_buf;
1031 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1032 npr->databaseName = odr_database;
1033 npr->which = Z_NamePlusRecord_databaseRecord;
1034 npr->u.databaseRecord =
1035 z_ext_record_xml(odr, rec_buf, rec_len);
1039 npr = zget_surrogateDiagRec(
1041 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1045 xmlFree(xmlrec_buf);
1050 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1053 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1054 npr->databaseName = odr_database;
1055 npr->which = Z_NamePlusRecord_databaseRecord;
1056 npr->u.databaseRecord = ext;
1060 npr = zget_surrogateDiagRec(
1062 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1063 "ZOOM_record, type ext");
1066 npl->records[i] = npr;
1068 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1069 records->which = Z_Records_DBOSD;
1070 records->u.databaseOrSurDiagnostics = npl;
1075 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1078 struct cql_node *r = 0;
1086 std::map<std::string,std::string>::const_iterator it;
1087 it = fieldmap.find(cn->u.st.index);
1088 if (it == fieldmap.end())
1090 if (it->second.length())
1091 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1097 r = convert_cql_fields(cn->u.boolean.left, odr);
1099 r = convert_cql_fields(cn->u.boolean.right, odr);
1102 r = convert_cql_fields(cn->u.sort.search, odr);
1108 static void sort_pqf_type_7(WRBUF pqf_wrbuf, const char *sru_sortkeys)
1110 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1111 /* see cql_sortby_to_sortkeys of YAZ. */
1113 int num_sortspec = 0;
1115 NMEM nmem = nmem_create();
1118 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1119 if (num_sortspec > 0)
1121 WRBUF w = wrbuf_alloc();
1122 for (i = 0; i < num_sortspec; i++)
1127 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1129 if (num_arg > 2 && arg[2][0])
1130 ascending = atoi(arg[2]);
1132 wrbuf_puts(w, "@or @attr 1=");
1133 yaz_encode_pqf_term(w, arg[0], strlen(arg[0]));
1134 wrbuf_printf(w, "@attr 7=%d %d ", ascending ? 1 : 2, i);
1138 wrbuf_puts(w, wrbuf_cstr(pqf_wrbuf));
1139 wrbuf_rewind(pqf_wrbuf);
1140 wrbuf_puts(pqf_wrbuf, wrbuf_cstr(w));
1147 static void sort_via_cql(WRBUF cql_sortby, const char *sru_sortkeys)
1149 /* sortkey layour: path,schema,ascending,caseSensitive,missingValue */
1150 /* see cql_sortby_to_sortkeys of YAZ. */
1152 int num_sortspec = 0;
1154 NMEM nmem = nmem_create();
1157 nmem_strsplit_blank(nmem, sru_sortkeys, &sortspec, &num_sortspec);
1158 if (num_sortspec > 0)
1160 WRBUF w = wrbuf_alloc();
1161 for (i = 0; i < num_sortspec; i++)
1166 int case_sensitive = 0;
1167 const char *missing = 0;
1168 nmem_strsplitx(nmem, ",", sortspec[i], &arg, &num_arg, 0);
1170 if (num_arg > 2 && arg[2][0])
1171 ascending = atoi(arg[2]);
1172 if (num_arg > 3 && arg[3][0])
1173 case_sensitive = atoi(arg[3]);
1174 if (num_arg > 4 && arg[4][0])
1179 wrbuf_puts(w, " sortby ");
1180 wrbuf_puts(w, arg[0]); /* field */
1182 wrbuf_puts(w, ascending ? "ascending" : "descending");
1184 wrbuf_puts(w, "/respectCase");
1187 if (!strcmp(missing, "omit"))
1188 wrbuf_puts(w, "/missingOmit");
1189 else if (!strcmp(missing, "abort"))
1190 wrbuf_puts(w, "/missingFail");
1191 else if (!strcmp(missing, "lowValue"))
1192 wrbuf_puts(w, "/missingLow");
1193 else if (!strcmp(missing, "highValue"))
1194 wrbuf_puts(w, "/missingHigh");
1198 wrbuf_puts(cql_sortby, wrbuf_cstr(w));
1205 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1207 Z_GDU *gdu = package.request().get();
1208 Z_APDU *apdu_req = gdu->u.z3950;
1209 Z_APDU *apdu_res = 0;
1211 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1212 if (sr->num_databaseNames != 1)
1214 apdu_res = odr.create_searchResponse(
1215 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1216 package.response() = apdu_res;
1222 std::string db(sr->databaseNames[0]);
1223 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1227 odr.create_searchResponse(apdu_req, error, addinfo);
1228 package.response() = apdu_res;
1232 b->set_option("setname", "default");
1235 Z_Query *query = sr->query;
1236 WRBUF ccl_wrbuf = 0;
1237 WRBUF pqf_wrbuf = 0;
1238 std::string sru_sortkeys;
1240 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1243 pqf_wrbuf = wrbuf_alloc();
1244 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1246 else if (query->which == Z_Query_type_2)
1249 ccl_wrbuf = wrbuf_alloc();
1250 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1251 query->u.type_2->len);
1253 else if (query->which == Z_Query_type_104 &&
1254 query->u.type_104->which == Z_External_CQL)
1257 const char *cql = query->u.type_104->u.cql;
1258 CQL_parser cp = cql_parser_create();
1259 int r = cql_parser_string(cp, cql);
1262 cql_parser_destroy(cp);
1264 odr.create_searchResponse(apdu_req,
1265 YAZ_BIB1_MALFORMED_QUERY,
1266 "CQL syntax error");
1267 package.response() = apdu_res;
1270 struct cql_node *cn = cql_parser_result(cp);
1271 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1274 // hopefully we are getting a ptr to a index+relation+term node
1276 if (cn_error->which == CQL_NODE_ST)
1277 addinfo = cn_error->u.st.index;
1280 odr.create_searchResponse(apdu_req,
1281 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1283 package.response() = apdu_res;
1288 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1291 ccl_wrbuf = wrbuf_alloc();
1292 wrbuf_puts(ccl_wrbuf, ccl_buf);
1294 WRBUF sru_sortkeys_wrbuf = wrbuf_alloc();
1296 cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf);
1298 sru_sortkeys.assign(wrbuf_cstr(sru_sortkeys_wrbuf));
1299 wrbuf_destroy(sru_sortkeys_wrbuf);
1301 cql_parser_destroy(cp);
1305 odr.create_searchResponse(apdu_req,
1306 YAZ_BIB1_MALFORMED_QUERY,
1307 "CQL to CCL conversion error");
1308 package.response() = apdu_res;
1315 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1316 package.response() = apdu_res;
1323 assert(pqf_wrbuf == 0);
1325 struct ccl_rpn_node *cn;
1326 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1327 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1329 wrbuf_destroy(ccl_wrbuf);
1332 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1333 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1337 case CCL_ERR_UNKNOWN_QUAL:
1338 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1340 case CCL_ERR_TRUNC_NOT_LEFT:
1341 case CCL_ERR_TRUNC_NOT_RIGHT:
1342 case CCL_ERR_TRUNC_NOT_BOTH:
1343 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1347 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1348 package.response() = apdu_res;
1351 pqf_wrbuf = wrbuf_alloc();
1352 ccl_pquery(pqf_wrbuf, cn);
1357 if (b->get_option("sru"))
1361 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1362 WRBUF wrb = wrbuf_alloc();
1364 if (!strcmp(b->get_option("sru"), "solr"))
1366 solr_transform_t cqlt = solr_transform_create();
1368 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1370 solr_transform_close(cqlt);
1374 cql_transform_t cqlt = cql_transform_create();
1376 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1378 cql_transform_close(cqlt);
1381 sort_via_cql(wrb, sru_sortkeys.c_str());
1385 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1386 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1390 wrbuf_destroy(pqf_wrbuf);
1394 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1395 "can not convert from RPN to CQL/SOLR");
1396 package.response() = apdu_res;
1402 sort_pqf_type_7(pqf_wrbuf, sru_sortkeys.c_str());
1404 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1405 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1406 wrbuf_destroy(pqf_wrbuf);
1409 const char *element_set_name = 0;
1410 Odr_int number_to_present = 0;
1412 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1414 Odr_int number_of_records_returned = 0;
1415 Z_Records *records = get_records(
1416 0, number_to_present, &error, &addinfo,
1417 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1419 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1422 apdu_res->u.searchResponse->records = records;
1423 apdu_res->u.searchResponse->numberOfRecordsReturned =
1424 odr_intdup(odr, number_of_records_returned);
1426 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1427 package.response() = apdu_res;
1430 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1432 Z_GDU *gdu = package.request().get();
1433 Z_APDU *apdu_req = gdu->u.z3950;
1434 Z_APDU *apdu_res = 0;
1435 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1440 package.response() = odr.create_presentResponse(
1441 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1444 const char *element_set_name = 0;
1445 Z_RecordComposition *comp = pr->recordComposition;
1446 if (comp && comp->which != Z_RecordComp_simple)
1448 package.response() = odr.create_presentResponse(
1450 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1453 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1454 element_set_name = comp->u.simple->u.generic;
1455 Odr_int number_of_records_returned = 0;
1458 Z_Records *records = get_records(
1459 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1460 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1461 pr->preferredRecordSyntax, element_set_name);
1463 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1466 apdu_res->u.presentResponse->records = records;
1467 apdu_res->u.presentResponse->numberOfRecordsReturned =
1468 odr_intdup(odr, number_of_records_returned);
1470 package.response() = apdu_res;
1473 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1475 Z_GDU *gdu = package.request().get();
1478 else if (gdu->which == Z_GDU_Z3950)
1480 Z_APDU *apdu_req = gdu->u.z3950;
1481 if (apdu_req->which == Z_APDU_initRequest)
1484 package.response() = odr.create_close(
1486 Z_Close_protocolError,
1489 else if (apdu_req->which == Z_APDU_searchRequest)
1491 handle_search(package);
1493 else if (apdu_req->which == Z_APDU_presentRequest)
1495 handle_present(package);
1500 package.response() = odr.create_close(
1502 Z_Close_protocolError,
1503 "zoom filter cannot handle this APDU");
1504 package.session().close();
1509 package.session().close();
1513 void yf::Zoom::Impl::process(mp::Package &package)
1515 FrontendPtr f = get_frontend(package);
1516 Z_GDU *gdu = package.request().get();
1518 if (f->m_is_virtual)
1520 f->handle_package(package);
1522 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1525 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1526 f->m_init_gdu = gdu;
1529 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1530 Z_InitResponse *resp = apdu->u.initResponse;
1533 static const int masks[] = {
1538 for (i = 0; masks[i] != -1; i++)
1539 if (ODR_MASK_GET(req->options, masks[i]))
1540 ODR_MASK_SET(resp->options, masks[i]);
1542 static const int versions[] = {
1543 Z_ProtocolVersion_1,
1544 Z_ProtocolVersion_2,
1545 Z_ProtocolVersion_3,
1548 for (i = 0; versions[i] != -1; i++)
1549 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1550 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1554 *resp->preferredMessageSize = *req->preferredMessageSize;
1555 *resp->maximumRecordSize = *req->maximumRecordSize;
1557 package.response() = apdu;
1558 f->m_is_virtual = true;
1563 release_frontend(package);
1567 static mp::filter::Base* filter_creator()
1569 return new mp::filter::Zoom;
1573 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1584 * c-file-style: "Stroustrup"
1585 * indent-tabs-mode: nil
1587 * vim: shiftwidth=4 tabstop=8 expandtab