5 Author: Johnny Mnemonic <johnny@themnemonic.org>
7 Copyright (C) 1997 - 2002 Pekka Riikonen
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.
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.
22 #include "silcincludes.h"
24 /* limit debug logging verbosity */
26 #define SILC_CONFIG_DEBUG(fmt) SILC_LOG_DEBUG(fmt)
28 #define SILC_CONFIG_DEBUG(fmt)
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;
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 */
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 */
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 */
80 /* return string describing SilcConfig's error code */
81 char *silc_config_strerror(int errnum)
83 if ((errnum < 0) || (errnum >= sizeof(errorstrs)/sizeof(*errorstrs)) ||
84 (errorstrs[errnum] == NULL)) {
85 char *defret = "-INVALIDERROR";
88 return errorstrs[errnum];
91 /* Begin of internal SilcConfig's text util functions */
93 /* Points the first non-space character */
94 static void my_trim_spaces(SilcConfigFile *file)
96 register char *r = file->p;
98 if (*r++ == '\n') file->line++;
101 /* Skips the current line until newline (lf or cr) */
102 static void my_skip_line(SilcConfigFile *file)
104 register char *r = file->p;
105 while (*r && (*r != '\n') && (*r != '\r')) r++;
106 file->p = (*r ? r + 1 : r);
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)
114 my_trim_spaces(file);
116 while (isalnum(*o) || (*o == '_') || (*o == '-'))
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)
127 my_trim_spaces(file);
130 char *quot = strchr(++o, '"');
132 if (!quot) { /* XXX FIXME: gotta do something here */
133 printf("Bullshit, missing matching \"");
142 /* update stream pointer */
146 /* we don't need quote parsing, fall-back to token extractor */
147 my_next_token(file, to);
150 /* Skips all comment lines and spaces lines until first useful character */
151 static void my_skip_comments(SilcConfigFile *file)
154 my_trim_spaces(file);
155 if (*file->p != '#') return;
160 /* End of internal text functions
161 * Next section contains SilcConfig internal config utils */
163 /* find an option in the list by name and returns its pointer */
164 static SilcConfigOption *silc_config_find_option(SilcConfigEntity ent,
167 SilcConfigOption *tmp;
168 for (tmp = ent->opts; tmp; tmp = tmp->next) {
169 if (!strcasecmp(tmp->name, name))
175 static void *silc_config_marshall(SilcConfigType type, const char *val)
184 case SILC_CONFIG_ARG_TOGGLE:
185 if (!strcasecmp(val, "yes") || !strcasecmp(val, "true") ||
186 !strcasecmp(val, "on") || !strcasecmp(val, "1")) {
189 else if (!strcasecmp(val, "no") || !strcasecmp(val, "false") ||
190 !strcasecmp(val, "off") || !strcasecmp(val, "0")) {
195 pt = silc_calloc(1, sizeof(val_bool));
196 *(bool *)pt = (bool) val_bool;
198 case SILC_CONFIG_ARG_INT:
199 val_int = (int) strtol(val, &val_tmp, 0);
200 if (*val_tmp) /* error converting string */
202 pt = silc_calloc(1, sizeof(val_int));
203 *(int *)pt = val_int;
205 case SILC_CONFIG_ARG_SIZE:
206 val_size = (SilcUInt32) strtol(val, &val_tmp, 0);
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 */
213 case 'k': /* Kilobytes */
214 val_size *= (SilcUInt32) 1024;
216 case 'm': /* Megabytes */
217 val_size *= (SilcUInt32) (1024 * 1024);
220 val_size *= (SilcUInt32) (1024 * 1024 * 1024);
225 /* the string must die here */
228 pt = silc_calloc(1, sizeof(val_size));
229 *(SilcUInt32 *)pt = val_size;
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. */
234 case SILC_CONFIG_ARG_STRE:
235 pt = (void *) strdup(val);
237 /* following types are not supposed to have a return value */
238 case SILC_CONFIG_ARG_BLOCK:
239 case SILC_CONFIG_ARG_NONE:
248 /* End of internal functions */
251 /* Tries to open the config file and returns a valid SilcConfigFile object
252 * or NULL if failed */
254 SilcConfigFile *silc_config_open(const char *configfile)
260 if (!(buffer = silc_file_readfile(configfile, &filelen)))
263 ret = silc_calloc(1, sizeof(*ret));
264 ret->filename = strdup(configfile);
265 ret->base = ret->p = buffer;
267 ret->line = 1; /* line count, start from first line */
271 /* Frees a file object */
273 void silc_config_close(SilcConfigFile *file)
276 /* XXX FIXME: this check could probably be removed later */
277 SilcUInt32 my_len = (SilcUInt32) (strchr(file->base, EOF) - file->base);
278 SILC_CONFIG_DEBUG(("file=0x%x name=\"%s\" level=%d line=%lu", (SilcUInt32) file,
279 file->filename, file->level, file->line));
280 if (my_len != file->len) {
281 fprintf(stderr, "FATAL ERROR: saved len and current len does not match!\n");
284 silc_free(file->filename);
285 memset(file->base, 'F', file->len);
286 silc_free(file->base);
287 memset(file, 'F', sizeof(*file));
292 /* initializes a SilcConfigEntity pointer allocation */
294 SilcConfigEntity silc_config_init(SilcConfigFile *file)
296 SilcConfigEntity ret;
301 SILC_CONFIG_DEBUG(("Allocating new config entity"));
302 ret = silc_calloc(1, sizeof(*ret));
307 /* Returns the original filename of the object file */
309 char *silc_config_get_filename(SilcConfigFile *file)
312 return file->filename;
316 /* Returns the current line that file parsing arrived at */
318 SilcUInt32 silc_config_get_line(SilcConfigFile *file)
325 /* Returns a pointer to the beginning of the requested line. If the line
326 * was not found, NULL is returned */
328 char *silc_config_read_line(SilcConfigFile *file, SilcUInt32 line)
334 if (!file || (line <= 0))
336 for (p = file->base; *p && (*p != EOF); p++) {
345 if ((endbuf = strchr(p, '\n'))) {
347 ret = silc_calloc(len, sizeof(*ret));
348 strncpy(ret, p, len);
352 ret = silc_calloc(strlen(p), sizeof(*ret));
358 /* Convenience function to read the current parsed line */
360 char *silc_config_read_current_line(SilcConfigFile *file)
362 return silc_config_read_line(file, file->line);
365 /* (Private) destroy a SilcConfigEntity */
367 static void silc_config_destroy(SilcConfigEntity ent)
369 SilcConfigOption *oldopt, *nextopt;
370 SILC_CONFIG_DEBUG(("Freeing config entity [ent=0x%x] [opts=0x%x]",
371 (SilcUInt32) ent, (SilcUInt32) ent->opts));
372 for (oldopt = ent->opts; oldopt; oldopt = nextopt) {
373 nextopt = oldopt->next;
374 memset(oldopt->name, 'F', strlen(oldopt->name) + 1);
375 silc_free(oldopt->name);
376 memset(oldopt, 'F', sizeof(*oldopt));
379 memset(ent, 'F', sizeof(*ent));
383 /* Registers a new option in the specified entity.
384 * Returns TRUE on success, FALSE if already registered. */
386 bool silc_config_register(SilcConfigEntity ent, const char *name,
387 SilcConfigType type, SilcConfigCallback cb,
388 const SilcConfigTable *subtable, void *context)
390 SilcConfigOption *newopt;
391 SILC_CONFIG_DEBUG(("Register new option=\"%s\" type=%u cb=0x%08x context=0x%08x",
392 name, type, (SilcUInt32) cb, (SilcUInt32) context));
394 /* if we are registering a block, make sure there is a specified sub-table */
395 if (!ent || !name || ((type == SILC_CONFIG_ARG_BLOCK) && !subtable))
398 /* don't register a reserved tag */
399 if (!strcasecmp(name, "include"))
402 /* check if an option was previously registered */
403 if (silc_config_find_option(ent, name)) {
404 SILC_LOG_DEBUG(("Error: Can't register \"%s\" twice.", name));
408 /* allocate and append the new option */
409 newopt = silc_calloc(1, sizeof(*newopt));
410 newopt->name = strdup(name);
413 newopt->subtable = subtable;
414 newopt->context = context;
416 /* append this option to the list */
420 SilcConfigOption *tmp;
421 for (tmp = ent->opts; tmp->next; tmp = tmp->next);
427 /* Register a new option table in the specified config entity */
429 bool silc_config_register_table(SilcConfigEntity ent,
430 const SilcConfigTable table[], void *context)
435 SILC_CONFIG_DEBUG(("Registering table"));
436 /* XXX FIXME: some potability checks needed - really? */
437 for (i = 0; table[i].name; i++) {
438 if (!silc_config_register(ent, table[i].name, table[i].type,
439 table[i].callback, table[i].subtable, context))
447 static int silc_config_main_internal(SilcConfigEntity ent)
449 SilcConfigFile *file = ent->file;
452 /* loop throught statements */
455 SilcConfigOption *thisopt;
457 /* makes it pointing to the next interesting char */
458 my_skip_comments(file);
460 if (**p == '\0' || **p == EOF) {
461 if (file->level > 1) /* cannot get eof in a sub-level! */
462 return SILC_CONFIG_EEXPECTED;
465 /* check if we completed this (sub) section (it doesn't matter if this
466 * is the main section) */
468 if (file->level < 2) /* can't be! must be at least one sub-block */
469 return SILC_CONFIG_EUNEXPECTED;
473 //SILC_LOG_HEXDUMP(("Preparing lookup at line=%lu", file->line), *p, 16);
475 /* obtain the keyword */
476 my_next_token(file, buf);
477 SILC_CONFIG_DEBUG(("Looking up keyword=\"%s\" [line=%lu]", buf, file->line));
479 /* handle special directive */
480 if (!strcasecmp(buf, "include")) {
482 SilcConfigFile *inc_file;
483 SilcConfigEntity inc_ent;
485 my_trim_spaces(file); /* prepare next char */
487 /* Now trying to include the specified file. The included file will
488 * be allowed to include sub-files but it will preserve the block-level
489 * of the including block. Note that the included file won't be allowed
490 * to raise the block level of the including block. */
492 my_get_string(file, buf); /* get the filename */
493 SILC_LOG_DEBUG(("Including file \"%s\"", buf));
494 /* before getting on, check if this row is REALLY complete */
496 return SILC_CONFIG_EMISSCOLON;
498 /* open the file and start the parsing */
499 inc_file = silc_config_open(buf);
500 if (!inc_file) /* does it point a valid filename? */
501 return SILC_CONFIG_ECANTOPEN;
502 inc_file->included = TRUE;
504 /* create a new entity and hack it to use the same options */
505 inc_ent = silc_config_init(inc_file);
506 inc_ent->opts = ent->opts;
507 ret = silc_config_main(inc_ent);
510 * If the included file returned an error, the application will probably
511 * want to output some kind of error message. Because of this, we can't
512 * destroy THIS file object. The hack works this way: The application
513 * expects to destroy the originally created object file, so we'll swap
514 * the original file with the included file. */
516 SilcConfigFile tmp_file;
517 SILC_CONFIG_DEBUG(("SWAPPING FILE OBJECTS"));
518 memcpy(&tmp_file, inc_file, sizeof(tmp_file));
519 memcpy(inc_file, file, sizeof(tmp_file));
520 silc_config_close(inc_file);
521 memcpy(file, &tmp_file, sizeof(tmp_file));
524 /* otherwise if no errors encoured, continue normally */
525 silc_config_close(inc_file);
526 continue; /* this one is handled */
529 /* we have a registered option (it can also be a sub-block) */
530 thisopt = silc_config_find_option(ent, buf);
532 return SILC_CONFIG_EBADOPTION;
534 my_trim_spaces(file); /* prepare next char */
536 /* option type is a block? */
537 if (thisopt->type == SILC_CONFIG_ARG_BLOCK) {
539 SilcConfigEntity sub_ent;
541 SILC_CONFIG_DEBUG(("Entering sub-block"));
543 return SILC_CONFIG_EOPENBRACE;
544 /* build the new entity for this sub-block */
545 sub_ent = silc_config_init(ent->file);
546 /* use the previous specified table to describe this block's options */
547 silc_config_register_table(sub_ent, thisopt->subtable, thisopt->context);
548 /* run this block! */
549 ret = silc_config_main(sub_ent);
550 SILC_CONFIG_DEBUG(("Returned from sub-block [ret=%d]", ret));
552 if (ret) /* now check the result */
555 /* now call block clean-up callback (if any) */
558 SILC_CONFIG_DEBUG(("Now calling clean-up callback"));
559 ret = thisopt->cb(thisopt->type, thisopt->name, file->line, NULL,
562 SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
566 /* Do we want ';' to be mandatory after close brace? */
568 return SILC_CONFIG_EMISSCOLON;
570 else if (thisopt->type == SILC_CONFIG_ARG_NONE) {
571 /* before getting on, check if this row is REALLY complete */
573 return SILC_CONFIG_EMISSCOLON;
574 SILC_CONFIG_DEBUG(("Triggering callback for none"));
576 thisopt->cb(thisopt->type, thisopt->name, file->line,
577 NULL, thisopt->context);
585 return SILC_CONFIG_EEXPECTEDEQUAL;
587 my_get_string(file, buf); /* get the option argument */
588 SILC_CONFIG_DEBUG(("With argument=\"%s\"", buf));
590 /* before getting on, check if this row is REALLY complete */
592 return SILC_CONFIG_EMISSCOLON;
594 /* convert the option argument to the right format */
595 pt = silc_config_marshall(thisopt->type, buf);
597 return SILC_CONFIG_EINVALIDTEXT;
599 ret = thisopt->cb(thisopt->type, thisopt->name, file->line,
600 pt, thisopt->context);
602 SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
614 return SILC_CONFIG_OK;
619 int silc_config_main(SilcConfigEntity ent)
621 SilcConfigFile *file = ent->file;
624 /* don't silently accept a NULL entity */
626 ret = SILC_CONFIG_EGENERIC;
630 /* call the real main and store the result */
632 SILC_CONFIG_DEBUG(("[Lev=%d] Entering config parsing core", file->level));
633 ret = silc_config_main_internal(ent);
634 SILC_CONFIG_DEBUG(("[Lev=%d] Quitting main [ret=%d]", file->level, ret));
635 if (!file->level) /* when swap happens, we could close a file twice */
639 /* If this file was included don't destroy the options set because it is
640 * the same of the including block. Although if this entity is in a
641 * sub-block created inside the included file, this options set must be
644 if ((file->level != 0) || (file->included != TRUE))
645 silc_config_destroy(ent);