Bug 5327 - new function FILTER and optional argument to CALLERID
[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  */
24
25 #include <stdlib.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <sys/types.h>
29 #include <regex.h>
30
31 #include "asterisk.h"
32
33 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
34
35 #include "asterisk/channel.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/app.h"
40 #include "asterisk/localtime.h"
41
42 static char *function_fieldqty(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
43 {
44         char *varname, *varval, workspace[256];
45         char *delim = ast_strdupa(data);
46         int fieldcount = 0;
47
48         if (delim) {
49                 varname = strsep(&delim, "|");
50                 pbx_retrieve_variable(chan, varname, &varval, workspace, sizeof(workspace), NULL);
51                 while (strsep(&varval, delim))
52                         fieldcount++;
53                 snprintf(buf, len, "%d", fieldcount);
54         } else {
55                 ast_log(LOG_ERROR, "Out of memory\n");
56                 strncpy(buf, "1", len);
57         }
58         return buf;
59 }
60
61 #ifndef BUILTIN_FUNC
62 static
63 #endif
64 struct ast_custom_function fieldqty_function = {
65         .name = "FIELDQTY",
66         .synopsis = "Count the fields, with an arbitrary delimiter",
67         .syntax = "FIELDQTY(<varname>,<delim>)",
68         .read = function_fieldqty,
69 };
70
71 static char *builtin_function_filter(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
72 {
73         char *allowed, *string, *outbuf=buf;
74
75         string = ast_strdupa(data);
76         if (!string) {
77                 ast_log(LOG_ERROR, "Out of memory");
78                 return "";
79         }
80
81         allowed = strsep(&string, "|");
82
83         if (!string) {
84                 ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>,<string>)\n");
85                 return "";
86         }
87
88         for ( ; *string && (buf + len - 1 > outbuf); string++) {
89                 if (strchr(allowed, *string)) {
90                         *outbuf = *string;
91                         outbuf++;
92                 }
93         }
94         *outbuf = '\0';
95         
96         return buf;
97 }
98
99 #ifndef BUILTIN_FUNC
100 static
101 #endif
102 struct ast_custom_function filter_function = {
103         .name = "FILTER",
104         .synopsis = "Filter the string to include only the allowed characters",
105         .syntax = "FILTER(<allowed-chars>,<string>)",
106         .read = builtin_function_filter,
107 };
108
109 static char *builtin_function_regex(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
110 {
111         char *arg, *earg = NULL, *tmp, errstr[256] = "";
112         int errcode;
113         regex_t regexbuf;
114
115         ast_copy_string(buf, "0", len);
116         
117         tmp = ast_strdupa(data);
118         if (!tmp) {
119                 ast_log(LOG_ERROR, "Out of memory in %s(%s)\n", cmd, data);
120                 return buf;
121         }
122
123         /* Regex in quotes */
124         arg = strchr(tmp, '"');
125         if (arg) {
126                 arg++;
127                 earg = strrchr(arg, '"');
128                 if (earg) {
129                         *earg++ = '\0';
130                         /* Skip over any spaces before the data we are checking */
131                         while (*earg == ' ')
132                                 earg++;
133                 }
134         } else {
135                 arg = tmp;
136         }
137
138         if ((errcode = regcomp(&regexbuf, arg, REG_EXTENDED | REG_NOSUB))) {
139                 regerror(errcode, &regexbuf, errstr, sizeof(errstr));
140                 ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, data, errstr);
141         } else {
142                 if (!regexec(&regexbuf, earg ? earg : "", 0, NULL, 0))
143                         ast_copy_string(buf, "1", len); 
144         }
145         regfree(&regexbuf);
146
147         return buf;
148 }
149
150 #ifndef BUILTIN_FUNC
151 static
152 #endif
153 struct ast_custom_function regex_function = {
154         .name = "REGEX",
155         .synopsis = "Regular Expression: Returns 1 if data matches regular expression.",
156         .syntax = "REGEX(\"<regular expression>\" <data>)",
157         .read = builtin_function_regex,
158 };
159
160 static char *builtin_function_len(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
161 {
162         int length = 0;
163         if (data) {
164                 length = strlen(data);
165         }
166         snprintf(buf, len, "%d", length);
167         return buf;
168 }
169
170 #ifndef BUILTIN_FUNC
171 static
172 #endif
173 struct ast_custom_function len_function = {
174         .name = "LEN",
175         .synopsis = "Returns the length of the argument given",
176         .syntax = "LEN(<string>)",
177         .read = builtin_function_len,
178 };
179
180 static char *acf_strftime(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
181 {
182         char *format, *epoch, *timezone = NULL;
183         long epochi;
184         struct tm time;
185
186         buf[0] = '\0';
187
188         if (!data) {
189                 ast_log(LOG_ERROR, "Asterisk function STRFTIME() requires an argument.\n");
190                 return buf;
191         }
192         
193         format = ast_strdupa(data);
194         if (!format) {
195                 ast_log(LOG_ERROR, "Out of memory\n");
196                 return buf;
197         }
198         
199         epoch = strsep(&format, "|");
200         timezone = strsep(&format, "|");
201
202         if (ast_strlen_zero(epoch) || !sscanf(epoch, "%ld", &epochi)) {
203                 struct timeval tv = ast_tvnow();
204                 epochi = tv.tv_sec;
205         }
206
207         ast_localtime(&epochi, &time, timezone);
208
209         if (!format) {
210                 format = "%c";
211         }
212
213         if (!strftime(buf, len, format, &time)) {
214                 ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
215         }
216         buf[len - 1] = '\0';
217
218         return buf;
219 }
220
221 #ifndef BUILTIN_FUNC
222 static
223 #endif
224 struct ast_custom_function strftime_function = {
225         .name = "STRFTIME",
226         .synopsis = "Returns the current date/time in a specified format.",
227         .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
228         .read = acf_strftime,
229 };
230
231 static char *function_eval(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
232 {
233         memset(buf, 0, len);
234
235         if (ast_strlen_zero(data)) {
236                 ast_log(LOG_WARNING, "EVAL requires an argument: EVAL(<string>)\n");
237                 return buf;
238         }
239
240         pbx_substitute_variables_helper(chan, data, buf, len - 1);
241
242         return buf;
243 }
244
245 #ifndef BUILTIN_FUNC
246 static
247 #endif
248 struct ast_custom_function eval_function = {
249         .name = "EVAL",
250         .synopsis = "Evaluate stored variables.",
251         .syntax = "EVAL(<variable>)",
252         .desc = "Using EVAL basically causes a string to be evaluated twice.\n"
253                 "When a variable or expression is in the dialplan, it will be\n"
254                 "evaluated at runtime. However, if the result of the evaluation\n"
255                 "is in fact a variable or expression, using EVAL will have it\n"
256                 "evaluated a second time. For example, if the variable ${MYVAR}\n"
257                 "contains \"${OTHERVAR}\", then the result of putting ${EVAL(${MYVAR})}\n"
258                 "in the dialplan will be the contents of the variable, OTHERVAR.\n"
259                 "Normally, by just putting ${MYVAR} in the dialplan, you would be\n"
260                 "left with \"${OTHERVAR}\".\n", 
261         .read = function_eval,
262 };
263