68103abba3
When func_cdr is used for variable substitution, there is no channel name and hence no run-time information available for CDR variable substitution. In that case, the correct thing to do is to use the CDR object on the channel passed to the function. This patch checks to see if the channel passed in has a name - if not, it uses ast_cdr_format_var instead of ast_cdr_get_var. This allows CDR backends to continue to use variable substitution in order to resolve ast_cdr object properties. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@392214 65c4cc65-6c06-0410-ace0-fbb531ad65f3
396 lines
12 KiB
C
396 lines
12 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999-2006, Digium, Inc.
|
|
*
|
|
* Portions Copyright (C) 2005, Anthony Minessale II
|
|
*
|
|
* 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 Call Detail Record related dialplan functions
|
|
*
|
|
* \author Anthony Minessale II
|
|
*
|
|
* \ingroup functions
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/utils.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/cdr.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<function name="CDR" language="en_US">
|
|
<synopsis>
|
|
Gets or sets a CDR variable.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="name" required="true">
|
|
<para>CDR field name:</para>
|
|
<enumlist>
|
|
<enum name="clid">
|
|
<para>Caller ID.</para>
|
|
</enum>
|
|
<enum name="lastdata">
|
|
<para>Last application arguments.</para>
|
|
</enum>
|
|
<enum name="disposition">
|
|
<para>The final state of the CDR.</para>
|
|
<enumlist>
|
|
<enum name="0">
|
|
<para><literal>NO ANSWER</literal></para>
|
|
</enum>
|
|
<enum name="1">
|
|
<para><literal>NO ANSWER</literal> (NULL record)</para>
|
|
</enum>
|
|
<enum name="2">
|
|
<para><literal>FAILED</literal></para>
|
|
</enum>
|
|
<enum name="4">
|
|
<para><literal>BUSY</literal></para>
|
|
</enum>
|
|
<enum name="8">
|
|
<para><literal>ANSWERED</literal></para>
|
|
</enum>
|
|
<enum name="16">
|
|
<para><literal>CONGESTION</literal></para>
|
|
</enum>
|
|
</enumlist>
|
|
</enum>
|
|
<enum name="src">
|
|
<para>Source.</para>
|
|
</enum>
|
|
<enum name="start">
|
|
<para>Time the call started.</para>
|
|
</enum>
|
|
<enum name="amaflags">
|
|
<para>R/W the Automatic Message Accounting (AMA) flags on the channel.
|
|
When read from a channel, the integer value will always be returned.
|
|
When written to a channel, both the string format or integer value
|
|
is accepted.</para>
|
|
<enumlist>
|
|
<enum name="1"><para><literal>OMIT</literal></para></enum>
|
|
<enum name="2"><para><literal>BILLING</literal></para></enum>
|
|
<enum name="3"><para><literal>DOCUMENTATION</literal></para></enum>
|
|
</enumlist>
|
|
<warning><para>Accessing this setting is deprecated in CDR. Please use the CHANNEL function instead.</para></warning>
|
|
</enum>
|
|
<enum name="dst">
|
|
<para>Destination.</para>
|
|
</enum>
|
|
<enum name="answer">
|
|
<para>Time the call was answered.</para>
|
|
</enum>
|
|
<enum name="accountcode">
|
|
<para>The channel's account code.</para>
|
|
<warning><para>Accessing this setting is deprecated in CDR. Please use the CHANNEL function instead.</para></warning>
|
|
</enum>
|
|
<enum name="dcontext">
|
|
<para>Destination context.</para>
|
|
</enum>
|
|
<enum name="end">
|
|
<para>Time the call ended.</para>
|
|
</enum>
|
|
<enum name="uniqueid">
|
|
<para>The channel's unique id.</para>
|
|
</enum>
|
|
<enum name="dstchannel">
|
|
<para>Destination channel.</para>
|
|
</enum>
|
|
<enum name="duration">
|
|
<para>Duration of the call.</para>
|
|
</enum>
|
|
<enum name="userfield">
|
|
<para>The channel's user specified field.</para>
|
|
</enum>
|
|
<enum name="lastapp">
|
|
<para>Last application.</para>
|
|
</enum>
|
|
<enum name="billsec">
|
|
<para>Duration of the call once it was answered.</para>
|
|
</enum>
|
|
<enum name="channel">
|
|
<para>Channel name.</para>
|
|
</enum>
|
|
<enum name="sequence">
|
|
<para>CDR sequence number.</para>
|
|
</enum>
|
|
</enumlist>
|
|
</parameter>
|
|
<parameter name="options" required="false">
|
|
<optionlist>
|
|
<option name="f">
|
|
<para>Returns billsec or duration fields as floating point values.</para>
|
|
</option>
|
|
<option name="u">
|
|
<para>Retrieves the raw, unprocessed value.</para>
|
|
<para>For example, 'start', 'answer', and 'end' will be retrieved as epoch
|
|
values, when the <literal>u</literal> option is passed, but formatted as YYYY-MM-DD HH:MM:SS
|
|
otherwise. Similarly, disposition and amaflags will return their raw
|
|
integral values.</para>
|
|
</option>
|
|
</optionlist>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>All of the CDR field names are read-only, except for <literal>accountcode</literal>,
|
|
<literal>userfield</literal>, and <literal>amaflags</literal>. You may, however, supply
|
|
a name not on the above list, and create your own variable, whose value can be changed
|
|
with this function, and this variable will be stored on the CDR.</para>
|
|
<note><para>CDRs can only be modified before the bridge between two channels is
|
|
torn down. For example, CDRs may not be modified after the <literal>Dial</literal>
|
|
application has returned.</para></note>
|
|
<para>Example: exten => 1,1,Set(CDR(userfield)=test)</para>
|
|
</description>
|
|
</function>
|
|
<function name="CDR_PROP" language="en_US">
|
|
<synopsis>
|
|
Set a property on a channel's CDR.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="name" required="true">
|
|
<para>The property to set on the CDR.</para>
|
|
<enumlist>
|
|
<enum name="party_a">
|
|
<para>Set this channel as the preferred Party A when
|
|
channels are associated together.</para>
|
|
<para>Write-Only</para>
|
|
</enum>
|
|
<enum name="disable">
|
|
<para>Disable CDRs for this channel.</para>
|
|
<para>Write-Only</para>
|
|
</enum>
|
|
</enumlist>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>This function sets a property on a channel's CDR. Properties
|
|
alter the behavior of how the CDR operates for that channel.</para>
|
|
</description>
|
|
</function>
|
|
***/
|
|
|
|
enum cdr_option_flags {
|
|
OPT_UNPARSED = (1 << 1),
|
|
OPT_FLOAT = (1 << 2),
|
|
};
|
|
|
|
AST_APP_OPTIONS(cdr_func_options, {
|
|
AST_APP_OPTION('f', OPT_FLOAT),
|
|
AST_APP_OPTION('u', OPT_UNPARSED),
|
|
});
|
|
|
|
static int cdr_read(struct ast_channel *chan, const char *cmd, char *parse,
|
|
char *buf, size_t len)
|
|
{
|
|
char format_buf[128];
|
|
char *value = NULL;
|
|
struct ast_flags flags = { 0 };
|
|
char tempbuf[512];
|
|
char *info;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(variable);
|
|
AST_APP_ARG(options);
|
|
);
|
|
|
|
if (!chan) {
|
|
return -1;
|
|
}
|
|
|
|
if (ast_strlen_zero(parse)) {
|
|
ast_log(AST_LOG_WARNING, "FUNC_CDR requires a variable (FUNC_CDR(variable[,option]))\n)");
|
|
return -1;
|
|
}
|
|
info = ast_strdupa(parse);
|
|
AST_STANDARD_APP_ARGS(args, info);
|
|
|
|
if (!ast_strlen_zero(args.options)) {
|
|
ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
|
|
}
|
|
|
|
if (ast_strlen_zero(ast_channel_name(chan))) {
|
|
/* Format request on a dummy channel */
|
|
ast_cdr_format_var(ast_channel_cdr(chan), args.variable, &value, tempbuf, sizeof(tempbuf), 0);
|
|
if (ast_strlen_zero(value)) {
|
|
return 0;
|
|
}
|
|
ast_copy_string(tempbuf, value, sizeof(tempbuf));
|
|
ast_set_flag(&flags, OPT_UNPARSED);
|
|
}else if (ast_cdr_getvar(ast_channel_name(chan), args.variable, tempbuf, sizeof(tempbuf))) {
|
|
return 0;
|
|
}
|
|
|
|
if (ast_test_flag(&flags, OPT_FLOAT) && (!strcasecmp("billsec", args.variable) || !strcasecmp("duration", args.variable))) {
|
|
long ms;
|
|
double dtime;
|
|
if (sscanf(tempbuf, "%30ld", &ms) != 1) {
|
|
ast_log(AST_LOG_WARNING, "Unable to parse %s (%s) from the CDR for channel %s\n",
|
|
args.variable, tempbuf, ast_channel_name(chan));
|
|
return 0;
|
|
}
|
|
dtime = (double)(ms / 1000.0);
|
|
sprintf(tempbuf, "%lf", dtime);
|
|
} else if (!ast_test_flag(&flags, OPT_UNPARSED)) {
|
|
if (!strcasecmp("start", args.variable)
|
|
|| !strcasecmp("end", args.variable)
|
|
|| !strcasecmp("answer", args.variable)) {
|
|
struct timeval fmt_time;
|
|
struct ast_tm tm;
|
|
/* tv_usec is suseconds_t, which could be int or long */
|
|
long int tv_usec;
|
|
if (sscanf(tempbuf, "%ld.%ld", &fmt_time.tv_sec, &tv_usec) != 2) {
|
|
ast_log(AST_LOG_WARNING, "Unable to parse %s (%s) from the CDR for channel %s\n",
|
|
args.variable, tempbuf, ast_channel_name(chan));
|
|
return 0;
|
|
}
|
|
fmt_time.tv_usec = tv_usec;
|
|
ast_localtime(&fmt_time, &tm, NULL);
|
|
ast_strftime(tempbuf, sizeof(*tempbuf), "%Y-%m-%d %T", &tm);
|
|
} else if (!strcasecmp("disposition", args.variable)) {
|
|
int disposition;
|
|
if (sscanf(tempbuf, "%8d", &disposition) != 1) {
|
|
ast_log(AST_LOG_WARNING, "Unable to parse %s (%s) from the CDR for channel %s\n",
|
|
args.variable, tempbuf, ast_channel_name(chan));
|
|
return 0;
|
|
}
|
|
sprintf(format_buf, "%s", ast_cdr_disp2str(disposition));
|
|
strcpy(tempbuf, format_buf);
|
|
} else if (!strcasecmp("amaflags", args.variable)) {
|
|
int amaflags;
|
|
if (sscanf(tempbuf, "%8d", &amaflags) != 1) {
|
|
ast_log(AST_LOG_WARNING, "Unable to parse %s (%s) from the CDR for channel %s\n",
|
|
args.variable, tempbuf, ast_channel_name(chan));
|
|
return 0;
|
|
}
|
|
sprintf(format_buf, "%s", ast_channel_amaflags2string(amaflags));
|
|
strcpy(tempbuf, format_buf);
|
|
}
|
|
}
|
|
|
|
ast_copy_string(buf, tempbuf, len);
|
|
return 0;
|
|
}
|
|
|
|
static int cdr_write(struct ast_channel *chan, const char *cmd, char *parse,
|
|
const char *value)
|
|
{
|
|
struct ast_flags flags = { 0 };
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(variable);
|
|
AST_APP_ARG(options);
|
|
);
|
|
|
|
if (ast_strlen_zero(parse) || !value || !chan)
|
|
return -1;
|
|
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
if (!ast_strlen_zero(args.options))
|
|
ast_app_parse_options(cdr_func_options, &flags, NULL, args.options);
|
|
|
|
if (!strcasecmp(args.variable, "accountcode")) {
|
|
ast_log(AST_LOG_WARNING, "Using the CDR function to set 'accountcode' is deprecated. Please use the CHANNEL function instead.\n");
|
|
ast_channel_lock(chan);
|
|
ast_channel_accountcode_set(chan, value);
|
|
ast_channel_unlock(chan);
|
|
} else if (!strcasecmp(args.variable, "peeraccount")) {
|
|
ast_log(AST_LOG_WARNING, "The 'peeraccount' setting is not supported. Please set the 'accountcode' on the appropriate channel using the CHANNEL function.\n");
|
|
} else if (!strcasecmp(args.variable, "userfield")) {
|
|
ast_cdr_setuserfield(ast_channel_name(chan), value);
|
|
} else if (!strcasecmp(args.variable, "amaflags")) {
|
|
ast_log(AST_LOG_WARNING, "Using the CDR function to set 'amaflags' is deprecated. Please use the CHANNEL function instead.\n");
|
|
if (isdigit(*value)) {
|
|
int amaflags;
|
|
sscanf(value, "%30d", &amaflags);
|
|
ast_channel_lock(chan);
|
|
ast_channel_amaflags_set(chan, amaflags);
|
|
ast_channel_unlock(chan);
|
|
} else {
|
|
ast_channel_lock(chan);
|
|
ast_channel_amaflags_set(chan, ast_channel_string2amaflag(value));
|
|
ast_channel_unlock(chan);
|
|
}
|
|
} else {
|
|
ast_cdr_setvar(ast_channel_name(chan), args.variable, value);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int cdr_prop_write(struct ast_channel *chan, const char *cmd, char *parse,
|
|
const char *value)
|
|
{
|
|
enum ast_cdr_options option;
|
|
|
|
if (!strcasecmp("party_a", cmd)) {
|
|
option = AST_CDR_FLAG_PARTY_A;
|
|
} else if (!strcasecmp("disable", cmd)) {
|
|
option = AST_CDR_FLAG_DISABLE_ALL;
|
|
} else {
|
|
ast_log(AST_LOG_WARNING, "Unknown option %s used with CDR_PROP\n", cmd);
|
|
return 0;
|
|
}
|
|
|
|
if (ast_true(value)) {
|
|
ast_cdr_set_property(ast_channel_name(chan), option);
|
|
} else {
|
|
ast_cdr_clear_property(ast_channel_name(chan), option);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function cdr_function = {
|
|
.name = "CDR",
|
|
.read = cdr_read,
|
|
.write = cdr_write,
|
|
};
|
|
|
|
static struct ast_custom_function cdr_prop_function = {
|
|
.name = "CDR_PROP",
|
|
.read = NULL,
|
|
.write = cdr_prop_write,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_unregister(&cdr_function);
|
|
res |= ast_custom_function_unregister(&cdr_prop_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_register(&cdr_function);
|
|
res |= ast_custom_function_register(&cdr_prop_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Call Detail Record (CDR) dialplan functions");
|