From 653628c8fb69dc3f9d26751520f91e43a18f17ae Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Fri, 20 Sep 2019 11:33:02 +0200 Subject: [PATCH] Allow to set the group display name in the database backend Signed-off-by: Joas Schilling --- apps/provisioning_api/appinfo/routes.php | 1 + .../lib/Controller/GroupsController.php | 24 +++++++++++- core/Command/Group/Add.php | 13 ++++++- lib/private/Group/Database.php | 24 +++++++++++- lib/private/Group/Group.php | 15 ++++++++ .../Group/Backend/ISetDisplayNameBackend.php | 38 +++++++++++++++++++ lib/public/IGroup.php | 9 +++++ 7 files changed, 121 insertions(+), 3 deletions(-) create mode 100644 lib/public/Group/Backend/ISetDisplayNameBackend.php diff --git a/apps/provisioning_api/appinfo/routes.php b/apps/provisioning_api/appinfo/routes.php index fb0a6b235ce..ef13159af5b 100644 --- a/apps/provisioning_api/appinfo/routes.php +++ b/apps/provisioning_api/appinfo/routes.php @@ -40,6 +40,7 @@ return [ ['root' => '/cloud', 'name' => 'Groups#getSubAdminsOfGroup', 'url' => '/groups/{groupId}/subadmins', 'verb' => 'GET', 'requirements' => ['groupId' => '.+']], ['root' => '/cloud', 'name' => 'Groups#addGroup', 'url' => '/groups', 'verb' => 'POST'], ['root' => '/cloud', 'name' => 'Groups#getGroup', 'url' => '/groups/{groupId}', 'verb' => 'GET', 'requirements' => ['groupId' => '.+']], + ['root' => '/cloud', 'name' => 'Groups#updateGroup', 'url' => '/groups/{groupId}', 'verb' => 'PUT', 'requirements' => ['groupId' => '.+']], ['root' => '/cloud', 'name' => 'Groups#deleteGroup', 'url' => '/groups/{groupId}', 'verb' => 'DELETE', 'requirements' => ['groupId' => '.+']], // Users diff --git a/apps/provisioning_api/lib/Controller/GroupsController.php b/apps/provisioning_api/lib/Controller/GroupsController.php index 7c4447ac4eb..72285f55192 100644 --- a/apps/provisioning_api/lib/Controller/GroupsController.php +++ b/apps/provisioning_api/lib/Controller/GroupsController.php @@ -129,7 +129,7 @@ class GroupsController extends AUserData { * * @param string $groupId * @return DataResponse - * @throws OCSException + * @throws OCSException * * @deprecated 14 Use getGroupUsers */ @@ -248,6 +248,28 @@ class GroupsController extends AUserData { return new DataResponse(); } + /** + * @PasswordConfirmationRequired + * + * @param string $groupId + * @param string $key + * @param string $value + * @return DataResponse + * @throws OCSException + */ + public function updateGroup(string $groupId, string $key, string $value): DataResponse { + if ($key === 'displayname') { + $group = $this->groupManager->get($groupId); + if ($group->setDisplayName($value)) { + return new DataResponse(); + } + + throw new OCSException('Not supported by backend', 101); + } else { + throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED); + } + } + /** * @PasswordConfirmationRequired * diff --git a/core/Command/Group/Add.php b/core/Command/Group/Add.php index 61253cf163d..eb2ecd0c533 100644 --- a/core/Command/Group/Add.php +++ b/core/Command/Group/Add.php @@ -28,6 +28,7 @@ use OC\Core\Command\Base; use OCP\IGroupManager; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; class Add extends Base { @@ -49,7 +50,13 @@ class Add extends Base { ->addArgument( 'groupid', InputArgument::REQUIRED, - 'Group name' + 'Group id' + ) + ->addOption( + 'display-name', + null, + InputOption::VALUE_REQUIRED, + 'Group name used in the web UI (can contain any characters)' ); } @@ -62,6 +69,10 @@ class Add extends Base { } else { $group = $this->groupManager->createGroup($gid); $output->writeln('Created group "' . $group->getGID() . '"'); + + if ($input->hasOption('display-name')) { + $group->setDisplayName($input->getOption('display-name')); + } } } } diff --git a/lib/private/Group/Database.php b/lib/private/Group/Database.php index 5e39398c60d..4aab8b8eaec 100644 --- a/lib/private/Group/Database.php +++ b/lib/private/Group/Database.php @@ -52,6 +52,7 @@ use OCP\Group\Backend\IDeleteGroupBackend; use OCP\Group\Backend\IGetDisplayNameBackend; use OCP\Group\Backend\IGroupDetailsBackend; use OCP\Group\Backend\IRemoveFromGroupBackend; +use OCP\Group\Backend\ISetDisplayNameBackend; use OCP\IDBConnection; /** @@ -65,7 +66,8 @@ class Database extends ABackend IDeleteGroupBackend, IGetDisplayNameBackend, IGroupDetailsBackend, - IRemoveFromGroupBackend { + IRemoveFromGroupBackend, + ISetDisplayNameBackend { /** @var string[] */ private $groupCache = []; @@ -450,4 +452,24 @@ class Database extends ABackend return []; } + /** + * @param string $gid + * @param string $displayName + * @return bool + * @since 18.0.0 + */ + public function setDisplayName(string $gid, string $displayName): bool { + if (!$this->groupExists($gid)) { + return false; + } + + $query = $this->dbConn->getQueryBuilder(); + $query->update('groups') + ->set('displayname', $query->createNamedParameter($displayName)) + ->where($query->expr()->eq('gid', $query->createNamedParameter($gid))); + $query->execute(); + + return true; + } + } diff --git a/lib/private/Group/Group.php b/lib/private/Group/Group.php index a50a5ffde78..8d86425c8e5 100644 --- a/lib/private/Group/Group.php +++ b/lib/private/Group/Group.php @@ -33,6 +33,7 @@ namespace OC\Group; use OCP\Group\Backend\IGetDisplayNameBackend; use OCP\Group\Backend\IHideFromCollaborationBackend; use OC\Hooks\PublicEmitter; +use OCP\Group\Backend\ISetDisplayNameBackend; use OCP\GroupInterface; use OCP\IGroup; use OCP\IUser; @@ -101,6 +102,20 @@ class Group implements IGroup { return $this->displayName; } + public function setDisplayName(string $displayName): bool { + $displayName = trim($displayName); + if ($displayName !== '') { + foreach ($this->backends as $backend) { + if (($backend instanceof ISetDisplayNameBackend) + && $backend->setDisplayName($this->gid, $displayName)) { + $this->displayName = $displayName; + return true; + } + } + } + return false; + } + /** * get all users in the group * diff --git a/lib/public/Group/Backend/ISetDisplayNameBackend.php b/lib/public/Group/Backend/ISetDisplayNameBackend.php new file mode 100644 index 00000000000..f75be69438d --- /dev/null +++ b/lib/public/Group/Backend/ISetDisplayNameBackend.php @@ -0,0 +1,38 @@ + + * + * @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 OCP\Group\Backend; + +/** + * @since 18.0.0 + */ +interface ISetDisplayNameBackend { + + /** + * @param string $gid + * @param string $displayName + * @return bool + * @since 18.0.0 + */ + public function setDisplayName(string $gid, string $displayName): bool; + +} diff --git a/lib/public/IGroup.php b/lib/public/IGroup.php index 48fa84df393..8b0eaf0ec0c 100644 --- a/lib/public/IGroup.php +++ b/lib/public/IGroup.php @@ -47,6 +47,15 @@ interface IGroup { */ public function getDisplayName(); + /** + * Set the group display name + * + * @param string $displayName + * @return bool + * @since 18.0.0 + */ + public function setDisplayName(string $displayName): bool; + /** * get all users in the group * -- 2.39.5