Stylesheet support.
[yaz-moved-to-github.git] / src / srwutil.c
index 998deb9..581c00d 100644 (file)
@@ -1,8 +1,8 @@
 /*
- * Copyright (c) 2002-2003, Index Data.
+ * Copyright (c) 2002-2004, Index Data.
  * See the file LICENSE for details.
  *
- * $Id: srwutil.c,v 1.2 2003-12-30 00:29:53 adam Exp $
+ * $Id: srwutil.c,v 1.6 2004-01-07 20:36:44 adam Exp $
  */
 
 #include <yaz/srw.h>
@@ -72,8 +72,8 @@ void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp)
         *intp = odr_intdup(o, atoi(v));
 }
 
-int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
-                     char **soap_ns, ODR decode)
+int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
+                  Z_SOAP **soap_package, ODR decode, char **charset)
 {
     if (!strcmp(hreq->method, "POST"))
     {
@@ -83,15 +83,15 @@ int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
        {
            char *db = "Default";
            const char *p0 = hreq->path, *p1;
-           Z_SOAP *soap_package = 0;
             int ret = -1;
             const char *charset_p = 0;
-            char *charset = 0;
            
-            static Z_SOAP_Handler soap_handlers[2] = {
+            static Z_SOAP_Handler soap_handlers[3] = {
 #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},
 #endif
                 {0, 0, 0}
             };
@@ -108,24 +108,23 @@ int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                db[p1 - p0] = '\0';
            }
 
-            if ((charset_p = strstr(content_type, "; charset=")))
+            if (charset && (charset_p = strstr(content_type, "; charset=")))
             {
                 int i = 0;
                 charset_p += 10;
                 while (i < 20 && charset_p[i] &&
                        !strchr("; \n\r", charset_p[i]))
                     i++;
-                charset = (char*) odr_malloc(decode, i+1);
-                memcpy(charset, charset_p, i);
-                charset[i] = '\0';
+                *charset = (char*) odr_malloc(decode, i+1);
+                memcpy(*charset, charset_p, i);
+                (*charset)[i] = '\0';
             }
-            ret = z_soap_codec(decode, &soap_package, 
+            ret = z_soap_codec(decode, soap_package, 
                                &hreq->content_buf, &hreq->content_len,
                                soap_handlers);
-           if (!ret && soap_package->which == Z_SOAP_generic &&
-               soap_package->u.generic->no == 0)
+           if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
            {
-               *srw_pdu = (Z_SRW_PDU*) soap_package->u.generic->p;
+               *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
                
                if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
                    (*srw_pdu)->u.request->database == 0)
@@ -135,7 +134,10 @@ int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                    (*srw_pdu)->u.explain_request->database == 0)
                    (*srw_pdu)->u.explain_request->database = db;
 
-               *soap_ns = odr_strdup(decode, soap_package->ns);
+               if ((*srw_pdu)->which == Z_SRW_scan_request &&
+                   (*srw_pdu)->u.scan_request->database == 0)
+                   (*srw_pdu)->u.scan_request->database = db;
+
                return 0;
            }
            return 1;
@@ -144,15 +146,27 @@ int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     return 2;
 }
 
-int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
-                     char **soap_ns, ODR decode)
+int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
+                  Z_SOAP **soap_package, ODR decode, char **charset)
 {
+#if HAVE_XML2
+    static Z_SOAP_Handler soap_handlers[2] = {
+       {"http://www.loc.gov/zing/srw/", 0,
+        (Z_SOAP_fun) yaz_srw_codec},
+       {0, 0, 0}
+    };
+#endif
     if (!strcmp(hreq->method, "GET"))
     {
         char *db = "Default";
         const char *p0 = hreq->path, *p1;
        const char *operation = 0;
+       char *query = 0;
+       char *pQuery = 0;
+       char *stylesheet = 0;
         
+       if (charset)
+           *charset = 0;
         if (*p0 == '/')
             p0++;
         p1 = strchr(p0, '?');
@@ -165,15 +179,16 @@ int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             db[p1 - p0] = '\0';
         }
 #if HAVE_XML2
-       if (p1)
-           operation = yaz_uri_val(p1, "operation", decode);
+       query = yaz_uri_val(p1, "query", decode);
+       pQuery = yaz_uri_val(p1, "pQuery", decode);
+       operation = yaz_uri_val(p1, "operation", decode);
+       stylesheet = yaz_uri_val(p1, "stylesheet", decode);
        if (!operation)
            operation = "explain";
-        if (p1 && !strcmp(operation, "searchRetrieve"))
+        if ((operation && !strcmp(operation, "searchRetrieve"))
+           || pQuery || query)
         {
             Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request);
-            char *query = yaz_uri_val(p1, "query", decode);
-            char *pQuery = yaz_uri_val(p1, "pQuery", decode);
             char *sortKeys = yaz_uri_val(p1, "sortKeys", decode);
             
            *srw_pdu = sr;
@@ -194,6 +209,8 @@ int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             }
             sr->u.request->recordSchema = yaz_uri_val(p1, "recordSchema", decode);
             sr->u.request->recordPacking = yaz_uri_val(p1, "recordPacking", decode);
+            sr->u.request->stylesheet = stylesheet;
+
             if (!sr->u.request->recordPacking)
                 sr->u.request->recordPacking = "xml";
             yaz_uri_val_int(p1, "maximumRecords", decode, 
@@ -202,7 +219,19 @@ int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
                         &sr->u.request->startRecord);
 
             sr->u.request->database = db;
-           *soap_ns = "SRU";
+
+           (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+           (*soap_package)->which = Z_SOAP_generic;
+           
+           (*soap_package)->u.generic =
+               odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+           
+           (*soap_package)->u.generic->p = sr;
+           (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+           (*soap_package)->u.generic->no = 0;
+           
+           (*soap_package)->ns = "SRU";
+
            return 0;
         }
        else if (p1 && !strcmp(operation, "explain"))
@@ -215,7 +244,21 @@ int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
             if (!sr->u.explain_request->recordPacking)
                 sr->u.explain_request->recordPacking = "xml";
            sr->u.explain_request->database = db;
-           *soap_ns = "SRU";
+
+            sr->u.explain_request->stylesheet = stylesheet;
+
+           (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+           (*soap_package)->which = Z_SOAP_generic;
+           
+           (*soap_package)->u.generic =
+               odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+           
+           (*soap_package)->u.generic->p = sr;
+           (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+           (*soap_package)->u.generic->no = 0;
+           
+           (*soap_package)->ns = "SRU";
+
            return 0;
        }
 #endif
@@ -223,3 +266,355 @@ int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
     }
     return 2;
 }
+
+Z_SRW_PDU *yaz_srw_get(ODR o, int which)
+{
+    Z_SRW_PDU *sr = odr_malloc(o, sizeof(*o));
+
+    sr->srw_version = odr_strdup(o, "1.1");
+    sr->which = which;
+    switch(which)
+    {
+    case Z_SRW_searchRetrieve_request:
+        sr->u.request = (Z_SRW_searchRetrieveRequest *)
+            odr_malloc(o, sizeof(*sr->u.request));
+        sr->u.request->query_type = Z_SRW_query_type_cql;
+        sr->u.request->query.cql = 0;
+        sr->u.request->sort_type = Z_SRW_sort_type_none;
+        sr->u.request->sort.none = 0;
+        sr->u.request->startRecord = 0;
+        sr->u.request->maximumRecords = 0;
+        sr->u.request->recordSchema = 0;
+        sr->u.request->recordPacking = 0;
+        sr->u.request->recordXPath = 0;
+       sr->u.request->database = 0;
+       sr->u.request->resultSetTTL = 0;
+       sr->u.request->stylesheet = 0;
+        break;
+    case Z_SRW_searchRetrieve_response:
+        sr->u.response = (Z_SRW_searchRetrieveResponse *)
+            odr_malloc(o, sizeof(*sr->u.response));
+        sr->u.response->numberOfRecords = 0;
+        sr->u.response->resultSetId = 0;
+        sr->u.response->resultSetIdleTime = 0;
+        sr->u.response->records = 0;
+        sr->u.response->num_records = 0;
+        sr->u.response->diagnostics = 0;
+        sr->u.response->num_diagnostics = 0;
+        sr->u.response->nextRecordPosition = 0;
+        break;
+    case Z_SRW_explain_request:
+        sr->u.explain_request = (Z_SRW_explainRequest *)
+            odr_malloc(o, sizeof(*sr->u.explain_request));
+        sr->u.explain_request->recordPacking = 0;
+       sr->u.explain_request->database = 0;
+       sr->u.explain_request->stylesheet = 0;
+        break;
+    case Z_SRW_explain_response:
+        sr->u.explain_response = (Z_SRW_explainResponse *)
+            odr_malloc(o, sizeof(*sr->u.explain_response));
+       sr->u.explain_response->record.recordData_buf = 0;
+       sr->u.explain_response->record.recordData_len = 0;
+       sr->u.explain_response->record.recordSchema = 0;
+       sr->u.explain_response->record.recordPosition = 0;
+       sr->u.explain_response->record.recordPacking =
+           Z_SRW_recordPacking_string;
+       sr->u.explain_response->diagnostics = 0;
+       sr->u.explain_response->num_diagnostics = 0;
+    }
+    return sr;
+}
+
+
+static struct {
+    int code;
+    const char *msg;
+} yaz_srw_codes [] = {
+{1, "Permanent system error"}, 
+{2, "System temporarily unavailable"}, 
+{3, "Authentication error"}, 
+/* Diagnostics Relating to CQL */
+{10, "Query syntax error"}, 
+{11, "Unsupported query type"}, 
+{12, "Too many characters in query"}, 
+{13, "Unbalanced or illegal use of parentheses"}, 
+{14, "Unbalanced or illegal use of quotes"}, 
+{15, "Illegal or unsupported context set"}, 
+{16, "Illegal or unsupported index"}, 
+{17, "Illegal or unsupported combination of index and context set"}, 
+{18, "Illegal or unsupported combination of indexes"}, 
+{19, "Illegal or unsupported relation"}, 
+{20, "Illegal or unsupported relation modifier"}, 
+{21, "Illegal or unsupported combination of relation modifers"}, 
+{22, "Illegal or unsupported combination of relation and index"}, 
+{23, "Too many characters in term"}, 
+{24, "Illegal 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 illegal or 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 (stop) words"}, 
+{36, "Term in invalid format for index or relation"}, 
+{37, "Illegal or unsupported boolean operator"}, 
+{38, "Too many boolean operators in query"}, 
+{39, "Proximity not supported"}, 
+{40, "Illegal or unsupported proximity relation"}, 
+{41, "Illegal or unsupported proximity distance"}, 
+{42, "Illegal or unsupported proximity unit"}, 
+{43, "Illegal or unsupported proximity ordering"}, 
+{44, "Illegal or 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, "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"}, 
+/* Diagnostics Relating to Sorting */
+{80, "Sort not supported"}, 
+{81, "Unsupported sort type (sortKeys vs xSortKeys)"}, 
+{82, "Illegal or unsupported sort sequence"}, 
+{83, "Too many records"}, 
+{84, "Too many sort keys"}, 
+{85, "Duplicate sort keys"}, 
+{86, "Incompatible record formats"}, 
+{87, "Unsupported schema for sort"}, 
+{88, "Unsupported tag path for sort"}, 
+{89, "Tag path illegal or unsupported for schema"}, 
+{90, "Illegal or unsupported direction value"}, 
+{91, "Illegal or unsupported case value"}, 
+{92, "Illegal or 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"},
+{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[] = {
+    1, 1,
+    2, 2,
+    3, 11,
+    4, 35,
+    5, 12,
+    6, 38,
+    7, 30,
+    8, 32,
+    9, 29,
+    108, 10,  /* Malformed query : Syntax error */
+    10, 10,
+    11, 12,
+    11, 23,
+    12, 60,
+    13, 61,
+    13, 62,
+    14, 63,
+    14, 64,
+    14, 65,
+    15, 68,
+    15, 69,
+    16, 70,
+    17, 70,
+    18, 50,
+    19, 55,
+    20, 56, 
+    21, 52,
+    22, 50,
+    23, 3,
+    24, 66,
+    25, 66,
+    26, 66,
+    27, 51,
+    28, 52,
+    29, 52,
+    30, 51,
+    31, 57,
+    32, 58,
+    33, 59,
+    100, 1, /* bad map */
+    101, 3,
+    102, 3,
+    103, 3,
+    104, 3,
+    105, 3, 
+    106, 66,
+    107, 11,
+    108, 10,
+    108, 13,
+    108, 14,
+    108, 25,
+    108, 26,
+    108, 27,
+    108, 45,
+        
+    109, 1,
+    110, 37,
+    111, 1,
+    112, 58,
+    113, 10,
+    114, 16,
+    115, 16,
+    116, 16,
+    117, 19,
+    118, 22,
+    119, 32,
+    119, 31,
+    120, 28,
+    121, 15,
+    122, 32,
+    123, 22,
+    123, 17,
+    123, 18,
+    124, 24,
+    125, 36,
+    126, 36, 
+    127, 36,
+    128, 51,
+    129, 39,
+    130, 43,
+    131, 40,
+    132, 42,
+    201, 44,
+    201, 33,
+    201, 34,
+    202, 41,
+    203, 43,
+    205, 1,  /* bad map */
+    206, 1,  /* bad map */
+    207, 89,
+    208, 1,  /* bad map */
+    209, 80,
+    210, 80,
+    210, 81,
+    211, 84,
+    212, 85,
+    213, 92,
+    214, 90,
+    215, 91,
+    216, 92,
+    217, 63,
+    218, 1,  /* bad map */
+    219, 1,  /* bad map */
+    220, 1,  /* bad map */
+    221, 1,  /* bad map */
+    222, 1,  /* bad map */
+    223, 1,  /* bad map */
+    224, 1,  /* bad map */
+    225, 1,  /* bad map */
+    226, 1,  /* bad map */
+    227, 66,
+    228, 1,  /* bad map */
+    229, 36,
+    230, 83,
+    231, 89,
+    232, 1,
+    233, 1, /* bad map */
+    234, 1, /* bad map */
+    235, 2,
+    236, 3, 
+    237, 82,
+    238, 67,
+    239, 66,
+    240, 1, /* bad map */
+    241, 1, /* bad map */
+    242, 70,
+    243, 1, /* bad map */
+    244, 66,
+    245, 10,
+    246, 10,
+    247, 10,
+    1001, 1, /* bad map */
+    1002, 1, /* bad map */
+    1003, 1, /* bad map */
+    1004, 1, /* bad map */
+    1005, 1, /* bad map */
+    1006, 1, /* bad map */
+    1007, 100,
+    1008, 1, 
+    1009, 1,
+    1010, 3,
+    1011, 3,
+    1012, 3,
+    1013, 3,
+    1014, 3,
+    1015, 3,
+    1015, 3,
+    1016, 3,
+    1017, 3,
+    1018, 2,
+    1019, 2,
+    1020, 2,
+    1021, 3,
+    1022, 3,
+    1023, 3,
+    1024, 16,
+    1025, 3,
+    1026, 64,
+    1027, 1,
+    1028, 65,
+    1029, 1,
+    1040, 1,
+    /* 1041-1065 */
+    1066, 66,
+    1066, 67,
+    0
+};
+
+int yaz_diag_bib1_to_srw (int code)
+{
+    const int *p = srw_bib1_map;
+    while (*p)
+    {
+        if (code == p[0])
+            return p[1];
+        p += 2;
+    }
+    return 1;
+}
+
+int yaz_diag_srw_to_bib1(int code)
+{
+    const int *p = srw_bib1_map;
+    while (*p)
+    {
+        if (code == p[1])
+            return p[0];
+        p += 2;
+    }
+    return 1;
+}
+