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
);
193 if ((word
[1] == 0) || !strcmp(word
+ 1, "onfig"))
194 uci_parse_config(ctx
, &word
);
199 if ((word
[1] == 0) || !strcmp(word
+ 1, "ption"))
200 uci_parse_option(ctx
, &word
);
209 uci_parse_error(ctx
, word
, "invalid command");
213 /* max number of characters that escaping adds to the string */
214 #define UCI_QUOTE_ESCAPE "'\\''"
217 * escape an uci string for export
219 static char *uci_escape(struct uci_context
*ctx
, const char *str
)
225 ctx
->bufsz
= LINEBUF
;
226 ctx
->buf
= malloc(LINEBUF
);
232 end
= strchr(str
, '\'');
234 end
= str
+ strlen(str
);
237 /* make sure that we have enough room in the buffer */
238 while (ofs
+ len
+ sizeof(UCI_QUOTE_ESCAPE
) + 1 > ctx
->bufsz
) {
240 ctx
->buf
= uci_realloc(ctx
, ctx
->buf
, ctx
->bufsz
);
243 /* copy the string until the character before the quote */
244 memcpy(&ctx
->buf
[ofs
], str
, len
);
247 /* end of string? return the buffer */
251 memcpy(&ctx
->buf
[ofs
], UCI_QUOTE_ESCAPE
, sizeof(UCI_QUOTE_ESCAPE
));
252 ofs
+= strlen(&ctx
->buf
[ofs
]);
261 * export a single config package to a file stream
263 static void uci_export_package(struct uci_package
*p
, FILE *stream
, bool header
)
265 struct uci_context
*ctx
= p
->ctx
;
266 struct uci_element
*s
, *o
;
269 fprintf(stream
, "package '%s'\n", uci_escape(ctx
, p
->e
.name
));
270 uci_foreach_element(&p
->sections
, s
) {
271 struct uci_section
*sec
= uci_to_section(s
);
272 fprintf(stream
, "\nconfig '%s'", uci_escape(ctx
, sec
->type
));
273 if (!sec
->anonymous
|| (ctx
->flags
& UCI_FLAG_EXPORT_NAME
))
274 fprintf(stream
, " '%s'", uci_escape(ctx
, sec
->e
.name
));
275 fprintf(stream
, "\n");
276 uci_foreach_element(&sec
->options
, o
) {
277 struct uci_option
*opt
= uci_to_option(o
);
279 case UCI_TYPE_STRING
:
280 fprintf(stream
, "\toption '%s'", uci_escape(ctx
, opt
->e
.name
));
281 fprintf(stream
, " '%s'\n", uci_escape(ctx
, opt
->v
.string
));
284 fprintf(stream
, "\t# unknown type for option '%s'\n", uci_escape(ctx
, opt
->e
.name
));
289 fprintf(stream
, "\n");
292 int uci_export(struct uci_context
*ctx
, FILE *stream
, struct uci_package
*package
, bool header
)
294 struct uci_element
*e
;
297 UCI_ASSERT(ctx
, stream
!= NULL
);
300 uci_export_package(package
, stream
, header
);
302 uci_foreach_element(&ctx
->root
, e
) {
303 uci_export_package(uci_to_package(e
), stream
, header
);
310 int uci_import(struct uci_context
*ctx
, FILE *stream
, const char *name
, struct uci_package
**package
, bool single
)
312 struct uci_parse_context
*pctx
;
315 /* make sure no memory from previous parse attempts is leaked */
318 uci_alloc_parse_context(ctx
);
321 if (*package
&& single
) {
322 pctx
->package
= *package
;
327 * If 'name' was supplied, assume that the supplied stream does not contain
328 * the appropriate 'package <name>' string to specify the config name
329 * NB: the config file can still override the package name
332 UCI_ASSERT(ctx
, uci_validate_str(name
, false));
336 while (!feof(pctx
->file
)) {
338 UCI_TRAP_SAVE(ctx
, error
);
340 uci_parse_line(ctx
, single
);
341 UCI_TRAP_RESTORE(ctx
);
344 if (ctx
->flags
& UCI_FLAG_PERROR
)
345 uci_perror(ctx
, NULL
);
346 if ((ctx
->err
!= UCI_ERR_PARSE
) ||
347 (ctx
->flags
& UCI_FLAG_STRICT
))
348 UCI_THROW(ctx
, ctx
->err
);
351 uci_fixup_section(ctx
, ctx
->pctx
->section
);
352 if (!pctx
->package
&& name
)
353 uci_switch_config(ctx
);
355 *package
= pctx
->package
;
357 pctx
->package
= NULL
;
360 uci_switch_config(ctx
);
362 /* no error happened, we can get rid of the parser context now */
369 static char *uci_config_path(struct uci_context
*ctx
, const char *name
)
373 UCI_ASSERT(ctx
, uci_validate_str(name
, false));
374 filename
= uci_malloc(ctx
, strlen(name
) + strlen(ctx
->confdir
) + 2);
375 sprintf(filename
, "%s/%s", ctx
->confdir
, name
);
380 void uci_file_commit(struct uci_context
*ctx
, struct uci_package
**package
, bool overwrite
)
382 struct uci_package
*p
= *package
;
389 p
->path
= uci_config_path(ctx
, p
->e
.name
);
391 UCI_THROW(ctx
, UCI_ERR_INVAL
);
394 /* open the config file for writing now, so that it is locked */
395 f
= uci_open_stream(ctx
, p
->path
, SEEK_SET
, true, true);
397 /* flush unsaved changes and reload from history file */
398 UCI_TRAP_SAVE(ctx
, done
);
399 if (p
->has_history
) {
401 name
= uci_strdup(ctx
, p
->e
.name
);
402 path
= uci_strdup(ctx
, p
->path
);
403 /* dump our own changes to the history file */
404 if (!uci_list_empty(&p
->history
))
405 UCI_INTERNAL(uci_save
, ctx
, p
);
408 * other processes might have modified the config
409 * as well. dump and reload
411 uci_free_package(&p
);
413 UCI_INTERNAL(uci_import
, ctx
, f
, name
, &p
, true);
416 p
->has_history
= true;
419 /* freed together with the uci_package */
422 /* check for updated history, flush */
423 if (!uci_load_history(ctx
, p
, true))
427 if (!uci_load_history(ctx
, NULL
, true))
433 ftruncate(fileno(f
), 0);
435 uci_export(ctx
, f
, p
, false);
436 UCI_TRAP_RESTORE(ctx
);
445 UCI_THROW(ctx
, ctx
->err
);
450 * This function returns the filename by returning the string
451 * after the last '/' character. By checking for a non-'\0'
452 * character afterwards, directories are ignored (glob marks
453 * those with a trailing '/'
455 static inline char *get_filename(char *path
)
459 p
= strrchr(path
, '/');
466 static char **uci_list_config_files(struct uci_context
*ctx
)
474 dir
= uci_malloc(ctx
, strlen(ctx
->confdir
) + 1 + sizeof("/*"));
475 sprintf(dir
, "%s/*", ctx
->confdir
);
476 if (glob(dir
, GLOB_MARK
, NULL
, &globbuf
) != 0)
477 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
479 size
= sizeof(char *) * (globbuf
.gl_pathc
+ 1);
480 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
483 p
= get_filename(globbuf
.gl_pathv
[i
]);
487 size
+= strlen(p
) + 1;
490 configs
= uci_malloc(ctx
, size
);
491 buf
= (char *) &configs
[globbuf
.gl_pathc
+ 1];
492 for(i
= 0; i
< globbuf
.gl_pathc
; i
++) {
495 p
= get_filename(globbuf
.gl_pathv
[i
]);
499 if (!uci_validate_name(p
))
504 buf
+= strlen(buf
) + 1;
510 static struct uci_package
*uci_file_load(struct uci_context
*ctx
, const char *name
)
512 struct uci_package
*package
= NULL
;
519 /* relative path outside of /etc/config */
521 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
524 /* absolute path outside of /etc/config */
525 filename
= uci_strdup(ctx
, name
);
526 name
= strrchr(name
, '/') + 1;
530 /* config in /etc/config */
531 filename
= uci_config_path(ctx
, name
);
536 file
= uci_open_stream(ctx
, filename
, SEEK_SET
, false, false);
538 UCI_TRAP_SAVE(ctx
, done
);
539 UCI_INTERNAL(uci_import
, ctx
, file
, name
, &package
, true);
540 UCI_TRAP_RESTORE(ctx
);
543 package
->path
= filename
;
544 package
->has_history
= confdir
;
545 uci_load_history(ctx
, package
, false);
549 uci_close_stream(file
);
551 UCI_THROW(ctx
, ctx
->err
);
555 static UCI_BACKEND(uci_file_backend
, "file",
556 .load
= uci_file_load
,
557 .commit
= uci_file_commit
,
558 .list_configs
= uci_list_config_files
,