Chanes to SCAN
[yaz-moved-to-github.git] / server / seshigh.c
index a9dfd99..ab54a94 100644 (file)
@@ -4,15 +4,52 @@
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: seshigh.c,v $
- * Revision 1.44  1995-08-17 12:45:25  quinn
+ * Revision 1.58  1996-02-20 12:53:04  quinn
+ * Chanes to SCAN
+ *
+ * Revision 1.57  1996/01/02  08:57:47  quinn
+ * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
+ *
+ * Revision 1.56  1995/12/14  11:09:57  quinn
+ * Work on Explain
+ *
+ * Revision 1.55  1995/11/08  17:41:37  quinn
+ * Smallish.
+ *
+ * Revision 1.54  1995/11/08  15:11:29  quinn
+ * Log of close transmit.
+ *
+ * Revision 1.53  1995/11/01  13:54:58  quinn
+ * Minor adjustments
+ *
+ * Revision 1.52  1995/11/01  12:19:13  quinn
+ * Second attempt to fix same bug.
+ *
+ * Revision 1.50  1995/10/25  16:58:32  quinn
+ * Simple.
+ *
+ * Revision 1.49  1995/10/16  13:51:53  quinn
+ * Changes to provide Especs to the backend.
+ *
+ * Revision 1.48  1995/10/06  08:51:20  quinn
+ * Added Write-buffer.
+ *
+ * Revision 1.47  1995/08/29  14:24:16  quinn
+ * Added second half of close-handshake
+ *
+ * Revision 1.46  1995/08/29  11:17:58  quinn
+ * Added code to receive close
+ *
+ * Revision 1.45  1995/08/21  09:11:00  quinn
+ * Smallish fixes to suppport new formats.
+ *
+ * Revision 1.44  1995/08/17  12:45:25  quinn
  * Fixed minor problems with GRS-1. Added support in c&s.
  *
  * Revision 1.43  1995/08/15  12:00:31  quinn
  * Updated External
  *
  * Revision 1.42  1995/08/15  11:16:50  quinn
- * CV:e ----------------------------------------------------------------------
- * CV:e ----------------------------------------------------------------------
  *
  * Revision 1.41  1995/08/02  10:23:06  quinn
  * Smallish
 #include <stdio.h>
 #include <unistd.h>
 #include <assert.h>
+#include <sys/time.h>
 
-#include <dmalloc.h>
+#include <xmalloc.h>
 #include <comstack.h>
 #include <eventl.h>
 #include <session.h>
@@ -198,6 +236,7 @@ static Z_APDU *response_searchRequest(association *assoc, request *reqb,
 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
     int *fd);
 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
+static void process_close(association *assoc, request *reqb);
 
 static FILE *apduf = 0; /* for use in static mode */
 static statserv_options_block *control_block = 0;
@@ -214,7 +253,7 @@ association *create_association(IOCHAN channel, COMSTACK link)
 
     if (!control_block)
        control_block = statserv_getcontrol();
-    if (!(new = malloc(sizeof(*new))))
+    if (!(new = xmalloc(sizeof(*new))))
        return 0;
     new->client_chan = channel;
     new->client_link = link;
@@ -263,7 +302,7 @@ association *create_association(IOCHAN channel, COMSTACK link)
     new->input_buffer = 0;
     new->input_buffer_len = 0;
     new->backend = 0;
-    new->rejected = 0;
+    new->state = ASSOC_NEW;
     request_initq(&new->incoming);
     request_initq(&new->outgoing);
     new->proto = cs_getproto(link);
@@ -280,12 +319,40 @@ void destroy_association(association *h)
     if (h->print)
        odr_destroy(h->print);
     if (h->input_buffer)
-       free(h->input_buffer);
+    xfree(h->input_buffer);
     if (h->backend)
        bend_close(h->backend);
     while (request_deq(&h->incoming));
     while (request_deq(&h->outgoing));
-    free(h);
+   xfree(h);
+}
+
+static void do_close(association *a, int reason, char *message)
+{
+    Z_APDU apdu;
+    Z_Close *cls = zget_Close(a->encode);
+    request *req = request_get();
+
+    /* Purge request queue */
+    while (request_deq(&a->incoming));
+    while (request_deq(&a->outgoing));
+    if (a->version >= 3)
+    {
+       logf(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
+           reason, message ? message : "none");
+       apdu.which = Z_APDU_close;
+       apdu.u.close = cls;
+       *cls->closeReason = reason;
+       cls->diagnosticInformation = message;
+       process_response(a, req, &apdu);
+       iochan_settimeout(a->client_chan, 60);
+    }
+    else
+    {
+       logf(LOG_DEBUG, "v2 client. No Close PDU");
+       iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
+    }
+    a->state = ASSOC_DEAD;
 }
 
 /*
@@ -307,10 +374,18 @@ void ir_session(IOCHAN h, int event)
     assert(h && conn && assoc);
     if (event == EVENT_TIMEOUT)
     {
-       logf(LOG_LOG, "Timeout - closing connection.");
-       cs_close(conn);
-       destroy_association(assoc);
-       iochan_destroy(h);
+       if (assoc->state != ASSOC_UP)
+       {
+           logf(LOG_LOG, "Final timeout - closing connection.");
+           cs_close(conn);
+           destroy_association(assoc);
+           iochan_destroy(h);
+       }
+       else
+       {
+           logf(LOG_LOG, "Session idle too long. Sending close.");
+           do_close(assoc, Z_Close_lackOfActivity, 0);
+       }
        return;
     }
     if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
@@ -320,7 +395,7 @@ void ir_session(IOCHAN h, int event)
            logf(LOG_DEBUG, "ir_session (input)");
            assert(assoc && conn);
            /* We aren't speaking to this fellow */
-           if (assoc->rejected)
+           if (assoc->state == ASSOC_DEAD)
            {
                logf(LOG_LOG, "Closed connection after reject");
                cs_close(conn);
@@ -349,13 +424,12 @@ void ir_session(IOCHAN h, int event)
            odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
            if (!z_APDU(assoc->decode, &req->request, 0))
            {
-               logf(LOG_LOG, "ODR error on incoming PDU: %s",
-                   odr_errlist[odr_geterror(assoc->decode)]);
+               logf(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
+                   odr_errlist[odr_geterror(assoc->decode)],
+                   odr_offset(assoc->decode));
                logf(LOG_LOG, "PDU dump:");
                odr_dumpBER(log_file(), assoc->input_buffer, res);
-               cs_close(conn);
-               destroy_association(assoc);
-               iochan_destroy(h);
+               do_close(assoc, Z_Close_protocolError, "Malformed package");
                return;
            }
            req->request_mem = odr_extract_mem(assoc->decode);
@@ -372,11 +446,7 @@ void ir_session(IOCHAN h, int event)
        req = request_head(&assoc->incoming);
        if (req->state == REQUEST_IDLE)
            if (process_request(assoc) < 0)
-           {
-               cs_close(conn);
-               destroy_association(assoc);
-               iochan_destroy(h);
-           }
+               do_close(assoc, Z_Close_systemProblem, "Unknown error");
     }
     if (event & EVENT_OUTPUT)
     {
@@ -394,7 +464,7 @@ void ir_session(IOCHAN h, int event)
                break;
            case 0: /* all sent - release the request structure */
                logf(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
-               odr_release_mem(req->request_mem);
+               nmem_destroy(req->request_mem);
                request_deq(&assoc->outgoing);
                request_release(req);
                if (!request_head(&assoc->outgoing))
@@ -433,6 +503,8 @@ static int process_request(association *assoc)
            res = process_presentRequest(assoc, req, &fd); break;
        case Z_APDU_scanRequest:
            res = process_scanRequest(assoc, req, &fd); break;
+       case Z_APDU_close:
+           process_close(assoc, req); return 0;
        default:
            logf(LOG_WARN, "Bad APDU received");
            return -1;
@@ -492,9 +564,7 @@ void backend_response(IOCHAN i, int event)
     if ((res && process_response(assoc, req, res) < 0) || fd < 0)
     {
        logf(LOG_LOG, "Fatal error when talking to backend");
-       cs_close(assoc->client_link);
-       destroy_association(assoc);
-       iochan_destroy(assoc->client_chan);
+       do_close(assoc, Z_Close_systemProblem, 0);
        iochan_destroy(i);
        return;
     }
@@ -515,11 +585,12 @@ static int process_response(association *assoc, request *req, Z_APDU *res)
     {
        logf(LOG_WARN, "ODR error when encoding response: %s",
            odr_errlist[odr_geterror(assoc->decode)]);
+       odr_reset(assoc->encode);
        return -1;
     }
     req->response = odr_getbuf(assoc->encode, &req->len_response,
        &req->size_response);
-    odr_setbuf(assoc->encode, 0, 0, 0); /* don't free if we abort later */
+    odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
     odr_reset(assoc->encode);
     if (assoc->print && !z_APDU(assoc->print, &res, 0))
     {
@@ -528,9 +599,11 @@ static int process_response(association *assoc, request *req, Z_APDU *res)
        odr_reset(assoc->print);
     }
     /* change this when we make the backend reentrant */
-    assert(req == request_head(&assoc->incoming));
-    req->state = REQUEST_IDLE;
-    request_deq(&assoc->incoming);
+    if (req == request_head(&assoc->incoming))
+    {
+       req->state = REQUEST_IDLE;
+       request_deq(&assoc->incoming);
+    }
     request_enq(&assoc->outgoing, req);
     /* turn the work over to the ir_session handler */
     iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
@@ -542,7 +615,7 @@ static int process_response(association *assoc, request *req, Z_APDU *res)
 
 /*
  * Handle init request.
- * At the moment, we don't check the protocol version or the options
+ * At the moment, we don't check the options
  * anywhere else in the code - we just try not to do anything that would
  * break a naive client. We'll toss 'em into the association block when
  * we need them there.
@@ -554,6 +627,7 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb)
     Z_InitResponse *resp = apdu->u.initResponse;
     bend_initrequest binitreq;
     bend_initresult *binitres;
+    char options[100];
 
     logf(LOG_LOG, "Got initRequest");
     if (req->implementationId)
@@ -573,26 +647,57 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb)
 
     assoc->backend = binitres->handle;
     resp->referenceId = req->referenceId;
+    *options = '\0';
     /* let's tell the client what we can do */
     if (ODR_MASK_GET(req->options, Z_Options_search))
+    {
        ODR_MASK_SET(resp->options, Z_Options_search);
+       strcat(options, "srch");
+    }
     if (ODR_MASK_GET(req->options, Z_Options_present))
+    {
        ODR_MASK_SET(resp->options, Z_Options_present);
+       strcat(options, " prst");
+    }
 #if 0
     if (ODR_MASK_GET(req->options, Z_Options_delSet))
+    {
        ODR_MASK_SET(&options, Z_Options_delSet);
+       strcat(options, " del");
+    }
 #endif
     if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
+    {
        ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
+       strcat(options, " namedresults");
+    }
     if (ODR_MASK_GET(req->options, Z_Options_scan))
+    {
        ODR_MASK_SET(resp->options, Z_Options_scan);
+       strcat(options, " scan");
+    }
     if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
+    {
        ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
+       strcat(options, " concurop");
+    }
 
     if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
+    {
        ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
+       assoc->version = 2; /* 1 & 2 are equivalent */
+    }
     if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
+    {
        ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
+       assoc->version = 2;
+    }
+    if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
+    {
+       ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
+       assoc->version = 3;
+    }
+    logf(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
     assoc->maximumRecordSize = *req->maximumRecordSize;
     if (assoc->maximumRecordSize > control_block->maxrecordsize)
        assoc->maximumRecordSize = control_block->maxrecordsize;
@@ -606,8 +711,10 @@ static Z_APDU *process_initRequest(association *assoc, request *reqb)
     {
        logf(LOG_LOG, "Connection rejected by backend.");
        *resp->result = 0;
-       assoc->rejected = 1;
+       assoc->state = ASSOC_DEAD;
     }
+    else
+       assoc->state = ASSOC_UP;
     return apdu;
 }
 
@@ -631,7 +738,7 @@ static Z_Records *diagrec(oid_proto proto, int error, char *addinfo)
 #endif
 
     bib1.proto = proto;
-    bib1.class = CLASS_DIAGSET;
+    bib1.oclass = CLASS_DIAGSET;
     bib1.value = VAL_BIB1;
 
     logf(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
@@ -669,7 +776,7 @@ static Z_NamePlusRecord *surrogatediagrec(oid_proto proto, char *dbname,
 #endif
 
     bib1.proto = proto;
-    bib1.class = CLASS_DIAGSET;
+    bib1.oclass = CLASS_DIAGSET;
     bib1.value = VAL_BIB1;
 
     logf(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
@@ -707,7 +814,7 @@ static Z_DiagRecs *diagrecs(oid_proto proto, int error, char *addinfo)
 
     logf(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo);
     bib1.proto = proto;
-    bib1.class = CLASS_DIAGSET;
+    bib1.oclass = CLASS_DIAGSET;
     bib1.value = VAL_BIB1;
 
     err = error;
@@ -730,7 +837,7 @@ static Z_DiagRecs *diagrecs(oid_proto proto, int error, char *addinfo)
 #define MAX_RECORDS 256
 
 static Z_Records *pack_records(association *a, char *setname, int start,
-                               int *num, Z_ElementSetNames *esn,
+                               int *num, Z_RecordComposition *comp,
                                int *next, int *pres, oid_value format)
 {
     int recno, total_length = 0, toget = *num;
@@ -756,7 +863,14 @@ static Z_Records *pack_records(association *a, char *setname, int start,
        bend_fetchresult *fres;
        Z_NamePlusRecord *thisrec;
        Z_DatabaseRecord *thisext;
-
+       int this_length;
+
+       /*
+        * we get the number of bytes allocated on the stream before any
+        * allocation done by the backend - this should give us a reasonable
+        * idea of the total size of the data so far.
+        */
+       total_length = odr_total(a->encode);
        if (reclist.num_records == MAX_RECORDS - 1)
        {
            *pres = Z_PRES_PARTIAL_2;
@@ -764,6 +878,7 @@ static Z_Records *pack_records(association *a, char *setname, int start,
        }
        freq.setname = setname;
        freq.number = recno;
+       freq.comp = comp;
        freq.format = format;
        freq.stream = a->encode;
        if (!(fres = bend_fetch(a->backend, &freq, 0)))
@@ -778,19 +893,23 @@ static Z_Records *pack_records(association *a, char *setname, int start,
            *pres = Z_PRES_FAILURE;
            return diagrec(a->proto, fres->errcode, fres->errstring);
        }
+       if (fres->len >= 0)
+           this_length = fres->len;
+       else
+           this_length = odr_total(a->encode) - total_length;
        logf(LOG_DEBUG, "  fetched record, len=%d, total=%d",
-           fres->len, total_length);
-       if (fres->len + total_length > a->preferredMessageSize)
+           this_length, total_length);
+       if (this_length + total_length > a->preferredMessageSize)
        {
            /* record is small enough, really */
-           if (fres->len <= a->preferredMessageSize)
+           if (this_length <= a->preferredMessageSize)
            {
                logf(LOG_DEBUG, "  Dropped last normal-sized record");
                *pres = Z_PRES_PARTIAL_2;
                break;
            }
            /* record can only be fetched by itself */
-           if (fres->len < a->maximumRecordSize)
+           if (this_length < a->maximumRecordSize)
            {
                logf(LOG_DEBUG, "  Record > prefmsgsz");
                if (toget > 1)
@@ -799,7 +918,6 @@ static Z_Records *pack_records(association *a, char *setname, int start,
                    reclist.records[reclist.num_records] =
                         surrogatediagrec(a->proto, fres->basename, 16, 0);
                    reclist.num_records++;
-                   total_length += 10; /* totally arbitrary */
                    continue;
                }
            }
@@ -809,7 +927,6 @@ static Z_Records *pack_records(association *a, char *setname, int start,
                reclist.records[reclist.num_records] =
                    surrogatediagrec(a->proto, fres->basename, 17, 0);
                reclist.num_records++;
-               total_length += 10; /* totally arbitrary */
                continue;
            }
        }
@@ -824,7 +941,7 @@ static Z_Records *pack_records(association *a, char *setname, int start,
            sizeof(Z_DatabaseRecord))))
            return 0;
        recform.proto = a->proto;
-       recform.class = CLASS_RECSYN;
+       recform.oclass = CLASS_RECSYN;
        recform.value = fres->format;
        thisext->direct_reference = odr_oiddup(a->encode,
            oid_getoidbyent(&recform));
@@ -877,7 +994,6 @@ static Z_Records *pack_records(association *a, char *setname, int start,
        }
        reclist.records[reclist.num_records] = thisrec;
        reclist.num_records++;
-       total_length += fres->len;
        *next = fres->last_in_set ? 0 : recno + 1;
     }
     *num = reclist.num_records;
@@ -951,24 +1067,27 @@ static Z_APDU *response_searchRequest(association *assoc, request *reqb,
     else
     {
        static int toget;
-       Z_ElementSetNames *setnames;
+       Z_RecordComposition comp, *compp = 0;
        static int presst = 0;
 
        resp.records = 0;
        resp.resultCount = &bsrt->hits;
 
+       comp.which = Z_RecordComp_simple;
        /* how many records does the user agent want, then? */
        if (bsrt->hits <= *req->smallSetUpperBound)
        {
            toget = bsrt->hits;
-           setnames = req->smallSetElementSetNames;
+           if ((comp.u.simple = req->smallSetElementSetNames))
+               compp = &comp;
        }
        else if (bsrt->hits < *req->largeSetLowerBound)
        {
            toget = *req->mediumSetPresentNumber;
            if (toget > bsrt->hits)
                toget = bsrt->hits;
-           setnames = req->mediumSetElementSetNames;
+           if ((comp.u.simple = req->mediumSetElementSetNames))
+               compp = &comp;
        }
        else
            toget = 0;
@@ -979,12 +1098,12 @@ static Z_APDU *response_searchRequest(association *assoc, request *reqb,
            oid_value form;
 
            if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
-               prefformat->class != CLASS_RECSYN)
+               prefformat->oclass != CLASS_RECSYN)
                form = VAL_NONE;
            else
                form = prefformat->value;
            resp.records = pack_records(assoc, req->resultSetName, 1,
-               &toget, setnames, &next, &presst, form);
+               &toget, compp, &next, &presst, form);
            if (!resp.records)
                return 0;
            resp.numberOfRecordsReturned = &toget;
@@ -1042,13 +1161,14 @@ static Z_APDU *process_presentRequest(association *assoc, request *reqb,
 #endif
 
     if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
-       prefformat->class != CLASS_RECSYN)
+       prefformat->oclass != CLASS_RECSYN)
        form = VAL_NONE;
     else
        form = prefformat->value;
     num = *req->numberOfRecordsRequested;
     resp.records = pack_records(assoc, req->resultSetId,
-       *req->resultSetStartPoint, &num, 0, &next, &presst, form);
+       *req->resultSetStartPoint, &num, req->recordComposition, &next,
+       &presst, form);
     if (!resp.records)
        return 0;
     resp.numberOfRecordsReturned = &num;
@@ -1092,7 +1212,7 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
 #endif
 
     if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
-       attent->class != CLASS_ATTSET || attent->value != VAL_BIB1))
+       attent->oclass != CLASS_ATTSET || attent->value != VAL_BIB1))
        ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto, 121, 0);
     else if (req->stepSize && *req->stepSize > 0)
        ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto, 205, 0);
@@ -1140,8 +1260,10 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
                e->which = Z_Entry_termInfo;
                e->u.termInfo = t = odr_malloc(assoc->encode, sizeof(*t));
                t->suggestedAttributes = 0;
+               t->displayTerm = 0;
                t->alternativeTerm = 0;
                t->byAttributes = 0;
+               t->otherTermInfo = 0;
                t->globalOccurrences = &srs->entries[i].occurrences;
                t->term = odr_malloc(assoc->encode, sizeof(*t->term));
                t->term->which = Z_Term_general;
@@ -1161,3 +1283,28 @@ static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
 
     return &apdu;
 }
+
+static void process_close(association *assoc, request *reqb)
+{
+    Z_Close *req = reqb->request->u.close;
+    static char *reasons[] =
+    {
+       "finished",
+       "shutdown",
+       "systemProblem",
+       "costLimit",
+       "resources",
+       "securityViolation",
+       "protocolError",
+       "lackOfActivity",
+       "peerAbort",
+       "unspecified"
+    };
+
+    logf(LOG_LOG, "Got close, reason %s, message %s",
+       reasons[*req->closeReason], req->diagnosticInformation ?
+       req->diagnosticInformation : "NULL");
+    if (assoc->version < 3) /* to make do_force respond with close */
+       assoc->version = 3;
+    do_close(assoc, Z_Close_finished, "Association terminated by client");
+}