dect
/
asterisk
Archived
13
0
Fork 0
This repository has been archived on 2022-02-17. You can view files and clone it, but cannot push or open issues or pull requests.
asterisk/res/res_config_sqlite.c

1536 lines
37 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2006, Proformatique
*
* Written by Richard Braun <rbraun@proformatique.com>
*
* Based on res_sqlite3 by Anthony Minessale II,
* and res_config_mysql by Matthew Boehm
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*!
* \page res_config_sqlite
*
* \section intro_sec Presentation
*
* res_config_sqlite is a module for the Asterisk Open Source PBX to
* support SQLite 2 databases. It can be used to fetch configuration
* from a database (static configuration files and/or using the Asterisk
* RealTime Architecture - ARA).
* It can also be used to log CDR entries. Finally, it can be used for simple
* queries in the Dialplan. Note that Asterisk already comes with a module
* named cdr_sqlite. There are two reasons for including it in res_config_sqlite:
* the first is that rewriting it was a training to learn how to write a
* simple module for Asterisk, the other is to have the same database open for
* all kinds of operations, which improves reliability and performance.
*
* There is already a module for SQLite 3 (named res_sqlite3) in the Asterisk
* addons. res_config_sqlite was developed because we, at Proformatique, are using
* PHP 4 in our embedded systems, and PHP 4 has no stable support for SQLite 3
* at this time. We also needed RealTime support.
*
* \section conf_sec Configuration
*
* The main configuration file is res_config_sqlite.conf. It must be readable or
* res_config_sqlite will fail to start. It is suggested to use the sample file
* in this package as a starting point. The file has only one section
* named <code>general</code>. Here are the supported parameters :
*
* <dl>
* <dt><code>dbfile</code></dt>
* <dd>The absolute path to the SQLite database (the file can be non existent,
* res_config_sqlite will create it if it has the appropriate rights)</dd>
* <dt><code>config_table</code></dt>
* <dd>The table used for static configuration</dd>
* <dt><code>cdr_table</code></dt>
* <dd>The table used to store CDR entries (if ommitted, CDR support is
* disabled)</dd>
* </dl>
*
* To use res_config_sqlite for static and/or RealTime configuration, refer to the
* Asterisk documentation. The file tables.sql can be used to create the
* needed tables.
*
* \section status_sec Driver status
*
* The CLI command <code>show sqlite status</code> returns status information
* about the running driver.
*
* \section credits_sec Credits
*
* res_config_sqlite was developed by Richard Braun at the Proformatique company.
*/
/*!
* \file
* \brief res_config_sqlite module.
*/
/*** MODULEINFO
<depend>sqlite</depend>
***/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include <sqlite.h>
#include "asterisk/pbx.h"
#include "asterisk/cdr.h"
#include "asterisk/cli.h"
#include "asterisk/lock.h"
#include "asterisk/config.h"
#include "asterisk/module.h"
#include "asterisk/linkedlists.h"
#define MACRO_BEGIN do {
#define MACRO_END } while (0)
#define RES_CONFIG_SQLITE_NAME "res_config_sqlite"
#define RES_CONFIG_SQLITE_DRIVER "sqlite"
#define RES_CONFIG_SQLITE_DESCRIPTION "Resource Module for SQLite 2"
#define RES_CONFIG_SQLITE_CONF_FILE "res_config_sqlite.conf"
enum {
RES_CONFIG_SQLITE_CONFIG_ID,
RES_CONFIG_SQLITE_CONFIG_CAT_METRIC,
RES_CONFIG_SQLITE_CONFIG_VAR_METRIC,
RES_CONFIG_SQLITE_CONFIG_COMMENTED,
RES_CONFIG_SQLITE_CONFIG_FILENAME,
RES_CONFIG_SQLITE_CONFIG_CATEGORY,
RES_CONFIG_SQLITE_CONFIG_VAR_NAME,
RES_CONFIG_SQLITE_CONFIG_VAR_VAL,
RES_CONFIG_SQLITE_CONFIG_COLUMNS,
};
#define SET_VAR(config, to, from) \
MACRO_BEGIN \
int __error; \
\
__error = set_var(&to, #to, from->value); \
\
if (__error) { \
ast_config_destroy(config); \
unload_config(); \
return 1; \
} \
MACRO_END
/*!
* Maximum number of loops before giving up executing a query. Calls to
* sqlite_xxx() functions which can return SQLITE_BUSY or SQLITE_LOCKED
* are enclosed by RES_CONFIG_SQLITE_BEGIN and RES_CONFIG_SQLITE_END, e.g.
* <pre>
* char *errormsg;
* int error;
*
* RES_CONFIG_SQLITE_BEGIN
* error = sqlite_exec(db, query, NULL, NULL, &errormsg);
* RES_CONFIG_SQLITE_END(error)
*
* if (error)
* ...;
* </pre>
*/
#define RES_CONFIG_SQLITE_MAX_LOOPS 10
/*!
* Macro used before executing a query.
*
* \see RES_CONFIG_SQLITE_MAX_LOOPS.
*/
#define RES_CONFIG_SQLITE_BEGIN \
MACRO_BEGIN \
int __i; \
\
for (__i = 0; __i < RES_CONFIG_SQLITE_MAX_LOOPS; __i++) {
/*!
* Macro used after executing a query.
*
* \see RES_CONFIG_SQLITE_MAX_LOOPS.
*/
#define RES_CONFIG_SQLITE_END(error) \
if (error != SQLITE_BUSY && error != SQLITE_LOCKED) \
break; \
usleep(1000); \
} \
MACRO_END;
/*!
* Structure sent to the SQLite callback function for static configuration.
*
* \see add_cfg_entry()
*/
struct cfg_entry_args {
struct ast_config *cfg;
struct ast_category *cat;
char *cat_name;
struct ast_flags flags;
const char *who_asked;
};
/*!
* Structure sent to the SQLite callback function for RealTime configuration.
*
* \see add_rt_cfg_entry()
*/
struct rt_cfg_entry_args {
struct ast_variable *var;
struct ast_variable *last;
};
/*!
* Structure sent to the SQLite callback function for RealTime configuration
* (realtime_multi_handler()).
*
* \see add_rt_multi_cfg_entry()
*/
struct rt_multi_cfg_entry_args {
struct ast_config *cfg;
char *initfield;
};
/*!
* \brief Allocate a variable.
* \param var the address of the variable to set (it will be allocated)
* \param name the name of the variable (for error handling)
* \param value the value to store in var
* \retval 0 on success
* \retval 1 if an allocation error occurred
*/
static int set_var(char **var, const char *name, const char *value);
/*!
* \brief Load the configuration file.
* \see unload_config()
*
* This function sets dbfile, config_table, and cdr_table. It calls
* check_vars() before returning, and unload_config() if an error occurred.
*
* \retval 0 on success
* \retval 1 if an error occurred
*/
static int load_config(void);
/*!
* \brief Free resources related to configuration.
* \see load_config()
*/
static void unload_config(void);
/*!
* \brief Asterisk callback function for CDR support.
* \param cdr the CDR entry Asterisk sends us.
*
* Asterisk will call this function each time a CDR entry must be logged if
* CDR support is enabled.
*
* \retval 0 on success
* \retval 1 if an error occurred
*/
static int cdr_handler(struct ast_cdr *cdr);
/*!
* \brief SQLite callback function for static configuration.
*
* This function is passed to the SQLite engine as a callback function to
* parse a row and store it in a struct ast_config object. It relies on
* resulting rows being sorted by category.
*
* \param arg a pointer to a struct cfg_entry_args object
* \param argc number of columns
* \param argv values in the row
* \param columnNames names and types of the columns
* \retval 0 on success
* \retval 1 if an error occurred
* \see cfg_entry_args
* \see sql_get_config_table
* \see config_handler()
*/
static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames);
/*!
* \brief Asterisk callback function for static configuration.
*
* Asterisk will call this function when it loads its static configuration,
* which usually happens at startup and reload.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param file the file to load from the database
* \param cfg the struct ast_config object to use when storing variables
* \param flags Optional flags. Not used.
* \param suggested_incl suggest include.
* \retval cfg object
* \retval NULL if an error occurred
* \see add_cfg_entry()
*/
static struct ast_config * config_handler(const char *database, const char *table, const char *file,
struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked);
/*!
* \brief Helper function to parse a va_list object into 2 dynamic arrays of
* strings, parameters and values.
*
* ap must have the following format : param1 val1 param2 val2 param3 val3 ...
* arguments will be extracted to create 2 arrays:
*
* <ul>
* <li>params : param1 param2 param3 ...</li>
* <li>vals : val1 val2 val3 ...</li>
* </ul>
*
* The address of these arrays are stored in params_ptr and vals_ptr. It
* is the responsibility of the caller to release the memory of these arrays.
* It is considered an error that va_list has a null or odd number of strings.
*
* \param ap the va_list object to parse
* \param params_ptr where the address of the params array is stored
* \param vals_ptr where the address of the vals array is stored
* \retval the number of elements in the arrays (which have the same size).
* \retval 0 if an error occurred.
*/
static size_t get_params(va_list ap, const char ***params_ptr,
const char ***vals_ptr);
/*!
* \brief SQLite callback function for RealTime configuration.
*
* This function is passed to the SQLite engine as a callback function to
* parse a row and store it in a linked list of struct ast_variable objects.
*
* \param arg a pointer to a struct rt_cfg_entry_args object
* \param argc number of columns
* \param argv values in the row
* \param columnNames names and types of the columns
* \retval 0 on success.
* \retval 1 if an error occurred.
* \see rt_cfg_entry_args
* \see realtime_handler()
*/
static int add_rt_cfg_entry(void *arg, int argc, char **argv,
char **columnNames);
/*!
* Asterisk callback function for RealTime configuration.
*
* Asterisk will call this function each time it requires a variable
* through the RealTime architecture. ap is a list of parameters and
* values used to find a specific row, e.g one parameter "name" and
* one value "123" so that the SQL query becomes <code>SELECT * FROM
* table WHERE name = '123';</code>.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param ap list of parameters and values to match
*
* \retval a linked list of struct ast_variable objects
* \retval NULL if an error occurred
* \see add_rt_cfg_entry()
*/
static struct ast_variable * realtime_handler(const char *database,
const char *table, va_list ap);
/*!
* \brief SQLite callback function for RealTime configuration.
*
* This function performs the same actions as add_rt_cfg_entry() except
* that the rt_multi_cfg_entry_args structure is designed to store
* categories in addition to variables.
*
* \param arg a pointer to a struct rt_multi_cfg_entry_args object
* \param argc number of columns
* \param argv values in the row
* \param columnNames names and types of the columns
* \retval 0 on success.
* \retval 1 if an error occurred.
* \see rt_multi_cfg_entry_args
* \see realtime_multi_handler()
*/
static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv,
char **columnNames);
/*!
* \brief Asterisk callback function for RealTime configuration.
*
* This function performs the same actions as realtime_handler() except
* that it can store variables per category, and can return several
* categories.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param ap list of parameters and values to match
* \retval a struct ast_config object storing categories and variables.
* \retval NULL if an error occurred.
*
* \see add_rt_multi_cfg_entry()
*/
static struct ast_config * realtime_multi_handler(const char *database,
const char *table, va_list ap);
/*!
* \brief Asterisk callback function for RealTime configuration (variable
* update).
*
* Asterisk will call this function each time a variable has been modified
* internally and must be updated in the backend engine. keyfield and entity
* are used to find the row to update, e.g. <code>UPDATE table SET ... WHERE
* keyfield = 'entity';</code>. ap is a list of parameters and values with the
* same format as the other realtime functions.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param keyfield the column of the matching cell
* \param entity the value of the matching cell
* \param ap list of parameters and new values to update in the database
* \retval the number of affected rows.
* \retval -1 if an error occurred.
*/
static int realtime_update_handler(const char *database, const char *table,
const char *keyfield, const char *entity, va_list ap);
/*!
* \brief Asterisk callback function for RealTime configuration (variable
* create/store).
*
* Asterisk will call this function each time a variable has been created
* internally and must be stored in the backend engine.
* are used to find the row to update, e.g. ap is a list of parameters and
* values with the same format as the other realtime functions.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param ap list of parameters and new values to insert into the database
* \retval the rowid of inserted row.
* \retval -1 if an error occurred.
*/
static int realtime_store_handler(const char *database, const char *table,
va_list ap);
/*!
* \brief Asterisk callback function for RealTime configuration (destroys
* variable).
*
* Asterisk will call this function each time a variable has been destroyed
* internally and must be removed from the backend engine. keyfield and entity
* are used to find the row to delete, e.g. <code>DELETE FROM table WHERE
* keyfield = 'entity';</code>. ap is a list of parameters and values with the
* same format as the other realtime functions.
*
* \param database the database to use (ignored)
* \param table the table to use
* \param keyfield the column of the matching cell
* \param entity the value of the matching cell
* \param ap list of additional parameters for cell matching
* \retval the number of affected rows.
* \retval -1 if an error occurred.
*/
static int realtime_destroy_handler(const char *database, const char *table,
const char *keyfield, const char *entity, va_list ap);
/*!
* \brief Asterisk callback function for the CLI status command.
*
* \param e CLI command
* \param cmd
* \param a CLI argument list
* \return RESULT_SUCCESS
*/
static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
/*! The SQLite database object. */
static sqlite *db;
/*! Set to 1 if CDR support is enabled. */
static int use_cdr;
/*! Set to 1 if the CDR callback function was registered. */
static int cdr_registered;
/*! Set to 1 if the CLI status command callback function was registered. */
static int cli_status_registered;
/*! The path of the database file. */
static char *dbfile;
/*! The name of the static configuration table. */
static char *config_table;
/*! The name of the table used to store CDR entries. */
static char *cdr_table;
/*!
* The structure specifying all callback functions used by Asterisk for static
* and RealTime configuration.
*/
static struct ast_config_engine sqlite_engine =
{
.name = RES_CONFIG_SQLITE_DRIVER,
.load_func = config_handler,
.realtime_func = realtime_handler,
.realtime_multi_func = realtime_multi_handler,
.store_func = realtime_store_handler,
.destroy_func = realtime_destroy_handler,
.update_func = realtime_update_handler
};
/*!
* The mutex used to prevent simultaneous access to the SQLite database.
*/
AST_MUTEX_DEFINE_STATIC(mutex);
/*!
* Structure containing details and callback functions for the CLI status
* command.
*/
static struct ast_cli_entry cli_status[] = {
AST_CLI_DEFINE(handle_cli_show_sqlite_status, "Show status information about the SQLite 2 driver"),
};
/*
* Taken from Asterisk 1.2 cdr_sqlite.so.
*/
/*! SQL query format to create the CDR table if non existent. */
static char *sql_create_cdr_table =
"CREATE TABLE '%q' (\n"
" id INTEGER,\n"
" clid VARCHAR(80) NOT NULL DEFAULT '',\n"
" src VARCHAR(80) NOT NULL DEFAULT '',\n"
" dst VARCHAR(80) NOT NULL DEFAULT '',\n"
" dcontext VARCHAR(80) NOT NULL DEFAULT '',\n"
" channel VARCHAR(80) NOT NULL DEFAULT '',\n"
" dstchannel VARCHAR(80) NOT NULL DEFAULT '',\n"
" lastapp VARCHAR(80) NOT NULL DEFAULT '',\n"
" lastdata VARCHAR(80) NOT NULL DEFAULT '',\n"
" start DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',\n"
" answer DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',\n"
" end DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',\n"
" duration INT(11) NOT NULL DEFAULT 0,\n"
" billsec INT(11) NOT NULL DEFAULT 0,\n"
" disposition VARCHAR(45) NOT NULL DEFAULT '',\n"
" amaflags INT(11) NOT NULL DEFAULT 0,\n"
" accountcode VARCHAR(20) NOT NULL DEFAULT '',\n"
" uniqueid VARCHAR(32) NOT NULL DEFAULT '',\n"
" userfield VARCHAR(255) NOT NULL DEFAULT '',\n"
" PRIMARY KEY (id)\n"
");";
/*! SQL query format to insert a CDR entry. */
static char *sql_add_cdr_entry =
"INSERT INTO '%q' ("
" clid,"
" src,"
" dst,"
" dcontext,"
" channel,"
" dstchannel,"
" lastapp,"
" lastdata,"
" start,"
" answer,"
" end,"
" duration,"
" billsec,"
" disposition,"
" amaflags,"
" accountcode,"
" uniqueid,"
" userfield"
") VALUES ("
" '%q',"
" '%q',"
" '%q',"
" '%q',"
" '%q',"
" '%q',"
" '%q',"
" '%q',"
" datetime(%d,'unixepoch','localtime'),"
" datetime(%d,'unixepoch','localtime'),"
" datetime(%d,'unixepoch','localtime'),"
" '%ld',"
" '%ld',"
" '%ld',"
" '%ld',"
" '%q',"
" '%q',"
" '%q'"
");";
/*!
* SQL query format to fetch the static configuration of a file.
* Rows must be sorted by category.
*
* \see add_cfg_entry()
*/
static char *sql_get_config_table =
"SELECT *"
" FROM '%q'"
" WHERE filename = '%q' AND commented = 0"
" ORDER BY cat_metric ASC, var_metric ASC;";
static int set_var(char **var, const char *name, const char *value)
{
if (*var)
ast_free(*var);
*var = ast_strdup(value);
if (!*var) {
ast_log(LOG_WARNING, "Unable to allocate variable %s\n", name);
return 1;
}
return 0;
}
static int check_vars(void)
{
if (!dbfile) {
ast_log(LOG_ERROR, "Undefined parameter %s\n", dbfile);
return 1;
}
use_cdr = (cdr_table != NULL);
return 0;
}
static int load_config(void)
{
struct ast_config *config;
struct ast_variable *var;
int error;
struct ast_flags config_flags = { 0 };
config = ast_config_load(RES_CONFIG_SQLITE_CONF_FILE, config_flags);
if (!config) {
ast_log(LOG_ERROR, "Unable to load " RES_CONFIG_SQLITE_CONF_FILE "\n");
return 1;
}
for (var = ast_variable_browse(config, "general"); var; var = var->next) {
if (!strcasecmp(var->name, "dbfile"))
SET_VAR(config, dbfile, var);
else if (!strcasecmp(var->name, "config_table"))
SET_VAR(config, config_table, var);
else if (!strcasecmp(var->name, "cdr_table"))
SET_VAR(config, cdr_table, var);
else
ast_log(LOG_WARNING, "Unknown parameter : %s\n", var->name);
}
ast_config_destroy(config);
error = check_vars();
if (error) {
unload_config();
return 1;
}
return 0;
}
static void unload_config(void)
{
ast_free(dbfile);
dbfile = NULL;
ast_free(config_table);
config_table = NULL;
ast_free(cdr_table);
cdr_table = NULL;
}
static int cdr_handler(struct ast_cdr *cdr)
{
char *query, *errormsg;
int error;
query = sqlite_mprintf(sql_add_cdr_entry, cdr_table, cdr->clid,
cdr->src, cdr->dst, cdr->dcontext, cdr->channel,
cdr->dstchannel, cdr->lastapp, cdr->lastdata,
cdr->start.tv_sec, cdr->answer.tv_sec,
cdr->end.tv_sec, cdr->duration, cdr->billsec,
cdr->disposition, cdr->amaflags, cdr->accountcode,
cdr->uniqueid, cdr->userfield);
if (!query) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
return 1;
}
ast_debug(1, "SQL query: %s\n", query);
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
ast_mutex_unlock(&mutex);
sqlite_freemem(query);
if (error) {
ast_log(LOG_ERROR, "%s\n", errormsg);
sqlite_freemem(errormsg);
return 1;
}
return 0;
}
static int add_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
{
struct cfg_entry_args *args;
struct ast_variable *var;
if (argc != RES_CONFIG_SQLITE_CONFIG_COLUMNS) {
ast_log(LOG_WARNING, "Corrupt table\n");
return 1;
}
args = arg;
if (!strcmp(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], "#include")) {
struct ast_config *cfg;
char *val;
val = argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL];
cfg = ast_config_internal_load(val, args->cfg, args->flags, "", args->who_asked);
if (!cfg) {
ast_log(LOG_WARNING, "Unable to include %s\n", val);
return 1;
} else {
args->cfg = cfg;
return 0;
}
}
if (!args->cat_name || strcmp(args->cat_name, argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY])) {
args->cat = ast_category_new(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY], "", 99999);
if (!args->cat) {
ast_log(LOG_WARNING, "Unable to allocate category\n");
return 1;
}
ast_free(args->cat_name);
args->cat_name = ast_strdup(argv[RES_CONFIG_SQLITE_CONFIG_CATEGORY]);
if (!args->cat_name) {
ast_category_destroy(args->cat);
return 1;
}
ast_category_append(args->cfg, args->cat);
}
var = ast_variable_new(argv[RES_CONFIG_SQLITE_CONFIG_VAR_NAME], argv[RES_CONFIG_SQLITE_CONFIG_VAR_VAL], "");
if (!var) {
ast_log(LOG_WARNING, "Unable to allocate variable");
return 1;
}
ast_variable_append(args->cat, var);
return 0;
}
static struct ast_config *config_handler(const char *database, const char *table, const char *file,
struct ast_config *cfg, struct ast_flags flags, const char *suggested_incl, const char *who_asked)
{
struct cfg_entry_args args;
char *query, *errormsg;
int error;
if (!config_table) {
if (!table) {
ast_log(LOG_ERROR, "Table name unspecified\n");
return NULL;
}
} else
table = config_table;
query = sqlite_mprintf(sql_get_config_table, table, file);
if (!query) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
return NULL;
}
ast_debug(1, "SQL query: %s\n", query);
args.cfg = cfg;
args.cat = NULL;
args.cat_name = NULL;
args.flags = flags;
args.who_asked = who_asked;
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, add_cfg_entry, &args, &errormsg);
RES_CONFIG_SQLITE_END(error)
ast_mutex_unlock(&mutex);
ast_free(args.cat_name);
sqlite_freemem(query);
if (error) {
ast_log(LOG_ERROR, "%s\n", errormsg);
sqlite_freemem(errormsg);
return NULL;
}
return cfg;
}
static size_t get_params(va_list ap, const char ***params_ptr, const char ***vals_ptr)
{
const char **tmp, *param, *val, **params, **vals;
size_t params_count;
params = NULL;
vals = NULL;
params_count = 0;
while ((param = va_arg(ap, const char *)) && (val = va_arg(ap, const char *))) {
if (!(tmp = ast_realloc(params, (params_count + 1) * sizeof(char *)))) {
ast_free(params);
ast_free(vals);
return 0;
}
params = tmp;
if (!(tmp = ast_realloc(vals, (params_count + 1) * sizeof(char *)))) {
ast_free(params);
ast_free(vals);
return 0;
}
vals = tmp;
params[params_count] = param;
vals[params_count] = val;
params_count++;
}
if (params_count > 0) {
*params_ptr = params;
*vals_ptr = vals;
} else
ast_log(LOG_WARNING, "1 parameter and 1 value at least required\n");
return params_count;
}
static int add_rt_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
{
struct rt_cfg_entry_args *args;
struct ast_variable *var;
int i;
args = arg;
for (i = 0; i < argc; i++) {
if (!argv[i])
continue;
if (!(var = ast_variable_new(columnNames[i], argv[i], "")))
return 1;
if (!args->var)
args->var = var;
if (!args->last)
args->last = var;
else {
args->last->next = var;
args->last = var;
}
}
return 0;
}
static struct ast_variable * realtime_handler(const char *database, const char *table, va_list ap)
{
char *query, *errormsg, *op, *tmp_str;
struct rt_cfg_entry_args args;
const char **params, **vals;
size_t params_count;
int error;
if (!table) {
ast_log(LOG_WARNING, "Table name unspecified\n");
return NULL;
}
params_count = get_params(ap, &params, &vals);
if (params_count == 0)
return NULL;
op = (strchr(params[0], ' ') == NULL) ? " =" : "";
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
/* \endcond */
query = sqlite_mprintf(QUERY, table, params[0], op, vals[0]);
if (!query) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
ast_free(params);
ast_free(vals);
return NULL;
}
if (params_count > 1) {
size_t i;
for (i = 1; i < params_count; i++) {
op = (strchr(params[i], ' ') == NULL) ? " =" : "";
tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
sqlite_freemem(query);
if (!tmp_str) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_free(params);
ast_free(vals);
return NULL;
}
query = tmp_str;
}
}
ast_free(params);
ast_free(vals);
tmp_str = sqlite_mprintf("%s LIMIT 1;", query);
sqlite_freemem(query);
if (!tmp_str) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
return NULL;
}
query = tmp_str;
ast_debug(1, "SQL query: %s\n", query);
args.var = NULL;
args.last = NULL;
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, add_rt_cfg_entry, &args, &errormsg);
RES_CONFIG_SQLITE_END(error)
ast_mutex_unlock(&mutex);
sqlite_freemem(query);
if (error) {
ast_log(LOG_WARNING, "%s\n", errormsg);
sqlite_freemem(errormsg);
ast_variables_destroy(args.var);
return NULL;
}
return args.var;
}
static int add_rt_multi_cfg_entry(void *arg, int argc, char **argv, char **columnNames)
{
struct rt_multi_cfg_entry_args *args;
struct ast_category *cat;
struct ast_variable *var;
char *cat_name;
size_t i;
args = arg;
cat_name = NULL;
/*
* cat_name should always be set here, since initfield is forged from
* params[0] in realtime_multi_handler(), which is a search parameter
* of the SQL query.
*/
for (i = 0; i < argc; i++) {
if (!strcmp(args->initfield, columnNames[i]))
cat_name = argv[i];
}
if (!cat_name) {
ast_log(LOG_ERROR, "Bogus SQL results, cat_name is NULL !\n");
return 1;
}
if (!(cat = ast_category_new(cat_name, "", 99999))) {
ast_log(LOG_WARNING, "Unable to allocate category\n");
return 1;
}
ast_category_append(args->cfg, cat);
for (i = 0; i < argc; i++) {
if (!argv[i] || !strcmp(args->initfield, columnNames[i]))
continue;
if (!(var = ast_variable_new(columnNames[i], argv[i], ""))) {
ast_log(LOG_WARNING, "Unable to allocate variable\n");
return 1;
}
ast_variable_append(cat, var);
}
return 0;
}
static struct ast_config *realtime_multi_handler(const char *database,
const char *table, va_list ap)
{
char *query, *errormsg, *op, *tmp_str, *initfield;
struct rt_multi_cfg_entry_args args;
const char **params, **vals;
struct ast_config *cfg;
size_t params_count;
int error;
if (!table) {
ast_log(LOG_WARNING, "Table name unspecified\n");
return NULL;
}
if (!(cfg = ast_config_new())) {
ast_log(LOG_WARNING, "Unable to allocate configuration structure\n");
return NULL;
}
if (!(params_count = get_params(ap, &params, &vals))) {
ast_config_destroy(cfg);
return NULL;
}
if (!(initfield = ast_strdup(params[0]))) {
ast_config_destroy(cfg);
ast_free(params);
ast_free(vals);
return NULL;
}
tmp_str = strchr(initfield, ' ');
if (tmp_str)
*tmp_str = '\0';
op = (!strchr(params[0], ' ')) ? " =" : "";
/*
* Asterisk sends us an already escaped string when searching for
* "exten LIKE" (uh!). Handle it separately.
*/
tmp_str = (!strcmp(vals[0], "\\_%")) ? "_%" : (char *)vals[0];
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "SELECT * FROM '%q' WHERE commented = 0 AND %q%s '%q'"
/* \endcond */
if (!(query = sqlite_mprintf(QUERY, table, params[0], op, tmp_str))) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
ast_config_destroy(cfg);
ast_free(params);
ast_free(vals);
ast_free(initfield);
return NULL;
}
if (params_count > 1) {
size_t i;
for (i = 1; i < params_count; i++) {
op = (!strchr(params[i], ' ')) ? " =" : "";
tmp_str = sqlite_mprintf("%s AND %q%s '%q'", query, params[i], op, vals[i]);
sqlite_freemem(query);
if (!tmp_str) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_config_destroy(cfg);
ast_free(params);
ast_free(vals);
ast_free(initfield);
return NULL;
}
query = tmp_str;
}
}
ast_free(params);
ast_free(vals);
if (!(tmp_str = sqlite_mprintf("%s ORDER BY %q;", query, initfield))) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_config_destroy(cfg);
ast_free(initfield);
return NULL;
}
sqlite_freemem(query);
query = tmp_str;
ast_debug(1, "SQL query: %s\n", query);
args.cfg = cfg;
args.initfield = initfield;
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, add_rt_multi_cfg_entry, &args, &errormsg);
RES_CONFIG_SQLITE_END(error)
ast_mutex_unlock(&mutex);
sqlite_freemem(query);
ast_free(initfield);
if (error) {
ast_log(LOG_WARNING, "%s\n", errormsg);
sqlite_freemem(errormsg);
ast_config_destroy(cfg);
return NULL;
}
return cfg;
}
static int realtime_update_handler(const char *database, const char *table,
const char *keyfield, const char *entity, va_list ap)
{
char *query, *errormsg, *tmp_str;
const char **params, **vals;
size_t params_count;
int error, rows_num;
if (!table) {
ast_log(LOG_WARNING, "Table name unspecified\n");
return -1;
}
if (!(params_count = get_params(ap, &params, &vals)))
return -1;
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "UPDATE '%q' SET %q = '%q'"
/* \endcond */
if (!(query = sqlite_mprintf(QUERY, table, params[0], vals[0]))) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
if (params_count > 1) {
size_t i;
for (i = 1; i < params_count; i++) {
tmp_str = sqlite_mprintf("%s, %q = '%q'", query, params[i], vals[i]);
sqlite_freemem(query);
if (!tmp_str) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
query = tmp_str;
}
}
ast_free(params);
ast_free(vals);
if (!(tmp_str = sqlite_mprintf("%s WHERE %q = '%q';", query, keyfield, entity))) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
return -1;
}
sqlite_freemem(query);
query = tmp_str;
ast_debug(1, "SQL query: %s\n", query);
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
if (!error)
rows_num = sqlite_changes(db);
else
rows_num = -1;
ast_mutex_unlock(&mutex);
sqlite_freemem(query);
if (error) {
ast_log(LOG_WARNING, "%s\n", errormsg);
sqlite_freemem(errormsg);
}
return rows_num;
}
static int realtime_store_handler(const char *database, const char *table, va_list ap)
{
char *errormsg, *tmp_str, *tmp_keys = NULL, *tmp_keys2 = NULL, *tmp_vals = NULL, *tmp_vals2 = NULL;
const char **params, **vals;
size_t params_count;
int error, rows_id;
size_t i;
if (!table) {
ast_log(LOG_WARNING, "Table name unspecified\n");
return -1;
}
if (!(params_count = get_params(ap, &params, &vals)))
return -1;
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "INSERT into '%q' (%s) VALUES (%s);"
/* \endcond */
for (i = 0; i < params_count; i++) {
if ( tmp_keys2 ) {
tmp_keys = sqlite_mprintf("%s, %q", tmp_keys2, params[i]);
sqlite_freemem(tmp_keys2);
} else {
tmp_keys = sqlite_mprintf("%q", params[i]);
}
if (!tmp_keys) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
if ( tmp_vals2 ) {
tmp_vals = sqlite_mprintf("%s, '%q'", tmp_vals2, params[i]);
sqlite_freemem(tmp_vals2);
} else {
tmp_vals = sqlite_mprintf("'%q'", params[i]);
}
if (!tmp_vals) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
tmp_keys2 = tmp_keys;
tmp_vals2 = tmp_vals;
}
ast_free(params);
ast_free(vals);
if (!(tmp_str = sqlite_mprintf(QUERY, table, tmp_keys, tmp_vals))) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
return -1;
}
sqlite_freemem(tmp_keys);
sqlite_freemem(tmp_vals);
ast_debug(1, "SQL query: %s\n", tmp_str);
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, tmp_str, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
if (!error) {
rows_id = sqlite_last_insert_rowid(db);
} else {
rows_id = -1;
}
ast_mutex_unlock(&mutex);
sqlite_freemem(tmp_str);
if (error) {
ast_log(LOG_WARNING, "%s\n", errormsg);
sqlite_freemem(errormsg);
}
return rows_id;
}
static int realtime_destroy_handler(const char *database, const char *table,
const char *keyfield, const char *entity, va_list ap)
{
char *query, *errormsg, *tmp_str;
const char **params, **vals;
size_t params_count;
int error, rows_num;
size_t i;
if (!table) {
ast_log(LOG_WARNING, "Table name unspecified\n");
return -1;
}
if (!(params_count = get_params(ap, &params, &vals)))
return -1;
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "DELETE FROM '%q' WHERE"
/* \endcond */
if (!(query = sqlite_mprintf(QUERY, table))) {
ast_log(LOG_WARNING, "Unable to allocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
for (i = 0; i < params_count; i++) {
tmp_str = sqlite_mprintf("%s %q = '%q' AND", query, params[i], vals[i]);
sqlite_freemem(query);
if (!tmp_str) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
ast_free(params);
ast_free(vals);
return -1;
}
query = tmp_str;
}
ast_free(params);
ast_free(vals);
if (!(tmp_str = sqlite_mprintf("%s %q = '%q';", query, keyfield, entity))) {
ast_log(LOG_WARNING, "Unable to reallocate SQL query\n");
return -1;
}
sqlite_freemem(query);
query = tmp_str;
ast_debug(1, "SQL query: %s\n", query);
ast_mutex_lock(&mutex);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
if (!error)
rows_num = sqlite_changes(db);
else
rows_num = -1;
ast_mutex_unlock(&mutex);
sqlite_freemem(query);
if (error) {
ast_log(LOG_WARNING, "%s\n", errormsg);
sqlite_freemem(errormsg);
}
return rows_num;
}
static char *handle_cli_show_sqlite_status(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
switch (cmd) {
case CLI_INIT:
e->command = "show sqlite status";
e->usage =
"Usage: show sqlite status\n"
" Show status information about the SQLite 2 driver\n";
return NULL;
case CLI_GENERATE:
return NULL;
}
if (a->argc != 3)
return CLI_SHOWUSAGE;
ast_cli(a->fd, "SQLite database path: %s\n", dbfile);
ast_cli(a->fd, "config_table: ");
if (!config_table)
ast_cli(a->fd, "unspecified, must be present in extconfig.conf\n");
else
ast_cli(a->fd, "%s\n", config_table);
ast_cli(a->fd, "cdr_table: ");
if (!cdr_table)
ast_cli(a->fd, "unspecified, CDR support disabled\n");
else
ast_cli(a->fd, "%s\n", cdr_table);
return CLI_SUCCESS;
}
static int unload_module(void)
{
if (cli_status_registered)
ast_cli_unregister_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
if (cdr_registered)
ast_cdr_unregister(RES_CONFIG_SQLITE_NAME);
ast_config_engine_deregister(&sqlite_engine);
if (db)
sqlite_close(db);
unload_config();
return 0;
}
static int load_module(void)
{
char *errormsg;
int error;
db = NULL;
cdr_registered = 0;
cli_status_registered = 0;
dbfile = NULL;
config_table = NULL;
cdr_table = NULL;
error = load_config();
if (error)
return AST_MODULE_LOAD_DECLINE;
if (!(db = sqlite_open(dbfile, 0660, &errormsg))) {
ast_log(LOG_ERROR, "%s\n", errormsg);
sqlite_freemem(errormsg);
unload_module();
return 1;
}
ast_config_engine_register(&sqlite_engine);
if (use_cdr) {
char *query;
/* \cond DOXYGEN_CAN_PARSE_THIS */
#undef QUERY
#define QUERY "SELECT COUNT(id) FROM %Q;"
/* \endcond */
query = sqlite_mprintf(QUERY, cdr_table);
if (!query) {
ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
unload_module();
return 1;
}
ast_debug(1, "SQL query: %s\n", query);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
sqlite_freemem(query);
if (error) {
/*
* Unexpected error.
*/
if (error != SQLITE_ERROR) {
ast_log(LOG_ERROR, "%s\n", errormsg);
sqlite_freemem(errormsg);
unload_module();
return 1;
}
sqlite_freemem(errormsg);
query = sqlite_mprintf(sql_create_cdr_table, cdr_table);
if (!query) {
ast_log(LOG_ERROR, "Unable to allocate SQL query\n");
unload_module();
return 1;
}
ast_debug(1, "SQL query: %s\n", query);
RES_CONFIG_SQLITE_BEGIN
error = sqlite_exec(db, query, NULL, NULL, &errormsg);
RES_CONFIG_SQLITE_END(error)
sqlite_freemem(query);
if (error) {
ast_log(LOG_ERROR, "%s\n", errormsg);
sqlite_freemem(errormsg);
unload_module();
return 1;
}
}
error = ast_cdr_register(RES_CONFIG_SQLITE_NAME, RES_CONFIG_SQLITE_DESCRIPTION, cdr_handler);
if (error) {
unload_module();
return 1;
}
cdr_registered = 1;
}
error = ast_cli_register_multiple(cli_status, sizeof(cli_status) / sizeof(struct ast_cli_entry));
if (error) {
unload_module();
return 1;
}
cli_status_registered = 1;
return 0;
}
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Realtime SQLite configuration",
.load = load_module,
.unload = unload_module,
);