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