nextcloud / server

lib/private/legacy/OC_User.php

Indentation +366 added lines, -366 removed lines

@@ -60,370 +60,370 @@
  *   logout()
  */
 class OC_User {
-	private static $_usedBackends = [];
-
-	private static $_setupedBackends = [];
-
-	// 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
-	 * @suppress PhanDeprecatedFunction
-	 */
-	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 . '.', ILogger::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 . '.', ILogger::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 = [];
-		\OC::$server->getUserManager()->clearBackends();
-	}
-
-	/**
-	 * setup the configured backends in config.php
-	 * @suppress PhanDeprecatedFunction
-	 */
-	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.', ILogger::DEBUG);
-				}
-			} else {
-				\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
-			}
-		}
-	}
-
-	/**
-	 * 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", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
-
-		if ($uid) {
-			if (self::getUser() !== $uid) {
-				self::setUserId($uid);
-				$userSession = \OC::$server->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',
-					[
-						'uid' => $uid,
-						'password' => '',
-						'isTokenLogin' => false,
-					]
-				);
-				/** @var IEventDispatcher $dispatcher */
-				$dispatcher = \OC::$server->get(IEventDispatcher::class);
-				$dispatcher->dispatchTyped(new UserLoggedInEvent(
-						\OC::$server->get(IUserManager::class)->get($uid),
-						$uid,
-						'',
-						false)
-				);
-
-				//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();
-			\OC::$server->getUserSession()->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);
-		}
-	}
-
-	/**
-	 * 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;
-	}
-
-	/**
-	 * Returns the current logout URL valid for the currently logged-in user
-	 *
-	 * @param \OCP\IURLGenerator $urlGenerator
-	 * @return string
-	 */
-	public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
-		$backend = self::findFirstActiveUsedBackend();
-		if ($backend) {
-			return $backend->getLogoutUrl();
-		}
-
-		$user = \OC::$server->getUserSession()->getUser();
-		if ($user instanceof \OCP\IUser) {
-			$backend = $user->getBackend();
-			if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
-				return $backend->getLogoutUrl();
-			}
-		}
-
-		$logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
-		$logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
-
-		return $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|bool uid or false
-	 * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method
-	 *                   get() of \OCP\IUserManager - \OC::$server->getUserManager()
-	 */
-	public static function getDisplayName($uid = null) {
-		if ($uid) {
-			$user = \OC::$server->getUserManager()->get($uid);
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return $uid;
-			}
-		} else {
-			$user = \OC::$server->getUserSession()->getUser();
-			if ($user) {
-				return $user->getDisplayName();
-			} else {
-				return false;
-			}
-		}
-	}
-
-	/**
-	 * 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;
-		}
-	}
-
-	/**
-	 * @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 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 = [];
-		$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
-		foreach ($users as $user) {
-			$displayNames[$user->getUID()] = $user->getDisplayName();
-		}
-		return $displayNames;
-	}
-
-	/**
-	 * 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;
-	}
+    private static $_usedBackends = [];
+
+    private static $_setupedBackends = [];
+
+    // 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
+     * @suppress PhanDeprecatedFunction
+     */
+    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 . '.', ILogger::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 . '.', ILogger::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 = [];
+        \OC::$server->getUserManager()->clearBackends();
+    }
+
+    /**
+     * setup the configured backends in config.php
+     * @suppress PhanDeprecatedFunction
+     */
+    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.', ILogger::DEBUG);
+                }
+            } else {
+                \OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', ILogger::ERROR);
+            }
+        }
+    }
+
+    /**
+     * 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", ["run" => &$run, "uid" => $uid, 'backend' => $backend]);
+
+        if ($uid) {
+            if (self::getUser() !== $uid) {
+                self::setUserId($uid);
+                $userSession = \OC::$server->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',
+                    [
+                        'uid' => $uid,
+                        'password' => '',
+                        'isTokenLogin' => false,
+                    ]
+                );
+                /** @var IEventDispatcher $dispatcher */
+                $dispatcher = \OC::$server->get(IEventDispatcher::class);
+                $dispatcher->dispatchTyped(new UserLoggedInEvent(
+                        \OC::$server->get(IUserManager::class)->get($uid),
+                        $uid,
+                        '',
+                        false)
+                );
+
+                //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();
+            \OC::$server->getUserSession()->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);
+        }
+    }
+
+    /**
+     * 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;
+    }
+
+    /**
+     * Returns the current logout URL valid for the currently logged-in user
+     *
+     * @param \OCP\IURLGenerator $urlGenerator
+     * @return string
+     */
+    public static function getLogoutUrl(\OCP\IURLGenerator $urlGenerator) {
+        $backend = self::findFirstActiveUsedBackend();
+        if ($backend) {
+            return $backend->getLogoutUrl();
+        }
+
+        $user = \OC::$server->getUserSession()->getUser();
+        if ($user instanceof \OCP\IUser) {
+            $backend = $user->getBackend();
+            if ($backend instanceof \OCP\User\Backend\ICustomLogout) {
+                return $backend->getLogoutUrl();
+            }
+        }
+
+        $logoutUrl = $urlGenerator->linkToRoute('core.login.logout');
+        $logoutUrl .= '?requesttoken=' . urlencode(\OCP\Util::callRegister());
+
+        return $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|bool uid or false
+     * @deprecated 8.1.0 fetch \OCP\IUser (has getDisplayName()) by using method
+     *                   get() of \OCP\IUserManager - \OC::$server->getUserManager()
+     */
+    public static function getDisplayName($uid = null) {
+        if ($uid) {
+            $user = \OC::$server->getUserManager()->get($uid);
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return $uid;
+            }
+        } else {
+            $user = \OC::$server->getUserSession()->getUser();
+            if ($user) {
+                return $user->getDisplayName();
+            } else {
+                return false;
+            }
+        }
+    }
+
+    /**
+     * 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;
+        }
+    }
+
+    /**
+     * @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 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 = [];
+        $users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
+        foreach ($users as $user) {
+            $displayNames[$user->getUID()] = $user->getDisplayName();
+        }
+        return $displayNames;
+    }
+
+    /**
+     * 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;
+    }
 }