Merge changes from team/group/appdocsxml
[asterisk/asterisk.git] / funcs / func_rand.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  * Copyright (C) 2006, Claude Patry
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  *
20  * \brief Generate Random Number
21  * 
22  * \author Claude Patry <cpatry@gmail.com>
23  * \author Tilghman Lesher ( http://asterisk.drunkcoder.com/ )
24  * \ingroup functions
25  */
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/module.h"
32 #include "asterisk/channel.h"
33 #include "asterisk/pbx.h"
34 #include "asterisk/utils.h"
35 #include "asterisk/app.h"
36
37 /*** DOCUMENTATION
38         <function name="RAND" language="en_US">
39                 <synopsis>
40                         Choose a random number in a range.                      
41                 </synopsis>
42                 <syntax>
43                         <parameter name="min" />
44                         <parameter name="max" />
45                 </syntax>
46                 <description>
47                         <para>Choose a random number between <replaceable>min</replaceable> and <replaceable>max</replaceable>. 
48                         <replaceable>min</replaceable> defaults to <literal>0</literal>, if not specified, while <replaceable>max</replaceable> defaults 
49                         to <literal>RAND_MAX</literal> (2147483647 on many systems).</para>
50                         <para>Example:  Set(junky=${RAND(1,8)});
51                         Sets junky to a random number between 1 and 8, inclusive.</para>
52                 </description>
53         </function>
54  ***/
55 static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
56                          char *parse, char *buffer, size_t buflen)
57 {
58         int min_int, response_int, max_int;
59         AST_DECLARE_APP_ARGS(args,
60                              AST_APP_ARG(min);
61                              AST_APP_ARG(max);
62         );
63
64         AST_STANDARD_APP_ARGS(args, parse);
65
66         if (ast_strlen_zero(args.min) || sscanf(args.min, "%d", &min_int) != 1)
67                 min_int = 0;
68
69         if (ast_strlen_zero(args.max) || sscanf(args.max, "%d", &max_int) != 1)
70                 max_int = RAND_MAX;
71
72         if (max_int < min_int) {
73                 int tmp = max_int;
74
75                 max_int = min_int;
76                 min_int = tmp;
77                 ast_debug(1, "max<min\n");
78         }
79
80         response_int = min_int + (ast_random() % (max_int - min_int + 1));
81         ast_debug(1, "%d was the lucky number in range [%d,%d]\n", response_int, min_int, max_int);
82         snprintf(buffer, buflen, "%d", response_int);
83
84         return 0;
85 }
86
87 static struct ast_custom_function acf_rand = {
88         .name = "RAND",
89         .read = acf_rand_exec,
90 };
91
92 static int unload_module(void)
93 {
94         ast_custom_function_unregister(&acf_rand);
95
96         return 0;
97 }
98
99 static int load_module(void)
100 {
101         return ast_custom_function_register(&acf_rand);
102 }
103
104 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Random number dialplan function");