SRU/SRW Explain for Frontend server

diff --git a/include/yaz/backend.h b/include/yaz/backend.h
index ecd577b..f6dfbf6 100644 (file)
--- a/include/yaz/backend.h
+++ b/include/yaz/backend.h
@@ -23,7 +23,7 @@
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Id: backend.h,v 1.19 2003-02-20 15:15:04 adam Exp $
+ * $Id: backend.h,v 1.20 2003-03-24 22:26:50 adam Exp $
  */
 
 #ifndef BACKEND_H
@@ -181,6 +181,13 @@ typedef struct bend_segment_rr {
     bend_association association;
 } bend_segment_rr;
 
+typedef struct {
+    ODR stream;
+    ODR decode;
+    ODR print;
+    char *explain_buf;
+} bend_explain_rr;
+
 typedef struct bend_initrequest
 {
     Z_IdAuthentication *auth;
@@ -205,6 +212,7 @@ typedef struct bend_initrequest
     /* character set and language negotiation - see include/yaz/z-charneg.h */
     Z_CharSetandLanguageNegotiation *charneg_request;
     Z_External *charneg_response;
+    int (*bend_explain)(void *handle, bend_explain_rr *rr);
 } bend_initrequest;
 
 typedef struct bend_initresult

diff --git a/include/yaz/soap.h b/include/yaz/soap.h
index bdbb098..79264f6 100644 (file)
--- a/include/yaz/soap.h
+++ b/include/yaz/soap.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2002-2003, Index Data.
  * See the file LICENSE for details.
  *
- * $Id: soap.h,v 1.3 2003-03-11 11:09:17 adam Exp $
+ * $Id: soap.h,v 1.4 2003-03-24 22:26:50 adam Exp $
  */
 
 #ifndef YAZ_SOAP_H
@@ -50,4 +50,8 @@ YAZ_EXPORT int z_soap_codec_enc(ODR o, Z_SOAP **pp,
                             char **content_buf, int *content_len,
                             Z_SOAP_Handler *handlers, const char *encoding);
 
+YAZ_EXPORT int z_soap_error(ODR o, Z_SOAP *p,
+                            const char *fault_code, const char *fault_string,
+                            const char *details);
+
 #endif

diff --git a/server/seshigh.c b/server/seshigh.c
index 9371662..ffed67f 100644 (file)
--- a/server/seshigh.c
+++ b/server/seshigh.c
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: seshigh.c,v 1.150 2003-03-20 21:15:00 adam Exp $
+ * $Id: seshigh.c,v 1.151 2003-03-24 22:26:50 adam Exp $
  */
 
 /*
@@ -436,8 +436,11 @@ static void assoc_init_reset(association *assoc)
     assoc->init->bend_scan = NULL;
     assoc->init->bend_segment = NULL;
     assoc->init->bend_fetch = NULL;
+    assoc->init->bend_explain = NULL;
+
     assoc->init->charneg_request = NULL;
     assoc->init->charneg_response = NULL;
+
     assoc->init->decode = assoc->decode;
     assoc->init->peer_name = 
         odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
@@ -710,6 +713,35 @@ static void srw_bend_search(association *assoc, request *req,
     }
 }
 
+
+static void srw_bend_explain(association *assoc, request *req,
+                             Z_SRW_explainRequest *srw_req,
+                             Z_SRW_explainResponse *srw_res)
+{
+    yaz_log(LOG_LOG, "Got SRW ExplainRequest");
+    if (!assoc->init)
+    {
+        yaz_log(LOG_DEBUG, "srw_bend_init");
+        if (!srw_bend_init(assoc))
+            return;
+    }
+    if (assoc->init && assoc->init->bend_explain)
+    {
+        bend_explain_rr rr;
+
+        rr.stream = assoc->encode;
+        rr.decode = assoc->decode;
+        rr.print = assoc->print;
+        rr.explain_buf = 0;
+        (*assoc->init->bend_explain)(assoc->backend, &rr);
+        if (rr.explain_buf)
+        {
+            srw_res->explainData_buf = rr.explain_buf;
+            srw_res->explainData_len = strlen(rr.explain_buf);
+        }
+    }
+}
+
 static int hex_digit (int ch)
 {
     if (ch >= '0' && ch <= '9')
@@ -808,7 +840,6 @@ static void process_http_request(association *assoc, request *req)
             memcpy (db, p0, p1 - p0);
             db[p1 - p0] = '\0';
         }
-
         if (p1 && *p1 == '?' && p1[1])
         {
             Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
@@ -841,8 +872,7 @@ static void process_http_request(association *assoc, request *req)
             if (sr->u.request->startRecord)
                 yaz_log(LOG_LOG, "startRecord=%d", *sr->u.request->startRecord);
             sr->u.request->database = db;
-            srw_bend_search(assoc, req, sr->u.request,
-                            res->u.response);
+            srw_bend_search(assoc, req, sr->u.request, res->u.response);
             
             soap_package = odr_malloc(o, sizeof(*soap_package));
             soap_package->which = Z_SOAP_generic;
@@ -873,6 +903,46 @@ static void process_http_request(association *assoc, request *req)
             }
 
         }
+        else
+        {
+            Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
+            Z_SRW_PDU *sr = yaz_srw_get(o, Z_SRW_explain_request);
+
+            srw_bend_explain(assoc, req, sr->u.explain_request,
+                            res->u.explain_response);
+
+            if (res->u.explain_response->explainData_buf)
+            {
+                soap_package = odr_malloc(o, sizeof(*soap_package));
+                soap_package->which = Z_SOAP_generic;
+                
+                soap_package->u.generic =
+                    odr_malloc(o, sizeof(*soap_package->u.generic));
+                
+                soap_package->u.generic->p = res;
+                soap_package->u.generic->ns = soap_handlers[0].ns;
+                soap_package->u.generic->no = 0;
+                
+                soap_package->ns = "SRU";
+                
+                p = z_get_HTTP_Response(o, 200);
+                hres = p->u.HTTP_Response;
+                
+                ret = z_soap_codec_enc(assoc->encode, &soap_package,
+                                       &hres->content_buf, &hres->content_len,
+                                       soap_handlers, charset);
+                if (!charset)
+                    z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
+                else
+                {
+                    char ctype[60];
+                    strcpy(ctype, "text/xml; charset=");
+                    strcat(ctype, charset);
+                    z_HTTP_header_add(o, &hres->headers, "Content-Type",
+                                      ctype);
+                }
+            }
+        }
 #ifdef DOCDIR
        if (strlen(hreq->path) >= 5 && strlen(hreq->path) < 80 &&
                         !memcmp(hreq->path, "/doc/", 5))
@@ -924,6 +994,8 @@ static void process_http_request(association *assoc, request *req)
            }
        }
 #endif
+
+#if 0
        if (!strcmp(hreq->path, "/")) 
         {
 #ifdef DOCDIR
@@ -952,6 +1024,8 @@ static void process_http_request(association *assoc, request *req)
             hres->content_len = strlen(hres->content_buf);
             z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/html");
         }
+#endif
+
         if (!p)
         {
             p = z_get_HTTP_Response(o, 404);
@@ -961,10 +1035,7 @@ static void process_http_request(association *assoc, request *req)
     {
         const char *content_type = z_HTTP_header_lookup(hreq->headers,
                                                         "Content-Type");
-        const char *soap_action = z_HTTP_header_lookup(hreq->headers,
-                                                       "SOAPAction");
-        if (content_type && soap_action && 
-            !yaz_strcmp_del("text/xml", content_type, "; "))
+        if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
         {
             Z_SOAP *soap_package = 0;
             int ret = -1;
@@ -975,7 +1046,7 @@ static void process_http_request(association *assoc, request *req)
             static Z_SOAP_Handler soap_handlers[2] = {
 #if HAVE_XML2
                 {"http://www.loc.gov/zing/srw/v1.0/", 0,
-                                        (Z_SOAP_fun) yaz_srw_codec},
+                 (Z_SOAP_fun) yaz_srw_codec},
 #endif
                 {0, 0, 0}
             };
@@ -994,7 +1065,6 @@ static void process_http_request(association *assoc, request *req)
             ret = z_soap_codec(assoc->decode, &soap_package, 
                                &hreq->content_buf, &hreq->content_len,
                                soap_handlers);
-            
 #if HAVE_XML2
             if (!ret && soap_package->which == Z_SOAP_generic &&
                 soap_package->u.generic->no == 0)
@@ -1032,6 +1102,29 @@ static void process_http_request(association *assoc, request *req)
                     soap_package->u.generic->p = res;
                     http_code = 200;
                 }
+                else if (sr->which == Z_SRW_explain_request)
+                {
+                    Z_SRW_PDU *res =
+                        yaz_srw_get(assoc->encode, Z_SRW_explain_response);
+
+                    srw_bend_explain(assoc, req, sr->u.explain_request,
+                                     res->u.explain_response);
+                    if (!res->u.explain_response->explainData_buf)
+                    {
+                        z_soap_error(assoc->encode, soap_package,
+                                     "SOAP-ENV:Client", "Explain Not Supported", 0);
+                    }
+                    else
+                    {
+                        soap_package->u.generic->p = res;
+                        http_code = 200;
+                    }
+                }
+                else
+                {
+                    z_soap_error(assoc->encode, soap_package,
+                                 "SOAP-ENV:Client", "Bad method", 0); 
+                }
             }
 #endif
             p = z_get_HTTP_Response(o, 200);

diff --git a/ztest/ztest.c b/ztest/ztest.c
index 7274130..c7e0679 100644 (file)
--- a/ztest/ztest.c
+++ b/ztest/ztest.c
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data.
  * See the file LICENSE for details.
  *
- * $Id: ztest.c,v 1.56 2003-02-28 15:59:02 adam Exp $
+ * $Id: ztest.c,v 1.57 2003-03-24 22:26:51 adam Exp $
  */
 
 /*
@@ -596,6 +596,17 @@ int ztest_scan(void *handle, bend_scan_rr *q)
     return 0;
 }
 
+static int ztest_explain(void *handle, bend_explain_rr *rr)
+{
+    rr->explain_buf = "<explain>\n"
+        "\t<serverInfo>\n"
+        "\t\t<host>localhost</host>\n"
+        "\t\t<port>210</port>\n"
+        "\t</serverInfo>\n"
+        "</explain>\n";
+    return 0;
+}
+
 bend_initresult *bend_init(bend_initrequest *q)
 {
     bend_initresult *r = (bend_initresult *)
@@ -613,6 +624,7 @@ bend_initresult *bend_init(bend_initrequest *q)
     q->bend_delete = ztest_delete;
     q->bend_fetch = ztest_fetch;
     q->bend_scan = ztest_scan;
+    q->bend_explain = ztest_explain;
     return r;
 }
 

diff --git a/zutil/srw.c b/zutil/srw.c
index 68f7912..d77cd65 100644 (file)
--- a/zutil/srw.c
+++ b/zutil/srw.c
@@ -2,7 +2,7 @@
  * Copyright (c) 2002-2003, Index Data.
  * See the file LICENSE for details.
  *
- * $Id: srw.c,v 1.11 2003-03-23 20:27:16 adam Exp $
+ * $Id: srw.c,v 1.12 2003-03-24 22:26:51 adam Exp $
  */
 
 #include <yaz/srw.h>
@@ -373,6 +373,7 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
         {
             Z_SRW_PDU **p = handler_data;
             Z_SRW_explainResponse *res;
+            xmlNodePtr ptr = method->children;
 
             *p = odr_malloc(o, sizeof(**p));
             (*p)->which = Z_SRW_explain_response;
@@ -380,8 +381,12 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             res->explainData_buf = 0;
             res->explainData_len = 0;
             res->explainPacking = Z_SRW_recordPacking_string;
-            match_xsd_string_n(method, "explainResponse", o,
-                               &res->explainData_buf, &res->explainData_len);
+            for (; ptr; ptr = ptr->next)
+            {
+                match_xsd_string_n(ptr, "Explain", o, 
+                                   &res->explainData_buf,
+                                   &res->explainData_len);
+            }
         }
         else
             return -1;
@@ -469,12 +474,8 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
 
             xmlSetNs(ptr, ns_srw);
 
-            if (res->explainData_buf)
-            {
-                xmlNodePtr t = xmlNewTextLen(res->explainData_buf,
-                                             res->explainData_len);
-                xmlAddChild(ptr, t);
-            }
+            add_xsd_string_n(ptr, "Explain", res->explainData_buf,
+                             res->explainData_len);
         }
         else
             return -1;