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 handling uci config history files
20 #include <sys/types.h>
29 /* record a change that was done to a package */
31 uci_add_history(struct uci_context *ctx, struct uci_list *list, int cmd, const char *section, const char *option, const char *value)
33 struct uci_history *h;
34 int size = strlen(section) + 1;
38 size += strlen(value) + 1;
40 h = uci_alloc_element(ctx, history, option, size);
43 h->section = strcpy(ptr, section);
45 ptr += strlen(ptr) + 1;
46 h->value = strcpy(ptr, value);
48 uci_list_add(list, &h->e.list);
52 uci_free_history(struct uci_history *h)
56 if ((h->section != NULL) &&
57 (h->section != uci_dataptr(h))) {
61 uci_free_element(&h->e);
65 int uci_set_savedir(struct uci_context *ctx, const char *dir)
70 UCI_ASSERT(ctx, dir != NULL);
72 sdir = uci_strdup(ctx, dir);
73 if (ctx->savedir != uci_savedir)
79 int uci_add_history_path(struct uci_context *ctx, const char *dir)
81 struct uci_element *e;
84 UCI_ASSERT(ctx, dir != NULL);
85 e = uci_alloc_generic(ctx, UCI_TYPE_PATH, dir, sizeof(struct uci_element));
86 uci_list_add(&ctx->history_path, &e->list);
91 static inline int uci_parse_history_tuple(struct uci_context *ctx, char **buf, struct uci_ptr *ptr)
93 int c = UCI_CMD_CHANGE;
106 /* UCI_CMD_ADD is used for anonymous sections or list values */
110 c = UCI_CMD_LIST_ADD;
114 if (c != UCI_CMD_CHANGE)
117 UCI_INTERNAL(uci_parse_ptr, ctx, ptr, *buf);
121 if (ptr->flags & UCI_LOOKUP_EXTENDED)
125 case UCI_CMD_REORDER:
126 if (!ptr->value || ptr->option)
130 if (!ptr->value || !uci_validate_name(ptr->value))
133 case UCI_CMD_LIST_ADD:
141 UCI_THROW(ctx, UCI_ERR_INVAL);
145 static void uci_parse_history_line(struct uci_context *ctx, struct uci_package *p, char *buf)
147 struct uci_element *e = NULL;
151 cmd = uci_parse_history_tuple(ctx, &buf, &ptr);
152 if (strcmp(ptr.package, p->e.name) != 0)
155 if (ctx->flags & UCI_FLAG_SAVED_HISTORY)
156 uci_add_history(ctx, &p->saved_history, cmd, ptr.section, ptr.option, ptr.value);
159 case UCI_CMD_REORDER:
160 expand_ptr(ctx, &ptr, true);
162 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
163 UCI_INTERNAL(uci_reorder_section, ctx, ptr.s, strtoul(ptr.value, NULL, 10));
166 UCI_INTERNAL(uci_rename, ctx, &ptr);
169 UCI_INTERNAL(uci_delete, ctx, &ptr);
171 case UCI_CMD_LIST_ADD:
172 UCI_INTERNAL(uci_add_list, ctx, &ptr);
176 UCI_INTERNAL(uci_set, ctx, &ptr);
178 if (!ptr.option && e && (cmd == UCI_CMD_ADD))
179 uci_to_section(e)->anonymous = true;
184 UCI_THROW(ctx, UCI_ERR_PARSE);
187 /* returns the number of changes that were successfully parsed */
188 static int uci_parse_history(struct uci_context *ctx, FILE *stream, struct uci_package *p)
190 struct uci_parse_context *pctx;
193 /* make sure no memory from previous parse attempts is leaked */
196 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
200 while (!feof(pctx->file)) {
206 * ignore parse errors in single lines, we want to preserve as much
207 * history as possible
209 UCI_TRAP_SAVE(ctx, error);
210 uci_parse_history_line(ctx, p, pctx->buf);
211 UCI_TRAP_RESTORE(ctx);
217 /* no error happened, we can get rid of the parser context now */
222 /* returns the number of changes that were successfully parsed */
223 static int uci_load_history_file(struct uci_context *ctx, struct uci_package *p, char *filename, FILE **f, bool flush)
228 UCI_TRAP_SAVE(ctx, done);
229 stream = uci_open_stream(ctx, filename, SEEK_SET, flush, false);
231 changes = uci_parse_history(ctx, stream, p);
232 UCI_TRAP_RESTORE(ctx);
237 uci_close_stream(stream);
241 /* returns the number of changes that were successfully parsed */
242 static int uci_load_history(struct uci_context *ctx, struct uci_package *p, bool flush)
244 struct uci_element *e;
245 char *filename = NULL;
252 uci_foreach_element(&ctx->history_path, e) {
253 if ((asprintf(&filename, "%s/%s", e->name, p->e.name) < 0) || !filename)
254 UCI_THROW(ctx, UCI_ERR_MEM);
256 uci_load_history_file(ctx, p, filename, NULL, false);
260 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
261 UCI_THROW(ctx, UCI_ERR_MEM);
263 changes = uci_load_history_file(ctx, p, filename, &f, flush);
264 if (flush && f && (changes > 0)) {
266 if (ftruncate(fileno(f), 0) < 0) {
268 UCI_THROW(ctx, UCI_ERR_IO);
278 static void uci_filter_history(struct uci_context *ctx, const char *name, const char *section, const char *option)
280 struct uci_parse_context *pctx;
281 struct uci_element *e, *tmp;
282 struct uci_list list;
283 char *filename = NULL;
287 uci_list_init(&list);
288 uci_alloc_parse_context(ctx);
291 if ((asprintf(&filename, "%s/%s", ctx->savedir, name) < 0) || !filename)
292 UCI_THROW(ctx, UCI_ERR_MEM);
294 UCI_TRAP_SAVE(ctx, done);
295 f = uci_open_stream(ctx, filename, SEEK_SET, true, false);
298 struct uci_element *e;
306 /* NB: need to allocate the element before the call to
307 * uci_parse_history_tuple, otherwise the original string
308 * gets modified before it is saved */
309 e = uci_alloc_generic(ctx, UCI_TYPE_HISTORY, pctx->buf, sizeof(struct uci_element));
310 uci_list_add(&list, &e->list);
312 uci_parse_history_tuple(ctx, &buf, &ptr);
314 if (!ptr.section || (strcmp(section, ptr.section) != 0))
318 if (!ptr.option || (strcmp(option, ptr.option) != 0))
321 /* match, drop this element again */
325 /* rebuild the history file */
327 if (ftruncate(fileno(f), 0) < 0)
328 UCI_THROW(ctx, UCI_ERR_IO);
329 uci_foreach_element_safe(&list, tmp, e) {
330 fprintf(f, "%s\n", e->name);
333 UCI_TRAP_RESTORE(ctx);
338 uci_close_stream(pctx->file);
339 uci_foreach_element_safe(&list, tmp, e) {
345 int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr)
347 char *package = NULL;
348 char *section = NULL;
352 expand_ptr(ctx, ptr, false);
353 UCI_ASSERT(ctx, ptr->p->has_history);
356 * - flush unwritten changes
357 * - save the package name
358 * - unload the package
359 * - filter the history
360 * - reload the package
362 UCI_TRAP_SAVE(ctx, error);
363 UCI_INTERNAL(uci_save, ctx, ptr->p);
365 /* NB: need to clone package, section and option names,
366 * as they may get freed on uci_free_package() */
367 package = uci_strdup(ctx, ptr->p->e.name);
369 section = uci_strdup(ctx, ptr->section);
371 option = uci_strdup(ctx, ptr->option);
373 uci_free_package(&ptr->p);
374 uci_filter_history(ctx, package, section, option);
376 UCI_INTERNAL(uci_load, ctx, package, &ptr->p);
377 UCI_TRAP_RESTORE(ctx);
388 UCI_THROW(ctx, ctx->err);
392 int uci_save(struct uci_context *ctx, struct uci_package *p)
395 char *filename = NULL;
396 struct uci_element *e, *tmp;
400 UCI_ASSERT(ctx, p != NULL);
403 * if the config file was outside of the /etc/config path,
404 * don't save the history to a file, update the real file
406 * does not modify the uci_package pointer
409 return uci_commit(ctx, &p, false);
411 if (uci_list_empty(&p->history))
414 if (stat(ctx->savedir, &statbuf) < 0)
415 mkdir(ctx->savedir, UCI_DIRMODE);
416 else if ((statbuf.st_mode & S_IFMT) != S_IFDIR)
417 UCI_THROW(ctx, UCI_ERR_IO);
419 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
420 UCI_THROW(ctx, UCI_ERR_MEM);
422 uci_foreach_element(&ctx->hooks, tmp) {
423 struct uci_hook *hook = uci_to_hook(tmp);
428 uci_foreach_element(&p->history, e) {
429 hook->ops->set(hook->ops, p, uci_to_history(e));
434 UCI_TRAP_SAVE(ctx, done);
435 f = uci_open_stream(ctx, filename, SEEK_END, true, true);
436 UCI_TRAP_RESTORE(ctx);
438 uci_foreach_element_safe(&p->history, tmp, e) {
439 struct uci_history *h = uci_to_history(e);
452 case UCI_CMD_REORDER:
455 case UCI_CMD_LIST_ADD:
462 fprintf(f, "%s%s.%s", prefix, p->e.name, h->section);
464 fprintf(f, ".%s", e->name);
466 if (h->cmd == UCI_CMD_REMOVE)
469 fprintf(f, "=%s\n", h->value);
478 UCI_THROW(ctx, ctx->err);