Asterisk - The Open Source Telephony Project  GIT-master-a24979a
Data Structures | Macros | Enumerations | Functions | Variables
res_agi.c File Reference

AGI - the Asterisk Gateway Interface. More...

#include "asterisk.h"
#include <math.h>
#include <signal.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <sys/stat.h>
#include <pthread.h>
#include "asterisk/paths.h"
#include "asterisk/network.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/astdb.h"
#include "asterisk/callerid.h"
#include "asterisk/cli.h"
#include "asterisk/image.h"
#include "asterisk/say.h"
#include "asterisk/app.h"
#include "asterisk/dsp.h"
#include "asterisk/musiconhold.h"
#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/strings.h"
#include "asterisk/manager.h"
#include "asterisk/ast_version.h"
#include "asterisk/speech.h"
#include "asterisk/term.h"
#include "asterisk/xmldoc.h"
#include "asterisk/srv.h"
#include "asterisk/test.h"
#include "asterisk/netsock2.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/format_cache.h"
#include "asterisk/agi.h"
Include dependency graph for res_agi.c:

Go to the source code of this file.

Data Structures

struct  agi_cmd
 
struct  agi_commands
 

Macros

#define AGI_BUF_INITSIZE   256
 
#define AGI_BUF_LEN   2048
 
#define AGI_BUF_SIZE   1024
 
#define AGI_NANDFS_RETRY   3
 
#define AGI_PORT   4573
 
#define AMI_BUF_SIZE   2048
 
#define AST_API_MODULE
 
#define ASYNC_AGI_BREAK   3
 
#define MAX_AGI_CONNECT   2000
 
#define MAX_ARGS   128
 
#define MAX_CMD_LEN   80
 
#define SRV_PREFIX   "_agi._tcp."
 
#define TONE_BLOCK_SIZE   200
 

Enumerations

enum  agi_result {
  AGI_RESULT_FAILURE = -1 , AGI_RESULT_SUCCESS , AGI_RESULT_SUCCESS_FAST , AGI_RESULT_SUCCESS_ASYNC ,
  AGI_RESULT_NOTFOUND , AGI_RESULT_HANGUP
}
 

Functions

static void __init_agi_buf (void)
 
static void __reg_module (void)
 
static void __unreg_module (void)
 
static int action_add_agi_cmd (struct mansession *s, const struct message *m)
 Add a new command to execute by the Async AGI application. More...
 
static int add_agi_cmd (struct ast_channel *chan, const char *cmd_buff, const char *cmd_id)
 
static int add_to_agi (struct ast_channel *chan)
 
static struct ast_manager_event_blobagi_async_end_to_ami (struct stasis_message *message)
 
static struct ast_manager_event_blobagi_async_exec_to_ami (struct stasis_message *message)
 
static struct ast_manager_event_blobagi_async_start_to_ami (struct stasis_message *message)
 
static struct ast_manager_event_blobagi_channel_to_ami (const char *type, struct stasis_message *message)
 
static void agi_destroy_commands_cb (void *data)
 
static int agi_exec (struct ast_channel *chan, const char *data)
 
static struct ast_manager_event_blobagi_exec_end_to_ami (struct stasis_message *message)
 
static int agi_exec_full (struct ast_channel *chan, const char *data, int enhanced, int dead)
 
static struct ast_manager_event_blobagi_exec_start_to_ami (struct stasis_message *message)
 
static enum agi_result agi_handle_command (struct ast_channel *chan, AGI *agi, char *buf, int dead)
 
int AST_OPTIONAL_API_NAME() ast_agi_register (struct ast_module *mod, agi_command *cmd)
 Registers an AGI command. More...
 
int AST_OPTIONAL_API_NAME() ast_agi_register_multiple (struct ast_module *mod, struct agi_command *cmd, unsigned int len)
 Registers a group of AGI commands, provided as an array of struct agi_command entries. More...
 
int AST_OPTIONAL_API_NAME() ast_agi_send (int fd, struct ast_channel *chan, char *fmt,...)
 Sends a string of text to an application connected via AGI. More...
 
int AST_OPTIONAL_API_NAME() ast_agi_unregister (agi_command *cmd)
 Unregisters an AGI command. More...
 
int AST_OPTIONAL_API_NAME() ast_agi_unregister_multiple (struct agi_command *cmd, unsigned int len)
 Unregisters a group of AGI commands, provided as an array of struct agi_command entries. More...
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static enum agi_result async_agi_read_frame (struct ast_channel *chan)
 
static int deadagi_exec (struct ast_channel *chan, const char *data)
 
static int eagi_exec (struct ast_channel *chan, const char *data)
 
static agi_commandfind_command (const char *const cmds[], int exact)
 
static void free_agi_cmd (struct agi_cmd *cmd)
 
static int get_agi_cmd (struct ast_channel *chan, struct agi_cmd **cmd)
 Retrieve the list head to the requested channel's AGI datastore. More...
 
static int handle_answer (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_asyncagi_break (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_autohangup (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_channelstatus (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static char * handle_cli_agi_add_cmd (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 CLI command to add applications to execute in Async AGI. More...
 
static char * handle_cli_agi_debug (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_cli_agi_dump_html (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * handle_cli_agi_show (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static int handle_connection (const char *agiurl, const struct ast_sockaddr addr, const int netsockfd)
 
static int handle_controlstreamfile (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_dbdel (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_dbdeltree (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_dbget (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_dbput (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_exec (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_getdata (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_getoption (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 get option - really similar to the handle_streamfile, but with a timeout More...
 
static int handle_getvariable (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_getvariablefull (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_hangup (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_noop (struct ast_channel *chan, AGI *agi, int arg, const char *const argv[])
 
static int handle_recordfile (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_recvchar (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_recvtext (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_sayalpha (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_saydate (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_saydatetime (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_saydigits (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_saynumber (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 Say number in various language syntaxes. More...
 
static int handle_sayphonetic (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_saytime (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_sendimage (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_sendtext (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setcallerid (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setcontext (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setextension (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setmusic (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setpriority (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_setvariable (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechactivategrammar (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechcreate (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechdeactivategrammar (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechdestroy (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechloadgrammar (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechrecognize (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechset (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_speechunloadgrammar (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_streamfile (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_tddmode (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_verbose (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static int handle_waitfordigit (struct ast_channel *chan, AGI *agi, int argc, const char *const argv[])
 
static char * help_workhorse (int fd, const char *const match[])
 
static enum agi_result launch_asyncagi (struct ast_channel *chan, int argc, char *argv[], int *efd)
 
static enum agi_result launch_ha_netscript (char *agiurl, char *argv[], int *fds)
 
static enum agi_result launch_netscript (char *agiurl, char *argv[], int *fds)
 
static enum agi_result launch_script (struct ast_channel *chan, char *script, int argc, char *argv[], int *fds, int *efd, int *opid)
 
static int load_module (void)
 
static int parse_args (char *s, int *max, const char *argv[])
 
static void publish_async_exec_end (struct ast_channel *chan, int command_id, const char *command, int result_code, const char *result)
 
static enum agi_result run_agi (struct ast_channel *chan, char *request, AGI *agi, int pid, int *status, int dead, int argc, char *argv[])
 
static void setup_env (struct ast_channel *chan, char *request, int fd, int enhanced, int argc, char *argv[])
 
static int speech_streamfile (struct ast_channel *chan, const char *filename, const char *preflang, int offset)
 
 STASIS_MESSAGE_TYPE_DEFN_LOCAL (agi_async_end_type,.to_ami=agi_async_end_to_ami,)
 
 STASIS_MESSAGE_TYPE_DEFN_LOCAL (agi_async_exec_type,.to_ami=agi_async_exec_to_ami,)
 
 STASIS_MESSAGE_TYPE_DEFN_LOCAL (agi_async_start_type,.to_ami=agi_async_start_to_ami,)
 
 STASIS_MESSAGE_TYPE_DEFN_LOCAL (agi_exec_end_type,.to_ami=agi_exec_end_to_ami,)
 
 STASIS_MESSAGE_TYPE_DEFN_LOCAL (agi_exec_start_type,.to_ami=agi_exec_start_to_ami,)
 
static int unload_module (void)
 
static void write_html_escaped (FILE *htmlfile, char *str)
 Convert string to use HTML escaped characters. More...
 
static int write_htmldump (const char *filename)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Asterisk Gateway Interface (AGI)" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND, .requires = "res_speech", }
 
static struct ast_threadstorage agi_buf = { .once = PTHREAD_ONCE_INIT , .key_init = __init_agi_buf , .custom_init = NULL , }
 
static struct agi_commands agi_commands = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
 
static const struct ast_datastore_info agi_commands_datastore_info
 
static int agidebug = 0
 
static char * app = "AGI"
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_cli_entry cli_agi []
 
static struct agi_command commands []
 AGI commands list. More...
 
static char * deadapp = "DeadAGI"
 
static char * eapp = "EAGI"
 

Detailed Description

AGI - the Asterisk Gateway Interface.

Author
Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file res_agi.c.

Macro Definition Documentation

◆ AGI_BUF_INITSIZE

#define AGI_BUF_INITSIZE   256

Definition at line 1476 of file res_agi.c.

◆ AGI_BUF_LEN

#define AGI_BUF_LEN   2048

Definition at line 1383 of file res_agi.c.

◆ AGI_BUF_SIZE

#define AGI_BUF_SIZE   1024

◆ AGI_NANDFS_RETRY

#define AGI_NANDFS_RETRY   3

Definition at line 1382 of file res_agi.c.

◆ AGI_PORT

#define AGI_PORT   4573

Definition at line 1399 of file res_agi.c.

◆ AMI_BUF_SIZE

#define AMI_BUF_SIZE   2048

◆ AST_API_MODULE

#define AST_API_MODULE

Definition at line 71 of file res_agi.c.

◆ ASYNC_AGI_BREAK

#define ASYNC_AGI_BREAK   3

Special return code for "asyncagi break" command.

Definition at line 1402 of file res_agi.c.

◆ MAX_AGI_CONNECT

#define MAX_AGI_CONNECT   2000

Definition at line 1397 of file res_agi.c.

◆ MAX_ARGS

#define MAX_ARGS   128

Definition at line 1380 of file res_agi.c.

◆ MAX_CMD_LEN

#define MAX_CMD_LEN   80

Definition at line 1381 of file res_agi.c.

◆ SRV_PREFIX

#define SRV_PREFIX   "_agi._tcp."

Definition at line 1384 of file res_agi.c.

◆ TONE_BLOCK_SIZE

#define TONE_BLOCK_SIZE   200

Definition at line 1394 of file res_agi.c.

Enumeration Type Documentation

◆ agi_result

enum agi_result
Enumerator
AGI_RESULT_FAILURE 
AGI_RESULT_SUCCESS 
AGI_RESULT_SUCCESS_FAST 
AGI_RESULT_SUCCESS_ASYNC 
AGI_RESULT_NOTFOUND 
AGI_RESULT_HANGUP 

Definition at line 1404 of file res_agi.c.

1404  {
1405  AGI_RESULT_FAILURE = -1,
1411 };
@ AGI_RESULT_HANGUP
Definition: res_agi.c:1410
@ AGI_RESULT_SUCCESS
Definition: res_agi.c:1406
@ AGI_RESULT_FAILURE
Definition: res_agi.c:1405
@ AGI_RESULT_SUCCESS_ASYNC
Definition: res_agi.c:1408
@ AGI_RESULT_SUCCESS_FAST
Definition: res_agi.c:1407
@ AGI_RESULT_NOTFOUND
Definition: res_agi.c:1409

Function Documentation

◆ __init_agi_buf()

static void __init_agi_buf ( void  )
static

Definition at line 1475 of file res_agi.c.

1479 {

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 4707 of file res_agi.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 4707 of file res_agi.c.

◆ action_add_agi_cmd()

static int action_add_agi_cmd ( struct mansession s,
const struct message m 
)
static

Add a new command to execute by the Async AGI application.

Parameters
s
mIt will append the application to the specified channel's queue if the channel is not inside Async AGI application it will return an error
Return values
0on success or incorrect use
1on failure to add the command ( most likely because the channel is not in Async AGI loop )

Definition at line 1701 of file res_agi.c.

1702 {
1703  const char *channel = astman_get_header(m, "Channel");
1704  const char *cmdbuff = astman_get_header(m, "Command");
1705  const char *cmdid = astman_get_header(m, "CommandID");
1706  struct ast_channel *chan;
1707  char buf[256];
1708 
1709  if (ast_strlen_zero(channel) || ast_strlen_zero(cmdbuff)) {
1710  astman_send_error(s, m, "Both, Channel and Command are *required*");
1711  return 0;
1712  }
1713 
1714  if (!(chan = ast_channel_get_by_name(channel))) {
1715  snprintf(buf, sizeof(buf), "Channel %s does not exist.", channel);
1716  astman_send_error(s, m, buf);
1717  return 0;
1718  }
1719 
1720  ast_channel_lock(chan);
1721 
1722  if (add_agi_cmd(chan, cmdbuff, cmdid)) {
1723  snprintf(buf, sizeof(buf), "Failed to add AGI command to channel %s queue", ast_channel_name(chan));
1724  astman_send_error(s, m, buf);
1725  ast_channel_unlock(chan);
1726  chan = ast_channel_unref(chan);
1727  return 0;
1728  }
1729 
1730  ast_channel_unlock(chan);
1731  chan = ast_channel_unref(chan);
1732 
1733  astman_send_ack(s, m, "Added AGI command to queue");
1734 
1735  return 0;
1736 }
#define ast_channel_lock(chan)
Definition: channel.h:2922
const char * ast_channel_name(const struct ast_channel *chan)
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:2958
struct ast_channel * ast_channel_get_by_name(const char *name)
Find a channel by name.
Definition: channel.c:1448
#define ast_channel_unlock(chan)
Definition: channel.h:2923
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
void astman_send_error(struct mansession *s, const struct message *m, char *error)
Send error in manager transaction.
Definition: manager.c:3166
void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
Send ack in manager transaction.
Definition: manager.c:3198
const char * astman_get_header(const struct message *m, char *var)
Get header from manager transaction.
Definition: manager.c:2827
static int add_agi_cmd(struct ast_channel *chan, const char *cmd_buff, const char *cmd_id)
Definition: res_agi.c:1572
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
Main Channel structure associated with a channel.

References add_agi_cmd(), ast_channel_get_by_name(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_channel_unref, ast_strlen_zero(), astman_get_header(), astman_send_ack(), astman_send_error(), and buf.

◆ add_agi_cmd()

static int add_agi_cmd ( struct ast_channel chan,
const char *  cmd_buff,
const char *  cmd_id 
)
static

Definition at line 1572 of file res_agi.c.

1573 {
1574  struct ast_datastore *store;
1575  struct agi_cmd *cmd;
1577 
1579  if (!store) {
1580  ast_log(LOG_WARNING, "Channel %s is not setup for Async AGI.\n", ast_channel_name(chan));
1581  return -1;
1582  }
1583  agi_commands = store->data;
1584  cmd = ast_calloc(1, sizeof(*cmd));
1585  if (!cmd) {
1586  return -1;
1587  }
1588  cmd->cmd_buffer = ast_strdup(cmd_buff);
1589  if (!cmd->cmd_buffer) {
1590  ast_free(cmd);
1591  return -1;
1592  }
1593  cmd->cmd_id = ast_strdup(cmd_id);
1594  if (!cmd->cmd_id) {
1595  ast_free(cmd->cmd_buffer);
1596  ast_free(cmd);
1597  return -1;
1598  }
1602  return 0;
1603 }
#define ast_free(a)
Definition: astmm.h:180
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ast_log
Definition: astobj2.c:42
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2398
#define LOG_WARNING
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
#define AST_LIST_LOCK(head)
Locks a list.
Definition: linkedlists.h:40
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
Definition: linkedlists.h:140
#define AST_LIST_HEAD(name, type)
Defines a structure to be used to hold a list of specified type.
Definition: linkedlists.h:173
static struct agi_commands agi_commands
static const struct ast_datastore_info agi_commands_datastore_info
Definition: res_agi.c:1536
#define NULL
Definition: resample.c:96
char * cmd_buffer
Definition: res_agi.c:1509
char * cmd_id
Definition: res_agi.c:1510
Structure for a data store object.
Definition: datastore.h:64
void * data
Definition: datastore.h:66
Definition: search.h:40

References agi_commands, agi_commands_datastore_info, ast_calloc, ast_channel_datastore_find(), ast_channel_name(), ast_free, AST_LIST_HEAD, AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log, ast_strdup, agi_cmd::cmd_buffer, agi_cmd::cmd_id, ast_datastore::data, LOG_WARNING, and NULL.

Referenced by action_add_agi_cmd(), and handle_cli_agi_add_cmd().

◆ add_to_agi()

static int add_to_agi ( struct ast_channel chan)
static

Definition at line 1605 of file res_agi.c.

1606 {
1607  struct ast_datastore *datastore;
1608  AST_LIST_HEAD(, agi_cmd) *agi_cmds_list;
1609 
1610  /* check if already on AGI */
1611  ast_channel_lock(chan);
1613  ast_channel_unlock(chan);
1614  if (datastore) {
1615  /* we already have an AGI datastore, let's just
1616  return success */
1617  return 0;
1618  }
1619 
1620  /* the channel has never been on Async AGI,
1621  let's allocate it's datastore */
1622  datastore = ast_datastore_alloc(&agi_commands_datastore_info, "AGI");
1623  if (!datastore) {
1624  return -1;
1625  }
1626  agi_cmds_list = ast_calloc(1, sizeof(*agi_cmds_list));
1627  if (!agi_cmds_list) {
1628  ast_log(LOG_ERROR, "Unable to allocate Async AGI commands list.\n");
1629  ast_datastore_free(datastore);
1630  return -1;
1631  }
1632  datastore->data = agi_cmds_list;
1633  AST_LIST_HEAD_INIT(agi_cmds_list);
1634  ast_channel_lock(chan);
1635  ast_channel_datastore_add(chan, datastore);
1636  ast_channel_unlock(chan);
1637  return 0;
1638 }
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2384
#define ast_datastore_alloc(info, uid)
Definition: datastore.h:85
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:68
#define LOG_ERROR
#define AST_LIST_HEAD_INIT(head)
Initializes a list head structure.
Definition: linkedlists.h:626

References agi_commands_datastore_info, ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), AST_LIST_HEAD, AST_LIST_HEAD_INIT, ast_log, ast_datastore::data, LOG_ERROR, and NULL.

◆ agi_async_end_to_ami()

static struct ast_manager_event_blob* agi_async_end_to_ami ( struct stasis_message message)
static

Definition at line 1452 of file res_agi.c.

1453 {
1454  return agi_channel_to_ami("AsyncAGIEnd", message);
1455 }
static struct ast_manager_event_blob * agi_channel_to_ami(const char *type, struct stasis_message *message)
Definition: res_agi.c:1413

References agi_channel_to_ami().

◆ agi_async_exec_to_ami()

static struct ast_manager_event_blob* agi_async_exec_to_ami ( struct stasis_message message)
static

Definition at line 1447 of file res_agi.c.

1448 {
1449  return agi_channel_to_ami("AsyncAGIExec", message);
1450 }

References agi_channel_to_ami().

◆ agi_async_start_to_ami()

static struct ast_manager_event_blob* agi_async_start_to_ami ( struct stasis_message message)
static

Definition at line 1442 of file res_agi.c.

1443 {
1444  return agi_channel_to_ami("AsyncAGIStart", message);
1445 }

References agi_channel_to_ami().

◆ agi_channel_to_ami()

static struct ast_manager_event_blob* agi_channel_to_ami ( const char *  type,
struct stasis_message message 
)
static

Definition at line 1413 of file res_agi.c.

1414 {
1416  RAII_VAR(struct ast_str *, channel_string, NULL, ast_free);
1417  RAII_VAR(struct ast_str *, event_string, NULL, ast_free);
1418 
1419  channel_string = ast_manager_build_channel_state_string(obj->snapshot);
1420  event_string = ast_manager_str_from_json_object(obj->blob, NULL);
1421  if (!channel_string || !event_string) {
1422  return NULL;
1423  }
1424 
1426  "%s"
1427  "%s",
1428  ast_str_buffer(channel_string),
1429  ast_str_buffer(event_string));
1430 }
static const char type[]
Definition: chan_ooh323.c:109
struct ast_str * ast_manager_str_from_json_object(struct ast_json *blob, key_exclusion_cb exclusion_cb)
Convert a JSON object into an AMI compatible string.
Definition: manager.c:1828
struct ast_manager_event_blob * ast_manager_event_blob_create(int event_flags, const char *manager_event, const char *extra_fields_fmt,...)
Construct a ast_manager_event_blob.
Definition: manager.c:9760
struct ast_str * ast_manager_build_channel_state_string(const struct ast_channel_snapshot *snapshot)
Generate the AMI message body from a channel snapshot.
#define EVENT_FLAG_AGI
Definition: manager.h:88
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:739
Blob of data associated with a channel.
struct ast_channel_snapshot * snapshot
struct ast_json * blob
Support for dynamic strings.
Definition: strings.h:604
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:936

References ast_free, ast_manager_build_channel_state_string(), ast_manager_event_blob_create(), ast_manager_str_from_json_object(), ast_str_buffer(), ast_channel_blob::blob, EVENT_FLAG_AGI, NULL, RAII_VAR, ast_channel_blob::snapshot, stasis_message_data(), and type.

Referenced by agi_async_end_to_ami(), agi_async_exec_to_ami(), agi_async_start_to_ami(), agi_exec_end_to_ami(), and agi_exec_start_to_ami().

◆ agi_destroy_commands_cb()

static void agi_destroy_commands_cb ( void *  data)
static

Definition at line 1522 of file res_agi.c.

1523 {
1524  struct agi_cmd *cmd;
1525  AST_LIST_HEAD(, agi_cmd) *chan_cmds = data;
1526  AST_LIST_LOCK(chan_cmds);
1527  while ( (cmd = AST_LIST_REMOVE_HEAD(chan_cmds, entry)) ) {
1528  free_agi_cmd(cmd);
1529  }
1530  AST_LIST_UNLOCK(chan_cmds);
1531  AST_LIST_HEAD_DESTROY(chan_cmds);
1532  ast_free(chan_cmds);
1533 }
#define AST_LIST_HEAD_DESTROY(head)
Destroys a list head structure.
Definition: linkedlists.h:653
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
Definition: linkedlists.h:833
static void free_agi_cmd(struct agi_cmd *cmd)
Definition: res_agi.c:1514

◆ agi_exec()

static int agi_exec ( struct ast_channel chan,
const char *  data 
)
static

Definition at line 4553 of file res_agi.c.

4554 {
4555  if (!ast_check_hangup(chan))
4556  return agi_exec_full(chan, data, 0, 0);
4557  else
4558  return agi_exec_full(chan, data, 0, 1);
4559 }
int ast_check_hangup(struct ast_channel *chan)
Check to see if a channel is needing hang up.
Definition: channel.c:445
static int agi_exec_full(struct ast_channel *chan, const char *data, int enhanced, int dead)
Definition: res_agi.c:4486

References agi_exec_full(), and ast_check_hangup().

◆ agi_exec_end_to_ami()

static struct ast_manager_event_blob* agi_exec_end_to_ami ( struct stasis_message message)
static

Definition at line 1437 of file res_agi.c.

1438 {
1439  return agi_channel_to_ami("AGIExecEnd", message);
1440 }

References agi_channel_to_ami().

◆ agi_exec_full()

static int agi_exec_full ( struct ast_channel chan,
const char *  data,
int  enhanced,
int  dead 
)
static

Definition at line 4486 of file res_agi.c.

4487 {
4488  enum agi_result res;
4489  char *buf;
4490  int fds[2], efd = -1, pid = -1;
4492  AST_APP_ARG(arg)[MAX_ARGS];
4493  );
4494  AGI agi;
4495 
4496  if (ast_strlen_zero(data)) {
4497  ast_log(LOG_WARNING, "AGI requires an argument (script)\n");
4498  return -1;
4499  }
4500  if (dead)
4501  ast_debug(3, "Hungup channel detected, running agi in dead mode.\n");
4502  memset(&agi, 0, sizeof(agi));
4503  buf = ast_strdupa(data);
4505  args.arg[args.argc] = NULL;
4506 #if 0
4507  /* Answer if need be */
4508  if (chan->_state != AST_STATE_UP) {
4509  if (ast_answer(chan))
4510  return -1;
4511  }
4512 #endif
4513  res = launch_script(chan, args.arg[0], args.argc, args.arg, fds, enhanced ? &efd : NULL, &pid);
4514  /* Async AGI do not require run_agi(), so just proceed if normal AGI
4515  or Fast AGI are setup with success. */
4516  if (res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) {
4517  int status = 0;
4518  agi.fd = fds[1];
4519  agi.ctrl = fds[0];
4520  agi.audio = efd;
4521  agi.fast = (res == AGI_RESULT_SUCCESS_FAST) ? 1 : 0;
4522  res = run_agi(chan, args.arg[0], &agi, pid, &status, dead, args.argc, args.arg);
4523  /* If the fork'd process returns non-zero, set AGISTATUS to FAILURE */
4524  if ((res == AGI_RESULT_SUCCESS || res == AGI_RESULT_SUCCESS_FAST) && status)
4525  res = AGI_RESULT_FAILURE;
4526  if (fds[1] != fds[0])
4527  close(fds[1]);
4528  if (efd > -1)
4529  close(efd);
4530  }
4532 
4533  switch (res) {
4534  case AGI_RESULT_SUCCESS:
4537  pbx_builtin_setvar_helper(chan, "AGISTATUS", "SUCCESS");
4538  break;
4539  case AGI_RESULT_FAILURE:
4540  pbx_builtin_setvar_helper(chan, "AGISTATUS", "FAILURE");
4541  break;
4542  case AGI_RESULT_NOTFOUND:
4543  pbx_builtin_setvar_helper(chan, "AGISTATUS", "NOTFOUND");
4544  break;
4545  case AGI_RESULT_HANGUP:
4546  pbx_builtin_setvar_helper(chan, "AGISTATUS", "HANGUP");
4547  return -1;
4548  }
4549 
4550  return 0;
4551 }
jack_status_t status
Definition: app_jack.c:146
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
int ast_answer(struct ast_channel *chan)
Answer a channel.
Definition: channel.c:2806
@ AST_STATE_UP
Definition: channelstate.h:42
#define AST_APP_ARG(name)
Define an application argument.
void ast_safe_fork_cleanup(void)
Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
Definition: main/app.c:3328
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
#define ast_debug(level,...)
Log a DEBUG message.
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name.
#define MAX_ARGS
Definition: res_agi.c:1380
static enum agi_result run_agi(struct ast_channel *chan, char *request, AGI *agi, int pid, int *status, int dead, int argc, char *argv[])
Definition: res_agi.c:4104
static enum agi_result launch_script(struct ast_channel *chan, char *script, int argc, char *argv[], int *fds, int *efd, int *opid)
Definition: res_agi.c:2192
agi_result
Definition: res_agi.c:1404
Definition: agi.h:34
const char * args

References AGI_RESULT_FAILURE, AGI_RESULT_HANGUP, AGI_RESULT_NOTFOUND, AGI_RESULT_SUCCESS, AGI_RESULT_SUCCESS_ASYNC, AGI_RESULT_SUCCESS_FAST, args, ast_answer(), AST_APP_ARG, ast_debug, AST_DECLARE_APP_ARGS, ast_log, ast_safe_fork_cleanup(), AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_strdupa, ast_strlen_zero(), buf, agi_command::dead, launch_script(), LOG_WARNING, MAX_ARGS, NULL, pbx_builtin_setvar_helper(), run_agi(), and status.

Referenced by agi_exec(), and eagi_exec().

◆ agi_exec_start_to_ami()

static struct ast_manager_event_blob* agi_exec_start_to_ami ( struct stasis_message message)
static

Definition at line 1432 of file res_agi.c.

1433 {
1434  return agi_channel_to_ami("AGIExecStart", message);
1435 }

References agi_channel_to_ami().

◆ agi_handle_command()

static enum agi_result agi_handle_command ( struct ast_channel chan,
AGI agi,
char *  buf,
int  dead 
)
static

Definition at line 4002 of file res_agi.c.

4014 {
4015  const char *argv[MAX_ARGS] = {0};
4016  int argc = MAX_ARGS;
4017  int res;
4018  agi_command *c;
4019  char *ami_cmd = ast_strdupa(buf);
4020  const char *ami_res;
4021  int command_id = ast_random();
4022  int resultcode = 0;
4023  RAII_VAR(struct ast_json *, startblob, NULL, ast_json_unref);
4024 
4025  startblob = ast_json_pack("{s: i, s: s}",
4026  "CommandId", command_id,
4027  "Command", ami_cmd);
4028  ast_channel_publish_cached_blob(chan, agi_exec_start_type(), startblob);
4029 
4030  parse_args(buf, &argc, argv);
4031  c = find_command(argv, 0);
4032  if (!c || !ast_module_running_ref(c->mod)) {
4033  ami_res = "Invalid or unknown command";
4034  resultcode = 510;
4035 
4036  ast_agi_send(agi->fd, chan, "%d %s\n", resultcode, ami_res);
4037 
4038  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4039 
4040  return AGI_RESULT_SUCCESS;
4041  }
4042 
4043  if (!dead || (dead && c->dead)) {
4044  res = c->handler(chan, agi, argc, argv);
4045  switch (res) {
4046  case RESULT_SHOWUSAGE:
4047  ami_res = "Usage";
4048  resultcode = 520;
4049 
4050  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4051 
4052  if (ast_strlen_zero(c->usage)) {
4053  ast_agi_send(agi->fd, chan, "520 Invalid command syntax. Proper usage not available.\n");
4054  } else {
4055  ast_agi_send(agi->fd, chan, "520-Invalid command syntax. Proper usage follows:\n");
4056  ast_agi_send(agi->fd, chan, "%s\n", c->usage);
4057  ast_agi_send(agi->fd, chan, "520 End of proper usage.\n");
4058  }
4059 
4060  break;
4061  case RESULT_FAILURE:
4062  ami_res = "Failure";
4063  resultcode = -1;
4064 
4065  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4066 
4067  /* The RESULT_FAILURE code is usually because the channel hungup. */
4068  return AGI_RESULT_FAILURE;
4069  case ASYNC_AGI_BREAK:
4070  ami_res = "Success";
4071  resultcode = 200;
4072 
4073  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4074 
4075  return AGI_RESULT_SUCCESS_ASYNC;
4076  case RESULT_SUCCESS:
4077  ami_res = "Success";
4078  resultcode = 200;
4079 
4080  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4081 
4082  break;
4083  default:
4084  ami_res = "Unknown Result";
4085  resultcode = 200;
4086 
4087  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4088 
4089  break;
4090  }
4091  } else {
4092  ami_res = "Command Not Permitted on a dead channel or intercept routine";
4093  resultcode = 511;
4094 
4095  ast_agi_send(agi->fd, chan, "%d %s\n", resultcode, ami_res);
4096 
4097  publish_async_exec_end(chan, command_id, ami_cmd, resultcode, ami_res);
4098  }
4099  ast_module_unref(c->mod);
4100 
4101  return AGI_RESULT_SUCCESS;
4102 }
#define RESULT_SHOWUSAGE
Definition: cli.h:41
#define RESULT_SUCCESS
Definition: cli.h:40
#define RESULT_FAILURE
Definition: cli.h:42
void ast_channel_publish_cached_blob(struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
Publish a channel blob message using the latest snapshot from the cache.
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition: json.c:591
#define ast_module_unref(mod)
Release a reference to the module.
Definition: module.h:469
#define ast_module_running_ref(mod)
Hold a reference to the module if it is running.
Definition: module.h:455
static int parse_args(char *s, int *max, const char *argv[])
Definition: res_agi.c:3939
static agi_command * find_command(const char *const cmds[], int exact)
Definition: res_agi.c:3901
#define ASYNC_AGI_BREAK
Definition: res_agi.c:1402
static void publish_async_exec_end(struct ast_channel *chan, int command_id, const char *command, int result_code, const char *result)
Definition: res_agi.c:4002
int AST_OPTIONAL_API_NAME() ast_agi_send(int fd, struct ast_channel *chan, char *fmt,...)
Sends a string of text to an application connected via AGI.
Definition: res_agi.c:1478
int fd
Definition: agi.h:35
Abstract JSON element (object, array, string, int, ...).
static struct test_val c
long int ast_random(void)
Definition: main/utils.c:2210

References ast_channel_publish_cached_blob(), ast_json_pack(), ast_json_unref(), NULL, RAII_VAR, and result.

◆ ast_agi_register()

int AST_OPTIONAL_API_NAME() ast_agi_register ( struct ast_module mod,
agi_command cmd 
)

Registers an AGI command.

Parameters
modPointer to the module_info structure for the module that is registering the command
cmdPointer to the descriptor for the command
Return values
1on success
0the command is already registered
AST_OPTIONAL_API_UNAVAILABLEthe module is not loaded.

Definition at line 3775 of file res_agi.c.

3776 {
3777  char fullcmd[MAX_CMD_LEN];
3778 
3779  ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
3780 
3781  if (!find_command(cmd->cmda, 1)) {
3782  *((enum ast_doc_src *) &cmd->docsrc) = AST_STATIC_DOC;
3783  if (ast_strlen_zero(cmd->summary) && ast_strlen_zero(cmd->usage)) {
3784 #ifdef AST_XML_DOCS
3785  *((char **) &cmd->summary) = ast_xmldoc_build_synopsis("agi", fullcmd, NULL);
3786  *((char **) &cmd->usage) = ast_xmldoc_build_description("agi", fullcmd, NULL);
3787  *((char **) &cmd->syntax) = ast_xmldoc_build_syntax("agi", fullcmd, NULL);
3788  *((char **) &cmd->seealso) = ast_xmldoc_build_seealso("agi", fullcmd, NULL);
3789  *((enum ast_doc_src *) &cmd->docsrc) = AST_XML_DOC;
3790 #endif
3791 #ifndef HAVE_NULLSAFE_PRINTF
3792  if (!cmd->summary) {
3793  *((char **) &cmd->summary) = ast_strdup("");
3794  }
3795  if (!cmd->usage) {
3796  *((char **) &cmd->usage) = ast_strdup("");
3797  }
3798  if (!cmd->syntax) {
3799  *((char **) &cmd->syntax) = ast_strdup("");
3800  }
3801  if (!cmd->seealso) {
3802  *((char **) &cmd->seealso) = ast_strdup("");
3803  }
3804 #endif
3805  }
3806 
3807  cmd->mod = mod;
3809  AST_LIST_INSERT_TAIL(&agi_commands, cmd, list);
3811  ast_verb(2, "AGI Command '%s' registered\n",fullcmd);
3812  return 1;
3813  } else {
3814  ast_log(LOG_WARNING, "Command already registered!\n");
3815  return 0;
3816  }
3817 }
#define ast_verb(level,...)
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define MAX_CMD_LEN
Definition: res_agi.c:1381
#define ast_join(s, len, w)
Join an array of strings into a single string.
Definition: strings.h:501
const char *const summary
Definition: agi.h:48
struct ast_module * mod
Definition: agi.h:60
enum ast_doc_src docsrc
Definition: agi.h:58
const char *const usage
Definition: agi.h:50
const char *const seealso
Definition: agi.h:56
const char *const syntax
Definition: agi.h:54
const char *const cmda[AST_MAX_CMD_LEN]
Definition: agi.h:43
char * ast_xmldoc_build_seealso(const char *type, const char *name, const char *module)
Parse the <see-also> node content.
Definition: xmldoc.c:1698
char * ast_xmldoc_build_syntax(const char *type, const char *name, const char *module)
Get the syntax for a specified application or function.
Definition: xmldoc.c:1253
ast_doc_src
From where the documentation come from, this structure is useful for use it inside application/functi...
Definition: xmldoc.h:30
@ AST_XML_DOC
Definition: xmldoc.h:31
@ AST_STATIC_DOC
Definition: xmldoc.h:32
char * ast_xmldoc_build_description(const char *type, const char *name, const char *module)
Generate description documentation from XML.
Definition: xmldoc.c:2252
char * ast_xmldoc_build_synopsis(const char *type, const char *name, const char *module)
Generate synopsis documentation from XML.
Definition: xmldoc.c:2229

References ast_join, AST_LIST_INSERT_TAIL, ast_log, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, AST_STATIC_DOC, ast_strdup, ast_strlen_zero(), ast_verb, AST_XML_DOC, ast_xmldoc_build_description(), ast_xmldoc_build_seealso(), ast_xmldoc_build_synopsis(), ast_xmldoc_build_syntax(), find_command(), LOG_WARNING, MAX_CMD_LEN, and NULL.

Referenced by ast_agi_register_multiple(), and AST_TEST_DEFINE().

◆ ast_agi_register_multiple()

int AST_OPTIONAL_API_NAME() ast_agi_register_multiple ( struct ast_module mod,
struct agi_command cmd,
unsigned int  len 
)

Registers a group of AGI commands, provided as an array of struct agi_command entries.

Parameters
modPointer to the module_info structure for the module that is registering the commands
cmdPointer to the first entry in the array of command descriptors
lenLength of the array (use the ARRAY_LEN macro to determine this easily)
Returns
0 on success, -1 on failure, AST_OPTIONAL_API_UNAVAILABLE if res_agi is not loaded
Note
If any command fails to register, all commands previously registered during the operation will be unregistered. In other words, this function registers all the provided commands, or none of them.

Definition at line 3855 of file res_agi.c.

3856 {
3857  unsigned int i, x = 0;
3858 
3859  for (i = 0; i < len; i++) {
3860  if (ast_agi_register(mod, cmd + i) == 1) {
3861  x++;
3862  continue;
3863  }
3864 
3865  /* registration failed, unregister everything
3866  that had been registered up to that point
3867  */
3868  for (; x > 0; x--) {
3869  /* we are intentionally ignoring the
3870  result of ast_agi_unregister() here,
3871  but it should be safe to do so since
3872  we just registered these commands and
3873  the only possible way for unregistration
3874  to fail is if the command is not
3875  registered
3876  */
3877  (void) ast_agi_unregister(cmd + x - 1);
3878  }
3879  return -1;
3880  }
3881 
3882  return 0;
3883 }
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
int AST_OPTIONAL_API_NAME() ast_agi_unregister(agi_command *cmd)
Unregisters an AGI command.
Definition: res_agi.c:3819
int AST_OPTIONAL_API_NAME() ast_agi_register(struct ast_module *mod, agi_command *cmd)
Registers an AGI command.
Definition: res_agi.c:3775

References ast_agi_register(), ast_agi_unregister(), len(), and agi_command::mod.

◆ ast_agi_send()

int AST_OPTIONAL_API_NAME() ast_agi_send ( int  fd,
struct ast_channel chan,
char *  fmt,
  ... 
)

Sends a string of text to an application connected via AGI.

Parameters
fdThe file descriptor for the AGI session (from struct agi_state)
chanPointer to an associated Asterisk channel, if any
fmtprintf-style format string
Returns
0 for success, -1 for failure, AST_OPTIONAL_API_UNAVAILABLE if res_agi is not loaded

Definition at line 1478 of file res_agi.c.

1479 {
1480  int res = 0;
1481  va_list ap;
1482  struct ast_str *buf;
1483 
1485  return -1;
1486 
1487  va_start(ap, fmt);
1488  res = ast_str_set_va(&buf, 0, fmt, ap);
1489  va_end(ap);
1490 
1491  if (res == -1) {
1492  ast_log(LOG_ERROR, "Out of memory\n");
1493  return -1;
1494  }
1495 
1496  if (agidebug) {
1497  if (chan) {
1498  ast_verbose("<%s>AGI Tx >> %s", ast_channel_name(chan), ast_str_buffer(buf));
1499  } else {
1500  ast_verbose("AGI Tx >> %s", ast_str_buffer(buf));
1501  }
1502  }
1503 
1505 }
void ast_verbose(const char *fmt,...)
Definition: extconf.c:2206
static struct ast_threadstorage agi_buf
Definition: res_agi.c:1475
static int agidebug
Definition: res_agi.c:1392
#define AGI_BUF_INITSIZE
Definition: res_agi.c:1476
int ast_str_set_va(struct ast_str **buf, ssize_t max_len, const char *fmt, va_list ap)
Set a dynamic string from a va_list.
Definition: strings.h:1008
size_t ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition: strings.h:711
struct ast_str * ast_str_thread_get(struct ast_threadstorage *ts, size_t init_len)
Retrieve a thread locally stored dynamic string.
Definition: strings.h:887
int ast_carefulwrite(int fd, char *s, int len, int timeoutms)
Try to write string, but wait no more than ms milliseconds before timing out.
Definition: main/utils.c:1738

References agi_buf, AGI_BUF_INITSIZE, agidebug, ast_carefulwrite(), ast_channel_name(), ast_log, ast_str_buffer(), ast_str_set_va(), ast_str_strlen(), ast_str_thread_get(), ast_verbose(), buf, and LOG_ERROR.

Referenced by handle_answer(), handle_asyncagi_break(), handle_autohangup(), handle_channelstatus(), handle_controlstreamfile(), handle_dbdel(), handle_dbdeltree(), handle_dbget(), handle_dbput(), handle_exec(), handle_getdata(), handle_getoption(), handle_getvariable(), handle_getvariablefull(), handle_hangup(), handle_noop(), handle_recordfile(), handle_recvchar(), handle_recvtext(), handle_sayalpha(), handle_saydate(), handle_saydatetime(), handle_saydigits(), handle_saynumber(), handle_sayphonetic(), handle_saytime(), handle_sendimage(), handle_sendtext(), handle_setcallerid(), handle_setcontext(), handle_setextension(), handle_setmusic(), handle_setpriority(), handle_setvariable(), handle_speechactivategrammar(), handle_speechcreate(), handle_speechdeactivategrammar(), handle_speechdestroy(), handle_speechloadgrammar(), handle_speechset(), handle_speechunloadgrammar(), handle_streamfile(), handle_tddmode(), handle_verbose(), handle_waitfordigit(), and setup_env().

◆ ast_agi_unregister()

int AST_OPTIONAL_API_NAME() ast_agi_unregister ( agi_command cmd)

Unregisters an AGI command.

Parameters
cmdPointer to the descriptor for the command
Returns
1 on success, 0 if the command was not already registered

Definition at line 3819 of file res_agi.c.

3820 {
3821  struct agi_command *e;
3822  int unregistered = 0;
3823  char fullcmd[MAX_CMD_LEN];
3824 
3825  ast_join(fullcmd, sizeof(fullcmd), cmd->cmda);
3826 
3829  if (cmd == e) {
3831 #ifdef AST_XML_DOCS
3832  if (e->docsrc == AST_XML_DOC) {
3833  ast_free((char *) e->summary);
3834  ast_free((char *) e->usage);
3835  ast_free((char *) e->syntax);
3836  ast_free((char *) e->seealso);
3837  *((char **) &e->summary) = NULL;
3838  *((char **) &e->usage) = NULL;
3839  *((char **) &e->syntax) = NULL;
3840  *((char **) &e->seealso) = NULL;
3841  }
3842 #endif
3843  unregistered=1;
3844  break;
3845  }
3846  }
3849  if (unregistered) {
3850  ast_verb(2, "AGI Command '%s' unregistered\n",fullcmd);
3851  }
3852  return unregistered;
3853 }
#define AST_RWLIST_REMOVE_CURRENT
Definition: linkedlists.h:570
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
Definition: linkedlists.h:545
#define AST_RWLIST_TRAVERSE_SAFE_END
Definition: linkedlists.h:617
struct agi_command::@209 list

References ast_free, ast_join, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, AST_XML_DOC, agi_command::docsrc, agi_command::list, MAX_CMD_LEN, NULL, agi_command::seealso, agi_command::summary, agi_command::syntax, and agi_command::usage.

Referenced by ast_agi_register_multiple(), ast_agi_unregister_multiple(), and AST_TEST_DEFINE().

◆ ast_agi_unregister_multiple()

int AST_OPTIONAL_API_NAME() ast_agi_unregister_multiple ( struct agi_command cmd,
unsigned int  len 
)

Unregisters a group of AGI commands, provided as an array of struct agi_command entries.

Parameters
cmdPointer to the first entry in the array of command descriptors
lenLength of the array (use the ARRAY_LEN macro to determine this easily)
Returns
0 on success, -1 on failure, AST_OPTIONAL_API_UNAVAILABLE if res_agi is not loaded
Note
If any command fails to unregister, this function will continue to unregister the remaining commands in the array; it will not reregister the already-unregistered commands.

Definition at line 3885 of file res_agi.c.

3886 {
3887  unsigned int i;
3888  int res = 0;
3889 
3890  for (i = 0; i < len; i++) {
3891  /* remember whether any of the unregistration
3892  attempts failed... there is no recourse if
3893  any of them do
3894  */
3895  res |= ast_agi_unregister(cmd + i);
3896  }
3897 
3898  return res;
3899 }

References ast_agi_unregister(), and len().

Referenced by unload_module().

◆ AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM ( void  )

Definition at line 4707 of file res_agi.c.

◆ async_agi_read_frame()

static enum agi_result async_agi_read_frame ( struct ast_channel chan)
static

Definition at line 1739 of file res_agi.c.

1752 {
1753  struct ast_frame *f;
1754 
1755  f = ast_read(chan);
1756  if (!f) {
1757  ast_debug(3, "No frame read on channel %s, going out ...\n", ast_channel_name(chan));
1758  return AGI_RESULT_HANGUP;
1759  }
1760  if (f->frametype == AST_FRAME_CONTROL) {
1761  /*
1762  * Is there any other frame we should care about besides
1763  * AST_CONTROL_HANGUP?
1764  */
1765  switch (f->subclass.integer) {
1766  case AST_CONTROL_HANGUP:
1767  ast_debug(3, "Got HANGUP frame on channel %s, going out ...\n", ast_channel_name(chan));
1768  ast_frfree(f);
1769  return AGI_RESULT_HANGUP;
1770  default:
1771  break;
1772  }
1773  }
1774  ast_frfree(f);
1775 
1776  return AGI_RESULT_SUCCESS;
1777 }
struct ast_frame * ast_read(struct ast_channel *chan)
Reads a frame.
Definition: channel.c:4292
#define ast_frfree(fr)
@ AST_FRAME_CONTROL
@ AST_CONTROL_HANGUP
Data structure associated with a single frame of data.
struct ast_frame_subclass subclass
enum ast_frame_type frametype

◆ deadagi_exec()

static int deadagi_exec ( struct ast_channel chan,
const char *  data 
)
static

Definition at line 4603 of file res_agi.c.

4604 {
4605  ast_log(LOG_WARNING, "DeadAGI has been deprecated, please use AGI in all cases!\n");
4606  return agi_exec(chan, data);
4607 }
static int agi_exec(struct ast_channel *chan, const char *data)
Definition: res_agi.c:4553

◆ eagi_exec()

static int eagi_exec ( struct ast_channel chan,
const char *  data 
)
static

Definition at line 4561 of file res_agi.c.

4562 {
4563  int res;
4564  struct ast_format *readformat;
4565  struct ast_format *requested_format = NULL;
4566  const char *requested_format_name;
4567 
4568  if (ast_check_hangup(chan)) {
4569  ast_log(LOG_ERROR, "EAGI cannot be run on a dead/hungup channel, please use AGI.\n");
4570  return 0;
4571  }
4572 
4573  requested_format_name = pbx_builtin_getvar_helper(chan, "EAGI_AUDIO_FORMAT");
4574  if (requested_format_name) {
4575  requested_format = ast_format_cache_get(requested_format_name);
4576  if (requested_format) {
4577  ast_verb(3, "<%s> Setting EAGI audio pipe format to %s\n",
4578  ast_channel_name(chan), ast_format_get_name(requested_format));
4579  } else {
4580  ast_log(LOG_ERROR, "Could not find requested format: %s\n", requested_format_name);
4581  }
4582  }
4583 
4584  readformat = ao2_bump(ast_channel_readformat(chan));
4585  if (ast_set_read_format(chan, requested_format ?: ast_format_slin)) {
4586  ast_log(LOG_WARNING, "Unable to set channel '%s' to linear mode\n", ast_channel_name(chan));
4587  ao2_cleanup(requested_format);
4588  ao2_cleanup(readformat);
4589  return -1;
4590  }
4591  res = agi_exec_full(chan, data, 1, 0);
4592  if (!res) {
4593  if (ast_set_read_format(chan, readformat)) {
4594  ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %s\n", ast_channel_name(chan),
4595  ast_format_get_name(readformat));
4596  }
4597  }
4598  ao2_cleanup(requested_format);
4599  ao2_cleanup(readformat);
4600  return res;
4601 }
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
int ast_set_read_format(struct ast_channel *chan, struct ast_format *format)
Sets read format on channel chan.
Definition: channel.c:5839
struct ast_format * ast_channel_readformat(struct ast_channel *chan)
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
#define ast_format_cache_get(name)
Retrieve a named format from the cache.
Definition: format_cache.h:278
struct ast_format * ast_format_slin
Built-in cached signed linear 8kHz format.
Definition: format_cache.c:41
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
Definition of a media format.
Definition: format.c:43

References agi_exec_full(), ao2_bump, ao2_cleanup, ast_channel_name(), ast_channel_readformat(), ast_check_hangup(), ast_format_cache_get, ast_format_get_name(), ast_format_slin, ast_log, ast_set_read_format(), ast_verb, LOG_ERROR, LOG_WARNING, NULL, and pbx_builtin_getvar_helper().

◆ find_command()

static agi_command * find_command ( const char *const  cmds[],
int  exact 
)
static

Definition at line 3901 of file res_agi.c.

3902 {
3903  int y, match;
3904  struct agi_command *e;
3905 
3908  if (!e->cmda[0])
3909  break;
3910  /* start optimistic */
3911  match = 1;
3912  for (y = 0; match && cmds[y]; y++) {
3913  /* If there are no more words in the command (and we're looking for
3914  an exact match) or there is a difference between the two words,
3915  then this is not a match */
3916  if (!e->cmda[y] && !exact)
3917  break;
3918  /* don't segfault if the next part of a command doesn't exist */
3919  if (!e->cmda[y]) {
3921  return NULL;
3922  }
3923  if (strcasecmp(e->cmda[y], cmds[y]))
3924  match = 0;
3925  }
3926  /* If more words are needed to complete the command then this is not
3927  a candidate (unless we're looking for a really inexact answer */
3928  if ((exact > -1) && e->cmda[y])
3929  match = 0;
3930  if (match) {
3932  return e;
3933  }
3934  }
3936  return NULL;
3937 }
static int match(struct ast_sockaddr *addr, unsigned short callno, unsigned short dcallno, const struct chan_iax2_pvt *cur, int check_dcallno)
Definition: chan_iax2.c:2312
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:494

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, agi_command::cmda, agi_command::list, match(), and NULL.

Referenced by ast_agi_register(), and handle_cli_agi_show().

◆ free_agi_cmd()

static void free_agi_cmd ( struct agi_cmd cmd)
static

Definition at line 1514 of file res_agi.c.

1515 {
1516  ast_free(cmd->cmd_buffer);
1517  ast_free(cmd->cmd_id);
1518  ast_free(cmd);
1519 }

References ast_free, agi_cmd::cmd_buffer, and agi_cmd::cmd_id.

◆ get_agi_cmd()

static int get_agi_cmd ( struct ast_channel chan,
struct agi_cmd **  cmd 
)
static

Retrieve the list head to the requested channel's AGI datastore.

Parameters
chanChannel datastore is requested for
cmdPointer to the struct pointer which will reference the head of the agi command list.
Return values
0if the datastore was valid and the list head was retrieved appropriately (even if it's NULL and the list is empty)
-1if the datastore could not be retrieved causing an error

Definition at line 1550 of file res_agi.c.

1551 {
1552  struct ast_datastore *store;
1554 
1555  ast_channel_lock(chan);
1557  ast_channel_unlock(chan);
1558  if (!store) {
1559  ast_log(LOG_ERROR, "Huh? Async AGI datastore disappeared on Channel %s!\n",
1560  ast_channel_name(chan));
1561  *cmd = NULL;
1562  return -1;
1563  }
1564  agi_commands = store->data;
1568  return 0;
1569 }

References agi_commands, agi_commands_datastore_info, ast_channel_datastore_find(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, AST_LIST_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log, ast_datastore::data, LOG_ERROR, and NULL.

◆ handle_answer()

static int handle_answer ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2356 of file res_agi.c.

2357 {
2358  int res = 0;
2359 
2360  /* Answer the channel */
2361  if (ast_channel_state(chan) != AST_STATE_UP)
2362  res = ast_answer(chan);
2363 
2364  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2365  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2366 }
ast_channel_state
ast_channel states
Definition: channelstate.h:35

References ast_agi_send(), ast_answer(), AST_STATE_UP, agi_state::fd, RESULT_FAILURE, and RESULT_SUCCESS.

◆ handle_asyncagi_break()

static int handle_asyncagi_break ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2368 of file res_agi.c.

2369 {
2370  ast_agi_send(agi->fd, chan, "200 result=0\n");
2371  return ASYNC_AGI_BREAK;
2372 }

References ast_agi_send(), ASYNC_AGI_BREAK, and agi_state::fd.

◆ handle_autohangup()

static int handle_autohangup ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3070 of file res_agi.c.

3071 {
3072  double timeout;
3073  struct timeval whentohangup = { 0, 0 };
3074 
3075  if (argc != 3)
3076  return RESULT_SHOWUSAGE;
3077  if (sscanf(argv[2], "%30lf", &timeout) != 1)
3078  return RESULT_SHOWUSAGE;
3079  if (timeout < 0)
3080  timeout = 0;
3081  if (timeout) {
3082  whentohangup.tv_sec = timeout;
3083  whentohangup.tv_usec = (timeout - whentohangup.tv_sec) * 1000000.0;
3084  }
3085  ast_channel_lock(chan);
3086  ast_channel_setwhentohangup_tv(chan, whentohangup);
3087  ast_channel_unlock(chan);
3088  ast_agi_send(agi->fd, chan, "200 result=0\n");
3089  return RESULT_SUCCESS;
3090 }
void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset)
Set when to hang a channel up.
Definition: channel.c:510

References ast_agi_send(), ast_channel_lock, ast_channel_setwhentohangup_tv(), ast_channel_unlock, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_channelstatus()

static int handle_channelstatus ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3171 of file res_agi.c.

3172 {
3173  if (argc == 2) {
3174  /* no argument: supply info on the current channel */
3175  ast_agi_send(agi->fd, chan, "200 result=%u\n", ast_channel_state(chan));
3176  return RESULT_SUCCESS;
3177  } else if (argc == 3) {
3178  struct ast_channel_snapshot *snapshot;
3179 
3180  /* one argument: look for info on the specified channel */
3181  snapshot = ast_channel_snapshot_get_latest_by_name(argv[2]);
3182  if (snapshot) {
3183  ast_agi_send(agi->fd, chan, "200 result=%u\n", snapshot->state);
3184  ao2_ref(snapshot, -1);
3185  return RESULT_SUCCESS;
3186  }
3187  /* if we get this far no channel name matched the argument given */
3188  ast_agi_send(agi->fd, chan, "200 result=-1\n");
3189  return RESULT_SUCCESS;
3190  } else {
3191  return RESULT_SHOWUSAGE;
3192  }
3193 }
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
struct ast_channel_snapshot * ast_channel_snapshot_get_latest_by_name(const char *name)
Obtain the latest ast_channel_snapshot from the Stasis Message Bus API cache. This is an ao2 object,...
Structure representing a snapshot of channel state.
enum ast_channel_state state

References ao2_ref, ast_agi_send(), ast_channel_snapshot_get_latest_by_name(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and ast_channel_snapshot::state.

◆ handle_cli_agi_add_cmd()

static char* handle_cli_agi_add_cmd ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

CLI command to add applications to execute in Async AGI.

Parameters
e
cmd
a
Return values
CLI_SUCCESSon success
NULLwhen init or tab completion is used

Definition at line 1649 of file res_agi.c.

1650 {
1651  struct ast_channel *chan;
1652  switch (cmd) {
1653  case CLI_INIT:
1654  e->command = "agi exec";
1655  e->usage = "Usage: agi exec <channel name> <app and arguments> [id]\n"
1656  " Add AGI command to the execute queue of the specified channel in Async AGI\n";
1657  return NULL;
1658  case CLI_GENERATE:
1659  if (a->pos == 2)
1660  return ast_complete_channels(a->line, a->word, a->pos, a->n, 2);
1661  return NULL;
1662  }
1663 
1664  if (a->argc < 4) {
1665  return CLI_SHOWUSAGE;
1666  }
1667 
1668  if (!(chan = ast_channel_get_by_name(a->argv[2]))) {
1669  ast_cli(a->fd, "Channel %s does not exist.\n", a->argv[2]);
1670  return CLI_FAILURE;
1671  }
1672 
1673  ast_channel_lock(chan);
1674 
1675  if (add_agi_cmd(chan, a->argv[3], (a->argc > 4 ? a->argv[4] : ""))) {
1676  ast_cli(a->fd, "Failed to add AGI command to queue of channel %s\n", ast_channel_name(chan));
1677  ast_channel_unlock(chan);
1678  chan = ast_channel_unref(chan);
1679  return CLI_FAILURE;
1680  }
1681 
1682  ast_debug(1, "Added AGI command to channel %s queue\n", ast_channel_name(chan));
1683 
1684  ast_channel_unlock(chan);
1685  chan = ast_channel_unref(chan);
1686 
1687  return CLI_SUCCESS;
1688 }
#define CLI_SHOWUSAGE
Definition: cli.h:45
char * ast_complete_channels(const char *line, const char *word, int pos, int state, int rpos)
Command completion for the list of active channels.
Definition: main/cli.c:1862
#define CLI_SUCCESS
Definition: cli.h:44
void ast_cli(int fd, const char *fmt,...)
Definition: clicompat.c:6
@ CLI_INIT
Definition: cli.h:152
@ CLI_GENERATE
Definition: cli.h:153
#define CLI_FAILURE
Definition: cli.h:46
char * command
Definition: cli.h:186
const char * usage
Definition: cli.h:177
static struct test_val a

References a, add_agi_cmd(), ast_channel_get_by_name(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_channel_unref, ast_cli(), ast_complete_channels(), ast_debug, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, and ast_cli_entry::usage.

◆ handle_cli_agi_debug()

static char* handle_cli_agi_debug ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 3354 of file res_agi.c.

3355 {
3356  switch (cmd) {
3357  case CLI_INIT:
3358  e->command = "agi set debug [on|off]";
3359  e->usage =
3360  "Usage: agi set debug [on|off]\n"
3361  " Enables/disables dumping of AGI transactions for\n"
3362  " debugging purposes.\n";
3363  return NULL;
3364 
3365  case CLI_GENERATE:
3366  return NULL;
3367  }
3368 
3369  if (a->argc != e->args)
3370  return CLI_SHOWUSAGE;
3371 
3372  if (strncasecmp(a->argv[3], "off", 3) == 0) {
3373  agidebug = 0;
3374  } else if (strncasecmp(a->argv[3], "on", 2) == 0) {
3375  agidebug = 1;
3376  } else {
3377  return CLI_SHOWUSAGE;
3378  }
3379  ast_cli(a->fd, "AGI Debugging %sabled\n", agidebug ? "En" : "Dis");
3380  return CLI_SUCCESS;
3381 }
int args
This gets set in ast_cli_register()
Definition: cli.h:185

References a, agidebug, ast_cli_entry::args, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, and ast_cli_entry::usage.

◆ handle_cli_agi_dump_html()

static char* handle_cli_agi_dump_html ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 4462 of file res_agi.c.

4463 {
4464  switch (cmd) {
4465  case CLI_INIT:
4466  e->command = "agi dump html";
4467  e->usage =
4468  "Usage: agi dump html <filename>\n"
4469  " Dumps the AGI command list in HTML format to the given\n"
4470  " file.\n";
4471  return NULL;
4472  case CLI_GENERATE:
4473  return NULL;
4474  }
4475  if (a->argc != e->args + 1)
4476  return CLI_SHOWUSAGE;
4477 
4478  if (write_htmldump(a->argv[e->args]) < 0) {
4479  ast_cli(a->fd, "Could not create file '%s'\n", a->argv[e->args]);
4480  return CLI_SHOWUSAGE;
4481  }
4482  ast_cli(a->fd, "AGI HTML commands dumped to: %s\n", a->argv[e->args]);
4483  return CLI_SUCCESS;
4484 }
static int write_htmldump(const char *filename)
Definition: res_agi.c:4410

References a, ast_cli_entry::args, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, NULL, ast_cli_entry::usage, and write_htmldump().

◆ handle_cli_agi_show()

static char* handle_cli_agi_show ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 4276 of file res_agi.c.

4277 {
4278  struct agi_command *command;
4279  char fullcmd[MAX_CMD_LEN];
4280  int error = 0;
4281 
4282  switch (cmd) {
4283  case CLI_INIT:
4284  e->command = "agi show commands [topic]";
4285  e->usage =
4286  "Usage: agi show commands [topic] <topic>\n"
4287  " When called with a topic as an argument, displays usage\n"
4288  " information on the given command. If called without a\n"
4289  " topic, it provides a list of AGI commands.\n";
4290  case CLI_GENERATE:
4291  return NULL;
4292  }
4293  if (a->argc < e->args - 1 || (a->argc >= e->args && strcasecmp(a->argv[e->args - 1], "topic")))
4294  return CLI_SHOWUSAGE;
4295  if (a->argc > e->args - 1) {
4296  command = find_command(a->argv + e->args, 1);
4297  if (command) {
4298  char *synopsis = NULL, *description = NULL, *syntax = NULL, *seealso = NULL;
4299  char info[30 + MAX_CMD_LEN]; /* '-= Info about...' */
4300  char infotitle[30 + MAX_CMD_LEN + AST_TERM_MAX_ESCAPE_CHARS]; /* '-= Info about...' with colors */
4301  char syntitle[11 + AST_TERM_MAX_ESCAPE_CHARS]; /* [Syntax]\n with colors */
4302  char desctitle[15 + AST_TERM_MAX_ESCAPE_CHARS]; /* [Description]\n with colors */
4303  char deadtitle[13 + AST_TERM_MAX_ESCAPE_CHARS]; /* [Runs Dead]\n with colors */
4304  char deadcontent[3 + AST_TERM_MAX_ESCAPE_CHARS]; /* 'Yes' or 'No' with colors */
4305  char seealsotitle[12 + AST_TERM_MAX_ESCAPE_CHARS]; /* [See Also]\n with colors */
4306  char stxtitle[10 + AST_TERM_MAX_ESCAPE_CHARS]; /* [Syntax]\n with colors */
4307  size_t synlen, desclen, seealsolen, stxlen;
4308 
4309  term_color(syntitle, "[Synopsis]\n", COLOR_MAGENTA, 0, sizeof(syntitle));
4310  term_color(desctitle, "[Description]\n", COLOR_MAGENTA, 0, sizeof(desctitle));
4311  term_color(deadtitle, "[Runs Dead]\n", COLOR_MAGENTA, 0, sizeof(deadtitle));
4312  term_color(seealsotitle, "[See Also]\n", COLOR_MAGENTA, 0, sizeof(seealsotitle));
4313  term_color(stxtitle, "[Syntax]\n", COLOR_MAGENTA, 0, sizeof(stxtitle));
4314  term_color(deadcontent, command->dead ? "Yes" : "No", COLOR_CYAN, 0, sizeof(deadcontent));
4315 
4316  ast_join(fullcmd, sizeof(fullcmd), a->argv + e->args);
4317  snprintf(info, sizeof(info), "\n -= Info about agi '%s' =- ", fullcmd);
4318  term_color(infotitle, info, COLOR_CYAN, 0, sizeof(infotitle));
4319 #ifdef AST_XML_DOCS
4320  if (command->docsrc == AST_XML_DOC) {
4321  synopsis = ast_xmldoc_printable(S_OR(command->summary, "Not available"), 1);
4322  description = ast_xmldoc_printable(S_OR(command->usage, "Not available"), 1);
4323  seealso = ast_xmldoc_printable(S_OR(command->seealso, "Not available"), 1);
4324  if (!seealso || !description || !synopsis) {
4325  error = 1;
4326  goto return_cleanup;
4327  }
4328  } else
4329 #endif
4330  {
4331  synlen = strlen(S_OR(command->summary, "Not available")) + AST_TERM_MAX_ESCAPE_CHARS;
4332  synopsis = ast_malloc(synlen);
4333 
4334  desclen = strlen(S_OR(command->usage, "Not available")) + AST_TERM_MAX_ESCAPE_CHARS;
4335  description = ast_malloc(desclen);
4336 
4337  seealsolen = strlen(S_OR(command->seealso, "Not available")) + AST_TERM_MAX_ESCAPE_CHARS;
4338  seealso = ast_malloc(seealsolen);
4339 
4340  if (!synopsis || !description || !seealso) {
4341  error = 1;
4342  goto return_cleanup;
4343  }
4344  term_color(synopsis, S_OR(command->summary, "Not available"), COLOR_CYAN, 0, synlen);
4345  term_color(description, S_OR(command->usage, "Not available"), COLOR_CYAN, 0, desclen);
4346  term_color(seealso, S_OR(command->seealso, "Not available"), COLOR_CYAN, 0, seealsolen);
4347  }
4348 
4349  stxlen = strlen(S_OR(command->syntax, "Not available")) + AST_TERM_MAX_ESCAPE_CHARS;
4350  syntax = ast_malloc(stxlen);
4351  if (!syntax) {
4352  error = 1;
4353  goto return_cleanup;
4354  }
4355  term_color(syntax, S_OR(command->syntax, "Not available"), COLOR_CYAN, 0, stxlen);
4356 
4357  ast_cli(a->fd, "%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n%s%s\n\n", infotitle, stxtitle, syntax,
4358  desctitle, description, syntitle, synopsis, deadtitle, deadcontent,
4359  seealsotitle, seealso);
4360 return_cleanup:
4361  ast_free(synopsis);
4362  ast_free(description);
4363  ast_free(syntax);
4364  ast_free(seealso);
4365  } else {
4366  if (find_command(a->argv + e->args, -1)) {
4367  return help_workhorse(a->fd, a->argv + e->args);
4368  } else {
4369  ast_join(fullcmd, sizeof(fullcmd), a->argv + e->args);
4370  ast_cli(a->fd, "No such command '%s'.\n", fullcmd);
4371  }
4372  }
4373  } else {
4374  return help_workhorse(a->fd, NULL);
4375  }
4376  return (error ? CLI_FAILURE : CLI_SUCCESS);
4377 }
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
static char * synopsis
Definition: func_enum.c:154
def info(msg)
static char * help_workhorse(int fd, const char *const match[])
Definition: res_agi.c:3749
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
const int dead
Definition: agi.h:52
char * term_color(char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
Colorize a specified string by adding terminal color codes.
Definition: term.c:235
#define COLOR_CYAN
Definition: term.h:62
#define COLOR_MAGENTA
Definition: term.h:60
#define AST_TERM_MAX_ESCAPE_CHARS
Maximum number of characters needed for a color escape sequence, and another one for a trailing reset...
Definition: term.h:75
int error(const char *format,...)
Definition: utils/frame.c:999
char * ast_xmldoc_printable(const char *bwinput, int withcolors)
Colorize and put delimiters (instead of tags) to the xmldoc output.
Definition: xmldoc.c:242

References a, ast_cli_entry::args, ast_cli(), ast_free, ast_join, ast_malloc, AST_TERM_MAX_ESCAPE_CHARS, AST_XML_DOC, ast_xmldoc_printable(), CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, COLOR_CYAN, COLOR_MAGENTA, ast_cli_entry::command, agi_command::dead, agi_command::docsrc, error(), find_command(), help_workhorse(), sip_to_pjsip::info(), MAX_CMD_LEN, NULL, S_OR, agi_command::seealso, agi_command::summary, synopsis, agi_command::syntax, term_color(), agi_command::usage, and ast_cli_entry::usage.

◆ handle_connection()

static int handle_connection ( const char *  agiurl,
const struct ast_sockaddr  addr,
const int  netsockfd 
)
static

Definition at line 2004 of file res_agi.c.

2005 {
2006  struct pollfd pfds[1];
2007  int res, conresult;
2008  socklen_t reslen;
2009 
2010  reslen = sizeof(conresult);
2011 
2012  pfds[0].fd = netsockfd;
2013  pfds[0].events = POLLOUT;
2014 
2015  while ((res = ast_poll(pfds, 1, MAX_AGI_CONNECT)) != 1) {
2016  if (errno != EINTR) {
2017  if (!res) {
2018  ast_log(LOG_WARNING, "FastAGI connection to '%s' timed out after MAX_AGI_CONNECT (%d) milliseconds.\n",
2019  agiurl, MAX_AGI_CONNECT);
2020  } else {
2021  ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
2022  }
2023 
2024  return 1;
2025  }
2026  }
2027 
2028  if (getsockopt(pfds[0].fd, SOL_SOCKET, SO_ERROR, &conresult, &reslen) < 0) {
2029  ast_log(LOG_WARNING, "Connection to %s failed with error: %s\n",
2030  ast_sockaddr_stringify(&addr), strerror(errno));
2031  return 1;
2032  }
2033 
2034  if (conresult) {
2035  ast_log(LOG_WARNING, "Connecting to '%s' failed for url '%s': %s\n",
2036  ast_sockaddr_stringify(&addr), agiurl, strerror(conresult));
2037  return 1;
2038  }
2039 
2040  return 0;
2041 }
int errno
static char * ast_sockaddr_stringify(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() with default format.
Definition: netsock2.h:256
#define ast_poll(a, b, c)
Definition: poll-compat.h:88
#define MAX_AGI_CONNECT
Definition: res_agi.c:1397

References ast_log, ast_poll, ast_sockaddr_stringify(), errno, LOG_WARNING, and MAX_AGI_CONNECT.

◆ handle_controlstreamfile()

static int handle_controlstreamfile ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2487 of file res_agi.c.

2488 {
2489  int res = 0, skipms = 3000;
2490  const char *fwd = "#", *rev = "*", *suspend = NULL, *stop = NULL; /* Default values */
2491  char stopkeybuf[2];
2492  long offsetms = 0;
2493  char offsetbuf[20];
2494 
2495  if (argc < 5 || argc > 10) {
2496  return RESULT_SHOWUSAGE;
2497  }
2498 
2499  if (!ast_strlen_zero(argv[4])) {
2500  stop = argv[4];
2501  }
2502 
2503  if ((argc > 5) && (sscanf(argv[5], "%30d", &skipms) != 1)) {
2504  return RESULT_SHOWUSAGE;
2505  }
2506 
2507  if (argc > 6 && !ast_strlen_zero(argv[6])) {
2508  fwd = argv[6];
2509  }
2510 
2511  if (argc > 7 && !ast_strlen_zero(argv[7])) {
2512  rev = argv[7];
2513  }
2514 
2515  if (argc > 8 && !ast_strlen_zero(argv[8])) {
2516  suspend = argv[8];
2517  }
2518 
2519  if (argc > 9 && (sscanf(argv[9], "%30ld", &offsetms) != 1)) {
2520  return RESULT_SHOWUSAGE;
2521  }
2522 
2523  res = ast_control_streamfile(chan, argv[3], fwd, rev, stop, suspend, NULL, skipms, &offsetms);
2524 
2525  /* If we stopped on one of our stop keys, return 0 */
2526  if (res > 0 && stop && strchr(stop, res)) {
2527  pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "USERSTOPPED");
2528  snprintf(stopkeybuf, sizeof(stopkeybuf), "%c", res);
2529  pbx_builtin_setvar_helper(chan, "CPLAYBACKSTOPKEY", stopkeybuf);
2530  } else if (res > 0 && res == AST_CONTROL_STREAM_STOP) {
2531  pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "REMOTESTOPPED");
2532  res = 0;
2533  } else {
2534  if (res < 0) {
2535  pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "ERROR");
2536  } else {
2537  pbx_builtin_setvar_helper(chan, "CPLAYBACKSTATUS", "SUCCESS");
2538  }
2539  }
2540 
2541  snprintf(offsetbuf, sizeof(offsetbuf), "%ld", offsetms);
2542  pbx_builtin_setvar_helper(chan, "CPLAYBACKOFFSET", offsetbuf);
2543 
2544  ast_agi_send(agi->fd, chan, "200 result=%d endpos=%ld\n", res, offsetms);
2545 
2546  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2547 }
unsigned int stop
Definition: app_meetme.c:1098
static int skipms
static void suspend(struct cc_core_instance *core_instance)
Definition: ccss.c:3193
int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms)
Stream a file with fast forward, pause, reverse, restart.
Definition: main/app.c:1535
@ AST_CONTROL_STREAM_STOP

References ast_agi_send(), AST_CONTROL_STREAM_STOP, ast_control_streamfile(), ast_strlen_zero(), agi_state::fd, NULL, pbx_builtin_setvar_helper(), RESULT_FAILURE, RESULT_SHOWUSAGE, RESULT_SUCCESS, skipms, stop, and suspend().

◆ handle_dbdel()

static int handle_dbdel ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3326 of file res_agi.c.

3327 {
3328  int res;
3329 
3330  if (argc != 4)
3331  return RESULT_SHOWUSAGE;
3332  res = ast_db_del(argv[2], argv[3]);
3333  ast_agi_send(agi->fd, chan, "200 result=%c\n", res ? '0' : '1');
3334  return RESULT_SUCCESS;
3335 }
int ast_db_del(const char *family, const char *key)
Delete entry in astdb.
Definition: main/db.c:429

References ast_agi_send(), ast_db_del(), agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_dbdeltree()

static int handle_dbdeltree ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3337 of file res_agi.c.

3338 {
3339  int num_deleted;
3340 
3341  if ((argc < 3) || (argc > 4)) {
3342  return RESULT_SHOWUSAGE;
3343  }
3344  if (argc == 4) {
3345  num_deleted = ast_db_deltree(argv[2], argv[3]);
3346  } else {
3347  num_deleted = ast_db_deltree(argv[2], NULL);
3348  }
3349 
3350  ast_agi_send(agi->fd, chan, "200 result=%c\n", num_deleted > 0 ? '0' : '1');
3351  return RESULT_SUCCESS;
3352 }
int ast_db_deltree(const char *family, const char *keytree)
Delete one or more entries in astdb.
Definition: main/db.c:457

References ast_agi_send(), ast_db_deltree(), agi_state::fd, NULL, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_dbget()

static int handle_dbget ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3282 of file res_agi.c.

3283 {
3284  int res;
3285  struct ast_str *buf;
3286 
3287  if (argc != 4)
3288  return RESULT_SHOWUSAGE;
3289 
3290  if (!(buf = ast_str_create(16))) {
3291  ast_agi_send(agi->fd, chan, "200 result=-1\n");
3292  return RESULT_SUCCESS;
3293  }
3294 
3295  do {
3296  res = ast_db_get(argv[2], argv[3], ast_str_buffer(buf), ast_str_size(buf));
3298  if (ast_str_strlen(buf) < ast_str_size(buf) - 1) {
3299  break;
3300  }
3301  if (ast_str_make_space(&buf, ast_str_size(buf) * 2)) {
3302  break;
3303  }
3304  } while (1);
3305 
3306  if (res)
3307  ast_agi_send(agi->fd, chan, "200 result=0\n");
3308  else
3309  ast_agi_send(agi->fd, chan, "200 result=1 (%s)\n", ast_str_buffer(buf));
3310 
3311  ast_free(buf);
3312  return RESULT_SUCCESS;
3313 }
int ast_db_get(const char *family, const char *key, char *value, int valuelen)
Get key value specified by family/key.
Definition: main/db.c:412
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:640
#define ast_str_make_space(buf, new_len)
Definition: strings.h:806
void ast_str_update(struct ast_str *buf)
Update the length of the buffer, after using ast_str merely as a buffer.
Definition: strings.h:684
size_t ast_str_size(const struct ast_str *buf)
Returns the current maximum length (without reallocation) of the current buffer.
Definition: strings.h:723

References ast_agi_send(), ast_db_get(), ast_free, ast_str_buffer(), ast_str_create, ast_str_make_space, ast_str_size(), ast_str_strlen(), ast_str_update(), buf, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_dbput()

static int handle_dbput ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3315 of file res_agi.c.

3316 {
3317  int res;
3318 
3319  if (argc != 5)
3320  return RESULT_SHOWUSAGE;
3321  res = ast_db_put(argv[2], argv[3], argv[4]);
3322  ast_agi_send(agi->fd, chan, "200 result=%c\n", res ? '0' : '1');
3323  return RESULT_SUCCESS;
3324 }
int ast_db_put(const char *family, const char *key, const char *value)
Store value addressed by family/key.
Definition: main/db.c:327

References ast_agi_send(), ast_db_put(), agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_exec()

static int handle_exec ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3120 of file res_agi.c.

3121 {
3122  int res, workaround;
3123  struct ast_app *app_to_exec;
3124 
3125  if (argc < 2)
3126  return RESULT_SHOWUSAGE;
3127 
3128  ast_verb(3, "AGI Script Executing Application: (%s) Options: (%s)\n", argv[1], argc >= 3 ? argv[2] : "");
3129 
3130  if ((app_to_exec = pbx_findapp(argv[1]))) {
3131  ast_channel_lock(chan);
3132  if (!(workaround = ast_test_flag(ast_channel_flags(chan), AST_FLAG_DISABLE_WORKAROUNDS))) {
3134  }
3135  ast_channel_unlock(chan);
3136  res = pbx_exec(chan, app_to_exec, argc == 2 ? "" : argv[2]);
3137  if (!workaround) {
3139  }
3140  } else {
3141  ast_log(LOG_WARNING, "Could not find application (%s)\n", argv[1]);
3142  res = -2;
3143  }
3144  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
3145 
3146  /* Even though this is wrong, users are depending upon this result. */
3147  return res;
3148 }
void ast_channel_clear_flag(struct ast_channel *chan, unsigned int flag)
Clear a flag on a channel.
Definition: channel.c:11220
@ AST_FLAG_DISABLE_WORKAROUNDS
Definition: channel.h:1022
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int pbx_exec(struct ast_channel *c, struct ast_app *app, const char *data)
Execute an application.
Definition: pbx_app.c:471
struct ast_app * pbx_findapp(const char *app)
Look up an application.
Definition: ael_main.c:165
ast_app: A registered application
Definition: pbx_app.c:45
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define ast_set_flag(p, flag)
Definition: utils.h:70

References ast_agi_send(), ast_channel_clear_flag(), ast_channel_flags(), ast_channel_lock, ast_channel_unlock, AST_FLAG_DISABLE_WORKAROUNDS, ast_log, ast_set_flag, ast_test_flag, ast_verb, agi_state::fd, LOG_WARNING, pbx_exec(), pbx_findapp(), and RESULT_SHOWUSAGE.

◆ handle_getdata()

static int handle_getdata ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2826 of file res_agi.c.

2827 {
2828  int res, max, timeout;
2829  char data[1024];
2830 
2831  if (argc < 3)
2832  return RESULT_SHOWUSAGE;
2833  if (argc >= 4)
2834  timeout = atoi(argv[3]);
2835  else
2836  timeout = 0;
2837  if (argc >= 5)
2838  max = atoi(argv[4]);
2839  else
2840  max = 1024;
2841  res = ast_app_getdata_full(chan, argv[2], data, max, timeout, agi->audio, agi->ctrl);
2842  if (res == 2) /* New command */
2843  return RESULT_SUCCESS;
2844  else if (res == 1)
2845  ast_agi_send(agi->fd, chan, "200 result=%s (timeout)\n", data);
2846  else if (res < 0 )
2847  ast_agi_send(agi->fd, chan, "200 result=-1\n");
2848  else
2849  ast_agi_send(agi->fd, chan, "200 result=%s\n", data);
2850  return RESULT_SUCCESS;
2851 }
#define max(a, b)
Definition: f2c.h:198
int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd)
Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other fu...
Definition: main/app.c:247
int ctrl
Definition: agi.h:37
int audio
Definition: agi.h:36

References ast_agi_send(), ast_app_getdata_full(), agi_state::audio, agi_state::ctrl, agi_state::fd, max, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_getoption()

static int handle_getoption ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

get option - really similar to the handle_streamfile, but with a timeout

Definition at line 2608 of file res_agi.c.

2609 {
2610  int res;
2611  struct ast_filestream *fs, *vfs;
2612  long sample_offset = 0, max_length;
2613  int timeout = 0;
2614  const char *edigits = "";
2615 
2616  if ( argc < 4 || argc > 5 )
2617  return RESULT_SHOWUSAGE;
2618 
2619  if ( argv[3] )
2620  edigits = argv[3];
2621 
2622  if ( argc == 5 )
2623  timeout = atoi(argv[4]);
2624  else if (ast_channel_pbx(chan)->dtimeoutms) {
2625  /* by default dtimeout is set to 5sec */
2626  timeout = ast_channel_pbx(chan)->dtimeoutms; /* in msec */
2627  }
2628 
2629  if (!(fs = ast_openstream(chan, argv[2], ast_channel_language(chan)))) {
2630  ast_agi_send(agi->fd, chan, "200 result=-1 endpos=%ld\n", sample_offset);
2631  ast_log(LOG_WARNING, "Unable to open %s\n", argv[2]);
2632  return RESULT_FAILURE;
2633  }
2634 
2635  if ((vfs = ast_openvstream(chan, argv[2], ast_channel_language(chan))))
2636  ast_debug(1, "Ooh, found a video stream, too\n");
2637 
2638  ast_verb(3, "Playing '%s' (escape_digits=%s) (timeout %d)\n", argv[2], edigits, timeout);
2639 
2640  ast_seekstream(fs, 0, SEEK_END);
2641  max_length = ast_tellstream(fs);
2642  ast_seekstream(fs, sample_offset, SEEK_SET);
2643  res = ast_applystream(chan, fs);
2644  if (vfs)
2645  ast_applystream(chan, vfs);
2646  ast_playstream(fs);
2647  if (vfs)
2649 
2650  res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
2651  /* this is to check for if ast_waitstream closed the stream, we probably are at
2652  * the end of the stream, return that amount, else check for the amount */
2653  sample_offset = (ast_channel_stream(chan))?ast_tellstream(fs):max_length;
2654  ast_stopstream(chan);
2655  if (res == 1) {
2656  /* Stop this command, don't print a result line, as there is a new command */
2657  return RESULT_SUCCESS;
2658  }
2659 
2660  /* If the user didnt press a key, wait for digitTimeout*/
2661  if (res == 0 ) {
2662  res = ast_waitfordigit_full(chan, timeout, NULL, agi->audio, agi->ctrl);
2663  /* Make sure the new result is in the escape digits of the GET OPTION */
2664  if ( !strchr(edigits,res) )
2665  res=0;
2666  }
2667 
2668  ast_agi_send(agi->fd, chan, "200 result=%d endpos=%ld\n", res, sample_offset);
2669  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2670 }
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)
struct ast_pbx * ast_channel_pbx(const struct ast_channel *chan)
const char * ast_channel_language(const struct ast_channel *chan)
int ast_waitfordigit_full(struct ast_channel *c, int ms, const char *breakon, int audiofd, int ctrlfd)
Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to mon...
Definition: channel.c:3240
off_t ast_tellstream(struct ast_filestream *fs)
Tell where we are in a stream.
Definition: file.c:1083
int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd)
Definition: file.c:1826
int ast_stopstream(struct ast_channel *c)
Stops a stream.
Definition: file.c:222
int ast_seekstream(struct ast_filestream *fs, off_t sample_offset, int whence)
Seeks into stream.
Definition: file.c:1073
int ast_applystream(struct ast_channel *chan, struct ast_filestream *s)
Applies a open stream to a channel.
Definition: file.c:1055
int ast_playstream(struct ast_filestream *s)
Play a open stream on a channel.
Definition: file.c:1061
struct ast_filestream * ast_openstream(struct ast_channel *chan, const char *filename, const char *preflang)
Opens stream for use in seeking, playing.
Definition: file.c:790
struct ast_filestream * ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang)
Opens stream for use in seeking, playing.
Definition: file.c:847
This structure is allocated by file.c in one chunk, together with buf_size and desc_size bytes of mem...
Definition: mod_format.h:101
struct ast_filestream * vfs
Definition: mod_format.h:110
int dtimeoutms
Definition: pbx.h:215

References ast_agi_send(), ast_applystream(), ast_channel_language(), ast_channel_pbx(), ast_channel_stream(), ast_debug, ast_log, ast_openstream(), ast_openvstream(), ast_playstream(), ast_seekstream(), ast_stopstream(), ast_tellstream(), ast_verb, ast_waitfordigit_full(), ast_waitstream_full(), agi_state::audio, agi_state::ctrl, ast_pbx::dtimeoutms, agi_state::fd, LOG_WARNING, NULL, RESULT_FAILURE, RESULT_SHOWUSAGE, RESULT_SUCCESS, and ast_filestream::vfs.

◆ handle_getvariable()

static int handle_getvariable ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3208 of file res_agi.c.

3209 {
3210  char *ret;
3211  char tempstr[1024] = "";
3212 
3213  if (argc != 3)
3214  return RESULT_SHOWUSAGE;
3215 
3216  /* check if we want to execute an ast_custom_function */
3217  if (!ast_strlen_zero(argv[2]) && (argv[2][strlen(argv[2]) - 1] == ')')) {
3218  ret = ast_func_read(chan, argv[2], tempstr, sizeof(tempstr)) ? NULL : tempstr;
3219  } else {
3220  pbx_retrieve_variable(chan, argv[2], &ret, tempstr, sizeof(tempstr), NULL);
3221  }
3222 
3223  if (ret)
3224  ast_agi_send(agi->fd, chan, "200 result=1 (%s)\n", ret);
3225  else
3226  ast_agi_send(agi->fd, chan, "200 result=0\n");
3227 
3228  return RESULT_SUCCESS;
3229 }
int ast_func_read(struct ast_channel *chan, const char *function, char *workspace, size_t len)
executes a read operation on a function
void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp)
Retrieve the value of a builtin variable or variable from the channel variable stack.

References ast_agi_send(), ast_func_read(), ast_strlen_zero(), agi_state::fd, NULL, pbx_retrieve_variable(), RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_getvariablefull()

static int handle_getvariablefull ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3231 of file res_agi.c.

3232 {
3233  struct ast_channel *chan2 = NULL;
3234 
3235  if (argc != 4 && argc != 5) {
3236  return RESULT_SHOWUSAGE;
3237  }
3238 
3239  if (argc == 5) {
3240  chan2 = ast_channel_get_by_name(argv[4]);
3241  } else {
3242  chan2 = ast_channel_ref(chan);
3243  }
3244 
3245  if (chan2) {
3246  struct ast_str *str = ast_str_create(16);
3247  if (!str) {
3248  ast_agi_send(agi->fd, chan, "200 result=0\n");
3249  return RESULT_SUCCESS;
3250  }
3251  ast_str_substitute_variables(&str, 0, chan2, argv[3]);
3252  ast_agi_send(agi->fd, chan, "200 result=1 (%s)\n", ast_str_buffer(str));
3253  ast_free(str);
3254  } else {
3255  ast_agi_send(agi->fd, chan, "200 result=0\n");
3256  }
3257 
3258  if (chan2) {
3259  chan2 = ast_channel_unref(chan2);
3260  }
3261 
3262  return RESULT_SUCCESS;
3263 }
const char * str
Definition: app_jack.c:147
#define ast_channel_ref(c)
Increase channel reference count.
Definition: channel.h:2947
void ast_str_substitute_variables(struct ast_str **buf, ssize_t maxlen, struct ast_channel *chan, const char *templ)

References ast_agi_send(), ast_channel_get_by_name(), ast_channel_ref, ast_channel_unref, ast_free, ast_str_buffer(), ast_str_create, ast_str_substitute_variables(), agi_state::fd, NULL, RESULT_SHOWUSAGE, RESULT_SUCCESS, and str.

◆ handle_hangup()

static int handle_hangup ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3092 of file res_agi.c.

3093 {
3094  struct ast_channel *c;
3095 
3096  if (argc == 1) {
3097  /* no argument: hangup the current channel */
3098  ast_set_hangupsource(chan, "dialplan/agi", 0);
3100  ast_agi_send(agi->fd, chan, "200 result=1\n");
3101  return RESULT_SUCCESS;
3102  } else if (argc == 2) {
3103  /* one argument: look for info on the specified channel */
3104  if ((c = ast_channel_get_by_name(argv[1]))) {
3105  /* we have a matching channel */
3106  ast_set_hangupsource(c, "dialplan/agi", 0);
3108  c = ast_channel_unref(c);
3109  ast_agi_send(agi->fd, chan, "200 result=1\n");
3110  return RESULT_SUCCESS;
3111  }
3112  /* if we get this far no channel name matched the argument given */
3113  ast_agi_send(agi->fd, chan, "200 result=-1\n");
3114  return RESULT_SUCCESS;
3115  } else {
3116  return RESULT_SHOWUSAGE;
3117  }
3118 }
@ AST_SOFTHANGUP_EXPLICIT
Definition: channel.h:1148
void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force)
Set the source of the hangup in this channel and it's bridge.
Definition: channel.c:2498
int ast_softhangup(struct ast_channel *chan, int cause)
Softly hangup up a channel.
Definition: channel.c:2470

References ast_agi_send(), ast_channel_get_by_name(), ast_channel_unref, ast_set_hangupsource(), ast_softhangup(), AST_SOFTHANGUP_EXPLICIT, c, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_noop()

static int handle_noop ( struct ast_channel chan,
AGI agi,
int  arg,
const char *const  argv[] 
)
static

Definition at line 3383 of file res_agi.c.

3384 {
3385  ast_agi_send(agi->fd, chan, "200 result=0\n");
3386  return RESULT_SUCCESS;
3387 }

References ast_agi_send(), agi_state::fd, and RESULT_SUCCESS.

◆ handle_recordfile()

static int handle_recordfile ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2891 of file res_agi.c.

2892 {
2893  struct ast_filestream *fs;
2894  struct ast_frame *f;
2895  struct timeval start;
2896  long sample_offset = 0;
2897  int res = 0;
2898  int ms;
2899 
2900  struct ast_dsp *sildet=NULL; /* silence detector dsp */
2901  int totalsilence = 0;
2902  int dspsilence = 0;
2903  int silence = 0; /* amount of silence to allow */
2904  int gotsilence = 0; /* did we timeout for silence? */
2905  char *silencestr = NULL;
2906  RAII_VAR(struct ast_format *, rfmt, NULL, ao2_cleanup);
2907 
2908  /* XXX EAGI FIXME XXX */
2909 
2910  if (argc < 6)
2911  return RESULT_SHOWUSAGE;
2912  if (sscanf(argv[5], "%30d", &ms) != 1)
2913  return RESULT_SHOWUSAGE;
2914 
2915  if (argc > 6)
2916  silencestr = strchr(argv[6],'s');
2917  if ((argc > 7) && (!silencestr))
2918  silencestr = strchr(argv[7],'s');
2919  if ((argc > 8) && (!silencestr))
2920  silencestr = strchr(argv[8],'s');
2921 
2922  if (silencestr) {
2923  if (strlen(silencestr) > 2) {
2924  if ((silencestr[0] == 's') && (silencestr[1] == '=')) {
2925  silencestr++;
2926  silencestr++;
2927  if (silencestr)
2928  silence = atoi(silencestr);
2929  if (silence > 0)
2930  silence *= 1000;
2931  }
2932  }
2933  }
2934 
2935  if (silence > 0) {
2936  rfmt = ao2_bump(ast_channel_readformat(chan));
2937  res = ast_set_read_format(chan, ast_format_slin);
2938  if (res < 0) {
2939  ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
2940  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2941  return RESULT_FAILURE;
2942  }
2943  sildet = ast_dsp_new();
2944  if (!sildet) {
2945  ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
2946  ast_agi_send(agi->fd, chan, "200 result=-1\n");
2947  return RESULT_FAILURE;
2948  }
2950  }
2951 
2952  /* backward compatibility, if no offset given, arg[6] would have been
2953  * caught below and taken to be a beep, else if it is a digit then it is a
2954  * offset */
2955  if ((argc >6) && (sscanf(argv[6], "%30ld", &sample_offset) != 1) && (!strchr(argv[6], '=')))
2956  res = ast_streamfile(chan, "beep", ast_channel_language(chan));
2957 
2958  if ((argc > 7) && (!strchr(argv[7], '=')))
2959  res = ast_streamfile(chan, "beep", ast_channel_language(chan));
2960 
2961  if (!res)
2962  res = ast_waitstream(chan, argv[4]);
2963  if (res) {
2964  ast_agi_send(agi->fd, chan, "200 result=%d (randomerror) endpos=%ld\n", res, sample_offset);
2965  } else {
2966  fs = ast_writefile(argv[2], argv[3], NULL, O_CREAT | O_WRONLY | (sample_offset ? O_APPEND : 0), 0, AST_FILE_MODE);
2967  if (!fs) {
2968  res = -1;
2969  ast_agi_send(agi->fd, chan, "200 result=%d (writefile)\n", res);
2970  if (sildet)
2971  ast_dsp_free(sildet);
2972  return RESULT_FAILURE;
2973  }
2974 
2975  /* Request a video update */
2977 
2978  ast_channel_stream_set(chan, fs);
2979  ast_applystream(chan,fs);
2980  /* really should have checks */
2981  ast_seekstream(fs, sample_offset, SEEK_SET);
2982  ast_truncstream(fs);
2983 
2984  start = ast_tvnow();
2985  while ((ms < 0) || ast_tvdiff_ms(ast_tvnow(), start) < ms) {
2986  res = ast_waitfor(chan, ms - ast_tvdiff_ms(ast_tvnow(), start));
2987  if (res < 0) {
2988  ast_closestream(fs);
2989  ast_agi_send(agi->fd, chan, "200 result=%d (waitfor) endpos=%ld\n", res,sample_offset);
2990  if (sildet)
2991  ast_dsp_free(sildet);
2992  return RESULT_FAILURE;
2993  }
2994  f = ast_read(chan);
2995  if (!f) {
2996  ast_closestream(fs);
2997  ast_agi_send(agi->fd, chan, "200 result=%d (hangup) endpos=%ld\n", -1, sample_offset);
2998  if (sildet)
2999  ast_dsp_free(sildet);
3000  return RESULT_FAILURE;
3001  }
3002  switch(f->frametype) {
3003  case AST_FRAME_DTMF:
3004  if (strchr(argv[4], f->subclass.integer)) {
3005  /* This is an interrupting character, so rewind to chop off any small
3006  amount of DTMF that may have been recorded
3007  */
3008  ast_stream_rewind(fs, 200);
3009  ast_truncstream(fs);
3010  sample_offset = ast_tellstream(fs);
3011  ast_closestream(fs);
3012  ast_agi_send(agi->fd, chan, "200 result=%d (dtmf) endpos=%ld\n", f->subclass.integer, sample_offset);
3013  ast_frfree(f);
3014  if (sildet)
3015  ast_dsp_free(sildet);
3016  return RESULT_SUCCESS;
3017  }
3018  break;
3019  case AST_FRAME_VOICE:
3020  ast_writestream(fs, f);
3021  /* this is a safe place to check progress since we know that fs
3022  * is valid after a write, and it will then have our current
3023  * location */
3024  sample_offset = ast_tellstream(fs);
3025  if (silence > 0) {
3026  dspsilence = 0;
3027  ast_dsp_silence(sildet, f, &dspsilence);
3028  if (dspsilence) {
3029  totalsilence = dspsilence;
3030  } else {
3031  totalsilence = 0;
3032  }
3033  if (totalsilence > silence) {
3034  /* Ended happily with silence */
3035  gotsilence = 1;
3036  break;
3037  }
3038  }
3039  break;
3040  case AST_FRAME_VIDEO:
3041  ast_writestream(fs, f);
3042  default:
3043  /* Ignore all other frames */
3044  break;
3045  }
3046  ast_frfree(f);
3047  if (gotsilence)
3048  break;
3049  }
3050 
3051  if (gotsilence) {
3052  ast_stream_rewind(fs, silence-1000);
3053  ast_truncstream(fs);
3054  sample_offset = ast_tellstream(fs);
3055  }
3056  ast_closestream(fs);
3057  ast_agi_send(agi->fd, chan, "200 result=%d (timeout) endpos=%ld\n", res, sample_offset);
3058  }
3059 
3060  if (silence > 0) {
3061  res = ast_set_read_format(chan, rfmt);
3062  if (res)
3063  ast_log(LOG_WARNING, "Unable to restore read format on '%s'\n", ast_channel_name(chan));
3064  ast_dsp_free(sildet);
3065  }
3066 
3067  return RESULT_SUCCESS;
3068 }
#define AST_FILE_MODE
Definition: asterisk.h:32
void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value)
int ast_waitfor(struct ast_channel *chan, int ms)
Wait for input on a channel.
Definition: channel.c:3163
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition: channel.c:4312
void ast_dsp_set_threshold(struct ast_dsp *dsp, int threshold)
Set the minimum average magnitude threshold to determine talking by the DSP.
Definition: dsp.c:1778
void ast_dsp_free(struct ast_dsp *dsp)
Definition: dsp.c:1773
struct ast_dsp * ast_dsp_new(void)
Allocates a new dsp, assumes 8khz for internal sample rate.
Definition: dsp.c:1748
@ THRESHOLD_SILENCE
Definition: dsp.h:73
int ast_dsp_silence(struct ast_dsp *dsp, struct ast_frame *f, int *totalsilence)
Process the audio frame for silence.
Definition: dsp.c:1486
int ast_dsp_get_threshold_from_settings(enum threshold which)
Get silence threshold from dsp.conf.
Definition: dsp.c:1999
int ast_writestream(struct ast_filestream *fs, struct ast_frame *f)
Writes a frame to a stream.
Definition: file.c:244
int ast_stream_rewind(struct ast_filestream *fs, off_t ms)
Rewind stream ms.
Definition: file.c:1098
int ast_streamfile(struct ast_channel *c, const char *filename, const char *preflang)
Streams a file.
Definition: file.c:1291
struct ast_filestream * ast_writefile(const char *filename, const char *type, const char *comment, int flags, int check, mode_t mode)
Starts writing a file.
Definition: file.c:1402
int ast_truncstream(struct ast_filestream *fs)
Trunc stream at current location.
Definition: file.c:1078
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition: file.c:1109
int ast_waitstream(struct ast_channel *c, const char *breakon)
Waits for a stream to stop or digit to be pressed.
Definition: file.c:1817
#define AST_FRAME_DTMF
@ AST_FRAME_VIDEO
@ AST_FRAME_VOICE
@ AST_CONTROL_VIDUPDATE
Definition: dsp.c:407
int totalsilence
Definition: dsp.c:411
struct ast_frame f
Definition: dsp.c:408
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:105
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:157

References ao2_bump, ao2_cleanup, ast_agi_send(), ast_applystream(), ast_channel_language(), ast_channel_name(), ast_channel_readformat(), ast_channel_stream_set(), ast_closestream(), AST_CONTROL_VIDUPDATE, ast_dsp_free(), ast_dsp_get_threshold_from_settings(), ast_dsp_new(), ast_dsp_set_threshold(), ast_dsp_silence(), AST_FILE_MODE, ast_format_slin, AST_FRAME_DTMF, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_indicate(), ast_log, ast_read(), ast_seekstream(), ast_set_read_format(), ast_stream_rewind(), ast_streamfile(), ast_tellstream(), ast_truncstream(), ast_tvdiff_ms(), ast_tvnow(), ast_waitfor(), ast_waitstream(), ast_writefile(), ast_writestream(), ast_dsp::f, agi_state::fd, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, NULL, RAII_VAR, RESULT_FAILURE, RESULT_SHOWUSAGE, RESULT_SUCCESS, ast_frame::subclass, THRESHOLD_SILENCE, and ast_dsp::totalsilence.

◆ handle_recvchar()

static int handle_recvchar ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2406 of file res_agi.c.

2407 {
2408  int res;
2409 
2410  if (argc != 3)
2411  return RESULT_SHOWUSAGE;
2412 
2413  res = ast_recvchar(chan,atoi(argv[2]));
2414  if (res == 0) {
2415  ast_agi_send(agi->fd, chan, "200 result=%d (timeout)\n", res);
2416  return RESULT_SUCCESS;
2417  }
2418  if (res > 0) {
2419  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2420  return RESULT_SUCCESS;
2421  }
2422  ast_agi_send(agi->fd, chan, "200 result=%d (hangup)\n", res);
2423  return RESULT_FAILURE;
2424 }
int ast_recvchar(struct ast_channel *chan, int timeout)
Receives a text character from a channel.
Definition: channel.c:4741

References ast_agi_send(), ast_recvchar(), agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_recvtext()

static int handle_recvtext ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2426 of file res_agi.c.

2427 {
2428  char *buf;
2429 
2430  if (argc != 3)
2431  return RESULT_SHOWUSAGE;
2432 
2433  buf = ast_recvtext(chan, atoi(argv[2]));
2434  if (buf) {
2435  ast_agi_send(agi->fd, chan, "200 result=1 (%s)\n", buf);
2436  ast_free(buf);
2437  } else {
2438  ast_agi_send(agi->fd, chan, "200 result=-1\n");
2439  }
2440  return RESULT_SUCCESS;
2441 }
char * ast_recvtext(struct ast_channel *chan, int timeout)
Receives a text string from a channel Read a string of text from a channel.
Definition: channel.c:4752

References ast_agi_send(), ast_free, ast_recvtext(), buf, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_sayalpha()

static int handle_sayalpha ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2708 of file res_agi.c.

2709 {
2710  int res;
2711  int sensitivity = AST_SAY_CASE_NONE;
2712 
2713  if (argc < 4 || argc > 5) {
2714  return RESULT_SHOWUSAGE;
2715  }
2716 
2717  if (argc > 4) {
2718  switch (argv[4][0]) {
2719  case 'a':
2720  case 'A':
2721  sensitivity = AST_SAY_CASE_ALL;
2722  break;
2723  case 'l':
2724  case 'L':
2725  sensitivity = AST_SAY_CASE_LOWER;
2726  break;
2727  case 'n':
2728  case 'N':
2729  sensitivity = AST_SAY_CASE_NONE;
2730  break;
2731  case 'u':
2732  case 'U':
2733  sensitivity = AST_SAY_CASE_UPPER;
2734  break;
2735  case '\0':
2736  break;
2737  default:
2738  return RESULT_SHOWUSAGE;
2739  }
2740  }
2741  res = ast_say_character_str_full(chan, argv[2], argv[3], ast_channel_language(chan), sensitivity, agi->audio, agi->ctrl);
2742  if (res == 1) /* New command */
2743  return RESULT_SUCCESS;
2744  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2745  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2746 }
SAY_EXTERN int(* ast_say_character_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, enum ast_say_case_sensitivity sensitivity, int audiofd, int ctrlfd) SAY_INIT(ast_say_character_str_full)
Definition: say.h:194
@ AST_SAY_CASE_LOWER
Definition: say.h:183
@ AST_SAY_CASE_ALL
Definition: say.h:185
@ AST_SAY_CASE_UPPER
Definition: say.h:184
@ AST_SAY_CASE_NONE
Definition: say.h:182

References ast_agi_send(), ast_channel_language(), AST_SAY_CASE_ALL, AST_SAY_CASE_LOWER, AST_SAY_CASE_NONE, AST_SAY_CASE_UPPER, ast_say_character_str_full, agi_state::audio, agi_state::ctrl, agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_saydate()

static int handle_saydate ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2748 of file res_agi.c.

2749 {
2750  int res, num;
2751 
2752  if (argc != 4)
2753  return RESULT_SHOWUSAGE;
2754  if (sscanf(argv[2], "%30d", &num) != 1)
2755  return RESULT_SHOWUSAGE;
2756  res = ast_say_date(chan, num, argv[3], ast_channel_language(chan));
2757  if (res == 1)
2758  return RESULT_SUCCESS;
2759  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2760  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2761 }
SAY_EXTERN int(* ast_say_date)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_date)
Definition: say.h:204

References ast_agi_send(), ast_channel_language(), ast_say_date, agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_saydatetime()

static int handle_saydatetime ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2778 of file res_agi.c.

2779 {
2780  int res = 0;
2781  time_t unixtime;
2782  const char *format, *zone = NULL;
2783 
2784  if (argc < 4)
2785  return RESULT_SHOWUSAGE;
2786 
2787  if (argc > 4) {
2788  format = argv[4];
2789  } else {
2790  /* XXX this doesn't belong here, but in the 'say' module */
2791  if (!strcasecmp(ast_channel_language(chan), "de")) {
2792  format = "A dBY HMS";
2793  } else {
2794  format = "ABdY 'digits/at' IMp";
2795  }
2796  }
2797 
2798  if (argc > 5 && !ast_strlen_zero(argv[5]))
2799  zone = argv[5];
2800 
2801  if (ast_get_time_t(argv[2], &unixtime, 0, NULL))
2802  return RESULT_SHOWUSAGE;
2803 
2804  res = ast_say_date_with_format(chan, unixtime, argv[3], ast_channel_language(chan), format, zone);
2805  if (res == 1)
2806  return RESULT_SUCCESS;
2807 
2808  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2809  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2810 }
static snd_pcm_format_t format
Definition: chan_alsa.c:106
SAY_EXTERN int(* ast_say_date_with_format)(struct ast_channel *chan, time_t t, const char *ints, const char *lang, const char *format, const char *timezone) SAY_INIT(ast_say_date_with_format)
Definition: say.h:208
int ast_get_time_t(const char *src, time_t *dst, time_t _default, int *consumed)
Parse a time (integer) string.
Definition: main/utils.c:2344

References ast_agi_send(), ast_channel_language(), ast_get_time_t(), ast_say_date_with_format, ast_strlen_zero(), agi_state::fd, format, NULL, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_saydigits()

static int handle_saydigits ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2692 of file res_agi.c.

2693 {
2694  int res, num;
2695 
2696  if (argc != 4)
2697  return RESULT_SHOWUSAGE;
2698  if (sscanf(argv[2], "%30d", &num) != 1)
2699  return RESULT_SHOWUSAGE;
2700 
2701  res = ast_say_digit_str_full(chan, argv[2], argv[3], ast_channel_language(chan), agi->audio, agi->ctrl);
2702  if (res == 1) /* New command */
2703  return RESULT_SUCCESS;
2704  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2705  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2706 }
SAY_EXTERN int(* ast_say_digit_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_digit_str_full)
Same as ast_say_digit_str() with audiofd for received audio and returns 1 on ctrlfd being readable.
Definition: say.h:162

References ast_agi_send(), ast_channel_language(), ast_say_digit_str_full, agi_state::audio, agi_state::ctrl, agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_saynumber()

static int handle_saynumber ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Say number in various language syntaxes.

Definition at line 2677 of file res_agi.c.

2678 {
2679  int res, num;
2680 
2681  if (argc < 4 || argc > 5)
2682  return RESULT_SHOWUSAGE;
2683  if (sscanf(argv[2], "%30d", &num) != 1)
2684  return RESULT_SHOWUSAGE;
2685  res = ast_say_number_full(chan, num, argv[3], ast_channel_language(chan), argc > 4 ? argv[4] : NULL, agi->audio, agi->ctrl);
2686  if (res == 1)
2687  return RESULT_SUCCESS;
2688  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2689  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2690 }
SAY_EXTERN int(* ast_say_number_full)(struct ast_channel *chan, int num, const char *ints, const char *lang, const char *options, int audiofd, int ctrlfd) SAY_INIT(ast_say_number_full)
Same as ast_say_number() with audiofd for received audio and returns 1 on ctrlfd being readable.
Definition: say.h:86

References ast_agi_send(), ast_channel_language(), ast_say_number_full, agi_state::audio, agi_state::ctrl, agi_state::fd, NULL, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_sayphonetic()

static int handle_sayphonetic ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2812 of file res_agi.c.

2813 {
2814  int res;
2815 
2816  if (argc != 4)
2817  return RESULT_SHOWUSAGE;
2818 
2819  res = ast_say_phonetic_str_full(chan, argv[2], argv[3], ast_channel_language(chan), agi->audio, agi->ctrl);
2820  if (res == 1) /* New command */
2821  return RESULT_SUCCESS;
2822  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2823  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2824 }
SAY_EXTERN int(* ast_say_phonetic_str_full)(struct ast_channel *chan, const char *num, const char *ints, const char *lang, int audiofd, int ctrlfd) SAY_INIT(ast_say_phonetic_str_full)
Definition: say.h:199

References ast_agi_send(), ast_channel_language(), ast_say_phonetic_str_full, agi_state::audio, agi_state::ctrl, agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_saytime()

static int handle_saytime ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2763 of file res_agi.c.

2764 {
2765  int res, num;
2766 
2767  if (argc != 4)
2768  return RESULT_SHOWUSAGE;
2769  if (sscanf(argv[2], "%30d", &num) != 1)
2770  return RESULT_SHOWUSAGE;
2771  res = ast_say_time(chan, num, argv[3], ast_channel_language(chan));
2772  if (res == 1)
2773  return RESULT_SUCCESS;
2774  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2775  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2776 }
SAY_EXTERN int(* ast_say_time)(struct ast_channel *chan, time_t t, const char *ints, const char *lang) SAY_INIT(ast_say_time)
Definition: say.h:202

References ast_agi_send(), ast_channel_language(), ast_say_time, agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_sendimage()

static int handle_sendimage ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2471 of file res_agi.c.

2472 {
2473  int res;
2474 
2475  if (argc != 3) {
2476  return RESULT_SHOWUSAGE;
2477  }
2478 
2479  res = ast_send_image(chan, argv[2]);
2480  if (!ast_check_hangup(chan)) {
2481  res = 0;
2482  }
2483  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2484  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2485 }
int ast_send_image(struct ast_channel *chan, const char *filename)
Sends an image.
Definition: image.c:158

References ast_agi_send(), ast_check_hangup(), ast_send_image(), agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_sendtext()

static int handle_sendtext ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2387 of file res_agi.c.

2388 {
2389  int res;
2390 
2391  if (argc != 3)
2392  return RESULT_SHOWUSAGE;
2393 
2394  /* At the moment, the parser (perhaps broken) returns with
2395  the last argument PLUS the newline at the end of the input
2396  buffer. This probably needs to be fixed, but I wont do that
2397  because other stuff may break as a result. The right way
2398  would probably be to strip off the trailing newline before
2399  parsing, then here, add a newline at the end of the string
2400  before sending it to ast_sendtext --DUDE */
2401  res = ast_sendtext(chan, argv[2]);
2402  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2403  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2404 }
int ast_sendtext(struct ast_channel *chan, const char *text)
Sends text to a channel.
Definition: channel.c:4844

References ast_agi_send(), ast_sendtext(), agi_state::fd, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_setcallerid()

static int handle_setcallerid ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3150 of file res_agi.c.

3151 {
3152  char tmp[256]="";
3153  char *l = NULL, *n = NULL;
3154 
3155  if (argv[2]) {
3156  ast_copy_string(tmp, argv[2], sizeof(tmp));
3157  ast_callerid_parse(tmp, &n, &l);
3158  if (l)
3160  else
3161  l = "";
3162  if (!n)
3163  n = "";
3164  ast_set_callerid(chan, l, n, NULL);
3165  }
3166 
3167  ast_agi_send(agi->fd, chan, "200 result=1\n");
3168  return RESULT_SUCCESS;
3169 }
static int tmp()
Definition: bt_open.c:389
int ast_callerid_parse(char *instr, char **name, char **location)
Destructively parse inbuf into name and location (or number)
Definition: callerid.c:1008
void ast_shrink_phone_number(char *n)
Shrink a phone number in place to just digits (more accurately it just removes ()'s,...
Definition: callerid.c:947
void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani)
Set caller ID number, name and ANI and generate AMI event.
Definition: channel.c:7417
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:406

References ast_agi_send(), ast_callerid_parse(), ast_copy_string(), ast_set_callerid(), ast_shrink_phone_number(), agi_state::fd, NULL, RESULT_SUCCESS, and tmp().

◆ handle_setcontext()

static int handle_setcontext ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2853 of file res_agi.c.

2854 {
2855 
2856  if (argc != 3)
2857  return RESULT_SHOWUSAGE;
2858  ast_channel_context_set(chan, argv[2]);
2859  ast_agi_send(agi->fd, chan, "200 result=0\n");
2860  return RESULT_SUCCESS;
2861 }
void ast_channel_context_set(struct ast_channel *chan, const char *value)

References ast_agi_send(), ast_channel_context_set(), agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_setextension()

static int handle_setextension ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2863 of file res_agi.c.

2864 {
2865  if (argc != 3)
2866  return RESULT_SHOWUSAGE;
2867  ast_channel_exten_set(chan, argv[2]);
2868  ast_agi_send(agi->fd, chan, "200 result=0\n");
2869  return RESULT_SUCCESS;
2870 }
void ast_channel_exten_set(struct ast_channel *chan, const char *value)

References ast_agi_send(), ast_channel_exten_set(), agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_setmusic()

static int handle_setmusic ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3389 of file res_agi.c.

3390 {
3391  if (argc < 3) {
3392  return RESULT_SHOWUSAGE;
3393  }
3394  if (!strncasecmp(argv[2], "on", 2))
3395  ast_moh_start(chan, argc > 3 ? argv[3] : NULL, NULL);
3396  else if (!strncasecmp(argv[2], "off", 3))
3397  ast_moh_stop(chan);
3398  ast_agi_send(agi->fd, chan, "200 result=0\n");
3399  return RESULT_SUCCESS;
3400 }
int ast_moh_start(struct ast_channel *chan, const char *mclass, const char *interpclass)
Turn on music on hold on a given channel.
Definition: channel.c:7849
void ast_moh_stop(struct ast_channel *chan)
Turn off music on hold on a given channel.
Definition: channel.c:7859

References ast_agi_send(), ast_moh_start(), ast_moh_stop(), agi_state::fd, NULL, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_setpriority()

static int handle_setpriority ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2872 of file res_agi.c.

2873 {
2874  int pri;
2875 
2876  if (argc != 3)
2877  return RESULT_SHOWUSAGE;
2878 
2879  if (sscanf(argv[2], "%30d", &pri) != 1) {
2880  pri = ast_findlabel_extension(chan, ast_channel_context(chan), ast_channel_exten(chan), argv[2],
2881  S_COR(ast_channel_caller(chan)->id.number.valid, ast_channel_caller(chan)->id.number.str, NULL));
2882  if (pri < 1)
2883  return RESULT_SHOWUSAGE;
2884  }
2885 
2886  ast_explicit_goto(chan, NULL, NULL, pri);
2887  ast_agi_send(agi->fd, chan, "200 result=0\n");
2888  return RESULT_SUCCESS;
2889 }
const char * ast_channel_context(const struct ast_channel *chan)
const char * ast_channel_exten(const struct ast_channel *chan)
struct ast_party_caller * ast_channel_caller(struct ast_channel *chan)
int ast_findlabel_extension(struct ast_channel *c, const char *context, const char *exten, const char *label, const char *callerid)
Find the priority of an extension that has the specified label.
Definition: pbx.c:4187
int ast_explicit_goto(struct ast_channel *chan, const char *context, const char *exten, int priority)
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition: strings.h:87
Number structure.
Definition: app_followme.c:154

References ast_agi_send(), ast_channel_caller(), ast_channel_context(), ast_channel_exten(), ast_explicit_goto(), ast_findlabel_extension(), agi_state::fd, NULL, RESULT_SHOWUSAGE, RESULT_SUCCESS, and S_COR.

◆ handle_setvariable()

static int handle_setvariable ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3195 of file res_agi.c.

3196 {
3197  if (argc != 4) {
3198  return RESULT_SHOWUSAGE;
3199  }
3200 
3201  if (argv[3])
3202  pbx_builtin_setvar_helper(chan, argv[2], argv[3]);
3203 
3204  ast_agi_send(agi->fd, chan, "200 result=1\n");
3205  return RESULT_SUCCESS;
3206 }

References ast_agi_send(), agi_state::fd, pbx_builtin_setvar_helper(), RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_speechactivategrammar()

static int handle_speechactivategrammar ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3493 of file res_agi.c.

3494 {
3495  if (argc != 4)
3496  return RESULT_SHOWUSAGE;
3497 
3498  if (!agi->speech) {
3499  ast_agi_send(agi->fd, chan, "200 result=0\n");
3500  return RESULT_SUCCESS;
3501  }
3502 
3503  if (ast_speech_grammar_activate(agi->speech, argv[3]))
3504  ast_agi_send(agi->fd, chan, "200 result=0\n");
3505  else
3506  ast_agi_send(agi->fd, chan, "200 result=1\n");
3507 
3508  return RESULT_SUCCESS;
3509 }
int ast_speech_grammar_activate(struct ast_speech *speech, const char *grammar_name)
Activate a grammar on a speech structure.
Definition: res_speech.c:65
struct ast_speech * speech
Definition: agi.h:39

References ast_agi_send(), ast_speech_grammar_activate(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechcreate()

static int handle_speechcreate ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3402 of file res_agi.c.

3403 {
3404  struct ast_format_cap *cap;
3405 
3406  /* If a structure already exists, return an error */
3407  if (agi->speech) {
3408  ast_agi_send(agi->fd, chan, "200 result=0\n");
3409  return RESULT_SUCCESS;
3410  }
3411 
3413  return RESULT_FAILURE;
3414  }
3416  if ((agi->speech = ast_speech_new(argv[2], cap))) {
3417  ast_agi_send(agi->fd, chan, "200 result=1\n");
3418  } else {
3419  ast_agi_send(agi->fd, chan, "200 result=0\n");
3420  }
3421  ao2_ref(cap, -1);
3422 
3423  return RESULT_SUCCESS;
3424 }
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition: format_cap.h:38
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition: format_cap.h:99
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition: format_cap.h:49
struct ast_speech * ast_speech_new(const char *engine_name, const struct ast_format_cap *formats)
Create a new speech structure.
Definition: res_speech.c:180
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54

References ao2_ref, ast_agi_send(), ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, ast_format_slin, ast_speech_new(), agi_state::fd, RESULT_FAILURE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechdeactivategrammar()

static int handle_speechdeactivategrammar ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3511 of file res_agi.c.

3512 {
3513  if (argc != 4)
3514  return RESULT_SHOWUSAGE;
3515 
3516  if (!agi->speech) {
3517  ast_agi_send(agi->fd, chan, "200 result=0\n");
3518  return RESULT_SUCCESS;
3519  }
3520 
3521  if (ast_speech_grammar_deactivate(agi->speech, argv[3]))
3522  ast_agi_send(agi->fd, chan, "200 result=0\n");
3523  else
3524  ast_agi_send(agi->fd, chan, "200 result=1\n");
3525 
3526  return RESULT_SUCCESS;
3527 }
int ast_speech_grammar_deactivate(struct ast_speech *speech, const char *grammar_name)
Deactivate a grammar on a speech structure.
Definition: res_speech.c:71

References ast_agi_send(), ast_speech_grammar_deactivate(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechdestroy()

static int handle_speechdestroy ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3444 of file res_agi.c.

3445 {
3446  if (agi->speech) {
3447  ast_speech_destroy(agi->speech);
3448  agi->speech = NULL;
3449  ast_agi_send(agi->fd, chan, "200 result=1\n");
3450  } else {
3451  ast_agi_send(agi->fd, chan, "200 result=0\n");
3452  }
3453 
3454  return RESULT_SUCCESS;
3455 }
int ast_speech_destroy(struct ast_speech *speech)
Destroy a speech structure.
Definition: res_speech.c:240

References ast_agi_send(), ast_speech_destroy(), agi_state::fd, NULL, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechloadgrammar()

static int handle_speechloadgrammar ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3457 of file res_agi.c.

3458 {
3459  if (argc != 5)
3460  return RESULT_SHOWUSAGE;
3461 
3462  if (!agi->speech) {
3463  ast_agi_send(agi->fd, chan, "200 result=0\n");
3464  return RESULT_SUCCESS;
3465  }
3466 
3467  if (ast_speech_grammar_load(agi->speech, argv[3], argv[4]))
3468  ast_agi_send(agi->fd, chan, "200 result=0\n");
3469  else
3470  ast_agi_send(agi->fd, chan, "200 result=1\n");
3471 
3472  return RESULT_SUCCESS;
3473 }
int ast_speech_grammar_load(struct ast_speech *speech, const char *grammar_name, const char *grammar)
Load a grammar on a speech structure (not globally)
Definition: res_speech.c:77

References ast_agi_send(), ast_speech_grammar_load(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechrecognize()

static int handle_speechrecognize ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3548 of file res_agi.c.

3549 {
3550  struct ast_speech *speech = agi->speech;
3551  const char *prompt;
3552  char dtmf = 0, tmp[4096] = "", *buf = tmp;
3553  int timeout = 0, offset = 0, res = 0, i = 0;
3554  long current_offset = 0;
3555  const char *reason = NULL;
3556  struct ast_frame *fr = NULL;
3557  struct ast_speech_result *result = NULL;
3558  size_t left = sizeof(tmp);
3559  time_t start = 0, current;
3560 
3561  if (argc < 4)
3562  return RESULT_SHOWUSAGE;
3563 
3564  if (!speech) {
3565  ast_agi_send(agi->fd, chan, "200 result=0\n");
3566  return RESULT_SUCCESS;
3567  }
3568 
3569  prompt = argv[2];
3570  timeout = atoi(argv[3]);
3571 
3572  /* If offset is specified then convert from text to integer */
3573  if (argc == 5)
3574  offset = atoi(argv[4]);
3575 
3576  /* We want frames coming in signed linear */
3577  if (ast_set_read_format(chan, ast_format_slin)) {
3578  ast_agi_send(agi->fd, chan, "200 result=0\n");
3579  return RESULT_SUCCESS;
3580  }
3581 
3582  /* Setup speech structure */
3583  if (speech->state == AST_SPEECH_STATE_NOT_READY || speech->state == AST_SPEECH_STATE_DONE) {
3585  ast_speech_start(speech);
3586  }
3587 
3588  /* Start playing prompt */
3589  speech_streamfile(chan, prompt, ast_channel_language(chan), offset);
3590 
3591  /* Go into loop reading in frames, passing to speech thingy, checking for hangup, all that jazz */
3592  while (ast_strlen_zero(reason)) {
3593  /* Run scheduled items */
3595 
3596  /* See maximum time of waiting */
3597  if ((res = ast_sched_wait(ast_channel_sched(chan))) < 0)
3598  res = 1000;
3599 
3600  /* Wait for frame */
3601  if (ast_waitfor(chan, res) > 0) {
3602  if (!(fr = ast_read(chan))) {
3603  reason = "hangup";
3604  break;
3605  }
3606  }
3607 
3608  /* Perform timeout check */
3609  if ((timeout > 0) && (start > 0)) {
3610  time(&current);
3611  if ((current - start) >= timeout) {
3612  reason = "timeout";
3613  if (fr)
3614  ast_frfree(fr);
3615  break;
3616  }
3617  }
3618 
3619  /* Check the speech structure for any changes */
3620  ast_mutex_lock(&speech->lock);
3621 
3622  /* See if we need to quiet the audio stream playback */
3623  if (ast_test_flag(speech, AST_SPEECH_QUIET) && ast_channel_stream(chan)) {
3624  current_offset = ast_tellstream(ast_channel_stream(chan));
3625  ast_stopstream(chan);
3627  }
3628 
3629  /* Check each state */
3630  switch (speech->state) {
3632  /* If the stream is done, start timeout calculation */
3633  if ((timeout > 0) && start == 0 && ((!ast_channel_stream(chan)) || (ast_channel_streamid(chan) == -1 && ast_channel_timingfunc(chan) == NULL))) {
3634  ast_stopstream(chan);
3635  time(&start);
3636  }
3637  /* Write audio frame data into speech engine if possible */
3638  if (fr && fr->frametype == AST_FRAME_VOICE)
3639  ast_speech_write(speech, fr->data.ptr, fr->datalen);
3640  break;
3641  case AST_SPEECH_STATE_WAIT:
3642  /* Cue waiting sound if not already playing */
3643  if ((!ast_channel_stream(chan)) || (ast_channel_streamid(chan) == -1 && ast_channel_timingfunc(chan) == NULL)) {
3644  ast_stopstream(chan);
3645  /* If a processing sound exists, or is not none - play it */
3646  if (!ast_strlen_zero(speech->processing_sound) && strcasecmp(speech->processing_sound, "none"))
3647  speech_streamfile(chan, speech->processing_sound, ast_channel_language(chan), 0);
3648  }
3649  break;
3650  case AST_SPEECH_STATE_DONE:
3651  /* Get the results */
3652  speech->results = ast_speech_results_get(speech);
3653  /* Change state to not ready */
3655  reason = "speech";
3656  break;
3657  default:
3658  break;
3659  }
3660  ast_mutex_unlock(&speech->lock);
3661 
3662  /* Check frame for DTMF or hangup */
3663  if (fr) {
3664  if (fr->frametype == AST_FRAME_DTMF) {
3665  reason = "dtmf";
3666  dtmf = fr->subclass.integer;
3667  } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass.integer == AST_CONTROL_HANGUP) {
3668  reason = "hangup";
3669  }
3670  ast_frfree(fr);
3671  }
3672  }
3673 
3674  if (!strcasecmp(reason, "speech")) {
3675  /* Build string containing speech results */
3676  for (result = speech->results; result; result = AST_LIST_NEXT(result, list)) {
3677  /* Build result string */
3678  ast_build_string(&buf, &left, "%sscore%d=%d text%d=\"%s\" grammar%d=%s", (i > 0 ? " " : ""), i, result->score, i, result->text, i, result->grammar);
3679  /* Increment result count */
3680  i++;
3681  }
3682  /* Print out */
3683  ast_agi_send(agi->fd, chan, "200 result=1 (speech) endpos=%ld results=%d %s\n", current_offset, i, tmp);
3684  } else if (!strcasecmp(reason, "dtmf")) {
3685  ast_agi_send(agi->fd, chan, "200 result=1 (digit) digit=%c endpos=%ld\n", dtmf, current_offset);
3686  } else if (!strcasecmp(reason, "hangup") || !strcasecmp(reason, "timeout")) {
3687  ast_agi_send(agi->fd, chan, "200 result=1 (%s) endpos=%ld\n", reason, current_offset);
3688  } else {
3689  ast_agi_send(agi->fd, chan, "200 result=0 endpos=%ld\n", current_offset);
3690  }
3691 
3692  return RESULT_SUCCESS;
3693 }
static struct ast_str * prompt
Definition: asterisk.c:2761
static PGresult * result
Definition: cel_pgsql.c:84
ast_timing_func_t ast_channel_timingfunc(const struct ast_channel *chan)
int ast_channel_streamid(const struct ast_channel *chan)
struct ast_sched_context * ast_channel_sched(const struct ast_channel *chan)
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
#define ast_mutex_unlock(a)
Definition: lock.h:188
#define ast_mutex_lock(a)
Definition: lock.h:187
size_t current
Definition: main/cli.c:113
static int speech_streamfile(struct ast_channel *chan, const char *filename, const char *preflang, int offset)
Definition: res_agi.c:3529
int ast_sched_runq(struct ast_sched_context *con)
Runs the queue.
Definition: sched.c:786
int ast_sched_wait(struct ast_sched_context *con) attribute_warn_unused_result
Determines number of seconds until the next outstanding event to take place.
Definition: sched.c:433
void ast_speech_start(struct ast_speech *speech)
Indicate to the speech engine that audio is now going to start being written.
Definition: res_speech.c:121
int ast_speech_write(struct ast_speech *speech, void *data, int len)
Write audio to the speech engine.
Definition: res_speech.c:143
struct ast_speech_result * ast_speech_results_get(struct ast_speech *speech)
Get speech recognition results.
Definition: res_speech.c:89
int ast_speech_change_state(struct ast_speech *speech, int state)
Change state of a speech structure.
Definition: res_speech.c:267
@ AST_SPEECH_STATE_DONE
Definition: speech.h:42
@ AST_SPEECH_STATE_READY
Definition: speech.h:40
@ AST_SPEECH_STATE_NOT_READY
Definition: speech.h:39
@ AST_SPEECH_STATE_WAIT
Definition: speech.h:41
@ AST_SPEECH_QUIET
Definition: speech.h:32
int ast_build_string(char **buffer, size_t *space, const char *fmt,...)
Build a string in a buffer, designed to be called repeatedly.
Definition: main/utils.c:2065
union ast_frame::@254 data
char * processing_sound
Definition: speech.h:60
int state
Definition: speech.h:62
ast_mutex_t lock
Definition: speech.h:56
struct ast_speech_result * results
Definition: speech.h:68
#define ast_clear_flag(p, flag)
Definition: utils.h:77

◆ handle_speechset()

static int handle_speechset ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3426 of file res_agi.c.

3427 {
3428  /* Check for minimum arguments */
3429  if (argc != 4)
3430  return RESULT_SHOWUSAGE;
3431 
3432  /* Check to make sure speech structure exists */
3433  if (!agi->speech) {
3434  ast_agi_send(agi->fd, chan, "200 result=0\n");
3435  return RESULT_SUCCESS;
3436  }
3437 
3438  ast_speech_change(agi->speech, argv[2], argv[3]);
3439  ast_agi_send(agi->fd, chan, "200 result=1\n");
3440 
3441  return RESULT_SUCCESS;
3442 }
int ast_speech_change(struct ast_speech *speech, const char *name, const char *value)
Change an engine specific attribute.
Definition: res_speech.c:168

References ast_agi_send(), ast_speech_change(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_speechunloadgrammar()

static int handle_speechunloadgrammar ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3475 of file res_agi.c.

3476 {
3477  if (argc != 4)
3478  return RESULT_SHOWUSAGE;
3479 
3480  if (!agi->speech) {
3481  ast_agi_send(agi->fd, chan, "200 result=0\n");
3482  return RESULT_SUCCESS;
3483  }
3484 
3485  if (ast_speech_grammar_unload(agi->speech, argv[3]))
3486  ast_agi_send(agi->fd, chan, "200 result=0\n");
3487  else
3488  ast_agi_send(agi->fd, chan, "200 result=1\n");
3489 
3490  return RESULT_SUCCESS;
3491 }
int ast_speech_grammar_unload(struct ast_speech *speech, const char *grammar_name)
Unload a grammar.
Definition: res_speech.c:83

References ast_agi_send(), ast_speech_grammar_unload(), agi_state::fd, RESULT_SHOWUSAGE, RESULT_SUCCESS, and agi_state::speech.

◆ handle_streamfile()

static int handle_streamfile ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2549 of file res_agi.c.

2550 {
2551  int res;
2552  struct ast_filestream *fs, *vfs;
2553  long sample_offset = 0, max_length;
2554  const char *edigits = "";
2555 
2556  if (argc < 4 || argc > 5) {
2557  return RESULT_SHOWUSAGE;
2558  }
2559 
2560  if (argv[3]) {
2561  edigits = argv[3];
2562  }
2563 
2564  if ((argc > 4) && (sscanf(argv[4], "%30ld", &sample_offset) != 1)) {
2565  return RESULT_SHOWUSAGE;
2566  }
2567 
2568  if (!(fs = ast_openstream(chan, argv[2], ast_channel_language(chan)))) {
2569  ast_agi_send(agi->fd, chan, "200 result=-1 endpos=%ld\n", sample_offset);
2570  return RESULT_FAILURE;
2571  }
2572 
2573  if ((vfs = ast_openvstream(chan, argv[2], ast_channel_language(chan)))) {
2574  ast_debug(1, "Ooh, found a video stream, too\n");
2575  }
2576  ast_verb(3, "<%s> Playing '%s.%s' (escape_digits=%s) (sample_offset %ld) (language '%s')\n",
2578  edigits, sample_offset, S_OR(ast_channel_language(chan), "default"));
2579 
2580  ast_seekstream(fs, 0, SEEK_END);
2581  max_length = ast_tellstream(fs);
2582  ast_seekstream(fs, sample_offset, SEEK_SET);
2583  res = ast_applystream(chan, fs);
2584  if (vfs) {
2585  ast_applystream(chan, vfs);
2586  }
2587  ast_playstream(fs);
2588  if (vfs) {
2590  }
2591 
2592  res = ast_waitstream_full(chan, argv[3], agi->audio, agi->ctrl);
2593  /* this is to check for if ast_waitstream closed the stream, we probably are at
2594  * the end of the stream, return that amount, else check for the amount */
2595  sample_offset = (ast_channel_stream(chan)) ? ast_tellstream(fs) : max_length;
2596  ast_stopstream(chan);
2597  if (res == 1) {
2598  /* Stop this command, don't print a result line, as there is a new command */
2599  return RESULT_SUCCESS;
2600  }
2601  ast_agi_send(agi->fd, chan, "200 result=%d endpos=%ld\n", res, sample_offset);
2602  pbx_builtin_setvar_helper(chan, "PLAYBACKSTATUS", res ? "FAILED" : "SUCCESS");
2603 
2604  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2605 }
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)

References ast_agi_send(), ast_applystream(), ast_channel_language(), ast_channel_name(), ast_channel_stream(), ast_channel_writeformat(), ast_debug, ast_format_get_name(), ast_openstream(), ast_openvstream(), ast_playstream(), ast_seekstream(), ast_stopstream(), ast_tellstream(), ast_verb, ast_waitstream_full(), agi_state::audio, agi_state::ctrl, agi_state::fd, pbx_builtin_setvar_helper(), RESULT_FAILURE, RESULT_SHOWUSAGE, RESULT_SUCCESS, S_OR, and ast_filestream::vfs.

◆ handle_tddmode()

static int handle_tddmode ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2443 of file res_agi.c.

2444 {
2445  int res, x;
2446 
2447  if (argc != 3)
2448  return RESULT_SHOWUSAGE;
2449 
2450  if (!strncasecmp(argv[2],"on",2)) {
2451  x = 1;
2452  } else {
2453  x = 0;
2454  }
2455  if (!strncasecmp(argv[2],"mate",4)) {
2456  x = 2;
2457  }
2458  if (!strncasecmp(argv[2],"tdd",3)) {
2459  x = 1;
2460  }
2461  res = ast_channel_setoption(chan, AST_OPTION_TDD, &x, sizeof(char), 0);
2462  if (res) {
2463  /* Set channel option failed */
2464  ast_agi_send(agi->fd, chan, "200 result=0\n");
2465  } else {
2466  ast_agi_send(agi->fd, chan, "200 result=1\n");
2467  }
2468  return RESULT_SUCCESS;
2469 }
int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block)
Sets an option on a channel.
Definition: channel.c:7505
#define AST_OPTION_TDD

References ast_agi_send(), ast_channel_setoption(), AST_OPTION_TDD, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_verbose()

static int handle_verbose ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 3265 of file res_agi.c.

3266 {
3267  int level = 0;
3268 
3269  if (argc < 2)
3270  return RESULT_SHOWUSAGE;
3271 
3272  if (argv[2])
3273  sscanf(argv[2], "%30d", &level);
3274 
3275  ast_verb(level, "%s: %s\n", ast_channel_data(chan), argv[1]);
3276 
3277  ast_agi_send(agi->fd, chan, "200 result=1\n");
3278 
3279  return RESULT_SUCCESS;
3280 }
const char * ast_channel_data(const struct ast_channel *chan)

References ast_agi_send(), ast_channel_data(), ast_verb, agi_state::fd, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ handle_waitfordigit()

static int handle_waitfordigit ( struct ast_channel chan,
AGI agi,
int  argc,
const char *const  argv[] 
)
static

Definition at line 2374 of file res_agi.c.

2375 {
2376  int res, to;
2377 
2378  if (argc != 4)
2379  return RESULT_SHOWUSAGE;
2380  if (sscanf(argv[3], "%30d", &to) != 1)
2381  return RESULT_SHOWUSAGE;
2382  res = ast_waitfordigit_full(chan, to, NULL, agi->audio, agi->ctrl);
2383  ast_agi_send(agi->fd, chan, "200 result=%d\n", res);
2384  return (res >= 0) ? RESULT_SUCCESS : RESULT_FAILURE;
2385 }

References ast_agi_send(), ast_waitfordigit_full(), agi_state::audio, agi_state::ctrl, agi_state::fd, NULL, RESULT_FAILURE, RESULT_SHOWUSAGE, and RESULT_SUCCESS.

◆ help_workhorse()

static char* help_workhorse ( int  fd,
const char *const  match[] 
)
static

Definition at line 3749 of file res_agi.c.

3750 {
3751  char fullcmd[MAX_CMD_LEN], matchstr[MAX_CMD_LEN];
3752  struct agi_command *e;
3753 
3754  if (match)
3755  ast_join(matchstr, sizeof(matchstr), match);
3756 
3757  ast_cli(fd, "%5.5s %30.30s %s\n","Dead","Command","Description");
3760  if (!e->cmda[0])
3761  break;
3762  /* Hide commands that start with '_' */
3763  if ((e->cmda[0])[0] == '_')
3764  continue;
3765  ast_join(fullcmd, sizeof(fullcmd), e->cmda);
3766  if (match && strncasecmp(matchstr, fullcmd, strlen(matchstr)))
3767  continue;
3768  ast_cli(fd, "%5.5s %30.30s %s\n", e->dead ? "Yes" : "No" , fullcmd, S_OR(e->summary, "Not available"));
3769  }
3771 
3772  return CLI_SUCCESS;
3773 }

References ast_cli(), ast_join, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, CLI_SUCCESS, agi_command::cmda, agi_command::dead, agi_command::list, match(), MAX_CMD_LEN, S_OR, and agi_command::summary.

Referenced by handle_cli_agi_show().

◆ launch_asyncagi()

static enum agi_result launch_asyncagi ( struct ast_channel chan,
int  argc,
char *  argv[],
int *  efd 
)
static

Definition at line 1739 of file res_agi.c.

1780 {
1781 /* This buffer sizes might cause truncation if the AGI command writes more data
1782  than AGI_BUF_SIZE as result. But let's be serious, is there an AGI command
1783  that writes a response larger than 1024 bytes?, I don't think so, most of
1784  them are just result=blah stuff. However probably if GET VARIABLE is called
1785  and the variable has large amount of data, that could be a problem. We could
1786  make this buffers dynamic, but let's leave that as a second step.
1787 
1788  AMI_BUF_SIZE is twice AGI_BUF_SIZE just for the sake of choosing a safe
1789  number. Some characters of AGI buf will be url encoded to be sent to manager
1790  clients. An URL encoded character will take 3 bytes, but again, to cause
1791  truncation more than about 70% of the AGI buffer should be URL encoded for
1792  that to happen. Not likely at all.
1793 
1794  On the other hand. I wonder if read() could eventually return less data than
1795  the amount already available in the pipe? If so, how to deal with that?
1796  So far, my tests on Linux have not had any problems.
1797  */
1798 #define AGI_BUF_SIZE 1024
1799 #define AMI_BUF_SIZE 2048
1800  enum agi_result cmd_status;
1801  struct agi_cmd *cmd;
1802  int res;
1803  int fds[2];
1804  int hungup;
1805  int timeout = 100;
1806  char agi_buffer[AGI_BUF_SIZE + 1];
1807  char ami_buffer[AMI_BUF_SIZE];
1808  enum agi_result returnstatus = AGI_RESULT_SUCCESS;
1809  AGI async_agi;
1810  RAII_VAR(struct ast_json *, startblob, NULL, ast_json_unref);
1811 
1812  if (efd) {
1813  ast_log(LOG_WARNING, "Async AGI does not support Enhanced AGI yet\n");
1814  return AGI_RESULT_FAILURE;
1815  }
1816 
1817  /* add AsyncAGI datastore to the channel */
1818  if (add_to_agi(chan)) {
1819  ast_log(LOG_ERROR, "Failed to start Async AGI on channel %s\n", ast_channel_name(chan));
1820  return AGI_RESULT_FAILURE;
1821  }
1822 
1823  /* this pipe allows us to create a "fake" AGI struct to use
1824  the AGI commands */
1825  res = pipe(fds);
1826  if (res) {
1827  ast_log(LOG_ERROR, "Failed to create Async AGI pipe\n");
1828  /*
1829  * Intentionally do not remove the datastore added with
1830  * add_to_agi() the from channel. It will be removed when the
1831  * channel is hung up anyway.
1832  */
1833  return AGI_RESULT_FAILURE;
1834  }
1835 
1836  /* handlers will get the pipe write fd and we read the AGI responses
1837  from the pipe read fd */
1838  async_agi.fd = fds[1];
1839  async_agi.ctrl = fds[1];
1840  async_agi.audio = -1; /* no audio support */
1841  async_agi.fast = 0;
1842  async_agi.speech = NULL;
1843 
1844  /* notify possible manager users of a new channel ready to
1845  receive commands */
1846  setup_env(chan, "async", fds[1], 0, argc, argv);
1847  /* read the environment */
1848  res = read(fds[0], agi_buffer, AGI_BUF_SIZE);
1849  if (res <= 0) {
1850  ast_log(LOG_ERROR, "Failed to read from Async AGI pipe on channel %s: %s\n",
1851  ast_channel_name(chan), res < 0 ? strerror(errno) : "EOF");
1852  returnstatus = AGI_RESULT_FAILURE;
1853  goto async_agi_abort;
1854  }
1855  agi_buffer[res] = '\0';
1856  /* encode it and send it thru the manager so whoever is going to take
1857  care of AGI commands on this channel can decide which AGI commands
1858  to execute based on the setup info */
1859  ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, ast_uri_http);
1860  startblob = ast_json_pack("{s: s}", "Env", ami_buffer);
1861 
1862  ast_channel_publish_cached_blob(chan, agi_async_start_type(), startblob);
1863 
1864  hungup = ast_check_hangup_locked(chan);
1865 
1866  for (;;) {
1867  /*
1868  * Process as many commands as we can. Commands are added via
1869  * the manager or the cli threads.
1870  */
1871  while (!hungup) {
1872  RAII_VAR(struct ast_json *, execblob, NULL, ast_json_unref);
1873  res = get_agi_cmd(chan, &cmd);
1874 
1875  if (res) {
1876  returnstatus = AGI_RESULT_FAILURE;
1877  goto async_agi_done;
1878  } else if (!cmd) {
1879  break;
1880  }
1881 
1882  /* OK, we have a command, let's call the command handler. */
1883  cmd_status = agi_handle_command(chan, &async_agi, cmd->cmd_buffer, 0);
1884 
1885  /*
1886  * The command handler must have written to our fake AGI struct
1887  * fd (the pipe), let's read the response.
1888  */
1889  res = read(fds[0], agi_buffer, AGI_BUF_SIZE);
1890  if (res <= 0) {
1891  ast_log(LOG_ERROR, "Failed to read from Async AGI pipe on channel %s: %s\n",
1892  ast_channel_name(chan), res < 0 ? strerror(errno) : "EOF");
1893  free_agi_cmd(cmd);
1894  returnstatus = AGI_RESULT_FAILURE;
1895  goto async_agi_done;
1896  }
1897  /*
1898  * We have a response, let's send the response thru the manager.
1899  * Include the CommandID if it was specified when the command
1900  * was added.
1901  */
1902  agi_buffer[res] = '\0';
1903  ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, ast_uri_http);
1904 
1905  execblob = ast_json_pack("{s: s}", "Result", ami_buffer);
1906  if (execblob && !ast_strlen_zero(cmd->cmd_id)) {
1907  ast_json_object_set(execblob, "CommandId", ast_json_string_create(cmd->cmd_id));
1908  }
1909  ast_channel_publish_cached_blob(chan, agi_async_exec_type(), execblob);
1910 
1911  free_agi_cmd(cmd);
1912 
1913  /*
1914  * Check the command status to determine if we should continue
1915  * executing more commands.
1916  */
1917  hungup = ast_check_hangup(chan);
1918  switch (cmd_status) {
1919  case AGI_RESULT_FAILURE:
1920  if (!hungup) {
1921  /* The failure was not because of a hangup. */
1922  returnstatus = AGI_RESULT_FAILURE;
1923  goto async_agi_done;
1924  }
1925  break;
1927  /* Only the "asyncagi break" command does this. */
1928  returnstatus = AGI_RESULT_SUCCESS_ASYNC;
1929  goto async_agi_done;
1930  default:
1931  break;
1932  }
1933  }
1934 
1935  if (!hungup) {
1936  /* Wait a bit for a frame to read or to poll for a new command. */
1937  res = ast_waitfor(chan, timeout);
1938  if (res < 0) {
1939  ast_debug(1, "ast_waitfor returned <= 0 on chan %s\n", ast_channel_name(chan));
1940  returnstatus = AGI_RESULT_FAILURE;
1941  break;
1942  }
1943  } else {
1944  /*
1945  * Read the channel control queue until it is dry so we can
1946  * quit.
1947  */
1948  res = 1;
1949  }
1950  if (0 < res) {
1951  do {
1952  cmd_status = async_agi_read_frame(chan);
1953  if (cmd_status != AGI_RESULT_SUCCESS) {
1954  returnstatus = cmd_status;
1955  goto async_agi_done;
1956  }
1957  hungup = ast_check_hangup(chan);
1958  } while (hungup);
1959  } else {
1960  hungup = ast_check_hangup(chan);
1961  }
1962  }
1963 async_agi_done:
1964 
1965  if (async_agi.speech) {
1966  ast_speech_destroy(async_agi.speech);
1967  }
1968  /* notify manager users this channel cannot be controlled anymore by Async AGI */
1969  ast_channel_publish_cached_blob(chan, agi_async_end_type(), NULL);
1970 
1971 async_agi_abort:
1972  /* close the pipe */
1973  close(fds[0]);
1974  close(fds[1]);
1975 
1976  /*
1977  * Intentionally do not remove the datastore added with
1978  * add_to_agi() the from channel. There might be commands still
1979  * in the queue or in-flight to us and AsyncAGI may get called
1980  * again. The datastore destructor will be called on channel
1981  * destruction anyway.
1982  */
1983 
1984  if (returnstatus == AGI_RESULT_SUCCESS) {
1985  returnstatus = AGI_RESULT_SUCCESS_ASYNC;
1986  }
1987  return returnstatus;
1988 
1989 #undef AGI_BUF_SIZE
1990 #undef AMI_BUF_SIZE
1991 }
int ast_check_hangup_locked(struct ast_channel *chan)
Definition: channel.c:459
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition: json.c:404
struct ast_json * ast_json_string_create(const char *value)
Construct a JSON string from value.
Definition: json.c:268
static void setup_env(struct ast_channel *chan, char *request, int fd, int enhanced, int argc, char *argv[])
Definition: res_agi.c:2310
#define AMI_BUF_SIZE
static enum agi_result async_agi_read_frame(struct ast_channel *chan)
Definition: res_agi.c:1751
static int add_to_agi(struct ast_channel *chan)
Definition: res_agi.c:1605
static int get_agi_cmd(struct ast_channel *chan, struct agi_cmd **cmd)
Retrieve the list head to the requested channel's AGI datastore.
Definition: res_agi.c:1550
#define AGI_BUF_SIZE
static enum agi_result agi_handle_command(struct ast_channel *chan, AGI *agi, char *buf, int dead)
Definition: res_agi.c:4013
unsigned int fast
Definition: agi.h:38
char * ast_uri_encode(const char *string, char *outbuf, int buflen, struct ast_flags spec)
Turn text string to URI-encoded XX version.
Definition: main/utils.c:723
const struct ast_flags ast_uri_http
Definition: main/utils.c:719

◆ launch_ha_netscript()

static enum agi_result launch_ha_netscript ( char *  agiurl,
char *  argv[],
int *  fds 
)
static

Definition at line 2004 of file res_agi.c.

2139 {
2140  char *host, *script;
2141  enum agi_result result;
2142  struct srv_context *context = NULL;
2143  int srv_ret;
2144  char service[256];
2145  char resolved_uri[1024];
2146  const char *srvhost;
2147  unsigned short srvport;
2148 
2149  /* format of agiurl is "hagi://host.domain[:port][/script/name]" */
2150  if (strlen(agiurl) < 7) { /* Remove hagi:// */
2151  ast_log(LOG_WARNING, "An error occurred parsing the AGI URI: %s", agiurl);
2152  return AGI_RESULT_FAILURE;
2153  }
2154  host = ast_strdupa(agiurl + 7);
2155 
2156  /* Strip off any script name */
2157  if ((script = strchr(host, '/'))) {
2158  *script++ = '\0';
2159  } else {
2160  script = "";
2161  }
2162 
2163  if (strchr(host, ':')) {
2164  ast_log(LOG_WARNING, "Specifying a port number disables SRV lookups: %s\n", agiurl);
2165  return launch_netscript(agiurl + 1, argv, fds); /* +1 to strip off leading h from hagi:// */
2166  }
2167 
2168  snprintf(service, sizeof(service), "%s%s", SRV_PREFIX, host);
2169 
2170  while (!(srv_ret = ast_srv_lookup(&context, service, &srvhost, &srvport))) {
2171  snprintf(resolved_uri, sizeof(resolved_uri), "agi://%s:%d/%s", srvhost, srvport, script);
2172  result = launch_netscript(resolved_uri, argv, fds);
2174  ast_log(LOG_WARNING, "AGI request failed for host '%s' (%s:%d)\n", host, srvhost, srvport);
2175  } else {
2176  /* The script launched so we must cleanup the context. */
2178  return result;
2179  }
2180  }
2181  /*
2182  * The DNS SRV lookup failed or we ran out of servers to check.
2183  * ast_srv_lookup() has already cleaned up the context for us.
2184  */
2185  if (srv_ret < 0) {
2186  ast_log(LOG_WARNING, "SRV lookup failed for %s\n", agiurl);
2187  }
2188 
2189  return AGI_RESULT_FAILURE;
2190 }
static char context[AST_MAX_CONTEXT]
Definition: chan_alsa.c:120
enum ast_cc_service_type service
Definition: chan_sip.c:956
static enum agi_result launch_netscript(char *agiurl, char *argv[], int *fds)
Definition: res_agi.c:2045
#define SRV_PREFIX
Definition: res_agi.c:1384
void ast_srv_cleanup(struct srv_context **context)
Cleanup resources associated with ast_srv_lookup.
Definition: srv.c:248
int ast_srv_lookup(struct srv_context **context, const char *service, const char **host, unsigned short *port)
Retrieve set of SRV lookups, in order.
Definition: srv.c:202

◆ launch_netscript()

static enum agi_result launch_netscript ( char *  agiurl,
char *  argv[],
int *  fds 
)
static

Definition at line 2004 of file res_agi.c.

2046 {
2047  int s = 0;
2048  char *host, *script;
2049  int num_addrs = 0, i = 0;
2050  struct ast_sockaddr *addrs;
2051 
2052  /* agiurl is "agi://host.domain[:port][/script/name]" */
2053  host = ast_strdupa(agiurl + 6); /* Remove agi:// */
2054 
2055  /* Strip off any script name */
2056  if ((script = strchr(host, '/'))) {
2057  *script++ = '\0';
2058  } else {
2059  script = "";
2060  }
2061 
2062  if (!(num_addrs = ast_sockaddr_resolve(&addrs, host, 0, AST_AF_UNSPEC))) {
2063  ast_log(LOG_WARNING, "Unable to locate host '%s'\n", host);
2064  return AGI_RESULT_FAILURE;
2065  }
2066 
2067  for (i = 0; i < num_addrs; i++) {
2068  if (!ast_sockaddr_port(&addrs[i])) {
2069  ast_sockaddr_set_port(&addrs[i], AGI_PORT);
2070  }
2071 
2072  if ((s = ast_socket_nonblock(addrs[i].ss.ss_family, SOCK_STREAM, IPPROTO_TCP)) < 0) {
2073  ast_log(LOG_WARNING, "Unable to create socket: %s\n", strerror(errno));
2074  continue;
2075  }
2076 
2077  if (ast_connect(s, &addrs[i]) && errno == EINPROGRESS) {
2078 
2079  if (handle_connection(agiurl, addrs[i], s)) {
2080  close(s);
2081  continue;
2082  }
2083 
2084  } else {
2085  ast_log(LOG_WARNING, "Connection to %s failed with unexpected error: %s\n",
2086  ast_sockaddr_stringify(&addrs[i]), strerror(errno));
2087  }
2088 
2089  break;
2090  }
2091 
2092  ast_free(addrs);
2093 
2094  if (i == num_addrs) {
2095  ast_log(LOG_WARNING, "Couldn't connect to any host. FastAGI failed.\n");
2096  return AGI_RESULT_FAILURE;
2097  }
2098 
2099  if (ast_agi_send(s, NULL, "agi_network: yes\n") < 0) {
2100  if (errno != EINTR) {
2101  ast_log(LOG_WARNING, "Connect to '%s' failed: %s\n", agiurl, strerror(errno));
2102  close(s);
2103  return AGI_RESULT_FAILURE;
2104  }
2105  }
2106 
2107  /* If we have a script parameter, relay it to the fastagi server */
2108  /* Script parameters take the form of: AGI(agi://my.example.com/?extension=${EXTEN}) */
2109  if (!ast_strlen_zero(script)) {
2110  ast_agi_send(s, NULL, "agi_network_script: %s\n", script);
2111  }
2112 
2113  ast_debug(4, "Wow, connected!\n");
2114  fds[0] = s;
2115  fds[1] = s;
2116  return AGI_RESULT_SUCCESS_FAST;
2117 }
int ast_connect(int sockfd, const struct ast_sockaddr *addr)
Wrapper around connect(2) that uses struct ast_sockaddr.
Definition: netsock2.c:595
@ AST_AF_UNSPEC
Definition: netsock2.h:54
#define ast_sockaddr_port(addr)
Get the port number of a socket address.
Definition: netsock2.h:517
int ast_sockaddr_resolve(struct ast_sockaddr **addrs, const char *str, int flags, int family)
Parses a string with an IPv4 or IPv6 address and place results into an array.
Definition: netsock2.c:280
#define ast_sockaddr_set_port(addr, port)
Sets the port number of a socket address.
Definition: netsock2.h:532
static int handle_connection(const char *agiurl, const struct ast_sockaddr addr, const int netsockfd)
Definition: res_agi.c:2004
#define AGI_PORT
Definition: res_agi.c:1399
Socket address structure.
Definition: netsock2.h:97
struct sockaddr_storage ss
Definition: netsock2.h:98
#define ast_socket_nonblock(domain, type, protocol)
Create a non-blocking socket.
Definition: utils.h:1068

◆ launch_script()

static enum agi_result launch_script ( struct ast_channel chan,
char *  script,
int  argc,
char *  argv[],
int *  fds,
int *  efd,
int *  opid 
)
static

Definition at line 2004 of file res_agi.c.

2193 {
2194  char tmp[256];
2195  int pid, toast[2], fromast[2], audio[2], res;
2196  struct stat st;
2197 
2198  if (!strncasecmp(script, "agi://", 6)) {
2199  return (efd == NULL) ? launch_netscript(script, argv, fds) : AGI_RESULT_FAILURE;
2200  }
2201  if (!strncasecmp(script, "hagi://", 7)) {
2202  return (efd == NULL) ? launch_ha_netscript(script, argv, fds) : AGI_RESULT_FAILURE;
2203  }
2204  if (!strncasecmp(script, "agi:async", sizeof("agi:async") - 1)) {
2205  return launch_asyncagi(chan, argc, argv, efd);
2206  }
2207 
2208  if (script[0] != '/') {
2209  snprintf(tmp, sizeof(tmp), "%s/%s", ast_config_AST_AGI_DIR, script);
2210  script = tmp;
2211  }
2212 
2213  /* Before even trying let's see if the file actually exists */
2214  if (stat(script, &st)) {
2215  ast_log(LOG_WARNING, "Failed to execute '%s': File does not exist.\n", script);
2216  return AGI_RESULT_NOTFOUND;
2217  }
2218 
2219  if (pipe(toast)) {
2220  ast_log(LOG_WARNING, "Unable to create toast pipe: %s\n",strerror(errno));
2221  return AGI_RESULT_FAILURE;
2222  }
2223  if (pipe(fromast)) {
2224  ast_log(LOG_WARNING, "unable to create fromast pipe: %s\n", strerror(errno));
2225  close(toast[0]);
2226  close(toast[1]);
2227  return AGI_RESULT_FAILURE;
2228  }
2229  if (efd) {
2230  if (pipe(audio)) {
2231  ast_log(LOG_WARNING, "unable to create audio pipe: %s\n", strerror(errno));
2232  close(fromast[0]);
2233  close(fromast[1]);
2234  close(toast[0]);
2235  close(toast[1]);
2236  return AGI_RESULT_FAILURE;
2237  }
2238 
2239  res = ast_fd_set_flags(audio[1], O_NONBLOCK);
2240  if (res < 0) {
2241  ast_log(LOG_WARNING, "unable to set audio pipe parameters: %s\n", strerror(errno));
2242  close(fromast[0]);
2243  close(fromast[1]);
2244  close(toast[0]);
2245  close(toast[1]);
2246  close(audio[0]);
2247  close(audio[1]);
2248  return AGI_RESULT_FAILURE;
2249  }
2250  }
2251 
2252  if ((pid = ast_safe_fork(1)) < 0) {
2253  ast_log(LOG_WARNING, "Failed to fork(): %s\n", strerror(errno));
2254  return AGI_RESULT_FAILURE;
2255  }
2256  if (!pid) {
2257  /* Pass paths to AGI via environmental variables */
2258  setenv("AST_CONFIG_DIR", ast_config_AST_CONFIG_DIR, 1);
2259  setenv("AST_CONFIG_FILE", ast_config_AST_CONFIG_FILE, 1);
2260  setenv("AST_MODULE_DIR", ast_config_AST_MODULE_DIR, 1);
2261  setenv("AST_SPOOL_DIR", ast_config_AST_SPOOL_DIR, 1);
2262  setenv("AST_MONITOR_DIR", ast_config_AST_MONITOR_DIR, 1);
2263  setenv("AST_VAR_DIR", ast_config_AST_VAR_DIR, 1);
2264  setenv("AST_DATA_DIR", ast_config_AST_DATA_DIR, 1);
2265  setenv("AST_LOG_DIR", ast_config_AST_LOG_DIR, 1);
2266  setenv("AST_AGI_DIR", ast_config_AST_AGI_DIR, 1);
2267  setenv("AST_KEY_DIR", ast_config_AST_KEY_DIR, 1);
2268  setenv("AST_RUN_DIR", ast_config_AST_RUN_DIR, 1);
2269 
2270  /* Don't run AGI scripts with realtime priority -- it causes audio stutter */
2271  ast_set_priority(0);
2272 
2273  /* Redirect stdin and out, provide enhanced audio channel if desired */
2274  dup2(fromast[0], STDIN_FILENO);
2275  dup2(toast[1], STDOUT_FILENO);
2276  if (efd)
2277  dup2(audio[0], STDERR_FILENO + 1);
2278  else
2279  close(STDERR_FILENO + 1);
2280 
2281  /* Close everything but stdin/out/error */
2282  ast_close_fds_above_n(STDERR_FILENO + 1);
2283 
2284  /* Execute script */
2285  /* XXX argv should be deprecated in favor of passing agi_argX paramaters */
2286  execv(script, argv);
2287  /* Can't use ast_log since FD's are closed */
2288  ast_child_verbose(1, "Failed to execute '%s': %s", script, strerror(errno));
2289  /* Special case to set status of AGI to failure */
2290  fprintf(stdout, "failure\n");
2291  fflush(stdout);
2292  _exit(1);
2293  }
2294  ast_verb(3, "Launched AGI Script %s\n", script);
2295  fds[0] = toast[0];
2296  fds[1] = fromast[1];
2297  if (efd)
2298  *efd = audio[1];
2299  /* close what we're not using in the parent */
2300  close(toast[1]);
2301  close(fromast[0]);
2302 
2303  if (efd)
2304  close(audio[0]);
2305 
2306  *opid = pid;
2307  return AGI_RESULT_SUCCESS;
2308 }
int ast_set_priority(int)
We set ourselves to a high priority, that we might pre-empt everything else. If your PBX has heavy ac...
Definition: asterisk.c:1835
int ast_safe_fork(int stop_reaper)
Common routine to safely fork without a chance of a signal handler firing badly in the child.
Definition: main/app.c:3267
void ast_close_fds_above_n(int n)
Common routine for child processes, to close all fds prior to exec(2)
Definition: main/app.c:3262
int setenv(const char *name, const char *value, int overwrite)
void ast_child_verbose(int level, const char *fmt,...)
Definition: logger.c:908
const char * ast_config_AST_KEY_DIR
Definition: options.c:161
const char * ast_config_AST_MODULE_DIR
Definition: options.c:153
const char * ast_config_AST_RUN_DIR
Definition: options.c:162
const char * ast_config_AST_DATA_DIR
Definition: options.c:158
const char * ast_config_AST_CONFIG_DIR
Definition: options.c:151
const char * ast_config_AST_SPOOL_DIR
Definition: options.c:154
const char * ast_config_AST_AGI_DIR
Definition: options.c:160
const char * ast_config_AST_VAR_DIR
Definition: options.c:157
const char * ast_config_AST_CONFIG_FILE
Definition: options.c:152
const char * ast_config_AST_MONITOR_DIR
Definition: options.c:155
const char * ast_config_AST_LOG_DIR
Definition: options.c:159
static enum agi_result launch_ha_netscript(char *agiurl, char *argv[], int *fds)
Definition: res_agi.c:2138
static enum agi_result launch_asyncagi(struct ast_channel *chan, int argc, char *argv[], int *efd)
Definition: res_agi.c:1779
#define ast_fd_set_flags(fd, flags)
Set flags on the given file descriptor.
Definition: utils.h:1034

Referenced by agi_exec_full().

◆ load_module()

static int load_module ( void  )
static

Definition at line 4674 of file res_agi.c.

4675 {
4676  int err = 0;
4677 
4678  err |= STASIS_MESSAGE_TYPE_INIT(agi_exec_start_type);
4679  err |= STASIS_MESSAGE_TYPE_INIT(agi_exec_end_type);
4680  err |= STASIS_MESSAGE_TYPE_INIT(agi_async_start_type);
4681  err |= STASIS_MESSAGE_TYPE_INIT(agi_async_exec_type);
4682  err |= STASIS_MESSAGE_TYPE_INIT(agi_async_end_type);
4683 
4690 
4691  AST_TEST_REGISTER(test_agi_null_docs);
4692 
4693  if (err) {
4694  unload_module();
4695  return AST_MODULE_LOAD_DECLINE;
4696  }
4697 
4698  return AST_MODULE_LOAD_SUCCESS;
4699 }
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
#define ast_manager_register_xml(action, authority, func)
Register a manager callback using XML documentation to describe the manager.
Definition: manager.h:191
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70
@ AST_MODULE_LOAD_DECLINE
Module has failed to load, may be in an inconsistent state.
Definition: module.h:78
#define ast_register_application_xml(app, execute)
Register an application using XML documentation.
Definition: module.h:626
static char * eapp
Definition: res_agi.c:1388
static struct ast_cli_entry cli_agi[]
Definition: res_agi.c:4609
static int eagi_exec(struct ast_channel *chan, const char *data)
Definition: res_agi.c:4561
static char * deadapp
Definition: res_agi.c:1390
static char * app
Definition: res_agi.c:1386
static int action_add_agi_cmd(struct mansession *s, const struct message *m)
Add a new command to execute by the Async AGI application.
Definition: res_agi.c:1701
static struct agi_command commands[]
AGI commands list.
Definition: res_agi.c:3698
static int unload_module(void)
Definition: res_agi.c:4656
int AST_OPTIONAL_API_NAME() ast_agi_register_multiple(struct ast_module *mod, struct agi_command *cmd, unsigned int len)
Registers a group of AGI commands, provided as an array of struct agi_command entries.
Definition: res_agi.c:3855
static int deadagi_exec(struct ast_channel *chan, const char *data)
Definition: res_agi.c:4603
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1493
struct ast_module * self
Definition: module.h:342
#define AST_TEST_REGISTER(cb)
Definition: test.h:127
#define ARRAY_LEN(a)
Definition: utils.h:661

◆ parse_args()

static int parse_args ( char *  s,
int *  max,
const char *  argv[] 
)
static

Definition at line 3939 of file res_agi.c.

3940 {
3941  int x = 0, quoted = 0, escaped = 0, whitespace = 1;
3942  char *cur;
3943 
3944  cur = s;
3945  while(*s) {
3946  switch(*s) {
3947  case '"':
3948  /* If it's escaped, put a literal quote */
3949  if (escaped)
3950  goto normal;
3951  else
3952  quoted = !quoted;
3953  if (quoted && whitespace) {
3954  /* If we're starting a quote, coming off white space start a new word, too */
3955  argv[x++] = cur;
3956  whitespace=0;
3957  }
3958  escaped = 0;
3959  break;
3960  case ' ':
3961  case '\t':
3962  if (!quoted && !escaped) {
3963  /* If we're not quoted, mark this as whitespace, and
3964  end the previous argument */
3965  whitespace = 1;
3966  *(cur++) = '\0';
3967  } else
3968  /* Otherwise, just treat it as anything else */
3969  goto normal;
3970  break;
3971  case '\\':
3972  /* If we're escaped, print a literal, otherwise enable escaping */
3973  if (escaped) {
3974  goto normal;
3975  } else {
3976  escaped=1;
3977  }
3978  break;
3979  default:
3980 normal:
3981  if (whitespace) {
3982  if (x >= MAX_ARGS -1) {
3983  ast_log(LOG_WARNING, "Too many arguments, truncating\n");
3984  break;
3985  }
3986  /* Coming off of whitespace, start the next argument */
3987  argv[x++] = cur;
3988  whitespace=0;
3989  }
3990  *(cur++) = *s;
3991  escaped=0;
3992  }
3993  s++;
3994  }
3995  /* Null terminate */
3996  *(cur++) = '\0';
3997  argv[x] = NULL;
3998  *max = x;
3999  return 0;
4000 }

References ast_log, LOG_WARNING, max, MAX_ARGS, and NULL.

◆ publish_async_exec_end()

static void publish_async_exec_end ( struct ast_channel chan,
int  command_id,
const char *  command,
int  result_code,
const char *  result 
)
static

Definition at line 4002 of file res_agi.c.

4003 {
4004  RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
4005  blob = ast_json_pack("{s: i, s: s, s: i, s: s}",
4006  "CommandId", command_id,
4007  "Command", command,
4008  "ResultCode", result_code,
4009  "Result", result);
4010  ast_channel_publish_cached_blob(chan, agi_exec_end_type(), blob);
4011 }

◆ run_agi()

static enum agi_result run_agi ( struct ast_channel chan,
char *  request,
AGI agi,
int  pid,
int *  status,
int  dead,
int  argc,
char *  argv[] 
)
static

Running in an interception routine is like DeadAGI mode. No touchy the channel frames.

Definition at line 4002 of file res_agi.c.

4105 {
4106  struct ast_channel *c;
4107  int outfd;
4108  int ms;
4109  int needhup = 0;
4110  enum agi_result returnstatus = AGI_RESULT_SUCCESS;
4111  struct ast_frame *f;
4112  char buf[AGI_BUF_LEN];
4113  char *res = NULL;
4114  FILE *readf;
4115  /* how many times we'll retry if ast_waitfor_nandfs will return without either
4116  channel or file descriptor in case select is interrupted by a system call (EINTR) */
4117  int retry = AGI_NANDFS_RETRY;
4118  int send_sighup;
4119  const char *sighup_str;
4120  const char *exit_on_hangup_str;
4121  int exit_on_hangup;
4122  /*! Running in an interception routine is like DeadAGI mode. No touchy the channel frames. */
4123  int in_intercept = ast_channel_get_intercept_mode();
4124 
4125  ast_channel_lock(chan);
4126  sighup_str = pbx_builtin_getvar_helper(chan, "AGISIGHUP");
4127  send_sighup = !ast_false(sighup_str);
4128  exit_on_hangup_str = pbx_builtin_getvar_helper(chan, "AGIEXITONHANGUP");
4129  exit_on_hangup = ast_true(exit_on_hangup_str);
4130  ast_channel_unlock(chan);
4131 
4132  if (!(readf = fdopen(agi->ctrl, "r"))) {
4133  ast_log(LOG_WARNING, "Unable to fdopen file descriptor\n");
4134  if (send_sighup && pid > -1)
4135  kill(pid, SIGHUP);
4136  close(agi->ctrl);
4137  return AGI_RESULT_FAILURE;
4138  }
4139 
4140  setlinebuf(readf);
4141  setup_env(chan, request, agi->fd, (agi->audio > -1), argc, argv);
4142  for (;;) {
4143  if (needhup) {
4144  needhup = 0;
4145  dead = 1;
4146  if (send_sighup) {
4147  if (pid > -1) {
4148  kill(pid, SIGHUP);
4149  } else if (agi->fast) {
4150  ast_agi_send(agi->fd, chan, "HANGUP\n");
4151  }
4152  }
4153  if (exit_on_hangup) {
4154  break;
4155  }
4156  }
4157  ms = -1;
4158  if (dead || in_intercept) {
4159  c = ast_waitfor_nandfds(&chan, 0, &agi->ctrl, 1, NULL, &outfd, &ms);
4160  } else if (!ast_check_hangup(chan)) {
4161  c = ast_waitfor_nandfds(&chan, 1, &agi->ctrl, 1, NULL, &outfd, &ms);
4162  } else {
4163  /*
4164  * Read the channel control queue until it is dry so we can
4165  * switch to dead mode.
4166  */
4167  c = chan;
4168  }
4169  if (c) {
4170  retry = AGI_NANDFS_RETRY;
4171  /* Idle the channel until we get a command */
4172  f = ast_read(c);
4173  if (!f) {
4174  ast_debug(1, "%s hungup\n", ast_channel_name(chan));
4175  needhup = 1;
4176  if (!returnstatus) {
4177  returnstatus = AGI_RESULT_HANGUP;
4178  }
4179  } else {
4180  /* If it's voice, write it to the audio pipe */
4181  if ((agi->audio > -1) && (f->frametype == AST_FRAME_VOICE)) {
4182  /* Write, ignoring errors */
4183  if (write(agi->audio, f->data.ptr, f->datalen) < 0) {
4184  }
4185  }
4186  ast_frfree(f);
4187  }
4188  } else if (outfd > -1) {
4189  size_t len = sizeof(buf);
4190  size_t buflen = 0;
4191  enum agi_result cmd_status;
4192 
4193  retry = AGI_NANDFS_RETRY;
4194  buf[0] = '\0';
4195 
4196  while (len > 1) {
4197  res = fgets(buf + buflen, len, readf);
4198  if (feof(readf))
4199  break;
4200  if (ferror(readf) && ((errno != EINTR) && (errno != EAGAIN)))
4201  break;
4202  if (res != NULL && !agi->fast)
4203  break;
4204  buflen = strlen(buf);
4205  if (buflen && buf[buflen - 1] == '\n')
4206  break;
4207  len = sizeof(buf) - buflen;
4208  if (agidebug)
4209  ast_verbose("AGI Rx << temp buffer %s - errno %s\nNo \\n received, checking again.\n", buf, strerror(errno));
4210  }
4211 
4212  if (!buf[0]) {
4213  /* Program terminated */
4214  ast_verb(3, "<%s>AGI Script %s completed, returning %d\n", ast_channel_name(chan), request, returnstatus);
4215  if (pid > 0)
4216  waitpid(pid, status, 0);
4217  /* No need to kill the pid anymore, since they closed us */
4218  pid = -1;
4219  break;
4220  }
4221 
4222  /* Special case for inability to execute child process */
4223  if (*buf && strncasecmp(buf, "failure", 7) == 0) {
4224  returnstatus = AGI_RESULT_FAILURE;
4225  break;
4226  }
4227 
4228  /* get rid of trailing newline, if any */
4229  buflen = strlen(buf);
4230  if (buflen && buf[buflen - 1] == '\n') {
4231  buf[buflen - 1] = '\0';
4232  }
4233 
4234  if (agidebug)
4235  ast_verbose("<%s>AGI Rx << %s\n", ast_channel_name(chan), buf);
4236  cmd_status = agi_handle_command(chan, agi, buf, dead || in_intercept);
4237  switch (cmd_status) {
4238  case AGI_RESULT_FAILURE:
4239  if (dead || in_intercept || !ast_check_hangup(chan)) {
4240  /* The failure was not because of a hangup. */
4241  returnstatus = AGI_RESULT_FAILURE;
4242  }
4243  break;
4244  default:
4245  break;
4246  }
4247  } else {
4248  if (--retry <= 0) {
4249  ast_log(LOG_WARNING, "No channel, no fd?\n");
4250  returnstatus = AGI_RESULT_FAILURE;
4251  break;
4252  }
4253  }