The configure method takes test_only flag so we can avoid
[metaproxy-moved-to-github.git] / src / filter_record_transform.cpp
index 9358473..d268b7d 100644 (file)
@@ -1,7 +1,22 @@
-/* $Id: filter_record_transform.cpp,v 1.3 2006-10-04 14:04:00 marc Exp $
-   Copyright (c) 2005-2006, Index Data.
+/* $Id: filter_record_transform.cpp,v 1.14 2008-02-20 15:07:52 adam Exp $
+   Copyright (c) 2005-2007, Index Data.
 
-   See the LICENSE file for details
+This file is part of Metaproxy.
+
+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 Metaproxy; see the file LICENSE.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
  */
 
 #include "config.hpp"
@@ -12,6 +27,7 @@
 #include "gduutil.hpp"
 #include "xmlutil.hpp"
 
+#include <yaz/diagbib1.h>
 #include <yaz/zgdu.h>
 #include <yaz/retrieval.h>
 
@@ -47,7 +63,7 @@ yf::RecordTransform::~RecordTransform()
 {  // must have a destructor because of boost::scoped_ptr
 }
 
-void yf::RecordTransform::configure(const xmlNode *xmlnode)
+void yf::RecordTransform::configure(const xmlNode *xmlnode, bool test_only)
 {
     m_p->configure(xmlnode);
 }
@@ -94,7 +110,7 @@ void yf::RecordTransform::Impl::configure(const xmlNode *xml_node)
         if (0 == strcmp((const char *) retrieval_node->name, "retrievalinfo"))
             break;
     }
-    
+
     // read configuration
     if ( 0 != yaz_retrieval_configure(m_retrieval, retrieval_node)){
         std::string msg("RecordTransform filter config: ");
@@ -118,7 +134,7 @@ void yf::RecordTransform::Impl::process(mp::Package &package) const
     }
     
     // getting original present request
-    Z_PresentRequest *pr = gdu_req->u.z3950->u.presentRequest;
+    Z_PresentRequest *pr_req = gdu_req->u.z3950->u.presentRequest;
 
     // setting up ODR's for memory during encoding/decoding
     //mp::odr odr_de(ODR_DECODE);  
@@ -131,16 +147,16 @@ void yf::RecordTransform::Impl::process(mp::Package &package) const
     const char *input_schema = 0;
     Odr_oid *input_syntax = 0;
 
-    if(pr->recordComposition){
+    if(pr_req->recordComposition){
         input_schema 
-            = mp_util::record_composition_to_esn(pr->recordComposition);
+            = mp_util::record_composition_to_esn(pr_req->recordComposition);
     }
-    if(pr->preferredRecordSyntax){
-        input_syntax = pr->preferredRecordSyntax;
+    if(pr_req->preferredRecordSyntax){
+        input_syntax = pr_req->preferredRecordSyntax;
     }
     
     const char *match_schema = 0;
-    int *match_syntax = 0;
+    Odr_oid *match_syntax = 0;
 
     const char *backend_schema = 0;
     Odr_oid *backend_syntax = 0;
@@ -152,74 +168,69 @@ void yf::RecordTransform::Impl::process(mp::Package &package) const
                                 &rc,
                                 &backend_schema, &backend_syntax);
 
-    std::cout << "ret_code " <<  ret_code << "\n";
-    std::cout << "match   " << (oid_getentbyoid(match_syntax))->desc << " " <<  match_schema << "\n";
-    std::cout << "backend " << (oid_getentbyoid(backend_syntax))->desc << " " <<  backend_schema << "\n";
-    
+    // error handling
+    if (ret_code != 0)
+    {
+        // need to construct present error package and send back
+
+        Z_APDU *apdu = 0;
+
+        const char *details = 0;
+        if (ret_code == -1) /* error ? */
+        {
+           details = yaz_retrieval_get_error(m_retrieval);
+           apdu = odr_en.create_presentResponse(
+               gdu_req->u.z3950,
+               YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS, details);
+        }
+        else if (ret_code == 1 || ret_code == 3)
+        {
+            details = input_schema;
+            apdu = odr_en.create_presentResponse(
+                gdu_req->u.z3950,
+                YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP, details);
+        }
+        else if (ret_code == 2)
+        {
+            char oidbuf[OID_STR_MAX];
+            oid_oid_to_dotstring(input_syntax, oidbuf);
+            details = odr_strdup(odr_en, oidbuf);
+            
+            apdu = odr_en.create_presentResponse(
+                gdu_req->u.z3950,
+                YAZ_BIB1_RECORD_SYNTAX_UNSUPP, details);
+        }
+        package.response() = apdu;
+        return;
+    }
 
-//         if (r == -1) /* error ? */
-//         {
-//             const char *details = yaz_retrieval_get_error(
-//                 assoc->server->retrieval);
-
-//             rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
-//             if (details)
-//                 rr->errstring = odr_strdup(rr->stream, details);
-//             return -1;
-//         }
-//         else if (r == 1 || r == 3)
-//         {
-//             const char *details = input_schema;
-//             rr->errcode =  YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
-//             if (details)
-//                 rr->errstring = odr_strdup(rr->stream, details);
-//             return -1;
-//         }
-//         else if (r == 2)
-//         {
-//             rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
-//             if (input_syntax_raw)
-//             {
-//                 char oidbuf[OID_STR_MAX];
-//                 oid_to_dotstring(input_syntax_raw, oidbuf);
-//                 rr->errstring = odr_strdup(rr->stream, oidbuf);
-//             }
-//             return -1;
-//     }
-
-
-    // now re-insructing the z3950 backend present request
+    // now re-coding the z3950 backend present request
      
-    // z3950'fy record syntax
-    //Odr_oid odr_oid;
-
-        
-        // = yaz_oidval_to_z3950oid (odr_en, CLASS_RECSYN, VAL_TEXT_XML);
-    // }
-    // Odr_oid *yaz_str_to_z3950oid (ODR o, int oid_class,
-    //                                         const char *str);
-    // const char *yaz_z3950oid_to_str (Odr_oid *oid, int *oid_class);
-
+    if (backend_syntax) 
+        pr_req->preferredRecordSyntax = odr_oiddup(odr_en, backend_syntax);
+    else
+        pr_req->preferredRecordSyntax = 0;
+    
 
     // z3950'fy record schema
-    //if ()
-    // {
-    //     pr->recordComposition 
-    //         = (Z_RecordComposition *) 
-    //           odr_malloc(odr_en, sizeof(Z_RecordComposition));
-    //     pr->recordComposition->which 
-    //         = Z_RecordComp_simple;
-    //     pr->recordComposition->u.simple 
-    //         = build_esn_from_schema(odr_en, 
-    //                                 (const char *) sr_req->recordSchema); 
-    // }
+    if (backend_schema)
+    {
+        pr_req->recordComposition 
+            = (Z_RecordComposition *) 
+              odr_malloc(odr_en, sizeof(Z_RecordComposition));
+        pr_req->recordComposition->which 
+            = Z_RecordComp_simple;
+        pr_req->recordComposition->u.simple 
+            = (Z_ElementSetNames *)
+               odr_malloc(odr_en, sizeof(Z_ElementSetNames));
+        pr_req->recordComposition->u.simple->which = Z_ElementSetNames_generic;
+        pr_req->recordComposition->u.simple->u.generic 
+            = odr_strdup(odr_en, backend_schema);
+    }
 
     // attaching Z3950 package to filter chain
     package.request() = gdu_req;
 
-    // std::cout << "z3950_present_request " << *apdu << "\n";   
-
-    // sending package
     package.move();
 
    //check successful Z3950 present response
@@ -239,53 +250,80 @@ void yf::RecordTransform::Impl::process(mp::Package &package) const
     // std::cout << "z3950_present_request OK\n";
     // std::cout << "back z3950 " << *gdu_res << "\n";
 
-//         if (backend_schema)
-//         {
-//             set_esn(&rr->comp, backend_schema, rr->stream->mem);
-//         }
-//         if (backend_syntax)
-//         {
-//             oident *oident_syntax = oid_getentbyoid(backend_syntax);
+    Z_PresentResponse * pr_res = gdu_res->u.z3950->u.presentResponse;
 
-//             rr->request_format_raw = backend_syntax;
-            
-//             if (oident_syntax)
-//                 rr->request_format = oident_syntax->value;
-//             else
-//                 rr->request_format = VAL_NONE;
-
-//        }
-//     }
-//     (*assoc->init->bend_fetch)(assoc->backend, rr);
-//     if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
-//     {   /* post conversion must take place .. */
-//         WRBUF output_record = wrbuf_alloc();
-//         int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
-//         if (r)
-//         {
-//             const char *details = yaz_record_conv_get_error(rc);
-//             rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
-//             if (details)
-//                 rr->errstring = odr_strdup(rr->stream, details);
-//         }
-//         else
-//         {
-//             rr->len = wrbuf_len(output_record);
-//             rr->record = odr_malloc(rr->stream, rr->len);
-//             memcpy(rr->record, wrbuf_buf(output_record), rr->len);
-//         }
-//         wrbuf_free(output_record, 1);
-//     }
-//     if (match_syntax)
-//     {
-//         struct oident *oi = oid_getentbyoid(match_syntax);
-//         rr->output_format = oi ? oi->value : VAL_NONE;
-//         rr->output_format_raw = match_syntax;
-//     }
-//     if (match_schema)
-//         rr->schema = odr_strdup(rr->stream, match_schema);
-//     return 0;
+    // let non surrogate dioagnostics in Z3950 present response package
+    // pass to frontend - just return
+    if (pr_res->records 
+        && pr_res->records->which == Z_Records_NSD
+        && pr_res->records->u.nonSurrogateDiagnostic)
+    {
+        // we might do more clever tricks to "reverse"
+        // these error(s).
+
+        //*pr_res->records->u.nonSurrogateDiagnostic->condition = 
+        // YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
+    }
 
+    // record transformation must take place 
+    if (rc && pr_res 
+        && pr_res->numberOfRecordsReturned 
+        && *(pr_res->numberOfRecordsReturned) > 0
+        && pr_res->records
+        && pr_res->records->which == Z_Records_DBOSD
+        && pr_res->records->u.databaseOrSurDiagnostics->num_records)
+    {
+         //transform all records
+         for (int i = 0; 
+              i < pr_res->records->u.databaseOrSurDiagnostics->num_records; 
+              i++)
+         {
+             Z_NamePlusRecord *npr 
+                 = pr_res->records->u.databaseOrSurDiagnostics->records[i];
+             if (npr->which == Z_NamePlusRecord_databaseRecord)
+             {
+                 WRBUF output_record = wrbuf_alloc();
+                 Z_External *r = npr->u.databaseRecord;
+                 int ret_trans = 0;
+                 if (r->which == Z_External_OPAC)
+                 {
+#if YAZ_VERSIONL >= 0x030011
+                     ret_trans = 
+                         yaz_record_conv_opac_record(rc, r->u.opac,
+                                                     output_record);
+#else
+                     ;
+#endif
+                 }
+                 else if (r->which == Z_External_octet) 
+                 {
+                     ret_trans =
+                         yaz_record_conv_record(rc, (const char *)
+                                                r->u.octet_aligned->buf, 
+                                                r->u.octet_aligned->len,
+                                                output_record);
+                 }
+                 if (ret_trans == 0)
+                 {
+                     npr->u.databaseRecord =
+                         z_ext_record_oid(odr_en, match_syntax,
+                                          wrbuf_buf(output_record),
+                                          wrbuf_len(output_record));
+                 }
+                 else
+                 {
+                     pr_res->records->
+                         u.databaseOrSurDiagnostics->records[i] 
+                         =  zget_surrogateDiagRec(
+                             odr_en, npr->databaseName,
+                             YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS,
+                             yaz_record_conv_get_error(rc));
+                 }
+                 wrbuf_destroy(output_record);
+             }
+         }
+    }
+    package.response() = gdu_res;
     return;
 }