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;
65 datalen += strlen(name) + 1;
66 ptr = uci_malloc(ctx, datalen);
67 e = (struct uci_element *) ptr;
70 e->name = (char *) ptr + size;
71 strcpy(e->name, name);
73 uci_list_init(&e->list);
79 uci_free_element(struct uci_element *e)
81 if (!uci_list_empty(&e->list))
82 uci_list_del(&e->list);
86 static struct uci_option *
87 uci_alloc_option(struct uci_section *s, const char *name, const char *value)
89 struct uci_package *p = s->package;
90 struct uci_context *ctx = p->ctx;
93 o = uci_alloc_element(ctx, option, name, strlen(value) + 1);
94 o->value = uci_dataptr(o);
96 strcpy(o->value, value);
97 uci_list_add(&s->options, &o->e.list);
103 uci_free_option(struct uci_option *o)
105 if ((o->value != uci_dataptr(o)) &&
108 uci_free_element(&o->e);
111 static struct uci_section *
112 uci_alloc_section(struct uci_package *p, const char *type, const char *name)
114 struct uci_context *ctx = p->ctx;
115 struct uci_section *s;
118 if (!name || !name[0]) {
119 snprintf(buf, 16, "cfg%d", p->n_section);
123 s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
124 s->type = uci_dataptr(s);
126 strcpy(s->type, type);
127 uci_list_init(&s->options);
128 uci_list_add(&p->sections, &s->e.list);
134 uci_free_section(struct uci_section *s)
136 struct uci_element *o, *tmp;
138 uci_foreach_element_safe(&s->options, tmp, o) {
139 uci_free_option(uci_to_option(o));
141 if ((s->type != uci_dataptr(s)) &&
144 uci_free_element(&s->e);
147 static struct uci_package *
148 uci_alloc_package(struct uci_context *ctx, const char *name)
150 struct uci_package *p;
152 p = uci_alloc_element(ctx, package, name, 0);
154 uci_list_init(&p->sections);
155 uci_list_init(&p->history);
160 uci_free_package(struct uci_package *p)
162 struct uci_element *e, *tmp;
169 uci_foreach_element_safe(&p->sections, tmp, e) {
170 uci_free_section(uci_to_section(e));
172 uci_free_element(&p->e);
175 /* record a change that was done to a package */
177 uci_add_history(struct uci_context *ctx, struct uci_package *p, int cmd, char *section, char *option, char *value)
179 struct uci_history *h;
180 int size = strlen(section) + 1;
187 size += strlen(section) + 1;
189 h = uci_alloc_element(ctx, history, option, size);
190 ptr = uci_dataptr(h);
192 h->section = strcpy(ptr, section);
194 ptr += strlen(ptr) + 1;
195 h->value = strcpy(ptr, value);
197 uci_list_add(&p->history, &h->e.list);
201 uci_free_history(struct uci_history *h)
205 if ((h->section != NULL) &&
206 (h->section != uci_dataptr(h))) {
210 uci_free_element(&h->e);
213 static struct uci_element *uci_lookup_list(struct uci_context *ctx, struct uci_list *list, const char *name)
215 struct uci_element *e;
217 uci_foreach_element(list, e) {
218 if (!strcmp(e->name, name))
224 int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *p, char *section, char *option)
226 struct uci_element *e;
227 struct uci_section *s;
228 struct uci_option *o;
231 UCI_ASSERT(ctx, res != NULL);
232 UCI_ASSERT(ctx, p != NULL);
233 UCI_ASSERT(ctx, section != NULL);
235 e = uci_lookup_list(ctx, &p->sections, section);
240 s = uci_to_section(e);
241 e = uci_lookup_list(ctx, &s->options, option);
248 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
252 int uci_del_element(struct uci_context *ctx, struct uci_element *e)
254 /* NB: UCI_INTERNAL use means without history tracking */
255 bool internal = ctx->internal;
256 struct uci_package *p = NULL;
257 struct uci_section *s = NULL;
258 struct uci_option *o = NULL;
259 struct uci_element *i, *tmp;
263 UCI_ASSERT(ctx, e != NULL);
266 case UCI_TYPE_SECTION:
267 s = uci_to_section(e);
268 uci_foreach_element_safe(&s->options, tmp, i) {
269 uci_del_element(ctx, i);
272 case UCI_TYPE_OPTION:
273 o = uci_to_option(e);
279 UCI_THROW(ctx, UCI_ERR_INVAL);
285 uci_add_history(ctx, p, UCI_CMD_REMOVE, s->e.name, option, NULL);
288 case UCI_TYPE_SECTION:
291 case UCI_TYPE_OPTION:
300 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value)
302 /* NB: UCI_INTERNAL use means without history tracking */
303 bool internal = ctx->internal;
304 struct uci_list *list;
305 struct uci_element *e;
306 struct uci_package *p;
307 struct uci_section *s;
314 UCI_ASSERT(ctx, value != NULL);
315 UCI_ASSERT(ctx, element != NULL);
316 UCI_ASSERT(ctx, *element != NULL);
318 /* what the 'value' of an element means depends on the type
319 * for a section, the 'value' means its type
320 * for an option, the 'value' means its value string
321 * when changing the value, shrink the element to its actual size
322 * (it may have been allocated with a bigger size, to include
324 * then duplicate the string passed on the command line and
325 * insert it into the structure.
330 case UCI_TYPE_SECTION:
331 size = sizeof(struct uci_section);
332 s = uci_to_section(e);
336 case UCI_TYPE_OPTION:
337 size = sizeof(struct uci_option);
338 s = uci_to_option(e)->section;
343 UCI_THROW(ctx, UCI_ERR_INVAL);
348 uci_add_history(ctx, p, UCI_CMD_CHANGE, section, option, value);
350 uci_list_del(&e->list);
351 e = uci_realloc(ctx, e, size);
352 str = uci_strdup(ctx, value);
353 uci_list_insert(list, &e->list);
357 case UCI_TYPE_SECTION:
358 uci_to_section(e)->type = str;
360 case UCI_TYPE_OPTION:
361 uci_to_option(e)->value = str;
370 int uci_del(struct uci_context *ctx, struct uci_package *p, char *section, char *option)
372 /* NB: pass on internal flag to uci_del_element */
373 bool internal = ctx->internal;
374 struct uci_element *e;
375 struct uci_section *s = NULL;
376 struct uci_option *o = NULL;
379 UCI_ASSERT(ctx, p != NULL);
380 UCI_ASSERT(ctx, section != NULL);
382 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
385 return uci_del_element(ctx, e);
386 UCI_INTERNAL(uci_del_element, ctx, e);
391 int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value)
393 /* NB: UCI_INTERNAL use means without history tracking */
394 bool internal = ctx->internal;
395 struct uci_element *e = NULL;
396 struct uci_section *s = NULL;
397 struct uci_option *o = NULL;
398 struct uci_history *h;
401 UCI_ASSERT(ctx, p != NULL);
402 UCI_ASSERT(ctx, section != NULL);
403 UCI_ASSERT(ctx, value != NULL);
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 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, NULL);
411 s = uci_to_section(e);
413 e = uci_lookup_list(ctx, &s->options, option);
416 o = uci_to_option(e);
420 * no unknown element was supplied, assume that we can just update
429 return uci_set_element_value(ctx, &e, value);
431 UCI_INTERNAL(uci_set_element_value, ctx, &e, value);
436 * the entry that we need to update was not found,
437 * check if the search failed prematurely.
438 * this can happen if the package was not found, or if
439 * an option was supplied, but the section wasn't found
441 if (!p || (!s && option))
442 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
444 /* now add the missing entry */
446 uci_add_history(ctx, p, UCI_CMD_ADD, section, option, value);
448 uci_alloc_option(s, option, value);
450 uci_alloc_section(p, value, section);
455 int uci_unload(struct uci_context *ctx, struct uci_package *p)
457 struct uci_element *e;
460 UCI_ASSERT(ctx, p != NULL);