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;
64 ptr = uci_malloc(ctx, datalen);
65 e = (struct uci_element *) ptr;
68 UCI_TRAP_SAVE(ctx, error);
69 e->name = uci_strdup(ctx, name);
70 UCI_TRAP_RESTORE(ctx);
72 uci_list_init(&e->list);
77 UCI_THROW(ctx, ctx->err);
84 uci_free_element(struct uci_element *e)
88 if (!uci_list_empty(&e->list))
89 uci_list_del(&e->list);
93 static struct uci_option *
94 uci_alloc_option(struct uci_section *s, const char *name, const char *value)
96 struct uci_package *p = s->package;
97 struct uci_context *ctx = p->ctx;
100 o = uci_alloc_element(ctx, option, name, strlen(value) + 1);
101 o->value = uci_dataptr(o);
103 strcpy(o->value, value);
104 uci_list_add(&s->options, &o->e.list);
110 uci_free_option(struct uci_option *o)
112 if ((o->value != uci_dataptr(o)) &&
115 uci_free_element(&o->e);
118 /* fix up an unnamed section, e.g. after adding options to it */
119 static void uci_fixup_section(struct uci_context *ctx, struct uci_section *s)
121 unsigned int hash = ~0;
122 struct uci_element *e;
129 * Generate a name for unnamed sections. This is used as reference
130 * when locating or updating the section from apps/scripts.
131 * To make multiple concurrent versions somewhat safe for updating,
132 * the name is generated from a hash of its type and name/value
133 * pairs of its option, and it is prefixed by a counter value.
134 * If the order of the unnamed sections changes for some reason,
135 * updates to them will be rejected.
137 hash = djbhash(hash, s->type);
138 uci_foreach_element(&s->options, e) {
139 hash = djbhash(hash, e->name);
140 hash = djbhash(hash, uci_to_option(e)->value);
142 sprintf(buf, "cfg%02x%04x", ++s->package->n_section, hash % (1 << 16));
143 s->e.name = uci_strdup(ctx, buf);
146 static struct uci_section *
147 uci_alloc_section(struct uci_package *p, const char *type, const char *name)
149 struct uci_context *ctx = p->ctx;
150 struct uci_section *s;
152 if (name && !name[0])
155 s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
156 uci_list_init(&s->options);
157 s->type = uci_dataptr(s);
159 strcpy(s->type, type);
164 uci_list_add(&p->sections, &s->e.list);
170 uci_free_section(struct uci_section *s)
172 struct uci_element *o, *tmp;
174 uci_foreach_element_safe(&s->options, tmp, o) {
175 uci_free_option(uci_to_option(o));
177 if ((s->type != uci_dataptr(s)) &&
180 uci_free_element(&s->e);
183 __plugin struct uci_package *
184 uci_alloc_package(struct uci_context *ctx, const char *name)
186 struct uci_package *p;
188 p = uci_alloc_element(ctx, package, name, 0);
190 uci_list_init(&p->sections);
191 uci_list_init(&p->history);
192 uci_list_init(&p->saved_history);
197 uci_free_package(struct uci_package **package)
199 struct uci_element *e, *tmp;
200 struct uci_package *p = *package;
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_foreach_element_safe(&p->saved_history, tmp, e) {
214 uci_free_history(uci_to_history(e));
216 uci_free_element(&p->e);
220 static struct uci_element *uci_lookup_list(struct uci_list *list, const char *name)
222 struct uci_element *e;
224 uci_foreach_element(list, e) {
225 if (!strcmp(e->name, name))
231 int uci_lookup_ext(struct uci_context *ctx, struct uci_element **res, char *ptr)
233 struct uci_package *p = NULL;
234 struct uci_element *e;
235 struct uci_section *s;
236 char *package = NULL;
237 char *section = NULL;
243 UCI_ASSERT(ctx, res != NULL);
244 UCI_ASSERT(ctx, ptr != NULL);
246 UCI_INTERNAL(uci_parse_tuple, ctx, ptr, &package, §ion, &option, NULL);
248 /* look up the package first */
249 e = uci_lookup_list(&ctx->root, package);
251 UCI_INTERNAL(uci_load, ctx, package, &p);
256 p = uci_to_package(e);
262 /* if the section name validates as a regular name, pass through
263 * to the regular uci_lookup function call */
264 if (!*section || uci_validate_name(section)) {
265 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
269 /* name did not validate, that means we have an extended lookup call
270 * parse it here. for now only the section index syntax is supported */
271 if (section[0] != '@')
276 /* parse the section index part */
277 idxstr = strchr(section, '[');
283 t = strchr(idxstr, ']');
291 idx = strtol(idxstr, &t, 10);
297 if (section && !uci_validate_str(section, false))
300 /* if the given index is negative, it specifies the section number from
301 * the end of the list */
304 uci_foreach_element(&p->sections, e) {
305 s = uci_to_section(e);
306 if (section && (strcmp(s->type, section) != 0))
315 uci_foreach_element(&p->sections, e) {
316 s = uci_to_section(e);
317 if (section && (strcmp(s->type, section) != 0))
328 e = uci_lookup_list(&s->options, option);
334 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
336 UCI_THROW(ctx, UCI_ERR_INVAL);
340 int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *p, const char *section, const char *option)
342 struct uci_element *e;
343 struct uci_section *s;
346 UCI_ASSERT(ctx, res != NULL);
347 UCI_ASSERT(ctx, p != NULL);
348 UCI_ASSERT(ctx, section && uci_validate_name(section));
350 UCI_ASSERT(ctx, uci_validate_name(option));
352 e = uci_lookup_list(&p->sections, section);
357 s = uci_to_section(e);
358 e = uci_lookup_list(&s->options, option);
367 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
371 int uci_del_element(struct uci_context *ctx, struct uci_element *e)
373 /* NB: UCI_INTERNAL use means without history tracking */
374 bool internal = ctx->internal;
375 struct uci_package *p = NULL;
376 struct uci_section *s = NULL;
377 struct uci_option *o = NULL;
378 struct uci_element *i, *tmp;
382 UCI_ASSERT(ctx, e != NULL);
385 case UCI_TYPE_SECTION:
386 s = uci_to_section(e);
387 uci_foreach_element_safe(&s->options, tmp, i) {
388 uci_del_element(ctx, i);
391 case UCI_TYPE_OPTION:
392 o = uci_to_option(e);
398 UCI_THROW(ctx, UCI_ERR_INVAL);
403 if (!internal && p->has_history)
404 uci_add_history(ctx, &p->history, UCI_CMD_REMOVE, s->e.name, option, NULL);
407 case UCI_TYPE_SECTION:
410 case UCI_TYPE_OPTION:
419 int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, const char *value)
421 /* NB: UCI_INTERNAL use means without history tracking */
422 bool internal = ctx->internal;
423 struct uci_list *list;
424 struct uci_element *e;
425 struct uci_package *p;
426 struct uci_section *s;
427 struct uci_option *o;
434 UCI_ASSERT(ctx, (element != NULL) && (*element != NULL));
436 /* what the 'value' of an element means depends on the type
437 * for a section, the 'value' means its type
438 * for an option, the 'value' means its value string
439 * when changing the value, shrink the element to its actual size
440 * (it may have been allocated with a bigger size, to include
442 * then duplicate the string passed on the command line and
443 * insert it into the structure.
448 case UCI_TYPE_SECTION:
449 UCI_ASSERT(ctx, uci_validate_str(value, false));
450 size = sizeof(struct uci_section);
451 s = uci_to_section(e);
454 /* matches the currently set value */
455 if (!strcmp(value, s->type))
458 case UCI_TYPE_OPTION:
459 UCI_ASSERT(ctx, value != NULL);
460 size = sizeof(struct uci_option);
461 o = uci_to_option(e);
465 /* matches the currently set value */
466 if (!strcmp(value, o->value))
470 UCI_THROW(ctx, UCI_ERR_INVAL);
474 if (!internal && p->has_history)
475 uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
477 uci_list_del(&e->list);
478 e = uci_realloc(ctx, e, size);
479 str = uci_strdup(ctx, value);
480 uci_list_insert(list, &e->list);
484 case UCI_TYPE_SECTION:
485 uci_to_section(e)->type = str;
487 case UCI_TYPE_OPTION:
488 uci_to_option(e)->value = str;
497 int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name)
499 /* NB: UCI_INTERNAL use means without history tracking */
500 bool internal = ctx->internal;
501 struct uci_element *e;
505 /* NB: p, section, option validated by uci_lookup */
506 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
508 if (!internal && p->has_history)
509 uci_add_history(ctx, &p->history, UCI_CMD_RENAME, section, option, name);
511 name = uci_strdup(ctx, name);
519 int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res)
521 bool internal = ctx->internal;
522 struct uci_section *s;
525 UCI_ASSERT(ctx, p != NULL);
526 s = uci_alloc_section(p, type, NULL);
527 uci_fixup_section(ctx, s);
529 if (!internal && p->has_history)
530 uci_add_history(ctx, &p->history, UCI_CMD_ADD, s->e.name, NULL, type);
535 int uci_delete(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option)
537 /* NB: pass on internal flag to uci_del_element */
538 bool internal = ctx->internal;
539 struct uci_element *e;
543 /* NB: p, section, option validated by uci_lookup */
544 UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
546 ctx->internal = internal;
547 return uci_del_element(ctx, e);
550 int uci_set(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_element **result)
552 /* NB: UCI_INTERNAL use means without history tracking */
553 bool internal = ctx->internal;
554 struct uci_element *e = NULL;
555 struct uci_section *s = NULL;
556 struct uci_option *o = NULL;
559 UCI_ASSERT(ctx, p != NULL);
560 UCI_ASSERT(ctx, uci_validate_name(section));
562 UCI_ASSERT(ctx, uci_validate_name(option));
563 UCI_ASSERT(ctx, value != NULL);
565 UCI_ASSERT(ctx, uci_validate_str(value, false));
569 * look up the package, section and option (if set)
570 * if the section/option is to be modified and it is not found
571 * create a new element in the appropriate list
573 e = uci_lookup_list(&p->sections, section);
577 s = uci_to_section(e);
578 if (ctx->pctx && ctx->pctx->merge)
579 ctx->pctx->section = s;
582 e = uci_lookup_list(&s->options, option);
585 o = uci_to_option(e);
589 * no unknown element was supplied, assume that we can just update
601 ctx->internal = internal;
602 return uci_set_element_value(ctx, result, value);
606 * the entry that we need to update was not found,
607 * check if the search failed prematurely.
608 * this can happen if the package was not found, or if
609 * an option was supplied, but the section wasn't found
611 if (!p || (!s && option))
612 UCI_THROW(ctx, UCI_ERR_NOTFOUND);
614 /* now add the missing entry */
615 if (!internal && p->has_history)
616 uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
618 o = uci_alloc_option(s, option, value);
622 s = uci_alloc_section(p, value, section);
625 if (ctx->pctx && ctx->pctx->merge)
626 ctx->pctx->section = s;
632 int uci_unload(struct uci_context *ctx, struct uci_package *p)
635 UCI_ASSERT(ctx, p != NULL);
637 uci_free_package(&p);