These small app documentation changes to app_dial and app_read will hopefully avert...
[asterisk/asterisk.git] / 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;
94         int to = 0;
95         int x = 0;
96         char *argcopy = NULL;
97         struct tone_zone_sound *ts;
98         struct ast_flags flags = {0};
99
100          AST_DECLARE_APP_ARGS(arglist,
101                 AST_APP_ARG(variable);
102                 AST_APP_ARG(filename);
103                 AST_APP_ARG(maxdigits);
104                 AST_APP_ARG(options);
105                 AST_APP_ARG(attempts);
106                 AST_APP_ARG(timeout);
107         );
108         
109         if (ast_strlen_zero(data)) {
110                 ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
111                 return -1;
112         }
113
114         u = ast_module_user_add(chan);
115         
116         argcopy = ast_strdupa(data);
117
118         AST_STANDARD_APP_ARGS(arglist, argcopy);
119
120         if (!ast_strlen_zero(arglist.options)) {
121                 ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
122         }
123         
124         if (!ast_strlen_zero(arglist.attempts)) {
125                 tries = atoi(arglist.attempts);
126                 if (tries <= 0)
127                         tries = 1;
128         }
129
130         if (!ast_strlen_zero(arglist.timeout)) {
131                 to = atoi(arglist.timeout);
132                 if (to <= 0)
133                         to = 0;
134                 else
135                         to *= 1000;
136         }
137
138         if (ast_strlen_zero(arglist.filename)) {
139                 arglist.filename = NULL;
140         }
141         if (!ast_strlen_zero(arglist.maxdigits)) {
142                 maxdigits = atoi(arglist.maxdigits);
143                 if ((maxdigits<1) || (maxdigits>255)) {
144                         maxdigits = 255;
145                 } else if (option_verbose > 2)
146                         ast_verbose(VERBOSE_PREFIX_3 "Accepting a maximum of %d digits.\n", maxdigits);
147         }
148         if (ast_strlen_zero(arglist.variable)) {
149                 ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n\n");
150                 ast_module_user_remove(u);
151                 return -1;
152         }
153         ts=NULL;
154         if (ast_test_flag(&flags,OPT_INDICATION)) {
155                 if (!ast_strlen_zero(arglist.filename)) {
156                         ts = ast_get_indication_tone(chan->zone,arglist.filename);
157                 }
158         }
159         if (chan->_state != AST_STATE_UP) {
160                 if (ast_test_flag(&flags,OPT_SKIP)) {
161                         /* At the user's option, skip if the line is not up */
162                         pbx_builtin_setvar_helper(chan, arglist.variable, "\0");
163                         ast_module_user_remove(u);
164                         return 0;
165                 } else if (!ast_test_flag(&flags,OPT_NOANSWER)) {
166                         /* Otherwise answer unless we're supposed to read while on-hook */
167                         res = ast_answer(chan);
168                 }
169         }
170         if (!res) {
171                 while (tries && !res) {
172                         ast_stopstream(chan);
173                         if (ts && ts->data[0]) {
174                                 if (!to)
175                                         to = chan->pbx ? chan->pbx->rtimeout * 1000 : 6000;
176                                 res = ast_playtones_start(chan, 0, ts->data, 0);
177                                 for (x = 0; x < maxdigits; ) {
178                                         res = ast_waitfordigit(chan, to);
179                                         ast_playtones_stop(chan);
180                                         if (res < 1) {
181                                                 tmp[x]='\0';
182                                                 break;
183                                         }
184                                         tmp[x++] = res;
185                                         if (tmp[x-1] == '#') {
186                                                 tmp[x-1] = '\0';
187                                                 break;
188                                         }
189                                 }
190                         } else {
191                                 res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
192                         }
193                         if (res > -1) {
194                                 pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
195                                 if (!ast_strlen_zero(tmp)) {
196                                         if (option_verbose > 2)
197                                                 ast_verbose(VERBOSE_PREFIX_3 "User entered '%s'\n", tmp);
198                                         tries = 0;
199                                 } else {
200                                         tries--;
201                                         if (option_verbose > 2) {
202                                                 if (tries)
203                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
204                                                 else
205                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing.\n");
206                                         }
207                                 }
208                                 res = 0;
209                         } else {
210                                 if (option_verbose > 2)
211                                         ast_verbose(VERBOSE_PREFIX_3 "User disconnected\n");
212                         }
213                 }
214         }
215         ast_module_user_remove(u);
216         return res;
217 }
218
219 static int unload_module(void)
220 {
221         int res;
222
223         res = ast_unregister_application(app);
224         
225         ast_module_user_hangup_all();
226
227         return res;     
228 }
229
230 static int load_module(void)
231 {
232         return ast_register_application(app, read_exec, synopsis, descrip);
233 }
234
235 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");