app_read.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2005, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Trivial application to read a variable
00022  *
00023  * \author Mark Spencer <markster@digium.com>
00024  * 
00025  * \ingroup applications
00026  */
00027 
00028 /*** MODULEINFO
00029    <support_level>core</support_level>
00030  ***/
00031  
00032 #include "asterisk.h"
00033 
00034 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 356042 $")
00035 
00036 #include "asterisk/file.h"
00037 #include "asterisk/pbx.h"
00038 #include "asterisk/channel.h"
00039 #include "asterisk/app.h"
00040 #include "asterisk/module.h"
00041 #include "asterisk/indications.h"
00042 
00043 /*** DOCUMENTATION
00044    <application name="Read" language="en_US">
00045       <synopsis>
00046          Read a variable.
00047       </synopsis>
00048       <syntax>
00049          <parameter name="variable" required="true">
00050             <para>The input digits will be stored in the given <replaceable>variable</replaceable>
00051             name.</para>
00052          </parameter>
00053          <parameter name="filenames" argsep="&amp;">
00054             <argument name="filename" required="true">
00055                <para>file(s) to play before reading digits or tone with option i</para>
00056             </argument>
00057             <argument name="filename2" multiple="true" />
00058          </parameter>
00059          <parameter name="maxdigits">
00060             <para>Maximum acceptable number of digits. Stops reading after
00061             <replaceable>maxdigits</replaceable> have been entered (without
00062             requiring the user to press the <literal>#</literal> key).</para>
00063             <para>Defaults to <literal>0</literal> - no limit - wait for the
00064             user press the <literal>#</literal> key. Any value below
00065             <literal>0</literal> means the same. Max accepted value is
00066             <literal>255</literal>.</para>
00067          </parameter>
00068          <parameter name="options">
00069             <optionlist>
00070                <option name="s">
00071                   <para>to return immediately if the line is not up.</para>
00072                </option>
00073                <option name="i">
00074                   <para>to play  filename as an indication tone from your
00075                   <filename>indications.conf</filename>.</para>
00076                </option>
00077                <option name="n">
00078                   <para>to read digits even if the line is not up.</para>
00079                </option>
00080             </optionlist>
00081          </parameter>
00082          <parameter name="attempts">
00083             <para>If greater than <literal>1</literal>, that many
00084             <replaceable>attempts</replaceable> will be made in the
00085             event no data is entered.</para>
00086          </parameter>
00087          <parameter name="timeout">
00088             <para>The number of seconds to wait for a digit response. If greater
00089             than <literal>0</literal>, that value will override the default timeout.
00090             Can be floating point.</para>
00091          </parameter>
00092       </syntax>
00093       <description>
00094          <para>Reads a #-terminated string of digits a certain number of times from the
00095          user in to the given <replaceable>variable</replaceable>.</para>
00096          <para>This application sets the following channel variable upon completion:</para>
00097          <variablelist>
00098             <variable name="READSTATUS">
00099                <para>This is the status of the read operation.</para>
00100                <value name="OK" />
00101                <value name="ERROR" />
00102                <value name="HANGUP" />
00103                <value name="INTERRUPTED" />
00104                <value name="SKIPPED" />
00105                <value name="TIMEOUT" />
00106             </variable>
00107          </variablelist>
00108       </description>
00109       <see-also>
00110          <ref type="application">SendDTMF</ref>
00111       </see-also>
00112    </application>
00113  ***/
00114 
00115 enum read_option_flags {
00116    OPT_SKIP = (1 << 0),
00117    OPT_INDICATION = (1 << 1),
00118    OPT_NOANSWER = (1 << 2),
00119 };
00120 
00121 AST_APP_OPTIONS(read_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 = "Read";
00128 
00129 static int read_exec(struct ast_channel *chan, const char *data)
00130 {
00131    int res = 0;
00132    char tmp[256] = "";
00133    int maxdigits = 255;
00134    int tries = 1, to = 0, x = 0;
00135    double tosec;
00136    char *argcopy = NULL;
00137    struct ast_tone_zone_sound *ts = NULL;
00138    struct ast_flags flags = {0};
00139    const char *status = "ERROR";
00140 
00141    AST_DECLARE_APP_ARGS(arglist,
00142       AST_APP_ARG(variable);
00143       AST_APP_ARG(filename);
00144       AST_APP_ARG(maxdigits);
00145       AST_APP_ARG(options);
00146       AST_APP_ARG(attempts);
00147       AST_APP_ARG(timeout);
00148    );
00149    
00150    pbx_builtin_setvar_helper(chan, "READSTATUS", status);
00151    if (ast_strlen_zero(data)) {
00152       ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
00153       return 0;
00154    }
00155    
00156    argcopy = ast_strdupa(data);
00157 
00158    AST_STANDARD_APP_ARGS(arglist, argcopy);
00159 
00160    if (!ast_strlen_zero(arglist.options)) {
00161       ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
00162    }
00163    
00164    if (!ast_strlen_zero(arglist.attempts)) {
00165       tries = atoi(arglist.attempts);
00166       if (tries <= 0)
00167          tries = 1;
00168    }
00169 
00170    if (!ast_strlen_zero(arglist.timeout)) {
00171       tosec = atof(arglist.timeout);
00172       if (tosec <= 0)
00173          to = 0;
00174       else
00175          to = tosec * 1000.0;
00176    }
00177 
00178    if (ast_strlen_zero(arglist.filename)) {
00179       arglist.filename = NULL;
00180    }
00181    if (!ast_strlen_zero(arglist.maxdigits)) {
00182       maxdigits = atoi(arglist.maxdigits);
00183       if ((maxdigits < 1) || (maxdigits > 255)) {
00184          maxdigits = 255;
00185       } else
00186          ast_verb(3, "Accepting a maximum of %d digits.\n", maxdigits);
00187    }
00188    if (ast_strlen_zero(arglist.variable)) {
00189       ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[,filename][,maxdigits][,option][,attempts][,timeout])\n\n");
00190       return 0;
00191    }
00192    if (ast_test_flag(&flags, OPT_INDICATION)) {
00193       if (!ast_strlen_zero(arglist.filename)) {
00194          ts = ast_get_indication_tone(ast_channel_zone(chan), arglist.filename);
00195       }
00196    }
00197    if (ast_channel_state(chan) != AST_STATE_UP) {
00198       if (ast_test_flag(&flags, OPT_SKIP)) {
00199          /* At the user's option, skip if the line is not up */
00200          pbx_builtin_setvar_helper(chan, arglist.variable, "");
00201          pbx_builtin_setvar_helper(chan, "READSTATUS", "SKIPPED");
00202          return 0;
00203       } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
00204          /* Otherwise answer unless we're supposed to read while on-hook */
00205          res = ast_answer(chan);
00206       }
00207    }
00208    if (!res) {
00209       while (tries && !res) {
00210          ast_stopstream(chan);
00211          if (ts && ts->data[0]) {
00212             if (!to)
00213                to = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 6000;
00214             res = ast_playtones_start(chan, 0, ts->data, 0);
00215             for (x = 0; x < maxdigits; ) {
00216                res = ast_waitfordigit(chan, to);
00217                ast_playtones_stop(chan);
00218                if (res < 1) {
00219                   if (res == 0)
00220                      status = "TIMEOUT";
00221                   tmp[x]='\0';
00222                   break;
00223                }
00224                tmp[x++] = res;
00225                if (tmp[x-1] == '#') {
00226                   tmp[x-1] = '\0';
00227                   status = "OK";
00228                   break;
00229                }
00230                if (x >= maxdigits) {
00231                   status = "OK";
00232                }
00233             }
00234          } else {
00235             res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
00236             if (res == AST_GETDATA_COMPLETE || res == AST_GETDATA_EMPTY_END_TERMINATED)
00237                status = "OK";
00238             else if (res == AST_GETDATA_TIMEOUT)
00239                status = "TIMEOUT";
00240             else if (res == AST_GETDATA_INTERRUPTED)
00241                status = "INTERRUPTED";
00242          }
00243          if (res > -1) {
00244             pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
00245             if (!ast_strlen_zero(tmp)) {
00246                ast_verb(3, "User entered '%s'\n", tmp);
00247                tries = 0;
00248             } else {
00249                tries--;
00250                if (tries)
00251                   ast_verb(3, "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
00252                else
00253                   ast_verb(3, "User entered nothing.\n");
00254             }
00255             res = 0;
00256          } else {
00257             pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
00258             ast_verb(3, "User disconnected\n");
00259          }
00260       }
00261    }
00262 
00263    if (ts) {
00264       ts = ast_tone_zone_sound_unref(ts);
00265    }
00266 
00267    if (ast_check_hangup(chan))
00268       status = "HANGUP";
00269    pbx_builtin_setvar_helper(chan, "READSTATUS", status);
00270    return 0;
00271 }
00272 
00273 static int unload_module(void)
00274 {
00275    return ast_unregister_application(app);
00276 }
00277 
00278 static int load_module(void)
00279 {
00280    return ast_register_application_xml(app, read_exec);
00281 }
00282 
00283 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");

Generated on Thu Apr 16 06:27:12 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6