80f092528fe8242fc423e9cd04a403e8aa1fe9c4
[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  * \ingroup applications
25  */
26
27 #include <stdlib.h>
28 #include <unistd.h>
29 #include <string.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/file.h"
36 #include "asterisk/logger.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/options.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/config.h"
41 #include "asterisk/module.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/cli.h"
44
45 #define next_one(var) var = var->next
46 #define crop_data(str) { *(str) = '\0' ; (str)++; }
47
48 static char *tdesc = "Realtime Data Lookup/Rewrite";
49 static char *app = "RealTime";
50 static char *uapp = "RealTimeUpdate";
51 static char *synopsis = "Realtime Data Lookup";
52 static char *usynopsis = "Realtime Data Rewrite";
53 static char *USAGE = "RealTime(<family>|<colmatch>|<value>[|<prefix>])";
54 static char *UUSAGE = "RealTimeUpdate(<family>|<colmatch>|<value>|<newcol>|<newval>)";
55 static char *desc = "Use the RealTime config handler system to read data into channel variables.\n"
56 "RealTime(<family>|<colmatch>|<value>[|<prefix>])\n\n"
57 "All unique column names will be set as channel variables with optional prefix to the name.\n"
58 "e.g. prefix of 'var_' would make the column 'name' become the variable ${var_name}\n\n";
59 static char *udesc = "Use the RealTime config handler system to update a value\n"
60 "RealTimeUpdate(<family>|<colmatch>|<value>|<newcol>|<newval>)\n\n"
61 "The column <newcol> in 'family' matching column <colmatch>=<value> will be updated to <newval>\n";
62
63 STANDARD_LOCAL_USER;
64 LOCAL_USER_DECL;
65
66 static int cli_load_realtime(int fd, int argc, char **argv) 
67 {
68         char *header_format = "%30s  %-30s\n";
69         struct ast_variable *var=NULL;
70
71         if(argc<5) {
72                 ast_cli(fd, "You must supply a family name, a column to match on, and a value to match to.\n");
73                 return RESULT_FAILURE;
74         }
75
76         var = ast_load_realtime(argv[2], argv[3], argv[4], NULL);
77
78         if(var) {
79                 ast_cli(fd, header_format, "Column Name", "Column Value");
80                 ast_cli(fd, header_format, "--------------------", "--------------------");
81                 while(var) {
82                         ast_cli(fd, header_format, var->name, var->value);
83                         var = var->next;
84                 }
85         } else {
86                 ast_cli(fd, "No rows found matching search criteria.\n");
87         }
88         return RESULT_SUCCESS;
89 }
90
91 static int cli_update_realtime(int fd, int argc, char **argv) {
92         int res = 0;
93
94         if(argc<7) {
95                 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");
96                 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");
97                 return RESULT_FAILURE;
98         }
99
100         res = ast_update_realtime(argv[2], argv[3], argv[4], argv[5], argv[6], NULL);
101
102         if(res < 0) {
103                 ast_cli(fd, "Failed to update. Check the debug log for possible SQL related entries.\n");
104                 return RESULT_SUCCESS;
105         }
106
107        ast_cli(fd, "Updated %d RealTime record%s.\n", res, (res != 1) ? "s" : "");
108
109         return RESULT_SUCCESS;
110 }
111
112 static char cli_load_realtime_usage[] =
113 "Usage: realtime load <family> <colmatch> <value>\n"
114 "       Prints out a list of variables using the RealTime driver.\n";
115
116 static struct ast_cli_entry cli_load_realtime_cmd = {
117         { "realtime", "load", NULL, NULL }, cli_load_realtime,
118         "Used to print out RealTime variables.", cli_load_realtime_usage, NULL };
119
120 static char cli_update_realtime_usage[] =
121 "Usage: realtime update <family> <colmatch> <value>\n"
122 "       Update a single variable using the RealTime driver.\n";
123
124 static struct ast_cli_entry cli_update_realtime_cmd = {
125         { "realtime", "update", NULL, NULL }, cli_update_realtime,
126         "Used to update RealTime variables.", cli_update_realtime_usage, NULL };
127
128 static int realtime_update_exec(struct ast_channel *chan, void *data) 
129 {
130         char *family=NULL, *colmatch=NULL, *value=NULL, *newcol=NULL, *newval=NULL;
131         struct localuser *u;
132         int res = 0;
133
134         if (ast_strlen_zero(data)) {
135                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",UUSAGE);
136                 return -1;
137         }
138         
139         LOCAL_USER_ADD(u);
140
141         if ((family = ast_strdupa(data))) {
142                 if ((colmatch = strchr(family,'|'))) {
143                         crop_data(colmatch);
144                         if ((value = strchr(colmatch,'|'))) {
145                                 crop_data(value);
146                                 if ((newcol = strchr(value,'|'))) {
147                                         crop_data(newcol);
148                                         if ((newval = strchr(newcol,'|'))) 
149                                                 crop_data(newval);
150                                 }
151                         }
152                 }
153         }
154         if (! (family && value && colmatch && newcol && newval) ) {
155                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",UUSAGE);
156                 res = -1;
157         } else {
158                 ast_update_realtime(family,colmatch,value,newcol,newval,NULL);
159         }
160
161         LOCAL_USER_REMOVE(u);
162         
163         return res;
164 }
165
166
167 static int realtime_exec(struct ast_channel *chan, void *data)
168 {
169         int res=0;
170         struct localuser *u;
171         struct ast_variable *var, *itt;
172         char *family=NULL, *colmatch=NULL, *value=NULL, *prefix=NULL, *vname=NULL;
173         size_t len;
174                 
175         if (ast_strlen_zero(data)) {
176                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",USAGE);
177                 return -1;
178         }
179         
180         LOCAL_USER_ADD(u);
181
182         if ((family = ast_strdupa(data))) {
183                 if ((colmatch = strchr(family,'|'))) {
184                         crop_data(colmatch);
185                         if ((value = strchr(colmatch,'|'))) {
186                                 crop_data(value);
187                                 if ((prefix = strchr(value,'|')))
188                                         crop_data(prefix);
189                         }
190                 }
191         }
192         if (! (family && value && colmatch) ) {
193                 ast_log(LOG_ERROR,"Invalid input: usage %s\n",USAGE);
194                 res = -1;
195         } else {
196                 if (option_verbose > 3)
197                         ast_verbose(VERBOSE_PREFIX_4"Realtime Lookup: family:'%s' colmatch:'%s' value:'%s'\n",family,colmatch,value);
198                 if ((var = ast_load_realtime(family, colmatch, value, NULL))) {
199                         for (itt = var; itt; itt = itt->next) {
200                                 if(prefix) {
201                                         len = strlen(prefix) + strlen(itt->name) + 2;
202                                         vname = alloca(len);
203                                         snprintf(vname,len,"%s%s",prefix,itt->name);
204                                         
205                                 } else 
206                                         vname = itt->name;
207
208                                 pbx_builtin_setvar_helper(chan, vname, itt->value);
209                         }
210                         ast_variables_destroy(var);
211                 } else if (option_verbose > 3)
212                         ast_verbose(VERBOSE_PREFIX_4"No Realtime Matches Found.\n");
213         }
214         
215         LOCAL_USER_REMOVE(u);
216         return res;
217 }
218
219 int unload_module(void)
220 {
221         int res;
222
223         res = ast_cli_unregister(&cli_load_realtime_cmd);
224         res |= ast_cli_unregister(&cli_update_realtime_cmd);
225         res |= ast_unregister_application(uapp);
226         res |= ast_unregister_application(app);
227
228         STANDARD_HANGUP_LOCALUSERS;
229
230         return res;
231 }
232
233 int load_module(void)
234 {
235         int res;
236
237         res = ast_cli_register(&cli_load_realtime_cmd);
238         res |= ast_cli_register(&cli_update_realtime_cmd);
239         res |= ast_register_application(uapp, realtime_update_exec, usynopsis, udesc);
240         res |= ast_register_application(app, realtime_exec, synopsis, desc);
241
242         return res;
243 }
244
245 char *description(void)
246 {
247         return tdesc;
248 }
249
250 int usecount(void)
251 {
252         int res;
253         STANDARD_USECOUNT(res);
254         return res;
255 }
256
257 char *key()
258 {
259         return ASTERISK_GPL_KEY;
260 }
261