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 tmp
= next_arg(ctx
, str
, false, false);
39 if (*tmp
&& (ctx
->flags
& UCI_FLAG_STRICT
))
40 uci_parse_error(ctx
, *str
, "too many arguments");
44 * switch to a different config, either triggered by uci_load, or by a
45 * 'package <...>' statement in the import file
47 static void uci_switch_config(struct uci_context
*ctx
)
49 struct uci_parse_context
*pctx
;
50 struct uci_element
*e
;
56 /* add the last config to main config file list */
58 pctx
->package
->backend
= ctx
->backend
;
59 uci_list_add(&ctx
->root
, &pctx
->package
->e
.list
);
69 * if an older config under the same name exists, unload it
70 * ignore errors here, e.g. if the config was not found
72 e
= uci_lookup_list(&ctx
->root
, name
);
74 UCI_THROW(ctx
, UCI_ERR_DUPLICATE
);
75 pctx
->package
= uci_alloc_package(ctx
, name
);
79 * parse the 'package' uci command (next config package)
81 static void uci_parse_package(struct uci_context
*ctx
, char **str
, bool single
)
85 /* command string null-terminated by strtok */
86 *str
+= strlen(*str
) + 1;
88 name
= next_arg(ctx
, str
, true, true);
93 ctx
->pctx
->name
= name
;
94 uci_switch_config(ctx
);
98 * parse the 'config' uci command (open a section)
100 static void uci_parse_config(struct uci_context
*ctx
, char **str
)
102 struct uci_parse_context
*pctx
= ctx
->pctx
;
106 uci_fixup_section(ctx
, ctx
->pctx
->section
);
107 if (!ctx
->pctx
->package
) {
108 if (!ctx
->pctx
->name
)
109 uci_parse_error(ctx
, *str
, "attempting to import a file without a package name");
111 uci_switch_config(ctx
);
114 /* command string null-terminated by strtok */
115 *str
+= strlen(*str
) + 1;
117 type
= next_arg(ctx
, str
, true, false);
118 if (!uci_validate_str(type
, false))
119 uci_parse_error(ctx
, type
, "invalid character in field");
120 name
= next_arg(ctx
, str
, false, true);
121 assert_eol(ctx
, str
);
124 UCI_TRAP_SAVE(ctx
, error
);
125 if (uci_set(ctx
, pctx
->package
, name
, NULL
, type
, NULL
) != UCI_OK
)
127 UCI_TRAP_RESTORE(ctx
);
130 UCI_THROW(ctx
, ctx
->errno
);
132 pctx
->section
= uci_alloc_section(pctx
->package
, type
, name
);
136 * parse the 'option' uci command (open a value)
138 static void uci_parse_option(struct uci_context
*ctx
, char **str
)
140 struct uci_parse_context
*pctx
= ctx
->pctx
;
145 uci_parse_error(ctx
, *str
, "option command found before the first section");
147 /* command string null-terminated by strtok */
148 *str
+= strlen(*str
) + 1;
150 name
= next_arg(ctx
, str
, true, true);
151 value
= next_arg(ctx
, str
, false, false);
152 assert_eol(ctx
, str
);
155 UCI_TRAP_SAVE(ctx
, error
);
156 uci_set(ctx
, pctx
->package
, pctx
->section
->e
.name
, name
, value
, NULL
);
157 UCI_TRAP_RESTORE(ctx
);
160 UCI_THROW(ctx
, ctx
->errno
);
162 uci_alloc_option(pctx
->section
, name
, value
);
167 * parse a complete input line, split up combined commands by ';'
169 static void uci_parse_line(struct uci_context
*ctx
, bool single
)
171 struct uci_parse_context
*pctx
= ctx
->pctx
;
172 char *word
, *brk
= NULL
;
174 for (word
= strtok_r(pctx
->buf
, ";", &brk
);
176 word
= strtok_r(NULL
, ";", &brk
)) {
179 word
= strtok_r(word
, " \t", &pbrk
);
188 if ((word
[1] == 0) || !strcmp(word
+ 1, "ackage"))
189 uci_parse_package(ctx
, &word
, single
);
192 if ((word
[1] == 0) || !strcmp(word
+ 1, "onfig"))
193 uci_parse_config(ctx
, &word
);
196 if ((word
[1] == 0) || !strcmp(word
+ 1, "ption"))
197 uci_parse_option(ctx
, &word
);
200 uci_parse_error(ctx
, word
, "unterminated command");
206 /* max number of characters that escaping adds to the string */
207 #define UCI_QUOTE_ESCAPE "'\\''"
210 * escape an uci string for export
212 static char *uci_escape(struct uci_context
*ctx
, char *str
)
218 ctx
->bufsz
= LINEBUF
;
219 ctx
->buf
= malloc(LINEBUF
);
223 p
= strchr(str
, '\'');
230 if (p
+ sizeof(UCI_QUOTE_ESCAPE
) - str
>= ctx
->bufsz
) {
232 ctx
->buf
= realloc(ctx
->buf
, ctx
->bufsz
);
234 UCI_THROW(ctx
, UCI_ERR_MEM
);
236 memcpy(&ctx
->buf
[pos
], s
, len
);
239 strcpy(&ctx
->buf
[pos
], UCI_QUOTE_ESCAPE
);
240 pos
+= sizeof(UCI_QUOTE_ESCAPE
);
242 } while ((p
= strchr(s
, '\'')));
249 * export a single config package to a file stream
251 static void uci_export_package(struct uci_package
*p
, FILE *stream
, bool header
)
253 struct uci_context
*ctx
= p
->ctx
;
254 struct uci_element
*s
, *o
;
257 fprintf(stream
, "package '%s'\n", uci_escape(ctx
, p
->e
.name
));
258 uci_foreach_element(&p
->sections
, s
) {
259 struct uci_section
*sec
= uci_to_section(s
);
260 fprintf(stream
, "\nconfig '%s'", uci_escape(ctx
, sec
->type
));
261 if (!sec
->anonymous
|| (ctx
->flags
& UCI_FLAG_EXPORT_NAME
))
262 fprintf(stream
, " '%s'", uci_escape(ctx
, sec
->e
.name
));
263 fprintf(stream
, "\n");
264 uci_foreach_element(&sec
->options
, o
) {
265 struct uci_option
*opt
= uci_to_option(o
);
266 fprintf(stream
, "\toption '%s'", uci_escape(ctx
, opt
->e
.name
));
267 fprintf(stream
, " '%s'\n", uci_escape(ctx
, opt
->value
));
270 fprintf(stream
, "\n");
273 int uci_export(struct uci_context
*ctx
, FILE *stream
, struct uci_package
*package
, bool header
)
275 struct uci_element
*e
;
278 UCI_ASSERT(ctx
, stream
!= NULL
);
281 uci_export_package(package
, stream
, header
);
283 uci_foreach_element(&ctx
->root
, e
) {
284 uci_export_package(uci_to_package(e
), stream
, header
);
291 int uci_import(struct uci_context
*ctx
, FILE *stream
, const char *name
, struct uci_package
**package
, bool single
)
293 struct uci_parse_context
*pctx
;
296 /* make sure no memory from previous parse attempts is leaked */
299 uci_alloc_parse_context(ctx
);
302 if (*package
&& single
) {
303 pctx
->package
= *package
;
308 * If 'name' was supplied, assume that the supplied stream does not contain
309 * the appropriate 'package <name>' string to specify the config name
310 * NB: the config file can still override the package name
313 UCI_ASSERT(ctx
, uci_validate_name(name
));
317 while (!feof(pctx
->file
)) {
319 UCI_TRAP_SAVE(ctx
, error
);
321 uci_parse_line(ctx
, single
);
322 UCI_TRAP_RESTORE(ctx
);
325 if (ctx
->flags
& UCI_FLAG_PERROR
)
326 uci_perror(ctx
, NULL
);
327 if ((ctx
->errno
!= UCI_ERR_PARSE
) ||
328 (ctx
->flags
& UCI_FLAG_STRICT
))
329 UCI_THROW(ctx
, ctx
->errno
);
332 uci_fixup_section(ctx
, ctx
->pctx
->section
);
334 *package
= pctx
->package
;
336 pctx
->package
= NULL
;
339 uci_switch_config(ctx
);
341 /* no error happened, we can get rid of the parser context now */
348 static char *uci_config_path(struct uci_context
*ctx
, const char *name
)
352 UCI_ASSERT(ctx
, uci_validate_name(name
));
353 filename
= uci_malloc(ctx
, strlen(name
) + strlen(ctx
->confdir
) + 2);
354 sprintf(filename
, "%s/%s", ctx
->confdir
, name
);
359 void uci_file_commit(struct uci_context
*ctx
, struct uci_package
**package
, bool overwrite
)
361 struct uci_package
*p
= *package
;
368 p
->path
= uci_config_path(ctx
, p
->e
.name
);
370 UCI_THROW(ctx
, UCI_ERR_INVAL
);
373 /* open the config file for writing now, so that it is locked */
374 f
= uci_open_stream(ctx
, p
->path
, SEEK_SET
, true, true);
376 /* flush unsaved changes and reload from history file */
377 UCI_TRAP_SAVE(ctx
, done
);
378 if (p
->has_history
) {
380 name
= uci_strdup(ctx
, p
->e
.name
);
381 path
= uci_strdup(ctx
, p
->path
);
382 /* dump our own changes to the history file */
383 if (!uci_list_empty(&p
->history
))
384 UCI_INTERNAL(uci_save
, ctx
, p
);
387 * other processes might have modified the config
388 * as well. dump and reload
390 uci_free_package(&p
);
392 UCI_INTERNAL(uci_import
, ctx
, f
, name
, &p
, true);
395 p
->has_history
= true;
398 /* freed together with the uci_package */
401 /* check for updated history, flush */
402 if (!uci_load_history(ctx
, p
, true))
406 if (!uci_load_history(ctx
, NULL
, true))
412 ftruncate(fileno(f
), 0);
414 uci_export(ctx
, f
, p
, false);
415 UCI_TRAP_RESTORE(ctx
);
424 UCI_THROW(ctx
, ctx
->errno
);
429 * This function returns the filename by returning the string
430 * after the last '/' character. By checking for a non-'\0'
431 * character afterwards, directories are ignored (glob marks
432 * those with a trailing '/'
434 static inline char *get_filename(char *path
)
438 p
= strrchr(path
, '/');
445 static char **uci_list_config_files(struct uci_context
*ctx
)
453 dir
= uci_malloc(ctx
, strlen(ctx
->confdir
) + 1 + sizeof("/*"));
454 sprintf(dir
, "%s/*", ctx
->confdir
);
455 if (glob(dir
, GLOB_MARK
, NULL
, &globbuf
) != 0)
456 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
458 size
= sizeof(char *) * (globbuf
.gl_pathc
+ 1);
459 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
462 p
= get_filename(globbuf
.gl_pathv
[i
]);
466 size
+= strlen(p
) + 1;
469 configs
= uci_malloc(ctx
, size
);
470 buf
= (char *) &configs
[globbuf
.gl_pathc
+ 1];
471 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
474 p
= get_filename(globbuf
.gl_pathv
[i
]);
480 buf
+= strlen(buf
) + 1;
486 static struct uci_package
*uci_file_load(struct uci_context
*ctx
, const char *name
)
488 struct uci_package
*package
= NULL
;
495 /* relative path outside of /etc/config */
497 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
500 /* absolute path outside of /etc/config */
501 filename
= uci_strdup(ctx
, name
);
502 name
= strrchr(name
, '/') + 1;
506 /* config in /etc/config */
507 filename
= uci_config_path(ctx
, name
);
512 file
= uci_open_stream(ctx
, filename
, SEEK_SET
, false, false);
514 UCI_TRAP_SAVE(ctx
, done
);
515 UCI_INTERNAL(uci_import
, ctx
, file
, name
, &package
, true);
516 UCI_TRAP_RESTORE(ctx
);
519 package
->path
= filename
;
520 package
->has_history
= confdir
;
521 uci_load_history(ctx
, package
, false);
525 uci_close_stream(file
);
527 UCI_THROW(ctx
, ctx
->errno
);
531 static UCI_BACKEND(uci_file_backend
, "file",
532 .load
= uci_file_load
,
533 .commit
= uci_file_commit
,
534 .list_configs
= uci_list_config_files
,