app_if.c File Reference

If Branch Implementation. More...

#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"

Include dependency graph for app_if.c:

Go to the source code of this file.

Macros
#define	VAR_SIZE   64

Functions
	AST_MODULE_INFO_STANDARD_EXTENDED (ASTERISK_GPL_KEY, "If Branch and Conditional Execution")
static int	else_exec (struct ast_channel *chan, const char *data)
static int	elseif_exec (struct ast_channel *chan, const char *data)
static int	end_exec (struct ast_channel *chan, const char *data)
static int	exit_exec (struct ast_channel *chan, const char *data)
static int	find_matching_endif (struct ast_channel *chan, const char *otherapp)
static struct ast_exten *	find_matching_priority (struct ast_context *c, const char *exten, int priority, const char *callerid)
static const char *	get_index (struct ast_channel *chan, const char *prefix, int idx)
static int	if_exec (struct ast_channel *chan, const char *data)
static int	if_helper (struct ast_channel *chan, const char *data, int end)
static int	load_module (void)
static int	unload_module (void)

Variables
static char *	else_app = "Else"
static char *	elseif_app = "ElseIf"
static char *	exit_app = "ExitIf"
static char *	if_app = "If"
static char *	stop_app = "EndIf"

Detailed Description

If Branch Implementation.

Author

Naveen Albert aster.nosp@m.isk@.nosp@m.phrea.nosp@m.knet.nosp@m..org

Definition in file app_if.c.

Macro Definition Documentation

VAR_SIZE

#define VAR_SIZE   64

Definition at line 136 of file app_if.c.

Function Documentation

AST_MODULE_INFO_STANDARD_EXTENDED()

AST_MODULE_INFO_STANDARD_EXTENDED	(	ASTERISK_GPL_KEY	,
		"If Branch and Conditional Execution"
	)

else_exec()

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

static

Definition at line 356 of file app_if.c.

                                                                 {
    return if_helper(chan, data, 3);
}

References ast_exten::data, and if_helper().

Referenced by load_module().

elseif_exec()

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

static

Definition at line 348 of file app_if.c.

                                                                   {
    return if_helper(chan, data, 1);
}

References ast_exten::data, and if_helper().

Referenced by load_module().

end_exec()

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

static

Definition at line 352 of file app_if.c.

                                                                {
    return if_helper(chan, data, 2);
}

References ast_exten::data, and if_helper().

Referenced by load_module().

exit_exec()

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

static

Definition at line 360 of file app_if.c.

                                                                 {
    return if_helper(chan, data, 4);
}

References ast_exten::data, and if_helper().

Referenced by load_module().

find_matching_endif()

static int find_matching_endif ( struct ast_channel *  chan, const char *  otherapp  )

static

Definition at line 183 of file app_if.c.

{
    struct ast_context *c;
    int res = -1;
 
    if (ast_rdlock_contexts()) {
        ast_log(LOG_ERROR, "Failed to lock contexts list\n");
        return -1;
    }
 
    for (c = ast_walk_contexts(NULL); c; c = ast_walk_contexts(c)) {
        struct ast_exten *e;
 
        if (!ast_rdlock_context(c)) {
            if (!strcmp(ast_get_context_name(c), ast_channel_context(chan))) {
                /* This is the matching context we want */
 
                int cur_priority = ast_channel_priority(chan) + 1, level = 1;
 
                for (e = find_matching_priority(c, ast_channel_exten(chan), cur_priority,
                    S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL));
                    e;
                    e = find_matching_priority(c, ast_channel_exten(chan), ++cur_priority,
                        S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL))) {
 
                    if (!strcasecmp(ast_get_extension_app(e), "IF")) {
                        level++;
                    } else if (!strcasecmp(ast_get_extension_app(e), "ENDIF")) {
                        level--;
                    }
 
                    if (!otherapp && level == 0) {
                        res = cur_priority;
                        break;
                    } else if (otherapp && level == 1 && !strcasecmp(ast_get_extension_app(e), otherapp)) {
                        res = cur_priority;
                        break;
                    }
                }
            }
            ast_unlock_context(c);
            if (res > 0) {
                break;
            }
        }
    }
    ast_unlock_contexts();
    return res;
}

References ast_channel_caller(), ast_channel_context(), ast_channel_exten(), ast_channel_priority(), ast_get_context_name(), ast_get_extension_app(), ast_log, ast_rdlock_context(), ast_rdlock_contexts(), ast_unlock_context(), ast_unlock_contexts(), ast_walk_contexts(), c, find_matching_priority(), LOG_ERROR, NULL, and S_COR.

Referenced by if_helper().

find_matching_priority()

static struct ast_exten * find_matching_priority ( struct ast_context *  c, const char *  exten, int  priority, const char *  callerid  )

static

Definition at line 146 of file app_if.c.

{
    struct ast_exten *e;
    struct ast_context *c2;
    int idx;
 
    for (e = ast_walk_context_extensions(c, NULL); e; e = ast_walk_context_extensions(c, e)) {
        if (ast_extension_match(ast_get_extension_name(e), exten)) {
            int needmatch = ast_get_extension_matchcid(e);
            if ((needmatch && ast_extension_match(ast_get_extension_cidmatch(e), callerid)) ||
                (!needmatch)) {
                /* This is the matching extension we want */
                struct ast_exten *p;
                for (p = ast_walk_extension_priorities(e, NULL); p; p = ast_walk_extension_priorities(e, p)) {
                    if (priority != ast_get_extension_priority(p))
                        continue;
                    return p;
                }
            }
        }
    }
 
    /* No match; run through includes */
    for (idx = 0; idx < ast_context_includes_count(c); idx++) {
        const struct ast_include *i = ast_context_includes_get(c, idx);
 
        for (c2 = ast_walk_contexts(NULL); c2; c2 = ast_walk_contexts(c2)) {
            if (!strcmp(ast_get_context_name(c2), ast_get_include_name(i))) {
                e = find_matching_priority(c2, exten, priority, callerid);
                if (e)
                    return e;
            }
        }
    }
    return NULL;
}

References ast_context_includes_count(), ast_context_includes_get(), ast_extension_match(), ast_get_context_name(), ast_get_extension_cidmatch(), ast_get_extension_matchcid(), ast_get_extension_name(), ast_get_extension_priority(), ast_get_include_name(), ast_walk_context_extensions(), ast_walk_contexts(), ast_walk_extension_priorities(), c, find_matching_priority(), NULL, and priority.

Referenced by find_matching_endif(), and find_matching_priority().

get_index()

static const char * get_index ( struct ast_channel *  chan, const char *  prefix, int  idx  )

static

Definition at line 138 of file app_if.c.

{
    char varname[VAR_SIZE];
 
    snprintf(varname, VAR_SIZE, "%s_%d", prefix, idx);
    return pbx_builtin_getvar_helper(chan, varname);
}

References pbx_builtin_getvar_helper(), prefix, and VAR_SIZE.

Referenced by if_helper().

if_exec()

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

static

Definition at line 344 of file app_if.c.

                                                               {
    return if_helper(chan, data, 0);
}

References ast_exten::data, and if_helper().

Referenced by load_module().

if_helper()

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

static

Definition at line 233 of file app_if.c.

{
    int res = 0;
    const char *if_pri = NULL;
    char *my_name = NULL;
    const char *label = NULL;
    char varname[VAR_SIZE + 3]; /* + IF_ */
    char end_varname[sizeof(varname) + 4]; /* + END_ + sizeof(varname) */
    const char *prefix = "IF";
    size_t size = 0;
    int used_index_i = -1, x = 0;
    char used_index[VAR_SIZE] = "0", new_index[VAR_SIZE] = "0";
 
    if (!chan) {
        return -1;
    }
 
    for (x = 0 ;; x++) {
        if (get_index(chan, prefix, x)) {
            used_index_i = x;
        } else {
            break;
        }
    }
 
    snprintf(used_index, sizeof(used_index), "%d", used_index_i);
    snprintf(new_index, sizeof(new_index), "%d", used_index_i + 1);
 
    size = strlen(ast_channel_context(chan)) + strlen(ast_channel_exten(chan)) + 32;
    my_name = ast_alloca(size);
    memset(my_name, 0, size);
    snprintf(my_name, size, "%s_%s_%d", ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan));
 
    ast_channel_lock(chan);
    if (end > 1) {
        label = used_index;
    } else if (!(label = pbx_builtin_getvar_helper(chan, my_name))) {
        label = new_index;
        pbx_builtin_setvar_helper(chan, my_name, label);
    }
    snprintf(varname, sizeof(varname), "%s_%s", prefix, label);
    if ((if_pri = pbx_builtin_getvar_helper(chan, varname)) && !end) {
        if_pri = ast_strdupa(if_pri);
        snprintf(end_varname,sizeof(end_varname),"END_%s",varname);
    }
    ast_channel_unlock(chan);
 
    if ((end <= 1 && !pbx_checkcondition(ast_strdupa(data))) || (end > 1)) {
        /* Condition Met (clean up helper vars) */
        const char *goto_str;
        int pri, endifpri;
        pbx_builtin_setvar_helper(chan, varname, NULL);
        pbx_builtin_setvar_helper(chan, my_name, NULL);
        snprintf(end_varname,sizeof(end_varname),"END_%s",varname);
        ast_channel_lock(chan);
        /* For EndIf, simply go to the next priority.
         * We do not add 1 to ast_channel_priority because the dialplan will
         * auto-increment the priority when we return, so just keep the priority as is.
         * For ExitIf or false If() condition, we need to find the end of the current
         * If branch (at same indentation) and branch there. */
        endifpri = end == 2 ? ast_channel_priority(chan) : find_matching_endif(chan, NULL);
        if ((goto_str = pbx_builtin_getvar_helper(chan, end_varname))) {
            ast_parseable_goto(chan, goto_str);
            pbx_builtin_setvar_helper(chan, end_varname, NULL);
        } else if (end <= 1 && (pri = find_matching_endif(chan, "ElseIf")) > 0 && pri < endifpri) {
            pri--; /* back up a priority, since it returned the priority after the ElseIf */
            /* If is false, and ElseIf exists, so jump to ElseIf */
            ast_verb(3, "Taking conditional false branch, jumping to priority %d\n", pri);
            ast_channel_priority_set(chan, pri);
        } else if (end <= 1 && (pri = find_matching_endif(chan, "Else")) > 0 && pri < endifpri) {
            /* don't need to back up a priority, because we don't actually need to execute Else, just jump to the priority after. Directly executing Else will exit the conditional. */
            /* If is false, and Else exists, so jump to Else */
            ast_verb(3, "Taking absolute false branch, jumping to priority %d\n", pri);
            ast_channel_priority_set(chan, pri);
        } else {
            pri = endifpri;
            if (pri > 0) {
                ast_verb(3, "Exiting conditional, jumping to priority %d\n", pri);
                ast_channel_priority_set(chan, pri);
            } else if (end == 4) { /* Condition added because of end > 0 instead of end == 4 */
                ast_log(LOG_WARNING, "Couldn't find matching EndIf? (If at %s@%s priority %d)\n", ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan));
            }
        }
        ast_channel_unlock(chan);
        return res;
    }
 
    if (end <= 1 && !if_pri) {
        char *goto_str;
        size = strlen(ast_channel_context(chan)) + strlen(ast_channel_exten(chan)) + 32;
        goto_str = ast_alloca(size);
        memset(goto_str, 0, size);
        snprintf(goto_str, size, "%s,%s,%d", ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan));
        pbx_builtin_setvar_helper(chan, varname, goto_str);
    } else if (end > 1 && if_pri) {
        /* END of branch */
        snprintf(end_varname, sizeof(end_varname), "END_%s", varname);
        if (!pbx_builtin_getvar_helper(chan, end_varname)) {
            char *goto_str;
            size = strlen(ast_channel_context(chan)) + strlen(ast_channel_exten(chan)) + 32;
            goto_str = ast_alloca(size);
            memset(goto_str, 0, size);
            snprintf(goto_str, size, "%s,%s,%d", ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan)+1);
            pbx_builtin_setvar_helper(chan, end_varname, goto_str);
        }
        ast_parseable_goto(chan, if_pri);
    }
 
    return res;
}

References ast_alloca, ast_channel_context(), ast_channel_exten(), ast_channel_lock, ast_channel_priority(), ast_channel_priority_set(), ast_channel_unlock, ast_log, ast_parseable_goto(), ast_strdupa, ast_verb, ast_exten::data, end, find_matching_endif(), get_index(), ast_exten::label, LOG_WARNING, NULL, pbx_builtin_getvar_helper(), pbx_builtin_setvar_helper(), pbx_checkcondition(), prefix, and VAR_SIZE.

Referenced by else_exec(), elseif_exec(), end_exec(), exit_exec(), and if_exec().

load_module()

static int load_module ( void  )

static

Definition at line 377 of file app_if.c.

{
    int res;
 
    res = ast_register_application_xml(if_app, if_exec);
    res |= ast_register_application_xml(elseif_app, elseif_exec);
    res |= ast_register_application_xml(stop_app, end_exec);
    res |= ast_register_application_xml(else_app, else_exec);
    res |= ast_register_application_xml(exit_app, exit_exec);
 
    return res;
}

References ast_register_application_xml, else_app, else_exec(), elseif_app, elseif_exec(), end_exec(), exit_app, exit_exec(), if_app, if_exec(), and stop_app.

unload_module()

static int unload_module ( void  )

static

Definition at line 364 of file app_if.c.

{
    int res;
 
    res = ast_unregister_application(if_app);
    res |= ast_unregister_application(elseif_app);
    res |= ast_unregister_application(stop_app);
    res |= ast_unregister_application(else_app);
    res |= ast_unregister_application(exit_app);
 
    return res;
}

References ast_unregister_application(), else_app, elseif_app, exit_app, if_app, and stop_app.

Variable Documentation

else_app

char* else_app = "Else"

static

Definition at line 132 of file app_if.c.

Referenced by load_module(), and unload_module().

elseif_app

char* elseif_app = "ElseIf"

static

Definition at line 131 of file app_if.c.

Referenced by load_module(), and unload_module().

exit_app

char* exit_app = "ExitIf"

static

Definition at line 134 of file app_if.c.

Referenced by load_module(), and unload_module().

if_app

char* if_app = "If"

static

Definition at line 130 of file app_if.c.

Referenced by load_module(), and unload_module().

stop_app

char* stop_app = "EndIf"

static

Definition at line 133 of file app_if.c.

Referenced by load_module(), and unload_module().