Merge "BuildSystem: Really do not pass unknown-warning options to the compiler."
[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 /*** MODULEINFO
28         <support_level>core</support_level>
29  ***/
30
31 #include "asterisk.h"
32
33 #include "asterisk/module.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/app.h"
38
39 /*** DOCUMENTATION
40         <function name="RAND" language="en_US">
41                 <synopsis>
42                         Choose a random number in a range.
43                 </synopsis>
44                 <syntax>
45                         <parameter name="min" />
46                         <parameter name="max" />
47                 </syntax>
48                 <description>
49                         <para>Choose a random number between <replaceable>min</replaceable> and <replaceable>max</replaceable>.
50                         <replaceable>min</replaceable> defaults to <literal>0</literal>, if not specified, while <replaceable>max</replaceable> defaults
51                         to <literal>RAND_MAX</literal> (2147483647 on many systems).</para>
52                         <para>Example:  Set(junky=${RAND(1,8)});
53                         Sets junky to a random number between 1 and 8, inclusive.</para>
54                 </description>
55         </function>
56  ***/
57 static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
58                          char *parse, char *buffer, size_t buflen)
59 {
60         int min_int, response_int, max_int;
61         AST_DECLARE_APP_ARGS(args,
62                              AST_APP_ARG(min);
63                              AST_APP_ARG(max);
64         );
65
66         AST_STANDARD_APP_ARGS(args, parse);
67
68         if (ast_strlen_zero(args.min) || sscanf(args.min, "%30d", &min_int) != 1)
69                 min_int = 0;
70
71         if (ast_strlen_zero(args.max) || sscanf(args.max, "%30d", &max_int) != 1)
72                 max_int = RAND_MAX;
73
74         if (max_int < min_int) {
75                 int tmp = max_int;
76
77                 max_int = min_int;
78                 min_int = tmp;
79                 ast_debug(1, "max<min\n");
80         }
81
82         response_int = min_int + (ast_random() % (max_int - min_int + 1));
83         ast_debug(1, "%d was the lucky number in range [%d,%d]\n", response_int, min_int, max_int);
84         snprintf(buffer, buflen, "%d", response_int);
85
86         return 0;
87 }
88
89 static struct ast_custom_function acf_rand = {
90         .name = "RAND",
91         .read = acf_rand_exec,
92         .read_max = 12,
93 };
94
95 static int unload_module(void)
96 {
97         ast_custom_function_unregister(&acf_rand);
98
99         return 0;
100 }
101
102 static int load_module(void)
103 {
104         return ast_custom_function_register(&acf_rand);
105 }
106
107 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Random number dialplan function");