config: Allow ConfBridge DTMF menus to have '#' as the first digit.
[asterisk/asterisk.git] / main / config.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, 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  *
21  * \brief Configuration File Parser
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * Includes the Asterisk Realtime API - ARA
26  * See http://wiki.asterisk.org
27  */
28
29 /*** MODULEINFO
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/paths.h"     /* use ast_config_AST_CONFIG_DIR */
38 #include "asterisk/network.h"   /* we do some sockaddr manipulation here */
39 #include <time.h>
40 #include <sys/stat.h>
41
42 #include <math.h>       /* HUGE_VAL */
43
44 #define AST_INCLUDE_GLOB 1
45
46 #include "asterisk/config.h"
47 #include "asterisk/cli.h"
48 #include "asterisk/lock.h"
49 #include "asterisk/utils.h"
50 #include "asterisk/channel.h"
51 #include "asterisk/app.h"
52 #include "asterisk/astobj2.h"
53 #include "asterisk/strings.h"   /* for the ast_str_*() API */
54 #include "asterisk/netsock2.h"
55
56 #define MAX_NESTED_COMMENTS 128
57 #define COMMENT_START ";--"
58 #define COMMENT_END "--;"
59 #define COMMENT_META ';'
60 #define COMMENT_TAG '-'
61
62 /*!
63  * Define the minimum filename space to reserve for each
64  * ast_variable in case the filename is renamed later by
65  * ast_include_rename().
66  */
67 #define MIN_VARIABLE_FNAME_SPACE        40
68
69 static char *extconfig_conf = "extconfig.conf";
70
71 static struct ao2_container *cfg_hooks;
72 static void config_hook_exec(const char *filename, const char *module, struct ast_config *cfg);
73
74 /*! \brief Structure to keep comments for rewriting configuration files */
75 struct ast_comment {
76         struct ast_comment *next;
77         /*! Comment body allocated after struct. */
78         char cmt[0];
79 };
80
81 /*! \brief Hold the mtime for config files, so if we don't need to reread our config, don't. */
82 struct cache_file_include {
83         AST_LIST_ENTRY(cache_file_include) list;
84         char include[0];
85 };
86
87 struct cache_file_mtime {
88         AST_LIST_ENTRY(cache_file_mtime) list;
89         AST_LIST_HEAD_NOLOCK(includes, cache_file_include) includes;
90         unsigned int has_exec:1;
91         time_t mtime;
92
93         /*! String stuffed in filename[] after the filename string. */
94         const char *who_asked;
95         /*! Filename and who_asked stuffed after it. */
96         char filename[0];
97 };
98
99 /*! Cached file mtime list. */
100 static AST_LIST_HEAD_STATIC(cfmtime_head, cache_file_mtime);
101
102 static int init_appendbuf(void *data)
103 {
104         struct ast_str **str = data;
105         *str = ast_str_create(16);
106         return *str ? 0 : -1;
107 }
108
109 AST_THREADSTORAGE_CUSTOM(appendbuf, init_appendbuf, ast_free_ptr);
110
111 /* comment buffers are better implemented using the ast_str_*() API */
112 #define CB_SIZE 250     /* initial size of comment buffers */
113
114 static void  CB_ADD(struct ast_str **cb, const char *str)
115 {
116         ast_str_append(cb, 0, "%s", str);
117 }
118
119 static void  CB_ADD_LEN(struct ast_str **cb, const char *str, int len)
120 {
121         char *s = ast_alloca(len + 1);
122         ast_copy_string(s, str, len);
123         ast_str_append(cb, 0, "%s", str);
124 }
125
126 static void CB_RESET(struct ast_str *cb, struct ast_str *llb)
127 {
128         if (cb) {
129                 ast_str_reset(cb);
130         }
131         if (llb) {
132                 ast_str_reset(llb);
133         }
134 }
135
136 static struct ast_comment *ALLOC_COMMENT(struct ast_str *buffer)
137 {
138         struct ast_comment *x = NULL;
139         if (!buffer || !ast_str_strlen(buffer)) {
140                 return NULL;
141         }
142         if ((x = ast_calloc(1, sizeof(*x) + ast_str_strlen(buffer) + 1))) {
143                 strcpy(x->cmt, ast_str_buffer(buffer)); /* SAFE */
144         }
145         return x;
146 }
147
148 /* I need to keep track of each config file, and all its inclusions,
149    so that we can track blank lines in each */
150
151 struct inclfile {
152         char *fname;
153         int lineno;
154 };
155
156 static int hash_string(const void *obj, const int flags)
157 {
158         char *str = ((struct inclfile *) obj)->fname;
159         int total;
160
161         for (total = 0; *str; str++) {
162                 unsigned int tmp = total;
163                 total <<= 1; /* multiply by 2 */
164                 total += tmp; /* multiply by 3 */
165                 total <<= 2; /* multiply by 12 */
166                 total += tmp; /* multiply by 13 */
167
168                 total += ((unsigned int) (*str));
169         }
170         if (total < 0) {
171                 total = -total;
172         }
173         return total;
174 }
175
176 static int hashtab_compare_strings(void *a, void *b, int flags)
177 {
178         const struct inclfile *ae = a, *be = b;
179         return !strcmp(ae->fname, be->fname) ? CMP_MATCH | CMP_STOP : 0;
180 }
181
182 static struct ast_config_map {
183         struct ast_config_map *next;
184         int priority;
185         /*! Stored in stuff[] at struct end. */
186         const char *name;
187         /*! Stored in stuff[] at struct end. */
188         const char *driver;
189         /*! Stored in stuff[] at struct end. */
190         const char *database;
191         /*! Stored in stuff[] at struct end. */
192         const char *table;
193         /*! Contents of name, driver, database, and table in that order stuffed here. */
194         char stuff[0];
195 } *config_maps = NULL;
196
197 AST_MUTEX_DEFINE_STATIC(config_lock);
198 static struct ast_config_engine *config_engine_list;
199
200 #define MAX_INCLUDE_LEVEL 10
201
202 struct ast_category_template_instance {
203         char name[80]; /* redundant? */
204         const struct ast_category *inst;
205         AST_LIST_ENTRY(ast_category_template_instance) next;
206 };
207
208 struct ast_category {
209         char name[80];
210         int ignored;                    /*!< do not let user of the config see this category -- set by (!) after the category decl; a template */
211         int include_level;
212         /*!
213          * \brief The file name from whence this declaration was read
214          * \note Will never be NULL
215          */
216         char *file;
217         int lineno;
218         AST_LIST_HEAD_NOLOCK(template_instance_list, ast_category_template_instance) template_instances;
219         struct ast_comment *precomments;
220         struct ast_comment *sameline;
221         struct ast_comment *trailing; /*!< the last object in the list will get assigned any trailing comments when EOF is hit */
222         /*! First category variable in the list. */
223         struct ast_variable *root;
224         /*! Last category variable in the list. */
225         struct ast_variable *last;
226         /*! Next node in the list. */
227         struct ast_category *next;
228 };
229
230 struct ast_config {
231         /*! First config category in the list. */
232         struct ast_category *root;
233         /*! Last config category in the list. */
234         struct ast_category *last;
235         struct ast_category *current;
236         struct ast_category *last_browse;     /*!< used to cache the last category supplied via category_browse */
237         int include_level;
238         int max_include_level;
239         struct ast_config_include *includes;  /*!< a list of inclusions, which should describe the entire tree */
240 };
241
242 struct ast_config_include {
243         /*!
244          * \brief file name in which the include occurs
245          * \note Will never be NULL
246          */
247         char *include_location_file;
248         int  include_location_lineno;    /*!< lineno where include occurred */
249         int  exec;                       /*!< set to non-zero if its a #exec statement */
250         /*!
251          * \brief if it's an exec, you'll have both the /var/tmp to read, and the original script
252          * \note Will never be NULL if exec is non-zero
253          */
254         char *exec_file;
255         /*!
256          * \brief file name included
257          * \note Will never be NULL
258          */
259         char *included_file;
260         int inclusion_count;             /*!< if the file is included more than once, a running count thereof -- but, worry not,
261                                               we explode the instances and will include those-- so all entries will be unique */
262         int output;                      /*!< a flag to indicate if the inclusion has been output */
263         struct ast_config_include *next; /*!< ptr to next inclusion in the list */
264 };
265
266 static void ast_variable_destroy(struct ast_variable *doomed);
267 static void ast_includes_destroy(struct ast_config_include *incls);
268
269 #ifdef MALLOC_DEBUG
270 struct ast_variable *_ast_variable_new(const char *name, const char *value, const char *filename, const char *file, const char *func, int lineno)
271 #else
272 struct ast_variable *ast_variable_new(const char *name, const char *value, const char *filename)
273 #endif
274 {
275         struct ast_variable *variable;
276         int name_len = strlen(name) + 1;
277         int val_len = strlen(value) + 1;
278         int fn_len = strlen(filename) + 1;
279
280         /* Ensure a minimum length in case the filename is changed later. */
281         if (fn_len < MIN_VARIABLE_FNAME_SPACE) {
282                 fn_len = MIN_VARIABLE_FNAME_SPACE;
283         }
284
285         if (
286 #ifdef MALLOC_DEBUG
287                 (variable = __ast_calloc(1, fn_len + name_len + val_len + sizeof(*variable), file, lineno, func))
288 #else
289                 (variable = ast_calloc(1, fn_len + name_len + val_len + sizeof(*variable)))
290 #endif
291                 ) {
292                 char *dst = variable->stuff;    /* writable space starts here */
293
294                 /* Put file first so ast_include_rename() can calculate space available. */
295                 variable->file = strcpy(dst, filename);
296                 dst += fn_len;
297                 variable->name = strcpy(dst, name);
298                 dst += name_len;
299                 variable->value = strcpy(dst, value);
300         }
301         return variable;
302 }
303
304 /*!
305  * \internal
306  * \brief Move the contents from the source to the destination variable.
307  *
308  * \param dst_var Destination variable node
309  * \param src_var Source variable node
310  *
311  * \return Nothing
312  */
313 static void ast_variable_move(struct ast_variable *dst_var, struct ast_variable *src_var)
314 {
315         dst_var->lineno = src_var->lineno;
316         dst_var->object = src_var->object;
317         dst_var->blanklines = src_var->blanklines;
318         dst_var->precomments = src_var->precomments;
319         src_var->precomments = NULL;
320         dst_var->sameline = src_var->sameline;
321         src_var->sameline = NULL;
322         dst_var->trailing = src_var->trailing;
323         src_var->trailing = NULL;
324 }
325
326 struct ast_config_include *ast_include_new(struct ast_config *conf, const char *from_file, const char *included_file, int is_exec, const char *exec_file, int from_lineno, char *real_included_file_name, int real_included_file_name_size)
327 {
328         /* a file should be included ONCE. Otherwise, if one of the instances is changed,
329          * then all be changed. -- how do we know to include it? -- Handling modified
330          * instances is possible, I'd have
331          * to create a new master for each instance. */
332         struct ast_config_include *inc;
333         struct stat statbuf;
334
335         inc = ast_include_find(conf, included_file);
336         if (inc) {
337                 do {
338                         inc->inclusion_count++;
339                         snprintf(real_included_file_name, real_included_file_name_size, "%s~~%d", included_file, inc->inclusion_count);
340                 } while (stat(real_included_file_name, &statbuf) == 0);
341                 ast_log(LOG_WARNING,"'%s', line %d:  Same File included more than once! This data will be saved in %s if saved back to disk.\n", from_file, from_lineno, real_included_file_name);
342         } else
343                 *real_included_file_name = 0;
344
345         inc = ast_calloc(1,sizeof(struct ast_config_include));
346         if (!inc) {
347                 return NULL;
348         }
349         inc->include_location_file = ast_strdup(from_file);
350         inc->include_location_lineno = from_lineno;
351         if (!ast_strlen_zero(real_included_file_name))
352                 inc->included_file = ast_strdup(real_included_file_name);
353         else
354                 inc->included_file = ast_strdup(included_file);
355
356         inc->exec = is_exec;
357         if (is_exec)
358                 inc->exec_file = ast_strdup(exec_file);
359
360         if (!inc->include_location_file
361                 || !inc->included_file
362                 || (is_exec && !inc->exec_file)) {
363                 ast_includes_destroy(inc);
364                 return NULL;
365         }
366
367         /* attach this new struct to the conf struct */
368         inc->next = conf->includes;
369         conf->includes = inc;
370
371         return inc;
372 }
373
374 void ast_include_rename(struct ast_config *conf, const char *from_file, const char *to_file)
375 {
376         struct ast_config_include *incl;
377         struct ast_category *cat;
378         char *str;
379
380         int from_len = strlen(from_file);
381         int to_len = strlen(to_file);
382
383         if (strcmp(from_file, to_file) == 0) /* no use wasting time if the name is the same */
384                 return;
385
386         /* the manager code allows you to read in one config file, then
387          * write it back out under a different name. But, the new arrangement
388          * ties output lines to the file name. So, before you try to write
389          * the config file to disk, better riffle thru the data and make sure
390          * the file names are changed.
391          */
392         /* file names are on categories, includes (of course), and on variables. So,
393          * traverse all this and swap names */
394
395         for (incl = conf->includes; incl; incl=incl->next) {
396                 if (strcmp(incl->include_location_file,from_file) == 0) {
397                         if (from_len >= to_len)
398                                 strcpy(incl->include_location_file, to_file);
399                         else {
400                                 /* Keep the old filename if the allocation fails. */
401                                 str = ast_strdup(to_file);
402                                 if (str) {
403                                         ast_free(incl->include_location_file);
404                                         incl->include_location_file = str;
405                                 }
406                         }
407                 }
408         }
409         for (cat = conf->root; cat; cat = cat->next) {
410                 struct ast_variable **prev;
411                 struct ast_variable *v;
412                 struct ast_variable *new_var;
413
414                 if (strcmp(cat->file,from_file) == 0) {
415                         if (from_len >= to_len)
416                                 strcpy(cat->file, to_file);
417                         else {
418                                 /* Keep the old filename if the allocation fails. */
419                                 str = ast_strdup(to_file);
420                                 if (str) {
421                                         ast_free(cat->file);
422                                         cat->file = str;
423                                 }
424                         }
425                 }
426                 for (prev = &cat->root, v = cat->root; v; prev = &v->next, v = v->next) {
427                         if (strcmp(v->file, from_file)) {
428                                 continue;
429                         }
430
431                         /*
432                          * Calculate actual space available.  The file string is
433                          * intentionally stuffed before the name string just so we can
434                          * do this.
435                          */
436                         if (to_len < v->name - v->file) {
437                                 /* The new name will fit in the available space. */
438                                 str = (char *) v->file;/* Stupid compiler complains about discarding qualifiers even though I used a cast. */
439                                 strcpy(str, to_file);/* SAFE */
440                                 continue;
441                         }
442
443                         /* Keep the old filename if the allocation fails. */
444                         new_var = ast_variable_new(v->name, v->value, to_file);
445                         if (!new_var) {
446                                 continue;
447                         }
448
449                         /* Move items from the old list node to the replacement node. */
450                         ast_variable_move(new_var, v);
451
452                         /* Replace the old node in the list with the new node. */
453                         new_var->next = v->next;
454                         if (cat->last == v) {
455                                 cat->last = new_var;
456                         }
457                         *prev = new_var;
458
459                         ast_variable_destroy(v);
460
461                         v = new_var;
462                 }
463         }
464 }
465
466 struct ast_config_include *ast_include_find(struct ast_config *conf, const char *included_file)
467 {
468         struct ast_config_include *x;
469         for (x=conf->includes;x;x=x->next) {
470                 if (strcmp(x->included_file,included_file) == 0)
471                         return x;
472         }
473         return 0;
474 }
475
476
477 void ast_variable_append(struct ast_category *category, struct ast_variable *variable)
478 {
479         if (!variable)
480                 return;
481         if (category->last)
482                 category->last->next = variable;
483         else
484                 category->root = variable;
485         category->last = variable;
486         while (category->last->next)
487                 category->last = category->last->next;
488 }
489
490 void ast_variable_insert(struct ast_category *category, struct ast_variable *variable, const char *line)
491 {
492         struct ast_variable *cur = category->root;
493         int lineno;
494         int insertline;
495
496         if (!variable || sscanf(line, "%30d", &insertline) != 1) {
497                 return;
498         }
499         if (!insertline) {
500                 variable->next = category->root;
501                 category->root = variable;
502         } else {
503                 for (lineno = 1; lineno < insertline; lineno++) {
504                         cur = cur->next;
505                         if (!cur->next) {
506                                 break;
507                         }
508                 }
509                 variable->next = cur->next;
510                 cur->next = variable;
511         }
512 }
513
514 static void ast_comment_destroy(struct ast_comment **comment)
515 {
516         struct ast_comment *n, *p;
517
518         for (p = *comment; p; p = n) {
519                 n = p->next;
520                 ast_free(p);
521         }
522
523         *comment = NULL;
524 }
525
526 static void ast_variable_destroy(struct ast_variable *doomed)
527 {
528         ast_comment_destroy(&doomed->precomments);
529         ast_comment_destroy(&doomed->sameline);
530         ast_comment_destroy(&doomed->trailing);
531         ast_free(doomed);
532 }
533
534 struct ast_variable *ast_variables_dup(struct ast_variable *var)
535 {
536         struct ast_variable *cloned;
537         struct ast_variable *tmp;
538
539         if (!(cloned = ast_variable_new(var->name, var->value, var->file))) {
540                 return NULL;
541         }
542
543         tmp = cloned;
544
545         while ((var = var->next)) {
546                 if (!(tmp->next = ast_variable_new(var->name, var->value, var->file))) {
547                         ast_variables_destroy(cloned);
548                         return NULL;
549                 }
550                 tmp = tmp->next;
551         }
552
553         return cloned;
554 }
555
556 void ast_variables_destroy(struct ast_variable *v)
557 {
558         struct ast_variable *vn;
559
560         while (v) {
561                 vn = v;
562                 v = v->next;
563                 ast_variable_destroy(vn);
564         }
565 }
566
567 struct ast_variable *ast_variable_browse(const struct ast_config *config, const char *category)
568 {
569         struct ast_category *cat = NULL;
570
571         if (!category) {
572                 return NULL;
573         }
574
575         if (config->last_browse && (config->last_browse->name == category)) {
576                 cat = config->last_browse;
577         } else {
578                 cat = ast_category_get(config, category);
579         }
580
581         return (cat) ? cat->root : NULL;
582 }
583
584 const char *ast_config_option(struct ast_config *cfg, const char *cat, const char *var)
585 {
586         const char *tmp;
587         tmp = ast_variable_retrieve(cfg, cat, var);
588         if (!tmp) {
589                 tmp = ast_variable_retrieve(cfg, "general", var);
590         }
591         return tmp;
592 }
593
594
595 const char *ast_variable_retrieve(const struct ast_config *config, const char *category, const char *variable)
596 {
597         struct ast_variable *v;
598
599         if (category) {
600                 for (v = ast_variable_browse(config, category); v; v = v->next) {
601                         if (!strcasecmp(variable, v->name)) {
602                                 return v->value;
603                         }
604                 }
605         } else {
606                 struct ast_category *cat;
607
608                 for (cat = config->root; cat; cat = cat->next) {
609                         for (v = cat->root; v; v = v->next) {
610                                 if (!strcasecmp(variable, v->name)) {
611                                         return v->value;
612                                 }
613                         }
614                 }
615         }
616
617         return NULL;
618 }
619
620 static struct ast_variable *variable_clone(const struct ast_variable *old)
621 {
622         struct ast_variable *new = ast_variable_new(old->name, old->value, old->file);
623
624         if (new) {
625                 new->lineno = old->lineno;
626                 new->object = old->object;
627                 new->blanklines = old->blanklines;
628                 /* TODO: clone comments? */
629         }
630
631         return new;
632 }
633
634 static void move_variables(struct ast_category *old, struct ast_category *new)
635 {
636         struct ast_variable *var = old->root;
637
638         old->root = NULL;
639         /* we can just move the entire list in a single op */
640         ast_variable_append(new, var);
641 }
642
643 struct ast_category *ast_category_new(const char *name, const char *in_file, int lineno)
644 {
645         struct ast_category *category;
646
647         category = ast_calloc(1, sizeof(*category));
648         if (!category) {
649                 return NULL;
650         }
651         category->file = ast_strdup(in_file);
652         if (!category->file) {
653                 ast_category_destroy(category);
654                 return NULL;
655         }
656         ast_copy_string(category->name, name, sizeof(category->name));
657         category->lineno = lineno; /* if you don't know the lineno, set it to 999999 or something real big */
658         return category;
659 }
660
661 static struct ast_category *category_get(const struct ast_config *config, const char *category_name, int ignored)
662 {
663         struct ast_category *cat;
664
665         /* try exact match first, then case-insensitive match */
666         for (cat = config->root; cat; cat = cat->next) {
667                 if (cat->name == category_name && (ignored || !cat->ignored))
668                         return cat;
669         }
670
671         for (cat = config->root; cat; cat = cat->next) {
672                 if (!strcasecmp(cat->name, category_name) && (ignored || !cat->ignored))
673                         return cat;
674         }
675
676         return NULL;
677 }
678
679 struct ast_category *ast_category_get(const struct ast_config *config, const char *category_name)
680 {
681         return category_get(config, category_name, 0);
682 }
683
684 int ast_category_exist(const struct ast_config *config, const char *category_name)
685 {
686         return !!ast_category_get(config, category_name);
687 }
688
689 void ast_category_append(struct ast_config *config, struct ast_category *category)
690 {
691         if (config->last)
692                 config->last->next = category;
693         else
694                 config->root = category;
695         category->include_level = config->include_level;
696         config->last = category;
697         config->current = category;
698 }
699
700 void ast_category_insert(struct ast_config *config, struct ast_category *cat, const char *match)
701 {
702         struct ast_category *cur_category;
703
704         if (!cat || !match)
705                 return;
706         if (!strcasecmp(config->root->name, match)) {
707                 cat->next = config->root;
708                 config->root = cat;
709                 return;
710         }
711         for (cur_category = config->root; cur_category; cur_category = cur_category->next) {
712                 if (!strcasecmp(cur_category->next->name, match)) {
713                         cat->next = cur_category->next;
714                         cur_category->next = cat;
715                         break;
716                 }
717         }
718 }
719
720 static void ast_destroy_template_list(struct ast_category *cat)
721 {
722         struct ast_category_template_instance *x;
723
724         while ((x = AST_LIST_REMOVE_HEAD(&cat->template_instances, next)))
725                 ast_free(x);
726 }
727
728 void ast_category_destroy(struct ast_category *cat)
729 {
730         ast_variables_destroy(cat->root);
731         cat->root = NULL;
732         cat->last = NULL;
733         ast_comment_destroy(&cat->precomments);
734         ast_comment_destroy(&cat->sameline);
735         ast_comment_destroy(&cat->trailing);
736         ast_destroy_template_list(cat);
737         ast_free(cat->file);
738         ast_free(cat);
739 }
740
741 static void ast_includes_destroy(struct ast_config_include *incls)
742 {
743         struct ast_config_include *incl,*inclnext;
744
745         for (incl=incls; incl; incl = inclnext) {
746                 inclnext = incl->next;
747                 ast_free(incl->include_location_file);
748                 ast_free(incl->exec_file);
749                 ast_free(incl->included_file);
750                 ast_free(incl);
751         }
752 }
753
754 static struct ast_category *next_available_category(struct ast_category *cat)
755 {
756         for (; cat && cat->ignored; cat = cat->next);
757
758         return cat;
759 }
760
761 /*! return the first var of a category */
762 struct ast_variable *ast_category_first(struct ast_category *cat)
763 {
764         return (cat) ? cat->root : NULL;
765 }
766
767 struct ast_variable *ast_category_root(struct ast_config *config, char *cat)
768 {
769         struct ast_category *category = ast_category_get(config, cat);
770
771         if (category)
772                 return category->root;
773         return NULL;
774 }
775
776 void ast_config_sort_categories(struct ast_config *config, int descending,
777                                                                 int (*comparator)(struct ast_category *p, struct ast_category *q))
778 {
779         /*
780          * The contents of this function are adapted from
781          * an example of linked list merge sorting
782          * copyright 2001 Simon Tatham.
783          *
784          * Permission is hereby granted, free of charge, to any person
785          * obtaining a copy of this software and associated documentation
786          * files (the "Software"), to deal in the Software without
787          * restriction, including without limitation the rights to use,
788          * copy, modify, merge, publish, distribute, sublicense, and/or
789          * sell copies of the Software, and to permit persons to whom the
790          * Software is furnished to do so, subject to the following
791          * conditions:
792          *
793          * The above copyright notice and this permission notice shall be
794          * included in all copies or substantial portions of the Software.
795          *
796          * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
797          * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
798          * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
799          * NONINFRINGEMENT.  IN NO EVENT SHALL SIMON TATHAM BE LIABLE FOR
800          * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
801          * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
802          * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
803          * SOFTWARE.
804          */
805
806         int insize = 1;
807         struct ast_category *p, *q, *e, *tail;
808         int nmerges, psize, qsize, i;
809
810         /* If the descending flag was sent, we'll apply inversion to the comparison function's return. */
811         if (descending) {
812                 descending = -1;
813         } else {
814                 descending = 1;
815         }
816
817         if (!config->root) {
818                 return;
819         }
820
821         while (1) {
822                 p = config->root;
823                 config->root = NULL;
824                 tail = NULL;
825
826                 nmerges = 0; /* count number of merges we do in this pass */
827
828                 while (p) {
829                         nmerges++; /* there exists a merge to be done */
830
831                         /* step `insize' places along from p */
832                         q = p;
833                         psize = 0;
834                         for (i = 0; i < insize; i++) {
835                                 psize++;
836                                 q = q->next;
837                                 if (!q) {
838                                         break;
839                                 }
840                         }
841
842                         /* if q hasn't fallen off end, we have two lists to merge */
843                         qsize = insize;
844
845                         /* now we have two lists; merge them */
846                         while (psize > 0 || (qsize > 0 && q)) {
847                                 /* decide whether next element of merge comes from p or q */
848                                 if (psize == 0) {
849                                         /* p is empty; e must come from q. */
850                                         e = q;
851                                         q = q->next;
852                                         qsize--;
853                                 } else if (qsize == 0 || !q) {
854                                         /* q is empty; e must come from p. */
855                                         e = p; p = p->next; psize--;
856                                 } else if ((comparator(p,q) * descending) <= 0) {
857                                         /* First element of p is lower (or same) e must come from p. */
858                                         e = p;
859                                         p = p->next;
860                                         psize--;
861                                 } else {
862                                         /* First element of q is lower; e must come from q. */
863                                         e = q;
864                                         q = q->next;
865                                         qsize--;
866                                 }
867
868                                 /* add the next element to the merged list */
869                                 if (tail) {
870                                         tail->next = e;
871                                 } else {
872                                         config->root = e;
873                                 }
874                                 tail = e;
875                         }
876
877                         /* now p has stepped `insize' places along, and q has too */
878                         p = q;
879                 }
880
881                 tail->next = NULL;
882
883                 /* If we have done only one merge, we're finished. */
884                 if (nmerges <= 1) { /* allow for nmerges==0, the empty list case */
885                         return;
886                 }
887
888                 /* Otherwise repeat, merging lists twice the size */
889                 insize *= 2;
890         }
891
892 }
893
894 char *ast_category_browse(struct ast_config *config, const char *prev)
895 {
896         struct ast_category *cat;
897
898         if (!prev) {
899                 /* First time browse. */
900                 cat = config->root;
901         } else if (config->last_browse && (config->last_browse->name == prev)) {
902                 /* Simple last browse found. */
903                 cat = config->last_browse->next;
904         } else {
905                 /*
906                  * Config changed since last browse.
907                  *
908                  * First try cheap last browse search. (Rebrowsing a different
909                  * previous category?)
910                  */
911                 for (cat = config->root; cat; cat = cat->next) {
912                         if (cat->name == prev) {
913                                 /* Found it. */
914                                 cat = cat->next;
915                                 break;
916                         }
917                 }
918                 if (!cat) {
919                         /*
920                          * Have to do it the hard way. (Last category was deleted and
921                          * re-added?)
922                          */
923                         for (cat = config->root; cat; cat = cat->next) {
924                                 if (!strcasecmp(cat->name, prev)) {
925                                         /* Found it. */
926                                         cat = cat->next;
927                                         break;
928                                 }
929                         }
930                 }
931         }
932
933         if (cat)
934                 cat = next_available_category(cat);
935
936         config->last_browse = cat;
937         return (cat) ? cat->name : NULL;
938 }
939
940 struct ast_variable *ast_category_detach_variables(struct ast_category *cat)
941 {
942         struct ast_variable *v;
943
944         v = cat->root;
945         cat->root = NULL;
946         cat->last = NULL;
947
948         return v;
949 }
950
951 void ast_category_rename(struct ast_category *cat, const char *name)
952 {
953         ast_copy_string(cat->name, name, sizeof(cat->name));
954 }
955
956 static void inherit_category(struct ast_category *new, const struct ast_category *base)
957 {
958         struct ast_variable *var;
959         struct ast_category_template_instance *x;
960
961         x = ast_calloc(1, sizeof(*x));
962         if (!x) {
963                 return;
964         }
965         strcpy(x->name, base->name);
966         x->inst = base;
967         AST_LIST_INSERT_TAIL(&new->template_instances, x, next);
968         for (var = base->root; var; var = var->next)
969                 ast_variable_append(new, variable_clone(var));
970 }
971
972 struct ast_config *ast_config_new(void)
973 {
974         struct ast_config *config;
975
976         if ((config = ast_calloc(1, sizeof(*config))))
977                 config->max_include_level = MAX_INCLUDE_LEVEL;
978         return config;
979 }
980
981 int ast_variable_delete(struct ast_category *category, const char *variable, const char *match, const char *line)
982 {
983         struct ast_variable *cur, *prev=NULL, *curn;
984         int res = -1;
985         int num_item = 0;
986         int req_item;
987
988         req_item = -1;
989         if (!ast_strlen_zero(line)) {
990                 /* Requesting to delete by item number. */
991                 if (sscanf(line, "%30d", &req_item) != 1
992                         || req_item < 0) {
993                         /* Invalid item number to delete. */
994                         return -1;
995                 }
996         }
997
998         prev = NULL;
999         cur = category->root;
1000         while (cur) {
1001                 curn = cur->next;
1002                 /* Delete by item number or by variable name with optional value. */
1003                 if ((0 <= req_item && num_item == req_item)
1004                         || (req_item < 0 && !strcasecmp(cur->name, variable)
1005                                 && (ast_strlen_zero(match) || !strcasecmp(cur->value, match)))) {
1006                         if (prev) {
1007                                 prev->next = cur->next;
1008                                 if (cur == category->last)
1009                                         category->last = prev;
1010                         } else {
1011                                 category->root = cur->next;
1012                                 if (cur == category->last)
1013                                         category->last = NULL;
1014                         }
1015                         ast_variable_destroy(cur);
1016                         res = 0;
1017                 } else
1018                         prev = cur;
1019
1020                 cur = curn;
1021                 ++num_item;
1022         }
1023         return res;
1024 }
1025
1026 int ast_variable_update(struct ast_category *category, const char *variable,
1027                                                 const char *value, const char *match, unsigned int object)
1028 {
1029         struct ast_variable *cur, *prev=NULL, *newer=NULL;
1030
1031         for (cur = category->root; cur; prev = cur, cur = cur->next) {
1032                 if (strcasecmp(cur->name, variable) ||
1033                         (!ast_strlen_zero(match) && strcasecmp(cur->value, match)))
1034                         continue;
1035
1036                 if (!(newer = ast_variable_new(variable, value, cur->file)))
1037                         return -1;
1038
1039                 ast_variable_move(newer, cur);
1040                 newer->object = newer->object || object;
1041
1042                 /* Replace the old node in the list with the new node. */
1043                 newer->next = cur->next;
1044                 if (prev)
1045                         prev->next = newer;
1046                 else
1047                         category->root = newer;
1048                 if (category->last == cur)
1049                         category->last = newer;
1050
1051                 ast_variable_destroy(cur);
1052
1053                 return 0;
1054         }
1055
1056         /* Could not find variable to update */
1057         return -1;
1058 }
1059
1060 int ast_category_delete(struct ast_config *cfg, const char *category)
1061 {
1062         struct ast_category *prev=NULL, *cat;
1063
1064         cat = cfg->root;
1065         while (cat) {
1066                 if (cat->name == category) {
1067                         if (prev) {
1068                                 prev->next = cat->next;
1069                                 if (cat == cfg->last)
1070                                         cfg->last = prev;
1071                         } else {
1072                                 cfg->root = cat->next;
1073                                 if (cat == cfg->last)
1074                                         cfg->last = NULL;
1075                         }
1076                         ast_category_destroy(cat);
1077                         return 0;
1078                 }
1079                 prev = cat;
1080                 cat = cat->next;
1081         }
1082
1083         prev = NULL;
1084         cat = cfg->root;
1085         while (cat) {
1086                 if (!strcasecmp(cat->name, category)) {
1087                         if (prev) {
1088                                 prev->next = cat->next;
1089                                 if (cat == cfg->last)
1090                                         cfg->last = prev;
1091                         } else {
1092                                 cfg->root = cat->next;
1093                                 if (cat == cfg->last)
1094                                         cfg->last = NULL;
1095                         }
1096                         ast_category_destroy(cat);
1097                         return 0;
1098                 }
1099                 prev = cat;
1100                 cat = cat->next;
1101         }
1102         return -1;
1103 }
1104
1105 int ast_category_empty(struct ast_config *cfg, const char *category)
1106 {
1107         struct ast_category *cat;
1108
1109         for (cat = cfg->root; cat; cat = cat->next) {
1110                 if (!strcasecmp(cat->name, category))
1111                         continue;
1112                 ast_variables_destroy(cat->root);
1113                 cat->root = NULL;
1114                 cat->last = NULL;
1115                 return 0;
1116         }
1117
1118         return -1;
1119 }
1120
1121 void ast_config_destroy(struct ast_config *cfg)
1122 {
1123         struct ast_category *cat, *catn;
1124
1125         if (!cfg)
1126                 return;
1127
1128         ast_includes_destroy(cfg->includes);
1129
1130         cat = cfg->root;
1131         while (cat) {
1132                 catn = cat;
1133                 cat = cat->next;
1134                 ast_category_destroy(catn);
1135         }
1136         ast_free(cfg);
1137 }
1138
1139 struct ast_category *ast_config_get_current_category(const struct ast_config *cfg)
1140 {
1141         return cfg->current;
1142 }
1143
1144 void ast_config_set_current_category(struct ast_config *cfg, const struct ast_category *cat)
1145 {
1146         /* cast below is just to silence compiler warning about dropping "const" */
1147         cfg->current = (struct ast_category *) cat;
1148 }
1149
1150 /*!
1151  * \internal
1152  * \brief Create a new cfmtime list node.
1153  *
1154  * \param filename Config filename caching.
1155  * \param who_asked Who wanted to know.
1156  *
1157  * \retval cfmtime New node on success.
1158  * \retval NULL on error.
1159  */
1160 static struct cache_file_mtime *cfmtime_new(const char *filename, const char *who_asked)
1161 {
1162         struct cache_file_mtime *cfmtime;
1163         char *dst;
1164
1165         cfmtime = ast_calloc(1,
1166                 sizeof(*cfmtime) + strlen(filename) + 1 + strlen(who_asked) + 1);
1167         if (!cfmtime) {
1168                 return NULL;
1169         }
1170         dst = cfmtime->filename;        /* writable space starts here */
1171         strcpy(dst, filename);
1172         dst += strlen(dst) + 1;
1173         cfmtime->who_asked = strcpy(dst, who_asked);
1174
1175         return cfmtime;
1176 }
1177
1178 enum config_cache_attribute_enum {
1179         ATTRIBUTE_INCLUDE = 0,
1180         ATTRIBUTE_EXEC = 1,
1181 };
1182
1183 static void config_cache_attribute(const char *configfile, enum config_cache_attribute_enum attrtype, const char *filename, const char *who_asked)
1184 {
1185         struct cache_file_mtime *cfmtime;
1186         struct cache_file_include *cfinclude;
1187         struct stat statbuf = { 0, };
1188
1189         /* Find our cached entry for this configuration file */
1190         AST_LIST_LOCK(&cfmtime_head);
1191         AST_LIST_TRAVERSE(&cfmtime_head, cfmtime, list) {
1192                 if (!strcmp(cfmtime->filename, configfile) && !strcmp(cfmtime->who_asked, who_asked))
1193                         break;
1194         }
1195         if (!cfmtime) {
1196                 cfmtime = cfmtime_new(configfile, who_asked);
1197                 if (!cfmtime) {
1198                         AST_LIST_UNLOCK(&cfmtime_head);
1199                         return;
1200                 }
1201                 /* Note that the file mtime is initialized to 0, i.e. 1970 */
1202                 AST_LIST_INSERT_SORTALPHA(&cfmtime_head, cfmtime, list, filename);
1203         }
1204
1205         if (!stat(configfile, &statbuf))
1206                 cfmtime->mtime = 0;
1207         else
1208                 cfmtime->mtime = statbuf.st_mtime;
1209
1210         switch (attrtype) {
1211         case ATTRIBUTE_INCLUDE:
1212                 AST_LIST_TRAVERSE(&cfmtime->includes, cfinclude, list) {
1213                         if (!strcmp(cfinclude->include, filename)) {
1214                                 AST_LIST_UNLOCK(&cfmtime_head);
1215                                 return;
1216                         }
1217                 }
1218                 cfinclude = ast_calloc(1, sizeof(*cfinclude) + strlen(filename) + 1);
1219                 if (!cfinclude) {
1220                         AST_LIST_UNLOCK(&cfmtime_head);
1221                         return;
1222                 }
1223                 strcpy(cfinclude->include, filename);
1224                 AST_LIST_INSERT_TAIL(&cfmtime->includes, cfinclude, list);
1225                 break;
1226         case ATTRIBUTE_EXEC:
1227                 cfmtime->has_exec = 1;
1228                 break;
1229         }
1230         AST_LIST_UNLOCK(&cfmtime_head);
1231 }
1232
1233 /*! \brief parse one line in the configuration.
1234  * \verbatim
1235  * We can have a category header        [foo](...)
1236  * a directive                          #include / #exec
1237  * or a regular line                    name = value
1238  * \endverbatim
1239  */
1240 static int process_text_line(struct ast_config *cfg, struct ast_category **cat,
1241         char *buf, int lineno, const char *configfile, struct ast_flags flags,
1242         struct ast_str *comment_buffer,
1243         struct ast_str *lline_buffer,
1244         const char *suggested_include_file,
1245         struct ast_category **last_cat, struct ast_variable **last_var, const char *who_asked)
1246 {
1247         char *c;
1248         char *cur = buf;
1249         struct ast_variable *v;
1250         char cmd[512], exec_file[512];
1251
1252         /* Actually parse the entry */
1253         if (cur[0] == '[') { /* A category header */
1254                 /* format is one of the following:
1255                  * [foo]        define a new category named 'foo'
1256                  * [foo](!)     define a new template category named 'foo'
1257                  * [foo](+)     append to category 'foo', error if foo does not exist.
1258                  * [foo](a)     define a new category and inherit from category or template a.
1259                  *              You can put a comma-separated list of categories and templates
1260                  *              and '!' and '+' between parentheses, with obvious meaning.
1261                  */
1262                 struct ast_category *newcat = NULL;
1263                 char *catname;
1264
1265                 c = strchr(cur, ']');
1266                 if (!c) {
1267                         ast_log(LOG_WARNING, "parse error: no closing ']', line %d of %s\n", lineno, configfile);
1268                         return -1;
1269                 }
1270                 *c++ = '\0';
1271                 cur++;
1272                 if (*c++ != '(')
1273                         c = NULL;
1274                 catname = cur;
1275                 if (!(*cat = newcat = ast_category_new(catname,
1276                                 S_OR(suggested_include_file, cfg->include_level == 1 ? "" : configfile),
1277                                 lineno))) {
1278                         return -1;
1279                 }
1280                 (*cat)->lineno = lineno;
1281                 *last_var = 0;
1282                 *last_cat = newcat;
1283
1284                 /* add comments */
1285                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1286                         newcat->precomments = ALLOC_COMMENT(comment_buffer);
1287                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1288                         newcat->sameline = ALLOC_COMMENT(lline_buffer);
1289                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1290                         CB_RESET(comment_buffer, lline_buffer);
1291
1292                 /* If there are options or categories to inherit from, process them now */
1293                 if (c) {
1294                         if (!(cur = strchr(c, ')'))) {
1295                                 ast_log(LOG_WARNING, "parse error: no closing ')', line %d of %s\n", lineno, configfile);
1296                                 return -1;
1297                         }
1298                         *cur = '\0';
1299                         while ((cur = strsep(&c, ","))) {
1300                                 if (!strcasecmp(cur, "!")) {
1301                                         (*cat)->ignored = 1;
1302                                 } else if (!strcasecmp(cur, "+")) {
1303                                         *cat = category_get(cfg, catname, 1);
1304                                         if (!(*cat)) {
1305                                                 if (newcat)
1306                                                         ast_category_destroy(newcat);
1307                                                 ast_log(LOG_WARNING, "Category addition requested, but category '%s' does not exist, line %d of %s\n", catname, lineno, configfile);
1308                                                 return -1;
1309                                         }
1310                                         if (newcat) {
1311                                                 move_variables(newcat, *cat);
1312                                                 ast_category_destroy(newcat);
1313                                                 newcat = NULL;
1314                                         }
1315                                 } else {
1316                                         struct ast_category *base;
1317
1318                                         base = category_get(cfg, cur, 1);
1319                                         if (!base) {
1320                                                 ast_log(LOG_WARNING, "Inheritance requested, but category '%s' does not exist, line %d of %s\n", cur, lineno, configfile);
1321                                                 return -1;
1322                                         }
1323                                         inherit_category(*cat, base);
1324                                 }
1325                         }
1326                 }
1327                 if (newcat)
1328                         ast_category_append(cfg, *cat);
1329         } else if (cur[0] == '#') { /* A directive - #include or #exec */
1330                 char *cur2;
1331                 char real_inclusion_name[256];
1332                 int do_include = 0;     /* otherwise, it is exec */
1333                 int try_include = 0;
1334
1335                 cur++;
1336                 c = cur;
1337                 while (*c && (*c > 32)) {
1338                         c++;
1339                 }
1340
1341                 if (*c) {
1342                         *c = '\0';
1343                         /* Find real argument */
1344                         c = ast_strip(c + 1);
1345                         if (!(*c)) {
1346                                 c = NULL;
1347                         }
1348                 } else {
1349                         c = NULL;
1350                 }
1351                 if (!strcasecmp(cur, "include")) {
1352                         do_include = 1;
1353                 } else if (!strcasecmp(cur, "tryinclude")) {
1354                         do_include = 1;
1355                         try_include = 1;
1356                 } else if (!strcasecmp(cur, "exec")) {
1357                         if (!ast_opt_exec_includes) {
1358                                 ast_log(LOG_WARNING, "Cannot perform #exec unless execincludes option is enabled in asterisk.conf (options section)!\n");
1359                                 return 0;       /* XXX is this correct ? or we should return -1 ? */
1360                         }
1361                 } else {
1362                         ast_log(LOG_WARNING, "Unknown directive '#%s' at line %d of %s\n", cur, lineno, configfile);
1363                         return 0;       /* XXX is this correct ? or we should return -1 ? */
1364                 }
1365
1366                 if (c == NULL) {
1367                         ast_log(LOG_WARNING, "Directive '#%s' needs an argument (%s) at line %d of %s\n",
1368                                         do_include ? "include / tryinclude" : "exec",
1369                                         do_include ? "filename" : "/path/to/executable",
1370                                         lineno,
1371                                         configfile);
1372                         return 0;       /* XXX is this correct ? or we should return -1 ? */
1373                 }
1374
1375                 cur = c;
1376                 /* Strip off leading and trailing "'s and <>'s */
1377                 /* Dequote */
1378                 if ((*c == '"') || (*c == '<')) {
1379                         char quote_char = *c;
1380                         if (quote_char == '<') {
1381                                 quote_char = '>';
1382                         }
1383
1384                         if (*(c + strlen(c) - 1) == quote_char) {
1385                                 cur++;
1386                                 *(c + strlen(c) - 1) = '\0';
1387                         }
1388                 }
1389                 cur2 = cur;
1390
1391                 /* #exec </path/to/executable>
1392                    We create a tmp file, then we #include it, then we delete it. */
1393                 if (!do_include) {
1394                         struct timeval now = ast_tvnow();
1395                         if (!ast_test_flag(&flags, CONFIG_FLAG_NOCACHE))
1396                                 config_cache_attribute(configfile, ATTRIBUTE_EXEC, NULL, who_asked);
1397                         snprintf(exec_file, sizeof(exec_file), "/var/tmp/exec.%d%d.%ld", (int)now.tv_sec, (int)now.tv_usec, (long)pthread_self());
1398                         snprintf(cmd, sizeof(cmd), "%s > %s 2>&1", cur, exec_file);
1399                         ast_safe_system(cmd);
1400                         cur = exec_file;
1401                 } else {
1402                         if (!ast_test_flag(&flags, CONFIG_FLAG_NOCACHE))
1403                                 config_cache_attribute(configfile, ATTRIBUTE_INCLUDE, cur, who_asked);
1404                         exec_file[0] = '\0';
1405                 }
1406                 /* A #include */
1407                 /* record this inclusion */
1408                 ast_include_new(cfg, cfg->include_level == 1 ? "" : configfile, cur, !do_include, cur2, lineno, real_inclusion_name, sizeof(real_inclusion_name));
1409
1410                 do_include = ast_config_internal_load(cur, cfg, flags, real_inclusion_name, who_asked) ? 1 : 0;
1411                 if (!ast_strlen_zero(exec_file))
1412                         unlink(exec_file);
1413                 if (!do_include && !try_include) {
1414                         ast_log(LOG_ERROR, "The file '%s' was listed as a #include but it does not exist.\n", cur);
1415                         return -1;
1416                 }
1417                 /* XXX otherwise what ? the default return is 0 anyways */
1418
1419         } else {
1420                 /* Just a line (variable = value) */
1421                 int object = 0;
1422                 int is_escaped;
1423
1424                 if (!(*cat)) {
1425                         ast_log(LOG_WARNING,
1426                                 "parse error: No category context for line %d of %s\n", lineno, configfile);
1427                         return -1;
1428                 }
1429
1430                 is_escaped = cur[0] == '\\';
1431                 if (is_escaped) {
1432                         /* First character is escaped. */
1433                         ++cur;
1434                         if (cur[0] < 33) {
1435                                 ast_log(LOG_ERROR, "Invalid escape in line %d of %s\n", lineno, configfile);
1436                                 return -1;
1437                         }
1438                 }
1439                 c = strchr(cur + is_escaped, '=');
1440
1441                 if (c && c > cur + is_escaped && (*(c - 1) == '+')) {
1442                         struct ast_variable *var, *replace = NULL;
1443                         struct ast_str **str = ast_threadstorage_get(&appendbuf, sizeof(*str));
1444
1445                         if (!str || !*str) {
1446                                 return -1;
1447                         }
1448
1449                         *(c - 1) = '\0';
1450                         c++;
1451                         cur = ast_strip(cur);
1452
1453                         /* Must iterate through category until we find last variable of same name (since there could be multiple) */
1454                         for (var = ast_category_first(*cat); var; var = var->next) {
1455                                 if (!strcmp(var->name, cur)) {
1456                                         replace = var;
1457                                 }
1458                         }
1459
1460                         if (!replace) {
1461                                 /* Nothing to replace; just set a variable normally. */
1462                                 goto set_new_variable;
1463                         }
1464
1465                         ast_str_set(str, 0, "%s", replace->value);
1466                         ast_str_append(str, 0, "%s", c);
1467                         ast_str_trim_blanks(*str);
1468                         ast_variable_update(*cat, replace->name, ast_skip_blanks(ast_str_buffer(*str)), replace->value, object);
1469                 } else if (c) {
1470                         *c = 0;
1471                         c++;
1472                         /* Ignore > in => */
1473                         if (*c== '>') {
1474                                 object = 1;
1475                                 c++;
1476                         }
1477                         cur = ast_strip(cur);
1478 set_new_variable:
1479                         if (ast_strlen_zero(cur)) {
1480                                 ast_log(LOG_WARNING, "No variable name in line %d of %s\n", lineno, configfile);
1481                         } else if ((v = ast_variable_new(cur, ast_strip(c), S_OR(suggested_include_file, cfg->include_level == 1 ? "" : configfile)))) {
1482                                 v->lineno = lineno;
1483                                 v->object = object;
1484                                 *last_cat = 0;
1485                                 *last_var = v;
1486                                 /* Put and reset comments */
1487                                 v->blanklines = 0;
1488                                 ast_variable_append(*cat, v);
1489                                 /* add comments */
1490                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1491                                         v->precomments = ALLOC_COMMENT(comment_buffer);
1492                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1493                                         v->sameline = ALLOC_COMMENT(lline_buffer);
1494                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1495                                         CB_RESET(comment_buffer, lline_buffer);
1496
1497                         } else {
1498                                 return -1;
1499                         }
1500                 } else {
1501                         ast_log(LOG_WARNING, "No '=' (equal sign) in line %d of %s\n", lineno, configfile);
1502                 }
1503         }
1504         return 0;
1505 }
1506
1507 static struct ast_config *config_text_file_load(const char *database, const char *table, const char *filename, struct ast_config *cfg, struct ast_flags flags, const char *suggested_include_file, const char *who_asked)
1508 {
1509         char fn[256];
1510 #if defined(LOW_MEMORY)
1511         char buf[512];
1512 #else
1513         char buf[8192];
1514 #endif
1515         char *new_buf, *comment_p, *process_buf;
1516         FILE *f;
1517         int lineno=0;
1518         int comment = 0, nest[MAX_NESTED_COMMENTS];
1519         struct ast_category *cat = NULL;
1520         int count = 0;
1521         struct stat statbuf;
1522         struct cache_file_mtime *cfmtime = NULL;
1523         struct cache_file_include *cfinclude;
1524         struct ast_variable *last_var = 0;
1525         struct ast_category *last_cat = 0;
1526         /*! Growable string buffer */
1527         struct ast_str *comment_buffer = NULL;  /*!< this will be a comment collector.*/
1528         struct ast_str *lline_buffer = NULL;    /*!< A buffer for stuff behind the ; */
1529
1530         if (cfg)
1531                 cat = ast_config_get_current_category(cfg);
1532
1533         if (filename[0] == '/') {
1534                 ast_copy_string(fn, filename, sizeof(fn));
1535         } else {
1536                 snprintf(fn, sizeof(fn), "%s/%s", ast_config_AST_CONFIG_DIR, filename);
1537         }
1538
1539         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS)) {
1540                 comment_buffer = ast_str_create(CB_SIZE);
1541                 if (comment_buffer)
1542                         lline_buffer = ast_str_create(CB_SIZE);
1543                 if (!lline_buffer) {
1544                         ast_free(comment_buffer);
1545                         ast_log(LOG_ERROR, "Failed to initialize the comment buffer!\n");
1546                         return NULL;
1547                 }
1548         }
1549 #ifdef AST_INCLUDE_GLOB
1550         {
1551                 int glob_ret;
1552                 glob_t globbuf;
1553                 globbuf.gl_offs = 0;    /* initialize it to silence gcc */
1554                 glob_ret = glob(fn, MY_GLOB_FLAGS, NULL, &globbuf);
1555                 if (glob_ret == GLOB_NOSPACE)
1556                         ast_log(LOG_WARNING,
1557                                 "Glob Expansion of pattern '%s' failed: Not enough memory\n", fn);
1558                 else if (glob_ret  == GLOB_ABORTED)
1559                         ast_log(LOG_WARNING,
1560                                 "Glob Expansion of pattern '%s' failed: Read error\n", fn);
1561                 else  {
1562                         /* loop over expanded files */
1563                         int i;
1564                         for (i=0; i<globbuf.gl_pathc; i++) {
1565                                 ast_copy_string(fn, globbuf.gl_pathv[i], sizeof(fn));
1566 #endif
1567         /*
1568          * The following is not a loop, but just a convenient way to define a block
1569          * (using do { } while(0) ), and be able to exit from it with 'continue'
1570          * or 'break' in case of errors. Nice trick.
1571          */
1572         do {
1573                 if (stat(fn, &statbuf))
1574                         continue;
1575
1576                 if (!S_ISREG(statbuf.st_mode)) {
1577                         ast_log(LOG_WARNING, "'%s' is not a regular file, ignoring\n", fn);
1578                         continue;
1579                 }
1580
1581                 if (!ast_test_flag(&flags, CONFIG_FLAG_NOCACHE)) {
1582                         /* Find our cached entry for this configuration file */
1583                         AST_LIST_LOCK(&cfmtime_head);
1584                         AST_LIST_TRAVERSE(&cfmtime_head, cfmtime, list) {
1585                                 if (!strcmp(cfmtime->filename, fn) && !strcmp(cfmtime->who_asked, who_asked))
1586                                         break;
1587                         }
1588                         if (!cfmtime) {
1589                                 cfmtime = cfmtime_new(fn, who_asked);
1590                                 if (!cfmtime)
1591                                         continue;
1592                                 /* Note that the file mtime is initialized to 0, i.e. 1970 */
1593                                 AST_LIST_INSERT_SORTALPHA(&cfmtime_head, cfmtime, list, filename);
1594                         }
1595                 }
1596
1597                 if (cfmtime && (!cfmtime->has_exec) && (cfmtime->mtime == statbuf.st_mtime) && ast_test_flag(&flags, CONFIG_FLAG_FILEUNCHANGED)) {
1598                         /* File is unchanged, what about the (cached) includes (if any)? */
1599                         int unchanged = 1;
1600                         AST_LIST_TRAVERSE(&cfmtime->includes, cfinclude, list) {
1601                                 /* We must glob here, because if we did not, then adding a file to globbed directory would
1602                                  * incorrectly cause no reload to be necessary. */
1603                                 char fn2[256];
1604 #ifdef AST_INCLUDE_GLOB
1605                                 int glob_return;
1606                                 glob_t glob_buf = { .gl_offs = 0 };
1607                                 glob_return = glob(cfinclude->include, MY_GLOB_FLAGS, NULL, &glob_buf);
1608                                 /* On error, we reparse */
1609                                 if (glob_return == GLOB_NOSPACE || glob_return  == GLOB_ABORTED)
1610                                         unchanged = 0;
1611                                 else  {
1612                                         /* loop over expanded files */
1613                                         int j;
1614                                         for (j = 0; j < glob_buf.gl_pathc; j++) {
1615                                                 ast_copy_string(fn2, glob_buf.gl_pathv[j], sizeof(fn2));
1616 #else
1617                                                 ast_copy_string(fn2, cfinclude->include);
1618 #endif
1619                                                 if (config_text_file_load(NULL, NULL, fn2, NULL, flags, "", who_asked) == NULL) {
1620                                                         /* that second-to-last field needs to be looked at in this case... TODO */
1621                                                         unchanged = 0;
1622                                                         /* One change is enough to short-circuit and reload the whole shebang */
1623                                                         break;
1624                                                 }
1625 #ifdef AST_INCLUDE_GLOB
1626                                         }
1627                                 }
1628 #endif
1629                         }
1630
1631                         if (unchanged) {
1632                                 AST_LIST_UNLOCK(&cfmtime_head);
1633                                 ast_free(comment_buffer);
1634                                 ast_free(lline_buffer);
1635 #ifdef AST_INCLUDE_GLOB
1636                                 globfree(&globbuf);
1637 #endif
1638                                 return CONFIG_STATUS_FILEUNCHANGED;
1639                         }
1640                 }
1641                 if (!ast_test_flag(&flags, CONFIG_FLAG_NOCACHE))
1642                         AST_LIST_UNLOCK(&cfmtime_head);
1643
1644                 /* If cfg is NULL, then we just want an answer */
1645                 if (cfg == NULL) {
1646                         ast_free(comment_buffer);
1647                         ast_free(lline_buffer);
1648 #ifdef AST_INCLUDE_GLOB
1649                                 globfree(&globbuf);
1650 #endif
1651                         return NULL;
1652                 }
1653
1654                 if (cfmtime)
1655                         cfmtime->mtime = statbuf.st_mtime;
1656
1657                 if (!(f = fopen(fn, "r"))) {
1658                         ast_debug(1, "No file to parse: %s\n", fn);
1659                         ast_verb(2, "Parsing '%s': Not found (%s)\n", fn, strerror(errno));
1660                         continue;
1661                 }
1662                 count++;
1663                 /* If we get to this point, then we're loading regardless */
1664                 ast_clear_flag(&flags, CONFIG_FLAG_FILEUNCHANGED);
1665                 ast_debug(1, "Parsing %s\n", fn);
1666                 ast_verb(2, "Parsing '%s': Found\n", fn);
1667                 while (!feof(f)) {
1668                         lineno++;
1669                         if (fgets(buf, sizeof(buf), f)) {
1670                                 /* Skip lines that are too long */
1671                                 if (strlen(buf) == sizeof(buf) - 1 && buf[sizeof(buf) - 1] != '\n') {
1672                                         ast_log(LOG_WARNING, "Line %d too long, skipping. It begins with: %.32s...\n", lineno, buf);
1673                                         while (fgets(buf, sizeof(buf), f)) {
1674                                                 if (strlen(buf) != sizeof(buf) - 1 || buf[sizeof(buf) - 1] == '\n') {
1675                                                         break;
1676                                                 }
1677                                         }
1678                                         continue;
1679                                 }
1680
1681                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && lline_buffer && ast_str_strlen(lline_buffer)) {
1682                                         CB_ADD(&comment_buffer, ast_str_buffer(lline_buffer));       /* add the current lline buffer to the comment buffer */
1683                                         ast_str_reset(lline_buffer);        /* erase the lline buffer */
1684                                 }
1685
1686                                 new_buf = buf;
1687                                 if (comment)
1688                                         process_buf = NULL;
1689                                 else
1690                                         process_buf = buf;
1691
1692                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && comment_buffer && ast_str_strlen(comment_buffer) && (ast_strlen_zero(buf) || strlen(buf) == strspn(buf," \t\n\r"))) {
1693                                         /* blank line? really? Can we add it to an existing comment and maybe preserve inter- and post- comment spacing? */
1694                                         CB_ADD(&comment_buffer, "\n");       /* add a newline to the comment buffer */
1695                                         continue; /* go get a new line, then */
1696                                 }
1697
1698                                 while ((comment_p = strchr(new_buf, COMMENT_META))) {
1699                                         if ((comment_p > new_buf) && (*(comment_p - 1) == '\\')) {
1700                                                 /* Escaped semicolons aren't comments. */
1701                                                 new_buf = comment_p;
1702                                                 /* write over the \ and bring the null terminator with us */
1703                                                 memmove(comment_p - 1, comment_p, strlen(comment_p) + 1);
1704                                         } else if (comment_p[1] == COMMENT_TAG && comment_p[2] == COMMENT_TAG && (comment_p[3] != '-')) {
1705                                                 /* Meta-Comment start detected ";--" */
1706                                                 if (comment < MAX_NESTED_COMMENTS) {
1707                                                         *comment_p = '\0';
1708                                                         new_buf = comment_p + 3;
1709                                                         comment++;
1710                                                         nest[comment-1] = lineno;
1711                                                 } else {
1712                                                         ast_log(LOG_ERROR, "Maximum nest limit of %d reached.\n", MAX_NESTED_COMMENTS);
1713                                                 }
1714                                         } else if ((comment_p >= new_buf + 2) &&
1715                                                    (*(comment_p - 1) == COMMENT_TAG) &&
1716                                                    (*(comment_p - 2) == COMMENT_TAG)) {
1717                                                 /* Meta-Comment end detected */
1718                                                 comment--;
1719                                                 new_buf = comment_p + 1;
1720                                                 if (!comment) {
1721                                                         /* Back to non-comment now */
1722                                                         if (process_buf) {
1723                                                                 /* Actually have to move what's left over the top, then continue */
1724                                                                 char *oldptr;
1725                                                                 oldptr = process_buf + strlen(process_buf);
1726                                                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS)) {
1727                                                                         CB_ADD(&comment_buffer, ";");
1728                                                                         CB_ADD_LEN(&comment_buffer, oldptr+1, new_buf-oldptr-1);
1729                                                                 }
1730
1731                                                                 memmove(oldptr, new_buf, strlen(new_buf) + 1);
1732                                                                 new_buf = oldptr;
1733                                                         } else
1734                                                                 process_buf = new_buf;
1735                                                 }
1736                                         } else {
1737                                                 if (!comment) {
1738                                                         /* If ; is found, and we are not nested in a comment,
1739                                                            we immediately stop all comment processing */
1740                                                         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS)) {
1741                                                                 CB_ADD(&lline_buffer, comment_p);
1742                                                         }
1743                                                         *comment_p = '\0';
1744                                                         new_buf = comment_p;
1745                                                 } else
1746                                                         new_buf = comment_p + 1;
1747                                         }
1748                                 }
1749                                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && comment && !process_buf ) {
1750                                         CB_ADD(&comment_buffer, buf);  /* the whole line is a comment, store it */
1751                                 }
1752
1753                                 if (process_buf) {
1754                                         char *buffer = ast_strip(process_buf);
1755                                         if (!ast_strlen_zero(buffer)) {
1756                                                 if (process_text_line(cfg, &cat, buffer, lineno, fn, flags, comment_buffer, lline_buffer, suggested_include_file, &last_cat, &last_var, who_asked)) {
1757                                                         cfg = CONFIG_STATUS_FILEINVALID;
1758                                                         break;
1759                                                 }
1760                                         }
1761                                 }
1762                         }
1763                 }
1764                 /* end of file-- anything in a comment buffer? */
1765                 if (last_cat) {
1766                         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && comment_buffer && ast_str_strlen(comment_buffer)) {
1767                                 if (lline_buffer && ast_str_strlen(lline_buffer)) {
1768                                         CB_ADD(&comment_buffer, ast_str_buffer(lline_buffer));       /* add the current lline buffer to the comment buffer */
1769                                         ast_str_reset(lline_buffer);        /* erase the lline buffer */
1770                                 }
1771                                 last_cat->trailing = ALLOC_COMMENT(comment_buffer);
1772                         }
1773                 } else if (last_var) {
1774                         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && comment_buffer && ast_str_strlen(comment_buffer)) {
1775                                 if (lline_buffer && ast_str_strlen(lline_buffer)) {
1776                                         CB_ADD(&comment_buffer, ast_str_buffer(lline_buffer));       /* add the current lline buffer to the comment buffer */
1777                                         ast_str_reset(lline_buffer);        /* erase the lline buffer */
1778                                 }
1779                                 last_var->trailing = ALLOC_COMMENT(comment_buffer);
1780                         }
1781                 } else {
1782                         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS) && comment_buffer && ast_str_strlen(comment_buffer)) {
1783                                 ast_debug(1, "Nothing to attach comments to, discarded: %s\n", ast_str_buffer(comment_buffer));
1784                         }
1785                 }
1786                 if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS))
1787                         CB_RESET(comment_buffer, lline_buffer);
1788
1789                 fclose(f);
1790         } while (0);
1791         if (comment) {
1792                 ast_log(LOG_WARNING,"Unterminated comment detected beginning on line %d\n", nest[comment - 1]);
1793         }
1794 #ifdef AST_INCLUDE_GLOB
1795                                         if (cfg == NULL || cfg == CONFIG_STATUS_FILEUNCHANGED || cfg == CONFIG_STATUS_FILEINVALID) {
1796                                                 break;
1797                                         }
1798                                 }
1799                                 globfree(&globbuf);
1800                         }
1801                 }
1802 #endif
1803
1804         if (ast_test_flag(&flags, CONFIG_FLAG_WITHCOMMENTS)) {
1805                 ast_free(comment_buffer);
1806                 ast_free(lline_buffer);
1807                 comment_buffer = NULL;
1808                 lline_buffer = NULL;
1809         }
1810
1811         if (count == 0)
1812                 return NULL;
1813
1814         return cfg;
1815 }
1816
1817
1818 /* NOTE: categories and variables each have a file and lineno attribute. On a save operation, these are used to determine
1819    which file and line number to write out to. Thus, an entire hierarchy of config files (via #include statements) can be
1820    recreated. BUT, care must be taken to make sure that every cat and var has the proper file name stored, or you may
1821    be shocked and mystified as to why things are not showing up in the files!
1822
1823    Also, All #include/#exec statements are recorded in the "includes" LL in the ast_config structure. The file name
1824    and line number are stored for each include, plus the name of the file included, so that these statements may be
1825    included in the output files on a file_save operation.
1826
1827    The lineno's are really just for relative placement in the file. There is no attempt to make sure that blank lines
1828    are included to keep the lineno's the same between input and output. The lineno fields are used mainly to determine
1829    the position of the #include and #exec directives. So, blank lines tend to disappear from a read/rewrite operation,
1830    and a header gets added.
1831
1832    vars and category heads are output in the order they are stored in the config file. So, if the software
1833    shuffles these at all, then the placement of #include directives might get a little mixed up, because the
1834    file/lineno data probably won't get changed.
1835
1836 */
1837
1838 static void gen_header(FILE *f1, const char *configfile, const char *fn, const char *generator)
1839 {
1840         char date[256]="";
1841         time_t t;
1842
1843         time(&t);
1844         ast_copy_string(date, ctime(&t), sizeof(date));
1845
1846         fprintf(f1, ";!\n");
1847         fprintf(f1, ";! Automatically generated configuration file\n");
1848         if (strcmp(configfile, fn))
1849                 fprintf(f1, ";! Filename: %s (%s)\n", configfile, fn);
1850         else
1851                 fprintf(f1, ";! Filename: %s\n", configfile);
1852         fprintf(f1, ";! Generator: %s\n", generator);
1853         fprintf(f1, ";! Creation Date: %s", date);
1854         fprintf(f1, ";!\n");
1855 }
1856
1857 static void inclfile_destroy(void *obj)
1858 {
1859         const struct inclfile *o = obj;
1860
1861         ast_free(o->fname);
1862 }
1863
1864
1865 static struct inclfile *set_fn(char *fn, int fn_size, const char *file, const char *configfile, struct ao2_container *fileset)
1866 {
1867         struct inclfile lookup;
1868         struct inclfile *fi;
1869
1870         if (ast_strlen_zero(file)) {
1871                 if (configfile[0] == '/')
1872                         ast_copy_string(fn, configfile, fn_size);
1873                 else
1874                         snprintf(fn, fn_size, "%s/%s", ast_config_AST_CONFIG_DIR, configfile);
1875         } else if (file[0] == '/')
1876                 ast_copy_string(fn, file, fn_size);
1877         else
1878                 snprintf(fn, fn_size, "%s/%s", ast_config_AST_CONFIG_DIR, file);
1879         lookup.fname = fn;
1880         fi = ao2_find(fileset, &lookup, OBJ_POINTER);
1881         if (fi) {
1882                 /* Found existing include file scratch pad. */
1883                 return fi;
1884         }
1885
1886         /* set up a file scratch pad */
1887         fi = ao2_alloc(sizeof(struct inclfile), inclfile_destroy);
1888         if (!fi) {
1889                 /* Scratch pad creation failed. */
1890                 return NULL;
1891         }
1892         fi->fname = ast_strdup(fn);
1893         if (!fi->fname) {
1894                 /* Scratch pad creation failed. */
1895                 ao2_ref(fi, -1);
1896                 return NULL;
1897         }
1898         fi->lineno = 1;
1899
1900         ao2_link(fileset, fi);
1901
1902         return fi;
1903 }
1904
1905 static int count_linefeeds(char *str)
1906 {
1907         int count = 0;
1908
1909         while (*str) {
1910                 if (*str =='\n')
1911                         count++;
1912                 str++;
1913         }
1914         return count;
1915 }
1916
1917 static int count_linefeeds_in_comments(struct ast_comment *x)
1918 {
1919         int count = 0;
1920
1921         while (x) {
1922                 count += count_linefeeds(x->cmt);
1923                 x = x->next;
1924         }
1925         return count;
1926 }
1927
1928 static void insert_leading_blank_lines(FILE *fp, struct inclfile *fi, struct ast_comment *precomments, int lineno)
1929 {
1930         int precomment_lines;
1931         int i;
1932
1933         if (!fi) {
1934                 /* No file scratch pad object so insert no blank lines. */
1935                 return;
1936         }
1937
1938         precomment_lines = count_linefeeds_in_comments(precomments);
1939
1940         /* I don't have to worry about those ;! comments, they are
1941            stored in the precomments, but not printed back out.
1942            I did have to make sure that comments following
1943            the ;! header comments were not also deleted in the process */
1944         if (lineno - precomment_lines - fi->lineno < 0) { /* insertions can mess up the line numbering and produce negative numbers that mess things up */
1945                 return;
1946         } else if (lineno == 0) {
1947                 /* Line replacements also mess things up */
1948                 return;
1949         } else if (lineno - precomment_lines - fi->lineno < 5) {
1950                 /* Only insert less than 5 blank lines; if anything more occurs,
1951                  * it's probably due to context deletion. */
1952                 for (i = fi->lineno; i < lineno - precomment_lines; i++) {
1953                         fprintf(fp, "\n");
1954                 }
1955         } else {
1956                 /* Deletion occurred - insert a single blank line, for separation of
1957                  * contexts. */
1958                 fprintf(fp, "\n");
1959         }
1960
1961         fi->lineno = lineno + 1; /* Advance the file lineno */
1962 }
1963
1964 int config_text_file_save(const char *configfile, const struct ast_config *cfg, const char *generator)
1965 {
1966         return ast_config_text_file_save(configfile, cfg, generator);
1967 }
1968
1969 int ast_config_text_file_save(const char *configfile, const struct ast_config *cfg, const char *generator)
1970 {
1971         FILE *f;
1972         char fn[PATH_MAX];
1973         struct ast_variable *var;
1974         struct ast_category *cat;
1975         struct ast_comment *cmt;
1976         struct ast_config_include *incl;
1977         int blanklines = 0;
1978         struct ao2_container *fileset;
1979         struct inclfile *fi;
1980
1981         fileset = ao2_container_alloc(1023, hash_string, hashtab_compare_strings);
1982         if (!fileset) {
1983                 /* Container creation failed. */
1984                 return -1;
1985         }
1986
1987         /* reset all the output flags, in case this isn't our first time saving this data */
1988         for (incl = cfg->includes; incl; incl = incl->next) {
1989                 incl->output = 0;
1990         }
1991
1992         /* go thru all the inclusions and make sure all the files involved (configfile plus all its inclusions)
1993            are all truncated to zero bytes and have that nice header*/
1994         for (incl = cfg->includes; incl; incl = incl->next) {
1995                 if (!incl->exec) { /* leave the execs alone -- we'll write out the #exec directives, but won't zero out the include files or exec files*/
1996                         /* normally, fn is just set to incl->included_file, prepended with config dir if relative */
1997                         fi = set_fn(fn, sizeof(fn), incl->included_file, configfile, fileset);
1998                         f = fopen(fn, "w");
1999                         if (f) {
2000                                 gen_header(f, configfile, fn, generator);
2001                                 fclose(f); /* this should zero out the file */
2002                         } else {
2003                                 ast_debug(1, "Unable to open for writing: %s\n", fn);
2004                                 ast_verb(2, "Unable to write %s (%s)\n", fn, strerror(errno));
2005                         }
2006                         if (fi) {
2007                                 ao2_ref(fi, -1);
2008                         }
2009                 }
2010         }
2011
2012         /* just set fn to absolute ver of configfile */
2013         fi = set_fn(fn, sizeof(fn), 0, configfile, fileset);
2014         if (
2015 #ifdef __CYGWIN__
2016                 (f = fopen(fn, "w+"))
2017 #else
2018                 (f = fopen(fn, "w"))
2019 #endif
2020                 ) {
2021                 ast_verb(2, "Saving '%s'\n", fn);
2022                 gen_header(f, configfile, fn, generator);
2023                 cat = cfg->root;
2024                 fclose(f);
2025                 if (fi) {
2026                         ao2_ref(fi, -1);
2027                 }
2028
2029                 /* from here out, we open each involved file and concat the stuff we need to add to the end and immediately close... */
2030                 /* since each var, cat, and associated comments can come from any file, we have to be
2031                    mobile, and open each file, print, and close it on an entry-by-entry basis */
2032
2033                 while (cat) {
2034                         fi = set_fn(fn, sizeof(fn), cat->file, configfile, fileset);
2035                         f = fopen(fn, "a");
2036                         if (!f) {
2037                                 ast_debug(1, "Unable to open for writing: %s\n", fn);
2038                                 ast_verb(2, "Unable to write %s (%s)\n", fn, strerror(errno));
2039                                 if (fi) {
2040                                         ao2_ref(fi, -1);
2041                                 }
2042                                 ao2_ref(fileset, -1);
2043                                 return -1;
2044                         }
2045
2046                         /* dump any includes that happen before this category header */
2047                         for (incl=cfg->includes; incl; incl = incl->next) {
2048                                 if (strcmp(incl->include_location_file, cat->file) == 0){
2049                                         if (cat->lineno > incl->include_location_lineno && !incl->output) {
2050                                                 if (incl->exec)
2051                                                         fprintf(f,"#exec \"%s\"\n", incl->exec_file);
2052                                                 else
2053                                                         fprintf(f,"#include \"%s\"\n", incl->included_file);
2054                                                 incl->output = 1;
2055                                         }
2056                                 }
2057                         }
2058
2059                         insert_leading_blank_lines(f, fi, cat->precomments, cat->lineno);
2060                         /* Dump section with any appropriate comment */
2061                         for (cmt = cat->precomments; cmt; cmt=cmt->next) {
2062                                 char *cmtp = cmt->cmt;
2063                                 while (cmtp && *cmtp == ';' && *(cmtp+1) == '!') {
2064                                         char *cmtp2 = strchr(cmtp+1, '\n');
2065                                         if (cmtp2)
2066                                                 cmtp = cmtp2+1;
2067                                         else cmtp = 0;
2068                                 }
2069                                 if (cmtp)
2070                                         fprintf(f,"%s", cmtp);
2071                         }
2072                         fprintf(f, "[%s]", cat->name);
2073                         if (cat->ignored || !AST_LIST_EMPTY(&cat->template_instances)) {
2074                                 fprintf(f, "(");
2075                                 if (cat->ignored) {
2076                                         fprintf(f, "!");
2077                                 }
2078                                 if (cat->ignored && !AST_LIST_EMPTY(&cat->template_instances)) {
2079                                         fprintf(f, ",");
2080                                 }
2081                                 if (!AST_LIST_EMPTY(&cat->template_instances)) {
2082                                         struct ast_category_template_instance *x;
2083                                         AST_LIST_TRAVERSE(&cat->template_instances, x, next) {
2084                                                 fprintf(f,"%s",x->name);
2085                                                 if (x != AST_LIST_LAST(&cat->template_instances))
2086                                                         fprintf(f,",");
2087                                         }
2088                                 }
2089                                 fprintf(f, ")");
2090                         }
2091                         for(cmt = cat->sameline; cmt; cmt=cmt->next)
2092                         {
2093                                 fprintf(f,"%s", cmt->cmt);
2094                         }
2095                         if (!cat->sameline)
2096                                 fprintf(f,"\n");
2097                         for (cmt = cat->trailing; cmt; cmt=cmt->next) {
2098                                 if (cmt->cmt[0] != ';' || cmt->cmt[1] != '!')
2099                                         fprintf(f,"%s", cmt->cmt);
2100                         }
2101                         fclose(f);
2102                         if (fi) {
2103                                 ao2_ref(fi, -1);
2104                         }
2105
2106                         var = cat->root;
2107                         while (var) {
2108                                 struct ast_category_template_instance *x;
2109                                 int found = 0;
2110                                 AST_LIST_TRAVERSE(&cat->template_instances, x, next) {
2111                                         struct ast_variable *v;
2112                                         for (v = x->inst->root; v; v = v->next) {
2113                                                 if (!strcasecmp(var->name, v->name) && !strcmp(var->value, v->value)) {
2114                                                         found = 1;
2115                                                         break;
2116                                                 }
2117                                         }
2118                                         if (found)
2119                                                 break;
2120                                 }
2121                                 if (found) {
2122                                         var = var->next;
2123                                         continue;
2124                                 }
2125                                 fi = set_fn(fn, sizeof(fn), var->file, configfile, fileset);
2126                                 f = fopen(fn, "a");
2127                                 if (!f) {
2128                                         ast_debug(1, "Unable to open for writing: %s\n", fn);
2129                                         ast_verb(2, "Unable to write %s (%s)\n", fn, strerror(errno));
2130                                         if (fi) {
2131                                                 ao2_ref(fi, -1);
2132                                         }
2133                                         ao2_ref(fileset, -1);
2134                                         return -1;
2135                                 }
2136
2137                                 /* dump any includes that happen before this category header */
2138                                 for (incl=cfg->includes; incl; incl = incl->next) {
2139                                         if (strcmp(incl->include_location_file, var->file) == 0){
2140                                                 if (var->lineno > incl->include_location_lineno && !incl->output) {
2141                                                         if (incl->exec)
2142                                                                 fprintf(f,"#exec \"%s\"\n", incl->exec_file);
2143                                                         else
2144                                                                 fprintf(f,"#include \"%s\"\n", incl->included_file);
2145                                                         incl->output = 1;
2146                                                 }
2147                                         }
2148                                 }
2149
2150                                 insert_leading_blank_lines(f, fi, var->precomments, var->lineno);
2151                                 for (cmt = var->precomments; cmt; cmt=cmt->next) {
2152                                         if (cmt->cmt[0] != ';' || cmt->cmt[1] != '!')
2153                                                 fprintf(f,"%s", cmt->cmt);
2154                                 }
2155                                 if (var->sameline)
2156                                         fprintf(f, "%s %s %s  %s", var->name, (var->object ? "=>" : "="), var->value, var->sameline->cmt);
2157                                 else
2158                                         fprintf(f, "%s %s %s\n", var->name, (var->object ? "=>" : "="), var->value);
2159                                 for (cmt = var->trailing; cmt; cmt=cmt->next) {
2160                                         if (cmt->cmt[0] != ';' || cmt->cmt[1] != '!')
2161                                                 fprintf(f,"%s", cmt->cmt);
2162                                 }
2163                                 if (var->blanklines) {
2164                                         blanklines = var->blanklines;
2165                                         while (blanklines--)
2166                                                 fprintf(f, "\n");
2167                                 }
2168
2169                                 fclose(f);
2170                                 if (fi) {
2171                                         ao2_ref(fi, -1);
2172                                 }
2173
2174                                 var = var->next;
2175                         }
2176                         cat = cat->next;
2177                 }
2178                 if (!option_debug) {
2179                         ast_verb(2, "Saving '%s': saved\n", fn);
2180                 }
2181         } else {
2182                 ast_debug(1, "Unable to open for writing: %s\n", fn);
2183                 ast_verb(2, "Unable to write '%s' (%s)\n", fn, strerror(errno));
2184                 if (fi) {
2185                         ao2_ref(fi, -1);
2186                 }
2187                 ao2_ref(fileset, -1);
2188                 return -1;
2189         }
2190
2191         /* Now, for files with trailing #include/#exec statements,
2192            we have to make sure every entry is output */
2193         for (incl=cfg->includes; incl; incl = incl->next) {
2194                 if (!incl->output) {
2195                         /* open the respective file */
2196                         fi = set_fn(fn, sizeof(fn), incl->include_location_file, configfile, fileset);
2197                         f = fopen(fn, "a");
2198                         if (!f) {
2199                                 ast_debug(1, "Unable to open for writing: %s\n", fn);
2200                                 ast_verb(2, "Unable to write %s (%s)\n", fn, strerror(errno));
2201                                 if (fi) {
2202                                         ao2_ref(fi, -1);
2203                                 }
2204                                 ao2_ref(fileset, -1);
2205                                 return -1;
2206                         }
2207
2208                         /* output the respective include */
2209                         if (incl->exec)
2210                                 fprintf(f,"#exec \"%s\"\n", incl->exec_file);
2211                         else
2212                                 fprintf(f,"#include \"%s\"\n", incl->included_file);
2213                         fclose(f);
2214                         incl->output = 1;
2215                         if (fi) {
2216                                 ao2_ref(fi, -1);
2217                         }
2218                 }
2219         }
2220         ao2_ref(fileset, -1); /* this should destroy the hash container */
2221
2222         return 0;
2223 }
2224
2225 static void clear_config_maps(void)
2226 {
2227         struct ast_config_map *map;
2228
2229         SCOPED_MUTEX(lock, &config_lock);
2230
2231         while (config_maps) {
2232                 map = config_maps;
2233                 config_maps = config_maps->next;
2234                 ast_free(map);
2235         }
2236 }
2237
2238 #ifdef TEST_FRAMEWORK
2239 int ast_realtime_append_mapping(const char *name, const char *driver, const char *database, const char *table, int priority)
2240 #else
2241 static int ast_realtime_append_mapping(const char *name, const char *driver, const char *database, const char *table, int priority)
2242 #endif
2243 {
2244         struct ast_config_map *map;
2245         char *dst;
2246         int length;
2247
2248         length = sizeof(*map);
2249         length += strlen(name) + 1;
2250         length += strlen(driver) + 1;
2251         length += strlen(database) + 1;
2252         if (table)
2253                 length += strlen(table) + 1;
2254
2255         if (!(map = ast_calloc(1, length)))
2256                 return -1;
2257
2258         dst = map->stuff;       /* writable space starts here */
2259         map->name = strcpy(dst, name);
2260         dst += strlen(dst) + 1;
2261         map->driver = strcpy(dst, driver);
2262         dst += strlen(dst) + 1;
2263         map->database = strcpy(dst, database);
2264         if (table) {
2265                 dst += strlen(dst) + 1;
2266                 map->table = strcpy(dst, table);
2267         }
2268         map->priority = priority;
2269         map->next = config_maps;
2270         config_maps = map;
2271
2272         ast_verb(2, "Binding %s to %s/%s/%s\n", map->name, map->driver, map->database, map->table ? map->table : map->name);
2273
2274         return 0;
2275 }
2276
2277 int read_config_maps(void)
2278 {
2279         struct ast_config *config, *configtmp;
2280         struct ast_variable *v;
2281         char *driver, *table, *database, *textpri, *stringp, *tmp;
2282         struct ast_flags flags = { CONFIG_FLAG_NOREALTIME };
2283         int pri;
2284
2285         clear_config_maps();
2286
2287         configtmp = ast_config_new();
2288         if (!configtmp) {
2289                 ast_log(LOG_ERROR, "Unable to allocate memory for new config\n");
2290                 return -1;
2291         }
2292         configtmp->max_include_level = 1;
2293         config = ast_config_internal_load(extconfig_conf, configtmp, flags, "", "extconfig");
2294         if (config == CONFIG_STATUS_FILEINVALID) {
2295                 return -1;
2296         } else if (!config) {
2297                 ast_config_destroy(configtmp);
2298                 return 0;
2299         }
2300
2301         for (v = ast_variable_browse(config, "settings"); v; v = v->next) {
2302                 char buf[512];
2303                 ast_copy_string(buf, v->value, sizeof(buf));
2304                 stringp = buf;
2305                 driver = strsep(&stringp, ",");
2306
2307                 if ((tmp = strchr(stringp, '\"')))
2308                         stringp = tmp;
2309
2310                 /* check if the database text starts with a double quote */
2311                 if (*stringp == '"') {
2312                         stringp++;
2313                         database = strsep(&stringp, "\"");
2314                         strsep(&stringp, ",");
2315                 } else {
2316                         /* apparently this text has no quotes */
2317                         database = strsep(&stringp, ",");
2318                 }
2319
2320                 table = strsep(&stringp, ",");
2321                 textpri = strsep(&stringp, ",");
2322                 if (!textpri || !(pri = atoi(textpri))) {
2323                         pri = 1;
2324                 }
2325
2326                 if (!strcmp(v->name, extconfig_conf)) {
2327                         ast_log(LOG_WARNING, "Cannot bind '%s'!\n", extconfig_conf);
2328                         continue;
2329                 }
2330
2331                 if (!strcmp(v->name, "asterisk.conf")) {
2332                         ast_log(LOG_WARNING, "Cannot bind 'asterisk.conf'!\n");
2333                         continue;
2334                 }
2335
2336                 if (!strcmp(v->name, "logger.conf")) {
2337                         ast_log(LOG_WARNING, "Cannot bind 'logger.conf'!\n");
2338                         continue;
2339                 }
2340
2341                 if (!driver || !database)
2342                         continue;
2343                 if (!strcasecmp(v->name, "sipfriends")) {
2344                         ast_log(LOG_WARNING, "The 'sipfriends' table is obsolete, update your config to use sippeers instead.\n");
2345                         ast_realtime_append_mapping("sippeers", driver, database, table ? table : "sipfriends", pri);
2346                 } else if (!strcasecmp(v->name, "iaxfriends")) {
2347                         ast_log(LOG_WARNING, "The 'iaxfriends' table is obsolete, update your config to use iaxusers and iaxpeers, though they can point to the same table.\n");
2348                         ast_realtime_append_mapping("iaxusers", driver, database, table ? table : "iaxfriends", pri);
2349                         ast_realtime_append_mapping("iaxpeers", driver, database, table ? table : "iaxfriends", pri);
2350                 } else
2351                         ast_realtime_append_mapping(v->name, driver, database, table, pri);
2352         }
2353
2354         ast_config_destroy(config);
2355         return 0;
2356 }
2357
2358 int ast_config_engine_register(struct ast_config_engine *new)
2359 {
2360         struct ast_config_engine *ptr;
2361
2362         SCOPED_MUTEX(lock, &config_lock);
2363
2364         if (!config_engine_list) {
2365                 config_engine_list = new;
2366         } else {
2367                 for (ptr = config_engine_list; ptr->next; ptr=ptr->next);
2368                 ptr->next = new;
2369         }
2370
2371         ast_log(LOG_NOTICE,"Registered Config Engine %s\n", new->name);
2372
2373         return 1;
2374 }
2375
2376 int ast_config_engine_deregister(struct ast_config_engine *del)
2377 {
2378         struct ast_config_engine *ptr, *last=NULL;
2379
2380         SCOPED_MUTEX(lock, &config_lock);
2381
2382         for (ptr = config_engine_list; ptr; ptr=ptr->next) {
2383                 if (ptr == del) {
2384                         if (last)
2385                                 last->next = ptr->next;
2386                         else
2387                                 config_engine_list = ptr->next;
2388                         break;
2389                 }
2390                 last = ptr;
2391         }
2392
2393         return 0;
2394 }
2395
2396 int ast_realtime_is_mapping_defined(const char *family)
2397 {
2398         struct ast_config_map *map;
2399         SCOPED_MUTEX(lock, &config_lock);
2400
2401         for (map = config_maps; map; map = map->next) {
2402                 if (!strcasecmp(family, map->name)) {
2403                         return 1;
2404                 }
2405         }
2406
2407         return 0;
2408 }
2409
2410 /*! \brief Find realtime engine for realtime family */
2411 static struct ast_config_engine *find_engine(const char *family, int priority, char *database, int dbsiz, char *table, int tabsiz)
2412 {
2413         struct ast_config_engine *eng, *ret = NULL;
2414         struct ast_config_map *map;
2415
2416         SCOPED_MUTEX(lock, &config_lock);
2417
2418         for (map = config_maps; map; map = map->next) {
2419                 if (!strcasecmp(family, map->name) && (priority == map->priority)) {
2420                         if (database)
2421                                 ast_copy_string(database, map->database, dbsiz);
2422                         if (table)
2423                                 ast_copy_string(table, map->table ? map->table : family, tabsiz);
2424                         break;
2425                 }
2426         }
2427
2428         /* Check if the required driver (engine) exist */
2429         if (map) {
2430                 for (eng = config_engine_list; !ret && eng; eng = eng->next) {
2431                         if (!strcasecmp(eng->name, map->driver))
2432                                 ret = eng;
2433                 }
2434         }
2435
2436         /* if we found a mapping, but the engine is not available, then issue a warning */
2437         if (map && !ret)
2438                 ast_log(LOG_WARNING, "Realtime mapping for '%s' found to engine '%s', but the engine is not available\n", map->name, map->driver);
2439
2440         return ret;
2441 }
2442
2443 static struct ast_config_engine text_file_engine = {
2444         .name = "text",
2445         .load_func = config_text_file_load,
2446 };
2447
2448 struct ast_config *ast_config_copy(const struct ast_config *old)
2449 {
2450         struct ast_config *new_config = ast_config_new();
2451         struct ast_category *cat_iter;
2452
2453         if (!new_config) {
2454                 return NULL;
2455         }
2456
2457         for (cat_iter = old->root; cat_iter; cat_iter = cat_iter->next) {
2458                 struct ast_category *new_cat =
2459                         ast_category_new(cat_iter->name, cat_iter->file, cat_iter->lineno);
2460                 if (!new_cat) {
2461                         goto fail;
2462                 }
2463                 ast_category_append(new_config, new_cat);
2464                 if (cat_iter->root) {
2465                         new_cat->root = ast_variables_dup(cat_iter->root);
2466                         if (!new_cat->root) {
2467                                 goto fail;
2468                         }
2469                         new_cat->last = cat_iter->last;
2470                 }
2471         }
2472
2473         return new_config;
2474
2475 fail:
2476         ast_config_destroy(new_config);
2477         return NULL;
2478 }
2479
2480
2481 struct ast_config *ast_config_internal_load(const char *filename, struct ast_config *cfg, struct ast_flags flags, const char *suggested_include_file, const char *who_asked)
2482 {
2483         char db[256];
2484         char table[256];
2485         struct ast_config_engine *loader = &text_file_engine;
2486         struct ast_config *result;
2487
2488         /* The config file itself bumps include_level by 1 */
2489         if (cfg->max_include_level > 0 && cfg->include_level == cfg->max_include_level + 1) {
2490                 ast_log(LOG_WARNING, "Maximum Include level (%d) exceeded\n", cfg->max_include_level);
2491                 return NULL;
2492         }
2493
2494         cfg->include_level++;
2495
2496         if (!ast_test_flag(&flags, CONFIG_FLAG_NOREALTIME) && config_engine_list) {
2497                 struct ast_config_engine *eng;
2498
2499                 eng = find_engine(filename, 1, db, sizeof(db), table, sizeof(table));
2500
2501
2502                 if (eng && eng->load_func) {
2503                         loader = eng;
2504                 } else {
2505                         eng = find_engine("global", 1, db, sizeof(db), table, sizeof(table));
2506                         if (eng && eng->load_func)
2507                                 loader = eng;
2508                 }
2509         }
2510
2511         result = loader->load_func(db, table, filename, cfg, flags, suggested_include_file, who_asked);
2512
2513         if (result && result != CONFIG_STATUS_FILEINVALID && result != CONFIG_STATUS_FILEUNCHANGED) {
2514                 result->include_level--;
2515                 config_hook_exec(filename, who_asked, result);
2516         } else if (result != CONFIG_STATUS_FILEINVALID) {
2517                 cfg->include_level--;
2518         }
2519
2520         return result;
2521 }
2522
2523 struct ast_config *ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
2524 {
2525         struct ast_config *cfg;
2526         struct ast_config *result;
2527
2528         cfg = ast_config_new();
2529         if (!cfg)
2530                 return NULL;
2531
2532         result = ast_config_internal_load(filename, cfg, flags, "", who_asked);
2533         if (!result || result == CONFIG_STATUS_FILEUNCHANGED || result == CONFIG_STATUS_FILEINVALID)
2534                 ast_config_destroy(cfg);
2535
2536         return result;
2537 }
2538
2539 static struct ast_variable *realtime_arguments_to_fields(va_list ap)
2540 {
2541         struct ast_variable *first, *fields = NULL;
2542         const char *newparam = va_arg(ap, const char *), *newval = va_arg(ap, const char *);
2543
2544         if (!(first = ast_variable_new(newparam, newval, ""))) {
2545                 return NULL;
2546         }
2547
2548         while ((newparam = va_arg(ap, const char *))) {
2549                 struct ast_variable *field;
2550
2551                 newval = va_arg(ap, const char *);
2552                 if (!(field = ast_variable_new(newparam, newval, ""))) {
2553                         ast_variables_destroy(fields);
2554                         ast_variables_destroy(first);
2555                         return NULL;
2556                 }
2557
2558                 field->next = fields;
2559                 fields = field;
2560         }
2561
2562         first->next = fields;
2563         fields = first;
2564
2565         return fields;
2566 }
2567
2568 struct ast_variable *ast_load_realtime_all_fields(const char *family, const struct ast_variable *fields)
2569 {
2570         struct ast_config_engine *eng;
2571         char db[256];
2572         char table[256];
2573         struct ast_variable *res=NULL;
2574         int i;
2575
2576         for (i = 1; ; i++) {
2577                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2578                         if (eng->realtime_func && (res = eng->realtime_func(db, table, fields))) {
2579                                 return res;
2580                         }
2581                 } else {
2582                         return NULL;
2583                 }
2584         }
2585
2586         return res;
2587 }
2588
2589 struct ast_variable *ast_load_realtime_all(const char *family, ...)
2590 {
2591         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2592         struct ast_variable *res = NULL;
2593         va_list ap;
2594
2595         va_start(ap, family);
2596         fields = realtime_arguments_to_fields(ap);
2597         va_end(ap);
2598
2599         if (fields) {
2600                 res = ast_load_realtime_all_fields(family, fields);
2601         }
2602
2603         return res;
2604 }
2605
2606 struct ast_variable *ast_load_realtime_fields(const char *family, const struct ast_variable *fields)
2607 {
2608         struct ast_variable *res;
2609         struct ast_variable *cur;
2610         struct ast_variable **prev;
2611
2612         res = ast_load_realtime_all_fields(family, fields);
2613
2614         /* Filter the list. */
2615         prev = &res;
2616         cur = res;
2617         while (cur) {
2618                 if (ast_strlen_zero(cur->value)) {
2619                         /* Eliminate empty entries */
2620                         struct ast_variable *next;
2621
2622                         next = cur->next;
2623                         *prev = next;
2624                         ast_variable_destroy(cur);
2625                         cur = next;
2626                 } else {
2627                         /* Make blank entries empty and keep them. */
2628                         if (cur->value[0] == ' ' && cur->value[1] == '\0') {
2629                                 char *vptr = (char *) cur->value;
2630
2631                                 vptr[0] = '\0';
2632                         }
2633
2634                         prev = &cur->next;
2635                         cur = cur->next;
2636                 }
2637         }
2638         return res;
2639 }
2640
2641 struct ast_variable *ast_load_realtime(const char *family, ...)
2642 {
2643         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2644         va_list ap;
2645
2646         va_start(ap, family);
2647         fields = realtime_arguments_to_fields(ap);
2648         va_end(ap);
2649
2650         return ast_load_realtime_fields(family, fields);
2651 }
2652
2653 /*! \brief Check if realtime engine is configured for family */
2654 int ast_check_realtime(const char *family)
2655 {
2656         struct ast_config_engine *eng;
2657         if (!ast_realtime_enabled()) {
2658                 return 0;       /* There are no engines at all so fail early */
2659         }
2660
2661         eng = find_engine(family, 1, NULL, 0, NULL, 0);
2662         if (eng)
2663                 return 1;
2664         return 0;
2665 }
2666
2667 /*! \brief Check if there's any realtime engines loaded */
2668 int ast_realtime_enabled(void)
2669 {
2670         return config_maps ? 1 : 0;
2671 }
2672
2673 int ast_realtime_require_field(const char *family, ...)
2674 {
2675         struct ast_config_engine *eng;
2676         char db[256];
2677         char table[256];
2678         va_list ap;
2679         int res = -1, i;
2680
2681         va_start(ap, family);
2682         for (i = 1; ; i++) {
2683                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2684                         /* If the require succeeds, it returns 0. */
2685                         if (eng->require_func && !(res = eng->require_func(db, table, ap))) {
2686                                 break;
2687                         }
2688                 } else {
2689                         break;
2690                 }
2691         }
2692         va_end(ap);
2693
2694         return res;
2695 }
2696
2697 int ast_unload_realtime(const char *family)
2698 {
2699         struct ast_config_engine *eng;
2700         char db[256];
2701         char table[256];
2702         int res = -1, i;
2703
2704         for (i = 1; ; i++) {
2705                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2706                         if (eng->unload_func) {
2707                                 /* Do this for ALL engines */
2708                                 res = eng->unload_func(db, table);
2709                         }
2710                 } else {
2711                         break;
2712                 }
2713         }
2714         return res;
2715 }
2716
2717 struct ast_config *ast_load_realtime_multientry_fields(const char *family, const struct ast_variable *fields)
2718 {
2719         struct ast_config_engine *eng;
2720         char db[256];
2721         char table[256];
2722         struct ast_config *res = NULL;
2723         int i;
2724
2725         for (i = 1; ; i++) {
2726                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2727                         if (eng->realtime_multi_func && (res = eng->realtime_multi_func(db, table, fields))) {
2728                                 /* If we were returned an empty cfg, destroy it and return NULL */
2729                                 if (!res->root) {
2730                                         ast_config_destroy(res);
2731                                         res = NULL;
2732                                 }
2733                                 break;
2734                         }
2735                 } else {
2736                         break;
2737                 }
2738         }
2739
2740         return res;
2741 }
2742
2743 struct ast_config *ast_load_realtime_multientry(const char *family, ...)
2744 {
2745         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2746         va_list ap;
2747
2748         va_start(ap, family);
2749         fields = realtime_arguments_to_fields(ap);
2750         va_end(ap);
2751
2752         return ast_load_realtime_multientry_fields(family, fields);
2753 }
2754
2755 int ast_update_realtime_fields(const char *family, const char *keyfield, const char *lookup, const struct ast_variable *fields)
2756 {
2757         struct ast_config_engine *eng;
2758         int res = -1, i;
2759         char db[256];
2760         char table[256];
2761
2762         for (i = 1; ; i++) {
2763                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2764                         /* If the update succeeds, it returns 0. */
2765                         if (eng->update_func && !(res = eng->update_func(db, table, keyfield, lookup, fields))) {
2766                                 break;
2767                         }
2768                 } else {
2769                         break;
2770                 }
2771         }
2772
2773         return res;
2774 }
2775
2776 int ast_update_realtime(const char *family, const char *keyfield, const char *lookup, ...)
2777 {
2778         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2779         va_list ap;
2780
2781         va_start(ap, lookup);
2782         fields = realtime_arguments_to_fields(ap);
2783         va_end(ap);
2784
2785         return ast_update_realtime_fields(family, keyfield, lookup, fields);
2786 }
2787
2788 int ast_update2_realtime_fields(const char *family, const struct ast_variable *lookup_fields, const struct ast_variable *update_fields)
2789 {
2790         struct ast_config_engine *eng;
2791         int res = -1, i;
2792         char db[256];
2793         char table[256];
2794
2795         for (i = 1; ; i++) {
2796                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2797                         if (eng->update2_func && !(res = eng->update2_func(db, table, lookup_fields, update_fields))) {
2798                                 break;
2799                         }
2800                 } else {
2801                         break;
2802                 }
2803         }
2804
2805         return res;
2806 }
2807
2808 int ast_update2_realtime(const char *family, ...)
2809 {
2810         RAII_VAR(struct ast_variable *, lookup_fields, NULL, ast_variables_destroy);
2811         RAII_VAR(struct ast_variable *, update_fields, NULL, ast_variables_destroy);
2812         va_list ap;
2813
2814         va_start(ap, family);
2815         lookup_fields = realtime_arguments_to_fields(ap);
2816         update_fields = realtime_arguments_to_fields(ap);
2817         va_end(ap);
2818
2819         return ast_update2_realtime_fields(family, lookup_fields, update_fields);
2820 }
2821
2822 int ast_store_realtime_fields(const char *family, const struct ast_variable *fields)
2823 {
2824         struct ast_config_engine *eng;
2825         int res = -1, i;
2826         char db[256];
2827         char table[256];
2828
2829         for (i = 1; ; i++) {
2830                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2831                         /* If the store succeeds, it returns 0. */
2832                         if (eng->store_func && !(res = eng->store_func(db, table, fields))) {
2833                                 break;
2834                         }
2835                 } else {
2836                         break;
2837                 }
2838         }
2839
2840         return res;
2841 }
2842
2843 int ast_store_realtime(const char *family, ...)
2844 {
2845         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2846         va_list ap;
2847
2848         va_start(ap, family);
2849         fields = realtime_arguments_to_fields(ap);
2850         va_end(ap);
2851
2852         return ast_store_realtime_fields(family, fields);
2853 }
2854
2855 int ast_destroy_realtime_fields(const char *family, const char *keyfield, const char *lookup, const struct ast_variable *fields)
2856 {
2857         struct ast_config_engine *eng;
2858         int res = -1, i;
2859         char db[256];
2860         char table[256];
2861
2862         for (i = 1; ; i++) {
2863                 if ((eng = find_engine(family, i, db, sizeof(db), table, sizeof(table)))) {
2864                         if (eng->destroy_func && !(res = eng->destroy_func(db, table, keyfield, lookup, fields))) {
2865                                 break;
2866                         }
2867                 } else {
2868                         break;
2869                 }
2870         }
2871
2872         return res;
2873 }
2874
2875 int ast_destroy_realtime(const char *family, const char *keyfield, const char *lookup, ...)
2876 {
2877         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
2878         va_list ap;
2879
2880         va_start(ap, lookup);
2881         fields = realtime_arguments_to_fields(ap);
2882         va_end(ap);
2883
2884         return ast_destroy_realtime_fields(family, keyfield, lookup, fields);
2885 }
2886
2887 char *ast_realtime_decode_chunk(char *chunk)
2888 {
2889         char *orig = chunk;
2890         for (; *chunk; chunk++) {
2891                 if (*chunk == '^' && strchr("0123456789ABCDEFabcdef", chunk[1]) && strchr("0123456789ABCDEFabcdef", chunk[2])) {
2892                         sscanf(chunk + 1, "%02hhX", chunk);
2893                         memmove(chunk + 1, chunk + 3, strlen(chunk + 3) + 1);
2894                 }
2895         }
2896         return orig;
2897 }
2898
2899 char *ast_realtime_encode_chunk(struct ast_str **dest, ssize_t maxlen, const char *chunk)
2900 {
2901         if (!strchr(chunk, ';') && !strchr(chunk, '^')) {
2902                 ast_str_set(dest, maxlen, "%s", chunk);
2903         } else {
2904                 ast_str_reset(*dest);
2905                 for (; *chunk; chunk++) {
2906                         if (strchr(";^", *chunk)) {
2907                                 ast_str_append(dest, maxlen, "^%02hhX", *chunk);
2908                         } else {
2909                                 ast_str_append(dest, maxlen, "%c", *chunk);
2910                         }
2911                 }
2912         }
2913         return ast_str_buffer(*dest);
2914 }
2915
2916 /*! \brief Helper function to parse arguments
2917  * See documentation in config.h
2918  */
2919 int ast_parse_arg(const char *arg, enum ast_parse_flags flags,
2920         void *p_result, ...)
2921 {
2922         va_list ap;
2923         int error = 0;
2924
2925         va_start(ap, p_result);
2926         switch (flags & PARSE_TYPE) {
2927         case PARSE_INT32:
2928         {
2929                 long int x = 0;
2930                 int32_t *result = p_result;
2931                 int32_t def = result ? *result : 0, high = INT32_MAX, low = INT32_MIN;
2932                 char *endptr = NULL;
2933
2934                 /* optional arguments: default value and/or (low, high) */
2935                 if (flags & PARSE_DEFAULT) {
2936                         def = va_arg(ap, int32_t);
2937                 }
2938                 if (flags & (PARSE_IN_RANGE | PARSE_OUT_RANGE)) {
2939                         low = va_arg(ap, int32_t);
2940                         high = va_arg(ap, int32_t);
2941                 }
2942                 if (ast_strlen_zero(arg)) {
2943                         error = 1;
2944                         goto int32_done;
2945                 }
2946                 errno = 0;
2947                 x = strtol(arg, &endptr, 0);
2948                 if (*endptr || errno || x < INT32_MIN || x > INT32_MAX) {
2949                         /* Parse error, or type out of int32_t bounds */
2950                         error = 1;
2951                         goto int32_done;
2952                 }
2953                 error = (x < low) || (x > high);
2954                 if (flags & PARSE_RANGE_DEFAULTS) {
2955                         if (x < low) {
2956                                 def = low;
2957                         } else if (x > high) {
2958                                 def = high;
2959                         }
2960                 }
2961                 if (flags & PARSE_OUT_RANGE) {
2962                         error = !error;
2963                 }
2964 int32_done:
2965                 if (result) {
2966                         *result  = error ? def : x;
2967                 }
2968
2969                 ast_debug(3, "extract int from [%s] in [%d, %d] gives [%ld](%d)\n",
2970                                 arg, low, high, result ? *result : x, error);
2971                 break;
2972         }
2973
2974         case PARSE_UINT32:
2975         {
2976                 unsigned long int x = 0;
2977                 uint32_t *result = p_result;
2978                 uint32_t def = result ? *result : 0, low = 0, high = UINT32_MAX;
2979                 char *endptr = NULL;
2980
2981                 /* optional argument: first default value, then range */
2982                 if (flags & PARSE_DEFAULT) {
2983                         def = va_arg(ap, uint32_t);
2984                 }
2985                 if (flags & (PARSE_IN_RANGE|PARSE_OUT_RANGE)) {
2986                         /* range requested, update bounds */
2987                         low = va_arg(ap, uint32_t);
2988                         high = va_arg(ap, uint32_t);
2989                 }
2990
2991                 if (ast_strlen_zero(arg)) {
2992                         error = 1;
2993                         goto uint32_done;
2994                 }
2995                 /* strtoul will happilly and silently negate negative numbers */
2996                 arg = ast_skip_blanks(arg);
2997                 if (*arg == '-') {
2998                         error = 1;
2999                         goto uint32_done;
3000                 }
3001                 errno = 0;
3002                 x = strtoul(arg, &endptr, 0);
3003                 if (*endptr || errno || x > UINT32_MAX) {
3004                         error = 1;
3005                         goto uint32_done;
3006                 }
3007                 error = (x < low) || (x > high);
3008                 if (flags & PARSE_RANGE_DEFAULTS) {
3009                         if (x < low) {
3010                                 def = low;
3011                         } else if (x > high) {
3012                                 def = high;
3013                         }
3014                 }
3015                 if (flags & PARSE_OUT_RANGE) {
3016                         error = !error;
3017                 }
3018 uint32_done:
3019                 if (result) {
3020                         *result  = error ? def : x;
3021                 }
3022                 ast_debug(3, "extract uint from [%s] in [%u, %u] gives [%lu](%d)\n",
3023                                 arg, low, high, result ? *result : x, error);
3024                 break;
3025         }
3026
3027         case PARSE_DOUBLE:
3028         {
3029                 double *result = p_result;
3030                 double x = 0, def = result ? *result : 0, low = -HUGE_VAL, high = HUGE_VAL;
3031                 char *endptr = NULL;
3032
3033                 /* optional argument: first default value, then range */
3034                 if (flags & PARSE_DEFAULT) {
3035                         def = va_arg(ap, double);
3036                 }
3037                 if (flags & (PARSE_IN_RANGE | PARSE_OUT_RANGE)) {
3038                         /* range requested, update bounds */
3039                         low = va_arg(ap, double);
3040                         high = va_arg(ap, double);
3041                 }
3042                 if (ast_strlen_zero(arg)) {
3043                         error = 1;
3044                         goto double_done;
3045                 }
3046                 errno = 0;
3047                 x = strtod(arg, &endptr);
3048                 if (*endptr || errno == ERANGE) {
3049                         error = 1;
3050                         goto double_done;
3051                 }
3052                 error = (x < low) || (x > high);
3053                 if (flags & PARSE_OUT_RANGE) {
3054                         error = !error;
3055                 }
3056 double_done:
3057                 if (result) {
3058                         *result = error ? def : x;
3059                 }
3060                 ast_debug(3, "extract double from [%s] in [%f, %f] gives [%f](%d)\n",
3061                                 arg, low, high, result ? *result : x, error);
3062                 break;
3063         }
3064         case PARSE_ADDR:
3065             {
3066