mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-20 08:40:16 +00:00
sorcery: Create AST_SORCERY dialplan function.
This patch creates the AST_SORCERY dialplan function which allows someone to retrieve any value from a sorcery-based config file. It's similar to AST_CONFIG. The creation of the function itself was fairly straightforward but it required changes to the underlying sorcery infrastructure that rippled into individual sorcery objects. The changes stemmed from inconsistencies in how sorcery created ast_variable objectsets from sorcery objects and the inconsistency in how individual objects used that feature especially when it came to parameters that can be specified multiple times like contact in aor and match in identify. You can read more here... http://lists.digium.com/pipermail/asterisk-dev/2014-February/065202.html So, what this patch does, besides actually creating the AST_SORCERY function, is the following... * Creates ast_variable_list_append which is a helper to append one ast_variable list to another. * Modifies the ast_sorcery_object_field_register functions to accept the already-defined sorcery_fields_handler callback. * Modifies ast_sorcery_objectset_create to accept a parameter indicating return type preference...a single ast_variable with all values concatenated or an ast_variable list with multiple entries. Also fixed a few bugs. * Modifies individual sorcery object implementations to use the new function definition of the ast_sorcery_object_field_register functions. * Modifies location.c and res_pjsip_endpoint_identifier_ip.c to implement sorcery_fields_handler handlers so they return multiple occurrences as an ast_variable_list. * Added a whole bunch of tests to test_sorcery. (closes issue ASTERISK-22537) Review: http://reviewboard.asterisk.org/r/3254/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@410042 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
George Joseph
@@ -119,6 +119,24 @@ enum ast_sorcery_retrieve_flags {
|
||||
AST_RETRIEVE_FLAG_ALL = (1 << 1),
|
||||
};
|
||||
|
||||
/*!
|
||||
* \brief Field handler flags
|
||||
*/
|
||||
enum ast_sorcery_field_handler_flags {
|
||||
/*! \brief Try both handlers, string first */
|
||||
AST_HANDLER_PREFER_STRING,
|
||||
|
||||
/*! \brief Try both handlers, list first */
|
||||
AST_HANDLER_PREFER_LIST,
|
||||
|
||||
/*! \brief Use string handler only */
|
||||
AST_HANDLER_ONLY_STRING,
|
||||
|
||||
/*! \brief Use list handler only */
|
||||
AST_HANDLER_ONLY_LIST,
|
||||
};
|
||||
|
||||
|
||||
/*! \brief Forward declaration for the sorcery main structure */
|
||||
struct ast_sorcery;
|
||||
|
||||
@@ -465,15 +483,19 @@ int ast_sorcery_object_fields_register(struct ast_sorcery *sorcery, const char *
|
||||
* \param type Type of object
|
||||
* \param name Name of the field
|
||||
* \param default_val Default value of the field
|
||||
* \param config_handler A custom handler for translating the string representation of the fields
|
||||
* \param sorcery_handler A custom handler for translating the native representation of the fields
|
||||
* \param multiple_handler A custom handler for translating the native representation of the fields
|
||||
* \param opt_type Option type
|
||||
* \param flags Option type specific flags
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
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,
|
||||
aco_option_handler config_handler, sorcery_field_handler sorcery_handler, unsigned int flags, unsigned int no_doc,
|
||||
size_t argc, ...);
|
||||
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,
|
||||
aco_option_handler config_handler, sorcery_field_handler sorcery_handler,
|
||||
sorcery_fields_handler multiple_handler, unsigned int flags, unsigned int no_doc, size_t argc, ...);
|
||||
|
||||
/*!
|
||||
* \brief Register a field within an object
|
||||
@@ -489,7 +511,7 @@ int __ast_sorcery_object_field_register(struct ast_sorcery *sorcery, const char
|
||||
* \retval -1 failure
|
||||
*/
|
||||
#define ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, NULL, NULL, flags, 0, VA_NARGS(__VA_ARGS__), __VA_ARGS__)
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, NULL, NULL, NULL, flags, 0, VA_NARGS(__VA_ARGS__), __VA_ARGS__)
|
||||
|
||||
/*!
|
||||
* \brief Register a field within an object without documentation
|
||||
@@ -505,7 +527,7 @@ int __ast_sorcery_object_field_register(struct ast_sorcery *sorcery, const char
|
||||
* \retval -1 failure
|
||||
*/
|
||||
#define ast_sorcery_object_field_register_nodoc(sorcery, type, name, default_val, opt_type, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, NULL, NULL, flags, 1, VA_NARGS(__VA_ARGS__), __VA_ARGS__)
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, NULL, NULL, NULL, flags, 1, VA_NARGS(__VA_ARGS__), __VA_ARGS__)
|
||||
|
||||
/*!
|
||||
* \brief Register a field within an object with custom handlers
|
||||
@@ -516,13 +538,14 @@ int __ast_sorcery_object_field_register(struct ast_sorcery *sorcery, const char
|
||||
* \param default_val Default value of the field
|
||||
* \param config_handler Custom configuration handler
|
||||
* \param sorcery_handler Custom sorcery handler
|
||||
* \param multiple_handler Custom multiple handler
|
||||
* \param flags Option type specific flags
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
#define ast_sorcery_object_field_register_custom(sorcery, type, name, default_val, config_handler, sorcery_handler, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, OPT_CUSTOM_T, config_handler, sorcery_handler, flags, 0, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
|
||||
#define ast_sorcery_object_field_register_custom(sorcery, type, name, default_val, config_handler, sorcery_handler, multiple_handler, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, OPT_CUSTOM_T, config_handler, sorcery_handler, multiple_handler, flags, 0, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
|
||||
|
||||
/*!
|
||||
* \brief Register a field within an object with custom handlers without documentation
|
||||
@@ -533,13 +556,14 @@ int __ast_sorcery_object_field_register(struct ast_sorcery *sorcery, const char
|
||||
* \param default_val Default value of the field
|
||||
* \param config_handler Custom configuration handler
|
||||
* \param sorcery_handler Custom sorcery handler
|
||||
* \param multiple_handler Custom multiple handler
|
||||
* \param flags Option type specific flags
|
||||
*
|
||||
* \retval 0 success
|
||||
* \retval -1 failure
|
||||
*/
|
||||
#define ast_sorcery_object_field_register_custom_nodoc(sorcery, type, name, default_val, config_handler, sorcery_handler, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, OPT_CUSTOM_T, config_handler, sorcery_handler, flags, 1, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
|
||||
#define ast_sorcery_object_field_register_custom_nodoc(sorcery, type, name, default_val, config_handler, sorcery_handler, multiple_handler, flags, ...) \
|
||||
__ast_sorcery_object_field_register(sorcery, type, name, default_val, OPT_CUSTOM_T, config_handler, sorcery_handler, multiple_handler, flags, 1, VA_NARGS(__VA_ARGS__), __VA_ARGS__);
|
||||
|
||||
/*!
|
||||
* \brief Inform any wizards to load persistent objects
|
||||
@@ -578,6 +602,22 @@ void ast_sorcery_reload_object(const struct ast_sorcery *sorcery, const char *ty
|
||||
*/
|
||||
void ast_sorcery_ref(struct ast_sorcery *sorcery);
|
||||
|
||||
|
||||
/*!
|
||||
* \brief Create an object set (KVP list) for an object
|
||||
*
|
||||
* \param sorcery Pointer to a sorcery structure
|
||||
* \param object Pointer to a sorcery object
|
||||
* \param flags Flags indicating which handler to use and in what order.
|
||||
*
|
||||
* \retval non-NULL success
|
||||
* \retval NULL if error occurred
|
||||
*
|
||||
* \note The returned ast_variable list must be destroyed using ast_variables_destroy
|
||||
*/
|
||||
struct ast_variable *ast_sorcery_objectset_create2(const struct ast_sorcery *sorcery,
|
||||
const void *object, enum ast_sorcery_field_handler_flags flags);
|
||||
|
||||
/*!
|
||||
* \brief Create an object set (KVP list) for an object
|
||||
*
|
||||
@@ -588,8 +628,14 @@ void ast_sorcery_ref(struct ast_sorcery *sorcery);
|
||||
* \retval NULL if error occurred
|
||||
*
|
||||
* \note The returned ast_variable list must be destroyed using ast_variables_destroy
|
||||
*
|
||||
* \note This function attempts to use a field's sorcery_fields_handler first and if that
|
||||
* doesn't exist or fails, a field's sorcery_field_handler is used. The difference is
|
||||
* that the former may return multiple list entries for the same field and the latter will only
|
||||
* return 1. It's up to the field itself to determine what the appropriate content is.
|
||||
*/
|
||||
struct ast_variable *ast_sorcery_objectset_create(const struct ast_sorcery *sorcery, const void *object);
|
||||
#define ast_sorcery_objectset_create(sorcery, object) \
|
||||
ast_sorcery_objectset_create2(sorcery, object, AST_HANDLER_PREFER_LIST)
|
||||
|
||||
/*!
|
||||
* \brief Create an object set in JSON format for an object
|
||||
|
||||
Reference in New Issue
Block a user