retrieval/d1_grs.c

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