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