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