app_read.c File Reference

Trivial application to read a variable. More...

#include "asterisk.h"
#include "asterisk/file.h"
#include "asterisk/pbx.h"
#include "asterisk/channel.h"
#include "asterisk/app.h"
#include "asterisk/module.h"
#include "asterisk/indications.h"

Include dependency graph for app_read.c:

Go to the source code of this file.

Enumerations
enum	{ OPT_ARG_TERMINATOR , OPT_ARG_ARRAY_SIZE }
enum	read_option_flags {   OPT_SKIP = (1 << 0) , OPT_INDICATION = (1 << 1) , OPT_NOANSWER = (1 << 2) , OPT_TERMINATOR = (1 << 3) ,   OPT_KEEP_TERMINATOR = (1 << 4) }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	read_exec (struct ast_channel *chan, const char *data)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Read Variable Application" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static char *	app = "Read"
static const struct ast_module_info *	ast_module_info = &__mod_info
static const struct ast_app_option	read_app_options [128] = { [ 's' ] = { .flag = OPT_SKIP }, [ 'i' ] = { .flag = OPT_INDICATION }, [ 'n' ] = { .flag = OPT_NOANSWER }, [ 't' ] = { .flag = OPT_TERMINATOR , .arg_index = OPT_ARG_TERMINATOR + 1 }, [ 'e' ] = { .flag = OPT_KEEP_TERMINATOR }, }

Detailed Description

Trivial application to read a variable.

Author

Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file app_read.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
OPT_ARG_TERMINATOR
OPT_ARG_ARRAY_SIZE

Definition at line 147 of file app_read.c.

     {
    OPT_ARG_TERMINATOR,
    /* note: this entry _MUST_ be the last one in the enum */
    OPT_ARG_ARRAY_SIZE,
};

read_option_flags

enum read_option_flags

Enumerator
OPT_SKIP
OPT_INDICATION
OPT_NOANSWER
OPT_TERMINATOR
OPT_KEEP_TERMINATOR

Definition at line 139 of file app_read.c.

                       {
    OPT_SKIP = (1 << 0),
    OPT_INDICATION = (1 << 1),
    OPT_NOANSWER = (1 << 2),
    OPT_TERMINATOR = (1 << 3),
    OPT_KEEP_TERMINATOR = (1 << 4),
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 337 of file app_read.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 337 of file app_read.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 337 of file app_read.c.

load_module()

static int load_module ( void  )

static

Definition at line 332 of file app_read.c.

{
    return ast_register_application_xml(app, read_exec);
}

References app, ast_register_application_xml, and read_exec().

read_exec()

static int read_exec ( struct ast_channel *  chan, const char *  data  )

static

Definition at line 163 of file app_read.c.

{
    int res = 0;
    char tmp[256] = "";
    int maxdigits = 255;
    int tries = 1, to = 0, x = 0;
    double tosec;
    char *argcopy = NULL;
    char *opt_args[OPT_ARG_ARRAY_SIZE];
    struct ast_tone_zone_sound *ts = NULL;
    struct ast_flags flags = {0};
    const char *status = "ERROR";
    char *terminator = "#"; /* use default terminator # by default */
 
    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, opt_args, 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(ast_channel_zone(chan), arglist.filename);
        }
    }
    if (ast_test_flag(&flags, OPT_TERMINATOR)) {
        if (!ast_strlen_zero(opt_args[OPT_ARG_TERMINATOR])) {
            terminator = opt_args[OPT_ARG_TERMINATOR];
        } else {
            terminator = ""; /* no digit inherently will terminate input */
        }
    }
    if (ast_channel_state(chan) != AST_STATE_UP) {
        if (ast_test_flag(&flags, OPT_SKIP)) {
            /* At the user's option, skip if the line is not up */
            if (ts) {
                ts = ast_tone_zone_sound_unref(ts);
            }
            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 = ast_channel_pbx(chan) ? ast_channel_pbx(chan)->rtimeoutms : 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 (terminator && strchr(terminator, tmp[x-1])) {
                        tmp[x-1] = '\0';
                        status = "OK";
                        break;
                    }
                    if (x >= maxdigits) {
                        status = "OK";
                    }
                }
            } else {
                res = ast_app_getdata_terminator(chan, arglist.filename, tmp, maxdigits, to, terminator);
                if (res == AST_GETDATA_COMPLETE) {
                    status = "OK";
                } else if (res == AST_GETDATA_EMPTY_END_TERMINATED) {
                    if (ast_test_flag(&flags, OPT_KEEP_TERMINATOR)) {
                        /* if the option is set to do so, read the
                           returned string as the terminator string */
                        ast_copy_string(tmp, terminator, sizeof(tmp));
                    }
                    status = "OK";
                } else if (res == AST_GETDATA_TIMEOUT) {
                    status = "TIMEOUT";
                } else if (res == AST_GETDATA_INTERRUPTED) {
                    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 (ts) {
        ts = ast_tone_zone_sound_unref(ts);
    }
 
    if (ast_check_hangup(chan))
        status = "HANGUP";
    pbx_builtin_setvar_helper(chan, "READSTATUS", status);
    return 0;
}

References ast_answer(), AST_APP_ARG, ast_app_getdata_terminator(), ast_app_parse_options(), ast_channel_pbx(), ast_channel_zone(), ast_check_hangup(), ast_copy_string(), AST_DECLARE_APP_ARGS, ast_get_indication_tone(), AST_GETDATA_COMPLETE, AST_GETDATA_EMPTY_END_TERMINATED, AST_GETDATA_INTERRUPTED, AST_GETDATA_TIMEOUT, ast_log, ast_playtones_start(), ast_playtones_stop(), AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_stopstream(), ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_tone_zone_sound_unref(), ast_verb, ast_waitfordigit(), ast_tone_zone_sound::data, ast_flags::flags, LOG_WARNING, NULL, OPT_ARG_ARRAY_SIZE, OPT_ARG_TERMINATOR, OPT_INDICATION, OPT_KEEP_TERMINATOR, OPT_NOANSWER, OPT_SKIP, OPT_TERMINATOR, options, pbx_builtin_setvar_helper(), read_app_options, ast_pbx::rtimeoutms, and status.

Referenced by load_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 327 of file app_read.c.

{
    return ast_unregister_application(app);
}

References app, and ast_unregister_application().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Read Variable Application" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 337 of file app_read.c.

app

char* app = "Read"

static

Definition at line 161 of file app_read.c.

Referenced by load_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 337 of file app_read.c.

read_app_options

const struct ast_app_option read_app_options[128] = { [ 's' ] = { .flag = OPT_SKIP }, [ 'i' ] = { .flag = OPT_INDICATION }, [ 'n' ] = { .flag = OPT_NOANSWER }, [ 't' ] = { .flag = OPT_TERMINATOR , .arg_index = OPT_ARG_TERMINATOR + 1 }, [ 'e' ] = { .flag = OPT_KEEP_TERMINATOR }, }

static

Definition at line 159 of file app_read.c.

Referenced by read_exec().