2 * Copyright (c) 1995-2003, Index Data
3 * See the file LICENSE for details.
5 * $Id: oid.c,v 1.65 2003-07-23 12:07:30 mike Exp $
9 * More or less protocol-transparent OID database.
10 * We could (and should?) extend this so that the user app can add new
11 * entries to the list at initialization.
22 #include <yaz/yaz-util.h>
24 static int z3950_prefix[] = { 1, 2, 840, 10003, -1 };
25 static int sr_prefix[] = { 1, 0, 10163, -1 };
29 struct oident_list *next;
32 static struct oident_list *oident_table = NULL;
33 static int oid_value_dynamic = VAL_DYNAMIC;
34 static int oid_init_flag = 0;
35 static NMEM_MUTEX oid_mutex = 0;
36 static NMEM oid_nmem = 0;
41 static oident standard_oids[] =
43 /* General definitions */
44 {PROTO_GENERAL, CLASS_TRANSYN, VAL_BER, {2,1,1,-1},
46 {PROTO_GENERAL, CLASS_TRANSYN, VAL_ISO2709, {1,0,2709,1,1,-1},
48 {PROTO_GENERAL, CLASS_GENERAL, VAL_ISO_ILL_1, {1,0,10161,2,1,-1},
50 /* Z39.50v3 definitions */
51 {PROTO_Z3950, CLASS_ABSYN, VAL_APDU, {2,1,-1},
53 {PROTO_Z3950, CLASS_APPCTX, VAL_BASIC_CTX, {1,1,-1},
55 {PROTO_Z3950, CLASS_ATTSET, VAL_BIB1, {3,1,-1},
57 {PROTO_Z3950, CLASS_ATTSET, VAL_EXP1, {3,2,-1},
59 {PROTO_Z3950, CLASS_ATTSET, VAL_EXT1, {3,3,-1},
61 {PROTO_Z3950, CLASS_ATTSET, VAL_CCL1, {3,4,-1},
63 {PROTO_Z3950, CLASS_ATTSET, VAL_GILS, {3,5,-1},
65 {PROTO_Z3950, CLASS_ATTSET, VAL_GILS, {3,5,-1},
67 {PROTO_Z3950, CLASS_ATTSET, VAL_STAS, {3,6,-1},
69 {PROTO_Z3950, CLASS_ATTSET, VAL_COLLECT1, {3,7,-1},
70 "Collections-attset"},
71 {PROTO_Z3950, CLASS_ATTSET, VAL_CIMI1, {3,8,-1},
73 {PROTO_Z3950, CLASS_ATTSET, VAL_GEO, {3,9,-1},
76 {PROTO_Z3950, CLASS_ATTSET, VAL_ZBIG, {3,10,-1},
78 {PROTO_Z3950, CLASS_ATTSET, VAL_UTIL, {3,11,-1},
80 {PROTO_Z3950, CLASS_ATTSET, VAL_XD1, {3,12,-1},
82 {PROTO_Z3950, CLASS_ATTSET, VAL_ZTHES, {3,13,-1},
84 {PROTO_Z3950, CLASS_ATTSET, VAL_FIN1, {3,14,-1},
86 {PROTO_Z3950, CLASS_ATTSET, VAL_DAN1, {3,15,-1},
88 {PROTO_Z3950, CLASS_ATTSET, VAL_HOLDINGS, {3,16,-1},
90 {PROTO_Z3950, CLASS_ATTSET, VAL_USMARC, {3,17,-1},
92 {PROTO_Z3950, CLASS_ATTSET, VAL_BIB2, {3,18,-1},
94 {PROTO_Z3950, CLASS_ATTSET, VAL_ZEEREX, {3,19,-1},
96 #if 0 /* This is the spawn of Satan. Use Zthes-1 instead */
97 {PROTO_Z3950, CLASS_ATTSET, VAL_THESAURUS, {3,1000,81,1,-1},
100 {PROTO_Z3950, CLASS_ATTSET, VAL_IDXPATH, {3,1000,81,2,-1},
102 {PROTO_Z3950, CLASS_DIAGSET, VAL_BIB1, {4,1,-1},
104 {PROTO_Z3950, CLASS_DIAGSET, VAL_DIAG1, {4,2,-1},
106 {PROTO_Z3950, CLASS_DIAGSET, VAL_DIAG_ES, {4,3,-1},
108 {PROTO_Z3950, CLASS_DIAGSET, VAL_DIAG_GENERAL, {4,3,-1},
110 {PROTO_Z3950, CLASS_RECSYN, VAL_UNIMARC, {5,1,-1},
112 {PROTO_Z3950, CLASS_RECSYN, VAL_INTERMARC, {5,2,-1},
114 {PROTO_Z3950, CLASS_RECSYN, VAL_CCF, {5,3,-1},
116 {PROTO_Z3950, CLASS_RECSYN, VAL_USMARC, {5,10,-1},
118 {PROTO_Z3950, CLASS_RECSYN, VAL_UKMARC, {5,11,-1},
120 {PROTO_Z3950, CLASS_RECSYN, VAL_NORMARC, {5,12,-1},
122 {PROTO_Z3950, CLASS_RECSYN, VAL_LIBRISMARC, {5,13,-1},
124 {PROTO_Z3950, CLASS_RECSYN, VAL_DANMARC, {5,14,-1},
126 {PROTO_Z3950, CLASS_RECSYN, VAL_FINMARC, {5,15,-1},
128 {PROTO_Z3950, CLASS_RECSYN, VAL_MAB, {5,16,-1},
130 {PROTO_Z3950, CLASS_RECSYN, VAL_CANMARC, {5,17,-1},
132 {PROTO_Z3950, CLASS_RECSYN, VAL_SBN, {5,18,-1},
134 {PROTO_Z3950, CLASS_RECSYN, VAL_PICAMARC, {5,19,-1},
136 {PROTO_Z3950, CLASS_RECSYN, VAL_AUSMARC, {5,20,-1},
138 {PROTO_Z3950, CLASS_RECSYN, VAL_IBERMARC, {5,21,-1},
140 {PROTO_Z3950, CLASS_RECSYN, VAL_CATMARC, {5,22,-1},
142 {PROTO_Z3950, CLASS_RECSYN, VAL_MALMARC, {5,23,-1},
144 {PROTO_Z3950, CLASS_RECSYN, VAL_JPMARC, {5,24,-1},
146 {PROTO_Z3950, CLASS_RECSYN, VAL_SWEMARC, {5,25,-1},
148 {PROTO_Z3950, CLASS_RECSYN, VAL_SIGLEMARC, {5,26,-1},
150 {PROTO_Z3950, CLASS_RECSYN, VAL_ISDSMARC, {5,27,-1},
152 {PROTO_Z3950, CLASS_RECSYN, VAL_RUSMARC, {5,28,-1},
154 {PROTO_Z3950, CLASS_RECSYN, VAL_HUNMARC, {5,29,-1},
156 {PROTO_Z3950, CLASS_RECSYN, VAL_EXPLAIN, {5,100,-1},
158 {PROTO_Z3950, CLASS_RECSYN, VAL_SUTRS, {5,101,-1},
160 {PROTO_Z3950, CLASS_RECSYN, VAL_OPAC, {5,102,-1},
162 {PROTO_Z3950, CLASS_RECSYN, VAL_SUMMARY, {5,103,-1},
164 {PROTO_Z3950, CLASS_RECSYN, VAL_GRS0, {5,104,-1},
166 {PROTO_Z3950, CLASS_RECSYN, VAL_GRS1, {5,105,-1},
168 {PROTO_Z3950, CLASS_RECSYN, VAL_EXTENDED, {5,106,-1},
170 {PROTO_Z3950, CLASS_RECSYN, VAL_FRAGMENT, {5,107,-1},
172 {PROTO_Z3950, CLASS_RECSYN, VAL_PDF, {5,109,1,-1},
174 {PROTO_Z3950, CLASS_RECSYN, VAL_POSTSCRIPT, {5,109,2,-1},
176 {PROTO_Z3950, CLASS_RECSYN, VAL_HTML, {5,109,3,-1},
178 {PROTO_Z3950, CLASS_RECSYN, VAL_TIFF, {5,109,4,-1},
180 {PROTO_Z3950, CLASS_RECSYN, VAL_GIF, {5,109,5,-1},
182 {PROTO_Z3950, CLASS_RECSYN, VAL_JPEG, {5,109,6,-1},
184 {PROTO_Z3950, CLASS_RECSYN, VAL_PNG, {5,109,7,-1},
186 {PROTO_Z3950, CLASS_RECSYN, VAL_MPEG, {5,109,8,-1},
188 {PROTO_Z3950, CLASS_RECSYN, VAL_SGML, {5,109,9,-1},
191 {PROTO_Z3950, CLASS_RECSYN, VAL_TIFFB, {5,110,1,-1},
193 {PROTO_Z3950, CLASS_RECSYN, VAL_WAV, {5,110,2,-1},
196 {PROTO_Z3950, CLASS_RECSYN, VAL_SQLRS, {5,111,-1},
198 {PROTO_Z3950, CLASS_RECSYN, VAL_SOIF, {5,1000,81,2,-1},
200 {PROTO_Z3950, CLASS_RECSYN, VAL_TEXT_XML, {5,109,10,-1},
202 {PROTO_Z3950, CLASS_RECSYN, VAL_TEXT_XML, {5,109,10,-1},
204 {PROTO_Z3950, CLASS_RECSYN, VAL_APPLICATION_XML, {5,109,11,-1},
206 {PROTO_Z3950, CLASS_RESFORM, VAL_RESOURCE1, {7,1,-1},
208 {PROTO_Z3950, CLASS_RESFORM, VAL_RESOURCE2, {7,2,-1},
210 {PROTO_Z3950, CLASS_RESFORM, VAL_UNIVERSE_REPORT, {7,1000,81,1,-1},
211 "UNIverse-Resource-Report"},
213 {PROTO_Z3950, CLASS_ACCFORM, VAL_PROMPT1, {8,1,-1},
215 {PROTO_Z3950, CLASS_ACCFORM, VAL_DES1, {8,2,-1},
217 {PROTO_Z3950, CLASS_ACCFORM, VAL_KRB1, {8,3,-1},
219 {PROTO_Z3950, CLASS_EXTSERV, VAL_PRESSET, {9,1,-1},
221 {PROTO_Z3950, CLASS_EXTSERV, VAL_PQUERY, {9,2,-1},
223 {PROTO_Z3950, CLASS_EXTSERV, VAL_PCQUERY, {9,3,-1},
225 {PROTO_Z3950, CLASS_EXTSERV, VAL_ITEMORDER, {9,4,-1},
227 {PROTO_Z3950, CLASS_EXTSERV, VAL_DBUPDATE0, {9,5,-1},
228 "DB. Update (first version)"},
229 {PROTO_Z3950, CLASS_EXTSERV, VAL_DBUPDATE1, {9,5,1,-1},
230 "DB. Update (second version)"},
231 {PROTO_Z3950, CLASS_EXTSERV, VAL_DBUPDATE, {9,5,1,1,-1},
233 {PROTO_Z3950, CLASS_EXTSERV, VAL_EXPORTSPEC, {9,6,-1},
235 {PROTO_Z3950, CLASS_EXTSERV, VAL_EXPORTINV, {9,7,-1},
237 /* ### Next line should be {9,1000,81,1,-1} */
238 {PROTO_Z3950, CLASS_EXTSERV, VAL_ADMINSERVICE, {9,81,1,-1},
240 {PROTO_Z3950, CLASS_USERINFO,VAL_SEARCHRES1, {10,1,-1},
242 {PROTO_Z3950, CLASS_USERINFO,VAL_CHARLANG, {10,2,-1},
243 "CharSetandLanguageNegotiation"},
244 {PROTO_Z3950, CLASS_USERINFO,VAL_USERINFO1, {10,3,-1},
246 {PROTO_Z3950, CLASS_USERINFO,VAL_MULTISRCH1, {10,4,-1},
247 "MultipleSearchTerms-1"},
248 {PROTO_Z3950, CLASS_USERINFO,VAL_MULTISRCH2, {10,5,-1},
249 "MultipleSearchTerms-2"},
250 {PROTO_Z3950, CLASS_USERINFO,VAL_DATETIME, {10,6,-1},
252 {PROTO_Z3950, CLASS_USERINFO,VAL_PROXY, {10,1000,81,1,-1},
254 {PROTO_Z3950, CLASS_USERINFO,VAL_COOKIE, {10,1000,81,2,-1},
256 {PROTO_Z3950, CLASS_USERINFO,VAL_CLIENT_IP, {10,1000,81,3,-1},
258 {PROTO_Z3950, CLASS_ELEMSPEC,VAL_ESPEC1, {11,1,-1},
260 {PROTO_Z3950, CLASS_VARSET, VAL_VAR1, {12,1,-1},
262 {PROTO_Z3950, CLASS_SCHEMA, VAL_WAIS, {13,1,-1},
264 {PROTO_Z3950, CLASS_SCHEMA, VAL_GILS, {13,2,-1},
266 {PROTO_Z3950, CLASS_SCHEMA, VAL_COLLECT1, {13,3,-1},
267 "Collections-schema"},
268 {PROTO_Z3950, CLASS_SCHEMA, VAL_GEO, {13,4,-1},
270 {PROTO_Z3950, CLASS_SCHEMA, VAL_CIMI1, {13,5,-1},
272 {PROTO_Z3950, CLASS_SCHEMA, VAL_UPDATEES, {13,6,-1},
274 {PROTO_Z3950, CLASS_SCHEMA, VAL_HOLDINGS, {13,7,-1},
276 {PROTO_Z3950, CLASS_SCHEMA, VAL_ZTHES, {13,8,-1},
278 {PROTO_Z3950, CLASS_SCHEMA, VAL_THESAURUS, {13,1000,81,1,-1},
280 {PROTO_Z3950, CLASS_SCHEMA, VAL_EXPLAIN, {13,1000,81,2,-1},
282 {PROTO_Z3950, CLASS_TAGSET, VAL_SETM, {14,1,-1},
284 {PROTO_Z3950, CLASS_TAGSET, VAL_SETG, {14,2,-1},
286 {PROTO_Z3950, CLASS_TAGSET, VAL_STAS, {14,3,-1},
288 {PROTO_Z3950, CLASS_TAGSET, VAL_GILS, {14,4,-1},
290 {PROTO_Z3950, CLASS_TAGSET, VAL_COLLECT1, {14,5,-1},
291 "Collections-tagset"},
292 {PROTO_Z3950, CLASS_TAGSET, VAL_CIMI1, {14,6,-1},
294 {PROTO_Z3950, CLASS_TAGSET, VAL_THESAURUS, {14,1000,81,1,-1},
295 "thesaurus-tagset"}, /* What is this Satan-spawn doing here? */
296 {PROTO_Z3950, CLASS_TAGSET, VAL_EXPLAIN, {14,1000,81,2,-1},
298 {PROTO_Z3950, CLASS_TAGSET, VAL_ZTHES, {14,8,-1},
300 {PROTO_Z3950, CLASS_NEGOT, VAL_CHARNEG3, {15,3,-1},
301 "CharSetandLanguageNegotiation-3"},
302 {PROTO_Z3950, CLASS_USERINFO,VAL_CQL, {16, 2, -1},
304 {PROTO_GENERAL, CLASS_GENERAL, VAL_UCS2, {1,0,10646,1,0,2,-1},
306 {PROTO_GENERAL, CLASS_GENERAL, VAL_UCS4, {1,0,10646,1,0,4,-1},
308 {PROTO_GENERAL, CLASS_GENERAL, VAL_UTF16, {1,0,10646,1,0,5,-1},
310 {PROTO_GENERAL, CLASS_GENERAL, VAL_UTF8, {1,0,10646,1,0,8,-1},
312 {PROTO_Z3950, CLASS_USERINFO,VAL_OCLCUI, {10, 1000, 17, 1, -1},
314 {PROTO_NOP, CLASS_NOP, VAL_NOP, {-1}, 0 }
319 void oid_oidcpy(int *t, int *s)
321 while ((*(t++) = *(s++)) > -1);
324 void oid_oidcat(int *t, int *s)
328 while ((*(t++) = *(s++)) > -1);
331 int oid_oidcmp(int *o1, int *o2)
333 while (*o1 == *o2 && *o1 > -1)
346 int oid_oidlen(int *o)
356 static int match_prefix(int *look, int *prefix)
360 for (len = 0; *look == *prefix; look++, prefix++, len++);
361 if (*prefix < 0) /* did we reach the end of the prefix? */
366 void oid_transfer (struct oident *oidentp)
368 while (*oidentp->oidsuffix >= 0)
370 oid_addent (oidentp->oidsuffix, oidentp->proto,
372 oidentp->desc, oidentp->value);
379 if (oid_init_flag == 0)
381 /* oid_transfer is thread safe, so there's nothing wrong in having
382 two threads calling it simultaniously. On the other hand
383 no thread may exit oid_init before all OID's bave been
384 transferred - which is why checked is set after oid_transfer...
386 nmem_mutex_create (&oid_mutex);
387 nmem_mutex_enter (oid_mutex);
389 oid_nmem = nmem_create ();
390 nmem_mutex_leave (oid_mutex);
391 oid_transfer (standard_oids);
401 nmem_mutex_destroy (&oid_mutex);
402 nmem_destroy (oid_nmem);
407 static struct oident *oid_getentbyoid_x(int *o)
409 enum oid_proto proto;
411 struct oident_list *ol;
413 /* determine protocol type */
414 if ((prelen = match_prefix(o, z3950_prefix)) != 0)
416 else if ((prelen = match_prefix(o, sr_prefix)) != 0)
419 proto = PROTO_GENERAL;
420 for (ol = oident_table; ol; ol = ol->next)
422 struct oident *p = &ol->oident;
423 if (p->proto == proto && !oid_oidcmp(o + prelen, p->oidsuffix))
425 if (p->proto == PROTO_GENERAL && !oid_oidcmp (o, p->oidsuffix))
432 * To query, fill out proto, class, and value of the ent parameter.
434 int *oid_ent_to_oid(struct oident *ent, int *ret)
436 struct oident_list *ol;
439 for (ol = oident_table; ol; ol = ol->next)
441 struct oident *p = &ol->oident;
442 if (ent->value == p->value &&
443 (p->proto == PROTO_GENERAL || (ent->proto == p->proto &&
444 (ent->oclass == p->oclass || ent->oclass == CLASS_GENERAL))))
446 if (p->proto == PROTO_Z3950)
447 oid_oidcpy(ret, z3950_prefix);
448 else if (p->proto == PROTO_SR)
449 oid_oidcpy(ret, sr_prefix);
452 oid_oidcat(ret, p->oidsuffix);
462 * To query, fill out proto, class, and value of the ent parameter.
464 int *oid_getoidbyent(struct oident *ent)
466 static int ret[OID_SIZE];
468 return oid_ent_to_oid (ent, ret);
471 struct oident *oid_addent (int *oid, enum oid_proto proto,
472 enum oid_class oclass,
473 const char *desc, int value)
475 struct oident *oident = 0;
477 nmem_mutex_enter (oid_mutex);
481 struct oident_list *oident_list;
482 oident_list = (struct oident_list *)
483 nmem_malloc (oid_nmem, sizeof(*oident_list));
484 oident = &oident_list->oident;
485 oident->proto = proto;
486 oident->oclass = oclass;
492 sprintf (desc_str, "%d", *oid);
493 for (i = 1; i < 12 && oid[i] >= 0; i++)
494 sprintf (desc_str+strlen(desc_str), ".%d", oid[i]);
497 oident->desc = nmem_strdup (oid_nmem, desc);
498 if (value == VAL_DYNAMIC)
499 oident->value = (enum oid_value) (++oid_value_dynamic);
501 oident->value = (enum oid_value) value;
502 oid_oidcpy (oident->oidsuffix, oid);
503 oident_list->next = oident_table;
504 oident_table = oident_list;
506 nmem_mutex_leave (oid_mutex);
510 struct oident *oid_getentbyoid(int *oid)
512 struct oident *oident;
517 oident = oid_getentbyoid_x (oid);
519 oident = oid_addent (oid, PROTO_GENERAL, CLASS_GENERAL,
524 static oid_value oid_getval_raw(const char *name)
526 int val = 0, i = 0, oid[OID_SIZE];
527 struct oident *oident;
529 while (isdigit (*name))
531 val = val*10 + (*name - '0');
543 oident = oid_getentbyoid_x (oid);
545 oident = oid_addent (oid, PROTO_GENERAL, CLASS_GENERAL, NULL,
547 return oident->value;
550 oid_value oid_getvalbyname(const char *name)
552 struct oident_list *ol;
556 return oid_getval_raw (name);
557 for (ol = oident_table; ol; ol = ol->next)
558 if (!yaz_matchstr(ol->oident.desc, name))
560 return ol->oident.value;
565 void oid_setprivateoids(oident *list)
570 void oid_trav (void (*func)(struct oident *oidinfo, void *vp), void *vp)
572 struct oident_list *ol;
575 for (ol = oident_table; ol; ol = ol->next)
576 (*func)(&ol->oident, vp);
579 int *oid_name_to_oid(oid_class oclass, const char *name, int *oid) {
582 /* Translate syntax to oid_val */
583 oid_value value = oid_getvalbyname(name);
585 /* Build it into an oident */
586 ent.proto = PROTO_Z3950;
590 /* Translate to an array of int */
591 return oid_ent_to_oid(&ent, oid);
594 char *oid_to_dotstring(const int *oid, char *oidbuf) {
599 for (i = 0; oid[i] != -1; i++) {
600 sprintf(tmpbuf, "%d", oid[i]);
601 if (i > 0) strcat(oidbuf, ".");
602 strcat(oidbuf, tmpbuf);
608 char *oid_name_to_dotstring(oid_class oclass, const char *name, char *oidbuf) {
611 (void) oid_name_to_oid(oclass, name, oid);
612 return oid_to_dotstring(oid, oidbuf);