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 uci_free_element(&o->e);
108 static struct uci_section *
109 uci_alloc_section(struct uci_package *p, const char *type, const char *name)
111 struct uci_context *ctx = p->ctx;
112 struct uci_section *s;
115 if (!name || !name[0]) {
116 snprintf(buf, 16, "cfg%d", p->n_section);
120 s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
121 s->type = uci_dataptr(s);
123 strcpy(s->type, type);
124 uci_list_init(&s->options);
125 uci_list_add(&p->sections, &s->e.list);
131 uci_free_section(struct uci_section *s)
133 struct uci_element *o, *tmp;
135 uci_foreach_element_safe(&s->options, tmp, o) {
136 uci_free_option(uci_to_option(o));
138 uci_free_element(&s->e);
141 static struct uci_package *
142 uci_alloc_package(struct uci_context *ctx, const char *name)
144 struct uci_package *p;
146 p = uci_alloc_element(ctx, package, name, 0);
148 uci_list_init(&p->sections);
149 uci_list_init(&p->history);
154 uci_free_package(struct uci_package *p)
156 struct uci_element *e, *tmp;
163 uci_foreach_element_safe(&p->sections, tmp, e) {
164 uci_free_section(uci_to_section(e));
166 uci_free_element(&p->e);
169 /* record a change that was done to a package */
171 uci_add_history(struct uci_context *ctx, struct uci_package *p, int cmd, char *section, char *option, char *value)
173 struct uci_history *h;
174 int size = strlen(section) + 1;
178 size += strlen(section) + 1;
180 h = uci_alloc_element(ctx, history, option, size);
181 ptr = uci_dataptr(h);
183 h->section = strcpy(ptr, section);
185 ptr += strlen(ptr) + 1;
186 h->value = strcpy(ptr, value);
188 uci_list_add(&p->history, &h->e.list);
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;
206 struct uci_option *o;
209 UCI_ASSERT(ctx, res != NULL);
210 UCI_ASSERT(ctx, p != NULL);
211 UCI_ASSERT(ctx, section != NULL);
213 e = uci_lookup_list(ctx, &p->sections, section);
218 s = uci_to_section(e);
219 e = uci_lookup_list(ctx, &s->options, option);
226 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
230 int uci_del_element(struct uci_context *ctx, struct uci_element *e)
232 bool internal = ctx->internal;
233 struct uci_package *p = NULL;
234 struct uci_section *s = NULL;
235 struct uci_option *o = NULL;
236 struct uci_element *i, *tmp;
240 UCI_ASSERT(ctx, e != NULL);
243 case UCI_TYPE_SECTION:
244 s = uci_to_section(e);
245 uci_foreach_element_safe(&s->options, tmp, i) {
246 uci_del_element(ctx, i);
249 case UCI_TYPE_OPTION:
250 o = uci_to_option(e);
256 UCI_THROW(ctx, UCI_ERR_INVAL);
262 uci_add_history(ctx, p, UCI_CMD_REMOVE, s->e.name, option, NULL);
265 case UCI_TYPE_SECTION:
268 case UCI_TYPE_OPTION:
277 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value)
279 bool internal = ctx->internal;
280 struct uci_list *list;
281 struct uci_element *e;
282 struct uci_package *p;
283 struct uci_section *s;
290 UCI_ASSERT(ctx, value != NULL);
291 UCI_ASSERT(ctx, element != NULL);
292 UCI_ASSERT(ctx, *element != NULL);
294 /* what the 'value' of an element means depends on the type
295 * for a section, the 'value' means its type
296 * for an option, the 'value' means its value string
297 * when changing the value, shrink the element to its actual size
298 * (it may have been allocated with a bigger size, to include
300 * then duplicate the string passed on the command line and
301 * insert it into the structure.
306 case UCI_TYPE_SECTION:
307 size = sizeof(struct uci_section);
308 s = uci_to_section(e);
312 case UCI_TYPE_OPTION:
313 size = sizeof(struct uci_option);
314 s = uci_to_option(e)->section;
319 UCI_THROW(ctx, UCI_ERR_INVAL);
324 uci_add_history(ctx, p, UCI_CMD_CHANGE, section, option, value);
326 uci_list_del(&e->list);
327 e = uci_realloc(ctx, e, size);
328 str = uci_strdup(ctx, value);
329 uci_list_insert(list, &e->list);
333 case UCI_TYPE_SECTION:
334 uci_to_section(e)->type = str;
336 case UCI_TYPE_OPTION:
337 uci_to_option(e)->value = str;
346 int uci_del(struct uci_context *ctx, struct uci_package *p, char *section, char *option)
348 bool internal = ctx->internal;
349 struct uci_element *e;
350 struct uci_section *s = NULL;
351 struct uci_option *o = NULL;
354 UCI_ASSERT(ctx, p != NULL);
355 UCI_ASSERT(ctx, section != NULL);
357 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
360 return uci_del_element(ctx, e);
361 UCI_INTERNAL(uci_del_element, ctx, e);
366 int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value)
368 bool internal = ctx->internal;
369 struct uci_element *e = NULL;
370 struct uci_section *s = NULL;
371 struct uci_option *o = NULL;
372 struct uci_history *h;
375 UCI_ASSERT(ctx, p != NULL);
376 UCI_ASSERT(ctx, section != NULL);
377 UCI_ASSERT(ctx, value != NULL);
380 * look up the package, section and option (if set)
381 * if the section/option is to be modified and it is not found
382 * create a new element in the appropriate list
384 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, NULL);
385 s = uci_to_section(e);
387 e = uci_lookup_list(ctx, &s->options, option);
390 o = uci_to_option(e);
394 * no unknown element was supplied, assume that we can just update
403 return uci_set_element_value(ctx, &e, value);
405 UCI_INTERNAL(uci_set_element_value, ctx, &e, value);
410 * the entry that we need to update was not found,
411 * check if the search failed prematurely.
412 * this can happen if the package was not found, or if
413 * an option was supplied, but the section wasn't found
415 if (!p || (!s && option))
416 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
418 /* now add the missing entry */
420 uci_add_history(ctx, p, UCI_CMD_ADD, section, option, value);
422 uci_alloc_option(s, option, value);
424 uci_alloc_section(p, value, section);
429 int uci_unload(struct uci_context *ctx, struct uci_package *p)
431 struct uci_element *e;
434 UCI_ASSERT(ctx, p != NULL);