288 lines
7.7 KiB
PHP
288 lines
7.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* ownCloud
|
|
*
|
|
* @author Frank Karlitschek
|
|
* @copyright 2012 Frank Karlitschek frank@owncloud.org
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or any later version.
|
|
*
|
|
* This library 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 along with this library. 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;
|
|
*
|
|
*/
|
|
|
|
require_once 'phpass/PasswordHash.php';
|
|
|
|
/**
|
|
* Class for user management in a SQL Database (e.g. MySQL, SQLite)
|
|
*/
|
|
class OC_User_Database extends OC_User_Backend {
|
|
/**
|
|
* @var PasswordHash
|
|
*/
|
|
private static $hasher = null;
|
|
|
|
private $cache = array();
|
|
|
|
private function getHasher() {
|
|
if (!self::$hasher) {
|
|
//we don't want to use DES based crypt(), since it doesn't return a hash with a recognisable prefix
|
|
$forcePortable = (CRYPT_BLOWFISH != 1);
|
|
self::$hasher = new PasswordHash(8, $forcePortable);
|
|
}
|
|
return self::$hasher;
|
|
}
|
|
|
|
/**
|
|
* @brief 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)) {
|
|
$hasher = $this->getHasher();
|
|
$hash = $hasher->HashPassword($password . OC_Config::getValue('passwordsalt', ''));
|
|
$query = OC_DB::prepare('INSERT INTO `*PREFIX*users` ( `uid`, `password` ) VALUES( ?, ? )');
|
|
$result = $query->execute(array($uid, $hash));
|
|
|
|
return $result ? true : false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief 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;
|
|
}
|
|
|
|
/**
|
|
* @brief 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)) {
|
|
$hasher = $this->getHasher();
|
|
$hash = $hasher->HashPassword($password . OC_Config::getValue('passwordsalt', ''));
|
|
$query = OC_DB::prepare('UPDATE `*PREFIX*users` SET `password` = ? WHERE `uid` = ?');
|
|
$result = $query->execute(array($hash, $uid));
|
|
|
|
return $result ? true : false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief 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;
|
|
}
|
|
|
|
/**
|
|
* @brief 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'];
|
|
}
|
|
|
|
/**
|
|
* @brief Get a list of all display names
|
|
* @return array an array of all displayNames (value) and the correspondig uids (key)
|
|
*
|
|
* Get a list of all display names and user ids.
|
|
*/
|
|
public function getDisplayNames($search = '', $limit = null, $offset = null) {
|
|
$displayNames = array();
|
|
$query = OC_DB::prepare('SELECT `uid`, `displayname` FROM `*PREFIX*users`'
|
|
. ' WHERE LOWER(`displayname`) LIKE LOWER(?) OR '
|
|
. 'LOWER(`uid`) LIKE LOWER(?)', $limit, $offset);
|
|
$result = $query->execute(array($search . '%', $search . '%'));
|
|
$users = array();
|
|
while ($row = $result->fetchRow()) {
|
|
$displayNames[$row['uid']] = $row['displayname'];
|
|
}
|
|
|
|
return $displayNames;
|
|
}
|
|
|
|
/**
|
|
* @brief 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'];
|
|
if ($storedHash[0] === '$') { //the new phpass based hashing
|
|
$hasher = $this->getHasher();
|
|
if ($hasher->CheckPassword($password . OC_Config::getValue('passwordsalt', ''), $storedHash)) {
|
|
return $row['uid'];
|
|
}
|
|
|
|
//old sha1 based hashing
|
|
} elseif (sha1($password) === $storedHash) {
|
|
//upgrade to new hashing
|
|
$this->setPassword($row['uid'], $password);
|
|
return $row['uid'];
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief 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 (OC_DB::isError($result)) {
|
|
OC_Log::write('core', OC_DB::getErrorMessage($result), OC_Log::ERROR);
|
|
return false;
|
|
}
|
|
|
|
while ($row = $result->fetchRow()) {
|
|
$this->cache[$uid]['uid'] = $row['uid'];
|
|
$this->cache[$uid]['displayname'] = $row['displayname'];
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @brief Get a list of all users
|
|
* @return array an array of all uids
|
|
*
|
|
* Get a list of all users.
|
|
*/
|
|
public function getUsers($search = '', $limit = null, $offset = null) {
|
|
$query = OC_DB::prepare('SELECT `uid` FROM `*PREFIX*users` WHERE LOWER(`uid`) LIKE LOWER(?)', $limit, $offset);
|
|
$result = $query->execute(array($search . '%'));
|
|
$users = array();
|
|
while ($row = $result->fetchRow()) {
|
|
$users[] = $row['uid'];
|
|
}
|
|
return $users;
|
|
}
|
|
|
|
/**
|
|
* @brief check if a user exists
|
|
* @param string $uid the username
|
|
* @return boolean
|
|
*/
|
|
public function userExists($uid) {
|
|
$this->loadUser($uid);
|
|
return !empty($this->cache[$uid]);
|
|
}
|
|
|
|
/**
|
|
* @brief get the user's home directory
|
|
* @param string $uid the username
|
|
* @return string|false
|
|
*/
|
|
public function getHome($uid) {
|
|
if ($this->userExists($uid)) {
|
|
return OC_Config::getValue("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 (OC_DB::isError($result)) {
|
|
OC_Log::write('core', OC_DB::getErrorMessage($result), OC_Log::ERROR);
|
|
return false;
|
|
}
|
|
return $result->fetchOne();
|
|
}
|
|
|
|
}
|