zutil/prt-ext.c

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