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;
83 Backend(SearchablePtr sptr);
85 void connect(std::string zurl, int *error, char **addinfo,
87 void search_pqf(const char *pqf, Odr_int *hits,
88 int *error, char **addinfo, ODR odr);
89 void search_cql(const char *cql, Odr_int *hits,
90 int *error, char **addinfo, ODR odr);
91 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
92 int *error, char **addinfo, ODR odr);
93 void set_option(const char *name, const char *value);
94 const char *get_option(const char *name);
95 void get_zoom_error(int *error, char **addinfo, ODR odr);
97 class Zoom::Frontend : boost::noncopyable {
102 yazpp_1::GDU m_init_gdu;
103 BackendPtr m_backend;
104 void handle_package(mp::Package &package);
105 void handle_search(mp::Package &package);
106 void handle_present(mp::Package &package);
107 BackendPtr get_backend_from_databases(std::string &database,
111 Z_Records *get_records(Odr_int start,
112 Odr_int number_to_present,
115 Odr_int *number_of_records_returned,
116 ODR odr, BackendPtr b,
117 Odr_oid *preferredRecordSyntax,
118 const char *element_set_name);
120 Frontend(Impl *impl);
124 friend class Frontend;
128 void process(metaproxy_1::Package & package);
129 void configure(const xmlNode * ptr, bool test_only,
132 void configure_local_records(const xmlNode * ptr, bool test_only);
133 FrontendPtr get_frontend(mp::Package &package);
134 void release_frontend(mp::Package &package);
135 SearchablePtr parse_torus_record(const xmlNode *ptr);
136 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
137 std::map<mp::Session, FrontendPtr> m_clients;
138 boost::mutex m_mutex;
139 boost::condition m_cond_session_ready;
140 std::string torus_url;
141 std::map<std::string,std::string> fieldmap;
143 std::string file_path;
144 std::string content_proxy_server;
146 std::string element_transform;
147 std::string element_raw;
148 std::map<std::string,SearchablePtr> s_map;
153 // define Pimpl wrapper forwarding to Impl
155 yf::Zoom::Zoom() : m_p(new Impl)
160 { // must have a destructor because of boost::scoped_ptr
163 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
166 m_p->configure(xmlnode, test_only, path);
169 void yf::Zoom::process(mp::Package &package) const
171 m_p->process(package);
175 // define Implementation stuff
177 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
179 m_connection = ZOOM_connection_create(0);
184 yf::Zoom::Backend::~Backend()
187 xsltFreeStylesheet(xsp);
188 ZOOM_connection_destroy(m_connection);
189 ZOOM_resultset_destroy(m_resultset);
193 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
197 const char *zoom_addinfo = 0;
198 *error = ZOOM_connection_error(m_connection, &msg, &zoom_addinfo);
201 if (*error >= ZOOM_ERROR_CONNECT)
203 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
204 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
205 *addinfo = (char *) odr_malloc(
206 odr, 20 + strlen(msg) +
207 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
208 strcpy(*addinfo, msg);
211 strcat(*addinfo, ": ");
212 strcat(*addinfo, zoom_addinfo);
213 strcat(*addinfo, " ");
218 *addinfo = (char *) odr_malloc(
219 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
221 if (zoom_addinfo && *zoom_addinfo)
223 strcpy(*addinfo, zoom_addinfo);
224 strcat(*addinfo, " ");
226 strcat(*addinfo, "(backend)");
231 void yf::Zoom::Backend::connect(std::string zurl,
232 int *error, char **addinfo,
235 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
236 get_zoom_error(error, addinfo, odr);
239 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
240 int *error, char **addinfo, ODR odr)
242 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
243 get_zoom_error(error, addinfo, odr);
245 *hits = ZOOM_resultset_size(m_resultset);
250 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
251 int *error, char **addinfo, ODR odr)
253 ZOOM_query q = ZOOM_query_create();
255 ZOOM_query_cql(q, cql);
257 m_resultset = ZOOM_connection_search(m_connection, q);
258 ZOOM_query_destroy(q);
259 get_zoom_error(error, addinfo, odr);
261 *hits = ZOOM_resultset_size(m_resultset);
266 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
268 int *error, char **addinfo, ODR odr)
270 ZOOM_resultset_records(m_resultset, recs, start, number);
271 get_zoom_error(error, addinfo, odr);
274 void yf::Zoom::Backend::set_option(const char *name, const char *value)
276 ZOOM_connection_option_set(m_connection, name, value);
278 ZOOM_resultset_option_set(m_resultset, name, value);
281 const char *yf::Zoom::Backend::get_option(const char *name)
283 return ZOOM_connection_option_get(m_connection, name);
286 yf::Zoom::Searchable::Searchable(CCL_bibset base)
289 use_turbomarc = true;
290 ccl_bibset = ccl_qual_dup(base);
293 yf::Zoom::Searchable::~Searchable()
295 ccl_qual_rm(&ccl_bibset);
298 yf::Zoom::Frontend::Frontend(Impl *impl) :
299 m_p(impl), m_is_virtual(false), m_in_use(true)
303 yf::Zoom::Frontend::~Frontend()
307 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
309 boost::mutex::scoped_lock lock(m_mutex);
311 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
315 it = m_clients.find(package.session());
316 if (it == m_clients.end())
319 if (!it->second->m_in_use)
321 it->second->m_in_use = true;
324 m_cond_session_ready.wait(lock);
326 FrontendPtr f(new Frontend(this));
327 m_clients[package.session()] = f;
332 void yf::Zoom::Impl::release_frontend(mp::Package &package)
334 boost::mutex::scoped_lock lock(m_mutex);
335 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
337 it = m_clients.find(package.session());
338 if (it != m_clients.end())
340 if (package.session().is_closed())
346 it->second->m_in_use = false;
348 m_cond_session_ready.notify_all();
352 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
354 bibset = ccl_qual_mk();
357 yf::Zoom::Impl::~Impl()
359 ccl_qual_rm(&bibset);
362 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
364 Zoom::SearchablePtr s(new Searchable(bibset));
366 for (ptr = ptr->children; ptr; ptr = ptr->next)
368 if (ptr->type != XML_ELEMENT_NODE)
370 if (!strcmp((const char *) ptr->name, "layer"))
372 else if (!strcmp((const char *) ptr->name,
375 s->authentication = mp::xml::get_text(ptr);
377 else if (!strcmp((const char *) ptr->name,
380 s->cfAuth = mp::xml::get_text(ptr);
382 else if (!strcmp((const char *) ptr->name,
385 s->cfProxy = mp::xml::get_text(ptr);
387 else if (!strcmp((const char *) ptr->name,
390 s->cfSubDb = mp::xml::get_text(ptr);
392 else if (!strcmp((const char *) ptr->name,
395 s->contentConnector = mp::xml::get_text(ptr);
397 else if (!strcmp((const char *) ptr->name, "udb"))
399 s->udb = mp::xml::get_text(ptr);
401 else if (!strcmp((const char *) ptr->name, "zurl"))
403 s->target = mp::xml::get_text(ptr);
405 else if (!strcmp((const char *) ptr->name, "sru"))
407 s->sru = mp::xml::get_text(ptr);
409 else if (!strcmp((const char *) ptr->name,
412 s->query_encoding = mp::xml::get_text(ptr);
414 else if (!strcmp((const char *) ptr->name,
417 s->piggyback = mp::xml::get_bool(ptr, true);
419 else if (!strcmp((const char *) ptr->name,
422 s->request_syntax = mp::xml::get_text(ptr);
424 else if (!strcmp((const char *) ptr->name,
427 s->element_set = mp::xml::get_text(ptr);
429 else if (!strcmp((const char *) ptr->name,
432 s->record_encoding = mp::xml::get_text(ptr);
434 else if (!strcmp((const char *) ptr->name,
437 s->transform_xsl_fname = mp::xml::get_text(ptr);
439 else if (!strcmp((const char *) ptr->name,
442 s->urlRecipe = mp::xml::get_text(ptr);
444 else if (!strcmp((const char *) ptr->name,
447 ; // useTurboMarc is ignored
449 else if (!strncmp((const char *) ptr->name,
452 std::string value = mp::xml::get_text(ptr);
453 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
454 (const char *) ptr->name + 7);
460 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
462 while (ptr && ptr->type != XML_ELEMENT_NODE)
467 if (!strcmp((const char *) ptr->name, "records"))
469 for (ptr = ptr->children; ptr; ptr = ptr->next)
471 if (ptr->type != XML_ELEMENT_NODE)
473 if (!strcmp((const char *) ptr->name, "record"))
475 SearchablePtr s = parse_torus_record(ptr);
478 std::string udb = s->udb;
483 throw mp::filter::FilterException
484 ("No udb for local torus record");
490 throw mp::filter::FilterException
492 + std::string((const char *) ptr->name)
493 + " in zoom filter inside element "
500 throw mp::filter::FilterException
502 + std::string((const char *) ptr->name)
503 + " in zoom filter inside element <torus>");
508 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
515 for (ptr = ptr->children; ptr; ptr = ptr->next)
517 if (ptr->type != XML_ELEMENT_NODE)
519 else if (!strcmp((const char *) ptr->name, "torus"))
521 const struct _xmlAttr *attr;
522 for (attr = ptr->properties; attr; attr = attr->next)
524 if (!strcmp((const char *) attr->name, "url"))
525 torus_url = mp::xml::get_text(attr->children);
526 else if (!strcmp((const char *) attr->name, "xsldir"))
527 xsldir = mp::xml::get_text(attr->children);
528 else if (!strcmp((const char *) attr->name, "element_transform"))
529 element_transform = mp::xml::get_text(attr->children);
530 else if (!strcmp((const char *) attr->name, "element_raw"))
531 element_raw = mp::xml::get_text(attr->children);
533 throw mp::filter::FilterException(
534 "Bad attribute " + std::string((const char *)
537 configure_local_records(ptr->children, test_only);
539 else if (!strcmp((const char *) ptr->name, "cclmap"))
541 const char *addinfo = 0;
542 ccl_xml_config(bibset, ptr, &addinfo);
544 else if (!strcmp((const char *) ptr->name, "fieldmap"))
546 const struct _xmlAttr *attr;
547 std::string ccl_field;
548 std::string cql_field;
549 for (attr = ptr->properties; attr; attr = attr->next)
551 if (!strcmp((const char *) attr->name, "ccl"))
552 ccl_field = mp::xml::get_text(attr->children);
553 else if (!strcmp((const char *) attr->name, "cql"))
554 cql_field = mp::xml::get_text(attr->children);
556 throw mp::filter::FilterException(
557 "Bad attribute " + std::string((const char *)
560 if (cql_field.length())
561 fieldmap[cql_field] = ccl_field;
563 else if (!strcmp((const char *) ptr->name, "contentProxy"))
565 const struct _xmlAttr *attr;
566 for (attr = ptr->properties; attr; attr = attr->next)
568 if (!strcmp((const char *) attr->name, "server"))
569 content_proxy_server = mp::xml::get_text(attr->children);
571 throw mp::filter::FilterException(
572 "Bad attribute " + std::string((const char *)
578 throw mp::filter::FilterException
580 + std::string((const char *) ptr->name)
581 + " in zoom filter");
586 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
587 std::string &database, int *error, char **addinfo, ODR odr)
589 std::list<BackendPtr>::const_iterator map_it;
590 if (m_backend && m_backend->m_frontend_database == database)
593 const char *sru_proxy = 0;
595 std::string torus_db;
596 size_t db_arg_pos = database.find(',');
597 if (db_arg_pos != std::string::npos)
599 torus_db = database.substr(0, db_arg_pos);
600 db_args = database.substr(db_arg_pos + 1);
607 std::map<std::string,SearchablePtr>::iterator it;
608 it = m_p->s_map.find(torus_db);
609 if (it != m_p->s_map.end())
613 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
616 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
617 *addinfo = odr_strdup(odr, database.c_str());
621 const xmlNode *ptr = xmlDocGetRootElement(doc);
623 { // presumably ptr is a records element node
624 // parse first record in document
625 for (ptr = ptr->children; ptr; ptr = ptr->next)
627 if (ptr->type == XML_ELEMENT_NODE
628 && !strcmp((const char *) ptr->name, "record"))
630 sptr = m_p->parse_torus_record(ptr);
640 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
641 *addinfo = odr_strdup(odr, database.c_str());
646 xsltStylesheetPtr xsp = 0;
647 if (sptr->transform_xsl_fname.length())
649 const char *path = 0;
651 if (m_p->xsldir.length())
652 path = m_p->xsldir.c_str();
654 path = m_p->file_path.c_str();
658 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
664 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
666 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
667 sprintf(*addinfo, "File could not be read: %s",
668 sptr->transform_xsl_fname.c_str());
672 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
675 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
676 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
677 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
681 xsp = xsltParseStylesheetDoc(xsp_doc);
684 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
685 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
694 BackendPtr b(new Backend(sptr));
697 b->m_frontend_database = database;
698 std::string authentication = sptr->authentication;
700 b->set_option("timeout", "40");
702 if (sptr->query_encoding.length())
703 b->set_option("rpnCharset", sptr->query_encoding.c_str());
705 if (sptr->cfAuth.length())
708 b->set_option("user", sptr->cfAuth.c_str());
709 if (db_args.length() == 0)
711 if (authentication.length())
713 // no database (auth) args specified already.. and the
714 // Torus authentication has it.. Generate the args that CF
716 size_t found = authentication.find('/');
717 if (found != std::string::npos)
719 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
720 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
723 db_args += "user=" + mp::util::uri_encode(authentication);
725 if (sptr->cfProxy.length())
727 if (db_args.length())
729 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
732 if (sptr->cfSubDb.length())
734 if (db_args.length())
736 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
742 if (db_args.length())
744 // user has specified backend authentication
745 const char *param_user = 0;
746 const char *param_password = 0;
750 int no_parms = yaz_uri_to_array(db_args.c_str(),
751 odr, &names, &values);
752 for (i = 0; i < no_parms; i++)
754 const char *name = names[i];
755 const char *value = values[i];
756 if (!strcmp(name, "user"))
758 else if (!strcmp(name, "password"))
759 param_password = value;
760 else if (!strcmp(name, "proxy"))
765 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
766 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
767 sprintf(msg, "Bad database argument: %s", name);
772 if (param_user && param_password)
774 char *auth = (char*) odr_malloc(
775 odr, strlen(param_user) + strlen(param_password) + 2);
776 strcpy(auth, param_user);
778 strcat(auth, param_password);
779 b->set_option("user", auth);
781 db_args.clear(); // no arguments to be passed (non-CF)
785 // use authentication from Torus, if given
786 if (authentication.length())
787 b->set_option("user", authentication.c_str());
792 b->set_option("proxy", sru_proxy);
795 if (sptr->sru.length())
797 url = "http://" + sptr->target;
798 b->set_option("sru", sptr->sru.c_str());
804 if (db_args.length())
805 url += "," + db_args;
806 yaz_log(YLOG_LOG, "url=%s", url.c_str());
807 b->connect(url, error, addinfo, odr);
815 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
816 Odr_int number_to_present,
819 Odr_int *number_of_records_returned,
822 Odr_oid *preferredRecordSyntax,
823 const char *element_set_name)
825 *number_of_records_returned = 0;
826 Z_Records *records = 0;
827 bool enable_pz2_retrieval = false; // whether target profile is used
828 bool enable_pz2_transform = false; // whether XSLT is used as well
829 bool assume_marc8_charset = false;
831 if (start < 0 || number_to_present <= 0)
834 if (number_to_present > 10000)
835 number_to_present = 10000;
837 ZOOM_record *recs = (ZOOM_record *)
838 odr_malloc(odr, number_to_present * sizeof(*recs));
840 char oid_name_str[OID_STR_MAX];
841 const char *syntax_name = 0;
843 if (preferredRecordSyntax &&
844 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
847 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
849 enable_pz2_retrieval = true;
850 enable_pz2_transform = true;
852 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
854 enable_pz2_retrieval = true;
858 if (enable_pz2_retrieval)
860 if (b->sptr->request_syntax.length())
862 syntax_name = b->sptr->request_syntax.c_str();
863 const Odr_oid *syntax_oid =
864 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
865 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
866 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
867 assume_marc8_charset = true;
870 else if (preferredRecordSyntax)
872 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
874 b->set_option("preferredRecordSyntax", syntax_name);
876 if (enable_pz2_retrieval)
878 element_set_name = 0;
879 if (b->sptr->element_set.length())
880 element_set_name = b->sptr->element_set.c_str();
883 b->set_option("elementSetName", element_set_name);
885 b->present(start, number_to_present, recs, error, addinfo, odr);
890 for (i = 0; i < number_to_present; i++)
895 { // only return records if no error and at least one record
896 char *odr_database = odr_strdup(odr,
897 b->m_frontend_database.c_str());
898 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
899 odr_malloc(odr, sizeof(*npl));
900 *number_of_records_returned = i;
901 npl->num_records = i;
902 npl->records = (Z_NamePlusRecord **)
903 odr_malloc(odr, i * sizeof(*npl->records));
904 for (i = 0; i < number_to_present; i++)
906 Z_NamePlusRecord *npr = 0;
908 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
909 &addinfo, 0 /* diagset */);
913 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
916 else if (enable_pz2_retrieval)
918 char rec_type_str[100];
919 const char *record_encoding = 0;
921 if (b->sptr->record_encoding.length())
922 record_encoding = b->sptr->record_encoding.c_str();
923 else if (assume_marc8_charset)
924 record_encoding = "marc8";
926 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
929 strcat(rec_type_str, "; charset=");
930 strcat(rec_type_str, record_encoding);
934 xmlChar *xmlrec_buf = 0;
935 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
937 if (rec_buf && b->xsp && enable_pz2_transform)
939 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
943 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
946 xsltSaveResultToString(&xmlrec_buf, &rec_len,
948 rec_buf = (const char *) xmlrec_buf;
956 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
958 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
959 if (res.length() && b->sptr->contentConnector.length())
961 yaz_log(YLOG_LOG, "contentConnector: %s",
962 b->sptr->contentConnector.c_str());
963 size_t off = res.find_first_of("://");
964 if (off != std::string::npos)
968 sprintf(tmp, "%ld.%s/",
969 id, m_p->content_proxy_server.c_str());
970 res.insert(off + 3, tmp);
975 xmlNode *ptr = xmlDocGetRootElement(doc);
976 while (ptr && ptr->type != XML_ELEMENT_NODE)
979 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
980 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
986 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
987 rec_buf = (const char *) xmlrec_buf;
993 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
994 npr->databaseName = odr_database;
995 npr->which = Z_NamePlusRecord_databaseRecord;
996 npr->u.databaseRecord =
997 z_ext_record_xml(odr, rec_buf, rec_len);
1001 npr = zget_surrogateDiagRec(
1003 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1007 xmlFree(xmlrec_buf);
1012 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
1015 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
1016 npr->databaseName = odr_database;
1017 npr->which = Z_NamePlusRecord_databaseRecord;
1018 npr->u.databaseRecord = ext;
1022 npr = zget_surrogateDiagRec(
1024 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
1025 "ZOOM_record, type ext");
1028 npl->records[i] = npr;
1030 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
1031 records->which = Z_Records_DBOSD;
1032 records->u.databaseOrSurDiagnostics = npl;
1037 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1040 struct cql_node *r = 0;
1048 std::map<std::string,std::string>::const_iterator it;
1049 it = fieldmap.find(cn->u.st.index);
1050 if (it == fieldmap.end())
1052 if (it->second.length())
1053 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1059 r = convert_cql_fields(cn->u.boolean.left, odr);
1061 r = convert_cql_fields(cn->u.boolean.right, odr);
1064 r = convert_cql_fields(cn->u.sort.search, odr);
1070 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1072 Z_GDU *gdu = package.request().get();
1073 Z_APDU *apdu_req = gdu->u.z3950;
1074 Z_APDU *apdu_res = 0;
1076 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1077 if (sr->num_databaseNames != 1)
1079 apdu_res = odr.create_searchResponse(
1080 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1081 package.response() = apdu_res;
1087 std::string db(sr->databaseNames[0]);
1088 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1092 odr.create_searchResponse(apdu_req, error, addinfo);
1093 package.response() = apdu_res;
1097 b->set_option("setname", "default");
1100 Z_Query *query = sr->query;
1101 WRBUF ccl_wrbuf = 0;
1102 WRBUF pqf_wrbuf = 0;
1104 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1107 pqf_wrbuf = wrbuf_alloc();
1108 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1110 else if (query->which == Z_Query_type_2)
1113 ccl_wrbuf = wrbuf_alloc();
1114 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1115 query->u.type_2->len);
1117 else if (query->which == Z_Query_type_104 &&
1118 query->u.type_104->which == Z_External_CQL)
1121 const char *cql = query->u.type_104->u.cql;
1122 CQL_parser cp = cql_parser_create();
1123 int r = cql_parser_string(cp, cql);
1126 cql_parser_destroy(cp);
1128 odr.create_searchResponse(apdu_req,
1129 YAZ_BIB1_MALFORMED_QUERY,
1130 "CQL syntax error");
1131 package.response() = apdu_res;
1134 struct cql_node *cn = cql_parser_result(cp);
1135 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1138 // hopefully we are getting a ptr to a index+relation+term node
1140 if (cn_error->which == CQL_NODE_ST)
1141 addinfo = cn_error->u.st.index;
1144 odr.create_searchResponse(apdu_req,
1145 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1147 package.response() = apdu_res;
1152 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1155 ccl_wrbuf = wrbuf_alloc();
1156 wrbuf_puts(ccl_wrbuf, ccl_buf);
1158 cql_parser_destroy(cp);
1162 odr.create_searchResponse(apdu_req,
1163 YAZ_BIB1_MALFORMED_QUERY,
1164 "CQL to CCL conversion error");
1165 package.response() = apdu_res;
1172 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1173 package.response() = apdu_res;
1180 assert(pqf_wrbuf == 0);
1182 struct ccl_rpn_node *cn;
1183 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1184 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1186 wrbuf_destroy(ccl_wrbuf);
1189 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1190 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1194 case CCL_ERR_UNKNOWN_QUAL:
1195 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1197 case CCL_ERR_TRUNC_NOT_LEFT:
1198 case CCL_ERR_TRUNC_NOT_RIGHT:
1199 case CCL_ERR_TRUNC_NOT_BOTH:
1200 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1204 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1205 package.response() = apdu_res;
1208 pqf_wrbuf = wrbuf_alloc();
1209 ccl_pquery(pqf_wrbuf, cn);
1214 if (b->get_option("sru"))
1218 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1219 WRBUF wrb = wrbuf_alloc();
1221 if (!strcmp(b->get_option("sru"), "solr"))
1223 solr_transform_t cqlt = solr_transform_create();
1225 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1227 solr_transform_close(cqlt);
1231 cql_transform_t cqlt = cql_transform_create();
1233 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1235 cql_transform_close(cqlt);
1239 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1240 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1244 wrbuf_destroy(pqf_wrbuf);
1248 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1249 "can not convert from RPN to CQL/SOLR");
1250 package.response() = apdu_res;
1256 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1257 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1258 wrbuf_destroy(pqf_wrbuf);
1262 const char *element_set_name = 0;
1263 Odr_int number_to_present = 0;
1265 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1267 Odr_int number_of_records_returned = 0;
1268 Z_Records *records = get_records(
1269 0, number_to_present, &error, &addinfo,
1270 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1272 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1275 apdu_res->u.searchResponse->records = records;
1276 apdu_res->u.searchResponse->numberOfRecordsReturned =
1277 odr_intdup(odr, number_of_records_returned);
1279 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1280 package.response() = apdu_res;
1283 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1285 Z_GDU *gdu = package.request().get();
1286 Z_APDU *apdu_req = gdu->u.z3950;
1287 Z_APDU *apdu_res = 0;
1288 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1293 package.response() = odr.create_presentResponse(
1294 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1297 const char *element_set_name = 0;
1298 Z_RecordComposition *comp = pr->recordComposition;
1299 if (comp && comp->which != Z_RecordComp_simple)
1301 package.response() = odr.create_presentResponse(
1303 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1306 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1307 element_set_name = comp->u.simple->u.generic;
1308 Odr_int number_of_records_returned = 0;
1311 Z_Records *records = get_records(
1312 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1313 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1314 pr->preferredRecordSyntax, element_set_name);
1316 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1319 apdu_res->u.presentResponse->records = records;
1320 apdu_res->u.presentResponse->numberOfRecordsReturned =
1321 odr_intdup(odr, number_of_records_returned);
1323 package.response() = apdu_res;
1326 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1328 Z_GDU *gdu = package.request().get();
1331 else if (gdu->which == Z_GDU_Z3950)
1333 Z_APDU *apdu_req = gdu->u.z3950;
1334 if (apdu_req->which == Z_APDU_initRequest)
1337 package.response() = odr.create_close(
1339 Z_Close_protocolError,
1342 else if (apdu_req->which == Z_APDU_searchRequest)
1344 handle_search(package);
1346 else if (apdu_req->which == Z_APDU_presentRequest)
1348 handle_present(package);
1353 package.response() = odr.create_close(
1355 Z_Close_protocolError,
1356 "zoom filter cannot handle this APDU");
1357 package.session().close();
1362 package.session().close();
1366 void yf::Zoom::Impl::process(mp::Package &package)
1368 FrontendPtr f = get_frontend(package);
1369 Z_GDU *gdu = package.request().get();
1371 if (f->m_is_virtual)
1373 f->handle_package(package);
1375 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1378 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1379 f->m_init_gdu = gdu;
1382 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1383 Z_InitResponse *resp = apdu->u.initResponse;
1386 static const int masks[] = {
1391 for (i = 0; masks[i] != -1; i++)
1392 if (ODR_MASK_GET(req->options, masks[i]))
1393 ODR_MASK_SET(resp->options, masks[i]);
1395 static const int versions[] = {
1396 Z_ProtocolVersion_1,
1397 Z_ProtocolVersion_2,
1398 Z_ProtocolVersion_3,
1401 for (i = 0; versions[i] != -1; i++)
1402 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1403 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1407 *resp->preferredMessageSize = *req->preferredMessageSize;
1408 *resp->maximumRecordSize = *req->maximumRecordSize;
1410 package.response() = apdu;
1411 f->m_is_virtual = true;
1416 release_frontend(package);
1420 static mp::filter::Base* filter_creator()
1422 return new mp::filter::Zoom;
1426 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1437 * c-file-style: "Stroustrup"
1438 * indent-tabs-mode: nil
1440 * vim: shiftwidth=4 tabstop=8 expandtab