Wed Jan 8 2020 09:49:40

Asterisk developer's documentation


app_readexten.c
Go to the documentation of this file.
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 /*** MODULEINFO
28  <support_level>core</support_level>
29  ***/
30 
31 #include "asterisk.h"
32 
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 411313 $")
34 
35 #include "asterisk/file.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/app.h"
38 #include "asterisk/module.h"
39 #include "asterisk/indications.h"
40 #include "asterisk/channel.h"
41 
42 /*** DOCUMENTATION
43  <application name="ReadExten" language="en_US">
44  <synopsis>
45  Read an extension into a variable.
46  </synopsis>
47  <syntax>
48  <parameter name="variable" required="true" />
49  <parameter name="filename">
50  <para>File to play before reading digits or tone with option <literal>i</literal></para>
51  </parameter>
52  <parameter name="context">
53  <para>Context in which to match extensions.</para>
54  </parameter>
55  <parameter name="option">
56  <optionlist>
57  <option name="s">
58  <para>Return immediately if the channel is not answered.</para>
59  </option>
60  <option name="i">
61  <para>Play <replaceable>filename</replaceable> as an indication tone from your
62  <filename>indications.conf</filename> or a directly specified list of
63  frequencies and durations.</para>
64  </option>
65  <option name="n">
66  <para>Read digits even if the channel is not answered.</para>
67  </option>
68  </optionlist>
69  </parameter>
70  <parameter name="timeout">
71  <para>An integer number of seconds to wait for a digit response. If
72  greater than <literal>0</literal>, that value will override the default timeout.</para>
73  </parameter>
74  </syntax>
75  <description>
76  <para>Reads a <literal>#</literal> terminated string of digits from the user into the given variable.</para>
77  <para>Will set READEXTENSTATUS on exit with one of the following statuses:</para>
78  <variablelist>
79  <variable name="READEXTENSTATUS">
80  <value name="OK">
81  A valid extension exists in ${variable}.
82  </value>
83  <value name="TIMEOUT">
84  No extension was entered in the specified time. Also sets ${variable} to "t".
85  </value>
86  <value name="INVALID">
87  An invalid extension, ${INVALID_EXTEN}, was entered. Also sets ${variable} to "i".
88  </value>
89  <value name="SKIP">
90  Line was not up and the option 's' was specified.
91  </value>
92  <value name="ERROR">
93  Invalid arguments were passed.
94  </value>
95  </variable>
96  </variablelist>
97  </description>
98  </application>
99  <function name="VALID_EXTEN" language="en_US">
100  <synopsis>
101  Determine whether an extension exists or not.
102  </synopsis>
103  <syntax>
104  <parameter name="context">
105  <para>Defaults to the current context</para>
106  </parameter>
107  <parameter name="extension" required="true" />
108  <parameter name="priority">
109  <para>Priority defaults to <literal>1</literal>.</para>
110  </parameter>
111  </syntax>
112  <description>
113  <para>Returns a true value if the indicated <replaceable>context</replaceable>,
114  <replaceable>extension</replaceable>, and <replaceable>priority</replaceable> exist.</para>
115  </description>
116  </function>
117  ***/
118 
120  OPT_SKIP = (1 << 0),
121  OPT_INDICATION = (1 << 1),
122  OPT_NOANSWER = (1 << 2),
123 };
124 
126  AST_APP_OPTION('s', OPT_SKIP),
129 });
130 
131 static char *app = "ReadExten";
132 
133 static int readexten_exec(struct ast_channel *chan, const char *data)
134 {
135  int res = 0;
136  char exten[256] = "";
137  int maxdigits = sizeof(exten) - 1;
138  int timeout = 0, digit_timeout = 0, x = 0;
139  char *argcopy = NULL, *status = "";
140  struct ast_tone_zone_sound *ts = NULL;
141  struct ast_flags flags = {0};
142 
143  AST_DECLARE_APP_ARGS(arglist,
144  AST_APP_ARG(variable);
145  AST_APP_ARG(filename);
147  AST_APP_ARG(options);
148  AST_APP_ARG(timeout);
149  );
150 
151  if (ast_strlen_zero(data)) {
152  ast_log(LOG_WARNING, "ReadExten requires at least one argument\n");
153  pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
154  return 0;
155  }
156 
157  argcopy = ast_strdupa(data);
158  AST_STANDARD_APP_ARGS(arglist, argcopy);
159 
160  if (ast_strlen_zero(arglist.variable)) {
161  ast_log(LOG_WARNING, "Usage: ReadExten(variable[,filename[,context[,options[,timeout]]]])\n");
162  pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", "ERROR");
163  return 0;
164  }
165 
166  if (ast_strlen_zero(arglist.filename))
167  arglist.filename = NULL;
168 
169  if (ast_strlen_zero(arglist.context))
170  arglist.context = chan->context;
171 
172  if (!ast_strlen_zero(arglist.options))
173  ast_app_parse_options(readexten_app_options, &flags, NULL, arglist.options);
174 
175  if (!ast_strlen_zero(arglist.timeout)) {
176  timeout = atoi(arglist.timeout);
177  if (timeout > 0)
178  timeout *= 1000;
179  }
180 
181  if (timeout <= 0)
182  timeout = chan->pbx ? chan->pbx->rtimeoutms : 10000;
183 
184  if (digit_timeout <= 0)
185  digit_timeout = chan->pbx ? chan->pbx->dtimeoutms : 5000;
186 
187  if (ast_test_flag(&flags, OPT_INDICATION) && !ast_strlen_zero(arglist.filename)) {
188  ts = ast_get_indication_tone(chan->zone, arglist.filename);
189  }
190 
191  do {
192  if (chan->_state != AST_STATE_UP) {
193  if (ast_test_flag(&flags, OPT_SKIP)) {
194  /* At the user's option, skip if the line is not up */
195  pbx_builtin_setvar_helper(chan, arglist.variable, "");
196  status = "SKIP";
197  break;
198  } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
199  /* Otherwise answer unless we're supposed to read while on-hook */
200  res = ast_answer(chan);
201  }
202  }
203 
204  if (res < 0) {
205  status = "HANGUP";
206  break;
207  }
208 
209  ast_playtones_stop(chan);
210  ast_stopstream(chan);
211 
212  if (ts && ts->data[0]) {
213  res = ast_playtones_start(chan, 0, ts->data, 0);
214  } else if (arglist.filename) {
215  if (ast_test_flag(&flags, OPT_INDICATION) && ast_fileexists(arglist.filename, NULL, chan->language) <= 0) {
216  /*
217  * We were asked to play an indication that did not exist in the config.
218  * If no such file exists, play it as a tonelist. With any luck they won't
219  * have a file named "350+440.ulaw"
220  * (but honestly, who would do something so silly?)
221  */
222  res = ast_playtones_start(chan, 0, arglist.filename, 0);
223  } else {
224  res = ast_streamfile(chan, arglist.filename, chan->language);
225  }
226  }
227 
228  for (x = 0; x < maxdigits; x++) {
229  ast_debug(3, "extension so far: '%s', timeout: %d\n", exten, timeout);
230  res = ast_waitfordigit(chan, timeout);
231 
232  ast_playtones_stop(chan);
233  ast_stopstream(chan);
234  timeout = digit_timeout;
235 
236  if (res < 1) { /* timeout expired or hangup */
237  if (ast_check_hangup(chan)) {
238  status = "HANGUP";
239  } else if (x == 0) {
240  pbx_builtin_setvar_helper(chan, arglist.variable, "t");
241  status = "TIMEOUT";
242  }
243  break;
244  }
245 
246  exten[x] = res;
247  if (!ast_matchmore_extension(chan, arglist.context, exten, 1 /* priority */,
248  S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
249  if (!ast_exists_extension(chan, arglist.context, exten, 1,
250  S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))
251  && res == '#') {
252  exten[x] = '\0';
253  }
254  break;
255  }
256  }
257 
258  if (!ast_strlen_zero(status))
259  break;
260 
261  if (ast_exists_extension(chan, arglist.context, exten, 1,
262  S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
263  ast_debug(3, "User entered valid extension '%s'\n", exten);
264  pbx_builtin_setvar_helper(chan, arglist.variable, exten);
265  status = "OK";
266  } else {
267  ast_debug(3, "User dialed invalid extension '%s' in context '%s' on %s\n", exten, arglist.context, chan->name);
268  pbx_builtin_setvar_helper(chan, arglist.variable, "i");
269  pbx_builtin_setvar_helper(chan, "INVALID_EXTEN", exten);
270  status = "INVALID";
271  }
272  } while (0);
273 
274  if (ts) {
275  ts = ast_tone_zone_sound_unref(ts);
276  }
277 
278  pbx_builtin_setvar_helper(chan, "READEXTENSTATUS", status);
279 
280  return status[0] == 'H' ? -1 : 0;
281 }
282 
283 static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
284 {
285  int priority_int;
289  AST_APP_ARG(priority);
290  );
291 
292  if (!chan) {
293  ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
294  return -1;
295  }
296 
297  AST_STANDARD_APP_ARGS(args, parse);
298 
299  if (ast_strlen_zero(args.context))
300  args.context = chan->context;
301 
302  if (ast_strlen_zero(args.extension)) {
303  ast_log(LOG_WARNING, "Syntax: VALID_EXTEN([<context>],<extension>[,<priority>]) - missing argument <extension>!\n");
304  return -1;
305  }
306 
307  if (ast_strlen_zero(args.priority))
308  priority_int = 1;
309  else
310  priority_int = atoi(args.priority);
311 
312  if (ast_exists_extension(chan, args.context, args.extension, priority_int,
313  S_COR(chan->caller.id.number.valid, chan->caller.id.number.str, NULL))) {
314  ast_copy_string(buffer, "1", buflen);
315  } else {
316  ast_copy_string(buffer, "0", buflen);
317  }
318 
319  return 0;
320 }
321 
323  .name = "VALID_EXTEN",
324  .read = acf_isexten_exec,
325 };
326 
327 static int unload_module(void)
328 {
329  int res = ast_unregister_application(app);
330  res |= ast_custom_function_unregister(&acf_isexten);
331 
332  return res;
333 }
334 
335 static int load_module(void)
336 {
338  res |= ast_custom_function_register(&acf_isexten);
339  return res;
340 }
341 
342 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read and evaluate extension validity");
Tone Indication Support.
int ast_matchmore_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
Looks to see if adding anything to this extension might match something. (exists ^ canmatch) ...
Definition: pbx.c:5420
static char exten[AST_MAX_EXTENSION]
Definition: chan_alsa.c:109
Main Channel structure associated with a channel.
Definition: channel.h:742
char * str
Subscriber phone number (Malloced)
Definition: channel.h:241
#define AST_MODULE_INFO_STANDARD(keystr, desc)
Definition: module.h:396
int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang)
Streams a file.
Definition: file.c:946
Asterisk main include file. File version handling, generic pbx functions.
#define AST_APP_OPTIONS(holder, options...)
Declares an array of options for an application.
Definition: app.h:712
struct ast_party_caller caller
Channel Caller ID information.
Definition: channel.h:804
struct ast_tone_zone * zone
Definition: channel.h:767
#define ast_test_flag(p, flag)
Definition: utils.h:63
char context[AST_MAX_CONTEXT]
Definition: channel.h:868
#define LOG_WARNING
Definition: logger.h:144
int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
Parses a string containing application options and sets flags/arguments.
Definition: app.c:2101
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application&#39;s arguments.
Definition: app.h:572
static int acf_isexten_exec(struct ast_channel *chan, const char *cmd, char *parse, char *buffer, size_t buflen)
void ast_playtones_stop(struct ast_channel *chan)
Stop playing tones on a channel.
Definition: indications.c:411
int ast_unregister_application(const char *app)
Unregister an application.
Definition: pbx.c:7705
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx.c:3814
readexten_option_flags
static int load_module(void)
struct ast_party_id id
Caller party ID.
Definition: channel.h:370
static int unload_module(void)
static int readexten_exec(struct ast_channel *chan, const char *data)
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:236
General Asterisk PBX channel definitions.
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
Data structure associated with a custom dialplan function.
Definition: pbx.h:95
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition: strings.h:83
static struct ast_tone_zone_sound * ast_tone_zone_sound_unref(struct ast_tone_zone_sound *ts)
Release a reference to an ast_tone_zone_sound.
Definition: indications.h:226
int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, int priority, const char *callerid)
Determine whether an extension exists.
Definition: pbx.c:5400
Core PBX routines and definitions.
int ast_check_hangup(struct ast_channel *chan)
Check to see if a channel is needing hang up.
Definition: channel.c:806
static struct ast_app_option readexten_app_options[128]
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: utils.h:663
static struct @350 args
enum ast_channel_state _state
Definition: channel.h:839
Description of a tone.
Definition: indications.h:36
struct ast_tone_zone_sound * ast_get_indication_tone(const struct ast_tone_zone *zone, const char *indication)
Locate a tone zone sound.
Definition: indications.c:473
const ast_string_field name
Definition: channel.h:787
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
static void parse(struct mgcp_request *req)
Definition: chan_mgcp.c:1858
static char * app
Structure used to handle boolean flags.
Definition: utils.h:200
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...
Definition: pbx.c:10546
int ast_waitfordigit(struct ast_channel *c, int ms)
Waits for a digit.
Definition: channel.c:3552
static struct ast_custom_function acf_isexten
int dtimeoutms
Definition: pbx.h:180
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:223
int ast_fileexists(const char *filename, const char *fmt, const char *preflang)
Checks for the existence of a given file.
Definition: file.c:919
int ast_answer(struct ast_channel *chan)
Answer a channel.
Definition: channel.c:3086
Application convenience functions, designed to give consistent look and feel to Asterisk apps...
int ast_playtones_start(struct ast_channel *chan, int vol, const char *tonelist, int interruptible)
Start playing a list of tones on a channel.
Definition: indications.c:319
const char * name
Definition: pbx.h:96
const char * data
Description of a tone.
Definition: indications.h:53
#define AST_APP_ARG(name)
Define an application argument.
Definition: app.h:555
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the &#39;standard&#39; argument separation process for an application.
Definition: app.h:604
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:107
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition: module.h:38
Asterisk module definitions.
unsigned char valid
TRUE if the number information is valid/present.
Definition: channel.h:247
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1164
const ast_string_field language
Definition: channel.h:787
int ast_stopstream(struct ast_channel *c)
Stops a stream.
Definition: file.c:128
#define ast_register_application_xml(app, execute)
Register an application using XML documentation.
Definition: module.h:437
jack_status_t status
Definition: app_jack.c:143
#define ASTERISK_FILE_VERSION(file, version)
Register/unregister a source code file with the core.
Definition: asterisk.h:180
#define AST_APP_OPTION(option, flagno)
Declares an application option that does not accept an argument.
Definition: app.h:721
struct ast_pbx * pbx
Definition: channel.h:761
int rtimeoutms
Definition: pbx.h:181
struct ast_party_number number
Subscriber phone number.
Definition: channel.h:292