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;
103 /* UCI_CMD_ADD is used for anonymous sections or list values */
107 c = UCI_CMD_LIST_ADD;
111 if (c != UCI_CMD_CHANGE)
114 UCI_INTERNAL(uci_parse_ptr, ctx, ptr, *buf);
118 if (ptr->flags & UCI_LOOKUP_EXTENDED)
123 if (!ptr->value || !uci_validate_name(ptr->value))
126 case UCI_CMD_LIST_ADD:
134 UCI_THROW(ctx, UCI_ERR_INVAL);
138 static void uci_parse_history_line(struct uci_context *ctx, struct uci_package *p, char *buf)
140 struct uci_element *e = NULL;
144 cmd = uci_parse_history_tuple(ctx, &buf, &ptr);
145 if (strcmp(ptr.package, p->e.name) != 0)
148 if (ctx->flags & UCI_FLAG_SAVED_HISTORY)
149 uci_add_history(ctx, &p->saved_history, cmd, ptr.section, ptr.option, ptr.value);
153 UCI_INTERNAL(uci_rename, ctx, &ptr);
156 UCI_INTERNAL(uci_delete, ctx, &ptr);
158 case UCI_CMD_LIST_ADD:
159 UCI_INTERNAL(uci_add_list, ctx, &ptr);
163 UCI_INTERNAL(uci_set, ctx, p, ptr.section, ptr.option, ptr.value, &e);
164 if (!ptr.option && e && (cmd == UCI_CMD_ADD))
165 uci_to_section(e)->anonymous = true;
170 UCI_THROW(ctx, UCI_ERR_PARSE);
173 /* returns the number of changes that were successfully parsed */
174 static int uci_parse_history(struct uci_context *ctx, FILE *stream, struct uci_package *p)
176 struct uci_parse_context *pctx;
179 /* make sure no memory from previous parse attempts is leaked */
182 pctx = (struct uci_parse_context *) uci_malloc(ctx, sizeof(struct uci_parse_context));
186 while (!feof(pctx->file)) {
192 * ignore parse errors in single lines, we want to preserve as much
193 * history as possible
195 UCI_TRAP_SAVE(ctx, error);
196 uci_parse_history_line(ctx, p, pctx->buf);
197 UCI_TRAP_RESTORE(ctx);
203 /* no error happened, we can get rid of the parser context now */
208 /* returns the number of changes that were successfully parsed */
209 static int uci_load_history_file(struct uci_context *ctx, struct uci_package *p, char *filename, FILE **f, bool flush)
214 UCI_TRAP_SAVE(ctx, done);
215 stream = uci_open_stream(ctx, filename, SEEK_SET, flush, false);
217 changes = uci_parse_history(ctx, stream, p);
218 UCI_TRAP_RESTORE(ctx);
223 uci_close_stream(stream);
227 /* returns the number of changes that were successfully parsed */
228 static int uci_load_history(struct uci_context *ctx, struct uci_package *p, bool flush)
230 struct uci_element *e;
231 char *filename = NULL;
238 uci_foreach_element(&ctx->history_path, e) {
239 if ((asprintf(&filename, "%s/%s", e->name, p->e.name) < 0) || !filename)
240 UCI_THROW(ctx, UCI_ERR_MEM);
242 uci_load_history_file(ctx, p, filename, NULL, false);
246 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
247 UCI_THROW(ctx, UCI_ERR_MEM);
249 changes = uci_load_history_file(ctx, p, filename, &f, flush);
250 if (flush && f && (changes > 0)) {
252 ftruncate(fileno(f), 0);
261 static void uci_filter_history(struct uci_context *ctx, const char *name, const char *section, const char *option)
263 struct uci_parse_context *pctx;
264 struct uci_element *e, *tmp;
265 struct uci_list list;
266 char *filename = NULL;
270 uci_list_init(&list);
271 uci_alloc_parse_context(ctx);
274 if ((asprintf(&filename, "%s/%s", ctx->savedir, name) < 0) || !filename)
275 UCI_THROW(ctx, UCI_ERR_MEM);
277 UCI_TRAP_SAVE(ctx, done);
278 f = uci_open_stream(ctx, filename, SEEK_SET, true, false);
281 struct uci_element *e;
289 /* NB: need to allocate the element before the call to
290 * uci_parse_history_tuple, otherwise the original string
291 * gets modified before it is saved */
292 e = uci_alloc_generic(ctx, UCI_TYPE_HISTORY, pctx->buf, sizeof(struct uci_element));
293 uci_list_add(&list, &e->list);
295 uci_parse_history_tuple(ctx, &buf, &ptr);
297 if (!ptr.section || (strcmp(section, ptr.section) != 0))
301 if (!ptr.option || (strcmp(option, ptr.option) != 0))
304 /* match, drop this element again */
308 /* rebuild the history file */
310 ftruncate(fileno(f), 0);
311 uci_foreach_element_safe(&list, tmp, e) {
312 fprintf(f, "%s\n", e->name);
315 UCI_TRAP_RESTORE(ctx);
321 uci_foreach_element_safe(&list, tmp, e) {
327 int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr)
329 char *package = NULL;
330 char *section = NULL;
334 expand_ptr(ctx, ptr, true);
335 UCI_ASSERT(ctx, ptr->p->has_history);
338 * - flush unwritten changes
339 * - save the package name
340 * - unload the package
341 * - filter the history
342 * - reload the package
344 UCI_TRAP_SAVE(ctx, error);
345 UCI_INTERNAL(uci_save, ctx, ptr->p);
347 /* NB: need to clone package, section and option names,
348 * as they may get freed on uci_free_package() */
349 package = uci_strdup(ctx, ptr->p->e.name);
350 section = uci_strdup(ctx, ptr->section);
351 option = uci_strdup(ctx, ptr->option);
353 uci_free_package(&ptr->p);
354 uci_filter_history(ctx, package, section, option);
356 UCI_INTERNAL(uci_load, ctx, package, &ptr->p);
357 UCI_TRAP_RESTORE(ctx);
368 UCI_THROW(ctx, ctx->err);
372 int uci_save(struct uci_context *ctx, struct uci_package *p)
375 char *filename = NULL;
376 struct uci_element *e, *tmp;
380 UCI_ASSERT(ctx, p != NULL);
383 * if the config file was outside of the /etc/config path,
384 * don't save the history to a file, update the real file
386 * does not modify the uci_package pointer
389 return uci_commit(ctx, &p, false);
391 if (uci_list_empty(&p->history))
394 if (stat(ctx->savedir, &statbuf) < 0)
395 mkdir(ctx->savedir, UCI_DIRMODE);
396 else if ((statbuf.st_mode & S_IFMT) != S_IFDIR)
397 UCI_THROW(ctx, UCI_ERR_IO);
399 if ((asprintf(&filename, "%s/%s", ctx->savedir, p->e.name) < 0) || !filename)
400 UCI_THROW(ctx, UCI_ERR_MEM);
403 UCI_TRAP_SAVE(ctx, done);
404 f = uci_open_stream(ctx, filename, SEEK_END, true, true);
405 UCI_TRAP_RESTORE(ctx);
407 uci_foreach_element_safe(&p->history, tmp, e) {
408 struct uci_history *h = uci_to_history(e);
421 case UCI_CMD_LIST_ADD:
428 fprintf(f, "%s%s.%s", prefix, p->e.name, h->section);
430 fprintf(f, ".%s", e->name);
432 if (h->cmd == UCI_CMD_REMOVE)
435 fprintf(f, "=%s\n", h->value);
444 UCI_THROW(ctx, ctx->err);