util/res.c

   1 /* $Id: res.c,v 1.56 2007-01-15 15:10:26 adam Exp $
   2    Copyright (C) 1995-2007
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 */
  22
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <assert.h>
  27 #ifdef WIN32
  28 #include <io.h>
  29 #endif
  30 #if HAVE_UNISTD_H
  31 #include <unistd.h>
  32 #endif
  33
  34 #include <yaz/yaz-util.h>
  35 #include <idzebra/res.h>
  36
  37 #define YLOG_RES 0
  38
  39 struct res_entry {
  40     char *name;
  41     char *value;
  42     struct res_entry *next;
  43 };
  44
  45 struct res_struct {
  46     int ref_count;
  47     struct res_entry *first, *last;
  48     Res def_res;
  49     Res over_res;
  50 };
  51
  52 static Res res_incref(Res r)
  53 {
  54     if (r)
  55         r->ref_count++;
  56     return r;
  57 }
  58
  59 static struct res_entry *add_entry(Res r)
  60 {
  61     struct res_entry *resp;
  62
  63     if (!r->first)
  64         resp = r->last = r->first =
  65             (struct res_entry *) xmalloc(sizeof(*resp));
  66     else
  67     {
  68         resp = (struct res_entry *) xmalloc(sizeof(*resp));
  69         r->last->next = resp;
  70         r->last = resp;
  71     }
  72     resp->next = NULL;
  73     return resp;
  74 }
  75
  76 static char *xstrdup_env(const char *src)
  77 {
  78     int i = 0;
  79     int j = 0;
  80     char *dst;
  81     int env_strlen = 0;
  82
  83     while (src[i])
  84     {
  85         if (src[i] == '$' && src[i+1] == '{')
  86         {
  87             char envname[128];
  88             char *env_val;
  89             int k = 0;
  90             i = i + 2;
  91             while (k < 127 && src[i] && !strchr(":}\n\r\f", src[i]))
  92                 envname[k++] = src[i++];
  93             envname[k] = '\0';
  94
  95             env_val = getenv(envname);
  96             if (env_val)
  97                 env_strlen += 1 + strlen(env_val);
  98             else
  99                 env_strlen++;
 100             while (src[i] && !strchr("}\n\r\f", src[i]))
 101                 i++;
 102             if (src[i] == '}')
 103                 i++;
 104         }
 105         else
 106             i++;
 107     }
 108     dst = xmalloc(1 + env_strlen + i);
 109     i = 0;
 110     while (src[i])
 111     {
 112         if (src[i] == '$' && src[i+1] == '{')
 113         {
 114             char envname[128];
 115             char *env_val;
 116             int k = 0;
 117             i = i + 2;
 118             while(k < 127 && src[i] && !strchr(":}\n\r\f", src[i]))
 119                 envname[k++] = src[i++];
 120             envname[k] = '\0';
 121             env_val = getenv(envname);
 122             if (env_val)
 123             {
 124                 strcpy(dst+j, env_val);
 125                 j += strlen(env_val);
 126             }
 127             else if (src[i] == ':' && src[i+1] == '-')
 128             {
 129                 i = i + 2;
 130                 while (src[i] && !strchr("}\n\r\f", src[i]))
 131                     dst[j++] = src[i++];
 132             }
 133             while (src[i] && !strchr("}\n\r\f", src[i]))
 134                 i++;
 135             if (src[i] == '}')
 136                 i++;
 137         }
 138         else
 139             dst[j++] = src[i++];
 140     }
 141     dst[j] = '\0';
 142     return dst;
 143 }
 144
 145 ZEBRA_RES res_read_file(Res r, const char *fname)
 146 {
 147     struct res_entry *resp;
 148     char *line;
 149     char *val_buf;
 150     int val_size, val_max = 256;
 151     char fr_buf[1024];
 152     FILE *fr;
 153
 154     assert(r);
 155
 156     fr = fopen(fname, "r");
 157     if (!fr)
 158     {
 159         yaz_log(YLOG_WARN|YLOG_ERRNO, "Cannot open `%s'", fname);
 160         return ZEBRA_FAIL;
 161     }
 162     val_buf = (char*) xmalloc(val_max);
 163     while (1)
 164     {
 165         line = fgets(fr_buf, sizeof(fr_buf)-1, fr);
 166         if (!line)
 167             break;
 168         if (*line != '#')
 169         {
 170             int no = 0;
 171             while (1)
 172             {
 173                 if (fr_buf[no] == 0 || fr_buf[no] == '\n' )
 174                 {
 175                     no = 0;
 176                     break;
 177                 }
 178                 if (strchr(": \t", fr_buf[no]))
 179                     break;
 180                 no++;
 181             }
 182             if (!no)
 183                 continue;
 184             fr_buf[no++] = '\0';
 185             resp = add_entry(r);
 186             resp->name = (char*) xmalloc(no);
 187             strcpy(resp->name, fr_buf);
 188
 189             while (strchr(" \t", fr_buf[no]))
 190                 no++;
 191             val_size = 0;
 192             while (1)
 193             {
 194                 if (fr_buf[no] == '\0' || strchr("\n\r\f", fr_buf[no]))
 195                 {
 196                     while (val_size > 0 &&
 197                               (val_buf[val_size-1] == ' ' ||
 198                                val_buf[val_size-1] == '\t'))
 199                         val_size--;
 200                     val_buf[val_size] = '\0';
 201                     resp->value = xstrdup_env(val_buf);
 202                     yaz_log(YLOG_DEBUG, "(name=%s,value=%s)",
 203                          resp->name, resp->value);
 204                     break;
 205                 }
 206                 else if (fr_buf[no] == '\\' && strchr("\n\r\f", fr_buf[no+1]))
 207                 {
 208                     line = fgets(fr_buf, sizeof(fr_buf)-1, fr);
 209                     if (!line)
 210                     {
 211                         val_buf[val_size] = '\0';
 212                         resp->value = xstrdup_env(val_buf);
 213                         break;
 214                     }
 215                     no = 0;
 216                 }
 217                 else
 218                 {
 219                     val_buf[val_size++] = fr_buf[no++];
 220                     if (val_size+1 >= val_max)
 221                     {
 222                         char *nb;
 223
 224                         nb = (char*) xmalloc(val_max+=1024);
 225                         memcpy(nb, val_buf, val_size);
 226                         xfree(val_buf);
 227                         val_buf = nb;
 228                     }
 229                 }
 230             }
 231         }
 232     }
 233     xfree(val_buf);
 234     fclose(fr);
 235     return ZEBRA_OK;
 236 }
 237
 238 Res res_open(Res def_res, Res over_res)
 239 {
 240     Res r;
 241     r = (Res) xmalloc(sizeof(*r));
 242
 243     r->ref_count = 1;
 244     r->first = r->last = NULL;
 245     r->def_res = res_incref(def_res);
 246     r->over_res = res_incref(over_res);
 247     return r;
 248 }
 249
 250 void res_clear(Res r)
 251 {
 252     struct res_entry *re, *re1;
 253     for (re = r->first; re; re=re1)
 254     {
 255         if (re->name)
 256             xfree(re->name);
 257         if (re->value)
 258             xfree(re->value);
 259         re1 = re->next;
 260         xfree(re);
 261     }
 262     r->first = r->last = NULL;
 263 }
 264
 265 void res_close(Res r)
 266 {
 267     if (r && --(r->ref_count) == 0)
 268     {
 269         res_clear(r);
 270         res_close(r->def_res);
 271         res_close(r->over_res);
 272         xfree(r);
 273     }
 274 }
 275
 276 const char *res_get_prefix(Res r, const char *name, const char *prefix,
 277                             const char *def)
 278 {
 279     const char *v = 0;;
 280     if (prefix)
 281     {
 282         char rname[128];
 283
 284         if (strlen(name) + strlen(prefix) >= (sizeof(rname)-2))
 285             return 0;
 286         strcpy(rname, prefix);
 287         strcat(rname, ".");
 288         strcat(rname, name);
 289         v = res_get(r, rname);
 290     }
 291     if (!v)
 292         v = res_get(r, name);
 293     if (!v)
 294         v = def;
 295     return v;
 296 }
 297
 298 const char *res_get(Res r, const char *name)
 299 {
 300     struct res_entry *re;
 301     const char *v;
 302
 303     if (!r)
 304         return 0;
 305
 306     v = res_get(r->over_res, name);
 307     if (v)
 308         return v;
 309
 310     for (re = r->first; re; re=re->next)
 311         if (re->value && !yaz_matchstr(re->name, name))
 312             return re->value;
 313
 314     return res_get(r->def_res, name);
 315 }
 316
 317 const char *res_get_def(Res r, const char *name, const char *def)
 318 {
 319     const char *t;
 320
 321     if (!(t = res_get(r, name)))
 322     {
 323         if (def)
 324             yaz_log(YLOG_DEBUG, "Using default resource %s:%s", name, def);
 325         return def;
 326     }
 327     else
 328         return t;
 329 }
 330
 331 int res_get_match(Res r, const char *name, const char *value, const char *s)
 332 {
 333     const char *cn = res_get(r, name);
 334
 335     if (!cn)
 336         cn = s;
 337     if (cn && !yaz_matchstr(cn, value))
 338         return 1;
 339     return 0;
 340 }
 341
 342 void res_set(Res r, const char *name, const char *value)
 343 {
 344     struct res_entry *re;
 345     assert(r);
 346
 347     if (!value)
 348         return;
 349     for (re = r->first; re; re=re->next)
 350         if (re->value && !yaz_matchstr(re->name, name))
 351         {
 352             xfree(re->value);
 353             re->value = xstrdup_env(value);
 354             return;
 355         }
 356     re = add_entry(r);
 357     re->name = xstrdup(name);
 358     re->value = xstrdup_env(value);
 359 }
 360
 361 int res_trav(Res r, const char *prefix, void *p,
 362               void (*f)(void *p, const char *name, const char *value))
 363 {
 364     struct res_entry *re;
 365     int l = 0;
 366     int no = 0;
 367
 368     if (!r)
 369         return 0;
 370     no = res_trav(r->over_res, prefix, p, f);
 371     if (no)
 372         return no;
 373     if (prefix)
 374         l = strlen(prefix);
 375     for (re = r->first; re; re=re->next)
 376         if (re->value)
 377             if (l==0 || !memcmp(re->name, prefix, l))
 378             {
 379                 (*f)(p, re->name, re->value);
 380                 no++;
 381             }
 382     if (!no)
 383         return res_trav(r->def_res, prefix, p, f);
 384     return no;
 385 }
 386
 387
 388 ZEBRA_RES res_write_file(Res r, const char *fname)
 389 {
 390     struct res_entry *re;
 391     FILE *fr;
 392
 393     assert(r);
 394     fr = fopen(fname, "w");
 395     if (!fr)
 396     {
 397         yaz_log(YLOG_FATAL|YLOG_ERRNO, "Cannot create `%s'", fname);
 398         return ZEBRA_FAIL;
 399     }
 400
 401     for (re = r->first; re; re=re->next)
 402     {
 403         int no = 0;
 404         int lefts = strlen(re->name)+2;
 405
 406         if (!re->value)
 407             fprintf(fr, "%s\n", re->name);
 408         else
 409         {
 410             fprintf(fr, "%s: ", re->name);
 411             while (lefts + strlen(re->value+no) > 78)
 412             {
 413                 int i = 20;
 414                 int ind = no+ 78-lefts;
 415                 while (--i >= 0)
 416                 {
 417                     if (re->value[ind] == ' ')
 418                         break;
 419                     --ind;
 420                 }
 421                 if (i<0)
 422                     ind = no + 78 - lefts;
 423                 for (i = no; i != ind; i++)
 424                     putc(re->value[i], fr);
 425                 fprintf(fr, "\\\n");
 426                 no=ind;
 427                 lefts = 0;
 428             }
 429             fprintf(fr, "%s\n", re->value+no);
 430         }
 431     }
 432     fclose(fr);
 433     return ZEBRA_OK;
 434 }
 435
 436 ZEBRA_RES res_get_int(Res r, const char *name, int *val)
 437 {
 438     const char *cp = res_get(r, name);
 439     if (cp)
 440     {
 441         if (sscanf(cp, "%d", val) == 1)
 442             return ZEBRA_OK;
 443         yaz_log(YLOG_WARN, "Expected integer for resource %s", name);
 444     }
 445     return ZEBRA_FAIL;
 446 }
 447
 448 /* == pop ================================================================= */
 449 Res res_add_over (Res p, Res t)
 450 {
 451     if ((!p) || (!t))
 452         return (0);
 453
 454     while (p->over_res)
 455         p = p->over_res;
 456
 457     p->over_res = t;
 458     return (p);
 459 }
 460
 461 void res_remove_over (Res r)
 462 {
 463     if (!r)
 464         return;
 465     r->over_res = 0;
 466 }
 467
 468 void res_close_over (Res r)
 469 {
 470     if (!r)
 471         return;
 472     if (r->over_res)
 473         res_close(r->over_res);
 474     r->over_res = 0;
 475 }
 476
 477 void res_add (Res r, const char *name, const char *value)
 478 {
 479     struct res_entry *re;
 480     assert(r);
 481     assert(name);
 482     assert(value);
 483     yaz_log (YLOG_RES, "res_add res=%p, name=%s, value=%s", r, name, value);
 484     re = add_entry (r);
 485     re->name = xstrdup (name);
 486     re->value = xstrdup_env (value);
 487 }
 488
 489 char **res_2_array (Res r)
 490 {
 491     struct res_entry *re;
 492     int i = 0;
 493     char **list;
 494
 495     if (!r)
 496         return 0;
 497
 498     list = xmalloc(sizeof(char *));
 499
 500     for (re = r->first; re; re=re->next) {
 501         list = xrealloc(list, ((i+3) * sizeof(char *)));
 502         list[i++] = strdup(re->name);
 503         if (re->value)
 504             list[i++] = strdup(re->value);
 505         else
 506             list[i++] = strdup("");
 507         yaz_log(YLOG_RES, "res2array: %s=%s",re->name, re->value);
 508     }
 509     list[i++] = 0;
 510     return (list);
 511 }
 512
 513 char **res_get_array(Res r, const char* name)
 514 {
 515     struct res_entry *re;
 516     int i = 0;
 517     char **list;
 518
 519     if (!r)
 520         return 0;
 521
 522     list = xmalloc(sizeof(char *));
 523
 524     for (re = r->first; re; re=re->next)
 525         if (re->value && !yaz_matchstr (re->name, name))
 526         {
 527             list = xrealloc(list, (i+2) * sizeof(char *));
 528             list[i++] = xstrdup(re->value);
 529         }
 530
 531     if (i == 0)
 532         return (res_get_array(r->def_res, name));
 533
 534     list[i++] = 0;
 535     return (list);
 536 }
 537
 538 void res_dump (Res r, int level)
 539 {
 540     struct res_entry *re;
 541
 542     if (!r)
 543         return;
 544
 545     for (re = r->first; re; re=re->next) {
 546         printf("%*s - %s:='%s'\n",level * 4,"",re->name,re->value);
 547     }
 548
 549     if (r->def_res) {
 550         printf ("%*s DEF ",level * 4,"");
 551         res_dump (r->def_res, level + 1);
 552     }
 553
 554     if (r->over_res) {
 555         printf ("%*s OVER ",level * 4,"");
 556         res_dump (r->over_res, level + 1);
 557     }
 558 }
 559
 560 int res_check(Res r_i, Res r_v)
 561 {
 562     struct res_entry *e_i;
 563     int errors = 0;
 564
 565     for (e_i = r_i->first; e_i; e_i = e_i->next)
 566     {
 567         struct res_entry *e_v;
 568         for (e_v = r_v->first; e_v; e_v = e_v->next)
 569         {
 570             int prefix_allowed = 0;
 571             int suffix_allowed = 0;
 572             const char *name = e_i->name;
 573             size_t name_len = strlen(e_i->name);
 574             char namez[32];
 575             const char *first_dot = 0;
 576             const char *second_dot = 0;
 577
 578             if (strchr(e_v->value, 'p'))
 579                 prefix_allowed = 1;
 580             if (strchr(e_v->value, 's'))
 581                 suffix_allowed = 1;
 582
 583             first_dot = strchr(name, '.');
 584             if (prefix_allowed && first_dot)
 585             {
 586                 name = first_dot+1;
 587                 name_len = strlen(name);
 588             }
 589             second_dot = strchr(name, '.');
 590             if (suffix_allowed && second_dot)
 591             {
 592                 name_len = second_dot - name;
 593             }
 594             if (name_len < sizeof(namez)-1)
 595             {
 596                 memcpy(namez, name, name_len);
 597                 namez[name_len] = '\0';
 598                 if (!yaz_matchstr(namez, e_v->name))
 599                     break;
 600             }
 601             /* for case 'a.b' we have to check 'a' as well */
 602             if (prefix_allowed && suffix_allowed && first_dot && !second_dot)
 603             {
 604                 name = e_i->name;
 605                 name_len = first_dot - name;
 606                 if (name_len < sizeof(namez)-1)
 607                 {
 608                     memcpy(namez, name, name_len);
 609                     namez[name_len] = '\0';
 610                     if (!yaz_matchstr(namez, e_v->name))
 611                         break;
 612                 }
 613             }
 614         }
 615         if (!e_v)
 616         {
 617             yaz_log(YLOG_WARN, "The following setting is unrecognized: %s",
 618                     e_i->name);
 619             errors++;
 620         }
 621     }
 622     return errors;
 623 }
 624
 625 /*
 626  * Local variables:
 627  * c-basic-offset: 4
 628  * indent-tabs-mode: nil
 629  * End:
 630  * vim: shiftwidth=4 tabstop=8 expandtab
 631  */
 632