zutil/prt-ext.c

   1 /*
   2  * Copyright (c) 1995-1999, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: prt-ext.c,v $
   7  * Revision 1.3  2000-03-14 13:52:32  ian
   8  * Added Admin Extended Service to External Choice
   9  *
  10  * Revision 1.2  1999/11/30 13:47:12  adam
  11  * Improved installation. Moved header files to include/yaz.
  12  *
  13  * Revision 1.1  1999/06/08 10:10:16  adam
  14  * New sub directory zutil. Moved YAZ Compiler to be part of YAZ tree.
  15  *
  16  * Revision 1.22  1999/05/26 15:24:26  adam
  17  * Fixed minor bugs regarding DB Update (introduced by previous commit).
  18  *
  19  * Revision 1.21  1999/05/26 14:47:12  adam
  20  * Implemented z_ext_record.
  21  *
  22  * Revision 1.20  1999/04/20 09:56:48  adam
  23  * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
  24  * Modified all encoders/decoders to reflect this change.
  25  *
  26  * Revision 1.19  1998/03/31 15:13:19  adam
  27  * Development towards compiled ASN.1.
  28  *
  29  * Revision 1.18  1998/03/31 11:07:44  adam
  30  * Furhter work on UNIverse resource report.
  31  * Added Extended Services handling in frontend server.
  32  *
  33  * Revision 1.17  1998/03/20 14:46:06  adam
  34  * Added UNIverse Resource Reports.
  35  *
  36  * Revision 1.16  1998/02/11 11:53:32  adam
  37  * Changed code so that it compiles as C++.
  38  *
  39  * Revision 1.15  1998/02/10 15:31:46  adam
  40  * Implemented date and time structure. Changed the Update Extended
  41  * Service.
  42  *
  43  * Revision 1.14  1998/01/05 09:04:57  adam
  44  * Fixed bugs in encoders/decoders - Not operator (!) missing.
  45  *
  46  * Revision 1.13  1997/05/14 06:53:22  adam
  47  * C++ support.
  48  *
  49  * Revision 1.12  1997/04/30 08:52:02  quinn
  50  * Null
  51  *
  52  * Revision 1.11  1996/10/10  12:35:13  quinn
  53  * Added Update extended service.
  54  *
  55  * Revision 1.10  1996/10/09  15:54:55  quinn
  56  * Added SearchInfoReport
  57  *
  58  * Revision 1.9  1996/06/10  08:53:36  quinn
  59  * Added Summary,OPAC,ResourceReport
  60  *
  61  * Revision 1.8  1996/02/20  12:51:44  quinn
  62  * Completed SCAN. Fixed problems with EXTERNAL.
  63  *
  64  * Revision 1.7  1995/10/12  10:34:38  quinn
  65  * Added Espec-1.
  66  *
  67  * Revision 1.6  1995/09/29  17:11:55  quinn
  68  * Smallish
  69  *
  70  * Revision 1.5  1995/09/27  15:02:42  quinn
  71  * Modified function heads & prototypes.
  72  *
  73  * Revision 1.4  1995/08/29  11:17:16  quinn
  74  * *** empty log message ***
  75  *
  76  * Revision 1.3  1995/08/21  09:10:18  quinn
  77  * Smallish fixes to suppport new formats.
  78  *
  79  * Revision 1.2  1995/08/17  12:45:00  quinn
  80  * Fixed minor problems with GRS-1. Added support in c&s.
  81  *
  82  * Revision 1.1  1995/08/15  13:37:41  quinn
  83  * Improved EXTERNAL
  84  *
  85  *
  86  */
  87
  88 #include <yaz/proto.h>
  89
  90 /*
  91  * The table below should be moved to the ODR structure itself and
  92  * be an image of the association context: To help
  93  * map indirect references when they show up.
  94  */
  95 static Z_ext_typeent type_table[] =
  96 {
  97     {VAL_SUTRS, Z_External_sutrs, (Odr_fun) z_SUTRS},
  98     {VAL_EXPLAIN, Z_External_explainRecord, (Odr_fun)z_ExplainRecord},
  99     {VAL_RESOURCE1, Z_External_resourceReport1, (Odr_fun)z_ResourceReport1},
 100     {VAL_RESOURCE2, Z_External_resourceReport2, (Odr_fun)z_ResourceReport2},
 101     {VAL_PROMPT1, Z_External_promptObject1, (Odr_fun)z_PromptObject1 },
 102     {VAL_GRS1, Z_External_grs1, (Odr_fun)z_GenericRecord},
 103     {VAL_EXTENDED, Z_External_extendedService, (Odr_fun)z_TaskPackage},
 104 #ifdef ASN_COMPILED
 105     {VAL_ITEMORDER, Z_External_itemOrder, (Odr_fun)z_IOItemOrder},
 106 #else
 107     {VAL_ITEMORDER, Z_External_itemOrder, (Odr_fun)z_ItemOrder},
 108 #endif
 109     {VAL_DIAG1, Z_External_diag1, (Odr_fun)z_DiagnosticFormat},
 110     {VAL_ESPEC1, Z_External_espec1, (Odr_fun)z_Espec1},
 111     {VAL_SUMMARY, Z_External_summary, (Odr_fun)z_BriefBib},
 112     {VAL_OPAC, Z_External_OPAC, (Odr_fun)z_OPACRecord},
 113     {VAL_SEARCHRES1, Z_External_searchResult1, (Odr_fun)z_SearchInfoReport},
 114     {VAL_DBUPDATE, Z_External_update, (Odr_fun)z_IUUpdate},
 115     {VAL_DATETIME, Z_External_dateTime, (Odr_fun)z_DateTime},
 116     {VAL_UNIVERSE_REPORT, Z_External_universeReport, (Odr_fun)z_UniverseReport},
 117     {VAL_NONE, 0, 0}
 118 };
 119
 120 Z_ext_typeent *z_ext_getentbyref(oid_value val)
 121 {
 122     Z_ext_typeent *i;
 123
 124     for (i = type_table; i->dref != VAL_NONE; i++)
 125         if (i->dref == val)
 126             return i;
 127     return 0;
 128 }
 129
 130 int z_External(ODR o, Z_External **p, int opt, const char *name)
 131 {
 132     oident *oid;
 133     Z_ext_typeent *type;
 134
 135     static Odr_arm arm[] =
 136     {
 137         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_single,
 138          (Odr_fun)odr_any, 0},
 139         {ODR_IMPLICIT, ODR_CONTEXT, 1, Z_External_octet,
 140          (Odr_fun)odr_octetstring, 0},
 141         {ODR_IMPLICIT, ODR_CONTEXT, 2, Z_External_arbitrary,
 142          (Odr_fun)odr_bitstring, 0},
 143         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_sutrs,
 144          (Odr_fun)z_SUTRS, 0},
 145         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_explainRecord,
 146          (Odr_fun)z_ExplainRecord, 0},
 147         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_resourceReport1,
 148          (Odr_fun)z_ResourceReport1, 0},
 149         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_resourceReport2,
 150          (Odr_fun)z_ResourceReport2, 0},
 151         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_promptObject1,
 152          (Odr_fun)z_PromptObject1, 0},
 153         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_grs1,
 154          (Odr_fun)z_GenericRecord, 0},
 155         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_extendedService,
 156          (Odr_fun)z_TaskPackage, 0},
 157 #ifdef ASN_COMPILED
 158         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_itemOrder,
 159          (Odr_fun)z_IOItemOrder, 0},
 160 #else
 161         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_itemOrder,
 162          (Odr_fun)z_ItemOrder, 0},
 163 #endif
 164         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_diag1,
 165          (Odr_fun)z_DiagnosticFormat, 0},
 166         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_espec1,
 167          (Odr_fun)z_Espec1, 0},
 168         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_summary,
 169          (Odr_fun)z_BriefBib, 0},
 170         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_OPAC,
 171          (Odr_fun)z_OPACRecord, 0},
 172         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_searchResult1,
 173          (Odr_fun)z_SearchInfoReport, 0},
 174         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_update,
 175          (Odr_fun)z_IUUpdate, 0},
 176         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_dateTime,
 177          (Odr_fun)z_DateTime, 0},
 178         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_universeReport,
 179          (Odr_fun)z_UniverseReport, 0},
 180 #ifdef ASN_COMPILED
 181         {ODR_EXPLICIT, ODR_CONTEXT, 0, Z_External_ESAdmin,
 182          (Odr_fun)z_Admin, 0},
 183 #endif
 184         {-1, -1, -1, -1, 0, 0}
 185     };
 186
 187     odr_implicit_settag(o, ODR_UNIVERSAL, ODR_EXTERNAL);
 188     if (!odr_sequence_begin(o, p, sizeof(**p), name))
 189         return opt && odr_ok(o);
 190     if (!(odr_oid(o, &(*p)->direct_reference, 1, 0) &&
 191           odr_integer(o, &(*p)->indirect_reference, 1, 0) &&
 192           odr_graphicstring(o, &(*p)->descriptor, 1, 0)))
 193         return 0;
 194     /*
 195      * Do we know this beast?
 196      */
 197     if (o->direction == ODR_DECODE && (*p)->direct_reference &&
 198         (oid = oid_getentbyoid((*p)->direct_reference)) &&
 199         (type = z_ext_getentbyref(oid->value)))
 200     {
 201         int zclass, tag, cons;
 202
 203         /*
 204          * We know it. If it's represented as an ASN.1 type, bias the CHOICE.
 205          */
 206         if (!odr_peektag(o, &zclass, &tag, &cons))
 207             return opt && odr_ok(o);
 208         if (zclass == ODR_CONTEXT && tag == 0 && cons == 1)
 209             odr_choice_bias(o, type->what);
 210     }
 211     return
 212         odr_choice(o, arm, &(*p)->u, &(*p)->which, name) &&
 213         odr_sequence_end(o);
 214 }
 215
 216 Z_External *z_ext_record(ODR o, int format, const char *buf, int len)
 217 {
 218     Z_External *thisext;
 219     oident recform;
 220     int oid[OID_SIZE];
 221
 222     thisext = (Z_External *) odr_malloc(o, sizeof(*thisext));
 223     thisext->descriptor = 0;
 224     thisext->indirect_reference = 0;
 225
 226     recform.proto = PROTO_Z3950;
 227     recform.oclass = CLASS_RECSYN;
 228     recform.value = (enum oid_value) format;
 229     if (!oid_ent_to_oid(&recform, oid))
 230         return 0;
 231     thisext->direct_reference = odr_oiddup(o, oid);
 232
 233     if (len < 0) /* Structured data */
 234     {
 235         switch (format)
 236         {
 237         case VAL_SUTRS:
 238             thisext->which = Z_External_sutrs;
 239             break;
 240         case VAL_GRS1:
 241             thisext->which = Z_External_grs1;
 242             break;
 243         case VAL_EXPLAIN:
 244             thisext->which = Z_External_explainRecord;
 245             break;
 246         case VAL_SUMMARY:
 247             thisext->which = Z_External_summary;
 248             break;
 249         case VAL_OPAC:
 250             thisext->which = Z_External_OPAC;
 251             break;
 252         default:
 253             return 0;
 254         }
 255
 256         /*
 257          * We cheat on the pointers here. Obviously, the record field
 258          * of the backend-fetch structure should have been a union for
 259          * correctness, but we're stuck with this for backwards
 260          * compatibility.
 261          */
 262         thisext->u.grs1 = (Z_GenericRecord*) buf;
 263     }
 264     else if (format == VAL_SUTRS) /* SUTRS is a single-ASN.1-type */
 265     {
 266         Odr_oct *sutrs = (Odr_oct *)odr_malloc(o, sizeof(*sutrs));
 267
 268         thisext->which = Z_External_sutrs;
 269         thisext->u.sutrs = sutrs;
 270         sutrs->buf = (unsigned char *)odr_malloc(o, len);
 271         sutrs->len = sutrs->size = len;
 272         memcpy(sutrs->buf, buf, len);
 273     }
 274     else
 275     {
 276         thisext->which = Z_External_octet;
 277         if (!(thisext->u.octet_aligned = (Odr_oct *)
 278               odr_malloc(o, sizeof(Odr_oct))))
 279             return 0;
 280         if (!(thisext->u.octet_aligned->buf = (unsigned char *)
 281               odr_malloc(o, len)))
 282             return 0;
 283         memcpy(thisext->u.octet_aligned->buf, buf, len);
 284         thisext->u.octet_aligned->len = thisext->u.octet_aligned->size = len;
 285     }
 286     return thisext;
 287 }
 288