diff options
author | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-04 07:49:22 +0200 |
---|---|---|
committer | Roeland Jago Douma <rullzer@owncloud.com> | 2016-05-10 19:53:36 +0200 |
commit | c51ebb02fa702456d0d470c05a260d68e3d4bb0e (patch) | |
tree | db74fafb97e652212ca276f98d866509d552042e /lib/private/user | |
parent | 0543f8a8393f1837f5988606dcf303ceb53ad73a (diff) | |
download | nextcloud-server-c51ebb02fa702456d0d470c05a260d68e3d4bb0e.tar.gz nextcloud-server-c51ebb02fa702456d0d470c05a260d68e3d4bb0e.zip |
Move OC_User_XX to legacy folder
Diffstat (limited to 'lib/private/user')
-rw-r--r-- | lib/private/user/backend.php | 198 | ||||
-rw-r--r-- | lib/private/user/database.php | 347 | ||||
-rw-r--r-- | lib/private/user/interface.php | 28 |
3 files changed, 0 insertions, 573 deletions
diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php deleted file mode 100644 index 2bb1df4d6b3..00000000000 --- a/lib/private/user/backend.php +++ /dev/null @@ -1,198 +0,0 @@ -<?php -/** - * @author Aldo "xoen" Giambelluca <xoen@xoen.org> - * @author Bart Visscher <bartv@thisnet.nl> - * @author Björn Schießle <schiessle@owncloud.com> - * @author Dominik Schmidt <dev@dominik-schmidt.de> - * @author Georg Ehrke <georg@owncloud.com> - * @author Jakob Sack <mail@jakobsack.de> - * @author Joas Schilling <nickvergessen@owncloud.com> - * @author Jörn Friedrich Dreyer <jfd@butonic.de> - * @author Lukas Reschke <lukas@owncloud.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <icewind@owncloud.com> - * @author Sam Tuke <mail@samtuke.com> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * @author Tigran Mkrtchyan <tigran.mkrtchyan@desy.de> - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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/> - * - */ - -/** - * error code for functions not provided by the user backend - * @deprecated Use \OC_User_Backend::NOT_IMPLEMENTED instead - */ -define('OC_USER_BACKEND_NOT_IMPLEMENTED', -501); - -/** - * actions that user backends can define - */ -/** @deprecated Use \OC_User_Backend::CREATE_USER instead */ -define('OC_USER_BACKEND_CREATE_USER', 1 << 0); -/** @deprecated Use \OC_User_Backend::SET_PASSWORD instead */ -define('OC_USER_BACKEND_SET_PASSWORD', 1 << 4); -/** @deprecated Use \OC_User_Backend::CHECK_PASSWORD instead */ -define('OC_USER_BACKEND_CHECK_PASSWORD', 1 << 8); -/** @deprecated Use \OC_User_Backend::GET_HOME instead */ -define('OC_USER_BACKEND_GET_HOME', 1 << 12); -/** @deprecated Use \OC_User_Backend::GET_DISPLAYNAME instead */ -define('OC_USER_BACKEND_GET_DISPLAYNAME', 1 << 16); -/** @deprecated Use \OC_User_Backend::SET_DISPLAYNAME instead */ -define('OC_USER_BACKEND_SET_DISPLAYNAME', 1 << 20); -/** @deprecated Use \OC_User_Backend::PROVIDE_AVATAR instead */ -define('OC_USER_BACKEND_PROVIDE_AVATAR', 1 << 24); -/** @deprecated Use \OC_User_Backend::COUNT_USERS instead */ -define('OC_USER_BACKEND_COUNT_USERS', 1 << 28); - -/** - * Abstract base class for user management. Provides methods for querying backend - * capabilities. - */ -abstract class OC_User_Backend implements \OCP\UserInterface { - /** - * error code for functions not provided by the user backend - */ - const NOT_IMPLEMENTED = -501; - - /** - * actions that user backends can define - */ - const CREATE_USER = 1; // 1 << 0 - const SET_PASSWORD = 16; // 1 << 4 - const CHECK_PASSWORD = 256; // 1 << 8 - const GET_HOME = 4096; // 1 << 12 - const GET_DISPLAYNAME = 65536; // 1 << 16 - const SET_DISPLAYNAME = 1048576; // 1 << 20 - const PROVIDE_AVATAR = 16777216; // 1 << 24 - const COUNT_USERS = 268435456; // 1 << 28 - - protected $possibleActions = array( - self::CREATE_USER => 'createUser', - self::SET_PASSWORD => 'setPassword', - self::CHECK_PASSWORD => 'checkPassword', - self::GET_HOME => 'getHome', - self::GET_DISPLAYNAME => 'getDisplayName', - self::SET_DISPLAYNAME => 'setDisplayName', - self::PROVIDE_AVATAR => 'canChangeAvatar', - self::COUNT_USERS => 'countUsers', - ); - - /** - * Get all supported actions - * @return int bitwise-or'ed actions - * - * Returns the supported actions as int to be - * compared with self::CREATE_USER etc. - */ - public function getSupportedActions() { - $actions = 0; - foreach($this->possibleActions AS $action => $methodName) { - if(method_exists($this, $methodName)) { - $actions |= $action; - } - } - - return $actions; - } - - /** - * Check if backend implements actions - * @param int $actions bitwise-or'ed actions - * @return boolean - * - * Returns the supported actions as int to be - * compared with self::CREATE_USER etc. - */ - public function implementsActions($actions) { - return (bool)($this->getSupportedActions() & $actions); - } - - /** - * delete a user - * @param string $uid The username of the user to delete - * @return bool - * - * Deletes a user - */ - public function deleteUser( $uid ) { - return false; - } - - /** - * Get a list of all users - * - * @param string $search - * @param null|int $limit - * @param null|int $offset - * @return string[] an array of all uids - */ - public function getUsers($search = '', $limit = null, $offset = null) { - return array(); - } - - /** - * check if a user exists - * @param string $uid the username - * @return boolean - */ - public function userExists($uid) { - return false; - } - - /** - * get the user's home directory - * @param string $uid the username - * @return boolean - */ - public function getHome($uid) { - return false; - } - - /** - * get display name of the user - * @param string $uid user ID of the user - * @return string display name - */ - public function getDisplayName($uid) { - return $uid; - } - - /** - * Get a list of all display names and user ids. - * - * @param string $search - * @param string|null $limit - * @param string|null $offset - * @return array an array of all displayNames (value) and the corresponding uids (key) - */ - public function getDisplayNames($search = '', $limit = null, $offset = null) { - $displayNames = array(); - $users = $this->getUsers($search, $limit, $offset); - foreach ( $users as $user) { - $displayNames[$user] = $user; - } - return $displayNames; - } - - /** - * Check if a user list is available or not - * @return boolean if users can be listed or not - */ - public function hasUserListings() { - return false; - } -} diff --git a/lib/private/user/database.php b/lib/private/user/database.php deleted file mode 100644 index fd273055ae1..00000000000 --- a/lib/private/user/database.php +++ /dev/null @@ -1,347 +0,0 @@ -<?php -/** - * @author adrien <adrien.waksberg@believedigital.com> - * @author Aldo "xoen" Giambelluca <xoen@xoen.org> - * @author Arthur Schiwon <blizzz@owncloud.com> - * @author Bart Visscher <bartv@thisnet.nl> - * @author Björn Schießle <schiessle@owncloud.com> - * @author fabian <fabian@web2.0-apps.de> - * @author Georg Ehrke <georg@owncloud.com> - * @author Jakob Sack <mail@jakobsack.de> - * @author Joas Schilling <nickvergessen@owncloud.com> - * @author Jörn Friedrich Dreyer <jfd@butonic.de> - * @author Lukas Reschke <lukas@owncloud.com> - * @author Michael Gapczynski <GapczynskiM@gmail.com> - * @author Morris Jobke <hey@morrisjobke.de> - * @author nishiki <nishiki@yaegashi.fr> - * @author Robin Appelman <icewind@owncloud.com> - * @author Robin McCorkell <robin@mccorkell.me.uk> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * @author Victor Dubiniuk <dubiniuk@owncloud.com> - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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/> - * - */ -/* - * - * The following SQL statement is just a help for developers and will not be - * executed! - * - * CREATE TABLE `users` ( - * `uid` varchar(64) COLLATE utf8_unicode_ci NOT NULL, - * `password` varchar(255) COLLATE utf8_unicode_ci NOT NULL, - * PRIMARY KEY (`uid`) - * ) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; - * - */ - -use OC\Cache\CappedMemoryCache; - -/** - * Class for user management in a SQL Database (e.g. MySQL, SQLite) - */ -class OC_User_Database extends OC_User_Backend implements \OCP\IUserBackend { - /** @var CappedMemoryCache */ - private $cache; - - /** - * OC_User_Database constructor. - */ - public function __construct() { - $this->cache = new CappedMemoryCache(); - } - - /** - * Create a new user - * @param string $uid The username of the user to create - * @param string $password The password of the new user - * @return bool - * - * Creates a new user. Basic checking of username is done in OC_User - * itself, not in its subclasses. - */ - public function createUser($uid, $password) { - if (!$this->userExists($uid)) { - $query = OC_DB::prepare('INSERT INTO `*PREFIX*users` ( `uid`, `password` ) VALUES( ?, ? )'); - $result = $query->execute(array($uid, \OC::$server->getHasher()->hash($password))); - - return $result ? true : false; - } - - return false; - } - - /** - * delete a user - * @param string $uid The username of the user to delete - * @return bool - * - * Deletes a user - */ - public function deleteUser($uid) { - // Delete user-group-relation - $query = OC_DB::prepare('DELETE FROM `*PREFIX*users` WHERE `uid` = ?'); - $result = $query->execute(array($uid)); - - if (isset($this->cache[$uid])) { - unset($this->cache[$uid]); - } - - return $result ? true : false; - } - - /** - * Set password - * @param string $uid The username - * @param string $password The new password - * @return bool - * - * Change the password of a user - */ - public function setPassword($uid, $password) { - if ($this->userExists($uid)) { - $query = OC_DB::prepare('UPDATE `*PREFIX*users` SET `password` = ? WHERE `uid` = ?'); - $result = $query->execute(array(\OC::$server->getHasher()->hash($password), $uid)); - - return $result ? true : false; - } - - return false; - } - - /** - * Set display name - * @param string $uid The username - * @param string $displayName The new display name - * @return bool - * - * Change the display name of a user - */ - public function setDisplayName($uid, $displayName) { - if ($this->userExists($uid)) { - $query = OC_DB::prepare('UPDATE `*PREFIX*users` SET `displayname` = ? WHERE LOWER(`uid`) = LOWER(?)'); - $query->execute(array($displayName, $uid)); - $this->cache[$uid]['displayname'] = $displayName; - - return true; - } - - return false; - } - - /** - * get display name of the user - * @param string $uid user ID of the user - * @return string display name - */ - public function getDisplayName($uid) { - $this->loadUser($uid); - return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname']; - } - - /** - * Get a list of all display names and user ids. - * - * @param string $search - * @param string|null $limit - * @param string|null $offset - * @return array an array of all displayNames (value) and the corresponding uids (key) - */ - public function getDisplayNames($search = '', $limit = null, $offset = null) { - $parameters = []; - $searchLike = ''; - if ($search !== '') { - $parameters[] = '%' . $search . '%'; - $parameters[] = '%' . $search . '%'; - $searchLike = ' WHERE LOWER(`displayname`) LIKE LOWER(?) OR ' - . 'LOWER(`uid`) LIKE LOWER(?)'; - } - - $displayNames = array(); - $query = OC_DB::prepare('SELECT `uid`, `displayname` FROM `*PREFIX*users`' - . $searchLike .' ORDER BY `uid` ASC', $limit, $offset); - $result = $query->execute($parameters); - while ($row = $result->fetchRow()) { - $displayNames[$row['uid']] = $row['displayname']; - } - - return $displayNames; - } - - /** - * Check if the password is correct - * @param string $uid The username - * @param string $password The password - * @return string - * - * Check if the password is correct without logging in the user - * returns the user id or false - */ - public function checkPassword($uid, $password) { - $query = OC_DB::prepare('SELECT `uid`, `password` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)'); - $result = $query->execute(array($uid)); - - $row = $result->fetchRow(); - if ($row) { - $storedHash = $row['password']; - $newHash = ''; - if(\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) { - if(!empty($newHash)) { - $this->setPassword($uid, $password); - } - return $row['uid']; - } - - } - - return false; - } - - /** - * Load an user in the cache - * @param string $uid the username - * @return boolean - */ - private function loadUser($uid) { - if (empty($this->cache[$uid])) { - $query = OC_DB::prepare('SELECT `uid`, `displayname` FROM `*PREFIX*users` WHERE LOWER(`uid`) = LOWER(?)'); - $result = $query->execute(array($uid)); - - if ($result === false) { - \OCP\Util::writeLog('core', OC_DB::getErrorMessage(), \OCP\Util::ERROR); - return false; - } - - while ($row = $result->fetchRow()) { - $this->cache[$uid]['uid'] = $row['uid']; - $this->cache[$uid]['displayname'] = $row['displayname']; - } - } - - return true; - } - - /** - * Get a list of all users - * - * @param string $search - * @param null|int $limit - * @param null|int $offset - * @return string[] an array of all uids - */ - public function getUsers($search = '', $limit = null, $offset = null) { - $parameters = []; - $searchLike = ''; - if ($search !== '') { - $parameters[] = '%' . $search . '%'; - $searchLike = ' WHERE LOWER(`uid`) LIKE LOWER(?)'; - } - - $query = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*users`' . $searchLike . ' ORDER BY `uid` ASC', $limit, $offset); - $result = $query->execute($parameters); - $users = array(); - while ($row = $result->fetchRow()) { - $users[] = $row['uid']; - } - return $users; - } - - /** - * check if a user exists - * @param string $uid the username - * @return boolean - */ - public function userExists($uid) { - $this->loadUser($uid); - return !empty($this->cache[$uid]); - } - - /** - * get the user's home directory - * @param string $uid the username - * @return string|false - */ - public function getHome($uid) { - if ($this->userExists($uid)) { - return \OC::$server->getConfig()->getSystemValue("datadirectory", OC::$SERVERROOT . "/data") . '/' . $uid; - } - - return false; - } - - /** - * @return bool - */ - public function hasUserListings() { - return true; - } - - /** - * counts the users in the database - * - * @return int|bool - */ - public function countUsers() { - $query = OC_DB::prepare('SELECT COUNT(*) FROM `*PREFIX*users`'); - $result = $query->execute(); - if ($result === false) { - \OCP\Util::writeLog('core', OC_DB::getErrorMessage(), \OCP\Util::ERROR); - return false; - } - return $result->fetchOne(); - } - - /** - * returns the username for the given login name in the correct casing - * - * @param string $loginName - * @return string|false - */ - public function loginName2UserName($loginName) { - if ($this->userExists($loginName)) { - return $this->cache[$loginName]['uid']; - } - - return false; - } - - /** - * Backend name to be shown in user management - * @return string the name of the backend to be shown - */ - public function getBackendName(){ - return 'Database'; - } - - public static function preLoginNameUsedAsUserName($param) { - if(!isset($param['uid'])) { - throw new \Exception('key uid is expected to be set in $param'); - } - - $backends = \OC::$server->getUserManager()->getBackends(); - foreach ($backends as $backend) { - if ($backend instanceof \OC_User_Database) { - /** @var \OC_User_Database $backend */ - $uid = $backend->loginName2UserName($param['uid']); - if ($uid !== false) { - $param['uid'] = $uid; - return; - } - } - } - - } -} diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php deleted file mode 100644 index d2868a79c2c..00000000000 --- a/lib/private/user/interface.php +++ /dev/null @@ -1,28 +0,0 @@ -<?php -/** - * @author Arthur Schiwon <blizzz@owncloud.com> - * @author Jörn Friedrich Dreyer <jfd@butonic.de> - * @author Morris Jobke <hey@morrisjobke.de> - * - * @copyright Copyright (c) 2016, ownCloud, Inc. - * @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/> - * - */ - -/** - * Interface OC_User_Interface - * @deprecated use the public \OCP\UserInterface instead - */ -interface OC_User_Interface extends \OCP\UserInterface {} |