func_db.c File Reference

Functions for interaction with the Asterisk database. More...

#include "asterisk.h"
#include <regex.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/astdb.h"

Include dependency graph for func_db.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	function_db_delete (struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
static int	function_db_delete_write (struct ast_channel *chan, const char *cmd, char *parse, const char *value)
	Wrapper to execute DB_DELETE from a write operation. Allows execution even if live_dangerously is disabled.
static int	function_db_exists (struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
static int	function_db_keycount (struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
static int	function_db_keys (struct ast_channel *chan, const char *cmd, char *parse, struct ast_str **result, ssize_t maxlen)
static int	function_db_read (struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
static int	function_db_write (struct ast_channel *chan, const char *cmd, char *parse, const char *value)
static int	load_module (void)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Database (astdb) related 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	db_delete_function
static struct ast_custom_function	db_exists_function
static struct ast_custom_function	db_function
static struct ast_custom_function	db_keycount_function
static struct ast_custom_function	db_keys_function

Detailed Description

Functions for interaction with the Asterisk database.

Author

Russell Bryant russe.nosp@m.lb@c.nosp@m.lemso.nosp@m.n.ed.nosp@m.u

Definition in file func_db.c.

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 455 of file func_db.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 455 of file func_db.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 455 of file func_db.c.

function_db_delete()

static int function_db_delete ( struct ast_channel *  chan, const char *  cmd, char *  parse, char *  buf, size_t  len  )

static

Definition at line 376 of file func_db.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(family);
        AST_APP_ARG(key);
    );
 
    buf[0] = '\0';
 
    if (ast_strlen_zero(parse)) {
        ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
        return -1;
    }
 
    AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 
    if (args.argc < 2) {
        ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
        return -1;
    }
 
    if (ast_db_get(args.family, args.key, buf, len - 1)) {
        ast_debug(1, "DB_DELETE: %s/%s not found in database.\n", args.family, args.key);
    } else {
        if (ast_db_del(args.family, args.key)) {
            ast_debug(1, "DB_DELETE: %s/%s could not be deleted from the database\n", args.family, args.key);
        }
    }
 
    pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
 
    return 0;
}

References args, AST_APP_ARG, ast_db_del(), ast_db_get(), ast_debug, AST_DECLARE_APP_ARGS, ast_log, AST_NONSTANDARD_APP_ARGS, ast_strlen_zero(), buf, len(), LOG_WARNING, and pbx_builtin_setvar_helper().

Referenced by function_db_delete_write().

function_db_delete_write()

static int function_db_delete_write ( struct ast_channel *  chan, const char *  cmd, char *  parse, const char *  value  )

static

Wrapper to execute DB_DELETE from a write operation. Allows execution even if live_dangerously is disabled.

Definition at line 415 of file func_db.c.

{
    /* Throwaway to hold the result from the read */
    char buf[128];
    return function_db_delete(chan, cmd, parse, buf, sizeof(buf));
}

References buf, and function_db_delete().

function_db_exists()

static int function_db_exists ( struct ast_channel *  chan, const char *  cmd, char *  parse, char *  buf, size_t  len  )

static

Definition at line 232 of file func_db.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(family);
        AST_APP_ARG(key);
    );
 
    buf[0] = '\0';
 
    if (ast_strlen_zero(parse)) {
        ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
        return -1;
    }
 
    AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 
    if (args.argc < 2) {
        ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
        return -1;
    }
 
    if (ast_db_get(args.family, args.key, buf, len - 1)) {
        strcpy(buf, "0");
    } else {
        pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
        strcpy(buf, "1");
    }
 
    return 0;
}

References args, AST_APP_ARG, ast_db_get(), AST_DECLARE_APP_ARGS, ast_log, AST_NONSTANDARD_APP_ARGS, ast_strlen_zero(), buf, len(), LOG_WARNING, and pbx_builtin_setvar_helper().

function_db_keycount()

static int function_db_keycount ( struct ast_channel *  chan, const char *  cmd, char *  parse, char *  buf, size_t  len  )

static

Definition at line 325 of file func_db.c.

{
    size_t parselen = strlen(parse);
    struct ast_db_entry *dbe, *orig_dbe;
    const char *last = "";
    int keycount = 0;
 
    /* Remove leading and trailing slashes */
    while (parse[0] == '/') {
        parse++;
        parselen--;
    }
    while (parse[parselen - 1] == '/') {
        parse[--parselen] = '\0';
    }
 
    /* Nothing within the database at that prefix? */
    if (!(orig_dbe = dbe = ast_db_gettree(parse, NULL))) {
        snprintf(buf, len, "%d", keycount);
        return 0;
    }
 
    for (; dbe; dbe = dbe->next) {
        /* Find the current component */
        char *curkey = &dbe->key[parselen + 1], *slash;
        if (*curkey == '/') {
            curkey++;
        }
        /* Remove everything after the current component */
        if ((slash = strchr(curkey, '/'))) {
            *slash = '\0';
        }
 
        /* Skip duplicates */
        if (!strcasecmp(last, curkey)) {
            continue;
        }
        last = curkey;
 
        keycount++;
    }
    ast_db_freetree(orig_dbe);
    snprintf(buf, len, "%d", keycount);
    return 0;
}

References ast_db_freetree(), ast_db_gettree(), buf, ast_db_entry::key, last, len(), ast_db_entry::next, and NULL.

function_db_keys()

static int function_db_keys ( struct ast_channel *  chan, const char *  cmd, char *  parse, struct ast_str **  result, ssize_t  maxlen  )

static

Definition at line 270 of file func_db.c.

{
    size_t parselen = strlen(parse);
    struct ast_db_entry *dbe, *orig_dbe;
    struct ast_str *escape_buf = NULL;
    const char *last = "";
 
    /* Remove leading and trailing slashes */
    while (parse[0] == '/') {
        parse++;
        parselen--;
    }
    while (parse[parselen - 1] == '/') {
        parse[--parselen] = '\0';
    }
 
    ast_str_reset(*result);
 
    /* Nothing within the database at that prefix? */
    if (!(orig_dbe = dbe = ast_db_gettree(parse, NULL))) {
        return 0;
    }
 
    for (; dbe; dbe = dbe->next) {
        /* Find the current component */
        char *curkey = &dbe->key[parselen + 1], *slash;
        if (*curkey == '/') {
            curkey++;
        }
        /* Remove everything after the current component */
        if ((slash = strchr(curkey, '/'))) {
            *slash = '\0';
        }
 
        /* Skip duplicates */
        if (!strcasecmp(last, curkey)) {
            continue;
        }
        last = curkey;
 
        if (orig_dbe != dbe) {
            ast_str_append(result, maxlen, ",");
        }
        ast_str_append_escapecommas(result, maxlen, curkey, strlen(curkey));
    }
    ast_db_freetree(orig_dbe);
    ast_free(escape_buf);
    return 0;
}

References ast_db_freetree(), ast_db_gettree(), ast_free, ast_str_append(), ast_str_append_escapecommas(), ast_str_reset(), ast_db_entry::key, last, ast_db_entry::next, NULL, and result.

function_db_read()

static int function_db_read ( struct ast_channel *  chan, const char *  cmd, char *  parse, char *  buf, size_t  len  )

static

Definition at line 162 of file func_db.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(family);
        AST_APP_ARG(key);
    );
 
    buf[0] = '\0';
 
    if (ast_strlen_zero(parse)) {
        ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
        return -1;
    }
 
    AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 
    if (args.argc < 2) {
        ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
        return -1;
    }
 
    if (ast_db_get(args.family, args.key, buf, len - 1)) {
        ast_debug(1, "DB: %s/%s not found in database.\n", args.family, args.key);
    } else {
        pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
    }
 
    return 0;
}

References args, AST_APP_ARG, ast_db_get(), ast_debug, AST_DECLARE_APP_ARGS, ast_log, AST_NONSTANDARD_APP_ARGS, ast_strlen_zero(), buf, len(), LOG_WARNING, and pbx_builtin_setvar_helper().

function_db_write()

static int function_db_write ( struct ast_channel *  chan, const char *  cmd, char *  parse, const char *  value  )

static

Definition at line 193 of file func_db.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(family);
        AST_APP_ARG(key);
    );
 
    if (ast_strlen_zero(parse)) {
        ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
        return -1;
    }
 
    AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 
    if (args.argc < 2) {
        ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
        return -1;
    }
    /*
    * When keynames are dynamically created using variables, if the variable is empty, this put bad data into the DB.
    * In particular, a few cases: an empty key name, a key starting or ending with a /, and a key containing // two slashes.
    * If this happens, allow it to go in, but warn the user of the issue and possible data corruption. */
    if (ast_strlen_zero(args.key) || args.key[0] == '/' || args.key[strlen(args.key) - 1] == '/' || strstr(args.key, "//")) {
        ast_log(LOG_WARNING, "DB: key '%s' seems malformed\n", args.key);
    }
    if (ast_db_put(args.family, args.key, value)) {
        ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
    }
 
    return 0;
}

References args, AST_APP_ARG, ast_db_put(), AST_DECLARE_APP_ARGS, ast_log, AST_NONSTANDARD_APP_ARGS, ast_strlen_zero(), LOG_WARNING, and value.

load_module()

static int load_module ( void  )

static

Definition at line 442 of file func_db.c.

{
    int res = 0;
 
    res |= ast_custom_function_register_escalating(&db_function, AST_CFE_BOTH);
    res |= ast_custom_function_register(&db_exists_function);
    res |= ast_custom_function_register_escalating(&db_delete_function, AST_CFE_READ);
    res |= ast_custom_function_register(&db_keys_function);
    res |= ast_custom_function_register(&db_keycount_function);
 
    return res;
}

References AST_CFE_BOTH, AST_CFE_READ, ast_custom_function_register, ast_custom_function_register_escalating, db_delete_function, db_exists_function, db_function, db_keycount_function, and db_keys_function.

unload_module()

static int unload_module ( void  )

static

Definition at line 429 of file func_db.c.

{
    int res = 0;
 
    res |= ast_custom_function_unregister(&db_function);
    res |= ast_custom_function_unregister(&db_exists_function);
    res |= ast_custom_function_unregister(&db_delete_function);
    res |= ast_custom_function_unregister(&db_keys_function);
    res |= ast_custom_function_unregister(&db_keycount_function);
 
    return res;
}

References ast_custom_function_unregister(), db_delete_function, db_exists_function, db_function, db_keycount_function, and db_keys_function.

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Database (astdb) related 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 455 of file func_db.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 455 of file func_db.c.

db_delete_function

struct ast_custom_function db_delete_function

static

Initial value:

= {
    .name = "DB_DELETE",
    .read = function_db_delete,
    .write = function_db_delete_write,
}

Definition at line 423 of file func_db.c.

                                                       {
    .name = "DB_DELETE",
    .read = function_db_delete,
    .write = function_db_delete_write,
};

Referenced by load_module(), and unload_module().

db_exists_function

struct ast_custom_function db_exists_function

static

Initial value:

= {
    .name = "DB_EXISTS",
    .read = function_db_exists,
    .read_max = 2,
}

Definition at line 264 of file func_db.c.

                                                       {
    .name = "DB_EXISTS",
    .read = function_db_exists,
    .read_max = 2,
};

Referenced by load_module(), and unload_module().

db_function

struct ast_custom_function db_function

static

Initial value:

= {
    .name = "DB",
    .read = function_db_read,
    .write = function_db_write,
}

Definition at line 226 of file func_db.c.

                                                {
    .name = "DB",
    .read = function_db_read,
    .write = function_db_write,
};

Referenced by load_module(), and unload_module().

db_keycount_function

struct ast_custom_function db_keycount_function

static

Initial value:

= {
    .name = "DB_KEYCOUNT",
    .read = function_db_keycount,
}

Definition at line 371 of file func_db.c.

                                                         {
    .name = "DB_KEYCOUNT",
    .read = function_db_keycount,
};

Referenced by load_module(), and unload_module().

db_keys_function

struct ast_custom_function db_keys_function

static

Initial value:

= {
    .name = "DB_KEYS",
    .read2 = function_db_keys,
}

Definition at line 320 of file func_db.c.

                                                     {
    .name = "DB_KEYS",
    .read2 = function_db_keys,
};

Referenced by load_module(), and unload_module().