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);
128 void configure_local_records(const xmlNode * ptr, bool test_only);
129 FrontendPtr get_frontend(mp::Package &package);
130 void release_frontend(mp::Package &package);
131 SearchablePtr parse_torus_record(const xmlNode *ptr);
132 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
133 std::map<mp::Session, FrontendPtr> m_clients;
134 boost::mutex m_mutex;
135 boost::condition m_cond_session_ready;
136 std::string torus_url;
137 std::map<std::string,std::string> fieldmap;
140 std::string element_transform;
141 std::string element_raw;
142 std::map<std::string,SearchablePtr> s_map;
147 // define Pimpl wrapper forwarding to Impl
149 yf::Zoom::Zoom() : m_p(new Impl)
154 { // must have a destructor because of boost::scoped_ptr
157 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
159 m_p->configure(xmlnode, test_only);
162 void yf::Zoom::process(mp::Package &package) const
164 m_p->process(package);
168 // define Implementation stuff
170 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
172 m_connection = ZOOM_connection_create(0);
177 yf::Zoom::Backend::~Backend()
180 xsltFreeStylesheet(xsp);
181 ZOOM_connection_destroy(m_connection);
182 ZOOM_resultset_destroy(m_resultset);
186 void yf::Zoom::Backend::get_zoom_error(int *error, const char **addinfo)
189 *error = ZOOM_connection_error(m_connection, &msg, addinfo);
192 if (*error >= ZOOM_ERROR_CONNECT)
194 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
195 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
202 void yf::Zoom::Backend::connect(std::string zurl,
203 int *error, const char **addinfo)
205 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
206 get_zoom_error(error, addinfo);
209 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
210 int *error, const char **addinfo)
212 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
213 get_zoom_error(error, addinfo);
215 *hits = ZOOM_resultset_size(m_resultset);
220 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
221 int *error, const char **addinfo)
223 ZOOM_query q = ZOOM_query_create();
225 ZOOM_query_cql(q, cql);
227 m_resultset = ZOOM_connection_search(m_connection, q);
228 ZOOM_query_destroy(q);
229 get_zoom_error(error, addinfo);
231 *hits = ZOOM_resultset_size(m_resultset);
236 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
238 int *error, const char **addinfo)
240 ZOOM_resultset_records(m_resultset, recs, start, number);
241 get_zoom_error(error, addinfo);
244 void yf::Zoom::Backend::set_option(const char *name, const char *value)
246 ZOOM_connection_option_set(m_connection, name, value);
248 ZOOM_resultset_option_set(m_resultset, name, value);
251 const char *yf::Zoom::Backend::get_option(const char *name)
253 return ZOOM_connection_option_get(m_connection, name);
256 yf::Zoom::Searchable::Searchable(CCL_bibset base)
259 use_turbomarc = true;
260 ccl_bibset = ccl_qual_dup(base);
263 yf::Zoom::Searchable::~Searchable()
265 ccl_qual_rm(&ccl_bibset);
268 yf::Zoom::Frontend::Frontend(Impl *impl) :
269 m_p(impl), m_is_virtual(false), m_in_use(true)
273 yf::Zoom::Frontend::~Frontend()
277 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
279 boost::mutex::scoped_lock lock(m_mutex);
281 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
285 it = m_clients.find(package.session());
286 if (it == m_clients.end())
289 if (!it->second->m_in_use)
291 it->second->m_in_use = true;
294 m_cond_session_ready.wait(lock);
296 FrontendPtr f(new Frontend(this));
297 m_clients[package.session()] = f;
302 void yf::Zoom::Impl::release_frontend(mp::Package &package)
304 boost::mutex::scoped_lock lock(m_mutex);
305 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
307 it = m_clients.find(package.session());
308 if (it != m_clients.end())
310 if (package.session().is_closed())
316 it->second->m_in_use = false;
318 m_cond_session_ready.notify_all();
322 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
324 bibset = ccl_qual_mk();
327 yf::Zoom::Impl::~Impl()
329 ccl_qual_rm(&bibset);
332 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
334 Zoom::SearchablePtr s(new Searchable(bibset));
336 for (ptr = ptr->children; ptr; ptr = ptr->next)
338 if (ptr->type != XML_ELEMENT_NODE)
340 if (!strcmp((const char *) ptr->name, "layer"))
342 else if (!strcmp((const char *) ptr->name,
345 s->authentication = mp::xml::get_text(ptr);
347 else if (!strcmp((const char *) ptr->name,
350 s->cfAuth = mp::xml::get_text(ptr);
352 else if (!strcmp((const char *) ptr->name,
355 s->cfProxy = mp::xml::get_text(ptr);
357 else if (!strcmp((const char *) ptr->name,
360 s->cfSubDb = mp::xml::get_text(ptr);
362 else if (!strcmp((const char *) ptr->name, "udb"))
364 s->udb = mp::xml::get_text(ptr);
366 else if (!strcmp((const char *) ptr->name, "zurl"))
368 s->target = mp::xml::get_text(ptr);
370 else if (!strcmp((const char *) ptr->name, "sru"))
372 s->sru = mp::xml::get_text(ptr);
374 else if (!strcmp((const char *) ptr->name,
377 s->query_encoding = mp::xml::get_text(ptr);
379 else if (!strcmp((const char *) ptr->name,
382 s->piggyback = mp::xml::get_bool(ptr, true);
384 else if (!strcmp((const char *) ptr->name,
387 s->request_syntax = mp::xml::get_text(ptr);
389 else if (!strcmp((const char *) ptr->name,
392 s->element_set = mp::xml::get_text(ptr);
394 else if (!strcmp((const char *) ptr->name,
397 s->record_encoding = mp::xml::get_text(ptr);
399 else if (!strcmp((const char *) ptr->name,
402 s->transform_xsl_fname = mp::xml::get_text(ptr);
404 else if (!strcmp((const char *) ptr->name,
407 s->urlRecipe = mp::xml::get_text(ptr);
409 else if (!strcmp((const char *) ptr->name,
412 ; // useTurboMarc is ignored
414 else if (!strncmp((const char *) ptr->name,
417 std::string value = mp::xml::get_text(ptr);
418 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
419 (const char *) ptr->name + 7);
425 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
427 while (ptr && ptr->type != XML_ELEMENT_NODE)
432 if (!strcmp((const char *) ptr->name, "records"))
434 for (ptr = ptr->children; ptr; ptr = ptr->next)
436 if (ptr->type != XML_ELEMENT_NODE)
438 if (!strcmp((const char *) ptr->name, "record"))
440 SearchablePtr s = parse_torus_record(ptr);
443 std::string udb = s->udb;
448 throw mp::filter::FilterException
449 ("No udb for local torus record");
455 throw mp::filter::FilterException
457 + std::string((const char *) ptr->name)
458 + " in zoom filter inside element "
465 throw mp::filter::FilterException
467 + std::string((const char *) ptr->name)
468 + " in zoom filter inside element <torus>");
473 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
475 for (ptr = ptr->children; ptr; ptr = ptr->next)
477 if (ptr->type != XML_ELEMENT_NODE)
479 else if (!strcmp((const char *) ptr->name, "torus"))
481 const struct _xmlAttr *attr;
482 for (attr = ptr->properties; attr; attr = attr->next)
484 if (!strcmp((const char *) attr->name, "url"))
485 torus_url = mp::xml::get_text(attr->children);
486 else if (!strcmp((const char *) attr->name, "xsldir"))
487 xsldir = mp::xml::get_text(attr->children);
488 else if (!strcmp((const char *) attr->name, "element_transform"))
489 element_transform = mp::xml::get_text(attr->children);
490 else if (!strcmp((const char *) attr->name, "element_raw"))
491 element_raw = mp::xml::get_text(attr->children);
493 throw mp::filter::FilterException(
494 "Bad attribute " + std::string((const char *)
497 configure_local_records(ptr->children, test_only);
499 else if (!strcmp((const char *) ptr->name, "cclmap"))
501 const char *addinfo = 0;
502 ccl_xml_config(bibset, ptr, &addinfo);
504 else if (!strcmp((const char *) ptr->name, "fieldmap"))
506 const struct _xmlAttr *attr;
507 std::string ccl_field;
508 std::string cql_field;
509 for (attr = ptr->properties; attr; attr = attr->next)
511 if (!strcmp((const char *) attr->name, "ccl"))
512 ccl_field = mp::xml::get_text(attr->children);
513 else if (!strcmp((const char *) attr->name, "cql"))
514 cql_field = mp::xml::get_text(attr->children);
516 throw mp::filter::FilterException(
517 "Bad attribute " + std::string((const char *)
520 if (cql_field.length())
521 fieldmap[cql_field] = ccl_field;
525 throw mp::filter::FilterException
527 + std::string((const char *) ptr->name)
528 + " in zoom filter");
533 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
534 std::string &database, int *error, char **addinfo, ODR odr)
536 std::list<BackendPtr>::const_iterator map_it;
537 if (m_backend && m_backend->m_frontend_database == database)
540 const char *sru_proxy = 0;
542 std::string torus_db;
543 size_t db_arg_pos = database.find(',');
544 if (db_arg_pos != std::string::npos)
546 torus_db = database.substr(0, db_arg_pos);
547 db_args = database.substr(db_arg_pos + 1);
554 std::map<std::string,SearchablePtr>::iterator it;
555 it = m_p->s_map.find(torus_db);
556 if (it != m_p->s_map.end())
560 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
563 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
564 *addinfo = odr_strdup(odr, database.c_str());
568 const xmlNode *ptr = xmlDocGetRootElement(doc);
570 { // presumably ptr is a records element node
571 // parse first record in document
572 for (ptr = ptr->children; ptr; ptr = ptr->next)
574 if (ptr->type == XML_ELEMENT_NODE
575 && !strcmp((const char *) ptr->name, "record"))
577 sptr = m_p->parse_torus_record(ptr);
587 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
588 *addinfo = odr_strdup(odr, database.c_str());
593 xsltStylesheetPtr xsp = 0;
594 if (sptr->transform_xsl_fname.length())
598 if (m_p->xsldir.length())
599 fname = m_p->xsldir + "/" + sptr->transform_xsl_fname;
601 fname = sptr->transform_xsl_fname;
602 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
605 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
606 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname.c_str()));
607 sprintf(*addinfo, "xmlParseFile failed. File %s", fname.c_str());
611 xsp = xsltParseStylesheetDoc(xsp_doc);
614 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
615 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
624 BackendPtr b(new Backend(sptr));
627 b->m_frontend_database = database;
628 std::string authentication = sptr->authentication;
630 b->set_option("timeout", "40");
632 if (sptr->query_encoding.length())
633 b->set_option("rpnCharset", sptr->query_encoding.c_str());
635 if (sptr->cfAuth.length())
638 b->set_option("user", sptr->cfAuth.c_str());
639 if (db_args.length() == 0)
641 if (authentication.length())
643 // no database (auth) args specified already.. and the
644 // Torus authentication has it.. Generate the args that CF
646 size_t found = authentication.find('/');
647 if (found != std::string::npos)
649 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
650 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
653 db_args += "user=" + mp::util::uri_encode(authentication);
655 if (sptr->cfProxy.length())
657 if (db_args.length())
659 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
662 if (sptr->cfSubDb.length())
664 if (db_args.length())
666 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
672 if (db_args.length())
674 // user has specified backend authentication
675 const char *param_user = 0;
676 const char *param_password = 0;
680 int no_parms = yaz_uri_to_array(db_args.c_str(),
681 odr, &names, &values);
682 for (i = 0; i < no_parms; i++)
684 const char *name = names[i];
685 const char *value = values[i];
686 if (!strcmp(name, "user"))
688 else if (!strcmp(name, "password"))
689 param_password = value;
690 else if (!strcmp(name, "proxy"))
695 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
696 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
697 sprintf(msg, "Bad database argument: %s", name);
702 if (param_user && param_password)
704 char *auth = (char*) odr_malloc(
705 odr, strlen(param_user) + strlen(param_password) + 2);
706 strcpy(auth, param_user);
708 strcat(auth, param_password);
709 b->set_option("user", auth);
711 db_args.clear(); // no arguments to be passed (non-CF)
715 // use authentication from Torus, if given
716 if (authentication.length())
717 b->set_option("user", authentication.c_str());
722 b->set_option("proxy", sru_proxy);
725 if (sptr->sru.length())
727 url = "http://" + sptr->target;
728 b->set_option("sru", sptr->sru.c_str());
734 if (db_args.length())
735 url += "," + db_args;
736 yaz_log(YLOG_LOG, "url=%s", url.c_str());
737 const char *addinfo_c = 0;
738 b->connect(url, error, &addinfo_c);
740 *addinfo = odr_strdup(odr, addinfo_c);
748 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
749 Odr_int number_to_present,
751 const char **addinfo,
752 Odr_int *number_of_records_returned,
755 Odr_oid *preferredRecordSyntax,
756 const char *element_set_name)
758 *number_of_records_returned = 0;
759 Z_Records *records = 0;
760 bool enable_pz2_retrieval = false; // whether target profile is used
761 bool enable_pz2_transform = false; // whether XSLT is used as well
762 bool assume_marc8_charset = false;
764 if (start < 0 || number_to_present <= 0)
767 if (number_to_present > 10000)
768 number_to_present = 10000;
770 ZOOM_record *recs = (ZOOM_record *)
771 odr_malloc(odr, number_to_present * sizeof(*recs));
773 char oid_name_str[OID_STR_MAX];
774 const char *syntax_name = 0;
776 if (preferredRecordSyntax &&
777 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
780 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
782 enable_pz2_retrieval = true;
783 enable_pz2_transform = true;
785 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
787 enable_pz2_retrieval = true;
791 if (enable_pz2_retrieval)
793 if (b->sptr->request_syntax.length())
795 syntax_name = b->sptr->request_syntax.c_str();
796 const Odr_oid *syntax_oid =
797 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
798 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
799 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
800 assume_marc8_charset = true;
803 else if (preferredRecordSyntax)
805 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
807 b->set_option("preferredRecordSyntax", syntax_name);
809 if (enable_pz2_retrieval)
811 element_set_name = 0;
812 if (b->sptr->element_set.length())
813 element_set_name = b->sptr->element_set.c_str();
816 b->set_option("elementSetName", element_set_name);
818 b->present(start, number_to_present, recs, error, addinfo);
823 for (i = 0; i < number_to_present; i++)
828 { // only return records if no error and at least one record
829 char *odr_database = odr_strdup(odr,
830 b->m_frontend_database.c_str());
831 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
832 odr_malloc(odr, sizeof(*npl));
833 *number_of_records_returned = i;
834 npl->num_records = i;
835 npl->records = (Z_NamePlusRecord **)
836 odr_malloc(odr, i * sizeof(*npl->records));
837 for (i = 0; i < number_to_present; i++)
839 Z_NamePlusRecord *npr = 0;
841 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
842 &addinfo, 0 /* diagset */);
846 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
849 else if (enable_pz2_retrieval)
851 char rec_type_str[100];
852 const char *record_encoding = 0;
854 if (b->sptr->record_encoding.length())
855 record_encoding = b->sptr->record_encoding.c_str();
856 else if (assume_marc8_charset)
857 record_encoding = "marc8";
859 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
862 strcat(rec_type_str, "; charset=");
863 strcat(rec_type_str, record_encoding);
867 xmlChar *xmlrec_buf = 0;
868 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
870 if (rec_buf && b->xsp && enable_pz2_transform)
872 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
876 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
879 xsltSaveResultToString(&xmlrec_buf, &rec_len,
881 rec_buf = (const char *) xmlrec_buf;
889 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
891 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
894 xmlNode *ptr = xmlDocGetRootElement(doc);
895 while (ptr && ptr->type != XML_ELEMENT_NODE)
898 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
899 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
905 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
906 rec_buf = (const char *) xmlrec_buf;
912 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
913 npr->databaseName = odr_database;
914 npr->which = Z_NamePlusRecord_databaseRecord;
915 npr->u.databaseRecord =
916 z_ext_record_xml(odr, rec_buf, rec_len);
920 npr = zget_surrogateDiagRec(
922 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
931 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
934 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
935 npr->databaseName = odr_database;
936 npr->which = Z_NamePlusRecord_databaseRecord;
937 npr->u.databaseRecord = ext;
941 npr = zget_surrogateDiagRec(
943 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
944 "ZOOM_record, type ext");
947 npl->records[i] = npr;
949 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
950 records->which = Z_Records_DBOSD;
951 records->u.databaseOrSurDiagnostics = npl;
956 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
959 struct cql_node *r = 0;
967 std::map<std::string,std::string>::const_iterator it;
968 it = fieldmap.find(cn->u.st.index);
969 if (it == fieldmap.end())
971 if (it->second.length())
972 cn->u.st.index = odr_strdup(odr, it->second.c_str());
978 r = convert_cql_fields(cn->u.boolean.left, odr);
980 r = convert_cql_fields(cn->u.boolean.right, odr);
983 r = convert_cql_fields(cn->u.sort.search, odr);
989 void yf::Zoom::Frontend::handle_search(mp::Package &package)
991 Z_GDU *gdu = package.request().get();
992 Z_APDU *apdu_req = gdu->u.z3950;
993 Z_APDU *apdu_res = 0;
995 Z_SearchRequest *sr = apdu_req->u.searchRequest;
996 if (sr->num_databaseNames != 1)
998 apdu_res = odr.create_searchResponse(
999 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1000 package.response() = apdu_res;
1005 char *addinfo_s = 0;
1006 std::string db(sr->databaseNames[0]);
1007 BackendPtr b = get_backend_from_databases(db, &error, &addinfo_s, odr);
1011 odr.create_searchResponse(
1012 apdu_req, error, addinfo_s);
1013 package.response() = apdu_res;
1017 const char *addinfo_c = 0;
1018 b->set_option("setname", "default");
1021 Z_Query *query = sr->query;
1022 WRBUF ccl_wrbuf = 0;
1023 WRBUF pqf_wrbuf = 0;
1025 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1028 pqf_wrbuf = wrbuf_alloc();
1029 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1031 else if (query->which == Z_Query_type_2)
1034 ccl_wrbuf = wrbuf_alloc();
1035 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1036 query->u.type_2->len);
1038 else if (query->which == Z_Query_type_104 &&
1039 query->u.type_104->which == Z_External_CQL)
1042 const char *cql = query->u.type_104->u.cql;
1043 CQL_parser cp = cql_parser_create();
1044 int r = cql_parser_string(cp, cql);
1047 cql_parser_destroy(cp);
1049 odr.create_searchResponse(apdu_req,
1050 YAZ_BIB1_MALFORMED_QUERY,
1051 "CQL syntax error");
1052 package.response() = apdu_res;
1055 struct cql_node *cn = cql_parser_result(cp);
1056 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1059 // hopefully we are getting a ptr to a index+relation+term node
1061 if (cn_error->which == CQL_NODE_ST)
1062 addinfo_c = cn_error->u.st.index;
1065 odr.create_searchResponse(apdu_req,
1066 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1068 package.response() = apdu_res;
1073 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1076 ccl_wrbuf = wrbuf_alloc();
1077 wrbuf_puts(ccl_wrbuf, ccl_buf);
1079 cql_parser_destroy(cp);
1083 odr.create_searchResponse(apdu_req,
1084 YAZ_BIB1_MALFORMED_QUERY,
1085 "CQL to CCL conversion error");
1086 package.response() = apdu_res;
1093 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1094 package.response() = apdu_res;
1101 assert(pqf_wrbuf == 0);
1103 struct ccl_rpn_node *cn;
1104 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1105 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1107 wrbuf_destroy(ccl_wrbuf);
1110 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1111 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1115 case CCL_ERR_UNKNOWN_QUAL:
1116 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1118 case CCL_ERR_TRUNC_NOT_LEFT:
1119 case CCL_ERR_TRUNC_NOT_RIGHT:
1120 case CCL_ERR_TRUNC_NOT_BOTH:
1121 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1125 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1126 package.response() = apdu_res;
1129 pqf_wrbuf = wrbuf_alloc();
1130 ccl_pquery(pqf_wrbuf, cn);
1135 if (b->get_option("sru"))
1139 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1140 WRBUF wrb = wrbuf_alloc();
1142 if (!strcmp(b->get_option("sru"), "solr"))
1144 solr_transform_t cqlt = solr_transform_create();
1146 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1148 solr_transform_close(cqlt);
1152 cql_transform_t cqlt = cql_transform_create();
1154 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1156 cql_transform_close(cqlt);
1160 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1161 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo_c);
1165 wrbuf_destroy(pqf_wrbuf);
1169 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1170 "can not convert from RPN to CQL/SOLR");
1171 package.response() = apdu_res;
1177 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1178 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo_c);
1179 wrbuf_destroy(pqf_wrbuf);
1183 const char *element_set_name = 0;
1184 Odr_int number_to_present = 0;
1186 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1188 Odr_int number_of_records_returned = 0;
1189 Z_Records *records = get_records(
1190 0, number_to_present, &error, &addinfo_c,
1191 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1193 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo_c);
1196 apdu_res->u.searchResponse->records = records;
1197 apdu_res->u.searchResponse->numberOfRecordsReturned =
1198 odr_intdup(odr, number_of_records_returned);
1200 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1201 package.response() = apdu_res;
1204 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1206 Z_GDU *gdu = package.request().get();
1207 Z_APDU *apdu_req = gdu->u.z3950;
1208 Z_APDU *apdu_res = 0;
1209 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1214 package.response() = odr.create_presentResponse(
1215 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1218 const char *element_set_name = 0;
1219 Z_RecordComposition *comp = pr->recordComposition;
1220 if (comp && comp->which != Z_RecordComp_simple)
1222 package.response() = odr.create_presentResponse(
1224 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1227 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1228 element_set_name = comp->u.simple->u.generic;
1229 Odr_int number_of_records_returned = 0;
1231 const char *addinfo = 0;
1232 Z_Records *records = get_records(
1233 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1234 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1235 pr->preferredRecordSyntax, element_set_name);
1237 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1240 apdu_res->u.presentResponse->records = records;
1241 apdu_res->u.presentResponse->numberOfRecordsReturned =
1242 odr_intdup(odr, number_of_records_returned);
1244 package.response() = apdu_res;
1247 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1249 Z_GDU *gdu = package.request().get();
1252 else if (gdu->which == Z_GDU_Z3950)
1254 Z_APDU *apdu_req = gdu->u.z3950;
1255 if (apdu_req->which == Z_APDU_initRequest)
1258 package.response() = odr.create_close(
1260 Z_Close_protocolError,
1263 else if (apdu_req->which == Z_APDU_searchRequest)
1265 handle_search(package);
1267 else if (apdu_req->which == Z_APDU_presentRequest)
1269 handle_present(package);
1274 package.response() = odr.create_close(
1276 Z_Close_protocolError,
1277 "zoom filter cannot handle this APDU");
1278 package.session().close();
1283 package.session().close();
1287 void yf::Zoom::Impl::process(mp::Package &package)
1289 FrontendPtr f = get_frontend(package);
1290 Z_GDU *gdu = package.request().get();
1292 if (f->m_is_virtual)
1294 f->handle_package(package);
1296 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1299 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1300 f->m_init_gdu = gdu;
1303 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1304 Z_InitResponse *resp = apdu->u.initResponse;
1307 static const int masks[] = {
1312 for (i = 0; masks[i] != -1; i++)
1313 if (ODR_MASK_GET(req->options, masks[i]))
1314 ODR_MASK_SET(resp->options, masks[i]);
1316 static const int versions[] = {
1317 Z_ProtocolVersion_1,
1318 Z_ProtocolVersion_2,
1319 Z_ProtocolVersion_3,
1322 for (i = 0; versions[i] != -1; i++)
1323 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1324 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1328 *resp->preferredMessageSize = *req->preferredMessageSize;
1329 *resp->maximumRecordSize = *req->maximumRecordSize;
1331 package.response() = apdu;
1332 f->m_is_virtual = true;
1337 release_frontend(package);
1341 static mp::filter::Base* filter_creator()
1343 return new mp::filter::Zoom;
1347 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1358 * c-file-style: "Stroustrup"
1359 * indent-tabs-mode: nil
1361 * vim: shiftwidth=4 tabstop=8 expandtab