config_options.c File Reference

Configuration Option-handling. More...

#include "asterisk.h"
#include <regex.h>
#include "asterisk/_private.h"
#include "asterisk/config.h"
#include "asterisk/config_options.h"
#include "asterisk/stringfields.h"
#include "asterisk/acl.h"
#include "asterisk/app.h"
#include "asterisk/frame.h"
#include "asterisk/xmldoc.h"
#include "asterisk/cli.h"
#include "asterisk/term.h"
#include "asterisk/format_cap.h"

Include dependency graph for config_options.c:

Go to the source code of this file.

Data Structures
struct	aco_info_internal
	Bits of aco_info that shouldn't be assigned outside this file. More...
struct	aco_option
struct	aco_type_internal

Macros
#define	CONFIG_OPT_BUCKETS   53
#define	XMLDOC_STRICT   1

Functions
int	__aco_option_register (struct aco_info *info, const char *name, enum aco_matchtype matchtype, struct aco_type **types, const char *default_val, enum aco_option_type kind, aco_option_handler handler, unsigned int flags, unsigned int no_doc, size_t argc,...)
	register a config option More...
static int	acl_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default handler for ACLs. More...
static void	aco_deinit (void)
void	aco_info_destroy (struct aco_info *info)
	Destroy an initialized aco_info struct. More...
int	aco_info_init (struct aco_info *info)
	Initialize an aco_info structure. More...
int	aco_init (void)
struct ao2_container *	aco_option_container_alloc (void)
	Allocate a container to hold config options. More...
static struct aco_option *	aco_option_find (struct aco_type *type, const char *name)
intptr_t	aco_option_get_argument (const struct aco_option *option, unsigned int position)
	Get the offset position for an argument within a config option. More...
unsigned int	aco_option_get_flags (const struct aco_option *option)
	Read the flags of a config option - useful when using a custom callback for a config option. More...
int	aco_option_register_deprecated (struct aco_info *info, const char *name, struct aco_type **types, const char *aliased_to)
	Register a deprecated (and aliased) config option. More...
void *	aco_pending_config (struct aco_info *info)
	Get pending config changes. More...
enum aco_process_status	aco_process_ast_config (struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
	Process config info from an ast_config via options registered with an aco_info. More...
int	aco_process_category_options (struct aco_type *type, struct ast_config *cfg, const char *cat, void *obj)
	Parse each option defined in a config category. More...
enum aco_process_status	aco_process_config (struct aco_info *info, int reload)
	Process a config info via the options registered with an aco_info. More...
int	aco_process_var (struct aco_type *type, const char *cat, struct ast_variable *var, void *obj)
	Parse a single ast_variable and apply it to an object. More...
int	aco_set_defaults (struct aco_type *type, const char *category, void *obj)
	Set all default options of obj. More...
static int	apply_config (struct aco_info *info)
static aco_option_handler	ast_config_option_default_handler (enum aco_option_type type)
static int	bool_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for bools (ast_true/ast_false) More...
static int	boolflag_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for bools (ast_true/ast_false) that are stored as flags. More...
static regex_t *	build_regex (const char *text)
static int	chararray_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default handler for character arrays. More...
static char *	cli_show_help (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static void	cli_show_module_options (struct ast_cli_args *a)
static void	cli_show_module_type (struct ast_cli_args *a)
static void	cli_show_module_types (struct ast_cli_args *a)
static void	cli_show_modules (struct ast_cli_args *a)
static int	codec_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for codec preferences/capabilities. More...
static char *	complete_config_module (const char *word)
static char *	complete_config_option (const char *module, const char *option, const char *word)
static char *	complete_config_type (const char *module, const char *word)
static int	config_opt_cmp (void *obj, void *arg, int flags)
static int	config_opt_hash (const void *obj, const int flags)
static void	config_option_destroy (void *obj)
static struct ast_str *	derive_category_text (enum aco_category_op category_match, const char *category)
static int	double_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for doubles. More...
static int	find_option_cb (void *obj, void *arg, int flags)
static struct ast_xml_doc_item *	find_xmldoc_option (struct ast_xml_doc_item *config_info, struct aco_type **types, const char *name)
static struct ast_xml_doc_item *	find_xmldoc_type (struct ast_xml_doc_item *config_info, const char *name)
static int	int_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for signed integers. More...
static int	internal_aco_type_category_check (struct aco_type *match, const char *category)
static struct aco_type *	internal_aco_type_find (struct aco_file *file, struct ast_config *cfg, const char *category)
static void	internal_file_types_destroy (struct aco_file *file)
static enum aco_process_status	internal_process_ast_config (struct aco_info *info, struct aco_file *file, struct ast_config *cfg)
static void	internal_type_destroy (struct aco_type *type)
static int	internal_type_init (struct aco_type *type)
static int	is_preload (struct aco_file *file, const char *cat)
static int	link_option_to_types (struct aco_info *info, struct aco_type **types, struct aco_option *opt)
static int	noop_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default handler for doing nothing. More...
static int	process_category (struct ast_config *cfg, struct aco_info *info, struct aco_file *file, const char *cat, int preload)
static int	sockaddr_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default handler for ast_sockaddrs. More...
static int	stringfield_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for stringfields. More...
static int	timelen_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for timelen signed integers. More...
static int	uint_handler_fn (const struct aco_option *opt, struct ast_variable *var, void *obj)
	Default option handler for unsigned integers. More...
static int	xmldoc_update_config_option (struct aco_type **types, const char *module, const char *name, const char *object_name, const char *default_value, unsigned int regex, enum aco_option_type type)
static int	xmldoc_update_config_type (const char *module, const char *name, const char *category, const char *matchfield, const char *matchvalue, enum aco_category_op category_match)

Variables
static char *	aco_option_type_string []
	Value of the aco_option_type enum as strings. More...
static struct ast_cli_entry	cli_aco []
static struct ao2_container *	xmldocs

Detailed Description

Configuration Option-handling.

Author

Terry Wilson twils.nosp@m.on@d.nosp@m.igium.nosp@m..com

Definition in file config_options.c.

Macro Definition Documentation

CONFIG_OPT_BUCKETS

#define CONFIG_OPT_BUCKETS   53

Definition at line 47 of file config_options.c.

XMLDOC_STRICT

#define XMLDOC_STRICT   1

Definition at line 1082 of file config_options.c.

Function Documentation

__aco_option_register()

int __aco_option_register	(	struct aco_info *	info,
		const char *	name,
		enum aco_matchtype	match_type,
		struct aco_type **	types,
		const char *	default_val,
		enum aco_option_type	type,
		aco_option_handler	handler,
		unsigned int	flags,
		unsigned int	no_doc,
		size_t	argc,
			...
	)

register a config option

Note

this should probably only be called by one of the aco_option_register* macros

Parameters

info	The aco_info holding this module's config information
name	The name of the option
match_type
types	An array of valid option types for matching categories to the correct struct type
default_val	The default value of the option in the same format as defined in a config file
type	The option type (only for default handlers)
handler	The handler function for the option (only for non-default types)
flags	a type specific flags, stored in the option and available to the handler
no_doc	if non-zero, this option should not have documentation
argc	The number for variadic arguments
...	field offsets to store for default handlers

Return values

0	success
-1	failure

Definition at line 300 of file config_options.c.

{
    struct aco_option *opt;
    va_list ap;
    int tmp;
 
    /* Custom option types require a handler */
    if (!handler && kind == OPT_CUSTOM_T) {
        return -1;
    }
 
    if (!(types && types[0])) {
        return -1;
    }
 
    opt = ao2_alloc_options(sizeof(*opt) + argc * sizeof(opt->args[0]),
        config_option_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
    if (!opt) {
        return -1;
    }
 
    if (matchtype == ACO_REGEX && !(opt->name_regex = build_regex(name))) {
        ao2_ref(opt, -1);
        return -1;
    }
 
    va_start(ap, argc);
    for (tmp = 0; tmp < argc; tmp++) {
        opt->args[tmp] = va_arg(ap, size_t);
    }
    va_end(ap);
 
    opt->name = name;
    opt->match_type = matchtype;
    opt->default_val = default_val;
    opt->type = kind;
    opt->handler = handler;
    opt->flags = flags;
    opt->argc = argc;
    opt->no_doc = no_doc;
 
    if (!opt->handler && !(opt->handler = ast_config_option_default_handler(opt->type))) {
        /* This should never happen */
        ast_log(LOG_ERROR, "No handler provided, and no default handler exists for type %u\n", opt->type);
        ao2_ref(opt, -1);
        return -1;
    };
 
    if (link_option_to_types(info, types, opt)) {
        ao2_ref(opt, -1);
        return -1;
    }
 
    return 0;
}

References ACO_REGEX, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_ref, aco_option::argc, aco_option::args, ast_config_option_default_handler(), ast_log, build_regex(), config_option_destroy(), aco_option::default_val, aco_option::flags, aco_option::handler, handler(), sip_to_pjsip::info(), link_option_to_types(), LOG_ERROR, aco_option::match_type, name, aco_option::name, aco_option::name_regex, aco_option::no_doc, OPT_CUSTOM_T, tmp(), and aco_option::type.

Referenced by __ast_sorcery_object_field_register(), and ast_sorcery_object_fields_register().

acl_handler_fn()

static int acl_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default handler for ACLs.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1549 of file config_options.c.

                                                                                             {
    struct ast_ha **ha = (struct ast_ha **)(obj + opt->args[0]);
    int error = 0;
    *ha = ast_append_ha(opt->flags ? "permit" : "deny", var->value, *ha, &error);
    return error;
}

References aco_option::args, ast_append_ha(), error(), aco_option::flags, and var.

Referenced by ast_config_option_default_handler().

aco_deinit()

static void aco_deinit ( void  )

static

Definition at line 1421 of file config_options.c.

{
    ast_cli_unregister(cli_aco);
    ao2_cleanup(xmldocs);
}

References ao2_cleanup, ast_cli_unregister(), cli_aco, and xmldocs.

Referenced by aco_init().

aco_info_destroy()

void aco_info_destroy

(

struct aco_info *

info

)

Destroy an initialized aco_info struct.

Parameters

info	The address of the aco_info struct to destroy

Definition at line 910 of file config_options.c.

{
    int x;
    /* It shouldn't be possible for internal->pending to be in use when this is called because
     * of the locks in loader.c around reloads and unloads and the fact that internal->pending
     * only exists while those locks are held */
    ast_free(info->internal);
    info->internal = NULL;
 
    for (x = 0; info->files[x]; x++) {
        internal_file_types_destroy(info->files[x]);
    }
}

References ast_free, sip_to_pjsip::info(), internal_file_types_destroy(), and NULL.

Referenced by aco_info_init(), ast_ari_config_destroy(), ast_ari_config_init(), AST_TEST_DEFINE(), cdr_engine_shutdown(), conf_destroy_config(), destroy_config(), load_module(), sorcery_object_type_destructor(), stasis_cleanup(), unload_features_config(), and unload_module().

aco_info_init()

int aco_info_init

(

struct aco_info *

info

)

Initialize an aco_info structure.

Note

aco_info_destroy must be called if this succeeds

Parameters

info	The address of an aco_info struct to initialize

Return values

0	Success
non-zero	Failure

Definition at line 877 of file config_options.c.

{
    size_t x = 0, y = 0;
    struct aco_file *file;
    struct aco_type *type;
 
    if (!(info->internal = ast_calloc(1, sizeof(*info->internal)))) {
        return -1;
    }
 
    while ((file = info->files[x++])) {
        while ((type = file->types[y++])) {
            if (internal_type_init(type)) {
                goto error;
            }
#ifdef AST_XML_DOCS
            if (!info->hidden &&
                !type->hidden &&
                type->type != ACO_IGNORE &&
                xmldoc_update_config_type(info->module, type->name, type->category, type->matchfield, type->matchvalue, type->category_match)) {
                goto error;
            }
#endif /* AST_XML_DOCS */
        }
        y = 0;
    }
 
    return 0;
error:
    aco_info_destroy(info);
    return -1;
}

References ACO_IGNORE, aco_info_destroy(), ast_calloc, error(), make_ari_stubs::file, sip_to_pjsip::info(), internal_type_init(), type, and xmldoc_update_config_type().

Referenced by __ast_sorcery_object_register(), ast_ari_config_init(), AST_TEST_DEFINE(), conf_load_config(), load_config(), load_module(), process_config(), and stasis_init().

aco_init()

int aco_init

(

void

)

Provided by config_options.c

Definition at line 1428 of file config_options.c.

{
#ifdef AST_XML_DOCS
    ast_register_cleanup(aco_deinit);
    if (!(xmldocs = ast_xmldoc_build_documentation("configInfo"))) {
        ast_log(LOG_ERROR, "Couldn't build config documentation\n");
        return -1;
    }
    ast_cli_register_multiple(cli_aco, ARRAY_LEN(cli_aco));
#endif /* AST_XML_DOCS */
    return 0;
}

References aco_deinit(), ARRAY_LEN, ast_cli_register_multiple, ast_log, ast_register_cleanup(), ast_xmldoc_build_documentation(), cli_aco, LOG_ERROR, and xmldocs.

Referenced by asterisk_daemon().

aco_option_container_alloc()

struct ao2_container * aco_option_container_alloc

(

void

)

Allocate a container to hold config options.

Definition at line 406 of file config_options.c.

{
    return ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, CONFIG_OPT_BUCKETS,
        config_opt_hash, NULL, config_opt_cmp);
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, CONFIG_OPT_BUCKETS, config_opt_cmp(), config_opt_hash(), and NULL.

Referenced by internal_type_init().

aco_option_find()

static struct aco_option * aco_option_find ( struct aco_type *  type, const char *  name  )

static

Definition at line 389 of file config_options.c.

{
    struct aco_option *opt;
 
    if (!type || !type->internal || !type->internal->opts) {
        ast_log(LOG_NOTICE, "Attempting to use NULL or unitialized config type\n");
        return NULL;
    }
 
    /* Try an exact match with OBJ_KEY for the common/fast case, then iterate through
     * all options for the regex cases */
    if (!(opt = ao2_callback(type->internal->opts, OBJ_KEY, find_option_cb, (void *) name))) {
        opt = ao2_callback(type->internal->opts, 0, find_option_cb, (void *) name);
    }
    return opt;
}

References ao2_callback, ast_log, find_option_cb(), LOG_NOTICE, name, NULL, OBJ_KEY, and type.

Referenced by aco_process_var().

aco_option_get_argument()

intptr_t aco_option_get_argument	(	const struct aco_option *	option,
		unsigned int	position
	)

Get the offset position for an argument within a config option.

Parameters

option	Pointer to the aco_option struct
position	Argument number

Return values

position

of the argument

Definition at line 248 of file config_options.c.

{
    return option->args[position];
}

References aco_option::args.

Referenced by timeval_str2struct().

aco_option_get_flags()

unsigned int aco_option_get_flags

(

const struct aco_option *

option

)

Read the flags of a config option - useful when using a custom callback for a config option.

Since

12

Parameters

option

Pointer to the aco_option struct

Return values

value

of the flags on the config option

Definition at line 243 of file config_options.c.

{
    return option->flags;
}

References aco_option::flags.

Referenced by option_handler_parkedfeature().

aco_option_register_deprecated()

int aco_option_register_deprecated	(	struct aco_info *	info,
		const char *	name,
		struct aco_type **	types,
		const char *	aliased_to
	)

Register a deprecated (and aliased) config option.

Parameters

info	A pointer to the aco_info struct
name	The name of the deprecated option
types	An array of valid option types for matching categories to the correct struct type
aliased_to	The name of the option that this deprecated option matches to

Return values

0	Success
-1	Failure

Definition at line 217 of file config_options.c.

{
    struct aco_option *opt;
 
    if (!info || ast_strlen_zero(name) || ast_strlen_zero(aliased_to)) {
        return -1;
    }
 
    opt = ao2_alloc_options(sizeof(*opt), config_option_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
    if (!opt) {
        return -1;
    }
 
    opt->name = name;
    opt->aliased_to = aliased_to;
    opt->deprecated = 1;
    opt->match_type = ACO_EXACT;
 
    if (link_option_to_types(info, types, opt)) {
        ao2_ref(opt, -1);
        return -1;
    }
 
    return 0;
}

References ACO_EXACT, aco_option::aliased_to, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_ref, ast_strlen_zero(), config_option_destroy(), aco_option::deprecated, sip_to_pjsip::info(), link_option_to_types(), aco_option::match_type, name, and aco_option::name.

Referenced by AST_TEST_DEFINE().

aco_pending_config()

void * aco_pending_config

(

struct aco_info *

info

)

Get pending config changes.

Note

This will most likely be called from the pre_apply_config callback function

Parameters

info	An initialized aco_info

Return values

NULL	error
non-NULL	A pointer to the user-defined config object with un-applied changes

Definition at line 103 of file config_options.c.

{
    if (!(info && info->internal)) {
        ast_log(LOG_ERROR, "This may not be called without an initialized aco_info!\n");
        return NULL;
    }
    return info->internal->pending;
}

References ast_log, sip_to_pjsip::info(), LOG_ERROR, and NULL.

Referenced by cel_pre_apply_config(), configure_parking_extensions(), features_pre_apply_config(), hepv3_config_pre_apply(), http_media_cache_config_pre_apply(), prometheus_config_pre_apply(), udptl_pre_apply_config(), unbound_config_preapply_callback(), verify_default_parking_lot(), and verify_default_profiles().

aco_process_ast_config()

enum aco_process_status aco_process_ast_config	(	struct aco_info *	info,
		struct aco_file *	file,
		struct ast_config *	cfg
	)

Process config info from an ast_config via options registered with an aco_info.

Parameters

info	The aco_info to be used for handling the config
file	The file attached to aco_info that the config represents
cfg	A pointer to a loaded ast_config to parse

Return values

ACO_PROCESS_OK	Success
ACO_PROCESS_ERROR	Failure

Definition at line 617 of file config_options.c.

{
    if (!info->internal) {
        ast_log(LOG_ERROR, "Attempt to process %s with uninitialized aco_info\n", file->filename);
        return ACO_PROCESS_ERROR;
    }
 
    if (!(info->internal->pending = info->snapshot_alloc())) {
        ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", file->filename);
        goto error;
    }
 
    if (internal_process_ast_config(info, file, cfg)) {
        goto error;
    }
 
    if (info->pre_apply_config && info->pre_apply_config()) {
        goto error;
    }
 
    if (apply_config(info)) {
        goto error;
    };
 
    ao2_cleanup(info->internal->pending);
    info->internal->pending = NULL;
    return ACO_PROCESS_OK;
 
error:
    ao2_cleanup(info->internal->pending);
    info->internal->pending = NULL;
 
    return ACO_PROCESS_ERROR;
}

References ACO_PROCESS_ERROR, ACO_PROCESS_OK, ao2_cleanup, apply_config(), ast_log, error(), make_ari_stubs::file, sip_to_pjsip::info(), internal_process_ast_config(), LOG_ERROR, and NULL.

aco_process_category_options()

int aco_process_category_options	(	struct aco_type *	type,
		struct ast_config *	cfg,
		const char *	cat,
		void *	obj
	)

Parse each option defined in a config category.

Parameters

type	The aco_type with the options for parsing
cfg	The ast_config being parsed
cat	The config category being parsed
obj	The user-defined config object that will store the parsed config items

Return values

0	Success
-1	Failure

Definition at line 805 of file config_options.c.

{
    struct ast_variable *var;
 
    for (var = ast_variable_browse(cfg, cat); var; var = var->next) {
        if (aco_process_var(type, cat, var, obj)) {
            return -1;
        }
    }
 
    return 0;
}

References aco_process_var(), ast_variable_browse(), type, and var.

Referenced by process_category().

aco_process_config()

enum aco_process_status aco_process_config	(	struct aco_info *	info,
		int	reload
	)

Process a config info via the options registered with an aco_info.

Parameters

info	The config_options_info to be used for handling the config
reload	Non-zero if this is for a reload.

Return values

ACO_PROCESS_OK	Success
ACO_PROCESS_ERROR	Failure
ACO_PROCESS_UNCHANGED	No change due to unedited config file

Definition at line 652 of file config_options.c.

{
    struct ast_config *cfg;
    struct ast_flags cfg_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0, };
    int res = ACO_PROCESS_OK;
    int file_count = 0;
    struct aco_file *file;
 
    if (!info->internal) {
        ast_log(LOG_ERROR, "Attempting to process uninitialized aco_info\n");
        return ACO_PROCESS_ERROR;
    }
 
    if (!(info->files[0])) {
        ast_log(LOG_ERROR, "No filename given, cannot proceed!\n");
        return ACO_PROCESS_ERROR;
    }
 
    if (!(info->internal->pending = info->snapshot_alloc())) {
        ast_log(LOG_ERROR, "In %s: Could not allocate temporary objects\n", info->module);
        return ACO_PROCESS_ERROR;
    }
 
    while (res != ACO_PROCESS_ERROR && (file = info->files[file_count++])) {
        const char *filename = file->filename;
        struct aco_type *match;
        int i;
 
        /* set defaults for global objects */
        for (i = 0, match = file->types[i]; match; match = file->types[++i]) {
            void **field = info->internal->pending + match->item_offset;
 
            if (match->type == ACO_IGNORE) {
                continue;
            }
 
            if (match->type != ACO_GLOBAL || !*field) {
                continue;
            }
 
            if (aco_set_defaults(match, match->category, *field)) {
                ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, match->category);
                res = ACO_PROCESS_ERROR;
                break;
            }
        }
 
        if (res == ACO_PROCESS_ERROR) {
            break;
        }
 
try_alias:
        cfg = ast_config_load(filename, cfg_flags);
        if (!cfg || cfg == CONFIG_STATUS_FILEMISSING) {
            if (file->alias && strcmp(file->alias, filename)) {
                filename = file->alias;
                goto try_alias;
            }
            ast_log(LOG_ERROR, "Unable to load config file '%s'\n", file->filename);
            res = ACO_PROCESS_ERROR;
            break;
        } else if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
            ast_debug(1, "%s was unchanged\n", file->filename);
            res = ACO_PROCESS_UNCHANGED;
            continue;
        } else if (cfg == CONFIG_STATUS_FILEINVALID) {
            ast_log(LOG_ERROR, "Contents of %s are invalid and cannot be parsed\n",
                file->filename);
            res = ACO_PROCESS_ERROR;
            break;
        }
 
        /* A file got loaded. */
        if (reload) {
            /* Must do any subsequent file loads unconditionally. */
            reload = 0;
            ast_clear_flag(&cfg_flags, CONFIG_FLAG_FILEUNCHANGED);
 
            if (file_count != 1) {
                /*
                 * Must restart loading to load all config files since a file
                 * after the first one changed.
                 */
                file_count = 0;
            } else {
                res = internal_process_ast_config(info, file, cfg);
            }
        } else {
            res = internal_process_ast_config(info, file, cfg);
        }
        ast_config_destroy(cfg);
    }
 
    if (res != ACO_PROCESS_OK) {
        goto end;
    }
 
    if (info->pre_apply_config && info->pre_apply_config()) {
        res = ACO_PROCESS_ERROR;
        goto end;
    }
 
    if (apply_config(info)) {
        res = ACO_PROCESS_ERROR;
        goto end;
    }
 
    if (info->post_apply_config) {
        info->post_apply_config();
    }
 
end:
    ao2_cleanup(info->internal->pending);
    info->internal->pending = NULL;
 
    return res;
}

References ACO_GLOBAL, ACO_IGNORE, ACO_PROCESS_ERROR, ACO_PROCESS_OK, ACO_PROCESS_UNCHANGED, aco_set_defaults(), ao2_cleanup, apply_config(), ast_clear_flag, ast_config_destroy(), ast_config_load, ast_debug, ast_log, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEMISSING, CONFIG_STATUS_FILEUNCHANGED, end, make_ari_stubs::file, aco_file::filename, sip_to_pjsip::info(), internal_process_ast_config(), LOG_ERROR, match(), NULL, and reload().

Referenced by __ast_udptl_reload(), AST_TEST_DEFINE(), conf_load_config(), conf_reload_config(), load_config(), load_module(), process_config(), reload(), reload_features_config(), reload_module(), and stasis_init().

aco_process_var()

int aco_process_var	(	struct aco_type *	type,
		const char *	cat,
		struct ast_variable *	var,
		void *	obj
	)

Parse a single ast_variable and apply it to an object.

Note

This function can be used to build up an object by repeatedly passing in the config variable name and values that would be found in a config file. This can be useful if the object is to be populated by a dialplan function, for example.

Parameters

type	The aco_type associated with the object
cat	The category to use
var	A variable to apply to the object
obj	A pointer to the object to be configured

Return values

0	Success
-1	Failure

Definition at line 769 of file config_options.c.

{
    RAII_VAR(struct aco_option *, opt, aco_option_find(type, var->name), ao2_cleanup);
    if (opt && opt->deprecated && !ast_strlen_zero(opt->aliased_to)) {
        const char *alias = ast_strdupa(opt->aliased_to);
        ast_log(LOG_WARNING, "At line %d of %s option '%s' is deprecated. Use '%s' instead\n", var->lineno, var->file, var->name, alias);
        ao2_ref(opt, -1);
        opt = aco_option_find(type, alias);
    }
 
    if (!opt) {
        ast_log(LOG_ERROR, "Could not find option suitable for category '%s' named '%s' at line %d of %s\n", cat, var->name, var->lineno, var->file);
        return -1;
    }
 
    if (!opt->handler) {
        /* It should be impossible for an option to not have a handler */
        ast_log(LOG_ERROR, "BUG! Somehow a config option for %s/%s was created with no handler!\n", cat, var->name);
        return -1;
    }
 
#ifdef AST_DEVMODE
    if (opt->doc_unavailable) {
        ast_log(LOG_ERROR, "Config option '%s' of type '%s' is not completely documented and can not be set\n", var->name, type->name);
        return -1;
    }
#endif
 
    if (opt->handler(opt, var, obj)) {
        ast_log(LOG_ERROR, "Error parsing %s=%s at line %d of %s\n", var->name, var->value, var->lineno, var->file);
        return -1;
    }
 
    return 0;
}

References aco_option_find(), ao2_cleanup, ao2_ref, ast_log, ast_strdupa, ast_strlen_zero(), LOG_ERROR, LOG_WARNING, RAII_VAR, type, and var.

Referenced by aco_process_category_options(), ast_sorcery_objectset_apply(), and func_confbridge_helper().

aco_set_defaults()

int aco_set_defaults	(	struct aco_type *	type,
		const char *	category,
		void *	obj
	)

Set all default options of obj.

Parameters

type	The aco_type with the options
category	The configuration category from which obj is being configured
obj	The object being configured

Return values

0	Success
-1	Failure

Definition at line 924 of file config_options.c.

{
    struct aco_option *opt;
    struct ao2_iterator iter;
 
    if (!type->internal) {
        return -1;
    }
 
    iter = ao2_iterator_init(type->internal->opts, 0);
 
    while ((opt = ao2_iterator_next(&iter))) {
        RAII_VAR(struct ast_variable *, var, NULL, ast_variables_destroy);
 
        if (ast_strlen_zero(opt->default_val)) {
            ao2_ref(opt, -1);
            continue;
        }
        if (!(var = ast_variable_new(opt->name, opt->default_val, ""))) {
            ao2_ref(opt, -1);
            ao2_iterator_destroy(&iter);
            return -1;
        }
        if (opt->handler(opt, var, obj)) {
            ast_log(LOG_ERROR, "Unable to set default for %s, %s=%s\n", category, var->name, var->value);
            ao2_ref(opt, -1);
            ao2_iterator_destroy(&iter);
            return -1;
        }
        ao2_ref(opt, -1);
    }
    ao2_iterator_destroy(&iter);
 
    return 0;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_log, ast_strlen_zero(), ast_variable_new, ast_variables_destroy(), aco_option::default_val, aco_option::handler, LOG_ERROR, aco_option::name, NULL, RAII_VAR, type, and var.

Referenced by __ast_udptl_reload(), aco_process_config(), ast_sorcery_alloc(), conf_alloc(), load_config(), load_module(), process_category(), process_config(), stasis_init(), unbound_config_apply_default(), verify_default_parking_lot(), and verify_default_profiles().

apply_config()

static int apply_config ( struct aco_info *  info )

static

Definition at line 589 of file config_options.c.

{
    ao2_global_obj_replace_unref(*info->global_obj, info->internal->pending);
 
    return 0;
}

References ao2_global_obj_replace_unref, and sip_to_pjsip::info().

Referenced by aco_process_ast_config(), aco_process_config(), load_module(), and unload_module().

ast_config_option_default_handler()

static aco_option_handler ast_config_option_default_handler ( enum aco_option_type  type )

static

Definition at line 139 of file config_options.c.

{
    switch(type) {
    case OPT_ACL_T: return acl_handler_fn;
    case OPT_BOOL_T: return bool_handler_fn;
    /* Reading from config files, BOOL and YESNO are handled exactly the
     * same. Their difference is in how they are rendered to users
     */
    case OPT_YESNO_T: return bool_handler_fn;
    case OPT_BOOLFLAG_T: return boolflag_handler_fn;
    case OPT_CHAR_ARRAY_T: return chararray_handler_fn;
    case OPT_CODEC_T: return codec_handler_fn;
    case OPT_DOUBLE_T: return double_handler_fn;
    case OPT_INT_T: return int_handler_fn;
    case OPT_NOOP_T: return noop_handler_fn;
    case OPT_SOCKADDR_T: return sockaddr_handler_fn;
    case OPT_STRINGFIELD_T: return stringfield_handler_fn;
    case OPT_UINT_T: return uint_handler_fn;
    case OPT_TIMELEN_T: return timelen_handler_fn;
 
    case OPT_CUSTOM_T: return NULL;
    }
 
    return NULL;
}

References acl_handler_fn(), bool_handler_fn(), boolflag_handler_fn(), chararray_handler_fn(), codec_handler_fn(), double_handler_fn(), int_handler_fn(), noop_handler_fn(), NULL, OPT_ACL_T, OPT_BOOL_T, OPT_BOOLFLAG_T, OPT_CHAR_ARRAY_T, OPT_CODEC_T, OPT_CUSTOM_T, OPT_DOUBLE_T, OPT_INT_T, OPT_NOOP_T, OPT_SOCKADDR_T, OPT_STRINGFIELD_T, OPT_TIMELEN_T, OPT_UINT_T, OPT_YESNO_T, sockaddr_handler_fn(), stringfield_handler_fn(), timelen_handler_fn(), type, and uint_handler_fn().

Referenced by __aco_option_register().

bool_handler_fn()

static int bool_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for bools (ast_true/ast_false)

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1586 of file config_options.c.

{
    unsigned int *field = (unsigned int *)(obj + opt->args[0]);
    *field = opt->flags ? ast_true(var->value) : ast_false(var->value);
    return 0;
}

References aco_option::args, ast_false(), ast_true(), aco_option::flags, and var.

Referenced by ast_config_option_default_handler().

boolflag_handler_fn()

static int boolflag_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for bools (ast_true/ast_false) that are stored as flags.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1597 of file config_options.c.

{
    unsigned int *flags_field = (unsigned int *)(obj + opt->args[0]);
    unsigned int val = opt->flags ? ast_true(var->value) : ast_false(var->value);
    unsigned int flag = opt->args[1];
    if (val) {
        *flags_field |= flag;
    } else {
        *flags_field &= ~flag;
    }
    return 0;
}

References aco_option::args, ast_false(), ast_true(), aco_option::flags, and var.

Referenced by ast_config_option_default_handler().

build_regex()

static regex_t * build_regex ( const char *  text )

static

Definition at line 165 of file config_options.c.

{
    int res;
    regex_t *regex;
 
    if (!(regex = ast_malloc(sizeof(*regex)))) {
        return NULL;
    }
 
    if ((res = regcomp(regex, text, REG_EXTENDED | REG_ICASE | REG_NOSUB))) {
        size_t len = regerror(res, regex, NULL, 0);
        char buf[len];
        regerror(res, regex, buf, len);
        ast_log(LOG_ERROR, "Could not compile regex '%s': %s\n", text, buf);
        ast_free(regex);
        return NULL;
    }
 
    return regex;
}

References ast_free, ast_log, ast_malloc, buf, len(), LOG_ERROR, NULL, regex(), and text.

Referenced by __aco_option_register(), internal_type_init(), and process_category().

chararray_handler_fn()

static int chararray_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default handler for character arrays.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1631 of file config_options.c.

{
    char *field = (char *)(obj + opt->args[0]);
    size_t len = opt->args[1];
 
    if (opt->flags && ast_strlen_zero(var->value)) {
        return -1;
    }
    ast_copy_string(field, var->value, len);
    return 0;
}

References aco_option::args, ast_copy_string(), ast_strlen_zero(), aco_option::flags, len(), and var.

Referenced by ast_config_option_default_handler().

cli_show_help()

static char * cli_show_help ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 1361 of file config_options.c.

{
    switch (cmd) {
    case CLI_INIT:
        e->command = "config show help";
        e->usage =
            "Usage: config show help [<module> [<type> [<option>]]]\n"
            "   Display detailed information about module configuration.\n"
            "     * If nothing is specified, the modules that have\n"
            "       configuration information are listed.\n"
            "     * If <module> is specified, the configuration types\n"
            "       for that module will be listed, along with brief\n"
            "       information about that type.\n"
            "     * If <module> and <type> are specified, detailed\n"
            "       information about the type is displayed, as well\n"
            "       as the available options.\n"
            "     * If <module>, <type>, and <option> are specified,\n"
            "       detailed information will be displayed about that\n"
            "       option.\n"
            "   NOTE: the help documentation is partially generated at run\n"
            "     time when a module is loaded. If a module is not loaded,\n"
            "     configuration help for that module may be incomplete.\n";
        return NULL;
    case CLI_GENERATE:
        switch(a->pos) {
        case 3:
            return complete_config_module(a->word);
        case 4:
            return complete_config_type(a->argv[3], a->word);
        case 5:
            return complete_config_option(a->argv[3], a->argv[4], a->word);
        default:
            return NULL;
        }
    }
 
    switch (a->argc) {
    case 3:
        cli_show_modules(a);
        break;
    case 4:
        cli_show_module_types(a);
        break;
    case 5:
        cli_show_module_type(a);
        break;
    case 6:
        cli_show_module_options(a);
        break;
    default:
        return CLI_SHOWUSAGE;
    }
 
    return CLI_SUCCESS;
}

References a, CLI_GENERATE, CLI_INIT, cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), cli_show_modules(), CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, complete_config_module(), complete_config_option(), complete_config_type(), NULL, and ast_cli_entry::usage.

cli_show_module_options()

static void cli_show_module_options ( struct ast_cli_args *  a )

static

Definition at line 1318 of file config_options.c.

{
    RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
    struct ast_xml_doc_item *tmp;
    char option_name[64];
    int match = 0;
 
    ast_assert(a->argc == 6);
 
    if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
        ast_cli(a->fd, "Unknown module %s\n", a->argv[3]);
        return;
    }
    tmp = item;
    while ((tmp = AST_LIST_NEXT(tmp, next))) {
        if (!strcasecmp(tmp->type, "configOption") && !strcasecmp(tmp->ref, a->argv[4]) && !strcasecmp(tmp->name, a->argv[5])) {
            if (match) {
                ast_cli(a->fd, "\n");
            }
            term_color(option_name, tmp->ref, COLOR_MAGENTA, COLOR_BLACK, sizeof(option_name));
            ast_cli(a->fd, "[%s%s]\n", option_name, ast_term_reset());
            if (ast_str_strlen(tmp->syntax)) {
                ast_cli(a->fd, "%s\n", ast_xmldoc_printable(ast_str_buffer(tmp->syntax), 1));
            }
            ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(AS_OR(tmp->synopsis, "No information available"), 1));
            if (ast_str_strlen(tmp->description)) {
                ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->description), 1));
            }
 
            if (ast_str_strlen(tmp->seealso)) {
                ast_cli(a->fd, "See Also:\n");
                ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->seealso), 1));
            }
 
            match = 1;
        }
    }
 
    if (!match) {
        ast_cli(a->fd, "No option %s found for %s:%s\n", a->argv[5], a->argv[3], a->argv[4]);
    }
}

References a, ao2_cleanup, ao2_find, AS_OR, ast_assert, ast_cli(), AST_LIST_NEXT, ast_str_buffer(), ast_str_strlen(), ast_term_reset(), ast_xmldoc_printable(), COLOR_BLACK, COLOR_MAGENTA, item, match(), ast_xml_doc_item::next, NULL, OBJ_KEY, RAII_VAR, term_color(), tmp(), and xmldocs.

Referenced by cli_show_help().

cli_show_module_type()

static void cli_show_module_type ( struct ast_cli_args *  a )

static

Definition at line 1266 of file config_options.c.

{
    RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
    struct ast_xml_doc_item *tmp;
    char option_type[64];
    int match = 0;
 
    ast_assert(a->argc == 5);
 
    if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
        ast_cli(a->fd, "Unknown module %s\n", a->argv[3]);
        return;
    }
 
    tmp = item;
    while ((tmp = AST_LIST_NEXT(tmp, next))) {
        if (!strcasecmp(tmp->type, "configObject") && !strcasecmp(tmp->name, a->argv[4])) {
            match = 1;
            term_color(option_type, tmp->name, COLOR_MAGENTA, COLOR_BLACK, sizeof(option_type));
            ast_cli(a->fd, "%s", option_type);
            if (ast_str_strlen(tmp->syntax)) {
                ast_cli(a->fd, ": [%s]\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->syntax), 1));
            } else {
                ast_cli(a->fd, "\n\n");
            }
            if (ast_str_strlen(tmp->synopsis)) {
                ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->synopsis), 1));
            }
            if (ast_str_strlen(tmp->description)) {
                ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(tmp->description), 1));
            }
        }
    }
 
    if (!match) {
        ast_cli(a->fd, "Unknown configuration type %s\n", a->argv[4]);
        return;
    }
 
    /* Now iterate over the options for the type */
    tmp = item;
    while ((tmp = AST_LIST_NEXT(tmp, next))) {
        if (!strcasecmp(tmp->type, "configOption") && !strcasecmp(tmp->ref, a->argv[4])) {
            ast_cli(a->fd, "%-25s -- %-120.120s\n", tmp->name,
                    ast_str_buffer(tmp->synopsis));
        }
    }
}

References a, ao2_cleanup, ao2_find, ast_assert, ast_cli(), AST_LIST_NEXT, ast_str_buffer(), ast_str_strlen(), ast_xmldoc_printable(), COLOR_BLACK, COLOR_MAGENTA, item, match(), ast_xml_doc_item::next, NULL, OBJ_KEY, RAII_VAR, term_color(), tmp(), and xmldocs.

Referenced by cli_show_help().

cli_show_module_types()

static void cli_show_module_types ( struct ast_cli_args *  a )

static

Definition at line 1234 of file config_options.c.

{
    RAII_VAR(struct ast_xml_doc_item *, item, NULL, ao2_cleanup);
    struct ast_xml_doc_item *tmp;
 
    ast_assert(a->argc == 4);
 
    if (!(item = ao2_find(xmldocs, a->argv[3], OBJ_KEY))) {
        ast_cli(a->fd, "Module %s not found.\n", a->argv[3]);
        return;
    }
 
    if (ast_str_strlen(item->synopsis)) {
        ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(item->synopsis), 1));
    }
    if (ast_str_strlen(item->description)) {
        ast_cli(a->fd, "%s\n\n", ast_xmldoc_printable(ast_str_buffer(item->description), 1));
    }
 
    tmp = item;
    ast_cli(a->fd, "Configuration option types for %s:\n", tmp->name);
    while ((tmp = AST_LIST_NEXT(tmp, next))) {
        if (!strcasecmp(tmp->type, "configObject")) {
            ast_cli(a->fd, "%-25s -- %-65.65s\n", tmp->name,
                ast_str_buffer(tmp->synopsis));
        }
    }
}

References a, ao2_cleanup, ao2_find, ast_assert, ast_cli(), AST_LIST_NEXT, ast_str_buffer(), ast_str_strlen(), ast_xmldoc_printable(), item, ast_xml_doc_item::next, NULL, OBJ_KEY, RAII_VAR, tmp(), and xmldocs.

Referenced by cli_show_help().

cli_show_modules()

static void cli_show_modules ( struct ast_cli_args *  a )

static

Definition at line 1210 of file config_options.c.

{
    struct ast_xml_doc_item *item;
    struct ao2_iterator it_items;
 
    ast_assert(a->argc == 3);
 
    if (ao2_container_count(xmldocs) == 0) {
        ast_cli(a->fd, "No modules found.\n");
        return;
    }
 
    it_items = ao2_iterator_init(xmldocs, 0);
    ast_cli(a->fd, "The following modules have configuration information:\n");
    while ((item = ao2_iterator_next(&it_items))) {
        ast_cli(a->fd, "\t%s\n", item->name);
        ao2_ref(item, -1);
    }
    ao2_iterator_destroy(&it_items);
}

References a, ao2_container_count(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_assert, ast_cli(), item, aco_type::name, and xmldocs.

Referenced by cli_show_help().

codec_handler_fn()

static int codec_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for codec preferences/capabilities.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1560 of file config_options.c.

                                                                                               {
    struct ast_format_cap **cap = (struct ast_format_cap **)(obj + opt->args[0]);
    return ast_format_cap_update_by_allow_disallow(*cap, var->value, opt->flags);
}

References aco_option::args, ast_format_cap_update_by_allow_disallow(), aco_option::flags, and var.

Referenced by ast_config_option_default_handler().

complete_config_module()

static char * complete_config_module ( const char *  word )

static

Definition at line 965 of file config_options.c.

{
    size_t wordlen = strlen(word);
    struct ao2_iterator i;
    struct ast_xml_doc_item *cur;
 
    i = ao2_iterator_init(xmldocs, 0);
    while ((cur = ao2_iterator_next(&i))) {
        if (!strncasecmp(word, cur->name, wordlen)) {
            if (ast_cli_completion_add(ast_strdup(cur->name))) {
                ao2_ref(cur, -1);
                break;
            }
        }
        ao2_ref(cur, -1);
    }
    ao2_iterator_destroy(&i);
 
    return NULL;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli_completion_add(), ast_strdup, ast_xml_doc_item::name, NULL, and xmldocs.

Referenced by cli_show_help().

complete_config_option()

static char * complete_config_option ( const char *  module, const char *  option, const char *  word  )

static

Definition at line 1016 of file config_options.c.

{
    size_t wordlen = strlen(word);
    struct ast_xml_doc_item *info;
    struct ast_xml_doc_item *cur;
 
    info = ao2_find(xmldocs, module, OBJ_KEY);
    if (!info) {
        return NULL;
    }
 
    cur = info;
    while ((cur = AST_LIST_NEXT(cur, next))) {
        if (!strcasecmp(cur->type, "configOption") && !strcasecmp(cur->ref, option) && !strncasecmp(word, cur->name, wordlen)) {
            if (ast_cli_completion_add(ast_strdup(cur->name))) {
                break;
            }
        }
    }
    ao2_ref(info, -1);
 
    return NULL;
}

References ao2_find, ao2_ref, ast_cli_completion_add(), AST_LIST_NEXT, ast_strdup, sip_to_pjsip::info(), ast_xml_doc_item::name, ast_xml_doc_item::next, NULL, OBJ_KEY, ast_xml_doc_item::ref, ast_xml_doc_item::type, and xmldocs.

Referenced by cli_show_help().

complete_config_type()

static char * complete_config_type ( const char *  module, const char *  word  )

static

Definition at line 989 of file config_options.c.

{
    size_t wordlen = strlen(word);
    struct ast_xml_doc_item *info;
    struct ast_xml_doc_item *cur;
 
    info = ao2_find(xmldocs, module, OBJ_KEY);
    if (!info) {
        return NULL;
    }
 
    cur = info;
    while ((cur = AST_LIST_NEXT(cur, next))) {
        if (!strcasecmp(cur->type, "configObject") && !strncasecmp(word, cur->name, wordlen)) {
            if (ast_cli_completion_add(ast_strdup(cur->name))) {
                break;
            }
        }
    }
    ao2_ref(info, -1);
 
    return NULL;
}

References ao2_find, ao2_ref, ast_cli_completion_add(), AST_LIST_NEXT, ast_strdup, sip_to_pjsip::info(), ast_xml_doc_item::name, ast_xml_doc_item::next, NULL, OBJ_KEY, ast_xml_doc_item::type, and xmldocs.

Referenced by cli_show_help().

config_opt_cmp()

static int config_opt_cmp ( void *  obj, void *  arg, int  flags  )

static

Definition at line 365 of file config_options.c.

{
    struct aco_option *opt1 = obj, *opt2 = arg;
    const char *name = (flags & OBJ_KEY) ? arg : opt2->name;
    return strcasecmp(opt1->name, name) ? 0 : CMP_MATCH | CMP_STOP;
}

References CMP_MATCH, CMP_STOP, aco_option::flags, name, aco_option::name, aco_option::obj, and OBJ_KEY.

Referenced by aco_option_container_alloc().

config_opt_hash()

static int config_opt_hash ( const void *  obj, const int  flags  )

static

Definition at line 358 of file config_options.c.

{
    const struct aco_option *opt = obj;
    const char *name = (flags & OBJ_KEY) ? obj : opt->name;
    return ast_str_case_hash(name);
}

References ast_str_case_hash(), aco_option::flags, name, aco_option::name, aco_option::obj, and OBJ_KEY.

Referenced by aco_option_container_alloc().

config_option_destroy()

static void config_option_destroy ( void *  obj )

static

Definition at line 112 of file config_options.c.

{
    struct aco_option *opt = obj;
    if (opt->match_type == ACO_REGEX && opt->name_regex) {
        regfree(opt->name_regex);
        ast_free(opt->name_regex);
    }
}

References ACO_REGEX, ast_free, aco_option::match_type, aco_option::name_regex, and aco_option::obj.

Referenced by __aco_option_register(), and aco_option_register_deprecated().

derive_category_text()

static struct ast_str * derive_category_text ( enum aco_category_op  category_match, const char *  category  )

static

Definition at line 1043 of file config_options.c.

{
    struct ast_str *s = ast_str_create(128);
 
    if (!s) {
        return NULL;
    }
 
    switch (category_match) {
    case ACO_WHITELIST_ARRAY:
    case ACO_BLACKLIST_ARRAY: {
        size_t i;
        const char **matches = (const char **) category;
        ast_str_append(&s, 0, "^(");
        for (i = 0; matches[i]; i++) {
            ast_str_append(&s, 0, "%s%s",
                i ? "|" : "",
                matches[i]);
        }
        ast_str_append(&s, 0, ")$");
        break;
    }
    case ACO_WHITELIST_EXACT:
    case ACO_BLACKLIST_EXACT:
        ast_str_set(&s, 0, "^%s$", category);
        break;
    case ACO_WHITELIST:
    case ACO_BLACKLIST:
    default:
        ast_str_set(&s, 0, "%s", category);
        break;
    }
 
    return s;
}

References ACO_BLACKLIST, ACO_BLACKLIST_ARRAY, ACO_BLACKLIST_EXACT, ACO_WHITELIST, ACO_WHITELIST_ARRAY, ACO_WHITELIST_EXACT, ast_str_append(), ast_str_create, ast_str_set(), and NULL.

Referenced by xmldoc_update_config_type().

double_handler_fn()

static int double_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for doubles.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1540 of file config_options.c.

                                                                                                {
    double *field = (double *)(obj + opt->args[0]);
    return ast_parse_arg(var->value, PARSE_DOUBLE | opt->flags, field);
}

References aco_option::args, ast_parse_arg(), aco_option::flags, PARSE_DOUBLE, and var.

Referenced by ast_config_option_default_handler().

find_option_cb()

static int find_option_cb ( void *  obj, void *  arg, int  flags  )

static

Definition at line 372 of file config_options.c.

{
    struct aco_option *match = obj;
    const char *name = arg;
 
    switch (match->match_type) {
    case ACO_EXACT:
        return strcasecmp(name, match->name) ? 0 : CMP_MATCH | CMP_STOP;
    case ACO_PREFIX:
        return strncasecmp(name, match->name, strlen(match->name)) ? 0 : CMP_MATCH | CMP_STOP;
    case ACO_REGEX:
        return regexec(match->name_regex, name, 0, NULL, 0) ? 0 : CMP_MATCH | CMP_STOP;
    }
    ast_log(LOG_ERROR, "Unknown match type. This should not be possible.\n");
    return CMP_STOP;
}

References ACO_EXACT, ACO_PREFIX, ACO_REGEX, ast_log, CMP_MATCH, CMP_STOP, LOG_ERROR, match(), name, NULL, and aco_option::obj.

Referenced by aco_option_find().

find_xmldoc_option()

static struct ast_xml_doc_item * find_xmldoc_option ( struct ast_xml_doc_item *  config_info, struct aco_type **  types, const char *  name  )

static

Definition at line 257 of file config_options.c.

{
    struct ast_xml_doc_item *iter = config_info;
 
    if (!iter) {
        return NULL;
    }
    /* First is just the configInfo, we can skip it */
    while ((iter = AST_LIST_NEXT(iter, next))) {
        size_t x;
        if (strcasecmp(iter->name, name)) {
            continue;
        }
        for (x = 0; types[x]; x++) {
            /* All we care about is that at least one type has the option */
            if (!strcasecmp(types[x]->name, iter->ref)) {
                return iter;
            }
        }
    }
    return NULL;
}

References AST_LIST_NEXT, name, ast_xml_doc_item::name, ast_xml_doc_item::next, NULL, and ast_xml_doc_item::ref.

Referenced by xmldoc_update_config_option().

find_xmldoc_type()

static struct ast_xml_doc_item * find_xmldoc_type ( struct ast_xml_doc_item *  config_info, const char *  name  )

static

Definition at line 283 of file config_options.c.

{
    struct ast_xml_doc_item *iter = config_info;
    if (!iter) {
        return NULL;
    }
    /* First is just the config Info, skip it */
    while ((iter = AST_LIST_NEXT(iter, next))) {
        if (!strcasecmp(iter->type, "configObject") && !strcasecmp(iter->name, name)) {
            break;
        }
    }
    return iter;
}

References AST_LIST_NEXT, name, ast_xml_doc_item::name, ast_xml_doc_item::next, NULL, and ast_xml_doc_item::type.

Referenced by xmldoc_update_config_type().

int_handler_fn()

static int int_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for signed integers.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1447 of file config_options.c.

                                                                                             {
    int *field = (int *)(obj + opt->args[0]);
    unsigned int flags = PARSE_INT32 | opt->flags;
    int res = 0;
    if (opt->flags & PARSE_IN_RANGE) {
        res = opt->flags & PARSE_DEFAULT ?
            ast_parse_arg(var->value, flags, field, (int) opt->args[1], (int) opt->args[2], opt->args[3]) :
            ast_parse_arg(var->value, flags, field, (int) opt->args[1], (int) opt->args[2]);
        if (res) {
            if (opt->flags & PARSE_RANGE_DEFAULTS) {
                ast_log(LOG_WARNING, "Failed to set %s=%s. Set to %d instead due to range limit (%d, %d)\n", var->name, var->value, *field, (int) opt->args[1], (int) opt->args[2]);
                res = 0;
            } else if (opt->flags & PARSE_DEFAULT) {
                ast_log(LOG_WARNING, "Failed to set %s=%s, Set to default value %d instead.\n", var->name, var->value, *field);
                res = 0;
            }
        }
    } else if ((opt->flags & PARSE_DEFAULT) && ast_parse_arg(var->value, flags, field, (int) opt->args[1])) {
        ast_log(LOG_WARNING, "Attempted to set %s=%s, but set it to %d instead due to default)\n", var->name, var->value, *field);
    } else {
        res = ast_parse_arg(var->value, flags, field);
    }
 
    return res;
}

References aco_option::args, ast_log, ast_parse_arg(), aco_option::flags, LOG_WARNING, PARSE_DEFAULT, PARSE_IN_RANGE, PARSE_INT32, PARSE_RANGE_DEFAULTS, and var.

Referenced by ast_config_option_default_handler().

internal_aco_type_category_check()

static int internal_aco_type_category_check ( struct aco_type *  match, const char *  category  )

static

Definition at line 412 of file config_options.c.

{
    const char **categories = (const char **)match->category;
 
    switch (match->category_match) {
    case ACO_WHITELIST:
        return regexec(match->internal->regex, category, 0, NULL, 0);
 
    case ACO_BLACKLIST:
        return !regexec(match->internal->regex, category, 0, NULL, 0);
 
    case ACO_WHITELIST_EXACT:
        return strcasecmp(match->category, category);
 
    case ACO_BLACKLIST_EXACT:
        return !strcasecmp(match->category, category);
 
    case ACO_WHITELIST_ARRAY:
        while (*categories) {
            if (!strcasecmp(*categories, category)) {
                return 0;
            }
            categories++;
        }
        return -1;
 
    case ACO_BLACKLIST_ARRAY:
        while (*categories) {
            if (!strcasecmp(*categories, category)) {
                return -1;
            }
            categories++;
        }
        return 0;
    }
 
    return -1;
}

References ACO_BLACKLIST, ACO_BLACKLIST_ARRAY, ACO_BLACKLIST_EXACT, ACO_WHITELIST, ACO_WHITELIST_ARRAY, ACO_WHITELIST_EXACT, categories, match(), and NULL.

Referenced by internal_aco_type_find().

internal_aco_type_find()

static struct aco_type * internal_aco_type_find ( struct aco_file *  file, struct ast_config *  cfg, const char *  category  )

static

Definition at line 451 of file config_options.c.

{
    size_t x;
    struct aco_type *match;
    const char *val;
 
    for (x = 0, match = file->types[x]; match; match = file->types[++x]) {
        /* First make sure we are an object that can service this category */
        if (internal_aco_type_category_check(match, category)) {
            continue;
        }
 
        /* Then, see if we need to match a particular field */
        if (!ast_strlen_zero(match->matchfield) && (!ast_strlen_zero(match->matchvalue) || match->matchfunc)) {
            if (!(val = ast_variable_retrieve(cfg, category, match->matchfield))) {
                ast_log(LOG_ERROR, "Required match field '%s' not found\n", match->matchfield);
                return NULL;
            }
            if (match->matchfunc) {
                if (!match->matchfunc(val)) {
                    continue;
                }
            } else if (strcasecmp(val, match->matchvalue)) {
                continue;
            }
        }
        /* If we get this far, we're a match */
        break;
    }
 
    return match;
}

References ast_log, ast_strlen_zero(), ast_variable_retrieve(), aco_type::category, make_ari_stubs::file, internal_aco_type_category_check(), LOG_ERROR, match(), and NULL.

Referenced by process_category().

internal_file_types_destroy()

static void internal_file_types_destroy ( struct aco_file *  file )

static

Definition at line 837 of file config_options.c.

{
    size_t x;
    struct aco_type *t;
 
    for (x = 0, t = file->types[x]; t; t = file->types[++x]) {
        internal_type_destroy(t);
        t = NULL;
    }
}

References make_ari_stubs::file, internal_type_destroy(), and NULL.

Referenced by aco_info_destroy().

internal_process_ast_config()

static enum aco_process_status internal_process_ast_config ( struct aco_info *  info, struct aco_file *  file, struct ast_config *  cfg  )

static

Definition at line 596 of file config_options.c.

{
    const char *cat = NULL;
 
    if (file->preload) {
        int i;
        for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
            if (process_category(cfg, info, file, file->preload[i], 1)) {
                return ACO_PROCESS_ERROR;
            }
        }
    }
 
    while ((cat = ast_category_browse(cfg, cat))) {
        if (process_category(cfg, info, file, cat, 0)) {
            return ACO_PROCESS_ERROR;
        }
    }
    return ACO_PROCESS_OK;
}

References ACO_PROCESS_ERROR, ACO_PROCESS_OK, ast_category_browse(), ast_strlen_zero(), make_ari_stubs::file, sip_to_pjsip::info(), NULL, and process_category().

Referenced by aco_process_ast_config(), and aco_process_config().

internal_type_destroy()

static void internal_type_destroy ( struct aco_type *  type )

static

Definition at line 818 of file config_options.c.

{
    /* If we've already had all our internal data cleared out,
     * then there's no need to proceed further
     */
    if (!type->internal) {
        return;
    }
 
    if (type->internal->regex) {
        regfree(type->internal->regex);
        ast_free(type->internal->regex);
    }
    ao2_cleanup(type->internal->opts);
    type->internal->opts = NULL;
    ast_free(type->internal);
    type->internal = NULL;
}

References ao2_cleanup, ast_free, NULL, and type.

Referenced by internal_file_types_destroy(), and internal_type_init().

internal_type_init()

static int internal_type_init ( struct aco_type *  type )

static

Definition at line 848 of file config_options.c.

{
    if (!(type->internal = ast_calloc(1, sizeof(*type->internal)))) {
        return -1;
    }
 
    switch (type->category_match) {
    case ACO_BLACKLIST:
    case ACO_WHITELIST:
        if (!(type->internal->regex = build_regex(type->category))) {
            internal_type_destroy(type);
            return -1;
        }
        break;
    case ACO_BLACKLIST_EXACT:
    case ACO_WHITELIST_EXACT:
    case ACO_BLACKLIST_ARRAY:
    case ACO_WHITELIST_ARRAY:
        break;
    }
 
    if (!(type->internal->opts = aco_option_container_alloc())) {
        internal_type_destroy(type);
        return -1;
    }
 
    return 0;
}

References ACO_BLACKLIST, ACO_BLACKLIST_ARRAY, ACO_BLACKLIST_EXACT, aco_option_container_alloc(), ACO_WHITELIST, ACO_WHITELIST_ARRAY, ACO_WHITELIST_EXACT, ast_calloc, build_regex(), internal_type_destroy(), and type.

Referenced by aco_info_init().

is_preload()

static int is_preload ( struct aco_file *  file, const char *  cat  )

static

Definition at line 484 of file config_options.c.

{
    int i;
 
    if (!file->preload) {
        return 0;
    }
 
    for (i = 0; !ast_strlen_zero(file->preload[i]); i++) {
        if (!strcasecmp(cat, file->preload[i])) {
            return 1;
        }
    }
    return 0;
}

References ast_strlen_zero(), and make_ari_stubs::file.

Referenced by process_category().

link_option_to_types()

static int link_option_to_types ( struct aco_info *  info, struct aco_type **  types, struct aco_option *  opt  )

static

Definition at line 186 of file config_options.c.

{
    size_t idx = 0;
    struct aco_type *type;
 
    while ((type = types[idx++])) {
        if (!type->internal) {
            ast_log(LOG_ERROR, "Attempting to register option using uninitialized type\n");
            return -1;
        }
        if (!ao2_link(type->internal->opts, opt)) {
            do {
                ao2_unlink(types[idx - 1]->internal->opts, opt);
            } while (--idx);
            return -1;
        }
#ifdef AST_XML_DOCS
        if (!info->hidden && !opt->no_doc &&
            xmldoc_update_config_option(types, info->module, opt->name, type->name, opt->default_val, opt->match_type == ACO_REGEX, opt->type)) {
#ifdef AST_DEVMODE
            opt->doc_unavailable = 1;
#endif
        }
#endif
    }
    /* The container(s) should hold the only ref to opt */
    ao2_ref(opt, -1);
 
    return 0;
}

References ACO_REGEX, ao2_link, ao2_ref, ao2_unlink, ast_log, aco_option::default_val, sip_to_pjsip::info(), aco_type::internal, LOG_ERROR, aco_option::match_type, aco_option::name, aco_option::no_doc, aco_type_internal::opts, type, aco_option::type, and xmldoc_update_config_option().

Referenced by __aco_option_register(), and aco_option_register_deprecated().

noop_handler_fn()

static int noop_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default handler for doing nothing.

Definition at line 1622 of file config_options.c.

{
    return 0;
}

Referenced by ast_config_option_default_handler().

process_category()

static int process_category ( struct ast_config *  cfg, struct aco_info *  info, struct aco_file *  file, const char *  cat, int  preload  )

static

Definition at line 500 of file config_options.c.

                                                                                                                                {
    RAII_VAR(void *, new_item, NULL, ao2_cleanup);
    struct aco_type *type;
    /* For global types, field is the global option struct. For non-global, it is the container for items.
     * We do not grab a reference to these objects, as the info already holds references to them. This
     * pointer is just a convenience. Do not actually store it somewhere. */
    void **field;
    regex_t *regex_skip;
 
    /* Skip preloaded categories if we aren't preloading */
    if (!preload && is_preload(file, cat)) {
        return 0;
    }
 
    /* Skip the category if we've been told to ignore it */
    if (!ast_strlen_zero(file->skip_category)) {
        regex_skip = build_regex(file->skip_category);
        if (!regexec(regex_skip, cat, 0, NULL, 0)) {
            regfree(regex_skip);
            ast_free(regex_skip);
            return 0;
        }
        regfree(regex_skip);
        ast_free(regex_skip);
    }
 
    /* Find aco_type by category, if not found it is an error */
    if (!(type = internal_aco_type_find(file, cfg, cat))) {
        ast_log(LOG_ERROR, "Could not find config type for category '%s' in '%s'\n", cat, file->filename);
        return -1;
    }
 
    if (type->type == ACO_IGNORE) {
        return 0;
    }
 
    field = info->internal->pending + type->item_offset;
    if (!*field) {
        ast_log(LOG_ERROR, "In %s: %s - No object to update!\n", file->filename, cat);
        return -1;
    }
 
    if (type->type == ACO_GLOBAL && *field) {
        if (aco_process_category_options(type, cfg, cat, *field)) {
            ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
            return -1;
        }
    } else if (type->type == ACO_ITEM) {
        int new = 0;
        /* If we have multiple definitions of a category in a file, or can set the values from multiple
         * files, look up the entry if we've already added it so we can merge the values together.
         * Otherwise, alloc a new item. */
        if (*field) {
            if (!(new_item = type->item_find(*field, cat))) {
                if (!(new_item = type->item_alloc(cat))) {
                    ast_log(LOG_ERROR, "In %s: Could not create item for %s\n", file->filename, cat);
                    return -1;
                }
                if (aco_set_defaults(type, cat, new_item)) {
                    ast_log(LOG_ERROR, "In %s: Setting defaults for %s failed\n", file->filename, cat);
                    return -1;
                }
                new = 1;
            }
        }
 
        if (type->item_pre_process && type->item_pre_process(new_item)) {
            ast_log(LOG_ERROR, "In %s: Preprocess callback for %s failed\n", file->filename, cat);
            return -1;
        }
 
        if (aco_process_category_options(type, cfg, cat, new_item)) {
            ast_log(LOG_ERROR, "In %s: Processing options for %s failed\n", file->filename, cat);
            return -1;
        }
 
        if (type->item_prelink && type->item_prelink(new_item)) {
            ast_log(LOG_ERROR, "In %s: Pre-link callback for %s failed\n", file->filename, cat);
            return -1;
        }
 
        if (new && !ao2_link(*field, new_item)) {
            ast_log(LOG_ERROR, "In %s: Linking config for %s failed\n", file->filename, cat);
            return -1;
        }
    }
    return 0;
}

References ACO_GLOBAL, ACO_IGNORE, ACO_ITEM, aco_process_category_options(), aco_set_defaults(), ao2_cleanup, ao2_link, ast_free, ast_log, ast_strlen_zero(), build_regex(), make_ari_stubs::file, sip_to_pjsip::info(), internal_aco_type_find(), is_preload(), LOG_ERROR, NULL, RAII_VAR, and type.

Referenced by internal_process_ast_config().

sockaddr_handler_fn()

static int sockaddr_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default handler for ast_sockaddrs.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1614 of file config_options.c.

{
    struct ast_sockaddr *field = (struct ast_sockaddr *)(obj + opt->args[0]);
    return ast_parse_arg(var->value, PARSE_ADDR | opt->flags, field);
}

References aco_option::args, ast_parse_arg(), aco_option::flags, PARSE_ADDR, and var.

Referenced by ast_config_option_default_handler().

stringfield_handler_fn()

static int stringfield_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for stringfields.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1569 of file config_options.c.

{
    ast_string_field *field = (const char **)(obj + opt->args[0]);
    struct ast_string_field_pool **pool = (struct ast_string_field_pool **)(obj + opt->args[1]);
    struct ast_string_field_mgr *mgr = (struct ast_string_field_mgr *)(obj + opt->args[2]);
 
    if (opt->flags && ast_strlen_zero(var->value)) {
        return -1;
    }
    ast_string_field_ptr_set_by_fields(*pool, *mgr, field, var->value);
    return 0;
}

References aco_option::args, ast_string_field_ptr_set_by_fields, ast_strlen_zero(), aco_option::flags, and var.

Referenced by ast_config_option_default_handler().

timelen_handler_fn()

static int timelen_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for timelen signed integers.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1507 of file config_options.c.

{
    int *field = (int *)(obj + opt->args[0]);
    unsigned int flags = PARSE_TIMELEN | opt->flags;
    int res = 0;
    if (opt->flags & PARSE_IN_RANGE) {
        if (opt->flags & PARSE_DEFAULT) {
            res = ast_parse_arg(var->value, flags, field, (enum ast_timelen) opt->args[1], (int) opt->args[2], (int) opt->args[3], opt->args[4]);
        } else {
            res = ast_parse_arg(var->value, flags, field, (enum ast_timelen) opt->args[1], (int) opt->args[2], (int) opt->args[3]);
        }
        if (res) {
            if (opt->flags & PARSE_RANGE_DEFAULTS) {
                ast_log(LOG_WARNING, "Failed to set %s=%s. Set to %d instead due to range limit (%d, %d)\n", var->name, var->value, *field, (int) opt->args[2], (int) opt->args[3]);
                res = 0;
            } else if (opt->flags & PARSE_DEFAULT) {
                ast_log(LOG_WARNING, "Failed to set %s=%s, Set to default value %d instead.\n", var->name, var->value, *field);
                res = 0;
            }
        }
    } else if ((opt->flags & PARSE_DEFAULT) && ast_parse_arg(var->value, flags, field, (enum ast_timelen) opt->args[1], (int) opt->args[2])) {
        ast_log(LOG_WARNING, "Attempted to set %s=%s, but set it to %d instead due to default)\n", var->name, var->value, *field);
    } else {
        res = ast_parse_arg(var->value, flags, field, (enum ast_timelen) opt->args[1]);
    }
 
    return res;
}

References aco_option::args, ast_log, ast_parse_arg(), aco_option::flags, LOG_WARNING, PARSE_DEFAULT, PARSE_IN_RANGE, PARSE_RANGE_DEFAULTS, PARSE_TIMELEN, and var.

Referenced by ast_config_option_default_handler().

uint_handler_fn()

static int uint_handler_fn ( const struct aco_option *  opt, struct ast_variable *  var, void *  obj  )

static

Default option handler for unsigned integers.

Note

For a description of the opt->flags and opt->args values, see the documentation for enum aco_option_type in config_options.h

Definition at line 1477 of file config_options.c.

                                                                                              {
    unsigned int *field = (unsigned int *)(obj + opt->args[0]);
    unsigned int flags = PARSE_UINT32 | opt->flags;
    int res = 0;
    if (opt->flags & PARSE_IN_RANGE) {
        res = opt->flags & PARSE_DEFAULT ?
            ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1], (unsigned int) opt->args[2], opt->args[3]) :
            ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1], (unsigned int) opt->args[2]);
        if (res) {
            if (opt->flags & PARSE_RANGE_DEFAULTS) {
                ast_log(LOG_WARNING, "Failed to set %s=%s. Set to %u instead due to range limit (%d, %d)\n", var->name, var->value, *field, (int) opt->args[1], (int) opt->args[2]);
                res = 0;
            } else if (opt->flags & PARSE_DEFAULT) {
                ast_log(LOG_WARNING, "Failed to set %s=%s, Set to default value %u instead.\n", var->name, var->value, *field);
                res = 0;
            }
        }
    } else if ((opt->flags & PARSE_DEFAULT) && ast_parse_arg(var->value, flags, field, (unsigned int) opt->args[1])) {
        ast_log(LOG_WARNING, "Attempted to set %s=%s, but set it to %u instead due to default)\n", var->name, var->value, *field);
    } else {
        res = ast_parse_arg(var->value, flags, field);
    }
 
    return res;
}

References aco_option::args, ast_log, ast_parse_arg(), aco_option::flags, LOG_WARNING, PARSE_DEFAULT, PARSE_IN_RANGE, PARSE_RANGE_DEFAULTS, PARSE_UINT32, and var.

Referenced by ast_config_option_default_handler().

xmldoc_update_config_option()

static int xmldoc_update_config_option ( struct aco_type **  types, const char *  module, const char *  name, const char *  object_name, const char *  default_value, unsigned int  regex, enum aco_option_type  type  )

static

Definition at line 1172 of file config_options.c.

{
    RAII_VAR(struct ast_xml_xpath_results *, results, NULL, ast_xml_xpath_results_free);
    RAII_VAR(struct ast_xml_doc_item *, config_info, ao2_find(xmldocs, module, OBJ_KEY), ao2_cleanup);
    struct ast_xml_doc_item * config_option;
    struct ast_xml_node *option;
 
    ast_assert(ARRAY_LEN(aco_option_type_string) > type);
 
    if (!config_info || !(config_option = find_xmldoc_option(config_info, types, name))) {
        ast_log(LOG_ERROR, "XML Documentation for option '%s' in modules '%s' not found!\n", name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(results = ast_xmldoc_query("/docs/configInfo[@name='%s']/configFile/configObject[@name='%s']/configOption[@name='%s']", module, object_name, name))) {
        ast_log(LOG_WARNING, "Could not find option '%s' with type '%s' in module '%s'\n", name, object_name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(option = ast_xml_xpath_get_first_result(results))) {
        ast_log(LOG_WARNING, "Could not obtain results for option '%s' with type '%s' in module '%s'\n", name, object_name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
    ast_xml_set_attribute(option, "regex", regex ? "true" : "false");
    ast_xml_set_attribute(option, "default", default_value);
    ast_xml_set_attribute(option, "type", aco_option_type_string[type]);
 
    if (ast_xmldoc_regenerate_doc_item(config_option)) {
        ast_log(LOG_WARNING, "Could not update option '%s' with values from config option registration\n", name);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    return 0;
}

References aco_option_type_string, ao2_cleanup, ao2_find, ARRAY_LEN, ast_assert, ast_log, ast_xml_set_attribute(), ast_xml_xpath_get_first_result(), ast_xml_xpath_results_free(), ast_xmldoc_query(), ast_xmldoc_regenerate_doc_item(), find_xmldoc_option(), LOG_ERROR, LOG_WARNING, name, NULL, OBJ_KEY, RAII_VAR, regex(), type, XMLDOC_STRICT, and xmldocs.

Referenced by link_option_to_types().

xmldoc_update_config_type()

static int xmldoc_update_config_type ( const char *  module, const char *  name, const char *  category, const char *  matchfield, const char *  matchvalue, enum aco_category_op  category_match  )

static

Definition at line 1087 of file config_options.c.

{
    RAII_VAR(struct ast_xml_xpath_results *, results, NULL, ast_xml_xpath_results_free);
    RAII_VAR(struct ast_xml_doc_item *, config_info, ao2_find(xmldocs, module, OBJ_KEY), ao2_cleanup);
    struct ast_xml_doc_item *config_type;
    struct ast_xml_node *type, *syntax, *matchinfo, *tmp;
    struct ast_str *derived_category = NULL;
 
    /* If we already have a syntax element, bail. This isn't an error, since we may unload a module which
     * has updated the docs and then load it again. */
    if ((results = ast_xmldoc_query("/docs/configInfo[@name='%s']/configFile/configObject[@name='%s']/syntax", module, name))) {
        return 0;
    }
 
    if (!(results = ast_xmldoc_query("/docs/configInfo[@name='%s']/configFile/configObject[@name='%s']", module, name))) {
        ast_log(LOG_WARNING, "Cannot update type '%s' in module '%s' because it has no existing documentation!"
            " If this module was recently built, run 'xmldoc reload' to refresh documentation, then load the module again\n",
            name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(type = ast_xml_xpath_get_first_result(results))) {
        ast_log(LOG_WARNING, "Could not retrieve documentation for type '%s' in module '%s'\n", name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(syntax = ast_xml_new_child(type, "syntax"))) {
        ast_log(LOG_WARNING, "Could not create syntax node for type '%s' in module '%s'\n", name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(matchinfo = ast_xml_new_child(syntax, "matchInfo"))) {
        ast_log(LOG_WARNING, "Could not create matchInfo node for type '%s' in module '%s'\n", name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (!(tmp = ast_xml_new_child(matchinfo, "category"))) {
        ast_log(LOG_WARNING, "Could not create category node for type '%s' in module '%s'\n", name, module);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    derived_category = derive_category_text(category_match, category);
    if (derived_category) {
        ast_xml_set_text(tmp, ast_str_buffer(derived_category));
        ast_free(derived_category);
    }
 
    switch (category_match) {
    case ACO_WHITELIST:
    case ACO_WHITELIST_EXACT:
    case ACO_WHITELIST_ARRAY:
        ast_xml_set_attribute(tmp, "match", "true");
        break;
    case ACO_BLACKLIST:
    case ACO_BLACKLIST_EXACT:
    case ACO_BLACKLIST_ARRAY:
        ast_xml_set_attribute(tmp, "match", "false");
        break;
    }
 
    if (!ast_strlen_zero(matchfield)) {
        if (!(tmp = ast_xml_new_child(matchinfo, "field"))) {
            ast_log(LOG_WARNING, "Could not add %s attribute for type '%s' in module '%s'\n", matchfield, name, module);
            return XMLDOC_STRICT ? -1 : 0;
        }
        ast_xml_set_attribute(tmp, "name", matchfield);
        ast_xml_set_text(tmp, matchvalue);
    }
 
    if (!config_info || !(config_type = find_xmldoc_type(config_info, name))) {
        ast_log(LOG_WARNING, "Could not obtain XML documentation item for config type %s\n", name);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    if (ast_xmldoc_regenerate_doc_item(config_type)) {
        ast_log(LOG_WARNING, "Could not update type '%s' with values from config type registration\n", name);
        return XMLDOC_STRICT ? -1 : 0;
    }
 
    return 0;
}

References ACO_BLACKLIST, ACO_BLACKLIST_ARRAY, ACO_BLACKLIST_EXACT, ACO_WHITELIST, ACO_WHITELIST_ARRAY, ACO_WHITELIST_EXACT, ao2_cleanup, ao2_find, ast_free, ast_log, ast_str_buffer(), ast_strlen_zero(), ast_xml_new_child(), ast_xml_set_attribute(), ast_xml_set_text(), ast_xml_xpath_get_first_result(), ast_xml_xpath_results_free(), ast_xmldoc_query(), ast_xmldoc_regenerate_doc_item(), derive_category_text(), find_xmldoc_type(), LOG_WARNING, name, NULL, OBJ_KEY, RAII_VAR, tmp(), type, XMLDOC_STRICT, and xmldocs.

Referenced by aco_info_init().

Variable Documentation

aco_option_type_string

char* aco_option_type_string[]

static

Value of the aco_option_type enum as strings.

Definition at line 85 of file config_options.c.

Referenced by xmldoc_update_config_option().

cli_aco

struct ast_cli_entry cli_aco[]

static

Initial value:

= {
    { .handler =  cli_show_help , .summary =  "Show configuration help for a module" ,},
}

Definition at line 1417 of file config_options.c.

Referenced by aco_deinit(), and aco_init().

xmldocs

struct ao2_container* xmldocs

static

Definition at line 82 of file config_options.c.

Referenced by aco_deinit(), aco_init(), cli_show_module_options(), cli_show_module_type(), cli_show_module_types(), cli_show_modules(), complete_config_module(), complete_config_option(), complete_config_type(), xmldoc_update_config_option(), and xmldoc_update_config_type().