retrieval/d1_read.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_read.c,v $
   7  * Revision 1.17  1997-11-05 09:20:51  adam
   8  * Minor change.
   9  *
  10  * Revision 1.16  1997/09/17 12:10:37  adam
  11  * YAZ version 1.4.
  12  *
  13  * Revision 1.15  1997/09/05 09:50:57  adam
  14  * Removed global data1_tabpath - uses data1_get_tabpath() instead.
  15  *
  16  * Revision 1.14  1997/05/14 06:54:04  adam
  17  * C++ support.
  18  *
  19  * Revision 1.13  1996/10/29 13:35:38  adam
  20  * Implemented data1_set_tabpath and data1_get_tabpath.
  21  *
  22  * Revision 1.12  1996/10/11 10:35:38  adam
  23  * Fixed a bug that caused data1_read_node to core dump when no abstract
  24  * syntax was defined in a "sgml"-record.
  25  *
  26  * Revision 1.11  1996/07/06 19:58:35  quinn
  27  * System headerfiles gathered in yconfig
  28  *
  29  * Revision 1.10  1996/01/19  15:41:47  quinn
  30  * Fixed uninitialized boolean.
  31  *
  32  * Revision 1.9  1996/01/17  14:52:47  adam
  33  * Changed prototype for reader function parsed to data1_read_record.
  34  *
  35  * Revision 1.8  1995/12/15  16:20:41  quinn
  36  * Added formatted text.
  37  *
  38  * Revision 1.7  1995/12/13  13:44:32  quinn
  39  * Modified Data1-system to use nmem
  40  *
  41  * Revision 1.6  1995/12/12  16:37:08  quinn
  42  * Added destroy element to data1_node.
  43  *
  44  * Revision 1.5  1995/12/11  15:22:37  quinn
  45  * Added last_child field to the node.
  46  * Rewrote schema-mapping.
  47  *
  48  * Revision 1.4  1995/11/13  09:27:36  quinn
  49  * Fiddling with the variant stuff.
  50  *
  51  * Revision 1.3  1995/11/01  16:34:57  quinn
  52  * Making data1 look for tables in data1_tabpath
  53  *
  54  * Revision 1.2  1995/11/01  13:54:48  quinn
  55  * Minor adjustments
  56  *
  57  * Revision 1.1  1995/11/01  11:56:09  quinn
  58  * Added Retrieval (data management) functions en masse.
  59  *
  60  * Revision 1.14  1995/10/30  12:40:55  quinn
  61  * Fixed a couple of bugs.
  62  *
  63  * Revision 1.13  1995/10/25  16:00:47  quinn
  64  * USMARC support is now almost operational
  65  *
  66  * Revision 1.12  1995/10/16  14:02:55  quinn
  67  * Changes to support element set names and espec1
  68  *
  69  * Revision 1.11  1995/10/13  16:05:08  quinn
  70  * Adding Espec1-processing
  71  *
  72  * Revision 1.10  1995/10/11  14:53:44  quinn
  73  * Work on variants.
  74  *
  75  * Revision 1.9  1995/10/06  16:56:50  quinn
  76  * Fixed ranked result.
  77  *
  78  * Revision 1.8  1995/10/06  16:44:13  quinn
  79  * Work on attribute set mapping, etc.
  80  *
  81  * Revision 1.7  1995/10/06  12:58:35  quinn
  82  * SUTRS support
  83  *
  84  * Revision 1.6  1995/10/04  09:29:49  quinn
  85  * Adjustments to support USGS test data
  86  *
  87  * Revision 1.5  1995/10/03  17:56:43  quinn
  88  * Fixing GRS code.
  89  *
  90  * Revision 1.4  1995/10/02  15:53:19  quinn
  91  * Work
  92  *
  93  * Revision 1.3  1995/10/02  14:55:21  quinn
  94  * *** empty log message ***
  95  *
  96  * Revision 1.2  1995/09/14  15:18:13  quinn
  97  * Work
  98  *
  99  * Revision 1.1  1995/09/12  11:24:30  quinn
 100  * Beginning to add code for structured records.
 101  *
 102  *
 103  */
 104
 105 #include <ctype.h>
 106 #include <stdio.h>
 107 #include <stdlib.h>
 108
 109 #include <xmalloc.h>
 110 #include <log.h>
 111 #include <data1.h>
 112
 113 /*
 114  * get the tag which is the immediate parent of this node (this may mean
 115  * traversing intermediate things like variants and stuff.
 116  */
 117 data1_node *get_parent_tag (data1_handle dh, data1_node *n)
 118 {
 119     for (; n && n->which != DATA1N_root; n = n->parent)
 120         if (n->which == DATA1N_tag)
 121             return n;
 122     return 0;
 123 }
 124
 125 data1_node *data1_mk_node (data1_handle dh, NMEM m)
 126 {
 127     data1_node *r;
 128
 129     r = nmem_malloc(m, sizeof(*r));
 130     r->next = r->child = r->last_child = r->parent = 0;
 131     r->num_children = 0;
 132     r->destroy = 0;
 133     return r;
 134 }
 135
 136 void data1_free_tree (data1_handle dh, data1_node *t)
 137 {
 138     data1_node *p = t->child, *pn;
 139
 140     while (p)
 141     {
 142         pn = p->next;
 143         data1_free_tree (dh, p);
 144         p = pn;
 145     }
 146     if (t->destroy)
 147         (*t->destroy)(t);
 148 }
 149
 150 /*
 151  * Insert a tagged node into the record root as first child of the node at
 152  * which should be root or tag itself). Returns pointer to the data node,
 153  * which can then be modified.
 154  */
 155 data1_node *data1_insert_taggeddata(data1_handle dh, data1_node *root,
 156                                     data1_node *at,
 157                                     char *tagname, NMEM m)
 158 {
 159     data1_node *tagn = data1_mk_node (dh, m);
 160     data1_node *datn;
 161
 162     tagn->which = DATA1N_tag;
 163     tagn->line = -1;
 164     tagn->u.tag.tag = 0;
 165     tagn->u.tag.node_selected = 0;
 166     tagn->u.tag.make_variantlist = 0;
 167     tagn->u.tag.no_data_requested = 0;
 168     tagn->u.tag.get_bytes = -1;
 169     if (!(tagn->u.tag.element = data1_getelementbytagname (dh,
 170                                                            root->u.root.absyn,
 171                                                            0, tagname)))
 172         return 0;
 173     tagn->child = datn = data1_mk_node (dh, m);
 174     tagn->num_children = 1;
 175     datn->parent = tagn;
 176     datn->root = root;
 177     datn->which = DATA1N_data;
 178     datn->u.data.formatted_text = 0;
 179     tagn->next = at->child;
 180     tagn->parent = at;
 181     at->child = tagn;
 182     at->num_children++;
 183     return datn;
 184 }
 185
 186 /*
 187  * Ugh. Sometimes functions just grow and grow on you. This one reads a
 188  * 'node' and its children.
 189  */
 190 data1_node *data1_read_node (data1_handle dh, char **buf,
 191                              data1_node *parent, int *line,
 192                              data1_absyn *absyn, NMEM m)
 193 {
 194     data1_node *res;
 195
 196     while (**buf && isspace(**buf))
 197     {
 198         if (**buf == '\n')
 199             (*line)++;
 200         (*buf)++;
 201     }
 202     if (!**buf)
 203         return 0;
 204
 205     if (**buf == '<') /* beginning of tag */
 206     {
 207         char *tag = (*buf) + 1;
 208         char *args = 0;
 209         char *t = tag;
 210         data1_node **pp;
 211         data1_element *elem = 0;
 212
 213         for (; *t && *t != '>' && !isspace(*t); t++);
 214         if (*t != '>' && !isspace(*t))
 215         {
 216             logf(LOG_WARN, "d1: %d: Malformed tag", *line);
 217             return 0;
 218         }
 219         if (isspace(*t)) /* the tag has arguments */
 220         {
 221             while (isspace(*t))
 222                 t++;
 223             if (*t != '>')
 224             {
 225                 args = t;
 226                 for (; *t && *t != '>'; t++);
 227                 if (*t != '>' && !isspace(*t))
 228                 {
 229                     logf(LOG_WARN, "d1: %d: Malformed tag", *line);
 230                     return 0;
 231                 }
 232             }
 233         }
 234
 235         /*
 236          * if end-tag, see if we terminate parent. If so, consume and return.
 237          * Else, return.
 238          */
 239         *t = '\0';
 240         if (*tag == '/')
 241         {
 242             if (!parent)
 243                 return 0;
 244             if (!*(tag +1) ||
 245                 (parent->which == DATA1N_root &&
 246                  !strcmp(tag + 1,parent->u.root.type)) ||
 247                 (parent->which == DATA1N_tag &&
 248                  !strcmp(tag + 1, parent->u.tag.tag)))
 249             {
 250                 *buf = t + 1;
 251                 return 0;
 252             }
 253             else
 254             {
 255                 *t = '>';
 256                 return 0;
 257             }
 258         }
 259
 260         if (!absyn) /* parent node - what are we? */
 261         {
 262             if (!(absyn = data1_get_absyn (dh, tag)))
 263             {
 264                 logf(LOG_WARN, "Unable to acquire abstract syntax for '%s'",
 265                     tag);
 266                 return 0;
 267             }
 268             res = data1_mk_node (dh, m);
 269             res->which = DATA1N_root;
 270             res->u.root.type = tag;
 271             res->u.root.absyn = absyn;
 272             res->root = res;
 273             *buf = t + 1;
 274         }
 275         else if (!strncmp(tag, "var", 3))
 276         {
 277             char tclass[DATA1_MAX_SYMBOL], type[DATA1_MAX_SYMBOL];
 278             data1_vartype *tp;
 279             int val_offset;
 280             data1_node *p;
 281
 282             if (sscanf(args, "%s %s %n", tclass, type, &val_offset) != 2)
 283             {
 284                 logf(LOG_WARN, "Malformed variant triple at '%s'", tag);
 285                 return 0;
 286             }
 287             if (!(tp =
 288                   data1_getvartypebyct(dh, parent->root->u.root.absyn->varset,
 289                                        tclass, type)))
 290                 return 0;
 291
 292             /*
 293              * If we're the first variant in this group, create a parent var,
 294              * and insert it before the current variant.
 295              */
 296             if (parent->which != DATA1N_variant)
 297             {
 298                 res = data1_mk_node (dh, m);
 299                 res->which = DATA1N_variant;
 300                 res->u.variant.type = 0;
 301                 res->u.variant.value = 0;
 302                 res->root = parent->root;
 303                 *t = '>';
 304             }
 305             else
 306             {
 307                 /*
 308                  * now determine if one of our ancestor triples is of same type.
 309                  * If so, we break here. This will make the parser unwind until
 310                  * we become a sibling (alternate variant) to the aforementioned
 311                  * triple. It stinks that we re-parse these tags on every
 312                  * iteration of this. This is a function in need of a rewrite.
 313                  */
 314                 for (p = parent; p->which == DATA1N_variant; p = p->parent)
 315                     if (p->u.variant.type == tp)
 316                     {
 317                         *t = '>';
 318                         return 0;
 319                     }
 320
 321                 res =  data1_mk_node (dh, m);
 322                 res->which = DATA1N_variant;
 323                 res->root = parent->root;
 324                 res->u.variant.type = tp;
 325                 res->u.variant.value = args + val_offset;
 326                 *buf = t + 1;
 327             }
 328         }
 329         else /* tag.. acquire our element in the abstract syntax */
 330         {
 331             data1_node *partag = get_parent_tag (dh, parent);
 332             data1_element *e = 0;
 333             int localtag = 0;
 334
 335             if (parent->which == DATA1N_variant)
 336             {
 337                 *t = '>';
 338                 return 0;
 339             }
 340             if (partag)
 341                 if (!(e = partag->u.tag.element))
 342                     localtag = 1; /* our parent is a local tag */
 343
 344 #if 0
 345             if (!localtag && !(elem = data1_getelementbytagname(absyn,
 346                 e, tag)) && (data1_gettagbyname(absyn->tagset, tag)))
 347             {
 348                 if (parent->which == DATA1N_root)
 349                     logf(LOG_WARN, "Tag '%s' used out of context", tag);
 350                 *t = '>';
 351                 return 0;
 352             }
 353 #else
 354             elem = data1_getelementbytagname(dh, absyn, e, tag);
 355 #endif
 356             res = data1_mk_node (dh, m);
 357             res->which = DATA1N_tag;
 358             res->u.tag.element = elem;
 359             res->u.tag.tag = tag;
 360             res->u.tag.node_selected = 0;
 361             res->u.tag.make_variantlist = 0;
 362             res->u.tag.no_data_requested = 0;
 363             res->u.tag.get_bytes = -1;
 364             res->root = parent->root;
 365             *buf = t + 1;
 366         }
 367
 368         res->parent = parent;
 369         res->num_children = 0;
 370
 371         pp = &res->child;
 372         /*
 373          * Read child nodes.
 374          */
 375         while ((*pp = data1_read_node(dh, buf, res, line, absyn, m)))
 376         {
 377             res->last_child = *pp;
 378             res->num_children++;
 379             pp = &(*pp)->next;
 380         }
 381     }
 382     else /* != '<'... this is a body of text */
 383     {
 384         int len = 0;
 385         char *data = *buf, *pp = *buf;
 386
 387         if (!parent)      /* abort if abstract syntax is undefined */
 388             return 0;
 389         /* Determine length and remove newlines/extra blanks */
 390         while (**buf && **buf != '<')
 391         {
 392             if (**buf == '\n')
 393                 (*line)++;
 394             if (isspace(**buf))
 395             {
 396                 *(pp++) = ' ';
 397                 (*buf)++;
 398                 while (isspace(**buf))
 399                     (*buf)++;
 400             }
 401             else
 402                 *(pp++) = *((*buf)++);
 403             len++;
 404         }
 405         while (isspace(data[len-1]))
 406             len--;
 407         res = data1_mk_node(dh, m);
 408         res->parent = parent;
 409         res->which = DATA1N_data;
 410         res->u.data.what = DATA1I_text;
 411         res->u.data.len = len;
 412         res->u.data.data = data;
 413         res->u.data.formatted_text = 0;
 414         res->root = parent->root;
 415     }
 416     return res;
 417 }
 418
 419 /*
 420  * Read a record in the native syntax.
 421  */
 422 data1_node *data1_read_record(data1_handle dh,
 423                               int (*rf)(void *, char *, size_t), void *fh,
 424                               NMEM m)
 425 {
 426     int *size;
 427     char **buf = data1_get_read_buf (dh, &size);
 428     char *bp;
 429     int rd = 0, res;
 430     int line = 0;
 431
 432     if (!*buf)
 433         *buf = xmalloc(*size = 4096);
 434
 435     for (;;)
 436     {
 437         if (rd + 4096 > *size && !(*buf =xrealloc(*buf, *size *= 2)))
 438             abort();
 439         if ((res = (*rf)(fh, *buf + rd, 4096)) <= 0)
 440         {
 441             if (!res)
 442             {
 443                 bp = *buf;
 444                 return data1_read_node(dh, &bp, 0, &line, 0, m);
 445             }
 446             else
 447                 return 0;
 448         }
 449         rd += res;
 450     }
 451 }