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; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
21 #include "silcincludes.h"
23 /* limit debug logging verbosity */
25 #define SILC_CONFIG_DEBUG(fmt) SILC_LOG_DEBUG(fmt)
27 #define SILC_CONFIG_DEBUG(fmt)
30 /* this is the option struct and currently it is only used internally to
31 * the module and other structs. */
32 typedef struct SilcConfigOptionStruct {
33 char *name; /* *lowercase* name of the option */
34 SilcConfigType type; /* important: the type of the returned value */
35 SilcConfigCallback cb; /* the value handler */
36 const SilcConfigTable *subtable; /* used if type is SILC_CONFIG_ARG_BLOCK */
37 void *context; /* context passed to the callback function */
38 struct SilcConfigOptionStruct *next;
41 /* unique for each config file (and included ones) */
42 struct SilcConfigFileObject {
43 char *filename; /* the original filename opened */
44 int level; /* parsing level, how many nested
45 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 SilcBool 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;
97 while ((*r != '\0' && *r != EOF) && isspace(*r))
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 != '\0' && *r != EOF) && (*r != '\n') && (*r != '\r')) r++;
106 file->p = ((*r != '\0' && *r != EOF) ? 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))
174 /* Converts a string in the type specified. returns a dynamically
175 * allocated pointer. */
176 static void *silc_config_marshall(SilcConfigType type, const char *val)
180 SilcBool val_boolean;
185 case SILC_CONFIG_ARG_TOGGLE:
186 if (!strcasecmp(val, "yes") || !strcasecmp(val, "true") ||
187 !strcasecmp(val, "on") || !strcasecmp(val, "1")) {
190 else if (!strcasecmp(val, "no") || !strcasecmp(val, "false") ||
191 !strcasecmp(val, "off") || !strcasecmp(val, "0")) {
196 pt = silc_calloc(1, sizeof(val_boolean));
197 *(SilcBool *)pt = (SilcBool) val_boolean;
199 case SILC_CONFIG_ARG_INT:
200 val_int = (int) strtol(val, &val_tmp, 0);
201 if (*val_tmp) /* error converting string */
203 pt = silc_calloc(1, sizeof(val_int));
204 *(int *)pt = val_int;
206 case SILC_CONFIG_ARG_SIZE:
207 val_size = (SilcUInt32) strtol(val, &val_tmp, 0);
209 return NULL; /* really wrong, there must be at least one digit */
210 /* Search for a designator */
211 switch (tolower(val_tmp[0])) {
212 case '\0': /* None */
214 case 'k': /* Kilobytes */
215 val_size *= (SilcUInt32) 1024;
217 case 'm': /* Megabytes */
218 val_size *= (SilcUInt32) (1024 * 1024);
221 val_size *= (SilcUInt32) (1024 * 1024 * 1024);
226 /* the string must die here */
229 pt = silc_calloc(1, sizeof(val_size));
230 *(SilcUInt32 *)pt = val_size;
232 case SILC_CONFIG_ARG_STR: /* the only difference between STR and STRE is */
233 if (!val[0]) /* that STR cannot be empty, while STRE can. */
235 case SILC_CONFIG_ARG_STRE:
236 pt = (void *) strdup(val);
238 /* following types are not supposed to have a return value */
239 case SILC_CONFIG_ARG_BLOCK:
240 case SILC_CONFIG_ARG_NONE:
249 /* End of internal functions */
252 /* Tries to open the config file and returns a valid SilcConfigFile object
253 * or NULL if failed */
255 SilcConfigFile *silc_config_open(const char *configfile)
261 if (!(buffer = silc_file_readfile(configfile, &filelen)))
264 ret = silc_calloc(1, sizeof(*ret));
265 ret->filename = strdup(configfile);
266 ret->base = ret->p = buffer;
268 ret->line = 1; /* line count, start from first line */
272 /* Frees a file object */
274 void silc_config_close(SilcConfigFile *file)
277 silc_free(file->filename);
278 memset(file->base, 'F', file->len);
279 silc_free(file->base);
280 memset(file, 'F', sizeof(*file));
285 /* initializes a SilcConfigEntity pointer allocation */
287 SilcConfigEntity silc_config_init(SilcConfigFile *file)
289 SilcConfigEntity ret;
294 SILC_CONFIG_DEBUG(("Allocating new config entity"));
295 ret = silc_calloc(1, sizeof(*ret));
300 /* Returns the original filename of the object file */
302 char *silc_config_get_filename(SilcConfigFile *file)
305 return file->filename;
309 /* Returns the current line that file parsing arrived at */
311 SilcUInt32 silc_config_get_line(SilcConfigFile *file)
318 /* Returns a pointer to the beginning of the requested line. If the line
319 * was not found, NULL is returned */
321 char *silc_config_read_line(SilcConfigFile *file, SilcUInt32 line)
325 char *ret = NULL, *endbuf;
327 if (!file || (line <= 0))
329 for (p = file->base; *p && (*p != EOF); p++) {
338 if ((endbuf = strchr(p, '\n'))) {
341 ret = silc_memdup(p, len);
343 ret = silc_memdup(p, strlen(p));
348 /* Convenience function to read the current parsed line */
350 char *silc_config_read_current_line(SilcConfigFile *file)
352 return silc_config_read_line(file, file->line);
355 /* (Private) destroy a SilcConfigEntity */
357 static void silc_config_destroy(SilcConfigEntity ent, SilcBool destroy_opts)
359 SilcConfigOption *oldopt, *nextopt;
360 SILC_CONFIG_DEBUG(("Freeing config entity [ent=0x%x] [opts=0x%x]",
361 (SilcUInt32) ent, (SilcUInt32) ent->opts));
363 /* if she wants to preserve options just free the object struct */
367 for (oldopt = ent->opts; oldopt; oldopt = nextopt) {
368 nextopt = oldopt->next;
369 memset(oldopt->name, 'F', strlen(oldopt->name) + 1);
370 silc_free(oldopt->name);
371 memset(oldopt, 'F', sizeof(*oldopt));
376 memset(ent, 'F', sizeof(*ent));
380 /* Registers a new option in the specified entity.
381 * Returns TRUE on success, FALSE if already registered. */
383 SilcBool silc_config_register(SilcConfigEntity ent, const char *name,
384 SilcConfigType type, SilcConfigCallback cb,
385 const SilcConfigTable *subtable, void *context)
387 SilcConfigOption *newopt;
388 SILC_CONFIG_DEBUG(("Register new option=\"%s\" "
389 "type=%u cb=0x%08x context=0x%08x",
390 name, type, (SilcUInt32) cb, (SilcUInt32) context));
392 /* if we are registering a block, make sure there is a specified sub-table */
393 if (!ent || !name || ((type == SILC_CONFIG_ARG_BLOCK) && !subtable))
396 /* don't register a reserved tag */
397 if (!strcasecmp(name, "include"))
400 /* check if an option was previously registered */
401 if (silc_config_find_option(ent, name)) {
402 SILC_LOG_DEBUG(("Error: Can't register \"%s\" twice.", name));
406 /* allocate and append the new option */
407 newopt = silc_calloc(1, sizeof(*newopt));
408 newopt->name = strdup(name);
411 newopt->subtable = subtable;
412 newopt->context = context;
414 /* append this option to the list */
418 SilcConfigOption *tmp;
419 for (tmp = ent->opts; tmp->next; tmp = tmp->next);
425 /* Register a new option table in the specified config entity */
427 SilcBool silc_config_register_table(SilcConfigEntity ent,
428 const SilcConfigTable table[], void *context)
433 SILC_CONFIG_DEBUG(("Registering table"));
434 /* XXX FIXME: some potability checks needed - really? */
435 for (i = 0; table[i].name; i++) {
436 if (!silc_config_register(ent, table[i].name, table[i].type,
437 table[i].callback, table[i].subtable, context))
445 static int silc_config_main_internal(SilcConfigEntity ent)
447 SilcConfigFile *file = ent->file;
450 /* loop throught statements */
453 SilcConfigOption *thisopt;
455 /* makes it pointing to the next interesting char */
456 my_skip_comments(file);
458 if (**p == '\0' || **p == EOF) {
459 if (file->level > 1) /* cannot get eof in a sub-level! */
460 return SILC_CONFIG_EEXPECTED;
463 /* check if we completed this (sub) section (it doesn't matter if this
464 * is the main section) */
466 if (file->level < 2) /* can't be! must be at least one sub-block */
467 return SILC_CONFIG_EUNEXPECTED;
471 //SILC_LOG_HEXDUMP(("Preparing lookup at line=%lu", file->line), *p, 16);
473 /* obtain the keyword */
474 my_next_token(file, buf);
475 SILC_CONFIG_DEBUG(("Looking up keyword=\"%s\" [line=%lu]",
478 /* handle special directive */
479 if (!strcasecmp(buf, "include")) {
481 SilcConfigFile *inc_file;
482 SilcConfigEntity inc_ent;
484 my_trim_spaces(file); /* prepare next char */
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. */
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 */
495 return SILC_CONFIG_EMISSCOLON;
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;
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);
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. */
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));
523 /* otherwise if no errors encoured, continue normally */
524 silc_config_close(inc_file);
525 continue; /* this one is handled */
528 /* we have a registered option (it can also be a sub-block) */
529 thisopt = silc_config_find_option(ent, buf);
531 return SILC_CONFIG_EBADOPTION;
533 my_trim_spaces(file); /* prepare next char */
535 /* option type is a block? */
536 if (thisopt->type == SILC_CONFIG_ARG_BLOCK) {
538 SilcConfigEntity sub_ent;
540 SILC_CONFIG_DEBUG(("Entering sub-block"));
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));
551 if (ret) /* now check the result */
554 /* now call block clean-up callback (if any) */
557 SILC_CONFIG_DEBUG(("Now calling clean-up callback"));
558 ret = thisopt->cb(thisopt->type, thisopt->name, file->line, NULL,
561 SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
565 /* Do we want ';' to be mandatory after close brace? */
567 return SILC_CONFIG_EMISSCOLON;
569 else if (thisopt->type == SILC_CONFIG_ARG_NONE) {
570 /* before getting on, check if this row is REALLY complete */
572 return SILC_CONFIG_EMISSCOLON;
573 SILC_CONFIG_DEBUG(("Triggering callback for none"));
575 thisopt->cb(thisopt->type, thisopt->name, file->line,
576 NULL, thisopt->context);
581 int ret = 0; /* very important in case of no cb */
584 return SILC_CONFIG_EEXPECTEDEQUAL;
586 my_get_string(file, buf); /* get the option argument */
587 SILC_CONFIG_DEBUG(("With argument=\"%s\"", buf));
589 /* before getting on, check if this row is REALLY complete */
591 return SILC_CONFIG_EMISSCOLON;
593 /* convert the option argument to the right format */
594 pt = silc_config_marshall(thisopt->type, buf);
596 return SILC_CONFIG_EINVALIDTEXT;
598 ret = thisopt->cb(thisopt->type, thisopt->name, file->line,
599 pt, thisopt->context);
601 /* since we have to free "pt" both on failure and on success, we
602 assume that ret == 0 if we didn't actually call any cb. */
605 SILC_CONFIG_DEBUG(("Callback refused the value [ret=%d]", ret));
615 return SILC_CONFIG_OK;
620 int silc_config_main(SilcConfigEntity ent)
622 SilcConfigFile *file = ent->file;
625 /* don't silently accept a NULL entity */
627 ret = SILC_CONFIG_EGENERIC;
631 /* call the real main and store the result */
633 SILC_CONFIG_DEBUG(("[Lev=%d] Entering config parsing core", file->level));
634 ret = silc_config_main_internal(ent);
635 SILC_CONFIG_DEBUG(("[Lev=%d] Quitting main [ret=%d]", file->level, ret));
636 if (!file->level) /* when swap happens, we could close a file twice */
640 /* If this file was included don't destroy the options set because it is
641 * the same of the including block. Although if this entity is in a
642 * sub-block created inside the included file, this options set must be
645 if ((file->level != 0) || (file->included != TRUE))
646 silc_config_destroy(ent, TRUE);
648 silc_config_destroy(ent, FALSE);