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);
229 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
233 int uci_del_element(struct uci_context *ctx, struct uci_element *e)
235 /* NB: UCI_INTERNAL use means without history tracking */
236 bool internal = ctx->internal;
237 struct uci_package *p = NULL;
238 struct uci_section *s = NULL;
239 struct uci_option *o = NULL;
240 struct uci_element *i, *tmp;
244 UCI_ASSERT(ctx, e != NULL);
247 case UCI_TYPE_SECTION:
248 s = uci_to_section(e);
249 uci_foreach_element_safe(&s->options, tmp, i) {
250 uci_del_element(ctx, i);
253 case UCI_TYPE_OPTION:
254 o = uci_to_option(e);
260 UCI_THROW(ctx, UCI_ERR_INVAL);
265 if (!internal && p->confdir)
266 uci_add_history(ctx, &p->history, UCI_CMD_REMOVE, s->e.name, option, NULL);
269 case UCI_TYPE_SECTION:
272 case UCI_TYPE_OPTION:
281 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value)
283 /* NB: UCI_INTERNAL use means without history tracking */
284 bool internal = ctx->internal;
285 struct uci_list *list;
286 struct uci_element *e;
287 struct uci_package *p;
288 struct uci_section *s;
295 UCI_ASSERT(ctx, (element != NULL) && (*element != NULL));
297 /* what the 'value' of an element means depends on the type
298 * for a section, the 'value' means its type
299 * for an option, the 'value' means its value string
300 * when changing the value, shrink the element to its actual size
301 * (it may have been allocated with a bigger size, to include
303 * then duplicate the string passed on the command line and
304 * insert it into the structure.
309 case UCI_TYPE_SECTION:
310 UCI_ASSERT(ctx, uci_validate_str(value, false));
311 size = sizeof(struct uci_section);
312 s = uci_to_section(e);
316 case UCI_TYPE_OPTION:
317 UCI_ASSERT(ctx, value != NULL);
318 size = sizeof(struct uci_option);
319 s = uci_to_option(e)->section;
324 UCI_THROW(ctx, UCI_ERR_INVAL);
328 if (!internal && p->confdir)
329 uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
331 uci_list_del(&e->list);
332 e = uci_realloc(ctx, e, size);
333 str = uci_strdup(ctx, value);
334 uci_list_insert(list, &e->list);
338 case UCI_TYPE_SECTION:
339 uci_to_section(e)->type = str;
341 case UCI_TYPE_OPTION:
342 uci_to_option(e)->value = str;
351 int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name)
353 /* NB: UCI_INTERNAL use means without history tracking */
354 bool internal = ctx->internal;
355 struct uci_element *e;
359 /* NB: p, section, option validated by uci_lookup */
360 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
362 if (!internal && p->confdir)
363 uci_add_history(ctx, &p->history, UCI_CMD_RENAME, section, option, name);
365 name = uci_strdup(ctx, name);
374 int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option)
376 /* NB: pass on internal flag to uci_del_element */
377 bool internal = ctx->internal;
378 struct uci_element *e;
382 /* NB: p, section, option validated by uci_lookup */
383 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
385 ctx->internal = internal;
386 return uci_del_element(ctx, e);
389 int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value, struct uci_element **result)
391 /* NB: UCI_INTERNAL use means without history tracking */
392 bool internal = ctx->internal;
393 struct uci_element *e = NULL;
394 struct uci_section *s = NULL;
395 struct uci_option *o = NULL;
398 UCI_ASSERT(ctx, p != NULL);
399 UCI_ASSERT(ctx, uci_validate_name(section));
401 UCI_ASSERT(ctx, uci_validate_name(option));
402 UCI_ASSERT(ctx, value != NULL);
404 UCI_ASSERT(ctx, uci_validate_str(value, false));
408 * look up the package, section and option (if set)
409 * if the section/option is to be modified and it is not found
410 * create a new element in the appropriate list
412 e = uci_lookup_list(ctx, &p->sections, section);
416 s = uci_to_section(e);
417 if (ctx->pctx && ctx->pctx->merge)
418 ctx->pctx->section = s;
421 e = uci_lookup_list(ctx, &s->options, option);
424 o = uci_to_option(e);
428 * no unknown element was supplied, assume that we can just update
440 ctx->internal = internal;
441 return uci_set_element_value(ctx, result, value);
445 * the entry that we need to update was not found,
446 * check if the search failed prematurely.
447 * this can happen if the package was not found, or if
448 * an option was supplied, but the section wasn't found
450 if (!p || (!s && option))
451 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
453 /* now add the missing entry */
454 if (!internal && p->confdir)
455 uci_add_history(ctx, &p->history, UCI_CMD_ADD, section, option, value);
457 o = uci_alloc_option(s, option, value);
461 s = uci_alloc_section(p, value, section);
464 if (ctx->pctx && ctx->pctx->merge)
465 ctx->pctx->section = s;
471 int uci_unload(struct uci_context *ctx, struct uci_package *p)
474 UCI_ASSERT(ctx, p != NULL);
476 uci_free_package(&p);