014d2d9baa2e52fceacbc6ca341c341b487e5f79
[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 static const char *app_gosub = "Gosub";
49 static const char *app_gosubif = "GosubIf";
50 static const char *app_return = "Return";
51 static const char *app_pop = "StackPop";
52
53 static const char *gosub_synopsis = "Jump to label, saving return address";
54 static const char *gosubif_synopsis = "Conditionally jump to label, saving return address";
55 static const char *return_synopsis = "Return from gosub routine";
56 static const char *pop_synopsis = "Remove one address from gosub stack";
57
58 static const char *gosub_descrip =
59 "Gosub([[context|]exten|]priority[(arg1[|...][|argN])])\n"
60 "  Jumps to the label specified, saving the return address.\n";
61 static const char *gosubif_descrip =
62 "GosubIf(condition?labeliftrue[(arg1[|...])][:labeliffalse[(arg1[|...])]])\n"
63 "  If the condition is true, then jump to labeliftrue.  If false, jumps to\n"
64 "labeliffalse, if specified.  In either case, a jump saves the return point\n"
65 "in the dialplan, to be returned to with a Return.\n";
66 static const char *return_descrip =
67 "Return([return-value])\n"
68 "  Jumps to the last label on the stack, removing it.  The return value, if\n"
69 "any, is saved in the channel variable GOSUB_RETVAL.\n";
70 static const char *pop_descrip =
71 "StackPop()\n"
72 "  Removes last label on the stack, discarding it.\n";
73
74
75 static void gosub_free(void *data);
76
77 static struct ast_datastore_info stack_info = {
78         .type = "GOSUB",
79         .destroy = gosub_free,
80 };
81
82 struct gosub_stack_frame {
83         AST_LIST_ENTRY(gosub_stack_frame) entries;
84         /* 100 arguments is all that we support anyway, but this will handle up to 255 */
85         unsigned char arguments;
86         int priority;
87         char *context;
88         char extension[0];
89 };
90
91 static void gosub_release_frame(struct ast_channel *chan, struct gosub_stack_frame *frame)
92 {
93         unsigned char i;
94         char argname[15];
95
96         /* If chan is not defined, then we're calling it as part of gosub_free,
97          * and the channel variables will be deallocated anyway.  Otherwise, we're
98          * just releasing a single frame, so we need to clean up the arguments for
99          * that frame, so that we re-expose the variables from the previous frame
100          * that were hidden by this one.
101          */
102         if (chan) {
103                 for (i = 1; i <= frame->arguments && i != 0; i++) {
104                         snprintf(argname, sizeof(argname), "ARG%hhd", i);
105                         pbx_builtin_setvar_helper(chan, argname, NULL);
106                 }
107         }
108         ast_free(frame);
109 }
110
111 static struct gosub_stack_frame *gosub_allocate_frame(const char *context, const char *extension, int priority, unsigned char arguments)
112 {
113         struct gosub_stack_frame *new = NULL;
114         int len_extension = strlen(extension), len_context = strlen(context);
115
116         if ((new = ast_calloc(1, sizeof(*new) + 2 + len_extension + len_context))) {
117                 strcpy(new->extension, extension);
118                 new->context = new->extension + len_extension + 1;
119                 strcpy(new->context, context);
120                 new->priority = priority;
121                 new->arguments = arguments;
122         }
123         return new;
124 }
125
126 static void gosub_free(void *data)
127 {
128         AST_LIST_HEAD(, gosub_stack_frame) *oldlist = data;
129         struct gosub_stack_frame *oldframe;
130         AST_LIST_LOCK(oldlist);
131         while ((oldframe = AST_LIST_REMOVE_HEAD(oldlist, entries))) {
132                 gosub_release_frame(NULL, oldframe);
133         }
134         AST_LIST_UNLOCK(oldlist);
135         AST_LIST_HEAD_DESTROY(oldlist);
136         ast_free(oldlist);
137 }
138
139 static int pop_exec(struct ast_channel *chan, void *data)
140 {
141         struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
142         struct gosub_stack_frame *oldframe;
143         AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
144
145         if (!stack_store) {
146                 ast_log(LOG_WARNING, "%s called with no gosub stack allocated.\n", app_pop);
147                 return 0;
148         }
149
150         oldlist = stack_store->data;
151         AST_LIST_LOCK(oldlist);
152         oldframe = AST_LIST_REMOVE_HEAD(oldlist, entries);
153         AST_LIST_UNLOCK(oldlist);
154
155         if (oldframe)
156                 gosub_release_frame(chan, oldframe);
157         else if (option_debug)
158                 ast_log(LOG_DEBUG, "%s called with an empty gosub stack\n", app_pop);
159
160         return 0;
161 }
162
163 static int return_exec(struct ast_channel *chan, void *data)
164 {
165         struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
166         struct gosub_stack_frame *oldframe;
167         AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
168         char *retval = data;
169
170         if (!stack_store) {
171                 ast_log(LOG_ERROR, "Return without Gosub: stack is unallocated\n");
172                 return -1;
173         }
174
175         oldlist = stack_store->data;
176         AST_LIST_LOCK(oldlist);
177         oldframe = AST_LIST_REMOVE_HEAD(oldlist, entries);
178         AST_LIST_UNLOCK(oldlist);
179
180         if (!oldframe) {
181                 ast_log(LOG_ERROR, "Return without Gosub: stack is empty\n");
182                 return -1;
183         }
184
185         ast_explicit_goto(chan, oldframe->context, oldframe->extension, oldframe->priority);
186         gosub_release_frame(chan, oldframe);
187
188         /* Set a return value, if any */
189         pbx_builtin_setvar_helper(chan, "GOSUB_RETVAL", S_OR(retval, ""));
190         return 0;
191 }
192
193 static int gosub_exec(struct ast_channel *chan, void *data)
194 {
195         struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
196         AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
197         struct gosub_stack_frame *newframe;
198         char argname[15], *tmp = ast_strdupa(data), *label, *endparen;
199         int i;
200         struct ast_module_user *u;
201         AST_DECLARE_APP_ARGS(args2,
202                 AST_APP_ARG(argval)[100];
203         );
204
205         if (ast_strlen_zero(data)) {
206                 ast_log(LOG_ERROR, "%s requires an argument: %s([[context|]exten|]priority[(arg1[|...][|argN])])\n", app_gosub, app_gosub);
207                 return -1;
208         }
209
210         u = ast_module_user_add(chan);
211
212         if (!stack_store) {
213                 if (option_debug)
214                         ast_log(LOG_DEBUG, "Channel %s has no datastore, so we're allocating one.\n", chan->name);
215                 stack_store = ast_channel_datastore_alloc(&stack_info, NULL);
216                 if (!stack_store) {
217                         ast_log(LOG_ERROR, "Unable to allocate new datastore.  Gosub will fail.\n");
218                         ast_module_user_remove(u);
219                         return -1;
220                 }
221
222                 oldlist = ast_calloc(1, sizeof(*oldlist));
223                 if (!oldlist) {
224                         ast_log(LOG_ERROR, "Unable to allocate datastore list head.  Gosub will fail.\n");
225                         ast_channel_datastore_free(stack_store);
226                         ast_module_user_remove(u);
227                         return -1;
228                 }
229
230                 stack_store->data = oldlist;
231                 AST_LIST_HEAD_INIT(oldlist);
232                 ast_channel_datastore_add(chan, stack_store);
233         }
234
235         /* Separate the arguments from the label */
236         /* NOTE:  you cannot use ast_app_separate_args for this, because '(' cannot be used as a delimiter. */
237         label = strsep(&tmp, "(");
238         if (tmp) {
239                 endparen = strrchr(tmp, ')');
240                 if (endparen)
241                         *endparen = '\0';
242                 else
243                         ast_log(LOG_WARNING, "Ouch.  No closing paren: '%s'?\n", (char *)data);
244                 AST_STANDARD_APP_ARGS(args2, tmp);
245         } else
246                 args2.argc = 0;
247
248         /* Create the return address, but don't save it until we know that the Gosub destination exists */
249         newframe = gosub_allocate_frame(chan->context, chan->exten, chan->priority + 1, args2.argc);
250
251         if (ast_parseable_goto(chan, label)) {
252                 ast_log(LOG_ERROR, "Gosub address is invalid: '%s'\n", (char *)data);
253                 ast_free(newframe);
254                 ast_module_user_remove(u);
255                 return -1;
256         }
257
258         /* Now that we know for certain that we're going to a new location, set our arguments */
259         for (i = 0; i < args2.argc; i++) {
260                 snprintf(argname, sizeof(argname), "ARG%d", i + 1);
261                 pbx_builtin_pushvar_helper(chan, argname, args2.argval[i]);
262                 if (option_debug)
263                         ast_log(LOG_DEBUG, "Setting '%s' to '%s'\n", argname, args2.argval[i]);
264         }
265
266         /* And finally, save our return address */
267         oldlist = stack_store->data;
268         AST_LIST_LOCK(oldlist);
269         AST_LIST_INSERT_HEAD(oldlist, newframe, entries);
270         AST_LIST_UNLOCK(oldlist);
271
272         ast_module_user_remove(u);
273
274         return 0;
275 }
276
277 static int gosubif_exec(struct ast_channel *chan, void *data)
278 {
279         struct ast_module_user *u;
280         char *args;
281         int res=0;
282         AST_DECLARE_APP_ARGS(cond,
283                 AST_APP_ARG(ition);
284                 AST_APP_ARG(labels);
285         );
286         AST_DECLARE_APP_ARGS(label,
287                 AST_APP_ARG(iftrue);
288                 AST_APP_ARG(iffalse);
289         );
290
291         if (ast_strlen_zero(data)) {
292                 ast_log(LOG_WARNING, "GosubIf requires an argument: GosubIf(cond?label1(args):label2(args)\n");
293                 return 0;
294         }
295
296         u = ast_module_user_add(chan);
297
298         args = ast_strdupa(data);
299         AST_NONSTANDARD_APP_ARGS(cond, args, '?');
300         if (cond.argc != 2) {
301                 ast_log(LOG_WARNING, "GosubIf requires an argument: GosubIf(cond?label1(args):label2(args)\n");
302                 ast_module_user_remove(u);
303                 return 0;
304         }
305
306         AST_NONSTANDARD_APP_ARGS(label, cond.labels, ':');
307
308         if (pbx_checkcondition(cond.ition)) {
309                 if (!ast_strlen_zero(label.iftrue))
310                         res = gosub_exec(chan, label.iftrue);
311         } else if (!ast_strlen_zero(label.iffalse)) {
312                 res = gosub_exec(chan, label.iffalse);
313         }
314
315         ast_module_user_remove(u);
316         return res;
317 }
318
319 static int unload_module(void)
320 {
321         ast_unregister_application(app_return);
322         ast_unregister_application(app_pop);
323         ast_unregister_application(app_gosubif);
324         ast_unregister_application(app_gosub);
325
326         ast_module_user_hangup_all();
327
328         return 0;
329 }
330
331 static int load_module(void)
332 {
333         ast_register_application(app_pop, pop_exec, pop_synopsis, pop_descrip);
334         ast_register_application(app_return, return_exec, return_synopsis, return_descrip);
335         ast_register_application(app_gosubif, gosubif_exec, gosubif_synopsis, gosubif_descrip);
336         ast_register_application(app_gosub, gosub_exec, gosub_synopsis, gosub_descrip);
337
338         return 0;
339 }
340
341 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dialplan subroutines (Gosub, Return, etc)");