It is no longer required for each module that deals with a channel to call ast_module...
[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 <sys/types.h>
31 #include <netdb.h>
32 #include <sys/socket.h>
33 #include <netinet/in.h>
34 #include <netinet/tcp.h>
35 #include <arpa/inet.h>
36 #include <math.h>
37 #include <stdlib.h>
38 #include <unistd.h>
39 #include <string.h>
40 #include <stdlib.h>
41 #include <signal.h>
42 #include <sys/time.h>
43 #include <stdio.h>
44 #include <fcntl.h>
45 #include <errno.h>
46 #include <sys/wait.h>
47 #include <sys/stat.h>
48
49 #include "asterisk/file.h"
50 #include "asterisk/logger.h"
51 #include "asterisk/channel.h"
52 #include "asterisk/pbx.h"
53 #include "asterisk/module.h"
54 #include "asterisk/astdb.h"
55 #include "asterisk/callerid.h"
56 #include "asterisk/cli.h"
57 #include "asterisk/logger.h"
58 #include "asterisk/options.h"
59 #include "asterisk/image.h"
60 #include "asterisk/say.h"
61 #include "asterisk/app.h"
62 #include "asterisk/dsp.h"
63 #include "asterisk/musiconhold.h"
64 #include "asterisk/utils.h"
65 #include "asterisk/lock.h"
66 #include "asterisk/strings.h"
67 #include "asterisk/agi.h"
68
69 #define MAX_ARGS 128
70 #define MAX_COMMANDS 128
71
72 /* Recycle some stuff from the CLI interface */
73 #define fdprintf agi_debug_cli
74
75 static char *app = "AGI";
76
77 static char *eapp = "EAGI";
78
79 static char *deadapp = "DeadAGI";
80
81 static char *synopsis = "Executes an AGI compliant application";
82 static char *esynopsis = "Executes an EAGI compliant application";
83 static char *deadsynopsis = "Executes AGI on a hungup channel";
84
85 static char *descrip =
86 "  [E|Dead]AGI(command|args): Executes an Asterisk Gateway Interface compliant\n"
87 "program on a channel. AGI allows Asterisk to launch external programs\n"
88 "written in any language to control a telephony channel, play audio,\n"
89 "read DTMF digits, etc. by communicating with the AGI protocol on stdin\n"
90 "and stdout.\n"
91 "  This channel will stop dialplan execution on hangup inside of this\n"
92 "application, except when using DeadAGI.  Otherwise, dialplan execution\n"
93 "will continue normally.\n"
94 "  A locally executed AGI script will receive SIGHUP on hangup from the channel\n"
95 "except when using DeadAGI. This can be disabled by setting the AGISIGHUP channel\n"
96 "variable to \"no\" before executing the AGI application.\n"
97 "  Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n"
98 "on file descriptor 3\n\n"
99 "  Use the CLI command 'agi show' to list available agi commands\n"
100 "  This application sets the following channel variable upon completion:\n"
101 "     AGISTATUS      The status of the attempt to the run the AGI script\n"
102 "                    text string, one of SUCCESS | FAILED | NOTFOUND | HANGUP\n";
103
104 static int agidebug = 0;
105
106 #define TONE_BLOCK_SIZE 200
107
108 /* Max time to connect to an AGI remote host */
109 #define MAX_AGI_CONNECT 2000
110
111 #define AGI_PORT 4573
112
113 enum agi_result {
114         AGI_RESULT_SUCCESS,
115         AGI_RESULT_FAILURE,
116         AGI_RESULT_NOTFOUND,
117         AGI_RESULT_HANGUP,
118 };
119
120 static void agi_debug_cli(int fd, char *fmt, ...)
121 {
122         char *stuff;
123         int res = 0;
124
125         va_list ap;
126         va_start(ap, fmt);
127         res = vasprintf(&stuff, fmt, ap);
128         va_end(ap);
129
130         if (res == -1) {
131                 ast_log(LOG_ERROR, "Out of memory\n");
132                 return;
133         }
134
135         if (agidebug)
136                 ast_verbose("AGI Tx >> %s\n", stuff);
137         ast_carefulwrite(fd, stuff, strlen(stuff), 100);
138         ast_free(stuff);
139 }
140
141 /* launch_netscript: The fastagi handler.
142         FastAGI defaults to port 4573 */
143 static enum agi_result launch_netscript(char *agiurl, char *argv[], int *fds, int *efd, int *opid)
144 {
145         int s, flags, res, port = AGI_PORT;
146         struct pollfd pfds[1];
147         char *host, *c, *script = "";
148         struct sockaddr_in sin;
149         struct hostent *hp;
150         struct ast_hostent ahp;
151
152         /* agiusl is "agi://host.domain[:port][/script/name]" */
153         host = ast_strdupa(agiurl + 6); /* Remove agi:// */
154         /* Strip off any script name */
155         if ((c = strchr(host, '/'))) {
156                 *c = '\0';
157                 c++;
158                 script = c;
159         }
160         if ((c = strchr(host, ':'))) {
161                 *c = '\0';
162                 c++;
163                 port = atoi(c);
164         }
165         if (efd) {
166                 ast_log(LOG_WARNING, "AGI URI's don't support Enhanced AGI yet\n");
167                 return -1;
168         }
169         if (!(hp = ast_gethostbyname(host, &ahp))) {
170                 ast_log(LOG_WARNING, "Unable to locate host '%s'\n", host);
171                 return -1;
172         }
173         if ((s = socket(AF_INET, SOCK_STREAM, 0)) < 0) {
174                 ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno));
175                 return -1;
176         }
177         if ((flags = fcntl(s, F_GETFL)) < 0) {
178                 ast_log(LOG_WARNING, "Fcntl(F_GETFL) failed: %s\n", strerror(errno));
179                 close(s);
180                 return -1;
181         }
182         if (fcntl(s, F_SETFL, flags | O_NONBLOCK) < 0) {
183                 ast_log(LOG_WARNING, "Fnctl(F_SETFL) failed: %s\n", strerror(errno));
184                 close(s);
185                 return -1;
186         }
187         memset(&sin, 0, sizeof(sin));
188         sin.sin_family = AF_INET;
189         sin.sin_port = htons(port);
190         memcpy(&sin.sin_addr, hp->h_addr, sizeof(sin.sin_addr));
191         if (connect(s, (struct sockaddr *)&sin, sizeof(sin)) && (errno != EINPROGRESS)) {
192                 ast_log(LOG_WARNING, "Connect failed with unexpected error: %s\n", strerror(errno));
193                 close(s);
194                 return AGI_RESULT_FAILURE;
195         }
196
197         pfds[0].fd = s;
198         pfds[0].events = POLLOUT;
199         while ((res = poll(pfds, 1, MAX_AGI_CONNECT)) != 1) {
200                 if (errno != EINTR) {
201                         if (!res) {
202                                 ast_log(LOG_WARNING, "FastAGI connection to '%s' timed out after MAX_AGI_CONNECT (%d) milliseconds.\n",
203                                         agiurl, MAX_AGI_CONNECT);
204                         } else
205                                 ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
206                         close(s);
207                         return AGI_RESULT_FAILURE;
208                 }
209         }
210         /* XXX in theory should check for partial writes... */
211         while (write(s, "agi_network: yes\n", strlen("agi_network: yes\n")) < 0) {
212                 if (errno != EINTR) {
213                         ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
214                         close(s);
215                         return AGI_RESULT_FAILURE;
216                 }
217         }
218
219         /* If we have a script parameter, relay it to the fastagi server */
220         /* Script parameters take the form of: AGI(agi://my.example.com/?extension=${EXTEN}) */
221         if (!ast_strlen_zero(script))
222                 fdprintf(s, "agi_network_script: %s\n", script);
223
224         ast_debug(4, "Wow, connected!\n");
225         fds[0] = s;
226         fds[1] = s;
227         *opid = -1;
228         return AGI_RESULT_SUCCESS;
229 }
230
231 static enum agi_result launch_script(char *script, char *argv[], int *fds, int *efd, int *opid)
232 {
233         char tmp[256];
234         int pid, toast[2], fromast[2], audio[2], x, res;
235         sigset_t signal_set, old_set;
236         struct stat st;
237
238         if (!strncasecmp(script, "agi://", 6))
239                 return launch_netscript(script, argv, fds, efd, opid);
240         
241         if (script[0] != '/') {
242                 snprintf(tmp, sizeof(tmp), "%s/%s", ast_config_AST_AGI_DIR, script);
243                 script = tmp;
244         }
245
246         /* Before even trying let's see if the file actually exists */
247         if (stat(script, &st)) {
248                 ast_log(LOG_WARNING, "Failed to execute '%s': File does not exist.\n", script);
249                 return AGI_RESULT_NOTFOUND;
250         }
251
252         if (pipe(toast)) {
253                 ast_log(LOG_WARNING, "Unable to create toast pipe: %s\n",strerror(errno));
254                 return AGI_RESULT_FAILURE;
255         }
256         if (pipe(fromast)) {
257                 ast_log(LOG_WARNING, "unable to create fromast pipe: %s\n", strerror(errno));
258                 close(toast[0]);
259                 close(toast[1]);
260                 return AGI_RESULT_FAILURE;
261         }
262         if (efd) {
263                 if (pipe(audio)) {
264                         ast_log(LOG_WARNING, "unable to create audio pipe: %s\n", strerror(errno));
265                         close(fromast[0]);
266                         close(fromast[1]);
267                         close(toast[0]);
268                         close(toast[1]);
269                         return AGI_RESULT_FAILURE;
270                 }
271                 res = fcntl(audio[1], F_GETFL);
272                 if (res > -1) 
273                         res = fcntl(audio[1], F_SETFL, res | O_NONBLOCK);
274                 if (res < 0) {
275                         ast_log(LOG_WARNING, "unable to set audio pipe parameters: %s\n", strerror(errno));
276                         close(fromast[0]);
277                         close(fromast[1]);
278                         close(toast[0]);
279                         close(toast[1]);
280                         close(audio[0]);
281                         close(audio[1]);
282                         return AGI_RESULT_FAILURE;
283                 }
284         }
285
286         /* Block SIGHUP during the fork - prevents a race */
287         sigfillset(&signal_set);
288         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
289         if ((pid = fork()) < 0) {
290                 ast_log(LOG_WARNING, "Failed to fork(): %s\n", strerror(errno));
291                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
292                 return AGI_RESULT_FAILURE;
293         }
294         if (!pid) {
295                 /* Pass paths to AGI via environmental variables */
296                 setenv("AST_CONFIG_DIR", ast_config_AST_CONFIG_DIR, 1);
297                 setenv("AST_CONFIG_FILE", ast_config_AST_CONFIG_FILE, 1);
298                 setenv("AST_MODULE_DIR", ast_config_AST_MODULE_DIR, 1);
299                 setenv("AST_SPOOL_DIR", ast_config_AST_SPOOL_DIR, 1);
300                 setenv("AST_MONITOR_DIR", ast_config_AST_MONITOR_DIR, 1);
301                 setenv("AST_VAR_DIR", ast_config_AST_VAR_DIR, 1);
302                 setenv("AST_DATA_DIR", ast_config_AST_DATA_DIR, 1);
303                 setenv("AST_LOG_DIR", ast_config_AST_LOG_DIR, 1);
304                 setenv("AST_AGI_DIR", ast_config_AST_AGI_DIR, 1);
305                 setenv("AST_KEY_DIR", ast_config_AST_KEY_DIR, 1);
306                 setenv("AST_RUN_DIR", ast_config_AST_RUN_DIR, 1);
307
308                 /* Don't run AGI scripts with realtime priority -- it causes audio stutter */
309                 ast_set_priority(0);
310
311                 /* Redirect stdin and out, provide enhanced audio channel if desired */
312                 dup2(fromast[0], STDIN_FILENO);
313                 dup2(toast[1], STDOUT_FILENO);
314                 if (efd)
315                         dup2(audio[0], STDERR_FILENO + 1);
316                 else
317                         close(STDERR_FILENO + 1);
318
319                 /* Before we unblock our signals, return our trapped signals back to the defaults */
320                 signal(SIGHUP, SIG_DFL);
321                 signal(SIGCHLD, SIG_DFL);
322                 signal(SIGINT, SIG_DFL);
323                 signal(SIGURG, SIG_DFL);
324                 signal(SIGTERM, SIG_DFL);
325                 signal(SIGPIPE, SIG_DFL);
326                 signal(SIGXFSZ, SIG_DFL);
327
328                 /* unblock important signal handlers */
329                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
330                         ast_log(LOG_WARNING, "unable to unblock signals for AGI script: %s\n", strerror(errno));
331                         _exit(1);
332                 }
333
334                 /* Close everything but stdin/out/error */
335                 for (x = STDERR_FILENO + 2; x < 1024; x++) 
336                         close(x);
337
338                 /* Execute script */
339                 /* XXX argv should be deprecated in favor of passing agi_argX paramaters */
340                 execv(script, argv);
341                 /* Can't use ast_log since FD's are closed */
342                 fprintf(stdout, "verbose \"Failed to execute '%s': %s\" 2\n", script, strerror(errno));
343                 fflush(stdout);
344                 _exit(1);
345         }
346         pthread_sigmask(SIG_SETMASK, &old_set, NULL);
347         if (option_verbose > 2) 
348                 ast_verbose(VERBOSE_PREFIX_3 "Launched AGI Script %s\n", script);
349         fds[0] = toast[0];
350         fds[1] = fromast[1];
351         if (efd)
352                 *efd = audio[1];
353         /* close what we're not using in the parent */
354         close(toast[1]);
355         close(fromast[0]);
356
357         if (efd)
358                 close(audio[0]);
359
360         *opid = pid;
361         return AGI_RESULT_SUCCESS;
362 }
363
364 static void setup_env(struct ast_channel *chan, char *request, int fd, int enhanced, int argc, char *argv[])
365 {
366         int count;
367
368         /* Print initial environment, with agi_request always being the first
369            thing */
370         fdprintf(fd, "agi_request: %s\n", request);
371         fdprintf(fd, "agi_channel: %s\n", chan->name);
372         fdprintf(fd, "agi_language: %s\n", chan->language);
373         fdprintf(fd, "agi_type: %s\n", chan->tech->type);
374         fdprintf(fd, "agi_uniqueid: %s\n", chan->uniqueid);
375
376         /* ANI/DNIS */
377         fdprintf(fd, "agi_callerid: %s\n", S_OR(chan->cid.cid_num, "unknown"));
378         fdprintf(fd, "agi_calleridname: %s\n", S_OR(chan->cid.cid_name, "unknown"));
379         fdprintf(fd, "agi_callingpres: %d\n", chan->cid.cid_pres);
380         fdprintf(fd, "agi_callingani2: %d\n", chan->cid.cid_ani2);
381         fdprintf(fd, "agi_callington: %d\n", chan->cid.cid_ton);
382         fdprintf(fd, "agi_callingtns: %d\n", chan->cid.cid_tns);
383         fdprintf(fd, "agi_dnid: %s\n", S_OR(chan->cid.cid_dnid, "unknown"));
384         fdprintf(fd, "agi_rdnis: %s\n", S_OR(chan->cid.cid_rdnis, "unknown"));
385
386         /* Context information */
387         fdprintf(fd, "agi_context: %s\n", chan->context);
388         fdprintf(fd, "agi_extension: %s\n", chan->exten);
389         fdprintf(fd, "agi_priority: %d\n", chan->priority);
390         fdprintf(fd, "agi_enhanced: %s\n", enhanced ? "1.0" : "0.0");
391
392         /* User information */
393         fdprintf(fd, "agi_accountcode: %s\n", chan->accountcode ? chan->accountcode : "");
394     
395         /* Send any parameters to the fastagi server that have been passed via the agi application */
396         /* Agi application paramaters take the form of: AGI(/path/to/example/script|${EXTEN}) */
397         for(count = 1; count < argc; count++)
398                 fdprintf(fd, "agi_arg_%d: %s\n", count, argv[count]);
399
400         /* End with empty return */
401         fdprintf(fd, "\n");
402 }
403
404 static int handle_answer(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
405 {
406         int res = 0;
407
408         /* Answer the channel */
409         if (chan->_state != AST_STATE_UP)
410                 res = ast_answer(chan);
411
412         fdprintf(agi->fd, "200 result=%d\n", res);
413         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
414 }
415
416 static int handle_waitfordigit(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
417 {
418         int res, to;
419
420         if (argc != 4)
421                 return RESULT_SHOWUSAGE;
422         if (sscanf(argv[3], "%d", &to) != 1)
423                 return RESULT_SHOWUSAGE;
424         res = ast_waitfordigit_full(chan, to, agi->audio, agi->ctrl);
425         fdprintf(agi->fd, "200 result=%d\n", res);
426         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
427 }
428
429 static int handle_sendtext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
430 {
431         int res;
432
433         if (argc != 3)
434                 return RESULT_SHOWUSAGE;
435
436         /* At the moment, the parser (perhaps broken) returns with
437            the last argument PLUS the newline at the end of the input
438            buffer. This probably needs to be fixed, but I wont do that
439            because other stuff may break as a result. The right way
440            would probably be to strip off the trailing newline before
441            parsing, then here, add a newline at the end of the string
442            before sending it to ast_sendtext --DUDE */
443         res = ast_sendtext(chan, argv[2]);
444         fdprintf(agi->fd, "200 result=%d\n", res);
445         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
446 }
447
448 static int handle_recvchar(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
449 {
450         int res;
451
452         if (argc != 3)
453                 return RESULT_SHOWUSAGE;
454
455         res = ast_recvchar(chan,atoi(argv[2]));
456         if (res == 0) {
457                 fdprintf(agi->fd, "200 result=%d (timeout)\n", res);
458                 return RESULT_SUCCESS;
459         }
460         if (res > 0) {
461                 fdprintf(agi->fd, "200 result=%d\n", res);
462                 return RESULT_SUCCESS;
463         }
464         else {
465                 fdprintf(agi->fd, "200 result=%d (hangup)\n", res);
466                 return RESULT_FAILURE;
467         }
468 }
469
470 static int handle_recvtext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
471 {
472         char *buf;
473         
474         if (argc != 3)
475                 return RESULT_SHOWUSAGE;
476
477         buf = ast_recvtext(chan,atoi(argv[2]));
478         if (buf) {
479                 fdprintf(agi->fd, "200 result=1 (%s)\n", buf);
480                 ast_free(buf);
481         } else {        
482                 fdprintf(agi->fd, "200 result=-1\n");
483         }
484         return RESULT_SUCCESS;
485 }
486
487 static int handle_tddmode(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
488 {
489         int res, x;
490
491         if (argc != 3)
492                 return RESULT_SHOWUSAGE;
493
494         if (!strncasecmp(argv[2],"on",2)) 
495                 x = 1; 
496         else 
497                 x = 0;
498         if (!strncasecmp(argv[2],"mate",4)) 
499                 x = 2;
500         if (!strncasecmp(argv[2],"tdd",3))
501                 x = 1;
502         res = ast_channel_setoption(chan, AST_OPTION_TDD, &x, sizeof(char), 0);
503         if (res != RESULT_SUCCESS)
504                 fdprintf(agi->fd, "200 result=0\n");
505         else
506                 fdprintf(agi->fd, "200 result=1\n");
507         return RESULT_SUCCESS;
508 }
509
510 static int handle_sendimage(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
511 {
512         int res;
513
514         if (argc != 3)
515                 return RESULT_SHOWUSAGE;
516
517         res = ast_send_image(chan, argv[2]);
518         if (!ast_check_hangup(chan))
519                 res = 0;
520         fdprintf(agi->fd, "200 result=%d\n", res);
521         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
522 }
523
524 static int handle_controlstreamfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
525 {
526         int res = 0, skipms = 3000;
527         char *fwd = NULL, *rev = NULL, *pause = NULL, *stop = NULL;
528
529         if (argc < 5 || argc > 9)
530                 return RESULT_SHOWUSAGE;
531
532         if (!ast_strlen_zero(argv[4]))
533                 stop = argv[4];
534         else
535                 stop = NULL;
536         
537         if ((argc > 5) && (sscanf(argv[5], "%d", &skipms) != 1))
538                 return RESULT_SHOWUSAGE;
539
540         if (argc > 6 && !ast_strlen_zero(argv[6]))
541                 fwd = argv[6];
542         else
543                 fwd = "#";
544
545         if (argc > 7 && !ast_strlen_zero(argv[7]))
546                 rev = argv[7];
547         else
548                 rev = "*";
549         
550         if (argc > 8 && !ast_strlen_zero(argv[8]))
551                 pause = argv[8];
552         else
553                 pause = NULL;
554         
555         res = ast_control_streamfile(chan, argv[3], fwd, rev, stop, pause, NULL, skipms, NULL);
556         
557         fdprintf(agi->fd, "200 result=%d\n", res);
558
559         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
560 }
561
562 static int handle_streamfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
563 {
564         int res, vres;
565         struct ast_filestream *fs, *vfs;
566         long sample_offset = 0, max_length;
567         char *edigits = "";
568
569         if (argc < 4 || argc > 5)
570                 return RESULT_SHOWUSAGE;
571
572         if (argv[3]) 
573                 edigits = argv[3];
574
575         if ((argc > 4) && (sscanf(argv[4], "%ld", &sample_offset) != 1))
576                 return RESULT_SHOWUSAGE;
577
578         if (!(fs = ast_openstream(chan, argv[2], chan->language))) {
579                 fdprintf(agi->fd, "200 result=%d endpos=%ld\n", 0, sample_offset);
580                 return RESULT_SUCCESS;
581         }       
582         vfs = ast_openvstream(chan, argv[2], chan->language);
583         ast_debug(vfs && 1, "Ooh, found a video stream, too\n");
584                 
585         if (option_verbose > 2)
586                 ast_verbose(VERBOSE_PREFIX_3 "Playing '%s' (escape_digits=%s) (sample_offset %ld)\n", argv[2], edigits, sample_offset);
587
588         ast_seekstream(fs, 0, SEEK_END);
589         max_length = ast_tellstream(fs);
590         ast_seekstream(fs, sample_offset, SEEK_SET);
591         res = ast_applystream(chan, fs);
592         if (vfs)
593                 vres = ast_applystream(chan, vfs);
594         ast_playstream(fs);
595         if (vfs)
596                 ast_playstream(vfs);
597         
598         res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
599         /* this is to check for if ast_waitstream closed the stream, we probably are at
600          * the end of the stream, return that amount, else check for the amount */
601         sample_offset = (chan->stream) ? ast_tellstream(fs) : max_length;
602         ast_stopstream(chan);
603         if (res == 1) {
604                 /* Stop this command, don't print a result line, as there is a new command */
605                 return RESULT_SUCCESS;
606         }
607         fdprintf(agi->fd, "200 result=%d endpos=%ld\n", res, sample_offset);
608         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
609 }
610
611 /* get option - really similar to the handle_streamfile, but with a timeout */
612 static int handle_getoption(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
613 {
614         int res, vres;
615         struct ast_filestream *fs, *vfs;
616         long sample_offset = 0, max_length;
617         int timeout = 0;
618         char *edigits = "";
619
620         if ( argc < 4 || argc > 5 )
621                 return RESULT_SHOWUSAGE;
622
623         if ( argv[3] ) 
624                 edigits = argv[3];
625
626         if ( argc == 5 )
627                 timeout = atoi(argv[4]);
628         else if (chan->pbx->dtimeout) {
629                 /* by default dtimeout is set to 5sec */
630                 timeout = chan->pbx->dtimeout * 1000; /* in msec */
631         }
632
633         if (!(fs = ast_openstream(chan, argv[2], chan->language))) {
634                 fdprintf(agi->fd, "200 result=%d endpos=%ld\n", 0, sample_offset);
635                 ast_log(LOG_WARNING, "Unable to open %s\n", argv[2]);
636                 return RESULT_SUCCESS;
637         }
638         vfs = ast_openvstream(chan, argv[2], chan->language);
639         ast_debug(vfs && 1, "Ooh, found a video stream, too\n");
640         
641         if (option_verbose > 2)
642                 ast_verbose(VERBOSE_PREFIX_3 "Playing '%s' (escape_digits=%s) (timeout %d)\n", argv[2], edigits, timeout);
643
644         ast_seekstream(fs, 0, SEEK_END);
645         max_length = ast_tellstream(fs);
646         ast_seekstream(fs, sample_offset, SEEK_SET);
647         res = ast_applystream(chan, fs);
648         if (vfs)
649                 vres = ast_applystream(chan, vfs);
650         ast_playstream(fs);
651         if (vfs)
652                 ast_playstream(vfs);
653
654         res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
655         /* this is to check for if ast_waitstream closed the stream, we probably are at
656          * the end of the stream, return that amount, else check for the amount */
657         sample_offset = (chan->stream)?ast_tellstream(fs):max_length;
658         ast_stopstream(chan);
659         if (res == 1) {
660                 /* Stop this command, don't print a result line, as there is a new command */
661                 return RESULT_SUCCESS;
662         }
663
664         /* If the user didnt press a key, wait for digitTimeout*/
665         if (res == 0 ) {
666                 res = ast_waitfordigit_full(chan, timeout, agi->audio, agi->ctrl);
667                 /* Make sure the new result is in the escape digits of the GET OPTION */
668                 if ( !strchr(edigits,res) )
669                         res=0;
670         }
671
672         fdprintf(agi->fd, "200 result=%d endpos=%ld\n", res, sample_offset);
673         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
674 }
675
676
677
678
679 /*--- handle_saynumber: Say number in various language syntaxes ---*/
680 /* While waiting, we're sending a NULL.  */
681 static int handle_saynumber(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
682 {
683         int res, num;
684
685         if (argc < 4 || argc > 5)
686                 return RESULT_SHOWUSAGE;
687         if (sscanf(argv[2], "%d", &num) != 1)
688                 return RESULT_SHOWUSAGE;
689         res = ast_say_number_full(chan, num, argv[3], chan->language, argc > 4 ? argv[4] : NULL, agi->audio, agi->ctrl);
690         if (res == 1)
691                 return RESULT_SUCCESS;
692         fdprintf(agi->fd, "200 result=%d\n", res);
693         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
694 }
695
696 static int handle_saydigits(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
697 {
698         int res, num;
699
700         if (argc != 4)
701                 return RESULT_SHOWUSAGE;
702         if (sscanf(argv[2], "%d", &num) != 1)
703                 return RESULT_SHOWUSAGE;
704
705         res = ast_say_digit_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
706         if (res == 1) /* New command */
707                 return RESULT_SUCCESS;
708         fdprintf(agi->fd, "200 result=%d\n", res);
709         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
710 }
711
712 static int handle_sayalpha(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
713 {
714         int res;
715
716         if (argc != 4)
717                 return RESULT_SHOWUSAGE;
718
719         res = ast_say_character_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
720         if (res == 1) /* New command */
721                 return RESULT_SUCCESS;
722         fdprintf(agi->fd, "200 result=%d\n", res);
723         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
724 }
725
726 static int handle_saydate(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
727 {
728         int res, num;
729
730         if (argc != 4)
731                 return RESULT_SHOWUSAGE;
732         if (sscanf(argv[2], "%d", &num) != 1)
733                 return RESULT_SHOWUSAGE;
734         res = ast_say_date(chan, num, argv[3], chan->language);
735         if (res == 1)
736                 return RESULT_SUCCESS;
737         fdprintf(agi->fd, "200 result=%d\n", res);
738         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
739 }
740
741 static int handle_saytime(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
742 {
743         int res, num;
744
745         if (argc != 4)
746                 return RESULT_SHOWUSAGE;
747         if (sscanf(argv[2], "%d", &num) != 1)
748                 return RESULT_SHOWUSAGE;
749         res = ast_say_time(chan, num, argv[3], chan->language);
750         if (res == 1)
751                 return RESULT_SUCCESS;
752         fdprintf(agi->fd, "200 result=%d\n", res);
753         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
754 }
755
756 static int handle_saydatetime(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
757 {
758         int res = 0;
759         time_t unixtime;
760         char *format, *zone = NULL;
761         
762         if (argc < 4)
763                 return RESULT_SHOWUSAGE;
764
765         if (argc > 4) {
766                 format = argv[4];
767         } else {
768                 /* XXX this doesn't belong here, but in the 'say' module */
769                 if (!strcasecmp(chan->language, "de")) {
770                         format = "A dBY HMS";
771                 } else {
772                         format = "ABdY 'digits/at' IMp"; 
773                 }
774         }
775
776         if (argc > 5 && !ast_strlen_zero(argv[5]))
777                 zone = argv[5];
778
779         if (ast_get_time_t(argv[2], &unixtime, 0, NULL))
780                 return RESULT_SHOWUSAGE;
781
782         res = ast_say_date_with_format(chan, unixtime, argv[3], chan->language, format, zone);
783         if (res == 1)
784                 return RESULT_SUCCESS;
785
786         fdprintf(agi->fd, "200 result=%d\n", res);
787         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
788 }
789
790 static int handle_sayphonetic(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
791 {
792         int res;
793
794         if (argc != 4)
795                 return RESULT_SHOWUSAGE;
796
797         res = ast_say_phonetic_str_full(chan, argv[2], argv[3], chan->language, agi->audio, agi->ctrl);
798         if (res == 1) /* New command */
799                 return RESULT_SUCCESS;
800         fdprintf(agi->fd, "200 result=%d\n", res);
801         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
802 }
803
804 static int handle_getdata(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
805 {
806         int res, max, timeout;
807         char data[1024];
808
809         if (argc < 3)
810                 return RESULT_SHOWUSAGE;
811         if (argc >= 4)
812                 timeout = atoi(argv[3]); 
813         else
814                 timeout = 0;
815         if (argc >= 5) 
816                 max = atoi(argv[4]); 
817         else
818                 max = 1024;
819         res = ast_app_getdata_full(chan, argv[2], data, max, timeout, agi->audio, agi->ctrl);
820         if (res == 2)                   /* New command */
821                 return RESULT_SUCCESS;
822         else if (res == 1)
823                 fdprintf(agi->fd, "200 result=%s (timeout)\n", data);
824         else if (res < 0 )
825                 fdprintf(agi->fd, "200 result=-1\n");
826         else
827                 fdprintf(agi->fd, "200 result=%s\n", data);
828         return RESULT_SUCCESS;
829 }
830
831 static int handle_setcontext(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
832 {
833
834         if (argc != 3)
835                 return RESULT_SHOWUSAGE;
836         ast_copy_string(chan->context, argv[2], sizeof(chan->context));
837         fdprintf(agi->fd, "200 result=0\n");
838         return RESULT_SUCCESS;
839 }
840         
841 static int handle_setextension(struct ast_channel *chan, AGI *agi, int argc, char **argv)
842 {
843         if (argc != 3)
844                 return RESULT_SHOWUSAGE;
845         ast_copy_string(chan->exten, argv[2], sizeof(chan->exten));
846         fdprintf(agi->fd, "200 result=0\n");
847         return RESULT_SUCCESS;
848 }
849
850 static int handle_setpriority(struct ast_channel *chan, AGI *agi, int argc, char **argv)
851 {
852         int pri;
853
854         if (argc != 3)
855                 return RESULT_SHOWUSAGE;        
856
857         if (sscanf(argv[2], "%d", &pri) != 1) {
858                 if ((pri = ast_findlabel_extension(chan, chan->context, chan->exten, argv[2], chan->cid.cid_num)) < 1)
859                         return RESULT_SHOWUSAGE;
860         }
861
862         ast_explicit_goto(chan, NULL, NULL, pri);
863         fdprintf(agi->fd, "200 result=0\n");
864         return RESULT_SUCCESS;
865 }
866                 
867 static int handle_recordfile(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
868 {
869         struct ast_filestream *fs;
870         struct ast_frame *f;
871         struct timeval start;
872         long sample_offset = 0;
873         int res = 0;
874         int ms;
875
876         struct ast_dsp *sildet=NULL;         /* silence detector dsp */
877         int totalsilence = 0;
878         int dspsilence = 0;
879         int silence = 0;                /* amount of silence to allow */
880         int gotsilence = 0;             /* did we timeout for silence? */
881         char *silencestr=NULL;
882         int rfmt=0;
883
884
885         /* XXX EAGI FIXME XXX */
886
887         if (argc < 6)
888                 return RESULT_SHOWUSAGE;
889         if (sscanf(argv[5], "%d", &ms) != 1)
890                 return RESULT_SHOWUSAGE;
891
892         if (argc > 6)
893                 silencestr = strchr(argv[6],'s');
894         if ((argc > 7) && (!silencestr))
895                 silencestr = strchr(argv[7],'s');
896         if ((argc > 8) && (!silencestr))
897                 silencestr = strchr(argv[8],'s');
898
899         if (silencestr) {
900                 if (strlen(silencestr) > 2) {
901                         if ((silencestr[0] == 's') && (silencestr[1] == '=')) {
902                                 silencestr++;
903                                 silencestr++;
904                                 if (silencestr)
905                                         silence = atoi(silencestr);
906                                 if (silence > 0)
907                                         silence *= 1000;
908                         }
909                 }
910         }
911
912         if (silence > 0) {
913                 rfmt = chan->readformat;
914                 res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
915                 if (res < 0) {
916                         ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
917                         return -1;
918                 }
919                 sildet = ast_dsp_new();
920                 if (!sildet) {
921                         ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
922                         return -1;
923                 }
924                 ast_dsp_set_threshold(sildet, 256);
925         }
926
927         /* backward compatibility, if no offset given, arg[6] would have been
928          * caught below and taken to be a beep, else if it is a digit then it is a
929          * offset */
930         if ((argc >6) && (sscanf(argv[6], "%ld", &sample_offset) != 1) && (!strchr(argv[6], '=')))
931                 res = ast_streamfile(chan, "beep", chan->language);
932
933         if ((argc > 7) && (!strchr(argv[7], '=')))
934                 res = ast_streamfile(chan, "beep", chan->language);
935
936         if (!res)
937                 res = ast_waitstream(chan, argv[4]);
938         if (res) {
939                 fdprintf(agi->fd, "200 result=%d (randomerror) endpos=%ld\n", res, sample_offset);
940         } else {
941                 fs = ast_writefile(argv[2], argv[3], NULL, O_CREAT | O_WRONLY | (sample_offset ? O_APPEND : 0), 0, AST_FILE_MODE);
942                 if (!fs) {
943                         res = -1;
944                         fdprintf(agi->fd, "200 result=%d (writefile)\n", res);
945                         if (sildet)
946                                 ast_dsp_free(sildet);
947                         return RESULT_FAILURE;
948                 }
949                 
950                 /* Request a video update */
951                 ast_indicate(chan, AST_CONTROL_VIDUPDATE);
952         
953                 chan->stream = fs;
954                 ast_applystream(chan,fs);
955                 /* really should have checks */
956                 ast_seekstream(fs, sample_offset, SEEK_SET);
957                 ast_truncstream(fs);
958                 
959                 start = ast_tvnow();
960                 while ((ms < 0) || ast_tvdiff_ms(ast_tvnow(), start) < ms) {
961                         res = ast_waitfor(chan, -1);
962                         if (res < 0) {
963                                 ast_closestream(fs);
964                                 fdprintf(agi->fd, "200 result=%d (waitfor) endpos=%ld\n", res,sample_offset);
965                                 if (sildet)
966                                         ast_dsp_free(sildet);
967                                 return RESULT_FAILURE;
968                         }
969                         f = ast_read(chan);
970                         if (!f) {
971                                 fdprintf(agi->fd, "200 result=%d (hangup) endpos=%ld\n", 0, sample_offset);
972                                 ast_closestream(fs);
973                                 if (sildet)
974                                         ast_dsp_free(sildet);
975                                 return RESULT_FAILURE;
976                         }
977                         switch(f->frametype) {
978                         case AST_FRAME_DTMF:
979                                 if (strchr(argv[4], f->subclass)) {
980                                         /* This is an interrupting chracter, so rewind to chop off any small
981                                            amount of DTMF that may have been recorded
982                                         */
983                                         ast_stream_rewind(fs, 200);
984                                         ast_truncstream(fs);
985                                         sample_offset = ast_tellstream(fs);
986                                         fdprintf(agi->fd, "200 result=%d (dtmf) endpos=%ld\n", f->subclass, sample_offset);
987                                         ast_closestream(fs);
988                                         ast_frfree(f);
989                                         if (sildet)
990                                                 ast_dsp_free(sildet);
991                                         return RESULT_SUCCESS;
992                                 }
993                                 break;
994                         case AST_FRAME_VOICE:
995                                 ast_writestream(fs, f);
996                                 /* this is a safe place to check progress since we know that fs
997                                  * is valid after a write, and it will then have our current
998                                  * location */
999                                 sample_offset = ast_tellstream(fs);
1000                                 if (silence > 0) {
1001                                         dspsilence = 0;
1002                                         ast_dsp_silence(sildet, f, &dspsilence);
1003                                         if (dspsilence) {
1004                                                 totalsilence = dspsilence;
1005                                         } else {
1006                                                 totalsilence = 0;
1007                                         }
1008                                         if (totalsilence > silence) {
1009                                              /* Ended happily with silence */
1010                                                 gotsilence = 1;
1011                                                 break;
1012                                         }
1013                                 }
1014                                 break;
1015                         case AST_FRAME_VIDEO:
1016                                 ast_writestream(fs, f);
1017                         default:
1018                                 /* Ignore all other frames */
1019                                 break;
1020                         }
1021                         ast_frfree(f);
1022                         if (gotsilence)
1023                                 break;
1024                 }
1025
1026                 if (gotsilence) {
1027                         ast_stream_rewind(fs, silence-1000);
1028                         ast_truncstream(fs);
1029                         sample_offset = ast_tellstream(fs);
1030                 }               
1031                 fdprintf(agi->fd, "200 result=%d (timeout) endpos=%ld\n", res, sample_offset);
1032                 ast_closestream(fs);
1033         }
1034
1035         if (silence > 0) {
1036                 res = ast_set_read_format(chan, rfmt);
1037                 if (res)
1038                         ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", chan->name);
1039                 ast_dsp_free(sildet);
1040         }
1041         return RESULT_SUCCESS;
1042 }
1043
1044 static int handle_autohangup(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1045 {
1046         int timeout;
1047
1048         if (argc != 3)
1049                 return RESULT_SHOWUSAGE;
1050         if (sscanf(argv[2], "%d", &timeout) != 1)
1051                 return RESULT_SHOWUSAGE;
1052         if (timeout < 0)
1053                 timeout = 0;
1054         if (timeout)
1055                 chan->whentohangup = time(NULL) + timeout;
1056         else
1057                 chan->whentohangup = 0;
1058         fdprintf(agi->fd, "200 result=0\n");
1059         return RESULT_SUCCESS;
1060 }
1061
1062 static int handle_hangup(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1063 {
1064         struct ast_channel *c;
1065
1066         if (argc == 1) {
1067                 /* no argument: hangup the current channel */
1068                 ast_softhangup(chan,AST_SOFTHANGUP_EXPLICIT);
1069                 fdprintf(agi->fd, "200 result=1\n");
1070                 return RESULT_SUCCESS;
1071         } else if (argc == 2) {
1072                 /* one argument: look for info on the specified channel */
1073                 c = ast_get_channel_by_name_locked(argv[1]);
1074                 if (c) {
1075                         /* we have a matching channel */
1076                         ast_softhangup(c,AST_SOFTHANGUP_EXPLICIT);
1077                         fdprintf(agi->fd, "200 result=1\n");
1078                         ast_channel_unlock(c);
1079                         return RESULT_SUCCESS;
1080                 }
1081                 /* if we get this far no channel name matched the argument given */
1082                 fdprintf(agi->fd, "200 result=-1\n");
1083                 return RESULT_SUCCESS;
1084         } else {
1085                 return RESULT_SHOWUSAGE;
1086         }
1087 }
1088
1089 static int handle_exec(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1090 {
1091         int res;
1092         struct ast_app *app;
1093
1094         if (argc < 2)
1095                 return RESULT_SHOWUSAGE;
1096
1097         if (option_verbose > 2)
1098                 ast_verbose(VERBOSE_PREFIX_3 "AGI Script Executing Application: (%s) Options: (%s)\n", argv[1], argv[2]);
1099
1100         if ((app = pbx_findapp(argv[1]))) {
1101                 res = pbx_exec(chan, app, argv[2]);
1102         } else {
1103                 ast_log(LOG_WARNING, "Could not find application (%s)\n", argv[1]);
1104                 res = -2;
1105         }
1106         fdprintf(agi->fd, "200 result=%d\n", res);
1107
1108         return res >= 0 ? RESULT_SUCCESS : RESULT_FAILURE;
1109 }
1110
1111 static int handle_setcallerid(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1112 {
1113         char tmp[256]="";
1114         char *l = NULL, *n = NULL;
1115
1116         if (argv[2]) {
1117                 ast_copy_string(tmp, argv[2], sizeof(tmp));
1118                 ast_callerid_parse(tmp, &n, &l);
1119                 if (l)
1120                         ast_shrink_phone_number(l);
1121                 else
1122                         l = "";
1123                 if (!n)
1124                         n = "";
1125                 ast_set_callerid(chan, l, n, NULL);
1126         }
1127
1128         fdprintf(agi->fd, "200 result=1\n");
1129         return RESULT_SUCCESS;
1130 }
1131
1132 static int handle_channelstatus(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1133 {
1134         struct ast_channel *c;
1135         if (argc == 2) {
1136                 /* no argument: supply info on the current channel */
1137                 fdprintf(agi->fd, "200 result=%d\n", chan->_state);
1138                 return RESULT_SUCCESS;
1139         } else if (argc == 3) {
1140                 /* one argument: look for info on the specified channel */
1141                 c = ast_get_channel_by_name_locked(argv[2]);
1142                 if (c) {
1143                         fdprintf(agi->fd, "200 result=%d\n", c->_state);
1144                         ast_channel_unlock(c);
1145                         return RESULT_SUCCESS;
1146                 }
1147                 /* if we get this far no channel name matched the argument given */
1148                 fdprintf(agi->fd, "200 result=-1\n");
1149                 return RESULT_SUCCESS;
1150         } else {
1151                 return RESULT_SHOWUSAGE;
1152         }
1153 }
1154
1155 static int handle_setvariable(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1156 {
1157         if (argv[3])
1158                 pbx_builtin_setvar_helper(chan, argv[2], argv[3]);
1159
1160         fdprintf(agi->fd, "200 result=1\n");
1161         return RESULT_SUCCESS;
1162 }
1163
1164 static int handle_getvariable(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1165 {
1166         char *ret;
1167         char tempstr[1024];
1168
1169         if (argc != 3)
1170                 return RESULT_SHOWUSAGE;
1171
1172         /* check if we want to execute an ast_custom_function */
1173         if (!ast_strlen_zero(argv[2]) && (argv[2][strlen(argv[2]) - 1] == ')')) {
1174                 ret = ast_func_read(chan, argv[2], tempstr, sizeof(tempstr)) ? NULL : tempstr;
1175         } else {
1176                 pbx_retrieve_variable(chan, argv[2], &ret, tempstr, sizeof(tempstr), NULL);
1177         }
1178
1179         if (ret)
1180                 fdprintf(agi->fd, "200 result=1 (%s)\n", ret);
1181         else
1182                 fdprintf(agi->fd, "200 result=0\n");
1183
1184         return RESULT_SUCCESS;
1185 }
1186
1187 static int handle_getvariablefull(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1188 {
1189         char tmp[4096] = "";
1190         struct ast_channel *chan2=NULL;
1191
1192         if ((argc != 4) && (argc != 5))
1193                 return RESULT_SHOWUSAGE;
1194         if (argc == 5) {
1195                 chan2 = ast_get_channel_by_name_locked(argv[4]);
1196         } else {
1197                 chan2 = chan;
1198         }
1199         if (chan) { /* XXX isn't this chan2 ? */
1200                 pbx_substitute_variables_helper(chan2, argv[3], tmp, sizeof(tmp) - 1);
1201                 fdprintf(agi->fd, "200 result=1 (%s)\n", tmp);
1202         } else {
1203                 fdprintf(agi->fd, "200 result=0\n");
1204         }
1205         if (chan2 && (chan2 != chan))
1206                 ast_channel_unlock(chan2);
1207         return RESULT_SUCCESS;
1208 }
1209
1210 static int handle_verbose(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1211 {
1212         int level = 0;
1213         char *prefix;
1214
1215         if (argc < 2)
1216                 return RESULT_SHOWUSAGE;
1217
1218         if (argv[2])
1219                 sscanf(argv[2], "%d", &level);
1220
1221         switch (level) {
1222                 case 4:
1223                         prefix = VERBOSE_PREFIX_4;
1224                         break;
1225                 case 3:
1226                         prefix = VERBOSE_PREFIX_3;
1227                         break;
1228                 case 2:
1229                         prefix = VERBOSE_PREFIX_2;
1230                         break;
1231                 case 1:
1232                 default:
1233                         prefix = VERBOSE_PREFIX_1;
1234                         break;
1235         }
1236
1237         if (level <= option_verbose)
1238                 ast_verbose("%s %s: %s\n", prefix, chan->data, argv[1]);
1239         
1240         fdprintf(agi->fd, "200 result=1\n");
1241         
1242         return RESULT_SUCCESS;
1243 }
1244
1245 static int handle_dbget(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1246 {
1247         int res;
1248         char tmp[256];
1249
1250         if (argc != 4)
1251                 return RESULT_SHOWUSAGE;
1252         res = ast_db_get(argv[2], argv[3], tmp, sizeof(tmp));
1253         if (res) 
1254                 fdprintf(agi->fd, "200 result=0\n");
1255         else
1256                 fdprintf(agi->fd, "200 result=1 (%s)\n", tmp);
1257
1258         return RESULT_SUCCESS;
1259 }
1260
1261 static int handle_dbput(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1262 {
1263         int res;
1264
1265         if (argc != 5)
1266                 return RESULT_SHOWUSAGE;
1267         res = ast_db_put(argv[2], argv[3], argv[4]);
1268         fdprintf(agi->fd, "200 result=%c\n", res ? '0' : '1');
1269         return RESULT_SUCCESS;
1270 }
1271
1272 static int handle_dbdel(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1273 {
1274         int res;
1275
1276         if (argc != 4)
1277                 return RESULT_SHOWUSAGE;
1278         res = ast_db_del(argv[2], argv[3]);
1279         fdprintf(agi->fd, "200 result=%c\n", res ? '0' : '1');
1280         return RESULT_SUCCESS;
1281 }
1282
1283 static int handle_dbdeltree(struct ast_channel *chan, AGI *agi, int argc, char **argv)
1284 {
1285         int res;
1286
1287         if ((argc < 3) || (argc > 4))
1288                 return RESULT_SHOWUSAGE;
1289         if (argc == 4)
1290                 res = ast_db_deltree(argv[2], argv[3]);
1291         else
1292                 res = ast_db_deltree(argv[2], NULL);
1293
1294         fdprintf(agi->fd, "200 result=%c\n", res ? '0' : '1');
1295         return RESULT_SUCCESS;
1296 }
1297
1298 static const char debug_usage[] = 
1299 "Usage: agi debug\n"
1300 "       Enables dumping of AGI transactions for debugging purposes\n";
1301
1302 static const char no_debug_usage[] = 
1303 "Usage: agi debug off\n"
1304 "       Disables dumping of AGI transactions for debugging purposes\n";
1305
1306 static int agi_do_debug(int fd, int argc, char *argv[])
1307 {
1308         if (argc != 2)
1309                 return RESULT_SHOWUSAGE;
1310         agidebug = 1;
1311         ast_cli(fd, "AGI Debugging Enabled\n");
1312         return RESULT_SUCCESS;
1313 }
1314
1315 static int agi_no_debug(int fd, int argc, char *argv[])
1316 {
1317         if (argc != 3)
1318                 return RESULT_SHOWUSAGE;
1319         agidebug = 0;
1320         ast_cli(fd, "AGI Debugging Disabled\n");
1321         return RESULT_SUCCESS;
1322 }
1323
1324 static int handle_noop(struct ast_channel *chan, AGI *agi, int arg, char *argv[])
1325 {
1326         fdprintf(agi->fd, "200 result=0\n");
1327         return RESULT_SUCCESS;
1328 }
1329
1330 static int handle_setmusic(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1331 {
1332         if (!strncasecmp(argv[2], "on", 2))
1333                 ast_moh_start(chan, argc > 3 ? argv[3] : NULL, NULL);
1334         else if (!strncasecmp(argv[2], "off", 3))
1335                 ast_moh_stop(chan);
1336         fdprintf(agi->fd, "200 result=0\n");
1337         return RESULT_SUCCESS;
1338 }
1339
1340 static char usage_setmusic[] =
1341 " Usage: SET MUSIC ON <on|off> <class>\n"
1342 "       Enables/Disables the music on hold generator.  If <class> is\n"
1343 " not specified, then the default music on hold class will be used.\n"
1344 " Always returns 0.\n";
1345
1346 static char usage_dbput[] =
1347 " Usage: DATABASE PUT <family> <key> <value>\n"
1348 "       Adds or updates an entry in the Asterisk database for a\n"
1349 " given family, key, and value.\n"
1350 " Returns 1 if successful, 0 otherwise.\n";
1351
1352 static char usage_dbget[] =
1353 " Usage: DATABASE GET <family> <key>\n"
1354 "       Retrieves an entry in the Asterisk database for a\n"
1355 " given family and key.\n"
1356 " Returns 0 if <key> is not set.  Returns 1 if <key>\n"
1357 " is set and returns the variable in parentheses.\n"
1358 " Example return code: 200 result=1 (testvariable)\n";
1359
1360 static char usage_dbdel[] =
1361 " Usage: DATABASE DEL <family> <key>\n"
1362 "       Deletes an entry in the Asterisk database for a\n"
1363 " given family and key.\n"
1364 " Returns 1 if successful, 0 otherwise.\n";
1365
1366 static char usage_dbdeltree[] =
1367 " Usage: DATABASE DELTREE <family> [keytree]\n"
1368 "       Deletes a family or specific keytree within a family\n"
1369 " in the Asterisk database.\n"
1370 " Returns 1 if successful, 0 otherwise.\n";
1371
1372 static char usage_verbose[] =
1373 " Usage: VERBOSE <message> <level>\n"
1374 "       Sends <message> to the console via verbose message system.\n"
1375 " <level> is the the verbose level (1-4)\n"
1376 " Always returns 1.\n";
1377
1378 static char usage_getvariable[] =
1379 " Usage: GET VARIABLE <variablename>\n"
1380 "       Returns 0 if <variablename> is not set.  Returns 1 if <variablename>\n"
1381 " is set and returns the variable in parentheses.\n"
1382 " example return code: 200 result=1 (testvariable)\n";
1383
1384 static char usage_getvariablefull[] =
1385 " Usage: GET FULL VARIABLE <variablename> [<channel name>]\n"
1386 "       Returns 0 if <variablename> is not set or channel does not exist.  Returns 1\n"
1387 "if <variablename>  is set and returns the variable in parenthesis.  Understands\n"
1388 "complex variable names and builtin variables, unlike GET VARIABLE.\n"
1389 " example return code: 200 result=1 (testvariable)\n";
1390
1391 static char usage_setvariable[] =
1392 " Usage: SET VARIABLE <variablename> <value>\n";
1393
1394 static char usage_channelstatus[] =
1395 " Usage: CHANNEL STATUS [<channelname>]\n"
1396 "       Returns the status of the specified channel.\n" 
1397 " If no channel name is given the returns the status of the\n"
1398 " current channel.  Return values:\n"
1399 "  0 Channel is down and available\n"
1400 "  1 Channel is down, but reserved\n"
1401 "  2 Channel is off hook\n"
1402 "  3 Digits (or equivalent) have been dialed\n"
1403 "  4 Line is ringing\n"
1404 "  5 Remote end is ringing\n"
1405 "  6 Line is up\n"
1406 "  7 Line is busy\n";
1407
1408 static char usage_setcallerid[] =
1409 " Usage: SET CALLERID <number>\n"
1410 "       Changes the callerid of the current channel.\n";
1411
1412 static char usage_exec[] =
1413 " Usage: EXEC <application> <options>\n"
1414 "       Executes <application> with given <options>.\n"
1415 " Returns whatever the application returns, or -2 on failure to find application\n";
1416
1417 static char usage_hangup[] =
1418 " Usage: HANGUP [<channelname>]\n"
1419 "       Hangs up the specified channel.\n"
1420 " If no channel name is given, hangs up the current channel\n";
1421
1422 static char usage_answer[] = 
1423 " Usage: ANSWER\n"
1424 "       Answers channel if not already in answer state. Returns -1 on\n"
1425 " channel failure, or 0 if successful.\n";
1426
1427 static char usage_waitfordigit[] = 
1428 " Usage: WAIT FOR DIGIT <timeout>\n"
1429 "       Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.\n"
1430 " Returns -1 on channel failure, 0 if no digit is received in the timeout, or\n"
1431 " the numerical value of the ascii of the digit if one is received.  Use -1\n"
1432 " for the timeout value if you desire the call to block indefinitely.\n";
1433
1434 static char usage_sendtext[] =
1435 " Usage: SEND TEXT \"<text to send>\"\n"
1436 "       Sends the given text on a channel. Most channels do not support the\n"
1437 " transmission of text.  Returns 0 if text is sent, or if the channel does not\n"
1438 " support text transmission.  Returns -1 only on error/hangup.  Text\n"
1439 " consisting of greater than one word should be placed in quotes since the\n"
1440 " command only accepts a single argument.\n";
1441
1442 static char usage_recvchar[] =
1443 " Usage: RECEIVE CHAR <timeout>\n"
1444 "       Receives a character of text on a channel. Specify timeout to be the\n"
1445 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
1446 " do not support the reception of text. Returns the decimal value of the character\n"
1447 " if one is received, or 0 if the channel does not support text reception.  Returns\n"
1448 " -1 only on error/hangup.\n";
1449
1450 static char usage_recvtext[] =
1451 " Usage: RECEIVE TEXT <timeout>\n"
1452 "       Receives a string of text on a channel. Specify timeout to be the\n"
1453 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
1454 " do not support the reception of text. Returns -1 for failure or 1 for success, and the string in parentheses.\n";
1455
1456 static char usage_tddmode[] =
1457 " Usage: TDD MODE <on|off>\n"
1458 "       Enable/Disable TDD transmission/reception on a channel. Returns 1 if\n"
1459 " successful, or 0 if channel is not TDD-capable.\n";
1460
1461 static char usage_sendimage[] =
1462 " Usage: SEND IMAGE <image>\n"
1463 "       Sends the given image on a channel. Most channels do not support the\n"
1464 " transmission of images. Returns 0 if image is sent, or if the channel does not\n"
1465 " support image transmission.  Returns -1 only on error/hangup. Image names\n"
1466 " should not include extensions.\n";
1467
1468 static char usage_streamfile[] =
1469 " Usage: STREAM FILE <filename> <escape digits> [sample offset]\n"
1470 "       Send the given file, allowing playback to be interrupted by the given\n"
1471 " digits, if any. Use double quotes for the digits if you wish none to be\n"
1472 " permitted. If sample offset is provided then the audio will seek to sample\n"
1473 " offset before play starts.  Returns 0 if playback completes without a digit\n"
1474 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
1475 " or -1 on error or if the channel was disconnected. Remember, the file\n"
1476 " extension must not be included in the filename.\n";
1477
1478 static char usage_controlstreamfile[] =
1479 " Usage: CONTROL STREAM FILE <filename> <escape digits> [skipms] [ffchar] [rewchr] [pausechr]\n"
1480 "       Send the given file, allowing playback to be controled by the given\n"
1481 " digits, if any. Use double quotes for the digits if you wish none to be\n"
1482 " permitted.  Returns 0 if playback completes without a digit\n"
1483 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
1484 " or -1 on error or if the channel was disconnected. Remember, the file\n"
1485 " extension must not be included in the filename.\n\n"
1486 " Note: ffchar and rewchar default to * and # respectively.\n";
1487
1488 static char usage_getoption[] = 
1489 " Usage: GET OPTION <filename> <escape_digits> [timeout]\n"
1490 "       Behaves similar to STREAM FILE but used with a timeout option.\n";
1491
1492 static char usage_saynumber[] =
1493 " Usage: SAY NUMBER <number> <escape digits> [gender]\n"
1494 "       Say a given number, returning early if any of the given DTMF digits\n"
1495 " are received on the channel.  Returns 0 if playback completes without a digit\n"
1496 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1497 " -1 on error/hangup.\n";
1498
1499 static char usage_saydigits[] =
1500 " Usage: SAY DIGITS <number> <escape digits>\n"
1501 "       Say a given digit string, returning early if any of the given DTMF digits\n"
1502 " are received on the channel. Returns 0 if playback completes without a digit\n"
1503 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1504 " -1 on error/hangup.\n";
1505
1506 static char usage_sayalpha[] =
1507 " Usage: SAY ALPHA <number> <escape digits>\n"
1508 "       Say a given character string, returning early if any of the given DTMF digits\n"
1509 " are received on the channel. Returns 0 if playback completes without a digit\n"
1510 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1511 " -1 on error/hangup.\n";
1512
1513 static char usage_saydate[] =
1514 " Usage: SAY DATE <date> <escape digits>\n"
1515 "       Say a given date, returning early if any of the given DTMF digits are\n"
1516 " received on the channel.  <date> is number of seconds elapsed since 00:00:00\n"
1517 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
1518 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1519 " digit if one was pressed or -1 on error/hangup.\n";
1520
1521 static char usage_saytime[] =
1522 " Usage: SAY TIME <time> <escape digits>\n"
1523 "       Say a given time, returning early if any of the given DTMF digits are\n"
1524 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
1525 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
1526 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1527 " digit if one was pressed or -1 on error/hangup.\n";
1528
1529 static char usage_saydatetime[] =
1530 " Usage: SAY DATETIME <time> <escape digits> [format] [timezone]\n"
1531 "       Say a given time, returning early if any of the given DTMF digits are\n"
1532 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
1533 " on January 1, 1970, Coordinated Universal Time (UTC). [format] is the format\n"
1534 " the time should be said in.  See voicemail.conf (defaults to \"ABdY\n"
1535 " 'digits/at' IMp\").  Acceptable values for [timezone] can be found in\n"
1536 " /usr/share/zoneinfo.  Defaults to machine default. Returns 0 if playback\n"
1537 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1538 " digit if one was pressed or -1 on error/hangup.\n";
1539
1540 static char usage_sayphonetic[] =
1541 " Usage: SAY PHONETIC <string> <escape digits>\n"
1542 "       Say a given character string with phonetics, returning early if any of the\n"
1543 " given DTMF digits are received on the channel. Returns 0 if playback\n"
1544 " completes without a digit pressed, the ASCII numerical value of the digit\n"
1545 " if one was pressed, or -1 on error/hangup.\n";
1546
1547 static char usage_getdata[] =
1548 " Usage: GET DATA <file to be streamed> [timeout] [max digits]\n"
1549 "       Stream the given file, and recieve DTMF data. Returns the digits received\n"
1550 "from the channel at the other end.\n";
1551
1552 static char usage_setcontext[] =
1553 " Usage: SET CONTEXT <desired context>\n"
1554 "       Sets the context for continuation upon exiting the application.\n";
1555
1556 static char usage_setextension[] =
1557 " Usage: SET EXTENSION <new extension>\n"
1558 "       Changes the extension for continuation upon exiting the application.\n";
1559
1560 static char usage_setpriority[] =
1561 " Usage: SET PRIORITY <priority>\n"
1562 "       Changes the priority for continuation upon exiting the application.\n"
1563 " The priority must be a valid priority or label.\n";
1564
1565 static char usage_recordfile[] =
1566 " Usage: RECORD FILE <filename> <format> <escape digits> <timeout> \\\n"
1567 "                                          [offset samples] [BEEP] [s=silence]\n"
1568 "       Record to a file until a given dtmf digit in the sequence is received\n"
1569 " Returns -1 on hangup or error.  The format will specify what kind of file\n"
1570 " will be recorded.  The timeout is the maximum record time in milliseconds, or\n"
1571 " -1 for no timeout. \"Offset samples\" is optional, and, if provided, will seek\n"
1572 " to the offset without exceeding the end of the file.  \"silence\" is the number\n"
1573 " of seconds of silence allowed before the function returns despite the\n"
1574 " lack of dtmf digits or reaching timeout.  Silence value must be\n"
1575 " preceeded by \"s=\" and is also optional.\n";
1576
1577 static char usage_autohangup[] =
1578 " Usage: SET AUTOHANGUP <time>\n"
1579 "       Cause the channel to automatically hangup at <time> seconds in the\n"
1580 " future.  Of course it can be hungup before then as well. Setting to 0 will\n"
1581 " cause the autohangup feature to be disabled on this channel.\n";
1582
1583 static char usage_noop[] =
1584 " Usage: NoOp\n"
1585 "       Does nothing.\n";
1586
1587 /*!
1588  * \brief AGI commands
1589  *
1590  * \todo XXX This array is not handled in a thread safe way.  There is no
1591  * synchronization done at all between the agi register and unregister functions
1592  * and the rest of this module which uses the entries here.
1593  */
1594 static agi_command commands[MAX_COMMANDS] = {
1595         { { "answer", NULL }, handle_answer, "Answer channel", usage_answer },
1596         { { "channel", "status", NULL }, handle_channelstatus, "Returns status of the connected channel", usage_channelstatus },
1597         { { "database", "del", NULL }, handle_dbdel, "Removes database key/value", usage_dbdel },
1598         { { "database", "deltree", NULL }, handle_dbdeltree, "Removes database keytree/value", usage_dbdeltree },
1599         { { "database", "get", NULL }, handle_dbget, "Gets database value", usage_dbget },
1600         { { "database", "put", NULL }, handle_dbput, "Adds/updates database value", usage_dbput },
1601         { { "exec", NULL }, handle_exec, "Executes a given Application", usage_exec },
1602         { { "get", "data", NULL }, handle_getdata, "Prompts for DTMF on a channel", usage_getdata },
1603         { { "get", "full", "variable", NULL }, handle_getvariablefull, "Evaluates a channel expression", usage_getvariablefull },
1604         { { "get", "option", NULL }, handle_getoption, "Stream file, prompt for DTMF, with timeout", usage_getoption },
1605         { { "get", "variable", NULL }, handle_getvariable, "Gets a channel variable", usage_getvariable },
1606         { { "hangup", NULL }, handle_hangup, "Hangup the current channel", usage_hangup },
1607         { { "noop", NULL }, handle_noop, "Does nothing", usage_noop },
1608         { { "receive", "char", NULL }, handle_recvchar, "Receives one character from channels supporting it", usage_recvchar },
1609         { { "receive", "text", NULL }, handle_recvtext, "Receives text from channels supporting it", usage_recvtext },
1610         { { "record", "file", NULL }, handle_recordfile, "Records to a given file", usage_recordfile },
1611         { { "say", "alpha", NULL }, handle_sayalpha, "Says a given character string", usage_sayalpha },
1612         { { "say", "digits", NULL }, handle_saydigits, "Says a given digit string", usage_saydigits },
1613         { { "say", "number", NULL }, handle_saynumber, "Says a given number", usage_saynumber },
1614         { { "say", "phonetic", NULL }, handle_sayphonetic, "Says a given character string with phonetics", usage_sayphonetic },
1615         { { "say", "date", NULL }, handle_saydate, "Says a given date", usage_saydate },
1616         { { "say", "time", NULL }, handle_saytime, "Says a given time", usage_saytime },
1617         { { "say", "datetime", NULL }, handle_saydatetime, "Says a given time as specfied by the format given", usage_saydatetime },
1618         { { "send", "image", NULL }, handle_sendimage, "Sends images to channels supporting it", usage_sendimage },
1619         { { "send", "text", NULL }, handle_sendtext, "Sends text to channels supporting it", usage_sendtext },
1620         { { "set", "autohangup", NULL }, handle_autohangup, "Autohangup channel in some time", usage_autohangup },
1621         { { "set", "callerid", NULL }, handle_setcallerid, "Sets callerid for the current channel", usage_setcallerid },
1622         { { "set", "context", NULL }, handle_setcontext, "Sets channel context", usage_setcontext },
1623         { { "set", "extension", NULL }, handle_setextension, "Changes channel extension", usage_setextension },
1624         { { "set", "music", NULL }, handle_setmusic, "Enable/Disable Music on hold generator", usage_setmusic },
1625         { { "set", "priority", NULL }, handle_setpriority, "Set channel dialplan priority", usage_setpriority },
1626         { { "set", "variable", NULL }, handle_setvariable, "Sets a channel variable", usage_setvariable },
1627         { { "stream", "file", NULL }, handle_streamfile, "Sends audio file on channel", usage_streamfile },
1628         { { "control", "stream", "file", NULL }, handle_controlstreamfile, "Sends audio file on channel and allows the listner to control the stream", usage_controlstreamfile },
1629         { { "tdd", "mode", NULL }, handle_tddmode, "Toggles TDD mode (for the deaf)", usage_tddmode },
1630         { { "verbose", NULL }, handle_verbose, "Logs a message to the asterisk verbose log", usage_verbose },
1631         { { "wait", "for", "digit", NULL }, handle_waitfordigit, "Waits for a digit to be pressed", usage_waitfordigit },
1632 };
1633
1634 static int help_workhorse(int fd, char *match[])
1635 {
1636         char fullcmd[80], matchstr[80];
1637         int x;
1638         struct agi_command *e;
1639
1640         if (match)
1641                 ast_join(matchstr, sizeof(matchstr), match);
1642
1643         for (x = 0; x < sizeof(commands) / sizeof(commands[0]); x++) {
1644                 e = &commands[x]; 
1645                 if (!e->cmda[0])
1646                         break;
1647                 /* Hide commands that start with '_' */
1648                 if ((e->cmda[0])[0] == '_')
1649                         continue;
1650                 ast_join(fullcmd, sizeof(fullcmd), e->cmda);
1651                 if (match && strncasecmp(matchstr, fullcmd, strlen(matchstr)))
1652                         continue;
1653                 ast_cli(fd, "%20.20s   %s\n", fullcmd, e->summary);
1654         }
1655         return 0;
1656 }
1657
1658 int ast_agi_register(agi_command *agi)
1659 {
1660         int x;
1661
1662         for (x = 0; x < MAX_COMMANDS - 1; x++) {
1663                 if (commands[x].cmda[0] == agi->cmda[0]) {
1664                         ast_log(LOG_WARNING, "Command already registered!\n");
1665                         return -1;
1666                 }
1667         }
1668         for (x = 0; x < MAX_COMMANDS - 1; x++) {
1669                 if (!commands[x].cmda[0]) {
1670                         commands[x] = *agi;
1671                         return 0;
1672                 }
1673         }
1674         ast_log(LOG_WARNING, "No more room for new commands!\n");
1675         return -1;
1676 }
1677
1678 void ast_agi_unregister(agi_command *agi)
1679 {
1680         int x;
1681         for (x = 0; x < MAX_COMMANDS - 1; x++) {
1682                 if (commands[x].cmda[0] == agi->cmda[0]) {
1683                         memset(&commands[x], 0, sizeof(agi_command));
1684                 }
1685         }
1686 }
1687
1688 static agi_command *find_command(char *cmds[], int exact)
1689 {
1690         int x, y, match;
1691
1692         for (x = 0; x < sizeof(commands) / sizeof(commands[0]); x++) {
1693                 if (!commands[x].cmda[0])
1694                         break;
1695                 /* start optimistic */
1696                 match = 1;
1697                 for (y = 0; match && cmds[y]; y++) {
1698                         /* If there are no more words in the command (and we're looking for
1699                            an exact match) or there is a difference between the two words,
1700                            then this is not a match */
1701                         if (!commands[x].cmda[y] && !exact)
1702                                 break;
1703                         /* don't segfault if the next part of a command doesn't exist */
1704                         if (!commands[x].cmda[y])
1705                                 return NULL;
1706                         if (strcasecmp(commands[x].cmda[y], cmds[y]))
1707                                 match = 0;
1708                 }
1709                 /* If more words are needed to complete the command then this is not
1710                    a candidate (unless we're looking for a really inexact answer  */
1711                 if ((exact > -1) && commands[x].cmda[y])
1712                         match = 0;
1713                 if (match)
1714                         return &commands[x];
1715         }
1716         return NULL;
1717 }
1718
1719
1720 static int parse_args(char *s, int *max, char *argv[])
1721 {
1722         int x = 0, quoted = 0, escaped = 0, whitespace = 1;
1723         char *cur;
1724
1725         cur = s;
1726         while(*s) {
1727                 switch(*s) {
1728                 case '"':
1729                         /* If it's escaped, put a literal quote */
1730                         if (escaped) 
1731                                 goto normal;
1732                         else 
1733                                 quoted = !quoted;
1734                         if (quoted && whitespace) {
1735                                 /* If we're starting a quote, coming off white space start a new word, too */
1736                                 argv[x++] = cur;
1737                                 whitespace=0;
1738                         }
1739                         escaped = 0;
1740                 break;
1741                 case ' ':
1742                 case '\t':
1743                         if (!quoted && !escaped) {
1744                                 /* If we're not quoted, mark this as whitespace, and
1745                                    end the previous argument */
1746                                 whitespace = 1;
1747                                 *(cur++) = '\0';
1748                         } else
1749                                 /* Otherwise, just treat it as anything else */ 
1750                                 goto normal;
1751                         break;
1752                 case '\\':
1753                         /* If we're escaped, print a literal, otherwise enable escaping */
1754                         if (escaped) {
1755                                 goto normal;
1756                         } else {
1757                                 escaped=1;
1758                         }
1759                         break;
1760                 default:
1761 normal:
1762                         if (whitespace) {
1763                                 if (x >= MAX_ARGS -1) {
1764                                         ast_log(LOG_WARNING, "Too many arguments, truncating\n");
1765                                         break;
1766                                 }
1767                                 /* Coming off of whitespace, start the next argument */
1768                                 argv[x++] = cur;
1769                                 whitespace=0;
1770                         }
1771                         *(cur++) = *s;
1772                         escaped=0;
1773                 }
1774                 s++;
1775         }
1776         /* Null terminate */
1777         *(cur++) = '\0';
1778         argv[x] = NULL;
1779         *max = x;
1780         return 0;
1781 }
1782
1783 static int agi_handle_command(struct ast_channel *chan, AGI *agi, char *buf)
1784 {
1785         char *argv[MAX_ARGS];
1786         int argc = MAX_ARGS, res;
1787         agi_command *c;
1788
1789         parse_args(buf, &argc, argv);
1790         if ((c = find_command(argv, 0))) {
1791                 res = c->handler(chan, agi, argc, argv);
1792                 switch(res) {
1793                 case RESULT_SHOWUSAGE:
1794                         fdprintf(agi->fd, "520-Invalid command syntax.  Proper usage follows:\n");
1795                         fdprintf(agi->fd, c->usage);
1796                         fdprintf(agi->fd, "520 End of proper usage.\n");
1797                         break;
1798                 case AST_PBX_KEEPALIVE:
1799                         /* We've been asked to keep alive, so do so */
1800                         return AST_PBX_KEEPALIVE;
1801                         break;
1802                 case RESULT_FAILURE:
1803                         /* They've already given the failure.  We've been hung up on so handle this
1804                            appropriately */
1805                         return -1;
1806                 }
1807         } else {
1808                 fdprintf(agi->fd, "510 Invalid or unknown command\n");
1809         }
1810         return 0;
1811 }
1812 #define RETRY   3
1813 static enum agi_result run_agi(struct ast_channel *chan, char *request, AGI *agi, int pid, int *status, int dead, int argc, char *argv[])
1814 {
1815         struct ast_channel *c;
1816         int outfd, ms;
1817         enum agi_result returnstatus = AGI_RESULT_SUCCESS;
1818         struct ast_frame *f;
1819         char buf[2048];
1820         FILE *readf;
1821         /* how many times we'll retry if ast_waitfor_nandfs will return without either 
1822           channel or file descriptor in case select is interrupted by a system call (EINTR) */
1823         int retry = RETRY;
1824
1825         if (!(readf = fdopen(agi->ctrl, "r"))) {
1826                 ast_log(LOG_WARNING, "Unable to fdopen file descriptor\n");
1827                 if (pid > -1)
1828                         kill(pid, SIGHUP);
1829                 close(agi->ctrl);
1830                 return AGI_RESULT_FAILURE;
1831         }
1832         setlinebuf(readf);
1833         setup_env(chan, request, agi->fd, (agi->audio > -1), argc, argv);
1834         for (;;) {
1835                 ms = -1;
1836                 c = ast_waitfor_nandfds(&chan, dead ? 0 : 1, &agi->ctrl, 1, NULL, &outfd, &ms);
1837                 if (c) {
1838                         retry = RETRY;
1839                         /* Idle the channel until we get a command */
1840                         f = ast_read(c);
1841                         if (!f) {
1842                                 ast_debug(1, "%s hungup\n", chan->name);
1843                                 returnstatus = AGI_RESULT_HANGUP;
1844                                 break;
1845                         } else {
1846                                 /* If it's voice, write it to the audio pipe */
1847                                 if ((agi->audio > -1) && (f->frametype == AST_FRAME_VOICE)) {
1848                                         /* Write, ignoring errors */
1849                                         write(agi->audio, f->data, f->datalen);
1850                                 }
1851                                 ast_frfree(f);
1852                         }
1853                 } else if (outfd > -1) {
1854                         retry = RETRY;
1855                         if (!fgets(buf, sizeof(buf), readf)) {
1856                                 /* Program terminated */
1857                                 if (returnstatus)
1858                                         returnstatus = -1;
1859                                 if (option_verbose > 2) 
1860                                         ast_verbose(VERBOSE_PREFIX_3 "AGI Script %s completed, returning %d\n", request, returnstatus);
1861                                 if (pid > 0)
1862                                         waitpid(pid, status, 0);
1863                                 /* No need to kill the pid anymore, since they closed us */
1864                                 pid = -1;
1865                                 break;
1866                         }
1867                         /* get rid of trailing newline, if any */
1868                         if (*buf && buf[strlen(buf) - 1] == '\n')
1869                                 buf[strlen(buf) - 1] = 0;
1870                         if (agidebug)
1871                                 ast_verbose("AGI Rx << %s\n", buf);
1872                         returnstatus |= agi_handle_command(chan, agi, buf);
1873                         /* If the handle_command returns -1, we need to stop */
1874                         if ((returnstatus < 0) || (returnstatus == AST_PBX_KEEPALIVE)) {
1875                                 break;
1876                         }
1877                 } else {
1878                         if (--retry <= 0) {
1879                                 ast_log(LOG_WARNING, "No channel, no fd?\n");
1880                                 returnstatus = AGI_RESULT_FAILURE;
1881                                 break;
1882                         }
1883                 }
1884         }
1885         /* Notify process */
1886         if (pid > -1) {
1887                 const char *sighup = pbx_builtin_getvar_helper(chan, "AGISIGHUP");
1888                 if (ast_strlen_zero(sighup) || !ast_false(sighup)) {
1889                         if (kill(pid, SIGHUP))
1890                                 ast_log(LOG_WARNING, "unable to send SIGHUP to AGI process %d: %s\n", pid, strerror(errno));
1891                 }
1892         }
1893         fclose(readf);
1894         return returnstatus;
1895 }
1896
1897 static int handle_showagi(int fd, int argc, char *argv[])
1898 {
1899         struct agi_command *e;
1900         char fullcmd[80];
1901
1902         if ((argc < 2))
1903                 return RESULT_SHOWUSAGE;
1904
1905         if (argc > 2) {
1906                 e = find_command(argv + 2, 1);
1907                 if (e) 
1908                         ast_cli(fd, e->usage);
1909                 else {
1910                         if (find_command(argv + 2, -1)) {
1911                                 return help_workhorse(fd, argv + 1);
1912                         } else {
1913                                 ast_join(fullcmd, sizeof(fullcmd), argv+1);
1914                                 ast_cli(fd, "No such command '%s'.\n", fullcmd);
1915                         }
1916                 }
1917         } else {
1918                 return help_workhorse(fd, NULL);
1919         }
1920         return RESULT_SUCCESS;
1921 }
1922
1923 /*! \brief Convert string to use HTML escaped characters
1924         \note Maybe this should be a generic function?
1925 */
1926 static void write_html_escaped(FILE *htmlfile, char *str)
1927 {
1928         char *cur = str;
1929
1930         while(*cur) {
1931                 switch (*cur) {
1932                 case '<':
1933                         fprintf(htmlfile, "%s", "&lt;");
1934                         break;
1935                 case '>':
1936                         fprintf(htmlfile, "%s", "&gt;");
1937                         break;
1938                 case '&':
1939                         fprintf(htmlfile, "%s", "&amp;");
1940                         break;
1941                 case '"':
1942                         fprintf(htmlfile, "%s", "&quot;");
1943                         break;
1944                 default:
1945                         fprintf(htmlfile, "%c", *cur);
1946                         break;
1947                 }
1948                 cur++;
1949         }
1950
1951         return;
1952 }
1953
1954 static int handle_agidumphtml(int fd, int argc, char *argv[])
1955 {
1956         struct agi_command *e;
1957         char fullcmd[80];
1958         int x;
1959         FILE *htmlfile;
1960
1961         if ((argc < 3))
1962                 return RESULT_SHOWUSAGE;
1963
1964         if (!(htmlfile = fopen(argv[2], "wt"))) {
1965                 ast_cli(fd, "Could not create file '%s'\n", argv[2]);
1966                 return RESULT_SHOWUSAGE;
1967         }
1968
1969         fprintf(htmlfile, "<HTML>\n<HEAD>\n<TITLE>AGI Commands</TITLE>\n</HEAD>\n");
1970         fprintf(htmlfile, "<BODY>\n<CENTER><B><H1>AGI Commands</H1></B></CENTER>\n\n");
1971
1972
1973         fprintf(htmlfile, "<TABLE BORDER=\"0\" CELLSPACING=\"10\">\n");
1974
1975         for (x = 0; x < sizeof(commands) / sizeof(commands[0]); x++) {
1976                 char *stringp, *tempstr;
1977
1978                 e = &commands[x]; 
1979                 if (!e->cmda[0])        /* end ? */
1980                         break;
1981                 /* Hide commands that start with '_' */
1982                 if ((e->cmda[0])[0] == '_')
1983                         continue;
1984                 ast_join(fullcmd, sizeof(fullcmd), e->cmda);
1985
1986                 fprintf(htmlfile, "<TR><TD><TABLE BORDER=\"1\" CELLPADDING=\"5\" WIDTH=\"100%%\">\n");
1987                 fprintf(htmlfile, "<TR><TH ALIGN=\"CENTER\"><B>%s - %s</B></TH></TR>\n", fullcmd,e->summary);
1988
1989                 stringp=e->usage;
1990                 tempstr = strsep(&stringp, "\n");
1991
1992                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">");
1993                 write_html_escaped(htmlfile, tempstr);
1994                 fprintf(htmlfile, "</TD></TR>\n");
1995
1996                 
1997                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">\n");
1998                 while ((tempstr = strsep(&stringp, "\n")) != NULL) {
1999                         write_html_escaped(htmlfile, tempstr);
2000                         fprintf(htmlfile, "<BR>\n");
2001                 }
2002                 fprintf(htmlfile, "</TD></TR>\n");
2003                 fprintf(htmlfile, "</TABLE></TD></TR>\n\n");
2004
2005         }
2006
2007         fprintf(htmlfile, "</TABLE>\n</BODY>\n</HTML>\n");
2008         fclose(htmlfile);
2009         ast_cli(fd, "AGI HTML Commands Dumped to: %s\n", argv[2]);
2010         return RESULT_SUCCESS;
2011 }
2012
2013 static int agi_exec_full(struct ast_channel *chan, void *data, int enhanced, int dead)
2014 {
2015         enum agi_result res;
2016         struct ast_module_user *u;
2017         char *argv[MAX_ARGS], buf[2048] = "", *tmp = buf, *stringp;
2018         int argc = 0, fds[2], efd = -1, pid;
2019         AGI agi;
2020
2021         if (ast_strlen_zero(data)) {
2022                 ast_log(LOG_WARNING, "AGI requires an argument (script)\n");
2023                 return -1;
2024         }
2025         ast_copy_string(buf, data, sizeof(buf));
2026
2027         memset(&agi, 0, sizeof(agi));
2028         while ((stringp = strsep(&tmp, "|")) && argc < MAX_ARGS-1)
2029                 argv[argc++] = stringp;
2030         argv[argc] = NULL;
2031
2032         u = ast_module_user_add(chan);
2033 #if 0
2034          /* Answer if need be */
2035         if (chan->_state != AST_STATE_UP) {
2036                 if (ast_answer(chan)) {
2037                         LOCAL_USER_REMOVE(u);
2038                         return -1;
2039                 }
2040         }
2041 #endif
2042         res = launch_script(argv[0], argv, fds, enhanced ? &efd : NULL, &pid);
2043         if (res == AGI_RESULT_SUCCESS) {
2044                 int status = 0;
2045                 agi.fd = fds[1];
2046                 agi.ctrl = fds[0];
2047                 agi.audio = efd;
2048                 res = run_agi(chan, argv[0], &agi, pid, &status, dead, argc, argv);
2049                 /* If the fork'd process returns non-zero, set AGISTATUS to FAILURE */
2050                 if (res == AGI_RESULT_SUCCESS && status)
2051                         res = AGI_RESULT_FAILURE;
2052                 if (fds[1] != fds[0])
2053                         close(fds[1]);
2054                 if (efd > -1)
2055                         close(efd);
2056                 ast_unreplace_sigchld();
2057         }
2058         ast_module_user_remove(u);
2059
2060         switch (res) {
2061         case AGI_RESULT_SUCCESS:
2062                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "SUCCESS");
2063                 break;
2064         case AGI_RESULT_FAILURE:
2065                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "FAILURE");
2066                 break;
2067         case AGI_RESULT_NOTFOUND:
2068                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "NOTFOUND");
2069                 break;
2070         case AGI_RESULT_HANGUP:
2071                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "HANGUP");
2072                 return -1;
2073         }
2074
2075         return 0;
2076 }
2077
2078 static int agi_exec(struct ast_channel *chan, void *data)
2079 {
2080         if (chan->_softhangup)
2081                 ast_log(LOG_WARNING, "If you want to run AGI on hungup channels you should use DeadAGI!\n");
2082         return agi_exec_full(chan, data, 0, 0);
2083 }
2084
2085 static int eagi_exec(struct ast_channel *chan, void *data)
2086 {
2087         int readformat, res;
2088
2089         if (chan->_softhangup)
2090                 ast_log(LOG_WARNING, "If you want to run AGI on hungup channels you should use DeadAGI!\n");
2091         readformat = chan->readformat;
2092         if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
2093                 ast_log(LOG_WARNING, "Unable to set channel '%s' to linear mode\n", chan->name);
2094                 return -1;
2095         }
2096         res = agi_exec_full(chan, data, 1, 0);
2097         if (!res) {
2098                 if (ast_set_read_format(chan, readformat)) {
2099                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %s\n", chan->name, ast_getformatname(readformat));
2100                 }
2101         }
2102         return res;
2103 }
2104
2105 static int deadagi_exec(struct ast_channel *chan, void *data)
2106 {
2107         return agi_exec_full(chan, data, 0, 1);
2108 }
2109
2110 static char showagi_help[] =
2111 "Usage: agi show [topic]\n"
2112 "       When called with a topic as an argument, displays usage\n"
2113 "       information on the given command.  If called without a\n"
2114 "       topic, it provides a list of AGI commands.\n";
2115
2116
2117 static char dumpagihtml_help[] =
2118 "Usage: agi dumphtml <filename>\n"
2119 "       Dumps the agi command list in html format to given filename\n";
2120
2121 static struct ast_cli_entry cli_agi[] = {
2122         { { "agi", "debug", NULL },
2123         agi_do_debug, "Enable AGI debugging",
2124         debug_usage },
2125
2126         { { "agi", "debug", "off", NULL },
2127         agi_no_debug, "Disable AGI debugging",
2128         no_debug_usage },
2129
2130         { { "agi", "show", NULL },
2131         handle_showagi, "List AGI commands or specific help",
2132         showagi_help },
2133
2134         { { "agi", "dumphtml", NULL },
2135         handle_agidumphtml, "Dumps a list of agi commands in html format",
2136         dumpagihtml_help },
2137 };
2138
2139 static int unload_module(void)
2140 {
2141         ast_cli_unregister_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2142         ast_unregister_application(eapp);
2143         ast_unregister_application(deadapp);
2144         return ast_unregister_application(app);
2145 }
2146
2147 static int load_module(void)
2148 {
2149         ast_cli_register_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2150         ast_register_application(deadapp, deadagi_exec, deadsynopsis, descrip);
2151         ast_register_application(eapp, eagi_exec, esynopsis, descrip);
2152         return ast_register_application(app, agi_exec, synopsis, descrip);
2153 }
2154
2155 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Asterisk Gateway Interface (AGI)",
2156                 .load = load_module,
2157                 .unload = unload_module,
2158                 );