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;
181 size += strlen(section) + 1;
183 h = uci_alloc_element(ctx, history, option, size);
184 ptr = uci_dataptr(h);
186 h->section = strcpy(ptr, section);
188 ptr += strlen(ptr) + 1;
189 h->value = strcpy(ptr, value);
191 uci_list_add(&p->history, &h->e.list);
194 static struct uci_element *uci_lookup_list(struct uci_context *ctx, struct uci_list *list, const char *name)
196 struct uci_element *e;
198 uci_foreach_element(list, e) {
199 if (!strcmp(e->name, name))
205 int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *p, char *section, char *option)
207 struct uci_element *e;
208 struct uci_section *s;
209 struct uci_option *o;
212 UCI_ASSERT(ctx, res != NULL);
213 UCI_ASSERT(ctx, p != NULL);
214 UCI_ASSERT(ctx, section != NULL);
216 e = uci_lookup_list(ctx, &p->sections, section);
221 s = uci_to_section(e);
222 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 bool internal = ctx->internal;
236 struct uci_package *p = NULL;
237 struct uci_section *s = NULL;
238 struct uci_option *o = NULL;
239 struct uci_element *i, *tmp;
243 UCI_ASSERT(ctx, e != NULL);
246 case UCI_TYPE_SECTION:
247 s = uci_to_section(e);
248 uci_foreach_element_safe(&s->options, tmp, i) {
249 uci_del_element(ctx, i);
252 case UCI_TYPE_OPTION:
253 o = uci_to_option(e);
259 UCI_THROW(ctx, UCI_ERR_INVAL);
265 uci_add_history(ctx, p, UCI_CMD_REMOVE, s->e.name, option, NULL);
268 case UCI_TYPE_SECTION:
271 case UCI_TYPE_OPTION:
280 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value)
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, value != NULL);
294 UCI_ASSERT(ctx, element != NULL);
295 UCI_ASSERT(ctx, *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 size = sizeof(struct uci_section);
311 s = uci_to_section(e);
315 case UCI_TYPE_OPTION:
316 size = sizeof(struct uci_option);
317 s = uci_to_option(e)->section;
322 UCI_THROW(ctx, UCI_ERR_INVAL);
327 uci_add_history(ctx, p, 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_del(struct uci_context *ctx, struct uci_package *p, char *section, char *option)
351 bool internal = ctx->internal;
352 struct uci_element *e;
353 struct uci_section *s = NULL;
354 struct uci_option *o = NULL;
357 UCI_ASSERT(ctx, p != NULL);
358 UCI_ASSERT(ctx, section != NULL);
360 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
363 return uci_del_element(ctx, e);
364 UCI_INTERNAL(uci_del_element, ctx, e);
369 int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value)
371 bool internal = ctx->internal;
372 struct uci_element *e = NULL;
373 struct uci_section *s = NULL;
374 struct uci_option *o = NULL;
375 struct uci_history *h;
378 UCI_ASSERT(ctx, p != NULL);
379 UCI_ASSERT(ctx, section != NULL);
380 UCI_ASSERT(ctx, value != NULL);
383 * look up the package, section and option (if set)
384 * if the section/option is to be modified and it is not found
385 * create a new element in the appropriate list
387 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, NULL);
388 s = uci_to_section(e);
390 e = uci_lookup_list(ctx, &s->options, option);
393 o = uci_to_option(e);
397 * no unknown element was supplied, assume that we can just update
406 return uci_set_element_value(ctx, &e, value);
408 UCI_INTERNAL(uci_set_element_value, ctx, &e, value);
413 * the entry that we need to update was not found,
414 * check if the search failed prematurely.
415 * this can happen if the package was not found, or if
416 * an option was supplied, but the section wasn't found
418 if (!p || (!s && option))
419 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
421 /* now add the missing entry */
423 uci_add_history(ctx, p, UCI_CMD_ADD, section, option, value);
425 uci_alloc_option(s, option, value);
427 uci_alloc_section(p, value, section);
432 int uci_unload(struct uci_context *ctx, struct uci_package *p)
434 struct uci_element *e;
437 UCI_ASSERT(ctx, p != NULL);