plugins-nextcloud-mirror/spreed
1
0
Fork 0
mirror of https://github.com/nextcloud/spreed.git synced 2025-12-17 21:12:20 +01:00
Code Projects Releases Activity

Merge pull request #13488 from nextcloud/feat/13446/api-for-media-preference

Browse source 
feat(calls): Add appconfig and user preference for default setting of…
This commit is contained in:
Joas Schilling 2024-10-08 14:21:53 +02:00 • committed by GitHub
commit ac44f1de6a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 211 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/capabilities.md
View file

@ -158,3 +158,4 @@
## 20.1
* `archived-conversations` (local) - Conversations can be marked as archived which will hide them from the conversation list by default
* `config => call => start-without-media` (local) - Boolean, whether media should be disabled when starting or joining a conversation

16
docs/settings.md
View file

@ -21,11 +21,16 @@
## User settings
| Key | Capability | Default | Valid values |
|-----------------------|------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| `attachment_folder` | `config => attachments => folder` | Value of app config `default_attachment_folder` | Path owned by the user to store uploads and received shares. It is created if it does not exist. |
| `read_status_privacy` | `config => chat => read-privacy` | `0` | One of the read-status constants from the [constants list](constants.md#participant-read-status-privacy) |
| `typing_privacy` | `config => chat => typing-privacy` | `0` | One of the typing privacy constants from the [constants list](constants.md#participant-typing-privacy) |
**Note:** Settings from `calls_start_without_media` onwards can not be set via above API.
Instead, the server API `POST /ocs/v2.php/apps/provisioning_api/api/v1/config/users/{appId}/{configKey}` needs to be used.
| Key | Capability | Default | Valid values |
|-----------------------------|-----------------------------------------|----------------------------------------------------|----------------------------------------------------------------------------------------------------------|
| `attachment_folder` | `config => attachments => folder` | Value of app config `default_attachment_folder` | Path owned by the user to store uploads and received shares. It is created if it does not exist. |
| `read_status_privacy` | `config => chat => read-privacy` | `0` | One of the read-status constants from the [constants list](constants.md#participant-read-status-privacy) |
| `typing_privacy` | `config => chat => typing-privacy` | `0` | One of the typing privacy constants from the [constants list](constants.md#participant-typing-privacy) |
| `play_sounds` | | `'yes'` | `'yes'` and `'no'` |
| `calls_start_without_media` | `config => call => start-without-media` | `''` falling back to app config with the same name | `'yes'` and `'no'` |
## Set SIP settings
@ -94,6 +99,7 @@ Legend:
| `changelog` | string<br>`yes` or `no` | `yes` | No | | Whether the changelog conversation is updated with new features on major releases |
| `has_reference_id` | string<br>`yes` or `no` | `no` | Yes | | Indicator whether the clients can use the reference value to identify their message, will be automatically set to `yes` when the repair steps are executed |
| `hide_signaling_warning` | string<br>`yes` or `no` | `no` | No | 🖌️ | Flag that allows to suppress the warning that an HPB should be configured |
| `calls_start_without_media` | string<br>`yes` or `no` | `no` | Yes | | Whether participants start with enabled or disabled audio and video by default |
| `breakout_rooms` | string<br>`yes` or `no` | `yes` | Yes | | Whether or not breakout rooms are allowed (Will only prevent creating new breakout rooms. Existing conversations are not modified.) |
| `call_recording` | string<br>`yes` or `no` | `yes` | Yes | | Enable call recording |
| `call_recording_transcription` | string<br>`yes` or `no` | `no` | No | | Whether call recordings should automatically be transcripted when a transcription provider is enabled. |

3
lib/AppInfo/Application.php
View file

@ -106,6 +106,7 @@ use OCA\Talk\Search\CurrentMessageSearch;
use OCA\Talk\Search\MessageSearch;
use OCA\Talk\Search\UnifiedSearchCSSLoader;
use OCA\Talk\Search\UnifiedSearchFilterPlugin;
use OCA\Talk\Settings\BeforePreferenceSetEventListener;
use OCA\Talk\Settings\Personal;
use OCA\Talk\SetupCheck\BackgroundBlurLoading;
use OCA\Talk\SetupCheck\FederationLockCache;
@ -124,6 +125,7 @@ use OCP\AppFramework\Bootstrap\IRegistrationContext;
use OCP\Collaboration\AutoComplete\AutoCompleteFilterEvent;
use OCP\Collaboration\Resources\IProviderManager;
use OCP\Collaboration\Resources\LoadAdditionalScriptsEvent;
use OCP\Config\BeforePreferenceSetEvent;
use OCP\EventDispatcher\IEventDispatcher;
use OCP\Federation\ICloudFederationProvider;
use OCP\Federation\ICloudFederationProviderManager;
@ -177,6 +179,7 @@ class Application extends App implements IBootstrap {
$context->registerEventListener(BeforeTemplateRenderedEvent::class, PublicShareTemplateLoader::class);
$context->registerEventListener(BeforeTemplateRenderedEvent::class, PublicShareAuthTemplateLoader::class);
$context->registerEventListener(LoadSidebar::class, FilesTemplateLoader::class);
$context->registerEventListener(BeforePreferenceSetEvent::class, BeforePreferenceSetEventListener::class);
// Activity listeners
$context->registerEventListener(AttendeesAddedEvent::class, ActivityListener::class);

2
lib/Capabilities.php
View file

@ -127,6 +127,7 @@ class Capabilities implements IPublicCapability {
'call' => [
'predefined-backgrounds',
'can-upload-background',
'start-without-media',
],
'chat' => [
'read-privacy',
@ -196,6 +197,7 @@ class Capabilities implements IPublicCapability {
'sip-enabled' => $this->talkConfig->isSIPConfigured(),
'sip-dialout-enabled' => $this->talkConfig->isSIPDialOutEnabled(),
'can-enable-sip' => false,
'start-without-media' => $this->talkConfig->getCallsStartWithoutMedia($user?->getUID()),
],
'chat' => [
'max-length' => ChatManager::MAX_CHAT_LENGTH,

18
lib/Config.php
View file

@ -12,6 +12,7 @@ use OCA\Talk\Events\BeforeTurnServersGetEvent;
use OCA\Talk\Federation\Authenticator;
use OCA\Talk\Model\Attendee;
use OCA\Talk\Service\RecordingService;
use OCA\Talk\Settings\UserPreference;
use OCA\Talk\Vendor\Firebase\JWT\JWT;
use OCP\AppFramework\Services\IAppConfig;
use OCP\AppFramework\Utility\ITimeFactory;
@ -662,4 +663,21 @@ class Config {
public function getGridVideosLimitEnforced(): bool {
return $this->config->getAppValue('spreed', 'grid_videos_limit_enforced', 'no') === 'yes';
}
/**
* User setting falling back to admin defined app config
*
* @param ?string $userId
* @return bool
*/
public function getCallsStartWithoutMedia(?string $userId): bool {
if ($userId !== null) {
$userSetting = $this->config->getUserValue($userId, 'spreed', UserPreference::CALLS_START_WITHOUT_MEDIA);
if ($userSetting === 'yes' || $userSetting === 'no') {
return $userSetting === 'yes';
}
}
return $this->appConfig->getAppValueBool('calls_start_without_media');
}
}

3
lib/Controller/RoomController.php
View file

@ -2436,6 +2436,9 @@ class RoomController extends AEnvironmentAwareController {
if (isset($data['config']['chat']['typing-privacy'])) {
$data['config']['chat']['typing-privacy'] = Participant::PRIVACY_PRIVATE;
}
if (isset($data['config']['call']['start-without-media'])) {
$data['config']['call']['start-without-media'] = $this->talkConfig->getCallsStartWithoutMedia($this->userId);
}
if ($response->getHeaders()['X-Nextcloud-Talk-Hash']) {
$headers['X-Nextcloud-Talk-Proxy-Hash'] = $response->getHeaders()['X-Nextcloud-Talk-Hash'];

54
lib/Controller/SettingsController.php
View file

@ -8,19 +8,13 @@ declare(strict_types=1);
namespace OCA\Talk\Controller;
use OCA\Files_Sharing\SharedStorage;
use OCA\Talk\Model\Attendee;
use OCA\Talk\Participant;
use OCA\Talk\Service\ParticipantService;
use OCA\Talk\Settings\BeforePreferenceSetEventListener;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\OpenAPI;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IConfig;
use OCP\IGroup;
use OCP\IGroupManager;
@ -35,8 +29,8 @@ class SettingsController extends OCSController {
protected IRootFolder $rootFolder,
protected IConfig $config,
protected IGroupManager $groupManager,
protected ParticipantService $participantService,
protected LoggerInterface $logger,
protected BeforePreferenceSetEventListener $preferenceListener,
protected ?string $userId,
) {
parent::__construct($appName, $request);
@ -54,57 +48,15 @@ class SettingsController extends OCSController {
*/
#[NoAdminRequired]
public function setUserSetting(string $key, $value): DataResponse {
if (!$this->validateUserSetting($key, $value)) {
if (!$this->preferenceListener->validatePreference($this->userId, $key, $value)) {
return new DataResponse([], Http::STATUS_BAD_REQUEST);
}
$this->config->setUserValue($this->userId, 'spreed', $key, $value);
if ($key === 'read_status_privacy') {
$this->participantService->updateReadPrivacyForActor(Attendee::ACTOR_USERS, $this->userId, (int)$value);
}
return new DataResponse();
}
/**
* @param string $setting
* @param int|null|string $value
* @return bool
*/
protected function validateUserSetting(string $setting, $value): bool {
if ($setting === 'attachment_folder') {
$userFolder = $this->rootFolder->getUserFolder($this->userId);
try {
$node = $userFolder->get($value);
if (!$node instanceof Folder) {
throw new NotPermittedException('Node is not a directory');
}
if ($node->isShared()) {
throw new NotPermittedException('Folder is shared');
}
return !$node->getStorage()->instanceOfStorage(SharedStorage::class);
} catch (NotFoundException $e) {
$userFolder->newFolder($value);
return true;
} catch (NotPermittedException $e) {
} catch (\Exception $e) {
$this->logger->error($e->getMessage(), ['exception' => $e]);
}
return false;
}
if ($setting === 'typing_privacy' || $setting === 'read_status_privacy') {
return (int)$value === Participant::PRIVACY_PUBLIC ||
(int)$value === Participant::PRIVACY_PRIVATE;
}
if ($setting === 'play_sounds') {
return $value === 'yes' || $value === 'no';
}
return false;
}
/**
* Update SIP bridge settings
*

1
lib/ResponseDefinitions.php
View file

@ -339,6 +339,7 @@ namespace OCA\Talk;
* sip-enabled: bool,
* sip-dialout-enabled: bool,
* can-enable-sip: bool,
* start-without-media: bool,
* },
* chat: array{
* max-length: int,

101
lib/Settings/BeforePreferenceSetEventListener.php Normal file
View file

@ -0,0 +1,101 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Settings;
use OCA\Files_Sharing\SharedStorage;
use OCA\Talk\AppInfo\Application;
use OCA\Talk\Model\Attendee;
use OCA\Talk\Participant;
use OCA\Talk\Service\ParticipantService;
use OCP\Config\BeforePreferenceSetEvent;
use OCP\EventDispatcher\Event;
use OCP\EventDispatcher\IEventListener;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use Psr\Log\LoggerInterface;
/**
* @template-implements IEventListener<Event>
*/
class BeforePreferenceSetEventListener implements IEventListener {
public function __construct(
protected IRootFolder $rootFolder,
protected ParticipantService $participantService,
protected LoggerInterface $logger,
) {
}
public function handle(Event $event): void {
if (!($event instanceof BeforePreferenceSetEvent)) {
// Unrelated
return;
}
if ($event->getAppId() !== Application::APP_ID) {
return;
}
$event->setValid($this->validatePreference(
$event->getUserId(),
$event->getConfigKey(),
$event->getConfigValue(),
));
}
/**
* @internal Make private/protected once SettingsController route was removed
*/
public function validatePreference(string $userId, string $key, string $value): bool {
if ($key === 'attachment_folder') {
return $this->validateAttachmentFolder($userId, $value);
}
// "boolean" yes/no
if ($key === UserPreference::CALLS_START_WITHOUT_MEDIA
|| $key === UserPreference::PLAY_SOUNDS) {
return $value === 'yes' || $value === 'no';
}
// "privacy" 0/1
if ($key === UserPreference::TYPING_PRIVACY
|| $key === UserPreference::READ_STATUS_PRIVACY) {
$valid = $value === (string)Participant::PRIVACY_PRIVATE || $value === (string)Participant::PRIVACY_PUBLIC;
if ($valid && $key === 'read_status_privacy') {
$this->participantService->updateReadPrivacyForActor(Attendee::ACTOR_USERS, $userId, (int)$value);
}
return $valid;
}
return false;
}
protected function validateAttachmentFolder(string $userId, string $value): bool {
try {
$userFolder = $this->rootFolder->getUserFolder($userId);
$node = $userFolder->get($value);
if (!$node instanceof Folder) {
throw new NotPermittedException('Node is not a directory');
}
if ($node->isShared()) {
throw new NotPermittedException('Folder is shared');
}
return !$node->getStorage()->instanceOfStorage(SharedStorage::class);
} catch (NotFoundException) {
$userFolder->newFolder($value);
return true;
} catch (NotPermittedException) {
} catch (\Exception $e) {
$this->logger->error($e->getMessage(), ['exception' => $e]);
}
return false;
}
}

16
lib/Settings/UserPreference.php Normal file
View file

@ -0,0 +1,16 @@
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Talk\Settings;
class UserPreference {
public const CALLS_START_WITHOUT_MEDIA = 'calls_start_without_media';
public const PLAY_SOUNDS = 'play_sounds';
public const TYPING_PRIVACY = 'typing_privacy';
public const READ_STATUS_PRIVACY = 'read_status_privacy';
}

6
openapi-administration.json
View file

@ -147,7 +147,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -186,6 +187,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-backend-recording.json
View file

@ -80,7 +80,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -119,6 +120,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-backend-signaling.json
View file

@ -80,7 +80,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -119,6 +120,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-backend-sipbridge.json
View file

@ -123,7 +123,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -162,6 +163,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-bots.json
View file

@ -80,7 +80,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -119,6 +120,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-federation.json
View file

@ -123,7 +123,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -162,6 +163,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi-full.json
View file

@ -285,7 +285,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -324,6 +325,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

6
openapi.json
View file

@ -226,7 +226,8 @@
"can-upload-background",
"sip-enabled",
"sip-dialout-enabled",
"can-enable-sip"
"can-enable-sip",
"start-without-media"
],
"properties": {
"enabled": {
@ -265,6 +266,9 @@
},
"can-enable-sip": {
"type": "boolean"
},
"start-without-media": {
"type": "boolean"
}
}
},

2
src/__mocks__/capabilities.ts
View file

@ -112,6 +112,7 @@ export const mockedCapabilities: Capabilities = {
'sip-enabled': true,
'sip-dialout-enabled': true,
'can-enable-sip': true,
'start-without-media': false,
},
chat: {
'max-length': 32000,
@ -143,6 +144,7 @@ export const mockedCapabilities: Capabilities = {
call: [
'predefined-backgrounds',
'can-upload-background',
'start-without-media',
],
chat: [
'read-privacy',

1
src/types/openapi/openapi-administration.ts
View file

@ -228,6 +228,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-backend-recording.ts
View file

@ -62,6 +62,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-backend-signaling.ts
View file

@ -48,6 +48,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-backend-sipbridge.ts
View file

@ -143,6 +143,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-bots.ts
View file

@ -66,6 +66,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-federation.ts
View file

@ -174,6 +174,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi-full.ts
View file

@ -1882,6 +1882,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

1
src/types/openapi/openapi.ts
View file

@ -1379,6 +1379,7 @@ export type components = {
"sip-enabled": boolean;
"sip-dialout-enabled": boolean;
"can-enable-sip": boolean;
"start-without-media": boolean;
};
chat: {
/** Format: int64 */

2
tests/php/CapabilitiesTest.php
View file

@ -119,6 +119,7 @@ class CapabilitiesTest extends TestCase {
'sip-enabled' => false,
'sip-dialout-enabled' => false,
'can-enable-sip' => false,
'start-without-media' => false,
'predefined-backgrounds' => [
'1_office.jpg',
'2_home.jpg',
@ -252,6 +253,7 @@ class CapabilitiesTest extends TestCase {
'sip-enabled' => false,
'sip-dialout-enabled' => false,
'can-enable-sip' => false,
'start-without-media' => false,
'predefined-backgrounds' => [
'1_office.jpg',
'2_home.jpg',