include "logger.h" and errno.h from asterisk.h - usage shows that they
[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 "asterisk/lock.h"
33 #include "asterisk/file.h"
34 #include "asterisk/channel.h"
35 #include "asterisk/pbx.h"
36 #include "asterisk/app.h"
37 #include "asterisk/module.h"
38 #include "asterisk/translate.h"
39 #include "asterisk/options.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/indications.h"
42
43 enum {
44         OPT_SKIP = (1 << 0),
45         OPT_INDICATION = (1 << 1),
46         OPT_NOANSWER = (1 << 2),
47 } read_option_flags;
48
49 AST_APP_OPTIONS(read_app_options, {
50         AST_APP_OPTION('s', OPT_SKIP),
51         AST_APP_OPTION('i', OPT_INDICATION),
52         AST_APP_OPTION('n', OPT_NOANSWER),
53 });
54
55 static char *app = "Read";
56
57 static char *synopsis = "Read a variable";
58
59 static char *descrip = 
60 "  Read(variable[,filename[&filename2...]][,maxdigits][,option][,attempts][,timeout])\n\n"
61 "Reads a #-terminated string of digits a certain number of times from the\n"
62 "user in to the given variable.\n"
63 "  filename   -- file(s) to play before reading digits or tone with option i\n"
64 "  maxdigits  -- maximum acceptable number of digits. Stops reading after\n"
65 "                maxdigits have been entered (without requiring the user to\n"
66 "                press the '#' key).\n"
67 "                Defaults to 0 - no limit - wait for the user press the '#' key.\n"
68 "                Any value below 0 means the same. Max accepted value is 255.\n"
69 "  option     -- options are 's' , 'i', 'n'\n"
70 "                's' to return immediately if the line is not up,\n"
71 "                'i' to play  filename as an indication tone from your indications.conf\n"
72 "                'n' to read digits even if the line is not up.\n"
73 "  attempts   -- if greater than 1, that many attempts will be made in the \n"
74 "                event no data is entered.\n"
75 "  timeout    -- The number of seconds to wait for a digit response. If greater\n"
76 "                than 0, that value will override the default timeout. Can be floating point.\n\n"
77 "Read should disconnect if the function fails or errors out.\n";
78
79
80 #define ast_next_data(instr,ptr,delim) if((ptr=strchr(instr,delim))) { *(ptr) = '\0' ; ptr++;}
81
82 static int read_exec(struct ast_channel *chan, void *data)
83 {
84         int res = 0;
85         char tmp[256] = "";
86         int maxdigits = 255;
87         int tries = 1, to = 0, x = 0;
88         double tosec;
89         char *argcopy = NULL;
90         struct ind_tone_zone_sound *ts;
91         struct ast_flags flags = {0};
92
93          AST_DECLARE_APP_ARGS(arglist,
94                 AST_APP_ARG(variable);
95                 AST_APP_ARG(filename);
96                 AST_APP_ARG(maxdigits);
97                 AST_APP_ARG(options);
98                 AST_APP_ARG(attempts);
99                 AST_APP_ARG(timeout);
100         );
101         
102         if (ast_strlen_zero(data)) {
103                 ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
104                 return -1;
105         }
106         
107         argcopy = ast_strdupa(data);
108
109         AST_STANDARD_APP_ARGS(arglist, argcopy);
110
111         if (!ast_strlen_zero(arglist.options)) {
112                 ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
113         }
114         
115         if (!ast_strlen_zero(arglist.attempts)) {
116                 tries = atoi(arglist.attempts);
117                 if (tries <= 0)
118                         tries = 1;
119         }
120
121         if (!ast_strlen_zero(arglist.timeout)) {
122                 tosec = atof(arglist.timeout);
123                 if (tosec <= 0)
124                         to = 0;
125                 else {
126                         to = tosec * 1000.0;
127                         if (to <= 0) {
128                                 /* Make sure we don't use the default timeout. */
129                                 ast_log(LOG_WARNING, "Read timeout less than 1 ms, assuming 1 ms timeout\n");
130                                 to = 1;
131                         }
132                 }
133         }
134
135         if (ast_strlen_zero(arglist.filename)) {
136                 arglist.filename = NULL;
137         }
138         if (!ast_strlen_zero(arglist.maxdigits)) {
139                 maxdigits = atoi(arglist.maxdigits);
140                 if ((maxdigits<1) || (maxdigits>255)) {
141                         maxdigits = 255;
142                 } else
143                         ast_verb(3, "Accepting a maximum of %d digits.\n", maxdigits);
144         }
145         if (ast_strlen_zero(arglist.variable)) {
146                 ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[,filename][,maxdigits][,option][,attempts][,timeout])\n\n");
147                 return -1;
148         }
149         ts=NULL;
150         if (ast_test_flag(&flags,OPT_INDICATION)) {
151                 if (!ast_strlen_zero(arglist.filename)) {
152                         ts = ast_get_indication_tone(chan->zone,arglist.filename);
153                 }
154         }
155         if (chan->_state != AST_STATE_UP) {
156                 if (ast_test_flag(&flags,OPT_SKIP)) {
157                         /* At the user's option, skip if the line is not up */
158                         pbx_builtin_setvar_helper(chan, arglist.variable, "\0");
159                         return 0;
160                 } else if (!ast_test_flag(&flags,OPT_NOANSWER)) {
161                         /* Otherwise answer unless we're supposed to read while on-hook */
162                         res = ast_answer(chan);
163                 }
164         }
165         if (!res) {
166                 while (tries && !res) {
167                         ast_stopstream(chan);
168                         if (ts && ts->data[0]) {
169                                 if (!to)
170                                         to = chan->pbx ? chan->pbx->rtimeout * 1000 : 6000;
171                                 res = ast_playtones_start(chan, 0, ts->data, 0);
172                                 for (x = 0; x < maxdigits; ) {
173                                         res = ast_waitfordigit(chan, to);
174                                         ast_playtones_stop(chan);
175                                         if (res < 1) {
176                                                 tmp[x]='\0';
177                                                 break;
178                                         }
179                                         tmp[x++] = res;
180                                         if (tmp[x-1] == '#') {
181                                                 tmp[x-1] = '\0';
182                                                 break;
183                                         }
184                                 }
185                         } else {
186                                 res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
187                         }
188                         if (res > -1) {
189                                 pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
190                                 if (!ast_strlen_zero(tmp)) {
191                                         ast_verb(3, "User entered '%s'\n", tmp);
192                                         tries = 0;
193                                 } else {
194                                         tries--;
195                                                 if (tries)
196                                                 ast_verb(3, "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
197                                                 else
198                                                 ast_verb(3, "User entered nothing.\n");
199                                         }
200                                 res = 0;
201                         } else {
202                                 pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
203                                 ast_verb(3, "User disconnected\n");
204                         }
205                 }
206         }
207
208         return res;
209 }
210
211 static int unload_module(void)
212 {
213         return ast_unregister_application(app);
214 }
215
216 static int load_module(void)
217 {
218         return ast_register_application(app, read_exec, synopsis, descrip);
219 }
220
221 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");