5432b0f5ad94d3cda292809b225a7233d9d1c360
[yaz-moved-to-github.git] / 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.24 2002-07-25 12:52:53 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 static Z_ElementData *nodetoelementdata(data1_handle dh, data1_node *n,
118                                         int select, int leaf,
119                                         ODR o, int *len)
120 {
121     Z_ElementData *res = (Z_ElementData *)odr_malloc(o, sizeof(*res));
122
123     if (!n)
124     {
125         res->which = Z_ElementData_elementNotThere;
126         res->u.elementNotThere = odr_nullval();
127     }
128     else if (n->which == DATA1N_data && leaf)
129     {
130         char str[512];
131         int toget;
132         data1_node *p;
133
134         for (p = n->parent; p && p->which != DATA1N_tag; p = p->parent)
135             ;
136
137         switch (n->u.data.what)
138         {
139         case DATA1I_num:
140             res->which = Z_ElementData_numeric;
141             res->u.numeric = (int *)odr_malloc(o, sizeof(int));
142             *res->u.numeric = atoi(n->u.data.data);
143             *len += 4;
144             break;
145         case DATA1I_text:
146             toget = n->u.data.len;
147             res->which = Z_ElementData_string;
148             res->u.string = (char *)odr_malloc(o, toget+1);
149             memcpy(res->u.string, n->u.data.data, toget);
150             res->u.string[toget] = '\0';
151             *len += toget;
152             break;
153         case DATA1I_oid:
154             res->which = Z_ElementData_oid;
155             strncpy(str, n->u.data.data, n->u.data.len);
156             str[n->u.data.len] = '\0';
157             res->u.oid = odr_getoidbystr(o, str);
158             *len += n->u.data.len;
159             break;
160         default:
161             yaz_log(LOG_WARN, "Can't handle datatype.");
162             return 0;
163         }
164     }
165     else
166     {
167         res->which = Z_ElementData_subtree;
168         if (!(res->u.subtree = data1_nodetogr (dh, n->parent, select, o, len)))
169             return 0;
170     }
171     return res;
172 }
173
174 static int is_empty_data (data1_node *n)
175 {
176     if (n && n->which == DATA1N_data && n->u.data.what == DATA1I_text)
177     {
178         int i = n->u.data.len;
179         
180         while (i > 0 && n->u.data.data[i-1] == '\n')
181             i--;
182         if (i == 0)
183             return 1;
184     }
185     return 0;
186 }
187
188
189 static Z_TaggedElement *nodetotaggedelement(data1_handle dh, data1_node *n,
190                                             int select, ODR o,
191                                             int *len)
192 {
193     Z_TaggedElement *res = (Z_TaggedElement *)odr_malloc(o, sizeof(*res));
194     data1_tag *tag = 0;
195     data1_node *data;
196     int leaf = 0;
197
198     if (n->which == DATA1N_tag)
199     {
200         if (n->u.tag.element)
201             tag = n->u.tag.element->tag;
202         data = n->child;
203
204         /* skip empty data children */
205         while (is_empty_data(data))
206             data = data->next;
207         if (!data)
208             data = n->child;
209         else
210         {   /* got one. see if this is the only non-empty one */
211             data1_node *sub = data->next;
212             while (sub && is_empty_data(sub))
213                 sub = sub->next;
214             if (!sub)
215                 leaf = 1;  /* all empty. 'data' is the only child */
216         }
217     }
218     /*
219      * If we're a data element at this point, we need to insert a
220      * wellKnown tag to wrap us up.
221      */
222     else if (n->which == DATA1N_data || n->which == DATA1N_variant)
223     {
224         if (n->root->u.root.absyn &&
225             !(tag = data1_gettagbyname (dh, n->root->u.root.absyn->tagset,
226                                         "wellKnown")))
227         {
228             yaz_log(LOG_WARN, "Unable to locate tag for 'wellKnown'");
229             return 0;
230         }
231         data = n;
232         leaf = 1;
233         if (is_empty_data(data))
234             return 0;
235     }
236     else
237     {
238         yaz_log(LOG_WARN, "Bad data.");
239         return 0;
240     }
241
242     res->tagType = (int *)odr_malloc(o, sizeof(int));
243     *res->tagType = (tag && tag->tagset) ? tag->tagset->type : 3;
244     res->tagValue = (Z_StringOrNumeric *)odr_malloc(o, sizeof(Z_StringOrNumeric));
245     if (tag && tag->which == DATA1T_numeric)
246     {
247         res->tagValue->which = Z_StringOrNumeric_numeric;
248         res->tagValue->u.numeric = (int *)odr_malloc(o, sizeof(int));
249         *res->tagValue->u.numeric = tag->value.numeric;
250     }
251     else
252     {
253         char *tagstr;
254
255         if (n->which == DATA1N_tag)      
256             tagstr = n->u.tag.tag;       /* tag at node */
257         else if (tag)                    
258             tagstr = tag->value.string;  /* no take from well-known */
259         else
260             return 0;
261         res->tagValue->which = Z_StringOrNumeric_string;
262         res->tagValue->u.string = odr_strdup(o, tagstr);
263     }
264     res->tagOccurrence = 0;
265     res->appliedVariant = 0;
266     res->metaData = 0;
267     if (n->which == DATA1N_variant || (data && data->which ==
268         DATA1N_variant && data->next == NULL))
269     {
270         int nvars = 0;
271
272         res->metaData = get_ElementMetaData(o);
273         if (n->which == DATA1N_tag && n->u.tag.make_variantlist)
274             if (traverse_triples(data, 0, res->metaData, o) < 0)
275                 return 0;
276         while (data && data->which == DATA1N_variant)
277         {
278             nvars++;
279             data = data->child;
280         }
281         if (n->which != DATA1N_tag || !n->u.tag.no_data_requested)
282             res->appliedVariant = make_variant(data->parent, nvars-1, o);
283     }
284     if (n->which == DATA1N_tag && n->u.tag.no_data_requested)
285     {
286         res->content = (Z_ElementData *)odr_malloc(o, sizeof(*res->content));
287         res->content->which = Z_ElementData_noDataRequested;
288         res->content->u.noDataRequested = odr_nullval();
289     }
290     else if (!(res->content = nodetoelementdata (dh, data, select, leaf,
291                                                  o, len)))
292         return 0;
293     *len += 10;
294     return res;
295 }
296
297 Z_GenericRecord *data1_nodetogr(data1_handle dh, data1_node *n,
298                                 int select, ODR o, int *len)
299 {
300     Z_GenericRecord *res = (Z_GenericRecord *)odr_malloc(o, sizeof(*res));
301     data1_node *c;
302     int num_children = 0;
303
304     if (n->which == DATA1N_root)
305         n = data1_get_root_tag (dh, n);
306         
307     for (c = n->child; c; c = c->next)
308         num_children++;
309
310     res->elements = (Z_TaggedElement **)
311         odr_malloc(o, sizeof(Z_TaggedElement *) * num_children);
312     res->num_elements = 0;
313     for (c = n->child; c; c = c->next)
314     {
315         if (c->which == DATA1N_tag && select && !c->u.tag.node_selected)
316             continue;
317         if ((res->elements[res->num_elements] =
318              nodetotaggedelement (dh, c, select, o, len)))
319             res->num_elements++;
320     }
321     return res;
322 }