Merge "res_pjsip: New endpoint option "refer_blind_progress""
[asterisk/asterisk.git] / res / res_sorcery_memory.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 In-Memory 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
39 /*! \brief Number of buckets for sorcery objects */
40 #define OBJECT_BUCKETS 53
41
42 static void *sorcery_memory_open(const char *data);
43 static int sorcery_memory_create(const struct ast_sorcery *sorcery, void *data, void *object);
44 static void *sorcery_memory_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id);
45 static void *sorcery_memory_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields);
46 static void sorcery_memory_retrieve_multiple(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects,
47                                              const struct ast_variable *fields);
48 static void sorcery_memory_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex);
49 static int sorcery_memory_update(const struct ast_sorcery *sorcery, void *data, void *object);
50 static int sorcery_memory_delete(const struct ast_sorcery *sorcery, void *data, void *object);
51 static void sorcery_memory_close(void *data);
52
53 static struct ast_sorcery_wizard memory_object_wizard = {
54         .name = "memory",
55         .open = sorcery_memory_open,
56         .create = sorcery_memory_create,
57         .retrieve_id = sorcery_memory_retrieve_id,
58         .retrieve_fields = sorcery_memory_retrieve_fields,
59         .retrieve_multiple = sorcery_memory_retrieve_multiple,
60         .retrieve_regex = sorcery_memory_retrieve_regex,
61         .update = sorcery_memory_update,
62         .delete = sorcery_memory_delete,
63         .close = sorcery_memory_close,
64 };
65
66 /*! \brief Structure used for fields comparison */
67 struct sorcery_memory_fields_cmp_params {
68         /*! \brief Pointer to the sorcery structure */
69         const struct ast_sorcery *sorcery;
70
71         /*! \brief Pointer to the fields to check */
72         const struct ast_variable *fields;
73
74         /*! \brief Regular expression for checking object id */
75         regex_t *regex;
76
77         /*! \brief Optional container to put object into */
78         struct ao2_container *container;
79 };
80
81 /*! \brief Hashing function for sorcery objects */
82 static int sorcery_memory_hash(const void *obj, const int flags)
83 {
84         const char *id = obj;
85
86         return ast_str_hash(flags & OBJ_KEY ? id : ast_sorcery_object_get_id(obj));
87 }
88
89 /*! \brief Comparator function for sorcery objects */
90 static int sorcery_memory_cmp(void *obj, void *arg, int flags)
91 {
92         const char *id = arg;
93
94         return !strcmp(ast_sorcery_object_get_id(obj), flags & OBJ_KEY ? id : ast_sorcery_object_get_id(arg)) ? CMP_MATCH | CMP_STOP : 0;
95 }
96
97 static int sorcery_memory_create(const struct ast_sorcery *sorcery, void *data, void *object)
98 {
99         void *existing;
100
101         ao2_lock(data);
102
103         existing = ao2_find(data, ast_sorcery_object_get_id(object), OBJ_KEY | OBJ_NOLOCK);
104         if (existing) {
105                 ao2_ref(existing, -1);
106                 ao2_unlock(data);
107                 return -1;
108         }
109
110         ao2_link_flags(data, object, OBJ_NOLOCK);
111
112         ao2_unlock(data);
113
114         return 0;
115 }
116
117 static int sorcery_memory_fields_cmp(void *obj, void *arg, int flags)
118 {
119         const struct sorcery_memory_fields_cmp_params *params = arg;
120         RAII_VAR(struct ast_variable *, objset, NULL, ast_variables_destroy);
121
122         if (params->regex) {
123                 /* If a regular expression has been provided see if it matches, otherwise move on */
124                 if (!regexec(params->regex, ast_sorcery_object_get_id(obj), 0, NULL, 0)) {
125                         ao2_link(params->container, obj);
126                 }
127                 return 0;
128         } else if (params->fields &&
129             (!(objset = ast_sorcery_objectset_create(params->sorcery, obj)) ||
130              (!ast_variable_lists_match(objset, params->fields, 0)))) {
131                 /* If we can't turn the object into an object set OR if differences exist between the fields
132                  * passed in and what are present on the object they are not a match.
133                  */
134                 return 0;
135         }
136
137         if (params->container) {
138                 ao2_link(params->container, obj);
139
140                 /* As multiple objects are being returned keep going */
141                 return 0;
142         } else {
143                 /* Immediately stop and return, we only want a single object */
144                 return CMP_MATCH | CMP_STOP;
145         }
146 }
147
148 static void *sorcery_memory_retrieve_fields(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields)
149 {
150         struct sorcery_memory_fields_cmp_params params = {
151                 .sorcery = sorcery,
152                 .fields = fields,
153                 .container = NULL,
154         };
155
156         /* If no fields are present return nothing, we require *something* */
157         if (!fields) {
158                 return NULL;
159         }
160
161         return ao2_callback(data, 0, sorcery_memory_fields_cmp, &params);
162 }
163
164 static void *sorcery_memory_retrieve_id(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id)
165 {
166         return ao2_find(data, id, OBJ_KEY);
167 }
168
169 static void sorcery_memory_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_memory_fields_cmp_params params = {
172                 .sorcery = sorcery,
173                 .fields = fields,
174                 .container = objects,
175         };
176
177         ao2_callback(data, 0, sorcery_memory_fields_cmp, &params);
178 }
179
180 static void sorcery_memory_retrieve_regex(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const char *regex)
181 {
182         regex_t expression;
183         struct sorcery_memory_fields_cmp_params params = {
184                 .sorcery = sorcery,
185                 .container = objects,
186                 .regex = &expression,
187         };
188
189         if (ast_strlen_zero(regex)) {
190                 regex = ".";
191         }
192
193         if (regcomp(&expression, regex, REG_EXTENDED | REG_NOSUB)) {
194                 return;
195         }
196
197         ao2_callback(data, 0, sorcery_memory_fields_cmp, &params);
198         regfree(&expression);
199 }
200
201 static int sorcery_memory_update(const struct ast_sorcery *sorcery, void *data, void *object)
202 {
203         RAII_VAR(void *, existing, NULL, ao2_cleanup);
204
205         ao2_lock(data);
206
207         if (!(existing = ao2_find(data, ast_sorcery_object_get_id(object), OBJ_KEY | OBJ_UNLINK))) {
208                 ao2_unlock(data);
209                 return -1;
210         }
211
212         ao2_link(data, object);
213
214         ao2_unlock(data);
215
216         return 0;
217 }
218
219 static int sorcery_memory_delete(const struct ast_sorcery *sorcery, void *data, void *object)
220 {
221         RAII_VAR(void *, existing, ao2_find(data, ast_sorcery_object_get_id(object), OBJ_KEY | OBJ_UNLINK), ao2_cleanup);
222
223         return existing ? 0 : -1;
224 }
225
226 static void *sorcery_memory_open(const char *data)
227 {
228         return ao2_container_alloc(OBJECT_BUCKETS, sorcery_memory_hash, sorcery_memory_cmp);
229 }
230
231 static void sorcery_memory_close(void *data)
232 {
233         ao2_ref(data, -1);
234 }
235
236 static int load_module(void)
237 {
238         if (ast_sorcery_wizard_register(&memory_object_wizard)) {
239                 return AST_MODULE_LOAD_DECLINE;
240         }
241
242         return AST_MODULE_LOAD_SUCCESS;
243 }
244
245 static int unload_module(void)
246 {
247         ast_sorcery_wizard_unregister(&memory_object_wizard);
248         return 0;
249 }
250
251 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Sorcery In-Memory Object Wizard",
252         .support_level = AST_MODULE_SUPPORT_CORE,
253         .load = load_module,
254         .unload = unload_module,
255         .load_pri = AST_MODPRI_REALTIME_DRIVER,
256 );