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);
70 int uci_set_savedir(struct uci_context *ctx, const char *dir)
75 UCI_ASSERT(ctx, dir != NULL);
77 sdir = uci_strdup(ctx, dir);
78 if (ctx->savedir != uci_savedir)
84 int uci_add_delta_path(struct uci_context *ctx, const char *dir)
86 struct uci_element *e;
89 UCI_ASSERT(ctx, dir != NULL);
90 if (!strcmp(dir, ctx->savedir))
92 e = uci_alloc_generic(ctx, UCI_TYPE_PATH, dir, sizeof(struct uci_element));
93 uci_list_add(&ctx->delta_path, &e->list);
98 static inline int uci_parse_delta_tuple(struct uci_context *ctx, char **buf, struct uci_ptr *ptr)
100 int c = UCI_CMD_CHANGE;
113 /* UCI_CMD_ADD is used for anonymous sections or list values */
117 c = UCI_CMD_LIST_ADD;
120 c = UCI_CMD_LIST_DEL;
124 if (c != UCI_CMD_CHANGE)
127 UCI_INTERNAL(uci_parse_ptr, ctx, ptr, *buf);
131 if (ptr->flags & UCI_LOOKUP_EXTENDED)
135 case UCI_CMD_REORDER:
136 if (!ptr->value || ptr->option)
140 if (!ptr->value || !uci_validate_name(ptr->value))
143 case UCI_CMD_LIST_ADD:
146 case UCI_CMD_LIST_DEL:
154 UCI_THROW(ctx, UCI_ERR_INVAL);
158 static void uci_parse_delta_line(struct uci_context *ctx, struct uci_package *p, char *buf)
160 struct uci_element *e = NULL;
164 cmd = uci_parse_delta_tuple(ctx, &buf, &ptr);
165 if (strcmp(ptr.package, p->e.name) != 0)
168 if (ctx->flags & UCI_FLAG_SAVED_DELTA)
169 uci_add_delta(ctx, &p->saved_delta, cmd, ptr.section, ptr.option, ptr.value);
172 case UCI_CMD_REORDER:
173 uci_expand_ptr(ctx, &ptr, true);
175 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
176 UCI_INTERNAL(uci_reorder_section, ctx, ptr.s, strtoul(ptr.value, NULL, 10));
179 UCI_INTERNAL(uci_rename, ctx, &ptr);
182 UCI_INTERNAL(uci_delete, ctx, &ptr);
184 case UCI_CMD_LIST_ADD:
185 UCI_INTERNAL(uci_add_list, ctx, &ptr);
187 case UCI_CMD_LIST_DEL:
188 UCI_INTERNAL(uci_del_list, ctx, &ptr);
192 UCI_INTERNAL(uci_set, ctx, &ptr);
194 if (!ptr.option && e && (cmd == UCI_CMD_ADD))
195 uci_to_section(e)->anonymous = true;
200 UCI_THROW(ctx, UCI_ERR_PARSE);
203 /* returns the number of changes that were successfully parsed */
204 static int uci_parse_delta(struct uci_context *ctx, FILE *stream, struct uci_package *p)
206 struct uci_parse_context *pctx;
209 /* make sure no memory from previous parse attempts is leaked */
212 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
216 while (!feof(pctx->file)) {
222 * ignore parse errors in single lines, we want to preserve as much
225 UCI_TRAP_SAVE(ctx, error);
226 uci_parse_delta_line(ctx, p, pctx->buf);
227 UCI_TRAP_RESTORE(ctx);
233 /* no error happened, we can get rid of the parser context now */
238 /* returns the number of changes that were successfully parsed */
239 static int uci_load_delta_file(struct uci_context *ctx, struct uci_package *p, char *filename, FILE **f, bool flush)
244 UCI_TRAP_SAVE(ctx, done);
245 stream = uci_open_stream(ctx, filename, NULL, SEEK_SET, flush, false);
247 changes = uci_parse_delta(ctx, stream, p);
248 UCI_TRAP_RESTORE(ctx);
253 uci_close_stream(stream);
257 /* returns the number of changes that were successfully parsed */
258 __private int uci_load_delta(struct uci_context *ctx, struct uci_package *p, bool flush)
260 struct uci_element *e;
261 char *filename = NULL;
268 uci_foreach_element(&ctx->delta_path, e) {
269 if ((asprintf(&filename, "%s/%s", e->name, p->e.name) < 0) || !filename)
270 UCI_THROW(ctx, UCI_ERR_MEM);
272 uci_load_delta_file(ctx, p, filename, NULL, false);
276 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
277 UCI_THROW(ctx, UCI_ERR_MEM);
279 changes = uci_load_delta_file(ctx, p, filename, &f, flush);
280 if (flush && f && (changes > 0)) {
282 if (ftruncate(fileno(f), 0) < 0) {
284 UCI_THROW(ctx, UCI_ERR_IO);
293 static void uci_filter_delta(struct uci_context *ctx, const char *name, const char *section, const char *option)
295 struct uci_parse_context *pctx;
296 struct uci_element *e, *tmp;
297 struct uci_list list;
298 char *filename = NULL;
302 uci_list_init(&list);
303 uci_alloc_parse_context(ctx);
306 if ((asprintf(&filename, "%s/%s", ctx->savedir, name) < 0) || !filename)
307 UCI_THROW(ctx, UCI_ERR_MEM);
309 UCI_TRAP_SAVE(ctx, done);
310 f = uci_open_stream(ctx, filename, NULL, SEEK_SET, true, false);
313 struct uci_element *e;
321 /* NB: need to allocate the element before the call to
322 * uci_parse_delta_tuple, otherwise the original string
323 * gets modified before it is saved */
324 e = uci_alloc_generic(ctx, UCI_TYPE_DELTA, pctx->buf, sizeof(struct uci_element));
325 uci_list_add(&list, &e->list);
327 uci_parse_delta_tuple(ctx, &buf, &ptr);
329 if (!ptr.section || (strcmp(section, ptr.section) != 0))
333 if (!ptr.option || (strcmp(option, ptr.option) != 0))
336 /* match, drop this element again */
340 /* rebuild the delta file */
342 if (ftruncate(fileno(f), 0) < 0)
343 UCI_THROW(ctx, UCI_ERR_IO);
344 uci_foreach_element_safe(&list, tmp, e) {
345 fprintf(f, "%s\n", e->name);
348 UCI_TRAP_RESTORE(ctx);
352 uci_close_stream(pctx->file);
353 uci_foreach_element_safe(&list, tmp, e) {
359 int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr)
361 char *package = NULL;
362 char *section = NULL;
366 uci_expand_ptr(ctx, ptr, false);
367 UCI_ASSERT(ctx, ptr->p->has_delta);
370 * - flush unwritten changes
371 * - save the package name
372 * - unload the package
374 * - reload the package
376 UCI_TRAP_SAVE(ctx, error);
377 UCI_INTERNAL(uci_save, ctx, ptr->p);
379 /* NB: need to clone package, section and option names,
380 * as they may get freed on uci_free_package() */
381 package = uci_strdup(ctx, ptr->p->e.name);
383 section = uci_strdup(ctx, ptr->section);
385 option = uci_strdup(ctx, ptr->option);
387 uci_free_package(&ptr->p);
388 uci_filter_delta(ctx, package, section, option);
390 UCI_INTERNAL(uci_load, ctx, package, &ptr->p);
391 UCI_TRAP_RESTORE(ctx);
399 UCI_THROW(ctx, ctx->err);
403 int uci_save(struct uci_context *ctx, struct uci_package *p)
406 char *filename = NULL;
407 struct uci_element *e, *tmp;
411 UCI_ASSERT(ctx, p != NULL);
414 * if the config file was outside of the /etc/config path,
415 * don't save the delta to a file, update the real file
417 * does not modify the uci_package pointer
420 return uci_commit(ctx, &p, false);
422 if (uci_list_empty(&p->delta))
425 if (stat(ctx->savedir, &statbuf) < 0) {
426 if (stat(ctx->confdir, &statbuf) == 0) {
427 mkdir(ctx->savedir, statbuf.st_mode);
429 mkdir(ctx->savedir, UCI_DIRMODE);
431 } else if ((statbuf.st_mode & S_IFMT) != S_IFDIR) {
432 UCI_THROW(ctx, UCI_ERR_IO);
435 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
436 UCI_THROW(ctx, UCI_ERR_MEM);
439 UCI_TRAP_SAVE(ctx, done);
440 f = uci_open_stream(ctx, filename, NULL, SEEK_END, true, true);
441 UCI_TRAP_RESTORE(ctx);
443 uci_foreach_element_safe(&p->delta, tmp, e) {
444 struct uci_delta *h = uci_to_delta(e);
457 case UCI_CMD_REORDER:
460 case UCI_CMD_LIST_ADD:
463 case UCI_CMD_LIST_DEL:
470 fprintf(f, "%s%s.%s", prefix, p->e.name, h->section);
472 fprintf(f, ".%s", e->name);
474 if (h->cmd == UCI_CMD_REMOVE && !h->value)
480 for (i = 0; h->value[i]; i++) {
481 unsigned char c = h->value[i];
496 UCI_THROW(ctx, ctx->err);