Backport 280 to master (#282)

* Use absolute icon url (fix #280)

* Update composer deps

* Updgrade "upload-artifacts" action

* Fix NotifierTest for NC31

.github/workflows/build.yml

@@ -35,7 +35,7 @@ jobs:
         run: cd ${{ env.APP_NAME }} && make appstore
 
       - name: Upload artifacts
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: ${{ env.APP_NAME }}.tar.gz
           path: ${{ env.APP_NAME }}/build/artifacts/appstore/${{ env.APP_NAME }}.tar.gz

lib/AppInfo/Application.php

@@ -61,7 +61,7 @@
 use Psr\Log\LoggerInterface;
 
 class Application extends App implements IBootstrap {
-	public const APP_NAME = "workflow_ocr";
+	public const APP_NAME = 'workflow_ocr';
 
 	/**
 	 * Application constructor.

lib/BackgroundJobs/ProcessFileJob.php

@@ -26,11 +26,11 @@
 
 namespace OCA\WorkflowOcr\BackgroundJobs;
 
-use \OCP\Files\File;
 use OCA\WorkflowOcr\Model\WorkflowSettings;
 use OCA\WorkflowOcr\Service\INotificationService;
 use OCA\WorkflowOcr\Service\IOcrService;
 use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\Files\File;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -67,7 +67,7 @@ protected function run($argument) : void {
 			$this->ocrService->runOcrProcess($fileId, $uid, $settings);
 		} catch (\Throwable $ex) {
 			$this->logger->error($ex->getMessage(), ['exception' => $ex]);
-			$this->notificationService->createErrorNotification($uid, 'An error occured while executing the OCR process ('.$ex->getMessage().'). Please have a look at your servers logfile for more details.');
+			$this->notificationService->createErrorNotification($uid, 'An error occured while executing the OCR process (' . $ex->getMessage() . '). Please have a look at your servers logfile for more details.');
 		}
 
 		$this->logger->debug('ENDED -- Run ' . self::class . ' job. Argument: {argument}.', ['argument' => $argument]);

lib/Listener/RegisterFlowOperationsListener.php

@@ -51,6 +51,6 @@ public function handle(Event $event): void {
 		$event->registerOperation($this->container->get(Operation::class));
 
 		// Register webpack bundled script 'js/workflow_ocr-main.js'
-		Util::addScript(Application::APP_NAME, Application::APP_NAME. '-main');
+		Util::addScript(Application::APP_NAME, Application::APP_NAME . '-main');
 	}
 }

lib/Migration/Version2702Date20230908170345.php

@@ -58,7 +58,7 @@ public function description(): string {
 	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
 		try {
 			$this->deleteNonDeliverableNotifications();
-		} catch(\Throwable $e) {
+		} catch (\Throwable $e) {
 			$output->warning('Could not delete non-deliverable notifications: ' . $e->getMessage() . '. Please see https://github.com/R0Wi-DEV/workflow_ocr/issues/221.');
 		}
 

lib/Model/WorkflowSettings.php

@@ -52,7 +52,7 @@ class WorkflowSettings {
 	/**
 	 * @param string $json The serialized JSON string used in frontend as input for the Vue component
 	 */
-	public function __construct(string $json = null) {
+	public function __construct(?string $json = null) {
 		$this->setJson($json);
 	}
 
@@ -109,7 +109,7 @@ public static function canConstruct(string $json): bool {
 	/**
 	 * @return void
 	 */
-	private function setJson(string $json = null) {
+	private function setJson(?string $json = null) {
 		if (!$json) {
 			return;
 		}

lib/Notification/Notifier.php

@@ -37,7 +37,7 @@
 use Psr\Log\LoggerInterface;
 
 class Notifier implements INotifier {
-	/** @var IFactory*/
+	/** @var IFactory */
 	private $l10nFactory;
 	/** @var IURLGenerator */
 	private $urlGenerator;
@@ -111,12 +111,12 @@ public function prepare(INotification $notification, string $languageCode): INot
 		$message = $notification->getSubjectParameters()['message'];
 		$notification
 			->setParsedMessage($message)
-			->setIcon($this->urlGenerator->imagePath(Application::APP_NAME, 'app-dark.svg'));
+			->setIcon($this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath(Application::APP_NAME, 'app-dark.svg')));
 
 		return $notification;
 	}
 
-	private function tryGetRichParamForFile(string $uid, int $fileId) : array | bool {
+	private function tryGetRichParamForFile(string $uid, int $fileId) : array|bool {
 		try {
 			$userFolder = $this->rootFolder->getUserFolder($uid);
 			/** @var File[] */

lib/OcrProcessors/IOcrProcessor.php

@@ -31,9 +31,9 @@
 interface IOcrProcessor {
 	/**
 	 * Processes OCR on the given file
-	 * @param File 				$file  				The file to be processed
-	 * @param WorkflowSettings 	$settings 			The settings to be used for this specific workflow
-	 * @param GlobalSettings 	$globalSettings 	The global settings configured for all OCR workflows on this system
+	 * @param File $file The file to be processed
+	 * @param WorkflowSettings $settings The settings to be used for this specific workflow
+	 * @param GlobalSettings $globalSettings The global settings configured for all OCR workflows on this system
 	 * @return OcrProcessorResult
 	 * @throws OcrNotPossibleException
 	 */

lib/OcrProcessors/OcrMyPdfBasedProcessor.php

@@ -96,9 +96,9 @@ public function ocrFile(File $file, WorkflowSettings $settings, GlobalSettings $
 			$this->logger->info('Temporary sidecar file at \'{path}\' was empty', ['path' => $this->sidecarFileAccessor->getOrCreateSidecarFile()]);
 		}
 
-		$this->logger->debug("OCR processing was successful");
+		$this->logger->debug('OCR processing was successful');
 
-		return new OcrProcessorResult($ocrFileContent, "pdf", $recognizedText);
+		return new OcrProcessorResult($ocrFileContent, 'pdf', $recognizedText);
 	}
 
 	/**

lib/Service/IEventService.php

@@ -33,7 +33,7 @@ interface IEventService {
 	/**
 	 * Emits events
 	 *
-	 * @param OcrProcessorResult $result 	The processed ocr result
+	 * @param OcrProcessorResult $result The processed ocr result
 	 *
 	 */
 	public function textRecognized(OcrProcessorResult $result, File $node);

lib/Service/INotificationService.php

@@ -34,5 +34,5 @@ interface INotificationService {
 	 * @param string $message The error message that should be displayed in the notification.
 	 * @param int $fileId Optional file ID of the file that failed to OCR. If given, user can jump to the file via link.
 	 */
-	public function createErrorNotification(?string $userId, string $message, int $fileId = null);
+	public function createErrorNotification(?string $userId, string $message, ?int $fileId = null);
 }

lib/Service/IOcrService.php

@@ -32,9 +32,9 @@ interface IOcrService {
 	/**
 	 * Processes OCR on the given file. Creates a new file version and emits appropriate events.
 	 *
-	 * @param int $fileId					The id if the file to be processed
-	 * @param string $uid 					The id of the user who has access to this file
-	 * @param WorkflowSettings $settings 	The settings to be used for processing
+	 * @param int $fileId The id if the file to be processed
+	 * @param string $uid The id of the user who has access to this file
+	 * @param WorkflowSettings $settings The settings to be used for processing
 	 *
 	 * @throws \OCA\WorkflowOcr\Exception\OcrNotPossibleException
 	 * @throws \OCA\WorkflowOcr\Exception\OcrProcessorNotFoundException

lib/Service/NotificationService.php

@@ -44,7 +44,7 @@ public function __construct(IManager $notificationManager) {
 	/**
 	 * @return void
 	 */
-	public function createErrorNotification(?string $userId, string $message, int $fileId = null) {
+	public function createErrorNotification(?string $userId, string $message, ?int $fileId = null) {
 		// We don't create unbound notifications
 		if (!$userId) {
 			return;

lib/Service/OcrService.php

@@ -115,7 +115,7 @@ public function runOcrProcess(int $fileId, string $uid, WorkflowSettings $settin
 
 			try {
 				$result = $ocrProcessor->ocrFile($file, $settings, $globalSettings);
-			} catch(OcrResultEmptyException $ex) {
+			} catch (OcrResultEmptyException $ex) {
 				// #232: it's okay to have an empty result if the file was skipped due to OCR mode
 				if ($settings->getOcrMode() === WorkflowSettings::OCR_MODE_SKIP_FILE) {
 					$this->logger->debug('Skipping empty OCR result for file with id {fileId} because OCR mode is set to \'skip file\'', ['fileId' => $fileId]);
@@ -135,7 +135,7 @@ public function runOcrProcess(int $fileId, string $uid, WorkflowSettings $settin
 			if ($result->getRecognizedText() !== '') {
 				$newFilePath = $originalFileExtension === $newFileExtension ?
 					$filePath :
-					$filePath . ".pdf";
+					$filePath . '.pdf';
 
 				$this->createNewFileVersion($newFilePath, $fileContent, $fileId);
 			}
@@ -204,9 +204,9 @@ private function processTagsAfterSuccessfulOcr(File $file, WorkflowSettings $set
 	}
 
 	/**
-	 * @param string $filePath		The filepath of the file to write
-	 * @param string $ocrContent	The new filecontent (which was OCR processed)
-	 * @param int $fileId		The id of the file to write. Used for locking.
+	 * @param string $filePath The filepath of the file to write
+	 * @param string $ocrContent The new filecontent (which was OCR processed)
+	 * @param int $fileId The id of the file to write. Used for locking.
 	 */
 	private function createNewFileVersion(string $filePath, string $ocrContent, int $fileId) : void {
 		$dirPath = dirname($filePath);

lib/Wrapper/ICommand.php

@@ -29,19 +29,19 @@
 interface ICommand {
 	/**
 	 * @param string $command the command or full command string to execute,
-	 * like 'gzip' or 'gzip -d'.  You can still call addArg() to add more
-	 * arguments to the command. If $escapeCommand was set to true, the command
-	 * gets escaped with escapeshellcmd().
+	 *                        like 'gzip' or 'gzip -d'.  You can still call addArg() to add more
+	 *                        arguments to the command. If $escapeCommand was set to true, the command
+	 *                        gets escaped with escapeshellcmd().
 	 * @return ICommand for method chaining
 	 */
 	public function setCommand(string $command) : ICommand;
 
 	/**
 	 * @param string $stdIn If set, the string will be piped to the
-	 * command via standard input. This enables the same functionality as
-	 * piping on the command line. It can also be a resource like a file
-	 * handle or a stream in which case its content will be piped into the
-	 * command like an input redirection.
+	 *                      command via standard input. This enables the same functionality as
+	 *                      piping on the command line. It can also be a resource like a file
+	 *                      handle or a stream in which case its content will be piped into the
+	 *                      command like an input redirection.
 	 * @return ICommand for method chaining
 	 */
 	public function setStdIn(string $stdIn) : ICommand;
@@ -50,7 +50,7 @@ public function setStdIn(string $stdIn) : ICommand;
 	 * Execute the command
 	 *
 	 * @return bool whether execution was successful. If `false`, error details
-	 * can be obtained from getError(), getStdErr() and getExitCode().
+	 *              can be obtained from getError(), getStdErr() and getExitCode().
 	 */
 	public function execute() : bool;
 
@@ -63,7 +63,7 @@ public function getOutput(bool $trim = true) : string;
 	/**
 	 * @param bool $trim whether to `trim()` the return value. The default is `true`.
 	 * @return string the error message, either stderr or an internal message.
-	 * Empty string if none.
+	 *                Empty string if none.
 	 */
 	public function getError(bool $trim = true) : string;
 

lib/Wrapper/ViewWrapper.php

@@ -26,7 +26,7 @@
 
 namespace OCA\WorkflowOcr\Wrapper;
 
-use \OC\Files\View;
+use OC\Files\View;
 
 class ViewWrapper implements IView {
 	/** @var View */

tests/Integration/AppTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @copyright Copyright (c) 2020 Robin Windey <[email protected]>
  *

tests/Integration/Composer/AutoloaderTest.php

@@ -46,7 +46,7 @@ protected function tearDown(): void {
 	public function testLoadDynamicClass(): void {
 		$rand = Server::get(ISecureRandom::class);
 		$className = ucfirst($rand->generate(10, ISecureRandom::CHAR_LOWER));
-		$namespace = "OCA\\WorkflowOcr";
+		$namespace = 'OCA\\WorkflowOcr';
 
 		file_put_contents(self::getClassPath($className), <<<FILE
 <?php

tests/Integration/Notification/AppFake.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @copyright Copyright (c) 2023 Robin Windey <[email protected]>
  *

tests/Integration/Notification/NotificationTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @copyright Copyright (c) 2023 Robin Windey <[email protected]>
  *

tests/TestUtils.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Nextcloud - Files_PhotoSpheres
  *

tests/Unit/BackgroundJobs/ProcessFileJobTest.php

@@ -183,8 +183,8 @@ public function testLogsNonOcrExceptionsFromOcrService() {
 
 	public function dataProvider_InvalidArguments() {
 		$arr = [
-			[null, "Argument is no array"],
-			[['mykey' => 'myvalue'], "Undefined array key"]
+			[null, 'Argument is no array'],
+			[['mykey' => 'myvalue'], 'Undefined array key']
 		];
 		return $arr;
 	}