Add commonly used include headers
[asterisk/asterisk.git] / apps / app_macro.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Macro Implementation
5  * 
6  * Copyright (C) 2003, Digium
7  *
8  * Mark Spencer <markster@digium.com>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <sys/types.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/channel.h>
18 #include <asterisk/pbx.h>
19 #include <asterisk/module.h>
20 #include <asterisk/options.h>
21 #include <stdlib.h>
22 #include <unistd.h>
23 #include <string.h>
24 #include <stdlib.h>
25
26 #include <pthread.h>
27
28 #define MAX_ARGS 80
29
30 static char *tdesc = "Extension Macros";
31
32 static char *descrip =
33 "  Macro(macroname|arg1|arg2...): Executes a macro using the context\n"
34 "'macro-<macroname>', jumping to the 's' extension of that context and\n"
35 "executing each step, then returning when the steps end.  The calling\n"
36 "extension, context, and priority are stored in ${MACRO_EXTEN}, \n"
37 "${MACRO_CONTEXT} and ${MACRO_PRIORITY} respectively.  Arguments become\n"
38 "${ARG1}, ${ARG2}, etc in the macro context.  Macro returns -1 if\n"
39 "any step in the macro returns -1, and 0 otherwise.  If you Goto out\n"
40 "of the Macro context, the Macro will terminate and control will be return\n"
41 "at the location of the Goto.  Otherwise if ${MACRO_OFFSET} is set at\n"
42 "termination, Macro will attempt to continue at priority\n"
43 "MACRO_OFFSET + N + 1 if such a step exists, and N + 1 otherwise.\n";
44
45 static char *app = "Macro";
46
47 static char *synopsis = "Macro Implementation";
48
49 STANDARD_LOCAL_USER;
50
51 LOCAL_USER_DECL;
52
53 static int macro_exec(struct ast_channel *chan, void *data)
54 {
55   char tmp[256] = "";
56   char *cur, *rest;
57   char *macro;
58   char fullmacro[80];
59   char varname[80];
60   char *oldargs[MAX_ARGS + 1] = { NULL, };
61   int argc, x;
62   int res;
63   char oldexten[256]="";
64   int oldpriority;
65   char pc[80];
66   char oldcontext[256] = "";
67   char *offsets;
68   int offset;
69   int setmacrocontext=0;
70   
71   char *save_macro_exten;
72   char *save_macro_context;
73   char *save_macro_priority;
74   char *save_macro_offset;
75   
76   if (!data || !strlen(data)) {
77     ast_log(LOG_WARNING, "Invalid Macro incantation\n");
78     return 0;
79   }
80   strncpy(tmp, data, sizeof(tmp) - 1);
81   rest = tmp;
82   macro = strsep(&rest, "|");
83   if (!macro || !strlen(macro)) {
84         ast_log(LOG_WARNING, "Invalid macro name specified\n");
85         return 0;
86   }
87   snprintf(fullmacro, sizeof(fullmacro), "macro-%s", macro);
88   if (!ast_exists_extension(chan, fullmacro, "s", 1, chan->callerid)) {
89         if (!ast_context_find(fullmacro)) 
90                 ast_log(LOG_WARNING, "No such context '%s' for macro '%s'\n", fullmacro, macro);
91         else
92                 ast_log(LOG_WARNING, "Context '%s' for macro '%s' lacks 's' extension, priority 1\n", fullmacro, macro);
93         return 0;
94   }
95   /* Save old info */
96   oldpriority = chan->priority;
97   strncpy(oldexten, chan->exten, sizeof(oldexten) - 1);
98   strncpy(oldcontext, chan->context, sizeof(oldcontext) - 1);
99   if (!strlen(chan->macrocontext)) {
100         strncpy(chan->macrocontext, chan->context, sizeof(chan->macrocontext) - 1);
101         setmacrocontext=1;
102   }
103   argc = 1;
104   /* Save old macro variables */
105   save_macro_exten = pbx_builtin_getvar_helper(chan, "MACRO_EXTEN");
106   if (save_macro_exten) save_macro_exten = strdup(save_macro_exten);
107   pbx_builtin_setvar_helper(chan, "MACRO_EXTEN", oldexten);
108
109   save_macro_context = pbx_builtin_getvar_helper(chan, "MACRO_CONTEXT");
110   if (save_macro_context) save_macro_context = strdup(save_macro_context);
111   pbx_builtin_setvar_helper(chan, "MACRO_CONTEXT", oldcontext);
112
113   save_macro_priority = pbx_builtin_getvar_helper(chan, "MACRO_PRIORITY");
114   if (save_macro_priority) save_macro_priority = strdup(save_macro_priority);
115   snprintf(pc, sizeof(pc), "%d", oldpriority);
116   pbx_builtin_setvar_helper(chan, "MACRO_PRIORITY", pc);
117   
118   save_macro_offset = pbx_builtin_getvar_helper(chan, "MACRO_OFFSET");
119   if (save_macro_offset) save_macro_offset = strdup(save_macro_offset);
120   pbx_builtin_setvar_helper(chan, "MACRO_OFFSET", NULL);
121
122   /* Setup environment for new run */
123   strcpy(chan->exten, "s");
124   strncpy(chan->context, fullmacro, sizeof(chan->context));
125   chan->priority = 1;
126
127   while((cur = strsep(&rest, "|")) && (argc < MAX_ARGS)) {
128         /* Save copy of old arguments if we're overwriting some, otherwise
129            let them pass through to the other macro */
130         oldargs[argc] = pbx_builtin_getvar_helper(chan, varname);
131         if (oldargs[argc])
132                 oldargs[argc] = strdup(oldargs[argc]);
133         snprintf(varname, sizeof(varname), "ARG%d", argc);
134         pbx_builtin_setvar_helper(chan, varname, cur);
135         argc++;
136   }
137   while(ast_exists_extension(chan, chan->context, chan->exten, chan->priority, chan->callerid)) {
138         if ((res = ast_spawn_extension(chan, chan->context, chan->exten, chan->priority, chan->callerid))) {
139                 /* Something bad happened, or a hangup has been requested. */
140                 if (((res >= '0') && (res <= '9')) || ((res >= 'A') && (res <= 'F'))) {
141                         /* Just return result as to the previous application as if it had been dialed */
142                         ast_log(LOG_DEBUG, "Oooh, got something to jump out with ('%c')!\n", res);
143                         break;
144                 }
145                 switch(res) {
146                 case AST_PBX_KEEPALIVE:
147                         if (option_debug)
148                                 ast_log(LOG_DEBUG, "Spawn extension (%s,%s,%d) exited KEEPALIVE in macro %s on '%s'\n", chan->context, chan->exten, chan->priority, macro, chan->name);
149                         else if (option_verbose > 1)
150                                 ast_verbose( VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited KEEPALIVE in macro '%s' on '%s'\n", chan->context, chan->exten, chan->priority, macro, chan->name);
151                         goto out;
152                         break;
153                 default:
154                         if (option_debug)
155                                 ast_log(LOG_DEBUG, "Spawn extension (%s,%s,%d) exited non-zero on '%s' in macro '%s'\n", chan->context, chan->exten, chan->priority, chan->name, macro);
156                         else if (option_verbose > 1)
157                                 ast_verbose( VERBOSE_PREFIX_2 "Spawn extension (%s, %s, %d) exited non-zero on '%s' in macro '%s'\n", chan->context, chan->exten, chan->priority, chan->name, macro);
158                         goto out;
159                 }
160         }
161         if (strcasecmp(chan->context, fullmacro)) {
162                 if (option_verbose > 1)
163                         ast_verbose(VERBOSE_PREFIX_2 "Channel '%s' jumping out of macro '%s'\n", chan->name, macro);
164                 break;
165         }
166         if (chan->_softhangup) {
167                 ast_log(LOG_DEBUG, "Extension %s, priority %d returned normally even though call was hung up\n",
168                         chan->exten, chan->priority);
169                 goto out;
170         }
171         chan->priority++;
172   }
173 out:
174   for (x=1;x<argc;x++) {
175         /* Restore old arguments and delete ours */
176         snprintf(varname, sizeof(varname), "ARG%d", x);
177         if (oldargs[x]) {
178                 pbx_builtin_setvar_helper(chan, varname, oldargs[x]);
179                 free(oldargs[x]);
180         } else {
181                 pbx_builtin_setvar_helper(chan, varname, NULL);
182         }
183   }
184
185   /* Restore macro variables */
186   pbx_builtin_setvar_helper(chan, "MACRO_EXTEN", save_macro_exten);
187   if (save_macro_exten) free(save_macro_exten);
188   pbx_builtin_setvar_helper(chan, "MACRO_CONTEXT", save_macro_context);
189   if (save_macro_context) free(save_macro_context);
190   pbx_builtin_setvar_helper(chan, "MACRO_PRIORITY", save_macro_priority);
191   if (save_macro_priority) free(save_macro_priority);
192   if (setmacrocontext)
193         strcpy(chan->macrocontext, "");
194
195   if (!strcasecmp(chan->context, fullmacro)) {
196         /* If we're leaving the macro normally, restore original information */
197         chan->priority = oldpriority;
198         strncpy(chan->context, oldcontext, sizeof(chan->context) - 1);
199         if (!chan->_softhangup) {
200                 /* Copy the extension, so long as we're not in softhangup, where we could be given an asyncgoto */
201                 strncpy(chan->exten, oldexten, sizeof(chan->exten) - 1);
202                 if ((offsets = pbx_builtin_getvar_helper(chan, "MACRO_OFFSET"))) {
203                         /* Handle macro offset if it's set by checking the availability of step n + offset + 1, otherwise continue
204                            normally if there is any problem */
205                         if (sscanf(offsets, "%d", &offset) == 1) {
206                                 if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + offset + 1, chan->callerid)) {
207                                         chan->priority += offset;
208                                 }
209                         }
210                 }
211         }
212   }
213
214   pbx_builtin_setvar_helper(chan, "MACRO_OFFSET", save_macro_offset);
215   if (save_macro_offset) free(save_macro_offset);
216   return res;
217 }
218
219 int unload_module(void)
220 {
221         STANDARD_HANGUP_LOCALUSERS;
222         return ast_unregister_application(app);
223 }
224
225 int load_module(void)
226 {
227         return ast_register_application(app, macro_exec, synopsis, descrip);
228 }
229
230 char *description(void)
231 {
232         return tdesc;
233 }
234
235 int usecount(void)
236 {
237         int res;
238         STANDARD_USECOUNT(res);
239         return res;
240 }
241
242 char *key()
243 {
244         return ASTERISK_GPL_KEY;
245 }