nextcloud / server

lib/private/User/User.php

Indentation +511 added lines, -511 removed lines

@@ -57,515 +57,515 @@
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class User implements IUser {
-	/** @var IAccountManager */
-	protected $accountManager;
-	/** @var string */
-	private $uid;
-
-	/** @var string|null */
-	private $displayName;
-
-	/** @var UserInterface|null */
-	private $backend;
-	/** @var EventDispatcherInterface */
-	private $legacyDispatcher;
-
-	/** @var IEventDispatcher */
-	private $dispatcher;
-
-	/** @var bool|null */
-	private $enabled;
-
-	/** @var Emitter|Manager */
-	private $emitter;
-
-	/** @var string */
-	private $home;
-
-	/** @var int|null */
-	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->legacyDispatcher = $dispatcher;
-		$this->emitter = $emitter;
-		if (is_null($config)) {
-			$config = \OC::$server->getConfig();
-		}
-		$this->config = $config;
-		$this->urlGenerator = $urlGenerator;
-		if (is_null($this->urlGenerator)) {
-			$this->urlGenerator = \OC::$server->getURLGenerator();
-		}
-		// TODO: inject
-		$this->dispatcher = \OC::$server->query(IEventDispatcher::class);
-	}
-
-	/**
-	 * 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 ($this->displayName === null) {
-			$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;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function setEMailAddress($mailAddress) {
-		$this->setSystemEMailAddress($mailAddress);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function setSystemEMailAddress(string $mailAddress): void {
-		$oldMailAddress = $this->getSystemEMailAddress();
-
-		if ($mailAddress === '') {
-			$this->config->deleteUserValue($this->uid, 'settings', 'email');
-		} else {
-			$this->config->setUserValue($this->uid, 'settings', 'email', $mailAddress);
-		}
-
-		$primaryAddress = $this->getPrimaryEMailAddress();
-		if ($primaryAddress === $mailAddress) {
-			// on match no dedicated primary settings is necessary
-			$this->setPrimaryEMailAddress('');
-		}
-
-		if ($oldMailAddress !== $mailAddress) {
-			$this->triggerChange('eMailAddress', $mailAddress, $oldMailAddress);
-		}
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function setPrimaryEMailAddress(string $mailAddress): void {
-		if ($mailAddress === '') {
-			$this->config->deleteUserValue($this->uid, 'settings', 'primary_email');
-			return;
-		}
-
-		$this->ensureAccountManager();
-		$account = $this->accountManager->getAccount($this);
-		$property = $account->getPropertyCollection(IAccountManager::COLLECTION_EMAIL)
-			->getPropertyByValue($mailAddress);
-
-		if ($property === null || $property->getLocallyVerified() !== IAccountManager::VERIFIED) {
-			throw new InvalidArgumentException('Only verified emails can be set as primary');
-		}
-		$this->config->setUserValue($this->uid, 'settings', 'primary_email', $mailAddress);
-	}
-
-	private function ensureAccountManager() {
-		if (!$this->accountManager instanceof IAccountManager) {
-			$this->accountManager = \OC::$server->get(IAccountManager::class);
-		}
-	}
-
-	/**
-	 * returns the timestamp of the user's last login or 0 if the user did never
-	 * login
-	 *
-	 * @return int
-	 */
-	public function getLastLogin() {
-		if ($this->lastLogin === null) {
-			$this->lastLogin = (int) $this->config->getUserValue($this->uid, 'login', 'lastLogin', 0);
-		}
-		return (int) $this->lastLogin;
-	}
-
-	/**
-	 * updates the timestamp of the most recent login of this user
-	 */
-	public function updateLastLoginTimestamp() {
-		$firstTimeLogin = ($this->getLastLogin() === 0);
-		$this->lastLogin = time();
-		$this->config->setUserValue(
-			$this->uid, 'login', 'lastLogin', $this->lastLogin);
-
-		return $firstTimeLogin;
-	}
-
-	/**
-	 * Delete the user
-	 *
-	 * @return bool
-	 */
-	public function delete() {
-		/** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
-		$this->legacyDispatcher->dispatch(IUser::class . '::preDelete', new GenericEvent($this));
-		if ($this->emitter) {
-			/** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
-			$this->emitter->emit('\OC\User', 'preDelete', [$this]);
-		}
-		$this->dispatcher->dispatchTyped(new BeforeUserDeletedEvent($this));
-		$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) {
-					$this->dispatcher->dispatchTyped(new BeforeUserRemovedEvent($group, $this));
-					$group->removeUser($this);
-					$this->dispatcher->dispatchTyped(new UserRemovedEvent($group, $this));
-				}
-			}
-			// Delete the user's keys in preferences
-			\OC::$server->getConfig()->deleteAllUserValues($this->uid);
-
-			\OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid);
-			\OC::$server->getCommentsManager()->deleteReadMarksFromUser($this);
-
-			/** @var IAvatarManager $avatarManager */
-			$avatarManager = \OC::$server->query(AvatarManager::class);
-			$avatarManager->deleteUserAvatar($this->uid);
-
-			$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);
-
-			/** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
-			$this->legacyDispatcher->dispatch(IUser::class . '::postDelete', new GenericEvent($this));
-			if ($this->emitter) {
-				/** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
-				$this->emitter->emit('\OC\User', 'postDelete', [$this]);
-			}
-			$this->dispatcher->dispatchTyped(new UserDeletedEvent($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->legacyDispatcher->dispatch(IUser::class . '::preSetPassword', new GenericEvent($this, [
-			'password' => $password,
-			'recoveryPassword' => $recoveryPassword,
-		]));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\User', 'preSetPassword', [$this, $password, $recoveryPassword]);
-		}
-		if ($this->backend->implementsActions(Backend::SET_PASSWORD)) {
-			$result = $this->backend->setPassword($this->uid, $password);
-
-			if ($result !== false) {
-				$this->legacyDispatcher->dispatch(IUser::class . '::postSetPassword', new GenericEvent($this, [
-					'password' => $password,
-					'recoveryPassword' => $recoveryPassword,
-				]));
-				if ($this->emitter) {
-					$this->emitter->emit('\OC\User', 'postSetPassword', [$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() {
-		if ($this->enabled === null) {
-			$enabled = $this->config->getUserValue($this->uid, 'core', 'enabled', 'true');
-			$this->enabled = $enabled === 'true';
-		}
-		return (bool) $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->getPrimaryEMailAddress() ?? $this->getSystemEMailAddress();
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getSystemEMailAddress(): ?string {
-		return $this->config->getUserValue($this->uid, 'settings', 'email', null);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	public function getPrimaryEMailAddress(): ?string {
-		return $this->config->getUserValue($this->uid, 'settings', 'primary_email', null);
-	}
-
-	/**
-	 * get the users' quota
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getQuota() {
-		// allow apps to modify the user quota by hooking into the event
-		$event = new GetQuotaEvent($this);
-		$this->dispatcher->dispatchTyped($event);
-		$overwriteQuota = $event->getQuota();
-		if ($overwriteQuota) {
-			$quota = $overwriteQuota;
-		} else {
-			$quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default');
-		}
-		if ($quota === 'default') {
-			$quota = $this->config->getAppValue('files', 'default_quota', 'none');
-
-			// if unlimited quota is not allowed => avoid getting 'unlimited' as default_quota fallback value
-			// use the first preset instead
-			$allowUnlimitedQuota = $this->config->getAppValue('files', 'allow_unlimited_quota', '1') === '1';
-			if (!$allowUnlimitedQuota) {
-				$presets = $this->config->getAppValue('files', 'quota_preset', '1 GB, 5 GB, 10 GB');
-				$presets = array_filter(array_map('trim', explode(',', $presets)));
-				$quotaPreset = array_values(array_diff($presets, ['default', 'none']));
-				if (count($quotaPreset) > 0) {
-					$quota = $this->config->getAppValue('files', 'default_quota', $quotaPreset[0]);
-				}
-			}
-		}
-		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 $uid . '@' . $server;
-	}
-
-	/**
-	 * @param string $url
-	 * @return string
-	 */
-	private function removeProtocolFromUrl($url) {
-		if (strpos($url, 'https://') === 0) {
-			return substr($url, strlen('https://'));
-		} elseif (strpos($url, 'http://') === 0) {
-			return substr($url, strlen('http://'));
-		}
-
-		return $url;
-	}
-
-	public function triggerChange($feature, $value = null, $oldValue = null) {
-		$this->legacyDispatcher->dispatch(IUser::class . '::changeUser', new GenericEvent($this, [
-			'feature' => $feature,
-			'value' => $value,
-			'oldValue' => $oldValue,
-		]));
-		if ($this->emitter) {
-			$this->emitter->emit('\OC\User', 'changeUser', [$this, $feature, $value, $oldValue]);
-		}
-	}
+    /** @var IAccountManager */
+    protected $accountManager;
+    /** @var string */
+    private $uid;
+
+    /** @var string|null */
+    private $displayName;
+
+    /** @var UserInterface|null */
+    private $backend;
+    /** @var EventDispatcherInterface */
+    private $legacyDispatcher;
+
+    /** @var IEventDispatcher */
+    private $dispatcher;
+
+    /** @var bool|null */
+    private $enabled;
+
+    /** @var Emitter|Manager */
+    private $emitter;
+
+    /** @var string */
+    private $home;
+
+    /** @var int|null */
+    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->legacyDispatcher = $dispatcher;
+        $this->emitter = $emitter;
+        if (is_null($config)) {
+            $config = \OC::$server->getConfig();
+        }
+        $this->config = $config;
+        $this->urlGenerator = $urlGenerator;
+        if (is_null($this->urlGenerator)) {
+            $this->urlGenerator = \OC::$server->getURLGenerator();
+        }
+        // TODO: inject
+        $this->dispatcher = \OC::$server->query(IEventDispatcher::class);
+    }
+
+    /**
+     * 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 ($this->displayName === null) {
+            $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;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setEMailAddress($mailAddress) {
+        $this->setSystemEMailAddress($mailAddress);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setSystemEMailAddress(string $mailAddress): void {
+        $oldMailAddress = $this->getSystemEMailAddress();
+
+        if ($mailAddress === '') {
+            $this->config->deleteUserValue($this->uid, 'settings', 'email');
+        } else {
+            $this->config->setUserValue($this->uid, 'settings', 'email', $mailAddress);
+        }
+
+        $primaryAddress = $this->getPrimaryEMailAddress();
+        if ($primaryAddress === $mailAddress) {
+            // on match no dedicated primary settings is necessary
+            $this->setPrimaryEMailAddress('');
+        }
+
+        if ($oldMailAddress !== $mailAddress) {
+            $this->triggerChange('eMailAddress', $mailAddress, $oldMailAddress);
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function setPrimaryEMailAddress(string $mailAddress): void {
+        if ($mailAddress === '') {
+            $this->config->deleteUserValue($this->uid, 'settings', 'primary_email');
+            return;
+        }
+
+        $this->ensureAccountManager();
+        $account = $this->accountManager->getAccount($this);
+        $property = $account->getPropertyCollection(IAccountManager::COLLECTION_EMAIL)
+            ->getPropertyByValue($mailAddress);
+
+        if ($property === null || $property->getLocallyVerified() !== IAccountManager::VERIFIED) {
+            throw new InvalidArgumentException('Only verified emails can be set as primary');
+        }
+        $this->config->setUserValue($this->uid, 'settings', 'primary_email', $mailAddress);
+    }
+
+    private function ensureAccountManager() {
+        if (!$this->accountManager instanceof IAccountManager) {
+            $this->accountManager = \OC::$server->get(IAccountManager::class);
+        }
+    }
+
+    /**
+     * returns the timestamp of the user's last login or 0 if the user did never
+     * login
+     *
+     * @return int
+     */
+    public function getLastLogin() {
+        if ($this->lastLogin === null) {
+            $this->lastLogin = (int) $this->config->getUserValue($this->uid, 'login', 'lastLogin', 0);
+        }
+        return (int) $this->lastLogin;
+    }
+
+    /**
+     * updates the timestamp of the most recent login of this user
+     */
+    public function updateLastLoginTimestamp() {
+        $firstTimeLogin = ($this->getLastLogin() === 0);
+        $this->lastLogin = time();
+        $this->config->setUserValue(
+            $this->uid, 'login', 'lastLogin', $this->lastLogin);
+
+        return $firstTimeLogin;
+    }
+
+    /**
+     * Delete the user
+     *
+     * @return bool
+     */
+    public function delete() {
+        /** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
+        $this->legacyDispatcher->dispatch(IUser::class . '::preDelete', new GenericEvent($this));
+        if ($this->emitter) {
+            /** @deprecated 21.0.0 use BeforeUserDeletedEvent event with the IEventDispatcher instead */
+            $this->emitter->emit('\OC\User', 'preDelete', [$this]);
+        }
+        $this->dispatcher->dispatchTyped(new BeforeUserDeletedEvent($this));
+        $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) {
+                    $this->dispatcher->dispatchTyped(new BeforeUserRemovedEvent($group, $this));
+                    $group->removeUser($this);
+                    $this->dispatcher->dispatchTyped(new UserRemovedEvent($group, $this));
+                }
+            }
+            // Delete the user's keys in preferences
+            \OC::$server->getConfig()->deleteAllUserValues($this->uid);
+
+            \OC::$server->getCommentsManager()->deleteReferencesOfActor('users', $this->uid);
+            \OC::$server->getCommentsManager()->deleteReadMarksFromUser($this);
+
+            /** @var IAvatarManager $avatarManager */
+            $avatarManager = \OC::$server->query(AvatarManager::class);
+            $avatarManager->deleteUserAvatar($this->uid);
+
+            $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);
+
+            /** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
+            $this->legacyDispatcher->dispatch(IUser::class . '::postDelete', new GenericEvent($this));
+            if ($this->emitter) {
+                /** @deprecated 21.0.0 use UserDeletedEvent event with the IEventDispatcher instead */
+                $this->emitter->emit('\OC\User', 'postDelete', [$this]);
+            }
+            $this->dispatcher->dispatchTyped(new UserDeletedEvent($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->legacyDispatcher->dispatch(IUser::class . '::preSetPassword', new GenericEvent($this, [
+            'password' => $password,
+            'recoveryPassword' => $recoveryPassword,
+        ]));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\User', 'preSetPassword', [$this, $password, $recoveryPassword]);
+        }
+        if ($this->backend->implementsActions(Backend::SET_PASSWORD)) {
+            $result = $this->backend->setPassword($this->uid, $password);
+
+            if ($result !== false) {
+                $this->legacyDispatcher->dispatch(IUser::class . '::postSetPassword', new GenericEvent($this, [
+                    'password' => $password,
+                    'recoveryPassword' => $recoveryPassword,
+                ]));
+                if ($this->emitter) {
+                    $this->emitter->emit('\OC\User', 'postSetPassword', [$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() {
+        if ($this->enabled === null) {
+            $enabled = $this->config->getUserValue($this->uid, 'core', 'enabled', 'true');
+            $this->enabled = $enabled === 'true';
+        }
+        return (bool) $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->getPrimaryEMailAddress() ?? $this->getSystemEMailAddress();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSystemEMailAddress(): ?string {
+        return $this->config->getUserValue($this->uid, 'settings', 'email', null);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPrimaryEMailAddress(): ?string {
+        return $this->config->getUserValue($this->uid, 'settings', 'primary_email', null);
+    }
+
+    /**
+     * get the users' quota
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getQuota() {
+        // allow apps to modify the user quota by hooking into the event
+        $event = new GetQuotaEvent($this);
+        $this->dispatcher->dispatchTyped($event);
+        $overwriteQuota = $event->getQuota();
+        if ($overwriteQuota) {
+            $quota = $overwriteQuota;
+        } else {
+            $quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default');
+        }
+        if ($quota === 'default') {
+            $quota = $this->config->getAppValue('files', 'default_quota', 'none');
+
+            // if unlimited quota is not allowed => avoid getting 'unlimited' as default_quota fallback value
+            // use the first preset instead
+            $allowUnlimitedQuota = $this->config->getAppValue('files', 'allow_unlimited_quota', '1') === '1';
+            if (!$allowUnlimitedQuota) {
+                $presets = $this->config->getAppValue('files', 'quota_preset', '1 GB, 5 GB, 10 GB');
+                $presets = array_filter(array_map('trim', explode(',', $presets)));
+                $quotaPreset = array_values(array_diff($presets, ['default', 'none']));
+                if (count($quotaPreset) > 0) {
+                    $quota = $this->config->getAppValue('files', 'default_quota', $quotaPreset[0]);
+                }
+            }
+        }
+        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 $uid . '@' . $server;
+    }
+
+    /**
+     * @param string $url
+     * @return string
+     */
+    private function removeProtocolFromUrl($url) {
+        if (strpos($url, 'https://') === 0) {
+            return substr($url, strlen('https://'));
+        } elseif (strpos($url, 'http://') === 0) {
+            return substr($url, strlen('http://'));
+        }
+
+        return $url;
+    }
+
+    public function triggerChange($feature, $value = null, $oldValue = null) {
+        $this->legacyDispatcher->dispatch(IUser::class . '::changeUser', new GenericEvent($this, [
+            'feature' => $feature,
+            'value' => $value,
+            'oldValue' => $oldValue,
+        ]));
+        if ($this->emitter) {
+            $this->emitter->emit('\OC\User', 'changeUser', [$this, $feature, $value, $oldValue]);
+        }
+    }
 }

apps/settings/lib/Controller/ChangePasswordController.php

Indentation +215 added lines, -215 removed lines

@@ -50,237 +50,237 @@
 
 class ChangePasswordController extends Controller {
 
-	/** @var string */
-	private $userId;
+    /** @var string */
+    private $userId;
 
-	/** @var IUserManager */
-	private $userManager;
+    /** @var IUserManager */
+    private $userManager;
 
-	/** @var IL10N */
-	private $l;
+    /** @var IL10N */
+    private $l;
 
-	/** @var GroupManager */
-	private $groupManager;
+    /** @var GroupManager */
+    private $groupManager;
 
-	/** @var Session */
-	private $userSession;
+    /** @var Session */
+    private $userSession;
 
-	/** @var IAppManager */
-	private $appManager;
+    /** @var IAppManager */
+    private $appManager;
 
-	public function __construct(string $appName,
-								IRequest $request,
-								string $userId,
-								IUserManager $userManager,
-								IUserSession $userSession,
-								IGroupManager $groupManager,
-								IAppManager $appManager,
-								IL10N $l) {
-		parent::__construct($appName, $request);
+    public function __construct(string $appName,
+                                IRequest $request,
+                                string $userId,
+                                IUserManager $userManager,
+                                IUserSession $userSession,
+                                IGroupManager $groupManager,
+                                IAppManager $appManager,
+                                IL10N $l) {
+        parent::__construct($appName, $request);
 
-		$this->userId = $userId;
-		$this->userManager = $userManager;
-		$this->userSession = $userSession;
-		$this->groupManager = $groupManager;
-		$this->appManager = $appManager;
-		$this->l = $l;
-	}
+        $this->userId = $userId;
+        $this->userManager = $userManager;
+        $this->userSession = $userSession;
+        $this->groupManager = $groupManager;
+        $this->appManager = $appManager;
+        $this->l = $l;
+    }
 
-	/**
-	 * @NoAdminRequired
-	 * @NoSubAdminRequired
-	 * @BruteForceProtection(action=changePersonalPassword)
-	 */
-	public function changePersonalPassword(string $oldpassword = '', string $newpassword = null): JSONResponse {
-		$loginName = $this->userSession->getLoginName();
-		/** @var IUser $user */
-		$user = $this->userManager->checkPassword($loginName, $oldpassword);
-		if ($user === false) {
-			$response = new JSONResponse([
-				'status' => 'error',
-				'data' => [
-					'message' => $this->l->t('Wrong password'),
-				],
-			]);
-			$response->throttle();
-			return $response;
-		}
+    /**
+     * @NoAdminRequired
+     * @NoSubAdminRequired
+     * @BruteForceProtection(action=changePersonalPassword)
+     */
+    public function changePersonalPassword(string $oldpassword = '', string $newpassword = null): JSONResponse {
+        $loginName = $this->userSession->getLoginName();
+        /** @var IUser $user */
+        $user = $this->userManager->checkPassword($loginName, $oldpassword);
+        if ($user === false) {
+            $response = new JSONResponse([
+                'status' => 'error',
+                'data' => [
+                    'message' => $this->l->t('Wrong password'),
+                ],
+            ]);
+            $response->throttle();
+            return $response;
+        }
 
-		try {
-			if ($newpassword === null || $user->setPassword($newpassword) === false) {
-				return new JSONResponse([
-					'status' => 'error',
-					'data' => [
-						'message' => $this->l->t('Unable to change personal password'),
-					],
-				]);
-			}
-			// password policy app throws exception
-		} catch (HintException $e) {
-			return new JSONResponse([
-				'status' => 'error',
-				'data' => [
-					'message' => $e->getHint(),
-				],
-			]);
-		}
+        try {
+            if ($newpassword === null || $user->setPassword($newpassword) === false) {
+                return new JSONResponse([
+                    'status' => 'error',
+                    'data' => [
+                        'message' => $this->l->t('Unable to change personal password'),
+                    ],
+                ]);
+            }
+            // password policy app throws exception
+        } catch (HintException $e) {
+            return new JSONResponse([
+                'status' => 'error',
+                'data' => [
+                    'message' => $e->getHint(),
+                ],
+            ]);
+        }
 
-		$this->userSession->updateSessionTokenPassword($newpassword);
+        $this->userSession->updateSessionTokenPassword($newpassword);
 
-		return new JSONResponse([
-			'status' => 'success',
-			'data' => [
-				'message' => $this->l->t('Saved'),
-			],
-		]);
-	}
+        return new JSONResponse([
+            'status' => 'success',
+            'data' => [
+                'message' => $this->l->t('Saved'),
+            ],
+        ]);
+    }
 
-	/**
-	 * @NoAdminRequired
-	 * @PasswordConfirmationRequired
-	 */
-	public function changeUserPassword(string $username = null, string $password = null, string $recoveryPassword = null): JSONResponse {
-		if ($username === null) {
-			return new JSONResponse([
-				'status' => 'error',
-				'data' => [
-					'message' => $this->l->t('No user supplied'),
-				],
-			]);
-		}
+    /**
+     * @NoAdminRequired
+     * @PasswordConfirmationRequired
+     */
+    public function changeUserPassword(string $username = null, string $password = null, string $recoveryPassword = null): JSONResponse {
+        if ($username === null) {
+            return new JSONResponse([
+                'status' => 'error',
+                'data' => [
+                    'message' => $this->l->t('No user supplied'),
+                ],
+            ]);
+        }
 
-		if ($password === null) {
-			return new JSONResponse([
-				'status' => 'error',
-				'data' => [
-					'message' => $this->l->t('Unable to change password'),
-				],
-			]);
-		}
+        if ($password === null) {
+            return new JSONResponse([
+                'status' => 'error',
+                'data' => [
+                    'message' => $this->l->t('Unable to change password'),
+                ],
+            ]);
+        }
 
-		$currentUser = $this->userSession->getUser();
-		$targetUser = $this->userManager->get($username);
-		if ($currentUser === null || $targetUser === null ||
-			!($this->groupManager->isAdmin($this->userId) ||
-			 $this->groupManager->getSubAdmin()->isUserAccessible($currentUser, $targetUser))
-		) {
-			return new JSONResponse([
-				'status' => 'error',
-				'data' => [
-					'message' => $this->l->t('Authentication error'),
-				],
-			]);
-		}
+        $currentUser = $this->userSession->getUser();
+        $targetUser = $this->userManager->get($username);
+        if ($currentUser === null || $targetUser === null ||
+            !($this->groupManager->isAdmin($this->userId) ||
+             $this->groupManager->getSubAdmin()->isUserAccessible($currentUser, $targetUser))
+        ) {
+            return new JSONResponse([
+                'status' => 'error',
+                'data' => [
+                    'message' => $this->l->t('Authentication error'),
+                ],
+            ]);
+        }
 
-		if ($this->appManager->isEnabledForUser('encryption')) {
-			//handle the recovery case
-			$crypt = new \OCA\Encryption\Crypto\Crypt(
-				\OC::$server->getLogger(),
-				\OC::$server->getUserSession(),
-				\OC::$server->getConfig(),
-				\OC::$server->getL10N('encryption'));
-			$keyStorage = \OC::$server->getEncryptionKeyStorage();
-			$util = new \OCA\Encryption\Util(
-				new \OC\Files\View(),
-				$crypt,
-				\OC::$server->getLogger(),
-				\OC::$server->getUserSession(),
-				\OC::$server->getConfig(),
-				\OC::$server->getUserManager());
-			$keyManager = new \OCA\Encryption\KeyManager(
-				$keyStorage,
-				$crypt,
-				\OC::$server->getConfig(),
-				\OC::$server->getUserSession(),
-				new \OCA\Encryption\Session(\OC::$server->getSession()),
-				\OC::$server->getLogger(),
-				$util,
-				\OC::$server->getLockingProvider()
-			);
-			$recovery = new \OCA\Encryption\Recovery(
-				\OC::$server->getUserSession(),
-				$crypt,
-				$keyManager,
-				\OC::$server->getConfig(),
-				\OC::$server->getEncryptionFilesHelper(),
-				new \OC\Files\View());
-			$recoveryAdminEnabled = $recovery->isRecoveryKeyEnabled();
+        if ($this->appManager->isEnabledForUser('encryption')) {
+            //handle the recovery case
+            $crypt = new \OCA\Encryption\Crypto\Crypt(
+                \OC::$server->getLogger(),
+                \OC::$server->getUserSession(),
+                \OC::$server->getConfig(),
+                \OC::$server->getL10N('encryption'));
+            $keyStorage = \OC::$server->getEncryptionKeyStorage();
+            $util = new \OCA\Encryption\Util(
+                new \OC\Files\View(),
+                $crypt,
+                \OC::$server->getLogger(),
+                \OC::$server->getUserSession(),
+                \OC::$server->getConfig(),
+                \OC::$server->getUserManager());
+            $keyManager = new \OCA\Encryption\KeyManager(
+                $keyStorage,
+                $crypt,
+                \OC::$server->getConfig(),
+                \OC::$server->getUserSession(),
+                new \OCA\Encryption\Session(\OC::$server->getSession()),
+                \OC::$server->getLogger(),
+                $util,
+                \OC::$server->getLockingProvider()
+            );
+            $recovery = new \OCA\Encryption\Recovery(
+                \OC::$server->getUserSession(),
+                $crypt,
+                $keyManager,
+                \OC::$server->getConfig(),
+                \OC::$server->getEncryptionFilesHelper(),
+                new \OC\Files\View());
+            $recoveryAdminEnabled = $recovery->isRecoveryKeyEnabled();
 
-			$validRecoveryPassword = false;
-			$recoveryEnabledForUser = false;
-			if ($recoveryAdminEnabled) {
-				$validRecoveryPassword = $keyManager->checkRecoveryPassword($recoveryPassword);
-				$recoveryEnabledForUser = $recovery->isRecoveryEnabledForUser($username);
-			}
+            $validRecoveryPassword = false;
+            $recoveryEnabledForUser = false;
+            if ($recoveryAdminEnabled) {
+                $validRecoveryPassword = $keyManager->checkRecoveryPassword($recoveryPassword);
+                $recoveryEnabledForUser = $recovery->isRecoveryEnabledForUser($username);
+            }
 
-			if ($recoveryEnabledForUser && $recoveryPassword === '') {
-				return new JSONResponse([
-					'status' => 'error',
-					'data' => [
-						'message' => $this->l->t('Please provide an admin recovery password; otherwise, all user data will be lost.'),
-					]
-				]);
-			} elseif ($recoveryEnabledForUser && ! $validRecoveryPassword) {
-				return new JSONResponse([
-					'status' => 'error',
-					'data' => [
-						'message' => $this->l->t('Wrong admin recovery password. Please check the password and try again.'),
-					]
-				]);
-			} else { // now we know that everything is fine regarding the recovery password, let's try to change the password
-				try {
-					$result = $targetUser->setPassword($password, $recoveryPassword);
-					// password policy app throws exception
-				} catch (HintException $e) {
-					return new JSONResponse([
-						'status' => 'error',
-						'data' => [
-							'message' => $e->getHint(),
-						],
-					]);
-				}
-				if (!$result && $recoveryEnabledForUser) {
-					return new JSONResponse([
-						'status' => 'error',
-						'data' => [
-							'message' => $this->l->t('Backend doesn\'t support password change, but the user\'s encryption key was updated.'),
-						]
-					]);
-				} elseif (!$result && !$recoveryEnabledForUser) {
-					return new JSONResponse([
-						'status' => 'error',
-						'data' => [
-							'message' => $this->l->t('Unable to change password'),
-						]
-					]);
-				}
-			}
-		} else {
-			try {
-				if ($targetUser->setPassword($password) === false) {
-					return new JSONResponse([
-						'status' => 'error',
-						'data' => [
-							'message' => $this->l->t('Unable to change password'),
-						],
-					]);
-				}
-				// password policy app throws exception
-			} catch (HintException $e) {
-				return new JSONResponse([
-					'status' => 'error',
-					'data' => [
-						'message' => $e->getHint(),
-					],
-				]);
-			}
-		}
+            if ($recoveryEnabledForUser && $recoveryPassword === '') {
+                return new JSONResponse([
+                    'status' => 'error',
+                    'data' => [
+                        'message' => $this->l->t('Please provide an admin recovery password; otherwise, all user data will be lost.'),
+                    ]
+                ]);
+            } elseif ($recoveryEnabledForUser && ! $validRecoveryPassword) {
+                return new JSONResponse([
+                    'status' => 'error',
+                    'data' => [
+                        'message' => $this->l->t('Wrong admin recovery password. Please check the password and try again.'),
+                    ]
+                ]);
+            } else { // now we know that everything is fine regarding the recovery password, let's try to change the password
+                try {
+                    $result = $targetUser->setPassword($password, $recoveryPassword);
+                    // password policy app throws exception
+                } catch (HintException $e) {
+                    return new JSONResponse([
+                        'status' => 'error',
+                        'data' => [
+                            'message' => $e->getHint(),
+                        ],
+                    ]);
+                }
+                if (!$result && $recoveryEnabledForUser) {
+                    return new JSONResponse([
+                        'status' => 'error',
+                        'data' => [
+                            'message' => $this->l->t('Backend doesn\'t support password change, but the user\'s encryption key was updated.'),
+                        ]
+                    ]);
+                } elseif (!$result && !$recoveryEnabledForUser) {
+                    return new JSONResponse([
+                        'status' => 'error',
+                        'data' => [
+                            'message' => $this->l->t('Unable to change password'),
+                        ]
+                    ]);
+                }
+            }
+        } else {
+            try {
+                if ($targetUser->setPassword($password) === false) {
+                    return new JSONResponse([
+                        'status' => 'error',
+                        'data' => [
+                            'message' => $this->l->t('Unable to change password'),
+                        ],
+                    ]);
+                }
+                // password policy app throws exception
+            } catch (HintException $e) {
+                return new JSONResponse([
+                    'status' => 'error',
+                    'data' => [
+                        'message' => $e->getHint(),
+                    ],
+                ]);
+            }
+        }
 
-		return new JSONResponse([
-			'status' => 'success',
-			'data' => [
-				'username' => $username,
-			],
-		]);
-	}
+        return new JSONResponse([
+            'status' => 'success',
+            'data' => [
+                'username' => $username,
+            ],
+        ]);
+    }
 }