Merge branch hotfix/v2.3.28

roadiz · Sep 24, 2024 · 1e9501d · 1e9501d
1 parent c6b0956
commit 1e9501d
Show file tree

Hide file tree

Showing 39 changed files with 1,440 additions and 2,085 deletions.
diff --git a/.github/workflows/run-test.yml b/.github/workflows/run-test.yml
@@ -19,7 +19,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.0', '8.1']
+                php-version: ['8.1', '8.2', '8.3']
         steps:
             - uses: shivammathur/setup-php@v2
               with:
@@ -35,8 +35,8 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run atoum unit tests
-              run: vendor/bin/atoum -d tests
+            - name: Run Unit tests
+              run: vendor/bin/phpunit -v --whitelist ./src tests
             - name: Run PHP Code Sniffer
               run: vendor/bin/phpcs -p ./src
             - name: Run PHPStan

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,3 @@
-#
-# Roadiz
-#
-/pimple.json
 
 # Ignore Google webmaster tool verification
 /google*.html

diff --git a/.travis.yml b/.travis.yml
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2023 Ambroise Maupate
+Copyright © 2024 Ambroise Maupate
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

diff --git a/Makefile b/Makefile
diff --git a/composer.json b/composer.json
@@ -18,33 +18,34 @@
         }
     ],
     "require": {
-        "php": ">=8.0",
+        "php": ">=8.1",
         "ext-json": "*",
         "ext-gd": "*",
         "ext-dom": "*",
         "ext-zip": "*",
         "ext-simplexml": "*",
         "ext-fileinfo": "*",
-        "doctrine/orm": "<2.17",
+        "doctrine/orm": "~2.19.0",
         "enshrined/svg-sanitize": "^0.15",
         "guzzlehttp/guzzle": "^7.2.0",
         "guzzlehttp/psr7": "^2.0",
         "intervention/image": "^2.5",
         "league/flysystem": "^3.0",
         "monolog/monolog": "^1.24.0 || ^2.1.1",
-        "symfony/asset": "5.4.*",
-        "symfony/console": "5.4.*",
-        "symfony/event-dispatcher": "5.4.*",
-        "symfony/filesystem": "5.4.*",
-        "symfony/finder": "5.4.*",
-        "symfony/http-foundation": "5.4.*",
-        "symfony/options-resolver": "5.4.*",
-        "symfony/serializer": "5.4.*",
+        "symfony/asset": "6.4.*",
+        "symfony/console": "6.4.*",
+        "symfony/event-dispatcher": "6.4.*",
+        "symfony/filesystem": "6.4.*",
+        "symfony/finder": "6.4.*",
+        "symfony/http-foundation": "6.4.*",
+        "symfony/options-resolver": "6.4.*",
+        "symfony/serializer": "6.4.*",
         "twig/twig": "^3.1"
     },
     "require-dev": {
         "php-coveralls/php-coveralls": "^2.4",
-        "atoum/atoum": "^4.0.0",
+        "phpunit/phpunit": "^9.5",
+        "api-platform/metadata": "^3.2.12",
         "squizlabs/php_codesniffer": "^3.5",
         "phpstan/phpstan": "^1.5.3",
         "phpstan/phpstan-doctrine": "^1.3"
@@ -54,6 +55,11 @@
             "RZ\\Roadiz\\Documents\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "RZ\\Roadiz\\Documents\\Tests\\": "tests/"
+        }
+    },
     "config": {
         "allow-plugins": {
             "composer/package-versions-deprecated": true,
@@ -62,8 +68,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.1.x-dev",
-            "dev-develop": "2.2.x-dev"
+            "dev-master": "2.3.x-dev",
+            "dev-develop": "2.4.x-dev"
         }
     }
 }
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,12 +1,14 @@
 parameters:
-    level: max
+    level: 7
     paths:
         - src
     excludePaths:
         - */node_modules/*
         - */bower_components/*
         - */static/*
     ignoreErrors:
+        - identifier: missingType.iterableValue
+        - identifier: missingType.generics
         - '#Call to an undefined method Doctrine\\Persistence\\ObjectRepository#'
         - '#Call to an undefined method Doctrine\\Persistence\\ObjectManager#'
         - '#Call to an undefined method Doctrine\\ORM\\EntityRepository#'
@@ -17,9 +19,9 @@ parameters:
         - '#Doctrine\\ORM\\Mapping\\GeneratedValue constructor expects#'
         - '#type mapping mismatch: property can contain Doctrine\\Common\\Collections\\Collection<int, [^\>]+> but database expects Doctrine\\Common\\Collections\\Collection&iterable<[^\>]+>#'
         - '#should return Doctrine\\Common\\Collections\\Collection<int, [^\>]+Interface> but returns Doctrine\\Common\\Collections\\Collection<int, [^\>]+>#'
+        - '#but returns Doctrine\\Common\\Collections\\ReadableCollection<int, [^\>]+>#'
+        - '#does not accept Doctrine\\Common\\Collections\\ReadableCollection<int, [^\>]+>#'
     reportUnmatchedIgnoredErrors: false
-    checkMissingIterableValueType: false
-    checkGenericClassInNonGenericObjectType: false
 
 includes:
     - vendor/phpstan/phpstan-doctrine/extension.neon

diff --git a/src/AbstractDocumentFinder.php b/src/AbstractDocumentFinder.php
@@ -53,7 +53,10 @@ public function findPicturesWithFilename(string $fileName): iterable
     {
         $pathInfo = pathinfo($fileName);
         $basename = $pathInfo['filename'];
-        $currentExtension = $pathInfo['extension'];
+        $currentExtension = $pathInfo['extension'] ?? null;
+        if (null === $currentExtension) {
+            return [];
+        }
         $extensionsList = [
             'jpg',
             'gif',

diff --git a/src/Console/DocumentClearFolderCommand.php b/src/Console/DocumentClearFolderCommand.php
@@ -36,9 +36,9 @@ protected function getDocumentQueryBuilder(FolderInterface $folder): QueryBuilde
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $this->io = new SymfonyStyle($input, $output);
+        $folderId = $input->getArgument('folderId');
 
-        $folderId = intval($input->getArgument('folderId'));
-        if ($folderId <= 0) {
+        if (!\is_numeric($folderId) || $folderId <= 0) {
             throw new \InvalidArgumentException('Folder ID must be a valid ID');
         }
         $em = $this->getManager();

diff --git a/src/DocumentArchiver.php b/src/DocumentArchiver.php
@@ -16,21 +16,18 @@
  */
 final class DocumentArchiver
 {
-    private FilesystemOperator $documentsStorage;
-
-    public function __construct(FilesystemOperator $documentsStorage)
+    public function __construct(private readonly FilesystemOperator $documentsStorage)
     {
-        $this->documentsStorage = $documentsStorage;
     }
 
     /**
-     * @param array $documents
+     * @param iterable<DocumentInterface> $documents
      * @param string $name
      * @param bool $keepFolders
      * @return string Zip file path
      * @throws FilesystemException
      */
-    public function archive(array $documents, string $name, bool $keepFolders = true): string
+    public function archive(iterable $documents, string $name, bool $keepFolders = true): string
     {
         $filename = (new AsciiSlugger())->slug($name . ' ' . date('YmdHis'), '_') . '.zip';
         $tmpFileName = sys_get_temp_dir() . DIRECTORY_SEPARATOR . $filename;
@@ -60,8 +57,16 @@ public function archive(array $documents, string $name, bool $keepFolders = true
         return $tmpFileName;
     }
 
+    /**
+     * @param iterable<DocumentInterface> $documents
+     * @param string $name
+     * @param bool $keepFolders
+     * @param bool $unlink
+     * @return BinaryFileResponse
+     * @throws FilesystemException
+     */
     public function archiveAndServe(
-        array $documents,
+        iterable $documents,
         string $name,
         bool $keepFolders = true,
         bool $unlink = true

diff --git a/src/DownscaleImageManager.php b/src/DownscaleImageManager.php
@@ -16,27 +16,14 @@
 
 final class DownscaleImageManager
 {
-    protected EntityManagerInterface $em;
-    protected ?LoggerInterface $logger;
-    protected int $maxPixelSize = 0;
-    protected string $rawImageSuffix = ".raw";
-    protected ImageManager $imageManager;
-    private FilesystemOperator $documentsStorage;
-
     public function __construct(
-        EntityManagerInterface $em,
-        FilesystemOperator $documentsStorage,
-        ImageManager $imageManager,
-        ?LoggerInterface $logger = null,
-        int $maxPixelSize = 0,
-        string $rawImageSuffix = ".raw"
+        private readonly EntityManagerInterface $em,
+        private readonly FilesystemOperator $documentsStorage,
+        private readonly ImageManager $imageManager,
+        private readonly ?LoggerInterface $logger = null,
+        private readonly int $maxPixelSize = 0,
+        private readonly string $rawImageSuffix = ".raw"
     ) {
-        $this->maxPixelSize = $maxPixelSize;
-        $this->rawImageSuffix = $rawImageSuffix;
-        $this->em = $em;
-        $this->logger = $logger;
-        $this->imageManager = $imageManager;
-        $this->documentsStorage = $documentsStorage;
     }
 
     /**
@@ -97,7 +84,7 @@ public function processDocumentFromExistingRaw(?DocumentInterface $document = nu
                     null !== $this->createDocumentFromImage($document, $processImage, true)
                     && null !== $this->logger
                 ) {
-                    $this->logger->info('Document has been downscaled.', ['path' => $documentPath]);
+                    $this->logger->info('Document has been downscaled.', ['path' => $documentPath, 'entity' => $document]);
                 }
             }
         }

diff --git a/src/Events/DocumentLifeCycleSubscriber.php b/src/Events/DocumentLifeCycleSubscriber.php
@@ -10,7 +10,6 @@
 use Doctrine\Persistence\Event\LifecycleEventArgs;
 use League\Flysystem\FilesystemException;
 use League\Flysystem\FilesystemOperator;
-use League\Flysystem\UnableToMoveFile;
 use League\Flysystem\Visibility;
 use RZ\Roadiz\Documents\Exceptions\DocumentWithoutFileException;
 use RZ\Roadiz\Documents\Models\DocumentInterface;
@@ -52,19 +51,9 @@ public function preUpdate(PreUpdateEventArgs $args): void
             && is_string($args->getNewValue('filename'))
             && $args->getOldValue('filename') !== ''
         ) {
-            $oldPath = $this->getDocumentMountPathForFilename($document, $args->getOldValue('filename'));
-            $newPath = $this->getDocumentMountPathForFilename($document, $args->getNewValue('filename'));
-
-            if ($oldPath !== $newPath) {
-                if ($this->documentsStorage->fileExists($oldPath) && !$this->documentsStorage->fileExists($newPath)) {
-                    /*
-                     * Only perform IO rename if old file exists and new path is free.
-                     */
-                    $this->documentsStorage->move($oldPath, $newPath);
-                } else {
-                    throw new UnableToMoveFile('Cannot rename file from ' . $oldPath . ' to ' . $newPath);
-                }
-            }
+            // This method must not throw any exception
+            // because filename WILL change if document file is updated too.
+            $this->renameDocumentFilename($document, $args);
         }
         if ($document instanceof DocumentInterface && $args->hasChangedField('private')) {
             if ($document->isPrivate() === true) {
@@ -75,6 +64,29 @@ public function preUpdate(PreUpdateEventArgs $args): void
         }
     }
 
+    private function renameDocumentFilename(DocumentInterface $document, PreUpdateEventArgs $args): void
+    {
+        $oldPath = $this->getDocumentMountPathForFilename($document, $args->getOldValue('filename'));
+        $newPath = $this->getDocumentMountPathForFilename($document, $args->getNewValue('filename'));
+
+        if ($oldPath === $newPath) {
+            return;
+        }
+
+        if (!$this->documentsStorage->fileExists($oldPath)) {
+            // Do not throw, just return
+            return;
+        }
+        if ($this->documentsStorage->fileExists($newPath)) {
+            // Do not throw, just return
+            return;
+        }
+        /*
+         * Only perform IO rename if old file exists and new path is free.
+         */
+        $this->documentsStorage->move($oldPath, $newPath);
+    }
+
     /**
      * @param DocumentInterface $document
      * @param PreUpdateEventArgs $args

diff --git a/src/Exceptions/DocumentWithoutFileException.php b/src/Exceptions/DocumentWithoutFileException.php
@@ -8,17 +8,11 @@
 
 final class DocumentWithoutFileException extends \RuntimeException
 {
-    private DocumentInterface $document;
-
-    public function __construct(DocumentInterface $document)
+    public function __construct(private readonly DocumentInterface $document)
     {
-        $this->document = $document;
         parent::__construct(sprintf('Document (%s) does not have a file on system.', (string) $document));
     }
 
-    /**
-     * @return DocumentInterface
-     */
     public function getDocument(): DocumentInterface
     {
         return $this->document;

diff --git a/src/Models/AdvancedDocumentInterface.php b/src/Models/AdvancedDocumentInterface.php
@@ -4,19 +4,8 @@
 
 namespace RZ\Roadiz\Documents\Models;
 
-interface AdvancedDocumentInterface extends DocumentInterface, SizeableInterface
+interface AdvancedDocumentInterface extends DocumentInterface, SizeableInterface, DisplayableInterface
 {
-    /**
-     * @return string|null
-     */
-    public function getImageAverageColor(): ?string;
-
-    /**
-     * @param string|null $imageAverageColor
-     * @return $this
-     */
-    public function setImageAverageColor(?string $imageAverageColor): static;
-
     /**
      * @return int|null
      */

diff --git a/src/Models/DocumentInterface.php b/src/Models/DocumentInterface.php
@@ -156,7 +156,7 @@ public function setRawDocument(?DocumentInterface $rawDocument = null): static;
     public function isRaw(): bool;
 
     /**
-     * @param boolean $raw the raw
+     * @param bool $raw the raw
      * @return $this
      */
     public function setRaw(bool $raw): static;