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>
28 #include <libxslt/xsltutils.h>
29 #include <libxslt/transform.h>
31 #include <boost/thread/mutex.hpp>
32 #include <boost/thread/condition.hpp>
33 #include <yaz/ccl_xml.h>
35 #include <yaz/rpn2cql.h>
36 #include <yaz/rpn2solr.h>
37 #include <yaz/pquery.h>
39 #include <yaz/oid_db.h>
40 #include <yaz/diagbib1.h>
43 #include <yaz/querytowrbuf.h>
45 namespace mp = metaproxy_1;
46 namespace yf = mp::filter;
48 namespace metaproxy_1 {
50 struct Zoom::Searchable : boost::noncopyable {
51 std::string authentication;
57 std::string query_encoding;
59 std::string request_syntax;
60 std::string element_set;
61 std::string record_encoding;
62 std::string transform_xsl_fname;
65 CCL_bibset ccl_bibset;
66 Searchable(CCL_bibset base);
69 class Zoom::Backend : boost::noncopyable {
71 friend class Frontend;
73 ZOOM_connection m_connection;
74 ZOOM_resultset m_resultset;
75 std::string m_frontend_database;
77 xsltStylesheetPtr xsp;
79 Backend(SearchablePtr sptr);
81 void connect(std::string zurl, int *error, const char **addinfo);
82 void search_pqf(const char *pqf, Odr_int *hits,
83 int *error, const char **addinfo);
84 void search_cql(const char *cql, Odr_int *hits,
85 int *error, const char **addinfo);
86 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
87 int *error, const char **addinfo);
88 void set_option(const char *name, const char *value);
89 const char *get_option(const char *name);
90 void get_zoom_error(int *error, const char **addinfo);
92 class Zoom::Frontend : boost::noncopyable {
97 yazpp_1::GDU m_init_gdu;
99 void handle_package(mp::Package &package);
100 void handle_search(mp::Package &package);
101 void handle_present(mp::Package &package);
102 BackendPtr get_backend_from_databases(std::string &database,
106 Z_Records *get_records(Odr_int start,
107 Odr_int number_to_present,
109 const char **addinfo,
110 Odr_int *number_of_records_returned,
111 ODR odr, BackendPtr b,
112 Odr_oid *preferredRecordSyntax,
113 const char *element_set_name);
115 Frontend(Impl *impl);
119 friend class Frontend;
123 void process(metaproxy_1::Package & package);
124 void configure(const xmlNode * ptr, bool test_only);
126 void configure_local_records(const xmlNode * ptr, bool test_only);
127 FrontendPtr get_frontend(mp::Package &package);
128 void release_frontend(mp::Package &package);
129 SearchablePtr parse_torus_record(const xmlNode *ptr);
130 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
131 std::map<mp::Session, FrontendPtr> m_clients;
132 boost::mutex m_mutex;
133 boost::condition m_cond_session_ready;
134 std::string torus_url;
135 std::map<std::string,std::string> fieldmap;
138 std::string element_transform;
139 std::string element_raw;
140 std::map<std::string,SearchablePtr> s_map;
145 // define Pimpl wrapper forwarding to Impl
147 yf::Zoom::Zoom() : m_p(new Impl)
152 { // must have a destructor because of boost::scoped_ptr
155 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only)
157 m_p->configure(xmlnode, test_only);
160 void yf::Zoom::process(mp::Package &package) const
162 m_p->process(package);
166 // define Implementation stuff
168 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
170 m_connection = ZOOM_connection_create(0);
175 yf::Zoom::Backend::~Backend()
178 xsltFreeStylesheet(xsp);
179 ZOOM_connection_destroy(m_connection);
180 ZOOM_resultset_destroy(m_resultset);
184 void yf::Zoom::Backend::get_zoom_error(int *error, const char **addinfo)
187 *error = ZOOM_connection_error(m_connection, &msg, addinfo);
190 if (*error >= ZOOM_ERROR_CONNECT)
192 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
193 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
200 void yf::Zoom::Backend::connect(std::string zurl,
201 int *error, const char **addinfo)
203 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
204 get_zoom_error(error, addinfo);
207 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
208 int *error, const char **addinfo)
210 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
211 get_zoom_error(error, addinfo);
213 *hits = ZOOM_resultset_size(m_resultset);
218 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
219 int *error, const char **addinfo)
221 ZOOM_query q = ZOOM_query_create();
223 ZOOM_query_cql(q, cql);
225 m_resultset = ZOOM_connection_search(m_connection, q);
226 ZOOM_query_destroy(q);
227 get_zoom_error(error, addinfo);
229 *hits = ZOOM_resultset_size(m_resultset);
234 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
236 int *error, const char **addinfo)
238 ZOOM_resultset_records(m_resultset, recs, start, number);
239 get_zoom_error(error, addinfo);
242 void yf::Zoom::Backend::set_option(const char *name, const char *value)
244 ZOOM_connection_option_set(m_connection, name, value);
246 ZOOM_resultset_option_set(m_resultset, name, value);
249 const char *yf::Zoom::Backend::get_option(const char *name)
251 return ZOOM_connection_option_get(m_connection, name);
254 yf::Zoom::Searchable::Searchable(CCL_bibset base)
257 use_turbomarc = true;
258 ccl_bibset = ccl_qual_dup(base);
261 yf::Zoom::Searchable::~Searchable()
263 ccl_qual_rm(&ccl_bibset);
266 yf::Zoom::Frontend::Frontend(Impl *impl) :
267 m_p(impl), m_is_virtual(false), m_in_use(true)
271 yf::Zoom::Frontend::~Frontend()
275 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
277 boost::mutex::scoped_lock lock(m_mutex);
279 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
283 it = m_clients.find(package.session());
284 if (it == m_clients.end())
287 if (!it->second->m_in_use)
289 it->second->m_in_use = true;
292 m_cond_session_ready.wait(lock);
294 FrontendPtr f(new Frontend(this));
295 m_clients[package.session()] = f;
300 void yf::Zoom::Impl::release_frontend(mp::Package &package)
302 boost::mutex::scoped_lock lock(m_mutex);
303 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
305 it = m_clients.find(package.session());
306 if (it != m_clients.end())
308 if (package.session().is_closed())
314 it->second->m_in_use = false;
316 m_cond_session_ready.notify_all();
320 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
322 bibset = ccl_qual_mk();
325 yf::Zoom::Impl::~Impl()
327 ccl_qual_rm(&bibset);
330 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
332 Zoom::SearchablePtr s(new Searchable(bibset));
334 for (ptr = ptr->children; ptr; ptr = ptr->next)
336 if (ptr->type != XML_ELEMENT_NODE)
338 if (!strcmp((const char *) ptr->name, "layer"))
340 else if (!strcmp((const char *) ptr->name,
343 s->authentication = mp::xml::get_text(ptr);
345 else if (!strcmp((const char *) ptr->name,
348 s->cfAuth = mp::xml::get_text(ptr);
350 else if (!strcmp((const char *) ptr->name,
353 s->cfProxy = mp::xml::get_text(ptr);
355 else if (!strcmp((const char *) ptr->name,
358 s->cfSubDb = mp::xml::get_text(ptr);
360 else if (!strcmp((const char *) ptr->name, "udb"))
362 s->udb = mp::xml::get_text(ptr);
364 else if (!strcmp((const char *) ptr->name, "zurl"))
366 s->target = mp::xml::get_text(ptr);
368 else if (!strcmp((const char *) ptr->name, "sru"))
370 s->sru = mp::xml::get_text(ptr);
372 else if (!strcmp((const char *) ptr->name,
375 s->query_encoding = mp::xml::get_text(ptr);
377 else if (!strcmp((const char *) ptr->name,
380 s->piggyback = mp::xml::get_bool(ptr, true);
382 else if (!strcmp((const char *) ptr->name,
385 s->request_syntax = mp::xml::get_text(ptr);
387 else if (!strcmp((const char *) ptr->name,
390 s->element_set = mp::xml::get_text(ptr);
392 else if (!strcmp((const char *) ptr->name,
395 s->record_encoding = mp::xml::get_text(ptr);
397 else if (!strcmp((const char *) ptr->name,
400 s->transform_xsl_fname = mp::xml::get_text(ptr);
402 else if (!strcmp((const char *) ptr->name,
405 ; // useTurboMarc is ignored
407 else if (!strncmp((const char *) ptr->name,
410 std::string value = mp::xml::get_text(ptr);
411 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
412 (const char *) ptr->name + 7);
418 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
420 while (ptr && ptr->type != XML_ELEMENT_NODE)
425 if (!strcmp((const char *) ptr->name, "records"))
427 for (ptr = ptr->children; ptr; ptr = ptr->next)
429 if (ptr->type != XML_ELEMENT_NODE)
431 if (!strcmp((const char *) ptr->name, "record"))
433 SearchablePtr s = parse_torus_record(ptr);
436 std::string udb = s->udb;
441 throw mp::filter::FilterException
442 ("No udb for local torus record");
448 throw mp::filter::FilterException
450 + std::string((const char *) ptr->name)
451 + " in zoom filter inside element "
458 throw mp::filter::FilterException
460 + std::string((const char *) ptr->name)
461 + " in zoom filter inside element <torus>");
466 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only)
468 for (ptr = ptr->children; ptr; ptr = ptr->next)
470 if (ptr->type != XML_ELEMENT_NODE)
472 else if (!strcmp((const char *) ptr->name, "torus"))
474 const struct _xmlAttr *attr;
475 for (attr = ptr->properties; attr; attr = attr->next)
477 if (!strcmp((const char *) attr->name, "url"))
478 torus_url = mp::xml::get_text(attr->children);
479 else if (!strcmp((const char *) attr->name, "xsldir"))
480 xsldir = mp::xml::get_text(attr->children);
481 else if (!strcmp((const char *) attr->name, "element_transform"))
482 element_transform = mp::xml::get_text(attr->children);
483 else if (!strcmp((const char *) attr->name, "element_raw"))
484 element_raw = mp::xml::get_text(attr->children);
486 throw mp::filter::FilterException(
487 "Bad attribute " + std::string((const char *)
490 configure_local_records(ptr->children, test_only);
492 else if (!strcmp((const char *) ptr->name, "cclmap"))
494 const char *addinfo = 0;
495 ccl_xml_config(bibset, ptr, &addinfo);
497 else if (!strcmp((const char *) ptr->name, "fieldmap"))
499 const struct _xmlAttr *attr;
500 std::string ccl_field;
501 std::string cql_field;
502 for (attr = ptr->properties; attr; attr = attr->next)
504 if (!strcmp((const char *) attr->name, "ccl"))
505 ccl_field = mp::xml::get_text(attr->children);
506 else if (!strcmp((const char *) attr->name, "cql"))
507 cql_field = mp::xml::get_text(attr->children);
509 throw mp::filter::FilterException(
510 "Bad attribute " + std::string((const char *)
513 if (cql_field.length())
514 fieldmap[cql_field] = ccl_field;
518 throw mp::filter::FilterException
520 + std::string((const char *) ptr->name)
521 + " in zoom filter");
526 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
527 std::string &database, int *error, char **addinfo, ODR odr)
529 std::list<BackendPtr>::const_iterator map_it;
530 if (m_backend && m_backend->m_frontend_database == database)
534 std::string torus_db;
535 size_t db_arg_pos = database.find(',');
536 if (db_arg_pos != std::string::npos)
538 torus_db = database.substr(0, db_arg_pos);
539 db_args = database.substr(db_arg_pos + 1);
546 std::map<std::string,SearchablePtr>::iterator it;
547 it = m_p->s_map.find(torus_db);
548 if (it != m_p->s_map.end())
552 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
555 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
556 *addinfo = odr_strdup(odr, database.c_str());
560 const xmlNode *ptr = xmlDocGetRootElement(doc);
562 { // presumably ptr is a records element node
563 // parse first record in document
564 for (ptr = ptr->children; ptr; ptr = ptr->next)
566 if (ptr->type == XML_ELEMENT_NODE
567 && !strcmp((const char *) ptr->name, "record"))
569 sptr = m_p->parse_torus_record(ptr);
579 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
580 *addinfo = odr_strdup(odr, database.c_str());
585 xsltStylesheetPtr xsp = 0;
586 if (sptr->transform_xsl_fname.length())
590 if (m_p->xsldir.length())
591 fname = m_p->xsldir + "/" + sptr->transform_xsl_fname;
593 fname = sptr->transform_xsl_fname;
594 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
597 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
598 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname.c_str()));
599 sprintf(*addinfo, "xmlParseFile failed. File %s", fname.c_str());
603 xsp = xsltParseStylesheetDoc(xsp_doc);
606 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
607 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
616 BackendPtr b(new Backend(sptr));
619 b->m_frontend_database = database;
620 std::string authentication = sptr->authentication;
622 b->set_option("timeout", "40");
624 if (sptr->query_encoding.length())
625 b->set_option("rpnCharset", sptr->query_encoding.c_str());
627 if (sptr->cfAuth.length())
630 b->set_option("user", sptr->cfAuth.c_str());
631 if (authentication.length() && db_args.length() == 0)
633 // no database (auth) args specified already.. and the
634 // Torus authentication has it.. Generate the args that CF
636 size_t found = authentication.find('/');
637 if (found != std::string::npos)
639 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
640 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
643 db_args += "user=" + mp::util::uri_encode(authentication);
649 if (db_args.length())
651 // user has specified backend authentication
652 const char *param_user = 0;
653 const char *param_password = 0;
657 int no_parms = yaz_uri_to_array(db_args.c_str(),
658 odr, &names, &values);
659 for (i = 0; i < no_parms; i++)
661 const char *name = names[i];
662 const char *value = values[i];
663 if (!strcmp(name, "user"))
665 else if (!strcmp(name, "password"))
666 param_password = value;
670 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
671 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
672 sprintf(msg, "Bad database argument: %s", name);
677 if (param_user && param_password)
679 char *auth = (char*) odr_malloc(
680 odr, strlen(param_user) + strlen(param_password) + 2);
681 strcpy(auth, param_user);
683 strcat(auth, param_password);
684 b->set_option("user", auth);
686 db_args.clear(); // no arguments to be passed (non-CF)
690 // use authentication from Torus, if given
691 if (authentication.length())
692 b->set_option("user", authentication.c_str());
695 if (sptr->cfProxy.length())
697 if (db_args.length())
699 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
701 if (sptr->cfSubDb.length())
703 if (db_args.length())
705 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
709 if (sptr->sru.length())
711 url = "http://" + sptr->target;
712 b->set_option("sru", sptr->sru.c_str());
718 if (db_args.length())
719 url += "," + db_args;
720 yaz_log(YLOG_LOG, "url=%s", url.c_str());
721 const char *addinfo_c = 0;
722 b->connect(url, error, &addinfo_c);
724 *addinfo = odr_strdup(odr, addinfo_c);
732 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
733 Odr_int number_to_present,
735 const char **addinfo,
736 Odr_int *number_of_records_returned,
739 Odr_oid *preferredRecordSyntax,
740 const char *element_set_name)
742 *number_of_records_returned = 0;
743 Z_Records *records = 0;
744 bool enable_pz2_retrieval = false; // whether target profile is used
745 bool enable_pz2_transform = false; // whether XSLT is used as well
746 bool assume_marc8_charset = false;
748 if (start < 0 || number_to_present <= 0)
751 if (number_to_present > 10000)
752 number_to_present = 10000;
754 ZOOM_record *recs = (ZOOM_record *)
755 odr_malloc(odr, number_to_present * sizeof(*recs));
757 char oid_name_str[OID_STR_MAX];
758 const char *syntax_name = 0;
760 if (preferredRecordSyntax &&
761 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
764 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
766 enable_pz2_retrieval = true;
767 enable_pz2_transform = true;
769 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
771 enable_pz2_retrieval = true;
775 if (enable_pz2_retrieval)
777 if (b->sptr->request_syntax.length())
779 syntax_name = b->sptr->request_syntax.c_str();
780 const Odr_oid *syntax_oid =
781 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
782 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
783 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
784 assume_marc8_charset = true;
787 else if (preferredRecordSyntax)
789 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
791 b->set_option("preferredRecordSyntax", syntax_name);
793 if (enable_pz2_retrieval)
795 element_set_name = 0;
796 if (b->sptr->element_set.length())
797 element_set_name = b->sptr->element_set.c_str();
800 b->set_option("elementSetName", element_set_name);
802 b->present(start, number_to_present, recs, error, addinfo);
807 for (i = 0; i < number_to_present; i++)
812 { // only return records if no error and at least one record
813 char *odr_database = odr_strdup(odr,
814 b->m_frontend_database.c_str());
815 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
816 odr_malloc(odr, sizeof(*npl));
817 *number_of_records_returned = i;
818 npl->num_records = i;
819 npl->records = (Z_NamePlusRecord **)
820 odr_malloc(odr, i * sizeof(*npl->records));
821 for (i = 0; i < number_to_present; i++)
823 Z_NamePlusRecord *npr = 0;
825 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
826 &addinfo, 0 /* diagset */);
830 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
833 else if (enable_pz2_retrieval)
835 char rec_type_str[100];
836 const char *record_encoding = 0;
838 if (b->sptr->record_encoding.length())
839 record_encoding = b->sptr->record_encoding.c_str();
840 else if (assume_marc8_charset)
841 record_encoding = "marc8";
843 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
846 strcat(rec_type_str, "; charset=");
847 strcat(rec_type_str, record_encoding);
851 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
853 if (rec_buf && b->xsp && enable_pz2_transform)
855 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
859 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
862 xsltSaveResultToString((xmlChar **) &rec_buf, &rec_len,
869 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
870 npr->databaseName = odr_database;
871 npr->which = Z_NamePlusRecord_databaseRecord;
872 npr->u.databaseRecord =
873 z_ext_record_xml(odr, rec_buf, rec_len);
877 npr = zget_surrogateDiagRec(
879 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
886 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
889 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
890 npr->databaseName = odr_database;
891 npr->which = Z_NamePlusRecord_databaseRecord;
892 npr->u.databaseRecord = ext;
896 npr = zget_surrogateDiagRec(
898 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
899 "ZOOM_record, type ext");
902 npl->records[i] = npr;
904 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
905 records->which = Z_Records_DBOSD;
906 records->u.databaseOrSurDiagnostics = npl;
911 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
914 struct cql_node *r = 0;
922 std::map<std::string,std::string>::const_iterator it;
923 it = fieldmap.find(cn->u.st.index);
924 if (it == fieldmap.end())
926 if (it->second.length())
927 cn->u.st.index = odr_strdup(odr, it->second.c_str());
933 r = convert_cql_fields(cn->u.boolean.left, odr);
935 r = convert_cql_fields(cn->u.boolean.right, odr);
938 r = convert_cql_fields(cn->u.sort.search, odr);
944 void yf::Zoom::Frontend::handle_search(mp::Package &package)
946 Z_GDU *gdu = package.request().get();
947 Z_APDU *apdu_req = gdu->u.z3950;
948 Z_APDU *apdu_res = 0;
950 Z_SearchRequest *sr = apdu_req->u.searchRequest;
951 if (sr->num_databaseNames != 1)
953 apdu_res = odr.create_searchResponse(
954 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
955 package.response() = apdu_res;
961 std::string db(sr->databaseNames[0]);
962 BackendPtr b = get_backend_from_databases(db, &error, &addinfo_s, odr);
966 odr.create_searchResponse(
967 apdu_req, error, addinfo_s);
968 package.response() = apdu_res;
972 const char *addinfo_c = 0;
973 b->set_option("setname", "default");
976 Z_Query *query = sr->query;
980 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
983 pqf_wrbuf = wrbuf_alloc();
984 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
986 else if (query->which == Z_Query_type_2)
989 ccl_wrbuf = wrbuf_alloc();
990 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
991 query->u.type_2->len);
993 else if (query->which == Z_Query_type_104 &&
994 query->u.type_104->which == Z_External_CQL)
997 const char *cql = query->u.type_104->u.cql;
998 CQL_parser cp = cql_parser_create();
999 int r = cql_parser_string(cp, cql);
1002 cql_parser_destroy(cp);
1004 odr.create_searchResponse(apdu_req,
1005 YAZ_BIB1_MALFORMED_QUERY,
1006 "CQL syntax error");
1007 package.response() = apdu_res;
1010 struct cql_node *cn = cql_parser_result(cp);
1011 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1014 // hopefully we are getting a ptr to a index+relation+term node
1016 if (cn_error->which == CQL_NODE_ST)
1017 addinfo_c = cn_error->u.st.index;
1020 odr.create_searchResponse(apdu_req,
1021 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1023 package.response() = apdu_res;
1028 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1031 ccl_wrbuf = wrbuf_alloc();
1032 wrbuf_puts(ccl_wrbuf, ccl_buf);
1034 cql_parser_destroy(cp);
1038 odr.create_searchResponse(apdu_req,
1039 YAZ_BIB1_MALFORMED_QUERY,
1040 "CQL to CCL conversion error");
1041 package.response() = apdu_res;
1048 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1049 package.response() = apdu_res;
1056 assert(pqf_wrbuf == 0);
1058 struct ccl_rpn_node *cn;
1059 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1060 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1062 wrbuf_destroy(ccl_wrbuf);
1065 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1066 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1070 case CCL_ERR_UNKNOWN_QUAL:
1071 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1073 case CCL_ERR_TRUNC_NOT_LEFT:
1074 case CCL_ERR_TRUNC_NOT_RIGHT:
1075 case CCL_ERR_TRUNC_NOT_BOTH:
1076 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1080 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1081 package.response() = apdu_res;
1084 pqf_wrbuf = wrbuf_alloc();
1085 ccl_pquery(pqf_wrbuf, cn);
1090 if (b->get_option("sru"))
1094 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1095 WRBUF wrb = wrbuf_alloc();
1097 if (!strcmp(b->get_option("sru"), "solr"))
1099 solr_transform_t cqlt = solr_transform_create();
1101 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1103 solr_transform_close(cqlt);
1107 cql_transform_t cqlt = cql_transform_create();
1109 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1111 cql_transform_close(cqlt);
1115 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1116 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo_c);
1120 wrbuf_destroy(pqf_wrbuf);
1124 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1125 "can not convert from RPN to CQL/SOLR");
1126 package.response() = apdu_res;
1132 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1133 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo_c);
1134 wrbuf_destroy(pqf_wrbuf);
1138 const char *element_set_name = 0;
1139 Odr_int number_to_present = 0;
1141 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1143 Odr_int number_of_records_returned = 0;
1144 Z_Records *records = get_records(
1145 0, number_to_present, &error, &addinfo_c,
1146 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1148 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo_c);
1151 apdu_res->u.searchResponse->records = records;
1152 apdu_res->u.searchResponse->numberOfRecordsReturned =
1153 odr_intdup(odr, number_of_records_returned);
1155 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1156 package.response() = apdu_res;
1159 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1161 Z_GDU *gdu = package.request().get();
1162 Z_APDU *apdu_req = gdu->u.z3950;
1163 Z_APDU *apdu_res = 0;
1164 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1169 package.response() = odr.create_presentResponse(
1170 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1173 const char *element_set_name = 0;
1174 Z_RecordComposition *comp = pr->recordComposition;
1175 if (comp && comp->which != Z_RecordComp_simple)
1177 package.response() = odr.create_presentResponse(
1179 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1182 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1183 element_set_name = comp->u.simple->u.generic;
1184 Odr_int number_of_records_returned = 0;
1186 const char *addinfo = 0;
1187 Z_Records *records = get_records(
1188 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1189 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1190 pr->preferredRecordSyntax, element_set_name);
1192 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1195 apdu_res->u.presentResponse->records = records;
1196 apdu_res->u.presentResponse->numberOfRecordsReturned =
1197 odr_intdup(odr, number_of_records_returned);
1199 package.response() = apdu_res;
1202 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1204 Z_GDU *gdu = package.request().get();
1207 else if (gdu->which == Z_GDU_Z3950)
1209 Z_APDU *apdu_req = gdu->u.z3950;
1210 if (apdu_req->which == Z_APDU_initRequest)
1213 package.response() = odr.create_close(
1215 Z_Close_protocolError,
1218 else if (apdu_req->which == Z_APDU_searchRequest)
1220 handle_search(package);
1222 else if (apdu_req->which == Z_APDU_presentRequest)
1224 handle_present(package);
1229 package.response() = odr.create_close(
1231 Z_Close_protocolError,
1232 "zoom filter cannot handle this APDU");
1233 package.session().close();
1238 package.session().close();
1242 void yf::Zoom::Impl::process(mp::Package &package)
1244 FrontendPtr f = get_frontend(package);
1245 Z_GDU *gdu = package.request().get();
1247 if (f->m_is_virtual)
1249 f->handle_package(package);
1251 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1254 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1255 f->m_init_gdu = gdu;
1258 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1259 Z_InitResponse *resp = apdu->u.initResponse;
1262 static const int masks[] = {
1267 for (i = 0; masks[i] != -1; i++)
1268 if (ODR_MASK_GET(req->options, masks[i]))
1269 ODR_MASK_SET(resp->options, masks[i]);
1271 static const int versions[] = {
1272 Z_ProtocolVersion_1,
1273 Z_ProtocolVersion_2,
1274 Z_ProtocolVersion_3,
1277 for (i = 0; versions[i] != -1; i++)
1278 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1279 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1283 *resp->preferredMessageSize = *req->preferredMessageSize;
1284 *resp->maximumRecordSize = *req->maximumRecordSize;
1286 package.response() = apdu;
1287 f->m_is_virtual = true;
1292 release_frontend(package);
1296 static mp::filter::Base* filter_creator()
1298 return new mp::filter::Zoom;
1302 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1313 * c-file-style: "Stroustrup"
1314 * indent-tabs-mode: nil
1316 * vim: shiftwidth=4 tabstop=8 expandtab