X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Ffilter_sru_to_z3950.cpp;h=7dd70a82109fde6c7d426a3bc1836866bcbe2090;hb=9263a36f12d300b625f5dbf6aa2c0f118290e08c;hp=68dbab33524d5d77d0bf27199a78a41183327736;hpb=098f68aa472b0827a0dfdfda38a338cde577ef98;p=metaproxy-moved-to-github.git diff --git a/src/filter_sru_to_z3950.cpp b/src/filter_sru_to_z3950.cpp index 68dbab3..7dd70a8 100644 --- a/src/filter_sru_to_z3950.cpp +++ b/src/filter_sru_to_z3950.cpp @@ -1,13 +1,27 @@ -/* $Id: filter_sru_to_z3950.cpp,v 1.24 2006-12-28 13:26:06 marc Exp $ - Copyright (c) 2005-2006, Index Data. +/* This file is part of Metaproxy. + Copyright (C) 2005-2010 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 +#include #include "gduutil.hpp" #include "sru_util.hpp" #include "filter_sru_to_z3950.hpp" @@ -16,62 +30,80 @@ #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 { namespace filter { class SRUtoZ3950::Impl { public: void configure(const xmlNode *xmlnode); - void process(metaproxy_1::Package &package) const; - private: - union SRW_query {char * cql; char * xcql; char * pqf;}; - typedef const int& SRW_query_type; + void process(metaproxy_1::Package &package); private: + std::map m_database_explain; - bool z3950_build_query(mp::odr &odr_en, Z_Query *z_query, - const SRW_query &query, - SRW_query_type query_type) const; + typedef std::map ActiveUrlMap; - bool z3950_init_request(mp::Package &package, - const std::string - &database = "Default") const; + 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) 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; - + 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; - int z3950_to_srw_diag(mp::odr &odr_en, - Z_SRW_searchRetrieveResponse *srw_res, - Z_DefaultDiagFormat *ddf) const; }; } } @@ -84,7 +116,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); } @@ -94,70 +126,117 @@ 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; + } + + // 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))) + sru_pdu_res, &soap, + charset, stylesheet))) { - mp_util::build_simple_explain(package, odr_en, sru_pdu_res, 0); - mp_util::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; - // explain - 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); + 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)); + } - mp_util::build_simple_explain(package, odr_en, sru_pdu_res, er_req); - } + assert(sru_pdu_req); - // searchRetrieve - else if (sru_pdu_req - && sru_pdu_req->which == Z_SRW_searchRetrieve_request - && sru_pdu_req->u.request) + // 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); @@ -166,87 +245,130 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const 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, sru_pdu_req)) { - { - 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)) + + ok = z3950_present_request(package, odr_en, + sru_pdu_res, + sr_req); + z3950_close_request(package); } } // scan - else if (sru_pdu_req - && sru_pdu_req->which == Z_SRW_scan_request + else if (sru_pdu_req->which == Z_SRW_scan_request && sru_pdu_req->u.scan_request) { - Z_SRW_scanRequest *sr_req = 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), - 4, "scan"); - - // to be used when we do scan - if (false && z3950_init_request(package)) - { - z3950_scan_request(package, odr_en, sru_pdu_res, sr_req); - z3950_close_request(package); - } + YAZ_SRW_UNSUPP_OPERATION, "scan"); } else { - //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; + 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"); } - //mp_util::build_sru_debug_package(package); + // build and send SRU response mp_util::build_sru_response(package, odr_en, soap, sru_pdu_res, charset, stylesheet); - return; } +void yf::SRUtoZ3950::Impl::process(mp::Package &package) +{ + 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; + } + + // 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(); + } +} + 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 Z_SRW_PDU *sru_pdu_req) 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 - //TODO: add user passwd in apdu - //init_req->idAuthentication = org_init->idAuthentication; - //init_req->implementationId = "IDxyz"; - //init_req->implementationName = "NAMExyz"; - //init_req->implementationVersion = "VERSIONxyz"; + 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; + 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); @@ -256,15 +378,26 @@ 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(); + 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; } @@ -272,18 +405,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); @@ -302,18 +437,19 @@ yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const // && z3950_gdu->u.z3950->which == Z_APDU_close) // return true; - if (z3950_package.session().is_closed()){ + if (z3950_package.session().is_closed()) + { return true; } 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); @@ -325,26 +461,28 @@ 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)); z_searchRequest->query = z_query; - if (!z3950_build_query(odr_en, z_query, - (const SRW_query&)sr_req->query, - sr_req->query_type)) + if (!z3950_build_query(odr_en, z_query, sr_req)) { yaz_add_srw_diagnostic(odr_en, &(sru_pdu_res->u.response->diagnostics), @@ -354,62 +492,74 @@ yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package, } 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 + = odr_intdup(odr_en, *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) +yf::SRUtoZ3950::Impl::z3950_present_request( + mp::Package &package, + mp::odr &odr_en, + Z_SRW_PDU *sru_pdu_res, + const Z_SRW_searchRetrieveRequest *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; bool send_z3950_present = true; @@ -421,7 +571,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. @@ -432,7 +582,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 @@ -442,266 +592,160 @@ 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 negative, or larger than number of records - if (sr_req->startRecord - && - ((*(sr_req->startRecord) < 0) // negative - || - (sru_pdu_res->u.response->numberOfRecords //out of range - && *(sr_req->startRecord) - > *(sru_pdu_res->u.response->numberOfRecords)) - )) + 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), - 61, 0); + YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0); } - + // maximumRecords requested negative - if (sr_req->maximumRecords - && *(sr_req->maximumRecords) < 0) - + 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), - 6, "maximumRecords"); + 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 - if (sr_req->startRecord) - *(apdu->u.presentRequest->resultSetStartPoint) - = *(sr_req->startRecord); - else - *(apdu->u.presentRequest->resultSetStartPoint) = 1; - - // z3950'fy number of records requested - // protect against requesting records out of range - if (sr_req->maximumRecords) - *(apdu->u.presentRequest->numberOfRecordsRequested) - = std::min(*(sr_req->maximumRecords), - *(sru_pdu_res->u.response->numberOfRecords) - - *(apdu->u.presentRequest->resultSetStartPoint) - + 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); - - // 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; - - //std::cout << "z3950_present_request " << *apdu << "\n"; - 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), - 2, 0); - package.session().close(); - return false; - } + if (max_recs > *sru_pdu_res->u.response->numberOfRecords - start) + max_recs = *sru_pdu_res->u.response->numberOfRecords - start + 1; - // 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) + sru_res->records = (Z_SRW_record *) + odr_malloc(odr_en, max_recs * sizeof(Z_SRW_record)); + int num = 0; + while (num < max_recs) { - //int http_code = - z3950_to_srw_diag(odr_en, sru_res, - pr->records->u.nonSurrogateDiagnostic); - return false; - } - - // 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; + // 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); - sru_res->records - = (Z_SRW_record *) odr_malloc(odr_en, - sru_res->num_records - * sizeof(Z_SRW_record)); + assert(apdu->u.presentRequest); - - // 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)); + *apdu->u.presentRequest->resultSetStartPoint = start + num; + *apdu->u.presentRequest->numberOfRecordsRequested = max_recs - num; + + // set response packing to be same as "request" packing.. + int record_packing = Z_SRW_recordPacking_XML; + if (sr_req->recordPacking && 's' == *(sr_req->recordPacking)) + record_packing = Z_SRW_recordPacking_string; - // inserting all records - for (int i = 0; i < sru_res->num_records; i++) + // 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) { - 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; + 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); + } + + // 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) - if (npr->which != Z_NamePlusRecord_databaseRecord) - { - sru_res->records[i].recordSchema = "diagnostic"; - sru_res->records[i].recordData_buf = "67"; - sru_res->records[i].recordData_len = 2; - } - else + { + 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; + + // 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; + + // if anything but database or surrogate diagnostics, stop + if (!pr->records || pr->records->which != Z_Records_DBOSD) + break; + else + { + // inserting all records + int returned_recs = + pr->records->u.databaseOrSurDiagnostics->num_records; + for (int i = 0; i < returned_recs; i++) { - Z_External *r = npr->u.databaseRecord; - oident *ent = oid_getentbyoid(r->direct_reference); - if (r->which == Z_External_octet - && ent->value == VAL_TEXT_XML) + int position = i + *apdu->u.presentRequest->resultSetStartPoint; + Z_NamePlusRecord *npr + = pr->records->u.databaseOrSurDiagnostics->records[i]; + + sru_res->records[i + num].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)) { - sru_res->records[i].recordSchema = "dc"; - sru_res->records[i].recordData_buf + // got XML record back + Z_External *r = npr->u.databaseRecord; + sru_res->records[i + num].recordPosition = + odr_intdup(odr_en, position); + sru_res->records[i + num].recordSchema = sr_req->recordSchema; + sru_res->records[i + num].recordData_buf = odr_strdupn(odr_en, (const char *)r->u.octet_aligned->buf, r->u.octet_aligned->len); - sru_res->records[i].recordData_len + sru_res->records[i + num].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 + num, position, + YAZ_SRW_RECORD_NOT_AVAILABLE_IN_THIS_SCHEMA, 0); } - } - } - } - - return true; -} - -bool -yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package, - mp::odr &odr_en, - 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); - Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_scanRequest); - - //TODO: add stuff in apdu - Z_ScanRequest *z_scanRequest = apdu->u.scanRequest; - - // database repackaging - z_scanRequest->num_databaseNames = 1; - z_scanRequest->databaseNames = (char**) - odr_malloc(odr_en, sizeof(char *)); - if (sr_req->database) - z_scanRequest->databaseNames[0] - = odr_strdup(odr_en, const_cast(sr_req->database)); - else - z_scanRequest->databaseNames[0] - = odr_strdup(odr_en, "Default"); - - - // query repackaging - // CQL or XCQL scan is not possible in Z3950, flagging a diagnostic - if (sr_req->query_type != Z_SRW_query_type_pqf) - { - //send_to_srw_client_error(7, "query"); - return false; + } + num += returned_recs; + } } - - // PQF query repackaging - // need to use Z_AttributesPlusTerm structure, not Z_Query - // this can be digget out of a - // Z_query->type1(Z_RPNQuery)->RPNStructure(Z_RPNStructure) - // ->u.simple(Z_Operand)->u.attributesPlusTerm(Z_AttributesPlusTerm ) - - //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, - // (const SRW_query&)sr_req->query, - // sr_req->query_type)) - //{ - //send_to_srw_client_error(7, "query"); - // return false; - //} - - // TODO: - - z3950_package.request() = apdu; - std::cout << "z3950_scan_request " << *apdu << "\n"; - - z3950_package.move(); - //TODO: check success condition + sru_res->num_records = num; + if (start - 1 + num < *sru_pdu_res->u.response->numberOfRecords) + sru_res->nextRecordPosition = + odr_intdup(odr_en, start + num); return true; - return false; } bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, - const SRW_query &query, - SRW_query_type query_type) const + const Z_SRW_searchRetrieveRequest *req + ) const { - if (query_type == Z_SRW_query_type_cql) + if (req->query_type == Z_SRW_query_type_cql) { Z_External *ext = (Z_External *) odr_malloc(odr_en, sizeof(*ext)); @@ -710,21 +754,21 @@ bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, ext->indirect_reference = 0; ext->descriptor = 0; ext->which = Z_External_CQL; - ext->u.cql = const_cast(query.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 (query_type == Z_SRW_query_type_pqf) + 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, query.pqf); + RPNquery = yaz_pqf_parse (pqf_parser, odr_en, req->query.pqf); if (!RPNquery) { std::cout << "TODO: Handeling of bad PQF\n"; @@ -740,6 +784,24 @@ bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, } +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, @@ -747,13 +809,11 @@ yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en, 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; } @@ -777,8 +837,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 */ +