-/* $Id: filter_sru_to_z3950.cpp,v 1.19 2006-10-02 13:44:48 marc Exp $
+/* $Id: filter_sru_to_z3950.cpp,v 1.25 2007-01-07 00:41:18 marc Exp $
Copyright (c) 2005-2006, Index Data.
See the LICENSE file for details
- */
+*/
#include "config.hpp"
#include "filter.hpp"
#include <iostream>
#include <sstream>
#include <string>
-
+#include <algorithm>
namespace mp = metaproxy_1;
namespace mp_util = metaproxy_1::util;
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,
- 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;
+
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;
+
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;
- 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;
char *charset = 0;
char *stylesheet = 0;
- if (! (sru_pdu_req = decode_sru_request(package, odr_de, odr_en,
+ mp_util::SRUServerInfo sruinfo = mp_util::get_sru_server_info(package);
+
+
+ if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en,
sru_pdu_res, soap,
charset, stylesheet)))
{
- build_simple_explain(package, odr_en, sru_pdu_res, 0);
- build_sru_response(package, odr_en, soap,
- sru_pdu_res, charset, stylesheet);
- package.session().close();
+ //mp_util::build_simple_explain(package, odr_en, sru_pdu_res, sruinfo);
+ //mp_util::build_sru_response(package, odr_en, soap,
+ // sru_pdu_res, charset, stylesheet);
+ //package.session().close();
+ package.move();
return;
}
-
- // SRU request package translation to Z3950 package
- if (sru_pdu_req)
- std::cout << *sru_pdu_req << "\n";
- else
- std::cout << "SRU empty\n";
-
-
// explain
if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request)
{
- Z_SRW_explainRequest *er_req = sru_pdu_req->u.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);
+ package.move();
+ return;
}
// searchRetrieve
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))
{
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),
+ 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);
}
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
return;
}
- //build_sru_debug_package(package);
- build_sru_response(package, odr_en, soap,
- sru_pdu_res, charset, stylesheet);
+ //mp_util::build_sru_debug_package(package);
+ mp_util::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 && er_req->recordPacking && 's' == *(er_req->recordPacking))
- record_packing = Z_SRW_recordPacking_string;
-
- // getting database info
- std::string database("Default");
- if (er_req && 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(
- "<explain>\n"
- " <serverInfo protocol='SRU'>\n"
- " <host>")
- + host
- + mp_util::to_string("</host>\n"
- " <port>")
- + port
- + mp_util::to_string("</port>\n"
- " <database>")
- + database
- + mp_util::to_string("</database>\n"
- " </serverInfo>\n"
- "</explain>\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 = mp_util::http_headers_debug(*http_req);
- int http_code = 400;
- http_response(package, content, http_code);
- return true;
- }
- package.session().close();
- return false;
-}
-
-
-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
-{
-
- // SRU request package translation to Z3950 package
- if (sru_pdu_res)
- std::cout << *(const_cast<Z_SRW_PDU *>(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;
- }
- 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;
-
- //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)))
- {
- if (sru_pdu_res->u.response->num_diagnostics)
- {
- //sru_pdu_res = sru_pdu_res_exp;
- package.session().close();
- return 0;
- }
- 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_pdu_res = sru_pdu_res_exp;
- package.session().close();
- return 0;
- }
- return 0;
-}
-
-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;
-};
-
-
bool
yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
Z_SRW_searchRetrieveRequest
const *sr_req) const
{
+
+ assert(sru_pdu_res->u.response);
+
Package z3950_package(package.session(), package.origin());
z3950_package.copy_filter(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;
}
const *sr_req)
const
{
+ assert(sru_pdu_res->u.response);
if (!sr_req)
return false;
if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords))
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.
80, 0);
}
- // start record requested larger than number of records
+ // start record requested negative, or 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) < 0) // negative
+ ||
+ (sru_pdu_res->u.response->numberOfRecords //out of range
+ && *(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),
61, 0);
}
+ // maximumRecords requested negative
+ if (sr_req->maximumRecords
+ && *(sr_req->maximumRecords) < 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");
+ }
+
// 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) = 1;
// z3950'fy number of records requested
+ // protect against requesting records out of range
if (sr_req->maximumRecords)
*(apdu->u.presentRequest->numberOfRecordsRequested)
- = *(sr_req->maximumRecords);
+ = 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->recordSchema)
{
apdu->u.presentRequest->recordComposition
- = (Z_RecordComposition *) odr_malloc(odr_en, sizeof(Z_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);
+ = mp_util::build_esn_from_schema(odr_en,
+ (const char *) sr_req->recordSchema);
}
// z3950'fy time to live - flagged as diagnostics above
&& pr->records->u.nonSurrogateDiagnostic)
{
//int http_code =
- z3950_to_srw_diag(odr_en, sru_res, pr->records->u.nonSurrogateDiagnostic);
+ z3950_to_srw_diag(odr_en, sru_res,
+ pr->records->u.nonSurrogateDiagnostic);
return false;
}
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++)
{
= pr->records->u.databaseOrSurDiagnostics->records[i];
sru_res->records[i].recordPosition
- = odr_intdup(odr_en, i + *(apdu->u.presentRequest->resultSetStartPoint));
+ = odr_intdup(odr_en,
+ i + *(apdu->u.presentRequest->resultSetStartPoint));
sru_res->records[i].recordPacking = record_packing;
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);
}
-// 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
-// {
-// std::string message("<html>\n<body>\n<h1>"
-// "Metaproxy SRUtoZ3950 filter"
-// "</h1>\n");
-
-// message += "<h3>HTTP Info</h3><br/>\n";
-// message += "<p>\n";
-// message += "<b>Method: </b> " + std::string(http_req.method) + "<br/>\n";
-// message += "<b>Version:</b> " + std::string(http_req.version) + "<br/>\n";
-// message += "<b>Path: </b> " + std::string(http_req.path) + "<br/>\n";
-
-// message += "<b>Content-Type:</b>"
-// + mp_util::http_header_value(http_req.headers, "Content-Type")
-// + "<br/>\n";
-// message += "<b>Content-Length:</b>"
-// + mp_util::http_header_value(http_req.headers, "Content-Length")
-// + "<br/>\n";
-// message += "</p>\n";
-
-// message += "<h3>Headers</h3><br/>\n";
-// message += "<p>\n";
-// Z_HTTP_Header* header = http_req.headers;
-// while (header){
-// message += "<b>Header: </b> <i>"
-// + std::string(header->name) + ":</i> "
-// + std::string(header->value) + "<br/>\n";
-// header = header->next;
-// }
-// message += "</p>\n";
-// message += "</body>\n</html>\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;
-}
-
-
-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,
extern "C" {
struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
0,
- "SRUtoZ3950",
+ "sru_z3950",
filter_creator
};
}
projects / metaproxy-moved-to-github.git / blobdiff