nextcloud / server

lib/private/legacy/user.php

Indentation +509 added lines, -510 removed lines

@@ -57,514 +57,513 @@
  */
 class OC_User {
 
-	/**
-	 * @return \OC\User\Session
-	 */
-	public static function getUserSession() {
-		return OC::$server->getUserSession();
-	}
-
-	private static $_usedBackends = array();
-
-	private static $_setupedBackends = array();
-
-	// bool, stores if a user want to access a resource anonymously, e.g if they open a public link
-	private static $incognitoMode = false;
-
-	/**
-	 * Adds the backend to the list of used backends
-	 *
-	 * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
-	 * @return bool
-	 *
-	 * Set the User Authentication Module
-	 */
-	public static function useBackend($backend = 'database') {
-		if ($backend instanceof \OCP\UserInterface) {
-			self::$_usedBackends[get_class($backend)] = $backend;
-			\OC::$server->getUserManager()->registerBackend($backend);
-		} else {
-			// You'll never know what happens
-			if (null === $backend OR !is_string($backend)) {
-				$backend = 'database';
-			}
-
-			// Load backend
-			switch ($backend) {
-				case 'database':
-				case 'mysql':
-				case 'sqlite':
-					\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
-					self::$_usedBackends[$backend] = new \OC\User\Database();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				case 'dummy':
-					self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-				default:
-					\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
-					$className = 'OC_USER_' . strtoupper($backend);
-					self::$_usedBackends[$backend] = new $className();
-					\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
-					break;
-			}
-		}
-		return true;
-	}
-
-	/**
-	 * remove all used backends
-	 */
-	public static function clearBackends() {
-		self::$_usedBackends = array();
-		\OC::$server->getUserManager()->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 */
-	public static function setupBackends() {
-		OC_App::loadApps(['prelogin']);
-		$backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
-		if (isset($backends['default']) && !$backends['default']) {
-			// clear default backends
-			self::clearBackends();
-		}
-		foreach ($backends as $i => $config) {
-			if (!is_array($config)) {
-				continue;
-			}
-			$class = $config['class'];
-			$arguments = $config['arguments'];
-			if (class_exists($class)) {
-				if (array_search($i, self::$_setupedBackends) === false) {
-					// make a reflection object
-					$reflectionObj = new ReflectionClass($class);
-
-					// use Reflection to create a new instance, using the $args
-					$backend = $reflectionObj->newInstanceArgs($arguments);
-					self::useBackend($backend);
-					self::$_setupedBackends[] = $i;
-				} else {
-					\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
-				}
-			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
-			}
-		}
-	}
-
-	/**
-
-	 * Try to login a user using the magic cookie (remember login)
-	 *
-	 * @deprecated use \OCP\IUserSession::loginWithCookie()
-	 * @param string $uid The username of the user to log in
-	 * @param string $token
-	 * @param string $oldSessionId
-	 * @return bool
-	 */
-	public static function loginWithCookie($uid, $token, $oldSessionId) {
-		return self::getUserSession()->loginWithCookie($uid, $token, $oldSessionId);
-	}
-
-	/**
-	 * Try to login a user, assuming authentication
-	 * has already happened (e.g. via Single Sign On).
-	 *
-	 * Log in a user and regenerate a new session.
-	 *
-	 * @param \OCP\Authentication\IApacheBackend $backend
-	 * @return bool
-	 */
-	public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
-
-		$uid = $backend->getCurrentUserId();
-		$run = true;
-		OC_Hook::emit("OC_User", "pre_login", array("run" => &$run, "uid" => $uid));
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				$setUidAsDisplayName = true;
-				if($backend instanceof \OCP\UserInterface
-					&& $backend->implementsActions(OC_User_Backend::GET_DISPLAYNAME)) {
-
-					$backendDisplayName = $backend->getDisplayName($uid);
-					if(is_string($backendDisplayName) && trim($backendDisplayName) !== '') {
-						$setUidAsDisplayName = false;
-					}
-				}
-				if($setUidAsDisplayName) {
-					self::setDisplayName($uid);
-				}
-				$userSession = self::getUserSession();
-				$userSession->setLoginName($uid);
-				$request = OC::$server->getRequest();
-				$userSession->createSessionToken($request, $uid, $uid);
-				// setup the filesystem
-				OC_Util::setupFS($uid);
-				// first call the post_login hooks, the login-process needs to be
-				// completed before we can safely create the users folder.
-				// For example encryption needs to initialize the users keys first
-				// before we can create the user folder with the skeleton files
-				OC_Hook::emit("OC_User", "post_login", array("uid" => $uid, 'password' => ''));
-				//trigger creation of user home and /files folder
-				\OC::$server->getUserFolder($uid);
-			}
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * Verify with Apache whether user is authenticated.
-	 *
-	 * @return boolean|null
-	 *          true: authenticated
-	 *          false: not authenticated
-	 *          null: not handled / no backend available
-	 */
-	public static function handleApacheAuth() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			OC_App::loadApps();
-
-			//setup extra user backends
-			self::setupBackends();
-			self::unsetMagicInCookie();
-
-			return self::loginWithApache($backend);
-		}
-
-		return null;
-	}
-
-
-	/**
-	 * Sets user id for session and triggers emit
-	 *
-	 * @param string $uid
-	 */
-	public static function setUserId($uid) {
-		$userSession = \OC::$server->getUserSession();
-		$userManager = \OC::$server->getUserManager();
-		if ($user = $userManager->get($uid)) {
-			$userSession->setUser($user);
-		} else {
-			\OC::$server->getSession()->set('user_id', $uid);
-		}
-	}
-
-	/**
-	 * Sets user display name for session
-	 *
-	 * @param string $uid
-	 * @param string $displayName
-	 * @return bool Whether the display name could get set
-	 */
-	public static function setDisplayName($uid, $displayName = null) {
-		if (is_null($displayName)) {
-			$displayName = $uid;
-		}
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setDisplayName($displayName);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check if the user is logged in, considers also the HTTP basic credentials
-	 *
-	 * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
-	 * @return bool
-	 */
-	public static function isLoggedIn() {
-		return \OC::$server->getUserSession()->isLoggedIn();
-	}
-
-	/**
-	 * set incognito mode, e.g. if a user wants to open a public link
-	 *
-	 * @param bool $status
-	 */
-	public static function setIncognitoMode($status) {
-		self::$incognitoMode = $status;
-	}
-
-	/**
-	 * get incognito mode status
-	 *
-	 * @return bool
-	 */
-	public static function isIncognitoMode() {
-		return self::$incognitoMode;
-	}
-
-	/**
-	 * Supplies an attribute to the logout hyperlink. The default behaviour
-	 * is to return an href with '?logout=true' appended. However, it can
-	 * supply any attribute(s) which are valid for <a>.
-	 *
-	 * @return string with one or more HTML attributes.
-	 */
-	public static function getLogoutAttribute() {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutAttribute();
-		}
-
-		$logoutUrl = \OC::$server->getURLGenerator()->linkToRouteAbsolute(
-			'core.login.logout',
-			[
-				'requesttoken' => \OCP\Util::callRegister(),
-			]
-		);
-
-		return 'href="'.$logoutUrl.'"';
-	}
-
-	/**
-	 * Check if the user is an admin user
-	 *
-	 * @param string $uid uid of the admin
-	 * @return bool
-	 */
-	public static function isAdminUser($uid) {
-		$group = \OC::$server->getGroupManager()->get('admin');
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
-			return true;
-		}
-		return false;
-	}
-
-
-	/**
-	 * get the user id of the user currently logged in.
-	 *
-	 * @return string|bool uid or false
-	 */
-	public static function getUser() {
-		$uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
-		if (!is_null($uid) && self::$incognitoMode === false) {
-			return $uid;
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * get the display name of the user currently logged in.
-	 *
-	 * @param string $uid
-	 * @return string uid or false
-	 */
-	public static function getDisplayName($uid = null) {
-		if ($uid) {
-			$user = \OC::$server->getUserManager()->get($uid);
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return $uid;
-			}
-		} else {
-			$user = self::getUserSession()->getUser();
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return false;
-			}
-		}
-	}
-
-	/**
-	 * Autogenerate a password
-	 *
-	 * @return string
-	 *
-	 * generates a password
-	 */
-	public static function generatePassword() {
-		return \OC::$server->getSecureRandom()->generate(30);
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @param string $recoveryPassword for the encryption app to reset encryption keys
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public static function setPassword($uid, $password, $recoveryPassword = null) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->setPassword($password, $recoveryPassword);
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Check if the password is correct
-	 *
-	 * @param string $uid The username
-	 * @param string $password The password
-	 * @return string|false user id a string on success, false otherwise
-	 *
-	 * Check if the password is correct without logging in the user
-	 * returns the user id or false
-	 */
-	public static function checkPassword($uid, $password) {
-		$manager = \OC::$server->getUserManager();
-		$username = $manager->checkPassword($uid, $password);
-		if ($username !== false) {
-			return $username->getUID();
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $uid The username
-	 * @return string
-	 *
-	 * returns the path to the users home directory
-	 * @deprecated Use \OC::$server->getUserManager->getHome()
-	 */
-	public static function getHome($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->getHome();
-		} else {
-			return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-	}
-
-	/**
-	 * Get a list of all users
-	 *
-	 * @return array an array of all uids
-	 *
-	 * Get a list of all users.
-	 * @param string $search
-	 * @param integer $limit
-	 * @param integer $offset
-	 */
-	public static function getUsers($search = '', $limit = null, $offset = null) {
-		$users = \OC::$server->getUserManager()->search($search, $limit, $offset);
-		$uids = array();
-		foreach ($users as $user) {
-			$uids[] = $user->getUID();
-		}
-		return $uids;
-	}
-
-	/**
-	 * Get a list of all users display name
-	 *
-	 * @param string $search
-	 * @param int $limit
-	 * @param int $offset
-	 * @return array associative array with all display names (value) and corresponding uids (key)
-	 *
-	 * Get a list of all display names and user ids.
-	 * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
-	 */
-	public static function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$displayNames = array();
-		$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public static function userExists($uid) {
-		return \OC::$server->getUserManager()->userExists($uid);
-	}
-
-	/**
-	 * disables a user
-	 *
-	 * @param string $uid the user to disable
-	 */
-	public static function disableUser($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			$user->setEnabled(false);
-		}
-	}
-
-	/**
-	 * enable a user
-	 *
-	 * @param string $uid
-	 */
-	public static function enableUser($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			$user->setEnabled(true);
-		}
-	}
-
-	/**
-	 * checks if a user is enabled
-	 *
-	 * @param string $uid
-	 * @return bool
-	 */
-	public static function isEnabled($uid) {
-		$user = \OC::$server->getUserManager()->get($uid);
-		if ($user) {
-			return $user->isEnabled();
-		} else {
-			return false;
-		}
-	}
-
-	/**
-	 * Set cookie value to use in next page load
-	 *
-	 * @param string $username username to be set
-	 * @param string $token
-	 */
-	public static function setMagicInCookie($username, $token) {
-		self::getUserSession()->setMagicInCookie($username, $token);
-	}
-
-	/**
-	 * Remove cookie for "remember username"
-	 */
-	public static function unsetMagicInCookie() {
-		self::getUserSession()->unsetMagicInCookie();
-	}
-
-	/**
-	 * Returns the first active backend from self::$_usedBackends.
-	 *
-	 * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
-	 */
-	private static function findFirstActiveUsedBackend() {
-		foreach (self::$_usedBackends as $backend) {
-			if ($backend instanceof OCP\Authentication\IApacheBackend) {
-				if ($backend->isSessionActive()) {
-					return $backend;
-				}
-			}
-		}
-
-		return null;
-	}
+    /**
+     * @return \OC\User\Session
+     */
+    public static function getUserSession() {
+        return OC::$server->getUserSession();
+    }
+
+    private static $_usedBackends = array();
+
+    private static $_setupedBackends = array();
+
+    // bool, stores if a user want to access a resource anonymously, e.g if they open a public link
+    private static $incognitoMode = false;
+
+    /**
+     * Adds the backend to the list of used backends
+     *
+     * @param string|\OCP\UserInterface $backend default: database The backend to use for user management
+     * @return bool
+     *
+     * Set the User Authentication Module
+     */
+    public static function useBackend($backend = 'database') {
+        if ($backend instanceof \OCP\UserInterface) {
+            self::$_usedBackends[get_class($backend)] = $backend;
+            \OC::$server->getUserManager()->registerBackend($backend);
+        } else {
+            // You'll never know what happens
+            if (null === $backend OR !is_string($backend)) {
+                $backend = 'database';
+            }
+
+            // Load backend
+            switch ($backend) {
+                case 'database':
+                case 'mysql':
+                case 'sqlite':
+                    \OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
+                    self::$_usedBackends[$backend] = new \OC\User\Database();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                case 'dummy':
+                    self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+                default:
+                    \OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
+                    $className = 'OC_USER_' . strtoupper($backend);
+                    self::$_usedBackends[$backend] = new $className();
+                    \OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
+                    break;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * remove all used backends
+     */
+    public static function clearBackends() {
+        self::$_usedBackends = array();
+        \OC::$server->getUserManager()->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     */
+    public static function setupBackends() {
+        OC_App::loadApps(['prelogin']);
+        $backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
+        if (isset($backends['default']) && !$backends['default']) {
+            // clear default backends
+            self::clearBackends();
+        }
+        foreach ($backends as $i => $config) {
+            if (!is_array($config)) {
+                continue;
+            }
+            $class = $config['class'];
+            $arguments = $config['arguments'];
+            if (class_exists($class)) {
+                if (array_search($i, self::$_setupedBackends) === false) {
+                    // make a reflection object
+                    $reflectionObj = new ReflectionClass($class);
+
+                    // use Reflection to create a new instance, using the $args
+                    $backend = $reflectionObj->newInstanceArgs($arguments);
+                    self::useBackend($backend);
+                    self::$_setupedBackends[] = $i;
+                } else {
+                    \OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
+                }
+            } else {
+                \OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
+            }
+        }
+    }
+
+    /**
+     * Try to login a user using the magic cookie (remember login)
+     *
+     * @deprecated use \OCP\IUserSession::loginWithCookie()
+     * @param string $uid The username of the user to log in
+     * @param string $token
+     * @param string $oldSessionId
+     * @return bool
+     */
+    public static function loginWithCookie($uid, $token, $oldSessionId) {
+        return self::getUserSession()->loginWithCookie($uid, $token, $oldSessionId);
+    }
+
+    /**
+     * Try to login a user, assuming authentication
+     * has already happened (e.g. via Single Sign On).
+     *
+     * Log in a user and regenerate a new session.
+     *
+     * @param \OCP\Authentication\IApacheBackend $backend
+     * @return bool
+     */
+    public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
+
+        $uid = $backend->getCurrentUserId();
+        $run = true;
+        OC_Hook::emit("OC_User", "pre_login", array("run" => &$run, "uid" => $uid));
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                $setUidAsDisplayName = true;
+                if($backend instanceof \OCP\UserInterface
+                    && $backend->implementsActions(OC_User_Backend::GET_DISPLAYNAME)) {
+
+                    $backendDisplayName = $backend->getDisplayName($uid);
+                    if(is_string($backendDisplayName) && trim($backendDisplayName) !== '') {
+                        $setUidAsDisplayName = false;
+                    }
+                }
+                if($setUidAsDisplayName) {
+                    self::setDisplayName($uid);
+                }
+                $userSession = self::getUserSession();
+                $userSession->setLoginName($uid);
+                $request = OC::$server->getRequest();
+                $userSession->createSessionToken($request, $uid, $uid);
+                // setup the filesystem
+                OC_Util::setupFS($uid);
+                // first call the post_login hooks, the login-process needs to be
+                // completed before we can safely create the users folder.
+                // For example encryption needs to initialize the users keys first
+                // before we can create the user folder with the skeleton files
+                OC_Hook::emit("OC_User", "post_login", array("uid" => $uid, 'password' => ''));
+                //trigger creation of user home and /files folder
+                \OC::$server->getUserFolder($uid);
+            }
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Verify with Apache whether user is authenticated.
+     *
+     * @return boolean|null
+     *          true: authenticated
+     *          false: not authenticated
+     *          null: not handled / no backend available
+     */
+    public static function handleApacheAuth() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            OC_App::loadApps();
+
+            //setup extra user backends
+            self::setupBackends();
+            self::unsetMagicInCookie();
+
+            return self::loginWithApache($backend);
+        }
+
+        return null;
+    }
+
+
+    /**
+     * Sets user id for session and triggers emit
+     *
+     * @param string $uid
+     */
+    public static function setUserId($uid) {
+        $userSession = \OC::$server->getUserSession();
+        $userManager = \OC::$server->getUserManager();
+        if ($user = $userManager->get($uid)) {
+            $userSession->setUser($user);
+        } else {
+            \OC::$server->getSession()->set('user_id', $uid);
+        }
+    }
+
+    /**
+     * Sets user display name for session
+     *
+     * @param string $uid
+     * @param string $displayName
+     * @return bool Whether the display name could get set
+     */
+    public static function setDisplayName($uid, $displayName = null) {
+        if (is_null($displayName)) {
+            $displayName = $uid;
+        }
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setDisplayName($displayName);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check if the user is logged in, considers also the HTTP basic credentials
+     *
+     * @deprecated use \OC::$server->getUserSession()->isLoggedIn()
+     * @return bool
+     */
+    public static function isLoggedIn() {
+        return \OC::$server->getUserSession()->isLoggedIn();
+    }
+
+    /**
+     * set incognito mode, e.g. if a user wants to open a public link
+     *
+     * @param bool $status
+     */
+    public static function setIncognitoMode($status) {
+        self::$incognitoMode = $status;
+    }
+
+    /**
+     * get incognito mode status
+     *
+     * @return bool
+     */
+    public static function isIncognitoMode() {
+        return self::$incognitoMode;
+    }
+
+    /**
+     * Supplies an attribute to the logout hyperlink. The default behaviour
+     * is to return an href with '?logout=true' appended. However, it can
+     * supply any attribute(s) which are valid for <a>.
+     *
+     * @return string with one or more HTML attributes.
+     */
+    public static function getLogoutAttribute() {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutAttribute();
+        }
+
+        $logoutUrl = \OC::$server->getURLGenerator()->linkToRouteAbsolute(
+            'core.login.logout',
+            [
+                'requesttoken' => \OCP\Util::callRegister(),
+            ]
+        );
+
+        return 'href="'.$logoutUrl.'"';
+    }
+
+    /**
+     * Check if the user is an admin user
+     *
+     * @param string $uid uid of the admin
+     * @return bool
+     */
+    public static function isAdminUser($uid) {
+        $group = \OC::$server->getGroupManager()->get('admin');
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($group && $user && $group->inGroup($user) && self::$incognitoMode === false) {
+            return true;
+        }
+        return false;
+    }
+
+
+    /**
+     * get the user id of the user currently logged in.
+     *
+     * @return string|bool uid or false
+     */
+    public static function getUser() {
+        $uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
+        if (!is_null($uid) && self::$incognitoMode === false) {
+            return $uid;
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * get the display name of the user currently logged in.
+     *
+     * @param string $uid
+     * @return string uid or false
+     */
+    public static function getDisplayName($uid = null) {
+        if ($uid) {
+            $user = \OC::$server->getUserManager()->get($uid);
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return $uid;
+            }
+        } else {
+            $user = self::getUserSession()->getUser();
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return false;
+            }
+        }
+    }
+
+    /**
+     * Autogenerate a password
+     *
+     * @return string
+     *
+     * generates a password
+     */
+    public static function generatePassword() {
+        return \OC::$server->getSecureRandom()->generate(30);
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @param string $recoveryPassword for the encryption app to reset encryption keys
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public static function setPassword($uid, $password, $recoveryPassword = null) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->setPassword($password, $recoveryPassword);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check if the password is correct
+     *
+     * @param string $uid The username
+     * @param string $password The password
+     * @return string|false user id a string on success, false otherwise
+     *
+     * Check if the password is correct without logging in the user
+     * returns the user id or false
+     */
+    public static function checkPassword($uid, $password) {
+        $manager = \OC::$server->getUserManager();
+        $username = $manager->checkPassword($uid, $password);
+        if ($username !== false) {
+            return $username->getUID();
+        }
+        return false;
+    }
+
+    /**
+     * @param string $uid The username
+     * @return string
+     *
+     * returns the path to the users home directory
+     * @deprecated Use \OC::$server->getUserManager->getHome()
+     */
+    public static function getHome($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->getHome();
+        } else {
+            return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+    }
+
+    /**
+     * Get a list of all users
+     *
+     * @return array an array of all uids
+     *
+     * Get a list of all users.
+     * @param string $search
+     * @param integer $limit
+     * @param integer $offset
+     */
+    public static function getUsers($search = '', $limit = null, $offset = null) {
+        $users = \OC::$server->getUserManager()->search($search, $limit, $offset);
+        $uids = array();
+        foreach ($users as $user) {
+            $uids[] = $user->getUID();
+        }
+        return $uids;
+    }
+
+    /**
+     * Get a list of all users display name
+     *
+     * @param string $search
+     * @param int $limit
+     * @param int $offset
+     * @return array associative array with all display names (value) and corresponding uids (key)
+     *
+     * Get a list of all display names and user ids.
+     * @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
+     */
+    public static function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $displayNames = array();
+        $users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid the username
+     * @return boolean
+     */
+    public static function userExists($uid) {
+        return \OC::$server->getUserManager()->userExists($uid);
+    }
+
+    /**
+     * disables a user
+     *
+     * @param string $uid the user to disable
+     */
+    public static function disableUser($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            $user->setEnabled(false);
+        }
+    }
+
+    /**
+     * enable a user
+     *
+     * @param string $uid
+     */
+    public static function enableUser($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            $user->setEnabled(true);
+        }
+    }
+
+    /**
+     * checks if a user is enabled
+     *
+     * @param string $uid
+     * @return bool
+     */
+    public static function isEnabled($uid) {
+        $user = \OC::$server->getUserManager()->get($uid);
+        if ($user) {
+            return $user->isEnabled();
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Set cookie value to use in next page load
+     *
+     * @param string $username username to be set
+     * @param string $token
+     */
+    public static function setMagicInCookie($username, $token) {
+        self::getUserSession()->setMagicInCookie($username, $token);
+    }
+
+    /**
+     * Remove cookie for "remember username"
+     */
+    public static function unsetMagicInCookie() {
+        self::getUserSession()->unsetMagicInCookie();
+    }
+
+    /**
+     * Returns the first active backend from self::$_usedBackends.
+     *
+     * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
+     */
+    private static function findFirstActiveUsedBackend() {
+        foreach (self::$_usedBackends as $backend) {
+            if ($backend instanceof OCP\Authentication\IApacheBackend) {
+                if ($backend->isSessionActive()) {
+                    return $backend;
+                }
+            }
+        }
+
+        return null;
+    }
 }

lib/private/Settings/Personal/PersonalInfo.php

Indentation +216 added lines, -216 removed lines

@@ -39,246 +39,246 @@
 use OCP\Settings\ISettings;
 
 class PersonalInfo implements ISettings {
-	/** @var IConfig */
-	private $config;
-	/** @var IUserManager */
-	private $userManager;
-	/** @var AccountManager */
-	private $accountManager;
-	/** @var IGroupManager */
-	private $groupManager;
-	/** @var IAppManager */
-	private $appManager;
-	/** @var IFactory */
-	private $l10nFactory;
+    /** @var IConfig */
+    private $config;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var AccountManager */
+    private $accountManager;
+    /** @var IGroupManager */
+    private $groupManager;
+    /** @var IAppManager */
+    private $appManager;
+    /** @var IFactory */
+    private $l10nFactory;
 
-	const COMMON_LANGUAGE_CODES = [
-		'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
-		'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
-	];
+    const COMMON_LANGUAGE_CODES = [
+        'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
+        'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
+    ];
 
-	/** @var IL10N */
-	private $l;
+    /** @var IL10N */
+    private $l;
 
-	/**
-	 * @param IConfig $config
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param AccountManager $accountManager
-	 * @param IFactory $l10nFactory
-	 * @param IL10N $l
-	 */
-	public function __construct(
-		IConfig $config,
-		IUserManager $userManager,
-		IGroupManager $groupManager,
-		AccountManager $accountManager,
-		IAppManager $appManager,
-		IFactory $l10nFactory,
-		IL10N $l
-	) {
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->accountManager = $accountManager;
-		$this->groupManager = $groupManager;
-		$this->appManager = $appManager;
-		$this->l10nFactory = $l10nFactory;
-		$this->l = $l;
-	}
+    /**
+     * @param IConfig $config
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param AccountManager $accountManager
+     * @param IFactory $l10nFactory
+     * @param IL10N $l
+     */
+    public function __construct(
+        IConfig $config,
+        IUserManager $userManager,
+        IGroupManager $groupManager,
+        AccountManager $accountManager,
+        IAppManager $appManager,
+        IFactory $l10nFactory,
+        IL10N $l
+    ) {
+        $this->config = $config;
+        $this->userManager = $userManager;
+        $this->accountManager = $accountManager;
+        $this->groupManager = $groupManager;
+        $this->appManager = $appManager;
+        $this->l10nFactory = $l10nFactory;
+        $this->l = $l;
+    }
 
-	/**
-	 * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
-	 * @since 9.1
-	 */
-	public function getForm() {
-		$federatedFileSharingEnabled = $this->appManager->isEnabledForUser('federatedfilesharing');
-		$lookupServerUploadEnabled = false;
-		if($federatedFileSharingEnabled) {
-			$federatedFileSharing = new Application();
-			$shareProvider = $federatedFileSharing->getFederatedShareProvider();
-			$lookupServerUploadEnabled = $shareProvider->isLookupServerUploadEnabled();
-		}
+    /**
+     * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+     * @since 9.1
+     */
+    public function getForm() {
+        $federatedFileSharingEnabled = $this->appManager->isEnabledForUser('federatedfilesharing');
+        $lookupServerUploadEnabled = false;
+        if($federatedFileSharingEnabled) {
+            $federatedFileSharing = new Application();
+            $shareProvider = $federatedFileSharing->getFederatedShareProvider();
+            $lookupServerUploadEnabled = $shareProvider->isLookupServerUploadEnabled();
+        }
 
-		$uid = \OC_User::getUser();
-		$user = $this->userManager->get($uid);
-		$userData = $this->accountManager->getUser($user);
+        $uid = \OC_User::getUser();
+        $user = $this->userManager->get($uid);
+        $userData = $this->accountManager->getUser($user);
 
-		$storageInfo = \OC_Helper::getStorageInfo('/');
-		if ($storageInfo['quota'] === FileInfo::SPACE_UNLIMITED) {
-			$totalSpace = $this->l->t('Unlimited');
-		} else {
-			$totalSpace = \OC_Helper::humanFileSize($storageInfo['total']);
-		}
+        $storageInfo = \OC_Helper::getStorageInfo('/');
+        if ($storageInfo['quota'] === FileInfo::SPACE_UNLIMITED) {
+            $totalSpace = $this->l->t('Unlimited');
+        } else {
+            $totalSpace = \OC_Helper::humanFileSize($storageInfo['total']);
+        }
 
-		$languageParameters = $this->getLanguages($user);
-		$messageParameters = $this->getMessageParameters($userData);
+        $languageParameters = $this->getLanguages($user);
+        $messageParameters = $this->getMessageParameters($userData);
 
-		$parameters = [
-			'total_space' => $totalSpace,
-			'usage' => \OC_Helper::humanFileSize($storageInfo['used']),
-			'usage_relative' => $storageInfo['relative'],
-			'quota' => $storageInfo['quota'],
-			'avatarChangeSupported' => $user->canChangeAvatar(),
-			'lookupServerUploadEnabled' => $lookupServerUploadEnabled,
-			'avatarScope' => $userData[AccountManager::PROPERTY_AVATAR]['scope'],
-			'displayNameChangeSupported' => $user->canChangeDisplayName(),
-			'displayName' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['value'],
-			'displayNameScope' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['scope'],
-			'email' => $userData[AccountManager::PROPERTY_EMAIL]['value'],
-			'emailScope' => $userData[AccountManager::PROPERTY_EMAIL]['scope'],
-			'emailVerification' => $userData[AccountManager::PROPERTY_EMAIL]['verified'],
-			'phone' => $userData[AccountManager::PROPERTY_PHONE]['value'],
-			'phoneScope' => $userData[AccountManager::PROPERTY_PHONE]['scope'],
-			'address' => $userData[AccountManager::PROPERTY_ADDRESS]['value'],
-			'addressScope' => $userData[AccountManager::PROPERTY_ADDRESS]['scope'],
-			'website' =>  $userData[AccountManager::PROPERTY_WEBSITE]['value'],
-			'websiteScope' =>  $userData[AccountManager::PROPERTY_WEBSITE]['scope'],
-			'websiteVerification' => $userData[AccountManager::PROPERTY_WEBSITE]['verified'],
-			'twitter' => $userData[AccountManager::PROPERTY_TWITTER]['value'],
-			'twitterScope' => $userData[AccountManager::PROPERTY_TWITTER]['scope'],
-			'twitterVerification' => $userData[AccountManager::PROPERTY_TWITTER]['verified'],
-			'groups' => $this->getGroups($user),
-			'passwordChangeSupported' => $user->canChangePassword(),
-		] + $messageParameters + $languageParameters;
+        $parameters = [
+            'total_space' => $totalSpace,
+            'usage' => \OC_Helper::humanFileSize($storageInfo['used']),
+            'usage_relative' => $storageInfo['relative'],
+            'quota' => $storageInfo['quota'],
+            'avatarChangeSupported' => $user->canChangeAvatar(),
+            'lookupServerUploadEnabled' => $lookupServerUploadEnabled,
+            'avatarScope' => $userData[AccountManager::PROPERTY_AVATAR]['scope'],
+            'displayNameChangeSupported' => $user->canChangeDisplayName(),
+            'displayName' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['value'],
+            'displayNameScope' => $userData[AccountManager::PROPERTY_DISPLAYNAME]['scope'],
+            'email' => $userData[AccountManager::PROPERTY_EMAIL]['value'],
+            'emailScope' => $userData[AccountManager::PROPERTY_EMAIL]['scope'],
+            'emailVerification' => $userData[AccountManager::PROPERTY_EMAIL]['verified'],
+            'phone' => $userData[AccountManager::PROPERTY_PHONE]['value'],
+            'phoneScope' => $userData[AccountManager::PROPERTY_PHONE]['scope'],
+            'address' => $userData[AccountManager::PROPERTY_ADDRESS]['value'],
+            'addressScope' => $userData[AccountManager::PROPERTY_ADDRESS]['scope'],
+            'website' =>  $userData[AccountManager::PROPERTY_WEBSITE]['value'],
+            'websiteScope' =>  $userData[AccountManager::PROPERTY_WEBSITE]['scope'],
+            'websiteVerification' => $userData[AccountManager::PROPERTY_WEBSITE]['verified'],
+            'twitter' => $userData[AccountManager::PROPERTY_TWITTER]['value'],
+            'twitterScope' => $userData[AccountManager::PROPERTY_TWITTER]['scope'],
+            'twitterVerification' => $userData[AccountManager::PROPERTY_TWITTER]['verified'],
+            'groups' => $this->getGroups($user),
+            'passwordChangeSupported' => $user->canChangePassword(),
+        ] + $messageParameters + $languageParameters;
 
 
-		return new TemplateResponse('settings', 'settings/personal/personal.info', $parameters, '');
-	}
+        return new TemplateResponse('settings', 'settings/personal/personal.info', $parameters, '');
+    }
 
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 * @since 9.1
-	 */
-	public function getSection() {
-		return 'personal-info';
-	}
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     * @since 9.1
+     */
+    public function getSection() {
+        return 'personal-info';
+    }
 
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 * @since 9.1
-	 */
-	public function getPriority() {
-		return 10;
-	}
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     * @since 9.1
+     */
+    public function getPriority() {
+        return 10;
+    }
 
-	/**
-	 * returns a sorted list of the user's group GIDs
-	 *
-	 * @param IUser $user
-	 * @return array
-	 */
-	private function getGroups(IUser $user) {
-		$groups = array_map(
-			function(IGroup $group) {
-				return $group->getGID();
-			},
-			$this->groupManager->getUserGroups($user)
-		);
-		sort($groups);
+    /**
+     * returns a sorted list of the user's group GIDs
+     *
+     * @param IUser $user
+     * @return array
+     */
+    private function getGroups(IUser $user) {
+        $groups = array_map(
+            function(IGroup $group) {
+                return $group->getGID();
+            },
+            $this->groupManager->getUserGroups($user)
+        );
+        sort($groups);
 
-		return $groups;
-	}
+        return $groups;
+    }
 
-	/**
-	 * returns the user language, common language and other languages in an
-	 * associative array
-	 *
-	 * @param IUser $user
-	 * @return array
-	 */
-	private function getLanguages(IUser $user) {
-		$forceLanguage = $this->config->getSystemValue('force_language', false);
-		if($forceLanguage !== false) {
-			return [];
-		}
+    /**
+     * returns the user language, common language and other languages in an
+     * associative array
+     *
+     * @param IUser $user
+     * @return array
+     */
+    private function getLanguages(IUser $user) {
+        $forceLanguage = $this->config->getSystemValue('force_language', false);
+        if($forceLanguage !== false) {
+            return [];
+        }
 
-		$uid = $user->getUID();
+        $uid = $user->getUID();
 
-		$userLang = $this->config->getUserValue($uid, 'core', 'lang', $this->l10nFactory->findLanguage());
-		$languageCodes = $this->l10nFactory->findAvailableLanguages();
+        $userLang = $this->config->getUserValue($uid, 'core', 'lang', $this->l10nFactory->findLanguage());
+        $languageCodes = $this->l10nFactory->findAvailableLanguages();
 
-		$commonLanguages = [];
-		$languages = [];
+        $commonLanguages = [];
+        $languages = [];
 
-		foreach($languageCodes as $lang) {
-			$l = \OC::$server->getL10N('settings', $lang);
-			// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
-			$potentialName = (string) $l->t('__language_name__');
-			if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
-				$ln = array('code' => $lang, 'name' => $potentialName);
-			} elseif ($lang === 'en') {
-				$ln = ['code' => $lang, 'name' => 'English (US)'];
-			}else{//fallback to language code
-				$ln=array('code'=>$lang, 'name'=>$lang);
-			}
+        foreach($languageCodes as $lang) {
+            $l = \OC::$server->getL10N('settings', $lang);
+            // TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
+            $potentialName = (string) $l->t('__language_name__');
+            if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
+                $ln = array('code' => $lang, 'name' => $potentialName);
+            } elseif ($lang === 'en') {
+                $ln = ['code' => $lang, 'name' => 'English (US)'];
+            }else{//fallback to language code
+                $ln=array('code'=>$lang, 'name'=>$lang);
+            }
 
-			// put appropriate languages into appropriate arrays, to print them sorted
-			// used language -> common languages -> divider -> other languages
-			if ($lang === $userLang) {
-				$userLang = $ln;
-			} elseif (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
-				$commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)]=$ln;
-			} else {
-				$languages[]=$ln;
-			}
-		}
+            // put appropriate languages into appropriate arrays, to print them sorted
+            // used language -> common languages -> divider -> other languages
+            if ($lang === $userLang) {
+                $userLang = $ln;
+            } elseif (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
+                $commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)]=$ln;
+            } else {
+                $languages[]=$ln;
+            }
+        }
 
-		// if user language is not available but set somehow: show the actual code as name
-		if (!is_array($userLang)) {
-			$userLang = [
-				'code' => $userLang,
-				'name' => $userLang,
-			];
-		}
+        // if user language is not available but set somehow: show the actual code as name
+        if (!is_array($userLang)) {
+            $userLang = [
+                'code' => $userLang,
+                'name' => $userLang,
+            ];
+        }
 
-		ksort($commonLanguages);
+        ksort($commonLanguages);
 
-		// sort now by displayed language not the iso-code
-		usort( $languages, function ($a, $b) {
-			if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
-				// If a doesn't have a name, but b does, list b before a
-				return 1;
-			}
-			if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
-				// If a does have a name, but b doesn't, list a before b
-				return -1;
-			}
-			// Otherwise compare the names
-			return strcmp($a['name'], $b['name']);
-		});
+        // sort now by displayed language not the iso-code
+        usort( $languages, function ($a, $b) {
+            if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
+                // If a doesn't have a name, but b does, list b before a
+                return 1;
+            }
+            if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
+                // If a does have a name, but b doesn't, list a before b
+                return -1;
+            }
+            // Otherwise compare the names
+            return strcmp($a['name'], $b['name']);
+        });
 
-		return [
-			'activelanguage' => $userLang,
-			'commonlanguages' => $commonLanguages,
-			'languages' => $languages
-		];
-	}
+        return [
+            'activelanguage' => $userLang,
+            'commonlanguages' => $commonLanguages,
+            'languages' => $languages
+        ];
+    }
 
-	/**
-	 * @param array $userData
-	 * @return array
-	 */
-	private function getMessageParameters(array $userData) {
-		$needVerifyMessage = [AccountManager::PROPERTY_EMAIL, AccountManager::PROPERTY_WEBSITE, AccountManager::PROPERTY_TWITTER];
-		$messageParameters = [];
-		foreach ($needVerifyMessage as $property) {
-			switch ($userData[$property]['verified']) {
-				case AccountManager::VERIFIED:
-					$message = $this->l->t('Verifying');
-					break;
-				case AccountManager::VERIFICATION_IN_PROGRESS:
-					$message = $this->l->t('Verifying …');
-					break;
-				default:
-					$message = $this->l->t('Verify');
-			}
-			$messageParameters[$property . 'Message'] = $message;
-		}
-		return $messageParameters;
-	}
+    /**
+     * @param array $userData
+     * @return array
+     */
+    private function getMessageParameters(array $userData) {
+        $needVerifyMessage = [AccountManager::PROPERTY_EMAIL, AccountManager::PROPERTY_WEBSITE, AccountManager::PROPERTY_TWITTER];
+        $messageParameters = [];
+        foreach ($needVerifyMessage as $property) {
+            switch ($userData[$property]['verified']) {
+                case AccountManager::VERIFIED:
+                    $message = $this->l->t('Verifying');
+                    break;
+                case AccountManager::VERIFICATION_IN_PROGRESS:
+                    $message = $this->l->t('Verifying …');
+                    break;
+                default:
+                    $message = $this->l->t('Verify');
+            }
+            $messageParameters[$property . 'Message'] = $message;
+        }
+        return $messageParameters;
+    }
 
 }