use the per-package backend on commit
[project/uci.git] / uci.h
1 /*
2  * libuci - Library for the Unified Configuration Interface
3  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
4  *
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
8  *
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.
13  */
14
15 #ifndef __LIBUCI_H
16 #define __LIBUCI_H
17
18 /*
19  * you can use these defines to enable debugging behavior for
20  * apps compiled against libuci:
21  *
22  * #define UCI_DEBUG_TYPECAST:
23  *   enable uci_element typecast checking at run time
24  *
25  */
26
27 #ifdef DEBUG_ALL
28 #define UCI_DEBUG
29 #define UCI_DEBUG_TYPECAST
30 #endif
31
32 #include <stdbool.h>
33 #include <setjmp.h>
34 #include <stdio.h>
35
36 #define UCI_CONFDIR "/etc/config"
37 #define UCI_SAVEDIR "/tmp/.uci"
38 #define UCI_FILEMODE    0600
39
40 enum
41 {
42         UCI_OK = 0,
43         UCI_ERR_MEM,
44         UCI_ERR_INVAL,
45         UCI_ERR_NOTFOUND,
46         UCI_ERR_IO,
47         UCI_ERR_PARSE,
48         UCI_ERR_DUPLICATE,
49         UCI_ERR_UNKNOWN,
50         UCI_ERR_LAST
51 };
52
53 struct uci_list;
54 struct uci_list
55 {
56         struct uci_list *next;
57         struct uci_list *prev;
58 };
59
60 struct uci_element;
61 struct uci_package;
62 struct uci_section;
63 struct uci_option;
64 struct uci_history;
65 struct uci_context;
66 struct uci_backend;
67 struct uci_parse_context;
68
69
70 /**
71  * uci_parse_tuple: Parse an uci tuple
72  * @ctx: uci context
73  * @str: input string
74  * @package: output package pointer
75  * @section: output section pointer
76  * @option: output option pointer
77  * @value: output value pointer
78  *
79  * format: <package>[.<section>[.<option>]][=<value>]
80  */
81 extern int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value);
82
83 /**
84  * uci_alloc_context: Allocate a new uci context
85  */
86 extern struct uci_context *uci_alloc_context(void);
87
88 /**
89  * uci_free_context: Free the uci context including all of its data
90  */
91 extern void uci_free_context(struct uci_context *ctx);
92
93 /**
94  * uci_perror: Print the last uci error that occured
95  * @ctx: uci context
96  * @str: string to print before the error message
97  */
98 extern void uci_perror(struct uci_context *ctx, const char *str);
99
100 /**
101  * uci_import: Import uci config data from a stream
102  * @ctx: uci context
103  * @stream: file stream to import from
104  * @name: (optional) assume the config has the given name
105  * @package: (optional) store the last parsed config package in this variable
106  * @single: ignore the 'package' keyword and parse everything into a single package
107  *
108  * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
109  * if 'package' points to a non-null struct pointer, enable history tracking and merge 
110  */
111 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
112
113 /**
114  * uci_export: Export one or all uci config packages
115  * @ctx: uci context
116  * @stream: output stream
117  * @package: (optional) uci config package to export
118  * @header: include the package header
119  */
120 extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
121
122 /**
123  * uci_load: Parse an uci config file and store it in the uci context
124  *
125  * @ctx: uci context
126  * @name: name of the config file (relative to the config directory)
127  * @package: store the loaded config package in this variable
128  */
129 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package);
130
131 /**
132  * uci_unload: Unload a config file from the uci context
133  *
134  * @ctx: uci context
135  * @package: pointer to the uci_package struct
136  */
137 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
138
139 /**
140  * uci_lookup: Look up an uci element
141  *
142  * @ctx: uci context
143  * @res: where to store the result
144  * @package: uci_package struct 
145  * @section: config section (optional)
146  * @option: option to search for (optional)
147  *
148  * If section is omitted, then a pointer to the config package is returned
149  * If option is omitted, then a pointer to the config section is returned
150  */
151 extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
152
153 /**
154  * uci_add_section: Add an unnamed section
155  * @ctx: uci context
156  * @p: package to add the section to
157  * @type: section type
158  * @res: pointer to store a reference to the new section in
159  */
160 extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, char *type, struct uci_section **res);
161
162 /**
163  * uci_set_element_value: Replace an element's value with a new one
164  * @ctx: uci context
165  * @element: pointer to an uci_element struct pointer
166  * @value: new value
167  * 
168  * Only valid for uci_option and uci_section. Will replace the type string
169  * when used with an uci_section
170  */
171 extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
172
173 /**
174  * uci_set: Set an element's value; create the element if necessary
175  * @ctx: uci context
176  * @package: package name
177  * @section: section name
178  * @option: option name
179  * @value: value (option) or type (section)
180  * @result: store the updated element in this variable (optional)
181  */
182 extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value, struct uci_element **result);
183
184 /**
185  * uci_rename: Rename an element
186  * @ctx: uci context
187  * @package: package name
188  * @section: section name
189  * @option: option name
190  * @name: new name
191  */
192 extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
193
194 /**
195  * uci_delete_element: Delete a section or option
196  * @ctx: uci context
197  * @e: element (section or option)
198  */
199 extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
200
201 /**
202  * uci_delete: Delete a section or option
203  * @ctx: uci context
204  * @p: uci package
205  * @section: section name
206  * @option: option name (optional)
207  */
208 extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
209
210 /**
211  * uci_save: save change history for a package
212  * @ctx: uci context
213  * @p: uci_package struct
214  */
215 extern int uci_save(struct uci_context *ctx, struct uci_package *p);
216
217 /**
218  * uci_commit: commit changes to a package
219  * @ctx: uci context
220  * @p: uci_package struct pointer
221  * @overwrite: overwrite existing config data and flush history
222  *
223  * committing may reload the whole uci_package data,
224  * the supplied pointer is updated accordingly
225  */
226 extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool overwrite);
227
228 /**
229  * uci_list_configs: List available uci config files
230  * @ctx: uci context
231  *
232  * caller is responsible for freeing the allocated memory behind list
233  */
234 extern int uci_list_configs(struct uci_context *ctx, char ***list);
235
236 /** 
237  * uci_set_savedir: override the default history save directory
238  * @ctx: uci context
239  * @dir: directory name
240  */
241 extern int uci_set_savedir(struct uci_context *ctx, const char *dir);
242
243 /** 
244  * uci_set_savedir: override the default config storage directory
245  * @ctx: uci context
246  * @dir: directory name
247  */
248 extern int uci_set_confdir(struct uci_context *ctx, const char *dir);
249
250 /**
251  * uci_add_history_path: add a directory to the search path for change history files
252  * @ctx: uci context
253  * @dir: directory name
254  *
255  * This function allows you to add directories, which contain 'overlays'
256  * for the active config, that will never be committed.
257  */
258 extern int uci_add_history_path(struct uci_context *ctx, const char *dir);
259
260 /**
261  * uci_revert: revert all changes to a config item
262  * @ctx: uci context
263  * @p: pointer to a uci_package struct ptr (will be replaced by the revert)
264  * @section: section name (optional)
265  * @option option name (optional)
266  */
267 extern int uci_revert(struct uci_context *ctx, struct uci_package **p, char *section, char *option);
268
269 /**
270  * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
271  * @ctx: uci context
272  * @stream: input stream
273  * @str: pointer to the current line (use NULL for parsing the next line)
274  * @result: pointer for the result
275  */
276 extern int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result);
277
278 /* UCI data structures */
279 enum uci_type {
280         UCI_TYPE_HISTORY = 0,
281         UCI_TYPE_PACKAGE = 1,
282         UCI_TYPE_SECTION = 2,
283         UCI_TYPE_OPTION = 3,
284         UCI_TYPE_PATH = 4,
285         UCI_TYPE_BACKEND = 5,
286 };
287
288 enum uci_flags {
289         UCI_FLAG_STRICT =        (1 << 0), /* strict mode for the parser */
290         UCI_FLAG_PERROR =        (1 << 1), /* print parser error messages */
291         UCI_FLAG_EXPORT_NAME =   (1 << 2), /* when exporting, name unnamed sections */
292         UCI_FLAG_SAVED_HISTORY = (1 << 3), /* store the saved history in memory as well */
293 };
294
295 struct uci_element
296 {
297         struct uci_list list;
298         enum uci_type type;
299         char *name;
300 };
301
302 struct uci_backend
303 {
304         struct uci_element e;
305         char **(*list_configs)(struct uci_context *ctx);
306         struct uci_package *(*load)(struct uci_context *ctx, const char *name);
307         void (*commit)(struct uci_context *ctx, struct uci_package **p, bool overwrite);
308 };
309
310 struct uci_context
311 {
312         /* list of config packages */
313         struct uci_list root;
314
315         /* parser context, use for error handling only */
316         struct uci_parse_context *pctx;
317
318         /* backend for import and export */
319         struct uci_backend *backend;
320         struct uci_list backends;
321
322         /* uci runtime flags */
323         enum uci_flags flags;
324
325         char *confdir;
326         char *savedir;
327
328         /* search path for history files */
329         struct uci_list history_path;
330
331         /* private: */
332         int errno;
333         const char *func;
334         jmp_buf trap;
335         bool internal;
336         char *buf;
337         int bufsz;
338 };
339
340 struct uci_package
341 {
342         struct uci_element e;
343         struct uci_list sections;
344         struct uci_context *ctx;
345         bool has_history;
346         char *path;
347
348         /* private: */
349         struct uci_backend *backend;
350         void *priv;
351         int n_section;
352         struct uci_list history;
353         struct uci_list saved_history;
354 };
355
356 struct uci_section
357 {
358         struct uci_element e;
359         struct uci_list options;
360         struct uci_package *package;
361         bool anonymous;
362         char *type;
363 };
364
365 struct uci_option
366 {
367         struct uci_element e;
368         struct uci_section *section;
369         char *value;
370 };
371
372 enum uci_command {
373         UCI_CMD_ADD,
374         UCI_CMD_REMOVE,
375         UCI_CMD_CHANGE,
376         UCI_CMD_RENAME
377 };
378
379 struct uci_history
380 {
381         struct uci_element e;
382         enum uci_command cmd;
383         char *section;
384         char *value;
385 };
386
387 #define UCI_BACKEND(_var, _name, ...)   \
388 struct uci_backend _var = {             \
389         .e.list = {                     \
390                 .next = &_var.e.list,   \
391                 .prev = &_var.e.list,   \
392         },                              \
393         .e.name = _name,                \
394         .e.type = UCI_TYPE_BACKEND,     \
395         __VA_ARGS__                     \
396 }
397
398
399 /* linked list handling */
400 #ifndef offsetof
401 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
402 #endif
403
404 /**
405  * container_of - cast a member of a structure out to the containing structure
406  * @ptr:    the pointer to the member.
407  * @type:   the type of the container struct this is embedded in.
408  * @member: the name of the member within the struct.
409  */
410 #define container_of(ptr, type, member) \
411         ((type *) ((char *)ptr - offsetof(type,member)))
412
413
414 /**
415  * uci_list_entry: casts an uci_list pointer to the containing struct.
416  * @_type: config, section or option
417  * @_ptr: pointer to the uci_list struct
418  */
419 #define list_to_element(ptr) \
420         container_of(ptr, struct uci_element, list)
421
422 /**
423  * uci_foreach_entry: loop through a list of uci elements
424  * @_list: pointer to the uci_list struct
425  * @_ptr: iteration variable, struct uci_element
426  *
427  * use like a for loop, e.g:
428  *   uci_foreach(&list, p) {
429  *      ...
430  *   }
431  */
432 #define uci_foreach_element(_list, _ptr)                \
433         for(_ptr = list_to_element((_list)->next);      \
434                 &_ptr->list != (_list);                 \
435                 _ptr = list_to_element(_ptr->list.next))
436
437 /**
438  * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion
439  * @_list: pointer to the uci_list struct
440  * @_tmp: temporary variable, struct uci_element *
441  * @_ptr: iteration variable, struct uci_element *
442  *
443  * use like a for loop, e.g:
444  *   uci_foreach(&list, p) {
445  *      ...
446  *   }
447  */
448 #define uci_foreach_element_safe(_list, _tmp, _ptr)             \
449         for(_ptr = list_to_element((_list)->next),              \
450                 _tmp = list_to_element(_ptr->list.next);        \
451                 &_ptr->list != (_list);                 \
452                 _ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
453
454 /**
455  * uci_list_empty: returns true if a list is empty
456  * @list: list head
457  */
458 #define uci_list_empty(list) ((list)->next == (list))
459
460 /* wrappers for dynamic type handling */
461 #define uci_type_backend UCI_TYPE_BACKEND
462 #define uci_type_history UCI_TYPE_HISTORY
463 #define uci_type_package UCI_TYPE_PACKAGE
464 #define uci_type_section UCI_TYPE_SECTION
465 #define uci_type_option UCI_TYPE_OPTION
466
467 /* element typecasting */
468 #ifdef UCI_DEBUG_TYPECAST
469 static const char *uci_typestr[] = {
470         [uci_type_backend] = "backend",
471         [uci_type_history] = "history",
472         [uci_type_package] = "package",
473         [uci_type_section] = "section",
474         [uci_type_option] = "option",
475 };
476
477 static void uci_typecast_error(int from, int to)
478 {
479         fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]);
480 }
481
482 #define BUILD_CAST(_type) \
483         static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
484         { \
485                 if (e->type != uci_type_ ## _type) { \
486                         uci_typecast_error(e->type, uci_type_ ## _type); \
487                 } \
488                 return (struct uci_ ## _type *) e; \
489         }
490
491 BUILD_CAST(backend)
492 BUILD_CAST(history)
493 BUILD_CAST(package)
494 BUILD_CAST(section)
495 BUILD_CAST(option)
496
497 #else
498 #define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
499 #define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
500 #define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
501 #define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
502 #define uci_to_option(ptr)  container_of(ptr, struct uci_option, e)
503 #endif
504
505 /**
506  * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast
507  * @ctx: uci context
508  * @type: {package,section,option}
509  * @name: string containing the name of the element
510  * @datasize: additional buffer size to reserve at the end of the struct
511  */
512 #define uci_alloc_element(ctx, type, name, datasize) \
513         uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
514
515 #define uci_dataptr(ptr) \
516         (((char *) ptr) + sizeof(*ptr))
517
518 #endif