X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=src%2Ffilter_sru_to_z3950.cpp;h=91191bb0fc94e62be123d578e7933a4f31eabef7;hb=a261f885073190e8de7ebe07870bc8e4d048f1e0;hp=d8469c97214f5ffef4dc638af6d831eab9e39d31;hpb=5f2548e1ed0e214ad7f921e292fc23224cf4cff4;p=metaproxy-moved-to-github.git diff --git a/src/filter_sru_to_z3950.cpp b/src/filter_sru_to_z3950.cpp index d8469c9..91191bb 100644 --- a/src/filter_sru_to_z3950.cpp +++ b/src/filter_sru_to_z3950.cpp @@ -1,8 +1,20 @@ -/* $Id: filter_sru_to_z3950.cpp,v 1.17 2006-10-02 12:01:06 marc Exp $ - Copyright (c) 2005-2006, Index Data. +/* This file is part of Metaproxy. + Copyright (C) 2005-2008 Index Data - See the LICENSE file for details - */ +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 +Software Foundation; either version 2, or (at your option) any later +version. + +Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +*/ #include "config.hpp" #include "filter.hpp" @@ -16,86 +28,79 @@ #include #include #include +#include +#include #include +#include #include #include #include - +#include +#include namespace mp = metaproxy_1; namespace mp_util = metaproxy_1::util; namespace yf = mp::filter; - namespace metaproxy_1 { namespace filter { class SRUtoZ3950::Impl { public: void configure(const xmlNode *xmlnode); - void process(metaproxy_1::Package &package) const; + void process(metaproxy_1::Package &package); private: union SRW_query {char * cql; char * xcql; char * pqf;}; typedef const int& SRW_query_type; + std::map m_database_explain; + + typedef std::map ActiveUrlMap; + + boost::mutex m_mutex; + boost::condition m_cond_url_ready; + ActiveUrlMap m_active_urls; private: - std::string sru_protocol(const Z_HTTP_Request &http_req) const; - std::string debug_http(const Z_HTTP_Request &http_req) const; - void http_response(mp::Package &package, - const std::string &content, - int http_code = 200) const; - bool build_sru_debug_package(mp::Package &package) const; - bool build_simple_explain(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_explainRequest const *er_req) - const; - bool build_sru_response(mp::Package &package, - mp::odr &odr_en, - Z_SOAP *soap, - const Z_SRW_PDU *sru_pdu_res, - char *charset, - const char *stylesheet) const; - Z_SRW_PDU * decode_sru_request(mp::Package &package, - mp::odr &odr_de, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SOAP *&soap, - char *charset, - char *stylesheet) const; - bool check_sru_query_exists(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) const; + void sru(metaproxy_1::Package &package, Z_GDU *zgdu_req); bool z3950_build_query(mp::odr &odr_en, Z_Query *z_query, const SRW_query &query, SRW_query_type query_type) const; + bool z3950_init_request(mp::Package &package, - const std::string - &database = "Default") const; + mp::odr &odr_en, + std::string zurl, + Z_SRW_PDU *sru_pdu_res) const; + bool z3950_close_request(mp::Package &package) const; - bool z3950_search_request(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) const; - bool z3950_present_request(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) const; + + bool z3950_search_request( + mp::Package &package, + mp::odr &odr_en, + Z_SRW_PDU *sru_pdu_res, + Z_SRW_searchRetrieveRequest const *sr_req, + std::string zurl) const; + + bool z3950_present_request( + mp::Package &package, + mp::odr &odr_en, + Z_SRW_PDU *sru_pdu_res, + Z_SRW_searchRetrieveRequest const *sr_req) const; + bool z3950_scan_request(mp::Package &package, mp::odr &odr_en, Z_SRW_PDU *sru_pdu_res, Z_SRW_scanRequest const *sr_req) const; - Z_ElementSetNames * build_esn_from_schema(mp::odr &odr_en, - const char *schema) - const; + + bool z3950_to_srw_diagnostics_ok(mp::odr &odr_en, + Z_SRW_searchRetrieveResponse *srw_res, + Z_Records *records) const; + int z3950_to_srw_diag(mp::odr &odr_en, Z_SRW_searchRetrieveResponse *srw_res, Z_DefaultDiagFormat *ddf) const; + + }; } } @@ -108,7 +113,7 @@ yf::SRUtoZ3950::~SRUtoZ3950() { // must have a destructor because of boost::scoped_ptr } -void yf::SRUtoZ3950::configure(const xmlNode *xmlnode) +void yf::SRUtoZ3950::configure(const xmlNode *xmlnode, bool test_only) { m_p->configure(xmlnode); } @@ -118,93 +123,138 @@ void yf::SRUtoZ3950::process(mp::Package &package) const m_p->process(package); } -void yf::SRUtoZ3950::Impl::configure(const xmlNode *xmlnode) +void yf::SRUtoZ3950::Impl::configure(const xmlNode *confignode) { -} - -void yf::SRUtoZ3950::Impl::process(mp::Package &package) const -{ - Z_GDU *zgdu_req = package.request().get(); - - // ignoring all non HTTP_Request packages - if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){ - package.move(); - return; - } + const xmlNode * dbnode; - // only working on HTTP_Request packages now + for (dbnode = confignode->children; dbnode; dbnode = dbnode->next){ + if (dbnode->type != XML_ELEMENT_NODE) + continue; + + std::string database; + mp::xml::check_element_mp(dbnode, "database"); + for (struct _xmlAttr *attr = dbnode->properties; + attr; attr = attr->next){ + + mp::xml::check_attribute(attr, "", "name"); + database = mp::xml::get_text(attr); + + const xmlNode *explainnode; + for (explainnode = dbnode->children; + explainnode; explainnode = explainnode->next){ + if (explainnode->type != XML_ELEMENT_NODE) + continue; + if (explainnode) + break; + } + // assigning explain node to database name - no check yet + m_database_explain.insert(std::make_pair(database, explainnode)); + } + } +} - // TODO: Z3950 response parsing and translation to SRU package +void yf::SRUtoZ3950::Impl::sru(mp::Package &package, Z_GDU *zgdu_req) +{ bool ok = true; mp::odr odr_de(ODR_DECODE); Z_SRW_PDU *sru_pdu_req = 0; mp::odr odr_en(ODR_ENCODE); - //Z_SRW_PDU *sru_pdu_res = 0; Z_SRW_PDU *sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response); + // determine database with the HTTP header information only + mp_util::SRUServerInfo sruinfo = mp_util::get_sru_server_info(package); + std::map::iterator idbexp; + idbexp = m_database_explain.find(sruinfo.database); + + // assign explain config XML DOM node if database is known + const xmlNode *explainnode = 0; + if (idbexp != m_database_explain.end()){ + explainnode = idbexp->second; + } + // just moving package if database is not known + else { + package.move(); + return; + } + + + // decode SRU request Z_SOAP *soap = 0; char *charset = 0; char *stylesheet = 0; - if (! (sru_pdu_req = decode_sru_request(package, odr_de, odr_en, - sru_pdu_res, soap, + // filter acts as sink for non-valid SRU requests + if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en, + sru_pdu_res, &soap, charset, stylesheet))) { - build_sru_response(package, odr_en, soap, - sru_pdu_res, charset, stylesheet); - package.session().close(); + if (soap) + { + mp_util::build_sru_explain(package, odr_en, sru_pdu_res, + sruinfo, explainnode); + mp_util::build_sru_response(package, odr_en, soap, + sru_pdu_res, charset, stylesheet); + } + else + { + metaproxy_1::odr odr; + Z_GDU *zgdu_res = + odr.create_HTTP_Response(package.session(), + zgdu_req->u.HTTP_Request, 400); + package.response() = zgdu_res; + } return; } - - // SRU request package translation to Z3950 package - if (sru_pdu_req) - std::cout << *sru_pdu_req << "\n"; - else - std::cout << "SRU empty\n"; - + std::string zurl; + Z_SRW_extra_arg *arg; + + for ( arg = sru_pdu_req->extra_args; arg; arg = arg->next) + if (!strcmp(arg->name, "x-target")) + { + zurl = std::string(arg->value); + } - // explain + + // filter acts as sink for SRU explain requests if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request) { Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request; - //sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response); - - build_simple_explain(package, odr_en, sru_pdu_res, er_req); + //mp_util::build_simple_explain(package, odr_en, sru_pdu_res, + // sruinfo, er_req); + mp_util::build_sru_explain(package, odr_en, sru_pdu_res, + sruinfo, explainnode, er_req); } - - // searchRetrieve else if (sru_pdu_req && sru_pdu_req->which == Z_SRW_searchRetrieve_request && sru_pdu_req->u.request) - { + { // searchRetrieve Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request; sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response); // checking that we have a query - ok = check_sru_query_exists(package, odr_en, sru_pdu_res, sr_req); + ok = mp_util::check_sru_query_exists(package, odr_en, + sru_pdu_res, sr_req); - if (ok && z3950_init_request(package)) + if (ok && z3950_init_request(package, odr_en, zurl, sru_pdu_res)) { - { - ok = z3950_search_request(package, odr_en, - sru_pdu_res, sr_req); - - if (ok - && sru_pdu_res->u.response->numberOfRecords - && *(sru_pdu_res->u.response->numberOfRecords) - && sr_req->maximumRecords - && *(sr_req->maximumRecords)) - - ok = z3950_present_request(package, odr_en, - sru_pdu_res, - sr_req); - z3950_close_request(package); - } + ok = z3950_search_request(package, odr_en, + sru_pdu_res, sr_req, zurl); + + if (ok + && sru_pdu_res->u.response->numberOfRecords + && *(sru_pdu_res->u.response->numberOfRecords) + && sr_req->maximumRecords + && *(sr_req->maximumRecords)) + + ok = z3950_present_request(package, odr_en, + sru_pdu_res, + sr_req); + z3950_close_request(package); } } @@ -217,7 +267,14 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response); - if (z3950_init_request(package)) + // we do not do scan at the moment, therefore issuing a diagnostic + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.scan_response->diagnostics), + &(sru_pdu_res->u.scan_response->num_diagnostics), + YAZ_SRW_UNSUPP_OPERATION, "scan"); + + // to be used when we do scan + if (false && z3950_init_request(package, odr_en, zurl, sru_pdu_res)) { z3950_scan_request(package, odr_en, sru_pdu_res, sr_req); z3950_close_request(package); @@ -225,297 +282,74 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const } else { - std::cout << "SRU OPERATION NOT SUPPORTED \n"; + //std::cout << "SRU OPERATION NOT SUPPORTED \n"; sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response); // TODO: make nice diagnostic return package - package.session().close(); return; } - //build_sru_debug_package(package); - build_sru_response(package, odr_en, soap, - sru_pdu_res, charset, stylesheet); - return; - - - - - - - -} - - -bool yf::SRUtoZ3950::Impl::build_simple_explain(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_explainRequest - const *er_req) const -{ - - - - // z3950'fy recordPacking - int record_packing = Z_SRW_recordPacking_XML; - if (er_req->recordPacking && 's' == *(er_req->recordPacking)) - record_packing = Z_SRW_recordPacking_string; - - // getting database info - std::string database("Default"); - if (er_req->database) - database = er_req->database; - - // getting host and port info - std::string host = package.origin().listen_host(); - std::string port = mp_util::to_string(package.origin().listen_port()); - - // overwriting host and port info if set from HTTP Host header - Z_GDU *zgdu_req = package.request().get(); - if (zgdu_req && zgdu_req->which == Z_GDU_HTTP_Request) - { - Z_HTTP_Request* http_req = zgdu_req->u.HTTP_Request; - if (http_req) - { - std::string http_host_address - = mp_util::http_header_value(http_req->headers, "Host"); - - std::string::size_type i = http_host_address.rfind(":"); - if (i != std::string::npos) - { - host.assign(http_host_address, 0, i); - port.assign(http_host_address, i + 1, std::string::npos); - } - } - } - - // building SRU explain record - std::string explain_xml - = mp_util::to_string( - "\n" - " \n" - " ") - + host - + mp_util::to_string("\n" - " ") - + port - + mp_util::to_string("\n" - " ") - + database - + mp_util::to_string("\n" - " \n" - "\n"); - - - // preparing explain record insert - Z_SRW_explainResponse *sru_res = sru_pdu_res->u.explain_response; - //sru_res->record - // = (Z_SRW_record *) odr_malloc(odr_en, sizeof(Z_SRW_record)); - - // inserting one and only explain record - - sru_res->record.recordPosition = odr_intdup(odr_en, 1); - sru_res->record.recordPacking = record_packing; - sru_res->record.recordSchema = "http://explain.z3950.org/dtd/2.0/"; - sru_res->record.recordData_len = 1 + explain_xml.size(); - sru_res->record.recordData_buf - = odr_strdupn(odr_en, (const char *)explain_xml.c_str(), - 1 + explain_xml.size()); - - return true; -}; - - -bool yf::SRUtoZ3950::Impl::build_sru_debug_package(mp::Package &package) const -{ - Z_GDU *zgdu_req = package.request().get(); - if (zgdu_req && zgdu_req->which == Z_GDU_HTTP_Request) - { - Z_HTTP_Request* http_req = zgdu_req->u.HTTP_Request; - std::string content = debug_http(*http_req); - int http_code = 400; - http_response(package, content, http_code); - return true; - } - package.session().close(); - return false; + // build and send SRU response + mp_util::build_sru_response(package, odr_en, soap, + sru_pdu_res, charset, stylesheet); } -bool yf::SRUtoZ3950::Impl::build_sru_response(mp::Package &package, - mp::odr &odr_en, - Z_SOAP *soap, - const Z_SRW_PDU *sru_pdu_res, - char *charset, - const char *stylesheet) - const +void yf::SRUtoZ3950::Impl::process(mp::Package &package) { - - // SRU request package translation to Z3950 package - if (sru_pdu_res) - std::cout << *(const_cast(sru_pdu_res)) << "\n"; - else - std::cout << "SRU empty\n"; - - Z_GDU *zgdu_req = package.request().get(); - if (zgdu_req && zgdu_req->which == Z_GDU_HTTP_Request) - { - Z_GDU *zgdu_res //= z_get_HTTP_Response(odr_en, 200); - = odr_en.create_HTTP_Response(package.session(), - zgdu_req->u.HTTP_Request, - 200); - - // adding HTTP response code and headers - Z_HTTP_Response * http_res = zgdu_res->u.HTTP_Response; - //http_res->code = http_code; - - std::string ctype("text/xml"); - if (charset){ - ctype += "; charset="; - ctype += charset; - } - z_HTTP_header_add(odr_en, - &http_res->headers, "Content-Type", ctype.c_str()); - - // packaging Z_SOAP into HTML response - static Z_SOAP_Handler soap_handlers[4] = { - {"http://www.loc.gov/zing/srw/", 0, - (Z_SOAP_fun) yaz_srw_codec}, - {"http://www.loc.gov/zing/srw/v1.0/", 0, - (Z_SOAP_fun) yaz_srw_codec}, - {"http://www.loc.gov/zing/srw/update/", 0, - (Z_SOAP_fun) yaz_ucp_codec}, - {0, 0, 0} - }; - - - // empty stylesheet means NO stylesheet - if (stylesheet && *stylesheet == '\0') - stylesheet = 0; - - // encoding SRU package - - soap->u.generic->p = (void*) sru_pdu_res; - //int ret = - z_soap_codec_enc_xsl(odr_en, &soap, - &http_res->content_buf, &http_res->content_len, - soap_handlers, charset, stylesheet); - - - package.response() = zgdu_res; - return true; + // ignoring all non HTTP_Request packages + if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){ + package.move(); + return; } - package.session().close(); - return false; -} - - - - Z_SRW_PDU * yf::SRUtoZ3950::Impl::decode_sru_request(mp::Package &package, - mp::odr &odr_de, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SOAP *&soap, - char *charset, - char *stylesheet) - const -{ - Z_GDU *zgdu_req = package.request().get(); - Z_SRW_PDU *sru_pdu_req = 0; - - assert((zgdu_req->which == Z_GDU_HTTP_Request)); - - //ignoring all non HTTP_Request packages - //if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){ - // return 0; - //} - Z_HTTP_Request* http_req = zgdu_req->u.HTTP_Request; - if (! http_req) - return 0; + // only working on HTTP_Request packages now - //Z_SRW_PDU *sru_pdu_res_exp = yaz_srw_get(odr_en, Z_SRW_explain_response); - - if (0 == yaz_sru_decode(http_req, &sru_pdu_req, &soap, - odr_de, &charset, - &(sru_pdu_res->u.response->diagnostics), - &(sru_pdu_res->u.response->num_diagnostics))) + // see if HTTP request is already being executed.. + // we consider only the SRU - GET case.. + if (zgdu_req->u.HTTP_Request->content_len == 0) { - if (sru_pdu_res->u.response->num_diagnostics) + const char *path = zgdu_req->u.HTTP_Request->path; + boost::mutex::scoped_lock lock(m_mutex); + while (1) { - //sru_pdu_res = sru_pdu_res_exp; - package.session().close(); - return 0; + ActiveUrlMap::iterator it = m_active_urls.find(path); + if (it == m_active_urls.end()) + { + m_active_urls[path] = 1; + break; + } + yaz_log(YLOG_LOG, "Waiting for %s to complete", path); + m_cond_url_ready.wait(lock); } - return sru_pdu_req; } - else if (0 == yaz_srw_decode(http_req, &sru_pdu_req, &soap, - odr_de, &charset)) - return sru_pdu_req; - else + sru(package, zgdu_req); + if (zgdu_req->u.HTTP_Request->content_len == 0) { - //sru_pdu_res = sru_pdu_res_exp; - package.session().close(); - return 0; - } - return 0; -} + const char *path = zgdu_req->u.HTTP_Request->path; + boost::mutex::scoped_lock lock(m_mutex); -bool -yf::SRUtoZ3950::Impl::check_sru_query_exists(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) - const -{ - if( (sr_req->query_type == Z_SRW_query_type_cql && !sr_req->query.cql) ) - { - yaz_add_srw_diagnostic(odr_en, - &(sru_pdu_res->u.response->diagnostics), - &(sru_pdu_res->u.response->num_diagnostics), - 7, "query"); - yaz_add_srw_diagnostic(odr_en, - &(sru_pdu_res->u.response->diagnostics), - &(sru_pdu_res->u.response->num_diagnostics), - 10, "CQL query is empty"); - return false; - } - if( (sr_req->query_type == Z_SRW_query_type_xcql && !sr_req->query.xcql) ) - { - yaz_add_srw_diagnostic(odr_en, - &(sru_pdu_res->u.response->diagnostics), - &(sru_pdu_res->u.response->num_diagnostics), - 10, "XCQL query is empty"); - return false; - } - if( (sr_req->query_type == Z_SRW_query_type_pqf && !sr_req->query.pqf) ) - { - yaz_add_srw_diagnostic(odr_en, - &(sru_pdu_res->u.response->diagnostics), - &(sru_pdu_res->u.response->num_diagnostics), - 10, "PQF query is empty"); - return false; - } - return true; -}; + ActiveUrlMap::iterator it = m_active_urls.find(path); + m_active_urls.erase(it); + m_cond_url_ready.notify_all(); + } +} bool yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package, - const std::string &database) const + mp::odr &odr_en, + std::string zurl, + Z_SRW_PDU *sru_pdu_res) const { // prepare Z3950 package - //Session s; - //Package z3950_package(s, package.origin()); Package z3950_package(package.session(), package.origin()); z3950_package.copy_filter(package); // set initRequest APDU - mp::odr odr_en(ODR_ENCODE); Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest); Z_InitRequest *init_req = apdu->u.initRequest; //TODO: add user name in apdu @@ -534,15 +368,25 @@ yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package, ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2); ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3); + if (zurl.length()) + { + std::string host; + std::list dblist; + mp_util::split_zurl(zurl, host, dblist); + mp_util::set_vhost_otherinfo(&init_req->otherInfo, odr_en, host, 1); + } + z3950_package.request() = apdu; // send Z3950 package - // std::cout << "z3950_init_request " << *apdu <<"\n"; z3950_package.move(); // dead Z3950 backend detection if (z3950_package.session().is_closed()){ - package.session().close(); + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.response->diagnostics), + &(sru_pdu_res->u.response->num_diagnostics), + YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0); return false; } @@ -550,18 +394,20 @@ yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package, Z_GDU *z3950_gdu = z3950_package.response().get(); if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950 - && z3950_gdu->u.z3950->which == Z_APDU_initResponse) + && z3950_gdu->u.z3950->which == Z_APDU_initResponse + && *z3950_gdu->u.z3950->u.initResponse->result) return true; + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.response->diagnostics), + &(sru_pdu_res->u.response->num_diagnostics), + YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0); return false; } bool yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const { - // close SRU package - package.session().close(); - // prepare and close Z3950 package Package z3950_package(package.session(), package.origin()); z3950_package.copy_filter(package); @@ -586,13 +432,16 @@ yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const return false; } -bool -yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) const +bool yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package, + mp::odr &odr_en, + Z_SRW_PDU *sru_pdu_res, + Z_SRW_searchRetrieveRequest + const *sr_req, + std::string zurl) const { + + assert(sru_pdu_res->u.response); + Package z3950_package(package.session(), package.origin()); z3950_package.copy_filter(package); @@ -600,18 +449,22 @@ yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package, Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest); Z_SearchRequest *z_searchRequest = apdu->u.searchRequest; - // z3950'fy database - z_searchRequest->num_databaseNames = 1; - z_searchRequest->databaseNames = (char**) - odr_malloc(odr_en, sizeof(char *)); - if (sr_req->database) - z_searchRequest->databaseNames[0] - = odr_strdup(odr_en, const_cast(sr_req->database)); - else - z_searchRequest->databaseNames[0] + if (!mp_util::set_databases_from_zurl(odr_en, zurl, + &z_searchRequest->num_databaseNames, + &z_searchRequest->databaseNames)) + { + z_searchRequest->num_databaseNames = 1; + z_searchRequest->databaseNames = (char**) + odr_malloc(odr_en, sizeof(char *)); + + if (sr_req->database) + z_searchRequest->databaseNames[0] + = odr_strdup(odr_en, const_cast(sr_req->database)); + else + z_searchRequest->databaseNames[0] = odr_strdup(odr_en, "Default"); - + } // z3950'fy query Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query)); @@ -621,75 +474,85 @@ yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package, (const SRW_query&)sr_req->query, sr_req->query_type)) { - //send_to_srw_client_error(7, "query"); + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.response->diagnostics), + &(sru_pdu_res->u.response->num_diagnostics), + 7, "query"); return false; } z3950_package.request() = apdu; - //std::cout << "z3950_search_request " << *apdu << "\n"; + // send Z39.50 package off to backend z3950_package.move(); Z_GDU *z3950_gdu = z3950_package.response().get(); - //std::cout << "z3950_search_request " << *z3950_gdu << "\n"; //TODO: check success condition - //int yaz_diag_bib1_to_srw (int bib1_code); //int yaz_diag_srw_to_bib1(int srw_code); //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init). - if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950 - && z3950_gdu->u.z3950->which == Z_APDU_searchResponse - && z3950_gdu->u.z3950->u.searchResponse->searchStatus) + if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950 + || z3950_gdu->u.z3950->which != Z_APDU_searchResponse + || !z3950_gdu->u.z3950->u.searchResponse + || !z3950_gdu->u.z3950->u.searchResponse->searchStatus) { + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.response->diagnostics), + &(sru_pdu_res->u.response->num_diagnostics), + 2, 0); + return false; + } + + // everything fine, continuing + Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse; - Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse; - if (sr) - { - // srw'fy number of records - sru_pdu_res->u.response->numberOfRecords - = (int *) odr_malloc(odr_en, sizeof(int *)); - *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount); - - // srw'fy nextRecordPosition - //sru_pdu_res->u.response->nextRecordPosition - // = (int *) odr_malloc(odr_en, sizeof(int *)); - //*(sru_pdu_res->u.response->nextRecordPosition) = 1; - - } - - return true; + // checking non surrogate diagnostics in Z3950 search response package + if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response, + sr->records)) + { + return false; } + + // Finally, roll on and srw'fy number of records + sru_pdu_res->u.response->numberOfRecords + = (int *) odr_malloc(odr_en, sizeof(int *)); + *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount); - return false; + // srw'fy nextRecordPosition + //sru_pdu_res->u.response->nextRecordPosition + // = (int *) odr_malloc(odr_en, sizeof(int *)); + //*(sru_pdu_res->u.response->nextRecordPosition) = 1; + + return true; } bool yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, - mp::odr &odr_en, - Z_SRW_PDU *sru_pdu_res, - Z_SRW_searchRetrieveRequest - const *sr_req) + mp::odr &odr_en, + Z_SRW_PDU *sru_pdu_res, + Z_SRW_searchRetrieveRequest + const *sr_req) const { + assert(sru_pdu_res->u.response); + int start = 1; + int max_recs = 0; if (!sr_req) return false; - + if (sr_req->maximumRecords) + max_recs = *sr_req->maximumRecords; + if (sr_req->startRecord) + start = *sr_req->startRecord; + // no need to work if nobody wants record .. - if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords)) + if (max_recs == 0) return true; - // creating Z3950 package - Package z3950_package(package.session(), package.origin()); - z3950_package.copy_filter(package); - Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest); - - assert(apdu->u.presentRequest); - bool send_z3950_present = true; // recordXPath unsupported. @@ -699,7 +562,7 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), &(sru_pdu_res->u.response->num_diagnostics), - 72, 0); + YAZ_SRW_XPATH_RETRIEVAL_UNSUPP, 0); } // resultSetTTL unsupported. @@ -710,7 +573,7 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), &(sru_pdu_res->u.response->num_diagnostics), - 50, 0); + YAZ_SRW_RESULT_SETS_UNSUPP, 0); } // sort unsupported @@ -720,20 +583,28 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), &(sru_pdu_res->u.response->num_diagnostics), - 80, 0); + YAZ_SRW_SORT_UNSUPP, 0); } - // start record requested larger than number of records - if (sr_req->startRecord - && sru_pdu_res->u.response->numberOfRecords - && *(sr_req->startRecord) > *(sru_pdu_res->u.response->numberOfRecords)) + // start record requested negative, or larger than number of records + if (start < 0 || start > *sru_pdu_res->u.response->numberOfRecords) { - // = *(sr_req->startRecord); send_z3950_present = false; yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), &(sru_pdu_res->u.response->num_diagnostics), - 61, 0); + YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0); + } + + // maximumRecords requested negative + if (max_recs < 0) + { + send_z3950_present = false; + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.response->diagnostics), + &(sru_pdu_res->u.response->num_diagnostics), + YAZ_SRW_UNSUPP_PARAMETER_VALUE, + "maximumRecords"); } // exit on all these above diagnostics @@ -741,38 +612,43 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, return false; // now packaging the z3950 present request + Package z3950_package(package.session(), package.origin()); + z3950_package.copy_filter(package); + Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest); + + assert(apdu->u.presentRequest); // z3950'fy start record position - if (sr_req->startRecord) - *(apdu->u.presentRequest->resultSetStartPoint) - = *(sr_req->startRecord); - else - *(apdu->u.presentRequest->resultSetStartPoint) = 1; + *apdu->u.presentRequest->resultSetStartPoint = start; // z3950'fy number of records requested - if (sr_req->maximumRecords) - *(apdu->u.presentRequest->numberOfRecordsRequested) - = *(sr_req->maximumRecords); - + // protect against requesting records out of range + *apdu->u.presentRequest->numberOfRecordsRequested + = std::min(max_recs, + *sru_pdu_res->u.response->numberOfRecords - start + 1); + // z3950'fy recordPacking int record_packing = Z_SRW_recordPacking_XML; if (sr_req->recordPacking && 's' == *(sr_req->recordPacking)) record_packing = Z_SRW_recordPacking_string; - + // RecordSyntax will always be XML - (apdu->u.presentRequest->preferredRecordSyntax) - = yaz_oidval_to_z3950oid (odr_en, CLASS_RECSYN, VAL_TEXT_XML); + apdu->u.presentRequest->preferredRecordSyntax + = odr_oiddup(odr_en, yaz_oid_recsyn_xml); // z3950'fy record schema - if (sr_req->recordSchema) - { - apdu->u.presentRequest->recordComposition - = (Z_RecordComposition *) odr_malloc(odr_en, sizeof(Z_RecordComposition)); - apdu->u.presentRequest->recordComposition->which - = Z_RecordComp_simple; - apdu->u.presentRequest->recordComposition->u.simple - = build_esn_from_schema(odr_en, (const char *) sr_req->recordSchema); - } + if (sr_req->recordSchema) + { + apdu->u.presentRequest->recordComposition + = (Z_RecordComposition *) + odr_malloc(odr_en, sizeof(Z_RecordComposition)); + apdu->u.presentRequest->recordComposition->which + = Z_RecordComp_simple; + apdu->u.presentRequest->recordComposition->u.simple + = mp_util::build_esn_from_schema(odr_en, + (const char *) + sr_req->recordSchema); + } // z3950'fy time to live - flagged as diagnostics above //if (sr_req->resultSetTTL) @@ -780,7 +656,7 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, // attaching Z3950 package to filter chain z3950_package.request() = apdu; - //std::cout << "z3950_present_request " << *apdu << "\n"; + // sending Z30.50 present request z3950_package.move(); //check successful Z3950 present response @@ -793,27 +669,23 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), &(sru_pdu_res->u.response->num_diagnostics), - 2, 0); - package.session().close(); + YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0); return false; } - + // everything fine, continuing - //std::cout << "z3950_present_request OK\n"; Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse; Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response; - // checking non surrogate dioagnostics in Z3950 present response package - if (pr->records - && pr->records->which == Z_Records_NSD - && pr->records->u.nonSurrogateDiagnostic) - { - //int http_code = - z3950_to_srw_diag(odr_en, sru_res, pr->records->u.nonSurrogateDiagnostic); + + // checking non surrogate diagnostics in Z3950 present response package + if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response, + pr->records)) return false; - } + + // copy all records if existing if (pr->records && pr->records->which == Z_Records_DBOSD) @@ -824,53 +696,53 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, sru_res->records = (Z_SRW_record *) odr_malloc(odr_en, - sru_res->num_records *sizeof(Z_SRW_record)); + sru_res->num_records + * sizeof(Z_SRW_record)); + // srw'fy nextRecordPosition - if (pr->nextResultSetPosition) + // next position never zero or behind the last z3950 record + if (pr->nextResultSetPosition + && *(pr->nextResultSetPosition) > 0 + && *(pr->nextResultSetPosition) + <= *(sru_pdu_res->u.response->numberOfRecords)) sru_res->nextRecordPosition = odr_intdup(odr_en, *(pr->nextResultSetPosition)); - + // inserting all records for (int i = 0; i < sru_res->num_records; i++) { + int position = i + *apdu->u.presentRequest->resultSetStartPoint; Z_NamePlusRecord *npr = pr->records->u.databaseOrSurDiagnostics->records[i]; - sru_res->records[i].recordPosition - = odr_intdup(odr_en, i + *(apdu->u.presentRequest->resultSetStartPoint)); - sru_res->records[i].recordPacking = record_packing; - if (npr->which != Z_NamePlusRecord_databaseRecord) + if (npr->which == Z_NamePlusRecord_databaseRecord && + npr->u.databaseRecord->direct_reference + && !oid_oidcmp(npr->u.databaseRecord->direct_reference, + yaz_oid_recsyn_xml)) { - sru_res->records[i].recordSchema = "diagnostic"; - sru_res->records[i].recordData_buf = "67"; - sru_res->records[i].recordData_len = 2; + // got XML record back + Z_External *r = npr->u.databaseRecord; + sru_res->records[i].recordPosition = + odr_intdup(odr_en, position); + sru_res->records[i].recordSchema = sr_req->recordSchema; + sru_res->records[i].recordData_buf + = odr_strdupn(odr_en, + (const char *)r->u.octet_aligned->buf, + r->u.octet_aligned->len); + sru_res->records[i].recordData_len + = r->u.octet_aligned->len; } else { - Z_External *r = npr->u.databaseRecord; - oident *ent = oid_getentbyoid(r->direct_reference); - if (r->which == Z_External_octet - && ent->value == VAL_TEXT_XML) - { - sru_res->records[i].recordSchema = "dc"; - sru_res->records[i].recordData_buf - = odr_strdupn(odr_en, - (const char *)r->u.octet_aligned->buf, - r->u.octet_aligned->len); - sru_res->records[i].recordData_len - = r->u.octet_aligned->len; - } - else - { - sru_res->records[i].recordSchema = "diagnostic"; - sru_res->records[i].recordData_buf = "67"; - sru_res->records[i].recordData_len = 2; - } - } - } + // not XML or no database record at all + yaz_mk_sru_surrogate( + odr_en, sru_res->records + i, position, + YAZ_SRW_RECORD_NOT_AVAILABLE_IN_THIS_SCHEMA, 0); + } + } } return true; @@ -882,6 +754,8 @@ yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package, Z_SRW_PDU *sru_pdu_res, Z_SRW_scanRequest const *sr_req) const { + assert(sru_pdu_res->u.scan_response); + Package z3950_package(package.session(), package.origin()); z3950_package.copy_filter(package); //mp::odr odr_en(ODR_ENCODE); @@ -981,120 +855,36 @@ bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, } -std::string -yf::SRUtoZ3950::Impl::sru_protocol(const Z_HTTP_Request &http_req) const -{ - const std::string mime_urlencoded("application/x-www-form-urlencoded"); - const std::string mime_text_xml("text/xml"); - const std::string mime_soap_xml("application/soap+xml"); - - const std::string http_method(http_req.method); - const std::string http_type - = mp_util::http_header_value(http_req.headers, "Content-Type"); - - if (http_method == "GET") - return "SRU GET"; - - if (http_method == "POST" - && http_type == mime_urlencoded) - return "SRU POST"; - - if ( http_method == "POST" - && (http_type == mime_text_xml - || http_type == mime_soap_xml)) - return "SRU SOAP"; - - return "HTTP"; -} - -std::string -yf::SRUtoZ3950::Impl::debug_http(const Z_HTTP_Request &http_req) const +bool +yf::SRUtoZ3950::Impl::z3950_to_srw_diagnostics_ok(mp::odr &odr_en, + Z_SRW_searchRetrieveResponse + *sru_res, + Z_Records *records) const { - std::string message("\n\n

" - "Metaproxy SRUtoZ3950 filter" - "

\n"); - - message += "

HTTP Info


\n"; - message += "

\n"; - message += "Method: " + std::string(http_req.method) + "
\n"; - message += "Version: " + std::string(http_req.version) + "
\n"; - message += "Path: " + std::string(http_req.path) + "
\n"; - - message += "Content-Type:" - + mp_util::http_header_value(http_req.headers, "Content-Type") - + "
\n"; - message += "Content-Length:" - + mp_util::http_header_value(http_req.headers, "Content-Length") - + "
\n"; - message += "

\n"; - - message += "

Headers


\n"; - message += "

\n"; - Z_HTTP_Header* header = http_req.headers; - while (header){ - message += "Header: " - + std::string(header->name) + ": " - + std::string(header->value) + "
\n"; - header = header->next; + // checking non surrogate diagnostics in Z3950 present response package + if (records + && records->which == Z_Records_NSD + && records->u.nonSurrogateDiagnostic) + { + z3950_to_srw_diag(odr_en, sru_res, + records->u.nonSurrogateDiagnostic); + return false; } - message += "

\n"; - message += "\n\n"; - return message; -} - -void yf::SRUtoZ3950::Impl::http_response(metaproxy_1::Package &package, - const std::string &content, - int http_code) const -{ - - Z_GDU *zgdu_req = package.request().get(); - Z_GDU *zgdu_res = 0; - mp::odr odr; - zgdu_res - = odr.create_HTTP_Response(package.session(), - zgdu_req->u.HTTP_Request, - http_code); - - zgdu_res->u.HTTP_Response->content_len = content.size(); - zgdu_res->u.HTTP_Response->content_buf - = (char*) odr_malloc(odr, zgdu_res->u.HTTP_Response->content_len); - - strncpy(zgdu_res->u.HTTP_Response->content_buf, - content.c_str(), zgdu_res->u.HTTP_Response->content_len); - - //z_HTTP_header_add(odr, &hres->headers, - // "Content-Type", content_type.c_str()); - package.response() = zgdu_res; + return true; } -Z_ElementSetNames * -yf::SRUtoZ3950::Impl::build_esn_from_schema(mp::odr &odr_en, - const char *schema) const -{ - if (!schema) - return 0; - - Z_ElementSetNames *esn - = (Z_ElementSetNames *) odr_malloc(odr_en, sizeof(Z_ElementSetNames)); - esn->which = Z_ElementSetNames_generic; - esn->u.generic = odr_strdup(odr_en, schema); - return esn; -} - int yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en, Z_SRW_searchRetrieveResponse *sru_res, Z_DefaultDiagFormat *ddf) const { int bib1_code = *ddf->condition; - if (bib1_code == 109) - return 404; sru_res->num_diagnostics = 1; sru_res->diagnostics = (Z_SRW_diagnostic *) odr_malloc(odr_en, sizeof(*sru_res->diagnostics)); yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics, - yaz_diag_bib1_to_srw(*ddf->condition), + yaz_diag_bib1_to_srw(bib1_code), ddf->u.v2Addinfo); return 0; } @@ -1109,7 +899,7 @@ static mp::filter::Base* filter_creator() extern "C" { struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = { 0, - "SRUtoZ3950", + "sru_z3950", filter_creator }; }