Thu Apr 28 2011 17:13:28

Asterisk developer's documentation


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