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
20 #include <sys/types.h>
32 #include "uci_internal.h"
35 #define LINEBUF_MAX 4096
38 * Fetch a new line from the input stream and resize buffer if necessary
40 __private void uci_getln(struct uci_context *ctx, int offset)
42 struct uci_parse_context *pctx = ctx->pctx;
46 if (pctx->buf == NULL) {
47 pctx->buf = uci_malloc(ctx, LINEBUF);
48 pctx->bufsz = LINEBUF;
56 p = fgets(p, pctx->bufsz - ofs, pctx->file);
61 if (pctx->buf[ofs - 1] == '\n') {
63 pctx->buf[ofs - 1] = 0;
67 if (pctx->bufsz > LINEBUF_MAX/2)
68 uci_parse_error(ctx, p, "line too long");
71 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
77 * parse a character escaped by '\'
78 * returns true if the escaped character is to be parsed
79 * returns false if the escaped character is to be ignored
81 static inline bool parse_backslash(struct uci_context *ctx, char **str)
86 /* undecoded backslash at the end of line, fetch the next line */
89 uci_getln(ctx, *str - ctx->pctx->buf);
93 /* FIXME: decode escaped char, necessary? */
98 * move the string pointer forward until a non-whitespace character or
101 static void skip_whitespace(struct uci_context *ctx, char **str)
104 while (**str && isspace(**str))
108 if (!parse_backslash(ctx, str))
113 static inline void addc(char **dest, char **src)
121 * parse a double quoted string argument from the command line
123 static void parse_double_quote(struct uci_context *ctx, char **str, char **target)
127 /* skip quote character */
130 while ((c = **str)) {
137 if (!parse_backslash(ctx, str))
145 uci_parse_error(ctx, *str, "unterminated \"");
149 * parse a single quoted string argument from the command line
151 static void parse_single_quote(struct uci_context *ctx, char **str, char **target)
154 /* skip quote character */
157 while ((c = **str)) {
167 uci_parse_error(ctx, *str, "unterminated '");
171 * parse a string from the command line and detect the quoting style
173 static void parse_str(struct uci_context *ctx, char **str, char **target)
179 parse_single_quote(ctx, str, target);
182 parse_double_quote(ctx, str, target);
193 if (!parse_backslash(ctx, str))
200 } while (**str && !isspace(**str));
204 * if the string was unquoted and we've stopped at a whitespace
205 * character, skip to the next one, because the whitespace will
206 * be overwritten by a null byte here
211 /* terminate the parsed string */
216 * extract the next argument from the command line
218 static char *next_arg(struct uci_context *ctx, char **str, bool required, bool name)
224 skip_whitespace(ctx, str);
229 parse_str(ctx, str, &ptr);
233 uci_parse_error(ctx, *str, "insufficient arguments");
237 if (name && !uci_validate_name(val))
238 uci_parse_error(ctx, val, "invalid character in field");
244 int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result)
247 UCI_ASSERT(ctx, str != NULL);
248 UCI_ASSERT(ctx, result != NULL);
250 if (ctx->pctx && (ctx->pctx->file != stream))
254 uci_alloc_parse_context(ctx);
256 ctx->pctx->file = stream;
260 *str = ctx->pctx->buf;
263 *result = next_arg(ctx, str, false, false);
269 uci_fill_ptr(struct uci_context *ctx, struct uci_ptr *ptr, struct uci_element *e, bool complete)
271 UCI_ASSERT(ctx, ptr != NULL);
272 UCI_ASSERT(ctx, e != NULL);
274 memset(ptr, 0, sizeof(struct uci_ptr));
276 case UCI_TYPE_OPTION:
277 ptr->o = uci_to_option(e);
279 case UCI_TYPE_SECTION:
280 ptr->s = uci_to_section(e);
282 case UCI_TYPE_PACKAGE:
283 ptr->p = uci_to_package(e);
286 UCI_THROW(ctx, UCI_ERR_INVAL);
290 ptr->option = ptr->o->e.name;
291 ptr->s = ptr->o->section;
293 ptr->section = ptr->s->e.name;
294 ptr->p = ptr->s->package;
296 ptr->package = ptr->p->e.name;
298 ptr->flags |= UCI_LOOKUP_DONE;
300 ptr->flags |= UCI_LOOKUP_COMPLETE;
308 * verify that the end of the line or command is reached.
309 * throw an error if extra arguments are given on the command line
311 static void assert_eol(struct uci_context *ctx, char **str)
315 skip_whitespace(ctx, str);
316 tmp = next_arg(ctx, str, false, false);
317 if (*tmp && (ctx->flags & UCI_FLAG_STRICT))
318 uci_parse_error(ctx, *str, "too many arguments");
322 * switch to a different config, either triggered by uci_load, or by a
323 * 'package <...>' statement in the import file
325 static void uci_switch_config(struct uci_context *ctx)
327 struct uci_parse_context *pctx;
328 struct uci_element *e;
334 /* add the last config to main config file list */
336 pctx->package->backend = ctx->backend;
337 uci_list_add(&ctx->root, &pctx->package->e.list);
339 pctx->package = NULL;
340 pctx->section = NULL;
347 * if an older config under the same name exists, unload it
348 * ignore errors here, e.g. if the config was not found
350 e = uci_lookup_list(&ctx->root, name);
352 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
353 pctx->package = uci_alloc_package(ctx, name);
357 * parse the 'package' uci command (next config package)
359 static void uci_parse_package(struct uci_context *ctx, char **str, bool single)
363 /* command string null-terminated by strtok */
364 *str += strlen(*str) + 1;
366 name = next_arg(ctx, str, true, true);
367 assert_eol(ctx, str);
371 ctx->pctx->name = name;
372 uci_switch_config(ctx);
376 * parse the 'config' uci command (open a section)
378 static void uci_parse_config(struct uci_context *ctx, char **str)
380 struct uci_parse_context *pctx = ctx->pctx;
381 struct uci_element *e;
386 uci_fixup_section(ctx, ctx->pctx->section);
387 if (!ctx->pctx->package) {
388 if (!ctx->pctx->name)
389 uci_parse_error(ctx, *str, "attempting to import a file without a package name");
391 uci_switch_config(ctx);
394 /* command string null-terminated by strtok */
395 *str += strlen(*str) + 1;
397 type = next_arg(ctx, str, true, false);
398 if (!uci_validate_type(type))
399 uci_parse_error(ctx, type, "invalid character in field");
400 name = next_arg(ctx, str, false, true);
401 assert_eol(ctx, str);
404 ctx->internal = !pctx->merge;
405 UCI_NESTED(uci_add_section, ctx, pctx->package, type, &pctx->section);
407 uci_fill_ptr(ctx, &ptr, &pctx->package->e, false);
408 e = uci_lookup_list(&pctx->package->sections, name);
410 ptr.s = uci_to_section(e);
414 ctx->internal = !pctx->merge;
415 UCI_NESTED(uci_set, ctx, &ptr);
416 pctx->section = uci_to_section(ptr.last);
421 * parse the 'option' uci command (open a value)
423 static void uci_parse_option(struct uci_context *ctx, char **str, bool list)
425 struct uci_parse_context *pctx = ctx->pctx;
426 struct uci_element *e;
432 uci_parse_error(ctx, *str, "option/list command found before the first section");
434 /* command string null-terminated by strtok */
435 *str += strlen(*str) + 1;
437 name = next_arg(ctx, str, true, true);
438 value = next_arg(ctx, str, false, false);
439 assert_eol(ctx, str);
441 uci_fill_ptr(ctx, &ptr, &pctx->section->e, false);
442 e = uci_lookup_list(&pctx->section->options, name);
444 ptr.o = uci_to_option(e);
448 ctx->internal = !pctx->merge;
450 UCI_NESTED(uci_add_list, ctx, &ptr);
452 UCI_NESTED(uci_set, ctx, &ptr);
456 * parse a complete input line, split up combined commands by ';'
458 static void uci_parse_line(struct uci_context *ctx, bool single)
460 struct uci_parse_context *pctx = ctx->pctx;
466 word = strtok_r(word, " \t", &brk);
475 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
476 uci_parse_package(ctx, &word, single);
481 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
482 uci_parse_config(ctx, &word);
487 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
488 uci_parse_option(ctx, &word, false);
493 if ((word[1] == 0) || !strcmp(word + 1, "ist"))
494 uci_parse_option(ctx, &word, true);
503 uci_parse_error(ctx, word, "invalid command");
507 /* max number of characters that escaping adds to the string */
508 #define UCI_QUOTE_ESCAPE "'\\''"
511 * escape an uci string for export
513 static char *uci_escape(struct uci_context *ctx, const char *str)
519 ctx->bufsz = LINEBUF;
520 ctx->buf = malloc(LINEBUF);
526 end = strchr(str, '\'');
528 end = str + strlen(str);
531 /* make sure that we have enough room in the buffer */
532 while (ofs + len + sizeof(UCI_QUOTE_ESCAPE) + 1 > ctx->bufsz) {
534 ctx->buf = uci_realloc(ctx, ctx->buf, ctx->bufsz);
537 /* copy the string until the character before the quote */
538 memcpy(&ctx->buf[ofs], str, len);
541 /* end of string? return the buffer */
545 memcpy(&ctx->buf[ofs], UCI_QUOTE_ESCAPE, sizeof(UCI_QUOTE_ESCAPE));
546 ofs += strlen(&ctx->buf[ofs]);
555 * export a single config package to a file stream
557 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
559 struct uci_context *ctx = p->ctx;
560 struct uci_element *s, *o, *i;
563 fprintf(stream, "package '%s'\n", uci_escape(ctx, p->e.name));
564 uci_foreach_element(&p->sections, s) {
565 struct uci_section *sec = uci_to_section(s);
566 fprintf(stream, "\nconfig '%s'", uci_escape(ctx, sec->type));
567 if (!sec->anonymous || (ctx->flags & UCI_FLAG_EXPORT_NAME))
568 fprintf(stream, " '%s'", uci_escape(ctx, sec->e.name));
569 fprintf(stream, "\n");
570 uci_foreach_element(&sec->options, o) {
571 struct uci_option *opt = uci_to_option(o);
573 case UCI_TYPE_STRING:
574 fprintf(stream, "\toption '%s'", uci_escape(ctx, opt->e.name));
575 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->v.string));
578 uci_foreach_element(&opt->v.list, i) {
579 fprintf(stream, "\tlist '%s'", uci_escape(ctx, opt->e.name));
580 fprintf(stream, " '%s'\n", uci_escape(ctx, i->name));
584 fprintf(stream, "\t# unknown type for option '%s'\n", uci_escape(ctx, opt->e.name));
589 fprintf(stream, "\n");
592 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
594 struct uci_element *e;
597 UCI_ASSERT(ctx, stream != NULL);
600 uci_export_package(package, stream, header);
602 uci_foreach_element(&ctx->root, e) {
603 uci_export_package(uci_to_package(e), stream, header);
610 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
612 struct uci_parse_context *pctx;
615 /* make sure no memory from previous parse attempts is leaked */
618 uci_alloc_parse_context(ctx);
621 if (*package && single) {
622 pctx->package = *package;
627 * If 'name' was supplied, assume that the supplied stream does not contain
628 * the appropriate 'package <name>' string to specify the config name
629 * NB: the config file can still override the package name
632 UCI_ASSERT(ctx, uci_validate_package(name));
636 while (!feof(pctx->file)) {
638 UCI_TRAP_SAVE(ctx, error);
640 uci_parse_line(ctx, single);
641 UCI_TRAP_RESTORE(ctx);
644 if (ctx->flags & UCI_FLAG_PERROR)
645 uci_perror(ctx, NULL);
646 if ((ctx->err != UCI_ERR_PARSE) ||
647 (ctx->flags & UCI_FLAG_STRICT))
648 UCI_THROW(ctx, ctx->err);
651 uci_fixup_section(ctx, ctx->pctx->section);
652 if (!pctx->package && name)
653 uci_switch_config(ctx);
655 *package = pctx->package;
657 pctx->package = NULL;
660 uci_switch_config(ctx);
662 /* no error happened, we can get rid of the parser context now */
669 static char *uci_config_path(struct uci_context *ctx, const char *name)
673 UCI_ASSERT(ctx, uci_validate_package(name));
674 filename = uci_malloc(ctx, strlen(name) + strlen(ctx->confdir) + 2);
675 sprintf(filename, "%s/%s", ctx->confdir, name);
680 void uci_file_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)
682 struct uci_package *p = *package;
689 p->path = uci_config_path(ctx, p->e.name);
691 UCI_THROW(ctx, UCI_ERR_INVAL);
694 /* open the config file for writing now, so that it is locked */
695 f = uci_open_stream(ctx, p->path, SEEK_SET, true, true);
697 /* flush unsaved changes and reload from history file */
698 UCI_TRAP_SAVE(ctx, done);
699 if (p->has_history) {
701 name = uci_strdup(ctx, p->e.name);
702 path = uci_strdup(ctx, p->path);
703 /* dump our own changes to the history file */
704 if (!uci_list_empty(&p->history))
705 UCI_INTERNAL(uci_save, ctx, p);
708 * other processes might have modified the config
709 * as well. dump and reload
711 uci_free_package(&p);
713 UCI_INTERNAL(uci_import, ctx, f, name, &p, true);
716 p->has_history = true;
719 /* freed together with the uci_package */
724 if (!uci_load_history(ctx, p, true))
729 if (ftruncate(fileno(f), 0) < 0)
730 UCI_THROW(ctx, UCI_ERR_IO);
732 uci_export(ctx, f, p, false);
733 UCI_TRAP_RESTORE(ctx);
742 UCI_THROW(ctx, ctx->err);
747 * This function returns the filename by returning the string
748 * after the last '/' character. By checking for a non-'\0'
749 * character afterwards, directories are ignored (glob marks
750 * those with a trailing '/'
752 static inline char *get_filename(char *path)
756 p = strrchr(path, '/');
763 static char **uci_list_config_files(struct uci_context *ctx)
771 dir = uci_malloc(ctx, strlen(ctx->confdir) + 1 + sizeof("/*"));
772 sprintf(dir, "%s/*", ctx->confdir);
773 if (glob(dir, GLOB_MARK, NULL, &globbuf) != 0) {
775 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
778 size = sizeof(char *) * (globbuf.gl_pathc + 1);
779 for(i = 0; i < globbuf.gl_pathc; i++) {
782 p = get_filename(globbuf.gl_pathv[i]);
786 size += strlen(p) + 1;
789 configs = uci_malloc(ctx, size);
790 buf = (char *) &configs[globbuf.gl_pathc + 1];
791 for(i = 0; i < globbuf.gl_pathc; i++) {
794 p = get_filename(globbuf.gl_pathv[i]);
798 if (!uci_validate_package(p))
803 buf += strlen(buf) + 1;
810 static struct uci_package *uci_file_load(struct uci_context *ctx, const char *name)
812 struct uci_package *package = NULL;
819 /* relative path outside of /etc/config */
821 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
824 /* absolute path outside of /etc/config */
825 filename = uci_strdup(ctx, name);
826 name = strrchr(name, '/') + 1;
830 /* config in /etc/config */
831 filename = uci_config_path(ctx, name);
836 file = uci_open_stream(ctx, filename, SEEK_SET, false, false);
838 UCI_TRAP_SAVE(ctx, done);
839 UCI_INTERNAL(uci_import, ctx, file, name, &package, true);
840 UCI_TRAP_RESTORE(ctx);
843 package->path = filename;
844 package->has_history = confdir;
845 uci_load_history(ctx, package, false);
849 uci_close_stream(file);
851 UCI_THROW(ctx, ctx->err);
855 __private UCI_BACKEND(uci_file_backend, "file",
856 .load = uci_file_load,
857 .commit = uci_file_commit,
858 .list_configs = uci_list_config_files,