b2bb8791556bc9cdbd877f851cb75e3bff84cf33
[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 #include "asterisk/taskprocessor.h"
42 #include "asterisk/threadpool.h"
43 #include "asterisk/json.h"
44
45 /* To prevent DEBUG_FD_LEAKS from interfering with things we undef open and close */
46 #undef open
47 #undef close
48
49 /*! \brief Number of buckets for wizards (should be prime for performance reasons) */
50 #define WIZARD_BUCKETS 7
51
52 /*! \brief Number of buckets for types (should be prime for performance reasons) */
53 #define TYPE_BUCKETS 53
54
55 /*! \brief Maximum length of an object field name */
56 #define MAX_OBJECT_FIELD 128
57
58 /*! \brief Thread pool for observers */
59 static struct ast_threadpool *threadpool;
60
61 /*! \brief Structure for internal sorcery object information */
62 struct ast_sorcery_object {
63         /*! \brief Unique identifier of this object */
64         char id[AST_UUID_STR_LEN];
65
66         /*! \brief Type of object */
67         char type[MAX_OBJECT_TYPE];
68
69         /*! \brief Optional object destructor */
70         ao2_destructor_fn destructor;
71
72         /*! \brief Extended object fields */
73         struct ast_variable *extended;
74 };
75
76 /*! \brief Structure for registered object type */
77 struct ast_sorcery_object_type {
78         /*! \brief Unique name of the object type */
79         char name[MAX_OBJECT_TYPE];
80
81         /*! \brief Optional transformation callback */
82         sorcery_transform_handler transform;
83
84         /*! \brief Optional object set apply callback */
85         sorcery_apply_handler apply;
86
87         /*! \brief Optional object copy callback */
88         sorcery_copy_handler copy;
89
90         /*! \brief Optional object diff callback */
91         sorcery_diff_handler diff;
92
93         /*! \brief Wizard instances */
94         struct ao2_container *wizards;
95
96         /*! \brief Object fields */
97         struct ao2_container *fields;
98
99         /*! \brief Configuration framework general information */
100         struct aco_info *info;
101
102         /*! \brief Configuration framework file information */
103         struct aco_file *file;
104
105         /*! \brief Type details */
106         struct aco_type type;
107
108         /*! \brief Observers */
109         struct ao2_container *observers;
110
111         /*! \brief Serializer for observers */
112         struct ast_taskprocessor *serializer;
113 };
114
115 /*! \brief Structure for registered object type observer */
116 struct ast_sorcery_object_type_observer {
117         /*! \brief Pointer to the observer implementation */
118         const struct ast_sorcery_observer *callbacks;
119 };
120
121 /*! \brief Structure used for observer invocations */
122 struct sorcery_observer_invocation {
123         /*! \brief Pointer to the object type */
124         struct ast_sorcery_object_type *object_type;
125
126         /*! \brief Pointer to the object */
127         void *object;
128 };
129
130 /*! \brief Structure for registered object field */
131 struct ast_sorcery_object_field {
132         /*! \brief Name of the field */
133         char name[MAX_OBJECT_FIELD];
134
135         /*! \brief Callback function for translation of a single value */
136         sorcery_field_handler handler;
137
138         /*! \brief Callback function for translation of multiple values */
139         sorcery_fields_handler multiple_handler;
140
141         /*! \brief Position of the field */
142         intptr_t args[];
143 };
144
145 /*! \brief Structure for a wizard instance which operates on objects */
146 struct ast_sorcery_object_wizard {
147         /*! \brief Wizard interface itself */
148         struct ast_sorcery_wizard *wizard;
149
150         /*! \brief Unique data for the wizard */
151         void *data;
152
153         /*! \brief Wizard is acting as an object cache */
154         unsigned int caching:1;
155 };
156
157 /*! \brief Full structure for sorcery */
158 struct ast_sorcery {
159         /*! \brief Container for known object types */
160         struct ao2_container *types;
161 };
162
163 /*! \brief Structure for passing load/reload details */
164 struct sorcery_load_details {
165         /*! \brief Sorcery structure in use */
166         const struct ast_sorcery *sorcery;
167
168         /*! \brief Type of object being loaded */
169         const char *type;
170
171         /*! \brief Whether this is a reload or not */
172         unsigned int reload:1;
173 };
174
175 /*! \brief Registered sorcery wizards */
176 struct ao2_container *wizards;
177
178 static int int_handler_fn(const void *obj, const intptr_t *args, char **buf)
179 {
180         int *field = (int *)(obj + args[0]);
181         return (ast_asprintf(buf, "%d", *field) < 0) ? -1 : 0;
182 }
183
184 static int uint_handler_fn(const void *obj, const intptr_t *args, char **buf)
185 {
186         unsigned int *field = (unsigned int *)(obj + args[0]);
187         return (ast_asprintf(buf, "%u", *field) < 0) ? -1 : 0;
188 }
189
190 static int double_handler_fn(const void *obj, const intptr_t *args, char **buf)
191 {
192         double *field = (double *)(obj + args[0]);
193         return (ast_asprintf(buf, "%f", *field) < 0) ? -1 : 0;
194 }
195
196 static int stringfield_handler_fn(const void *obj, const intptr_t *args, char **buf)
197 {
198         ast_string_field *field = (const char **)(obj + args[0]);
199         return !(*buf = ast_strdup(*field)) ? -1 : 0;
200 }
201
202 static int bool_handler_fn(const void *obj, const intptr_t *args, char **buf)
203 {
204         unsigned int *field = (unsigned int *)(obj + args[0]);
205         return !(*buf = ast_strdup(*field ? "true" : "false")) ? -1 : 0;
206 }
207
208 static int sockaddr_handler_fn(const void *obj, const intptr_t *args, char **buf)
209 {
210         struct ast_sockaddr *field = (struct ast_sockaddr *)(obj + args[0]);
211         return !(*buf = ast_strdup(ast_sockaddr_stringify(field))) ? -1 : 0;
212 }
213
214 static int chararray_handler_fn(const void *obj, const intptr_t *args, char **buf)
215 {
216         char *field = (char *)(obj + args[0]);
217         return !(*buf = ast_strdup(field)) ? -1 : 0;
218 }
219
220 static sorcery_field_handler sorcery_field_default_handler(enum aco_option_type type)
221 {
222         switch(type) {
223         case OPT_BOOL_T: return bool_handler_fn;
224         case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
225         case OPT_DOUBLE_T: return double_handler_fn;
226         case OPT_INT_T: return int_handler_fn;
227         case OPT_SOCKADDR_T: return sockaddr_handler_fn;
228         case OPT_STRINGFIELD_T: return stringfield_handler_fn;
229         case OPT_UINT_T: return uint_handler_fn;
230
231         default:
232         case OPT_CUSTOM_T: return NULL;
233         }
234
235         return NULL;
236 }
237
238 /*! \brief Hashing function for sorcery wizards */
239 static int sorcery_wizard_hash(const void *obj, const int flags)
240 {
241         const struct ast_sorcery_wizard *wizard = obj;
242         const char *name = obj;
243
244         return ast_str_hash(flags & OBJ_KEY ? name : wizard->name);
245 }
246
247 /*! \brief Comparator function for sorcery wizards */
248 static int sorcery_wizard_cmp(void *obj, void *arg, int flags)
249 {
250         struct ast_sorcery_wizard *wizard1 = obj, *wizard2 = arg;
251         const char *name = arg;
252
253         return !strcmp(wizard1->name, flags & OBJ_KEY ? name : wizard2->name) ? CMP_MATCH | CMP_STOP : 0;
254 }
255
256 /*! \brief Cleanup function */
257 static void sorcery_exit(void)
258 {
259         ast_threadpool_shutdown(threadpool);
260         threadpool = NULL;
261 }
262
263 /*! \brief Cleanup function for graceful shutdowns */
264 static void sorcery_cleanup(void)
265 {
266         ao2_cleanup(wizards);
267 }
268
269 int ast_sorcery_init(void)
270 {
271         struct ast_threadpool_options options = {
272                 .version = AST_THREADPOOL_OPTIONS_VERSION,
273                 .auto_increment = 1,
274                 .max_size = 0,
275                 .idle_timeout = 60,
276                 .initial_size = 0,
277         };
278         ast_assert(wizards == NULL);
279
280         if (!(threadpool = ast_threadpool_create("Sorcery", NULL, &options))) {
281                 threadpool = NULL;
282                 return -1;
283         }
284
285         if (!(wizards = ao2_container_alloc(WIZARD_BUCKETS, sorcery_wizard_hash, sorcery_wizard_cmp))) {
286                 ast_threadpool_shutdown(threadpool);
287                 return -1;
288         }
289
290         ast_register_cleanup(sorcery_cleanup);
291         ast_register_atexit(sorcery_exit);
292
293         return 0;
294 }
295
296 int __ast_sorcery_wizard_register(const struct ast_sorcery_wizard *interface, struct ast_module *module)
297 {
298         struct ast_sorcery_wizard *wizard;
299         int res = -1;
300
301         ast_assert(!ast_strlen_zero(interface->name));
302
303         ao2_lock(wizards);
304
305         if ((wizard = ao2_find(wizards, interface->name, OBJ_KEY | OBJ_NOLOCK))) {
306                 ast_log(LOG_WARNING, "Attempted to register sorcery wizard '%s' twice\n",
307                         interface->name);
308                 goto done;
309         }
310
311         if (!(wizard = ao2_alloc(sizeof(*wizard), NULL))) {
312                 goto done;
313         }
314
315         *wizard = *interface;
316         wizard->module = module;
317
318         ao2_link_flags(wizards, wizard, OBJ_NOLOCK);
319         res = 0;
320
321         ast_verb(2, "Sorcery registered wizard '%s'\n", interface->name);
322
323 done:
324         ao2_cleanup(wizard);
325         ao2_unlock(wizards);
326
327         return res;
328 }
329
330 int ast_sorcery_wizard_unregister(const struct ast_sorcery_wizard *interface)
331 {
332         RAII_VAR(struct ast_sorcery_wizard *, wizard, ao2_find(wizards, interface->name, OBJ_KEY | OBJ_UNLINK), ao2_cleanup);
333
334         if (wizard) {
335                 ast_verb(2, "Sorcery unregistered wizard '%s'\n", interface->name);
336                 return 0;
337         } else {
338                 return -1;
339         }
340 }
341
342 /*! \brief Destructor called when sorcery structure is destroyed */
343 static void sorcery_destructor(void *obj)
344 {
345         struct ast_sorcery *sorcery = obj;
346
347         ao2_cleanup(sorcery->types);
348 }
349
350 /*! \brief Hashing function for sorcery types */
351 static int sorcery_type_hash(const void *obj, const int flags)
352 {
353         const struct ast_sorcery_object_type *type = obj;
354         const char *name = obj;
355
356         return ast_str_hash(flags & OBJ_KEY ? name : type->name);
357 }
358
359 /*! \brief Comparator function for sorcery types */
360 static int sorcery_type_cmp(void *obj, void *arg, int flags)
361 {
362         struct ast_sorcery_object_type *type1 = obj, *type2 = arg;
363         const char *name = arg;
364
365         return !strcmp(type1->name, flags & OBJ_KEY ? name : type2->name) ? CMP_MATCH | CMP_STOP : 0;
366 }
367
368 struct ast_sorcery *ast_sorcery_open(void)
369 {
370         struct ast_sorcery *sorcery;
371
372         if (!(sorcery = ao2_alloc(sizeof(*sorcery), sorcery_destructor))) {
373                 return NULL;
374         }
375
376         if (!(sorcery->types = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, TYPE_BUCKETS, sorcery_type_hash, sorcery_type_cmp))) {
377                 ao2_ref(sorcery, -1);
378                 sorcery = NULL;
379         }
380
381         return sorcery;
382 }
383
384 /*! \brief Destructor function for object types */
385 static void sorcery_object_type_destructor(void *obj)
386 {
387         struct ast_sorcery_object_type *object_type = obj;
388
389         ao2_cleanup(object_type->wizards);
390         ao2_cleanup(object_type->fields);
391         ao2_cleanup(object_type->observers);
392
393         if (object_type->info) {
394                 aco_info_destroy(object_type->info);
395                 ast_free(object_type->info);
396         }
397
398         ast_free(object_type->file);
399
400         ast_taskprocessor_unreference(object_type->serializer);
401 }
402
403 /*! \brief Internal function which allocates an object type structure */
404 static struct ast_sorcery_object_type *sorcery_object_type_alloc(const char *type, const char *module)
405 {
406         struct ast_sorcery_object_type *object_type;
407         char uuid[AST_UUID_STR_LEN];
408
409         if (!(object_type = ao2_alloc(sizeof(*object_type), sorcery_object_type_destructor))) {
410                 return NULL;
411         }
412
413         /* Order matters for object wizards */
414         if (!(object_type->wizards = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
415                 ao2_ref(object_type, -1);
416                 return NULL;
417         }
418
419         if (!(object_type->fields = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
420                 ao2_ref(object_type, -1);
421                 return NULL;
422         }
423
424         if (!(object_type->observers = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, 1, NULL, NULL))) {
425                 ao2_ref(object_type, -1);
426                 return NULL;
427         }
428
429         if (!(object_type->info = ast_calloc(1, sizeof(*object_type->info) + 2 * sizeof(object_type->info->files[0])))) {
430                 ao2_ref(object_type, -1);
431                 return NULL;
432         }
433
434         if (!(object_type->file = ast_calloc(1, sizeof(*object_type->file) + 2 * sizeof(object_type->file->types[0])))) {
435                 ao2_ref(object_type, -1);
436                 return NULL;
437         }
438
439         if (!ast_uuid_generate_str(uuid, sizeof(uuid))) {
440                 ao2_ref(object_type, -1);
441                 return NULL;
442         }
443
444         if (!(object_type->serializer = ast_threadpool_serializer(uuid, threadpool))) {
445                 ao2_ref(object_type, -1);
446                 return NULL;
447         }
448
449         object_type->info->files[0] = object_type->file;
450         object_type->info->files[1] = NULL;
451         object_type->info->module = module;
452
453         ast_copy_string(object_type->name, type, sizeof(object_type->name));
454
455         return object_type;
456 }
457
458 /*! \brief Object wizard destructor */
459 static void sorcery_object_wizard_destructor(void *obj)
460 {
461         struct ast_sorcery_object_wizard *object_wizard = obj;
462
463         if (object_wizard->data) {
464                 object_wizard->wizard->close(object_wizard->data);
465         }
466
467         if (object_wizard->wizard) {
468                 ast_module_unref(object_wizard->wizard->module);
469         }
470 }
471
472 /*! \brief Internal function which creates an object type and adds a wizard mapping */
473 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)
474 {
475         RAII_VAR(struct ast_sorcery_object_type *, object_type,  ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
476         RAII_VAR(struct ast_sorcery_wizard *, wizard, ao2_find(wizards, name, OBJ_KEY), ao2_cleanup);
477         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, ao2_alloc(sizeof(*object_wizard), sorcery_object_wizard_destructor), ao2_cleanup);
478         int created = 0;
479
480         if (!wizard || !object_wizard) {
481                 return -1;
482         }
483
484         if (!object_type) {
485                 if (!(object_type = sorcery_object_type_alloc(type, module))) {
486                         return -1;
487                 }
488                 created = 1;
489         }
490
491         if (wizard->open && !(object_wizard->data = wizard->open(data))) {
492                 return -1;
493         }
494
495         ast_module_ref(wizard->module);
496
497         object_wizard->wizard = wizard;
498         object_wizard->caching = caching;
499
500         ao2_link(object_type->wizards, object_wizard);
501
502         if (created) {
503                 ao2_link(sorcery->types, object_type);
504         }
505
506         return 0;
507 }
508
509 int __ast_sorcery_apply_config(struct ast_sorcery *sorcery, const char *name, const char *module)
510 {
511         struct ast_flags flags = { 0 };
512         struct ast_config *config = ast_config_load2("sorcery.conf", "sorcery", flags);
513         struct ast_variable *mapping;
514         int res = 0;
515
516         if (!config || (config == CONFIG_STATUS_FILEMISSING) || (config == CONFIG_STATUS_FILEINVALID)) {
517                 return -1;
518         }
519
520         for (mapping = ast_variable_browse(config, name); mapping; mapping = mapping->next) {
521                 RAII_VAR(char *, mapping_name, ast_strdup(mapping->name), ast_free);
522                 RAII_VAR(char *, mapping_value, ast_strdup(mapping->value), ast_free);
523                 char *options = mapping_name, *name = strsep(&options, "/");
524                 char *data = mapping_value, *wizard = strsep(&data, ",");
525                 unsigned int caching = 0;
526
527                 /* If no wizard exists just skip, nothing we can do */
528                 if (ast_strlen_zero(wizard)) {
529                         continue;
530                 }
531
532                 /* If the wizard is configured as a cache treat it as such */
533                 if (!ast_strlen_zero(options) && strstr(options, "cache")) {
534                         caching = 1;
535                 }
536
537                 /* Any error immediately causes us to stop */
538                 if ((res = sorcery_apply_wizard_mapping(sorcery, name, module, wizard, data, caching))) {
539                         break;
540                 }
541         }
542
543         ast_config_destroy(config);
544
545         return res;
546 }
547
548 int __ast_sorcery_apply_default(struct ast_sorcery *sorcery, const char *type, const char *module, const char *name, const char *data)
549 {
550         RAII_VAR(struct ast_sorcery_object_type *, object_type,  ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
551
552         /* Defaults can not be added if any existing mapping exists */
553         if (object_type) {
554                 return -1;
555         }
556
557         return sorcery_apply_wizard_mapping(sorcery, type, module, name, data, 0);
558 }
559
560 static int sorcery_extended_config_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
561 {
562         return ast_sorcery_object_set_extended(obj, var->name, var->value);
563 }
564
565 static int sorcery_extended_fields_handler(const void *obj, struct ast_variable **fields)
566 {
567         const struct ast_sorcery_object_details *details = obj;
568
569         if (details->object->extended) {
570                 *fields = ast_variables_dup(details->object->extended);
571         } else {
572                 *fields = NULL;
573         }
574
575         return 0;
576 }
577
578 int __ast_sorcery_object_register(struct ast_sorcery *sorcery, const char *type, unsigned int hidden, aco_type_item_alloc alloc, sorcery_transform_handler transform, sorcery_apply_handler apply)
579 {
580         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
581
582         if (!object_type || object_type->type.item_alloc) {
583                 return -1;
584         }
585
586         object_type->type.name = object_type->name;
587         object_type->type.type = ACO_ITEM;
588         object_type->type.category = ".?";
589         object_type->type.item_alloc = alloc;
590         object_type->type.hidden = hidden;
591
592         object_type->transform = transform;
593         object_type->apply = apply;
594         object_type->file->types[0] = &object_type->type;
595         object_type->file->types[1] = NULL;
596
597         if (aco_info_init(object_type->info)) {
598                 return -1;
599         }
600
601         if (ast_sorcery_object_fields_register(sorcery, type, "^@", sorcery_extended_config_handler, sorcery_extended_fields_handler)) {
602                 return -1;
603         }
604
605         return 0;
606 }
607
608 void ast_sorcery_object_set_copy_handler(struct ast_sorcery *sorcery, const char *type, sorcery_copy_handler copy)
609 {
610         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
611
612         if (!object_type) {
613                 return;
614         }
615
616         object_type->copy = copy;
617 }
618
619 void ast_sorcery_object_set_diff_handler(struct ast_sorcery *sorcery, const char *type, sorcery_diff_handler diff)
620 {
621         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
622
623         if (!object_type) {
624                 return;
625         }
626
627         object_type->diff = diff;
628 }
629
630 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)
631 {
632         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
633         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
634
635         if (!object_type || !object_type->type.item_alloc || !config_handler || !(object_field = ao2_alloc(sizeof(*object_field), NULL))) {
636                 return -1;
637         }
638
639         ast_copy_string(object_field->name, regex, sizeof(object_field->name));
640         object_field->multiple_handler = sorcery_handler;
641
642         ao2_link(object_type->fields, object_field);
643         __aco_option_register(object_type->info, regex, ACO_REGEX, object_type->file->types, "", OPT_CUSTOM_T, config_handler, 0, 1, 0);
644
645         return 0;
646 }
647
648 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,
649                                         aco_option_handler config_handler, sorcery_field_handler sorcery_handler, unsigned int flags, unsigned int no_doc, size_t argc, ...)
650 {
651         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
652         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
653         int pos;
654         va_list args;
655
656         if (!strcmp(type, "id") || !object_type || !object_type->type.item_alloc) {
657                 return -1;
658         }
659
660         if (!sorcery_handler) {
661                 sorcery_handler = sorcery_field_default_handler(opt_type);
662         }
663
664         if (!(object_field = ao2_alloc(sizeof(*object_field) + argc * sizeof(object_field->args[0]), NULL))) {
665                 return -1;
666         }
667
668         ast_copy_string(object_field->name, name, sizeof(object_field->name));
669         object_field->handler = sorcery_handler;
670
671         va_start(args, argc);
672         for (pos = 0; pos < argc; pos++) {
673                 object_field->args[pos] = va_arg(args, size_t);
674         }
675         va_end(args);
676
677         ao2_link(object_type->fields, object_field);
678
679         /* TODO: Improve this hack */
680         if (!argc) {
681                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc);
682         } else if (argc == 1) {
683                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
684                                       object_field->args[0]);
685         } else if (argc == 2) {
686                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
687                                       object_field->args[0], object_field->args[1]);
688         } else if (argc == 3) {
689                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
690                                       object_field->args[0], object_field->args[1], object_field->args[2]);
691         } else {
692                 ast_assert(0); /* The hack... she does us no good for this */
693         }
694
695         return 0;
696 }
697
698 static int sorcery_wizard_load(void *obj, void *arg, int flags)
699 {
700         struct ast_sorcery_object_wizard *wizard = obj;
701         struct sorcery_load_details *details = arg;
702         void (*load)(void *data, const struct ast_sorcery *sorcery, const char *type);
703
704         load = !details->reload ? wizard->wizard->load : wizard->wizard->reload;
705
706         if (load) {
707                 load(wizard->data, details->sorcery, details->type);
708         }
709
710         return 0;
711 }
712
713 /*! \brief Destructor for observer invocation */
714 static void sorcery_observer_invocation_destroy(void *obj)
715 {
716         struct sorcery_observer_invocation *invocation = obj;
717
718         ao2_cleanup(invocation->object_type);
719         ao2_cleanup(invocation->object);
720 }
721
722 /*! \brief Allocator function for observer invocation */
723 static struct sorcery_observer_invocation *sorcery_observer_invocation_alloc(struct ast_sorcery_object_type *object_type, void *object)
724 {
725         struct sorcery_observer_invocation *invocation = ao2_alloc(sizeof(*invocation), sorcery_observer_invocation_destroy);
726
727         if (!invocation) {
728                 return NULL;
729         }
730
731         ao2_ref(object_type, +1);
732         invocation->object_type = object_type;
733
734         if (object) {
735                 ao2_ref(object, +1);
736                 invocation->object = object;
737         }
738
739         return invocation;
740 }
741
742 /*! \brief Internal callback function which notifies an individual observer that an object type has been loaded */
743 static int sorcery_observer_notify_loaded(void *obj, void *arg, int flags)
744 {
745         const struct ast_sorcery_object_type_observer *observer = obj;
746
747         if (observer->callbacks->loaded) {
748                 observer->callbacks->loaded(arg);
749         }
750
751         return 0;
752 }
753
754 /*! \brief Internal callback function which notifies observers that an object type has been loaded */
755 static int sorcery_observers_notify_loaded(void *data)
756 {
757         struct sorcery_observer_invocation *invocation = data;
758
759         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_loaded, invocation->object_type->name);
760         ao2_cleanup(invocation);
761
762         return 0;
763 }
764
765 static int sorcery_object_load(void *obj, void *arg, int flags)
766 {
767         struct ast_sorcery_object_type *type = obj;
768         struct sorcery_load_details *details = arg;
769
770         details->type = type->name;
771         ao2_callback(type->wizards, OBJ_NODATA, sorcery_wizard_load, details);
772
773         if (ao2_container_count(type->observers)) {
774                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(type, NULL);
775
776                 if (invocation && ast_taskprocessor_push(type->serializer, sorcery_observers_notify_loaded, invocation)) {
777                         ao2_cleanup(invocation);
778                 }
779         }
780
781         return 0;
782 }
783
784 void ast_sorcery_load(const struct ast_sorcery *sorcery)
785 {
786         struct sorcery_load_details details = {
787                 .sorcery = sorcery,
788                 .reload = 0,
789         };
790
791         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
792 }
793
794 void ast_sorcery_load_object(const struct ast_sorcery *sorcery, const char *type)
795 {
796         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
797         struct sorcery_load_details details = {
798                 .sorcery = sorcery,
799                 .reload = 0,
800         };
801
802         if (!object_type) {
803                 return;
804         }
805
806         sorcery_object_load(object_type, &details, 0);
807 }
808
809 void ast_sorcery_reload(const struct ast_sorcery *sorcery)
810 {
811         struct sorcery_load_details details = {
812                 .sorcery = sorcery,
813                 .reload = 1,
814         };
815
816         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
817 }
818
819 void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *type)
820 {
821         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
822         struct sorcery_load_details details = {
823                 .sorcery = sorcery,
824                 .reload = 1,
825         };
826
827         if (!object_type) {
828                 return;
829         }
830
831         sorcery_object_load(object_type, &details, 0);
832 }
833
834 void ast_sorcery_ref(struct ast_sorcery *sorcery)
835 {
836         ao2_ref(sorcery, +1);
837 }
838
839 struct ast_variable *ast_sorcery_objectset_create(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->object->type, OBJ_KEY), ao2_cleanup);
843         struct ao2_iterator i;
844         struct ast_sorcery_object_field *object_field;
845         struct ast_variable *fields = NULL;
846         int res = 0;
847
848         if (!object_type) {
849                 return NULL;
850         }
851
852         i = ao2_iterator_init(object_type->fields, 0);
853
854         for (; (object_field = ao2_iterator_next(&i)) && !res; ao2_ref(object_field, -1)) {
855                 struct ast_variable *tmp = NULL;
856
857                 if (object_field->multiple_handler) {
858                         if ((res = object_field->multiple_handler(object, &tmp))) {
859                                 ast_variables_destroy(tmp);
860                         }
861                 } else if (object_field->handler) {
862                         char *buf = NULL;
863
864                         if ((res = object_field->handler(object, object_field->args, &buf)) ||
865                                 !(tmp = ast_variable_new(object_field->name, S_OR(buf, ""), ""))) {
866                                 res = -1;
867                         }
868
869                         ast_free(buf);
870                 } else {
871                         continue;
872                 }
873
874                 if (!res && tmp) {
875                         tmp->next = fields;
876                         fields = tmp;
877                 }
878         }
879
880         ao2_iterator_destroy(&i);
881
882         /* If any error occurs we destroy all fields handled before so a partial objectset is not returned */
883         if (res) {
884                 ast_variables_destroy(fields);
885                 fields = NULL;
886         }
887
888         return fields;
889 }
890
891 struct ast_json *ast_sorcery_objectset_json_create(const struct ast_sorcery *sorcery, const void *object)
892 {
893         const struct ast_sorcery_object_details *details = object;
894         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
895         struct ao2_iterator i;
896         struct ast_sorcery_object_field *object_field;
897         struct ast_json *json = ast_json_object_create();
898         int res = 0;
899
900         if (!object_type || !json) {
901                 return NULL;
902         }
903
904         i = ao2_iterator_init(object_type->fields, 0);
905
906         for (; (object_field = ao2_iterator_next(&i)) && !res; ao2_ref(object_field, -1)) {
907                 if (object_field->multiple_handler) {
908                         struct ast_variable *tmp = NULL;
909                         struct ast_variable *field;
910
911                         if ((res = object_field->multiple_handler(object, &tmp))) {
912                                 break;
913                         }
914
915                         for (field = tmp; field; field = field->next) {
916                                 struct ast_json *value = ast_json_string_create(field->value);
917
918                                 if (value && ast_json_object_set(json, field->name, value)) {
919                                         ast_json_unref(value);
920                                         res = -1;
921                                 }
922                         }
923
924                         ast_variables_destroy(tmp);
925                 } else if (object_field->handler) {
926                         char *buf = NULL;
927                         struct ast_json *value = NULL;
928
929                         if ((res = object_field->handler(object, object_field->args, &buf)) ||
930                                 !(value = ast_json_string_create(buf)) ||
931                                 ast_json_object_set(json, object_field->name, value)) {
932                                 ast_json_unref(value);
933                                 res = -1;
934                         }
935
936                         ast_free(buf);
937                 } else {
938                         continue;
939                 }
940         }
941
942         ao2_iterator_destroy(&i);
943
944         /* If any error occurs we destroy the JSON object so a partial objectset is not returned */
945         if (res) {
946                 ast_json_unref(json);
947                 json = NULL;
948         }
949
950         return json;
951 }
952
953 int ast_sorcery_objectset_apply(const struct ast_sorcery *sorcery, void *object, struct ast_variable *objectset)
954 {
955         const struct ast_sorcery_object_details *details = object;
956         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
957         RAII_VAR(struct ast_variable *, transformed, NULL, ast_variables_destroy);
958         struct ast_variable *field;
959         int res = 0;
960
961         if (!object_type) {
962                 return -1;
963         }
964
965         if (object_type->transform && (transformed = object_type->transform(objectset))) {
966                 field = transformed;
967         } else {
968                 field = objectset;
969         }
970
971         for (; field; field = field->next) {
972                 if ((res = aco_process_var(&object_type->type, details->object->id, field, object))) {
973                         break;
974                 }
975         }
976
977         if (!res && object_type->apply) {
978                 res = object_type->apply(sorcery, object);
979         }
980
981         return res;
982 }
983
984 static const struct ast_variable *sorcery_find_field(const struct ast_variable *fields, const char *name)
985 {
986         const struct ast_variable *field;
987
988         /* Search the linked list of fields to find the correct one */
989         for (field = fields; field; field = field->next) {
990                 if (!strcmp(field->name, name)) {
991                         return field;
992                 }
993         }
994
995         return NULL;
996 }
997
998 int ast_sorcery_changeset_create(const struct ast_variable *original, const struct ast_variable *modified, struct ast_variable **changes)
999 {
1000         const struct ast_variable *field;
1001         int res = 0;
1002
1003         *changes = NULL;
1004
1005         /* Unless the ast_variable list changes when examined... it can't differ from itself */
1006         if (original == modified) {
1007                 return 0;
1008         }
1009
1010         for (field = modified; field; field = field->next) {
1011                 const struct ast_variable *old = sorcery_find_field(original, field->name);
1012
1013                 if (!old || strcmp(old->value, field->value)) {
1014                         struct ast_variable *tmp;
1015
1016                         if (!(tmp = ast_variable_new(field->name, field->value, ""))) {
1017                                 res = -1;
1018                                 break;
1019                         }
1020
1021                         tmp->next = *changes;
1022                         *changes = tmp;
1023                 }
1024         }
1025
1026         /* If an error occurred do not return a partial changeset */
1027         if (res) {
1028                 ast_variables_destroy(*changes);
1029                 *changes = NULL;
1030         }
1031
1032         return res;
1033 }
1034
1035 static void sorcery_object_destructor(void *object)
1036 {
1037         struct ast_sorcery_object_details *details = object;
1038
1039         if (details->object->destructor) {
1040                 details->object->destructor(object);
1041         }
1042
1043         ast_variables_destroy(details->object->extended);
1044 }
1045
1046 void *ast_sorcery_generic_alloc(size_t size, ao2_destructor_fn destructor)
1047 {
1048         void *object = ao2_alloc_options(size + sizeof(struct ast_sorcery_object), sorcery_object_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
1049         struct ast_sorcery_object_details *details = object;
1050
1051         if (!object) {
1052                 return NULL;
1053         }
1054
1055         details->object = object + size;
1056         details->object->destructor = destructor;
1057
1058         return object;
1059 }
1060
1061 void *ast_sorcery_alloc(const struct ast_sorcery *sorcery, const char *type, const char *id)
1062 {
1063         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1064         struct ast_sorcery_object_details *details;
1065
1066         if (!object_type || !object_type->type.item_alloc ||
1067             !(details = object_type->type.item_alloc(id))) {
1068                 return NULL;
1069         }
1070
1071         if (ast_strlen_zero(id)) {
1072                 ast_uuid_generate_str(details->object->id, sizeof(details->object->id));
1073         } else {
1074                 ast_copy_string(details->object->id, id, sizeof(details->object->id));
1075         }
1076
1077         ast_copy_string(details->object->type, type, sizeof(details->object->type));
1078
1079         if (aco_set_defaults(&object_type->type, id, details)) {
1080                 ao2_ref(details, -1);
1081                 return NULL;
1082         }
1083
1084         return details;
1085 }
1086
1087 void *ast_sorcery_copy(const struct ast_sorcery *sorcery, const void *object)
1088 {
1089         const struct ast_sorcery_object_details *details = object;
1090         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1091         struct ast_sorcery_object_details *copy = ast_sorcery_alloc(sorcery, details->object->type, details->object->id);
1092         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
1093         int res = 0;
1094
1095         if (!copy) {
1096                 return NULL;
1097         } else if (object_type->copy) {
1098                 res = object_type->copy(object, copy);
1099         } else if ((objectset = ast_sorcery_objectset_create(sorcery, object))) {
1100                 res = ast_sorcery_objectset_apply(sorcery, copy, objectset);
1101         } else {
1102                 /* No native copy available and could not create an objectset, this copy has failed */
1103                 res = -1;
1104         }
1105
1106         if (res) {
1107                 ao2_cleanup(copy);
1108                 copy = NULL;
1109         }
1110
1111         return copy;
1112 }
1113
1114 int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes)
1115 {
1116         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, ast_sorcery_object_get_type(original), OBJ_KEY), ao2_cleanup);
1117
1118         *changes = NULL;
1119
1120         if (strcmp(ast_sorcery_object_get_type(original), ast_sorcery_object_get_type(modified))) {
1121                 return -1;
1122         }
1123
1124         if (original == modified) {
1125                 return 0;
1126         } else if (!object_type->diff) {
1127                 RAII_VAR(struct ast_variable *, objectset1, NULL, ast_variables_destroy);
1128                 RAII_VAR(struct ast_variable *, objectset2, NULL, ast_variables_destroy);
1129
1130                 objectset1 = ast_sorcery_objectset_create(sorcery, original);
1131                 objectset2 = ast_sorcery_objectset_create(sorcery, modified);
1132
1133                 return ast_sorcery_changeset_create(objectset1, objectset2, changes);
1134         } else {
1135                 return object_type->diff(original, modified, changes);
1136         }
1137 }
1138
1139 /*! \brief Structure used when calling create, update, or delete */
1140 struct sorcery_details {
1141         /*! \brief Pointer to the sorcery instance */
1142         const struct ast_sorcery *sorcery;
1143         /*! \brief Pointer to the object itself */
1144         void *obj;
1145 };
1146
1147 /*! \brief Internal function used to create an object in caching wizards */
1148 static int sorcery_cache_create(void *obj, void *arg, int flags)
1149 {
1150         const struct ast_sorcery_object_wizard *object_wizard = obj;
1151         const struct sorcery_details *details = arg;
1152
1153         if (!object_wizard->caching || !object_wizard->wizard->create) {
1154                 return 0;
1155         }
1156
1157         object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj);
1158
1159         return 0;
1160 }
1161
1162 void *ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
1163 {
1164         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1165         void *object = NULL;
1166         struct ao2_iterator i;
1167         struct ast_sorcery_object_wizard *wizard;
1168         unsigned int cached = 0;
1169
1170         if (!object_type || ast_strlen_zero(id)) {
1171                 return NULL;
1172         }
1173
1174         i = ao2_iterator_init(object_type->wizards, 0);
1175         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1176                 if (wizard->wizard->retrieve_id &&
1177                     !(object = wizard->wizard->retrieve_id(sorcery, wizard->data, object_type->name, id))) {
1178                         continue;
1179                 }
1180
1181                 cached = wizard->caching;
1182
1183                 ao2_ref(wizard, -1);
1184                 break;
1185         }
1186         ao2_iterator_destroy(&i);
1187
1188         if (!cached && object) {
1189                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1190         }
1191
1192         return object;
1193 }
1194
1195 void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields)
1196 {
1197         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1198         void *object = NULL;
1199         struct ao2_iterator i;
1200         struct ast_sorcery_object_wizard *wizard;
1201         unsigned int cached = 0;
1202
1203         if (!object_type) {
1204                 return NULL;
1205         }
1206
1207         /* If returning multiple objects create a container to store them in */
1208         if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1209                 if (!(object = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1210                         return NULL;
1211                 }
1212         }
1213
1214         /* Inquire with the available wizards for retrieval */
1215         i = ao2_iterator_init(object_type->wizards, 0);
1216         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1217                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1218                         if (wizard->wizard->retrieve_multiple) {
1219                                 wizard->wizard->retrieve_multiple(sorcery, wizard->data, object_type->name, object, fields);
1220                         }
1221                 } else if (fields && wizard->wizard->retrieve_fields) {
1222                         if (wizard->wizard->retrieve_fields) {
1223                                 object = wizard->wizard->retrieve_fields(sorcery, wizard->data, object_type->name, fields);
1224                         }
1225                 }
1226
1227                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE) || !object) {
1228                         continue;
1229                 }
1230
1231                 cached = wizard->caching;
1232
1233                 ao2_ref(wizard, -1);
1234                 break;
1235         }
1236         ao2_iterator_destroy(&i);
1237
1238         /* If we are returning a single object and it came from a non-cache source create it in any caches */
1239         if (!(flags & AST_RETRIEVE_FLAG_MULTIPLE) && !cached && object) {
1240                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1241         }
1242
1243         return object;
1244 }
1245
1246 struct ao2_container *ast_sorcery_retrieve_by_regex(const struct ast_sorcery *sorcery, const char *type, const char *regex)
1247 {
1248         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1249         struct ao2_container *objects;
1250         struct ao2_iterator i;
1251         struct ast_sorcery_object_wizard *wizard;
1252
1253         if (!object_type || !(objects = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1254                 return NULL;
1255         }
1256
1257         i = ao2_iterator_init(object_type->wizards, 0);
1258         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1259                 if (!wizard->wizard->retrieve_regex) {
1260                         continue;
1261                 }
1262
1263                 wizard->wizard->retrieve_regex(sorcery, wizard->data, object_type->name, objects, regex);
1264         }
1265         ao2_iterator_destroy(&i);
1266
1267         return objects;
1268 }
1269
1270 /*! \brief Internal function which returns if the wizard has created the object */
1271 static int sorcery_wizard_create(void *obj, void *arg, int flags)
1272 {
1273         const struct ast_sorcery_object_wizard *object_wizard = obj;
1274         const struct sorcery_details *details = arg;
1275
1276         return (!object_wizard->caching && !object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj)) ? CMP_MATCH | CMP_STOP : 0;
1277 }
1278
1279 /*! \brief Internal callback function which notifies an individual observer that an object has been created */
1280 static int sorcery_observer_notify_create(void *obj, void *arg, int flags)
1281 {
1282         const struct ast_sorcery_object_type_observer *observer = obj;
1283
1284         if (observer->callbacks->created) {
1285                 observer->callbacks->created(arg);
1286         }
1287
1288         return 0;
1289 }
1290
1291 /*! \brief Internal callback function which notifies observers that an object has been created */
1292 static int sorcery_observers_notify_create(void *data)
1293 {
1294         struct sorcery_observer_invocation *invocation = data;
1295
1296         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_create, invocation->object);
1297         ao2_cleanup(invocation);
1298
1299         return 0;
1300 }
1301
1302 int ast_sorcery_create(const struct ast_sorcery *sorcery, void *object)
1303 {
1304         const struct ast_sorcery_object_details *details = object;
1305         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1306         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1307         struct sorcery_details sdetails = {
1308                 .sorcery = sorcery,
1309                 .obj = object,
1310         };
1311
1312         if (!object_type) {
1313                 return -1;
1314         }
1315
1316         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_create, &sdetails)) &&
1317                 ao2_container_count(object_type->observers)) {
1318                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1319
1320                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_create, invocation)) {
1321                         ao2_cleanup(invocation);
1322                 }
1323         }
1324
1325         return object_wizard ? 0 : -1;
1326 }
1327
1328 /*! \brief Internal callback function which notifies an individual observer that an object has been updated */
1329 static int sorcery_observer_notify_update(void *obj, void *arg, int flags)
1330 {
1331         const struct ast_sorcery_object_type_observer *observer = obj;
1332
1333         if (observer->callbacks->updated) {
1334                 observer->callbacks->updated(arg);
1335         }
1336
1337         return 0;
1338 }
1339
1340 /*! \brief Internal callback function which notifies observers that an object has been updated */
1341 static int sorcery_observers_notify_update(void *data)
1342 {
1343         struct sorcery_observer_invocation *invocation = data;
1344
1345         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_update, invocation->object);
1346         ao2_cleanup(invocation);
1347
1348         return 0;
1349 }
1350
1351 /*! \brief Internal function which returns if a wizard has updated the object */
1352 static int sorcery_wizard_update(void *obj, void *arg, int flags)
1353 {
1354         const struct ast_sorcery_object_wizard *object_wizard = obj;
1355         const struct sorcery_details *details = arg;
1356
1357         return (object_wizard->wizard->update && !object_wizard->wizard->update(details->sorcery, object_wizard->data, details->obj) &&
1358                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1359 }
1360
1361 int ast_sorcery_update(const struct ast_sorcery *sorcery, void *object)
1362 {
1363         const struct ast_sorcery_object_details *details = object;
1364         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1365         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1366         struct sorcery_details sdetails = {
1367                 .sorcery = sorcery,
1368                 .obj = object,
1369         };
1370
1371         if (!object_type) {
1372                 return -1;
1373         }
1374
1375         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_update, &sdetails)) &&
1376                 ao2_container_count(object_type->observers)) {
1377                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1378
1379                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_update, invocation)) {
1380                         ao2_cleanup(invocation);
1381                 }
1382         }
1383
1384         return object_wizard ? 0 : -1;
1385 }
1386
1387 /*! \brief Internal callback function which notifies an individual observer that an object has been deleted */
1388 static int sorcery_observer_notify_delete(void *obj, void *arg, int flags)
1389 {
1390         const struct ast_sorcery_object_type_observer *observer = obj;
1391
1392         if (observer->callbacks->deleted) {
1393                 observer->callbacks->deleted(arg);
1394         }
1395
1396         return 0;
1397 }
1398
1399 /*! \brief Internal callback function which notifies observers that an object has been deleted */
1400 static int sorcery_observers_notify_delete(void *data)
1401 {
1402         struct sorcery_observer_invocation *invocation = data;
1403
1404         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_delete, invocation->object);
1405         ao2_cleanup(invocation);
1406
1407         return 0;
1408 }
1409
1410 /*! \brief Internal function which returns if a wizard has deleted the object */
1411 static int sorcery_wizard_delete(void *obj, void *arg, int flags)
1412 {
1413         const struct ast_sorcery_object_wizard *object_wizard = obj;
1414         const struct sorcery_details *details = arg;
1415
1416         return (object_wizard->wizard->delete && !object_wizard->wizard->delete(details->sorcery, object_wizard->data, details->obj) &&
1417                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1418 }
1419
1420 int ast_sorcery_delete(const struct ast_sorcery *sorcery, void *object)
1421 {
1422         const struct ast_sorcery_object_details *details = object;
1423         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1424         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1425         struct sorcery_details sdetails = {
1426                 .sorcery = sorcery,
1427                 .obj = object,
1428         };
1429
1430         if (!object_type) {
1431                 return -1;
1432         }
1433
1434         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_delete, &sdetails)) &&
1435                 ao2_container_count(object_type->observers)) {
1436                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1437
1438                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_delete, invocation)) {
1439                         ao2_cleanup(invocation);
1440                 }
1441         }
1442
1443         return object_wizard ? 0 : -1;
1444 }
1445
1446 void ast_sorcery_unref(struct ast_sorcery *sorcery)
1447 {
1448         ao2_cleanup(sorcery);
1449 }
1450
1451 const char *ast_sorcery_object_get_id(const void *object)
1452 {
1453         const struct ast_sorcery_object_details *details = object;
1454         return details->object->id;
1455 }
1456
1457 const char *ast_sorcery_object_get_type(const void *object)
1458 {
1459         const struct ast_sorcery_object_details *details = object;
1460         return details->object->type;
1461 }
1462
1463 const char *ast_sorcery_object_get_extended(const void *object, const char *name)
1464 {
1465         const struct ast_sorcery_object_details *details = object;
1466         struct ast_variable *field;
1467
1468         for (field = details->object->extended; field; field = field->next) {
1469                 if (!strcmp(field->name + 1, name)) {
1470                         return field->value;
1471                 }
1472         }
1473
1474         return NULL;
1475 }
1476
1477 int ast_sorcery_object_set_extended(const void *object, const char *name, const char *value)
1478 {
1479         RAII_VAR(struct ast_variable *, field, NULL, ast_variables_destroy);
1480         struct ast_variable *extended = ast_variable_new(name, value, ""), *previous = NULL;
1481         const struct ast_sorcery_object_details *details = object;
1482
1483         if (!extended) {
1484                 return -1;
1485         }
1486
1487         for (field = details->object->extended; field; previous = field, field = field->next) {
1488                 if (!strcmp(field->name, name)) {
1489                         if (previous) {
1490                                 previous->next = field->next;
1491                         } else {
1492                                 details->object->extended = field->next;
1493                         }
1494                         field->next = NULL;
1495                         break;
1496                 }
1497         }
1498
1499         extended->next = details->object->extended;
1500         details->object->extended = extended;
1501
1502         return 0;
1503 }
1504
1505 int ast_sorcery_observer_add(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
1506 {
1507         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1508         struct ast_sorcery_object_type_observer *observer;
1509
1510         if (!object_type || !callbacks) {
1511                 return -1;
1512         }
1513
1514         if (!(observer = ao2_alloc(sizeof(*observer), NULL))) {
1515                 return -1;
1516         }
1517
1518         observer->callbacks = callbacks;
1519         ao2_link(object_type->observers, observer);
1520         ao2_ref(observer, -1);
1521
1522         return 0;
1523 }
1524
1525 /*! \brief Internal callback function for removing an observer */
1526 static int sorcery_observer_remove(void *obj, void *arg, int flags)
1527 {
1528         const struct ast_sorcery_object_type_observer *observer = obj;
1529
1530         return (observer->callbacks == arg) ? CMP_MATCH | CMP_STOP : 0;
1531 }
1532
1533 void ast_sorcery_observer_remove(const struct ast_sorcery *sorcery, const char *type, struct ast_sorcery_observer *callbacks)
1534 {
1535         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1536
1537         if (!object_type) {
1538                 return;
1539         }
1540
1541         ao2_callback(object_type->observers, OBJ_NODATA | OBJ_UNLINK, sorcery_observer_remove, callbacks);
1542 }