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