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