Revert changes for PQF SRU queries.
[yaz-moved-to-github.git] / src / srwutil.c
index 1f39728..943653e 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * Copyright (C) 1995-2005, Index Data ApS
+ * Copyright (C) 1995-2006, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: srwutil.c,v 1.39 2006-05-05 20:02:22 quinn Exp $
+ * $Id: srwutil.c,v 1.49 2006-09-06 13:37:51 adam Exp $
  */
 /**
  * \file srwutil.c
@@ -41,9 +41,10 @@ void encode_uri_char(char *dst, char ch)
     }
 }
 
-void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
+static void yaz_array_to_uri_ex(char **path, ODR o, char **name, char **value,
+                                const char *extra_args)
 {
-    size_t i, szp = 0, sz = 0;
+    size_t i, szp = 0, sz = extra_args ? 1+strlen(extra_args) : 1;
     for(i = 0; name[i]; i++)
         sz += strlen(name[i]) + 3 + strlen(value[i]) * 3;
     *path = odr_malloc(o, sz);
@@ -67,9 +68,21 @@ void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
             szp += vlen;
         }
     }
+    if (extra_args)
+    {
+        if (i)
+            (*path)[szp++] = '&';
+        memcpy(*path + szp, extra_args, strlen(extra_args));
+        szp += strlen(extra_args);
+    }
     (*path)[szp] = '\0';
 }
 
+void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
+{
+    return yaz_array_to_uri_ex(path, o, name, value, 0);
+}
+
 int yaz_uri_array(const char *path, ODR o, char ***name, char ***val)
 {
     int no = 2;
@@ -188,11 +201,11 @@ static int yaz_base64decode(const char *in, char *out)
        char i0, i1, i2, i3;
        char *p;
 
-       if (!(p = index(map, in[0])))
+       if (!(p = strchr(map, in[0])))
            return 0;
        i0 = p - map;
        len--;
-       if (!(p = index(map, in[1])))
+       if (!(p = strchr(map, in[1])))
            return 0;
        i1 = p - map;
        len--;
@@ -200,7 +213,7 @@ static int yaz_base64decode(const char *in, char *out)
        olen++;
        if (in[2] == '=')
            break;
-       if (!(p = index(map, in[2])))
+       if (!(p = strchr(map, in[2])))
            return 0;
        i2 = p - map;
        len--;
@@ -208,7 +221,7 @@ static int yaz_base64decode(const char *in, char *out)
        olen++;
        if (in[3] == '=')
            break;
-       if (!(p = index(map, in[3])))
+       if (!(p = strchr(map, in[3])))
            return 0;
        i3 = p - map;
        len--;
@@ -226,8 +239,8 @@ static int yaz_base64decode(const char *in, char *out)
  * 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)
+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");
 
@@ -249,7 +262,7 @@ static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq, char *userna
         olen = yaz_base64decode(basic, out);
         /* Format of out should be username:password at this point */
         strcpy(ubuf, out);
-        if ((p = index(ubuf, ':'))) {
+        if ((p = strchr(ubuf, ':'))) {
             *(p++) = '\0';
             if (*p)
                 strcpy(pbuf, p);
@@ -333,7 +346,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,
@@ -398,6 +411,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
 */ 
@@ -405,7 +435,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},
@@ -430,7 +460,7 @@ 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;
@@ -469,7 +499,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;
@@ -514,21 +544,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"))
@@ -549,7 +585,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)
             {
@@ -561,12 +599,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;
 
@@ -633,16 +672,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;
 
@@ -686,7 +729,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
@@ -709,13 +753,19 @@ Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o)
     return res;
 }
 
-Z_SRW_PDU *yaz_srw_get(ODR o, int which)
+Z_SRW_PDU *yaz_srw_get_core_v_1_1(ODR o)
 {
-    Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o));
+    Z_SRW_PDU *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(*p));
+    p->srw_version = odr_strdup(o, "1.1");
+    p->username = 0;
+    p->password = 0;
+    p->extra_args = 0;
+    return p;
+}
 
-    sr->username = 0;
-    sr->password = 0;
-    sr->srw_version = odr_strdup(o, "1.1");
+Z_SRW_PDU *yaz_srw_get(ODR o, int which)
+{
+    Z_SRW_PDU *sr = yaz_srw_get_core_v_1_1(o);
     sr->which = which;
     switch(which)
     {
@@ -1129,7 +1179,7 @@ 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, char *charset)
+                       ODR encode, const char *charset)
 {
     char *name[30], *value[30]; /* definite upper limit for SRU params */
     char *uri_args;
@@ -1137,11 +1187,13 @@ int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
 
     if (yaz_get_sru_parms(srw_pdu, encode, name, value))
         return -1;
-    yaz_array_to_uri(&uri_args, encode, name, value);
+    yaz_array_to_uri_ex(&uri_args, encode, name, value, srw_pdu->extra_args);
 
     hreq->method = "GET";
     
-    path = odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 3);
+    path = odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4
+                      +(srw_pdu->extra_args ? strlen(srw_pdu->extra_args) : 0)
+        );
     sprintf(path, "%s?%s", hreq->path, uri_args);
     hreq->path = path;
 
@@ -1151,7 +1203,7 @@ 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, char *charset)
+                        ODR encode, const char *charset)
 {
     char *name[30], *value[30]; /* definite upper limit for SRU params */
     char *uri_args;
@@ -1159,7 +1211,7 @@ int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
     if (yaz_get_sru_parms(srw_pdu, encode, name, value))
         return -1;
 
-    yaz_array_to_uri(&uri_args, encode, name, value);
+    yaz_array_to_uri_ex(&uri_args, encode, name, value, srw_pdu->extra_args);
 
     hreq->method = "POST";
     
@@ -1172,6 +1224,35 @@ int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
     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