X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=src%2Ffilter_zoom.cpp;h=bcd618f98b8c981c6507d08590868b5fe2bc846b;hb=c1915c1645ff4b7ccaa4ec1f0584fdd4371b253c;hp=b0597ce1b72fb4aed06c1c5ab72d4f4a87f4491a;hpb=c45ae107e9836f63beb51f5792f9963f221781ef;p=metaproxy-moved-to-github.git diff --git a/src/filter_zoom.cpp b/src/filter_zoom.cpp index b0597ce..bcd618f 100644 --- a/src/filter_zoom.cpp +++ b/src/filter_zoom.cpp @@ -1,5 +1,5 @@ /* This file is part of Metaproxy. - Copyright (C) 2005-2011 Index Data + Copyright (C) 2005-2012 Index Data Metaproxy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free @@ -21,10 +21,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include #include #include "filter_zoom.hpp" -#include -#include -#include -#include #include #include #include @@ -35,6 +31,10 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include #include + +#include +#include +#include #include #include #include @@ -48,6 +48,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include #include #include +#include namespace mp = metaproxy_1; namespace yf = mp::filter; @@ -59,11 +60,12 @@ namespace metaproxy_1 { std::string authentication; std::string cfAuth; std::string cfProxy; - std::string cfSubDb; + std::string cfSubDB; std::string udb; std::string target; std::string query_encoding; std::string sru; + std::string sru_version; std::string request_syntax; std::string element_set; std::string record_encoding; @@ -83,14 +85,18 @@ namespace metaproxy_1 { friend class Impl; friend class Frontend; std::string zurl; + WRBUF m_apdu_wrbuf; ZOOM_connection m_connection; ZOOM_resultset m_resultset; std::string m_frontend_database; SearchablePtr sptr; xsltStylesheetPtr xsp; std::string content_session_id; + bool enable_cproxy; + bool enable_explain; + xmlDoc *explain_doc; public: - Backend(SearchablePtr sptr); + Backend(); ~Backend(); void connect(std::string zurl, int *error, char **addinfo, ODR odr); @@ -112,14 +118,31 @@ namespace metaproxy_1 { BackendPtr m_backend; void handle_package(mp::Package &package); void handle_search(mp::Package &package); + + BackendPtr explain_search(mp::Package &package, + std::string &database, + int *error, + char **addinfo, + ODR odr, + std::string &torus_db, + std::string &realm); void handle_present(mp::Package &package); - BackendPtr get_backend_from_databases(const mp::Package &package, + BackendPtr get_backend_from_databases(mp::Package &package, std::string &database, int *error, char **addinfo, - ODR odr); - - + ODR odr, + int *proxy_step); + + bool create_content_session(mp::Package &package, + BackendPtr b, + int *error, + char **addinfo, + ODR odr, + std::string authentication, + std::string proxy, + std::string realm); + void prepare_elements(BackendPtr b, Odr_oid *preferredRecordSyntax, const char *element_set_name, @@ -127,7 +150,8 @@ namespace metaproxy_1 { bool &enable_pz2_transform, bool &assume_marc8_charset); - Z_Records *get_records(Odr_int start, + Z_Records *get_records(Package &package, + Odr_int start, Odr_int number_to_present, int *error, char **addinfo, @@ -135,6 +159,9 @@ namespace metaproxy_1 { ODR odr, BackendPtr b, Odr_oid *preferredRecordSyntax, const char *element_set_name); + + void log_diagnostic(mp::Package &package, + int error, const char *addinfo); public: Frontend(Impl *impl); ~Frontend(); @@ -156,7 +183,8 @@ namespace metaproxy_1 { std::map m_clients; boost::mutex m_mutex; boost::condition m_cond_session_ready; - std::string torus_url; + std::string torus_searchable_url; + std::string torus_content_url; std::string default_realm; std::map fieldmap; std::string xsldir; @@ -168,6 +196,7 @@ namespace metaproxy_1 { std::string element_transform; std::string element_raw; std::string proxy; + xsltStylesheetPtr explain_xsp; std::map s_map; }; } @@ -197,19 +226,27 @@ void yf::Zoom::process(mp::Package &package) const // define Implementation stuff -yf::Zoom::Backend::Backend(SearchablePtr ptr) : sptr(ptr) +yf::Zoom::Backend::Backend() { + m_apdu_wrbuf = wrbuf_alloc(); m_connection = ZOOM_connection_create(0); + ZOOM_connection_save_apdu_wrbuf(m_connection, m_apdu_wrbuf); m_resultset = 0; xsp = 0; + enable_cproxy = true; + enable_explain = false; + explain_doc = 0; } yf::Zoom::Backend::~Backend() { if (xsp) xsltFreeStylesheet(xsp); + if (explain_doc) + xmlFreeDoc(explain_doc); ZOOM_connection_destroy(m_connection); ZOOM_resultset_destroy(m_resultset); + wrbuf_destroy(m_apdu_wrbuf); } @@ -219,38 +256,30 @@ void yf::Zoom::Backend::get_zoom_error(int *error, char **addinfo, const char *msg = 0; const char *zoom_addinfo = 0; const char *dset = 0; - *error = ZOOM_connection_error_x(m_connection, &msg, &zoom_addinfo, &dset); - if (*error) + int error0 = ZOOM_connection_error_x(m_connection, &msg, + &zoom_addinfo, &dset); + if (error0) { - if (*error >= ZOOM_ERROR_CONNECT) - { - // turn ZOOM diagnostic into a Bib-1 2: with addinfo=zoom err msg - *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR; - *addinfo = (char *) odr_malloc( - odr, 20 + strlen(msg) + - (zoom_addinfo ? strlen(zoom_addinfo) : 0)); - strcpy(*addinfo, msg); - if (zoom_addinfo) - { - strcat(*addinfo, ": "); - strcat(*addinfo, zoom_addinfo); - strcat(*addinfo, " "); - } - } + if (!dset) + dset = "Unknown"; + + if (!strcmp(dset, "info:srw/diagnostic/1")) + *error = yaz_diag_srw_to_bib1(error0); + else if (!strcmp(dset, "Bib-1")) + *error = error0; else - { - if (dset && !strcmp(dset, "info:srw/diagnostic/1")) - *error = yaz_diag_srw_to_bib1(*error); - *addinfo = (char *) odr_malloc( - odr, 20 + (zoom_addinfo ? strlen(zoom_addinfo) : 0)); - **addinfo = '\0'; - if (zoom_addinfo && *zoom_addinfo) - { - strcpy(*addinfo, zoom_addinfo); - strcat(*addinfo, " "); - } - strcat(*addinfo, "(backend)"); + *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR; + + *addinfo = (char *) odr_malloc( + odr, 30 + strlen(dset) + strlen(msg) + + (zoom_addinfo ? strlen(zoom_addinfo) : 0)); + **addinfo = '\0'; + if (zoom_addinfo && *zoom_addinfo) + { + strcpy(*addinfo, zoom_addinfo); + strcat(*addinfo, " "); } + sprintf(*addinfo + strlen(*addinfo), "(%s %d %s)", dset, error0, msg); } } @@ -265,6 +294,7 @@ void yf::Zoom::Backend::connect(std::string zurl, void yf::Zoom::Backend::search(ZOOM_query q, Odr_int *hits, int *error, char **addinfo, ODR odr) { + ZOOM_resultset_destroy(m_resultset); m_resultset = ZOOM_connection_search(m_connection, q); get_zoom_error(error, addinfo, odr); if (*error == 0) @@ -303,6 +333,7 @@ yf::Zoom::Searchable::Searchable(CCL_bibset base) piggyback = true; use_turbomarc = true; sortStrategy = "embed"; + urlRecipe = "${md-electronic-url}"; ccl_bibset = ccl_qual_dup(base); } @@ -370,11 +401,14 @@ yf::Zoom::Impl::Impl() : { bibset = ccl_qual_mk(); + explain_xsp = 0; srand((unsigned int) time(0)); } yf::Zoom::Impl::~Impl() -{ +{ + if (explain_xsp) + xsltFreeStylesheet(explain_xsp); ccl_qual_rm(&bibset); } @@ -404,9 +438,9 @@ yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr) s->cfProxy = mp::xml::get_text(ptr); } else if (!strcmp((const char *) ptr->name, - "cfSubDb")) + "cfSubDB")) { - s->cfSubDb = mp::xml::get_text(ptr); + s->cfSubDB = mp::xml::get_text(ptr); } else if (!strcmp((const char *) ptr->name, "contentConnector")) @@ -425,6 +459,11 @@ yf::Zoom::SearchablePtr yf::Zoom::Impl::parse_torus_record(const xmlNode *ptr) { s->sru = mp::xml::get_text(ptr); } + else if (!strcmp((const char *) ptr->name, "SRUVersion") || + !strcmp((const char *) ptr->name, "sruVersion")) + { + s->sru_version = mp::xml::get_text(ptr); + } else if (!strcmp((const char *) ptr->name, "queryEncoding")) { @@ -543,6 +582,8 @@ void yf::Zoom::Impl::configure_local_records(const xmlNode *ptr, bool test_only) void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only, const char *path) { + std::string explain_xslt_fname; + content_tmp_file = "/tmp/cf.XXXXXX.p"; if (path && *path) { @@ -558,7 +599,9 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only, for (attr = ptr->properties; attr; attr = attr->next) { if (!strcmp((const char *) attr->name, "url")) - torus_url = mp::xml::get_text(attr->children); + torus_searchable_url = mp::xml::get_text(attr->children); + else if (!strcmp((const char *) attr->name, "content_url")) + torus_content_url = mp::xml::get_text(attr->children); else if (!strcmp((const char *) attr->name, "realm")) default_realm = mp::xml::get_text(attr->children); else if (!strcmp((const char *) attr->name, "xsldir")) @@ -569,11 +612,17 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only, element_raw = mp::xml::get_text(attr->children); else if (!strcmp((const char *) attr->name, "proxy")) proxy = mp::xml::get_text(attr->children); + else if (!strcmp((const char *) attr->name, "explain_xsl")) + explain_xslt_fname = mp::xml::get_text(attr->children); else throw mp::filter::FilterException( "Bad attribute " + std::string((const char *) attr->name)); } + // If content_url is not given, use value of searchable, to + // ensure backwards compatibility + if (!torus_content_url.length()) + torus_content_url = torus_searchable_url; configure_local_records(ptr->children, test_only); } else if (!strcmp((const char *) ptr->name, "cclmap")) @@ -636,11 +685,99 @@ void yf::Zoom::Impl::configure(const xmlNode *ptr, bool test_only, + " in zoom filter"); } } + + if (explain_xslt_fname.length()) + { + const char *path = 0; + + if (xsldir.length()) + path = xsldir.c_str(); + else + path = file_path.c_str(); + + char fullpath[1024]; + char *cp = yaz_filepath_resolve(explain_xslt_fname.c_str(), + path, 0, fullpath); + if (!cp) + { + throw mp::filter::FilterException + ("Cannot read XSLT " + explain_xslt_fname); + } + + xmlDoc *xsp_doc = xmlParseFile(cp); + if (!xsp_doc) + { + throw mp::filter::FilterException + ("Cannot parse XSLT " + explain_xslt_fname); + } + + explain_xsp = xsltParseStylesheetDoc(xsp_doc); + if (!explain_xsp) + { + xmlFreeDoc(xsp_doc); + throw mp::filter::FilterException + ("Cannot parse XSLT " + explain_xslt_fname); + + } + } +} + +bool yf::Zoom::Frontend::create_content_session(mp::Package &package, + BackendPtr b, + int *error, char **addinfo, + ODR odr, + std::string authentication, + std::string proxy, + std::string realm) +{ + if (b->sptr->contentConnector.length()) + { + char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8); + strcpy(fname, m_p->content_tmp_file.c_str()); + char *xx = strstr(fname, "XXXXXX"); + if (!xx) + { + xx = fname + strlen(fname); + strcat(fname, "XXXXXX"); + } + char tmp_char = xx[6]; + sprintf(xx, "%06d", ((unsigned) rand()) % 1000000); + xx[6] = tmp_char; + + FILE *file = fopen(fname, "w"); + if (!file) + { + package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname); + *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR; + *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname)); + sprintf(*addinfo, "Could not create %s", fname); + xfree(fname); + return false; + } + b->content_session_id.assign(xx, 6); + WRBUF w = wrbuf_alloc(); + wrbuf_puts(w, "#content_proxy\n"); + wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str()); + if (authentication.length()) + wrbuf_printf(w, "auth: %s\n", authentication.c_str()); + if (proxy.length()) + wrbuf_printf(w, "proxy: %s\n", proxy.c_str()); + if (realm.length()) + wrbuf_printf(w, "realm: %s\n", realm.c_str()); + + fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file); + fclose(file); + package.log("zoom", YLOG_LOG, "content file: %s", fname); + xfree(fname); + wrbuf_destroy(w); + } + return true; } yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( - const mp::Package &package, - std::string &database, int *error, char **addinfo, ODR odr) + mp::Package &package, + std::string &database, int *error, char **addinfo, ODR odr, + int *proxy_step) { std::list::const_iterator map_it; if (m_backend && m_backend->m_frontend_database == database) @@ -658,11 +795,16 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( torus_db = database; std::string authentication; + std::string content_authentication; std::string proxy; + std::string content_proxy; std::string realm = m_p->default_realm; const char *param_user = 0; const char *param_password = 0; + const char *param_content_user = 0; + const char *param_content_password = 0; + const char *param_nocproxy = 0; int no_parms = 0; char **names; @@ -677,6 +819,8 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( const char **out_values = (const char **) odr_malloc(odr, (10 + no_parms) * sizeof(*out_values)); + // may be changed if it's a content connection + std::string torus_url = m_p->torus_searchable_url; int i; for (i = 0; i < no_parms; i++) { @@ -688,12 +832,35 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( param_user = value; else if (!strcmp(name, "password")) param_password = value; + else if (!strcmp(name, "content-user")) + param_content_user = value; + else if (!strcmp(name, "content-password")) + param_content_password = value; + else if (!strcmp(name, "content-proxy")) + content_proxy = value; + else if (!strcmp(name, "nocproxy")) + param_nocproxy = value; else if (!strcmp(name, "proxy")) - proxy = value; + { + char **dstr; + int dnum = 0; + nmem_strsplit(odr->mem, ",", value, &dstr, &dnum); + if (*proxy_step >= dnum) + *proxy_step = 0; + else + { + proxy = dstr[*proxy_step]; + + (*proxy_step)++; + if (*proxy_step == dnum) + *proxy_step = 0; + } + } else if (!strcmp(name, "cproxysession")) { out_names[no_out_args] = name; out_values[no_out_args++] = value; + torus_url = m_p->torus_content_url; } else if (!strcmp(name, "realm")) realm = value; @@ -718,16 +885,29 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( if (param_password) authentication += "/" + std::string(param_password); } + if (param_content_user) + { + content_authentication = std::string(param_content_user); + if (param_content_password) + content_authentication += "/" + std::string(param_content_password); + } + + if (torus_db.compare("IR-Explain---1") == 0) + return explain_search(package, database, error, addinfo, odr, torus_db, + realm); + SearchablePtr sptr; std::map::iterator it; it = m_p->s_map.find(torus_db); if (it != m_p->s_map.end()) sptr = it->second; - else if (m_p->torus_url.length() > 0) + else if (torus_url.length() > 0) { - xmlDoc *doc = mp::get_searchable(m_p->torus_url, torus_db, realm, - m_p->proxy); + std::string torus_query = "udb=" + torus_db; + xmlDoc *doc = mp::get_searchable(package,torus_url, torus_db, + torus_query, + realm, m_p->proxy); if (!doc) { *error = YAZ_BIB1_DATABASE_DOES_NOT_EXIST; @@ -839,10 +1019,12 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( m_backend.reset(); - BackendPtr b(new Backend(sptr)); + BackendPtr b(new Backend); + b->sptr = sptr; b->xsp = xsp; b->m_frontend_database = database; + b->enable_cproxy = param_nocproxy ? false : true; if (sptr->query_encoding.length()) b->set_option("rpnCharset", sptr->query_encoding); @@ -852,7 +1034,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( if (m_p->apdu_log) b->set_option("apdulog", "1"); - if (sptr->piggyback) + if (sptr->piggyback && sptr->sru.length()) b->set_option("count", "1"); /* some SRU servers INSIST on getting maximumRecords > 0 */ b->set_option("piggyback", sptr->piggyback ? "1" : "0"); @@ -892,10 +1074,15 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( out_names[no_out_args] = "proxy"; out_values[no_out_args++] = odr_strdup(odr, proxy.c_str()); } - if (sptr->cfSubDb.length()) + if (sptr->cfSubDB.length()) { out_names[no_out_args] = "subdatabase"; - out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDb.c_str()); + out_values[no_out_args++] = odr_strdup(odr, sptr->cfSubDB.c_str()); + } + if (param_nocproxy) + { + out_names[no_out_args] = "nocproxy"; + out_values[no_out_args++] = odr_strdup(odr, param_nocproxy); } } else @@ -913,53 +1100,17 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( if (proxy.length()) b->set_option("proxy", proxy); } - if (b->sptr->contentConnector.length()) - { - char *fname = (char *) xmalloc(m_p->content_tmp_file.length() + 8); - strcpy(fname, m_p->content_tmp_file.c_str()); - char *xx = strstr(fname, "XXXXXX"); - if (!xx) - { - xx = fname + strlen(fname); - strcat(fname, "XXXXXX"); - } - char tmp_char = xx[6]; - sprintf(xx, "%06d", ((unsigned) rand()) % 1000000); - xx[6] = tmp_char; - - FILE *file = fopen(fname, "w"); - if (!file) - { - package.log("zoom", YLOG_WARN|YLOG_ERRNO, "create %s", fname); - *error = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR; - *addinfo = (char *) odr_malloc(odr, 40 + strlen(fname)); - sprintf(*addinfo, "Could not create %s", fname); - xfree(fname); - BackendPtr backend_null; - return backend_null; - } - b->content_session_id.assign(xx, 6); - WRBUF w = wrbuf_alloc(); - wrbuf_puts(w, "#content_proxy\n"); - wrbuf_printf(w, "connector: %s\n", b->sptr->contentConnector.c_str()); - if (authentication.length()) - wrbuf_printf(w, "auth: %s\n", authentication.c_str()); - if (proxy.length()) - wrbuf_printf(w, "proxy: %s\n", proxy.c_str()); - if (sptr->cfProxy.length()) - wrbuf_printf(w, "cfproxy: %s\n", sptr->cfProxy.c_str()); - - fwrite(wrbuf_buf(w), 1, wrbuf_len(w), file); - fclose(file); - package.log("zoom", YLOG_LOG, "file %s created\n", fname); - xfree(fname); - } - + if (proxy.length()) + package.log("zoom", YLOG_LOG, "proxy: %s", proxy.c_str()); + std::string url; if (sptr->sru.length()) { url = "http://" + sptr->target; b->set_option("sru", sptr->sru); + + if (sptr->sru_version.length()) + b->set_option("sru_version", sptr->sru_version); } else { @@ -974,12 +1125,16 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( (char **) out_values); url += "," + std::string(x_args); } - package.log("zoom", YLOG_LOG, "url=%s", url.c_str()); + package.log("zoom", YLOG_LOG, "url: %s", url.c_str()); b->connect(url, error, addinfo, odr); + if (*error == 0 && b->enable_cproxy) + create_content_session(package, b, error, addinfo, odr, + content_authentication.length() ? + content_authentication : authentication, + content_proxy.length() ? content_proxy : proxy, + realm); if (*error == 0) - { m_backend = b; - } return b; } @@ -1043,7 +1198,8 @@ void yf::Zoom::Frontend::prepare_elements(BackendPtr b, b->set_option("schema", element_set_name); } -Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, +Z_Records *yf::Zoom::Frontend::get_records(Package &package, + Odr_int start, Odr_int number_to_present, int *error, char **addinfo, @@ -1065,6 +1221,10 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, enable_pz2_transform, assume_marc8_charset); + package.log("zoom", YLOG_LOG, "pz2_retrieval: %s . pz2_transform: %s", + enable_pz2_retrieval ? "yes" : "no", + enable_pz2_transform ? "yes" : "no"); + if (start < 0 || number_to_present <=0) return records; @@ -1097,11 +1257,13 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, { Z_NamePlusRecord *npr = 0; const char *addinfo; + int sur_error = ZOOM_record_error(recs[i], 0 /* msg */, &addinfo, 0 /* diagset */); if (sur_error) { + log_diagnostic(package, sur_error, addinfo); npr = zget_surrogateDiagRec(odr, odr_database, sur_error, addinfo); } @@ -1121,7 +1283,9 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, strcat(rec_type_str, "; charset="); strcat(rec_type_str, record_encoding); } - + + package.log("zoom", YLOG_LOG, "Getting record of type %s", + rec_type_str); int rec_len; xmlChar *xmlrec_buf = 0; const char *rec_buf = ZOOM_record_get(recs[i], rec_type_str, @@ -1130,11 +1294,16 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, { std::string addinfo("ZOOM_record_get failed for type "); + int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; addinfo += rec_type_str; - npr = zget_surrogateDiagRec( - odr, odr_database, - YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS, - addinfo.c_str()); + log_diagnostic(package, error, addinfo.c_str()); + npr = zget_surrogateDiagRec(odr, odr_database, + error, addinfo.c_str()); + } + else + { + package.log_write(rec_buf, rec_len); + package.log_write("\r\n", 2); } if (rec_buf && b->xsp && enable_pz2_transform) @@ -1142,10 +1311,11 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, xmlDoc *rec_doc = xmlParseMemory(rec_buf, rec_len); if (!rec_doc) { + const char *addinfo = "xml parse failed for record"; + int error = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; + log_diagnostic(package, error, addinfo); npr = zget_surrogateDiagRec( - odr, odr_database, - YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS, - "xml parse failed for record"); + odr, odr_database, error, addinfo); } else { @@ -1157,25 +1327,28 @@ Z_Records *yf::Zoom::Frontend::get_records(Odr_int start, xsltSaveResultToString(&xmlrec_buf, &rec_len, rec_res, b->xsp); rec_buf = (const char *) xmlrec_buf; + package.log("zoom", YLOG_LOG, "xslt successful"); + package.log_write(rec_buf, rec_len); xmlFreeDoc(rec_res); } if (!rec_buf) { std::string addinfo; + int error = + YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; addinfo = "xslt apply failed for " + b->sptr->transform_xsl_fname; + log_diagnostic(package, error, addinfo.c_str()); npr = zget_surrogateDiagRec( - odr, odr_database, - YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS, - addinfo.c_str()); + odr, odr_database, error, addinfo.c_str()); } xmlFreeDoc(rec_doc); } } - if (rec_buf) + if (rec_buf && b->enable_cproxy) { xmlDoc *doc = xmlParseMemory(rec_buf, rec_len); std::string res = @@ -1293,6 +1466,77 @@ struct cql_node *yf::Zoom::Impl::convert_cql_fields(struct cql_node *cn, return r; } +void yf::Zoom::Frontend::log_diagnostic(mp::Package &package, + int error, const char *addinfo) +{ + const char *err_msg = yaz_diag_bib1_str(error); + if (addinfo) + package.log("zoom", YLOG_WARN, "Diagnostic %d %s: %s", + error, err_msg, addinfo); + else + package.log("zoom", YLOG_WARN, "Diagnostic %d %s:", + error, err_msg); +} + +yf::Zoom::BackendPtr yf::Zoom::Frontend::explain_search(mp::Package &package, + std::string &database, + int *error, + char **addinfo, + ODR odr, + std::string &torus_db, + std::string &realm) +{ + m_backend.reset(); + + BackendPtr b(new Backend); + + b->m_frontend_database = database; + b->enable_explain = true; + + Z_GDU *gdu = package.request().get(); + Z_APDU *apdu_req = gdu->u.z3950; + Z_APDU *apdu_res = 0; + Z_SearchRequest *sr = apdu_req->u.searchRequest; + Z_Query *query = sr->query; + + if (query->which == Z_Query_type_104 && + query->u.type_104->which == Z_External_CQL) + { + std::string torus_url = m_p->torus_searchable_url; + std::string torus_query(query->u.type_104->u.cql); + xmlDoc *doc = mp::get_searchable(package, torus_url, "", + torus_query, + realm, m_p->proxy); + if (m_p->explain_xsp) + { + xmlDoc *rec_res = xsltApplyStylesheet(m_p->explain_xsp, doc, 0); + + xmlFreeDoc(doc); + doc = rec_res; + } + *error = YAZ_BIB1_QUERY_TYPE_UNSUPP; + *addinfo = odr_strdup(odr, "CQL, IR-Explain---1"); + + xmlChar *buf_out = 0; + int len_out; + xmlDocDumpMemory(doc, &buf_out, &len_out); + + fwrite(buf_out, 1, len_out, yaz_log_file()); + + xmlFree(buf_out); + if (b->explain_doc) + xmlFreeDoc(b->explain_doc); + b->explain_doc = doc; + return m_backend; + } + else + { + *error = YAZ_BIB1_QUERY_TYPE_UNSUPP; + *addinfo = odr_strdup(odr, "RPN/CCL, IR-Explain---1"); + return m_backend; + } +} + void yf::Zoom::Frontend::handle_search(mp::Package &package) { Z_GDU *gdu = package.request().get(); @@ -1302,24 +1546,37 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) Z_SearchRequest *sr = apdu_req->u.searchRequest; if (sr->num_databaseNames != 1) { - apdu_res = odr.create_searchResponse( - apdu_req, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0); + int error = YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED; + log_diagnostic(package, error, 0); + apdu_res = odr.create_searchResponse(apdu_req, error, 0); package.response() = apdu_res; return; } + int proxy_step = 0; + +next_proxy: int error = 0; char *addinfo = 0; std::string db(sr->databaseNames[0]); + BackendPtr b = get_backend_from_databases(package, db, &error, - &addinfo, odr); + &addinfo, odr, &proxy_step); + if (error && proxy_step) + { + package.log("zoom", YLOG_WARN, + "create backend failed: trying next proxy"); + goto next_proxy; + } if (error) { - apdu_res = - odr.create_searchResponse(apdu_req, error, addinfo); + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; return; } + if (b->enable_explain) + return; b->set_option("setname", "default"); @@ -1357,13 +1614,15 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) const char *cql = query->u.type_104->u.cql; CQL_parser cp = cql_parser_create(); int r = cql_parser_string(cp, cql); + package.log("zoom", YLOG_LOG, "CQL: %s", cql); if (r) { cql_parser_destroy(cp); + error = YAZ_BIB1_MALFORMED_QUERY; + const char *addinfo = "CQL syntax error"; + log_diagnostic(package, error, addinfo); apdu_res = - odr.create_searchResponse(apdu_req, - YAZ_BIB1_MALFORMED_QUERY, - "CQL syntax error"); + odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; return; } @@ -1372,82 +1631,94 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) if (cn_error) { // hopefully we are getting a ptr to a index+relation+term node + error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE; addinfo = 0; if (cn_error->which == CQL_NODE_ST) addinfo = cn_error->u.st.index; - - apdu_res = - odr.create_searchResponse(apdu_req, - YAZ_BIB1_UNSUPP_USE_ATTRIBUTE, - addinfo); + + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; + cql_parser_destroy(cp); return; } char ccl_buf[1024]; - r = cql_to_ccl_buf(cn, ccl_buf, sizeof(ccl_buf)); - if (r == 0) + if (r) { - ccl_wrbuf = wrbuf_alloc(); - wrbuf_puts(ccl_wrbuf, ccl_buf); - - WRBUF sru_sortkeys_wrbuf = wrbuf_alloc(); + error = YAZ_BIB1_MALFORMED_QUERY; + const char *addinfo = "CQL to CCL conversion error"; - cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf); - WRBUF sort_spec_wrbuf = wrbuf_alloc(); - yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf), - sort_spec_wrbuf); - wrbuf_destroy(sru_sortkeys_wrbuf); + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); + package.response() = apdu_res; + cql_parser_destroy(cp); + return; + } - yaz_tok_cfg_t tc = yaz_tok_cfg_create(); - yaz_tok_parse_t tp = - yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf)); - yaz_tok_cfg_destroy(tc); + WRBUF sru_sortkeys_wrbuf = wrbuf_alloc(); + if (cql_sortby_to_sortkeys(cn, wrbuf_vp_puts, sru_sortkeys_wrbuf)) + { + error = YAZ_BIB1_ILLEGAL_SORT_RELATION; + const char *addinfo = "CQL to CCL sortby conversion"; + + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); + package.response() = apdu_res; + wrbuf_destroy(sru_sortkeys_wrbuf); + cql_parser_destroy(cp); + return; + } + WRBUF sort_spec_wrbuf = wrbuf_alloc(); + yaz_srw_sortkeys_to_sort_spec(wrbuf_cstr(sru_sortkeys_wrbuf), + sort_spec_wrbuf); + wrbuf_destroy(sru_sortkeys_wrbuf); - /* go through sortspec and map fields */ - int token = yaz_tok_move(tp); - while (token != YAZ_TOK_EOF) + ccl_wrbuf = wrbuf_alloc(); + wrbuf_puts(ccl_wrbuf, ccl_buf); + + yaz_tok_cfg_t tc = yaz_tok_cfg_create(); + yaz_tok_parse_t tp = + yaz_tok_parse_buf(tc, wrbuf_cstr(sort_spec_wrbuf)); + yaz_tok_cfg_destroy(tc); + + /* go through sortspec and map fields */ + int token = yaz_tok_move(tp); + while (token != YAZ_TOK_EOF) + { + if (token == YAZ_TOK_STRING) + { + const char *field = yaz_tok_parse_string(tp); + std::map::iterator it; + it = b->sptr->sortmap.find(field); + if (it != b->sptr->sortmap.end()) + sortkeys += it->second; + else + sortkeys += field; + } + sortkeys += " "; + token = yaz_tok_move(tp); + if (token == YAZ_TOK_STRING) + { + sortkeys += yaz_tok_parse_string(tp); + } + if (token != YAZ_TOK_EOF) { - if (token == YAZ_TOK_STRING) - { - const char *field = yaz_tok_parse_string(tp); - std::map::iterator it; - it = b->sptr->sortmap.find(field); - if (it != b->sptr->sortmap.end()) - sortkeys += it->second; - else - sortkeys += field; - } sortkeys += " "; token = yaz_tok_move(tp); - if (token == YAZ_TOK_STRING) - { - sortkeys += yaz_tok_parse_string(tp); - } - if (token != YAZ_TOK_EOF) - { - sortkeys += " "; - token = yaz_tok_move(tp); - } } - yaz_tok_parse_destroy(tp); - wrbuf_destroy(sort_spec_wrbuf); } + yaz_tok_parse_destroy(tp); + wrbuf_destroy(sort_spec_wrbuf); + cql_parser_destroy(cp); - if (r) - { - apdu_res = - odr.create_searchResponse(apdu_req, - YAZ_BIB1_MALFORMED_QUERY, - "CQL to CCL conversion error"); - package.response() = apdu_res; - return; - } } else { - apdu_res = - odr.create_searchResponse(apdu_req, YAZ_BIB1_QUERY_TYPE_UNSUPP, 0); + error = YAZ_BIB1_QUERY_TYPE_UNSUPP; + const char *addinfo = 0; + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; return; } @@ -1465,21 +1736,21 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) if (!cn) { char *addinfo = odr_strdup(odr, ccl_err_msg(cerror)); - int z3950_diag = YAZ_BIB1_MALFORMED_QUERY; + error = YAZ_BIB1_MALFORMED_QUERY; switch (cerror) { case CCL_ERR_UNKNOWN_QUAL: - z3950_diag = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE; + error = YAZ_BIB1_UNSUPP_USE_ATTRIBUTE; break; case CCL_ERR_TRUNC_NOT_LEFT: case CCL_ERR_TRUNC_NOT_RIGHT: case CCL_ERR_TRUNC_NOT_BOTH: - z3950_diag = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE; + error = YAZ_BIB1_UNSUPP_TRUNCATION_ATTRIBUTE; break; } - apdu_res = - odr.create_searchResponse(apdu_req, z3950_diag, addinfo); + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; return; } @@ -1529,9 +1800,10 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) wrbuf_destroy(pqf_wrbuf); if (status) { - apdu_res = - odr.create_searchResponse(apdu_req, YAZ_BIB1_MALFORMED_QUERY, - "can not convert from RPN to CQL/SOLR"); + error = YAZ_BIB1_MALFORMED_QUERY; + const char *addinfo = "can not convert from RPN to CQL/SOLR"; + log_diagnostic(package, error, addinfo); + apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; return; } @@ -1545,6 +1817,14 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) wrbuf_destroy(pqf_wrbuf); } + if (error && proxy_step) + { + // reset below prevent reuse in get_backend_from_databases + m_backend.reset(); + package.log("zoom", YLOG_WARN, "search failed: trying next proxy"); + goto next_proxy; + } + const char *element_set_name = 0; Odr_int number_to_present = 0; if (!error) @@ -1552,9 +1832,12 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) Odr_int number_of_records_returned = 0; Z_Records *records = get_records( + package, 0, number_to_present, &error, &addinfo, &number_of_records_returned, odr, b, sr->preferredRecordSyntax, element_set_name); + if (error) + log_diagnostic(package, error, addinfo); apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); if (records) { @@ -1594,19 +1877,31 @@ void yf::Zoom::Frontend::handle_present(mp::Package &package) Odr_int number_of_records_returned = 0; int error = 0; char *addinfo = 0; - Z_Records *records = get_records( - *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested, - &error, &addinfo, &number_of_records_returned, odr, m_backend, - pr->preferredRecordSyntax, element_set_name); - apdu_res = odr.create_presentResponse(apdu_req, error, addinfo); - if (records) + if (m_backend->enable_explain) { - apdu_res->u.presentResponse->records = records; - apdu_res->u.presentResponse->numberOfRecordsReturned = - odr_intdup(odr, number_of_records_returned); + package.response() = odr.create_presentResponse( + apdu_req, YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS, + "IR-Explain---1 fetch not implemented"); + return; + } + else + { + Z_Records *records = + get_records(package, + *pr->resultSetStartPoint - 1, *pr->numberOfRecordsRequested, + &error, &addinfo, &number_of_records_returned, odr, m_backend, + pr->preferredRecordSyntax, element_set_name); + + apdu_res = odr.create_presentResponse(apdu_req, error, addinfo); + if (records) + { + apdu_res->u.presentResponse->records = records; + apdu_res->u.presentResponse->numberOfRecordsReturned = + odr_intdup(odr, number_of_records_returned); + } + package.response() = apdu_res; } - package.response() = apdu_res; } void yf::Zoom::Frontend::handle_package(mp::Package &package) @@ -1617,6 +1912,9 @@ void yf::Zoom::Frontend::handle_package(mp::Package &package) else if (gdu->which == Z_GDU_Z3950) { Z_APDU *apdu_req = gdu->u.z3950; + + if (m_backend) + wrbuf_rewind(m_backend->m_apdu_wrbuf); if (apdu_req->which == Z_APDU_initRequest) { mp::odr odr; @@ -1642,6 +1940,11 @@ void yf::Zoom::Frontend::handle_package(mp::Package &package) "zoom filter cannot handle this APDU"); package.session().close(); } + if (m_backend) + { + WRBUF w = m_backend->m_apdu_wrbuf; + package.log_write(wrbuf_buf(w), wrbuf_len(w)); + } } else {