Add a massive set of changes for converting to use the ast_debug() macro.
[asterisk/asterisk.git] / 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 <stdio.h>
35 #include <stdlib.h>
36 #include <string.h>
37 #include <sys/types.h>
38 #include <regex.h>
39
40 #include "asterisk/module.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/logger.h"
44 #include "asterisk/options.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/app.h"
47 #include "asterisk/astdb.h"
48
49 static int function_db_read(struct ast_channel *chan, const char *cmd,
50                             char *parse, char *buf, size_t len)
51 {
52         AST_DECLARE_APP_ARGS(args,
53                              AST_APP_ARG(family);
54                              AST_APP_ARG(key);
55         );
56
57         buf[0] = '\0';
58
59         if (ast_strlen_zero(parse)) {
60                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
61                 return -1;
62         }
63
64         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
65
66         if (args.argc < 2) {
67                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
68                 return -1;
69         }
70
71         if (ast_db_get(args.family, args.key, buf, len - 1)) {
72                 ast_debug(1, "DB: %s/%s not found in database.\n", args.family, args.key);
73         } else
74                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
75
76         return 0;
77 }
78
79 static int function_db_write(struct ast_channel *chan, const char *cmd, char *parse,
80                              const char *value)
81 {
82         AST_DECLARE_APP_ARGS(args,
83                              AST_APP_ARG(family);
84                              AST_APP_ARG(key);
85         );
86
87         if (ast_strlen_zero(parse)) {
88                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
89                 return -1;
90         }
91
92         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
93
94         if (args.argc < 2) {
95                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
96                 return -1;
97         }
98
99         if (ast_db_put(args.family, args.key, (char *) value))
100                 ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
101
102         return 0;
103 }
104
105 static struct ast_custom_function db_function = {
106         .name = "DB",
107         .synopsis = "Read from or write to the Asterisk database",
108         .syntax = "DB(<family>/<key>)",
109         .desc =
110 "This function will read from or write a value to the Asterisk database.  On a\n"
111 "read, this function returns the corresponding value from the database, or blank\n"
112 "if it does not exist.  Reading a database value will also set the variable\n"
113 "DB_RESULT.  If you wish to find out if an entry exists, use the DB_EXISTS\n"
114 "function.\n",
115         .read = function_db_read,
116         .write = function_db_write,
117 };
118
119 static int function_db_exists(struct ast_channel *chan, const char *cmd,
120                               char *parse, char *buf, size_t len)
121 {
122         AST_DECLARE_APP_ARGS(args,
123                              AST_APP_ARG(family);
124                              AST_APP_ARG(key);
125         );
126
127         buf[0] = '\0';
128
129         if (ast_strlen_zero(parse)) {
130                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
131                 return -1;
132         }
133
134         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
135
136         if (args.argc < 2) {
137                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
138                 return -1;
139         }
140
141         if (ast_db_get(args.family, args.key, buf, len - 1))
142                 strcpy(buf, "0");
143         else {
144                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
145                 strcpy(buf, "1");
146         }
147
148         return 0;
149 }
150
151 static struct ast_custom_function db_exists_function = {
152         .name = "DB_EXISTS",
153         .synopsis = "Check to see if a key exists in the Asterisk database",
154         .syntax = "DB_EXISTS(<family>/<key>)",
155         .desc =
156                 "This function will check to see if a key exists in the Asterisk\n"
157                 "database. If it exists, the function will return \"1\". If not,\n"
158                 "it will return \"0\".  Checking for existence of a database key will\n"
159                 "also set the variable DB_RESULT to the key's value if it exists.\n",
160         .read = function_db_exists,
161 };
162
163 static int function_db_delete(struct ast_channel *chan, const char *cmd,
164                               char *parse, char *buf, size_t len)
165 {
166         AST_DECLARE_APP_ARGS(args,
167                              AST_APP_ARG(family);
168                              AST_APP_ARG(key);
169         );
170
171         buf[0] = '\0';
172
173         if (ast_strlen_zero(parse)) {
174                 ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
175                 return -1;
176         }
177
178         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
179
180         if (args.argc < 2) {
181                 ast_log(LOG_WARNING, "DB_DELETE requires an argument, DB_DELETE(<family>/<key>)\n");
182                 return -1;
183         }
184
185         if (ast_db_get(args.family, args.key, buf, len - 1)) {
186                 ast_debug(1, "DB_DELETE: %s/%s not found in database.\n", args.family, args.key);
187         } else {
188                 if (ast_db_del(args.family, args.key)) {
189                         ast_debug(1, "DB_DELETE: %s/%s could not be deleted from the database\n", args.family, args.key);
190                 }
191         }
192         pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
193
194         return 0;
195 }
196
197
198 static struct ast_custom_function db_delete_function = {
199         .name = "DB_DELETE",
200         .synopsis = "Return a value from the database and delete it",
201         .syntax = "DB_DELETE(<family>/<key>)",
202         .desc =
203                 "This function will retrieve a value from the Asterisk database\n"
204                 " and then remove that key from the database.  DB_RESULT\n"
205                 "will be set to the key's value if it exists.\n",
206         .read = function_db_delete,
207 };
208
209 static int unload_module(void)
210 {
211         int res = 0;
212
213         res |= ast_custom_function_unregister(&db_function);
214         res |= ast_custom_function_unregister(&db_exists_function);
215         res |= ast_custom_function_unregister(&db_delete_function);
216
217         return res;
218 }
219
220 static int load_module(void)
221 {
222         int res = 0;
223
224         res |= ast_custom_function_register(&db_function);
225         res |= ast_custom_function_register(&db_exists_function);
226         res |= ast_custom_function_register(&db_delete_function);
227
228         return res;
229 }
230
231 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Database (astdb) related dialplan functions");