123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435 |
- <?php
- 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/>.
- *
- */
- namespace OC\Profile;
- use OCP\Profile\IProfileManager;
- use function array_flip;
- use function usort;
- use OC\AppFramework\Bootstrap\Coordinator;
- use OC\Core\Db\ProfileConfig;
- use OC\Core\Db\ProfileConfigMapper;
- use OC\KnownUser\KnownUserService;
- use OC\Profile\Actions\EmailAction;
- 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\IConfig;
- use OCP\IUser;
- use OCP\L10N\IFactory;
- use OCP\Profile\ILinkAction;
- use OCP\Cache\CappedMemoryCache;
- use Psr\Container\ContainerInterface;
- use Psr\Log\LoggerInterface;
- 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,
- 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,
- ];
- 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
- * @return array{userId: string, address?: string|null, biography?: string|null, displayname?: string|null, headline?: string|null, isUserAvatarVisible?: bool, organisation?: string|null, role?: string|null, actions: list<array{id: string, icon: string, title: string, target: ?string}>}
- */
- 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:
- $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 medatata,
- * 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('Organisation'),
- ],
- IAccountManager::PROPERTY_ROLE => [
- 'appId' => self::CORE_APP_ID,
- 'displayId' => $this->l10nFactory->get('lib')->t('Role'),
- ],
- ];
- $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;
- }
- }
|