Get rid of any remaining ast_verbose calls in the code in favor of
[asterisk/asterisk.git] / res / res_agi.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
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 AGI - the Asterisk Gateway Interface
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <math.h>
31 #include <signal.h>
32 #include <sys/time.h>
33 #include <sys/wait.h>
34 #include <sys/stat.h>
35 #include <pthread.h>
36
37 #include "asterisk/paths.h"     /* use many ast_config_AST_*_DIR */
38 #include "asterisk/network.h"
39 #include "asterisk/file.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/astdb.h"
44 #include "asterisk/callerid.h"
45 #include "asterisk/cli.h"
46 #include "asterisk/image.h"
47 #include "asterisk/say.h"
48 #include "asterisk/app.h"
49 #include "asterisk/dsp.h"
50 #include "asterisk/musiconhold.h"
51 #include "asterisk/utils.h"
52 #include "asterisk/lock.h"
53 #include "asterisk/strings.h"
54 #include "asterisk/agi.h"
55 #include "asterisk/manager.h"
56 #include "asterisk/version.h"
57 #include "asterisk/speech.h"
58 #include "asterisk/manager.h"
59
60 #define MAX_ARGS 128
61 #define AGI_NANDFS_RETRY 3
62 #define AGI_BUF_LEN 2048
63
64 static char *app = "AGI";
65
66 static char *eapp = "EAGI";
67
68 static char *deadapp = "DeadAGI";
69
70 static char *synopsis = "Executes an AGI compliant application";
71 static char *esynopsis = "Executes an EAGI compliant application";
72 static char *deadsynopsis = "Executes AGI on a hungup channel";
73
74 static char *descrip =
75 "  [E|Dead]AGI(command,args): Executes an Asterisk Gateway Interface compliant\n"
76 "program on a channel. AGI allows Asterisk to launch external programs\n"
77 "written in any language to control a telephony channel, play audio,\n"
78 "read DTMF digits, etc. by communicating with the AGI protocol on stdin\n"
79 "and stdout.\n"
80 "  This channel will stop dialplan execution on hangup inside of this\n"
81 "application, except when using DeadAGI.  Otherwise, dialplan execution\n"
82 "will continue normally.\n"
83 "  A locally executed AGI script will receive SIGHUP on hangup from the channel\n"
84 "except when using DeadAGI. This can be disabled by setting the AGISIGHUP channel\n"
85 "variable to \"no\" before executing the AGI application.\n"
86 "  Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n"
87 "on file descriptor 3\n\n"
88 "  Use the CLI command 'agi show' to list available agi commands\n"
89 "  This application sets the following channel variable upon completion:\n"
90 "     AGISTATUS      The status of the attempt to the run the AGI script\n"
91 "                    text string, one of SUCCESS | FAILURE | NOTFOUND | HANGUP\n";
92
93 static int agidebug = 0;
94
95 #define TONE_BLOCK_SIZE 200
96
97 /* Max time to connect to an AGI remote host */
98 #define MAX_AGI_CONNECT 2000
99
100 #define AGI_PORT 4573
101
102 enum agi_result {
103         AGI_RESULT_SUCCESS,
104         AGI_RESULT_SUCCESS_FAST,
105         AGI_RESULT_SUCCESS_ASYNC,
106         AGI_RESULT_FAILURE,
107         AGI_RESULT_NOTFOUND,
108         AGI_RESULT_HANGUP,
109 };
110
111 static agi_command *find_command(char *cmds[], int exact);
112
113 AST_THREADSTORAGE(agi_buf);
114 #define AGI_BUF_INITSIZE 256
115
116 int ast_agi_fdprintf(struct ast_channel *chan, int fd, char *fmt, ...)
117 {
118         int res = 0;
119         va_list ap;
120         struct ast_str *buf;
121
122         if (!(buf = ast_str_thread_get(&agi_buf, AGI_BUF_INITSIZE)))
123                 return -1;
124
125         va_start(ap, fmt);
126         res = ast_str_set_va(&buf, 0, fmt, ap);
127         va_end(ap);
128
129         if (res == -1) {
130                 ast_log(LOG_ERROR, "Out of memory\n");
131                 return -1;
132         }
133
134         if (agidebug) {
135                 if (chan) {
136                         ast_verbose("<%s>AGI Tx >> %s", chan->name, buf->str);
137                 } else {
138                         ast_verbose("AGI Tx >> %s", buf->str);
139                 }
140         }
141
142         return ast_carefulwrite(fd, buf->str, buf->used, 100);
143 }
144
145 /* linked list of AGI commands ready to be executed by Async AGI */
146 struct agi_cmd {
147         char *cmd_buffer;
148         char *cmd_id;
149         AST_LIST_ENTRY(agi_cmd) entry;
150 };
151
152 static void free_agi_cmd(struct agi_cmd *cmd)
153 {
154         ast_free(cmd->cmd_buffer);
155         ast_free(cmd->cmd_id);
156         ast_free(cmd);
157 }
158
159 /* AGI datastore destructor */
160 static void agi_destroy_commands_cb(void *data)
161 {
162         struct agi_cmd *cmd;
163         AST_LIST_HEAD(, agi_cmd) *chan_cmds = data;
164         AST_LIST_LOCK(chan_cmds);
165         while ( (cmd = AST_LIST_REMOVE_HEAD(chan_cmds, entry)) ) { 
166                 free_agi_cmd(cmd);
167         } 
168         AST_LIST_UNLOCK(chan_cmds);
169         AST_LIST_HEAD_DESTROY(chan_cmds);
170         ast_free(chan_cmds);
171 }
172
173 /* channel datastore to keep the queue of AGI commands in the channel */
174 static const struct ast_datastore_info agi_commands_datastore_info = {
175         .type = "AsyncAGI",
176         .destroy = agi_destroy_commands_cb
177 };
178
179 static const char mandescr_asyncagi[] =
180 "Description: Add an AGI command to the execute queue of the channel in Async AGI\n"
181 "Variables:\n"
182 "  *Channel: Channel that is currently in Async AGI\n"
183 "  *Command: Application to execute\n"
184 "   CommandID: comand id. This will be sent back in CommandID header of AsyncAGI exec event notification\n"
185 "\n";
186
187 static struct agi_cmd *get_agi_cmd(struct ast_channel *chan)
188 {
189         struct ast_datastore *store;
190         struct agi_cmd *cmd;
191         AST_LIST_HEAD(, agi_cmd) *agi_commands;
192
193         ast_channel_lock(chan);
194         store = ast_channel_datastore_find(chan, &agi_commands_datastore_info, NULL);
195         ast_channel_unlock(chan);
196         if (!store) {
197                 ast_log(LOG_ERROR, "Hu? datastore disappeared at Async AGI on Channel %s!\n", chan->name);
198                 return NULL;
199         }
200         agi_commands = store->data;
201         AST_LIST_LOCK(agi_commands);
202         cmd = AST_LIST_REMOVE_HEAD(agi_commands, entry);
203         AST_LIST_UNLOCK(agi_commands);
204         return cmd;
205 }
206
207 /* channel is locked when calling this one either from the CLI or manager thread */
208 static int add_agi_cmd(struct ast_channel *chan, const char *cmd_buff, const char *cmd_id)
209 {
210         struct ast_datastore *store;
211         struct agi_cmd *cmd;
212         AST_LIST_HEAD(, agi_cmd) *agi_commands;
213
214         store = ast_channel_datastore_find(chan, &agi_commands_datastore_info, NULL);
215         if (!store) {
216                 ast_log(LOG_WARNING, "Channel %s is not at Async AGI.\n", chan->name);
217                 return -1;
218         }
219         agi_commands = store->data;
220         cmd = ast_calloc(1, sizeof(*cmd));
221         if (!cmd) {
222                 return -1;
223         }
224         cmd->cmd_buffer = ast_strdup(cmd_buff);
225         if (!cmd->cmd_buffer) {
226                 ast_free(cmd);
227                 return -1;
228         }
229         cmd->cmd_id = ast_strdup(cmd_id);
230         if (!cmd->cmd_id) {
231                 ast_free(cmd->cmd_buffer);
232                 ast_free(cmd);
233                 return -1;
234         }
235         AST_LIST_LOCK(agi_commands);
236         AST_LIST_INSERT_TAIL(agi_commands, cmd, entry);
237         AST_LIST_UNLOCK(agi_commands);
238         return 0;
239 }
240
241 static int add_to_agi(struct ast_channel *chan)
242 {
243         struct ast_datastore *datastore;
244         AST_LIST_HEAD(, agi_cmd) *agi_cmds_list;
245
246         /* check if already on AGI */
247         ast_channel_lock(chan);
248         datastore = ast_channel_datastore_find(chan, &agi_commands_datastore_info, NULL);
249         ast_channel_unlock(chan);
250         if (datastore) {
251                 /* we already have an AGI datastore, let's just 
252                    return success */
253                 return 0;
254         }
255
256         /* the channel has never been on Async AGI,
257            let's allocate it's datastore */
258         datastore = ast_channel_datastore_alloc(&agi_commands_datastore_info, "AGI");
259         if (!datastore) {
260                 return -1;
261         }
262         agi_cmds_list = ast_calloc(1, sizeof(*agi_cmds_list));
263         if (!agi_cmds_list) {
264                 ast_log(LOG_ERROR, "Unable to allocate Async AGI commands list.\n");
265                 ast_channel_datastore_free(datastore);
266                 return -1;
267         }
268         datastore->data = agi_cmds_list;
269         AST_LIST_HEAD_INIT(agi_cmds_list);
270         ast_channel_lock(chan);
271         ast_channel_datastore_add(chan, datastore);
272         ast_channel_unlock(chan);
273         return 0;
274 }
275
276 /*!
277  * \brief CLI command to add applications to execute in Async AGI 
278  * \param e
279  * \param cmd 
280  * \param a
281  *
282  * \retval CLI_SUCCESS on success
283  * \retval NULL when init or tab completion is used
284 */
285 static char *handle_cli_agi_add_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
286 {
287         struct ast_channel *chan;
288         switch (cmd) {
289         case CLI_INIT:
290                 e->command = "agi exec";
291                 e->usage = "Usage: agi exec <channel name> <app and arguments> [id]\n"
292                            "       Add AGI command to the execute queue of the specified channel in Async AGI\n";
293                 return NULL;
294         case CLI_GENERATE:
295                 if (a->pos == 2)
296                         return ast_complete_channels(a->line, a->word, a->pos, a->n, 2);
297                 return NULL;
298         }
299
300         if (a->argc < 4)
301                 return CLI_SHOWUSAGE;
302         chan = ast_get_channel_by_name_locked(a->argv[2]);
303         if (!chan) {
304                 ast_log(LOG_WARNING, "Channel %s does not exists or cannot lock it\n", a->argv[2]);
305                 return CLI_FAILURE;
306         }
307         if (add_agi_cmd(chan, a->argv[3], (a->argc > 4 ? a->argv[4] : ""))) {
308                 ast_log(LOG_WARNING, "failed to add AGI command to queue of channel %s\n", chan->name);
309                 ast_channel_unlock(chan);
310                 return CLI_FAILURE;
311         }
312         ast_log(LOG_DEBUG, "Added AGI command to channel %s queue\n", chan->name);
313         ast_channel_unlock(chan);
314         return CLI_SUCCESS;
315 }
316
317 /*!
318  * \brief Add a new command to execute by the Async AGI application
319  * \param s
320  * \param m
321  *
322  * It will append the application to the specified channel's queue
323  * if the channel is not inside Async AGI application it will return an error
324  * \retval 0 on success or incorrect use
325  * \retval 1 on failure to add the command ( most likely because the channel 
326  * is not in Async AGI loop )
327 */
328 static int action_add_agi_cmd(struct mansession *s, const struct message *m)
329 {
330         const char *channel = astman_get_header(m, "Channel");
331         const char *cmdbuff = astman_get_header(m, "Command");
332         const char *cmdid   = astman_get_header(m, "CommandID");
333         struct ast_channel *chan;
334         char buf[256];
335         if (ast_strlen_zero(channel) || ast_strlen_zero(cmdbuff)) {
336                 astman_send_error(s, m, "Both, Channel and Command are *required*");
337                 return 0;
338         }
339         chan = ast_get_channel_by_name_locked(channel);
340         if (!chan) {
341                 snprintf(buf, sizeof(buf), "Channel %s does not exists or cannot get its lock", channel);
342                 astman_send_error(s, m, buf);
343                 return 1;
344         }
345         if (add_agi_cmd(chan, cmdbuff, cmdid)) {
346                 snprintf(buf, sizeof(buf), "Failed to add AGI command to channel %s queue", chan->name);
347                 astman_send_error(s, m, buf);
348                 ast_channel_unlock(chan);
349                 return 1;
350         }
351         astman_send_ack(s, m, "Added AGI command to queue");
352         ast_channel_unlock(chan);
353         return 0;
354 }
355
356 static int agi_handle_command(struct ast_channel *chan, AGI *agi, char *buf, int dead);
357 static void setup_env(struct ast_channel *chan, char *request, int fd, int enhanced, int argc, char *argv[]);
358 static enum agi_result launch_asyncagi(struct ast_channel *chan, char *argv[], int *efd)
359 {
360 /* This buffer sizes might cause truncation if the AGI command writes more data
361    than AGI_BUF_SIZE as result. But let's be serious, is there an AGI command 
362    that writes a response larger than 1024 bytes?, I don't think so, most of 
363    them are just result=blah stuff. However probably if GET VARIABLE is called 
364    and the variable has large amount of data, that could be a problem. We could 
365    make this buffers dynamic, but let's leave that as a second step.
366
367    AMI_BUF_SIZE is twice AGI_BUF_SIZE just for the sake of choosing a safe 
368    number. Some characters of AGI buf will be url encoded to be sent to manager 
369    clients.  An URL encoded character will take 3 bytes, but again, to cause 
370    truncation more than about 70% of the AGI buffer should be URL encoded for 
371    that to happen.  Not likely at all. 
372
373    On the other hand. I wonder if read() could eventually return less data than 
374    the amount already available in the pipe? If so, how to deal with that?  
375    So far, my tests on Linux have not had any problems.
376  */
377 #define AGI_BUF_SIZE 1024
378 #define AMI_BUF_SIZE 2048
379         struct ast_frame *f;
380         struct agi_cmd *cmd;
381         int res, fds[2];
382         int timeout = 100; 
383         char agi_buffer[AGI_BUF_SIZE + 1];
384         char ami_buffer[AMI_BUF_SIZE];
385         enum agi_result returnstatus = AGI_RESULT_SUCCESS_ASYNC;
386         AGI async_agi;
387
388         if (efd) {
389                 ast_log(LOG_WARNING, "Async AGI does not support Enhanced AGI yet\n");
390                 return AGI_RESULT_FAILURE;
391         }
392
393         /* add AsyncAGI datastore to the channel */
394         if (add_to_agi(chan)) {
395                 ast_log(LOG_ERROR, "failed to start Async AGI on channel %s\n", chan->name);
396                 return AGI_RESULT_FAILURE;
397         }       
398
399         /* this pipe allows us to create a "fake" AGI struct to use 
400            the AGI commands */
401         res = pipe(fds);
402         if (res) {
403                 ast_log(LOG_ERROR, "failed to create Async AGI pipe\n");
404                 /* intentionally do not remove datastore, added with 
405                    add_to_agi(), from channel. It will be removed when 
406                    the channel is hung up anyways */
407                 return AGI_RESULT_FAILURE;
408         }
409         /* handlers will get the pipe write fd and we read the AGI responses 
410            from the pipe read fd */
411         async_agi.fd = fds[1]; 
412         async_agi.ctrl = fds[1];
413         async_agi.audio = -1; /* no audio support */
414         async_agi.fast = 0;
415
416         /* notify possible manager users of a new channel ready to 
417            receive commands */  
418         setup_env(chan, "async", fds[1], 0, 0, NULL);
419         /* read the environment */
420         res = read(fds[0], agi_buffer, AGI_BUF_SIZE);
421         if (!res) {
422                 ast_log(LOG_ERROR, "failed to read from Async AGI pipe on channel %s\n", chan->name);
423                 returnstatus = AGI_RESULT_FAILURE;
424                 goto quit;
425         }
426         agi_buffer[res] = '\0';
427         /* encode it and send it thru the manager so whoever is going to take 
428            care of AGI commands on this channel can decide which AGI commands 
429            to execute based on the setup info */
430         ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, 1);
431         manager_event(EVENT_FLAG_CALL, "AsyncAGI", "SubEvent: Start\r\nChannel: %s\r\nEnv: %s\r\n", chan->name, ami_buffer); 
432         while (1) {
433                 /* bail out if we need to hangup */
434                 if (ast_check_hangup(chan)) {
435                         ast_log(LOG_DEBUG, "ast_check_hangup returned true on chan %s\n", chan->name);
436                         break;
437                 }
438                 /* retrieve a command 
439                    (commands are added via the manager or the cli threads) */
440                 cmd = get_agi_cmd(chan);
441                 if (cmd) {
442                         /* OK, we have a command, let's call the 
443                            command handler. */
444                         res = agi_handle_command(chan, &async_agi, cmd->cmd_buffer, 0);
445                         if ((res < 0) || (res == AST_PBX_KEEPALIVE)) {
446                                 free_agi_cmd(cmd);
447                                 break;
448                         }
449                         /* the command handler must have written to our fake 
450                            AGI struct fd (the pipe), let's read the response */
451                         res = read(fds[0], agi_buffer, AGI_BUF_SIZE);
452                         if (!res) {
453                                 returnstatus = AGI_RESULT_FAILURE;
454                                 ast_log(LOG_ERROR, "failed to read from AsyncAGI pipe on channel %s\n", chan->name);
455                                 free_agi_cmd(cmd);
456                                 break;
457                         }
458                         /* we have a response, let's send the response thru the
459                            manager. Include the CommandID if it was specified 
460                            when the command was added */
461                         agi_buffer[res] = '\0';
462                         ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, 1);
463                         if (ast_strlen_zero(cmd->cmd_id))
464                                 manager_event(EVENT_FLAG_CALL, "AsyncAGI", "SubEvent: Exec\r\nChannel: %s\r\nResult: %s\r\n", chan->name, ami_buffer);
465                         else
466                                 manager_event(EVENT_FLAG_CALL, "AsyncAGI", "SubEvent: Exec\r\nChannel: %s\r\nCommandID: %s\r\nResult: %s\r\n", chan->name, cmd->cmd_id, ami_buffer);
467                         free_agi_cmd(cmd);
468                 } else {
469                         /* no command so far, wait a bit for a frame to read */
470                         res = ast_waitfor(chan, timeout);
471                         if (res < 0) {
472                                 ast_log(LOG_DEBUG, "ast_waitfor returned <= 0 on chan %s\n", chan->name);
473                                 break;
474                         }
475                         if (res == 0)
476                                 continue;
477                         f = ast_read(chan);
478                         if (!f) {
479                                 ast_log(LOG_DEBUG, "No frame read on channel %s, going out ...\n", chan->name);
480                                 returnstatus = AGI_RESULT_HANGUP;
481                                 break;
482                         }
483                         /* is there any other frame we should care about 
484                            besides AST_CONTROL_HANGUP? */
485                         if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP) {
486                                 ast_log(LOG_DEBUG, "Got HANGUP frame on channel %s, going out ...\n", chan->name);
487                                 ast_frfree(f);
488                                 break;
489                         }
490                         ast_frfree(f);
491                 }
492         }
493 quit:
494         /* notify manager users this channel cannot be 
495            controlled anymore by Async AGI */
496         manager_event(EVENT_FLAG_CALL, "AsyncAGI", "SubEvent: End\r\nChannel: %s\r\n", chan->name);
497
498         /* close the pipe */
499         close(fds[0]);
500         close(fds[1]);
501
502         /* intentionally don't get rid of the datastore. So commands can be 
503            still in the queue in case AsyncAGI gets called again.
504            Datastore destructor will be called on channel destroy anyway  */
505
506         return returnstatus;
507
508 #undef AGI_BUF_SIZE 
509 #undef AMI_BUF_SIZE 
510 }
511
512 /* launch_netscript: The fastagi handler.
513         FastAGI defaults to port 4573 */
514 static enum agi_result launch_netscript(char *agiurl, char *argv[], int *fds, int *efd, int *opid)
515 {
516         int s, flags, res, port = AGI_PORT;
517         struct pollfd pfds[1];
518         char *host, *c, *script = "";
519         struct sockaddr_in sin;
520         struct hostent *hp;
521         struct ast_hostent ahp;
522
523         /* agiusl is "agi://host.domain[:port][/script/name]" */
524         host = ast_strdupa(agiurl + 6); /* Remove agi:// */
525         /* Strip off any script name */
526         if ((c = strchr(host, '/'))) {
527                 *c = '\0';
528                 c++;
529                 script = c;
530         }
531         if ((c = strchr(host, ':'))) {
532                 *c = '\0';
533                 c++;
534                 port = atoi(c);
535         }
536         if (efd) {
537                 ast_log(LOG_WARNING, "AGI URI's don't support Enhanced AGI yet\n");
538                 return -1;
539         }
540         if (!(hp = ast_gethostbyname(host, &ahp))) {
541                 ast_log(LOG_WARNING, "Unable to locate host '%s'\n", host);
542                 return -1;
543         }
544         if ((s = socket(AF_INET, SOCK_STREAM, 0)) < 0) {
545                 ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno));
546                 return -1;
547         }
548         if ((flags = fcntl(s, F_GETFL)) < 0) {
549                 ast_log(LOG_WARNING, "Fcntl(F_GETFL) failed: %s\n", strerror(errno));
550                 close(s);
551                 return -1;
552         }
553         if (fcntl(s, F_SETFL, flags | O_NONBLOCK) < 0) {
554                 ast_log(LOG_WARNING, "Fnctl(F_SETFL) failed: %s\n", strerror(errno));
555                 close(s);
556                 return -1;
557         }
558         memset(&sin, 0, sizeof(sin));
559         sin.sin_family = AF_INET;
560         sin.sin_port = htons(port);
561         memcpy(&sin.sin_addr, hp->h_addr, sizeof(sin.sin_addr));
562         if (connect(s, (struct sockaddr *)&sin, sizeof(sin)) && (errno != EINPROGRESS)) {
563                 ast_log(LOG_WARNING, "Connect failed with unexpected error: %s\n", strerror(errno));
564                 close(s);
565                 return AGI_RESULT_FAILURE;
566         }
567
568         pfds[0].fd = s;
569         pfds[0].events = POLLOUT;
570         while ((res = poll(pfds, 1, MAX_AGI_CONNECT)) != 1) {
571                 if (errno != EINTR) {
572                         if (!res) {
573                                 ast_log(LOG_WARNING, "FastAGI connection to '%s' timed out after MAX_AGI_CONNECT (%d) milliseconds.\n",
574                                         agiurl, MAX_AGI_CONNECT);
575                         } else
576                                 ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
577                         close(s);
578                         return AGI_RESULT_FAILURE;
579                 }
580         }
581
582         if (ast_agi_fdprintf(NULL, s, "agi_network: yes\n") < 0) {
583                 if (errno != EINTR) {
584                         ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
585                         close(s);
586                         return AGI_RESULT_FAILURE;
587                 }
588         }
589
590         /* If we have a script parameter, relay it to the fastagi server */
591         /* Script parameters take the form of: AGI(agi://my.example.com/?extension=${EXTEN}) */
592         if (!ast_strlen_zero(script))
593                 ast_agi_fdprintf(NULL, s, "agi_network_script: %s\n", script);
594
595         ast_debug(4, "Wow, connected!\n");
596         fds[0] = s;
597         fds[1] = s;
598         *opid = -1;
599         return AGI_RESULT_SUCCESS_FAST;
600 }
601
602 static enum agi_result launch_script(struct ast_channel *chan, char *script, char *argv[], int *fds, int *efd, int *opid)
603 {
604         char tmp[256];
605         int pid, toast[2], fromast[2], audio[2], x, res;
606         sigset_t signal_set, old_set;
607         struct stat st;
608
609         if (!strncasecmp(script, "agi://", 6))
610                 return launch_netscript(script, argv, fds, efd, opid);
611         if (!strncasecmp(script, "agi:async", sizeof("agi:async")-1))
612                 return launch_asyncagi(chan, argv, efd);
613         
614         if (script[0] != '/') {
615                 snprintf(tmp, sizeof(tmp), "%s/%s", ast_config_AST_AGI_DIR, script);
616                 script = tmp;
617         }
618
619         /* Before even trying let's see if the file actually exists */
620         if (stat(script, &st)) {
621                 ast_log(LOG_WARNING, "Failed to execute '%s': File does not exist.\n", script);
622                 return AGI_RESULT_NOTFOUND;
623         }
624
625         if (pipe(toast)) {
626                 ast_log(LOG_WARNING, "Unable to create toast pipe: %s\n",strerror(errno));
627                 return AGI_RESULT_FAILURE;
628         }
629         if (pipe(fromast)) {
630                 ast_log(LOG_WARNING, "unable to create fromast pipe: %s\n", strerror(errno));
631                 close(toast[0]);
632                 close(toast[1]);
633                 return AGI_RESULT_FAILURE;
634         }
635         if (efd) {
636                 if (pipe(audio)) {
637                         ast_log(LOG_WARNING, "unable to create audio pipe: %s\n", strerror(errno));
638                         close(fromast[0]);
639                         close(fromast[1]);
640                         close(toast[0]);
641                         close(toast[1]);
642                         return AGI_RESULT_FAILURE;
643                 }
644                 res = fcntl(audio[1], F_GETFL);
645                 if (res > -1) 
646                         res = fcntl(audio[1], F_SETFL, res | O_NONBLOCK);
647                 if (res < 0) {
648                         ast_log(LOG_WARNING, "unable to set audio pipe parameters: %s\n", strerror(errno));
649                         close(fromast[0]);
650                         close(fromast[1]);
651                         close(toast[0]);
652                         close(toast[1]);
653                         close(audio[0]);
654                         close(audio[1]);
655                         return AGI_RESULT_FAILURE;
656                 }
657         }
658
659         /* Block SIGHUP during the fork - prevents a race */
660         sigfillset(&signal_set);
661         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
662         if ((pid = fork()) < 0) {
663                 ast_log(LOG_WARNING, "Failed to fork(): %s\n", strerror(errno));
664                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
665                 return AGI_RESULT_FAILURE;
666         }
667         if (!pid) {
668                 /* Pass paths to AGI via environmental variables */
669                 setenv("AST_CONFIG_DIR", ast_config_AST_CONFIG_DIR, 1);
670                 setenv("AST_CONFIG_FILE", ast_config_AST_CONFIG_FILE, 1);
671                 setenv("AST_MODULE_DIR", ast_config_AST_MODULE_DIR, 1);
672                 setenv("AST_SPOOL_DIR", ast_config_AST_SPOOL_DIR, 1);
673                 setenv("AST_MONITOR_DIR", ast_config_AST_MONITOR_DIR, 1);
674                 setenv("AST_VAR_DIR", ast_config_AST_VAR_DIR, 1);
675                 setenv("AST_DATA_DIR", ast_config_AST_DATA_DIR, 1);
676                 setenv("AST_LOG_DIR", ast_config_AST_LOG_DIR, 1);
677                 setenv("AST_AGI_DIR", ast_config_AST_AGI_DIR, 1);
678                 setenv("AST_KEY_DIR", ast_config_AST_KEY_DIR, 1);
679                 setenv("AST_RUN_DIR", ast_config_AST_RUN_DIR, 1);
680
681                 /* Don't run AGI scripts with realtime priority -- it causes audio stutter */
682                 ast_set_priority(0);
683
684                 /* Redirect stdin and out, provide enhanced audio channel if desired */
685                 dup2(fromast[0], STDIN_FILENO);
686                 dup2(toast[1], STDOUT_FILENO);
687                 if (efd)
688                         dup2(audio[0], STDERR_FILENO + 1);
689                 else
690                         close(STDERR_FILENO + 1);
691
692                 /* Before we unblock our signals, return our trapped signals back to the defaults */
693                 signal(SIGHUP, SIG_DFL);
694                 signal(SIGCHLD, SIG_DFL);
695                 signal(SIGINT, SIG_DFL);
696                 signal(SIGURG, SIG_DFL);
697                 signal(SIGTERM, SIG_DFL);
698                 signal(SIGPIPE, SIG_DFL);
699                 signal(SIGXFSZ, SIG_DFL);
700
701                 /* unblock important signal handlers */
702                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
703                         ast_log(LOG_WARNING, "unable to unblock signals for AGI script: %s\n", strerror(errno));
704                         _exit(1);
705                 }
706
707                 /* Close everything but stdin/out/error */
708                 for (x = STDERR_FILENO + 2; x < 1024; x++) 
709                         close(x);
710
711                 /* Execute script */
712                 /* XXX argv should be deprecated in favor of passing agi_argX paramaters */
713                 execv(script, argv);
714                 /* Can't use ast_log since FD's are closed */
715                 fprintf(stdout, "verbose \"Failed to execute '%s': %s\" 2\n", script, strerror(errno));
716                 fflush(stdout);
717                 _exit(1);
718         }
719         pthread_sigmask(SIG_SETMASK, &old_set, NULL);
720         ast_verb(3, "Launched AGI Script %s\n", script);
721         fds[0] = toast[0];
722         fds[1] = fromast[1];
723         if (efd)
724                 *efd = audio[1];
725         /* close what we're not using in the parent */
726         close(toast[1]);
727         close(fromast[0]);
728
729         if (efd)
730                 close(audio[0]);
731
732         *opid = pid;
733         return AGI_RESULT_SUCCESS;
734 }
735
736 static void setup_env(struct ast_channel *chan, char *request, int fd, int enhanced, int argc, char *argv[])
737 {
738         int count;
739
740         /* Print initial environment, with agi_request always being the first
741            thing */
742         ast_agi_fdprintf(chan, fd, "agi_request: %s\n", request);
743         ast_agi_fdprintf(chan, fd, "agi_channel: %s\n", chan->name);
744         ast_agi_fdprintf(chan, fd, "agi_language: %s\n", chan->language);
745         ast_agi_fdprintf(chan, fd, "agi_type: %s\n", chan->tech->type);
746         ast_agi_fdprintf(chan, fd, "agi_uniqueid: %s\n", chan->uniqueid);
747         ast_agi_fdprintf(chan, fd, "agi_version: %s\n", ast_get_version());
748
749         /* ANI/DNIS */
750         ast_agi_fdprintf(chan, fd, "agi_callerid: %s\n", S_OR(chan->cid.cid_num, "unknown"));
751         ast_agi_fdprintf(chan, fd, "agi_calleridname: %s\n", S_OR(chan->cid.cid_name, "unknown"));
752         ast_agi_fdprintf(chan, fd, "agi_callingpres: %d\n", chan->cid.cid_pres);
753         ast_agi_fdprintf(chan, fd, "agi_callingani2: %d\n", chan->cid.cid_ani2);
754         ast_agi_fdprintf(chan, fd, "agi_callington: %d\n", chan->cid.cid_ton);
755         ast_agi_fdprintf(chan, fd, "agi_callingtns: %d\n", chan->cid.cid_tns);
756         ast_agi_fdprintf(chan, fd, "agi_dnid: %s\n", S_OR(chan->cid.cid_dnid, "unknown"));
757         ast_agi_fdprintf(chan, fd, "agi_rdnis: %s\n", S_OR(chan->cid.cid_rdnis, "unknown"));
758
759         /* Context information */
760         ast_agi_fdprintf(chan, fd, "agi_context: %s\n", chan->context);
761         ast_agi_fdprintf(chan, fd, "agi_extension: %s\n", chan->exten);
762         ast_agi_fdprintf(chan, fd, "agi_priority: %d\n", chan->priority);
763         ast_agi_fdprintf(chan, fd, "agi_enhanced: %s\n", enhanced ? "1.0" : "0.0");
764
765         /* User information */
766         ast_agi_fdprintf(chan, fd, "agi_accountcode: %s\n", chan->accountcode ? chan->accountcode : "");
767         ast_agi_fdprintf(chan, fd, "agi_threadid: %ld\n", (long)pthread_self());
768
769         /* Send any parameters to the fastagi server that have been passed via the agi application */
770         /* Agi application paramaters take the form of: AGI(/path/to/example/script|${EXTEN}) */
771         for(count = 1; count < argc; count++)
772                 ast_agi_fdprintf(chan, fd, "agi_arg_%d: %s\n", count, argv[count]);
773
774         /* End with empty return */
775         ast_agi_fdprintf(chan, fd, "\n");
776 }
777
778 static int handle_answer(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
779 {
780         int res = 0;
781
782         /* Answer the channel */
783         if (chan->_state != AST_STATE_UP)
784                 res = ast_answer(chan);
785
786         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
787         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
788 }
789
790 static int handle_waitfordigit(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
791 {
792         int res, to;
793
794         if (argc != 4)
795                 return RESULT_SHOWUSAGE;
796         if (sscanf(argv[3], "%d", &to) != 1)
797                 return RESULT_SHOWUSAGE;
798         res = ast_waitfordigit_full(chan, to, agi->audio, agi->ctrl);
799         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
800         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
801 }
802
803 static int handle_sendtext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
804 {
805         int res;
806
807         if (argc != 3)
808                 return RESULT_SHOWUSAGE;
809
810         /* At the moment, the parser (perhaps broken) returns with
811            the last argument PLUS the newline at the end of the input
812            buffer. This probably needs to be fixed, but I wont do that
813            because other stuff may break as a result. The right way
814            would probably be to strip off the trailing newline before
815            parsing, then here, add a newline at the end of the string
816            before sending it to ast_sendtext --DUDE */
817         res = ast_sendtext(chan, argv[2]);
818         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
819         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
820 }
821
822 static int handle_recvchar(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
823 {
824         int res;
825
826         if (argc != 3)
827                 return RESULT_SHOWUSAGE;
828
829         res = ast_recvchar(chan,atoi(argv[2]));
830         if (res == 0) {
831                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (timeout)\n", res);
832                 return RESULT_SUCCESS;
833         }
834         if (res > 0) {
835                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
836                 return RESULT_SUCCESS;
837         }
838         else {
839                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (hangup)\n", res);
840                 return RESULT_FAILURE;
841         }
842 }
843
844 static int handle_recvtext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
845 {
846         char *buf;
847         
848         if (argc != 3)
849                 return RESULT_SHOWUSAGE;
850
851         buf = ast_recvtext(chan,atoi(argv[2]));
852         if (buf) {
853                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", buf);
854                 ast_free(buf);
855         } else {        
856                 ast_agi_fdprintf(chan, agi->fd, "200 result=-1\n");
857         }
858         return RESULT_SUCCESS;
859 }
860
861 static int handle_tddmode(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
862 {
863         int res, x;
864
865         if (argc != 3)
866                 return RESULT_SHOWUSAGE;
867
868         if (!strncasecmp(argv[2],"on",2)) 
869                 x = 1; 
870         else 
871                 x = 0;
872         if (!strncasecmp(argv[2],"mate",4)) 
873                 x = 2;
874         if (!strncasecmp(argv[2],"tdd",3))
875                 x = 1;
876         res = ast_channel_setoption(chan, AST_OPTION_TDD, &x, sizeof(char), 0);
877         if (res != RESULT_SUCCESS)
878                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
879         else
880                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
881         return RESULT_SUCCESS;
882 }
883
884 static int handle_sendimage(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
885 {
886         int res;
887
888         if (argc != 3)
889                 return RESULT_SHOWUSAGE;
890
891         res = ast_send_image(chan, argv[2]);
892         if (!ast_check_hangup(chan))
893                 res = 0;
894         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
895         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
896 }
897
898 static int handle_controlstreamfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
899 {
900         int res = 0, skipms = 3000;
901         char *fwd = NULL, *rev = NULL, *pause = NULL, *stop = NULL;
902
903         if (argc < 5 || argc > 9)
904                 return RESULT_SHOWUSAGE;
905
906         if (!ast_strlen_zero(argv[4]))
907                 stop = argv[4];
908         else
909                 stop = NULL;
910         
911         if ((argc > 5) && (sscanf(argv[5], "%d", &skipms) != 1))
912                 return RESULT_SHOWUSAGE;
913
914         if (argc > 6 && !ast_strlen_zero(argv[6]))
915                 fwd = argv[6];
916         else
917                 fwd = "#";
918
919         if (argc > 7 && !ast_strlen_zero(argv[7]))
920                 rev = argv[7];
921         else
922                 rev = "*";
923         
924         if (argc > 8 && !ast_strlen_zero(argv[8]))
925                 pause = argv[8];
926         else
927                 pause = NULL;
928         
929         res = ast_control_streamfile(chan, argv[3], fwd, rev, stop, pause, NULL, skipms, NULL);
930         
931         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
932
933         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
934 }
935
936 static int handle_streamfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
937 {
938         int res, vres;
939         struct ast_filestream *fs, *vfs;
940         long sample_offset = 0, max_length;
941         char *edigits = "";
942
943         if (argc < 4 || argc > 5)
944                 return RESULT_SHOWUSAGE;
945
946         if (argv[3]) 
947                 edigits = argv[3];
948
949         if ((argc > 4) && (sscanf(argv[4], "%ld", &sample_offset) != 1))
950                 return RESULT_SHOWUSAGE;
951
952         if (!(fs = ast_openstream(chan, argv[2], chan->language))) {
953                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d endpos=%ld\n", 0, sample_offset);
954                 return RESULT_SUCCESS;
955         }
956
957         if ((vfs = ast_openvstream(chan, argv[2], chan->language)))
958                 ast_debug(1, "Ooh, found a video stream, too\n");
959                 
960         ast_verb(3, "Playing '%s' (escape_digits=%s) (sample_offset %ld)\n", argv[2], edigits, sample_offset);
961
962         ast_seekstream(fs, 0, SEEK_END);
963         max_length = ast_tellstream(fs);
964         ast_seekstream(fs, sample_offset, SEEK_SET);
965         res = ast_applystream(chan, fs);
966         if (vfs)
967                 vres = ast_applystream(chan, vfs);
968         ast_playstream(fs);
969         if (vfs)
970                 ast_playstream(vfs);
971         
972         res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
973         /* this is to check for if ast_waitstream closed the stream, we probably are at
974          * the end of the stream, return that amount, else check for the amount */
975         sample_offset = (chan->stream) ? ast_tellstream(fs) : max_length;
976         ast_stopstream(chan);
977         if (res == 1) {
978                 /* Stop this command, don't print a result line, as there is a new command */
979                 return RESULT_SUCCESS;
980         }
981         ast_agi_fdprintf(chan, agi->fd, "200 result=%d endpos=%ld\n", res, sample_offset);
982         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
983 }
984
985 /* get option - really similar to the handle_streamfile, but with a timeout */
986 static int handle_getoption(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
987 {
988         int res, vres;
989         struct ast_filestream *fs, *vfs;
990         long sample_offset = 0, max_length;
991         int timeout = 0;
992         char *edigits = "";
993
994         if ( argc < 4 || argc > 5 )
995                 return RESULT_SHOWUSAGE;
996
997         if ( argv[3] ) 
998                 edigits = argv[3];
999
1000         if ( argc == 5 )
1001                 timeout = atoi(argv[4]);
1002         else if (chan->pbx->dtimeout) {
1003                 /* by default dtimeout is set to 5sec */
1004                 timeout = chan->pbx->dtimeout * 1000; /* in msec */
1005         }
1006
1007         if (!(fs = ast_openstream(chan, argv[2], chan->language))) {
1008                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d endpos=%ld\n", 0, sample_offset);
1009                 ast_log(LOG_WARNING, "Unable to open %s\n", argv[2]);
1010                 return RESULT_SUCCESS;
1011         }
1012
1013         if ((vfs = ast_openvstream(chan, argv[2], chan->language)))
1014                 ast_debug(1, "Ooh, found a video stream, too\n");
1015         
1016         ast_verb(3, "Playing '%s' (escape_digits=%s) (timeout %d)\n", argv[2], edigits, timeout);
1017
1018         ast_seekstream(fs, 0, SEEK_END);
1019         max_length = ast_tellstream(fs);
1020         ast_seekstream(fs, sample_offset, SEEK_SET);
1021         res = ast_applystream(chan, fs);
1022         if (vfs)
1023                 vres = ast_applystream(chan, vfs);
1024         ast_playstream(fs);
1025         if (vfs)
1026                 ast_playstream(vfs);
1027
1028         res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
1029         /* this is to check for if ast_waitstream closed the stream, we probably are at
1030          * the end of the stream, return that amount, else check for the amount */
1031         sample_offset = (chan->stream)?ast_tellstream(fs):max_length;
1032         ast_stopstream(chan);
1033         if (res == 1) {
1034                 /* Stop this command, don't print a result line, as there is a new command */
1035                 return RESULT_SUCCESS;
1036         }
1037
1038         /* If the user didnt press a key, wait for digitTimeout*/
1039         if (res == 0 ) {
1040                 res = ast_waitfordigit_full(chan, timeout, agi->audio, agi->ctrl);
1041                 /* Make sure the new result is in the escape digits of the GET OPTION */
1042                 if ( !strchr(edigits,res) )
1043                         res=0;
1044         }
1045
1046         ast_agi_fdprintf(chan, agi->fd, "200 result=%d endpos=%ld\n", res, sample_offset);
1047         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1048 }
1049
1050
1051
1052
1053 /*--- handle_saynumber: Say number in various language syntaxes ---*/
1054 /* While waiting, we're sending a NULL.  */
1055 static int handle_saynumber(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1056 {
1057         int res, num;
1058
1059         if (argc < 4 || argc > 5)
1060                 return RESULT_SHOWUSAGE;
1061         if (sscanf(argv[2], "%d", &num) != 1)
1062                 return RESULT_SHOWUSAGE;
1063         res = ast_say_number_full(chan, num, argv[3], chan->language, argc > 4 ? argv[4] : NULL, agi->audio, agi->ctrl);
1064         if (res == 1)
1065                 return RESULT_SUCCESS;
1066         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1067         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1068 }
1069
1070 static int handle_saydigits(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1071 {
1072         int res, num;
1073
1074         if (argc != 4)
1075                 return RESULT_SHOWUSAGE;
1076         if (sscanf(argv[2], "%d", &num) != 1)
1077                 return RESULT_SHOWUSAGE;
1078
1079         res = ast_say_digit_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
1080         if (res == 1) /* New command */
1081                 return RESULT_SUCCESS;
1082         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1083         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1084 }
1085
1086 static int handle_sayalpha(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1087 {
1088         int res;
1089
1090         if (argc != 4)
1091                 return RESULT_SHOWUSAGE;
1092
1093         res = ast_say_character_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
1094         if (res == 1) /* New command */
1095                 return RESULT_SUCCESS;
1096         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1097         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1098 }
1099
1100 static int handle_saydate(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1101 {
1102         int res, num;
1103
1104         if (argc != 4)
1105                 return RESULT_SHOWUSAGE;
1106         if (sscanf(argv[2], "%d", &num) != 1)
1107                 return RESULT_SHOWUSAGE;
1108         res = ast_say_date(chan, num, argv[3], chan->language);
1109         if (res == 1)
1110                 return RESULT_SUCCESS;
1111         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1112         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1113 }
1114
1115 static int handle_saytime(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1116 {
1117         int res, num;
1118
1119         if (argc != 4)
1120                 return RESULT_SHOWUSAGE;
1121         if (sscanf(argv[2], "%d", &num) != 1)
1122                 return RESULT_SHOWUSAGE;
1123         res = ast_say_time(chan, num, argv[3], chan->language);
1124         if (res == 1)
1125                 return RESULT_SUCCESS;
1126         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1127         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1128 }
1129
1130 static int handle_saydatetime(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1131 {
1132         int res = 0;
1133         time_t unixtime;
1134         char *format, *zone = NULL;
1135         
1136         if (argc < 4)
1137                 return RESULT_SHOWUSAGE;
1138
1139         if (argc > 4) {
1140                 format = argv[4];
1141         } else {
1142                 /* XXX this doesn't belong here, but in the 'say' module */
1143                 if (!strcasecmp(chan->language, "de")) {
1144                         format = "A dBY HMS";
1145                 } else {
1146                         format = "ABdY 'digits/at' IMp"; 
1147                 }
1148         }
1149
1150         if (argc > 5 && !ast_strlen_zero(argv[5]))
1151                 zone = argv[5];
1152
1153         if (ast_get_time_t(argv[2], &unixtime, 0, NULL))
1154                 return RESULT_SHOWUSAGE;
1155
1156         res = ast_say_date_with_format(chan, unixtime, argv[3], chan->language, format, zone);
1157         if (res == 1)
1158                 return RESULT_SUCCESS;
1159
1160         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1161         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1162 }
1163
1164 static int handle_sayphonetic(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1165 {
1166         int res;
1167
1168         if (argc != 4)
1169                 return RESULT_SHOWUSAGE;
1170
1171         res = ast_say_phonetic_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
1172         if (res == 1) /* New command */
1173                 return RESULT_SUCCESS;
1174         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1175         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
1176 }
1177
1178 static int handle_getdata(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1179 {
1180         int res, max, timeout;
1181         char data[1024];
1182
1183         if (argc < 3)
1184                 return RESULT_SHOWUSAGE;
1185         if (argc >= 4)
1186                 timeout = atoi(argv[3]); 
1187         else
1188                 timeout = 0;
1189         if (argc >= 5) 
1190                 max = atoi(argv[4]); 
1191         else
1192                 max = 1024;
1193         res = ast_app_getdata_full(chan, argv[2], data, max, timeout, agi->audio, agi->ctrl);
1194         if (res == 2)                   /* New command */
1195                 return RESULT_SUCCESS;
1196         else if (res == 1)
1197                 ast_agi_fdprintf(chan, agi->fd, "200 result=%s (timeout)\n", data);
1198         else if (res < 0 )
1199                 ast_agi_fdprintf(chan, agi->fd, "200 result=-1\n");
1200         else
1201                 ast_agi_fdprintf(chan, agi->fd, "200 result=%s\n", data);
1202         return RESULT_SUCCESS;
1203 }
1204
1205 static int handle_setcontext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1206 {
1207
1208         if (argc != 3)
1209                 return RESULT_SHOWUSAGE;
1210         ast_copy_string(chan->context, argv[2], sizeof(chan->context));
1211         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1212         return RESULT_SUCCESS;
1213 }
1214         
1215 static int handle_setextension(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1216 {
1217         if (argc != 3)
1218                 return RESULT_SHOWUSAGE;
1219         ast_copy_string(chan->exten, argv[2], sizeof(chan->exten));
1220         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1221         return RESULT_SUCCESS;
1222 }
1223
1224 static int handle_setpriority(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1225 {
1226         int pri;
1227
1228         if (argc != 3)
1229                 return RESULT_SHOWUSAGE;        
1230
1231         if (sscanf(argv[2], "%d", &pri) != 1) {
1232                 if ((pri = ast_findlabel_extension(chan, chan->context, chan->exten, argv[2], chan->cid.cid_num)) < 1)
1233                         return RESULT_SHOWUSAGE;
1234         }
1235
1236         ast_explicit_goto(chan, NULL, NULL, pri);
1237         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1238         return RESULT_SUCCESS;
1239 }
1240                 
1241 static int handle_recordfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1242 {
1243         struct ast_filestream *fs;
1244         struct ast_frame *f;
1245         struct timeval start;
1246         long sample_offset = 0;
1247         int res = 0;
1248         int ms;
1249
1250         struct ast_dsp *sildet=NULL;         /* silence detector dsp */
1251         int totalsilence = 0;
1252         int dspsilence = 0;
1253         int silence = 0;                /* amount of silence to allow */
1254         int gotsilence = 0;             /* did we timeout for silence? */
1255         char *silencestr=NULL;
1256         int rfmt=0;
1257
1258
1259         /* XXX EAGI FIXME XXX */
1260
1261         if (argc < 6)
1262                 return RESULT_SHOWUSAGE;
1263         if (sscanf(argv[5], "%d", &ms) != 1)
1264                 return RESULT_SHOWUSAGE;
1265
1266         if (argc > 6)
1267                 silencestr = strchr(argv[6],'s');
1268         if ((argc > 7) && (!silencestr))
1269                 silencestr = strchr(argv[7],'s');
1270         if ((argc > 8) && (!silencestr))
1271                 silencestr = strchr(argv[8],'s');
1272
1273         if (silencestr) {
1274                 if (strlen(silencestr) > 2) {
1275                         if ((silencestr[0] == 's') && (silencestr[1] == '=')) {
1276                                 silencestr++;
1277                                 silencestr++;
1278                                 if (silencestr)
1279                                         silence = atoi(silencestr);
1280                                 if (silence > 0)
1281                                         silence *= 1000;
1282                         }
1283                 }
1284         }
1285
1286         if (silence > 0) {
1287                 rfmt = chan->readformat;
1288                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
1289                 if (res < 0) {
1290                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
1291                         return -1;
1292                 }
1293                 sildet = ast_dsp_new();
1294                 if (!sildet) {
1295                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
1296                         return -1;
1297                 }
1298                 ast_dsp_set_threshold(sildet, 256);
1299         }
1300
1301         /* backward compatibility, if no offset given, arg[6] would have been
1302          * caught below and taken to be a beep, else if it is a digit then it is a
1303          * offset */
1304         if ((argc >6) && (sscanf(argv[6], "%ld", &sample_offset) != 1) && (!strchr(argv[6], '=')))
1305                 res = ast_streamfile(chan, "beep", chan->language);
1306
1307         if ((argc > 7) && (!strchr(argv[7], '=')))
1308                 res = ast_streamfile(chan, "beep", chan->language);
1309
1310         if (!res)
1311                 res = ast_waitstream(chan, argv[4]);
1312         if (res) {
1313                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (randomerror) endpos=%ld\n", res, sample_offset);
1314         } else {
1315                 fs = ast_writefile(argv[2], argv[3], NULL, O_CREAT | O_WRONLY | (sample_offset ? O_APPEND : 0), 0, AST_FILE_MODE);
1316                 if (!fs) {
1317                         res = -1;
1318                         ast_agi_fdprintf(chan, agi->fd, "200 result=%d (writefile)\n", res);
1319                         if (sildet)
1320                                 ast_dsp_free(sildet);
1321                         return RESULT_FAILURE;
1322                 }
1323                 
1324                 /* Request a video update */
1325                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
1326         
1327                 chan->stream = fs;
1328                 ast_applystream(chan,fs);
1329                 /* really should have checks */
1330                 ast_seekstream(fs, sample_offset, SEEK_SET);
1331                 ast_truncstream(fs);
1332                 
1333                 start = ast_tvnow();
1334                 while ((ms < 0) || ast_tvdiff_ms(ast_tvnow(), start) < ms) {
1335                         res = ast_waitfor(chan, -1);
1336                         if (res < 0) {
1337                                 ast_closestream(fs);
1338                                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (waitfor) endpos=%ld\n", res,sample_offset);
1339                                 if (sildet)
1340                                         ast_dsp_free(sildet);
1341                                 return RESULT_FAILURE;
1342                         }
1343                         f = ast_read(chan);
1344                         if (!f) {
1345                                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (hangup) endpos=%ld\n", -1, sample_offset);
1346                                 ast_closestream(fs);
1347                                 if (sildet)
1348                                         ast_dsp_free(sildet);
1349                                 return RESULT_FAILURE;
1350                         }
1351                         switch(f->frametype) {
1352                         case AST_FRAME_DTMF:
1353                                 if (strchr(argv[4], f->subclass)) {
1354                                         /* This is an interrupting chracter, so rewind to chop off any small
1355                                            amount of DTMF that may have been recorded
1356                                         */
1357                                         ast_stream_rewind(fs, 200);
1358                                         ast_truncstream(fs);
1359                                         sample_offset = ast_tellstream(fs);
1360                                         ast_agi_fdprintf(chan, agi->fd, "200 result=%d (dtmf) endpos=%ld\n", f->subclass, sample_offset);
1361                                         ast_closestream(fs);
1362                                         ast_frfree(f);
1363                                         if (sildet)
1364                                                 ast_dsp_free(sildet);
1365                                         return RESULT_SUCCESS;
1366                                 }
1367                                 break;
1368                         case AST_FRAME_VOICE:
1369                                 ast_writestream(fs, f);
1370                                 /* this is a safe place to check progress since we know that fs
1371                                  * is valid after a write, and it will then have our current
1372                                  * location */
1373                                 sample_offset = ast_tellstream(fs);
1374                                 if (silence > 0) {
1375                                         dspsilence = 0;
1376                                         ast_dsp_silence(sildet, f, &dspsilence);
1377                                         if (dspsilence) {
1378                                                 totalsilence = dspsilence;
1379                                         } else {
1380                                                 totalsilence = 0;
1381                                         }
1382                                         if (totalsilence > silence) {
1383                                                 /* Ended happily with silence */
1384                                                 gotsilence = 1;
1385                                                 break;
1386                                         }
1387                                 }
1388                                 break;
1389                         case AST_FRAME_VIDEO:
1390                                 ast_writestream(fs, f);
1391                         default:
1392                                 /* Ignore all other frames */
1393                                 break;
1394                         }
1395                         ast_frfree(f);
1396                         if (gotsilence)
1397                                 break;
1398                 }
1399
1400                         if (gotsilence) {
1401                                 ast_stream_rewind(fs, silence-1000);
1402                                 ast_truncstream(fs);
1403                                 sample_offset = ast_tellstream(fs);
1404                 }               
1405                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (timeout) endpos=%ld\n", res, sample_offset);
1406                 ast_closestream(fs);
1407         }
1408
1409         if (silence > 0) {
1410                 res = ast_set_read_format(chan, rfmt);
1411                 if (res)
1412                         ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
1413                         ast_dsp_free(sildet);
1414         }
1415         return RESULT_SUCCESS;
1416 }
1417
1418 static int handle_autohangup(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1419 {
1420         int timeout;
1421
1422         if (argc != 3)
1423                 return RESULT_SHOWUSAGE;
1424         if (sscanf(argv[2], "%d", &timeout) != 1)
1425                 return RESULT_SHOWUSAGE;
1426         if (timeout < 0)
1427                 timeout = 0;
1428         if (timeout)
1429                 chan->whentohangup = time(NULL) + timeout;
1430         else
1431                 chan->whentohangup = 0;
1432         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1433         return RESULT_SUCCESS;
1434 }
1435
1436 static int handle_hangup(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1437 {
1438         struct ast_channel *c;
1439
1440         if (argc == 1) {
1441                 /* no argument: hangup the current channel */
1442                 ast_softhangup(chan,AST_SOFTHANGUP_EXPLICIT);
1443                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1444                 return RESULT_SUCCESS;
1445         } else if (argc == 2) {
1446                 /* one argument: look for info on the specified channel */
1447                 c = ast_get_channel_by_name_locked(argv[1]);
1448                 if (c) {
1449                         /* we have a matching channel */
1450                         ast_softhangup(c,AST_SOFTHANGUP_EXPLICIT);
1451                         ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1452                         ast_channel_unlock(c);
1453                         return RESULT_SUCCESS;
1454                 }
1455                 /* if we get this far no channel name matched the argument given */
1456                 ast_agi_fdprintf(chan, agi->fd, "200 result=-1\n");
1457                 return RESULT_SUCCESS;
1458         } else {
1459                 return RESULT_SHOWUSAGE;
1460         }
1461 }
1462
1463 static int handle_exec(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1464 {
1465         int res;
1466         struct ast_app *app;
1467
1468         if (argc < 2)
1469                 return RESULT_SHOWUSAGE;
1470
1471         ast_verb(3, "AGI Script Executing Application: (%s) Options: (%s)\n", argv[1], argv[2]);
1472
1473         if ((app = pbx_findapp(argv[1]))) {
1474                 res = pbx_exec(chan, app, argv[2]);
1475         } else {
1476                 ast_log(LOG_WARNING, "Could not find application (%s)\n", argv[1]);
1477                 res = -2;
1478         }
1479         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1480
1481         /* Even though this is wrong, users are depending upon this result. */
1482         return res;
1483 }
1484
1485 static int handle_setcallerid(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1486 {
1487         char tmp[256]="";
1488         char *l = NULL, *n = NULL;
1489
1490         if (argv[2]) {
1491                 ast_copy_string(tmp, argv[2], sizeof(tmp));
1492                 ast_callerid_parse(tmp, &n, &l);
1493                 if (l)
1494                         ast_shrink_phone_number(l);
1495                 else
1496                         l = "";
1497                 if (!n)
1498                         n = "";
1499                 ast_set_callerid(chan, l, n, NULL);
1500         }
1501
1502         ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1503         return RESULT_SUCCESS;
1504 }
1505
1506 static int handle_channelstatus(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1507 {
1508         struct ast_channel *c;
1509         if (argc == 2) {
1510                 /* no argument: supply info on the current channel */
1511                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", chan->_state);
1512                 return RESULT_SUCCESS;
1513         } else if (argc == 3) {
1514                 /* one argument: look for info on the specified channel */
1515                 c = ast_get_channel_by_name_locked(argv[2]);
1516                 if (c) {
1517                         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", c->_state);
1518                         ast_channel_unlock(c);
1519                         return RESULT_SUCCESS;
1520                 }
1521                 /* if we get this far no channel name matched the argument given */
1522                 ast_agi_fdprintf(chan, agi->fd, "200 result=-1\n");
1523                 return RESULT_SUCCESS;
1524         } else {
1525                 return RESULT_SHOWUSAGE;
1526         }
1527 }
1528
1529 static int handle_setvariable(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1530 {
1531         if (argv[3])
1532                 pbx_builtin_setvar_helper(chan, argv[2], argv[3]);
1533
1534         ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1535         return RESULT_SUCCESS;
1536 }
1537
1538 static int handle_getvariable(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1539 {
1540         char *ret;
1541         char tempstr[1024];
1542
1543         if (argc != 3)
1544                 return RESULT_SHOWUSAGE;
1545
1546         /* check if we want to execute an ast_custom_function */
1547         if (!ast_strlen_zero(argv[2]) && (argv[2][strlen(argv[2]) - 1] == ')')) {
1548                 ret = ast_func_read(chan, argv[2], tempstr, sizeof(tempstr)) ? NULL : tempstr;
1549         } else {
1550                 pbx_retrieve_variable(chan, argv[2], &ret, tempstr, sizeof(tempstr), NULL);
1551         }
1552
1553         if (ret)
1554                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", ret);
1555         else
1556                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1557
1558         return RESULT_SUCCESS;
1559 }
1560
1561 static int handle_getvariablefull(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1562 {
1563         char tmp[4096];
1564         struct ast_channel *chan2=NULL;
1565
1566         if ((argc != 4) && (argc != 5))
1567                 return RESULT_SHOWUSAGE;
1568         if (argc == 5) {
1569                 chan2 = ast_get_channel_by_name_locked(argv[4]);
1570         } else {
1571                 chan2 = chan;
1572         }
1573         if (chan2) {
1574                 pbx_substitute_variables_helper(chan2, argv[3], tmp, sizeof(tmp) - 1);
1575                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", tmp);
1576         } else {
1577                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1578         }
1579         if (chan2 && (chan2 != chan))
1580                 ast_channel_unlock(chan2);
1581         return RESULT_SUCCESS;
1582 }
1583
1584 static int handle_verbose(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1585 {
1586         int level = 0;
1587
1588         if (argc < 2)
1589                 return RESULT_SHOWUSAGE;
1590
1591         if (argv[2])
1592                 sscanf(argv[2], "%d", &level);
1593
1594         ast_verb(level, "%s: %s\n", chan->data, argv[1]);
1595         
1596         ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1597         
1598         return RESULT_SUCCESS;
1599 }
1600
1601 static int handle_dbget(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1602 {
1603         int res;
1604         char tmp[256];
1605
1606         if (argc != 4)
1607                 return RESULT_SHOWUSAGE;
1608         res = ast_db_get(argv[2], argv[3], tmp, sizeof(tmp));
1609         if (res) 
1610                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1611         else
1612                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", tmp);
1613
1614         return RESULT_SUCCESS;
1615 }
1616
1617 static int handle_dbput(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1618 {
1619         int res;
1620
1621         if (argc != 5)
1622                 return RESULT_SHOWUSAGE;
1623         res = ast_db_put(argv[2], argv[3], argv[4]);
1624         ast_agi_fdprintf(chan, agi->fd, "200 result=%c\n", res ? '0' : '1');
1625         return RESULT_SUCCESS;
1626 }
1627
1628 static int handle_dbdel(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1629 {
1630         int res;
1631
1632         if (argc != 4)
1633                 return RESULT_SHOWUSAGE;
1634         res = ast_db_del(argv[2], argv[3]);
1635         ast_agi_fdprintf(chan, agi->fd, "200 result=%c\n", res ? '0' : '1');
1636         return RESULT_SUCCESS;
1637 }
1638
1639 static int handle_dbdeltree(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1640 {
1641         int res;
1642
1643         if ((argc < 3) || (argc > 4))
1644                 return RESULT_SHOWUSAGE;
1645         if (argc == 4)
1646                 res = ast_db_deltree(argv[2], argv[3]);
1647         else
1648                 res = ast_db_deltree(argv[2], NULL);
1649
1650         ast_agi_fdprintf(chan, agi->fd, "200 result=%c\n", res ? '0' : '1');
1651         return RESULT_SUCCESS;
1652 }
1653
1654 static char *handle_cli_agi_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1655 {
1656         switch (cmd) {
1657         case CLI_INIT:
1658                 e->command = "agi debug [off]";
1659                 e->usage =
1660                         "Usage: agi debug [off]\n"
1661                         "       Enables/disables dumping of AGI transactions for\n"
1662                         "       debugging purposes.\n";
1663                 return NULL;
1664
1665         case CLI_GENERATE:
1666                 return NULL;
1667         }
1668         if (a->argc < e->args - 1 || a->argc > e->args )
1669                 return CLI_SHOWUSAGE;
1670         if (a->argc == e->args - 1) {
1671                 agidebug = 1;
1672         } else {
1673                 if (strncasecmp(a->argv[e->args - 1], "off", 3) == 0) {
1674                         agidebug = 0;
1675                 } else {
1676                         return CLI_SHOWUSAGE;
1677                 }
1678         }
1679         ast_cli(a->fd, "AGI Debugging %sabled\n", agidebug ? "En" : "Dis");
1680         return CLI_SUCCESS;
1681 }
1682
1683 static int handle_noop(struct ast_channel *chan, AGI *agi, int arg, char *argv[])
1684 {
1685         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1686         return RESULT_SUCCESS;
1687 }
1688
1689 static int handle_setmusic(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1690 {
1691         if (!strncasecmp(argv[2], "on", 2))
1692                 ast_moh_start(chan, argc > 3 ? argv[3] : NULL, NULL);
1693         else if (!strncasecmp(argv[2], "off", 3))
1694                 ast_moh_stop(chan);
1695         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1696         return RESULT_SUCCESS;
1697 }
1698
1699 static int handle_speechcreate(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1700 {
1701         /* If a structure already exists, return an error */
1702         if (agi->speech) {
1703                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1704                 return RESULT_SUCCESS;
1705         }
1706         
1707         if ((agi->speech = ast_speech_new(argv[2], AST_FORMAT_SLINEAR)))
1708                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1709         else
1710                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1711         
1712         return RESULT_SUCCESS;
1713 }
1714
1715 static int handle_speechset(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1716 {
1717         /* Check for minimum arguments */
1718         if (argc != 3)
1719                 return RESULT_SHOWUSAGE;
1720         
1721         /* Check to make sure speech structure exists */
1722         if (!agi->speech) {
1723                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1724                 return RESULT_SUCCESS;
1725         }
1726         
1727         ast_speech_change(agi->speech, argv[2], argv[3]);
1728         ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1729         
1730         return RESULT_SUCCESS;
1731 }
1732
1733 static int handle_speechdestroy(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1734 {
1735         if (agi->speech) {
1736                 ast_speech_destroy(agi->speech);
1737                 agi->speech = NULL;
1738                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1739         } else {
1740                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1741         }
1742         
1743         return RESULT_SUCCESS;
1744 }
1745
1746 static int handle_speechloadgrammar(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1747 {
1748         if (argc != 5)
1749                 return RESULT_SHOWUSAGE;
1750         
1751         if (!agi->speech) {
1752                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1753                 return RESULT_SUCCESS;
1754         }
1755         
1756         if (ast_speech_grammar_load(agi->speech, argv[3], argv[4]))
1757                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1758         else
1759                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1760         
1761         return RESULT_SUCCESS;
1762 }
1763
1764 static int handle_speechunloadgrammar(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1765 {
1766         if (argc != 4)
1767                 return RESULT_SHOWUSAGE;
1768         
1769         if (!agi->speech) {
1770                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1771                 return RESULT_SUCCESS;
1772         }
1773         
1774         if (ast_speech_grammar_unload(agi->speech, argv[3]))
1775                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1776         else
1777                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1778         
1779         return RESULT_SUCCESS;
1780 }
1781
1782 static int handle_speechactivategrammar(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1783 {
1784         if (argc != 4)
1785                 return RESULT_SHOWUSAGE;
1786         
1787         if (!agi->speech) {
1788                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1789                 return RESULT_SUCCESS;
1790         }
1791         
1792         if (ast_speech_grammar_activate(agi->speech, argv[3]))
1793                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1794         else
1795                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1796         
1797         return RESULT_SUCCESS;
1798 }
1799
1800 static int handle_speechdeactivategrammar(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1801 {
1802         if (argc != 4)
1803                 return RESULT_SHOWUSAGE;
1804         
1805         if (!agi->speech) {
1806                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1807                 return RESULT_SUCCESS;
1808         }
1809         
1810         if (ast_speech_grammar_deactivate(agi->speech, argv[3]))
1811                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1812         else
1813                 ast_agi_fdprintf(chan, agi->fd, "200 result=1\n");
1814         
1815         return RESULT_SUCCESS;
1816 }
1817
1818 static int speech_streamfile(struct ast_channel *chan, const char *filename, const char *preflang, int offset)
1819 {
1820         struct ast_filestream *fs = NULL;
1821         
1822         if (!(fs = ast_openstream(chan, filename, preflang)))
1823                 return -1;
1824         
1825         if (offset)
1826                 ast_seekstream(fs, offset, SEEK_SET);
1827         
1828         if (ast_applystream(chan, fs))
1829                 return -1;
1830         
1831         if (ast_playstream(fs))
1832                 return -1;
1833         
1834         return 0;
1835 }
1836
1837 static int handle_speechrecognize(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1838 {
1839         struct ast_speech *speech = agi->speech;
1840         char *prompt, dtmf = 0, tmp[4096] = "", *buf = tmp;
1841         int timeout = 0, offset = 0, old_read_format = 0, res = 0, i = 0;
1842         long current_offset = 0;
1843         const char *reason = NULL;
1844         struct ast_frame *fr = NULL;
1845         struct ast_speech_result *result = NULL;
1846         size_t left = sizeof(tmp);
1847         time_t start = 0, current;
1848         
1849         if (argc < 4)
1850                 return RESULT_SHOWUSAGE;
1851         
1852         if (!speech) {
1853                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1854                 return RESULT_SUCCESS;
1855         }
1856         
1857         prompt = argv[2];
1858         timeout = atoi(argv[3]);
1859         
1860         /* If offset is specified then convert from text to integer */
1861         if (argc == 5)
1862                 offset = atoi(argv[4]);
1863         
1864         /* We want frames coming in signed linear */
1865         old_read_format = chan->readformat;
1866         if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
1867                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1868                 return RESULT_SUCCESS;
1869         }
1870         
1871         /* Setup speech structure */
1872         if (speech->state == AST_SPEECH_STATE_NOT_READY || speech->state == AST_SPEECH_STATE_DONE) {
1873                 ast_speech_change_state(speech, AST_SPEECH_STATE_NOT_READY);
1874                 ast_speech_start(speech);
1875         }
1876         
1877         /* Start playing prompt */
1878         speech_streamfile(chan, prompt, chan->language, offset);
1879         
1880         /* Go into loop reading in frames, passing to speech thingy, checking for hangup, all that jazz */
1881         while (ast_strlen_zero(reason)) {
1882                 /* Run scheduled items */
1883                 ast_sched_runq(chan->sched);
1884                 
1885                 /* See maximum time of waiting */
1886                 if ((res = ast_sched_wait(chan->sched)) < 0)
1887                         res = 1000;
1888                 
1889                 /* Wait for frame */
1890                 if (ast_waitfor(chan, res) > 0) {
1891                         if (!(fr = ast_read(chan))) {
1892                                 reason = "hangup";
1893                                 break;
1894                         }
1895                 }
1896                 
1897                 /* Perform timeout check */
1898                 if ((timeout > 0) && (start > 0)) {
1899                         time(&current);
1900                         if ((current - start) >= timeout) {
1901                                 reason = "timeout";
1902                                 if (fr)
1903                                         ast_frfree(fr);
1904                                 break;
1905                         }
1906                 }
1907                 
1908                 /* Check the speech structure for any changes */
1909                 ast_mutex_lock(&speech->lock);
1910                 
1911                 /* See if we need to quiet the audio stream playback */
1912                 if (ast_test_flag(speech, AST_SPEECH_QUIET) && chan->stream) {
1913                         current_offset = ast_tellstream(chan->stream);
1914                         ast_stopstream(chan);
1915                         ast_clear_flag(speech, AST_SPEECH_QUIET);
1916                 }
1917                 
1918                 /* Check each state */
1919                 switch (speech->state) {
1920                 case AST_SPEECH_STATE_READY:
1921                         /* If the stream is done, start timeout calculation */
1922                         if ((timeout > 0) && ((!chan->stream) || (chan->streamid == -1 && chan->timingfunc == NULL))) {
1923                                 ast_stopstream(chan);
1924                                 time(&start);
1925                         }
1926                         /* Write audio frame data into speech engine if possible */
1927                         if (fr && fr->frametype == AST_FRAME_VOICE)
1928                                 ast_speech_write(speech, fr->data, fr->datalen);
1929                         break;
1930                 case AST_SPEECH_STATE_WAIT:
1931                         /* Cue waiting sound if not already playing */
1932                         if ((!chan->stream) || (chan->streamid == -1 && chan->timingfunc == NULL)) {
1933                                 ast_stopstream(chan);
1934                                 /* If a processing sound exists, or is not none - play it */
1935                                 if (!ast_strlen_zero(speech->processing_sound) && strcasecmp(speech->processing_sound, "none"))
1936                                         speech_streamfile(chan, speech->processing_sound, chan->language, 0);
1937                         }
1938                         break;
1939                 case AST_SPEECH_STATE_DONE:
1940                         /* Get the results */
1941                         speech->results = ast_speech_results_get(speech);
1942                         /* Change state to not ready */
1943                         ast_speech_change_state(speech, AST_SPEECH_STATE_NOT_READY);
1944                         reason = "speech";
1945                         break;
1946                 default:
1947                         break;
1948                 }
1949                 ast_mutex_unlock(&speech->lock);
1950                 
1951                 /* Check frame for DTMF or hangup */
1952                 if (fr) {
1953                         if (fr->frametype == AST_FRAME_DTMF) {
1954                                 reason = "dtmf";
1955                                 dtmf = fr->subclass;
1956                         } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_HANGUP) {
1957                                 reason = "hangup";
1958                         }
1959                         ast_frfree(fr);
1960                 }
1961         }
1962         
1963         if (!strcasecmp(reason, "speech")) {
1964                 /* Build string containing speech results */
1965                 for (result = speech->results; result; result = AST_LIST_NEXT(result, list)) {
1966                         /* Build result string */
1967                         ast_build_string(&buf, &left, "%sscore%d=%d text%d=\"%s\" grammar%d=%s", (i > 0 ? " " : ""), i, result->score, i, result->text, i, result->grammar);
1968                         /* Increment result count */
1969                         i++;
1970                 }
1971                 /* Print out */
1972                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (speech) endpos=%ld results=%d %s\n", current_offset, i, tmp);
1973         } else if (!strcasecmp(reason, "dtmf")) {
1974                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (digit) digit=%c endpos=%ld\n", dtmf, current_offset);
1975         } else if (!strcasecmp(reason, "hangup") || !strcasecmp(reason, "timeout")) {
1976                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s) endpos=%ld\n", reason, current_offset);
1977         } else {
1978                 ast_agi_fdprintf(chan, agi->fd, "200 result=0 endpos=%ld\n", current_offset);
1979         }
1980         
1981         return RESULT_SUCCESS;
1982 }
1983
1984 static int handle_asyncagi_break(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1985 {
1986         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1987         return AST_PBX_KEEPALIVE;
1988 }
1989
1990 static char usage_setmusic[] =
1991 " Usage: SET MUSIC ON <on|off> <class>\n"
1992 "       Enables/Disables the music on hold generator.  If <class> is\n"
1993 " not specified, then the default music on hold class will be used.\n"
1994 " Always returns 0.\n";
1995
1996 static char usage_dbput[] =
1997 " Usage: DATABASE PUT <family> <key> <value>\n"
1998 "       Adds or updates an entry in the Asterisk database for a\n"
1999 " given family, key, and value.\n"
2000 " Returns 1 if successful, 0 otherwise.\n";
2001
2002 static char usage_dbget[] =
2003 " Usage: DATABASE GET <family> <key>\n"
2004 "       Retrieves an entry in the Asterisk database for a\n"
2005 " given family and key.\n"
2006 " Returns 0 if <key> is not set.  Returns 1 if <key>\n"
2007 " is set and returns the variable in parentheses.\n"
2008 " Example return code: 200 result=1 (testvariable)\n";
2009
2010 static char usage_dbdel[] =
2011 " Usage: DATABASE DEL <family> <key>\n"
2012 "       Deletes an entry in the Asterisk database for a\n"
2013 " given family and key.\n"
2014 " Returns 1 if successful, 0 otherwise.\n";
2015
2016 static char usage_dbdeltree[] =
2017 " Usage: DATABASE DELTREE <family> [keytree]\n"
2018 "       Deletes a family or specific keytree within a family\n"
2019 " in the Asterisk database.\n"
2020 " Returns 1 if successful, 0 otherwise.\n";
2021
2022 static char usage_verbose[] =
2023 " Usage: VERBOSE <message> <level>\n"
2024 "       Sends <message> to the console via verbose message system.\n"
2025 " <level> is the the verbose level (1-4)\n"
2026 " Always returns 1.\n";
2027
2028 static char usage_getvariable[] =
2029 " Usage: GET VARIABLE <variablename>\n"
2030 "       Returns 0 if <variablename> is not set.  Returns 1 if <variablename>\n"
2031 " is set and returns the variable in parentheses.\n"
2032 " example return code: 200 result=1 (testvariable)\n";
2033
2034 static char usage_getvariablefull[] =
2035 " Usage: GET FULL VARIABLE <variablename> [<channel name>]\n"
2036 "       Returns 0 if <variablename> is not set or channel does not exist.  Returns 1\n"
2037 "if <variablename>  is set and returns the variable in parenthesis.  Understands\n"
2038 "complex variable names and builtin variables, unlike GET VARIABLE.\n"
2039 " example return code: 200 result=1 (testvariable)\n";
2040
2041 static char usage_setvariable[] =
2042 " Usage: SET VARIABLE <variablename> <value>\n";
2043
2044 static char usage_channelstatus[] =
2045 " Usage: CHANNEL STATUS [<channelname>]\n"
2046 "       Returns the status of the specified channel.\n" 
2047 " If no channel name is given the returns the status of the\n"
2048 " current channel.  Return values:\n"
2049 "  0 Channel is down and available\n"
2050 "  1 Channel is down, but reserved\n"
2051 "  2 Channel is off hook\n"
2052 "  3 Digits (or equivalent) have been dialed\n"
2053 "  4 Line is ringing\n"
2054 "  5 Remote end is ringing\n"
2055 "  6 Line is up\n"
2056 "  7 Line is busy\n";
2057
2058 static char usage_setcallerid[] =
2059 " Usage: SET CALLERID <number>\n"
2060 "       Changes the callerid of the current channel.\n";
2061
2062 static char usage_exec[] =
2063 " Usage: EXEC <application> <options>\n"
2064 "       Executes <application> with given <options>.\n"
2065 " Returns whatever the application returns, or -2 on failure to find application\n";
2066
2067 static char usage_hangup[] =
2068 " Usage: HANGUP [<channelname>]\n"
2069 "       Hangs up the specified channel.\n"
2070 " If no channel name is given, hangs up the current channel\n";
2071
2072 static char usage_answer[] = 
2073 " Usage: ANSWER\n"
2074 "       Answers channel if not already in answer state. Returns -1 on\n"
2075 " channel failure, or 0 if successful.\n";
2076
2077 static char usage_waitfordigit[] = 
2078 " Usage: WAIT FOR DIGIT <timeout>\n"
2079 "       Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.\n"
2080 " Returns -1 on channel failure, 0 if no digit is received in the timeout, or\n"
2081 " the numerical value of the ascii of the digit if one is received.  Use -1\n"
2082 " for the timeout value if you desire the call to block indefinitely.\n";
2083
2084 static char usage_sendtext[] =
2085 " Usage: SEND TEXT \"<text to send>\"\n"
2086 "       Sends the given text on a channel. Most channels do not support the\n"
2087 " transmission of text.  Returns 0 if text is sent, or if the channel does not\n"
2088 " support text transmission.  Returns -1 only on error/hangup.  Text\n"
2089 " consisting of greater than one word should be placed in quotes since the\n"
2090 " command only accepts a single argument.\n";
2091
2092 static char usage_recvchar[] =
2093 " Usage: RECEIVE CHAR <timeout>\n"
2094 "       Receives a character of text on a channel. Specify timeout to be the\n"
2095 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
2096 " do not support the reception of text. Returns the decimal value of the character\n"
2097 " if one is received, or 0 if the channel does not support text reception.  Returns\n"
2098 " -1 only on error/hangup.\n";
2099
2100 static char usage_recvtext[] =
2101 " Usage: RECEIVE TEXT <timeout>\n"
2102 "       Receives a string of text on a channel. Specify timeout to be the\n"
2103 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
2104 " do not support the reception of text. Returns -1 for failure or 1 for success, and the string in parentheses.\n";
2105
2106 static char usage_tddmode[] =
2107 " Usage: TDD MODE <on|off>\n"
2108 "       Enable/Disable TDD transmission/reception on a channel. Returns 1 if\n"
2109 " successful, or 0 if channel is not TDD-capable.\n";
2110
2111 static char usage_sendimage[] =
2112 " Usage: SEND IMAGE <image>\n"
2113 "       Sends the given image on a channel. Most channels do not support the\n"
2114 " transmission of images. Returns 0 if image is sent, or if the channel does not\n"
2115 " support image transmission.  Returns -1 only on error/hangup. Image names\n"
2116 " should not include extensions.\n";
2117
2118 static char usage_streamfile[] =
2119 " Usage: STREAM FILE <filename> <escape digits> [sample offset]\n"
2120 "       Send the given file, allowing playback to be interrupted by the given\n"
2121 " digits, if any. Use double quotes for the digits if you wish none to be\n"
2122 " permitted. If sample offset is provided then the audio will seek to sample\n"
2123 " offset before play starts.  Returns 0 if playback completes without a digit\n"
2124 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
2125 " or -1 on error or if the channel was disconnected. Remember, the file\n"
2126 " extension must not be included in the filename.\n";
2127
2128 static char usage_controlstreamfile[] =
2129 " Usage: CONTROL STREAM FILE <filename> <escape digits> [skipms] [ffchar] [rewchr] [pausechr]\n"
2130 "       Send the given file, allowing playback to be controled by the given\n"
2131 " digits, if any. Use double quotes for the digits if you wish none to be\n"
2132 " permitted.  Returns 0 if playback completes without a digit\n"
2133 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
2134 " or -1 on error or if the channel was disconnected. Remember, the file\n"
2135 " extension must not be included in the filename.\n\n"
2136 " Note: ffchar and rewchar default to * and # respectively.\n";
2137
2138 static char usage_getoption[] = 
2139 " Usage: GET OPTION <filename> <escape_digits> [timeout]\n"
2140 "       Behaves similar to STREAM FILE but used with a timeout option.\n";
2141
2142 static char usage_saynumber[] =
2143 " Usage: SAY NUMBER <number> <escape digits> [gender]\n"
2144 "       Say a given number, returning early if any of the given DTMF digits\n"
2145 " are received on the channel.  Returns 0 if playback completes without a digit\n"
2146 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
2147 " -1 on error/hangup.\n";
2148
2149 static char usage_saydigits[] =
2150 " Usage: SAY DIGITS <number> <escape digits>\n"
2151 "       Say a given digit string, returning early if any of the given DTMF digits\n"
2152 " are received on the channel. Returns 0 if playback completes without a digit\n"
2153 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
2154 " -1 on error/hangup.\n";
2155
2156 static char usage_sayalpha[] =
2157 " Usage: SAY ALPHA <number> <escape digits>\n"
2158 "       Say a given character string, returning early if any of the given DTMF digits\n"
2159 " are received on the channel. Returns 0 if playback completes without a digit\n"
2160 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
2161 " -1 on error/hangup.\n";
2162
2163 static char usage_saydate[] =
2164 " Usage: SAY DATE <date> <escape digits>\n"
2165 "       Say a given date, returning early if any of the given DTMF digits are\n"
2166 " received on the channel.  <date> is number of seconds elapsed since 00:00:00\n"
2167 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
2168 " completes without a digit being pressed, or the ASCII numerical value of the\n"
2169 " digit if one was pressed or -1 on error/hangup.\n";
2170
2171 static char usage_saytime[] =
2172 " Usage: SAY TIME <time> <escape digits>\n"
2173 "       Say a given time, returning early if any of the given DTMF digits are\n"
2174 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
2175 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
2176 " completes without a digit being pressed, or the ASCII numerical value of the\n"
2177 " digit if one was pressed or -1 on error/hangup.\n";
2178
2179 static char usage_saydatetime[] =
2180 " Usage: SAY DATETIME <time> <escape digits> [format] [timezone]\n"
2181 "       Say a given time, returning early if any of the given DTMF digits are\n"
2182 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
2183 " on January 1, 1970, Coordinated Universal Time (UTC). [format] is the format\n"
2184 " the time should be said in.  See voicemail.conf (defaults to \"ABdY\n"
2185 " 'digits/at' IMp\").  Acceptable values for [timezone] can be found in\n"
2186 " /usr/share/zoneinfo.  Defaults to machine default. Returns 0 if playback\n"
2187 " completes without a digit being pressed, or the ASCII numerical value of the\n"
2188 " digit if one was pressed or -1 on error/hangup.\n";
2189
2190 static char usage_sayphonetic[] =
2191 " Usage: SAY PHONETIC <string> <escape digits>\n"
2192 "       Say a given character string with phonetics, returning early if any of the\n"
2193 " given DTMF digits are received on the channel. Returns 0 if playback\n"
2194 " completes without a digit pressed, the ASCII numerical value of the digit\n"
2195 " if one was pressed, or -1 on error/hangup.\n";
2196
2197 static char usage_getdata[] =
2198 " Usage: GET DATA <file to be streamed> [timeout] [max digits]\n"
2199 "       Stream the given file, and recieve DTMF data. Returns the digits received\n"
2200 "from the channel at the other end.\n";
2201
2202 static char usage_setcontext[] =
2203 " Usage: SET CONTEXT <desired context>\n"
2204 "       Sets the context for continuation upon exiting the application.\n";
2205
2206 static char usage_setextension[] =
2207 " Usage: SET EXTENSION <new extension>\n"
2208 "       Changes the extension for continuation upon exiting the application.\n";
2209
2210 static char usage_setpriority[] =
2211 " Usage: SET PRIORITY <priority>\n"
2212 "       Changes the priority for continuation upon exiting the application.\n"
2213 " The priority must be a valid priority or label.\n";
2214
2215 static char usage_recordfile[] =
2216 " Usage: RECORD FILE <filename> <format> <escape digits> <timeout> \\\n"
2217 "                                          [offset samples] [BEEP] [s=silence]\n"
2218 "       Record to a file until a given dtmf digit in the sequence is received\n"
2219 " Returns -1 on hangup or error.  The format will specify what kind of file\n"
2220 " will be recorded.  The timeout is the maximum record time in milliseconds, or\n"
2221 " -1 for no timeout. \"Offset samples\" is optional, and, if provided, will seek\n"
2222 " to the offset without exceeding the end of the file.  \"silence\" is the number\n"
2223 " of seconds of silence allowed before the function returns despite the\n"
2224 " lack of dtmf digits or reaching timeout.  Silence value must be\n"
2225 " preceeded by \"s=\" and is also optional.\n";
2226
2227 static char usage_autohangup[] =
2228 " Usage: SET AUTOHANGUP <time>\n"
2229 "       Cause the channel to automatically hangup at <time> seconds in the\n"
2230 " future.  Of course it can be hungup before then as well. Setting to 0 will\n"
2231 " cause the autohangup feature to be disabled on this channel.\n";
2232
2233 static char usage_break_aagi[] =
2234 " Usage: ASYNCAGI BREAK\n"
2235 "       Break the Async AGI loop.\n";
2236
2237 static char usage_noop[] =
2238 " Usage: NoOp\n"
2239 "       Does nothing.\n";
2240
2241 static char usage_speechcreate[] =
2242 " Usage: SPEECH CREATE <engine>\n"
2243 "       Create a speech object to be used by the other Speech AGI commands.\n";
2244
2245 static char usage_speechset[] =
2246 " Usage: SPEECH SET <name> <value>\n"
2247 "       Set an engine-specific setting.\n";
2248
2249 static char usage_speechdestroy[] =
2250 " Usage: SPEECH DESTROY\n"
2251 "       Destroy the speech object created by SPEECH CREATE.\n";
2252
2253 static char usage_speechloadgrammar[] =
2254 " Usage: SPEECH LOAD GRAMMAR <grammar name> <path to grammar>\n"
2255 "       Loads the specified grammar as the specified name.\n";
2256
2257 static char usage_speechunloadgrammar[] =
2258 " Usage: SPEECH UNLOAD GRAMMAR <grammar name>\n"
2259 "       Unloads the specified grammar.\n";
2260
2261 static char usage_speechactivategrammar[] =
2262 " Usage: SPEECH ACTIVATE GRAMMAR <grammar name>\n"
2263 "       Activates the specified grammar on the speech object.\n";
2264
2265 static char usage_speechdeactivategrammar[] =
2266 " Usage: SPEECH DEACTIVATE GRAMMAR <grammar name>\n"
2267 "       Deactivates the specified grammar on the speech object.\n";
2268
2269 static char usage_speechrecognize[] =
2270 " Usage: SPEECH RECOGNIZE <prompt> <timeout> [<offset>]\n"
2271 "       Plays back given prompt while listening for speech and dtmf.\n";
2272
2273 /*!
2274  * \brief AGI commands list
2275  */
2276 static struct agi_command commands[] = {
2277         { { "answer", NULL }, handle_answer, "Answer channel", usage_answer , 0 },
2278         { { "channel", "status", NULL }, handle_channelstatus, "Returns status of the connected channel", usage_channelstatus , 0 },
2279         { { "database", "del", NULL }, handle_dbdel, "Removes database key/value", usage_dbdel , 1 },
2280         { { "database", "deltree", NULL }, handle_dbdeltree, "Removes database keytree/value", usage_dbdeltree , 1 },
2281         { { "database", "get", NULL }, handle_dbget, "Gets database value", usage_dbget , 1 },
2282         { { "database", "put", NULL }, handle_dbput, "Adds/updates database value", usage_dbput , 1 },
2283         { { "exec", NULL }, handle_exec, "Executes a given Application", usage_exec , 1 },
2284         { { "get", "data", NULL }, handle_getdata, "Prompts for DTMF on a channel", usage_getdata , 0 },
2285         { { "get", "full", "variable", NULL }, handle_getvariablefull, "Evaluates a channel expression", usage_getvariablefull , 1 },
2286         { { "get", "option", NULL }, handle_getoption, "Stream file, prompt for DTMF, with timeout", usage_getoption , 0 },
2287         { { "get", "variable", NULL }, handle_getvariable, "Gets a channel variable", usage_getvariable , 1 },
2288         { { "hangup", NULL }, handle_hangup, "Hangup the current channel", usage_hangup , 0 },
2289         { { "noop", NULL }, handle_noop, "Does nothing", usage_noop , 1 },
2290         { { "receive", "char", NULL }, handle_recvchar, "Receives one character from channels supporting it", usage_recvchar , 0 },
2291         { { "receive", "text", NULL }, handle_recvtext, "Receives text from channels supporting it", usage_recvtext , 0 },
2292         { { "record", "file", NULL }, handle_recordfile, "Records to a given file", usage_recordfile , 0 },
2293         { { "say", "alpha", NULL }, handle_sayalpha, "Says a given character string", usage_sayalpha , 0 },
2294         { { "say", "digits", NULL }, handle_saydigits, "Says a given digit string", usage_saydigits , 0 },
2295         { { "say", "number", NULL }, handle_saynumber, "Says a given number", usage_saynumber , 0 },
2296         { { "say", "phonetic", NULL }, handle_sayphonetic, "Says a given character string with phonetics", usage_sayphonetic , 0 },
2297         { { "say", "date", NULL }, handle_saydate, "Says a given date", usage_saydate , 0 },
2298         { { "say", "time", NULL }, handle_saytime, "Says a given time", usage_saytime , 0 },
2299         { { "say", "datetime", NULL }, handle_saydatetime, "Says a given time as specfied by the format given", usage_saydatetime , 0 },
2300         { { "send", "image", NULL }, handle_sendimage, "Sends images to channels supporting it", usage_sendimage , 0 },
2301         { { "send", "text", NULL }, handle_sendtext, "Sends text to channels supporting it", usage_sendtext , 0 },
2302         { { "set", "autohangup", NULL }, handle_autohangup, "Autohangup channel in some time", usage_autohangup , 0 },
2303         { { "set", "callerid", NULL }, handle_setcallerid, "Sets callerid for the current channel", usage_setcallerid , 0 },
2304         { { "set", "context", NULL }, handle_setcontext, "Sets channel context", usage_setcontext , 0 },
2305         { { "set", "extension", NULL }, handle_setextension, "Changes channel extension", usage_setextension , 0 },
2306         { { "set", "music", NULL }, handle_setmusic, "Enable/Disable Music on hold generator", usage_setmusic , 0 },
2307         { { "set", "priority", NULL }, handle_setpriority, "Set channel dialplan priority", usage_setpriority , 0 },
2308         { { "set", "variable", NULL }, handle_setvariable, "Sets a channel variable", usage_setvariable , 1 },
2309         { { "stream", "file", NULL }, handle_streamfile, "Sends audio file on channel", usage_streamfile , 0 },
2310         { { "control", "stream", "file", NULL }, handle_controlstreamfile, "Sends audio file on channel and allows the listner to control the stream", usage_controlstreamfile , 0 },
2311         { { "tdd", "mode", NULL }, handle_tddmode, "Toggles TDD mode (for the deaf)", usage_tddmode , 0 },
2312         { { "verbose", NULL }, handle_verbose, "Logs a message to the asterisk verbose log", usage_verbose , 1 },
2313         { { "wait", "for", "digit", NULL }, handle_waitfordigit, "Waits for a digit to be pressed", usage_waitfordigit , 0 },
2314         { { "speech", "create", NULL }, handle_speechcreate, "Creates a speech object", usage_speechcreate, 0 },
2315         { { "speech", "set", NULL }, handle_speechset, "Sets a speech engine setting", usage_speechset, 0 },
2316         { { "speech", "destroy", NULL }, handle_speechdestroy, "Destroys a speech object", usage_speechdestroy, 1 },
2317         { { "speech", "load", "grammar", NULL }, handle_speechloadgrammar, "Loads a grammar", usage_speechloadgrammar, 0 },
2318         { { "speech", "unload", "grammar", NULL }, handle_speechunloadgrammar, "Unloads a grammar", usage_speechunloadgrammar, 1 },
2319         { { "speech", "activate", "grammar", NULL }, handle_speechactivategrammar, "Activates a grammar", usage_speechactivategrammar, 0 },
2320         { { "speech", "deactivate", "grammar", NULL }, handle_speechdeactivategrammar, "Deactivates a grammar", usage_speechdeactivategrammar, 0 },
2321         { { "speech", "recognize", NULL }, handle_speechrecognize, "Recognizes speech", usage_speechrecognize, 0 },
2322         { { "asyncagi", "break", NULL }, handle_asyncagi_break, "Break AsyncAGI loop", usage_break_aagi, 0 },
2323 };
2324
2325 static AST_RWLIST_HEAD_STATIC(agi_commands, agi_command);
2326
2327 static char *help_workhorse(int fd, char *match[])
2328 {
2329         char fullcmd[80], matchstr[80];
2330         struct agi_command *e;
2331
2332         if (match)
2333                 ast_join(matchstr, sizeof(matchstr), match);
2334
2335         ast_cli(fd, "%5.5s %30.30s   %s\n","Dead","Command","Description");
2336         AST_RWLIST_RDLOCK(&agi_commands);
2337         AST_RWLIST_TRAVERSE(&agi_commands, e, list) {
2338                 if (!e->cmda[0])
2339                         break;
2340                 /* Hide commands that start with '_' */
2341                 if ((e->cmda[0])[0] == '_')
2342                         continue;
2343                 ast_join(fullcmd, sizeof(fullcmd), e->cmda);
2344                 if (match && strncasecmp(matchstr, fullcmd, strlen(matchstr)))
2345                         continue;
2346                 ast_cli(fd, "%5.5s %30.30s   %s\n", e->dead ? "Yes" : "No" , fullcmd, e->summary);
2347         }
2348         AST_RWLIST_UNLOCK(&agi_commands);
2349
2350         return CLI_SUCCESS;
2351 }
2352
2353 int ast_agi_register(struct ast_module *mod, agi_command *cmd)
2354 {
2355         char fullcmd[80];
2356
2357         ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
2358
2359         if (!find_command(cmd->cmda,1)) {
2360                 cmd->mod = mod;
2361                 AST_RWLIST_WRLOCK(&agi_commands);
2362                 AST_LIST_INSERT_TAIL(&agi_commands, cmd, list);
2363                 AST_RWLIST_UNLOCK(&agi_commands);
2364                 if (mod != ast_module_info->self)
2365                         ast_module_ref(ast_module_info->self);
2366                 ast_verb(2, "AGI Command '%s' registered\n",fullcmd);
2367                 return 1;
2368         } else {
2369                 ast_log(LOG_WARNING, "Command already registered!\n");
2370                 return 0;
2371         }
2372 }
2373
2374 int ast_agi_unregister(struct ast_module *mod, agi_command *cmd)
2375 {
2376         struct agi_command *e;
2377         int unregistered = 0;
2378         char fullcmd[80];
2379         
2380         ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
2381
2382         AST_RWLIST_WRLOCK(&agi_commands);
2383         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&agi_commands, e, list) {
2384                 if (cmd == e) {
2385                         AST_RWLIST_REMOVE_CURRENT(list);
2386                         if (mod != ast_module_info->self)
2387                                 ast_module_unref(ast_module_info->self);
2388                         unregistered=1;
2389                         break;
2390                 }
2391         }
2392         AST_RWLIST_TRAVERSE_SAFE_END;
2393         AST_RWLIST_UNLOCK(&agi_commands);
2394         if (unregistered)
2395                 ast_verb(2, "AGI Command '%s' unregistered\n",fullcmd);
2396         else
2397                 ast_log(LOG_WARNING, "Unable to unregister command: '%s'!\n",fullcmd);
2398         return unregistered;
2399 }
2400
2401 void ast_agi_register_multiple(struct ast_module *mod, agi_command *cmd, int len)
2402 {
2403         int i;
2404
2405         for (i = 0; i < len; i++)
2406                 ast_agi_register(mod, cmd + i);
2407
2408 }
2409
2410 void ast_agi_unregister_multiple(struct ast_module *mod, agi_command *cmd, int len)
2411 {
2412         int i;
2413
2414         for (i = 0; i < len; i++)
2415                 ast_agi_unregister(mod, cmd + i);
2416 }
2417
2418 static agi_command *find_command(char *cmds[], int exact)
2419 {
2420         int y, match;
2421         struct agi_command *e;
2422
2423         AST_RWLIST_RDLOCK(&agi_commands);
2424         AST_RWLIST_TRAVERSE(&agi_commands, e, list) {
2425                 if (!e->cmda[0])
2426                         break;
2427                 /* start optimistic */
2428                 match = 1;
2429                 for (y = 0; match && cmds[y]; y++) {
2430                         /* If there are no more words in the command (and we're looking for
2431                            an exact match) or there is a difference between the two words,
2432                            then this is not a match */
2433                         if (!e->cmda[y] && !exact)
2434                                 break;
2435                         /* don't segfault if the next part of a command doesn't exist */
2436                         if (!e->cmda[y])
2437                                 return NULL;
2438                         if (strcasecmp(e->cmda[y], cmds[y]))
2439                                 match = 0;
2440                 }
2441                 /* If more words are needed to complete the command then this is not
2442                    a candidate (unless we're looking for a really inexact answer  */
2443                 if ((exact > -1) && e->cmda[y])
2444                         match = 0;
2445                 if (match)
2446                         return e;
2447         }
2448         AST_RWLIST_UNLOCK(&agi_commands);
2449         return NULL;
2450 }
2451
2452 static int parse_args(char *s, int *max, char *argv[])
2453 {
2454         int x = 0, quoted = 0, escaped = 0, whitespace = 1;
2455         char *cur;
2456
2457         cur = s;
2458         while(*s) {
2459                 switch(*s) {
2460                 case '"':
2461                         /* If it's escaped, put a literal quote */
2462                         if (escaped) 
2463                                 goto normal;
2464                         else 
2465                                 quoted = !quoted;
2466                         if (quoted && whitespace) {
2467                                 /* If we're starting a quote, coming off white space start a new word, too */
2468                                 argv[x++] = cur;
2469                                 whitespace=0;
2470                         }
2471                         escaped = 0;
2472                 break;
2473                 case ' ':
2474                 case '\t':
2475                         if (!quoted && !escaped) {
2476                                 /* If we're not quoted, mark this as whitespace, and
2477                                    end the previous argument */
2478                                 whitespace = 1;
2479                                 *(cur++) = '\0';
2480                         } else
2481                                 /* Otherwise, just treat it as anything else */ 
2482                                 goto normal;
2483                         break;
2484                 case '\\':
2485                         /* If we're escaped, print a literal, otherwise enable escaping */
2486                         if (escaped) {
2487                                 goto normal;
2488                         } else {
2489                                 escaped=1;
2490                         }
2491                         break;
2492                 default:
2493 normal:
2494                         if (whitespace) {
2495                                 if (x >= MAX_ARGS -1) {
2496                                         ast_log(LOG_WARNING, "Too many arguments, truncating\n");
2497                                         break;
2498                                 }
2499                                 /* Coming off of whitespace, start the next argument */
2500                                 argv[x++] = cur;
2501                                 whitespace=0;
2502                         }
2503                         *(cur++) = *s;
2504                         escaped=0;
2505                 }
2506                 s++;
2507         }
2508         /* Null terminate */
2509         *(cur++) = '\0';
2510         argv[x] = NULL;
2511         *max = x;
2512         return 0;
2513 }
2514
2515 static int agi_handle_command(struct ast_channel *chan, AGI *agi, char *buf, int dead)
2516 {
2517         char *argv[MAX_ARGS];
2518         int argc = MAX_ARGS, res;
2519         agi_command *c;
2520         const char *ami_res = "Unknown Result";
2521         char *ami_cmd = ast_strdupa(buf);
2522         int command_id = ast_random(), resultcode = 200;
2523
2524         manager_event(EVENT_FLAG_CALL, "AGIExec", 
2525                         "SubEvent: Start\r\n"
2526                         "Channel: %s\r\n"
2527                         "CommandId: %d\r\n"
2528                         "Command: %s\r\n", chan->name, command_id, ami_cmd);
2529         parse_args(buf, &argc, argv);
2530         if ((c = find_command(argv, 0)) && (!dead || (dead && c->dead))) {
2531                 /* if this command wasnt registered by res_agi, be sure to usecount
2532                 the module we are using */
2533                 if (c->mod != ast_module_info->self)
2534                         ast_module_ref(c->mod);
2535                 res = c->handler(chan, agi, argc, argv);
2536                 if (c->mod != ast_module_info->self)
2537                         ast_module_unref(c->mod);
2538                 switch (res) {
2539                 case RESULT_SHOWUSAGE: ami_res = "Usage"; resultcode = 520; break;
2540                 case AST_PBX_KEEPALIVE: ami_res = "KeepAlive"; resultcode = 210; break;
2541                 case RESULT_FAILURE: ami_res = "Failure"; resultcode = -1; break;
2542                 case RESULT_SUCCESS: ami_res = "Success"; resultcode = 200; break;
2543                 }
2544                 manager_event(EVENT_FLAG_CALL, "AGIExec",
2545                                 "SubEvent: End\r\n"
2546                                 "Channel: %s\r\n"
2547                                 "CommandId: %d\r\n"
2548                                 "Command: %s\r\n"
2549                                 "ResultCode: %d\r\n"
2550                                 "Result: %s\r\n", chan->name, command_id, ami_cmd, resultcode, ami_res);
2551                 switch(res) {
2552                 case RESULT_SHOWUSAGE:
2553                         ast_agi_fdprintf(chan, agi->fd, "520-Invalid command syntax.  Proper usage follows:\n");
2554                         ast_agi_fdprintf(chan, agi->fd, c->usage);
2555                         ast_agi_fdprintf(chan, agi->fd, "520 End of proper usage.\n");
2556                         break;
2557                 case AST_PBX_KEEPALIVE:
2558                         /* We've been asked to keep alive, so do so */
2559                         return AST_PBX_KEEPALIVE;
2560                         break;
2561                 case RESULT_FAILURE:
2562                         /* They've already given the failure.  We've been hung up on so handle this
2563                            appropriately */
2564                         return -1;
2565                 }
2566         } else if ((c = find_command(argv, 0))) {
2567                 ast_agi_fdprintf(chan, agi->fd, "511 Command Not Permitted on a dead channel\n");
2568                 manager_event(EVENT_FLAG_CALL, "AGIExec",
2569                                 "SubEvent: End\r\n"
2570                                 "Channel: %s\r\n"
2571                                 "CommandId: %d\r\n"
2572                                 "Command: %s\r\n"
2573                                 "ResultCode: 511\r\n"
2574                                 "Result: Command not permitted on a dead channel\r\n", chan->name, command_id, ami_cmd);
2575         } else {
2576                 ast_agi_fdprintf(chan, agi->fd, "510 Invalid or unknown command\n");
2577                 manager_event(EVENT_FLAG_CALL, "AGIExec",
2578                                 "SubEvent: End\r\n"
2579                                 "Channel: %s\r\n"
2580                                 "CommandId: %d\r\n"
2581                                 "Command: %s\r\n"
2582                                 "ResultCode: 510\r\n"
2583                                 "Result: Invalid or unknown command\r\n", chan->name, command_id, ami_cmd);
2584         }
2585         return 0;
2586 }
2587 static enum agi_result run_agi(struct ast_channel *chan, char *request, AGI *agi, int pid, int *status, int dead, int argc, char *argv[])
2588 {
2589         struct ast_channel *c;
2590         int outfd, ms, needhup = 0;
2591         enum agi_result returnstatus = AGI_RESULT_SUCCESS;
2592         struct ast_frame *f;
2593         char buf[AGI_BUF_LEN];
2594         char *res = NULL;
2595         FILE *readf;
2596         /* how many times we'll retry if ast_waitfor_nandfs will return without either 
2597           channel or file descriptor in case select is interrupted by a system call (EINTR) */
2598         int retry = AGI_NANDFS_RETRY;
2599
2600         if (!(readf = fdopen(agi->ctrl, "r"))) {
2601                 ast_log(LOG_WARNING, "Unable to fdopen file descriptor\n");
2602                 if (pid > -1)
2603                         kill(pid, SIGHUP);
2604                 close(agi->ctrl);
2605                 return AGI_RESULT_FAILURE;
2606         }
2607         setlinebuf(readf);
2608         setup_env(chan, request, agi->fd, (agi->audio > -1), argc, argv);
2609         for (;;) {
2610                 if (needhup) {
2611                         needhup = 0;
2612                         dead = 1;
2613                         if (pid > -1)
2614                                 kill(pid, SIGHUP);
2615                 }
2616                 ms = -1;
2617                 c = ast_waitfor_nandfds(&chan, dead ? 0 : 1, &agi->ctrl, 1, NULL, &outfd, &ms);
2618                 if (c) {
2619                         retry = AGI_NANDFS_RETRY;
2620                         /* Idle the channel until we get a command */
2621                         f = ast_read(c);
2622                         if (!f) {
2623                                 ast_debug(1, "%s hungup\n", chan->name);
2624                                 returnstatus = AGI_RESULT_HANGUP;
2625                                 needhup = 1;
2626                                 continue;
2627                         } else {
2628                                 /* If it's voice, write it to the audio pipe */
2629                                 if ((agi->audio > -1) && (f->frametype == AST_FRAME_VOICE)) {
2630                                         /* Write, ignoring errors */
2631                                         write(agi->audio, f->data, f->datalen);
2632                                 }
2633                                 ast_frfree(f);
2634                         }
2635                 } else if (outfd > -1) {
2636                         size_t len = sizeof(buf);
2637                         size_t buflen = 0;
2638
2639                         retry = AGI_NANDFS_RETRY;
2640                         buf[0] = '\0';
2641
2642                         while (buflen < (len - 1)) {
2643                                 res = fgets(buf + buflen, len, readf);
2644                                 if (feof(readf)) 
2645                                         break;
2646                                 if (ferror(readf) && ((errno != EINTR) && (errno != EAGAIN))) 
2647                                         break;
2648                                 if (res != NULL && !agi->fast)
2649                                         break;
2650                                 buflen = strlen(buf);
2651                                 if (buflen && buf[buflen - 1] == '\n')
2652                                         break;
2653                                 len -= buflen;
2654                                 if (agidebug)
2655                                         ast_verbose( "AGI Rx << temp buffer %s - errno %s\n", buf, strerror(errno));
2656                         }
2657
2658                         if (!buf[0]) {
2659                                 /* Program terminated */
2660                                 if (returnstatus && returnstatus != AST_PBX_KEEPALIVE)
2661                                         returnstatus = -1;
2662                                 ast_verb(3, "<%s>AGI Script %s completed, returning %d\n", chan->name, request, returnstatus);
2663                                 if (pid > 0)
2664                                         waitpid(pid, status, 0);
2665                                 /* No need to kill the pid anymore, since they closed us */
2666                                 pid = -1;
2667                                 break;
2668                         }
2669
2670                         /* get rid of trailing newline, if any */
2671                         if (*buf && buf[strlen(buf) - 1] == '\n')
2672                                 buf[strlen(buf) - 1] = 0;
2673                         if (agidebug)
2674                                 ast_verbose("<%s>AGI Rx << %s\n", chan->name, buf);
2675                         returnstatus |= agi_handle_command(chan, agi, buf, dead);
2676                         /* If the handle_command returns -1, we need to stop */
2677                         if ((returnstatus < 0) || (returnstatus == AST_PBX_KEEPALIVE)) {
2678                                 needhup = 1;
2679                                 continue;
2680                         }
2681                 } else {
2682                         if (--retry <= 0) {
2683                                 ast_log(LOG_WARNING, "No channel, no fd?\n");
2684                                 returnstatus = AGI_RESULT_FAILURE;
2685                                 break;
2686                         }
2687                 }
2688         }
2689         /* Notify process */
2690         if (pid > -1) {
2691                 const char *sighup = pbx_builtin_getvar_helper(chan, "AGISIGHUP");
2692                 if (ast_strlen_zero(sighup) || !ast_false(sighup)) {
2693                         if (kill(pid, SIGHUP))
2694                                 ast_log(LOG_WARNING, "unable to send SIGHUP to AGI process %d: %s\n", pid, strerror(errno));
2695                 }
2696         }
2697         fclose(readf);
2698         return returnstatus;
2699 }
2700
2701 static char *handle_cli_agi_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2702 {
2703         struct agi_command *command;
2704         char fullcmd[80];
2705
2706         switch (cmd) {
2707         case CLI_INIT:
2708                 e->command = "agi show";
2709                 e->usage =
2710                         "Usage: agi show [topic]\n"
2711                         "       When called with a topic as an argument, displays usage\n"
2712                         "       information on the given command.  If called without a\n"
2713                         "       topic, it provides a list of AGI commands.\n";
2714                 break;
2715         case CLI_GENERATE:
2716                 return NULL;
2717         }
2718         if (a->argc < e->args)
2719                 return CLI_SHOWUSAGE;
2720         if (a->argc > e->args) {
2721                 command = find_command(a->argv + e->args, 1);
2722                 if (command) {
2723                         ast_cli(a->fd, command->usage);
2724                         ast_cli(a->fd, " Runs Dead : %s\n", command->dead ? "Yes" : "No");
2725                 } else {
2726                         if (find_command(a->argv + e->args, -1)) {
2727                                 return help_workhorse(a->fd, a->argv + e->args);
2728                         } else {
2729                                 ast_join(fullcmd, sizeof(fullcmd), a->argv + e->args);
2730                                 ast_cli(a->fd, "No such command '%s'.\n", fullcmd);
2731                         }
2732                 }
2733         } else {
2734                 return help_workhorse(a->fd, NULL);
2735         }
2736         return CLI_SUCCESS;
2737 }
2738
2739 /*! \brief Convert string to use HTML escaped characters
2740         \note Maybe this should be a generic function?
2741 */
2742 static void write_html_escaped(FILE *htmlfile, char *str)
2743 {
2744         char *cur = str;
2745
2746         while(*cur) {
2747                 switch (*cur) {
2748                 case '<':
2749                         fprintf(htmlfile, "%s", "&lt;");
2750                         break;
2751                 case '>':
2752                         fprintf(htmlfile, "%s", "&gt;");
2753                         break;
2754                 case '&':
2755                         fprintf(htmlfile, "%s", "&amp;");
2756                         break;
2757                 case '"':
2758                         fprintf(htmlfile, "%s", "&quot;");
2759                         break;
2760                 default:
2761                         fprintf(htmlfile, "%c", *cur);
2762                         break;
2763                 }
2764                 cur++;
2765         }
2766
2767         return;
2768 }
2769
2770 static char *handle_cli_agi_dumphtml(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2771 {
2772         struct agi_command *command;
2773         char fullcmd[80];
2774         FILE *htmlfile;
2775
2776         switch (cmd) {
2777         case CLI_INIT:
2778                 e->command = "agi dumphtml";
2779                 e->usage =
2780                         "Usage: agi dumphtml <filename>\n"
2781                         "       Dumps the AGI command list in HTML format to the given\n"
2782                         "       file.\n";
2783                 return NULL;
2784         case CLI_GENERATE:
2785                 return NULL;
2786         }
2787         if (a->argc < e->args + 1)
2788                 return CLI_SHOWUSAGE;
2789
2790         if (!(htmlfile = fopen(a->argv[2], "wt"))) {
2791                 ast_cli(a->fd, "Could not create file '%s'\n", a->argv[2]);
2792                 return CLI_SHOWUSAGE;
2793         }
2794
2795         fprintf(htmlfile, "<HTML>\n<HEAD>\n<TITLE>AGI Commands</TITLE>\n</HEAD>\n");
2796         fprintf(htmlfile, "<BODY>\n<CENTER><B><H1>AGI Commands</H1></B></CENTER>\n\n");
2797         fprintf(htmlfile, "<TABLE BORDER=\"0\" CELLSPACING=\"10\">\n");
2798
2799         AST_RWLIST_RDLOCK(&agi_commands);
2800         AST_RWLIST_TRAVERSE(&agi_commands, command, list) {
2801                 char *stringp, *tempstr;
2802  
2803                 if (!command->cmda[0])  /* end ? */
2804                         break;
2805                 /* Hide commands that start with '_' */
2806                 if ((command->cmda[0])[0] == '_')
2807                         continue;
2808                 ast_join(fullcmd, sizeof(fullcmd), command->cmda);
2809
2810                 fprintf(htmlfile, "<TR><TD><TABLE BORDER=\"1\" CELLPADDING=\"5\" WIDTH=\"100%%\">\n");
2811                 fprintf(htmlfile, "<TR><TH ALIGN=\"CENTER\"><B>%s - %s</B></TH></TR>\n", fullcmd, command->summary);
2812
2813                 stringp = command->usage;
2814                 tempstr = strsep(&stringp, "\n");
2815
2816                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">");
2817                 write_html_escaped(htmlfile, tempstr);
2818                 fprintf(htmlfile, "</TD></TR>\n");
2819                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">\n");
2820
2821                 while ((tempstr = strsep(&stringp, "\n")) != NULL) {
2822                         write_html_escaped(htmlfile, tempstr);
2823                         fprintf(htmlfile, "<BR>\n");
2824                 }
2825                 fprintf(htmlfile, "</TD></TR>\n");
2826                 fprintf(htmlfile, "</TABLE></TD></TR>\n\n");
2827         }
2828         AST_RWLIST_UNLOCK(&agi_commands);
2829         fprintf(htmlfile, "</TABLE>\n</BODY>\n</HTML>\n");
2830         fclose(htmlfile);
2831         ast_cli(a->fd, "AGI HTML commands dumped to: %s\n", a->argv[2]);
2832         return CLI_SUCCESS;
2833 }
2834
2835 static int agi_exec_full(struct ast_channel *chan, void *data, int enhanced, int dead)
2836 {
2837         enum agi_result res;
2838         struct ast_module_user *u;
2839         char buf[AGI_BUF_LEN] = "", *tmp = buf;
2840         int fds[2], efd = -1, pid;
2841         AST_DECLARE_APP_ARGS(args,
2842                 AST_APP_ARG(arg)[MAX_ARGS];
2843         );
2844         AGI agi;
2845
2846         if (ast_strlen_zero(data)) {
2847                 ast_log(LOG_WARNING, "AGI requires an argument (script)\n");
2848                 return -1;
2849         }
2850         if (dead)
2851                 ast_log(LOG_NOTICE, "Hungup channel detected, running agi in dead mode.\n");
2852         ast_copy_string(buf, data, sizeof(buf));
2853         memset(&agi, 0, sizeof(agi));
2854         AST_STANDARD_APP_ARGS(args, tmp);
2855         args.argv[args.argc] = NULL;
2856
2857         u = ast_module_user_add(chan);
2858 #if 0
2859          /* Answer if need be */
2860         if (chan->_state != AST_STATE_UP) {
2861                 if (ast_answer(chan)) {
2862                         ast_module_user_remove(u);
2863                         return -1;
2864                 }
2865         }
2866 #endif
2867         res = launch_script(chan, args.argv[0], args.argv, fds, enhanced ? &efd : NULL, &pid);
2868         /* Async AGI do not require run_agi(), so just proceed if normal AGI
2869            or Fast AGI are setup with success. */
2870         if (res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) {
2871                 int status = 0;
2872                 agi.fd = fds[1];
2873                 agi.ctrl = fds[0];
2874                 agi.audio = efd;
2875                 agi.fast = (res == AGI_RESULT_SUCCESS_FAST) ? 1 : 0;
2876                 res = run_agi(chan, args.argv[0], &agi, pid, &status, dead, args.argc, args.argv);
2877                 /* If the fork'd process returns non-zero, set AGISTATUS to FAILURE */
2878                 if ((res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) && status)
2879                         res = AGI_RESULT_FAILURE;
2880                 if (fds[1] != fds[0])
2881                         close(fds[1]);
2882                 if (efd > -1)
2883                         close(efd);
2884                 ast_unreplace_sigchld();
2885         } 
2886         ast_module_user_remove(u);
2887
2888         switch (res) {
2889         case AGI_RESULT_SUCCESS:
2890         case AGI_RESULT_SUCCESS_FAST:
2891         case AGI_RESULT_SUCCESS_ASYNC:
2892                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "SUCCESS");
2893                 break;
2894         case AGI_RESULT_FAILURE:
2895                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "FAILURE");
2896                 break;
2897         case AGI_RESULT_NOTFOUND:
2898                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "NOTFOUND");
2899                 break;
2900         case AGI_RESULT_HANGUP:
2901                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "HANGUP");
2902                 return -1;
2903         }
2904
2905         return 0;
2906 }
2907
2908 static int agi_exec(struct ast_channel *chan, void *data)
2909 {
2910         if (!ast_check_hangup(chan))
2911                 return agi_exec_full(chan, data, 0, 0);
2912         else
2913                 return agi_exec_full(chan, data, 0, 1);
2914 }
2915
2916 static int eagi_exec(struct ast_channel *chan, void *data)
2917 {
2918         int readformat, res;
2919
2920         if (ast_check_hangup(chan)) {
2921                 ast_log(LOG_ERROR, "If you want to run AGI on hungup channels you should use DeadAGI!\n");
2922                 return 0;
2923         }
2924         readformat = chan->readformat;
2925         if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
2926                 ast_log(LOG_WARNING, "Unable to set channel '%s' to linear mode\n", chan->name);
2927                 return -1;
2928         }
2929         res = agi_exec_full(chan, data, 1, 0);
2930         if (!res) {
2931                 if (ast_set_read_format(chan, readformat)) {
2932                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %s\n", chan->name, ast_getformatname(readformat));
2933                 }
2934         }
2935         return res;
2936 }
2937
2938 static int deadagi_exec(struct ast_channel *chan, void *data)
2939 {
2940         ast_log(LOG_WARNING, "DeadAGI has been deprecated, please use AGI in all cases!\n");
2941         return agi_exec(chan, data);
2942 }
2943
2944 static struct ast_cli_entry cli_agi[] = {
2945         AST_CLI_DEFINE(handle_cli_agi_add_cmd,   "Add AGI command to a channel in Async AGI"),
2946         AST_CLI_DEFINE(handle_cli_agi_debug,    "Enable/Disable AGI debugging"),
2947         AST_CLI_DEFINE(handle_cli_agi_show,     "List AGI commands or specific help"),
2948         AST_CLI_DEFINE(handle_cli_agi_dumphtml, "Dumps a list of AGI commands in HTML format")
2949 };
2950
2951 static int unload_module(void)
2952 {
2953         ast_cli_unregister_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2954         ast_agi_unregister_multiple(ast_module_info->self, commands, sizeof(commands) / sizeof(struct agi_command));
2955         ast_unregister_application(eapp);
2956         ast_unregister_application(deadapp);
2957         ast_manager_unregister("AGI");
2958         return ast_unregister_application(app);
2959 }
2960
2961 static int load_module(void)
2962 {
2963         ast_cli_register_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2964         ast_agi_register_multiple(ast_module_info->self, commands, sizeof(commands) / sizeof(struct agi_command));
2965         ast_register_application(deadapp, deadagi_exec, deadsynopsis, descrip);
2966         ast_register_application(eapp, eagi_exec, esynopsis, descrip);
2967         ast_manager_register2("AGI", EVENT_FLAG_CALL, action_add_agi_cmd, "Add an AGI command to execute by Async AGI", mandescr_asyncagi);
2968         return ast_register_application(app, agi_exec, synopsis, descrip);
2969 }
2970
2971 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Asterisk Gateway Interface (AGI)",
2972                 .load = load_module,
2973                 .unload = unload_module,
2974                 );