Merge pull request #20405 from gustavotrott/backport-allowPromoteGuestToModerator-27

feat (backport 2.7): Introduces `allowPromoteGuestToModerator` config

akka-bbb-apps/src/main/scala/org/bigbluebutton/core/apps/users/ChangeUserRoleCmdMsgHdlr.scala

@@ -30,7 +30,7 @@ trait ChangeUserRoleCmdMsgHdlr extends RightsManagementTrait {
         } yield {
           RegisteredUsers.updateUserRole(liveMeeting.registeredUsers, u, userRole)
         }
-        val promoteGuest = !liveMeeting.props.usersProp.authenticatedGuest
+        val promoteGuest = !liveMeeting.props.usersProp.authenticatedGuest || liveMeeting.props.usersProp.allowPromoteGuestToModerator
         if (msg.body.role == Roles.MODERATOR_ROLE && (!uvo.guest || promoteGuest)) {
           // Promote non-guest users.
           val notifyEvent = MsgBuilder.buildNotifyUserInMeetingEvtMsg(

akka-bbb-apps/src/main/scala/org/bigbluebutton/core/running/MeetingActor.scala

@@ -399,7 +399,7 @@ class MeetingActor(
       case m: ChangeUserPinStateReqMsg      => usersApp.handleChangeUserPinStateReqMsg(m)
       case m: ChangeUserMobileFlagReqMsg    => usersApp.handleChangeUserMobileFlagReqMsg(m)
       case m: SetUserSpeechLocaleReqMsg     => usersApp.handleSetUserSpeechLocaleReqMsg(m)
-      case m: SetUserSpeechOptionsReqMsg => usersApp.handleSetUserSpeechOptionsReqMsg(m)
+      case m: SetUserSpeechOptionsReqMsg    => usersApp.handleSetUserSpeechOptionsReqMsg(m)
 
       // Client requested to eject user
       case m: EjectUserFromMeetingCmdMsg =>

akka-bbb-apps/src/test/scala/org/bigbluebutton/core/AppsTestFixtures.scala

@@ -44,6 +44,7 @@ trait AppsTestFixtures {
   val allowModsToUnmuteUsers = false
   val allowModsToEjectCameras = false
   val authenticatedGuest = false
+  val allowPromoteGuestToModerator = false
   val meetingLayout = ""
   val captureNotesFilename = s"Room 0${sequence} (Notes)"
   val captureSlidesFilename = s"Room 0${sequence} (Whiteboard)"
@@ -70,7 +71,7 @@ trait AppsTestFixtures {
   val usersProp = UsersProp(maxUsers = maxUsers, webcamsOnlyForModerator = webcamsOnlyForModerator,
     userCameraCap = userCameraCap,
     guestPolicy = guestPolicy, allowModsToUnmuteUsers = allowModsToUnmuteUsers, allowModsToEjectCameras = allowModsToEjectCameras,
-    authenticatedGuest = authenticatedGuest, meetingLayout = meetingLayout)
+    authenticatedGuest = authenticatedGuest, allowPromoteGuestToModerator = allowPromoteGuestToModerator, meetingLayout = meetingLayout)
   val metadataProp = new MetadataProp(metadata)
 
   val defaultProps = DefaultProps(meetingProp, breakoutProps, durationProps, password, recordProp, welcomeProp, voiceProp,

bbb-common-message/src/main/scala/org/bigbluebutton/common2/domain/Meeting2x.scala

@@ -41,15 +41,16 @@ case class WelcomeProp(welcomeMsgTemplate: String, welcomeMsg: String, modOnlyMe
 case class VoiceProp(telVoice: String, voiceConf: String, dialNumber: String, muteOnStart: Boolean)
 
 case class UsersProp(
-    maxUsers:                 Int,
+    maxUsers:                     Int,
-    maxUserConcurrentAccesses:Int,
+    maxUserConcurrentAccesses:    Int,
-    webcamsOnlyForModerator:  Boolean,
+    webcamsOnlyForModerator:      Boolean,
-    userCameraCap:            Int,
+    userCameraCap:                Int,
-    guestPolicy:              String,
+    guestPolicy:                  String,
-    meetingLayout:            String,
+    meetingLayout:                String,
-    allowModsToUnmuteUsers:   Boolean,
+    allowModsToUnmuteUsers:       Boolean,
-    allowModsToEjectCameras:  Boolean,
+    allowModsToEjectCameras:      Boolean,
-    authenticatedGuest:       Boolean
+    authenticatedGuest:           Boolean,
+    allowPromoteGuestToModerator: Boolean
 )
 
 case class MetadataProp(metadata: collection.immutable.Map[String, String])

bbb-common-message/src/test/scala/org/bigbluebutton/common2/TestFixtures.scala

@@ -44,6 +44,7 @@ trait TestFixtures {
   val keepEvents = false
   val guestPolicy = "ALWAYS_ASK"
   val authenticatedGuest = false
+  val allowPromoteGuestToModerator = false
   val metadata: collection.immutable.Map[String, String] = Map("foo" -> "bar", "bar" -> "baz", "baz" -> "foo")
   val captureNotesFilename = s"Room 0${sequence} (Notes)"
   val captureSlidesFilename = s"Room 0${sequence} (Whiteboard)"
@@ -71,7 +72,8 @@ trait TestFixtures {
   val voiceProp = VoiceProp(telVoice = voiceConfId, voiceConf = voiceConfId, dialNumber = dialNumber, muteOnStart = muteOnStart)
   val usersProp = UsersProp(maxUsers = maxUsers, webcamsOnlyForModerator = webcamsOnlyForModerator,
     userCameraCap = userCameraCap,
-    guestPolicy = guestPolicy, allowModsToUnmuteUsers = allowModsToUnmuteUsers, allowModsToEjectCameras = allowModsToEjectCameras, authenticatedGuest = authenticatedGuest)
+    guestPolicy = guestPolicy, allowModsToUnmuteUsers = allowModsToUnmuteUsers, allowModsToEjectCameras = allowModsToEjectCameras,
+    authenticatedGuest = authenticatedGuest, allowPromoteGuestToModerator = allowPromoteGuestToModerator)
   val metadataProp = new MetadataProp(metadata)
   val defaultProps = DefaultProps(meetingProp, breakoutProps, durationProps, password, recordProp, welcomeProp, voiceProp,
     usersProp, metadataProp)

bbb-common-web/src/main/java/org/bigbluebutton/api/ApiParams.java

@@ -33,6 +33,7 @@ public class ApiParams {
     public static final String FREE_JOIN = "freeJoin";
     public static final String FULL_NAME = "fullName";
     public static final String GUEST_POLICY = "guestPolicy";
+    public static final String ALLOW_PROMOTE_GUEST_TO_MODERATOR = "allowPromoteGuestToModerator";
     public static final String MEETING_LAYOUT = "meetingLayout";
     public static final String IS_BREAKOUT = "isBreakout";
     public static final String LOGO = "logo";

bbb-common-web/src/main/java/org/bigbluebutton/api/MeetingService.java

@@ -401,10 +401,12 @@ public class MeetingService implements MessageListener {
     gw.createMeeting(m.getInternalId(), m.getExternalId(), m.getParentMeetingId(), m.getName(), m.isRecord(),
             m.getTelVoice(), m.getDuration(), m.getAutoStartRecording(), m.getAllowStartStopRecording(),
             m.getRecordFullDurationMedia(),
-            m.getWebcamsOnlyForModerator(), m.getMeetingCameraCap(), m.getUserCameraCap(), m.getMaxPinnedCameras(), m.getModeratorPassword(), m.getViewerPassword(),
+            m.getWebcamsOnlyForModerator(), m.getMeetingCameraCap(), m.getUserCameraCap(), m.getMaxPinnedCameras(),
+            m.getModeratorPassword(), m.getViewerPassword(),
             m.getLearningDashboardAccessToken(), m.getCreateTime(),
             formatPrettyDate(m.getCreateTime()), m.isBreakout(), m.getSequence(), m.isFreeJoin(), m.getMetadata(),
-            m.getGuestPolicy(), m.getAuthenticatedGuest(), m.getMeetingLayout(), m.getWelcomeMessageTemplate(), m.getWelcomeMessage(), m.getModeratorOnlyMessage(),
+            m.getGuestPolicy(), m.getAuthenticatedGuest(), m.getAllowPromoteGuestToModerator(), m.getMeetingLayout(),
+            m.getWelcomeMessageTemplate(), m.getWelcomeMessage(), m.getModeratorOnlyMessage(),
             m.getDialNumber(), m.getMaxUsers(), m.getMaxUserConcurrentAccesses(),
             m.getMeetingExpireIfNoUserJoinedInMinutes(), m.getMeetingExpireWhenLastUserLeftInMinutes(),
             m.getUserInactivityInspectTimerInMinutes(), m.getUserInactivityThresholdInMinutes(),

bbb-common-web/src/main/java/org/bigbluebutton/api/ParamsProcessorUtil.java

@@ -86,6 +86,7 @@ public class ParamsProcessorUtil {
     private String defaultAvatarURL;
     private String defaultGuestPolicy;
     private Boolean authenticatedGuest;
+    private Boolean defaultAllowPromoteGuestToModerator;
     private String defaultMeetingLayout;
     private int defaultMeetingDuration;
     private boolean disableRecordingDefault;
@@ -676,7 +677,12 @@ public class ParamsProcessorUtil {
         String guestPolicy = defaultGuestPolicy;
         if (!StringUtils.isEmpty(params.get(ApiParams.GUEST_POLICY))) {
         	guestPolicy = params.get(ApiParams.GUEST_POLICY);
-		    }
+		}
+
+        Boolean allowPromoteGuestToModerator = defaultAllowPromoteGuestToModerator;
+        if (!StringUtils.isEmpty(params.get(ApiParams.ALLOW_PROMOTE_GUEST_TO_MODERATOR))) {
+            allowPromoteGuestToModerator = Boolean.parseBoolean(params.get(ApiParams.ALLOW_PROMOTE_GUEST_TO_MODERATOR));
+        }
 
         String presentationUploadExternalDescription = defaultPresentationUploadExternalDescription;
         if (!StringUtils.isEmpty(params.get(ApiParams.PRESENTATION_UPLOAD_EXTERNAL_DESCRIPTION))) {
@@ -766,6 +772,7 @@ public class ParamsProcessorUtil {
                 .withWelcomeMessage(welcomeMessage).isBreakout(isBreakout)
                 .withGuestPolicy(guestPolicy)
                 .withAuthenticatedGuest(authenticatedGuest)
+                .withAllowPromoteGuestToModerator(allowPromoteGuestToModerator)
                 .withAllowRequestsWithoutSession(allowRequestsWithoutSession)
                 .withMeetingLayout(meetingLayout)
 				.withBreakoutRoomsParams(breakoutParams)
@@ -1297,7 +1304,11 @@ public class ParamsProcessorUtil {
 		this.authenticatedGuest = value;
 	}
 
-  public void setDefaultMeetingLayout(String meetingLayout) {
+    public void setDefaultAllowPromoteGuestToModerator(Boolean value) {
+        this.defaultAllowPromoteGuestToModerator = value;
+    }
+
+	public void setDefaultMeetingLayout(String meetingLayout) {
 		this.defaultMeetingLayout =  meetingLayout;
 	}
 

bbb-common-web/src/main/java/org/bigbluebutton/api/domain/Meeting.java

@@ -83,6 +83,7 @@ public class Meeting {
 	private String guestLobbyMessage = "";
 	private Map<String,String> usersWithGuestLobbyMessages;
 	private Boolean authenticatedGuest = false;
+	private Boolean allowPromoteGuestToModerator = false;
 	private String meetingLayout = MeetingLayout.SMART_LAYOUT;
 	private boolean userHasJoined = false;
 	private Map<String, String> guestUsersWithPositionInWaitingLine;
@@ -166,6 +167,7 @@ public class Meeting {
         isBreakout = builder.isBreakout;
         guestPolicy = builder.guestPolicy;
         authenticatedGuest = builder.authenticatedGuest;
+		allowPromoteGuestToModerator = builder.allowPromoteGuestToModerator;
 		meetingLayout = builder.meetingLayout;
         allowRequestsWithoutSession = builder.allowRequestsWithoutSession;
         breakoutRoomsParams = builder.breakoutRoomsParams;
@@ -499,6 +501,14 @@ public class Meeting {
 		return authenticatedGuest;
 	}
 
+	public void setAllowPromoteGuestToModerator(Boolean value) {
+		allowPromoteGuestToModerator = value;
+	}
+
+	public Boolean getAllowPromoteGuestToModerator() {
+		return allowPromoteGuestToModerator;
+	}
+
 	public void setMeetingLayout(String layout) {
 		meetingLayout = layout;
 	}
@@ -903,6 +913,7 @@ public class Meeting {
     	private boolean isBreakout;
     	private String guestPolicy;
     	private Boolean authenticatedGuest;
+		private Boolean allowPromoteGuestToModerator;
     	private Boolean allowRequestsWithoutSession;
 		private String meetingLayout;
     	private BreakoutRoomsParams breakoutRoomsParams;
@@ -1085,15 +1096,20 @@ public class Meeting {
     		return this;
     	}
 
-    	public Builder withAllowRequestsWithoutSession(Boolean value) {
+		public Builder withAllowPromoteGuestToModerator(Boolean value) {
+			allowPromoteGuestToModerator = value;
+			return this;
+		}
+
+		public Builder withAllowRequestsWithoutSession(Boolean value) {
     		allowRequestsWithoutSession = value;
     		return this;
     	}
 
-			public Builder withMeetingLayout(String layout) {
+		public Builder withMeetingLayout(String layout) {
-				meetingLayout = layout;
+			meetingLayout = layout;
-				return this;
+			return this;
-			}
+		}
 
 		public Builder withBreakoutRoomsParams(BreakoutRoomsParams params) {
     		breakoutRoomsParams = params;

bbb-common-web/src/main/java/org/bigbluebutton/api2/IBbbWebApiGWApp.java

@@ -26,7 +26,8 @@ public interface IBbbWebApiGWApp {
                      Integer maxPinnedCameras,
                      String moderatorPass, String viewerPass, String learningDashboardAccessToken, Long createTime,
                      String createDate, Boolean isBreakout, Integer sequence, Boolean freejoin, Map<String, String> metadata,
-                     String guestPolicy, Boolean authenticatedGuest, String meetingLayout, String welcomeMsgTemplate, String welcomeMsg, String modOnlyMessage,
+                     String guestPolicy, Boolean authenticatedGuest, Boolean allowPromoteGuestToModerator, String meetingLayout,
+                     String welcomeMsgTemplate, String welcomeMsg, String modOnlyMessage,
                      String dialNumber, Integer maxUsers, Integer maxUserConcurrentAccesses,
                      Integer meetingExpireIfNoUserJoinedInMinutes,
                      Integer meetingExpireWhenLastUserLeftInMinutes,

bbb-common-web/src/main/java/org/bigbluebutton/api2/domain/UsersProp2.java

@@ -7,6 +7,7 @@ public class UsersProp2 {
     public final String guestPolicy;
     public final String meetingLayout;
     public final boolean authenticatedGuest;
+    public final boolean allowPromoteGuestToModerator;
     public final boolean userHasJoined;
     public final boolean webcamsOnlyForModerator;
     public final int userCameraCap;
@@ -21,6 +22,7 @@ public class UsersProp2 {
                       String guestPolicy,
                       String meetingLayout,
                       boolean authenticatedGuest,
+                      boolean allowPromoteGuestToModerator,
                       boolean userHasJoined,
                       Map<String, String> userCustomData,
                       Map<String, User2> users,
@@ -31,6 +33,7 @@ public class UsersProp2 {
         this.guestPolicy = guestPolicy;
         this.meetingLayout = meetingLayout;
         this.authenticatedGuest = authenticatedGuest;
+        this.allowPromoteGuestToModerator = allowPromoteGuestToModerator;
         this.userHasJoined = userHasJoined;
         this.userCustomData = userCustomData;
         this.users = users;

bbb-common-web/src/main/scala/org/bigbluebutton/api2/BbbWebApiGWApp.scala

@@ -130,7 +130,10 @@ class BbbWebApiGWApp(
                     createTime: java.lang.Long, createDate: String, isBreakout: java.lang.Boolean,
                     sequence: java.lang.Integer,
                     freeJoin: java.lang.Boolean,
-                    metadata: java.util.Map[String, String], guestPolicy: String, authenticatedGuest: java.lang.Boolean, meetingLayout: String,
+                    metadata: java.util.Map[String, String], guestPolicy: String,
+                    authenticatedGuest: java.lang.Boolean,
+                    allowPromoteGuestToModerator: java.lang.Boolean,
+                    meetingLayout: String,
                     welcomeMsgTemplate: String, welcomeMsg: String, modOnlyMessage: String,
                     dialNumber:                             String,
                     maxUsers:                               java.lang.Integer,
@@ -211,7 +214,8 @@ class BbbWebApiGWApp(
       userCameraCap = userCameraCap.intValue(),
       guestPolicy = guestPolicy, meetingLayout = meetingLayout, allowModsToUnmuteUsers = allowModsToUnmuteUsers.booleanValue(),
       allowModsToEjectCameras = allowModsToEjectCameras.booleanValue(),
-      authenticatedGuest = authenticatedGuest.booleanValue()
+      authenticatedGuest = authenticatedGuest.booleanValue(),
+      allowPromoteGuestToModerator = allowPromoteGuestToModerator.booleanValue()
     )
     val metadataProp = MetadataProp(mapAsScalaMap(metadata).toMap)
 

bigbluebutton-html5/imports/api/meetings/server/modifiers/addMeeting.js

@@ -100,6 +100,7 @@ export default async function addMeeting(meeting) {
       userCameraCap: Number,
       guestPolicy: String,
       authenticatedGuest: Boolean,
+      allowPromoteGuestToModerator: Boolean,
       allowModsToUnmuteUsers: Boolean,
       allowModsToEjectCameras: Boolean,
       meetingLayout: String,

bigbluebutton-html5/imports/ui/components/user-list/service.js

@@ -401,6 +401,7 @@ const getUsersProp = () => {
         'usersProp.allowModsToUnmuteUsers': 1,
         'usersProp.allowModsToEjectCameras': 1,
         'usersProp.authenticatedGuest': 1,
+        'usersProp.allowPromoteGuestToModerator': 1,
       },
     },
   );
@@ -411,6 +412,7 @@ const getUsersProp = () => {
     allowModsToUnmuteUsers: false,
     allowModsToEjectCameras: false,
     authenticatedGuest: false,
+    allowPromoteGuestToModerator: false,
   };
 };
 
@@ -463,14 +465,18 @@ const getAvailableActions = (
     && !isSubjectUserModerator
     && !isDialInUser
     && !isBreakoutRoom
-    && !(isSubjectUserGuest && usersProp.authenticatedGuest);
+    && !(isSubjectUserGuest
+          && usersProp.authenticatedGuest
+          && !usersProp.allowPromoteGuestToModerator);
 
   const allowedToDemote = amIModerator
     && !amISubjectUser
     && isSubjectUserModerator
     && !isDialInUser
     && !isBreakoutRoom
-    && !(isSubjectUserGuest && usersProp.authenticatedGuest);
+    && !(isSubjectUserGuest
+          && usersProp.authenticatedGuest
+          && !usersProp.allowPromoteGuestToModerator);
 
   const allowedToChangeStatus = amISubjectUser && USER_STATUS_ENABLED;
 

bigbluebutton-web/grails-app/conf/bigbluebutton.properties

@@ -160,6 +160,9 @@ defaultGuestPolicy=ALWAYS_ACCEPT
 # Enables or disables authenticated guest
 authenticatedGuest=true
 
+# Allows moderators to promote guests to moderators when authenticatedGuest is enabled
+defaultAllowPromoteGuestToModerator=false
+
 #---------------------------------------------------
 # Default Meeting Layout
 # Valid values are CUSTOM_LAYOUT, SMART_LAYOUT, PRESENTATION_FOCUS, VIDEO_FOCUS

bigbluebutton-web/grails-app/conf/spring/resources.xml

@@ -165,6 +165,7 @@ with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
         <property name="defaultAvatarURL" value="${defaultAvatarURL}"/>
         <property name="defaultGuestPolicy" value="${defaultGuestPolicy}"/>
         <property name="authenticatedGuest" value="${authenticatedGuest}"/>
+        <property name="defaultAllowPromoteGuestToModerator" value="${defaultAllowPromoteGuestToModerator}"/>
         <property name="defaultMeetingLayout" value="${defaultMeetingLayout}"/>
         <property name="meetingExpireIfNoUserJoinedInMinutes" value="${meetingExpireIfNoUserJoinedInMinutes}"/>
         <property name="meetingExpireWhenLastUserLeftInMinutes" value="${meetingExpireWhenLastUserLeftInMinutes}"/>