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