Added SRU-GET and SRU-POST support for ZOOM C. Option "sru" specifies
[yaz-moved-to-github.git] / src / srwutil.c
index e1e7d31..e075dad 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: srwutil.c,v 1.30 2005-09-12 09:14:57 adam Exp $
+ * $Id: srwutil.c,v 1.36 2006-03-01 23:24:25 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, '&')))
     {
@@ -137,20 +183,33 @@ void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp)
         *intp = odr_intdup(o, atoi(v));
 }
 
-void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d, 
-                           int code, const char *details)
+void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d, 
+                           const char *uri, const char *message,
+                           const char *details)
 {
-    d->uri = (char *) odr_malloc(o, 50);
-    sprintf(d->uri, "info:srw/diagnostic/1/%d", code);
-    d->message = 0;
+    d->uri = odr_strdup(o, uri);
+    if (message)
+        d->message = odr_strdup(o, message);
+    else
+        d->message = 0;
     if (details)
         d->details = odr_strdup(o, details);
     else
         d->details = 0;
 }
 
-void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
-                            int *num, int code, const char *addinfo)
+void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d, 
+                           int code, const char *details)
+{
+    char uri[40];
+    
+    sprintf(uri, "info:srw/diagnostic/1/%d", code);
+    yaz_mk_srw_diagnostic(o, d, uri, 0, details);
+}
+
+void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
+                                int *num, const char *uri,
+                                const char *message, const char *details)
 {
     Z_SRW_diagnostic *d_new;
     d_new = (Z_SRW_diagnostic *) odr_malloc (o, (*num + 1)* sizeof(**d));
@@ -158,10 +217,19 @@ void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
         memcpy (d_new, *d, *num *sizeof(**d));
     *d = d_new;
 
-    yaz_mk_std_diagnostic(o, *d + *num, code, addinfo);
+    yaz_mk_srw_diagnostic(o, *d + *num, uri, message, details);
     (*num)++;
 }
 
+void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
+                            int *num, int code, const char *addinfo)
+{
+    char uri[40];
+    
+    sprintf(uri, "info:srw/diagnostic/1/%d", code);
+    yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo);
+}
+
 int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                    Z_SOAP **soap_package, ODR decode, char **charset)
 {
@@ -178,12 +246,14 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             int ret = -1;
             const char *charset_p = 0;
             
-            static Z_SOAP_Handler soap_handlers[3] = {
+            static Z_SOAP_Handler soap_handlers[4] = {
 #if HAVE_XML2
                 {"http://www.loc.gov/zing/srw/", 0,
                  (Z_SOAP_fun) yaz_srw_codec},
                 {"http://www.loc.gov/zing/srw/v1.0/", 0,
                  (Z_SOAP_fun) yaz_srw_codec},
+                {"http://www.loc.gov/zing/srw/update/", 0,
+                 (Z_SOAP_fun) yaz_ucp_codec},
 #endif
                 {0, 0, 0}
             };
@@ -230,6 +300,10 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                     (*srw_pdu)->u.scan_request->database == 0)
                     (*srw_pdu)->u.scan_request->database = db;
 
+                if ((*srw_pdu)->which == Z_SRW_update_request &&
+                    (*srw_pdu)->u.update_request->database == 0)
+                    (*srw_pdu)->u.update_request->database = db;
+
                 return 0;
             }
             return 1;
@@ -252,8 +326,21 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
         {0, 0, 0}
     };
 #endif
-    if (!strcmp(hreq->method, "GET") ||
-      !strcmp(hreq->method, "POST") )
+    const char *content_type = z_HTTP_header_lookup(hreq->headers,
+                                                    "Content-Type");
+    /*
+      SRU GET: allow any content type.
+      SRU POST: we support "application/x-www-form-urlencoded";
+      not  "multipart/form-data" .
+    */
+    if (!strcmp(hreq->method, "GET") 
+        ||
+        (!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;
@@ -513,6 +600,20 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     return 2;
 }
 
+Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o)
+{
+    Z_SRW_extra_record *res = (Z_SRW_extra_record *)
+        odr_malloc(o, sizeof(*res));
+    res->type = 1;
+    res->recordReviewCode = 0;
+    res->recordReviewNote = 0;
+    res->recordId = 0;
+    res->nonDupRecordId = 0;
+    res->recordLockStatus = 0;
+    res->recordOldVersion = 0;
+    return res;
+}
+
 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 {
     Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o));
@@ -548,6 +649,7 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
         sr->u.response->diagnostics = 0;
         sr->u.response->num_diagnostics = 0;
         sr->u.response->nextRecordPosition = 0;
+        sr->u.response->extra_records = 0;
         break;
     case Z_SRW_explain_request:
         sr->u.explain_request = (Z_SRW_explainRequest *)
@@ -567,6 +669,7 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
             Z_SRW_recordPacking_string;
         sr->u.explain_response->diagnostics = 0;
         sr->u.explain_response->num_diagnostics = 0;
+        sr->u.explain_response->extra_record = 0;
         break;
     case Z_SRW_scan_request:
         sr->u.scan_request = (Z_SRW_scanRequest *)
@@ -581,16 +684,46 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
     case Z_SRW_scan_response:
         sr->u.scan_response = (Z_SRW_scanResponse *)
             odr_malloc(o, sizeof(*sr->u.scan_response));
-        sr->u.scan_response->terms = 0;
-        sr->u.scan_response->num_terms = 0;
-        sr->u.scan_response->diagnostics = 0;
-        sr->u.scan_response->num_diagnostics = 0;
+       sr->u.scan_response->terms = 0;
+       sr->u.scan_response->num_terms = 0;
+       sr->u.scan_response->diagnostics = 0;
+       sr->u.scan_response->num_diagnostics = 0;
+    case Z_SRW_update_request:
+        sr->u.update_request = (Z_SRW_updateRequest *)
+            odr_malloc(o, sizeof(*sr->u.update_request));
+       sr->u.update_request->database = 0;
+       sr->u.update_request->stylesheet = 0;
+        sr->u.update_request->record.recordSchema = 0;
+        sr->u.update_request->record.recordPacking = Z_SRW_recordPacking_XML;
+       sr->u.update_request->recordId = 0;
+       sr->u.update_request->recordVersion = 0;
+       sr->u.update_request->recordOldVersion = 0;
+        sr->u.update_request->record.recordData_buf = 0;
+        sr->u.update_request->record.recordData_len = 0;
+        sr->u.update_request->extra_record = 0;
+        sr->u.update_request->extraRequestData = 0;
+       sr->u.request->database = 0;
+        break;
+    case Z_SRW_update_response:
+        sr->u.update_response = (Z_SRW_updateResponse *)
+            odr_malloc(o, sizeof(*sr->u.update_response));
+       sr->u.update_response->operationStatus = 0;
+       sr->u.update_response->recordId = 0;
+       sr->u.update_response->recordVersion = 0;
+       sr->u.update_response->recordChecksum = 0;
+       sr->u.update_response->record.recordData_buf = 0;
+       sr->u.update_response->record.recordData_len = 0;
+       sr->u.update_response->record.recordSchema = 0;
+       sr->u.update_response->record.recordPacking =
+           Z_SRW_recordPacking_XML;
+        sr->u.update_response->extra_record = 0;
+        sr->u.update_response->extraResponseData = 0;
+       sr->u.update_response->diagnostics = 0;
+       sr->u.update_response->num_diagnostics = 0;
     }
     return sr;
 }
 
-
-
 /* bib1:srw */
 static int srw_bib1_map[] = {
     1, 1,
@@ -698,7 +831,7 @@ static int srw_bib1_map[] = {
     219, 1,  /* bad map */
     220, 1,  /* bad map */
     221, 1,  /* bad map */
-    222, 1,  /* bad map */
+    222, 3,
     223, 1,  /* bad map */
     224, 1,  /* bad map */
     225, 1,  /* bad map */
@@ -785,6 +918,162 @@ 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, 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, 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;
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4