X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Ffilter_sru_to_z3950.cpp;h=7ccebd30c824312ce7944b740c8eb4135f05fe1a;hb=e8f88ae9eb36023af537c24847744f57e6bf6c4e;hp=77cfa2144f76643cfc4b530cc2ebdae236be8de8;hpb=3e6cd573da434709745d8ed06e4be45c2f19e283;p=metaproxy-moved-to-github.git diff --git a/src/filter_sru_to_z3950.cpp b/src/filter_sru_to_z3950.cpp index 77cfa21..7ccebd3 100644 --- a/src/filter_sru_to_z3950.cpp +++ b/src/filter_sru_to_z3950.cpp @@ -1,59 +1,115 @@ -/* $Id: filter_sru_to_z3950.cpp,v 1.3 2006-09-13 21:49:34 marc Exp $ - Copyright (c) 2005-2006, Index Data. +/* This file is part of Metaproxy. + Copyright (C) 2005-2009 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 +*/ + +// make std::min actually work on Windows +#define NOMINMAX 1 #include "config.hpp" #include "filter.hpp" #include "package.hpp" #include "util.hpp" +#include "gduutil.hpp" +#include "sru_util.hpp" #include "filter_sru_to_z3950.hpp" #include +#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 -{ - - template - std::string stringify(const T& x) - { - std::ostringstream o; - o << x; - return o.str(); - } -} - - namespace metaproxy_1 { namespace filter { - class SRUtoZ3950::Rep { - //friend class SRUtoZ3950; + class SRUtoZ3950::Impl { public: void configure(const xmlNode *xmlnode); - void process(metaproxy_1::Package &package) const; + void process(metaproxy_1::Package &package); private: - std::string protocol_type(const Z_HTTP_Request &http_req) const; - std::string debug_http(const Z_HTTP_Request &http_req) const; - void http_response(metaproxy_1::Package &package, - const std::string &content, - int http_code = 200) const; + std::map m_database_explain; + + typedef std::map ActiveUrlMap; + + boost::mutex m_mutex; + boost::condition m_cond_url_ready; + ActiveUrlMap m_active_urls; + private: + void sru(metaproxy_1::Package &package, Z_GDU *zgdu_req); + bool z3950_build_query( + mp::odr &odr_en, Z_Query *z_query, + const Z_SRW_searchRetrieveRequest *req + ) const; + + bool z3950_init_request( + mp::Package &package, + mp::odr &odr_en, + std::string zurl, + Z_SRW_PDU *sru_pdu_res, + const Z_SRW_PDU *sru_pdu_req + ) 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, + 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_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; + }; } } -yf::SRUtoZ3950::SRUtoZ3950() : m_p(new Rep) +yf::SRUtoZ3950::SRUtoZ3950() : m_p(new Impl) { } @@ -61,7 +117,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); } @@ -71,160 +127,725 @@ void yf::SRUtoZ3950::process(mp::Package &package) const m_p->process(package); } -void yf::SRUtoZ3950::Rep::configure(const xmlNode *xmlnode) +void yf::SRUtoZ3950::Impl::configure(const xmlNode *confignode) { + const xmlNode * dbnode; + + 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)); + } + } } -void yf::SRUtoZ3950::Rep::process(mp::Package &package) const +void yf::SRUtoZ3950::Impl::sru(mp::Package &package, Z_GDU *zgdu_req) { - Z_GDU *zgdu_req = package.request().get(); + bool ok = true; - // ignoring all non HTTP_Request packages - if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){ + 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 = 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; - + // 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))) + { + 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; + } - // only working on HTTP_Request packages now - Z_HTTP_Request* http_req = zgdu_req->u.HTTP_Request; + 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); + } + else if (!strcmp(arg->name, "x-max-sockets")) + { + package.origin().set_max_sockets(atoi(arg->value)); + } + + assert(sru_pdu_req); + + // filter acts as sink for SRU explain requests + if (sru_pdu_req->which == Z_SRW_explain_request) + { + Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request; + //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); + } + else if (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 = mp_util::check_sru_query_exists(package, odr_en, + sru_pdu_res, sr_req); + + if (ok && z3950_init_request(package, odr_en, + zurl, sru_pdu_res, sru_pdu_req)) + { + 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); + } + } - // TODO: SRU package checking and translation to Z3950 package - - std::cout << protocol_type(*http_req) << "\n"; + // scan + else if (sru_pdu_req->which == Z_SRW_scan_request + && sru_pdu_req->u.scan_request) + { + sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response); + + // 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"); + } + else + { + sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response); + + yaz_add_srw_diagnostic(odr_en, + &(sru_pdu_res->u.explain_response->diagnostics), + &(sru_pdu_res->u.explain_response->num_diagnostics), + YAZ_SRW_UNSUPP_OPERATION, "unknown"); + } - package.move(); - return; + // build and send SRU response + mp_util::build_sru_response(package, odr_en, soap, + sru_pdu_res, charset, stylesheet); +} +void yf::SRUtoZ3950::Impl::process(mp::Package &package) +{ + Z_GDU *zgdu_req = package.request().get(); -// int ret_code = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */ -// Z_SRW_PDU *sru_res = 0; -// Z_SOAP *soap_package = 0; -// char *charset = 0; -// Z_SRW_diagnostic *diagnostic = 0; -// int num_diagnostic = 0; -// mp::odr odr; + // ignoring all non HTTP_Request packages + if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)) + { + package.move(); + return; + } -// ret_code = yaz_sru_decode(http_req, &sru_res, -// &soap_package, odr, &charset, -// &diagnostic, &num_diagnostic))) -// -// ret_code = yaz_srw_decode(http_req, &sru_res, -// &soap_package, odr, &charset))) + // only working on HTTP_Request packages now - + // see if HTTP request is already being executed.. + // we consider only the SRU - GET case.. + if (zgdu_req->u.HTTP_Request->content_len == 0) + { + const char *path = zgdu_req->u.HTTP_Request->path; + boost::mutex::scoped_lock lock(m_mutex); + while (1) + { + 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); + } + } + sru(package, zgdu_req); + if (zgdu_req->u.HTTP_Request->content_len == 0) + { + const char *path = zgdu_req->u.HTTP_Request->path; + boost::mutex::scoped_lock lock(m_mutex); + + ActiveUrlMap::iterator it = m_active_urls.find(path); + m_active_urls.erase(it); + m_cond_url_ready.notify_all(); + } +} - // sending Z3950 package through pipeline - package.move(); +bool +yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package, + mp::odr &odr_en, + std::string zurl, + Z_SRW_PDU *sru_pdu_res, + const Z_SRW_PDU *sru_pdu_req) const +{ + // prepare Z3950 package + Package z3950_package(package.session(), package.origin()); + z3950_package.copy_filter(package); - // TODO: Z3950 response parsing and translation to SRU package - Z_HTTP_Response* http_res = 0; + // set initRequest APDU + Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest); + Z_InitRequest *init_req = apdu->u.initRequest; - std::string content = debug_http(*http_req); - int http_code = 200; + Z_IdAuthentication *auth = NULL; + if (sru_pdu_req->username && !sru_pdu_req->password) + { + auth = (Z_IdAuthentication *) odr_malloc(odr_en, sizeof(Z_IdAuthentication)); + auth->which = Z_IdAuthentication_open; + auth->u.open = odr_strdup(odr_en, sru_pdu_req->username); + } + else if (sru_pdu_req->username && sru_pdu_req->password) + { + auth = (Z_IdAuthentication *) odr_malloc(odr_en, sizeof(Z_IdAuthentication)); + auth->which = Z_IdAuthentication_idPass; + auth->u.idPass = (Z_IdPass *) odr_malloc(odr_en, sizeof(Z_IdPass)); + auth->u.idPass->groupId = NULL; + auth->u.idPass->password = odr_strdup(odr_en, sru_pdu_req->password); + auth->u.idPass->userId = odr_strdup(odr_en, sru_pdu_req->username); + } + + init_req->idAuthentication = auth; - http_response(package, content, http_code); + ODR_MASK_SET(init_req->options, Z_Options_search); + ODR_MASK_SET(init_req->options, Z_Options_present); + ODR_MASK_SET(init_req->options, Z_Options_namedResultSets); + ODR_MASK_SET(init_req->options, Z_Options_scan); + + ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1); + 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 + z3950_package.move(); + + // dead Z3950 backend detection + if (z3950_package.session().is_closed()) + { + 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; + } + + // check successful initResponse + Z_GDU *z3950_gdu = z3950_package.response().get(); - //package.response() = zgdu_res; + if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950 + && 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 +{ + // prepare and close Z3950 package + Package z3950_package(package.session(), package.origin()); + z3950_package.copy_filter(package); + z3950_package.session().close(); + + // set close APDU + //mp::odr odr_en(ODR_ENCODE); + //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close); + //z3950_package.request() = apdu; + + z3950_package.move(); + + // check successful close response + //Z_GDU *z3950_gdu = z3950_package.response().get(); + //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950 + // && z3950_gdu->u.z3950->which == Z_APDU_close) + // return true; + + if (z3950_package.session().is_closed()) + { + return true; + } + return false; } -std::string -yf::SRUtoZ3950::Rep::protocol_type(const Z_HTTP_Request &http_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 { - std::string protocol("HTTP"); - const std::string mime_text_xml("text/xml"); - const std::string mime_soap_xml("application/soap+xml"); - const std::string mime_urlencoded("application/x-www-form-urlencoded"); + assert(sru_pdu_res->u.response); - const std::string http_method(http_req.method); + Package z3950_package(package.session(), package.origin()); + z3950_package.copy_filter(package); - //const std::string http_type(z_HTTP_header_lookup(http_req.headers, - // "Content-Type")); - // TODO: there is a sude condition in the above, fix it in YAZ - const std::string http_type("xyz"); + //add stuff in z3950 apdu + Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest); + Z_SearchRequest *z_searchRequest = apdu->u.searchRequest; - if (http_method == "GET") - return "SRU GET"; - if (http_method == "POST" - && http_type == mime_urlencoded) - return "SRU POST"; + 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)); + z_searchRequest->query = z_query; + + if (!z3950_build_query(odr_en, z_query, sr_req)) + { + 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; + + // send Z39.50 package off to backend + z3950_package.move(); + + + Z_GDU *z3950_gdu = z3950_package.response().get(); + + //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 + || !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; + + // 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 + = odr_intdup(odr_en, *sr->resultCount); - if ( http_method == "POST" - && (http_type == mime_text_xml - || http_type == mime_soap_xml)) - return "SRU SOAP"; + // srw'fy nextRecordPosition + //sru_pdu_res->u.response->nextRecordPosition + // = (int *) odr_malloc(odr_en, sizeof(int *)); + //*(sru_pdu_res->u.response->nextRecordPosition) = 1; - return "HTTP"; + return true; } -std::string -yf::SRUtoZ3950::Rep::debug_http(const Z_HTTP_Request &http_req) 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:" - + std::string(z_HTTP_header_lookup(http_req.headers, "Content-Type")) - + "
\n"; - message += "Content-Length:" - + std::string(z_HTTP_header_lookup(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; - } - message += "

\n"; - message += "\n\n"; - return message; -} - -void yf::SRUtoZ3950::Rep::http_response(metaproxy_1::Package &package, - const std::string &content, - int http_code) const +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) + 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; - 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); + // no need to work if nobody wants record .. + if (max_recs == 0) + return true; + + bool send_z3950_present = true; + + // recordXPath unsupported. + if (sr_req->recordXPath) + { + 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_XPATH_RETRIEVAL_UNSUPP, 0); + } + + // resultSetTTL unsupported. + // resultSetIdleTime in response + if (sr_req->resultSetTTL) + { + 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_RESULT_SETS_UNSUPP, 0); + } + + // sort unsupported + if (sr_req->sort_type != Z_SRW_sort_type_none) + { + 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_SORT_UNSUPP, 0); + } + + // start record requested negative, or larger than number of records + if (start < 0 || start > *sru_pdu_res->u.response->numberOfRecords) + { + 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_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 + if (!send_z3950_present) + 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 + *apdu->u.presentRequest->resultSetStartPoint = start; + + // z3950'fy number of records requested + // protect against requesting records out of range + if (max_recs < *sru_pdu_res->u.response->numberOfRecords - start + 1) + *apdu->u.presentRequest->numberOfRecordsRequested = max_recs; + else + *apdu->u.presentRequest->numberOfRecordsRequested = + *sru_pdu_res->u.response->numberOfRecords - start + 1; - 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); + // z3950'fy recordPacking + int record_packing = Z_SRW_recordPacking_XML; + if (sr_req->recordPacking && 's' == *(sr_req->recordPacking)) + record_packing = Z_SRW_recordPacking_string; - strncpy(zgdu_res->u.HTTP_Response->content_buf, - content.c_str(), zgdu_res->u.HTTP_Response->content_len); + // RecordSyntax will always be 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 + = 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) + + // attaching Z3950 package to filter chain + z3950_package.request() = apdu; + + // sending Z30.50 present request + z3950_package.move(); + + //check successful Z3950 present response + Z_GDU *z3950_gdu = z3950_package.response().get(); + if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950 + || z3950_gdu->u.z3950->which != Z_APDU_presentResponse + || !z3950_gdu->u.z3950->u.presentResponse) + + { + 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; + } + + + // everything fine, continuing + + Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse; + Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response; + + + // 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; - //z_HTTP_header_add(odr, &hres->headers, - // "Content-Type", content_type.c_str()); - package.response() = zgdu_res; + + + // copy all records if existing + if (pr->records && pr->records->which == Z_Records_DBOSD) + { + // srw'fy number of returned records + sru_res->num_records + = pr->records->u.databaseOrSurDiagnostics->num_records; + + sru_res->records + = (Z_SRW_record *) odr_malloc(odr_en, + sru_res->num_records + * sizeof(Z_SRW_record)); + + + // srw'fy nextRecordPosition + // 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].recordPacking = record_packing; + + if (npr->which == Z_NamePlusRecord_databaseRecord && + npr->u.databaseRecord->direct_reference + && !oid_oidcmp(npr->u.databaseRecord->direct_reference, + yaz_oid_recsyn_xml)) + { + // 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 + { + // 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; +} + +bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, + const Z_SRW_searchRetrieveRequest *req + ) const +{ + if (req->query_type == Z_SRW_query_type_cql) + { + Z_External *ext = (Z_External *) + odr_malloc(odr_en, sizeof(*ext)); + ext->direct_reference = + odr_getoidbystr(odr_en, "1.2.840.10003.16.2"); + ext->indirect_reference = 0; + ext->descriptor = 0; + ext->which = Z_External_CQL; + ext->u.cql = odr_strdup(odr_en, req->query.cql); + + z_query->which = Z_Query_type_104; + z_query->u.type_104 = ext; + return true; + } + + if (req->query_type == Z_SRW_query_type_pqf) + { + Z_RPNQuery *RPNquery; + YAZ_PQF_Parser pqf_parser; + + pqf_parser = yaz_pqf_create (); + + RPNquery = yaz_pqf_parse (pqf_parser, odr_en, req->query.pqf); + if (!RPNquery) + { + std::cout << "TODO: Handeling of bad PQF\n"; + std::cout << "TODO: Diagnostic to be send\n"; + } + z_query->which = Z_Query_type_1; + z_query->u.type_1 = RPNquery; + + yaz_pqf_destroy(pqf_parser); + return true; + } + return false; } +bool +yf::SRUtoZ3950::Impl::z3950_to_srw_diagnostics_ok(mp::odr &odr_en, + Z_SRW_searchRetrieveResponse + *sru_res, + Z_Records *records) const +{ + // 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; + } + return true; +} + + +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; + 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(bib1_code), + ddf->u.v2Addinfo); + return 0; +} + static mp::filter::Base* filter_creator() @@ -235,7 +856,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 }; } @@ -244,8 +865,9 @@ extern "C" { /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil - * c-file-style: "stroustrup" * End: * vim: shiftwidth=4 tabstop=8 expandtab */ +