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, char **addinfo,
85 void search_pqf(const char *pqf, Odr_int *hits,
86 int *error, char **addinfo, ODR odr);
87 void search_cql(const char *cql, Odr_int *hits,
88 int *error, char **addinfo, ODR odr);
89 void present(Odr_int start, Odr_int number, ZOOM_record *recs,
90 int *error, char **addinfo, ODR odr);
91 void set_option(const char *name, const char *value);
92 const char *get_option(const char *name);
93 void get_zoom_error(int *error, char **addinfo, ODR odr);
95 class Zoom::Frontend : boost::noncopyable {
100 yazpp_1::GDU m_init_gdu;
101 BackendPtr m_backend;
102 void handle_package(mp::Package &package);
103 void handle_search(mp::Package &package);
104 void handle_present(mp::Package &package);
105 BackendPtr get_backend_from_databases(std::string &database,
109 Z_Records *get_records(Odr_int start,
110 Odr_int number_to_present,
113 Odr_int *number_of_records_returned,
114 ODR odr, BackendPtr b,
115 Odr_oid *preferredRecordSyntax,
116 const char *element_set_name);
118 Frontend(Impl *impl);
122 friend class Frontend;
126 void process(metaproxy_1::Package & package);
127 void configure(const xmlNode * ptr, bool test_only,
130 void configure_local_records(const xmlNode * ptr, bool test_only);
131 FrontendPtr get_frontend(mp::Package &package);
132 void release_frontend(mp::Package &package);
133 SearchablePtr parse_torus_record(const xmlNode *ptr);
134 struct cql_node *convert_cql_fields(struct cql_node *cn, ODR odr);
135 std::map<mp::Session, FrontendPtr> m_clients;
136 boost::mutex m_mutex;
137 boost::condition m_cond_session_ready;
138 std::string torus_url;
139 std::map<std::string,std::string> fieldmap;
141 std::string file_path;
143 std::string element_transform;
144 std::string element_raw;
145 std::map<std::string,SearchablePtr> s_map;
150 // define Pimpl wrapper forwarding to Impl
152 yf::Zoom::Zoom() : m_p(new Impl)
157 { // must have a destructor because of boost::scoped_ptr
160 void yf::Zoom::configure(const xmlNode *xmlnode, bool test_only,
163 m_p->configure(xmlnode, test_only, path);
166 void yf::Zoom::process(mp::Package &package) const
168 m_p->process(package);
172 // define Implementation stuff
174 yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr)
176 m_connection = ZOOM_connection_create(0);
181 yf::Zoom::Backend::~Backend()
184 xsltFreeStylesheet(xsp);
185 ZOOM_connection_destroy(m_connection);
186 ZOOM_resultset_destroy(m_resultset);
190 void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo,
194 const char *zoom_addinfo = 0;
195 *error = ZOOM_connection_error(m_connection, &msg, &zoom_addinfo);
198 if (*error >= ZOOM_ERROR_CONNECT)
200 // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg
201 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
202 *addinfo = (char *) odr_malloc(
203 odr, 20 + strlen(msg) +
204 (zoom_addinfo ? strlen(zoom_addinfo) : 0));
205 strcpy(*addinfo, msg);
208 strcat(*addinfo, ": ");
209 strcat(*addinfo, zoom_addinfo);
210 strcat(*addinfo, " ");
215 *addinfo = (char *) odr_malloc(
216 odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0));
218 if (zoom_addinfo && *zoom_addinfo)
220 strcpy(*addinfo, zoom_addinfo);
221 strcat(*addinfo, " ");
223 strcat(*addinfo, "(backend)");
228 void yf::Zoom::Backend::connect(std::string zurl,
229 int *error, char **addinfo,
232 ZOOM_connection_connect(m_connection, zurl.c_str(), 0);
233 get_zoom_error(error, addinfo, odr);
236 void yf::Zoom::Backend::search_pqf(const char *pqf, Odr_int *hits,
237 int *error, char **addinfo, ODR odr)
239 m_resultset = ZOOM_connection_search_pqf(m_connection, pqf);
240 get_zoom_error(error, addinfo, odr);
242 *hits = ZOOM_resultset_size(m_resultset);
247 void yf::Zoom::Backend::search_cql(const char *cql, Odr_int *hits,
248 int *error, char **addinfo, ODR odr)
250 ZOOM_query q = ZOOM_query_create();
252 ZOOM_query_cql(q, cql);
254 m_resultset = ZOOM_connection_search(m_connection, q);
255 ZOOM_query_destroy(q);
256 get_zoom_error(error, addinfo, odr);
258 *hits = ZOOM_resultset_size(m_resultset);
263 void yf::Zoom::Backend::present(Odr_int start, Odr_int number,
265 int *error, char **addinfo, ODR odr)
267 ZOOM_resultset_records(m_resultset, recs, start, number);
268 get_zoom_error(error, addinfo, odr);
271 void yf::Zoom::Backend::set_option(const char *name, const char *value)
273 ZOOM_connection_option_set(m_connection, name, value);
275 ZOOM_resultset_option_set(m_resultset, name, value);
278 const char *yf::Zoom::Backend::get_option(const char *name)
280 return ZOOM_connection_option_get(m_connection, name);
283 yf::Zoom::Searchable::Searchable(CCL_bibset base)
286 use_turbomarc = true;
287 ccl_bibset = ccl_qual_dup(base);
290 yf::Zoom::Searchable::~Searchable()
292 ccl_qual_rm(&ccl_bibset);
295 yf::Zoom::Frontend::Frontend(Impl *impl) :
296 m_p(impl), m_is_virtual(false), m_in_use(true)
300 yf::Zoom::Frontend::~Frontend()
304 yf::Zoom::FrontendPtr yf::Zoom::Impl::get_frontend(mp::Package &package)
306 boost::mutex::scoped_lock lock(m_mutex);
308 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
312 it = m_clients.find(package.session());
313 if (it == m_clients.end())
316 if (!it->second->m_in_use)
318 it->second->m_in_use = true;
321 m_cond_session_ready.wait(lock);
323 FrontendPtr f(new Frontend(this));
324 m_clients[package.session()] = f;
329 void yf::Zoom::Impl::release_frontend(mp::Package &package)
331 boost::mutex::scoped_lock lock(m_mutex);
332 std::map<mp::Session,yf::Zoom::FrontendPtr>::iterator it;
334 it = m_clients.find(package.session());
335 if (it != m_clients.end())
337 if (package.session().is_closed())
343 it->second->m_in_use = false;
345 m_cond_session_ready.notify_all();
349 yf::Zoom::Impl::Impl() : element_transform("pz2") , element_raw("raw")
351 bibset = ccl_qual_mk();
354 yf::Zoom::Impl::~Impl()
356 ccl_qual_rm(&bibset);
359 yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr)
361 Zoom::SearchablePtr s(new Searchable(bibset));
363 for (ptr = ptr->children; ptr; ptr = ptr->next)
365 if (ptr->type != XML_ELEMENT_NODE)
367 if (!strcmp((const char *) ptr->name, "layer"))
369 else if (!strcmp((const char *) ptr->name,
372 s->authentication = mp::xml::get_text(ptr);
374 else if (!strcmp((const char *) ptr->name,
377 s->cfAuth = mp::xml::get_text(ptr);
379 else if (!strcmp((const char *) ptr->name,
382 s->cfProxy = mp::xml::get_text(ptr);
384 else if (!strcmp((const char *) ptr->name,
387 s->cfSubDb = mp::xml::get_text(ptr);
389 else if (!strcmp((const char *) ptr->name, "udb"))
391 s->udb = mp::xml::get_text(ptr);
393 else if (!strcmp((const char *) ptr->name, "zurl"))
395 s->target = mp::xml::get_text(ptr);
397 else if (!strcmp((const char *) ptr->name, "sru"))
399 s->sru = mp::xml::get_text(ptr);
401 else if (!strcmp((const char *) ptr->name,
404 s->query_encoding = mp::xml::get_text(ptr);
406 else if (!strcmp((const char *) ptr->name,
409 s->piggyback = mp::xml::get_bool(ptr, true);
411 else if (!strcmp((const char *) ptr->name,
414 s->request_syntax = mp::xml::get_text(ptr);
416 else if (!strcmp((const char *) ptr->name,
419 s->element_set = mp::xml::get_text(ptr);
421 else if (!strcmp((const char *) ptr->name,
424 s->record_encoding = mp::xml::get_text(ptr);
426 else if (!strcmp((const char *) ptr->name,
429 s->transform_xsl_fname = mp::xml::get_text(ptr);
431 else if (!strcmp((const char *) ptr->name,
434 s->urlRecipe = mp::xml::get_text(ptr);
436 else if (!strcmp((const char *) ptr->name,
439 ; // useTurboMarc is ignored
441 else if (!strncmp((const char *) ptr->name,
444 std::string value = mp::xml::get_text(ptr);
445 ccl_qual_fitem(s->ccl_bibset, value.c_str(),
446 (const char *) ptr->name + 7);
452 void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only)
454 while (ptr && ptr->type != XML_ELEMENT_NODE)
459 if (!strcmp((const char *) ptr->name, "records"))
461 for (ptr = ptr->children; ptr; ptr = ptr->next)
463 if (ptr->type != XML_ELEMENT_NODE)
465 if (!strcmp((const char *) ptr->name, "record"))
467 SearchablePtr s = parse_torus_record(ptr);
470 std::string udb = s->udb;
475 throw mp::filter::FilterException
476 ("No udb for local torus record");
482 throw mp::filter::FilterException
484 + std::string((const char *) ptr->name)
485 + " in zoom filter inside element "
492 throw mp::filter::FilterException
494 + std::string((const char *) ptr->name)
495 + " in zoom filter inside element <torus>");
500 void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only,
506 if (path[strlen(path)-1] != '/')
509 for (ptr = ptr->children; ptr; ptr = ptr->next)
511 if (ptr->type != XML_ELEMENT_NODE)
513 else if (!strcmp((const char *) ptr->name, "torus"))
515 const struct _xmlAttr *attr;
516 for (attr = ptr->properties; attr; attr = attr->next)
518 if (!strcmp((const char *) attr->name, "url"))
519 torus_url = mp::xml::get_text(attr->children);
520 else if (!strcmp((const char *) attr->name, "xsldir"))
521 xsldir = mp::xml::get_text(attr->children);
522 else if (!strcmp((const char *) attr->name, "element_transform"))
523 element_transform = mp::xml::get_text(attr->children);
524 else if (!strcmp((const char *) attr->name, "element_raw"))
525 element_raw = mp::xml::get_text(attr->children);
527 throw mp::filter::FilterException(
528 "Bad attribute " + std::string((const char *)
531 configure_local_records(ptr->children, test_only);
533 else if (!strcmp((const char *) ptr->name, "cclmap"))
535 const char *addinfo = 0;
536 ccl_xml_config(bibset, ptr, &addinfo);
538 else if (!strcmp((const char *) ptr->name, "fieldmap"))
540 const struct _xmlAttr *attr;
541 std::string ccl_field;
542 std::string cql_field;
543 for (attr = ptr->properties; attr; attr = attr->next)
545 if (!strcmp((const char *) attr->name, "ccl"))
546 ccl_field = mp::xml::get_text(attr->children);
547 else if (!strcmp((const char *) attr->name, "cql"))
548 cql_field = mp::xml::get_text(attr->children);
550 throw mp::filter::FilterException(
551 "Bad attribute " + std::string((const char *)
554 if (cql_field.length())
555 fieldmap[cql_field] = ccl_field;
559 throw mp::filter::FilterException
561 + std::string((const char *) ptr->name)
562 + " in zoom filter");
567 yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases(
568 std::string &database, int *error, char **addinfo, ODR odr)
570 std::list<BackendPtr>::const_iterator map_it;
571 if (m_backend && m_backend->m_frontend_database == database)
574 const char *sru_proxy = 0;
576 std::string torus_db;
577 size_t db_arg_pos = database.find(',');
578 if (db_arg_pos != std::string::npos)
580 torus_db = database.substr(0, db_arg_pos);
581 db_args = database.substr(db_arg_pos + 1);
588 std::map<std::string,SearchablePtr>::iterator it;
589 it = m_p->s_map.find(torus_db);
590 if (it != m_p->s_map.end())
594 xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db);
597 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
598 *addinfo = odr_strdup(odr, database.c_str());
602 const xmlNode *ptr = xmlDocGetRootElement(doc);
604 { // presumably ptr is a records element node
605 // parse first record in document
606 for (ptr = ptr->children; ptr; ptr = ptr->next)
608 if (ptr->type == XML_ELEMENT_NODE
609 && !strcmp((const char *) ptr->name, "record"))
611 sptr = m_p->parse_torus_record(ptr);
621 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
622 *addinfo = odr_strdup(odr, database.c_str());
627 xsltStylesheetPtr xsp = 0;
628 if (sptr->transform_xsl_fname.length())
632 if (m_p->xsldir.length())
633 fname = m_p->xsldir + "/" + sptr->transform_xsl_fname;
635 fname = m_p->file_path + sptr->transform_xsl_fname;
636 xmlDoc *xsp_doc = xmlParseFile(fname.c_str());
639 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
640 *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname.c_str()));
641 sprintf(*addinfo, "xmlParseFile failed. File %s", fname.c_str());
645 xsp = xsltParseStylesheetDoc(xsp_doc);
648 *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST;
649 *addinfo = odr_strdup(odr, "xsltParseStylesheetDoc failed");
658 BackendPtr b(new Backend(sptr));
661 b->m_frontend_database = database;
662 std::string authentication = sptr->authentication;
664 b->set_option("timeout", "40");
666 if (sptr->query_encoding.length())
667 b->set_option("rpnCharset", sptr->query_encoding.c_str());
669 if (sptr->cfAuth.length())
672 b->set_option("user", sptr->cfAuth.c_str());
673 if (db_args.length() == 0)
675 if (authentication.length())
677 // no database (auth) args specified already.. and the
678 // Torus authentication has it.. Generate the args that CF
680 size_t found = authentication.find('/');
681 if (found != std::string::npos)
683 db_args += "user=" + mp::util::uri_encode(authentication.substr(0, found))
684 + "&password=" + mp::util::uri_encode(authentication.substr(found+1));
687 db_args += "user=" + mp::util::uri_encode(authentication);
689 if (sptr->cfProxy.length())
691 if (db_args.length())
693 db_args += "proxy=" + mp::util::uri_encode(sptr->cfProxy);
696 if (sptr->cfSubDb.length())
698 if (db_args.length())
700 db_args += "subdatabase=" + mp::util::uri_encode(sptr->cfSubDb);
706 if (db_args.length())
708 // user has specified backend authentication
709 const char *param_user = 0;
710 const char *param_password = 0;
714 int no_parms = yaz_uri_to_array(db_args.c_str(),
715 odr, &names, &values);
716 for (i = 0; i < no_parms; i++)
718 const char *name = names[i];
719 const char *value = values[i];
720 if (!strcmp(name, "user"))
722 else if (!strcmp(name, "password"))
723 param_password = value;
724 else if (!strcmp(name, "proxy"))
729 char *msg = (char*) odr_malloc(odr, strlen(name) + 30);
730 *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
731 sprintf(msg, "Bad database argument: %s", name);
736 if (param_user && param_password)
738 char *auth = (char*) odr_malloc(
739 odr, strlen(param_user) + strlen(param_password) + 2);
740 strcpy(auth, param_user);
742 strcat(auth, param_password);
743 b->set_option("user", auth);
745 db_args.clear(); // no arguments to be passed (non-CF)
749 // use authentication from Torus, if given
750 if (authentication.length())
751 b->set_option("user", authentication.c_str());
756 b->set_option("proxy", sru_proxy);
759 if (sptr->sru.length())
761 url = "http://" + sptr->target;
762 b->set_option("sru", sptr->sru.c_str());
768 if (db_args.length())
769 url += "," + db_args;
770 yaz_log(YLOG_LOG, "url=%s", url.c_str());
771 b->connect(url, error, addinfo, odr);
779 Z_Records *yf::Zoom::Frontend::get_records(Odr_int start,
780 Odr_int number_to_present,
783 Odr_int *number_of_records_returned,
786 Odr_oid *preferredRecordSyntax,
787 const char *element_set_name)
789 *number_of_records_returned = 0;
790 Z_Records *records = 0;
791 bool enable_pz2_retrieval = false; // whether target profile is used
792 bool enable_pz2_transform = false; // whether XSLT is used as well
793 bool assume_marc8_charset = false;
795 if (start < 0 || number_to_present <= 0)
798 if (number_to_present > 10000)
799 number_to_present = 10000;
801 ZOOM_record *recs = (ZOOM_record *)
802 odr_malloc(odr, number_to_present * sizeof(*recs));
804 char oid_name_str[OID_STR_MAX];
805 const char *syntax_name = 0;
807 if (preferredRecordSyntax &&
808 !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml)
811 if (!strcmp(element_set_name, m_p->element_transform.c_str()))
813 enable_pz2_retrieval = true;
814 enable_pz2_transform = true;
816 else if (!strcmp(element_set_name, m_p->element_raw.c_str()))
818 enable_pz2_retrieval = true;
822 if (enable_pz2_retrieval)
824 if (b->sptr->request_syntax.length())
826 syntax_name = b->sptr->request_syntax.c_str();
827 const Odr_oid *syntax_oid =
828 yaz_string_to_oid(yaz_oid_std(), CLASS_RECSYN, syntax_name);
829 if (!oid_oidcmp(syntax_oid, yaz_oid_recsyn_usmarc)
830 || !oid_oidcmp(syntax_oid, yaz_oid_recsyn_opac))
831 assume_marc8_charset = true;
834 else if (preferredRecordSyntax)
836 yaz_oid_to_string_buf(preferredRecordSyntax, 0, oid_name_str);
838 b->set_option("preferredRecordSyntax", syntax_name);
840 if (enable_pz2_retrieval)
842 element_set_name = 0;
843 if (b->sptr->element_set.length())
844 element_set_name = b->sptr->element_set.c_str();
847 b->set_option("elementSetName", element_set_name);
849 b->present(start, number_to_present, recs, error, addinfo, odr);
854 for (i = 0; i < number_to_present; i++)
859 { // only return records if no error and at least one record
860 char *odr_database = odr_strdup(odr,
861 b->m_frontend_database.c_str());
862 Z_NamePlusRecordList *npl = (Z_NamePlusRecordList *)
863 odr_malloc(odr, sizeof(*npl));
864 *number_of_records_returned = i;
865 npl->num_records = i;
866 npl->records = (Z_NamePlusRecord **)
867 odr_malloc(odr, i * sizeof(*npl->records));
868 for (i = 0; i < number_to_present; i++)
870 Z_NamePlusRecord *npr = 0;
872 int sur_error = ZOOM_record_error(recs[i], 0 /* msg */,
873 &addinfo, 0 /* diagset */);
877 npr = zget_surrogateDiagRec(odr, odr_database, sur_error,
880 else if (enable_pz2_retrieval)
882 char rec_type_str[100];
883 const char *record_encoding = 0;
885 if (b->sptr->record_encoding.length())
886 record_encoding = b->sptr->record_encoding.c_str();
887 else if (assume_marc8_charset)
888 record_encoding = "marc8";
890 strcpy(rec_type_str, b->sptr->use_turbomarc ? "txml" : "xml");
893 strcat(rec_type_str, "; charset=");
894 strcat(rec_type_str, record_encoding);
898 xmlChar *xmlrec_buf = 0;
899 const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str,
901 if (rec_buf && b->xsp && enable_pz2_transform)
903 xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len);
907 rec_res = xsltApplyStylesheet(b->xsp, rec_doc, 0);
910 xsltSaveResultToString(&xmlrec_buf, &rec_len,
912 rec_buf = (const char *) xmlrec_buf;
920 xmlDoc *doc = xmlParseMemory(rec_buf, rec_len);
922 mp::xml::url_recipe_handle(doc, b->sptr->urlRecipe);
925 xmlNode *ptr = xmlDocGetRootElement(doc);
926 while (ptr && ptr->type != XML_ELEMENT_NODE)
929 xmlNewChild(ptr, 0, BAD_CAST "generated-url", 0);
930 xmlNode * t = xmlNewText(BAD_CAST res.c_str());
936 xmlDocDumpMemory(doc, &xmlrec_buf, &rec_len);
937 rec_buf = (const char *) xmlrec_buf;
943 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
944 npr->databaseName = odr_database;
945 npr->which = Z_NamePlusRecord_databaseRecord;
946 npr->u.databaseRecord =
947 z_ext_record_xml(odr, rec_buf, rec_len);
951 npr = zget_surrogateDiagRec(
953 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
962 (Z_External *) ZOOM_record_get(recs[i], "ext", 0);
965 npr = (Z_NamePlusRecord *) odr_malloc(odr, sizeof(*npr));
966 npr->databaseName = odr_database;
967 npr->which = Z_NamePlusRecord_databaseRecord;
968 npr->u.databaseRecord = ext;
972 npr = zget_surrogateDiagRec(
974 YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
975 "ZOOM_record, type ext");
978 npl->records[i] = npr;
980 records = (Z_Records*) odr_malloc(odr, sizeof(*records));
981 records->which = Z_Records_DBOSD;
982 records->u.databaseOrSurDiagnostics = npl;
987 struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn,
990 struct cql_node *r = 0;
998 std::map<std::string,std::string>::const_iterator it;
999 it = fieldmap.find(cn->u.st.index);
1000 if (it == fieldmap.end())
1002 if (it->second.length())
1003 cn->u.st.index = odr_strdup(odr, it->second.c_str());
1009 r = convert_cql_fields(cn->u.boolean.left, odr);
1011 r = convert_cql_fields(cn->u.boolean.right, odr);
1014 r = convert_cql_fields(cn->u.sort.search, odr);
1020 void yf::Zoom::Frontend::handle_search(mp::Package &package)
1022 Z_GDU *gdu = package.request().get();
1023 Z_APDU *apdu_req = gdu->u.z3950;
1024 Z_APDU *apdu_res = 0;
1026 Z_SearchRequest *sr = apdu_req->u.searchRequest;
1027 if (sr->num_databaseNames != 1)
1029 apdu_res = odr.create_searchResponse(
1030 apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
1031 package.response() = apdu_res;
1037 std::string db(sr->databaseNames[0]);
1038 BackendPtr b = get_backend_from_databases(db, &error, &addinfo, odr);
1042 odr.create_searchResponse(apdu_req, error, addinfo);
1043 package.response() = apdu_res;
1047 b->set_option("setname", "default");
1050 Z_Query *query = sr->query;
1051 WRBUF ccl_wrbuf = 0;
1052 WRBUF pqf_wrbuf = 0;
1054 if (query->which == Z_Query_type_1 || query->which == Z_Query_type_101)
1057 pqf_wrbuf = wrbuf_alloc();
1058 yaz_rpnquery_to_wrbuf(pqf_wrbuf, query->u.type_1);
1060 else if (query->which == Z_Query_type_2)
1063 ccl_wrbuf = wrbuf_alloc();
1064 wrbuf_write(ccl_wrbuf, (const char *) query->u.type_2->buf,
1065 query->u.type_2->len);
1067 else if (query->which == Z_Query_type_104 &&
1068 query->u.type_104->which == Z_External_CQL)
1071 const char *cql = query->u.type_104->u.cql;
1072 CQL_parser cp = cql_parser_create();
1073 int r = cql_parser_string(cp, cql);
1076 cql_parser_destroy(cp);
1078 odr.create_searchResponse(apdu_req,
1079 YAZ_BIB1_MALFORMED_QUERY,
1080 "CQL syntax error");
1081 package.response() = apdu_res;
1084 struct cql_node *cn = cql_parser_result(cp);
1085 struct cql_node *cn_error = m_p->convert_cql_fields(cn, odr);
1088 // hopefully we are getting a ptr to a index+relation+term node
1090 if (cn_error->which == CQL_NODE_ST)
1091 addinfo = cn_error->u.st.index;
1094 odr.create_searchResponse(apdu_req,
1095 YAZ_BIB1_UNSUPP_USE_ATTRIBUTE,
1097 package.response() = apdu_res;
1102 r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf));
1105 ccl_wrbuf = wrbuf_alloc();
1106 wrbuf_puts(ccl_wrbuf, ccl_buf);
1108 cql_parser_destroy(cp);
1112 odr.create_searchResponse(apdu_req,
1113 YAZ_BIB1_MALFORMED_QUERY,
1114 "CQL to CCL conversion error");
1115 package.response() = apdu_res;
1122 odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0);
1123 package.response() = apdu_res;
1130 assert(pqf_wrbuf == 0);
1132 struct ccl_rpn_node *cn;
1133 yaz_log(YLOG_LOG, "CCL: %s", wrbuf_cstr(ccl_wrbuf));
1134 cn = ccl_find_str(b->sptr->ccl_bibset, wrbuf_cstr(ccl_wrbuf),
1136 wrbuf_destroy(ccl_wrbuf);
1139 char *addinfo = odr_strdup(odr, ccl_err_msg(cerror));
1140 int z3950_diag = YAZ_BIB1_MALFORMED_QUERY;
1144 case CCL_ERR_UNKNOWN_QUAL:
1145 z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE;
1147 case CCL_ERR_TRUNC_NOT_LEFT:
1148 case CCL_ERR_TRUNC_NOT_RIGHT:
1149 case CCL_ERR_TRUNC_NOT_BOTH:
1150 z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE;
1154 odr.create_searchResponse(apdu_req, z3950_diag, addinfo);
1155 package.response() = apdu_res;
1158 pqf_wrbuf = wrbuf_alloc();
1159 ccl_pquery(pqf_wrbuf, cn);
1164 if (b->get_option("sru"))
1168 zquery = p_query_rpn(odr, wrbuf_cstr(pqf_wrbuf));
1169 WRBUF wrb = wrbuf_alloc();
1171 if (!strcmp(b->get_option("sru"), "solr"))
1173 solr_transform_t cqlt = solr_transform_create();
1175 status = solr_transform_rpn2solr_wrbuf(cqlt, wrb, zquery);
1177 solr_transform_close(cqlt);
1181 cql_transform_t cqlt = cql_transform_create();
1183 status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery);
1185 cql_transform_close(cqlt);
1189 yaz_log(YLOG_LOG, "search CQL: %s", wrbuf_cstr(wrb));
1190 b->search_cql(wrbuf_cstr(wrb), &hits, &error, &addinfo, odr);
1194 wrbuf_destroy(pqf_wrbuf);
1198 odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY,
1199 "can not convert from RPN to CQL/SOLR");
1200 package.response() = apdu_res;
1206 yaz_log(YLOG_LOG, "search PQF: %s", wrbuf_cstr(pqf_wrbuf));
1207 b->search_pqf(wrbuf_cstr(pqf_wrbuf), &hits, &error, &addinfo, odr);
1208 wrbuf_destroy(pqf_wrbuf);
1212 const char *element_set_name = 0;
1213 Odr_int number_to_present = 0;
1215 mp::util::piggyback_sr(sr, hits, number_to_present, &element_set_name);
1217 Odr_int number_of_records_returned = 0;
1218 Z_Records *records = get_records(
1219 0, number_to_present, &error, &addinfo,
1220 &number_of_records_returned, odr, b, sr->preferredRecordSyntax,
1222 apdu_res = odr.create_searchResponse(apdu_req, error, addinfo);
1225 apdu_res->u.searchResponse->records = records;
1226 apdu_res->u.searchResponse->numberOfRecordsReturned =
1227 odr_intdup(odr, number_of_records_returned);
1229 apdu_res->u.searchResponse->resultCount = odr_intdup(odr, hits);
1230 package.response() = apdu_res;
1233 void yf::Zoom::Frontend::handle_present(mp::Package &package)
1235 Z_GDU *gdu = package.request().get();
1236 Z_APDU *apdu_req = gdu->u.z3950;
1237 Z_APDU *apdu_res = 0;
1238 Z_PresentRequest *pr = apdu_req->u.presentRequest;
1243 package.response() = odr.create_presentResponse(
1244 apdu_req, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST, 0);
1247 const char *element_set_name = 0;
1248 Z_RecordComposition *comp = pr->recordComposition;
1249 if (comp && comp->which != Z_RecordComp_simple)
1251 package.response() = odr.create_presentResponse(
1253 YAZ_BIB1_PRESENT_COMP_SPEC_PARAMETER_UNSUPP, 0);
1256 if (comp && comp->u.simple->which == Z_ElementSetNames_generic)
1257 element_set_name = comp->u.simple->u.generic;
1258 Odr_int number_of_records_returned = 0;
1261 Z_Records *records = get_records(
1262 *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested,
1263 &error, &addinfo, &number_of_records_returned, odr, m_backend,
1264 pr->preferredRecordSyntax, element_set_name);
1266 apdu_res = odr.create_presentResponse(apdu_req, error, addinfo);
1269 apdu_res->u.presentResponse->records = records;
1270 apdu_res->u.presentResponse->numberOfRecordsReturned =
1271 odr_intdup(odr, number_of_records_returned);
1273 package.response() = apdu_res;
1276 void yf::Zoom::Frontend::handle_package(mp::Package &package)
1278 Z_GDU *gdu = package.request().get();
1281 else if (gdu->which == Z_GDU_Z3950)
1283 Z_APDU *apdu_req = gdu->u.z3950;
1284 if (apdu_req->which == Z_APDU_initRequest)
1287 package.response() = odr.create_close(
1289 Z_Close_protocolError,
1292 else if (apdu_req->which == Z_APDU_searchRequest)
1294 handle_search(package);
1296 else if (apdu_req->which == Z_APDU_presentRequest)
1298 handle_present(package);
1303 package.response() = odr.create_close(
1305 Z_Close_protocolError,
1306 "zoom filter cannot handle this APDU");
1307 package.session().close();
1312 package.session().close();
1316 void yf::Zoom::Impl::process(mp::Package &package)
1318 FrontendPtr f = get_frontend(package);
1319 Z_GDU *gdu = package.request().get();
1321 if (f->m_is_virtual)
1323 f->handle_package(package);
1325 else if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1328 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
1329 f->m_init_gdu = gdu;
1332 Z_APDU *apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
1333 Z_InitResponse *resp = apdu->u.initResponse;
1336 static const int masks[] = {
1341 for (i = 0; masks[i] != -1; i++)
1342 if (ODR_MASK_GET(req->options, masks[i]))
1343 ODR_MASK_SET(resp->options, masks[i]);
1345 static const int versions[] = {
1346 Z_ProtocolVersion_1,
1347 Z_ProtocolVersion_2,
1348 Z_ProtocolVersion_3,
1351 for (i = 0; versions[i] != -1; i++)
1352 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
1353 ODR_MASK_SET(resp->protocolVersion, versions[i]);
1357 *resp->preferredMessageSize = *req->preferredMessageSize;
1358 *resp->maximumRecordSize = *req->maximumRecordSize;
1360 package.response() = apdu;
1361 f->m_is_virtual = true;
1366 release_frontend(package);
1370 static mp::filter::Base* filter_creator()
1372 return new mp::filter::Zoom;
1376 struct metaproxy_1_filter_struct metaproxy_1_filter_zoom = {
1387 * c-file-style: "Stroustrup"
1388 * indent-tabs-mode: nil
1390 * vim: shiftwidth=4 tabstop=8 expandtab