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