1 files changed, 104 insertions, 118 deletions

diff --git a/lib/private/Profile/ProfileManager.php b/lib/private/Profile/ProfileManager.php
index ddc0670604b..c38412f6bd0 100644
--- a/lib/private/Profile/ProfileManager.php
+++ b/lib/private/Profile/ProfileManager.php
@@ -3,85 +3,49 @@
 declare(strict_types=1);
 
 /**
- * @copyright 2021 Christopher Ng <chrng8@gmail.com>
- *
- * @author Christopher Ng <chrng8@gmail.com>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program 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 Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
 namespace OC\Profile;
 
-use function Safe\array_flip;
-use function Safe\usort;
 use OC\AppFramework\Bootstrap\Coordinator;
+use OC\Config\PresetManager;
 use OC\Core\Db\ProfileConfig;
 use OC\Core\Db\ProfileConfigMapper;
+use OC\Core\ResponseDefinitions;
 use OC\KnownUser\KnownUserService;
+use OC\Profile\Actions\BlueskyAction;
 use OC\Profile\Actions\EmailAction;
+use OC\Profile\Actions\FediverseAction;
 use OC\Profile\Actions\PhoneAction;
 use OC\Profile\Actions\TwitterAction;
-use OC\Profile\Actions\FediverseAction;
 use OC\Profile\Actions\WebsiteAction;
 use OCP\Accounts\IAccountManager;
 use OCP\Accounts\PropertyDoesNotExistException;
 use OCP\App\IAppManager;
 use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\Cache\CappedMemoryCache;
+use OCP\Config\Lexicon\Preset;
 use OCP\IConfig;
 use OCP\IUser;
 use OCP\L10N\IFactory;
 use OCP\Profile\ILinkAction;
-use OCP\Cache\CappedMemoryCache;
+use OCP\Profile\IProfileManager;
 use Psr\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
+use function array_flip;
+use function usort;
 
-class ProfileManager {
-	/** @var IAccountManager */
-	private $accountManager;
-
-	/** @var IAppManager */
-	private $appManager;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var ProfileConfigMapper */
-	private $configMapper;
-
-	/** @var ContainerInterface */
-	private $container;
-
-	/** @var KnownUserService */
-	private $knownUserService;
-
-	/** @var IFactory */
-	private $l10nFactory;
-
-	/** @var LoggerInterface */
-	private $logger;
-
-	/** @var Coordinator */
-	private $coordinator;
-
+/**
+ * @psalm-import-type CoreProfileFields from ResponseDefinitions
+ */
+class ProfileManager implements IProfileManager {
 	/** @var ILinkAction[] */
-	private $actions = [];
+	private array $actions = [];
 
 	/** @var null|ILinkAction[] */
-	private $sortedActions = null;
+	private ?array $sortedActions = null;
 	/** @var CappedMemoryCache<ProfileConfig> */
 	private CappedMemoryCache $configCache;
 
@@ -95,6 +59,7 @@ class ProfileManager {
 		PhoneAction::class,
 		WebsiteAction::class,
 		TwitterAction::class,
+		BlueskyAction::class,
 		FediverseAction::class,
 	];
 
@@ -109,35 +74,28 @@ class ProfileManager {
 		IAccountManager::PROPERTY_HEADLINE,
 		IAccountManager::PROPERTY_ORGANISATION,
 		IAccountManager::PROPERTY_ROLE,
+		IAccountManager::PROPERTY_PRONOUNS,
 	];
 
 	public function __construct(
-		IAccountManager $accountManager,
-		IAppManager $appManager,
-		IConfig $config,
-		ProfileConfigMapper $configMapper,
-		ContainerInterface $container,
-		KnownUserService $knownUserService,
-		IFactory $l10nFactory,
-		LoggerInterface $logger,
-		Coordinator $coordinator
+		private IAccountManager $accountManager,
+		private IAppManager $appManager,
+		private IConfig $config,
+		private ProfileConfigMapper $configMapper,
+		private ContainerInterface $container,
+		private KnownUserService $knownUserService,
+		private IFactory $l10nFactory,
+		private LoggerInterface $logger,
+		private Coordinator $coordinator,
+		private readonly PresetManager $presetManager,
 	) {
-		$this->accountManager = $accountManager;
-		$this->appManager = $appManager;
-		$this->config = $config;
-		$this->configMapper = $configMapper;
-		$this->container = $container;
-		$this->knownUserService = $knownUserService;
-		$this->l10nFactory = $l10nFactory;
-		$this->logger = $logger;
-		$this->coordinator = $coordinator;
 		$this->configCache = new CappedMemoryCache();
 	}
 
 	/**
 	 * If no user is passed as an argument return whether profile is enabled globally in `config.php`
 	 */
-	public function isProfileEnabled(?IUser $user = null): ?bool {
+	public function isProfileEnabled(?IUser $user = null): bool {
 		$profileEnabledGlobally = $this->config->getSystemValueBool('profile.enabled', true);
 
 		if (empty($user) || !$profileEnabledGlobally) {
@@ -145,7 +103,7 @@ class ProfileManager {
 		}
 
 		$account = $this->accountManager->getAccount($user);
-		return filter_var(
+		return (bool)filter_var(
 			$account->getProperty(IAccountManager::PROPERTY_PROFILE_ENABLED)->getValue(),
 			FILTER_VALIDATE_BOOLEAN,
 			FILTER_NULL_ON_FAILURE,
@@ -169,7 +127,7 @@ class ProfileManager {
 				return;
 			}
 			if (!$this->appManager->isEnabledForUser($action->getAppId(), $visitingUser)) {
-				$this->logger->notice('App: ' . $action->getAppId() . ' cannot register actions as it is not enabled for the visiting user: ' . $visitingUser->getUID());
+				$this->logger->notice('App: ' . $action->getAppId() . ' cannot register actions as it is not enabled for the visiting user: ' . ($visitingUser ? $visitingUser->getUID() : '(user not connected)'));
 				return;
 			}
 		}
@@ -229,57 +187,54 @@ class ProfileManager {
 	 * Return whether the profile parameter of the target user
 	 * is visible to the visiting user
 	 */
-	private function isParameterVisible(string $paramId, IUser $targetUser, ?IUser $visitingUser): bool {
+	public function isProfileFieldVisible(string $profileField, IUser $targetUser, ?IUser $visitingUser): bool {
 		try {
 			$account = $this->accountManager->getAccount($targetUser);
-			$scope = $account->getProperty($paramId)->getScope();
+			$scope = $account->getProperty($profileField)->getScope();
 		} catch (PropertyDoesNotExistException $e) {
 			// Allow the exception as not all profile parameters are account properties
 		}
 
-		$visibility = $this->getProfileConfig($targetUser, $visitingUser)[$paramId]['visibility'];
+		$visibility = $this->getProfileConfig($targetUser, $visitingUser)[$profileField]['visibility'];
 		// Handle profile visibility and account property scope
-		switch ($visibility) {
-			case ProfileConfig::VISIBILITY_HIDE:
-				return false;
-			case ProfileConfig::VISIBILITY_SHOW_USERS_ONLY:
-				if (!empty($scope)) {
-					switch ($scope) {
-						case IAccountManager::SCOPE_PRIVATE:
-							return $visitingUser !== null && $this->knownUserService->isKnownToUser($targetUser->getUID(), $visitingUser->getUID());
-						case IAccountManager::SCOPE_LOCAL:
-						case IAccountManager::SCOPE_FEDERATED:
-						case IAccountManager::SCOPE_PUBLISHED:
-							return $visitingUser !== null;
-						default:
-							return false;
-					}
-				}
+
+		if ($visibility === self::VISIBILITY_SHOW_USERS_ONLY) {
+			if (empty($scope)) {
 				return $visitingUser !== null;
-			case ProfileConfig::VISIBILITY_SHOW:
-				if (!empty($scope)) {
-					switch ($scope) {
-						case IAccountManager::SCOPE_PRIVATE:
-							return $visitingUser !== null && $this->knownUserService->isKnownToUser($targetUser->getUID(), $visitingUser->getUID());
-						case IAccountManager::SCOPE_LOCAL:
-						case IAccountManager::SCOPE_FEDERATED:
-						case IAccountManager::SCOPE_PUBLISHED:
-							return true;
-						default:
-							return false;
-					}
-				}
+			}
+
+			return match ($scope) {
+				IAccountManager::SCOPE_PRIVATE => $visitingUser !== null && $this->knownUserService->isKnownToUser($targetUser->getUID(), $visitingUser->getUID()),
+				IAccountManager::SCOPE_LOCAL,
+				IAccountManager::SCOPE_FEDERATED,
+				IAccountManager::SCOPE_PUBLISHED => $visitingUser !== null,
+				default => false,
+			};
+		}
+
+		if ($visibility === self::VISIBILITY_SHOW) {
+			if (empty($scope)) {
 				return true;
-			default:
-				return false;
+			}
+
+			return match ($scope) {
+				IAccountManager::SCOPE_PRIVATE => $visitingUser !== null && $this->knownUserService->isKnownToUser($targetUser->getUID(), $visitingUser->getUID()),
+				IAccountManager::SCOPE_LOCAL,
+				IAccountManager::SCOPE_FEDERATED,
+				IAccountManager::SCOPE_PUBLISHED => true,
+				default => false,
+			};
 		}
+
+		return false;
 	}
 
 	/**
 	 * Return the profile parameters of the target user that are visible to the visiting user
 	 * in an associative array
+	 * @psalm-return CoreProfileFields
 	 */
-	public function getProfileParams(IUser $targetUser, ?IUser $visitingUser): array {
+	public function getProfileFields(IUser $targetUser, ?IUser $visitingUser): array {
 		$account = $this->accountManager->getAccount($targetUser);
 
 		// Initialize associative array of profile parameters
@@ -296,15 +251,16 @@ class ProfileManager {
 				case IAccountManager::PROPERTY_HEADLINE:
 				case IAccountManager::PROPERTY_ORGANISATION:
 				case IAccountManager::PROPERTY_ROLE:
-					$profileParameters[$property] =
-						$this->isParameterVisible($property, $targetUser, $visitingUser)
+				case IAccountManager::PROPERTY_PRONOUNS:
+					$profileParameters[$property]
+						= $this->isProfileFieldVisible($property, $targetUser, $visitingUser)
 						// Explicitly set to null when value is empty string
 						? ($account->getProperty($property)->getValue() ?: null)
 						: null;
 					break;
 				case IAccountManager::PROPERTY_AVATAR:
 					// Add avatar visibility
-					$profileParameters['isUserAvatarVisible'] = $this->isParameterVisible($property, $targetUser, $visitingUser);
+					$profileParameters['isUserAvatarVisible'] = $this->isProfileFieldVisible($property, $targetUser, $visitingUser);
 					break;
 			}
 		}
@@ -324,7 +280,7 @@ class ProfileManager {
 				array_filter(
 					$this->getActions($targetUser, $visitingUser),
 					function (ILinkAction $action) use ($targetUser, $visitingUser) {
-						return $this->isParameterVisible($action->getId(), $targetUser, $visitingUser);
+						return $this->isProfileFieldVisible($action->getId(), $targetUser, $visitingUser);
 					}
 				),
 			)
@@ -356,12 +312,13 @@ class ProfileManager {
 		// Construct the default config for actions
 		$actionsConfig = [];
 		foreach ($this->getActions($targetUser, $visitingUser) as $action) {
-			$actionsConfig[$action->getId()] = ['visibility' => ProfileConfig::DEFAULT_VISIBILITY];
+			$actionsConfig[$action->getId()] = ['visibility' => self::DEFAULT_VISIBILITY];
 		}
 
 		// Construct the default config for account properties
 		$propertiesConfig = [];
-		foreach (ProfileConfig::DEFAULT_PROPERTY_VISIBILITY as $property => $visibility) {
+		foreach (self::DEFAULT_PROPERTY_VISIBILITY as $property => $visibility) {
+			$this->applyDefaultProfilePreset($property, $visibility);
 			$propertiesConfig[$property] = ['visibility' => $visibility];
 		}
 
@@ -369,6 +326,31 @@ class ProfileManager {
 	}
 
 	/**
+	 * modify property visibility, based on current Preset
+	 *
+	 * @psalm-suppress UnhandledMatchCondition if conditions are not met, we do not change $visibility
+	 */
+	private function applyDefaultProfilePreset(string $property, string &$visibility): void {
+		try {
+			$overwrite = match ($this->presetManager->getLexiconPreset()) {
+				Preset::SHARED, Preset::SCHOOL, Preset::UNIVERSITY => match ($property) {
+					IAccountManager::PROPERTY_ADDRESS, IAccountManager::PROPERTY_EMAIL, IAccountManager::PROPERTY_PHONE => self::VISIBILITY_HIDE,
+				},
+				Preset::PRIVATE, Preset::FAMILY, Preset::CLUB => match ($property) {
+					IAccountManager::PROPERTY_EMAIL => self::VISIBILITY_SHOW,
+				},
+				Preset::SMALL, Preset::MEDIUM, Preset::LARGE => match ($property) {
+					IAccountManager::PROPERTY_EMAIL, IAccountManager::PROPERTY_PHONE => self::VISIBILITY_SHOW,
+				},
+			};
+		} catch (\UnhandledMatchError) {
+			return;
+		}
+
+		$visibility = $overwrite;
+	}
+
+	/**
 	 * Return the profile config of the target user,
 	 * if a config does not already exist a default config is created and returned
 	 */
@@ -399,7 +381,7 @@ class ProfileManager {
 	}
 
 	/**
-	 * Return the profile config of the target user with additional medatata,
+	 * Return the profile config of the target user with additional metadata,
 	 * if a config does not already exist a default config is created and returned
 	 */
 	public function getProfileConfigWithMetadata(IUser $targetUser, ?IUser $visitingUser): array {
@@ -440,7 +422,7 @@ class ProfileManager {
 			],
 			IAccountManager::PROPERTY_DISPLAYNAME => [
 				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Full name'),
+				'displayId' => $this->l10nFactory->get('lib')->t('Display name'),
 			],
 			IAccountManager::PROPERTY_HEADLINE => [
 				'appId' => self::CORE_APP_ID,
@@ -448,12 +430,16 @@ class ProfileManager {
 			],
 			IAccountManager::PROPERTY_ORGANISATION => [
 				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Organisation'),
+				'displayId' => $this->l10nFactory->get('lib')->t('Organization'),
 			],
 			IAccountManager::PROPERTY_ROLE => [
 				'appId' => self::CORE_APP_ID,
 				'displayId' => $this->l10nFactory->get('lib')->t('Role'),
 			],
+			IAccountManager::PROPERTY_PRONOUNS => [
+				'appId' => self::CORE_APP_ID,
+				'displayId' => $this->l10nFactory->get('lib')->t('Pronouns'),
+			],
 		];
 
 		$paramMetadata = array_merge($actionsMetadata, $propertiesMetadata);