Use the same delimited character as the FILTER function in FIELDQTY and CUT.
[asterisk/asterisk.git] / apps / app_exec.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2004 - 2005, Tilghman Lesher.  All rights reserved.
5  * Portions copyright (c) 2006, Philipp Dunkel.
6  *
7  * Tilghman Lesher <app_exec__v002@the-tilghman.com>
8  *
9  * This code is released by the author with no restrictions on usage.
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  */
18
19 /*! \file
20  *
21  * \brief Exec application
22  *
23  * \author Tilghman Lesher <app_exec__v002@the-tilghman.com>
24  * \author Philipp Dunkel <philipp.dunkel@ebox.at>
25  *
26  * \ingroup applications
27  */
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <unistd.h>
36 #include <string.h>
37
38 #include "asterisk/file.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/options.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/module.h"
44 #include "asterisk/app.h"
45
46 /* Maximum length of any variable */
47 #define MAXRESULT       1024
48
49 /*! Note
50  *
51  * The key difference between these two apps is exit status.  In a
52  * nutshell, Exec tries to be transparent as possible, behaving
53  * in exactly the same way as if the application it calls was
54  * directly invoked from the dialplan.
55  *
56  * TryExec, on the other hand, provides a way to execute applications
57  * and catch any possible fatal error without actually fatally
58  * affecting the dialplan.
59  */
60
61 static char *app_exec = "Exec";
62 static char *exec_synopsis = "Executes dialplan application";
63 static char *exec_descrip =
64 "Usage: Exec(appname(arguments))\n"
65 "  Allows an arbitrary application to be invoked even when not\n"
66 "hardcoded into the dialplan.  If the underlying application\n"
67 "terminates the dialplan, or if the application cannot be found,\n"
68 "Exec will terminate the dialplan.\n"
69 "  To invoke external applications, see the application System.\n"
70 "  If you would like to catch any error instead, see TryExec.\n";
71
72 static char *app_tryexec = "TryExec";
73 static char *tryexec_synopsis = "Executes dialplan application, always returning";
74 static char *tryexec_descrip =
75 "Usage: TryExec(appname(arguments))\n"
76 "  Allows an arbitrary application to be invoked even when not\n"
77 "hardcoded into the dialplan. To invoke external applications\n"
78 "see the application System.  Always returns to the dialplan.\n"
79 "The channel variable TRYSTATUS will be set to:\n"
80 "    SUCCESS   if the application returned zero\n"
81 "    FAILED    if the application returned non-zero\n"
82 "    NOAPP     if the application was not found or was not specified\n";
83
84 static char *app_execif = "ExecIf";
85 static char *execif_synopsis = "Executes dialplan application, conditionally";
86 static char *execif_descrip = 
87 "Usage:  ExecIF (<expr>?<app>(<data>):<app2>(<data2>))\n"
88 "If <expr> is true, execute and return the result of <app>(<data>).\n"
89 "If <expr> is true, but <app> is not found, then the application\n"
90 "will return a non-zero value.\n";
91
92 static int exec_exec(struct ast_channel *chan, void *data)
93 {
94         int res = 0;
95         char *s, *appname, *endargs, args[MAXRESULT] = "";
96         struct ast_app *app;
97
98         if (ast_strlen_zero(data))
99                 return 0;
100         
101         s = ast_strdupa(data);
102         appname = strsep(&s, "(");
103         if (s) {
104                 endargs = strrchr(s, ')');
105                 if (endargs)
106                         *endargs = '\0';
107                 pbx_substitute_variables_helper(chan, s, args, MAXRESULT - 1);
108         }
109         if (appname) {
110                 app = pbx_findapp(appname);
111                 if (app) {
112                         res = pbx_exec(chan, app, args);
113                 } else {
114                         ast_log(LOG_WARNING, "Could not find application (%s)\n", appname);
115                         res = -1;
116                 }
117         }
118
119         return res;
120 }
121
122 static int tryexec_exec(struct ast_channel *chan, void *data)
123 {
124         int res = 0;
125         char *s, *appname, *endargs, args[MAXRESULT] = "";
126         struct ast_app *app;
127
128         if (ast_strlen_zero(data))
129                 return 0;
130
131         s = ast_strdupa(data);
132         appname = strsep(&s, "(");
133         if (s) {
134                 endargs = strrchr(s, ')');
135                 if (endargs)
136                         *endargs = '\0';
137                 pbx_substitute_variables_helper(chan, s, args, MAXRESULT - 1);
138         }
139         if (appname) {
140                 app = pbx_findapp(appname);
141                 if (app) {
142                         res = pbx_exec(chan, app, args);
143                         pbx_builtin_setvar_helper(chan, "TRYSTATUS", res ? "FAILED" : "SUCCESS");
144                 } else {
145                         ast_log(LOG_WARNING, "Could not find application (%s)\n", appname);
146                         pbx_builtin_setvar_helper(chan, "TRYSTATUS", "NOAPP");
147                 }
148         }
149
150         return 0;
151 }
152
153 static int execif_exec(struct ast_channel *chan, void *data)
154 {
155         int res = 0;
156         char *truedata = NULL, *falsedata = NULL, *end;
157         struct ast_app *app = NULL;
158         AST_DECLARE_APP_ARGS(expr,
159                 AST_APP_ARG(expr);
160                 AST_APP_ARG(remainder);
161         );
162         AST_DECLARE_APP_ARGS(apps,
163                 AST_APP_ARG(t);
164                 AST_APP_ARG(f);
165         );
166         char *parse = ast_strdupa(data);
167
168         AST_NONSTANDARD_APP_ARGS(expr, parse, '?');
169         AST_NONSTANDARD_APP_ARGS(apps, expr.remainder, ':');
170
171         if (apps.t && (truedata = strchr(apps.t, '('))) {
172                 *truedata++ = '\0';
173                 if ((end = strrchr(truedata, ')')))
174                         *end = '\0';
175         }
176
177         if (apps.f && (falsedata = strchr(apps.f, '('))) {
178                 *falsedata++ = '\0';
179                 if ((end = strrchr(falsedata, ')')))
180                         *end = '\0';
181         }
182
183         if (pbx_checkcondition(expr.expr)) { 
184                 if (!ast_strlen_zero(apps.t) && (app = pbx_findapp(apps.t))) {
185                         res = pbx_exec(chan, app, S_OR(truedata, ""));
186                 } else {
187                         ast_log(LOG_WARNING, "Could not find application! (%s)\n", apps.t);
188                         res = -1;
189                 }
190         } else {
191                 if (!ast_strlen_zero(apps.f) && (app = pbx_findapp(apps.f))) {
192                         res = pbx_exec(chan, app, S_OR(falsedata, ""));
193                 } else {
194                         ast_log(LOG_WARNING, "Could not find application! (%s)\n", apps.f);
195                         res = -1;
196                 }
197         }
198
199         return res;
200 }
201
202 static int unload_module(void)
203 {
204         int res;
205
206         res = ast_unregister_application(app_exec);
207         res |= ast_unregister_application(app_tryexec);
208         res |= ast_unregister_application(app_execif);
209
210         return res;
211 }
212
213 static int load_module(void)
214 {
215         int res = ast_register_application(app_exec, exec_exec, exec_synopsis, exec_descrip);
216         res |= ast_register_application(app_tryexec, tryexec_exec, tryexec_synopsis, tryexec_descrip);
217         res |= ast_register_application(app_execif, execif_exec, execif_synopsis, execif_descrip);
218         return res;
219 }
220
221 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Executes dialplan applications");