Add support for a realtime sorcery module.
[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 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include <regex.h>
36
37 #include "asterisk/module.h"
38 #include "asterisk/sorcery.h"
39
40 /*! \brief They key field used to store the unique identifier for the object */
41 #define UUID_FIELD "id"
42
43 static void *sorcery_realtime_open(const char *data);
44 static int sorcery_realtime_create(const struct ast_sorcery *sorcery, void *data, void *object);
45 static void *sorcery_realtime_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id);
46 static void *sorcery_realtime_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields);
47 static void sorcery_realtime_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects,
48                                              const struct ast_variable *fields);
49 static void sorcery_realtime_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex);
50 static int sorcery_realtime_update(const struct ast_sorcery *sorcery, void *data, void *object);
51 static int sorcery_realtime_delete(const struct ast_sorcery *sorcery, void *data, void *object);
52 static void sorcery_realtime_close(void *data);
53
54 static struct ast_sorcery_wizard realtime_object_wizard = {
55         .name = "realtime",
56         .open = sorcery_realtime_open,
57         .create = sorcery_realtime_create,
58         .retrieve_id = sorcery_realtime_retrieve_id,
59         .retrieve_fields = sorcery_realtime_retrieve_fields,
60         .retrieve_multiple = sorcery_realtime_retrieve_multiple,
61         .retrieve_regex = sorcery_realtime_retrieve_regex,
62         .update = sorcery_realtime_update,
63         .delete = sorcery_realtime_delete,
64         .close = sorcery_realtime_close,
65 };
66
67 static int sorcery_realtime_create(const struct ast_sorcery *sorcery, void *data, void *object)
68 {
69         const char *family = data;
70         RAII_VAR(struct ast_variable *, fields, ast_sorcery_objectset_create(sorcery, object), ast_variables_destroy);
71         struct ast_variable *id = ast_variable_new(UUID_FIELD, ast_sorcery_object_get_id(object), "");
72
73         if (!fields || !id) {
74                 ast_variables_destroy(id);
75                 return -1;
76         }
77
78         /* Place the identifier at the front for sanity sake */
79         id->next = fields;
80         fields = id;
81
82         return ast_store_realtime_fields(family, fields) ? -1 : 0;
83 }
84
85 /*! \brief Internal helper function which returns a filtered objectset, basically removes the id field */
86 static struct ast_variable *sorcery_realtime_filter_objectset(struct ast_variable *objectset, struct ast_variable **id)
87 {
88         struct ast_variable *previous = NULL, *field;
89
90         for (field = objectset; field; field = field->next) {
91                 if (!strcmp(field->name, UUID_FIELD)) {
92                         *id = field;
93
94                         if (previous) {
95                                 previous->next = field->next;
96                         } else {
97                                 objectset = field->next;
98                         }
99
100                         field->next = NULL;
101                         break;
102                 }
103                 previous = field;
104         }
105
106         return objectset;
107 }
108
109 static void *sorcery_realtime_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields)
110 {
111         const char *family = data;
112         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
113         RAII_VAR(struct ast_variable *, id, NULL, ast_variables_destroy);
114         void *object = NULL;
115
116         if (!(objectset = ast_load_realtime_fields(family, fields))) {
117                 return NULL;
118         }
119
120         objectset = sorcery_realtime_filter_objectset(objectset, &id);
121
122         if (!id || !(object = ast_sorcery_alloc(sorcery, type, id->value)) || ast_sorcery_objectset_apply(sorcery, object, objectset)) {
123                 return NULL;
124         }
125
126         return object;
127 }
128
129 static void *sorcery_realtime_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
130 {
131         RAII_VAR(struct ast_variable *, fields, ast_variable_new(UUID_FIELD, id, ""), ast_variables_destroy);
132
133         return sorcery_realtime_retrieve_fields(sorcery, data, type, fields);
134 }
135
136 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)
137 {
138         const char *family = data;
139         RAII_VAR(struct ast_config *, rows, NULL, ast_config_destroy);
140         RAII_VAR(struct ast_variable *, all, NULL, ast_variables_destroy);
141         char *row = NULL;
142
143         if (!fields) {
144                 char field[strlen(UUID_FIELD) + 6], value[2];
145
146                 /* If no fields have been specified we want all rows, so trick realtime into doing it */
147                 snprintf(field, sizeof(field), "%s LIKE", UUID_FIELD);
148                 snprintf(value, sizeof(value), "%%");
149
150                 if (!(all = ast_variable_new(field, value, ""))) {
151                         return;
152                 }
153
154                 fields = all;
155         }
156
157         if (!(rows = ast_load_realtime_multientry_fields(family, fields))) {
158                 return;
159         }
160
161         while ((row = ast_category_browse(rows, row))) {
162                 struct ast_variable *objectset = ast_category_root(rows, row);
163                 RAII_VAR(struct ast_variable *, id, NULL, ast_variables_destroy);
164                 RAII_VAR(void *, object, NULL, ao2_cleanup);
165
166                 objectset = sorcery_realtime_filter_objectset(objectset, &id);
167
168                 if (id && (object = ast_sorcery_alloc(sorcery, type, id->value)) && !ast_sorcery_objectset_apply(sorcery, object, objectset)) {
169                         ao2_link(objects, object);
170                 }
171
172                 /* If the id is the root of the row it will be destroyed during ast_config_destroy */
173                 if (id == ast_category_root(rows, row)) {
174                         id = NULL;
175                 }
176         }
177 }
178
179 static void sorcery_realtime_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex)
180 {
181         char field[strlen(UUID_FIELD) + 6], value[strlen(regex) + 2];
182         RAII_VAR(struct ast_variable *, fields, NULL, ast_variables_destroy);
183
184         /* The realtime API provides no direct ability to do regex so for now we support a limited subset using pattern matching */
185         if (regex[0] != '^') {
186                 return;
187         }
188
189         snprintf(field, sizeof(field), "%s LIKE", UUID_FIELD);
190         snprintf(value, sizeof(value), "%s%%", regex + 1);
191
192         if (!(fields = ast_variable_new(field, value, ""))) {
193                 return;
194         }
195
196         sorcery_realtime_retrieve_multiple(sorcery, data, type, objects, fields);
197 }
198
199 static int sorcery_realtime_update(const struct ast_sorcery *sorcery, void *data, void *object)
200 {
201         const char *family = data;
202         RAII_VAR(struct ast_variable *, fields, ast_sorcery_objectset_create(sorcery, object), ast_variables_destroy);
203
204         if (!fields) {
205                 return -1;
206         }
207
208         return (ast_update_realtime_fields(family, UUID_FIELD, ast_sorcery_object_get_id(object), fields) <= 0) ? -1 : 0;
209 }
210
211 static int sorcery_realtime_delete(const struct ast_sorcery *sorcery, void *data, void *object)
212 {
213         const char *family = data;
214
215         return (ast_destroy_realtime_fields(family, UUID_FIELD, ast_sorcery_object_get_id(object), NULL) <= 0) ? -1 : 0;
216 }
217
218 static void *sorcery_realtime_open(const char *data)
219 {
220         /* We require a prefix for family string generation, or else stuff could mix together */
221         if (ast_strlen_zero(data) || !ast_realtime_is_mapping_defined(data)) {
222                 return NULL;
223         }
224
225         return ast_strdup(data);
226 }
227
228 static void sorcery_realtime_close(void *data)
229 {
230         ast_free(data);
231 }
232
233 static int load_module(void)
234 {
235         if (ast_sorcery_wizard_register(&realtime_object_wizard)) {
236                 return AST_MODULE_LOAD_DECLINE;
237         }
238
239         return AST_MODULE_LOAD_SUCCESS;
240 }
241
242 static int unload_module(void)
243 {
244         ast_sorcery_wizard_unregister(&realtime_object_wizard);
245         return 0;
246 }
247
248 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Sorcery Realtime Object Wizard",
249         .load = load_module,
250         .unload = unload_module,
251         .load_pri = AST_MODPRI_REALTIME_DRIVER,
252 );