nextcloud / server

apps/updatenotification/lib/BackgroundJob/ResetToken.php

Indentation +33 added lines, -33 removed lines

@@ -19,39 +19,39 @@
  */
 class ResetToken extends TimedJob {
 
-	/**
-	 * @param IConfig $config
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(
-		ITimeFactory $time,
-		private IConfig $config,
-		private IAppConfig $appConfig,
-		private LoggerInterface $logger,
-	) {
-		parent::__construct($time);
-		// Run once an hour
-		parent::setInterval(60 * 60);
-	}
+    /**
+     * @param IConfig $config
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(
+        ITimeFactory $time,
+        private IConfig $config,
+        private IAppConfig $appConfig,
+        private LoggerInterface $logger,
+    ) {
+        parent::__construct($time);
+        // Run once an hour
+        parent::setInterval(60 * 60);
+    }
 
-	/**
-	 * @param $argument
-	 */
-	protected function run($argument) {
-		if ($this->config->getSystemValueBool('config_is_read_only')) {
-			$this->logger->debug('Skipping `updater.secret` reset since config_is_read_only is set', ['app' => 'updatenotification']);
-			return;
-		}
+    /**
+     * @param $argument
+     */
+    protected function run($argument) {
+        if ($this->config->getSystemValueBool('config_is_read_only')) {
+            $this->logger->debug('Skipping `updater.secret` reset since config_is_read_only is set', ['app' => 'updatenotification']);
+            return;
+        }
 
-		$secretCreated = $this->appConfig->getValueInt('core', 'updater.secret.created');
-		// Delete old tokens after 2 days and also tokens without any created date
-		$secretCreatedDiff = $this->time->getTime() - $secretCreated;
-		if ($secretCreatedDiff >= 172800) {
-			$this->config->deleteSystemValue('updater.secret');
-			$this->appConfig->deleteKey('core', 'updater.secret.created');
-			$this->logger->warning('Cleared old `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
-		} else {
-			$this->logger->debug('Keeping existing `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
-		}
-	}
+        $secretCreated = $this->appConfig->getValueInt('core', 'updater.secret.created');
+        // Delete old tokens after 2 days and also tokens without any created date
+        $secretCreatedDiff = $this->time->getTime() - $secretCreated;
+        if ($secretCreatedDiff >= 172800) {
+            $this->config->deleteSystemValue('updater.secret');
+            $this->appConfig->deleteKey('core', 'updater.secret.created');
+            $this->logger->warning('Cleared old `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
+        } else {
+            $this->logger->debug('Keeping existing `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
+        }
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -49,9 +49,9 @@
 		if ($secretCreatedDiff >= 172800) {
 			$this->config->deleteSystemValue('updater.secret');
 			$this->appConfig->deleteKey('core', 'updater.secret.created');
-			$this->logger->warning('Cleared old `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
+			$this->logger->warning('Cleared old `updater.secret` that was created '.$secretCreatedDiff.' seconds ago', ['app' => 'updatenotification']);
 		} else {
-			$this->logger->debug('Keeping existing `updater.secret` that was created ' . $secretCreatedDiff . ' seconds ago', ['app' => 'updatenotification']);
+			$this->logger->debug('Keeping existing `updater.secret` that was created '.$secretCreatedDiff.' seconds ago', ['app' => 'updatenotification']);
 		}
 	}
 }

apps/updatenotification/lib/Controller/AdminController.php

Indentation +41 added lines, -41 removed lines

@@ -25,52 +25,52 @@
 
 class AdminController extends Controller {
 
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		private IJobList $jobList,
-		private ISecureRandom $secureRandom,
-		private IConfig $config,
-		private IAppConfig $appConfig,
-		private ITimeFactory $timeFactory,
-		private IL10N $l10n,
-		private LoggerInterface $logger,
-	) {
-		parent::__construct($appName, $request);
-	}
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        private IJobList $jobList,
+        private ISecureRandom $secureRandom,
+        private IConfig $config,
+        private IAppConfig $appConfig,
+        private ITimeFactory $timeFactory,
+        private IL10N $l10n,
+        private LoggerInterface $logger,
+    ) {
+        parent::__construct($appName, $request);
+    }
 
-	/**
-	 * @param string $channel
-	 * @return DataResponse
-	 */
-	public function setChannel(string $channel): DataResponse {
-		Util::setChannel($channel);
-		$this->appConfig->setValueInt('core', 'lastupdatedat', 0);
-		return new DataResponse(['status' => 'success', 'data' => ['message' => $this->l10n->t('Channel updated')]]);
-	}
+    /**
+     * @param string $channel
+     * @return DataResponse
+     */
+    public function setChannel(string $channel): DataResponse {
+        Util::setChannel($channel);
+        $this->appConfig->setValueInt('core', 'lastupdatedat', 0);
+        return new DataResponse(['status' => 'success', 'data' => ['message' => $this->l10n->t('Channel updated')]]);
+    }
 
-	/**
-	 * @return DataResponse
-	 */
-	public function createCredentials(): DataResponse {
-		if ($this->config->getSystemValueBool('upgrade.disable-web')) {
-			return new DataResponse(['status' => 'error', 'message' => $this->l10n->t('Web updater is disabled')], Http::STATUS_FORBIDDEN);
-		}
+    /**
+     * @return DataResponse
+     */
+    public function createCredentials(): DataResponse {
+        if ($this->config->getSystemValueBool('upgrade.disable-web')) {
+            return new DataResponse(['status' => 'error', 'message' => $this->l10n->t('Web updater is disabled')], Http::STATUS_FORBIDDEN);
+        }
 
-		if ($this->config->getSystemValueBool('config_is_read_only')) {
-			return new DataResponse(['status' => 'error', 'message' => $this->l10n->t('Configuration is read-only')], Http::STATUS_FORBIDDEN);
-		}
+        if ($this->config->getSystemValueBool('config_is_read_only')) {
+            return new DataResponse(['status' => 'error', 'message' => $this->l10n->t('Configuration is read-only')], Http::STATUS_FORBIDDEN);
+        }
 
-		// Create a new job and store the creation date
-		$this->jobList->add(ResetToken::class);
-		$this->appConfig->setValueInt('core', 'updater.secret.created', $this->timeFactory->getTime());
+        // Create a new job and store the creation date
+        $this->jobList->add(ResetToken::class);
+        $this->appConfig->setValueInt('core', 'updater.secret.created', $this->timeFactory->getTime());
 
-		// Create a new token
-		$newToken = $this->secureRandom->generate(64);
-		$this->config->setSystemValue('updater.secret', password_hash($newToken, PASSWORD_DEFAULT));
+        // Create a new token
+        $newToken = $this->secureRandom->generate(64);
+        $this->config->setSystemValue('updater.secret', password_hash($newToken, PASSWORD_DEFAULT));
 
-		$this->logger->warning('Created new `updater.secret`', ['app' => 'updatenotification']);
+        $this->logger->warning('Created new `updater.secret`', ['app' => 'updatenotification']);
 
-		return new DataResponse($newToken);
-	}
+        return new DataResponse($newToken);
+    }
 }

apps/updatenotification/tests/BackgroundJob/ResetTokenTest.php

Indentation +110 added lines, -110 removed lines

@@ -17,122 +17,122 @@
 use Test\TestCase;
 
 class ResetTokenTest extends TestCase {
-	protected BackgroundJobResetToken $resetTokenBackgroundJob;
+    protected BackgroundJobResetToken $resetTokenBackgroundJob;
 
-	protected IConfig&MockObject $config;
-	protected IAppConfig&MockObject $appConfig;
-	protected ITimeFactory&MockObject $timeFactory;
-	protected LoggerInterface&MockObject $logger;
+    protected IConfig&MockObject $config;
+    protected IAppConfig&MockObject $appConfig;
+    protected ITimeFactory&MockObject $timeFactory;
+    protected LoggerInterface&MockObject $logger;
 
-	protected function setUp(): void {
-		parent::setUp();
-		$this->timeFactory = $this->createMock(ITimeFactory::class);
-		$this->config = $this->createMock(IConfig::class);
-		$this->appConfig = $this->createMock(IAppConfig::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->resetTokenBackgroundJob = new BackgroundJobResetToken(
-			$this->timeFactory,
-			$this->config,
-			$this->appConfig,
-			$this->logger,
-		);
-	}
+    protected function setUp(): void {
+        parent::setUp();
+        $this->timeFactory = $this->createMock(ITimeFactory::class);
+        $this->config = $this->createMock(IConfig::class);
+        $this->appConfig = $this->createMock(IAppConfig::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->resetTokenBackgroundJob = new BackgroundJobResetToken(
+            $this->timeFactory,
+            $this->config,
+            $this->appConfig,
+            $this->logger,
+        );
+    }
 
-	/**
-	 * Affirm if updater.secret.created <48 hours ago then `updater.secret` is left alone.
-	 */
-	public function testKeepSecretWhenCreatedRecently(): void {
-		$this->timeFactory
-			->expects($this->atLeastOnce())
-			->method('getTime')
-			->willReturn(1733069649); // "Sun, 01 Dec 2024 16:14:09 +0000"
-		$this->appConfig
-			->expects($this->once())
-			->method('getValueInt')
-			->with('core', 'updater.secret.created')
-			->willReturn(1733069649 - 1 * 24 * 60 * 60); // 24h prior: "Sat, 30 Nov 2024 16:14:09 +0000"
-		$this->config
-			->expects($this->once())
-			->method('getSystemValueBool')
-			->with('config_is_read_only')
-			->willReturn(false);
-		$this->config
-			->expects($this->never())
-			->method('deleteSystemValue');
-		$this->appConfig
-			->expects($this->never())
-			->method('deleteKey');
-		$this->logger
-			->expects($this->never())
-			->method('warning');
-		$this->logger
-			->expects($this->once())
-			->method('debug');
+    /**
+     * Affirm if updater.secret.created <48 hours ago then `updater.secret` is left alone.
+     */
+    public function testKeepSecretWhenCreatedRecently(): void {
+        $this->timeFactory
+            ->expects($this->atLeastOnce())
+            ->method('getTime')
+            ->willReturn(1733069649); // "Sun, 01 Dec 2024 16:14:09 +0000"
+        $this->appConfig
+            ->expects($this->once())
+            ->method('getValueInt')
+            ->with('core', 'updater.secret.created')
+            ->willReturn(1733069649 - 1 * 24 * 60 * 60); // 24h prior: "Sat, 30 Nov 2024 16:14:09 +0000"
+        $this->config
+            ->expects($this->once())
+            ->method('getSystemValueBool')
+            ->with('config_is_read_only')
+            ->willReturn(false);
+        $this->config
+            ->expects($this->never())
+            ->method('deleteSystemValue');
+        $this->appConfig
+            ->expects($this->never())
+            ->method('deleteKey');
+        $this->logger
+            ->expects($this->never())
+            ->method('warning');
+        $this->logger
+            ->expects($this->once())
+            ->method('debug');
 
-		static::invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
-	}
+        static::invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
+    }
 
-	/**
-	 * Affirm if updater.secret.created >48 hours ago then `updater.secret` is removed
-	 */
-	public function testSecretIsRemovedWhenOutdated(): void {
-		$this->timeFactory
-			->expects($this->atLeastOnce())
-			->method('getTime')
-			->willReturn(1455045234); // "Tue, 09 Feb 2016 19:13:54 +0000"
-		$this->appConfig
-			->expects($this->once())
-			->method('getValueInt')
-			->with('core', 'updater.secret.created')
-			->willReturn(1455045234 - 3 * 24 * 60 * 60); // 72h prior: "Sat, 06 Feb 2016 19:13:54 +0000"
-		$this->config
-			->expects($this->once())
-			->method('getSystemValueBool')
-			->with('config_is_read_only')
-			->willReturn(false);
-		$this->config
-			->expects($this->once())
-			->method('deleteSystemValue')
-			->with('updater.secret');
-		$this->appConfig
-			->expects($this->once())
-			->method('deleteKey')
-			->with('core', 'updater.secret.created');
-		$this->logger
-			->expects($this->once())
-			->method('warning');
-		$this->logger
-			->expects($this->never())
-			->method('debug');
+    /**
+     * Affirm if updater.secret.created >48 hours ago then `updater.secret` is removed
+     */
+    public function testSecretIsRemovedWhenOutdated(): void {
+        $this->timeFactory
+            ->expects($this->atLeastOnce())
+            ->method('getTime')
+            ->willReturn(1455045234); // "Tue, 09 Feb 2016 19:13:54 +0000"
+        $this->appConfig
+            ->expects($this->once())
+            ->method('getValueInt')
+            ->with('core', 'updater.secret.created')
+            ->willReturn(1455045234 - 3 * 24 * 60 * 60); // 72h prior: "Sat, 06 Feb 2016 19:13:54 +0000"
+        $this->config
+            ->expects($this->once())
+            ->method('getSystemValueBool')
+            ->with('config_is_read_only')
+            ->willReturn(false);
+        $this->config
+            ->expects($this->once())
+            ->method('deleteSystemValue')
+            ->with('updater.secret');
+        $this->appConfig
+            ->expects($this->once())
+            ->method('deleteKey')
+            ->with('core', 'updater.secret.created');
+        $this->logger
+            ->expects($this->once())
+            ->method('warning');
+        $this->logger
+            ->expects($this->never())
+            ->method('debug');
 
-		$this->invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
-	}
+        $this->invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
+    }
 
-	public function testRunWithExpiredTokenAndReadOnlyConfigFile(): void { // Affirm if config_is_read_only is set that the secret is never reset
-		$this->timeFactory
-				->expects($this->never())
-				->method('getTime');
-		$this->appConfig
-			->expects($this->never())
-			->method('getValueInt');
-		$this->config
-			->expects($this->once())
-			->method('getSystemValueBool')
-			->with('config_is_read_only')
-			->willReturn(true);
-		$this->config
-			->expects($this->never())
-			->method('deleteSystemValue');
-		$this->appConfig
-			->expects($this->never())
-			->method('deleteKey');
-		$this->logger
-			->expects($this->never())
-			->method('warning');
-		$this->logger
-			->expects($this->once())
-			->method('debug');
+    public function testRunWithExpiredTokenAndReadOnlyConfigFile(): void { // Affirm if config_is_read_only is set that the secret is never reset
+        $this->timeFactory
+                ->expects($this->never())
+                ->method('getTime');
+        $this->appConfig
+            ->expects($this->never())
+            ->method('getValueInt');
+        $this->config
+            ->expects($this->once())
+            ->method('getSystemValueBool')
+            ->with('config_is_read_only')
+            ->willReturn(true);
+        $this->config
+            ->expects($this->never())
+            ->method('deleteSystemValue');
+        $this->appConfig
+            ->expects($this->never())
+            ->method('deleteKey');
+        $this->logger
+            ->expects($this->never())
+            ->method('warning');
+        $this->logger
+            ->expects($this->once())
+            ->method('debug');
 
-		$this->invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
-	}
+        $this->invokePrivate($this->resetTokenBackgroundJob, 'run', [null]);
+    }
 }

apps/updatenotification/tests/Controller/AdminControllerTest.php

Indentation +79 added lines, -79 removed lines

@@ -23,91 +23,91 @@
 use Test\TestCase;
 
 class AdminControllerTest extends TestCase {
-	protected IRequest&MockObject $request;
-	protected IJobList&MockObject $jobList;
-	protected ISecureRandom&MockObject $secureRandom;
-	protected IConfig&MockObject $config;
-	protected ITimeFactory&MockObject $timeFactory;
-	protected IL10N&MockObject $l10n;
-	protected IAppConfig&MockObject $appConfig;
-	protected LoggerInterface&MockObject $logger;
+    protected IRequest&MockObject $request;
+    protected IJobList&MockObject $jobList;
+    protected ISecureRandom&MockObject $secureRandom;
+    protected IConfig&MockObject $config;
+    protected ITimeFactory&MockObject $timeFactory;
+    protected IL10N&MockObject $l10n;
+    protected IAppConfig&MockObject $appConfig;
+    protected LoggerInterface&MockObject $logger;
 
-	protected AdminController $adminController;
+    protected AdminController $adminController;
 
-	protected function setUp(): void {
-		parent::setUp();
+    protected function setUp(): void {
+        parent::setUp();
 
-		$this->request = $this->createMock(IRequest::class);
-		$this->jobList = $this->createMock(IJobList::class);
-		$this->secureRandom = $this->createMock(ISecureRandom::class);
-		$this->config = $this->createMock(IConfig::class);
-		$this->appConfig = $this->createMock(IAppConfig::class);
-		$this->timeFactory = $this->createMock(ITimeFactory::class);
-		$this->l10n = $this->createMock(IL10N::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
+        $this->request = $this->createMock(IRequest::class);
+        $this->jobList = $this->createMock(IJobList::class);
+        $this->secureRandom = $this->createMock(ISecureRandom::class);
+        $this->config = $this->createMock(IConfig::class);
+        $this->appConfig = $this->createMock(IAppConfig::class);
+        $this->timeFactory = $this->createMock(ITimeFactory::class);
+        $this->l10n = $this->createMock(IL10N::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
 
-		$this->adminController = new AdminController(
-			'updatenotification',
-			$this->request,
-			$this->jobList,
-			$this->secureRandom,
-			$this->config,
-			$this->appConfig,
-			$this->timeFactory,
-			$this->l10n,
-			$this->logger,
-		);
-	}
+        $this->adminController = new AdminController(
+            'updatenotification',
+            $this->request,
+            $this->jobList,
+            $this->secureRandom,
+            $this->config,
+            $this->appConfig,
+            $this->timeFactory,
+            $this->l10n,
+            $this->logger,
+        );
+    }
 
-	public function testCreateCredentials(): void {
-		$this->jobList
-			->expects($this->once())
-			->method('add')
-			->with(ResetToken::class);
-		$this->secureRandom
-			->expects($this->once())
-			->method('generate')
-			->with(64)
-			->willReturn('MyGeneratedToken');
-		$this->config
-			->expects($this->once())
-			->method('setSystemValue')
-			->with('updater.secret');
-		$this->timeFactory
-			->expects($this->once())
-			->method('getTime')
-			->willReturn(12345);
-		$this->appConfig
-			->expects($this->once())
-			->method('setValueInt')
-			->with('core', 'updater.secret.created', 12345);
+    public function testCreateCredentials(): void {
+        $this->jobList
+            ->expects($this->once())
+            ->method('add')
+            ->with(ResetToken::class);
+        $this->secureRandom
+            ->expects($this->once())
+            ->method('generate')
+            ->with(64)
+            ->willReturn('MyGeneratedToken');
+        $this->config
+            ->expects($this->once())
+            ->method('setSystemValue')
+            ->with('updater.secret');
+        $this->timeFactory
+            ->expects($this->once())
+            ->method('getTime')
+            ->willReturn(12345);
+        $this->appConfig
+            ->expects($this->once())
+            ->method('setValueInt')
+            ->with('core', 'updater.secret.created', 12345);
 
-		$expected = new DataResponse('MyGeneratedToken');
-		$this->assertEquals($expected, $this->adminController->createCredentials());
-	}
+        $expected = new DataResponse('MyGeneratedToken');
+        $this->assertEquals($expected, $this->adminController->createCredentials());
+    }
 
-	public function testCreateCredentialsAndWebUpdaterDisabled(): void {
-		$this->config
-			->expects($this->once())
-			->method('getSystemValueBool')
-			->with('upgrade.disable-web')
-			->willReturn(true);
-		$this->jobList
-			->expects($this->never())
-			->method('add');
-		$this->secureRandom
-			->expects($this->never())
-			->method('generate');
-		$this->config
-			->expects($this->never())
-			->method('setSystemValue');
-		$this->timeFactory
-			->expects($this->never())
-			->method('getTime');
-		$this->appConfig
-			->expects($this->never())
-			->method('setValueInt');
+    public function testCreateCredentialsAndWebUpdaterDisabled(): void {
+        $this->config
+            ->expects($this->once())
+            ->method('getSystemValueBool')
+            ->with('upgrade.disable-web')
+            ->willReturn(true);
+        $this->jobList
+            ->expects($this->never())
+            ->method('add');
+        $this->secureRandom
+            ->expects($this->never())
+            ->method('generate');
+        $this->config
+            ->expects($this->never())
+            ->method('setSystemValue');
+        $this->timeFactory
+            ->expects($this->never())
+            ->method('getTime');
+        $this->appConfig
+            ->expects($this->never())
+            ->method('setValueInt');
 
-		$this->adminController->createCredentials();
-	}
+        $this->adminController->createCredentials();
+    }
 }