aff358c249061265b91b1a5e15a0a5352f473747
[asterisk/asterisk.git] / funcs / func_logic.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  * Portions Copyright (C) 2005, Anthony Minessale II
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  * 
20  * \brief Conditional logic dialplan functions
21  * 
22  * \author Anthony Minessale II
23  *
24  * \ingroup functions
25  */
26
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <sys/types.h>
35
36 #include "asterisk/module.h"
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
43 static int isnull(struct ast_channel *chan, const char *cmd, char *data,
44                   char *buf, size_t len)
45 {
46         strcpy(buf, data && *data ? "0" : "1");
47
48         return 0;
49 }
50
51 static int exists(struct ast_channel *chan, const char *cmd, char *data, char *buf,
52                   size_t len)
53 {
54         strcpy(buf, data && *data ? "1" : "0");
55
56         return 0;
57 }
58
59 static int iftime(struct ast_channel *chan, const char *cmd, char *data, char *buf,
60                   size_t len)
61 {
62         struct ast_timing timing;
63         char *expr;
64         char *iftrue;
65         char *iffalse;
66
67         data = ast_strip_quoted(data, "\"", "\"");
68         expr = strsep(&data, "?");
69         iftrue = strsep(&data, ":");
70         iffalse = data;
71
72         if (ast_strlen_zero(expr) || !(iftrue || iffalse)) {
73                 ast_log(LOG_WARNING,
74                                 "Syntax IFTIME(<timespec>?[<true>][:<false>])\n");
75                 return -1;
76         }
77
78         if (!ast_build_timing(&timing, expr)) {
79                 ast_log(LOG_WARNING, "Invalid Time Spec.\n");
80                 return -1;
81         }
82
83         if (iftrue)
84                 iftrue = ast_strip_quoted(iftrue, "\"", "\"");
85         if (iffalse)
86                 iffalse = ast_strip_quoted(iffalse, "\"", "\"");
87
88         ast_copy_string(buf, ast_check_timing(&timing) ? iftrue : iffalse, len);
89
90         return 0;
91 }
92
93 static int acf_if(struct ast_channel *chan, const char *cmd, char *data, char *buf,
94                   size_t len)
95 {
96         AST_DECLARE_APP_ARGS(args1,
97                 AST_APP_ARG(expr);
98                 AST_APP_ARG(remainder);
99         );
100         AST_DECLARE_APP_ARGS(args2,
101                 AST_APP_ARG(iftrue);
102                 AST_APP_ARG(iffalse);
103         );
104         args2.iftrue = args2.iffalse = NULL; /* you have to set these, because if there is nothing after the '?',
105                                                                                         then args1.remainder will be NULL, not a pointer to a null string, and
106                                                                                         then any garbage in args2.iffalse will not be cleared, and you'll crash.
107                                                                                     -- and if you mod the ast_app_separate_args func instead, you'll really
108                                                                                         mess things up badly, because the rest of everything depends on null args
109                                                                                         for non-specified stuff. */
110         
111         AST_NONSTANDARD_APP_ARGS(args1, data, '?');
112         AST_NONSTANDARD_APP_ARGS(args2, args1.remainder, ':');
113
114         if (ast_strlen_zero(args1.expr) || !(args2.iftrue || args2.iffalse)) {
115                 ast_log(LOG_WARNING, "Syntax IF(<expr>?[<true>][:<false>])  (expr must be non-null, and either <true> or <false> must be non-null)\n");
116                 ast_log(LOG_WARNING, "      In this case, <expr>='%s', <true>='%s', and <false>='%s'\n", args1.expr, args2.iftrue, args2.iffalse);
117                 return -1;
118         }
119
120         args1.expr = ast_strip(args1.expr);
121         if (args2.iftrue)
122                 args2.iftrue = ast_strip(args2.iftrue);
123         if (args2.iffalse)
124                 args2.iffalse = ast_strip(args2.iffalse);
125
126         ast_copy_string(buf, pbx_checkcondition(args1.expr) ? (S_OR(args2.iftrue, "")) : (S_OR(args2.iffalse, "")), len);
127
128         return 0;
129 }
130
131 static int set(struct ast_channel *chan, const char *cmd, char *data, char *buf,
132                size_t len)
133 {
134         char *varname;
135         char *val;
136
137         varname = strsep(&data, "=");
138         val = data;
139
140         if (ast_strlen_zero(varname) || !val) {
141                 ast_log(LOG_WARNING, "Syntax SET(<varname>=[<value>])\n");
142                 return -1;
143         }
144
145         varname = ast_strip(varname);
146         val = ast_strip(val);
147         pbx_builtin_setvar_helper(chan, varname, val);
148         ast_copy_string(buf, val, len);
149
150         return 0;
151 }
152
153 static int acf_import(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
154 {
155         AST_DECLARE_APP_ARGS(args,
156                 AST_APP_ARG(channel);
157                 AST_APP_ARG(varname);
158         );
159         AST_STANDARD_APP_ARGS(args, data);
160         memset(buf, 0, len);
161
162         if (!ast_strlen_zero(args.varname)) {
163                 struct ast_channel *chan2 = ast_get_channel_by_name_locked(args.channel);
164                 if (chan2) {
165                         char *s = alloca(strlen(args.varname) + 4);
166                         if (s) {
167                                 sprintf(s, "${%s}", args.varname);
168                                 pbx_substitute_variables_helper(chan2, s, buf, len);
169                         }
170                         ast_channel_unlock(chan2);
171                 }
172         }
173         return 0;
174 }
175
176 static struct ast_custom_function isnull_function = {
177         .name = "ISNULL",
178         .synopsis = "NULL Test: Returns 1 if NULL or 0 otherwise",
179         .syntax = "ISNULL(<data>)",
180         .read = isnull,
181 };
182
183 static struct ast_custom_function set_function = {
184         .name = "SET",
185         .synopsis = "SET assigns a value to a channel variable",
186         .syntax = "SET(<varname>=[<value>])",
187         .read = set,
188 };
189
190 static struct ast_custom_function exists_function = {
191         .name = "EXISTS",
192         .synopsis = "Existence Test: Returns 1 if exists, 0 otherwise",
193         .syntax = "EXISTS(<data>)",
194         .read = exists,
195 };
196
197 static struct ast_custom_function if_function = {
198         .name = "IF",
199         .synopsis =
200                 "Conditional: Returns the data following '?' if true, else the data following ':'",
201         .syntax = "IF(<expr>?[<true>][:<false>])",
202         .read = acf_if,
203 };
204
205 static struct ast_custom_function if_time_function = {
206         .name = "IFTIME",
207         .synopsis =
208                 "Temporal Conditional: Returns the data following '?' if true, else the data following ':'",
209         .syntax = "IFTIME(<timespec>?[<true>][:<false>])",
210         .read = iftime,
211 };
212
213 static struct ast_custom_function import_function = {
214         .name = "IMPORT",
215         .synopsis =
216                 "Retrieve the value of a variable from another channel\n",
217         .syntax = "IMPORT(channel,variable)",
218         .read = acf_import,
219 };
220
221 static int unload_module(void)
222 {
223         int res = 0;
224
225         res |= ast_custom_function_unregister(&isnull_function);
226         res |= ast_custom_function_unregister(&set_function);
227         res |= ast_custom_function_unregister(&exists_function);
228         res |= ast_custom_function_unregister(&if_function);
229         res |= ast_custom_function_unregister(&if_time_function);
230         res |= ast_custom_function_unregister(&import_function);
231
232         return res;
233 }
234
235 static int load_module(void)
236 {
237         int res = 0;
238
239         res |= ast_custom_function_register(&isnull_function);
240         res |= ast_custom_function_register(&set_function);
241         res |= ast_custom_function_register(&exists_function);
242         res |= ast_custom_function_register(&if_function);
243         res |= ast_custom_function_register(&if_time_function);
244         res |= ast_custom_function_register(&import_function);
245
246         return res;
247 }
248
249 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Logical dialplan functions");