Implement API changes in BBB 2.4-2.6 (#156)

* Implement API changes in BBB 2.4-2.6

* Add backwards compatibility for the old method setLockSettingsDisableNote and isLockSettingsDisableNote

* Fix CS and composer scripts

* CS Fixer

* Adjust tests

* Add errorRedirectUrl join parameter

* Add final to test classes

Author: samuelwei

composer.json

@@ -103,9 +103,9 @@
     "test-functional": "tools/phpunit --testsuite=\"BigBlueButton functional test suite\" --exclude-group=functional-legacy",
     "cs-fix": "tools/php-cs-fixer fix --allow-risky=yes",
     "cs-test": "tools/php-cs-fixer fix --dry-run --allow-risky=yes",
-    "psalm": "psalm --threads=1",
-    "psalm-clear": "psalm --clear-cache && psalm --clear-global-cache",
-    "psalm-fix": "psalm --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType",
+    "psalm": "tools/psalm --threads=1",
+    "psalm-clear": "tools/psalm --clear-cache && psalm --clear-global-cache",
+    "psalm-fix": "tools/psalm --alter --issues=InvalidReturnType,InvalidNullableReturnType,MissingParamType,InvalidFalsableReturnType",
     "post-install-cmd": "tools/composer-git-hooks add --ignore-lock",
     "post-update-cmd": "tools/composer-git-hooks update"
   },

src/BigBlueButton.php

@@ -113,7 +113,7 @@ class BigBlueButton
      *
      * @throws ConfigException
      */
-    public function __construct(string $baseUrl = null, string $secret = null, TransportInterface $transport = null, string $hashingAlgorithm = HashingAlgorithm::SHA_1)
+    public function __construct(?string $baseUrl = null, ?string $secret = null, ?TransportInterface $transport = null, string $hashingAlgorithm = HashingAlgorithm::SHA_1)
     {
         // Keeping backward compatibility with older deployed versions
         $this->securitySecret = $secret ?: getenv('BBB_SECURITY_SALT') ?: getenv('BBB_SECRET');

src/Core/Meeting.php

@@ -20,6 +20,8 @@
 
 namespace BigBlueButton\Core;
 
+use BigBlueButton\Enum\Role;
+
 /**
  * Class Meeting.
  */
@@ -324,7 +326,7 @@ public function getModerators(): array
         $attendees = $this->getAttendees();
 
         $moderators = array_filter($attendees, function ($attendee) {
-            return $attendee->getRole() === 'MODERATOR';
+            return $attendee->getRole() === Role::MODERATOR;
         });
 
         return array_values($moderators);
@@ -340,7 +342,7 @@ public function getViewers(): array
         $attendees = $this->getAttendees();
 
         $viewers = array_filter($attendees, function ($attendee) {
-            return $attendee->getRole() === 'VIEWER';
+            return $attendee->getRole() === Role::VIEWER;
         });
 
         return array_values($viewers);

src/Enum/Role.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2022 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 Role extends Enum
+{
+    public const MODERATOR = 'MODERATOR';
+    public const VIEWER = 'VIEWER';
+}

src/Parameters/CreateMeetingParameters.php

@@ -48,8 +48,6 @@
  * @method $this     setSequence(int $sequence)
  * @method bool|null isFreeJoin()
  * @method $this     setFreeJoin(bool $isFreeJoin)
- * @method bool|null isBreakoutRoomsEnabled()
- * @method $this     setBreakoutRoomsEnabled(bool $isBreakoutRoomsEnabled)
  * @method bool|null isBreakoutRoomsPrivateChatEnabled()
  * @method $this     setBreakoutRoomsPrivateChatEnabled(bool $isBreakoutRoomsPrivateChatEnabled)
  * @method bool|null isBreakoutRoomsRecord()
@@ -82,8 +80,8 @@
  * @method $this     setLockSettingsDisablePrivateChat(bool $isLockSettingsDisablePrivateChat)
  * @method bool|null isLockSettingsDisablePublicChat()
  * @method $this     setLockSettingsDisablePublicChat(bool $isLockSettingsDisablePublicChat)
- * @method bool|null isLockSettingsDisableNote()
- * @method $this     setLockSettingsDisableNote(bool $isLockSettingsDisableNote)
+ * @method bool|null isLockSettingsDisableNotes()
+ * @method $this     setLockSettingsDisableNotes(bool $isLockSettingsDisableNotes)
  * @method bool|null isLockSettingsLockedLayout()
  * @method $this     setLockSettingsLockedLayout(bool $isLockSettingsLockedLayout)
  * @method bool|null isLockSettingsHideUserList()
@@ -104,16 +102,12 @@
  * @method $this     setMeetingLayout(string $meetingLayout)
  * @method string    getMeetingEndedURL()
  * @method $this     setMeetingEndedURL(string $meetingEndedURL)
- * @method bool|null isLearningDashboardEnabled()
- * @method $this     setLearningDashboardEnabled(bool $isLearningDashboardEnabled)
  * @method int       getLearningDashboardCleanupDelayInMinutes()
  * @method $this     setLearningDashboardCleanupDelayInMinutes(int $learningDashboardCleanupDelayInMinutes)
  * @method bool|null isAllowModsToEjectCameras()
  * @method $this     setAllowModsToEjectCameras(bool $isAllowModsToEjectCameras)
  * @method bool|null isAllowRequestsWithoutSession()
  * @method $this     setAllowRequestsWithoutSession(bool $isAllowRequestsWithoutSession)
- * @method bool|null isVirtualBackgroundsDisabled()
- * @method $this     setVirtualBackgroundsDisabled(bool $isVirtualBackgroundsDisabled)
  * @method int       getUserCameraCap()
  * @method $this     setUserCameraCap(int $cap)
  * @method array     getDisabledFeatures()
@@ -291,7 +285,7 @@ class CreateMeetingParameters extends MetaParameters
     /**
      * @var bool
      */
-    protected $lockSettingsDisableNote;
+    protected $lockSettingsDisableNotes;
 
     /**
      * @var bool
@@ -313,6 +307,11 @@ class CreateMeetingParameters extends MetaParameters
      */
     protected $lockSettingsLockOnJoinConfigurable;
 
+    /**
+     * @var bool
+     */
+    protected $lockSettingsHideViewersCursor;
+
     /**
      * @var string
      */
@@ -388,6 +387,51 @@ class CreateMeetingParameters extends MetaParameters
      */
     protected $disabledFeaturesExclude = [];
 
+    /**
+     * @var int
+     */
+    protected $meetingCameraCap;
+
+    /**
+     * @var int
+     */
+    protected $meetingExpireIfNoUserJoinedInMinutes;
+
+    /**
+     * @var int
+     */
+    protected $meetingExpireWhenLastUserLeftInMinutes;
+
+    /**
+     * @var bool
+     */
+    protected $preUploadedPresentationOverrideDefault;
+
+    /**
+     * @var bool
+     */
+    protected $notifyRecordingIsOn;
+
+    /**
+     * @var bool
+     */
+    protected $remindRecordingIsOn;
+
+    /**
+     * @var bool
+     */
+    protected $recordFullDurationMedia;
+
+    /**
+     * @var string
+     */
+    protected $presentationUploadExternalUrl;
+
+    /**
+     * @var string
+     */
+    protected $presentationUploadExternalDescription;
+
     /**
      * @var array
      */
@@ -427,6 +471,80 @@ public function isBreakout(): ?bool
         return $this->isBreakout;
     }
 
+    /**
+     * @deprecated use disabledFeatures instead
+     * Backwards compatibility for the old method name with the missing 's' at the end
+     */
+    public function setLockSettingsDisableNote(bool $isLockSettingsDisableNote): self
+    {
+        $this->isLockSettingsDisableNotes = $isLockSettingsDisableNote;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated use disabledFeatures instead
+     * Backwards compatibility for the old method name with the missing 's' at the end
+     */
+    public function isLockSettingsDisableNote(): bool
+    {
+        return $this->isLockSettingsDisableNotes;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function setLearningDashboardEnabled(bool $learningDashboardEnabled): self
+    {
+        $this->learningDashboardEnabled = $learningDashboardEnabled;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function isLearningDashboardEnabled(): bool
+    {
+        return $this->learningDashboardEnabled;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function setVirtualBackgroundsDisabled(bool $virtualBackgroundsDisabled): self
+    {
+        $this->virtualBackgroundsDisabled = $virtualBackgroundsDisabled;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function isVirtualBackgroundsDisabled(): bool
+    {
+        return $this->virtualBackgroundsDisabled;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function setBreakoutRoomsEnabled(bool $breakoutRoomsEnabled): self
+    {
+        $this->breakoutRoomsEnabled = $breakoutRoomsEnabled;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use disabledFeatures instead
+     */
+    public function isBreakoutRoomsEnabled(): bool
+    {
+        return $this->breakoutRoomsEnabled;
+    }
+
     public function isUserCameraCapDisabled(): bool
     {
         return $this->userCameraCap === 0;
@@ -493,7 +611,7 @@ public function setGuestPolicyAlwaysAccept(): self
         return $this;
     }
 
-    public function addPresentation(string $nameOrUrl, string $content = null, string $filename = null): self
+    public function addPresentation(string $nameOrUrl, ?string $content = null, ?string $filename = null): self
     {
         if (!$filename) {
             $this->presentations[$nameOrUrl] = !$content ?: base64_encode($content);

src/Parameters/EndMeetingParameters.php

@@ -37,7 +37,7 @@ class EndMeetingParameters extends BaseParameters
      */
     protected $password;
 
-    public function __construct(string $meetingID, string $password = null)
+    public function __construct(string $meetingID, ?string $password = null)
     {
         if (\func_num_args() === 2) {
             @trigger_error(sprintf('Passing $password parameter to constructor of "%s" is deprecated since 5.1 and will be removed in 6.0. Recent BigBlueButton versions does not require the password parameter to end a meeting.', self::class), \E_USER_DEPRECATED);

src/Parameters/InsertDocumentParameters.php

@@ -42,7 +42,7 @@ public function __construct(string $meetingID)
         $this->meetingID = $meetingID;
     }
 
-    public function addPresentation(string $url, string $filename, bool $downloadable = null, bool $removable = null): self
+    public function addPresentation(string $url, string $filename, ?bool $downloadable = null, ?bool $removable = null): self
     {
         $this->presentations[$url] = [
             'filename' => $filename,

src/Parameters/JoinMeetingParameters.php

@@ -19,6 +19,8 @@
 
 namespace BigBlueButton\Parameters;
 
+use BigBlueButton\Enum\Role;
+
 /**
  * Class JoinMeetingParametersTest.
  *
@@ -38,6 +40,8 @@
  * @method $this     setAvatarURL(string $avatarURL)
  * @method bool|null isRedirect()
  * @method $this     setRedirect(bool $redirect)
+ * @method string    getErrorRedirectUrl()
+ * @method $this     setErrorRedirectUrl(string $errorRedirectUrl)
  * @method string    getClientURL()
  * @method $this     setClientURL(string $clientURL)
  * @method bool|null isGuest()
@@ -102,6 +106,11 @@ class JoinMeetingParameters extends UserDataParameters
      */
     protected $redirect;
 
+    /**
+     * @var string
+     */
+    protected $errorRedirectUrl;
+
     /**
      * @var string
      */
@@ -122,15 +131,20 @@ class JoinMeetingParameters extends UserDataParameters
      */
     protected $excludeFromDashboard;
 
-    public function __construct(string $meetingID, string $fullName, string $password = null)
+    public function __construct(string $meetingID, string $fullName, $passwordOrRole)
     {
-        if (\func_num_args() === 3) {
-            @trigger_error(sprintf('Passing $password parameter to constructor of "%s" is deprecated since 5.1 and will be removed in 6.0. Use "%s::setRole()" to set the designated role for the joining user instead.', self::class, self::class), \E_USER_DEPRECATED);
+        if (!$passwordOrRole instanceof Role) {
+            @trigger_error(sprintf('Passing a password as the third parameter to constructor of "%s" is deprecated since 5.1 and will be removed in 6.0. Pass the role for the joining user instead.', self::class, self::class), \E_USER_DEPRECATED);
         }
 
         $this->meetingID = $meetingID;
         $this->fullName = $fullName;
-        $this->password = $password;
+
+        if (Role::MODERATOR === $passwordOrRole || Role::VIEWER === $passwordOrRole) {
+            $this->role = $passwordOrRole;
+        } else {
+            $this->password = $passwordOrRole;
+        }
     }
 
     /**

tests/TestCase.php

@@ -22,6 +22,7 @@
 use BigBlueButton\Core\GuestPolicy;
 use BigBlueButton\Core\MeetingLayout;
 use BigBlueButton\Enum\Feature;
+use BigBlueButton\Enum\Role;
 use BigBlueButton\Parameters\CreateMeetingParameters;
 use BigBlueButton\Parameters\EndMeetingParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters;
@@ -246,11 +247,12 @@ protected function generateJoinMeetingParams()
     {
         return ['meetingID' => $this->faker->uuid,
                 'fullName' => $this->faker->name,
-                'password' => $this->faker->password,
+                'role' => $this->faker->randomElement(Role::getValues()),
                 'userID' => $this->faker->numberBetween(1, 1000),
                 'webVoiceConf' => $this->faker->word,
                 'createTime' => $this->faker->unixTime,
                 'configToken' => $this->faker->word,
+                'errorRedirectUrl' => $this->faker->url,
                 'userdata-countrycode' => $this->faker->countryCode,
                 'userdata-email' => $this->faker->email,
                 'userdata-commercial' => false,
@@ -264,16 +266,13 @@ protected function generateJoinMeetingParams()
      */
     protected function getJoinMeetingMock($params)
     {
-        if (isset($params['password'])) {
-            $joinMeetingParams = new JoinMeetingParameters($params['meetingID'], $params['fullName'], $params['password']);
-        } else {
-            $joinMeetingParams = new JoinMeetingParameters($params['meetingID'], $params['fullName']);
-        }
+        $joinMeetingParams = new JoinMeetingParameters($params['meetingID'], $params['fullName'], $params['role']);
 
         return $joinMeetingParams
             ->setUserID($params['userID'])
             ->setWebVoiceConf($params['webVoiceConf'])
             ->setCreateTime($params['createTime'])
+            ->setErrorRedirectUrl($params['errorRedirectUrl'])
             ->setConfigToken($params['configToken'])
             ->addUserData('countrycode', $params['userdata-countrycode'])
             ->addUserData('email', $params['userdata-email'])