* libuci - Library for the Unified Configuration Interface
* Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
*
- * this program is free software; you can redistribute it and/or modify
- * it under the terms of the gnu lesser general public license version 2.1
- * as published by the free software foundation
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 2.1
+ * as published by the Free Software Foundation
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* GNU General Public License for more details.
*/
-#include <glob.h>
-
/* initialize a list head/item */
static inline void uci_list_init(struct uci_list *ptr)
{
ptr->next = ptr;
}
-/* inserts a new list entry between two consecutive entries */
+/* inserts a new list entry after a given entry */
static inline void uci_list_insert(struct uci_list *list, struct uci_list *ptr)
{
list->next->prev = ptr;
uci_list_init(ptr);
}
+/*
+ * uci_alloc_generic allocates a new uci_element with payload
+ * payload is appended to the struct to save memory and reduce fragmentation
+ */
static struct uci_element *
uci_alloc_generic(struct uci_context *ctx, int type, const char *name, int size)
{
struct uci_element *e;
+ int datalen = size;
void *ptr;
- ptr = uci_malloc(ctx, size + strlen(name) + 1);
+ ptr = uci_malloc(ctx, datalen);
e = (struct uci_element *) ptr;
e->type = type;
- e->name = (char *) ptr + size;
- strcpy(e->name, name);
+ if (name) {
+ UCI_TRAP_SAVE(ctx, error);
+ e->name = uci_strdup(ctx, name);
+ UCI_TRAP_RESTORE(ctx);
+ }
uci_list_init(&e->list);
+ goto done;
+error:
+ free(ptr);
+ UCI_THROW(ctx, ctx->err);
+
+done:
return e;
}
static void
uci_free_element(struct uci_element *e)
{
- if (!e)
- return;
-
+ if (e->name)
+ free(e->name);
if (!uci_list_empty(&e->list))
uci_list_del(&e->list);
free(e);
struct uci_option *o;
o = uci_alloc_element(ctx, option, name, strlen(value) + 1);
- o->value = uci_dataptr(o);
+ o->type = UCI_TYPE_STRING;
+ o->v.string = uci_dataptr(o);
o->section = s;
- strcpy(o->value, value);
+ strcpy(o->v.string, value);
uci_list_add(&s->options, &o->e.list);
return o;
static inline void
uci_free_option(struct uci_option *o)
{
+ struct uci_element *e, *tmp;
+
+ switch(o->type) {
+ case UCI_TYPE_STRING:
+ if ((o->v.string != uci_dataptr(o)) &&
+ (o->v.string != NULL))
+ free(o->v.string);
+ break;
+ case UCI_TYPE_LIST:
+ uci_foreach_element_safe(&o->v.list, tmp, e) {
+ uci_free_element(e);
+ }
+ break;
+ default:
+ break;
+ }
uci_free_element(&o->e);
}
+static struct uci_option *
+uci_alloc_list(struct uci_section *s, const char *name)
+{
+ struct uci_package *p = s->package;
+ struct uci_context *ctx = p->ctx;
+ struct uci_option *o;
+
+ o = uci_alloc_element(ctx, option, name, 0);
+ o->type = UCI_TYPE_LIST;
+ o->section = s;
+ uci_list_init(&o->v.list);
+ uci_list_add(&s->options, &o->e.list);
+
+ return o;
+}
+
+/* fix up an unnamed section, e.g. after adding options to it */
+static void uci_fixup_section(struct uci_context *ctx, struct uci_section *s)
+{
+ unsigned int hash = ~0;
+ struct uci_element *e;
+ char buf[16];
+
+ if (!s || s->e.name)
+ return;
+
+ /*
+ * Generate a name for unnamed sections. This is used as reference
+ * when locating or updating the section from apps/scripts.
+ * To make multiple concurrent versions somewhat safe for updating,
+ * the name is generated from a hash of its type and name/value
+ * pairs of its option, and it is prefixed by a counter value.
+ * If the order of the unnamed sections changes for some reason,
+ * updates to them will be rejected.
+ */
+ hash = djbhash(hash, s->type);
+ uci_foreach_element(&s->options, e) {
+ struct uci_option *o;
+ hash = djbhash(hash, e->name);
+ o = uci_to_option(e);
+ switch(o->type) {
+ case UCI_TYPE_STRING:
+ hash = djbhash(hash, o->v.string);
+ break;
+ default:
+ break;
+ }
+ }
+ sprintf(buf, "cfg%02x%04x", ++s->package->n_section, hash % (1 << 16));
+ s->e.name = uci_strdup(ctx, buf);
+}
+
static struct uci_section *
uci_alloc_section(struct uci_package *p, const char *type, const char *name)
{
struct uci_context *ctx = p->ctx;
struct uci_section *s;
- char buf[16];
- if (!name || !name[0]) {
- snprintf(buf, 16, "cfg%d", p->n_section);
- name = buf;
- }
+ if (name && !name[0])
+ name = NULL;
s = uci_alloc_element(ctx, section, name, strlen(type) + 1);
+ uci_list_init(&s->options);
s->type = uci_dataptr(s);
s->package = p;
strcpy(s->type, type);
- uci_list_init(&s->options);
+ if (name == NULL)
+ s->anonymous = true;
+ p->n_section++;
+
uci_list_add(&p->sections, &s->e.list);
return s;
uci_foreach_element_safe(&s->options, tmp, o) {
uci_free_option(uci_to_option(o));
}
+ if ((s->type != uci_dataptr(s)) &&
+ (s->type != NULL))
+ free(s->type);
uci_free_element(&s->e);
}
-static struct uci_package *
+__plugin struct uci_package *
uci_alloc_package(struct uci_context *ctx, const char *name)
{
struct uci_package *p;
p = uci_alloc_element(ctx, package, name, 0);
p->ctx = ctx;
uci_list_init(&p->sections);
+ uci_list_init(&p->history);
+ uci_list_init(&p->saved_history);
return p;
}
static void
-uci_free_package(struct uci_package *p)
+uci_free_package(struct uci_package **package)
{
struct uci_element *e, *tmp;
+ struct uci_package *p = *package;
if(!p)
return;
+ if (p->path)
+ free(p->path);
uci_foreach_element_safe(&p->sections, tmp, e) {
uci_free_section(uci_to_section(e));
}
+ uci_foreach_element_safe(&p->history, tmp, e) {
+ uci_free_history(uci_to_history(e));
+ }
+ uci_foreach_element_safe(&p->saved_history, tmp, e) {
+ uci_free_history(uci_to_history(e));
+ }
uci_free_element(&p->e);
+ *package = NULL;
}
-static struct uci_element *uci_lookup_list(struct uci_context *ctx, struct uci_list *list, char *name)
+static struct uci_element *uci_lookup_list(struct uci_list *list, const char *name)
{
struct uci_element *e;
if (!strcmp(e->name, name))
return e;
}
- UCI_THROW(ctx, UCI_ERR_NOTFOUND);
+ return NULL;
}
-int uci_lookup(struct uci_context *ctx, struct uci_element **res, char *package, char *section, char *option)
+int uci_lookup_ext(struct uci_context *ctx, struct uci_element **res, char *ptr)
{
+ struct uci_package *p = NULL;
struct uci_element *e;
- struct uci_package *p;
struct uci_section *s;
- struct uci_option *o;
+ char *package = NULL;
+ char *section = NULL;
+ char *option = NULL;
+ char *idxstr, *t;
+ int idx, c;
UCI_HANDLE_ERR(ctx);
UCI_ASSERT(ctx, res != NULL);
- UCI_ASSERT(ctx, package != NULL);
+ UCI_ASSERT(ctx, ptr != NULL);
+
+ UCI_INTERNAL(uci_parse_tuple, ctx, ptr, &package, §ion, &option, NULL);
+
+ /* look up the package first */
+ e = uci_lookup_list(&ctx->root, package);
+ if (!e) {
+ UCI_INTERNAL(uci_load, ctx, package, &p);
+ if (!p)
+ goto notfound;
+ e = &p->e;
+ } else {
+ p = uci_to_package(e);
+ }
- e = uci_lookup_list(ctx, &ctx->root, package);
if (!section)
- goto found;
+ goto done;
- p = uci_to_package(e);
- e = uci_lookup_list(ctx, &p->sections, section);
- if (!option)
- goto found;
+ /* if the section name validates as a regular name, pass through
+ * to the regular uci_lookup function call */
+ if (!*section || uci_validate_name(section)) {
+ UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
+ goto done;
+ }
- s = uci_to_section(e);
- e = uci_lookup_list(ctx, &s->options, option);
+ /* name did not validate, that means we have an extended lookup call
+ * parse it here. for now only the section index syntax is supported */
+ if (section[0] != '@')
+ goto error;
+
+ section++;
+
+ /* parse the section index part */
+ idxstr = strchr(section, '[');
+ if (!idxstr)
+ goto error;
+ *idxstr = 0;
+ idxstr++;
+
+ t = strchr(idxstr, ']');
+ if (!t)
+ goto error;
+ if (t[1] != 0)
+ goto error;
+ *t = 0;
+
+ t = NULL;
+ idx = strtol(idxstr, &t, 10);
+ if (t && *t)
+ goto error;
+
+ if (!*section)
+ section = NULL;
+ if (section && !uci_validate_str(section, false))
+ goto error;
+
+ /* if the given index is negative, it specifies the section number from
+ * the end of the list */
+ if (idx < 0) {
+ c = 0;
+ uci_foreach_element(&p->sections, e) {
+ s = uci_to_section(e);
+ if (section && (strcmp(s->type, section) != 0))
+ continue;
+
+ c++;
+ }
+ idx += c;
+ }
+
+ c = 0;
+ uci_foreach_element(&p->sections, e) {
+ s = uci_to_section(e);
+ if (section && (strcmp(s->type, section) != 0))
+ continue;
+
+ if (idx == c)
+ goto found;
+ c++;
+ }
+ goto notfound;
found:
+ if (option)
+ e = uci_lookup_list(&s->options, option);
+done:
*res = e;
return 0;
+
+notfound:
+ UCI_THROW(ctx, UCI_ERR_NOTFOUND);
+error:
+ UCI_THROW(ctx, UCI_ERR_INVAL);
+ return 0;
}
-int uci_unload(struct uci_context *ctx, const char *name)
+int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *p, const char *section, const char *option)
{
struct uci_element *e;
+ struct uci_section *s;
UCI_HANDLE_ERR(ctx);
- UCI_ASSERT(ctx, name != NULL);
+ UCI_ASSERT(ctx, res != NULL);
+ UCI_ASSERT(ctx, p != NULL);
+ UCI_ASSERT(ctx, section && uci_validate_name(section));
+ if (option)
+ UCI_ASSERT(ctx, uci_validate_name(option));
- uci_foreach_element(&ctx->root, e) {
- if (!strcmp(e->name, name))
- goto found;
+ e = uci_lookup_list(&p->sections, section);
+ if (!e)
+ goto notfound;
+
+ if (option) {
+ s = uci_to_section(e);
+ e = uci_lookup_list(&s->options, option);
+ if (!e)
+ goto notfound;
}
+
+ *res = e;
+ return 0;
+
+notfound:
UCI_THROW(ctx, UCI_ERR_NOTFOUND);
+ return 0;
+}
-found:
- uci_free_package(uci_to_package(e));
+int uci_del_element(struct uci_context *ctx, struct uci_element *e)
+{
+ /* NB: UCI_INTERNAL use means without history tracking */
+ bool internal = ctx->internal;
+ struct uci_package *p = NULL;
+ struct uci_section *s = NULL;
+ struct uci_option *o = NULL;
+ struct uci_element *i, *tmp;
+ char *option = NULL;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, e != NULL);
+
+ switch(e->type) {
+ case UCI_TYPE_SECTION:
+ s = uci_to_section(e);
+ uci_foreach_element_safe(&s->options, tmp, i) {
+ uci_del_element(ctx, i);
+ }
+ break;
+ case UCI_TYPE_OPTION:
+ o = uci_to_option(e);
+ s = o->section;
+ p = s->package;
+ option = e->name;
+ break;
+ default:
+ UCI_THROW(ctx, UCI_ERR_INVAL);
+ break;
+ }
+
+ p = s->package;
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_REMOVE, s->e.name, option, NULL);
+
+ switch(e->type) {
+ case UCI_TYPE_SECTION:
+ uci_free_section(s);
+ break;
+ case UCI_TYPE_OPTION:
+ uci_free_option(o);
+ break;
+ default:
+ break;
+ }
return 0;
}
+int uci_add_element_list(struct uci_context *ctx, struct uci_option *o, const char *value)
+{
+ struct uci_element *e;
+ struct uci_package *p;
+ struct uci_section *s;
+ bool internal = ctx->internal;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, (o != NULL) && (o->type == UCI_TYPE_LIST) && uci_validate_text(value));
+
+ s = o->section;
+ p = s->package;
+
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_LIST_ADD, s->e.name, o->e.name, value);
+
+ e = uci_alloc_generic(ctx, UCI_TYPE_ITEM, value, 0);
+ uci_list_add(&o->v.list, &e->list);
+
+ return 0;
+}
+
+int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, const char *value)
+{
+ /* NB: UCI_INTERNAL use means without history tracking */
+ bool internal = ctx->internal;
+ struct uci_list *list;
+ struct uci_element *e;
+ struct uci_package *p;
+ struct uci_section *s;
+ struct uci_option *o;
+ char *section;
+ char *option;
+ char *str;
+ int size = 0;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, (element != NULL) && (*element != NULL));
+
+ /* what the 'value' of an element means depends on the type
+ * for a section, the 'value' means its type
+ * for an option, the 'value' means its value string
+ * when changing the value, shrink the element to its actual size
+ * (it may have been allocated with a bigger size, to include
+ * its buffer)
+ * then duplicate the string passed on the command line and
+ * insert it into the structure.
+ */
+ e = *element;
+ list = e->list.prev;
+
+ switch(e->type) {
+ case UCI_TYPE_SECTION:
+ UCI_ASSERT(ctx, uci_validate_str(value, false));
+ size = sizeof(struct uci_section);
+ s = uci_to_section(e);
+ section = e->name;
+ option = NULL;
+ /* matches the currently set value */
+ if (!strcmp(value, s->type))
+ return 0;
+ break;
+
+ case UCI_TYPE_OPTION:
+ UCI_ASSERT(ctx, value != NULL);
+ o = uci_to_option(e);
+ s = o->section;
+ section = s->e.name;
+ option = o->e.name;
+ switch(o->type) {
+ case UCI_TYPE_STRING:
+ size = sizeof(struct uci_option);
+ /* matches the currently set value */
+ if (!strcmp(value, o->v.string))
+ return 0;
+ break;
+ default:
+ /* default action for non-string datatypes is to delete
+ * the existing entry, then re-create it as a string */
+ break;
+ }
+ break;
+
+ default:
+ UCI_THROW(ctx, UCI_ERR_INVAL);
+ return 0;
+ }
+ p = s->package;
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
+
+ if ((e->type == UCI_TYPE_OPTION) && (size == 0)) {
+ o = uci_alloc_option(s, option, value);
+ UCI_INTERNAL(uci_del_element, ctx, e);
+ *element = &o->e;
+ goto done;
+ }
+
+ uci_list_del(&e->list);
+ e = uci_realloc(ctx, e, size);
+ str = uci_strdup(ctx, value);
+ uci_list_insert(list, &e->list);
+ *element = e;
+
+ switch(e->type) {
+ case UCI_TYPE_SECTION:
+ uci_to_section(e)->type = str;
+ break;
+ case UCI_TYPE_OPTION:
+ uci_to_option(e)->v.string = str;
+ break;
+ default:
+ break;
+ }
+
+done:
+ return 0;
+}
+
+int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name)
+{
+ /* NB: UCI_INTERNAL use means without history tracking */
+ bool internal = ctx->internal;
+ struct uci_element *e;
+
+ UCI_HANDLE_ERR(ctx);
+
+ /* NB: p, section, option validated by uci_lookup */
+ UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
+
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_RENAME, section, option, name);
+
+ name = uci_strdup(ctx, name);
+ if (e->name)
+ free(e->name);
+ e->name = name;
+
+ return 0;
+}
+
+int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res)
+{
+ bool internal = ctx->internal;
+ struct uci_section *s;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, p != NULL);
+ s = uci_alloc_section(p, type, NULL);
+ uci_fixup_section(ctx, s);
+ *res = s;
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_ADD, s->e.name, NULL, type);
+
+ return 0;
+}
+
+int uci_delete(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option)
+{
+ /* NB: pass on internal flag to uci_del_element */
+ bool internal = ctx->internal;
+ struct uci_element *e;
+
+ UCI_HANDLE_ERR(ctx);
+
+ /* NB: p, section, option validated by uci_lookup */
+ UCI_INTERNAL(uci_lookup, ctx, &e, p, section, option);
+
+ ctx->internal = internal;
+ return uci_del_element(ctx, e);
+}
+
+int uci_add_list(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_option **result)
+{
+ /* NB: UCI_INTERNAL use means without history tracking */
+ bool internal = ctx->internal;
+ struct uci_element *e;
+ struct uci_section *s;
+ struct uci_option *o;
+ struct uci_option *prev = NULL;
+ const char *value2 = NULL;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, p && section && option && value && uci_validate_text(value));
+
+ /* look up the section first */
+ UCI_INTERNAL(uci_lookup, ctx, &e, p, section, NULL);
+ s = uci_to_section(e);
+
+ e = uci_lookup_list(&s->options, option);
+ if (e) {
+ o = uci_to_option(e);
+ switch (o->type) {
+ case UCI_TYPE_STRING:
+ /* we already have a string value, let's convert that to a list */
+ prev = o;
+ value2 = value;
+ value = o->v.string;
+ break;
+ case UCI_TYPE_LIST:
+ if (result)
+ *result = o;
+
+ ctx->internal = internal;
+ return uci_add_element_list(ctx, o, value);
+ default:
+ UCI_THROW(ctx, UCI_ERR_INVAL);
+ break;
+ }
+ }
+
+ o = uci_alloc_list(s, option);
+ if (result)
+ *result = o;
+ if (prev) {
+ UCI_INTERNAL(uci_add_element_list, ctx, o, value);
+ uci_free_option(prev);
+ value = value2;
+ }
+
+ ctx->internal = internal;
+ return uci_add_element_list(ctx, o, value);
+}
+
+int uci_set(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_element **result)
+{
+ /* NB: UCI_INTERNAL use means without history tracking */
+ bool internal = ctx->internal;
+ struct uci_element *e = NULL;
+ struct uci_section *s = NULL;
+ struct uci_option *o = NULL;
+
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, p != NULL);
+ UCI_ASSERT(ctx, uci_validate_name(section));
+ if (option) {
+ UCI_ASSERT(ctx, uci_validate_name(option));
+ UCI_ASSERT(ctx, value != NULL);
+ } else {
+ UCI_ASSERT(ctx, uci_validate_str(value, false));
+ }
+
+ /*
+ * look up the package, section and option (if set)
+ * if the section/option is to be modified and it is not found
+ * create a new element in the appropriate list
+ */
+ e = uci_lookup_list(&p->sections, section);
+ if (!e)
+ goto notfound;
+
+ s = uci_to_section(e);
+ if (ctx->pctx && ctx->pctx->merge)
+ ctx->pctx->section = s;
+
+ if (option) {
+ e = uci_lookup_list(&s->options, option);
+ if (!e)
+ goto notfound;
+ o = uci_to_option(e);
+ }
+
+ /*
+ * no unknown element was supplied, assume that we can just update
+ * an existing entry
+ */
+ if (o)
+ e = &o->e;
+ else
+ e = &s->e;
+ if (result)
+ *result = e;
+ else
+ result = &e;
+
+ ctx->internal = internal;
+ return uci_set_element_value(ctx, result, value);
+
+notfound:
+ /*
+ * the entry that we need to update was not found,
+ * check if the search failed prematurely.
+ * this can happen if the package was not found, or if
+ * an option was supplied, but the section wasn't found
+ */
+ if (!p || (!s && option))
+ UCI_THROW(ctx, UCI_ERR_NOTFOUND);
+
+ /* now add the missing entry */
+ if (!internal && p->has_history)
+ uci_add_history(ctx, &p->history, UCI_CMD_CHANGE, section, option, value);
+ if (s) {
+ o = uci_alloc_option(s, option, value);
+ if (result)
+ *result = &o->e;
+ } else {
+ s = uci_alloc_section(p, value, section);
+ if (result)
+ *result = &s->e;
+ if (ctx->pctx && ctx->pctx->merge)
+ ctx->pctx->section = s;
+ }
+
+ return 0;
+}
+
+int uci_unload(struct uci_context *ctx, struct uci_package *p)
+{
+ UCI_HANDLE_ERR(ctx);
+ UCI_ASSERT(ctx, p != NULL);
+
+ uci_free_package(&p);
+ return 0;
+}
projects / project / uci.git / blobdiff