retrieval/d1_grs.c

   1 /*
   2  * Copyright (c) 1995-2002, Index Data.
   3  * See the file LICENSE for details.
   4  * Sebastian Hammer, Adam Dickmeiss
   5  *
   6  * $Id: d1_grs.c,v 1.26 2002-10-08 22:18:22 adam Exp $
   7  *
   8  */
   9
  10 #include <assert.h>
  11 #include <stdlib.h>
  12
  13 #include <yaz/proto.h>
  14 #include <yaz/log.h>
  15 #include <yaz/data1.h>
  16
  17 #define D1_VARIANTARRAY 20 /* fixed max length on sup'd variant-list. Lazy me */
  18
  19 static Z_ElementMetaData *get_ElementMetaData(ODR o)
  20 {
  21     Z_ElementMetaData *r = (Z_ElementMetaData *)odr_malloc(o, sizeof(*r));
  22
  23     r->seriesOrder = 0;
  24     r->usageRight = 0;
  25     r->num_hits = 0;
  26     r->hits = 0;
  27     r->displayName = 0;
  28     r->num_supportedVariants = 0;
  29     r->supportedVariants = 0;
  30     r->message = 0;
  31     r->elementDescriptor = 0;
  32     r->surrogateFor = 0;
  33     r->surrogateElement = 0;
  34     r->other = 0;
  35
  36     return r;
  37 }
  38
  39 /*
  40  * N should point to the *last* (leaf) triple in a sequence. Construct a variant
  41  * from each of the triples beginning (ending) with 'n', up to the
  42  * nearest parent tag. num should equal the number of triples in the
  43  * sequence.
  44  */
  45 static Z_Variant *make_variant(data1_node *n, int num, ODR o)
  46 {
  47     Z_Variant *v = (Z_Variant *)odr_malloc(o, sizeof(*v));
  48     data1_node *p;
  49
  50     v->globalVariantSetId = 0;
  51     v->num_triples = num;
  52     v->triples = (Z_Triple **)odr_malloc(o, sizeof(Z_Triple*) * num);
  53
  54     /*
  55      * cycle back up through the tree of variants
  56      * (traversing exactly 'level' variants).
  57      */
  58     for (p = n, num--; p && num >= 0; p = p->parent, num--)
  59     {
  60         Z_Triple *t;
  61
  62         assert(p->which == DATA1N_variant);
  63         t = v->triples[num] = (Z_Triple *)odr_malloc(o, sizeof(*t));
  64         t->variantSetId = 0;
  65         t->zclass = (int *)odr_malloc(o, sizeof(int));
  66         *t->zclass = p->u.variant.type->zclass->zclass;
  67         t->type = (int *)odr_malloc(o, sizeof(int));
  68         *t->type = p->u.variant.type->type;
  69
  70         switch (p->u.variant.type->datatype)
  71         {
  72             case DATA1K_string:
  73                 t->which = Z_Triple_internationalString;
  74                 t->value.internationalString =
  75                     odr_strdup(o, p->u.variant.value);
  76                 break;
  77             default:
  78                 yaz_log(LOG_WARN, "Unable to handle value for variant %s",
  79                         p->u.variant.type->name);
  80                 return 0;
  81         }
  82     }
  83     return v;
  84 }
  85
  86 /*
  87  * Traverse the variant children of n, constructing a supportedVariant list.
  88  */
  89 static int traverse_triples(data1_node *n, int level, Z_ElementMetaData *m,
  90     ODR o)
  91 {
  92     data1_node *c;
  93
  94     for (c = n->child; c; c = c->next)
  95         if (c->which == DATA1N_data && level)
  96         {
  97             if (!m->supportedVariants)
  98                 m->supportedVariants = (Z_Variant **)odr_malloc(o, sizeof(Z_Variant*) *
  99                     D1_VARIANTARRAY);
 100             else if (m->num_supportedVariants >= D1_VARIANTARRAY)
 101             {
 102                 yaz_log(LOG_WARN, "Too many variants (D1_VARIANTARRAY==%d)",
 103                         D1_VARIANTARRAY);
 104                 return -1;
 105             }
 106
 107             if (!(m->supportedVariants[m->num_supportedVariants++] =
 108                 make_variant(n, level, o)))
 109                 return -1;
 110         }
 111         else if (c->which == DATA1N_variant)
 112             if (traverse_triples(c, level+1, m, o) < 0)
 113                 return -1;
 114     return 0;
 115 }
 116
 117 /*
 118  * Locate some data under this node. This routine should handle variants
 119  * prettily.
 120  */
 121 static char *get_data(data1_node *n, int *len)
 122 {
 123     char *r;
 124     data1_node *np = 0;
 125
 126     while (n)
 127     {
 128         if (n->which == DATA1N_data)
 129         {
 130             int i;
 131             *len = n->u.data.len;
 132
 133             for (i = 0; i<*len; i++)
 134                 if (!d1_isspace(n->u.data.data[i]))
 135                     break;
 136             while (*len && d1_isspace(n->u.data.data[*len - 1]))
 137                 (*len)--;
 138             *len = *len - i;
 139             if (*len > 0)
 140                 return n->u.data.data + i;
 141         }
 142         if (n->which == DATA1N_tag)
 143             np = n->child;
 144         n = n->next;
 145         if (!n)
 146         {
 147             n = np;
 148             np = 0;
 149         }
 150     }
 151     r = "";
 152     *len = strlen(r);
 153     return r;
 154 }
 155
 156 static Z_ElementData *nodetoelementdata(data1_handle dh, data1_node *n,
 157                                         int select, int leaf,
 158                                         ODR o, int *len)
 159 {
 160     Z_ElementData *res = (Z_ElementData *)odr_malloc(o, sizeof(*res));
 161
 162     if (!n)
 163     {
 164         res->which = Z_ElementData_elementNotThere;
 165         res->u.elementNotThere = odr_nullval();
 166     }
 167     else if (n->which == DATA1N_data && leaf)
 168     {
 169         char str[64], *cp;
 170         int toget = n->u.data.len;
 171
 172         cp = get_data (n, &toget);
 173
 174         switch (n->u.data.what)
 175         {
 176         case DATA1I_num:
 177             res->which = Z_ElementData_numeric;
 178             res->u.numeric = (int *)odr_malloc(o, sizeof(int));
 179             *res->u.numeric = atoi_n (cp, toget);
 180             *len += 4;
 181             break;
 182         case DATA1I_text:
 183         case DATA1I_xmltext:
 184             res->which = Z_ElementData_string;
 185             res->u.string = (char *)odr_malloc(o, toget+1);
 186             if (toget)
 187                 memcpy(res->u.string, cp, toget);
 188             res->u.string[toget] = '\0';
 189             *len += toget;
 190             break;
 191         case DATA1I_oid:
 192             res->which = Z_ElementData_oid;
 193             if (toget > 63)
 194                 toget = 63;
 195             memcpy (str, cp, toget);
 196             str[toget] = '\0';
 197             res->u.oid = odr_getoidbystr(o, str);
 198             *len += oid_oidlen(res->u.oid) * sizeof(int);
 199             break;
 200         default:
 201             yaz_log(LOG_WARN, "Can't handle datatype.");
 202             return 0;
 203         }
 204     }
 205     else
 206     {
 207         res->which = Z_ElementData_subtree;
 208         if (!(res->u.subtree = data1_nodetogr (dh, n->parent, select, o, len)))
 209             return 0;
 210     }
 211     return res;
 212 }
 213
 214 static int is_empty_data (data1_node *n)
 215 {
 216     if (n && n->which == DATA1N_data && (n->u.data.what == DATA1I_text
 217                                 || n->u.data.what == DATA1I_xmltext))
 218     {
 219         int i = n->u.data.len;
 220
 221         while (i > 0 && strchr("\n ", n->u.data.data[i-1]))
 222             i--;
 223         if (i == 0)
 224             return 1;
 225     }
 226     return 0;
 227 }
 228
 229
 230 static Z_TaggedElement *nodetotaggedelement(data1_handle dh, data1_node *n,
 231                                             int select, ODR o,
 232                                             int *len)
 233 {
 234     Z_TaggedElement *res = (Z_TaggedElement *)odr_malloc(o, sizeof(*res));
 235     data1_tag *tag = 0;
 236     data1_node *data;
 237     int leaf = 0;
 238
 239     if (n->which == DATA1N_tag)
 240     {
 241         if (n->u.tag.element)
 242             tag = n->u.tag.element->tag;
 243         data = n->child;
 244
 245         /* skip empty data children */
 246         while (is_empty_data(data))
 247             data = data->next;
 248         if (!data)
 249             data = n->child;
 250         else
 251         {   /* got one. see if this is the only non-empty one */
 252             data1_node *sub = data->next;
 253             while (sub && is_empty_data(sub))
 254                 sub = sub->next;
 255             if (!sub)
 256                 leaf = 1;  /* all empty. 'data' is the only child */
 257         }
 258     }
 259     /*
 260      * If we're a data element at this point, we need to insert a
 261      * wellKnown tag to wrap us up.
 262      */
 263     else if (n->which == DATA1N_data || n->which == DATA1N_variant)
 264     {
 265         if (n->root->u.root.absyn &&
 266             !(tag = data1_gettagbyname (dh, n->root->u.root.absyn->tagset,
 267                                         "wellKnown")))
 268         {
 269             yaz_log(LOG_WARN, "Unable to locate tag for 'wellKnown'");
 270             return 0;
 271         }
 272         data = n;
 273         leaf = 1;
 274         if (is_empty_data(data))
 275             return 0;
 276     }
 277     else
 278     {
 279         yaz_log(LOG_WARN, "Bad data.");
 280         return 0;
 281     }
 282
 283     res->tagType = (int *)odr_malloc(o, sizeof(int));
 284     *res->tagType = (tag && tag->tagset) ? tag->tagset->type : 3;
 285     res->tagValue = (Z_StringOrNumeric *)odr_malloc(o, sizeof(Z_StringOrNumeric));
 286     if (tag && tag->which == DATA1T_numeric)
 287     {
 288         res->tagValue->which = Z_StringOrNumeric_numeric;
 289         res->tagValue->u.numeric = (int *)odr_malloc(o, sizeof(int));
 290         *res->tagValue->u.numeric = tag->value.numeric;
 291     }
 292     else
 293     {
 294         char *tagstr;
 295
 296         if (n->which == DATA1N_tag)
 297             tagstr = n->u.tag.tag;       /* tag at node */
 298         else if (tag)
 299             tagstr = tag->value.string;  /* no take from well-known */
 300         else
 301             return 0;
 302         res->tagValue->which = Z_StringOrNumeric_string;
 303         res->tagValue->u.string = odr_strdup(o, tagstr);
 304     }
 305     res->tagOccurrence = 0;
 306     res->appliedVariant = 0;
 307     res->metaData = 0;
 308     if (n->which == DATA1N_variant || (data && data->which ==
 309         DATA1N_variant && data->next == NULL))
 310     {
 311         int nvars = 0;
 312
 313         res->metaData = get_ElementMetaData(o);
 314         if (n->which == DATA1N_tag && n->u.tag.make_variantlist)
 315             if (traverse_triples(data, 0, res->metaData, o) < 0)
 316                 return 0;
 317         while (data && data->which == DATA1N_variant)
 318         {
 319             nvars++;
 320             data = data->child;
 321         }
 322         if (n->which != DATA1N_tag || !n->u.tag.no_data_requested)
 323             res->appliedVariant = make_variant(data->parent, nvars-1, o);
 324     }
 325     if (n->which == DATA1N_tag && n->u.tag.no_data_requested)
 326     {
 327         res->content = (Z_ElementData *)odr_malloc(o, sizeof(*res->content));
 328         res->content->which = Z_ElementData_noDataRequested;
 329         res->content->u.noDataRequested = odr_nullval();
 330     }
 331     else if (!(res->content = nodetoelementdata (dh, data, select, leaf,
 332                                                  o, len)))
 333         return 0;
 334     *len += 10;
 335     return res;
 336 }
 337
 338 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
 339                                 int select, ODR o, int *len)
 340 {
 341     Z_GenericRecord *res = (Z_GenericRecord *)odr_malloc(o, sizeof(*res));
 342     data1_node *c;
 343     int num_children = 0;
 344
 345     if (n->which == DATA1N_root)
 346         n = data1_get_root_tag (dh, n);
 347
 348     for (c = n->child; c; c = c->next)
 349         num_children++;
 350
 351     res->elements = (Z_TaggedElement **)
 352         odr_malloc(o, sizeof(Z_TaggedElement *) * num_children);
 353     res->num_elements = 0;
 354     for (c = n->child; c; c = c->next)
 355     {
 356         if (c->which == DATA1N_tag && select && !c->u.tag.node_selected)
 357             continue;
 358         if ((res->elements[res->num_elements] =
 359              nodetotaggedelement (dh, c, select, o, len)))
 360             res->num_elements++;
 361     }
 362     return res;
 363 }