nextcloud / server

apps/twofactor_backupcodes/tests/Unit/Provider/BackupCodesProviderTest.php

Indentation +130 added lines, -130 removed lines

@@ -20,134 +20,134 @@
 use Test\TestCase;
 
 class BackupCodesProviderTest extends TestCase {
-	private string $appName;
-
-	private BackupCodeStorage&MockObject $storage;
-	private IL10N&MockObject $l10n;
-	private AppManager&MockObject $appManager;
-	private IInitialState&MockObject $initialState;
-
-	private ITemplateManager $templateManager;
-	private BackupCodesProvider $provider;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->appName = 'twofactor_backupcodes';
-		$this->storage = $this->createMock(BackupCodeStorage::class);
-		$this->l10n = $this->createMock(IL10N::class);
-		$this->appManager = $this->createMock(AppManager::class);
-		$this->initialState = $this->createMock(IInitialState::class);
-		$this->templateManager = Server::get(ITemplateManager::class);
-
-		$this->provider = new BackupCodesProvider(
-			$this->appName,
-			$this->storage,
-			$this->l10n,
-			$this->appManager,
-			$this->initialState,
-			$this->templateManager,
-		);
-	}
-
-	public function testGetId(): void {
-		$this->assertEquals('backup_codes', $this->provider->getId());
-	}
-
-	public function testGetDisplayName(): void {
-		$this->l10n->expects($this->once())
-			->method('t')
-			->with('Backup code')
-			->willReturn('l10n backup code');
-		$this->assertSame('l10n backup code', $this->provider->getDisplayName());
-	}
-
-	public function testGetDescription(): void {
-		$this->l10n->expects($this->once())
-			->method('t')
-			->with('Use backup code')
-			->willReturn('l10n use backup code');
-		$this->assertSame('l10n use backup code', $this->provider->getDescription());
-	}
-
-	public function testGetTempalte(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-		$expected = $this->templateManager->getTemplate('twofactor_backupcodes', 'challenge');
-
-		$this->assertEquals($expected, $this->provider->getTemplate($user));
-	}
-
-	public function testVerfiyChallenge(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-		$challenge = 'xyz';
-
-		$this->storage->expects($this->once())
-			->method('validateCode')
-			->with($user, $challenge)
-			->willReturn(false);
-
-		$this->assertFalse($this->provider->verifyChallenge($user, $challenge));
-	}
-
-	public function testIsTwoFactorEnabledForUser(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-
-		$this->storage->expects($this->once())
-			->method('hasBackupCodes')
-			->with($user)
-			->willReturn(true);
-
-		$this->assertTrue($this->provider->isTwoFactorAuthEnabledForUser($user));
-	}
-
-	public function testIsActiveNoProviders(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-
-		$this->appManager->expects($this->once())
-			->method('getEnabledAppsForUser')
-			->with($user)
-			->willReturn([
-				'twofactor_backupcodes',
-				'mail',
-			]);
-		$this->appManager->expects($this->once())
-			->method('getAppInfo')
-			->with('mail')
-			->willReturn([
-				'two-factor-providers' => [],
-			]);
-
-		$this->assertFalse($this->provider->isActive($user));
-	}
-
-	public function testIsActiveWithProviders(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-
-		$this->appManager->expects($this->once())
-			->method('getEnabledAppsForUser')
-			->with($user)
-			->willReturn([
-				'twofactor_backupcodes',
-				'twofactor_u2f',
-			]);
-		$this->appManager->expects($this->once())
-			->method('getAppInfo')
-			->with('twofactor_u2f')
-			->willReturn([
-				'two-factor-providers' => [
-					'OCA\TwoFactorU2F\Provider\U2FProvider',
-				],
-			]);
-
-		$this->assertTrue($this->provider->isActive($user));
-	}
-
-	public function testDisable(): void {
-		$user = $this->getMockBuilder(IUser::class)->getMock();
-		$this->storage->expects(self::once())
-			->method('deleteCodes')
-			->with($user);
-
-		$this->provider->disableFor($user);
-	}
+    private string $appName;
+
+    private BackupCodeStorage&MockObject $storage;
+    private IL10N&MockObject $l10n;
+    private AppManager&MockObject $appManager;
+    private IInitialState&MockObject $initialState;
+
+    private ITemplateManager $templateManager;
+    private BackupCodesProvider $provider;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->appName = 'twofactor_backupcodes';
+        $this->storage = $this->createMock(BackupCodeStorage::class);
+        $this->l10n = $this->createMock(IL10N::class);
+        $this->appManager = $this->createMock(AppManager::class);
+        $this->initialState = $this->createMock(IInitialState::class);
+        $this->templateManager = Server::get(ITemplateManager::class);
+
+        $this->provider = new BackupCodesProvider(
+            $this->appName,
+            $this->storage,
+            $this->l10n,
+            $this->appManager,
+            $this->initialState,
+            $this->templateManager,
+        );
+    }
+
+    public function testGetId(): void {
+        $this->assertEquals('backup_codes', $this->provider->getId());
+    }
+
+    public function testGetDisplayName(): void {
+        $this->l10n->expects($this->once())
+            ->method('t')
+            ->with('Backup code')
+            ->willReturn('l10n backup code');
+        $this->assertSame('l10n backup code', $this->provider->getDisplayName());
+    }
+
+    public function testGetDescription(): void {
+        $this->l10n->expects($this->once())
+            ->method('t')
+            ->with('Use backup code')
+            ->willReturn('l10n use backup code');
+        $this->assertSame('l10n use backup code', $this->provider->getDescription());
+    }
+
+    public function testGetTempalte(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+        $expected = $this->templateManager->getTemplate('twofactor_backupcodes', 'challenge');
+
+        $this->assertEquals($expected, $this->provider->getTemplate($user));
+    }
+
+    public function testVerfiyChallenge(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+        $challenge = 'xyz';
+
+        $this->storage->expects($this->once())
+            ->method('validateCode')
+            ->with($user, $challenge)
+            ->willReturn(false);
+
+        $this->assertFalse($this->provider->verifyChallenge($user, $challenge));
+    }
+
+    public function testIsTwoFactorEnabledForUser(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+
+        $this->storage->expects($this->once())
+            ->method('hasBackupCodes')
+            ->with($user)
+            ->willReturn(true);
+
+        $this->assertTrue($this->provider->isTwoFactorAuthEnabledForUser($user));
+    }
+
+    public function testIsActiveNoProviders(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+
+        $this->appManager->expects($this->once())
+            ->method('getEnabledAppsForUser')
+            ->with($user)
+            ->willReturn([
+                'twofactor_backupcodes',
+                'mail',
+            ]);
+        $this->appManager->expects($this->once())
+            ->method('getAppInfo')
+            ->with('mail')
+            ->willReturn([
+                'two-factor-providers' => [],
+            ]);
+
+        $this->assertFalse($this->provider->isActive($user));
+    }
+
+    public function testIsActiveWithProviders(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+
+        $this->appManager->expects($this->once())
+            ->method('getEnabledAppsForUser')
+            ->with($user)
+            ->willReturn([
+                'twofactor_backupcodes',
+                'twofactor_u2f',
+            ]);
+        $this->appManager->expects($this->once())
+            ->method('getAppInfo')
+            ->with('twofactor_u2f')
+            ->willReturn([
+                'two-factor-providers' => [
+                    'OCA\TwoFactorU2F\Provider\U2FProvider',
+                ],
+            ]);
+
+        $this->assertTrue($this->provider->isActive($user));
+    }
+
+    public function testDisable(): void {
+        $user = $this->getMockBuilder(IUser::class)->getMock();
+        $this->storage->expects(self::once())
+            ->method('deleteCodes')
+            ->with($user);
+
+        $this->provider->disableFor($user);
+    }
 }

apps/twofactor_backupcodes/lib/Provider/BackupCodesProvider.php

Indentation +97 added lines, -97 removed lines

@@ -21,110 +21,110 @@
 use OCP\Template\ITemplateManager;
 
 class BackupCodesProvider implements IDeactivatableByAdmin, IProvidesPersonalSettings {
-	public function __construct(
-		private string $appName,
-		private BackupCodeStorage $storage,
-		private IL10N $l10n,
-		private AppManager $appManager,
-		private IInitialState $initialState,
-		private ITemplateManager $templateManager,
-	) {
-	}
+    public function __construct(
+        private string $appName,
+        private BackupCodeStorage $storage,
+        private IL10N $l10n,
+        private AppManager $appManager,
+        private IInitialState $initialState,
+        private ITemplateManager $templateManager,
+    ) {
+    }
 
-	/**
-	 * Get unique identifier of this 2FA provider
-	 *
-	 * @return string
-	 */
-	public function getId(): string {
-		return 'backup_codes';
-	}
+    /**
+     * 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 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 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 ITemplate
-	 */
-	public function getTemplate(IUser $user): ITemplate {
-		return $this->templateManager->getTemplate('twofactor_backupcodes', 'challenge');
-	}
+    /**
+     * Get the template for rending the 2FA provider view
+     *
+     * @param IUser $user
+     * @return ITemplate
+     */
+    public function getTemplate(IUser $user): ITemplate {
+        return $this->templateManager->getTemplate('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);
-	}
+    /**
+     * 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);
-	}
+    /**
+     * 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;
-	}
+    /**
+     * 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->initialState->provideInitialState('state', $state);
-		return new Personal();
-	}
+    /**
+     * @param IUser $user
+     *
+     * @return IPersonalProviderSettings
+     */
+    public function getPersonalSettings(IUser $user): IPersonalProviderSettings {
+        $state = $this->storage->getBackupCodesState($user);
+        $this->initialState->provideInitialState('state', $state);
+        return new Personal();
+    }
 
-	public function disableFor(IUser $user): void {
-		$this->storage->deleteCodes($user);
-	}
+    public function disableFor(IUser $user): void {
+        $this->storage->deleteCodes($user);
+    }
 }

lib/private/UserStatus/Manager.php

Indentation +71 added lines, -71 removed lines

@@ -15,86 +15,86 @@
 use Psr\Log\LoggerInterface;
 
 class Manager implements IManager {
-	/** @var ?class-string */
-	private ?string $providerClass = null;
-	private ?IProvider $provider = null;
+    /** @var ?class-string */
+    private ?string $providerClass = null;
+    private ?IProvider $provider = null;
 
-	public function __construct(
-		private ContainerInterface $container,
-		private LoggerInterface $logger,
-	) {
-	}
+    public function __construct(
+        private ContainerInterface $container,
+        private LoggerInterface $logger,
+    ) {
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function getUserStatuses(array $userIds): array {
-		$this->setupProvider();
-		if (!$this->provider) {
-			return [];
-		}
+    /**
+     * @inheritDoc
+     */
+    public function getUserStatuses(array $userIds): array {
+        $this->setupProvider();
+        if (!$this->provider) {
+            return [];
+        }
 
-		return $this->provider->getUserStatuses($userIds);
-	}
+        return $this->provider->getUserStatuses($userIds);
+    }
 
-	/**
-	 * @param string $class
-	 * @since 20.0.0
-	 * @internal
-	 */
-	public function registerProvider(string $class): void {
-		$this->providerClass = $class;
-		$this->provider = null;
-	}
+    /**
+     * @param string $class
+     * @since 20.0.0
+     * @internal
+     */
+    public function registerProvider(string $class): void {
+        $this->providerClass = $class;
+        $this->provider = null;
+    }
 
-	/**
-	 * Lazily set up provider
-	 */
-	private function setupProvider(): void {
-		if ($this->provider !== null) {
-			return;
-		}
-		if ($this->providerClass === null) {
-			return;
-		}
+    /**
+     * Lazily set up provider
+     */
+    private function setupProvider(): void {
+        if ($this->provider !== null) {
+            return;
+        }
+        if ($this->providerClass === null) {
+            return;
+        }
 
-		/**
-		 * @psalm-suppress InvalidCatch
-		 */
-		try {
-			$provider = $this->container->get($this->providerClass);
-		} catch (ContainerExceptionInterface $e) {
-			$this->logger->error('Could not load user-status "' . $this->providerClass . '" provider dynamically: ' . $e->getMessage(), [
-				'exception' => $e,
-			]);
-			return;
-		}
+        /**
+         * @psalm-suppress InvalidCatch
+         */
+        try {
+            $provider = $this->container->get($this->providerClass);
+        } catch (ContainerExceptionInterface $e) {
+            $this->logger->error('Could not load user-status "' . $this->providerClass . '" provider dynamically: ' . $e->getMessage(), [
+                'exception' => $e,
+            ]);
+            return;
+        }
 
-		$this->provider = $provider;
-	}
+        $this->provider = $provider;
+    }
 
-	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false, ?string $customMessage = null): void {
-		$this->setupProvider();
-		if (!$this->provider instanceof ISettableProvider) {
-			return;
-		}
+    public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false, ?string $customMessage = null): void {
+        $this->setupProvider();
+        if (!$this->provider instanceof ISettableProvider) {
+            return;
+        }
 
-		$this->provider->setUserStatus($userId, $messageId, $status, $createBackup, $customMessage);
-	}
+        $this->provider->setUserStatus($userId, $messageId, $status, $createBackup, $customMessage);
+    }
 
-	public function revertUserStatus(string $userId, string $messageId, string $status): void {
-		$this->setupProvider();
-		if (!$this->provider instanceof ISettableProvider) {
-			return;
-		}
-		$this->provider->revertUserStatus($userId, $messageId, $status);
-	}
+    public function revertUserStatus(string $userId, string $messageId, string $status): void {
+        $this->setupProvider();
+        if (!$this->provider instanceof ISettableProvider) {
+            return;
+        }
+        $this->provider->revertUserStatus($userId, $messageId, $status);
+    }
 
-	public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
-		$this->setupProvider();
-		if (!$this->provider instanceof ISettableProvider) {
-			return;
-		}
-		$this->provider->revertMultipleUserStatus($userIds, $messageId, $status);
-	}
+    public function revertMultipleUserStatus(array $userIds, string $messageId, string $status): void {
+        $this->setupProvider();
+        if (!$this->provider instanceof ISettableProvider) {
+            return;
+        }
+        $this->provider->revertMultipleUserStatus($userIds, $messageId, $status);
+    }
 }

lib/private/InitialStateService.php

Indentation +107 added lines, -107 removed lines

@@ -18,111 +18,111 @@
 
 class InitialStateService implements IInitialStateService {
 
-	/** @var string[][] */
-	private array $states = [];
-
-	/** @var Closure[][] */
-	private array $lazyStates = [];
-
-
-	public function __construct(
-		private LoggerInterface $logger,
-		private Coordinator $bootstrapCoordinator,
-		private ContainerInterface $container,
-	) {
-	}
-
-	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] = [];
-			}
-			try {
-				$this->states[$appName][$key] = json_encode($data, JSON_THROW_ON_ERROR);
-			} catch (\JsonException $e) {
-				$this->logger->error('Invalid ' . $key . ' data provided to provideInitialState by ' . $appName, ['exception' => $e]);
-			}
-			return;
-		}
-
-		$this->logger->warning('Invalid ' . $key . ' 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;
-	}
-
-	/**
-	 * Invoke all callbacks to populate the `states` property
-	 */
-	private function invokeLazyStateCallbacks(): void {
-		foreach ($this->lazyStates as $app => $lazyStates) {
-			foreach ($lazyStates as $key => $lazyState) {
-				$startTime = microtime(true);
-				$this->provideInitialState($app, $key, $lazyState());
-				$endTime = microtime(true);
-				$duration = $endTime - $startTime;
-				if ($duration > 1) {
-					$this->logger->warning('Lazy initial state provider for {key} took {duration} seconds.', [
-						'app' => $app,
-						'key' => $key,
-						'duration' => round($duration, 2),
-					]);
-				}
-			}
-		}
-		$this->lazyStates = [];
-	}
-
-	/**
-	 * Load the lazy states via the IBootstrap mechanism
-	 */
-	private function loadLazyStates(): void {
-		$context = $this->bootstrapCoordinator->getRegistrationContext();
-
-		if ($context === null) {
-			// To early, nothing to do yet
-			return;
-		}
-
-		$initialStates = $context->getInitialStates();
-		foreach ($initialStates as $initialState) {
-			try {
-				$provider = $this->container->query($initialState->getService());
-			} catch (QueryException $e) {
-				// Log an continue. We can be fault tolerant here.
-				$this->logger->error('Could not load initial state provider dynamically: ' . $e->getMessage(), [
-					'exception' => $e,
-					'app' => $initialState->getAppId(),
-				]);
-				continue;
-			}
-
-			if (!($provider instanceof InitialStateProvider)) {
-				// Log an continue. We can be fault tolerant here.
-				$this->logger->error('Initial state provider is not an InitialStateProvider instance: ' . $initialState->getService(), [
-					'app' => $initialState->getAppId(),
-				]);
-			}
-
-			$this->provideInitialState($initialState->getAppId(), $provider->getKey(), $provider);
-		}
-	}
-
-	public function getInitialStates(): array {
-		$this->invokeLazyStateCallbacks();
-		$this->loadLazyStates();
-
-		$appStates = [];
-		foreach ($this->states as $app => $states) {
-			foreach ($states as $key => $value) {
-				$appStates["$app-$key"] = $value;
-			}
-		}
-		return $appStates;
-	}
+    /** @var string[][] */
+    private array $states = [];
+
+    /** @var Closure[][] */
+    private array $lazyStates = [];
+
+
+    public function __construct(
+        private LoggerInterface $logger,
+        private Coordinator $bootstrapCoordinator,
+        private ContainerInterface $container,
+    ) {
+    }
+
+    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] = [];
+            }
+            try {
+                $this->states[$appName][$key] = json_encode($data, JSON_THROW_ON_ERROR);
+            } catch (\JsonException $e) {
+                $this->logger->error('Invalid ' . $key . ' data provided to provideInitialState by ' . $appName, ['exception' => $e]);
+            }
+            return;
+        }
+
+        $this->logger->warning('Invalid ' . $key . ' 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;
+    }
+
+    /**
+     * Invoke all callbacks to populate the `states` property
+     */
+    private function invokeLazyStateCallbacks(): void {
+        foreach ($this->lazyStates as $app => $lazyStates) {
+            foreach ($lazyStates as $key => $lazyState) {
+                $startTime = microtime(true);
+                $this->provideInitialState($app, $key, $lazyState());
+                $endTime = microtime(true);
+                $duration = $endTime - $startTime;
+                if ($duration > 1) {
+                    $this->logger->warning('Lazy initial state provider for {key} took {duration} seconds.', [
+                        'app' => $app,
+                        'key' => $key,
+                        'duration' => round($duration, 2),
+                    ]);
+                }
+            }
+        }
+        $this->lazyStates = [];
+    }
+
+    /**
+     * Load the lazy states via the IBootstrap mechanism
+     */
+    private function loadLazyStates(): void {
+        $context = $this->bootstrapCoordinator->getRegistrationContext();
+
+        if ($context === null) {
+            // To early, nothing to do yet
+            return;
+        }
+
+        $initialStates = $context->getInitialStates();
+        foreach ($initialStates as $initialState) {
+            try {
+                $provider = $this->container->query($initialState->getService());
+            } catch (QueryException $e) {
+                // Log an continue. We can be fault tolerant here.
+                $this->logger->error('Could not load initial state provider dynamically: ' . $e->getMessage(), [
+                    'exception' => $e,
+                    'app' => $initialState->getAppId(),
+                ]);
+                continue;
+            }
+
+            if (!($provider instanceof InitialStateProvider)) {
+                // Log an continue. We can be fault tolerant here.
+                $this->logger->error('Initial state provider is not an InitialStateProvider instance: ' . $initialState->getService(), [
+                    'app' => $initialState->getAppId(),
+                ]);
+            }
+
+            $this->provideInitialState($initialState->getAppId(), $provider->getKey(), $provider);
+        }
+    }
+
+    public function getInitialStates(): array {
+        $this->invokeLazyStateCallbacks();
+        $this->loadLazyStates();
+
+        $appStates = [];
+        foreach ($this->states as $app => $states) {
+            foreach ($states as $key => $value) {
+                $appStates["$app-$key"] = $value;
+            }
+        }
+        return $appStates;
+    }
 }

lib/private/AppFramework/DependencyInjection/DIContainer.php

Indentation +297 added lines, -297 removed lines

@@ -64,301 +64,301 @@
 use Psr\Log\LoggerInterface;
 
 class DIContainer extends SimpleContainer implements IAppContainer {
-	protected string $appName;
-	private array $middleWares = [];
-	private ServerContainer $server;
-
-	public function __construct(string $appName, array $urlParams = [], ?ServerContainer $server = null) {
-		parent::__construct();
-		$this->appName = $appName;
-		$this->registerParameter('appName', $appName);
-		$this->registerParameter('urlParams', $urlParams);
-
-		/** @deprecated 32.0.0 */
-		$this->registerDeprecatedAlias('Request', IRequest::class);
-
-		if ($server === null) {
-			$server = \OC::$server;
-		}
-		$this->server = $server;
-		$this->server->registerAppContainer($appName, $this);
-
-		// aliases
-		/** @deprecated 26.0.0 inject $appName */
-		$this->registerDeprecatedAlias('AppName', 'appName');
-		/** @deprecated 26.0.0 inject $webRoot*/
-		$this->registerDeprecatedAlias('WebRoot', 'webRoot');
-		/** @deprecated 26.0.0 inject $userId */
-		$this->registerDeprecatedAlias('UserId', 'userId');
-
-		/**
-		 * Core services
-		 */
-		/* Cannot be an alias because Output is not in OCA */
-		$this->registerService(IOutput::class, fn (ContainerInterface $c): IOutput => new Output($c->get('webRoot')));
-
-		$this->registerService(Folder::class, function () {
-			return $this->getServer()->getUserFolder();
-		});
-
-		$this->registerService(IAppData::class, function (ContainerInterface $c): IAppData {
-			return $c->get(IAppDataFactory::class)->get($c->get('appName'));
-		});
-
-		$this->registerService(IL10N::class, function (ContainerInterface $c) {
-			return $this->getServer()->getL10N($c->get('appName'));
-		});
-
-		// Log wrappers
-		$this->registerService(LoggerInterface::class, function (ContainerInterface $c) {
-			/* Cannot be an alias because it uses LoggerInterface so it would infinite loop */
-			return new ScopedPsrLogger(
-				$c->get(PsrLoggerAdapter::class),
-				$c->get('appName')
-			);
-		});
-
-		$this->registerService(IServerContainer::class, function () {
-			return $this->getServer();
-		});
-		/** @deprecated 32.0.0 */
-		$this->registerDeprecatedAlias('ServerContainer', IServerContainer::class);
-
-		$this->registerAlias(\OCP\WorkflowEngine\IManager::class, Manager::class);
-
-		$this->registerService(ContainerInterface::class, fn (ContainerInterface $c) => $c);
-		$this->registerDeprecatedAlias(IAppContainer::class, ContainerInterface::class);
-
-		// commonly used attributes
-		$this->registerService('userId', function (ContainerInterface $c): ?string {
-			return $c->get(ISession::class)->get('user_id');
-		});
-
-		$this->registerService('webRoot', function (ContainerInterface $c): string {
-			return $c->get(IServerContainer::class)->getWebRoot();
-		});
-
-		$this->registerService('OC_Defaults', function (ContainerInterface $c): object {
-			return $c->get(IServerContainer::class)->get('ThemingDefaults');
-		});
-
-		/** @deprecated 32.0.0 */
-		$this->registerDeprecatedAlias('Protocol', Http::class);
-		$this->registerService(Http::class, function (ContainerInterface $c) {
-			$protocol = $c->get(IRequest::class)->getHttpProtocol();
-			return new Http($_SERVER, $protocol);
-		});
-
-		/** @deprecated 32.0.0 */
-		$this->registerDeprecatedAlias('Dispatcher', Dispatcher::class);
-		$this->registerService(Dispatcher::class, function (ContainerInterface $c) {
-			return new Dispatcher(
-				$c->get(Http::class),
-				$c->get(MiddlewareDispatcher::class),
-				$c->get(IControllerMethodReflector::class),
-				$c->get(IRequest::class),
-				$c->get(IConfig::class),
-				$c->get(IDBConnection::class),
-				$c->get(LoggerInterface::class),
-				$c->get(EventLogger::class),
-				$c,
-			);
-		});
-
-		/**
-		 * App Framework default arguments
-		 */
-		$this->registerParameter('corsMethods', 'PUT, POST, GET, DELETE, PATCH');
-		$this->registerParameter('corsAllowedHeaders', 'Authorization, Content-Type, Accept');
-		$this->registerParameter('corsMaxAge', 1728000);
-
-		/**
-		 * Middleware
-		 */
-		/** @deprecated 32.0.0 */
-		$this->registerDeprecatedAlias('MiddlewareDispatcher', MiddlewareDispatcher::class);
-		$this->registerService(MiddlewareDispatcher::class, function (ContainerInterface $c) {
-			$server = $this->getServer();
-
-			$dispatcher = new MiddlewareDispatcher();
-
-			$dispatcher->registerMiddleware($c->get(CompressionMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(NotModifiedMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(ReloadExecutionMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(SameSiteCookieMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(CORSMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(OCSMiddleware::class));
-
-			$dispatcher->registerMiddleware($c->get(FlowV2EphemeralSessionsMiddleware::class));
-
-			$securityMiddleware = new SecurityMiddleware(
-				$c->get(IRequest::class),
-				$c->get(IControllerMethodReflector::class),
-				$c->get(INavigationManager::class),
-				$c->get(IURLGenerator::class),
-				$c->get(LoggerInterface::class),
-				$c->get('appName'),
-				$server->getUserSession()->isLoggedIn(),
-				$c->get(IGroupManager::class),
-				$c->get(ISubAdmin::class),
-				$c->get(IAppManager::class),
-				$server->getL10N('lib'),
-				$c->get(AuthorizedGroupMapper::class),
-				$c->get(IUserSession::class),
-				$c->get(IRemoteAddress::class),
-			);
-			$dispatcher->registerMiddleware($securityMiddleware);
-			$dispatcher->registerMiddleware($c->get(CSPMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(FeaturePolicyMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(PasswordConfirmationMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(TwoFactorMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(BruteForceMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(RateLimitingMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(PublicShareMiddleware::class));
-			$dispatcher->registerMiddleware($c->get(AdditionalScriptsMiddleware::class));
-
-			$coordinator = $c->get(\OC\AppFramework\Bootstrap\Coordinator::class);
-			$registrationContext = $coordinator->getRegistrationContext();
-			if ($registrationContext !== null) {
-				$appId = $this->get('appName');
-				foreach ($registrationContext->getMiddlewareRegistrations() as $middlewareRegistration) {
-					if ($middlewareRegistration->getAppId() === $appId
-						|| $middlewareRegistration->isGlobal()) {
-						$dispatcher->registerMiddleware($c->get($middlewareRegistration->getService()));
-					}
-				}
-			}
-			foreach ($this->middleWares as $middleWare) {
-				$dispatcher->registerMiddleware($c->get($middleWare));
-			}
-
-			$dispatcher->registerMiddleware($c->get(SessionMiddleware::class));
-			return $dispatcher;
-		});
-
-		$this->registerAlias(IAppConfig::class, \OC\AppFramework\Services\AppConfig::class);
-		$this->registerAlias(IInitialState::class, \OC\AppFramework\Services\InitialState::class);
-	}
-
-	/**
-	 * @return \OCP\IServerContainer
-	 */
-	public function getServer() {
-		return $this->server;
-	}
-
-	/**
-	 * @param string $middleWare
-	 */
-	public function registerMiddleWare($middleWare): bool {
-		if (in_array($middleWare, $this->middleWares, true) !== false) {
-			return false;
-		}
-		$this->middleWares[] = $middleWare;
-		return true;
-	}
-
-	/**
-	 * used to return the appname of the set application
-	 * @return string the name of your application
-	 */
-	public function getAppName() {
-		return $this->query('appName');
-	}
-
-	/**
-	 * @deprecated 12.0.0 use IUserSession->isLoggedIn()
-	 * @return boolean
-	 */
-	public function isLoggedIn() {
-		return \OC::$server->getUserSession()->isLoggedIn();
-	}
-
-	/**
-	 * @deprecated 12.0.0 use IGroupManager->isAdmin($userId)
-	 * @return boolean
-	 */
-	public function isAdminUser() {
-		$uid = $this->getUserId();
-		return \OC_User::isAdminUser($uid);
-	}
-
-	private function getUserId(): string {
-		return $this->getServer()->getSession()->get('user_id');
-	}
-
-	/**
-	 * Register a capability
-	 *
-	 * @param string $serviceName e.g. 'OCA\Files\Capabilities'
-	 */
-	public function registerCapability($serviceName) {
-		$this->query('OC\CapabilitiesManager')->registerCapability(function () use ($serviceName) {
-			return $this->query($serviceName);
-		});
-	}
-
-	public function has($id): bool {
-		if (parent::has($id)) {
-			return true;
-		}
-
-		if ($this->server->has($id, true)) {
-			return true;
-		}
-
-		return false;
-	}
-
-	public function query(string $name, bool $autoload = true) {
-		if ($name === 'AppName' || $name === 'appName') {
-			return $this->appName;
-		}
-
-		$isServerClass = str_starts_with($name, 'OCP\\') || str_starts_with($name, 'OC\\');
-		if ($isServerClass && !$this->has($name)) {
-			return $this->getServer()->query($name, $autoload);
-		}
-
-		try {
-			return $this->queryNoFallback($name);
-		} catch (QueryException $firstException) {
-			try {
-				return $this->getServer()->query($name, $autoload);
-			} catch (QueryException $secondException) {
-				if ($firstException->getCode() === 1) {
-					throw $secondException;
-				}
-				throw $firstException;
-			}
-		}
-	}
-
-	/**
-	 * @param string $name
-	 * @return mixed
-	 * @throws QueryException if the query could not be resolved
-	 */
-	public function queryNoFallback($name) {
-		$name = $this->sanitizeName($name);
-
-		if ($this->offsetExists($name)) {
-			return parent::query($name);
-		} elseif ($this->appName === 'settings' && str_starts_with($name, 'OC\\Settings\\')) {
-			return parent::query($name);
-		} elseif ($this->appName === 'core' && str_starts_with($name, 'OC\\Core\\')) {
-			return parent::query($name);
-		} elseif (str_starts_with($name, \OC\AppFramework\App::buildAppNamespace($this->appName) . '\\')) {
-			return parent::query($name);
-		} elseif (
-			str_starts_with($name, 'OC\\AppFramework\\Services\\')
-			|| str_starts_with($name, 'OC\\AppFramework\\Middleware\\')
-		) {
-			/* AppFramework services are scoped to the application */
-			return parent::query($name);
-		}
-
-		throw new QueryException('Could not resolve ' . $name . '!'
-			. ' Class can not be instantiated', 1);
-	}
+    protected string $appName;
+    private array $middleWares = [];
+    private ServerContainer $server;
+
+    public function __construct(string $appName, array $urlParams = [], ?ServerContainer $server = null) {
+        parent::__construct();
+        $this->appName = $appName;
+        $this->registerParameter('appName', $appName);
+        $this->registerParameter('urlParams', $urlParams);
+
+        /** @deprecated 32.0.0 */
+        $this->registerDeprecatedAlias('Request', IRequest::class);
+
+        if ($server === null) {
+            $server = \OC::$server;
+        }
+        $this->server = $server;
+        $this->server->registerAppContainer($appName, $this);
+
+        // aliases
+        /** @deprecated 26.0.0 inject $appName */
+        $this->registerDeprecatedAlias('AppName', 'appName');
+        /** @deprecated 26.0.0 inject $webRoot*/
+        $this->registerDeprecatedAlias('WebRoot', 'webRoot');
+        /** @deprecated 26.0.0 inject $userId */
+        $this->registerDeprecatedAlias('UserId', 'userId');
+
+        /**
+         * Core services
+         */
+        /* Cannot be an alias because Output is not in OCA */
+        $this->registerService(IOutput::class, fn (ContainerInterface $c): IOutput => new Output($c->get('webRoot')));
+
+        $this->registerService(Folder::class, function () {
+            return $this->getServer()->getUserFolder();
+        });
+
+        $this->registerService(IAppData::class, function (ContainerInterface $c): IAppData {
+            return $c->get(IAppDataFactory::class)->get($c->get('appName'));
+        });
+
+        $this->registerService(IL10N::class, function (ContainerInterface $c) {
+            return $this->getServer()->getL10N($c->get('appName'));
+        });
+
+        // Log wrappers
+        $this->registerService(LoggerInterface::class, function (ContainerInterface $c) {
+            /* Cannot be an alias because it uses LoggerInterface so it would infinite loop */
+            return new ScopedPsrLogger(
+                $c->get(PsrLoggerAdapter::class),
+                $c->get('appName')
+            );
+        });
+
+        $this->registerService(IServerContainer::class, function () {
+            return $this->getServer();
+        });
+        /** @deprecated 32.0.0 */
+        $this->registerDeprecatedAlias('ServerContainer', IServerContainer::class);
+
+        $this->registerAlias(\OCP\WorkflowEngine\IManager::class, Manager::class);
+
+        $this->registerService(ContainerInterface::class, fn (ContainerInterface $c) => $c);
+        $this->registerDeprecatedAlias(IAppContainer::class, ContainerInterface::class);
+
+        // commonly used attributes
+        $this->registerService('userId', function (ContainerInterface $c): ?string {
+            return $c->get(ISession::class)->get('user_id');
+        });
+
+        $this->registerService('webRoot', function (ContainerInterface $c): string {
+            return $c->get(IServerContainer::class)->getWebRoot();
+        });
+
+        $this->registerService('OC_Defaults', function (ContainerInterface $c): object {
+            return $c->get(IServerContainer::class)->get('ThemingDefaults');
+        });
+
+        /** @deprecated 32.0.0 */
+        $this->registerDeprecatedAlias('Protocol', Http::class);
+        $this->registerService(Http::class, function (ContainerInterface $c) {
+            $protocol = $c->get(IRequest::class)->getHttpProtocol();
+            return new Http($_SERVER, $protocol);
+        });
+
+        /** @deprecated 32.0.0 */
+        $this->registerDeprecatedAlias('Dispatcher', Dispatcher::class);
+        $this->registerService(Dispatcher::class, function (ContainerInterface $c) {
+            return new Dispatcher(
+                $c->get(Http::class),
+                $c->get(MiddlewareDispatcher::class),
+                $c->get(IControllerMethodReflector::class),
+                $c->get(IRequest::class),
+                $c->get(IConfig::class),
+                $c->get(IDBConnection::class),
+                $c->get(LoggerInterface::class),
+                $c->get(EventLogger::class),
+                $c,
+            );
+        });
+
+        /**
+         * App Framework default arguments
+         */
+        $this->registerParameter('corsMethods', 'PUT, POST, GET, DELETE, PATCH');
+        $this->registerParameter('corsAllowedHeaders', 'Authorization, Content-Type, Accept');
+        $this->registerParameter('corsMaxAge', 1728000);
+
+        /**
+         * Middleware
+         */
+        /** @deprecated 32.0.0 */
+        $this->registerDeprecatedAlias('MiddlewareDispatcher', MiddlewareDispatcher::class);
+        $this->registerService(MiddlewareDispatcher::class, function (ContainerInterface $c) {
+            $server = $this->getServer();
+
+            $dispatcher = new MiddlewareDispatcher();
+
+            $dispatcher->registerMiddleware($c->get(CompressionMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(NotModifiedMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(ReloadExecutionMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(SameSiteCookieMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(CORSMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(OCSMiddleware::class));
+
+            $dispatcher->registerMiddleware($c->get(FlowV2EphemeralSessionsMiddleware::class));
+
+            $securityMiddleware = new SecurityMiddleware(
+                $c->get(IRequest::class),
+                $c->get(IControllerMethodReflector::class),
+                $c->get(INavigationManager::class),
+                $c->get(IURLGenerator::class),
+                $c->get(LoggerInterface::class),
+                $c->get('appName'),
+                $server->getUserSession()->isLoggedIn(),
+                $c->get(IGroupManager::class),
+                $c->get(ISubAdmin::class),
+                $c->get(IAppManager::class),
+                $server->getL10N('lib'),
+                $c->get(AuthorizedGroupMapper::class),
+                $c->get(IUserSession::class),
+                $c->get(IRemoteAddress::class),
+            );
+            $dispatcher->registerMiddleware($securityMiddleware);
+            $dispatcher->registerMiddleware($c->get(CSPMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(FeaturePolicyMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(PasswordConfirmationMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(TwoFactorMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(BruteForceMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(RateLimitingMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(PublicShareMiddleware::class));
+            $dispatcher->registerMiddleware($c->get(AdditionalScriptsMiddleware::class));
+
+            $coordinator = $c->get(\OC\AppFramework\Bootstrap\Coordinator::class);
+            $registrationContext = $coordinator->getRegistrationContext();
+            if ($registrationContext !== null) {
+                $appId = $this->get('appName');
+                foreach ($registrationContext->getMiddlewareRegistrations() as $middlewareRegistration) {
+                    if ($middlewareRegistration->getAppId() === $appId
+                        || $middlewareRegistration->isGlobal()) {
+                        $dispatcher->registerMiddleware($c->get($middlewareRegistration->getService()));
+                    }
+                }
+            }
+            foreach ($this->middleWares as $middleWare) {
+                $dispatcher->registerMiddleware($c->get($middleWare));
+            }
+
+            $dispatcher->registerMiddleware($c->get(SessionMiddleware::class));
+            return $dispatcher;
+        });
+
+        $this->registerAlias(IAppConfig::class, \OC\AppFramework\Services\AppConfig::class);
+        $this->registerAlias(IInitialState::class, \OC\AppFramework\Services\InitialState::class);
+    }
+
+    /**
+     * @return \OCP\IServerContainer
+     */
+    public function getServer() {
+        return $this->server;
+    }
+
+    /**
+     * @param string $middleWare
+     */
+    public function registerMiddleWare($middleWare): bool {
+        if (in_array($middleWare, $this->middleWares, true) !== false) {
+            return false;
+        }
+        $this->middleWares[] = $middleWare;
+        return true;
+    }
+
+    /**
+     * used to return the appname of the set application
+     * @return string the name of your application
+     */
+    public function getAppName() {
+        return $this->query('appName');
+    }
+
+    /**
+     * @deprecated 12.0.0 use IUserSession->isLoggedIn()
+     * @return boolean
+     */
+    public function isLoggedIn() {
+        return \OC::$server->getUserSession()->isLoggedIn();
+    }
+
+    /**
+     * @deprecated 12.0.0 use IGroupManager->isAdmin($userId)
+     * @return boolean
+     */
+    public function isAdminUser() {
+        $uid = $this->getUserId();
+        return \OC_User::isAdminUser($uid);
+    }
+
+    private function getUserId(): string {
+        return $this->getServer()->getSession()->get('user_id');
+    }
+
+    /**
+     * Register a capability
+     *
+     * @param string $serviceName e.g. 'OCA\Files\Capabilities'
+     */
+    public function registerCapability($serviceName) {
+        $this->query('OC\CapabilitiesManager')->registerCapability(function () use ($serviceName) {
+            return $this->query($serviceName);
+        });
+    }
+
+    public function has($id): bool {
+        if (parent::has($id)) {
+            return true;
+        }
+
+        if ($this->server->has($id, true)) {
+            return true;
+        }
+
+        return false;
+    }
+
+    public function query(string $name, bool $autoload = true) {
+        if ($name === 'AppName' || $name === 'appName') {
+            return $this->appName;
+        }
+
+        $isServerClass = str_starts_with($name, 'OCP\\') || str_starts_with($name, 'OC\\');
+        if ($isServerClass && !$this->has($name)) {
+            return $this->getServer()->query($name, $autoload);
+        }
+
+        try {
+            return $this->queryNoFallback($name);
+        } catch (QueryException $firstException) {
+            try {
+                return $this->getServer()->query($name, $autoload);
+            } catch (QueryException $secondException) {
+                if ($firstException->getCode() === 1) {
+                    throw $secondException;
+                }
+                throw $firstException;
+            }
+        }
+    }
+
+    /**
+     * @param string $name
+     * @return mixed
+     * @throws QueryException if the query could not be resolved
+     */
+    public function queryNoFallback($name) {
+        $name = $this->sanitizeName($name);
+
+        if ($this->offsetExists($name)) {
+            return parent::query($name);
+        } elseif ($this->appName === 'settings' && str_starts_with($name, 'OC\\Settings\\')) {
+            return parent::query($name);
+        } elseif ($this->appName === 'core' && str_starts_with($name, 'OC\\Core\\')) {
+            return parent::query($name);
+        } elseif (str_starts_with($name, \OC\AppFramework\App::buildAppNamespace($this->appName) . '\\')) {
+            return parent::query($name);
+        } elseif (
+            str_starts_with($name, 'OC\\AppFramework\\Services\\')
+            || str_starts_with($name, 'OC\\AppFramework\\Middleware\\')
+        ) {
+            /* AppFramework services are scoped to the application */
+            return parent::query($name);
+        }
+
+        throw new QueryException('Could not resolve ' . $name . '!'
+            . ' Class can not be instantiated', 1);
+    }
 }

lib/public/IInitialStateService.php

Indentation +32 added lines, -32 removed lines

@@ -15,37 +15,37 @@
  * @see \OCP\AppFramework\Services\IInitialState
  */
 interface IInitialStateService {
-	/**
-	 * Allows an app to provide its initial state to the template system.
-	 * Use this if you know your initial state still 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
-	 *
-	 * @deprecated 21 Use {@see \OCP\AppFramework\Services\IInitialState} or {@see \OCP\AppFramework\Services\InitialStateProvider}
-	 * @see \OCP\AppFramework\Services\IInitialState::provideInitialState()
-	 */
-	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 still 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
+     *
+     * @deprecated 21 Use {@see \OCP\AppFramework\Services\IInitialState} or {@see \OCP\AppFramework\Services\InitialStateProvider}
+     * @see \OCP\AppFramework\Services\IInitialState::provideInitialState()
+     */
+    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
-	 *
-	 * @deprecated 21 Use {@see \OCP\AppFramework\Services\IInitialState} or {@see \OCP\AppFramework\Services\InitialStateProvider}
-	 * @see \OCP\AppFramework\Services\IInitialState::provideLazyInitialState()
-	 */
-	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
+     *
+     * @deprecated 21 Use {@see \OCP\AppFramework\Services\IInitialState} or {@see \OCP\AppFramework\Services\InitialStateProvider}
+     * @see \OCP\AppFramework\Services\IInitialState::provideLazyInitialState()
+     */
+    public function provideLazyInitialState(string $appName, string $key, Closure $closure): void;
 }