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)
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_name(pctx_str(pctx, val)))
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;
284 *str = ctx->pctx->buf;
286 UCI_ASSERT(ctx, ctx->pctx->pos == *str - ctx->pctx->buf);
289 /*FIXME do we need to skip empty lines? */
290 ofs_result = next_arg(ctx, false, false);
291 *result = pctx_str(ctx->pctx, ofs_result);
292 *str = pctx_cur_str(ctx->pctx);
298 uci_fill_ptr(struct uci_context *ctx, struct uci_ptr *ptr, struct uci_element *e)
300 UCI_ASSERT(ctx, ptr != NULL);
301 UCI_ASSERT(ctx, e != NULL);
303 memset(ptr, 0, sizeof(struct uci_ptr));
305 case UCI_TYPE_OPTION:
306 ptr->o = uci_to_option(e);
308 case UCI_TYPE_SECTION:
309 ptr->s = uci_to_section(e);
311 case UCI_TYPE_PACKAGE:
312 ptr->p = uci_to_package(e);
315 UCI_THROW(ctx, UCI_ERR_INVAL);
319 ptr->option = ptr->o->e.name;
320 ptr->s = ptr->o->section;
322 ptr->section = ptr->s->e.name;
323 ptr->p = ptr->s->package;
325 ptr->package = ptr->p->e.name;
327 ptr->flags |= UCI_LOOKUP_DONE;
335 * verify that the end of the line or command is reached.
336 * throw an error if extra arguments are given on the command line
338 static void assert_eol(struct uci_context *ctx)
343 skip_whitespace(ctx);
344 ofs_tmp = next_arg(ctx, false, false);
345 tmp = pctx_str(ctx->pctx, ofs_tmp);
346 if (*tmp && (ctx->flags & UCI_FLAG_STRICT))
347 uci_parse_error(ctx, "too many arguments");
351 * switch to a different config, either triggered by uci_load, or by a
352 * 'package <...>' statement in the import file
354 static void uci_switch_config(struct uci_context *ctx)
356 struct uci_parse_context *pctx;
357 struct uci_element *e;
363 /* add the last config to main config file list */
365 pctx->package->backend = ctx->backend;
366 uci_list_add(&ctx->root, &pctx->package->e.list);
368 pctx->package = NULL;
369 pctx->section = NULL;
376 * if an older config under the same name exists, unload it
377 * ignore errors here, e.g. if the config was not found
379 e = uci_lookup_list(&ctx->root, name);
381 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
382 pctx->package = uci_alloc_package(ctx, name);
386 * parse the 'package' uci command (next config package)
388 static void uci_parse_package(struct uci_context *ctx, bool single)
390 struct uci_parse_context *pctx = ctx->pctx;
394 /* command string null-terminated by strtok */
395 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
397 ofs_name = next_arg(ctx, true, true);
398 name = pctx_str(pctx, ofs_name);
403 ctx->pctx->name = name;
404 uci_switch_config(ctx);
408 * parse the 'config' uci command (open a section)
410 static void uci_parse_config(struct uci_context *ctx)
412 struct uci_parse_context *pctx = ctx->pctx;
413 struct uci_element *e;
415 int ofs_name, ofs_type;
419 uci_fixup_section(ctx, ctx->pctx->section);
420 if (!ctx->pctx->package) {
421 if (!ctx->pctx->name)
422 uci_parse_error(ctx, "attempting to import a file without a package name");
424 uci_switch_config(ctx);
427 /* command string null-terminated by strtok */
428 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
430 ofs_type = next_arg(ctx, true, false);
431 type = pctx_str(pctx, ofs_type);
432 if (!uci_validate_type(type))
433 uci_parse_error(ctx, "invalid character in type field");
435 ofs_name = next_arg(ctx, false, true);
436 type = pctx_str(pctx, ofs_type);
437 name = pctx_str(pctx, ofs_name);
440 if (!name || !name[0]) {
441 ctx->internal = !pctx->merge;
442 UCI_NESTED(uci_add_section, ctx, pctx->package, type, &pctx->section);
444 uci_fill_ptr(ctx, &ptr, &pctx->package->e);
445 e = uci_lookup_list(&pctx->package->sections, name);
447 ptr.s = uci_to_section(e);
451 ctx->internal = !pctx->merge;
452 UCI_NESTED(uci_set, ctx, &ptr);
453 pctx->section = uci_to_section(ptr.last);
458 * parse the 'option' uci command (open a value)
460 static void uci_parse_option(struct uci_context *ctx, bool list)
462 struct uci_parse_context *pctx = ctx->pctx;
463 struct uci_element *e;
465 int ofs_name, ofs_value;
470 uci_parse_error(ctx, "option/list command found before the first section");
472 /* command string null-terminated by strtok */
473 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
475 ofs_name = next_arg(ctx, true, true);
476 ofs_value = next_arg(ctx, false, false);
477 name = pctx_str(pctx, ofs_name);
478 value = pctx_str(pctx, ofs_value);
481 uci_fill_ptr(ctx, &ptr, &pctx->section->e);
482 e = uci_lookup_list(&pctx->section->options, name);
484 ptr.o = uci_to_option(e);
488 ctx->internal = !pctx->merge;
490 UCI_NESTED(uci_add_list, ctx, &ptr);
492 UCI_NESTED(uci_set, ctx, &ptr);
496 * parse a complete input line, split up combined commands by ';'
498 static void uci_parse_line(struct uci_context *ctx, bool single)
500 struct uci_parse_context *pctx = ctx->pctx;
503 /* Skip whitespace characters at the start of line */
504 skip_whitespace(ctx);
506 word = strtok(pctx_cur_str(pctx), " \t");
515 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
516 uci_parse_package(ctx, single);
521 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
522 uci_parse_config(ctx);
527 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
528 uci_parse_option(ctx, false);
533 if ((word[1] == 0) || !strcmp(word + 1, "ist"))
534 uci_parse_option(ctx, true);
543 uci_parse_error(ctx, "invalid command");
547 /* max number of characters that escaping adds to the string */
548 #define UCI_QUOTE_ESCAPE "'\\''"
551 * escape an uci string for export
553 static const char *uci_escape(struct uci_context *ctx, const char *str)
559 ctx->bufsz = LINEBUF;
560 ctx->buf = malloc(LINEBUF);
569 end = strchr(str, '\'');
571 end = str + strlen(str);
574 /* make sure that we have enough room in the buffer */
575 while (ofs + len + sizeof(UCI_QUOTE_ESCAPE) + 1 > ctx->bufsz) {
577 ctx->buf = uci_realloc(ctx, ctx->buf, ctx->bufsz);
580 /* copy the string until the character before the quote */
581 memcpy(&ctx->buf[ofs], str, len);
584 /* end of string? return the buffer */
588 memcpy(&ctx->buf[ofs], UCI_QUOTE_ESCAPE, sizeof(UCI_QUOTE_ESCAPE));
589 ofs += strlen(&ctx->buf[ofs]);
598 * export a single config package to a file stream
600 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
602 struct uci_context *ctx = p->ctx;
603 struct uci_element *s, *o, *i;
606 fprintf(stream, "package %s\n", uci_escape(ctx, p->e.name));
607 uci_foreach_element(&p->sections, s) {
608 struct uci_section *sec = uci_to_section(s);
609 fprintf(stream, "\nconfig %s", uci_escape(ctx, sec->type));
610 if (!sec->anonymous || (ctx->flags & UCI_FLAG_EXPORT_NAME))
611 fprintf(stream, " '%s'", uci_escape(ctx, sec->e.name));
612 fprintf(stream, "\n");
613 uci_foreach_element(&sec->options, o) {
614 struct uci_option *opt = uci_to_option(o);
616 case UCI_TYPE_STRING:
617 fprintf(stream, "\toption %s", uci_escape(ctx, opt->e.name));
618 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->v.string));
621 uci_foreach_element(&opt->v.list, i) {
622 fprintf(stream, "\tlist %s", uci_escape(ctx, opt->e.name));
623 fprintf(stream, " '%s'\n", uci_escape(ctx, i->name));
627 fprintf(stream, "\t# unknown type for option '%s'\n", uci_escape(ctx, opt->e.name));
632 fprintf(stream, "\n");
635 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
637 struct uci_element *e;
640 UCI_ASSERT(ctx, stream != NULL);
643 uci_export_package(package, stream, header);
645 uci_foreach_element(&ctx->root, e) {
646 uci_export_package(uci_to_package(e), stream, header);
653 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
655 struct uci_parse_context *pctx;
658 /* make sure no memory from previous parse attempts is leaked */
661 uci_alloc_parse_context(ctx);
664 if (package && *package && single) {
665 pctx->package = *package;
670 * If 'name' was supplied, assume that the supplied stream does not contain
671 * the appropriate 'package <name>' string to specify the config name
672 * NB: the config file can still override the package name
675 UCI_ASSERT(ctx, uci_validate_package(name));
679 while (!feof(pctx->file)) {
682 UCI_TRAP_SAVE(ctx, error);
684 uci_parse_line(ctx, single);
685 UCI_TRAP_RESTORE(ctx);
688 if (ctx->flags & UCI_FLAG_PERROR)
689 uci_perror(ctx, NULL);
690 if ((ctx->err != UCI_ERR_PARSE) ||
691 (ctx->flags & UCI_FLAG_STRICT))
692 UCI_THROW(ctx, ctx->err);
695 uci_fixup_section(ctx, ctx->pctx->section);
696 if (!pctx->package && name)
697 uci_switch_config(ctx);
699 *package = pctx->package;
701 pctx->package = NULL;
704 uci_switch_config(ctx);
706 /* no error happened, we can get rid of the parser context now */
713 static char *uci_config_path(struct uci_context *ctx, const char *name)
717 UCI_ASSERT(ctx, uci_validate_package(name));
718 filename = uci_malloc(ctx, strlen(name) + strlen(ctx->confdir) + 2);
719 sprintf(filename, "%s/%s", ctx->confdir, name);
724 static void uci_file_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)
726 struct uci_package *p = *package;
727 FILE *f1, *f2 = NULL;
730 char *filename = NULL;
732 bool do_rename = false;
736 p->path = uci_config_path(ctx, p->e.name);
738 UCI_THROW(ctx, UCI_ERR_INVAL);
741 if ((asprintf(&filename, "%s/.%s.uci-XXXXXX", ctx->confdir, p->e.name) < 0) || !filename)
742 UCI_THROW(ctx, UCI_ERR_MEM);
744 if (!mktemp(filename))
749 UCI_THROW(ctx, UCI_ERR_IO);
752 if ((stat(filename, &statbuf) == 0) && ((statbuf.st_mode & S_IFMT) != S_IFREG))
753 UCI_THROW(ctx, UCI_ERR_IO);
755 /* open the config file for writing now, so that it is locked */
756 f1 = uci_open_stream(ctx, p->path, NULL, SEEK_SET, true, true);
758 /* flush unsaved changes and reload from delta file */
759 UCI_TRAP_SAVE(ctx, done);
762 name = uci_strdup(ctx, p->e.name);
763 path = uci_strdup(ctx, p->path);
764 /* dump our own changes to the delta file */
765 if (!uci_list_empty(&p->delta))
766 UCI_INTERNAL(uci_save, ctx, p);
769 * other processes might have modified the config
770 * as well. dump and reload
772 uci_free_package(&p);
774 UCI_INTERNAL(uci_import, ctx, f1, name, &p, true);
780 /* freed together with the uci_package */
785 if (!uci_load_delta(ctx, p, true))
789 f2 = uci_open_stream(ctx, filename, p->path, SEEK_SET, true, true);
790 uci_export(ctx, f2, p, false);
794 uci_close_stream(f2);
798 UCI_TRAP_RESTORE(ctx);
803 uci_close_stream(f1);
804 if (do_rename && rename(filename, p->path)) {
806 UCI_THROW(ctx, UCI_ERR_IO);
811 UCI_THROW(ctx, ctx->err);
816 * This function returns the filename by returning the string
817 * after the last '/' character. By checking for a non-'\0'
818 * character afterwards, directories are ignored (glob marks
819 * those with a trailing '/'
821 static inline char *get_filename(char *path)
825 p = strrchr(path, '/');
832 static char **uci_list_config_files(struct uci_context *ctx)
840 dir = uci_malloc(ctx, strlen(ctx->confdir) + 1 + sizeof("/*"));
841 sprintf(dir, "%s/*", ctx->confdir);
842 if (glob(dir, GLOB_MARK, NULL, &globbuf) != 0) {
844 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
847 size = sizeof(char *) * (globbuf.gl_pathc + 1);
848 for(i = 0; i < globbuf.gl_pathc; i++) {
851 p = get_filename(globbuf.gl_pathv[i]);
855 size += strlen(p) + 1;
858 configs = uci_malloc(ctx, size);
859 buf = (char *) &configs[globbuf.gl_pathc + 1];
860 for(i = 0; i < globbuf.gl_pathc; i++) {
863 p = get_filename(globbuf.gl_pathv[i]);
867 if (!uci_validate_package(p))
872 buf += strlen(buf) + 1;
879 static struct uci_package *uci_file_load(struct uci_context *ctx, const char *name)
881 struct uci_package *package = NULL;
888 /* relative path outside of /etc/config */
890 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
893 /* absolute path outside of /etc/config */
894 filename = uci_strdup(ctx, name);
895 name = strrchr(name, '/') + 1;
899 /* config in /etc/config */
900 filename = uci_config_path(ctx, name);
905 UCI_TRAP_SAVE(ctx, done);
906 file = uci_open_stream(ctx, filename, NULL, SEEK_SET, false, false);
908 UCI_INTERNAL(uci_import, ctx, file, name, &package, true);
909 UCI_TRAP_RESTORE(ctx);
912 package->path = filename;
913 package->has_delta = confdir;
914 uci_load_delta(ctx, package, false);
918 uci_close_stream(file);
921 UCI_THROW(ctx, ctx->err);
926 __private UCI_BACKEND(uci_file_backend, "file",
927 .load = uci_file_load,
928 .commit = uci_file_commit,
929 .list_configs = uci_list_config_files,