a88620ea67d4b868475961ea8a4993932ca59140
[asterisk/asterisk.git] / apps / app_realtime.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Anthony Minessale <anthmct@yahoo.com>
7  * Mark Spencer <markster@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief RealTime App
23  *
24  * \author Anthony Minessale <anthmct@yahoo.com>
25  * \author Mark Spencer <markster@digium.com>
26  * 
27  * \ingroup applications
28  */
29
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include <unistd.h>
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/options.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/config.h"
45 #include "asterisk/module.h"
46 #include "asterisk/lock.h"
47 #include "asterisk/cli.h"
48
49 #define next_one(var) var = var->next
50 #define crop_data(str) { *(str) = '\0' ; (str)++; }
51
52 static char *tdesc = "Realtime Data Lookup/Rewrite";
53 static char *app = "RealTime";
54 static char *uapp = "RealTimeUpdate";
55 static char *synopsis = "Realtime Data Lookup";
56 static char *usynopsis = "Realtime Data Rewrite";
57 static char *USAGE = "RealTime(<family>|<colmatch>|<value>[|<prefix>])";
58 static char *UUSAGE = "RealTimeUpdate(<family>|<colmatch>|<value>|<newcol>|<newval>)";
59 static char *desc =
60 "Use the RealTime config handler system to read data into channel variables.\n"
61 "RealTime(<family>|<colmatch>|<value>[|<prefix>])\n\n"
62 "All unique column names will be set as channel variables with optional prefix\n"
63 "to the name.  For example, a prefix of 'var_' would make the column 'name'\n"
64 "become the variable ${var_name}.  REALTIMECOUNT will be set with the number\n"
65 "of values read.\n";
66 static char *udesc = "Use the RealTime config handler system to update a value\n"
67 "RealTimeUpdate(<family>|<colmatch>|<value>|<newcol>|<newval>)\n\n"
68 "The column <newcol> in 'family' matching column <colmatch>=<value> will be\n"
69 "updated to <newval>.  REALTIMECOUNT will be set with the number of rows\n"
70 "updated or -1 if an error occurs.\n";
71
72 STANDARD_LOCAL_USER;
73 LOCAL_USER_DECL;
74
75 static int cli_load_realtime(int fd, int argc, char **argv) 
76 {
77         char *header_format = "%30s  %-30s\n";
78         struct ast_variable *var=NULL;
79
80         if(argc<5) {
81                 ast_cli(fd, "You must supply a family name, a column to match on, and a value to match to.\n");
82                 return RESULT_FAILURE;
83         }
84
85         var = ast_load_realtime(argv[2], argv[3], argv[4], NULL);
86
87         if(var) {
88                 ast_cli(fd, header_format, "Column Name", "Column Value");
89                 ast_cli(fd, header_format, "--------------------", "--------------------");
90                 while(var) {
91                         ast_cli(fd, header_format, var->name, var->value);
92                         var = var->next;
93                 }
94         } else {
95                 ast_cli(fd, "No rows found matching search criteria.\n");
96         }
97         return RESULT_SUCCESS;
98 }
99
100 static int cli_update_realtime(int fd, int argc, char **argv) {
101         int res = 0;
102
103         if(argc<7) {
104                 ast_cli(fd, "You must supply a family name, a column to update on, a new value, column to match, and value to to match.\n");
105                 ast_cli(fd, "Ex: realtime update sipfriends name bobsphone port 4343\n will execute SQL as UPDATE sipfriends SET port = 4343 WHERE name = bobsphone\n");
106                 return RESULT_FAILURE;
107         }
108
109         res = ast_update_realtime(argv[2], argv[3], argv[4], argv[5], argv[6], NULL);
110
111         if(res < 0) {
112                 ast_cli(fd, "Failed to update. Check the debug log for possible SQL related entries.\n");
113                 return RESULT_SUCCESS;
114         }
115
116        ast_cli(fd, "Updated %d RealTime record%s.\n", res, (res != 1) ? "s" : "");
117
118         return RESULT_SUCCESS;
119 }
120
121 static char cli_load_realtime_usage[] =
122 "Usage: realtime load <family> <colmatch> <value>\n"
123 "       Prints out a list of variables using the RealTime driver.\n";
124
125 static struct ast_cli_entry cli_load_realtime_cmd = {
126         { "realtime", "load", NULL, NULL }, cli_load_realtime,
127         "Used to print out RealTime variables.", cli_load_realtime_usage, NULL };
128
129 static char cli_update_realtime_usage[] =
130 "Usage: realtime update <family> <colmatch> <value>\n"
131 "       Update a single variable using the RealTime driver.\n";
132
133 static struct ast_cli_entry cli_update_realtime_cmd = {
134         { "realtime", "update", NULL, NULL }, cli_update_realtime,
135         "Used to update RealTime variables.", cli_update_realtime_usage, NULL };
136
137 static int realtime_update_exec(struct ast_channel *chan, void *data) 
138 {
139         char *family=NULL, *colmatch=NULL, *value=NULL, *newcol=NULL, *newval=NULL;
140         struct localuser *u;
141         int res = 0, count = 0;
142         char countc[13];
143
144         if (ast_strlen_zero(data)) {
145                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",UUSAGE);
146                 return -1;
147         }
148         
149         LOCAL_USER_ADD(u);
150
151         family = ast_strdupa(data);
152         if ((colmatch = strchr(family,'|'))) {
153                 crop_data(colmatch);
154                 if ((value = strchr(colmatch,'|'))) {
155                         crop_data(value);
156                         if ((newcol = strchr(value,'|'))) {
157                                 crop_data(newcol);
158                                 if ((newval = strchr(newcol,'|'))) 
159                                         crop_data(newval);
160                         }
161                 }
162         }
163         if (!newval) {
164                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",UUSAGE);
165                 res = -1;
166         } else {
167                 count = ast_update_realtime(family,colmatch,value,newcol,newval,NULL);
168         }
169
170         snprintf(countc, sizeof(countc), "%d", count);
171         pbx_builtin_setvar_helper(chan, "REALTIMECOUNT", countc);
172
173         LOCAL_USER_REMOVE(u);
174         
175         return res;
176 }
177
178
179 static int realtime_exec(struct ast_channel *chan, void *data)
180 {
181         int res=0, count=0;
182         struct localuser *u;
183         struct ast_variable *var, *itt;
184         char *family=NULL, *colmatch=NULL, *value=NULL, *prefix=NULL, *vname=NULL;
185         char countc[13];
186         size_t len;
187                 
188         if (ast_strlen_zero(data)) {
189                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",USAGE);
190                 return -1;
191         }
192         
193         LOCAL_USER_ADD(u);
194
195         family = ast_strdupa(data);
196         if ((colmatch = strchr(family,'|'))) {
197                 crop_data(colmatch);
198                 if ((value = strchr(colmatch,'|'))) {
199                         crop_data(value);
200                         if ((prefix = strchr(value,'|')))
201                                 crop_data(prefix);
202                 }
203         }
204         if (!value) {
205                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",USAGE);
206                 res = -1;
207         } else {
208                 if (option_verbose > 3)
209                         ast_verbose(VERBOSE_PREFIX_4"Realtime Lookup: family:'%s' colmatch:'%s' value:'%s'\n",family,colmatch,value);
210                 if ((var = ast_load_realtime(family, colmatch, value, NULL))) {
211                         for (itt = var; itt; itt = itt->next) {
212                                 if(prefix) {
213                                         len = strlen(prefix) + strlen(itt->name) + 2;
214                                         vname = alloca(len);
215                                         snprintf(vname,len,"%s%s",prefix,itt->name);
216                                         
217                                 } else 
218                                         vname = itt->name;
219
220                                 pbx_builtin_setvar_helper(chan, vname, itt->value);
221                                 count++;
222                         }
223                         ast_variables_destroy(var);
224                 } else if (option_verbose > 3)
225                         ast_verbose(VERBOSE_PREFIX_4"No Realtime Matches Found.\n");
226         }
227         snprintf(countc, sizeof(countc), "%d", count);
228         pbx_builtin_setvar_helper(chan, "REALTIMECOUNT", countc);
229         
230         LOCAL_USER_REMOVE(u);
231         return res;
232 }
233
234 int unload_module(void)
235 {
236         int res;
237
238         res = ast_cli_unregister(&cli_load_realtime_cmd);
239         res |= ast_cli_unregister(&cli_update_realtime_cmd);
240         res |= ast_unregister_application(uapp);
241         res |= ast_unregister_application(app);
242
243         STANDARD_HANGUP_LOCALUSERS;
244
245         return res;
246 }
247
248 int load_module(void)
249 {
250         int res;
251
252         res = ast_cli_register(&cli_load_realtime_cmd);
253         res |= ast_cli_register(&cli_update_realtime_cmd);
254         res |= ast_register_application(uapp, realtime_update_exec, usynopsis, udesc);
255         res |= ast_register_application(app, realtime_exec, synopsis, desc);
256
257         return res;
258 }
259
260 char *description(void)
261 {
262         return tdesc;
263 }
264
265 int usecount(void)
266 {
267         int res;
268         STANDARD_USECOUNT(res);
269         return res;
270 }
271
272 char *key()
273 {
274         return ASTERISK_GPL_KEY;
275 }
276