start using asterisk/network.h for network related headers.
[asterisk/asterisk.git] / res / res_agi.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief AGI - the Asterisk Gateway Interface
22  *
23  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <math.h>
31 #include <signal.h>
32 #include <sys/time.h>
33 #include <fcntl.h>
34 #include <errno.h>
35 #include <sys/wait.h>
36 #include <sys/stat.h>
37
38 #include "asterisk/network.h"
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/module.h"
44 #include "asterisk/astdb.h"
45 #include "asterisk/callerid.h"
46 #include "asterisk/cli.h"
47 #include "asterisk/options.h"
48 #include "asterisk/image.h"
49 #include "asterisk/say.h"
50 #include "asterisk/app.h"
51 #include "asterisk/dsp.h"
52 #include "asterisk/musiconhold.h"
53 #include "asterisk/utils.h"
54 #include "asterisk/lock.h"
55 #include "asterisk/strings.h"
56 #include "asterisk/agi.h"
57
58 #define MAX_ARGS 128
59 #define AGI_NANDFS_RETRY 3
60 #define AGI_BUF_LEN 2048
61
62 static char *app = "AGI";
63
64 static char *eapp = "EAGI";
65
66 static char *deadapp = "DeadAGI";
67
68 static char *synopsis = "Executes an AGI compliant application";
69 static char *esynopsis = "Executes an EAGI compliant application";
70 static char *deadsynopsis = "Executes AGI on a hungup channel";
71
72 static char *descrip =
73 "  [E|Dead]AGI(command,args): Executes an Asterisk Gateway Interface compliant\n"
74 "program on a channel. AGI allows Asterisk to launch external programs\n"
75 "written in any language to control a telephony channel, play audio,\n"
76 "read DTMF digits, etc. by communicating with the AGI protocol on stdin\n"
77 "and stdout.\n"
78 "  This channel will stop dialplan execution on hangup inside of this\n"
79 "application, except when using DeadAGI.  Otherwise, dialplan execution\n"
80 "will continue normally.\n"
81 "  A locally executed AGI script will receive SIGHUP on hangup from the channel\n"
82 "except when using DeadAGI. This can be disabled by setting the AGISIGHUP channel\n"
83 "variable to \"no\" before executing the AGI application.\n"
84 "  Using 'EAGI' provides enhanced AGI, with incoming audio available out of band\n"
85 "on file descriptor 3\n\n"
86 "  Use the CLI command 'agi show' to list available agi commands\n"
87 "  This application sets the following channel variable upon completion:\n"
88 "     AGISTATUS      The status of the attempt to the run the AGI script\n"
89 "                    text string, one of SUCCESS | FAILED | NOTFOUND | HANGUP\n";
90
91 static int agidebug = 0;
92
93 #define TONE_BLOCK_SIZE 200
94
95 /* Max time to connect to an AGI remote host */
96 #define MAX_AGI_CONNECT 2000
97
98 #define AGI_PORT 4573
99
100 enum agi_result {
101         AGI_RESULT_SUCCESS,
102         AGI_RESULT_SUCCESS_FAST,
103         AGI_RESULT_FAILURE,
104         AGI_RESULT_NOTFOUND,
105         AGI_RESULT_HANGUP,
106 };
107
108 static agi_command *find_command(char *cmds[], int exact);
109
110 AST_THREADSTORAGE(agi_buf);
111 #define AGI_BUF_INITSIZE 256
112
113 int ast_agi_fdprintf(struct ast_channel *chan, int fd, char *fmt, ...)
114 {
115         int res = 0;
116         va_list ap;
117         struct ast_str *buf;
118
119         if (!(buf = ast_str_thread_get(&agi_buf, AGI_BUF_INITSIZE)))
120                 return -1;
121
122         va_start(ap, fmt);
123         res = ast_str_set_va(&buf, 0, fmt, ap);
124         va_end(ap);
125
126         if (res == -1) {
127                 ast_log(LOG_ERROR, "Out of memory\n");
128                 return -1;
129         }
130
131         if (agidebug) {
132                 if (chan) {
133                         ast_verbose("<%s>AGI Tx >> %s", chan->name, buf->str);
134                 } else {
135                         ast_verbose("AGI Tx >> %s", buf->str);
136                 }
137         }
138
139         return ast_carefulwrite(fd, buf->str, buf->used, 100);
140 }
141
142 /* launch_netscript: The fastagi handler.
143         FastAGI defaults to port 4573 */
144 static enum agi_result launch_netscript(char *agiurl, char *argv[], int *fds, int *efd, int *opid)
145 {
146         int s, flags, res, port = AGI_PORT;
147         struct pollfd pfds[1];
148         char *host, *c, *script = "";
149         struct sockaddr_in sin;
150         struct hostent *hp;
151         struct ast_hostent ahp;
152
153         /* agiusl is "agi://host.domain[:port][/script/name]" */
154         host = ast_strdupa(agiurl + 6); /* Remove agi:// */
155         /* Strip off any script name */
156         if ((c = strchr(host, '/'))) {
157                 *c = '\0';
158                 c++;
159                 script = c;
160         }
161         if ((c = strchr(host, ':'))) {
162                 *c = '\0';
163                 c++;
164                 port = atoi(c);
165         }
166         if (efd) {
167                 ast_log(LOG_WARNING, "AGI URI's don't support Enhanced AGI yet\n");
168                 return -1;
169         }
170         if (!(hp = ast_gethostbyname(host, &ahp))) {
171                 ast_log(LOG_WARNING, "Unable to locate host '%s'\n", host);
172                 return -1;
173         }
174         if ((s = socket(AF_INET, SOCK_STREAM, 0)) < 0) {
175                 ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno));
176                 return -1;
177         }
178         if ((flags = fcntl(s, F_GETFL)) < 0) {
179                 ast_log(LOG_WARNING, "Fcntl(F_GETFL) failed: %s\n", strerror(errno));
180                 close(s);
181                 return -1;
182         }
183         if (fcntl(s, F_SETFL, flags | O_NONBLOCK) < 0) {
184                 ast_log(LOG_WARNING, "Fnctl(F_SETFL) failed: %s\n", strerror(errno));
185                 close(s);
186                 return -1;
187         }
188         memset(&sin, 0, sizeof(sin));
189         sin.sin_family = AF_INET;
190         sin.sin_port = htons(port);
191         memcpy(&sin.sin_addr, hp->h_addr, sizeof(sin.sin_addr));
192         if (connect(s, (struct sockaddr *)&sin, sizeof(sin)) && (errno != EINPROGRESS)) {
193                 ast_log(LOG_WARNING, "Connect failed with unexpected error: %s\n", strerror(errno));
194                 close(s);
195                 return AGI_RESULT_FAILURE;
196         }
197
198         pfds[0].fd = s;
199         pfds[0].events = POLLOUT;
200         while ((res = poll(pfds, 1, MAX_AGI_CONNECT)) != 1) {
201                 if (errno != EINTR) {
202                         if (!res) {
203                                 ast_log(LOG_WARNING, "FastAGI connection to '%s' timed out after MAX_AGI_CONNECT (%d) milliseconds.\n",
204                                         agiurl, MAX_AGI_CONNECT);
205                         } else
206                                 ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
207                         close(s);
208                         return AGI_RESULT_FAILURE;
209                 }
210         }
211
212         if (ast_agi_fdprintf(NULL, s, "agi_network: yes\n") < 0) {
213                 if (errno != EINTR) {
214                         ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
215                         close(s);
216                         return AGI_RESULT_FAILURE;
217                 }
218         }
219
220         /* If we have a script parameter, relay it to the fastagi server */
221         /* Script parameters take the form of: AGI(agi://my.example.com/?extension=${EXTEN}) */
222         if (!ast_strlen_zero(script))
223                 ast_agi_fdprintf(NULL, s, "agi_network_script: %s\n", script);
224
225         ast_debug(4, "Wow, connected!\n");
226         fds[0] = s;
227         fds[1] = s;
228         *opid = -1;
229         return AGI_RESULT_SUCCESS_FAST;
230 }
231
232 static enum agi_result launch_script(char *script, char *argv[], int *fds, int *efd, int *opid)
233 {
234         char tmp[256];
235         int pid, toast[2], fromast[2], audio[2], x, res;
236         sigset_t signal_set, old_set;
237         struct stat st;
238
239         if (!strncasecmp(script, "agi://", 6))
240                 return launch_netscript(script, argv, fds, efd, opid);
241         
242         if (script[0] != '/') {
243                 snprintf(tmp, sizeof(tmp), "%s/%s", ast_config_AST_AGI_DIR, script);
244                 script = tmp;
245         }
246
247         /* Before even trying let's see if the file actually exists */
248         if (stat(script, &st)) {
249                 ast_log(LOG_WARNING, "Failed to execute '%s': File does not exist.\n", script);
250                 return AGI_RESULT_NOTFOUND;
251         }
252
253         if (pipe(toast)) {
254                 ast_log(LOG_WARNING, "Unable to create toast pipe: %s\n",strerror(errno));
255                 return AGI_RESULT_FAILURE;
256         }
257         if (pipe(fromast)) {
258                 ast_log(LOG_WARNING, "unable to create fromast pipe: %s\n", strerror(errno));
259                 close(toast[0]);
260                 close(toast[1]);
261                 return AGI_RESULT_FAILURE;
262         }
263         if (efd) {
264                 if (pipe(audio)) {
265                         ast_log(LOG_WARNING, "unable to create audio pipe: %s\n", strerror(errno));
266                         close(fromast[0]);
267                         close(fromast[1]);
268                         close(toast[0]);
269                         close(toast[1]);
270                         return AGI_RESULT_FAILURE;
271                 }
272                 res = fcntl(audio[1], F_GETFL);
273                 if (res > -1) 
274                         res = fcntl(audio[1], F_SETFL, res | O_NONBLOCK);
275                 if (res < 0) {
276                         ast_log(LOG_WARNING, "unable to set audio pipe parameters: %s\n", strerror(errno));
277                         close(fromast[0]);
278                         close(fromast[1]);
279                         close(toast[0]);
280                         close(toast[1]);
281                         close(audio[0]);
282                         close(audio[1]);
283                         return AGI_RESULT_FAILURE;
284                 }
285         }
286
287         /* Block SIGHUP during the fork - prevents a race */
288         sigfillset(&signal_set);
289         pthread_sigmask(SIG_BLOCK, &signal_set, &old_set);
290         if ((pid = fork()) < 0) {
291                 ast_log(LOG_WARNING, "Failed to fork(): %s\n", strerror(errno));
292                 pthread_sigmask(SIG_SETMASK, &old_set, NULL);
293                 return AGI_RESULT_FAILURE;
294         }
295         if (!pid) {
296                 /* Pass paths to AGI via environmental variables */
297                 setenv("AST_CONFIG_DIR", ast_config_AST_CONFIG_DIR, 1);
298                 setenv("AST_CONFIG_FILE", ast_config_AST_CONFIG_FILE, 1);
299                 setenv("AST_MODULE_DIR", ast_config_AST_MODULE_DIR, 1);
300                 setenv("AST_SPOOL_DIR", ast_config_AST_SPOOL_DIR, 1);
301                 setenv("AST_MONITOR_DIR", ast_config_AST_MONITOR_DIR, 1);
302                 setenv("AST_VAR_DIR", ast_config_AST_VAR_DIR, 1);
303                 setenv("AST_DATA_DIR", ast_config_AST_DATA_DIR, 1);
304                 setenv("AST_LOG_DIR", ast_config_AST_LOG_DIR, 1);
305                 setenv("AST_AGI_DIR", ast_config_AST_AGI_DIR, 1);
306                 setenv("AST_KEY_DIR", ast_config_AST_KEY_DIR, 1);
307                 setenv("AST_RUN_DIR", ast_config_AST_RUN_DIR, 1);
308
309                 /* Don't run AGI scripts with realtime priority -- it causes audio stutter */
310                 ast_set_priority(0);
311
312                 /* Redirect stdin and out, provide enhanced audio channel if desired */
313                 dup2(fromast[0], STDIN_FILENO);
314                 dup2(toast[1], STDOUT_FILENO);
315                 if (efd)
316                         dup2(audio[0], STDERR_FILENO + 1);
317                 else
318                         close(STDERR_FILENO + 1);
319
320                 /* Before we unblock our signals, return our trapped signals back to the defaults */
321                 signal(SIGHUP, SIG_DFL);
322                 signal(SIGCHLD, SIG_DFL);
323                 signal(SIGINT, SIG_DFL);
324                 signal(SIGURG, SIG_DFL);
325                 signal(SIGTERM, SIG_DFL);
326                 signal(SIGPIPE, SIG_DFL);
327                 signal(SIGXFSZ, SIG_DFL);
328
329                 /* unblock important signal handlers */
330                 if (pthread_sigmask(SIG_UNBLOCK, &signal_set, NULL)) {
331                         ast_log(LOG_WARNING, "unable to unblock signals for AGI script: %s\n", strerror(errno));
332                         _exit(1);
333                 }
334
335                 /* Close everything but stdin/out/error */
336                 for (x = STDERR_FILENO + 2; x < 1024; x++) 
337                         close(x);
338
339                 /* Execute script */
340                 /* XXX argv should be deprecated in favor of passing agi_argX paramaters */
341                 execv(script, argv);
342                 /* Can't use ast_log since FD's are closed */
343                 fprintf(stdout, "verbose \"Failed to execute '%s': %s\" 2\n", script, strerror(errno));
344                 fflush(stdout);
345                 _exit(1);
346         }
347         pthread_sigmask(SIG_SETMASK, &old_set, NULL);
348         ast_verb(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         ast_agi_fdprintf(chan, fd, "agi_request: %s\n", request);
371         ast_agi_fdprintf(chan, fd, "agi_channel: %s\n", chan->name);
372         ast_agi_fdprintf(chan, fd, "agi_language: %s\n", chan->language);
373         ast_agi_fdprintf(chan, fd, "agi_type: %s\n", chan->tech->type);
374         ast_agi_fdprintf(chan, fd, "agi_uniqueid: %s\n", chan->uniqueid);
375
376         /* ANI/DNIS */
377         ast_agi_fdprintf(chan, fd, "agi_callerid: %s\n", S_OR(chan->cid.cid_num, "unknown"));
378         ast_agi_fdprintf(chan, fd, "agi_calleridname: %s\n", S_OR(chan->cid.cid_name, "unknown"));
379         ast_agi_fdprintf(chan, fd, "agi_callingpres: %d\n", chan->cid.cid_pres);
380         ast_agi_fdprintf(chan, fd, "agi_callingani2: %d\n", chan->cid.cid_ani2);
381         ast_agi_fdprintf(chan, fd, "agi_callington: %d\n", chan->cid.cid_ton);
382         ast_agi_fdprintf(chan, fd, "agi_callingtns: %d\n", chan->cid.cid_tns);
383         ast_agi_fdprintf(chan, fd, "agi_dnid: %s\n", S_OR(chan->cid.cid_dnid, "unknown"));
384         ast_agi_fdprintf(chan, fd, "agi_rdnis: %s\n", S_OR(chan->cid.cid_rdnis, "unknown"));
385
386         /* Context information */
387         ast_agi_fdprintf(chan, fd, "agi_context: %s\n", chan->context);
388         ast_agi_fdprintf(chan, fd, "agi_extension: %s\n", chan->exten);
389         ast_agi_fdprintf(chan, fd, "agi_priority: %d\n", chan->priority);
390         ast_agi_fdprintf(chan, fd, "agi_enhanced: %s\n", enhanced ? "1.0" : "0.0");
391
392         /* User information */
393         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, fd, "agi_arg_%d: %s\n", count, argv[count]);
399
400         /* End with empty return */
401         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d (timeout)\n", res);
458                 return RESULT_SUCCESS;
459         }
460         if (res > 0) {
461                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
462                 return RESULT_SUCCESS;
463         }
464         else {
465                 ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", buf);
480                 ast_free(buf);
481         } else {        
482                 ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
505         else
506                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=%d endpos=%ld\n", 0, sample_offset);
580                 return RESULT_SUCCESS;
581         }
582
583         if ((vfs = ast_openvstream(chan, argv[2], chan->language)))
584                 ast_debug(1, "Ooh, found a video stream, too\n");
585                 
586         ast_verb(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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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
639         if ((vfs = ast_openvstream(chan, argv[2], chan->language)))
640                 ast_debug(1, "Ooh, found a video stream, too\n");
641         
642         ast_verb(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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
787         return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
788 }
789
790 static int handle_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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=%s (timeout)\n", data);
824         else if (res < 0 )
825                 ast_agi_fdprintf(chan, agi->fd, "200 result=-1\n");
826         else
827                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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                         ast_agi_fdprintf(chan, 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                                 ast_agi_fdprintf(chan, 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                                 ast_agi_fdprintf(chan, 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                                         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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                         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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         ast_verb(3, "AGI Script Executing Application: (%s) Options: (%s)\n", argv[1], argv[2]);
1098
1099         if ((app = pbx_findapp(argv[1]))) {
1100                 res = pbx_exec(chan, app, argv[2]);
1101         } else {
1102                 ast_log(LOG_WARNING, "Could not find application (%s)\n", argv[1]);
1103                 res = -2;
1104         }
1105         ast_agi_fdprintf(chan, agi->fd, "200 result=%d\n", res);
1106
1107         /* Even though this is wrong, users are depending upon this result. */
1108         return res;
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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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                         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", ret);
1181         else
1182                 ast_agi_fdprintf(chan, 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 (chan2) {
1200                 pbx_substitute_variables_helper(chan2, argv[3], tmp, sizeof(tmp) - 1);
1201                 ast_agi_fdprintf(chan, agi->fd, "200 result=1 (%s)\n", tmp);
1202         } else {
1203                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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                 ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1255         else
1256                 ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, 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         ast_agi_fdprintf(chan, agi->fd, "200 result=%c\n", res ? '0' : '1');
1295         return RESULT_SUCCESS;
1296 }
1297
1298 static char *handle_cli_agi_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1299 {
1300         switch (cmd) {
1301         case CLI_INIT:
1302                 e->command = "agi debug [off]";
1303                 e->usage =
1304                         "Usage: agi debug [off]\n"
1305                         "       Enables/disables dumping of AGI transactions for\n"
1306                         "       debugging purposes.\n";
1307                 return NULL;
1308
1309         case CLI_GENERATE:
1310                 return NULL;
1311         }
1312         if (a->argc < e->args - 1 || a->argc > e->args )
1313                 return CLI_SHOWUSAGE;
1314         if (a->argc == e->args - 1) {
1315                 agidebug = 1;
1316         } else {
1317                 if (strncasecmp(a->argv[e->args - 1], "off", 3) == 0) {
1318                         agidebug = 0;
1319                 } else {
1320                         return CLI_SHOWUSAGE;
1321                 }
1322         }
1323         ast_cli(a->fd, "AGI Debugging %sabled\n", agidebug ? "En" : "Dis");
1324         return CLI_SUCCESS;
1325 }
1326
1327 static int handle_noop(struct ast_channel *chan, AGI *agi, int arg, char *argv[])
1328 {
1329         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1330         return RESULT_SUCCESS;
1331 }
1332
1333 static int handle_setmusic(struct ast_channel *chan, AGI *agi, int argc, char *argv[])
1334 {
1335         if (!strncasecmp(argv[2], "on", 2))
1336                 ast_moh_start(chan, argc > 3 ? argv[3] : NULL, NULL);
1337         else if (!strncasecmp(argv[2], "off", 3))
1338                 ast_moh_stop(chan);
1339         ast_agi_fdprintf(chan, agi->fd, "200 result=0\n");
1340         return RESULT_SUCCESS;
1341 }
1342
1343 static char usage_setmusic[] =
1344 " Usage: SET MUSIC ON <on|off> <class>\n"
1345 "       Enables/Disables the music on hold generator.  If <class> is\n"
1346 " not specified, then the default music on hold class will be used.\n"
1347 " Always returns 0.\n";
1348
1349 static char usage_dbput[] =
1350 " Usage: DATABASE PUT <family> <key> <value>\n"
1351 "       Adds or updates an entry in the Asterisk database for a\n"
1352 " given family, key, and value.\n"
1353 " Returns 1 if successful, 0 otherwise.\n";
1354
1355 static char usage_dbget[] =
1356 " Usage: DATABASE GET <family> <key>\n"
1357 "       Retrieves an entry in the Asterisk database for a\n"
1358 " given family and key.\n"
1359 " Returns 0 if <key> is not set.  Returns 1 if <key>\n"
1360 " is set and returns the variable in parentheses.\n"
1361 " Example return code: 200 result=1 (testvariable)\n";
1362
1363 static char usage_dbdel[] =
1364 " Usage: DATABASE DEL <family> <key>\n"
1365 "       Deletes an entry in the Asterisk database for a\n"
1366 " given family and key.\n"
1367 " Returns 1 if successful, 0 otherwise.\n";
1368
1369 static char usage_dbdeltree[] =
1370 " Usage: DATABASE DELTREE <family> [keytree]\n"
1371 "       Deletes a family or specific keytree within a family\n"
1372 " in the Asterisk database.\n"
1373 " Returns 1 if successful, 0 otherwise.\n";
1374
1375 static char usage_verbose[] =
1376 " Usage: VERBOSE <message> <level>\n"
1377 "       Sends <message> to the console via verbose message system.\n"
1378 " <level> is the the verbose level (1-4)\n"
1379 " Always returns 1.\n";
1380
1381 static char usage_getvariable[] =
1382 " Usage: GET VARIABLE <variablename>\n"
1383 "       Returns 0 if <variablename> is not set.  Returns 1 if <variablename>\n"
1384 " is set and returns the variable in parentheses.\n"
1385 " example return code: 200 result=1 (testvariable)\n";
1386
1387 static char usage_getvariablefull[] =
1388 " Usage: GET FULL VARIABLE <variablename> [<channel name>]\n"
1389 "       Returns 0 if <variablename> is not set or channel does not exist.  Returns 1\n"
1390 "if <variablename>  is set and returns the variable in parenthesis.  Understands\n"
1391 "complex variable names and builtin variables, unlike GET VARIABLE.\n"
1392 " example return code: 200 result=1 (testvariable)\n";
1393
1394 static char usage_setvariable[] =
1395 " Usage: SET VARIABLE <variablename> <value>\n";
1396
1397 static char usage_channelstatus[] =
1398 " Usage: CHANNEL STATUS [<channelname>]\n"
1399 "       Returns the status of the specified channel.\n" 
1400 " If no channel name is given the returns the status of the\n"
1401 " current channel.  Return values:\n"
1402 "  0 Channel is down and available\n"
1403 "  1 Channel is down, but reserved\n"
1404 "  2 Channel is off hook\n"
1405 "  3 Digits (or equivalent) have been dialed\n"
1406 "  4 Line is ringing\n"
1407 "  5 Remote end is ringing\n"
1408 "  6 Line is up\n"
1409 "  7 Line is busy\n";
1410
1411 static char usage_setcallerid[] =
1412 " Usage: SET CALLERID <number>\n"
1413 "       Changes the callerid of the current channel.\n";
1414
1415 static char usage_exec[] =
1416 " Usage: EXEC <application> <options>\n"
1417 "       Executes <application> with given <options>.\n"
1418 " Returns whatever the application returns, or -2 on failure to find application\n";
1419
1420 static char usage_hangup[] =
1421 " Usage: HANGUP [<channelname>]\n"
1422 "       Hangs up the specified channel.\n"
1423 " If no channel name is given, hangs up the current channel\n";
1424
1425 static char usage_answer[] = 
1426 " Usage: ANSWER\n"
1427 "       Answers channel if not already in answer state. Returns -1 on\n"
1428 " channel failure, or 0 if successful.\n";
1429
1430 static char usage_waitfordigit[] = 
1431 " Usage: WAIT FOR DIGIT <timeout>\n"
1432 "       Waits up to 'timeout' milliseconds for channel to receive a DTMF digit.\n"
1433 " Returns -1 on channel failure, 0 if no digit is received in the timeout, or\n"
1434 " the numerical value of the ascii of the digit if one is received.  Use -1\n"
1435 " for the timeout value if you desire the call to block indefinitely.\n";
1436
1437 static char usage_sendtext[] =
1438 " Usage: SEND TEXT \"<text to send>\"\n"
1439 "       Sends the given text on a channel. Most channels do not support the\n"
1440 " transmission of text.  Returns 0 if text is sent, or if the channel does not\n"
1441 " support text transmission.  Returns -1 only on error/hangup.  Text\n"
1442 " consisting of greater than one word should be placed in quotes since the\n"
1443 " command only accepts a single argument.\n";
1444
1445 static char usage_recvchar[] =
1446 " Usage: RECEIVE CHAR <timeout>\n"
1447 "       Receives a character of text on a channel. Specify timeout to be the\n"
1448 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
1449 " do not support the reception of text. Returns the decimal value of the character\n"
1450 " if one is received, or 0 if the channel does not support text reception.  Returns\n"
1451 " -1 only on error/hangup.\n";
1452
1453 static char usage_recvtext[] =
1454 " Usage: RECEIVE TEXT <timeout>\n"
1455 "       Receives a string of text on a channel. Specify timeout to be the\n"
1456 " maximum time to wait for input in milliseconds, or 0 for infinite. Most channels\n"
1457 " do not support the reception of text. Returns -1 for failure or 1 for success, and the string in parentheses.\n";
1458
1459 static char usage_tddmode[] =
1460 " Usage: TDD MODE <on|off>\n"
1461 "       Enable/Disable TDD transmission/reception on a channel. Returns 1 if\n"
1462 " successful, or 0 if channel is not TDD-capable.\n";
1463
1464 static char usage_sendimage[] =
1465 " Usage: SEND IMAGE <image>\n"
1466 "       Sends the given image on a channel. Most channels do not support the\n"
1467 " transmission of images. Returns 0 if image is sent, or if the channel does not\n"
1468 " support image transmission.  Returns -1 only on error/hangup. Image names\n"
1469 " should not include extensions.\n";
1470
1471 static char usage_streamfile[] =
1472 " Usage: STREAM FILE <filename> <escape digits> [sample offset]\n"
1473 "       Send the given file, allowing playback to be interrupted by the given\n"
1474 " digits, if any. Use double quotes for the digits if you wish none to be\n"
1475 " permitted. If sample offset is provided then the audio will seek to sample\n"
1476 " offset before play starts.  Returns 0 if playback completes without a digit\n"
1477 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
1478 " or -1 on error or if the channel was disconnected. Remember, the file\n"
1479 " extension must not be included in the filename.\n";
1480
1481 static char usage_controlstreamfile[] =
1482 " Usage: CONTROL STREAM FILE <filename> <escape digits> [skipms] [ffchar] [rewchr] [pausechr]\n"
1483 "       Send the given file, allowing playback to be controled by the given\n"
1484 " digits, if any. Use double quotes for the digits if you wish none to be\n"
1485 " permitted.  Returns 0 if playback completes without a digit\n"
1486 " being pressed, or the ASCII numerical value of the digit if one was pressed,\n"
1487 " or -1 on error or if the channel was disconnected. Remember, the file\n"
1488 " extension must not be included in the filename.\n\n"
1489 " Note: ffchar and rewchar default to * and # respectively.\n";
1490
1491 static char usage_getoption[] = 
1492 " Usage: GET OPTION <filename> <escape_digits> [timeout]\n"
1493 "       Behaves similar to STREAM FILE but used with a timeout option.\n";
1494
1495 static char usage_saynumber[] =
1496 " Usage: SAY NUMBER <number> <escape digits> [gender]\n"
1497 "       Say a given number, returning early if any of the given DTMF digits\n"
1498 " are received on the channel.  Returns 0 if playback completes without a digit\n"
1499 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1500 " -1 on error/hangup.\n";
1501
1502 static char usage_saydigits[] =
1503 " Usage: SAY DIGITS <number> <escape digits>\n"
1504 "       Say a given digit string, returning early if any of the given DTMF digits\n"
1505 " are received on the channel. Returns 0 if playback completes without a digit\n"
1506 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1507 " -1 on error/hangup.\n";
1508
1509 static char usage_sayalpha[] =
1510 " Usage: SAY ALPHA <number> <escape digits>\n"
1511 "       Say a given character string, returning early if any of the given DTMF digits\n"
1512 " are received on the channel. Returns 0 if playback completes without a digit\n"
1513 " being pressed, or the ASCII numerical value of the digit if one was pressed or\n"
1514 " -1 on error/hangup.\n";
1515
1516 static char usage_saydate[] =
1517 " Usage: SAY DATE <date> <escape digits>\n"
1518 "       Say a given date, returning early if any of the given DTMF digits are\n"
1519 " received on the channel.  <date> is number of seconds elapsed since 00:00:00\n"
1520 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
1521 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1522 " digit if one was pressed or -1 on error/hangup.\n";
1523
1524 static char usage_saytime[] =
1525 " Usage: SAY TIME <time> <escape digits>\n"
1526 "       Say a given time, returning early if any of the given DTMF digits are\n"
1527 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
1528 " on January 1, 1970, Coordinated Universal Time (UTC). Returns 0 if playback\n"
1529 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1530 " digit if one was pressed or -1 on error/hangup.\n";
1531
1532 static char usage_saydatetime[] =
1533 " Usage: SAY DATETIME <time> <escape digits> [format] [timezone]\n"
1534 "       Say a given time, returning early if any of the given DTMF digits are\n"
1535 " received on the channel.  <time> is number of seconds elapsed since 00:00:00\n"
1536 " on January 1, 1970, Coordinated Universal Time (UTC). [format] is the format\n"
1537 " the time should be said in.  See voicemail.conf (defaults to \"ABdY\n"
1538 " 'digits/at' IMp\").  Acceptable values for [timezone] can be found in\n"
1539 " /usr/share/zoneinfo.  Defaults to machine default. Returns 0 if playback\n"
1540 " completes without a digit being pressed, or the ASCII numerical value of the\n"
1541 " digit if one was pressed or -1 on error/hangup.\n";
1542
1543 static char usage_sayphonetic[] =
1544 " Usage: SAY PHONETIC <string> <escape digits>\n"
1545 "       Say a given character string with phonetics, returning early if any of the\n"
1546 " given DTMF digits are received on the channel. Returns 0 if playback\n"
1547 " completes without a digit pressed, the ASCII numerical value of the digit\n"
1548 " if one was pressed, or -1 on error/hangup.\n";
1549
1550 static char usage_getdata[] =
1551 " Usage: GET DATA <file to be streamed> [timeout] [max digits]\n"
1552 "       Stream the given file, and recieve DTMF data. Returns the digits received\n"
1553 "from the channel at the other end.\n";
1554
1555 static char usage_setcontext[] =
1556 " Usage: SET CONTEXT <desired context>\n"
1557 "       Sets the context for continuation upon exiting the application.\n";
1558
1559 static char usage_setextension[] =
1560 " Usage: SET EXTENSION <new extension>\n"
1561 "       Changes the extension for continuation upon exiting the application.\n";
1562
1563 static char usage_setpriority[] =
1564 " Usage: SET PRIORITY <priority>\n"
1565 "       Changes the priority for continuation upon exiting the application.\n"
1566 " The priority must be a valid priority or label.\n";
1567
1568 static char usage_recordfile[] =
1569 " Usage: RECORD FILE <filename> <format> <escape digits> <timeout> \\\n"
1570 "                                          [offset samples] [BEEP] [s=silence]\n"
1571 "       Record to a file until a given dtmf digit in the sequence is received\n"
1572 " Returns -1 on hangup or error.  The format will specify what kind of file\n"
1573 " will be recorded.  The timeout is the maximum record time in milliseconds, or\n"
1574 " -1 for no timeout. \"Offset samples\" is optional, and, if provided, will seek\n"
1575 " to the offset without exceeding the end of the file.  \"silence\" is the number\n"
1576 " of seconds of silence allowed before the function returns despite the\n"
1577 " lack of dtmf digits or reaching timeout.  Silence value must be\n"
1578 " preceeded by \"s=\" and is also optional.\n";
1579
1580 static char usage_autohangup[] =
1581 " Usage: SET AUTOHANGUP <time>\n"
1582 "       Cause the channel to automatically hangup at <time> seconds in the\n"
1583 " future.  Of course it can be hungup before then as well. Setting to 0 will\n"
1584 " cause the autohangup feature to be disabled on this channel.\n";
1585
1586 static char usage_noop[] =
1587 " Usage: NoOp\n"
1588 "       Does nothing.\n";
1589
1590 /*!
1591  * \brief AGI commands list
1592  */
1593 static struct agi_command commands[] = {
1594         { { "answer", NULL }, handle_answer, "Answer channel", usage_answer , 0 },
1595         { { "channel", "status", NULL }, handle_channelstatus, "Returns status of the connected channel", usage_channelstatus , 0 },
1596         { { "database", "del", NULL }, handle_dbdel, "Removes database key/value", usage_dbdel , 1 },
1597         { { "database", "deltree", NULL }, handle_dbdeltree, "Removes database keytree/value", usage_dbdeltree , 1 },
1598         { { "database", "get", NULL }, handle_dbget, "Gets database value", usage_dbget , 1 },
1599         { { "database", "put", NULL }, handle_dbput, "Adds/updates database value", usage_dbput , 1 },
1600         { { "exec", NULL }, handle_exec, "Executes a given Application", usage_exec , 1 },
1601         { { "get", "data", NULL }, handle_getdata, "Prompts for DTMF on a channel", usage_getdata , 0 },
1602         { { "get", "full", "variable", NULL }, handle_getvariablefull, "Evaluates a channel expression", usage_getvariablefull , 1 },
1603         { { "get", "option", NULL }, handle_getoption, "Stream file, prompt for DTMF, with timeout", usage_getoption , 0 },
1604         { { "get", "variable", NULL }, handle_getvariable, "Gets a channel variable", usage_getvariable , 1 },
1605         { { "hangup", NULL }, handle_hangup, "Hangup the current channel", usage_hangup , 0 },
1606         { { "noop", NULL }, handle_noop, "Does nothing", usage_noop , 1 },
1607         { { "receive", "char", NULL }, handle_recvchar, "Receives one character from channels supporting it", usage_recvchar , 0 },
1608         { { "receive", "text", NULL }, handle_recvtext, "Receives text from channels supporting it", usage_recvtext , 0 },
1609         { { "record", "file", NULL }, handle_recordfile, "Records to a given file", usage_recordfile , 0 },
1610         { { "say", "alpha", NULL }, handle_sayalpha, "Says a given character string", usage_sayalpha , 0 },
1611         { { "say", "digits", NULL }, handle_saydigits, "Says a given digit string", usage_saydigits , 0 },
1612         { { "say", "number", NULL }, handle_saynumber, "Says a given number", usage_saynumber , 0 },
1613         { { "say", "phonetic", NULL }, handle_sayphonetic, "Says a given character string with phonetics", usage_sayphonetic , 0 },
1614         { { "say", "date", NULL }, handle_saydate, "Says a given date", usage_saydate , 0 },
1615         { { "say", "time", NULL }, handle_saytime, "Says a given time", usage_saytime , 0 },
1616         { { "say", "datetime", NULL }, handle_saydatetime, "Says a given time as specfied by the format given", usage_saydatetime , 0 },
1617         { { "send", "image", NULL }, handle_sendimage, "Sends images to channels supporting it", usage_sendimage , 0 },
1618         { { "send", "text", NULL }, handle_sendtext, "Sends text to channels supporting it", usage_sendtext , 0 },
1619         { { "set", "autohangup", NULL }, handle_autohangup, "Autohangup channel in some time", usage_autohangup , 0 },
1620         { { "set", "callerid", NULL }, handle_setcallerid, "Sets callerid for the current channel", usage_setcallerid , 0 },
1621         { { "set", "context", NULL }, handle_setcontext, "Sets channel context", usage_setcontext , 0 },
1622         { { "set", "extension", NULL }, handle_setextension, "Changes channel extension", usage_setextension , 0 },
1623         { { "set", "music", NULL }, handle_setmusic, "Enable/Disable Music on hold generator", usage_setmusic , 0 },
1624         { { "set", "priority", NULL }, handle_setpriority, "Set channel dialplan priority", usage_setpriority , 0 },
1625         { { "set", "variable", NULL }, handle_setvariable, "Sets a channel variable", usage_setvariable , 1 },
1626         { { "stream", "file", NULL }, handle_streamfile, "Sends audio file on channel", usage_streamfile , 0 },
1627         { { "control", "stream", "file", NULL }, handle_controlstreamfile, "Sends audio file on channel and allows the listner to control the stream", usage_controlstreamfile , 0 },
1628         { { "tdd", "mode", NULL }, handle_tddmode, "Toggles TDD mode (for the deaf)", usage_tddmode , 0 },
1629         { { "verbose", NULL }, handle_verbose, "Logs a message to the asterisk verbose log", usage_verbose , 1 },
1630         { { "wait", "for", "digit", NULL }, handle_waitfordigit, "Waits for a digit to be pressed", usage_waitfordigit , 0 },
1631 };
1632
1633 static AST_RWLIST_HEAD_STATIC(agi_commands, agi_command);
1634
1635 static char *help_workhorse(int fd, char *match[])
1636 {
1637         char fullcmd[80], matchstr[80];
1638         struct agi_command *e;
1639
1640         if (match)
1641                 ast_join(matchstr, sizeof(matchstr), match);
1642
1643         ast_cli(fd, "%5.5s %20.20s   %s\n","Dead","Command","Description");
1644         AST_RWLIST_RDLOCK(&agi_commands);
1645         AST_RWLIST_TRAVERSE(&agi_commands, e, list) {
1646                 if (!e->cmda[0])
1647                         break;
1648                 /* Hide commands that start with '_' */
1649                 if ((e->cmda[0])[0] == '_')
1650                         continue;
1651                 ast_join(fullcmd, sizeof(fullcmd), e->cmda);
1652                 if (match && strncasecmp(matchstr, fullcmd, strlen(matchstr)))
1653                         continue;
1654                 ast_cli(fd, "%5.5s %20.20s   %s\n", e->dead ? "Yes" : "No" , fullcmd, e->summary);
1655         }
1656         AST_RWLIST_UNLOCK(&agi_commands);
1657
1658         return CLI_SUCCESS;
1659 }
1660
1661 int ast_agi_register(struct ast_module *mod, agi_command *cmd)
1662 {
1663         char fullcmd[80];
1664
1665         ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
1666
1667         if (!find_command(cmd->cmda,1)) {
1668                 cmd->mod = mod;
1669                 AST_RWLIST_WRLOCK(&agi_commands);
1670                 AST_LIST_INSERT_TAIL(&agi_commands, cmd, list);
1671                 AST_RWLIST_UNLOCK(&agi_commands);
1672                 if (mod != ast_module_info->self)
1673                         ast_module_ref(ast_module_info->self);
1674                 ast_verb(2, "AGI Command '%s' registered\n",fullcmd);
1675                 return 1;
1676         } else {
1677                 ast_log(LOG_WARNING, "Command already registered!\n");
1678                 return 0;
1679         }
1680 }
1681
1682 int ast_agi_unregister(struct ast_module *mod, agi_command *cmd)
1683 {
1684         struct agi_command *e;
1685         int unregistered = 0;
1686         char fullcmd[80];
1687         
1688         ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
1689
1690         AST_RWLIST_WRLOCK(&agi_commands);
1691         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&agi_commands, e, list) {
1692                 if (cmd == e) {
1693                         AST_RWLIST_REMOVE_CURRENT(list);
1694                         if (mod != ast_module_info->self)
1695                                 ast_module_unref(ast_module_info->self);
1696                         unregistered=1;
1697                         break;
1698                 }
1699         }
1700         AST_RWLIST_TRAVERSE_SAFE_END;
1701         AST_RWLIST_UNLOCK(&agi_commands);
1702         if (unregistered)
1703                 ast_verb(2, "AGI Command '%s' unregistered\n",fullcmd);
1704         else
1705                 ast_log(LOG_WARNING, "Unable to unregister command: '%s'!\n",fullcmd);
1706         return unregistered;
1707 }
1708
1709 void ast_agi_register_multiple(struct ast_module *mod, agi_command *cmd, int len)
1710 {
1711         int i;
1712
1713         for (i = 0; i < len; i++)
1714                 ast_agi_register(mod, cmd + i);
1715
1716 }
1717
1718 void ast_agi_unregister_multiple(struct ast_module *mod, agi_command *cmd, int len)
1719 {
1720         int i;
1721
1722         for (i = 0; i < len; i++)
1723                 ast_agi_unregister(mod, cmd + i);
1724 }
1725
1726 static agi_command *find_command(char *cmds[], int exact)
1727 {
1728         int y, match;
1729         struct agi_command *e;
1730
1731         AST_RWLIST_RDLOCK(&agi_commands);
1732         AST_RWLIST_TRAVERSE(&agi_commands, e, list) {
1733                 if (!e->cmda[0])
1734                         break;
1735                 /* start optimistic */
1736                 match = 1;
1737                 for (y = 0; match && cmds[y]; y++) {
1738                         /* If there are no more words in the command (and we're looking for
1739                            an exact match) or there is a difference between the two words,
1740                            then this is not a match */
1741                         if (!e->cmda[y] && !exact)
1742                                 break;
1743                         /* don't segfault if the next part of a command doesn't exist */
1744                         if (!e->cmda[y])
1745                                 return NULL;
1746                         if (strcasecmp(e->cmda[y], cmds[y]))
1747                                 match = 0;
1748                 }
1749                 /* If more words are needed to complete the command then this is not
1750                    a candidate (unless we're looking for a really inexact answer  */
1751                 if ((exact > -1) && e->cmda[y])
1752                         match = 0;
1753                 if (match)
1754                         return e;
1755         }
1756         AST_RWLIST_UNLOCK(&agi_commands);
1757         return NULL;
1758 }
1759
1760 static int parse_args(char *s, int *max, char *argv[])
1761 {
1762         int x = 0, quoted = 0, escaped = 0, whitespace = 1;
1763         char *cur;
1764
1765         cur = s;
1766         while(*s) {
1767                 switch(*s) {
1768                 case '"':
1769                         /* If it's escaped, put a literal quote */
1770                         if (escaped) 
1771                                 goto normal;
1772                         else 
1773                                 quoted = !quoted;
1774                         if (quoted && whitespace) {
1775                                 /* If we're starting a quote, coming off white space start a new word, too */
1776                                 argv[x++] = cur;
1777                                 whitespace=0;
1778                         }
1779                         escaped = 0;
1780                 break;
1781                 case ' ':
1782                 case '\t':
1783                         if (!quoted && !escaped) {
1784                                 /* If we're not quoted, mark this as whitespace, and
1785                                    end the previous argument */
1786                                 whitespace = 1;
1787                                 *(cur++) = '\0';
1788                         } else
1789                                 /* Otherwise, just treat it as anything else */ 
1790                                 goto normal;
1791                         break;
1792                 case '\\':
1793                         /* If we're escaped, print a literal, otherwise enable escaping */
1794                         if (escaped) {
1795                                 goto normal;
1796                         } else {
1797                                 escaped=1;
1798                         }
1799                         break;
1800                 default:
1801 normal:
1802                         if (whitespace) {
1803                                 if (x >= MAX_ARGS -1) {
1804                                         ast_log(LOG_WARNING, "Too many arguments, truncating\n");
1805                                         break;
1806                                 }
1807                                 /* Coming off of whitespace, start the next argument */
1808                                 argv[x++] = cur;
1809                                 whitespace=0;
1810                         }
1811                         *(cur++) = *s;
1812                         escaped=0;
1813                 }
1814                 s++;
1815         }
1816         /* Null terminate */
1817         *(cur++) = '\0';
1818         argv[x] = NULL;
1819         *max = x;
1820         return 0;
1821 }
1822
1823 static int agi_handle_command(struct ast_channel *chan, AGI *agi, char *buf, int dead)
1824 {
1825         char *argv[MAX_ARGS];
1826         int argc = MAX_ARGS, res;
1827         agi_command *c;
1828
1829         parse_args(buf, &argc, argv);
1830         if ((c = find_command(argv, 0)) && (!dead || (dead && c->dead))) {
1831                 /* if this command wasnt registered by res_agi, be sure to usecount
1832                 the module we are using */
1833                 if (c->mod != ast_module_info->self)
1834                         ast_module_ref(c->mod);
1835                 res = c->handler(chan, agi, argc, argv);
1836                 if (c->mod != ast_module_info->self)
1837                         ast_module_unref(c->mod);
1838                 switch(res) {
1839                 case RESULT_SHOWUSAGE:
1840                         ast_agi_fdprintf(chan, agi->fd, "520-Invalid command syntax.  Proper usage follows:\n");
1841                         ast_agi_fdprintf(chan, agi->fd, c->usage);
1842                         ast_agi_fdprintf(chan, agi->fd, "520 End of proper usage.\n");
1843                         break;
1844                 case AST_PBX_KEEPALIVE:
1845                         /* We've been asked to keep alive, so do so */
1846                         return AST_PBX_KEEPALIVE;
1847                         break;
1848                 case RESULT_FAILURE:
1849                         /* They've already given the failure.  We've been hung up on so handle this
1850                            appropriately */
1851                         return -1;
1852                 }
1853         } else if ((c = find_command(argv, 0))) {
1854                 ast_agi_fdprintf(chan, agi->fd, "511 Command Not Permitted on a dead channel\n");
1855         } else {
1856                 ast_agi_fdprintf(chan, agi->fd, "510 Invalid or unknown command\n");
1857         }
1858         return 0;
1859 }
1860 static enum agi_result run_agi(struct ast_channel *chan, char *request, AGI *agi, int pid, int *status, int dead, int argc, char *argv[])
1861 {
1862         struct ast_channel *c;
1863         int outfd, ms, needhup = 0;
1864         enum agi_result returnstatus = AGI_RESULT_SUCCESS;
1865         struct ast_frame *f;
1866         char buf[AGI_BUF_LEN];
1867         char *res = NULL;
1868         FILE *readf;
1869         /* how many times we'll retry if ast_waitfor_nandfs will return without either 
1870           channel or file descriptor in case select is interrupted by a system call (EINTR) */
1871         int retry = AGI_NANDFS_RETRY;
1872
1873         if (!(readf = fdopen(agi->ctrl, "r"))) {
1874                 ast_log(LOG_WARNING, "Unable to fdopen file descriptor\n");
1875                 if (pid > -1)
1876                         kill(pid, SIGHUP);
1877                 close(agi->ctrl);
1878                 return AGI_RESULT_FAILURE;
1879         }
1880         setlinebuf(readf);
1881         setup_env(chan, request, agi->fd, (agi->audio > -1), argc, argv);
1882         for (;;) {
1883                 if (needhup) {
1884                         needhup = 0;
1885                         dead = 1;
1886                         kill(pid, SIGHUP);
1887                 }
1888                 ms = -1;
1889                 c = ast_waitfor_nandfds(&chan, dead ? 0 : 1, &agi->ctrl, 1, NULL, &outfd, &ms);
1890                 if (c) {
1891                         retry = AGI_NANDFS_RETRY;
1892                         /* Idle the channel until we get a command */
1893                         f = ast_read(c);
1894                         if (!f) {
1895                                 ast_debug(1, "%s hungup\n", chan->name);
1896                                 returnstatus = AGI_RESULT_HANGUP;
1897                                 needhup = 1;
1898                                 continue;
1899                         } else {
1900                                 /* If it's voice, write it to the audio pipe */
1901                                 if ((agi->audio > -1) && (f->frametype == AST_FRAME_VOICE)) {
1902                                         /* Write, ignoring errors */
1903                                         write(agi->audio, f->data, f->datalen);
1904                                 }
1905                                 ast_frfree(f);
1906                         }
1907                 } else if (outfd > -1) {
1908                         size_t len = sizeof(buf);
1909                         size_t buflen = 0;
1910
1911                         retry = AGI_NANDFS_RETRY;
1912                         buf[0] = '\0';
1913
1914                         while (buflen < (len - 1)) {
1915                                 res = fgets(buf + buflen, len, readf);
1916                                 if (feof(readf)) 
1917                                         break;
1918                                 if (ferror(readf) && ((errno != EINTR) && (errno != EAGAIN))) 
1919                                         break;
1920                                 if (res != NULL && !agi->fast)
1921                                         break;
1922                                 buflen = strlen(buf);
1923                                 if (buflen && buf[buflen - 1] == '\n')
1924                                         break;
1925                                 len -= buflen;
1926                                 if (agidebug)
1927                                         ast_verbose( "AGI Rx << temp buffer %s - errno %s\n", buf, strerror(errno));
1928                         }
1929
1930                         if (!buf[0]) {
1931                                 /* Program terminated */
1932                                 if (returnstatus && returnstatus != AST_PBX_KEEPALIVE)
1933                                         returnstatus = -1;
1934                                 ast_verb(3, "<%s>AGI Script %s completed, returning %d\n", chan->name, request, returnstatus);
1935                                 if (pid > 0)
1936                                         waitpid(pid, status, 0);
1937                                 /* No need to kill the pid anymore, since they closed us */
1938                                 pid = -1;
1939                                 break;
1940                         }
1941
1942                         /* get rid of trailing newline, if any */
1943                         if (*buf && buf[strlen(buf) - 1] == '\n')
1944                                 buf[strlen(buf) - 1] = 0;
1945                         if (agidebug)
1946                                 ast_verbose("<%s>AGI Rx << %s\n", chan->name, buf);
1947                         returnstatus |= agi_handle_command(chan, agi, buf, dead);
1948                         /* If the handle_command returns -1, we need to stop */
1949                         if ((returnstatus < 0) || (returnstatus == AST_PBX_KEEPALIVE)) {
1950                                 needhup = 1;
1951                                 continue;
1952                         }
1953                 } else {
1954                         if (--retry <= 0) {
1955                                 ast_log(LOG_WARNING, "No channel, no fd?\n");
1956                                 returnstatus = AGI_RESULT_FAILURE;
1957                                 break;
1958                         }
1959                 }
1960         }
1961         /* Notify process */
1962         if (pid > -1) {
1963                 const char *sighup = pbx_builtin_getvar_helper(chan, "AGISIGHUP");
1964                 if (ast_strlen_zero(sighup) || !ast_false(sighup)) {
1965                         if (kill(pid, SIGHUP))
1966                                 ast_log(LOG_WARNING, "unable to send SIGHUP to AGI process %d: %s\n", pid, strerror(errno));
1967                 }
1968         }
1969         fclose(readf);
1970         return returnstatus;
1971 }
1972
1973 static char *handle_cli_agi_show(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
1974 {
1975         struct agi_command *command;
1976         char fullcmd[80];
1977
1978         switch (cmd) {
1979         case CLI_INIT:
1980                 e->command = "agi show";
1981                 e->usage =
1982                         "Usage: agi show [topic]\n"
1983                         "       When called with a topic as an argument, displays usage\n"
1984                         "       information on the given command.  If called without a\n"
1985                         "       topic, it provides a list of AGI commands.\n";
1986                 break;
1987         case CLI_GENERATE:
1988                 return NULL;
1989         }
1990         if (a->argc < e->args)
1991                 return CLI_SHOWUSAGE;
1992         if (a->argc > e->args) {
1993                 command = find_command(a->argv + e->args, 1);
1994                 if (command) {
1995                         ast_cli(a->fd, command->usage);
1996                         ast_cli(a->fd, " Runs Dead : %s\n", command->dead ? "Yes" : "No");
1997                 } else {
1998                         if (find_command(a->argv + e->args, -1)) {
1999                                 return help_workhorse(a->fd, a->argv + e->args);
2000                         } else {
2001                                 ast_join(fullcmd, sizeof(fullcmd), a->argv + e->args);
2002                                 ast_cli(a->fd, "No such command '%s'.\n", fullcmd);
2003                         }
2004                 }
2005         } else {
2006                 return help_workhorse(a->fd, NULL);
2007         }
2008         return CLI_SUCCESS;
2009 }
2010
2011 /*! \brief Convert string to use HTML escaped characters
2012         \note Maybe this should be a generic function?
2013 */
2014 static void write_html_escaped(FILE *htmlfile, char *str)
2015 {
2016         char *cur = str;
2017
2018         while(*cur) {
2019                 switch (*cur) {
2020                 case '<':
2021                         fprintf(htmlfile, "%s", "&lt;");
2022                         break;
2023                 case '>':
2024                         fprintf(htmlfile, "%s", "&gt;");
2025                         break;
2026                 case '&':
2027                         fprintf(htmlfile, "%s", "&amp;");
2028                         break;
2029                 case '"':
2030                         fprintf(htmlfile, "%s", "&quot;");
2031                         break;
2032                 default:
2033                         fprintf(htmlfile, "%c", *cur);
2034                         break;
2035                 }
2036                 cur++;
2037         }
2038
2039         return;
2040 }
2041
2042 static char *handle_cli_agi_dumphtml(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2043 {
2044         struct agi_command *command;
2045         char fullcmd[80];
2046         FILE *htmlfile;
2047
2048         switch (cmd) {
2049         case CLI_INIT:
2050                 e->command = "agi dumphtml";
2051                 e->usage =
2052                         "Usage: agi dumphtml <filename>\n"
2053                         "       Dumps the AGI command list in HTML format to the given\n"
2054                         "       file.\n";
2055                 return NULL;
2056         case CLI_GENERATE:
2057                 return NULL;
2058         }
2059         if (a->argc < e->args + 1)
2060                 return CLI_SHOWUSAGE;
2061
2062         if (!(htmlfile = fopen(a->argv[2], "wt"))) {
2063                 ast_cli(a->fd, "Could not create file '%s'\n", a->argv[2]);
2064                 return CLI_SHOWUSAGE;
2065         }
2066
2067         fprintf(htmlfile, "<HTML>\n<HEAD>\n<TITLE>AGI Commands</TITLE>\n</HEAD>\n");
2068         fprintf(htmlfile, "<BODY>\n<CENTER><B><H1>AGI Commands</H1></B></CENTER>\n\n");
2069         fprintf(htmlfile, "<TABLE BORDER=\"0\" CELLSPACING=\"10\">\n");
2070
2071         AST_RWLIST_RDLOCK(&agi_commands);
2072         AST_RWLIST_TRAVERSE(&agi_commands, command, list) {
2073                 char *stringp, *tempstr;
2074  
2075                 if (!command->cmda[0])  /* end ? */
2076                         break;
2077                 /* Hide commands that start with '_' */
2078                 if ((command->cmda[0])[0] == '_')
2079                         continue;
2080                 ast_join(fullcmd, sizeof(fullcmd), command->cmda);
2081
2082                 fprintf(htmlfile, "<TR><TD><TABLE BORDER=\"1\" CELLPADDING=\"5\" WIDTH=\"100%%\">\n");
2083                 fprintf(htmlfile, "<TR><TH ALIGN=\"CENTER\"><B>%s - %s</B></TH></TR>\n", fullcmd, command->summary);
2084
2085                 stringp = command->usage;
2086                 tempstr = strsep(&stringp, "\n");
2087
2088                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">");
2089                 write_html_escaped(htmlfile, tempstr);
2090                 fprintf(htmlfile, "</TD></TR>\n");
2091                 fprintf(htmlfile, "<TR><TD ALIGN=\"CENTER\">\n");
2092
2093                 while ((tempstr = strsep(&stringp, "\n")) != NULL) {
2094                         write_html_escaped(htmlfile, tempstr);
2095                         fprintf(htmlfile, "<BR>\n");
2096                 }
2097                 fprintf(htmlfile, "</TD></TR>\n");
2098                 fprintf(htmlfile, "</TABLE></TD></TR>\n\n");
2099         }
2100         AST_RWLIST_UNLOCK(&agi_commands);
2101         fprintf(htmlfile, "</TABLE>\n</BODY>\n</HTML>\n");
2102         fclose(htmlfile);
2103         ast_cli(a->fd, "AGI HTML commands dumped to: %s\n", a->argv[2]);
2104         return CLI_SUCCESS;
2105 }
2106
2107 static int agi_exec_full(struct ast_channel *chan, void *data, int enhanced, int dead)
2108 {
2109         enum agi_result res;
2110         struct ast_module_user *u;
2111         char buf[AGI_BUF_LEN] = "", *tmp = buf;
2112         int fds[2], efd = -1, pid;
2113         AST_DECLARE_APP_ARGS(args,
2114                 AST_APP_ARG(arg)[MAX_ARGS];
2115         );
2116         AGI agi;
2117
2118         if (ast_strlen_zero(data)) {
2119                 ast_log(LOG_WARNING, "AGI requires an argument (script)\n");
2120                 return -1;
2121         }
2122         if (dead)
2123                 ast_log(LOG_NOTICE, "Hungup channel detected, running agi in dead mode.");
2124         ast_copy_string(buf, data, sizeof(buf));
2125         memset(&agi, 0, sizeof(agi));
2126         AST_STANDARD_APP_ARGS(args, tmp);
2127         args.argv[args.argc] = NULL;
2128
2129         u = ast_module_user_add(chan);
2130 #if 0
2131          /* Answer if need be */
2132         if (chan->_state != AST_STATE_UP) {
2133                 if (ast_answer(chan)) {
2134                         LOCAL_USER_REMOVE(u);
2135                         return -1;
2136                 }
2137         }
2138 #endif
2139         res = launch_script(args.argv[0], args.argv, fds, enhanced ? &efd : NULL, &pid);
2140         if (res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) {
2141                 int status = 0;
2142                 agi.fd = fds[1];
2143                 agi.ctrl = fds[0];
2144                 agi.audio = efd;
2145                 agi.fast = (res == AGI_RESULT_SUCCESS_FAST) ? 1 : 0;
2146                 res = run_agi(chan, args.argv[0], &agi, pid, &status, dead, args.argc, args.argv);
2147                 /* If the fork'd process returns non-zero, set AGISTATUS to FAILURE */
2148                 if ((res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) && status)
2149                         res = AGI_RESULT_FAILURE;
2150                 if (fds[1] != fds[0])
2151                         close(fds[1]);
2152                 if (efd > -1)
2153                         close(efd);
2154                 ast_unreplace_sigchld();
2155         }
2156         ast_module_user_remove(u);
2157
2158         switch (res) {
2159         case AGI_RESULT_SUCCESS:
2160         case AGI_RESULT_SUCCESS_FAST:
2161                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "SUCCESS");
2162                 break;
2163         case AGI_RESULT_FAILURE:
2164                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "FAILURE");
2165                 break;
2166         case AGI_RESULT_NOTFOUND:
2167                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "NOTFOUND");
2168                 break;
2169         case AGI_RESULT_HANGUP:
2170                 pbx_builtin_setvar_helper(chan, "AGISTATUS", "HANGUP");
2171                 return -1;
2172         }
2173
2174         return 0;
2175 }
2176
2177 static int agi_exec(struct ast_channel *chan, void *data)
2178 {
2179         if (!ast_check_hangup(chan))
2180                 return agi_exec_full(chan, data, 0, 0);
2181         else
2182                 return agi_exec_full(chan, data, 0, 1);
2183 }
2184
2185 static int eagi_exec(struct ast_channel *chan, void *data)
2186 {
2187         int readformat, res;
2188
2189         if (ast_check_hangup(chan)) {
2190                 ast_log(LOG_ERROR, "If you want to run AGI on hungup channels you should use DeadAGI!\n");
2191                 return 0;
2192         }
2193         readformat = chan->readformat;
2194         if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
2195                 ast_log(LOG_WARNING, "Unable to set channel '%s' to linear mode\n", chan->name);
2196                 return -1;
2197         }
2198         res = agi_exec_full(chan, data, 1, 0);
2199         if (!res) {
2200                 if (ast_set_read_format(chan, readformat)) {
2201                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %s\n", chan->name, ast_getformatname(readformat));
2202                 }
2203         }
2204         return res;
2205 }
2206
2207 static int deadagi_exec(struct ast_channel *chan, void *data)
2208 {
2209         ast_log(LOG_WARNING, "DeadAGI has been deprecated, please use AGI in all cases!");
2210         return agi_exec(chan, data);
2211 }
2212
2213 static struct ast_cli_entry cli_agi[] = {
2214         AST_CLI_DEFINE(handle_cli_agi_debug,    "Enable/Disable AGI debugging"),
2215         AST_CLI_DEFINE(handle_cli_agi_show,     "List AGI commands or specific help"),
2216         AST_CLI_DEFINE(handle_cli_agi_dumphtml, "Dumps a list of AGI commands in HTML format")
2217 };
2218
2219 static int unload_module(void)
2220 {
2221         ast_cli_unregister_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2222         ast_agi_unregister_multiple(ast_module_info->self, commands, sizeof(commands) / sizeof(struct agi_command));
2223         ast_unregister_application(eapp);
2224         ast_unregister_application(deadapp);
2225         return ast_unregister_application(app);
2226 }
2227
2228 static int load_module(void)
2229 {
2230         ast_cli_register_multiple(cli_agi, sizeof(cli_agi) / sizeof(struct ast_cli_entry));
2231         ast_agi_register_multiple(ast_module_info->self, commands, sizeof(commands) / sizeof(struct agi_command));
2232         ast_register_application(deadapp, deadagi_exec, deadsynopsis, descrip);
2233         ast_register_application(eapp, eagi_exec, esynopsis, descrip);
2234         return ast_register_application(app, agi_exec, synopsis, descrip);
2235 }
2236
2237 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Asterisk Gateway Interface (AGI)",
2238                 .load = load_module,
2239                 .unload = unload_module,
2240                 );