func_global.c File Reference

Global variable dialplan functions. More...

#include "asterisk.h"
#include <sys/stat.h>
#include "asterisk/module.h"
#include "asterisk/pbx.h"
#include "asterisk/channel.h"
#include "asterisk/app.h"
#include "asterisk/stasis_channels.h"

Include dependency graph for func_global.c:

Go to the source code of this file.

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	global_delete_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
static int	global_exists_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	global_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	global_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
static int	load_module (void)
static int	shared_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static void	shared_variable_free (void *data)
static int	shared_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Variable dialplan functions" , .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 const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_custom_function	global_delete_function
static struct ast_custom_function	global_exists_function
static struct ast_custom_function	global_function
static struct ast_custom_function	shared_function
static const struct ast_datastore_info	shared_variable_info

Detailed Description

Global variable dialplan functions.

Author

Tilghman Lesher func_.nosp@m.glob.nosp@m.al__2.nosp@m.0060.nosp@m.5@the.nosp@m.-til.nosp@m.ghman.nosp@m..com

Definition in file func_global.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 415 of file func_global.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 415 of file func_global.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 415 of file func_global.c.

global_delete_write()

static int global_delete_write ( struct ast_channel *  chan, const char *  cmd, char *  data, const char *  value  )

static

Definition at line 201 of file func_global.c.

{
    pbx_builtin_setvar_helper(NULL, data, NULL);
 
    return 0;
}

References NULL, and pbx_builtin_setvar_helper().

global_exists_read()

static int global_exists_read ( struct ast_channel *  chan, const char *  cmd, char *  data, char *  buf, size_t  len  )

static

Definition at line 213 of file func_global.c.

{
    const char *var = pbx_builtin_getvar_helper(NULL, data);
 
    strcpy(buf, var ? "1" : "0");
 
    return 0;
}

References buf, NULL, pbx_builtin_getvar_helper(), and var.

global_read()

static int global_read ( struct ast_channel *  chan, const char *  cmd, char *  data, char *  buf, size_t  len  )

static

Definition at line 176 of file func_global.c.

{
    const char *var = pbx_builtin_getvar_helper(NULL, data);
 
    *buf = '\0';
 
    if (var)
        ast_copy_string(buf, var, len);
 
    return 0;
}

References ast_copy_string(), buf, len(), NULL, pbx_builtin_getvar_helper(), and var.

global_write()

static int global_write ( struct ast_channel *  chan, const char *  cmd, char *  data, const char *  value  )

static

Definition at line 188 of file func_global.c.

{
    pbx_builtin_setvar_helper(NULL, data, value);
 
    return 0;
}

References NULL, pbx_builtin_setvar_helper(), and value.

load_module()

static int load_module ( void  )

static

Definition at line 403 of file func_global.c.

{
    int res = 0;
 
    res |= ast_custom_function_register(&global_function);
    res |= ast_custom_function_register(&global_delete_function);
    res |= ast_custom_function_register(&global_exists_function);
    res |= ast_custom_function_register(&shared_function);
 
    return res;
}

References ast_custom_function_register, global_delete_function, global_exists_function, global_function, and shared_function.

shared_read()

static int shared_read ( struct ast_channel *  chan, const char *  cmd, char *  data, char *  buf, size_t  len  )

static

Definition at line 228 of file func_global.c.

{
    struct ast_datastore *varstore;
    struct varshead *varshead;
    struct ast_var_t *var;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(var);
        AST_APP_ARG(chan);
    );
    struct ast_channel *c_ref = NULL;
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "SHARED() requires an argument: SHARED(<var>[,<chan>])\n");
        return -1;
    }
 
    AST_STANDARD_APP_ARGS(args, data);
 
    if (!ast_strlen_zero(args.chan)) {
        char *prefix = ast_alloca(strlen(args.chan) + 2);
        sprintf(prefix, "%s-", args.chan);
        if (!(c_ref = ast_channel_get_by_name(args.chan)) && !(c_ref = ast_channel_get_by_name_prefix(prefix, strlen(prefix)))) {
            ast_log(LOG_ERROR, "Channel '%s' not found!  Variable '%s' will be blank.\n", args.chan, args.var);
            return -1;
        }
        chan = c_ref;
    } else if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
 
    ast_channel_lock(chan);
 
    if (!(varstore = ast_channel_datastore_find(chan, &shared_variable_info, NULL))) {
        ast_channel_unlock(chan);
        if (c_ref) {
            c_ref = ast_channel_unref(c_ref);
        }
        return -1;
    }
 
    varshead = varstore->data;
    *buf = '\0';
 
    /* Protected by the channel lock */
    AST_LIST_TRAVERSE(varshead, var, entries) {
        if (!strcmp(args.var, ast_var_name(var))) {
            ast_copy_string(buf, ast_var_value(var), len);
            break;
        }
    }
 
    ast_channel_unlock(chan);
 
    if (c_ref) {
        c_ref = ast_channel_unref(c_ref);
    }
 
    return 0;
}

References args, ast_alloca, AST_APP_ARG, ast_channel_datastore_find(), ast_channel_get_by_name(), ast_channel_get_by_name_prefix(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, ast_copy_string(), AST_DECLARE_APP_ARGS, AST_LIST_TRAVERSE, ast_log, AST_STANDARD_APP_ARGS, ast_strlen_zero(), ast_var_name(), ast_var_value(), buf, ast_datastore::data, ast_channel::data, len(), LOG_ERROR, LOG_WARNING, NULL, prefix, shared_variable_info, and var.

shared_variable_free()

static void shared_variable_free ( void *  data )

static

Definition at line 165 of file func_global.c.

{
    struct varshead *varshead = data;
    struct ast_var_t *var;
 
    while ((var = AST_LIST_REMOVE_HEAD(varshead, entries))) {
        ast_var_delete(var);
    }
    ast_free(varshead);
}

References ast_free, AST_LIST_REMOVE_HEAD, ast_var_delete(), ast_var_t::entries, and var.

shared_write()

static int shared_write ( struct ast_channel *  chan, const char *  cmd, char *  data, const char *  value  )

static

Definition at line 289 of file func_global.c.

{
    struct ast_datastore *varstore;
    struct varshead *varshead;
    struct ast_var_t *var;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(var);
        AST_APP_ARG(chan);
    );
    struct ast_channel *c_ref = NULL;
    int len;
    RAII_VAR(char *, shared_buffer, NULL, ast_free);
 
    if (ast_strlen_zero(data)) {
        ast_log(LOG_WARNING, "SHARED() requires an argument: SHARED(<var>[,<chan>])\n");
        return -1;
    }
 
    AST_STANDARD_APP_ARGS(args, data);
 
    if (!ast_strlen_zero(args.chan)) {
        char *prefix = ast_alloca(strlen(args.chan) + 2);
        sprintf(prefix, "%s-", args.chan);
        if (!(c_ref = ast_channel_get_by_name(args.chan)) && !(c_ref = ast_channel_get_by_name_prefix(prefix, strlen(prefix)))) {
            ast_log(LOG_ERROR, "Channel '%s' not found!  Variable '%s' not set to '%s'.\n", args.chan, args.var, value);
            return -1;
        }
        chan = c_ref;
    } else if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
 
    len = 9 + strlen(args.var); /* SHARED() + var */
    shared_buffer = ast_malloc(len);
    if (!shared_buffer) {
        if (c_ref) {
            ast_channel_unref(c_ref);
        }
        return -1;
    }
 
    ast_channel_lock(chan);
 
    if (!(varstore = ast_channel_datastore_find(chan, &shared_variable_info, NULL))) {
        if (!(varstore = ast_datastore_alloc(&shared_variable_info, NULL))) {
            ast_log(LOG_ERROR, "Unable to allocate new datastore.  Shared variable not set.\n");
            ast_channel_unlock(chan);
            if (c_ref) {
                c_ref = ast_channel_unref(c_ref);
            }
            return -1;
        }
 
        if (!(varshead = ast_calloc(1, sizeof(*varshead)))) {
            ast_log(LOG_ERROR, "Unable to allocate variable structure.  Shared variable not set.\n");
            ast_datastore_free(varstore);
            ast_channel_unlock(chan);
            if (c_ref) {
                c_ref = ast_channel_unref(c_ref);
            }
            return -1;
        }
 
        varstore->data = varshead;
        ast_channel_datastore_add(chan, varstore);
    }
    varshead = varstore->data;
 
    /* Protected by the channel lock */
    AST_LIST_TRAVERSE_SAFE_BEGIN(varshead, var, entries) {
        /* If there's a previous value, remove it */
        if (!strcmp(args.var, ast_var_name(var))) {
            AST_LIST_REMOVE_CURRENT(entries);
            ast_var_delete(var);
            break;
        }
    }
    AST_LIST_TRAVERSE_SAFE_END;
 
    if ((var = ast_var_assign(args.var, S_OR(value, "")))) {
        AST_LIST_INSERT_HEAD(varshead, var, entries);
 
        sprintf(shared_buffer, "SHARED(%s)", args.var);
        ast_channel_publish_varset(chan, shared_buffer, value);
    }
 
    ast_channel_unlock(chan);
 
    if (c_ref) {
        c_ref = ast_channel_unref(c_ref);
    }
 
    return 0;
}

References args, ast_alloca, AST_APP_ARG, ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_get_by_name(), ast_channel_get_by_name_prefix(), ast_channel_lock, ast_channel_publish_varset(), ast_channel_unlock, ast_channel_unref, ast_datastore_alloc, ast_datastore_free(), AST_DECLARE_APP_ARGS, ast_free, AST_LIST_INSERT_HEAD, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log, ast_malloc, AST_STANDARD_APP_ARGS, ast_strlen_zero(), ast_var_assign, ast_var_delete(), ast_var_name(), ast_datastore::data, ast_channel::data, len(), LOG_ERROR, LOG_WARNING, NULL, prefix, RAII_VAR, S_OR, shared_variable_info, value, var, and ast_channel::varshead.

unload_module()

static int unload_module ( void  )

static

Definition at line 391 of file func_global.c.

{
    int res = 0;
 
    res |= ast_custom_function_unregister(&global_function);
    res |= ast_custom_function_unregister(&global_delete_function);
    res |= ast_custom_function_unregister(&global_exists_function);
    res |= ast_custom_function_unregister(&shared_function);
 
    return res;
}

References ast_custom_function_unregister(), global_delete_function, global_exists_function, global_function, and shared_function.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Variable dialplan functions" , .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 415 of file func_global.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 415 of file func_global.c.

global_delete_function

struct ast_custom_function global_delete_function

static

Initial value:

= {
    .name = "GLOBAL_DELETE",
    .write = global_delete_write,
}

Definition at line 208 of file func_global.c.

                                                           {
    .name = "GLOBAL_DELETE",
    .write = global_delete_write,
};

Referenced by load_module(), and unload_module().

global_exists_function

struct ast_custom_function global_exists_function

static

Initial value:

= {
    .name = "GLOBAL_EXISTS",
    .read = global_exists_read,
}

Definition at line 223 of file func_global.c.

                                                           {
    .name = "GLOBAL_EXISTS",
    .read = global_exists_read,
};

Referenced by load_module(), and unload_module().

global_function

struct ast_custom_function global_function

static

Initial value:

= {
    .name = "GLOBAL",
    .read = global_read,
    .write = global_write,
}

Definition at line 195 of file func_global.c.

                                                    {
    .name = "GLOBAL",
    .read = global_read,
    .write = global_write,
};

Referenced by load_module(), and unload_module().

shared_function

struct ast_custom_function shared_function

static

Initial value:

= {
    .name = "SHARED",
    .read = shared_read,
    .write = shared_write,
}

Definition at line 385 of file func_global.c.

                                                    {
    .name = "SHARED",
    .read = shared_read,
    .write = shared_write,
};

Referenced by load_module(), and unload_module().

shared_variable_info

const struct ast_datastore_info shared_variable_info

static

Initial value:

= {
    .type = "SHARED_VARIABLES",
    .destroy = shared_variable_free,
}

Definition at line 160 of file func_global.c.

                                                              {
    .type = "SHARED_VARIABLES",
    .destroy = shared_variable_free,
};

Referenced by shared_read(), and shared_write().