funcs/func_db.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 2005-2006, Russell Bryant <russelb@clemson.edu>
   5  *
   6  * func_db.c adapted from the old app_db.c, copyright by the following people
   7  * Copyright (C) 2005, Mark Spencer <markster@digium.com>
   8  * Copyright (C) 2003, Jefferson Noxon <jeff@debian.org>
   9  *
  10  * See http://www.asterisk.org for more information about
  11  * the Asterisk project. Please do not directly contact
  12  * any of the maintainers of this project for assistance;
  13  * the project provides a web site, mailing lists and IRC
  14  * channels for your use.
  15  *
  16  * This program is free software, distributed under the terms of
  17  * the GNU General Public License Version 2. See the LICENSE file
  18  * at the top of the source tree.
  19  */
  20
  21 /*! \file
  22  *
  23  * \brief Functions for interaction with the Asterisk database
  24  *
  25  * \author Russell Bryant <russelb@clemson.edu>
  26  *
  27  * \ingroup functions
  28  */
  29
  30 #include "asterisk.h"
  31
  32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  33
  34 #include <regex.h>
  35
  36 #include "asterisk/module.h"
  37 #include "asterisk/channel.h"
  38 #include "asterisk/pbx.h"
  39 #include "asterisk/utils.h"
  40 #include "asterisk/app.h"
  41 #include "asterisk/astdb.h"
  42
  43 static int function_db_read(struct ast_channel *chan, const char *cmd,
  44                             char *parse, char *buf, size_t len)
  45 {
  46         AST_DECLARE_APP_ARGS(args,
  47                              AST_APP_ARG(family);
  48                              AST_APP_ARG(key);
  49         );
  50
  51         buf[0] = '\0';
  52
  53         if (ast_strlen_zero(parse)) {
  54                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
  55                 return -1;
  56         }
  57
  58         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
  59
  60         if (args.argc < 2) {
  61                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
  62                 return -1;
  63         }
  64
  65         if (ast_db_get(args.family, args.key, buf, len - 1)) {
  66                 ast_debug(1, "DB: %s/%s not found in database.\n", args.family, args.key);
  67         } else
  68                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
  69
  70         return 0;
  71 }
  72
  73 static int function_db_write(struct ast_channel *chan, const char *cmd, char *parse,
  74                              const char *value)
  75 {
  76         AST_DECLARE_APP_ARGS(args,
  77                              AST_APP_ARG(family);
  78                              AST_APP_ARG(key);
  79         );
  80
  81         if (ast_strlen_zero(parse)) {
  82                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
  83                 return -1;
  84         }
  85
  86         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
  87
  88         if (args.argc < 2) {
  89                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
  90                 return -1;
  91         }
  92
  93         if (ast_db_put(args.family, args.key, (char *) value))
  94                 ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
  95
  96         return 0;
  97 }
  98
  99 static struct ast_custom_function db_function = {
 100         .name = "DB",
 101         .synopsis = "Read from or write to the Asterisk database",
 102         .syntax = "DB(<family>/<key>)",
 103         .desc =
 104 "This function will read from or write a value to the Asterisk database.  On a\n"
 105 "read, this function returns the corresponding value from the database, or blank\n"
 106 "if it does not exist.  Reading a database value will also set the variable\n"
 107 "DB_RESULT.  If you wish to find out if an entry exists, use the DB_EXISTS\n"
 108 "function.\n",
 109         .read = function_db_read,
 110         .write = function_db_write,
 111 };
 112
 113 static int function_db_exists(struct ast_channel *chan, const char *cmd,
 114                               char *parse, char *buf, size_t len)
 115 {
 116         AST_DECLARE_APP_ARGS(args,
 117                              AST_APP_ARG(family);
 118                              AST_APP_ARG(key);
 119         );
 120
 121         buf[0] = '\0';
 122
 123         if (ast_strlen_zero(parse)) {
 124                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
 125                 return -1;
 126         }
 127
 128         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 129
 130         if (args.argc < 2) {
 131                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
 132                 return -1;
 133         }
 134
 135         if (ast_db_get(args.family, args.key, buf, len - 1))
 136                 strcpy(buf, "0");
 137         else {
 138                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
 139                 strcpy(buf, "1");
 140         }
 141
 142         return 0;
 143 }
 144
 145 static struct ast_custom_function db_exists_function = {
 146         .name = "DB_EXISTS",
 147         .synopsis = "Check to see if a key exists in the Asterisk database",
 148         .syntax = "DB_EXISTS(<family>/<key>)",
 149         .desc =
 150                 "This function will check to see if a key exists in the Asterisk\n"
 151                 "database. If it exists, the function will return \"1\". If not,\n"
 152                 "it will return \"0\".  Checking for existence of a database key will\n"
 153                 "also set the variable DB_RESULT to the key's value if it exists.\n",
 154         .read = function_db_exists,
 155 };
 156
 157 static int function_db_delete(struct ast_channel *chan, const char *cmd,
 158                               char *parse, char *buf, size_t len)
 159 {
 160         AST_DECLARE_APP_ARGS(args,
 161                              AST_APP_ARG(family);
 162                              AST_APP_ARG(key);
 163         );
 164
 165         buf[0] = '\0';
 166
 167         if (ast_strlen_zero(parse)) {
 168                 ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
 169                 return -1;
 170         }
 171
 172         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
 173
 174         if (args.argc < 2) {
 175                 ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
 176                 return -1;
 177         }
 178
 179         if (ast_db_get(args.family, args.key, buf, len - 1)) {
 180                 ast_debug(1, "DB_DELETE: %s/%s not found in database.\n", args.family, args.key);
 181         } else {
 182                 if (ast_db_del(args.family, args.key)) {
 183                         ast_debug(1, "DB_DELETE: %s/%s could not be deleted from the database\n", args.family, args.key);
 184                 }
 185         }
 186         pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
 187
 188         return 0;
 189 }
 190
 191
 192 static struct ast_custom_function db_delete_function = {
 193         .name = "DB_DELETE",
 194         .synopsis = "Return a value from the database and delete it",
 195         .syntax = "DB_DELETE(<family>/<key>)",
 196         .desc =
 197                 "This function will retrieve a value from the Asterisk database\n"
 198                 " and then remove that key from the database.  DB_RESULT\n"
 199                 "will be set to the key's value if it exists.\n",
 200         .read = function_db_delete,
 201 };
 202
 203 static int unload_module(void)
 204 {
 205         int res = 0;
 206
 207         res |= ast_custom_function_unregister(&db_function);
 208         res |= ast_custom_function_unregister(&db_exists_function);
 209         res |= ast_custom_function_unregister(&db_delete_function);
 210
 211         return res;
 212 }
 213
 214 static int load_module(void)
 215 {
 216         int res = 0;
 217
 218         res |= ast_custom_function_register(&db_function);
 219         res |= ast_custom_function_register(&db_exists_function);
 220         res |= ast_custom_function_register(&db_delete_function);
 221
 222         return res;
 223 }
 224
 225 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Database (astdb) related dialplan functions");