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"
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;
50 /* It takes 2 slots for fgets to read 1 char. */
51 if (offset >= pctx->bufsz - 1) {
53 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
61 p = fgets(p, pctx->bufsz - ofs, pctx->file);
66 if (pctx->buf[ofs - 1] == '\n') {
72 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
74 UCI_THROW(ctx, UCI_ERR_MEM);
79 * parse a character escaped by '\'
80 * returns true if the escaped character is to be parsed
81 * returns false if the escaped character is to be ignored
83 static bool parse_backslash(struct uci_context *ctx)
85 struct uci_parse_context *pctx = ctx->pctx;
90 /* undecoded backslash at the end of line, fetch the next line */
91 if (!pctx_cur_char(pctx) ||
92 pctx_cur_char(pctx) == '\n' ||
93 (pctx_cur_char(pctx) == '\r' &&
94 pctx_char(pctx, pctx_pos(pctx) + 1) == '\n' &&
95 !pctx_char(pctx, pctx_pos(pctx) + 2))) {
96 uci_getln(ctx, pctx->pos);
100 /* FIXME: decode escaped char, necessary? */
105 * move the string pointer forward until a non-whitespace character or
108 static void skip_whitespace(struct uci_context *ctx)
110 struct uci_parse_context *pctx = ctx->pctx;
112 while (pctx_cur_char(pctx) && isspace(pctx_cur_char(pctx)))
116 static inline void addc(struct uci_context *ctx, int *pos_dest, int *pos_src)
118 struct uci_parse_context *pctx = ctx->pctx;
120 pctx_char(pctx, *pos_dest) = pctx_char(pctx, *pos_src);
126 * parse a double quoted string argument from the command line
128 static void parse_double_quote(struct uci_context *ctx, int *target)
130 struct uci_parse_context *pctx = ctx->pctx;
133 /* skip quote character */
137 c = pctx_cur_char(pctx);
143 /* Multi-line str value */
144 uci_getln(ctx, pctx->pos);
145 if (!pctx_cur_char(pctx)) {
146 uci_parse_error(ctx, "EOF with unterminated \"");
150 if (!parse_backslash(ctx))
154 addc(ctx, target, &pctx->pos);
161 * parse a single quoted string argument from the command line
163 static void parse_single_quote(struct uci_context *ctx, int *target)
165 struct uci_parse_context *pctx = ctx->pctx;
167 /* skip quote character */
171 c = pctx_cur_char(pctx);
177 /* Multi-line str value */
178 uci_getln(ctx, pctx->pos);
179 if (!pctx_cur_char(pctx))
180 uci_parse_error(ctx, "EOF with unterminated '");
184 addc(ctx, target, &pctx->pos);
190 * parse a string from the command line and detect the quoting style
192 static void parse_str(struct uci_context *ctx, int *target)
194 struct uci_parse_context *pctx = ctx->pctx;
197 switch(pctx_cur_char(pctx)) {
199 parse_single_quote(ctx, target);
202 parse_double_quote(ctx, target);
205 pctx_cur_char(pctx) = 0;
213 if (!parse_backslash(ctx))
217 addc(ctx, target, &pctx->pos);
220 } while (pctx_cur_char(pctx) && !isspace(pctx_cur_char(pctx)));
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
228 if (pctx_cur_char(pctx) && next)
231 /* terminate the parsed string */
232 pctx_char(pctx, *target) = 0;
236 * extract the next argument from the command line
238 static int next_arg(struct uci_context *ctx, bool required, bool name, bool package)
240 struct uci_parse_context *pctx = ctx->pctx;
243 skip_whitespace(ctx);
244 val = ptr = pctx_pos(pctx);
245 if (pctx_cur_char(pctx) == ';') {
246 pctx_cur_char(pctx) = 0;
249 parse_str(ctx, &ptr);
251 if (!pctx_char(pctx, val)) {
253 uci_parse_error(ctx, "insufficient arguments");
257 if (name && !uci_validate_str(pctx_str(pctx, val), name, package))
258 uci_parse_error(ctx, "invalid character in name field");
264 int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result)
269 UCI_ASSERT(ctx, str != NULL);
270 UCI_ASSERT(ctx, result != NULL);
272 if (ctx->pctx && (ctx->pctx->file != stream))
276 uci_alloc_parse_context(ctx);
278 ctx->pctx->file = stream;
284 ofs_result = next_arg(ctx, false, false, false);
285 *result = pctx_str(ctx->pctx, ofs_result);
286 *str = pctx_cur_str(ctx->pctx);
292 uci_fill_ptr(struct uci_context *ctx, struct uci_ptr *ptr, struct uci_element *e)
294 UCI_ASSERT(ctx, ptr != NULL);
295 UCI_ASSERT(ctx, e != NULL);
297 memset(ptr, 0, sizeof(struct uci_ptr));
299 case UCI_TYPE_OPTION:
300 ptr->o = uci_to_option(e);
302 case UCI_TYPE_SECTION:
303 ptr->s = uci_to_section(e);
305 case UCI_TYPE_PACKAGE:
306 ptr->p = uci_to_package(e);
309 UCI_THROW(ctx, UCI_ERR_INVAL);
313 ptr->option = ptr->o->e.name;
314 ptr->s = ptr->o->section;
316 ptr->section = ptr->s->e.name;
317 ptr->p = ptr->s->package;
319 ptr->package = ptr->p->e.name;
321 ptr->flags |= UCI_LOOKUP_DONE;
329 * verify that the end of the line or command is reached.
330 * throw an error if extra arguments are given on the command line
332 static void assert_eol(struct uci_context *ctx)
337 skip_whitespace(ctx);
338 ofs_tmp = next_arg(ctx, false, false, false);
339 tmp = pctx_str(ctx->pctx, ofs_tmp);
340 if (*tmp && (ctx->flags & UCI_FLAG_STRICT))
341 uci_parse_error(ctx, "too many arguments");
345 * switch to a different config, either triggered by uci_load, or by a
346 * 'package <...>' statement in the import file
348 static void uci_switch_config(struct uci_context *ctx)
350 struct uci_parse_context *pctx;
351 struct uci_element *e;
357 /* add the last config to main config file list */
359 pctx->package->backend = ctx->backend;
360 uci_list_add(&ctx->root, &pctx->package->e.list);
362 pctx->package = NULL;
363 pctx->section = NULL;
370 * if an older config under the same name exists, unload it
371 * ignore errors here, e.g. if the config was not found
373 e = uci_lookup_list(&ctx->root, name);
375 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
376 pctx->package = uci_alloc_package(ctx, name);
380 * parse the 'package' uci command (next config package)
382 static void uci_parse_package(struct uci_context *ctx, bool single)
384 struct uci_parse_context *pctx = ctx->pctx;
388 /* command string null-terminated by strtok */
389 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
391 ofs_name = next_arg(ctx, true, true, true);
392 name = pctx_str(pctx, ofs_name);
397 ctx->pctx->name = name;
398 uci_switch_config(ctx);
402 * parse the 'config' uci command (open a section)
404 static void uci_parse_config(struct uci_context *ctx)
406 struct uci_parse_context *pctx = ctx->pctx;
407 struct uci_element *e;
409 int ofs_name, ofs_type;
413 uci_fixup_section(ctx, ctx->pctx->section);
414 if (!ctx->pctx->package) {
415 if (!ctx->pctx->name)
416 uci_parse_error(ctx, "attempting to import a file without a package name");
418 uci_switch_config(ctx);
421 /* command string null-terminated by strtok */
422 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
424 ofs_type = next_arg(ctx, true, false, false);
425 type = pctx_str(pctx, ofs_type);
426 if (!uci_validate_type(type))
427 uci_parse_error(ctx, "invalid character in type field");
429 ofs_name = next_arg(ctx, false, true, false);
430 type = pctx_str(pctx, ofs_type);
431 name = pctx_str(pctx, ofs_name);
434 if (!name || !name[0]) {
435 ctx->internal = !pctx->merge;
436 UCI_NESTED(uci_add_section, ctx, pctx->package, type, &pctx->section);
438 uci_fill_ptr(ctx, &ptr, &pctx->package->e);
439 e = uci_lookup_list(&pctx->package->sections, name);
441 ptr.s = uci_to_section(e);
445 ctx->internal = !pctx->merge;
446 UCI_NESTED(uci_set, ctx, &ptr);
447 pctx->section = uci_to_section(ptr.last);
452 * parse the 'option' uci command (open a value)
454 static void uci_parse_option(struct uci_context *ctx, bool list)
456 struct uci_parse_context *pctx = ctx->pctx;
457 struct uci_element *e;
459 int ofs_name, ofs_value;
464 uci_parse_error(ctx, "option/list command found before the first section");
466 /* command string null-terminated by strtok */
467 pctx->pos += strlen(pctx_cur_str(pctx)) + 1;
469 ofs_name = next_arg(ctx, true, true, false);
470 ofs_value = next_arg(ctx, false, false, false);
471 name = pctx_str(pctx, ofs_name);
472 value = pctx_str(pctx, ofs_value);
475 uci_fill_ptr(ctx, &ptr, &pctx->section->e);
476 e = uci_lookup_list(&pctx->section->options, name);
478 ptr.o = uci_to_option(e);
482 ctx->internal = !pctx->merge;
484 UCI_NESTED(uci_add_list, ctx, &ptr);
486 UCI_NESTED(uci_set, ctx, &ptr);
490 * parse a complete input line, split up combined commands by ';'
492 static void uci_parse_line(struct uci_context *ctx, bool single)
494 struct uci_parse_context *pctx = ctx->pctx;
497 /* Skip whitespace characters at the start of line */
498 skip_whitespace(ctx);
500 word = strtok(pctx_cur_str(pctx), " \t");
509 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
510 uci_parse_package(ctx, single);
515 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
516 uci_parse_config(ctx);
521 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
522 uci_parse_option(ctx, false);
527 if ((word[1] == 0) || !strcmp(word + 1, "ist"))
528 uci_parse_option(ctx, true);
537 uci_parse_error(ctx, "invalid command");
541 /* max number of characters that escaping adds to the string */
542 #define UCI_QUOTE_ESCAPE "'\\''"
545 * escape an uci string for export
547 static const char *uci_escape(struct uci_context *ctx, const char *str)
553 ctx->bufsz = LINEBUF;
554 ctx->buf = malloc(LINEBUF);
563 end = strchr(str, '\'');
565 end = str + strlen(str);
568 /* make sure that we have enough room in the buffer */
569 while (ofs + len + sizeof(UCI_QUOTE_ESCAPE) + 1 > ctx->bufsz) {
571 ctx->buf = uci_realloc(ctx, ctx->buf, ctx->bufsz);
574 /* copy the string until the character before the quote */
575 memcpy(&ctx->buf[ofs], str, len);
578 /* end of string? return the buffer */
582 memcpy(&ctx->buf[ofs], UCI_QUOTE_ESCAPE, sizeof(UCI_QUOTE_ESCAPE));
583 ofs += strlen(&ctx->buf[ofs]);
592 * export a single config package to a file stream
594 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
596 struct uci_context *ctx = p->ctx;
597 struct uci_element *s, *o, *i;
600 fprintf(stream, "package %s\n", uci_escape(ctx, p->e.name));
601 uci_foreach_element(&p->sections, s) {
602 struct uci_section *sec = uci_to_section(s);
603 fprintf(stream, "\nconfig %s", uci_escape(ctx, sec->type));
604 if (!sec->anonymous || (ctx->flags & UCI_FLAG_EXPORT_NAME))
605 fprintf(stream, " '%s'", uci_escape(ctx, sec->e.name));
606 fprintf(stream, "\n");
607 uci_foreach_element(&sec->options, o) {
608 struct uci_option *opt = uci_to_option(o);
610 case UCI_TYPE_STRING:
611 fprintf(stream, "\toption %s", uci_escape(ctx, opt->e.name));
612 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->v.string));
615 uci_foreach_element(&opt->v.list, i) {
616 fprintf(stream, "\tlist %s", uci_escape(ctx, opt->e.name));
617 fprintf(stream, " '%s'\n", uci_escape(ctx, i->name));
621 fprintf(stream, "\t# unknown type for option '%s'\n", uci_escape(ctx, opt->e.name));
626 fprintf(stream, "\n");
629 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
631 struct uci_element *e;
634 UCI_ASSERT(ctx, stream != NULL);
637 uci_export_package(package, stream, header);
639 uci_foreach_element(&ctx->root, e) {
640 uci_export_package(uci_to_package(e), stream, header);
647 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
649 struct uci_parse_context *pctx;
652 /* make sure no memory from previous parse attempts is leaked */
655 uci_alloc_parse_context(ctx);
658 if (package && *package && single) {
659 pctx->package = *package;
664 * If 'name' was supplied, assume that the supplied stream does not contain
665 * the appropriate 'package <name>' string to specify the config name
666 * NB: the config file can still override the package name
669 UCI_ASSERT(ctx, uci_validate_package(name));
673 while (!feof(pctx->file)) {
676 UCI_TRAP_SAVE(ctx, error);
678 uci_parse_line(ctx, single);
679 UCI_TRAP_RESTORE(ctx);
682 if (ctx->flags & UCI_FLAG_PERROR)
683 uci_perror(ctx, NULL);
684 if ((ctx->err != UCI_ERR_PARSE) ||
685 (ctx->flags & UCI_FLAG_STRICT))
686 UCI_THROW(ctx, ctx->err);
689 uci_fixup_section(ctx, ctx->pctx->section);
690 if (!pctx->package && name)
691 uci_switch_config(ctx);
693 *package = pctx->package;
695 pctx->package = NULL;
698 uci_switch_config(ctx);
700 /* no error happened, we can get rid of the parser context now */
707 static char *uci_config_path(struct uci_context *ctx, const char *name)
711 UCI_ASSERT(ctx, uci_validate_package(name));
712 filename = uci_malloc(ctx, strlen(name) + strlen(ctx->confdir) + 2);
713 sprintf(filename, "%s/%s", ctx->confdir, name);
718 static void uci_file_commit(struct uci_context *ctx, struct uci_package **package, bool overwrite)
720 struct uci_package *p = *package;
721 FILE *f1, *f2 = NULL;
724 char *filename = NULL;
726 bool do_rename = false;
730 p->path = uci_config_path(ctx, p->e.name);
732 UCI_THROW(ctx, UCI_ERR_INVAL);
735 if ((asprintf(&filename, "%s/.%s.uci-XXXXXX", ctx->confdir, p->e.name) < 0) || !filename)
736 UCI_THROW(ctx, UCI_ERR_MEM);
738 if (!mktemp(filename))
743 UCI_THROW(ctx, UCI_ERR_IO);
746 if ((stat(filename, &statbuf) == 0) && ((statbuf.st_mode & S_IFMT) != S_IFREG))
747 UCI_THROW(ctx, UCI_ERR_IO);
749 /* open the config file for writing now, so that it is locked */
750 f1 = uci_open_stream(ctx, p->path, NULL, SEEK_SET, true, true);
752 /* flush unsaved changes and reload from delta file */
753 UCI_TRAP_SAVE(ctx, done);
756 name = uci_strdup(ctx, p->e.name);
757 path = uci_strdup(ctx, p->path);
758 /* dump our own changes to the delta file */
759 if (!uci_list_empty(&p->delta))
760 UCI_INTERNAL(uci_save, ctx, p);
763 * other processes might have modified the config
764 * as well. dump and reload
766 uci_free_package(&p);
768 UCI_INTERNAL(uci_import, ctx, f1, name, &p, true);
774 /* freed together with the uci_package */
779 if (!uci_load_delta(ctx, p, true))
783 f2 = uci_open_stream(ctx, filename, p->path, SEEK_SET, true, true);
784 uci_export(ctx, f2, p, false);
788 uci_close_stream(f2);
792 UCI_TRAP_RESTORE(ctx);
797 uci_close_stream(f1);
798 if (do_rename && rename(filename, p->path)) {
800 UCI_THROW(ctx, UCI_ERR_IO);
804 UCI_THROW(ctx, ctx->err);
809 * This function returns the filename by returning the string
810 * after the last '/' character. By checking for a non-'\0'
811 * character afterwards, directories are ignored (glob marks
812 * those with a trailing '/'
814 static inline char *get_filename(char *path)
818 p = strrchr(path, '/');
825 static char **uci_list_config_files(struct uci_context *ctx)
833 dir = uci_malloc(ctx, strlen(ctx->confdir) + 1 + sizeof("/*"));
834 sprintf(dir, "%s/*", ctx->confdir);
835 if (glob(dir, GLOB_MARK, NULL, &globbuf) != 0) {
837 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
840 size = sizeof(char *) * (globbuf.gl_pathc + 1);
841 for(i = 0; i < globbuf.gl_pathc; i++) {
844 p = get_filename(globbuf.gl_pathv[i]);
848 size += strlen(p) + 1;
851 configs = uci_malloc(ctx, size);
852 buf = (char *) &configs[globbuf.gl_pathc + 1];
853 for(i = 0; i < globbuf.gl_pathc; i++) {
856 p = get_filename(globbuf.gl_pathv[i]);
860 if (!uci_validate_package(p))
865 buf += strlen(buf) + 1;
872 static struct uci_package *uci_file_load(struct uci_context *ctx, const char *name)
874 struct uci_package *package = NULL;
881 /* relative path outside of /etc/config */
883 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
886 /* absolute path outside of /etc/config */
887 filename = uci_strdup(ctx, name);
888 name = strrchr(name, '/') + 1;
892 /* config in /etc/config */
893 filename = uci_config_path(ctx, name);
898 UCI_TRAP_SAVE(ctx, done);
899 file = uci_open_stream(ctx, filename, NULL, SEEK_SET, false, false);
901 UCI_INTERNAL(uci_import, ctx, file, name, &package, true);
902 UCI_TRAP_RESTORE(ctx);
905 package->path = filename;
906 package->has_delta = confdir;
907 uci_load_delta(ctx, package, false);
911 uci_close_stream(file);
914 UCI_THROW(ctx, ctx->err);
919 __private UCI_BACKEND(uci_file_backend, "file",
920 .load = uci_file_load,
921 .commit = uci_file_commit,
922 .list_configs = uci_list_config_files,