#ifndef __LIBUCI_H
#define __LIBUCI_H
+#include "uci_config.h"
+
/*
* you can use these defines to enable debugging behavior for
* apps compiled against libuci:
*
*/
-#ifdef DEBUG_ALL
-#define UCI_DEBUG
-#define UCI_DEBUG_TYPECAST
-#endif
-
#include <stdbool.h>
#include <setjmp.h>
#include <stdio.h>
#define UCI_CONFDIR "/etc/config"
#define UCI_SAVEDIR "/tmp/.uci"
-#define UCI_FILEMODE 0600
+#define UCI_DIRMODE 0700
+#define UCI_FILEMODE 0600
enum
{
struct uci_list *prev;
};
+struct uci_ptr;
struct uci_element;
struct uci_package;
struct uci_section;
struct uci_option;
struct uci_history;
struct uci_context;
+struct uci_backend;
struct uci_parse_context;
/**
- * uci_parse_tuple: Parse an uci tuple
- * @ctx: uci context
- * @str: input string
- * @package: output package pointer
- * @section: output section pointer
- * @option: output option pointer
- * @value: output value pointer
- *
- * format: <package>[.<section>[.<option>]][=<value>]
- */
-extern int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value);
-
-/**
* uci_alloc_context: Allocate a new uci context
*/
extern struct uci_context *uci_alloc_context(void);
extern void uci_perror(struct uci_context *ctx, const char *str);
/**
+ * uci_geterror: Get an error string for the last uci error
+ * @ctx: uci context
+ * @dest: target pointer for the string
+ * @str: prefix for the error message
+ *
+ * Note: string must be freed by the caller
+ */
+extern void uci_get_errorstr(struct uci_context *ctx, char **dest, const char *str);
+
+/**
* uci_import: Import uci config data from a stream
* @ctx: uci context
* @stream: file stream to import from
extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
/**
- * uci_cleanup: Clean up after an error
- *
+ * uci_lookup_ptr: Split an uci tuple string and look up an element tree
* @ctx: uci context
- */
-extern int uci_cleanup(struct uci_context *ctx);
-
-/**
- * uci_lookup: Look up an uci element
+ * @ptr: lookup result struct
+ * @str: uci tuple string to look up
+ * @extended: allow extended syntax lookup
*
- * @ctx: uci context
- * @res: where to store the result
- * @package: uci_package struct
- * @section: config section (optional)
- * @option: option to search for (optional)
+ * if extended is set to true, uci_lookup_ptr supports the following
+ * extended syntax:
*
- * If section is omitted, then a pointer to the config package is returned
- * If option is omitted, then a pointer to the config section is returned
+ * Examples:
+ * network.@interface[0].ifname ('ifname' option of the first interface section)
+ * network.@interface[-1] (last interface section)
+ * Note: uci_lookup_ext will automatically load a config package if necessary
*/
-extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
+extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);
/**
- * uci_set_element_value: Replace an element's value with a new one
+ * uci_add_section: Add an unnamed section
* @ctx: uci context
- * @element: pointer to an uci_element struct pointer
- * @value: new value
- *
- * Only valid for uci_option and uci_section. Will replace the type string
- * when used with an uci_section
+ * @p: package to add the section to
+ * @type: section type
+ * @res: pointer to store a reference to the new section in
*/
-extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
+extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res);
/**
* uci_set: Set an element's value; create the element if necessary
* @ctx: uci context
- * @package: package name
- * @section: section name
- * @option: option name
- * @value: value (option) or type (section)
- * @result: store the updated element in this variable (optional)
+ * @ptr: uci pointer
+ *
+ * The updated/created element is stored in ptr->last
*/
-extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value, struct uci_element **result);
+extern int uci_set(struct uci_context *ctx, struct uci_ptr *ptr);
/**
- * uci_rename: Rename an element
+ * uci_add_list: Append a string to an element list
* @ctx: uci context
- * @package: package name
- * @section: section name
- * @option: option name
- * @name: new name
+ * @ptr: uci pointer (with value)
+ *
+ * Note: if the given option already contains a string value,
+ * it will be converted to an 1-element-list before appending the next element
*/
-extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
+extern int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr);
/**
- * uci_delete_element: Delete a section or option
+ * uci_rename: Rename an element
* @ctx: uci context
- * @e: element (section or option)
+ * @ptr: uci pointer (with value)
*/
-extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
+extern int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr);
/**
* uci_delete: Delete a section or option
* @ctx: uci context
- * @p: uci package
- * @section: section name
- * @option: option name (optional)
+ * @ptr: uci pointer
*/
-extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
+extern int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr);
/**
* uci_save: save change history for a package
/**
* uci_list_configs: List available uci config files
* @ctx: uci context
+ *
+ * caller is responsible for freeing the allocated memory behind list
*/
extern int uci_list_configs(struct uci_context *ctx, char ***list);
/**
* uci_revert: revert all changes to a config item
* @ctx: uci context
- * @p: pointer to a uci_package struct ptr (will be replaced by the revert)
- * @section: section name (optional)
- * @option option name (optional)
+ * @ptr: uci pointer
*/
-extern int uci_revert(struct uci_context *ctx, struct uci_package **p, char *section, char *option);
+extern int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr);
/**
* uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
*/
extern int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result);
+/**
+ * uci_set_backend: change the default backend
+ * @ctx: uci context
+ * @name: name of the backend
+ *
+ * The default backend is "file", which uses /etc/config for config storage
+ */
+extern int uci_set_backend(struct uci_context *ctx, const char *name);
+
+/**
+ * uci_validate_text: validate a value string for uci options
+ * @str: value
+ *
+ * this function checks whether a given string is acceptable as value
+ * for uci options
+ */
+extern bool uci_validate_text(const char *str);
+
/* UCI data structures */
enum uci_type {
- UCI_TYPE_HISTORY = 0,
- UCI_TYPE_PACKAGE = 1,
- UCI_TYPE_SECTION = 2,
- UCI_TYPE_OPTION = 3,
- UCI_TYPE_PATH = 4
+ UCI_TYPE_UNSPEC = 0,
+ UCI_TYPE_HISTORY = 1,
+ UCI_TYPE_PACKAGE = 2,
+ UCI_TYPE_SECTION = 3,
+ UCI_TYPE_OPTION = 4,
+ UCI_TYPE_PATH = 5,
+ UCI_TYPE_BACKEND = 6,
+ UCI_TYPE_ITEM = 7,
+};
+
+enum uci_option_type {
+ UCI_TYPE_STRING = 0,
+ UCI_TYPE_LIST = 1,
};
enum uci_flags {
char *name;
};
+struct uci_backend
+{
+ struct uci_element e;
+ char **(*list_configs)(struct uci_context *ctx);
+ struct uci_package *(*load)(struct uci_context *ctx, const char *name);
+ void (*commit)(struct uci_context *ctx, struct uci_package **p, bool overwrite);
+
+ /* private: */
+ const void *ptr;
+ void *priv;
+};
+
struct uci_context
{
/* list of config packages */
/* parser context, use for error handling only */
struct uci_parse_context *pctx;
+ /* backend for import and export */
+ struct uci_backend *backend;
+ struct uci_list backends;
+
/* uci runtime flags */
enum uci_flags flags;
struct uci_list history_path;
/* private: */
- int errno;
+ int err;
const char *func;
jmp_buf trap;
- bool internal;
+ bool internal, nested;
char *buf;
int bufsz;
};
struct uci_element e;
struct uci_list sections;
struct uci_context *ctx;
- bool confdir;
+ bool has_history;
char *path;
/* private: */
+ struct uci_backend *backend;
+ void *priv;
int n_section;
struct uci_list history;
struct uci_list saved_history;
{
struct uci_element e;
struct uci_section *section;
- char *value;
+ enum uci_option_type type;
+ union {
+ struct uci_list list;
+ char *string;
+ } v;
};
enum uci_command {
UCI_CMD_ADD,
UCI_CMD_REMOVE,
UCI_CMD_CHANGE,
- UCI_CMD_RENAME
+ UCI_CMD_RENAME,
+ UCI_CMD_LIST_ADD,
};
struct uci_history
char *value;
};
+struct uci_ptr
+{
+ enum uci_type target;
+ enum {
+ UCI_LOOKUP_DONE = (1 << 0),
+ UCI_LOOKUP_COMPLETE = (1 << 1),
+ UCI_LOOKUP_EXTENDED = (1 << 2),
+ } flags;
+
+ struct uci_package *p;
+ struct uci_section *s;
+ struct uci_option *o;
+ struct uci_element *last;
+
+ const char *package;
+ const char *section;
+ const char *option;
+ const char *value;
+};
+
+
/* linked list handling */
#ifndef offsetof
#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
* @_type: config, section or option
* @_ptr: pointer to the uci_list struct
*/
-#define element_to(type, ptr) \
- container_of(ptr, struct uci_ ## type, e)
-
#define list_to_element(ptr) \
container_of(ptr, struct uci_element, list)
#define uci_list_empty(list) ((list)->next == (list))
/* wrappers for dynamic type handling */
+#define uci_type_backend UCI_TYPE_BACKEND
#define uci_type_history UCI_TYPE_HISTORY
#define uci_type_package UCI_TYPE_PACKAGE
#define uci_type_section UCI_TYPE_SECTION
/* element typecasting */
#ifdef UCI_DEBUG_TYPECAST
static const char *uci_typestr[] = {
+ [uci_type_backend] = "backend",
[uci_type_history] = "history",
[uci_type_package] = "package",
[uci_type_section] = "section",
return (struct uci_ ## _type *) e; \
}
+BUILD_CAST(backend)
BUILD_CAST(history)
BUILD_CAST(package)
BUILD_CAST(section)
BUILD_CAST(option)
#else
+#define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
#define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
#define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
#define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
projects / project / uci.git / blobdiff