Wed Apr 6 11:29:38 2011

Asterisk developer's documentation


app_readexten.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 2007-2008, Trinity College Computing Center
00005  * Written by David Chappell <David.Chappell@trincoll.edu>
00006  *
00007  * See http://www.asterisk.org for more information about
00008  * the Asterisk project. Please do not directly contact
00009  * any of the maintainers of this project for assistance;
00010  * the project provides a web site, mailing lists and IRC
00011  * channels for your use.
00012  *
00013  * This program is free software, distributed under the terms of
00014  * the GNU General Public License Version 2. See the LICENSE file
00015  * at the top of the source tree.
00016  */
00017 
00018 /*! \file
00019  *
00020  * \brief Trivial application to read an extension into a variable
00021  *
00022  * \author David Chappell <David.Chappell@trincoll.edu>
00023  * 
00024  * \ingroup applications
00025  */
00026  
00027 #include "asterisk.h"
00028 
00029 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 281723 $")
00030 
00031 #include "asterisk/file.h"
00032 #include "asterisk/pbx.h"
00033 #include "asterisk/app.h"
00034 #include "asterisk/module.h"
00035 #include "asterisk/indications.h"
00036 #include "asterisk/channel.h"
00037 
00038 /*** DOCUMENTATION
00039    <application name="ReadExten" language="en_US">
00040       <synopsis>
00041          Read an extension into a variable.
00042       </synopsis>
00043       <syntax>
00044          <parameter name="variable" required="true" />
00045          <parameter name="filename">
00046             <para>File to play before reading digits or tone with option <literal>i</literal></para>
00047          </parameter>
00048          <parameter name="context">
00049             <para>Context in which to match extensions.</para>
00050          </parameter>
00051          <parameter name="option">
00052             <optionlist>
00053                <option name="s">
00054                   <para>Return immediately if the channel is not answered.</para>
00055                </option>
00056                <option name="i">
00057                   <para>Play <replaceable>filename</replaceable> as an indication tone from your
00058                   <filename>indications.conf</filename> or a directly specified list of
00059                   frequencies and durations.</para>
00060                </option>
00061                <option name="n">
00062                   <para>Read digits even if the channel is not answered.</para>
00063                </option>
00064             </optionlist>
00065          </parameter>
00066          <parameter name="timeout">
00067             <para>An integer number of seconds to wait for a digit response. If
00068             greater than <literal>0</literal>, that value will override the default timeout.</para>
00069          </parameter>
00070       </syntax>
00071       <description>
00072          <para>Reads a <literal>#</literal> terminated string of digits from the user into the given variable.</para>
00073          <para>Will set READEXTENSTATUS on exit with one of the following statuses:</para>
00074          <variablelist>
00075             <variable name="READEXTENSTATUS">
00076                <value name="OK">
00077                   A valid extension exists in ${variable}.
00078                </value>
00079                <value name="TIMEOUT">
00080                   No extension was entered in the specified time.  Also sets ${variable} to "t".
00081                </value>
00082                <value name="INVALID">
00083                   An invalid extension, ${INVALID_EXTEN}, was entered.  Also sets ${variable} to "i".
00084                </value>
00085                <value name="SKIP">
00086                   Line was not up and the option 's' was specified.
00087                </value>
00088                <value name="ERROR">
00089                   Invalid arguments were passed.
00090                </value>
00091             </variable>
00092          </variablelist>
00093       </description>
00094    </application>
00095    <function name="VALID_EXTEN" language="en_US">
00096       <synopsis>
00097          Determine whether an extension exists or not.
00098       </synopsis>
00099       <syntax>
00100          <parameter name="context">
00101             <para>Defaults to the current context</para>
00102          </parameter>
00103          <parameter name="extension" required="true" />
00104          <parameter name="priority">
00105             <para>Priority defaults to <literal>1</literal>.</para>
00106          </parameter>
00107       </syntax>
00108       <description>
00109          <para>Returns a true value if the indicated <replaceable>context</replaceable>,
00110          <replaceable>extension</replaceable>, and <replaceable>priority</replaceable> exist.</para>
00111       </description>
00112    </function>
00113  ***/
00114 
00115 enum readexten_option_flags {
00116    OPT_SKIP = (1 << 0),
00117    OPT_INDICATION = (1 << 1),
00118    OPT_NOANSWER = (1 << 2),
00119 };
00120 
00121 AST_APP_OPTIONS(readexten_app_options, {
00122    AST_APP_OPTION('s', OPT_SKIP),
00123    AST_APP_OPTION('i', OPT_INDICATION),
00124    AST_APP_OPTION('n', OPT_NOANSWER),
00125 });
00126 
00127 static char *app = "ReadExten";
00128 
00129 static int readexten_exec(struct ast_channel *chan, const char *data)
00130 {
00131    int res = 0;
00132    char exten[256] = "";
00133    int maxdigits = sizeof(exten) - 1;
00134    int timeout = 0, digit_timeout = 0, x = 0;
00135    char *argcopy = NULL, *status = "";
00136    struct ast_tone_zone_sound *ts = NULL;
00137    struct ast_flags flags = {0};
00138 
00139     AST_DECLARE_APP_ARGS(arglist,
00140       AST_APP_ARG(variable);
00141       AST_APP_ARG(filename);
00142       AST_APP_ARG(context);
00143       AST_APP_ARG(options);
00144       AST_APP_ARG(timeout);
00145    );
00146    
00147    if (ast_strlen_zero(data)) {
00148       ast_log(LOG_WARNING, "ReadExten requires at least one argument\n");
00149       pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
00150       return 0;
00151    }
00152 
00153    argcopy = ast_strdupa(data);
00154    AST_STANDARD_APP_ARGS(arglist, argcopy);
00155 
00156    if (ast_strlen_zero(arglist.variable)) {
00157       ast_log(LOG_WARNING, "Usage: ReadExten(variable[,filename[,context[,options[,timeout]]]])\n");
00158       pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
00159       return 0;
00160    }
00161 
00162    if (ast_strlen_zero(arglist.filename))
00163       arglist.filename = NULL;
00164 
00165    if (ast_strlen_zero(arglist.context))
00166       arglist.context = chan->context;
00167 
00168    if (!ast_strlen_zero(arglist.options))
00169       ast_app_parse_options(readexten_app_options, &flags, NULL, arglist.options);
00170 
00171    if (!ast_strlen_zero(arglist.timeout)) {
00172       timeout = atoi(arglist.timeout);
00173       if (timeout > 0)
00174          timeout *= 1000;
00175    }
00176 
00177    if (timeout <= 0)
00178       timeout = chan->pbx ? chan->pbx->rtimeoutms : 10000;
00179 
00180    if (digit_timeout <= 0)
00181       digit_timeout = chan->pbx ? chan->pbx->dtimeoutms : 5000;
00182 
00183    if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename)) {
00184       ts = ast_get_indication_tone(chan->zone, arglist.filename);
00185    }
00186 
00187    do {
00188       if (chan->_state != AST_STATE_UP) {
00189          if (ast_test_flag(&flags, OPT_SKIP)) {
00190             /* At the user's option, skip if the line is not up */
00191             pbx_builtin_setvar_helper(chan, arglist.variable, "");
00192             status = "SKIP";
00193             break;
00194          } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
00195             /* Otherwise answer unless we're supposed to read while on-hook */
00196             res = ast_answer(chan);
00197          }
00198       }
00199 
00200       if (res < 0) {
00201          status = "HANGUP";
00202          break;
00203       }
00204 
00205       ast_playtones_stop(chan);
00206       ast_stopstream(chan);
00207 
00208       if (ts && ts->data[0]) {
00209          res = ast_playtones_start(chan, 0, ts->data, 0);
00210       } else if (arglist.filename) {
00211          if (ast_test_flag(&flags, OPT_INDICATION) && ast_fileexists(arglist.filename, NULL, chan->language) <= 0) {
00212             /*
00213              * We were asked to play an indication that did not exist in the config.
00214              * If no such file exists, play it as a tonelist.  With any luck they won't
00215              * have a file named "350+440.ulaw"
00216              * (but honestly, who would do something so silly?)
00217              */
00218             res = ast_playtones_start(chan, 0, arglist.filename, 0);
00219          } else {
00220             res = ast_streamfile(chan, arglist.filename, chan->language);
00221          }
00222       }
00223 
00224       for (x = 0; x < maxdigits; x++) {
00225          ast_debug(3, "extension so far: '%s', timeout: %d\n", exten, timeout);
00226          res = ast_waitfordigit(chan, timeout);
00227 
00228          ast_playtones_stop(chan);
00229          ast_stopstream(chan);
00230          timeout = digit_timeout;
00231 
00232          if (res < 1) {    /* timeout expired or hangup */
00233             if (ast_check_hangup(chan)) {
00234                status = "HANGUP";
00235             } else if (x == 0) {
00236                pbx_builtin_setvar_helper(chan, arglist.variable, "t");
00237                status = "TIMEOUT";
00238             }
00239             break;
00240          }
00241 
00242          exten[x] = res;
00243          if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */,
00244             S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
00245             if (!ast_exists_extension(chan, arglist.context, exten, 1,
00246                S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))
00247                && res == '#') {
00248                exten[x] = '\0';
00249             }
00250             break;
00251          }
00252       }
00253 
00254       if (!ast_strlen_zero(status))
00255          break;
00256 
00257       if (ast_exists_extension(chan, arglist.context, exten, 1,
00258          S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
00259          ast_debug(3, "User entered valid extension '%s'\n", exten);
00260          pbx_builtin_setvar_helper(chan, arglist.variable, exten);
00261          status = "OK";
00262       } else {
00263          ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, chan->name);
00264          pbx_builtin_setvar_helper(chan, arglist.variable, "i");
00265          pbx_builtin_setvar_helper(chan, "INVALID_EXTEN", exten);
00266          status = "INVALID";
00267       }
00268    } while (0);
00269 
00270    if (ts) {
00271       ts = ast_tone_zone_sound_unref(ts);
00272    }
00273 
00274    pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
00275 
00276    return status[0] == 'H' ? -1 : 0;
00277 }
00278 
00279 static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
00280 {
00281    int priority_int;
00282    AST_DECLARE_APP_ARGS(args,
00283       AST_APP_ARG(context);
00284       AST_APP_ARG(extension);
00285       AST_APP_ARG(priority);
00286    );
00287 
00288    AST_STANDARD_APP_ARGS(args, parse);
00289 
00290    if (ast_strlen_zero(args.context))
00291       args.context = chan->context;
00292 
00293    if (ast_strlen_zero(args.extension)) {
00294       ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
00295       return -1;
00296    }
00297 
00298    if (ast_strlen_zero(args.priority))
00299       priority_int = 1;
00300    else
00301       priority_int = atoi(args.priority);
00302 
00303    if (ast_exists_extension(chan, args.context, args.extension, priority_int,
00304       S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
00305        ast_copy_string(buffer, "1", buflen);
00306    } else {
00307        ast_copy_string(buffer, "0", buflen);
00308    }
00309 
00310    return 0;
00311 }
00312 
00313 static struct ast_custom_function acf_isexten = {
00314    .name = "VALID_EXTEN",
00315    .read = acf_isexten_exec,
00316 };
00317 
00318 static int unload_module(void)
00319 {
00320    int res = ast_unregister_application(app);
00321    res |= ast_custom_function_unregister(&acf_isexten);
00322 
00323    return res; 
00324 }
00325 
00326 static int load_module(void)
00327 {
00328    int res = ast_register_application_xml(app, readexten_exec);
00329    res |= ast_custom_function_register(&acf_isexten);
00330    return res;
00331 }
00332 
00333 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read and evaluate extension validity");

Generated on Wed Apr 6 11:29:38 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7