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>
28 #define LINEBUF_MAX 4096
30 static void uci_parse_error(struct uci_context *ctx, char *pos, char *reason)
32 struct uci_parse_context *pctx = ctx->pctx;
34 pctx->reason = reason;
35 pctx->byte = pos - pctx->buf;
36 UCI_THROW(ctx, UCI_ERR_PARSE);
40 * Fetch a new line from the input stream and resize buffer if necessary
42 static void uci_getln(struct uci_context *ctx, int offset)
44 struct uci_parse_context *pctx = ctx->pctx;
48 if (pctx->buf == NULL) {
49 pctx->buf = uci_malloc(ctx, LINEBUF);
50 pctx->bufsz = LINEBUF;
58 p = fgets(p, pctx->bufsz - ofs, pctx->file);
63 if (pctx->buf[ofs - 1] == '\n') {
65 pctx->buf[ofs - 1] = 0;
69 if (pctx->bufsz > LINEBUF_MAX/2)
70 uci_parse_error(ctx, p, "line too long");
73 pctx->buf = uci_realloc(ctx, pctx->buf, pctx->bufsz);
78 * Clean up all extra memory used by the parser and exporter
80 static void uci_file_cleanup(struct uci_context *ctx)
82 struct uci_parse_context *pctx;
96 uci_free_package(&pctx->package);
105 * parse a character escaped by '\'
106 * returns true if the escaped character is to be parsed
107 * returns false if the escaped character is to be ignored
109 static inline bool parse_backslash(struct uci_context *ctx, char **str)
114 /* undecoded backslash at the end of line, fetch the next line */
117 uci_getln(ctx, *str - ctx->pctx->buf);
121 /* FIXME: decode escaped char, necessary? */
126 * move the string pointer forward until a non-whitespace character or
129 static void skip_whitespace(struct uci_context *ctx, char **str)
132 while (**str && isspace(**str))
136 if (!parse_backslash(ctx, str))
141 static inline void addc(char **dest, char **src)
149 * parse a double quoted string argument from the command line
151 static void parse_double_quote(struct uci_context *ctx, char **str, char **target)
155 /* skip quote character */
158 while ((c = **str)) {
165 if (!parse_backslash(ctx, str))
173 uci_parse_error(ctx, *str, "unterminated \"");
177 * parse a single quoted string argument from the command line
179 static void parse_single_quote(struct uci_context *ctx, char **str, char **target)
182 /* skip quote character */
185 while ((c = **str)) {
195 uci_parse_error(ctx, *str, "unterminated '");
199 * parse a string from the command line and detect the quoting style
201 static void parse_str(struct uci_context *ctx, char **str, char **target)
206 parse_single_quote(ctx, str, target);
209 parse_double_quote(ctx, str, target);
214 if (!parse_backslash(ctx, str))
221 } while (**str && !isspace(**str));
225 * if the string was unquoted and we've stopped at a whitespace
226 * character, skip to the next one, because the whitespace will
227 * be overwritten by a null byte here
232 /* terminate the parsed string */
237 * extract the next argument from the command line
239 static char *next_arg(struct uci_context *ctx, char **str, bool required, bool name)
245 skip_whitespace(ctx, str);
246 parse_str(ctx, str, &ptr);
249 uci_parse_error(ctx, *str, "insufficient arguments");
253 if (name && !uci_validate_name(val))
254 uci_parse_error(ctx, val, "invalid character in field");
261 * verify that the end of the line or command is reached.
262 * throw an error if extra arguments are given on the command line
264 static void assert_eol(struct uci_context *ctx, char **str)
268 tmp = next_arg(ctx, str, false, false);
270 uci_parse_error(ctx, *str, "too many arguments");
274 * switch to a different config, either triggered by uci_load, or by a
275 * 'package <...>' statement in the import file
277 static void uci_switch_config(struct uci_context *ctx)
279 struct uci_parse_context *pctx;
280 struct uci_element *e;
286 /* add the last config to main config file list */
288 uci_list_add(&ctx->root, &pctx->package->e.list);
290 pctx->package = NULL;
291 pctx->section = NULL;
298 * if an older config under the same name exists, unload it
299 * ignore errors here, e.g. if the config was not found
301 e = uci_lookup_list(ctx, &ctx->root, name);
303 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
304 pctx->package = uci_alloc_package(ctx, name);
308 * parse the 'package' uci command (next config package)
310 static void uci_parse_package(struct uci_context *ctx, char **str, bool single)
314 /* command string null-terminated by strtok */
315 *str += strlen(*str) + 1;
317 name = next_arg(ctx, str, true, true);
318 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 uci_parse_error(ctx, *str, "attempting to import a file without a package name");
338 uci_switch_config(ctx);
341 /* command string null-terminated by strtok */
342 *str += strlen(*str) + 1;
344 type = next_arg(ctx, str, true, true);
345 name = next_arg(ctx, str, false, true);
346 assert_eol(ctx, str);
347 ctx->pctx->section = uci_alloc_section(ctx->pctx->package, type, name);
351 * parse the 'option' uci command (open a value)
353 static void uci_parse_option(struct uci_context *ctx, char **str)
358 if (!ctx->pctx->section)
359 uci_parse_error(ctx, *str, "option command found before the first section");
361 /* command string null-terminated by strtok */
362 *str += strlen(*str) + 1;
364 name = next_arg(ctx, str, true, true);
365 value = next_arg(ctx, str, true, false);
366 assert_eol(ctx, str);
367 uci_alloc_option(ctx->pctx->section, name, value);
372 * parse a complete input line, split up combined commands by ';'
374 static void uci_parse_line(struct uci_context *ctx, bool single)
376 struct uci_parse_context *pctx = ctx->pctx;
377 char *word, *brk = NULL;
379 for (word = strtok_r(pctx->buf, ";", &brk);
381 word = strtok_r(NULL, ";", &brk)) {
384 word = strtok_r(word, " \t", &pbrk);
388 if ((word[1] == 0) || !strcmp(word + 1, "ackage"))
389 uci_parse_package(ctx, &word, single);
392 if ((word[1] == 0) || !strcmp(word + 1, "onfig"))
393 uci_parse_config(ctx, &word);
396 if ((word[1] == 0) || !strcmp(word + 1, "ption"))
397 uci_parse_option(ctx, &word);
400 uci_parse_error(ctx, word, "unterminated command");
406 /* max number of characters that escaping adds to the string */
407 #define UCI_QUOTE_ESCAPE "'\\''"
410 * escape an uci string for export
412 static char *uci_escape(struct uci_context *ctx, char *str)
418 ctx->bufsz = LINEBUF;
419 ctx->buf = malloc(LINEBUF);
423 p = strchr(str, '\'');
430 if (p + sizeof(UCI_QUOTE_ESCAPE) - str >= ctx->bufsz) {
432 ctx->buf = realloc(ctx->buf, ctx->bufsz);
434 UCI_THROW(ctx, UCI_ERR_MEM);
436 memcpy(&ctx->buf[pos], s, len);
439 strcpy(&ctx->buf[pos], UCI_QUOTE_ESCAPE);
440 pos += sizeof(UCI_QUOTE_ESCAPE);
442 } while ((p = strchr(s, '\'')));
449 * export a single config package to a file stream
451 static void uci_export_package(struct uci_package *p, FILE *stream, bool header)
453 struct uci_context *ctx = p->ctx;
454 struct uci_element *s, *o;
457 fprintf(stream, "package '%s'\n", uci_escape(ctx, p->e.name));
458 uci_foreach_element(&p->sections, s) {
459 struct uci_section *sec = uci_to_section(s);
460 fprintf(stream, "\nconfig '%s'", uci_escape(ctx, sec->type));
461 fprintf(stream, " '%s'\n", uci_escape(ctx, sec->e.name));
462 uci_foreach_element(&sec->options, o) {
463 struct uci_option *opt = uci_to_option(o);
464 fprintf(stream, "\toption '%s'", uci_escape(ctx, opt->e.name));
465 fprintf(stream, " '%s'\n", uci_escape(ctx, opt->value));
468 fprintf(stream, "\n");
471 int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header)
473 struct uci_element *e;
476 UCI_ASSERT(ctx, stream != NULL);
479 uci_export_package(package, stream, header);
481 uci_foreach_element(&ctx->root, e) {
482 uci_export_package(uci_to_package(e), stream, header);
489 int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single)
491 struct uci_parse_context *pctx;
493 /* make sure no memory from previous parse attempts is leaked */
494 uci_file_cleanup(ctx);
496 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
501 * If 'name' was supplied, assume that the supplied stream does not contain
502 * the appropriate 'package <name>' string to specify the config name
503 * NB: the config file can still override the package name
508 while (!feof(pctx->file)) {
510 UCI_TRAP_SAVE(ctx, error);
512 uci_parse_line(ctx, single);
513 UCI_TRAP_RESTORE(ctx);
516 if (ctx->flags & UCI_FLAG_PERROR)
517 uci_perror(ctx, NULL);
518 if ((ctx->errno != UCI_ERR_PARSE) ||
519 (ctx->flags & UCI_FLAG_STRICT))
520 UCI_THROW(ctx, ctx->errno);
524 *package = pctx->package;
527 uci_switch_config(ctx);
529 /* no error happened, we can get rid of the parser context now */
530 uci_file_cleanup(ctx);
536 * open a stream and go to the right position
538 * note: when opening for write and seeking to the beginning of
539 * the stream, truncate the file
541 static FILE *uci_open_stream(struct uci_context *ctx, const char *filename, int pos, bool write, bool create)
546 int mode = (write ? O_RDWR : O_RDONLY);
551 if (!write && ((stat(filename, &statbuf) < 0) ||
552 ((statbuf.st_mode & S_IFMT) != S_IFREG))) {
553 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
556 fd = open(filename, mode, UCI_FILEMODE);
560 if (flock(fd, (write ? LOCK_EX : LOCK_SH)) < 0)
563 ret = lseek(fd, 0, pos);
568 file = fdopen(fd, (write ? "w+" : "r"));
573 UCI_THROW(ctx, UCI_ERR_IO);
578 static void uci_close_stream(FILE *stream)
590 static void uci_parse_history_line(struct uci_context *ctx, struct uci_package *p, char *buf)
593 char *package = NULL;
594 char *section = NULL;
603 UCI_INTERNAL(uci_parse_tuple, ctx, buf, &package, §ion, &option, &value);
604 if (!package || !section || (!delete && !value))
606 if (strcmp(package, p->e.name) != 0)
608 if (!uci_validate_name(section))
610 if (option && !uci_validate_name(option))
614 UCI_INTERNAL(uci_del, ctx, p, section, option);
616 UCI_INTERNAL(uci_set, ctx, p, section, option, value);
620 UCI_THROW(ctx, UCI_ERR_PARSE);
623 static void uci_parse_history(struct uci_context *ctx, FILE *stream, struct uci_package *p)
625 struct uci_parse_context *pctx;
627 /* make sure no memory from previous parse attempts is leaked */
628 uci_file_cleanup(ctx);
630 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
634 while (!feof(pctx->file)) {
640 * ignore parse errors in single lines, we want to preserve as much
641 * history as possible
643 UCI_TRAP_SAVE(ctx, error);
644 uci_parse_history_line(ctx, p, pctx->buf);
645 UCI_TRAP_RESTORE(ctx);
650 /* no error happened, we can get rid of the parser context now */
651 uci_file_cleanup(ctx);
654 static void uci_load_history(struct uci_context *ctx, struct uci_package *p, bool flush)
656 char *filename = NULL;
661 if ((asprintf(&filename, "%s/%s", UCI_SAVEDIR, p->e.name) < 0) || !filename)
662 UCI_THROW(ctx, UCI_ERR_MEM);
664 UCI_TRAP_SAVE(ctx, done);
665 f = uci_open_stream(ctx, filename, SEEK_SET, flush, false);
666 uci_parse_history(ctx, f, p);
667 UCI_TRAP_RESTORE(ctx);
672 ftruncate(fileno(f), 0);
681 int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package)
688 UCI_ASSERT(ctx, name != NULL);
692 /* relative path outside of /etc/config */
694 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
697 /* absolute path outside of /etc/config */
698 filename = uci_strdup(ctx, name);
699 name = strrchr(name, '/') + 1;
703 /* config in /etc/config */
704 if (strchr(name, '/'))
705 UCI_THROW(ctx, UCI_ERR_INVAL);
706 filename = uci_malloc(ctx, strlen(name) + sizeof(UCI_CONFDIR) + 2);
707 sprintf(filename, UCI_CONFDIR "/%s", name);
712 file = uci_open_stream(ctx, filename, SEEK_SET, false, false);
714 UCI_TRAP_SAVE(ctx, done);
715 uci_import(ctx, file, name, package, true);
716 UCI_TRAP_RESTORE(ctx);
719 (*package)->path = filename;
720 (*package)->confdir = confdir;
721 uci_load_history(ctx, *package, false);
725 uci_close_stream(file);
729 int uci_save(struct uci_context *ctx, struct uci_package *p)
732 char *filename = NULL;
733 struct uci_element *e, *tmp;
736 UCI_ASSERT(ctx, p != NULL);
739 * if the config file was outside of the /etc/config path,
740 * don't save the history to a file, update the real file
742 * does not modify the uci_package pointer
745 return uci_commit(ctx, &p);
747 if (uci_list_empty(&p->history))
750 if ((asprintf(&filename, "%s/%s", UCI_SAVEDIR, p->e.name) < 0) || !filename)
751 UCI_THROW(ctx, UCI_ERR_MEM);
754 UCI_TRAP_SAVE(ctx, done);
755 f = uci_open_stream(ctx, filename, SEEK_END, true, true);
756 UCI_TRAP_RESTORE(ctx);
758 uci_foreach_element_safe(&p->history, tmp, e) {
759 struct uci_history *h = uci_to_history(e);
761 if (h->cmd == UCI_CMD_REMOVE)
764 fprintf(f, "%s.%s", p->e.name, h->section);
766 fprintf(f, ".%s", e->name);
768 if (h->cmd == UCI_CMD_REMOVE)
771 fprintf(f, "=%s\n", h->value);
780 UCI_THROW(ctx, ctx->errno);
785 int uci_commit(struct uci_context *ctx, struct uci_package **package)
787 struct uci_package *p;
793 UCI_ASSERT(ctx, package != NULL);
796 UCI_ASSERT(ctx, p != NULL);
797 UCI_ASSERT(ctx, p->path != NULL);
799 /* open the config file for writing now, so that it is locked */
800 f = uci_open_stream(ctx, p->path, SEEK_SET, true, true);
802 /* flush unsaved changes and reload from history file */
803 UCI_TRAP_SAVE(ctx, done);
805 name = uci_strdup(ctx, p->e.name);
806 path = uci_strdup(ctx, p->path);
807 if (!uci_list_empty(&p->history))
808 UCI_INTERNAL(uci_save, ctx, p);
809 uci_free_package(&p);
810 uci_file_cleanup(ctx);
811 UCI_INTERNAL(uci_import, ctx, f, name, &p, true);
817 /* freed together with the uci_package */
820 /* check for updated history, just in case */
821 uci_load_history(ctx, p, true);
825 ftruncate(fileno(f), 0);
827 uci_export(ctx, f, p, false);
828 UCI_TRAP_RESTORE(ctx);
837 UCI_THROW(ctx, ctx->errno);
844 * This function returns the filename by returning the string
845 * after the last '/' character. By checking for a non-'\0'
846 * character afterwards, directories are ignored (glob marks
847 * those with a trailing '/'
849 static inline char *get_filename(char *path)
853 p = strrchr(path, '/');
860 int uci_list_configs(struct uci_context *ctx, char ***list)
869 if (glob(UCI_CONFDIR "/*", GLOB_MARK, NULL, &globbuf) != 0)
870 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
872 size = sizeof(char *) * (globbuf.gl_pathc + 1);
873 for(i = 0; i < globbuf.gl_pathc; i++) {
876 p = get_filename(globbuf.gl_pathv[i]);
880 size += strlen(p) + 1;
883 configs = uci_malloc(ctx, size);
884 buf = (char *) &configs[globbuf.gl_pathc + 1];
885 for(i = 0; i < globbuf.gl_pathc; i++) {
888 p = get_filename(globbuf.gl_pathv[i]);
894 buf += strlen(buf) + 1;