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