6ec0f3c9320ad693a95691acd9d0eb45439e018b
[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  */
25
26 #include <stdlib.h>
27 #include <string.h>
28 #include <stdio.h>
29 #include <sys/types.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/module.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/app.h"
41
42 STANDARD_LOCAL_USER;
43
44 LOCAL_USER_DECL;
45
46 static int acf_rand_exec(struct ast_channel *chan, char *cmd,
47                          char *parse, char *buffer, size_t buflen)
48 {
49         struct localuser *u;
50         int min_int, response_int, max_int;
51         AST_DECLARE_APP_ARGS(args,
52                              AST_APP_ARG(min);
53                              AST_APP_ARG(max);
54         );
55
56         LOCAL_USER_ACF_ADD(u);
57
58         AST_STANDARD_APP_ARGS(args, parse);
59
60         if (ast_strlen_zero(args.min) || sscanf(args.min, "%d", &min_int) != 1)
61                 min_int = 0;
62
63         if (ast_strlen_zero(args.max) || sscanf(args.max, "%d", &max_int) != 1)
64                 max_int = RAND_MAX;
65
66         if (max_int < min_int) {
67                 int tmp = max_int;
68
69                 max_int = min_int;
70                 min_int = tmp;
71                 ast_log(LOG_DEBUG, "max<min\n");
72         }
73
74         response_int = min_int + (ast_random() % (max_int - min_int + 1));
75         ast_log(LOG_DEBUG, "%d was the lucky number in range [%d,%d]\n",
76                 response_int, min_int, max_int);
77         snprintf(buffer, buflen, "%d", response_int);
78
79         LOCAL_USER_REMOVE(u);
80
81         return 0;
82 }
83
84 static struct ast_custom_function acf_rand = {
85         .name = "RAND",
86         .synopsis = "Choose a random number in a range",
87         .syntax = "RAND([min][,max])",
88         .desc =
89                 "Choose a random number between min and max.  Min defaults to 0, if not\n"
90                 "specified, while max defaults to RAND_MAX (2147483647 on many systems).\n"
91                 "  Example:  Set(junky=${RAND(1,8)}); \n"
92                 "  Sets junky to a random number between 1 and 8, inclusive.\n",
93         .read = acf_rand_exec,
94 };
95
96
97 static char *tdesc = "Random number dialplan function";
98
99 int unload_module(void)
100 {
101         ast_custom_function_unregister(&acf_rand);
102
103         return 0;
104 }
105
106 int load_module(void)
107 {
108         return ast_custom_function_register(&acf_rand);
109 }
110
111 char *description(void)
112 {
113         return tdesc;
114 }
115
116 int usecount(void)
117 {
118         return 0;
119 }
120
121 char *key()
122 {
123         return ASTERISK_GPL_KEY;
124 }