Pass the sorcery instance to wizards for CUD operations as well as retrieve.
[asterisk/asterisk.git] / main / sorcery.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 /*! \file
20  *
21  * \brief Sorcery Data Access Layer API
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/logger.h"
35 #include "asterisk/sorcery.h"
36 #include "asterisk/astobj2.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/config_options.h"
39 #include "asterisk/netsock2.h"
40 #include "asterisk/module.h"
41
42 /* To prevent DEBUG_FD_LEAKS from interfering with things we undef open and close */
43 #undef open
44 #undef close
45
46 /*! \brief Number of buckets for wizards (should be prime for performance reasons) */
47 #define WIZARD_BUCKETS 7
48
49 /*! \brief Number of buckets for types (should be prime for performance reasons) */
50 #define TYPE_BUCKETS 53
51
52 /*! \brief Maximum length of an object field name */
53 #define MAX_OBJECT_FIELD 128
54
55 /*! \brief Structure for registered object type */
56 struct ast_sorcery_object_type {
57         /*! \brief Unique name of the object type */
58         char name[MAX_OBJECT_TYPE];
59
60         /*! \brief Optional transformation callback */
61         sorcery_transform_handler transform;
62
63         /*! \brief Optional object set apply callback */
64         sorcery_apply_handler apply;
65
66         /*! \brief Optional object copy callback */
67         sorcery_copy_handler copy;
68
69         /*! \brief Optional object diff callback */
70         sorcery_diff_handler diff;
71
72         /*! \brief Wizard instances */
73         struct ao2_container *wizards;
74
75         /*! \brief Object fields */
76         struct ao2_container *fields;
77
78         /*! \brief Configuration framework general information */
79         struct aco_info *info;
80
81         /*! \brief Configuration framework file information */
82         struct aco_file *file;
83
84         /*! \brief Type details */
85         struct aco_type type;
86 };
87
88 /*! \brief Structure for registered object field */
89 struct ast_sorcery_object_field {
90         /*! \brief Name of the field */
91         char name[MAX_OBJECT_FIELD];
92
93         /*! \brief Callback function for translation of a single value */
94         sorcery_field_handler handler;
95
96         /*! \brief Callback function for translation of multiple values */
97         sorcery_fields_handler multiple_handler;
98
99         /*! \brief Position of the field */
100         intptr_t args[];
101 };
102
103 /*! \brief Structure for a wizard instance which operates on objects */
104 struct ast_sorcery_object_wizard {
105         /*! \brief Wizard interface itself */
106         struct ast_sorcery_wizard *wizard;
107
108         /*! \brief Unique data for the wizard */
109         void *data;
110
111         /*! \brief Wizard is acting as an object cache */
112         unsigned int caching:1;
113 };
114
115 /*! \brief Full structure for sorcery */
116 struct ast_sorcery {
117         /*! \brief Container for known object types */
118         struct ao2_container *types;
119 };
120
121 /*! \brief Structure for passing load/reload details */
122 struct sorcery_load_details {
123         /*! \brief Sorcery structure in use */
124         const struct ast_sorcery *sorcery;
125
126         /*! \brief Type of object being loaded */
127         const char *type;
128
129         /*! \brief Whether this is a reload or not */
130         unsigned int reload:1;
131 };
132
133 /*! \brief Registered sorcery wizards */
134 struct ao2_container *wizards;
135
136 static int int_handler_fn(const void *obj, const intptr_t *args, char **buf)
137 {
138         int *field = (int *)(obj + args[0]);
139         return (ast_asprintf(buf, "%d", *field) < 0) ? -1 : 0;
140 }
141
142 static int uint_handler_fn(const void *obj, const intptr_t *args, char **buf)
143 {
144         unsigned int *field = (unsigned int *)(obj + args[0]);
145         return (ast_asprintf(buf, "%u", *field) < 0) ? -1 : 0;
146 }
147
148 static int double_handler_fn(const void *obj, const intptr_t *args, char **buf)
149 {
150         double *field = (double *)(obj + args[0]);
151         return (ast_asprintf(buf, "%f", *field) < 0) ? -1 : 0;
152 }
153
154 static int stringfield_handler_fn(const void *obj, const intptr_t *args, char **buf)
155 {
156         ast_string_field *field = (const char **)(obj + args[0]);
157         return !(*buf = ast_strdup(*field)) ? -1 : 0;
158 }
159
160 static int bool_handler_fn(const void *obj, const intptr_t *args, char **buf)
161 {
162         unsigned int *field = (unsigned int *)(obj + args[0]);
163         return !(*buf = ast_strdup(*field ? "true" : "false")) ? -1 : 0;
164 }
165
166 static int sockaddr_handler_fn(const void *obj, const intptr_t *args, char **buf)
167 {
168         struct ast_sockaddr *field = (struct ast_sockaddr *)(obj + args[0]);
169         return !(*buf = ast_strdup(ast_sockaddr_stringify(field))) ? -1 : 0;
170 }
171
172 static int noop_handler_fn(const void *obj, const intptr_t *args, char **buf)
173 {
174         return 0;
175 }
176
177 static int chararray_handler_fn(const void *obj, const intptr_t *args, char **buf)
178 {
179         char *field = (char *)(obj + args[0]);
180         return !(*buf = ast_strdup(field)) ? -1 : 0;
181 }
182
183 static sorcery_field_handler sorcery_field_default_handler(enum aco_option_type type)
184 {
185         switch(type) {
186         case OPT_BOOL_T: return bool_handler_fn;
187         case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
188         case OPT_DOUBLE_T: return double_handler_fn;
189         case OPT_INT_T: return int_handler_fn;
190         case OPT_NOOP_T: return noop_handler_fn;
191         case OPT_SOCKADDR_T: return sockaddr_handler_fn;
192         case OPT_STRINGFIELD_T: return stringfield_handler_fn;
193         case OPT_UINT_T: return uint_handler_fn;
194
195         default:
196         case OPT_CUSTOM_T: return NULL;
197         }
198
199         return NULL;
200 }
201
202 /*! \brief Hashing function for sorcery wizards */
203 static int sorcery_wizard_hash(const void *obj, const int flags)
204 {
205         const struct ast_sorcery_wizard *wizard = obj;
206         const char *name = obj;
207
208         return ast_str_hash(flags & OBJ_KEY ? name : wizard->name);
209 }
210
211 /*! \brief Comparator function for sorcery wizards */
212 static int sorcery_wizard_cmp(void *obj, void *arg, int flags)
213 {
214         struct ast_sorcery_wizard *wizard1 = obj, *wizard2 = arg;
215         const char *name = arg;
216
217         return !strcmp(wizard1->name, flags & OBJ_KEY ? name : wizard2->name) ? CMP_MATCH | CMP_STOP : 0;
218 }
219
220 int ast_sorcery_init(void)
221 {
222         ast_assert(wizards == NULL);
223
224         if (!(wizards = ao2_container_alloc(WIZARD_BUCKETS, sorcery_wizard_hash, sorcery_wizard_cmp))) {
225                 return -1;
226         }
227
228         return 0;
229 }
230
231 int __ast_sorcery_wizard_register(const struct ast_sorcery_wizard *interface, struct ast_module *module)
232 {
233         struct ast_sorcery_wizard *wizard;
234         int res = -1;
235
236         ast_assert(!ast_strlen_zero(interface->name));
237
238         ao2_lock(wizards);
239
240         if ((wizard = ao2_find(wizards, interface->name, OBJ_KEY | OBJ_NOLOCK))) {
241                 ast_log(LOG_WARNING, "Attempted to register sorcery wizard '%s' twice\n",
242                         interface->name);
243                 goto done;
244         }
245
246         if (!(wizard = ao2_alloc(sizeof(*wizard), NULL))) {
247                 goto done;
248         }
249
250         *wizard = *interface;
251         wizard->module = module;
252
253         ao2_link_flags(wizards, wizard, OBJ_NOLOCK);
254         res = 0;
255
256         ast_verb(2, "Sorcery registered wizard '%s'\n", interface->name);
257
258 done:
259         ao2_cleanup(wizard);
260         ao2_unlock(wizards);
261
262         return res;
263 }
264
265 int ast_sorcery_wizard_unregister(const struct ast_sorcery_wizard *interface)
266 {
267         RAII_VAR(struct ast_sorcery_wizard *, wizard, ao2_find(wizards, interface->name, OBJ_KEY | OBJ_UNLINK), ao2_cleanup);
268
269         if (wizard) {
270                 ast_verb(2, "Sorcery unregistered wizard '%s'\n", interface->name);
271                 return 0;
272         } else {
273                 return -1;
274         }
275 }
276
277 /*! \brief Destructor called when sorcery structure is destroyed */
278 static void sorcery_destructor(void *obj)
279 {
280         struct ast_sorcery *sorcery = obj;
281
282         ao2_cleanup(sorcery->types);
283 }
284
285 /*! \brief Hashing function for sorcery types */
286 static int sorcery_type_hash(const void *obj, const int flags)
287 {
288         const struct ast_sorcery_object_type *type = obj;
289         const char *name = obj;
290
291         return ast_str_hash(flags & OBJ_KEY ? name : type->name);
292 }
293
294 /*! \brief Comparator function for sorcery types */
295 static int sorcery_type_cmp(void *obj, void *arg, int flags)
296 {
297         struct ast_sorcery_object_type *type1 = obj, *type2 = arg;
298         const char *name = arg;
299
300         return !strcmp(type1->name, flags & OBJ_KEY ? name : type2->name) ? CMP_MATCH | CMP_STOP : 0;
301 }
302
303 struct ast_sorcery *ast_sorcery_open(void)
304 {
305         struct ast_sorcery *sorcery;
306
307         if (!(sorcery = ao2_alloc(sizeof(*sorcery), sorcery_destructor))) {
308                 return NULL;
309         }
310
311         if (!(sorcery->types = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, TYPE_BUCKETS, sorcery_type_hash, sorcery_type_cmp))) {
312                 ao2_ref(sorcery, -1);
313                 sorcery = NULL;
314         }
315
316         return sorcery;
317 }
318
319 /*! \brief Destructor function for object types */
320 static void sorcery_object_type_destructor(void *obj)
321 {
322         struct ast_sorcery_object_type *object_type = obj;
323
324         ao2_cleanup(object_type->wizards);
325         ao2_cleanup(object_type->fields);
326
327         if (object_type->info) {
328                 aco_info_destroy(object_type->info);
329                 ast_free(object_type->info);
330         }
331
332         ast_free(object_type->file);
333 }
334
335 /*! \brief Internal function which allocates an object type structure */
336 static struct ast_sorcery_object_type *sorcery_object_type_alloc(const char *type, const char *module)
337 {
338         struct ast_sorcery_object_type *object_type;
339
340         if (!(object_type = ao2_alloc(sizeof(*object_type), sorcery_object_type_destructor))) {
341                 return NULL;
342         }
343
344         /* Order matters for object wizards */
345         if (!(object_type->wizards = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
346                 ao2_ref(object_type, -1);
347                 return NULL;
348         }
349
350         if (!(object_type->fields = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
351                 ao2_ref(object_type, -1);
352                 return NULL;
353         }
354
355         if (!(object_type->info = ast_calloc(1, sizeof(*object_type->info) + 2 * sizeof(object_type->info->files[0])))) {
356                 ao2_ref(object_type, -1);
357                 return NULL;
358         }
359
360         if (!(object_type->file = ast_calloc(1, sizeof(*object_type->file) + 2 * sizeof(object_type->file->types[0])))) {
361                 ao2_ref(object_type, -1);
362                 return NULL;
363         }
364
365         object_type->info->files[0] = object_type->file;
366         object_type->info->files[1] = NULL;
367         object_type->info->module = module;
368
369         ast_copy_string(object_type->name, type, sizeof(object_type->name));
370
371         return object_type;
372 }
373
374 /*! \brief Object wizard destructor */
375 static void sorcery_object_wizard_destructor(void *obj)
376 {
377         struct ast_sorcery_object_wizard *object_wizard = obj;
378
379         if (object_wizard->data) {
380                 object_wizard->wizard->close(object_wizard->data);
381         }
382
383         if (object_wizard->wizard) {
384                 ast_module_unref(object_wizard->wizard->module);
385         }
386 }
387
388 /*! \brief Internal function which creates an object type and adds a wizard mapping */
389 static int sorcery_apply_wizard_mapping(struct ast_sorcery *sorcery, const char *type, const char *module, const char *name, const char *data, unsigned int caching)
390 {
391         RAII_VAR(struct ast_sorcery_object_type *, object_type,  ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
392         RAII_VAR(struct ast_sorcery_wizard *, wizard, ao2_find(wizards, name, OBJ_KEY), ao2_cleanup);
393         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, ao2_alloc(sizeof(*object_wizard), sorcery_object_wizard_destructor), ao2_cleanup);
394         int created = 0;
395
396         if (!wizard || !object_wizard) {
397                 return -1;
398         }
399
400         if (!object_type) {
401                 if (!(object_type = sorcery_object_type_alloc(type, module))) {
402                         return -1;
403                 }
404                 created = 1;
405         }
406
407         if (wizard->open && !(object_wizard->data = wizard->open(data))) {
408                 return -1;
409         }
410
411         ast_module_ref(wizard->module);
412
413         object_wizard->wizard = wizard;
414         object_wizard->caching = caching;
415
416         ao2_link(object_type->wizards, object_wizard);
417
418         if (created) {
419                 ao2_link(sorcery->types, object_type);
420         }
421
422         return 0;
423 }
424
425 int __ast_sorcery_apply_config(struct ast_sorcery *sorcery, const char *name, const char *module)
426 {
427         struct ast_flags flags = { 0 };
428         struct ast_config *config = ast_config_load2("sorcery.conf", "sorcery", flags);
429         struct ast_variable *mapping;
430         int res = 0;
431
432         if (!config || (config == CONFIG_STATUS_FILEMISSING) || (config == CONFIG_STATUS_FILEINVALID)) {
433                 return -1;
434         }
435
436         for (mapping = ast_variable_browse(config, name); mapping; mapping = mapping->next) {
437                 RAII_VAR(char *, mapping_name, ast_strdup(mapping->name), ast_free);
438                 RAII_VAR(char *, mapping_value, ast_strdup(mapping->value), ast_free);
439                 char *options = mapping_name, *name = strsep(&options, "/");
440                 char *data = mapping_value, *wizard = strsep(&data, ",");
441                 unsigned int caching = 0;
442
443                 /* If no wizard exists just skip, nothing we can do */
444                 if (ast_strlen_zero(wizard)) {
445                         continue;
446                 }
447
448                 /* If the wizard is configured as a cache treat it as such */
449                 if (!ast_strlen_zero(options) && strstr(options, "cache")) {
450                         caching = 1;
451                 }
452
453                 /* Any error immediately causes us to stop */
454                 if ((res = sorcery_apply_wizard_mapping(sorcery, name, module, wizard, data, caching))) {
455                         break;
456                 }
457         }
458
459         ast_config_destroy(config);
460
461         return res;
462 }
463
464 int __ast_sorcery_apply_default(struct ast_sorcery *sorcery, const char *type, const char *module, const char *name, const char *data)
465 {
466         RAII_VAR(struct ast_sorcery_object_type *, object_type,  ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
467
468         /* Defaults can not be added if any existing mapping exists */
469         if (object_type) {
470                 return -1;
471         }
472
473         return sorcery_apply_wizard_mapping(sorcery, type, module, name, data, 0);
474 }
475
476 int ast_sorcery_object_register(struct ast_sorcery *sorcery, const char *type, aco_type_item_alloc alloc, sorcery_transform_handler transform, sorcery_apply_handler apply)
477 {
478         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
479
480         if (!object_type || object_type->type.item_alloc) {
481                 return -1;
482         }
483
484         object_type->type.type = ACO_ITEM;
485         object_type->type.category = "";
486         object_type->type.item_alloc = alloc;
487
488         object_type->transform = transform;
489         object_type->apply = apply;
490         object_type->file->types[0] = &object_type->type;
491         object_type->file->types[1] = NULL;
492
493         if (aco_info_init(object_type->info)) {
494                 return -1;
495         }
496
497         return 0;
498 }
499
500 void ast_sorcery_object_set_copy_handler(struct ast_sorcery *sorcery, const char *type, sorcery_copy_handler copy)
501 {
502         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
503
504         if (!object_type) {
505                 return;
506         }
507
508         object_type->copy = copy;
509 }
510
511 void ast_sorcery_object_set_diff_handler(struct ast_sorcery *sorcery, const char *type, sorcery_diff_handler diff)
512 {
513         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
514
515         if (!object_type) {
516                 return;
517         }
518
519         object_type->diff = diff;
520 }
521
522 int ast_sorcery_object_fields_register(struct ast_sorcery *sorcery, const char *type, const char *regex, aco_option_handler config_handler, sorcery_fields_handler sorcery_handler)
523 {
524         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
525         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
526
527         if (!object_type || !object_type->type.item_alloc || !config_handler || !(object_field = ao2_alloc(sizeof(*object_field), NULL))) {
528                 return -1;
529         }
530
531         ast_copy_string(object_field->name, regex, sizeof(object_field->name));
532         object_field->multiple_handler = sorcery_handler;
533
534         ao2_link(object_type->fields, object_field);
535         __aco_option_register(object_type->info, regex, ACO_REGEX, object_type->file->types, "", OPT_CUSTOM_T, config_handler, 0, 0);
536
537         return 0;
538 }
539
540 int __ast_sorcery_object_field_register(struct ast_sorcery *sorcery, const char *type, const char *name, const char *default_val, enum aco_option_type opt_type,
541                                         aco_option_handler config_handler, sorcery_field_handler sorcery_handler, unsigned int flags, size_t argc, ...)
542 {
543         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
544         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
545         int pos;
546         va_list args;
547
548         if (!object_type || !object_type->type.item_alloc) {
549                 return -1;
550         }
551
552         if (!sorcery_handler) {
553                 sorcery_handler = sorcery_field_default_handler(opt_type);
554         }
555
556         if (!(object_field = ao2_alloc(sizeof(*object_field) + argc * sizeof(object_field->args[0]), NULL))) {
557                 return -1;
558         }
559
560         ast_copy_string(object_field->name, name, sizeof(object_field->name));
561         object_field->handler = sorcery_handler;
562
563         va_start(args, argc);
564         for (pos = 0; pos < argc; pos++) {
565                 object_field->args[pos] = va_arg(args, size_t);
566         }
567         va_end(args);
568
569         ao2_link(object_type->fields, object_field);
570
571         /* TODO: Improve this hack */
572         if (!argc) {
573                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc);
574         } else if (argc == 1) {
575                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
576                                       object_field->args[0]);
577         } else if (argc == 2) {
578                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
579                                       object_field->args[0], object_field->args[1]);
580         } else if (argc == 3) {
581                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
582                                       object_field->args[0], object_field->args[1], object_field->args[2]);
583         } else {
584                 ast_assert(0); /* The hack... she does us no good for this */
585         }
586
587         return 0;
588 }
589
590 static int sorcery_wizard_load(void *obj, void *arg, int flags)
591 {
592         struct ast_sorcery_object_wizard *wizard = obj;
593         struct sorcery_load_details *details = arg;
594         void (*load)(void *data, const struct ast_sorcery *sorcery, const char *type);
595
596         load = !details->reload ? wizard->wizard->load : wizard->wizard->reload;
597
598         if (load) {
599                 load(wizard->data, details->sorcery, details->type);
600         }
601
602         return 0;
603 }
604
605 static int sorcery_object_load(void *obj, void *arg, int flags)
606 {
607         struct ast_sorcery_object_type *type = obj;
608         struct sorcery_load_details *details = arg;
609
610         details->type = type->name;
611         ao2_callback(type->wizards, OBJ_NODATA, sorcery_wizard_load, details);
612
613         return 0;
614 }
615
616 void ast_sorcery_load(const struct ast_sorcery *sorcery)
617 {
618         struct sorcery_load_details details = {
619                 .sorcery = sorcery,
620                 .reload = 0,
621         };
622
623         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
624 }
625
626 void ast_sorcery_load_object(const struct ast_sorcery *sorcery, const char *type)
627 {
628         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
629         struct sorcery_load_details details = {
630                 .sorcery = sorcery,
631                 .reload = 0,
632         };
633
634         if (!object_type) {
635                 return;
636         }
637
638         sorcery_object_load(object_type, &details, 0);
639 }
640
641 void ast_sorcery_reload(const struct ast_sorcery *sorcery)
642 {
643         struct sorcery_load_details details = {
644                 .sorcery = sorcery,
645                 .reload = 1,
646         };
647
648         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
649 }
650
651 void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *type)
652 {
653         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
654         struct sorcery_load_details details = {
655                 .sorcery = sorcery,
656                 .reload = 1,
657         };
658
659         if (!object_type) {
660                 return;
661         }
662
663         sorcery_object_load(object_type, &details, 0);
664 }
665
666 void ast_sorcery_ref(struct ast_sorcery *sorcery)
667 {
668         ao2_ref(sorcery, +1);
669 }
670
671 struct ast_variable *ast_sorcery_objectset_create(const struct ast_sorcery *sorcery, const void *object)
672 {
673         const struct ast_sorcery_object_details *details = object;
674         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
675         struct ao2_iterator i;
676         struct ast_sorcery_object_field *object_field;
677         struct ast_variable *fields = NULL;
678         int res = 0;
679
680         if (!object_type) {
681                 return NULL;
682         }
683
684         i = ao2_iterator_init(object_type->fields, 0);
685
686         for (; (object_field = ao2_iterator_next(&i)) && !res; ao2_ref(object_field, -1)) {
687                 struct ast_variable *tmp = NULL;
688
689                 if (object_field->multiple_handler) {
690                         if ((res = object_field->multiple_handler(object, &tmp))) {
691                                 ast_variables_destroy(tmp);
692                         }
693                 } else if (object_field->handler) {
694                         char *buf = NULL;
695
696                         if ((res = object_field->handler(object, object_field->args, &buf)) ||
697                                 !(tmp = ast_variable_new(object_field->name, S_OR(buf, ""), ""))) {
698                                 res = -1;
699                         }
700
701                         ast_free(buf);
702                 } else {
703                         continue;
704                 }
705
706                 if (!res) {
707                         tmp->next = fields;
708                         fields = tmp;
709                 }
710         }
711
712         ao2_iterator_destroy(&i);
713
714         /* If any error occurs we destroy all fields handled before so a partial objectset is not returned */
715         if (res) {
716                 ast_variables_destroy(fields);
717                 fields = NULL;
718         }
719
720         return fields;
721 }
722
723 int ast_sorcery_objectset_apply(const struct ast_sorcery *sorcery, void *object, struct ast_variable *objectset)
724 {
725         const struct ast_sorcery_object_details *details = object;
726         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
727         RAII_VAR(struct ast_variable *, transformed, NULL, ast_variables_destroy);
728         struct ast_variable *field;
729         int res = 0;
730
731         if (!object_type) {
732                 return -1;
733         }
734
735         if (object_type->transform && (transformed = object_type->transform(objectset))) {
736                 field = transformed;
737         } else {
738                 field = objectset;
739         }
740
741         for (; field; field = field->next) {
742                 if ((res = aco_process_var(&object_type->type, details->id, field, object))) {
743                         break;
744                 }
745         }
746
747         if (!res && object_type->apply) {
748                 object_type->apply(sorcery, object);
749         }
750
751         return res;
752 }
753
754 static const struct ast_variable *sorcery_find_field(const struct ast_variable *fields, const char *name)
755 {
756         const struct ast_variable *field;
757
758         /* Search the linked list of fields to find the correct one */
759         for (field = fields; field; field = field->next) {
760                 if (!strcmp(field->name, name)) {
761                         return field;
762                 }
763         }
764
765         return NULL;
766 }
767
768 int ast_sorcery_changeset_create(const struct ast_variable *original, const struct ast_variable *modified, struct ast_variable **changes)
769 {
770         const struct ast_variable *field;
771         int res = 0;
772
773         *changes = NULL;
774
775         /* Unless the ast_variable list changes when examined... it can't differ from itself */
776         if (original == modified) {
777                 return 0;
778         }
779
780         for (field = modified; field; field = field->next) {
781                 const struct ast_variable *old = sorcery_find_field(original, field->name);
782
783                 if (!old || strcmp(old->value, field->value)) {
784                         struct ast_variable *tmp;
785
786                         if (!(tmp = ast_variable_new(field->name, field->value, ""))) {
787                                 res = -1;
788                                 break;
789                         }
790
791                         tmp->next = *changes;
792                         *changes = tmp;
793                 }
794         }
795
796         /* If an error occurred do not return a partial changeset */
797         if (res) {
798                 ast_variables_destroy(*changes);
799                 *changes = NULL;
800         }
801
802         return res;
803 }
804
805 void *ast_sorcery_alloc(const struct ast_sorcery *sorcery, const char *type, const char *id)
806 {
807         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
808         struct ast_sorcery_object_details *details;
809
810         if (!object_type || !object_type->type.item_alloc ||
811             !(details = object_type->type.item_alloc(""))) {
812                 return NULL;
813         }
814
815         if (ast_strlen_zero(id)) {
816                 struct ast_uuid *uuid = ast_uuid_generate();
817
818                 if (!uuid) {
819                         ao2_ref(details, -1);
820                         return NULL;
821                 }
822
823                 ast_uuid_to_str(uuid, details->id, AST_UUID_STR_LEN);
824                 ast_free(uuid);
825         } else {
826                 ast_copy_string(details->id, id, sizeof(details->id));
827         }
828
829         ast_copy_string(details->type, type, sizeof(details->type));
830
831         if (aco_set_defaults(&object_type->type, id, details)) {
832                 ao2_ref(details, -1);
833                 return NULL;
834         }
835
836         return details;
837 }
838
839 void *ast_sorcery_copy(const struct ast_sorcery *sorcery, const void *object)
840 {
841         const struct ast_sorcery_object_details *details = object;
842         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
843         struct ast_sorcery_object_details *copy = ast_sorcery_alloc(sorcery, details->type, details->id);
844         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
845         int res = 0;
846
847         if (!copy) {
848                 return NULL;
849         } else if (object_type->copy) {
850                 res = object_type->copy(object, copy);
851         } else if ((objectset = ast_sorcery_objectset_create(sorcery, object))) {
852                 res = ast_sorcery_objectset_apply(sorcery, copy, objectset);
853         } else {
854                 /* No native copy available and could not create an objectset, this copy has failed */
855                 res = -1;
856         }
857
858         if (res) {
859                 ao2_cleanup(copy);
860                 copy = NULL;
861         }
862
863         return copy;
864 }
865
866 int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes)
867 {
868         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, ast_sorcery_object_get_type(original), OBJ_KEY), ao2_cleanup);
869
870         *changes = NULL;
871
872         if (strcmp(ast_sorcery_object_get_type(original), ast_sorcery_object_get_type(modified))) {
873                 return -1;
874         }
875
876         if (original == modified) {
877                 return 0;
878         } else if (!object_type->diff) {
879                 RAII_VAR(struct ast_variable *, objectset1, NULL, ast_variables_destroy);
880                 RAII_VAR(struct ast_variable *, objectset2, NULL, ast_variables_destroy);
881
882                 objectset1 = ast_sorcery_objectset_create(sorcery, original);
883                 objectset2 = ast_sorcery_objectset_create(sorcery, modified);
884
885                 return ast_sorcery_changeset_create(objectset1, objectset2, changes);
886         } else {
887                 return object_type->diff(original, modified, changes);
888         }
889 }
890
891 /*! \brief Structure used when calling create, update, or delete */
892 struct sorcery_details {
893         /*! \brief Pointer to the sorcery instance */
894         const struct ast_sorcery *sorcery;
895         /*! \brief Pointer to the object itself */
896         void *obj;
897 };
898
899 /*! \brief Internal function used to create an object in caching wizards */
900 static int sorcery_cache_create(void *obj, void *arg, int flags)
901 {
902         const struct ast_sorcery_object_wizard *object_wizard = obj;
903         const struct sorcery_details *details = arg;
904
905         if (!object_wizard->caching || !object_wizard->wizard->create) {
906                 return 0;
907         }
908
909         object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj);
910
911         return 0;
912 }
913
914 void *ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
915 {
916         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
917         void *object = NULL;
918         struct ao2_iterator i;
919         struct ast_sorcery_object_wizard *wizard;
920         unsigned int cached = 0;
921
922         if (!object_type || ast_strlen_zero(id)) {
923                 return NULL;
924         }
925
926         i = ao2_iterator_init(object_type->wizards, 0);
927         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
928                 if (wizard->wizard->retrieve_id &&
929                     !(object = wizard->wizard->retrieve_id(sorcery, wizard->data, object_type->name, id))) {
930                         continue;
931                 }
932
933                 cached = wizard->caching;
934
935                 ao2_ref(wizard, -1);
936                 break;
937         }
938         ao2_iterator_destroy(&i);
939
940         if (!cached && object) {
941                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
942         }
943
944         return object;
945 }
946
947 void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields)
948 {
949         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
950         void *object = NULL;
951         struct ao2_iterator i;
952         struct ast_sorcery_object_wizard *wizard;
953         unsigned int cached = 0;
954
955         if (!object_type) {
956                 return NULL;
957         }
958
959         /* If returning multiple objects create a container to store them in */
960         if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
961                 if (!(object = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
962                         return NULL;
963                 }
964         }
965
966         /* Inquire with the available wizards for retrieval */
967         i = ao2_iterator_init(object_type->wizards, 0);
968         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
969                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
970                         if (wizard->wizard->retrieve_multiple) {
971                                 wizard->wizard->retrieve_multiple(sorcery, wizard->data, object_type->name, object, fields);
972                         }
973                 } else if (fields && wizard->wizard->retrieve_fields) {
974                         if (wizard->wizard->retrieve_fields) {
975                                 object = wizard->wizard->retrieve_fields(sorcery, wizard->data, object_type->name, fields);
976                         }
977                 }
978
979                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE) || !object) {
980                         continue;
981                 }
982
983                 cached = wizard->caching;
984
985                 ao2_ref(wizard, -1);
986                 break;
987         }
988         ao2_iterator_destroy(&i);
989
990         /* If we are returning a single object and it came from a non-cache source create it in any caches */
991         if (!(flags & AST_RETRIEVE_FLAG_MULTIPLE) && !cached && object) {
992                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
993         }
994
995         return object;
996 }
997
998 struct ao2_container *ast_sorcery_retrieve_by_regex(const struct ast_sorcery *sorcery, const char *type, const char *regex)
999 {
1000         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1001         struct ao2_container *objects;
1002         struct ao2_iterator i;
1003         struct ast_sorcery_object_wizard *wizard;
1004
1005         if (!object_type || !(objects = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1006                 return NULL;
1007         }
1008
1009         i = ao2_iterator_init(object_type->wizards, 0);
1010         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1011                 if (!wizard->wizard->retrieve_regex) {
1012                         continue;
1013                 }
1014
1015                 wizard->wizard->retrieve_regex(sorcery, wizard->data, object_type->name, objects, regex);
1016         }
1017         ao2_iterator_destroy(&i);
1018
1019         return objects;
1020 }
1021
1022 /*! \brief Internal function which returns if the wizard has created the object */
1023 static int sorcery_wizard_create(void *obj, void *arg, int flags)
1024 {
1025         const struct ast_sorcery_object_wizard *object_wizard = obj;
1026         const struct sorcery_details *details = arg;
1027
1028         return (!object_wizard->caching && !object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj)) ? CMP_MATCH | CMP_STOP : 0;
1029 }
1030
1031 int ast_sorcery_create(const struct ast_sorcery *sorcery, void *object)
1032 {
1033         const struct ast_sorcery_object_details *details = object;
1034         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
1035         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1036         struct sorcery_details sdetails = {
1037                 .sorcery = sorcery,
1038                 .obj = object,
1039         };
1040
1041         if (!object_type) {
1042                 return -1;
1043         }
1044
1045         object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_create, &sdetails);
1046
1047         return object_wizard ? 0 : -1;
1048 }
1049
1050 /*! \brief Internal function which returns if a wizard has updated the object */
1051 static int sorcery_wizard_update(void *obj, void *arg, int flags)
1052 {
1053         const struct ast_sorcery_object_wizard *object_wizard = obj;
1054         const struct sorcery_details *details = arg;
1055
1056         return (object_wizard->wizard->update && !object_wizard->wizard->update(details->sorcery, object_wizard->data, details->obj) &&
1057                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1058 }
1059
1060 int ast_sorcery_update(const struct ast_sorcery *sorcery, void *object)
1061 {
1062         const struct ast_sorcery_object_details *details = object;
1063         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
1064         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1065         struct sorcery_details sdetails = {
1066                 .sorcery = sorcery,
1067                 .obj = object,
1068         };
1069
1070         if (!object_type) {
1071                 return -1;
1072         }
1073
1074         object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_update, &sdetails);
1075
1076         return object_wizard ? 0 : -1;
1077 }
1078
1079 /*! \brief Internal function which returns if a wizard has deleted the object */
1080 static int sorcery_wizard_delete(void *obj, void *arg, int flags)
1081 {
1082         const struct ast_sorcery_object_wizard *object_wizard = obj;
1083         const struct sorcery_details *details = arg;
1084
1085         return (object_wizard->wizard->delete && !object_wizard->wizard->delete(details->sorcery, object_wizard->data, details->obj) &&
1086                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1087 }
1088
1089 int ast_sorcery_delete(const struct ast_sorcery *sorcery, void *object)
1090 {
1091         const struct ast_sorcery_object_details *details = object;
1092         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->type, OBJ_KEY), ao2_cleanup);
1093         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1094         struct sorcery_details sdetails = {
1095                 .sorcery = sorcery,
1096                 .obj = object,
1097         };
1098
1099         if (!object_type) {
1100                 return -1;
1101         }
1102
1103         object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_delete, &sdetails);
1104
1105         return object_wizard ? 0 : -1;
1106 }
1107
1108 void ast_sorcery_unref(struct ast_sorcery *sorcery)
1109 {
1110         ao2_cleanup(sorcery);
1111 }
1112
1113 const char *ast_sorcery_object_get_id(const void *object)
1114 {
1115         const struct ast_sorcery_object_details *details = object;
1116         return details->id;
1117 }
1118
1119 const char *ast_sorcery_object_get_type(const void *object)
1120 {
1121         const struct ast_sorcery_object_details *details = object;
1122         return details->type;
1123 }