1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
|
/*
* 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
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision: 403917 $")
#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_KEYS" language="en_US">
<synopsis>
Obtain a list of keys within the Asterisk database.
</synopsis>
<syntax>
<parameter name="prefix" />
</syntax>
<description>
<para>This function will return a comma-separated list of keys existing
at the prefix specified within the Asterisk database. If no argument is
provided, then a list of key families will be returned.</para>
</description>
</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>
<note>
<para>If <literal>live_dangerously</literal> in <literal>asterisk.conf</literal>
is set to <literal>no</literal>, this function can only be read from the
dialplan, and not directly from external protocols. It can, however, be
executed as a write operation (<literal>DB_DELETE(family, key)=ignored</literal>)</para>
</note>
</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_keys(struct ast_channel *chan, const char *cmd, char *parse, struct ast_str **result, ssize_t maxlen)
{
size_t parselen = strlen(parse);
struct ast_db_entry *dbe, *orig_dbe;
struct ast_str *escape_buf = NULL;
const char *last = "";
/* Remove leading and trailing slashes */
while (parse[0] == '/') {
parse++;
parselen--;
}
while (parse[parselen - 1] == '/') {
parse[--parselen] = '\0';
}
ast_str_reset(*result);
/* Nothing within the database at that prefix? */
if (!(orig_dbe = dbe = ast_db_gettree(parse, NULL))) {
return 0;
}
for (; dbe; dbe = dbe->next) {
/* Find the current component */
char *curkey = &dbe->key[parselen + 1], *slash;
if (*curkey == '/') {
curkey++;
}
/* Remove everything after the current component */
if ((slash = strchr(curkey, '/'))) {
*slash = '\0';
}
/* Skip duplicates */
if (!strcasecmp(last, curkey)) {
continue;
}
last = curkey;
if (orig_dbe != dbe) {
ast_str_append(result, maxlen, ",");
}
ast_str_append_escapecommas(result, maxlen, curkey, strlen(curkey));
}
ast_db_freetree(orig_dbe);
ast_free(escape_buf);
return 0;
}
static struct ast_custom_function db_keys_function = {
.name = "DB_KEYS",
.read2 = function_db_keys,
};
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;
}
/*!
* \brief Wrapper to execute DB_DELETE from a write operation. Allows execution
* even if live_dangerously is disabled.
*/
static int function_db_delete_write(struct ast_channel *chan, const char *cmd, char *parse,
const char *value)
{
/* Throwaway to hold the result from the read */
char buf[128];
return function_db_delete(chan, cmd, parse, buf, sizeof(buf));
}
static struct ast_custom_function db_delete_function = {
.name = "DB_DELETE",
.read = function_db_delete,
.write = function_db_delete_write,
};
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);
res |= ast_custom_function_unregister(&db_keys_function);
return res;
}
static int load_module(void)
{
int res = 0;
res |= ast_custom_function_register_escalating(&db_function, AST_CFE_BOTH);
res |= ast_custom_function_register(&db_exists_function);
res |= ast_custom_function_register_escalating(&db_delete_function, AST_CFE_READ);
res |= ast_custom_function_register(&db_keys_function);
return res;
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Database (astdb) related dialplan functions");
|