Files
asterisk/funcs/func_rand.c
George Joseph e6fe538d81 docs: Add version information to application and function XML elements
* Do a git blame on the embedded XML application or function element.

* From the commit hash, grab the summary line.

* Do a git log --grep <summary> to find the cherry-pick commits in all
  branches that match.

* Do a git patch-id to ensure the commits are all related and didn't get
  a false match on the summary.

* Do a git tag --contains <commit> to find the tags that contain each
  commit.

* Weed out all tags not ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The applications and functions defined in the following files were done by
hand because the XML was extracted from the C source file relatively recently.
* channels/pjsip/dialplan_functions_doc.xml
* main/logger_doc.xml
* main/manager_doc.xml
* res/res_geolocation/geoloc_doc.xml
* res/res_stir_shaken/stir_shaken_doc.xml

(cherry picked from commit 54d67711f8)
2025-01-23 18:36:04 +00:00

110 lines
2.8 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
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
#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">
<since><version>1.6.2.0</version></since>
<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>
<example title="Set random number between 1 and 8, inclusive">
exten => s,1,Set(junky=${RAND(1,8)})
</example>
</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, "%30d", &min_int) != 1)
min_int = 0;
if (ast_strlen_zero(args.max) || sscanf(args.max, "%30d", &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,
.read_max = 12,
};
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");