nextcloud / server

lib/private/User/Database.php

Indentation +421 added lines, -421 removed lines

@@ -75,425 +75,425 @@
  * Class for user management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend
-	implements ICreateUserBackend,
-	           ISetPasswordBackend,
-	           ISetDisplayNameBackend,
-	           IGetDisplayNameBackend,
-	           ICheckPasswordBackend,
-	           IGetHomeBackend,
-	           ICountUsersBackend,
-	           IGetRealUIDBackend {
-	/** @var CappedMemoryCache */
-	private $cache;
-
-	/** @var EventDispatcherInterface */
-	private $eventDispatcher;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/** @var string */
-	private $table;
-
-	/**
-	 * \OC\User\Database constructor.
-	 *
-	 * @param EventDispatcherInterface $eventDispatcher
-	 * @param string $table
-	 */
-	public function __construct($eventDispatcher = null, $table = 'users') {
-		$this->cache = new CappedMemoryCache();
-		$this->table = $table;
-		$this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
-	}
-
-	/**
-	 * 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)) {
-			$event = new GenericEvent($password);
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
-
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert($this->table)
-				->values([
-					'uid' => $qb->createNamedParameter($uid),
-					'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
-					'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
-				]);
-
-			$result = $qb->execute();
-
-			// Clear cache
-			unset($this->cache[$uid]);
-
-			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) {
-		$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)) {
-			$event = new GenericEvent($password);
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
-
-			$hasher = \OC::$server->getHasher();
-			$hashedPassword = $hasher->hash($password);
-
-			return $this->updatePassword($uid, $hashedPassword);
-		}
-
-		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(string $uid, string $displayName): bool {
-		$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 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) {
-		$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')
-			->orderBy('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 $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(string $uid, string $password) {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->select('uid', 'password')
-			->from($this->table)
-			->where(
-				$qb->expr()->eq(
-					'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
-				)
-			);
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$storedHash = $row['password'];
-			$newHash = '';
-			if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
-				if (!empty($newHash)) {
-					$this->updatePassword($uid, $newHash);
-				}
-				return (string)$row['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')
-				->from($this->table)
-				->where(
-					$qb->expr()->eq(
-						'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
-					)
-				);
-			$result = $qb->execute();
-			$row = $result->fetch();
-			$result->closeCursor();
-
-			$this->cache[$uid] = false;
-
-			// "uid" is primary key, so there can only be a single result
-			if ($row !== false) {
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
-			} else {
-				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()->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() {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('uid'))
-			->from($this->table);
-		$result = $query->execute();
-
-		return $result->fetchColumn();
-	}
-
-	/**
-	 * 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;
-	}
+    implements ICreateUserBackend,
+                ISetPasswordBackend,
+                ISetDisplayNameBackend,
+                IGetDisplayNameBackend,
+                ICheckPasswordBackend,
+                IGetHomeBackend,
+                ICountUsersBackend,
+                IGetRealUIDBackend {
+    /** @var CappedMemoryCache */
+    private $cache;
+
+    /** @var EventDispatcherInterface */
+    private $eventDispatcher;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /** @var string */
+    private $table;
+
+    /**
+     * \OC\User\Database constructor.
+     *
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param string $table
+     */
+    public function __construct($eventDispatcher = null, $table = 'users') {
+        $this->cache = new CappedMemoryCache();
+        $this->table = $table;
+        $this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
+    }
+
+    /**
+     * 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)) {
+            $event = new GenericEvent($password);
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
+
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert($this->table)
+                ->values([
+                    'uid' => $qb->createNamedParameter($uid),
+                    'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
+                    'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
+                ]);
+
+            $result = $qb->execute();
+
+            // Clear cache
+            unset($this->cache[$uid]);
+
+            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) {
+        $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)) {
+            $event = new GenericEvent($password);
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
+
+            $hasher = \OC::$server->getHasher();
+            $hashedPassword = $hasher->hash($password);
+
+            return $this->updatePassword($uid, $hashedPassword);
+        }
+
+        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(string $uid, string $displayName): bool {
+        $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 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) {
+        $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')
+            ->orderBy('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 $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(string $uid, string $password) {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->select('uid', 'password')
+            ->from($this->table)
+            ->where(
+                $qb->expr()->eq(
+                    'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
+                )
+            );
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $storedHash = $row['password'];
+            $newHash = '';
+            if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
+                if (!empty($newHash)) {
+                    $this->updatePassword($uid, $newHash);
+                }
+                return (string)$row['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')
+                ->from($this->table)
+                ->where(
+                    $qb->expr()->eq(
+                        'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
+                    )
+                );
+            $result = $qb->execute();
+            $row = $result->fetch();
+            $result->closeCursor();
+
+            $this->cache[$uid] = false;
+
+            // "uid" is primary key, so there can only be a single result
+            if ($row !== false) {
+                $this->cache[$uid]['uid'] = (string)$row['uid'];
+                $this->cache[$uid]['displayname'] = (string)$row['displayname'];
+            } else {
+                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()->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() {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('uid'))
+            ->from($this->table);
+        $result = $query->execute();
+
+        return $result->fetchColumn();
+    }
+
+    /**
+     * 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;
+    }
 }