apps/app_read.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2005, Digium, Inc.
   5  *
   6  * Mark Spencer <markster@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief Trivial application to read a variable
  22  *
  23  * \author Mark Spencer <markster@digium.com>
  24  *
  25  * \ingroup applications
  26  */
  27
  28 #include "asterisk.h"
  29
  30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  31
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #include <string.h>
  35
  36 #include "asterisk/lock.h"
  37 #include "asterisk/file.h"
  38 #include "asterisk/logger.h"
  39 #include "asterisk/channel.h"
  40 #include "asterisk/pbx.h"
  41 #include "asterisk/app.h"
  42 #include "asterisk/module.h"
  43 #include "asterisk/translate.h"
  44 #include "asterisk/options.h"
  45 #include "asterisk/utils.h"
  46 #include "asterisk/indications.h"
  47
  48 enum {
  49         OPT_SKIP = (1 << 0),
  50         OPT_INDICATION = (1 << 1),
  51         OPT_NOANSWER = (1 << 2),
  52 } read_option_flags;
  53
  54 AST_APP_OPTIONS(read_app_options, {
  55         AST_APP_OPTION('s', OPT_SKIP),
  56         AST_APP_OPTION('i', OPT_INDICATION),
  57         AST_APP_OPTION('n', OPT_NOANSWER),
  58 });
  59
  60 static char *app = "Read";
  61
  62 static char *synopsis = "Read a variable";
  63
  64 static char *descrip =
  65 "  Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n\n"
  66 "Reads a #-terminated string of digits a certain number of times from the\n"
  67 "user in to the given variable.\n"
  68 "  filename   -- file to play before reading digits or tone with option i\n"
  69 "  maxdigits  -- maximum acceptable number of digits. Stops reading after\n"
  70 "                maxdigits have been entered (without requiring the user to\n"
  71 "                press the '#' key).\n"
  72 "                Defaults to 0 - no limit - wait for the user press the '#' key.\n"
  73 "                Any value below 0 means the same. Max accepted value is 255.\n"
  74 "  option     -- options are 's' , 'i', 'n'\n"
  75 "                's' to return immediately if the line is not up,\n"
  76 "                'i' to play  filename as an indication tone from your indications.conf\n"
  77 "                'n' to read digits even if the line is not up.\n"
  78 "  attempts   -- if greater than 1, that many attempts will be made in the \n"
  79 "                event no data is entered.\n"
  80 "  timeout    -- An integer number of seconds to wait for a digit response. If greater\n"
  81 "                than 0, that value will override the default timeout.\n\n"
  82 "Read should disconnect if the function fails or errors out.\n";
  83
  84
  85 #define ast_next_data(instr,ptr,delim) if((ptr=strchr(instr,delim))) { *(ptr) = '\0' ; ptr++;}
  86
  87 static int read_exec(struct ast_channel *chan, void *data)
  88 {
  89         int res = 0;
  90         struct ast_module_user *u;
  91         char tmp[256] = "";
  92         int maxdigits = 255;
  93         int tries = 1, to = 0, x = 0;
  94         char *argcopy = NULL;
  95         struct ind_tone_zone_sound *ts;
  96         struct ast_flags flags = {0};
  97
  98          AST_DECLARE_APP_ARGS(arglist,
  99                 AST_APP_ARG(variable);
 100                 AST_APP_ARG(filename);
 101                 AST_APP_ARG(maxdigits);
 102                 AST_APP_ARG(options);
 103                 AST_APP_ARG(attempts);
 104                 AST_APP_ARG(timeout);
 105         );
 106
 107         if (ast_strlen_zero(data)) {
 108                 ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
 109                 return -1;
 110         }
 111
 112         u = ast_module_user_add(chan);
 113
 114         argcopy = ast_strdupa(data);
 115
 116         AST_STANDARD_APP_ARGS(arglist, argcopy);
 117
 118         if (!ast_strlen_zero(arglist.options)) {
 119                 ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
 120         }
 121
 122         if (!ast_strlen_zero(arglist.attempts)) {
 123                 tries = atoi(arglist.attempts);
 124                 if (tries <= 0)
 125                         tries = 1;
 126         }
 127
 128         if (!ast_strlen_zero(arglist.timeout)) {
 129                 to = atoi(arglist.timeout);
 130                 if (to <= 0)
 131                         to = 0;
 132                 else
 133                         to *= 1000;
 134         }
 135
 136         if (ast_strlen_zero(arglist.filename)) {
 137                 arglist.filename = NULL;
 138         }
 139         if (!ast_strlen_zero(arglist.maxdigits)) {
 140                 maxdigits = atoi(arglist.maxdigits);
 141                 if ((maxdigits<1) || (maxdigits>255)) {
 142                         maxdigits = 255;
 143                 } else if (option_verbose > 2)
 144                         ast_verbose(VERBOSE_PREFIX_3 "Accepting a maximum of %d digits.\n", maxdigits);
 145         }
 146         if (ast_strlen_zero(arglist.variable)) {
 147                 ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n\n");
 148                 ast_module_user_remove(u);
 149                 return -1;
 150         }
 151         ts=NULL;
 152         if (ast_test_flag(&flags,OPT_INDICATION)) {
 153                 if (!ast_strlen_zero(arglist.filename)) {
 154                         ts = ast_get_indication_tone(chan->zone,arglist.filename);
 155                 }
 156         }
 157         if (chan->_state != AST_STATE_UP) {
 158                 if (ast_test_flag(&flags,OPT_SKIP)) {
 159                         /* At the user's option, skip if the line is not up */
 160                         pbx_builtin_setvar_helper(chan, arglist.variable, "\0");
 161                         ast_module_user_remove(u);
 162                         return 0;
 163                 } else if (!ast_test_flag(&flags,OPT_NOANSWER)) {
 164                         /* Otherwise answer unless we're supposed to read while on-hook */
 165                         res = ast_answer(chan);
 166                 }
 167         }
 168         if (!res) {
 169                 while (tries && !res) {
 170                         ast_stopstream(chan);
 171                         if (ts && ts->data[0]) {
 172                                 if (!to)
 173                                         to = chan->pbx ? chan->pbx->rtimeout * 1000 : 6000;
 174                                 res = ast_playtones_start(chan, 0, ts->data, 0);
 175                                 for (x = 0; x < maxdigits; ) {
 176                                         res = ast_waitfordigit(chan, to);
 177                                         ast_playtones_stop(chan);
 178                                         if (res < 1) {
 179                                                 tmp[x]='\0';
 180                                                 break;
 181                                         }
 182                                         tmp[x++] = res;
 183                                         if (tmp[x-1] == '#') {
 184                                                 tmp[x-1] = '\0';
 185                                                 break;
 186                                         }
 187                                 }
 188                         } else {
 189                                 res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
 190                         }
 191                         if (res > -1) {
 192                                 pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
 193                                 if (!ast_strlen_zero(tmp)) {
 194                                         if (option_verbose > 2)
 195                                                 ast_verbose(VERBOSE_PREFIX_3 "User entered '%s'\n", tmp);
 196                                         tries = 0;
 197                                 } else {
 198                                         tries--;
 199                                         if (option_verbose > 2) {
 200                                                 if (tries)
 201                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
 202                                                 else
 203                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing.\n");
 204                                         }
 205                                 }
 206                                 res = 0;
 207                         } else {
 208                                 pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
 209                                 if (option_verbose > 2)
 210                                         ast_verbose(VERBOSE_PREFIX_3 "User disconnected\n");
 211                         }
 212                 }
 213         }
 214         ast_module_user_remove(u);
 215         return res;
 216 }
 217
 218 static int unload_module(void)
 219 {
 220         int res;
 221
 222         res = ast_unregister_application(app);
 223
 224         ast_module_user_hangup_all();
 225
 226         return res;
 227 }
 228
 229 static int load_module(void)
 230 {
 231         return ast_register_application(app, read_exec, synopsis, descrip);
 232 }
 233
 234 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");