kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-06 12:36:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Include channel uniqueid in "AsyncAGI" and "AGIExec" events.

Browse Source 
* Added AMI event documentation for AsyncAGI and AGIExec events.

(closes issue ASTERISK-20318)
Reported by: Dan Cropp
Patches:
      res_agi_patch.txt (license #6422) patch uploaded by Dan Cropp
      modified for trunk.


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@374075 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Richard Mudgett
2012-09-28 22:11:19 +00:00
parent 02d2280543
commit 1f9d7090df
1 changed files with 126 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
res/res_agi.c
View File

@@ -1323,10 +1323,32 @@ static enum agi_result launch_asyncagi(struct ast_channel *chan, char *argv[], i
care of AGI commands on this channel can decide which AGI commands care of AGI commands on this channel can decide which AGI commands
to execute based on the setup info */ to execute based on the setup info */
ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, ast_uri_http); ast_uri_encode(agi_buffer, ami_buffer, AMI_BUF_SIZE, ast_uri_http);
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
<syntax>
<parameter name="SubEvent">
<para>A sub event type, specifying the channel AsyncAGI processing status.</para>
<enumlist>
<enum name="Start"/>
<enum name="Exec"/>
<enum name="End"/>
</enumlist>
</parameter>
<parameter name="Env">
<para>URL encoded string read from the AsyncAGI server.</para>
</parameter>
</syntax>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGI, "AsyncAGI", manager_event(EVENT_FLAG_AGI, "AsyncAGI",
"SubEvent: Start\r\n" "SubEvent: Start\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"Env: %s\r\n", ast_channel_name(chan), ami_buffer); "Uniqueid: %s\r\n"
"Env: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
ami_buffer);
hungup = ast_check_hangup(chan); hungup = ast_check_hangup(chan);
for (;;) { for (;;) {
/* /*
@@ -1369,13 +1391,35 @@ static enum agi_result launch_asyncagi(struct ast_channel *chan, char *argv[], i
manager_event(EVENT_FLAG_AGI, "AsyncAGI", manager_event(EVENT_FLAG_AGI, "AsyncAGI",
"SubEvent: Exec\r\n" "SubEvent: Exec\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"Result: %s\r\n", ast_channel_name(chan), ami_buffer); "Uniqueid: %s\r\n"
"Result: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
ami_buffer);
} else { } else {
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
<syntax>
<parameter name="CommandID" required="false">
<para>Optional command ID sent by the AsyncAGI server to identify the command.</para>
</parameter>
<parameter name="Result">
<para>URL encoded result string from the executed AGI command.</para>
</parameter>
</syntax>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGI, "AsyncAGI", manager_event(EVENT_FLAG_AGI, "AsyncAGI",
"SubEvent: Exec\r\n" "SubEvent: Exec\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"Uniqueid: %s\r\n"
"CommandID: %s\r\n" "CommandID: %s\r\n"
"Result: %s\r\n", ast_channel_name(chan), cmd->cmd_id, ami_buffer); "Result: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
cmd->cmd_id,
ami_buffer);
} }
free_agi_cmd(cmd); free_agi_cmd(cmd);
@@ -1434,11 +1478,18 @@ async_agi_done:
if (async_agi.speech) { if (async_agi.speech) {
ast_speech_destroy(async_agi.speech); ast_speech_destroy(async_agi.speech);
} }
/* notify manager users this channel cannot be /* notify manager users this channel cannot be controlled anymore by Async AGI */
controlled anymore by Async AGI */ /*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGI, "AsyncAGI", manager_event(EVENT_FLAG_AGI, "AsyncAGI",
"SubEvent: End\r\n" "SubEvent: End\r\n"
"Channel: %s\r\n", ast_channel_name(chan)); "Channel: %s\r\n"
"Uniqueid: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan));
async_agi_abort: async_agi_abort:
/* close the pipe */ /* close the pipe */
@@ -3414,11 +3465,36 @@ static enum agi_result agi_handle_command(struct ast_channel *chan, AGI *agi, ch
int command_id = ast_random(); int command_id = ast_random();
int resultcode; int resultcode;
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a received AGI command starts processing.</synopsis>
<syntax>
<parameter name="SubEvent">
<para>A sub event type, specifying whether the AGI command has begun or ended.</para>
<enumlist>
<enum name="Start"/>
<enum name="End"/>
</enumlist>
</parameter>
<parameter name="CommandId">
<para>Random identification number assigned to the execution of this command.</para>
</parameter>
<parameter name="Command">
<para>The AGI command as received from the external source.</para>
</parameter>
</syntax>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGI, "AGIExec", manager_event(EVENT_FLAG_AGI, "AGIExec",
"SubEvent: Start\r\n" "SubEvent: Start\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"CommandId: %d\r\n" "Uniqueid: %s\r\n"
"Command: %s\r\n", ast_channel_name(chan), command_id, ami_cmd); "CommandId: %d\r\n"
"Command: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
command_id,
ami_cmd);
parse_args(buf, &argc, argv); parse_args(buf, &argc, argv);
c = find_command(argv, 0); c = find_command(argv, 0);
if (c && (!dead || (dead && c->dead))) { if (c && (!dead || (dead && c->dead))) {
@@ -3453,13 +3529,25 @@ static enum agi_result agi_handle_command(struct ast_channel *chan, AGI *agi, ch
resultcode = 200; resultcode = 200;
break; break;
} }
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a received AGI command completes processing.</synopsis>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_AGI, "AGIExec", manager_event(EVENT_FLAG_AGI, "AGIExec",
"SubEvent: End\r\n" "SubEvent: End\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"CommandId: %d\r\n" "Uniqueid: %s\r\n"
"Command: %s\r\n" "CommandId: %d\r\n"
"ResultCode: %d\r\n" "Command: %s\r\n"
"Result: %s\r\n", ast_channel_name(chan), command_id, ami_cmd, resultcode, ami_res); "ResultCode: %d\r\n"
"Result: %s\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
command_id,
ami_cmd,
resultcode,
ami_res);
switch (res) { switch (res) {
case RESULT_SHOWUSAGE: case RESULT_SHOWUSAGE:
if (ast_strlen_zero(c->usage)) { if (ast_strlen_zero(c->usage)) {
@@ -3481,21 +3569,31 @@ static enum agi_result agi_handle_command(struct ast_channel *chan, AGI *agi, ch
} else if (c) { } else if (c) {
ast_agi_send(agi->fd, chan, "511 Command Not Permitted on a dead channel\n"); ast_agi_send(agi->fd, chan, "511 Command Not Permitted on a dead channel\n");
manager_event(EVENT_FLAG_AGI, "AGIExec", manager_event(EVENT_FLAG_AGI, "AGIExec",
"SubEvent: End\r\n" "SubEvent: End\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"CommandId: %d\r\n" "Uniqueid: %s\r\n"
"Command: %s\r\n" "CommandId: %d\r\n"
"ResultCode: 511\r\n" "Command: %s\r\n"
"Result: Command not permitted on a dead channel\r\n", ast_channel_name(chan), command_id, ami_cmd); "ResultCode: 511\r\n"
"Result: Command not permitted on a dead channel\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
command_id,
ami_cmd);
} else { } else {
ast_agi_send(agi->fd, chan, "510 Invalid or unknown command\n"); ast_agi_send(agi->fd, chan, "510 Invalid or unknown command\n");
manager_event(EVENT_FLAG_AGI, "AGIExec", manager_event(EVENT_FLAG_AGI, "AGIExec",
"SubEvent: End\r\n" "SubEvent: End\r\n"
"Channel: %s\r\n" "Channel: %s\r\n"
"CommandId: %d\r\n" "Uniqueid: %s\r\n"
"Command: %s\r\n" "CommandId: %d\r\n"
"ResultCode: 510\r\n" "Command: %s\r\n"
"Result: Invalid or unknown command\r\n", ast_channel_name(chan), command_id, ami_cmd); "ResultCode: 510\r\n"
"Result: Invalid or unknown command\r\n",
ast_channel_name(chan),
ast_channel_uniqueid(chan),
command_id,
ami_cmd);
} }
return AGI_RESULT_SUCCESS; return AGI_RESULT_SUCCESS;
} }