6f3ec3a5293359040b446200fb044d35e4fcce8d
[asterisk/asterisk.git] / include / asterisk / sorcery.h
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  * \brief Sorcery Data Access Layer API
21  * \author Joshua Colp <jcolp@digium.com>
22  * \ref AstSorcery
23  */
24
25 /*!
26  * \page AstSorcery Data Access Layer API
27  *
28  * Sorcery is a unifying data access layer which utilizes the configuration framework,
29  * realtime, and astdb to allow object creation, retrieval, updating, and deletion.
30  *
31  * \par Initialization
32  *
33  * Usage of sorcery is accomplished by first opening a sorcery structure. This structure holds
34  * all information about the object types, object fields, and object mappings. All API functions
35  * require the sorcery structure to operate. When sorcery is no longer needed the structure can
36  * be unreferenced using \ref ast_sorcery_unref
37  *
38  * Once opened the sorcery structure must have object mappings applied to it. This maps the
39  * object types to their respective wizards (object storage modules). If the developer would like
40  * to allow the user to configure this using the sorcery.conf configuration file the
41  * \ref ast_sorcery_apply_config API call can be used to read in the configuration file and apply the
42  * mappings. If the storage of the object types are such that a default wizard can be used this can
43  * be applied using the \ref ast_sorcery_apply_default API call. Note that the default mappings will not
44  * override configured mappings. They are only used in the case where no configured mapping exists.
45  *
46  * Configuring object mappings implicitly creates a basic version of an object type. The object type
47  * must be fully registered, however, using the \ref ast_sorcery_object_type_register API call before any
48  * objects of the type can be allocated, created, or retrieved.
49  *
50  * Once the object type itself has been fully registered the individual fields within the object must
51  * be registered using the \ref ast_sorcery_object_field_register API call. Note that not all fields *need*
52  * be registered. Only fields that should be accessible using the sorcery API have to be registered.
53  *
54  * \par Creating Objects
55  *
56  * Before an object can be created within the sorcery API it must first be allocated using the
57  * \ref ast_sorcery_alloc API call. This allocates a new instance of the object, sets sorcery specific
58  * details, and applies default values to the object. A unique identifier can optionally be specified
59  * when allocating an object. If it is not provided one will be automatically generated. Allocating
60  * an object does not create it within any object storage mechanisms that are configured for the
61  * object type. Creation must explicitly be done using the \ref ast_sorcery_create API call. This API call
62  * passes the object to each configured object storage mechanism for the object type until one
63  * successfully persists the object.
64  *
65  * \par Retrieving Objects
66  *
67  * To retrieve a single object using its unique identifier the \ref ast_sorcery_retrieve_by_id API call
68  * can be used.
69  *
70  * To retrieve potentially multiple objects using specific fields the \ref ast_sorcery_retrieve_by_fields
71  * API call can be used. The behavior of this API call is controlled using different flags. If the
72  * AST_RETRIEVE_FLAG_MULTIPLE flag is used a container will be returned which contains all matching objects.
73  * To retrieve all objects the AST_RETRIEVE_FLAG_ALL flag can be specified. Note that when specifying this flag
74  * you do not need to pass any fields.
75  *
76  * Both API calls return shared objects. Modification of the object can not occur until it has been copied.
77  *
78  * \par Updating Objects
79  *
80  * As retrieved objects may be shared the first step to updating the object with new details is creating a
81  * copy using the \ref ast_sorcery_copy API call. This will return a new object which is specific to the caller.
82  * Any field within the object may be modified as needed. Once changes are done the changes can be committed
83  * using the \ref ast_sorcery_update API call. Note that as the copied object is specific to the caller it must
84  * be unreferenced after use.
85  *
86  * \par Deleting Objects
87  *
88  * To delete an object simply call the \ref ast_sorcery_delete API call with an object retrieved using the
89  * ast_sorcery_retrieve_by_* API calls or a copy returned from \ref ast_sorcery_copy.
90  */
91
92 #ifndef _ASTERISK_SORCERY_H
93 #define _ASTERISK_SORCERY_H
94
95 #if defined(__cplusplus) || defined(c_plusplus)
96 extern "C" {
97 #endif
98
99 #include "asterisk/config_options.h"
100 #include "asterisk/uuid.h"
101
102 /*! \brief Maximum size of an object type */
103 #define MAX_OBJECT_TYPE 64
104
105 /*!
106  * \brief Retrieval flags
107  */
108 enum ast_sorcery_retrieve_flags {
109         /*! \brief Default retrieval flags */
110         AST_RETRIEVE_FLAG_DEFAULT = 0,
111
112         /*! \brief Return all matching objects */
113         AST_RETRIEVE_FLAG_MULTIPLE = (1 << 0),
114
115         /*! \brief Perform no matching, return all objects */
116         AST_RETRIEVE_FLAG_ALL = (1 << 1),
117 };
118
119 /*! \brief Forward declaration for the sorcery main structure */
120 struct ast_sorcery;
121
122 /*!
123  * \brief A callback function for translating a value into a string
124  *
125  * \param obj Object to get value from
126  * \param args Where the field is
127  * \param buf Pointer to the buffer that the handler has created which contains the field value
128  *
129  * \retval 0 success
130  * \retval -1 failure
131  */
132 typedef int (*sorcery_field_handler)(const void *obj, const intptr_t *args, char **buf);
133
134 /*!
135  * \brief A callback function for performing a transformation on an object set
136  *
137  * \param set The existing object set
138  *
139  * \retval non-NULL new object set if changed
140  * \retval NULL if no changes present
141  *
142  * \note The returned ast_variable list must be *new*. You can not return the input set.
143  */
144 typedef struct ast_variable *(*sorcery_transform_handler)(struct ast_variable *set);
145
146 /*!
147  * \brief A callback function for when an object set is successfully applied to an object
148  *
149  * \param sorcery Sorcery structure in use
150  * \param obj The object itself
151  */
152 typedef void (*sorcery_apply_handler)(const struct ast_sorcery *sorcery, void *obj);
153
154 /*!
155  * \brief A callback function for copying the contents of one object to another
156  *
157  * \param src The source object
158  * \param dst The destination object
159  *
160  * \retval 0 success
161  * \retval -1 failure
162  */
163 typedef int (*sorcery_copy_handler)(const void *src, void *dst);
164
165 /*!
166  * \brief A callback function for generating a changeset between two objects
167  *
168  * \param original The original object
169  * \param modified The modified object
170  * \param changes The changeset
171  *
172  * \param 0 success
173  * \param -1 failure
174  */
175 typedef int (*sorcery_diff_handler)(const void *original, const void *modified, struct ast_variable **changes);
176
177 /*! \brief Interface for a sorcery wizard */
178 struct ast_sorcery_wizard {
179         /*! \brief Name of the wizard */
180         const char *name;
181
182         /*! \brief Pointer to the Asterisk module this wizard is implemented by */
183         struct ast_module *module;
184
185         /*! \brief Callback for opening a wizard */
186         void *(*open)(const char *data);
187
188         /*! \brief Optional callback for loading persistent objects */
189         void (*load)(void *data, const struct ast_sorcery *sorcery, const char *type);
190
191         /*! \brief Optional callback for reloading persistent objects */
192         void (*reload)(void *data, const struct ast_sorcery *sorcery, const char *type);
193
194         /*! \brief Callback for creating an object */
195         int (*create)(void *data, void *object);
196
197         /*! \brief Callback for retrieving an object using an id */
198         void *(*retrieve_id)(const struct ast_sorcery *sorcery, void *data, const char *type, const char *id);
199
200         /*! \brief Optional callback for retrieving an object using fields */
201         void *(*retrieve_fields)(const struct ast_sorcery *sorcery, void *data, const char *type, const struct ast_variable *fields);
202
203         /*! \brief Optional callback for retrieving multiple objects using some optional field criteria */
204         void (*retrieve_multiple)(const struct ast_sorcery *sorcery, void *data, const char *type, struct ao2_container *objects, const struct ast_variable *fields);
205
206         /*! \brief Callback for updating an object */
207         int (*update)(void *data, void *object);
208
209         /*! \brief Callback for deleting an object */
210         int (*delete)(void *data, void *object);
211
212         /*! \brief Callback for closing a wizard */
213         void (*close)(void *data);
214 };
215
216 /*! \brief Structure which contains details about a sorcery object */
217 struct ast_sorcery_object_details {
218         /*! \brief Unique identifier of this object */
219         char id[AST_UUID_STR_LEN];
220
221         /*! \brief Type of object */
222         char type[MAX_OBJECT_TYPE];
223 };
224
225 /*! \brief Macro which must be used at the beginning of each sorcery capable object */
226 #define SORCERY_OBJECT(details)                    \
227 struct {                                           \
228         struct ast_sorcery_object_details details; \
229 }                                                  \
230
231 /*!
232  * \brief Initialize the sorcery API
233  *
234  * \retval 0 success
235  * \retval -1 failure
236  */
237 int ast_sorcery_init(void);
238
239 /*!
240  * \brief Register a sorcery wizard
241  *
242  * \param interface Pointer to a wizard interface
243  * \param module Pointer to the module implementing the interface
244  *
245  * \retval 0 success
246  * \retval -1 failure
247  */
248 int __ast_sorcery_wizard_register(const struct ast_sorcery_wizard *interface, struct ast_module *module);
249
250 /*!
251  * \brief See \ref __ast_sorcery_wizard_register()
252  */
253 #define ast_sorcery_wizard_register(interface) __ast_sorcery_wizard_register(interface, ast_module_info ? ast_module_info->self : NULL)
254
255 /*!
256  * \brief Unregister a sorcery wizard
257  *
258  * \param interface Pointer to the wizard interface
259  *
260  * \retval 0 success
261  * \retval -1 failure
262  */
263 int ast_sorcery_wizard_unregister(const struct ast_sorcery_wizard *interface);
264
265 /*!
266  * \brief Open a new sorcery structure
267  *
268  * \retval non-NULL success
269  * \retval NULL if allocation failed
270  */
271 struct ast_sorcery *ast_sorcery_open(void);
272
273 /*!
274  * \brief Apply configured wizard mappings
275  *
276  * \param sorcery Pointer to a sorcery structure
277  * \param name Name of the category to use within the configuration file, normally the module name
278  *
279  * \retval 0 success
280  * \retval -1 failure
281  */
282 int ast_sorcery_apply_config(struct ast_sorcery *sorcery, const char *name);
283
284 /*!
285  * \brief Apply default object wizard mappings
286  *
287  * \param sorcery Pointer to a sorcery structure
288  * \param type Type of object to apply to
289  * \param name Name of the wizard to use
290  * \param data Data to be passed to wizard
291  *
292  * \retval 0 success
293  * \retval -1 failure
294  *
295  * \note This should be called *after* applying configuration sourced mappings
296  *
297  * \note Only a single default can exist per object type
298  */
299 int ast_sorcery_apply_default(struct ast_sorcery *sorcery, const char *type, const char *name, const char *data);
300
301 /*!
302  * \brief Register an object type
303  *
304  * \param sorcery Pointer to a sorcery structure
305  * \param type Type of object
306  * \param alloc Required object allocation callback
307  * \param transform Optional transformation callback
308  * \param apply Optional object set apply callback
309  *
310  * \retval 0 success
311  * \retval -1 failure
312  */
313 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);
314
315 /*!
316  * \brief Set the copy handler for an object type
317  *
318  * \param sorcery Pointer to a sorcery structure
319  * \param type Type of object
320  * \param copy Copy handler
321  */
322 void ast_sorcery_object_set_copy_handler(struct ast_sorcery *sorcery, const char *type, sorcery_copy_handler copy);
323
324 /*!
325  * \brief Set the diff handler for an object type
326  *
327  * \param sorcery Pointer to a sorcery structure
328  * \param type Type of object
329  * \param diff Diff handler
330  */
331 void ast_sorcery_object_set_diff_handler(struct ast_sorcery *sorcery, const char *type, sorcery_diff_handler diff);
332
333 /*!
334  * \brief Register a field within an object
335  *
336  * \param sorcery Pointer to a sorcery structure
337  * \param type Type of object
338  * \param name Name of the field
339  * \param default_val Default value of the field
340  * \param opt_type Option type
341  * \param flags Option type specific flags
342  *
343  * \retval 0 success
344  * \retval -1 failure
345  */
346 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,
347                                         aco_option_handler config_handler, sorcery_field_handler sorcery_handler, unsigned int flags, size_t argc, ...);
348
349 /*!
350  * \brief Register a field within an object
351  *
352  * \param sorcery Pointer to a sorcery structure
353  * \param type Type of object
354  * \param name Name of the field
355  * \param default_val Default value of the field
356  * \param opt_type Option type
357  * \param flags Option type specific flags
358  *
359  * \retval 0 success
360  * \retval -1 failure
361  */
362 #define ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, flags, ...) \
363     __ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, NULL, NULL, flags, VA_NARGS(__VA_ARGS__), __VA_ARGS__)
364
365 /*!
366  * \brief Register a field within an object with custom handlers
367  *
368  * \param sorcery Pointer to a sorcery structure
369  * \param type Type of object
370  * \param name Name of the field
371  * \param default_val Default value of the field
372  * \param config_handler Custom configuration handler
373  * \param sorcery_handler Custom sorcery handler
374  * \param flags Option type specific flags
375  *
376  * \retval 0 success
377  * \retval -1 failure
378  */
379 #define ast_sorcery_object_field_register_custom(sorcery, type, name, default_val, config_handler, sorcery_handler, flags, ...) \
380     __ast_sorcery_object_field_register(sorcery, type, name, default_val, OPT_CUSTOM_T, config_handler, sorcery_handler, flags, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
381
382 /*!
383  * \brief Inform any wizards to load persistent objects
384  *
385  * \param sorcery Pointer to a sorcery structure
386  */
387 void ast_sorcery_load(const struct ast_sorcery *sorcery);
388
389 /*!
390  * \brief Inform any wizards of a specific object type to load persistent objects
391  *
392  * \param sorcery Pointer to a sorcery structure
393  * \param type Name of the object type to load
394  */
395 void ast_sorcery_load_object(const struct ast_sorcery *sorcery, const char *type);
396
397 /*!
398  * \brief Inform any wizards to reload persistent objects
399  *
400  * \param sorcery Pointer to a sorcery structure
401  */
402 void ast_sorcery_reload(const struct ast_sorcery *sorcery);
403
404 /*!
405  * \brief Inform any wizards of a specific object type to reload persistent objects
406  *
407  * \param sorcery Pointer to a sorcery structure
408  * \param type Name of the object type to reload
409  */
410 void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *type);
411
412 /*!
413  * \brief Increase the reference count of a sorcery structure
414  *
415  * \param sorcery Pointer to a sorcery structure
416  */
417 void ast_sorcery_ref(struct ast_sorcery *sorcery);
418
419 /*!
420  * \brief Create an object set (KVP list) for an object
421  *
422  * \param sorcery Pointer to a sorcery structure
423  * \param object Pointer to a sorcery object
424  *
425  * \retval non-NULL success
426  * \retval NULL if error occurred
427  *
428  * \note The returned ast_variable list must be destroyed using ast_variables_destroy
429  */
430 struct ast_variable *ast_sorcery_objectset_create(const struct ast_sorcery *sorcery, const void *object);
431
432 /*!
433  * \brief Apply an object set (KVP list) to an object
434  *
435  * \param sorcery Pointer to a sorcery structure
436  * \param object Pointer to a sorcery object
437  * \param objectset Object set itself
438  *
439  * \retval 0 success
440  * \retval -1 failure
441  *
442  * \note This operation is *not* atomic. If this fails it is possible for the object to be left with a partially
443  *       applied object set.
444  */
445 int ast_sorcery_objectset_apply(const struct ast_sorcery *sorcery, void *object, struct ast_variable *objectset);
446
447 /*!
448  * \brief Create a changeset given two object sets
449  *
450  * \param original Original object set
451  * \param modified Modified object set
452  * \param changes Pointer to hold any changes between the object sets
453  *
454  * \retval 0 success
455  * \retval -1 failure
456  *
457  * \note The returned ast_variable list must be destroyed using ast_variables_destroy
458  */
459 int ast_sorcery_changeset_create(const struct ast_variable *original, const struct ast_variable *modified, struct ast_variable **changes);
460
461 /*!
462  * \brief Allocate an object
463  *
464  * \param sorcery Pointer to a sorcery structure
465  * \param type Type of object to allocate
466  * \param id Optional unique identifier, if none is provided one will be generated
467  *
468  * \retval non-NULL success
469  * \retval NULL failure
470  */
471 void *ast_sorcery_alloc(const struct ast_sorcery *sorcery, const char *type, const char *id);
472
473 /*!
474  * \brief Create a copy of an object
475  *
476  * \param sorcery Pointer to a sorcery structure
477  * \param object Existing object
478  *
479  * \retval non-NULL success
480  * \retval NULL failure
481  */
482 void *ast_sorcery_copy(const struct ast_sorcery *sorcery, const void *object);
483
484 /*!
485  * \brief Create a changeset of two objects
486  *
487  * \param sorcery Pointer to a sorcery structure
488  * \param original Original object
489  * \param modified Modified object
490  * \param changes Pointer which will be populated with changes if any exist
491  *
492  * \retval 0 success
493  * \retval -1 failure
494  *
495  * \note The returned ast_variable list must be destroyed using ast_variables_destroy
496  *
497  * \note While the objects must be of the same type they do not have to be the same object
498  */
499 int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes);
500
501 /*!
502  * \brief Create and potentially persist an object using an available wizard
503  *
504  * \param sorcery Pointer to a sorcery structure
505  * \param object Pointer to a sorcery object
506  *
507  * \retval 0 success
508  * \retval -1 failure
509  */
510 int ast_sorcery_create(const struct ast_sorcery *sorcery, void *object);
511
512 /*!
513  * \brief Retrieve an object using its unique identifier
514  *
515  * \param sorcery Pointer to a sorcery structure
516  * \param type Type of object to retrieve
517  * \param id Unique object identifier
518  *
519  * \retval non-NULL if found
520  * \retval NULL if not found
521  */
522 void *ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id);
523
524 /*!
525  * \brief Retrieve an object or multiple objects using specific fields
526  *
527  * \param sorcery Pointer to a sorcery structure
528  * \param type Type of object to retrieve
529  * \param flags Flags to control behavior
530  * \param fields Optional jbject fields and values to match against
531  *
532  * \retval non-NULL if found
533  * \retval NULL if not found
534  *
535  * \note If the AST_RETRIEVE_FLAG_MULTIPLE flag is specified the returned value will be an
536  *       ao2_container that must be unreferenced after use.
537  *
538  * \note If the AST_RETRIEVE_FLAG_ALL flag is used you may omit fields to retrieve all objects
539  *       of the given type.
540  */
541 void *ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields);
542
543 /*!
544  * \brief Update an object
545  *
546  * \param sorcery Pointer to a sorcery structure
547  * \param object Pointer to a sorcery object
548  *
549  * \retval 0 success
550  * \retval -1 failure
551  */
552 int ast_sorcery_update(const struct ast_sorcery *sorcery, void *object);
553
554 /*!
555  * \brief Delete an object
556  *
557  * \param sorcery Pointer to a sorcery structure
558  * \param object Pointer to a sorcery object
559  *
560  * \retval 0 success
561  * \retval -1 failure
562  */
563 int ast_sorcery_delete(const struct ast_sorcery *sorcery, void *object);
564
565 /*!
566  * \brief Decrease the reference count of a sorcery structure
567  *
568  * \param sorcery Pointer to a sorcery structure
569  */
570 void ast_sorcery_unref(struct ast_sorcery *sorcery);
571
572 /*!
573  * \brief Get the unique identifier of a sorcery object
574  *
575  * \param object Pointer to a sorcery object
576  *
577  * \retval unique identifier
578  */
579 const char *ast_sorcery_object_get_id(const void *object);
580
581 /*!
582  * \brief Get the type of a sorcery object
583  *
584  * \param object Pointer to a sorcery object
585  *
586  * \retval type of object
587  */
588 const char *ast_sorcery_object_get_type(const void *object);
589
590 #if defined(__cplusplus) || defined(c_plusplus)
591 }
592 #endif
593
594 #endif /* _ASTERISK_SORCERY_H */