For GFS: schema for bend_fetch; displayTerm for bend_scan.
[yaz-moved-to-github.git] / server / seshigh.c
index bb27754..a2a28f9 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: seshigh.c,v 1.146 2003-02-23 14:26:57 adam Exp $
+ * $Id: seshigh.c,v 1.154 2003-04-24 13:30:32 adam Exp $
  */
 
 /*
@@ -100,6 +100,7 @@ association *create_association(IOCHAN channel, COMSTACK link)
     if (!(anew = (association *)xmalloc(sizeof(*anew))))
        return 0;
     anew->init = 0;
+    anew->version = 0;
     anew->client_chan = channel;
     anew->client_link = link;
     anew->cs_get_mask = 0;
@@ -435,8 +436,11 @@ static void assoc_init_reset(association *assoc)
     assoc->init->bend_scan = NULL;
     assoc->init->bend_segment = NULL;
     assoc->init->bend_fetch = NULL;
+    assoc->init->bend_explain = NULL;
+
     assoc->init->charneg_request = NULL;
     assoc->init->charneg_response = NULL;
+
     assoc->init->decode = assoc->decode;
     assoc->init->peer_name = 
         odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
@@ -444,6 +448,8 @@ static void assoc_init_reset(association *assoc)
 
 static int srw_bend_init(association *assoc)
 {
+    const char *encoding = "UTF-8";
+    Z_External *ce;
     bend_initresult *binitres;
     statserv_options_block *cb = statserv_getcontrol();
     
@@ -451,7 +457,10 @@ static int srw_bend_init(association *assoc)
 
     assoc->maximumRecordSize = 3000000;
     assoc->preferredMessageSize = 3000000;
-
+#if 1
+    ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
+    assoc->init->charneg_request = ce->u.charNeg3;
+#endif
     if (!(binitres = (*cb->bend_init)(assoc->init)))
     {
        yaz_log(LOG_WARN, "Bad response from backend.");
@@ -506,7 +515,11 @@ static int srw_bend_fetch(association *assoc, int pos,
     rr.errcode = 0;
     rr.errstring = 0;
     rr.surrogate_flag = 0;
-    
+    rr.schema = srw_req->recordSchema;
+
+    if (!assoc->init->bend_fetch)
+        return 1;
+
     (*assoc->init->bend_fetch)(assoc->backend, &rr);
 
     if (rr.len >= 0)
@@ -514,9 +527,10 @@ static int srw_bend_fetch(association *assoc, int pos,
         record->recordData_buf = rr.record;
         record->recordData_len = rr.len;
         record->recordPosition = odr_intdup(o, pos);
-        record->recordSchema = 0;
-        if (srw_req->recordSchema)
-            record->recordSchema = odr_strdup(o, srw_req->recordSchema);
+        if (rr.schema)
+            record->recordSchema = odr_strdup(o, rr.schema);
+        else
+            record->recordSchema = 0;
     }
     return rr.errcode;
 }
@@ -530,9 +544,24 @@ static void srw_bend_search(association *assoc, request *req,
     Z_External *ext;
     
     yaz_log(LOG_LOG, "Got SRW SearchRetrieveRequest");
+    yaz_log(LOG_DEBUG, "srw_bend_search");
     if (!assoc->init)
-        srw_bend_init(assoc);
-
+    {
+        yaz_log(LOG_DEBUG, "srw_bend_init");
+        if (!srw_bend_init(assoc))
+        {
+            srw_error = 3;  /* assume Authentication error */
+
+            srw_res->num_diagnostics = 1;
+            srw_res->diagnostics = (Z_SRW_diagnostic *)
+                odr_malloc(assoc->encode, sizeof(*srw_res->diagnostics));
+            srw_res->diagnostics[0].code = 
+                odr_intdup(assoc->encode, srw_error);
+            srw_res->diagnostics[0].details = 0;
+            return;
+        }
+    }
+    
     rr.setname = "default";
     rr.replace_set = 1;
     rr.num_bases = 1;
@@ -582,11 +611,15 @@ static void srw_bend_search(association *assoc, request *req,
     else
         srw_error = 11;
 
-    if (srw_req->sort_type != Z_SRW_sort_type_none)
+    if (!srw_error && srw_req->sort_type != Z_SRW_sort_type_none)
         srw_error = 80;
 
+    if (!srw_error && !assoc->init->bend_search)
+        srw_error = 1;
+
     if (srw_error)
     {
+        yaz_log(LOG_DEBUG, "srw_bend_search returned SRW error %d", srw_error);
         srw_res->num_diagnostics = 1;
         srw_res->diagnostics = (Z_SRW_diagnostic *)
            odr_malloc(assoc->encode, sizeof(*srw_res->diagnostics));
@@ -595,7 +628,6 @@ static void srw_bend_search(association *assoc, request *req,
         srw_res->diagnostics[0].details = 0;
         return;
     }
-
     
     rr.stream = assoc->encode;
     rr.decode = assoc->decode;
@@ -612,6 +644,7 @@ static void srw_bend_search(association *assoc, request *req,
     srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
     if (rr.errcode)
     {
+        yaz_log(LOG_DEBUG, "bend_search returned Bib-1 code %d", rr.errcode);
         srw_res->num_diagnostics = 1;
         srw_res->diagnostics = (Z_SRW_diagnostic *)
            odr_malloc(assoc->encode, sizeof(*srw_res->diagnostics));
@@ -619,6 +652,9 @@ static void srw_bend_search(association *assoc, request *req,
             odr_intdup(assoc->encode, 
                        yaz_diag_bib1_to_srw (rr.errcode));
         srw_res->diagnostics[0].details = rr.errstring;
+        yaz_log(LOG_DEBUG, "srw_bend_search returned SRW error %d",
+                *srw_res->diagnostics[0].code);
+                
     }
     else
     {
@@ -628,22 +664,34 @@ static void srw_bend_search(association *assoc, request *req,
             int number = *srw_req->maximumRecords;
             int start = 1;
             int i;
+
             if (srw_req->startRecord)
                 start = *srw_req->startRecord;
+
+            yaz_log(LOG_DEBUG, "srw_bend_search. start=%d max=%d",
+                    start, *srw_req->maximumRecords);
+
             if (start <= rr.hits)
             {
                 int j = 0;
+                int packing = Z_SRW_recordPacking_string;
                 if (start + number > rr.hits)
                     number = rr.hits - start + 1;
+                if (srw_req->recordPacking && 
+                    !strcmp(srw_req->recordPacking, "xml"))
+                    packing = Z_SRW_recordPacking_XML;
                 srw_res->records = (Z_SRW_record *)
                     odr_malloc(assoc->encode,
                                number * sizeof(*srw_res->records));
                 for (i = 0; i<number; i++)
                 {
                     int errcode;
+                    
+                    srw_res->records[j].recordPacking = packing;
                     srw_res->records[j].recordData_buf = 0;
+                    yaz_log(LOG_DEBUG, "srw_bend_fetch %d", i+start);
                     errcode = srw_bend_fetch(assoc, i+start, srw_req,
-                                              srw_res->records + j);
+                                             srw_res->records + j);
                     if (errcode)
                     {
                         srw_res->num_diagnostics = 1;
@@ -667,6 +715,99 @@ static void srw_bend_search(association *assoc, request *req,
     }
 }
 
+
+static void srw_bend_explain(association *assoc, request *req,
+                             Z_SRW_explainRequest *srw_req,
+                             Z_SRW_explainResponse *srw_res)
+{
+    yaz_log(LOG_LOG, "Got SRW ExplainRequest");
+    if (!assoc->init)
+    {
+        yaz_log(LOG_DEBUG, "srw_bend_init");
+        if (!srw_bend_init(assoc))
+            return;
+    }
+    if (assoc->init && assoc->init->bend_explain)
+    {
+        bend_explain_rr rr;
+
+        rr.stream = assoc->encode;
+        rr.decode = assoc->decode;
+        rr.print = assoc->print;
+        rr.explain_buf = 0;
+        (*assoc->init->bend_explain)(assoc->backend, &rr);
+        if (rr.explain_buf)
+        {
+            srw_res->explainData_buf = rr.explain_buf;
+            srw_res->explainData_len = strlen(rr.explain_buf);
+        }
+    }
+}
+
+static int hex_digit (int ch)
+{
+    if (ch >= '0' && ch <= '9')
+        return ch - '0';
+    else if (ch >= 'a' && ch <= 'f')
+        return ch - 'a'+10;
+    else if (ch >= 'A' && ch <= 'F')
+        return ch - 'A'+10;
+    return 0;
+}
+
+static char *uri_val(const char *path, const char *name, ODR o)
+{
+    size_t nlen = strlen(name);
+    if (*path != '?')
+        return 0;
+    path++;
+    while (path && *path)
+    {
+        const char *p1 = strchr(path, '=');
+        if (!p1)
+            break;
+        if (p1 - path == nlen && !memcmp(path, name, nlen))
+        {
+            size_t i = 0;
+            char *ret;
+            
+            path = p1 + 1;
+            p1 = strchr(path, '&');
+            if (!p1)
+                p1 = strlen(path) + path;
+            ret = odr_malloc(o, p1 - path + 1);
+            while (*path && *path != '&')
+            {
+                if (*path == '+')
+                {
+                    ret[i++] = ' ';
+                    path++;
+                }
+                else if (*path == '%' && path[1] && path[2])
+                {
+                    ret[i++] = hex_digit (path[1])*16 + hex_digit (path[2]);
+                    path = path + 3;
+                }
+                else
+                    ret[i++] = *path++;
+            }
+            ret[i] = '\0';
+            return ret;
+        }
+        path = strchr(p1, '&');
+        if (path)
+            path++;
+    }
+    return 0;
+}
+
+void uri_val_int(const char *path, const char *name, ODR o, int **intp)
+{
+    const char *v = uri_val(path, name, o);
+    if (v)
+        *intp = odr_intdup(o, atoi(v));
+}
+
 static void process_http_request(association *assoc, request *req)
 {
     Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
@@ -677,6 +818,137 @@ static void process_http_request(association *assoc, request *req)
 
     if (!strcmp(hreq->method, "GET"))
     {
+        char *charset = 0;
+        int ret = -1;
+        Z_SOAP *soap_package = 0;
+        char *db = "Default";
+        const char *p0 = hreq->path, *p1;
+        static Z_SOAP_Handler soap_handlers[2] = {
+#if HAVE_XML2
+            {"http://www.loc.gov/zing/srw/v1.0/", 0,
+             (Z_SOAP_fun) yaz_srw_codec},
+#endif
+            {0, 0, 0}
+        };
+        
+        if (*p0 == '/')
+            p0++;
+        p1 = strchr(p0, '?');
+        if (!p1)
+            p1 = p0 + strlen(p0);
+        if (p1 != p0)
+        {
+            db = odr_malloc(assoc->decode, p1 - p0 + 1);
+            memcpy (db, p0, p1 - p0);
+            db[p1 - p0] = '\0';
+        }
+#if HAVE_XML2
+        if (p1 && *p1 == '?' && p1[1])
+        {
+            Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
+            Z_SRW_PDU *sr = yaz_srw_get(o, Z_SRW_searchRetrieve_request);
+            char *query = uri_val(p1, "query", o);
+            char *pQuery = uri_val(p1, "pQuery", o);
+            char *sortKeys = uri_val(p1, "sortKeys", o);
+            
+            if (query)
+            {
+                sr->u.request->query_type = Z_SRW_query_type_cql;
+                sr->u.request->query.cql = query;
+            }
+            if (pQuery)
+            {
+                sr->u.request->query_type = Z_SRW_query_type_pqf;
+                sr->u.request->query.pqf = pQuery;
+            }
+            if (sortKeys)
+            {
+                sr->u.request->sort_type = Z_SRW_sort_type_sort;
+                sr->u.request->sort.sortKeys = sortKeys;
+            }
+            sr->u.request->recordSchema = uri_val(p1, "recordSchema", o);
+            sr->u.request->recordPacking = uri_val(p1, "recordPacking", o);
+            if (!sr->u.request->recordPacking)
+                sr->u.request->recordPacking = "xml";
+            uri_val_int(p1, "maximumRecords", o, 
+                        &sr->u.request->maximumRecords);
+            uri_val_int(p1, "startRecord", o,
+                        &sr->u.request->startRecord);
+            if (sr->u.request->startRecord)
+                yaz_log(LOG_LOG, "startRecord=%d", *sr->u.request->startRecord);
+            sr->u.request->database = db;
+            srw_bend_search(assoc, req, sr->u.request, res->u.response);
+            
+            soap_package = odr_malloc(o, sizeof(*soap_package));
+            soap_package->which = Z_SOAP_generic;
+
+            soap_package->u.generic =
+                odr_malloc(o, sizeof(*soap_package->u.generic));
+
+            soap_package->u.generic->p = res;
+            soap_package->u.generic->ns = soap_handlers[0].ns;
+            soap_package->u.generic->no = 0;
+            
+            soap_package->ns = "SRU";
+
+            p = z_get_HTTP_Response(o, 200);
+            hres = p->u.HTTP_Response;
+
+            ret = z_soap_codec_enc(assoc->encode, &soap_package,
+                                   &hres->content_buf, &hres->content_len,
+                                   soap_handlers, charset);
+            if (!charset)
+                z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
+            else
+            {
+                char ctype[60];
+                strcpy(ctype, "text/xml; charset=");
+                strcat(ctype, charset);
+                z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
+            }
+
+        }
+        else
+        {
+            Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
+            Z_SRW_PDU *sr = yaz_srw_get(o, Z_SRW_explain_request);
+
+            srw_bend_explain(assoc, req, sr->u.explain_request,
+                            res->u.explain_response);
+
+            if (res->u.explain_response->explainData_buf)
+            {
+                soap_package = odr_malloc(o, sizeof(*soap_package));
+                soap_package->which = Z_SOAP_generic;
+                
+                soap_package->u.generic =
+                    odr_malloc(o, sizeof(*soap_package->u.generic));
+                
+                soap_package->u.generic->p = res;
+                soap_package->u.generic->ns = soap_handlers[0].ns;
+                soap_package->u.generic->no = 0;
+                
+                soap_package->ns = "SRU";
+                
+                p = z_get_HTTP_Response(o, 200);
+                hres = p->u.HTTP_Response;
+                
+                ret = z_soap_codec_enc(assoc->encode, &soap_package,
+                                       &hres->content_buf, &hres->content_len,
+                                       soap_handlers, charset);
+                if (!charset)
+                    z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
+                else
+                {
+                    char ctype[60];
+                    strcpy(ctype, "text/xml; charset=");
+                    strcat(ctype, charset);
+                    z_HTTP_header_add(o, &hres->headers, "Content-Type",
+                                      ctype);
+                }
+            }
+        }
+#endif
 #ifdef DOCDIR
        if (strlen(hreq->path) >= 5 && strlen(hreq->path) < 80 &&
                         !memcmp(hreq->path, "/doc/", 5))
@@ -728,6 +1000,8 @@ static void process_http_request(association *assoc, request *req)
            }
        }
 #endif
+
+#if 0
        if (!strcmp(hreq->path, "/")) 
         {
 #ifdef DOCDIR
@@ -756,6 +1030,8 @@ static void process_http_request(association *assoc, request *req)
             hres->content_len = strlen(hres->content_buf);
             z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/html");
         }
+#endif
+
         if (!p)
         {
             p = z_get_HTTP_Response(o, 404);
@@ -765,26 +1041,36 @@ static void process_http_request(association *assoc, request *req)
     {
         const char *content_type = z_HTTP_header_lookup(hreq->headers,
                                                         "Content-Type");
-        const char *soap_action = z_HTTP_header_lookup(hreq->headers,
-                                                       "SOAPAction");
-        if (content_type && soap_action && 
-            !yaz_strcmp_del("text/xml", content_type, "; "))
+        if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
         {
             Z_SOAP *soap_package = 0;
             int ret = -1;
             int http_code = 500;
+            const char *charset_p = 0;
+            char *charset = 0;
 
             static Z_SOAP_Handler soap_handlers[2] = {
 #if HAVE_XML2
                 {"http://www.loc.gov/zing/srw/v1.0/", 0,
-                                        (Z_SOAP_fun) yaz_srw_codec},
+                 (Z_SOAP_fun) yaz_srw_codec},
 #endif
                 {0, 0, 0}
             };
+            if ((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 = odr_malloc(assoc->encode, i+1);
+                memcpy(charset, charset_p, i);
+                charset[i] = '\0';
+                yaz_log(LOG_LOG, "SOAP encoding %s", charset);
+            }
             ret = z_soap_codec(assoc->decode, &soap_package, 
                                &hreq->content_buf, &hreq->content_len,
                                soap_handlers);
-            
 #if HAVE_XML2
             if (!ret && soap_package->which == Z_SOAP_generic &&
                 soap_package->u.generic->no == 0)
@@ -822,15 +1108,46 @@ static void process_http_request(association *assoc, request *req)
                     soap_package->u.generic->p = res;
                     http_code = 200;
                 }
+                else if (sr->which == Z_SRW_explain_request)
+                {
+                    Z_SRW_PDU *res =
+                        yaz_srw_get(assoc->encode, Z_SRW_explain_response);
+
+                    srw_bend_explain(assoc, req, sr->u.explain_request,
+                                     res->u.explain_response);
+                    if (!res->u.explain_response->explainData_buf)
+                    {
+                        z_soap_error(assoc->encode, soap_package,
+                                     "SOAP-ENV:Client", "Explain Not Supported", 0);
+                    }
+                    else
+                    {
+                        soap_package->u.generic->p = res;
+                        http_code = 200;
+                    }
+                }
+                else
+                {
+                    z_soap_error(assoc->encode, soap_package,
+                                 "SOAP-ENV:Client", "Bad method", 0); 
+                }
             }
 #endif
             p = z_get_HTTP_Response(o, 200);
             hres = p->u.HTTP_Response;
-            ret = z_soap_codec(assoc->encode, &soap_package,
-                               &hres->content_buf, &hres->content_len,
-                               soap_handlers);
+            ret = z_soap_codec_enc(assoc->encode, &soap_package,
+                                   &hres->content_buf, &hres->content_len,
+                                   soap_handlers, charset);
             hres->code = http_code;
-            z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
+            if (!charset)
+                z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
+            else
+            {
+                char ctype[60];
+                strcpy(ctype, "text/xml; charset=");
+                strcat(ctype, charset);
+                z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
+            }
         }
         if (!p) /* still no response ? */
             p = z_get_HTTP_Response(o, 500);
@@ -1438,8 +1755,8 @@ static Z_Records *pack_records(association *a, char *setname, int start,
        freq.output_format_raw = 0;
        freq.stream = a->encode;
        freq.print = a->print;
-       freq.surrogate_flag = 0;
        freq.referenceId = referenceId;
+        freq.schema = 0;
        (*a->init->bend_fetch)(a->backend, &freq);
        /* backend should be able to signal whether error is system-wide
           or only pertaining to current record */
@@ -1788,6 +2105,7 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
     oident *attset;
     bend_scan_rr *bsrr = (bend_scan_rr *)
         odr_malloc (assoc->encode, sizeof(*bsrr));
+    struct scan_entry *save_entries;
 
     yaz_log(LOG_LOG, "Got ScanRequest");
 
@@ -1825,6 +2143,28 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
     bsrr->stream = assoc->encode;
     bsrr->print = assoc->print;
     bsrr->step_size = res->stepSize;
+    bsrr->entries = 0;
+    /* Note that version 2.0 of YAZ and older did not set entries .. 
+       We do now. And when we do it's easier to extend the scan entry 
+       We know that if the scan handler did set entries, it will
+       not know of new member display_term.
+    */
+    if (bsrr->num_entries > 0) 
+    {
+        int i;
+        bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
+                                   bsrr->num_entries);
+        for (i = 0; i<bsrr->num_entries; i++)
+        {
+            bsrr->entries[i].term = 0;
+            bsrr->entries[i].occurrences = 0;
+            bsrr->entries[i].errcode = 0;
+            bsrr->entries[i].errstring = 0;
+            bsrr->entries[i].display_term = 0;
+        }
+    }
+    save_entries = bsrr->entries;  /* save it so we can compare later */
+
     if (req->attributeSet &&
         (attset = oid_getentbyoid(req->attributeSet)) &&
         (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
@@ -1866,6 +2206,16 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
                     odr_malloc(assoc->encode, sizeof(*t));
                 t->suggestedAttributes = 0;
                 t->displayTerm = 0;
+                if (save_entries == bsrr->entries && 
+                    bsrr->entries[i].display_term)
+                {
+                    /* the entries was NOT set by the handler. So it's
+                       safe to test for new member display_term. It is
+                       NULL'ed by us.
+                    */
+                    t->displayTerm = odr_strdup(assoc->encode,
+                                                bsrr->entries[i].display_term);
+                }
                 t->alternativeTerm = 0;
                 t->byAttributes = 0;
                 t->otherTermInfo = 0;