You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
476 lines
13 KiB
476 lines
13 KiB
<?php |
|
/** |
|
* @copyright Copyright (c) 2016, ownCloud, Inc. |
|
* |
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
|
* @author Bart Visscher <bartv@thisnet.nl> |
|
* @author Björn Schießle <bjoern@schiessle.org> |
|
* @author Joas Schilling <coding@schilljs.com> |
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de> |
|
* @author Lukas Reschke <lukas@statuscode.ch> |
|
* @author Morris Jobke <hey@morrisjobke.de> |
|
* @author Robin Appelman <robin@icewind.nl> |
|
* @author Thomas Müller <thomas.mueller@tmit.eu> |
|
* @author Vincent Petry <pvince81@owncloud.com> |
|
* |
|
* @license AGPL-3.0 |
|
* |
|
* 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. |
|
* |
|
* 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, version 3, |
|
* along with this program. If not, see <http://www.gnu.org/licenses/> |
|
* |
|
*/ |
|
|
|
namespace OC\User; |
|
|
|
use OC\Accounts\AccountManager; |
|
use OC\Files\Cache\Storage; |
|
use OC\Hooks\Emitter; |
|
use OC_Helper; |
|
use OCP\IAvatarManager; |
|
use OCP\IImage; |
|
use OCP\IURLGenerator; |
|
use OCP\IUser; |
|
use OCP\IConfig; |
|
use OCP\UserInterface; |
|
use \OCP\IUserBackend; |
|
use Symfony\Component\EventDispatcher\EventDispatcherInterface; |
|
use Symfony\Component\EventDispatcher\GenericEvent; |
|
|
|
class User implements IUser { |
|
/** @var string */ |
|
private $uid; |
|
|
|
/** @var string */ |
|
private $displayName; |
|
|
|
/** @var UserInterface|null */ |
|
private $backend; |
|
/** @var EventDispatcherInterface */ |
|
private $dispatcher; |
|
|
|
/** @var bool */ |
|
private $enabled; |
|
|
|
/** @var Emitter|Manager */ |
|
private $emitter; |
|
|
|
/** @var string */ |
|
private $home; |
|
|
|
/** @var int */ |
|
private $lastLogin; |
|
|
|
/** @var \OCP\IConfig */ |
|
private $config; |
|
|
|
/** @var IAvatarManager */ |
|
private $avatarManager; |
|
|
|
/** @var IURLGenerator */ |
|
private $urlGenerator; |
|
|
|
public function __construct(string $uid, ?UserInterface $backend, EventDispatcherInterface $dispatcher, $emitter = null, IConfig $config = null, $urlGenerator = null) { |
|
$this->uid = $uid; |
|
$this->backend = $backend; |
|
$this->dispatcher = $dispatcher; |
|
$this->emitter = $emitter; |
|
if(is_null($config)) { |
|
$config = \OC::$server->getConfig(); |
|
} |
|
$this->config = $config; |
|
$this->urlGenerator = $urlGenerator; |
|
$enabled = $this->config->getUserValue($uid, 'core', 'enabled', 'true'); |
|
$this->enabled = ($enabled === 'true'); |
|
$this->lastLogin = $this->config->getUserValue($uid, 'login', 'lastLogin', 0); |
|
if (is_null($this->urlGenerator)) { |
|
$this->urlGenerator = \OC::$server->getURLGenerator(); |
|
} |
|
} |
|
|
|
/** |
|
* get the user id |
|
* |
|
* @return string |
|
*/ |
|
public function getUID() { |
|
return $this->uid; |
|
} |
|
|
|
/** |
|
* get the display name for the user, if no specific display name is set it will fallback to the user id |
|
* |
|
* @return string |
|
*/ |
|
public function getDisplayName() { |
|
if (!isset($this->displayName)) { |
|
$displayName = ''; |
|
if ($this->backend && $this->backend->implementsActions(Backend::GET_DISPLAYNAME)) { |
|
// get display name and strip whitespace from the beginning and end of it |
|
$backendDisplayName = $this->backend->getDisplayName($this->uid); |
|
if (is_string($backendDisplayName)) { |
|
$displayName = trim($backendDisplayName); |
|
} |
|
} |
|
|
|
if (!empty($displayName)) { |
|
$this->displayName = $displayName; |
|
} else { |
|
$this->displayName = $this->uid; |
|
} |
|
} |
|
return $this->displayName; |
|
} |
|
|
|
/** |
|
* set the displayname for the user |
|
* |
|
* @param string $displayName |
|
* @return bool |
|
*/ |
|
public function setDisplayName($displayName) { |
|
$displayName = trim($displayName); |
|
$oldDisplayName = $this->getDisplayName(); |
|
if ($this->backend->implementsActions(Backend::SET_DISPLAYNAME) && !empty($displayName) && $displayName !== $oldDisplayName) { |
|
$result = $this->backend->setDisplayName($this->uid, $displayName); |
|
if ($result) { |
|
$this->displayName = $displayName; |
|
$this->triggerChange('displayName', $displayName, $oldDisplayName); |
|
} |
|
return $result !== false; |
|
} |
|
return false; |
|
} |
|
|
|
/** |
|
* set the email address of the user |
|
* |
|
* @param string|null $mailAddress |
|
* @return void |
|
* @since 9.0.0 |
|
*/ |
|
public function setEMailAddress($mailAddress) { |
|
$oldMailAddress = $this->getEMailAddress(); |
|
if($oldMailAddress !== $mailAddress) { |
|
if($mailAddress === '') { |
|
$this->config->deleteUserValue($this->uid, 'settings', 'email'); |
|
} else { |
|
$this->config->setUserValue($this->uid, 'settings', 'email', $mailAddress); |
|
} |
|
$this->triggerChange('eMailAddress', $mailAddress, $oldMailAddress); |
|
} |
|
} |
|
|
|
/** |
|
* returns the timestamp of the user's last login or 0 if the user did never |
|
* login |
|
* |
|
* @return int |
|
*/ |
|
public function getLastLogin() { |
|
return $this->lastLogin; |
|
} |
|
|
|
/** |
|
* updates the timestamp of the most recent login of this user |
|
*/ |
|
public function updateLastLoginTimestamp() { |
|
$firstTimeLogin = ($this->lastLogin === 0); |
|
$this->lastLogin = time(); |
|
$this->config->setUserValue( |
|
$this->uid, 'login', 'lastLogin', $this->lastLogin); |
|
|
|
return $firstTimeLogin; |
|
} |
|
|
|
/** |
|
* Delete the user |
|
* |
|
* @return bool |
|
*/ |
|
public function delete() { |
|
$this->dispatcher->dispatch(IUser::class . '::preDelete', new GenericEvent($this)); |
|
if ($this->emitter) { |
|
$this->emitter->emit('\OC\User', 'preDelete', array($this)); |
|
} |
|
// get the home now because it won't return it after user deletion |
|
$homePath = $this->getHome(); |
|
$result = $this->backend->deleteUser($this->uid); |
|
if ($result) { |
|
|
|
// FIXME: Feels like an hack - suggestions? |
|
|
|
$groupManager = \OC::$server->getGroupManager(); |
|
// We have to delete the user from all groups |
|
foreach ($groupManager->getUserGroupIds($this) as $groupId) { |
|
$group = $groupManager->get($groupId); |
|
if ($group) { |
|
\OC_Hook::emit("OC_Group", "pre_removeFromGroup", ["run" => true, "uid" => $this->uid, "gid" => $groupId]); |
|
$group->removeUser($this); |
|
\OC_Hook::emit("OC_User", "post_removeFromGroup", ["uid" => $this->uid, "gid" => $groupId]); |
|
} |
|
} |
|
// Delete the user's keys in preferences |
|
\OC::$server->getConfig()->deleteAllUserValues($this->uid); |
|
|
|
// Delete user files in /data/ |
|
if ($homePath !== false) { |
|
// FIXME: this operates directly on FS, should use View instead... |
|
// also this is not testable/mockable... |
|
\OC_Helper::rmdirr($homePath); |
|
} |
|
|
|
// Delete the users entry in the storage table |
|
Storage::remove('home::' . $this->uid); |
|
|
|
\OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid); |
|
\OC::$server->getCommentsManager()->deleteReadMarksFromUser($this); |
|
|
|
$notification = \OC::$server->getNotificationManager()->createNotification(); |
|
$notification->setUser($this->uid); |
|
\OC::$server->getNotificationManager()->markProcessed($notification); |
|
|
|
/** @var AccountManager $accountManager */ |
|
$accountManager = \OC::$server->query(AccountManager::class); |
|
$accountManager->deleteUser($this); |
|
|
|
$this->dispatcher->dispatch(IUser::class . '::postDelete', new GenericEvent($this)); |
|
if ($this->emitter) { |
|
$this->emitter->emit('\OC\User', 'postDelete', array($this)); |
|
} |
|
} |
|
return !($result === false); |
|
} |
|
|
|
/** |
|
* Set the password of the user |
|
* |
|
* @param string $password |
|
* @param string $recoveryPassword for the encryption app to reset encryption keys |
|
* @return bool |
|
*/ |
|
public function setPassword($password, $recoveryPassword = null) { |
|
$this->dispatcher->dispatch(IUser::class . '::preSetPassword', new GenericEvent($this, [ |
|
'password' => $password, |
|
'recoveryPassword' => $recoveryPassword, |
|
])); |
|
if ($this->emitter) { |
|
$this->emitter->emit('\OC\User', 'preSetPassword', array($this, $password, $recoveryPassword)); |
|
} |
|
if ($this->backend->implementsActions(Backend::SET_PASSWORD)) { |
|
$result = $this->backend->setPassword($this->uid, $password); |
|
$this->dispatcher->dispatch(IUser::class . '::postSetPassword', new GenericEvent($this, [ |
|
'password' => $password, |
|
'recoveryPassword' => $recoveryPassword, |
|
])); |
|
if ($this->emitter) { |
|
$this->emitter->emit('\OC\User', 'postSetPassword', array($this, $password, $recoveryPassword)); |
|
} |
|
return !($result === false); |
|
} else { |
|
return false; |
|
} |
|
} |
|
|
|
/** |
|
* get the users home folder to mount |
|
* |
|
* @return string |
|
*/ |
|
public function getHome() { |
|
if (!$this->home) { |
|
if ($this->backend->implementsActions(Backend::GET_HOME) and $home = $this->backend->getHome($this->uid)) { |
|
$this->home = $home; |
|
} elseif ($this->config) { |
|
$this->home = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $this->uid; |
|
} else { |
|
$this->home = \OC::$SERVERROOT . '/data/' . $this->uid; |
|
} |
|
} |
|
return $this->home; |
|
} |
|
|
|
/** |
|
* Get the name of the backend class the user is connected with |
|
* |
|
* @return string |
|
*/ |
|
public function getBackendClassName() { |
|
if($this->backend instanceof IUserBackend) { |
|
return $this->backend->getBackendName(); |
|
} |
|
return get_class($this->backend); |
|
} |
|
|
|
public function getBackend() { |
|
return $this->backend; |
|
} |
|
|
|
/** |
|
* check if the backend allows the user to change his avatar on Personal page |
|
* |
|
* @return bool |
|
*/ |
|
public function canChangeAvatar() { |
|
if ($this->backend->implementsActions(Backend::PROVIDE_AVATAR)) { |
|
return $this->backend->canChangeAvatar($this->uid); |
|
} |
|
return true; |
|
} |
|
|
|
/** |
|
* check if the backend supports changing passwords |
|
* |
|
* @return bool |
|
*/ |
|
public function canChangePassword() { |
|
return $this->backend->implementsActions(Backend::SET_PASSWORD); |
|
} |
|
|
|
/** |
|
* check if the backend supports changing display names |
|
* |
|
* @return bool |
|
*/ |
|
public function canChangeDisplayName() { |
|
if ($this->config->getSystemValue('allow_user_to_change_display_name') === false) { |
|
return false; |
|
} |
|
return $this->backend->implementsActions(Backend::SET_DISPLAYNAME); |
|
} |
|
|
|
/** |
|
* check if the user is enabled |
|
* |
|
* @return bool |
|
*/ |
|
public function isEnabled() { |
|
return $this->enabled; |
|
} |
|
|
|
/** |
|
* set the enabled status for the user |
|
* |
|
* @param bool $enabled |
|
*/ |
|
public function setEnabled(bool $enabled = true) { |
|
$oldStatus = $this->isEnabled(); |
|
$this->enabled = $enabled; |
|
if ($oldStatus !== $this->enabled) { |
|
// TODO: First change the value, then trigger the event as done for all other properties. |
|
$this->triggerChange('enabled', $enabled, $oldStatus); |
|
$this->config->setUserValue($this->uid, 'core', 'enabled', $enabled ? 'true' : 'false'); |
|
} |
|
} |
|
|
|
/** |
|
* get the users email address |
|
* |
|
* @return string|null |
|
* @since 9.0.0 |
|
*/ |
|
public function getEMailAddress() { |
|
return $this->config->getUserValue($this->uid, 'settings', 'email', null); |
|
} |
|
|
|
/** |
|
* get the users' quota |
|
* |
|
* @return string |
|
* @since 9.0.0 |
|
*/ |
|
public function getQuota() { |
|
$quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default'); |
|
if($quota === 'default') { |
|
$quota = $this->config->getAppValue('files', 'default_quota', 'none'); |
|
} |
|
return $quota; |
|
} |
|
|
|
/** |
|
* set the users' quota |
|
* |
|
* @param string $quota |
|
* @return void |
|
* @since 9.0.0 |
|
*/ |
|
public function setQuota($quota) { |
|
$oldQuota = $this->config->getUserValue($this->uid, 'files', 'quota', ''); |
|
if($quota !== 'none' and $quota !== 'default') { |
|
$quota = OC_Helper::computerFileSize($quota); |
|
$quota = OC_Helper::humanFileSize($quota); |
|
} |
|
if($quota !== $oldQuota) { |
|
$this->config->setUserValue($this->uid, 'files', 'quota', $quota); |
|
$this->triggerChange('quota', $quota, $oldQuota); |
|
} |
|
} |
|
|
|
/** |
|
* get the avatar image if it exists |
|
* |
|
* @param int $size |
|
* @return IImage|null |
|
* @since 9.0.0 |
|
*/ |
|
public function getAvatarImage($size) { |
|
// delay the initialization |
|
if (is_null($this->avatarManager)) { |
|
$this->avatarManager = \OC::$server->getAvatarManager(); |
|
} |
|
|
|
$avatar = $this->avatarManager->getAvatar($this->uid); |
|
$image = $avatar->get(-1); |
|
if ($image) { |
|
return $image; |
|
} |
|
|
|
return null; |
|
} |
|
|
|
/** |
|
* get the federation cloud id |
|
* |
|
* @return string |
|
* @since 9.0.0 |
|
*/ |
|
public function getCloudId() { |
|
$uid = $this->getUID(); |
|
$server = $this->urlGenerator->getAbsoluteURL('/'); |
|
$server = rtrim( $this->removeProtocolFromUrl($server), '/'); |
|
return \OC::$server->getCloudIdManager()->getCloudId($uid, $server)->getId(); |
|
} |
|
|
|
/** |
|
* @param string $url |
|
* @return string |
|
*/ |
|
private function removeProtocolFromUrl($url) { |
|
if (strpos($url, 'https://') === 0) { |
|
return substr($url, strlen('https://')); |
|
} else if (strpos($url, 'http://') === 0) { |
|
return substr($url, strlen('http://')); |
|
} |
|
|
|
return $url; |
|
} |
|
|
|
public function triggerChange($feature, $value = null, $oldValue = null) { |
|
$this->dispatcher->dispatch(IUser::class . '::changeUser', new GenericEvent($this, [ |
|
'feature' => $feature, |
|
'value' => $value, |
|
'oldValue' => $oldValue, |
|
])); |
|
if ($this->emitter) { |
|
$this->emitter->emit('\OC\User', 'changeUser', array($this, $feature, $value, $oldValue)); |
|
} |
|
} |
|
}
|
|
|