[stable33] feat: setup check implementation

lib/AppInfo/Application.php

@@ -94,5 +94,14 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(UserDeletedEvent::class, UserDeletedListener::class);
 
 		$context->registerDashboardWidget(PendingSignaturesWidget::class);
+
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\JavaSetupCheck::class);
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\JSignPdfSetupCheck::class);
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\PDFtkSetupCheck::class);
+
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\PopplerSetupCheck::class);
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\ImagickSetupCheck::class);
+
+		$context->registerSetupCheck(\OCA\Libresign\SetupCheck\CertificateEngineSetupCheck::class);
 	}
 }

lib/Command/Configure/Check.php

@@ -9,8 +9,8 @@
 namespace OCA\Libresign\Command\Configure;
 
 use OC\Core\Command\Base;
-use OCA\Libresign\Service\Install\ConfigureCheckService;
-use OCP\IConfig;
+use OCA\Libresign\Service\SetupCheck\ConfigureCheckResult;
+use OCA\Libresign\Service\SetupCheckResultService;
 use Symfony\Component\Console\Helper\Table;
 use Symfony\Component\Console\Helper\TableCell;
 use Symfony\Component\Console\Helper\TableCellStyle;
@@ -19,9 +19,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Check extends Base {
+
 	public function __construct(
-		private ConfigureCheckService $configureCheckService,
-		private IConfig $config,
+		private SetupCheckResultService $setupCheckResultService,
 	) {
 		parent::__construct();
 	}
@@ -49,22 +49,25 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$certificate = $input->getOption('certificate');
 		$all = (!$sign && !$certificate);
 
-		$result = [];
-		if ($all) {
-			$result = $this->configureCheckService->checkAll();
-		} else {
-			if ($sign) {
-				$result = array_merge($result, $this->configureCheckService->checkSign());
+		$allChecks = $this->setupCheckResultService->getFormattedChecks();
+
+		$filteredRows = array_filter($allChecks, function (ConfigureCheckResult $check) use ($all, $sign, $certificate) {
+			if ($all) {
+				return true;
 			}
-			if ($certificate) {
-				$result = array_merge($result, $this->configureCheckService->checkCertificate());
+			if ($sign && $check->getCategory() === 'system') {
+				return true;
 			}
-		}
+			if ($certificate && $check->getCategory() === 'security') {
+				return true;
+			}
+			return false;
+		});
 
-		if (count($result)) {
+		if (!empty($filteredRows)) {
 			$table = new Table($output);
 			$table->setColumnMaxWidth(3, 40);
-			foreach ($result as $row) {
+			foreach ($filteredRows as $row) {
 				$table->addRow([
 					new TableCell($row->getStatus(), ['style' => new TableCellStyle([
 						'bg' => $this->getStatusColor($row->getStatus()),
@@ -86,10 +89,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 				->setStyle('symfony-style-guide')
 				->render();
 		}
+
 		return 0;
 	}
 
-	private function getStatusColor($status): string {
+	private function getStatusColor(string $status): string {
 		return match ($status) {
 			'success' => 'green',
 			'error' => 'red',

lib/Controller/AdminController.php

@@ -22,9 +22,9 @@
 use OCA\Libresign\Service\DocMdp\ConfigService as DocMdpConfigService;
 use OCA\Libresign\Service\FooterService;
 use OCA\Libresign\Service\IdentifyMethodService;
-use OCA\Libresign\Service\Install\ConfigureCheckService;
 use OCA\Libresign\Service\Install\InstallService;
 use OCA\Libresign\Service\ReminderService;
+use OCA\Libresign\Service\SetupCheckResultService;
 use OCA\Libresign\Service\SignatureBackgroundService;
 use OCA\Libresign\Service\SignatureTextService;
 use OCA\Libresign\Settings\Admin;
@@ -70,7 +70,6 @@ class AdminController extends AEnvironmentAwareController {
 	public function __construct(
 		IRequest $request,
 		private IAppConfig $appConfig,
-		private ConfigureCheckService $configureCheckService,
 		private InstallService $installService,
 		private CertificateEngineFactory $certificateEngineFactory,
 		private IEventSourceFactory $eventSourceFactory,
@@ -85,6 +84,7 @@ public function __construct(
 		private DocMdpConfigService $docMdpConfigService,
 		private IdentifyMethodService $identifyMethodService,
 		private FileMapper $fileMapper,
+		private SetupCheckResultService $setupCheckResultService,
 	) {
 		parent::__construct(Application::APP_ID, $request);
 		$this->eventSource = $this->eventSourceFactory->create();
@@ -257,11 +257,9 @@ public function loadCertificate(): DataResponse {
 	#[NoCSRFRequired]
 	#[ApiRoute(verb: 'GET', url: '/api/{apiVersion}/admin/configure-check', requirements: ['apiVersion' => '(v1)'])]
 	public function configureCheck(): DataResponse {
-		/** @var LibresignConfigureChecksResponse $configureCheckList */
-		$configureCheckList = array_values($this->configureCheckService->checkAll());
-		return new DataResponse(
-			$configureCheckList
-		);
+		/** @var LibresignConfigureChecksResponse $checks */
+		$checks = $this->setupCheckResultService->getFormattedChecks();
+		return new DataResponse($checks);
 	}
 
 	/**
@@ -300,8 +298,7 @@ public function installAndValidate(): void {
 				$this->installService->installCfssl($async);
 			}
 
-			$this->configureCheckService->disableCache();
-			$this->eventSource->send('configure_check', $this->configureCheckService->checkAll());
+			$this->eventSource->send('configure_check', $this->setupCheckResultService->getFormattedChecks());
 			$seconds = 0;
 			while ($this->installService->isDownloadWip()) {
 				$totalSize = $this->installService->getTotalSize();
@@ -312,7 +309,7 @@ public function installAndValidate(): void {
 				usleep(200000); // 0.2 seconds
 				$seconds += 0.2;
 				if ($seconds === 5.0) {
-					$this->eventSource->send('configure_check', $this->configureCheckService->checkAll());
+					$this->eventSource->send('configure_check', $this->setupCheckResultService->getFormattedChecks());
 					$seconds = 0;
 				}
 			}
@@ -326,7 +323,7 @@ public function installAndValidate(): void {
 			]));
 		}
 
-		$this->eventSource->send('configure_check', $this->configureCheckService->checkAll());
+		$this->eventSource->send('configure_check', $this->setupCheckResultService->getFormattedChecks());
 		$this->eventSource->send('done', '');
 		$this->eventSource->close();
 		// Nextcloud inject a lot of headers that is incompatible with SSE
@@ -563,7 +560,7 @@ public function signerName(
 		float $fontSize,
 		bool $isDarkTheme,
 		string $align,
-	):  FileDisplayResponse|DataResponse {
+	): FileDisplayResponse|DataResponse {
 		try {
 			$blob = $this->signatureTextService->signerNameImage(
 				width: $width,

lib/Handler/CertificateEngine/AEngineHandler.php

@@ -777,9 +777,11 @@ private function getConfigPathForApi(bool $generated): string {
 	}
 
 	private function filterNameValue(string $name, mixed $value, bool $generated): mixed {
-		if ($name === 'OU' && is_array($value) && !$generated) {
-			$filtered = $this->removeCaIdFromOrganizationalUnit($value);
-			return empty($filtered) ? null : $filtered;
+		if ($name === 'OU' && is_array($value)) {
+			if (!$generated) {
+				$value = $this->removeCaIdFromOrganizationalUnit($value);
+			}
+			return empty($value) ? null : implode(', ', $value);
 		}
 		return $value;
 	}

lib/ResponseDefinitions.php

@@ -267,7 +267,7 @@
  * @psalm-type LibresignConfigureCheck = array{
  *     message: string,
  *     resource: string,
- *     status: "error"|"success",
+ *     status: "error"|"info"|"success",
  *     tip: string,
  * }
  * @psalm-type LibresignConfigureChecksResponse = list<LibresignConfigureCheck>