From 309354852f12ae88d5eef05d311d6ebcba8ee762 Mon Sep 17 00:00:00 2001 From: Christopher Ng Date: Thu, 14 Oct 2021 08:19:40 +0000 Subject: Profile backend Signed-off-by: Christopher Ng --- core/Db/ProfileConfig.php | 172 ++++++++++++++++++++++++++++++++++++++++ core/Db/ProfileConfigMapper.php | 48 +++++++++++ 2 files changed, 220 insertions(+) create mode 100644 core/Db/ProfileConfig.php create mode 100644 core/Db/ProfileConfigMapper.php (limited to 'core/Db') diff --git a/core/Db/ProfileConfig.php b/core/Db/ProfileConfig.php new file mode 100644 index 00000000000..eb50da37a64 --- /dev/null +++ b/core/Db/ProfileConfig.php @@ -0,0 +1,172 @@ + + * + * @author Christopher Ng + * + * @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 . + * + */ + +namespace OC\Core\Db; + +use function Safe\json_decode; +use function Safe\json_encode; +use \JsonSerializable; +use OCP\Accounts\IAccountManager; +use OCP\AppFramework\Db\Entity; +use OCP\Profile\ParameterDoesNotExistException; + +/** + * @method string getUserId() + * @method void setUserId(string $userId) + * @method string getConfig() + * @method void setConfig(string $config) + */ +class ProfileConfig extends Entity implements JsonSerializable { + + /** + * Visible to users, guests, and public access + * + * @since 23.0.0 + */ + public const VISIBILITY_SHOW = 'show'; + + /** + * Visible to users and guests + * + * @since 23.0.0 + */ + public const VISIBILITY_SHOW_USERS_ONLY = 'show_users_only'; + + /** + * Visible to nobody + * + * @since 23.0.0 + */ + public const VISIBILITY_HIDE = 'hide'; + + /** + * Default account property visibility + * + * @since 23.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_WEBSITE => self::VISIBILITY_SHOW, + ]; + + /** + * Default visibility + * + * @since 23.0.0 + */ + public const DEFAULT_VISIBILITY = self::VISIBILITY_SHOW_USERS_ONLY; + + /** @var string */ + protected $userId; + + /** @var string */ + protected $config; + + public function __construct() { + $this->addType('userId', 'string'); + $this->addType('config', 'string'); + } + + /** + * Returns the config in an associative array + */ + public function getConfigArray(): array { + return json_decode($this->config, true); + } + + /** + * Set the config + */ + public function setConfigArray(array $config): void { + $this->setConfig(json_encode($config)); + } + + /** + * Returns the visibility map in an associative array + */ + public function getVisibilityMap(): array { + $config = $this->getConfigArray(); + $visibilityMap = []; + foreach ($config as $paramId => $paramConfig) { + $visibilityMap[$paramId] = $paramConfig['visibility']; + } + + return $visibilityMap; + } + + /** + * Set the visibility map + */ + public function setVisibilityMap(array $visibilityMap): void { + $config = $this->getConfigArray(); + foreach ($visibilityMap as $paramId => $visibility) { + $config[$paramId] = array_merge( + $config[$paramId] ?: [], + ['visibility' => $visibility], + ); + } + + $this->setConfigArray($config); + } + + /** + * Returns the visibility of the parameter + * + * @throws ParameterDoesNotExistException + */ + public function getVisibility(string $paramId): string { + $visibilityMap = $this->getVisibilityMap(); + if (isset($visibilityMap[$paramId])) { + return $visibilityMap[$paramId]; + } + throw new ParameterDoesNotExistException($paramId); + } + + /** + * Set the visibility of the parameter + */ + public function setVisibility(string $paramId, string $visibility): void { + $visibilityMap = $this->getVisibilityMap(); + $visibilityMap[$paramId] = $visibility; + $this->setVisibilityMap($visibilityMap); + } + + public function jsonSerialize(): array { + return [ + 'userId' => $this->userId, + 'config' => $this->getConfigArray(), + ]; + } +} diff --git a/core/Db/ProfileConfigMapper.php b/core/Db/ProfileConfigMapper.php new file mode 100644 index 00000000000..a8b1e35f747 --- /dev/null +++ b/core/Db/ProfileConfigMapper.php @@ -0,0 +1,48 @@ + + * + * @author Christopher Ng + * + * @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 . + * + */ + +namespace OC\Core\Db; + +use OCP\AppFramework\Db\QBMapper; +use OCP\IDBConnection; + +class ProfileConfigMapper extends QBMapper { + public function __construct(IDBConnection $db) { + parent::__construct($db, 'profile_config', ProfileConfig::class); + } + + public function get(string $userId): ProfileConfig { + $qb = $this->db->getQueryBuilder(); + $qb->select('*') + ->from($this->getTableName()) + ->where($qb->expr()->eq('user_id', $qb->createNamedParameter($userId))); + return $this->findEntity($qb); + } + + public function getArray(string $userId): array { + return $this->get($userId)->getConfigArray(); + } +} -- cgit v1.2.3