nextcloud/apps/provisioning_api/lib/Controller/UsersController.php

988 lines
30 KiB
PHP
Raw Normal View History

<?php
declare(strict_types=1);
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bjoern Schiessle <bjoern@schiessle.org>
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @author Daniel Calviño Sánchez <danxuliu@gmail.com>
* @author Daniel Kesselberg <mail@danielkesselberg.de>
2016-07-21 17:49:16 +03:00
* @author Joas Schilling <coding@schilljs.com>
* @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
* @author Julius Härtl <jus@bitgrid.net>
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2015-10-26 15:54:55 +03:00
* @author michag86 <micha_g@arcor.de>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <robin@icewind.nl>
2016-07-21 17:49:16 +03:00
* @author Roeland Jago Douma <roeland@famdouma.nl>
* @author Thomas Citharel <tcit@tcit.fr>
2015-06-25 12:43:55 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-03-26 13:44:34 +03:00
* @author Tom Needham <tom@owncloud.com>
*
2015-03-26 13:44:34 +03:00
* @license AGPL-3.0
*
2015-03-26 13:44:34 +03:00
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
2015-03-26 13:44:34 +03:00
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
2015-03-26 13:44:34 +03:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
2015-03-26 13:44:34 +03:00
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
2016-08-11 20:49:45 +03:00
namespace OCA\Provisioning_API\Controller;
use OC\Accounts\AccountManager;
use OC\Authentication\Token\RemoteWipe;
use OC\HintException;
use OCA\Provisioning_API\FederatedFileSharingFactory;
use OCA\Settings\Mailer\NewUserMailHelper;
use OCP\App\IAppManager;
2016-08-11 20:49:45 +03:00
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSException;
use OCP\AppFramework\OCS\OCSForbiddenException;
use OCP\IConfig;
use OCP\IGroup;
use OCP\IGroupManager;
2015-10-27 16:09:45 +03:00
use OCP\ILogger;
2016-08-11 20:49:45 +03:00
use OCP\IRequest;
use OCP\IUser;
use OCP\IUserManager;
use OCP\IUserSession;
use OCP\L10N\IFactory;
use OCP\Security\ISecureRandom;
class UsersController extends AUserData {
/** @var IAppManager */
private $appManager;
2015-10-27 16:09:45 +03:00
/** @var ILogger */
private $logger;
/** @var IFactory */
private $l10nFactory;
/** @var NewUserMailHelper */
private $newUserMailHelper;
/** @var FederatedFileSharingFactory */
private $federatedFileSharingFactory;
/** @var ISecureRandom */
private $secureRandom;
/** @var RemoteWipe */
private $remoteWipe;
/**
2016-08-11 20:49:45 +03:00
* @param string $appName
* @param IRequest $request
* @param IUserManager $userManager
* @param IConfig $config
* @param IAppManager $appManager
* @param IGroupManager $groupManager
* @param IUserSession $userSession
* @param AccountManager $accountManager
2015-10-27 16:09:45 +03:00
* @param ILogger $logger
* @param IFactory $l10nFactory
* @param NewUserMailHelper $newUserMailHelper
* @param FederatedFileSharingFactory $federatedFileSharingFactory
* @param ISecureRandom $secureRandom
*/
public function __construct(string $appName,
2016-08-11 20:49:45 +03:00
IRequest $request,
IUserManager $userManager,
IConfig $config,
IAppManager $appManager,
IGroupManager $groupManager,
IUserSession $userSession,
AccountManager $accountManager,
ILogger $logger,
IFactory $l10nFactory,
NewUserMailHelper $newUserMailHelper,
FederatedFileSharingFactory $federatedFileSharingFactory,
ISecureRandom $secureRandom,
RemoteWipe $remoteWipe) {
parent::__construct($appName,
$request,
$userManager,
$config,
$groupManager,
$userSession,
$accountManager);
2016-08-11 20:49:45 +03:00
$this->appManager = $appManager;
2015-10-27 16:09:45 +03:00
$this->logger = $logger;
$this->l10nFactory = $l10nFactory;
$this->newUserMailHelper = $newUserMailHelper;
$this->federatedFileSharingFactory = $federatedFileSharingFactory;
$this->secureRandom = $secureRandom;
$this->remoteWipe = $remoteWipe;
}
/**
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* returns a list of users
*
2016-08-11 20:49:45 +03:00
* @param string $search
* @param int $limit
* @param int $offset
* @return DataResponse
*/
public function getUsers(string $search = '', int $limit = null, int $offset = 0): DataResponse {
$user = $this->userSession->getUser();
$users = [];
// Admin? Or SubAdmin?
2015-10-27 16:09:45 +03:00
$uid = $user->getUID();
$subAdminManager = $this->groupManager->getSubAdmin();
if ($this->groupManager->isAdmin($uid)){
$users = $this->userManager->search($search, $limit, $offset);
2015-10-27 16:09:45 +03:00
} else if ($subAdminManager->isSubAdmin($user)) {
$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($user);
foreach ($subAdminOfGroups as $key => $group) {
$subAdminOfGroups[$key] = $group->getGID();
}
$users = [];
foreach ($subAdminOfGroups as $group) {
$users = array_merge($users, $this->groupManager->displayNamesInGroup($group, $search, $limit, $offset));
}
}
2016-08-11 20:49:45 +03:00
$users = array_keys($users);
2016-08-11 20:49:45 +03:00
return new DataResponse([
'users' => $users
]);
}
/**
* @NoAdminRequired
*
* returns a list of users and their data
*/
public function getUsersDetails(string $search = '', int $limit = null, int $offset = 0): DataResponse {
$currentUser = $this->userSession->getUser();
$users = [];
// Admin? Or SubAdmin?
$uid = $currentUser->getUID();
$subAdminManager = $this->groupManager->getSubAdmin();
if ($this->groupManager->isAdmin($uid)){
$users = $this->userManager->search($search, $limit, $offset);
$users = array_keys($users);
} else if ($subAdminManager->isSubAdmin($currentUser)) {
$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($currentUser);
foreach ($subAdminOfGroups as $key => $group) {
$subAdminOfGroups[$key] = $group->getGID();
}
$users = [];
foreach ($subAdminOfGroups as $group) {
$users[] = array_keys($this->groupManager->displayNamesInGroup($group, $search, $limit, $offset));
}
$users = array_merge(...$users);
}
2016-08-11 20:49:45 +03:00
$usersDetails = [];
foreach ($users as $userId) {
$userId = (string) $userId;
$userData = $this->getUserData($userId);
// Do not insert empty entry
if (!empty($userData)) {
$usersDetails[$userId] = $userData;
} else {
// Logged user does not have permissions to see this user
// only showing its id
$usersDetails[$userId] = ['id' => $userId];
}
}
2016-08-11 20:49:45 +03:00
return new DataResponse([
'users' => $usersDetails
]);
}
/**
* @throws OCSException
*/
private function createNewUserId(): string {
$attempts = 0;
do {
$uidCandidate = $this->secureRandom->generate(10, ISecureRandom::CHAR_HUMAN_READABLE);
if (!$this->userManager->userExists($uidCandidate)) {
return $uidCandidate;
}
$attempts++;
} while ($attempts < 10);
throw new OCSException('Could not create non-existing user id', 111);
}
/**
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* @param string $userid
* @param string $password
* @param string $displayName
* @param string $email
2016-08-11 20:49:45 +03:00
* @param array $groups
* @param array $subadmin
* @param string $quota
* @param string $language
2016-08-11 20:49:45 +03:00
* @return DataResponse
* @throws OCSException
*/
public function addUser(string $userid,
string $password = '',
string $displayName = '',
string $email = '',
array $groups = [],
array $subadmin = [],
string $quota = '',
string $language = ''): DataResponse {
$user = $this->userSession->getUser();
$isAdmin = $this->groupManager->isAdmin($user->getUID());
2015-10-30 11:30:00 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
if(empty($userid) && $this->config->getAppValue('core', 'newUser.generateUserID', 'no') === 'yes') {
$userid = $this->createNewUserId();
}
if ($this->userManager->userExists($userid)) {
2015-10-27 16:09:45 +03:00
$this->logger->error('Failed addUser attempt: User already exists.', ['app' => 'ocs_api']);
2016-08-11 20:49:45 +03:00
throw new OCSException('User already exists', 102);
}
if ($groups !== []) {
2015-10-30 11:30:00 +03:00
foreach ($groups as $group) {
if (!$this->groupManager->groupExists($group)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('group '.$group.' does not exist', 104);
}
if (!$isAdmin && !$subAdminManager->isSubAdminOfGroup($user, $this->groupManager->get($group))) {
2016-08-11 20:49:45 +03:00
throw new OCSException('insufficient privileges for group '. $group, 105);
}
}
} else {
if (!$isAdmin) {
2016-08-11 20:49:45 +03:00
throw new OCSException('no group specified (required for subadmins)', 106);
}
}
$subadminGroups = [];
if ($subadmin !== []) {
foreach ($subadmin as $groupid) {
$group = $this->groupManager->get($groupid);
// Check if group exists
if ($group === null) {
throw new OCSException('Subadmin group does not exist', 102);
}
// Check if trying to make subadmin of admin group
if ($group->getGID() === 'admin') {
throw new OCSException('Cannot create subadmins for admin group', 103);
}
// Check if has permission to promote subadmins
if (!$subAdminManager->isSubAdminOfGroup($user, $group) && !$isAdmin) {
throw new OCSForbiddenException('No permissions to promote subadmins');
}
$subadminGroups[] = $group;
}
}
$generatePasswordResetToken = false;
if ($password === '') {
if ($email === '') {
throw new OCSException('To send a password link to the user an email address is required.', 108);
}
$password = $this->secureRandom->generate(10);
// Make sure we pass the password_policy
$password .= $this->secureRandom->generate(2, '$!.,;:-~+*[]{}()');
$generatePasswordResetToken = true;
}
if ($email === '' && $this->config->getAppValue('core', 'newUser.requireEmail', 'no') === 'yes') {
throw new OCSException('Required email address was not provided', 110);
}
try {
2016-08-11 20:49:45 +03:00
$newUser = $this->userManager->createUser($userid, $password);
$this->logger->info('Successful addUser call with userid: ' . $userid, ['app' => 'ocs_api']);
foreach ($groups as $group) {
$this->groupManager->get($group)->addUser($newUser);
$this->logger->info('Added userid ' . $userid . ' to group ' . $group, ['app' => 'ocs_api']);
}
foreach ($subadminGroups as $group) {
$subAdminManager->createSubAdmin($newUser, $group);
}
if ($displayName !== '') {
$this->editUser($userid, 'display', $displayName);
}
if ($quota !== '') {
$this->editUser($userid, 'quota', $quota);
}
if ($language !== '') {
$this->editUser($userid, 'language', $language);
}
// Send new user mail only if a mail is set
if ($email !== '') {
$newUser->setEMailAddress($email);
try {
$emailTemplate = $this->newUserMailHelper->generateTemplate($newUser, $generatePasswordResetToken);
$this->newUserMailHelper->sendMail($newUser, $emailTemplate);
} catch (\Exception $e) {
// Mail could be failing hard or just be plain not configured
// Logging error as it is the hardest of the two
$this->logger->logException($e, [
'message' => "Unable to send the invitation mail to $email",
'level' => ILogger::ERROR,
'app' => 'ocs_api',
]);
}
}
return new DataResponse(['id' => $userid]);
} catch (HintException $e) {
$this->logger->logException($e, [
'message' => 'Failed addUser attempt with hint exception.',
'level' => ILogger::WARN,
'app' => 'ocs_api',
]);
throw new OCSException($e->getHint(), 107);
} catch (OCSException $e) {
$this->logger->logException($e, [
'message' => 'Failed addUser attempt with ocs exeption.',
'level' => ILogger::ERROR,
'app' => 'ocs_api',
]);
throw $e;
} catch (\Exception $e) {
$this->logger->logException($e, [
'message' => 'Failed addUser attempt with exception.',
'level' => ILogger::ERROR,
'app' => 'ocs_api',
]);
2016-08-11 20:49:45 +03:00
throw new OCSException('Bad request', 101);
}
}
/**
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
* @NoSubAdminRequired
*
* gets user info
*
2016-08-11 20:49:45 +03:00
* @param string $userId
* @return DataResponse
* @throws OCSException
*/
public function getUser(string $userId): DataResponse {
$data = $this->getUserData($userId);
// getUserData returns empty array if not enough permissions
if (empty($data)) {
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
return new DataResponse($data);
}
/**
* @NoAdminRequired
* @NoSubAdminRequired
*
* gets user info from the currently logged in user
*
* @return DataResponse
* @throws OCSException
*/
public function getCurrentUser(): DataResponse {
$user = $this->userSession->getUser();
if ($user) {
$data = $this->getUserData($user->getUID());
// rename "displayname" to "display-name" only for this call to keep
// the API stable.
$data['display-name'] = $data['displayname'];
unset($data['displayname']);
return new DataResponse($data);
}
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
/**
* @NoAdminRequired
* @NoSubAdminRequired
*/
public function getEditableFields(): DataResponse {
$permittedFields = [];
// Editing self (display, email)
if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
$permittedFields[] = AccountManager::PROPERTY_EMAIL;
}
if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
$federatedFileSharing = $this->federatedFileSharingFactory->get();
$shareProvider = $federatedFileSharing->getFederatedShareProvider();
if ($shareProvider->isLookupServerUploadEnabled()) {
$permittedFields[] = AccountManager::PROPERTY_PHONE;
$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
$permittedFields[] = AccountManager::PROPERTY_TWITTER;
}
}
return new DataResponse($permittedFields);
}
2016-08-11 20:49:45 +03:00
/**
* @NoAdminRequired
* @NoSubAdminRequired
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
*
* edit users
*
2016-08-11 20:49:45 +03:00
* @param string $userId
* @param string $key
* @param string $value
* @return DataResponse
* @throws OCSException
*/
public function editUser(string $userId, string $key, string $value): DataResponse {
2015-10-27 16:09:45 +03:00
$currentLoggedInUser = $this->userSession->getUser();
2016-08-11 20:49:45 +03:00
$targetUser = $this->userManager->get($userId);
if ($targetUser === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
2015-10-27 16:09:45 +03:00
}
$permittedFields = [];
if ($targetUser->getUID() === $currentLoggedInUser->getUID()) {
// Editing self (display, email)
if ($this->config->getSystemValue('allow_user_to_change_display_name', true) !== false) {
$permittedFields[] = 'display';
$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
$permittedFields[] = AccountManager::PROPERTY_EMAIL;
}
$permittedFields[] = 'password';
if ($this->config->getSystemValue('force_language', false) === false ||
$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
$permittedFields[] = 'language';
}
if ($this->config->getSystemValue('force_locale', false) === false ||
$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
$permittedFields[] = 'locale';
}
if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
$federatedFileSharing = new \OCA\FederatedFileSharing\AppInfo\Application();
$shareProvider = $federatedFileSharing->getFederatedShareProvider();
if ($shareProvider->isLookupServerUploadEnabled()) {
$permittedFields[] = AccountManager::PROPERTY_PHONE;
$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
$permittedFields[] = AccountManager::PROPERTY_TWITTER;
}
}
// If admin they can edit their own quota
if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
$permittedFields[] = 'quota';
}
} else {
// Check if admin / subadmin
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
if ($subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
2015-10-27 16:09:45 +03:00
|| $this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
// They have permissions over the user
$permittedFields[] = 'display';
$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
$permittedFields[] = AccountManager::PROPERTY_EMAIL;
$permittedFields[] = 'password';
$permittedFields[] = 'language';
$permittedFields[] = 'locale';
$permittedFields[] = AccountManager::PROPERTY_PHONE;
$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
$permittedFields[] = AccountManager::PROPERTY_TWITTER;
$permittedFields[] = 'quota';
} else {
// No rights
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
}
// Check if permitted to edit this field
if (!in_array($key, $permittedFields)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
// Process the edit
2016-08-11 20:49:45 +03:00
switch($key) {
case 'display':
case AccountManager::PROPERTY_DISPLAYNAME:
2016-08-11 20:49:45 +03:00
$targetUser->setDisplayName($value);
break;
case 'quota':
2016-08-11 20:49:45 +03:00
$quota = $value;
if ($quota !== 'none' && $quota !== 'default') {
if (is_numeric($quota)) {
$quota = (float) $quota;
} else {
$quota = \OCP\Util::computerFileSize($quota);
}
if ($quota === false) {
2016-08-11 20:49:45 +03:00
throw new OCSException('Invalid quota value '.$value, 103);
}
if ($quota === -1) {
$quota = 'none';
} else {
$quota = \OCP\Util::humanFileSize($quota);
}
}
$targetUser->setQuota($quota);
break;
case 'password':
try {
if (!$targetUser->canChangePassword()) {
throw new OCSException('Setting the password is not supported by the users backend', 103);
}
$targetUser->setPassword($value);
} catch (HintException $e) { // password policy error
throw new OCSException($e->getMessage(), 103);
}
break;
case 'language':
$languagesCodes = $this->l10nFactory->findAvailableLanguages();
if (!in_array($value, $languagesCodes, true) && $value !== 'en') {
throw new OCSException('Invalid language', 102);
}
$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
break;
case 'locale':
if (!$this->l10nFactory->localeExists($value)) {
throw new OCSException('Invalid locale', 102);
}
$this->config->setUserValue($targetUser->getUID(), 'core', 'locale', $value);
break;
case AccountManager::PROPERTY_EMAIL:
if (filter_var($value, FILTER_VALIDATE_EMAIL) || $value === '') {
2016-08-11 20:49:45 +03:00
$targetUser->setEMailAddress($value);
} else {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 102);
}
break;
case AccountManager::PROPERTY_PHONE:
case AccountManager::PROPERTY_ADDRESS:
case AccountManager::PROPERTY_WEBSITE:
case AccountManager::PROPERTY_TWITTER:
$userAccount = $this->accountManager->getUser($targetUser);
if ($userAccount[$key]['value'] !== $value) {
$userAccount[$key]['value'] = $value;
$this->accountManager->updateUser($targetUser, $userAccount);
}
break;
default:
2016-08-11 20:49:45 +03:00
throw new OCSException('', 103);
}
2016-08-11 20:49:45 +03:00
return new DataResponse();
}
/**
* @PasswordConfirmationRequired
* @NoAdminRequired
*
* @param string $userId
*
* @return DataResponse
*
* @throws OCSException
*/
public function wipeUserDevices(string $userId): DataResponse {
/** @var IUser $currentLoggedInUser */
$currentLoggedInUser = $this->userSession->getUser();
$targetUser = $this->userManager->get($userId);
if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
throw new OCSException('', 101);
}
// If not permitted
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
$this->remoteWipe->markAllTokensForWipe($targetUser);
return new DataResponse();
}
/**
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* @param string $userId
* @return DataResponse
* @throws OCSException
*/
public function deleteUser(string $userId): DataResponse {
2015-10-27 16:09:45 +03:00
$currentLoggedInUser = $this->userSession->getUser();
2016-08-11 20:49:45 +03:00
$targetUser = $this->userManager->get($userId);
2015-10-27 16:09:45 +03:00
if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 101);
}
2015-10-27 16:09:45 +03:00
// If not permitted
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
2015-10-27 16:09:45 +03:00
// Go ahead with the delete
if ($targetUser->delete()) {
2016-08-11 20:49:45 +03:00
return new DataResponse();
} else {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 101);
}
}
/**
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* @param string $userId
* @return DataResponse
* @throws OCSException
* @throws OCSForbiddenException
*/
public function disableUser(string $userId): DataResponse {
2016-08-11 20:49:45 +03:00
return $this->setEnabled($userId, false);
}
/**
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* @param string $userId
* @return DataResponse
* @throws OCSException
* @throws OCSForbiddenException
*/
public function enableUser(string $userId): DataResponse {
2016-08-11 20:49:45 +03:00
return $this->setEnabled($userId, true);
}
/**
2016-08-11 20:49:45 +03:00
* @param string $userId
* @param bool $value
2016-08-11 20:49:45 +03:00
* @return DataResponse
* @throws OCSException
*/
private function setEnabled(string $userId, bool $value): DataResponse {
$currentLoggedInUser = $this->userSession->getUser();
2016-08-11 20:49:45 +03:00
$targetUser = $this->userManager->get($userId);
if ($targetUser === null || $targetUser->getUID() === $currentLoggedInUser->getUID()) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 101);
}
// If not permitted
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$this->groupManager->isAdmin($currentLoggedInUser->getUID()) && !$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
// enable/disable the user now
$targetUser->setEnabled($value);
2016-08-11 20:49:45 +03:00
return new DataResponse();
}
/**
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
* @NoSubAdminRequired
*
* @param string $userId
* @return DataResponse
* @throws OCSException
*/
public function getUsersGroups(string $userId): DataResponse {
2015-10-27 16:09:45 +03:00
$loggedInUser = $this->userSession->getUser();
2016-08-11 20:49:45 +03:00
$targetUser = $this->userManager->get($userId);
if ($targetUser === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
2015-10-27 16:09:45 +03:00
}
if ($targetUser->getUID() === $loggedInUser->getUID() || $this->groupManager->isAdmin($loggedInUser->getUID())) {
// Self lookup or admin lookup
2016-08-11 20:49:45 +03:00
return new DataResponse([
2015-10-27 16:09:45 +03:00
'groups' => $this->groupManager->getUserGroupIds($targetUser)
]);
} else {
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
// Looking up someone else
if ($subAdminManager->isUserAccessible($loggedInUser, $targetUser)) {
// Return the group that the method caller is subadmin of for the user in question
/** @var IGroup[] $getSubAdminsGroups */
2015-10-27 16:09:45 +03:00
$getSubAdminsGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
foreach ($getSubAdminsGroups as $key => $group) {
$getSubAdminsGroups[$key] = $group->getGID();
}
$groups = array_intersect(
2015-10-27 16:09:45 +03:00
$getSubAdminsGroups,
$this->groupManager->getUserGroupIds($targetUser)
);
2016-08-11 20:49:45 +03:00
return new DataResponse(['groups' => $groups]);
} else {
// Not permitted
2016-08-11 20:49:45 +03:00
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
}
}
/**
* @PasswordConfirmationRequired
* @NoAdminRequired
*
2016-08-11 20:49:45 +03:00
* @param string $userId
* @param string $groupid
* @return DataResponse
* @throws OCSException
*/
public function addToGroup(string $userId, string $groupid = ''): DataResponse {
if ($groupid === '') {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 101);
}
2016-08-11 20:49:45 +03:00
$group = $this->groupManager->get($groupid);
$targetUser = $this->userManager->get($userId);
if ($group === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 102);
}
if ($targetUser === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 103);
}
2015-10-27 16:09:45 +03:00
// If they're not an admin, check they are a subadmin of the group in question
$loggedInUser = $this->userSession->getUser();
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
throw new OCSException('', 104);
}
// Add user to group
2015-10-27 16:09:45 +03:00
$group->addUser($targetUser);
2016-08-11 20:49:45 +03:00
return new DataResponse();
}
/**
* @PasswordConfirmationRequired
2016-08-11 20:49:45 +03:00
* @NoAdminRequired
*
* @param string $userId
2016-08-11 20:49:45 +03:00
* @param string $groupid
* @return DataResponse
* @throws OCSException
*/
public function removeFromGroup(string $userId, string $groupid): DataResponse {
2015-10-27 16:09:45 +03:00
$loggedInUser = $this->userSession->getUser();
if ($groupid === null || trim($groupid) === '') {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 101);
}
2015-10-27 16:09:45 +03:00
2016-08-11 20:49:45 +03:00
$group = $this->groupManager->get($groupid);
if ($group === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 102);
}
2016-08-11 20:49:45 +03:00
$targetUser = $this->userManager->get($userId);
if ($targetUser === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 103);
2015-10-27 16:09:45 +03:00
}
// If they're not an admin, check they are a subadmin of the group in question
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$this->groupManager->isAdmin($loggedInUser->getUID()) && !$subAdminManager->isSubAdminOfGroup($loggedInUser, $group)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('', 104);
}
// Check they aren't removing themselves from 'admin' or their 'subadmin; group
if ($targetUser->getUID() === $loggedInUser->getUID()) {
if ($this->groupManager->isAdmin($loggedInUser->getUID())) {
if ($group->getGID() === 'admin') {
2016-08-11 20:49:45 +03:00
throw new OCSException('Cannot remove yourself from the admin group', 105);
}
} else {
// Not an admin, so the user must be a subadmin of this group, but that is not allowed.
throw new OCSException('Cannot remove yourself from this group as you are a SubAdmin', 105);
}
} else if (!$this->groupManager->isAdmin($loggedInUser->getUID())) {
/** @var IGroup[] $subAdminGroups */
$subAdminGroups = $subAdminManager->getSubAdminsGroups($loggedInUser);
$subAdminGroups = array_map(function (IGroup $subAdminGroup) {
return $subAdminGroup->getGID();
}, $subAdminGroups);
$userGroups = $this->groupManager->getUserGroupIds($targetUser);
$userSubAdminGroups = array_intersect($subAdminGroups, $userGroups);
if (count($userSubAdminGroups) <= 1) {
// Subadmin must not be able to remove a user from all their subadmin groups.
throw new OCSException('Not viable to remove user from the last group you are SubAdmin of', 105);
}
}
2015-10-27 16:09:45 +03:00
// Remove user from group
2015-10-27 16:09:45 +03:00
$group->removeUser($targetUser);
2016-08-11 20:49:45 +03:00
return new DataResponse();
}
/**
* Creates a subadmin
*
* @PasswordConfirmationRequired
*
2016-08-11 20:49:45 +03:00
* @param string $userId
* @param string $groupid
* @return DataResponse
* @throws OCSException
*/
public function addSubAdmin(string $userId, string $groupid): DataResponse {
2016-08-11 20:49:45 +03:00
$group = $this->groupManager->get($groupid);
$user = $this->userManager->get($userId);
2015-10-27 16:09:45 +03:00
// Check if the user exists
if ($user === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('User does not exist', 101);
}
// Check if group exists
if ($group === null) {
throw new OCSException('Group does not exist', 102);
}
// Check if trying to make subadmin of admin group
if ($group->getGID() === 'admin') {
2016-08-11 20:49:45 +03:00
throw new OCSException('Cannot create subadmins for admin group', 103);
}
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
// We cannot be subadmin twice
if ($subAdminManager->isSubAdminOfGroup($user, $group)) {
2016-08-11 20:49:45 +03:00
return new DataResponse();
}
// Go
$subAdminManager->createSubAdmin($user, $group);
return new DataResponse();
}
/**
* Removes a subadmin from a group
*
* @PasswordConfirmationRequired
*
2016-08-11 20:49:45 +03:00
* @param string $userId
* @param string $groupid
* @return DataResponse
* @throws OCSException
*/
public function removeSubAdmin(string $userId, string $groupid): DataResponse {
2016-08-11 20:49:45 +03:00
$group = $this->groupManager->get($groupid);
$user = $this->userManager->get($userId);
2015-10-27 16:09:45 +03:00
$subAdminManager = $this->groupManager->getSubAdmin();
// Check if the user exists
if ($user === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('User does not exist', 101);
}
2015-10-27 16:09:45 +03:00
// Check if the group exists
if ($group === null) {
2016-08-11 20:49:45 +03:00
throw new OCSException('Group does not exist', 101);
2015-10-27 16:09:45 +03:00
}
// Check if they are a subadmin of this said group
if (!$subAdminManager->isSubAdminOfGroup($user, $group)) {
2016-08-11 20:49:45 +03:00
throw new OCSException('User is not a subadmin of this group', 102);
}
2015-10-27 16:09:45 +03:00
// Go
$subAdminManager->deleteSubAdmin($user, $group);
return new DataResponse();
}
/**
* Get the groups a user is a subadmin of
*
* @param string $userId
* @return DataResponse
* @throws OCSException
*/
public function getUserSubAdminGroups(string $userId): DataResponse {
$groups = $this->getUserSubAdminGroupsData($userId);
return new DataResponse($groups);
}
/**
* @NoAdminRequired
* @PasswordConfirmationRequired
*
* resend welcome message
*
* @param string $userId
* @return DataResponse
* @throws OCSException
*/
public function resendWelcomeMessage(string $userId): DataResponse {
$currentLoggedInUser = $this->userSession->getUser();
$targetUser = $this->userManager->get($userId);
if ($targetUser === null) {
throw new OCSException('', \OCP\API::RESPOND_NOT_FOUND);
}
// Check if admin / subadmin
$subAdminManager = $this->groupManager->getSubAdmin();
if (!$subAdminManager->isUserAccessible($currentLoggedInUser, $targetUser)
&& !$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
// No rights
throw new OCSException('', \OCP\API::RESPOND_UNAUTHORISED);
}
$email = $targetUser->getEMailAddress();
if ($email === '' || $email === null) {
throw new OCSException('Email address not available', 101);
}
try {
$emailTemplate = $this->newUserMailHelper->generateTemplate($targetUser, false);
$this->newUserMailHelper->sendMail($targetUser, $emailTemplate);
} catch(\Exception $e) {
$this->logger->logException($e, [
'message' => "Can't send new user mail to $email",
'level' => ILogger::ERROR,
'app' => 'settings',
]);
throw new OCSException('Sending email failed', 102);
}
return new DataResponse();
}
}