e024a5c389a8ae1b21f65ffa4b2c40765ff6f86e
[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  * \ingroup applications
24  */
25  
26 #include <string.h>
27 #include <stdlib.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/lock.h"
34 #include "asterisk/file.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/app.h"
39 #include "asterisk/module.h"
40 #include "asterisk/translate.h"
41 #include "asterisk/options.h"
42 #include "asterisk/utils.h"
43
44 static char *tdesc = "Read Variable Application";
45
46 static char *app = "Read";
47
48 static char *synopsis = "Read a variable";
49
50 static char *descrip = 
51 "  Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n\n"
52 "Reads a #-terminated string of digits a certain number of times from the\n"
53 "user in to the given variable.\n"
54 "  filename   -- file to play before reading digits.\n"
55 "  maxdigits  -- maximum acceptable number of digits. Stops reading after\n"
56 "                maxdigits have been entered (without requiring the user to\n"
57 "                press the '#' key).\n"
58 "                Defaults to 0 - no limit - wait for the user press the '#' key.\n"
59 "                Any value below 0 means the same. Max accepted value is 255.\n"
60 "  option     -- may be 'skip' to return immediately if the line is not up,\n"
61 "                or 'noanswer' to read digits even if the line is not up.\n"
62 "  attempts   -- if greater than 1, that many attempts will be made in the \n"
63 "                event no data is entered.\n"
64 "  timeout    -- if greater than 0, that value will override the default timeout.\n\n"
65 "Read should disconnect if the function fails or errors out.\n";
66
67 STANDARD_LOCAL_USER;
68
69 LOCAL_USER_DECL;
70
71 #define ast_next_data(instr,ptr,delim) if((ptr=strchr(instr,delim))) { *(ptr) = '\0' ; ptr++;}
72
73 static int read_exec(struct ast_channel *chan, void *data)
74 {
75         int res = 0;
76         struct localuser *u;
77         char tmp[256];
78         char *timeout = NULL;
79         char *varname = NULL;
80         char *filename = NULL;
81         char *loops;
82         char *maxdigitstr=NULL;
83         char *options=NULL;
84         int option_skip = 0;
85         int option_noanswer = 0;
86         int maxdigits=255;
87         int tries = 1;
88         int to = 0;
89         int x = 0;
90         char *argcopy = NULL;
91         char *args[8];
92
93         if (ast_strlen_zero(data)) {
94                 ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
95                 return -1;
96         }
97
98         LOCAL_USER_ADD(u);
99         
100         argcopy = ast_strdupa(data);
101         if (!argcopy) {
102                 ast_log(LOG_ERROR, "Out of memory\n");
103                 LOCAL_USER_REMOVE(u);
104                 return -1;
105         }
106
107         if (ast_app_separate_args(argcopy, '|', args, sizeof(args) / sizeof(args[0])) < 1) {
108                 ast_log(LOG_WARNING, "Cannot Parse Arguments.\n");
109                 LOCAL_USER_REMOVE(u);
110                 return -1;
111         }
112
113         varname = args[x++];
114         filename = args[x++];
115         maxdigitstr = args[x++];
116         options = args[x++];
117         loops = args[x++];
118         timeout = args[x++];
119         
120         if (options) { 
121                 if (!strcasecmp(options, "skip"))
122                         option_skip = 1;
123                 else if (!strcasecmp(options, "noanswer"))
124                         option_noanswer = 1;
125                 else {
126                         if (strchr(options, 's'))
127                                 option_skip = 1;
128                         if (strchr(options, 'n'))
129                                 option_noanswer = 1;
130                 }
131         }
132
133         if(loops) {
134                 tries = atoi(loops);
135                 if(tries <= 0)
136                         tries = 1;
137         }
138
139         if(timeout) {
140                 to = atoi(timeout);
141                 if (to <= 0)
142                         to = 0;
143                 else
144                         to *= 1000;
145         }
146
147         if (ast_strlen_zero(filename)) 
148                 filename = NULL;
149         if (maxdigitstr) {
150                 maxdigits = atoi(maxdigitstr);
151                 if ((maxdigits<1) || (maxdigits>255)) {
152                         maxdigits = 255;
153                 } else if (option_verbose > 2)
154                         ast_verbose(VERBOSE_PREFIX_3 "Accepting a maximum of %d digits.\n", maxdigits);
155         }
156         if (ast_strlen_zero(varname)) {
157                 ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[|filename][|maxdigits][|option][|attempts][|timeout])\n\n");
158                 LOCAL_USER_REMOVE(u);
159                 return -1;
160         }
161         
162         if (chan->_state != AST_STATE_UP) {
163                 if (option_skip) {
164                         /* At the user's option, skip if the line is not up */
165                         pbx_builtin_setvar_helper(chan, varname, "\0");
166                         LOCAL_USER_REMOVE(u);
167                         return 0;
168                 } else if (!option_noanswer) {
169                         /* Otherwise answer unless we're supposed to read while on-hook */
170                         res = ast_answer(chan);
171                 }
172         }
173         if (!res) {
174                 while(tries && !res) {
175                         ast_stopstream(chan);
176                         res = ast_app_getdata(chan, filename, tmp, maxdigits, to);
177                         if (res > -1) {
178                                 pbx_builtin_setvar_helper(chan, varname, tmp);
179                                 if (!ast_strlen_zero(tmp)) {
180                                         if (option_verbose > 2)
181                                                 ast_verbose(VERBOSE_PREFIX_3 "User entered '%s'\n", tmp);
182                                         tries = 0;
183                                 } else {
184                                         tries--;
185                                         if (option_verbose > 2) {
186                                                 if (tries)
187                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
188                                                 else
189                                                         ast_verbose(VERBOSE_PREFIX_3 "User entered nothing.\n");
190                                         }
191                                 }
192                                 res = 0;
193                         } else {
194                                 if (option_verbose > 2)
195                                         ast_verbose(VERBOSE_PREFIX_3 "User disconnected\n");
196                         }
197                 }
198         }
199         LOCAL_USER_REMOVE(u);
200         return res;
201 }
202
203 int unload_module(void)
204 {
205         int res;
206
207         res = ast_unregister_application(app);
208         
209         STANDARD_HANGUP_LOCALUSERS;
210
211         return res;     
212 }
213
214 int load_module(void)
215 {
216         return ast_register_application(app, read_exec, synopsis, descrip);
217 }
218
219 char *description(void)
220 {
221         return tdesc;
222 }
223
224 int usecount(void)
225 {
226         int res;
227         STANDARD_USECOUNT(res);
228         return res;
229 }
230
231 char *key()
232 {
233         return ASTERISK_GPL_KEY;
234 }