Fix up modules in the 'apps' directory, and also correct the bad example of enum definitions in include/asterisk/app.h, which many developers followed (thanks for reading the documentation!). In addition, add some basic usage examples of the 'pahole' and 'pglobal' tools to the coding guidelines. git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@200656 65c4cc65-6c06-0410-ace0-fbb531ad65f3
316 lines
8.8 KiB
C
316 lines
8.8 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2007-2008, Trinity College Computing Center
|
|
* Written by David Chappell <David.Chappell@trincoll.edu>
|
|
*
|
|
* 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 Trivial application to read an extension into a variable
|
|
*
|
|
* \author David Chappell <David.Chappell@trincoll.edu>
|
|
*
|
|
* \ingroup applications
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/indications.h"
|
|
#include "asterisk/channel.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<application name="ReadExten" language="en_US">
|
|
<synopsis>
|
|
Read an extension into a variable.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="variable" required="true" />
|
|
<parameter name="filename">
|
|
<para>File to play before reading digits or tone with option <literal>i</literal></para>
|
|
</parameter>
|
|
<parameter name="context">
|
|
<para>Context in which to match extensions.</para>
|
|
</parameter>
|
|
<parameter name="option">
|
|
<optionlist>
|
|
<option name="s">
|
|
<para>Return immediately if the channel is not answered.</para>
|
|
</option>
|
|
<option name="i">
|
|
<para>Play <replaceable>filename</replaceable> as an indication tone from your
|
|
<filename>indications.conf</filename></para>
|
|
</option>
|
|
<option name="n">
|
|
<para>Read digits even if the channel is not answered.</para>
|
|
</option>
|
|
</optionlist>
|
|
</parameter>
|
|
<parameter name="timeout">
|
|
<para>An integer number of seconds to wait for a digit response. If
|
|
greater than <literal>0</literal>, that value will override the default timeout.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Reads a <literal>#</literal> terminated string of digits from the user into the given variable.</para>
|
|
<para>Will set READEXTENSTATUS on exit with one of the following statuses:</para>
|
|
<variablelist>
|
|
<variable name="READEXTENSTATUS">
|
|
<value name="OK">
|
|
A valid extension exists in ${variable}.
|
|
</value>
|
|
<value name="TIMEOUT">
|
|
No extension was entered in the specified time. Also sets ${variable} to "t".
|
|
</value>
|
|
<value name="INVALID">
|
|
An invalid extension, ${INVALID_EXTEN}, was entered. Also sets ${variable} to "i".
|
|
</value>
|
|
<value name="SKIP">
|
|
Line was not up and the option 's' was specified.
|
|
</value>
|
|
<value name="ERROR">
|
|
Invalid arguments were passed.
|
|
</value>
|
|
</variable>
|
|
</variablelist>
|
|
</description>
|
|
</application>
|
|
<function name="VALID_EXTEN" language="en_US">
|
|
<synopsis>
|
|
Determine whether an extension exists or not.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="context">
|
|
<para>Defaults to the current context</para>
|
|
</parameter>
|
|
<parameter name="extension" required="true" />
|
|
<parameter name="priority">
|
|
<para>Priority defaults to <literal>1</literal>.</para>
|
|
</parameter>
|
|
</syntax>
|
|
<description>
|
|
<para>Returns a true value if the indicated <replaceable>context</replaceable>,
|
|
<replaceable>extension</replaceable>, and <replaceable>priority</replaceable> exist.</para>
|
|
</description>
|
|
</function>
|
|
***/
|
|
|
|
enum readexten_option_flags {
|
|
OPT_SKIP = (1 << 0),
|
|
OPT_INDICATION = (1 << 1),
|
|
OPT_NOANSWER = (1 << 2),
|
|
};
|
|
|
|
AST_APP_OPTIONS(readexten_app_options, {
|
|
AST_APP_OPTION('s', OPT_SKIP),
|
|
AST_APP_OPTION('i', OPT_INDICATION),
|
|
AST_APP_OPTION('n', OPT_NOANSWER),
|
|
});
|
|
|
|
static char *app = "ReadExten";
|
|
|
|
static int readexten_exec(struct ast_channel *chan, const char *data)
|
|
{
|
|
int res = 0;
|
|
char exten[256] = "";
|
|
int maxdigits = sizeof(exten) - 1;
|
|
int timeout = 0, digit_timeout = 0, x = 0;
|
|
char *argcopy = NULL, *status = "";
|
|
struct ast_tone_zone_sound *ts = NULL;
|
|
struct ast_flags flags = {0};
|
|
|
|
AST_DECLARE_APP_ARGS(arglist,
|
|
AST_APP_ARG(variable);
|
|
AST_APP_ARG(filename);
|
|
AST_APP_ARG(context);
|
|
AST_APP_ARG(options);
|
|
AST_APP_ARG(timeout);
|
|
);
|
|
|
|
if (ast_strlen_zero(data)) {
|
|
ast_log(LOG_WARNING, "ReadExten requires at least one argument\n");
|
|
pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
|
|
return 0;
|
|
}
|
|
|
|
argcopy = ast_strdupa(data);
|
|
AST_STANDARD_APP_ARGS(arglist, argcopy);
|
|
|
|
if (ast_strlen_zero(arglist.variable)) {
|
|
ast_log(LOG_WARNING, "Usage: ReadExten(variable[,filename[,context[,options[,timeout]]]])\n");
|
|
pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
|
|
return 0;
|
|
}
|
|
|
|
if (ast_strlen_zero(arglist.filename))
|
|
arglist.filename = NULL;
|
|
|
|
if (ast_strlen_zero(arglist.context))
|
|
arglist.context = chan->context;
|
|
|
|
if (!ast_strlen_zero(arglist.options))
|
|
ast_app_parse_options(readexten_app_options, &flags, NULL, arglist.options);
|
|
|
|
if (!ast_strlen_zero(arglist.timeout)) {
|
|
timeout = atoi(arglist.timeout);
|
|
if (timeout > 0)
|
|
timeout *= 1000;
|
|
}
|
|
|
|
if (timeout <= 0)
|
|
timeout = chan->pbx ? chan->pbx->rtimeoutms : 10000;
|
|
|
|
if (digit_timeout <= 0)
|
|
digit_timeout = chan->pbx ? chan->pbx->dtimeoutms : 5000;
|
|
|
|
if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename)) {
|
|
ts = ast_get_indication_tone(chan->zone, arglist.filename);
|
|
}
|
|
|
|
do {
|
|
if (chan->_state != AST_STATE_UP) {
|
|
if (ast_test_flag(&flags, OPT_SKIP)) {
|
|
/* At the user's option, skip if the line is not up */
|
|
pbx_builtin_setvar_helper(chan, arglist.variable, "");
|
|
status = "SKIP";
|
|
break;
|
|
} else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
|
|
/* Otherwise answer unless we're supposed to read while on-hook */
|
|
res = ast_answer(chan);
|
|
}
|
|
}
|
|
|
|
if (res < 0) {
|
|
status = "HANGUP";
|
|
break;
|
|
}
|
|
|
|
ast_playtones_stop(chan);
|
|
ast_stopstream(chan);
|
|
|
|
if (ts && ts->data[0])
|
|
res = ast_playtones_start(chan, 0, ts->data, 0);
|
|
else if (arglist.filename)
|
|
res = ast_streamfile(chan, arglist.filename, chan->language);
|
|
|
|
for (x = 0; x < maxdigits; x++) {
|
|
ast_debug(3, "extension so far: '%s', timeout: %d\n", exten, timeout);
|
|
res = ast_waitfordigit(chan, timeout);
|
|
|
|
ast_playtones_stop(chan);
|
|
ast_stopstream(chan);
|
|
timeout = digit_timeout;
|
|
|
|
if (res < 1) { /* timeout expired or hangup */
|
|
if (ast_check_hangup(chan)) {
|
|
status = "HANGUP";
|
|
} else {
|
|
pbx_builtin_setvar_helper(chan, arglist.variable, "t");
|
|
status = "TIMEOUT";
|
|
}
|
|
break;
|
|
}
|
|
|
|
exten[x] = res;
|
|
if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */, chan->cid.cid_num)) {
|
|
if (!ast_exists_extension(chan, arglist.context, exten, 1, chan->cid.cid_num) && res == '#') {
|
|
exten[x] = '\0';
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!ast_strlen_zero(status))
|
|
break;
|
|
|
|
if (ast_exists_extension(chan, arglist.context, exten, 1, chan->cid.cid_num)) {
|
|
ast_debug(3, "User entered valid extension '%s'\n", exten);
|
|
pbx_builtin_setvar_helper(chan, arglist.variable, exten);
|
|
status = "OK";
|
|
} else {
|
|
ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, chan->name);
|
|
pbx_builtin_setvar_helper(chan, arglist.variable, "i");
|
|
pbx_builtin_setvar_helper(chan, "INVALID_EXTEN", exten);
|
|
status = "INVALID";
|
|
}
|
|
} while (0);
|
|
|
|
if (ts) {
|
|
ts = ast_tone_zone_sound_unref(ts);
|
|
}
|
|
|
|
pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
|
|
|
|
return status[0] == 'H' ? -1 : 0;
|
|
}
|
|
|
|
static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
|
|
{
|
|
int priority_int;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(context);
|
|
AST_APP_ARG(extension);
|
|
AST_APP_ARG(priority);
|
|
);
|
|
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
if (ast_strlen_zero(args.context))
|
|
args.context = chan->context;
|
|
|
|
if (ast_strlen_zero(args.extension)) {
|
|
ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
|
|
return -1;
|
|
}
|
|
|
|
if (ast_strlen_zero(args.priority))
|
|
priority_int = 1;
|
|
else
|
|
priority_int = atoi(args.priority);
|
|
|
|
if (ast_exists_extension(chan, args.context, args.extension, priority_int, chan->cid.cid_num))
|
|
ast_copy_string(buffer, "1", buflen);
|
|
else
|
|
ast_copy_string(buffer, "0", buflen);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function acf_isexten = {
|
|
.name = "VALID_EXTEN",
|
|
.read = acf_isexten_exec,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res = ast_unregister_application(app);
|
|
res |= ast_custom_function_unregister(&acf_isexten);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res = ast_register_application_xml(app, readexten_exec);
|
|
res |= ast_custom_function_register(&acf_isexten);
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read and evaluate extension validity");
|