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>
28 static struct uci_backend uci_file_backend
;
31 * verify that the end of the line or command is reached.
32 * throw an error if extra arguments are given on the command line
34 static void assert_eol(struct uci_context
*ctx
, char **str
)
38 skip_whitespace(ctx
, str
);
39 tmp
= next_arg(ctx
, str
, false, false);
40 if (*tmp
&& (ctx
->flags
& UCI_FLAG_STRICT
))
41 uci_parse_error(ctx
, *str
, "too many arguments");
45 * switch to a different config, either triggered by uci_load, or by a
46 * 'package <...>' statement in the import file
48 static void uci_switch_config(struct uci_context
*ctx
)
50 struct uci_parse_context
*pctx
;
51 struct uci_element
*e
;
57 /* add the last config to main config file list */
59 pctx
->package
->backend
= ctx
->backend
;
60 uci_list_add(&ctx
->root
, &pctx
->package
->e
.list
);
70 * if an older config under the same name exists, unload it
71 * ignore errors here, e.g. if the config was not found
73 e
= uci_lookup_list(&ctx
->root
, name
);
75 UCI_THROW(ctx
, UCI_ERR_DUPLICATE
);
76 pctx
->package
= uci_alloc_package(ctx
, name
);
80 * parse the 'package' uci command (next config package)
82 static void uci_parse_package(struct uci_context
*ctx
, char **str
, bool single
)
86 /* command string null-terminated by strtok */
87 *str
+= strlen(*str
) + 1;
89 name
= next_arg(ctx
, str
, true, true);
94 ctx
->pctx
->name
= name
;
95 uci_switch_config(ctx
);
99 * parse the 'config' uci command (open a section)
101 static void uci_parse_config(struct uci_context
*ctx
, char **str
)
103 struct uci_parse_context
*pctx
= ctx
->pctx
;
107 uci_fixup_section(ctx
, ctx
->pctx
->section
);
108 if (!ctx
->pctx
->package
) {
109 if (!ctx
->pctx
->name
)
110 uci_parse_error(ctx
, *str
, "attempting to import a file without a package name");
112 uci_switch_config(ctx
);
115 /* command string null-terminated by strtok */
116 *str
+= strlen(*str
) + 1;
118 type
= next_arg(ctx
, str
, true, false);
119 if (!uci_validate_str(type
, false))
120 uci_parse_error(ctx
, type
, "invalid character in field");
121 name
= next_arg(ctx
, str
, false, true);
122 assert_eol(ctx
, str
);
125 UCI_TRAP_SAVE(ctx
, error
);
126 if (uci_set(ctx
, pctx
->package
, name
, NULL
, type
, NULL
) != UCI_OK
)
128 UCI_TRAP_RESTORE(ctx
);
131 UCI_THROW(ctx
, ctx
->err
);
133 pctx
->section
= uci_alloc_section(pctx
->package
, type
, name
);
137 * parse the 'option' uci command (open a value)
139 static void uci_parse_option(struct uci_context
*ctx
, char **str
)
141 struct uci_parse_context
*pctx
= ctx
->pctx
;
146 uci_parse_error(ctx
, *str
, "option command found before the first section");
148 /* command string null-terminated by strtok */
149 *str
+= strlen(*str
) + 1;
151 name
= next_arg(ctx
, str
, true, true);
152 value
= next_arg(ctx
, str
, false, false);
153 assert_eol(ctx
, str
);
156 UCI_TRAP_SAVE(ctx
, error
);
157 uci_set(ctx
, pctx
->package
, pctx
->section
->e
.name
, name
, value
, NULL
);
158 UCI_TRAP_RESTORE(ctx
);
161 UCI_THROW(ctx
, ctx
->err
);
163 uci_alloc_option(pctx
->section
, name
, value
);
168 * parse a complete input line, split up combined commands by ';'
170 static void uci_parse_line(struct uci_context
*ctx
, bool single
)
172 struct uci_parse_context
*pctx
= ctx
->pctx
;
178 word
= strtok_r(word
, " \t", &brk
);
187 if ((word
[1] == 0) || !strcmp(word
+ 1, "ackage"))
188 uci_parse_package(ctx
, &word
, single
);
191 if ((word
[1] == 0) || !strcmp(word
+ 1, "onfig"))
192 uci_parse_config(ctx
, &word
);
195 if ((word
[1] == 0) || !strcmp(word
+ 1, "ption"))
196 uci_parse_option(ctx
, &word
);
199 uci_parse_error(ctx
, word
, "unterminated command");
205 /* max number of characters that escaping adds to the string */
206 #define UCI_QUOTE_ESCAPE "'\\''"
209 * escape an uci string for export
211 static char *uci_escape(struct uci_context
*ctx
, const char *str
)
217 ctx
->bufsz
= LINEBUF
;
218 ctx
->buf
= malloc(LINEBUF
);
224 end
= strchr(str
, '\'');
226 end
= str
+ strlen(str
);
229 /* make sure that we have enough room in the buffer */
230 while (ofs
+ len
+ sizeof(UCI_QUOTE_ESCAPE
) + 1 > ctx
->bufsz
) {
232 ctx
->buf
= uci_realloc(ctx
, ctx
->buf
, ctx
->bufsz
);
235 /* copy the string until the character before the quote */
236 memcpy(&ctx
->buf
[ofs
], str
, len
);
239 /* end of string? return the buffer */
243 memcpy(&ctx
->buf
[ofs
], UCI_QUOTE_ESCAPE
, sizeof(UCI_QUOTE_ESCAPE
));
244 ofs
+= strlen(&ctx
->buf
[ofs
]);
253 * export a single config package to a file stream
255 static void uci_export_package(struct uci_package
*p
, FILE *stream
, bool header
)
257 struct uci_context
*ctx
= p
->ctx
;
258 struct uci_element
*s
, *o
;
261 fprintf(stream
, "package '%s'\n", uci_escape(ctx
, p
->e
.name
));
262 uci_foreach_element(&p
->sections
, s
) {
263 struct uci_section
*sec
= uci_to_section(s
);
264 fprintf(stream
, "\nconfig '%s'", uci_escape(ctx
, sec
->type
));
265 if (!sec
->anonymous
|| (ctx
->flags
& UCI_FLAG_EXPORT_NAME
))
266 fprintf(stream
, " '%s'", uci_escape(ctx
, sec
->e
.name
));
267 fprintf(stream
, "\n");
268 uci_foreach_element(&sec
->options
, o
) {
269 struct uci_option
*opt
= uci_to_option(o
);
270 fprintf(stream
, "\toption '%s'", uci_escape(ctx
, opt
->e
.name
));
271 fprintf(stream
, " '%s'\n", uci_escape(ctx
, opt
->value
));
274 fprintf(stream
, "\n");
277 int uci_export(struct uci_context
*ctx
, FILE *stream
, struct uci_package
*package
, bool header
)
279 struct uci_element
*e
;
282 UCI_ASSERT(ctx
, stream
!= NULL
);
285 uci_export_package(package
, stream
, header
);
287 uci_foreach_element(&ctx
->root
, e
) {
288 uci_export_package(uci_to_package(e
), stream
, header
);
295 int uci_import(struct uci_context
*ctx
, FILE *stream
, const char *name
, struct uci_package
**package
, bool single
)
297 struct uci_parse_context
*pctx
;
300 /* make sure no memory from previous parse attempts is leaked */
303 uci_alloc_parse_context(ctx
);
306 if (*package
&& single
) {
307 pctx
->package
= *package
;
312 * If 'name' was supplied, assume that the supplied stream does not contain
313 * the appropriate 'package <name>' string to specify the config name
314 * NB: the config file can still override the package name
317 UCI_ASSERT(ctx
, uci_validate_str(name
, false));
321 while (!feof(pctx
->file
)) {
323 UCI_TRAP_SAVE(ctx
, error
);
325 uci_parse_line(ctx
, single
);
326 UCI_TRAP_RESTORE(ctx
);
329 if (ctx
->flags
& UCI_FLAG_PERROR
)
330 uci_perror(ctx
, NULL
);
331 if ((ctx
->err
!= UCI_ERR_PARSE
) ||
332 (ctx
->flags
& UCI_FLAG_STRICT
))
333 UCI_THROW(ctx
, ctx
->err
);
336 uci_fixup_section(ctx
, ctx
->pctx
->section
);
337 if (!pctx
->package
&& name
)
338 uci_switch_config(ctx
);
340 *package
= pctx
->package
;
342 pctx
->package
= NULL
;
345 uci_switch_config(ctx
);
347 /* no error happened, we can get rid of the parser context now */
354 static char *uci_config_path(struct uci_context
*ctx
, const char *name
)
358 UCI_ASSERT(ctx
, uci_validate_str(name
, false));
359 filename
= uci_malloc(ctx
, strlen(name
) + strlen(ctx
->confdir
) + 2);
360 sprintf(filename
, "%s/%s", ctx
->confdir
, name
);
365 void uci_file_commit(struct uci_context
*ctx
, struct uci_package
**package
, bool overwrite
)
367 struct uci_package
*p
= *package
;
374 p
->path
= uci_config_path(ctx
, p
->e
.name
);
376 UCI_THROW(ctx
, UCI_ERR_INVAL
);
379 /* open the config file for writing now, so that it is locked */
380 f
= uci_open_stream(ctx
, p
->path
, SEEK_SET
, true, true);
382 /* flush unsaved changes and reload from history file */
383 UCI_TRAP_SAVE(ctx
, done
);
384 if (p
->has_history
) {
386 name
= uci_strdup(ctx
, p
->e
.name
);
387 path
= uci_strdup(ctx
, p
->path
);
388 /* dump our own changes to the history file */
389 if (!uci_list_empty(&p
->history
))
390 UCI_INTERNAL(uci_save
, ctx
, p
);
393 * other processes might have modified the config
394 * as well. dump and reload
396 uci_free_package(&p
);
398 UCI_INTERNAL(uci_import
, ctx
, f
, name
, &p
, true);
401 p
->has_history
= true;
404 /* freed together with the uci_package */
407 /* check for updated history, flush */
408 if (!uci_load_history(ctx
, p
, true))
412 if (!uci_load_history(ctx
, NULL
, true))
418 ftruncate(fileno(f
), 0);
420 uci_export(ctx
, f
, p
, false);
421 UCI_TRAP_RESTORE(ctx
);
430 UCI_THROW(ctx
, ctx
->err
);
435 * This function returns the filename by returning the string
436 * after the last '/' character. By checking for a non-'\0'
437 * character afterwards, directories are ignored (glob marks
438 * those with a trailing '/'
440 static inline char *get_filename(char *path
)
444 p
= strrchr(path
, '/');
451 static char **uci_list_config_files(struct uci_context
*ctx
)
459 dir
= uci_malloc(ctx
, strlen(ctx
->confdir
) + 1 + sizeof("/*"));
460 sprintf(dir
, "%s/*", ctx
->confdir
);
461 if (glob(dir
, GLOB_MARK
, NULL
, &globbuf
) != 0)
462 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
464 size
= sizeof(char *) * (globbuf
.gl_pathc
+ 1);
465 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
468 p
= get_filename(globbuf
.gl_pathv
[i
]);
472 size
+= strlen(p
) + 1;
475 configs
= uci_malloc(ctx
, size
);
476 buf
= (char *) &configs
[globbuf
.gl_pathc
+ 1];
477 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
480 p
= get_filename(globbuf
.gl_pathv
[i
]);
484 if (!uci_validate_name(p
))
489 buf
+= strlen(buf
) + 1;
495 static struct uci_package
*uci_file_load(struct uci_context
*ctx
, const char *name
)
497 struct uci_package
*package
= NULL
;
504 /* relative path outside of /etc/config */
506 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
509 /* absolute path outside of /etc/config */
510 filename
= uci_strdup(ctx
, name
);
511 name
= strrchr(name
, '/') + 1;
515 /* config in /etc/config */
516 filename
= uci_config_path(ctx
, name
);
521 file
= uci_open_stream(ctx
, filename
, SEEK_SET
, false, false);
523 UCI_TRAP_SAVE(ctx
, done
);
524 UCI_INTERNAL(uci_import
, ctx
, file
, name
, &package
, true);
525 UCI_TRAP_RESTORE(ctx
);
528 package
->path
= filename
;
529 package
->has_history
= confdir
;
530 uci_load_history(ctx
, package
, false);
534 uci_close_stream(file
);
536 UCI_THROW(ctx
, ctx
->err
);
540 static UCI_BACKEND(uci_file_backend
, "file",
541 .load
= uci_file_load
,
542 .commit
= uci_file_commit
,
543 .list_configs
= uci_list_config_files
,