mirror of
https://github.com/nextcloud/server.git
synced 2025-02-11 11:39:27 +00:00
350 lines
11 KiB
PHP
350 lines
11 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
namespace OCA\Provisioning_API\Controller;
|
|
|
|
use OCA\Provisioning_API\ResponseDefinitions;
|
|
use OCA\Settings\Settings\Admin\Sharing;
|
|
use OCA\Settings\Settings\Admin\Users;
|
|
use OCP\Accounts\IAccountManager;
|
|
use OCP\AppFramework\Http;
|
|
use OCP\AppFramework\Http\Attribute\AuthorizedAdminSetting;
|
|
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
|
|
use OCP\AppFramework\Http\Attribute\PasswordConfirmationRequired;
|
|
use OCP\AppFramework\Http\DataResponse;
|
|
use OCP\AppFramework\OCS\OCSException;
|
|
use OCP\AppFramework\OCS\OCSForbiddenException;
|
|
use OCP\AppFramework\OCS\OCSNotFoundException;
|
|
use OCP\AppFramework\OCSController;
|
|
use OCP\Files\IRootFolder;
|
|
use OCP\Group\ISubAdmin;
|
|
use OCP\IConfig;
|
|
use OCP\IGroup;
|
|
use OCP\IGroupManager;
|
|
use OCP\IRequest;
|
|
use OCP\IUser;
|
|
use OCP\IUserManager;
|
|
use OCP\IUserSession;
|
|
use OCP\L10N\IFactory;
|
|
use Psr\Log\LoggerInterface;
|
|
|
|
/**
|
|
* @psalm-import-type Provisioning_APIGroupDetails from ResponseDefinitions
|
|
* @psalm-import-type Provisioning_APIUserDetails from ResponseDefinitions
|
|
*/
|
|
class GroupsController extends AUserDataOCSController {
|
|
|
|
public function __construct(
|
|
string $appName,
|
|
IRequest $request,
|
|
IUserManager $userManager,
|
|
IConfig $config,
|
|
IGroupManager $groupManager,
|
|
IUserSession $userSession,
|
|
IAccountManager $accountManager,
|
|
ISubAdmin $subAdminManager,
|
|
IFactory $l10nFactory,
|
|
IRootFolder $rootFolder,
|
|
private LoggerInterface $logger,
|
|
) {
|
|
parent::__construct($appName,
|
|
$request,
|
|
$userManager,
|
|
$config,
|
|
$groupManager,
|
|
$userSession,
|
|
$accountManager,
|
|
$subAdminManager,
|
|
$l10nFactory,
|
|
$rootFolder,
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get a list of groups
|
|
*
|
|
* @param string $search Text to search for
|
|
* @param ?int $limit Limit the amount of groups returned
|
|
* @param int $offset Offset for searching for groups
|
|
* @return DataResponse<Http::STATUS_OK, array{groups: list<string>}, array{}>
|
|
*
|
|
* 200: Groups returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function getGroups(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
|
|
$groups = $this->groupManager->search($search, $limit, $offset);
|
|
$groups = array_values(array_map(function ($group) {
|
|
/** @var IGroup $group */
|
|
return $group->getGID();
|
|
}, $groups));
|
|
|
|
return new DataResponse(['groups' => $groups]);
|
|
}
|
|
|
|
/**
|
|
* Get a list of groups details
|
|
*
|
|
* @param string $search Text to search for
|
|
* @param ?int $limit Limit the amount of groups returned
|
|
* @param int $offset Offset for searching for groups
|
|
* @return DataResponse<Http::STATUS_OK, array{groups: list<Provisioning_APIGroupDetails>}, array{}>
|
|
*
|
|
* 200: Groups details returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
#[AuthorizedAdminSetting(settings: Sharing::class)]
|
|
public function getGroupsDetails(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
|
|
$groups = $this->groupManager->search($search, $limit, $offset);
|
|
$groups = array_values(array_map(function ($group) {
|
|
/** @var IGroup $group */
|
|
return [
|
|
'id' => $group->getGID(),
|
|
'displayname' => $group->getDisplayName(),
|
|
'usercount' => $group->count(),
|
|
'disabled' => $group->countDisabled(),
|
|
'canAdd' => $group->canAddUser(),
|
|
'canRemove' => $group->canRemoveUser(),
|
|
];
|
|
}, $groups));
|
|
|
|
return new DataResponse(['groups' => $groups]);
|
|
}
|
|
|
|
/**
|
|
* Get a list of users in the specified group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @return DataResponse<Http::STATUS_OK, array{users: list<string>}, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* @deprecated 14 Use getGroupUsers
|
|
*
|
|
* 200: Group users returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function getGroup(string $groupId): DataResponse {
|
|
return $this->getGroupUsers($groupId);
|
|
}
|
|
|
|
/**
|
|
* Get a list of users in the specified group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @return DataResponse<Http::STATUS_OK, array{users: list<string>}, array{}>
|
|
* @throws OCSException
|
|
* @throws OCSNotFoundException Group not found
|
|
* @throws OCSForbiddenException Missing permissions to get users in the group
|
|
*
|
|
* 200: User IDs returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function getGroupUsers(string $groupId): DataResponse {
|
|
$groupId = urldecode($groupId);
|
|
|
|
$user = $this->userSession->getUser();
|
|
$isSubadminOfGroup = false;
|
|
|
|
// Check the group exists
|
|
$group = $this->groupManager->get($groupId);
|
|
if ($group !== null) {
|
|
$isSubadminOfGroup = $this->groupManager->getSubAdmin()->isSubAdminOfGroup($user, $group);
|
|
} else {
|
|
throw new OCSNotFoundException('The requested group could not be found');
|
|
}
|
|
|
|
// Check subadmin has access to this group
|
|
$isAdmin = $this->groupManager->isAdmin($user->getUID());
|
|
$isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($user->getUID());
|
|
if ($isAdmin || $isDelegatedAdmin || $isSubadminOfGroup) {
|
|
$users = $this->groupManager->get($groupId)->getUsers();
|
|
$users = array_map(function ($user) {
|
|
/** @var IUser $user */
|
|
return $user->getUID();
|
|
}, $users);
|
|
/** @var list<string> $users */
|
|
$users = array_values($users);
|
|
return new DataResponse(['users' => $users]);
|
|
}
|
|
|
|
throw new OCSForbiddenException();
|
|
}
|
|
|
|
/**
|
|
* Get a list of users details in the specified group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @param string $search Text to search for
|
|
* @param int|null $limit Limit the amount of groups returned
|
|
* @param int $offset Offset for searching for groups
|
|
*
|
|
* @return DataResponse<Http::STATUS_OK, array{users: array<string, Provisioning_APIUserDetails|array{id: string}>}, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* 200: Group users details returned
|
|
*/
|
|
#[NoAdminRequired]
|
|
public function getGroupUsersDetails(string $groupId, string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
|
|
$groupId = urldecode($groupId);
|
|
$currentUser = $this->userSession->getUser();
|
|
|
|
// Check the group exists
|
|
$group = $this->groupManager->get($groupId);
|
|
if ($group !== null) {
|
|
$isSubadminOfGroup = $this->groupManager->getSubAdmin()->isSubAdminOfGroup($currentUser, $group);
|
|
} else {
|
|
throw new OCSException('The requested group could not be found', OCSController::RESPOND_NOT_FOUND);
|
|
}
|
|
|
|
// Check subadmin has access to this group
|
|
$isAdmin = $this->groupManager->isAdmin($currentUser->getUID());
|
|
$isDelegatedAdmin = $this->groupManager->isDelegatedAdmin($currentUser->getUID());
|
|
if ($isAdmin || $isDelegatedAdmin || $isSubadminOfGroup) {
|
|
$users = $group->searchUsers($search, $limit, $offset);
|
|
|
|
// Extract required number
|
|
$usersDetails = [];
|
|
foreach ($users as $user) {
|
|
try {
|
|
/** @var IUser $user */
|
|
$userId = (string)$user->getUID();
|
|
$userData = $this->getUserData($userId);
|
|
// Do not insert empty entry
|
|
if ($userData !== null) {
|
|
$usersDetails[$userId] = $userData;
|
|
} else {
|
|
// Logged user does not have permissions to see this user
|
|
// only showing its id
|
|
$usersDetails[$userId] = ['id' => $userId];
|
|
}
|
|
} catch (OCSNotFoundException $e) {
|
|
// continue if a users ceased to exist.
|
|
}
|
|
}
|
|
return new DataResponse(['users' => $usersDetails]);
|
|
}
|
|
|
|
throw new OCSException('The requested group could not be found', OCSController::RESPOND_NOT_FOUND);
|
|
}
|
|
|
|
/**
|
|
* Create a new group
|
|
*
|
|
* @param string $groupid ID of the group
|
|
* @param string $displayname Display name of the group
|
|
* @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* 200: Group created successfully
|
|
*/
|
|
#[AuthorizedAdminSetting(settings:Users::class)]
|
|
#[PasswordConfirmationRequired]
|
|
public function addGroup(string $groupid, string $displayname = ''): DataResponse {
|
|
// Validate name
|
|
if (empty($groupid)) {
|
|
$this->logger->error('Group name not supplied', ['app' => 'provisioning_api']);
|
|
throw new OCSException('Invalid group name', 101);
|
|
}
|
|
// Check if it exists
|
|
if ($this->groupManager->groupExists($groupid)) {
|
|
throw new OCSException('group exists', 102);
|
|
}
|
|
$group = $this->groupManager->createGroup($groupid);
|
|
if ($group === null) {
|
|
throw new OCSException('Not supported by backend', 103);
|
|
}
|
|
if ($displayname !== '') {
|
|
$group->setDisplayName($displayname);
|
|
}
|
|
return new DataResponse();
|
|
}
|
|
|
|
/**
|
|
* Update a group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @param string $key Key to update, only 'displayname'
|
|
* @param string $value New value for the key
|
|
* @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* 200: Group updated successfully
|
|
*/
|
|
#[AuthorizedAdminSetting(settings:Users::class)]
|
|
#[PasswordConfirmationRequired]
|
|
public function updateGroup(string $groupId, string $key, string $value): DataResponse {
|
|
$groupId = urldecode($groupId);
|
|
|
|
if ($key === 'displayname') {
|
|
$group = $this->groupManager->get($groupId);
|
|
if ($group === null) {
|
|
throw new OCSException('Group does not exist', OCSController::RESPOND_NOT_FOUND);
|
|
}
|
|
if ($group->setDisplayName($value)) {
|
|
return new DataResponse();
|
|
}
|
|
|
|
throw new OCSException('Not supported by backend', 101);
|
|
} else {
|
|
throw new OCSException('', OCSController::RESPOND_UNKNOWN_ERROR);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete a group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @return DataResponse<Http::STATUS_OK, list<empty>, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* 200: Group deleted successfully
|
|
*/
|
|
#[AuthorizedAdminSetting(settings:Users::class)]
|
|
#[PasswordConfirmationRequired]
|
|
public function deleteGroup(string $groupId): DataResponse {
|
|
$groupId = urldecode($groupId);
|
|
|
|
// Check it exists
|
|
if (!$this->groupManager->groupExists($groupId)) {
|
|
throw new OCSException('', 101);
|
|
} elseif ($groupId === 'admin' || !$this->groupManager->get($groupId)->delete()) {
|
|
// Cannot delete admin group
|
|
throw new OCSException('', 102);
|
|
}
|
|
|
|
return new DataResponse();
|
|
}
|
|
|
|
/**
|
|
* Get the list of user IDs that are a subadmin of the group
|
|
*
|
|
* @param string $groupId ID of the group
|
|
* @return DataResponse<Http::STATUS_OK, list<string>, array{}>
|
|
* @throws OCSException
|
|
*
|
|
* 200: Sub admins returned
|
|
*/
|
|
#[AuthorizedAdminSetting(settings:Users::class)]
|
|
public function getSubAdminsOfGroup(string $groupId): DataResponse {
|
|
// Check group exists
|
|
$targetGroup = $this->groupManager->get($groupId);
|
|
if ($targetGroup === null) {
|
|
throw new OCSException('Group does not exist', 101);
|
|
}
|
|
|
|
/** @var IUser[] $subadmins */
|
|
$subadmins = $this->groupManager->getSubAdmin()->getGroupsSubAdmins($targetGroup);
|
|
// New class returns IUser[] so convert back
|
|
/** @var list<string> $uids */
|
|
$uids = [];
|
|
foreach ($subadmins as $user) {
|
|
$uids[] = $user->getUID();
|
|
}
|
|
|
|
return new DataResponse($uids);
|
|
}
|
|
}
|