123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405 |
- <?php
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Aldo "xoen" Giambelluca <xoen@xoen.org>
- * @author Andreas Fischer <bantu@owncloud.com>
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Bartek Przybylski <bart.p.pl@gmail.com>
- * @author Björn Schießle <bjoern@schiessle.org>
- * @author Christoph Wurst <christoph@owncloud.com>
- * @author Georg Ehrke <oc.list@georgehrke.com>
- * @author Jakob Sack <mail@jakobsack.de>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author shkdee <louis.traynard@m4x.org>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Tom Needham <tom@owncloud.com>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- use OCP\ILogger;
- /**
- * This class provides wrapper methods for user management. Multiple backends are
- * supported. User management operations are delegated to the configured backend for
- * execution.
- *
- * Note that &run is deprecated and won't work anymore.
- *
- * Hooks provided:
- * pre_createUser(&run, uid, password)
- * post_createUser(uid, password)
- * pre_deleteUser(&run, uid)
- * post_deleteUser(uid)
- * pre_setPassword(&run, uid, password, recoveryPassword)
- * post_setPassword(uid, password, recoveryPassword)
- * pre_login(&run, uid, password)
- * post_login(uid)
- * logout()
- */
- class OC_User {
- 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
- * @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 = array();
- \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", array("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", 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();
- \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();
- }
- $logoutUrl = $urlGenerator->linkToRouteAbsolute('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 = array();
- $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;
- }
- }
|