Merge pull request #357 from virtUOS/remove-deprecated

Implement disabledFeatures and remove old flags

Author: BrutalBirdie

README.md

@@ -146,7 +146,7 @@ Also check [Before you install](https://docs.bigbluebutton.org/administration/in
 | | `bbb_office_to_pdf_max_concurrent_conversions` | Max concurrent of conversion script execution | `4` | |
 | | `bbb_freeswitch_muted_sound` | Enable muted sound (`you are now muted`) | `true` | |
 | | `bbb_freeswitch_unmuted_sound` | Enable unmuted sound (`you are now unmuted`) | `true` | |
-| | `bbb_breakout_rooms_enabled` | Enable or disable breakout rooms | `true` | |
+| Deprecated | `bbb_breakout_rooms_enabled` | Enable or disable breakout rooms | `true` | use `bbb_disabled_features` instead |
 | | `bbb_breakout_rooms_record` | Enable or disable recording in breakout rooms | `false` | |
 | | `bbb_breakout_rooms_privatechat_enabled` | Enable or disable private chat in breakout rooms | `true` | |
 | | `bbb_docker_compose_version` | Set [docker-compose python package version](https://pypi.org/project/docker/#history) | see `defaults/main.yml` | Sets the version of the docker-compose python package |
@@ -165,8 +165,9 @@ Also check [Before you install](https://docs.bigbluebutton.org/administration/in
 | | `bbb_end_when_delay_in_minutes` |  | `1` |  |
 | | `bbb_notify_recording_is_on` |  | `false` |  |
 | | `bbb_allow_reveal_of_bbb_version` |  | `false` |  |
-| | `bbb_learning_dashboard_enabled` | Enable `true` / Disable `false` the [Learning Dashboard](https://docs.bigbluebutton.org/2.4/new.html#learning-dashboard) | `true` | |
+| Deprecated | `bbb_learning_dashboard_enabled` | Enable `true` / Disable `false` the [Learning Dashboard](https://docs.bigbluebutton.org/2.4/new.html#learning-dashboard) | `true` | use `bbb_disabled_features` instead|
 | `bbb_default_meeting_layout` | Default Meeting Layout. Default Meeting Layout. Valid values are CUSTOM_LAYOUT, SMART_LAYOUT, PRESENTATION_FOCUS, VIDEO_FOCUS | `SMART_LAYOUT` | |
+| | `bbb_disabled_features` | List of features to disable | `[]` | See https://docs.bigbluebutton.org/development/api#create for options |
 
 ### METEOR
 

defaults/main.yml

@@ -160,14 +160,14 @@ bbb_num_file_processor_threads: 2
 bbb_office_to_pdf_conversion_timeout: 60
 bbb_office_to_pdf_max_concurrent_conversions: 4
 
-bbb_breakout_rooms_enabled: true
+bbb_breakout_rooms_enabled: true  # deprecated as of 2.6
 bbb_breakout_rooms_record: false
 bbb_breakout_rooms_privatechat_enabled: true
 
 bbb_user_inactivity_inspect_timer: 0
 bbb_user_inactivity_threshold: 30
 bbb_user_activity_sign_response_delay: 5
-bbb_learning_dashboard_enabled: true
+bbb_learning_dashboard_enabled: true  # deprecated as of 2.6
 bbb_default_meeting_layout: SMART_LAYOUT
 bbb_webcams_only_for_moderator: false
 bbb_allow_mods_to_eject_cameras: false
@@ -179,6 +179,17 @@ bbb_end_when_delay_in_minutes: 1
 bbb_notify_recording_is_on: false
 bbb_allow_reveal_of_bbb_version: false
 
+# List of features to disable
+# Available options:
+# chat, sharedNotes, polls, screenshare, externalVideos, presentation, downloadPresentationWithAnnotations
+# learningDashboard, layouts, captions, liveTranscription, virtualBackgrounds, customVirtualBackgrounds
+# breakoutRooms, importSharedNotesFromBreakoutRooms, importPresentationWithAnnotationsFromBreakoutRooms
+bbb_disabled_features: []
+
+# the following variables are to ensure backwards compatibility with the deprecated feature flags
+bbb_disabled_features_deprecated: "{{ (['learningDashboard'] if bbb_learning_dashboard_enabled else []) + (['breakoutRooms'] if bbb_breakout_rooms_enabled else []) }}"
+bbb_disabled_features_combined: "{{ bbb_disabled_features | union(bbb_disabled_features_deprecated) }}"
+
 bbb_use_default_logo: false
 bbb_default_logo_url: ${ bigbluebutton.web.serverURL }/images/{{ bbb_custom_logo_name | default('logo.png') }}
 # bbb_custom_logo: "logo.png"

tasks/checkvars.yml

@@ -60,6 +60,12 @@
         msg: Please set a value for the bbb_proxy_name variable.
       failed_when: bbb_proxy_name is not defined
       when: bbb_proxy_host is defined
+    - name: Checking bbb_disabled_features against allowed values
+      assert:
+        that: "{{ item in bbb_allowed_disabled_features }}"
+        fail_msg: "Value {{ item }} is not in list of allowed values."
+      loop: "{{ bbb_disabled_features }}"
+      when: bbb_disabled_features
   rescue:
     - name: CHECK YOUR VARIABLES!
       debug:

templates/bbb-web/bbb-web.properties.j2

@@ -21,8 +21,6 @@ bigbluebutton.web.logoutURL={{ bbb_web_logouturl }}
 allowRequestsWithoutSession={{ bbb_allow_request_without_session | ternary('true', 'false') }}
 maxNumPages={{ bbb_max_num_pages }}
 maxFileSizeUpload={{ bbb_max_file_size_upload }}
-attendeesJoinViaHTML5Client=true
-moderatorsJoinViaHTML5Client=true
 defaultGuestPolicy={{ bbb_guestpolicy }}
 defaultWelcomeMessage={{ bbb_default_welcome_message }}
 beans.presentationService.defaultUploadedPresentation={{ bbb_default_presentation }}
@@ -34,14 +32,12 @@ numConversionThreads={{ bbb_num_conversion_threads }}
 numFileProcessorThreads={{ bbb_num_file_processor_threads }}
 officeToPdfConversionTimeout={{ bbb_office_to_pdf_conversion_timeout }}
 officeToPdfMaxConcurrentConversions={{ bbb_office_to_pdf_max_concurrent_conversions }}
-breakoutRoomsEnabled={{ bbb_breakout_rooms_enabled | ternary('true', 'false') }}
 breakoutRoomsRecord={{ bbb_breakout_rooms_record | ternary('true', 'false') }}
 breakoutRoomsPrivateChatEnabled={{ bbb_breakout_rooms_privatechat_enabled | ternary('true', 'false') }}
 userInactivityInspectTimerInMinutes={{ bbb_user_inactivity_inspect_timer }}
 userInactivityThresholdInMinutes={{ bbb_user_inactivity_threshold }}
 userActivitySignResponseDelayInMinutes={{ bbb_user_activity_sign_response_delay }}
 webcamsOnlyForModerator={{ bbb_webcams_only_for_moderator | ternary("true", "false") }}
-learningDashboardEnabled={{ bbb_learning_dashboard_enabled }}
 allowModsToEjectCameras={{ bbb_allow_mods_to_eject_cameras }}
 meetingCameraCap={{ bbb_meeting_camera_cap }}
 userCameraCap={{ bbb_user_camera_cap }}
@@ -50,6 +46,7 @@ endWhenNoModerator={{ bbb_end_when_no_moderator | ternary('true', 'false') }}
 endWhenNoModeratorDelayInMinutes={{ bbb_end_when_delay_in_minutes }}
 notifyRecordingIsOn={{ bbb_notify_recording_is_on | ternary('true', 'false') }}
 allowRevealOfBBBVersion={{ bbb_allow_reveal_of_bbb_version | ternary('true', 'false') }}
+disabledFeatures={{ bbb_disabled_features_combined | join(',') }}
 
 # show a logo in top left corner
 useDefaultLogo={{ bbb_use_default_logo | ternary('true', 'false') }}

vars/main.yml

@@ -26,3 +26,21 @@ bbb_webhooks:
 
 bbb_demos:
   - bbb-demo
+
+bbb_allowed_disabled_features:
+  - chat
+  - sharedNotes
+  - polls
+  - screenshare
+  - externalVideos
+  - presentation
+  - downloadPresentationWithAnnotations
+  - learningDashboard
+  - layouts
+  - captions
+  - liveTranscription
+  - virtualBackgrounds
+  - customVirtualBackgrounds
+  - breakoutRooms
+  - importSharedNotesFromBreakoutRooms
+  - importPresentationWithAnnotationsFromBreakoutRooms