![tilghman](/assets/img/avatar_default.png)
function and begin the transition from SIPCHANINFO() to just using CHANNEL(). (closes issue #12856) Reported by: mostyn Patches: iax_and_sip_channel_info.patch uploaded by mostyn (license 398) (with some additional cleanup by me) git-svn-id: http://svn.digium.com/svn/asterisk/trunk@122802 f38db490-d61c-443f-a65b-d21fe96a405b
322 lines
12 KiB
C
322 lines
12 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2006, Digium, Inc.
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Channel info dialplan functions
|
|
*
|
|
* \author Kevin P. Fleming <kpfleming@digium.com>
|
|
* \author Ben Winslow
|
|
*
|
|
* \ingroup functions
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include <regex.h>
|
|
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/utils.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/indications.h"
|
|
#include "asterisk/stringfields.h"
|
|
|
|
#define locked_copy_string(chan, dest, source, len) \
|
|
do { \
|
|
ast_channel_lock(chan); \
|
|
ast_copy_string(dest, source, len); \
|
|
ast_channel_unlock(chan); \
|
|
} while (0)
|
|
#define locked_string_field_set(chan, field, source) \
|
|
do { \
|
|
ast_channel_lock(chan); \
|
|
ast_string_field_set(chan, field, source); \
|
|
ast_channel_unlock(chan); \
|
|
} while (0)
|
|
|
|
char *transfercapability_table[0x20] = {
|
|
"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", };
|
|
|
|
static int func_channel_read(struct ast_channel *chan, const char *function,
|
|
char *data, char *buf, size_t len)
|
|
{
|
|
int ret = 0;
|
|
|
|
if (!strcasecmp(data, "audionativeformat"))
|
|
/* use the _multiple version when chan->nativeformats holds multiple formats */
|
|
/* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_AUDIO_MASK); */
|
|
ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_AUDIO_MASK), len);
|
|
else if (!strcasecmp(data, "videonativeformat"))
|
|
/* use the _multiple version when chan->nativeformats holds multiple formats */
|
|
/* ast_getformatname_multiple(buf, len, chan->nativeformats & AST_FORMAT_VIDEO_MASK); */
|
|
ast_copy_string(buf, ast_getformatname(chan->nativeformats & AST_FORMAT_VIDEO_MASK), len);
|
|
else if (!strcasecmp(data, "audioreadformat"))
|
|
ast_copy_string(buf, ast_getformatname(chan->readformat), len);
|
|
else if (!strcasecmp(data, "audiowriteformat"))
|
|
ast_copy_string(buf, ast_getformatname(chan->writeformat), len);
|
|
#ifdef CHANNEL_TRACE
|
|
else if (!strcasecmp(data, "trace")) {
|
|
ast_channel_lock(chan);
|
|
ast_copy_string(buf, ast_channel_trace_is_enabled(chan) ? "1" : "0", len);
|
|
ast_channel_unlock(chan);
|
|
}
|
|
#endif
|
|
else if (!strcasecmp(data, "tonezone") && chan->zone)
|
|
locked_copy_string(chan, buf, chan->zone->country, len);
|
|
else if (!strcasecmp(data, "language"))
|
|
locked_copy_string(chan, buf, chan->language, len);
|
|
else if (!strcasecmp(data, "musicclass"))
|
|
locked_copy_string(chan, buf, chan->musicclass, len);
|
|
else if (!strcasecmp(data, "parkinglot"))
|
|
locked_copy_string(chan, buf, chan->parkinglot, len);
|
|
else if (!strcasecmp(data, "state"))
|
|
locked_copy_string(chan, buf, ast_state2str(chan->_state), len);
|
|
else if (!strcasecmp(data, "channeltype"))
|
|
locked_copy_string(chan, buf, chan->tech->type, len);
|
|
else if (!strcasecmp(data, "transfercapability"))
|
|
locked_copy_string(chan, buf, transfercapability_table[chan->transfercapability & 0x1f], len);
|
|
else if (!strcasecmp(data, "callgroup")) {
|
|
char groupbuf[256];
|
|
locked_copy_string(chan, buf, ast_print_group(groupbuf, sizeof(groupbuf), chan->callgroup), len);
|
|
} else if (!chan->tech->func_channel_read
|
|
|| chan->tech->func_channel_read(chan, function, data, buf, len)) {
|
|
ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n", data);
|
|
ret = -1;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
static int func_channel_write(struct ast_channel *chan, const char *function,
|
|
char *data, const char *value)
|
|
{
|
|
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);
|
|
#ifdef CHANNEL_TRACE
|
|
else if (!strcasecmp(data, "trace")) {
|
|
ast_channel_lock(chan);
|
|
if (ast_true(value))
|
|
ret = ast_channel_trace_enable(chan);
|
|
else if (ast_false(value))
|
|
ret = ast_channel_trace_disable(chan);
|
|
else {
|
|
ret = -1;
|
|
ast_log(LOG_WARNING, "Invalid value for CHANNEL(trace).");
|
|
}
|
|
ast_channel_unlock(chan);
|
|
}
|
|
#endif
|
|
else if (!strcasecmp(data, "tonezone")) {
|
|
struct ind_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
|
|
chan->zone = new_zone;
|
|
} else if (!strcasecmp(data, "callgroup"))
|
|
chan->callgroup = ast_get_group(value);
|
|
else if (!strcasecmp(data, "txgain")) {
|
|
sscanf(value, "%hhd", &gainset);
|
|
ast_channel_setoption(chan, AST_OPTION_TXGAIN, &gainset, sizeof(gainset), 0);
|
|
} else if (!strcasecmp(data, "rxgain")) {
|
|
sscanf(value, "%hhd", &gainset);
|
|
ast_channel_setoption(chan, AST_OPTION_RXGAIN, &gainset, sizeof(gainset), 0);
|
|
} else if (!strcasecmp(data, "transfercapability")) {
|
|
unsigned short i;
|
|
for (i = 0; i < 0x20; i++) {
|
|
if (!strcasecmp(transfercapability_table[i], value) && strcmp(value, "UNK")) {
|
|
chan->transfercapability = i;
|
|
break;
|
|
}
|
|
}
|
|
} else if (!chan->tech->func_channel_write
|
|
|| chan->tech->func_channel_write(chan, function, data, value)) {
|
|
ast_log(LOG_WARNING, "Unknown or unavailable item requested: '%s'\n",
|
|
data);
|
|
ret = -1;
|
|
}
|
|
|
|
return ret;
|
|
}
|
|
|
|
static struct ast_custom_function channel_function = {
|
|
.name = "CHANNEL",
|
|
.synopsis = "Gets/sets various pieces of information about the channel.",
|
|
.syntax = "CHANNEL(item)",
|
|
.desc = "Gets/set various pieces of information about the channel.\n"
|
|
"Standard items (provided by all channel technologies) are:\n"
|
|
"R/O audioreadformat format currently being read\n"
|
|
"R/O audionativeformat format used natively for audio\n"
|
|
"R/O audiowriteformat format currently being written\n"
|
|
"R/W callgroup call groups for call pickup\n"
|
|
"R/O channeltype technology used for channel\n"
|
|
"R/W language language for sounds played\n"
|
|
"R/W musicclass class (from musiconhold.conf) for hold music\n"
|
|
"R/W parkinglot parkinglot for parking\n"
|
|
"R/W rxgain set rxgain level on channel drivers that support it\n"
|
|
"R/O state state for channel\n"
|
|
"R/W tonezone zone for indications played\n"
|
|
"R/W txgain set txgain level on channel drivers that support it\n"
|
|
"R/O videonativeformat format used natively for video\n"
|
|
#ifdef CHANNEL_TRACE
|
|
"R/W trace whether or not context tracing is enabled\n"
|
|
#endif
|
|
"\n"
|
|
"chan_sip provides the following additional options:\n"
|
|
"R/O peerip Get the IP address of the peer\n"
|
|
"R/O recvip Get the source IP address of the peer\n"
|
|
"R/O from Get the URI from the From: header\n"
|
|
"R/O uri Get the URI from the Contact: header\n"
|
|
"R/O useragent Get the useragent\n"
|
|
"R/O peername Get the name of the peer\n"
|
|
"R/O t38passthrough 1 if T38 is offered or enabled in this channel, otherwise 0\n"
|
|
"R/O rtpqos Get QOS information about the RTP stream\n"
|
|
" This option takes two additional arguments:\n"
|
|
" Argument 1:\n"
|
|
" audio Get data about the audio stream\n"
|
|
" video Get data about the video stream\n"
|
|
" text Get data about the text stream\n"
|
|
" Argument 2:\n"
|
|
" local_ssrc Local SSRC (stream ID)\n"
|
|
" local_lostpackets Local lost packets\n"
|
|
" local_jitter Local calculated jitter\n"
|
|
" local_maxjitter Local calculated jitter (maximum)\n"
|
|
" local_minjitter Local calculated jitter (minimum)\n"
|
|
" local_normdevjitter Local calculated jitter (normal deviation)\n"
|
|
" local_stdevjitter Local calculated jitter (standard deviation)\n"
|
|
" local_count Number of received packets\n"
|
|
" remote_ssrc Remote SSRC (stream ID)\n"
|
|
" remote_lostpackets Remote lost packets\n"
|
|
" remote_jitter Remote reported jitter\n"
|
|
" remote_maxjitter Remote calculated jitter (maximum)\n"
|
|
" remote_minjitter Remote calculated jitter (minimum)\n"
|
|
" remote_normdevjitter Remote calculated jitter (normal deviation)\n"
|
|
" remote_stdevjitter Remote calculated jitter (standard deviation)\n"
|
|
" remote_count Number of transmitted packets\n"
|
|
" rtt Round trip time\n"
|
|
" maxrtt Round trip time (maximum)\n"
|
|
" minrtt Round trip time (minimum)\n"
|
|
" normdevrtt Round trip time (normal deviation)\n"
|
|
" stdevrtt Round trip time (standard deviation)\n"
|
|
" all All statistics (in a form suited to logging, but not for parsing)\n"
|
|
"R/O rtpdest Get remote RTP destination information\n"
|
|
" This option takes one additional argument:\n"
|
|
" Argument 1:\n"
|
|
" audio Get audio destination\n"
|
|
" video Get video destination\n"
|
|
"\n"
|
|
"chan_iax2 provides the following additional options:\n"
|
|
"R/W osptoken Get or set the OSP token information for a call\n"
|
|
"R/O peerip Get the peer's ip address\n"
|
|
"R/O peername Get the peer's username\n"
|
|
"\n"
|
|
"Additional items may be available from the channel driver providing\n"
|
|
"the channel; see its documentation for details.\n"
|
|
"\n"
|
|
"Any item requested that is not available on the current channel will\n"
|
|
"return an empty string.\n",
|
|
.read = func_channel_read,
|
|
.write = func_channel_write,
|
|
};
|
|
|
|
static int func_channels_read(struct ast_channel *chan, const char *function, char *data, char *buf, size_t maxlen)
|
|
{
|
|
struct ast_channel *c = NULL;
|
|
regex_t re;
|
|
int res;
|
|
size_t buflen = 0;
|
|
|
|
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;
|
|
}
|
|
}
|
|
|
|
for (c = ast_channel_walk_locked(NULL); c; ast_channel_unlock(c), c = ast_channel_walk_locked(c)) {
|
|
if (ast_strlen_zero(data) || regexec(&re, c->name, 0, NULL, 0) == 0) {
|
|
size_t namelen = strlen(c->name);
|
|
if (buflen + namelen + (ast_strlen_zero(buf) ? 0 : 1) + 1 < maxlen) {
|
|
if (!ast_strlen_zero(buf)) {
|
|
strcat(buf, " ");
|
|
buflen++;
|
|
}
|
|
strcat(buf, c->name);
|
|
buflen += namelen;
|
|
} else {
|
|
ast_log(LOG_WARNING, "Number of channels exceeds the available buffer space. Output will be truncated!\n");
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!ast_strlen_zero(data)) {
|
|
regfree(&re);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function channels_function = {
|
|
.name = "CHANNELS",
|
|
.synopsis = "Gets the list of channels, optionally filtering by a regular expression.",
|
|
.syntax = "CHANNEL([regular expression])",
|
|
.desc =
|
|
"Gets the list of channels, optionally filtering by a regular expression. If\n"
|
|
"no argument is provided, all known channels are returned. The regular\n"
|
|
"expression must correspond to the POSIX.2 specification, as shown in\n"
|
|
"regex(7). The list returned will be space-delimited.\n",
|
|
.read = func_channels_read,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_unregister(&channel_function);
|
|
res |= ast_custom_function_unregister(&channels_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_register(&channel_function);
|
|
res |= ast_custom_function_register(&channels_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Channel information dialplan functions");
|