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 Lesser General Public License for more details.
15 static void uci_list_set_pos(struct uci_list
*head
, struct uci_list
*ptr
, int pos
)
17 struct uci_list
*new_head
= head
;
18 struct uci_element
*p
= NULL
;
21 uci_foreach_element(head
, p
) {
27 uci_list_add(new_head
->next
, ptr
);
30 static inline void uci_list_fixup(struct uci_list
*ptr
)
32 ptr
->prev
->next
= ptr
;
33 ptr
->next
->prev
= ptr
;
37 * uci_alloc_generic allocates a new uci_element with payload
38 * payload is appended to the struct to save memory and reduce fragmentation
40 __private
struct uci_element
*
41 uci_alloc_generic(struct uci_context
*ctx
, int type
, const char *name
, int size
)
43 struct uci_element
*e
;
47 ptr
= uci_malloc(ctx
, datalen
);
48 e
= (struct uci_element
*) ptr
;
51 UCI_TRAP_SAVE(ctx
, error
);
52 e
->name
= uci_strdup(ctx
, name
);
53 UCI_TRAP_RESTORE(ctx
);
55 uci_list_init(&e
->list
);
60 UCI_THROW(ctx
, ctx
->err
);
67 uci_free_element(struct uci_element
*e
)
70 if (!uci_list_empty(&e
->list
))
71 uci_list_del(&e
->list
);
75 static struct uci_option
*
76 uci_alloc_option(struct uci_section
*s
, const char *name
, const char *value
)
78 struct uci_package
*p
= s
->package
;
79 struct uci_context
*ctx
= p
->ctx
;
82 o
= uci_alloc_element(ctx
, option
, name
, strlen(value
) + 1);
83 o
->type
= UCI_TYPE_STRING
;
84 o
->v
.string
= uci_dataptr(o
);
86 strcpy(o
->v
.string
, value
);
87 uci_list_add(&s
->options
, &o
->e
.list
);
93 uci_free_option(struct uci_option
*o
)
95 struct uci_element
*e
, *tmp
;
99 if ((o
->v
.string
!= uci_dataptr(o
)) &&
100 (o
->v
.string
!= NULL
))
104 uci_foreach_element_safe(&o
->v
.list
, tmp
, e
) {
111 uci_free_element(&o
->e
);
114 static struct uci_option
*
115 uci_alloc_list(struct uci_section
*s
, const char *name
)
117 struct uci_package
*p
= s
->package
;
118 struct uci_context
*ctx
= p
->ctx
;
119 struct uci_option
*o
;
121 o
= uci_alloc_element(ctx
, option
, name
, 0);
122 o
->type
= UCI_TYPE_LIST
;
124 uci_list_init(&o
->v
.list
);
125 uci_list_add(&s
->options
, &o
->e
.list
);
130 /* Based on an efficient hash function published by D. J. Bernstein */
131 static unsigned int djbhash(unsigned int hash
, char *str
)
133 int len
= strlen(str
);
140 for(i
= 0; i
< len
; i
++) {
141 hash
= ((hash
<< 5) + hash
) + str
[i
];
143 return (hash
& 0x7FFFFFFF);
146 /* fix up an unnamed section, e.g. after adding options to it */
147 __private
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 __private
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
->delta
);
228 uci_list_init(&p
->saved_delta
);
233 uci_free_package(struct uci_package
**package
)
235 struct uci_element
*e
, *tmp
;
236 struct uci_package
*p
= *package
;
242 uci_foreach_element_safe(&p
->sections
, tmp
, e
) {
243 uci_free_section(uci_to_section(e
));
245 uci_foreach_element_safe(&p
->delta
, tmp
, e
) {
246 uci_free_delta(uci_to_delta(e
));
248 uci_foreach_element_safe(&p
->saved_delta
, tmp
, e
) {
249 uci_free_delta(uci_to_delta(e
));
251 uci_free_element(&p
->e
);
256 uci_free_any(struct uci_element
**e
)
259 case UCI_TYPE_SECTION
:
260 uci_free_section(uci_to_section(*e
));
262 case UCI_TYPE_OPTION
:
263 uci_free_option(uci_to_option(*e
));
271 __private
struct uci_element
*
272 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
*
284 uci_lookup_ext_section(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
286 char *idxstr
, *t
, *section
, *name
;
287 struct uci_element
*e
= NULL
;
288 struct uci_section
*s
;
291 section
= uci_strdup(ctx
, ptr
->section
);
292 name
= idxstr
= section
+ 1;
294 if (section
[0] != '@')
297 /* parse the section index part */
298 idxstr
= strchr(idxstr
, '[');
304 t
= strchr(idxstr
, ']');
312 idx
= strtol(idxstr
, &t
, 10);
318 else if (!uci_validate_type(name
))
321 /* if the given index is negative, it specifies the section number from
322 * the end of the list */
325 uci_foreach_element(&ptr
->p
->sections
, e
) {
326 s
= uci_to_section(e
);
327 if (name
&& (strcmp(s
->type
, name
) != 0))
336 uci_foreach_element(&ptr
->p
->sections
, e
) {
337 s
= uci_to_section(e
);
338 if (name
&& (strcmp(s
->type
, name
) != 0))
350 memset(ptr
, 0, sizeof(struct uci_ptr
));
351 UCI_THROW(ctx
, UCI_ERR_INVAL
);
355 ptr
->section
= e
->name
;
360 uci_lookup_next(struct uci_context
*ctx
, struct uci_element
**e
, struct uci_list
*list
, const char *name
)
364 *e
= uci_lookup_list(list
, name
);
366 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
372 uci_lookup_ptr(struct uci_context
*ctx
, struct uci_ptr
*ptr
, char *str
, bool extended
)
374 struct uci_element
*e
;
377 UCI_ASSERT(ctx
, ptr
!= NULL
);
380 UCI_INTERNAL(uci_parse_ptr
, ctx
, ptr
, str
);
382 ptr
->flags
|= UCI_LOOKUP_DONE
;
384 /* look up the package first */
388 e
= uci_lookup_list(&ctx
->root
, ptr
->package
);
391 UCI_INTERNAL(uci_load
, ctx
, ptr
->package
, &ptr
->p
);
394 ptr
->last
= &ptr
->p
->e
;
396 ptr
->p
= uci_to_package(e
);
400 if (!ptr
->section
&& !ptr
->s
)
403 /* if the section name validates as a regular name, pass through
404 * to the regular uci_lookup function call */
407 } else if (ptr
->flags
& UCI_LOOKUP_EXTENDED
) {
409 e
= uci_lookup_ext_section(ctx
, ptr
);
411 UCI_THROW(ctx
, UCI_ERR_INVAL
);
413 e
= uci_lookup_list(&ptr
->p
->sections
, ptr
->section
);
420 ptr
->s
= uci_to_section(e
);
423 e
= uci_lookup_list(&ptr
->s
->options
, ptr
->option
);
427 ptr
->o
= uci_to_option(e
);
432 ptr
->flags
|= UCI_LOOKUP_COMPLETE
;
437 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
438 /* not a chance here */
439 return UCI_ERR_NOTFOUND
;
442 __private
struct uci_element
*
443 uci_expand_ptr(struct uci_context
*ctx
, struct uci_ptr
*ptr
, bool complete
)
445 UCI_ASSERT(ctx
, ptr
!= NULL
);
447 if (!(ptr
->flags
& UCI_LOOKUP_DONE
))
448 UCI_INTERNAL(uci_lookup_ptr
, ctx
, ptr
, NULL
, 1);
449 if (complete
&& !(ptr
->flags
& UCI_LOOKUP_COMPLETE
))
450 UCI_THROW(ctx
, UCI_ERR_NOTFOUND
);
451 UCI_ASSERT(ctx
, ptr
->p
!= NULL
);
453 /* fill in missing string info */
454 if (ptr
->p
&& !ptr
->package
)
455 ptr
->package
= ptr
->p
->e
.name
;
456 if (ptr
->s
&& !ptr
->section
)
457 ptr
->section
= ptr
->s
->e
.name
;
458 if (ptr
->o
&& !ptr
->option
)
459 ptr
->option
= ptr
->o
->e
.name
;
471 static void uci_add_element_list(struct uci_context
*ctx
, struct uci_ptr
*ptr
, bool internal
)
473 struct uci_element
*e
;
474 struct uci_package
*p
;
477 if (!internal
&& p
->has_delta
)
478 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_LIST_ADD
, ptr
->section
, ptr
->option
, ptr
->value
);
480 e
= uci_alloc_generic(ctx
, UCI_TYPE_ITEM
, ptr
->value
, sizeof(struct uci_option
));
481 uci_list_add(&ptr
->o
->v
.list
, &e
->list
);
484 int uci_rename(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
486 /* NB: UCI_INTERNAL use means without delta tracking */
487 bool internal
= ctx
&& ctx
->internal
;
488 struct uci_element
*e
;
489 struct uci_package
*p
;
494 e
= uci_expand_ptr(ctx
, ptr
, true);
497 UCI_ASSERT(ctx
, ptr
->s
);
498 UCI_ASSERT(ctx
, ptr
->value
);
500 if (!internal
&& p
->has_delta
)
501 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_RENAME
, ptr
->section
, ptr
->option
, ptr
->value
);
503 n
= uci_strdup(ctx
, ptr
->value
);
507 if (e
->type
== UCI_TYPE_SECTION
)
508 uci_to_section(e
)->anonymous
= false;
513 int uci_reorder_section(struct uci_context
*ctx
, struct uci_section
*s
, int pos
)
515 struct uci_package
*p
= s
->package
;
516 bool internal
= ctx
&& ctx
->internal
;
521 uci_list_set_pos(&s
->package
->sections
, &s
->e
.list
, pos
);
522 if (!internal
&& p
->has_delta
) {
523 sprintf(order
, "%d", pos
);
524 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_REORDER
, s
->e
.name
, NULL
, order
);
530 int uci_add_section(struct uci_context
*ctx
, struct uci_package
*p
, const char *type
, struct uci_section
**res
)
532 bool internal
= ctx
&& ctx
->internal
;
533 struct uci_section
*s
;
536 UCI_ASSERT(ctx
, p
!= NULL
);
537 s
= uci_alloc_section(p
, type
, NULL
);
538 uci_fixup_section(ctx
, s
);
540 if (!internal
&& p
->has_delta
)
541 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_ADD
, s
->e
.name
, NULL
, type
);
546 int uci_delete(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
548 /* NB: pass on internal flag to uci_del_element */
549 bool internal
= ctx
&& ctx
->internal
;
550 struct uci_package
*p
;
551 struct uci_element
*e1
, *e2
, *tmp
;
556 e1
= uci_expand_ptr(ctx
, ptr
, true);
559 UCI_ASSERT(ctx
, ptr
->s
);
561 if (ptr
->o
&& ptr
->o
->type
== UCI_TYPE_LIST
&& ptr
->value
&& *ptr
->value
) {
562 if (!sscanf(ptr
->value
, "%d", &index
))
565 uci_foreach_element_safe(&ptr
->o
->v
.list
, tmp
, e2
) {
567 if (!internal
&& p
->has_delta
)
568 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_REMOVE
, ptr
->section
, ptr
->option
, ptr
->value
);
569 uci_free_option(uci_to_option(e2
));
578 if (!internal
&& p
->has_delta
)
579 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_REMOVE
, ptr
->section
, ptr
->option
, NULL
);
585 else if (ptr
->section
)
591 int uci_add_list(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
593 /* NB: UCI_INTERNAL use means without delta tracking */
594 bool internal
= ctx
&& ctx
->internal
;
595 struct uci_option
*prev
= NULL
;
596 const char *value2
= NULL
;
600 uci_expand_ptr(ctx
, ptr
, false);
601 UCI_ASSERT(ctx
, ptr
->s
);
602 UCI_ASSERT(ctx
, ptr
->value
);
605 switch (ptr
->o
->type
) {
606 case UCI_TYPE_STRING
:
607 /* we already have a string value, convert that to a list */
610 ptr
->value
= ptr
->o
->v
.string
;
613 uci_add_element_list(ctx
, ptr
, internal
);
616 UCI_THROW(ctx
, UCI_ERR_INVAL
);
621 ptr
->o
= uci_alloc_list(ptr
->s
, ptr
->option
);
623 uci_add_element_list(ctx
, ptr
, true);
624 uci_free_option(prev
);
627 uci_add_element_list(ctx
, ptr
, internal
);
632 int uci_del_list(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
634 /* NB: pass on internal flag to uci_del_element */
635 bool internal
= ctx
&& ctx
->internal
;
636 struct uci_element
*e
, *tmp
;
637 struct uci_package
*p
;
641 uci_expand_ptr(ctx
, ptr
, false);
642 UCI_ASSERT(ctx
, ptr
->s
);
643 UCI_ASSERT(ctx
, ptr
->value
);
645 if (!(ptr
->o
&& ptr
->option
))
648 if ((ptr
->o
->type
!= UCI_TYPE_LIST
))
652 if (!internal
&& p
->has_delta
)
653 uci_add_delta(ctx
, &p
->delta
, UCI_CMD_LIST_DEL
, ptr
->section
, ptr
->option
, ptr
->value
);
655 uci_foreach_element_safe(&ptr
->o
->v
.list
, tmp
, e
) {
656 if (!strcmp(ptr
->value
, uci_to_option(e
)->e
.name
)) {
657 uci_free_option(uci_to_option(e
));
664 int uci_set(struct uci_context
*ctx
, struct uci_ptr
*ptr
)
666 /* NB: UCI_INTERNAL use means without delta tracking */
667 bool internal
= ctx
&& ctx
->internal
;
670 uci_expand_ptr(ctx
, ptr
, false);
671 UCI_ASSERT(ctx
, ptr
->value
);
672 UCI_ASSERT(ctx
, ptr
->s
|| (!ptr
->option
&& ptr
->section
));
673 if (!ptr
->option
&& ptr
->value
[0]) {
674 UCI_ASSERT(ctx
, uci_validate_type(ptr
->value
));
677 if (!ptr
->o
&& ptr
->s
&& ptr
->option
) {
678 struct uci_element
*e
;
679 e
= uci_lookup_list(&ptr
->s
->options
, ptr
->option
);
681 ptr
->o
= uci_to_option(e
);
683 if (!ptr
->value
[0]) {
684 /* if setting a nonexistant option/section to a nonexistant value,
685 * exit without errors */
686 if (!(ptr
->flags
& UCI_LOOKUP_COMPLETE
))
689 return uci_delete(ctx
, ptr
);
690 } else if (!ptr
->o
&& ptr
->option
) { /* new option */
691 ptr
->o
= uci_alloc_option(ptr
->s
, ptr
->option
, ptr
->value
);
692 ptr
->last
= &ptr
->o
->e
;
693 } else if (!ptr
->s
&& ptr
->section
) { /* new section */
694 ptr
->s
= uci_alloc_section(ptr
->p
, ptr
->value
, ptr
->section
);
695 ptr
->last
= &ptr
->s
->e
;
696 } else if (ptr
->o
&& ptr
->option
) { /* update option */
697 if ((ptr
->o
->type
== UCI_TYPE_STRING
) &&
698 !strcmp(ptr
->o
->v
.string
, ptr
->value
))
700 uci_free_option(ptr
->o
);
701 ptr
->o
= uci_alloc_option(ptr
->s
, ptr
->option
, ptr
->value
);
702 ptr
->last
= &ptr
->o
->e
;
703 } else if (ptr
->s
&& ptr
->section
) { /* update section */
704 char *s
= uci_strdup(ctx
, ptr
->value
);
706 if (ptr
->s
->type
== uci_dataptr(ptr
->s
)) {
708 ptr
->last
= uci_realloc(ctx
, ptr
->s
, sizeof(struct uci_section
));
709 ptr
->s
= uci_to_section(ptr
->last
);
710 uci_list_fixup(&ptr
->s
->e
.list
);
716 UCI_THROW(ctx
, UCI_ERR_INVAL
);
719 if (!internal
&& ptr
->p
->has_delta
)
720 uci_add_delta(ctx
, &ptr
->p
->delta
, UCI_CMD_CHANGE
, ptr
->section
, ptr
->option
, ptr
->value
);
725 int uci_unload(struct uci_context
*ctx
, struct uci_package
*p
)
728 UCI_ASSERT(ctx
, p
!= NULL
);
730 uci_free_package(&p
);