* 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
#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_DIRMODE 0700
+#define UCI_FILEMODE 0600
enum
{
UCI_ERR_NOTFOUND,
UCI_ERR_IO,
UCI_ERR_PARSE,
+ UCI_ERR_DUPLICATE,
UCI_ERR_UNKNOWN,
UCI_ERR_LAST
};
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);
* @stream: file stream to import from
* @name: (optional) assume the config has the given name
* @package: (optional) store the last parsed config package in this variable
+ * @single: ignore the 'package' keyword and parse everything into a single package
*
* the name parameter is for config files that don't explicitly use the 'package <...>' keyword
+ * if 'package' points to a non-null struct pointer, enable history tracking and merge
*/
-extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package);
+extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
/**
* uci_export: Export one or all uci config packages
* @ctx: uci context
* @stream: output stream
* @package: (optional) uci config package to export
+ * @header: include the package header
*/
-extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package);
+extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
/**
* uci_load: Parse an uci config file and store it in the uci context
* uci_unload: Unload a config file from the uci context
*
* @ctx: uci context
- * @name: name of the config file
+ * @package: pointer to the uci_package struct
*/
-extern int uci_unload(struct uci_context *ctx, const char *name);
-
-/**
- * uci_cleanup: Clean up after an error
- *
- * @ctx: uci context
- */
-extern int uci_cleanup(struct uci_context *ctx);
+extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
/**
* uci_lookup: Look up an uci element
*
* @ctx: uci context
* @res: where to store the result
- * @package: config package
+ * @package: uci_package struct
* @section: config section (optional)
* @option: option to search for (optional)
*
* 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
*/
-extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, char *package, char *section, char *option);
+extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
+
+/**
+ * uci_add_section: Add an unnamed section
+ * @ctx: uci context
+ * @p: package to add the section to
+ * @type: section type
+ * @res: pointer to store a reference to the new section in
+ */
+extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, char *type, struct uci_section **res);
/**
* uci_set_element_value: Replace an element's value with a new one
* @section: section name
* @option: option name
* @value: value (option) or type (section)
+ * @result: store the updated element in this variable (optional)
+ */
+extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value, struct uci_element **result);
+
+/**
+ * uci_rename: Rename an element
+ * @ctx: uci context
+ * @package: package name
+ * @section: section name
+ * @option: option name
+ * @name: new name
+ */
+extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
+
+/**
+ * uci_delete_element: Delete a section or option
+ * @ctx: uci context
+ * @e: element (section or option)
+ */
+extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
+
+/**
+ * uci_delete: Delete a section or option
+ * @ctx: uci context
+ * @p: uci package
+ * @section: section name
+ * @option: option name (optional)
*/
-extern int uci_set(struct uci_context *ctx, char *package, char *section, char *option, char *value);
+extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
+
+/**
+ * uci_save: save change history for a package
+ * @ctx: uci context
+ * @p: uci_package struct
+ */
+extern int uci_save(struct uci_context *ctx, struct uci_package *p);
+
+/**
+ * uci_commit: commit changes to a package
+ * @ctx: uci context
+ * @p: uci_package struct pointer
+ * @overwrite: overwrite existing config data and flush history
+ *
+ * committing may reload the whole uci_package data,
+ * the supplied pointer is updated accordingly
+ */
+extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool overwrite);
/**
* 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_set_savedir: override the default history save directory
+ * @ctx: uci context
+ * @dir: directory name
+ */
+extern int uci_set_savedir(struct uci_context *ctx, const char *dir);
+
+/**
+ * uci_set_savedir: override the default config storage directory
+ * @ctx: uci context
+ * @dir: directory name
+ */
+extern int uci_set_confdir(struct uci_context *ctx, const char *dir);
+
+/**
+ * uci_add_history_path: add a directory to the search path for change history files
+ * @ctx: uci context
+ * @dir: directory name
*
+ * This function allows you to add directories, which contain 'overlays'
+ * for the active config, that will never be committed.
+ */
+extern int uci_add_history_path(struct uci_context *ctx, const char *dir);
+
+/**
+ * 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)
*/
-extern char **uci_list_configs(struct uci_context *ctx);
+extern int uci_revert(struct uci_context *ctx, struct uci_package **p, char *section, char *option);
+
+/**
+ * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
+ * @ctx: uci context
+ * @stream: input stream
+ * @str: pointer to the current line (use NULL for parsing the next line)
+ * @result: pointer for the result
+ */
+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 data structures */
enum uci_type {
- UCI_TYPE_PACKAGE = 0,
- UCI_TYPE_SECTION = 1,
- UCI_TYPE_OPTION = 2
+ UCI_TYPE_HISTORY = 0,
+ UCI_TYPE_PACKAGE = 1,
+ UCI_TYPE_SECTION = 2,
+ UCI_TYPE_OPTION = 3,
+ UCI_TYPE_PATH = 4,
+ UCI_TYPE_BACKEND = 5,
+};
+
+enum uci_flags {
+ UCI_FLAG_STRICT = (1 << 0), /* strict mode for the parser */
+ UCI_FLAG_PERROR = (1 << 1), /* print parser error messages */
+ UCI_FLAG_EXPORT_NAME = (1 << 2), /* when exporting, name unnamed sections */
+ UCI_FLAG_SAVED_HISTORY = (1 << 3), /* store the saved history in memory as well */
};
struct uci_element
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;
- /* private: */
- int errno;
- const char *func;
- jmp_buf trap;
- char *buf;
- int bufsz;
-};
+ /* backend for import and export */
+ struct uci_backend *backend;
+ struct uci_list backends;
-struct uci_parse_context
-{
- /* error context */
- const char *reason;
- int line;
- int byte;
+ /* uci runtime flags */
+ enum uci_flags flags;
+
+ char *confdir;
+ char *savedir;
+
+ /* search path for history files */
+ struct uci_list history_path;
/* private: */
- struct uci_package *package;
- struct uci_section *section;
- FILE *file;
- const char *name;
+ int err;
+ const char *func;
+ jmp_buf trap;
+ bool internal;
char *buf;
int bufsz;
};
struct uci_element e;
struct uci_list sections;
struct uci_context *ctx;
+ 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_section
struct uci_element e;
struct uci_list options;
struct uci_package *package;
+ bool anonymous;
char *type;
};
enum uci_command {
UCI_CMD_ADD,
UCI_CMD_REMOVE,
- UCI_CMD_CHANGE
+ UCI_CMD_CHANGE,
+ UCI_CMD_RENAME
};
struct uci_history
{
- struct uci_list list;
+ struct uci_element e;
enum uci_command cmd;
char *section;
- char *option;
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
#define uci_type_option UCI_TYPE_OPTION
/* 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",
- [uci_type_option] = "option"
+ [uci_type_option] = "option",
};
static void uci_typecast_error(int from, int to)
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)
#define uci_to_option(ptr) container_of(ptr, struct uci_option, e)
projects / project / uci.git / blobdiff