Changed include/yaz/diagbib1.h and added include/yaz/diagsrw.h with
[yaz-moved-to-github.git] / src / srwutil.c
index 06355d1..c476d11 100644 (file)
@@ -1,10 +1,15 @@
 /*
- * Copyright (c) 2002-2004, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: srwutil.c,v 1.12 2004-02-14 15:58:42 adam Exp $
+ * $Id: srwutil.c,v 1.27 2005-02-01 14:43:50 adam Exp $
+ */
+/**
+ * \file srwutil.c
+ * \brief Implements SRW/SRU utilities.
  */
 
+#include <stdlib.h>
 #include <yaz/srw.h>
 #include <yaz/yaz-iconv.h>
 
@@ -98,7 +103,7 @@ char *yaz_uri_val(const char *path, const char *name, ODR o)
             p1 = strchr(path, '&');
             if (!p1)
                 p1 = strlen(path) + path;
-            ret = odr_malloc(o, p1 - path + 1);
+            ret = (char *) odr_malloc(o, p1 - path + 1);
             while (*path && *path != '&')
             {
                 if (*path == '+')
@@ -163,7 +168,9 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     {
        const char *content_type = z_HTTP_header_lookup(hreq->headers,
                                                        "Content-Type");
-       if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
+       if (content_type && 
+           (!yaz_strcmp_del("text/xml", content_type, "; ") ||
+            !yaz_strcmp_del("text/plain", content_type, "; ")))
        {
            char *db = "Default";
            const char *p0 = hreq->path, *p1;
@@ -230,6 +237,9 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     return 2;
 }
 
+/**
+  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,
                   Z_SRW_diagnostic **diag, int *num_diag)
@@ -245,6 +255,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
        const char *operation = 0;
        char *version = 0;
        char *query = 0;
@@ -252,11 +263,16 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
        char *sortKeys = 0;
        char *stylesheet = 0;
        char *scanClause = 0;
+       char *pScanClause = 0;
        char *recordXPath = 0;
        char *recordSchema = 0;
-       char *recordPacking = "xml";
+       char *recordPacking = "xml";  /* xml packing is default for SRU */
        char *maximumRecords = 0;
        char *startRecord = 0;
+       char *maximumTerms = 0;
+       char *responsePosition = 0;
+       char *extraRequestData = 0;
+#endif
        char **uri_name;
        char **uri_val;
 
@@ -302,21 +318,34 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                    version = v;
                else if (!strcmp(n, "scanClause"))
                    scanClause = v;
+               else if (!strcmp(n, "x-pScanClause"))
+                   pScanClause = v;
                else if (!strcmp(n, "maximumRecords"))
                    maximumRecords = v;
                else if (!strcmp(n, "startRecord"))
                    startRecord = v;
+               else if (!strcmp(n, "maximumTerms"))
+                   maximumTerms = v;
+               else if (!strcmp(n, "responsePosition"))
+                   responsePosition = v;
+               else if (!strcmp(n, "extraRequestData"))
+                   extraRequestData = v;
                else
                    yaz_add_srw_diagnostic(decode, diag, num_diag, 8, n);
            }
        }
        if (!version)
-           yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "version");
-       else if (version && strcmp(version, "1.1"))
+       {
+           if (uri_name)
+               yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "version");
+           version = "1.1";
+       }
+       if (strcmp(version, "1.1"))
            yaz_add_srw_diagnostic(decode, diag, num_diag, 5, "1.1");
        if (!operation)
        {
-           yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "operation");
+           if (uri_name)
+               yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "operation");
            operation = "explain";
        }
         if (!strcmp(operation, "searchRetrieve"))
@@ -373,6 +402,8 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
         }
        else if (!strcmp(operation, "explain"))
        {
+           /* Transfer SRU explain parameters to common struct */
+           /* http://www.loc.gov/z3950/agency/zing/srw/explain.html */
             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
 
            sr->srw_version = version;
@@ -398,15 +429,35 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
        }
        else if (!strcmp(operation, "scan"))
        {
+           /* Transfer SRU scan parameters to common struct */
+           /* http://www.loc.gov/z3950/agency/zing/srw/scan.html */
             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request);
 
-           if (!scanClause)
-               yaz_add_srw_diagnostic(decode, diag, num_diag, 7,
-                                      "scanClause");
            sr->srw_version = version;
            *srw_pdu = sr;
-            sr->u.scan_request->scanClause = scanClause;
+
+            if (scanClause)
+            {
+                sr->u.scan_request->query_type = Z_SRW_query_type_cql;
+               sr->u.scan_request->scanClause.cql = scanClause;
+            }
+            else if (pScanClause)
+            {
+                sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
+                sr->u.scan_request->scanClause.pqf = pScanClause;
+            }
+           else
+               yaz_add_srw_diagnostic(decode, diag, num_diag, 7,
+                                      "scanClause");
            sr->u.scan_request->database = db;
+
+           if (maximumTerms)
+               sr->u.scan_request->maximumTerms =
+                   odr_intdup(decode, atoi(maximumTerms));
+           if (responsePosition)
+               sr->u.scan_request->responsePosition =
+                   odr_intdup(decode, atoi(responsePosition));
+
             sr->u.scan_request->stylesheet = stylesheet;
 
            (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
@@ -460,7 +511,7 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
 
 Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 {
-    Z_SRW_PDU *sr = odr_malloc(o, sizeof(*o));
+    Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o));
 
     sr->srw_version = odr_strdup(o, "1.1");
     sr->which = which;
@@ -520,7 +571,8 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
        sr->u.scan_request->stylesheet = 0;
        sr->u.scan_request->maximumTerms = 0;
        sr->u.scan_request->responsePosition = 0;
-       sr->u.scan_request->scanClause = 0;
+       sr->u.scan_request->query_type = Z_SRW_query_type_cql;
+       sr->u.scan_request->scanClause.cql = 0;
         break;
     case Z_SRW_scan_response:
         sr->u.scan_response = (Z_SRW_scanResponse *)
@@ -534,117 +586,6 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which)
 }
 
 
-static struct {
-    int code;
-    const char *msg;
-} yaz_srw_codes [] = {
-{1, "Permanent system error"}, 
-{2, "System temporarily unavailable"}, 
-{3, "Authentication error"}, 
-{4, "Unsupported operation"},
-{5, "Unsupported version"},
-{6, "Unsupported parameter value"},
-{7, "Mandatory parameter not supplied"},
-{8, "Unsupported parameter"},
-/* Diagnostics Relating to CQL */
-{10, "Query syntax error"}, 
-{11, "Unsupported query type"}, 
-{12, "Too many characters in query"}, 
-{13, "Invalid or unsupported use of parentheses"}, 
-{14, "Invalid or unsupported use of quotes"}, 
-{15, "Unsupported context context set"}, 
-{16, "Unsupported index"}, 
-{17, "Unsupported combination of index and context set"}, 
-{18, "Unsupported combination of indexes"}, 
-{19, "Unsupported relation"}, 
-{20, "Unsupported relation modifier"}, 
-{21, "Unsupported combination of relation modifers"}, 
-{22, "Unsupported combination of relation and index"}, 
-{23, "Too many characters in term"}, 
-{24, "Unsupported combination of relation and term"}, 
-{25, "Special characters not quoted in term"}, 
-{26, "Non special character escaped in term"}, 
-{27, "Empty term unsupported"}, 
-{28, "Masking character not supported"}, 
-{29, "Masked words too short"}, 
-{30, "Too many masking characters in term"}, 
-{31, "Anchoring character not supported"}, 
-{32, "Anchoring character in unsupported position"}, 
-{33, "Combination of proximity/adjacency and masking characters not supported"}, 
-{34, "Combination of proximity/adjacency and anchoring characters not supported"}, 
-{35, "Terms only exclusion stopwords"}, 
-{36, "Term in invalid format for index or relation"}, 
-{37, "Unsupported boolean operator"}, 
-{38, "Too many boolean operators in query"}, 
-{39, "Proximity not supported"}, 
-{40, "Unsupported proximity relation"}, 
-{41, "Unsupported proximity distance"}, 
-{42, "Unsupported proximity unit"}, 
-{43, "Unsupported proximity ordering"}, 
-{44, "Unsupported combination of proximity modifiers"}, 
-{45, "context set name (prefix) assigned to multiple identifiers"}, 
-/* Diagnostics Relating to Result Sets */
-{50, "Result sets not supported"}, 
-{51, "Result set does not exist"}, 
-{52, "Result set temporarily unavailable"}, 
-{53, "Result sets only supported for retrieval"}, 
-{54, "Retrieval may only occur from an existing result set"}, 
-{55, "Combination of result sets with search terms not supported"}, 
-{56, "Only combination of single result set with search terms supported"}, 
-{57, "Result set created but no records available"}, 
-{58, "Result set created with unpredictable partial results available"}, 
-{59, "Result set created with valid partial results available"}, 
-/* Diagnostics Relating to Records */
-{60, "Result set no created: too many records retrieved"}, 
-{61, "First record position out of range"}, 
-{62, "Negative number of records requested"}, 
-{63, "System error in retrieving records"}, 
-{64, "Record temporarily unavailable"}, 
-{65, "Record does not exist"}, 
-{66, "Unknown schema for retrieval"}, 
-{67, "Record not available in this schema"}, 
-{68, "Not authorised to send record"}, 
-{69, "Not authorised to send record in this schema"}, 
-{70, "Record too large to send"}, 
-{71, "Unsupported record packing"},
-{72, "XPath retrieval unsupported"},
-{73, "XPath expression contains unsupported feature"},
-{74, "Unable to evaluate XPath expression"},
-/* Diagnostics Relating to Sorting */
-{80, "Sort not supported"}, 
-{81, "Unsupported sort type"}, 
-{82, "Unsupported sort sequence"}, 
-{83, "Too many records to sort"}, 
-{84, "Too many sort keys to sort"}, 
-{85, "Duplicate sort keys"}, 
-{86, "Cannot sort: incompatible record formats"}, 
-{87, "Unsupported schema for sort"}, 
-{88, "Unsupported path for sort"}, 
-{89, "Path unsupported for schema"}, 
-{90, "Unsupported direction value"}, 
-{91, "Unsupported case value"}, 
-{92, "Unsupported missing value action"}, 
-/* Diagnostics Relating to Explain */
-{100, "Explain not supported"}, 
-{101, "Explain request type not supported (SOAP vs GET)"}, 
-{102, "Explain record temporarily unavailable"},
-/* Diagnostics Relating to Stylesheets */
-{110, "Stylesheets not supported"},
-{111, "Unsupported stylesheet"},
-/* Diagnostics relating to Scan */
-{120, "Response position out of range"},
-{0, 0}
-};
-
-const char *yaz_diag_srw_str (int code)
-{
-    int i;
-    for (i = 0; yaz_srw_codes[i].code; i++)
-        if (yaz_srw_codes[i].code == code)
-            return yaz_srw_codes[i].msg;
-    return 0;
-}
-
 
 /* bib1:srw */
 static int srw_bib1_map[] = {
@@ -711,6 +652,7 @@ static int srw_bib1_map[] = {
     115, 16,
     116, 16,
     117, 19,
+    117, 20,
     118, 22,
     119, 32,
     119, 31,