add API function for parsing strings to time_t (issue #6320, with mods)
[asterisk/asterisk.git] / funcs / func_strings.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005-2006, 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/module.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/app.h"
43 #include "asterisk/localtime.h"
44
45 static int function_fieldqty(struct ast_channel *chan, char *cmd,
46                              char *parse, char *buf, size_t len)
47 {
48         char *varval;
49         int fieldcount = 0;
50         AST_DECLARE_APP_ARGS(args,
51                              AST_APP_ARG(varname);
52                              AST_APP_ARG(delim);
53                 );
54
55         AST_STANDARD_APP_ARGS(args, parse);
56         if (args.delim) {
57                 pbx_retrieve_variable(chan, args.varname, &varval, buf, len, NULL);
58                 while (strsep(&varval, args.delim))
59                         fieldcount++;
60         } else {
61                 fieldcount = 1;
62         }
63         snprintf(buf, len, "%d", fieldcount);
64
65         return 0;
66 }
67
68 static struct ast_custom_function fieldqty_function = {
69         .name = "FIELDQTY",
70         .synopsis = "Count the fields, with an arbitrary delimiter",
71         .syntax = "FIELDQTY(<varname>,<delim>)",
72         .read = function_fieldqty,
73 };
74
75 static int filter(struct ast_channel *chan, char *cmd, char *parse, char *buf,
76                   size_t len)
77 {
78         AST_DECLARE_APP_ARGS(args,
79                              AST_APP_ARG(allowed);
80                              AST_APP_ARG(string);
81         );
82         char *outbuf = buf;
83
84         AST_STANDARD_APP_ARGS(args, parse);
85
86         if (!args.string) {
87                 ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>,<string>)\n");
88                 return -1;
89         }
90
91         for (; *(args.string) && (buf + len - 1 > outbuf); (args.string)++) {
92                 if (strchr(args.allowed, *(args.string)))
93                         *outbuf++ = *(args.string);
94         }
95         *outbuf = '\0';
96
97         return 0;
98 }
99
100 static struct ast_custom_function filter_function = {
101         .name = "FILTER",
102         .synopsis = "Filter the string to include only the allowed characters",
103         .syntax = "FILTER(<allowed-chars>,<string>)",
104         .read = filter,
105 };
106
107 static int regex(struct ast_channel *chan, char *cmd, char *parse, char *buf,
108                  size_t len)
109 {
110         AST_DECLARE_APP_ARGS(args,
111                              AST_APP_ARG(null);
112                              AST_APP_ARG(reg);
113                              AST_APP_ARG(str);
114         );
115         int errcode;
116         regex_t regexbuf;
117
118         buf[0] = '\0';
119
120         AST_NONSTANDARD_APP_ARGS(args, parse, '"');
121
122         ast_log(LOG_DEBUG, "FUNCTION REGEX (%s)(%s)\n", args.reg, args.str);
123
124         if ((errcode = regcomp(&regexbuf, args.reg, REG_EXTENDED | REG_NOSUB))) {
125                 regerror(errcode, &regexbuf, buf, len);
126                 ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, parse, buf);
127                 return -1;
128         } else {
129                 if (!regexec(&regexbuf, args.str, 0, NULL, 0))
130                         strcpy(buf, "1");
131         }
132         regfree(&regexbuf);
133
134         return 0;
135 }
136
137 static struct ast_custom_function regex_function = {
138         .name = "REGEX",
139         .synopsis =
140                 "Regular Expression: Returns 1 if data matches regular expression.",
141         .syntax = "REGEX(\"<regular expression>\" <data>)",
142         .read = regex,
143 };
144
145 static int array(struct ast_channel *chan, char *cmd, char *var,
146                  const char *value)
147 {
148         AST_DECLARE_APP_ARGS(arg1,
149                              AST_APP_ARG(var)[100];
150         );
151         AST_DECLARE_APP_ARGS(arg2,
152                              AST_APP_ARG(val)[100];
153         );
154         char *value2;
155         int i;
156
157         value2 = ast_strdupa(value);
158         if (!var || !value2)
159                 return -1;
160
161         /* The functions this will generally be used with are SORT and ODBC_*, which
162          * both return comma-delimited lists.  However, if somebody uses literal lists,
163          * their commas will be translated to vertical bars by the load, and I don't
164          * want them to be surprised by the result.  Hence, we prefer commas as the
165          * delimiter, but we'll fall back to vertical bars if commas aren't found.
166          */
167         ast_log(LOG_DEBUG, "array (%s=%s)\n", var, value2);
168         if (strchr(var, ','))
169                 AST_NONSTANDARD_APP_ARGS(arg1, var, ',');
170         else
171                 AST_STANDARD_APP_ARGS(arg1, var);
172
173         if (strchr(value2, ','))
174                 AST_NONSTANDARD_APP_ARGS(arg2, value2, ',');
175         else
176                 AST_STANDARD_APP_ARGS(arg2, value2);
177
178         for (i = 0; i < arg1.argc; i++) {
179                 ast_log(LOG_DEBUG, "array set value (%s=%s)\n", arg1.var[i],
180                         arg2.val[i]);
181                 if (i < arg2.argc) {
182                         pbx_builtin_setvar_helper(chan, arg1.var[i], arg2.val[i]);
183                 } else {
184                         /* We could unset the variable, by passing a NULL, but due to
185                          * pushvar semantics, that could create some undesired behavior. */
186                         pbx_builtin_setvar_helper(chan, arg1.var[i], "");
187                 }
188         }
189
190         return 0;
191 }
192
193 static struct ast_custom_function array_function = {
194         .name = "ARRAY",
195         .synopsis = "Allows setting multiple variables at once",
196         .syntax = "ARRAY(var1[,var2[...][,varN]])",
197         .write = array,
198         .desc =
199                 "The comma-separated list passed as a value to which the function is set will\n"
200                 "be interpreted as a set of values to which the comma-separated list of\n"
201                 "variable names in the argument should be set.\n"
202                 "Hence, Set(ARRAY(var1,var2)=1,2) will set var1 to 1 and var2 to 2\n"
203                 "Note: remember to either backslash your commas in extensions.conf or quote the\n"
204                 "entire argument, since Set can take multiple arguments itself.\n",
205 };
206
207 static int len(struct ast_channel *chan, char *cmd, char *data, char *buf,
208                size_t len)
209 {
210         int length = 0;
211
212         if (data)
213                 length = strlen(data);
214
215         snprintf(buf, len, "%d", length);
216
217         return 0;
218 }
219
220 static struct ast_custom_function len_function = {
221         .name = "LEN",
222         .synopsis = "Returns the length of the argument given",
223         .syntax = "LEN(<string>)",
224         .read = len,
225 };
226
227 static int acf_strftime(struct ast_channel *chan, char *cmd, char *parse,
228                         char *buf, size_t len)
229 {
230         AST_DECLARE_APP_ARGS(args,
231                              AST_APP_ARG(epoch);
232                              AST_APP_ARG(timezone);
233                              AST_APP_ARG(format);
234         );
235         time_t epochi;
236         struct tm tm;
237
238         buf[0] = '\0';
239
240         if (ast_strlen_zero(parse)) {
241                 ast_log(LOG_ERROR,
242                                 "Asterisk function STRFTIME() requires an argument.\n");
243                 return -1;
244         }
245
246         AST_STANDARD_APP_ARGS(args, parse);
247
248         ast_get_time_t(args.epoch, &epochi, time(NULL));
249         ast_localtime(&epochi, &tm, args.timezone);
250
251         if (!args.format)
252                 args.format = "%c";
253
254         if (!strftime(buf, len, args.format, &tm))
255                 ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
256
257         buf[len - 1] = '\0';
258
259         return 0;
260 }
261
262 static struct ast_custom_function strftime_function = {
263         .name = "STRFTIME",
264         .synopsis = "Returns the current date/time in a specified format.",
265         .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
266         .read = acf_strftime,
267 };
268
269 static int acf_strptime(struct ast_channel *chan, char *cmd, char *data,
270                         char *buf, size_t len)
271 {
272         AST_DECLARE_APP_ARGS(args,
273                              AST_APP_ARG(timestring);
274                              AST_APP_ARG(timezone);
275                              AST_APP_ARG(format);
276         );
277         struct tm time;
278
279         memset(&time, 0, sizeof(struct tm));
280
281         buf[0] = '\0';
282
283         if (!data) {
284                 ast_log(LOG_ERROR,
285                                 "Asterisk function STRPTIME() requires an argument.\n");
286                 return -1;
287         }
288
289         AST_STANDARD_APP_ARGS(args, data);
290
291         if (ast_strlen_zero(args.format)) {
292                 ast_log(LOG_ERROR,
293                                 "No format supplied to STRPTIME(<timestring>|<timezone>|<format>)");
294                 return -1;
295         }
296
297         if (!strptime(args.timestring, args.format, &time)) {
298                 ast_log(LOG_WARNING, "C function strptime() output nothing?!!\n");
299         } else {
300                 snprintf(buf, len, "%d", (int) ast_mktime(&time, args.timezone));
301         }
302
303         return 0;
304 }
305
306 static struct ast_custom_function strptime_function = {
307         .name = "STRPTIME",
308         .synopsis =
309                 "Returns the epoch of the arbitrary date/time string structured as described in the format.",
310         .syntax = "STRPTIME(<datetime>|<timezone>|<format>)",
311         .desc =
312                 "This is useful for converting a date into an EPOCH time, possibly to pass to\n"
313                 "an application like SayUnixTime or to calculate the difference between two\n"
314                 "date strings.\n"
315                 "\n"
316                 "Example:\n"
317                 "  ${STRPTIME(2006-03-01 07:30:35|America/Chicago|%Y-%m-%d %H:%M:%S)} returns 1141219835\n",
318         .read = acf_strptime,
319 };
320
321 static int function_eval(struct ast_channel *chan, char *cmd, char *data,
322                          char *buf, size_t len)
323 {
324         buf[0] = '\0';
325
326         if (ast_strlen_zero(data)) {
327                 ast_log(LOG_WARNING, "EVAL requires an argument: EVAL(<string>)\n");
328                 return -1;
329         }
330
331         pbx_substitute_variables_helper(chan, data, buf, len - 1);
332
333         return 0;
334 }
335
336 static struct ast_custom_function eval_function = {
337         .name = "EVAL",
338         .synopsis = "Evaluate stored variables.",
339         .syntax = "EVAL(<variable>)",
340         .desc = "Using EVAL basically causes a string to be evaluated twice.\n"
341                 "When a variable or expression is in the dialplan, it will be\n"
342                 "evaluated at runtime. However, if the result of the evaluation\n"
343                 "is in fact a variable or expression, using EVAL will have it\n"
344                 "evaluated a second time. For example, if the variable ${MYVAR}\n"
345                 "contains \"${OTHERVAR}\", then the result of putting ${EVAL(${MYVAR})}\n"
346                 "in the dialplan will be the contents of the variable, OTHERVAR.\n"
347                 "Normally, by just putting ${MYVAR} in the dialplan, you would be\n"
348                 "left with \"${OTHERVAR}\".\n",
349         .read = function_eval,
350 };
351
352 static char *tdesc = "String handling dialplan functions";
353
354 int unload_module(void)
355 {
356         int res = 0;
357
358         res |= ast_custom_function_unregister(&fieldqty_function);
359         res |= ast_custom_function_unregister(&filter_function);
360         res |= ast_custom_function_unregister(&regex_function);
361         res |= ast_custom_function_unregister(&array_function);
362         res |= ast_custom_function_unregister(&len_function);
363         res |= ast_custom_function_unregister(&strftime_function);
364         res |= ast_custom_function_unregister(&strptime_function);
365         res |= ast_custom_function_unregister(&eval_function);
366
367         return res;
368 }
369
370 int load_module(void)
371 {
372         int res = 0;
373
374         res |= ast_custom_function_register(&fieldqty_function);
375         res |= ast_custom_function_register(&filter_function);
376         res |= ast_custom_function_register(&regex_function);
377         res |= ast_custom_function_register(&array_function);
378         res |= ast_custom_function_register(&len_function);
379         res |= ast_custom_function_register(&strftime_function);
380         res |= ast_custom_function_register(&strptime_function);
381         res |= ast_custom_function_register(&eval_function);
382
383         return res;
384 }
385
386 char *description(void)
387 {
388         return tdesc;
389 }
390
391 int usecount(void)
392 {
393         return 0;
394 }
395
396 char *key()
397 {
398         return ASTERISK_GPL_KEY;
399 }