Changed include/yaz/diagbib1.h and added include/yaz/diagsrw.h with
[yaz-moved-to-github.git] / src / srw.c
index cf22d06..414a475 100644 (file)
--- a/src/srw.c
+++ b/src/srw.c
@@ -1,8 +1,12 @@
 /*
- * Copyright (c) 2002-2004, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: srw.c,v 1.15 2004-01-07 20:36:44 adam Exp $
+ * $Id: srw.c,v 1.34 2005-02-04 20:27:19 adam Exp $
+ */
+/**
+ * \file srw.c
+ * \brief Implements SRW/SRU package encoding and decoding
  */
 
 #include <yaz/srw.h>
@@ -26,7 +30,7 @@ static void add_XML_n(xmlNodePtr ptr, const char *elem, char *val, int len)
     }
 }
 
-xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, char *val,
+xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, const char *val,
                            int len)
 {
     if (val)
@@ -39,20 +43,20 @@ xmlNodePtr add_xsd_string_n(xmlNodePtr ptr, const char *elem, char *val,
     return 0;
 }
 
-xmlNodePtr add_xsd_string(xmlNodePtr ptr, const char *elem, char *val)
+xmlNodePtr add_xsd_string(xmlNodePtr ptr, const char *elem, const char *val)
 {
     if (val)
-        return xmlNewChild(ptr, 0, elem, val);
+        return xmlNewTextChild(ptr, 0, elem, val);
     return 0;
 }
 
-static void add_xsd_integer(xmlNodePtr ptr, const char *elem, int *val)
+static void add_xsd_integer(xmlNodePtr ptr, const char *elem, const int *val)
 {
     if (val)
     {
         char str[30];
         sprintf(str, "%d", *val);
-        xmlNewChild(ptr, 0, elem, str);
+        xmlNewTextChild(ptr, 0, elem, str);
     }
 }
 
@@ -91,7 +95,10 @@ static int match_xsd_string_n(xmlNodePtr ptr, const char *elem, ODR o,
 #endif
     ptr = ptr->children;
     if (!ptr || ptr->type != XML_TEXT_NODE)
-        return 0;
+    {
+       *val = "";
+        return 1;
+    }
     *val = odr_strdup(o, ptr->content);
     if (len)
         *len = strlen(ptr->content);
@@ -113,7 +120,7 @@ static int match_xsd_XML_n(xmlNodePtr ptr, const char *elem, ODR o,
     if (!match_element(ptr, elem))
         return 0;
     ptr = ptr->children;
-    while (ptr && ptr->type != XML_TEXT_NODE && ptr->type != XML_COMMENT_NODE)
+    while (ptr && (ptr->type == XML_TEXT_NODE || ptr->type == XML_COMMENT_NODE))
        ptr = ptr->next;
     if (!ptr)
         return 0;
@@ -243,7 +250,7 @@ static int yaz_srw_records(ODR o, xmlNodePtr pptr, Z_SRW_record **recs,
         }
         if (!*num)
             return 1;
-        *recs = odr_malloc(o, *num * sizeof(**recs));
+        *recs = (Z_SRW_record *) odr_malloc(o, *num * sizeof(**recs));
         for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
         {
             if (ptr->type == XML_ELEMENT_NODE &&
@@ -282,11 +289,12 @@ static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
         }
         if (!*num)
             return 1;
-        *recs = odr_malloc(o, *num * sizeof(**recs));
+        *recs = (Z_SRW_diagnostic *) odr_malloc(o, *num * sizeof(**recs));
        for (i = 0; i < *num; i++)
        {
-            (*recs)[i].code = 0;
+            (*recs)[i].uri = 0;
             (*recs)[i].details = 0;
+            (*recs)[i].message = 0;
        } 
         for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next)
         {
@@ -294,16 +302,20 @@ static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
                 !strcmp(ptr->name, "diagnostic"))
             {
                 xmlNodePtr rptr;
-                (*recs)[i].code = 0;
+                (*recs)[i].uri = 0;
                 (*recs)[i].details = 0;
+                (*recs)[i].message = 0;
                 for (rptr = ptr->children; rptr; rptr = rptr->next)
                 {
-                    if (match_xsd_integer(rptr, "code", o, 
-                                               &(*recs)[i].code))
+                    if (match_xsd_string(rptr, "uri", o, 
+                                        &(*recs)[i].uri))
                         ;
                     else if (match_xsd_string(rptr, "details", o, 
                                               &(*recs)[i].details))
                         ;
+                    else if (match_xsd_string(rptr, "message", o, 
+                                              &(*recs)[i].message))
+                        ;
                 }
                 i++;
             }
@@ -313,11 +325,22 @@ static int yaz_srw_diagnostics(ODR o, xmlNodePtr pptr, Z_SRW_diagnostic **recs,
     {
         int i;
        xmlNsPtr ns_diag =
-           xmlNewNs(pptr, "http://www.loc.gov/zing/srw/diagnostics/", "diag");
+           xmlNewNs(pptr, "http://www.loc.gov/zing/srw/diagnostic/", 0);
         for (i = 0; i < *num; i++)
         {
+           const char *std_diag = "info:srw/diagnostic/1/";
             xmlNodePtr rptr = xmlNewChild(pptr, ns_diag, "diagnostic", 0);
-            add_xsd_integer(rptr, "code", (*recs)[i].code);
+            add_xsd_string(rptr, "uri", (*recs)[i].uri);
+           if ((*recs)[i].message)
+               add_xsd_string(rptr, "message", (*recs)[i].message);
+           else if ((*recs)[i].uri && 
+                    !strncmp((*recs)[i].uri, std_diag, strlen(std_diag)))
+           {
+               int no = atoi((*recs)[i].uri + strlen(std_diag));
+               const char *message = yaz_diag_srw_str(no);
+               if (message)
+                   add_xsd_string(rptr, "message", message);
+           }
             add_xsd_string(rptr, "details", (*recs)[i].details);
         }
     }
@@ -333,6 +356,7 @@ static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
        term->value = 0;
        term->numberOfRecords = 0;
        term->displayTerm = 0;
+       term->whereInList = 0;
        for (ptr = pptr->children; ptr; ptr = ptr->next)
        {
            if (match_xsd_string(ptr, "value", o,  &term->value))
@@ -343,14 +367,18 @@ static int yaz_srw_term(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm *term,
            else if (match_xsd_string(ptr, "displayTerm", o, 
                                      &term->displayTerm))
                ;
+           else if (match_xsd_string(ptr, "whereInList", o, 
+                                     &term->whereInList))
+               ;
        }
     }
     else if (o->direction == ODR_ENCODE)
     {
        xmlNodePtr ptr = pptr;
        add_xsd_string(ptr, "value", term->value);
-       add_xsd_integer(ptr, "value", term->numberOfRecords);
+       add_xsd_integer(ptr, "numberOfRecords", term->numberOfRecords);
        add_xsd_string(ptr, "displayTerm", term->displayTerm);
+       add_xsd_string(ptr, "whereInList", term->whereInList);
     }
     return 0;
 }
@@ -371,7 +399,7 @@ static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
         }
         if (!*num)
             return 1;
-        *terms = odr_malloc(o, *num * sizeof(**terms));
+        *terms = (Z_SRW_scanTerm *) odr_malloc(o, *num * sizeof(**terms));
         for (i = 0, ptr = pptr->children; ptr; ptr = ptr->next, i++)
         {
             if (ptr->type == XML_ELEMENT_NODE &&
@@ -394,7 +422,7 @@ static int yaz_srw_terms(ODR o, xmlNodePtr pptr, Z_SRW_scanTerm **terms,
 int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                   void *client_data, const char *ns)
 {
-    xmlNodePtr pptr = vptr;
+    xmlNodePtr pptr = (xmlNodePtr) vptr;
     if (o->direction == ODR_DECODE)
     {
        Z_SRW_PDU **p = handler_data;
@@ -408,7 +436,7 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
         if (method->type != XML_ELEMENT_NODE)
             return -1;
 
-       *p = odr_malloc(o, sizeof(**p));
+       *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(**p));
        (*p)->srw_version = odr_strdup(o, "1.1");
        
         if (!strcmp(method->name, "searchRetrieveRequest"))
@@ -417,7 +445,8 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             Z_SRW_searchRetrieveRequest *req;
 
             (*p)->which = Z_SRW_searchRetrieve_request;
-            req = (*p)->u.request = odr_malloc(o, sizeof(*req));
+            req = (*p)->u.request = (Z_SRW_searchRetrieveRequest *)
+               odr_malloc(o, sizeof(*req));
             req->query_type = Z_SRW_query_type_cql;
             req->query.cql = 0;
             req->sort_type = Z_SRW_sort_type_none;
@@ -433,7 +462,10 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
 
             for (; ptr; ptr = ptr->next)
             {
-                if (match_xsd_string(ptr, "query", o, 
+               if (match_xsd_string(ptr, "version", o,
+                                    &(*p)->srw_version))
+                    ;
+                else if (match_xsd_string(ptr, "query", o, 
                                      &req->query.cql))
                     req->query_type = Z_SRW_query_type_cql;
                 else if (match_xsd_string(ptr, "pQuery", o, 
@@ -442,36 +474,33 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                 else if (match_xsd_string(ptr, "xQuery", o, 
                                      &req->query.xcql))
                     req->query_type = Z_SRW_query_type_xcql;
-                else if (match_xsd_string(ptr, "sortKeys", o, 
-                                          &req->sort.sortKeys))
-                    req->sort_type = Z_SRW_sort_type_sort;
-                else if (match_xsd_string(ptr, "recordSchema", o, 
-                                          &req->recordSchema))
+                else if (match_xsd_integer(ptr, "startRecord", o,
+                                           &req->startRecord))
+                    ;
+                else if (match_xsd_integer(ptr, "maximumRecords", o,
+                                           &req->maximumRecords))
                     ;
                 else if (match_xsd_string(ptr, "recordPacking", o,
                                           &req->recordPacking))
                     ;
+                else if (match_xsd_string(ptr, "recordSchema", o, 
+                                          &req->recordSchema))
+                    ;
                 else if (match_xsd_string(ptr, "recordXPath", o,
                                           &req->recordXPath))
                     ;
-                else if (match_xsd_integer(ptr, "startRecord", o,
-                                           &req->startRecord))
-                    ;
-                else if (match_xsd_integer(ptr, "maximumRecords", o,
-                                           &req->maximumRecords))
+                else if (match_xsd_string(ptr, "resultSetTTL", o,
+                                           &req->database))
                     ;
+                else if (match_xsd_string(ptr, "sortKeys", o, 
+                                          &req->sort.sortKeys))
+                    req->sort_type = Z_SRW_sort_type_sort;
                 else if (match_xsd_string(ptr, "stylesheet", o,
                                            &req->stylesheet))
                     ;
                 else if (match_xsd_string(ptr, "database", o,
                                            &req->database))
                     ;
-                else if (match_xsd_string(ptr, "resultSetTTL", o,
-                                           &req->database))
-                    ;
-                else if (match_xsd_string(ptr, "version", o,
-                                           &(*p)->srw_version))
-                    ;
                 /* missing is xQuery, xSortKeys .. */
             }
         }
@@ -481,7 +510,8 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             Z_SRW_searchRetrieveResponse *res;
 
             (*p)->which = Z_SRW_searchRetrieve_response;
-            res = (*p)->u.response = odr_malloc(o, sizeof(*res));
+            res = (*p)->u.response = (Z_SRW_searchRetrieveResponse *)
+               odr_malloc(o, sizeof(*res));
 
             res->numberOfRecords = 0;
             res->resultSetId = 0;
@@ -494,7 +524,10 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
 
             for (; ptr; ptr = ptr->next)
             {
-                if (match_xsd_integer(ptr, "numberOfRecords", o, 
+                if (match_xsd_string(ptr, "version", o,
+                                    &(*p)->srw_version))
+                    ;
+                else if (match_xsd_integer(ptr, "numberOfRecords", o, 
                                       &res->numberOfRecords))
                     ;
                 else if (match_xsd_string(ptr, "resultSetId", o, 
@@ -507,16 +540,13 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                     yaz_srw_records(o, ptr, &res->records,
                                     &res->num_records, client_data,
                                     ns);
+                else if (match_xsd_integer(ptr, "nextRecordPosition", o,
+                                           &res->nextRecordPosition))
+                    ;
                 else if (match_element(ptr, "diagnostics"))
                     yaz_srw_diagnostics(o, ptr, &res->diagnostics,
                                         &res->num_diagnostics,
                                         client_data, ns);
-                else if (match_xsd_integer(ptr, "nextRecordPosition", o,
-                                           &res->nextRecordPosition))
-                    ;
-                else if (match_xsd_string(ptr, "version", o,
-                                           &(*p)->srw_version))
-                    ;
             }
         }
         else if (!strcmp(method->name, "explainRequest"))
@@ -525,24 +555,25 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
            xmlNodePtr ptr = method->children;
             
             (*p)->which = Z_SRW_explain_request;
-            req = (*p)->u.explain_request = odr_malloc(o, sizeof(*req));
+            req = (*p)->u.explain_request = (Z_SRW_explainRequest *)
+               odr_malloc(o, sizeof(*req));
            req->recordPacking = 0;
            req->database = 0;
            req->stylesheet = 0;
            for (; ptr; ptr = ptr->next)
            {
-               if (match_xsd_string(ptr, "database", o,
-                                    &req->database))
-                    ;
+                if (match_xsd_string(ptr, "version", o,
+                                           &(*p)->srw_version))
+                   ;
                else if (match_xsd_string(ptr, "stylesheet", o,
                                          &req->stylesheet))
                    ;
                else if (match_xsd_string(ptr, "recordPacking", o,
                                     &req->recordPacking))
                    ;
-                else if (match_xsd_string(ptr, "version", o,
-                                           &(*p)->srw_version))
-                   ;
+               else if (match_xsd_string(ptr, "database", o,
+                                    &req->database))
+                    ;
            }
         }
         else if (!strcmp(method->name, "explainResponse"))
@@ -551,17 +582,22 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             xmlNodePtr ptr = method->children;
 
             (*p)->which = Z_SRW_explain_response;
-            res = (*p)->u.explain_response = odr_malloc(o, sizeof(*res));
+            res = (*p)->u.explain_response = (Z_SRW_explainResponse*)
+               odr_malloc(o, sizeof(*res));
             res->diagnostics = 0;
             res->num_diagnostics = 0;
+           res->record.recordSchema = 0;
+           res->record.recordData_buf = 0;
+           res->record.recordData_len = 0;
+           res->record.recordPosition = 0;
 
            for (; ptr; ptr = ptr->next)
            {
-               if (match_element(ptr, "record"))
-                   yaz_srw_record(o, ptr, &res->record, client_data, ns);
-                else if (match_xsd_string(ptr, "version", o,
-                                         &(*p)->srw_version))
+                if (match_xsd_string(ptr, "version", o,
+                                           &(*p)->srw_version))
                    ;
+               else if (match_element(ptr, "record"))
+                   yaz_srw_record(o, ptr, &res->record, client_data, ns);
                else if (match_element(ptr, "diagnostics"))
                     yaz_srw_diagnostics(o, ptr, &res->diagnostics,
                                         &res->num_diagnostics,
@@ -575,12 +611,14 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             xmlNodePtr ptr = method->children;
 
             (*p)->which = Z_SRW_scan_request;
-            req = (*p)->u.scan_request = odr_malloc(o, sizeof(*req));
-           req->database = 0;
-           req->scanClause = 0;
-           req->stylesheet = 0;
+            req = (*p)->u.scan_request = (Z_SRW_scanRequest *)
+               odr_malloc(o, sizeof(*req));
+           req->query_type = Z_SRW_query_type_cql;
+           req->scanClause.cql = 0;
            req->responsePosition = 0;
            req->maximumTerms = 0;
+           req->stylesheet = 0;
+           req->database = 0;
            
            for (; ptr; ptr = ptr->next)
            {
@@ -588,20 +626,25 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                                     &(*p)->srw_version))
                    ;
                else if (match_xsd_string(ptr, "scanClause", o,
-                                    &req->scanClause))
-                   ;
-               else if (match_xsd_string(ptr, "database", o,
-                                         &req->database))
-                    ;
-               else if (match_xsd_string(ptr, "stylesheet", o,
-                                         &req->stylesheet))
+                                    &req->scanClause.cql))
                    ;
+               else if (match_xsd_string(ptr, "pScanClause", o,
+                                         &req->scanClause.pqf))
+               {
+                   req->query_type = Z_SRW_query_type_pqf;
+               }
                else if (match_xsd_integer(ptr, "responsePosition", o,
                                           &req->responsePosition))
                    ;
                else if (match_xsd_integer(ptr, "maximumTerms", o,
                                           &req->maximumTerms))
                     ;
+               else if (match_xsd_string(ptr, "stylesheet", o,
+                                         &req->stylesheet))
+                   ;
+               else if (match_xsd_string(ptr, "database", o,
+                                         &req->database))
+                    ;
            }
         }
         else if (!strcmp(method->name, "scanResponse"))
@@ -610,7 +653,8 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
             xmlNodePtr ptr = method->children;
 
             (*p)->which = Z_SRW_scan_response;
-            res = (*p)->u.scan_response = odr_malloc(o, sizeof(*res));
+            res = (*p)->u.scan_response = (Z_SRW_scanResponse *)
+               odr_malloc(o, sizeof(*res));
            res->terms = 0;
            res->num_terms = 0;
            res->diagnostics = 0;
@@ -618,7 +662,10 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
            
            for (; ptr; ptr = ptr->next)
            {
-                if (match_element(ptr, "terms"))
+               if (match_xsd_string(ptr, "version", o,
+                                    &(*p)->srw_version))
+                   ;
+                else if (match_element(ptr, "terms"))
                     yaz_srw_terms(o, ptr, &res->terms,
                                  &res->num_terms, client_data,
                                  ns);
@@ -626,9 +673,6 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                     yaz_srw_diagnostics(o, ptr, &res->diagnostics,
                                         &res->num_diagnostics,
                                         client_data, ns);
-               else if (match_xsd_string(ptr, "version", o,
-                                         &(*p)->srw_version))
-                   ;
            }
         }
         else
@@ -664,6 +708,12 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                 add_xsd_string(ptr, "pQuery", req->query.pqf);
                 break;
             }
+            add_xsd_integer(ptr, "startRecord", req->startRecord);
+            add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
+            add_xsd_string(ptr, "recordPacking", req->recordPacking);
+            add_xsd_string(ptr, "recordSchema", req->recordSchema);
+            add_xsd_string(ptr, "recordXPath", req->recordXPath);
+            add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
             switch(req->sort_type)
             {
             case Z_SRW_sort_type_none:
@@ -675,14 +725,8 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                 add_xsd_string(ptr, "xSortKeys", req->sort.xSortKeys);
                 break;
             }
-            add_xsd_integer(ptr, "startRecord", req->startRecord);
-            add_xsd_integer(ptr, "maximumRecords", req->maximumRecords);
-            add_xsd_string(ptr, "recordSchema", req->recordSchema);
-            add_xsd_string(ptr, "recordPacking", req->recordPacking);
-            add_xsd_string(ptr, "recordXPath", req->recordXPath);
-            add_xsd_string(ptr, "database", req->database);
-            add_xsd_integer(ptr, "resultSetTTL", req->resultSetTTL);
             add_xsd_string(ptr, "stylesheet", req->stylesheet);
+            add_xsd_string(ptr, "database", req->database);
         }
         else if ((*p)->which == Z_SRW_searchRetrieve_response)
         {
@@ -703,13 +747,14 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
                 yaz_srw_records(o, rptr, &res->records, &res->num_records,
                                 client_data, ns);
             }
+            add_xsd_integer(ptr, "nextRecordPosition",
+                           res->nextRecordPosition);
             if (res->num_diagnostics)
             {
                 xmlNodePtr rptr = xmlNewChild(ptr, 0, "diagnostics", 0);
                 yaz_srw_diagnostics(o, rptr, &res->diagnostics,
                                     &res->num_diagnostics, client_data, ns);
             }
-            add_xsd_integer(ptr, "nextRecordPosition", res->nextRecordPosition);
         }
         else if ((*p)->which == Z_SRW_explain_request)
         {
@@ -721,6 +766,7 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
            add_xsd_string(ptr, "version", (*p)->srw_version);
             add_xsd_string(ptr, "recordPacking", req->recordPacking);
             add_xsd_string(ptr, "stylesheet", req->stylesheet);
+            add_xsd_string(ptr, "database", req->database);
         }
         else if ((*p)->which == Z_SRW_explain_response)
         {
@@ -750,10 +796,19 @@ int yaz_srw_codec(ODR o, void * vptr, Z_SRW_PDU **handler_data,
            xmlSetNs(ptr, ns_srw);
 
            add_xsd_string(ptr, "version", (*p)->srw_version);
-           add_xsd_string(ptr, "scanClause", req->scanClause);
+           switch(req->query_type)
+           {
+           case Z_SRW_query_type_cql:
+               add_xsd_string(ptr, "scanClause", req->scanClause.cql);
+               break;
+           case Z_SRW_query_type_pqf:
+               add_xsd_string(ptr, "pScanClause", req->scanClause.pqf);
+               break;
+           }
            add_xsd_integer(ptr, "responsePosition", req->responsePosition);
            add_xsd_integer(ptr, "maximumTerms", req->maximumTerms);
            add_xsd_string(ptr, "stylesheet", req->stylesheet);
+            add_xsd_string(ptr, "database", req->database);
         }
         else if ((*p)->which == Z_SRW_scan_response)
         {