astdb.h File Reference

Persistent data storage (akin to *doze registry) More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_db_entry

Functions
int	ast_db_del (const char *family, const char *key)
	Delete entry in astdb. More...
int	ast_db_del2 (const char *family, const char *key)
	Same as ast_db_del, but with more stringent error checking. More...
int	ast_db_deltree (const char *family, const char *keytree)
	Delete one or more entries in astdb. More...
int	ast_db_exists (const char *family, const char *key)
	Check if family/key exitsts. More...
void	ast_db_freetree (struct ast_db_entry *entry)
	Free structure created by ast_db_gettree() More...
int	ast_db_get (const char *family, const char *key, char *value, int valuelen)
	Get key value specified by family/key. More...
int	ast_db_get_allocated (const char *family, const char *key, char **out)
	Get key value specified by family/key as a heap allocated string. More...
struct ast_db_entry *	ast_db_gettree (const char *family, const char *keytree)
	Get a list of values within the astdb tree. More...
struct ast_db_entry *	ast_db_gettree_by_prefix (const char *family, const char *key_prefix)
	Get a list of values with the given key prefix. More...
int	ast_db_put (const char *family, const char *key, const char *value)
	Store value addressed by family/key. More...

Detailed Description

Persistent data storage (akin to *doze registry)

Definition in file astdb.h.

Function Documentation

ast_db_del()

int ast_db_del	(	const char *	family,
		const char *	key
	)

Delete entry in astdb.

Definition at line 476 of file main/db.c.

{
    char fullkey[MAX_DB_FIELD];
    size_t fullkey_len;
    int res = 0;
 
    if (strlen(family) + strlen(key) + 2 > sizeof(fullkey) - 1) {
        ast_log(LOG_WARNING, "Family and key length must be less than %zu bytes\n", sizeof(fullkey) - 3);
        return -1;
    }
 
    fullkey_len = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, key);
 
    ast_mutex_lock(&dblock);
    if (sqlite3_bind_text(del_stmt, 1, fullkey, fullkey_len, SQLITE_STATIC) != SQLITE_OK) {
        ast_log(LOG_WARNING, "Couldn't bind key to stmt: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    } else if (sqlite3_step(del_stmt) != SQLITE_DONE) {
        ast_debug(1, "Unable to find key '%s' in family '%s'\n", key, family);
        res = -1;
    }
    sqlite3_reset(del_stmt);
    db_sync();
    ast_mutex_unlock(&dblock);
 
    return res;
}

References ast_debug, ast_log, ast_mutex_lock, ast_mutex_unlock, astdb, db_sync(), dblock, LOG_WARNING, and MAX_DB_FIELD.

Referenced by __expire_registry(), add_cert_key_to_astdb(), ast_privacy_set(), AST_TEST_DEFINE(), auth_exec(), cache_lookup_internal(), cleanup_cert_from_astdb_and_fs(), destroy_all_channels(), dialgroup_refreshdb(), do_register_expire(), dump_queue_members(), function_db_delete(), handle_dbdel(), media_cache_item_del_from_astdb(), media_cache_remove_from_astdb(), mkintf(), process_clearcache(), reload_queue_members(), sorcery_astdb_delete(), stasis_app_device_state_delete(), and update_registry().

ast_db_del2()

int ast_db_del2	(	const char *	family,
		const char *	key
	)

Same as ast_db_del, but with more stringent error checking.

Unlike ast_db_del, if the key does not exist in the first place, an error is emitted and -1 is returned.

Return values

-1	An error occured (including key not found to begin with)
0	Successfully deleted

Definition at line 504 of file main/db.c.

{
    char fullkey[MAX_DB_FIELD];
    char tmp[1];
    size_t fullkey_len;
    int mres, res = 0;
 
    if (strlen(family) + strlen(key) + 2 > sizeof(fullkey) - 1) {
        ast_log(LOG_WARNING, "Family and key length must be less than %zu bytes\n", sizeof(fullkey) - 3);
        return -1;
    }
 
    fullkey_len = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, key);
 
    ast_mutex_lock(&dblock);
    if (ast_db_get(family, key, tmp, sizeof(tmp))) {
        ast_log(LOG_WARNING, "AstDB key %s does not exist\n", fullkey);
        res = -1;
    } else if (sqlite3_bind_text(del_stmt, 1, fullkey, fullkey_len, SQLITE_STATIC) != SQLITE_OK) {
        ast_log(LOG_WARNING, "Couldn't bind key to stmt: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    } else if ((mres = sqlite3_step(del_stmt) != SQLITE_DONE)) {
        ast_log(LOG_WARNING, "AstDB error (%s): %s\n", fullkey, sqlite3_errstr(mres));
        res = -1;
    }
    sqlite3_reset(del_stmt);
    db_sync();
    ast_mutex_unlock(&dblock);
 
    return res;
}

References ast_db_get(), ast_log, ast_mutex_lock, ast_mutex_unlock, astdb, db_sync(), dblock, LOG_WARNING, MAX_DB_FIELD, and tmp().

Referenced by handle_cli_database_del(), and manager_dbdel().

ast_db_deltree()

int ast_db_deltree	(	const char *	family,
		const char *	keytree
	)

Delete one or more entries in astdb.

If both parameters are NULL, the entire database will be purged. If only keytree is NULL, all entries within the family will be purged. It is an error for keytree to have a value when family is NULL.

Return values

-1	An error occurred
>=	0 Number of records deleted

Definition at line 536 of file main/db.c.

{
    sqlite3_stmt *stmt = deltree_stmt;
    char prefix[MAX_DB_FIELD];
    int res = 0;
 
    if (!ast_strlen_zero(family)) {
        if (!ast_strlen_zero(keytree)) {
            /* Family and key tree */
            snprintf(prefix, sizeof(prefix), "/%s/%s", family, keytree);
        } else {
            /* Family only */
            snprintf(prefix, sizeof(prefix), "/%s", family);
        }
    } else {
        prefix[0] = '\0';
        stmt = deltree_all_stmt;
    }
 
    ast_mutex_lock(&dblock);
    if (!ast_strlen_zero(prefix) && (sqlite3_bind_text(stmt, 1, prefix, -1, SQLITE_STATIC) != SQLITE_OK)) {
        ast_log(LOG_WARNING, "Couldn't bind %s to stmt: %s\n", prefix, sqlite3_errmsg(astdb));
        res = -1;
    } else if (sqlite3_step(stmt) != SQLITE_DONE) {
        ast_log(LOG_WARNING, "Couldn't execute stmt: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    }
    res = sqlite3_changes(astdb);
    sqlite3_reset(stmt);
    db_sync();
    ast_mutex_unlock(&dblock);
 
    return res;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, ast_strlen_zero(), astdb, db_sync(), dblock, LOG_WARNING, MAX_DB_FIELD, and prefix.

Referenced by ast_privacy_reset(), AST_TEST_DEFINE(), cleanup_cert_from_astdb_and_fs(), deinitialize_sorcery(), deltree_exec(), dundi_flush(), handle_cli_database_deltree(), handle_dbdeltree(), iax_provision_reload(), manager_dbdeltree(), media_cache_item_del_from_astdb(), and media_cache_remove_from_astdb().

ast_db_exists()

int ast_db_exists	(	const char *	family,
		const char *	key
	)

Check if family/key exitsts.

Parameters

family
key

Return values

1	if family/key exists
0	if family/key does not exist or an error occurred

Definition at line 444 of file main/db.c.

{
    int result;
    char fullkey[MAX_DB_FIELD];
    size_t fullkey_len;
    int res = 0;
 
    fullkey_len = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, key);
    if (fullkey_len >= sizeof(fullkey)) {
        ast_log(LOG_WARNING, "Family and key length must be less than %zu bytes\n", sizeof(fullkey) - 3);
        return -1;
    }
 
    ast_mutex_lock(&dblock);
    res = sqlite3_bind_text(exists_stmt, 1, fullkey, fullkey_len, SQLITE_STATIC);
    if (res != SQLITE_OK) {
        ast_log(LOG_WARNING, "Couldn't bind key to stmt: %d:%s\n", res, sqlite3_errmsg(astdb));
        res = 0;
    } else if (sqlite3_step(exists_stmt) != SQLITE_ROW) {
        res = 0;
    } else if (!(result = sqlite3_column_int(exists_stmt, 0))) {
        res = 0;
    } else {
        res = result;
    }
    sqlite3_reset(exists_stmt);
    ast_mutex_unlock(&dblock);
 
    return res;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, astdb, dblock, LOG_WARNING, MAX_DB_FIELD, and result.

Referenced by cleanup_cert_from_astdb_and_fs(), and retrieve_cert_from_cache().

ast_db_freetree()

void ast_db_freetree

(

struct ast_db_entry *

entry

)

Free structure created by ast_db_gettree()

Definition at line 677 of file main/db.c.

{
    struct ast_db_entry *last;
    while (dbe) {
        last = dbe;
        dbe = dbe->next;
        ast_free(last);
    }
}

References ast_free, last, and ast_db_entry::next.

Referenced by AST_TEST_DEFINE(), dundi_show_cache(), dundi_show_hints(), function_db_keycount(), function_db_keys(), handle_cli_devstate_list(), handle_cli_presencestate_list(), load_module(), media_cache_item_populate_from_astdb(), media_cache_populate_from_astdb(), populate_cache(), process_clearcache(), reload_queue_members(), sorcery_astdb_retrieve_fields_common(), sorcery_astdb_retrieve_prefix(), sorcery_astdb_retrieve_regex(), and stasis_app_device_states_to_json().

ast_db_get()

int ast_db_get	(	const char *	family,
		const char *	key,
		char *	value,
		int	valuelen
	)

Get key value specified by family/key.

Definition at line 427 of file main/db.c.

{
    ast_assert(value != NULL);
 
    /* Make sure we initialize */
    value[0] = 0;
 
    return db_get_common(family, key, &value, valuelen);
}

References ast_assert, db_get_common(), NULL, and value.

Referenced by ast_db_del2(), ast_pbx_uuid_get(), ast_privacy_check(), AST_TEST_DEFINE(), auth_exec(), blacklist_read(), cache_lookup_internal(), check_access(), create_addr(), custom_devstate_callback(), custom_presence_callback(), database_increment(), destroy_all_channels(), function_db_delete(), function_db_exists(), function_db_read(), handle_cli_database_get(), handle_dbget(), iax_provision_version(), load_password(), manager_dbget(), mkintf(), populate_addr(), refresh_all_favorite(), reg_source_db(), retrieve_cert_from_cache(), sorcery_astdb_delete(), sorcery_astdb_update(), and stasis_device_state_cb().

ast_db_get_allocated()

int ast_db_get_allocated	(	const char *	family,
		const char *	key,
		char **	out
	)

Get key value specified by family/key as a heap allocated string.

Given a family and key, sets out to a pointer to a heap allocated string. In the event of an error, out will be set to NULL. The string must be freed by calling ast_free().

Return values

-1	An error occurred
0	Success

Definition at line 437 of file main/db.c.

{
    *out = NULL;
 
    return db_get_common(family, key, out, -1);
}

References db_get_common(), NULL, and out.

Referenced by AST_TEST_DEFINE(), media_cache_item_del_from_astdb(), reload_queue_members(), and sorcery_astdb_retrieve_id().

ast_db_gettree()

struct ast_db_entry * ast_db_gettree	(	const char *	family,
		const char *	keytree
	)

Get a list of values within the astdb tree.

If family is specified, only those keys will be returned. If keytree is specified, subkeys are expected to exist (separated from the key with a slash). If subkeys do not exist and keytree is specified, the tree will consist of either a single entry or NULL will be returned.

Resulting tree should be freed by passing the return value to ast_db_freetree() when usage is concluded.

Definition at line 610 of file main/db.c.

{
    char prefix[MAX_DB_FIELD];
    sqlite3_stmt *stmt = gettree_stmt;
    size_t res = 0;
    struct ast_db_entry *ret;
 
    if (!ast_strlen_zero(family)) {
        if (!ast_strlen_zero(keytree)) {
            /* Family and key tree */
            res = snprintf(prefix, sizeof(prefix), "/%s/%s", family, keytree);
        } else {
            /* Family only */
            res = snprintf(prefix, sizeof(prefix), "/%s", family);
        }
 
        if (res >= sizeof(prefix)) {
            ast_log(LOG_WARNING, "Requested prefix is too long: %s\n", keytree);
            return NULL;
        }
    } else {
        prefix[0] = '\0';
        stmt = gettree_all_stmt;
    }
 
    ast_mutex_lock(&dblock);
    if (res && (sqlite3_bind_text(stmt, 1, prefix, res, SQLITE_STATIC) != SQLITE_OK)) {
        ast_log(LOG_WARNING, "Could not bind %s to stmt: %s\n", prefix, sqlite3_errmsg(astdb));
        sqlite3_reset(stmt);
        ast_mutex_unlock(&dblock);
        return NULL;
    }
 
    ret = db_gettree_common(stmt);
    sqlite3_reset(stmt);
    ast_mutex_unlock(&dblock);
 
    return ret;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, ast_strlen_zero(), astdb, db_gettree_common(), dblock, LOG_WARNING, MAX_DB_FIELD, NULL, and prefix.

Referenced by AST_TEST_DEFINE(), dundi_show_cache(), dundi_show_hints(), function_db_keycount(), function_db_keys(), handle_cli_devstate_list(), handle_cli_presencestate_list(), load_module(), media_cache_item_populate_from_astdb(), media_cache_populate_from_astdb(), populate_cache(), process_clearcache(), reload_queue_members(), sorcery_astdb_retrieve_fields_common(), sorcery_astdb_retrieve_regex(), and stasis_app_device_states_to_json().

ast_db_gettree_by_prefix()

struct ast_db_entry * ast_db_gettree_by_prefix	(	const char *	family,
		const char *	key_prefix
	)

Get a list of values with the given key prefix.

Parameters

family	The family to search under
key_prefix	The key prefix to search under

Return values

NULL	An error occurred

Definition at line 650 of file main/db.c.

{
    char prefix[MAX_DB_FIELD];
    size_t res;
    struct ast_db_entry *ret;
 
    res = snprintf(prefix, sizeof(prefix), "/%s/%s", family, key_prefix);
    if (res >= sizeof(prefix)) {
        ast_log(LOG_WARNING, "Requested key prefix is too long: %s\n", key_prefix);
        return NULL;
    }
 
    ast_mutex_lock(&dblock);
    if (sqlite3_bind_text(gettree_prefix_stmt, 1, prefix, res, SQLITE_STATIC) != SQLITE_OK) {
        ast_log(LOG_WARNING, "Could not bind %s to stmt: %s\n", prefix, sqlite3_errmsg(astdb));
        sqlite3_reset(gettree_prefix_stmt);
        ast_mutex_unlock(&dblock);
        return NULL;
    }
 
    ret = db_gettree_common(gettree_prefix_stmt);
    sqlite3_reset(gettree_prefix_stmt);
    ast_mutex_unlock(&dblock);
 
    return ret;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, astdb, db_gettree_common(), dblock, LOG_WARNING, MAX_DB_FIELD, NULL, and prefix.

Referenced by sorcery_astdb_retrieve_prefix().

ast_db_put()

int ast_db_put	(	const char *	family,
		const char *	key,
		const char *	value
	)

Store value addressed by family/key.

Definition at line 342 of file main/db.c.

{
    char fullkey[MAX_DB_FIELD];
    size_t fullkey_len;
    int res = 0;
 
    if (strlen(family) + strlen(key) + 2 > sizeof(fullkey) - 1) {
        ast_log(LOG_WARNING, "Family and key length must be less than %zu bytes\n", sizeof(fullkey) - 3);
        return -1;
    }
 
    fullkey_len = snprintf(fullkey, sizeof(fullkey), "/%s/%s", family, key);
 
    ast_mutex_lock(&dblock);
    if (sqlite3_bind_text(put_stmt, 1, fullkey, fullkey_len, SQLITE_STATIC) != SQLITE_OK) {
        ast_log(LOG_WARNING, "Couldn't bind key to stmt: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    } else if (sqlite3_bind_text(put_stmt, 2, value, -1, SQLITE_STATIC) != SQLITE_OK) {
        ast_log(LOG_WARNING, "Couldn't bind value to stmt: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    } else if (sqlite3_step(put_stmt) != SQLITE_DONE) {
        ast_log(LOG_WARNING, "Couldn't execute statement: %s\n", sqlite3_errmsg(astdb));
        res = -1;
    }
 
    sqlite3_reset(put_stmt);
    db_sync();
    ast_mutex_unlock(&dblock);
 
    return res;
}

References ast_log, ast_mutex_lock, ast_mutex_unlock, astdb, db_sync(), dblock, LOG_WARNING, MAX_DB_FIELD, and value.

Referenced by __analog_ss_thread(), add_cert_expiration_to_astdb(), add_cert_key_to_astdb(), ast_privacy_set(), AST_TEST_DEFINE(), asterisk_daemon(), cache_save(), cache_save_hint(), database_increment(), devstate_write(), dialgroup_refreshdb(), dump_queue_members(), function_db_write(), handle_cli_database_put(), handle_cli_devstate_change(), handle_cli_presencestate_change(), handle_command_response(), handle_dbput(), iax_provision_build(), manager_dbput(), media_cache_item_sync_to_astdb(), metadata_sync_to_astdb(), presence_write(), save_secret(), sorcery_astdb_create(), stasis_app_device_state_update(), and update_registry().