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