OCA\TwoFactorGateway\Service\StateStorage

Complexity

Total Complexity

13

Size/Duplication

Total Lines	114
Duplicated Lines	0 %

Test Coverage

Coverage

81.71%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	19	4
A	persist()	0	62	4
A	deleteUserValue()	0	3	1
A	setUserValue()	0	3	1
A	__construct()	0	3	1
A	getUserValue()	0	3	1
A	buildConfigKey()	0	2	1

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Christoph Wurst <christoph@winzerhof-wurst.at>
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\TwoFactorGateway\Service;

use Exception;
use OCA\TwoFactorGateway\AppInfo\Application;
use OCA\TwoFactorGateway\Provider\State;
use OCP\IConfig;
use OCP\IUser;

class StateStorage {
	public const STATE_DISABLED = 0;
	public const STATE_START_VERIFICATION = 1;
	public const STATE_VERIFYING = 2;
	public const STATE_ENABLED = 3;

	public function __construct(
		private IConfig $config,
	) {
	}

	private function buildConfigKey(string $gatewayName, string $key): string {
		return $gatewayName . "_$key";
	}

	private function getUserValue(IUser $user, string $gatewayName, string $key, string $default = ''): string {
		$gatewayKey = $this->buildConfigKey($gatewayName, $key);
		return $this->config->getUserValue($user->getUID(), Application::APP_ID, $gatewayKey, $default);

The function OCP\IConfig::getUserValue() has been deprecated: 33.0.0 - use {@see IUserConfig} directly

	}

	private function setUserValue(IUser $user, string $gatewayName, string $key, ?string $value): void {
		$gatewayKey = $this->buildConfigKey($gatewayName, $key);
		$this->config->setUserValue($user->getUID(), Application::APP_ID, $gatewayKey, $value);

The function OCP\IConfig::setUserValue() has been deprecated: 33.0.0 - use {@see IUserConfig} directly

	}

	private function deleteUserValue(IUser $user, string $gatewayName, string $key): void {
		$gatewayKey = $this->buildConfigKey($gatewayName, $key);
		$this->config->deleteUserValue($user->getUID(), Application::APP_ID, $gatewayKey);

The function OCP\IConfig::deleteUserValue() has been deprecated: 33.0.0 - use {@see IUserConfig::deleteUserConfig} directly

	}

	public function get(IUser $user, string $gatewayName): State {
		$isVerified = $this->getUserValue($user, $gatewayName, 'verified', 'false') === 'true';
		$identifier = $this->getUserValue($user, $gatewayName, 'identifier');
		$verificationCode = $this->getUserValue($user, $gatewayName, 'verification_code');

		if ($isVerified) {
			$state = StateStorage::STATE_ENABLED;
		} elseif ($identifier !== '' && $verificationCode !== '') {
			$state = StateStorage::STATE_VERIFYING;
		} else {
			$state = StateStorage::STATE_DISABLED;
		}

		return new State(
			$user,
			$state,
			$gatewayName,
			$identifier,
			$verificationCode
		);
	}

	public function persist(State $state): State {
		switch ($state->getState()) {
			case StateStorage::STATE_DISABLED:
				$this->deleteUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verified'
				);
				$this->deleteUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verification_code'
				);

				break;
			case StateStorage::STATE_VERIFYING:
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'identifier',
					$state->getIdentifier()
				);
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verification_code',
					$state->getVerificationCode()
				);
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verified',
					'false'
				);

				break;
			case StateStorage::STATE_ENABLED:
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'identifier',
					$state->getIdentifier()
				);
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verification_code',
					$state->getVerificationCode()
				);
				$this->setUserValue(
					$state->getUser(),
					$state->getGatewayName(),
					'verified',
					'true'
				);

				break;
			default:
				throw new Exception('invalid provider state');
		}

		return $state;
	}
}