123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
- * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
- * SPDX-License-Identifier: AGPL-3.0-only
- */
- namespace OC\User;
- use InvalidArgumentException;
- use OCP\AppFramework\Db\TTransactional;
- use OCP\Cache\CappedMemoryCache;
- use OCP\EventDispatcher\IEventDispatcher;
- use OCP\IDBConnection;
- use OCP\Security\Events\ValidatePasswordPolicyEvent;
- use OCP\Security\IHasher;
- use OCP\User\Backend\ABackend;
- use OCP\User\Backend\ICheckPasswordBackend;
- use OCP\User\Backend\ICountUsersBackend;
- use OCP\User\Backend\ICreateUserBackend;
- use OCP\User\Backend\IGetDisplayNameBackend;
- use OCP\User\Backend\IGetHomeBackend;
- use OCP\User\Backend\IGetRealUIDBackend;
- use OCP\User\Backend\IPasswordHashBackend;
- use OCP\User\Backend\ISearchKnownUsersBackend;
- use OCP\User\Backend\ISetDisplayNameBackend;
- use OCP\User\Backend\ISetPasswordBackend;
- /**
- * Class for user management in a SQL Database (e.g. MySQL, SQLite)
- */
- class Database extends ABackend implements
- ICreateUserBackend,
- ISetPasswordBackend,
- ISetDisplayNameBackend,
- IGetDisplayNameBackend,
- ICheckPasswordBackend,
- IGetHomeBackend,
- ICountUsersBackend,
- ISearchKnownUsersBackend,
- IGetRealUIDBackend,
- IPasswordHashBackend {
- /** @var CappedMemoryCache */
- private $cache;
- /** @var IEventDispatcher */
- private $eventDispatcher;
- /** @var IDBConnection */
- private $dbConn;
- /** @var string */
- private $table;
- use TTransactional;
- /**
- * \OC\User\Database constructor.
- *
- * @param IEventDispatcher $eventDispatcher
- * @param string $table
- */
- public function __construct($eventDispatcher = null, $table = 'users') {
- $this->cache = new CappedMemoryCache();
- $this->table = $table;
- $this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OCP\Server::get(IEventDispatcher::class);
- }
- /**
- * FIXME: This function should not be required!
- */
- private function fixDI() {
- if ($this->dbConn === null) {
- $this->dbConn = \OC::$server->getDatabaseConnection();
- }
- }
- /**
- * 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(string $uid, string $password): bool {
- $this->fixDI();
- if (!$this->userExists($uid)) {
- $this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
- return $this->atomic(function () use ($uid, $password) {
- $qb = $this->dbConn->getQueryBuilder();
- $qb->insert($this->table)
- ->values([
- 'uid' => $qb->createNamedParameter($uid),
- 'password' => $qb->createNamedParameter(\OC::$server->get(IHasher::class)->hash($password)),
- 'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
- ]);
- $result = $qb->executeStatement();
- // Clear cache
- unset($this->cache[$uid]);
- // Repopulate the cache
- $this->loadUser($uid);
- return (bool) $result;
- }, $this->dbConn);
- }
- return false;
- }
- /**
- * delete a user
- *
- * @param string $uid The username of the user to delete
- * @return bool
- *
- * Deletes a user
- */
- public function deleteUser($uid) {
- $this->fixDI();
- // Delete user-group-relation
- $query = $this->dbConn->getQueryBuilder();
- $query->delete($this->table)
- ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
- $result = $query->execute();
- if (isset($this->cache[$uid])) {
- unset($this->cache[$uid]);
- }
- return $result ? true : false;
- }
- private function updatePassword(string $uid, string $passwordHash): bool {
- $query = $this->dbConn->getQueryBuilder();
- $query->update($this->table)
- ->set('password', $query->createNamedParameter($passwordHash))
- ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
- $result = $query->execute();
- 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(string $uid, string $password): bool {
- $this->fixDI();
- if ($this->userExists($uid)) {
- $this->eventDispatcher->dispatchTyped(new ValidatePasswordPolicyEvent($password));
- $hasher = \OC::$server->get(IHasher::class);
- $hashedPassword = $hasher->hash($password);
- $return = $this->updatePassword($uid, $hashedPassword);
- if ($return) {
- $this->cache[$uid]['password'] = $hashedPassword;
- }
- return $return;
- }
- return false;
- }
- public function getPasswordHash(string $userId): ?string {
- $this->fixDI();
- if (!$this->userExists($userId)) {
- return null;
- }
- if (!empty($this->cache[$userId]['password'])) {
- return $this->cache[$userId]['password'];
- }
- $qb = $this->dbConn->getQueryBuilder();
- $qb->select('password')
- ->from($this->table)
- ->where($qb->expr()->eq('uid_lower', $qb->createNamedParameter(mb_strtolower($userId))));
- /** @var false|string $hash */
- $hash = $qb->executeQuery()->fetchOne();
- if ($hash === false) {
- return null;
- }
- $this->cache[$userId]['password'] = $hash;
- return $hash;
- }
- public function setPasswordHash(string $userId, string $passwordHash): bool {
- if (!\OCP\Server::get(IHasher::class)->validate($passwordHash)) {
- throw new InvalidArgumentException();
- }
- $this->fixDI();
- $result = $this->updatePassword($userId, $passwordHash);
- if (!$result) {
- return false;
- }
- $this->cache[$userId]['password'] = $passwordHash;
- return true;
- }
- /**
- * Set display name
- *
- * @param string $uid The username
- * @param string $displayName The new display name
- * @return bool
- *
- * @throws \InvalidArgumentException
- *
- * Change the display name of a user
- */
- public function setDisplayName(string $uid, string $displayName): bool {
- if (mb_strlen($displayName) > 64) {
- throw new \InvalidArgumentException('Invalid displayname');
- }
- $this->fixDI();
- if ($this->userExists($uid)) {
- $query = $this->dbConn->getQueryBuilder();
- $query->update($this->table)
- ->set('displayname', $query->createNamedParameter($displayName))
- ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
- $query->execute();
- $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): string {
- $uid = (string)$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 int|null $limit
- * @param int|null $offset
- * @return array an array of all displayNames (value) and the corresponding uids (key)
- */
- public function getDisplayNames($search = '', $limit = null, $offset = null) {
- $limit = $this->fixLimit($limit);
- $this->fixDI();
- $query = $this->dbConn->getQueryBuilder();
- $query->select('uid', 'displayname')
- ->from($this->table, 'u')
- ->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
- $query->expr()->eq('userid', 'uid'),
- $query->expr()->eq('appid', $query->expr()->literal('settings')),
- $query->expr()->eq('configkey', $query->expr()->literal('email')))
- )
- // sqlite doesn't like re-using a single named parameter here
- ->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
- ->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
- ->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
- ->orderBy($query->func()->lower('displayname'), 'ASC')
- ->addOrderBy('uid_lower', 'ASC')
- ->setMaxResults($limit)
- ->setFirstResult($offset);
- $result = $query->executeQuery();
- $displayNames = [];
- while ($row = $result->fetch()) {
- $displayNames[(string)$row['uid']] = (string)$row['displayname'];
- }
- return $displayNames;
- }
- /**
- * @param string $searcher
- * @param string $pattern
- * @param int|null $limit
- * @param int|null $offset
- * @return array
- * @since 21.0.1
- */
- public function searchKnownUsersByDisplayName(string $searcher, string $pattern, ?int $limit = null, ?int $offset = null): array {
- $limit = $this->fixLimit($limit);
- $this->fixDI();
- $query = $this->dbConn->getQueryBuilder();
- $query->select('u.uid', 'u.displayname')
- ->from($this->table, 'u')
- ->leftJoin('u', 'known_users', 'k', $query->expr()->andX(
- $query->expr()->eq('k.known_user', 'u.uid'),
- $query->expr()->eq('k.known_to', $query->createNamedParameter($searcher))
- ))
- ->where($query->expr()->eq('k.known_to', $query->createNamedParameter($searcher)))
- ->andWhere($query->expr()->orX(
- $query->expr()->iLike('u.uid', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($pattern) . '%')),
- $query->expr()->iLike('u.displayname', $query->createNamedParameter('%' . $this->dbConn->escapeLikeParameter($pattern) . '%'))
- ))
- ->orderBy('u.displayname', 'ASC')
- ->addOrderBy('u.uid_lower', 'ASC')
- ->setMaxResults($limit)
- ->setFirstResult($offset);
- $result = $query->execute();
- $displayNames = [];
- while ($row = $result->fetch()) {
- $displayNames[(string)$row['uid']] = (string)$row['displayname'];
- }
- return $displayNames;
- }
- /**
- * Check if the password is correct
- *
- * @param string $loginName The loginname
- * @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(string $loginName, string $password) {
- $found = $this->loadUser($loginName);
- if ($found && is_array($this->cache[$loginName])) {
- $storedHash = $this->cache[$loginName]['password'];
- $newHash = '';
- if (\OC::$server->get(IHasher::class)->verify($password, $storedHash, $newHash)) {
- if (!empty($newHash)) {
- $this->updatePassword($loginName, $newHash);
- }
- return (string)$this->cache[$loginName]['uid'];
- }
- }
- return false;
- }
- /**
- * Load an user in the cache
- *
- * @param string $uid the username
- * @return boolean true if user was found, false otherwise
- */
- private function loadUser($uid) {
- $this->fixDI();
- $uid = (string)$uid;
- if (!isset($this->cache[$uid])) {
- //guests $uid could be NULL or ''
- if ($uid === '') {
- $this->cache[$uid] = false;
- return true;
- }
- $qb = $this->dbConn->getQueryBuilder();
- $qb->select('uid', 'displayname', 'password')
- ->from($this->table)
- ->where(
- $qb->expr()->eq(
- 'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
- )
- );
- $result = $qb->execute();
- $row = $result->fetch();
- $result->closeCursor();
- // "uid" is primary key, so there can only be a single result
- if ($row !== false) {
- $this->cache[$uid] = [
- 'uid' => (string)$row['uid'],
- 'displayname' => (string)$row['displayname'],
- 'password' => (string)$row['password'],
- ];
- } else {
- $this->cache[$uid] = false;
- return false;
- }
- }
- 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) {
- $limit = $this->fixLimit($limit);
- $users = $this->getDisplayNames($search, $limit, $offset);
- $userIds = array_map(function ($uid) {
- return (string)$uid;
- }, array_keys($users));
- sort($userIds, SORT_STRING | SORT_FLAG_CASE);
- return $userIds;
- }
- /**
- * check if a user exists
- *
- * @param string $uid the username
- * @return boolean
- */
- public function userExists($uid) {
- $this->loadUser($uid);
- return $this->cache[$uid] !== false;
- }
- /**
- * get the user's home directory
- *
- * @param string $uid the username
- * @return string|false
- */
- public function getHome(string $uid) {
- if ($this->userExists($uid)) {
- return \OC::$server->getConfig()->getSystemValueString('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
- }
- return false;
- }
- /**
- * @return bool
- */
- public function hasUserListings() {
- return true;
- }
- /**
- * counts the users in the database
- *
- * @return int|false
- */
- public function countUsers() {
- $this->fixDI();
- $query = $this->dbConn->getQueryBuilder();
- $query->select($query->func()->count('uid'))
- ->from($this->table);
- $result = $query->executeQuery();
- 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 Database) {
- /** @var \OC\User\Database $backend */
- $uid = $backend->loginName2UserName($param['uid']);
- if ($uid !== false) {
- $param['uid'] = $uid;
- return;
- }
- }
- }
- }
- public function getRealUID(string $uid): string {
- if (!$this->userExists($uid)) {
- throw new \RuntimeException($uid . ' does not exist');
- }
- return $this->cache[$uid]['uid'];
- }
- private function fixLimit($limit) {
- if (is_int($limit) && $limit >= 0) {
- return $limit;
- }
- return null;
- }
- }
|