X-Git-Url: http://git.openwrt.org/?p=project%2Fuci.git;a=blobdiff_plain;f=uci.h;h=198ae2a5888a3da88cf69e72b19eb1a54df5cc77;hp=e921269872a114f43611907bbea44983aba0bb51;hb=3bff697cca125a6a4147e3bd1c469b36504e8237;hpb=333ef9e09be5ac9c191625cca4efcebdbfc22073 diff --git a/uci.h b/uci.h index e921269..198ae2a 100644 --- a/uci.h +++ b/uci.h @@ -2,9 +2,9 @@ * libuci - Library for the Unified Configuration Interface * Copyright (C) 2008 Felix Fietkau * - * 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 @@ -15,6 +15,8 @@ #ifndef __LIBUCI_H #define __LIBUCI_H +#include "uci_config.h" + /* * you can use these defines to enable debugging behavior for * apps compiled against libuci: @@ -24,18 +26,14 @@ * */ -#ifdef DEBUG_ALL -#define UCI_DEBUG -#define UCI_DEBUG_TYPECAST -#endif - #include #include #include #define UCI_CONFDIR "/etc/config" #define UCI_SAVEDIR "/tmp/.uci" -#define UCI_FILEMODE 0600 +#define UCI_DIRMODE 0700 +#define UCI_FILEMODE 0600 enum { @@ -63,6 +61,7 @@ struct uci_section; struct uci_option; struct uci_history; struct uci_context; +struct uci_backend; struct uci_parse_context; @@ -135,13 +134,6 @@ extern int uci_load(struct uci_context *ctx, const char *name, struct uci_packag */ extern int uci_unload(struct uci_context *ctx, struct uci_package *p); -/** - * uci_cleanup: Clean up after an error - * - * @ctx: uci context - */ -extern int uci_cleanup(struct uci_context *ctx); - /** * uci_lookup: Look up an uci element * @@ -154,7 +146,34 @@ extern int uci_cleanup(struct uci_context *ctx); * 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, struct uci_package *package, char *section, char *option); +extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, const char *section, const char *option); + +/** + * uci_lookup_ext: Extended lookup for an uci element + * + * @ctx: uci context + * @res: where to store the result + * @ptr: uci pointer tuple + * + * Looks up an element using the extended syntax, which is a superset of what + * uci_parse_tuple accepts. It can look up sections by an index with an optional + * type. + * + * 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_ext(struct uci_context *ctx, struct uci_element **res, char *ptr); + +/** + * 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, const char *type, struct uci_section **res); /** * uci_set_element_value: Replace an element's value with a new one @@ -165,7 +184,15 @@ extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct * Only valid for uci_option and uci_section. Will replace the type string * when used with an uci_section */ -extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value); +extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, const char *value); + +/** + * uci_add_element_list: Append a string to a list option + * @ctx: uci context + * @option: pointer to the uci option element + * @value: string to append + */ +extern int uci_add_element_list(struct uci_context *ctx, struct uci_option *o, const char *value); /** * uci_set: Set an element's value; create the element if necessary @@ -174,8 +201,23 @@ extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **e * @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); +extern int uci_set(struct uci_context *ctx, struct uci_package *p, const char *section, const char *option, const char *value, struct uci_element **result); + +/** + * uci_add_list: Append a string to an element list + * @ctx: uci context + * @package: package name + * @section: section name + * @option: option name + * @value: string value + * @result: store the updated element in this variable (optional) + * + * Note: if the given option already contains a string, convert it to an 1-element-list + * before appending the next element + */ +extern 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); /** * uci_rename: Rename an element @@ -201,7 +243,7 @@ extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e); * @section: section name * @option: option name (optional) */ -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_package *p, const char *section, const char *option); /** * uci_save: save change history for a package @@ -223,23 +265,93 @@ extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool over /** * 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 int uci_revert(struct uci_context *ctx, struct uci_package **p, const char *section, const 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_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_OPTION = 3, + UCI_TYPE_PATH = 4, + UCI_TYPE_BACKEND = 5, + UCI_TYPE_ITEM = 6, +}; + +enum uci_option_type { + UCI_TYPE_STRING = 0, + UCI_TYPE_LIST = 1, }; 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_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 @@ -249,6 +361,18 @@ 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 */ @@ -257,11 +381,21 @@ struct uci_context /* 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; + char *confdir; + char *savedir; + + /* search path for history files */ + struct uci_list history_path; + /* private: */ - int errno; + int err; const char *func; jmp_buf trap; bool internal; @@ -269,34 +403,20 @@ struct uci_context int bufsz; }; -struct uci_parse_context -{ - /* error context */ - const char *reason; - int line; - int byte; - - /* private: */ - struct uci_package *package; - struct uci_section *section; - bool merge; - FILE *file; - const char *name; - char *buf; - int bufsz; -}; - struct uci_package { 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_section @@ -312,14 +432,19 @@ struct uci_option { 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 @@ -330,6 +455,7 @@ struct uci_history char *value; }; + /* linked list handling */ #ifndef offsetof #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) @@ -350,9 +476,6 @@ struct uci_history * @_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) @@ -395,6 +518,7 @@ struct uci_history #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 @@ -403,6 +527,7 @@ struct uci_history /* 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", @@ -423,12 +548,14 @@ 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)