This commit introduces the first phase of an effort to manage documentation of the interfaces in Asterisk in an XML format. Currently, a new format is available for applications and dialplan functions. A good number of conversions to the new format are also included. For more information, see the following message to asterisk-dev: http://lists.digium.com/pipermail/asterisk-dev/2008-October/034968.html git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@153365 65c4cc65-6c06-0410-ace0-fbb531ad65f3
105 lines
2.7 KiB
C
105 lines
2.7 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2006, Digium, Inc.
|
|
* Copyright (C) 2006, Claude Patry
|
|
*
|
|
* 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 Generate Random Number
|
|
*
|
|
* \author Claude Patry <cpatry@gmail.com>
|
|
* \author Tilghman Lesher ( http://asterisk.drunkcoder.com/ )
|
|
* \ingroup functions
|
|
*/
|
|
|
|
#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"
|
|
|
|
/*** DOCUMENTATION
|
|
<function name="RAND" language="en_US">
|
|
<synopsis>
|
|
Choose a random number in a range.
|
|
</synopsis>
|
|
<syntax>
|
|
<parameter name="min" />
|
|
<parameter name="max" />
|
|
</syntax>
|
|
<description>
|
|
<para>Choose a random number between <replaceable>min</replaceable> and <replaceable>max</replaceable>.
|
|
<replaceable>min</replaceable> defaults to <literal>0</literal>, if not specified, while <replaceable>max</replaceable> defaults
|
|
to <literal>RAND_MAX</literal> (2147483647 on many systems).</para>
|
|
<para>Example: Set(junky=${RAND(1,8)});
|
|
Sets junky to a random number between 1 and 8, inclusive.</para>
|
|
</description>
|
|
</function>
|
|
***/
|
|
static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
|
|
char *parse, char *buffer, size_t buflen)
|
|
{
|
|
int min_int, response_int, max_int;
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(min);
|
|
AST_APP_ARG(max);
|
|
);
|
|
|
|
AST_STANDARD_APP_ARGS(args, parse);
|
|
|
|
if (ast_strlen_zero(args.min) || sscanf(args.min, "%d", &min_int) != 1)
|
|
min_int = 0;
|
|
|
|
if (ast_strlen_zero(args.max) || sscanf(args.max, "%d", &max_int) != 1)
|
|
max_int = RAND_MAX;
|
|
|
|
if (max_int < min_int) {
|
|
int tmp = max_int;
|
|
|
|
max_int = min_int;
|
|
min_int = tmp;
|
|
ast_debug(1, "max<min\n");
|
|
}
|
|
|
|
response_int = min_int + (ast_random() % (max_int - min_int + 1));
|
|
ast_debug(1, "%d was the lucky number in range [%d,%d]\n", response_int, min_int, max_int);
|
|
snprintf(buffer, buflen, "%d", response_int);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function acf_rand = {
|
|
.name = "RAND",
|
|
.read = acf_rand_exec,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
ast_custom_function_unregister(&acf_rand);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
return ast_custom_function_register(&acf_rand);
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Random number dialplan function");
|