Reformat
[yaz-moved-to-github.git] / src / srwutil.c
index baac6a7..40c8039 100644 (file)
@@ -1,62 +1,88 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2009 Index Data
+ * Copyright (C) 1995-2011 Index Data
  * See the file LICENSE for details.
  */
 /**
  * \file srwutil.c
  * \brief Implements SRW/SRU utilities.
  */
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
 
 #include <stdlib.h>
+#include <assert.h>
 #include <yaz/srw.h>
 #include <yaz/matchstr.h>
+#include <yaz/base64.h>
 #include <yaz/yaz-iconv.h>
+#include "sru-p.h"
 
-#if YAZ_HAVE_XML2
-static int yaz_base64decode(const char *in, char *out)
+#define MAX_SRU_PARAMETERS 30
+
+static char *yaz_decode_sru_dbpath_odr(ODR n, const char *uri, size_t len)
 {
-    const char *map = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-       "abcdefghijklmnopqrstuvwxyz0123456789+/";
-    int olen = 0;
-    int len = strlen(in);
+    return odr_strdupn(n, uri, len);
+}
 
-    while (len >= 4)
-    {
-       char i0, i1, i2, i3;
-       char *p;
-
-       if (!(p = strchr(map, in[0])))
-           return 0;
-       i0 = p - map;
-       len--;
-       if (!(p = strchr(map, in[1])))
-           return 0;
-       i1 = p - map;
-       len--;
-       *(out++) = i0 << 2 | i1 >> 4;
-       olen++;
-       if (in[2] == '=')
-           break;
-       if (!(p = strchr(map, in[2])))
-           return 0;
-       i2 = p - map;
-       len--;
-       *(out++) = i1 << 4 | i2 >> 2;
-       olen++;
-       if (in[3] == '=')
-           break;
-       if (!(p = strchr(map, in[3])))
-           return 0;
-       i3 = p - map;
-       len--;
-       *(out++) = i2 << 6 | i3;
-       olen++;
-
-       in += 4;
-    }
+void yaz_encode_sru_dbpath_buf(char *dst, const char *db)
+{
+    assert(db);
+    *dst = '/';
+    strcpy(dst+1, db);
+}
 
-    *out = '\0';
-    return olen;
+char *yaz_encode_sru_dbpath_odr(ODR out, const char *db)
+{
+    char *dst = odr_malloc(out, 3 * strlen(db) + 2);
+    yaz_encode_sru_dbpath_buf(dst, db);
+    return dst;
+}
+
+Z_AttributeList *yaz_use_attribute_create(ODR o, const char *name)
+{
+    Z_AttributeList *attributes= (Z_AttributeList *)
+        odr_malloc(o, sizeof(*attributes));
+    Z_AttributeElement ** elements;
+    attributes->num_attributes = 1;
+    elements = (Z_AttributeElement**)
+        odr_malloc(o, attributes->num_attributes * sizeof(*elements));
+    elements[0] = (Z_AttributeElement*) odr_malloc(o,sizeof(**elements));
+    elements[0]->attributeType = odr_intdup(o, 1);
+    elements[0]->attributeSet = odr_nullval();
+    elements[0]->which = Z_AttributeValue_complex;
+    elements[0]->value.complex = (Z_ComplexAttribute *)
+        odr_malloc(o, sizeof(Z_ComplexAttribute));
+    elements[0]->value.complex->num_list = 1;
+    elements[0]->value.complex->list = (Z_StringOrNumeric **)
+        odr_malloc(o, 1 * sizeof(Z_StringOrNumeric *));
+    elements[0]->value.complex->list[0] = (Z_StringOrNumeric *)
+        odr_malloc(o, sizeof(Z_StringOrNumeric));
+    elements[0]->value.complex->list[0]->which = Z_StringOrNumeric_string;
+    elements[0]->value.complex->list[0]->u.string = odr_strdup(o, name);
+    elements[0]->value.complex->semanticAction = 0;
+    elements[0]->value.complex->num_semanticAction = 0;
+    attributes->attributes = elements;
+    return attributes;
+}
+
+#if YAZ_HAVE_XML2
+const char *yaz_element_attribute_value_get(xmlNodePtr ptr,
+                                            const char *node_name,
+                                            const char *attribute_name)
+{
+    struct _xmlAttr *attr;
+    // check if the node name matches
+    if (strcmp((const char*) ptr->name, node_name))
+        return 0;
+    // check if the attribute name and return the value
+    for (attr = ptr->properties; attr; attr = attr->next)
+        if (attr->children && attr->children->type == XML_TEXT_NODE)
+        {
+            if (!strcmp((const char *) attr->name, attribute_name))
+                return (const char *) attr->children->content;
+        }
+    return 0;
 }
 #endif
 
@@ -78,7 +104,6 @@ int yaz_srw_check_content_type(Z_HTTP_Response *hres)
  * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password
  * parameters. Added by SH.
  */
-#if YAZ_HAVE_XML2
 static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
                                char *username, char *password, ODR decode)
 {
@@ -89,8 +114,9 @@ static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
     if (password)
         sr->password = password;
 
-    if (basic) {
-        int len, olen;
+    if (basic)
+    {
+        int len;
         char out[256];
         char ubuf[256] = "", pbuf[256] = "", *p;
         if (strncmp(basic, "Basic ", 6))
@@ -99,10 +125,11 @@ static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
         len = strlen(basic);
         if (!len || len > 256)
             return;
-        olen = yaz_base64decode(basic, out);
+        yaz_base64decode(basic, out);
         /* Format of out should be username:password at this point */
         strcpy(ubuf, out);
-        if ((p = strchr(ubuf, ':'))) {
+        if ((p = strchr(ubuf, ':')))
+        {
             *(p++) = '\0';
             if (*p)
                 strcpy(pbuf, p);
@@ -113,7 +140,6 @@ static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq,
             sr->password = odr_strdup(decode, pbuf);
     }
 }
-#endif
 
 void yaz_uri_val_int(const char *path, const char *name, ODR o, Odr_int **intp)
 {
@@ -151,9 +177,9 @@ void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
                                 const char *message, const char *details)
 {
     Z_SRW_diagnostic *d_new;
-    d_new = (Z_SRW_diagnostic *) odr_malloc (o, (*num + 1)* sizeof(**d));
+    d_new = (Z_SRW_diagnostic *) odr_malloc(o, (*num + 1)* sizeof(**d));
     if (*num)
-        memcpy (d_new, *d, *num *sizeof(**d));
+        memcpy(d_new, *d, *num *sizeof(**d));
     *d = d_new;
 
     yaz_mk_srw_diagnostic(o, *d + *num, uri, message, details);
@@ -258,12 +284,7 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             if (!p1)
                 p1 = p0 + strlen(p0);
             if (p1 != p0)
-            {
-                db = (char*) odr_malloc(decode, p1 - p0 + 1);
-                memcpy (db, p0, p1 - p0);
-                db[p1 - p0] = '\0';
-            }
-
+                db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
             grab_charset(decode, content_type, charset);
 
             ret = z_soap_codec(decode, soap_package, 
@@ -272,6 +293,7 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
             {
                 *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
+                yaz_srw_decodeauth(*srw_pdu, hreq, 0, 0, decode);
                 
                 if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
                     (*srw_pdu)->u.request->database == 0)
@@ -324,7 +346,7 @@ static int yaz_sru_decode_integer(ODR odr, const char *pname,
 #endif
 
 /**
-  http://www.loc.gov/z3950/agency/zing/srw/service.html
+   http://www.loc.gov/z3950/agency/zing/srw/service.html
 */ 
 int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                    Z_SOAP **soap_package, ODR decode, char **charset,
@@ -337,7 +359,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     };
 #endif
     const char *content_type = z_HTTP_header_lookup(hreq->headers,
-                                            "Content-Type");
+                                                    "Content-Type");
 
     /*
       SRU GET: ignore content type.
@@ -346,9 +368,9 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     */
     if (!strcmp(hreq->method, "GET")
         || 
-             (!strcmp(hreq->method, "POST") && content_type &&
-              !yaz_strcmp_del("application/x-www-form-urlencoded",
-                              content_type, "; ")))
+        (!strcmp(hreq->method, "POST") && content_type &&
+         !yaz_strcmp_del("application/x-www-form-urlencoded",
+                         content_type, "; ")))
     {
         char *db = "Default";
         const char *p0 = hreq->path, *p1;
@@ -370,7 +392,6 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
         char *startRecord = 0;
         char *maximumTerms = 0;
         char *responsePosition = 0;
-        char *extraRequestData = 0;
         Z_SRW_extra_arg *extra_args = 0;
 #endif
         char **uri_name;
@@ -386,11 +407,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
         if (!p1)
             p1 = p0 + strlen(p0);
         if (p1 != p0)
-        {
-            db = (char*) odr_malloc(decode, p1 - p0 + 1);
-            memcpy (db, p0, p1 - p0);
-            db[p1 - p0] = '\0';
-        }
+            db = yaz_decode_sru_dbpath_odr(decode, p0, p1 - p0);
         if (!strcmp(hreq->method, "POST"))
             p1 = hreq->content_buf;
         yaz_uri_to_array(p1, decode, &uri_name, &uri_val);
@@ -437,7 +454,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                 else if (!strcmp(n, "responsePosition"))
                     responsePosition = v;
                 else if (!strcmp(n, "extraRequestData"))
-                    extraRequestData = v;
+                    ; /* ignoring extraRequestData */
                 else if (n[0] == 'x' && n[1] == '-')
                 {
                     Z_SRW_extra_arg **l = &extra_args;
@@ -735,6 +752,7 @@ Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version)
         sr->u.request->database = 0;
         sr->u.request->resultSetTTL = 0;
         sr->u.request->stylesheet = 0;
+        sr->u.request->facetList = 0;
         break;
     case Z_SRW_searchRetrieve_response:
         sr->u.response = (Z_SRW_searchRetrieveResponse *)
@@ -748,6 +766,7 @@ Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version)
         sr->u.response->num_diagnostics = 0;
         sr->u.response->nextRecordPosition = 0;
         sr->u.response->extra_records = 0;
+        sr->u.response->facetList = 0;
         break;
     case Z_SRW_explain_request:
         sr->u.explain_request = (Z_SRW_explainRequest *)
@@ -1034,8 +1053,8 @@ int yaz_diag_srw_to_bib1(int code)
     return 1;
 }
 
-static void add_val_int(ODR o, char **name, char **value,  int *i,
-                        char *a_name, Odr_int *val)
+void yaz_add_name_value_int(ODR o, char **name, char **value, int *i,
+                            char *a_name, Odr_int *val)
 {
     if (val)
     {
@@ -1046,8 +1065,8 @@ static void add_val_int(ODR o, char **name, char **value,  int *i,
     }
 }
 
-static void add_val_str(ODR o, char **name, char **value,  int *i,
-                        char *a_name, char *val)
+void yaz_add_name_value_str(ODR o, char **name, char **value,  int *i,
+                            char *a_name, char *val)
 {
     if (val)
     {
@@ -1061,7 +1080,7 @@ static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
                              char **name, char **value, int max_names)
 {
     int i = 0;
-    add_val_str(encode, name, value, &i, "version", srw_pdu->srw_version);
+    yaz_add_name_value_str(encode, name, value, &i, "version", srw_pdu->srw_version);
     name[i] = "operation";
     switch(srw_pdu->which)
     {
@@ -1070,16 +1089,16 @@ static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
         switch(srw_pdu->u.request->query_type)
         {
         case Z_SRW_query_type_cql:
-            add_val_str(encode, name, value, &i, "query",
-                        srw_pdu->u.request->query.cql);
+            yaz_add_name_value_str(encode, name, value, &i, "query",
+                                   srw_pdu->u.request->query.cql);
             break;
         case Z_SRW_query_type_pqf:
-            add_val_str(encode, name, value, &i, "x-pquery",
-                        srw_pdu->u.request->query.pqf);
+            yaz_add_name_value_str(encode, name, value, &i, "x-pquery",
+                                   srw_pdu->u.request->query.pqf);
             break;
         case Z_SRW_query_type_xcql:
-            add_val_str(encode, name, value, &i, "x-cql",
-                        srw_pdu->u.request->query.xcql);
+            yaz_add_name_value_str(encode, name, value, &i, "x-cql",
+                                   srw_pdu->u.request->query.xcql);
             break;
         }
         switch(srw_pdu->u.request->sort_type)
@@ -1087,29 +1106,29 @@ static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
         case Z_SRW_sort_type_none:
             break;
         case Z_SRW_sort_type_sort:            
-            add_val_str(encode, name, value, &i, "sortKeys",
-                        srw_pdu->u.request->sort.sortKeys);
+            yaz_add_name_value_str(encode, name, value, &i, "sortKeys",
+                                   srw_pdu->u.request->sort.sortKeys);
             break;
         }
-        add_val_int(encode, name, value, &i, "startRecord", 
-                    srw_pdu->u.request->startRecord);
-        add_val_int(encode, name, value, &i, "maximumRecords", 
-                    srw_pdu->u.request->maximumRecords);
-        add_val_str(encode, name, value, &i, "recordSchema",
-                    srw_pdu->u.request->recordSchema);
-        add_val_str(encode, name, value, &i, "recordPacking",
-                    srw_pdu->u.request->recordPacking);
-        add_val_str(encode, name, value, &i, "recordXPath",
-                    srw_pdu->u.request->recordXPath);
-        add_val_str(encode, name, value, &i, "stylesheet",
-                    srw_pdu->u.request->stylesheet);
-        add_val_int(encode, name, value, &i, "resultSetTTL", 
-                    srw_pdu->u.request->resultSetTTL);
+        yaz_add_name_value_int(encode, name, value, &i, "startRecord", 
+                               srw_pdu->u.request->startRecord);
+        yaz_add_name_value_int(encode, name, value, &i, "maximumRecords", 
+                               srw_pdu->u.request->maximumRecords);
+        yaz_add_name_value_str(encode, name, value, &i, "recordSchema",
+                               srw_pdu->u.request->recordSchema);
+        yaz_add_name_value_str(encode, name, value, &i, "recordPacking",
+                               srw_pdu->u.request->recordPacking);
+        yaz_add_name_value_str(encode, name, value, &i, "recordXPath",
+                               srw_pdu->u.request->recordXPath);
+        yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
+                               srw_pdu->u.request->stylesheet);
+        yaz_add_name_value_int(encode, name, value, &i, "resultSetTTL", 
+                               srw_pdu->u.request->resultSetTTL);
         break;
     case Z_SRW_explain_request:
         value[i++] = "explain";
-        add_val_str(encode, name, value, &i, "stylesheet",
-                    srw_pdu->u.explain_request->stylesheet);
+        yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
+                               srw_pdu->u.explain_request->stylesheet);
         break;
     case Z_SRW_scan_request:
         value[i++] = "scan";
@@ -1117,24 +1136,24 @@ static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
         switch(srw_pdu->u.scan_request->query_type)
         {
         case Z_SRW_query_type_cql:
-            add_val_str(encode, name, value, &i, "scanClause",
-                        srw_pdu->u.scan_request->scanClause.cql);
+            yaz_add_name_value_str(encode, name, value, &i, "scanClause",
+                                   srw_pdu->u.scan_request->scanClause.cql);
             break;
         case Z_SRW_query_type_pqf:
-            add_val_str(encode, name, value, &i, "x-pScanClause",
-                        srw_pdu->u.scan_request->scanClause.pqf);
+            yaz_add_name_value_str(encode, name, value, &i, "x-pScanClause",
+                                   srw_pdu->u.scan_request->scanClause.pqf);
             break;
         case Z_SRW_query_type_xcql:
-            add_val_str(encode, name, value, &i, "x-cqlScanClause",
-                        srw_pdu->u.scan_request->scanClause.xcql);
+            yaz_add_name_value_str(encode, name, value, &i, "x-cqlScanClause",
+                                   srw_pdu->u.scan_request->scanClause.xcql);
             break;
         }
-        add_val_int(encode, name, value, &i, "responsePosition", 
-                    srw_pdu->u.scan_request->responsePosition);
-        add_val_int(encode, name, value, &i, "maximumTerms", 
-                    srw_pdu->u.scan_request->maximumTerms);
-        add_val_str(encode, name, value, &i, "stylesheet",
-                    srw_pdu->u.scan_request->stylesheet);
+        yaz_add_name_value_int(encode, name, value, &i, "responsePosition", 
+                               srw_pdu->u.scan_request->responsePosition);
+        yaz_add_name_value_int(encode, name, value, &i, "maximumTerms", 
+                               srw_pdu->u.scan_request->maximumTerms);
+        yaz_add_name_value_str(encode, name, value, &i, "stylesheet",
+                               srw_pdu->u.scan_request->stylesheet);
         break;
     case Z_SRW_update_request:
         value[i++] = "update";
@@ -1160,13 +1179,13 @@ static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
 int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
                        ODR encode, const char *charset)
 {
-    char *name[30], *value[30]; /* definite upper limit for SRU params */
+    char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
     char *uri_args;
     char *path;
 
     z_HTTP_header_add_basic_auth(encode, &hreq->headers, 
                                  srw_pdu->username, srw_pdu->password);
-    if (yaz_get_sru_parms(srw_pdu, encode, name, value, 30))
+    if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
         return -1;
     yaz_array_to_uri(&uri_args, encode, name, value);
 
@@ -1176,6 +1195,7 @@ int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
         odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4);
 
     sprintf(path, "%s?%s", hreq->path, uri_args);
+    yaz_log(YLOG_DEBUG, "SRU HTTP Get Request %s", path);
     hreq->path = path;
 
     z_HTTP_header_add_content_type(encode, &hreq->headers,
@@ -1186,12 +1206,12 @@ int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
                         ODR encode, const char *charset)
 {
-    char *name[30], *value[30]; /* definite upper limit for SRU params */
+    char *name[MAX_SRU_PARAMETERS], *value[MAX_SRU_PARAMETERS]; /* definite upper limit for SRU params */
     char *uri_args;
 
     z_HTTP_header_add_basic_auth(encode, &hreq->headers, 
                                  srw_pdu->username, srw_pdu->password);
-    if (yaz_get_sru_parms(srw_pdu, encode, name, value, 30))
+    if (yaz_get_sru_parms(srw_pdu, encode, name, value, MAX_SRU_PARAMETERS))
         return -1;
 
     yaz_array_to_uri(&uri_args, encode, name, value);
@@ -1245,12 +1265,13 @@ int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
                             charset);
 }
 
-Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num )
+Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num)
 {
     Z_SRW_recordVersion *ver 
-        = (Z_SRW_recordVersion *) odr_malloc( odr, num * sizeof(*ver) );
+        = (Z_SRW_recordVersion *) odr_malloc(odr,num * sizeof(*ver));
     int i;
-    for ( i=0; i < num; ++i ){
+    for (i = 0; i < num; ++i)
+    {
         ver[i].versionType = 0;
         ver[i].versionValue = 0;
     }
@@ -1305,7 +1326,6 @@ void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args)
 }
 
 
-
 /*
  * Local variables:
  * c-basic-offset: 4