2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2005, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Trivial application to read a variable
23 * \author Mark Spencer <markster@digium.com>
25 * \ingroup applications
30 ASTERISK_FILE_VERSION(__FILE__
, "$Revision$")
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"
50 OPT_INDICATION
= (1 << 1),
51 OPT_NOANSWER
= (1 << 2),
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
),
60 static char *app
= "Read";
62 static char *synopsis
= "Read a variable";
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";
85 #define ast_next_data(instr,ptr,delim) if((ptr=strchr(instr,delim))) { *(ptr) = '\0' ; ptr++;}
87 static int read_exec(struct ast_channel
*chan
, void *data
)
90 struct ast_module_user
*u
;
93 int tries
= 1, to
= 0, x
= 0;
95 struct tone_zone_sound
*ts
;
96 struct ast_flags flags
= {0};
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
);
107 if (ast_strlen_zero(data
)) {
108 ast_log(LOG_WARNING
, "Read requires an argument (variable)\n");
112 u
= ast_module_user_add(chan
);
114 argcopy
= ast_strdupa(data
);
116 AST_STANDARD_APP_ARGS(arglist
, argcopy
);
118 if (!ast_strlen_zero(arglist
.options
)) {
119 ast_app_parse_options(read_app_options
, &flags
, NULL
, arglist
.options
);
122 if (!ast_strlen_zero(arglist
.attempts
)) {
123 tries
= atoi(arglist
.attempts
);
128 if (!ast_strlen_zero(arglist
.timeout
)) {
129 to
= atoi(arglist
.timeout
);
136 if (ast_strlen_zero(arglist
.filename
)) {
137 arglist
.filename
= NULL
;
139 if (!ast_strlen_zero(arglist
.maxdigits
)) {
140 maxdigits
= atoi(arglist
.maxdigits
);
141 if ((maxdigits
<1) || (maxdigits
>255)) {
143 } else if (option_verbose
> 2)
144 ast_verbose(VERBOSE_PREFIX_3
"Accepting a maximum of %d digits.\n", maxdigits
);
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
);
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
);
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
);
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
);
169 while (tries
&& !res
) {
170 ast_stopstream(chan
);
171 if (ts
&& ts
->data
[0]) {
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
);
183 if (tmp
[x
-1] == '#') {
189 res
= ast_app_getdata(chan
, arglist
.filename
, tmp
, maxdigits
, to
);
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
);
199 if (option_verbose
> 2) {
201 ast_verbose(VERBOSE_PREFIX_3
"User entered nothing, %d chance%s left\n", tries
, (tries
!= 1) ? "s" : "");
203 ast_verbose(VERBOSE_PREFIX_3
"User entered nothing.\n");
208 pbx_builtin_setvar_helper(chan
, arglist
.variable
, tmp
);
209 if (option_verbose
> 2)
210 ast_verbose(VERBOSE_PREFIX_3
"User disconnected\n");
214 ast_module_user_remove(u
);
218 static int unload_module(void)
222 res
= ast_unregister_application(app
);
224 ast_module_user_hangup_all();
229 static int load_module(void)
231 return ast_register_application(app
, read_exec
, synopsis
, descrip
);
234 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY
, "Read Variable Application");