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
, &ptr
);
165 if (!ptr
.option
&& e
&& (cmd
== UCI_CMD_ADD
))
166 uci_to_section(e
)->anonymous
= true;
171 UCI_THROW(ctx
, UCI_ERR_PARSE
);
174 /* returns the number of changes that were successfully parsed */
175 static int uci_parse_history(struct uci_context
*ctx
, FILE *stream
, struct uci_package
*p
)
177 struct uci_parse_context
*pctx
;
180 /* make sure no memory from previous parse attempts is leaked */
183 pctx
= (struct uci_parse_context
*) uci_malloc(ctx
, sizeof(struct uci_parse_context
));
187 while (!feof(pctx
->file
)) {
193 * ignore parse errors in single lines, we want to preserve as much
194 * history as possible
196 UCI_TRAP_SAVE(ctx
, error
);
197 uci_parse_history_line(ctx
, p
, pctx
->buf
);
198 UCI_TRAP_RESTORE(ctx
);
204 /* no error happened, we can get rid of the parser context now */
209 /* returns the number of changes that were successfully parsed */
210 static int uci_load_history_file(struct uci_context
*ctx
, struct uci_package
*p
, char *filename
, FILE **f
, bool flush
)
215 UCI_TRAP_SAVE(ctx
, done
);
216 stream
= uci_open_stream(ctx
, filename
, SEEK_SET
, flush
, false);
218 changes
= uci_parse_history(ctx
, stream
, p
);
219 UCI_TRAP_RESTORE(ctx
);
224 uci_close_stream(stream
);
228 /* returns the number of changes that were successfully parsed */
229 static int uci_load_history(struct uci_context
*ctx
, struct uci_package
*p
, bool flush
)
231 struct uci_element
*e
;
232 char *filename
= NULL
;
239 uci_foreach_element(&ctx
->history_path
, e
) {
240 if ((asprintf(&filename
, "%s/%s", e
->name
, p
->e
.name
) < 0) || !filename
)
241 UCI_THROW(ctx
, UCI_ERR_MEM
);
243 uci_load_history_file(ctx
, p
, filename
, NULL
, false);
247 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, p
->e
.name
) < 0) || !filename
)
248 UCI_THROW(ctx
, UCI_ERR_MEM
);
250 changes
= uci_load_history_file(ctx
, p
, filename
, &f
, flush
);
251 if (flush
&& f
&& (changes
> 0)) {
253 if (ftruncate(fileno(f
), 0) < 0) {
255 UCI_THROW(ctx
, UCI_ERR_IO
);
265 static void uci_filter_history(struct uci_context
*ctx
, const char *name
, const char *section
, const char *option
)
267 struct uci_parse_context
*pctx
;
268 struct uci_element
*e
, *tmp
;
269 struct uci_list list
;
270 char *filename
= NULL
;
274 uci_list_init(&list
);
275 uci_alloc_parse_context(ctx
);
278 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, name
) < 0) || !filename
)
279 UCI_THROW(ctx
, UCI_ERR_MEM
);
281 UCI_TRAP_SAVE(ctx
, done
);
282 f
= uci_open_stream(ctx
, filename
, SEEK_SET
, true, false);
285 struct uci_element
*e
;
293 /* NB: need to allocate the element before the call to
294 * uci_parse_history_tuple, otherwise the original string
295 * gets modified before it is saved */
296 e
= uci_alloc_generic(ctx
, UCI_TYPE_HISTORY
, pctx
->buf
, sizeof(struct uci_element
));
297 uci_list_add(&list
, &e
->list
);
299 uci_parse_history_tuple(ctx
, &buf
, &ptr
);
301 if (!ptr
.section
|| (strcmp(section
, ptr
.section
) != 0))
305 if (!ptr
.option
|| (strcmp(option
, ptr
.option
) != 0))
308 /* match, drop this element again */
312 /* rebuild the history file */
314 if (ftruncate(fileno(f
), 0) < 0)
315 UCI_THROW(ctx
, UCI_ERR_IO
);
316 uci_foreach_element_safe(&list
, tmp
, e
) {
317 fprintf(f
, "%s\n", e
->name
);
320 UCI_TRAP_RESTORE(ctx
);
325 uci_close_stream(pctx
->file
);
326 uci_foreach_element_safe(&list
, tmp
, e
) {
332 int uci_revert(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
334 char *package
= NULL
;
335 char *section
= NULL
;
339 expand_ptr(ctx
, ptr
, false);
340 UCI_ASSERT(ctx
, ptr
->p
->has_history
);
343 * - flush unwritten changes
344 * - save the package name
345 * - unload the package
346 * - filter the history
347 * - reload the package
349 UCI_TRAP_SAVE(ctx
, error
);
350 UCI_INTERNAL(uci_save
, ctx
, ptr
->p
);
352 /* NB: need to clone package, section and option names,
353 * as they may get freed on uci_free_package() */
354 package
= uci_strdup(ctx
, ptr
->p
->e
.name
);
356 section
= uci_strdup(ctx
, ptr
->section
);
358 option
= uci_strdup(ctx
, ptr
->option
);
360 uci_free_package(&ptr
->p
);
361 uci_filter_history(ctx
, package
, section
, option
);
363 UCI_INTERNAL(uci_load
, ctx
, package
, &ptr
->p
);
364 UCI_TRAP_RESTORE(ctx
);
375 UCI_THROW(ctx
, ctx
->err
);
379 int uci_save(struct uci_context
*ctx
, struct uci_package
*p
)
382 char *filename
= NULL
;
383 struct uci_element
*e
, *tmp
;
387 UCI_ASSERT(ctx
, p
!= NULL
);
390 * if the config file was outside of the /etc/config path,
391 * don't save the history to a file, update the real file
393 * does not modify the uci_package pointer
396 return uci_commit(ctx
, &p
, false);
398 if (uci_list_empty(&p
->history
))
401 if (stat(ctx
->savedir
, &statbuf
) < 0)
402 mkdir(ctx
->savedir
, UCI_DIRMODE
);
403 else if ((statbuf
.st_mode
& S_IFMT
) != S_IFDIR
)
404 UCI_THROW(ctx
, UCI_ERR_IO
);
406 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, p
->e
.name
) < 0) || !filename
)
407 UCI_THROW(ctx
, UCI_ERR_MEM
);
410 UCI_TRAP_SAVE(ctx
, done
);
411 f
= uci_open_stream(ctx
, filename
, SEEK_END
, true, true);
412 UCI_TRAP_RESTORE(ctx
);
414 uci_foreach_element_safe(&p
->history
, tmp
, e
) {
415 struct uci_history
*h
= uci_to_history(e
);
428 case UCI_CMD_LIST_ADD
:
435 fprintf(f
, "%s%s.%s", prefix
, p
->e
.name
, h
->section
);
437 fprintf(f
, ".%s", e
->name
);
439 if (h
->cmd
== UCI_CMD_REMOVE
)
442 fprintf(f
, "=%s\n", h
->value
);
451 UCI_THROW(ctx
, ctx
->err
);