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;
68 CCL_bibset ccl_bibset;
69 Searchable(CCL_bibset base);
72 class Zoom::Backend : boost::noncopyable {
74 friend class Frontend;
76 ZOOM_connection m_connection;
77 ZOOM_resultset m_resultset;
78 std::string m_frontend_database;
80 xsltStylesheetPtr xsp;
82 Backend(SearchablePtr sptr);
84 void connect(std::string zurl, int *error, char **addinfo,
86 void search_pqf(const char *pqf, Odr_int *hits,
87 int *error, char **addinfo, ODR odr);
88 void search_cql(const char *cql, Odr_int *hits,
89 int *error, char **addinfo, ODR odr);
90 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
91 int *error, char **addinfo, ODR odr);
92 void set_option(const char *name, const char *value);
93 const char *get_option(const char *name);
94 void get_zoom_error(int *error, char **addinfo, ODR odr);
96 class Zoom::Frontend : boost::noncopyable {
101 yazpp_1::GDU m_init_gdu;
102 BackendPtr m_backend;
103 void handle_package(mp::Package &package);
104 void handle_search(mp::Package &package);
105 void handle_present(mp::Package &package);
106 BackendPtr get_backend_from_databases(std::string &database,
110 Z_Records *get_records(Odr_int start,
111 Odr_int number_to_present,
114 Odr_int *number_of_records_returned,
115 ODR odr, BackendPtr b,
116 Odr_oid *preferredRecordSyntax,
117 const char *element_set_name);
119 Frontend(Impl *impl);
123 friend class Frontend;
127 void process(metaproxy_1::Package & package);
128 void configure(const xmlNode * ptr, bool test_only,
131 void configure_local_records(const xmlNode * ptr, bool test_only);
132 FrontendPtr get_frontend(mp::Package &package);
133 void release_frontend(mp::Package &package);
134 SearchablePtr parse_torus_record(const xmlNode *ptr);
135 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
136 std::map<mp::Session, FrontendPtr> m_clients;
137 boost::mutex m_mutex;
138 boost::condition m_cond_session_ready;
139 std::string torus_url;
140 std::map<std::string,std::string> fieldmap;
142 std::string file_path;
144 std::string element_transform;
145 std::string element_raw;
146 std::map<std::string,SearchablePtr> s_map;
151 // define Pimpl wrapper forwarding to Impl
153 yf::Zoom::Zoom() : m_p(new Impl)
158 { // must have a destructor because of boost::scoped_ptr
161 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
164 m_p->configure(xmlnode, test_only, path);
167 void yf::Zoom::process(mp::Package &package) const
169 m_p->process(package);
173 // define Implementation stuff
175 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
177 m_connection = ZOOM_connection_create(0);
182 yf::Zoom::Backend::~Backend()
185 xsltFreeStylesheet(xsp);
186 ZOOM_connection_destroy(m_connection);
187 ZOOM_resultset_destroy(m_resultset);
191 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
195 const char *zoom_addinfo = 0;
196 *error = ZOOM_connection_error(m_connection, &msg, &zoom_addinfo);
199 if (*error >= ZOOM_ERROR_CONNECT)
201 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
202 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
203 *addinfo = (char *) odr_malloc(
204 odr, 20 + strlen(msg) +
205 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
206 strcpy(*addinfo, msg);
209 strcat(*addinfo, ": ");
210 strcat(*addinfo, zoom_addinfo);
211 strcat(*addinfo, " ");
216 *addinfo = (char *) odr_malloc(
217 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
219 if (zoom_addinfo && *zoom_addinfo)
221 strcpy(*addinfo, zoom_addinfo);
222 strcat(*addinfo, " ");
224 strcat(*addinfo, "(backend)");
229 void yf::Zoom::Backend::connect(std::string zurl,
230 int *error, char **addinfo,
233 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
234 get_zoom_error(error, addinfo, odr);
237 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
238 int *error, char **addinfo, ODR odr)
240 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
241 get_zoom_error(error, addinfo, odr);
243 *hits = ZOOM_resultset_size(m_resultset);
248 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
249 int *error, char **addinfo, ODR odr)
251 ZOOM_query q = ZOOM_query_create();
253 ZOOM_query_cql(q, cql);
255 m_resultset = ZOOM_connection_search(m_connection, q);
256 ZOOM_query_destroy(q);
257 get_zoom_error(error, addinfo, odr);
259 *hits = ZOOM_resultset_size(m_resultset);
264 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
266 int *error, char **addinfo, ODR odr)
268 ZOOM_resultset_records(m_resultset, recs, start, number);
269 get_zoom_error(error, addinfo, odr);
272 void yf::Zoom::Backend::set_option(const char *name, const char *value)
274 ZOOM_connection_option_set(m_connection, name, value);
276 ZOOM_resultset_option_set(m_resultset, name, value);
279 const char *yf::Zoom::Backend::get_option(const char *name)
281 return ZOOM_connection_option_get(m_connection, name);
284 yf::Zoom::Searchable::Searchable(CCL_bibset base)
287 use_turbomarc = true;
288 ccl_bibset = ccl_qual_dup(base);
291 yf::Zoom::Searchable::~Searchable()
293 ccl_qual_rm(&ccl_bibset);
296 yf::Zoom::Frontend::Frontend(Impl *impl) :
297 m_p(impl), m_is_virtual(false), m_in_use(true)
301 yf::Zoom::Frontend::~Frontend()
305 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
307 boost::mutex::scoped_lock lock(m_mutex);
309 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
313 it = m_clients.find(package.session());
314 if (it == m_clients.end())
317 if (!it->second->m_in_use)
319 it->second->m_in_use = true;
322 m_cond_session_ready.wait(lock);
324 FrontendPtr f(new Frontend(this));
325 m_clients[package.session()] = f;
330 void yf::Zoom::Impl::release_frontend(mp::Package &package)
332 boost::mutex::scoped_lock lock(m_mutex);
333 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
335 it = m_clients.find(package.session());
336 if (it != m_clients.end())
338 if (package.session().is_closed())
344 it->second->m_in_use = false;
346 m_cond_session_ready.notify_all();
350 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
352 bibset = ccl_qual_mk();
355 yf::Zoom::Impl::~Impl()
357 ccl_qual_rm(&bibset);
360 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
362 Zoom::SearchablePtr s(new Searchable(bibset));
364 for (ptr = ptr->children; ptr; ptr = ptr->next)
366 if (ptr->type != XML_ELEMENT_NODE)
368 if (!strcmp((const char *) ptr->name, "layer"))
370 else if (!strcmp((const char *) ptr->name,
373 s->authentication = mp::xml::get_text(ptr);
375 else if (!strcmp((const char *) ptr->name,
378 s->cfAuth = mp::xml::get_text(ptr);
380 else if (!strcmp((const char *) ptr->name,
383 s->cfProxy = mp::xml::get_text(ptr);
385 else if (!strcmp((const char *) ptr->name,
388 s->cfSubDb = mp::xml::get_text(ptr);
390 else if (!strcmp((const char *) ptr->name, "udb"))
392 s->udb = mp::xml::get_text(ptr);
394 else if (!strcmp((const char *) ptr->name, "zurl"))
396 s->target = mp::xml::get_text(ptr);
398 else if (!strcmp((const char *) ptr->name, "sru"))
400 s->sru = mp::xml::get_text(ptr);
402 else if (!strcmp((const char *) ptr->name,
405 s->query_encoding = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name,
410 s->piggyback = mp::xml::get_bool(ptr, true);
412 else if (!strcmp((const char *) ptr->name,
415 s->request_syntax = mp::xml::get_text(ptr);
417 else if (!strcmp((const char *) ptr->name,
420 s->element_set = mp::xml::get_text(ptr);
422 else if (!strcmp((const char *) ptr->name,
425 s->record_encoding = mp::xml::get_text(ptr);
427 else if (!strcmp((const char *) ptr->name,
430 s->transform_xsl_fname = mp::xml::get_text(ptr);
432 else if (!strcmp((const char *) ptr->name,
435 s->urlRecipe = mp::xml::get_text(ptr);
437 else if (!strcmp((const char *) ptr->name,
440 ; // useTurboMarc is ignored
442 else if (!strncmp((const char *) ptr->name,
445 std::string value = mp::xml::get_text(ptr);
446 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
447 (const char *) ptr->name + 7);
453 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
455 while (ptr && ptr->type != XML_ELEMENT_NODE)
460 if (!strcmp((const char *) ptr->name, "records"))
462 for (ptr = ptr->children; ptr; ptr = ptr->next)
464 if (ptr->type != XML_ELEMENT_NODE)
466 if (!strcmp((const char *) ptr->name, "record"))
468 SearchablePtr s = parse_torus_record(ptr);
471 std::string udb = s->udb;
476 throw mp::filter::FilterException
477 ("No udb for local torus record");
483 throw mp::filter::FilterException
485 + std::string((const char *) ptr->name)
486 + " in zoom filter inside element "
493 throw mp::filter::FilterException
495 + std::string((const char *) ptr->name)
496 + " in zoom filter inside element <torus>");
501 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
508 for (ptr = ptr->children; ptr; ptr = ptr->next)
510 if (ptr->type != XML_ELEMENT_NODE)
512 else if (!strcmp((const char *) ptr->name, "torus"))
514 const struct _xmlAttr *attr;
515 for (attr = ptr->properties; attr; attr = attr->next)
517 if (!strcmp((const char *) attr->name, "url"))
518 torus_url = mp::xml::get_text(attr->children);
519 else if (!strcmp((const char *) attr->name, "xsldir"))
520 xsldir = mp::xml::get_text(attr->children);
521 else if (!strcmp((const char *) attr->name, "element_transform"))
522 element_transform = mp::xml::get_text(attr->children);
523 else if (!strcmp((const char *) attr->name, "element_raw"))
524 element_raw = mp::xml::get_text(attr->children);
526 throw mp::filter::FilterException(
527 "Bad attribute " + std::string((const char *)
530 configure_local_records(ptr->children, test_only);
532 else if (!strcmp((const char *) ptr->name, "cclmap"))
534 const char *addinfo = 0;
535 ccl_xml_config(bibset, ptr, &addinfo);
537 else if (!strcmp((const char *) ptr->name, "fieldmap"))
539 const struct _xmlAttr *attr;
540 std::string ccl_field;
541 std::string cql_field;
542 for (attr = ptr->properties; attr; attr = attr->next)
544 if (!strcmp((const char *) attr->name, "ccl"))
545 ccl_field = mp::xml::get_text(attr->children);
546 else if (!strcmp((const char *) attr->name, "cql"))
547 cql_field = mp::xml::get_text(attr->children);
549 throw mp::filter::FilterException(
550 "Bad attribute " + std::string((const char *)
553 if (cql_field.length())
554 fieldmap[cql_field] = ccl_field;
558 throw mp::filter::FilterException
560 + std::string((const char *) ptr->name)
561 + " in zoom filter");
566 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
567 std::string &database, int *error, char **addinfo, ODR odr)
569 std::list<BackendPtr>::const_iterator map_it;
570 if (m_backend && m_backend->m_frontend_database == database)
573 const char *sru_proxy = 0;
575 std::string torus_db;
576 size_t db_arg_pos = database.find(',');
577 if (db_arg_pos != std::string::npos)
579 torus_db = database.substr(0, db_arg_pos);
580 db_args = database.substr(db_arg_pos + 1);
587 std::map<std::string,SearchablePtr>::iterator it;
588 it = m_p->s_map.find(torus_db);
589 if (it != m_p->s_map.end())
593 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
596 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
597 *addinfo = odr_strdup(odr, database.c_str());
601 const xmlNode *ptr = xmlDocGetRootElement(doc);
603 { // presumably ptr is a records element node
604 // parse first record in document
605 for (ptr = ptr->children; ptr; ptr = ptr->next)
607 if (ptr->type == XML_ELEMENT_NODE
608 && !strcmp((const char *) ptr->name, "record"))
610 sptr = m_p->parse_torus_record(ptr);
620 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
621 *addinfo = odr_strdup(odr, database.c_str());
626 xsltStylesheetPtr xsp = 0;
627 if (sptr->transform_xsl_fname.length())
629 const char *path = 0;
631 if (m_p->xsldir.length())
632 path = m_p->xsldir.c_str();
634 path = m_p->file_path.c_str();
638 char *cp = yaz_filepath_resolve(sptr->transform_xsl_fname.c_str(),
644 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
646 odr_malloc(odr, 40 + sptr->transform_xsl_fname.length());
647 sprintf(*addinfo, "File could not be read: %s",
648 sptr->transform_xsl_fname.c_str());
652 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
655 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
656 *addinfo = (char *) odr_malloc(odr, 40 + fname.length());
657 sprintf(*addinfo, "xmlParseFile failed. File: %s", fname.c_str());
661 xsp = xsltParseStylesheetDoc(xsp_doc);
664 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
665 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
674 BackendPtr b(new Backend(sptr));
677 b->m_frontend_database = database;
678 std::string authentication = sptr->authentication;
680 b->set_option("timeout", "40");
682 if (sptr->query_encoding.length())
683 b->set_option("rpnCharset", sptr->query_encoding.c_str());
685 if (sptr->cfAuth.length())
688 b->set_option("user", sptr->cfAuth.c_str());
689 if (db_args.length() == 0)
691 if (authentication.length())
693 // no database (auth) args specified already.. and the
694 // Torus authentication has it.. Generate the args that CF
696 size_t found = authentication.find('/');
697 if (found != std::string::npos)
699 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
700 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
703 db_args += "user=" + mp::util::uri_encode(authentication);
705 if (sptr->cfProxy.length())
707 if (db_args.length())
709 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
712 if (sptr->cfSubDb.length())
714 if (db_args.length())
716 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
722 if (db_args.length())
724 // user has specified backend authentication
725 const char *param_user = 0;
726 const char *param_password = 0;
730 int no_parms = yaz_uri_to_array(db_args.c_str(),
731 odr, &names, &values);
732 for (i = 0; i < no_parms; i++)
734 const char *name = names[i];
735 const char *value = values[i];
736 if (!strcmp(name, "user"))
738 else if (!strcmp(name, "password"))
739 param_password = value;
740 else if (!strcmp(name, "proxy"))
745 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
746 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
747 sprintf(msg, "Bad database argument: %s", name);
752 if (param_user && param_password)
754 char *auth = (char*) odr_malloc(
755 odr, strlen(param_user) + strlen(param_password) + 2);
756 strcpy(auth, param_user);
758 strcat(auth, param_password);
759 b->set_option("user", auth);
761 db_args.clear(); // no arguments to be passed (non-CF)
765 // use authentication from Torus, if given
766 if (authentication.length())
767 b->set_option("user", authentication.c_str());
772 b->set_option("proxy", sru_proxy);
775 if (sptr->sru.length())
777 url = "http://" + sptr->target;
778 b->set_option("sru", sptr->sru.c_str());
784 if (db_args.length())
785 url += "," + db_args;
786 yaz_log(YLOG_LOG, "url=%s", url.c_str());
787 b->connect(url, error, addinfo, odr);
795 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
796 Odr_int number_to_present,
799 Odr_int *number_of_records_returned,
802 Odr_oid *preferredRecordSyntax,
803 const char *element_set_name)
805 *number_of_records_returned = 0;
806 Z_Records *records = 0;
807 bool enable_pz2_retrieval = false; // whether target profile is used
808 bool enable_pz2_transform = false; // whether XSLT is used as well
809 bool assume_marc8_charset = false;
811 if (start < 0 || number_to_present <= 0)
814 if (number_to_present > 10000)
815 number_to_present = 10000;
817 ZOOM_record *recs = (ZOOM_record *)
818 odr_malloc(odr, number_to_present * sizeof(*recs));
820 char oid_name_str[OID_STR_MAX];
821 const char *syntax_name = 0;
823 if (preferredRecordSyntax &&
824 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
827 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
829 enable_pz2_retrieval = true;
830 enable_pz2_transform = true;
832 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
834 enable_pz2_retrieval = true;
838 if (enable_pz2_retrieval)
840 if (b->sptr->request_syntax.length())
842 syntax_name = b->sptr->request_syntax.c_str();
843 const Odr_oid *syntax_oid =
844 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
845 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
846 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
847 assume_marc8_charset = true;
850 else if (preferredRecordSyntax)
852 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
854 b->set_option("preferredRecordSyntax", syntax_name);
856 if (enable_pz2_retrieval)
858 element_set_name = 0;
859 if (b->sptr->element_set.length())
860 element_set_name = b->sptr->element_set.c_str();
863 b->set_option("elementSetName", element_set_name);
865 b->present(start, number_to_present, recs, error, addinfo, odr);
870 for (i = 0; i < number_to_present; i++)
875 { // only return records if no error and at least one record
876 char *odr_database = odr_strdup(odr,
877 b->m_frontend_database.c_str());
878 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
879 odr_malloc(odr, sizeof(*npl));
880 *number_of_records_returned = i;
881 npl->num_records = i;
882 npl->records = (Z_NamePlusRecord **)
883 odr_malloc(odr, i * sizeof(*npl->records));
884 for (i = 0; i < number_to_present; i++)
886 Z_NamePlusRecord *npr = 0;
888 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
889 &addinfo, 0 /* diagset */);
893 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
896 else if (enable_pz2_retrieval)
898 char rec_type_str[100];
899 const char *record_encoding = 0;
901 if (b->sptr->record_encoding.length())
902 record_encoding = b->sptr->record_encoding.c_str();
903 else if (assume_marc8_charset)
904 record_encoding = "marc8";
906 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
909 strcat(rec_type_str, "; charset=");
910 strcat(rec_type_str, record_encoding);
914 xmlChar *xmlrec_buf = 0;
915 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
917 if (rec_buf && b->xsp && enable_pz2_transform)
919 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
923 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
926 xsltSaveResultToString(&xmlrec_buf, &rec_len,
928 rec_buf = (const char *) xmlrec_buf;
936 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
938 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
941 xmlNode *ptr = xmlDocGetRootElement(doc);
942 while (ptr && ptr->type != XML_ELEMENT_NODE)
945 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
946 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
952 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
953 rec_buf = (const char *) xmlrec_buf;
959 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
960 npr->databaseName = odr_database;
961 npr->which = Z_NamePlusRecord_databaseRecord;
962 npr->u.databaseRecord =
963 z_ext_record_xml(odr, rec_buf, rec_len);
967 npr = zget_surrogateDiagRec(
969 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
978 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
981 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
982 npr->databaseName = odr_database;
983 npr->which = Z_NamePlusRecord_databaseRecord;
984 npr->u.databaseRecord = ext;
988 npr = zget_surrogateDiagRec(
990 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
991 "ZOOM_record, type ext");
994 npl->records[i] = npr;
996 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
997 records->which = Z_Records_DBOSD;
998 records->u.databaseOrSurDiagnostics = npl;
1003 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
1006 struct cql_node *r = 0;
1014 std::map<std::string,std::string>::const_iterator it;
1015 it = fieldmap.find(cn->u.st.index);
1016 if (it == fieldmap.end())
1018 if (it->second.length())
1019 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1025 r = convert_cql_fields(cn->u.boolean.left, odr);
1027 r = convert_cql_fields(cn->u.boolean.right, odr);
1030 r = convert_cql_fields(cn->u.sort.search, odr);
1036 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1038 Z_GDU *gdu = package.request().get();
1039 Z_APDU *apdu_req = gdu->u.z3950;
1040 Z_APDU *apdu_res = 0;
1042 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1043 if (sr->num_databaseNames != 1)
1045 apdu_res = odr.create_searchResponse(
1046 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1047 package.response() = apdu_res;
1053 std::string db(sr->databaseNames[0]);
1054 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1058 odr.create_searchResponse(apdu_req, error, addinfo);
1059 package.response() = apdu_res;
1063 b->set_option("setname", "default");
1066 Z_Query *query = sr->query;
1067 WRBUF ccl_wrbuf = 0;
1068 WRBUF pqf_wrbuf = 0;
1070 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1073 pqf_wrbuf = wrbuf_alloc();
1074 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1076 else if (query->which == Z_Query_type_2)
1079 ccl_wrbuf = wrbuf_alloc();
1080 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1081 query->u.type_2->len);
1083 else if (query->which == Z_Query_type_104 &&
1084 query->u.type_104->which == Z_External_CQL)
1087 const char *cql = query->u.type_104->u.cql;
1088 CQL_parser cp = cql_parser_create();
1089 int r = cql_parser_string(cp, cql);
1092 cql_parser_destroy(cp);
1094 odr.create_searchResponse(apdu_req,
1095 YAZ_BIB1_MALFORMED_QUERY,
1096 "CQL syntax error");
1097 package.response() = apdu_res;
1100 struct cql_node *cn = cql_parser_result(cp);
1101 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1104 // hopefully we are getting a ptr to a index+relation+term node
1106 if (cn_error->which == CQL_NODE_ST)
1107 addinfo = cn_error->u.st.index;
1110 odr.create_searchResponse(apdu_req,
1111 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1113 package.response() = apdu_res;
1118 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1121 ccl_wrbuf = wrbuf_alloc();
1122 wrbuf_puts(ccl_wrbuf, ccl_buf);
1124 cql_parser_destroy(cp);
1128 odr.create_searchResponse(apdu_req,
1129 YAZ_BIB1_MALFORMED_QUERY,
1130 "CQL to CCL conversion error");
1131 package.response() = apdu_res;
1138 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1139 package.response() = apdu_res;
1146 assert(pqf_wrbuf == 0);
1148 struct ccl_rpn_node *cn;
1149 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1150 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1152 wrbuf_destroy(ccl_wrbuf);
1155 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1156 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1160 case CCL_ERR_UNKNOWN_QUAL:
1161 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1163 case CCL_ERR_TRUNC_NOT_LEFT:
1164 case CCL_ERR_TRUNC_NOT_RIGHT:
1165 case CCL_ERR_TRUNC_NOT_BOTH:
1166 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1170 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1171 package.response() = apdu_res;
1174 pqf_wrbuf = wrbuf_alloc();
1175 ccl_pquery(pqf_wrbuf, cn);
1180 if (b->get_option("sru"))
1184 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1185 WRBUF wrb = wrbuf_alloc();
1187 if (!strcmp(b->get_option("sru"), "solr"))
1189 solr_transform_t cqlt = solr_transform_create();
1191 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1193 solr_transform_close(cqlt);
1197 cql_transform_t cqlt = cql_transform_create();
1199 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1201 cql_transform_close(cqlt);
1205 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1206 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1210 wrbuf_destroy(pqf_wrbuf);
1214 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1215 "can not convert from RPN to CQL/SOLR");
1216 package.response() = apdu_res;
1222 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1223 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1224 wrbuf_destroy(pqf_wrbuf);
1228 const char *element_set_name = 0;
1229 Odr_int number_to_present = 0;
1231 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1233 Odr_int number_of_records_returned = 0;
1234 Z_Records *records = get_records(
1235 0, number_to_present, &error, &addinfo,
1236 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1238 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1241 apdu_res->u.searchResponse->records = records;
1242 apdu_res->u.searchResponse->numberOfRecordsReturned =
1243 odr_intdup(odr, number_of_records_returned);
1245 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1246 package.response() = apdu_res;
1249 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1251 Z_GDU *gdu = package.request().get();
1252 Z_APDU *apdu_req = gdu->u.z3950;
1253 Z_APDU *apdu_res = 0;
1254 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1259 package.response() = odr.create_presentResponse(
1260 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1263 const char *element_set_name = 0;
1264 Z_RecordComposition *comp = pr->recordComposition;
1265 if (comp && comp->which != Z_RecordComp_simple)
1267 package.response() = odr.create_presentResponse(
1269 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1272 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1273 element_set_name = comp->u.simple->u.generic;
1274 Odr_int number_of_records_returned = 0;
1277 Z_Records *records = get_records(
1278 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1279 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1280 pr->preferredRecordSyntax, element_set_name);
1282 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1285 apdu_res->u.presentResponse->records = records;
1286 apdu_res->u.presentResponse->numberOfRecordsReturned =
1287 odr_intdup(odr, number_of_records_returned);
1289 package.response() = apdu_res;
1292 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1294 Z_GDU *gdu = package.request().get();
1297 else if (gdu->which == Z_GDU_Z3950)
1299 Z_APDU *apdu_req = gdu->u.z3950;
1300 if (apdu_req->which == Z_APDU_initRequest)
1303 package.response() = odr.create_close(
1305 Z_Close_protocolError,
1308 else if (apdu_req->which == Z_APDU_searchRequest)
1310 handle_search(package);
1312 else if (apdu_req->which == Z_APDU_presentRequest)
1314 handle_present(package);
1319 package.response() = odr.create_close(
1321 Z_Close_protocolError,
1322 "zoom filter cannot handle this APDU");
1323 package.session().close();
1328 package.session().close();
1332 void yf::Zoom::Impl::process(mp::Package &package)
1334 FrontendPtr f = get_frontend(package);
1335 Z_GDU *gdu = package.request().get();
1337 if (f->m_is_virtual)
1339 f->handle_package(package);
1341 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1344 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1345 f->m_init_gdu = gdu;
1348 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1349 Z_InitResponse *resp = apdu->u.initResponse;
1352 static const int masks[] = {
1357 for (i = 0; masks[i] != -1; i++)
1358 if (ODR_MASK_GET(req->options, masks[i]))
1359 ODR_MASK_SET(resp->options, masks[i]);
1361 static const int versions[] = {
1362 Z_ProtocolVersion_1,
1363 Z_ProtocolVersion_2,
1364 Z_ProtocolVersion_3,
1367 for (i = 0; versions[i] != -1; i++)
1368 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1369 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1373 *resp->preferredMessageSize = *req->preferredMessageSize;
1374 *resp->maximumRecordSize = *req->maximumRecordSize;
1376 package.response() = apdu;
1377 f->m_is_virtual = true;
1382 release_frontend(package);
1386 static mp::filter::Base* filter_creator()
1388 return new mp::filter::Zoom;
1392 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1403 * c-file-style: "Stroustrup"
1404 * indent-tabs-mode: nil
1406 * vim: shiftwidth=4 tabstop=8 expandtab