sorcery: Don't try to load object types which haven't been defined.
[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/format.h"
38 #include "asterisk/format_cap.h"
39 #include "asterisk/strings.h"
40 #include "asterisk/config_options.h"
41 #include "asterisk/netsock2.h"
42 #include "asterisk/module.h"
43 #include "asterisk/taskprocessor.h"
44 #include "asterisk/threadpool.h"
45 #include "asterisk/json.h"
46
47 /* To prevent DEBUG_FD_LEAKS from interfering with things we undef open and close */
48 #undef open
49 #undef close
50
51 /*! \brief Number of buckets for wizards (should be prime for performance reasons) */
52 #define WIZARD_BUCKETS 7
53
54 /*! \brief Number of buckets for types (should be prime for performance reasons) */
55 #define TYPE_BUCKETS 53
56
57 /*! \brief Number of buckets for instances (should be prime for performance reasons) */
58 #define INSTANCE_BUCKETS 17
59
60 /*! \brief Number of buckets for object fields (should be prime for performance reasons) */
61 #define OBJECT_FIELD_BUCKETS 29
62
63 #define NOTIFY_GENERIC_OBSERVERS(container, type, callback, ...) ({ \
64         struct ao2_iterator i = ao2_iterator_init(container, 0); \
65         struct type *observer; \
66         ao2_rdlock(container); \
67         while ((observer = ao2_iterator_next(&i))) { \
68                 if (observer->callbacks->callback) { \
69                         observer->callbacks->callback(__VA_ARGS__); \
70                 } \
71                 ao2_cleanup(observer); \
72         } \
73         ao2_unlock(container); \
74         ao2_iterator_cleanup(&i); \
75 })
76
77 #define NOTIFY_GLOBAL_OBSERVERS(container, callback, ...) \
78         NOTIFY_GENERIC_OBSERVERS(container, sorcery_global_observer, callback, __VA_ARGS__)
79
80 #define NOTIFY_INSTANCE_OBSERVERS(container, callback, ...) \
81         NOTIFY_GENERIC_OBSERVERS(container, sorcery_instance_observer, callback, __VA_ARGS__)
82
83 #define NOTIFY_WIZARD_OBSERVERS(container, callback, ...) \
84         NOTIFY_GENERIC_OBSERVERS(container, sorcery_wizard_observer, callback, __VA_ARGS__)
85
86 /*! \brief Thread pool for observers */
87 static struct ast_threadpool *threadpool;
88
89 /*! \brief Structure for internal sorcery object information */
90 struct ast_sorcery_object {
91         /*! \brief Unique identifier of this object */
92         char *id;
93
94         /*! \brief Type of object */
95         char type[MAX_OBJECT_TYPE];
96
97         /*! \brief Optional object destructor */
98         ao2_destructor_fn destructor;
99
100         /*! \brief Extended object fields */
101         struct ast_variable *extended;
102 };
103
104 /*! \brief Structure for registered object type */
105 struct ast_sorcery_object_type {
106         /*! \brief Unique name of the object type */
107         char name[MAX_OBJECT_TYPE];
108
109         /*! \brief Optional transformation callback */
110         sorcery_transform_handler transform;
111
112         /*! \brief Optional object set apply callback */
113         sorcery_apply_handler apply;
114
115         /*! \brief Optional object copy callback */
116         sorcery_copy_handler copy;
117
118         /*! \brief Optional object diff callback */
119         sorcery_diff_handler diff;
120
121         /*! \brief Wizard instances */
122         struct ao2_container *wizards;
123
124         /*! \brief Object fields */
125         struct ao2_container *fields;
126
127         /*! \brief Configuration framework general information */
128         struct aco_info *info;
129
130         /*! \brief Configuration framework file information */
131         struct aco_file *file;
132
133         /*! \brief Type details */
134         struct aco_type type;
135
136         /*! \brief Observers */
137         struct ao2_container *observers;
138
139         /*! \brief Serializer for observers */
140         struct ast_taskprocessor *serializer;
141
142         /*! \brief Specifies if object type is reloadable or not */
143         unsigned int reloadable:1;
144 };
145
146 /*! \brief Structure for registered object type observer */
147 struct ast_sorcery_object_type_observer {
148         /*! \brief Pointer to the observer implementation */
149         const struct ast_sorcery_observer *callbacks;
150 };
151
152 /*! \brief Structure used for observer invocations */
153 struct sorcery_observer_invocation {
154         /*! \brief Pointer to the object type */
155         struct ast_sorcery_object_type *object_type;
156
157         /*! \brief Pointer to the object */
158         void *object;
159 };
160
161 /*! \brief Structure for registered object field */
162 struct ast_sorcery_object_field {
163         /*! \brief Name of the field */
164         char name[MAX_OBJECT_FIELD];
165
166         /*! \brief The compiled name regex if name is a regex */
167         regex_t *name_regex;
168
169         /*! \brief Callback function for translation of a single value */
170         sorcery_field_handler handler;
171
172         /*! \brief Callback function for translation of multiple values */
173         sorcery_fields_handler multiple_handler;
174
175         /*! \brief Position of the field */
176         intptr_t args[];
177 };
178
179 /*! \brief Structure for an internal wizard instance */
180 struct ast_sorcery_internal_wizard {
181         /*! \brief Wizard interface itself */
182         struct ast_sorcery_wizard callbacks;
183
184         /*! \brief Observers */
185         struct ao2_container *observers;
186 };
187
188 /*! \brief Structure for a wizard instance which operates on objects */
189 struct ast_sorcery_object_wizard {
190         /*! \brief Wizard interface itself */
191         struct ast_sorcery_internal_wizard *wizard;
192
193         /*! \brief Unique data for the wizard */
194         void *data;
195
196         /*! \brief Wizard is acting as an object cache */
197         unsigned int caching:1;
198 };
199
200 /*! \brief Full structure for sorcery */
201 struct ast_sorcery {
202         /*! \brief Container for known object types */
203         struct ao2_container *types;
204
205         /*! \brief Observers */
206         struct ao2_container *observers;
207
208         /*! \brief The name of the module owning this sorcery instance */
209         char module_name[0];
210 };
211
212 /*! \brief Structure for passing load/reload details */
213 struct sorcery_load_details {
214         /*! \brief Sorcery structure in use */
215         const struct ast_sorcery *sorcery;
216
217         /*! \brief Type of object being loaded */
218         const char *type;
219
220         /*! \brief Whether this is a reload or not */
221         unsigned int reload:1;
222 };
223
224 /*! \brief Registered sorcery wizards */
225 static struct ao2_container *wizards;
226
227 /* The following 3 observer wrappers must name their
228  * external observer 'callbacks' and it must be
229  * the first member of the structure.  Common macros
230  * and container callbacks depend on it.
231  */
232
233 /*! \brief A global observer wrapper */
234 struct sorcery_global_observer {
235         const struct ast_sorcery_global_observer *callbacks;
236 };
237
238 /*! \brief An instance observer wrapper */
239 struct sorcery_instance_observer {
240         const struct ast_sorcery_instance_observer *callbacks;
241 };
242
243 /*! \brief A wizard observer wrapper */
244 struct sorcery_wizard_observer {
245         const struct ast_sorcery_wizard_observer *callbacks;
246 };
247
248 /*! \brief Registered global observers */
249 struct ao2_container *observers;
250
251 /*! \brief Registered sorcery instances */
252 static struct ao2_container *instances;
253
254 static int int_handler_fn(const void *obj, const intptr_t *args, char **buf)
255 {
256         int *field = (int *)(obj + args[0]);
257         return (ast_asprintf(buf, "%d", *field) < 0) ? -1 : 0;
258 }
259
260 static int uint_handler_fn(const void *obj, const intptr_t *args, char **buf)
261 {
262         unsigned int *field = (unsigned int *)(obj + args[0]);
263         return (ast_asprintf(buf, "%u", *field) < 0) ? -1 : 0;
264 }
265
266 static int double_handler_fn(const void *obj, const intptr_t *args, char **buf)
267 {
268         double *field = (double *)(obj + args[0]);
269         return (ast_asprintf(buf, "%f", *field) < 0) ? -1 : 0;
270 }
271
272 static int stringfield_handler_fn(const void *obj, const intptr_t *args, char **buf)
273 {
274         ast_string_field *field = (const char **)(obj + args[0]);
275         return !(*buf = ast_strdup(*field)) ? -1 : 0;
276 }
277
278 static int bool_handler_fn(const void *obj, const intptr_t *args, char **buf)
279 {
280         unsigned int *field = (unsigned int *)(obj + args[0]);
281         return !(*buf = ast_strdup(*field ? "true" : "false")) ? -1 : 0;
282 }
283
284 static int sockaddr_handler_fn(const void *obj, const intptr_t *args, char **buf)
285 {
286         struct ast_sockaddr *field = (struct ast_sockaddr *)(obj + args[0]);
287         return !(*buf = ast_strdup(ast_sockaddr_stringify(field))) ? -1 : 0;
288 }
289
290 static int chararray_handler_fn(const void *obj, const intptr_t *args, char **buf)
291 {
292         char *field = (char *)(obj + args[0]);
293         return !(*buf = ast_strdup(field)) ? -1 : 0;
294 }
295
296 static int codec_handler_fn(const void *obj, const intptr_t *args, char **buf)
297 {
298         struct ast_str *codec_buf = ast_str_alloca(64);
299         struct ast_format_cap **cap = (struct ast_format_cap **)(obj + args[0]);
300         return !(*buf = ast_strdup(ast_format_cap_get_names(*cap, &codec_buf)));
301 }
302
303 static sorcery_field_handler sorcery_field_default_handler(enum aco_option_type type)
304 {
305         switch(type) {
306         case OPT_BOOL_T: return bool_handler_fn;
307         case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
308         case OPT_CODEC_T: return codec_handler_fn;
309         case OPT_DOUBLE_T: return double_handler_fn;
310         case OPT_INT_T: return int_handler_fn;
311         case OPT_SOCKADDR_T: return sockaddr_handler_fn;
312         case OPT_STRINGFIELD_T: return stringfield_handler_fn;
313         case OPT_UINT_T: return uint_handler_fn;
314
315         default:
316         case OPT_CUSTOM_T: return NULL;
317         }
318
319         return NULL;
320 }
321
322 /*! \brief Hashing function for sorcery wizards */
323 static int sorcery_wizard_hash(const void *obj, const int flags)
324 {
325         const struct ast_sorcery_internal_wizard *object;
326         const char *key;
327
328         switch (flags & OBJ_SEARCH_MASK) {
329         case OBJ_SEARCH_KEY:
330                 key = obj;
331                 break;
332         case OBJ_SEARCH_OBJECT:
333                 object = obj;
334                 key = object->callbacks.name;
335                 break;
336         default:
337                 ast_assert(0);
338                 return 0;
339         }
340         return ast_str_hash(key);
341 }
342
343 /*! \brief Comparator function for sorcery wizards */
344 static int sorcery_wizard_cmp(void *obj, void *arg, int flags)
345 {
346         const struct ast_sorcery_internal_wizard *object_left = obj;
347         const struct ast_sorcery_internal_wizard *object_right = arg;
348         const char *right_key = arg;
349         int cmp;
350
351         switch (flags & OBJ_SEARCH_MASK) {
352         case OBJ_SEARCH_OBJECT:
353                 right_key = object_right->callbacks.name;
354                 /* Fall through */
355         case OBJ_SEARCH_KEY:
356                 cmp = strcmp(object_left->callbacks.name, right_key);
357                 break;
358         case OBJ_SEARCH_PARTIAL_KEY:
359                 cmp = strncmp(object_left->callbacks.name, right_key, strlen(right_key));
360                 break;
361         default:
362                 cmp = 0;
363                 break;
364         }
365         if (cmp) {
366                 return 0;
367         }
368         return CMP_MATCH;
369 }
370
371 /*! \brief Hashing function for sorcery wizards */
372 static int object_type_field_hash(const void *obj, const int flags)
373 {
374         const struct ast_sorcery_object_field *object_field;
375         const char *key;
376
377         switch (flags & OBJ_SEARCH_MASK) {
378         case OBJ_SEARCH_KEY:
379                 key = obj;
380                 break;
381         case OBJ_SEARCH_OBJECT:
382                 object_field = obj;
383                 key = object_field->name;
384                 break;
385         default:
386                 ast_assert(0);
387                 return 0;
388         }
389         return ast_str_hash(key);
390 }
391
392 static int object_type_field_cmp(void *obj, void *arg, int flags)
393 {
394         const struct ast_sorcery_object_field *field_left = obj;
395         const struct ast_sorcery_object_field *field_right = arg;
396         const char *right_key = arg;
397         int cmp;
398
399         switch (flags & OBJ_SEARCH_MASK) {
400         case OBJ_SEARCH_OBJECT:
401                 right_key = field_right->name;
402                 /* Fall through */
403         case OBJ_SEARCH_KEY:
404                 cmp = strcmp(field_left->name, right_key);
405                 break;
406         case OBJ_SEARCH_PARTIAL_KEY:
407                 cmp = strncmp(field_left->name, right_key, strlen(right_key));
408                 break;
409         default:
410                 cmp = 0;
411                 break;
412         }
413         if (cmp) {
414                 return 0;
415         }
416         return CMP_MATCH;
417 }
418
419 /*! \brief Cleanup function */
420 static void sorcery_exit(void)
421 {
422         ast_threadpool_shutdown(threadpool);
423         threadpool = NULL;
424 }
425
426 /*! \brief Cleanup function for graceful shutdowns */
427 static void sorcery_cleanup(void)
428 {
429         ao2_cleanup(wizards);
430         wizards = NULL;
431         ao2_cleanup(observers);
432         observers = NULL;
433         ao2_cleanup(instances);
434         instances = NULL;
435 }
436
437 /*! \brief Compare function for sorcery instances */
438 static int sorcery_instance_cmp(void *obj, void *arg, int flags)
439 {
440         const struct ast_sorcery *object_left = obj;
441         const struct ast_sorcery *object_right = arg;
442         const char *right_key = arg;
443         int cmp;
444
445         switch (flags & OBJ_SEARCH_MASK) {
446         case OBJ_SEARCH_OBJECT:
447                 right_key = object_right->module_name;
448                 /* Fall through */
449         case OBJ_SEARCH_KEY:
450                 cmp = strcmp(object_left->module_name, right_key);
451                 break;
452         case OBJ_SEARCH_PARTIAL_KEY:
453                 cmp = strncmp(object_left->module_name, right_key, strlen(right_key));
454                 break;
455         default:
456                 cmp = 0;
457                 break;
458         }
459         if (cmp) {
460                 return 0;
461         }
462         return CMP_MATCH;
463 }
464
465 /*! \brief Hashing function for sorcery instances */
466 static int sorcery_instance_hash(const void *obj, const int flags)
467 {
468         const struct ast_sorcery *object;
469         const char *key;
470
471         switch (flags & OBJ_SEARCH_MASK) {
472         case OBJ_SEARCH_KEY:
473                 key = obj;
474                 break;
475         case OBJ_SEARCH_OBJECT:
476                 object = obj;
477                 key = object->module_name;
478                 break;
479         default:
480                 ast_assert(0);
481                 return 0;
482         }
483         return ast_str_hash(key);
484 }
485
486 int ast_sorcery_init(void)
487 {
488         struct ast_threadpool_options options = {
489                 .version = AST_THREADPOOL_OPTIONS_VERSION,
490                 .auto_increment = 1,
491                 .max_size = 0,
492                 .idle_timeout = 60,
493                 .initial_size = 0,
494         };
495         ast_assert(wizards == NULL);
496
497         if (!(threadpool = ast_threadpool_create("Sorcery", NULL, &options))) {
498                 threadpool = NULL;
499                 return -1;
500         }
501
502         if (!(wizards = ao2_container_alloc(WIZARD_BUCKETS, sorcery_wizard_hash, sorcery_wizard_cmp))) {
503                 ast_threadpool_shutdown(threadpool);
504                 return -1;
505         }
506
507         observers = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK, 0, NULL, NULL);
508         if (!observers) {
509                 sorcery_cleanup();
510                 sorcery_exit();
511                 return -1;
512         }
513
514         instances = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, INSTANCE_BUCKETS,
515                 sorcery_instance_hash, sorcery_instance_cmp);
516         if (!instances) {
517                 sorcery_cleanup();
518                 sorcery_exit();
519                 return -1;
520         }
521
522         ast_register_cleanup(sorcery_cleanup);
523         ast_register_atexit(sorcery_exit);
524
525         return 0;
526 }
527
528 static void sorcery_internal_wizard_destructor(void *obj)
529 {
530         struct ast_sorcery_internal_wizard *wizard = obj;
531
532         ao2_cleanup(wizard->observers);
533 }
534
535 int __ast_sorcery_wizard_register(const struct ast_sorcery_wizard *interface, struct ast_module *module)
536 {
537         struct ast_sorcery_internal_wizard *wizard;
538         int res = -1;
539
540         ast_assert(!ast_strlen_zero(interface->name));
541
542         ao2_lock(wizards);
543
544         if ((wizard = ao2_find(wizards, interface->name, OBJ_KEY | OBJ_NOLOCK))) {
545                 ast_log(LOG_WARNING, "Attempted to register sorcery wizard '%s' twice\n",
546                         interface->name);
547                 goto done;
548         }
549
550         if (!(wizard = ao2_alloc(sizeof(*wizard), sorcery_internal_wizard_destructor))) {
551                 goto done;
552         }
553
554         wizard->callbacks = *interface;
555         wizard->callbacks.module = module;
556
557         wizard->observers = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK, 0, NULL, NULL);
558         if (!wizard->observers) {
559                 goto done;
560         }
561
562         ao2_link_flags(wizards, wizard, OBJ_NOLOCK);
563         res = 0;
564
565         ast_verb(2, "Sorcery registered wizard '%s'\n", interface->name);
566
567         NOTIFY_GLOBAL_OBSERVERS(observers, wizard_registered,
568                 interface->name, interface);
569
570 done:
571         ao2_cleanup(wizard);
572         ao2_unlock(wizards);
573
574         return res;
575 }
576
577 int ast_sorcery_wizard_unregister(const struct ast_sorcery_wizard *interface)
578 {
579         struct ast_sorcery_internal_wizard *wizard =
580                 interface ? ao2_find(wizards, interface->name, OBJ_SEARCH_KEY) : NULL;
581
582         if (wizard) {
583                 NOTIFY_GLOBAL_OBSERVERS(observers, wizard_unregistering, wizard->callbacks.name, &wizard->callbacks);
584                 ao2_unlink(wizards, wizard);
585                 ao2_ref(wizard, -1);
586                 ast_verb(2, "Sorcery unregistered wizard '%s'\n", interface->name);
587                 return 0;
588         } else {
589                 return -1;
590         }
591 }
592
593 /*! \brief Internal callback function for removing a generic observer */
594 static int sorcery_generic_observer_remove(void *obj, void *arg, int flags)
595 {
596         const struct sorcery_global_observer *observer = obj;
597
598         return (observer->callbacks == arg) ? CMP_MATCH | CMP_STOP : 0;
599 }
600
601 int ast_sorcery_global_observer_add(const struct ast_sorcery_global_observer *callbacks)
602 {
603         struct sorcery_global_observer *cb;
604
605         cb = ao2_alloc(sizeof(*cb), NULL);
606         if (!cb) {
607                 return -1;
608         }
609
610         cb->callbacks = callbacks;
611         ao2_link(observers, cb);
612         ao2_ref(cb, -1);
613
614         return 0;
615 }
616
617 void ast_sorcery_global_observer_remove(
618         const struct ast_sorcery_global_observer *callbacks)
619 {
620         ao2_callback(observers, OBJ_NODATA | OBJ_UNLINK, sorcery_generic_observer_remove, (void *)callbacks);
621 }
622
623 int ast_sorcery_instance_observer_add(struct ast_sorcery *sorcery,
624         const struct ast_sorcery_instance_observer *callbacks)
625 {
626         struct sorcery_instance_observer *cb;
627
628         cb = ao2_alloc(sizeof(*cb), NULL);
629         if (!cb) {
630                 return -1;
631         }
632
633         cb->callbacks = callbacks;
634         ao2_link(sorcery->observers, cb);
635         ao2_ref(cb, -1);
636
637         return 0;
638 }
639
640 void ast_sorcery_instance_observer_remove(struct ast_sorcery *sorcery,
641         const struct ast_sorcery_instance_observer *callbacks)
642 {
643         ao2_callback(sorcery->observers, OBJ_NODATA | OBJ_UNLINK, sorcery_generic_observer_remove, (void *)callbacks);
644 }
645
646 int ast_sorcery_wizard_observer_add(struct ast_sorcery_wizard *interface,
647         const struct ast_sorcery_wizard_observer *callbacks)
648 {
649         RAII_VAR(struct ast_sorcery_internal_wizard *, wizard,
650                 interface ? ao2_find(wizards, interface->name, OBJ_SEARCH_KEY) : NULL,
651                         ao2_cleanup);
652
653         if (wizard) {
654                 struct sorcery_wizard_observer *cb;
655
656                 cb = ao2_alloc(sizeof(*cb), NULL);
657                 if (!cb) {
658                         return -1;
659                 }
660
661                 cb->callbacks = callbacks;
662                 ao2_link(wizard->observers, cb);
663                 ao2_ref(cb, -1);
664
665                 return 0;
666         }
667
668         return -1;
669 }
670
671 void ast_sorcery_wizard_observer_remove(struct ast_sorcery_wizard *interface,
672         const struct ast_sorcery_wizard_observer *callbacks)
673 {
674         RAII_VAR(struct ast_sorcery_internal_wizard *, wizard,
675                 interface ? ao2_find(wizards, interface->name, OBJ_SEARCH_KEY) : NULL,
676                         ao2_cleanup);
677
678         if (wizard) {
679                 ao2_callback(wizard->observers, OBJ_NODATA | OBJ_UNLINK, sorcery_generic_observer_remove, (void *)callbacks);
680         }
681 }
682
683 /*! \brief Destructor called when sorcery structure is destroyed */
684 static void sorcery_destructor(void *obj)
685 {
686         struct ast_sorcery *sorcery = obj;
687
688         if (sorcery->observers) {
689                 NOTIFY_GLOBAL_OBSERVERS(observers, instance_destroying, sorcery->module_name, sorcery);
690         }
691         ao2_cleanup(sorcery->observers);
692         ao2_cleanup(sorcery->types);
693 }
694
695 /*! \brief Hashing function for sorcery types */
696 static int sorcery_type_hash(const void *obj, const int flags)
697 {
698         const struct ast_sorcery_object_type *object;
699         const char *key;
700
701         switch (flags & OBJ_SEARCH_MASK) {
702         case OBJ_SEARCH_KEY:
703                 key = obj;
704                 break;
705         case OBJ_SEARCH_OBJECT:
706                 object = obj;
707                 key = object->name;
708                 break;
709         default:
710                 ast_assert(0);
711                 return 0;
712         }
713         return ast_str_hash(key);
714 }
715
716 /*! \brief Comparator function for sorcery types */
717 static int sorcery_type_cmp(void *obj, void *arg, int flags)
718 {
719         const struct ast_sorcery_object_type *object_left = obj;
720         const struct ast_sorcery_object_type *object_right = arg;
721         const char *right_key = arg;
722         int cmp;
723
724         switch (flags & OBJ_SEARCH_MASK) {
725         case OBJ_SEARCH_OBJECT:
726                 right_key = object_right->name;
727                 /* Fall through */
728         case OBJ_SEARCH_KEY:
729                 cmp = strcmp(object_left->name, right_key);
730                 break;
731         case OBJ_SEARCH_PARTIAL_KEY:
732                 cmp = strncmp(object_left->name, right_key, strlen(right_key));
733                 break;
734         default:
735                 cmp = 0;
736                 break;
737         }
738         if (cmp) {
739                 return 0;
740         }
741         return CMP_MATCH;
742 }
743
744 struct ast_sorcery *__ast_sorcery_open(const char *module_name)
745 {
746         struct ast_sorcery *sorcery;
747
748         ast_assert(module_name != NULL);
749
750         ao2_wrlock(instances);
751         if ((sorcery = ao2_find(instances, module_name, OBJ_SEARCH_KEY | OBJ_NOLOCK))) {
752                 goto done;
753         }
754
755         if (!(sorcery = ao2_alloc(sizeof(*sorcery) + strlen(module_name) + 1, sorcery_destructor))) {
756                 goto done;
757         }
758
759         if (!(sorcery->types = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, TYPE_BUCKETS, sorcery_type_hash, sorcery_type_cmp))) {
760                 ao2_ref(sorcery, -1);
761                 sorcery = NULL;
762                 goto done;
763         }
764
765         if (!(sorcery->observers = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_RWLOCK, 0, NULL, NULL))) {
766                 ao2_ref(sorcery, -1);
767                 sorcery = NULL;
768                 goto done;
769         }
770
771         strcpy(sorcery->module_name, module_name); /* Safe */
772
773         if (__ast_sorcery_apply_config(sorcery, module_name, module_name) == AST_SORCERY_APPLY_FAIL) {
774                 ast_log(LOG_ERROR, "Error attempting to apply configuration %s to sorcery.\n", module_name);
775                 ao2_cleanup(sorcery);
776                 sorcery = NULL;
777                 goto done;
778         }
779
780         ao2_link_flags(instances, sorcery, OBJ_NOLOCK);
781
782         NOTIFY_GLOBAL_OBSERVERS(observers, instance_created, module_name, sorcery);
783
784 done:
785         ao2_unlock(instances);
786         return sorcery;
787 }
788
789 /*! \brief Search function for sorcery instances */
790 struct ast_sorcery *ast_sorcery_retrieve_by_module_name(const char *module_name)
791 {
792         return ao2_find(instances, module_name, OBJ_SEARCH_KEY);
793 }
794
795 /*! \brief Destructor function for object types */
796 static void sorcery_object_type_destructor(void *obj)
797 {
798         struct ast_sorcery_object_type *object_type = obj;
799
800         ao2_cleanup(object_type->wizards);
801         ao2_cleanup(object_type->fields);
802         ao2_cleanup(object_type->observers);
803
804         if (object_type->info) {
805                 aco_info_destroy(object_type->info);
806                 ast_free(object_type->info);
807         }
808
809         ast_free(object_type->file);
810
811         ast_taskprocessor_unreference(object_type->serializer);
812 }
813
814 /*! \brief Internal function which allocates an object type structure */
815 static struct ast_sorcery_object_type *sorcery_object_type_alloc(const char *type, const char *module)
816 {
817         struct ast_sorcery_object_type *object_type;
818         char uuid[AST_UUID_STR_LEN];
819
820         if (!(object_type = ao2_alloc(sizeof(*object_type), sorcery_object_type_destructor))) {
821                 return NULL;
822         }
823
824         /* Order matters for object wizards */
825         if (!(object_type->wizards = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, sorcery_wizard_cmp))) {
826                 ao2_ref(object_type, -1);
827                 return NULL;
828         }
829
830         if (!(object_type->fields = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, OBJECT_FIELD_BUCKETS,
831                                         object_type_field_hash, object_type_field_cmp))) {
832                 ao2_ref(object_type, -1);
833                 return NULL;
834         }
835
836         if (!(object_type->observers = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_RWLOCK, 1, NULL, NULL))) {
837                 ao2_ref(object_type, -1);
838                 return NULL;
839         }
840
841         if (!(object_type->info = ast_calloc(1, sizeof(*object_type->info) + 2 * sizeof(object_type->info->files[0])))) {
842                 ao2_ref(object_type, -1);
843                 return NULL;
844         }
845
846         if (!(object_type->file = ast_calloc(1, sizeof(*object_type->file) + 2 * sizeof(object_type->file->types[0])))) {
847                 ao2_ref(object_type, -1);
848                 return NULL;
849         }
850
851         if (!ast_uuid_generate_str(uuid, sizeof(uuid))) {
852                 ao2_ref(object_type, -1);
853                 return NULL;
854         }
855
856         if (!(object_type->serializer = ast_threadpool_serializer(uuid, threadpool))) {
857                 ao2_ref(object_type, -1);
858                 return NULL;
859         }
860
861         object_type->info->files[0] = object_type->file;
862         object_type->info->files[1] = NULL;
863         object_type->info->module = module;
864
865         ast_copy_string(object_type->name, type, sizeof(object_type->name));
866
867         return object_type;
868 }
869
870 /*! \brief Object wizard destructor */
871 static void sorcery_object_wizard_destructor(void *obj)
872 {
873         struct ast_sorcery_object_wizard *object_wizard = obj;
874
875         if (object_wizard->data) {
876                 object_wizard->wizard->callbacks.close(object_wizard->data);
877         }
878
879         if (object_wizard->wizard) {
880                 ast_module_unref(object_wizard->wizard->callbacks.module);
881         }
882
883         ao2_cleanup(object_wizard->wizard);
884 }
885
886 /*! \brief Internal function which creates an object type and adds a wizard mapping */
887 enum ast_sorcery_apply_result __ast_sorcery_apply_wizard_mapping(struct ast_sorcery *sorcery,
888                 const char *type, const char *module, const char *name, const char *data, unsigned int caching)
889 {
890         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
891         RAII_VAR(struct ast_sorcery_internal_wizard *, wizard, ao2_find(wizards, name, OBJ_KEY), ao2_cleanup);
892         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, ao2_alloc(sizeof(*object_wizard), sorcery_object_wizard_destructor), ao2_cleanup);
893         int created = 0;
894
895         if (!wizard || !object_wizard) {
896                 return AST_SORCERY_APPLY_FAIL;
897         }
898
899         if (!object_type) {
900                 if (!(object_type = sorcery_object_type_alloc(type, module))) {
901                         return AST_SORCERY_APPLY_FAIL;
902                 }
903                 created = 1;
904         }
905
906         if (!created) {
907                 struct ast_sorcery_wizard *found;
908
909                 found = ao2_find(object_type->wizards, wizard, OBJ_SEARCH_OBJECT);
910                 if (found) {
911                         ast_debug(1, "Wizard %s already applied to object type %s\n",
912                                         wizard->callbacks.name, object_type->name);
913                         ao2_cleanup(found);
914                         return AST_SORCERY_APPLY_DUPLICATE;
915                 }
916         }
917
918         if (wizard->callbacks.open && !(object_wizard->data = wizard->callbacks.open(data))) {
919                 return AST_SORCERY_APPLY_FAIL;
920         }
921
922         ast_module_ref(wizard->callbacks.module);
923
924         object_wizard->wizard = ao2_bump(wizard);
925         object_wizard->caching = caching;
926
927         ao2_link(object_type->wizards, object_wizard);
928
929         if (created) {
930                 ao2_link(sorcery->types, object_type);
931         }
932
933         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, wizard_mapped,
934                 sorcery->module_name, sorcery, type, &wizard->callbacks, data, object_wizard->data);
935
936         return AST_SORCERY_APPLY_SUCCESS;
937 }
938
939 enum ast_sorcery_apply_result  __ast_sorcery_apply_config(struct ast_sorcery *sorcery, const char *name, const char *module)
940 {
941         struct ast_flags flags = { 0 };
942         struct ast_config *config = ast_config_load2("sorcery.conf", "sorcery", flags);
943         struct ast_variable *mapping;
944         int res = AST_SORCERY_APPLY_SUCCESS;
945
946         if (!config) {
947                 return AST_SORCERY_APPLY_NO_CONFIGURATION;
948         }
949
950         if (config == CONFIG_STATUS_FILEINVALID) {
951                 return AST_SORCERY_APPLY_FAIL;
952         }
953
954         for (mapping = ast_variable_browse(config, name); mapping; mapping = mapping->next) {
955                 RAII_VAR(char *, mapping_name, ast_strdup(mapping->name), ast_free);
956                 RAII_VAR(char *, mapping_value, ast_strdup(mapping->value), ast_free);
957                 char *options = mapping_name;
958                 char *type = strsep(&options, "/");
959                 char *data = mapping_value;
960                 char *wizard = strsep(&data, ",");
961                 unsigned int caching = 0;
962
963                 /* If no object type or wizard exists just skip, nothing we can do */
964                 if (ast_strlen_zero(type) || ast_strlen_zero(wizard)) {
965                         continue;
966                 }
967
968                 /* If the wizard is configured as a cache treat it as such */
969                 if (!ast_strlen_zero(options) && strstr(options, "cache")) {
970                         caching = 1;
971                 }
972
973                 /* Any error immediately causes us to stop */
974                 if (__ast_sorcery_apply_wizard_mapping(sorcery, type, module, wizard, data, caching) == AST_SORCERY_APPLY_FAIL) {
975                         res = AST_SORCERY_APPLY_FAIL;
976                         break;
977                 }
978         }
979
980         ast_config_destroy(config);
981
982         return res;
983 }
984
985 enum ast_sorcery_apply_result __ast_sorcery_apply_default(struct ast_sorcery *sorcery, const char *type, const char *module, const char *name, const char *data)
986 {
987         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
988
989         /* Defaults can not be added if any existing mapping exists */
990         if (object_type) {
991                 return AST_SORCERY_APPLY_DEFAULT_UNNECESSARY;
992         }
993
994         return __ast_sorcery_apply_wizard_mapping(sorcery, type, module, name, data, 0);
995 }
996
997 static int sorcery_extended_config_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
998 {
999         return ast_sorcery_object_set_extended(obj, var->name, var->value);
1000 }
1001
1002 static int sorcery_extended_fields_handler(const void *obj, struct ast_variable **fields)
1003 {
1004         const struct ast_sorcery_object_details *details = obj;
1005
1006         if (details->object->extended) {
1007                 *fields = ast_variables_dup(details->object->extended);
1008         } else {
1009                 *fields = NULL;
1010         }
1011
1012         return 0;
1013 }
1014
1015 int __ast_sorcery_object_register(struct ast_sorcery *sorcery, const char *type, unsigned int hidden, unsigned int reloadable, aco_type_item_alloc alloc, sorcery_transform_handler transform, sorcery_apply_handler apply)
1016 {
1017         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1018
1019         if (!object_type || object_type->type.item_alloc) {
1020                 return -1;
1021         }
1022
1023         object_type->type.name = object_type->name;
1024         object_type->type.type = ACO_ITEM;
1025         object_type->type.category = ".?";
1026         object_type->type.item_alloc = alloc;
1027         object_type->type.hidden = hidden;
1028
1029         object_type->reloadable = reloadable;
1030         object_type->transform = transform;
1031         object_type->apply = apply;
1032         object_type->file->types[0] = &object_type->type;
1033         object_type->file->types[1] = NULL;
1034
1035         if (aco_info_init(object_type->info)) {
1036                 return -1;
1037         }
1038
1039         if (ast_sorcery_object_fields_register(sorcery, type, "^@", sorcery_extended_config_handler, sorcery_extended_fields_handler)) {
1040                 return -1;
1041         }
1042
1043         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, object_type_registered,
1044                 sorcery->module_name, sorcery, type);
1045
1046         return 0;
1047 }
1048
1049 void ast_sorcery_object_set_copy_handler(struct ast_sorcery *sorcery, const char *type, sorcery_copy_handler copy)
1050 {
1051         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1052
1053         if (!object_type) {
1054                 return;
1055         }
1056
1057         object_type->copy = copy;
1058 }
1059
1060 void ast_sorcery_object_set_diff_handler(struct ast_sorcery *sorcery, const char *type, sorcery_diff_handler diff)
1061 {
1062         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1063
1064         if (!object_type) {
1065                 return;
1066         }
1067
1068         object_type->diff = diff;
1069 }
1070
1071 static void sorcery_object_field_destructor(void *obj)
1072 {
1073         struct ast_sorcery_object_field *object_field = obj;
1074
1075         if (object_field->name_regex) {
1076                 regfree(object_field->name_regex);
1077         }
1078 }
1079
1080 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)
1081 {
1082 #define MAX_REGEX_ERROR_LEN 128
1083         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1084         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
1085         int rc;
1086
1087         if (!object_type || !object_type->type.item_alloc || !config_handler
1088                 || !(object_field = ao2_alloc(sizeof(*object_field), sorcery_object_field_destructor))) {
1089                 return -1;
1090         }
1091
1092         ast_copy_string(object_field->name, regex, sizeof(object_field->name));
1093         object_field->multiple_handler = sorcery_handler;
1094
1095         if (!(object_field->name_regex = ast_calloc(1, sizeof(regex_t)))) {
1096                 return -1;
1097         }
1098
1099         if ((rc = regcomp(object_field->name_regex, regex, REG_EXTENDED | REG_NOSUB))) {
1100                 char *regerr = ast_alloca(MAX_REGEX_ERROR_LEN);
1101                 regerror(rc, object_field->name_regex, regerr, MAX_REGEX_ERROR_LEN);
1102                 ast_log(LOG_ERROR, "Regular expression '%s' failed to compile: %s\n", regex, regerr);
1103                 return -1;
1104         }
1105
1106         ao2_link(object_type->fields, object_field);
1107         __aco_option_register(object_type->info, regex, ACO_REGEX, object_type->file->types, "", OPT_CUSTOM_T, config_handler, 0, 1, 0);
1108
1109         return 0;
1110 }
1111
1112 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,
1113                                         aco_option_handler config_handler, sorcery_field_handler sorcery_handler, sorcery_fields_handler multiple_handler, unsigned int flags, unsigned int no_doc, unsigned int alias, size_t argc, ...)
1114 {
1115         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1116         RAII_VAR(struct ast_sorcery_object_field *, object_field, NULL, ao2_cleanup);
1117         int pos;
1118         va_list args;
1119
1120         if (!strcmp(type, "id") || !object_type || !object_type->type.item_alloc) {
1121                 return -1;
1122         }
1123
1124         if (!sorcery_handler) {
1125                 sorcery_handler = sorcery_field_default_handler(opt_type);
1126         }
1127
1128         if (!(object_field = ao2_alloc(sizeof(*object_field) + argc * sizeof(object_field->args[0]), NULL))) {
1129                 return -1;
1130         }
1131
1132         ast_copy_string(object_field->name, name, sizeof(object_field->name));
1133         object_field->handler = sorcery_handler;
1134         object_field->multiple_handler = multiple_handler;
1135
1136         va_start(args, argc);
1137         for (pos = 0; pos < argc; pos++) {
1138                 object_field->args[pos] = va_arg(args, size_t);
1139         }
1140         va_end(args);
1141
1142         if (!alias) {
1143                 ao2_link(object_type->fields, object_field);
1144         }
1145
1146         /* TODO: Improve this hack */
1147         if (!argc) {
1148                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc);
1149         } else if (argc == 1) {
1150                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
1151                         object_field->args[0]);
1152         } else if (argc == 2) {
1153                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
1154                         object_field->args[0], object_field->args[1]);
1155         } else if (argc == 3) {
1156                 __aco_option_register(object_type->info, name, ACO_EXACT, object_type->file->types, default_val, opt_type, config_handler, flags, no_doc, argc,
1157                         object_field->args[0], object_field->args[1], object_field->args[2]);
1158         } else {
1159                 ast_assert(0); /* The hack... she does us no good for this */
1160         }
1161
1162         return 0;
1163 }
1164
1165 /*! \brief Retrieves whether or not the type is reloadable */
1166 static int sorcery_reloadable(const struct ast_sorcery *sorcery, const char *type)
1167 {
1168         RAII_VAR(struct ast_sorcery_object_type *, object_type,
1169                  ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1170         return object_type && object_type->reloadable;
1171 }
1172
1173 static int sorcery_wizard_load(void *obj, void *arg, int flags)
1174 {
1175         struct ast_sorcery_object_wizard *wizard = obj;
1176         struct sorcery_load_details *details = arg;
1177         void (*load)(void *data, const struct ast_sorcery *sorcery, const char *type);
1178
1179         load = !details->reload ? wizard->wizard->callbacks.load : wizard->wizard->callbacks.reload;
1180
1181         if (load) {
1182                 NOTIFY_WIZARD_OBSERVERS(wizard->wizard->observers, wizard_loading,
1183                         wizard->wizard->callbacks.name, &wizard->wizard->callbacks, details->type, details->reload);
1184
1185                 load(wizard->data, details->sorcery, details->type);
1186
1187                 NOTIFY_WIZARD_OBSERVERS(wizard->wizard->observers, wizard_loaded,
1188                         wizard->wizard->callbacks.name, &wizard->wizard->callbacks, details->type, details->reload);
1189         }
1190
1191         return 0;
1192 }
1193
1194 /*! \brief Destructor for observer invocation */
1195 static void sorcery_observer_invocation_destroy(void *obj)
1196 {
1197         struct sorcery_observer_invocation *invocation = obj;
1198
1199         ao2_cleanup(invocation->object_type);
1200         ao2_cleanup(invocation->object);
1201 }
1202
1203 /*! \brief Allocator function for observer invocation */
1204 static struct sorcery_observer_invocation *sorcery_observer_invocation_alloc(struct ast_sorcery_object_type *object_type, void *object)
1205 {
1206         struct sorcery_observer_invocation *invocation = ao2_alloc(sizeof(*invocation), sorcery_observer_invocation_destroy);
1207
1208         if (!invocation) {
1209                 return NULL;
1210         }
1211
1212         ao2_ref(object_type, +1);
1213         invocation->object_type = object_type;
1214
1215         if (object) {
1216                 ao2_ref(object, +1);
1217                 invocation->object = object;
1218         }
1219
1220         return invocation;
1221 }
1222
1223 /*! \brief Internal callback function which notifies an individual observer that an object type has been loaded */
1224 static int sorcery_observer_notify_loaded(void *obj, void *arg, int flags)
1225 {
1226         const struct ast_sorcery_object_type_observer *observer = obj;
1227
1228         if (observer->callbacks->loaded) {
1229                 observer->callbacks->loaded(arg);
1230         }
1231
1232         return 0;
1233 }
1234
1235 /*! \brief Internal callback function which notifies observers that an object type has been loaded */
1236 static int sorcery_observers_notify_loaded(void *data)
1237 {
1238         struct sorcery_observer_invocation *invocation = data;
1239
1240         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_loaded, invocation->object_type->name);
1241         ao2_cleanup(invocation);
1242
1243         return 0;
1244 }
1245
1246 static int sorcery_object_load(void *obj, void *arg, int flags)
1247 {
1248         struct ast_sorcery_object_type *type = obj;
1249         struct sorcery_load_details *details = arg;
1250
1251         if (!type->type.item_alloc) {
1252                 return 0;
1253         }
1254
1255         details->type = type->name;
1256
1257         if (details->reload && !sorcery_reloadable(details->sorcery, details->type)) {
1258                 ast_log(LOG_NOTICE, "Type '%s' is not reloadable, maintaining previous values\n",
1259                         details->type);
1260                 return 0;
1261         }
1262
1263         NOTIFY_INSTANCE_OBSERVERS(details->sorcery->observers, object_type_loading,
1264                 details->sorcery->module_name, details->sorcery, type->name, details->reload);
1265
1266         ao2_callback(type->wizards, OBJ_NODATA, sorcery_wizard_load, details);
1267
1268         NOTIFY_INSTANCE_OBSERVERS(details->sorcery->observers, object_type_loaded,
1269                 details->sorcery->module_name, details->sorcery, type->name, details->reload);
1270
1271         if (ao2_container_count(type->observers)) {
1272                 struct sorcery_observer_invocation *invocation;
1273
1274                 invocation = sorcery_observer_invocation_alloc(type, NULL);
1275                 if (invocation
1276                         && ast_taskprocessor_push(type->serializer, sorcery_observers_notify_loaded,
1277                                 invocation)) {
1278                         ao2_cleanup(invocation);
1279                 }
1280         }
1281
1282         return 0;
1283 }
1284
1285 void ast_sorcery_load(const struct ast_sorcery *sorcery)
1286 {
1287         struct sorcery_load_details details = {
1288                 .sorcery = sorcery,
1289                 .reload = 0,
1290         };
1291
1292         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, instance_loading,
1293                 sorcery->module_name, sorcery, 0);
1294
1295         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
1296
1297         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, instance_loaded,
1298                 sorcery->module_name, sorcery, 0);
1299 }
1300
1301 void ast_sorcery_load_object(const struct ast_sorcery *sorcery, const char *type)
1302 {
1303         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1304         struct sorcery_load_details details = {
1305                 .sorcery = sorcery,
1306                 .reload = 0,
1307         };
1308
1309         if (!object_type) {
1310                 return;
1311         }
1312
1313         sorcery_object_load(object_type, &details, 0);
1314 }
1315
1316 void ast_sorcery_reload(const struct ast_sorcery *sorcery)
1317 {
1318         struct sorcery_load_details details = {
1319                 .sorcery = sorcery,
1320                 .reload = 1,
1321         };
1322
1323         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, instance_loading,
1324                 sorcery->module_name, sorcery, 1);
1325
1326         ao2_callback(sorcery->types, OBJ_NODATA, sorcery_object_load, &details);
1327
1328         NOTIFY_INSTANCE_OBSERVERS(sorcery->observers, instance_loaded,
1329                 sorcery->module_name, sorcery, 1);
1330
1331 }
1332
1333 void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *type)
1334 {
1335         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1336         struct sorcery_load_details details = {
1337                 .sorcery = sorcery,
1338                 .reload = 1,
1339         };
1340
1341         if (!object_type) {
1342                 return;
1343         }
1344
1345         sorcery_object_load(object_type, &details, 0);
1346 }
1347
1348 void ast_sorcery_ref(struct ast_sorcery *sorcery)
1349 {
1350         ao2_ref(sorcery, +1);
1351 }
1352
1353 static struct ast_variable *get_single_field_as_var_list(const void *object, struct ast_sorcery_object_field *object_field)
1354 {
1355         struct ast_variable *tmp = NULL;
1356         char *buf = NULL;
1357
1358         if (!object_field->handler) {
1359                 return NULL;
1360         }
1361
1362         if (!(object_field->handler(object, object_field->args, &buf))) {
1363                 tmp = ast_variable_new(object_field->name, S_OR(buf, ""), "");
1364         }
1365         ast_free(buf);
1366
1367         return tmp;
1368 }
1369
1370 static struct ast_variable *get_multiple_fields_as_var_list(const void *object, struct ast_sorcery_object_field *object_field)
1371 {
1372         struct ast_variable *tmp = NULL;
1373
1374         if (!object_field->multiple_handler) {
1375                 return NULL;
1376         }
1377
1378         if (object_field->multiple_handler(object, &tmp)) {
1379                 ast_variables_destroy(tmp);
1380                 tmp = NULL;
1381         }
1382
1383         return tmp;
1384 }
1385
1386 struct ast_variable *ast_sorcery_objectset_create2(const struct ast_sorcery *sorcery,
1387         const void *object,     enum ast_sorcery_field_handler_flags flags)
1388 {
1389         const struct ast_sorcery_object_details *details = object;
1390         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1391         struct ao2_iterator i;
1392         struct ast_sorcery_object_field *object_field;
1393         struct ast_variable *head = NULL;
1394         struct ast_variable *tail = NULL;
1395
1396         if (!object_type) {
1397                 return NULL;
1398         }
1399
1400         i = ao2_iterator_init(object_type->fields, 0);
1401
1402         for (; (object_field = ao2_iterator_next(&i)); ao2_ref(object_field, -1)) {
1403                 struct ast_variable *tmp;
1404
1405                 switch (flags) {
1406                 case AST_HANDLER_PREFER_LIST:
1407                         if ((tmp = get_multiple_fields_as_var_list(object, object_field)) ||
1408                                 (tmp = get_single_field_as_var_list(object, object_field))) {
1409                                 break;
1410                         }
1411                         continue;
1412                 case AST_HANDLER_PREFER_STRING:
1413                         if ((tmp = get_single_field_as_var_list(object, object_field)) ||
1414                                 (tmp = get_multiple_fields_as_var_list(object, object_field))) {
1415                                 break;
1416                         }
1417                         continue;
1418                 case AST_HANDLER_ONLY_LIST:
1419                         if ((tmp = get_multiple_fields_as_var_list(object, object_field))) {
1420                                 break;
1421                         }
1422                         continue;
1423                 case AST_HANDLER_ONLY_STRING:
1424                         if ((tmp = get_single_field_as_var_list(object, object_field))) {
1425                                 break;
1426                         }
1427                         continue;
1428                 default:
1429                         continue;
1430                 }
1431
1432                 tail = ast_variable_list_append_hint(&head, tail, tmp);
1433         }
1434
1435         ao2_iterator_destroy(&i);
1436
1437         return head;
1438 }
1439
1440 struct ast_json *ast_sorcery_objectset_json_create(const struct ast_sorcery *sorcery, const void *object)
1441 {
1442         const struct ast_sorcery_object_details *details = object;
1443         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1444         struct ao2_iterator i;
1445         struct ast_sorcery_object_field *object_field;
1446         struct ast_json *json = ast_json_object_create();
1447         int res = 0;
1448
1449         if (!object_type || !json) {
1450                 return NULL;
1451         }
1452
1453         i = ao2_iterator_init(object_type->fields, 0);
1454
1455         for (; !res && (object_field = ao2_iterator_next(&i)); ao2_ref(object_field, -1)) {
1456                 if (object_field->multiple_handler) {
1457                         struct ast_variable *tmp = NULL;
1458                         struct ast_variable *field;
1459
1460                         if ((res = object_field->multiple_handler(object, &tmp))) {
1461                                 ast_variables_destroy(tmp);
1462                                 ao2_ref(object_field, -1);
1463                                 break;
1464                         }
1465
1466                         for (field = tmp; field; field = field->next) {
1467                                 struct ast_json *value = ast_json_string_create(field->value);
1468
1469                                 if (!value || ast_json_object_set(json, field->name, value)) {
1470                                         res = -1;
1471                                         break;
1472                                 }
1473                         }
1474
1475                         ast_variables_destroy(tmp);
1476                 } else if (object_field->handler) {
1477                         char *buf = NULL;
1478                         struct ast_json *value = NULL;
1479
1480                         if ((res = object_field->handler(object, object_field->args, &buf))
1481                                 || !(value = ast_json_string_create(buf))
1482                                 || ast_json_object_set(json, object_field->name, value)) {
1483                                 res = -1;
1484                         }
1485
1486                         ast_free(buf);
1487                 } else {
1488                         continue;
1489                 }
1490         }
1491
1492         ao2_iterator_destroy(&i);
1493
1494         /* If any error occurs we destroy the JSON object so a partial objectset is not returned */
1495         if (res) {
1496                 ast_json_unref(json);
1497                 json = NULL;
1498         }
1499
1500         return json;
1501 }
1502
1503 int ast_sorcery_objectset_apply(const struct ast_sorcery *sorcery, void *object, struct ast_variable *objectset)
1504 {
1505         const struct ast_sorcery_object_details *details = object;
1506         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1507         RAII_VAR(struct ast_variable *, transformed, NULL, ast_variables_destroy);
1508         struct ast_variable *field;
1509         int res = 0;
1510
1511         if (!object_type) {
1512                 return -1;
1513         }
1514
1515         if (object_type->transform && (transformed = object_type->transform(objectset))) {
1516                 field = transformed;
1517         } else {
1518                 field = objectset;
1519         }
1520
1521         for (; field; field = field->next) {
1522                 if ((res = aco_process_var(&object_type->type, details->object->id, field, object))) {
1523                         break;
1524                 }
1525         }
1526
1527         if (!res && object_type->apply) {
1528                 res = object_type->apply(sorcery, object);
1529         }
1530
1531         return res;
1532 }
1533
1534 int ast_sorcery_changeset_create(const struct ast_variable *original, const struct ast_variable *modified, struct ast_variable **changes)
1535 {
1536         const struct ast_variable *field;
1537         int res = 0;
1538
1539         *changes = NULL;
1540
1541         /* Unless the ast_variable list changes when examined... it can't differ from itself */
1542         if (original == modified) {
1543                 return 0;
1544         }
1545
1546         for (field = modified; field; field = field->next) {
1547                 const char *old_value = ast_variable_find_in_list(original, field->name);
1548
1549                 if (!old_value || strcmp(old_value, field->value)) {
1550                         struct ast_variable *tmp;
1551
1552                         if (!(tmp = ast_variable_new(field->name, field->value, ""))) {
1553                                 res = -1;
1554                                 break;
1555                         }
1556
1557                         tmp->next = *changes;
1558                         *changes = tmp;
1559                 }
1560         }
1561
1562         /* If an error occurred do not return a partial changeset */
1563         if (res) {
1564                 ast_variables_destroy(*changes);
1565                 *changes = NULL;
1566         }
1567
1568         return res;
1569 }
1570
1571 static void sorcery_object_destructor(void *object)
1572 {
1573         struct ast_sorcery_object_details *details = object;
1574
1575         if (details->object->destructor) {
1576                 details->object->destructor(object);
1577         }
1578
1579         ast_variables_destroy(details->object->extended);
1580         ast_free(details->object->id);
1581 }
1582
1583 void *ast_sorcery_generic_alloc(size_t size, ao2_destructor_fn destructor)
1584 {
1585         void *object = ao2_alloc_options(size + sizeof(struct ast_sorcery_object), sorcery_object_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
1586         struct ast_sorcery_object_details *details = object;
1587
1588         if (!object) {
1589                 return NULL;
1590         }
1591
1592         details->object = object + size;
1593         details->object->destructor = destructor;
1594
1595         return object;
1596 }
1597
1598 void *ast_sorcery_alloc(const struct ast_sorcery *sorcery, const char *type, const char *id)
1599 {
1600         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1601         struct ast_sorcery_object_details *details;
1602
1603         if (!object_type || !object_type->type.item_alloc ||
1604                 !(details = object_type->type.item_alloc(id))) {
1605                 return NULL;
1606         }
1607
1608         if (ast_strlen_zero(id)) {
1609                 char uuid[AST_UUID_STR_LEN];
1610
1611                 ast_uuid_generate_str(uuid, sizeof(uuid));
1612                 details->object->id = ast_strdup(uuid);
1613         } else {
1614                 details->object->id = ast_strdup(id);
1615         }
1616
1617         ast_copy_string(details->object->type, type, sizeof(details->object->type));
1618
1619         if (aco_set_defaults(&object_type->type, id, details)) {
1620                 ao2_ref(details, -1);
1621                 return NULL;
1622         }
1623
1624         return details;
1625 }
1626
1627 void *ast_sorcery_copy(const struct ast_sorcery *sorcery, const void *object)
1628 {
1629         const struct ast_sorcery_object_details *details = object;
1630         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1631         struct ast_sorcery_object_details *copy = ast_sorcery_alloc(sorcery, details->object->type, details->object->id);
1632         RAII_VAR(struct ast_variable *, objectset, NULL, ast_variables_destroy);
1633         int res = 0;
1634
1635         if (!copy) {
1636                 return NULL;
1637         } else if (object_type->copy) {
1638                 res = object_type->copy(object, copy);
1639         } else if ((objectset = ast_sorcery_objectset_create(sorcery, object))) {
1640                 res = ast_sorcery_objectset_apply(sorcery, copy, objectset);
1641         } else {
1642                 /* No native copy available and could not create an objectset, this copy has failed */
1643                 res = -1;
1644         }
1645
1646         if (res) {
1647                 ao2_cleanup(copy);
1648                 copy = NULL;
1649         }
1650
1651         return copy;
1652 }
1653
1654 int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes)
1655 {
1656         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, ast_sorcery_object_get_type(original), OBJ_KEY), ao2_cleanup);
1657
1658         *changes = NULL;
1659
1660         if (strcmp(ast_sorcery_object_get_type(original), ast_sorcery_object_get_type(modified))) {
1661                 return -1;
1662         }
1663
1664         if (original == modified) {
1665                 return 0;
1666         } else if (!object_type->diff) {
1667                 RAII_VAR(struct ast_variable *, objectset1, NULL, ast_variables_destroy);
1668                 RAII_VAR(struct ast_variable *, objectset2, NULL, ast_variables_destroy);
1669
1670                 objectset1 = ast_sorcery_objectset_create(sorcery, original);
1671                 objectset2 = ast_sorcery_objectset_create(sorcery, modified);
1672
1673                 return ast_sorcery_changeset_create(objectset1, objectset2, changes);
1674         } else {
1675                 return object_type->diff(original, modified, changes);
1676         }
1677 }
1678
1679 /*! \brief Structure used when calling create, update, or delete */
1680 struct sorcery_details {
1681         /*! \brief Pointer to the sorcery instance */
1682         const struct ast_sorcery *sorcery;
1683         /*! \brief Pointer to the object itself */
1684         void *obj;
1685 };
1686
1687 /*! \brief Internal function used to create an object in caching wizards */
1688 static int sorcery_cache_create(void *obj, void *arg, int flags)
1689 {
1690         const struct ast_sorcery_object_wizard *object_wizard = obj;
1691         const struct sorcery_details *details = arg;
1692
1693         if (!object_wizard->caching || !object_wizard->wizard->callbacks.create) {
1694                 return 0;
1695         }
1696
1697         object_wizard->wizard->callbacks.create(details->sorcery, object_wizard->data, details->obj);
1698
1699         return 0;
1700 }
1701
1702 void *ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
1703 {
1704         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1705         void *object = NULL;
1706         struct ao2_iterator i;
1707         struct ast_sorcery_object_wizard *wizard;
1708         unsigned int cached = 0;
1709
1710         if (!object_type || ast_strlen_zero(id)) {
1711                 return NULL;
1712         }
1713
1714         i = ao2_iterator_init(object_type->wizards, 0);
1715         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1716                 if (wizard->wizard->callbacks.retrieve_id &&
1717                         !(object = wizard->wizard->callbacks.retrieve_id(sorcery, wizard->data, object_type->name, id))) {
1718                         continue;
1719                 }
1720
1721                 cached = wizard->caching;
1722
1723                 ao2_ref(wizard, -1);
1724                 break;
1725         }
1726         ao2_iterator_destroy(&i);
1727
1728         if (!cached && object) {
1729                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1730         }
1731
1732         return object;
1733 }
1734
1735 void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields)
1736 {
1737         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1738         void *object = NULL;
1739         struct ao2_iterator i;
1740         struct ast_sorcery_object_wizard *wizard;
1741         unsigned int cached = 0;
1742
1743         if (!object_type) {
1744                 return NULL;
1745         }
1746
1747         /* If returning multiple objects create a container to store them in */
1748         if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1749                 if (!(object = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1750                         return NULL;
1751                 }
1752         }
1753
1754         /* Inquire with the available wizards for retrieval */
1755         i = ao2_iterator_init(object_type->wizards, 0);
1756         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1757                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE)) {
1758                         if (wizard->wizard->callbacks.retrieve_multiple) {
1759                                 wizard->wizard->callbacks.retrieve_multiple(sorcery, wizard->data, object_type->name, object, fields);
1760                         }
1761                 } else if (fields && wizard->wizard->callbacks.retrieve_fields) {
1762                         if (wizard->wizard->callbacks.retrieve_fields) {
1763                                 object = wizard->wizard->callbacks.retrieve_fields(sorcery, wizard->data, object_type->name, fields);
1764                         }
1765                 }
1766
1767                 if ((flags & AST_RETRIEVE_FLAG_MULTIPLE) || !object) {
1768                         continue;
1769                 }
1770
1771                 cached = wizard->caching;
1772
1773                 ao2_ref(wizard, -1);
1774                 break;
1775         }
1776         ao2_iterator_destroy(&i);
1777
1778         /* If we are returning a single object and it came from a non-cache source create it in any caches */
1779         if (!(flags & AST_RETRIEVE_FLAG_MULTIPLE) && !cached && object) {
1780                 ao2_callback(object_type->wizards, 0, sorcery_cache_create, object);
1781         }
1782
1783         return object;
1784 }
1785
1786 struct ao2_container *ast_sorcery_retrieve_by_regex(const struct ast_sorcery *sorcery, const char *type, const char *regex)
1787 {
1788         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
1789         struct ao2_container *objects;
1790         struct ao2_iterator i;
1791         struct ast_sorcery_object_wizard *wizard;
1792
1793         if (!object_type || !(objects = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) {
1794                 return NULL;
1795         }
1796
1797         i = ao2_iterator_init(object_type->wizards, 0);
1798         for (; (wizard = ao2_iterator_next(&i)); ao2_ref(wizard, -1)) {
1799                 if (!wizard->wizard->callbacks.retrieve_regex) {
1800                         continue;
1801                 }
1802
1803                 wizard->wizard->callbacks.retrieve_regex(sorcery, wizard->data, object_type->name, objects, regex);
1804         }
1805         ao2_iterator_destroy(&i);
1806
1807         return objects;
1808 }
1809
1810 /*! \brief Internal function which returns if the wizard has created the object */
1811 static int sorcery_wizard_create(void *obj, void *arg, int flags)
1812 {
1813         const struct ast_sorcery_object_wizard *object_wizard = obj;
1814         const struct sorcery_details *details = arg;
1815
1816         if (!object_wizard->wizard->callbacks.create) {
1817                 ast_assert(0);
1818                 ast_log(LOG_ERROR, "Sorcery wizard '%s' doesn't contain a 'create' virtual function.\n",
1819                         object_wizard->wizard->callbacks.name);
1820                 return 0;
1821         }
1822         return (!object_wizard->caching && !object_wizard->wizard->callbacks.create(details->sorcery, object_wizard->data, details->obj)) ? CMP_MATCH | CMP_STOP : 0;
1823 }
1824
1825 /*! \brief Internal callback function which notifies an individual observer that an object has been created */
1826 static int sorcery_observer_notify_create(void *obj, void *arg, int flags)
1827 {
1828         const struct ast_sorcery_object_type_observer *observer = obj;
1829
1830         if (observer->callbacks->created) {
1831                 observer->callbacks->created(arg);
1832         }
1833
1834         return 0;
1835 }
1836
1837 /*! \brief Internal callback function which notifies observers that an object has been created */
1838 static int sorcery_observers_notify_create(void *data)
1839 {
1840         struct sorcery_observer_invocation *invocation = data;
1841
1842         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_create, invocation->object);
1843         ao2_cleanup(invocation);
1844
1845         return 0;
1846 }
1847
1848 int ast_sorcery_create(const struct ast_sorcery *sorcery, void *object)
1849 {
1850         const struct ast_sorcery_object_details *details = object;
1851         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1852         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1853         struct sorcery_details sdetails = {
1854                 .sorcery = sorcery,
1855                 .obj = object,
1856         };
1857
1858         if (!object_type) {
1859                 return -1;
1860         }
1861
1862         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_create, &sdetails)) &&
1863                 ao2_container_count(object_type->observers)) {
1864                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1865
1866                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_create, invocation)) {
1867                         ao2_cleanup(invocation);
1868                 }
1869         }
1870
1871         return object_wizard ? 0 : -1;
1872 }
1873
1874 /*! \brief Internal callback function which notifies an individual observer that an object has been updated */
1875 static int sorcery_observer_notify_update(void *obj, void *arg, int flags)
1876 {
1877         const struct ast_sorcery_object_type_observer *observer = obj;
1878
1879         if (observer->callbacks->updated) {
1880                 observer->callbacks->updated(arg);
1881         }
1882
1883         return 0;
1884 }
1885
1886 /*! \brief Internal callback function which notifies observers that an object has been updated */
1887 static int sorcery_observers_notify_update(void *data)
1888 {
1889         struct sorcery_observer_invocation *invocation = data;
1890
1891         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_update, invocation->object);
1892         ao2_cleanup(invocation);
1893
1894         return 0;
1895 }
1896
1897 /*! \brief Internal function which returns if a wizard has updated the object */
1898 static int sorcery_wizard_update(void *obj, void *arg, int flags)
1899 {
1900         const struct ast_sorcery_object_wizard *object_wizard = obj;
1901         const struct sorcery_details *details = arg;
1902
1903         return (object_wizard->wizard->callbacks.update && !object_wizard->wizard->callbacks.update(details->sorcery, object_wizard->data, details->obj) &&
1904                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1905 }
1906
1907 int ast_sorcery_update(const struct ast_sorcery *sorcery, void *object)
1908 {
1909         const struct ast_sorcery_object_details *details = object;
1910         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1911         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1912         struct sorcery_details sdetails = {
1913                 .sorcery = sorcery,
1914                 .obj = object,
1915         };
1916
1917         if (!object_type) {
1918                 return -1;
1919         }
1920
1921         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_update, &sdetails)) &&
1922                 ao2_container_count(object_type->observers)) {
1923                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1924
1925                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_update, invocation)) {
1926                         ao2_cleanup(invocation);
1927                 }
1928         }
1929
1930         return object_wizard ? 0 : -1;
1931 }
1932
1933 /*! \brief Internal callback function which notifies an individual observer that an object has been deleted */
1934 static int sorcery_observer_notify_delete(void *obj, void *arg, int flags)
1935 {
1936         const struct ast_sorcery_object_type_observer *observer = obj;
1937
1938         if (observer->callbacks->deleted) {
1939                 observer->callbacks->deleted(arg);
1940         }
1941
1942         return 0;
1943 }
1944
1945 /*! \brief Internal callback function which notifies observers that an object has been deleted */
1946 static int sorcery_observers_notify_delete(void *data)
1947 {
1948         struct sorcery_observer_invocation *invocation = data;
1949
1950         ao2_callback(invocation->object_type->observers, OBJ_NODATA, sorcery_observer_notify_delete, invocation->object);
1951         ao2_cleanup(invocation);
1952
1953         return 0;
1954 }
1955
1956 /*! \brief Internal function which returns if a wizard has deleted the object */
1957 static int sorcery_wizard_delete(void *obj, void *arg, int flags)
1958 {
1959         const struct ast_sorcery_object_wizard *object_wizard = obj;
1960         const struct sorcery_details *details = arg;
1961
1962         return (object_wizard->wizard->callbacks.delete && !object_wizard->wizard->callbacks.delete(details->sorcery, object_wizard->data, details->obj) &&
1963                 !object_wizard->caching) ? CMP_MATCH | CMP_STOP : 0;
1964 }
1965
1966 int ast_sorcery_delete(const struct ast_sorcery *sorcery, void *object)
1967 {
1968         const struct ast_sorcery_object_details *details = object;
1969         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, details->object->type, OBJ_KEY), ao2_cleanup);
1970         RAII_VAR(struct ast_sorcery_object_wizard *, object_wizard, NULL, ao2_cleanup);
1971         struct sorcery_details sdetails = {
1972                 .sorcery = sorcery,
1973                 .obj = object,
1974         };
1975
1976         if (!object_type) {
1977                 return -1;
1978         }
1979
1980         if ((object_wizard = ao2_callback(object_type->wizards, 0, sorcery_wizard_delete, &sdetails)) &&
1981                 ao2_container_count(object_type->observers)) {
1982                 struct sorcery_observer_invocation *invocation = sorcery_observer_invocation_alloc(object_type, object);
1983
1984                 if (invocation && ast_taskprocessor_push(object_type->serializer, sorcery_observers_notify_delete, invocation)) {
1985                         ao2_cleanup(invocation);
1986                 }
1987         }
1988
1989         return object_wizard ? 0 : -1;
1990 }
1991
1992 void ast_sorcery_unref(struct ast_sorcery *sorcery)
1993 {
1994         if (sorcery) {
1995                 /* One ref for what we just released, the other for the instances container. */
1996                 ao2_wrlock(instances);
1997                 if (ao2_ref(sorcery, -1) == 2) {
1998                         ao2_unlink_flags(instances, sorcery, OBJ_NOLOCK);
1999                 }
2000                 ao2_unlock(instances);
2001         }
2002 }
2003
2004 const char *ast_sorcery_object_get_id(const void *object)
2005 {
2006         const struct ast_sorcery_object_details *details = object;
2007         return details->object->id;
2008 }
2009
2010 const char *ast_sorcery_object_get_type(const void *object)
2011 {
2012         const struct ast_sorcery_object_details *details = object;
2013         return details->object->type;
2014 }
2015
2016 const char *ast_sorcery_object_get_extended(const void *object, const char *name)
2017 {
2018         const struct ast_sorcery_object_details *details = object;
2019         struct ast_variable *field;
2020
2021         for (field = details->object->extended; field; field = field->next) {
2022                 if (!strcmp(field->name + 1, name)) {
2023                         return field->value;
2024                 }
2025         }
2026
2027         return NULL;
2028 }
2029
2030 int ast_sorcery_object_set_extended(const void *object, const char *name, const char *value)
2031 {
2032         RAII_VAR(struct ast_variable *, field, NULL, ast_variables_destroy);
2033         struct ast_variable *extended = ast_variable_new(name, value, ""), *previous = NULL;
2034         const struct ast_sorcery_object_details *details = object;
2035
2036         if (!extended) {
2037                 return -1;
2038         }
2039
2040         for (field = details->object->extended; field; previous = field, field = field->next) {
2041                 if (!strcmp(field->name, name)) {
2042                         if (previous) {
2043                                 previous->next = field->next;
2044                         } else {
2045                                 details->object->extended = field->next;
2046                         }
2047                         field->next = NULL;
2048                         break;
2049                 }
2050         }
2051
2052         extended->next = details->object->extended;
2053         details->object->extended = extended;
2054
2055         return 0;
2056 }
2057
2058 int ast_sorcery_observer_add(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
2059 {
2060         RAII_VAR(struct ast_sorcery_object_type *, object_type, ao2_find(sorcery->types, type, OBJ_KEY), ao2_cleanup);
2061         struct ast_sorcery_object_type_observer *observer;
2062         int res;
2063
2064         if (!object_type || !callbacks) {
2065                 return -1;
2066         }
2067
2068         if (!(observer = ao2_alloc(sizeof(*observer), NULL))) {
2069                 return -1;
2070         }
2071
2072         observer->callbacks = callbacks;
2073         res = 0;
2074         if (!ao2_link(object_type->observers, observer)) {
2075                 res = -1;
2076         }
2077         ao2_ref(observer, -1);
2078
2079         return res;
2080 }
2081
2082 /*! \brief Internal callback function for removing an observer */
2083 static int sorcery_observer_remove(void *obj, void *arg, int flags)
2084 {
2085         const struct ast_sorcery_object_type_observer *observer = obj;
2086
2087         return (observer->callbacks == arg) ? CMP_MATCH | CMP_STOP : 0;
2088 }
2089
2090 void ast_sorcery_observer_remove(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
2091 {
2092         RAII_VAR(struct ast_sorcery_object_type *, object_type, NULL, ao2_cleanup);
2093         struct ast_sorcery_observer *cbs = (struct ast_sorcery_observer *) callbacks;/* Remove const for traversal. */
2094
2095         if (!sorcery) {
2096                 return;
2097         }
2098         object_type = ao2_find(sorcery->types, type, OBJ_KEY);
2099         if (!object_type) {
2100                 return;
2101         }
2102
2103         ao2_callback(object_type->observers, OBJ_NODATA | OBJ_UNLINK,
2104                 sorcery_observer_remove, cbs);
2105 }
2106
2107 int ast_sorcery_object_id_sort(const void *obj, const void *arg, int flags)
2108 {
2109         const char *right_key = arg;
2110         int cmp;
2111
2112         switch (flags & OBJ_SEARCH_MASK) {
2113         case OBJ_SEARCH_OBJECT:
2114                 right_key = ast_sorcery_object_get_id(arg);
2115                 /* Fall through */
2116         case OBJ_SEARCH_KEY:
2117                 cmp = strcmp(ast_sorcery_object_get_id(obj), right_key);
2118                 break;
2119         case OBJ_SEARCH_PARTIAL_KEY:
2120                 cmp = strncmp(ast_sorcery_object_get_id(obj), right_key, strlen(right_key));
2121                 break;
2122         default:
2123                 cmp = 0;
2124                 break;
2125         }
2126         return cmp;
2127 }
2128
2129 int ast_sorcery_object_id_compare(void *obj, void *arg, int flags)
2130 {
2131         const char *right_key = arg;
2132         int cmp = 0;
2133
2134         switch (flags & OBJ_SEARCH_MASK) {
2135         case OBJ_SEARCH_OBJECT:
2136                 right_key = ast_sorcery_object_get_id(arg);
2137                 /* Fall through */
2138         case OBJ_SEARCH_KEY:
2139                 if (strcmp(ast_sorcery_object_get_id(obj), right_key) == 0) {
2140                         cmp = CMP_MATCH | CMP_STOP;
2141                 }
2142                 break;
2143         case OBJ_SEARCH_PARTIAL_KEY:
2144                 if (strncmp(ast_sorcery_object_get_id(obj), right_key, strlen(right_key)) == 0) {
2145                         cmp = CMP_MATCH;
2146                 }
2147                 break;
2148         default:
2149                 cmp = 0;
2150                 break;
2151         }
2152         return cmp;
2153 }
2154
2155 int ast_sorcery_object_id_hash(const void *obj, int flags) {
2156         if (flags & OBJ_SEARCH_OBJECT) {
2157                 return ast_str_hash(ast_sorcery_object_get_id(obj));
2158         } else if (flags & OBJ_SEARCH_KEY) {
2159                 return ast_str_hash(obj);
2160         }
2161         return -1;
2162 }
2163
2164 struct ast_sorcery_object_type *ast_sorcery_get_object_type(const struct ast_sorcery *sorcery,
2165                 const char *type)
2166 {
2167         return ao2_find(sorcery->types, type, OBJ_SEARCH_KEY);
2168 }
2169
2170 static int is_registered_cb(void *obj, void *arg, int flags)
2171 {
2172         struct ast_sorcery_object_field *object_field = obj;
2173         char *name = arg;
2174         int rc = 0;
2175
2176         if (object_field->name_regex
2177                 && !regexec(object_field->name_regex, name, 0, NULL, 0)) {
2178                 rc = CMP_MATCH | CMP_STOP;
2179         }
2180
2181         return rc;
2182 }
2183
2184 int ast_sorcery_is_object_field_registered(const struct ast_sorcery_object_type *object_type,
2185                 const char *field_name)
2186 {
2187         struct ast_sorcery_object_field *object_field;
2188         int res = 1;
2189
2190         ast_assert(object_type != NULL);
2191
2192         object_field = ao2_find(object_type->fields, field_name, OBJ_SEARCH_KEY);
2193
2194         if (!object_field) {
2195                 object_field = ao2_callback(object_type->fields, 0, is_registered_cb, (char *)field_name);
2196         }
2197
2198         if (!object_field) {
2199                 res = 0;
2200         }
2201
2202         ao2_cleanup(object_field);
2203         return res;
2204 }