bce5d9d625e9faba42b1734c28fecd5f9bb5b613
[asterisk/asterisk.git] / funcs / func_strings.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Digium, Inc.
5  * Portions Copyright (C) 2005, Tilghman Lesher.  All rights reserved.
6  * Portions Copyright (C) 2005, Anthony Minessale II
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief String manipulation dialplan functions
22  *
23  * \author Tilghman Lesher
24  * \author Anothony Minessale II 
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <sys/types.h>
31 #include <regex.h>
32
33 #include "asterisk.h"
34
35 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
36
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/app.h"
42 #include "asterisk/localtime.h"
43
44 static char *function_fieldqty(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
45 {
46         char *varname, *varval, workspace[256];
47         char *delim = ast_strdupa(data);
48         int fieldcount = 0;
49
50         if (delim) {
51                 varname = strsep(&delim, "|");
52                 pbx_retrieve_variable(chan, varname, &varval, workspace, sizeof(workspace), NULL);
53                 while (strsep(&varval, delim))
54                         fieldcount++;
55                 snprintf(buf, len, "%d", fieldcount);
56         } else {
57                 ast_log(LOG_ERROR, "Out of memory\n");
58                 strncpy(buf, "1", len);
59         }
60         return buf;
61 }
62
63 #ifndef BUILTIN_FUNC
64 static
65 #endif
66 struct ast_custom_function fieldqty_function = {
67         .name = "FIELDQTY",
68         .synopsis = "Count the fields, with an arbitrary delimiter",
69         .syntax = "FIELDQTY(<varname>,<delim>)",
70         .read = function_fieldqty,
71 };
72
73 static char *builtin_function_filter(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
74 {
75         char *allowed, *string, *outbuf=buf;
76
77         string = ast_strdupa(data);
78         if (!string) {
79                 ast_log(LOG_ERROR, "Out of memory");
80                 return "";
81         }
82
83         allowed = strsep(&string, "|");
84
85         if (!string) {
86                 ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>,<string>)\n");
87                 return "";
88         }
89
90         for ( ; *string && (buf + len - 1 > outbuf); string++) {
91                 if (strchr(allowed, *string)) {
92                         *outbuf = *string;
93                         outbuf++;
94                 }
95         }
96         *outbuf = '\0';
97         
98         return buf;
99 }
100
101 #ifndef BUILTIN_FUNC
102 static
103 #endif
104 struct ast_custom_function filter_function = {
105         .name = "FILTER",
106         .synopsis = "Filter the string to include only the allowed characters",
107         .syntax = "FILTER(<allowed-chars>,<string>)",
108         .read = builtin_function_filter,
109 };
110
111 static char *builtin_function_regex(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
112 {
113         char *arg, *earg = NULL, *tmp, errstr[256] = "";
114         int errcode;
115         regex_t regexbuf;
116
117         ast_copy_string(buf, "0", len);
118         
119         tmp = ast_strdupa(data);
120         if (!tmp) {
121                 ast_log(LOG_ERROR, "Out of memory in %s(%s)\n", cmd, data);
122                 return buf;
123         }
124
125         /* Regex in quotes */
126         arg = strchr(tmp, '"');
127         if (arg) {
128                 arg++;
129                 earg = strrchr(arg, '"');
130                 if (earg) {
131                         *earg++ = '\0';
132                         /* Skip over any spaces before the data we are checking */
133                         while (*earg == ' ')
134                                 earg++;
135                 }
136         } else {
137                 arg = tmp;
138         }
139
140         if ((errcode = regcomp(&regexbuf, arg, REG_EXTENDED | REG_NOSUB))) {
141                 regerror(errcode, &regexbuf, errstr, sizeof(errstr));
142                 ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, data, errstr);
143         } else {
144                 if (!regexec(&regexbuf, earg ? earg : "", 0, NULL, 0))
145                         ast_copy_string(buf, "1", len); 
146         }
147         regfree(&regexbuf);
148
149         return buf;
150 }
151
152 #ifndef BUILTIN_FUNC
153 static
154 #endif
155 struct ast_custom_function regex_function = {
156         .name = "REGEX",
157         .synopsis = "Regular Expression: Returns 1 if data matches regular expression.",
158         .syntax = "REGEX(\"<regular expression>\" <data>)",
159         .read = builtin_function_regex,
160 };
161
162 static void builtin_function_array(struct ast_channel *chan, char *cmd, char *data, const char *value)
163 {
164         char *varv[100];
165         char *valuev[100];
166         char *var, *value2;
167         int varcount, valuecount, i;
168
169         var = ast_strdupa(data);
170         value2 = ast_strdupa(value);
171         if (!var || !value2) {
172                 ast_log(LOG_ERROR, "Out of memory\n");
173                 return;
174         }
175
176         /* The functions this will generally be used with are SORT and ODBC_*, which
177          * both return comma-delimited lists.  However, if somebody uses literal lists,
178          * their commas will be translated to vertical bars by the load, and I don't
179          * want them to be surprised by the result.  Hence, we prefer commas as the
180          * delimiter, but we'll fall back to vertical bars if commas aren't found.
181          */
182         if (strchr(var, ',')) {
183                 varcount = ast_app_separate_args(var, ',', varv, 100);
184         } else {
185                 varcount = ast_app_separate_args(var, '|', varv, 100);
186         }
187
188         if (strchr(value2, ',')) {
189                 valuecount = ast_app_separate_args(value2, ',', valuev, 100);
190         } else {
191                 valuecount = ast_app_separate_args(value2, '|', valuev, 100);
192         }
193
194         for (i = 0; i < varcount; i++) {
195                 if (i < valuecount) {
196                         pbx_builtin_setvar_helper(chan, varv[i], valuev[i]);
197                 } else {
198                         /* We could unset the variable, by passing a NULL, but due to
199                          * pushvar semantics, that could create some undesired behavior. */
200                         pbx_builtin_setvar_helper(chan, varv[i], "");
201                 }
202         }
203 }
204
205 #ifndef BUILTIN_FUNC
206 static
207 #endif
208 struct ast_custom_function array_function = {
209         .name = "ARRAY",
210         .synopsis = "Allows setting multiple variables at once",
211         .syntax = "ARRAY(var1[,var2[...][,varN]])",
212         .write = builtin_function_array,
213         .desc =
214 "The comma-separated list passed as a value to which the function is set\n"
215 "will be interpreted as a set of values to which the comma-separated list\n"
216 "of variable names in the argument should be set.\n"
217 "Hence, Set(ARRAY(var1,var2)=1,2) will set var1 to 1 and var2 to 2\n",
218 };
219
220 static char *builtin_function_len(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
221 {
222         int length = 0;
223         if (data) {
224                 length = strlen(data);
225         }
226         snprintf(buf, len, "%d", length);
227         return buf;
228 }
229
230 #ifndef BUILTIN_FUNC
231 static
232 #endif
233 struct ast_custom_function len_function = {
234         .name = "LEN",
235         .synopsis = "Returns the length of the argument given",
236         .syntax = "LEN(<string>)",
237         .read = builtin_function_len,
238 };
239
240 static char *acf_strftime(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
241 {
242         char *format, *epoch, *timezone = NULL;
243         long epochi;
244         struct tm time;
245
246         buf[0] = '\0';
247
248         if (!data) {
249                 ast_log(LOG_ERROR, "Asterisk function STRFTIME() requires an argument.\n");
250                 return buf;
251         }
252         
253         format = ast_strdupa(data);
254         if (!format) {
255                 ast_log(LOG_ERROR, "Out of memory\n");
256                 return buf;
257         }
258         
259         epoch = strsep(&format, "|");
260         timezone = strsep(&format, "|");
261
262         if (ast_strlen_zero(epoch) || !sscanf(epoch, "%ld", &epochi)) {
263                 struct timeval tv = ast_tvnow();
264                 epochi = tv.tv_sec;
265         }
266
267         ast_localtime(&epochi, &time, timezone);
268
269         if (!format) {
270                 format = "%c";
271         }
272
273         if (!strftime(buf, len, format, &time)) {
274                 ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
275         }
276         buf[len - 1] = '\0';
277
278         return buf;
279 }
280
281 #ifndef BUILTIN_FUNC
282 static
283 #endif
284 struct ast_custom_function strftime_function = {
285         .name = "STRFTIME",
286         .synopsis = "Returns the current date/time in a specified format.",
287         .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
288         .read = acf_strftime,
289 };
290
291 static char *function_eval(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
292 {
293         memset(buf, 0, len);
294
295         if (ast_strlen_zero(data)) {
296                 ast_log(LOG_WARNING, "EVAL requires an argument: EVAL(<string>)\n");
297                 return buf;
298         }
299
300         pbx_substitute_variables_helper(chan, data, buf, len - 1);
301
302         return buf;
303 }
304
305 #ifndef BUILTIN_FUNC
306 static
307 #endif
308 struct ast_custom_function eval_function = {
309         .name = "EVAL",
310         .synopsis = "Evaluate stored variables.",
311         .syntax = "EVAL(<variable>)",
312         .desc = "Using EVAL basically causes a string to be evaluated twice.\n"
313                 "When a variable or expression is in the dialplan, it will be\n"
314                 "evaluated at runtime. However, if the result of the evaluation\n"
315                 "is in fact a variable or expression, using EVAL will have it\n"
316                 "evaluated a second time. For example, if the variable ${MYVAR}\n"
317                 "contains \"${OTHERVAR}\", then the result of putting ${EVAL(${MYVAR})}\n"
318                 "in the dialplan will be the contents of the variable, OTHERVAR.\n"
319                 "Normally, by just putting ${MYVAR} in the dialplan, you would be\n"
320                 "left with \"${OTHERVAR}\".\n", 
321         .read = function_eval,
322 };
323