a866a75900
This branch adds additional methods to dialplan functions, whereby the result buffers are now dynamic buffers, which can be expanded to the size of any result. No longer are variable substitutions limited to 4095 bytes of data. In addition, the common case of needing buffers much smaller than that will enable substitution to only take up the amount of memory actually needed. The existing variable substitution routines are still available, but users of those API calls should transition to using the dynamic-buffer APIs. Reviewboard: http://reviewboard.digium.com/r/174/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@191140 65c4cc65-6c06-0410-ace0-fbb531ad65f3
271 lines
7 KiB
C
271 lines
7 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2005-2006, Russell Bryant <russelb@clemson.edu>
|
|
*
|
|
* func_db.c adapted from the old app_db.c, copyright by the following people
|
|
* Copyright (C) 2005, Mark Spencer <markster@digium.com>
|
|
* Copyright (C) 2003, Jefferson Noxon <jeff@debian.org>
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Functions for interaction with the Asterisk database
|
|
*
|
|
* \author Russell Bryant <russelb@clemson.edu>
|
|
*
|
|
* \ingroup functions
|
|
*/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include <regex.h>
|
|
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/utils.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/astdb.h"
|
|
|
|
/*** DOCUMENTATION
|
|
<function name="DB" language="en_US">
|
|
<synopsis>
|
|
Read from or write to the Asterisk database.
|
|
</synopsis>
|
|
<syntax argsep="/">
|
|
<parameter name="family" required="true" />
|
|
<parameter name="key" required="true" />
|
|
</syntax>
|
|
<description>
|
|
<para>This function will read from or write a value to the Asterisk database. On a
|
|
read, this function returns the corresponding value from the database, or blank
|
|
if it does not exist. Reading a database value will also set the variable
|
|
DB_RESULT. If you wish to find out if an entry exists, use the DB_EXISTS
|
|
function.</para>
|
|
</description>
|
|
<see-also>
|
|
<ref type="application">DBdel</ref>
|
|
<ref type="function">DB_DELETE</ref>
|
|
<ref type="application">DBdeltree</ref>
|
|
<ref type="function">DB_EXISTS</ref>
|
|
</see-also>
|
|
</function>
|
|
<function name="DB_EXISTS" language="en_US">
|
|
<synopsis>
|
|
Check to see if a key exists in the Asterisk database.
|
|
</synopsis>
|
|
<syntax argsep="/">
|
|
<parameter name="family" required="true" />
|
|
<parameter name="key" required="true" />
|
|
</syntax>
|
|
<description>
|
|
<para>This function will check to see if a key exists in the Asterisk
|
|
database. If it exists, the function will return <literal>1</literal>. If not,
|
|
it will return <literal>0</literal>. Checking for existence of a database key will
|
|
also set the variable DB_RESULT to the key's value if it exists.</para>
|
|
</description>
|
|
<see-also>
|
|
<ref type="function">DB</ref>
|
|
</see-also>
|
|
</function>
|
|
<function name="DB_DELETE" language="en_US">
|
|
<synopsis>
|
|
Return a value from the database and delete it.
|
|
</synopsis>
|
|
<syntax argsep="/">
|
|
<parameter name="family" required="true" />
|
|
<parameter name="key" required="true" />
|
|
</syntax>
|
|
<description>
|
|
<para>This function will retrieve a value from the Asterisk database
|
|
and then remove that key from the database. <variable>DB_RESULT</variable>
|
|
will be set to the key's value if it exists.</para>
|
|
</description>
|
|
<see-also>
|
|
<ref type="application">DBdel</ref>
|
|
<ref type="function">DB</ref>
|
|
<ref type="application">DBdeltree</ref>
|
|
</see-also>
|
|
</function>
|
|
***/
|
|
|
|
static int function_db_read(struct ast_channel *chan, const char *cmd,
|
|
char *parse, char *buf, size_t len)
|
|
{
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(family);
|
|
AST_APP_ARG(key);
|
|
);
|
|
|
|
buf[0] = '\0';
|
|
|
|
if (ast_strlen_zero(parse)) {
|
|
ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
AST_NONSTANDARD_APP_ARGS(args, parse, '/');
|
|
|
|
if (args.argc < 2) {
|
|
ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
if (ast_db_get(args.family, args.key, buf, len - 1)) {
|
|
ast_debug(1, "DB: %s/%s not found in database.\n", args.family, args.key);
|
|
} else {
|
|
pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int function_db_write(struct ast_channel *chan, const char *cmd, char *parse,
|
|
const char *value)
|
|
{
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(family);
|
|
AST_APP_ARG(key);
|
|
);
|
|
|
|
if (ast_strlen_zero(parse)) {
|
|
ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
|
|
return -1;
|
|
}
|
|
|
|
AST_NONSTANDARD_APP_ARGS(args, parse, '/');
|
|
|
|
if (args.argc < 2) {
|
|
ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
|
|
return -1;
|
|
}
|
|
|
|
if (ast_db_put(args.family, args.key, value)) {
|
|
ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function db_function = {
|
|
.name = "DB",
|
|
.read = function_db_read,
|
|
.write = function_db_write,
|
|
};
|
|
|
|
static int function_db_exists(struct ast_channel *chan, const char *cmd,
|
|
char *parse, char *buf, size_t len)
|
|
{
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(family);
|
|
AST_APP_ARG(key);
|
|
);
|
|
|
|
buf[0] = '\0';
|
|
|
|
if (ast_strlen_zero(parse)) {
|
|
ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
AST_NONSTANDARD_APP_ARGS(args, parse, '/');
|
|
|
|
if (args.argc < 2) {
|
|
ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
if (ast_db_get(args.family, args.key, buf, len - 1)) {
|
|
strcpy(buf, "0");
|
|
} else {
|
|
pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
|
|
strcpy(buf, "1");
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static struct ast_custom_function db_exists_function = {
|
|
.name = "DB_EXISTS",
|
|
.read = function_db_exists,
|
|
.read_max = 2,
|
|
};
|
|
|
|
static int function_db_delete(struct ast_channel *chan, const char *cmd,
|
|
char *parse, char *buf, size_t len)
|
|
{
|
|
AST_DECLARE_APP_ARGS(args,
|
|
AST_APP_ARG(family);
|
|
AST_APP_ARG(key);
|
|
);
|
|
|
|
buf[0] = '\0';
|
|
|
|
if (ast_strlen_zero(parse)) {
|
|
ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
AST_NONSTANDARD_APP_ARGS(args, parse, '/');
|
|
|
|
if (args.argc < 2) {
|
|
ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
|
|
return -1;
|
|
}
|
|
|
|
if (ast_db_get(args.family, args.key, buf, len - 1)) {
|
|
ast_debug(1, "DB_DELETE: %s/%s not found in database.\n", args.family, args.key);
|
|
} else {
|
|
if (ast_db_del(args.family, args.key)) {
|
|
ast_debug(1, "DB_DELETE: %s/%s could not be deleted from the database\n", args.family, args.key);
|
|
}
|
|
}
|
|
|
|
pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
static struct ast_custom_function db_delete_function = {
|
|
.name = "DB_DELETE",
|
|
.read = function_db_delete,
|
|
};
|
|
|
|
static int unload_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_unregister(&db_function);
|
|
res |= ast_custom_function_unregister(&db_exists_function);
|
|
res |= ast_custom_function_unregister(&db_delete_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
int res = 0;
|
|
|
|
res |= ast_custom_function_register(&db_function);
|
|
res |= ast_custom_function_register(&db_exists_function);
|
|
res |= ast_custom_function_register(&db_delete_function);
|
|
|
|
return res;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Database (astdb) related dialplan functions");
|