Thu Sep 7 01:02:51 2017

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 /*** MODULEINFO
00029    <support_level>core</support_level>
00030  ***/
00031  
00032 #include "asterisk.h"
00033 
00034 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 328209 $")
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 extern AST_LIST_HEAD(readmaskvars, ast_variable_list) readmaskvars;
00130 
00131 static int read_exec(struct ast_channel *chan, const char *data)
00132 {
00133    int res = 0;
00134    char tmp[256] = "";
00135    char *digits;
00136    int maxdigits = 255;
00137    int tries = 1, to = 0, x = 0;
00138    double tosec;
00139    char *argcopy = NULL;
00140    struct ast_tone_zone_sound *ts = NULL;
00141    struct ast_flags flags = {0};
00142    const char *status = "ERROR";
00143    struct ast_variable_list *cur;
00144 
00145    AST_DECLARE_APP_ARGS(arglist,
00146       AST_APP_ARG(variable);
00147       AST_APP_ARG(filename);
00148       AST_APP_ARG(maxdigits);
00149       AST_APP_ARG(options);
00150       AST_APP_ARG(attempts);
00151       AST_APP_ARG(timeout);
00152    );
00153    
00154    pbx_builtin_setvar_helper(chan, "READSTATUS", status);
00155    if (ast_strlen_zero(data)) {
00156       ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
00157       return 0;
00158    }
00159    
00160    argcopy = ast_strdupa(data);
00161 
00162    AST_STANDARD_APP_ARGS(arglist, argcopy);
00163 
00164    if (!ast_strlen_zero(arglist.options)) {
00165       ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
00166    }
00167    
00168    if (!ast_strlen_zero(arglist.attempts)) {
00169       tries = atoi(arglist.attempts);
00170       if (tries <= 0)
00171          tries = 1;
00172    }
00173 
00174    if (!ast_strlen_zero(arglist.timeout)) {
00175       tosec = atof(arglist.timeout);
00176       if (tosec <= 0)
00177          to = 0;
00178       else
00179          to = tosec * 1000.0;
00180    }
00181 
00182    if (ast_strlen_zero(arglist.filename)) {
00183       arglist.filename = NULL;
00184    }
00185    if (!ast_strlen_zero(arglist.maxdigits)) {
00186       maxdigits = atoi(arglist.maxdigits);
00187       if ((maxdigits < 1) || (maxdigits > 255)) {
00188          maxdigits = 255;
00189       } else
00190          ast_verb(3, "Accepting a maximum of %d digits.\n", maxdigits);
00191    }
00192    if (ast_strlen_zero(arglist.variable)) {
00193       ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[,filename][,maxdigits][,option][,attempts][,timeout])\n\n");
00194       return 0;
00195    }
00196    if (ast_test_flag(&flags, OPT_INDICATION)) {
00197       if (!ast_strlen_zero(arglist.filename)) {
00198          ts = ast_get_indication_tone(chan->zone, arglist.filename);
00199       }
00200    }
00201    if (chan->_state != AST_STATE_UP) {
00202       if (ast_test_flag(&flags, OPT_SKIP)) {
00203          /* At the user's option, skip if the line is not up */
00204          pbx_builtin_setvar_helper(chan, arglist.variable, "");
00205          pbx_builtin_setvar_helper(chan, "READSTATUS", "SKIPPED");
00206          return 0;
00207       } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
00208          /* Otherwise answer unless we're supposed to read while on-hook */
00209          res = ast_answer(chan);
00210       }
00211    }
00212    if (!res) {
00213       while (tries && !res) {
00214          ast_stopstream(chan);
00215          if (ts && ts->data[0]) {
00216             if (!to)
00217                to = chan->pbx ? chan->pbx->rtimeoutms : 6000;
00218             res = ast_playtones_start(chan, 0, ts->data, 0);
00219             for (x = 0; x < maxdigits; ) {
00220                res = ast_waitfordigit(chan, to);
00221                ast_playtones_stop(chan);
00222                if (res < 1) {
00223                   if (res == 0)
00224                      status = "TIMEOUT";
00225                   tmp[x]='\0';
00226                   break;
00227                }
00228                tmp[x++] = res;
00229                if (tmp[x-1] == '#') {
00230                   tmp[x-1] = '\0';
00231                   status = "OK";
00232                   break;
00233                }
00234                if (x >= maxdigits) {
00235                   status = "OK";
00236                }
00237             }
00238          } else {
00239             res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
00240             if (res == AST_GETDATA_COMPLETE || res == AST_GETDATA_EMPTY_END_TERMINATED)
00241                status = "OK";
00242             else if (res == AST_GETDATA_TIMEOUT)
00243                status = "TIMEOUT";
00244             else if (res == AST_GETDATA_INTERRUPTED)
00245                status = "INTERRUPTED";
00246          }
00247          if (res > -1) {
00248             pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
00249             if (!ast_strlen_zero(tmp)) {
00250                if (VERBOSITY_ATLEAST(3)) {
00251                   digits = ast_strdupa(tmp);
00252                   AST_LIST_TRAVERSE(&readmaskvars, cur, list) {
00253                      if (!strncmp(arglist.variable, cur->variable, sizeof(cur->variable))) {
00254                         mask_string(digits, readmaskvarini, readmaskvarend, 0);
00255                         break;
00256                      }
00257                   }
00258                   ast_verb(3, "User entered '%s'\n", digits);
00259                }
00260                tries = 0;
00261             } else {
00262                tries--;
00263                if (tries)
00264                   ast_verb(3, "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
00265                else
00266                   ast_verb(3, "User entered nothing.\n");
00267             }
00268             res = 0;
00269          } else {
00270             pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
00271             ast_verb(3, "User disconnected\n");
00272          }
00273       }
00274    }
00275 
00276    if (ts) {
00277       ts = ast_tone_zone_sound_unref(ts);
00278    }
00279 
00280    if (ast_check_hangup(chan))
00281       status = "HANGUP";
00282    pbx_builtin_setvar_helper(chan, "READSTATUS", status);
00283    return 0;
00284 }
00285 
00286 static int unload_module(void)
00287 {
00288    return ast_unregister_application(app);
00289 }
00290 
00291 static int load_module(void)
00292 {
00293    return ast_register_application_xml(app, read_exec);
00294 }
00295 
00296 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");

Generated on 7 Sep 2017 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1