2 * libuci - Library for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
5 * this program is free software; you can redistribute it and/or modify
6 * it under the terms of the gnu lesser general public license version 2.1
7 * as published by the free software foundation
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 * This file contains the code for parsing uci config files
19 #include <sys/types.h>
27 #define LINEBUF_MAX 4096
30 * Fetch a new line from the input stream and resize buffer if necessary
32 static void uci_getln(struct uci_context *ctx, int offset)
34 struct uci_parse_context *pctx = ctx->pctx;
38 if (pctx->buf == NULL) {
39 pctx->buf = uci_malloc(ctx, LINEBUF);
40 pctx->bufsz = LINEBUF;
48 p = fgets(p, pctx->bufsz - ofs, pctx->file);
53 if (pctx->buf[ofs - 1] == '\n') {
55 pctx->buf[ofs - 1] = 0;
59 if (pctx->bufsz > LINEBUF_MAX/2) {
60 pctx->reason = "line too long";
61 pctx->byte = LINEBUF_MAX;
62 UCI_THROW(ctx, UCI_ERR_PARSE);
66 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
71 * Clean up all extra memory used by the parser and exporter
73 static void uci_file_cleanup(struct uci_context *ctx)
75 struct uci_parse_context *pctx;
89 uci_free_package(pctx->package);
100 * parse a character escaped by '\'
101 * returns true if the escaped character is to be parsed
102 * returns false if the escaped character is to be ignored
104 static inline bool parse_backslash(struct uci_context *ctx, char **str)
109 /* undecoded backslash at the end of line, fetch the next line */
112 uci_getln(ctx, *str - ctx->pctx->buf);
116 /* FIXME: decode escaped char, necessary? */
121 * move the string pointer forward until a non-whitespace character or
124 static void skip_whitespace(struct uci_context *ctx, char **str)
127 while (**str && isspace(**str))
131 if (!parse_backslash(ctx, str))
136 static inline void addc(char **dest, char **src)
144 * parse a double quoted string argument from the command line
146 static void parse_double_quote(struct uci_context *ctx, char **str, char **target)
150 /* skip quote character */
153 while ((c = **str)) {
160 if (!parse_backslash(ctx, str))
168 ctx->pctx->reason = "unterminated \"";
169 ctx->pctx->byte = *str - ctx->pctx->buf;
170 UCI_THROW(ctx, UCI_ERR_PARSE);
174 * parse a single quoted string argument from the command line
176 static void parse_single_quote(struct uci_context *ctx, char **str, char **target)
179 /* skip quote character */
182 while ((c = **str)) {
192 ctx->pctx->reason = "unterminated '";
193 ctx->pctx->byte = *str - ctx->pctx->buf;
194 UCI_THROW(ctx, UCI_ERR_PARSE);
198 * parse a string from the command line and detect the quoting style
200 static void parse_str(struct uci_context *ctx, char **str, char **target)
205 parse_single_quote(ctx, str, target);
208 parse_double_quote(ctx, str, target);
213 if (!parse_backslash(ctx, str))
220 } while (**str && !isspace(**str));
224 * if the string was unquoted and we've stopped at a whitespace
225 * character, skip to the next one, because the whitespace will
226 * be overwritten by a null byte here
231 /* terminate the parsed string */
236 * extract the next argument from the command line
238 static char *next_arg(struct uci_context *ctx, char **str, bool required)
244 skip_whitespace(ctx, str);
245 parse_str(ctx, str, &ptr);
246 if (required && !*val) {
247 ctx->pctx->reason = "insufficient arguments";
248 ctx->pctx->byte = *str - ctx->pctx->buf;
249 UCI_THROW(ctx, UCI_ERR_PARSE);
256 * verify that the end of the line or command is reached.
257 * throw an error if extra arguments are given on the command line
259 static void assert_eol(struct uci_context *ctx, char **str)
263 tmp = next_arg(ctx, str, false);
265 ctx->pctx->reason = "too many arguments";
266 ctx->pctx->byte = tmp - ctx->pctx->buf;
267 UCI_THROW(ctx, UCI_ERR_PARSE);
272 * switch to a different config, either triggered by uci_load, or by a
273 * 'package <...>' statement in the import file
275 static void uci_switch_config(struct uci_context *ctx)
277 struct uci_parse_context *pctx;
278 struct uci_element *e;
284 /* add the last config to main config file list */
286 uci_list_add(&ctx->root, &pctx->package->e.list);
288 pctx->package = NULL;
289 pctx->section = NULL;
296 * if an older config under the same name exists, unload it
297 * ignore errors here, e.g. if the config was not found
299 UCI_TRAP_SAVE(ctx, ignore);
300 e = uci_lookup_list(ctx, &ctx->root, name);
302 uci_unload(ctx, uci_to_package(e));
303 UCI_TRAP_RESTORE(ctx);
307 pctx->package = uci_alloc_package(ctx, name);
311 * parse the 'package' uci command (next config package)
313 static void uci_parse_package(struct uci_context *ctx, char **str)
317 /* command string null-terminated by strtok */
318 *str += strlen(*str) + 1;
320 name = next_arg(ctx, str, true);
321 assert_eol(ctx, str);
322 ctx->pctx->name = name;
323 uci_switch_config(ctx);
327 * parse the 'config' uci command (open a section)
329 static void uci_parse_config(struct uci_context *ctx, char **str)
334 if (!ctx->pctx->package) {
335 if (!ctx->pctx->name) {
336 ctx->pctx->byte = *str - ctx->pctx->buf;
337 ctx->pctx->reason = "attempting to import a file without a package name";
338 UCI_THROW(ctx, UCI_ERR_PARSE);
340 uci_switch_config(ctx);
343 /* command string null-terminated by strtok */
344 *str += strlen(*str) + 1;
346 type = next_arg(ctx, str, true);
347 name = next_arg(ctx, str, false);
348 assert_eol(ctx, str);
349 ctx->pctx->section = uci_alloc_section(ctx->pctx->package, type, name);
353 * parse the 'option' uci command (open a value)
355 static void uci_parse_option(struct uci_context *ctx, char **str)
360 if (!ctx->pctx->section) {
361 ctx->pctx->byte = *str - ctx->pctx->buf;
362 ctx->pctx->reason = "option command found before the first section";
363 UCI_THROW(ctx, UCI_ERR_PARSE);
365 /* command string null-terminated by strtok */
366 *str += strlen(*str) + 1;
368 name = next_arg(ctx, str, true);
369 value = next_arg(ctx, str, true);
370 assert_eol(ctx, str);
371 uci_alloc_option(ctx->pctx->section, name, value);
376 * parse a complete input line, split up combined commands by ';'
378 static void uci_parse_line(struct uci_context *ctx)
380 struct uci_parse_context *pctx = ctx->pctx;
381 char *word, *brk = NULL;
383 for (word = strtok_r(pctx->buf, ";", &brk);
385 word = strtok_r(NULL, ";", &brk)) {
388 word = strtok_r(word, " \t", &pbrk);
392 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
393 uci_parse_package(ctx, &word);
396 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
397 uci_parse_config(ctx, &word);
400 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
401 uci_parse_option(ctx, &word);
404 pctx->reason = "unterminated command";
405 pctx->byte = word - pctx->buf;
406 UCI_THROW(ctx, UCI_ERR_PARSE);
412 /* max number of characters that escaping adds to the string */
413 #define UCI_QUOTE_ESCAPE "'\\'"
416 * escape an uci string for export
418 static char *uci_escape(struct uci_context *ctx, char *str)
424 ctx->bufsz = LINEBUF;
425 ctx->buf = malloc(LINEBUF);
429 p = strchr(str, '\'');
436 if (p + sizeof(UCI_QUOTE_ESCAPE) - str >= ctx->bufsz) {
438 ctx->buf = realloc(ctx->buf, ctx->bufsz);
440 UCI_THROW(ctx, UCI_ERR_MEM);
442 memcpy(&ctx->buf[pos], s, len);
445 strcpy(&ctx->buf[pos], UCI_QUOTE_ESCAPE);
446 pos += sizeof(UCI_QUOTE_ESCAPE);
448 } while ((p = strchr(s, '\'')));
455 * export a single config package to a file stream
457 static void uci_export_package(struct uci_package *p, FILE *stream)
459 struct uci_context *ctx = p->ctx;
460 struct uci_element *s, *o;
462 fprintf(stream, "package '%s'\n", uci_escape(ctx, p->e.name));
463 uci_foreach_element(&p->sections, s) {
464 struct uci_section *sec = uci_to_section(s);
465 fprintf(stream, "\nconfig '%s'", uci_escape(ctx, sec->type));
466 fprintf(stream, " '%s'\n", uci_escape(ctx, sec->e.name));
467 uci_foreach_element(&sec->options, o) {
468 struct uci_option *opt = uci_to_option(o);
469 fprintf(stream, "\toption '%s'", uci_escape(ctx, opt->e.name));
470 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->value));
473 fprintf(stream, "\n");
476 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package)
478 struct uci_element *e;
481 UCI_ASSERT(ctx, stream != NULL);
484 uci_export_package(package, stream);
488 uci_foreach_element(&ctx->root, e) {
489 uci_export_package(uci_to_package(e), stream);
495 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package)
497 struct uci_parse_context *pctx;
499 /* make sure no memory from previous parse attempts is leaked */
500 uci_file_cleanup(ctx);
502 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
507 * If 'name' was supplied, assume that the supplied stream does not contain
508 * the appropriate 'package <name>' string to specify the config name
509 * NB: the config file can still override the package name
514 while (!feof(pctx->file)) {
521 *package = pctx->package;
524 uci_switch_config(ctx);
526 /* no error happened, we can get rid of the parser context now */
527 uci_file_cleanup(ctx);
532 int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package)
541 UCI_ASSERT(ctx, name != NULL);
546 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
549 /* absolute/relative path outside of /etc/config */
550 filename = uci_strdup(ctx, name);
551 name = strrchr(name, '/') + 1;
555 filename = uci_malloc(ctx, strlen(name) + sizeof(UCI_CONFDIR) + 2);
556 sprintf(filename, UCI_CONFDIR "/%s", name);
561 if ((stat(filename, &statbuf) < 0) ||
562 ((statbuf.st_mode & S_IFMT) != S_IFREG)) {
563 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
566 fd = open(filename, O_RDONLY);
568 UCI_THROW(ctx, UCI_ERR_IO);
571 file = fdopen(fd, "r");
573 UCI_THROW(ctx, UCI_ERR_IO);
576 UCI_TRAP_SAVE(ctx, done);
577 uci_import(ctx, file, name, package);
578 UCI_TRAP_RESTORE(ctx);
581 (*package)->path = filename;
582 (*package)->confdir = confdir;
592 * This function returns the filename by returning the string
593 * after the last '/' character. By checking for a non-'\0'
594 * character afterwards, directories are ignored (glob marks
595 * those with a trailing '/'
597 static inline char *get_filename(char *path)
601 p = strrchr(path, '/');
608 char **uci_list_configs(struct uci_context *ctx)
615 if (glob(UCI_CONFDIR "/*", GLOB_MARK, NULL, &globbuf) != 0)
618 size = sizeof(char *) * (globbuf.gl_pathc + 1);
619 for(i = 0; i < globbuf.gl_pathc; i++) {
622 p = get_filename(globbuf.gl_pathv[i]);
626 size += strlen(p) + 1;
629 configs = malloc(size);
633 memset(configs, 0, size);
634 buf = (char *) &configs[globbuf.gl_pathc + 1];
635 for(i = 0; i < globbuf.gl_pathc; i++) {
638 p = get_filename(globbuf.gl_pathv[i]);
644 buf += strlen(buf) + 1;