res_pjsip_outbound_registration: Fix leak on vector add failure.
[asterisk/asterisk.git] / res / res_sorcery_realtime.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 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 Realtime 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
38 /*! \brief They key field used to store the unique identifier for the object */
39 #define UUID_FIELD "id"
40
41 enum unqualified_fetch {
42         UNQUALIFIED_FETCH_NO,
43         UNQUALIFIED_FETCH_WARN,
44         UNQUALIFIED_FETCH_YES,
45         UNQUALIFIED_FETCH_ERROR,
46 };
47
48 struct sorcery_config {
49         enum unqualified_fetch fetch;
50         char family[];
51 };
52
53 static void *sorcery_realtime_open(const char *data);
54 static int sorcery_realtime_create(const struct ast_sorcery *sorcery, void *data, void *object);
55 static void *sorcery_realtime_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id);
56 static void *sorcery_realtime_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields);
57 static void sorcery_realtime_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects,
58                                              const struct ast_variable *fields);
59 static void sorcery_realtime_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex);
60 static int sorcery_realtime_update(const struct ast_sorcery *sorcery, void *data, void *object);
61 static int sorcery_realtime_delete(const struct ast_sorcery *sorcery, void *data, void *object);
62 static void sorcery_realtime_close(void *data);
63
64 static struct ast_sorcery_wizard realtime_object_wizard = {
65         .name = "realtime",
66         .open = sorcery_realtime_open,
67         .create = sorcery_realtime_create,
68         .retrieve_id = sorcery_realtime_retrieve_id,
69         .retrieve_fields = sorcery_realtime_retrieve_fields,
70         .retrieve_multiple = sorcery_realtime_retrieve_multiple,
71         .retrieve_regex = sorcery_realtime_retrieve_regex,
72         .update = sorcery_realtime_update,
73         .delete = sorcery_realtime_delete,
74         .close = sorcery_realtime_close,
75 };
76
77 static int sorcery_realtime_create(const struct ast_sorcery *sorcery, void *data, void *object)
78 {
79         struct sorcery_config *config = data;
80         RAII_VAR(struct ast_variable *, fields, ast_sorcery_objectset_create(sorcery, object), ast_variables_destroy);
81         struct ast_variable *id = ast_variable_new(UUID_FIELD, ast_sorcery_object_get_id(object), "");
82
83         if (!fields || !id) {
84                 ast_variables_destroy(id);
85                 return -1;
86         }
87
88         /* Place the identifier at the front for sanity sake */
89         id->next = fields;
90         fields = id;
91
92         return (ast_store_realtime_fields(config->family, fields) <= 0) ? -1 : 0;
93 }
94
95 /*! \brief Internal helper function which returns a filtered objectset. 
96  *
97  * The following are filtered out of the objectset:
98  * \li The id field. This is returned to the caller in an out parameter.
99  * \li Fields that are not registered with sorcery.
100  *
101  * \param objectset Objectset to filter.
102  * \param[out] id The ID of the sorcery object, as found in the objectset.
103  * \param sorcery The sorcery instance that is requesting an objectset.
104  * \param type The object type
105  *
106  * \return The filtered objectset
107  */
108 static struct ast_variable *sorcery_realtime_filter_objectset(struct ast_variable *objectset, struct ast_variable **id,
109                 const struct ast_sorcery *sorcery, const char *type)
110 {
111         struct ast_variable *previous = NULL, *field = objectset;
112         struct ast_sorcery_object_type *object_type;
113
114         object_type = ast_sorcery_get_object_type(sorcery, type);
115         if (!object_type) {
116                 ast_log(LOG_WARNING, "Unknown sorcery object type %s. Expect errors\n", type);
117                 /* Continue since we still want to filter out the id */
118         }
119
120         while (field) {
121                 int remove_field = 0;
122                 int delete_field = 0;
123
124                 if (!strcmp(field->name, UUID_FIELD)) {
125                         *id = field;
126                         remove_field = 1;
127                 } else if (object_type &&
128                                 !ast_sorcery_is_object_field_registered(object_type, field->name)) {
129                         ast_debug(1, "Filtering out realtime field '%s' from retrieval\n", field->name);
130                         remove_field = 1;
131                         delete_field = 1;
132                 }
133
134                 if (remove_field) {
135                         struct ast_variable *removed;
136
137                         if (previous) {
138                                 previous->next = field->next;
139                         } else {
140                                 objectset = field->next;
141                         }
142
143                         removed = field;
144                         field = field->next;
145                         removed->next = NULL;
146                         if (delete_field) {
147                                 ast_variables_destroy(removed);
148                         }
149                 } else {
150                         previous = field;
151                         field = field->next;
152                 }
153         }
154
155         ao2_cleanup(object_type);
156
157         return objectset;
158 }
159
160 static void *sorcery_realtime_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields)
161 {
162         struct sorcery_config *config = data;
163         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
164         RAII_VAR(struct ast_variable *, id, NULL, ast_variables_destroy);
165         void *object = NULL;
166
167         if (!(objectset = ast_load_realtime_fields(config->family, fields))) {
168                 return NULL;
169         }
170
171         objectset = sorcery_realtime_filter_objectset(objectset, &id, sorcery, type);
172
173         if (!id
174                 || !(object = ast_sorcery_alloc(sorcery, type, id->value))
175                 || ast_sorcery_objectset_apply(sorcery, object, objectset)) {
176                 return NULL;
177         }
178
179         return object;
180 }
181
182 static void *sorcery_realtime_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
183 {
184         RAII_VAR(struct ast_variable *, fields, ast_variable_new(UUID_FIELD, id, ""), ast_variables_destroy);
185
186         return sorcery_realtime_retrieve_fields(sorcery, data, type, fields);
187 }
188
189 static void sorcery_realtime_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const struct ast_variable *fields)
190 {
191         struct sorcery_config *config = data;
192         RAII_VAR(struct ast_config *, rows, NULL, ast_config_destroy);
193         RAII_VAR(struct ast_variable *, all, NULL, ast_variables_destroy);
194         struct ast_category *row = NULL;
195
196         if (!fields) {
197                 char field[strlen(UUID_FIELD) + 6], value[2];
198
199                 if (config->fetch == UNQUALIFIED_FETCH_NO) {
200                         return;
201                 }
202                 if (config->fetch == UNQUALIFIED_FETCH_ERROR) {
203                         ast_log(LOG_ERROR, "Unqualified fetch prevented on %s\n", config->family);
204                         return;
205                 }
206                 if (config->fetch == UNQUALIFIED_FETCH_WARN) {
207                         ast_log(LOG_WARNING, "Unqualified fetch attempted on %s\n", config->family);
208                         return;
209                 }
210
211                 /* If no fields have been specified we want all rows, so trick realtime into doing it */
212                 snprintf(field, sizeof(field), "%s LIKE", UUID_FIELD);
213                 snprintf(value, sizeof(value), "%%");
214
215                 if (!(all = ast_variable_new(field, value, ""))) {
216                         return;
217                 }
218
219                 fields = all;
220         }
221
222         if (!(rows = ast_load_realtime_multientry_fields(config->family, fields))) {
223                 return;
224         }
225
226         while ((row = ast_category_browse_filtered(rows, NULL, row, NULL))) {
227                 struct ast_variable *objectset = ast_category_detach_variables(row);
228                 RAII_VAR(struct ast_variable *, id, NULL, ast_variables_destroy);
229                 RAII_VAR(void *, object, NULL, ao2_cleanup);
230
231                 objectset = sorcery_realtime_filter_objectset(objectset, &id, sorcery, type);
232
233                 if (id && (object = ast_sorcery_alloc(sorcery, type, id->value)) && !ast_sorcery_objectset_apply(sorcery, object, objectset)) {
234                         ao2_link(objects, object);
235                 }
236
237                 ast_variables_destroy(objectset);
238         }
239 }
240
241 static void sorcery_realtime_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex)
242 {
243         char field[strlen(UUID_FIELD) + 6], value[strlen(regex) + 3];
244         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
245
246         if (!ast_strlen_zero(regex)) {
247                 /* The realtime API provides no direct ability to do regex so for now we support a limited subset using pattern matching */
248                 snprintf(field, sizeof(field), "%s LIKE", UUID_FIELD);
249                 if (regex[0] == '^') {
250                         snprintf(value, sizeof(value), "%s%%", regex + 1);
251                 } else {
252                         snprintf(value, sizeof(value), "%%%s%%", regex);
253                 }
254
255                 if (!(fields = ast_variable_new(field, value, ""))) {
256                         return;
257                 }
258         }
259
260         sorcery_realtime_retrieve_multiple(sorcery, data, type, objects, fields);
261 }
262
263 static int sorcery_realtime_update(const struct ast_sorcery *sorcery, void *data, void *object)
264 {
265         struct sorcery_config *config = data;
266         RAII_VAR(struct ast_variable *, fields, ast_sorcery_objectset_create(sorcery, object), ast_variables_destroy);
267
268         if (!fields) {
269                 return -1;
270         }
271
272         return (ast_update_realtime_fields(config->family, UUID_FIELD, ast_sorcery_object_get_id(object), fields) < 0) ? -1 : 0;
273 }
274
275 static int sorcery_realtime_delete(const struct ast_sorcery *sorcery, void *data, void *object)
276 {
277         struct sorcery_config *config = data;
278
279         return (ast_destroy_realtime_fields(config->family, UUID_FIELD, ast_sorcery_object_get_id(object), NULL) <= 0) ? -1 : 0;
280 }
281
282 static void *sorcery_realtime_open(const char *data)
283 {
284         struct sorcery_config *config;
285         char *tmp;
286         char *family;
287         char *option;
288
289         /* We require a prefix for family string generation, or else stuff could mix together */
290         if (ast_strlen_zero(data)) {
291                 return NULL;
292         }
293
294         tmp = ast_strdupa(data);
295         family = strsep(&tmp, ",");
296
297         if (!ast_realtime_is_mapping_defined(family)) {
298                 return NULL;
299         }
300
301         config = ast_calloc(1, sizeof(*config) + strlen(family) + 1);
302         if (!config) {
303                 return NULL;
304         }
305
306         strcpy(config->family, family); /* Safe */
307         config->fetch = UNQUALIFIED_FETCH_YES;
308
309         while ((option = strsep(&tmp, ","))) {
310                 char *name = strsep(&option, "=");
311                 char *value = option;
312
313                 if (!strcasecmp(name, "allow_unqualified_fetch")) {
314                         if (ast_strlen_zero(value) || !strcasecmp(value, "yes")) {
315                                 config->fetch = UNQUALIFIED_FETCH_YES;
316                         } else if (!strcasecmp(value, "no")) {
317                                 config->fetch = UNQUALIFIED_FETCH_NO;
318                         } else if (!strcasecmp(value, "warn")) {
319                                 config->fetch = UNQUALIFIED_FETCH_WARN;
320                         } else if (!strcasecmp(value, "error")) {
321                                 config->fetch = UNQUALIFIED_FETCH_ERROR;
322                         } else {
323                                 ast_log(LOG_ERROR, "Unrecognized value in %s:%s: '%s'\n", family, name, value);
324                                 return NULL;
325                         }
326                 } else {
327                         ast_log(LOG_ERROR, "Unrecognized option in %s: '%s'\n", family, name);
328                         return NULL;
329                 }
330         }
331
332         return config;
333 }
334
335 static void sorcery_realtime_close(void *data)
336 {
337         ast_free(data);
338 }
339
340 static int load_module(void)
341 {
342         if (ast_sorcery_wizard_register(&realtime_object_wizard)) {
343                 return AST_MODULE_LOAD_DECLINE;
344         }
345
346         return AST_MODULE_LOAD_SUCCESS;
347 }
348
349 static int unload_module(void)
350 {
351         ast_sorcery_wizard_unregister(&realtime_object_wizard);
352         return 0;
353 }
354
355 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Sorcery Realtime Object Wizard",
356         .support_level = AST_MODULE_SUPPORT_CORE,
357         .load = load_module,
358         .unload = unload_module,
359         .load_pri = AST_MODPRI_REALTIME_DRIVER,
360 );