confbridge: Add 'Admin' param to join, leave, mute, unmute and talking events

Currently there's no way to tell if a user is an admin or not when receiving
the join, leave, mute, unmute and talking events.  This patch adds that
capability.

Tested by: George Joseph
Review: https://reviewboard.asterisk.org/r/3950/
........

Merged revisions 422176 from http://svn.asterisk.org/svn/asterisk/branches/12


git-svn-id: https://origsvn.digium.com/svn/asterisk/branches/13@422177 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_confbridge.c

@@ -445,7 +445,8 @@ const char *conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds
 	return "";
 }
 
-static void send_conf_stasis(struct confbridge_conference *conference, struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *extras, int channel_topic)
+static void send_conf_stasis(struct confbridge_conference *conference, struct ast_channel *chan,
+	struct stasis_message_type *type, struct ast_json *extras, int channel_topic)
 {
 	RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
 	RAII_VAR(struct ast_json *, json_object, NULL, ast_json_unref);
@@ -487,14 +488,32 @@ static void send_conf_end_event(struct confbridge_conference *conference)
 	send_conf_stasis(conference, NULL, confbridge_end_type(), NULL, 0);
 }
 
-static void send_join_event(struct ast_channel *chan, struct confbridge_conference *conference)
+static void send_join_event(struct confbridge_user *user, struct confbridge_conference *conference)
 {
-	send_conf_stasis(conference, chan, confbridge_join_type(), NULL, 0);
+	struct ast_json *json_object;
+
+	json_object = ast_json_pack("{s: b}",
+		"admin", ast_test_flag(&user->u_profile, USER_OPT_ADMIN)
+	);
+	if (!json_object) {
+		return;
+	}
+	send_conf_stasis(conference, user->chan, confbridge_join_type(), json_object, 0);
+	ast_json_unref(json_object);
 }
 
-static void send_leave_event(struct ast_channel *chan, struct confbridge_conference *conference)
+static void send_leave_event(struct confbridge_user *user, struct confbridge_conference *conference)
 {
-	send_conf_stasis(conference, chan, confbridge_leave_type(), NULL, 0);
+	struct ast_json *json_object;
+
+	json_object = ast_json_pack("{s: b}",
+		"admin", ast_test_flag(&user->u_profile, USER_OPT_ADMIN)
+	);
+	if (!json_object) {
+		return;
+	}
+	send_conf_stasis(conference, user->chan, confbridge_leave_type(), json_object, 0);
+	ast_json_unref(json_object);
 }
 
 static void send_start_record_event(struct confbridge_conference *conference)
@@ -507,14 +526,32 @@ static void send_stop_record_event(struct confbridge_conference *conference)
 	send_conf_stasis(conference, NULL, confbridge_stop_record_type(), NULL, 0);
 }
 
-static void send_mute_event(struct ast_channel *chan, struct confbridge_conference *conference)
+static void send_mute_event(struct confbridge_user *user, struct confbridge_conference *conference)
 {
-	send_conf_stasis(conference, chan, confbridge_mute_type(), NULL, 1);
+	struct ast_json *json_object;
+
+	json_object = ast_json_pack("{s: b}",
+		"admin", ast_test_flag(&user->u_profile, USER_OPT_ADMIN)
+	);
+	if (!json_object) {
+		return;
+	}
+	send_conf_stasis(conference, user->chan, confbridge_mute_type(), json_object, 1);
+	ast_json_unref(json_object);
 }
 
-static void send_unmute_event(struct ast_channel *chan, struct confbridge_conference *conference)
+static void send_unmute_event(struct confbridge_user *user, struct confbridge_conference *conference)
 {
-	send_conf_stasis(conference, chan, confbridge_unmute_type(), NULL, 1);
+	struct ast_json *json_object;
+
+	json_object = ast_json_pack("{s: b}",
+		"admin", ast_test_flag(&user->u_profile, USER_OPT_ADMIN)
+	);
+	if (!json_object) {
+		return;
+	}
+	send_conf_stasis(conference, user->chan, confbridge_unmute_type(), json_object, 1);
+	ast_json_unref(json_object);
 }
 
 static void set_rec_filename(struct confbridge_conference *conference, struct ast_str **filename, int is_new)
@@ -1454,25 +1491,21 @@ static int play_sound_number(struct confbridge_conference *conference, int say_n
 	return play_sound_helper(conference, NULL, say_number);
 }
 
-static void conf_handle_talker_destructor(void *pvt_data)
-{
-	ast_free(pvt_data);
-}
-
 static int conf_handle_talker_cb(struct ast_bridge_channel *bridge_channel, void *hook_pvt, int talking)
 {
-	const char *conf_name = hook_pvt;
+	const struct confbridge_user *user = hook_pvt;
 	RAII_VAR(struct confbridge_conference *, conference, NULL, ao2_cleanup);
 	struct ast_json *talking_extras;
 
-	conference = ao2_find(conference_bridges, conf_name, OBJ_KEY);
+	conference = ao2_find(conference_bridges, user->conference->name, OBJ_KEY);
 	if (!conference) {
 		/* Remove the hook since the conference does not exist. */
 		return -1;
 	}
 
-	talking_extras = ast_json_pack("{s: s}",
+	talking_extras = ast_json_pack("{s: s, s: b}",
-		"talking_status", talking ? "on" : "off");
+		"talking_status", talking ? "on" : "off",
+		"admin", ast_test_flag(&user->u_profile, USER_OPT_ADMIN));
 	if (!talking_extras) {
 		return 0;
 	}
@@ -1688,17 +1721,9 @@ static int confbridge_exec(struct ast_channel *chan, const char *data)
 
 	/* Set a talker indicate call back if talking detection is requested */
 	if (ast_test_flag(&user.u_profile, USER_OPT_TALKER_DETECT)) {
-		char *conf_name = ast_strdup(args.conf_name); /* this is freed during feature cleanup */
-
-		if (!conf_name) {
-			pbx_builtin_setvar_helper(chan, "CONFBRIDGE_RESULT", "FAILED");
-			res = -1;
-			goto confbridge_cleanup;
-		}
 		if (ast_bridge_talk_detector_hook(&user.features, conf_handle_talker_cb,
-			conf_name, conf_handle_talker_destructor, AST_BRIDGE_HOOK_REMOVE_ON_PULL)) {
+			&user, NULL, AST_BRIDGE_HOOK_REMOVE_ON_PULL)) {
 			pbx_builtin_setvar_helper(chan, "CONFBRIDGE_RESULT", "FAILED");
-			ast_free(conf_name);
 			res = -1;
 			goto confbridge_cleanup;
 		}
@@ -1767,7 +1792,7 @@ static int confbridge_exec(struct ast_channel *chan, const char *data)
 	conf_moh_unsuspend(&user);
 
 	/* Join our conference bridge for real */
-	send_join_event(user.chan, conference);
+	send_join_event(&user, conference);
 	ast_bridge_join(conference->bridge,
 		chan,
 		NULL,
@@ -1779,7 +1804,7 @@ static int confbridge_exec(struct ast_channel *chan, const char *data)
 		pbx_builtin_setvar_helper(chan, "CONFBRIDGE_RESULT", "HANGUP");
 	}
 
-	send_leave_event(user.chan, conference);
+	send_leave_event(&user, conference);
 
 	/* if we're shutting down, don't attempt to do further processing */
 	if (ast_shutting_down()) {
@@ -1838,8 +1863,7 @@ confbridge_cleanup:
 }
 
 static int action_toggle_mute(struct confbridge_conference *conference,
-	struct confbridge_user *user,
+	struct confbridge_user *user)
-	struct ast_channel *chan)
 {
 	int mute;
 
@@ -1852,17 +1876,17 @@ static int action_toggle_mute(struct confbridge_conference *conference,
 		"Message: participant %s %s\r\n"
 		"Conference: %s\r\n"
 		"Channel: %s",
-		ast_channel_name(chan),
+		ast_channel_name(user->chan),
 		mute ? "muted" : "unmuted",
 		user->b_profile.name,
-		ast_channel_name(chan));
+		ast_channel_name(user->chan));
 	if (mute) {
-		send_mute_event(chan, conference);
+		send_mute_event(user, conference);
 	} else {
-		send_unmute_event(chan, conference);
+		send_unmute_event(user, conference);
 	}
 
-	return ast_stream_and_wait(chan, (mute ?
+	return ast_stream_and_wait(user->chan, (mute ?
 		conf_get_sound(CONF_SOUND_MUTED, user->b_profile.sounds) :
 		conf_get_sound(CONF_SOUND_UNMUTED, user->b_profile.sounds)),
 		"");
@@ -2080,9 +2104,7 @@ static int execute_menu_entry(struct confbridge_conference *conference,
 	AST_LIST_TRAVERSE(&menu_entry->actions, menu_action, action) {
 		switch (menu_action->id) {
 		case MENU_ACTION_TOGGLE_MUTE:
-			res |= action_toggle_mute(conference,
+			res |= action_toggle_mute(conference, user);
-				user,
-				bridge_channel->chan);
 			break;
 		case MENU_ACTION_ADMIN_TOGGLE_MUTE_PARTICIPANTS:
 			if (!isadmin) {
@@ -2494,9 +2516,9 @@ static void generic_mute_unmute_user(struct confbridge_conference *conference, s
 		conference->b_profile.name,
 		ast_channel_name(user->chan));
 	if (mute) {
-		send_mute_event(user->chan, conference);
+		send_mute_event(user, conference);
 	} else {
-		send_unmute_event(user->chan, conference);
+		send_unmute_event(user, conference);
 	}
 }
 

apps/confbridge/confbridge_manager.c

@@ -76,6 +76,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 				</parameter>
 				<bridge_snapshot/>
 				<channel_snapshot/>
+				<parameter name="Admin">
+					<para>Identifies this user as an admin user.</para>
+					<enumlist>
+						<enum name="Yes"/>
+						<enum name="No"/>
+					</enumlist>
+				</parameter>
 			</syntax>
 			<see-also>
 				<ref type="managerEvent">ConfbridgeLeave</ref>
@@ -92,6 +99,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 				</parameter>
 				<bridge_snapshot/>
 				<channel_snapshot/>
+				<parameter name="Admin">
+					<para>Identifies this user as an admin user.</para>
+					<enumlist>
+						<enum name="Yes"/>
+						<enum name="No"/>
+					</enumlist>
+				</parameter>
 			</syntax>
 			<see-also>
 				<ref type="managerEvent">ConfbridgeJoin</ref>
@@ -138,6 +152,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 				</parameter>
 				<bridge_snapshot/>
 				<channel_snapshot/>
+				<parameter name="Admin">
+					<para>Identifies this user as an admin user.</para>
+					<enumlist>
+						<enum name="Yes"/>
+						<enum name="No"/>
+					</enumlist>
+				</parameter>
 			</syntax>
 			<see-also>
 				<ref type="managerEvent">ConfbridgeUnmute</ref>
@@ -154,6 +175,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 				</parameter>
 				<bridge_snapshot/>
 				<channel_snapshot/>
+				<parameter name="Admin">
+					<para>Identifies this user as an admin user.</para>
+					<enumlist>
+						<enum name="Yes"/>
+						<enum name="No"/>
+					</enumlist>
+				</parameter>
 			</syntax>
 			<see-also>
 				<ref type="managerEvent">ConfbridgeMute</ref>
@@ -176,6 +204,13 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 						<enum name="off"/>
 					</enumlist>
 				</parameter>
+				<parameter name="Admin">
+					<para>Identifies this user as an admin user.</para>
+					<enumlist>
+						<enum name="Yes"/>
+						<enum name="No"/>
+					</enumlist>
+				</parameter>
 			</syntax>
 			<see-also>
 				<ref type="application">ConfBridge</ref>
@@ -223,6 +258,18 @@ static void confbridge_publish_manager_event(
 		S_COR(extra_text, ast_str_buffer(extra_text), ""));
 }
 
+static int get_admin_header(struct ast_str **extra_text, struct stasis_message *message)
+{
+	const struct ast_bridge_blob *blob = stasis_message_data(message);
+	const struct ast_json *admin = ast_json_object_get(blob->blob, "admin");
+	if (!admin) {
+		return -1;
+	}
+
+	return ast_str_append_event_header(extra_text, "Admin",
+		S_COR(ast_json_is_true(admin), "Yes", "No"));
+}
+
 static void confbridge_start_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
@@ -238,13 +285,23 @@ static void confbridge_end_cb(void *data, struct stasis_subscription *sub,
 static void confbridge_leave_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
-	confbridge_publish_manager_event(message, "ConfbridgeLeave", NULL);
+	struct ast_str *extra_text = NULL;
+
+	if (!get_admin_header(&extra_text, message)) {
+		confbridge_publish_manager_event(message, "ConfbridgeLeave", extra_text);
+	}
+	ast_free(extra_text);
 }
 
 static void confbridge_join_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
-	confbridge_publish_manager_event(message, "ConfbridgeJoin", NULL);
+	struct ast_str *extra_text = NULL;
+
+	if (!get_admin_header(&extra_text, message)) {
+		confbridge_publish_manager_event(message, "ConfbridgeJoin", extra_text);
+	}
+	ast_free(extra_text);
 }
 
 static void confbridge_start_record_cb(void *data, struct stasis_subscription *sub,
@@ -262,20 +319,30 @@ static void confbridge_stop_record_cb(void *data, struct stasis_subscription *su
 static void confbridge_mute_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
-	confbridge_publish_manager_event(message, "ConfbridgeMute", NULL);
+	struct ast_str *extra_text = NULL;
+
+	if (!get_admin_header(&extra_text, message)) {
+		confbridge_publish_manager_event(message, "ConfbridgeMute", extra_text);
+	}
+	ast_free(extra_text);
 }
 
 static void confbridge_unmute_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
-	confbridge_publish_manager_event(message, "ConfbridgeUnmute", NULL);
+	struct ast_str *extra_text = NULL;
+
+	if (!get_admin_header(&extra_text, message)) {
+		confbridge_publish_manager_event(message, "ConfbridgeUnmute", extra_text);
+	}
+	ast_free(extra_text);
 }
 
 static void confbridge_talking_cb(void *data, struct stasis_subscription *sub,
 	struct stasis_message *message)
 {
 	RAII_VAR(struct ast_str *, extra_text, NULL, ast_free);
-	struct ast_bridge_blob *blob = stasis_message_data(message);
+	const struct ast_bridge_blob *blob = stasis_message_data(message);
 	const char *talking_status = ast_json_string_get(ast_json_object_get(blob->blob, "talking_status"));
 	if (!talking_status) {
 		return;
@@ -286,7 +353,9 @@ static void confbridge_talking_cb(void *data, struct stasis_subscription *sub,
 		return;
 	}
 
-	confbridge_publish_manager_event(message, "ConfbridgeTalking", extra_text);
+	if (!get_admin_header(&extra_text, message)) {
+		confbridge_publish_manager_event(message, "ConfbridgeTalking", extra_text);
+	}
 }
 
 STASIS_MESSAGE_TYPE_DEFN(confbridge_start_type);