nextcloud-server/lib/private/Authentication/TwoFactorAuth/Db/ProviderUserAssignmentDao.php

<?php

declare(strict_types=1);

/**
 * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
 *
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 *
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * 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
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 */
namespace OC\Authentication\TwoFactorAuth\Db;

use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IDBConnection;
use function array_map;

/**
 * Data access object to query and assign (provider_id, uid, enabled) tuples of
 * 2FA providers
 */
class ProviderUserAssignmentDao {
	public const TABLE_NAME = 'twofactor_providers';

	/** @var IDBConnection */
	private $conn;

	public function __construct(IDBConnection $dbConn) {
		$this->conn = $dbConn;
	}

	/**
	 * Get all assigned provider IDs for the given user ID
	 *
	 * @return array<string, bool> where the array key is the provider ID (string) and the
	 *                  value is the enabled state (bool)
	 */
	public function getState(string $uid): array {
		$qb = $this->conn->getQueryBuilder();

		$query = $qb->select('provider_id', 'enabled')
			->from(self::TABLE_NAME)
			->where($qb->expr()->eq('uid', $qb->createNamedParameter($uid)));
		$result = $query->execute();
		$providers = [];
		foreach ($result->fetchAll() as $row) {
			$providers[(string)$row['provider_id']] = 1 === (int)$row['enabled'];
		}
		$result->closeCursor();

		return $providers;
	}

	/**
	 * Persist a new/updated (provider_id, uid, enabled) tuple
	 */
	public function persist(string $providerId, string $uid, int $enabled): void {
		$qb = $this->conn->getQueryBuilder();

		try {
			// Insert a new entry
			$insertQuery = $qb->insert(self::TABLE_NAME)->values([
				'provider_id' => $qb->createNamedParameter($providerId),
				'uid' => $qb->createNamedParameter($uid),
				'enabled' => $qb->createNamedParameter($enabled, IQueryBuilder::PARAM_INT),
			]);

			$insertQuery->execute();
		} catch (UniqueConstraintViolationException $ex) {
			// There is already an entry -> update it
			$updateQuery = $qb->update(self::TABLE_NAME)
				->set('enabled', $qb->createNamedParameter($enabled))
				->where($qb->expr()->eq('provider_id', $qb->createNamedParameter($providerId)))
				->andWhere($qb->expr()->eq('uid', $qb->createNamedParameter($uid)));
			$updateQuery->execute();
		}
	}

	/**
	 * Delete all provider states of a user and return the provider IDs
	 *
	 * @param string $uid
	 *
	 * @return list<array{provider_id: string, uid: string, enabled: bool}>
	 */
	public function deleteByUser(string $uid): array {
		$qb1 = $this->conn->getQueryBuilder();
		$selectQuery = $qb1->select('*')
			->from(self::TABLE_NAME)
			->where($qb1->expr()->eq('uid', $qb1->createNamedParameter($uid)));
		$selectResult = $selectQuery->execute();
		$rows = $selectResult->fetchAll();
		$selectResult->closeCursor();

		$qb2 = $this->conn->getQueryBuilder();
		$deleteQuery = $qb2
			->delete(self::TABLE_NAME)
			->where($qb2->expr()->eq('uid', $qb2->createNamedParameter($uid)));
		$deleteQuery->execute();

		return array_map(function (array $row) {
			return [
				'provider_id' => $row['provider_id'],
				'uid' => $row['uid'],
				'enabled' => 1 === (int) $row['enabled'],
			];
		}, $rows);
	}

	public function deleteAll(string $providerId): void {
		$qb = $this->conn->getQueryBuilder();

		$deleteQuery = $qb->delete(self::TABLE_NAME)
			->where($qb->expr()->eq('provider_id', $qb->createNamedParameter($providerId)));

		$deleteQuery->execute();
	}
}