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 handling uci config delta files
20 #include <sys/types.h>
32 #include "uci_internal.h"
34 /* record a change that was done to a package */
36 uci_add_delta(struct uci_context *ctx, struct uci_list *list, int cmd, const char *section, const char *option, const char *value)
39 int size = strlen(section) + 1;
43 size += strlen(value) + 1;
45 h = uci_alloc_element(ctx, delta, option, size);
48 h->section = strcpy(ptr, section);
50 ptr += strlen(ptr) + 1;
51 h->value = strcpy(ptr, value);
53 uci_list_add(list, &h->e.list);
57 uci_free_delta(struct uci_delta *h)
61 if ((h->section != NULL) &&
62 (h->section != uci_dataptr(h))) {
66 uci_free_element(&h->e);
69 static void uci_delta_save(struct uci_context *ctx, FILE *f,
70 const char *name, const struct uci_delta *h)
72 const struct uci_element *e = &h->e;
73 char prefix[2] = {0, 0};
75 if (h->cmd <= __UCI_CMD_LAST)
76 prefix[0] = uci_command_char[h->cmd];
78 fprintf(f, "%s%s.%s", prefix, name, h->section);
80 fprintf(f, ".%s", e->name);
82 if (h->cmd == UCI_CMD_REMOVE && !h->value)
88 for (i = 0; h->value[i]; i++) {
89 unsigned char c = h->value[i];
99 int uci_set_savedir(struct uci_context *ctx, const char *dir)
102 struct uci_element *e, *tmp;
103 volatile bool exists = false;
106 UCI_ASSERT(ctx, dir != NULL);
108 /* Move dir to the end of ctx->delta_path */
109 uci_foreach_element_safe(&ctx->delta_path, tmp, e) {
110 if (!strcmp(e->name, dir)) {
112 uci_list_del(&e->list);
117 e = uci_alloc_generic(ctx, UCI_TYPE_PATH, dir, sizeof(struct uci_element));
118 uci_list_add(&ctx->delta_path, &e->list);
120 sdir = uci_strdup(ctx, dir);
121 if (ctx->savedir != uci_savedir)
127 int uci_add_delta_path(struct uci_context *ctx, const char *dir)
129 struct uci_element *e;
130 struct uci_list *savedir;
133 UCI_ASSERT(ctx, dir != NULL);
135 /* Duplicate delta path is not allowed */
136 uci_foreach_element(&ctx->delta_path, e) {
137 if (!strcmp(e->name, dir))
138 UCI_THROW(ctx, UCI_ERR_DUPLICATE);
141 e = uci_alloc_generic(ctx, UCI_TYPE_PATH, dir, sizeof(struct uci_element));
142 /* Keep savedir at the end of ctx->delta_path list */
143 savedir = ctx->delta_path.prev;
144 uci_list_insert(savedir->prev, &e->list);
149 char const uci_command_char[] = {
151 [UCI_CMD_REMOVE] = '-',
152 [UCI_CMD_CHANGE] = 0,
153 [UCI_CMD_RENAME] = '@',
154 [UCI_CMD_REORDER] = '^',
155 [UCI_CMD_LIST_ADD] = '|',
156 [UCI_CMD_LIST_DEL] = '~'
159 static inline int uci_parse_delta_tuple(struct uci_context *ctx, struct uci_ptr *ptr)
161 struct uci_parse_context *pctx = ctx->pctx;
162 char *str = pctx_cur_str(pctx), *arg;
165 UCI_INTERNAL(uci_parse_argument, ctx, ctx->pctx->file, &str, &arg);
169 for (c = 0; c <= __UCI_CMD_LAST; c++) {
170 if (uci_command_char[c] == *arg)
173 if (c > __UCI_CMD_LAST)
176 if (c != UCI_CMD_CHANGE)
179 UCI_INTERNAL(uci_parse_ptr, ctx, ptr, arg);
183 if (ptr->flags & UCI_LOOKUP_EXTENDED)
185 if (c != UCI_CMD_REMOVE && !ptr->value) {
190 case UCI_CMD_REORDER:
191 if (!ptr->value || ptr->option)
195 if (!ptr->value || !uci_validate_name(ptr->value))
198 case UCI_CMD_LIST_ADD:
201 case UCI_CMD_LIST_DEL:
209 UCI_THROW(ctx, UCI_ERR_INVAL);
213 static void uci_parse_delta_line(struct uci_context *ctx, struct uci_package *p)
215 struct uci_element *e = NULL;
219 cmd = uci_parse_delta_tuple(ctx, &ptr);
220 if (strcmp(ptr.package, p->e.name) != 0)
223 if (ctx->flags & UCI_FLAG_SAVED_DELTA)
224 uci_add_delta(ctx, &p->saved_delta, cmd, ptr.section, ptr.option, ptr.value);
227 case UCI_CMD_REORDER:
228 uci_expand_ptr(ctx, &ptr, true);
230 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
231 UCI_INTERNAL(uci_reorder_section, ctx, ptr.s, strtoul(ptr.value, NULL, 10));
234 UCI_INTERNAL(uci_rename, ctx, &ptr);
237 UCI_INTERNAL(uci_delete, ctx, &ptr);
239 case UCI_CMD_LIST_ADD:
240 UCI_INTERNAL(uci_add_list, ctx, &ptr);
242 case UCI_CMD_LIST_DEL:
243 UCI_INTERNAL(uci_del_list, ctx, &ptr);
247 UCI_INTERNAL(uci_set, ctx, &ptr);
249 if (!ptr.option && e && (cmd == UCI_CMD_ADD))
250 uci_to_section(e)->anonymous = true;
255 UCI_THROW(ctx, UCI_ERR_PARSE);
258 /* returns the number of changes that were successfully parsed */
259 static int uci_parse_delta(struct uci_context *ctx, FILE *stream, struct uci_package *p)
261 struct uci_parse_context *pctx;
262 volatile int changes = 0;
264 /* make sure no memory from previous parse attempts is leaked */
267 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
271 while (!feof(pctx->file)) {
278 * ignore parse errors in single lines, we want to preserve as much
281 UCI_TRAP_SAVE(ctx, error);
282 uci_parse_delta_line(ctx, p);
283 UCI_TRAP_RESTORE(ctx);
289 /* no error happened, we can get rid of the parser context now */
294 /* returns the number of changes that were successfully parsed */
295 static int uci_load_delta_file(struct uci_context *ctx, struct uci_package *p, char *filename, FILE **f, bool flush)
297 FILE *volatile stream = NULL;
298 volatile int changes = 0;
300 UCI_TRAP_SAVE(ctx, done);
301 stream = uci_open_stream(ctx, filename, NULL, SEEK_SET, flush, false);
302 UCI_TRAP_RESTORE(ctx);
305 changes = uci_parse_delta(ctx, stream, p);
311 uci_close_stream(stream);
315 /* returns the number of changes that were successfully parsed */
316 __private int uci_load_delta(struct uci_context *ctx, struct uci_package *p, bool flush)
318 struct uci_element *e;
319 char *filename = NULL;
320 FILE *volatile f = NULL;
321 volatile int changes = 0;
326 uci_foreach_element(&ctx->delta_path, e) {
327 if ((asprintf(&filename, "%s/%s", e->name, p->e.name) < 0) || !filename)
328 UCI_THROW(ctx, UCI_ERR_MEM);
330 changes += uci_load_delta_file(ctx, p, filename, NULL, false);
334 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
335 UCI_THROW(ctx, UCI_ERR_MEM);
336 UCI_TRAP_SAVE(ctx, done);
337 f = uci_open_stream(ctx, filename, NULL, SEEK_SET, flush, false);
338 UCI_TRAP_RESTORE(ctx);
340 if (flush && f && (changes > 0)) {
341 if (ftruncate(fileno(f), 0) < 0) {
344 UCI_THROW(ctx, UCI_ERR_IO);
355 static void uci_filter_delta(struct uci_context *ctx, const char *name, const char *section, const char *option)
357 struct uci_parse_context *pctx;
358 struct uci_element *e, *tmp;
359 struct uci_list list;
360 char *filename = NULL;
364 uci_list_init(&list);
365 uci_alloc_parse_context(ctx);
368 if ((asprintf(&filename, "%s/%s", ctx->savedir, name) < 0) || !filename)
369 UCI_THROW(ctx, UCI_ERR_MEM);
371 UCI_TRAP_SAVE(ctx, done);
372 f = uci_open_stream(ctx, filename, NULL, SEEK_SET, true, false);
383 c = uci_parse_delta_tuple(ctx, &ptr);
386 if (!ptr.section || (strcmp(section, ptr.section) != 0))
389 if (match && option) {
390 if (!ptr.option || (strcmp(option, ptr.option) != 0))
395 uci_add_delta(ctx, &list, c,
396 ptr.section, ptr.option, ptr.value);
400 /* rebuild the delta file */
402 if (ftruncate(fileno(f), 0) < 0)
403 UCI_THROW(ctx, UCI_ERR_IO);
404 uci_foreach_element_safe(&list, tmp, e) {
405 struct uci_delta *h = uci_to_delta(e);
406 uci_delta_save(ctx, f, name, h);
409 UCI_TRAP_RESTORE(ctx);
413 uci_close_stream(pctx->file);
414 uci_foreach_element_safe(&list, tmp, e) {
415 uci_free_delta(uci_to_delta(e));
420 int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr)
422 char *volatile package = NULL;
423 char *volatile section = NULL;
424 char *volatile option = NULL;
427 uci_expand_ptr(ctx, ptr, false);
428 UCI_ASSERT(ctx, ptr->p->has_delta);
431 * - flush unwritten changes
432 * - save the package name
433 * - unload the package
435 * - reload the package
437 UCI_TRAP_SAVE(ctx, error);
438 UCI_INTERNAL(uci_save, ctx, ptr->p);
440 /* NB: need to clone package, section and option names,
441 * as they may get freed on uci_free_package() */
442 package = uci_strdup(ctx, ptr->p->e.name);
444 section = uci_strdup(ctx, ptr->section);
446 option = uci_strdup(ctx, ptr->option);
448 uci_free_package(&ptr->p);
449 uci_filter_delta(ctx, package, section, option);
451 UCI_INTERNAL(uci_load, ctx, package, &ptr->p);
452 UCI_TRAP_RESTORE(ctx);
460 UCI_THROW(ctx, ctx->err);
464 int uci_save(struct uci_context *ctx, struct uci_package *p)
466 FILE *volatile f = NULL;
467 char *filename = NULL;
468 struct uci_element *e, *tmp;
472 UCI_ASSERT(ctx, p != NULL);
475 * if the config file was outside of the /etc/config path,
476 * don't save the delta to a file, update the real file
478 * does not modify the uci_package pointer
481 return uci_commit(ctx, &p, false);
483 if (uci_list_empty(&p->delta))
486 if (stat(ctx->savedir, &statbuf) < 0) {
487 if (stat(ctx->confdir, &statbuf) == 0) {
488 mkdir(ctx->savedir, statbuf.st_mode);
490 mkdir(ctx->savedir, UCI_DIRMODE);
492 } else if ((statbuf.st_mode & S_IFMT) != S_IFDIR) {
493 UCI_THROW(ctx, UCI_ERR_IO);
496 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
497 UCI_THROW(ctx, UCI_ERR_MEM);
500 UCI_TRAP_SAVE(ctx, done);
501 f = uci_open_stream(ctx, filename, NULL, SEEK_END, true, true);
502 UCI_TRAP_RESTORE(ctx);
504 uci_foreach_element_safe(&p->delta, tmp, e) {
505 struct uci_delta *h = uci_to_delta(e);
506 uci_delta_save(ctx, f, p->e.name, h);
514 UCI_THROW(ctx, ctx->err);