Merge "res_pjsip: New endpoint option "refer_blind_progress""
[asterisk/asterisk.git] / res / res_sorcery_config.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 /*!
20  * \file
21  *
22  * \brief Sorcery Configuration File Object Wizard
23  *
24  * \author Joshua Colp <jcolp@digium.com>
25  */
26
27 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 #include <regex.h>
34
35 #include "asterisk/module.h"
36 #include "asterisk/sorcery.h"
37 #include "asterisk/astobj2.h"
38 #include "asterisk/config.h"
39 #include "asterisk/uuid.h"
40 #include "asterisk/hashtab.h"
41
42 /*! \brief Structure for storing configuration file sourced objects */
43 struct sorcery_config {
44         /*! \brief UUID for identifying us when opening a configuration file */
45         char uuid[AST_UUID_STR_LEN];
46
47         /*! \brief Objects retrieved from the configuration file */
48         struct ao2_global_obj objects;
49
50         /*! \brief Any specific variable criteria for considering a defined category for this object */
51         struct ast_variable *criteria;
52
53         /*! \brief Number of buckets to use for objects */
54         unsigned int buckets;
55
56         /*! \brief Enable file level integrity instead of object level */
57         unsigned int file_integrity:1;
58
59         /*! \brief Filename of the configuration file */
60         char filename[];
61 };
62
63 /*! \brief Structure used for fields comparison */
64 struct sorcery_config_fields_cmp_params {
65         /*! \brief Pointer to the sorcery structure */
66         const struct ast_sorcery *sorcery;
67
68         /*! \brief Pointer to the fields to check */
69         const struct ast_variable *fields;
70
71         /*! \brief Regular expression for checking object id */
72         regex_t *regex;
73
74         /*! \brief Optional container to put object into */
75         struct ao2_container *container;
76 };
77
78 static void *sorcery_config_open(const char *data);
79 static void sorcery_config_load(void *data, const struct ast_sorcery *sorcery, const char *type);
80 static void sorcery_config_reload(void *data, const struct ast_sorcery *sorcery, const char *type);
81 static void *sorcery_config_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id);
82 static void *sorcery_config_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields);
83 static void sorcery_config_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects,
84                                              const struct ast_variable *fields);
85 static void sorcery_config_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex);
86 static void sorcery_config_close(void *data);
87
88 static struct ast_sorcery_wizard config_object_wizard = {
89         .name = "config",
90         .open = sorcery_config_open,
91         .load = sorcery_config_load,
92         .reload = sorcery_config_reload,
93         .retrieve_id = sorcery_config_retrieve_id,
94         .retrieve_fields = sorcery_config_retrieve_fields,
95         .retrieve_multiple = sorcery_config_retrieve_multiple,
96         .retrieve_regex = sorcery_config_retrieve_regex,
97         .close = sorcery_config_close,
98 };
99
100 /*! \brief Destructor function for sorcery config */
101 static void sorcery_config_destructor(void *obj)
102 {
103         struct sorcery_config *config = obj;
104
105         ao2_global_obj_release(config->objects);
106         ast_rwlock_destroy(&config->objects.lock);
107         ast_variables_destroy(config->criteria);
108 }
109
110 static int sorcery_config_fields_cmp(void *obj, void *arg, int flags)
111 {
112         const struct sorcery_config_fields_cmp_params *params = arg;
113         RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
114
115         if (params->regex) {
116                 /* If a regular expression has been provided see if it matches, otherwise move on */
117                 if (!regexec(params->regex, ast_sorcery_object_get_id(obj), 0, NULL, 0)) {
118                         ao2_link(params->container, obj);
119                 }
120                 return 0;
121         } else if (params->fields &&
122             (!(objset = ast_sorcery_objectset_create(params->sorcery, obj)) ||
123              (!ast_variable_lists_match(objset, params->fields, 0)))) {
124                 /* If we can't turn the object into an object set OR if differences exist between the fields
125                  * passed in and what are present on the object they are not a match.
126                  */
127                 return 0;
128         }
129
130         /* We want this object */
131         if (params->container) {
132                 /*
133                  * We are putting the found objects into the given container instead
134                  * of the normal container traversal return mechanism.
135                  */
136                 ao2_link(params->container, obj);
137                 return 0;
138         } else {
139                 return CMP_MATCH;
140         }
141 }
142
143 static void *sorcery_config_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields)
144 {
145         struct sorcery_config *config = data;
146         RAII_VAR(struct ao2_container *, objects, ao2_global_obj_ref(config->objects), ao2_cleanup);
147         struct sorcery_config_fields_cmp_params params = {
148                 .sorcery = sorcery,
149                 .fields = fields,
150                 .container = NULL,
151         };
152
153         /* If no fields are present return nothing, we require *something*, same goes if no objects exist yet */
154         if (!objects || !fields) {
155                 return NULL;
156         }
157
158         return ao2_callback(objects, 0, sorcery_config_fields_cmp, &params);
159 }
160
161 static void *sorcery_config_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
162 {
163         struct sorcery_config *config = data;
164         RAII_VAR(struct ao2_container *, objects, ao2_global_obj_ref(config->objects), ao2_cleanup);
165
166         return objects ? ao2_find(objects, id, OBJ_SEARCH_KEY) : NULL;
167 }
168
169 static void sorcery_config_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const struct ast_variable *fields)
170 {
171         struct sorcery_config *config = data;
172         RAII_VAR(struct ao2_container *, config_objects, ao2_global_obj_ref(config->objects), ao2_cleanup);
173         struct sorcery_config_fields_cmp_params params = {
174                 .sorcery = sorcery,
175                 .fields = fields,
176                 .container = objects,
177         };
178
179         if (!config_objects) {
180                 return;
181         }
182
183         ao2_callback(config_objects, OBJ_NODATA | OBJ_MULTIPLE, sorcery_config_fields_cmp, &params);
184 }
185
186 static void sorcery_config_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex)
187 {
188         struct sorcery_config *config = data;
189         RAII_VAR(struct ao2_container *, config_objects, ao2_global_obj_ref(config->objects), ao2_cleanup);
190         regex_t expression;
191         struct sorcery_config_fields_cmp_params params = {
192                 .sorcery = sorcery,
193                 .container = objects,
194                 .regex = &expression,
195         };
196
197         if (ast_strlen_zero(regex)) {
198                 regex = ".";
199         }
200
201         if (!config_objects || regcomp(&expression, regex, REG_EXTENDED | REG_NOSUB)) {
202                 return;
203         }
204
205         ao2_callback(config_objects, OBJ_NODATA | OBJ_MULTIPLE, sorcery_config_fields_cmp, &params);
206         regfree(&expression);
207 }
208
209 /*! \brief Internal function which determines if criteria has been met for considering an object set applicable */
210 static int sorcery_is_criteria_met(struct ast_variable *objset, struct ast_variable *criteria)
211 {
212         RAII_VAR(struct ast_variable *, diff, NULL, ast_variables_destroy);
213
214         return (!criteria || (!ast_sorcery_changeset_create(objset, criteria, &diff) && !diff)) ? 1 : 0;
215 }
216
217 static void sorcery_config_internal_load(void *data, const struct ast_sorcery *sorcery, const char *type, unsigned int reload)
218 {
219         struct sorcery_config *config = data;
220         struct ast_flags flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
221         struct ast_config *cfg = ast_config_load2(config->filename, config->uuid, flags);
222         struct ast_category *category = NULL;
223         RAII_VAR(struct ao2_container *, objects, NULL, ao2_cleanup);
224         const char *id = NULL;
225         unsigned int buckets = 0;
226
227         if (!cfg) {
228                 ast_log(LOG_ERROR, "Unable to load config file '%s'\n", config->filename);
229                 return;
230         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
231                 ast_debug(1, "Config file '%s' was unchanged\n", config->filename);
232                 return;
233         } else if (cfg == CONFIG_STATUS_FILEINVALID) {
234                 ast_log(LOG_ERROR, "Contents of config file '%s' are invalid and cannot be parsed\n", config->filename);
235                 return;
236         }
237
238         if (!config->buckets) {
239                 while ((category = ast_category_browse_filtered(cfg, NULL, category, NULL))) {
240
241                         /* If given criteria has not been met skip the category, it is not applicable */
242                         if (!sorcery_is_criteria_met(ast_category_first(category), config->criteria)) {
243                                 continue;
244                         }
245
246                         buckets++;
247                 }
248
249                 /* Determine the optimal number of buckets */
250                 while (buckets && !ast_is_prime(buckets)) {
251                         /* This purposely goes backwards to ensure that the container doesn't have a ton of
252                          * empty buckets for objects that will never get added.
253                          */
254                         buckets--;
255                 }
256
257                 if (!buckets) {
258                         buckets = 1;
259                 }
260         } else {
261                 buckets = config->buckets;
262         }
263
264         ast_debug(2, "Using bucket size of '%d' for objects of type '%s' from '%s'\n",
265                 buckets, type, config->filename);
266
267         objects = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, buckets,
268                 ast_sorcery_object_id_hash, NULL, ast_sorcery_object_id_compare);
269         if (!objects) {
270                 ast_log(LOG_ERROR, "Could not create bucket for new objects from '%s', keeping existing objects\n",
271                         config->filename);
272                 ast_config_destroy(cfg);
273                 return;
274         }
275
276         while ((category = ast_category_browse_filtered(cfg, NULL, category, NULL))) {
277                 RAII_VAR(void *, obj, NULL, ao2_cleanup);
278                 id = ast_category_get_name(category);
279
280                 /* If given criteria has not been met skip the category, it is not applicable */
281                 if (!sorcery_is_criteria_met(ast_category_first(category), config->criteria)) {
282                         continue;
283                 }
284
285                 /*  Confirm an object with this id does not already exist in the bucket.
286                  *  If it exists, however, the configuration is invalid so stop
287                  *  processing and destroy it. */
288                 obj = ao2_find(objects, id, OBJ_SEARCH_KEY);
289                 if (obj) {
290                         ast_log(LOG_ERROR, "Config file '%s' could not be loaded; configuration contains a duplicate object: '%s' of type '%s'\n",
291                                 config->filename, id, type);
292                         ast_config_destroy(cfg);
293                         return;
294                 }
295
296                 if (!(obj = ast_sorcery_alloc(sorcery, type, id)) ||
297                     ast_sorcery_objectset_apply(sorcery, obj, ast_category_first(category))) {
298
299                         if (config->file_integrity) {
300                                 ast_log(LOG_ERROR, "Config file '%s' could not be loaded due to error with object '%s' of type '%s'\n",
301                                         config->filename, id, type);
302                                 ast_config_destroy(cfg);
303                                 return;
304                         } else {
305                                 ast_log(LOG_ERROR, "Could not create an object of type '%s' with id '%s' from configuration file '%s'\n",
306                                         type, id, config->filename);
307                         }
308
309                         ao2_cleanup(obj);
310
311                         /* To ensure we don't lose the object that already exists we retrieve it from the old objects container and add it to the new one */
312                         if (!(obj = sorcery_config_retrieve_id(sorcery, data, type, id))) {
313                                 continue;
314                         }
315
316                         ast_log(LOG_NOTICE, "Retaining existing configuration for object of type '%s' with id '%s'\n", type, id);
317                 }
318
319                 ao2_link(objects, obj);
320         }
321
322         ao2_global_obj_replace_unref(config->objects, objects);
323         ast_config_destroy(cfg);
324 }
325
326 static void sorcery_config_load(void *data, const struct ast_sorcery *sorcery, const char *type)
327 {
328         sorcery_config_internal_load(data, sorcery, type, 0);
329 }
330
331 static void sorcery_config_reload(void *data, const struct ast_sorcery *sorcery, const char *type)
332 {
333         sorcery_config_internal_load(data, sorcery, type, 1);
334 }
335
336 static void *sorcery_config_open(const char *data)
337 {
338         char *tmp;
339         char *filename;
340         char *option;
341         struct sorcery_config *config;
342
343         if (ast_strlen_zero(data)) {
344                 return NULL;
345         }
346
347         tmp = ast_strdupa(data);
348         filename = strsep(&tmp, ",");
349
350         if (ast_strlen_zero(filename) || !(config = ao2_alloc_options(sizeof(*config) + strlen(filename) + 1, sorcery_config_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK))) {
351                 return NULL;
352         }
353
354         ast_uuid_generate_str(config->uuid, sizeof(config->uuid));
355
356         ast_rwlock_init(&config->objects.lock);
357         strcpy(config->filename, filename);
358
359         while ((option = strsep(&tmp, ","))) {
360                 char *name = strsep(&option, "="), *value = option;
361
362                 if (!strcasecmp(name, "buckets")) {
363                         if (sscanf(value, "%30u", &config->buckets) != 1) {
364                                 ast_log(LOG_ERROR, "Unsupported bucket size of '%s' used for configuration file '%s', defaulting to automatic determination\n",
365                                         value, filename);
366                         }
367                 } else if (!strcasecmp(name, "integrity")) {
368                         if (!strcasecmp(value, "file")) {
369                                 config->file_integrity = 1;
370                         } else if (!strcasecmp(value, "object")) {
371                                 config->file_integrity = 0;
372                         } else {
373                                 ast_log(LOG_ERROR, "Unsupported integrity value of '%s' used for configuration file '%s', defaulting to 'object'\n",
374                                         value, filename);
375                         }
376                 } else if (!strcasecmp(name, "criteria")) {
377                         char *field = strsep(&value, "=");
378                         struct ast_variable *criteria = ast_variable_new(field, value, "");
379
380                         if (criteria) {
381                                 criteria->next = config->criteria;
382                                 config->criteria = criteria;
383                         } else {
384                                 /* This is fatal since not following criteria would potentially yield invalid objects */
385                                 ast_log(LOG_ERROR, "Could not create criteria entry of field '%s' with value '%s' for configuration file '%s'\n",
386                                         field, value, filename);
387                                 ao2_ref(config, -1);
388                                 return NULL;
389                         }
390                 } else {
391                         ast_log(LOG_ERROR, "Unsupported option '%s' used for configuration file '%s'\n", name, filename);
392                 }
393         }
394
395         return config;
396 }
397
398 static void sorcery_config_close(void *data)
399 {
400         struct sorcery_config *config = data;
401
402         ao2_ref(config, -1);
403 }
404
405 static int load_module(void)
406 {
407         if (ast_sorcery_wizard_register(&config_object_wizard)) {
408                 return AST_MODULE_LOAD_DECLINE;
409         }
410
411         return AST_MODULE_LOAD_SUCCESS;
412 }
413
414 static int unload_module(void)
415 {
416         ast_sorcery_wizard_unregister(&config_object_wizard);
417         return 0;
418 }
419
420 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Sorcery Configuration File Object Wizard",
421         .support_level = AST_MODULE_SUPPORT_CORE,
422         .load = load_module,
423         .unload = unload_module,
424         .load_pri = AST_MODPRI_REALTIME_DRIVER,
425 );