forked from asterisk/asterisk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig_options.c
1639 lines (1416 loc) · 47.9 KB
/
config_options.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2012, Digium, Inc.
*
* Mark Spencer <[email protected]>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
* \brief Configuration Option-handling
* \author Terry Wilson <[email protected]>
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
#include <regex.h>
#include "asterisk/_private.h"
#include "asterisk/config.h"
#include "asterisk/config_options.h"
#include "asterisk/stringfields.h"
#include "asterisk/acl.h"
#include "asterisk/app.h"
#include "asterisk/frame.h"
#include "asterisk/xmldoc.h"
#include "asterisk/cli.h"
#include "asterisk/term.h"
#include "asterisk/format_cap.h"
#ifdef LOW_MEMORY
#define CONFIG_OPT_BUCKETS 5
#else
#define CONFIG_OPT_BUCKETS 53
#endif /* LOW_MEMORY */
/*! \brief Bits of aco_info that shouldn't be assigned outside this file
* \internal
*/
struct aco_info_internal {
void *pending; /*!< The user-defined config object awaiting application */
};
struct aco_type_internal {
regex_t *regex;
struct ao2_container *opts; /*!< The container of options registered to the aco_info */
};
struct aco_option {
const char *name;
const char *aliased_to;
const char *default_val;
enum aco_matchtype match_type;
regex_t *name_regex;
struct aco_type **obj;
enum aco_option_type type;
aco_option_handler handler;
unsigned int flags;
unsigned int no_doc:1;
#ifdef AST_DEVMODE
unsigned int doc_unavailable:1;
#endif
unsigned char deprecated:1;
size_t argc;
intptr_t args[0];
};
#ifdef AST_XML_DOCS
static struct ao2_container *xmldocs;
/*! \brief Value of the aco_option_type enum as strings */
static char *aco_option_type_string[] = {
"ACL", /* OPT_ACL_T, */
"Boolean", /* OPT_BOOL_T, */
"Boolean", /* OPT_BOOLFLAG_T, */
"String", /* OPT_CHAR_ARRAY_T, */
"Codec", /* OPT_CODEC_T, */
"Custom", /* OPT_CUSTOM_T, */
"Double", /* OPT_DOUBLE_T, */
"Integer", /* OPT_INT_T, */
"None", /* OPT_NOOP_T, */
"IP Address", /* OPT_SOCKADDR_T, */
"String", /* OPT_STRINGFIELD_T, */
"Unsigned Integer", /* OPT_UINT_T, */
"Boolean", /* OPT_YESNO_T, */
"Time Length", /* OPT_TIMELEN_T, */
};
#endif /* AST_XML_DOCS */
void *aco_pending_config(struct aco_info *info)
{
if (!(info && info->internal)) {
ast_log(LOG_ERROR, "This may not be called without an initialized aco_info!\n");
return NULL;
}
return info->internal->pending;
}
static void config_option_destroy(void *obj)
{
struct aco_option *opt = obj;
if (opt->match_type == ACO_REGEX && opt->name_regex) {
regfree(opt->name_regex);
ast_free(opt->name_regex);
}
}
static int int_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int uint_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int timelen_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int double_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int sockaddr_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int stringfield_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int bool_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int boolflag_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int acl_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int codec_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int noop_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
static int chararray_handler_fn(const struct aco_option *opt, struct ast_variable *var, void *obj);
#ifdef AST_XML_DOCS
static int xmldoc_update_config_type(const char *module, const char *name, const char *category, const char *matchfield, const char *matchvalue, enum aco_category_op category_match);
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);
#endif
static aco_option_handler ast_config_option_default_handler(enum aco_option_type type)
{
switch(type) {
case OPT_ACL_T: return acl_handler_fn;
case OPT_BOOL_T: return bool_handler_fn;
/* Reading from config files, BOOL and YESNO are handled exactly the
* same. Their difference is in how they are rendered to users
*/
case OPT_YESNO_T: return bool_handler_fn;
case OPT_BOOLFLAG_T: return boolflag_handler_fn;
case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
case OPT_CODEC_T: return codec_handler_fn;
case OPT_DOUBLE_T: return double_handler_fn;
case OPT_INT_T: return int_handler_fn;
case OPT_NOOP_T: return noop_handler_fn;
case OPT_SOCKADDR_T: return sockaddr_handler_fn;
case OPT_STRINGFIELD_T: return stringfield_handler_fn;
case OPT_UINT_T: return uint_handler_fn;
case OPT_TIMELEN_T: return timelen_handler_fn;
case OPT_CUSTOM_T: return NULL;
}
return NULL;
}
static regex_t *build_regex(const char *text)
{
int res;
regex_t *regex;
if (!(regex = ast_malloc(sizeof(*regex)))) {
return NULL;
}
if ((res = regcomp(regex, text, REG_EXTENDED | REG_ICASE | REG_NOSUB))) {
size_t len = regerror(res, regex, NULL, 0);
char buf[len];
regerror(res, regex, buf, len);
ast_log(LOG_ERROR, "Could not compile regex '%s': %s\n", text, buf);
ast_free(regex);
return NULL;
}
return regex;
}
static int link_option_to_types(struct aco_info *info, struct aco_type **types, struct aco_option *opt)
{
size_t idx = 0;
struct aco_type *type;
while ((type = types[idx++])) {
if (!type->internal) {
ast_log(LOG_ERROR, "Attempting to register option using uninitialized type\n");
return -1;
}
if (!ao2_link(type->internal->opts, opt)) {
do {
ao2_unlink(types[idx - 1]->internal->opts, opt);
} while (--idx);
return -1;
}
#ifdef AST_XML_DOCS
if (!info->hidden && !opt->no_doc &&
xmldoc_update_config_option(types, info->module, opt->name, type->name, opt->default_val, opt->match_type == ACO_REGEX, opt->type)) {
#ifdef AST_DEVMODE
opt->doc_unavailable = 1;
#endif
}
#endif
}
/* The container(s) should hold the only ref to opt */
ao2_ref(opt, -1);
return 0;
}
int aco_option_register_deprecated(struct aco_info *info, const char *name, struct aco_type **types, const char *aliased_to)
{
struct aco_option *opt;
if (!info || ast_strlen_zero(name) || ast_strlen_zero(aliased_to)) {
return -1;
}
opt = ao2_alloc_options(sizeof(*opt), config_option_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
if (!opt) {
return -1;
}
opt->name = name;
opt->aliased_to = aliased_to;
opt->deprecated = 1;
opt->match_type = ACO_EXACT;
if (link_option_to_types(info, types, opt)) {
ao2_ref(opt, -1);
return -1;
}
return 0;
}
unsigned int aco_option_get_flags(const struct aco_option *option)
{
return option->flags;
}
intptr_t aco_option_get_argument(const struct aco_option *option, unsigned int position)
{
return option->args[position];
}
#ifdef AST_XML_DOCS
/*! \internal
* \brief Find a particular ast_xml_doc_item from it's parent config_info, types, and name
*/
static struct ast_xml_doc_item *find_xmldoc_option(struct ast_xml_doc_item *config_info, struct aco_type **types, const char *name)
{
struct ast_xml_doc_item *iter = config_info;
if (!iter) {
return NULL;
}
/* First is just the configInfo, we can skip it */
while ((iter = AST_LIST_NEXT(iter, next))) {
size_t x;
if (strcasecmp(iter->name, name)) {
continue;
}
for (x = 0; types[x]; x++) {
/* All we care about is that at least one type has the option */
if (!strcasecmp(types[x]->name, iter->ref)) {
return iter;
}
}
}
return NULL;
}
/*! \internal
* \brief Find a particular ast_xml_doc_item from it's parent config_info and name
*/
static struct ast_xml_doc_item *find_xmldoc_type(struct ast_xml_doc_item *config_info, const char *name)
{
struct ast_xml_doc_item *iter = config_info;
if (!iter) {
return NULL;
}
/* First is just the config Info, skip it */
while ((iter = AST_LIST_NEXT(iter, next))) {
if (!strcasecmp(iter->type, "configObject") && !strcasecmp(iter->name, name)) {
break;
}
}
return iter;
}
#endif /* AST_XML_DOCS */
int __aco_option_register(struct aco_info *info, const char *name, enum aco_matchtype matchtype, struct aco_type **types,
const char *default_val, enum aco_option_type kind, aco_option_handler handler, unsigned int flags,
unsigned int no_doc, size_t argc, ...)
{
struct aco_option *opt;
va_list ap;
int tmp;
/* Custom option types require a handler */
if (!handler && kind == OPT_CUSTOM_T) {
return -1;
}
if (!(types && types[0])) {
return -1;
}
opt = ao2_alloc_options(sizeof(*opt) + argc * sizeof(opt->args[0]),
config_option_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
if (!opt) {
return -1;
}
if (matchtype == ACO_REGEX && !(opt->name_regex = build_regex(name))) {
ao2_ref(opt, -1);
return -1;
}
va_start(ap, argc);
for (tmp = 0; tmp < argc; tmp++) {
opt->args[tmp] = va_arg(ap, size_t);
}
va_end(ap);
opt->name = name;
opt->match_type = matchtype;
opt->default_val = default_val;
opt->type = kind;
opt->handler = handler;
opt->flags = flags;
opt->argc = argc;
opt->no_doc = no_doc;
if (!opt->handler && !(opt->handler = ast_config_option_default_handler(opt->type))) {
/* This should never happen */
ast_log(LOG_ERROR, "No handler provided, and no default handler exists for type %u\n", opt->type);
ao2_ref(opt, -1);
return -1;
};
if (link_option_to_types(info, types, opt)) {
ao2_ref(opt, -1);
return -1;
}
return 0;
}
static int config_opt_hash(const void *obj, const int flags)
{
const struct aco_option *opt = obj;
const char *name = (flags & OBJ_KEY) ? obj : opt->name;
return ast_str_case_hash(name);
}
static int config_opt_cmp(void *obj, void *arg, int flags)
{
struct aco_option *opt1 = obj, *opt2 = arg;
const char *name = (flags & OBJ_KEY) ? arg : opt2->name;
return strcasecmp(opt1->name, name) ? 0 : CMP_MATCH | CMP_STOP;
}
static int find_option_cb(void *obj, void *arg, int flags)
{
struct aco_option *match = obj;
const char *name = arg;
switch (match->match_type) {
case ACO_EXACT:
return strcasecmp(name, match->name) ? 0 : CMP_MATCH | CMP_STOP;
case ACO_PREFIX:
return strncasecmp(name, match->name, strlen(match->name)) ? 0 : CMP_MATCH | CMP_STOP;
case ACO_REGEX:
return regexec(match->name_regex, name, 0, NULL, 0) ? 0 : CMP_MATCH | CMP_STOP;
}
ast_log(LOG_ERROR, "Unknown match type. This should not be possible.\n");
return CMP_STOP;
}
static struct aco_option *aco_option_find(struct aco_type *type, const char *name)
{
struct aco_option *opt;
if (!type || !type->internal || !type->internal->opts) {
ast_log(LOG_NOTICE, "Attempting to use NULL or unitialized config type\n");
return NULL;
}
/* Try an exact match with OBJ_KEY for the common/fast case, then iterate through
* all options for the regex cases */
if (!(opt = ao2_callback(type->internal->opts, OBJ_KEY, find_option_cb, (void *) name))) {
opt = ao2_callback(type->internal->opts, 0, find_option_cb, (void *) name);
}
return opt;
}
struct ao2_container *aco_option_container_alloc(void)
{
return ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, CONFIG_OPT_BUCKETS,
config_opt_hash, NULL, config_opt_cmp);
}
static int internal_aco_type_category_check(struct aco_type *match, const char *category)
{
const char **categories = (const char **)match->category;
switch (match->category_match) {
case ACO_WHITELIST:
return regexec(match->internal->regex, category, 0, NULL, 0);
case ACO_BLACKLIST:
return !regexec(match->internal->regex, category, 0, NULL, 0);
case ACO_WHITELIST_EXACT:
return strcasecmp(match->category, category);
case ACO_BLACKLIST_EXACT:
return !strcasecmp(match->category, category);
case ACO_WHITELIST_ARRAY:
while (*categories) {
if (!strcasecmp(*categories, category)) {
return 0;
}
categories++;
}
return -1;
case ACO_BLACKLIST_ARRAY:
while (*categories) {
if (!strcasecmp(*categories, category)) {
return -1;
}
categories++;
}
return 0;
}
return -1;
}
static struct aco_type *internal_aco_type_find(struct aco_file *file, struct ast_config *cfg, const char *category)
{
size_t x;
struct aco_type *match;
const char *val;
for (x = 0, match = file->types[x]; match; match = file->types[++x]) {
/* First make sure we are an object that can service this category */
if (internal_aco_type_category_check(match, category)) {
continue;
}
/* Then, see if we need to match a particular field */
if (!ast_strlen_zero(match->matchfield) && (!ast_strlen_zero(match->matchvalue) || match->matchfunc)) {
if (!(val = ast_variable_retrieve(cfg, category, match->matchfield))) {
ast_log(LOG_ERROR, "Required match field '%s' not found\n", match->matchfield);
return NULL;
}
if (match->matchfunc) {
if (!match->matchfunc(val)) {
continue;
}
} else if (strcasecmp(val, match->matchvalue)) {
continue;
}
}
/* If we get this far, we're a match */
break;
}
return match;
}
static int is_preload(struct aco_file *file, const char *cat)
{
int i;
if (!file->preload) {
return 0;
}
for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
if (!strcasecmp(cat, file->preload[i])) {
return 1;
}
}
return 0;
}
static int process_category(struct ast_config *cfg, struct aco_info *info, struct aco_file *file, const char *cat, int preload) {
RAII_VAR(void *, new_item, NULL, ao2_cleanup);
struct aco_type *type;
/* For global types, field is the global option struct. For non-global, it is the container for items.
* We do not grab a reference to these objects, as the info already holds references to them. This
* pointer is just a convenience. Do not actually store it somewhere. */
void **field;
regex_t *regex_skip;
/* Skip preloaded categories if we aren't preloading */
if (!preload && is_preload(file, cat)) {
return 0;
}
/* Skip the category if we've been told to ignore it */
if (!ast_strlen_zero(file->skip_category)) {
regex_skip = build_regex(file->skip_category);
if (!regexec(regex_skip, cat, 0, NULL, 0)) {
regfree(regex_skip);
ast_free(regex_skip);
return 0;
}
regfree(regex_skip);
ast_free(regex_skip);
}
/* Find aco_type by category, if not found it is an error */
if (!(type = internal_aco_type_find(file, cfg, cat))) {
ast_log(LOG_ERROR, "Could not find config type for category '%s' in '%s'\n", cat, file->filename);
return -1;
}
if (type->type == ACO_IGNORE) {
return 0;
}
field = info->internal->pending + type->item_offset;
if (!*field) {
ast_log(LOG_ERROR, "In %s: %s - No object to update!\n", file->filename, cat);
return -1;
}
if (type->type == ACO_GLOBAL && *field) {
if (aco_process_category_options(type, cfg, cat, *field)) {
ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
return -1;
}
} else if (type->type == ACO_ITEM) {
int new = 0;
/* If we have multiple definitions of a category in a file, or can set the values from multiple
* files, look up the entry if we've already added it so we can merge the values together.
* Otherwise, alloc a new item. */
if (*field) {
if (!(new_item = type->item_find(*field, cat))) {
if (!(new_item = type->item_alloc(cat))) {
ast_log(LOG_ERROR, "In %s: Could not create item for %s\n", file->filename, cat);
return -1;
}
if (aco_set_defaults(type, cat, new_item)) {
ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, cat);
return -1;
}
new = 1;
}
}
if (type->item_pre_process && type->item_pre_process(new_item)) {
ast_log(LOG_ERROR, "In %s: Preprocess callback for %s failed\n", file->filename, cat);
return -1;
}
if (aco_process_category_options(type, cfg, cat, new_item)) {
ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
return -1;
}
if (type->item_prelink && type->item_prelink(new_item)) {
ast_log(LOG_ERROR, "In %s: Pre-link callback for %s failed\n", file->filename, cat);
return -1;
}
if (new && !ao2_link(*field, new_item)) {
ast_log(LOG_ERROR, "In %s: Linking config for %s failed\n", file->filename, cat);
return -1;
}
}
return 0;
}
static int apply_config(struct aco_info *info)
{
ao2_global_obj_replace_unref(*info->global_obj, info->internal->pending);
return 0;
}
static enum aco_process_status internal_process_ast_config(struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
{
const char *cat = NULL;
if (file->preload) {
int i;
for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
if (process_category(cfg, info, file, file->preload[i], 1)) {
return ACO_PROCESS_ERROR;
}
}
}
while ((cat = ast_category_browse(cfg, cat))) {
if (process_category(cfg, info, file, cat, 0)) {
return ACO_PROCESS_ERROR;
}
}
return ACO_PROCESS_OK;
}
enum aco_process_status aco_process_ast_config(struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
{
if (!info->internal) {
ast_log(LOG_ERROR, "Attempt to process %s with uninitialized aco_info\n", file->filename);
return ACO_PROCESS_ERROR;
}
if (!(info->internal->pending = info->snapshot_alloc())) {
ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", file->filename);
goto error;
}
if (internal_process_ast_config(info, file, cfg)) {
goto error;
}
if (info->pre_apply_config && info->pre_apply_config()) {
goto error;
}
if (apply_config(info)) {
goto error;
};
ao2_cleanup(info->internal->pending);
info->internal->pending = NULL;
return ACO_PROCESS_OK;
error:
ao2_cleanup(info->internal->pending);
info->internal->pending = NULL;
return ACO_PROCESS_ERROR;
}
enum aco_process_status aco_process_config(struct aco_info *info, int reload)
{
struct ast_config *cfg;
struct ast_flags cfg_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0, };
int res = ACO_PROCESS_OK;
int file_count = 0;
struct aco_file *file;
if (!info->internal) {
ast_log(LOG_ERROR, "Attempting to process uninitialized aco_info\n");
return ACO_PROCESS_ERROR;
}
if (!(info->files[0])) {
ast_log(LOG_ERROR, "No filename given, cannot proceed!\n");
return ACO_PROCESS_ERROR;
}
if (!(info->internal->pending = info->snapshot_alloc())) {
ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", info->module);
return ACO_PROCESS_ERROR;
}
while (res != ACO_PROCESS_ERROR && (file = info->files[file_count++])) {
const char *filename = file->filename;
struct aco_type *match;
int i;
/* set defaults for global objects */
for (i = 0, match = file->types[i]; match; match = file->types[++i]) {
void **field = info->internal->pending + match->item_offset;
if (match->type == ACO_IGNORE) {
continue;
}
if (match->type != ACO_GLOBAL || !*field) {
continue;
}
if (aco_set_defaults(match, match->category, *field)) {
ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, match->category);
res = ACO_PROCESS_ERROR;
break;
}
}
if (res == ACO_PROCESS_ERROR) {
break;
}
try_alias:
cfg = ast_config_load(filename, cfg_flags);
if (!cfg || cfg == CONFIG_STATUS_FILEMISSING) {
if (file->alias && strcmp(file->alias, filename)) {
filename = file->alias;
goto try_alias;
}
ast_log(LOG_ERROR, "Unable to load config file '%s'\n", file->filename);
res = ACO_PROCESS_ERROR;
break;
} else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
ast_debug(1, "%s was unchanged\n", file->filename);
res = ACO_PROCESS_UNCHANGED;
continue;
} else if (cfg == CONFIG_STATUS_FILEINVALID) {
ast_log(LOG_ERROR, "Contents of %s are invalid and cannot be parsed\n",
file->filename);
res = ACO_PROCESS_ERROR;
break;
}
/* A file got loaded. */
if (reload) {
/* Must do any subsequent file loads unconditionally. */
reload = 0;
ast_clear_flag(&cfg_flags, CONFIG_FLAG_FILEUNCHANGED);
if (file_count != 1) {
/*
* Must restart loading to load all config files since a file
* after the first one changed.
*/
file_count = 0;
} else {
res = internal_process_ast_config(info, file, cfg);
}
} else {
res = internal_process_ast_config(info, file, cfg);
}
ast_config_destroy(cfg);
}
if (res != ACO_PROCESS_OK) {
goto end;
}
if (info->pre_apply_config && info->pre_apply_config()) {
res = ACO_PROCESS_ERROR;
goto end;
}
if (apply_config(info)) {
res = ACO_PROCESS_ERROR;
goto end;
}
if (info->post_apply_config) {
info->post_apply_config();
}
end:
ao2_cleanup(info->internal->pending);
info->internal->pending = NULL;
return res;
}
int aco_process_var(struct aco_type *type, const char *cat, struct ast_variable *var, void *obj)
{
RAII_VAR(struct aco_option *, opt, aco_option_find(type, var->name), ao2_cleanup);
if (opt && opt->deprecated && !ast_strlen_zero(opt->aliased_to)) {
const char *alias = ast_strdupa(opt->aliased_to);
ast_log(LOG_WARNING, "At line %d of %s option '%s' is deprecated. Use '%s' instead\n", var->lineno, var->file, var->name, alias);
ao2_ref(opt, -1);
opt = aco_option_find(type, alias);
}
if (!opt) {
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);
return -1;
}
if (!opt->handler) {
/* It should be impossible for an option to not have a handler */
ast_log(LOG_ERROR, "BUG! Somehow a config option for %s/%s was created with no handler!\n", cat, var->name);
return -1;
}
#ifdef AST_DEVMODE
if (opt->doc_unavailable) {
ast_log(LOG_ERROR, "Config option '%s' of type '%s' is not completely documented and can not be set\n", var->name, type->name);
return -1;
}
#endif
if (opt->handler(opt, var, obj)) {
ast_log(LOG_ERROR, "Error parsing %s=%s at line %d of %s\n", var->name, var->value, var->lineno, var->file);
return -1;
}
return 0;
}
int aco_process_category_options(struct aco_type *type, struct ast_config *cfg, const char *cat, void *obj)
{
struct ast_variable *var;
for (var = ast_variable_browse(cfg, cat); var; var = var->next) {
if (aco_process_var(type, cat, var, obj)) {
return -1;
}
}
return 0;
}
static void internal_type_destroy(struct aco_type *type)
{
/* If we've already had all our internal data cleared out,
* then there's no need to proceed further
*/
if (!type->internal) {
return;
}
if (type->internal->regex) {
regfree(type->internal->regex);
ast_free(type->internal->regex);
}
ao2_cleanup(type->internal->opts);
type->internal->opts = NULL;
ast_free(type->internal);
type->internal = NULL;
}
static void internal_file_types_destroy(struct aco_file *file)
{
size_t x;
struct aco_type *t;
for (x = 0, t = file->types[x]; t; t = file->types[++x]) {
internal_type_destroy(t);
t = NULL;
}
}
static int internal_type_init(struct aco_type *type)
{
if (!(type->internal = ast_calloc(1, sizeof(*type->internal)))) {
return -1;
}
switch (type->category_match) {
case ACO_BLACKLIST:
case ACO_WHITELIST:
if (!(type->internal->regex = build_regex(type->category))) {
internal_type_destroy(type);
return -1;
}
break;
case ACO_BLACKLIST_EXACT:
case ACO_WHITELIST_EXACT:
case ACO_BLACKLIST_ARRAY:
case ACO_WHITELIST_ARRAY:
break;
}
if (!(type->internal->opts = aco_option_container_alloc())) {
internal_type_destroy(type);
return -1;
}
return 0;
}
int aco_info_init(struct aco_info *info)
{
size_t x = 0, y = 0;
struct aco_file *file;
struct aco_type *type;
if (!(info->internal = ast_calloc(1, sizeof(*info->internal)))) {
return -1;
}
while ((file = info->files[x++])) {
while ((type = file->types[y++])) {
if (internal_type_init(type)) {
goto error;
}
#ifdef AST_XML_DOCS
if (!info->hidden &&
!type->hidden &&
type->type != ACO_IGNORE &&
xmldoc_update_config_type(info->module, type->name, type->category, type->matchfield, type->matchvalue, type->category_match)) {
goto error;
}
#endif /* AST_XML_DOCS */
}
y = 0;
}
return 0;
error:
aco_info_destroy(info);
return -1;
}
void aco_info_destroy(struct aco_info *info)
{
int x;
/* It shouldn't be possible for internal->pending to be in use when this is called because
* of the locks in loader.c around reloads and unloads and the fact that internal->pending
* only exists while those locks are held */
ast_free(info->internal);
info->internal = NULL;
for (x = 0; info->files[x]; x++) {
internal_file_types_destroy(info->files[x]);
}
}
int aco_set_defaults(struct aco_type *type, const char *category, void *obj)
{
struct aco_option *opt;
struct ao2_iterator iter;
if (!type->internal) {
return -1;
}
iter = ao2_iterator_init(type->internal->opts, 0);
while ((opt = ao2_iterator_next(&iter))) {
RAII_VAR(struct ast_variable *, var, NULL, ast_variables_destroy);
if (ast_strlen_zero(opt->default_val)) {
ao2_ref(opt, -1);
continue;
}
if (!(var = ast_variable_new(opt->name, opt->default_val, ""))) {
ao2_ref(opt, -1);
ao2_iterator_destroy(&iter);
return -1;
}
if (opt->handler(opt, var, obj)) {
ast_log(LOG_ERROR, "Unable to set default for %s, %s=%s\n", category, var->name, var->value);
ao2_ref(opt, -1);
ao2_iterator_destroy(&iter);
return -1;
}
ao2_ref(opt, -1);
}
ao2_iterator_destroy(&iter);
return 0;
}
#ifdef AST_XML_DOCS
/*! \internal
* \brief Complete the name of the module the user is looking for
*/
static char *complete_config_module(const char *word)
{
size_t wordlen = strlen(word);
struct ao2_iterator i;
struct ast_xml_doc_item *cur;
i = ao2_iterator_init(xmldocs, 0);
while ((cur = ao2_iterator_next(&i))) {
if (!strncasecmp(word, cur->name, wordlen)) {
if (ast_cli_completion_add(ast_strdup(cur->name))) {
ao2_ref(cur, -1);
break;
}
}
ao2_ref(cur, -1);
}
ao2_iterator_destroy(&i);
return NULL;
}
/*! \internal
* \brief Complete the name of the configuration type the user is looking for
*/
static char *complete_config_type(const char *module, const char *word)
{
size_t wordlen = strlen(word);
struct ast_xml_doc_item *info;
struct ast_xml_doc_item *cur;
info = ao2_find(xmldocs, module, OBJ_KEY);
if (!info) {
return NULL;
}
cur = info;