funcs/func_db.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 2005, 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
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/types.h>
  31 #include <regex.h>
  32
  33 #include "asterisk.h"
  34
  35 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
  36
  37 #include "asterisk/channel.h"
  38 #include "asterisk/pbx.h"
  39 #include "asterisk/logger.h"
  40 #include "asterisk/options.h"
  41 #include "asterisk/utils.h"
  42 #include "asterisk/app.h"
  43 #include "asterisk/astdb.h"
  44
  45 static char *function_db_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
  46 {
  47         int argc;
  48         char *args;
  49         char *argv[2];
  50         char *family;
  51         char *key;
  52
  53         if (ast_strlen_zero(data)) {
  54                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
  55                 return buf;
  56         }
  57
  58         args = ast_strdupa(data);
  59         argc = ast_app_separate_args(args, '/', argv, sizeof(argv) / sizeof(argv[0]));
  60
  61         if (argc > 1) {
  62                 family = argv[0];
  63                 key = argv[1];
  64         } else {
  65                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
  66                 return buf;
  67         }
  68
  69         if (ast_db_get(family, key, buf, len-1)) {
  70                 ast_log(LOG_DEBUG, "DB: %s/%s not found in database.\n", family, key);
  71         } else
  72                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
  73
  74
  75         return buf;
  76 }
  77
  78 static void function_db_write(struct ast_channel *chan, char *cmd, char *data, const char *value)
  79 {
  80         int argc;
  81         char *args;
  82         char *argv[2];
  83         char *family;
  84         char *key;
  85
  86         if (ast_strlen_zero(data)) {
  87                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
  88                 return;
  89         }
  90
  91         args = ast_strdupa(data);
  92         argc = ast_app_separate_args(args, '/', argv, sizeof(argv) / sizeof(argv[0]));
  93
  94         if (argc > 1) {
  95                 family = argv[0];
  96                 key = argv[1];
  97         } else {
  98                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
  99                 return;
 100         }
 101
 102         if (ast_db_put(family, key, (char*)value)) {
 103                 ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
 104         }
 105 }
 106
 107 #ifndef BUILTIN_FUNC
 108 static
 109 #endif
 110 struct ast_custom_function db_function = {
 111         .name = "DB",
 112         .synopsis = "Read or Write from/to the Asterisk database",
 113         .syntax = "DB(<family>/<key>)",
 114         .desc = "This function will read or write a value from/to the Asterisk database.\n"
 115                 "DB(...) will read a value from the database, while DB(...)=value\n"
 116                 "will write a value to the database.  On a read, this function\n"
 117                 "returns the value from the datase, or NULL if it does not exist.\n"
 118                 "On a write, this function will always return NULL.  Reading a database value\n"
 119                 "will also set the variable DB_RESULT.\n",
 120         .read = function_db_read,
 121         .write = function_db_write,
 122 };
 123
 124 static char *function_db_exists(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
 125 {
 126         int argc;
 127         char *args;
 128         char *argv[2];
 129         char *family;
 130         char *key;
 131
 132         if (ast_strlen_zero(data)) {
 133                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
 134                 return buf;
 135         }
 136
 137         args = ast_strdupa(data);
 138         argc = ast_app_separate_args(args, '/', argv, sizeof(argv) / sizeof(argv[0]));
 139
 140         if (argc > 1) {
 141                 family = argv[0];
 142                 key = argv[1];
 143         } else {
 144                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
 145                 return buf;
 146         }
 147
 148         if (ast_db_get(family, key, buf, len-1))
 149                 ast_copy_string(buf, "0", len);
 150         else {
 151                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
 152                 ast_copy_string(buf, "1", len);
 153         }
 154
 155         return buf;
 156 }
 157
 158 #ifndef BUILTIN_FUNC
 159 static
 160 #endif
 161 struct ast_custom_function db_exists_function = {
 162         .name = "DB_EXISTS",
 163         .synopsis = "Check to see if a key exists in the Asterisk database",
 164         .syntax = "DB_EXISTS(<family>/<key>)",
 165         .desc = "This function will check to see if a key exists in the Asterisk\n"
 166                 "database. If it exists, the function will return \"1\". If not,\n"
 167                 "it will return \"0\".  Checking for existence of a database key will\n"
 168                 "also set the variable DB_RESULT to the key's value if it exists.\n",
 169         .read = function_db_exists,
 170 };