Merged revisions 281723 via svnmerge from
[asterisk/asterisk.git] / apps / app_readexten.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2007-2008, Trinity College Computing Center
5  * Written by David Chappell <David.Chappell@trincoll.edu>
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  *
20  * \brief Trivial application to read an extension into a variable
21  *
22  * \author David Chappell <David.Chappell@trincoll.edu>
23  * 
24  * \ingroup applications
25  */
26  
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/file.h"
32 #include "asterisk/pbx.h"
33 #include "asterisk/app.h"
34 #include "asterisk/module.h"
35 #include "asterisk/indications.h"
36 #include "asterisk/channel.h"
37
38 /*** DOCUMENTATION
39         <application name="ReadExten" language="en_US">
40                 <synopsis>
41                         Read an extension into a variable.
42                 </synopsis>
43                 <syntax>
44                         <parameter name="variable" required="true" />
45                         <parameter name="filename">
46                                 <para>File to play before reading digits or tone with option <literal>i</literal></para>
47                         </parameter>
48                         <parameter name="context">
49                                 <para>Context in which to match extensions.</para>
50                         </parameter>
51                         <parameter name="option">
52                                 <optionlist>
53                                         <option name="s">
54                                                 <para>Return immediately if the channel is not answered.</para>
55                                         </option>
56                                         <option name="i">
57                                                 <para>Play <replaceable>filename</replaceable> as an indication tone from your
58                                                 <filename>indications.conf</filename> or a directly specified list of
59                                                 frequencies and durations.</para>
60                                         </option>
61                                         <option name="n">
62                                                 <para>Read digits even if the channel is not answered.</para>
63                                         </option>
64                                 </optionlist>
65                         </parameter>
66                         <parameter name="timeout">
67                                 <para>An integer number of seconds to wait for a digit response. If
68                                 greater than <literal>0</literal>, that value will override the default timeout.</para>
69                         </parameter>
70                 </syntax>
71                 <description>
72                         <para>Reads a <literal>#</literal> terminated string of digits from the user into the given variable.</para>
73                         <para>Will set READEXTENSTATUS on exit with one of the following statuses:</para>
74                         <variablelist>
75                                 <variable name="READEXTENSTATUS">
76                                         <value name="OK">
77                                                 A valid extension exists in ${variable}.
78                                         </value>
79                                         <value name="TIMEOUT">
80                                                 No extension was entered in the specified time.  Also sets ${variable} to "t".
81                                         </value>
82                                         <value name="INVALID">
83                                                 An invalid extension, ${INVALID_EXTEN}, was entered.  Also sets ${variable} to "i".
84                                         </value>
85                                         <value name="SKIP">
86                                                 Line was not up and the option 's' was specified.
87                                         </value>
88                                         <value name="ERROR">
89                                                 Invalid arguments were passed.
90                                         </value>
91                                 </variable>
92                         </variablelist>
93                 </description>
94         </application>
95         <function name="VALID_EXTEN" language="en_US">
96                 <synopsis>
97                         Determine whether an extension exists or not.
98                 </synopsis>
99                 <syntax>
100                         <parameter name="context">
101                                 <para>Defaults to the current context</para>
102                         </parameter>
103                         <parameter name="extension" required="true" />
104                         <parameter name="priority">
105                                 <para>Priority defaults to <literal>1</literal>.</para>
106                         </parameter>
107                 </syntax>
108                 <description>
109                         <para>Returns a true value if the indicated <replaceable>context</replaceable>,
110                         <replaceable>extension</replaceable>, and <replaceable>priority</replaceable> exist.</para>
111                 </description>
112         </function>
113  ***/
114
115 enum readexten_option_flags {
116         OPT_SKIP = (1 << 0),
117         OPT_INDICATION = (1 << 1),
118         OPT_NOANSWER = (1 << 2),
119 };
120
121 AST_APP_OPTIONS(readexten_app_options, {
122         AST_APP_OPTION('s', OPT_SKIP),
123         AST_APP_OPTION('i', OPT_INDICATION),
124         AST_APP_OPTION('n', OPT_NOANSWER),
125 });
126
127 static char *app = "ReadExten";
128
129 static int readexten_exec(struct ast_channel *chan, const char *data)
130 {
131         int res = 0;
132         char exten[256] = "";
133         int maxdigits = sizeof(exten) - 1;
134         int timeout = 0, digit_timeout = 0, x = 0;
135         char *argcopy = NULL, *status = "";
136         struct ast_tone_zone_sound *ts = NULL;
137         struct ast_flags flags = {0};
138
139          AST_DECLARE_APP_ARGS(arglist,
140                 AST_APP_ARG(variable);
141                 AST_APP_ARG(filename);
142                 AST_APP_ARG(context);
143                 AST_APP_ARG(options);
144                 AST_APP_ARG(timeout);
145         );
146         
147         if (ast_strlen_zero(data)) {
148                 ast_log(LOG_WARNING, "ReadExten requires at least one argument\n");
149                 pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
150                 return 0;
151         }
152
153         argcopy = ast_strdupa(data);
154         AST_STANDARD_APP_ARGS(arglist, argcopy);
155
156         if (ast_strlen_zero(arglist.variable)) {
157                 ast_log(LOG_WARNING, "Usage: ReadExten(variable[,filename[,context[,options[,timeout]]]])\n");
158                 pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
159                 return 0;
160         }
161
162         if (ast_strlen_zero(arglist.filename))
163                 arglist.filename = NULL;
164
165         if (ast_strlen_zero(arglist.context))
166                 arglist.context = chan->context;
167
168         if (!ast_strlen_zero(arglist.options))
169                 ast_app_parse_options(readexten_app_options, &flags, NULL, arglist.options);
170
171         if (!ast_strlen_zero(arglist.timeout)) {
172                 timeout = atoi(arglist.timeout);
173                 if (timeout > 0)
174                         timeout *= 1000;
175         }
176
177         if (timeout <= 0)
178                 timeout = chan->pbx ? chan->pbx->rtimeoutms : 10000;
179
180         if (digit_timeout <= 0)
181                 digit_timeout = chan->pbx ? chan->pbx->dtimeoutms : 5000;
182
183         if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename)) {
184                 ts = ast_get_indication_tone(chan->zone, arglist.filename);
185         }
186
187         do {
188                 if (chan->_state != AST_STATE_UP) {
189                         if (ast_test_flag(&flags, OPT_SKIP)) {
190                                 /* At the user's option, skip if the line is not up */
191                                 pbx_builtin_setvar_helper(chan, arglist.variable, "");
192                                 status = "SKIP";
193                                 break;
194                         } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
195                                 /* Otherwise answer unless we're supposed to read while on-hook */
196                                 res = ast_answer(chan);
197                         }
198                 }
199
200                 if (res < 0) {
201                         status = "HANGUP";
202                         break;
203                 }
204
205                 ast_playtones_stop(chan);
206                 ast_stopstream(chan);
207
208                 if (ts && ts->data[0]) {
209                         res = ast_playtones_start(chan, 0, ts->data, 0);
210                 } else if (arglist.filename) {
211                         if (ast_test_flag(&flags, OPT_INDICATION) && ast_fileexists(arglist.filename, NULL, chan->language) <= 0) {
212                                 /*
213                                  * We were asked to play an indication that did not exist in the config.
214                                  * If no such file exists, play it as a tonelist.  With any luck they won't
215                                  * have a file named "350+440.ulaw"
216                                  * (but honestly, who would do something so silly?)
217                                  */
218                                 res = ast_playtones_start(chan, 0, arglist.filename, 0);
219                         } else {
220                                 res = ast_streamfile(chan, arglist.filename, chan->language);
221                         }
222                 }
223
224                 for (x = 0; x < maxdigits; x++) {
225                         ast_debug(3, "extension so far: '%s', timeout: %d\n", exten, timeout);
226                         res = ast_waitfordigit(chan, timeout);
227
228                         ast_playtones_stop(chan);
229                         ast_stopstream(chan);
230                         timeout = digit_timeout;
231
232                         if (res < 1) {          /* timeout expired or hangup */
233                                 if (ast_check_hangup(chan)) {
234                                         status = "HANGUP";
235                                 } else if (x == 0) {
236                                         pbx_builtin_setvar_helper(chan, arglist.variable, "t");
237                                         status = "TIMEOUT";
238                                 }
239                                 break;
240                         }
241
242                         exten[x] = res;
243                         if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */,
244                                 S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
245                                 if (!ast_exists_extension(chan, arglist.context, exten, 1,
246                                         S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))
247                                         && res == '#') {
248                                         exten[x] = '\0';
249                                 }
250                                 break;
251                         }
252                 }
253
254                 if (!ast_strlen_zero(status))
255                         break;
256
257                 if (ast_exists_extension(chan, arglist.context, exten, 1,
258                         S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
259                         ast_debug(3, "User entered valid extension '%s'\n", exten);
260                         pbx_builtin_setvar_helper(chan, arglist.variable, exten);
261                         status = "OK";
262                 } else {
263                         ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, chan->name);
264                         pbx_builtin_setvar_helper(chan, arglist.variable, "i");
265                         pbx_builtin_setvar_helper(chan, "INVALID_EXTEN", exten);
266                         status = "INVALID";
267                 }
268         } while (0);
269
270         if (ts) {
271                 ts = ast_tone_zone_sound_unref(ts);
272         }
273
274         pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
275
276         return status[0] == 'H' ? -1 : 0;
277 }
278
279 static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
280 {
281         int priority_int;
282         AST_DECLARE_APP_ARGS(args,
283                 AST_APP_ARG(context);
284                 AST_APP_ARG(extension);
285                 AST_APP_ARG(priority);
286         );
287
288         AST_STANDARD_APP_ARGS(args, parse);
289
290         if (ast_strlen_zero(args.context))
291                 args.context = chan->context;
292
293         if (ast_strlen_zero(args.extension)) {
294                 ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
295                 return -1;
296         }
297
298         if (ast_strlen_zero(args.priority))
299                 priority_int = 1;
300         else
301                 priority_int = atoi(args.priority);
302
303         if (ast_exists_extension(chan, args.context, args.extension, priority_int,
304                 S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
305             ast_copy_string(buffer, "1", buflen);
306         } else {
307             ast_copy_string(buffer, "0", buflen);
308         }
309
310         return 0;
311 }
312
313 static struct ast_custom_function acf_isexten = {
314         .name = "VALID_EXTEN",
315         .read = acf_isexten_exec,
316 };
317
318 static int unload_module(void)
319 {
320         int res = ast_unregister_application(app);
321         res |= ast_custom_function_unregister(&acf_isexten);
322
323         return res;     
324 }
325
326 static int load_module(void)
327 {
328         int res = ast_register_application_xml(app, readexten_exec);
329         res |= ast_custom_function_register(&acf_isexten);
330         return res;
331 }
332
333 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read and evaluate extension validity");