func_odbc.c File Reference

ODBC lookups. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/config.h"
#include "asterisk/res_odbc.h"
#include "asterisk/res_odbc_transaction.h"
#include "asterisk/app.h"
#include "asterisk/cli.h"
#include "asterisk/strings.h"

Include dependency graph for func_odbc.c:

Go to the source code of this file.

Data Structures
struct	acf_odbc_query
struct	dsn
	Data source name. More...
struct	odbc_datastore
struct	odbc_datastore_row
struct	queries

Macros
#define	DEFAULT_SINGLE_DB_CONNECTION   0
#define	DSN_BUCKETS   37

Enumerations
enum	odbc_option_flags { OPT_ESCAPECOMMAS = (1 << 0) , OPT_MULTIROW = (1 << 1) }

Functions
static void	__init_coldata_buf (void)
static void	__init_colnames_buf (void)
static void	__init_sql2_buf (void)
static void	__init_sql_buf (void)
static void	__reg_module (void)
static void	__unreg_module (void)
static int	acf_escape (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len, char character)
static int	acf_escape_backslashes (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	acf_escape_ticks (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	acf_fetch (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int	acf_odbc_read (struct ast_channel *chan, const char *cmd, char *s, char *buf, size_t len)
static int	acf_odbc_write (struct ast_channel *chan, const char *cmd, char *s, const char *value)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static char *	cli_odbc_read (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	cli_odbc_write (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	connection_dead (struct odbc_obj *connection)
	Determine if the connection has died. More...
static struct dsn *	create_dsn (const char *name)
	Create a DSN and connect to the database. More...
static int	dsn_cmp (void *obj, void *arg, int flags)
static void	dsn_destructor (void *obj)
static int	dsn_hash (const void *obj, const int flags)
static int	exec_odbcfinish (struct ast_channel *chan, const char *data)
static SQLHSTMT	execute (struct odbc_obj *obj, void *data, int silent)
	Common execution function for SQL queries. More...
static int	free_acf_query (struct acf_odbc_query *query)
static SQLHSTMT	generic_execute (struct odbc_obj *obj, void *data)
static struct dsn *	get_dsn (const char *name)
	Retrieve a DSN, or create it if it does not exist. More...
static struct odbc_obj *	get_odbc_obj (const char *dsn_name, struct dsn **dsn)
	Get a DB handle via a DSN or directly. More...
static int	init_acf_query (struct ast_config *cfg, char *catg, struct acf_odbc_query **query)
static int	load_module (void)
static void	odbc_datastore_free (void *data)
static void	release_obj_or_dsn (struct odbc_obj **obj, struct dsn **dsn)
	Release an ODBC obj or a DSN. More...
static int	reload (void)
static SQLHSTMT	silent_execute (struct odbc_obj *obj, void *data)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "ODBC lookups" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload, .requires = "res_odbc", }
static char *	app_odbcfinish = "ODBCFinish"
static const struct ast_module_info *	ast_module_info = &__mod_info
static struct ast_cli_entry	cli_func_odbc []
static struct ast_threadstorage	coldata_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_coldata_buf , .custom_init = NULL , }
static struct ast_threadstorage	colnames_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_colnames_buf , .custom_init = NULL , }
static char *	config = "func_odbc.conf"
struct ao2_container *	dsns
static struct ast_custom_function	escape_backslashes_function
static struct ast_custom_function	escape_function
static struct ast_custom_function	fetch_function
static const struct ast_datastore_info	odbc_info
static struct queries	queries = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static int	resultcount = 0
static int	single_db_connection
static ast_rwlock_t	single_db_connection_lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} }
static struct ast_threadstorage	sql2_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_sql2_buf , .custom_init = NULL , }
static struct ast_threadstorage	sql_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_sql_buf , .custom_init = NULL , }

Detailed Description

ODBC lookups.

Author

Tilghman Lesher func_.nosp@m.odbc.nosp@m.__200.nosp@m.508@.nosp@m.the-t.nosp@m.ilgh.nosp@m.man.c.nosp@m.om

Definition in file func_odbc.c.

Macro Definition Documentation

DEFAULT_SINGLE_DB_CONNECTION

#define DEFAULT_SINGLE_DB_CONNECTION   0

Definition at line 120 of file func_odbc.c.

DSN_BUCKETS

#define DSN_BUCKETS   37

Definition at line 174 of file func_odbc.c.

Enumeration Type Documentation

odbc_option_flags

enum odbc_option_flags

Enumerator
OPT_ESCAPECOMMAS
OPT_MULTIROW

Definition at line 126 of file func_odbc.c.

                       {
    OPT_ESCAPECOMMAS =  (1 << 0),
    OPT_MULTIROW     =  (1 << 1),
};

Function Documentation

__init_coldata_buf()

static void __init_coldata_buf ( void  )

static

Definition at line 439 of file func_odbc.c.

{

__init_colnames_buf()

static void __init_colnames_buf ( void  )

static

Definition at line 440 of file func_odbc.c.

{

__init_sql2_buf()

static void __init_sql2_buf ( void  )

static

Definition at line 438 of file func_odbc.c.

{

__init_sql_buf()

static void __init_sql_buf ( void  )

static

Definition at line 437 of file func_odbc.c.

{

__reg_module()

static void __reg_module ( void  )

static

Definition at line 2013 of file func_odbc.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 2013 of file func_odbc.c.

acf_escape()

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

static

Definition at line 1122 of file func_odbc.c.

{
    char *out = buf;
 
    for (; *data && out - buf < len; data++) {
        if (*data == character) {
            *out = character;
            out++;
        }
        *out++ = *data;
    }
    *out = '\0';
 
    return 0;
}

References buf, ast_datastore::data, len(), and out.

Referenced by acf_escape_backslashes(), and acf_escape_ticks().

acf_escape_backslashes()

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

static

Definition at line 1149 of file func_odbc.c.

{
    return acf_escape(chan, cmd, data, buf, len, '\\');
}

References acf_escape(), buf, and len().

acf_escape_ticks()

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

static

Definition at line 1138 of file func_odbc.c.

{
    return acf_escape(chan, cmd, data, buf, len, '\'');
}

References acf_escape(), buf, ast_datastore::data, and len().

acf_fetch()

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

static

Definition at line 1160 of file func_odbc.c.

{
    struct ast_datastore *store;
    struct odbc_datastore *resultset;
    struct odbc_datastore_row *row;
 
    if (!chan) {
        ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
        return -1;
    }
 
    ast_channel_lock(chan);
    store = ast_channel_datastore_find(chan, &odbc_info, data);
    if (!store) {
        ast_channel_unlock(chan);
        pbx_builtin_setvar_helper(chan, "ODBC_FETCH_STATUS", "FAILURE");
        return -1;
    }
    resultset = store->data;
    AST_LIST_LOCK(resultset);
    row = AST_LIST_REMOVE_HEAD(resultset, list);
    AST_LIST_UNLOCK(resultset);
    if (!row) {
        /* Cleanup datastore */
        ast_channel_datastore_remove(chan, store);
        ast_datastore_free(store);
        ast_channel_unlock(chan);
        pbx_builtin_setvar_helper(chan, "ODBC_FETCH_STATUS", "FAILURE");
        return -1;
    }
    pbx_builtin_setvar_helper(chan, "~ODBCFIELDS~", resultset->names);
    ast_channel_unlock(chan);
    ast_copy_string(buf, row->data, len);
    ast_free(row);
    pbx_builtin_setvar_helper(chan, "ODBC_FETCH_STATUS", "SUCCESS");
    return 0;
}

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), ast_datastore_free(), ast_free, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log, buf, odbc_datastore_row::data, ast_datastore::data, len(), odbc_datastore_row::list, LOG_WARNING, odbc_datastore::names, odbc_info, and pbx_builtin_setvar_helper().

Referenced by acf_odbc_read().

acf_odbc_read()

static int acf_odbc_read ( struct ast_channel *  chan, const char *  cmd, char *  s, char *  buf, size_t  len  )

static

Definition at line 742 of file func_odbc.c.

{
    struct odbc_obj *obj = NULL;
    struct acf_odbc_query *query;
    char varname[15], rowcount[12] = "-1";
    struct ast_str *colnames = ast_str_thread_get(&colnames_buf, 16);
    int res, x, y, buflen = 0, escapecommas, rowlimit = 1, multirow = 0, dsn_num, bogus_chan = 0;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(field)[100];
    );
    SQLHSTMT stmt = NULL;
    SQLSMALLINT colcount=0;
    SQLLEN indicator;
    SQLSMALLINT collength;
    struct odbc_datastore *resultset = NULL;
    struct odbc_datastore_row *row = NULL;
    struct ast_str *sql = ast_str_thread_get(&sql_buf, 16);
    const char *status = "FAILURE";
    struct dsn *dsn = NULL;
 
    if (!sql || !colnames) {
        if (chan) {
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
        }
        return -1;
    }
 
    ast_str_reset(colnames);
 
    AST_RWLIST_RDLOCK(&queries);
    AST_RWLIST_TRAVERSE(&queries, query, list) {
        if (!strcmp(query->acf->name, cmd)) {
            break;
        }
    }
 
    if (!query) {
        ast_log(LOG_ERROR, "No such function '%s'\n", cmd);
        AST_RWLIST_UNLOCK(&queries);
        if (chan) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
        }
        return -1;
    }
 
    AST_STANDARD_APP_ARGS(args, s);
    if (args.argc < query->minargs) {
        ast_log(LOG_ERROR, "%d arguments supplied to '%s' requiring minimum %d\n",
                args.argc, cmd, query->minargs);
        AST_RWLIST_UNLOCK(&queries);
        return -1;
    }
 
    if (!chan) {
        if (!(chan = ast_dummy_channel_alloc())) {
            AST_RWLIST_UNLOCK(&queries);
            return -1;
        }
        bogus_chan = 1;
    }
 
    if (!bogus_chan) {
        ast_autoservice_start(chan);
    }
 
    snprintf(varname, sizeof(varname), "%u", args.argc);
    pbx_builtin_pushvar_helper(chan, "ARGC", varname);
    for (x = 0; x < args.argc; x++) {
        snprintf(varname, sizeof(varname), "ARG%d", x + 1);
        pbx_builtin_pushvar_helper(chan, varname, args.field[x]);
    }
 
    ast_str_substitute_variables(&sql, 0, chan, query->sql_read);
 
    if (bogus_chan) {
        chan = ast_channel_unref(chan);
    } else {
        /* Restore prior values */
        pbx_builtin_setvar_helper(chan, "ARGC", NULL);
 
        for (x = 0; x < args.argc; x++) {
            snprintf(varname, sizeof(varname), "ARG%d", x + 1);
            pbx_builtin_setvar_helper(chan, varname, NULL);
        }
    }
 
    /* Save these flags, so we can release the lock */
    escapecommas = ast_test_flag(query, OPT_ESCAPECOMMAS);
    if (!bogus_chan && ast_test_flag(query, OPT_MULTIROW)) {
        if (!(resultset = ast_calloc(1, sizeof(*resultset)))) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
            AST_RWLIST_UNLOCK(&queries);
            ast_autoservice_stop(chan);
            return -1;
        }
        AST_LIST_HEAD_INIT(resultset);
        if (query->rowlimit) {
            rowlimit = query->rowlimit;
        } else {
            rowlimit = INT_MAX;
        }
        multirow = 1;
    } else if (!bogus_chan) {
        if (query->rowlimit > 1) {
            rowlimit = query->rowlimit;
            if (!(resultset = ast_calloc(1, sizeof(*resultset)))) {
                pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
                pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
                AST_RWLIST_UNLOCK(&queries);
                ast_autoservice_stop(chan);
                return -1;
            }
            AST_LIST_HEAD_INIT(resultset);
        }
    }
    AST_RWLIST_UNLOCK(&queries);
 
    for (dsn_num = 0; dsn_num < 5; dsn_num++) {
        if (!ast_strlen_zero(query->readhandle[dsn_num])) {
            obj = get_odbc_obj(query->readhandle[dsn_num], &dsn);
            if (!obj) {
                continue;
            }
            stmt = ast_odbc_direct_execute(obj, generic_execute, ast_str_buffer(sql));
        }
        if (stmt) {
            break;
        }
        release_obj_or_dsn (&obj, &dsn);
    }
 
    if (!stmt) {
        ast_log(LOG_ERROR, "Unable to execute query [%s]\n", ast_str_buffer(sql));
        release_obj_or_dsn (&obj, &dsn);
        if (!bogus_chan) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
            ast_autoservice_stop(chan);
        }
        odbc_datastore_free(resultset);
        return -1;
    }
 
    res = SQLNumResultCols(stmt, &colcount);
    if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
        ast_log(LOG_WARNING, "SQL Column Count error!\n[%s]\n\n", ast_str_buffer(sql));
        SQLCloseCursor(stmt);
        SQLFreeHandle (SQL_HANDLE_STMT, stmt);
        release_obj_or_dsn (&obj, &dsn);
        if (!bogus_chan) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
            ast_autoservice_stop(chan);
        }
        odbc_datastore_free(resultset);
        return -1;
    }
 
    if (colcount <= 0) {
        ast_verb(4, "Returned %d columns [%s]\n", colcount, ast_str_buffer(sql));
        buf[0] = '\0';
        SQLCloseCursor(stmt);
        SQLFreeHandle (SQL_HANDLE_STMT, stmt);
        release_obj_or_dsn (&obj, &dsn);
        if (!bogus_chan) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", "0");
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", "NODATA");
            ast_autoservice_stop(chan);
        }
        odbc_datastore_free(resultset);
        return 0;
    }
 
    res = SQLFetch(stmt);
    if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
        int res1 = -1;
        if (res == SQL_NO_DATA) {
            ast_verb(4, "Found no rows [%s]\n", ast_str_buffer(sql));
            res1 = 0;
            buf[0] = '\0';
            ast_copy_string(rowcount, "0", sizeof(rowcount));
            status = "NODATA";
        } else {
            ast_log(LOG_WARNING, "Error %d in FETCH [%s]\n", res, ast_str_buffer(sql));
            status = "FETCHERROR";
        }
        SQLCloseCursor(stmt);
        SQLFreeHandle(SQL_HANDLE_STMT, stmt);
        release_obj_or_dsn (&obj, &dsn);
        if (!bogus_chan) {
            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
            ast_autoservice_stop(chan);
        }
        odbc_datastore_free(resultset);
        return res1;
    }
 
    status = "SUCCESS";
 
    for (y = 0; y < rowlimit; y++) {
        buf[0] = '\0';
        for (x = 0; x < colcount; x++) {
            int i;
            struct ast_str *coldata = ast_str_thread_get(&coldata_buf, 16);
            char *ptrcoldata;
 
            if (!coldata) {
                odbc_datastore_free(resultset);
                SQLCloseCursor(stmt);
                SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                release_obj_or_dsn (&obj, &dsn);
                if (!bogus_chan) {
                    pbx_builtin_setvar_helper(chan, "ODBCSTATUS", "MEMERROR");
                    ast_autoservice_stop(chan);
                }
                return -1;
            }
 
            if (y == 0) {
                char colname[256];
                SQLLEN octetlength = 0;
 
                res = SQLDescribeCol(stmt, x + 1, (unsigned char *)colname, sizeof(colname), &collength, NULL, NULL, NULL, NULL);
                ast_debug(3, "Got collength of %d for column '%s' (offset %d)\n", (int)collength, colname, x);
                if (((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) || collength == 0) {
                    snprintf(colname, sizeof(colname), "field%d", x);
                }
 
                SQLColAttribute(stmt, x + 1, SQL_DESC_OCTET_LENGTH, NULL, 0, NULL, &octetlength);
 
                ast_str_make_space(&coldata, octetlength + 1);
 
                if (ast_str_strlen(colnames)) {
                    ast_str_append(&colnames, 0, ",");
                }
                ast_str_append_escapecommas(&colnames, 0, colname, sizeof(colname));
 
                if (resultset) {
                    void *tmp = ast_realloc(resultset, sizeof(*resultset) + ast_str_strlen(colnames) + 1);
                    if (!tmp) {
                        ast_log(LOG_ERROR, "No space for a new resultset?\n");
                        odbc_datastore_free(resultset);
                        SQLCloseCursor(stmt);
                        SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                        release_obj_or_dsn (&obj, &dsn);
                        if (!bogus_chan) {
                            pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
                            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", "MEMERROR");
                            ast_autoservice_stop(chan);
                        }
                        return -1;
                    }
                    resultset = tmp;
                    strcpy((char *)resultset + sizeof(*resultset), ast_str_buffer(colnames));
                }
            }
 
            buflen = strlen(buf);
            res = ast_odbc_ast_str_SQLGetData(&coldata, -1, stmt, x + 1, SQL_CHAR, &indicator);
            if (indicator == SQL_NULL_DATA) {
                ast_debug(3, "Got NULL data\n");
                ast_str_reset(coldata);
                res = SQL_SUCCESS;
            }
 
            if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                ast_log(LOG_WARNING, "SQL Get Data error!\n[%s]\n\n", ast_str_buffer(sql));
                y = -1;
                buf[0] = '\0';
                goto end_acf_read;
            }
 
            ast_debug(2, "Got coldata of '%s'\n", ast_str_buffer(coldata));
 
            if (x) {
                buf[buflen++] = ',';
            }
 
            /* Copy data, encoding '\' and ',' for the argument parser */
            ptrcoldata = ast_str_buffer(coldata);
            for (i = 0; i < ast_str_strlen(coldata); i++) {
                if (escapecommas && (ptrcoldata[i] == '\\' || ptrcoldata[i] == ',')) {
                    buf[buflen++] = '\\';
                }
                buf[buflen++] = ptrcoldata[i];
 
                if (buflen >= len - 2) {
                    break;
                }
 
                if (ptrcoldata[i] == '\0') {
                    break;
                }
            }
 
            buf[buflen] = '\0';
            ast_debug(2, "buf is now set to '%s'\n", buf);
        }
        ast_debug(2, "buf is now set to '%s'\n", buf);
 
        if (resultset) {
            row = ast_calloc(1, sizeof(*row) + buflen + 1);
            if (!row) {
                ast_log(LOG_ERROR, "Unable to allocate space for more rows in this resultset.\n");
                status = "MEMERROR";
                goto end_acf_read;
            }
            strcpy((char *)row + sizeof(*row), buf);
            AST_LIST_INSERT_TAIL(resultset, row, list);
 
            /* Get next row */
            res = SQLFetch(stmt);
            if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                if (res != SQL_NO_DATA) {
                    ast_log(LOG_WARNING, "Error %d in FETCH [%s]\n", res, ast_str_buffer(sql));
                }
                /* Number of rows in the resultset */
                y++;
                break;
            }
        }
    }
 
end_acf_read:
    if (!bogus_chan) {
        snprintf(rowcount, sizeof(rowcount), "%d", y);
        pbx_builtin_setvar_helper(chan, "ODBCROWS", rowcount);
        pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
        pbx_builtin_setvar_helper(chan, "~ODBCFIELDS~", ast_str_buffer(colnames));
        if (resultset) {
            struct ast_datastore *odbc_store;
            if (multirow) {
                int uid;
                uid = ast_atomic_fetchadd_int(&resultcount, +1) + 1;
                snprintf(buf, len, "%d", uid);
            } else {
                /* Name of the query is name of the resultset */
                ast_copy_string(buf, cmd, len);
 
                /* If there's one with the same name already, free it */
                ast_channel_lock(chan);
                if ((odbc_store = ast_channel_datastore_find(chan, &odbc_info, buf))) {
                    ast_channel_datastore_remove(chan, odbc_store);
                    ast_datastore_free(odbc_store);
                }
                ast_channel_unlock(chan);
            }
            odbc_store = ast_datastore_alloc(&odbc_info, buf);
            if (!odbc_store) {
                ast_log(LOG_ERROR, "Rows retrieved, but unable to store it in the channel.  Results fail.\n");
                odbc_datastore_free(resultset);
                SQLCloseCursor(stmt);
                SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                release_obj_or_dsn (&obj, &dsn);
                pbx_builtin_setvar_helper(chan, "ODBCSTATUS", "MEMERROR");
                ast_autoservice_stop(chan);
                return -1;
            }
            odbc_store->data = resultset;
            ast_channel_lock(chan);
            ast_channel_datastore_add(chan, odbc_store);
            ast_channel_unlock(chan);
        }
    }
    SQLCloseCursor(stmt);
    SQLFreeHandle(SQL_HANDLE_STMT, stmt);
    release_obj_or_dsn (&obj, &dsn);
    if (resultset && !multirow) {
        /* Fetch the first resultset */
        if (!acf_fetch(chan, "", buf, buf, len)) {
            buf[0] = '\0';
        }
    }
    if (!bogus_chan) {
        ast_autoservice_stop(chan);
    }
    return 0;
}

References acf_fetch(), args, AST_APP_ARG, ast_atomic_fetchadd_int(), ast_autoservice_start(), ast_autoservice_stop(), ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_channel_unref, ast_copy_string(), ast_datastore_alloc, ast_datastore_free(), ast_debug, AST_DECLARE_APP_ARGS, ast_dummy_channel_alloc, AST_LIST_HEAD_INIT, AST_LIST_INSERT_TAIL, ast_log, ast_odbc_ast_str_SQLGetData(), ast_odbc_direct_execute(), ast_realloc, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_STANDARD_APP_ARGS, ast_str_append(), ast_str_append_escapecommas(), ast_str_buffer(), ast_str_make_space, ast_str_reset(), ast_str_strlen(), ast_str_substitute_variables(), ast_str_thread_get(), ast_strlen_zero(), ast_test_flag, ast_verb, buf, coldata_buf, colnames_buf, ast_datastore::data, generic_execute(), get_odbc_obj(), indicator, len(), LOG_ERROR, LOG_WARNING, NULL, odbc_datastore_free(), odbc_info, OPT_ESCAPECOMMAS, OPT_MULTIROW, pbx_builtin_pushvar_helper(), pbx_builtin_setvar_helper(), release_obj_or_dsn(), resultcount, sql_buf, status, tmp(), and ast_datastore::uid.

Referenced by init_acf_query().

acf_odbc_write()

static int acf_odbc_write ( struct ast_channel *  chan, const char *  cmd, char *  s, const char *  value  )

static

Note

Okay, this part is confusing. Transactions belong to a single database handle. Therefore, when working with transactions, we CANNOT failover to multiple DSNs. We MUST have a single handle all the way through the transaction, or else we CANNOT enforce atomicity.

Definition at line 526 of file func_odbc.c.

{
    struct odbc_obj *obj = NULL;
    struct acf_odbc_query *query;
    char *t, varname[15];
    int i, dsn_num, bogus_chan = 0;
    int transactional = 0;
    AST_DECLARE_APP_ARGS(values,
        AST_APP_ARG(field)[100];
    );
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(field)[100];
    );
    SQLHSTMT stmt = NULL;
    SQLLEN rows=0;
    struct ast_str *buf = ast_str_thread_get(&sql_buf, 16);
    struct ast_str *insertbuf = ast_str_thread_get(&sql2_buf, 16);
    const char *status = "FAILURE";
    struct dsn *dsn = NULL;
 
    if (!buf || !insertbuf) {
        return -1;
    }
 
    AST_RWLIST_RDLOCK(&queries);
    AST_RWLIST_TRAVERSE(&queries, query, list) {
        if (!strcmp(query->acf->name, cmd)) {
            break;
        }
    }
 
    if (!query) {
        ast_log(LOG_ERROR, "No such function '%s'\n", cmd);
        AST_RWLIST_UNLOCK(&queries);
        if (chan) {
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
        }
        return -1;
    }
 
    AST_STANDARD_APP_ARGS(args, s);
    if (args.argc < query->minargs) {
        ast_log(LOG_ERROR, "%d arguments supplied to '%s' requiring minimum %d\n",
                args.argc, cmd, query->minargs);
        AST_RWLIST_UNLOCK(&queries);
        return -1;
    }
 
    if (!chan) {
        if (!(chan = ast_dummy_channel_alloc())) {
            AST_RWLIST_UNLOCK(&queries);
            return -1;
        }
        bogus_chan = 1;
    }
 
    if (!bogus_chan) {
        ast_autoservice_start(chan);
    }
 
    ast_str_make_space(&buf, strlen(query->sql_write) * 2 + 300);
    /* We only get here if sql_write is set. sql_insert is optional however. */
    if (query->sql_insert) {
        ast_str_make_space(&insertbuf, strlen(query->sql_insert) * 2 + 300);
    }
 
    /* Parse our arguments */
    t = value ? ast_strdupa(value) : "";
 
    if (!s || !t) {
        ast_log(LOG_ERROR, "Out of memory\n");
        AST_RWLIST_UNLOCK(&queries);
        if (!bogus_chan) {
            ast_autoservice_stop(chan);
            pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
        } else {
            ast_channel_unref(chan);
        }
        return -1;
    }
 
    snprintf(varname, sizeof(varname), "%u", args.argc);
    pbx_builtin_pushvar_helper(chan, "ARGC", varname);
    for (i = 0; i < args.argc; i++) {
        snprintf(varname, sizeof(varname), "ARG%d", i + 1);
        pbx_builtin_pushvar_helper(chan, varname, args.field[i]);
    }
 
    /* Parse values, just like arguments */
    AST_STANDARD_APP_ARGS(values, t);
    for (i = 0; i < values.argc; i++) {
        snprintf(varname, sizeof(varname), "VAL%d", i + 1);
        pbx_builtin_pushvar_helper(chan, varname, values.field[i]);
    }
 
    /* Additionally set the value as a whole (but push an empty string if value is NULL) */
    pbx_builtin_pushvar_helper(chan, "VALUE", value ? value : "");
 
    ast_str_substitute_variables(&buf, 0, chan, query->sql_write);
    if (query->sql_insert) {
        ast_str_substitute_variables(&insertbuf, 0, chan, query->sql_insert);
    }
 
    if (bogus_chan) {
        chan = ast_channel_unref(chan);
    } else {
        /* Restore prior values */
        pbx_builtin_setvar_helper(chan, "ARGC", NULL);
 
        for (i = 0; i < args.argc; i++) {
            snprintf(varname, sizeof(varname), "ARG%d", i + 1);
            pbx_builtin_setvar_helper(chan, varname, NULL);
        }
 
        for (i = 0; i < values.argc; i++) {
            snprintf(varname, sizeof(varname), "VAL%d", i + 1);
            pbx_builtin_setvar_helper(chan, varname, NULL);
        }
        pbx_builtin_setvar_helper(chan, "VALUE", NULL);
    }
 
    /*!\note
     * Okay, this part is confusing.  Transactions belong to a single database
     * handle.  Therefore, when working with transactions, we CANNOT failover
     * to multiple DSNs.  We MUST have a single handle all the way through the
     * transaction, or else we CANNOT enforce atomicity.
     */
    for (dsn_num = 0; dsn_num < 5; dsn_num++) {
        if (!ast_strlen_zero(query->writehandle[dsn_num])) {
            if (transactional) {
                /* This can only happen second time through or greater. */
                ast_log(LOG_WARNING, "Transactions do not work well with multiple DSNs for 'writehandle'\n");
            }
 
            if ((obj = ast_odbc_retrieve_transaction_obj(chan, query->writehandle[dsn_num]))) {
                transactional = 1;
            } else {
                obj = get_odbc_obj(query->writehandle[dsn_num], &dsn);
                transactional = 0;
            }
 
            if (obj && (stmt = ast_odbc_direct_execute(obj, generic_execute, ast_str_buffer(buf)))) {
                break;
            }
            if (!transactional) {
                release_obj_or_dsn (&obj, &dsn);
            }
        }
    }
 
    if (stmt) {
        SQLRowCount(stmt, &rows);
        SQLCloseCursor(stmt);
        SQLFreeHandle(SQL_HANDLE_STMT, stmt);
 
        if (rows != 0) {
            status = "SUCCESS";
 
        } else if (query->sql_insert) {
            if (!transactional) {
                release_obj_or_dsn (&obj, &dsn);
            }
 
            for (transactional = 0, dsn_num = 0; dsn_num < 5; dsn_num++) {
                if (!ast_strlen_zero(query->writehandle[dsn_num])) {
                    if (transactional) {
                        /* This can only happen second time through or greater. */
                        ast_log(LOG_WARNING, "Transactions do not work well with multiple DSNs for 'writehandle'\n");
                    } else {
                        release_obj_or_dsn (&obj, &dsn);
                    }
 
                    if ((obj = ast_odbc_retrieve_transaction_obj(chan, query->writehandle[dsn_num]))) {
                        transactional = 1;
                    } else {
                        obj = get_odbc_obj(query->writehandle[dsn_num], &dsn);
                        transactional = 0;
                    }
                    if (obj) {
                        stmt = ast_odbc_direct_execute(obj, generic_execute, ast_str_buffer(insertbuf));
                    }
                }
                if (stmt) {
                    status = "FAILOVER";
                    SQLRowCount(stmt, &rows);
                    SQLCloseCursor(stmt);
                    SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                    break;
                }
            }
        }
    }
 
    AST_RWLIST_UNLOCK(&queries);
 
    /* Output the affected rows, for all cases.  In the event of failure, we
     * flag this as -1 rows.  Note that this is different from 0 affected rows
     * which would be the case if we succeeded in our query, but the values did
     * not change. */
    if (!bogus_chan) {
        snprintf(varname, sizeof(varname), "%d", (int)rows);
        pbx_builtin_setvar_helper(chan, "ODBCROWS", varname);
        pbx_builtin_setvar_helper(chan, "ODBCSTATUS", status);
    }
 
    if (!transactional) {
        release_obj_or_dsn (&obj, &dsn);
    }
 
    if (!bogus_chan) {
        ast_autoservice_stop(chan);
    }
 
    return 0;
}

References args, AST_APP_ARG, ast_autoservice_start(), ast_autoservice_stop(), ast_channel_unref, AST_DECLARE_APP_ARGS, ast_dummy_channel_alloc, ast_log, ast_odbc_direct_execute(), ast_odbc_retrieve_transaction_obj(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_STANDARD_APP_ARGS, ast_str_buffer(), ast_str_make_space, ast_str_substitute_variables(), ast_str_thread_get(), ast_strdupa, ast_strlen_zero(), buf, generic_execute(), get_odbc_obj(), LOG_ERROR, LOG_WARNING, NULL, pbx_builtin_pushvar_helper(), pbx_builtin_setvar_helper(), release_obj_or_dsn(), sql2_buf, sql_buf, status, and value.

Referenced by init_acf_query().

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 2013 of file func_odbc.c.

cli_odbc_read()

static char * cli_odbc_read ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 1463 of file func_odbc.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(field)[100];
    );
    struct ast_str *sql;
    char *char_args, varname[15];
    struct acf_odbc_query *query;
    struct ast_channel *chan;
    int i;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "odbc read";
        e->usage =
            "Usage: odbc read <name> <args> [exec]\n"
            "       Evaluates the SQL provided in the ODBC function <name>, and\n"
            "       optionally executes the function.  This function is intended for\n"
            "       testing purposes.  Remember to quote arguments containing spaces.\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 2) {
            int wordlen = strlen(a->word), which = 0;
            /* Complete function name */
            AST_RWLIST_RDLOCK(&queries);
            AST_RWLIST_TRAVERSE(&queries, query, list) {
                if (!strncasecmp(query->acf->name, a->word, wordlen)) {
                    if (++which > a->n) {
                        char *res = ast_strdup(query->acf->name);
                        AST_RWLIST_UNLOCK(&queries);
                        return res;
                    }
                }
            }
            AST_RWLIST_UNLOCK(&queries);
            return NULL;
        } else if (a->pos == 4) {
            static const char * const completions[] = { "exec", NULL };
            return ast_cli_complete(a->word, completions, a->n);
        } else {
            return NULL;
        }
    }
 
    if (a->argc < 4 || a->argc > 5) {
        return CLI_SHOWUSAGE;
    }
 
    sql = ast_str_thread_get(&sql_buf, 16);
    if (!sql) {
        return CLI_FAILURE;
    }
 
    AST_RWLIST_RDLOCK(&queries);
    AST_RWLIST_TRAVERSE(&queries, query, list) {
        if (!strcmp(query->acf->name, a->argv[2])) {
            break;
        }
    }
 
    if (!query) {
        ast_cli(a->fd, "No such query '%s'\n", a->argv[2]);
        AST_RWLIST_UNLOCK(&queries);
        return CLI_SHOWUSAGE;
    }
 
    if (!query->sql_read) {
        ast_cli(a->fd, "The function %s has no readsql parameter.\n", a->argv[2]);
        AST_RWLIST_UNLOCK(&queries);
        return CLI_SUCCESS;
    }
 
    ast_str_make_space(&sql, strlen(query->sql_read) * 2 + 300);
 
    /* Evaluate function */
    char_args = ast_strdupa(a->argv[3]);
 
    chan = ast_dummy_channel_alloc();
    if (!chan) {
        AST_RWLIST_UNLOCK(&queries);
        return CLI_FAILURE;
    }
 
    AST_STANDARD_APP_ARGS(args, char_args);
    for (i = 0; i < args.argc; i++) {
        snprintf(varname, sizeof(varname), "ARG%d", i + 1);
        pbx_builtin_pushvar_helper(chan, varname, args.field[i]);
    }
 
    ast_str_substitute_variables(&sql, 0, chan, query->sql_read);
    chan = ast_channel_unref(chan);
 
    if (a->argc == 5 && !strcmp(a->argv[4], "exec")) {
        /* Execute the query */
        struct odbc_obj *obj = NULL;
        struct dsn *dsn = NULL;
        int dsn_num, executed = 0;
        SQLHSTMT stmt;
        int rows = 0, res, x;
        SQLSMALLINT colcount = 0, collength;
        SQLLEN indicator, octetlength;
        struct ast_str *coldata = ast_str_thread_get(&coldata_buf, 16);
        char colname[256];
 
        if (!coldata) {
            AST_RWLIST_UNLOCK(&queries);
            return CLI_SUCCESS;
        }
 
        for (dsn_num = 0; dsn_num < 5; dsn_num++) {
            if (ast_strlen_zero(query->readhandle[dsn_num])) {
                continue;
            }
            obj = get_odbc_obj(query->readhandle[dsn_num], &dsn);
            if (!obj) {
                continue;
            }
            ast_debug(1, "Found handle %s\n", query->readhandle[dsn_num]);
 
            if (!(stmt = ast_odbc_direct_execute(obj, generic_execute, ast_str_buffer(sql)))) {
                release_obj_or_dsn (&obj, &dsn);
                continue;
            }
 
            executed = 1;
 
            res = SQLNumResultCols(stmt, &colcount);
            if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                ast_cli(a->fd, "SQL Column Count error!\n[%s]\n\n", ast_str_buffer(sql));
                SQLCloseCursor(stmt);
                SQLFreeHandle (SQL_HANDLE_STMT, stmt);
                release_obj_or_dsn (&obj, &dsn);
                AST_RWLIST_UNLOCK(&queries);
                return CLI_SUCCESS;
            }
 
            if (colcount <= 0) {
                SQLCloseCursor(stmt);
                SQLFreeHandle (SQL_HANDLE_STMT, stmt);
                release_obj_or_dsn (&obj, &dsn);
                ast_cli(a->fd, "Returned %d columns.  Query executed on handle %d:%s [%s]\n", colcount, dsn_num, query->readhandle[dsn_num], ast_str_buffer(sql));
                AST_RWLIST_UNLOCK(&queries);
                return CLI_SUCCESS;
            }
 
            res = SQLFetch(stmt);
            if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                SQLCloseCursor(stmt);
                SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                release_obj_or_dsn (&obj, &dsn);
                if (res == SQL_NO_DATA) {
                    ast_cli(a->fd, "Returned %d rows.  Query executed on handle %d:%s [%s]\n", rows, dsn_num, query->readhandle[dsn_num], ast_str_buffer(sql));
                    break;
                } else {
                    ast_cli(a->fd, "Error %d in FETCH [%s]\n", res, ast_str_buffer(sql));
                }
                AST_RWLIST_UNLOCK(&queries);
                return CLI_SUCCESS;
            }
            for (;;) {
                for (x = 0; x < colcount; x++) {
                    res = SQLDescribeCol(stmt, x + 1, (unsigned char *)colname, sizeof(colname), &collength, NULL, NULL, NULL, NULL);
                    if (((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) || collength == 0) {
                        snprintf(colname, sizeof(colname), "field%d", x);
                    }
 
                    octetlength = 0;
                    SQLColAttribute(stmt, x + 1, SQL_DESC_OCTET_LENGTH, NULL, 0, NULL, &octetlength);
 
                    res = ast_odbc_ast_str_SQLGetData(&coldata, octetlength + 1, stmt, x + 1, SQL_CHAR, &indicator);
                    if (indicator == SQL_NULL_DATA) {
                        ast_str_set(&coldata, 0, "(nil)");
                        res = SQL_SUCCESS;
                    }
 
                    if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                        ast_cli(a->fd, "SQL Get Data error %d!\n[%s]\n\n", res, ast_str_buffer(sql));
                        SQLCloseCursor(stmt);
                        SQLFreeHandle(SQL_HANDLE_STMT, stmt);
                        release_obj_or_dsn (&obj, &dsn);
                        AST_RWLIST_UNLOCK(&queries);
                        return CLI_SUCCESS;
                    }
 
                    ast_cli(a->fd, "%-20.20s  %s\n", colname, ast_str_buffer(coldata));
                }
                rows++;
 
                /* Get next row */
                res = SQLFetch(stmt);
                if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
                    break;
                }
                ast_cli(a->fd, "%-20.20s  %s\n", "----------", "----------");
            }
            SQLCloseCursor(stmt);
            SQLFreeHandle(SQL_HANDLE_STMT, stmt);
            release_obj_or_dsn (&obj, &dsn);
            ast_cli(a->fd, "Returned %d row%s.  Query executed on handle %d [%s]\n", rows, rows == 1 ? "" : "s", dsn_num, query->readhandle[dsn_num]);
            break;
        }
        release_obj_or_dsn (&obj, &dsn);
 
        if (!executed) {
            ast_cli(a->fd, "Failed to execute query. [%s]\n", ast_str_buffer(sql));
        }
    } else { /* No execution, just print out the resulting SQL */
        ast_cli(a->fd, "%s\n", ast_str_buffer(sql));
    }
    AST_RWLIST_UNLOCK(&queries);
    return CLI_SUCCESS;
}

References a, args, AST_APP_ARG, ast_channel_unref, ast_cli(), ast_cli_complete(), ast_debug, AST_DECLARE_APP_ARGS, ast_dummy_channel_alloc, ast_odbc_ast_str_SQLGetData(), ast_odbc_direct_execute(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_STANDARD_APP_ARGS, ast_str_buffer(), ast_str_make_space, ast_str_set(), ast_str_substitute_variables(), ast_str_thread_get(), ast_strdup, ast_strdupa, ast_strlen_zero(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, coldata_buf, ast_cli_entry::command, generic_execute(), get_odbc_obj(), indicator, NULL, pbx_builtin_pushvar_helper(), release_obj_or_dsn(), sql_buf, and ast_cli_entry::usage.

cli_odbc_write()

static char * cli_odbc_write ( struct ast_cli_entry *  e, int  cmd, struct ast_cli_args *  a  )

static

Definition at line 1676 of file func_odbc.c.

{
    AST_DECLARE_APP_ARGS(values,
        AST_APP_ARG(field)[100];
    );
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(field)[100];
    );
    struct ast_str *sql;
    char *char_args, *char_values, varname[15];
    struct acf_odbc_query *query;
    struct ast_channel *chan;
    int i;
 
    switch (cmd) {
    case CLI_INIT:
        e->command = "odbc write";
        e->usage =
            "Usage: odbc write <name> <args> <value> [exec]\n"
            "       Evaluates the SQL provided in the ODBC function <name>, and\n"
            "       optionally executes the function.  This function is intended for\n"
            "       testing purposes.  Remember to quote arguments containing spaces.\n";
        return NULL;
    case CLI_GENERATE:
        if (a->pos == 2) {
            int wordlen = strlen(a->word), which = 0;
            /* Complete function name */
            AST_RWLIST_RDLOCK(&queries);
            AST_RWLIST_TRAVERSE(&queries, query, list) {
                if (!strncasecmp(query->acf->name, a->word, wordlen)) {
                    if (++which > a->n) {
                        char *res = ast_strdup(query->acf->name);
                        AST_RWLIST_UNLOCK(&queries);
                        return res;
                    }
                }
            }
            AST_RWLIST_UNLOCK(&queries);
            return NULL;
        } else if (a->pos == 5) {
            static const char * const completions[] = { "exec", NULL };
            return ast_cli_complete(a->word, completions, a->n);
        } else {
            return NULL;
        }
    }
 
    if (a->argc < 5 || a->argc > 6) {
        return CLI_SHOWUSAGE;
    }
 
    sql = ast_str_thread_get(&sql_buf, 16);
    if (!sql) {
        return CLI_FAILURE;
    }
 
    AST_RWLIST_RDLOCK(&queries);
    AST_RWLIST_TRAVERSE(&queries, query, list) {
        if (!strcmp(query->acf->name, a->argv[2])) {
            break;
        }
    }
 
    if (!query) {
        ast_cli(a->fd, "No such query '%s'\n", a->argv[2]);
        AST_RWLIST_UNLOCK(&queries);
        return CLI_SHOWUSAGE;
    }
 
    if (!query->sql_write) {
        ast_cli(a->fd, "The function %s has no writesql parameter.\n", a->argv[2]);
        AST_RWLIST_UNLOCK(&queries);
        return CLI_SUCCESS;
    }
 
    /* FIXME: The code below duplicates code found in acf_odbc_write but
     * lacks the newer sql_insert additions. */
 
    ast_str_make_space(&sql, strlen(query->sql_write) * 2 + 300);
 
    /* Evaluate function */
    char_args = ast_strdupa(a->argv[3]);
    char_values = ast_strdupa(a->argv[4]);
 
    chan = ast_dummy_channel_alloc();
    if (!chan) {
        AST_RWLIST_UNLOCK(&queries);
        return CLI_FAILURE;
    }
 
    AST_STANDARD_APP_ARGS(args, char_args);
    for (i = 0; i < args.argc; i++) {
        snprintf(varname, sizeof(varname), "ARG%d", i + 1);
        pbx_builtin_pushvar_helper(chan, varname, args.field[i]);
    }
 
    /* Parse values, just like arguments */
    AST_STANDARD_APP_ARGS(values, char_values);
    for (i = 0; i < values.argc; i++) {
        snprintf(varname, sizeof(varname), "VAL%d", i + 1);
        pbx_builtin_pushvar_helper(chan, varname, values.field[i]);
    }
 
    /* Additionally set the value as a whole (but push an empty string if value is NULL) */
    pbx_builtin_pushvar_helper(chan, "VALUE", S_OR(a->argv[4], ""));
    ast_str_substitute_variables(&sql, 0, chan, query->sql_write);
    ast_debug(1, "SQL is %s\n", ast_str_buffer(sql));
 
    chan = ast_channel_unref(chan);
 
    if (a->argc == 6 && !strcmp(a->argv[5], "exec")) {
        /* Execute the query */
        struct odbc_obj *obj = NULL;
        struct dsn *dsn = NULL;
        int dsn_num, executed = 0;
        SQLHSTMT stmt;
        SQLLEN rows = -1;
 
        for (dsn_num = 0; dsn_num < 5; dsn_num++) {
            if (ast_strlen_zero(query->writehandle[dsn_num])) {
                continue;
            }
            obj = get_odbc_obj(query->writehandle[dsn_num], &dsn);
            if (!obj) {
                continue;
            }
            if (!(stmt = ast_odbc_direct_execute(obj, generic_execute, ast_str_buffer(sql)))) {
                release_obj_or_dsn (&obj, &dsn);
                continue;
            }
 
            SQLRowCount(stmt, &rows);
            SQLCloseCursor(stmt);
            SQLFreeHandle(SQL_HANDLE_STMT, stmt);
            release_obj_or_dsn (&obj, &dsn);
            ast_cli(a->fd, "Affected %d rows.  Query executed on handle %d [%s]\n", (int)rows, dsn_num, query->writehandle[dsn_num]);
            executed = 1;
            break;
        }
 
        if (!executed) {
            ast_cli(a->fd, "Failed to execute query.\n");
        }
    } else { /* No execution, just print out the resulting SQL */
        ast_cli(a->fd, "%s\n", ast_str_buffer(sql));
    }
    AST_RWLIST_UNLOCK(&queries);
    return CLI_SUCCESS;
}

References a, args, AST_APP_ARG, ast_channel_unref, ast_cli(), ast_cli_complete(), ast_debug, AST_DECLARE_APP_ARGS, ast_dummy_channel_alloc, ast_odbc_direct_execute(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_STANDARD_APP_ARGS, ast_str_buffer(), ast_str_make_space, ast_str_substitute_variables(), ast_str_thread_get(), ast_strdup, ast_strdupa, ast_strlen_zero(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, generic_execute(), get_odbc_obj(), NULL, pbx_builtin_pushvar_helper(), release_obj_or_dsn(), S_OR, sql_buf, and ast_cli_entry::usage.

connection_dead()

static int connection_dead ( struct odbc_obj *  connection )

static

Determine if the connection has died.

Parameters

connection

The connection to check

Return values

1	Yep, it's dead
0	It's alive and well

Definition at line 282 of file func_odbc.c.

{
    SQLINTEGER dead;
    SQLRETURN res;
    SQLHSTMT stmt;
 
    if (!connection) {
        return 1;
    }
 
    res = SQLGetConnectAttr(connection->con, SQL_ATTR_CONNECTION_DEAD, &dead, 0, 0);
    if (SQL_SUCCEEDED(res)) {
        return dead == SQL_CD_TRUE ? 1 : 0;
    }
 
    /* If the Driver doesn't support SQL_ATTR_CONNECTION_DEAD do a direct
     * execute of a probing statement and see if that succeeds instead
     */
    stmt = ast_odbc_direct_execute(connection, silent_execute, "SELECT 1");
    if (!stmt) {
        return 1;
    }
 
    SQLFreeHandle(SQL_HANDLE_STMT, stmt);
    return 0;
}

References ast_odbc_direct_execute(), odbc_obj::con, dsn::connection, and silent_execute().

Referenced by get_dsn().

create_dsn()

static struct dsn * create_dsn ( const char *  name )

static

Create a DSN and connect to the database.

Parameters

name	The name of the DSN as found in res_odbc.conf

Return values

NULL	Fail
non-NULL	The newly-created structure

Definition at line 243 of file func_odbc.c.

{
    struct dsn *dsn;
 
    if (!dsns) {
        return NULL;
    }
 
    dsn = ao2_alloc(sizeof(*dsn) + strlen(name) + 1, dsn_destructor);
    if (!dsn) {
        return NULL;
    }
 
    /* Safe */
    strcpy(dsn->name, name);
 
    dsn->connection = ast_odbc_request_obj(name, 0);
    if (!dsn->connection) {
        ao2_ref(dsn, -1);
        return NULL;
    }
 
    if (!ao2_link_flags(dsns, dsn, OBJ_NOLOCK)) {
        ao2_ref(dsn, -1);
        return NULL;
    }
 
    return dsn;
}

References ao2_alloc, ao2_link_flags, ao2_ref, ast_odbc_request_obj, dsn::connection, dsn, dsn_destructor(), dsns, dsn::name, name, NULL, and OBJ_NOLOCK.

Referenced by get_dsn().

dsn_cmp()

static int dsn_cmp ( void *  obj, void *  arg, int  flags  )

static

Definition at line 198 of file func_odbc.c.

{
    const struct dsn *object_left = obj;
    const struct dsn *object_right = arg;
    const char *right_key = arg;
    int cmp;
 
    switch (flags & OBJ_SEARCH_MASK) {
    case OBJ_SEARCH_OBJECT:
        right_key = object_right->name;
        /* Fall through */
    case OBJ_SEARCH_KEY:
        cmp = strcmp(object_left->name, right_key);
        break;
    case OBJ_SEARCH_PARTIAL_KEY:
        cmp = strncmp(object_left->name, right_key, strlen(right_key));
        break;
    default:
        cmp = 0;
        break;
    }
 
    if (cmp) {
        return 0;
    }
 
    return CMP_MATCH;
}

References CMP_MATCH, dsn::name, OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, OBJ_SEARCH_OBJECT, and OBJ_SEARCH_PARTIAL_KEY.

Referenced by load_module(), and reload().

dsn_destructor()

static void dsn_destructor ( void *  obj )

static

Definition at line 227 of file func_odbc.c.

{
    struct dsn *dsn = obj;
 
    if (dsn->connection) {
        ast_odbc_release_obj(dsn->connection);
    }
}

References ast_odbc_release_obj(), and dsn::connection.

Referenced by create_dsn().

dsn_hash()

static int dsn_hash ( const void *  obj, const int  flags  )

static

Definition at line 178 of file func_odbc.c.

{
    const struct dsn *object;
    const char *key;
 
    switch (flags & OBJ_SEARCH_MASK) {
    case OBJ_SEARCH_KEY:
        key = obj;
        break;
    case OBJ_SEARCH_OBJECT:
        object = obj;
        key = object->name;
        break;
    default:
        ast_assert(0);
        return 0;
    }
    return ast_str_hash(key);
}

References ast_assert, ast_str_hash(), OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, and OBJ_SEARCH_OBJECT.

Referenced by load_module(), and reload().

exec_odbcfinish()

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

static

Definition at line 1206 of file func_odbc.c.

{
    struct ast_datastore *store;
 
    ast_channel_lock(chan);
    store = ast_channel_datastore_find(chan, &odbc_info, data);
    if (store) {
        ast_channel_datastore_remove(chan, store);
        ast_datastore_free(store);
    }
    ast_channel_unlock(chan);
    return 0;
}

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_channel_lock, ast_channel_unlock, ast_datastore_free(), ast_datastore::data, and odbc_info.

Referenced by load_module().

execute()

static SQLHSTMT execute ( struct odbc_obj *  obj, void *  data, int  silent  )

static

Common execution function for SQL queries.

Parameters

obj	DB connection
data	The query to execute
silent	If true, do not print warnings on failure

Return values

NULL	Failed to execute query
non-NULL	The executed statement

Definition at line 471 of file func_odbc.c.

{
    int res;
    char *sql = data;
    SQLHSTMT stmt;
 
    res = SQLAllocHandle (SQL_HANDLE_STMT, obj->con, &stmt);
    if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO)) {
        ast_log(LOG_WARNING, "SQL Alloc Handle failed (%d)!\n", res);
        return NULL;
    }
 
    res = ast_odbc_execute_sql(obj, stmt, sql);
    if ((res != SQL_SUCCESS) && (res != SQL_SUCCESS_WITH_INFO) && (res != SQL_NO_DATA)) {
        if (res == SQL_ERROR && !silent) {
            int i;
            SQLINTEGER nativeerror=0, numfields=0;
            SQLSMALLINT diagbytes=0;
            unsigned char state[10], diagnostic[256];
 
            SQLGetDiagField(SQL_HANDLE_STMT, stmt, 1, SQL_DIAG_NUMBER, &numfields, SQL_IS_INTEGER, &diagbytes);
            for (i = 0; i < numfields; i++) {
                SQLGetDiagRec(SQL_HANDLE_STMT, stmt, i + 1, state, &nativeerror, diagnostic, sizeof(diagnostic), &diagbytes);
                ast_log(LOG_WARNING, "SQL Execute returned an error %d: %s: %s (%d)\n", res, state, diagnostic, diagbytes);
                if (i > 10) {
                    ast_log(LOG_WARNING, "Oh, that was good.  There are really %d diagnostics?\n", (int)numfields);
                    break;
                }
            }
        }
 
        if (!silent) {
            ast_log(LOG_WARNING, "SQL Exec Direct failed (%d)![%s]\n", res, sql);
        }
        SQLCloseCursor(stmt);
        SQLFreeHandle(SQL_HANDLE_STMT, stmt);
        return NULL;
    }
 
    return stmt;
}

References ast_log, ast_odbc_execute_sql(), odbc_obj::con, odbc_datastore_row::data, LOG_WARNING, and NULL.

Referenced by ast_register_application2(), generic_execute(), load_pbx_builtins(), and silent_execute().

free_acf_query()

static int free_acf_query ( struct acf_odbc_query *  query )

static

Definition at line 1220 of file func_odbc.c.

{
    if (query) {
        if (query->acf) {
            if (query->acf->name)
                ast_free((char *)query->acf->name);
            ast_string_field_free_memory(query->acf);
            ast_free(query->acf);
        }
        ast_free(query->sql_read);
        ast_free(query->sql_write);
        ast_free(query->sql_insert);
        ast_free(query);
    }
    return 0;
}

References ast_free, and ast_string_field_free_memory.

Referenced by init_acf_query(), reload(), and unload_module().

generic_execute()

static SQLHSTMT generic_execute ( struct odbc_obj *  obj, void *  data  )

static

Definition at line 513 of file func_odbc.c.

{
    return execute(obj, data, 0);
}

References odbc_datastore_row::data, and execute().

Referenced by acf_odbc_read(), acf_odbc_write(), cli_odbc_read(), and cli_odbc_write().

get_dsn()

static struct dsn * get_dsn ( const char *  name )

static

Retrieve a DSN, or create it if it does not exist.

The created DSN is returned locked. This should be inconsequential to callers in most cases.

When finished with the returned structure, the caller must call release_obj_or_dsn

Parameters

name	Name of the DSN as found in res_odbc.conf

Return values

NULL	Unable to retrieve or create the DSN
non-NULL	The retrieved/created locked DSN

Definition at line 322 of file func_odbc.c.

{
    struct dsn *dsn;
 
    if (!dsns) {
        return NULL;
    }
 
    ao2_lock(dsns);
    dsn = ao2_find(dsns, name, OBJ_SEARCH_KEY | OBJ_NOLOCK);
    if (!dsn) {
        dsn = create_dsn(name);
    }
    ao2_unlock(dsns);
 
    if (!dsn) {
        return NULL;
    }
 
    ao2_lock(dsn);
    if (!dsn->connection) {
        dsn->connection = ast_odbc_request_obj(name, 0);
        if (!dsn->connection) {
            ao2_unlock(dsn);
            ao2_ref(dsn, -1);
            return NULL;
        }
        return dsn;
    }
 
    if (connection_dead(dsn->connection)) {
        ast_odbc_release_obj(dsn->connection);
        dsn->connection = ast_odbc_request_obj(name, 0);
        if (!dsn->connection) {
            ao2_unlock(dsn);
            ao2_ref(dsn, -1);
            return NULL;
        }
    }
 
    return dsn;
}

References ao2_find, ao2_lock, ao2_ref, ao2_unlock, ast_odbc_release_obj(), ast_odbc_request_obj, dsn::connection, connection_dead(), create_dsn(), dsn, dsns, name, NULL, OBJ_NOLOCK, and OBJ_SEARCH_KEY.

Referenced by get_odbc_obj().

get_odbc_obj()

static struct odbc_obj * get_odbc_obj ( const char *  dsn_name, struct dsn **  dsn  )

static

Get a DB handle via a DSN or directly.

If single db connection then get the DB handle via DSN else by requesting a connection directly

Parameters

dsn_name	Name of the DSN as found in res_odbc.conf
dsn	The pointer to the DSN

Return values

NULL	Unable to retrieve the DB handle
non-NULL	The retrieved DB handle

Definition at line 376 of file func_odbc.c.

{
    struct odbc_obj *obj = NULL;
 
    ast_rwlock_rdlock(&single_db_connection_lock);
    if (single_db_connection) {
        if (dsn) {
            *dsn = get_dsn(dsn_name);
            if (*dsn) {
                obj = (*dsn)->connection;
            }
        }
    } else {
        obj = ast_odbc_request_obj(dsn_name, 0);
    }
    ast_rwlock_unlock(&single_db_connection_lock);
 
    return obj;
}

References ast_odbc_request_obj, ast_rwlock_rdlock, ast_rwlock_unlock, get_dsn(), NULL, single_db_connection, and single_db_connection_lock.

Referenced by acf_odbc_read(), acf_odbc_write(), cli_odbc_read(), and cli_odbc_write().

init_acf_query()

static int init_acf_query ( struct ast_config *  cfg, char *  catg, struct acf_odbc_query **  query  )

static

Definition at line 1237 of file func_odbc.c.

{
    const char *tmp;
    const char *tmp2 = NULL;
    int i;
 
    if (!cfg || !catg) {
        return EINVAL;
    }
 
    if (!(*query = ast_calloc(1, sizeof(**query)))) {
        return ENOMEM;
    }
 
    if (((tmp = ast_variable_retrieve(cfg, catg, "writehandle"))) || ((tmp = ast_variable_retrieve(cfg, catg, "dsn")))) {
        char *tmp2 = ast_strdupa(tmp);
        AST_DECLARE_APP_ARGS(writeconf,
            AST_APP_ARG(dsn)[5];
        );
        AST_STANDARD_APP_ARGS(writeconf, tmp2);
        for (i = 0; i < 5; i++) {
            if (!ast_strlen_zero(writeconf.dsn[i]))
                ast_copy_string((*query)->writehandle[i], writeconf.dsn[i], sizeof((*query)->writehandle[i]));
        }
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "readhandle"))) {
        char *tmp2 = ast_strdupa(tmp);
        AST_DECLARE_APP_ARGS(readconf,
            AST_APP_ARG(dsn)[5];
        );
        AST_STANDARD_APP_ARGS(readconf, tmp2);
        for (i = 0; i < 5; i++) {
            if (!ast_strlen_zero(readconf.dsn[i]))
                ast_copy_string((*query)->readhandle[i], readconf.dsn[i], sizeof((*query)->readhandle[i]));
        }
    } else {
        /* If no separate readhandle, then use the writehandle for reading */
        for (i = 0; i < 5; i++) {
            if (!ast_strlen_zero((*query)->writehandle[i]))
                ast_copy_string((*query)->readhandle[i], (*query)->writehandle[i], sizeof((*query)->readhandle[i]));
        }
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "readsql")) ||
            (tmp2 = ast_variable_retrieve(cfg, catg, "read"))) {
        if (!tmp) {
            ast_log(LOG_WARNING, "Parameter 'read' is deprecated for category %s.  Please use 'readsql' instead.\n", catg);
            tmp = tmp2;
        }
        if (*tmp != '\0') { /* non-empty string */
            if (!((*query)->sql_read = ast_strdup(tmp))) {
                free_acf_query(*query);
                *query = NULL;
                return ENOMEM;
            }
        }
    }
 
    if ((*query)->sql_read && ast_strlen_zero((*query)->readhandle[0])) {
        free_acf_query(*query);
        *query = NULL;
        ast_log(LOG_ERROR, "There is SQL, but no ODBC class to be used for reading: %s\n", catg);
        return EINVAL;
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "writesql")) ||
            (tmp2 = ast_variable_retrieve(cfg, catg, "write"))) {
        if (!tmp) {
            ast_log(LOG_WARNING, "Parameter 'write' is deprecated for category %s.  Please use 'writesql' instead.\n", catg);
            tmp = tmp2;
        }
        if (*tmp != '\0') { /* non-empty string */
            if (!((*query)->sql_write = ast_strdup(tmp))) {
                free_acf_query(*query);
                *query = NULL;
                return ENOMEM;
            }
        }
    }
 
    if ((*query)->sql_write && ast_strlen_zero((*query)->writehandle[0])) {
        free_acf_query(*query);
        *query = NULL;
        ast_log(LOG_ERROR, "There is SQL, but no ODBC class to be used for writing: %s\n", catg);
        return EINVAL;
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "insertsql"))) {
        if (*tmp != '\0') { /* non-empty string */
            if (!((*query)->sql_insert = ast_strdup(tmp))) {
                free_acf_query(*query);
                *query = NULL;
                return ENOMEM;
            }
        }
    }
 
    /* Allow escaping of embedded commas in fields to be turned off */
    ast_set_flag((*query), OPT_ESCAPECOMMAS);
    if ((tmp = ast_variable_retrieve(cfg, catg, "escapecommas"))) {
        if (ast_false(tmp))
            ast_clear_flag((*query), OPT_ESCAPECOMMAS);
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "mode"))) {
        if (strcasecmp(tmp, "multirow") == 0)
            ast_set_flag((*query), OPT_MULTIROW);
        if ((tmp = ast_variable_retrieve(cfg, catg, "rowlimit")))
            sscanf(tmp, "%30d", &((*query)->rowlimit));
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "minargs"))) {
        sscanf(tmp, "%30d", &((*query)->minargs));
    }
 
    (*query)->acf = ast_calloc(1, sizeof(struct ast_custom_function));
    if (!(*query)->acf) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
    if (ast_string_field_init((*query)->acf, 128)) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "prefix")) && !ast_strlen_zero(tmp)) {
        if (ast_asprintf((char **)&((*query)->acf->name), "%s_%s", tmp, catg) < 0) {
            (*query)->acf->name = NULL;
        }
    } else {
        if (ast_asprintf((char **)&((*query)->acf->name), "ODBC_%s", catg) < 0) {
            (*query)->acf->name = NULL;
        }
    }
 
    if (!(*query)->acf->name) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "syntax")) && !ast_strlen_zero(tmp)) {
        ast_string_field_build((*query)->acf, syntax, "%s(%s)", (*query)->acf->name, tmp);
    } else {
        ast_string_field_build((*query)->acf, syntax, "%s(<arg1>[...[,<argN>]])", (*query)->acf->name);
    }
 
    if (ast_strlen_zero((*query)->acf->syntax)) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
 
    if ((tmp = ast_variable_retrieve(cfg, catg, "synopsis")) && !ast_strlen_zero(tmp)) {
        ast_string_field_set((*query)->acf, synopsis, tmp);
    } else {
        ast_string_field_set((*query)->acf, synopsis, "Runs the referenced query with the specified arguments");
    }
 
    if (ast_strlen_zero((*query)->acf->synopsis)) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
 
    if ((*query)->sql_read && (*query)->sql_write) {
        ast_string_field_build((*query)->acf, desc,
                    "Runs the following query, as defined in func_odbc.conf, performing\n"
                    "substitution of the arguments into the query as specified by ${ARG1},\n"
                    "${ARG2}, ... ${ARGn}.  When setting the function, the values are provided\n"
                    "either in whole as ${VALUE} or parsed as ${VAL1}, ${VAL2}, ... ${VALn}.\n"
                    "%s"
                    "\nRead:\n%s\n\nWrite:\n%s%s%s",
                    (*query)->sql_insert ?
                        "If the write query affects no rows, the insert query will be\n"
                        "performed.\n" : "",
                    (*query)->sql_read,
                    (*query)->sql_write,
                    (*query)->sql_insert ? "\n\nInsert:\n" : "",
                    (*query)->sql_insert ? (*query)->sql_insert : "");
    } else if ((*query)->sql_read) {
        ast_string_field_build((*query)->acf, desc,
                    "Runs the following query, as defined in func_odbc.conf, performing\n"
                    "substitution of the arguments into the query as specified by ${ARG1},\n"
                    "${ARG2}, ... ${ARGn}.  This function may only be read, not set.\n\nSQL:\n%s",
                    (*query)->sql_read);
    } else if ((*query)->sql_write) {
        ast_string_field_build((*query)->acf, desc,
                    "Runs the following query, as defined in func_odbc.conf, performing\n"
                    "substitution of the arguments into the query as specified by ${ARG1},\n"
                    "${ARG2}, ... ${ARGn}.  The values are provided either in whole as\n"
                    "${VALUE} or parsed as ${VAL1}, ${VAL2}, ... ${VALn}.\n"
                    "This function may only be set.\n%s\nSQL:\n%s%s%s",
                    (*query)->sql_insert ?
                        "If the write query affects no rows, the insert query will be\n"
                        "performed.\n" : "",
                    (*query)->sql_write,
                    (*query)->sql_insert ? "\n\nInsert:\n" : "",
                    (*query)->sql_insert ? (*query)->sql_insert : "");
    } else {
        free_acf_query(*query);
        *query = NULL;
        ast_log(LOG_WARNING, "Section '%s' was found, but there was no SQL to execute.  Ignoring.\n", catg);
        return EINVAL;
    }
 
    if (ast_strlen_zero((*query)->acf->desc)) {
        free_acf_query(*query);
        *query = NULL;
        return ENOMEM;
    }
 
    if ((*query)->sql_read) {
        (*query)->acf->read = acf_odbc_read;
    }
 
    if ((*query)->sql_write) {
        (*query)->acf->write = acf_odbc_write;
    }
 
    return 0;
}

References acf_odbc_read(), acf_odbc_write(), AST_APP_ARG, ast_asprintf, ast_calloc, ast_clear_flag, ast_copy_string(), AST_DECLARE_APP_ARGS, ast_false(), ast_log, ast_set_flag, AST_STANDARD_APP_ARGS, ast_strdup, ast_strdupa, ast_string_field_build, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), ast_variable_retrieve(), desc, free_acf_query(), LOG_ERROR, LOG_WARNING, NULL, OPT_ESCAPECOMMAS, OPT_MULTIROW, synopsis, and tmp().

Referenced by load_module(), and reload().

load_module()

static int load_module ( void  )

static

Definition at line 1831 of file func_odbc.c.

{
    int res = 0;
    struct ast_config *cfg;
    char *catg;
    const char *s;
    struct ast_flags config_flags = { 0 };
 
    res |= ast_custom_function_register(&fetch_function);
    res |= ast_register_application_xml(app_odbcfinish, exec_odbcfinish);
 
    cfg = ast_config_load(config, config_flags);
    if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
        ast_log(LOG_NOTICE, "Unable to load config for func_odbc: %s\n", config);
        return AST_MODULE_LOAD_DECLINE;
    }
 
    ast_rwlock_wrlock(&single_db_connection_lock);
    if ((s = ast_variable_retrieve(cfg, "general", "single_db_connection"))) {
        single_db_connection = ast_true(s);
    } else {
        single_db_connection = DEFAULT_SINGLE_DB_CONNECTION;
    }
 
    dsns = NULL;
 
    if (single_db_connection) {
        dsns = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, DSN_BUCKETS,
            dsn_hash, NULL, dsn_cmp);
        if (!dsns) {
            ast_log(LOG_ERROR, "Could not initialize DSN container\n");
            ast_rwlock_unlock(&single_db_connection_lock);
            return AST_MODULE_LOAD_DECLINE;
        }
    }
    ast_rwlock_unlock(&single_db_connection_lock);
 
    AST_RWLIST_WRLOCK(&queries);
    for (catg = ast_category_browse(cfg, NULL);
         catg;
         catg = ast_category_browse(cfg, catg)) {
        struct acf_odbc_query *query = NULL;
        int err;
 
        if (!strcasecmp(catg, "general")) {
            continue;
        }
 
        if ((err = init_acf_query(cfg, catg, &query))) {
            if (err == ENOMEM)
                ast_log(LOG_ERROR, "Out of memory\n");
            else if (err == EINVAL)
                ast_log(LOG_ERROR, "Invalid parameters for category %s\n", catg);
            else
                ast_log(LOG_ERROR, "%s (%d)\n", strerror(err), err);
        } else {
            AST_RWLIST_INSERT_HEAD(&queries, query, list);
            ast_custom_function_register(query->acf);
        }
    }
 
    ast_config_destroy(cfg);
    res |= ast_custom_function_register(&escape_function);
    res |= ast_custom_function_register(&escape_backslashes_function);
    ast_cli_register_multiple(cli_func_odbc, ARRAY_LEN(cli_func_odbc));
 
    AST_RWLIST_UNLOCK(&queries);
    return res;
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, app_odbcfinish, ARRAY_LEN, ast_category_browse(), ast_cli_register_multiple, ast_config_destroy(), ast_config_load, ast_custom_function_register, ast_log, AST_MODULE_LOAD_DECLINE, ast_register_application_xml, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_rwlock_unlock, ast_rwlock_wrlock, ast_true(), ast_variable_retrieve(), cli_func_odbc, config, CONFIG_STATUS_FILEINVALID, DEFAULT_SINGLE_DB_CONNECTION, DSN_BUCKETS, dsn_cmp(), dsn_hash(), dsns, escape_backslashes_function, escape_function, exec_odbcfinish(), fetch_function, init_acf_query(), LOG_ERROR, LOG_NOTICE, NULL, single_db_connection, and single_db_connection_lock.

odbc_datastore_free()

static void odbc_datastore_free ( void *  data )

static

Definition at line 444 of file func_odbc.c.

{
    struct odbc_datastore *result = data;
    struct odbc_datastore_row *row;
 
    if (!result) {
        return;
    }
 
    AST_LIST_LOCK(result);
    while ((row = AST_LIST_REMOVE_HEAD(result, list))) {
        ast_free(row);
    }
    AST_LIST_UNLOCK(result);
    AST_LIST_HEAD_DESTROY(result);
    ast_free(result);
}

References ast_free, AST_LIST_HEAD_DESTROY, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, odbc_datastore_row::list, and result.

Referenced by acf_odbc_read().

release_obj_or_dsn()

static void release_obj_or_dsn ( struct odbc_obj **  obj, struct dsn **  dsn  )

inlinestatic

Release an ODBC obj or a DSN.

If single db connection then unlock and unreference the DSN else release the ODBC obj

Parameters

obj	The pointer to the ODBC obj to release
dsn	The pointer to the dsn to unlock and unreference

Definition at line 405 of file func_odbc.c.

{
    if (dsn && *dsn) {
        /* If multiple connections are not enabled then the guarantee
         * of a single connection already exists and holding on to the
         * connection would prevent any other user from acquiring it
         * indefinitely.
         */
        if (ast_odbc_get_max_connections((*dsn)->name) < 2) {
            ast_odbc_release_obj((*dsn)->connection);
            (*dsn)->connection = NULL;
        }
        ao2_unlock(*dsn);
        ao2_ref(*dsn, -1);
        *dsn = NULL;
        /* Some callers may provide both an obj and dsn. To ensure that
         * the connection is not released twice we set it to NULL here if
         * present.
         */
        if (obj) {
            *obj = NULL;
        }
    } else if (obj && *obj) {
        ast_odbc_release_obj(*obj);
        *obj = NULL;
    }
}

References ao2_ref, ao2_unlock, ast_odbc_get_max_connections(), ast_odbc_release_obj(), and NULL.

Referenced by acf_odbc_read(), acf_odbc_write(), cli_odbc_read(), and cli_odbc_write().

reload()

static int reload ( void  )

static

Definition at line 1932 of file func_odbc.c.

{
    int res = 0;
    struct ast_config *cfg;
    struct acf_odbc_query *oldquery;
    char *catg;
    const char *s;
    struct ast_flags config_flags = { CONFIG_FLAG_FILEUNCHANGED };
 
    cfg = ast_config_load(config, config_flags);
    if (cfg == CONFIG_STATUS_FILEUNCHANGED || cfg == CONFIG_STATUS_FILEINVALID)
        return 0;
 
    ast_rwlock_wrlock(&single_db_connection_lock);
 
    if (dsns) {
        ao2_ref(dsns, -1);
        dsns = NULL;
    }
 
    if (cfg && (s = ast_variable_retrieve(cfg, "general", "single_db_connection"))) {
        single_db_connection = ast_true(s);
    } else {
        single_db_connection = DEFAULT_SINGLE_DB_CONNECTION;
    }
 
    if (single_db_connection) {
        dsns = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, DSN_BUCKETS,
            dsn_hash, NULL, dsn_cmp);
        if (!dsns) {
            ast_log(LOG_ERROR, "Could not initialize DSN container\n");
            ast_rwlock_unlock(&single_db_connection_lock);
            return 0;
        }
    }
    ast_rwlock_unlock(&single_db_connection_lock);
 
    AST_RWLIST_WRLOCK(&queries);
 
    while (!AST_RWLIST_EMPTY(&queries)) {
        oldquery = AST_RWLIST_REMOVE_HEAD(&queries, list);
        ast_custom_function_unregister(oldquery->acf);
        free_acf_query(oldquery);
    }
 
    if (!cfg) {
        ast_log(LOG_WARNING, "Unable to load config for func_odbc: %s\n", config);
        goto reload_out;
    }
 
    for (catg = ast_category_browse(cfg, NULL);
         catg;
         catg = ast_category_browse(cfg, catg)) {
        struct acf_odbc_query *query = NULL;
 
        if (!strcasecmp(catg, "general")) {
            continue;
        }
 
        if (init_acf_query(cfg, catg, &query)) {
            ast_log(LOG_ERROR, "Cannot initialize query %s\n", catg);
        } else {
            AST_RWLIST_INSERT_HEAD(&queries, query, list);
            ast_custom_function_register(query->acf);
        }
    }
 
    ast_config_destroy(cfg);
reload_out:
    AST_RWLIST_UNLOCK(&queries);
    return res;
}

References AO2_ALLOC_OPT_LOCK_MUTEX, ao2_container_alloc_hash, ao2_ref, ast_category_browse(), ast_config_destroy(), ast_config_load, ast_custom_function_register, ast_custom_function_unregister(), ast_log, AST_RWLIST_EMPTY, AST_RWLIST_INSERT_HEAD, AST_RWLIST_REMOVE_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_rwlock_unlock, ast_rwlock_wrlock, ast_true(), ast_variable_retrieve(), config, CONFIG_FLAG_FILEUNCHANGED, CONFIG_STATUS_FILEINVALID, CONFIG_STATUS_FILEUNCHANGED, DEFAULT_SINGLE_DB_CONNECTION, DSN_BUCKETS, dsn_cmp(), dsn_hash(), dsns, free_acf_query(), init_acf_query(), LOG_ERROR, LOG_WARNING, NULL, single_db_connection, and single_db_connection_lock.

silent_execute()

static SQLHSTMT silent_execute ( struct odbc_obj *  obj, void *  data  )

static

Definition at line 518 of file func_odbc.c.

{
    return execute(obj, data, 1);
}

References odbc_datastore_row::data, and execute().

Referenced by connection_dead().

unload_module()

static int unload_module ( void  )

static

Definition at line 1901 of file func_odbc.c.

{
    struct acf_odbc_query *query;
    int res = 0;
 
    AST_RWLIST_WRLOCK(&queries);
    while (!AST_RWLIST_EMPTY(&queries)) {
        query = AST_RWLIST_REMOVE_HEAD(&queries, list);
        ast_custom_function_unregister(query->acf);
        free_acf_query(query);
    }
 
    res |= ast_custom_function_unregister(&escape_function);
    res |= ast_custom_function_unregister(&escape_backslashes_function);
    res |= ast_custom_function_unregister(&fetch_function);
    res |= ast_unregister_application(app_odbcfinish);
    ast_cli_unregister_multiple(cli_func_odbc, ARRAY_LEN(cli_func_odbc));
 
    /* Allow any threads waiting for this lock to pass (avoids a race) */
    AST_RWLIST_UNLOCK(&queries);
    usleep(1);
    AST_RWLIST_WRLOCK(&queries);
 
    AST_RWLIST_UNLOCK(&queries);
 
    if (dsns) {
        ao2_ref(dsns, -1);
    }
    return res;
}

References ao2_ref, app_odbcfinish, ARRAY_LEN, ast_cli_unregister_multiple(), ast_custom_function_unregister(), AST_RWLIST_EMPTY, AST_RWLIST_REMOVE_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_unregister_application(), cli_func_odbc, dsns, escape_backslashes_function, escape_function, fetch_function, and free_acf_query().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "ODBC lookups" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload, .requires = "res_odbc", }

static

Definition at line 2013 of file func_odbc.c.

app_odbcfinish

char* app_odbcfinish = "ODBCFinish"

static

Definition at line 1204 of file func_odbc.c.

Referenced by load_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 2013 of file func_odbc.c.

cli_func_odbc

struct ast_cli_entry cli_func_odbc[]

static

Initial value:

= {
    { .handler =  cli_odbc_write , .summary =  "Test setting a func_odbc function" ,},
    { .handler =  cli_odbc_read , .summary =  "Test reading a func_odbc function" ,},
}

Definition at line 1826 of file func_odbc.c.

Referenced by load_module(), and unload_module().

coldata_buf

struct ast_threadstorage coldata_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_coldata_buf , .custom_init = NULL , }

static

Definition at line 439 of file func_odbc.c.

Referenced by acf_odbc_read(), and cli_odbc_read().

colnames_buf

struct ast_threadstorage colnames_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_colnames_buf , .custom_init = NULL , }

static

Definition at line 440 of file func_odbc.c.

Referenced by acf_odbc_read().

config

char* config = "func_odbc.conf"

static

Definition at line 118 of file func_odbc.c.

Referenced by load_module(), and reload().

dsns

struct ao2_container* dsns

Definition at line 176 of file func_odbc.c.

Referenced by create_dsn(), get_dsn(), load_module(), reload(), and unload_module().

escape_backslashes_function

struct ast_custom_function escape_backslashes_function

static

Initial value:

= {
    .name = "SQL_ESC_BACKSLASHES",
    .read = acf_escape_backslashes,
    .write = NULL,
}

Definition at line 1154 of file func_odbc.c.

Referenced by load_module(), and unload_module().

escape_function

struct ast_custom_function escape_function

static

Initial value:

= {
    .name = "SQL_ESC",
    .read = acf_escape_ticks,
    .write = NULL,
}

Definition at line 1143 of file func_odbc.c.

Referenced by load_module(), and unload_module().

fetch_function

struct ast_custom_function fetch_function

static

Initial value:

= {
    .name = "ODBC_FETCH",
    .read = acf_fetch,
    .write = NULL,
}

Definition at line 1198 of file func_odbc.c.

Referenced by load_module(), and unload_module().

odbc_info

const struct ast_datastore_info odbc_info

static

Initial value:

= {
    .type = "FUNC_ODBC",
    .destroy = odbc_datastore_free,
}

Definition at line 146 of file func_odbc.c.

Referenced by acf_fetch(), acf_odbc_read(), and exec_odbcfinish().

queries

struct queries queries = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }

static

resultcount

int resultcount = 0

static

Definition at line 435 of file func_odbc.c.

Referenced by acf_odbc_read().

single_db_connection

int single_db_connection

static

Definition at line 122 of file func_odbc.c.

Referenced by get_odbc_obj(), load_module(), and reload().

single_db_connection_lock

ast_rwlock_t single_db_connection_lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} }

static

Definition at line 124 of file func_odbc.c.

Referenced by get_odbc_obj(), load_module(), and reload().

sql2_buf

struct ast_threadstorage sql2_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_sql2_buf , .custom_init = NULL , }

static

Definition at line 438 of file func_odbc.c.

Referenced by acf_odbc_write().

sql_buf

struct ast_threadstorage sql_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_sql_buf , .custom_init = NULL , }

static

Definition at line 437 of file func_odbc.c.

Referenced by acf_odbc_read(), acf_odbc_write(), cli_odbc_read(), and cli_odbc_write().