res_aeap.c File Reference

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/module.h"
#include "asterisk/sorcery.h"
#include "asterisk/cli.h"
#include "asterisk/format.h"
#include "asterisk/format_cap.h"
#include "asterisk/res_aeap.h"
#include "res_aeap/general.h"

Include dependency graph for res_aeap.c:

Go to the source code of this file.

Data Structures
struct	ast_aeap_client_config

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
static int	aeap_cli_show (void *obj, void *arg, int flags)
static struct ast_aeap *	aeap_create (const char *id, const struct ast_aeap_params *params, int connect, int timeout)
static char *	aeap_tab_complete_name (const char *word, struct ao2_container *container)
const struct ast_format_cap *	ast_aeap_client_config_codecs (const struct ast_aeap_client_config *cfg)
	Retrieve codec capabilities from the configuration. More...
int	ast_aeap_client_config_has_protocol (const struct ast_aeap_client_config *cfg, const char *protocol)
	Check a given protocol against that in an Asterisk external application configuration. More...
struct ao2_container *	ast_aeap_client_configs_get (const char *protocol)
	Retrieve a listing of all client configuration objects by protocol. More...
struct ast_aeap *	ast_aeap_create_and_connect_by_id (const char *id, const struct ast_aeap_params *params, int timeout)
	Create and connect to an Asterisk external application by sorcery id. More...
struct ast_aeap *	ast_aeap_create_by_id (const char *id, const struct ast_aeap_params *params)
	Create an Asterisk external application object by sorcery id. More...
struct ast_variable *	ast_aeap_custom_fields_get (const char *id)
	Retrieve a list of custom configuration fields. More...
struct ast_sorcery *	ast_aeap_sorcery (void)
	Retrieve the AEAP sorcery object. More...
struct ast_module *	AST_MODULE_SELF_SYM (void)
static void *	client_config_alloc (const char *name)
static int	client_config_apply (const struct ast_sorcery *sorcery, void *obj)
static void	client_config_destructor (void *obj)
static struct ast_aeap_client_config *	client_config_get (const char *id)
static char *	client_config_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	client_config_show_all (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	load_module (void)
static int	reload_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Asterisk External Application Protocol Module for Asterisk" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_http_websocket", }
static struct ast_cli_entry	aeap_cli []
static struct ast_sorcery *	aeap_sorcery
static const struct ast_module_info *	ast_module_info = &__mod_info

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 424 of file res_aeap.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 424 of file res_aeap.c.

aeap_cli_show()

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

static

Definition at line 207 of file res_aeap.c.

{
    struct ast_cli_args *a = arg;
    struct ast_variable *options;
    struct ast_variable *i;
 
    if (!obj) {
        ast_cli(a->fd, "No AEAP configuration found\n");
        return 0;
    }
 
    options = ast_variable_list_sort(ast_sorcery_objectset_create(aeap_sorcery, obj));
    if (!options) {
        return 0;
    }
 
    ast_cli(a->fd, "%s: %s\n", ast_sorcery_object_get_type(obj),
        ast_sorcery_object_get_id(obj));
 
    for (i = options; i; i = i->next) {
        ast_cli(a->fd, "\t%s: %s\n", i->name, i->value);
    }
 
    ast_cli(a->fd, "\n");
 
    ast_variables_destroy(options);
 
    return 0;
}

References a, aeap_sorcery, ast_cli(), ast_sorcery_object_get_id(), ast_sorcery_object_get_type(), ast_sorcery_objectset_create, ast_variable_list_sort(), ast_variables_destroy(), ast_variable::name, ast_variable::next, options, and ast_variable::value.

Referenced by client_config_show(), and client_config_show_all().

aeap_create()

static struct ast_aeap * aeap_create ( const char *  id, const struct ast_aeap_params *  params, int  connect, int  timeout  )

static

Definition at line 304 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg;
    struct ast_aeap *aeap;
    const char *url = NULL;
    const char *protocol = NULL;
 
    cfg = client_config_get(id);
    if (cfg) {
        url = cfg->url;
        protocol = cfg->protocol;
    }
 
#ifdef TEST_FRAMEWORK
    else if (ast_begins_with(id, "_aeap_test_")) {
        url = "ws://127.0.0.1:8088/ws";
        protocol = id;
    }
#endif
 
    if (!url && !protocol) {
        ast_log(LOG_ERROR, "AEAP: unable to get configuration for '%s'\n", id);
        return NULL;
    }
 
    aeap = connect ? ast_aeap_create_and_connect(url, params, url, protocol, timeout) :
        ast_aeap_create(url, params);
 
    ao2_cleanup(cfg);
    return aeap;
}

References ao2_cleanup, ast_aeap_create(), ast_aeap_create_and_connect(), ast_begins_with(), ast_log, client_config_get(), id, LOG_ERROR, NULL, ast_aeap::params, ast_aeap_client_config::protocol, ast_aeap_client_config::url, and url.

Referenced by ast_aeap_create_and_connect_by_id(), and ast_aeap_create_by_id().

aeap_tab_complete_name()

static char * aeap_tab_complete_name ( const char *  word, struct ao2_container *  container  )

static

Definition at line 182 of file res_aeap.c.

{
    void *obj;
    struct ao2_iterator it;
    int wordlen = strlen(word);
    int ret;
 
    it = ao2_iterator_init(container, 0);
    while ((obj = ao2_iterator_next(&it))) {
        if (!strncasecmp(word, ast_sorcery_object_get_id(obj), wordlen)) {
            ret = ast_cli_completion_add(ast_strdup(ast_sorcery_object_get_id(obj)));
            if (ret) {
                ao2_ref(obj, -1);
                break;
            }
        }
        ao2_ref(obj, -1);
    }
    ao2_iterator_destroy(&it);
 
    ao2_ref(container, -1);
 
    return NULL;
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli_completion_add(), ast_sorcery_object_get_id(), ast_strdup, container, and NULL.

Referenced by client_config_show().

ast_aeap_client_config_codecs()

const struct ast_format_cap * ast_aeap_client_config_codecs

(

const struct ast_aeap_client_config *

cfg

)

Retrieve codec capabilities from the configuration.

Parameters

cfg	A configuration object

Returns

The configuration's codec capabilities

Definition at line 151 of file res_aeap.c.

{
    return cfg->codecs;
}

References ast_aeap_client_config::codecs.

Referenced by load_engine().

ast_aeap_client_config_has_protocol()

int ast_aeap_client_config_has_protocol	(	const struct ast_aeap_client_config *	cfg,
		const char *	protocol
	)

Check a given protocol against that in an Asterisk external application configuration.

Parameters

cfg	A configuration object
protocol	The protocol to check

Returns

True if the configuration's protocol matches, false otherwise

Definition at line 156 of file res_aeap.c.

{
    return !strcmp(protocol, cfg->protocol);
}

References ast_aeap_client_config::protocol.

Referenced by load_engine(), and unload_engine().

ast_aeap_client_configs_get()

struct ao2_container * ast_aeap_client_configs_get

(

const char *

protocol

)

Retrieve a listing of all client configuration objects by protocol.

Note

Caller is responsible for the returned container's reference.

Parameters

protocol

An optional protocol to filter on (if NULL returns all client configs)

Returns

A container of client configuration objects

Definition at line 162 of file res_aeap.c.

{
    struct ao2_container *container;
    struct ast_variable *var;
 
    var = protocol ? ast_variable_new("protocol ==", protocol, "") : NULL;
 
    container = ast_sorcery_retrieve_by_fields(aeap_sorcery,
        AEAP_CONFIG_CLIENT, AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, var);
 
    ast_variables_destroy(var);
 
    return container;
}

References AEAP_CONFIG_CLIENT, aeap_sorcery, AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), ast_variable_new, ast_variables_destroy(), container, NULL, and var.

Referenced by client_config_show(), client_config_show_all(), load_module(), speech_observer_loaded(), and unload_module().

ast_aeap_create_and_connect_by_id()

struct ast_aeap * ast_aeap_create_and_connect_by_id	(	const char *	id,
		const struct ast_aeap_params *	params,
		int	timeout
	)

Create and connect to an Asterisk external application by sorcery id.

Parameters

id	The sorcery id to lookup
params	Callbacks and other parameters to use
timeout	How long (in milliseconds) to attempt to connect (-1 equals infinite)

Returns

A new ao2 reference counted aeap object, or NULL on error

Definition at line 342 of file res_aeap.c.

{
    return aeap_create(id, params, 1, timeout);
}

References aeap_create(), and ast_aeap::params.

Referenced by speech_aeap_engine_create().

ast_aeap_create_by_id()

struct ast_aeap * ast_aeap_create_by_id	(	const char *	id,
		const struct ast_aeap_params *	params
	)

Create an Asterisk external application object by sorcery id.

Parameters

id	The sorcery id to lookup
params	Callbacks and other parameters to use

Returns

A new ao2 reference counted aeap object, or NULL on error

Definition at line 337 of file res_aeap.c.

{
    return aeap_create(id, params, 0, 0);
}

References aeap_create(), and ast_aeap::params.

ast_aeap_custom_fields_get()

struct ast_variable * ast_aeap_custom_fields_get

(

const char *

id

)

Retrieve a list of custom configuration fields.

Parameters

id	configuration id/sorcery lookup key

Returns

variables, or NULL on error

Definition at line 348 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg;
    struct ast_variable *vars;
 
    cfg = client_config_get(id);
    if (!cfg) {
        ast_log(LOG_WARNING, "AEAP: no client configuration '%s' to get fields\n", id);
        return NULL;
    }
 
    vars = ast_sorcery_objectset_create(aeap_sorcery, cfg);
 
    ao2_ref(cfg, -1);
    return vars;
}

References aeap_sorcery, ao2_ref, ast_log, ast_sorcery_objectset_create, client_config_get(), LOG_WARNING, and NULL.

Referenced by speech_aeap_engine_create().

ast_aeap_sorcery()

struct ast_sorcery * ast_aeap_sorcery

(

void

)

Retrieve the AEAP sorcery object.

Returns

the AEAP sorcery object

Definition at line 87 of file res_aeap.c.

                                           {
    return aeap_sorcery;
}

References aeap_sorcery.

Referenced by load_module(), and unload_module().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 424 of file res_aeap.c.

client_config_alloc()

static void * client_config_alloc ( const char *  name )

static

Definition at line 112 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg;
 
    cfg = ast_sorcery_generic_alloc(sizeof(*cfg), client_config_destructor);
    if (!cfg) {
        return NULL;
    }
 
    if (ast_string_field_init(cfg, 512)) {
        ao2_ref(cfg, -1);
        return NULL;
    }
 
    if (!(cfg->codecs = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
        ao2_ref(cfg, -1);
        return NULL;
    }
 
    return cfg;
}

References ao2_ref, ast_format_cap_alloc, AST_FORMAT_CAP_FLAG_DEFAULT, ast_sorcery_generic_alloc(), ast_string_field_init, client_config_destructor(), ast_aeap_client_config::codecs, and NULL.

Referenced by load_module().

client_config_apply()

static int client_config_apply ( const struct ast_sorcery *  sorcery, void *  obj  )

static

Definition at line 134 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg = obj;
 
    if (ast_strlen_zero(cfg->url)) {
        ast_log(LOG_ERROR, "AEAP - URL must be present for '%s'\n", ast_sorcery_object_get_id(cfg));
        return -1;
    }
 
    if (!ast_begins_with(cfg->url, "ws")) {
        ast_log(LOG_ERROR, "AEAP - URL must be ws or wss for '%s'\n", ast_sorcery_object_get_id(cfg));
        return -1;
    }
 
    return 0;
}

References ast_begins_with(), ast_log, ast_sorcery_object_get_id(), ast_strlen_zero(), LOG_ERROR, and ast_aeap_client_config::url.

Referenced by load_module().

client_config_destructor()

static void client_config_destructor ( void *  obj )

static

Definition at line 104 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg = obj;
 
    ast_string_field_free_memory(cfg);
    ao2_cleanup(cfg->codecs);
}

References ao2_cleanup, ast_string_field_free_memory, and ast_aeap_client_config::codecs.

Referenced by client_config_alloc().

client_config_get()

static struct ast_aeap_client_config * client_config_get ( const char *  id )

static

Definition at line 177 of file res_aeap.c.

{
    return ast_sorcery_retrieve_by_id(aeap_sorcery, AEAP_CONFIG_CLIENT, id);
}

References AEAP_CONFIG_CLIENT, aeap_sorcery, and ast_sorcery_retrieve_by_id().

Referenced by aeap_create(), ast_aeap_custom_fields_get(), and client_config_show().

client_config_show()

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

static

Definition at line 237 of file res_aeap.c.

{
    struct ast_aeap_client_config *cfg;
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "aeap show client";
        e->usage =
            "Usage: aeap show client <id>\n"
            "       Show the AEAP settings for a given client\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 3) {
            return aeap_tab_complete_name(a->word, ast_aeap_client_configs_get(NULL));
        } else {
            return NULL;
        }
    }
 
    if (a->argc != 4) {
        return CLI_SHOWUSAGE;
    }
 
    cfg = client_config_get(a->argv[3]);
    aeap_cli_show(cfg, a, 0);
    ao2_cleanup(cfg);
 
    return CLI_SUCCESS;
}

References a, aeap_cli_show(), aeap_tab_complete_name(), ao2_cleanup, ast_aeap_client_configs_get(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, client_config_get(), ast_cli_entry::command, NULL, and ast_cli_entry::usage.

client_config_show_all()

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

static

Definition at line 267 of file res_aeap.c.

{
    struct ao2_container *container;
 
    switch(cmd) {
    case CLI_INIT:
        e->command = "aeap show clients";
        e->usage =
            "Usage: aeap show clients\n"
            "       Show all configured AEAP clients\n";
        return NULL;
    case CLI_GENERATE:
        return NULL;
    }
 
    if (a->argc != 3) {
        return CLI_SHOWUSAGE;
    }
 
    container = ast_aeap_client_configs_get(NULL);
    if (!container || ao2_container_count(container) == 0) {
        ast_cli(a->fd, "No AEAP clients found\n");
        ao2_cleanup(container);
        return CLI_SUCCESS;
    }
 
    ao2_callback(container, OBJ_NODATA, aeap_cli_show, a);
    ao2_ref(container, -1);
 
    return CLI_SUCCESS;
}

References a, aeap_cli_show(), ao2_callback, ao2_cleanup, ao2_container_count(), ao2_ref, ast_aeap_client_configs_get(), ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, container, NULL, OBJ_NODATA, and ast_cli_entry::usage.

load_module()

static int load_module ( void  )

static

Definition at line 384 of file res_aeap.c.

{
    if (aeap_general_initialize()) {
        return AST_MODULE_LOAD_DECLINE;
    }
 
    if (!(aeap_sorcery = ast_sorcery_open()))
    {
        ast_log(LOG_ERROR, "AEAP - failed to open sorcery\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_apply_default(aeap_sorcery, AEAP_CONFIG_CLIENT, "config", "aeap.conf,criteria=type=client");
 
    if (ast_sorcery_object_register(aeap_sorcery, "client", client_config_alloc,
        NULL, client_config_apply)) {
        ast_log(LOG_ERROR, "AEAP - failed to register client sorcery object\n");
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_sorcery_object_field_register(aeap_sorcery, AEAP_CONFIG_CLIENT, "type", "", OPT_NOOP_T, 0, 0);
    ast_sorcery_object_field_register(aeap_sorcery, AEAP_CONFIG_CLIENT, "url", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_aeap_client_config, url));
    ast_sorcery_object_field_register(aeap_sorcery, AEAP_CONFIG_CLIENT, "protocol", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_aeap_client_config, protocol));
    ast_sorcery_object_field_register(aeap_sorcery, AEAP_CONFIG_CLIENT, "codecs", "", OPT_CODEC_T, 1, FLDSET(struct ast_aeap_client_config, codecs));
 
    ast_sorcery_load(aeap_sorcery);
 
    ast_cli_register_multiple(aeap_cli, ARRAY_LEN(aeap_cli));
 
    return 0;
}

References aeap_cli, AEAP_CONFIG_CLIENT, aeap_general_initialize(), aeap_sorcery, ARRAY_LEN, ast_cli_register_multiple, ast_log, AST_MODULE_LOAD_DECLINE, ast_sorcery_apply_default, ast_sorcery_load(), ast_sorcery_object_field_register, ast_sorcery_object_register, ast_sorcery_open, client_config_alloc(), client_config_apply(), codecs, FLDSET, LOG_ERROR, NULL, OPT_CODEC_T, OPT_NOOP_T, OPT_STRINGFIELD_T, STRFLDSET, and url.

reload_module()

static int reload_module ( void  )

static

Definition at line 365 of file res_aeap.c.

{
    ast_sorcery_reload(aeap_sorcery);
 
    return 0;
}

References aeap_sorcery, and ast_sorcery_reload().

unload_module()

static int unload_module ( void  )

static

Definition at line 372 of file res_aeap.c.

{
    ast_sorcery_unref(aeap_sorcery);
    aeap_sorcery = NULL;
 
    ast_cli_unregister_multiple(aeap_cli, ARRAY_LEN(aeap_cli));
 
    aeap_general_finalize();
 
    return 0;
}

References aeap_cli, aeap_general_finalize(), aeap_sorcery, ARRAY_LEN, ast_cli_unregister_multiple(), ast_sorcery_unref, and NULL.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Asterisk External Application Protocol Module for Asterisk" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_module, .load_pri = AST_MODPRI_CHANNEL_DEPEND, .requires = "res_http_websocket", }

static

Definition at line 424 of file res_aeap.c.

aeap_cli

struct ast_cli_entry aeap_cli[]

static

Initial value:

= {
    { .handler =  client_config_show , .summary =  "Show AEAP client configuration by id" ,},
    { .handler =  client_config_show_all , .summary =  "Show all AEAP client configurations" ,},
}

Definition at line 299 of file res_aeap.c.

Referenced by load_module(), and unload_module().

aeap_sorcery

struct ast_sorcery* aeap_sorcery

static

Definition at line 85 of file res_aeap.c.

Referenced by aeap_cli_show(), ast_aeap_client_configs_get(), ast_aeap_custom_fields_get(), ast_aeap_sorcery(), client_config_get(), load_module(), reload_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 424 of file res_aeap.c.