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>
24 #include <metaproxy/package.hpp>
25 #include <metaproxy/util.hpp>
26 #include <metaproxy/xmlutil.hpp>
29 #include <libxslt/xsltutils.h>
30 #include <libxslt/transform.h>
32 #include <boost/thread/mutex.hpp>
33 #include <boost/thread/condition.hpp>
34 #include <yaz/ccl_xml.h>
36 #include <yaz/rpn2cql.h>
37 #include <yaz/rpn2solr.h>
38 #include <yaz/pquery.h>
40 #include <yaz/oid_db.h>
41 #include <yaz/diagbib1.h>
44 #include <yaz/querytowrbuf.h>
46 namespace mp = metaproxy_1;
47 namespace yf = mp::filter;
49 namespace metaproxy_1 {
51 struct Zoom::Searchable : boost::noncopyable {
52 std::string authentication;
58 std::string query_encoding;
60 std::string request_syntax;
61 std::string element_set;
62 std::string record_encoding;
63 std::string transform_xsl_fname;
64 std::string urlRecipe;
67 CCL_bibset ccl_bibset;
68 Searchable(CCL_bibset base);
71 class Zoom::Backend : boost::noncopyable {
73 friend class Frontend;
75 ZOOM_connection m_connection;
76 ZOOM_resultset m_resultset;
77 std::string m_frontend_database;
79 xsltStylesheetPtr xsp;
81 Backend(SearchablePtr sptr);
83 void connect(std::string zurl, int *error, const char **addinfo);
84 void search_pqf(const char *pqf, Odr_int *hits,
85 int *error, const char **addinfo);
86 void search_cql(const char *cql, Odr_int *hits,
87 int *error, const char **addinfo);
88 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
89 int *error, const char **addinfo);
90 void set_option(const char *name, const char *value);
91 const char *get_option(const char *name);
92 void get_zoom_error(int *error, const char **addinfo);
94 class Zoom::Frontend : boost::noncopyable {
99 yazpp_1::GDU m_init_gdu;
100 BackendPtr m_backend;
101 void handle_package(mp::Package &package);
102 void handle_search(mp::Package &package);
103 void handle_present(mp::Package &package);
104 BackendPtr get_backend_from_databases(std::string &database,
108 Z_Records *get_records(Odr_int start,
109 Odr_int number_to_present,
111 const char **addinfo,
112 Odr_int *number_of_records_returned,
113 ODR odr, BackendPtr b,
114 Odr_oid *preferredRecordSyntax,
115 const char *element_set_name);
117 Frontend(Impl *impl);
121 friend class Frontend;
125 void process(metaproxy_1::Package & package);
126 void configure(const xmlNode * ptr, bool test_only,
129 void configure_local_records(const xmlNode * ptr, bool test_only);
130 FrontendPtr get_frontend(mp::Package &package);
131 void release_frontend(mp::Package &package);
132 SearchablePtr parse_torus_record(const xmlNode *ptr);
133 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
134 std::map<mp::Session, FrontendPtr> m_clients;
135 boost::mutex m_mutex;
136 boost::condition m_cond_session_ready;
137 std::string torus_url;
138 std::map<std::string,std::string> fieldmap;
140 std::string file_path;
142 std::string element_transform;
143 std::string element_raw;
144 std::map<std::string,SearchablePtr> s_map;
149 // define Pimpl wrapper forwarding to Impl
151 yf::Zoom::Zoom() : m_p(new Impl)
156 { // must have a destructor because of boost::scoped_ptr
159 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
162 m_p->configure(xmlnode, test_only, path);
165 void yf::Zoom::process(mp::Package &package) const
167 m_p->process(package);
171 // define Implementation stuff
173 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
175 m_connection = ZOOM_connection_create(0);
180 yf::Zoom::Backend::~Backend()
183 xsltFreeStylesheet(xsp);
184 ZOOM_connection_destroy(m_connection);
185 ZOOM_resultset_destroy(m_resultset);
189 void yf::Zoom::Backend::get_zoom_error(int *error, const char **addinfo)
192 *error = ZOOM_connection_error(m_connection, &msg, addinfo);
195 if (*error >= ZOOM_ERROR_CONNECT)
197 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
198 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
205 void yf::Zoom::Backend::connect(std::string zurl,
206 int *error, const char **addinfo)
208 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
209 get_zoom_error(error, addinfo);
212 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
213 int *error, const char **addinfo)
215 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
216 get_zoom_error(error, addinfo);
218 *hits = ZOOM_resultset_size(m_resultset);
223 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
224 int *error, const char **addinfo)
226 ZOOM_query q = ZOOM_query_create();
228 ZOOM_query_cql(q, cql);
230 m_resultset = ZOOM_connection_search(m_connection, q);
231 ZOOM_query_destroy(q);
232 get_zoom_error(error, addinfo);
234 *hits = ZOOM_resultset_size(m_resultset);
239 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
241 int *error, const char **addinfo)
243 ZOOM_resultset_records(m_resultset, recs, start, number);
244 get_zoom_error(error, addinfo);
247 void yf::Zoom::Backend::set_option(const char *name, const char *value)
249 ZOOM_connection_option_set(m_connection, name, value);
251 ZOOM_resultset_option_set(m_resultset, name, value);
254 const char *yf::Zoom::Backend::get_option(const char *name)
256 return ZOOM_connection_option_get(m_connection, name);
259 yf::Zoom::Searchable::Searchable(CCL_bibset base)
262 use_turbomarc = true;
263 ccl_bibset = ccl_qual_dup(base);
266 yf::Zoom::Searchable::~Searchable()
268 ccl_qual_rm(&ccl_bibset);
271 yf::Zoom::Frontend::Frontend(Impl *impl) :
272 m_p(impl), m_is_virtual(false), m_in_use(true)
276 yf::Zoom::Frontend::~Frontend()
280 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
282 boost::mutex::scoped_lock lock(m_mutex);
284 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
288 it = m_clients.find(package.session());
289 if (it == m_clients.end())
292 if (!it->second->m_in_use)
294 it->second->m_in_use = true;
297 m_cond_session_ready.wait(lock);
299 FrontendPtr f(new Frontend(this));
300 m_clients[package.session()] = f;
305 void yf::Zoom::Impl::release_frontend(mp::Package &package)
307 boost::mutex::scoped_lock lock(m_mutex);
308 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
310 it = m_clients.find(package.session());
311 if (it != m_clients.end())
313 if (package.session().is_closed())
319 it->second->m_in_use = false;
321 m_cond_session_ready.notify_all();
325 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
327 bibset = ccl_qual_mk();
330 yf::Zoom::Impl::~Impl()
332 ccl_qual_rm(&bibset);
335 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
337 Zoom::SearchablePtr s(new Searchable(bibset));
339 for (ptr = ptr->children; ptr; ptr = ptr->next)
341 if (ptr->type != XML_ELEMENT_NODE)
343 if (!strcmp((const char *) ptr->name, "layer"))
345 else if (!strcmp((const char *) ptr->name,
348 s->authentication = mp::xml::get_text(ptr);
350 else if (!strcmp((const char *) ptr->name,
353 s->cfAuth = mp::xml::get_text(ptr);
355 else if (!strcmp((const char *) ptr->name,
358 s->cfProxy = mp::xml::get_text(ptr);
360 else if (!strcmp((const char *) ptr->name,
363 s->cfSubDb = mp::xml::get_text(ptr);
365 else if (!strcmp((const char *) ptr->name, "udb"))
367 s->udb = mp::xml::get_text(ptr);
369 else if (!strcmp((const char *) ptr->name, "zurl"))
371 s->target = mp::xml::get_text(ptr);
373 else if (!strcmp((const char *) ptr->name, "sru"))
375 s->sru = mp::xml::get_text(ptr);
377 else if (!strcmp((const char *) ptr->name,
380 s->query_encoding = mp::xml::get_text(ptr);
382 else if (!strcmp((const char *) ptr->name,
385 s->piggyback = mp::xml::get_bool(ptr, true);
387 else if (!strcmp((const char *) ptr->name,
390 s->request_syntax = mp::xml::get_text(ptr);
392 else if (!strcmp((const char *) ptr->name,
395 s->element_set = mp::xml::get_text(ptr);
397 else if (!strcmp((const char *) ptr->name,
400 s->record_encoding = mp::xml::get_text(ptr);
402 else if (!strcmp((const char *) ptr->name,
405 s->transform_xsl_fname = mp::xml::get_text(ptr);
407 else if (!strcmp((const char *) ptr->name,
410 s->urlRecipe = mp::xml::get_text(ptr);
412 else if (!strcmp((const char *) ptr->name,
415 ; // useTurboMarc is ignored
417 else if (!strncmp((const char *) ptr->name,
420 std::string value = mp::xml::get_text(ptr);
421 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
422 (const char *) ptr->name + 7);
428 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
430 while (ptr && ptr->type != XML_ELEMENT_NODE)
435 if (!strcmp((const char *) ptr->name, "records"))
437 for (ptr = ptr->children; ptr; ptr = ptr->next)
439 if (ptr->type != XML_ELEMENT_NODE)
441 if (!strcmp((const char *) ptr->name, "record"))
443 SearchablePtr s = parse_torus_record(ptr);
446 std::string udb = s->udb;
451 throw mp::filter::FilterException
452 ("No udb for local torus record");
458 throw mp::filter::FilterException
460 + std::string((const char *) ptr->name)
461 + " in zoom filter inside element "
468 throw mp::filter::FilterException
470 + std::string((const char *) ptr->name)
471 + " in zoom filter inside element <torus>");
476 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
482 if (path[strlen(path)-1] != '/')
485 for (ptr = ptr->children; ptr; ptr = ptr->next)
487 if (ptr->type != XML_ELEMENT_NODE)
489 else if (!strcmp((const char *) ptr->name, "torus"))
491 const struct _xmlAttr *attr;
492 for (attr = ptr->properties; attr; attr = attr->next)
494 if (!strcmp((const char *) attr->name, "url"))
495 torus_url = mp::xml::get_text(attr->children);
496 else if (!strcmp((const char *) attr->name, "xsldir"))
497 xsldir = mp::xml::get_text(attr->children);
498 else if (!strcmp((const char *) attr->name, "element_transform"))
499 element_transform = mp::xml::get_text(attr->children);
500 else if (!strcmp((const char *) attr->name, "element_raw"))
501 element_raw = mp::xml::get_text(attr->children);
503 throw mp::filter::FilterException(
504 "Bad attribute " + std::string((const char *)
507 configure_local_records(ptr->children, test_only);
509 else if (!strcmp((const char *) ptr->name, "cclmap"))
511 const char *addinfo = 0;
512 ccl_xml_config(bibset, ptr, &addinfo);
514 else if (!strcmp((const char *) ptr->name, "fieldmap"))
516 const struct _xmlAttr *attr;
517 std::string ccl_field;
518 std::string cql_field;
519 for (attr = ptr->properties; attr; attr = attr->next)
521 if (!strcmp((const char *) attr->name, "ccl"))
522 ccl_field = mp::xml::get_text(attr->children);
523 else if (!strcmp((const char *) attr->name, "cql"))
524 cql_field = mp::xml::get_text(attr->children);
526 throw mp::filter::FilterException(
527 "Bad attribute " + std::string((const char *)
530 if (cql_field.length())
531 fieldmap[cql_field] = ccl_field;
535 throw mp::filter::FilterException
537 + std::string((const char *) ptr->name)
538 + " in zoom filter");
543 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
544 std::string &database, int *error, char **addinfo, ODR odr)
546 std::list<BackendPtr>::const_iterator map_it;
547 if (m_backend && m_backend->m_frontend_database == database)
550 const char *sru_proxy = 0;
552 std::string torus_db;
553 size_t db_arg_pos = database.find(',');
554 if (db_arg_pos != std::string::npos)
556 torus_db = database.substr(0, db_arg_pos);
557 db_args = database.substr(db_arg_pos + 1);
564 std::map<std::string,SearchablePtr>::iterator it;
565 it = m_p->s_map.find(torus_db);
566 if (it != m_p->s_map.end())
570 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
573 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
574 *addinfo = odr_strdup(odr, database.c_str());
578 const xmlNode *ptr = xmlDocGetRootElement(doc);
580 { // presumably ptr is a records element node
581 // parse first record in document
582 for (ptr = ptr->children; ptr; ptr = ptr->next)
584 if (ptr->type == XML_ELEMENT_NODE
585 && !strcmp((const char *) ptr->name, "record"))
587 sptr = m_p->parse_torus_record(ptr);
597 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
598 *addinfo = odr_strdup(odr, database.c_str());
603 xsltStylesheetPtr xsp = 0;
604 if (sptr->transform_xsl_fname.length())
608 if (m_p->xsldir.length())
609 fname = m_p->xsldir + "/" + sptr->transform_xsl_fname;
611 fname = m_p->file_path + sptr->transform_xsl_fname;
612 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
615 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
616 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname.c_str()));
617 sprintf(*addinfo, "xmlParseFile failed. File %s", fname.c_str());
621 xsp = xsltParseStylesheetDoc(xsp_doc);
624 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
625 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
634 BackendPtr b(new Backend(sptr));
637 b->m_frontend_database = database;
638 std::string authentication = sptr->authentication;
640 b->set_option("timeout", "40");
642 if (sptr->query_encoding.length())
643 b->set_option("rpnCharset", sptr->query_encoding.c_str());
645 if (sptr->cfAuth.length())
648 b->set_option("user", sptr->cfAuth.c_str());
649 if (db_args.length() == 0)
651 if (authentication.length())
653 // no database (auth) args specified already.. and the
654 // Torus authentication has it.. Generate the args that CF
656 size_t found = authentication.find('/');
657 if (found != std::string::npos)
659 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
660 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
663 db_args += "user=" + mp::util::uri_encode(authentication);
665 if (sptr->cfProxy.length())
667 if (db_args.length())
669 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
672 if (sptr->cfSubDb.length())
674 if (db_args.length())
676 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
682 if (db_args.length())
684 // user has specified backend authentication
685 const char *param_user = 0;
686 const char *param_password = 0;
690 int no_parms = yaz_uri_to_array(db_args.c_str(),
691 odr, &names, &values);
692 for (i = 0; i < no_parms; i++)
694 const char *name = names[i];
695 const char *value = values[i];
696 if (!strcmp(name, "user"))
698 else if (!strcmp(name, "password"))
699 param_password = value;
700 else if (!strcmp(name, "proxy"))
705 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
706 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
707 sprintf(msg, "Bad database argument: %s", name);
712 if (param_user && param_password)
714 char *auth = (char*) odr_malloc(
715 odr, strlen(param_user) + strlen(param_password) + 2);
716 strcpy(auth, param_user);
718 strcat(auth, param_password);
719 b->set_option("user", auth);
721 db_args.clear(); // no arguments to be passed (non-CF)
725 // use authentication from Torus, if given
726 if (authentication.length())
727 b->set_option("user", authentication.c_str());
732 b->set_option("proxy", sru_proxy);
735 if (sptr->sru.length())
737 url = "http://" + sptr->target;
738 b->set_option("sru", sptr->sru.c_str());
744 if (db_args.length())
745 url += "," + db_args;
746 yaz_log(YLOG_LOG, "url=%s", url.c_str());
747 const char *addinfo_c = 0;
748 b->connect(url, error, &addinfo_c);
750 *addinfo = odr_strdup(odr, addinfo_c);
758 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
759 Odr_int number_to_present,
761 const char **addinfo,
762 Odr_int *number_of_records_returned,
765 Odr_oid *preferredRecordSyntax,
766 const char *element_set_name)
768 *number_of_records_returned = 0;
769 Z_Records *records = 0;
770 bool enable_pz2_retrieval = false; // whether target profile is used
771 bool enable_pz2_transform = false; // whether XSLT is used as well
772 bool assume_marc8_charset = false;
774 if (start < 0 || number_to_present <= 0)
777 if (number_to_present > 10000)
778 number_to_present = 10000;
780 ZOOM_record *recs = (ZOOM_record *)
781 odr_malloc(odr, number_to_present * sizeof(*recs));
783 char oid_name_str[OID_STR_MAX];
784 const char *syntax_name = 0;
786 if (preferredRecordSyntax &&
787 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
790 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
792 enable_pz2_retrieval = true;
793 enable_pz2_transform = true;
795 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
797 enable_pz2_retrieval = true;
801 if (enable_pz2_retrieval)
803 if (b->sptr->request_syntax.length())
805 syntax_name = b->sptr->request_syntax.c_str();
806 const Odr_oid *syntax_oid =
807 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
808 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
809 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
810 assume_marc8_charset = true;
813 else if (preferredRecordSyntax)
815 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
817 b->set_option("preferredRecordSyntax", syntax_name);
819 if (enable_pz2_retrieval)
821 element_set_name = 0;
822 if (b->sptr->element_set.length())
823 element_set_name = b->sptr->element_set.c_str();
826 b->set_option("elementSetName", element_set_name);
828 b->present(start, number_to_present, recs, error, addinfo);
833 for (i = 0; i < number_to_present; i++)
838 { // only return records if no error and at least one record
839 char *odr_database = odr_strdup(odr,
840 b->m_frontend_database.c_str());
841 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
842 odr_malloc(odr, sizeof(*npl));
843 *number_of_records_returned = i;
844 npl->num_records = i;
845 npl->records = (Z_NamePlusRecord **)
846 odr_malloc(odr, i * sizeof(*npl->records));
847 for (i = 0; i < number_to_present; i++)
849 Z_NamePlusRecord *npr = 0;
851 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
852 &addinfo, 0 /* diagset */);
856 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
859 else if (enable_pz2_retrieval)
861 char rec_type_str[100];
862 const char *record_encoding = 0;
864 if (b->sptr->record_encoding.length())
865 record_encoding = b->sptr->record_encoding.c_str();
866 else if (assume_marc8_charset)
867 record_encoding = "marc8";
869 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
872 strcat(rec_type_str, "; charset=");
873 strcat(rec_type_str, record_encoding);
877 xmlChar *xmlrec_buf = 0;
878 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
880 if (rec_buf && b->xsp && enable_pz2_transform)
882 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
886 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
889 xsltSaveResultToString(&xmlrec_buf, &rec_len,
891 rec_buf = (const char *) xmlrec_buf;
899 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
901 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
904 xmlNode *ptr = xmlDocGetRootElement(doc);
905 while (ptr && ptr->type != XML_ELEMENT_NODE)
908 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
909 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
915 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
916 rec_buf = (const char *) xmlrec_buf;
922 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
923 npr->databaseName = odr_database;
924 npr->which = Z_NamePlusRecord_databaseRecord;
925 npr->u.databaseRecord =
926 z_ext_record_xml(odr, rec_buf, rec_len);
930 npr = zget_surrogateDiagRec(
932 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
941 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
944 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
945 npr->databaseName = odr_database;
946 npr->which = Z_NamePlusRecord_databaseRecord;
947 npr->u.databaseRecord = ext;
951 npr = zget_surrogateDiagRec(
953 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
954 "ZOOM_record, type ext");
957 npl->records[i] = npr;
959 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
960 records->which = Z_Records_DBOSD;
961 records->u.databaseOrSurDiagnostics = npl;
966 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
969 struct cql_node *r = 0;
977 std::map<std::string,std::string>::const_iterator it;
978 it = fieldmap.find(cn->u.st.index);
979 if (it == fieldmap.end())
981 if (it->second.length())
982 cn->u.st.index = odr_strdup(odr, it->second.c_str());
988 r = convert_cql_fields(cn->u.boolean.left, odr);
990 r = convert_cql_fields(cn->u.boolean.right, odr);
993 r = convert_cql_fields(cn->u.sort.search, odr);
999 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1001 Z_GDU *gdu = package.request().get();
1002 Z_APDU *apdu_req = gdu->u.z3950;
1003 Z_APDU *apdu_res = 0;
1005 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1006 if (sr->num_databaseNames != 1)
1008 apdu_res = odr.create_searchResponse(
1009 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1010 package.response() = apdu_res;
1015 char *addinfo_s = 0;
1016 std::string db(sr->databaseNames[0]);
1017 BackendPtr b = get_backend_from_databases(db, &error, &addinfo_s, odr);
1021 odr.create_searchResponse(
1022 apdu_req, error, addinfo_s);
1023 package.response() = apdu_res;
1027 const char *addinfo_c = 0;
1028 b->set_option("setname", "default");
1031 Z_Query *query = sr->query;
1032 WRBUF ccl_wrbuf = 0;
1033 WRBUF pqf_wrbuf = 0;
1035 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1038 pqf_wrbuf = wrbuf_alloc();
1039 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1041 else if (query->which == Z_Query_type_2)
1044 ccl_wrbuf = wrbuf_alloc();
1045 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1046 query->u.type_2->len);
1048 else if (query->which == Z_Query_type_104 &&
1049 query->u.type_104->which == Z_External_CQL)
1052 const char *cql = query->u.type_104->u.cql;
1053 CQL_parser cp = cql_parser_create();
1054 int r = cql_parser_string(cp, cql);
1057 cql_parser_destroy(cp);
1059 odr.create_searchResponse(apdu_req,
1060 YAZ_BIB1_MALFORMED_QUERY,
1061 "CQL syntax error");
1062 package.response() = apdu_res;
1065 struct cql_node *cn = cql_parser_result(cp);
1066 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1069 // hopefully we are getting a ptr to a index+relation+term node
1071 if (cn_error->which == CQL_NODE_ST)
1072 addinfo_c = cn_error->u.st.index;
1075 odr.create_searchResponse(apdu_req,
1076 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1078 package.response() = apdu_res;
1083 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1086 ccl_wrbuf = wrbuf_alloc();
1087 wrbuf_puts(ccl_wrbuf, ccl_buf);
1089 cql_parser_destroy(cp);
1093 odr.create_searchResponse(apdu_req,
1094 YAZ_BIB1_MALFORMED_QUERY,
1095 "CQL to CCL conversion error");
1096 package.response() = apdu_res;
1103 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1104 package.response() = apdu_res;
1111 assert(pqf_wrbuf == 0);
1113 struct ccl_rpn_node *cn;
1114 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1115 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1117 wrbuf_destroy(ccl_wrbuf);
1120 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1121 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1125 case CCL_ERR_UNKNOWN_QUAL:
1126 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1128 case CCL_ERR_TRUNC_NOT_LEFT:
1129 case CCL_ERR_TRUNC_NOT_RIGHT:
1130 case CCL_ERR_TRUNC_NOT_BOTH:
1131 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1135 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1136 package.response() = apdu_res;
1139 pqf_wrbuf = wrbuf_alloc();
1140 ccl_pquery(pqf_wrbuf, cn);
1145 if (b->get_option("sru"))
1149 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1150 WRBUF wrb = wrbuf_alloc();
1152 if (!strcmp(b->get_option("sru"), "solr"))
1154 solr_transform_t cqlt = solr_transform_create();
1156 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1158 solr_transform_close(cqlt);
1162 cql_transform_t cqlt = cql_transform_create();
1164 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1166 cql_transform_close(cqlt);
1170 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1171 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo_c);
1175 wrbuf_destroy(pqf_wrbuf);
1179 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1180 "can not convert from RPN to CQL/SOLR");
1181 package.response() = apdu_res;
1187 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1188 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo_c);
1189 wrbuf_destroy(pqf_wrbuf);
1193 const char *element_set_name = 0;
1194 Odr_int number_to_present = 0;
1196 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1198 Odr_int number_of_records_returned = 0;
1199 Z_Records *records = get_records(
1200 0, number_to_present, &error, &addinfo_c,
1201 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1203 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo_c);
1206 apdu_res->u.searchResponse->records = records;
1207 apdu_res->u.searchResponse->numberOfRecordsReturned =
1208 odr_intdup(odr, number_of_records_returned);
1210 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1211 package.response() = apdu_res;
1214 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1216 Z_GDU *gdu = package.request().get();
1217 Z_APDU *apdu_req = gdu->u.z3950;
1218 Z_APDU *apdu_res = 0;
1219 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1224 package.response() = odr.create_presentResponse(
1225 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1228 const char *element_set_name = 0;
1229 Z_RecordComposition *comp = pr->recordComposition;
1230 if (comp && comp->which != Z_RecordComp_simple)
1232 package.response() = odr.create_presentResponse(
1234 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1237 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1238 element_set_name = comp->u.simple->u.generic;
1239 Odr_int number_of_records_returned = 0;
1241 const char *addinfo = 0;
1242 Z_Records *records = get_records(
1243 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1244 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1245 pr->preferredRecordSyntax, element_set_name);
1247 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1250 apdu_res->u.presentResponse->records = records;
1251 apdu_res->u.presentResponse->numberOfRecordsReturned =
1252 odr_intdup(odr, number_of_records_returned);
1254 package.response() = apdu_res;
1257 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1259 Z_GDU *gdu = package.request().get();
1262 else if (gdu->which == Z_GDU_Z3950)
1264 Z_APDU *apdu_req = gdu->u.z3950;
1265 if (apdu_req->which == Z_APDU_initRequest)
1268 package.response() = odr.create_close(
1270 Z_Close_protocolError,
1273 else if (apdu_req->which == Z_APDU_searchRequest)
1275 handle_search(package);
1277 else if (apdu_req->which == Z_APDU_presentRequest)
1279 handle_present(package);
1284 package.response() = odr.create_close(
1286 Z_Close_protocolError,
1287 "zoom filter cannot handle this APDU");
1288 package.session().close();
1293 package.session().close();
1297 void yf::Zoom::Impl::process(mp::Package &package)
1299 FrontendPtr f = get_frontend(package);
1300 Z_GDU *gdu = package.request().get();
1302 if (f->m_is_virtual)
1304 f->handle_package(package);
1306 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1309 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1310 f->m_init_gdu = gdu;
1313 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1314 Z_InitResponse *resp = apdu->u.initResponse;
1317 static const int masks[] = {
1322 for (i = 0; masks[i] != -1; i++)
1323 if (ODR_MASK_GET(req->options, masks[i]))
1324 ODR_MASK_SET(resp->options, masks[i]);
1326 static const int versions[] = {
1327 Z_ProtocolVersion_1,
1328 Z_ProtocolVersion_2,
1329 Z_ProtocolVersion_3,
1332 for (i = 0; versions[i] != -1; i++)
1333 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1334 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1338 *resp->preferredMessageSize = *req->preferredMessageSize;
1339 *resp->maximumRecordSize = *req->maximumRecordSize;
1341 package.response() = apdu;
1342 f->m_is_virtual = true;
1347 release_frontend(package);
1351 static mp::filter::Base* filter_creator()
1353 return new mp::filter::Zoom;
1357 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1368 * c-file-style: "Stroustrup"
1369 * indent-tabs-mode: nil
1371 * vim: shiftwidth=4 tabstop=8 expandtab