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