Add support for a realtime sorcery module.
[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 #include "asterisk/inline_api.h"
32
33 struct ast_config;
34
35 struct ast_category;
36
37 /*! Options for ast_config_load()
38  */
39 enum {
40         /*! Load the configuration, including comments */
41         CONFIG_FLAG_WITHCOMMENTS  = (1 << 0),
42         /*! On a reload, give us a -1 if the file hasn't changed. */
43         CONFIG_FLAG_FILEUNCHANGED = (1 << 1),
44         /*! Don't attempt to cache mtime on this config file. */
45         CONFIG_FLAG_NOCACHE       = (1 << 2),
46         /*! Don't attempt to load from realtime (typically called from a realtime driver dependency) */
47         CONFIG_FLAG_NOREALTIME    = (1 << 3),
48 };
49
50 #define CONFIG_STATUS_FILEMISSING       (void *)0
51 #define CONFIG_STATUS_FILEUNCHANGED     (void *)-1
52 #define CONFIG_STATUS_FILEINVALID       (void *)-2
53
54 /*!
55  * \brief Types used in ast_realtime_require_field
56  */
57 typedef enum {
58         RQ_INTEGER1,
59         RQ_UINTEGER1,
60         RQ_INTEGER2,
61         RQ_UINTEGER2,
62         RQ_INTEGER3,
63         RQ_UINTEGER3,
64         RQ_INTEGER4,
65         RQ_UINTEGER4,
66         RQ_INTEGER8,
67         RQ_UINTEGER8,
68         RQ_CHAR,
69         RQ_FLOAT,
70         RQ_DATE,
71         RQ_DATETIME,
72 } require_type;
73
74 /*! \brief Structure for variables, used for configurations and for channel variables */
75 struct ast_variable {
76         /*! Variable name.  Stored in stuff[] at struct end. */
77         const char *name;
78         /*! Variable value.  Stored in stuff[] at struct end. */
79         const char *value;
80
81         /*! Next node in the list. */
82         struct ast_variable *next;
83
84         /*! Filename where variable found.  Stored in stuff[] at struct end. */
85         const char *file;
86
87         int lineno;
88         int object;             /*!< 0 for variable, 1 for object */
89         int blanklines;         /*!< Number of blanklines following entry */
90         struct ast_comment *precomments;
91         struct ast_comment *sameline;
92         struct ast_comment *trailing; /*!< the last object in the list will get assigned any trailing comments when EOF is hit */
93         /*!
94          * \brief Contents of file, name, and value in that order stuffed here.
95          * \note File must be stuffed before name because of ast_include_rename().
96          */
97         char stuff[0];
98 };
99
100 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);
101 typedef struct ast_variable *realtime_var_get(const char *database, const char *table, const struct ast_variable *fields);
102 typedef struct ast_config *realtime_multi_get(const char *database, const char *table, const struct ast_variable *fields);
103 typedef int realtime_update(const char *database, const char *table, const char *keyfield, const char *entity, const struct ast_variable *fields);
104 typedef int realtime_update2(const char *database, const char *table, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields);
105 typedef int realtime_store(const char *database, const char *table, const struct ast_variable *fields);
106 typedef int realtime_destroy(const char *database, const char *table, const char *keyfield, const char *entity, const struct ast_variable *fields);
107
108 /*!
109  * \brief Function pointer called to ensure database schema is properly configured for realtime use
110  * \since 1.6.1
111  */
112 typedef int realtime_require(const char *database, const char *table, va_list ap);
113
114 /*!
115  * \brief Function pointer called to clear the database cache and free resources used for such
116  * \since 1.6.1
117  */
118 typedef int realtime_unload(const char *database, const char *table);
119
120 /*! \brief Configuration engine structure, used to define realtime drivers */
121 struct ast_config_engine {
122         char *name;
123         config_load_func *load_func;
124         realtime_var_get *realtime_func;
125         realtime_multi_get *realtime_multi_func;
126         realtime_update *update_func;
127         realtime_update2 *update2_func;
128         realtime_store *store_func;
129         realtime_destroy *destroy_func;
130         realtime_require *require_func;
131         realtime_unload *unload_func;
132         struct ast_config_engine *next;
133 };
134
135 /*!
136  * \brief Load a config file
137  *
138  * \param filename path of file to open.  If no preceding '/' character,
139  * path is considered relative to AST_CONFIG_DIR
140  * \param who_asked The module which is making this request.
141  * \param flags Optional flags:
142  * CONFIG_FLAG_WITHCOMMENTS - load the file with comments intact;
143  * CONFIG_FLAG_FILEUNCHANGED - check the file mtime and return CONFIG_STATUS_FILEUNCHANGED if the mtime is the same; or
144  * CONFIG_FLAG_NOCACHE - don't cache file mtime (main purpose of this option is to save memory on temporary files).
145  *
146  * \details
147  * Create a config structure from a given configuration file.
148  *
149  * \return an ast_config data structure on success
150  * \retval NULL on error
151  */
152 struct ast_config *ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags);
153
154 /*!
155  * \brief Load a config file
156  *
157  * \param filename path of file to open.  If no preceding '/' character,
158  * path is considered relative to AST_CONFIG_DIR
159  * \param flags Optional flags:
160  * CONFIG_FLAG_WITHCOMMENTS - load the file with comments intact;
161  * CONFIG_FLAG_FILEUNCHANGED - check the file mtime and return CONFIG_STATUS_FILEUNCHANGED if the mtime is the same; or
162  * CONFIG_FLAG_NOCACHE - don't cache file mtime (main purpose of this option is to save memory on temporary files).
163  *
164  * \details
165  * Create a config structure from a given configuration file.
166  *
167  * \return an ast_config data structure on success
168  * \retval NULL on error
169  */
170 #define ast_config_load(filename, flags)        ast_config_load2(filename, AST_MODULE, flags)
171
172 /*!
173  * \brief Destroys a config
174  *
175  * \param config pointer to config data structure
176  *
177  * \details
178  * Free memory associated with a given config
179  */
180 void ast_config_destroy(struct ast_config *config);
181
182 /*!
183  * \brief returns the root ast_variable of a config
184  *
185  * \param config pointer to an ast_config data structure
186  * \param cat name of the category for which you want the root
187  *
188  * \return the category specified
189  */
190 struct ast_variable *ast_category_root(struct ast_config *config, char *cat);
191
192 /*!
193  * \brief Sorts categories in a config in the order of a numerical value contained within them.
194  *
195  * \param config The config structure you wish to sort
196  * \param comparator variable Which numerical value you wish to sort by
197  * \param descending If true, we sort highest to lowest instead of lowest to highest
198  *
199  * \details
200  * This function will assume a value of 0 for any non-numerical strings and NULL fields.
201  */
202 void ast_config_sort_categories(struct ast_config *config, int descending,
203                                                                 int (*comparator)(struct ast_category *p, struct ast_category *q));
204
205 /*!
206  * \brief Goes through categories
207  *
208  * \param config Which config structure you wish to "browse"
209  * \param prev A pointer to a previous category.
210  *
211  * \details
212  * This function is kind of non-intuitive in it's use.
213  * To begin, one passes NULL as the second argument.
214  * It will return a pointer to the string of the first category in the file.
215  * From here on after, one must then pass the previous usage's return value
216  * as the second pointer, and it will return a pointer to the category name
217  * afterwards.
218  *
219  * \retval a category on success
220  * \retval NULL on failure/no-more-categories
221  */
222 char *ast_category_browse(struct ast_config *config, const char *prev);
223
224 /*!
225  * \brief Goes through variables
226  *
227  * \details
228  * Somewhat similar in intent as the ast_category_browse.
229  * List variables of config file category
230  *
231  * \retval ast_variable list on success
232  * \retval NULL on failure
233  */
234 struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category);
235
236 /*!
237  * \brief given a pointer to a category, return the root variable.
238  *
239  * \details
240  * This is equivalent to ast_variable_browse(), but more efficient if we
241  * already have the struct ast_category * (e.g. from ast_category_get())
242  */
243 struct ast_variable *ast_category_first(struct ast_category *cat);
244
245 /*!
246  * \brief Gets a variable
247  *
248  * \param config which (opened) config to use
249  * \param category category under which the variable lies
250  * \param variable which variable you wish to get the data for
251  *
252  * \details
253  * Goes through a given config file in the given category and searches for the given variable
254  *
255  * \retval The variable value on success
256  * \retval NULL if unable to find it.
257  */
258 const char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable);
259
260 /*!
261  * \brief Retrieve a category if it exists
262  *
263  * \param config which config to use
264  * \param category_name name of the category you're looking for
265  *
266  * \details
267  * This will search through the categories within a given config file for a match.
268  *
269  * \retval pointer to category if found
270  * \retval NULL if not.
271  */
272 struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name);
273
274 /*!
275  * \brief Check for category duplicates
276  *
277  * \param config which config to use
278  * \param category_name name of the category you're looking for
279  *
280  * \details
281  * This will search through the categories within a given config file for a match.
282  *
283  * \return non-zero if found
284  */
285 int ast_category_exist(const struct ast_config *config, const char *category_name);
286
287 /*!
288  * \brief Retrieve realtime configuration
289  *
290  * \param family which family/config to lookup
291  *
292  * \details
293  * This will use builtin configuration backends to look up a particular
294  * entity in realtime and return a variable list of its parameters.
295  *
296  * \note
297  * Unlike the variables in ast_config, the resulting list of variables
298  * MUST be freed with ast_variables_destroy() as there is no container.
299  *
300  * \note
301  * The difference between these two calls is that ast_load_realtime excludes
302  * fields whose values are NULL, while ast_load_realtime_all loads all columns.
303  *
304  * \note
305  * You should use the constant SENTINEL to terminate arguments, in
306  * order to preserve cross-platform compatibility.
307  */
308 struct ast_variable *ast_load_realtime_fields(const char *family, const struct ast_variable *fields);
309 struct ast_variable *ast_load_realtime(const char *family, ...) attribute_sentinel;
310 struct ast_variable *ast_load_realtime_all_fields(const char *family, const struct ast_variable *fields);
311 struct ast_variable *ast_load_realtime_all(const char *family, ...) attribute_sentinel;
312
313 /*!
314  * \brief Release any resources cached for a realtime family
315  * \since 1.6.1
316  *
317  * \param family which family/config to destroy
318  *
319  * \details
320  * Various backends may cache attributes about a realtime data storage
321  * facility; on reload, a front end resource may request to purge that cache.
322  *
323  * \retval 0 If any cache was purged
324  * \retval -1 If no cache was found
325  */
326 int ast_unload_realtime(const char *family);
327
328 /*!
329  * \brief Inform realtime what fields that may be stored
330  * \since 1.6.1
331  *
332  * \param family which family/config is referenced
333  *
334  * \details
335  * This will inform builtin configuration backends that particular fields
336  * may be updated during the use of that configuration section.  This is
337  * mainly to be used during startup routines, to ensure that various fields
338  * exist in the backend.  The backends may take various actions, such as
339  * creating new fields in the data store or warning the administrator that
340  * new fields may need to be created, in order to ensure proper function.
341  *
342  * The arguments are specified in groups of 3:  column name, column type,
343  * and column size.  The column types are specified as integer constants,
344  * defined by the enum require_type.  Note that the size is specified as
345  * the number of equivalent character fields that a field may take up, even
346  * if a field is otherwise specified as an integer type.  This is due to
347  * the fact that some fields have historically been specified as character
348  * types, even if they contained integer values.
349  *
350  * A family should always specify its fields to the minimum necessary
351  * requirements to fulfill all possible values (within reason; for example,
352  * a timeout value may reasonably be specified as an INTEGER2, with size 5.
353  * Even though values above 32767 seconds are possible, they are unlikely
354  * to be useful, and we should not complain about that size).
355  *
356  * \retval 0 Required fields met specified standards
357  * \retval -1 One or more fields was missing or insufficient
358  *
359  * \note You should use the constant SENTINEL to terminate arguments, in
360  * order to preserve cross-platform compatibility.
361  */
362 int ast_realtime_require_field(const char *family, ...) attribute_sentinel;
363
364 /*!
365  * \brief Retrieve realtime configuration
366  *
367  * \param family which family/config to lookup
368  * \param fields list of fields
369  *
370  * \details
371  * This will use builtin configuration backends to look up a particular
372  * entity in realtime and return a variable list of its parameters. Unlike
373  * the ast_load_realtime, this function can return more than one entry and
374  * is thus stored inside a traditional ast_config structure rather than
375  * just returning a linked list of variables.
376  *
377  * \return An ast_config with one or more results
378  * \retval NULL Error or no results returned
379  */
380 struct ast_config *ast_load_realtime_multientry_fields(const char *family, const struct ast_variable *fields);
381
382 /*!
383  * \brief Retrieve realtime configuration
384  *
385  * \param family which family/config to lookup
386  *
387  * \details
388  * This will use builtin configuration backends to look up a particular
389  * entity in realtime and return a variable list of its parameters. Unlike
390  * the ast_load_realtime, this function can return more than one entry and
391  * is thus stored inside a traditional ast_config structure rather than
392  * just returning a linked list of variables.
393  *
394  * \return An ast_config with one or more results
395  * \retval NULL Error or no results returned
396  *
397  * \note You should use the constant SENTINEL to terminate arguments, in
398  * order to preserve cross-platform compatibility.
399  */
400 struct ast_config *ast_load_realtime_multientry(const char *family, ...) attribute_sentinel;
401
402 /*!
403  * \brief Update realtime configuration
404  *
405  * \param family which family/config to be updated
406  * \param keyfield which field to use as the key
407  * \param lookup which value to look for in the key field to match the entry.
408  * \param fields fields to update
409  *
410  * \details
411  * This function is used to update a parameter in realtime configuration space.
412  *
413  * \return Number of rows affected, or -1 on error.
414  */
415 int ast_update_realtime_fields(const char *family, const char *keyfield, const char *lookup, const struct ast_variable *fields);
416
417 /*!
418  * \brief Update realtime configuration
419  *
420  * \param family which family/config to be updated
421  * \param keyfield which field to use as the key
422  * \param lookup which value to look for in the key field to match the entry.
423  *
424  * \details
425  * This function is used to update a parameter in realtime configuration space.
426  *
427  * \return Number of rows affected, or -1 on error.
428  *
429  * \note You should use the constant SENTINEL to terminate arguments, in
430  * order to preserve cross-platform compatibility.
431  */
432 int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
433
434 /*!
435  * \brief Update realtime configuration
436  *
437  * \param family which family/config to be updated
438  * \param lookup_fields fields used to look up entries
439  * \param update_fields fields to update
440  *
441  * \details
442  * This function is used to update a parameter in realtime configuration space.
443  * It includes the ability to lookup a row based upon multiple key criteria.
444  * As a result, this function includes two sentinel values, one to terminate
445  * lookup values and the other to terminate the listing of fields to update.
446  *
447  * \return Number of rows affected, or -1 on error.
448  */
449 int ast_update2_realtime_fields(const char *family, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields);
450
451 /*!
452  * \brief Update realtime configuration
453  *
454  * \param family which family/config to be updated
455  *
456  * \details
457  * This function is used to update a parameter in realtime configuration space.
458  * It includes the ability to lookup a row based upon multiple key criteria.
459  * As a result, this function includes two sentinel values, one to terminate
460  * lookup values and the other to terminate the listing of fields to update.
461  *
462  * \return Number of rows affected, or -1 on error.
463  *
464  * \note You should use the constant SENTINEL to terminate arguments, in
465  * order to preserve cross-platform compatibility.
466  */
467 int ast_update2_realtime(const char *family, ...) attribute_sentinel;
468
469 /*!
470  * \brief Create realtime configuration
471  *
472  * \param family which family/config to be created
473  * \param fields fields themselves
474  *
475  * \details
476  * This function is used to create a parameter in realtime configuration space.
477  *
478  * \return Number of rows affected, or -1 on error.
479  *
480  * \note
481  * On the MySQL engine only, for reasons of backwards compatibility, the return
482  * value is the insert ID.  This value is nonportable and may be changed in a
483  * future version to match the other engines.
484  */
485 int ast_store_realtime_fields(const char *family, const struct ast_variable *fields);
486
487 /*!
488  * \brief Create realtime configuration
489  *
490  * \param family which family/config to be created
491  *
492  * \details
493  * This function is used to create a parameter in realtime configuration space.
494  *
495  * \return Number of rows affected, or -1 on error.
496  *
497  * \note
498  * On the MySQL engine only, for reasons of backwards compatibility, the return
499  * value is the insert ID.  This value is nonportable and may be changed in a
500  * future version to match the other engines.
501  *
502  * \note You should use the constant SENTINEL to terminate arguments, in
503  * order to preserve cross-platform compatibility.
504  */
505 int ast_store_realtime(const char *family, ...) attribute_sentinel;
506
507 /*!
508  * \brief Destroy realtime configuration
509  *
510  * \param family which family/config to be destroyed
511  * \param keyfield which field to use as the key
512  * \param lookup which value to look for in the key field to match the entry.
513  * \param fields fields themselves
514  *
515  * \details
516  * This function is used to destroy an entry in realtime configuration space.
517  * Additional params are used as keys.
518  *
519  * \return Number of rows affected, or -1 on error.
520  */
521 int ast_destroy_realtime_fields(const char *family, const char *keyfield, const char *lookup, const struct ast_variable *fields);
522
523 /*!
524  * \brief Destroy realtime configuration
525  *
526  * \param family which family/config to be destroyed
527  * \param keyfield which field to use as the key
528  * \param lookup which value to look for in the key field to match the entry.
529  *
530  * \details
531  * This function is used to destroy an entry in realtime configuration space.
532  * Additional params are used as keys.
533  *
534  * \return Number of rows affected, or -1 on error.
535  *
536  * \note You should use the constant SENTINEL to terminate arguments, in
537  * order to preserve cross-platform compatibility.
538  */
539 int ast_destroy_realtime(const char *family, const char *keyfield, const char *lookup, ...) attribute_sentinel;
540
541 /*!
542  * \brief Check if realtime engine is configured for family
543  * \param family which family/config to be checked
544  * \return 1 if family is configured in realtime and engine exists
545  */
546 int ast_check_realtime(const char *family);
547
548 /*! \brief Check if there's any realtime engines loaded */
549 int ast_realtime_enabled(void);
550
551 /*!
552  * \brief Duplicate variable list
553  * \param var the linked list of variables to clone
554  * \return A duplicated list which you'll need to free with
555  * ast_variables_destroy or NULL when out of memory.
556  *
557  * \note Do not depend on this to copy more than just name, value and filename
558  * (the arguments to ast_variables_new).
559  */
560 struct ast_variable *ast_variables_dup(struct ast_variable *var);
561
562 /*!
563  * \brief Free variable list
564  * \param var the linked list of variables to free
565  *
566  * \details
567  * This function frees a list of variables.
568  */
569 void ast_variables_destroy(struct ast_variable *var);
570
571 /*!
572  * \brief Register config engine
573  * \retval 1 Always
574  */
575 int ast_config_engine_register(struct ast_config_engine *newconfig);
576
577 /*!
578  * \brief Deregister config engine
579  * \retval 0 Always
580  */
581 int ast_config_engine_deregister(struct ast_config_engine *del);
582
583 /*!
584  * \brief Determine if a mapping exists for a given family
585  *
586  * \param family which family you are looking to see if a mapping exists for
587  * \retval 1 if it is mapped
588  * \retval 0 if it is not
589  */
590 int ast_realtime_is_mapping_defined(const char *family);
591
592 #ifdef TEST_FRAMEWORK
593 /*!
594  * \brief Add an explicit mapping for a family
595  *
596  * \param name Family name
597  * \param driver Driver to use
598  * \param database Database to access
599  * \param table Table to use
600  * \param priority Priority of this mapping
601  */
602 int ast_realtime_append_mapping(const char *name, const char *driver, const char *database, const char *table, int priority);
603 #endif
604
605 /*!
606  * \brief Exposed initialization method for core process
607  *
608  * \details
609  * This method is intended for use only with the core initialization and is
610  * not designed to be called from any user applications.
611  */
612 int register_config_cli(void);
613
614 /*!
615  * \brief Exposed re-initialization method for core process
616  *
617  * \details
618  * This method is intended for use only with the core re-initialization and is
619  * not designed to be called from any user applications.
620  */
621 int read_config_maps(void);
622
623 /*! \brief Create a new base configuration structure */
624 struct ast_config *ast_config_new(void);
625
626 /*!
627  * \brief Retrieve the current category name being built.
628  *
629  * \details
630  * API for backend configuration engines while building a configuration set.
631  */
632 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg);
633
634 /*!
635  * \brief Set the category within the configuration as being current.
636  *
637  * \details
638  * API for backend configuration engines while building a configuration set.
639  */
640 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat);
641
642 /*!
643  * \brief Retrieve a configuration variable within the configuration set.
644  *
645  * \details
646  * Retrieves the named variable \p var within category \p cat of configuration
647  * set \p cfg.  If not found, attempts to retrieve the named variable \p var
648  * from within category \em general.
649  *
650  * \return Value of \p var, or NULL if not found.
651  */
652 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var);
653
654 /*! \brief Create a category structure */
655 struct ast_category *ast_category_new(const char *name, const char *in_file, int lineno);
656 void ast_category_append(struct ast_config *config, struct ast_category *cat);
657
658 /*!
659  * \brief Inserts new category
660  * 
661  * \param config which config to use
662  * \param cat newly created category to insert
663  * \param match which category to insert above
664  *
665  * \details
666  * This function is used to insert a new category above another category
667  * matching the match parameter.
668  */
669 void ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match);
670 int ast_category_delete(struct ast_config *cfg, const char *category);
671
672 /*!
673  * \brief Removes and destroys all variables within a category
674  * \retval 0 if the category was found and emptied
675  * \retval -1 if the category was not found
676  */
677 int ast_category_empty(struct ast_config *cfg, const char *category);
678 void ast_category_destroy(struct ast_category *cat);
679 struct ast_variable *ast_category_detach_variables(struct ast_category *cat);
680 void ast_category_rename(struct ast_category *cat, const char *name);
681
682 #ifdef MALLOC_DEBUG
683 struct ast_variable *_ast_variable_new(const char *name, const char *value, const char *filename, const char *file, const char *function, int lineno);
684 #define ast_variable_new(a, b, c) _ast_variable_new(a, b, c, __FILE__, __PRETTY_FUNCTION__, __LINE__)
685 #else
686 struct ast_variable *ast_variable_new(const char *name, const char *value, const char *filename);
687 #endif
688 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);
689 struct ast_config_include *ast_include_find(struct ast_config *conf, const char *included_file);
690 void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file);
691 void ast_variable_append(struct ast_category *category, struct ast_variable *variable);
692 void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line);
693 int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line);
694
695 /*!
696  * \brief Update variable value within a config
697  *
698  * \param category Category element within the config
699  * \param variable Name of the variable to change
700  * \param value New value of the variable
701  * \param match If set, previous value of the variable (if NULL or zero-length, no matching will be done)
702  * \param object Boolean of whether to make the new variable an object
703  *
704  * \return 0 on success or -1 on failure.
705  */
706 int ast_variable_update(struct ast_category *category, const char *variable,
707                                                 const char *value, const char *match, unsigned int object);
708
709 int ast_config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator);
710 int config_text_file_save(const char *filename, const struct ast_config *cfg, const char *generator) __attribute__((deprecated));
711
712 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);
713 /*!
714  * \brief
715  * Copies the contents of one ast_config into another
716  *
717  * \note
718  * This creates a config on the heap. The caller of this must
719  * be prepared to free the memory returned.
720  *
721  * \param orig the config to copy
722  * \return The new config on success, NULL on failure.
723  */
724 struct ast_config *ast_config_copy(const struct ast_config *orig);
725
726 /*!
727  * \brief
728  * Flags that affect the behaviour of config hooks.
729  */
730 enum config_hook_flags {
731         butt,
732 };
733
734 /*
735  * \brief Callback when configuration is updated
736  *
737  * \param cfg A copy of the configuration that is being changed.
738  *            This MUST be freed by the callback before returning.
739  */
740 typedef int (*config_hook_cb)(struct ast_config *cfg);
741
742 /*!
743  * \brief
744  * Register a config hook for a particular file and module
745  *
746  * \param name The name of the hook you are registering.
747  * \param filename The file whose config you wish to hook into.
748  * \param module The module that is reloading the config. This
749  *               can be useful if multiple modules may possibly
750  *               reload the same file, but you are only interested
751  *               when a specific module reloads the file
752  * \param flags Flags that affect the way hooks work.
753  * \param hook The callback to be called when config is loaded.
754  * return 0 Success
755  * return -1 Unsuccess, also known as UTTER AND COMPLETE FAILURE
756  */
757 int ast_config_hook_register(const char *name,
758                 const char *filename,
759                 const char *module,
760                 enum config_hook_flags flags,
761                 config_hook_cb hook);
762
763 /*!
764  * \brief
765  * Unregister a config hook
766  *
767  * \param name The name of the hook to unregister
768  */
769 void ast_config_hook_unregister(const char *name);
770
771 /*!
772  * \brief Support code to parse config file arguments
773  *
774  * \details
775  * The function ast_parse_arg() provides a generic interface to parse
776  * strings (e.g. numbers, network addresses and so on) in a flexible
777  * way, e.g. by doing proper error and bound checks, provide default
778  * values, and so on.
779  * The function (described later) takes a string as an argument,
780  * a set of flags to specify the result format and checks to perform,
781  * a pointer to the result, and optionally some additional arguments.
782  *
783  * \return It returns 0 on success, != 0 otherwise.
784  */
785 enum ast_parse_flags {
786         /* low 4 bits of flags are used for the operand type */
787         PARSE_TYPE      =       0x000f,
788         /* numeric types, with optional default value and bound checks.
789          * Additional arguments are passed by value.
790          */
791         PARSE_INT32     =       0x0001,
792         PARSE_UINT32    =       0x0002,
793         PARSE_DOUBLE    =       0x0003,
794 #if 0   /* not supported yet */
795         PARSE_INT16     =       0x0004,
796         PARSE_UINT16    =       0x0005,
797 #endif
798
799         /* Returns a struct ast_sockaddr, with optional default value
800          * (passed by reference) and port handling (accept, ignore,
801          * require, forbid). The format is 'ipaddress[:port]'. IPv6 address
802          * literals need square brackets around them if a port is specified.
803          */
804         PARSE_ADDR      =       0x000e,
805
806         /* Returns a struct sockaddr_in, with optional default value
807          * (passed by reference) and port handling (accept, ignore,
808          * require, forbid). The format is 'host.name[:port]'
809          */
810         PARSE_INADDR    =       0x000f,
811
812         /* Other data types can be added as needed */
813
814         /* If PARSE_DEFAULT is set, next argument is a default value
815          * which is returned in case of error. The argument is passed
816          * by value in case of numeric types, by reference in other cases.
817          */
818         PARSE_DEFAULT   =       0x0010, /* assign default on error */
819
820         /* Request a range check, applicable to numbers. Two additional
821          * arguments are passed by value, specifying the low-high end of
822          * the range (inclusive). An error is returned if the value
823          * is outside or inside the range, respectively.
824          */
825         PARSE_IN_RANGE =       0x0020, /* accept values inside a range */
826         PARSE_OUT_RANGE =      0x0040, /* accept values outside a range */
827         PARSE_RANGE_DEFAULTS = 0x0080, /* default to range min/max on range error */
828
829         /* Port handling, for ast_sockaddr. accept/ignore/require/forbid
830          * port number after the hostname or address.
831          */
832         PARSE_PORT_MASK =       0x0300, /* 0x000: accept port if present */
833         PARSE_PORT_IGNORE =     0x0100, /* 0x100: ignore port if present */
834         PARSE_PORT_REQUIRE =    0x0200, /* 0x200: require port number */
835         PARSE_PORT_FORBID =     0x0300, /* 0x100: forbid port number */
836 };
837
838 /*!
839  * \brief The argument parsing routine.
840  *
841  * \param arg the string to parse. It is not modified.
842  * \param flags combination of ast_parse_flags to specify the
843  *      return type and additional checks.
844  * \param result pointer to the result. NULL is valid here, and can
845  *      be used to perform only the validity checks.
846  * \param ... extra arguments are required according to flags.
847  *
848  * \retval 0 in case of success, != 0 otherwise.
849  * \retval result returns the parsed value in case of success,
850  * the default value in case of error, or it is left unchanged
851  * in case of error and no default specified. Note that in certain
852  * cases (e.g. sockaddr_in, with multi-field return values) some
853  * of the fields in result may be changed even if an error occurs.
854  *
855  * \details
856  * Examples of use:
857  *     ast_parse_arg("223", PARSE_INT32|PARSE_IN_RANGE, &a, -1000, 1000);
858  * returns 0, a = 223
859  *     ast_parse_arg("22345", PARSE_INT32|PARSE_IN_RANGE|PARSE_DEFAULT, &a, 9999, 10, 100);
860  * returns 1, a = 9999
861  *     ast_parse_arg("22345ssf", PARSE_UINT32|PARSE_IN_RANGE, &b, 10, 100);
862  * returns 1, b unchanged
863  *    ast_parse_arg("12", PARSE_UINT32|PARSE_IN_RANGE|PARSE_RANGE_DEFAULTS, &a, 1, 10);
864  * returns 1, a = 10
865  *    ast_parse_arg("www.foo.biz:44", PARSE_INADDR, &sa);
866  * returns 0, sa contains address and port
867  *    ast_parse_arg("www.foo.biz", PARSE_INADDR|PARSE_PORT_REQUIRE, &sa);
868  * returns 1 because port is missing, sa contains address
869  */
870 int ast_parse_arg(const char *arg, enum ast_parse_flags flags,
871         void *result, ...);
872
873 /*
874  * Parsing config file options in C is slightly annoying because we cannot use
875  * string in a switch() statement, yet we need a similar behaviour, with many
876  * branches and a break on a matching one.
877  * The following somehow simplifies the job: we create a block using
878  * the CV_START and CV_END macros, and then within the block we can run
879  * actions such as "if (condition) { body; break; }"
880  * Additional macros are present to run simple functions (e.g. ast_copy_string)
881  * or to pass arguments to ast_parse_arg()
882  *
883  * As an example:
884
885         CV_START(v->name, v->value);    // start the block
886         CV_STR("foo", x_foo);           // static string
887         CV_DSTR("bar", y_bar);          // malloc'ed string
888         CV_F("bar", ...);               // call a generic function
889         CV_END;                         // end the block
890  */
891
892 /*! \brief the macro to open a block for variable parsing */
893 #define CV_START(__in_var, __in_val)            \
894         do {                                    \
895                 const char *__var = __in_var;   \
896                 const char *__val = __in_val;
897
898 /*! \brief close a variable parsing block */
899 #define CV_END                  } while (0)
900
901 /*! \brief call a generic function if the name matches. */
902 #define CV_F(__pattern, __body) if (!strcasecmp((__var), __pattern)) { __body; break; }
903
904 /*!
905  * \brief helper macros to assign the value to a BOOL, UINT, static string and
906  * dynamic string
907  */
908 #define CV_BOOL(__x, __dst)     CV_F(__x, (__dst) = ast_true(__val) )
909 #define CV_UINT(__x, __dst)     CV_F(__x, (__dst) = strtoul(__val, NULL, 0) )
910 #define CV_STR(__x, __dst)      CV_F(__x, ast_copy_string(__dst, __val, sizeof(__dst)))
911 #define CV_DSTR(__x, __dst)     CV_F(__x, ast_free(__dst); __dst = ast_strdup(__val))
912 #define CV_STRFIELD(__x, __obj, __field) CV_F(__x, ast_string_field_set(__obj, __field, __val))
913
914 /*! \brief Check if require type is an integer type */
915 AST_INLINE_API(
916 int ast_rq_is_int(require_type type),
917 {
918         switch (type) {
919         case RQ_INTEGER1:
920         case RQ_UINTEGER1:
921         case RQ_INTEGER2:
922         case RQ_UINTEGER2:
923         case RQ_INTEGER3:
924         case RQ_UINTEGER3:
925         case RQ_INTEGER4:
926         case RQ_UINTEGER4:
927         case RQ_INTEGER8:
928         case RQ_UINTEGER8:
929                 return 1;
930         default:
931                 return 0;
932         }
933 }
934 )
935
936 /*!
937  * \brief Remove standard encoding from realtime values, which ensures
938  * that a semicolon embedded within a single value is not treated upon
939  * retrieval as multiple values.
940  * \param chunk Data to be decoded
941  * \return The decoded data, in the original buffer
942  * \since 1.8
943  * \warning This function modifies the original buffer
944  */
945 char *ast_realtime_decode_chunk(char *chunk);
946
947 /*!
948  * \brief Encodes a chunk of data for realtime
949  * \param dest Destination buffer
950  * \param maxlen Length passed through to ast_str_* functions
951  * \param chunk Source data to be encoded
952  * \return Buffer within dest
953  * \since 1.8
954  */
955 char *ast_realtime_encode_chunk(struct ast_str **dest, ssize_t maxlen, const char *chunk);
956
957 #if defined(__cplusplus) || defined(c_plusplus)
958 }
959 #endif
960
961 #endif /* _ASTERISK_CONFIG_H */