res/res_agi.c

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