make app_queue 1.2 jump compliant (issue #5580)
[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_regex(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
72 {
73         char *arg, *earg = NULL, *tmp, errstr[256] = "";
74         int errcode;
75         regex_t regexbuf;
76
77         ast_copy_string(buf, "0", len);
78         
79         tmp = ast_strdupa(data);
80         if (!tmp) {
81                 ast_log(LOG_ERROR, "Out of memory in %s(%s)\n", cmd, data);
82                 return buf;
83         }
84
85         /* Regex in quotes */
86         arg = strchr(tmp, '"');
87         if (arg) {
88                 arg++;
89                 earg = strrchr(arg, '"');
90                 if (earg) {
91                         *earg++ = '\0';
92                         /* Skip over any spaces before the data we are checking */
93                         while (*earg == ' ')
94                                 earg++;
95                 }
96         } else {
97                 arg = tmp;
98         }
99
100         if ((errcode = regcomp(&regexbuf, arg, REG_EXTENDED | REG_NOSUB))) {
101                 regerror(errcode, &regexbuf, errstr, sizeof(errstr));
102                 ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, data, errstr);
103         } else {
104                 if (!regexec(&regexbuf, earg ? earg : "", 0, NULL, 0))
105                         ast_copy_string(buf, "1", len); 
106         }
107         regfree(&regexbuf);
108
109         return buf;
110 }
111
112 #ifndef BUILTIN_FUNC
113 static
114 #endif
115 struct ast_custom_function regex_function = {
116         .name = "REGEX",
117         .synopsis = "Regular Expression: Returns 1 if data matches regular expression.",
118         .syntax = "REGEX(\"<regular expression>\" <data>)",
119         .read = builtin_function_regex,
120 };
121
122 static char *builtin_function_len(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
123 {
124         int length = 0;
125         if (data) {
126                 length = strlen(data);
127         }
128         snprintf(buf, len, "%d", length);
129         return buf;
130 }
131
132 #ifndef BUILTIN_FUNC
133 static
134 #endif
135 struct ast_custom_function len_function = {
136         .name = "LEN",
137         .synopsis = "Returns the length of the argument given",
138         .syntax = "LEN(<string>)",
139         .read = builtin_function_len,
140 };
141
142 static char *acf_strftime(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
143 {
144         char *format, *epoch, *timezone = NULL;
145         long epochi;
146         struct tm time;
147
148         buf[0] = '\0';
149
150         if (!data) {
151                 ast_log(LOG_ERROR, "Asterisk function STRFTIME() requires an argument.\n");
152                 return buf;
153         }
154         
155         format = ast_strdupa(data);
156         if (!format) {
157                 ast_log(LOG_ERROR, "Out of memory\n");
158                 return buf;
159         }
160         
161         epoch = strsep(&format, "|");
162         timezone = strsep(&format, "|");
163
164         if (ast_strlen_zero(epoch) || !sscanf(epoch, "%ld", &epochi)) {
165                 struct timeval tv = ast_tvnow();
166                 epochi = tv.tv_sec;
167         }
168
169         ast_localtime(&epochi, &time, timezone);
170
171         if (!format) {
172                 format = "%c";
173         }
174
175         if (!strftime(buf, len, format, &time)) {
176                 ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
177         }
178         buf[len - 1] = '\0';
179
180         return buf;
181 }
182
183 #ifndef BUILTIN_FUNC
184 static
185 #endif
186 struct ast_custom_function strftime_function = {
187         .name = "STRFTIME",
188         .synopsis = "Returns the current date/time in a specified format.",
189         .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
190         .read = acf_strftime,
191 };
192
193 static char *function_eval(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
194 {
195         memset(buf, 0, len);
196
197         if (ast_strlen_zero(data)) {
198                 ast_log(LOG_WARNING, "EVAL requires an argument: EVAL(<string>)\n");
199                 return buf;
200         }
201
202         pbx_substitute_variables_helper(chan, data, buf, len - 1);
203
204         return buf;
205 }
206
207 #ifndef BUILTIN_FUNC
208 static
209 #endif
210 struct ast_custom_function eval_function = {
211         .name = "EVAL",
212         .synopsis = "Evaluate stored variables.",
213         .syntax = "EVAL(<variable>)",
214         .desc = "Using EVAL basically causes a string to be evaluated twice.\n"
215                 "When a variable or expression is in the dialplan, it will be\n"
216                 "evaluated at runtime. However, if the result of the evaluation\n"
217                 "is in fact a variable or expression, using EVAL will have it\n"
218                 "evaluated a second time. For example, if the variable ${MYVAR}\n"
219                 "contains \"${OTHERVAR}\", then the result of putting ${EVAL(${MYVAR})}\n"
220                 "in the dialplan will be the contents of the variable, OTHERVAR.\n"
221                 "Normally, by just putting ${MYVAR} in the dialplan, you would be\n"
222                 "left with \"${OTHERVAR}\".\n", 
223         .read = function_eval,
224 };
225