X-Git-Url: http://lists.indexdata.com/cgi-bin?a=blobdiff_plain;f=src%2Ffilter_sru_to_z3950.cpp;h=d8469c97214f5ffef4dc638af6d831eab9e39d31;hb=5f2548e1ed0e214ad7f921e292fc23224cf4cff4;hp=523bdee3e49f5e08b69d7045fc6f9575b5fb9243;hpb=76a98c38e74bf2c4b9f3840d06dce994e268c20b;p=metaproxy-moved-to-github.git diff --git a/src/filter_sru_to_z3950.cpp b/src/filter_sru_to_z3950.cpp index 523bdee..d8469c9 100644 --- a/src/filter_sru_to_z3950.cpp +++ b/src/filter_sru_to_z3950.cpp @@ -1,4 +1,4 @@ -/* $Id: filter_sru_to_z3950.cpp,v 1.11 2006-09-22 11:11:17 marc Exp $ +/* $Id: filter_sru_to_z3950.cpp,v 1.17 2006-10-02 12:01:06 marc Exp $ Copyright (c) 2005-2006, Index Data. See the LICENSE file for details @@ -9,6 +9,7 @@ #include "package.hpp" #include "util.hpp" #include "gduutil.hpp" +#include "sru_util.hpp" #include "filter_sru_to_z3950.hpp" #include @@ -24,55 +25,31 @@ namespace mp = metaproxy_1; +namespace mp_util = metaproxy_1::util; namespace yf = mp::filter; -namespace metaproxy_1 -{ - - template - std::string to_string(const T& t) - { - std::ostringstream o; - if(o << t) - return o.str(); - - return std::string(); - } - - std::string http_header_value(const Z_HTTP_Header* header, - const std::string name) - { - while (header && header->name - && std::string(header->name) != name) - header = header->next; - - if (header && header->name && std::string(header->name) == name - && header->value) - return std::string(header->value); - - return std::string(); - } - - -} - namespace metaproxy_1 { namespace filter { - class SRUtoZ3950::Rep { - private: - union SRW_query {char * cql; char * xcql; char * pqf;}; - typedef const int& SRW_query_type; + 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; + 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, @@ -86,6 +63,11 @@ namespace metaproxy_1 { 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; bool z3950_build_query(mp::odr &odr_en, Z_Query *z_query, const SRW_query &query, SRW_query_type query_type) const; @@ -108,12 +90,17 @@ namespace metaproxy_1 { 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; + Z_ElementSetNames * build_esn_from_schema(mp::odr &odr_en, + const char *schema) + 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) { } @@ -131,11 +118,11 @@ 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 *xmlnode) { } -void yf::SRUtoZ3950::Rep::process(mp::Package &package) const +void yf::SRUtoZ3950::Impl::process(mp::Package &package) const { Z_GDU *zgdu_req = package.request().get(); @@ -168,6 +155,7 @@ void yf::SRUtoZ3950::Rep::process(mp::Package &package) const { build_sru_response(package, odr_en, soap, sru_pdu_res, charset, stylesheet); + package.session().close(); return; } @@ -182,21 +170,25 @@ void yf::SRUtoZ3950::Rep::process(mp::Package &package) const // explain if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request) { - //Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request; - // sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response); - std::cout << "TODO: implement explain response"; - + 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); } - // searchRetrieve - if (sru_pdu_req && sru_pdu_req->which == Z_SRW_searchRetrieve_request) + else if (sru_pdu_req + && sru_pdu_req->which == Z_SRW_searchRetrieve_request + && sru_pdu_req->u.request) { Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request; sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response); - if (z3950_init_request(package)) + // checking that we have a query + ok = check_sru_query_exists(package, odr_en, sru_pdu_res, sr_req); + + if (ok && z3950_init_request(package)) { { ok = z3950_search_request(package, odr_en, @@ -217,7 +209,9 @@ void yf::SRUtoZ3950::Rep::process(mp::Package &package) const } // scan - else if (sru_pdu_req && sru_pdu_req->which == Z_SRW_scan_request) + else if (sru_pdu_req + && 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; @@ -252,7 +246,87 @@ void yf::SRUtoZ3950::Rep::process(mp::Package &package) const } -bool yf::SRUtoZ3950::Rep::build_sru_debug_package(mp::Package &package) const + +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) @@ -268,7 +342,7 @@ bool yf::SRUtoZ3950::Rep::build_sru_debug_package(mp::Package &package) const } -bool yf::SRUtoZ3950::Rep::build_sru_response(mp::Package &package, +bool yf::SRUtoZ3950::Impl::build_sru_response(mp::Package &package, mp::odr &odr_en, Z_SOAP *soap, const Z_SRW_PDU *sru_pdu_res, @@ -339,7 +413,7 @@ bool yf::SRUtoZ3950::Rep::build_sru_response(mp::Package &package, - Z_SRW_PDU * yf::SRUtoZ3950::Rep::decode_sru_request(mp::Package &package, + 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, @@ -390,7 +464,48 @@ bool yf::SRUtoZ3950::Rep::build_sru_response(mp::Package &package, } bool -yf::SRUtoZ3950::Rep::z3950_init_request(mp::Package &package, +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; +}; + + + +bool +yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package, const std::string &database) const { // prepare Z3950 package @@ -442,7 +557,7 @@ yf::SRUtoZ3950::Rep::z3950_init_request(mp::Package &package, } bool -yf::SRUtoZ3950::Rep::z3950_close_request(mp::Package &package) const +yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const { // close SRU package package.session().close(); @@ -472,24 +587,24 @@ yf::SRUtoZ3950::Rep::z3950_close_request(mp::Package &package) const } bool -yf::SRUtoZ3950::Rep::z3950_search_request(mp::Package &package, +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 { 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_searchRequest); + z3950_package.copy_filter(package); //add stuff in z3950 apdu + 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)); @@ -552,7 +667,7 @@ yf::SRUtoZ3950::Rep::z3950_search_request(mp::Package &package, } bool -yf::SRUtoZ3950::Rep::z3950_present_request(mp::Package &package, +yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package, mp::odr &odr_en, Z_SRW_PDU *sru_pdu_res, Z_SRW_searchRetrieveRequest @@ -564,7 +679,7 @@ yf::SRUtoZ3950::Rep::z3950_present_request(mp::Package &package, return false; - // no need to work if nobody wants records seen .. + // no need to work if nobody wants record .. if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords)) return true; @@ -608,6 +723,19 @@ yf::SRUtoZ3950::Rep::z3950_present_request(mp::Package &package, 80, 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)) + { + // = *(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); + } + // exit on all these above diagnostics if (!send_z3950_present) return false; @@ -655,92 +783,101 @@ yf::SRUtoZ3950::Rep::z3950_present_request(mp::Package &package, //std::cout << "z3950_present_request " << *apdu << "\n"; z3950_package.move(); - //TODO: check success condition + //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) + if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950 + || z3950_gdu->u.z3950->which != Z_APDU_presentResponse + || !z3950_gdu->u.z3950->u.presentResponse) { - //std::cout << "z3950_present_request OK\n"; + 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; + } + + + // 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); + 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; + + sru_res->records + = (Z_SRW_record *) odr_malloc(odr_en, + sru_res->num_records *sizeof(Z_SRW_record)); + + // srw'fy nextRecordPosition + if (pr->nextResultSetPosition) + sru_res->nextRecordPosition + = odr_intdup(odr_en, *(pr->nextResultSetPosition)); - Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse; - if (pr) + // inserting all records + for (int i = 0; i < sru_res->num_records; i++) { - Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response; + Z_NamePlusRecord *npr + = pr->records->u.databaseOrSurDiagnostics->records[i]; - // srw'fy nextRecordPosition - if (pr->nextResultSetPosition) - sru_res->nextRecordPosition - = odr_intdup(odr_en, *(pr->nextResultSetPosition)); + sru_res->records[i].recordPosition + = odr_intdup(odr_en, i + *(apdu->u.presentRequest->resultSetStartPoint)); - // = (int *) odr_malloc(odr_en, sizeof(int *)); - //*(sru_res->nextRecordPosition) - //= *(Pr->nextResultSetPosition); - - // copy all records if existing - if (pr->records && pr->records->which == Z_Records_DBOSD) + sru_res->records[i].recordPacking = record_packing; + + if (npr->which != Z_NamePlusRecord_databaseRecord) { - // 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)); - - for (int i = 0; i < sru_res->num_records; i++) + sru_res->records[i].recordSchema = "diagnostic"; + sru_res->records[i].recordData_buf = "67"; + sru_res->records[i].recordData_len = 2; + } + 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) { - 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) - { - sru_res->records[i].recordSchema = "diagnostic"; - sru_res->records[i].recordData_buf = "67"; - sru_res->records[i].recordData_len = 2; - } - 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; - } - } - + 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; } - - - } - } - return true; + else + { + sru_res->records[i].recordSchema = "diagnostic"; + sru_res->records[i].recordData_buf = "67"; + sru_res->records[i].recordData_len = 2; + } + } + } } - - return false; + + return true; } bool -yf::SRUtoZ3950::Rep::z3950_scan_request(mp::Package &package, +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 @@ -801,7 +938,7 @@ yf::SRUtoZ3950::Rep::z3950_scan_request(mp::Package &package, return false; } -bool yf::SRUtoZ3950::Rep::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, +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 { @@ -845,7 +982,7 @@ bool yf::SRUtoZ3950::Rep::z3950_build_query(mp::odr &odr_en, Z_Query *z_query, std::string -yf::SRUtoZ3950::Rep::sru_protocol(const Z_HTTP_Request &http_req) const +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"); @@ -853,7 +990,7 @@ yf::SRUtoZ3950::Rep::sru_protocol(const Z_HTTP_Request &http_req) const const std::string http_method(http_req.method); const std::string http_type - = http_header_value(http_req.headers, "Content-Type"); + = mp_util::http_header_value(http_req.headers, "Content-Type"); if (http_method == "GET") return "SRU GET"; @@ -871,7 +1008,7 @@ yf::SRUtoZ3950::Rep::sru_protocol(const Z_HTTP_Request &http_req) const } std::string -yf::SRUtoZ3950::Rep::debug_http(const Z_HTTP_Request &http_req) const +yf::SRUtoZ3950::Impl::debug_http(const Z_HTTP_Request &http_req) const { std::string message("\n\n

" "Metaproxy SRUtoZ3950 filter" @@ -884,10 +1021,10 @@ yf::SRUtoZ3950::Rep::debug_http(const Z_HTTP_Request &http_req) const message += "Path: " + std::string(http_req.path) + "
\n"; message += "Content-Type:" - + http_header_value(http_req.headers, "Content-Type") + + mp_util::http_header_value(http_req.headers, "Content-Type") + "
\n"; message += "Content-Length:" - + http_header_value(http_req.headers, "Content-Length") + + mp_util::http_header_value(http_req.headers, "Content-Length") + "
\n"; message += "

\n"; @@ -905,7 +1042,7 @@ yf::SRUtoZ3950::Rep::debug_http(const Z_HTTP_Request &http_req) const return message; } -void yf::SRUtoZ3950::Rep::http_response(metaproxy_1::Package &package, +void yf::SRUtoZ3950::Impl::http_response(metaproxy_1::Package &package, const std::string &content, int http_code) const { @@ -931,7 +1068,9 @@ void yf::SRUtoZ3950::Rep::http_response(metaproxy_1::Package &package, } -Z_ElementSetNames * yf::SRUtoZ3950::Rep::build_esn_from_schema(mp::odr &odr_en, const char *schema) const +Z_ElementSetNames * +yf::SRUtoZ3950::Impl::build_esn_from_schema(mp::odr &odr_en, + const char *schema) const { if (!schema) return 0; @@ -943,6 +1082,25 @@ Z_ElementSetNames * yf::SRUtoZ3950::Rep::build_esn_from_schema(mp::odr &odr_en, 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), + ddf->u.v2Addinfo); + return 0; +} + + + static mp::filter::Base* filter_creator() { return new mp::filter::SRUtoZ3950;