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.
17 /* initialize a list head/item */
18 static inline void uci_list_init(struct uci_list *ptr)
24 /* inserts a new list entry after a given entry */
25 static inline void uci_list_insert(struct uci_list *list, struct uci_list *ptr)
27 list->next->prev = ptr;
29 ptr->next = list->next;
33 /* inserts a new list entry at the tail of the list */
34 static inline void uci_list_add(struct uci_list *head, struct uci_list *ptr)
36 /* NB: head->prev points at the tail */
37 uci_list_insert(head->prev, ptr);
40 static inline void uci_list_del(struct uci_list *ptr)
42 struct uci_list *next, *prev;
54 * uci_alloc_generic allocates a new uci_element with payload
55 * payload is appended to the struct to save memory and reduce fragmentation
57 static struct uci_element *
58 uci_alloc_generic(struct uci_context *ctx, int type, const char *name, int size)
60 struct uci_element *e;
64 ptr = uci_malloc(ctx, datalen);
65 e = (struct uci_element *) ptr;
68 UCI_TRAP_SAVE(ctx, error);
69 e->name = uci_strdup(ctx, name);
70 UCI_TRAP_RESTORE(ctx);
72 uci_list_init(&e->list);
77 UCI_THROW(ctx, ctx->errno);
84 uci_free_element(struct uci_element *e)
88 if (!uci_list_empty(&e->list))
89 uci_list_del(&e->list);
93 static struct uci_option *
94 uci_alloc_option(struct uci_section *s, const char *name, const char *value)
96 struct uci_package *p = s->package;
97 struct uci_context *ctx = p->ctx;
100 o = uci_alloc_element(ctx, option, name, strlen(value) + 1);
101 o->value = uci_dataptr(o);
103 strcpy(o->value, value);
104 uci_list_add(&s->options, &o->e.list);
110 uci_free_option(struct uci_option *o)
112 if ((o->value != uci_dataptr(o)) &&
115 uci_free_element(&o->e);
118 static struct uci_section *
119 uci_alloc_section(struct uci_package *p, const char *type, const char *name)
121 struct uci_context *ctx = p->ctx;
122 struct uci_section *s;
124 if (name && !name[0])
127 s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
128 uci_list_init(&s->options);
129 s->type = uci_dataptr(s);
131 strcpy(s->type, type);
135 uci_list_add(&p->sections, &s->e.list);
141 uci_free_section(struct uci_section *s)
143 struct uci_element *o, *tmp;
145 uci_foreach_element_safe(&s->options, tmp, o) {
146 uci_free_option(uci_to_option(o));
148 if ((s->type != uci_dataptr(s)) &&
151 uci_free_element(&s->e);
154 static struct uci_package *
155 uci_alloc_package(struct uci_context *ctx, const char *name)
157 struct uci_package *p;
159 p = uci_alloc_element(ctx, package, name, 0);
161 uci_list_init(&p->sections);
162 uci_list_init(&p->history);
163 uci_list_init(&p->saved_history);
168 uci_free_package(struct uci_package **package)
170 struct uci_element *e, *tmp;
171 struct uci_package *p = *package;
178 uci_foreach_element_safe(&p->sections, tmp, e) {
179 uci_free_section(uci_to_section(e));
181 uci_foreach_element_safe(&p->history, tmp, e) {
182 uci_free_history(uci_to_history(e));
184 uci_foreach_element_safe(&p->saved_history, tmp, e) {
185 uci_free_history(uci_to_history(e));
187 uci_free_element(&p->e);
191 static struct uci_element *uci_lookup_list(struct uci_context *ctx, struct uci_list *list, const char *name)
193 struct uci_element *e;
195 uci_foreach_element(list, e) {
196 if (!strcmp(e->name, name))
202 int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *p, char *section, char *option)
204 struct uci_element *e;
205 struct uci_section *s;
208 UCI_ASSERT(ctx, res != NULL);
209 UCI_ASSERT(ctx, p != NULL);
210 UCI_ASSERT(ctx, uci_validate_name(section));
212 UCI_ASSERT(ctx, uci_validate_name(option));
214 e = uci_lookup_list(ctx, &p->sections, section);
219 s = uci_to_section(e);
220 e = uci_lookup_list(ctx, &s->options, option);
227 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
231 int uci_del_element(struct uci_context *ctx, struct uci_element *e)
233 /* NB: UCI_INTERNAL use means without history tracking */
234 bool internal = ctx->internal;
235 struct uci_package *p = NULL;
236 struct uci_section *s = NULL;
237 struct uci_option *o = NULL;
238 struct uci_element *i, *tmp;
242 UCI_ASSERT(ctx, e != NULL);
245 case UCI_TYPE_SECTION:
246 s = uci_to_section(e);
247 uci_foreach_element_safe(&s->options, tmp, i) {
248 uci_del_element(ctx, i);
251 case UCI_TYPE_OPTION:
252 o = uci_to_option(e);
258 UCI_THROW(ctx, UCI_ERR_INVAL);
263 if (!internal && p->confdir)
264 uci_add_history(ctx, &p->history, UCI_CMD_REMOVE, s->e.name, option, NULL);
267 case UCI_TYPE_SECTION:
270 case UCI_TYPE_OPTION:
279 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value)
281 /* NB: UCI_INTERNAL use means without history tracking */
282 bool internal = ctx->internal;
283 struct uci_list *list;
284 struct uci_element *e;
285 struct uci_package *p;
286 struct uci_section *s;
293 UCI_ASSERT(ctx, (element != NULL) && (*element != NULL));
295 /* what the 'value' of an element means depends on the type
296 * for a section, the 'value' means its type
297 * for an option, the 'value' means its value string
298 * when changing the value, shrink the element to its actual size
299 * (it may have been allocated with a bigger size, to include
301 * then duplicate the string passed on the command line and
302 * insert it into the structure.
307 case UCI_TYPE_SECTION:
308 UCI_ASSERT(ctx, uci_validate_str(value, false));
309 size = sizeof(struct uci_section);
310 s = uci_to_section(e);
314 case UCI_TYPE_OPTION:
315 UCI_ASSERT(ctx, value != NULL);
316 size = sizeof(struct uci_option);
317 s = uci_to_option(e)->section;
322 UCI_THROW(ctx, UCI_ERR_INVAL);
326 if (!internal && p->confdir)
327 uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
329 uci_list_del(&e->list);
330 e = uci_realloc(ctx, e, size);
331 str = uci_strdup(ctx, value);
332 uci_list_insert(list, &e->list);
336 case UCI_TYPE_SECTION:
337 uci_to_section(e)->type = str;
339 case UCI_TYPE_OPTION:
340 uci_to_option(e)->value = str;
349 int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name)
351 /* NB: UCI_INTERNAL use means without history tracking */
352 bool internal = ctx->internal;
353 struct uci_element *e;
357 /* NB: p, section, option validated by uci_lookup */
358 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
360 if (!internal && p->confdir)
361 uci_add_history(ctx, &p->history, UCI_CMD_RENAME, section, option, name);
363 name = uci_strdup(ctx, name);
372 int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option)
374 /* NB: pass on internal flag to uci_del_element */
375 bool internal = ctx->internal;
376 struct uci_element *e;
380 /* NB: p, section, option validated by uci_lookup */
381 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
383 ctx->internal = internal;
384 return uci_del_element(ctx, e);
387 int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value)
389 /* NB: UCI_INTERNAL use means without history tracking */
390 bool internal = ctx->internal;
391 struct uci_element *e = NULL;
392 struct uci_section *s = NULL;
393 struct uci_option *o = NULL;
396 UCI_ASSERT(ctx, p != NULL);
397 UCI_ASSERT(ctx, uci_validate_name(section));
399 UCI_ASSERT(ctx, uci_validate_name(option));
400 UCI_ASSERT(ctx, value != NULL);
402 UCI_ASSERT(ctx, uci_validate_str(value, false));
406 * look up the package, section and option (if set)
407 * if the section/option is to be modified and it is not found
408 * create a new element in the appropriate list
410 e = uci_lookup_list(ctx, &p->sections, section);
414 s = uci_to_section(e);
415 if (ctx->pctx && ctx->pctx->merge)
416 ctx->pctx->section = s;
419 e = uci_lookup_list(ctx, &s->options, option);
422 o = uci_to_option(e);
426 * no unknown element was supplied, assume that we can just update
434 ctx->internal = internal;
435 return uci_set_element_value(ctx, &e, value);
439 * the entry that we need to update was not found,
440 * check if the search failed prematurely.
441 * this can happen if the package was not found, or if
442 * an option was supplied, but the section wasn't found
444 if (!p || (!s && option))
445 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
447 /* now add the missing entry */
448 if (!internal && p->confdir)
449 uci_add_history(ctx, &p->history, UCI_CMD_ADD, section, option, value);
451 uci_alloc_option(s, option, value);
453 s = uci_alloc_section(p, value, section);
454 if (ctx->pctx && ctx->pctx->merge)
455 ctx->pctx->section = s;
461 int uci_unload(struct uci_context *ctx, struct uci_package *p)
464 UCI_ASSERT(ctx, p != NULL);
466 uci_free_package(&p);