5 Author: Giovanni Giacobbi <giovanni@giacobbi.net>
7 Copyright (C) 2002 - 2003 Giovanni Giacobbi
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
46 silc_config_main we have */
47 char *base; /* this is a fixed pointer to the base location */
48 char *p; /* the Parser poitner */
49 SilcUInt32 len; /* fixed length of the whole file */
50 SilcUInt32 line; /* current parsing line, strictly linked to p */
51 bool included; /* wether this file is main or included */
54 /* We need the entity to base our block-style parsing on */
55 struct SilcConfigEntityObject {
56 SilcConfigOption *opts; /* known options list */
57 SilcConfigFile *file; /* parsing file object */
60 /* access error descriptions only with silc_config_strerror() */
61 static char *errorstrs[] = {
62 "-OK", /* SILC_CONFIG_OK */
63 "-SILENT", /* SILC_CONFIG_ESILENT */
64 "-PRINTLINE", /* SILC_CONFIG_EPRINTLINE */
65 "Invalid syntax", /* SILC_CONFIG_EGENERIC */
66 "Internal error! Please report this bug", /* SILC_CONFIG_EINTERNAL */
67 "Can't open specified file", /* SILC_CONFIG_ECANTOPEN */
68 "Expected open-brace '{'", /* SILC_CONFIG_EOPENBRACE */
69 "Missing close-brace '}'", /* SILC_CONFIG_ECLOSEBRACE */
70 "Invalid data type", /* SILC_CONFIG_ETYPE */
71 "Unknown option", /* SILC_CONFIG_EBADOPTION */
72 "Invalid text", /* SILC_CONFIG_EINVALIDTEXT */
73 "Double option specification", /* SILC_CONFIG_EDOUBLE */
74 "Expected data but not found", /* SILC_CONFIG_EEXPECTED */
75 "Expected '='", /* SILC_CONFIG_EEXPECTEDEQUAL */
76 "Unexpected data", /* SILC_CONFIG_EUNEXPECTED */
77 "Missing mandatory fields", /* SILC_CONFIG_EMISSFIELDS */
78 "Missing ';'", /* SILC_CONFIG_EMISSCOLON */
81 /* return string describing SilcConfig's error code */
82 char *silc_config_strerror(int errnum)
84 if ((errnum < 0) || (errnum >= sizeof(errorstrs)/sizeof(*errorstrs)) ||
85 (errorstrs[errnum] == NULL)) {
86 char *defret = "-INVALIDERROR";
89 return errorstrs[errnum];
92 /* Begin of internal SilcConfig's text util functions */
94 /* Points the first non-space character */
95 static void my_trim_spaces(SilcConfigFile *file)
97 register char *r = file->p;
98 while ((*r != '\0' && *r != EOF) && isspace(*r))
99 if (*r++ == '\n') file->line++;
102 /* Skips the current line until newline (lf or cr) */
103 static void my_skip_line(SilcConfigFile *file)
105 register char *r = file->p;
106 while ((*r != '\0' && *r != EOF) && (*r != '\n') && (*r != '\r')) r++;
107 file->p = ((*r != '\0' && *r != EOF) ? r + 1 : r);
110 /* Obtains a text token from the current position until first separator.
111 * a separator is any non alphanumeric character nor "_" or "-" */
112 static char *my_next_token(SilcConfigFile *file, char *to)
115 my_trim_spaces(file);
117 while (isalnum(*o) || (*o == '_') || (*o == '-'))
123 /* Obtains a string from the current position. The only difference from
124 * next_token() is that quoted-strings are also accepted */
125 static char *my_get_string(SilcConfigFile *file, char *to)
128 my_trim_spaces(file);
131 char *quot = strchr(++o, '"');
133 if (!quot) { /* XXX FIXME: gotta do something here */
134 printf("Bullshit, missing matching \"");
143 /* update stream pointer */
147 /* we don't need quote parsing, fall-back to token extractor */
148 my_next_token(file, to);
151 /* Skips all comment lines and spaces lines until first useful character */
152 static void my_skip_comments(SilcConfigFile *file)
155 my_trim_spaces(file);
156 if (*file->p != '#') return;
161 /* End of internal text functions
162 * Next section contains SilcConfig internal config utils */
164 /* find an option in the list by name and returns its pointer */
165 static SilcConfigOption *silc_config_find_option(SilcConfigEntity ent,
168 SilcConfigOption *tmp;
169 for (tmp = ent->opts; tmp; tmp = tmp->next) {
170 if (!strcasecmp(tmp->name, name))
175 /* Converts a string in the type specified. returns a dynamically
176 * allocated pointer. */
177 static void *silc_config_marshall(SilcConfigType type, const char *val)
186 case SILC_CONFIG_ARG_TOGGLE:
187 if (!strcasecmp(val, "yes") || !strcasecmp(val, "true") ||
188 !strcasecmp(val, "on") || !strcasecmp(val, "1")) {
191 else if (!strcasecmp(val, "no") || !strcasecmp(val, "false") ||
192 !strcasecmp(val, "off") || !strcasecmp(val, "0")) {
197 pt = silc_calloc(1, sizeof(val_bool));
198 *(bool *)pt = (bool) val_bool;
200 case SILC_CONFIG_ARG_INT:
201 val_int = (int) strtol(val, &val_tmp, 0);
202 if (*val_tmp) /* error converting string */
204 pt = silc_calloc(1, sizeof(val_int));
205 *(int *)pt = val_int;
207 case SILC_CONFIG_ARG_SIZE:
208 val_size = (SilcUInt32) strtol(val, &val_tmp, 0);
210 return NULL; /* really wrong, there must be at least one digit */
211 /* Search for a designator */
212 switch (tolower(val_tmp[0])) {
213 case '\0': /* None */
215 case 'k': /* Kilobytes */
216 val_size *= (SilcUInt32) 1024;
218 case 'm': /* Megabytes */
219 val_size *= (SilcUInt32) (1024 * 1024);
222 val_size *= (SilcUInt32) (1024 * 1024 * 1024);
227 /* the string must die here */
230 pt = silc_calloc(1, sizeof(val_size));
231 *(SilcUInt32 *)pt = val_size;
233 case SILC_CONFIG_ARG_STR: /* the only difference between STR and STRE is */
234 if (!val[0]) /* that STR cannot be empty, while STRE can. */
236 case SILC_CONFIG_ARG_STRE:
237 pt = (void *) strdup(val);
239 /* following types are not supposed to have a return value */
240 case SILC_CONFIG_ARG_BLOCK:
241 case SILC_CONFIG_ARG_NONE:
250 /* End of internal functions */
253 /* Tries to open the config file and returns a valid SilcConfigFile object
254 * or NULL if failed */
256 SilcConfigFile *silc_config_open(const char *configfile)
262 if (!(buffer = silc_file_readfile(configfile, &filelen)))
265 ret = silc_calloc(1, sizeof(*ret));
266 ret->filename = strdup(configfile);
267 ret->base = ret->p = buffer;
269 ret->line = 1; /* line count, start from first line */
273 /* Frees a file object */
275 void silc_config_close(SilcConfigFile *file)
278 silc_free(file->filename);
279 memset(file->base, 'F', file->len);
280 silc_free(file->base);
281 memset(file, 'F', sizeof(*file));
286 /* initializes a SilcConfigEntity pointer allocation */
288 SilcConfigEntity silc_config_init(SilcConfigFile *file)
290 SilcConfigEntity ret;
295 SILC_CONFIG_DEBUG(("Allocating new config entity"));
296 ret = silc_calloc(1, sizeof(*ret));
301 /* Returns the original filename of the object file */
303 char *silc_config_get_filename(SilcConfigFile *file)
306 return file->filename;
310 /* Returns the current line that file parsing arrived at */
312 SilcUInt32 silc_config_get_line(SilcConfigFile *file)
319 /* Returns a pointer to the beginning of the requested line. If the line
320 * was not found, NULL is returned */
322 char *silc_config_read_line(SilcConfigFile *file, SilcUInt32 line)
326 char *ret = NULL, *endbuf;
328 if (!file || (line <= 0))
330 for (p = file->base; *p && (*p != EOF); p++) {
339 if ((endbuf = strchr(p, '\n'))) {
342 ret = silc_memdup(p, len);
344 ret = silc_memdup(p, strlen(p));
349 /* Convenience function to read the current parsed line */
351 char *silc_config_read_current_line(SilcConfigFile *file)
353 return silc_config_read_line(file, file->line);
356 /* (Private) destroy a SilcConfigEntity */
358 static void silc_config_destroy(SilcConfigEntity ent, bool destroy_opts)
360 SilcConfigOption *oldopt, *nextopt;
361 SILC_CONFIG_DEBUG(("Freeing config entity [ent=0x%x] [opts=0x%x]",
362 (SilcUInt32) ent, (SilcUInt32) ent->opts));
364 /* if she wants to preserve options just free the object struct */
368 for (oldopt = ent->opts; oldopt; oldopt = nextopt) {
369 nextopt = oldopt->next;
370 memset(oldopt->name, 'F', strlen(oldopt->name) + 1);
371 silc_free(oldopt->name);
372 memset(oldopt, 'F', sizeof(*oldopt));
377 memset(ent, 'F', sizeof(*ent));
381 /* Registers a new option in the specified entity.
382 * Returns TRUE on success, FALSE if already registered. */
384 bool silc_config_register(SilcConfigEntity ent, const char *name,
385 SilcConfigType type, SilcConfigCallback cb,
386 const SilcConfigTable *subtable, void *context)
388 SilcConfigOption *newopt;
389 SILC_CONFIG_DEBUG(("Register new option=\"%s\" "
390 "type=%u cb=0x%08x context=0x%08x",
391 name, type, (SilcUInt32) cb, (SilcUInt32) context));
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))
397 /* don't register a reserved tag */
398 if (!strcasecmp(name, "include"))
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));
407 /* allocate and append the new option */
408 newopt = silc_calloc(1, sizeof(*newopt));
409 newopt->name = strdup(name);
412 newopt->subtable = subtable;
413 newopt->context = context;
415 /* append this option to the list */
419 SilcConfigOption *tmp;
420 for (tmp = ent->opts; tmp->next; tmp = tmp->next);
426 /* Register a new option table in the specified config entity */
428 bool silc_config_register_table(SilcConfigEntity ent,
429 const SilcConfigTable table[], void *context)
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))
446 static int silc_config_main_internal(SilcConfigEntity ent)
448 SilcConfigFile *file = ent->file;
451 /* loop throught statements */
454 SilcConfigOption *thisopt;
456 /* makes it pointing to the next interesting char */
457 my_skip_comments(file);
459 if (**p == '\0' || **p == EOF) {
460 if (file->level > 1) /* cannot get eof in a sub-level! */
461 return SILC_CONFIG_EEXPECTED;
464 /* check if we completed this (sub) section (it doesn't matter if this
465 * is the main section) */
467 if (file->level < 2) /* can't be! must be at least one sub-block */
468 return SILC_CONFIG_EUNEXPECTED;
472 //SILC_LOG_HEXDUMP(("Preparing lookup at line=%lu", file->line), *p, 16);
474 /* obtain the keyword */
475 my_next_token(file, buf);
476 SILC_CONFIG_DEBUG(("Looking up keyword=\"%s\" [line=%lu]",
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);
582 int ret = 0; /* very important in case of no cb */
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 /* since we have to free "pt" both on failure and on success, we
603 assume that ret == 0 if we didn't actually call any cb. */
606 SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
616 return SILC_CONFIG_OK;
621 int silc_config_main(SilcConfigEntity ent)
623 SilcConfigFile *file = ent->file;
626 /* don't silently accept a NULL entity */
628 ret = SILC_CONFIG_EGENERIC;
632 /* call the real main and store the result */
634 SILC_CONFIG_DEBUG(("[Lev=%d] Entering config parsing core", file->level));
635 ret = silc_config_main_internal(ent);
636 SILC_CONFIG_DEBUG(("[Lev=%d] Quitting main [ret=%d]", file->level, ret));
637 if (!file->level) /* when swap happens, we could close a file twice */
641 /* If this file was included don't destroy the options set because it is
642 * the same of the including block. Although if this entity is in a
643 * sub-block created inside the included file, this options set must be
646 if ((file->level != 0) || (file->included != TRUE))
647 silc_config_destroy(ent, TRUE);
649 silc_config_destroy(ent, FALSE);