nextcloud / server

apps/twofactor_backupcodes/lib/Provider/BackupCodesProvider.php

Indentation +124 added lines, -124 removed lines

@@ -36,130 +36,130 @@
 
 class BackupCodesProvider implements IProvider, IProvidesPersonalSettings {
 
-	/** @var string */
-	private $appName;
-
-	/** @var BackupCodeStorage */
-	private $storage;
-
-	/** @var IL10N */
-	private $l10n;
-
-	/** @var AppManager */
-	private $appManager;
-	/** @var IInitialStateService */
-	private $initialStateService;
-
-	/**
-	 * @param string $appName
-	 * @param BackupCodeStorage $storage
-	 * @param IL10N $l10n
-	 * @param AppManager $appManager
-	 */
-	public function __construct(string $appName,
-								BackupCodeStorage $storage,
-								IL10N $l10n,
-								AppManager $appManager,
-								IInitialStateService $initialStateService) {
-		$this->appName = $appName;
-		$this->l10n = $l10n;
-		$this->storage = $storage;
-		$this->appManager = $appManager;
-		$this->initialStateService = $initialStateService;
-	}
-
-	/**
-	 * Get unique identifier of this 2FA provider
-	 *
-	 * @return string
-	 */
-	public function getId(): string {
-		return 'backup_codes';
-	}
-
-	/**
-	 * Get the display name for selecting the 2FA provider
-	 *
-	 * @return string
-	 */
-	public function getDisplayName(): string {
-		return $this->l10n->t('Backup code');
-	}
-
-	/**
-	 * Get the description for selecting the 2FA provider
-	 *
-	 * @return string
-	 */
-	public function getDescription(): string {
-		return $this->l10n->t('Use backup code');
-	}
-
-	/**
-	 * Get the template for rending the 2FA provider view
-	 *
-	 * @param IUser $user
-	 * @return Template
-	 */
-	public function getTemplate(IUser $user): Template {
-		return new Template('twofactor_backupcodes', 'challenge');
-	}
-
-	/**
-	 * Verify the given challenge
-	 *
-	 * @param IUser $user
-	 * @param string $challenge
-	 * @return bool
-	 */
-	public function verifyChallenge(IUser $user, string $challenge): bool {
-		return $this->storage->validateCode($user, $challenge);
-	}
-
-	/**
-	 * Decides whether 2FA is enabled for the given user
-	 *
-	 * @param IUser $user
-	 * @return boolean
-	 */
-	public function isTwoFactorAuthEnabledForUser(IUser $user): bool {
-		return $this->storage->hasBackupCodes($user);
-	}
-
-	/**
-	 * Determine whether backup codes should be active or not
-	 *
-	 * Backup codes only make sense if at least one 2FA provider is active,
-	 * hence this method checks all enabled apps on whether they provide 2FA
-	 * functionality or not. If there's at least one app, backup codes are
-	 * enabled on the personal settings page.
-	 *
-	 * @param IUser $user
-	 * @return boolean
-	 */
-	public function isActive(IUser $user): bool {
-		$appIds = array_filter($this->appManager->getEnabledAppsForUser($user), function($appId) {
-			return $appId !== $this->appName;
-		});
-		foreach ($appIds as $appId) {
-			$info = $this->appManager->getAppInfo($appId);
-			if (isset($info['two-factor-providers']) && count($info['two-factor-providers']) > 0) {
-				return true;
-			}
-		}
-		return false;
-	}
-
-	/**
-	 * @param IUser $user
-	 *
-	 * @return IPersonalProviderSettings
-	 */
-	public function getPersonalSettings(IUser $user): IPersonalProviderSettings {
-		$state = $this->storage->getBackupCodesState($user);
-		$this->initialStateService->provideInitialState($this->appName, 'state', $state);
-		return new Personal();
-	}
+    /** @var string */
+    private $appName;
+
+    /** @var BackupCodeStorage */
+    private $storage;
+
+    /** @var IL10N */
+    private $l10n;
+
+    /** @var AppManager */
+    private $appManager;
+    /** @var IInitialStateService */
+    private $initialStateService;
+
+    /**
+     * @param string $appName
+     * @param BackupCodeStorage $storage
+     * @param IL10N $l10n
+     * @param AppManager $appManager
+     */
+    public function __construct(string $appName,
+                                BackupCodeStorage $storage,
+                                IL10N $l10n,
+                                AppManager $appManager,
+                                IInitialStateService $initialStateService) {
+        $this->appName = $appName;
+        $this->l10n = $l10n;
+        $this->storage = $storage;
+        $this->appManager = $appManager;
+        $this->initialStateService = $initialStateService;
+    }
+
+    /**
+     * Get unique identifier of this 2FA provider
+     *
+     * @return string
+     */
+    public function getId(): string {
+        return 'backup_codes';
+    }
+
+    /**
+     * Get the display name for selecting the 2FA provider
+     *
+     * @return string
+     */
+    public function getDisplayName(): string {
+        return $this->l10n->t('Backup code');
+    }
+
+    /**
+     * Get the description for selecting the 2FA provider
+     *
+     * @return string
+     */
+    public function getDescription(): string {
+        return $this->l10n->t('Use backup code');
+    }
+
+    /**
+     * Get the template for rending the 2FA provider view
+     *
+     * @param IUser $user
+     * @return Template
+     */
+    public function getTemplate(IUser $user): Template {
+        return new Template('twofactor_backupcodes', 'challenge');
+    }
+
+    /**
+     * Verify the given challenge
+     *
+     * @param IUser $user
+     * @param string $challenge
+     * @return bool
+     */
+    public function verifyChallenge(IUser $user, string $challenge): bool {
+        return $this->storage->validateCode($user, $challenge);
+    }
+
+    /**
+     * Decides whether 2FA is enabled for the given user
+     *
+     * @param IUser $user
+     * @return boolean
+     */
+    public function isTwoFactorAuthEnabledForUser(IUser $user): bool {
+        return $this->storage->hasBackupCodes($user);
+    }
+
+    /**
+     * Determine whether backup codes should be active or not
+     *
+     * Backup codes only make sense if at least one 2FA provider is active,
+     * hence this method checks all enabled apps on whether they provide 2FA
+     * functionality or not. If there's at least one app, backup codes are
+     * enabled on the personal settings page.
+     *
+     * @param IUser $user
+     * @return boolean
+     */
+    public function isActive(IUser $user): bool {
+        $appIds = array_filter($this->appManager->getEnabledAppsForUser($user), function($appId) {
+            return $appId !== $this->appName;
+        });
+        foreach ($appIds as $appId) {
+            $info = $this->appManager->getAppInfo($appId);
+            if (isset($info['two-factor-providers']) && count($info['two-factor-providers']) > 0) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @param IUser $user
+     *
+     * @return IPersonalProviderSettings
+     */
+    public function getPersonalSettings(IUser $user): IPersonalProviderSettings {
+        $state = $this->storage->getBackupCodesState($user);
+        $this->initialStateService->provideInitialState($this->appName, 'state', $state);
+        return new Personal();
+    }
 
 }
 

lib/private/InitialStateService.php

Indentation +47 added lines, -47 removed lines

@@ -30,61 +30,61 @@
 
 class InitialStateService implements IInitialStateService {
 
-	/** @var ILogger */
-	private $logger;
+    /** @var ILogger */
+    private $logger;
 
-	/** @var string[][] */
-	private $states = [];
+    /** @var string[][] */
+    private $states = [];
 
-	/** @var Closure[][] */
-	private $lazyStates = [];
+    /** @var Closure[][] */
+    private $lazyStates = [];
 
-	public function __construct(ILogger $logger) {
-		$this->logger = $logger;
-	}
+    public function __construct(ILogger $logger) {
+        $this->logger = $logger;
+    }
 
-	public function provideInitialState(string $appName, string $key, $data): void {
-		// Scalars and JsonSerializable are fine
-		if (is_scalar($data) || $data instanceof \JsonSerializable || is_array($data)) {
-			if (!isset($this->states[$appName])) {
-				$this->states[$appName] = [];
-			}
-			$this->states[$appName][$key] = json_encode($data);
-			return;
-		}
+    public function provideInitialState(string $appName, string $key, $data): void {
+        // Scalars and JsonSerializable are fine
+        if (is_scalar($data) || $data instanceof \JsonSerializable || is_array($data)) {
+            if (!isset($this->states[$appName])) {
+                $this->states[$appName] = [];
+            }
+            $this->states[$appName][$key] = json_encode($data);
+            return;
+        }
 
-		$this->logger->warning('Invalid data provided to provideInitialState by ' . $appName);
-	}
+        $this->logger->warning('Invalid data provided to provideInitialState by ' . $appName);
+    }
 
-	public function provideLazyInitialState(string $appName, string $key, Closure $closure): void {
-		if (!isset($this->lazyStates[$appName])) {
-			$this->lazyStates[$appName] = [];
-		}
-		$this->lazyStates[$appName][$key] = $closure;
-	}
+    public function provideLazyInitialState(string $appName, string $key, Closure $closure): void {
+        if (!isset($this->lazyStates[$appName])) {
+            $this->lazyStates[$appName] = [];
+        }
+        $this->lazyStates[$appName][$key] = $closure;
+    }
 
-	/**
-	 * Invoke all callbacks to populate the `states` property
-	 */
-	private function invokeLazyStateCallbacks(): void {
-		foreach ($this->lazyStates as $app => $lazyStates) {
-			foreach ($lazyStates as $key => $lazyState) {
-				$this->provideInitialState($app, $key, $lazyState());
-			}
-		}
-		$this->lazyStates = [];
-	}
+    /**
+     * Invoke all callbacks to populate the `states` property
+     */
+    private function invokeLazyStateCallbacks(): void {
+        foreach ($this->lazyStates as $app => $lazyStates) {
+            foreach ($lazyStates as $key => $lazyState) {
+                $this->provideInitialState($app, $key, $lazyState());
+            }
+        }
+        $this->lazyStates = [];
+    }
 
-	public function getInitialStates(): array {
-		$this->invokeLazyStateCallbacks();
+    public function getInitialStates(): array {
+        $this->invokeLazyStateCallbacks();
 
-		$appStates = [];
-		foreach ($this->states as $app => $states) {
-			foreach ($states as $key => $value) {
-				$appStates["$app-$key"] = $value;
-			}
-		}
-		return $appStates;
-	}
+        $appStates = [];
+        foreach ($this->states as $app => $states) {
+            foreach ($states as $key => $value) {
+                $appStates["$app-$key"] = $value;
+            }
+        }
+        return $appStates;
+    }
 
 }

Spacing +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
 			return;
 		}
 
-		$this->logger->warning('Invalid data provided to provideInitialState by ' . $appName);
+		$this->logger->warning('Invalid data provided to provideInitialState by '.$appName);
 	}
 
 	public function provideLazyInitialState(string $appName, string $key, Closure $closure): void {

lib/public/IInitialStateService.php

Indentation +26 added lines, -26 removed lines

@@ -30,31 +30,31 @@
  * @since 16.0.0
  */
 interface IInitialStateService {
-	/**
-	 * Allows an app to provide its initial state to the template system.
-	 * Use this if you know your initial state sill be used for example if
-	 * you are in the render function of you controller.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $appName
-	 * @param string $key
-	 * @param bool|int|float|string|array|\JsonSerializable $data
-	 */
-	public function provideInitialState(string $appName, string $key, $data): void;
+    /**
+     * Allows an app to provide its initial state to the template system.
+     * Use this if you know your initial state sill be used for example if
+     * you are in the render function of you controller.
+     *
+     * @since 16.0.0
+     *
+     * @param string $appName
+     * @param string $key
+     * @param bool|int|float|string|array|\JsonSerializable $data
+     */
+    public function provideInitialState(string $appName, string $key, $data): void;
 
-	/**
-	 * Allows an app to provide its initial state via a lazy method.
-	 * This will call the closure when the template is being generated.
-	 * Use this if your app is injected into pages. Since then the render method
-	 * is not called explicitly. But we do not want to load the state on webdav
-	 * requests for example.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $appName
-	 * @param string $key
-	 * @param Closure $closure returns a primitive or an object that implements JsonSerializable
-	 */
-	public function provideLazyInitialState(string $appName, string $key, Closure $closure): void;
+    /**
+     * Allows an app to provide its initial state via a lazy method.
+     * This will call the closure when the template is being generated.
+     * Use this if your app is injected into pages. Since then the render method
+     * is not called explicitly. But we do not want to load the state on webdav
+     * requests for example.
+     *
+     * @since 16.0.0
+     *
+     * @param string $appName
+     * @param string $key
+     * @param Closure $closure returns a primitive or an object that implements JsonSerializable
+     */
+    public function provideLazyInitialState(string $appName, string $key, Closure $closure): void;
 }