4c60d1da14e7f86c89579493b98b1027f167ddb2
[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, 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
591         object_type->transform = transform;
592         object_type->apply = apply;
593         object_type->file->types[0] = &object_type->type;
594         object_type->file->types[1] = NULL;
595
596         if (aco_info_init(object_type->info)) {
597                 return -1;
598         }
599
600         if (ast_sorcery_object_fields_register(sorcery, type, "^@", sorcery_extended_config_handler, sorcery_extended_fields_handler)) {
601                 return -1;
602         }
603
604         return 0;
605 }
606
607 void ast_sorcery_object_set_copy_handler(struct ast_sorcery *sorcery, const char *type, sorcery_copy_handler copy)
608 {
609         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
610
611         if (!object_type) {
612                 return;
613         }
614
615         object_type->copy = copy;
616 }
617
618 void ast_sorcery_object_set_diff_handler(struct ast_sorcery *sorcery, const char *type, sorcery_diff_handler diff)
619 {
620         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
621
622         if (!object_type) {
623                 return;
624         }
625
626         object_type->diff = diff;
627 }
628
629 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)
630 {
631         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
632         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
633
634         if (!object_type || !object_type->type.item_alloc || !config_handler || !(object_field = ao2_alloc(sizeof(*object_field), NULL))) {
635                 return -1;
636         }
637
638         ast_copy_string(object_field->name, regex, sizeof(object_field->name));
639         object_field->multiple_handler = sorcery_handler;
640
641         ao2_link(object_type->fields, object_field);
642         __aco_option_register(object_type->info, regex, ACO_REGEX, object_type->file->types, "", OPT_CUSTOM_T, config_handler, 0, 0);
643
644         return 0;
645 }
646
647 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,
648                                         aco_option_handler config_handler, sorcery_field_handler sorcery_handler, unsigned int flags, size_t argc, ...)
649 {
650         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
651         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
652         int pos;
653         va_list args;
654
655         if (!strcmp(type, "id") || !object_type || !object_type->type.item_alloc) {
656                 return -1;
657         }
658
659         if (!sorcery_handler) {
660                 sorcery_handler = sorcery_field_default_handler(opt_type);
661         }
662
663         if (!(object_field = ao2_alloc(sizeof(*object_field) + argc * sizeof(object_field->args[0]), NULL))) {
664                 return -1;
665         }
666
667         ast_copy_string(object_field->name, name, sizeof(object_field->name));
668         object_field->handler = sorcery_handler;
669
670         va_start(args, argc);
671         for (pos = 0; pos < argc; pos++) {
672                 object_field->args[pos] = va_arg(args, size_t);
673         }
674         va_end(args);
675
676         ao2_link(object_type->fields, object_field);
677
678         /* TODO: Improve this hack */
679         if (!argc) {
680                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc);
681         } else if (argc == 1) {
682                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
683                                       object_field->args[0]);
684         } else if (argc == 2) {
685                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
686                                       object_field->args[0], object_field->args[1]);
687         } else if (argc == 3) {
688                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, argc,
689                                       object_field->args[0], object_field->args[1], object_field->args[2]);
690         } else {
691                 ast_assert(0); /* The hack... she does us no good for this */
692         }
693
694         return 0;
695 }
696
697 static int sorcery_wizard_load(void *obj, void *arg, int flags)
698 {
699         struct ast_sorcery_object_wizard *wizard = obj;
700         struct sorcery_load_details *details = arg;
701         void (*load)(void *data, const struct ast_sorcery *sorcery, const char *type);
702
703         load = !details->reload ? wizard->wizard->load : wizard->wizard->reload;
704
705         if (load) {
706                 load(wizard->data, details->sorcery, details->type);
707         }
708
709         return 0;
710 }
711
712 /*! \brief Destructor for observer invocation */
713 static void sorcery_observer_invocation_destroy(void *obj)
714 {
715         struct sorcery_observer_invocation *invocation = obj;
716
717         ao2_cleanup(invocation->object_type);
718         ao2_cleanup(invocation->object);
719 }
720
721 /*! \brief Allocator function for observer invocation */
722 static struct sorcery_observer_invocation *sorcery_observer_invocation_alloc(struct ast_sorcery_object_type *object_type, void *object)
723 {
724         struct sorcery_observer_invocation *invocation = ao2_alloc(sizeof(*invocation), sorcery_observer_invocation_destroy);
725
726         if (!invocation) {
727                 return NULL;
728         }
729
730         ao2_ref(object_type, +1);
731         invocation->object_type = object_type;
732
733         if (object) {
734                 ao2_ref(object, +1);
735                 invocation->object = object;
736         }
737
738         return invocation;
739 }
740
741 /*! \brief Internal callback function which notifies an individual observer that an object type has been loaded */
742 static int sorcery_observer_notify_loaded(void *obj, void *arg, int flags)
743 {
744         const struct ast_sorcery_object_type_observer *observer = obj;
745
746         if (observer->callbacks->loaded) {
747                 observer->callbacks->loaded(arg);
748         }
749
750         return 0;
751 }
752
753 /*! \brief Internal callback function which notifies observers that an object type has been loaded */
754 static int sorcery_observers_notify_loaded(void *data)
755 {
756         struct sorcery_observer_invocation *invocation = data;
757
758         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_loaded, invocation->object_type->name);
759         ao2_cleanup(invocation);
760
761         return 0;
762 }
763
764 static int sorcery_object_load(void *obj, void *arg, int flags)
765 {
766         struct ast_sorcery_object_type *type = obj;
767         struct sorcery_load_details *details = arg;
768
769         details->type = type->name;
770         ao2_callback(type->wizards, OBJ_NODATA, sorcery_wizard_load, details);
771
772         if (ao2_container_count(type->observers)) {
773                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(type, NULL);
774
775                 if (invocation && ast_taskprocessor_push(type->serializer, sorcery_observers_notify_loaded, invocation)) {
776                         ao2_cleanup(invocation);
777                 }
778         }
779
780         return 0;
781 }
782
783 void ast_sorcery_load(const struct ast_sorcery *sorcery)
784 {
785         struct sorcery_load_details details = {
786                 .sorcery = sorcery,
787                 .reload = 0,
788         };
789
790         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
791 }
792
793 void ast_sorcery_load_object(const struct ast_sorcery *sorcery, const char *type)
794 {
795         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
796         struct sorcery_load_details details = {
797                 .sorcery = sorcery,
798                 .reload = 0,
799         };
800
801         if (!object_type) {
802                 return;
803         }
804
805         sorcery_object_load(object_type, &details, 0);
806 }
807
808 void ast_sorcery_reload(const struct ast_sorcery *sorcery)
809 {
810         struct sorcery_load_details details = {
811                 .sorcery = sorcery,
812                 .reload = 1,
813         };
814
815         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
816 }
817
818 void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *type)
819 {
820         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
821         struct sorcery_load_details details = {
822                 .sorcery = sorcery,
823                 .reload = 1,
824         };
825
826         if (!object_type) {
827                 return;
828         }
829
830         sorcery_object_load(object_type, &details, 0);
831 }
832
833 void ast_sorcery_ref(struct ast_sorcery *sorcery)
834 {
835         ao2_ref(sorcery, +1);
836 }
837
838 struct ast_variable *ast_sorcery_objectset_create(const struct ast_sorcery *sorcery, const void *object)
839 {
840         const struct ast_sorcery_object_details *details = object;
841         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
842         struct ao2_iterator i;
843         struct ast_sorcery_object_field *object_field;
844         struct ast_variable *fields = NULL;
845         int res = 0;
846
847         if (!object_type) {
848                 return NULL;
849         }
850
851         i = ao2_iterator_init(object_type->fields, 0);
852
853         for (; (object_field = ao2_iterator_next(&i)) && !res; ao2_ref(object_field, -1)) {
854                 struct ast_variable *tmp = NULL;
855
856                 if (object_field->multiple_handler) {
857                         if ((res = object_field->multiple_handler(object, &tmp))) {
858                                 ast_variables_destroy(tmp);
859                         }
860                 } else if (object_field->handler) {
861                         char *buf = NULL;
862
863                         if ((res = object_field->handler(object, object_field->args, &buf)) ||
864                                 !(tmp = ast_variable_new(object_field->name, S_OR(buf, ""), ""))) {
865                                 res = -1;
866                         }
867
868                         ast_free(buf);
869                 } else {
870                         continue;
871                 }
872
873                 if (!res && tmp) {
874                         tmp->next = fields;
875                         fields = tmp;
876                 }
877         }
878
879         ao2_iterator_destroy(&i);
880
881         /* If any error occurs we destroy all fields handled before so a partial objectset is not returned */
882         if (res) {
883                 ast_variables_destroy(fields);
884                 fields = NULL;
885         }
886
887         return fields;
888 }
889
890 struct ast_json *ast_sorcery_objectset_json_create(const struct ast_sorcery *sorcery, const void *object)
891 {
892         const struct ast_sorcery_object_details *details = object;
893         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
894         struct ao2_iterator i;
895         struct ast_sorcery_object_field *object_field;
896         struct ast_json *json = ast_json_object_create();
897         int res = 0;
898
899         if (!object_type || !json) {
900                 return NULL;
901         }
902
903         i = ao2_iterator_init(object_type->fields, 0);
904
905         for (; (object_field = ao2_iterator_next(&i)) && !res; ao2_ref(object_field, -1)) {
906                 if (object_field->multiple_handler) {
907                         struct ast_variable *tmp = NULL;
908                         struct ast_variable *field;
909
910                         if ((res = object_field->multiple_handler(object, &tmp))) {
911                                 break;
912                         }
913
914                         for (field = tmp; field; field = field->next) {
915                                 struct ast_json *value = ast_json_string_create(field->value);
916
917                                 if (value && ast_json_object_set(json, field->name, value)) {
918                                         ast_json_unref(value);
919                                         res = -1;
920                                 }
921                         }
922
923                         ast_variables_destroy(tmp);
924                 } else if (object_field->handler) {
925                         char *buf = NULL;
926                         struct ast_json *value = NULL;
927
928                         if ((res = object_field->handler(object, object_field->args, &buf)) ||
929                                 !(value = ast_json_string_create(buf)) ||
930                                 ast_json_object_set(json, object_field->name, value)) {
931                                 ast_json_unref(value);
932                                 res = -1;
933                         }
934
935                         ast_free(buf);
936                 } else {
937                         continue;
938                 }
939         }
940
941         ao2_iterator_destroy(&i);
942
943         /* If any error occurs we destroy the JSON object so a partial objectset is not returned */
944         if (res) {
945                 ast_json_unref(json);
946                 json = NULL;
947         }
948
949         return json;
950 }
951
952 int ast_sorcery_objectset_apply(const struct ast_sorcery *sorcery, void *object, struct ast_variable *objectset)
953 {
954         const struct ast_sorcery_object_details *details = object;
955         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
956         RAII_VAR(struct ast_variable *, transformed, NULL, ast_variables_destroy);
957         struct ast_variable *field;
958         int res = 0;
959
960         if (!object_type) {
961                 return -1;
962         }
963
964         if (object_type->transform && (transformed = object_type->transform(objectset))) {
965                 field = transformed;
966         } else {
967                 field = objectset;
968         }
969
970         for (; field; field = field->next) {
971                 if ((res = aco_process_var(&object_type->type, details->object->id, field, object))) {
972                         break;
973                 }
974         }
975
976         if (!res && object_type->apply) {
977                 res = object_type->apply(sorcery, object);
978         }
979
980         return res;
981 }
982
983 static const struct ast_variable *sorcery_find_field(const struct ast_variable *fields, const char *name)
984 {
985         const struct ast_variable *field;
986
987         /* Search the linked list of fields to find the correct one */
988         for (field = fields; field; field = field->next) {
989                 if (!strcmp(field->name, name)) {
990                         return field;
991                 }
992         }
993
994         return NULL;
995 }
996
997 int ast_sorcery_changeset_create(const struct ast_variable *original, const struct ast_variable *modified, struct ast_variable **changes)
998 {
999         const struct ast_variable *field;
1000         int res = 0;
1001
1002         *changes = NULL;
1003
1004         /* Unless the ast_variable list changes when examined... it can't differ from itself */
1005         if (original == modified) {
1006                 return 0;
1007         }
1008
1009         for (field = modified; field; field = field->next) {
1010                 const struct ast_variable *old = sorcery_find_field(original, field->name);
1011
1012                 if (!old || strcmp(old->value, field->value)) {
1013                         struct ast_variable *tmp;
1014
1015                         if (!(tmp = ast_variable_new(field->name, field->value, ""))) {
1016                                 res = -1;
1017                                 break;
1018                         }
1019
1020                         tmp->next = *changes;
1021                         *changes = tmp;
1022                 }
1023         }
1024
1025         /* If an error occurred do not return a partial changeset */
1026         if (res) {
1027                 ast_variables_destroy(*changes);
1028                 *changes = NULL;
1029         }
1030
1031         return res;
1032 }
1033
1034 static void sorcery_object_destructor(void *object)
1035 {
1036         struct ast_sorcery_object_details *details = object;
1037
1038         if (details->object->destructor) {
1039                 details->object->destructor(object);
1040         }
1041
1042         ast_variables_destroy(details->object->extended);
1043 }
1044
1045 void *ast_sorcery_generic_alloc(size_t size, ao2_destructor_fn destructor)
1046 {
1047         void *object = ao2_alloc_options(size + sizeof(struct ast_sorcery_object), sorcery_object_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
1048         struct ast_sorcery_object_details *details = object;
1049
1050         if (!object) {
1051                 return NULL;
1052         }
1053
1054         details->object = object + size;
1055         details->object->destructor = destructor;
1056
1057         return object;
1058 }
1059
1060 void *ast_sorcery_alloc(const struct ast_sorcery *sorcery, const char *type, const char *id)
1061 {
1062         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1063         struct ast_sorcery_object_details *details;
1064
1065         if (!object_type || !object_type->type.item_alloc ||
1066             !(details = object_type->type.item_alloc(id))) {
1067                 return NULL;
1068         }
1069
1070         if (ast_strlen_zero(id)) {
1071                 ast_uuid_generate_str(details->object->id, sizeof(details->object->id));
1072         } else {
1073                 ast_copy_string(details->object->id, id, sizeof(details->object->id));
1074         }
1075
1076         ast_copy_string(details->object->type, type, sizeof(details->object->type));
1077
1078         if (aco_set_defaults(&object_type->type, id, details)) {
1079                 ao2_ref(details, -1);
1080                 return NULL;
1081         }
1082
1083         return details;
1084 }
1085
1086 void *ast_sorcery_copy(const struct ast_sorcery *sorcery, const void *object)
1087 {
1088         const struct ast_sorcery_object_details *details = object;
1089         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1090         struct ast_sorcery_object_details *copy = ast_sorcery_alloc(sorcery, details->object->type, details->object->id);
1091         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
1092         int res = 0;
1093
1094         if (!copy) {
1095                 return NULL;
1096         } else if (object_type->copy) {
1097                 res = object_type->copy(object, copy);
1098         } else if ((objectset = ast_sorcery_objectset_create(sorcery, object))) {
1099                 res = ast_sorcery_objectset_apply(sorcery, copy, objectset);
1100         } else {
1101                 /* No native copy available and could not create an objectset, this copy has failed */
1102                 res = -1;
1103         }
1104
1105         if (res) {
1106                 ao2_cleanup(copy);
1107                 copy = NULL;
1108         }
1109
1110         return copy;
1111 }
1112
1113 int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes)
1114 {
1115         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, ast_sorcery_object_get_type(original), OBJ_KEY), ao2_cleanup);
1116
1117         *changes = NULL;
1118
1119         if (strcmp(ast_sorcery_object_get_type(original), ast_sorcery_object_get_type(modified))) {
1120                 return -1;
1121         }
1122
1123         if (original == modified) {
1124                 return 0;
1125         } else if (!object_type->diff) {
1126                 RAII_VAR(struct ast_variable *, objectset1, NULL, ast_variables_destroy);
1127                 RAII_VAR(struct ast_variable *, objectset2, NULL, ast_variables_destroy);
1128
1129                 objectset1 = ast_sorcery_objectset_create(sorcery, original);
1130                 objectset2 = ast_sorcery_objectset_create(sorcery, modified);
1131
1132                 return ast_sorcery_changeset_create(objectset1, objectset2, changes);
1133         } else {
1134                 return object_type->diff(original, modified, changes);
1135         }
1136 }
1137
1138 /*! \brief Structure used when calling create, update, or delete */
1139 struct sorcery_details {
1140         /*! \brief Pointer to the sorcery instance */
1141         const struct ast_sorcery *sorcery;
1142         /*! \brief Pointer to the object itself */
1143         void *obj;
1144 };
1145
1146 /*! \brief Internal function used to create an object in caching wizards */
1147 static int sorcery_cache_create(void *obj, void *arg, int flags)
1148 {
1149         const struct ast_sorcery_object_wizard *object_wizard = obj;
1150         const struct sorcery_details *details = arg;
1151
1152         if (!object_wizard->caching || !object_wizard->wizard->create) {
1153                 return 0;
1154         }
1155
1156         object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj);
1157
1158         return 0;
1159 }
1160
1161 void *ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
1162 {
1163         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1164         void *object = NULL;
1165         struct ao2_iterator i;
1166         struct ast_sorcery_object_wizard *wizard;
1167         unsigned int cached = 0;
1168
1169         if (!object_type || ast_strlen_zero(id)) {
1170                 return NULL;
1171         }
1172
1173         i = ao2_iterator_init(object_type->wizards, 0);
1174         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1175                 if (wizard->wizard->retrieve_id &&
1176                     !(object = wizard->wizard->retrieve_id(sorcery, wizard->data, object_type->name, id))) {
1177                         continue;
1178                 }
1179
1180                 cached = wizard->caching;
1181
1182                 ao2_ref(wizard, -1);
1183                 break;
1184         }
1185         ao2_iterator_destroy(&i);
1186
1187         if (!cached && object) {
1188                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1189         }
1190
1191         return object;
1192 }
1193
1194 void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields)
1195 {
1196         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1197         void *object = NULL;
1198         struct ao2_iterator i;
1199         struct ast_sorcery_object_wizard *wizard;
1200         unsigned int cached = 0;
1201
1202         if (!object_type) {
1203                 return NULL;
1204         }
1205
1206         /* If returning multiple objects create a container to store them in */
1207         if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1208                 if (!(object = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1209                         return NULL;
1210                 }
1211         }
1212
1213         /* Inquire with the available wizards for retrieval */
1214         i = ao2_iterator_init(object_type->wizards, 0);
1215         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1216                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1217                         if (wizard->wizard->retrieve_multiple) {
1218                                 wizard->wizard->retrieve_multiple(sorcery, wizard->data, object_type->name, object, fields);
1219                         }
1220                 } else if (fields && wizard->wizard->retrieve_fields) {
1221                         if (wizard->wizard->retrieve_fields) {
1222                                 object = wizard->wizard->retrieve_fields(sorcery, wizard->data, object_type->name, fields);
1223                         }
1224                 }
1225
1226                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE) || !object) {
1227                         continue;
1228                 }
1229
1230                 cached = wizard->caching;
1231
1232                 ao2_ref(wizard, -1);
1233                 break;
1234         }
1235         ao2_iterator_destroy(&i);
1236
1237         /* If we are returning a single object and it came from a non-cache source create it in any caches */
1238         if (!(flags & AST_RETRIEVE_FLAG_MULTIPLE) && !cached && object) {
1239                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1240         }
1241
1242         return object;
1243 }
1244
1245 struct ao2_container *ast_sorcery_retrieve_by_regex(const struct ast_sorcery *sorcery, const char *type, const char *regex)
1246 {
1247         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1248         struct ao2_container *objects;
1249         struct ao2_iterator i;
1250         struct ast_sorcery_object_wizard *wizard;
1251
1252         if (!object_type || !(objects = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1253                 return NULL;
1254         }
1255
1256         i = ao2_iterator_init(object_type->wizards, 0);
1257         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1258                 if (!wizard->wizard->retrieve_regex) {
1259                         continue;
1260                 }
1261
1262                 wizard->wizard->retrieve_regex(sorcery, wizard->data, object_type->name, objects, regex);
1263         }
1264         ao2_iterator_destroy(&i);
1265
1266         return objects;
1267 }
1268
1269 /*! \brief Internal function which returns if the wizard has created the object */
1270 static int sorcery_wizard_create(void *obj, void *arg, int flags)
1271 {
1272         const struct ast_sorcery_object_wizard *object_wizard = obj;
1273         const struct sorcery_details *details = arg;
1274
1275         return (!object_wizard->caching && !object_wizard->wizard->create(details->sorcery, object_wizard->data, details->obj)) ? CMP_MATCH | CMP_STOP : 0;
1276 }
1277
1278 /*! \brief Internal callback function which notifies an individual observer that an object has been created */
1279 static int sorcery_observer_notify_create(void *obj, void *arg, int flags)
1280 {
1281         const struct ast_sorcery_object_type_observer *observer = obj;
1282
1283         if (observer->callbacks->created) {
1284                 observer->callbacks->created(arg);
1285         }
1286
1287         return 0;
1288 }
1289
1290 /*! \brief Internal callback function which notifies observers that an object has been created */
1291 static int sorcery_observers_notify_create(void *data)
1292 {
1293         struct sorcery_observer_invocation *invocation = data;
1294
1295         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_create, invocation->object);
1296         ao2_cleanup(invocation);
1297
1298         return 0;
1299 }
1300
1301 int ast_sorcery_create(const struct ast_sorcery *sorcery, void *object)
1302 {
1303         const struct ast_sorcery_object_details *details = object;
1304         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1305         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1306         struct sorcery_details sdetails = {
1307                 .sorcery = sorcery,
1308                 .obj = object,
1309         };
1310
1311         if (!object_type) {
1312                 return -1;
1313         }
1314
1315         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_create, &sdetails)) &&
1316                 ao2_container_count(object_type->observers)) {
1317                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1318
1319                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_create, invocation)) {
1320                         ao2_cleanup(invocation);
1321                 }
1322         }
1323
1324         return object_wizard ? 0 : -1;
1325 }
1326
1327 /*! \brief Internal callback function which notifies an individual observer that an object has been updated */
1328 static int sorcery_observer_notify_update(void *obj, void *arg, int flags)
1329 {
1330         const struct ast_sorcery_object_type_observer *observer = obj;
1331
1332         if (observer->callbacks->updated) {
1333                 observer->callbacks->updated(arg);
1334         }
1335
1336         return 0;
1337 }
1338
1339 /*! \brief Internal callback function which notifies observers that an object has been updated */
1340 static int sorcery_observers_notify_update(void *data)
1341 {
1342         struct sorcery_observer_invocation *invocation = data;
1343
1344         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_update, invocation->object);
1345         ao2_cleanup(invocation);
1346
1347         return 0;
1348 }
1349
1350 /*! \brief Internal function which returns if a wizard has updated the object */
1351 static int sorcery_wizard_update(void *obj, void *arg, int flags)
1352 {
1353         const struct ast_sorcery_object_wizard *object_wizard = obj;
1354         const struct sorcery_details *details = arg;
1355
1356         return (object_wizard->wizard->update && !object_wizard->wizard->update(details->sorcery, object_wizard->data, details->obj) &&
1357                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1358 }
1359
1360 int ast_sorcery_update(const struct ast_sorcery *sorcery, void *object)
1361 {
1362         const struct ast_sorcery_object_details *details = object;
1363         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1364         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1365         struct sorcery_details sdetails = {
1366                 .sorcery = sorcery,
1367                 .obj = object,
1368         };
1369
1370         if (!object_type) {
1371                 return -1;
1372         }
1373
1374         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_update, &sdetails)) &&
1375                 ao2_container_count(object_type->observers)) {
1376                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1377
1378                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_update, invocation)) {
1379                         ao2_cleanup(invocation);
1380                 }
1381         }
1382
1383         return object_wizard ? 0 : -1;
1384 }
1385
1386 /*! \brief Internal callback function which notifies an individual observer that an object has been deleted */
1387 static int sorcery_observer_notify_delete(void *obj, void *arg, int flags)
1388 {
1389         const struct ast_sorcery_object_type_observer *observer = obj;
1390
1391         if (observer->callbacks->deleted) {
1392                 observer->callbacks->deleted(arg);
1393         }
1394
1395         return 0;
1396 }
1397
1398 /*! \brief Internal callback function which notifies observers that an object has been deleted */
1399 static int sorcery_observers_notify_delete(void *data)
1400 {
1401         struct sorcery_observer_invocation *invocation = data;
1402
1403         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_delete, invocation->object);
1404         ao2_cleanup(invocation);
1405
1406         return 0;
1407 }
1408
1409 /*! \brief Internal function which returns if a wizard has deleted the object */
1410 static int sorcery_wizard_delete(void *obj, void *arg, int flags)
1411 {
1412         const struct ast_sorcery_object_wizard *object_wizard = obj;
1413         const struct sorcery_details *details = arg;
1414
1415         return (object_wizard->wizard->delete && !object_wizard->wizard->delete(details->sorcery, object_wizard->data, details->obj) &&
1416                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1417 }
1418
1419 int ast_sorcery_delete(const struct ast_sorcery *sorcery, void *object)
1420 {
1421         const struct ast_sorcery_object_details *details = object;
1422         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1423         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1424         struct sorcery_details sdetails = {
1425                 .sorcery = sorcery,
1426                 .obj = object,
1427         };
1428
1429         if (!object_type) {
1430                 return -1;
1431         }
1432
1433         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_delete, &sdetails)) &&
1434                 ao2_container_count(object_type->observers)) {
1435                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1436
1437                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_delete, invocation)) {
1438                         ao2_cleanup(invocation);
1439                 }
1440         }
1441
1442         return object_wizard ? 0 : -1;
1443 }
1444
1445 void ast_sorcery_unref(struct ast_sorcery *sorcery)
1446 {
1447         ao2_cleanup(sorcery);
1448 }
1449
1450 const char *ast_sorcery_object_get_id(const void *object)
1451 {
1452         const struct ast_sorcery_object_details *details = object;
1453         return details->object->id;
1454 }
1455
1456 const char *ast_sorcery_object_get_type(const void *object)
1457 {
1458         const struct ast_sorcery_object_details *details = object;
1459         return details->object->type;
1460 }
1461
1462 const char *ast_sorcery_object_get_extended(const void *object, const char *name)
1463 {
1464         const struct ast_sorcery_object_details *details = object;
1465         struct ast_variable *field;
1466
1467         for (field = details->object->extended; field; field = field->next) {
1468                 if (!strcmp(field->name + 1, name)) {
1469                         return field->value;
1470                 }
1471         }
1472
1473         return NULL;
1474 }
1475
1476 int ast_sorcery_object_set_extended(const void *object, const char *name, const char *value)
1477 {
1478         RAII_VAR(struct ast_variable *, field, NULL, ast_variables_destroy);
1479         struct ast_variable *extended = ast_variable_new(name, value, ""), *previous = NULL;
1480         const struct ast_sorcery_object_details *details = object;
1481
1482         if (!extended) {
1483                 return -1;
1484         }
1485
1486         for (field = details->object->extended; field; previous = field, field = field->next) {
1487                 if (!strcmp(field->name, name)) {
1488                         if (previous) {
1489                                 previous->next = field->next;
1490                         } else {
1491                                 details->object->extended = field->next;
1492                         }
1493                         field->next = NULL;
1494                         break;
1495                 }
1496         }
1497
1498         extended->next = details->object->extended;
1499         details->object->extended = extended;
1500
1501         return 0;
1502 }
1503
1504 int ast_sorcery_observer_add(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
1505 {
1506         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1507         struct ast_sorcery_object_type_observer *observer;
1508
1509         if (!object_type || !callbacks) {
1510                 return -1;
1511         }
1512
1513         if (!(observer = ao2_alloc(sizeof(*observer), NULL))) {
1514                 return -1;
1515         }
1516
1517         observer->callbacks = callbacks;
1518         ao2_link(object_type->observers, observer);
1519         ao2_ref(observer, -1);
1520
1521         return 0;
1522 }
1523
1524 /*! \brief Internal callback function for removing an observer */
1525 static int sorcery_observer_remove(void *obj, void *arg, int flags)
1526 {
1527         const struct ast_sorcery_object_type_observer *observer = obj;
1528
1529         return (observer->callbacks == arg) ? CMP_MATCH | CMP_STOP : 0;
1530 }
1531
1532 void ast_sorcery_observer_remove(const struct ast_sorcery *sorcery, const char *type, struct ast_sorcery_observer *callbacks)
1533 {
1534         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1535
1536         if (!object_type) {
1537                 return;
1538         }
1539
1540         ao2_callback(object_type->observers, OBJ_NODATA | OBJ_UNLINK, sorcery_observer_remove, callbacks);
1541 }