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