aboutsummaryrefslogtreecommitdiffstats
path: root/trunk/apps/app_read.c
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/apps/app_read.c')
-rw-r--r--trunk/apps/app_read.c231
1 files changed, 0 insertions, 231 deletions
diff --git a/trunk/apps/app_read.c b/trunk/apps/app_read.c
deleted file mode 100644
index a7fdf624b..000000000
--- a/trunk/apps/app_read.c
+++ /dev/null
@@ -1,231 +0,0 @@
-/*
- * Asterisk -- An open source telephony toolkit.
- *
- * Copyright (C) 1999 - 2005, Digium, Inc.
- *
- * Mark Spencer <markster@digium.com>
- *
- * See http://www.asterisk.org for more information about
- * the Asterisk project. Please do not directly contact
- * any of the maintainers of this project for assistance;
- * the project provides a web site, mailing lists and IRC
- * channels for your use.
- *
- * This program is free software, distributed under the terms of
- * the GNU General Public License Version 2. See the LICENSE file
- * at the top of the source tree.
- */
-
-/*! \file
- *
- * \brief Trivial application to read a variable
- *
- * \author Mark Spencer <markster@digium.com>
- *
- * \ingroup applications
- */
-
-#include "asterisk.h"
-
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
-#include "asterisk/file.h"
-#include "asterisk/pbx.h"
-#include "asterisk/channel.h"
-#include "asterisk/app.h"
-#include "asterisk/module.h"
-#include "asterisk/indications.h"
-
-enum {
- OPT_SKIP = (1 << 0),
- OPT_INDICATION = (1 << 1),
- OPT_NOANSWER = (1 << 2),
-} read_option_flags;
-
-AST_APP_OPTIONS(read_app_options, {
- AST_APP_OPTION('s', OPT_SKIP),
- AST_APP_OPTION('i', OPT_INDICATION),
- AST_APP_OPTION('n', OPT_NOANSWER),
-});
-
-static char *app = "Read";
-
-static char *synopsis = "Read a variable";
-
-static char *descrip =
-" Read(variable[,filename[&filename2...]][,maxdigits][,option][,attempts][,timeout])\n\n"
-"Reads a #-terminated string of digits a certain number of times from the\n"
-"user in to the given variable.\n"
-" filename -- file(s) to play before reading digits or tone with option i\n"
-" maxdigits -- maximum acceptable number of digits. Stops reading after\n"
-" maxdigits have been entered (without requiring the user to\n"
-" press the '#' key).\n"
-" Defaults to 0 - no limit - wait for the user press the '#' key.\n"
-" Any value below 0 means the same. Max accepted value is 255.\n"
-" option -- options are 's' , 'i', 'n'\n"
-" 's' to return immediately if the line is not up,\n"
-" 'i' to play filename as an indication tone from your indications.conf\n"
-" 'n' to read digits even if the line is not up.\n"
-" attempts -- if greater than 1, that many attempts will be made in the \n"
-" event no data is entered.\n"
-" timeout -- The number of seconds to wait for a digit response. If greater\n"
-" than 0, that value will override the default timeout. Can be floating point.\n"
-"This application sets the following channel variable upon completion:\n"
-" READSTATUS - This is the status of the read operation.\n"
-" Possible values are:\n"
-" OK | ERROR | HANGUP | INTERRUPTED | SKIPPED | TIMEOUT\n";
-
-
-#define ast_next_data(instr,ptr,delim) if((ptr=strchr(instr,delim))) { *(ptr) = '\0' ; ptr++;}
-
-static int read_exec(struct ast_channel *chan, void *data)
-{
- int res = 0;
- char tmp[256] = "";
- int maxdigits = 255;
- int tries = 1, to = 0, x = 0;
- double tosec;
- char *argcopy = NULL;
- struct ind_tone_zone_sound *ts = NULL;
- struct ast_flags flags = {0};
- const char *status = "ERROR";
-
- AST_DECLARE_APP_ARGS(arglist,
- AST_APP_ARG(variable);
- AST_APP_ARG(filename);
- AST_APP_ARG(maxdigits);
- AST_APP_ARG(options);
- AST_APP_ARG(attempts);
- AST_APP_ARG(timeout);
- );
-
- pbx_builtin_setvar_helper(chan, "READSTATUS", status);
- if (ast_strlen_zero(data)) {
- ast_log(LOG_WARNING, "Read requires an argument (variable)\n");
- return 0;
- }
-
- argcopy = ast_strdupa(data);
-
- AST_STANDARD_APP_ARGS(arglist, argcopy);
-
- if (!ast_strlen_zero(arglist.options)) {
- ast_app_parse_options(read_app_options, &flags, NULL, arglist.options);
- }
-
- if (!ast_strlen_zero(arglist.attempts)) {
- tries = atoi(arglist.attempts);
- if (tries <= 0)
- tries = 1;
- }
-
- if (!ast_strlen_zero(arglist.timeout)) {
- tosec = atof(arglist.timeout);
- if (tosec <= 0)
- to = 0;
- else
- to = tosec * 1000.0;
- }
-
- if (ast_strlen_zero(arglist.filename)) {
- arglist.filename = NULL;
- }
- if (!ast_strlen_zero(arglist.maxdigits)) {
- maxdigits = atoi(arglist.maxdigits);
- if ((maxdigits < 1) || (maxdigits > 255)) {
- maxdigits = 255;
- } else
- ast_verb(3, "Accepting a maximum of %d digits.\n", maxdigits);
- }
- if (ast_strlen_zero(arglist.variable)) {
- ast_log(LOG_WARNING, "Invalid! Usage: Read(variable[,filename][,maxdigits][,option][,attempts][,timeout])\n\n");
- return 0;
- }
- if (ast_test_flag(&flags, OPT_INDICATION)) {
- if (! ast_strlen_zero(arglist.filename)) {
- ts = ast_get_indication_tone(chan->zone, arglist.filename);
- }
- }
- if (chan->_state != AST_STATE_UP) {
- if (ast_test_flag(&flags, OPT_SKIP)) {
- /* At the user's option, skip if the line is not up */
- pbx_builtin_setvar_helper(chan, arglist.variable, "");
- pbx_builtin_setvar_helper(chan, "READSTATUS", "SKIPPED");
- return 0;
- } else if (!ast_test_flag(&flags, OPT_NOANSWER)) {
- /* Otherwise answer unless we're supposed to read while on-hook */
- res = ast_answer(chan);
- }
- }
- if (!res) {
- while (tries && !res) {
- ast_stopstream(chan);
- if (ts && ts->data[0]) {
- if (!to)
- to = chan->pbx ? chan->pbx->rtimeout * 1000 : 6000;
- res = ast_playtones_start(chan, 0, ts->data, 0);
- for (x = 0; x < maxdigits; ) {
- res = ast_waitfordigit(chan, to);
- ast_playtones_stop(chan);
- if (res < 1) {
- if (res == 0)
- status = "TIMEOUT";
- tmp[x]='\0';
- break;
- }
- tmp[x++] = res;
- if (tmp[x-1] == '#') {
- tmp[x-1] = '\0';
- status = "OK";
- break;
- }
- if (x >= maxdigits) {
- status = "OK";
- }
- }
- } else {
- res = ast_app_getdata(chan, arglist.filename, tmp, maxdigits, to);
- if (res == 0)
- status = "OK";
- else if (res == 1)
- status = "TIMEOUT";
- else if (res == 2)
- status = "INTERRUPTED";
- }
- if (res > -1) {
- pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
- if (!ast_strlen_zero(tmp)) {
- ast_verb(3, "User entered '%s'\n", tmp);
- tries = 0;
- } else {
- tries--;
- if (tries)
- ast_verb(3, "User entered nothing, %d chance%s left\n", tries, (tries != 1) ? "s" : "");
- else
- ast_verb(3, "User entered nothing.\n");
- }
- res = 0;
- } else {
- pbx_builtin_setvar_helper(chan, arglist.variable, tmp);
- ast_verb(3, "User disconnected\n");
- }
- }
- }
-
- if (ast_check_hangup(chan))
- status = "HANGUP";
- pbx_builtin_setvar_helper(chan, "READSTATUS", status);
- return 0;
-}
-
-static int unload_module(void)
-{
- return ast_unregister_application(app);
-}
-
-static int load_module(void)
-{
- return ast_register_application(app, read_exec, synopsis, descrip);
-}
-
-AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read Variable Application");
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-23 11:23:45 +0000