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.
15 /* initialize a list head/item */
16 static inline void uci_list_init(struct uci_list
*ptr
)
22 /* inserts a new list entry after a given entry */
23 static inline void uci_list_insert(struct uci_list
*list
, struct uci_list
*ptr
)
25 list
->next
->prev
= ptr
;
27 ptr
->next
= list
->next
;
31 /* inserts a new list entry at the tail of the list */
32 static inline void uci_list_add(struct uci_list
*head
, struct uci_list
*ptr
)
34 /* NB: head->prev points at the tail */
35 uci_list_insert(head
->prev
, ptr
);
38 static inline void uci_list_del(struct uci_list
*ptr
)
40 struct uci_list
*next
, *prev
;
52 * uci_alloc_generic allocates a new uci_element with payload
53 * payload is appended to the struct to save memory and reduce fragmentation
55 static struct uci_element
*
56 uci_alloc_generic(struct uci_context
*ctx
, int type
, const char *name
, int size
)
58 struct uci_element
*e
;
62 ptr
= uci_malloc(ctx
, datalen
);
63 e
= (struct uci_element
*) ptr
;
66 UCI_TRAP_SAVE(ctx
, error
);
67 e
->name
= uci_strdup(ctx
, name
);
68 UCI_TRAP_RESTORE(ctx
);
70 uci_list_init(&e
->list
);
75 UCI_THROW(ctx
, ctx
->err
);
82 uci_free_element(struct uci_element
*e
)
86 if (!uci_list_empty(&e
->list
))
87 uci_list_del(&e
->list
);
91 static struct uci_option
*
92 uci_alloc_option(struct uci_section
*s
, const char *name
, const char *value
)
94 struct uci_package
*p
= s
->package
;
95 struct uci_context
*ctx
= p
->ctx
;
98 o
= uci_alloc_element(ctx
, option
, name
, strlen(value
) + 1);
99 o
->type
= UCI_TYPE_STRING
;
100 o
->v
.string
= uci_dataptr(o
);
102 strcpy(o
->v
.string
, value
);
103 uci_list_add(&s
->options
, &o
->e
.list
);
109 uci_free_option(struct uci_option
*o
)
111 struct uci_element
*e
, *tmp
;
114 case UCI_TYPE_STRING
:
115 if ((o
->v
.string
!= uci_dataptr(o
)) &&
116 (o
->v
.string
!= NULL
))
120 uci_foreach_element_safe(&o
->v
.list
, tmp
, e
) {
127 uci_free_element(&o
->e
);
130 static struct uci_option
*
131 uci_alloc_list(struct uci_section
*s
, const char *name
)
133 struct uci_package
*p
= s
->package
;
134 struct uci_context
*ctx
= p
->ctx
;
135 struct uci_option
*o
;
137 o
= uci_alloc_element(ctx
, option
, name
, 0);
138 o
->type
= UCI_TYPE_LIST
;
140 uci_list_init(&o
->v
.list
);
141 uci_list_add(&s
->options
, &o
->e
.list
);
146 /* fix up an unnamed section, e.g. after adding options to it */
147 static void uci_fixup_section(struct uci_context
*ctx
, struct uci_section
*s
)
149 unsigned int hash
= ~0;
150 struct uci_element
*e
;
157 * Generate a name for unnamed sections. This is used as reference
158 * when locating or updating the section from apps/scripts.
159 * To make multiple concurrent versions somewhat safe for updating,
160 * the name is generated from a hash of its type and name/value
161 * pairs of its option, and it is prefixed by a counter value.
162 * If the order of the unnamed sections changes for some reason,
163 * updates to them will be rejected.
165 hash
= djbhash(hash
, s
->type
);
166 uci_foreach_element(&s
->options
, e
) {
167 struct uci_option
*o
;
168 hash
= djbhash(hash
, e
->name
);
169 o
= uci_to_option(e
);
171 case UCI_TYPE_STRING
:
172 hash
= djbhash(hash
, o
->v
.string
);
178 sprintf(buf
, "cfg%02x%04x", ++s
->package
->n_section
, hash
% (1 << 16));
179 s
->e
.name
= uci_strdup(ctx
, buf
);
182 static struct uci_section
*
183 uci_alloc_section(struct uci_package
*p
, const char *type
, const char *name
)
185 struct uci_context
*ctx
= p
->ctx
;
186 struct uci_section
*s
;
188 if (name
&& !name
[0])
191 s
= uci_alloc_element(ctx
, section
, name
, strlen(type
) + 1);
192 uci_list_init(&s
->options
);
193 s
->type
= uci_dataptr(s
);
195 strcpy(s
->type
, type
);
200 uci_list_add(&p
->sections
, &s
->e
.list
);
206 uci_free_section(struct uci_section
*s
)
208 struct uci_element
*o
, *tmp
;
210 uci_foreach_element_safe(&s
->options
, tmp
, o
) {
211 uci_free_option(uci_to_option(o
));
213 if ((s
->type
!= uci_dataptr(s
)) &&
216 uci_free_element(&s
->e
);
219 __plugin
struct uci_package
*
220 uci_alloc_package(struct uci_context
*ctx
, const char *name
)
222 struct uci_package
*p
;
224 p
= uci_alloc_element(ctx
, package
, name
, 0);
226 uci_list_init(&p
->sections
);
227 uci_list_init(&p
->history
);
228 uci_list_init(&p
->saved_history
);
233 uci_free_package(struct uci_package
**package
)
235 struct uci_element
*e
, *tmp
;
236 struct uci_package
*p
= *package
;
243 uci_foreach_element_safe(&p
->sections
, tmp
, e
) {
244 uci_free_section(uci_to_section(e
));
246 uci_foreach_element_safe(&p
->history
, tmp
, e
) {
247 uci_free_history(uci_to_history(e
));
249 uci_foreach_element_safe(&p
->saved_history
, tmp
, e
) {
250 uci_free_history(uci_to_history(e
));
252 uci_free_element(&p
->e
);
257 uci_free_any(struct uci_element
**e
)
260 case UCI_TYPE_SECTION
:
261 uci_free_section(uci_to_section(*e
));
263 case UCI_TYPE_OPTION
:
264 uci_free_option(uci_to_option(*e
));
272 static struct uci_element
*uci_lookup_list(struct uci_list
*list
, const char *name
)
274 struct uci_element
*e
;
276 uci_foreach_element(list
, e
) {
277 if (!strcmp(e
->name
, name
))
283 static struct uci_element
*uci_lookup_ext_section(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
285 char *idxstr
, *t
, *section
, *name
;
286 struct uci_element
*e
= NULL
;
287 struct uci_section
*s
;
290 section
= uci_strdup(ctx
, ptr
->section
);
291 name
= idxstr
= section
+ 1;
293 if (section
[0] != '@')
296 /* parse the section index part */
297 idxstr
= strchr(idxstr
, '[');
303 t
= strchr(idxstr
, ']');
311 idx
= strtol(idxstr
, &t
, 10);
317 else if (!uci_validate_str(name
, false))
320 /* if the given index is negative, it specifies the section number from
321 * the end of the list */
324 uci_foreach_element(&ptr
->p
->sections
, e
) {
325 s
= uci_to_section(e
);
326 if (name
&& (strcmp(s
->type
, name
) != 0))
335 uci_foreach_element(&ptr
->p
->sections
, e
) {
336 s
= uci_to_section(e
);
337 if (name
&& (strcmp(s
->type
, name
) != 0))
349 memset(ptr
, 0, sizeof(struct uci_ptr
));
350 UCI_THROW(ctx
, UCI_ERR_INVAL
);
356 int uci_lookup_ptr(struct uci_context
*ctx
, struct uci_ptr
*ptr
, char *str
, bool extended
)
358 struct uci_element
*e
;
361 UCI_ASSERT(ctx
, ptr
!= NULL
);
364 UCI_INTERNAL(uci_parse_ptr
, ctx
, ptr
, str
);
366 ptr
->flags
|= UCI_LOOKUP_DONE
;
368 /* look up the package first */
369 e
= uci_lookup_list(&ctx
->root
, ptr
->package
);
371 UCI_INTERNAL(uci_load
, ctx
, ptr
->package
, &ptr
->p
);
375 ptr
->p
= uci_to_package(e
);
381 /* if the section name validates as a regular name, pass through
382 * to the regular uci_lookup function call */
383 if (ptr
->flags
& UCI_LOOKUP_EXTENDED
)
384 e
= uci_lookup_ext_section(ctx
, ptr
);
386 e
= uci_lookup_list(&ptr
->p
->sections
, ptr
->section
);
391 ptr
->s
= uci_to_section(e
);
394 e
= uci_lookup_list(&ptr
->s
->options
, ptr
->option
);
398 ptr
->o
= uci_to_option(e
);
402 ptr
->flags
|= UCI_LOOKUP_COMPLETE
;
407 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
412 uci_fill_ptr(struct uci_context
*ctx
, struct uci_ptr
*ptr
, struct uci_element
*e
, bool complete
)
415 UCI_ASSERT(ctx
, ptr
!= NULL
);
416 UCI_ASSERT(ctx
, e
!= NULL
);
418 memset(ptr
, 0, sizeof(struct uci_ptr
));
420 case UCI_TYPE_OPTION
:
421 ptr
->o
= uci_to_option(e
);
423 case UCI_TYPE_SECTION
:
424 ptr
->s
= uci_to_section(e
);
426 case UCI_TYPE_PACKAGE
:
427 ptr
->p
= uci_to_package(e
);
430 UCI_THROW(ctx
, UCI_ERR_INVAL
);
434 ptr
->option
= ptr
->o
->e
.name
;
435 ptr
->s
= ptr
->o
->section
;
437 ptr
->section
= ptr
->s
->e
.name
;
438 ptr
->p
= ptr
->s
->package
;
440 ptr
->package
= ptr
->p
->e
.name
;
442 ptr
->flags
|= UCI_LOOKUP_DONE
;
444 ptr
->flags
|= UCI_LOOKUP_COMPLETE
;
449 static struct uci_element
*
450 expand_ptr(struct uci_context
*ctx
, struct uci_ptr
*ptr
, bool complete
)
452 UCI_ASSERT(ctx
, ptr
!= NULL
);
454 if (!(ptr
->flags
& UCI_LOOKUP_DONE
))
455 uci_lookup_ptr(ctx
, ptr
, NULL
, 1);
456 if (complete
&& !(ptr
->flags
& UCI_LOOKUP_COMPLETE
))
457 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
458 UCI_ASSERT(ctx
, ptr
->p
!= NULL
);
460 /* fill in missing string info */
461 if (ptr
->p
&& !ptr
->package
)
462 ptr
->package
= ptr
->p
->e
.name
;
463 if (ptr
->s
&& !ptr
->section
)
464 ptr
->section
= ptr
->s
->e
.name
;
465 if (ptr
->o
&& !ptr
->option
)
466 ptr
->option
= ptr
->o
->e
.name
;
478 static void uci_add_element_list(struct uci_context
*ctx
, struct uci_ptr
*ptr
, bool internal
)
480 struct uci_element
*e
;
481 struct uci_package
*p
;
484 if (!internal
&& p
->has_history
)
485 uci_add_history(ctx
, &p
->history
, UCI_CMD_LIST_ADD
, ptr
->section
, ptr
->option
, ptr
->value
);
487 e
= uci_alloc_generic(ctx
, UCI_TYPE_ITEM
, ptr
->value
, sizeof(struct uci_option
));
488 uci_list_add(&ptr
->o
->v
.list
, &e
->list
);
491 int uci_set_element_value(struct uci_context
*ctx
, struct uci_element
**element
, const char *value
)
493 /* NB: UCI_INTERNAL use means without history tracking */
494 bool internal
= ctx
->internal
;
495 struct uci_list
*list
;
496 struct uci_element
*e
;
497 struct uci_package
*p
;
498 struct uci_section
*s
;
499 struct uci_option
*o
;
506 UCI_ASSERT(ctx
, (element
!= NULL
) && (*element
!= NULL
));
508 /* what the 'value' of an element means depends on the type
509 * for a section, the 'value' means its type
510 * for an option, the 'value' means its value string
511 * when changing the value, shrink the element to its actual size
512 * (it may have been allocated with a bigger size, to include
514 * then duplicate the string passed on the command line and
515 * insert it into the structure.
521 case UCI_TYPE_SECTION
:
522 UCI_ASSERT(ctx
, uci_validate_str(value
, false));
523 size
= sizeof(struct uci_section
);
524 s
= uci_to_section(e
);
527 /* matches the currently set value */
528 if (!strcmp(value
, s
->type
))
532 case UCI_TYPE_OPTION
:
533 UCI_ASSERT(ctx
, value
!= NULL
);
534 o
= uci_to_option(e
);
539 case UCI_TYPE_STRING
:
540 size
= sizeof(struct uci_option
);
541 /* matches the currently set value */
542 if (!strcmp(value
, o
->v
.string
))
546 /* default action for non-string datatypes is to delete
547 * the existing entry, then re-create it as a string */
553 UCI_THROW(ctx
, UCI_ERR_INVAL
);
557 if (!internal
&& p
->has_history
)
558 uci_add_history(ctx
, &p
->history
, UCI_CMD_CHANGE
, section
, option
, value
);
560 if ((e
->type
== UCI_TYPE_OPTION
) && (size
== 0)) {
561 o
= uci_alloc_option(s
, option
, value
);
567 uci_list_del(&e
->list
);
568 e
= uci_realloc(ctx
, e
, size
);
569 str
= uci_strdup(ctx
, value
);
570 uci_list_insert(list
, &e
->list
);
574 case UCI_TYPE_SECTION
:
575 uci_to_section(e
)->type
= str
;
577 case UCI_TYPE_OPTION
:
578 uci_to_option(e
)->v
.string
= str
;
588 int uci_rename(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
590 /* NB: UCI_INTERNAL use means without history tracking */
591 bool internal
= ctx
->internal
;
592 struct uci_element
*e
;
593 struct uci_package
*p
;
598 e
= expand_ptr(ctx
, ptr
, true);
601 UCI_ASSERT(ctx
, ptr
->s
);
602 UCI_ASSERT(ctx
, ptr
->value
);
604 if (!internal
&& p
->has_history
)
605 uci_add_history(ctx
, &p
->history
, UCI_CMD_RENAME
, ptr
->section
, ptr
->option
, ptr
->value
);
607 n
= uci_strdup(ctx
, ptr
->value
);
615 int uci_add_section(struct uci_context
*ctx
, struct uci_package
*p
, const char *type
, struct uci_section
**res
)
617 bool internal
= ctx
->internal
;
618 struct uci_section
*s
;
621 UCI_ASSERT(ctx
, p
!= NULL
);
622 s
= uci_alloc_section(p
, type
, NULL
);
623 uci_fixup_section(ctx
, s
);
625 if (!internal
&& p
->has_history
)
626 uci_add_history(ctx
, &p
->history
, UCI_CMD_ADD
, s
->e
.name
, NULL
, type
);
631 int uci_delete(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
633 /* NB: pass on internal flag to uci_del_element */
634 bool internal
= ctx
->internal
;
635 struct uci_package
*p
;
636 struct uci_element
*e
;
640 e
= expand_ptr(ctx
, ptr
, true);
643 UCI_ASSERT(ctx
, ptr
->s
);
645 if (!internal
&& p
->has_history
)
646 uci_add_history(ctx
, &p
->history
, UCI_CMD_REMOVE
, ptr
->section
, ptr
->option
, NULL
);
652 int uci_add_list(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
654 /* NB: UCI_INTERNAL use means without history tracking */
655 bool internal
= ctx
->internal
;
656 struct uci_option
*prev
= NULL
;
657 const char *value2
= NULL
;
661 expand_ptr(ctx
, ptr
, false);
662 UCI_ASSERT(ctx
, ptr
->s
);
663 UCI_ASSERT(ctx
, ptr
->value
);
666 switch (ptr
->o
->type
) {
667 case UCI_TYPE_STRING
:
668 /* we already have a string value, convert that to a list */
671 ptr
->value
= ptr
->o
->v
.string
;
674 uci_add_element_list(ctx
, ptr
, internal
);
677 UCI_THROW(ctx
, UCI_ERR_INVAL
);
682 ptr
->o
= uci_alloc_list(ptr
->s
, ptr
->option
);
684 uci_add_element_list(ctx
, ptr
, true);
685 uci_free_option(prev
);
688 uci_add_element_list(ctx
, ptr
, internal
);
693 int uci_set(struct uci_context
*ctx
, struct uci_package
*p
, const char *section
, const char *option
, const char *value
, struct uci_element
**result
)
695 /* NB: UCI_INTERNAL use means without history tracking */
696 bool internal
= ctx
->internal
;
697 struct uci_element
*e
= NULL
;
698 struct uci_section
*s
= NULL
;
699 struct uci_option
*o
= NULL
;
702 UCI_ASSERT(ctx
, p
!= NULL
);
703 UCI_ASSERT(ctx
, uci_validate_name(section
));
705 UCI_ASSERT(ctx
, uci_validate_name(option
));
706 UCI_ASSERT(ctx
, value
!= NULL
);
708 UCI_ASSERT(ctx
, uci_validate_str(value
, false));
712 * look up the package, section and option (if set)
713 * if the section/option is to be modified and it is not found
714 * create a new element in the appropriate list
716 e
= uci_lookup_list(&p
->sections
, section
);
720 s
= uci_to_section(e
);
721 if (ctx
->pctx
&& ctx
->pctx
->merge
)
722 ctx
->pctx
->section
= s
;
725 e
= uci_lookup_list(&s
->options
, option
);
728 o
= uci_to_option(e
);
732 * no unknown element was supplied, assume that we can just update
744 ctx
->internal
= internal
;
745 return uci_set_element_value(ctx
, result
, value
);
749 * the entry that we need to update was not found,
750 * check if the search failed prematurely.
751 * this can happen if the package was not found, or if
752 * an option was supplied, but the section wasn't found
754 if (!p
|| (!s
&& option
))
755 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
757 /* now add the missing entry */
758 if (!internal
&& p
->has_history
)
759 uci_add_history(ctx
, &p
->history
, UCI_CMD_CHANGE
, section
, option
, value
);
761 o
= uci_alloc_option(s
, option
, value
);
765 s
= uci_alloc_section(p
, value
, section
);
768 if (ctx
->pctx
&& ctx
->pctx
->merge
)
769 ctx
->pctx
->section
= s
;
775 int uci_unload(struct uci_context
*ctx
, struct uci_package
*p
)
778 UCI_ASSERT(ctx
, p
!= NULL
);
780 uci_free_package(&p
);