39a3fbe61c96ddcb57c00d28875ea63aa5a542ff
[asterisk/asterisk.git] / main / config_options.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, 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 Option-handling
21  * \author Terry Wilson <twilson@digium.com>
22  */
23
24 /*** MODULEINFO
25         <support_level>core</support_level>
26  ***/
27
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <regex.h>
33
34 #include "asterisk/_private.h"
35 #include "asterisk/config.h"
36 #include "asterisk/config_options.h"
37 #include "asterisk/stringfields.h"
38 #include "asterisk/acl.h"
39 #include "asterisk/frame.h"
40 #include "asterisk/xmldoc.h"
41 #include "asterisk/cli.h"
42 #include "asterisk/term.h"
43
44 #ifdef LOW_MEMORY
45 #define CONFIG_OPT_BUCKETS 5
46 #else
47 #define CONFIG_OPT_BUCKETS 53
48 #endif /* LOW_MEMORY */
49
50 /*! \brief Bits of aco_info that shouldn't be assigned outside this file
51  * \internal
52  */
53 struct aco_info_internal {
54         void *pending;              /*!< The user-defined config object awaiting application */
55 };
56
57 struct aco_type_internal {
58         regex_t *regex;
59         struct ao2_container *opts; /*!< The container of options registered to the aco_info */
60 };
61
62 struct aco_option {
63         const char *name;
64         const char *aliased_to;
65         const char *default_val;
66         enum aco_matchtype match_type;
67         regex_t *name_regex;
68         struct aco_type **obj;
69         enum aco_option_type type;
70         aco_option_handler handler;
71         unsigned int flags;
72         unsigned char deprecated:1;
73         size_t argc;
74         intptr_t args[0];
75 };
76
77 #ifdef AST_XML_DOCS
78 static struct ao2_container *xmldocs;
79 #endif /* AST_XML_DOCS */
80
81 /*! \brief Value of the aco_option_type enum as strings */
82 static char *aco_option_type_string[] = {
83         "ACL",                          /* OPT_ACL_T, */
84         "Boolean",                      /* OPT_BOOL_T, */
85         "Boolean",                      /* OPT_BOOLFLAG_T, */
86         "String",                       /* OPT_CHAR_ARRAY_T, */
87         "Codec",                        /* OPT_CODEC_T, */
88         "Custom",                       /* OPT_CUSTOM_T, */
89         "Double",                       /* OPT_DOUBLE_T, */
90         "Integer",                      /* OPT_INT_T, */
91         "None",                         /* OPT_NOOP_T, */
92         "IP Address",           /* OPT_SOCKADDR_T, */
93         "String",                       /* OPT_STRINGFIELD_T, */
94         "Unsigned Integer",     /* OPT_UINT_T, */
95 };
96
97 void *aco_pending_config(struct aco_info *info)
98 {
99         if (!(info && info->internal)) {
100                 ast_log(LOG_ERROR, "This may not be called without an initialized aco_info!\n");
101                 return NULL;
102         }
103         return info->internal->pending;
104 }
105
106 static void config_option_destroy(void *obj)
107 {
108         struct aco_option *opt = obj;
109         if (opt->match_type == ACO_REGEX && opt->name_regex) {
110                 regfree(opt->name_regex);
111                 ast_free(opt->name_regex);
112         }
113 }
114
115 static int int_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
116 static int uint_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
117 static int double_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
118 static int sockaddr_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
119 static int stringfield_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
120 static int bool_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
121 static int boolflag_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
122 static int acl_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
123 static int codec_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
124 static int noop_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
125 static int chararray_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
126
127 #ifdef AST_XML_DOCS
128 static int xmldoc_update_config_type(const char *module, const char *name, const char *category, const char *matchfield, const char *matchvalue, unsigned int matches);
129 static int xmldoc_update_config_option(struct aco_type **types, const char *module, const char *name, const char *object_name, const char *default_value, unsigned int regex, enum aco_option_type type);
130 #endif
131
132 static aco_option_handler ast_config_option_default_handler(enum aco_option_type type)
133 {
134         switch(type) {
135         case OPT_ACL_T: return acl_handler_fn;
136         case OPT_BOOL_T: return bool_handler_fn;
137         case OPT_BOOLFLAG_T: return boolflag_handler_fn;
138         case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
139         case OPT_CODEC_T: return codec_handler_fn;
140         case OPT_DOUBLE_T: return double_handler_fn;
141         case OPT_INT_T: return int_handler_fn;
142         case OPT_NOOP_T: return noop_handler_fn;
143         case OPT_SOCKADDR_T: return sockaddr_handler_fn;
144         case OPT_STRINGFIELD_T: return stringfield_handler_fn;
145         case OPT_UINT_T: return uint_handler_fn;
146
147         case OPT_CUSTOM_T: return NULL;
148         }
149
150         return NULL;
151 }
152
153 static regex_t *build_regex(const char *text)
154 {
155         int res;
156         regex_t *regex;
157
158         if (!(regex = ast_malloc(sizeof(*regex)))) {
159                 return NULL;
160         }
161
162         if ((res = regcomp(regex, text, REG_EXTENDED | REG_ICASE | REG_NOSUB))) {
163                 size_t len = regerror(res, regex, NULL, 0);
164                 char buf[len];
165                 regerror(res, regex, buf, len);
166                 ast_log(LOG_ERROR, "Could not compile regex '%s': %s\n", text, buf);
167                 ast_free(regex);
168                 return NULL;
169         }
170
171         return regex;
172 }
173
174 static int link_option_to_types(struct aco_info *info, struct aco_type **types, struct aco_option *opt)
175 {
176         size_t idx = 0;
177         struct aco_type *type;
178
179         while ((type = types[idx++])) {
180                 if (!type->internal) {
181                         ast_log(LOG_ERROR, "Attempting to register option using uninitialized type\n");
182                         return -1;
183                 }
184                 if (!ao2_link(type->internal->opts, opt)
185 #ifdef AST_XML_DOCS
186                                 || xmldoc_update_config_option(types, info->module, opt->name, type->name, opt->default_val, opt->match_type == ACO_REGEX, opt->type)
187 #endif /* AST_XML_DOCS */
188                 ) {
189                         while (--idx) {
190                                 ao2_unlink(types[idx]->internal->opts, opt);
191                         }
192                         return -1;
193                 }
194                 /* The container should hold the only ref to opt */
195                 ao2_ref(opt, -1);
196         }
197         return 0;
198 }
199
200 int aco_option_register_deprecated(struct aco_info *info, const char *name, struct aco_type **types, const char *aliased_to)
201 {
202         struct aco_option *opt;
203
204         if (!info || ast_strlen_zero(name) || ast_strlen_zero(aliased_to)) {
205                 return -1;
206         }
207
208         if (!(opt = ao2_alloc(sizeof(*opt), config_option_destroy))) {
209                 return -1;
210         }
211
212         opt->name = name;
213         opt->aliased_to = aliased_to;
214         opt->deprecated = 1;
215         opt->match_type = ACO_EXACT;
216
217         if (link_option_to_types(info, types, opt)) {
218                 ao2_ref(opt, -1);
219                 return -1;
220         }
221
222         return 0;
223 }
224
225 unsigned int aco_option_get_flags(const struct aco_option *option)
226 {
227         return option->flags;
228 }
229
230 #ifdef AST_XML_DOCS
231 /*! \internal
232  * \brief Find a particular ast_xml_doc_item from it's parent config_info, types, and name
233  */
234 static struct ast_xml_doc_item *find_xmldoc_option(struct ast_xml_doc_item *config_info, struct aco_type **types, const char *name)
235 {
236         struct ast_xml_doc_item *iter = config_info;
237
238         if (!iter) {
239                 return NULL;
240         }
241         /* First is just the configInfo, we can skip it */
242         while ((iter = iter->next)) {
243                 size_t x;
244                 if (strcasecmp(iter->name, name)) {
245                         continue;
246                 }
247                 for (x = 0; types[x]; x++) {
248                         /* All we care about is that at least one type has the option */
249                         if (!strcasecmp(types[x]->name, iter->ref)) {
250                                 return iter;
251                         }
252                 }
253         }
254         return NULL;
255 }
256
257 /*! \internal
258  * \brief Find a particular ast_xml_doc_item from it's parent config_info and name
259  */
260 static struct ast_xml_doc_item *find_xmldoc_type(struct ast_xml_doc_item *config_info, const char *name)
261 {
262         struct ast_xml_doc_item *iter = config_info;
263         if (!iter) {
264                 return NULL;
265         }
266         /* First is just the config Info, skip it */
267         while ((iter = iter->next)) {
268                 if (!strcasecmp(iter->type, "configObject") && !strcasecmp(iter->name, name)) {
269                         break;
270                 }
271         }
272         return iter;
273 }
274
275 #endif /* AST_XML_DOCS */
276
277 int __aco_option_register(struct aco_info *info, const char *name, enum aco_matchtype matchtype, struct aco_type **types,
278         const char *default_val, enum aco_option_type kind, aco_option_handler handler, unsigned int flags, size_t argc, ...)
279 {
280         struct aco_option *opt;
281         va_list ap;
282         int tmp;
283
284         /* Custom option types require a handler */
285         if (!handler && kind == OPT_CUSTOM_T) {
286                 return -1;
287         }
288
289         if (!(types && types[0])) {
290                 return -1;
291         }
292
293         if (!(opt = ao2_alloc(sizeof(*opt) + argc * sizeof(opt->args[0]), config_option_destroy))) {
294                 return -1;
295         }
296
297         if (matchtype == ACO_REGEX && !(opt->name_regex = build_regex(name))) {
298                 ao2_ref(opt, -1);
299                 return -1;
300         }
301
302         va_start(ap, argc);
303         for (tmp = 0; tmp < argc; tmp++) {
304                 opt->args[tmp] = va_arg(ap, size_t);
305         }
306         va_end(ap);
307
308         opt->name = name;
309         opt->match_type = matchtype;
310         opt->default_val = default_val;
311         opt->type = kind;
312         opt->handler = handler;
313         opt->flags = flags;
314         opt->argc = argc;
315
316         if (!opt->handler && !(opt->handler = ast_config_option_default_handler(opt->type))) {
317                 /* This should never happen */
318                 ast_log(LOG_ERROR, "No handler provided, and no default handler exists for type %d\n", opt->type);
319                 ao2_ref(opt, -1);
320                 return -1;
321         };
322
323         if (link_option_to_types(info, types, opt)) {
324                 ao2_ref(opt, -1);
325                 return -1;
326         }
327
328         return 0;
329 }
330
331 static int config_opt_hash(const void *obj, const int flags)
332 {
333         const struct aco_option *opt = obj;
334         const char *name = (flags & OBJ_KEY) ? obj : opt->name;
335         return ast_str_case_hash(name);
336 }
337
338 static int config_opt_cmp(void *obj, void *arg, int flags)
339 {
340         struct aco_option *opt1 = obj, *opt2 = arg;
341         const char *name = (flags & OBJ_KEY) ? arg : opt2->name;
342         return strcasecmp(opt1->name, name) ? 0 : CMP_MATCH | CMP_STOP;
343 }
344
345 static int find_option_cb(void *obj, void *arg, int flags)
346 {
347         struct aco_option *match = obj;
348         const char *name = arg;
349
350         switch (match->match_type) {
351         case ACO_EXACT:
352                 return strcasecmp(name, match->name) ? 0 : CMP_MATCH | CMP_STOP;
353         case ACO_REGEX:
354                 return regexec(match->name_regex, name, 0, NULL, 0) ? 0 : CMP_MATCH | CMP_STOP;
355         }
356         ast_log(LOG_ERROR, "Unknown match type. This should not be possible.\n");
357         return CMP_STOP;
358 }
359
360 static struct aco_option *aco_option_find(struct aco_type *type, const char *name)
361 {
362         struct aco_option *opt;
363
364         if (!type || !type->internal || !type->internal->opts) {
365                 ast_log(LOG_NOTICE, "Attempting to use NULL or unitialized config type\n");
366                 return NULL;
367         }
368
369         /* Try an exact match with OBJ_KEY for the common/fast case, then iterate through
370          * all options for the regex cases */
371         if (!(opt = ao2_callback(type->internal->opts, OBJ_KEY, find_option_cb, (void *) name))) {
372                 opt = ao2_callback(type->internal->opts, 0, find_option_cb, (void *) name);
373         }
374         return opt;
375 }
376
377 struct ao2_container *aco_option_container_alloc(void)
378 {
379         return ao2_container_alloc(CONFIG_OPT_BUCKETS, config_opt_hash, config_opt_cmp);
380 }
381
382 static struct aco_type *internal_aco_type_find(struct aco_file *file, struct ast_config *cfg, const char *category)
383 {
384         size_t x;
385         struct aco_type *match;
386         const char *val;
387
388         for (x = 0, match = file->types[x]; match; match = file->types[++x]) {
389                 /* First make sure we are an object that can service this category */
390                 if (!regexec(match->internal->regex, category, 0, NULL, 0) == !match->category_match) {
391                         continue;
392                 }
393
394                 /* Then, see if we need to match a particular field */
395                 if (!ast_strlen_zero(match->matchfield) && (!ast_strlen_zero(match->matchvalue) || match->matchfunc)) {
396                         if (!(val = ast_variable_retrieve(cfg, category, match->matchfield))) {
397                                 ast_log(LOG_ERROR, "Required match field '%s' not found\n", match->matchfield);
398                                 return NULL;
399                         }
400                         if (match->matchfunc) {
401                                 if (!match->matchfunc(val)) {
402                                         continue;
403                                 }
404                         } else if (strcasecmp(val, match->matchvalue)) {
405                                 continue;
406                         }
407                 }
408                 /* If we get this far, we're a match */
409                 break;
410         }
411
412         return match;
413 }
414
415 static int is_preload(struct aco_file *file, const char *cat)
416 {
417         int i;
418
419         if (!file->preload) {
420                 return 0;
421         }
422
423         for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
424                 if (!strcasecmp(cat, file->preload[i])) {
425                         return 1;
426                 }
427         }
428         return 0;
429 }
430
431 static int process_category(struct ast_config *cfg, struct aco_info *info, struct aco_file *file, const char *cat, int preload) {
432         RAII_VAR(void *, new_item, NULL, ao2_cleanup);
433         struct aco_type *type;
434         /* For global types, field is the global option struct. For non-global, it is the container for items.
435          * We do not grab a reference to these objects, as the info already holds references to them. This
436          * pointer is just a convenience. Do not actually store it somewhere. */
437         void **field;
438
439         /* Skip preloaded categories if we aren't preloading */
440         if (!preload && is_preload(file, cat)) {
441                 return 0;
442         }
443
444         /* Find aco_type by category, if not found it is an error */
445         if (!(type = internal_aco_type_find(file, cfg, cat))) {
446                 ast_log(LOG_ERROR, "Could not find config type for category '%s' in '%s'\n", cat, file->filename);
447                 return -1;
448         }
449
450         field = info->internal->pending + type->item_offset;
451         if (!*field) {
452                 ast_log(LOG_ERROR, "No object to update!\n");
453                 return -1;
454         }
455
456         if (type->type == ACO_GLOBAL && *field) {
457                 if (aco_set_defaults(type, cat, *field)) {
458                         ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, cat);
459                         return -1;
460                 }
461                 if (aco_process_category_options(type, cfg, cat, *field)) {
462                         ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
463                         return -1;
464                 }
465         } else if (type->type == ACO_ITEM) {
466                 int new = 0;
467                 /* If we have multiple definitions of a category in a file, or can set the values from multiple
468                  * files, look up the entry if we've already added it so we can merge the values together.
469                  * Otherwise, alloc a new item. */
470                 if (*field) {
471                         if (!(new_item = type->item_find(*field, cat))) {
472                                 if (!(new_item = type->item_alloc(cat))) {
473                                         ast_log(LOG_ERROR, "In %s: Could not create item for %s\n", file->filename, cat);
474                                         return -1;
475                                 }
476                                 if (aco_set_defaults(type, cat, new_item)) {
477                                         ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, cat);
478                                         return -1;
479                                 }
480                                 new = 1;
481                         }
482                 }
483
484                 if (type->item_pre_process && type->item_pre_process(new_item)) {
485                         ast_log(LOG_ERROR, "In %s: Preprocess callback for %s failed\n", file->filename, cat);
486                         return -1;
487                 }
488
489                 if (aco_process_category_options(type, cfg, cat, new_item)) {
490                         ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
491                         return -1;
492                 }
493
494                 if (type->item_prelink && type->item_prelink(new_item)) {
495                         ast_log(LOG_ERROR, "In %s: Pre-link callback for %s failed\n", file->filename, cat);
496                         return -1;
497                 }
498
499                 if (new && !ao2_link(*field, new_item)) {
500                         ast_log(LOG_ERROR, "In %s: Linking config for %s failed\n", file->filename, cat);
501                         return -1;
502                 }
503         }
504         return 0;
505 }
506
507 static int apply_config(struct aco_info *info)
508 {
509         ao2_global_obj_replace_unref(*info->global_obj, info->internal->pending);
510
511         return 0;
512 }
513
514 static enum aco_process_status internal_process_ast_config(struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
515 {
516         const char *cat = NULL;
517
518         if (file->preload) {
519                 int i;
520                 for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
521                         if (process_category(cfg, info, file, file->preload[i], 1)) {
522                                 return ACO_PROCESS_ERROR;
523                         }
524                 }
525         }
526
527         while ((cat = ast_category_browse(cfg, cat))) {
528                 if (process_category(cfg, info, file, cat, 0)) {
529                         return ACO_PROCESS_ERROR;
530                 }
531         }
532         return ACO_PROCESS_OK;
533 }
534
535 enum aco_process_status aco_process_ast_config(struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
536 {
537         if (!info->internal) {
538                 ast_log(LOG_ERROR, "Attempt to process %s with uninitialized aco_info\n", file->filename);
539                 goto error;
540         }
541
542         if (!(info->internal->pending = info->snapshot_alloc())) {
543                 ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", file->filename);
544                 goto error;
545         }
546
547         if (internal_process_ast_config(info, file, cfg)) {
548                 goto error;
549         }
550
551         if (info->pre_apply_config && info->pre_apply_config()) {
552                 goto error;
553         }
554
555         if (apply_config(info)) {
556                 goto error;
557         };
558
559         ao2_cleanup(info->internal->pending);
560         return ACO_PROCESS_OK;
561
562 error:
563         ao2_cleanup(info->internal->pending);
564         return ACO_PROCESS_ERROR;
565 }
566
567 enum aco_process_status aco_process_config(struct aco_info *info, int reload)
568 {
569         struct ast_config *cfg;
570         struct ast_flags cfg_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0, };
571         int res = ACO_PROCESS_OK, x = 0;
572         struct aco_file *file;
573
574         if (!(info->files[0])) {
575                 ast_log(LOG_ERROR, "No filename given, cannot proceed!\n");
576                 return ACO_PROCESS_ERROR;
577         }
578
579         if (!info->internal) {
580                 ast_log(LOG_ERROR, "Attempting to process uninitialized aco_info\n");
581                 return ACO_PROCESS_ERROR;
582         }
583
584         if (!(info->internal->pending = info->snapshot_alloc())) {
585                 ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", info->module);
586                 return ACO_PROCESS_ERROR;
587         }
588
589         while (res != ACO_PROCESS_ERROR && (file = info->files[x++])) {
590                 const char *filename = file->filename;
591 try_alias:
592                 if (!(cfg = ast_config_load(filename, cfg_flags))) {
593                         if (file->alias && strcmp(file->alias, filename)) {
594                                 filename = file->alias;
595                                 goto try_alias;
596                         }
597                         ast_log(LOG_ERROR, "Unable to load config file '%s'\n", file->filename);
598                         res = ACO_PROCESS_ERROR;
599                         break;
600                 } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
601                         ast_debug(1, "%s was unchanged\n", file->filename);
602                         res = ACO_PROCESS_UNCHANGED;
603                         continue;
604                 } else if (cfg == CONFIG_STATUS_FILEINVALID) {
605                         ast_log(LOG_ERROR, "Contents of %s are invalid and cannot be parsed\n", file->filename);
606                         res = ACO_PROCESS_ERROR;
607                         break;
608                 } else if (cfg == CONFIG_STATUS_FILEMISSING) {
609                         if (file->alias && strcmp(file->alias, filename)) {
610                                 filename = file->alias;
611                                 goto try_alias;
612                         }
613                         ast_log(LOG_ERROR, "%s is missing! Cannot load %s\n", file->filename, info->module);
614                         res = ACO_PROCESS_ERROR;
615                         break;
616                 }
617
618                 res = internal_process_ast_config(info, file, cfg);
619                 ast_config_destroy(cfg);
620         }
621
622         if (res != ACO_PROCESS_OK) {
623                 goto end;
624         }
625
626         if (info->pre_apply_config && (info->pre_apply_config())) {
627                 res = ACO_PROCESS_ERROR;
628                 goto end;
629         }
630
631         if (apply_config(info)) {
632                 res = ACO_PROCESS_ERROR;
633                 goto end;
634         }
635
636         if (info->post_apply_config) {
637                 info->post_apply_config();
638         }
639
640 end:
641         ao2_cleanup(info->internal->pending);
642         return res;
643 }
644 int aco_process_var(struct aco_type *type, const char *cat, struct ast_variable *var, void *obj)
645 {
646         RAII_VAR(struct aco_option *, opt, aco_option_find(type, var->name), ao2_cleanup);
647         if (opt && opt->deprecated && !ast_strlen_zero(opt->aliased_to)) {
648                 const char *alias = ast_strdupa(opt->aliased_to);
649                 ast_log(LOG_WARNING, "At line %d of %s option '%s' is deprecated. Use '%s' instead\n", var->lineno, var->file, var->name, alias);
650                 ao2_ref(opt, -1);
651                 opt = aco_option_find(type, alias);
652         }
653
654         if (!opt) {
655                 ast_log(LOG_ERROR, "Could not find option suitable for category '%s' named '%s' at line %d of %s\n", cat, var->name, var->lineno, var->file);
656                 return -1;
657         }
658
659         if (!opt->handler) {
660                 /* It should be impossible for an option to not have a handler */
661                 ast_log(LOG_ERROR, "BUG! Somehow a config option for %s/%s was created with no handler!\n", cat, var->name);
662                 return -1;
663         }
664         if (opt->handler(opt, var, obj)) {
665                 ast_log(LOG_ERROR, "Error parsing %s=%s at line %d of %s\n", var->name, var->value, var->lineno, var->file);
666                 return -1;
667         }
668
669         return 0;
670 }
671
672 int aco_process_category_options(struct aco_type *type, struct ast_config *cfg, const char *cat, void *obj)
673 {
674         struct ast_variable *var;
675
676         for (var = ast_variable_browse(cfg, cat); var; var = var->next) {
677                 if (aco_process_var(type, cat, var, obj)) {
678                         return -1;
679                 }
680         }
681
682         return 0;
683 }
684
685 static void internal_type_destroy(struct aco_type *type)
686 {
687         /* If we've already had all our internal data cleared out,
688          * then there's no need to proceed further
689          */
690         if (!type->internal) {
691                 return;
692         }
693
694         if (type->internal->regex) {
695                 regfree(type->internal->regex);
696                 ast_free(type->internal->regex);
697         }
698         ao2_cleanup(type->internal->opts);
699         type->internal->opts = NULL;
700         ast_free(type->internal);
701         type->internal = NULL;
702 }
703
704 static void internal_file_types_destroy(struct aco_file *file)
705 {
706         size_t x;
707         struct aco_type *t;
708
709         for (x = 0, t = file->types[x]; t; t = file->types[++x]) {
710                 internal_type_destroy(t);
711                 t = NULL;
712         }
713 }
714
715 static int internal_type_init(struct aco_type *type)
716 {
717         if (!(type->internal = ast_calloc(1, sizeof(*type->internal)))) {
718                 return -1;
719         }
720
721         if (!(type->internal->regex = build_regex(type->category))) {
722                 internal_type_destroy(type);
723                 return -1;
724         }
725
726         if (!(type->internal->opts = aco_option_container_alloc())) {
727                 internal_type_destroy(type);
728                 return -1;
729         }
730
731         return 0;
732 }
733
734 int aco_info_init(struct aco_info *info)
735 {
736         size_t x = 0, y = 0;
737         struct aco_file *file;
738         struct aco_type *type;
739
740         if (!(info->internal = ast_calloc(1, sizeof(*info->internal)))) {
741                 return -1;
742         }
743
744         while ((file = info->files[x++])) {
745                 while ((type = file->types[y++])) {
746                         if (internal_type_init(type)) {
747                                 goto error;
748                         }
749 #ifdef AST_XML_DOCS
750                         if (xmldoc_update_config_type(info->module, type->name, type->category, type->matchfield, type->matchvalue, type->category_match == ACO_WHITELIST)) {
751                                 goto error;
752                         }
753 #endif /* AST_XML_DOCS */
754                 }
755                 y = 0;
756         }
757
758         return 0;
759 error:
760         aco_info_destroy(info);
761         return -1;
762 }
763
764 void aco_info_destroy(struct aco_info *info)
765 {
766         int x;
767         /* It shouldn't be possible for internal->pending to be in use when this is called because
768          * of the locks in loader.c around reloads and unloads and the fact that internal->pending
769          * only exists while those locks are held */
770         ast_free(info->internal);
771         info->internal = NULL;
772
773         for (x = 0; info->files[x]; x++) {
774                 internal_file_types_destroy(info->files[x]);
775         }
776 }
777
778 int aco_set_defaults(struct aco_type *type, const char *category, void *obj)
779 {
780         struct aco_option *opt;
781         struct ao2_iterator iter;
782
783         iter = ao2_iterator_init(type->internal->opts, 0);
784
785         while ((opt = ao2_iterator_next(&iter))) {
786                 RAII_VAR(struct ast_variable *, var, NULL, ast_variables_destroy);
787
788                 if (ast_strlen_zero(opt->default_val)) {
789                         ao2_ref(opt, -1);
790                         continue;
791                 }
792                 if (!(var = ast_variable_new(opt->name, opt->default_val, ""))) {
793                         ao2_ref(opt, -1);
794                         ao2_iterator_destroy(&iter);
795                         return -1;
796                 }
797                 if (opt->handler(opt, var, obj)) {
798                         ast_log(LOG_ERROR, "Unable to set default for %s, %s=%s\n", category, var->name, var->value);
799                         ao2_ref(opt, -1);
800                         ao2_iterator_destroy(&iter);
801                         return -1;
802                 }
803                 ao2_ref(opt, -1);
804         }
805         ao2_iterator_destroy(&iter);
806
807         return 0;
808 }
809
810 #ifdef AST_XML_DOCS
811
812 /*! \internal
813  * \brief Complete the name of the module the user is looking for
814  */
815 static char *complete_config_module(const char *word, int pos, int state)
816 {
817         char *c = NULL;
818         size_t wordlen = strlen(word);
819         int which = 0;
820         struct ao2_iterator i;
821         struct ast_xml_doc_item *cur;
822
823         if (pos != 3) {
824                 return NULL;
825         }
826
827         i = ao2_iterator_init(xmldocs, 0);
828         while ((cur = ao2_iterator_next(&i))) {
829                 if (!strncasecmp(word, cur->name, wordlen) && ++which > state) {
830                         c = ast_strdup(cur->name);
831                         ao2_ref(cur, -1);
832                         break;
833                 }
834                 ao2_ref(cur, -1);
835         }
836         ao2_iterator_destroy(&i);
837
838         return c;
839 }
840
841 /*! \internal
842  * \brief Complete the name of the configuration type the user is looking for
843  */
844 static char *complete_config_type(const char *module, const char *word, int pos, int state)
845 {
846         char *c = NULL;
847         size_t wordlen = strlen(word);
848         int which = 0;
849         RAII_VAR(struct ast_xml_doc_item *, info, NULL, ao2_cleanup);
850         struct ast_xml_doc_item *cur;
851
852         if (pos != 4) {
853                 return NULL;
854         }
855
856         if (!(info = ao2_find(xmldocs, module, OBJ_KEY))) {
857                 return NULL;
858         }
859
860         cur = info;
861         while ((cur = cur->next)) {
862                 if (!strcasecmp(cur->type, "configObject") && !strncasecmp(word, cur->name, wordlen) && ++which > state) {
863                         c = ast_strdup(cur->name);
864                         break;
865                 }
866         }
867         return c;
868 }
869
870 /*! \internal
871  * \brief Complete the name of the configuration option the user is looking for
872  */
873 static char *complete_config_option(const char *module, const char *option, const char *word, int pos, int state)
874 {
875         char *c = NULL;
876         size_t wordlen = strlen(word);
877         int which = 0;
878         RAII_VAR(struct ast_xml_doc_item *, info, NULL, ao2_cleanup);
879         struct ast_xml_doc_item *cur;
880
881         if (pos != 5) {
882                 return NULL;
883         }
884
885         if (!(info = ao2_find(xmldocs, module, OBJ_KEY))) {
886                 return NULL;
887         }
888
889         cur = info;
890         while ((cur = cur->next)) {
891                 if (!strcasecmp(cur->type, "configOption") && !strcasecmp(cur->ref, option) && !strncasecmp(word, cur->name, wordlen) && ++which > state) {
892                         c = ast_strdup(cur->name);
893                         break;
894                 }
895         }
896         return c;
897 }
898
899 /* Define as 0 if we want to allow configurations to be registered without
900  * documentation
901  */
902 #define XMLDOC_STRICT 0
903
904 /*! \internal
905  * \brief Update the XML documentation for a config type based on its registration
906  */
907 static int xmldoc_update_config_type(const char *module, const char *name, const char *category, const char *matchfield, const char *matchvalue, unsigned int matches)
908 {
909         RAII_VAR(struct ast_xml_xpath_results *, results, NULL, ast_xml_xpath_results_free);
910         RAII_VAR(struct ast_xml_doc_item *, config_info, ao2_find(xmldocs, module, OBJ_KEY), ao2_cleanup);
911         struct ast_xml_doc_item *config_type;
912         struct ast_xml_node *type, *syntax, *matchinfo, *tmp;
913
914         /* If we already have a syntax element, bail. This isn't an error, since we may unload a module which
915          * has updated the docs and then load it again. */
916         if ((results = ast_xmldoc_query("//configInfo[@name='%s']/*/configObject[@name='%s']/syntax", module, name))) {
917                 return 0;
918         }
919
920         if (!(results = ast_xmldoc_query("//configInfo[@name='%s']/*/configObject[@name='%s']", module, name))) {
921                 ast_log(LOG_WARNING, "Cannot update type '%s' in module '%s' because it has no existing documentation!\n", name, module);
922                 return XMLDOC_STRICT ? -1 : 0;
923         }
924
925         if (!(type = ast_xml_xpath_get_first_result(results))) {
926                 ast_log(LOG_WARNING, "Could not retrieve documentation for type '%s' in module '%s'\n", name, module);
927                 return XMLDOC_STRICT ? -1 : 0;
928         }
929
930         if (!(syntax = ast_xml_new_child(type, "syntax"))) {
931                 ast_log(LOG_WARNING, "Could not create syntax node for type '%s' in module '%s'\n", name, module);
932                 return XMLDOC_STRICT ? -1 : 0;
933         }
934
935         if (!(matchinfo = ast_xml_new_child(syntax, "matchInfo"))) {
936                 ast_log(LOG_WARNING, "Could not create matchInfo node for type '%s' in module '%s'\n", name, module);
937                 return XMLDOC_STRICT ? -1 : 0;
938         }
939
940         if (!(tmp = ast_xml_new_child(matchinfo, "category"))) {
941                 ast_log(LOG_WARNING, "Could not create category node for type '%s' in module '%s'\n", name, module);
942                 return XMLDOC_STRICT ? -1 : 0;
943         }
944
945         ast_xml_set_text(tmp, category);
946         ast_xml_set_attribute(tmp, "match", matches ? "true" : "false");
947
948         if (!ast_strlen_zero(matchfield) && !(tmp = ast_xml_new_child(matchinfo, "field"))) {
949                 ast_log(LOG_WARNING, "Could not add %s attribute for type '%s' in module '%s'\n", matchfield, name, module);
950                 return XMLDOC_STRICT ? -1 : 0;
951         }
952
953         ast_xml_set_attribute(tmp, "name", matchfield);
954         ast_xml_set_text(tmp, matchvalue);
955
956         if (!config_info || !(config_type = find_xmldoc_type(config_info, name))) {
957                 ast_log(LOG_WARNING, "Could not obtain XML documentation item for config type %s\n", name);
958                 return XMLDOC_STRICT ? -1 : 0;
959         }
960
961         if (ast_xmldoc_regenerate_doc_item(config_type)) {
962                 ast_log(LOG_WARNING, "Could not update type '%s' with values from config type registration\n", name);
963                 return XMLDOC_STRICT ? -1 : 0;
964         }
965
966         return 0;
967 }
968
969 /*! \internal
970  * \brief Update the XML documentation for a config option based on its registration
971  */
972 static int xmldoc_update_config_option(struct aco_type **types, const char *module, const char *name, const char *object_name, const char *default_value, unsigned int regex, enum aco_option_type type)
973 {
974         RAII_VAR(struct ast_xml_xpath_results *, results, NULL, ast_xml_xpath_results_free);
975         RAII_VAR(struct ast_xml_doc_item *, config_info, ao2_find(xmldocs, module, OBJ_KEY), ao2_cleanup);
976         struct ast_xml_doc_item * config_option;
977         struct ast_xml_node *option;
978
979         ast_assert(ARRAY_LEN(aco_option_type_string) > type);
980
981         if (!config_info || !(config_option = find_xmldoc_option(config_info, types, name))) {
982                 ast_log(LOG_ERROR, "XML Documentation for option '%s' in modules '%s' not found!\n", name, module);
983                 return XMLDOC_STRICT ? -1 : 0;
984         }
985
986         if (!(results = ast_xmldoc_query("//configInfo[@name='%s']/*/configObject[@name='%s']/configOption[@name='%s']", module, object_name, name))) {
987                 ast_log(LOG_WARNING, "Could not find option '%s' with type '%s' in module '%s'\n", name, object_name, module);
988                 return XMLDOC_STRICT ? -1 : 0;
989         }
990
991         if (!(option = ast_xml_xpath_get_first_result(results))) {
992                 ast_log(LOG_WARNING, "Could obtain results for option '%s' with type '%s' in module '%s'\n", name, object_name, module);
993                 return XMLDOC_STRICT ? -1 : 0;
994         }
995         ast_xml_set_attribute(option, "regex", regex ? "true" : "false");
996         ast_xml_set_attribute(option, "default", default_value);
997         ast_xml_set_attribute(option, "type", aco_option_type_string[type]);
998
999         if (ast_xmldoc_regenerate_doc_item(config_option)) {
1000                 ast_log(LOG_WARNING, "Could not update option '%s' with values from config option registration\n", name);
1001                 return XMLDOC_STRICT ? -1 : 0;
1002         }
1003
1004         return 0;
1005 }
1006
1007 /*! \internal
1008  * \brief Show the modules with configuration information
1009  */
1010 static void cli_show_modules(struct ast_cli_args *a)
1011 {
1012         struct ast_xml_doc_item *item;
1013         struct ao2_iterator it_items;
1014
1015         ast_assert(a->argc == 3);
1016
1017         if (ao2_container_count(xmldocs) == 0) {
1018                 ast_cli(a->fd, "No modules found.\n");
1019                 return;
1020         }
1021
1022         it_items = ao2_iterator_init(xmldocs, 0);
1023         ast_cli(a->fd, "The following modules have configuration information:\n");
1024         while ((item = ao2_iterator_next(&it_items))) {
1025                 ast_cli(a->fd, "\t%s\n", item->name);
1026                 ao2_ref(item, -1);
1027         }
1028         ao2_iterator_destroy(&it_items);
1029 }
1030
1031 /*! \internal
1032  * \brief Show the configuration types for a module
1033  */
1034 static void cli_show_module_types(struct ast_cli_args *a)
1035 {
1036         RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
1037         struct ast_xml_doc_item *tmp;
1038
1039         ast_assert(a->argc == 4);
1040
1041         if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
1042                 ast_cli(a->fd, "Module %s not found.\n", a->argv[3]);
1043                 return;
1044         }
1045
1046         if (ast_str_strlen(item->synopsis)) {
1047                 ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(item->synopsis), 1));
1048         }
1049         if (ast_str_strlen(item->description)) {
1050                 ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(item->description), 1));
1051         }
1052
1053         tmp = item;
1054         ast_cli(a->fd, "Configuration option types for %s:\n", tmp->name);
1055         while ((tmp = tmp->next)) {
1056                 if (!strcasecmp(tmp->type, "configObject")) {
1057                         ast_cli(a->fd, "%-25s -- %-65.65s\n", tmp->name,
1058                                 ast_str_buffer(tmp->synopsis));
1059                 }
1060         }
1061 }
1062
1063 /*! \internal
1064  * \brief Show the information for a configuration type
1065  */
1066 static void cli_show_module_type(struct ast_cli_args *a)
1067 {
1068         RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
1069         struct ast_xml_doc_item *tmp;
1070         char option_type[64];
1071         int match = 0;
1072
1073         ast_assert(a->argc == 5);
1074
1075         if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
1076                 ast_cli(a->fd, "Unknown module %s\n", a->argv[3]);
1077                 return;
1078         }
1079
1080         tmp = item;
1081         while ((tmp = tmp->next)) {
1082                 if (!strcasecmp(tmp->type, "configObject") && !strcasecmp(tmp->name, a->argv[4])) {
1083                         match = 1;
1084                         term_color(option_type, tmp->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(option_type));
1085                         ast_cli(a->fd, "%s", option_type);
1086                         if (ast_str_strlen(tmp->syntax)) {
1087                                 ast_cli(a->fd, ": [%s]\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->syntax), 1));
1088                         } else {
1089                                 ast_cli(a->fd, "\n\n");
1090                         }
1091                         if (ast_str_strlen(tmp->synopsis)) {
1092                                 ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->synopsis), 1));
1093                         }
1094                         if (ast_str_strlen(tmp->description)) {
1095                                 ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->description), 1));
1096                         }
1097                 }
1098         }
1099
1100         if (!match) {
1101                 ast_cli(a->fd, "Unknown configuration type %s\n", a->argv[4]);
1102                 return;
1103         }
1104
1105         /* Now iterate over the options for the type */
1106         tmp = item;
1107         while ((tmp = tmp->next)) {
1108                 if (!strcasecmp(tmp->type, "configOption") && !strcasecmp(tmp->ref, a->argv[4])) {
1109                         ast_cli(a->fd, "%-25s -- %-65.65s\n", tmp->name,
1110                                         ast_str_buffer(tmp->synopsis));
1111                 }
1112         }
1113 }
1114
1115 /*! \internal
1116  * \brief Show detailed information for an option
1117  */
1118 static void cli_show_module_options(struct ast_cli_args *a)
1119 {
1120         RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
1121         struct ast_xml_doc_item *tmp;
1122         char option_name[64];
1123         int match = 0;
1124
1125         ast_assert(a->argc == 6);
1126
1127         if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
1128                 ast_cli(a->fd, "Unknown module %s\n", a->argv[3]);
1129                 return;
1130         }
1131         tmp = item;
1132         while ((tmp = tmp->next)) {
1133                 if (!strcasecmp(tmp->type, "configOption") && !strcasecmp(tmp->ref, a->argv[4]) && !strcasecmp(tmp->name, a->argv[5])) {
1134                         if (match) {
1135                                 ast_cli(a->fd, "\n");
1136                         }
1137                         term_color(option_name, tmp->ref, COLOR_MAGENTA, COLOR_BLACK, sizeof(option_name));
1138                         ast_cli(a->fd, "[%s%s]\n", option_name, term_end());
1139                         if (ast_str_strlen(tmp->syntax)) {
1140                                 ast_cli(a->fd, "%s\n", ast_xmldoc_printable(ast_str_buffer(tmp->syntax), 1));
1141                         }
1142                         ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(AS_OR(tmp->synopsis, "No information available"), 1));
1143                         if (ast_str_strlen(tmp->description)) {
1144                                 ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->description), 1));
1145                         }
1146
1147                         match = 1;
1148                 }
1149         }
1150
1151         if (!match) {
1152                 ast_cli(a->fd, "No option %s found for %s:%s\n", a->argv[5], a->argv[3], a->argv[4]);
1153         }
1154 }
1155
1156 static char *cli_show_help(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1157 {
1158         switch (cmd) {
1159         case CLI_INIT:
1160                 e->command = "config show help";
1161                 e->usage =
1162                         "Usage: config show help [<module> [<type> [<option>]]]\n"
1163                         "   Display detailed information about module configuration.\n"
1164                         "     * If nothing is specified, the modules that have\n"
1165                         "       configuration information are listed.\n"
1166                         "     * If <module> is specified, the configuration types\n"
1167                         "       for that module will be listed, along with brief\n"
1168                         "       information about that type.\n"
1169                         "     * If <module> and <type> are specified, detailed\n"
1170                         "       information about the type is displayed, as well\n"
1171                         "       as the available options.\n"
1172                         "     * If <module>, <type>, and <option> are specified,\n"
1173                         "       detailed information will be displayed about that\n"
1174                         "       option.\n"
1175                         "   NOTE: the help documentation is partially generated at run\n"
1176                         "     time when a module is loaded. If a module is not loaded,\n"
1177                         "     configuration help for that module may be incomplete.\n";
1178                 return NULL;
1179         case CLI_GENERATE:
1180                 switch(a->pos) {
1181                 case 3: return complete_config_module(a->word, a->pos, a->n);
1182                 case 4: return complete_config_type(a->argv[3], a->word, a->pos, a->n);
1183                 case 5: return complete_config_option(a->argv[3], a->argv[4], a->word, a->pos, a->n);
1184                 default: return NULL;
1185                 }
1186         }
1187
1188         switch (a->argc) {
1189         case 3:
1190                 cli_show_modules(a);
1191                 break;
1192         case 4:
1193                 cli_show_module_types(a);
1194                 break;
1195         case 5:
1196                 cli_show_module_type(a);
1197                 break;
1198         case 6:
1199                 cli_show_module_options(a);
1200                 break;
1201         default:
1202                 return CLI_SHOWUSAGE;
1203         }
1204
1205         return CLI_SUCCESS;
1206 }
1207
1208 static struct ast_cli_entry cli_aco[] = {
1209         AST_CLI_DEFINE(cli_show_help, "Show configuration help for a module"),
1210 };
1211
1212 static void aco_deinit(void)
1213 {
1214         ast_cli_unregister(cli_aco);
1215         ao2_cleanup(xmldocs);
1216 }
1217 #endif /* AST_XML_DOCS */
1218
1219 int aco_init(void)
1220 {
1221 #ifdef AST_XML_DOCS
1222         ast_register_atexit(aco_deinit);
1223         if (!(xmldocs = ast_xmldoc_build_documentation("configInfo"))) {
1224                 ast_log(LOG_ERROR, "Couldn't build config documentation\n");
1225                 return -1;
1226         }
1227         ast_cli_register_multiple(cli_aco, ARRAY_LEN(cli_aco));
1228 #endif /* AST_XML_DOCS */
1229         return 0;
1230 }
1231
1232 /* Default config option handlers */
1233
1234 /*! \brief Default option handler for signed integers
1235  * \note For a description of the opt->flags and opt->args values, see the documentation for
1236  * enum aco_option_type in config_options.h
1237  */
1238 static int int_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj) {
1239         int *field = (int *)(obj + opt->args[0]);
1240         unsigned int flags = PARSE_INT32 | opt->flags;
1241         int res = 0;
1242         if (opt->flags & PARSE_IN_RANGE) {
1243                 res = opt->flags & PARSE_DEFAULT ?
1244                         ast_parse_arg(var->value, flags, field, (int) opt->args[1], (int) opt->args[2], opt->args[3]) :
1245                         ast_parse_arg(var->value, flags, field, (int) opt->args[1], (int) opt->args[2]);
1246                 if (res) {
1247                         if (opt->flags & PARSE_RANGE_DEFAULTS) {
1248                                 ast_log(LOG_WARNING, "Failed to set %s=%s. Set to %d instead due to range limit (%d, %d)\n", var->name, var->value, *field, (int) opt->args[1], (int) opt->args[2]);
1249                                 res = 0;
1250                         } else if (opt->flags & PARSE_DEFAULT) {
1251                                 ast_log(LOG_WARNING, "Failed to set %s=%s, Set to default value %d instead.\n", var->name, var->value, *field);
1252                                 res = 0;
1253                         }
1254                 }
1255         } else if ((opt->flags & PARSE_DEFAULT) && ast_parse_arg(var->value, flags, field, (int) opt->args[1])) {
1256                 ast_log(LOG_WARNING, "Attempted to set %s=%s, but set it to %d instead due to default)\n", var->name, var->value, *field);
1257         } else {
1258                 res = ast_parse_arg(var->value, flags, field);
1259         }
1260
1261         return res;
1262 }
1263
1264 /*! \brief Default option handler for unsigned integers
1265  * \note For a description of the opt->flags and opt->args values, see the documentation for
1266  * enum aco_option_type in config_options.h
1267  */
1268 static int uint_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj) {
1269         unsigned int *field = (unsigned int *)(obj + opt->args[0]);
1270         unsigned int flags = PARSE_INT32 | opt->flags;
1271         int res = 0;
1272         if (opt->flags & PARSE_IN_RANGE) {
1273                 res = opt->flags & PARSE_DEFAULT ?
1274                         ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1], (unsigned int) opt->args[2], opt->args[3]) :
1275                         ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1], (unsigned int) opt->args[2]);
1276                 if (res) {
1277                         if (opt->flags & PARSE_RANGE_DEFAULTS) {
1278                                 ast_log(LOG_WARNING, "Failed to set %s=%s. Set to %d instead due to range limit (%d, %d)\n", var->name, var->value, *field, (int) opt->args[1], (int) opt->args[2]);
1279                                 res = 0;
1280                         } else if (opt->flags & PARSE_DEFAULT) {
1281                                 ast_log(LOG_WARNING, "Failed to set %s=%s, Set to default value %d instead.\n", var->name, var->value, *field);
1282                                 res = 0;
1283                         }
1284                 }
1285         } else if ((opt->flags & PARSE_DEFAULT) && ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1])) {
1286                 ast_log(LOG_WARNING, "Attempted to set %s=%s, but set it to %u instead due to default)\n", var->name, var->value, *field);
1287         } else {
1288                 res = ast_parse_arg(var->value, flags, field);
1289         }
1290
1291         return res;
1292 }
1293
1294 /*! \brief Default option handler for doubles
1295  * \note For a description of the opt->flags and opt->args values, see the documentation for
1296  * enum aco_option_type in config_options.h
1297  */
1298 static int double_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj) {
1299         double *field = (double *)(obj + opt->args[0]);
1300         return ast_parse_arg(var->value, PARSE_DOUBLE | opt->flags, field);
1301 }
1302
1303 /*! \brief Default handler for ACLs
1304  * \note For a description of the opt->flags and opt->args values, see the documentation for
1305  * enum aco_option_type in config_options.h
1306  */
1307 static int acl_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj) {
1308         struct ast_ha **ha = (struct ast_ha **)(obj + opt->args[0]);
1309         int error = 0;
1310         *ha = ast_append_ha(opt->flags ? "permit" : "deny", var->value, *ha, &error);
1311         return error;
1312 }
1313
1314 /*! \brief Default option handler for codec preferences/capabilities
1315  * \note For a description of the opt->flags and opt->args values, see the documentation for
1316  * enum aco_option_type in config_options.h
1317  */
1318 static int codec_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj) {
1319         struct ast_codec_pref *pref = (struct ast_codec_pref *)(obj + opt->args[0]);
1320         struct ast_format_cap **cap = (struct ast_format_cap **)(obj + opt->args[1]);
1321         return ast_parse_allow_disallow(pref, *cap, var->value, opt->flags);
1322 }
1323
1324 /*! \brief Default option handler for stringfields
1325  * \note For a description of the opt->flags and opt->args values, see the documentation for
1326  * enum aco_option_type in config_options.h
1327  */
1328 static int stringfield_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1329 {
1330         ast_string_field *field = (const char **)(obj + opt->args[0]);
1331         struct ast_string_field_pool **pool = (struct ast_string_field_pool **)(obj + opt->args[1]);
1332         struct ast_string_field_mgr *mgr = (struct ast_string_field_mgr *)(obj + opt->args[2]);
1333         ast_string_field_ptr_set_by_fields(*pool, *mgr, field, var->value);
1334         return 0;
1335 }
1336
1337 /*! \brief Default option handler for bools (ast_true/ast_false)
1338  * \note For a description of the opt->flags and opt->args values, see the documentation for
1339  * enum aco_option_type in config_options.h
1340  */
1341 static int bool_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1342 {
1343         unsigned int *field = (unsigned int *)(obj + opt->args[0]);
1344         *field = opt->flags ? ast_true(var->value) : ast_false(var->value);
1345         return 0;
1346 }
1347
1348 /*! \brief Default option handler for bools (ast_true/ast_false) that are stored as flags
1349  * \note For a description of the opt->flags and opt->args values, see the documentation for
1350  * enum aco_option_type in config_options.h
1351  */
1352 static int boolflag_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1353 {
1354         unsigned int *flags_field = (unsigned int *)(obj + opt->args[0]);
1355         unsigned int val = opt->flags ? ast_true(var->value) : ast_false(var->value);
1356         unsigned int flag = opt->args[1];
1357         if (val) {
1358                 *flags_field |= flag;
1359         } else {
1360                 *flags_field &= ~flag;
1361         }
1362         return 0;
1363 }
1364
1365 /*! \brief Default handler for ast_sockaddrs
1366  * \note For a description of the opt->flags and opt->args values, see the documentation for
1367  * enum aco_option_type in config_options.h
1368  */
1369 static int sockaddr_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1370 {
1371         struct ast_sockaddr *field = (struct ast_sockaddr *)(obj + opt->args[0]);
1372         return ast_parse_arg(var->value, PARSE_ADDR | opt->flags, field);
1373 }
1374
1375 /*! \brief Default handler for doing noithing
1376  */
1377 static int noop_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1378 {
1379         return 0;
1380 }
1381
1382 /*! \brief Default handler for character arrays
1383  * \note For a description of the opt->flags and opt->args values, see the documentation for
1384  * enum aco_option_type in config_options.h
1385  */
1386 static int chararray_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj)
1387 {
1388         char *field = (char *)(obj + opt->args[0]);
1389         size_t len = opt->args[1];
1390
1391         ast_copy_string(field, var->value, len);
1392         return 0;
1393 }