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