Merge pull request #32550 from nextcloud/feat/api-cleanup-check

Add api to register setup checks

1 files changed, 20 insertions, 34 deletions

diff --git a/apps/settings/lib/SetupChecks/CheckUserCertificates.php b/apps/settings/lib/SetupChecks/CheckUserCertificates.php
index 52fea7b6551..e09ef267e07 100644
--- a/apps/settings/lib/SetupChecks/CheckUserCertificates.php
+++ b/apps/settings/lib/SetupChecks/CheckUserCertificates.php
@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 /**
  * @copyright Copyright (c) 2020 Morris Jobke <hey@morrisjobke.de>
+ * @copyright Copyright (c) 2022 Carl Schwan <carl@carlschwan.eu>
  *
  * @author Morris Jobke <hey@morrisjobke.de>
  *
@@ -27,50 +28,35 @@ namespace OCA\Settings\SetupChecks;
 
 use OCP\IConfig;
 use OCP\IL10N;
-use OCP\IURLGenerator;
+use OCP\SetupCheck\ISetupCheck;
+use OCP\SetupCheck\SetupResult;
 
-class CheckUserCertificates {
-	/** @var IL10N */
-	private $l10n;
-	/** @var string */
-	private $configValue;
-	/** @var IURLGenerator */
-	private $urlGenerator;
+class CheckUserCertificates implements ISetupCheck {
+	private string $configValue;
 
-	public function __construct(IL10N $l10n, IConfig $config, IURLGenerator $urlGenerator) {
-		$this->l10n = $l10n;
-		$configValue = $config->getAppValue('files_external', 'user_certificate_scan', '');
-		$this->configValue = $configValue;
-		$this->urlGenerator = $urlGenerator;
+	public function __construct(
+		private IL10N $l10n,
+		IConfig $config,
+	) {
+		$this->configValue = $config->getAppValue('files_external', 'user_certificate_scan', '');
 	}
 
-	public function description(): string {
-		if ($this->configValue === '') {
-			return '';
-		}
-		if ($this->configValue === 'not-run-yet') {
-			return $this->l10n->t('A background job is pending that checks for user imported SSL certificates. Please check back later.');
-		}
-		return $this->l10n->t('There are some user imported SSL certificates present, that are not used anymore with Nextcloud 21. They can be imported on the command line via "occ security:certificates:import" command. Their paths inside the data directory are shown below.');
+	public function getCategory(): string {
+		return 'security';
 	}
 
-	public function severity(): string {
-		return 'warning';
+	public function getName(): string {
+		return $this->l10n->t('Checking for old user imported certificate');
 	}
 
-	public function run(): bool {
+	public function run(): SetupResult {
 		// all fine if neither "not-run-yet" nor a result
-		return $this->configValue === '';
-	}
-
-	public function elements(): array {
-		if ($this->configValue === '' || $this->configValue === 'not-run-yet') {
-			return [];
+		if ($this->configValue === '') {
+			return SetupResult::success();
 		}
-		$data = json_decode($this->configValue);
-		if (!is_array($data)) {
-			return [];
+		if ($this->configValue === 'not-run-yet') {
+			return SetupResult::info($this->l10n->t('A background job is pending that checks for user imported SSL certificates. Please check back later.'));
 		}
-		return $data;
+		return SetupResult::error($this->l10n->t('There are some user imported SSL certificates present, that are not used anymore with Nextcloud 21. They can be imported on the command line via "occ security:certificates:import" command. Their paths inside the data directory are shown below.'));
 	}
 }