When the back-end refuses initialisation, return diagnostics
[yaz-moved-to-github.git] / server / seshigh.c
index 5f8a5c2..eedf040 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: seshigh.c,v 1.149 2003-03-18 13:34:36 adam Exp $
+ * $Id: seshigh.c,v 1.161 2003-09-09 16:03:46 mike Exp $
  */
 
 /*
@@ -66,6 +66,7 @@ void backend_response(IOCHAN i, int event);
 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
 static int process_z_response(association *assoc, request *req, Z_APDU *res);
 static Z_APDU *process_initRequest(association *assoc, request *reqb);
+static Z_External *init_diagnostics(ODR odr, int errcode, char *errstring);
 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
     int *fd);
 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
@@ -326,8 +327,10 @@ void ir_session(IOCHAN h, int event)
            odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
            if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
            {
-               yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
+               yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [element %s] "
+                        "[near byte %d] ",
                        odr_errmsg(odr_geterror(assoc->decode)),
+                        odr_getelement(assoc->decode),
                        odr_offset(assoc->decode));
                 if (assoc->decode->error != OHTTP)
                 {
@@ -436,8 +439,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));
@@ -512,6 +518,7 @@ 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;
@@ -523,9 +530,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;
 }
@@ -648,35 +656,43 @@ static void srw_bend_search(association *assoc, request *req,
                        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);
+                *srw_res->diagnostics[0].code);
                 
     }
     else
     {
+        int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
+        int start = srw_req->startRecord ? *srw_req->startRecord : 1;
+
+        yaz_log(LOG_LOG, "Request to pack %d+%d out of %d",
+                start, number, rr.hits);
+
         srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
-        if (srw_req->maximumRecords && *srw_req->maximumRecords > 0)
+        if (number > 0)
         {
-            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)
+            if (start > rr.hits)
+            {
+                yaz_log(LOG_LOG, "Request out or range");
+            }
+            else
             {
                 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,
@@ -704,6 +720,35 @@ 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')
@@ -726,7 +771,7 @@ static char *uri_val(const char *path, const char *name, ODR o)
         const char *p1 = strchr(path, '=');
         if (!p1)
             break;
-        if (p1 - path == nlen && !memcmp(path, name, nlen))
+        if ((size_t)(p1 - path) == nlen && !memcmp(path, name, nlen))
         {
             size_t i = 0;
             char *ret;
@@ -778,18 +823,18 @@ 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
+        int ret = -1;
+        char *charset = 0;
+        Z_SOAP *soap_package = 0;
+        static Z_SOAP_Handler soap_handlers[2] = {
             {"http://www.loc.gov/zing/srw/v1.0/", 0,
              (Z_SOAP_fun) yaz_srw_codec},
-#endif
             {0, 0, 0}
         };
+#endif
         
         if (*p0 == '/')
             p0++;
@@ -802,7 +847,7 @@ static void process_http_request(association *assoc, request *req)
             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);
@@ -827,6 +872,9 @@ static void process_http_request(association *assoc, request *req)
                 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,
@@ -834,8 +882,7 @@ static void process_http_request(association *assoc, request *req)
             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);
+            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;
@@ -866,6 +913,47 @@ static void process_http_request(association *assoc, request *req)
             }
 
         }
+        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))
@@ -917,6 +1005,8 @@ static void process_http_request(association *assoc, request *req)
            }
        }
 #endif
+
+#if 0
        if (!strcmp(hreq->path, "/")) 
         {
 #ifdef DOCDIR
@@ -945,6 +1035,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);
@@ -954,10 +1046,7 @@ 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;
@@ -968,7 +1057,7 @@ static void process_http_request(association *assoc, request *req)
             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}
             };
@@ -987,7 +1076,6 @@ static void process_http_request(association *assoc, request *req)
             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)
@@ -1025,6 +1113,29 @@ 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);
@@ -1273,8 +1384,9 @@ static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
     }
     if (!z_GDU(assoc->encode, &res, 0, 0))
     {
-       yaz_log(LOG_WARN, "ODR error when encoding response: %s",
-           odr_errmsg(odr_geterror(assoc->decode)));
+       yaz_log(LOG_WARN, "ODR error when decoding PDU: %s [element %s]",
+                odr_errmsg(odr_geterror(assoc->decode)),
+                odr_getelement(assoc->decode));
        return -1;
     }
     req->response = odr_getbuf(assoc->encode, &req->len_response,
@@ -1501,6 +1613,9 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb)
        yaz_log(LOG_LOG, "Connection rejected by backend.");
        *resp->result = 0;
        assoc->state = ASSOC_DEAD;
+       resp->userInformationField = init_diagnostics(assoc->encode,
+                                                     binitres->errcode,
+                                                     binitres->errstring);
     }
     else
        assoc->state = ASSOC_UP;
@@ -1508,13 +1623,79 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb)
 }
 
 /*
- * These functions should be merged.
+ * Diagnostic in default format, to be returned as either a surrogate
+ * or non-surrogate diagnostic in the context of an open session, or
+ * as User-information when an Init is refused.
  */
-
-static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo, ODR odr)
+static Z_DefaultDiagFormat *justdiag(ODR odr, int error, char *addinfo)
 {
+    int *err = odr_intdup(odr, error);
+    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
+       odr_malloc (odr, sizeof(*dr));
+
+    yaz_log(LOG_LOG, "[%d] %s%s%s", error, diagbib1_str(error),
+        addinfo ? " -- " : "", addinfo ? addinfo : "");
+
+    dr->diagnosticSetId =
+       yaz_oidval_to_z3950oid (odr, CLASS_DIAGSET, VAL_BIB1);
+    dr->condition = err;
     dr->which = Z_DefaultDiagFormat_v2Addinfo;
     dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
+    return dr;
+}
+
+/*
+ * Set the specified `errcode' and `errstring' into a UserInfo-1
+ * external to be returned to the client in accordance with Z35.90
+ * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
+ *     http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
+ */
+static Z_External *init_diagnostics(ODR odr, int error, char *addinfo)
+{
+    Z_External *x, *x2;
+    oident oid;
+    Z_OtherInformation *u;
+    Z_OtherInformationUnit *l;
+    Z_DiagnosticFormat *d;
+    Z_DiagnosticFormat_s *e;
+
+    x = (Z_External*) odr_malloc(odr, sizeof *x);
+    x->descriptor = 0;
+    x->indirect_reference = 0; 
+    oid.proto = PROTO_Z3950;
+    oid.oclass = CLASS_USERINFO;
+    oid.value = VAL_USERINFO1;
+    x->direct_reference = odr_oiddup(odr, oid_getoidbyent(&oid));
+    x->which = Z_External_userInfo1;
+
+    u = odr_malloc(odr, sizeof *u);
+    x->u.userInfo1 = u;
+    u->num_elements = 1;
+    u->list = (Z_OtherInformationUnit**) odr_malloc(odr, sizeof *u->list);
+    u->list[0] = (Z_OtherInformationUnit*) odr_malloc(odr, sizeof *u->list[0]);
+    l = u->list[0];
+    l->category = 0;
+    l->which = Z_OtherInfo_externallyDefinedInfo;
+
+    x2 = (Z_External*) odr_malloc(odr, sizeof *x);
+    l->information.externallyDefinedInfo = x2;
+    x2->descriptor = 0;
+    x2->indirect_reference = 0;
+    oid.oclass = CLASS_DIAGSET;
+    oid.value = VAL_DIAG1;
+    x2->direct_reference = odr_oiddup(odr, oid_getoidbyent(&oid));
+    x2->which = Z_External_diag1;
+
+    d = (Z_DiagnosticFormat*) odr_malloc(odr, sizeof *d);
+    x2->u.diag1 = d;
+    d->num = 1;
+    d->elements = (Z_DiagnosticFormat_s**) odr_malloc (odr, sizeof *d->elements);
+    d->elements[0] = (Z_DiagnosticFormat_s*) odr_malloc (odr, sizeof *d->elements[0]);
+    e = d->elements[0];
+
+    e->which = Z_DiagnosticFormat_s_defaultDiagRec;
+    e->u.defaultDiagRec = justdiag(odr, error, addinfo);
+    return x;
 }
 
 /*
@@ -1524,20 +1705,8 @@ static Z_Records *diagrec(association *assoc, int error, char *addinfo)
 {
     Z_Records *rec = (Z_Records *)
        odr_malloc (assoc->encode, sizeof(*rec));
-    int *err = odr_intdup(assoc->encode, error);
-    Z_DiagRec *drec = (Z_DiagRec *)
-       odr_malloc (assoc->encode, sizeof(*drec));
-    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
-       odr_malloc (assoc->encode, sizeof(*dr));
-
-    yaz_log(LOG_LOG, "[%d] %s %s%s", error, diagbib1_str(error),
-        addinfo ? " -- " : "", addinfo ? addinfo : "");
     rec->which = Z_Records_NSD;
-    rec->u.nonSurrogateDiagnostic = dr;
-    dr->diagnosticSetId =
-       yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
-    dr->condition = err;
-    set_addinfo (dr, addinfo, assoc->encode);
+    rec->u.nonSurrogateDiagnostic = justdiag(assoc->encode, error, addinfo);
     return rec;
 }
 
@@ -1549,21 +1718,14 @@ static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
 {
     Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
        odr_malloc (assoc->encode, sizeof(*rec));
-    int *err = odr_intdup(assoc->encode, error);
     Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
-    Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
-       odr_malloc (assoc->encode, sizeof(*dr));
     
     yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
     rec->databaseName = dbname;
     rec->which = Z_NamePlusRecord_surrogateDiagnostic;
     rec->u.surrogateDiagnostic = drec;
     drec->which = Z_DiagRec_defaultFormat;
-    drec->u.defaultFormat = dr;
-    dr->diagnosticSetId =
-       yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
-    dr->condition = err;
-    set_addinfo (dr, addinfo, assoc->encode);
+    drec->u.defaultFormat = justdiag(assoc->encode, error, addinfo);
 
     return rec;
 }
@@ -1649,8 +1811,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 */
@@ -1999,6 +2161,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");
 
@@ -2036,6 +2199,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))
@@ -2077,6 +2262,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;
@@ -2154,6 +2349,7 @@ static Z_APDU *process_sortRequest(association *assoc, request *reqb,
        res->num_diagnostics = 0;
        res->diagnostics = 0;
     }
+    res->resultCount = 0;
     res->otherInfo = 0;
 
     apdu->which = Z_APDU_sortResponse;