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 Lesser General Public License for more details.
16 * This file contains the code for parsing uci config files
20 #include <sys/types.h>
33 #include "uci_internal.h"
36 #define LINEBUF_MAX 4096
39 * Fetch a new line from the input stream and resize buffer if necessary
41 __private void uci_getln(struct uci_context *ctx, int offset)
43 struct uci_parse_context *pctx = ctx->pctx;
47 if (pctx->buf == NULL) {
48 pctx->buf = uci_malloc(ctx, LINEBUF);
49 pctx->bufsz = LINEBUF;
51 /* It takes 2 slots for fgets to read 1 char. */
52 if (offset >= pctx->bufsz - 1) {
54 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
62 p = fgets(p, pctx->bufsz - ofs, pctx->file);
67 if (pctx->buf[ofs - 1] == '\n') {
72 if (pctx->bufsz > LINEBUF_MAX/2)
73 uci_parse_error(ctx, "line too long");
76 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
81 * parse a character escaped by '\'
82 * returns true if the escaped character is to be parsed
83 * returns false if the escaped character is to be ignored
85 static bool parse_backslash(struct uci_context *ctx)
87 struct uci_parse_context *pctx = ctx->pctx;
92 /* undecoded backslash at the end of line, fetch the next line */
93 if (!pctx_cur_char(pctx) ||
94 pctx_cur_char(pctx) == '\n' ||
95 (pctx_cur_char(pctx) == '\r' &&
96 pctx_char(pctx, pctx_pos(pctx) + 1) == '\n' &&
97 !pctx_char(pctx, pctx_pos(pctx) + 2))) {
98 uci_getln(ctx, pctx->pos);
102 /* FIXME: decode escaped char, necessary? */
107 * move the string pointer forward until a non-whitespace character or
110 static void skip_whitespace(struct uci_context *ctx)
112 struct uci_parse_context *pctx = ctx->pctx;
114 while (pctx_cur_char(pctx) && isspace(pctx_cur_char(pctx)))
118 static inline void addc(struct uci_context *ctx, int *pos_dest, int *pos_src)
120 struct uci_parse_context *pctx = ctx->pctx;
122 pctx_char(pctx, *pos_dest) = pctx_char(pctx, *pos_src);
128 * parse a double quoted string argument from the command line
130 static void parse_double_quote(struct uci_context *ctx, int *target)
132 struct uci_parse_context *pctx = ctx->pctx;
135 /* skip quote character */
139 c = pctx_cur_char(pctx);
145 /* Multi-line str value */
146 uci_getln(ctx, pctx->pos);
147 if (!pctx_cur_char(pctx)) {
148 uci_parse_error(ctx, "EOF with unterminated \"");
152 if (!parse_backslash(ctx))
156 addc(ctx, target, &pctx->pos);
163 * parse a single quoted string argument from the command line
165 static void parse_single_quote(struct uci_context *ctx, int *target)
167 struct uci_parse_context *pctx = ctx->pctx;
169 /* skip quote character */
173 c = pctx_cur_char(pctx);
179 /* Multi-line str value */
180 uci_getln(ctx, pctx->pos);
181 if (!pctx_cur_char(pctx))
182 uci_parse_error(ctx, "EOF with unterminated '");
186 addc(ctx, target, &pctx->pos);
192 * parse a string from the command line and detect the quoting style
194 static void parse_str(struct uci_context *ctx, int *target)
196 struct uci_parse_context *pctx = ctx->pctx;
199 switch(pctx_cur_char(pctx)) {
201 parse_single_quote(ctx, target);
204 parse_double_quote(ctx, target);
207 pctx_cur_char(pctx) = 0;
215 if (!parse_backslash(ctx))
219 addc(ctx, target, &pctx->pos);
222 } while (pctx_cur_char(pctx) && !isspace(pctx_cur_char(pctx)));
226 * if the string was unquoted and we've stopped at a whitespace
227 * character, skip to the next one, because the whitespace will
228 * be overwritten by a null byte here
230 if (pctx_cur_char(pctx) && next)
233 /* terminate the parsed string */
234 pctx_char(pctx, *target) = 0;
238 * extract the next argument from the command line
240 static int next_arg(struct uci_context *ctx, bool required, bool name, bool package)
242 struct uci_parse_context *pctx = ctx->pctx;
245 skip_whitespace(ctx);
246 val = ptr = pctx_pos(pctx);
247 if (pctx_cur_char(pctx) == ';') {
248 pctx_cur_char(pctx) = 0;
251 parse_str(ctx, &ptr);
253 if (!pctx_char(pctx, val)) {
255 uci_parse_error(ctx, "insufficient arguments");
259 if (name && !uci_validate_str(pctx_str(pctx, val), name, package))
260 uci_parse_error(ctx, "invalid character in name field");
266 int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result)
271 UCI_ASSERT(ctx, str != NULL);
272 UCI_ASSERT(ctx, result != NULL);
274 if (ctx->pctx && (ctx->pctx->file != stream))
278 uci_alloc_parse_context(ctx);
280 ctx->pctx->file = stream;
286 ofs_result = next_arg(ctx, false, false, false);
287 *result = pctx_str(ctx->pctx, ofs_result);
288 *str = pctx_cur_str(ctx->pctx);
294 uci_fill_ptr(struct uci_context *ctx, struct uci_ptr *ptr, struct uci_element *e)
296 UCI_ASSERT(ctx, ptr != NULL);
297 UCI_ASSERT(ctx, e != NULL);
299 memset(ptr, 0, sizeof(struct uci_ptr));
301 case UCI_TYPE_OPTION:
302 ptr->o = uci_to_option(e);
304 case UCI_TYPE_SECTION:
305 ptr->s = uci_to_section(e);
307 case UCI_TYPE_PACKAGE:
308 ptr->p = uci_to_package(e);
311 UCI_THROW(ctx, UCI_ERR_INVAL);
315 ptr->option = ptr->o->e.name;
316 ptr->s = ptr->o->section;
318 ptr->section = ptr->s->e.name;
319 ptr->p = ptr->s->package;
321 ptr->package = ptr->p->e.name;
323 ptr->flags |= UCI_LOOKUP_DONE;
331 * verify that the end of the line or command is reached.
332 * throw an error if extra arguments are given on the command line
334 static void assert_eol(struct uci_context *ctx)
339 skip_whitespace(ctx);
340 ofs_tmp = next_arg(ctx, false, false, false);
341 tmp = pctx_str(ctx->pctx, ofs_tmp);
342 if (*tmp && (ctx->flags & UCI_FLAG_STRICT))
343 uci_parse_error(ctx, "too many arguments");
347 * switch to a different config, either triggered by uci_load, or by a
348 * 'package <...>' statement in the import file
350 static void uci_switch_config(struct uci_context *ctx)
352 struct uci_parse_context *pctx;
353 struct uci_element *e;
359 /* add the last config to main config file list */
361 pctx->package->backend = ctx->backend;
362 uci_list_add(&ctx->root, &pctx->package->e.list);
364 pctx->package = NULL;
365 pctx->section = NULL;
372 * if an older config under the same name exists, unload it
373 * ignore errors here, e.g. if the config was not found
375 e = uci_lookup_list(&ctx->root, name);
377 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
378 pctx->package = uci_alloc_package(ctx, name);
382 * parse the 'package' uci command (next config package)
384 static void uci_parse_package(struct uci_context *ctx, bool single)
386 struct uci_parse_context *pctx = ctx->pctx;
390 /* command string null-terminated by strtok */
391 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
393 ofs_name = next_arg(ctx, true, true, true);
394 name = pctx_str(pctx, ofs_name);
399 ctx->pctx->name = name;
400 uci_switch_config(ctx);
404 * parse the 'config' uci command (open a section)
406 static void uci_parse_config(struct uci_context *ctx)
408 struct uci_parse_context *pctx = ctx->pctx;
409 struct uci_element *e;
411 int ofs_name, ofs_type;
415 uci_fixup_section(ctx, ctx->pctx->section);
416 if (!ctx->pctx->package) {
417 if (!ctx->pctx->name)
418 uci_parse_error(ctx, "attempting to import a file without a package name");
420 uci_switch_config(ctx);
423 /* command string null-terminated by strtok */
424 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
426 ofs_type = next_arg(ctx, true, false, false);
427 type = pctx_str(pctx, ofs_type);
428 if (!uci_validate_type(type))
429 uci_parse_error(ctx, "invalid character in type field");
431 ofs_name = next_arg(ctx, false, true, false);
432 type = pctx_str(pctx, ofs_type);
433 name = pctx_str(pctx, ofs_name);
436 if (!name || !name[0]) {
437 ctx->internal = !pctx->merge;
438 UCI_NESTED(uci_add_section, ctx, pctx->package, type, &pctx->section);
440 uci_fill_ptr(ctx, &ptr, &pctx->package->e);
441 e = uci_lookup_list(&pctx->package->sections, name);
443 ptr.s = uci_to_section(e);
447 ctx->internal = !pctx->merge;
448 UCI_NESTED(uci_set, ctx, &ptr);
449 pctx->section = uci_to_section(ptr.last);
454 * parse the 'option' uci command (open a value)
456 static void uci_parse_option(struct uci_context *ctx, bool list)
458 struct uci_parse_context *pctx = ctx->pctx;
459 struct uci_element *e;
461 int ofs_name, ofs_value;
466 uci_parse_error(ctx, "option/list command found before the first section");
468 /* command string null-terminated by strtok */
469 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
471 ofs_name = next_arg(ctx, true, true, false);
472 ofs_value = next_arg(ctx, false, false, false);
473 name = pctx_str(pctx, ofs_name);
474 value = pctx_str(pctx, ofs_value);
477 uci_fill_ptr(ctx, &ptr, &pctx->section->e);
478 e = uci_lookup_list(&pctx->section->options, name);
480 ptr.o = uci_to_option(e);
484 ctx->internal = !pctx->merge;
486 UCI_NESTED(uci_add_list, ctx, &ptr);
488 UCI_NESTED(uci_set, ctx, &ptr);
492 * parse a complete input line, split up combined commands by ';'
494 static void uci_parse_line(struct uci_context *ctx, bool single)
496 struct uci_parse_context *pctx = ctx->pctx;
499 /* Skip whitespace characters at the start of line */
500 skip_whitespace(ctx);
502 word = strtok(pctx_cur_str(pctx), " \t");
511 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
512 uci_parse_package(ctx, single);
517 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
518 uci_parse_config(ctx);
523 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
524 uci_parse_option(ctx, false);
529 if ((word[1] == 0) || !strcmp(word + 1, "ist"))
530 uci_parse_option(ctx, true);
539 uci_parse_error(ctx, "invalid command");
543 /* max number of characters that escaping adds to the string */
544 #define UCI_QUOTE_ESCAPE "'\\''"
547 * escape an uci string for export
549 static const char *uci_escape(struct uci_context *ctx, const char *str)
555 ctx->bufsz = LINEBUF;
556 ctx->buf = malloc(LINEBUF);
565 end = strchr(str, '\'');
567 end = str + strlen(str);
570 /* make sure that we have enough room in the buffer */
571 while (ofs + len + sizeof(UCI_QUOTE_ESCAPE) + 1 > ctx->bufsz) {
573 ctx->buf = uci_realloc(ctx, ctx->buf, ctx->bufsz);
576 /* copy the string until the character before the quote */
577 memcpy(&ctx->buf[ofs], str, len);
580 /* end of string? return the buffer */
584 memcpy(&ctx->buf[ofs], UCI_QUOTE_ESCAPE, sizeof(UCI_QUOTE_ESCAPE));
585 ofs += strlen(&ctx->buf[ofs]);
594 * export a single config package to a file stream
596 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
598 struct uci_context *ctx = p->ctx;
599 struct uci_element *s, *o, *i;
602 fprintf(stream, "package %s\n", uci_escape(ctx, p->e.name));
603 uci_foreach_element(&p->sections, s) {
604 struct uci_section *sec = uci_to_section(s);
605 fprintf(stream, "\nconfig %s", uci_escape(ctx, sec->type));
606 if (!sec->anonymous || (ctx->flags & UCI_FLAG_EXPORT_NAME))
607 fprintf(stream, " '%s'", uci_escape(ctx, sec->e.name));
608 fprintf(stream, "\n");
609 uci_foreach_element(&sec->options, o) {
610 struct uci_option *opt = uci_to_option(o);
612 case UCI_TYPE_STRING:
613 fprintf(stream, "\toption %s", uci_escape(ctx, opt->e.name));
614 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->v.string));
617 uci_foreach_element(&opt->v.list, i) {
618 fprintf(stream, "\tlist %s", uci_escape(ctx, opt->e.name));
619 fprintf(stream, " '%s'\n", uci_escape(ctx, i->name));
623 fprintf(stream, "\t# unknown type for option '%s'\n", uci_escape(ctx, opt->e.name));
628 fprintf(stream, "\n");
631 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
633 struct uci_element *e;
636 UCI_ASSERT(ctx, stream != NULL);
639 uci_export_package(package, stream, header);
641 uci_foreach_element(&ctx->root, e) {
642 uci_export_package(uci_to_package(e), stream, header);
649 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
651 struct uci_parse_context *pctx;
654 /* make sure no memory from previous parse attempts is leaked */
657 uci_alloc_parse_context(ctx);
660 if (package && *package && single) {
661 pctx->package = *package;
666 * If 'name' was supplied, assume that the supplied stream does not contain
667 * the appropriate 'package <name>' string to specify the config name
668 * NB: the config file can still override the package name
671 UCI_ASSERT(ctx, uci_validate_package(name));
675 while (!feof(pctx->file)) {
678 UCI_TRAP_SAVE(ctx, error);
680 uci_parse_line(ctx, single);
681 UCI_TRAP_RESTORE(ctx);
684 if (ctx->flags & UCI_FLAG_PERROR)
685 uci_perror(ctx, NULL);
686 if ((ctx->err != UCI_ERR_PARSE) ||
687 (ctx->flags & UCI_FLAG_STRICT))
688 UCI_THROW(ctx, ctx->err);
691 uci_fixup_section(ctx, ctx->pctx->section);
692 if (!pctx->package && name)
693 uci_switch_config(ctx);
695 *package = pctx->package;
697 pctx->package = NULL;
700 uci_switch_config(ctx);
702 /* no error happened, we can get rid of the parser context now */
709 static char *uci_config_path(struct uci_context *ctx, const char *name)
713 UCI_ASSERT(ctx, uci_validate_package(name));
714 filename = uci_malloc(ctx, strlen(name) + strlen(ctx->confdir) + 2);
715 sprintf(filename, "%s/%s", ctx->confdir, name);
720 static void uci_file_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)
722 struct uci_package *p = *package;
723 FILE *f1, *f2 = NULL;
726 char *filename = NULL;
728 bool do_rename = false;
732 p->path = uci_config_path(ctx, p->e.name);
734 UCI_THROW(ctx, UCI_ERR_INVAL);
737 if ((asprintf(&filename, "%s/.%s.uci-XXXXXX", ctx->confdir, p->e.name) < 0) || !filename)
738 UCI_THROW(ctx, UCI_ERR_MEM);
740 if (!mktemp(filename))
745 UCI_THROW(ctx, UCI_ERR_IO);
748 if ((stat(filename, &statbuf) == 0) && ((statbuf.st_mode & S_IFMT) != S_IFREG))
749 UCI_THROW(ctx, UCI_ERR_IO);
751 /* open the config file for writing now, so that it is locked */
752 f1 = uci_open_stream(ctx, p->path, NULL, SEEK_SET, true, true);
754 /* flush unsaved changes and reload from delta file */
755 UCI_TRAP_SAVE(ctx, done);
758 name = uci_strdup(ctx, p->e.name);
759 path = uci_strdup(ctx, p->path);
760 /* dump our own changes to the delta file */
761 if (!uci_list_empty(&p->delta))
762 UCI_INTERNAL(uci_save, ctx, p);
765 * other processes might have modified the config
766 * as well. dump and reload
768 uci_free_package(&p);
770 UCI_INTERNAL(uci_import, ctx, f1, name, &p, true);
776 /* freed together with the uci_package */
781 if (!uci_load_delta(ctx, p, true))
785 f2 = uci_open_stream(ctx, filename, p->path, SEEK_SET, true, true);
786 uci_export(ctx, f2, p, false);
790 uci_close_stream(f2);
794 UCI_TRAP_RESTORE(ctx);
799 uci_close_stream(f1);
800 if (do_rename && rename(filename, p->path)) {
802 UCI_THROW(ctx, UCI_ERR_IO);
807 UCI_THROW(ctx, ctx->err);
812 * This function returns the filename by returning the string
813 * after the last '/' character. By checking for a non-'\0'
814 * character afterwards, directories are ignored (glob marks
815 * those with a trailing '/'
817 static inline char *get_filename(char *path)
821 p = strrchr(path, '/');
828 static char **uci_list_config_files(struct uci_context *ctx)
836 dir = uci_malloc(ctx, strlen(ctx->confdir) + 1 + sizeof("/*"));
837 sprintf(dir, "%s/*", ctx->confdir);
838 if (glob(dir, GLOB_MARK, NULL, &globbuf) != 0) {
840 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
843 size = sizeof(char *) * (globbuf.gl_pathc + 1);
844 for(i = 0; i < globbuf.gl_pathc; i++) {
847 p = get_filename(globbuf.gl_pathv[i]);
851 size += strlen(p) + 1;
854 configs = uci_malloc(ctx, size);
855 buf = (char *) &configs[globbuf.gl_pathc + 1];
856 for(i = 0; i < globbuf.gl_pathc; i++) {
859 p = get_filename(globbuf.gl_pathv[i]);
863 if (!uci_validate_package(p))
868 buf += strlen(buf) + 1;
875 static struct uci_package *uci_file_load(struct uci_context *ctx, const char *name)
877 struct uci_package *package = NULL;
884 /* relative path outside of /etc/config */
886 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
889 /* absolute path outside of /etc/config */
890 filename = uci_strdup(ctx, name);
891 name = strrchr(name, '/') + 1;
895 /* config in /etc/config */
896 filename = uci_config_path(ctx, name);
901 UCI_TRAP_SAVE(ctx, done);
902 file = uci_open_stream(ctx, filename, NULL, SEEK_SET, false, false);
904 UCI_INTERNAL(uci_import, ctx, file, name, &package, true);
905 UCI_TRAP_RESTORE(ctx);
908 package->path = filename;
909 package->has_delta = confdir;
910 uci_load_delta(ctx, package, false);
914 uci_close_stream(file);
917 UCI_THROW(ctx, ctx->err);
922 __private UCI_BACKEND(uci_file_backend, "file",
923 .load = uci_file_load,
924 .commit = uci_file_commit,
925 .list_configs = uci_list_config_files,