revert my pass through the tree to remove checks of the result of ast_strdupa
[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_v002@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_v002@the-tilghman.com>
24  * 
25  * \ingroup applications
26  */
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <string.h>
32
33 #include "asterisk/options.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/channel.h"
36 #include "asterisk/chanvars.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/config.h"
40
41 #define STACKVAR        "~GOSUB~STACK~"
42
43 static const char *tdesc = "Stack Routines";
44
45 static const char *app_gosub = "Gosub";
46 static const char *app_gosubif = "GosubIf";
47 static const char *app_return = "Return";
48 static const char *app_pop = "StackPop";
49
50 static const char *gosub_synopsis = "Jump to label, saving return address";
51 static const char *gosubif_synopsis = "Jump to label, saving return address";
52 static const char *return_synopsis = "Return from gosub routine";
53 static const char *pop_synopsis = "Remove one address from gosub stack";
54
55 static const char *gosub_descrip =
56 "Gosub([[context|]exten|]priority)\n"
57 "  Jumps to the label specified, saving the return address.\n";
58 static const char *gosubif_descrip =
59 "GosubIf(condition?labeliftrue[:labeliffalse])\n"
60 "  If the condition is true, then jump to labeliftrue.  If false, jumps to\n"
61 "labeliffalse, if specified.  In either case, a jump saves the return point\n"
62 "in the dialplan, to be returned to with a Return.\n";
63 static const char *return_descrip =
64 "Return()\n"
65 "  Jumps to the last label on the stack, removing it.\n";
66 static const char *pop_descrip =
67 "StackPop()\n"
68 "  Removes last label on the stack, discarding it.\n";
69
70 STANDARD_LOCAL_USER;
71
72 LOCAL_USER_DECL;
73
74 static int pop_exec(struct ast_channel *chan, void *data)
75 {
76         pbx_builtin_setvar_helper(chan, STACKVAR, NULL);
77
78         return 0;
79 }
80
81 static int return_exec(struct ast_channel *chan, void *data)
82 {
83         const char *label = pbx_builtin_getvar_helper(chan, STACKVAR);
84
85         if (ast_strlen_zero(label)) {
86                 ast_log(LOG_ERROR, "Return without Gosub: stack is empty\n");
87                 return -1;
88         } else if (ast_parseable_goto(chan, label)) {
89                 ast_log(LOG_WARNING, "No next statement after Gosub?\n");
90                 return -1;
91         }
92
93         pbx_builtin_setvar_helper(chan, STACKVAR, NULL);
94         return 0;
95 }
96
97 static int gosub_exec(struct ast_channel *chan, void *data)
98 {
99         char newlabel[AST_MAX_EXTENSION * 2 + 3 + 11];
100         struct localuser *u;
101
102         if (ast_strlen_zero(data)) {
103                 ast_log(LOG_ERROR, "%s requires an argument: %s([[context|]exten|]priority)\n", app_gosub, app_gosub);
104                 return -1;
105         }
106
107         LOCAL_USER_ADD(u);
108         snprintf(newlabel, sizeof(newlabel), "%s|%s|%d", chan->context, chan->exten, chan->priority + 1);
109
110         if (ast_parseable_goto(chan, data)) {
111                 LOCAL_USER_REMOVE(u);
112                 return -1;
113         }
114
115         pbx_builtin_pushvar_helper(chan, STACKVAR, newlabel);
116         LOCAL_USER_REMOVE(u);
117
118         return 0;
119 }
120
121 static int gosubif_exec(struct ast_channel *chan, void *data)
122 {
123         struct localuser *u;
124         char *condition="", *label1, *label2, *args;
125         int res=0;
126
127         if (ast_strlen_zero(data)) {
128                 ast_log(LOG_WARNING, "GosubIf requires an argument\n");
129                 return 0;
130         }
131
132         args = ast_strdupa((char *)data);
133         if (!args) {
134                 ast_log(LOG_ERROR, "Out of memory\n");
135                 return -1;
136         }
137
138         LOCAL_USER_ADD(u);
139
140         condition = strsep(&args, "?");
141         label1 = strsep(&args, ":");
142         label2 = args;
143
144         if (ast_true(condition)) {
145                 if (label1) {
146                         res = gosub_exec(chan, label1);
147                 }
148         } else if (label2) {
149                 res = gosub_exec(chan, label2);
150         }
151
152         LOCAL_USER_REMOVE(u);
153         return res;
154 }
155
156 int unload_module(void)
157 {
158         ast_unregister_application(app_return);
159         ast_unregister_application(app_pop);
160         ast_unregister_application(app_gosubif);
161         ast_unregister_application(app_gosub);
162
163         STANDARD_HANGUP_LOCALUSERS;
164
165         return 0;
166 }
167
168 int load_module(void)
169 {
170         ast_register_application(app_pop, pop_exec, pop_synopsis, pop_descrip);
171         ast_register_application(app_return, return_exec, return_synopsis, return_descrip);
172         ast_register_application(app_gosubif, gosubif_exec, gosubif_synopsis, gosubif_descrip);
173         ast_register_application(app_gosub, gosub_exec, gosub_synopsis, gosub_descrip);
174
175         return 0;
176 }
177
178 char *description(void)
179 {
180         return (char *) tdesc;
181 }
182
183 int usecount(void)
184 {
185         int res;
186
187         STANDARD_USECOUNT(res);
188
189         return res;
190 }
191
192 char *key()
193 {
194         return ASTERISK_GPL_KEY;
195 }