Replace direct access to channel name with accessor functions
[asterisk/asterisk.git] / apps / app_readexten.c
index fbff883..6e8531d 100644 (file)
@@ -1,9 +1,8 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 2007 Dave Chappell
- *
- * David Chappell <David.Chappell@trincoll.edu>
+ * Copyright (C) 2007-2008, Trinity College Computing Center
+ * Written by David Chappell <David.Chappell@trincoll.edu>
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact
  * 
  * \ingroup applications
  */
+
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
  
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#include "asterisk/lock.h"
 #include "asterisk/file.h"
-#include "asterisk/logger.h"
-#include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/app.h"
 #include "asterisk/module.h"
-#include "asterisk/options.h"
-#include "asterisk/utils.h"
 #include "asterisk/indications.h"
+#include "asterisk/channel.h"
 
-enum {
+/*** DOCUMENTATION
+       <application name="ReadExten" language="en_US">
+               <synopsis>
+                       Read an extension into a variable.
+               </synopsis>
+               <syntax>
+                       <parameter name="variable" required="true" />
+                       <parameter name="filename">
+                               <para>File to play before reading digits or tone with option <literal>i</literal></para>
+                       </parameter>
+                       <parameter name="context">
+                               <para>Context in which to match extensions.</para>
+                       </parameter>
+                       <parameter name="option">
+                               <optionlist>
+                                       <option name="s">
+                                               <para>Return immediately if the channel is not answered.</para>
+                                       </option>
+                                       <option name="i">
+                                               <para>Play <replaceable>filename</replaceable> as an indication tone from your
+                                               <filename>indications.conf</filename> or a directly specified list of
+                                               frequencies and durations.</para>
+                                       </option>
+                                       <option name="n">
+                                               <para>Read digits even if the channel is not answered.</para>
+                                       </option>
+                               </optionlist>
+                       </parameter>
+                       <parameter name="timeout">
+                               <para>An integer number of seconds to wait for a digit response. If
+                               greater than <literal>0</literal>, that value will override the default timeout.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Reads a <literal>#</literal> terminated string of digits from the user into the given variable.</para>
+                       <para>Will set READEXTENSTATUS on exit with one of the following statuses:</para>
+                       <variablelist>
+                               <variable name="READEXTENSTATUS">
+                                       <value name="OK">
+                                               A valid extension exists in ${variable}.
+                                       </value>
+                                       <value name="TIMEOUT">
+                                               No extension was entered in the specified time.  Also sets ${variable} to "t".
+                                       </value>
+                                       <value name="INVALID">
+                                               An invalid extension, ${INVALID_EXTEN}, was entered.  Also sets ${variable} to "i".
+                                       </value>
+                                       <value name="SKIP">
+                                               Line was not up and the option 's' was specified.
+                                       </value>
+                                       <value name="ERROR">
+                                               Invalid arguments were passed.
+                                       </value>
+                               </variable>
+                       </variablelist>
+               </description>
+       </application>
+ ***/
+
+enum readexten_option_flags {
        OPT_SKIP = (1 << 0),
        OPT_INDICATION = (1 << 1),
        OPT_NOANSWER = (1 << 2),
-} readexten_option_flags;
+};
 
 AST_APP_OPTIONS(readexten_app_options, {
        AST_APP_OPTION('s', OPT_SKIP),
@@ -54,36 +112,14 @@ AST_APP_OPTIONS(readexten_app_options, {
 
 static char *app = "ReadExten";
 
-static char *synopsis = "Read an extension into a variable";
-
-static char *descrip = 
-"  ReadExten(<variable>[,[<filename>][,[<context>][,[<option>][,<timeout>]]]])\n\n"
-"Reads a #-terminated string of digits from the user into the given variable.\n"
-"  filename  file to play before reading digits or tone with option i\n"
-"  context   context in which to match extensions\n"
-"  option    options are:\n"
-"              s - Return immediately if the channel is not answered,\n"
-"              i - Play filename as an indication tone from your\n"
-"                  indications.conf\n"
-"              n - Read digits even if the channel is not answered.\n"
-"  timeout   An integer number of seconds to wait for a digit response. If\n"
-"            greater than 0, that value will override the default timeout.\n\n"
-"ReadExten will set READEXTENSTATUS on exit with one of the following statuses:\n"
-"  OK        A valid extension exists in ${variable}\n"
-"  TIMEOUT   No extension was entered in the specified time\n"
-"  INVALID   An invalid extension, ${INVALID_EXTEN}, was entered\n"
-"  SKIP      Line was not up and the option 's' was specified\n"
-"  ERROR     Invalid arguments were passed\n";
-
-
-static int readexten_exec(struct ast_channel *chan, void *data)
+static int readexten_exec(struct ast_channel *chan, const char *data)
 {
        int res = 0;
        char exten[256] = "";
        int maxdigits = sizeof(exten) - 1;
        int timeout = 0, digit_timeout = 0, x = 0;
        char *argcopy = NULL, *status = "";
-       struct ind_tone_zone_sound *ts = NULL;
+       struct ast_tone_zone_sound *ts = NULL;
        struct ast_flags flags = {0};
 
         AST_DECLARE_APP_ARGS(arglist,
@@ -104,7 +140,7 @@ static int readexten_exec(struct ast_channel *chan, void *data)
        AST_STANDARD_APP_ARGS(arglist, argcopy);
 
        if (ast_strlen_zero(arglist.variable)) {
-               ast_log(LOG_WARNING, "Invalid! Usage: ReadExten(variable[|filename][|context][|options][|timeout])\n\n");
+               ast_log(LOG_WARNING, "Usage: ReadExten(variable[,filename[,context[,options[,timeout]]]])\n");
                pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
                return 0;
        }
@@ -125,13 +161,14 @@ static int readexten_exec(struct ast_channel *chan, void *data)
        }
 
        if (timeout <= 0)
-               timeout = chan->pbx ? chan->pbx->rtimeout * 1000 : 10000;
+               timeout = chan->pbx ? chan->pbx->rtimeoutms : 10000;
 
        if (digit_timeout <= 0)
-               digit_timeout = chan->pbx ? chan->pbx->dtimeout * 1000 : 5000;
+               digit_timeout = chan->pbx ? chan->pbx->dtimeoutms : 5000;
 
-       if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename))
+       if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename)) {
                ts = ast_get_indication_tone(chan->zone, arglist.filename);
+       }
 
        do {
                if (chan->_state != AST_STATE_UP) {
@@ -154,10 +191,21 @@ static int readexten_exec(struct ast_channel *chan, void *data)
                ast_playtones_stop(chan);
                ast_stopstream(chan);
 
-               if (ts && ts->data[0])
+               if (ts && ts->data[0]) {
                        res = ast_playtones_start(chan, 0, ts->data, 0);
-               else if (arglist.filename)
-                       res = ast_streamfile(chan, arglist.filename, chan->language);
+               } else if (arglist.filename) {
+                       if (ast_test_flag(&flags, OPT_INDICATION) && ast_fileexists(arglist.filename, NULL, chan->language) <= 0) {
+                               /*
+                                * We were asked to play an indication that did not exist in the config.
+                                * If no such file exists, play it as a tonelist.  With any luck they won't
+                                * have a file named "350+440.ulaw"
+                                * (but honestly, who would do something so silly?)
+                                */
+                               res = ast_playtones_start(chan, 0, arglist.filename, 0);
+                       } else {
+                               res = ast_streamfile(chan, arglist.filename, chan->language);
+                       }
+               }
 
                for (x = 0; x < maxdigits; x++) {
                        ast_debug(3, "extension so far: '%s', timeout: %d\n", exten, timeout);
@@ -168,17 +216,23 @@ static int readexten_exec(struct ast_channel *chan, void *data)
                        timeout = digit_timeout;
 
                        if (res < 1) {          /* timeout expired or hangup */
-                               if (ast_check_hangup(chan))
+                               if (ast_check_hangup(chan)) {
                                        status = "HANGUP";
-                               else
+                               } else if (x == 0) {
+                                       pbx_builtin_setvar_helper(chan, arglist.variable, "t");
                                        status = "TIMEOUT";
-                               break;
-                       } else if (res == '#') {
+                               }
                                break;
                        }
 
                        exten[x] = res;
-                       if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */, chan->cid.cid_num)) {
+                       if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */,
+                               S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
+                               if (!ast_exists_extension(chan, arglist.context, exten, 1,
+                                       S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))
+                                       && res == '#') {
+                                       exten[x] = '\0';
+                               }
                                break;
                        }
                }
@@ -186,76 +240,37 @@ static int readexten_exec(struct ast_channel *chan, void *data)
                if (!ast_strlen_zero(status))
                        break;
 
-               if (ast_exists_extension(chan, arglist.context, exten, 1, chan->cid.cid_num)) {
+               if (ast_exists_extension(chan, arglist.context, exten, 1,
+                       S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
                        ast_debug(3, "User entered valid extension '%s'\n", exten);
                        pbx_builtin_setvar_helper(chan, arglist.variable, exten);
                        status = "OK";
                } else {
-                       ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, chan->name);
+                       ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, ast_channel_name(chan));
+                       pbx_builtin_setvar_helper(chan, arglist.variable, "i");
                        pbx_builtin_setvar_helper(chan, "INVALID_EXTEN", exten);
                        status = "INVALID";
                }
        } while (0);
 
-       pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
-
-       return status[0] == 'H' ? -1 : 0;
-}
-
-static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
-{
-       int priority_int;
-       AST_DECLARE_APP_ARGS(args,
-               AST_APP_ARG(context);
-               AST_APP_ARG(extension);
-               AST_APP_ARG(priority);
-       );
-
-       AST_STANDARD_APP_ARGS(args, parse);
-
-       if (ast_strlen_zero(args.context))
-               args.context = chan->context;
-
-       if (ast_strlen_zero(args.extension)) {
-               ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
-               return -1;
+       if (ts) {
+               ts = ast_tone_zone_sound_unref(ts);
        }
 
-       if (ast_strlen_zero(args.priority))
-               priority_int = 1;
-       else
-               priority_int = atoi(args.priority);
-
-       if (ast_exists_extension(chan, args.context, args.extension, priority_int, chan->cid.cid_num))
-           ast_copy_string(buffer, "1", buflen);
-       else
-           ast_copy_string(buffer, "0", buflen);
+       pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
 
-       return 0;
+       return status[0] == 'H' ? -1 : 0;
 }
 
-static struct ast_custom_function acf_isexten = {
-       .name = "VALID_EXTEN",
-       .synopsis = "Determine whether an extension exists or not",
-       .syntax = "VALID_EXTEN([<context>],<extension>[,<priority>])",
-       .desc =
-"Returns a true value if the indicated context, extension, and priority exist.\n"
-"Context defaults to the current context, priority defaults to 1.\n",
-       .read = acf_isexten_exec,
-};
-
 static int unload_module(void)
 {
        int res = ast_unregister_application(app);
-       res |= ast_custom_function_unregister(&acf_isexten);
-
-       return res;     
+       return res;
 }
 
 static int load_module(void)
 {
-       int res = ast_register_application(app, readexten_exec, synopsis, descrip);
-       res |= ast_custom_function_register(&acf_isexten);
+       int res = ast_register_application_xml(app, readexten_exec);
        return res;
 }