Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/lib/private/Profile/ProfileManager.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/private/Profile/ProfileManager.php')
-rw-r--r--lib/private/Profile/ProfileManager.php193
1 files changed, 141 insertions, 52 deletions
diff --git a/lib/private/Profile/ProfileManager.php b/lib/private/Profile/ProfileManager.php
index a7fdfcc62f4..f83de7fd358 100644
--- a/lib/private/Profile/ProfileManager.php
+++ b/lib/private/Profile/ProfileManager.php
@@ -26,6 +26,7 @@ declare(strict_types=1);
namespace OC\Profile;
+use function Safe\array_flip;
use function Safe\usort;
use OC\AppFramework\Bootstrap\Coordinator;
use OC\Core\Db\ProfileConfig;
@@ -77,6 +78,8 @@ class ProfileManager {
/** @var null|ILinkAction[] */
private $sortedActions = null;
+ private const CORE_APP_ID = 'core';
+
/**
* Array of account property actions
*/
@@ -92,6 +95,7 @@ class ProfileManager {
*/
private const PROFILE_PROPERTIES = [
IAccountManager::PROPERTY_ADDRESS,
+ IAccountManager::PROPERTY_AVATAR,
IAccountManager::PROPERTY_BIOGRAPHY,
IAccountManager::PROPERTY_DISPLAYNAME,
IAccountManager::PROPERTY_HEADLINE,
@@ -122,7 +126,7 @@ class ProfileManager {
/**
* Register an action for the user
*/
- private function registerAction(IUser $targetUser, ?IUser $visitingUser, ILinkAction $action): void {
+ private function registerAction(ILinkAction $action, IUser $targetUser, ?IUser $visitingUser): void {
$action->preload($targetUser);
if ($action->getTarget() === null) {
@@ -130,18 +134,9 @@ class ProfileManager {
return;
}
- if (isset($this->actions[$action->getId()])) {
- $this->logger->error('Cannot register duplicate action: ' . $action->getId());
- return;
- }
-
- if ($action->getAppId() !== 'core') {
+ 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 user: ' . $targetUser->getUID());
- return;
- }
- if ($visitingUser === null) {
- $this->logger->notice('App: ' . $action->getAppId() . ' cannot register actions as it is not available to non logged in users');
+ $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)) {
@@ -150,6 +145,16 @@ class ProfileManager {
}
}
+ 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;
}
@@ -168,7 +173,7 @@ class ProfileManager {
foreach (self::ACCOUNT_PROPERTY_ACTIONS as $actionClass) {
/** @var ILinkAction $action */
$action = $this->container->get($actionClass);
- $this->registerAction($targetUser, $visitingUser, $action);
+ $this->registerAction($action, $targetUser, $visitingUser);
}
$context = $this->coordinator->getRegistrationContext();
@@ -177,7 +182,7 @@ class ProfileManager {
foreach ($context->getProfileLinkActions() as $registration) {
/** @var ILinkAction $action */
$action = $this->container->get($registration->getService());
- $this->registerAction($targetUser, $visitingUser, $action);
+ $this->registerAction($action, $targetUser, $visitingUser);
}
}
@@ -192,9 +197,10 @@ class ProfileManager {
}
/**
- * Return whether the profile parameter is visible to the visiting user
+ * Return whether the profile parameter of the target user
+ * is visible to the visiting user
*/
- private function isParameterVisible(IUser $targetUser, ?IUser $visitingUser, string $paramId): bool {
+ private function isParameterVisible(string $paramId, IUser $targetUser, ?IUser $visitingUser): bool {
try {
$account = $this->accountManager->getAccount($targetUser);
$scope = $account->getProperty($paramId)->getScope();
@@ -241,10 +247,12 @@ class ProfileManager {
}
/**
- * Return the profile parameters
+ * Return the profile parameters of the target user that are visible to the visiting user
+ * in an associative array
*/
public function getProfileParams(IUser $targetUser, ?IUser $visitingUser): array {
$account = $this->accountManager->getAccount($targetUser);
+
// Initialize associative array of profile parameters
$profileParameters = [
'userId' => $account->getUser()->getUID(),
@@ -252,16 +260,26 @@ class ProfileManager {
// Add account properties
foreach (self::PROFILE_PROPERTIES as $property) {
- $profileParameters[$property] =
- $this->isParameterVisible($targetUser, $visitingUser, $property)
- // Explicitly set to null when value is empty string
- ? ($account->getProperty($property)->getValue() ?: null)
- : null;
+ 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->isParameterVisible($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);
+ break;
+ }
}
- // Add avatar visibility
- $profileParameters['isUserAvatarVisible'] = $this->isParameterVisible($targetUser, $visitingUser, IAccountManager::PROPERTY_AVATAR);
-
// Add actions
$profileParameters['actions'] = array_map(
function (ILinkAction $action) {
@@ -277,7 +295,7 @@ class ProfileManager {
array_filter(
$this->getActions($targetUser, $visitingUser),
function (ILinkAction $action) use ($targetUser, $visitingUser) {
- return $this->isParameterVisible($targetUser, $visitingUser, $action->getId());
+ return $this->isParameterVisible($action->getId(), $targetUser, $visitingUser);
}
),
)
@@ -287,54 +305,53 @@ class ProfileManager {
}
/**
+ * 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 {
// Contruct the default config for actions
$actionsConfig = [];
foreach ($this->getActions($targetUser, $visitingUser) as $action) {
- $actionsConfig[$action->getId()] = [
- 'displayId' => $action->getDisplayId(),
- 'visibility' => ProfileConfig::DEFAULT_VISIBILITY,
- ];
+ $actionsConfig[$action->getId()] = ['visibility' => ProfileConfig::DEFAULT_VISIBILITY];
}
- // Map of account properties to display IDs
- $propertyDisplayMap = [
- IAccountManager::PROPERTY_ADDRESS => $this->l10nFactory->get('core')->t('Address'),
- IAccountManager::PROPERTY_AVATAR => $this->l10nFactory->get('core')->t('Avatar'),
- IAccountManager::PROPERTY_BIOGRAPHY => $this->l10nFactory->get('core')->t('About'),
- IAccountManager::PROPERTY_DISPLAYNAME => $this->l10nFactory->get('core')->t('Full name'),
- IAccountManager::PROPERTY_HEADLINE => $this->l10nFactory->get('core')->t('Headline'),
- IAccountManager::PROPERTY_ORGANISATION => $this->l10nFactory->get('core')->t('Organisation'),
- IAccountManager::PROPERTY_ROLE => $this->l10nFactory->get('core')->t('Role'),
- IAccountManager::PROPERTY_EMAIL => $this->l10nFactory->get('core')->t('Email'),
- IAccountManager::PROPERTY_PHONE => $this->l10nFactory->get('core')->t('Phone'),
- IAccountManager::PROPERTY_TWITTER => $this->l10nFactory->get('core')->t('Twitter'),
- IAccountManager::PROPERTY_WEBSITE => $this->l10nFactory->get('core')->t('Website'),
- ];
-
// Contruct the default config for account properties
$propertiesConfig = [];
- foreach ($propertyDisplayMap as $property => $displayId) {
- $propertiesConfig[$property] = [
- 'displayId' => $displayId,
- 'visibility' => ProfileConfig::DEFAULT_PROPERTY_VISIBILITY[$property],
- ];
+ foreach (ProfileConfig::DEFAULT_PROPERTY_VISIBILITY as $property => $visibility) {
+ $propertiesConfig[$property] = ['visibility' => $visibility];
}
return array_merge($actionsConfig, $propertiesConfig);
}
/**
- * Return the profile config
+ * 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 {
$config = $this->configMapper->get($targetUser->getUID());
// Merge defaults with the existing config in case the defaults are missing
- $config->setConfigArray(array_merge($defaultProfileConfig, $config->getConfigArray()));
+ $config->setConfigArray(array_merge(
+ $defaultProfileConfig,
+ $this->filterNotStoredProfileConfig($config->getConfigArray()),
+ ));
$this->configMapper->update($config);
$configArray = $config->getConfigArray();
} catch (DoesNotExistException $e) {
@@ -348,4 +365,76 @@ class ProfileManager {
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(self::CORE_APP_ID)->t('Address'),
+ ],
+ IAccountManager::PROPERTY_AVATAR => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('Profile picture'),
+ ],
+ IAccountManager::PROPERTY_BIOGRAPHY => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('About'),
+ ],
+ IAccountManager::PROPERTY_DISPLAYNAME => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('Full name'),
+ ],
+ IAccountManager::PROPERTY_HEADLINE => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('Headline'),
+ ],
+ IAccountManager::PROPERTY_ORGANISATION => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('Organisation'),
+ ],
+ IAccountManager::PROPERTY_ROLE => [
+ 'appId' => self::CORE_APP_ID,
+ 'displayId' => $this->l10nFactory->get(self::CORE_APP_ID)->t('Role'),
+ ],
+ ];
+
+ $paramMetadata = array_merge($actionsMetadata, $propertiesMetadata);
+
+ foreach ($configArray as $paramId => $paramConfig) {
+ if (isset($paramMetadata[$paramId])) {
+ $configArray[$paramId] = array_merge(
+ $paramConfig,
+ $paramMetadata[$paramId],
+ );
+ }
+ }
+
+ return $configArray;
+ }
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-16 07:31:26 +0300