For Libxml2 and friends, YAZ defines YAZ_HAVE_{XML2,XSLT,EXSLT) in
[yaz-moved-to-github.git] / src / srwutil.c
index 6519422..9e698c6 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: srwutil.c,v 1.34 2005-12-14 14:05:55 adam Exp $
+ * $Id: srwutil.c,v 1.45 2006-07-06 10:17:54 adam Exp $
  */
 /**
  * \file srwutil.c
@@ -24,6 +24,52 @@ static int hex_digit (int ch)
     return 0;
 }
 
+void encode_uri_char(char *dst, char ch)
+{
+    if (ch == ' ')
+        strcpy(dst, "+");
+    else if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') ||
+        (ch >= '0' && ch <= '9'))
+    {
+        dst[0] = ch;
+        dst[1] = '\0';
+    }
+    else
+    {
+        dst[0] = '%';
+        sprintf(dst+1, "%02X", (unsigned char ) ch);
+    }
+}
+
+void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
+{
+    size_t i, szp = 0, sz = 0;
+    for(i = 0; name[i]; i++)
+        sz += strlen(name[i]) + 3 + strlen(value[i]) * 3;
+    *path = odr_malloc(o, sz);
+    
+    for(i = 0; name[i]; i++)
+    {
+        size_t j, ilen;
+        if (i)
+            (*path)[szp++] = '&';
+        ilen = strlen(name[i]);
+        memcpy(*path+szp, name[i], ilen);
+        szp += ilen;
+        (*path)[szp++] = '=';
+        for (j = 0; value[i][j]; j++)
+        {
+            size_t vlen;
+            char vstr[5];
+            encode_uri_char(vstr, value[i][j]);
+            vlen = strlen(vstr);
+            memcpy(*path+szp, vstr, vlen);
+            szp += vlen;
+        }
+    }
+    (*path)[szp] = '\0';
+}
+
 int yaz_uri_array(const char *path, ODR o, char ***name, char ***val)
 {
     int no = 2;
@@ -32,7 +78,7 @@ int yaz_uri_array(const char *path, ODR o, char ***name, char ***val)
     if (*path == '?')
         path++;
     if (!*path)
-        return no;
+        return 0;
     cp = path;
     while ((cp = strchr(cp, '&')))
     {
@@ -130,6 +176,91 @@ char *yaz_uri_val(const char *path, const char *name, ODR o)
     return 0;
 }
 
+static int yaz_base64decode(const char *in, char *out)
+{
+    const char *map = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+       "abcdefghijklmnopqrstuvwxyz0123456789+/";
+    int olen = 0;
+    int len = strlen(in);
+
+    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;
+    }
+
+    *out = '\0';
+    return olen;
+}
+
+/**
+ * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password
+ * parameters. Added by SH.
+ */
+static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq, char *username,
+        char *password, ODR decode)
+{
+    const char *basic = z_HTTP_header_lookup(hreq->headers, "Authorization");
+
+    if (username)
+        sr->username = username;
+    if (password)
+        sr->password = password;
+
+    if (basic) {
+        int len, olen;
+        char out[256];
+        char ubuf[256] = "", pbuf[256] = "", *p;
+        if (strncmp(basic, "Basic ", 6))
+            return;
+        basic += 6;
+        len = strlen(basic);
+        if (!len || len > 256)
+            return;
+        olen = yaz_base64decode(basic, out);
+        /* Format of out should be username:password at this point */
+        strcpy(ubuf, out);
+        if ((p = strchr(ubuf, ':'))) {
+            *(p++) = '\0';
+            if (*p)
+                strcpy(pbuf, p);
+        }
+        if (*ubuf)
+            sr->username = odr_strdup(decode, ubuf);
+        if (*pbuf)
+            sr->password = odr_strdup(decode, pbuf);
+    }
+}
+
 void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp)
 {
     const char *v = yaz_uri_val(path, name, o);
@@ -158,7 +289,7 @@ void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
     char uri[40];
     
     sprintf(uri, "info:srw/diagnostic/1/%d", code);
-    return yaz_mk_srw_diagnostic(o, d, uri, 0, details);
+    yaz_mk_srw_diagnostic(o, d, uri, 0, details);
 }
 
 void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
@@ -181,7 +312,7 @@ void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
     char uri[40];
     
     sprintf(uri, "info:srw/diagnostic/1/%d", code);
-    return yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
+    yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
 }
 
 int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
@@ -193,6 +324,7 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                                                         "Content-Type");
         if (content_type && 
             (!yaz_strcmp_del("text/xml", content_type, "; ") ||
+             !yaz_strcmp_del("application/soap+xml", content_type, "; ") ||
              !yaz_strcmp_del("text/plain", content_type, "; ")))
         {
             char *db = "Default";
@@ -201,7 +333,7 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             const char *charset_p = 0;
             
             static Z_SOAP_Handler soap_handlers[4] = {
-#if HAVE_XML2
+#if YAZ_HAVE_XML2
                 {"http://www.loc.gov/zing/srw/", 0,
                  (Z_SOAP_fun) yaz_srw_codec},
                 {"http://www.loc.gov/zing/srw/v1.0/", 0,
@@ -266,6 +398,23 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     return 2;
 }
 
+static int yaz_sru_integer_decode(ODR odr, const char *pname, 
+                                  const char *valstr, int **valp,
+                                  Z_SRW_diagnostic **diag, int *num_diag)
+
+{
+    int ival;
+    if (!valstr)
+        return 0;
+    if (sscanf(valstr, "%d", &ival) != 1)
+    {
+        yaz_add_srw_diagnostic(odr, diag, num_diag,
+                               YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname);
+        return 0;
+    }
+    *valp = odr_intdup(odr, ival);
+    return 1;
+}
 /**
   http://www.loc.gov/z3950/agency/zing/srw/service.html
 */ 
@@ -273,7 +422,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                    Z_SOAP **soap_package, ODR decode, char **charset,
                    Z_SRW_diagnostic **diag, int *num_diag)
 {
-#if HAVE_XML2
+#if YAZ_HAVE_XML2
     static Z_SOAP_Handler soap_handlers[2] = {
         {"http://www.loc.gov/zing/srw/", 0,
          (Z_SOAP_fun) yaz_srw_codec},
@@ -298,11 +447,13 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     {
         char *db = "Default";
         const char *p0 = hreq->path, *p1;
-#if HAVE_XML2
+#if YAZ_HAVE_XML2
         const char *operation = 0;
         char *version = 0;
         char *query = 0;
         char *pQuery = 0;
+        char *username = 0;
+        char *password = 0;
         char *sortKeys = 0;
         char *stylesheet = 0;
         char *scanClause = 0;
@@ -335,7 +486,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
         if (!strcmp(hreq->method, "POST"))
             p1 = hreq->content_buf;
         yaz_uri_array(p1, decode, &uri_name, &uri_val);
-#if HAVE_XML2
+#if YAZ_HAVE_XML2
         if (uri_name)
         {
             int i;
@@ -347,6 +498,10 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                     query = v;
                 else if (!strcmp(n, "x-pquery"))
                     pQuery = v;
+                else if (!strcmp(n, "x-username"))
+                    username = v;
+                else if (!strcmp(n, "x-password"))
+                    password = v;
                 else if (!strcmp(n, "operation"))
                     operation = v;
                 else if (!strcmp(n, "stylesheet"))
@@ -376,21 +531,27 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                 else if (!strcmp(n, "extraRequestData"))
                     extraRequestData = v;
                 else
-                    yaz_add_srw_diagnostic(decode, diag, num_diag, 8, n);
+                    yaz_add_srw_diagnostic(decode, diag, num_diag,
+                                           YAZ_SRW_UNSUPP_PARAMETER, n);
             }
         }
         if (!version)
         {
             if (uri_name)
-                yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "version");
+                yaz_add_srw_diagnostic(
+                    decode, diag, num_diag,
+                    YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "version");
             version = "1.1";
         }
         if (strcmp(version, "1.1"))
-            yaz_add_srw_diagnostic(decode, diag, num_diag, 5, "1.1");
+            yaz_add_srw_diagnostic(decode, diag, num_diag,
+                                   YAZ_SRW_UNSUPP_VERSION, "1.1");
         if (!operation)
         {
             if (uri_name)
-                yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "operation");
+                yaz_add_srw_diagnostic(
+                    decode, diag, num_diag, 
+                    YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation");
             operation = "explain";
         }
         if (!strcmp(operation, "searchRetrieve"))
@@ -399,6 +560,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 
             sr->srw_version = version;
             *srw_pdu = sr;
+            yaz_srw_decodeauth(sr, hreq, username, password, decode);
             if (query)
             {
                 sr->u.request->query_type = Z_SRW_query_type_cql;
@@ -410,7 +572,9 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                 sr->u.request->query.pqf = pQuery;
             }
             else
-                yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "query");
+                yaz_add_srw_diagnostic(
+                    decode, diag, num_diag, 
+                    YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query");
 
             if (sortKeys)
             {
@@ -422,12 +586,13 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             sr->u.request->recordPacking = recordPacking;
             sr->u.request->stylesheet = stylesheet;
 
-            if (maximumRecords)
-                sr->u.request->maximumRecords =
-                    odr_intdup(decode, atoi(maximumRecords));
-            if (startRecord)
-                sr->u.request->startRecord =
-                    odr_intdup(decode, atoi(startRecord));
+            yaz_sru_integer_decode(decode, "maximumRecords", maximumRecords, 
+                                   &sr->u.request->maximumRecords, 
+                                   diag, num_diag);
+
+            yaz_sru_integer_decode(decode, "startRecord", startRecord, 
+                                   &sr->u.request->startRecord,
+                                   diag, num_diag);
 
             sr->u.request->database = db;
 
@@ -452,6 +617,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 
             sr->srw_version = version;
+            yaz_srw_decodeauth(sr, hreq, username, password, decode);
             *srw_pdu = sr;
             sr->u.explain_request->recordPacking = recordPacking;
             sr->u.explain_request->database = db;
@@ -480,6 +646,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 
             sr->srw_version = version;
             *srw_pdu = sr;
+            yaz_srw_decodeauth(sr, hreq, username, password, decode);
 
             if (scanClause)
             {
@@ -492,16 +659,20 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                 sr->u.scan_request->scanClause.pqf = pScanClause;
             }
             else
-                yaz_add_srw_diagnostic(decode, diag, num_diag, 7,
-                                       "scanClause");
+                yaz_add_srw_diagnostic(
+                    decode, diag, num_diag, 
+                    YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause");
             sr->u.scan_request->database = db;
+            
+            yaz_sru_integer_decode(decode, "maximumTerms",
+                                   maximumTerms, 
+                                   &sr->u.scan_request->maximumTerms,
+                                   diag, num_diag);
 
-            if (maximumTerms)
-                sr->u.scan_request->maximumTerms =
-                    odr_intdup(decode, atoi(maximumTerms));
-            if (responsePosition)
-                sr->u.scan_request->responsePosition =
-                    odr_intdup(decode, atoi(responsePosition));
+            yaz_sru_integer_decode(decode, "responsePosition",
+                                   responsePosition, 
+                                   &sr->u.scan_request->responsePosition,
+                                   diag, num_diag);
 
             sr->u.scan_request->stylesheet = stylesheet;
 
@@ -545,7 +716,8 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             
             (*soap_package)->ns = "SRU";
 
-            yaz_add_srw_diagnostic(decode, diag, num_diag, 4, operation);
+            yaz_add_srw_diagnostic(decode, diag, num_diag, 
+                                   YAZ_SRW_UNSUPP_OPERATION, operation);
             return 0;
         }
 #endif
@@ -572,6 +744,8 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 {
     Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o));
 
+    sr->username = 0;
+    sr->password = 0;
     sr->srw_version = odr_strdup(o, "1.1");
     sr->which = which;
     switch(which)
@@ -642,6 +816,7 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
        sr->u.scan_response->num_terms = 0;
        sr->u.scan_response->diagnostics = 0;
        sr->u.scan_response->num_diagnostics = 0;
+        break;
     case Z_SRW_update_request:
         sr->u.update_request = (Z_SRW_updateRequest *)
             odr_malloc(o, sizeof(*sr->u.update_request));
@@ -872,6 +1047,191 @@ 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, int *val)
+{
+    if (val)
+    {
+        name[*i] = a_name;
+        value[*i] = odr_malloc(o, 30);
+        sprintf(value[*i], "%d", *val);
+        (*i)++;
+    }
+}
+
+static void add_val_str(ODR o, char **name, char **value,  int *i,
+                        char *a_name, char *val)
+{
+    if (val)
+    {
+        name[*i] = a_name;
+        value[*i] = val;
+        (*i)++;
+    }
+}
+
+static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
+                              char **name, char **value)
+{
+    int i = 0;
+    add_val_str(encode, name, value, &i, "version", srw_pdu->srw_version);
+    name[i] = "operation";
+    switch(srw_pdu->which)
+    {
+    case Z_SRW_searchRetrieve_request:
+        value[i++] = "searchRetrieve";
+        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);
+            break;
+        case Z_SRW_query_type_pqf:
+            add_val_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);
+            break;
+        }
+        switch(srw_pdu->u.request->sort_type)
+        {
+        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);
+            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);
+        break;
+    case Z_SRW_explain_request:
+        value[i++] = "explain";
+        add_val_str(encode, name, value, &i, "stylesheet",
+                    srw_pdu->u.explain_request->stylesheet);
+        break;
+    case Z_SRW_scan_request:
+        value[i++] = "scan";
+
+        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);
+            break;
+        case Z_SRW_query_type_pqf:
+            add_val_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);
+            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);
+        break;
+    case Z_SRW_update_request:
+        value[i++] = "update";
+        break;
+    default:
+        return -1;
+    }
+    name[i++] = 0;
+    return 0;
+}
+
+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 *uri_args;
+    char *path;
+
+    if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+        return -1;
+    yaz_array_to_uri(&uri_args, encode, name, value);
+
+    hreq->method = "GET";
+    
+    path = odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 3);
+    sprintf(path, "%s?%s", hreq->path, uri_args);
+    hreq->path = path;
+
+    z_HTTP_header_add_content_type(encode, &hreq->headers,
+                                   "text/xml", charset);
+    return 0;
+}
+
+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 *uri_args;
+
+    if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+        return -1;
+
+    yaz_array_to_uri(&uri_args, encode, name, value);
+
+    hreq->method = "POST";
+    
+    hreq->content_buf = uri_args;
+    hreq->content_len = strlen(uri_args);
+
+    z_HTTP_header_add_content_type(encode, &hreq->headers,
+                                   "application/x-www-form-urlencoded",
+                                   charset);
+    return 0;
+}
+
+int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
+                        ODR odr, const char *charset)
+{
+    Z_SOAP_Handler handlers[2] = {
+#if YAZ_HAVE_XML2
+        {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
+#endif
+        {0, 0, 0}
+    };
+    Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p));
+    z_HTTP_header_add_content_type(odr,
+                                   &hreq->headers,
+                                   "text/xml", charset);
+    
+    z_HTTP_header_add(odr, &hreq->headers,
+                      "SOAPAction", "\"\"");
+    p->which = Z_SOAP_generic;
+    p->u.generic = (Z_SOAP_Generic *) odr_malloc(odr, sizeof(*p->u.generic));
+    p->u.generic->no = 0;
+    p->u.generic->ns = 0;
+    p->u.generic->p = srw_pdu;
+    p->ns = "http://schemas.xmlsoap.org/soap/envelope/";
+    
+    return z_soap_codec_enc(odr, &p,
+                            &hreq->content_buf,
+                            &hreq->content_len, handlers,
+                            charset);
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4