retrieval/d1_grs.c

   1 /*
   2  * Copyright (c) 1995-1997, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Log: d1_grs.c,v $
   7  * Revision 1.13  1998-02-11 11:53:35  adam
   8  * Changed code so that it compiles as C++.
   9  *
  10  * Revision 1.12  1997/11/24 11:33:56  adam
  11  * Using function odr_nullval() instead of global ODR_NULLVAL when
  12  * appropriate.
  13  *
  14  * Revision 1.11  1997/11/18 09:51:09  adam
  15  * Removed element num_children from data1_node. Minor changes in
  16  * data1 to Explain.
  17  *
  18  * Revision 1.10  1997/09/17 12:10:36  adam
  19  * YAZ version 1.4.
  20  *
  21  * Revision 1.9  1997/05/14 06:54:03  adam
  22  * C++ support.
  23  *
  24  * Revision 1.8  1996/12/05 13:17:49  quinn
  25  * Fixed GRS-1 null-ref
  26  *
  27  * Revision 1.7  1996/10/11  11:57:23  quinn
  28  * Smallish
  29  *
  30  * Revision 1.6  1996/07/06  19:58:34  quinn
  31  * System headerfiles gathered in yconfig
  32  *
  33  * Revision 1.5  1996/06/03  09:46:42  quinn
  34  * Added OID data type.
  35  *
  36  * Revision 1.4  1996/05/01  12:45:30  quinn
  37  * Support use of local tag names in abs file.
  38  *
  39  * Revision 1.3  1995/11/13  09:27:35  quinn
  40  * Fiddling with the variant stuff.
  41  *
  42  * Revision 1.2  1995/11/01  13:54:46  quinn
  43  * Minor adjustments
  44  *
  45  * Revision 1.1  1995/11/01  11:56:07  quinn
  46  * Added Retrieval (data management) functions en masse.
  47  *
  48  *
  49  */
  50
  51 #include <assert.h>
  52 #include <stdlib.h>
  53
  54 #include <proto.h>
  55 #include <log.h>
  56
  57 #include <data1.h>
  58
  59 #define D1_VARIANTARRAY 20 /* fixed max length on sup'd variant-list. Lazy me */
  60
  61 static Z_ElementMetaData *get_ElementMetaData(ODR o)
  62 {
  63     Z_ElementMetaData *r = (Z_ElementMetaData *)odr_malloc(o, sizeof(*r));
  64
  65     r->seriesOrder = 0;
  66     r->usageRight = 0;
  67     r->num_hits = 0;
  68     r->hits = 0;
  69     r->displayName = 0;
  70     r->num_supportedVariants = 0;
  71     r->supportedVariants = 0;
  72     r->message = 0;
  73     r->elementDescriptor = 0;
  74     r->surrogateFor = 0;
  75     r->surrogateElement = 0;
  76     r->other = 0;
  77
  78     return r;
  79 }
  80
  81 /*
  82  * N should point to the *last* (leaf) triple in a sequence. Construct a variant
  83  * from each of the triples beginning (ending) with 'n', up to the
  84  * nearest parent tag. num should equal the number of triples in the
  85  * sequence.
  86  */
  87 static Z_Variant *make_variant(data1_node *n, int num, ODR o)
  88 {
  89     Z_Variant *v = (Z_Variant *)odr_malloc(o, sizeof(*v));
  90     data1_node *p;
  91
  92     v->globalVariantSetId = 0;
  93     v->num_triples = num;
  94     v->triples = (Z_Triple **)odr_malloc(o, sizeof(Z_Triple*) * num);
  95
  96     /*
  97      * cycle back up through the tree of variants
  98      * (traversing exactly 'level' variants).
  99      */
 100     for (p = n, num--; p && num >= 0; p = p->parent, num--)
 101     {
 102         Z_Triple *t;
 103
 104         assert(p->which == DATA1N_variant);
 105         t = v->triples[num] = (Z_Triple *)odr_malloc(o, sizeof(*t));
 106         t->variantSetId = 0;
 107         t->zclass = (int *)odr_malloc(o, sizeof(int));
 108         *t->zclass = p->u.variant.type->zclass->zclass;
 109         t->type = (int *)odr_malloc(o, sizeof(int));
 110         *t->type = p->u.variant.type->type;
 111
 112         switch (p->u.variant.type->datatype)
 113         {
 114             case DATA1K_string:
 115                 t->which = Z_Triple_internationalString;
 116                 t->value.internationalString = (char *)odr_malloc(o,
 117                     strlen(p->u.variant.value)+1);
 118                 strcpy(t->value.internationalString, p->u.variant.value);
 119                 break;
 120             default:
 121                 logf(LOG_WARN, "Unable to handle value for variant %s",
 122                     p->u.variant.type->name);
 123                 return 0;
 124         }
 125     }
 126     return v;
 127 }
 128
 129 /*
 130  * Traverse the variant children of n, constructing a supportedVariant list.
 131  */
 132 static int traverse_triples(data1_node *n, int level, Z_ElementMetaData *m,
 133     ODR o)
 134 {
 135     data1_node *c;
 136
 137     for (c = n->child; c; c = c->next)
 138         if (c->which == DATA1N_data && level)
 139         {
 140             if (!m->supportedVariants)
 141                 m->supportedVariants = (Z_Variant **)odr_malloc(o, sizeof(Z_Variant*) *
 142                     D1_VARIANTARRAY);
 143             else if (m->num_supportedVariants >= D1_VARIANTARRAY)
 144             {
 145                 logf(LOG_WARN, "Too many variants (D1_VARIANTARRAY==%d)",
 146                     D1_VARIANTARRAY);
 147                 return -1;
 148             }
 149
 150             if (!(m->supportedVariants[m->num_supportedVariants++] =
 151                 make_variant(n, level, o)))
 152                 return -1;
 153         }
 154         else if (c->which == DATA1N_variant)
 155             if (traverse_triples(c, level+1, m, o) < 0)
 156                 return -1;
 157     return 0;
 158 }
 159
 160 static Z_ElementData *nodetoelementdata(data1_handle dh, data1_node *n,
 161                                         int select, int leaf,
 162                                         ODR o, int *len)
 163 {
 164     Z_ElementData *res = (Z_ElementData *)odr_malloc(o, sizeof(*res));
 165
 166     if (!n)
 167     {
 168         res->which = Z_ElementData_elementNotThere;
 169         res->u.elementNotThere = odr_nullval();
 170     }
 171     else if (n->which == DATA1N_data && (leaf || n->next == NULL))
 172     {
 173         char str[512];
 174         int toget;
 175         data1_node *p;
 176
 177         for (p = n->parent; p && p->which != DATA1N_tag; p = p->parent)
 178             ;
 179
 180         switch (n->u.data.what)
 181         {
 182             case DATA1I_num:
 183                 res->which = Z_ElementData_numeric;
 184                 res->u.numeric = (int *)odr_malloc(o, sizeof(int));
 185                 *res->u.numeric = atoi(n->u.data.data);
 186                 *len += 4;
 187                 break;
 188             case DATA1I_text:
 189                 toget = n->u.data.len;
 190                 if (p->u.tag.get_bytes > 0 && p->u.tag.get_bytes < toget)
 191                     toget = p->u.tag.get_bytes;
 192                 res->which = Z_ElementData_string;
 193                 res->u.string = (char *)odr_malloc(o, toget+1);
 194                 memcpy(res->u.string, n->u.data.data, toget);
 195                 res->u.string[toget] = '\0';
 196                 *len += toget;
 197                 break;
 198             case DATA1I_oid:
 199                 res->which = Z_ElementData_oid;
 200                 strncpy(str, n->u.data.data, n->u.data.len);
 201                 str[n->u.data.len] = '\0';
 202                 res->u.oid = odr_getoidbystr(o, str);
 203                 *len += n->u.data.len;
 204                 break;
 205             default:
 206                 logf(LOG_WARN, "Can't handle datatype.");
 207                 return 0;
 208         }
 209     }
 210     else
 211     {
 212         res->which = Z_ElementData_subtree;
 213         if (!(res->u.subtree = data1_nodetogr (dh, n->parent, select, o, len)))
 214             return 0;
 215     }
 216     return res;
 217 }
 218
 219 static Z_TaggedElement *nodetotaggedelement(data1_handle dh, data1_node *n,
 220                                             int select, ODR o,
 221                                             int *len)
 222 {
 223     Z_TaggedElement *res = (Z_TaggedElement *)odr_malloc(o, sizeof(*res));
 224     data1_tag *tag = 0;
 225     data1_node *data;
 226     int leaf;
 227
 228     if (n->which == DATA1N_tag)
 229     {
 230         if (n->u.tag.element)
 231             tag = n->u.tag.element->tag;
 232         data = n->child;
 233         leaf = 0;
 234     }
 235     /*
 236      * If we're a data element at this point, we need to insert a
 237      * wellKnown tag to wrap us up.
 238      */
 239     else if (n->which == DATA1N_data || n->which == DATA1N_variant)
 240     {
 241         if (!(tag = data1_gettagbyname (dh, n->root->u.root.absyn->tagset,
 242                                         "wellKnown")))
 243         {
 244             logf(LOG_WARN, "Unable to locate tag for 'wellKnown'");
 245             return 0;
 246         }
 247         data = n;
 248         leaf = 1;
 249     }
 250     else
 251     {
 252         logf(LOG_WARN, "Bad data.");
 253         return 0;
 254     }
 255
 256     res->tagType = (int *)odr_malloc(o, sizeof(int));
 257     *res->tagType = (tag && tag->tagset) ? tag->tagset->type : 3;
 258     res->tagValue = (Z_StringOrNumeric *)odr_malloc(o, sizeof(Z_StringOrNumeric));
 259     if (tag && tag->which == DATA1T_numeric)
 260     {
 261         res->tagValue->which = Z_StringOrNumeric_numeric;
 262         res->tagValue->u.numeric = (int *)odr_malloc(o, sizeof(int));
 263         *res->tagValue->u.numeric = tag->value.numeric;
 264     }
 265     else
 266     {
 267         char *tagstr;
 268
 269         if (tag) /* well-known tag */
 270             tagstr = tag->value.string;
 271         else /* tag local to this file */
 272             tagstr = n->u.tag.tag;
 273
 274         res->tagValue->which = Z_StringOrNumeric_string;
 275         res->tagValue->u.string = (char *)odr_malloc(o, strlen(tagstr)+1);
 276         strcpy(res->tagValue->u.string, tagstr);
 277     }
 278     res->tagOccurrence = 0;
 279     res->appliedVariant = 0;
 280     res->metaData = 0;
 281     if (n->which == DATA1N_variant || (data && data->which ==
 282         DATA1N_variant && data->next == NULL))
 283     {
 284         int nvars = 0;
 285
 286         res->metaData = get_ElementMetaData(o);
 287         if (n->which == DATA1N_tag && n->u.tag.make_variantlist)
 288             if (traverse_triples(data, 0, res->metaData, o) < 0)
 289                 return 0;
 290         while (data && data->which == DATA1N_variant)
 291         {
 292             nvars++;
 293             data = data->child;
 294         }
 295         if (n->which != DATA1N_tag || !n->u.tag.no_data_requested)
 296             res->appliedVariant = make_variant(data->parent, nvars-1, o);
 297     }
 298     if (n->which == DATA1N_tag && n->u.tag.no_data_requested)
 299     {
 300         res->content = (Z_ElementData *)odr_malloc(o, sizeof(*res->content));
 301         res->content->which = Z_ElementData_noDataRequested;
 302         res->content->u.noDataRequested = odr_nullval();
 303     }
 304     else if (!(res->content = nodetoelementdata (dh, data, select, leaf,
 305                                                  o, len)))
 306         return 0;
 307     *len += 10;
 308     return res;
 309 }
 310
 311 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 312                                 int select, ODR o, int *len)
 313 {
 314     Z_GenericRecord *res = (Z_GenericRecord *)odr_malloc(o, sizeof(*res));
 315     data1_node *c;
 316     int num_children = 0;
 317
 318     for (c = n->child; c; c = c->next)
 319         num_children++;
 320
 321     res->elements = (Z_TaggedElement **)odr_malloc(o, sizeof(Z_TaggedElement *) * num_children);
 322     res->num_elements = 0;
 323     for (c = n->child; c; c = c->next)
 324     {
 325         if (c->which == DATA1N_tag && select && !c->u.tag.node_selected)
 326             continue;
 327         if (!(res->elements[res->num_elements++] =
 328               nodetotaggedelement (dh, c, select, o, len)))
 329             return 0;
 330     }
 331     return res;
 332 }