nextcloud / server

lib/private/Profile/ProfileManager.php

Indentation +388 added lines, -388 removed lines

@@ -39,392 +39,392 @@
  * @psalm-import-type CoreProfileFields from ResponseDefinitions
  */
 class ProfileManager implements IProfileManager {
-	/** @var ILinkAction[] */
-	private array $actions = [];
-
-	/** @var null|ILinkAction[] */
-	private ?array $sortedActions = null;
-	/** @var CappedMemoryCache<ProfileConfig> */
-	private CappedMemoryCache $configCache;
-
-	private const CORE_APP_ID = 'core';
-
-	/**
-	 * Array of account property actions
-	 */
-	private const ACCOUNT_PROPERTY_ACTIONS = [
-		EmailAction::class,
-		PhoneAction::class,
-		WebsiteAction::class,
-		TwitterAction::class,
-		BlueskyAction::class,
-		FediverseAction::class,
-	];
-
-	/**
-	 * Array of account properties displayed on the profile
-	 */
-	private const PROFILE_PROPERTIES = [
-		IAccountManager::PROPERTY_ADDRESS,
-		IAccountManager::PROPERTY_AVATAR,
-		IAccountManager::PROPERTY_BIOGRAPHY,
-		IAccountManager::PROPERTY_DISPLAYNAME,
-		IAccountManager::PROPERTY_HEADLINE,
-		IAccountManager::PROPERTY_ORGANISATION,
-		IAccountManager::PROPERTY_ROLE,
-		IAccountManager::PROPERTY_PRONOUNS,
-	];
-
-	public function __construct(
-		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,
-	) {
-		$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 {
-		$profileEnabledGlobally = $this->config->getSystemValueBool('profile.enabled', true);
-
-		if (empty($user) || !$profileEnabledGlobally) {
-			return $profileEnabledGlobally;
-		}
-
-		$account = $this->accountManager->getAccount($user);
-		return (bool)filter_var(
-			$account->getProperty(IAccountManager::PROPERTY_PROFILE_ENABLED)->getValue(),
-			FILTER_VALIDATE_BOOLEAN,
-			FILTER_NULL_ON_FAILURE,
-		);
-	}
-
-	/**
-	 * Register an action for the user
-	 */
-	private function registerAction(ILinkAction $action, IUser $targetUser, ?IUser $visitingUser): void {
-		$action->preload($targetUser);
-
-		if ($action->getTarget() === null) {
-			// Actions without a target are not registered
-			return;
-		}
-
-		if ($action->getAppId() !== self::CORE_APP_ID) {
-			if (!$this->appManager->isEnabledForUser($action->getAppId(), $targetUser)) {
-				$this->logger->notice('App: ' . $action->getAppId() . ' cannot register actions as it is not enabled for the target user: ' . $targetUser->getUID());
-				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 ? $visitingUser->getUID() : '(user not connected)'));
-				return;
-			}
-		}
-
-		if (in_array($action->getId(), self::PROFILE_PROPERTIES, true)) {
-			$this->logger->error('Cannot register action with ID: ' . $action->getId() . ', as it is used by a core account property.');
-			return;
-		}
-
-		if (isset($this->actions[$action->getId()])) {
-			$this->logger->error('Cannot register duplicate action: ' . $action->getId());
-			return;
-		}
-
-		// Add action to associative array of actions
-		$this->actions[$action->getId()] = $action;
-	}
-
-	/**
-	 * Return an array of registered profile actions for the user
-	 *
-	 * @return ILinkAction[]
-	 */
-	private function getActions(IUser $targetUser, ?IUser $visitingUser): array {
-		// If actions are already registered and sorted, return them
-		if ($this->sortedActions !== null) {
-			return $this->sortedActions;
-		}
-
-		foreach (self::ACCOUNT_PROPERTY_ACTIONS as $actionClass) {
-			/** @var ILinkAction $action */
-			$action = $this->container->get($actionClass);
-			$this->registerAction($action, $targetUser, $visitingUser);
-		}
-
-		$context = $this->coordinator->getRegistrationContext();
-
-		if ($context !== null) {
-			foreach ($context->getProfileLinkActions() as $registration) {
-				/** @var ILinkAction $action */
-				$action = $this->container->get($registration->getService());
-				$this->registerAction($action, $targetUser, $visitingUser);
-			}
-		}
-
-		$actionsClone = $this->actions;
-		// Sort associative array into indexed array in ascending order of priority
-		usort($actionsClone, function (ILinkAction $a, ILinkAction $b) {
-			return $a->getPriority() === $b->getPriority() ? 0 : ($a->getPriority() < $b->getPriority() ? -1 : 1);
-		});
-
-		$this->sortedActions = $actionsClone;
-		return $this->sortedActions;
-	}
-
-	/**
-	 * Return whether the profile parameter of the target user
-	 * is visible to the visiting user
-	 */
-	public function isProfileFieldVisible(string $profileField, IUser $targetUser, ?IUser $visitingUser): bool {
-		try {
-			$account = $this->accountManager->getAccount($targetUser);
-			$scope = $account->getProperty($profileField)->getScope();
-		} catch (PropertyDoesNotExistException $e) {
-			// Allow the exception as not all profile parameters are account properties
-		}
-
-		$visibility = $this->getProfileConfig($targetUser, $visitingUser)[$profileField]['visibility'];
-		// Handle profile visibility and account property scope
-
-		if ($visibility === self::VISIBILITY_SHOW_USERS_ONLY) {
-			if (empty($scope)) {
-				return $visitingUser !== null;
-			}
-
-			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;
-			}
-
-			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 getProfileFields(IUser $targetUser, ?IUser $visitingUser): array {
-		$account = $this->accountManager->getAccount($targetUser);
-
-		// Initialize associative array of profile parameters
-		$profileParameters = [
-			'userId' => $account->getUser()->getUID(),
-		];
-
-		// Add account properties
-		foreach (self::PROFILE_PROPERTIES as $property) {
-			switch ($property) {
-				case IAccountManager::PROPERTY_ADDRESS:
-				case IAccountManager::PROPERTY_BIOGRAPHY:
-				case IAccountManager::PROPERTY_DISPLAYNAME:
-				case IAccountManager::PROPERTY_HEADLINE:
-				case IAccountManager::PROPERTY_ORGANISATION:
-				case IAccountManager::PROPERTY_ROLE:
-				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->isProfileFieldVisible($property, $targetUser, $visitingUser);
-					break;
-			}
-		}
-
-		// Add actions
-		$profileParameters['actions'] = array_map(
-			function (ILinkAction $action) {
-				return [
-					'id' => $action->getId(),
-					'icon' => $action->getIcon(),
-					'title' => $action->getTitle(),
-					'target' => $action->getTarget(),
-				];
-			},
-			// This is needed to reindex the array after filtering
-			array_values(
-				array_filter(
-					$this->getActions($targetUser, $visitingUser),
-					function (ILinkAction $action) use ($targetUser, $visitingUser) {
-						return $this->isProfileFieldVisible($action->getId(), $targetUser, $visitingUser);
-					}
-				),
-			)
-		);
-
-		return $profileParameters;
-	}
-
-	/**
-	 * Return the filtered profile config containing only
-	 * the properties to be stored on the database
-	 */
-	private function filterNotStoredProfileConfig(array $profileConfig): array {
-		$dbParamConfigProperties = [
-			'visibility',
-		];
-
-		foreach ($profileConfig as $paramId => $paramConfig) {
-			$profileConfig[$paramId] = array_intersect_key($paramConfig, array_flip($dbParamConfigProperties));
-		}
-
-		return $profileConfig;
-	}
-
-	/**
-	 * Return the default profile config
-	 */
-	private function getDefaultProfileConfig(IUser $targetUser, ?IUser $visitingUser): array {
-		// Construct the default config for actions
-		$actionsConfig = [];
-		foreach ($this->getActions($targetUser, $visitingUser) as $action) {
-			$actionsConfig[$action->getId()] = ['visibility' => self::DEFAULT_VISIBILITY];
-		}
-
-		// Construct the default config for account properties
-		$propertiesConfig = [];
-		foreach (self::DEFAULT_PROPERTY_VISIBILITY as $property => $visibility) {
-			$propertiesConfig[$property] = ['visibility' => $visibility];
-		}
-
-		return array_merge($actionsConfig, $propertiesConfig);
-	}
-
-	/**
-	 * Return the profile config of the target user,
-	 * if a config does not already exist a default config is created and returned
-	 */
-	public function getProfileConfig(IUser $targetUser, ?IUser $visitingUser): array {
-		$defaultProfileConfig = $this->getDefaultProfileConfig($targetUser, $visitingUser);
-		try {
-			if (($config = $this->configCache[$targetUser->getUID()]) === null) {
-				$config = $this->configMapper->get($targetUser->getUID());
-				$this->configCache[$targetUser->getUID()] = $config;
-			}
-			// Merge defaults with the existing config in case the defaults are missing
-			$config->setConfigArray(array_merge(
-				$defaultProfileConfig,
-				$this->filterNotStoredProfileConfig($config->getConfigArray()),
-			));
-			$this->configMapper->update($config);
-			$configArray = $config->getConfigArray();
-		} catch (DoesNotExistException $e) {
-			// Create a new default config if it does not exist
-			$config = new ProfileConfig();
-			$config->setUserId($targetUser->getUID());
-			$config->setConfigArray($defaultProfileConfig);
-			$this->configMapper->insert($config);
-			$configArray = $config->getConfigArray();
-		}
-
-		return $configArray;
-	}
-
-	/**
-	 * 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 {
-		$configArray = $this->getProfileConfig($targetUser, $visitingUser);
-
-		$actionsMetadata = [];
-		foreach ($this->getActions($targetUser, $visitingUser) as $action) {
-			$actionsMetadata[$action->getId()] = [
-				'appId' => $action->getAppId(),
-				'displayId' => $action->getDisplayId(),
-			];
-		}
-
-		// Add metadata for account property actions which are always configurable
-		foreach (self::ACCOUNT_PROPERTY_ACTIONS as $actionClass) {
-			/** @var ILinkAction $action */
-			$action = $this->container->get($actionClass);
-			if (!isset($actionsMetadata[$action->getId()])) {
-				$actionsMetadata[$action->getId()] = [
-					'appId' => $action->getAppId(),
-					'displayId' => $action->getDisplayId(),
-				];
-			}
-		}
-
-		$propertiesMetadata = [
-			IAccountManager::PROPERTY_ADDRESS => [
-				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Address'),
-			],
-			IAccountManager::PROPERTY_AVATAR => [
-				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Profile picture'),
-			],
-			IAccountManager::PROPERTY_BIOGRAPHY => [
-				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('About'),
-			],
-			IAccountManager::PROPERTY_DISPLAYNAME => [
-				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Display name'),
-			],
-			IAccountManager::PROPERTY_HEADLINE => [
-				'appId' => self::CORE_APP_ID,
-				'displayId' => $this->l10nFactory->get('lib')->t('Headline'),
-			],
-			IAccountManager::PROPERTY_ORGANISATION => [
-				'appId' => self::CORE_APP_ID,
-				'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);
-		$configArray = array_intersect_key($configArray, $paramMetadata);
-
-		foreach ($configArray as $paramId => $paramConfig) {
-			if (isset($paramMetadata[$paramId])) {
-				$configArray[$paramId] = array_merge(
-					$paramConfig,
-					$paramMetadata[$paramId],
-				);
-			}
-		}
-
-		return $configArray;
-	}
+    /** @var ILinkAction[] */
+    private array $actions = [];
+
+    /** @var null|ILinkAction[] */
+    private ?array $sortedActions = null;
+    /** @var CappedMemoryCache<ProfileConfig> */
+    private CappedMemoryCache $configCache;
+
+    private const CORE_APP_ID = 'core';
+
+    /**
+     * Array of account property actions
+     */
+    private const ACCOUNT_PROPERTY_ACTIONS = [
+        EmailAction::class,
+        PhoneAction::class,
+        WebsiteAction::class,
+        TwitterAction::class,
+        BlueskyAction::class,
+        FediverseAction::class,
+    ];
+
+    /**
+     * Array of account properties displayed on the profile
+     */
+    private const PROFILE_PROPERTIES = [
+        IAccountManager::PROPERTY_ADDRESS,
+        IAccountManager::PROPERTY_AVATAR,
+        IAccountManager::PROPERTY_BIOGRAPHY,
+        IAccountManager::PROPERTY_DISPLAYNAME,
+        IAccountManager::PROPERTY_HEADLINE,
+        IAccountManager::PROPERTY_ORGANISATION,
+        IAccountManager::PROPERTY_ROLE,
+        IAccountManager::PROPERTY_PRONOUNS,
+    ];
+
+    public function __construct(
+        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,
+    ) {
+        $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 {
+        $profileEnabledGlobally = $this->config->getSystemValueBool('profile.enabled', true);
+
+        if (empty($user) || !$profileEnabledGlobally) {
+            return $profileEnabledGlobally;
+        }
+
+        $account = $this->accountManager->getAccount($user);
+        return (bool)filter_var(
+            $account->getProperty(IAccountManager::PROPERTY_PROFILE_ENABLED)->getValue(),
+            FILTER_VALIDATE_BOOLEAN,
+            FILTER_NULL_ON_FAILURE,
+        );
+    }
+
+    /**
+     * Register an action for the user
+     */
+    private function registerAction(ILinkAction $action, IUser $targetUser, ?IUser $visitingUser): void {
+        $action->preload($targetUser);
+
+        if ($action->getTarget() === null) {
+            // Actions without a target are not registered
+            return;
+        }
+
+        if ($action->getAppId() !== self::CORE_APP_ID) {
+            if (!$this->appManager->isEnabledForUser($action->getAppId(), $targetUser)) {
+                $this->logger->notice('App: ' . $action->getAppId() . ' cannot register actions as it is not enabled for the target user: ' . $targetUser->getUID());
+                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 ? $visitingUser->getUID() : '(user not connected)'));
+                return;
+            }
+        }
+
+        if (in_array($action->getId(), self::PROFILE_PROPERTIES, true)) {
+            $this->logger->error('Cannot register action with ID: ' . $action->getId() . ', as it is used by a core account property.');
+            return;
+        }
+
+        if (isset($this->actions[$action->getId()])) {
+            $this->logger->error('Cannot register duplicate action: ' . $action->getId());
+            return;
+        }
+
+        // Add action to associative array of actions
+        $this->actions[$action->getId()] = $action;
+    }
+
+    /**
+     * Return an array of registered profile actions for the user
+     *
+     * @return ILinkAction[]
+     */
+    private function getActions(IUser $targetUser, ?IUser $visitingUser): array {
+        // If actions are already registered and sorted, return them
+        if ($this->sortedActions !== null) {
+            return $this->sortedActions;
+        }
+
+        foreach (self::ACCOUNT_PROPERTY_ACTIONS as $actionClass) {
+            /** @var ILinkAction $action */
+            $action = $this->container->get($actionClass);
+            $this->registerAction($action, $targetUser, $visitingUser);
+        }
+
+        $context = $this->coordinator->getRegistrationContext();
+
+        if ($context !== null) {
+            foreach ($context->getProfileLinkActions() as $registration) {
+                /** @var ILinkAction $action */
+                $action = $this->container->get($registration->getService());
+                $this->registerAction($action, $targetUser, $visitingUser);
+            }
+        }
+
+        $actionsClone = $this->actions;
+        // Sort associative array into indexed array in ascending order of priority
+        usort($actionsClone, function (ILinkAction $a, ILinkAction $b) {
+            return $a->getPriority() === $b->getPriority() ? 0 : ($a->getPriority() < $b->getPriority() ? -1 : 1);
+        });
+
+        $this->sortedActions = $actionsClone;
+        return $this->sortedActions;
+    }
+
+    /**
+     * Return whether the profile parameter of the target user
+     * is visible to the visiting user
+     */
+    public function isProfileFieldVisible(string $profileField, IUser $targetUser, ?IUser $visitingUser): bool {
+        try {
+            $account = $this->accountManager->getAccount($targetUser);
+            $scope = $account->getProperty($profileField)->getScope();
+        } catch (PropertyDoesNotExistException $e) {
+            // Allow the exception as not all profile parameters are account properties
+        }
+
+        $visibility = $this->getProfileConfig($targetUser, $visitingUser)[$profileField]['visibility'];
+        // Handle profile visibility and account property scope
+
+        if ($visibility === self::VISIBILITY_SHOW_USERS_ONLY) {
+            if (empty($scope)) {
+                return $visitingUser !== null;
+            }
+
+            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;
+            }
+
+            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 getProfileFields(IUser $targetUser, ?IUser $visitingUser): array {
+        $account = $this->accountManager->getAccount($targetUser);
+
+        // Initialize associative array of profile parameters
+        $profileParameters = [
+            'userId' => $account->getUser()->getUID(),
+        ];
+
+        // Add account properties
+        foreach (self::PROFILE_PROPERTIES as $property) {
+            switch ($property) {
+                case IAccountManager::PROPERTY_ADDRESS:
+                case IAccountManager::PROPERTY_BIOGRAPHY:
+                case IAccountManager::PROPERTY_DISPLAYNAME:
+                case IAccountManager::PROPERTY_HEADLINE:
+                case IAccountManager::PROPERTY_ORGANISATION:
+                case IAccountManager::PROPERTY_ROLE:
+                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->isProfileFieldVisible($property, $targetUser, $visitingUser);
+                    break;
+            }
+        }
+
+        // Add actions
+        $profileParameters['actions'] = array_map(
+            function (ILinkAction $action) {
+                return [
+                    'id' => $action->getId(),
+                    'icon' => $action->getIcon(),
+                    'title' => $action->getTitle(),
+                    'target' => $action->getTarget(),
+                ];
+            },
+            // This is needed to reindex the array after filtering
+            array_values(
+                array_filter(
+                    $this->getActions($targetUser, $visitingUser),
+                    function (ILinkAction $action) use ($targetUser, $visitingUser) {
+                        return $this->isProfileFieldVisible($action->getId(), $targetUser, $visitingUser);
+                    }
+                ),
+            )
+        );
+
+        return $profileParameters;
+    }
+
+    /**
+     * Return the filtered profile config containing only
+     * the properties to be stored on the database
+     */
+    private function filterNotStoredProfileConfig(array $profileConfig): array {
+        $dbParamConfigProperties = [
+            'visibility',
+        ];
+
+        foreach ($profileConfig as $paramId => $paramConfig) {
+            $profileConfig[$paramId] = array_intersect_key($paramConfig, array_flip($dbParamConfigProperties));
+        }
+
+        return $profileConfig;
+    }
+
+    /**
+     * Return the default profile config
+     */
+    private function getDefaultProfileConfig(IUser $targetUser, ?IUser $visitingUser): array {
+        // Construct the default config for actions
+        $actionsConfig = [];
+        foreach ($this->getActions($targetUser, $visitingUser) as $action) {
+            $actionsConfig[$action->getId()] = ['visibility' => self::DEFAULT_VISIBILITY];
+        }
+
+        // Construct the default config for account properties
+        $propertiesConfig = [];
+        foreach (self::DEFAULT_PROPERTY_VISIBILITY as $property => $visibility) {
+            $propertiesConfig[$property] = ['visibility' => $visibility];
+        }
+
+        return array_merge($actionsConfig, $propertiesConfig);
+    }
+
+    /**
+     * Return the profile config of the target user,
+     * if a config does not already exist a default config is created and returned
+     */
+    public function getProfileConfig(IUser $targetUser, ?IUser $visitingUser): array {
+        $defaultProfileConfig = $this->getDefaultProfileConfig($targetUser, $visitingUser);
+        try {
+            if (($config = $this->configCache[$targetUser->getUID()]) === null) {
+                $config = $this->configMapper->get($targetUser->getUID());
+                $this->configCache[$targetUser->getUID()] = $config;
+            }
+            // Merge defaults with the existing config in case the defaults are missing
+            $config->setConfigArray(array_merge(
+                $defaultProfileConfig,
+                $this->filterNotStoredProfileConfig($config->getConfigArray()),
+            ));
+            $this->configMapper->update($config);
+            $configArray = $config->getConfigArray();
+        } catch (DoesNotExistException $e) {
+            // Create a new default config if it does not exist
+            $config = new ProfileConfig();
+            $config->setUserId($targetUser->getUID());
+            $config->setConfigArray($defaultProfileConfig);
+            $this->configMapper->insert($config);
+            $configArray = $config->getConfigArray();
+        }
+
+        return $configArray;
+    }
+
+    /**
+     * 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 {
+        $configArray = $this->getProfileConfig($targetUser, $visitingUser);
+
+        $actionsMetadata = [];
+        foreach ($this->getActions($targetUser, $visitingUser) as $action) {
+            $actionsMetadata[$action->getId()] = [
+                'appId' => $action->getAppId(),
+                'displayId' => $action->getDisplayId(),
+            ];
+        }
+
+        // Add metadata for account property actions which are always configurable
+        foreach (self::ACCOUNT_PROPERTY_ACTIONS as $actionClass) {
+            /** @var ILinkAction $action */
+            $action = $this->container->get($actionClass);
+            if (!isset($actionsMetadata[$action->getId()])) {
+                $actionsMetadata[$action->getId()] = [
+                    'appId' => $action->getAppId(),
+                    'displayId' => $action->getDisplayId(),
+                ];
+            }
+        }
+
+        $propertiesMetadata = [
+            IAccountManager::PROPERTY_ADDRESS => [
+                'appId' => self::CORE_APP_ID,
+                'displayId' => $this->l10nFactory->get('lib')->t('Address'),
+            ],
+            IAccountManager::PROPERTY_AVATAR => [
+                'appId' => self::CORE_APP_ID,
+                'displayId' => $this->l10nFactory->get('lib')->t('Profile picture'),
+            ],
+            IAccountManager::PROPERTY_BIOGRAPHY => [
+                'appId' => self::CORE_APP_ID,
+                'displayId' => $this->l10nFactory->get('lib')->t('About'),
+            ],
+            IAccountManager::PROPERTY_DISPLAYNAME => [
+                'appId' => self::CORE_APP_ID,
+                'displayId' => $this->l10nFactory->get('lib')->t('Display name'),
+            ],
+            IAccountManager::PROPERTY_HEADLINE => [
+                'appId' => self::CORE_APP_ID,
+                'displayId' => $this->l10nFactory->get('lib')->t('Headline'),
+            ],
+            IAccountManager::PROPERTY_ORGANISATION => [
+                'appId' => self::CORE_APP_ID,
+                '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);
+        $configArray = array_intersect_key($configArray, $paramMetadata);
+
+        foreach ($configArray as $paramId => $paramConfig) {
+            if (isset($paramMetadata[$paramId])) {
+                $configArray[$paramId] = array_merge(
+                    $paramConfig,
+                    $paramMetadata[$paramId],
+                );
+            }
+        }
+
+        return $configArray;
+    }
 }

lib/public/Accounts/IAccountManager.php

Indentation +206 added lines, -206 removed lines

@@ -18,210 +18,210 @@
  *
  */
 interface IAccountManager {
-	/**
-	 * Contact details visible locally only
-	 *
-	 * @since 21.0.1
-	 */
-	public const SCOPE_PRIVATE = 'v2-private';
-
-	/**
-	 * Contact details visible locally and through public link access on local instance
-	 *
-	 * @since 21.0.1
-	 */
-	public const SCOPE_LOCAL = 'v2-local';
-
-	/**
-	 * Contact details visible locally, through public link access and on trusted federated servers.
-	 *
-	 * @since 21.0.1
-	 */
-	public const SCOPE_FEDERATED = 'v2-federated';
-
-	/**
-	 * Contact details visible locally, through public link access, on trusted federated servers
-	 * and published to the public lookup server.
-	 *
-	 * @since 21.0.1
-	 */
-	public const SCOPE_PUBLISHED = 'v2-published';
-
-	/**
-	 * The list of allowed scopes
-	 *
-	 * @since 25.0.0
-	 */
-	public const ALLOWED_SCOPES = [
-		self::SCOPE_PRIVATE,
-		self::SCOPE_LOCAL,
-		self::SCOPE_FEDERATED,
-		self::SCOPE_PUBLISHED,
-	];
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_AVATAR = 'avatar';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_DISPLAYNAME = 'displayname';
-
-	/**
-	 * @since 27.0.0
-	 * @deprecated 27.0.0 only added for backwards compatibility with provisioning_api UsersController::getCurrentUser
-	 */
-	public const PROPERTY_DISPLAYNAME_LEGACY = 'display-name';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_PHONE = 'phone';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_EMAIL = 'email';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_WEBSITE = 'website';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const PROPERTY_ADDRESS = 'address';
-
-	/**
-	 * @since 15.0.0
-	 * @deprecated 32.0.0
-	 */
-	public const PROPERTY_TWITTER = 'twitter';
-
-	/**
-	 * @since 32.0.0
-	 */
-	public const PROPERTY_BLUESKY = 'bluesky';
-
-	/**
-	 * @since 26.0.0
-	 */
-	public const PROPERTY_FEDIVERSE = 'fediverse';
-
-	/**
-	 * @since 23.0.0
-	 */
-	public const PROPERTY_ORGANISATION = 'organisation';
-
-	/**
-	 * @since 23.0.0
-	 */
-	public const PROPERTY_ROLE = 'role';
-
-	/**
-	 * @since 23.0.0
-	 */
-	public const PROPERTY_HEADLINE = 'headline';
-
-	/**
-	 * @since 23.0.0
-	 */
-	public const PROPERTY_BIOGRAPHY = 'biography';
-
-	/**
-	 * @since 23.0.0
-	 */
-	public const PROPERTY_PROFILE_ENABLED = 'profile_enabled';
-
-	/**
-	 * @since 30.0.0
-	 */
-	public const PROPERTY_BIRTHDATE = 'birthdate';
-
-	/**
-	 * @since 31.0.0
-	 */
-	public const PROPERTY_PRONOUNS = 'pronouns';
-
-	/**
-	 * The list of allowed properties
-	 *
-	 * @since 25.0.0
-	 */
-	public const ALLOWED_PROPERTIES = [
-		self::PROPERTY_ADDRESS,
-		self::PROPERTY_AVATAR,
-		self::PROPERTY_BIOGRAPHY,
-		self::PROPERTY_BIRTHDATE,
-		self::PROPERTY_DISPLAYNAME,
-		self::PROPERTY_EMAIL,
-		self::PROPERTY_FEDIVERSE,
-		self::PROPERTY_HEADLINE,
-		self::PROPERTY_ORGANISATION,
-		self::PROPERTY_PHONE,
-		self::PROPERTY_PROFILE_ENABLED,
-		self::PROPERTY_PRONOUNS,
-		self::PROPERTY_ROLE,
-		self::PROPERTY_TWITTER,
-		self::PROPERTY_BLUESKY,
-		self::PROPERTY_WEBSITE,
-	];
-
-
-	/**
-	 * @since 22.0.0
-	 */
-	public const COLLECTION_EMAIL = 'additional_mail';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const NOT_VERIFIED = '0';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const VERIFICATION_IN_PROGRESS = '1';
-
-	/**
-	 * @since 15.0.0
-	 */
-	public const VERIFIED = '2';
-
-	/**
-	 * Get the account data for a given user
-	 *
-	 * @since 15.0.0
-	 *
-	 * @param IUser $user
-	 * @return IAccount
-	 */
-	public function getAccount(IUser $user): IAccount;
-
-	/**
-	 * Update the account data with for the user
-	 *
-	 * @since 21.0.1
-	 *
-	 * @param IAccount $account
-	 * @throws \InvalidArgumentException Message is the property that was invalid
-	 */
-	public function updateAccount(IAccount $account): void;
-
-	/**
-	 * Search for users based on account data
-	 *
-	 * @param string $property - property or property collection name – since
-	 *                         NC 22 the implementation MAY add a fitting property collection into the
-	 *                         search even if a property name was given e.g. email property and email
-	 *                         collection)
-	 * @param string[] $values
-	 * @return array
-	 *
-	 * @since 21.0.0
-	 */
-	public function searchUsers(string $property, array $values): array;
+    /**
+     * Contact details visible locally only
+     *
+     * @since 21.0.1
+     */
+    public const SCOPE_PRIVATE = 'v2-private';
+
+    /**
+     * Contact details visible locally and through public link access on local instance
+     *
+     * @since 21.0.1
+     */
+    public const SCOPE_LOCAL = 'v2-local';
+
+    /**
+     * Contact details visible locally, through public link access and on trusted federated servers.
+     *
+     * @since 21.0.1
+     */
+    public const SCOPE_FEDERATED = 'v2-federated';
+
+    /**
+     * Contact details visible locally, through public link access, on trusted federated servers
+     * and published to the public lookup server.
+     *
+     * @since 21.0.1
+     */
+    public const SCOPE_PUBLISHED = 'v2-published';
+
+    /**
+     * The list of allowed scopes
+     *
+     * @since 25.0.0
+     */
+    public const ALLOWED_SCOPES = [
+        self::SCOPE_PRIVATE,
+        self::SCOPE_LOCAL,
+        self::SCOPE_FEDERATED,
+        self::SCOPE_PUBLISHED,
+    ];
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_AVATAR = 'avatar';
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_DISPLAYNAME = 'displayname';
+
+    /**
+     * @since 27.0.0
+     * @deprecated 27.0.0 only added for backwards compatibility with provisioning_api UsersController::getCurrentUser
+     */
+    public const PROPERTY_DISPLAYNAME_LEGACY = 'display-name';
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_PHONE = 'phone';
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_EMAIL = 'email';
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_WEBSITE = 'website';
+
+    /**
+     * @since 15.0.0
+     */
+    public const PROPERTY_ADDRESS = 'address';
+
+    /**
+     * @since 15.0.0
+     * @deprecated 32.0.0
+     */
+    public const PROPERTY_TWITTER = 'twitter';
+
+    /**
+     * @since 32.0.0
+     */
+    public const PROPERTY_BLUESKY = 'bluesky';
+
+    /**
+     * @since 26.0.0
+     */
+    public const PROPERTY_FEDIVERSE = 'fediverse';
+
+    /**
+     * @since 23.0.0
+     */
+    public const PROPERTY_ORGANISATION = 'organisation';
+
+    /**
+     * @since 23.0.0
+     */
+    public const PROPERTY_ROLE = 'role';
+
+    /**
+     * @since 23.0.0
+     */
+    public const PROPERTY_HEADLINE = 'headline';
+
+    /**
+     * @since 23.0.0
+     */
+    public const PROPERTY_BIOGRAPHY = 'biography';
+
+    /**
+     * @since 23.0.0
+     */
+    public const PROPERTY_PROFILE_ENABLED = 'profile_enabled';
+
+    /**
+     * @since 30.0.0
+     */
+    public const PROPERTY_BIRTHDATE = 'birthdate';
+
+    /**
+     * @since 31.0.0
+     */
+    public const PROPERTY_PRONOUNS = 'pronouns';
+
+    /**
+     * The list of allowed properties
+     *
+     * @since 25.0.0
+     */
+    public const ALLOWED_PROPERTIES = [
+        self::PROPERTY_ADDRESS,
+        self::PROPERTY_AVATAR,
+        self::PROPERTY_BIOGRAPHY,
+        self::PROPERTY_BIRTHDATE,
+        self::PROPERTY_DISPLAYNAME,
+        self::PROPERTY_EMAIL,
+        self::PROPERTY_FEDIVERSE,
+        self::PROPERTY_HEADLINE,
+        self::PROPERTY_ORGANISATION,
+        self::PROPERTY_PHONE,
+        self::PROPERTY_PROFILE_ENABLED,
+        self::PROPERTY_PRONOUNS,
+        self::PROPERTY_ROLE,
+        self::PROPERTY_TWITTER,
+        self::PROPERTY_BLUESKY,
+        self::PROPERTY_WEBSITE,
+    ];
+
+
+    /**
+     * @since 22.0.0
+     */
+    public const COLLECTION_EMAIL = 'additional_mail';
+
+    /**
+     * @since 15.0.0
+     */
+    public const NOT_VERIFIED = '0';
+
+    /**
+     * @since 15.0.0
+     */
+    public const VERIFICATION_IN_PROGRESS = '1';
+
+    /**
+     * @since 15.0.0
+     */
+    public const VERIFIED = '2';
+
+    /**
+     * Get the account data for a given user
+     *
+     * @since 15.0.0
+     *
+     * @param IUser $user
+     * @return IAccount
+     */
+    public function getAccount(IUser $user): IAccount;
+
+    /**
+     * Update the account data with for the user
+     *
+     * @since 21.0.1
+     *
+     * @param IAccount $account
+     * @throws \InvalidArgumentException Message is the property that was invalid
+     */
+    public function updateAccount(IAccount $account): void;
+
+    /**
+     * Search for users based on account data
+     *
+     * @param string $property - property or property collection name – since
+     *                         NC 22 the implementation MAY add a fitting property collection into the
+     *                         search even if a property name was given e.g. email property and email
+     *                         collection)
+     * @param string[] $values
+     * @return array
+     *
+     * @since 21.0.0
+     */
+    public function searchUsers(string $property, array $values): array;
 }

lib/public/Profile/IProfileManager.php

Indentation +65 added lines, -65 removed lines

@@ -18,76 +18,76 @@
  * @since 28.0.0
  */
 interface IProfileManager {
-	/**
-	 * Visible to users, guests, and public access
-	 *
-	 * @since 28.0.0
-	 */
-	public const VISIBILITY_SHOW = 'show';
+    /**
+     * Visible to users, guests, and public access
+     *
+     * @since 28.0.0
+     */
+    public const VISIBILITY_SHOW = 'show';
 
-	/**
-	 * Visible to users and guests
-	 *
-	 * @since 28.0.0
-	 */
-	public const VISIBILITY_SHOW_USERS_ONLY = 'show_users_only';
+    /**
+     * Visible to users and guests
+     *
+     * @since 28.0.0
+     */
+    public const VISIBILITY_SHOW_USERS_ONLY = 'show_users_only';
 
-	/**
-	 * Visible to nobody
-	 *
-	 * @since 28.0.0
-	 */
-	public const VISIBILITY_HIDE = 'hide';
+    /**
+     * Visible to nobody
+     *
+     * @since 28.0.0
+     */
+    public const VISIBILITY_HIDE = 'hide';
 
-	/**
-	 * Default account property visibility
-	 *
-	 * @since 28.0.0
-	 */
-	public const DEFAULT_PROPERTY_VISIBILITY = [
-		IAccountManager::PROPERTY_ADDRESS => self::VISIBILITY_SHOW_USERS_ONLY,
-		IAccountManager::PROPERTY_AVATAR => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_BIOGRAPHY => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_DISPLAYNAME => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_HEADLINE => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_ORGANISATION => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_ROLE => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_EMAIL => self::VISIBILITY_SHOW_USERS_ONLY,
-		IAccountManager::PROPERTY_PHONE => self::VISIBILITY_SHOW_USERS_ONLY,
-		IAccountManager::PROPERTY_TWITTER => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_BLUESKY => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_WEBSITE => self::VISIBILITY_SHOW,
-		IAccountManager::PROPERTY_PRONOUNS => self::VISIBILITY_SHOW,
-	];
+    /**
+     * Default account property visibility
+     *
+     * @since 28.0.0
+     */
+    public const DEFAULT_PROPERTY_VISIBILITY = [
+        IAccountManager::PROPERTY_ADDRESS => self::VISIBILITY_SHOW_USERS_ONLY,
+        IAccountManager::PROPERTY_AVATAR => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_BIOGRAPHY => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_DISPLAYNAME => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_HEADLINE => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_ORGANISATION => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_ROLE => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_EMAIL => self::VISIBILITY_SHOW_USERS_ONLY,
+        IAccountManager::PROPERTY_PHONE => self::VISIBILITY_SHOW_USERS_ONLY,
+        IAccountManager::PROPERTY_TWITTER => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_BLUESKY => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_WEBSITE => self::VISIBILITY_SHOW,
+        IAccountManager::PROPERTY_PRONOUNS => self::VISIBILITY_SHOW,
+    ];
 
-	/**
-	 * Default visibility
-	 *
-	 * @since 28.0.0
-	 */
-	public const DEFAULT_VISIBILITY = self::VISIBILITY_SHOW_USERS_ONLY;
+    /**
+     * Default visibility
+     *
+     * @since 28.0.0
+     */
+    public const DEFAULT_VISIBILITY = self::VISIBILITY_SHOW_USERS_ONLY;
 
-	/**
-	 * If no user is passed as an argument return whether profile is enabled globally in `config.php`
-	 *
-	 * @since 28.0.0
-	 */
-	public function isProfileEnabled(?IUser $user = null): bool;
+    /**
+     * If no user is passed as an argument return whether profile is enabled globally in `config.php`
+     *
+     * @since 28.0.0
+     */
+    public function isProfileEnabled(?IUser $user = null): bool;
 
-	/**
-	 * Return whether the profile parameter of the target user
-	 * is visible to the visiting user
-	 *
-	 * @since 28.0.0
-	 */
-	public function isProfileFieldVisible(string $profileField, IUser $targetUser, ?IUser $visitingUser): bool;
+    /**
+     * Return whether the profile parameter of the target user
+     * is visible to the visiting user
+     *
+     * @since 28.0.0
+     */
+    public function isProfileFieldVisible(string $profileField, IUser $targetUser, ?IUser $visitingUser): bool;
 
-	/**
-	 * Return the profile parameters of the target user that are visible to the visiting user
-	 * in an associative array
-	 *
-	 * @psalm-return CoreProfileFields
-	 * @since 28.0.0
-	 */
-	public function getProfileFields(IUser $targetUser, ?IUser $visitingUser): array;
+    /**
+     * Return the profile parameters of the target user that are visible to the visiting user
+     * in an associative array
+     *
+     * @psalm-return CoreProfileFields
+     * @since 28.0.0
+     */
+    public function getProfileFields(IUser $targetUser, ?IUser $visitingUser): array;
 }