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 /* record a change that was done to a package */
149 uci_add_history(struct uci_context
*ctx
, struct uci_package
*p
, int cmd
, char *section
, char *option
, char *value
)
151 struct uci_history
*h
;
152 int size
= strlen(section
) + 1;
159 size
+= strlen(section
) + 1;
161 h
= uci_alloc_element(ctx
, history
, option
, size
);
162 ptr
= uci_dataptr(h
);
164 h
->section
= strcpy(ptr
, section
);
166 ptr
+= strlen(ptr
) + 1;
167 h
->value
= strcpy(ptr
, value
);
169 uci_list_add(&p
->history
, &h
->e
.list
);
173 uci_free_history(struct uci_history
*h
)
177 if ((h
->section
!= NULL
) &&
178 (h
->section
!= uci_dataptr(h
))) {
182 uci_free_element(&h
->e
);
185 static struct uci_package
*
186 uci_alloc_package(struct uci_context
*ctx
, const char *name
)
188 struct uci_package
*p
;
190 p
= uci_alloc_element(ctx
, package
, name
, 0);
192 uci_list_init(&p
->sections
);
193 uci_list_init(&p
->history
);
198 uci_free_package(struct uci_package
*p
)
200 struct uci_element
*e
, *tmp
;
207 uci_foreach_element_safe(&p
->sections
, tmp
, e
) {
208 uci_free_section(uci_to_section(e
));
210 uci_foreach_element_safe(&p
->history
, tmp
, e
) {
211 uci_free_history(uci_to_history(e
));
213 uci_free_element(&p
->e
);
216 static struct uci_element
*uci_lookup_list(struct uci_context
*ctx
, struct uci_list
*list
, const char *name
)
218 struct uci_element
*e
;
220 uci_foreach_element(list
, e
) {
221 if (!strcmp(e
->name
, name
))
227 int uci_lookup(struct uci_context
*ctx
, struct uci_element
**res
, struct uci_package
*p
, char *section
, char *option
)
229 struct uci_element
*e
;
230 struct uci_section
*s
;
231 struct uci_option
*o
;
234 UCI_ASSERT(ctx
, res
!= NULL
);
235 UCI_ASSERT(ctx
, p
!= NULL
);
236 UCI_ASSERT(ctx
, section
!= NULL
);
238 e
= uci_lookup_list(ctx
, &p
->sections
, section
);
243 s
= uci_to_section(e
);
244 e
= uci_lookup_list(ctx
, &s
->options
, option
);
251 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
255 int uci_del_element(struct uci_context
*ctx
, struct uci_element
*e
)
257 /* NB: UCI_INTERNAL use means without history tracking */
258 bool internal
= ctx
->internal
;
259 struct uci_package
*p
= NULL
;
260 struct uci_section
*s
= NULL
;
261 struct uci_option
*o
= NULL
;
262 struct uci_element
*i
, *tmp
;
266 UCI_ASSERT(ctx
, e
!= NULL
);
269 case UCI_TYPE_SECTION
:
270 s
= uci_to_section(e
);
271 uci_foreach_element_safe(&s
->options
, tmp
, i
) {
272 uci_del_element(ctx
, i
);
275 case UCI_TYPE_OPTION
:
276 o
= uci_to_option(e
);
282 UCI_THROW(ctx
, UCI_ERR_INVAL
);
288 uci_add_history(ctx
, p
, UCI_CMD_REMOVE
, s
->e
.name
, option
, NULL
);
291 case UCI_TYPE_SECTION
:
294 case UCI_TYPE_OPTION
:
303 int uci_set_element_value(struct uci_context
*ctx
, struct uci_element
**element
, char *value
)
305 /* NB: UCI_INTERNAL use means without history tracking */
306 bool internal
= ctx
->internal
;
307 struct uci_list
*list
;
308 struct uci_element
*e
;
309 struct uci_package
*p
;
310 struct uci_section
*s
;
317 UCI_ASSERT(ctx
, value
!= NULL
);
318 UCI_ASSERT(ctx
, element
!= NULL
);
319 UCI_ASSERT(ctx
, *element
!= NULL
);
321 /* what the 'value' of an element means depends on the type
322 * for a section, the 'value' means its type
323 * for an option, the 'value' means its value string
324 * when changing the value, shrink the element to its actual size
325 * (it may have been allocated with a bigger size, to include
327 * then duplicate the string passed on the command line and
328 * insert it into the structure.
333 case UCI_TYPE_SECTION
:
334 size
= sizeof(struct uci_section
);
335 s
= uci_to_section(e
);
339 case UCI_TYPE_OPTION
:
340 size
= sizeof(struct uci_option
);
341 s
= uci_to_option(e
)->section
;
346 UCI_THROW(ctx
, UCI_ERR_INVAL
);
351 uci_add_history(ctx
, p
, UCI_CMD_CHANGE
, section
, option
, value
);
353 uci_list_del(&e
->list
);
354 e
= uci_realloc(ctx
, e
, size
);
355 str
= uci_strdup(ctx
, value
);
356 uci_list_insert(list
, &e
->list
);
360 case UCI_TYPE_SECTION
:
361 uci_to_section(e
)->type
= str
;
363 case UCI_TYPE_OPTION
:
364 uci_to_option(e
)->value
= str
;
373 int uci_del(struct uci_context
*ctx
, struct uci_package
*p
, char *section
, char *option
)
375 /* NB: pass on internal flag to uci_del_element */
376 bool internal
= ctx
->internal
;
377 struct uci_element
*e
;
378 struct uci_section
*s
= NULL
;
379 struct uci_option
*o
= NULL
;
382 UCI_ASSERT(ctx
, p
!= NULL
);
383 UCI_ASSERT(ctx
, section
!= NULL
);
385 UCI_INTERNAL(uci_lookup
, ctx
, &e
, p
, section
, option
);
388 return uci_del_element(ctx
, e
);
389 UCI_INTERNAL(uci_del_element
, ctx
, e
);
394 int uci_set(struct uci_context
*ctx
, struct uci_package
*p
, char *section
, char *option
, char *value
)
396 /* NB: UCI_INTERNAL use means without history tracking */
397 bool internal
= ctx
->internal
;
398 struct uci_element
*e
= NULL
;
399 struct uci_section
*s
= NULL
;
400 struct uci_option
*o
= NULL
;
401 struct uci_history
*h
;
404 UCI_ASSERT(ctx
, p
!= NULL
);
405 UCI_ASSERT(ctx
, section
!= NULL
);
406 UCI_ASSERT(ctx
, value
!= NULL
);
409 * look up the package, section and option (if set)
410 * if the section/option is to be modified and it is not found
411 * create a new element in the appropriate list
413 UCI_INTERNAL(uci_lookup
, ctx
, &e
, p
, section
, NULL
);
414 s
= uci_to_section(e
);
416 e
= uci_lookup_list(ctx
, &s
->options
, option
);
419 o
= uci_to_option(e
);
423 * no unknown element was supplied, assume that we can just update
432 return uci_set_element_value(ctx
, &e
, value
);
434 UCI_INTERNAL(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 */
449 uci_add_history(ctx
, p
, UCI_CMD_ADD
, section
, option
, value
);
451 uci_alloc_option(s
, option
, value
);
453 uci_alloc_section(p
, value
, section
);
458 int uci_unload(struct uci_context
*ctx
, struct uci_package
*p
)
460 struct uci_element
*e
;
463 UCI_ASSERT(ctx
, p
!= NULL
);