features, manager : Add CancelAtxfer AMI action
authorThomas Sevestre <thomassevestre@free.fr>
Fri, 25 Aug 2017 13:19:00 +0000 (13:19 +0000)
committerKevin Harwell <kharwell@digium.com>
Thu, 12 Oct 2017 18:31:34 +0000 (13:31 -0500)
Add action to cancel feature attended transfer with AMI interface

ASTERISK-27215 #close

Change-Id: Iab8a81362b5a1757e2608f70b014ef863200cb42

CHANGES
include/asterisk/features_config.h
main/features_config.c
main/manager.c

diff --git a/CHANGES b/CHANGES
index 4d1395f..63c8c6f 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -33,6 +33,10 @@ res_pjsip
    than one.  The removed contact is likely the old contact created by
    "rewrite_contact" that the device is refreshing.
 
+AMI
+------------------
+ * Added a new CancelAtxfer action that cancels an attended transfer.
+
 ------------------------------------------------------------------------------
 --- Functionality changes from Asterisk 14 to Asterisk 15 --------------------
 ------------------------------------------------------------------------------
index baaff18..1bce50b 100644 (file)
@@ -117,6 +117,21 @@ struct ast_features_xfer_config *ast_get_chan_features_xfer_config(struct ast_ch
 char *ast_get_chan_features_xferfailsound(struct ast_channel *chan);
 
 /*!
+ * \brief Get the transfer configuration option atxferabort
+ *
+ * \note The channel should be locked before calling this function.
+ * \note The returned value has to be freed.
+ *
+ * If no channel is provided, then option is pulled from the global
+ * transfer configuration.
+ *
+ * \param chan The channel to get configuration options for
+ * \retval NULL Failed to get configuration
+ * \retval non-NULL The atxferabort
+ */
+char *ast_get_chan_features_atxferabort(struct ast_channel *chan);
+
+/*!
  * \brief Configuration relating to call pickup
  */
 struct ast_features_pickup_config {
index 8307b12..72cd040 100644 (file)
@@ -1173,6 +1173,21 @@ char *ast_get_chan_features_xferfailsound(struct ast_channel *chan)
        return res;
 }
 
+char *ast_get_chan_features_atxferabort(struct ast_channel *chan)
+{
+       char *res;
+       struct ast_features_xfer_config *cfg = ast_get_chan_features_xfer_config(chan);
+
+       if (!cfg) {
+               return NULL;
+       }
+
+       res = ast_strdup(cfg->atxferabort);
+       ao2_ref(cfg, -1);
+
+       return res;
+}
+
 struct ast_features_pickup_config *ast_get_chan_features_pickup_config(struct ast_channel *chan)
 {
        RAII_VAR(struct features_config *, cfg, NULL, ao2_cleanup);
index e67efe3..5c0b318 100644 (file)
                        <ref type="managerEvent">AttendedTransfer</ref>
                </see-also>
        </manager>
+       <manager name="CancelAtxfer" language="en_US">
+               <synopsis>
+                       Cancel an attended transfer.
+               </synopsis>
+               <syntax>
+                       <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+                       <parameter name="Channel" required="true">
+                               <para>The transferer channel.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Cancel an attended transfer. Note, this uses the configured cancel attended transfer
+                       feature option (atxferabort) to cancel the transfer. If not available this action will fail.
+                       </para>
+               </description>
+               <see-also>
+                       <ref type="managerEvent">AttendedTransfer</ref>
+               </see-also>
+       </manager>
        <manager name="Originate" language="en_US">
                <synopsis>
                        Originate a call.
@@ -4959,6 +4978,47 @@ static int action_atxfer(struct mansession *s, const struct message *m)
        return 0;
 }
 
+static int action_cancel_atxfer(struct mansession *s, const struct message *m)
+{
+       const char *name = astman_get_header(m, "Channel");
+       struct ast_channel *chan = NULL;
+       char *feature_code;
+       const char *digit;
+
+       if (ast_strlen_zero(name)) {
+               astman_send_error(s, m, "No channel specified");
+               return 0;
+       }
+
+       if (!(chan = ast_channel_get_by_name(name))) {
+               astman_send_error(s, m, "Channel specified does not exist");
+               return 0;
+       }
+
+       ast_channel_lock(chan);
+       feature_code = ast_get_chan_features_atxferabort(chan);
+       ast_channel_unlock(chan);
+
+       if (!feature_code) {
+               astman_send_error(s, m, "No disconnect feature code found");
+               ast_channel_unref(chan);
+               return 0;
+       }
+
+       for (digit = feature_code; *digit; ++digit) {
+               struct ast_frame f = { AST_FRAME_DTMF, .subclass.integer = *digit };
+               ast_queue_frame(chan, &f);
+       }
+       ast_free(feature_code);
+
+       chan = ast_channel_unref(chan);
+
+       astman_send_ack(s, m, "CancelAtxfer successfully queued");
+
+       return 0;
+}
+
+
 static int check_blacklist(const char *cmd)
 {
        char *cmd_copy, *cur_cmd;
@@ -8679,6 +8739,7 @@ static void manager_shutdown(void)
        ast_manager_unregister("ListCategories");
        ast_manager_unregister("Redirect");
        ast_manager_unregister("Atxfer");
+       ast_manager_unregister("CancelAtxfer");
        ast_manager_unregister("Originate");
        ast_manager_unregister("Command");
        ast_manager_unregister("ExtensionState");
@@ -8894,6 +8955,7 @@ static int __init_manager(int reload, int by_external_config)
                ast_manager_register_xml_core("ListCategories", EVENT_FLAG_CONFIG, action_listcategories);
                ast_manager_register_xml_core("Redirect", EVENT_FLAG_CALL, action_redirect);
                ast_manager_register_xml_core("Atxfer", EVENT_FLAG_CALL, action_atxfer);
+               ast_manager_register_xml_core("CancelAtxfer", EVENT_FLAG_CALL, action_cancel_atxfer);
                ast_manager_register_xml_core("Originate", EVENT_FLAG_ORIGINATE, action_originate);
                ast_manager_register_xml_core("Command", EVENT_FLAG_COMMAND, action_command);
                ast_manager_register_xml_core("ExtensionState", EVENT_FLAG_CALL | EVENT_FLAG_REPORTING, action_extensionstate);