since the module API is changing, it's a good time to const-ify the description(...
[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
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/module.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/options.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/app.h"
44 #include "asterisk/astdb.h"
45
46 static int function_db_read(struct ast_channel *chan, char *cmd,
47                             char *parse, char *buf, size_t len)
48 {
49         AST_DECLARE_APP_ARGS(args,
50                              AST_APP_ARG(family);
51                              AST_APP_ARG(key);
52         );
53
54         buf[0] = '\0';
55
56         if (ast_strlen_zero(parse)) {
57                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
58                 return -1;
59         }
60
61         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
62
63         if (args.argc < 2) {
64                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)\n");
65                 return -1;
66         }
67
68         if (ast_db_get(args.family, args.key, buf, len - 1)) {
69                 ast_log(LOG_DEBUG, "DB: %s/%s not found in database.\n", args.family,
70                                 args.key);
71         } else
72                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
73
74         return 0;
75 }
76
77 static int function_db_write(struct ast_channel *chan, char *cmd, char *parse,
78                              const char *value)
79 {
80         AST_DECLARE_APP_ARGS(args,
81                              AST_APP_ARG(family);
82                              AST_APP_ARG(key);
83         );
84
85         if (ast_strlen_zero(parse)) {
86                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=<value>\n");
87                 return -1;
88         }
89
90         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
91
92         if (args.argc < 2) {
93                 ast_log(LOG_WARNING, "DB requires an argument, DB(<family>/<key>)=value\n");
94                 return -1;
95         }
96
97         if (ast_db_put(args.family, args.key, (char *) value))
98                 ast_log(LOG_WARNING, "DB: Error writing value to database.\n");
99
100         return 0;
101 }
102
103 static struct ast_custom_function db_function = {
104         .name = "DB",
105         .synopsis = "Read or Write from/to the Asterisk database",
106         .syntax = "DB(<family>/<key>)",
107         .desc =
108                 "This function will read or write a value from/to the Asterisk database.\n"
109                 "DB(...) will read a value from the database, while DB(...)=value\n"
110                 "will write a value to the database.  On a read, this function\n"
111                 "returns the value from the datase, or NULL if it does not exist.\n"
112                 "On a write, this function will always return NULL.  Reading a database value\n"
113                 "will also set the variable DB_RESULT.\n",
114         .read = function_db_read,
115         .write = function_db_write,
116 };
117
118 static int function_db_exists(struct ast_channel *chan, char *cmd,
119                               char *parse, char *buf, size_t len)
120 {
121         AST_DECLARE_APP_ARGS(args,
122                              AST_APP_ARG(family);
123                              AST_APP_ARG(key);
124         );
125
126         buf[0] = '\0';
127
128         if (ast_strlen_zero(parse)) {
129                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
130                 return -1;
131         }
132
133         AST_NONSTANDARD_APP_ARGS(args, parse, '/');
134
135         if (args.argc < 2) {
136                 ast_log(LOG_WARNING, "DB_EXISTS requires an argument, DB(<family>/<key>)\n");
137                 return -1;
138         }
139
140         if (ast_db_get(args.family, args.key, buf, len - 1))
141                 strcpy(buf, "0");
142         else {
143                 pbx_builtin_setvar_helper(chan, "DB_RESULT", buf);
144                 strcpy(buf, "1");
145         }
146
147         return 0;
148 }
149
150 static struct ast_custom_function db_exists_function = {
151         .name = "DB_EXISTS",
152         .synopsis = "Check to see if a key exists in the Asterisk database",
153         .syntax = "DB_EXISTS(<family>/<key>)",
154         .desc =
155                 "This function will check to see if a key exists in the Asterisk\n"
156                 "database. If it exists, the function will return \"1\". If not,\n"
157                 "it will return \"0\".  Checking for existence of a database key will\n"
158                 "also set the variable DB_RESULT to the key's value if it exists.\n",
159         .read = function_db_exists,
160 };
161
162 static char *tdesc = "Database (astdb) related dialplan functions";
163
164 int unload_module(void)
165 {
166         int res = 0;
167
168         res |= ast_custom_function_unregister(&db_function);
169         res |= ast_custom_function_unregister(&db_exists_function);
170
171         return res;
172 }
173
174 int load_module(void)
175 {
176         int res = 0;
177
178         res |= ast_custom_function_register(&db_function);
179         res |= ast_custom_function_register(&db_exists_function);
180
181         return res;
182 }
183
184 const char *description(void)
185 {
186         return tdesc;
187 }
188
189 int usecount(void)
190 {
191         return 0;
192 }
193
194 const char *key()
195 {
196         return ASTERISK_GPL_KEY;
197 }