License, documentation, and memory fixes
[yaz-moved-to-github.git] / asn / proto.c
index 70b98ec..66664ab 100644 (file)
@@ -1,10 +1,25 @@
 /*
- * Copyright (C) 1994, Index Data I/S 
- * All rights reserved.
+ * Copyright (c) 1995, Index Data
+ * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: proto.c,v $
- * Revision 1.16  1995-03-30 10:26:43  quinn
+ * Revision 1.21  1995-05-16 08:50:24  quinn
+ * License, documentation, and memory fixes
+ *
+ * Revision 1.20  1995/05/15  11:55:25  quinn
+ * Smallish.
+ *
+ * Revision 1.19  1995/04/11  11:58:35  quinn
+ * Fixed bug.
+ *
+ * Revision 1.18  1995/04/11  11:52:02  quinn
+ * Fixed possible buf in proto.c
+ *
+ * Revision 1.17  1995/04/10  10:22:22  quinn
+ * Added SCAN.
+ *
+ * Revision 1.16  1995/03/30  10:26:43  quinn
  * Added Term structure
  *
  * Revision 1.15  1995/03/30  09:08:39  quinn
@@ -88,7 +103,7 @@ int z_UserInformationField(ODR o, Z_UserInformationField **p, int opt)
 int z_NSRAuthentication(ODR o, Z_NSRAuthentication **p, int opt)
 {
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        odr_visiblestring(o, &(*p)->user, 0) &&
        odr_visiblestring(o, &(*p)->password, 0) &&
@@ -99,7 +114,7 @@ int z_NSRAuthentication(ODR o, Z_NSRAuthentication **p, int opt)
 int z_IdPass(ODR o, Z_IdPass **p, int opt)
 {
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        odr_implicit(o, odr_visiblestring, &(*p)->groupId, ODR_CONTEXT, 0, 0) &&
        odr_implicit(o, odr_visiblestring, &(*p)->userId, ODR_CONTEXT, 1, 0) &&
@@ -383,7 +398,7 @@ int z_Operator(ODR o, Z_Operator **p, int opt)
        odr_constructed_end(o))
        return 1;
     *p = 0;
-    return opt && !o->error;
+    return opt && odr_ok(o);
 }
 
 int z_Operand(ODR o, Z_Operand **p, int opt)
@@ -402,7 +417,7 @@ int z_Operand(ODR o, Z_Operand **p, int opt)
     if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
        return 1;
     *p = 0;
-    return opt && !o->error;
+    return opt && odr_ok(o);
 }
 
 int z_RPNStructure(ODR o, Z_RPNStructure **p, int opt);
@@ -410,7 +425,7 @@ int z_RPNStructure(ODR o, Z_RPNStructure **p, int opt);
 int z_Complex(ODR o, Z_Complex **p, int opt)
 {
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        z_RPNStructure(o, &(*p)->s1, 0) &&
        z_RPNStructure(o, &(*p)->s2, 0) &&
@@ -434,13 +449,13 @@ int z_RPNStructure(ODR o, Z_RPNStructure **p, int opt)
     if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
        return 1;
     *p = 0;
-    return opt && !o->error;
+    return opt && odr_ok(o);
 }
 
 int z_RPNQuery(ODR o, Z_RPNQuery **p, int opt)
 {
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        odr_oid(o, &(*p)->attributeSetId, 0) &&
        z_RPNStructure(o, &(*p)->RPNStructure, 0) &&
@@ -465,7 +480,7 @@ int z_Query(ODR o, Z_Query **p, int opt)
     if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
        return 1;
     *p = 0;
-    return opt && !o->error;
+    return opt && odr_ok(o);
 }
 
 int z_SearchRequest(ODR o, Z_SearchRequest **p, int opt)
@@ -473,7 +488,7 @@ int z_SearchRequest(ODR o, Z_SearchRequest **p, int opt)
     Z_SearchRequest *pp;
 
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     pp = *p;
     return
        z_ReferenceId(o, &pp->referenceId, 1) &&
@@ -508,7 +523,7 @@ int z_DatabaseRecord(ODR o, Z_DatabaseRecord **p, int opt)
 int z_DiagRec(ODR o, Z_DiagRec **p, int opt)
 {
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        odr_oid(o, &(*p)->diagnosticSetId, 1) &&       /* SHOULD NOT BE OPT */
        odr_integer(o, &(*p)->condition, 0) &&
@@ -529,7 +544,7 @@ int z_NamePlusRecord(ODR o, Z_NamePlusRecord **p, int opt)
     };
 
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     return
        odr_implicit(o, z_DatabaseName, &(*p)->databaseName, ODR_CONTEXT,
            0, 1) &&
@@ -566,9 +581,211 @@ int z_Records(ODR o, Z_Records **p, int opt)
     if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
        return 1;
     *p = 0;
+    return opt && odr_ok(o);
+}
+
+/* ------------------------ SCAN SERVICE -------------------- */
+
+int z_AttributeList(ODR o, Z_AttributeList **p, int opt)
+{
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+    else if (!*p)
+       return opt;
+
+    odr_implicit_settag(o, ODR_CONTEXT, 44);
+    if (odr_sequence_of(o, z_AttributeElement, &(*p)->attributes,
+       &(*p)->num_attributes))
+       return 1;
+    *p = 0;
+    return opt && odr_ok(o);
+}
+
+/*
+ * This is a temporary hack. We don't know just *what* old version of the
+ * protocol willow uses, so we'll just patiently wait for them to update
+ */
+static int willow_scan = 0;
+
+int z_WillowAttributesPlusTerm(ODR o, Z_AttributesPlusTerm **p, int opt)
+{
+    if (!*p && o->direction != ODR_DECODE)
+       return opt;
+    if (!odr_constructed_begin(o, p, ODR_CONTEXT, 4))
+    {
+       o->t_class = -1;
+       return opt && odr_ok(o);
+    }
+    if (!odr_constructed_begin(o, p, ODR_CONTEXT, 1))
+       return 0;
+    if (!odr_constructed_begin(o, p, ODR_UNIVERSAL, ODR_SEQUENCE))
+       return 0;
+    if (!odr_implicit_settag(o, ODR_CONTEXT, 44))
+       return 0;
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+    if (!odr_sequence_of(o, z_AttributeElement, &(*p)->attributeList,
+       &(*p)->num_attributes))
+       return 0;
+    if (!odr_sequence_end(o) || !odr_sequence_end(o))
+       return 0;
+    if (!z_Term(o, &(*p)->term, 0))
+       return 0;
+    if (!odr_constructed_end(o))
+       return 0;
+    willow_scan = 1;
+    return 1;
+}
+
+int z_AlternativeTerm(ODR o, Z_AlternativeTerm **p, int opt)
+{
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+    else if (!*p)
+    {
+       o->t_class = -1;
+       return opt && odr_ok(o);
+    }
+
+    if (odr_sequence_of(o, z_AttributesPlusTerm, &(*p)->terms,
+       &(*p)->num_terms))
+       return 1;
+    *p = 0;
     return opt && !o->error;
 }
 
+int z_OccurrenceByAttributes(ODR o, Z_OccurrenceByAttributes **p, int opt)
+{
+    if (!odr_sequence_begin(o, p, sizeof(**p)))
+       return opt && odr_ok(o);
+    return
+       odr_explicit(o, z_AttributeList, &(*p)->attributes, ODR_CONTEXT, 1, 1)&&
+       odr_explicit(o, odr_integer, &(*p)->global, ODR_CONTEXT, 2, 1) &&
+       odr_sequence_end(o);
+}
+
+int z_TermInfo(ODR o, Z_TermInfo **p, int opt)
+{
+    if (!odr_sequence_begin(o, p, sizeof(**p)))
+       return opt && odr_ok(o);
+    return
+       (willow_scan ? 
+           odr_implicit(o, z_Term, &(*p)->term, ODR_CONTEXT, 1, 0) :
+           z_Term(o, &(*p)->term, 0)) &&
+       z_AttributeList(o, &(*p)->suggestedAttributes, 1) &&
+       odr_implicit(o, z_AlternativeTerm, &(*p)->alternativeTerm,
+           ODR_CONTEXT, 4, 1) &&
+       odr_implicit(o, odr_integer, &(*p)->globalOccurrences, ODR_CONTEXT,
+           2, 1) &&
+       odr_implicit(o, z_OccurrenceByAttributes, &(*p)->byAttributes,
+           ODR_CONTEXT, 3, 1) &&
+       odr_sequence_end(o);
+}
+
+int z_Entry(ODR o, Z_Entry **p, int opt)
+{
+    static Odr_arm arm[] =
+    {
+       {ODR_IMPLICIT, ODR_CONTEXT, 1, Z_Entry_termInfo, z_TermInfo},
+       {ODR_EXPLICIT, ODR_CONTEXT, 2, Z_Entry_surrogateDiagnostic,
+           z_DiagRec},
+       {-1, -1, -1, -1, 0}
+    };
+
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+
+    if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
+       return 1;
+    *p = 0;
+    return opt && odr_ok(o);
+}
+
+int z_Entries(ODR o, Z_Entries **p, int opt)
+{
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+    else if (!*p)
+       return opt;
+
+    if (odr_sequence_of(o, z_Entry, &(*p)->entries,
+       &(*p)->num_entries))
+       return 1;
+    *p = 0;
+    return 0;
+}
+
+int z_DiagRecs(ODR o, Z_DiagRecs **p, int opt)
+{
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+    else if (!*p)
+       return opt;
+
+       if (odr_sequence_of(o, z_DiagRec, &(*p)->diagRecs,
+       &(*p)->num_diagRecs))
+       return 1;
+    *p = 0;
+    return 0;
+}
+
+int z_ListEntries(ODR o, Z_ListEntries **p, int opt)
+{
+    static Odr_arm arm[] =
+    {
+       {ODR_IMPLICIT, ODR_CONTEXT, 1, Z_ListEntries_entries, z_Entries},
+       {ODR_IMPLICIT, ODR_CONTEXT, 2, Z_ListEntries_nonSurrogateDiagnostics,
+           z_DiagRecs},
+       {-1, -1, -1, -1, 0}
+    };
+
+    if (o->direction == ODR_DECODE)
+       *p = odr_malloc(o, sizeof(**p));
+
+    if (odr_choice(o, arm, &(*p)->u, &(*p)->which))
+       return 1;
+    *p = 0;
+    return opt && odr_ok(o);
+}
+
+int z_ScanRequest(ODR o, Z_ScanRequest **p, int opt)
+{
+    if (!odr_sequence_begin(o, p, sizeof(**p)))
+       return opt && odr_ok(o);
+    willow_scan = 0;
+    return
+       z_ReferenceId(o, &(*p)->referenceId, 1) &&
+       odr_implicit_settag(o, ODR_CONTEXT, 3) &&
+       odr_sequence_of(o, z_DatabaseName, &(*p)->databaseNames,
+           &(*p)->num_databaseNames) &&
+       odr_oid(o, &(*p)->attributeSet, 1) &&
+       (z_AttributesPlusTerm(o, &(*p)->termListAndStartPoint, 1) ?
+           ((*p)->termListAndStartPoint ? 1 : 
+       z_WillowAttributesPlusTerm(o, &(*p)->termListAndStartPoint, 0)) : 0) &&
+       odr_implicit(o, odr_integer, &(*p)->stepSize, ODR_CONTEXT, 5, 1) &&
+       odr_implicit(o, odr_integer, &(*p)->numberOfTermsRequested,
+           ODR_CONTEXT, 6, 0) &&
+       odr_implicit(o, odr_integer, &(*p)->preferredPositionInResponse,
+           ODR_CONTEXT, 7, 1) &&
+       odr_sequence_end(o);
+}
+
+int z_ScanResponse(ODR o, Z_ScanResponse **p, int opt)
+{
+    if (!odr_sequence_begin(o, p, sizeof(**p)))
+       return opt && odr_ok(o);
+    return
+       z_ReferenceId(o, &(*p)->referenceId, 1) &&
+       odr_implicit(o, odr_integer, &(*p)->stepSize, ODR_CONTEXT, 3, 1) &&
+       odr_implicit(o, odr_integer, &(*p)->scanStatus, ODR_CONTEXT, 4, 0) &&
+       odr_implicit(o, odr_integer, &(*p)->numberOfEntriesReturned,
+           ODR_CONTEXT, 5, 0) &&
+       odr_implicit(o, odr_integer, &(*p)->positionOfTerm, ODR_CONTEXT, 6, 1)&&
+       odr_explicit(o, z_ListEntries, &(*p)->entries, ODR_CONTEXT, 7, 1) &&
+       odr_implicit(o, odr_oid, &(*p)->attributeSet, ODR_CONTEXT, 8, 1) &&
+       odr_sequence_end(o);
+}
+
 /* ------------------------ SEARCHRESPONSE ----------------*/
 
 int z_NumberOfRecordsReturned(ODR o, int **p, int opt)
@@ -591,7 +808,7 @@ int z_SearchResponse(ODR o, Z_SearchResponse **p, int opt)
     Z_SearchResponse *pp;
 
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     pp = *p;
     return
        z_ReferenceId(o, &pp->referenceId, 1) &&
@@ -612,7 +829,7 @@ int z_PresentRequest(ODR o, Z_PresentRequest **p, int opt)
     Z_PresentRequest *pp;
 
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     pp = *p;
     return
        z_ReferenceId(o, &pp->referenceId, 1) &&
@@ -631,7 +848,7 @@ int z_PresentResponse(ODR o, Z_PresentResponse **p, int opt)
     Z_PresentResponse *pp;
 
     if (!odr_sequence_begin(o, p, sizeof(**p)))
-       return opt;
+       return opt && odr_ok(o);
     pp = *p;
     return
        z_ReferenceId(o, &pp->referenceId, 1) &&
@@ -651,9 +868,20 @@ int z_APDU(ODR o, Z_APDU **p, int opt)
        {ODR_IMPLICIT, ODR_CONTEXT, 20, Z_APDU_initRequest, z_InitRequest},
        {ODR_IMPLICIT, ODR_CONTEXT, 21, Z_APDU_initResponse, z_InitResponse},
        {ODR_IMPLICIT, ODR_CONTEXT, 22, Z_APDU_searchRequest, z_SearchRequest},
-       {ODR_IMPLICIT, ODR_CONTEXT, 23, Z_APDU_searchResponse, z_SearchResponse},
-       {ODR_IMPLICIT, ODR_CONTEXT, 24, Z_APDU_presentRequest, z_PresentRequest},
-       {ODR_IMPLICIT, ODR_CONTEXT, 25, Z_APDU_presentResponse, z_PresentResponse},
+       {ODR_IMPLICIT, ODR_CONTEXT, 23, Z_APDU_searchResponse,
+           z_SearchResponse},
+       {ODR_IMPLICIT, ODR_CONTEXT, 24, Z_APDU_presentRequest,
+           z_PresentRequest},
+       {ODR_IMPLICIT, ODR_CONTEXT, 25, Z_APDU_presentResponse,
+           z_PresentResponse},
+       {ODR_IMPLICIT, ODR_CONTEXT, 30, Z_APDU_resourceControlRequest,
+           z_ResourceControlRequest},
+       {ODR_IMPLICIT, ODR_CONTEXT, 31, Z_APDU_resourceControlResponse,
+           z_ResourceControlResponse},
+       {ODR_IMPLICIT, ODR_CONTEXT, 32, Z_APDU_triggerResourceControlRequest,
+           z_TriggerResourceControlRequest},
+       {ODR_IMPLICIT, ODR_CONTEXT, 35, Z_APDU_scanRequest, z_ScanRequest},
+       {ODR_IMPLICIT, ODR_CONTEXT, 36, Z_APDU_scanResponse, z_ScanResponse},
 
        {-1, -1, -1, -1, 0}
     };
@@ -664,7 +892,7 @@ int z_APDU(ODR o, Z_APDU **p, int opt)
     {
        if (o->direction == ODR_DECODE)
            *p = 0;
-       return opt && !o->error;
+       return opt && odr_ok(o);
     }
     return 1;
 }