X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=src%2Ffilter_zoom.cpp;h=bcd618f98b8c981c6507d08590868b5fe2bc846b;hb=c1915c1645ff4b7ccaa4ec1f0584fdd4371b253c;hp=45ead65fa6b9bfa8f0b288ef098568bb10cce21c;hpb=8085904b5f89768a01a4ddf5eb74b371b6999166;p=metaproxy-moved-to-github.git diff --git a/src/filter_zoom.cpp b/src/filter_zoom.cpp index 45ead65..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 @@ -92,8 +92,11 @@ namespace metaproxy_1 { 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); @@ -115,6 +118,14 @@ 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(mp::Package &package, std::string &database, @@ -129,7 +140,8 @@ namespace metaproxy_1 { char **addinfo, ODR odr, std::string authentication, - std::string proxy); + std::string proxy, + std::string realm); void prepare_elements(BackendPtr b, Odr_oid *preferredRecordSyntax, @@ -184,6 +196,7 @@ namespace metaproxy_1 { std::string element_transform; std::string element_raw; std::string proxy; + xsltStylesheetPtr explain_xsp; std::map s_map; }; } @@ -213,21 +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); } @@ -275,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) @@ -381,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); } @@ -559,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) { @@ -587,6 +612,8 @@ 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 *) @@ -658,6 +685,41 @@ 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, @@ -665,7 +727,8 @@ bool yf::Zoom::Frontend::create_content_session(mp::Package &package, int *error, char **addinfo, ODR odr, std::string authentication, - std::string proxy) + std::string proxy, + std::string realm) { if (b->sptr->contentConnector.length()) { @@ -699,11 +762,14 @@ bool yf::Zoom::Frontend::create_content_session(mp::Package &package, 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; } @@ -738,6 +804,7 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( 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; @@ -771,6 +838,8 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( 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")) { char **dstr; @@ -822,6 +891,11 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( 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; @@ -830,7 +904,9 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( sptr = it->second; else if (torus_url.length() > 0) { + 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) { @@ -943,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); @@ -1001,6 +1079,11 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( out_names[no_out_args] = "subdatabase"; 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 { @@ -1044,11 +1127,12 @@ yf::Zoom::BackendPtr yf::Zoom::Frontend::get_backend_from_databases( } package.log("zoom", YLOG_LOG, "url: %s", url.c_str()); b->connect(url, error, addinfo, odr); - if (*error == 0) + 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); + content_proxy.length() ? content_proxy : proxy, + realm); if (*error == 0) m_backend = b; return b; @@ -1174,8 +1258,6 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package, Z_NamePlusRecord *npr = 0; const char *addinfo; - package.log("zoom", YLOG_LOG, "Inspecting record at position %d", - start + i); int sur_error = ZOOM_record_error(recs[i], 0 /* msg */, &addinfo, 0 /* diagset */); @@ -1266,7 +1348,7 @@ Z_Records *yf::Zoom::Frontend::get_records(Package &package, } } - if (rec_buf) + if (rec_buf && b->enable_cproxy) { xmlDoc *doc = xmlParseMemory(rec_buf, rec_len); std::string res = @@ -1396,6 +1478,65 @@ void yf::Zoom::Frontend::log_diagnostic(mp::Package &package, 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(); @@ -1411,7 +1552,6 @@ void yf::Zoom::Frontend::handle_search(mp::Package &package) package.response() = apdu_res; return; } - int proxy_step = 0; next_proxy: @@ -1435,6 +1575,8 @@ next_proxy: package.response() = apdu_res; return; } + if (b->enable_explain) + return; b->set_option("setname", "default"); @@ -1497,59 +1639,11 @@ next_proxy: 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) - { - ccl_wrbuf = wrbuf_alloc(); - wrbuf_puts(ccl_wrbuf, ccl_buf); - - WRBUF sru_sortkeys_wrbuf = wrbuf_alloc(); - - 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); - - 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) - { - sortkeys += " "; - token = yaz_tok_move(tp); - } - } - yaz_tok_parse_destroy(tp); - wrbuf_destroy(sort_spec_wrbuf); - } - cql_parser_destroy(cp); if (r) { error = YAZ_BIB1_MALFORMED_QUERY; @@ -1558,8 +1652,66 @@ next_proxy: log_diagnostic(package, error, addinfo); apdu_res = odr.create_searchResponse(apdu_req, error, addinfo); package.response() = apdu_res; + cql_parser_destroy(cp); return; } + + 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); + + 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) + { + sortkeys += " "; + token = yaz_tok_move(tp); + } + } + yaz_tok_parse_destroy(tp); + wrbuf_destroy(sort_spec_wrbuf); + + cql_parser_destroy(cp); } else { @@ -1725,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(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) + 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)