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