CHANNEL(callid): Give dialplan access to the callid.
[asterisk/asterisk.git] / funcs / func_rand.c
index 0f1bd00..bc514b8 100644 (file)
  * 
  * \author Claude Patry <cpatry@gmail.com>
  * \author Tilghman Lesher ( http://asterisk.drunkcoder.com/ )
+ * \ingroup functions
  */
 
-#include <stdlib.h>
-#include <string.h>
-#include <stdio.h>
-#include <sys/types.h>
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
 
 #include "asterisk.h"
 
-/* ASTERISK_FILE_VERSION(__FILE__, "$Revision: 7682 $") */
-
+#include "asterisk/module.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
-#include "asterisk/logger.h"
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
-#ifndef BUILTIN_FUNC
-#include "asterisk/module.h"
-#endif
-
 
-STANDARD_LOCAL_USER;
-
-LOCAL_USER_DECL;
-
-
-static char *acf_rand_exec(struct ast_channel *chan, char *cmd, char *data, char *buffer, size_t buflen)
+/*** DOCUMENTATION
+       <function name="RAND" language="en_US">
+               <synopsis>
+                       Choose a random number in a range.                      
+               </synopsis>
+               <syntax>
+                       <parameter name="min" />
+                       <parameter name="max" />
+               </syntax>
+               <description>
+                       <para>Choose a random number between <replaceable>min</replaceable> and <replaceable>max</replaceable>. 
+                       <replaceable>min</replaceable> defaults to <literal>0</literal>, if not specified, while <replaceable>max</replaceable> defaults 
+                       to <literal>RAND_MAX</literal> (2147483647 on many systems).</para>
+                       <para>Example:  Set(junky=${RAND(1,8)});
+                       Sets junky to a random number between 1 and 8, inclusive.</para>
+               </description>
+       </function>
+ ***/
+static int acf_rand_exec(struct ast_channel *chan, const char *cmd,
+                        char *parse, char *buffer, size_t buflen)
 {
-       struct localuser *u;
-       char *args[2] = { "", "" }, *s;
        int min_int, response_int, max_int;
+       AST_DECLARE_APP_ARGS(args,
+                            AST_APP_ARG(min);
+                            AST_APP_ARG(max);
+       );
 
-       LOCAL_USER_ACF_ADD(u);
+       AST_STANDARD_APP_ARGS(args, parse);
 
-       if (!(s = ast_strdupa(data))) {
-               *buffer = '\0';
-               LOCAL_USER_REMOVE(u);
-               return buffer;
-       }
-
-       ast_app_separate_args(s, '|', args, sizeof(args) / sizeof(args[0]));
-
-       if (ast_strlen_zero(args[0]) || sscanf(args[0], "%d", &min_int) != 1) {
+       if (ast_strlen_zero(args.min) || sscanf(args.min, "%30d", &min_int) != 1)
                min_int = 0;
-       }
 
-       if (ast_strlen_zero(args[1]) || sscanf(args[1], "%d", &max_int) != 1) {
+       if (ast_strlen_zero(args.max) || sscanf(args.max, "%30d", &max_int) != 1)
                max_int = RAND_MAX;
-       }
 
        if (max_int < min_int) {
                int tmp = max_int;
+
                max_int = min_int;
                min_int = tmp;
-               ast_log(LOG_DEBUG, "max<min\n");
+               ast_debug(1, "max<min\n");
        }
 
        response_int = min_int + (ast_random() % (max_int - min_int + 1));
-       ast_log(LOG_DEBUG, "%d was the lucky number in range [%d,%d]\n", response_int, min_int, max_int);
+       ast_debug(1, "%d was the lucky number in range [%d,%d]\n", response_int, min_int, max_int);
        snprintf(buffer, buflen, "%d", response_int);
 
-       LOCAL_USER_REMOVE(u);
-       return buffer;
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function acf_rand = {
+static struct ast_custom_function acf_rand = {
        .name = "RAND",
-       .synopsis = "Choose a random number in a range",
-       .syntax = "RAND([min][,max])",
-       .desc =
-"Choose a random number between min and max.  Min defaults to 0, if not\n"
-"specified, while max defaults to RAND_MAX (2147483647 on many systems).\n"
-"  Example:  Set(junky=${RAND(1,8)}); \n"
-"  Sets junky to a random number between 1 and 8, inclusive.\n",
        .read = acf_rand_exec,
+       .read_max = 12,
 };
 
-
-#ifndef BUILTIN_FUNC
-
-static char *tdesc = "Generate a random number";
-
-int unload_module(void)
+static int unload_module(void)
 {
        ast_custom_function_unregister(&acf_rand);
 
-       STANDARD_HANGUP_LOCALUSERS;
-
        return 0;
 }
 
-int load_module(void)
+static int load_module(void)
 {
        return ast_custom_function_register(&acf_rand);
 }
 
-char *description(void)
-{
-       return tdesc;
-}
-
-int usecount(void)
-{
-       int res;
-
-       STANDARD_USECOUNT(res);
-
-       return res;
-}
-
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
-
-#endif
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Random number dialplan function");