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