Merge the adaptive realtime branch, which will make adding new required fields
[asterisk/asterisk.git] / include / asterisk / config.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Configuration File Parser
21  */
22
23 #ifndef _ASTERISK_CONFIG_H
24 #define _ASTERISK_CONFIG_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 #include "asterisk/utils.h"
31
32 struct ast_config;
33
34 struct ast_category;
35
36 /*! Options for ast_config_load()
37  */
38 enum {
39         /*! Load the configuration, including comments */
40         CONFIG_FLAG_WITHCOMMENTS  = (1 << 0),
41         /*! On a reload, give us a -1 if the file hasn't changed. */
42         CONFIG_FLAG_FILEUNCHANGED = (1 << 1),
43         /*! Don't attempt to cache mtime on this config file. */
44         CONFIG_FLAG_NOCACHE       = (1 << 2),
45 };
46
47 #define CONFIG_STATUS_FILEUNCHANGED     (void *)-1
48
49 /*!
50  * \brief Types used in ast_realtime_require_field
51  */
52 typedef enum {
53         RQ_INTEGER,
54         RQ_CHAR,
55         RQ_FLOAT,
56         RQ_DATE,
57         RQ_DATETIME,
58 } require_type;
59
60 /*! \brief Structure for variables, used for configurations and for channel variables 
61 */
62 struct ast_variable {
63         const char *name;
64         const char *value;
65         struct ast_variable *next;
66
67         char *file;
68
69         int lineno;
70         int object;             /*!< 0 for variable, 1 for object */
71         int blanklines;         /*!< Number of blanklines following entry */
72         struct ast_comment *precomments;
73         struct ast_comment *sameline;
74         struct ast_comment *trailing; /*!< the last object in the list will get assigned any trailing comments when EOF is hit */
75         char stuff[0];
76 };
77
78 typedef struct ast_config *config_load_func(const char *database, const char *table, const char *configfile, struct ast_config *config, struct ast_flags flags, const char *suggested_include_file, const char *who_asked);
79 typedef struct ast_variable *realtime_var_get(const char *database, const char *table, va_list ap);
80 typedef struct ast_config *realtime_multi_get(const char *database, const char *table, va_list ap);
81 typedef int realtime_update(const char *database, const char *table, const char *keyfield, const char *entity, va_list ap);
82 typedef int realtime_store(const char *database, const char *table, va_list ap);
83 typedef int realtime_destroy(const char *database, const char *table, const char *keyfield, const char *entity, va_list ap);
84 typedef int realtime_require(const char *database, const char *table, va_list ap);
85 typedef int realtime_unload(const char *database, const char *table);
86
87 /*! \brief Configuration engine structure, used to define realtime drivers */
88 struct ast_config_engine {
89         char *name;
90         config_load_func *load_func;
91         realtime_var_get *realtime_func;
92         realtime_multi_get *realtime_multi_func;
93         realtime_update *update_func;
94         realtime_store *store_func;
95         realtime_destroy *destroy_func;
96         realtime_require *require_func;
97         realtime_unload *unload_func;
98         struct ast_config_engine *next;
99 };
100
101 /*! \brief Load a config file 
102  * \param filename path of file to open.  If no preceding '/' character, path is considered relative to AST_CONFIG_DIR
103  * Create a config structure from a given configuration file.
104  * \param who_asked The module which is making this request.
105  * \param flags Optional flags:
106  * CONFIG_FLAG_WITHCOMMENTS - load the file with comments intact;
107  * CONFIG_FLAG_FILEUNCHANGED - check the file mtime and return CONFIG_STATUS_FILEUNCHANGED if the mtime is the same; or
108  * CONFIG_FLAG_NOCACHE - don't cache file mtime (main purpose of this option is to save memory on temporary files).
109  *
110  * \retval an ast_config data structure on success
111  * \retval NULL on error
112  */
113 struct ast_config *ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags);
114
115 #define ast_config_load(filename, flags)        ast_config_load2(filename, AST_MODULE, flags)
116
117 /*! \brief Destroys a config 
118  * \param config pointer to config data structure
119  * Free memory associated with a given config
120  *
121  */
122 void ast_config_destroy(struct ast_config *config);
123
124 /*! \brief returns the root ast_variable of a config
125  * \param config pointer to an ast_config data structure
126  * \param cat name of the category for which you want the root
127  *
128  * Returns the category specified
129  */
130 struct ast_variable *ast_category_root(struct ast_config *config, char *cat);
131
132 /*! \brief Goes through categories 
133  * \param config Which config structure you wish to "browse"
134  * \param prev A pointer to a previous category.
135  * This function is kind of non-intuitive in it's use.  To begin, one passes NULL as the second argument.  It will return a pointer to the string of the first category in the file.  From here on after, one must then pass the previous usage's return value as the second pointer, and it will return a pointer to the category name afterwards.
136  *
137  * \retval a category on success
138  * \retval NULL on failure/no-more-categories
139  */
140 char *ast_category_browse(struct ast_config *config, const char *prev);
141
142 /*! 
143  * \brief Goes through variables
144  * Somewhat similar in intent as the ast_category_browse.
145  * List variables of config file category
146  *
147  * \retval ast_variable list on success
148  * \retval NULL on failure
149  */
150 struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category);
151
152 /*!
153  * \brief given a pointer to a category, return the root variable.
154  * This is equivalent to ast_variable_browse(), but more efficient if we
155  * already have the struct ast_category * (e.g. from ast_category_get())
156  */
157 struct ast_variable *ast_category_first(struct ast_category *cat);
158
159 /*! 
160  * \brief Gets a variable 
161  * \param config which (opened) config to use
162  * \param category category under which the variable lies
163  * \param variable which variable you wish to get the data for
164  * Goes through a given config file in the given category and searches for the given variable
165  *
166  * \retval The variable value on success 
167  * \retval NULL if unable to find it.
168  */
169 const char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable);
170
171 /*! 
172  * \brief Retrieve a category if it exists
173  * \param config which config to use
174  * \param category_name name of the category you're looking for
175  * This will search through the categories within a given config file for a match.
176  *
177  * \retval pointer to category if found
178  * \retval NULL if not.
179  */
180 struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name);
181
182 /*! 
183  * \brief Check for category duplicates 
184  * \param config which config to use
185  * \param category_name name of the category you're looking for
186  * This will search through the categories within a given config file for a match.
187  *
188  * \return non-zero if found
189  */
190 int ast_category_exist(const struct ast_config *config, const char *category_name);
191
192 /*! 
193  * \brief Retrieve realtime configuration 
194  * \param family which family/config to lookup
195  * This will use builtin configuration backends to look up a particular 
196  * entity in realtime and return a variable list of its parameters.  Note
197  * that unlike the variables in ast_config, the resulting list of variables
198  * MUST be freed with ast_variables_destroy() as there is no container.
199  */
200 struct ast_variable *ast_load_realtime(const char *family, ...) attribute_sentinel;
201 struct ast_variable *ast_load_realtime_all(const char *family, ...) attribute_sentinel;
202
203 /*!
204  * \brief Release any resources cached for a realtime family
205  * \param family which family/config to destroy
206  * Various backends may cache attributes about a realtime data storage
207  * facility; on reload, a front end resource may request to purge that cache.
208  */
209 int ast_unload_realtime(const char *family);
210
211 /*!
212  * \brief Inform realtime what fields that may be stored
213  * \param family which family/config is referenced
214  * This will inform builtin configuration backends that particular fields
215  * may be updated during the use of that configuration section.  This is
216  * mainly to be used during startup routines, to ensure that various fields
217  * exist in the backend.  The backends may take various actions, such as
218  * creating new fields in the data store or warning the administrator that
219  * new fields may need to be created, in order to ensure proper function.
220  */
221 int ast_require_realtime_fields(const char *family, ...) attribute_sentinel;
222
223 /*! 
224  * \brief Retrieve realtime configuration 
225  * \param family which family/config to lookup
226  * This will use builtin configuration backends to look up a particular 
227  * entity in realtime and return a variable list of its parameters. Unlike
228  * the ast_load_realtime, this function can return more than one entry and
229  * is thus stored inside a taditional ast_config structure rather than 
230  * just returning a linked list of variables.
231  */
232 struct ast_config *ast_load_realtime_multientry(const char *family, ...) attribute_sentinel;
233
234 /*! 
235  * \brief Update realtime configuration 
236  * \param family which family/config to be updated
237  * \param keyfield which field to use as the key
238  * \param lookup which value to look for in the key field to match the entry.
239  * This function is used to update a parameter in realtime configuration space.
240  *
241  */
242 int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
243
244 /*! 
245  * \brief Create realtime configuration 
246  * \param family which family/config to be created
247  * This function is used to create a parameter in realtime configuration space.
248  *
249  */
250 int ast_store_realtime(const char *family, ...) attribute_sentinel;
251
252 /*! 
253  * \brief Destroy realtime configuration 
254  * \param family which family/config to be destroyed
255  * \param keyfield which field to use as the key
256  * \param lookup which value to look for in the key field to match the entry.
257  * This function is used to destroy an entry in realtime configuration space.
258  * Additional params are used as keys.
259  *
260  */
261 int ast_destroy_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
262
263 /*! 
264  * \brief Check if realtime engine is configured for family 
265  * \param family which family/config to be checked
266  * \return 1 if family is configured in realtime and engine exists
267 */
268 int ast_check_realtime(const char *family);
269
270 int ast_realtime_require_field(const char *family, ...) attribute_sentinel;
271
272 /*! \brief Check if there's any realtime engines loaded */
273 int ast_realtime_enabled(void);
274
275 /*! \brief Free variable list 
276  * \param var the linked list of variables to free
277  * This function frees a list of variables.
278  */
279 void ast_variables_destroy(struct ast_variable *var);
280
281 /*! \brief Register config engine */
282 int ast_config_engine_register(struct ast_config_engine *newconfig);
283
284 /*! \brief Deegister config engine */
285 int ast_config_engine_deregister(struct ast_config_engine *del);
286
287 int register_config_cli(void);
288 int read_config_maps(void);
289
290 struct ast_config *ast_config_new(void);
291 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg);
292 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat);
293 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var);
294
295 struct ast_category *ast_category_new(const char *name, const char *in_file, int lineno);
296 void ast_category_append(struct ast_config *config, struct ast_category *cat);
297
298 /*! 
299  * \brief Inserts new category
300  * \param config which config to use
301  * \param cat newly created category to insert
302  * \param match which category to insert above
303  * This function is used to insert a new category above another category
304  * matching the match parameter.
305  */
306 void ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match);
307 int ast_category_delete(struct ast_config *cfg, const char *category);
308 int ast_category_empty(struct ast_config *cfg, const char *category);
309 void ast_category_destroy(struct ast_category *cat);
310 struct ast_variable *ast_category_detach_variables(struct ast_category *cat);
311 void ast_category_rename(struct ast_category *cat, const char *name);
312
313 struct ast_variable *ast_variable_new(const char *name, const char *value, const char *filename);
314 struct ast_config_include *ast_include_new(struct ast_config *conf, const char *from_file, const char *included_file, int is_exec, const char *exec_file, int from_lineno, char *real_included_file_name, int real_included_file_name_size);
315 struct ast_config_include *ast_include_find(struct ast_config *conf, const char *included_file);
316 void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file);
317 void ast_variable_append(struct ast_category *category, struct ast_variable *variable);
318 void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line);
319 int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line);
320 int ast_variable_update(struct ast_category *category, const char *variable, 
321                                                 const char *value, const char *match, unsigned int object);
322
323 int config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator);
324
325 struct ast_config *ast_config_internal_load(const char *configfile, struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl_file, const char *who_asked);
326
327 /*! \brief Support code to parse config file arguments
328  *
329  * The function ast_parse_arg() provides a generic interface to parse
330  * strings (e.g. numbers, network addresses and so on) in a flexible
331  * way, e.g. by doing proper error and bound checks, provide default
332  * values, and so on.
333  * The function (described later) takes a string as an argument,
334  * a set of flags to specify the result format and checks to perform,
335  * a pointer to the result, and optionally some additional arguments.
336  * It returns 0 on success, != 0 otherwise.
337  *
338  */
339 enum ast_parse_flags {
340         /* low 4 bits of flags are used for the operand type */
341         PARSE_TYPE      =       0x000f,
342         /* numeric types, with optional default value and bound checks.
343          * Additional arguments are passed by value.
344          */
345         PARSE_INT32     =       0x0001,
346         PARSE_UINT32    =       0x0002,
347         PARSE_DOUBLE    =       0x0003,
348 #if 0   /* not supported yet */
349         PARSE_INT16     =       0x0004,
350         PARSE_UINT16    =       0x0005,
351 #endif
352         /* Returns a struct sockaddr_in, with optional default value
353          * (passed by reference) and port handling (accept, ignore,
354          * require, forbid). The format is 'host.name[:port]'
355          */
356         PARSE_INADDR    =       0x000f,
357
358         /* Other data types can be added as needed */
359
360         /* If PARSE_DEFAULT is set, next argument is a default value
361          * which is returned in case of error. The argument is passed
362          * by value in case of numeric types, by reference in other cases.
363          */
364         PARSE_DEFAULT   =       0x0010, /* assign default on error */
365
366         /* Request a range check, applicable to numbers. Two additional
367          * arguments are passed by value, specifying the low-high end of
368          * the range (inclusive). An error is returned if the value
369          * is outside or inside the range, respectively.
370          */
371         PARSE_IN_RANGE =        0x0020, /* accept values inside a range */
372         PARSE_OUT_RANGE =       0x0040, /* accept values outside a range */
373
374         /* Port handling, for sockaddr_in. accept/ignore/require/forbid
375          * port number after the hostname or address.
376          */
377         PARSE_PORT_MASK =       0x0300, /* 0x000: accept port if present */
378         PARSE_PORT_IGNORE =     0x0100, /* 0x100: ignore port if present */
379         PARSE_PORT_REQUIRE =    0x0200, /* 0x200: require port number */
380         PARSE_PORT_FORBID =     0x0300, /* 0x100: forbid port number */
381 };
382
383 /*! \brief The argument parsing routine.
384  * \param arg the string to parse. It is not modified.
385  * \param flags combination of ast_parse_flags to specify the
386  *      return type and additional checks.
387  * \param result pointer to the result. NULL is valid here, and can
388  *      be used to perform only the validity checks.
389  * \param ... extra arguments are required according to flags.
390  * \retval 0 in case of success, != 0 otherwise.
391  * \retval result returns the parsed value in case of success,
392  *      the default value in case of error, or it is left unchanged
393  *      in case of error and no default specified. Note that in certain
394  *      cases (e.g. sockaddr_in, with multi-field return values) some
395  *      of the fields in result may be changed even if an error occurs.
396  *
397  * Examples of use:
398  *      ast_parse_arg("223", PARSE_INT32|PARSE_IN_RANGE,
399  *              &a, -1000, 1000); 
400  *              returns 0, a = 223
401  *      ast_parse_arg("22345", PARSE_INT32|PARSE_IN_RANGE|PARSE_DEFAULT,
402  *              &a, 9999, 10, 100);
403  *              returns 1, a = 9999
404  *      ast_parse_arg("22345ssf", PARSE_UINT32|PARSE_IN_RANGE, &b, 10, 100);
405  *              returns 1, b unchanged
406  *      ast_parse_arg("www.foo.biz:44", PARSE_INADDR, &sa);
407  *              returns 0, sa contains address and port
408  *      ast_parse_arg("www.foo.biz", PARSE_INADDR|PARSE_PORT_REQUIRE, &sa);
409  *              returns 1 because port is missing, sa contains address
410  */
411 int ast_parse_arg(const char *arg, enum ast_parse_flags flags,
412         void *result, ...);
413
414 /*
415  * Parsing config file options in C is slightly annoying because we cannot use
416  * string in a switch() statement, yet we need a similar behaviour, with many
417  * branches and a break on a matching one.
418  * The following somehow simplifies the job: we create a block using
419  * the  CV_START and CV_END macros, and then within the block we can run
420  * actions such as "if (condition) { body; break; }"
421  * Additional macros are present to run simple functions (e.g. ast_copy_string)
422  * or to pass arguments to ast_parse_arg()
423  *
424  * As an example:
425
426         CV_START(v->name, v->value);    // start the block
427         CV_STR("foo", x_foo);           // static string
428         CV_DSTR("bar", y_bar);          // malloc'ed string
429         CV_F("bar", ...);               // call a generic function
430         CV_END;                         // end the block
431  */
432
433 /*! \brief the macro to open a block for variable parsing */
434 #define CV_START(__in_var, __in_val)            \
435         do {                                    \
436                 const char *__var = __in_var;   \
437                 const char *__val = __in_val;
438
439 /*! \brief close a variable parsing block */
440 #define CV_END                  } while (0)
441
442 /*! \brief call a generic function if the name matches. */
443 #define CV_F(__pattern, __body) if (!strcasecmp((__var), __pattern)) { __body; break; }
444
445 /*! \brief helper macros to assign the value to a BOOL, UINT, static string and
446  * dynamic string
447  */
448 #define CV_BOOL(__x, __dst)     CV_F(__x, (__dst) = ast_true(__val) )
449 #define CV_UINT(__x, __dst)     CV_F(__x, (__dst) = strtoul(__val, NULL, 0) )
450 #define CV_STR(__x, __dst)      CV_F(__x, ast_copy_string(__dst, __val, sizeof(__dst)))
451 #define CV_DSTR(__x, __dst)     CV_F(__x, if (__dst) ast_free(__dst); __dst = ast_strdup(__val))
452 #define CV_STRFIELD(__x, __obj, __field) CV_F(__x, ast_string_field_set(__obj, __field, __val))
453
454 #if defined(__cplusplus) || defined(c_plusplus)
455 }
456 #endif
457
458 #endif /* _ASTERISK_CONFIG_H */