src/cclqfile.c

   1 /*
   2  * Copyright (c) 1995, the EUROPAGATE consortium (see below).
   3  *
   4  * The EUROPAGATE consortium members are:
   5  *
   6  *    University College Dublin
   7  *    Danmarks Teknologiske Videnscenter
   8  *    An Chomhairle Leabharlanna
   9  *    Consejo Superior de Investigaciones Cientificas
  10  *
  11  * Permission to use, copy, modify, distribute, and sell this software and
  12  * its documentation, in whole or in part, for any purpose, is hereby granted,
  13  * provided that:
  14  *
  15  * 1. This copyright and permission notice appear in all copies of the
  16  * software and its documentation. Notices of copyright or attribution
  17  * which appear at the beginning of any file must remain unchanged.
  18  *
  19  * 2. The names of EUROPAGATE or the project partners may not be used to
  20  * endorse or promote products derived from this software without specific
  21  * prior written permission.
  22  *
  23  * 3. Users of this software (implementors and gateway operators) agree to
  24  * inform the EUROPAGATE consortium of their use of the software. This
  25  * information will be used to evaluate the EUROPAGATE project and the
  26  * software, and to plan further developments. The consortium may use
  27  * the information in later publications.
  28  *
  29  * 4. Users of this software agree to make their best efforts, when
  30  * documenting their use of the software, to acknowledge the EUROPAGATE
  31  * consortium, and the role played by the software in their work.
  32  *
  33  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  34  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  35  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  36  * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
  37  * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
  38  * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
  39  * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
  40  * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
  41  * USE OR PERFORMANCE OF THIS SOFTWARE.
  42  *
  43  */
  44 /**
  45  * \file cclqfile.c
  46  * \brief Implements parsing of CCL qualifier specs in files
  47  */
  48 /* CCL qualifiers
  49  * Europagate, 1995
  50  *
  51  * $Id: cclqfile.c,v 1.10 2007-04-27 10:09:45 adam Exp $
  52  *
  53  * Old Europagate Log:
  54  *
  55  * Revision 1.3  1995/05/16  09:39:26  adam
  56  * LICENSE.
  57  *
  58  * Revision 1.2  1995/05/11  14:03:56  adam
  59  * Changes in the reading of qualifier(s). New function: ccl_qual_fitem.
  60  * New variable ccl_case_sensitive, which controls whether reserved
  61  * words and field names are case sensitive or not.
  62  *
  63  * Revision 1.1  1995/04/17  09:31:45  adam
  64  * Improved handling of qualifiers. Aliases or reserved words.
  65  *
  66  */
  67
  68 #include <stdio.h>
  69 #include <stdlib.h>
  70 #include <string.h>
  71
  72 #include <yaz/tokenizer.h>
  73 #include <yaz/ccl.h>
  74 #include <yaz/log.h>
  75
  76 #define MAX_QUAL 128
  77
  78 int ccl_qual_field2(CCL_bibset bibset, const char *cp, const char *qual_name,
  79                     const char **addinfo)
  80 {
  81     yaz_tok_cfg_t yt = yaz_tok_cfg_create();
  82
  83     int type_ar[MAX_QUAL];
  84     int value_ar[MAX_QUAL];
  85     char *svalue_ar[MAX_QUAL];
  86     char *attsets[MAX_QUAL];
  87     int pair_no = 0;
  88     char *type_str = 0;
  89     int t;
  90     yaz_tok_parse_t tp;
  91
  92     yaz_tok_cfg_single_tokens(yt, ",=");
  93
  94     tp = yaz_tok_parse_buf(yt, cp);
  95
  96     yaz_tok_cfg_destroy(yt);
  97     *addinfo = 0;
  98
  99     t = yaz_tok_move(tp);
 100     while (t == YAZ_TOK_STRING)
 101     {
 102         /* we don't know what lead is yet */
 103         char *lead_str = xstrdup(yaz_tok_parse_string(tp));
 104         const char *value_str = 0;
 105         int type = 0, value = 0; /* indicates attribute value UNSET  */
 106
 107         t = yaz_tok_move(tp);
 108         if (t == ',')
 109         {
 110             /* full attribute spec: set, type = value */
 111             /* lead is attribute set */
 112             attsets[pair_no] = lead_str;
 113             t = yaz_tok_move(tp);
 114             if (t != YAZ_TOK_STRING)
 115             {
 116                 *addinfo = "token expected";
 117                 goto out;
 118             }
 119             xfree(type_str);
 120             type_str = xstrdup(yaz_tok_parse_string(tp));
 121             if (yaz_tok_move(tp) != '=')
 122             {
 123                 *addinfo = "= expected";
 124                 goto out;
 125             }
 126         }
 127         else if (t == '=')
 128         {
 129             /* lead is attribute type */
 130             /* attribute set omitted: type = value */
 131             attsets[pair_no] = 0;
 132             xfree(type_str);
 133             type_str = lead_str;
 134         }
 135         else
 136         {
 137             /* lead is first of a list of qualifier aliaeses */
 138             /* qualifier alias: q1 q2 ... */
 139             xfree(lead_str);
 140             yaz_tok_parse_destroy(tp);
 141             ccl_qual_add_combi (bibset, qual_name, cp);
 142             return 0;
 143         }
 144         while (1) /* comma separated attribute value list */
 145         {
 146             t = yaz_tok_move(tp);
 147             /* must have a value now */
 148             if (t != YAZ_TOK_STRING)
 149             {
 150                 *addinfo = "value token expected";
 151                 goto out;
 152             }
 153             value_str = yaz_tok_parse_string(tp);
 154
 155             if (sscanf(type_str, "%d", &type) == 1)
 156                 ;
 157             else if (strlen(type_str) != 1)
 158             {
 159                 *addinfo = "bad attribute type";
 160                 goto out;
 161             }
 162             else
 163             {
 164                 switch (*type_str)
 165                 {
 166                 case 'u':
 167                 case 'U':
 168                     type = CCL_BIB1_USE;
 169                     break;
 170                 case 'r':
 171                 case 'R':
 172                     type = CCL_BIB1_REL;
 173                     if (!ccl_stricmp (value_str, "o"))
 174                         value = CCL_BIB1_REL_ORDER;
 175                     else if (!ccl_stricmp (value_str, "r"))
 176                         value = CCL_BIB1_REL_PORDER;
 177                     break;
 178                 case 'p':
 179                 case 'P':
 180                     type = CCL_BIB1_POS;
 181                     break;
 182                 case 's':
 183                 case 'S':
 184                     type = CCL_BIB1_STR;
 185                     if (!ccl_stricmp (value_str, "pw"))
 186                         value = CCL_BIB1_STR_WP;
 187                     if (!ccl_stricmp (value_str, "al"))
 188                         value = CCL_BIB1_STR_AND_LIST;
 189                     if (!ccl_stricmp (value_str, "ol"))
 190                         value = CCL_BIB1_STR_OR_LIST;
 191                     break;
 192                 case 't':
 193                 case 'T':
 194                     type = CCL_BIB1_TRU;
 195                     if (!ccl_stricmp (value_str, "l"))
 196                         value = CCL_BIB1_TRU_CAN_LEFT;
 197                     else if (!ccl_stricmp (value_str, "r"))
 198                         value = CCL_BIB1_TRU_CAN_RIGHT;
 199                     else if (!ccl_stricmp (value_str, "b"))
 200                         value = CCL_BIB1_TRU_CAN_BOTH;
 201                     else if (!ccl_stricmp (value_str, "n"))
 202                         value = CCL_BIB1_TRU_CAN_NONE;
 203                     break;
 204                 case 'c':
 205                 case 'C':
 206                     type = CCL_BIB1_COM;
 207                     break;
 208                 }
 209             }
 210             if (type == 0)
 211             {
 212                 /* type was not set in switch above */
 213                 *addinfo = "bad attribute type";
 214                 goto out;
 215             }
 216             type_ar[pair_no] = type;
 217             if (value)
 218             {
 219                 value_ar[pair_no] = value;
 220                 svalue_ar[pair_no] = 0;
 221             }
 222             else if (*value_str >= '0' && *value_str <= '9')
 223             {
 224                 value_ar[pair_no] = atoi (value_str);
 225                 svalue_ar[pair_no] = 0;
 226             }
 227             else
 228             {
 229                 value_ar[pair_no] = 0;
 230                 svalue_ar[pair_no] = xstrdup(value_str);
 231             }
 232             pair_no++;
 233             if (pair_no == MAX_QUAL)
 234             {
 235                 *addinfo = "too many attribute values";
 236                 goto out;
 237             }
 238             t = yaz_tok_move(tp);
 239             if (t != ',')
 240                 break;
 241             attsets[pair_no] = attsets[pair_no-1];
 242         }
 243     }
 244  out:
 245     xfree(type_str);
 246     type_str = 0;
 247
 248     yaz_tok_parse_destroy(tp);
 249
 250     if (*addinfo)
 251     {
 252         int i;
 253         for (i = 0; i<pair_no; i++)
 254         {
 255             xfree(attsets[i]);
 256             xfree(svalue_ar[i]);
 257         }
 258         return -1;
 259     }
 260     ccl_qual_add_set(bibset, qual_name, pair_no, type_ar, value_ar, svalue_ar,
 261                      attsets);
 262     return 0;
 263 }
 264
 265 void ccl_qual_field(CCL_bibset bibset, const char *cp, const char *qual_name)
 266 {
 267     const char *addinfo;
 268     ccl_qual_field2(bibset, cp, qual_name, &addinfo);
 269     if (addinfo)
 270         yaz_log(YLOG_WARN, "ccl_qual_field2 fail: %s", addinfo);
 271 }
 272
 273 void ccl_qual_fitem (CCL_bibset bibset, const char *cp, const char *qual_name)
 274 {
 275     if (*qual_name == '@')
 276         ccl_qual_add_special(bibset, qual_name+1, cp);
 277     else
 278         ccl_qual_field(bibset, cp, qual_name);
 279 }
 280
 281 void ccl_qual_buf(CCL_bibset bibset, const char *buf)
 282 {
 283     const char *cp1 = buf;
 284     char line[256];
 285     while (1)
 286     {
 287         const char *cp2 = cp1;
 288         int len;
 289         while (*cp2 && !strchr("\r\n", *cp2))
 290             cp2++;
 291         len = cp2 - cp1;
 292         if (len > 0)
 293         {
 294             if (len >= (sizeof(line)-1))
 295                 len = sizeof(line)-1;
 296             memcpy(line, cp1, len);
 297             line[len] = '\0';
 298             ccl_qual_line(bibset, line);
 299         }
 300         if (!*cp2)
 301             break;
 302         cp1 = cp2+1;
 303     }
 304 }
 305
 306 void ccl_qual_line(CCL_bibset bibset, char *line)
 307 {
 308     int  no_scan = 0;
 309     char qual_name[128];
 310     char *cp1, *cp = line;
 311
 312     if (*cp == '#')
 313         return;        /* ignore lines starting with # */
 314     if (sscanf (cp, "%100s%n", qual_name, &no_scan) < 1)
 315         return;        /* also ignore empty lines */
 316     cp += no_scan;
 317     cp1 = strchr(cp, '#');
 318     if (cp1)
 319         *cp1 = '\0';
 320     ccl_qual_fitem (bibset, cp, qual_name);
 321 }
 322
 323 /*
 324  * ccl_qual_file: Read bibset definition from file.
 325  * bibset:  Bibset
 326  * inf:     FILE pointer.
 327  *
 328  * Each line format is:
 329  *  <name> <t>=<v> <t>=<v> ....
 330  *  Where <name> is name of qualifier;
 331  *  <t>=<v> is a attribute definition pair where <t> is one of:
 332  *     u(use), r(relation), p(position), t(truncation), c(completeness)
 333  *     or plain integer.
 334  *  <v> is an integer or special pseudo-value.
 335  */
 336 void ccl_qual_file (CCL_bibset bibset, FILE *inf)
 337 {
 338     char line[256];
 339
 340     while (fgets (line, 255, inf))
 341         ccl_qual_line(bibset, line);
 342 }
 343
 344 int ccl_qual_fname (CCL_bibset bibset, const char *fname)
 345 {
 346     FILE *inf;
 347     inf = fopen (fname, "r");
 348     if (!inf)
 349         return -1;
 350     ccl_qual_file (bibset, inf);
 351     fclose (inf);
 352     return 0;
 353 }
 354 /*
 355  * Local variables:
 356  * c-basic-offset: 4
 357  * indent-tabs-mode: nil
 358  * End:
 359  * vim: shiftwidth=4 tabstop=8 expandtab
 360  */
 361