ast_json_pack(): Use safer json ref mechanism.
[asterisk/asterisk.git] / main / manager_bridges.c
index 77d9ff0..b7059f4 100644 (file)
@@ -25,8 +25,6 @@
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/stasis_bridges.h"
 #include "asterisk/stasis_channels.h"
 #include "asterisk/manager.h"
@@ -42,6 +40,11 @@ static struct stasis_message_router *bridge_state_router;
                        <syntax>
                                <bridge_snapshot/>
                        </syntax>
+                       <see-also>
+                               <ref type="managerEvent">BridgeDestroy</ref>
+                               <ref type="managerEvent">BridgeEnter</ref>
+                               <ref type="managerEvent">BridgeLeave</ref>
+                       </see-also>
                </managerEventInstance>
        </managerEvent>
        <managerEvent language="en_US" name="BridgeDestroy">
@@ -50,6 +53,11 @@ static struct stasis_message_router *bridge_state_router;
                        <syntax>
                                <bridge_snapshot/>
                        </syntax>
+                       <see-also>
+                               <ref type="managerEvent">BridgeCreate</ref>
+                               <ref type="managerEvent">BridgeEnter</ref>
+                               <ref type="managerEvent">BridgeLeave</ref>
+                       </see-also>
                </managerEventInstance>
        </managerEvent>
        <managerEvent language="en_US" name="BridgeEnter">
@@ -62,6 +70,11 @@ static struct stasis_message_router *bridge_state_router;
                                        <para>The uniqueid of the channel being swapped out of the bridge</para>
                                </parameter>
                        </syntax>
+                       <see-also>
+                               <ref type="managerEvent">BridgeCreate</ref>
+                               <ref type="managerEvent">BridgeDestroy</ref>
+                               <ref type="managerEvent">BridgeLeave</ref>
+                       </see-also>
                </managerEventInstance>
        </managerEvent>
        <managerEvent language="en_US" name="BridgeLeave">
@@ -71,6 +84,26 @@ static struct stasis_message_router *bridge_state_router;
                                <bridge_snapshot/>
                                <channel_snapshot/>
                        </syntax>
+                       <see-also>
+                               <ref type="managerEvent">BridgeCreate</ref>
+                               <ref type="managerEvent">BridgeDestroy</ref>
+                               <ref type="managerEvent">BridgeEnter</ref>
+                       </see-also>
+               </managerEventInstance>
+       </managerEvent>
+       <managerEvent language="en_US" name="BridgeVideoSourceUpdate">
+               <managerEventInstance class="EVENT_FLAG_CALL">
+                       <synopsis>Raised when the channel that is the source of video in a bridge changes.</synopsis>
+                       <syntax>
+                               <bridge_snapshot/>
+                               <parameter name="BridgePreviousVideoSource">
+                                       <para>The unique ID of the channel that was the video source.</para>
+                               </parameter>
+                       </syntax>
+                       <see-also>
+                               <ref type="managerEvent">BridgeCreate</ref>
+                               <ref type="managerEvent">BridgeDestroy</ref>
+                       </see-also>
                </managerEventInstance>
        </managerEvent>
        <manager name="BridgeList" language="en_US">
@@ -86,6 +119,12 @@ static struct stasis_message_router *bridge_state_router;
                <description>
                        <para>Returns a list of bridges, optionally filtering on a bridge type.</para>
                </description>
+               <see-also>
+                       <ref type="manager">Bridge</ref>
+                       <ref type="manager">BridgeDestroy</ref>
+                       <ref type="manager">BridgeInfo</ref>
+                       <ref type="manager">BridgeKick</ref>
+               </see-also>
        </manager>
        <manager name="BridgeInfo" language="en_US">
                <synopsis>
@@ -94,19 +133,92 @@ static struct stasis_message_router *bridge_state_router;
                <syntax>
                        <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
                        <parameter name="BridgeUniqueid" required="true">
-                               <para>The unique ID of the bridge about which to retreive information.</para>
+                               <para>The unique ID of the bridge about which to retrieve information.</para>
                        </parameter>
                </syntax>
                <description>
                        <para>Returns detailed information about a bridge and the channels in it.</para>
                </description>
+               <see-also>
+                       <ref type="manager">Bridge</ref>
+                       <ref type="manager">BridgeDestroy</ref>
+                       <ref type="manager">BridgeKick</ref>
+                       <ref type="manager">BridgeList</ref>
+               </see-also>
+               <responses>
+                       <list-elements>
+                               <managerEvent language="en_US" name="BridgeInfoChannel">
+                                       <managerEventInstance class="EVENT_FLAG_COMMAND">
+                                               <synopsis>Information about a channel in a bridge.</synopsis>
+                                               <syntax>
+                                                       <channel_snapshot/>
+                                               </syntax>
+                                       </managerEventInstance>
+                               </managerEvent>
+                       </list-elements>
+                       <managerEvent language="en_US" name="BridgeInfoComplete">
+                               <managerEventInstance class="EVENT_FLAG_COMMAND">
+                                       <synopsis>Information about a bridge.</synopsis>
+                                       <syntax>
+                                               <bridge_snapshot/>
+                                       </syntax>
+                               </managerEventInstance>
+                       </managerEvent>
+               </responses>
+       </manager>
+       <manager name="BridgeDestroy" language="en_US">
+               <synopsis>
+                       Destroy a bridge.
+               </synopsis>
+               <syntax>
+                       <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+                       <parameter name="BridgeUniqueid" required="true">
+                               <para>The unique ID of the bridge to destroy.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Deletes the bridge, causing channels to continue or hang up.</para>
+               </description>
+               <see-also>
+                       <ref type="manager">Bridge</ref>
+                       <ref type="manager">BridgeInfo</ref>
+                       <ref type="manager">BridgeKick</ref>
+                       <ref type="manager">BridgeList</ref>
+                       <ref type="managerEvent">BridgeDestroy</ref>
+               </see-also>
+       </manager>
+       <manager name="BridgeKick" language="en_US">
+               <synopsis>
+                       Kick a channel from a bridge.
+               </synopsis>
+               <syntax>
+                       <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
+                       <parameter name="BridgeUniqueid" required="false">
+                               <para>The unique ID of the bridge containing the channel to
+                               destroy.  This parameter can be omitted, or supplied to insure
+                               that the channel is not removed from the wrong bridge.</para>
+                       </parameter>
+                       <parameter name="Channel" required="true">
+                               <para>The channel to kick out of a bridge.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>The channel is removed from the bridge.</para>
+               </description>
+               <see-also>
+                       <ref type="manager">Bridge</ref>
+                       <ref type="manager">BridgeDestroy</ref>
+                       <ref type="manager">BridgeInfo</ref>
+                       <ref type="manager">BridgeList</ref>
+                       <ref type="managerEvent">BridgeLeave</ref>
+               </see-also>
        </manager>
  ***/
 
 /*! \brief The \ref stasis subscription returned by the forwarding of the channel topic
  * to the manager topic
  */
-static struct stasis_subscription *topic_forwarder;
+static struct stasis_forward *topic_forwarder;
 
 struct ast_str *ast_manager_build_bridge_state_string_prefix(
        const struct ast_bridge_snapshot *snapshot,
@@ -123,16 +235,32 @@ struct ast_str *ast_manager_build_bridge_state_string_prefix(
                "%sBridgeUniqueid: %s\r\n"
                "%sBridgeType: %s\r\n"
                "%sBridgeTechnology: %s\r\n"
-               "%sBridgeNumChannels: %d\r\n",
+               "%sBridgeCreator: %s\r\n"
+               "%sBridgeName: %s\r\n"
+               "%sBridgeNumChannels: %u\r\n"
+               "%sBridgeVideoSourceMode: %s\r\n",
                prefix, snapshot->uniqueid,
                prefix, snapshot->subclass,
                prefix, snapshot->technology,
-               prefix, snapshot->num_channels);
+               prefix, ast_strlen_zero(snapshot->creator) ? "<unknown>": snapshot->creator,
+               prefix, ast_strlen_zero(snapshot->name) ? "<unknown>": snapshot->name,
+               prefix, snapshot->num_channels,
+               prefix, ast_bridge_video_mode_to_string(snapshot->video_mode));
        if (!res) {
                ast_free(out);
                return NULL;
        }
 
+       if (snapshot->video_mode != AST_BRIDGE_VIDEO_MODE_NONE
+               && !ast_strlen_zero(snapshot->video_source_id)) {
+               res = ast_str_append(&out, 0, "%sBridgeVideoSource: %s\r\n",
+                       prefix, snapshot->video_source_id);
+               if (!res) {
+                       ast_free(out);
+                       return NULL;
+               }
+       }
+
        return out;
 }
 
@@ -160,6 +288,25 @@ static struct ast_manager_event_blob *bridge_create(
                EVENT_FLAG_CALL, "BridgeCreate", NO_EXTRA_FIELDS);
 }
 
+/* \brief Handle video source updates */
+static struct ast_manager_event_blob *bridge_video_update(
+       struct ast_bridge_snapshot *old_snapshot,
+       struct ast_bridge_snapshot *new_snapshot)
+{
+       if (!new_snapshot || !old_snapshot) {
+               return NULL;
+       }
+
+       if (!strcmp(old_snapshot->video_source_id, new_snapshot->video_source_id)) {
+               return NULL;
+       }
+
+       return ast_manager_event_blob_create(
+               EVENT_FLAG_CALL, "BridgeVideoSourceUpdate",
+               "BridgePreviousVideoSource: %s\r\n",
+               old_snapshot->video_source_id);
+}
+
 /*! \brief Handle bridge destruction */
 static struct ast_manager_event_blob *bridge_destroy(
        struct ast_bridge_snapshot *old_snapshot,
@@ -173,14 +320,13 @@ static struct ast_manager_event_blob *bridge_destroy(
                EVENT_FLAG_CALL, "BridgeDestroy", NO_EXTRA_FIELDS);
 }
 
-
 bridge_snapshot_monitor bridge_monitors[] = {
        bridge_create,
+       bridge_video_update,
        bridge_destroy,
 };
 
 static void bridge_snapshot_update(void *data, struct stasis_subscription *sub,
-                                   struct stasis_topic *topic,
                                    struct stasis_message *message)
 {
        RAII_VAR(struct ast_str *, bridge_event_string, NULL, ast_free);
@@ -221,7 +367,6 @@ static void bridge_snapshot_update(void *data, struct stasis_subscription *sub,
 }
 
 static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
-                                   struct stasis_topic *topic,
                                    struct stasis_message *message)
 {
        struct ast_bridge_merge_message *merge_msg = stasis_message_data(message);
@@ -254,7 +399,6 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
 }
 
 static void channel_enter_cb(void *data, struct stasis_subscription *sub,
-                                   struct stasis_topic *topic,
                                    struct stasis_message *message)
 {
        static const char *swap_name = "SwapUniqueid: ";
@@ -283,7 +427,6 @@ static void channel_enter_cb(void *data, struct stasis_subscription *sub,
 }
 
 static void channel_leave_cb(void *data, struct stasis_subscription *sub,
-                                   struct stasis_topic *topic,
                                    struct stasis_message *message)
 {
        struct ast_bridge_blob *blob = stasis_message_data(message);
@@ -311,12 +454,17 @@ static int filter_bridge_type_cb(void *obj, void *arg, int flags)
        return strcmp(bridge_type, snapshot->technology) ? CMP_MATCH : 0;
 }
 
+struct bridge_list_data {
+       const char *id_text;
+       int count;
+};
+
 static int send_bridge_list_item_cb(void *obj, void *arg, void *data, int flags)
 {
        struct ast_bridge_snapshot *snapshot = stasis_message_data(obj);
        struct mansession *s = arg;
-       char *id_text = data;
-       RAII_VAR(struct ast_str *, bridge_info, ast_manager_build_bridge_state_string(snapshot), ast_free_ptr);
+       struct bridge_list_data *list_data = data;
+       RAII_VAR(struct ast_str *, bridge_info, ast_manager_build_bridge_state_string(snapshot), ast_free);
 
        if (!bridge_info) {
                return 0;
@@ -327,8 +475,9 @@ static int send_bridge_list_item_cb(void *obj, void *arg, void *data, int flags)
                "%s"
                "%s"
                "\r\n",
-               ast_str_buffer(bridge_info),
-               id_text);
+               list_data->id_text,
+               ast_str_buffer(bridge_info));
+       ++list_data->count;
        return 0;
 }
 
@@ -338,6 +487,7 @@ static int manager_bridges_list(struct mansession *s, const struct message *m)
        const char *type_filter = astman_get_header(m, "BridgeType");
        RAII_VAR(struct ast_str *, id_text, ast_str_create(128), ast_free);
        RAII_VAR(struct ao2_container *, bridges, NULL, ao2_cleanup);
+       struct bridge_list_data list_data;
 
        if (!id_text) {
                astman_send_error(s, m, "Internal error");
@@ -354,20 +504,21 @@ static int manager_bridges_list(struct mansession *s, const struct message *m)
                return -1;
        }
 
-       astman_send_ack(s, m, "Bridge listing will follow");
+       astman_send_listack(s, m, "Bridge listing will follow", "start");
 
        if (!ast_strlen_zero(type_filter)) {
                char *type_filter_dup = ast_strdupa(type_filter);
-               ao2_callback(bridges, OBJ_MULTIPLE | OBJ_NODATA | OBJ_UNLINK, filter_bridge_type_cb, type_filter_dup);
+
+               ao2_callback(bridges, OBJ_MULTIPLE | OBJ_NODATA | OBJ_UNLINK,
+                       filter_bridge_type_cb, type_filter_dup);
        }
 
-       ao2_callback_data(bridges, OBJ_NODATA, send_bridge_list_item_cb, s, ast_str_buffer(id_text));
+       list_data.id_text = ast_str_buffer(id_text);
+       list_data.count = 0;
+       ao2_callback_data(bridges, OBJ_NODATA, send_bridge_list_item_cb, s, &list_data);
 
-       astman_append(s,
-               "Event: BridgeListComplete\r\n"
-               "%s"
-               "\r\n",
-               ast_str_buffer(id_text));
+       astman_send_list_complete_start(s, m, "BridgeListComplete", list_data.count);
+       astman_send_list_complete_end(s);
 
        return 0;
 }
@@ -376,13 +527,13 @@ static int send_bridge_info_item_cb(void *obj, void *arg, void *data, int flags)
 {
        char *uniqueid = obj;
        struct mansession *s = arg;
-       char *id_text = data;
+       struct bridge_list_data *list_data = data;
        RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
        struct ast_channel_snapshot *snapshot;
        RAII_VAR(struct ast_str *, channel_text, NULL, ast_free);
+
        msg = stasis_cache_get(ast_channel_cache(),
                ast_channel_snapshot_type(), uniqueid);
-
        if (!msg) {
                return 0;
        }
@@ -402,8 +553,9 @@ static int send_bridge_info_item_cb(void *obj, void *arg, void *data, int flags)
                "%s"
                "%s"
                "\r\n",
-               ast_str_buffer(channel_text),
-               id_text);
+               list_data->id_text,
+               ast_str_buffer(channel_text));
+       ++list_data->count;
        return 0;
 }
 
@@ -415,6 +567,7 @@ static int manager_bridge_info(struct mansession *s, const struct message *m)
        RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
        RAII_VAR(struct ast_str *, bridge_info, NULL, ast_free);
        struct ast_bridge_snapshot *snapshot;
+       struct bridge_list_data list_data;
 
        if (!id_text) {
                astman_send_error(s, m, "Internal error");
@@ -423,7 +576,7 @@ static int manager_bridge_info(struct mansession *s, const struct message *m)
 
        if (ast_strlen_zero(bridge_uniqueid)) {
                astman_send_error(s, m, "BridgeUniqueid must be provided");
-               return -1;
+               return 0;
        }
 
        if (!ast_strlen_zero(id)) {
@@ -433,37 +586,106 @@ static int manager_bridge_info(struct mansession *s, const struct message *m)
        msg = stasis_cache_get(ast_bridge_cache(), ast_bridge_snapshot_type(), bridge_uniqueid);
        if (!msg) {
                astman_send_error(s, m, "Specified BridgeUniqueid not found");
-               return -1;
+               return 0;
        }
 
-       astman_send_ack(s, m, "Bridge channel listing will follow");
-
        snapshot = stasis_message_data(msg);
        bridge_info = ast_manager_build_bridge_state_string(snapshot);
+       if (!bridge_info) {
+               astman_send_error(s, m, "Internal error");
+               return -1;
+       }
 
-       ao2_callback_data(snapshot->channels, OBJ_NODATA, send_bridge_info_item_cb, s, ast_str_buffer(id_text));
+       astman_send_listack(s, m, "Bridge channel listing will follow", "start");
 
-       astman_append(s,
-               "Event: BridgeInfoComplete\r\n"
-               "%s"
-               "%s"
-               "\r\n",
-               S_COR(bridge_info, ast_str_buffer(bridge_info), ""),
-               ast_str_buffer(id_text));
+       list_data.id_text = ast_str_buffer(id_text);
+       list_data.count = 0;
+       ao2_callback_data(snapshot->channels, OBJ_NODATA, send_bridge_info_item_cb, s, &list_data);
+
+       astman_send_list_complete_start(s, m, "BridgeInfoComplete", list_data.count);
+       if (!ast_strlen_zero(ast_str_buffer(bridge_info))) {
+               astman_append(s, "%s", ast_str_buffer(bridge_info));
+       }
+       astman_send_list_complete_end(s);
 
        return 0;
 }
 
-static void manager_bridging_cleanup(void)
+static int manager_bridge_destroy(struct mansession *s, const struct message *m)
 {
-       stasis_unsubscribe(topic_forwarder);
-       topic_forwarder = NULL;
+       const char *bridge_uniqueid = astman_get_header(m, "BridgeUniqueid");
+       struct ast_bridge *bridge;
+
+       if (ast_strlen_zero(bridge_uniqueid)) {
+               astman_send_error(s, m, "BridgeUniqueid must be provided");
+               return 0;
+       }
+
+       bridge = ast_bridge_find_by_id(bridge_uniqueid);
+       if (!bridge) {
+               astman_send_error(s, m, "Specified BridgeUniqueid not found");
+               return 0;
+       }
+       ast_bridge_destroy(bridge, 0);
+
+       astman_send_ack(s, m, "Bridge has been destroyed");
+
+       return 0;
+}
+
+static int manager_bridge_kick(struct mansession *s, const struct message *m)
+{
+       const char *bridge_uniqueid = astman_get_header(m, "BridgeUniqueid");
+       const char *channel_name = astman_get_header(m, "Channel");
+       RAII_VAR(struct ast_bridge *, bridge, NULL, ao2_cleanup);
+       RAII_VAR(struct ast_channel *, channel, NULL, ao2_cleanup);
+
+       if (ast_strlen_zero(channel_name)) {
+               astman_send_error(s, m, "Channel must be provided");
+               return 0;
+       }
+
+       channel = ast_channel_get_by_name(channel_name);
+       if (!channel) {
+               astman_send_error(s, m, "Channel does not exist");
+               return 0;
+       }
+
+       if (ast_strlen_zero(bridge_uniqueid)) {
+               /* get the bridge from the channel */
+               ast_channel_lock(channel);
+               bridge = ast_channel_get_bridge(channel);
+               ast_channel_unlock(channel);
+               if (!bridge) {
+                       astman_send_error(s, m, "Channel is not in a bridge");
+                       return 0;
+               }
+       } else {
+               bridge = ast_bridge_find_by_id(bridge_uniqueid);
+               if (!bridge || ast_test_flag(&bridge->feature_flags, AST_BRIDGE_FLAG_INVISIBLE)) {
+                       astman_send_error(s, m, "Bridge not found");
+                       return 0;
+               }
+       }
+
+       if (ast_bridge_kick(bridge, channel)) {
+               astman_send_error(s, m, "Channel kick from bridge failed");
+               return 0;
+       }
+
+       astman_send_ack(s, m, "Channel has been kicked");
+       return 0;
 }
 
-static void manager_bridging_shutdown(void)
+static void manager_bridging_cleanup(void)
 {
+       stasis_forward_cancel(topic_forwarder);
+       topic_forwarder = NULL;
+
        ast_manager_unregister("BridgeList");
        ast_manager_unregister("BridgeInfo");
+       ast_manager_unregister("BridgeDestroy");
+       ast_manager_unregister("BridgeKick");
 }
 
 int manager_bridging_init(void)
@@ -477,7 +699,6 @@ int manager_bridging_init(void)
                return 0;
        }
 
-       ast_register_atexit(manager_bridging_shutdown);
        ast_register_cleanup(manager_bridging_cleanup);
 
        manager_topic = ast_manager_get_topic();
@@ -514,12 +735,14 @@ int manager_bridging_init(void)
 
        ret |= ast_manager_register_xml_core("BridgeList", 0, manager_bridges_list);
        ret |= ast_manager_register_xml_core("BridgeInfo", 0, manager_bridge_info);
+       ret |= ast_manager_register_xml_core("BridgeDestroy", 0, manager_bridge_destroy);
+       ret |= ast_manager_register_xml_core("BridgeKick", 0, manager_bridge_kick);
 
        /* If somehow we failed to add any routes, just shut down the whole
         * thing and fail it.
         */
        if (ret) {
-               manager_bridging_shutdown();
+               manager_bridging_cleanup();
                return -1;
        }