util/oid.c

   1 /*
   2  * Copyright (c) 1995, Index Data
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: oid.c,v $
   7  * Revision 1.16  1996-10-09 15:55:02  quinn
   8  * Added SearchInfoReport
   9  *
  10  * Revision 1.15  1996/10/07  15:29:43  quinn
  11  * Added SOIF support
  12  *
  13  * Revision 1.14  1996/02/20  17:58:28  adam
  14  * Added const to oid_getvalbyname.
  15  *
  16  * Revision 1.13  1996/02/20  16:37:33  quinn
  17  * Using yaz_matchstr in oid_getvalbyname
  18  *
  19  * Revision 1.12  1996/01/02  08:57:53  quinn
  20  * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
  21  *
  22  * Revision 1.11  1995/12/13  16:03:35  quinn
  23  * *** empty log message ***
  24  *
  25  * Revision 1.10  1995/11/28  09:30:44  quinn
  26  * Work.
  27  *
  28  * Revision 1.9  1995/11/13  09:27:53  quinn
  29  * Fiddling with the variant stuff.
  30  *
  31  * Revision 1.8  1995/10/12  10:34:56  quinn
  32  * Added Espec-1.
  33  *
  34  * Revision 1.7  1995/10/10  16:27:12  quinn
  35  * *** empty log message ***
  36  *
  37  * Revision 1.6  1995/09/29  17:12:35  quinn
  38  * Smallish
  39  *
  40  * Revision 1.5  1995/09/29  17:01:51  quinn
  41  * More Windows work
  42  *
  43  * Revision 1.4  1995/09/27  15:03:03  quinn
  44  * Modified function heads & prototypes.
  45  *
  46  * Revision 1.3  1995/09/12  11:32:06  quinn
  47  * Added a looker-upper by name.
  48  *
  49  * Revision 1.2  1995/08/21  09:11:16  quinn
  50  * Smallish fixes to suppport new formats.
  51  *
  52  * Revision 1.1  1995/05/29  08:17:13  quinn
  53  * iMoved oid to util to support comstack.
  54  *
  55  * Revision 1.5  1995/05/22  11:30:16  quinn
  56  * Adding Z39.50-1992 stuff to proto.c. Adding zget.c
  57  *
  58  * Revision 1.4  1995/05/16  08:50:22  quinn
  59  * License, documentation, and memory fixes
  60  *
  61  * Revision 1.3  1995/04/11  11:52:02  quinn
  62  * Fixed possible buf in proto.c
  63  *
  64  * Revision 1.2  1995/03/29  15:39:38  quinn
  65  * Adding some resource control elements, and a null-check to getentbyoid
  66  *
  67  * Revision 1.1  1995/03/27  08:32:12  quinn
  68  * Added OID database
  69  *
  70  *
  71  */
  72
  73 /*
  74  * More or less protocol-transparent OID database.
  75  * We could (and should?) extend this so that the user app can add new
  76  * entries to the list at initialization.
  77  */
  78
  79 #include <oid.h>
  80 #include <yaz-util.h>
  81
  82 static int z3950_prefix[] = { 1, 2, 840, 10003, -1 };
  83 static int sr_prefix[]    = { 1, 0, 10163, -1 };
  84
  85 /*
  86  * OID database
  87  */
  88 static oident oids[] =
  89 {
  90     /* General definitions */
  91     {PROTO_GENERAL, CLASS_TRANSYN, VAL_BER,       {2,1,1,-1},  "BER"         },
  92     {PROTO_GENERAL, CLASS_TRANSYN, VAL_ISO2709,   {1,0,2709,1,1,-1},"ISO2709"},
  93
  94     /* Z39.50v3 definitions */
  95     {PROTO_Z3950,   CLASS_ABSYN,   VAL_APDU,      {2,1,-1},    "Z-APDU"      },
  96     {PROTO_Z3950,   CLASS_APPCTX,  VAL_BASIC_CTX, {1,1,-1},    "Z-BASIC"     },
  97     {PROTO_Z3950,   CLASS_ATTSET,  VAL_BIB1,      {3,1,-1},    "Bib-1"       },
  98     {PROTO_Z3950,   CLASS_ATTSET,  VAL_EXP1,      {3,2,-1},    "Exp-1"       },
  99     {PROTO_Z3950,   CLASS_ATTSET,  VAL_EXT1,      {3,3,-1},    "Ext-1"       },
 100     {PROTO_Z3950,   CLASS_ATTSET,  VAL_CCL1,      {3,4,-1},    "CCL-1"       },
 101     {PROTO_Z3950,   CLASS_ATTSET,  VAL_GILS,      {3,5,-1},    "GILS-attset" },
 102     {PROTO_Z3950,   CLASS_ATTSET,  VAL_STAS,      {3,6,-1},    "STAS-attset" },
 103     {PROTO_Z3950,   CLASS_DIAGSET, VAL_BIB1,      {4,1,-1},    "Bib-1"       },
 104     {PROTO_Z3950,   CLASS_DIAGSET, VAL_DIAG1,     {4,2,-1},    "Diag-1"      },
 105     {PROTO_Z3950,   CLASS_RECSYN,  VAL_UNIMARC,   {5,1,-1},    "Unimarc"     },
 106     {PROTO_Z3950,   CLASS_RECSYN,  VAL_INTERMARC, {5,2,-1},    "Intermarc"   },
 107     {PROTO_Z3950,   CLASS_RECSYN,  VAL_CCF,       {5,3,-1},    "CCF"         },
 108     {PROTO_Z3950,   CLASS_RECSYN,  VAL_USMARC,    {5,10,-1},   "USmarc"      },
 109     {PROTO_Z3950,   CLASS_RECSYN,  VAL_UKMARC,    {5,11,-1},   "UKmarc"      },
 110     {PROTO_Z3950,   CLASS_RECSYN,  VAL_NORMARC,   {5,12,-1},   "Normarc"     },
 111     {PROTO_Z3950,   CLASS_RECSYN,  VAL_LIBRISMARC,{5,13,-1},   "Librismarc"  },
 112     {PROTO_Z3950,   CLASS_RECSYN,  VAL_DANMARC,   {5,14,-1},   "Danmarc"     },
 113     {PROTO_Z3950,   CLASS_RECSYN,  VAL_FINMARC,   {5,15,-1},   "Finmarc"     },
 114     {PROTO_Z3950,   CLASS_RECSYN,  VAL_MAB,       {5,16,-1},   "MAB"         },
 115     {PROTO_Z3950,   CLASS_RECSYN,  VAL_CANMARC,   {5,17,-1},   "Canmarc"     },
 116     {PROTO_Z3950,   CLASS_RECSYN,  VAL_SBN,       {5,18,-1},   "SBN"         },
 117     {PROTO_Z3950,   CLASS_RECSYN,  VAL_PICAMARC,  {5,19,-1},   "Picamarc"    },
 118     {PROTO_Z3950,   CLASS_RECSYN,  VAL_AUSMARC,   {5,20,-1},   "Ausmarc"     },
 119     {PROTO_Z3950,   CLASS_RECSYN,  VAL_IBERMARC,  {5,21,-1},   "Ibermarc"    },
 120     {PROTO_Z3950,   CLASS_RECSYN,  VAL_EXPLAIN,   {5,100,-1},  "Explain"     },
 121     {PROTO_Z3950,   CLASS_RECSYN,  VAL_SUTRS,     {5,101,-1},  "SUTRS"       },
 122     {PROTO_Z3950,   CLASS_RECSYN,  VAL_OPAC,      {5,102,-1},  "OPAC"        },
 123     {PROTO_Z3950,   CLASS_RECSYN,  VAL_SUMMARY,   {5,103,-1},  "Summary"     },
 124     {PROTO_Z3950,   CLASS_RECSYN,  VAL_GRS0,      {5,104,-1},  "GRS-0"       },
 125     {PROTO_Z3950,   CLASS_RECSYN,  VAL_GRS1,      {5,105,-1},  "GRS-1"       },
 126     {PROTO_Z3950,   CLASS_RECSYN,  VAL_EXTENDED,  {5,106,-1},  "Extended"    },
 127 #if 0
 128     {PROTO_Z3950,   CLASS_RECSYN,  VAL_ID_SGML,   {5,1000,81,1,-1},"ID-SGML" },
 129 #endif
 130     {PROTO_Z3950,   CLASS_RECSYN,  VAL_SOIF,      {5,1000,81,2,-1},"SOIF" },
 131     {PROTO_Z3950,   CLASS_RESFORM, VAL_RESOURCE1, {7,1,-1},    "Resource-1"  },
 132     {PROTO_Z3950,   CLASS_RESFORM, VAL_RESOURCE2, {7,2,-1},    "Resource-2"  },
 133     {PROTO_Z3950,   CLASS_ACCFORM, VAL_PROMPT1,   {8,1,-1},    "Prompt-1"    },
 134     {PROTO_Z3950,   CLASS_ACCFORM, VAL_DES1,      {8,2,-1},    "Des-1"       },
 135     {PROTO_Z3950,   CLASS_ACCFORM, VAL_KRB1,      {8,3,-1},    "Krb-1"       },
 136     {PROTO_Z3950,   CLASS_EXTSERV, VAL_PRESSET,   {9,1,-1},    "Pers. set"   },
 137     {PROTO_Z3950,   CLASS_EXTSERV, VAL_PQUERY,    {9,2,-1},    "Pers. query" },
 138     {PROTO_Z3950,   CLASS_EXTSERV, VAL_PCQUERY,   {9,3,-1},    "Per'd query" },
 139     {PROTO_Z3950,   CLASS_EXTSERV, VAL_ITEMORDER, {9,4,-1},    "Item order"  },
 140     {PROTO_Z3950,   CLASS_EXTSERV, VAL_DBUPDATE,  {9,5,-1},    "DB. Update"  },
 141     {PROTO_Z3950,   CLASS_EXTSERV, VAL_EXPORTSPEC,{9,6,-1},    "exp. spec."  },
 142     {PROTO_Z3950,   CLASS_EXTSERV, VAL_EXPORTINV, {9,7,-1},    "exp. inv."   },
 143
 144     {PROTO_Z3950,   CLASS_USERINFO,VAL_SEARCHRES1 {10,1,-1},  "searchResult-1"},
 145
 146     {PROTO_Z3950,   CLASS_ELEMSPEC,VAL_ESPEC1,    {11,1,-1},   "Espec-1"     },
 147     {PROTO_Z3950,   CLASS_VARSET,  VAL_VAR1,      {12,1,-1},   "Variant-1"   },
 148
 149     {PROTO_Z3950,   CLASS_SCHEMA,  VAL_WAIS,      {13,1,-1},   "WAIS-schema" },
 150     {PROTO_Z3950,   CLASS_SCHEMA,  VAL_GILS,      {13,2,-1},   "GILS-schema" },
 151
 152     {PROTO_Z3950,   CLASS_TAGSET,  VAL_SETM,      {14,1,-1},   "TagsetM"     },
 153     {PROTO_Z3950,   CLASS_TAGSET,  VAL_SETG,      {14,2,-1},   "TagsetG"     },
 154 #if 0
 155     {PROTO_Z3950,   CLASS_TAGSET,  VAL_GILS,      {14,3,-1},   "GILS-tagset" },
 156 #endif
 157
 158     /* SR definitions. Note that some of them aren't defined by the
 159         standard (yet), but are borrowed from Z3950v3 */
 160     {PROTO_SR,      CLASS_ABSYN,   VAL_APDU,      {2,1,-1},    "SR-APDU"     },
 161     {PROTO_SR,      CLASS_APPCTX,  VAL_BASIC_CTX, {1,1,-1},    "SR-BASIC"    },
 162     {PROTO_SR,      CLASS_ATTSET,  VAL_BIB1,      {3,1,-1},    "Bib-1"       },
 163     {PROTO_SR,      CLASS_ATTSET,  VAL_EXP1,      {3,2,-1},    "Exp-1"       },
 164     {PROTO_SR,      CLASS_ATTSET,  VAL_EXT1,      {3,3,-1},    "Ext-1"       },
 165     {PROTO_SR,      CLASS_ATTSET,  VAL_CCL1,      {3,4,-1},    "CCL-1"       },
 166     {PROTO_SR,      CLASS_ATTSET,  VAL_GILS,      {3,5,-1},    "GILS"        },
 167     {PROTO_SR,      CLASS_ATTSET,  VAL_STAS,      {3,6,-1},    "STAS",       },
 168     {PROTO_SR,      CLASS_DIAGSET, VAL_BIB1,      {4,1,-1},    "Bib-1"       },
 169     {PROTO_SR,      CLASS_DIAGSET, VAL_DIAG1,     {4,2,-1},    "Diag-1"      },
 170     {PROTO_SR,      CLASS_RECSYN,  VAL_UNIMARC,   {5,1,-1},    "Unimarc"     },
 171     {PROTO_SR,      CLASS_RECSYN,  VAL_INTERMARC, {5,2,-1},    "Intermarc"   },
 172     {PROTO_SR,      CLASS_RECSYN,  VAL_CCF,       {5,3,-1},     "CCF"        },
 173     {PROTO_SR,      CLASS_RECSYN,  VAL_USMARC,    {5,10,-1},   "USmarc"      },
 174     {PROTO_SR,      CLASS_RECSYN,  VAL_UKMARC,    {5,11,-1},   "UKmarc"      },
 175     {PROTO_SR,      CLASS_RECSYN,  VAL_NORMARC,   {5,12,-1},   "Normarc"     },
 176     {PROTO_SR,      CLASS_RECSYN,  VAL_LIBRISMARC,{5,13,-1},   "Librismarc"  },
 177     {PROTO_SR,      CLASS_RECSYN,  VAL_DANMARC,   {5,14,-1},   "Danmarc"     },
 178     {PROTO_SR,      CLASS_RECSYN,  VAL_FINMARC,   {5,15,-1},   "Finmarc"     },
 179     {PROTO_SR,      CLASS_RECSYN,  VAL_MAB,       {5,16,-1},   "MAB"         },
 180     {PROTO_SR,      CLASS_RECSYN,  VAL_CANMARC,   {5,17,-1},   "Canmarc"     },
 181     {PROTO_SR,      CLASS_RECSYN,  VAL_MAB,       {5,16,-1},   "MAB"         },
 182     {PROTO_SR,      CLASS_RECSYN,  VAL_CANMARC,   {5,17,-1},   "Canmarc"     },
 183     {PROTO_SR,      CLASS_RECSYN,  VAL_SBN,       {5,18,-1},   "SBN"         },
 184     {PROTO_SR,      CLASS_RECSYN,  VAL_PICAMARC,  {5,19,-1},   "Picamarc"    },
 185     {PROTO_SR,      CLASS_RECSYN,  VAL_AUSMARC,   {5,20,-1},   "Ausmarc"     },
 186     {PROTO_SR,      CLASS_RECSYN,  VAL_IBERMARC,  {5,21,-1},   "Ibermarc"    },
 187     {PROTO_SR,      CLASS_RECSYN,  VAL_EXPLAIN,   {5,100,-1},  "Explain"     },
 188     {PROTO_SR,      CLASS_RECSYN,  VAL_SUTRS,     {5,101,-1},  "SUTRS"       },
 189     {PROTO_SR,      CLASS_RECSYN,  VAL_OPAC,      {5,102,-1},  "OPAC"        },
 190     {PROTO_SR,      CLASS_RECSYN,  VAL_SUMMARY,   {5,103,-1},  "Summary"     },
 191     {PROTO_SR,      CLASS_RECSYN,  VAL_GRS0,      {5,104,-1},  "GRS-0"       },
 192     {PROTO_SR,      CLASS_RECSYN,  VAL_GRS1,      {5,105,-1},  "GRS-1"       },
 193     {PROTO_SR,      CLASS_RECSYN,  VAL_EXTENDED,  {5,106,-1},  "Extended"    },
 194     {PROTO_SR,      CLASS_RESFORM, VAL_RESOURCE1, {7,1,-1},    "Resource-1"  },
 195     {PROTO_SR,      CLASS_RESFORM, VAL_RESOURCE2, {7,2,-1},    "Resource-2"  },
 196     {PROTO_SR,      CLASS_ACCFORM, VAL_PROMPT1,   {8,1,-1},    "Prompt-1"    },
 197     {PROTO_SR,      CLASS_ACCFORM, VAL_DES1,      {8,2,-1},    "Des-1"       },
 198     {PROTO_SR,      CLASS_ACCFORM, VAL_KRB1,      {8,3,-1},    "Krb-1"       },
 199     {PROTO_SR,      CLASS_EXTSERV, VAL_PRESSET,   {9,1,-1},    "Pers. set"   },
 200     {PROTO_SR,      CLASS_EXTSERV, VAL_PQUERY,    {9,2,-1},    "Pers. query" },
 201     {PROTO_SR,      CLASS_EXTSERV, VAL_PCQUERY,   {9,3,-1},    "Per'd query" },
 202     {PROTO_SR,      CLASS_EXTSERV, VAL_ITEMORDER, {9,4,-1},    "Item order"  },
 203     {PROTO_SR,      CLASS_EXTSERV, VAL_DBUPDATE,  {9,5,-1},    "DB. Update"  },
 204     {PROTO_SR,      CLASS_EXTSERV, VAL_EXPORTSPEC,{9,6,-1},    "exp. spec."  },
 205     {PROTO_SR,      CLASS_EXTSERV, VAL_EXPORTINV, {9,7,-1},    "exp. inv."   },
 206     {PROTO_SR,      CLASS_ELEMSPEC,VAL_ESPEC1,    {11,1,-1},   "Espec-1"     },
 207     {PROTO_SR,      CLASS_VARSET,  VAL_VAR1,      {12,1,-1},   "Variant-1"   },
 208
 209     {PROTO_SR,      CLASS_SCHEMA,  VAL_WAIS,      {13,1,-1},   "WAIS-schema" },
 210     {PROTO_SR,      CLASS_SCHEMA,  VAL_GILS,      {13,2,-1},   "GILS-schema" },
 211
 212     {PROTO_SR,      CLASS_TAGSET,  VAL_SETM,      {14,1,-1},   "TagsetM"     },
 213     {PROTO_SR,      CLASS_TAGSET,  VAL_SETG,      {14,2,-1},   "TagsetG"     },
 214 #if 0
 215     {PROTO_SR,      CLASS_TAGSET,  VAL_GILS,      {14,3,-1},   "GILS-tagset" },
 216 #endif
 217
 218     {0,             0,             0,             {-1},        0          }
 219 };
 220
 221 /* OID utilities */
 222
 223 void oid_oidcpy(int *t, int *s)
 224 {
 225     while ((*(t++) = *(s++)) > -1);
 226 }
 227
 228 void oid_oidcat(int *t, int *s)
 229 {
 230     while (*t > -1)
 231         t++;
 232     while ((*(t++) = *(s++)) > -1);
 233 }
 234
 235 int oid_oidcmp(int *o1, int *o2)
 236 {
 237     while (*o1 == *o2 && *o1 > -1)
 238     {
 239         o1++;
 240         o2++;
 241     }
 242     if (*o1 == *o2)
 243         return 0;
 244     else if (*o1 > *o2)
 245         return 1;
 246     else
 247         return -1;
 248 }
 249
 250 int oid_oidlen(int *o)
 251 {
 252     int len = 0;
 253
 254     while (*(o++) >= 0)
 255         len++;
 256     return len;
 257 }
 258
 259
 260 static int match_prefix(int *look, int *prefix)
 261 {
 262     int len;
 263
 264     for (len = 0; *look == *prefix; look++, prefix++, len++);
 265     if (*prefix < 0) /* did we reach the end of the prefix? */
 266         return len;
 267     return 0;
 268 }
 269
 270 struct oident *oid_getentbyoid(int *o)
 271 {
 272     enum oid_proto proto;
 273     int prelen;
 274     oident *p;
 275
 276     /* determine protocol type */
 277     if (!o)
 278         return 0;
 279     if ((prelen = match_prefix(o, z3950_prefix)))
 280         proto = PROTO_Z3950;
 281     else if ((prelen = match_prefix(o, sr_prefix)))
 282         proto = PROTO_SR;
 283     else
 284         proto = PROTO_GENERAL;
 285     for (p = oids; *p->oidsuffix >= 0; p++)
 286         if (p->proto == proto && !oid_oidcmp(o + prelen, p->oidsuffix))
 287             return p;
 288     return 0;
 289 }
 290
 291 /*
 292  * To query, fill out proto, class, and value of the ent parameter.
 293  */
 294 int *oid_getoidbyent(struct oident *ent)
 295 {
 296     struct oident *p;
 297     static int ret[OID_SIZE];
 298
 299     for (p = oids; *p->oidsuffix >= 0; p++)
 300         if (ent->proto == p->proto &&
 301             ent->oclass == p->oclass &&
 302             ent->value == p->value)
 303         {
 304             if (ent->proto == PROTO_Z3950)
 305                 oid_oidcpy(ret, z3950_prefix);
 306             else if (ent->proto == PROTO_SR)
 307                 oid_oidcpy(ret, sr_prefix);
 308             else
 309                 ret[0] = -1;
 310             oid_oidcat(ret, p->oidsuffix);
 311             return ret;
 312         }
 313     return 0;
 314 }
 315
 316 oid_value oid_getvalbyname(const char *name)
 317 {
 318     struct oident *p;
 319
 320     for (p = oids; *p->oidsuffix >= 0; p++)
 321         if (!yaz_matchstr(p->desc, name))
 322             return p->value;
 323     return VAL_NONE;
 324 }