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