d34d13d725c749b3e98b56f3098d6814e803a041
[asterisk/asterisk.git] / apps / app_stack.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2004-2006 Tilghman Lesher <app_stack_v003@the-tilghman.com>.
5  *
6  * This code is released by the author with no restrictions on usage.
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 Stack applications Gosub, Return, etc.
22  *
23  * \author Tilghman Lesher <app_stack_v003@the-tilghman.com>
24  * 
25  * \ingroup applications
26  */
27
28 #include "asterisk.h"
29  
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <unistd.h>
35 #include <string.h>
36
37 #include "asterisk/options.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/chanvars.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/config.h"
44 #include "asterisk/app.h"
45
46 #define STACKVAR        "~GOSUB~STACK~"
47
48
49 static const char *app_gosub = "Gosub";
50 static const char *app_gosubif = "GosubIf";
51 static const char *app_return = "Return";
52 static const char *app_pop = "StackPop";
53
54 static const char *gosub_synopsis = "Jump to label, saving return address";
55 static const char *gosubif_synopsis = "Conditionally jump to label, saving return address";
56 static const char *return_synopsis = "Return from gosub routine";
57 static const char *pop_synopsis = "Remove one address from gosub stack";
58
59 static const char *gosub_descrip =
60 "Gosub([[context|]exten|]priority[(arg1[|...][|argN])])\n"
61 "  Jumps to the label specified, saving the return address.\n";
62 static const char *gosubif_descrip =
63 "GosubIf(condition?labeliftrue[(arg1[|...])][:labeliffalse[(arg1[|...])]])\n"
64 "  If the condition is true, then jump to labeliftrue.  If false, jumps to\n"
65 "labeliffalse, if specified.  In either case, a jump saves the return point\n"
66 "in the dialplan, to be returned to with a Return.\n";
67 static const char *return_descrip =
68 "Return([return-value])\n"
69 "  Jumps to the last label on the stack, removing it.  The return value, if\n"
70 "any, is saved in the channel variable GOSUB_RETVAL.\n";
71 static const char *pop_descrip =
72 "StackPop()\n"
73 "  Removes last label on the stack, discarding it.\n";
74
75
76 static int pop_exec(struct ast_channel *chan, void *data)
77 {
78         const char *frame = pbx_builtin_getvar_helper(chan, STACKVAR);
79         int numargs = 0, i;
80         char argname[15];
81
82         /* Pop any arguments for this stack frame off the variable stack */
83         if (frame) {
84                 numargs = atoi(frame);
85                 for (i = 1; i <= numargs; i++) {
86                         snprintf(argname, sizeof(argname), "ARG%d", i);
87                         pbx_builtin_setvar_helper(chan, argname, NULL);
88                 }
89         }
90
91         /* Remove the last frame from the Gosub stack */
92         pbx_builtin_setvar_helper(chan, STACKVAR, NULL);
93
94         return 0;
95 }
96
97 static int return_exec(struct ast_channel *chan, void *data)
98 {
99         const char *label = pbx_builtin_getvar_helper(chan, STACKVAR);
100         char argname[15], *retval = data;
101         int numargs, i;
102
103         if (ast_strlen_zero(label)) {
104                 ast_log(LOG_ERROR, "Return without Gosub: stack is empty\n");
105                 return -1;
106         }
107
108         /* Pop any arguments for this stack frame off the variable stack */
109         numargs = atoi(label);
110         for (i = 1; i <= numargs; i++) {
111                 snprintf(argname, sizeof(argname), "ARG%d", i);
112                 pbx_builtin_setvar_helper(chan, argname, NULL);
113         }
114
115         /* If the label exists, it will always have a ':' */
116         label = strchr(label, ':') + 1;
117
118         if (ast_parseable_goto(chan, label)) {
119                 ast_log(LOG_WARNING, "No next statement after Gosub?\n");
120                 return -1;
121         }
122
123         /* Remove the current frame from the Gosub stack */
124         pbx_builtin_setvar_helper(chan, STACKVAR, NULL);
125
126         /* Set a return value, if any */
127         pbx_builtin_setvar_helper(chan, "GOSUB_RETVAL", S_OR(retval, ""));
128         return 0;
129 }
130
131 static int gosub_exec(struct ast_channel *chan, void *data)
132 {
133         char newlabel[AST_MAX_EXTENSION + AST_MAX_CONTEXT + 11 + 11 + 4];
134         char argname[15], *tmp = ast_strdupa(data), *label, *endparen;
135         int i;
136         struct ast_module_user *u;
137         AST_DECLARE_APP_ARGS(args2,
138                 AST_APP_ARG(argval)[100];
139         );
140
141         if (ast_strlen_zero(data)) {
142                 ast_log(LOG_ERROR, "%s requires an argument: %s([[context|]exten|]priority[(arg1[|...][|argN])])\n", app_gosub, app_gosub);
143                 return -1;
144         }
145
146         u = ast_module_user_add(chan);
147
148         /* Separate the arguments from the label */
149         /* NOTE:  you cannot use ast_app_separate_args for this, because '(' cannot be used as a delimiter. */
150         label = strsep(&tmp, "(");
151         if (tmp) {
152                 endparen = strrchr(tmp, ')');
153                 if (endparen)
154                         *endparen = '\0';
155                 else
156                         ast_log(LOG_WARNING, "Ouch.  No closing paren: '%s'?\n", (char *)data);
157                 AST_STANDARD_APP_ARGS(args2, tmp);
158         } else
159                 args2.argc = 0;
160
161         /* Create the return address, but don't save it until we know that the Gosub destination exists */
162         snprintf(newlabel, sizeof(newlabel), "%d:%s|%s|%d", args2.argc, chan->context, chan->exten, chan->priority + 1);
163
164         if (ast_parseable_goto(chan, label)) {
165                 ast_log(LOG_ERROR, "Gosub address is invalid: '%s'\n", (char *)data);
166                 ast_module_user_remove(u);
167                 return -1;
168         }
169
170         /* Now that we know for certain that we're going to a new location, set our arguments */
171         for (i = 0; i < args2.argc; i++) {
172                 snprintf(argname, sizeof(argname), "ARG%d", i + 1);
173                 pbx_builtin_pushvar_helper(chan, argname, args2.argval[i]);
174                 ast_log(LOG_DEBUG, "Setting '%s' to '%s'\n", argname, args2.argval[i]);
175         }
176
177         /* And finally, save our return address */
178         pbx_builtin_pushvar_helper(chan, STACKVAR, newlabel);
179         ast_log(LOG_DEBUG, "Setting gosub return address to '%s'\n", newlabel);
180         ast_module_user_remove(u);
181
182         return 0;
183 }
184
185 static int gosubif_exec(struct ast_channel *chan, void *data)
186 {
187         struct ast_module_user *u;
188         char *args;
189         int res=0;
190         AST_DECLARE_APP_ARGS(cond,
191                 AST_APP_ARG(ition);
192                 AST_APP_ARG(labels);
193         );
194         AST_DECLARE_APP_ARGS(label,
195                 AST_APP_ARG(iftrue);
196                 AST_APP_ARG(iffalse);
197         );
198
199         if (ast_strlen_zero(data)) {
200                 ast_log(LOG_WARNING, "GosubIf requires an argument: GosubIf(cond?label1(args):label2(args)\n");
201                 return 0;
202         }
203
204         u = ast_module_user_add(chan);
205
206         args = ast_strdupa(data);
207         AST_NONSTANDARD_APP_ARGS(cond, args, '?');
208         if (cond.argc != 2) {
209                 ast_log(LOG_WARNING, "GosubIf requires an argument: GosubIf(cond?label1(args):label2(args)\n");
210                 ast_module_user_remove(u);
211                 return 0;
212         }
213
214         AST_NONSTANDARD_APP_ARGS(label, cond.labels, ':');
215
216         if (pbx_checkcondition(cond.ition)) {
217                 if (!ast_strlen_zero(label.iftrue))
218                         res = gosub_exec(chan, label.iftrue);
219         } else if (!ast_strlen_zero(label.iffalse)) {
220                 res = gosub_exec(chan, label.iffalse);
221         }
222
223         ast_module_user_remove(u);
224         return res;
225 }
226
227 static int unload_module(void)
228 {
229         ast_unregister_application(app_return);
230         ast_unregister_application(app_pop);
231         ast_unregister_application(app_gosubif);
232         ast_unregister_application(app_gosub);
233
234         ast_module_user_hangup_all();
235
236         return 0;
237 }
238
239 static int load_module(void)
240 {
241         ast_register_application(app_pop, pop_exec, pop_synopsis, pop_descrip);
242         ast_register_application(app_return, return_exec, return_synopsis, return_descrip);
243         ast_register_application(app_gosubif, gosubif_exec, gosubif_synopsis, gosubif_descrip);
244         ast_register_application(app_gosub, gosub_exec, gosub_synopsis, gosub_descrip);
245
246         return 0;
247 }
248
249 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Stack Routines");