ConfBridge: Correct prompt playback target

Currently, when the first marked user enters the conference that
contains waitmarked users, a prompt is played indicating that the user
is being placed into the conference. Unfortunately, this prompt is
played to the marked user and not the waitmarked users which is not
very helpful.

This patch changes that behavior to play a prompt stating
"The conference will now begin" to the entire conference after adding
and unmuting the waitmarked users since the design of confbridge is not
conducive to playing a prompt to a subset of users in a conference in
an asynchronous manner.

(closes issue PQ-1396)
Review: https://reviewboard.asterisk.org/r/3155/
Reported by: Steve Pitts
........

Merged revisions 407857 from http://svn.asterisk.org/svn/asterisk/branches/11

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

diff --git a/UPGRADE.txt b/UPGRADE.txt
index a293ffaa938a18e4715191b3a35c5fd4a3ebd1b0..67a7a7bd83b6620f534831f94aeab3b21575ad15 100644 (file)
--- a/UPGRADE.txt
+++ b/UPGRADE.txt
@@ -21,6 +21,11 @@
 ===
 ===========================================================
 From 12.0.0 to 12.1.0:
+* The sound_place_into_conference sound used in Confbridge is now deprecated
+  and is no longer functional since it has been broken since its inception
+  and the fix involved using a different method to achieve the same goal. The
+  new method to achieve this functionality is by using sound_begin to play
+  a sound to the conference when waitmarked users are moved into the conference.
 
 - The per console verbose level feature as previously implemented caused a
   large performance penalty.  The fix required some minor incompatibilities

diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c
index 20ceb38f80dda42b950fdf77be9bea05f808736e..e69189b668025040f0e353e30ba1701cafad2630 100644 (file)
--- a/apps/app_confbridge.c
+++ b/apps/app_confbridge.c
@@ -416,6 +416,8 @@ const char *conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds
                return S_OR(custom_sounds->participantsmuted, "conf-now-muted");
        case CONF_SOUND_PARTICIPANTS_UNMUTED:
                return S_OR(custom_sounds->participantsunmuted, "conf-now-unmuted");
+       case CONF_SOUND_BEGIN:
+               return S_OR(custom_sounds->begin, "confbridge-conf-begin");
        }
 
        return "";
@@ -1083,14 +1085,6 @@ static void conf_moh_suspend(struct confbridge_user *user)
        ao2_unlock(user->conference);
 }
 
-int conf_handle_first_marked_common(struct confbridge_user *user)
-{
-       if (!ast_test_flag(&user->u_profile, USER_OPT_QUIET) && play_prompt_to_user(user, conf_get_sound(CONF_SOUND_PLACE_IN_CONF, user->b_profile.sounds))) {
-               return -1;
-       }
-       return 0;
-}
-
 int conf_handle_inactive_waitmarked(struct confbridge_user *user)
 {
        /* If we have not been quieted play back that they are waiting for the leader */

diff --git a/apps/confbridge/conf_config_parser.c b/apps/confbridge/conf_config_parser.c
index 695d20ce6df75b8b7b7886398fcab1350714c8df..7b6e731902fdbd6350e39f32bd46ab984b26087f 100644 (file)
--- a/apps/confbridge/conf_config_parser.c
+++ b/apps/confbridge/conf_config_parser.c
@@ -867,6 +867,12 @@ static int set_sound(const char *sound_name, const char *sound_file, struct brid
        } else if (!strcasecmp(sound_name, "sound_other_in_party")) {
                ast_string_field_set(sounds, otherinparty, sound_file);
        } else if (!strcasecmp(sound_name, "sound_place_into_conference")) {
+               static int deprecation_warning = 1;
+               if (deprecation_warning) {
+                       ast_log(LOG_WARNING, "sound_place_into_conference is deprecated"
+                               " and unused. Use sound_begin for similar functionality.");
+                       deprecation_warning = 0;
+               }
                ast_string_field_set(sounds, placeintoconf, sound_file);
        } else if (!strcasecmp(sound_name, "sound_wait_for_leader")) {
                ast_string_field_set(sounds, waitforleader, sound_file);
@@ -892,6 +898,8 @@ static int set_sound(const char *sound_name, const char *sound_file, struct brid
                ast_string_field_set(sounds, participantsmuted, sound_file);
        } else if (!strcasecmp(sound_name, "sound_participants_unmuted")) {
                ast_string_field_set(sounds, participantsunmuted, sound_file);
+       } else if (!strcasecmp(sound_name, "sound_begin")) {
+               ast_string_field_set(sounds, begin, sound_file);
        } else {
                return -1;
        }
@@ -1509,6 +1517,7 @@ static char *handle_cli_confbridge_show_bridge_profile(struct ast_cli_entry *e,
        ast_cli(a->fd,"sound_leave:          %s\n", conf_get_sound(CONF_SOUND_LEAVE, b_profile.sounds));
        ast_cli(a->fd,"sound_participants_muted:     %s\n", conf_get_sound(CONF_SOUND_PARTICIPANTS_MUTED, b_profile.sounds));
        ast_cli(a->fd,"sound_participants_unmuted:     %s\n", conf_get_sound(CONF_SOUND_PARTICIPANTS_UNMUTED, b_profile.sounds));
+       ast_cli(a->fd,"sound_begin:          %s\n", conf_get_sound(CONF_SOUND_BEGIN, b_profile.sounds));
        ast_cli(a->fd,"\n");
 
        conf_bridge_profile_destroy(&b_profile);
@@ -1851,6 +1860,7 @@ static int bridge_template_handler(const struct aco_option *opt, struct ast_vari
        ast_string_field_set(sounds, leave, b_profile->sounds->leave);
        ast_string_field_set(sounds, participantsmuted, b_profile->sounds->participantsmuted);
        ast_string_field_set(sounds, participantsunmuted, b_profile->sounds->participantsunmuted);
+       ast_string_field_set(sounds, begin, b_profile->sounds->begin);
 
        ao2_ref(b_profile->sounds, -1); /* sounds struct copied over to it from the template by reference only. */
        ao2_ref(oldsounds, -1);    /* original sounds struct we don't need anymore */

diff --git a/apps/confbridge/conf_state_empty.c b/apps/confbridge/conf_state_empty.c
index bd1309bfdc5e704f9dca68f475adc605a6da93c0..285f22abbee75a3631ea2e8719e0c6c12b621b46 100644 (file)
--- a/apps/confbridge/conf_state_empty.c
+++ b/apps/confbridge/conf_state_empty.c
@@ -73,7 +73,6 @@ static void join_marked(struct confbridge_user *user)
 {
        conf_add_user_marked(user->conference, user);
        conf_handle_first_join(user->conference);
-       conf_add_post_join_action(user, conf_handle_first_marked_common);
 
        conf_change_state(user, CONF_STATE_SINGLE_MARKED);
 }

diff --git a/apps/confbridge/conf_state_multi_marked.c b/apps/confbridge/conf_state_multi_marked.c
index ba8ad6d2bcb96e756716fdad569f07af6a0dc18b..bcf25de0468c52d2538d266013be6369ead654a5 100644 (file)
--- a/apps/confbridge/conf_state_multi_marked.c
+++ b/apps/confbridge/conf_state_multi_marked.c
@@ -169,14 +169,21 @@ static void leave_marked(struct confbridge_user *user)
        }
 }
 
+static int post_join_play_begin(struct confbridge_user *cbu)
+{
+       int res;
+
+       ast_autoservice_start(cbu->chan);
+       res = play_sound_file(cbu->conference,
+               conf_get_sound(CONF_SOUND_BEGIN, cbu->b_profile.sounds));
+       ast_autoservice_stop(cbu->chan);
+       return res;
+}
+
 static void transition_to_marked(struct confbridge_user *user)
 {
        struct confbridge_user *user_iter;
-
-       /* Play the audio file stating they are going to be placed into the conference */
-       if (user->conference->markedusers == 1 && ast_test_flag(&user->u_profile, USER_OPT_MARKEDUSER)) {
-               conf_handle_first_marked_common(user);
-       }
+       int waitmarked_moved = 0;
 
        /* Move all waiting users to active, stopping MOH and unmuting if necessary */
        AST_LIST_TRAVERSE_SAFE_BEGIN(&user->conference->waiting_list, user_iter, list) {
@@ -188,6 +195,15 @@ static void transition_to_marked(struct confbridge_user *user)
                        conf_moh_stop(user_iter);
                }
                conf_update_user_mute(user_iter);
+               waitmarked_moved++;
        }
        AST_LIST_TRAVERSE_SAFE_END;
+
+       /* Play the audio file stating that the conference is beginning */
+       if (user->conference->markedusers == 1
+               && ast_test_flag(&user->u_profile, USER_OPT_MARKEDUSER)
+               && !ast_test_flag(&user->u_profile, USER_OPT_QUIET)
+               && waitmarked_moved) {
+               conf_add_post_join_action(user, post_join_play_begin);
+       }
 }

diff --git a/apps/confbridge/include/confbridge.h b/apps/confbridge/include/confbridge.h
index 5f94cd5ee6e06c7f530f79c3d26273ced8bc3986..932fdad5cce9f53d16d1b5b21017c14354fd8178 100644 (file)
--- a/apps/confbridge/include/confbridge.h
+++ b/apps/confbridge/include/confbridge.h
@@ -161,6 +161,7 @@ enum conf_sounds {
        CONF_SOUND_LEAVE,
        CONF_SOUND_PARTICIPANTS_MUTED,
        CONF_SOUND_PARTICIPANTS_UNMUTED,
+       CONF_SOUND_BEGIN,
 };
 
 struct bridge_profile_sounds {
@@ -187,6 +188,7 @@ struct bridge_profile_sounds {
                AST_STRING_FIELD(join);
                AST_STRING_FIELD(participantsmuted);
                AST_STRING_FIELD(participantsunmuted);
+               AST_STRING_FIELD(begin);
        );
 };
 
@@ -399,13 +401,6 @@ void conf_moh_start(struct confbridge_user *user);
  */
 void conf_mute_only_active(struct confbridge_conference *conference);
 
-/*! \brief Callback to execute any time we transition from zero to one marked users
- * \param user The first marked user joining the conference
- * \retval 0 success
- * \retval -1 failure
- */
-int conf_handle_first_marked_common(struct confbridge_user *user);
-
 /*! \brief Callback to execute any time we transition from zero to one active users
  * \param conference The conference bridge with a single active user joined
  * \retval 0 success

diff --git a/configs/confbridge.conf.sample b/configs/confbridge.conf.sample
index 94739a6fe5e220030129e3447fbca8f2d67a8753..9e90e61168c90dd741d747c3999322dbffc1e357 100644 (file)
--- a/configs/confbridge.conf.sample
+++ b/configs/confbridge.conf.sample
@@ -227,7 +227,9 @@ type=bridge
                        ; The sounds are stringed together like this.
                        ; "sound_there_are" <number of participants> "sound_other_in_party"
 ;sound_place_into_conference ; The sound played when someone is placed into the conference
-                             ; after waiting for a marked user.
+                             ; after waiting for a marked user. This sound is now deprecated
+                             ; since it was only ever used improperly and correcting that bug
+                             ; made it completely unused.
 ;sound_wait_for_leader  ; The sound played when a user is placed into a conference that
                         ; can not start until a marked user enters.
 ;sound_leader_has_left  ; The sound played when the last marked user leaves the conference.
@@ -237,6 +239,7 @@ type=bridge
 ;sound_locked_now ; The sound played to an admin after toggling the conference to locked mode.
 ;sound_unlocked_now; The sound played to an admin after toggling the conference to unlocked mode.
 ;sound_error_menu ; The sound played when an invalid menu option is entered.
+;sound_begin ; The sound played to the conference when the first marked user enters the conference.
 
 ; --- ConfBridge Menu Options ---
 ; The ConfBridge application also has the ability to