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