nextcloud / server

lib/public/IUser.php

Indentation +174 added lines, -174 removed lines

@@ -36,178 +36,178 @@
  */
 interface IUser {
 
-	/**
-	 * get the user id
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getUID();
-
-	/**
-	 * get the display name for the user, if no specific display name is set it will fallback to the user id
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getDisplayName();
-
-	/**
-	 * set the display name for the user
-	 *
-	 * @param string $displayName
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function setDisplayName($displayName);
-
-	/**
-	 * returns the timestamp of the user's last login or 0 if the user did never
-	 * login
-	 *
-	 * @return int
-	 * @since 8.0.0
-	 */
-	public function getLastLogin();
-
-	/**
-	 * updates the timestamp of the most recent login of this user
-	 * @since 8.0.0
-	 */
-	public function updateLastLoginTimestamp();
-
-	/**
-	 * Delete the user
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function delete();
-
-	/**
-	 * Set the password of the user
-	 *
-	 * @param string $password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function setPassword($password, $recoveryPassword = null);
-
-	/**
-	 * get the users home folder to mount
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getHome();
-
-	/**
-	 * Get the name of the backend class the user is connected with
-	 *
-	 * @return string
-	 * @since 8.0.0
-	 */
-	public function getBackendClassName();
-
-	/**
-	 * Get the backend for the current user object
-	 *
-	 * @return UserInterface
-	 * @since 15.0.0
-	 */
-	public function getBackend();
-
-	/**
-	 * check if the backend allows the user to change his avatar on Personal page
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangeAvatar();
-
-	/**
-	 * check if the backend supports changing passwords
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangePassword();
-
-	/**
-	 * check if the backend supports changing display names
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function canChangeDisplayName();
-
-	/**
-	 * check if the user is enabled
-	 *
-	 * @return bool
-	 * @since 8.0.0
-	 */
-	public function isEnabled();
-
-	/**
-	 * set the enabled status for the user
-	 *
-	 * @param bool $enabled
-	 * @since 8.0.0
-	 */
-	public function setEnabled(bool $enabled = true);
-
-	/**
-	 * get the users email address
-	 *
-	 * @return string|null
-	 * @since 9.0.0
-	 */
-	public function getEMailAddress();
-
-	/**
-	 * get the avatar image if it exists
-	 *
-	 * @param int $size
-	 * @return IImage|null
-	 * @since 9.0.0
-	 */
-	public function getAvatarImage($size);
-
-	/**
-	 * get the federation cloud id
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getCloudId();
-
-	/**
-	 * set the email address of the user
-	 *
-	 * @param string|null $mailAddress
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setEMailAddress($mailAddress);
-
-	/**
-	 * get the users' quota in human readable form. If a specific quota is not
-	 * set for the user, the default value is returned. If a default setting
-	 * was not set otherwise, it is return as 'none', i.e. quota is not limited.
-	 *
-	 * @return string
-	 * @since 9.0.0
-	 */
-	public function getQuota();
-
-	/**
-	 * set the users' quota
-	 *
-	 * @param string $quota
-	 * @return void
-	 * @since 9.0.0
-	 */
-	public function setQuota($quota);
+    /**
+     * get the user id
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getUID();
+
+    /**
+     * get the display name for the user, if no specific display name is set it will fallback to the user id
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getDisplayName();
+
+    /**
+     * set the display name for the user
+     *
+     * @param string $displayName
+     * @return bool
+     * @since 8.0.0
+     */
+    public function setDisplayName($displayName);
+
+    /**
+     * returns the timestamp of the user's last login or 0 if the user did never
+     * login
+     *
+     * @return int
+     * @since 8.0.0
+     */
+    public function getLastLogin();
+
+    /**
+     * updates the timestamp of the most recent login of this user
+     * @since 8.0.0
+     */
+    public function updateLastLoginTimestamp();
+
+    /**
+     * Delete the user
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function delete();
+
+    /**
+     * Set the password of the user
+     *
+     * @param string $password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     * @since 8.0.0
+     */
+    public function setPassword($password, $recoveryPassword = null);
+
+    /**
+     * get the users home folder to mount
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getHome();
+
+    /**
+     * Get the name of the backend class the user is connected with
+     *
+     * @return string
+     * @since 8.0.0
+     */
+    public function getBackendClassName();
+
+    /**
+     * Get the backend for the current user object
+     *
+     * @return UserInterface
+     * @since 15.0.0
+     */
+    public function getBackend();
+
+    /**
+     * check if the backend allows the user to change his avatar on Personal page
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangeAvatar();
+
+    /**
+     * check if the backend supports changing passwords
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangePassword();
+
+    /**
+     * check if the backend supports changing display names
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function canChangeDisplayName();
+
+    /**
+     * check if the user is enabled
+     *
+     * @return bool
+     * @since 8.0.0
+     */
+    public function isEnabled();
+
+    /**
+     * set the enabled status for the user
+     *
+     * @param bool $enabled
+     * @since 8.0.0
+     */
+    public function setEnabled(bool $enabled = true);
+
+    /**
+     * get the users email address
+     *
+     * @return string|null
+     * @since 9.0.0
+     */
+    public function getEMailAddress();
+
+    /**
+     * get the avatar image if it exists
+     *
+     * @param int $size
+     * @return IImage|null
+     * @since 9.0.0
+     */
+    public function getAvatarImage($size);
+
+    /**
+     * get the federation cloud id
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getCloudId();
+
+    /**
+     * set the email address of the user
+     *
+     * @param string|null $mailAddress
+     * @return void
+     * @since 9.0.0
+     */
+    public function setEMailAddress($mailAddress);
+
+    /**
+     * get the users' quota in human readable form. If a specific quota is not
+     * set for the user, the default value is returned. If a default setting
+     * was not set otherwise, it is return as 'none', i.e. quota is not limited.
+     *
+     * @return string
+     * @since 9.0.0
+     */
+    public function getQuota();
+
+    /**
+     * set the users' quota
+     *
+     * @param string $quota
+     * @return void
+     * @since 9.0.0
+     */
+    public function setQuota($quota);
 }

apps/provisioning_api/lib/Controller/AUserData.php

Indentation +155 added lines, -155 removed lines

@@ -38,162 +38,162 @@
 
 abstract class AUserData extends OCSController {
 
-	/** @var IUserManager */
-	protected $userManager;
-	/** @var IConfig */
-	protected $config;
-	/** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
-	protected $groupManager;
-	/** @var IUserSession */
-	protected $userSession;
-	/** @var AccountManager */
-	protected $accountManager;
-
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IUserManager $userManager
-	 * @param IConfig $config
-	 * @param IGroupManager $groupManager
-	 * @param IUserSession $userSession
-	 * @param AccountManager $accountManager
-	 */
-	public function __construct(string $appName,
-								IRequest $request,
-								IUserManager $userManager,
-								IConfig $config,
-								IGroupManager $groupManager,
-								IUserSession $userSession,
-								AccountManager $accountManager) {
-		parent::__construct($appName, $request);
-
-		$this->userManager = $userManager;
-		$this->config = $config;
-		$this->groupManager = $groupManager;
-		$this->userSession = $userSession;
-		$this->accountManager = $accountManager;
-	}
-
-	/**
-	 * creates a array with all user data
-	 *
-	 * @param string $userId
-	 * @return array
-	 * @throws OCSException
-	 */
-	protected function getUserData(string $userId): array {
-		$currentLoggedInUser = $this->userSession->getUser();
-
-		$data = [];
-
-		// Check if the target user exists
-		$targetUserObject = $this->userManager->get($userId);
-		if($targetUserObject === null) {
-			throw new OCSNotFoundException('User does not exist');
-		}
-
-		// Should be at least Admin Or SubAdmin!
-		if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())
-			|| $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
-				$data['enabled'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'enabled', 'true') === 'true';
-		} else {
-			// Check they are looking up themselves
-			if ($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
-				return $data;
-			}
-		}
-
-		// Get groups data
-		$userAccount = $this->accountManager->getUser($targetUserObject);
-		$groups = $this->groupManager->getUserGroups($targetUserObject);
-		$gids = [];
-		foreach ($groups as $group) {
-			$gids[] = $group->getGID();
-		}
-
-		// Find the data
-		$data['id'] = $targetUserObject->getUID();
-		$data['storageLocation'] = $targetUserObject->getHome();
-		$data['lastLogin'] = $targetUserObject->getLastLogin() * 1000;
-		$data['backend'] = $targetUserObject->getBackendClassName();
-		$data['subadmin'] = $this->getUserSubAdminGroupsData($targetUserObject->getUID());
-		$data['quota'] = $this->fillStorageInfo($targetUserObject->getUID());
-		$data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
-		$data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
-		$data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
-		$data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
-		$data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
-		$data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
-		$data['groups'] = $gids;
-		$data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
-		$data['locale'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'locale');
-
-		$backend = $targetUserObject->getBackend();
-		$data['backendCapabilities'] = [
-			'setDisplayName' => $backend instanceof ISetDisplayNameBackend || $backend->implementsActions(Backend::SET_DISPLAYNAME),
-			'setPassword' => $backend instanceof ISetPasswordBackend || $backend->implementsActions(Backend::SET_PASSWORD),
-		];
-
-		return $data;
+    /** @var IUserManager */
+    protected $userManager;
+    /** @var IConfig */
+    protected $config;
+    /** @var IGroupManager|\OC\Group\Manager */ // FIXME Requires a method that is not on the interface
+    protected $groupManager;
+    /** @var IUserSession */
+    protected $userSession;
+    /** @var AccountManager */
+    protected $accountManager;
+
+    /**
+     * @param string $appName
+     * @param IRequest $request
+     * @param IUserManager $userManager
+     * @param IConfig $config
+     * @param IGroupManager $groupManager
+     * @param IUserSession $userSession
+     * @param AccountManager $accountManager
+     */
+    public function __construct(string $appName,
+                                IRequest $request,
+                                IUserManager $userManager,
+                                IConfig $config,
+                                IGroupManager $groupManager,
+                                IUserSession $userSession,
+                                AccountManager $accountManager) {
+        parent::__construct($appName, $request);
+
+        $this->userManager = $userManager;
+        $this->config = $config;
+        $this->groupManager = $groupManager;
+        $this->userSession = $userSession;
+        $this->accountManager = $accountManager;
     }
 
-	/**
-	 * Get the groups a user is a subadmin of
-	 *
-	 * @param string $userId
-	 * @return array
-	 * @throws OCSException
-	 */
-	protected function getUserSubAdminGroupsData(string $userId): array {
-		$user = $this->userManager->get($userId);
-		// Check if the user exists
-		if($user === null) {
-			throw new OCSNotFoundException('User does not exist');
-		}
-
-		// Get the subadmin groups
-		$subAdminGroups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
-		$groups = [];
-		foreach ($subAdminGroups as $key => $group) {
-			$groups[] = $group->getGID();
-		}
-
-		return $groups;
-	}
-
-	/**
-	 * @param string $userId
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
-	 */
-	protected function fillStorageInfo(string $userId): array {
-		try {
-			\OC_Util::tearDownFS();
-			\OC_Util::setupFS($userId);
-			$storage = OC_Helper::getStorageInfo('/');
-			$data = [
-				'free' => $storage['free'],
-				'used' => $storage['used'],
-				'total' => $storage['total'],
-				'relative' => $storage['relative'],
-				'quota' => $storage['quota'],
-			];
-		} catch (NotFoundException $ex) {
-			// User fs is not setup yet
-			$user = $this->userManager->get($userId);
-			if ($user === null) {
-				throw new OCSException('User does not exist', 101);
-			}
-			$quota = $user->getQuota();
-			if ($quota !== 'none') {
-				$quota = OC_Helper::computerFileSize($quota);
-			}
-			$data = [
-				'quota' => $quota !== false ? $quota : 'none',
-				'used' => 0
-			];
-		}
-		return $data;
-	}
+    /**
+     * creates a array with all user data
+     *
+     * @param string $userId
+     * @return array
+     * @throws OCSException
+     */
+    protected function getUserData(string $userId): array {
+        $currentLoggedInUser = $this->userSession->getUser();
+
+        $data = [];
+
+        // Check if the target user exists
+        $targetUserObject = $this->userManager->get($userId);
+        if($targetUserObject === null) {
+            throw new OCSNotFoundException('User does not exist');
+        }
+
+        // Should be at least Admin Or SubAdmin!
+        if ($this->groupManager->isAdmin($currentLoggedInUser->getUID())
+            || $this->groupManager->getSubAdmin()->isUserAccessible($currentLoggedInUser, $targetUserObject)) {
+                $data['enabled'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'enabled', 'true') === 'true';
+        } else {
+            // Check they are looking up themselves
+            if ($currentLoggedInUser->getUID() !== $targetUserObject->getUID()) {
+                return $data;
+            }
+        }
+
+        // Get groups data
+        $userAccount = $this->accountManager->getUser($targetUserObject);
+        $groups = $this->groupManager->getUserGroups($targetUserObject);
+        $gids = [];
+        foreach ($groups as $group) {
+            $gids[] = $group->getGID();
+        }
+
+        // Find the data
+        $data['id'] = $targetUserObject->getUID();
+        $data['storageLocation'] = $targetUserObject->getHome();
+        $data['lastLogin'] = $targetUserObject->getLastLogin() * 1000;
+        $data['backend'] = $targetUserObject->getBackendClassName();
+        $data['subadmin'] = $this->getUserSubAdminGroupsData($targetUserObject->getUID());
+        $data['quota'] = $this->fillStorageInfo($targetUserObject->getUID());
+        $data[AccountManager::PROPERTY_EMAIL] = $targetUserObject->getEMailAddress();
+        $data[AccountManager::PROPERTY_DISPLAYNAME] = $targetUserObject->getDisplayName();
+        $data[AccountManager::PROPERTY_PHONE] = $userAccount[AccountManager::PROPERTY_PHONE]['value'];
+        $data[AccountManager::PROPERTY_ADDRESS] = $userAccount[AccountManager::PROPERTY_ADDRESS]['value'];
+        $data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
+        $data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
+        $data['groups'] = $gids;
+        $data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
+        $data['locale'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'locale');
+
+        $backend = $targetUserObject->getBackend();
+        $data['backendCapabilities'] = [
+            'setDisplayName' => $backend instanceof ISetDisplayNameBackend || $backend->implementsActions(Backend::SET_DISPLAYNAME),
+            'setPassword' => $backend instanceof ISetPasswordBackend || $backend->implementsActions(Backend::SET_PASSWORD),
+        ];
+
+        return $data;
+    }
+
+    /**
+     * Get the groups a user is a subadmin of
+     *
+     * @param string $userId
+     * @return array
+     * @throws OCSException
+     */
+    protected function getUserSubAdminGroupsData(string $userId): array {
+        $user = $this->userManager->get($userId);
+        // Check if the user exists
+        if($user === null) {
+            throw new OCSNotFoundException('User does not exist');
+        }
+
+        // Get the subadmin groups
+        $subAdminGroups = $this->groupManager->getSubAdmin()->getSubAdminsGroups($user);
+        $groups = [];
+        foreach ($subAdminGroups as $key => $group) {
+            $groups[] = $group->getGID();
+        }
+
+        return $groups;
+    }
+
+    /**
+     * @param string $userId
+     * @return array
+     * @throws \OCP\Files\NotFoundException
+     */
+    protected function fillStorageInfo(string $userId): array {
+        try {
+            \OC_Util::tearDownFS();
+            \OC_Util::setupFS($userId);
+            $storage = OC_Helper::getStorageInfo('/');
+            $data = [
+                'free' => $storage['free'],
+                'used' => $storage['used'],
+                'total' => $storage['total'],
+                'relative' => $storage['relative'],
+                'quota' => $storage['quota'],
+            ];
+        } catch (NotFoundException $ex) {
+            // User fs is not setup yet
+            $user = $this->userManager->get($userId);
+            if ($user === null) {
+                throw new OCSException('User does not exist', 101);
+            }
+            $quota = $user->getQuota();
+            if ($quota !== 'none') {
+                $quota = OC_Helper::computerFileSize($quota);
+            }
+            $data = [
+                'quota' => $quota !== false ? $quota : 'none',
+                'used' => 0
+            ];
+        }
+        return $data;
+    }
 
 }