Sync upstream (#126)

* Fix error "BigBlueButton\Core\Attendee::__construct(): Node no longer exists" if the $xml doesn't have the customdata property.

* Update BigBlueButton.php

Customize XML Response Timeout, in my case I like to adjust it to 2ms instead of your default 10ms

* Close Curl handle in php8

* Update BigBlueButton.php

* Public accessor for buildUrl

Public accessor for buildUrl for custom URL calls which is not supported by bbb-api

* add more parameters to CreateMeetingParameters.php

* Remove legacy Flash client 'configXML' related API.

* Delete joinViaHTML5 client param in join API.

* Add new API parameters introduced in BigBlueButton 2.4.

* Pass Curl options

Allow passing curl options, for example for proxy settings.

* assign curl options

* Hotfix : fix wrong label parameter

* Removed duplicate properties

* Fix errors from merge

* Fixed CS

* Updated code to our standards

* Fixed docblock

* Fixed CS again

* Added test for coverage

* Extended tests

* Update tests/unit/BigBlueButtonTest.php

* Update tests/unit/BigBlueButtonTest.php

Co-authored-by: David Rojo <david.rojo.gonzalez@gmail.com>
Co-authored-by: Ashraf Kaabi <mail@kaabi.info>
Co-authored-by: Andrey Rodko <arodko@adxnet.com>
Co-authored-by: Ghazi Triki <ghazi.triki@riadvice.tn>
Co-authored-by: iamdorsa <dorsa.hlee@gmail.com>
Co-authored-by: denis-b <denis.bonnenfant@diderot.org>
Co-authored-by: Michaël Benhaïm <mbenhaim@cenef.fr>
Co-authored-by: Samuel Weirich <samuel.weirich@gmx.de>

Author: 9 people

composer.json

@@ -12,7 +12,7 @@
   "authors": [
     {
       "name": "Ghazi Triki",
-      "email": "ghazi.nocturne@gmail.com",
+      "email": "ghazi.triki@riadvice.tn",
       "role": "Developer"
     },
     {

src/BigBlueButton.php

@@ -587,4 +587,9 @@ private function requestUrl(string $url, string $payload = '', string $contentTy
 
         return $response->getBody();
     }
+
+    public function buildUrl(string $method = '', string $params = '', bool $append = true): string
+    {
+        return $this->urlBuilder->buildUrl($method, $params, $append);
+    }
 }

src/Core/GuestPolicy.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2021 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\Core;
+
+final class GuestPolicy
+{
+    public const ALWAYS_ACCEPT        = 'ALWAYS_ACCEPT';
+    public const ALWAYS_DENY          = 'ALWAYS_DENY';
+    public const ASK_MODERATOR        = 'ASK_MODERATOR';
+    public const ALWAYS_ACCEPT_AUTH   = 'ALWAYS_ACCEPT_AUTH';
+}

src/Core/MeetingLayout.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2021 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\Core;
+
+final class MeetingLayout
+{
+    public const CUSTOM_LAYOUT      = 'CUSTOM_LAYOUT';
+    public const SMART_LAYOUT       = 'SMART_LAYOUT';
+    public const PRESENTATION_FOCUS = 'PRESENTATION_FOCUS';
+    public const VIDEO_FOCUS        = 'VIDEO_FOCUS';
+}

src/Parameters/CreateMeetingParameters.php

@@ -18,6 +18,9 @@
  */
 namespace BigBlueButton\Parameters;
 
+use BigBlueButton\Core\GuestPolicy;
+use BigBlueButton\Core\MeetingLayout;
+
 /**
  * @method string getName()
  * @method $this setName(string $name)
@@ -33,6 +36,8 @@
  * @method $this setDialNumber(string $dialNumber)
  * @method string getVoiceBridge()
  * @method $this setVoiceBridge(string $voiceBridge)
+ * @method string getWebVoice()
+ * @method $this setWebVoice(string $webVoice)
  * @method int getMaxParticipants()
  * @method $this setMaxParticipants(int $maxParticipants)
  * @method string getLogoutURL()
@@ -101,6 +106,8 @@
  * @method $this setEndWhenNoModeratorDelayInMinutes(int $endWhenNoModeratorDelayInMinutes)
  * @method string getMeetingLayout()
  * @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()
@@ -117,15 +124,39 @@
  */
 class CreateMeetingParameters extends MetaParameters
 {
-    public const ALWAYS_ACCEPT      = 'ALWAYS_ACCEPT';
-    public const ALWAYS_DENY        = 'ALWAYS_DENY';
-    public const ASK_MODERATOR      = 'ASK_MODERATOR';
-    public const ALWAYS_ACCEPT_AUTH = 'ALWAYS_ACCEPT_AUTH';
+    /**
+     * @deprecated Use GuestPolicy::ALWAYS_ACCEPT instead.
+     */
+    public const ALWAYS_ACCEPT      = GuestPolicy::ALWAYS_ACCEPT;
+    /**
+     * @deprecated Use GuestPolicy::ALWAYS_DENY instead.
+     */
+    public const ALWAYS_DENY        = GuestPolicy::ALWAYS_DENY;
+    /**
+     * @deprecated Use GuestPolicy::ASK_MODERATOR instead.
+     */
+    public const ASK_MODERATOR      = GuestPolicy::ASK_MODERATOR;
+    /**
+     * @deprecated Use GuestPolicy::ALWAYS_ACCEPT_AUTH instead.
+     */
+    public const ALWAYS_ACCEPT_AUTH = GuestPolicy::ALWAYS_ACCEPT_AUTH;
 
-    const CUSTOM_LAYOUT      = 'CUSTOM_LAYOUT';
-    const SMART_LAYOUT       = 'SMART_LAYOUT';
-    const PRESENTATION_FOCUS = 'PRESENTATION_FOCUS';
-    const VIDEO_FOCUS        = 'VIDEO_FOCUS';
+    /**
+     * @deprecated Use MeetingLayout::CUSTOM_LAYOUT instead.
+     */
+    public const CUSTOM_LAYOUT      = MeetingLayout::CUSTOM_LAYOUT;
+    /**
+     * @deprecated Use MeetingLayout::SMART_LAYOUT instead.
+     */
+    public const SMART_LAYOUT       = MeetingLayout::SMART_LAYOUT;
+    /**
+     * @deprecated Use MeetingLayout::PRESENTATION_FOCUS instead.
+     */
+    public const PRESENTATION_FOCUS = MeetingLayout::PRESENTATION_FOCUS;
+    /**
+     * @deprecated Use MeetingLayout::VIDEO_FOCUS instead.
+     */
+    public const VIDEO_FOCUS        = MeetingLayout::VIDEO_FOCUS;
 
     /**
      * @var string
@@ -162,6 +193,11 @@ class CreateMeetingParameters extends MetaParameters
      */
     protected $voiceBridge;
 
+    /**
+     * @var string
+     */
+    protected $webVoice;
+
     /**
      * @var int
      */
@@ -315,7 +351,7 @@ class CreateMeetingParameters extends MetaParameters
     /**
      * @var string
      */
-    protected $guestPolicy = self::ALWAYS_ACCEPT;
+    protected $guestPolicy = GuestPolicy::ALWAYS_ACCEPT;
 
     /**
      * @var bool
@@ -337,6 +373,11 @@ class CreateMeetingParameters extends MetaParameters
      */
     protected $meetingLayout;
 
+    /**
+     * @var string
+     */
+    protected $meetingEndedURL;
+
     /**
      * @var bool
      */
@@ -589,15 +630,15 @@ public function setParentMeetingId(string $parentMeetingID)
      */
     public function isGuestPolicyAlwaysDeny()
     {
-        return $this->guestPolicy === self::ALWAYS_DENY;
+        return $this->guestPolicy === GuestPolicy::ALWAYS_DENY;
     }
 
     /**
      * @return CreateMeetingParameters
      */
     public function setGuestPolicyAlwaysDeny()
     {
-        $this->guestPolicy = self::ALWAYS_DENY;
+        $this->guestPolicy = GuestPolicy::ALWAYS_DENY;
 
         return $this;
     }
@@ -607,7 +648,7 @@ public function setGuestPolicyAlwaysDeny()
      */
     public function isGuestPolicyAskModerator()
     {
-        return $this->guestPolicy === self::ASK_MODERATOR;
+        return $this->guestPolicy === GuestPolicy::ASK_MODERATOR;
     }
 
     /**
@@ -616,7 +657,7 @@ public function isGuestPolicyAskModerator()
      */
     public function setGuestPolicyAskModerator()
     {
-        $this->guestPolicy = self::ASK_MODERATOR;
+        $this->guestPolicy = GuestPolicy::ASK_MODERATOR;
 
         return $this;
     }
@@ -626,7 +667,7 @@ public function setGuestPolicyAskModerator()
      */
     public function isGuestPolicyAlwaysAcceptAuth()
     {
-        return $this->guestPolicy === self::ALWAYS_ACCEPT_AUTH;
+        return $this->guestPolicy === GuestPolicy::ALWAYS_ACCEPT_AUTH;
     }
 
     /**
@@ -635,7 +676,7 @@ public function isGuestPolicyAlwaysAcceptAuth()
      */
     public function setGuestPolicyAlwaysAcceptAuth()
     {
-        $this->guestPolicy = self::ALWAYS_ACCEPT_AUTH;
+        $this->guestPolicy = GuestPolicy::ALWAYS_ACCEPT_AUTH;
 
         return $this;
     }

src/Responses/GetRecordingTextTracksResponse.php

@@ -2,7 +2,7 @@
 /**
  * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
  *
- * Copyright (c) 2016-2018 BigBlueButton Inc. and by respective authors (see below).
+ * Copyright (c) 2016-2021 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

tests/TestCase.php

@@ -18,6 +18,8 @@
  */
 namespace BigBlueButton;
 
+use BigBlueButton\Core\GuestPolicy;
+use BigBlueButton\Core\MeetingLayout;
 use BigBlueButton\Parameters\CreateMeetingParameters as CreateMeetingParameters;
 use BigBlueButton\Parameters\EndMeetingParameters;
 use BigBlueButton\Parameters\JoinMeetingParameters as JoinMeetingParameters;
@@ -73,6 +75,7 @@ protected function generateCreateParams()
             'autoStartRecording'                        => $this->faker->boolean(50),
             'dialNumber'                                => $this->faker->phoneNumber,
             'voiceBridge'                               => $this->faker->randomNumber(5),
+            'webVoice'                                  => $this->faker->word,
             'logoutURL'                                 => $this->faker->url,
             'maxParticipants'                           => $this->faker->numberBetween(2, 100),
             'record'                                    => $this->faker->boolean(50),
@@ -83,7 +86,7 @@ protected function generateCreateParams()
             'webcamsOnlyForModerator'                   => $this->faker->boolean(50),
             'logo'                                      => $this->faker->imageUrl(330, 70),
             'copyright'                                 => $this->faker->text,
-            'guestPolicy'                               => CreateMeetingParameters::ALWAYS_ACCEPT,
+            'guestPolicy'                               => $this->faker->randomElement([GuestPolicy::ALWAYS_ACCEPT, GuestPolicy::ALWAYS_DENY, GuestPolicy::ASK_MODERATOR]),
             'muteOnStart'                               => $this->faker->boolean(50),
             'lockSettingsDisableCam'                    => $this->faker->boolean(50),
             'lockSettingsDisableMic'                    => $this->faker->boolean(50),
@@ -95,6 +98,7 @@ protected function generateCreateParams()
             'lockSettingsLockOnJoin'                    => $this->faker->boolean(50),
             'lockSettingsLockOnJoinConfigurable'        => $this->faker->boolean(50),
             'allowModsToUnmuteUsers'                    => $this->faker->boolean(50),
+            'allowModsToEjectCameras'                   => $this->faker->boolean(50),
             'meta_presenter'                            => $this->faker->name,
             'meta_endCallbackUrl'                       => $this->faker->url,
             'meta_bbb-recording-ready-url'              => $this->faker->url,
@@ -104,16 +108,16 @@ protected function generateCreateParams()
             'endWhenNoModerator'                        => $this->faker->boolean(50),
             'endWhenNoModeratorDelayInMinutes'          => $this->faker->numberBetween(1, 100),
             'meetingLayout'                             => $this->faker->randomElement([
-                                                                CreateMeetingParameters::CUSTOM_LAYOUT,
-                                                                CreateMeetingParameters::SMART_LAYOUT,
-                                                                CreateMeetingParameters::PRESENTATION_FOCUS,
-                                                                CreateMeetingParameters::VIDEO_FOCUS
+                                                                MeetingLayout::CUSTOM_LAYOUT,
+                                                                MeetingLayout::SMART_LAYOUT,
+                                                                MeetingLayout::PRESENTATION_FOCUS,
+                                                                MeetingLayout::VIDEO_FOCUS
                                                            ]),
             'learningDashboardEnabled'                  => $this->faker->boolean(50),
             'learningDashboardCleanupDelayInMinutes'    => $this->faker->numberBetween(1, 100),
-            'allowModsToEjectCameras'                   => $this->faker->boolean(50),
             'breakoutRoomsEnabled'                      => $this->faker->boolean(50),
             'breakoutRoomsPrivateChatEnabled'           => $this->faker->boolean(50),
+            'meetingEndedURL'                           => $this->faker->url,
             'breakoutRoomsRecord'                       => $this->faker->boolean(50),
             'allowRequestsWithoutSession'               => $this->faker->boolean(50),
             'virtualBackgroundsDisabled'                => $this->faker->boolean(50),
@@ -148,11 +152,12 @@ protected function getCreateMock($params)
             ->setModeratorPassword($params['moderatorPW'])
             ->setDialNumber($params['dialNumber'])
             ->setVoiceBridge($params['voiceBridge'])
-            ->setLogoutUrl($params['logoutURL'])
+            ->setWebVoice($params['webVoice'])
+            ->setLogoutURL($params['logoutURL'])
             ->setMaxParticipants($params['maxParticipants'])
             ->setRecord($params['record'])
             ->setDuration($params['duration'])
-            ->setWelcomeMessage($params['welcome'])
+            ->setWelcome($params['welcome'])
             ->setAutoStartRecording($params['autoStartRecording'])
             ->setAllowStartStopRecording($params['allowStartStopRecording'])
             ->setModeratorOnlyMessage($params['moderatorOnlyMessage'])
@@ -172,14 +177,17 @@ protected function getCreateMock($params)
             ->setLockSettingsLockOnJoin($params['lockSettingsLockOnJoin'])
             ->setLockSettingsLockOnJoinConfigurable($params['lockSettingsLockOnJoinConfigurable'])
             ->setAllowModsToUnmuteUsers($params['allowModsToUnmuteUsers'])
-            ->setGuestPolicyAlwaysAccept()
+            ->setGuestPolicy($params['guestPolicy'])
             ->addMeta('presenter', $params['meta_presenter'])
             ->setBannerText($params['bannerText'])
             ->setBannerColor($params['bannerColor'])
             ->setMeetingKeepEvents($params['meetingKeepEvents'])
             ->setEndWhenNoModerator($params['endWhenNoModerator'])
             ->setEndWhenNoModeratorDelayInMinutes($params['endWhenNoModeratorDelayInMinutes'])
+            ->setAllowModsToEjectCameras($params['allowModsToEjectCameras'])
+            ->setMeetingEndedURL($params['meetingEndedURL'])
             ->setMeetingLayout($params['meetingLayout'])
+            ->setMeetingKeepEvents($params['meetingKeepEvents'])
             ->setLearningDashboardEnabled($params['learningDashboardEnabled'])
             ->setLearningDashboardCleanupDelayInMinutes($params['learningDashboardCleanupDelayInMinutes'])
             ->setAllowModsToEjectCameras($params['allowModsToEjectCameras'])