retrieval/d1_read.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_read.c,v $
   7  * Revision 1.27  1999-08-27 09:40:32  adam
   8  * Renamed logf function to yaz_log. Removed VC++ project files.
   9  *
  10  * Revision 1.26  1999/07/13 13:23:48  adam
  11  * Non-recursive version of data1_read_node. data1_read_nodex reads
  12  * stream of bytes (instead of buffer in memory).
  13  *
  14  * Revision 1.25  1999/04/20 09:56:48  adam
  15  * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
  16  * Modified all encoders/decoders to reflect this change.
  17  *
  18  * Revision 1.24  1998/10/28 15:10:09  adam
  19  * Added --with-yc option to configure. For the data1_node in data1.h:
  20  * decreased size of localdata and removed member "line" which wasn't useful.
  21  *
  22  * Revision 1.23  1998/03/12 11:28:45  adam
  23  * Fix: didn't set root member of tagged node in function.
  24  * data1_add_insert_taggeddata.
  25  *
  26  * Revision 1.22  1998/03/05 08:15:32  adam
  27  * Implemented data1_add_insert_taggeddata utility which is more flexible
  28  * than data1_insert_taggeddata.
  29  *
  30  * Revision 1.21  1998/02/27 14:08:05  adam
  31  * Added const to some char pointer arguments.
  32  * Reworked data1_read_node so that it doesn't create a tree with
  33  * pointers to original "SGML"-buffer.
  34  *
  35  * Revision 1.20  1998/02/11 11:53:35  adam
  36  * Changed code so that it compiles as C++.
  37  *
  38  * Revision 1.19  1997/12/09 16:17:09  adam
  39  * Fix bug regarding variants. Tags with prefix "var" was incorrectly
  40  * interpreted as "start of variants". Now, only "var" indicates such
  41  * start.
  42  * Cleaned up data1_read_node so tag names and variant names are
  43  * copied and not pointed to by the generated data1 tree. Data nodes
  44  * still point to old buffer.
  45  *
  46  * Revision 1.18  1997/11/18 09:51:09  adam
  47  * Removed element num_children from data1_node. Minor changes in
  48  * data1 to Explain.
  49  *
  50  * Revision 1.17  1997/11/05 09:20:51  adam
  51  * Minor change.
  52  *
  53  * Revision 1.16  1997/09/17 12:10:37  adam
  54  * YAZ version 1.4.
  55  *
  56  * Revision 1.15  1997/09/05 09:50:57  adam
  57  * Removed global data1_tabpath - uses data1_get_tabpath() instead.
  58  *
  59  * Revision 1.14  1997/05/14 06:54:04  adam
  60  * C++ support.
  61  *
  62  * Revision 1.13  1996/10/29 13:35:38  adam
  63  * Implemented data1_set_tabpath and data1_get_tabpath.
  64  *
  65  * Revision 1.12  1996/10/11 10:35:38  adam
  66  * Fixed a bug that caused data1_read_node to core dump when no abstract
  67  * syntax was defined in a "sgml"-record.
  68  *
  69  * Revision 1.11  1996/07/06 19:58:35  quinn
  70  * System headerfiles gathered in yconfig
  71  *
  72  * Revision 1.10  1996/01/19  15:41:47  quinn
  73  * Fixed uninitialized boolean.
  74  *
  75  * Revision 1.9  1996/01/17  14:52:47  adam
  76  * Changed prototype for reader function parsed to data1_read_record.
  77  *
  78  * Revision 1.8  1995/12/15  16:20:41  quinn
  79  * Added formatted text.
  80  *
  81  * Revision 1.7  1995/12/13  13:44:32  quinn
  82  * Modified Data1-system to use nmem
  83  *
  84  * Revision 1.6  1995/12/12  16:37:08  quinn
  85  * Added destroy element to data1_node.
  86  *
  87  * Revision 1.5  1995/12/11  15:22:37  quinn
  88  * Added last_child field to the node.
  89  * Rewrote schema-mapping.
  90  *
  91  * Revision 1.4  1995/11/13  09:27:36  quinn
  92  * Fiddling with the variant stuff.
  93  *
  94  * Revision 1.3  1995/11/01  16:34:57  quinn
  95  * Making data1 look for tables in data1_tabpath
  96  *
  97  * Revision 1.2  1995/11/01  13:54:48  quinn
  98  * Minor adjustments
  99  *
 100  * Revision 1.1  1995/11/01  11:56:09  quinn
 101  * Added Retrieval (data management) functions en masse.
 102  *
 103  * Revision 1.14  1995/10/30  12:40:55  quinn
 104  * Fixed a couple of bugs.
 105  *
 106  * Revision 1.13  1995/10/25  16:00:47  quinn
 107  * USMARC support is now almost operational
 108  *
 109  * Revision 1.12  1995/10/16  14:02:55  quinn
 110  * Changes to support element set names and espec1
 111  *
 112  * Revision 1.11  1995/10/13  16:05:08  quinn
 113  * Adding Espec1-processing
 114  *
 115  * Revision 1.10  1995/10/11  14:53:44  quinn
 116  * Work on variants.
 117  *
 118  * Revision 1.9  1995/10/06  16:56:50  quinn
 119  * Fixed ranked result.
 120  *
 121  * Revision 1.8  1995/10/06  16:44:13  quinn
 122  * Work on attribute set mapping, etc.
 123  *
 124  * Revision 1.7  1995/10/06  12:58:35  quinn
 125  * SUTRS support
 126  *
 127  * Revision 1.6  1995/10/04  09:29:49  quinn
 128  * Adjustments to support USGS test data
 129  *
 130  * Revision 1.5  1995/10/03  17:56:43  quinn
 131  * Fixing GRS code.
 132  *
 133  * Revision 1.4  1995/10/02  15:53:19  quinn
 134  * Work
 135  *
 136  * Revision 1.3  1995/10/02  14:55:21  quinn
 137  * *** empty log message ***
 138  *
 139  * Revision 1.2  1995/09/14  15:18:13  quinn
 140  * Work
 141  *
 142  * Revision 1.1  1995/09/12  11:24:30  quinn
 143  * Beginning to add code for structured records.
 144  *
 145  *
 146  */
 147
 148 #include <assert.h>
 149 #include <ctype.h>
 150 #include <stdio.h>
 151 #include <stdlib.h>
 152
 153 #include <xmalloc.h>
 154 #include <log.h>
 155 #include <data1.h>
 156
 157 /*
 158  * get the tag which is the immediate parent of this node (this may mean
 159  * traversing intermediate things like variants and stuff.
 160  */
 161 data1_node *get_parent_tag (data1_handle dh, data1_node *n)
 162 {
 163     for (; n && n->which != DATA1N_root; n = n->parent)
 164         if (n->which == DATA1N_tag)
 165             return n;
 166     return 0;
 167 }
 168
 169 data1_node *data1_mk_node (data1_handle dh, NMEM m)
 170 {
 171     data1_node *r;
 172
 173     r = (data1_node *)nmem_malloc(m, sizeof(*r));
 174     r->next = r->child = r->last_child = r->parent = 0;
 175     r->destroy = 0;
 176     return r;
 177 }
 178
 179 void data1_free_tree (data1_handle dh, data1_node *t)
 180 {
 181     data1_node *p = t->child, *pn;
 182
 183     while (p)
 184     {
 185         pn = p->next;
 186         data1_free_tree (dh, p);
 187         p = pn;
 188     }
 189     if (t->destroy)
 190         (*t->destroy)(t);
 191 }
 192
 193 char *data1_insert_string (data1_handle dh, data1_node *res,
 194                            NMEM m, const char *str)
 195 {
 196     int len = strlen(str);
 197
 198     if (len >= DATA1_LOCALDATA)
 199         return nmem_strdup (m, str);
 200     else
 201     {
 202         strcpy (res->lbuf, str);
 203         return res->lbuf;
 204     }
 205 }
 206
 207 data1_node *data1_add_insert_taggeddata(data1_handle dh, data1_node *root,
 208                                         data1_node *at,
 209                                         const char *tagname, NMEM m,
 210                                         int first_flag, int local_allowed)
 211 {
 212     data1_node *partag = get_parent_tag (dh, at);
 213     data1_node *tagn = data1_mk_node (dh, m);
 214     data1_element *e = NULL;
 215     data1_node *datn;
 216
 217     tagn->which = DATA1N_tag;
 218     tagn->u.tag.tag = data1_insert_string (dh, tagn, m, tagname);
 219     tagn->u.tag.node_selected = 0;
 220     tagn->u.tag.make_variantlist = 0;
 221     tagn->u.tag.no_data_requested = 0;
 222     tagn->u.tag.get_bytes = -1;
 223
 224     if (partag)
 225         e = partag->u.tag.element;
 226     tagn->u.tag.element =
 227         data1_getelementbytagname (dh, root->u.root.absyn, e, tagname);
 228     if (!local_allowed && !tagn->u.tag.element)
 229         return NULL;
 230     tagn->last_child = tagn->child = datn = data1_mk_node (dh, m);
 231     tagn->root = root;
 232     datn->parent = tagn;
 233     datn->root = root;
 234     datn->which = DATA1N_data;
 235     datn->u.data.formatted_text = 0;
 236     tagn->parent = at;
 237
 238     if (first_flag)
 239     {
 240         tagn->next = at->child;
 241         if (!tagn->next)
 242             at->last_child = tagn;
 243         at->child = tagn;
 244     }
 245     else
 246     {
 247         if (!at->child)
 248             at->child = tagn;
 249         else
 250         {
 251             assert (at->last_child);
 252             at->last_child->next = tagn;
 253         }
 254         at->last_child = tagn;
 255     }
 256     return datn;
 257 }
 258
 259 data1_node *data1_add_taggeddata(data1_handle dh, data1_node *root,
 260                                  data1_node *at,
 261                                  const char *tagname, NMEM m)
 262 {
 263     return data1_add_insert_taggeddata (dh, root, at, tagname, m, 0, 1);
 264 }
 265
 266
 267 /*
 268  * Insert a tagged node into the record root as first child of the node at
 269  * which should be root or tag itself). Returns pointer to the data node,
 270  * which can then be modified.
 271  */
 272 data1_node *data1_insert_taggeddata(data1_handle dh, data1_node *root,
 273                                     data1_node *at,
 274                                     const char *tagname, NMEM m)
 275 {
 276     return data1_add_insert_taggeddata (dh, root, at, tagname, m, 1, 0);
 277 }
 278
 279 /*
 280  * Ugh. Sometimes functions just grow and grow on you. This one reads a
 281  * 'node' and its children.
 282  */
 283 data1_node *data1_read_nodex (data1_handle dh, NMEM m,
 284                               int (*get_byte)(void *fh), void *fh, WRBUF wrbuf)
 285 {
 286     data1_absyn *absyn = 0;
 287     data1_node *d1_stack[256];
 288     data1_node *res;
 289     int c;
 290     int level = 0;
 291     int line = 1;
 292
 293     d1_stack[level] = 0;
 294     c = (*get_byte)(fh);
 295     while (1)
 296     {
 297         data1_node *parent = level ? d1_stack[level-1] : 0;
 298         while (c != '\0' && isspace(c))
 299         {
 300             if (c == '\n')
 301                 line++;
 302             c = (*get_byte)(fh);
 303         }
 304         if (c == '\0')
 305             break;
 306
 307         if (c == '<') /* beginning of tag */
 308         {
 309             char tag[64];
 310             char args[256];
 311             size_t i;
 312
 313             for (i = 0; (c=(*get_byte)(fh)) && c != '>' && !isspace(c);)
 314                 if (i < (sizeof(tag)-1))
 315                     tag[i++] = c;
 316             tag[i] = '\0';
 317             while (isspace(c))
 318                 c = (*get_byte)(fh);
 319             for (i = 0; c && c != '>'; c = (*get_byte)(fh))
 320                 if (i < (sizeof(args)-1))
 321                     args[i++] = c;
 322             args[i] = '\0';
 323             if (c != '>')
 324             {
 325                 yaz_log(LOG_WARN, "d1: %d: Malformed tag", line);
 326                 return 0;
 327             }
 328             else
 329                 c = (*get_byte)(fh);
 330
 331             /* End tag? */
 332             if (*tag == '/')
 333             {
 334                 if (tag[1] == '\0')
 335                     --level;        /* </> */
 336                 else
 337                 {                   /* </tag> */
 338                     int i = level;
 339                     while (i > 0)
 340                     {
 341                         parent = d1_stack[--i];
 342                         if ((parent->which == DATA1N_root &&
 343                              !strcmp(tag+1, parent->u.root.type)) ||
 344                             (parent->which == DATA1N_tag &&
 345                              !strcmp(tag+1, parent->u.tag.tag)))
 346                         {
 347                             level = i;
 348                             break;
 349                         }
 350                     }
 351                     if (i != level)
 352                     {
 353                         yaz_log (LOG_WARN, "%d: no begin tag for %s",
 354                                  line, tag);
 355                         break;
 356                     }
 357                 }
 358                 if (level == 0)
 359                     return d1_stack[0];
 360                 continue;
 361             }
 362             if (level == 0) /* root ? */
 363             {
 364                 if (!(absyn = data1_get_absyn (dh, tag)))
 365                 {
 366                     yaz_log(LOG_WARN, "Unable to acquire abstract syntax "
 367                             "for '%s'", tag);
 368                     return 0;
 369                 }
 370                 res = data1_mk_node (dh, m);
 371                 res->which = DATA1N_root;
 372                 res->u.root.type = data1_insert_string (dh, res, m, tag);
 373                 res->u.root.absyn = absyn;
 374                 res->root = res;
 375             }
 376             else if (!strcmp(tag, "var"))
 377             {
 378                 char tclass[DATA1_MAX_SYMBOL], type[DATA1_MAX_SYMBOL];
 379                 data1_vartype *tp;
 380                 int val_offset;
 381
 382                 if (sscanf(args, "%s %s %n", tclass, type, &val_offset) != 2)
 383                 {
 384                     yaz_log(LOG_WARN, "Malformed variant triple at '%s'", tag);
 385                     continue;
 386                 }
 387                 if (!(tp =
 388                       data1_getvartypebyct(dh,
 389                                            parent->root->u.root.absyn->varset,
 390                                            tclass, type)))
 391                     continue;
 392                 /*
 393                  * If we're the first variant in this group, create a parent
 394                  * variant, and insert it before the current variant.
 395                  */
 396                 if (parent->which != DATA1N_variant)
 397                 {
 398                     res = data1_mk_node (dh, m);
 399                     res->which = DATA1N_variant;
 400                     res->u.variant.type = 0;
 401                     res->u.variant.value = 0;
 402                 }
 403                 else
 404                 {
 405                     /*
 406                      * now determine if one of our ancestor triples is of
 407                      * same type. If so, we break here.
 408                      */
 409                     int i;
 410                     for (i = level-1; d1_stack[i]->which==DATA1N_variant; --i)
 411                         if (d1_stack[i]->u.variant.type == tp)
 412                         {
 413                             level = i;
 414                             break;
 415                         }
 416                     res = data1_mk_node (dh, m);
 417                     res->which = DATA1N_variant;
 418                     res->u.variant.type = tp;
 419                     res->u.variant.value =
 420                         data1_insert_string (dh, res, m, args + val_offset);
 421                 }
 422             }
 423             else /* tag.. acquire our element in the abstract syntax */
 424             {
 425                 data1_node *partag = get_parent_tag (dh, parent);
 426                 data1_element *elem, *e = 0;
 427                 int localtag = 0;
 428
 429                 if (parent->which == DATA1N_variant)
 430                     return 0;
 431                 if (partag)
 432                     if (!(e = partag->u.tag.element))
 433                         localtag = 1; /* our parent is a local tag */
 434
 435                 elem = data1_getelementbytagname(dh, absyn, e, tag);
 436                 res = data1_mk_node (dh, m);
 437                 res->which = DATA1N_tag;
 438                 res->u.tag.tag = data1_insert_string (dh, res, m, tag);
 439                 res->u.tag.element = elem;
 440                 res->u.tag.node_selected = 0;
 441                 res->u.tag.make_variantlist = 0;
 442                 res->u.tag.no_data_requested = 0;
 443                 res->u.tag.get_bytes = -1;
 444             }
 445             if (parent)
 446             {
 447                 parent->last_child = res;
 448                 res->root = parent->root;
 449             }
 450             res->parent = parent;
 451             if (d1_stack[level])
 452                 d1_stack[level]->next = res;
 453             else if (parent)
 454                 parent->child = res;
 455             d1_stack[level] = res;
 456             d1_stack[++level] = 0;
 457         }
 458         else /* != '<'... this is a body of text */
 459         {
 460             const char *src;
 461             char *dst;
 462             int len, prev_char = 0;
 463
 464             if (level == 0)
 465             {
 466                 c = (*get_byte)(fh);
 467                 continue;
 468             }
 469             res = data1_mk_node(dh, m);
 470             res->parent = parent;
 471             res->which = DATA1N_data;
 472             res->u.data.what = DATA1I_text;
 473             res->u.data.formatted_text = 0;
 474             res->root = parent->root;
 475             parent->last_child = res;
 476             if (d1_stack[level])
 477                 d1_stack[level]->next = res;
 478             else
 479                 parent->child = res;
 480             d1_stack[level] = res;
 481
 482             wrbuf_rewind(wrbuf);
 483
 484             while (c != '<')
 485             {
 486                 wrbuf_putc (wrbuf, c);
 487                 c = (*get_byte)(fh);
 488             }
 489             len = wrbuf_len(wrbuf);
 490
 491             /* use local buffer of nmem if too large */
 492             if (len >= DATA1_LOCALDATA)
 493                 res->u.data.data = (char*) nmem_malloc (m, len);
 494             else
 495                 res->u.data.data = res->lbuf;
 496
 497             /* read "data" and transfer while removing white space */
 498             dst = res->u.data.data;
 499             for (src = wrbuf_buf(wrbuf); --len >= 0; src++)
 500             {
 501                 if (*src == '\n')
 502                     line++;
 503                 if (isspace (*src))
 504                     prev_char = ' ';
 505                 else
 506                 {
 507                     if (prev_char)
 508                     {
 509                         *dst++ = prev_char;
 510                         prev_char = 0;
 511                     }
 512                     *dst++ = *src;
 513                 }
 514             }
 515             res->u.data.len = dst - res->u.data.data;
 516         }
 517     }
 518     return 0;
 519 }
 520
 521 int getc_mem (void *fh)
 522 {
 523     const char **p = (const char **) fh;
 524     if (**p)
 525         return *(*p)++;
 526     return 0;
 527 }
 528
 529 data1_node *data1_read_node (data1_handle dh, const char **buf, NMEM m)
 530 {
 531     WRBUF wrbuf = wrbuf_alloc();
 532     data1_node *node;
 533
 534     node = data1_read_nodex(dh, m, getc_mem, buf, wrbuf);
 535     wrbuf_free (wrbuf, 1);
 536     return node;
 537 }
 538
 539 /*
 540  * Read a record in the native syntax.
 541  */
 542 data1_node *data1_read_record(data1_handle dh,
 543                               int (*rf)(void *, char *, size_t), void *fh,
 544                               NMEM m)
 545 {
 546     int *size;
 547     char **buf = data1_get_read_buf (dh, &size);
 548     const char *bp;
 549     int rd = 0, res;
 550
 551     if (!*buf)
 552         *buf = (char *)xmalloc(*size = 4096);
 553
 554     for (;;)
 555     {
 556         if (rd + 2048 >= *size && !(*buf =(char *)xrealloc(*buf, *size *= 2)))
 557             abort();
 558         if ((res = (*rf)(fh, *buf + rd, 2048)) <= 0)
 559         {
 560             if (!res)
 561             {
 562                 bp = *buf;
 563                 (*buf)[rd] = '\0';
 564                 return data1_read_node(dh, &bp, m);
 565             }
 566             else
 567                 return 0;
 568         }
 569         rd += res;
 570     }
 571 }
 572
 573 data1_node *data1_read_sgml (data1_handle dh, NMEM m, const char *buf)
 574 {
 575     const char *bp = buf;
 576     return data1_read_node (dh, &bp, m);
 577 }
 578