pbx_builtins.c File Reference

Core PBX builtin routines. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/pbx.h"
#include "asterisk/causes.h"
#include "asterisk/indications.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/say.h"
#include "asterisk/app.h"
#include "asterisk/module.h"
#include "asterisk/conversions.h"
#include "pbx_private.h"

Include dependency graph for pbx_builtins.c:

Go to the source code of this file.

Data Structures
struct	pbx_builtin
	Declaration of builtin applications. More...

Macros
#define	BACKGROUND_MATCHEXTEN   (1 << 2)
#define	BACKGROUND_NOANSWER   (1 << 1)
#define	BACKGROUND_PLAYBACK   (1 << 3)
#define	BACKGROUND_SKIP   (1 << 0)

Enumerations
enum	{ WAITEXTEN_MOH = (1 << 0) , WAITEXTEN_DIALTONE = (1 << 1) }
enum	read_option_flags {   OPT_DELAY = (1 << 0) , OPT_MUTE = (1 << 1) , OPT_QUELCH = (1 << 2) , OPT_RELAXED = (1 << 3) ,   OPT_LAX_KP = (1 << 4) , OPT_PROCESS = (1 << 5) , OPT_NO_KP = (1 << 6) , OPT_NO_ST = (1 << 7) ,   OPT_KP_OVERRIDE = (1 << 8) , OPT_MAXDIGITS = (1 << 9) , OPT_SKIP = (1 << 0) , OPT_INDICATION = (1 << 1) ,   OPT_NOANSWER = (1 << 2) , OPT_TERMINATOR = (1 << 3) , OPT_KEEP_TERMINATOR = (1 << 4) , OPT_ANSWER = (1 << 0) ,   OPT_DELAY = (1 << 0) , OPT_MUTE = (1 << 1) , OPT_QUELCH = (1 << 2) , OPT_RELAXED = (1 << 3) ,   OPT_EXTRAPULSES = (1 << 4) , WAITEXTEN_ARG_MOH , WAITEXTEN_ARG_DIALTONE , WAITEXTEN_ARRAY_SIZE }

Functions
int	indicate_busy (struct ast_channel *chan, const char *data)
int	indicate_congestion (struct ast_channel *chan, const char *data)
int	load_pbx_builtins (void)
static int	pbx_builtin_answer (struct ast_channel *chan, const char *data)
static int	pbx_builtin_background (struct ast_channel *chan, const char *data)
static int	pbx_builtin_execiftime (struct ast_channel *chan, const char *data)
static int	pbx_builtin_goto (struct ast_channel *chan, const char *data)
static int	pbx_builtin_gotoif (struct ast_channel *chan, const char *data)
static int	pbx_builtin_gotoiftime (struct ast_channel *chan, const char *data)
static int	pbx_builtin_hangup (struct ast_channel *chan, const char *data)
static int	pbx_builtin_incomplete (struct ast_channel *chan, const char *data)
static int	pbx_builtin_noop (struct ast_channel *chan, const char *data)
static int	pbx_builtin_proceeding (struct ast_channel *chan, const char *data)
static int	pbx_builtin_progress (struct ast_channel *chan, const char *data)
int	pbx_builtin_raise_exception (struct ast_channel *chan, const char *reason)
static int	pbx_builtin_ringing (struct ast_channel *chan, const char *data)
static int	pbx_builtin_saycharacters (struct ast_channel *chan, const char *data)
static int	pbx_builtin_saycharacters_case (struct ast_channel *chan, const char *data)
static int	pbx_builtin_saydigits (struct ast_channel *chan, const char *data)
static int	pbx_builtin_saymoney (struct ast_channel *chan, const char *data)
static int	pbx_builtin_saynumber (struct ast_channel *chan, const char *data)
static int	pbx_builtin_sayordinal (struct ast_channel *chan, const char *data)
static int	pbx_builtin_sayphonetic (struct ast_channel *chan, const char *data)
static int	pbx_builtin_wait (struct ast_channel *chan, const char *data)
static int	pbx_builtin_waitdigit (struct ast_channel *chan, const char *data)
static int	pbx_builtin_waitexten (struct ast_channel *chan, const char *data)
static int	permit_dtmf_interrupt (struct ast_channel *chan)
	Determine if DTMF interruption was requested. More...
static void	unload_pbx_builtins (void)

Variables
static const struct ast_app_option	background_opts [128] = { [ 's' ] = { .flag = (1 << 0) }, [ 'n' ] = { .flag = (1 << 1) }, [ 'm' ] = { .flag = (1 << 2) }, [ 'p' ] = { .flag = (1 << 3) }, }
struct pbx_builtin	builtins []
static const struct ast_app_option	waitexten_opts [128] = { [ 'm' ] = { .flag = WAITEXTEN_MOH , .arg_index = WAITEXTEN_ARG_MOH + 1 }, [ 'd' ] = { .flag = WAITEXTEN_DIALTONE , .arg_index = WAITEXTEN_ARG_DIALTONE + 1 }, }

Detailed Description

Core PBX builtin routines.

Author

George Joseph georg.nosp@m.e.jo.nosp@m.seph@.nosp@m.fair.nosp@m.view5.nosp@m..com

Definition in file pbx_builtins.c.

Macro Definition Documentation

BACKGROUND_MATCHEXTEN

#define BACKGROUND_MATCHEXTEN   (1 << 2)

Definition at line 783 of file pbx_builtins.c.

BACKGROUND_NOANSWER

#define BACKGROUND_NOANSWER   (1 << 1)

Definition at line 782 of file pbx_builtins.c.

BACKGROUND_PLAYBACK

#define BACKGROUND_PLAYBACK   (1 << 3)

Definition at line 784 of file pbx_builtins.c.

BACKGROUND_SKIP

#define BACKGROUND_SKIP   (1 << 0)

Definition at line 781 of file pbx_builtins.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
WAITEXTEN_MOH
WAITEXTEN_DIALTONE

Definition at line 793 of file pbx_builtins.c.

     {
    WAITEXTEN_MOH = (1 << 0),
    WAITEXTEN_DIALTONE = (1 << 1),
};

read_option_flags

enum read_option_flags

Enumerator
OPT_DELAY
OPT_MUTE
OPT_QUELCH
OPT_RELAXED
OPT_LAX_KP
OPT_PROCESS
OPT_NO_KP
OPT_NO_ST
OPT_KP_OVERRIDE
OPT_MAXDIGITS
OPT_SKIP
OPT_INDICATION
OPT_NOANSWER
OPT_TERMINATOR
OPT_KEEP_TERMINATOR
OPT_ANSWER
OPT_DELAY
OPT_MUTE
OPT_QUELCH
OPT_RELAXED
OPT_EXTRAPULSES
WAITEXTEN_ARG_MOH
WAITEXTEN_ARG_DIALTONE
WAITEXTEN_ARRAY_SIZE

Definition at line 798 of file pbx_builtins.c.

                       {
    WAITEXTEN_ARG_MOH,
    WAITEXTEN_ARG_DIALTONE,
    /* note: this entry _MUST_ be the last one in the enum */
    WAITEXTEN_ARRAY_SIZE,
};

Function Documentation

load_pbx_builtins()

int load_pbx_builtins

(

void

)

Provided by pbx_builtins.c

Definition at line 1597 of file pbx_builtins.c.

{
    int x;
 
    /* Register builtin applications */
    for (x = 0; x < ARRAY_LEN(builtins); x++) {
        if (ast_register_application2(builtins[x].name, builtins[x].execute, NULL, NULL, NULL)) {
            ast_log(LOG_ERROR, "Unable to register builtin application '%s'\n", builtins[x].name);
            return -1;
        }
    }
 
    ast_register_cleanup(unload_pbx_builtins);
 
    return 0;
}

References ARRAY_LEN, ast_log, ast_register_application2(), ast_register_cleanup(), builtins, execute(), LOG_ERROR, name, NULL, unload_pbx_builtins(), and ast_channel::x.

Referenced by asterisk_daemon().

pbx_builtin_gotoif()

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

static

Definition at line 1336 of file pbx_builtins.c.

{
    char *condition, *branch1, *branch2, *branch;
    char *stringp;
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "Ignoring, since there is no variable to check\n");
        return 0;
    }
 
    stringp = ast_strdupa(data);
    condition = strsep(&stringp,"?");
    branch1 = strsep(&stringp,":");
    branch2 = strsep(&stringp,"");
    branch = pbx_checkcondition(condition) ? branch1 : branch2;
 
    if (ast_strlen_zero(branch)) {
        ast_debug(1, "Not taking any branch\n");
        return 0;
    }
 
    return pbx_builtin_goto(chan, branch);
}

References ast_debug, ast_log, ast_strdupa, ast_strlen_zero(), LOG_WARNING, pbx_builtin_goto(), pbx_checkcondition(), and strsep().

pbx_builtin_incomplete()

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

static

Definition at line 913 of file pbx_builtins.c.

{
    const char *options = data;
    int answer = 1;
 
    /* Some channels can receive DTMF in unanswered state; some cannot */
    if (!ast_strlen_zero(options) && strchr(options, 'n')) {
        answer = 0;
    }
 
    /* If the channel is hungup, stop waiting */
    if (ast_check_hangup(chan)) {
        return -1;
    } else if (ast_channel_state(chan) != AST_STATE_UP && answer) {
        __ast_answer(chan, 0);
    }
 
    ast_indicate(chan, AST_CONTROL_INCOMPLETE);
 
    return AST_PBX_INCOMPLETE;
}

References __ast_answer(), answer(), ast_check_hangup(), AST_CONTROL_INCOMPLETE, ast_indicate(), AST_PBX_INCOMPLETE, AST_STATE_UP, ast_strlen_zero(), and options.

pbx_builtin_noop()

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

static

Definition at line 1331 of file pbx_builtins.c.

{
    return 0;
}

pbx_builtin_raise_exception()

int pbx_builtin_raise_exception	(	struct ast_channel *	chan,
		const char *	reason
	)

Definition at line 810 of file pbx_builtins.c.

{
    /* Priority will become 1, next time through the AUTOLOOP */
    return raise_exception(chan, reason, 0);
}

References raise_exception().

pbx_builtin_saycharacters()

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

static

Definition at line 1529 of file pbx_builtins.c.

{
    int res = 0;
 
    if (data) {
        res = ast_say_character_str(chan, data, permit_dtmf_interrupt(chan) ? AST_DIGIT_ANY : "", ast_channel_language(chan), AST_SAY_CASE_NONE);
    }
 
    return res;
}

References ast_channel_language(), AST_DIGIT_ANY, AST_SAY_CASE_NONE, ast_say_character_str(), and permit_dtmf_interrupt().

pbx_builtin_saycharacters_case()

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

static

Definition at line 1482 of file pbx_builtins.c.

{
    int res = 0;
    int sensitivity = 0;
    char *parse;
 
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(options);
        AST_APP_ARG(characters);
    );
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "SayAlphaCase requires two arguments (options, characters)\n");
        return 0;
    }
 
    parse = ast_strdupa(data);
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (!args.options || strlen(args.options) != 1) {
        ast_log(LOG_WARNING, "SayAlphaCase options are mutually exclusive and required\n");
        return 0;
    }
 
    switch (args.options[0]) {
    case 'a':
        sensitivity = AST_SAY_CASE_ALL;
        break;
    case 'l':
        sensitivity = AST_SAY_CASE_LOWER;
        break;
    case 'n':
        sensitivity = AST_SAY_CASE_NONE;
        break;
    case 'u':
        sensitivity = AST_SAY_CASE_UPPER;
        break;
    default:
        ast_log(LOG_WARNING, "Invalid option: '%s'\n", args.options);
        return 0;
    }
 
    res = ast_say_character_str(chan, args.characters, permit_dtmf_interrupt(chan) ? AST_DIGIT_ANY : "", ast_channel_language(chan), sensitivity);
 
    return res;
}

References args, AST_APP_ARG, ast_channel_language(), AST_DECLARE_APP_ARGS, AST_DIGIT_ANY, ast_log, AST_SAY_CASE_ALL, AST_SAY_CASE_LOWER, AST_SAY_CASE_NONE, AST_SAY_CASE_UPPER, ast_say_character_str(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), LOG_WARNING, options, and permit_dtmf_interrupt().

pbx_builtin_saydigits()

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

static

Definition at line 1460 of file pbx_builtins.c.

{
    int res = 0;
 
    if (data) {
        res = ast_say_digit_str(chan, data, permit_dtmf_interrupt(chan) ? AST_DIGIT_ANY : "", ast_channel_language(chan));
    }
 
    return res;
}

References ast_channel_language(), AST_DIGIT_ANY, ast_say_digit_str(), and permit_dtmf_interrupt().

pbx_builtin_saymoney()

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

static

Definition at line 1471 of file pbx_builtins.c.

{
    int res = 0;
 
    if (data) {
        res = ast_say_money_str(chan, data, permit_dtmf_interrupt(chan) ? AST_DIGIT_ANY : "", ast_channel_language(chan));
    }
 
    return res;
}

References ast_channel_language(), AST_DIGIT_ANY, ast_say_money_str(), and permit_dtmf_interrupt().

pbx_builtin_saynumber()

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

static

Definition at line 1382 of file pbx_builtins.c.

{
    char tmp[256];
    char *number = tmp;
    int number_val;
    char *options;
    int res;
    int interrupt = permit_dtmf_interrupt(chan);
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "SayNumber requires an argument (number)\n");
        return -1;
    }
    ast_copy_string(tmp, data, sizeof(tmp));
    strsep(&number, ",");
 
    if (ast_str_to_int(tmp, &number_val)) {
        ast_log(LOG_WARNING, "argument '%s' to SayNumber could not be parsed as a number.\n", tmp);
        return 0;
    }
 
    options = strsep(&number, ",");
    if (options) {
        if ( strcasecmp(options, "f") && strcasecmp(options, "m") &&
            strcasecmp(options, "c") && strcasecmp(options, "n") ) {
            ast_log(LOG_WARNING, "SayNumber gender option is either 'f', 'm', 'c' or 'n'\n");
            return -1;
        }
    }
 
    res = ast_say_number(chan, number_val, interrupt ? AST_DIGIT_ANY : "", ast_channel_language(chan), options);
 
    if (res < 0 && !ast_check_hangup_locked(chan)) {
        ast_log(LOG_WARNING, "We were unable to say the number %s, is it too large?\n", tmp);
    }
 
    return interrupt ? res : 0;
}

References ast_channel_language(), ast_check_hangup_locked(), ast_copy_string(), AST_DIGIT_ANY, ast_log, ast_say_number(), ast_str_to_int(), ast_strlen_zero(), LOG_WARNING, options, permit_dtmf_interrupt(), and strsep().

pbx_builtin_sayordinal()

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

static

Definition at line 1421 of file pbx_builtins.c.

{
    char tmp[256];
    char *number = tmp;
    int number_val;
    char *options;
    int res;
    int interrupt = permit_dtmf_interrupt(chan);
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "SayOrdinal requires an argument (number)\n");
        return -1;
    }
    ast_copy_string(tmp, data, sizeof(tmp));
    strsep(&number, ",");
 
    if (ast_str_to_int(tmp, &number_val)) {
        ast_log(LOG_WARNING, "argument '%s' to SayOrdinal could not be parsed as a number.\n", tmp);
        return 0;
    }
 
    options = strsep(&number, ",");
    if (options) {
        if ( strcasecmp(options, "f") && strcasecmp(options, "m") &&
            strcasecmp(options, "c") && strcasecmp(options, "n") ) {
            ast_log(LOG_WARNING, "SayOrdinal gender option is either 'f', 'm', 'c' or 'n'\n");
            return -1;
        }
    }
 
    res = ast_say_ordinal(chan, number_val, interrupt ? AST_DIGIT_ANY : "", ast_channel_language(chan), options);
 
    if (res < 0 && !ast_check_hangup_locked(chan)) {
        ast_log(LOG_WARNING, "We were unable to say the number %s, is it too large?\n", tmp);
    }
 
    return interrupt ? res : 0;
}

References ast_channel_language(), ast_check_hangup_locked(), ast_copy_string(), AST_DIGIT_ANY, ast_log, ast_say_ordinal(), ast_str_to_int(), ast_strlen_zero(), LOG_WARNING, options, permit_dtmf_interrupt(), and strsep().

pbx_builtin_sayphonetic()

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

static

Definition at line 1540 of file pbx_builtins.c.

{
    int res = 0;
 
    if (data) {
        res = ast_say_phonetic_str(chan, data, permit_dtmf_interrupt(chan) ? AST_DIGIT_ANY : "", ast_channel_language(chan));
    }
 
    return res;
}

References ast_channel_language(), AST_DIGIT_ANY, ast_say_phonetic_str(), and permit_dtmf_interrupt().

permit_dtmf_interrupt()

static int permit_dtmf_interrupt ( struct ast_channel *  chan )

static

Determine if DTMF interruption was requested.

If the SAY_DTMF_INTERRUPT channel variable is truthy, the caller has requested DTMF interruption be enabled.

Parameters

chan	the channel to examine

Return values

-1	if DTMF interruption was requested
0	if DTMF interruption was not requested

Definition at line 1371 of file pbx_builtins.c.

{
    int interrupt;
 
    ast_channel_lock(chan);
    interrupt = ast_true(pbx_builtin_getvar_helper(chan, "SAY_DTMF_INTERRUPT"));
    ast_channel_unlock(chan);
 
    return interrupt;
}

References ast_channel_lock, ast_channel_unlock, ast_true(), and pbx_builtin_getvar_helper().

Referenced by pbx_builtin_saycharacters(), pbx_builtin_saycharacters_case(), pbx_builtin_saydigits(), pbx_builtin_saymoney(), pbx_builtin_saynumber(), pbx_builtin_sayordinal(), and pbx_builtin_sayphonetic().

unload_pbx_builtins()

static void unload_pbx_builtins ( void  )

static

Definition at line 1587 of file pbx_builtins.c.

{
    int x;
 
    /* Unregister builtin applications */
    for (x = 0; x < ARRAY_LEN(builtins); x++) {
        ast_unregister_application(builtins[x].name);
    }
}

References ARRAY_LEN, ast_unregister_application(), builtins, name, and ast_channel::x.

Referenced by load_pbx_builtins().

Variable Documentation

background_opts

const struct ast_app_option background_opts[128] = { [ 's' ] = { .flag = (1 << 0) }, [ 'n' ] = { .flag = (1 << 1) }, [ 'm' ] = { .flag = (1 << 2) }, [ 'p' ] = { .flag = (1 << 3) }, }

static

Definition at line 791 of file pbx_builtins.c.

Referenced by pbx_builtin_background().

builtins

struct pbx_builtin builtins[]

Referenced by load_pbx_builtins(), and unload_pbx_builtins().

waitexten_opts

const struct ast_app_option waitexten_opts[128] = { [ 'm' ] = { .flag = WAITEXTEN_MOH , .arg_index = WAITEXTEN_ARG_MOH + 1 }, [ 'd' ] = { .flag = WAITEXTEN_DIALTONE , .arg_index = WAITEXTEN_ARG_DIALTONE + 1 }, }

static

Definition at line 808 of file pbx_builtins.c.

Referenced by pbx_builtin_waitexten().