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
, char *section
, char *option
, 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 void uci_parse_history_tuple(struct uci_context
*ctx
, char **buf
, char **package
, char **section
, char **option
, char **value
, int *cmd
)
93 int c
= UCI_CMD_CHANGE
;
98 } else if (**buf
== '@') {
101 } else if (**buf
== '+') {
102 /* UCI_CMD_ADD is used for anonymous sections */
109 UCI_INTERNAL(uci_parse_tuple
, ctx
, *buf
, package
, section
, option
, value
);
111 UCI_THROW(ctx
, UCI_ERR_PARSE
);
115 static void uci_parse_history_line(struct uci_context
*ctx
, struct uci_package
*p
, char *buf
)
117 struct uci_element
*e
= NULL
;
120 char *package
= NULL
;
121 char *section
= NULL
;
126 uci_parse_history_tuple(ctx
, &buf
, &package
, §ion
, &option
, &value
, &cmd
);
127 if (!package
|| (strcmp(package
, p
->e
.name
) != 0))
129 if (!uci_validate_name(section
))
131 if (option
&& !uci_validate_name(option
))
133 if (rename
&& !uci_validate_str(value
, (option
|| delete)))
136 if (ctx
->flags
& UCI_FLAG_SAVED_HISTORY
)
137 uci_add_history(ctx
, &p
->saved_history
, cmd
, section
, option
, value
);
141 UCI_INTERNAL(uci_rename
, ctx
, p
, section
, option
, value
);
144 UCI_INTERNAL(uci_delete
, ctx
, p
, section
, option
);
148 UCI_INTERNAL(uci_set
, ctx
, p
, section
, option
, value
, &e
);
149 if (!option
&& e
&& (cmd
== UCI_CMD_ADD
))
150 uci_to_section(e
)->anonymous
= true;
155 UCI_THROW(ctx
, UCI_ERR_PARSE
);
158 /* returns the number of changes that were successfully parsed */
159 static int uci_parse_history(struct uci_context
*ctx
, FILE *stream
, struct uci_package
*p
)
161 struct uci_parse_context
*pctx
;
164 /* make sure no memory from previous parse attempts is leaked */
165 ctx
->internal
= true;
168 pctx
= (struct uci_parse_context
*) uci_malloc(ctx
, sizeof(struct uci_parse_context
));
172 while (!feof(pctx
->file
)) {
178 * ignore parse errors in single lines, we want to preserve as much
179 * history as possible
181 UCI_TRAP_SAVE(ctx
, error
);
182 uci_parse_history_line(ctx
, p
, pctx
->buf
);
183 UCI_TRAP_RESTORE(ctx
);
189 /* no error happened, we can get rid of the parser context now */
190 ctx
->internal
= true;
195 /* returns the number of changes that were successfully parsed */
196 static int uci_load_history_file(struct uci_context
*ctx
, struct uci_package
*p
, char *filename
, FILE **f
, bool flush
)
201 UCI_TRAP_SAVE(ctx
, done
);
202 stream
= uci_open_stream(ctx
, filename
, SEEK_SET
, flush
, false);
204 changes
= uci_parse_history(ctx
, stream
, p
);
205 UCI_TRAP_RESTORE(ctx
);
210 uci_close_stream(stream
);
214 /* returns the number of changes that were successfully parsed */
215 static int uci_load_history(struct uci_context
*ctx
, struct uci_package
*p
, bool flush
)
217 struct uci_element
*e
;
218 char *filename
= NULL
;
225 uci_foreach_element(&ctx
->history_path
, e
) {
226 if ((asprintf(&filename
, "%s/%s", e
->name
, p
->e
.name
) < 0) || !filename
)
227 UCI_THROW(ctx
, UCI_ERR_MEM
);
229 uci_load_history_file(ctx
, p
, filename
, NULL
, false);
233 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, p
->e
.name
) < 0) || !filename
)
234 UCI_THROW(ctx
, UCI_ERR_MEM
);
236 changes
= uci_load_history_file(ctx
, p
, filename
, &f
, flush
);
237 if (flush
&& f
&& (changes
> 0)) {
239 ftruncate(fileno(f
), 0);
248 static void uci_filter_history(struct uci_context
*ctx
, const char *name
, char *section
, char *option
)
250 struct uci_parse_context
*pctx
;
251 struct uci_element
*e
, *tmp
;
252 struct uci_list list
;
253 char *filename
= NULL
;
260 uci_list_init(&list
);
261 uci_alloc_parse_context(ctx
);
264 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, name
) < 0) || !filename
)
265 UCI_THROW(ctx
, UCI_ERR_MEM
);
267 UCI_TRAP_SAVE(ctx
, done
);
268 f
= uci_open_stream(ctx
, filename
, SEEK_SET
, true, false);
271 struct uci_element
*e
;
279 /* NB: need to allocate the element before the call to
280 * uci_parse_history_tuple, otherwise the original string
281 * gets modified before it is saved */
282 e
= uci_alloc_generic(ctx
, UCI_TYPE_HISTORY
, pctx
->buf
, sizeof(struct uci_element
));
283 uci_list_add(&list
, &e
->list
);
285 uci_parse_history_tuple(ctx
, &buf
, &p
, &s
, &o
, &v
, NULL
);
287 if (!s
|| (strcmp(section
, s
) != 0))
291 if (!o
|| (strcmp(option
, o
) != 0))
294 /* match, drop this element again */
298 /* rebuild the history file */
300 ftruncate(fileno(f
), 0);
301 uci_foreach_element_safe(&list
, tmp
, e
) {
302 fprintf(f
, "%s\n", e
->name
);
305 UCI_TRAP_RESTORE(ctx
);
311 uci_foreach_element_safe(&list
, tmp
, e
) {
314 ctx
->internal
= true;
318 int uci_revert(struct uci_context
*ctx
, struct uci_package
**pkg
, char *section
, char *option
)
320 struct uci_package
*p
;
324 UCI_ASSERT(ctx
, pkg
!= NULL
);
326 UCI_ASSERT(ctx
, p
!= NULL
);
327 UCI_ASSERT(ctx
, p
->confdir
);
330 * - flush unwritten changes
331 * - save the package name
332 * - unload the package
333 * - filter the history
334 * - reload the package
336 UCI_TRAP_SAVE(ctx
, error
);
337 UCI_INTERNAL(uci_save
, ctx
, p
);
338 name
= uci_strdup(ctx
, p
->e
.name
);
341 uci_free_package(&p
);
342 uci_filter_history(ctx
, name
, section
, option
);
344 UCI_INTERNAL(uci_load
, ctx
, name
, &p
);
345 UCI_TRAP_RESTORE(ctx
);
352 UCI_THROW(ctx
, ctx
->errno
);
356 int uci_save(struct uci_context
*ctx
, struct uci_package
*p
)
359 char *filename
= NULL
;
360 struct uci_element
*e
, *tmp
;
363 UCI_ASSERT(ctx
, p
!= NULL
);
366 * if the config file was outside of the /etc/config path,
367 * don't save the history to a file, update the real file
369 * does not modify the uci_package pointer
372 return uci_commit(ctx
, &p
, false);
374 if (uci_list_empty(&p
->history
))
377 if ((asprintf(&filename
, "%s/%s", ctx
->savedir
, p
->e
.name
) < 0) || !filename
)
378 UCI_THROW(ctx
, UCI_ERR_MEM
);
381 UCI_TRAP_SAVE(ctx
, done
);
382 f
= uci_open_stream(ctx
, filename
, SEEK_END
, true, true);
383 UCI_TRAP_RESTORE(ctx
);
385 uci_foreach_element_safe(&p
->history
, tmp
, e
) {
386 struct uci_history
*h
= uci_to_history(e
);
402 fprintf(f
, "%s.%s", p
->e
.name
, h
->section
);
404 fprintf(f
, ".%s", e
->name
);
406 if (h
->cmd
== UCI_CMD_REMOVE
)
409 fprintf(f
, "=%s\n", h
->value
);
418 UCI_THROW(ctx
, ctx
->errno
);