2010-04-22 21:03:54 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 18:07:57 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Aldo "xoen" Giambelluca <xoen@xoen.org>
|
|
|
|
* @author Andreas Fischer <bantu@owncloud.com>
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
2016-03-01 19:25:15 +03:00
|
|
|
* @author Bartek Przybylski <bart.p.pl@gmail.com>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Björn Schießle <bjoern@schiessle.org>
|
2016-04-25 15:10:55 +03:00
|
|
|
* @author Christoph Wurst <christoph@owncloud.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Georg Ehrke <georg@owncloud.com>
|
|
|
|
* @author Jakob Sack <mail@jakobsack.de>
|
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Lukas Reschke <lukas@statuscode.ch>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
2016-07-21 19:13:36 +03:00
|
|
|
* @author Robin Appelman <robin@icewind.nl>
|
2016-01-12 17:02:16 +03:00
|
|
|
* @author Robin McCorkell <robin@mccorkell.me.uk>
|
2016-07-21 18:07:57 +03:00
|
|
|
* @author Roeland Jago Douma <roeland@famdouma.nl>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author shkdee <louis.traynard@m4x.org>
|
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
* @author Tom Needham <tom@owncloud.com>
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* @license AGPL-3.0
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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.
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
2011-04-15 19:14:02 +04:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-03-26 13:44:34 +03:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU Affero General Public License for more details.
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
2015-03-26 13:44:34 +03:00
|
|
|
* 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/>
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This class provides wrapper methods for user management. Multiple backends are
|
|
|
|
* supported. User management operations are delegated to the configured backend for
|
|
|
|
* execution.
|
|
|
|
*
|
2015-10-03 00:19:26 +03:00
|
|
|
* Note that &run is deprecated and won't work anymore.
|
|
|
|
*
|
2015-02-26 13:37:37 +03:00
|
|
|
* 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()
|
|
|
|
*/
|
2011-07-29 23:36:03 +04:00
|
|
|
class OC_User {
|
2014-04-21 17:44:54 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @return \OC\User\Session
|
|
|
|
*/
|
2013-07-10 02:06:22 +04:00
|
|
|
public static function getUserSession() {
|
2013-09-20 14:45:56 +04:00
|
|
|
return OC::$server->getUserSession();
|
2013-05-29 02:32:10 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
private static $_usedBackends = array();
|
|
|
|
|
|
|
|
private static $_setupedBackends = array();
|
|
|
|
|
2016-04-26 12:32:35 +03:00
|
|
|
// bool, stores if a user want to access a resource anonymously, e.g if they open a public link
|
2013-11-22 16:55:38 +04:00
|
|
|
private static $incognitoMode = false;
|
|
|
|
|
2011-04-15 19:14:02 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Adds the backend to the list of used backends
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2016-01-14 16:28:03 +03:00
|
|
|
* @param string|\OCP\UserInterface $backend default: database The backend to use for user management
|
2013-05-29 02:32:10 +04:00
|
|
|
* @return bool
|
2011-04-15 19:14:02 +04:00
|
|
|
*
|
|
|
|
* Set the User Authentication Module
|
|
|
|
*/
|
2013-05-29 02:32:10 +04:00
|
|
|
public static function useBackend($backend = 'database') {
|
2016-01-14 16:28:03 +03:00
|
|
|
if ($backend instanceof \OCP\UserInterface) {
|
2013-05-29 02:32:10 +04:00
|
|
|
self::$_usedBackends[get_class($backend)] = $backend;
|
2015-12-17 15:03:37 +03:00
|
|
|
\OC::$server->getUserManager()->registerBackend($backend);
|
2012-12-11 17:56:04 +04:00
|
|
|
} else {
|
2012-07-19 18:31:55 +04:00
|
|
|
// You'll never know what happens
|
2013-05-29 02:32:10 +04:00
|
|
|
if (null === $backend OR !is_string($backend)) {
|
2012-07-19 18:31:55 +04:00
|
|
|
$backend = 'database';
|
|
|
|
}
|
2010-07-21 19:53:51 +04:00
|
|
|
|
2012-07-19 18:31:55 +04:00
|
|
|
// Load backend
|
2013-05-29 02:32:10 +04:00
|
|
|
switch ($backend) {
|
2012-07-19 18:31:55 +04:00
|
|
|
case 'database':
|
|
|
|
case 'mysql':
|
|
|
|
case 'sqlite':
|
2015-07-03 15:06:40 +03:00
|
|
|
\OCP\Util::writeLog('core', 'Adding user backend ' . $backend . '.', \OCP\Util::DEBUG);
|
2016-05-04 09:34:39 +03:00
|
|
|
self::$_usedBackends[$backend] = new \OC\User\Database();
|
2015-12-17 15:03:37 +03:00
|
|
|
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
|
2012-07-19 18:31:55 +04:00
|
|
|
break;
|
2015-09-22 01:56:36 +03:00
|
|
|
case 'dummy':
|
|
|
|
self::$_usedBackends[$backend] = new \Test\Util\User\Dummy();
|
2015-12-17 15:03:37 +03:00
|
|
|
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
|
2015-09-22 01:56:36 +03:00
|
|
|
break;
|
2012-07-19 18:31:55 +04:00
|
|
|
default:
|
2015-07-03 15:06:40 +03:00
|
|
|
\OCP\Util::writeLog('core', 'Adding default user backend ' . $backend . '.', \OCP\Util::DEBUG);
|
2016-04-07 16:39:34 +03:00
|
|
|
$className = 'OC_USER_' . strtoupper($backend);
|
2012-07-19 18:31:55 +04:00
|
|
|
self::$_usedBackends[$backend] = new $className();
|
2015-12-17 15:03:37 +03:00
|
|
|
\OC::$server->getUserManager()->registerBackend(self::$_usedBackends[$backend]);
|
2012-07-19 18:31:55 +04:00
|
|
|
break;
|
|
|
|
}
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2012-12-11 17:56:04 +04:00
|
|
|
return true;
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-19 20:52:49 +04:00
|
|
|
|
2012-07-24 00:31:48 +04:00
|
|
|
/**
|
|
|
|
* remove all used backends
|
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function clearBackends() {
|
2013-05-29 02:32:10 +04:00
|
|
|
self::$_usedBackends = array();
|
2015-12-17 15:03:37 +03:00
|
|
|
\OC::$server->getUserManager()->clearBackends();
|
2012-07-24 00:31:48 +04:00
|
|
|
}
|
|
|
|
|
2012-09-01 04:48:54 +04:00
|
|
|
/**
|
|
|
|
* setup the configured backends in config.php
|
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function setupBackends() {
|
2016-12-22 11:31:35 +03:00
|
|
|
OC_App::loadApps(['prelogin']);
|
|
|
|
$backends = \OC::$server->getSystemConfig()->getValue('user_backends', []);
|
|
|
|
if (isset($backends['default']) && !$backends['default']) {
|
|
|
|
// clear default backends
|
|
|
|
self::clearBackends();
|
|
|
|
}
|
2013-05-29 02:32:10 +04:00
|
|
|
foreach ($backends as $i => $config) {
|
2016-12-22 11:31:35 +03:00
|
|
|
if (!is_array($config)) {
|
|
|
|
continue;
|
|
|
|
}
|
2013-05-29 02:32:10 +04:00
|
|
|
$class = $config['class'];
|
|
|
|
$arguments = $config['arguments'];
|
|
|
|
if (class_exists($class)) {
|
|
|
|
if (array_search($i, self::$_setupedBackends) === false) {
|
2012-12-11 17:56:04 +04:00
|
|
|
// make a reflection object
|
|
|
|
$reflectionObj = new ReflectionClass($class);
|
2012-09-01 04:48:54 +04:00
|
|
|
|
2012-12-11 17:56:04 +04:00
|
|
|
// use Reflection to create a new instance, using the $args
|
|
|
|
$backend = $reflectionObj->newInstanceArgs($arguments);
|
|
|
|
self::useBackend($backend);
|
2013-06-18 22:47:47 +04:00
|
|
|
self::$_setupedBackends[] = $i;
|
2012-12-11 17:56:04 +04:00
|
|
|
} else {
|
2015-07-03 15:06:40 +03:00
|
|
|
\OCP\Util::writeLog('core', 'User backend ' . $class . ' already initialized.', \OCP\Util::DEBUG);
|
2012-12-11 17:56:04 +04:00
|
|
|
}
|
|
|
|
} else {
|
2015-07-03 15:06:40 +03:00
|
|
|
\OCP\Util::writeLog('core', 'User backend ' . $class . ' not found.', \OCP\Util::ERROR);
|
2012-09-01 04:48:54 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-04-22 21:03:54 +04:00
|
|
|
/**
|
2011-09-18 17:05:53 +04:00
|
|
|
|
2014-05-21 20:03:37 +04:00
|
|
|
* Try to login a user using the magic cookie (remember login)
|
|
|
|
*
|
2016-04-07 16:39:34 +03:00
|
|
|
* @deprecated use \OCP\IUserSession::loginWithCookie()
|
2014-05-21 20:03:37 +04:00
|
|
|
* @param string $uid The username of the user to log in
|
|
|
|
* @param string $token
|
2016-09-06 22:41:15 +03:00
|
|
|
* @param string $oldSessionId
|
2014-05-21 20:03:37 +04:00
|
|
|
* @return bool
|
|
|
|
*/
|
2016-09-06 22:41:15 +03:00
|
|
|
public static function loginWithCookie($uid, $token, $oldSessionId) {
|
|
|
|
return self::getUserSession()->loginWithCookie($uid, $token, $oldSessionId);
|
2014-05-21 20:03:37 +04:00
|
|
|
}
|
|
|
|
|
2013-10-01 15:25:58 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Try to login a user, assuming authentication
|
2013-10-02 17:04:42 +04:00
|
|
|
* has already happened (e.g. via Single Sign On).
|
2013-10-01 15:25:58 +04:00
|
|
|
*
|
|
|
|
* Log in a user and regenerate a new session.
|
2013-10-02 17:04:42 +04:00
|
|
|
*
|
2013-10-02 17:11:49 +04:00
|
|
|
* @param \OCP\Authentication\IApacheBackend $backend
|
2013-10-02 17:04:42 +04:00
|
|
|
* @return bool
|
2013-10-01 15:25:58 +04:00
|
|
|
*/
|
2013-10-02 17:11:49 +04:00
|
|
|
public static function loginWithApache(\OCP\Authentication\IApacheBackend $backend) {
|
2013-10-01 15:25:58 +04:00
|
|
|
|
2013-10-02 00:56:47 +04:00
|
|
|
$uid = $backend->getCurrentUserId();
|
2013-10-01 15:25:58 +04:00
|
|
|
$run = true;
|
2015-02-02 18:09:30 +03:00
|
|
|
OC_Hook::emit("OC_User", "pre_login", array("run" => &$run, "uid" => $uid));
|
2013-10-01 15:25:58 +04:00
|
|
|
|
2015-02-02 18:09:30 +03:00
|
|
|
if ($uid) {
|
2015-08-21 18:31:58 +03:00
|
|
|
if (self::getUser() !== $uid) {
|
|
|
|
self::setUserId($uid);
|
2017-02-16 15:23:04 +03:00
|
|
|
$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);
|
|
|
|
}
|
2015-08-21 18:31:58 +03:00
|
|
|
self::getUserSession()->setLoginName($uid);
|
2016-05-31 11:48:14 +03:00
|
|
|
$request = OC::$server->getRequest();
|
|
|
|
self::getUserSession()->createSessionToken($request, $uid, $uid);
|
2016-04-11 11:35:52 +03:00
|
|
|
// setup the filesystem
|
|
|
|
OC_Util::setupFS($uid);
|
2016-05-03 11:41:37 +03:00
|
|
|
// 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' => ''));
|
2016-04-11 11:35:52 +03:00
|
|
|
//trigger creation of user home and /files folder
|
|
|
|
\OC::$server->getUserFolder($uid);
|
2015-08-21 18:31:58 +03:00
|
|
|
}
|
2013-10-01 15:25:58 +04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Verify with Apache whether user is authenticated.
|
2013-10-01 15:25:58 +04:00
|
|
|
*
|
2013-10-02 17:04:42 +04:00
|
|
|
* @return boolean|null
|
|
|
|
* true: authenticated
|
|
|
|
* false: not authenticated
|
|
|
|
* null: not handled / no backend available
|
2013-10-01 15:25:58 +04:00
|
|
|
*/
|
2013-10-02 02:55:35 +04:00
|
|
|
public static function handleApacheAuth() {
|
2013-10-02 17:31:46 +04:00
|
|
|
$backend = self::findFirstActiveUsedBackend();
|
|
|
|
if ($backend) {
|
|
|
|
OC_App::loadApps();
|
2013-10-01 15:25:58 +04:00
|
|
|
|
2013-10-02 17:31:46 +04:00
|
|
|
//setup extra user backends
|
|
|
|
self::setupBackends();
|
|
|
|
self::unsetMagicInCookie();
|
2013-10-01 15:25:58 +04:00
|
|
|
|
2013-10-02 17:31:46 +04:00
|
|
|
return self::loginWithApache($backend);
|
2013-10-01 15:25:58 +04:00
|
|
|
}
|
|
|
|
|
2013-10-02 02:55:35 +04:00
|
|
|
return null;
|
2013-10-01 15:25:58 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2011-09-18 17:05:53 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Sets user id for session and triggers emit
|
2016-04-07 16:39:34 +03:00
|
|
|
*
|
|
|
|
* @param string $uid
|
2011-09-18 17:05:53 +04:00
|
|
|
*/
|
|
|
|
public static function setUserId($uid) {
|
2015-02-02 18:09:30 +03:00
|
|
|
$userSession = \OC::$server->getUserSession();
|
|
|
|
$userManager = \OC::$server->getUserManager();
|
|
|
|
if ($user = $userManager->get($uid)) {
|
|
|
|
$userSession->setUser($user);
|
|
|
|
} else {
|
|
|
|
\OC::$server->getSession()->set('user_id', $uid);
|
|
|
|
}
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-19 20:52:49 +04:00
|
|
|
|
2013-01-29 23:42:21 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Sets user display name for session
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2014-02-06 19:30:58 +04:00
|
|
|
* @param string $uid
|
2016-02-08 18:43:39 +03:00
|
|
|
* @param string $displayName
|
2014-04-21 17:44:54 +04:00
|
|
|
* @return bool Whether the display name could get set
|
2013-01-29 23:42:21 +04:00
|
|
|
*/
|
2013-01-28 17:09:11 +04:00
|
|
|
public static function setDisplayName($uid, $displayName = null) {
|
2013-05-29 02:32:10 +04:00
|
|
|
if (is_null($displayName)) {
|
|
|
|
$displayName = $uid;
|
2013-01-28 17:09:11 +04:00
|
|
|
}
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->setDisplayName($displayName);
|
|
|
|
} else {
|
|
|
|
return false;
|
2013-01-30 01:33:46 +04:00
|
|
|
}
|
2013-01-24 16:07:59 +04:00
|
|
|
}
|
2013-01-29 23:42:21 +04:00
|
|
|
|
2010-04-22 21:03:54 +04:00
|
|
|
/**
|
2014-09-18 18:02:18 +04:00
|
|
|
* Check if the user is logged in, considers also the HTTP basic credentials
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2016-04-07 16:39:34 +03:00
|
|
|
* @deprecated use \OC::$server->getUserSession()->isLoggedIn()
|
2014-05-11 21:05:28 +04:00
|
|
|
* @return bool
|
2010-07-23 01:42:18 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function isLoggedIn() {
|
2016-04-07 16:39:34 +03:00
|
|
|
return \OC::$server->getUserSession()->isLoggedIn();
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-19 20:52:49 +04:00
|
|
|
|
2013-11-22 16:55:38 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* set incognito mode, e.g. if a user wants to open a public link
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-11-22 16:55:38 +04:00
|
|
|
* @param bool $status
|
|
|
|
*/
|
|
|
|
public static function setIncognitoMode($status) {
|
|
|
|
self::$incognitoMode = $status;
|
2014-12-17 23:53:43 +03:00
|
|
|
}
|
2013-11-22 16:55:38 +04:00
|
|
|
|
2014-12-17 23:53:43 +03:00
|
|
|
/**
|
|
|
|
* get incognito mode status
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2014-12-17 23:53:43 +03:00
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public static function isIncognitoMode() {
|
|
|
|
return self::$incognitoMode;
|
2013-11-22 16:55:38 +04:00
|
|
|
}
|
|
|
|
|
2013-10-01 15:25:58 +04:00
|
|
|
/**
|
2013-10-02 17:04:42 +04:00
|
|
|
* Supplies an attribute to the logout hyperlink. The default behaviour
|
2013-10-01 15:25:58 +04:00
|
|
|
* is to return an href with '?logout=true' appended. However, it can
|
|
|
|
* supply any attribute(s) which are valid for <a>.
|
|
|
|
*
|
2013-10-02 17:04:42 +04:00
|
|
|
* @return string with one or more HTML attributes.
|
2013-10-01 15:25:58 +04:00
|
|
|
*/
|
|
|
|
public static function getLogoutAttribute() {
|
2013-10-02 17:31:46 +04:00
|
|
|
$backend = self::findFirstActiveUsedBackend();
|
|
|
|
if ($backend) {
|
|
|
|
return $backend->getLogoutAttribute();
|
2013-10-01 15:25:58 +04:00
|
|
|
}
|
|
|
|
|
2016-04-18 13:14:07 +03:00
|
|
|
$logoutUrl = \OC::$server->getURLGenerator()->linkToRouteAbsolute(
|
|
|
|
'core.login.logout',
|
|
|
|
[
|
|
|
|
'requesttoken' => \OCP\Util::callRegister(),
|
|
|
|
]
|
|
|
|
);
|
|
|
|
|
|
|
|
return 'href="'.$logoutUrl.'"';
|
2013-10-01 15:25:58 +04:00
|
|
|
}
|
|
|
|
|
2013-01-14 22:45:17 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check if the user is an admin user
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $uid uid of the admin
|
|
|
|
* @return bool
|
2013-01-14 22:45:17 +04:00
|
|
|
*/
|
|
|
|
public static function isAdminUser($uid) {
|
2013-11-27 19:52:30 +04:00
|
|
|
if (OC_Group::inGroup($uid, 'admin') && self::$incognitoMode === false) {
|
2013-01-14 22:45:17 +04:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2011-06-22 14:50:57 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* get the user id of the user currently logged in.
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2015-05-21 14:07:54 +03:00
|
|
|
* @return string|bool uid or false
|
2011-06-22 14:50:57 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function getUser() {
|
2014-07-16 21:40:22 +04:00
|
|
|
$uid = \OC::$server->getSession() ? \OC::$server->getSession()->get('user_id') : null;
|
2013-11-22 16:55:38 +04:00
|
|
|
if (!is_null($uid) && self::$incognitoMode === false) {
|
2013-05-29 02:47:55 +04:00
|
|
|
return $uid;
|
2013-05-29 02:32:10 +04:00
|
|
|
} else {
|
2011-06-22 14:50:57 +04:00
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-01-29 23:42:21 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* get the display name of the user currently logged in.
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-06-03 15:15:42 +04:00
|
|
|
* @param string $uid
|
2013-05-31 20:18:13 +04:00
|
|
|
* @return string uid or false
|
2013-01-29 23:42:21 +04:00
|
|
|
*/
|
2013-06-03 15:15:42 +04:00
|
|
|
public static function getDisplayName($uid = null) {
|
|
|
|
if ($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-06-03 15:15:42 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->getDisplayName();
|
|
|
|
} else {
|
|
|
|
return $uid;
|
|
|
|
}
|
2013-05-29 02:32:10 +04:00
|
|
|
} else {
|
|
|
|
$user = self::getUserSession()->getUser();
|
|
|
|
if ($user) {
|
|
|
|
return $user->getDisplayName();
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
2013-01-29 23:42:21 +04:00
|
|
|
}
|
2013-01-24 16:07:59 +04:00
|
|
|
}
|
2013-01-29 23:42:21 +04:00
|
|
|
|
2010-04-22 21:03:54 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Autogenerate a password
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @return string
|
2011-04-18 12:41:01 +04:00
|
|
|
*
|
|
|
|
* generates a password
|
2010-07-23 01:42:18 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function generatePassword() {
|
2016-01-11 22:05:30 +03:00
|
|
|
return \OC::$server->getSecureRandom()->generate(30);
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-19 20:52:49 +04:00
|
|
|
|
2010-04-22 21:03:54 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Set password
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $uid The username
|
|
|
|
* @param string $password The new password
|
|
|
|
* @param string $recoveryPassword for the encryption app to reset encryption keys
|
|
|
|
* @return bool
|
2011-04-18 12:41:01 +04:00
|
|
|
*
|
|
|
|
* Change the password of a user
|
2010-07-23 01:42:18 +04:00
|
|
|
*/
|
2013-05-29 02:32:10 +04:00
|
|
|
public static function setPassword($uid, $password, $recoveryPassword = null) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->setPassword($password, $recoveryPassword);
|
|
|
|
} else {
|
2011-04-18 13:39:29 +04:00
|
|
|
return false;
|
|
|
|
}
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-19 20:52:49 +04:00
|
|
|
|
2013-11-22 16:24:11 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check whether user can change his avatar
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-11-22 16:24:11 +04:00
|
|
|
* @param string $uid The username
|
|
|
|
* @return bool
|
|
|
|
*
|
|
|
|
* Check whether a specified user can change his avatar
|
|
|
|
*/
|
|
|
|
public static function canUserChangeAvatar($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-11-22 16:24:11 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->canChangeAvatar();
|
|
|
|
} else {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-02-05 17:58:35 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check whether user can change his password
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $uid The username
|
|
|
|
* @return bool
|
2013-02-05 17:58:35 +04:00
|
|
|
*
|
|
|
|
* Check whether a specified user can change his password
|
|
|
|
*/
|
|
|
|
public static function canUserChangePassword($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->canChangePassword();
|
|
|
|
} else {
|
|
|
|
return false;
|
2013-02-05 17:58:35 +04:00
|
|
|
}
|
|
|
|
}
|
2013-02-22 20:21:57 +04:00
|
|
|
|
2013-02-06 14:38:03 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check whether user can change his display name
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $uid The username
|
|
|
|
* @return bool
|
2013-02-06 14:38:03 +04:00
|
|
|
*
|
|
|
|
* Check whether a specified user can change his display name
|
|
|
|
*/
|
|
|
|
public static function canUserChangeDisplayName($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->canChangeDisplayName();
|
|
|
|
} else {
|
|
|
|
return false;
|
2013-02-06 14:38:03 +04:00
|
|
|
}
|
|
|
|
}
|
2013-02-05 17:58:35 +04:00
|
|
|
|
2010-04-22 21:03:54 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Check if the password is correct
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $uid The username
|
|
|
|
* @param string $password The password
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return string|false user id a string on success, false otherwise
|
2011-04-18 12:41:01 +04:00
|
|
|
*
|
|
|
|
* Check if the password is correct without logging in the user
|
2012-05-17 02:57:43 +04:00
|
|
|
* returns the user id or false
|
2010-07-23 01:42:18 +04:00
|
|
|
*/
|
2013-05-29 02:32:10 +04:00
|
|
|
public static function checkPassword($uid, $password) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$manager = \OC::$server->getUserManager();
|
2013-09-16 16:15:35 +04:00
|
|
|
$username = $manager->checkPassword($uid, $password);
|
|
|
|
if ($username !== false) {
|
2013-09-25 17:03:22 +04:00
|
|
|
return $username->getUID();
|
2011-06-21 21:28:46 +04:00
|
|
|
}
|
2013-09-16 16:15:35 +04:00
|
|
|
return false;
|
2010-07-21 19:53:51 +04:00
|
|
|
}
|
2010-07-15 21:10:20 +04:00
|
|
|
|
2012-08-26 18:24:25 +04:00
|
|
|
/**
|
2013-01-28 22:08:03 +04:00
|
|
|
* @param string $uid The username
|
2013-05-29 02:32:10 +04:00
|
|
|
* @return string
|
2012-08-26 18:24:25 +04:00
|
|
|
*
|
2012-10-27 17:23:35 +04:00
|
|
|
* returns the path to the users home directory
|
2014-12-04 16:15:55 +03:00
|
|
|
* @deprecated Use \OC::$server->getUserManager->getHome()
|
2012-08-26 18:24:25 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function getHome($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->getHome();
|
|
|
|
} else {
|
2015-12-18 13:42:09 +03:00
|
|
|
return \OC::$server->getSystemConfig()->getValue('datadirectory', OC::$SERVERROOT . '/data') . '/' . $uid;
|
2012-08-26 18:24:25 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-09-15 20:24:14 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Get a list of all users
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2014-05-11 21:13:51 +04:00
|
|
|
* @return array an array of all uids
|
2011-04-18 12:41:01 +04:00
|
|
|
*
|
|
|
|
* Get a list of all users.
|
2014-04-21 17:44:54 +04:00
|
|
|
* @param string $search
|
2014-02-19 12:31:54 +04:00
|
|
|
* @param integer $limit
|
|
|
|
* @param integer $offset
|
2010-09-15 20:24:14 +04:00
|
|
|
*/
|
2012-08-25 02:05:07 +04:00
|
|
|
public static function getUsers($search = '', $limit = null, $offset = null) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$users = \OC::$server->getUserManager()->search($search, $limit, $offset);
|
2013-05-29 02:32:10 +04:00
|
|
|
$uids = array();
|
|
|
|
foreach ($users as $user) {
|
|
|
|
$uids[] = $user->getUID();
|
2011-06-21 21:28:46 +04:00
|
|
|
}
|
2013-05-29 02:32:10 +04:00
|
|
|
return $uids;
|
2011-06-21 21:28:46 +04:00
|
|
|
}
|
|
|
|
|
2013-01-29 23:42:21 +04:00
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Get a list of all users display name
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $search
|
|
|
|
* @param int $limit
|
|
|
|
* @param int $offset
|
|
|
|
* @return array associative array with all display names (value) and corresponding uids (key)
|
2013-01-29 23:42:21 +04:00
|
|
|
*
|
|
|
|
* Get a list of all display names and user ids.
|
2014-12-09 20:36:40 +03:00
|
|
|
* @deprecated Use \OC::$server->getUserManager->searchDisplayName($search, $limit, $offset) instead.
|
2013-01-29 23:42:21 +04:00
|
|
|
*/
|
|
|
|
public static function getDisplayNames($search = '', $limit = null, $offset = null) {
|
|
|
|
$displayNames = array();
|
2015-12-17 15:03:37 +03:00
|
|
|
$users = \OC::$server->getUserManager()->searchDisplayName($search, $limit, $offset);
|
2013-05-29 02:32:10 +04:00
|
|
|
foreach ($users as $user) {
|
|
|
|
$displayNames[$user->getUID()] = $user->getDisplayName();
|
2013-01-29 23:42:21 +04:00
|
|
|
}
|
|
|
|
return $displayNames;
|
2013-01-25 14:05:00 +04:00
|
|
|
}
|
2011-06-21 21:28:46 +04:00
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* check if a user exists
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2011-06-21 21:28:46 +04:00
|
|
|
* @param string $uid the username
|
|
|
|
* @return boolean
|
|
|
|
*/
|
2013-05-29 02:32:10 +04:00
|
|
|
public static function userExists($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
return \OC::$server->getUserManager()->userExists($uid);
|
2010-09-15 20:24:14 +04:00
|
|
|
}
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2012-07-29 20:07:51 +04:00
|
|
|
/**
|
|
|
|
* disables a user
|
2013-05-29 02:32:10 +04:00
|
|
|
*
|
2013-06-03 15:17:03 +04:00
|
|
|
* @param string $uid the user to disable
|
2012-07-29 20:07:51 +04:00
|
|
|
*/
|
2013-06-03 15:17:03 +04:00
|
|
|
public static function disableUser($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
$user->setEnabled(false);
|
2012-09-12 14:47:18 +04:00
|
|
|
}
|
2012-07-29 20:07:51 +04:00
|
|
|
}
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2012-07-29 20:07:51 +04:00
|
|
|
/**
|
|
|
|
* enable a user
|
2013-05-29 02:32:10 +04:00
|
|
|
*
|
2013-06-03 15:17:03 +04:00
|
|
|
* @param string $uid
|
2012-07-29 20:07:51 +04:00
|
|
|
*/
|
2013-06-03 15:17:03 +04:00
|
|
|
public static function enableUser($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
$user->setEnabled(true);
|
2012-09-12 14:47:18 +04:00
|
|
|
}
|
2012-07-29 20:07:51 +04:00
|
|
|
}
|
2012-08-29 10:38:33 +04:00
|
|
|
|
2012-07-29 20:07:51 +04:00
|
|
|
/**
|
|
|
|
* checks if a user is enabled
|
2013-05-29 02:32:10 +04:00
|
|
|
*
|
2013-06-03 15:17:03 +04:00
|
|
|
* @param string $uid
|
2012-07-29 20:07:51 +04:00
|
|
|
* @return bool
|
|
|
|
*/
|
2013-06-03 15:17:03 +04:00
|
|
|
public static function isEnabled($uid) {
|
2015-12-17 15:03:37 +03:00
|
|
|
$user = \OC::$server->getUserManager()->get($uid);
|
2013-05-29 02:32:10 +04:00
|
|
|
if ($user) {
|
|
|
|
return $user->isEnabled();
|
2012-09-12 14:47:18 +04:00
|
|
|
} else {
|
2013-05-29 02:32:10 +04:00
|
|
|
return false;
|
2012-09-12 14:47:18 +04:00
|
|
|
}
|
2012-07-29 20:07:51 +04:00
|
|
|
}
|
2011-07-20 17:04:14 +04:00
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Set cookie value to use in next page load
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2011-07-20 17:04:14 +04:00
|
|
|
* @param string $username username to be set
|
2013-05-29 02:32:10 +04:00
|
|
|
* @param string $token
|
2011-07-20 17:04:14 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function setMagicInCookie($username, $token) {
|
2013-05-29 02:32:10 +04:00
|
|
|
self::getUserSession()->setMagicInCookie($username, $token);
|
2011-07-20 17:04:14 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Remove cookie for "remember username"
|
2011-07-20 17:04:14 +04:00
|
|
|
*/
|
2012-09-07 17:22:01 +04:00
|
|
|
public static function unsetMagicInCookie() {
|
2013-05-29 02:32:10 +04:00
|
|
|
self::getUserSession()->unsetMagicInCookie();
|
2011-07-20 17:04:14 +04:00
|
|
|
}
|
2013-10-02 17:31:46 +04:00
|
|
|
|
|
|
|
/**
|
2014-05-19 19:50:53 +04:00
|
|
|
* Returns the first active backend from self::$_usedBackends.
|
2015-02-02 18:09:30 +03:00
|
|
|
*
|
2014-02-06 19:30:58 +04:00
|
|
|
* @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend
|
2013-10-02 17:31:46 +04:00
|
|
|
*/
|
|
|
|
private static function findFirstActiveUsedBackend() {
|
|
|
|
foreach (self::$_usedBackends as $backend) {
|
|
|
|
if ($backend instanceof OCP\Authentication\IApacheBackend) {
|
|
|
|
if ($backend->isSessionActive()) {
|
|
|
|
return $backend;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return null;
|
|
|
|
}
|
2010-04-22 21:03:54 +04:00
|
|
|
}
|