Implement disabledFeatures in create API (#152)

* Implement disabledFeatures in create API

* Refactor

* Implement disabled features exclude, update features enum

* Add return type

---------

Co-authored-by: Felix Jacobi <felix@jacobi-hamburg.net>

Author: samuelwei

src/Enum/Feature.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2023 BigBlueButton Inc. and by respective authors (see below).
+ *
+ * This program is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation; either version 3.0 of the License, or (at your option) any later
+ * version.
+ *
+ * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along
+ * with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Enum;
+
+use MabeEnum\Enum;
+
+/**
+ * @psalm-immutable
+ */
+class Feature extends Enum
+{
+    public const BREAKOUT_ROOMS = 'breakoutRooms';
+    public const CAPTIONS = 'captions';
+    public const CHAT = 'chat';
+    public const DOWNLOAD_PRESENTATION_WITH_ANNOTATIONS = 'downloadPresentationWithAnnotations';
+    public const EXTERNAL_VIDEOS = 'externalVideos';
+    public const IMPORT_PRESENTATION_WITHANNOTATIONS_FROM_BREAKOUTROOMS = 'importPresentationWithAnnotationsFromBreakoutRooms';
+    public const IMPORT_SHARED_NOTES_FROM_BREAKOUTROOMS = 'importSharedNotesFromBreakoutRooms';
+    public const LAYOUTS = 'layouts';
+    public const LEARNING_DASHBOARD = 'learningDashboard';
+    public const POLLS = 'polls';
+    public const SCREENSHARE = 'screenshare';
+    public const SHARED_NOTES = 'sharedNotes';
+    public const VIRTUAL_BACKGROUNDS = 'virtualBackgrounds';
+    public const CUSTOM_VIRTUAL_BACKGROUNDS = 'customVirtualBackgrounds';
+    public const LIVE_TRANSCRIPTION = 'liveTranscription';
+    public const PRESENTATION = 'presentation';
+}

src/Parameters/CreateMeetingParameters.php

@@ -116,6 +116,10 @@
  * @method $this     setVirtualBackgroundsDisabled(bool $isVirtualBackgroundsDisabled)
  * @method int       getUserCameraCap()
  * @method $this     setUserCameraCap(int $cap)
+ * @method array     getDisabledFeatures()
+ * @method $this     setDisabledFeatures(array $disabledFeatures)
+ * @method array     getDisabledFeaturesExclude()
+ * @method $this     setDisabledFeaturesExclude(array $disabledFeaturesExclude)
  */
 class CreateMeetingParameters extends MetaParameters
 {
@@ -374,13 +378,25 @@ class CreateMeetingParameters extends MetaParameters
      */
     private $breakoutRoomsGroups = [];
 
+    /**
+     * @var array
+     */
+    protected $disabledFeatures = [];
+
+    /**
+     * @var array
+     */
+    protected $disabledFeaturesExclude = [];
+
     /**
      * @var array
      */
     private $presentations = [];
 
     public function __construct(string $meetingID, string $name)
     {
+        $this->ignoreProperties = ['disabledFeatures', 'disabledFeaturesExclude'];
+
         $this->meetingID = $meetingID;
         $this->name = $name;
     }
@@ -595,6 +611,20 @@ public function getHTTPQuery(): string
     {
         $queries = $this->getHTTPQueryArray();
 
+        // Add disabled features if any are set
+        if (!empty($this->disabledFeatures)) {
+            $queries = array_merge($queries, [
+                'disabledFeatures' => implode(',', $this->disabledFeatures),
+            ]);
+        }
+
+        // Add disabled features exclude if any are set
+        if (!empty($this->disabledFeaturesExclude)) {
+            $queries = array_merge($queries, [
+                'disabledFeaturesExclude' => implode(',', $this->disabledFeaturesExclude),
+            ]);
+        }
+
         // Pre-defined groups to automatically assign the students to a given breakout room
         if (!empty($this->breakoutRoomsGroups)) {
             $queries = array_merge($queries, [

tests/TestCase.php

@@ -21,6 +21,7 @@
 
 use BigBlueButton\Core\GuestPolicy;
 use BigBlueButton\Core\MeetingLayout;
+use BigBlueButton\Enum\Feature;
 use BigBlueButton\Parameters\CreateMeetingParameters;
 use BigBlueButton\Parameters\EndMeetingParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
@@ -97,6 +98,8 @@ protected function generateCreateParams()
             'lockSettingsLockOnJoinConfigurable' => $this->faker->boolean(50),
             'allowModsToUnmuteUsers' => $this->faker->boolean(50),
             'allowModsToEjectCameras' => $this->faker->boolean(50),
+            'disabledFeatures' => $this->faker->randomElements(Feature::getValues(), 3),
+            'disabledFeaturesExclude' => $this->faker->randomElements(Feature::getValues(), 2),
             'meta_presenter' => $this->faker->name,
             'meta_endCallbackUrl' => $this->faker->url,
             'meta_bbb-recording-ready-url' => $this->faker->url,
@@ -206,7 +209,9 @@ protected function getCreateMock($params)
             ->setBreakoutRoomsRecord($params['breakoutRoomsRecord'])
             ->setAllowRequestsWithoutSession($params['allowRequestsWithoutSession'])
             ->setVirtualBackgroundsDisabled($params['virtualBackgroundsDisabled'])
-            ->setUserCameraCap($params['userCameraCap']);
+            ->setUserCameraCap($params['userCameraCap'])
+            ->setDisabledFeatures($params['disabledFeatures'])
+            ->setDisabledFeaturesExclude($params['disabledFeaturesExclude']);
 
         if (isset($params['moderatorPW'])) {
             $createMeetingParams->setModeratorPW($params['moderatorPW']);

tests/functional/AbstractBigBlueButtonFunctionalTest.php

@@ -106,12 +106,8 @@ public function testCreateMeetingUrl(): void
     {
         $params = $this->generateCreateParams();
         $url = $this->bbb->getCreateMeetingUrl($this->getCreateMock($params));
-        foreach ($params as $key => $value) {
-            if (\is_bool($value)) {
-                $value = $value ? 'true' : 'false';
-            }
-            $this->assertStringContainsString($key.'='.rawurlencode($value), $url);
-        }
+
+        $this->assertUrlContainsAllRequestParameters($url, $params);
     }
 
     /**
@@ -212,12 +208,7 @@ public function testCreateJoinMeetingUrl(): void
 
         $url = $this->bbb->getJoinMeetingURL($joinMeetingMock);
 
-        foreach ($joinMeetingParams as $key => $value) {
-            if (\is_bool($value)) {
-                $value = $value ? 'true' : 'false';
-            }
-            $this->assertStringContainsString('='.rawurlencode($value), $url);
-        }
+        $this->assertUrlContainsAllRequestParameters($url, $joinMeetingParams);
     }
 
     public function testJoinMeeting()
@@ -255,12 +246,8 @@ public function testCreateEndMeetingUrl(): void
     {
         $params = $this->generateEndMeetingParams();
         $url = $this->bbb->getEndMeetingURL($this->getEndMeetingMock($params));
-        foreach ($params as $key => $value) {
-            if (\is_bool($value)) {
-                $value = $value ? 'true' : 'false';
-            }
-            $this->assertStringContainsString('='.rawurlencode($value), $url);
-        }
+
+        $this->assertUrlContainsAllRequestParameters($url, $params);
     }
 
     public function testEndMeeting()

tests/unit/Parameters/CreateMeetingParametersTest.php

@@ -20,6 +20,7 @@
 namespace BigBlueButton\Parameters;
 
 use BigBlueButton\Core\GuestPolicy;
+use BigBlueButton\Enum\Feature;
 use BigBlueButton\TestCase;
 
 /**
@@ -90,6 +91,8 @@ public function testCreateMeetingParameters()
         $this->assertEquals($params['allowRequestsWithoutSession'], $createMeetingParams->isAllowRequestsWithoutSession());
         $this->assertEquals($params['virtualBackgroundsDisabled'], $createMeetingParams->isVirtualBackgroundsDisabled());
         $this->assertEquals(json_encode($params['groups']), json_encode($createMeetingParams->getBreakoutRoomsGroups()));
+        $this->assertEquals($params['disabledFeatures'], $createMeetingParams->getDisabledFeatures());
+        $this->assertEquals($params['disabledFeaturesExclude'], $createMeetingParams->getDisabledFeaturesExclude());
 
         // Check values are empty of this is not a breakout room
         $this->assertNull($createMeetingParams->isBreakout());
@@ -104,6 +107,32 @@ public function testCreateMeetingParameters()
         $this->assertEquals($newId, $createMeetingParams->getMeetingID());
     }
 
+    public function testDisabledFeatures(): void
+    {
+        $params = $this->generateCreateParams();
+        $createMeetingParams = $this->getCreateMock($params);
+
+        // Test empty disabled features
+        $createMeetingParams->setDisabledFeatures([]);
+        $params = urldecode($createMeetingParams->getHTTPQuery());
+        $this->assertStringNotContainsString('disabledFeatures=', $params);
+
+        // Test with multiple disabled features
+        $createMeetingParams->setDisabledFeatures([Feature::CHAT, Feature::POLLS, Feature::CAPTIONS]);
+        $params = urldecode($createMeetingParams->getHTTPQuery());
+        $this->assertStringContainsString('disabledFeatures=chat,polls,captions', $params);
+
+        // Test empty disabled features exclude
+        $createMeetingParams->setDisabledFeaturesExclude([]);
+        $params = urldecode($createMeetingParams->getHTTPQuery());
+        $this->assertStringNotContainsString('disabledFeaturesExclude=', $params);
+
+        // Test with multiple disabled features exclude
+        $createMeetingParams->setDisabledFeaturesExclude([Feature::CHAT, Feature::POLLS]);
+        $params = urldecode($createMeetingParams->getHTTPQuery());
+        $this->assertStringContainsString('disabledFeaturesExclude=chat,polls', $params);
+    }
+
     public function testCreateBreakoutMeeting()
     {
         $params = $this->generateBreakoutCreateParams($this->generateCreateParams());