add STRFTIME dialplan function (bug #4098, modified to use new funcs subdirectory)
[asterisk/asterisk.git] / funcs / func_strings.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * String manipulation dialplan functions
5  * 
6  * Copyright (C) 2005, Digium, Inc.
7  *
8  * This program is free software, distributed under the terms of
9  * the GNU General Public License
10  */
11
12 #include <stdlib.h>
13 #include <string.h>
14 #include <sys/types.h>
15 #include <regex.h>
16
17 #include "asterisk/channel.h"
18 #include "asterisk/pbx.h"
19 #include "asterisk/logger.h"
20 #include "asterisk/utils.h"
21 #include "asterisk/app.h"
22 #include "asterisk/localtime.h"
23
24 static char *function_fieldqty(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
25 {
26         char *varname, *varval, workspace[256];
27         char *delim = ast_strdupa(data);
28         int fieldcount = 0;
29
30         if (delim) {
31                 varname = strsep(&delim, "|");
32                 pbx_retrieve_variable(chan, varname, &varval, workspace, sizeof(workspace), NULL);
33                 while (strsep(&varval, delim))
34                         fieldcount++;
35                 snprintf(buf, len, "%d", fieldcount);
36         } else {
37                 ast_log(LOG_ERROR, "Out of memory\n");
38                 strncpy(buf, "1", len);
39         }
40         return buf;
41 }
42
43 #ifndef BUILTIN_FUNC
44 static
45 #endif
46 struct ast_custom_function fieldqty_function = {
47         .name = "FIELDQTY",
48         .synopsis = "Count the fields, with an arbitrary delimiter",
49         .syntax = "FIELDQTY(<varname>,<delim>)",
50         .read = function_fieldqty,
51 };
52
53 static char *builtin_function_regex(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
54 {
55         char *ret_true = "1", *ret_false = "0", *ret;
56         char *arg, *earg, *tmp, errstr[256] = "";
57         int errcode;
58         regex_t regexbuf;
59
60         ret = ret_false; /* convince me otherwise */
61         tmp = ast_strdupa(data);
62         if (tmp) {
63                 /* Regex in quotes */
64                 arg = strchr(tmp, '"');
65                 if (arg) {
66                         arg++;
67                         earg = strrchr(arg, '"');
68                         if (earg) {
69                                 *earg = '\0';
70                         }
71                 } else {
72                         arg = tmp;
73                 }
74
75                 if ((errcode = regcomp(&regexbuf, arg, REG_EXTENDED | REG_NOSUB))) {
76                         regerror(errcode, &regexbuf, errstr, sizeof(errstr));
77                         ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, data, errstr);
78                         ret = NULL;
79                 } else {
80                         ret = regexec(&regexbuf, data, 0, NULL, 0) ? ret_false : ret_true;
81                 }
82                 regfree(&regexbuf);
83         } else {
84                 ast_log(LOG_ERROR, "Out of memory in %s(%s)\n", cmd, data);
85         }
86
87         return ret;
88 }
89
90 #ifndef BUILTIN_FUNC
91 static
92 #endif
93 struct ast_custom_function regex_function = {
94         .name = "REGEX",
95         .synopsis = "Regular Expression: Returns 1 if data matches regular expression.",
96         .syntax = "REGEX(\"<regular expression>\" <data>)",
97         .read = builtin_function_regex,
98 };
99
100 static char *builtin_function_len(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
101 {
102         int length = 0;
103         if (data) {
104                 length = strlen(data);
105         }
106         snprintf(buf, len, "%d", length);
107         return buf;
108 }
109
110 #ifndef BUILTIN_FUNC
111 static
112 #endif
113 struct ast_custom_function len_function = {
114         .name = "LEN",
115         .synopsis = "Returns the length of the argument given",
116         .syntax = "LEN(<string>)",
117         .read = builtin_function_len,
118 };
119
120 static char *acf_strftime(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
121 {
122         char *format, *epoch, *timezone;
123         long epochi;
124         struct timeval tv;
125         struct tm time;
126
127         if (data) {
128                 format = ast_strdupa(data);
129                 if (format) {
130                         epoch = strsep(&format, "|");
131                         timezone = strsep(&format, "|");
132
133                         if (epoch && !ast_strlen_zero(epoch) && sscanf(epoch, "%ld", &epochi) == 1) {
134                         } else if (!gettimeofday(&tv, NULL)) {
135                                 epochi = tv.tv_sec;
136                         } else {
137                                 ast_log(LOG_ERROR, "Cannot gettimeofday() ?!!\n");
138                                 return "";
139                         }
140
141                         ast_localtime(&epochi, &time, timezone);
142
143                         if (!format) {
144                                 format = "%c";
145                         }
146
147                         buf[0] = '\0';
148                         if (! strftime(buf, len, format, &time)) {
149                                 ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
150                         }
151                         buf[len - 1] = '\0';
152
153                         return buf;
154                 } else {
155                         ast_log(LOG_ERROR, "Out of memory\n");
156                 }
157         } else {
158                 ast_log(LOG_ERROR, "Asterisk function STRFTIME() requires an argument.\n");
159         }
160         return "";
161 }
162
163 #ifndef BUILTIN_FUNC
164 static
165 #endif
166 struct ast_custom_function strftime_function = {
167         .name = "STRFTIME",
168         .synopsis = "Returns the current date/time in a specified format.",
169         .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
170         .read = acf_strftime,
171 };