lib/silcutil/silcconfig.c

   1 /*
   2
   3   silcconfig.c
   4
   5   Author: Johnny Mnemonic <johnny@themnemonic.org>
   6
   7   Copyright (C) 1997 - 2002 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20 /* $Id$ */
  21
  22 #include "silcincludes.h"
  23
  24 /* limit debug logging verbosity */
  25 #if 0
  26 #define SILC_CONFIG_DEBUG(fmt) SILC_LOG_DEBUG(fmt)
  27 #else
  28 #define SILC_CONFIG_DEBUG(fmt)
  29 #endif
  30
  31 /* this is the option struct and currently it is only used internally to
  32  * the module and other structs. */
  33 typedef struct SilcConfigOptionStruct {
  34   char *name;                   /* *lowercase* name of the option */
  35   SilcConfigType type;          /* important: the type of the returned value */
  36   SilcConfigCallback cb;        /* the value handler */
  37   const SilcConfigTable *subtable; /* used if type is SILC_CONFIG_ARG_BLOCK */
  38   void *context;                /* context passed to the callback function */
  39   struct SilcConfigOptionStruct *next;
  40 } SilcConfigOption;
  41
  42 /* unique for each config file (and included ones) */
  43 struct SilcConfigFileObject {
  44   char *filename; /* the original filename opened */
  45   int level;    /* parsing level, how many nested silc_config_main we have */
  46   char *base;   /* this is a fixed pointer to the base location */
  47   char *p;      /* the Parser poitner */
  48   SilcUInt32 len;       /* fixed length of the whole file */
  49   SilcUInt32 line;      /* current parsing line, strictly linked to p */
  50   bool included; /* wether this file is main or included */
  51 };
  52
  53 /* We need the entity to base our block-style parsing on */
  54 struct SilcConfigEntityObject {
  55   SilcConfigOption *opts;       /* known options list */
  56   SilcConfigFile *file;         /* parsing file object */
  57 };
  58
  59 /* access error descriptions only with silc_config_strerror() */
  60 static char *errorstrs[] = {
  61   "-OK",                                        /* SILC_CONFIG_OK */
  62   "-SILENT",                                    /* SILC_CONFIG_ESILENT */
  63   "-PRINTLINE",                                 /* SILC_CONFIG_EPRINTLINE */
  64   "Invalid syntax",                             /* SILC_CONFIG_EGENERIC */
  65   "Internal error! Please report this bug",     /* SILC_CONFIG_EINTERNAL */
  66   "Can't open specified file",                  /* SILC_CONFIG_ECANTOPEN */
  67   "Expected open-brace '{'",                    /* SILC_CONFIG_EOPENBRACE */
  68   "Missing close-brace '}'",                    /* SILC_CONFIG_ECLOSEBRACE */
  69   "Invalid data type",                          /* SILC_CONFIG_ETYPE */
  70   "Unknown option",                             /* SILC_CONFIG_EBADOPTION */
  71   "Invalid text",                               /* SILC_CONFIG_EINVALIDTEXT */
  72   "Double option specification",                /* SILC_CONFIG_EDOUBLE */
  73   "Expected data but not found",                /* SILC_CONFIG_EEXPECTED */
  74   "Expected '='",                               /* SILC_CONFIG_EEXPECTEDEQUAL */
  75   "Unexpected data",                            /* SILC_CONFIG_EUNEXPECTED */
  76   "Missing mandatory fields",                   /* SILC_CONFIG_EMISSFIELDS */
  77   "Missing ';'",                                /* SILC_CONFIG_EMISSCOLON */
  78 };
  79
  80 /* return string describing SilcConfig's error code */
  81 char *silc_config_strerror(int errnum)
  82 {
  83   if ((errnum < 0) || (errnum >= sizeof(errorstrs)/sizeof(*errorstrs)) ||
  84     (errorstrs[errnum] == NULL)) {
  85     char *defret = "-INVALIDERROR";
  86     return defret;
  87   }
  88   return errorstrs[errnum];
  89 }
  90
  91 /* Begin of internal SilcConfig's text util functions */
  92
  93 /* Points the first non-space character */
  94 static void my_trim_spaces(SilcConfigFile *file)
  95 {
  96   register char *r = file->p;
  97   while (isspace(*r))
  98     if (*r++ == '\n') file->line++;
  99   file->p = r;
 100 }
 101 /* Skips the current line until newline (lf or cr) */
 102 static void my_skip_line(SilcConfigFile *file)
 103 {
 104   register char *r = file->p;
 105   while (*r && (*r != '\n') && (*r != '\r')) r++;
 106   file->p = (*r ? r + 1 : r);
 107   file->line++;
 108 }
 109 /* Obtains a text token from the current position until first separator.
 110  * a separator is any non alphanumeric character nor "_" or "-" */
 111 static char *my_next_token(SilcConfigFile *file, char *to)
 112 {
 113   register char *o;
 114   my_trim_spaces(file);
 115   o = file->p;
 116   while (isalnum(*o) || (*o == '_') || (*o == '-'))
 117     *to++ = *o++;
 118   *to = '\0';
 119   file->p = o;
 120   return to;
 121 }
 122 /* Obtains a string from the current position. The only difference from
 123  * next_token() is that quoted-strings are also accepted */
 124 static char *my_get_string(SilcConfigFile *file, char *to)
 125 {
 126   char *o;
 127   my_trim_spaces(file);
 128   o = file->p;
 129   if (*o == '"') {
 130     char *quot = strchr(++o, '"');
 131     int len = quot - o;
 132     if (!quot) { /* XXX FIXME: gotta do something here */
 133       printf("Bullshit, missing matching \"");
 134       exit(1);
 135     }
 136     if (len <= 0)
 137       *to = '\0';
 138     else {
 139       strncpy(to, o, len);
 140       to[len] = '\0';
 141     }
 142     /* update stream pointer */
 143     file->p = quot + 1;
 144     return to;
 145   }
 146   /* we don't need quote parsing, fall-back to token extractor */
 147   my_next_token(file, to);
 148   return to;
 149 };
 150 /* Skips all comment lines and spaces lines until first useful character */
 151 static void my_skip_comments(SilcConfigFile *file)
 152 {
 153   while (1) {
 154     my_trim_spaces(file);
 155     if (*file->p != '#') return;
 156     my_skip_line(file);
 157   }
 158 }
 159
 160 /* End of internal text functions
 161  * Next section contains SilcConfig internal config utils */
 162
 163 /* find an option in the list by name and returns its pointer */
 164 static SilcConfigOption *silc_config_find_option(SilcConfigEntity ent,
 165         const char *name)
 166 {
 167   SilcConfigOption *tmp;
 168   for (tmp = ent->opts; tmp; tmp = tmp->next) {
 169     if (!strcasecmp(tmp->name, name))
 170       return tmp;
 171   }
 172   return NULL;
 173 }
 174 /* ... */
 175 static void *silc_config_marshall(SilcConfigType type, const char *val)
 176 {
 177   void *pt;
 178   int val_int;
 179   bool val_bool;
 180   char *val_tmp;
 181   SilcUInt32 val_size;
 182
 183   switch (type) {
 184     case SILC_CONFIG_ARG_TOGGLE:
 185       if (!strcasecmp(val, "yes") || !strcasecmp(val, "true") ||
 186                 !strcasecmp(val, "on") || !strcasecmp(val, "1")) {
 187         val_bool = TRUE;
 188       }
 189       else if (!strcasecmp(val, "no") || !strcasecmp(val, "false") ||
 190                 !strcasecmp(val, "off") || !strcasecmp(val, "0")) {
 191         val_bool = FALSE;
 192       }
 193       else
 194         return NULL;
 195       pt = silc_calloc(1, sizeof(val_bool));
 196       *(bool *)pt = (bool) val_bool;
 197       return pt;
 198     case SILC_CONFIG_ARG_INT:
 199       val_int = (int) strtol(val, &val_tmp, 0);
 200       if (*val_tmp) /* error converting string */
 201         return NULL;
 202       pt = silc_calloc(1, sizeof(val_int));
 203       *(int *)pt = val_int;
 204       return pt;
 205     case SILC_CONFIG_ARG_SIZE:
 206       val_size = (SilcUInt32) strtol(val, &val_tmp, 0);
 207       if (val == val_tmp)
 208         return NULL; /* really wrong, there must be at least one digit */
 209       /* Search for a designator */
 210       switch (tolower(val_tmp[0])) {
 211         case '\0': /* None */
 212           break;
 213         case 'k': /* Kilobytes */
 214           val_size *= (SilcUInt32) 1024;
 215           break;
 216         case 'm': /* Megabytes */
 217           val_size *= (SilcUInt32) (1024 * 1024);
 218           break;
 219         case 'g':
 220           val_size *= (SilcUInt32) (1024 * 1024 * 1024);
 221           break;
 222         default:
 223           return NULL;
 224       }
 225       /* the string must die here */
 226       if (val_tmp[1])
 227         return NULL;
 228       pt = silc_calloc(1, sizeof(val_size));
 229       *(SilcUInt32 *)pt = val_size;
 230       return pt;
 231     case SILC_CONFIG_ARG_STR: /* the only difference between STR and STRE is */
 232       if (!val[0])            /* that STR cannot be empty, while STRE can.  */
 233         return NULL;
 234     case SILC_CONFIG_ARG_STRE:
 235       pt = (void *) strdup(val);
 236       return pt;
 237     /* following types are not supposed to have a return value */
 238     case SILC_CONFIG_ARG_BLOCK:
 239     case SILC_CONFIG_ARG_NONE:
 240       return NULL;
 241     default:
 242       return NULL;
 243   }
 244
 245   return NULL;
 246 }
 247
 248 /* End of internal functions */
 249
 250
 251 /* Tries to open the config file and returns a valid SilcConfigFile object
 252  * or NULL if failed */
 253
 254 SilcConfigFile *silc_config_open(const char *configfile)
 255 {
 256   char *buffer;
 257   SilcUInt32 filelen;
 258   SilcConfigFile *ret;
 259
 260   if (!(buffer = silc_file_readfile(configfile, &filelen)))
 261     return NULL;
 262
 263   ret = silc_calloc(1, sizeof(*ret));
 264   ret->filename = strdup(configfile);
 265   ret->base = ret->p = buffer;
 266   ret->len = filelen;
 267   ret->line = 1; /* line count, start from first line */
 268   return ret;
 269 }
 270
 271 /* Frees a file object */
 272
 273 void silc_config_close(SilcConfigFile *file)
 274 {
 275   if (file) {
 276     silc_free(file->filename);
 277     memset(file->base, 'F', file->len);
 278     silc_free(file->base);
 279     memset(file, 'F', sizeof(*file));
 280     silc_free(file);
 281   }
 282 }
 283
 284 /* initializes a SilcConfigEntity pointer allocation */
 285
 286 SilcConfigEntity silc_config_init(SilcConfigFile *file)
 287 {
 288   SilcConfigEntity ret;
 289
 290   if (!file)
 291     return NULL;
 292
 293   SILC_CONFIG_DEBUG(("Allocating new config entity"));
 294   ret = silc_calloc(1, sizeof(*ret));
 295   ret->file = file;
 296   return ret;
 297 };
 298
 299 /* Returns the original filename of the object file */
 300
 301 char *silc_config_get_filename(SilcConfigFile *file)
 302 {
 303   if (file)
 304     return file->filename;
 305   return NULL;
 306 }
 307
 308 /* Returns the current line that file parsing arrived at */
 309
 310 SilcUInt32 silc_config_get_line(SilcConfigFile *file)
 311 {
 312   if (file)
 313     return file->line;
 314   return 0;
 315 }
 316
 317 /* Returns a pointer to the beginning of the requested line.  If the line
 318  * was not found, NULL is returned */
 319
 320 char *silc_config_read_line(SilcConfigFile *file, SilcUInt32 line)
 321 {
 322   register char *p;
 323   int len;
 324   char *ret, *endbuf;
 325
 326   if (!file || (line <= 0))
 327     return NULL;
 328   for (p = file->base; *p && (*p != EOF); p++) {
 329     if (line <= 1)
 330       goto found;
 331     if (*p == '\n')
 332       line--;
 333   }
 334   return NULL;
 335
 336  found:
 337   if ((endbuf = strchr(p, '\n'))) {
 338     len = endbuf - p;
 339     ret = silc_calloc(len, sizeof(*ret));
 340     strncpy(ret, p, len);
 341     ret[len] = '\0';
 342   }
 343   else {
 344     ret = silc_calloc(strlen(p), sizeof(*ret));
 345     strcpy(ret, p);
 346   }
 347   return ret;
 348 }
 349
 350 /* Convenience function to read the current parsed line */
 351
 352 char *silc_config_read_current_line(SilcConfigFile *file)
 353 {
 354   return silc_config_read_line(file, file->line);
 355 }
 356
 357 /* (Private) destroy a SilcConfigEntity */
 358
 359 static void silc_config_destroy(SilcConfigEntity ent, bool destroy_opts)
 360 {
 361   SilcConfigOption *oldopt, *nextopt;
 362   SILC_CONFIG_DEBUG(("Freeing config entity [ent=0x%x] [opts=0x%x]",
 363                         (SilcUInt32) ent, (SilcUInt32) ent->opts));
 364
 365   /* if she wants to preserve options just free the object struct */
 366   if (!destroy_opts)
 367     goto skip_sect;
 368
 369   for (oldopt = ent->opts; oldopt; oldopt = nextopt) {
 370     nextopt = oldopt->next;
 371     memset(oldopt->name, 'F', strlen(oldopt->name) + 1);
 372     silc_free(oldopt->name);
 373     memset(oldopt, 'F', sizeof(*oldopt));
 374     silc_free(oldopt);
 375   }
 376
 377  skip_sect:
 378   memset(ent, 'F', sizeof(*ent));
 379   silc_free(ent);
 380 }
 381
 382 /* Registers a new option in the specified entity.
 383  * Returns TRUE on success, FALSE if already registered. */
 384
 385 bool silc_config_register(SilcConfigEntity ent, const char *name,
 386                           SilcConfigType type, SilcConfigCallback cb,
 387                           const SilcConfigTable *subtable, void *context)
 388 {
 389   SilcConfigOption *newopt;
 390   SILC_CONFIG_DEBUG(("Register new option=\"%s\" type=%u cb=0x%08x context=0x%08x",
 391                 name, type, (SilcUInt32) cb, (SilcUInt32) context));
 392
 393   /* if we are registering a block, make sure there is a specified sub-table */
 394   if (!ent || !name || ((type == SILC_CONFIG_ARG_BLOCK) && !subtable))
 395     return FALSE;
 396
 397   /* don't register a reserved tag */
 398   if (!strcasecmp(name, "include"))
 399     return FALSE;
 400
 401   /* check if an option was previously registered */
 402   if (silc_config_find_option(ent, name)) {
 403     SILC_LOG_DEBUG(("Error: Can't register \"%s\" twice.", name));
 404     return FALSE;
 405   }
 406
 407   /* allocate and append the new option */
 408   newopt = silc_calloc(1, sizeof(*newopt));
 409   newopt->name = strdup(name);
 410   newopt->type = type;
 411   newopt->cb = cb;
 412   newopt->subtable = subtable;
 413   newopt->context = context;
 414
 415   /* append this option to the list */
 416   if (!ent->opts)
 417     ent->opts = newopt;
 418   else {
 419     SilcConfigOption *tmp;
 420     for (tmp = ent->opts; tmp->next; tmp = tmp->next);
 421     tmp->next = newopt;
 422   }
 423   return TRUE;
 424 }
 425
 426 /* Register a new option table in the specified config entity */
 427
 428 bool silc_config_register_table(SilcConfigEntity ent,
 429                                 const SilcConfigTable table[], void *context)
 430 {
 431   int i;
 432   if (!ent || !table)
 433     return FALSE;
 434   SILC_CONFIG_DEBUG(("Registering table"));
 435   /* XXX FIXME: some potability checks needed - really? */
 436   for (i = 0; table[i].name; i++) {
 437     if (!silc_config_register(ent, table[i].name, table[i].type,
 438                               table[i].callback, table[i].subtable, context))
 439       return FALSE;
 440   }
 441   return TRUE;
 442 }
 443
 444 /* ... */
 445
 446 static int silc_config_main_internal(SilcConfigEntity ent)
 447 {
 448   SilcConfigFile *file = ent->file;
 449   char **p = &file->p;
 450
 451   /* loop throught statements */
 452   while (1) {
 453     char buf[255];
 454     SilcConfigOption *thisopt;
 455
 456     /* makes it pointing to the next interesting char */
 457     my_skip_comments(file);
 458     /* got eof? */
 459     if (**p == '\0' || **p == EOF) {
 460       if (file->level > 1) /* cannot get eof in a sub-level! */
 461         return SILC_CONFIG_EEXPECTED;
 462       goto finish;
 463     }
 464     /* check if we completed this (sub) section (it doesn't matter if this
 465      * is the main section) */
 466     if (**p == '}') {
 467       if (file->level < 2) /* can't be! must be at least one sub-block */
 468         return SILC_CONFIG_EUNEXPECTED;
 469       (*p)++;
 470       goto finish;
 471     }
 472     //SILC_LOG_HEXDUMP(("Preparing lookup at line=%lu", file->line), *p, 16);
 473
 474     /* obtain the keyword */
 475     my_next_token(file, buf);
 476     SILC_CONFIG_DEBUG(("Looking up keyword=\"%s\" [line=%lu]", buf, file->line));
 477
 478     /* handle special directive */
 479     if (!strcasecmp(buf, "include")) {
 480       int ret;
 481       SilcConfigFile *inc_file;
 482       SilcConfigEntity inc_ent;
 483
 484       my_trim_spaces(file); /* prepare next char */
 485
 486       /* Now trying to include the specified file.  The included file will
 487        * be allowed to include sub-files but it will preserve the block-level
 488        * of the including block. Note that the included file won't be allowed
 489        * to raise the block level of the including block. */
 490
 491       my_get_string(file, buf); /* get the filename */
 492       SILC_LOG_DEBUG(("Including file \"%s\"", buf));
 493       /* before getting on, check if this row is REALLY complete */
 494       if (*(*p)++ != ';')
 495         return SILC_CONFIG_EMISSCOLON;
 496
 497       /* open the file and start the parsing */
 498       inc_file = silc_config_open(buf);
 499       if (!inc_file) /* does it point a valid filename? */
 500         return SILC_CONFIG_ECANTOPEN;
 501       inc_file->included = TRUE;
 502
 503       /* create a new entity and hack it to use the same options */
 504       inc_ent = silc_config_init(inc_file);
 505       inc_ent->opts = ent->opts;
 506       ret = silc_config_main(inc_ent);
 507
 508       /* Cleanup.
 509        * If the included file returned an error, the application will probably
 510        * want to output some kind of error message. Because of this, we can't
 511        * destroy THIS file object. The hack works this way: The application
 512        * expects to destroy the originally created object file, so we'll swap
 513        * the original file with the included file. */
 514       if (ret) {
 515         SilcConfigFile tmp_file;
 516         SILC_CONFIG_DEBUG(("SWAPPING FILE OBJECTS"));
 517         memcpy(&tmp_file, inc_file, sizeof(tmp_file));
 518         memcpy(inc_file, file, sizeof(tmp_file));
 519         silc_config_close(inc_file);
 520         memcpy(file, &tmp_file, sizeof(tmp_file));
 521         return ret;
 522       }
 523       /* otherwise if no errors encoured, continue normally */
 524       silc_config_close(inc_file);
 525       continue; /* this one is handled */
 526     }
 527
 528     /* we have a registered option (it can also be a sub-block) */
 529     thisopt = silc_config_find_option(ent, buf);
 530     if (!thisopt)
 531       return SILC_CONFIG_EBADOPTION;
 532
 533     my_trim_spaces(file); /* prepare next char */
 534
 535     /* option type is a block? */
 536     if (thisopt->type == SILC_CONFIG_ARG_BLOCK) {
 537       int ret;
 538       SilcConfigEntity sub_ent;
 539
 540       SILC_CONFIG_DEBUG(("Entering sub-block"));
 541       if (*(*p)++ != '{')
 542         return SILC_CONFIG_EOPENBRACE;
 543       /* build the new entity for this sub-block */
 544       sub_ent = silc_config_init(ent->file);
 545       /* use the previous specified table to describe this block's options */
 546       silc_config_register_table(sub_ent, thisopt->subtable, thisopt->context);
 547       /* run this block! */
 548       ret = silc_config_main(sub_ent);
 549       SILC_CONFIG_DEBUG(("Returned from sub-block [ret=%d]", ret));
 550
 551       if (ret) /* now check the result */
 552         return ret;
 553
 554       /* now call block clean-up callback (if any) */
 555       if (thisopt->cb) {
 556         int ret;
 557         SILC_CONFIG_DEBUG(("Now calling clean-up callback"));
 558         ret = thisopt->cb(thisopt->type, thisopt->name, file->line, NULL,
 559                           thisopt->context);
 560         if (ret) {
 561           SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
 562           return ret;
 563         }
 564       }
 565       /* Do we want ';' to be mandatory after close brace? */
 566       if (*(*p)++ != ';')
 567         return SILC_CONFIG_EMISSCOLON;
 568     }
 569     else if (thisopt->type == SILC_CONFIG_ARG_NONE) {
 570       /* before getting on, check if this row is REALLY complete */
 571       if (*(*p)++ != ';')
 572         return SILC_CONFIG_EMISSCOLON;
 573       SILC_CONFIG_DEBUG(("Triggering callback for none"));
 574       if (thisopt->cb) {
 575         thisopt->cb(thisopt->type, thisopt->name, file->line,
 576                     NULL, thisopt->context);
 577       }
 578     }
 579     else {
 580       void *pt;
 581       int ret;
 582
 583       if (*(*p)++ != '=')
 584         return SILC_CONFIG_EEXPECTEDEQUAL;
 585
 586       my_get_string(file, buf); /* get the option argument */
 587       SILC_CONFIG_DEBUG(("With argument=\"%s\"", buf));
 588
 589       /* before getting on, check if this row is REALLY complete */
 590       if (*(*p)++ != ';')
 591         return SILC_CONFIG_EMISSCOLON;
 592
 593       /* convert the option argument to the right format */
 594       pt = silc_config_marshall(thisopt->type, buf);
 595       if (!pt)
 596         return SILC_CONFIG_EINVALIDTEXT;
 597       if (thisopt->cb) {
 598         ret = thisopt->cb(thisopt->type, thisopt->name, file->line,
 599                           pt, thisopt->context);
 600         if (ret) {
 601           SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
 602           return ret;
 603         }
 604       }
 605       silc_free(pt);
 606     }
 607     continue;
 608
 609  finish:
 610     break;
 611   }
 612
 613   return SILC_CONFIG_OK;
 614 }
 615
 616 /* ... */
 617
 618 int silc_config_main(SilcConfigEntity ent)
 619 {
 620   SilcConfigFile *file = ent->file;
 621   int ret;
 622
 623   /* don't silently accept a NULL entity */
 624   if (!ent) {
 625     ret = SILC_CONFIG_EGENERIC;
 626     goto main_cleanup;
 627   }
 628
 629   /* call the real main and store the result */
 630   file->level++;
 631   SILC_CONFIG_DEBUG(("[Lev=%d] Entering config parsing core", file->level));
 632   ret = silc_config_main_internal(ent);
 633   SILC_CONFIG_DEBUG(("[Lev=%d] Quitting main [ret=%d]", file->level, ret));
 634   if (!file->level) /* when swap happens, we could close a file twice */
 635     goto main_end;
 636   file->level--;
 637
 638   /* If this file was included don't destroy the options set because it is
 639    * the same of the including block. Although if this entity is in a
 640    * sub-block created inside the included file, this options set must be
 641    * destroyed. */
 642  main_cleanup:
 643   if ((file->level != 0) || (file->included != TRUE))
 644     silc_config_destroy(ent, TRUE);
 645   else
 646     silc_config_destroy(ent, FALSE);
 647
 648  main_end:
 649   return ret;
 650 }