adapting lower-case convention
[metaproxy-moved-to-github.git] / src / filter_sru_to_z3950.cpp
index d3a672d..9c1a12a 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: filter_sru_to_z3950.cpp,v 1.16 2006-09-29 09:48:36 marc Exp $
+/* $Id: filter_sru_to_z3950.cpp,v 1.22 2006-10-10 14:20:16 marc Exp $
    Copyright (c) 2005-2006, Index Data.
 
    See the LICENSE file for details
@@ -22,7 +22,7 @@
 #include <iostream>
 #include <sstream>
 #include <string>
-
+#include <algorithm>
 
 namespace mp = metaproxy_1;
 namespace mp_util = metaproxy_1::util;
@@ -39,11 +39,11 @@ namespace metaproxy_1 {
             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 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;
+            //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,
@@ -153,6 +153,7 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const
                                             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();
@@ -217,7 +218,14 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const
 
         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
         
-        if (z3950_init_request(package))
+        // we do not do scan at the moment, therefore issuing a diagnostic
+        yaz_add_srw_diagnostic(odr_en,
+                               &(sru_pdu_res->u.scan_response->diagnostics), 
+                               &(sru_pdu_res->u.scan_response->num_diagnostics), 
+                               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);
@@ -237,13 +245,6 @@ void yf::SRUtoZ3950::Impl::process(mp::Package &package) const
     build_sru_response(package, odr_en, soap, 
                        sru_pdu_res, charset, stylesheet);
     return;
-
-
-
-
-
-
-
 }
 
 
@@ -253,27 +254,49 @@ bool yf::SRUtoZ3950::Impl::build_simple_explain(mp::Package &package,
                                                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))
+    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->database)
+    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>")
-        + package.origin().server_host()
+        + host
         + mp_util::to_string("</host>\n"
             "  <port>")
-        + mp_util::to_string(package.origin().server_port())
+        + port
         + mp_util::to_string("</port>\n"
             "  <database>")
         + database
@@ -307,9 +330,9 @@ bool yf::SRUtoZ3950::Impl::build_sru_debug_package(mp::Package &package) const
     if  (zgdu_req && zgdu_req->which == Z_GDU_HTTP_Request)
     {    
         Z_HTTP_Request* http_req =  zgdu_req->u.HTTP_Request;
-        std::string content = debug_http(*http_req);
+        std::string content = mp_util::http_headers_debug(*http_req);
         int http_code = 400;    
-        http_response(package, content, http_code);
+        mp_util::http_response(package, content, http_code);
         return true;
     }
     package.session().close();
@@ -568,6 +591,9 @@ yf::SRUtoZ3950::Impl::z3950_search_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);
 
@@ -596,7 +622,10 @@ yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
                            (const SRW_query&)sr_req->query, 
                            sr_req->query_type))
     {    
-        //send_to_srw_client_error(7, "query");
+        yaz_add_srw_diagnostic(odr_en,
+                               &(sru_pdu_res->u.response->diagnostics), 
+                               &(sru_pdu_res->u.response->num_diagnostics), 
+                               7, "query");
         return false;
     }
 
@@ -649,6 +678,7 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
                                            const *sr_req)
     const
 {
+    assert(sru_pdu_res->u.response);
 
     if (!sr_req)
         return false;
@@ -658,13 +688,6 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
     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.
@@ -698,12 +721,16 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
                                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), 
@@ -711,11 +738,28 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
                                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)
@@ -725,9 +769,13 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
         *(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;
@@ -742,11 +790,13 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
      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); 
+             = build_esn_from_schema(odr_en, 
+                                     (const char *) sr_req->recordSchema); 
      }
 
     // z3950'fy time to live - flagged as diagnostics above
@@ -786,7 +836,8 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
         && 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;
     }
     
@@ -799,13 +850,19 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
         
         sru_res->records 
             = (Z_SRW_record *) odr_malloc(odr_en, 
-                                          sru_res->num_records *sizeof(Z_SRW_record));
+                                          sru_res->num_records 
+                                             * sizeof(Z_SRW_record));
         
+
         // srw'fy nextRecordPosition
-        if (pr->nextResultSetPosition)
+        // next position never zero or behind the last z3950 record 
+        if (pr->nextResultSetPosition
+            && *(pr->nextResultSetPosition) > 0 
+            && *(pr->nextResultSetPosition) 
+               <= *(sru_pdu_res->u.response->numberOfRecords))
             sru_res->nextRecordPosition 
                 = odr_intdup(odr_en, *(pr->nextResultSetPosition));
-
+        
         // inserting all records
         for (int i = 0; i < sru_res->num_records; i++)
         {
@@ -813,7 +870,8 @@ yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
                 = 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;
             
@@ -857,6 +915,8 @@ yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package,
                                         Z_SRW_PDU *sru_pdu_res,
                                         Z_SRW_scanRequest const *sr_req) const 
 {
+    assert(sru_pdu_res->u.scan_response);
+
     Package z3950_package(package.session(), package.origin());
     z3950_package.copy_filter(package); 
     //mp::odr odr_en(ODR_ENCODE);
@@ -956,91 +1016,91 @@ bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
 }
 
 
-std::string 
-yf::SRUtoZ3950::Impl::sru_protocol(const Z_HTTP_Request &http_req) const
-{
-    const std::string mime_urlencoded("application/x-www-form-urlencoded");
-    const std::string mime_text_xml("text/xml");
-    const std::string mime_soap_xml("application/soap+xml");
+// 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");
+//     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 == "GET")
+//         return "SRU GET";
 
-    if (http_method == "POST"
-              && http_type  == mime_urlencoded)
-        return "SRU POST";
+//     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");
+//     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>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);
+//     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);
+//     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);
+//     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_HTTP_header_add(odr, &hres->headers,
+//     //                  "Content-Type", content_type.c_str());
+//     package.response() = zgdu_res;
+// }
 
 
 Z_ElementSetNames * 
@@ -1084,7 +1144,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
     };
 }