func_channel.c File Reference

Channel info dialplan functions. More...

#include "asterisk.h"
#include <regex.h>
#include <ctype.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/bridge.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/indications.h"
#include "asterisk/stringfields.h"
#include "asterisk/global_datastores.h"
#include "asterisk/bridge_basic.h"
#include "asterisk/bridge_after.h"
#include "asterisk/max_forwards.h"

Include dependency graph for func_channel.c:

Go to the source code of this file.

Macros
#define	locked_copy_string(chan, dest, source, len)
#define	locked_string_field_set(chan, field, source)

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	func_chan_exists_read (struct ast_channel *chan, const char *function, char *data, char *buf, size_t maxlen)
static int	func_channel_read (struct ast_channel *chan, const char *function, char *data, char *buf, size_t len)
static int	func_channel_write (struct ast_channel *chan, const char *function, char *data, const char *value)
static int	func_channel_write_real (struct ast_channel *chan, const char *function, char *data, const char *value)
static int	func_channels_read (struct ast_channel *chan, const char *function, char *data, char *buf, size_t maxlen)
static int	func_mchan_read (struct ast_channel *chan, const char *function, char *data, struct ast_str **buf, ssize_t len)
static int	func_mchan_write (struct ast_channel *chan, const char *function, char *data, const char *value)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Channel information dialplan functions" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_custom_function	chan_exists_function
static struct ast_custom_function	channel_function
static struct ast_custom_function	channels_function
static struct ast_custom_function	mchan_function
static const char *const	transfercapability_table [0x20]

Detailed Description

Channel info dialplan functions.

Author

Kevin P. Fleming kpfle.nosp@m.ming.nosp@m.@digi.nosp@m.um.c.nosp@m.om

Ben Winslow

Naveen Albert aster.nosp@m.isk@.nosp@m.phrea.nosp@m.knet.nosp@m..org

Definition in file func_channel.c.

Macro Definition Documentation

locked_copy_string

#define locked_copy_string	(		chan,
			dest,
			source,
			len
	)

Value:

    do { \
        ast_channel_lock(chan); \
        ast_copy_string(dest, source, len); \
        ast_channel_unlock(chan); \
    } while (0)

Definition at line 370 of file func_channel.c.

       { \
        ast_channel_lock(chan); \
        ast_copy_string(dest, source, len); \
        ast_channel_unlock(chan); \
    } while (0)

locked_string_field_set

#define locked_string_field_set	(		chan,
			field,
			source
	)

Value:

    do { \
        ast_channel_lock(chan); \
        ast_channel_##field##_set(chan, source); \
        ast_channel_unlock(chan); \
    } while (0)

Definition at line 376 of file func_channel.c.

       { \
        ast_channel_lock(chan); \
        ast_channel_##field##_set(chan, source); \
        ast_channel_unlock(chan); \
    } while (0)

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 989 of file func_channel.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 989 of file func_channel.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 989 of file func_channel.c.

func_chan_exists_read()

static int func_chan_exists_read ( struct ast_channel *  chan, const char *  function, char *  data, char *  buf, size_t  maxlen  )

static

Definition at line 899 of file func_channel.c.

{
    struct ast_channel *chan_found = NULL;
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "%s: Channel name or unique ID required\n", function);
        return -1;
    }
 
    chan_found = ast_channel_get_by_name(data);
    snprintf(buf, maxlen, "%d", (chan_found ? 1 : 0));
    if (chan_found) {
        ast_channel_unref(chan_found);
    }
    return 0;
}

References ast_channel_get_by_name(), ast_channel_unref, ast_log, ast_strlen_zero(), buf, ast_channel::data, LOG_WARNING, and NULL.

func_channel_read()

static int func_channel_read ( struct ast_channel *  chan, const char *  function, char *  data, char *  buf, size_t  len  )

static

Definition at line 389 of file func_channel.c.

{
    int ret = 0;
    struct ast_format_cap *tmpcap;
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", function);
        return -1;
    }
 
    if (!strcasecmp(data, "audionativeformat")) {
        tmpcap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
        if (tmpcap) {
            struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
 
            ast_channel_lock(chan);
            ast_format_cap_append_from_cap(tmpcap, ast_channel_nativeformats(chan), AST_MEDIA_TYPE_AUDIO);
            ast_channel_unlock(chan);
            ast_copy_string(buf, ast_format_cap_get_names(tmpcap, &codec_buf), len);
            ao2_ref(tmpcap, -1);
        }
    } else if (!strcasecmp(data, "videonativeformat")) {
        tmpcap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
        if (tmpcap) {
            struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
 
            ast_channel_lock(chan);
            ast_format_cap_append_from_cap(tmpcap, ast_channel_nativeformats(chan), AST_MEDIA_TYPE_VIDEO);
            ast_channel_unlock(chan);
            ast_copy_string(buf, ast_format_cap_get_names(tmpcap, &codec_buf), len);
            ao2_ref(tmpcap, -1);
        }
    } else if (!strcasecmp(data, "audioreadformat")) {
        locked_copy_string(chan, buf, ast_format_get_name(ast_channel_readformat(chan)), len);
    } else if (!strcasecmp(data, "audiowriteformat")) {
        locked_copy_string(chan, buf, ast_format_get_name(ast_channel_writeformat(chan)), len);
    } else if (!strcasecmp(data, "tonezone") && ast_channel_zone(chan)) {
        locked_copy_string(chan, buf, ast_channel_zone(chan)->country, len);
    } else if (!strcasecmp(data, "adsicpe")) {
        int adsi;
        ast_channel_lock(chan);
        adsi = ast_channel_adsicpe(chan);
        ast_channel_unlock(chan);
        switch (adsi) {
        case AST_ADSI_AVAILABLE:
            ast_copy_string(buf, "available", len);
            break;
        case AST_ADSI_UNAVAILABLE:
            ast_copy_string(buf, "unavailable", len);
            break;
        case AST_ADSI_OFFHOOKONLY:
            ast_copy_string(buf, "offhookonly", len);
            break;
        default:
            ast_copy_string(buf, "unknown", len);
            break;
        }
    } else if (!strcasecmp(data, "dtmf_features")) {
        if (ast_bridge_features_ds_get_string(chan, buf, len)) {
            buf[0] = '\0';
        }
    } else if (!strcasecmp(data, "language"))
        locked_copy_string(chan, buf, ast_channel_language(chan), len);
    else if (!strcasecmp(data, "musicclass"))
        locked_copy_string(chan, buf, ast_channel_musicclass(chan), len);
    else if (!strcasecmp(data, "name")) {
        locked_copy_string(chan, buf, ast_channel_name(chan), len);
    } else if (!strcasecmp(data, "parkinglot"))
        locked_copy_string(chan, buf, ast_channel_parkinglot(chan), len);
    else if (!strcasecmp(data, "state"))
        locked_copy_string(chan, buf, ast_state2str(ast_channel_state(chan)), len);
    else if (!strcasecmp(data, "onhold")) {
        locked_copy_string(chan, buf,
            ast_channel_hold_state(chan) == AST_CONTROL_HOLD ? "1" : "0", len);
    } else if (!strcasecmp(data, "channeltype"))
        locked_copy_string(chan, buf,
            ast_channel_tech(chan) ? ast_channel_tech(chan)->type : "", len);
    else if (!strcasecmp(data, "accountcode"))
        locked_copy_string(chan, buf, ast_channel_accountcode(chan), len);
    else if (!strcasecmp(data, "checkhangup")) {
        locked_copy_string(chan, buf, ast_check_hangup(chan) ? "1" : "0", len);
    } else if (!strcasecmp(data, "peeraccount"))
        locked_copy_string(chan, buf, ast_channel_peeraccount(chan), len);
    else if (!strcasecmp(data, "hangupsource"))
        locked_copy_string(chan, buf, ast_channel_hangupsource(chan), len);
    else if (!strcasecmp(data, "appname") && ast_channel_appl(chan))
        locked_copy_string(chan, buf, ast_channel_appl(chan), len);
    else if (!strcasecmp(data, "appdata") && ast_channel_data(chan))
        locked_copy_string(chan, buf, ast_channel_data(chan), len);
    else if (!strcasecmp(data, "exten"))
        locked_copy_string(chan, buf, ast_channel_exten(chan), len);
    else if (!strcasecmp(data, "context"))
        locked_copy_string(chan, buf, ast_channel_context(chan), len);
    else if (!strcasecmp(data, "lastexten"))
        locked_copy_string(chan, buf, ast_channel_lastexten(chan), len);
    else if (!strcasecmp(data, "lastcontext"))
        locked_copy_string(chan, buf, ast_channel_lastcontext(chan), len);
    else if (!strcasecmp(data, "userfield"))
        locked_copy_string(chan, buf, ast_channel_userfield(chan), len);
    else if (!strcasecmp(data, "channame"))
        locked_copy_string(chan, buf, ast_channel_name(chan), len);
    else if (!strcasecmp(data, "linkedid")) {
        ast_channel_lock(chan);
        if (ast_strlen_zero(ast_channel_linkedid(chan))) {
            /* fall back on the channel's uniqueid if linkedid is unset */
            ast_copy_string(buf, ast_channel_uniqueid(chan), len);
        }
        else {
            ast_copy_string(buf, ast_channel_linkedid(chan), len);
        }
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "peer")) {
        struct ast_channel *peer;
 
        peer = ast_channel_bridge_peer(chan);
        if (peer) {
            /* Only real channels could have a bridge peer this way. */
            ast_channel_lock(peer);
            ast_copy_string(buf, ast_channel_name(peer), len);
            ast_channel_unlock(peer);
            ast_channel_unref(peer);
        } else {
            buf[0] = '\0';
            ast_channel_lock(chan);
            if (!ast_channel_tech(chan)) {
                const char *pname;
 
                /*
                 * A dummy channel can still pass along bridged peer info
                 * via the BRIDGEPEER variable.
                 *
                 * A horrible kludge, but... how else?
                 */
                pname = pbx_builtin_getvar_helper(chan, "BRIDGEPEER");
                if (!ast_strlen_zero(pname)) {
                    ast_copy_string(buf, pname, len);
                }
            }
            ast_channel_unlock(chan);
        }
    } else if (!strcasecmp(data, "uniqueid")) {
        locked_copy_string(chan, buf, ast_channel_uniqueid(chan), len);
    } else if (!strcasecmp(data, "transfercapability")) {
        locked_copy_string(chan, buf, transfercapability_table[ast_channel_transfercapability(chan) & 0x1f], len);
    } else if (!strcasecmp(data, "callgroup")) {
        char groupbuf[256];
 
        locked_copy_string(chan, buf,  ast_print_group(groupbuf, sizeof(groupbuf), ast_channel_callgroup(chan)), len);
    } else if (!strcasecmp(data, "pickupgroup")) {
        char groupbuf[256];
 
        locked_copy_string(chan, buf,  ast_print_group(groupbuf, sizeof(groupbuf), ast_channel_pickupgroup(chan)), len);
    } else if (!strcasecmp(data, "namedcallgroup")) {
        struct ast_str *tmp_str = ast_str_alloca(1024);
 
        locked_copy_string(chan, buf,  ast_print_namedgroups(&tmp_str, ast_channel_named_callgroups(chan)), len);
    } else if (!strcasecmp(data, "namedpickupgroup")) {
        struct ast_str *tmp_str = ast_str_alloca(1024);
 
        locked_copy_string(chan, buf,  ast_print_namedgroups(&tmp_str, ast_channel_named_pickupgroups(chan)), len);
    } else if (!strcasecmp(data, "after_bridge_goto")) {
        ast_bridge_read_after_goto(chan, buf, len);
    } else if (!strcasecmp(data, "amaflags")) {
        ast_channel_lock(chan);
        snprintf(buf, len, "%u", ast_channel_amaflags(chan));
        ast_channel_unlock(chan);
    } else if (!strncasecmp(data, "secure_bridge_", 14)) {
        struct ast_datastore *ds;
 
        buf[0] = '\0';
        ast_channel_lock(chan);
        if ((ds = ast_channel_datastore_find(chan, &secure_call_info, NULL))) {
            struct ast_secure_call_store *encrypt = ds->data;
 
            if (!strcasecmp(data, "secure_bridge_signaling")) {
                snprintf(buf, len, "%s", encrypt->signaling ? "1" : "");
            } else if (!strcasecmp(data, "secure_bridge_media")) {
                snprintf(buf, len, "%s", encrypt->media ? "1" : "");
            }
        }
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "max_forwards")) {
        ast_channel_lock(chan);
        snprintf(buf, len, "%d", ast_max_forwards_get(chan));
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "callid")) {
        ast_callid callid;
 
        buf[0] = '\0';
        ast_channel_lock(chan);
        callid = ast_channel_callid(chan);
        if (callid) {
            ast_callid_strnprint(buf, len, callid);
        }
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "tdd")) {
        char status;
        int status_size = (int) sizeof(status);
        ret = ast_channel_queryoption(chan, AST_OPTION_TDD, &status, &status_size, 0);
        if (!ret) {
            ast_copy_string(buf, status == 2 ? "mate" : status ? "1" : "0", len);
        }
    } else if (!strcasecmp(data, "digitdetect")) {
        char status;
        int status_size = (int) sizeof(status);
        ret = ast_channel_queryoption(chan, AST_OPTION_DIGIT_DETECT, &status, &status_size, 0);
        if (!ret) {
            ast_copy_string(buf, status ? "1" : "0", len);
        }
    } else if (!strcasecmp(data, "faxdetect")) {
        char status;
        int status_size = (int) sizeof(status);
        ret = ast_channel_queryoption(chan, AST_OPTION_FAX_DETECT, &status, &status_size, 0);
        if (!ret) {
            ast_copy_string(buf, status ? "1" : "0", len);
        }
    } else if (!strcasecmp(data, "device_name")) {
        ret = ast_channel_get_device_name(chan, buf, len);
    } else if (!strcasecmp(data, "tenantid")) {
        locked_copy_string(chan, buf, ast_channel_tenantid(chan), len);
    } else if (!ast_channel_tech(chan) || !ast_channel_tech(chan)->func_channel_read || ast_channel_tech(chan)->func_channel_read(chan, function, data, buf, len)) {
        ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n", data);
        ret = -1;
    }
 
    return ret;
}

References adsi, ao2_ref, AST_ADSI_AVAILABLE, AST_ADSI_OFFHOOKONLY, AST_ADSI_UNAVAILABLE, ast_bridge_features_ds_get_string(), ast_bridge_read_after_goto(), ast_callid_strnprint(), ast_channel_accountcode(), ast_channel_amaflags(), ast_channel_appl(), ast_channel_bridge_peer(), ast_channel_callgroup(), ast_channel_callid(), ast_channel_context(), ast_channel_data(), ast_channel_datastore_find(), ast_channel_exten(), ast_channel_get_device_name(), ast_channel_hangupsource(), ast_channel_hold_state(), ast_channel_language(), ast_channel_lastcontext(), ast_channel_lastexten(), ast_channel_linkedid(), ast_channel_lock, ast_channel_musicclass(), ast_channel_name(), ast_channel_named_callgroups(), ast_channel_named_pickupgroups(), ast_channel_nativeformats(), ast_channel_parkinglot(), ast_channel_peeraccount(), ast_channel_pickupgroup(), ast_channel_queryoption(), ast_channel_readformat(), ast_channel_tenantid(), ast_channel_transfercapability(), ast_channel_uniqueid(), ast_channel_unlock, ast_channel_unref, ast_channel_userfield(), ast_channel_writeformat(), ast_channel_zone(), ast_check_hangup(), AST_CONTROL_HOLD, ast_copy_string(), ast_format_cap_alloc, ast_format_cap_append_from_cap(), AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_cap_get_names(), AST_FORMAT_CAP_NAMES_LEN, ast_format_get_name(), ast_log, ast_max_forwards_get(), AST_MEDIA_TYPE_AUDIO, AST_MEDIA_TYPE_VIDEO, AST_OPTION_DIGIT_DETECT, AST_OPTION_FAX_DETECT, AST_OPTION_TDD, ast_print_group(), ast_print_namedgroups(), ast_state2str(), ast_str_alloca, ast_strlen_zero(), buf, country, ast_datastore::data, ast_channel::data, func_channel_read(), len(), locked_copy_string, LOG_WARNING, ast_secure_call_store::media, NULL, pbx_builtin_getvar_helper(), secure_call_info, ast_secure_call_store::signaling, status, transfercapability_table, and ast_channel_tech::type.

Referenced by func_channel_read().

func_channel_write()

static int func_channel_write ( struct ast_channel *  chan, const char *  function, char *  data, const char *  value  )

static

Definition at line 812 of file func_channel.c.

{
    int res;
    ast_chan_write_info_t write_info = {
        .version = AST_CHAN_WRITE_INFO_T_VERSION,
        .write_fn = func_channel_write_real,
        .chan = chan,
        .function = function,
        .data = data,
        .value = value,
    };
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", function);
        return -1;
    }
 
    res = func_channel_write_real(chan, function, data, value);
    ast_channel_setoption(chan, AST_OPTION_CHANNEL_WRITE, &write_info, sizeof(write_info), 0);
 
    return res;
}

References AST_CHAN_WRITE_INFO_T_VERSION, ast_channel_setoption(), ast_log, AST_OPTION_CHANNEL_WRITE, ast_channel::data, func_channel_write_real(), LOG_WARNING, value, and ast_chan_write_info_t::version.

Referenced by func_channel_write_real().

func_channel_write_real()

static int func_channel_write_real ( struct ast_channel *  chan, const char *  function, char *  data, const char *  value  )

static

Definition at line 618 of file func_channel.c.

{
    int ret = 0;
    signed char gainset;
 
    if (!strcasecmp(data, "language"))
        locked_string_field_set(chan, language, value);
    else if (!strcasecmp(data, "parkinglot"))
        locked_string_field_set(chan, parkinglot, value);
    else if (!strcasecmp(data, "musicclass"))
        locked_string_field_set(chan, musicclass, value);
    else if (!strcasecmp(data, "accountcode"))
        locked_string_field_set(chan, accountcode, value);
    else if (!strcasecmp(data, "userfield"))
        locked_string_field_set(chan, userfield, value);
    else if (!strcasecmp(data, "after_bridge_goto")) {
        if (ast_strlen_zero(value)) {
            ast_bridge_discard_after_goto(chan);
        } else {
            ast_bridge_set_after_go_on(chan, ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan), value);
        }
    } else if (!strcasecmp(data, "amaflags")) {
        int amaflags;
 
        if (isdigit(*value)) {
            if (sscanf(value, "%30d", &amaflags) != 1) {
                amaflags = AST_AMA_NONE;
            }
        } else {
            amaflags = ast_channel_string2amaflag(value);
        }
        ast_channel_lock(chan);
        ast_channel_amaflags_set(chan, amaflags);
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "peeraccount"))
        locked_string_field_set(chan, peeraccount, value);
    else if (!strcasecmp(data, "hangupsource"))
        /* XXX - should we be forcing this here? */
        ast_set_hangupsource(chan, value, 0);
    else if (!strcasecmp(data, "tonezone")) {
        struct ast_tone_zone *new_zone;
        if (!(new_zone = ast_get_indication_zone(value))) {
            ast_log(LOG_ERROR, "Unknown country code '%s' for tonezone. Check indications.conf for available country codes.\n", value);
            ret = -1;
        } else {
            ast_channel_lock(chan);
            if (ast_channel_zone(chan)) {
                ast_channel_zone_set(chan, ast_tone_zone_unref(ast_channel_zone(chan)));
            }
            ast_channel_zone_set(chan, ast_tone_zone_ref(new_zone));
            ast_channel_unlock(chan);
            new_zone = ast_tone_zone_unref(new_zone);
        }
    } else if (!strcasecmp(data, "adsicpe")) {
        int adsi;
        if (!strcasecmp(value, "unknown")) {
            adsi = AST_ADSI_UNKNOWN;
        } else if (!strcasecmp(value, "available")) {
            adsi = AST_ADSI_AVAILABLE;
        } else if (!strcasecmp(value, "unavailable")) {
            adsi = AST_ADSI_UNAVAILABLE;
        } else if (!strcasecmp(value, "offhookonly")) {
            adsi = AST_ADSI_OFFHOOKONLY;
        } else {
            ast_log(LOG_ERROR, "Unknown ADSI availability '%s'\n", value);
            return -1;
        }
        ast_channel_lock(chan);
        ast_channel_adsicpe_set(chan, adsi);
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "dtmf_features")) {
        ret = ast_bridge_features_ds_set_string(chan, value);
    } else if (!strcasecmp(data, "callgroup")) {
        ast_channel_lock(chan);
        ast_channel_callgroup_set(chan, ast_get_group(value));
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "pickupgroup")) {
        ast_channel_lock(chan);
        ast_channel_pickupgroup_set(chan, ast_get_group(value));
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "namedcallgroup")) {
        struct ast_namedgroups *groups = ast_get_namedgroups(value);
 
        ast_channel_lock(chan);
        ast_channel_named_callgroups_set(chan, groups);
        ast_channel_unlock(chan);
        ast_unref_namedgroups(groups);
    } else if (!strcasecmp(data, "namedpickupgroup")) {
        struct ast_namedgroups *groups = ast_get_namedgroups(value);
 
        ast_channel_lock(chan);
        ast_channel_named_pickupgroups_set(chan, groups);
        ast_channel_unlock(chan);
        ast_unref_namedgroups(groups);
    } else if (!strcasecmp(data, "tdd")) {
        char enabled;
        if (!strcasecmp(value, "mate")) {
            enabled = 2;
        } else {
            enabled = ast_true(value) ? 1 : 0;
        }
        ast_channel_setoption(chan, AST_OPTION_TDD, &enabled, sizeof(enabled), 0);
    } else if (!strcasecmp(data, "relaxdtmf")) {
        char enabled = ast_true(value) ? 1 : 0;
        ast_channel_setoption(chan, AST_OPTION_RELAXDTMF, &enabled, sizeof(enabled), 0);
    } else if (!strcasecmp(data, "txgain")) {
        sscanf(value, "%4hhd", &gainset);
        ast_channel_setoption(chan, AST_OPTION_TXGAIN, &gainset, sizeof(gainset), 0);
    } else if (!strcasecmp(data, "rxgain")) {
        sscanf(value, "%4hhd", &gainset);
        ast_channel_setoption(chan, AST_OPTION_RXGAIN, &gainset, sizeof(gainset), 0);
    } else if (!strcasecmp(data, "digitdetect")) {
        char enabled = ast_true(value) ? 1 : 0;
        ast_channel_setoption(chan, AST_OPTION_DIGIT_DETECT, &enabled, sizeof(enabled), 0);
    } else if (!strcasecmp(data, "faxdetect")) {
        char enabled = ast_true(value) ? 1 : 0;
        ast_channel_setoption(chan, AST_OPTION_FAX_DETECT, &enabled, sizeof(enabled), 0);
    } else if (!strcasecmp(data, "transfercapability")) {
        unsigned short i;
 
        ast_channel_lock(chan);
        for (i = 0; i < 0x20; i++) {
            if (!strcasecmp(transfercapability_table[i], value) && strcmp(value, "UNK")) {
                ast_channel_transfercapability_set(chan, i);
                break;
            }
        }
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "hangup_handler_pop")) {
        /* Pop one hangup handler before pushing the new handler. */
        ast_pbx_hangup_handler_pop(chan);
        ast_pbx_hangup_handler_push(chan, value);
    } else if (!strcasecmp(data, "hangup_handler_push")) {
        ast_pbx_hangup_handler_push(chan, value);
    } else if (!strcasecmp(data, "hangup_handler_wipe")) {
        /* Pop all hangup handlers before pushing the new handler. */
        while (ast_pbx_hangup_handler_pop(chan)) {
        }
        ast_pbx_hangup_handler_push(chan, value);
    } else if (!strncasecmp(data, "secure_bridge_", 14)) {
        struct ast_datastore *ds;
        struct ast_secure_call_store *store;
 
        if (!chan || !value) {
            return -1;
        }
 
        ast_channel_lock(chan);
        if (!(ds = ast_channel_datastore_find(chan, &secure_call_info, NULL))) {
            if (!(ds = ast_datastore_alloc(&secure_call_info, NULL))) {
                ast_channel_unlock(chan);
                return -1;
            }
            if (!(store = ast_calloc(1, sizeof(*store)))) {
                ast_channel_unlock(chan);
                ast_free(ds);
                return -1;
            }
            ds->data = store;
            ast_channel_datastore_add(chan, ds);
        } else {
            store = ds->data;
        }
 
        if (!strcasecmp(data, "secure_bridge_signaling")) {
            store->signaling = ast_true(value) ? 1 : 0;
        } else if (!strcasecmp(data, "secure_bridge_media")) {
            store->media = ast_true(value) ? 1 : 0;
        }
        ast_channel_unlock(chan);
    } else if (!strcasecmp(data, "max_forwards")) {
        int max_forwards;
        if (sscanf(value, "%d", &max_forwards) != 1) {
            ast_log(LOG_WARNING, "Unable to set max forwards to '%s'\n", value);
            ret = -1;
        } else {
            ast_channel_lock(chan);
            ret = ast_max_forwards_set(chan, max_forwards);
            ast_channel_unlock(chan);
        }
    } else if (!strcasecmp(data, "tenantid")) {
        ast_channel_tenantid_set(chan, value);
    } else if (!ast_channel_tech(chan)
         || !ast_channel_tech(chan)->func_channel_write
         || ast_channel_tech(chan)->func_channel_write(chan, function, data, value)) {
        ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n",
                data);
        ret = -1;
    }
 
    return ret;
}

References accountcode, adsi, amaflags, AST_ADSI_AVAILABLE, AST_ADSI_OFFHOOKONLY, AST_ADSI_UNAVAILABLE, AST_ADSI_UNKNOWN, AST_AMA_NONE, ast_bridge_discard_after_goto(), ast_bridge_features_ds_set_string(), ast_bridge_set_after_go_on(), ast_calloc, ast_channel_adsicpe_set(), ast_channel_amaflags_set(), ast_channel_callgroup_set(), ast_channel_context(), ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_exten(), ast_channel_lock, ast_channel_named_callgroups_set(), ast_channel_named_pickupgroups_set(), ast_channel_pickupgroup_set(), ast_channel_priority(), ast_channel_setoption(), ast_channel_string2amaflag(), ast_channel_tenantid_set(), ast_channel_transfercapability_set(), ast_channel_unlock, ast_channel_zone(), ast_channel_zone_set(), ast_datastore_alloc, ast_free, ast_get_group(), ast_get_indication_zone(), ast_get_namedgroups(), ast_log, ast_max_forwards_set(), AST_OPTION_DIGIT_DETECT, AST_OPTION_FAX_DETECT, AST_OPTION_RELAXDTMF, AST_OPTION_RXGAIN, AST_OPTION_TDD, AST_OPTION_TXGAIN, ast_pbx_hangup_handler_pop(), ast_pbx_hangup_handler_push(), ast_set_hangupsource(), ast_strlen_zero(), ast_tone_zone_ref(), ast_tone_zone_unref(), ast_true(), ast_unref_namedgroups(), ast_datastore::data, enabled, func_channel_write(), language, locked_string_field_set, LOG_ERROR, LOG_WARNING, ast_secure_call_store::media, NULL, secure_call_info, ast_secure_call_store::signaling, transfercapability_table, and value.

Referenced by func_channel_write().

func_channels_read()

static int func_channels_read ( struct ast_channel *  chan, const char *  function, char *  data, char *  buf, size_t  maxlen  )

static

Definition at line 841 of file func_channel.c.

{
    struct ast_channel *c = NULL;
    regex_t re;
    int res;
    size_t buflen = 0;
    struct ast_channel_iterator *iter;
 
    buf[0] = '\0';
 
    if (!ast_strlen_zero(data)) {
        if ((res = regcomp(&re, data, REG_EXTENDED | REG_ICASE | REG_NOSUB))) {
            regerror(res, &re, buf, maxlen);
            ast_log(LOG_WARNING, "Error compiling regular expression for %s(%s): %s\n", function, data, buf);
            return -1;
        }
    }
 
    if (!(iter = ast_channel_iterator_all_new())) {
        if (!ast_strlen_zero(data)) {
            regfree(&re);
        }
        return -1;
    }
 
    while ((c = ast_channel_iterator_next(iter))) {
        ast_channel_lock(c);
        if (ast_strlen_zero(data) || regexec(&re, ast_channel_name(c), 0, NULL, 0) == 0) {
            size_t namelen = strlen(ast_channel_name(c));
            if (buflen + namelen + (ast_strlen_zero(buf) ? 0 : 1) + 1 < maxlen) {
                if (!ast_strlen_zero(buf)) {
                    strcat(buf, " ");
                    buflen++;
                }
                strcat(buf, ast_channel_name(c));
                buflen += namelen;
            } else {
                ast_log(LOG_WARNING, "Number of channels exceeds the available buffer space.  Output will be truncated!\n");
            }
        }
        ast_channel_unlock(c);
        c = ast_channel_unref(c);
    }
 
    ast_channel_iterator_destroy(iter);
 
    if (!ast_strlen_zero(data)) {
        regfree(&re);
    }
 
    return 0;
}

References ast_channel_iterator_all_new(), ast_channel_iterator_destroy(), ast_channel_iterator_next(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_channel_unref, ast_log, ast_strlen_zero(), buf, c, LOG_WARNING, and NULL.

func_mchan_read()

static int func_mchan_read ( struct ast_channel *  chan, const char *  function, char *  data, struct ast_str **  buf, ssize_t  len  )

static

Definition at line 921 of file func_channel.c.

{
    struct ast_channel *mchan;
    char *template = ast_alloca(4 + strlen(data));
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", function);
        return -1;
    }
 
    mchan = ast_channel_get_by_name(ast_channel_linkedid(chan));
    sprintf(template, "${%s}", data); /* SAFE */
    ast_str_substitute_variables(buf, len, mchan ? mchan : chan, template);
    if (mchan) {
        ast_channel_unref(mchan);
    }
    return 0;
}

References ast_alloca, ast_channel_get_by_name(), ast_channel_linkedid(), ast_channel_unref, ast_log, ast_str_substitute_variables(), buf, ast_channel::data, len(), and LOG_WARNING.

func_mchan_write()

static int func_mchan_write ( struct ast_channel *  chan, const char *  function, char *  data, const char *  value  )

static

Definition at line 941 of file func_channel.c.

{
    struct ast_channel *mchan;
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", function);
        return -1;
    }
 
    mchan = ast_channel_get_by_name(ast_channel_linkedid(chan));
    pbx_builtin_setvar_helper(mchan ? mchan : chan, data, value);
    if (mchan) {
        ast_channel_unref(mchan);
    }
    return 0;
}

References ast_channel_get_by_name(), ast_channel_linkedid(), ast_channel_unref, ast_log, ast_channel::data, LOG_WARNING, pbx_builtin_setvar_helper(), and value.

load_module()

static int load_module ( void  )

static

Definition at line 977 of file func_channel.c.

{
    int res = 0;
 
    res |= ast_custom_function_register(&channel_function);
    res |= ast_custom_function_register(&channels_function);
    res |= ast_custom_function_register(&chan_exists_function);
    res |= ast_custom_function_register(&mchan_function);
 
    return res;
}

References ast_custom_function_register, chan_exists_function, channel_function, channels_function, and mchan_function.

unload_module()

static int unload_module ( void  )

static

Definition at line 965 of file func_channel.c.

{
    int res = 0;
 
    res |= ast_custom_function_unregister(&channel_function);
    res |= ast_custom_function_unregister(&channels_function);
    res |= ast_custom_function_unregister(&chan_exists_function);
    res |= ast_custom_function_unregister(&mchan_function);
 
    return res;
}

References ast_custom_function_unregister(), chan_exists_function, channel_function, channels_function, and mchan_function.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Channel information dialplan functions" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 989 of file func_channel.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 989 of file func_channel.c.

chan_exists_function

struct ast_custom_function chan_exists_function

static

Initial value:

= {
    .name = "CHANNEL_EXISTS",
    .read = func_chan_exists_read,
}

Definition at line 916 of file func_channel.c.

                                                         {
    .name = "CHANNEL_EXISTS",
    .read = func_chan_exists_read,
};

Referenced by load_module(), and unload_module().

channel_function

struct ast_custom_function channel_function

static

Initial value:

= {
    .name = "CHANNEL",
    .read = func_channel_read,
    .write = func_channel_write,
}

Definition at line 835 of file func_channel.c.

                                                     {
    .name = "CHANNEL",
    .read = func_channel_read,
    .write = func_channel_write,
};

Referenced by load_module(), and unload_module().

channels_function

struct ast_custom_function channels_function

static

Initial value:

= {
    .name = "CHANNELS",
    .read = func_channels_read,
}

Definition at line 894 of file func_channel.c.

                                                      {
    .name = "CHANNELS",
    .read = func_channels_read,
};

Referenced by load_module(), and unload_module().

mchan_function

struct ast_custom_function mchan_function

static

Initial value:

= {
    .name = "MASTER_CHANNEL",
    .read2 = func_mchan_read,
    .write = func_mchan_write,
}

Definition at line 959 of file func_channel.c.

                                                   {
    .name = "MASTER_CHANNEL",
    .read2 = func_mchan_read,
    .write = func_mchan_write,
};

Referenced by load_module(), and unload_module().

transfercapability_table

const char* const transfercapability_table[0x20]

static

Initial value:

= {
    "SPEECH", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "DIGITAL", "RESTRICTED_DIGITAL", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "3K1AUDIO", "DIGITAL_W_TONES", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "VIDEO", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", }

Definition at line 383 of file func_channel.c.

                                                           {
    "SPEECH", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "DIGITAL", "RESTRICTED_DIGITAL", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "3K1AUDIO", "DIGITAL_W_TONES", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK",
    "VIDEO", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", "UNK", };

Referenced by func_channel_read(), and func_channel_write_real().