feat(Documents): Reduced document folder column length, use microtime…

… to ensure folder uniqueness, refactored document utils
roadiz · Feb 26, 2025 · 9347f27 · 9347f27
1 parent 85bffff
commit 9347f27
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 66 deletions.
diff --git a/src/AbstractDocumentFactory.php b/src/AbstractDocumentFactory.php
@@ -8,7 +8,6 @@
 use League\Flysystem\FilesystemOperator;
 use League\Flysystem\MountManager;
 use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 use RZ\Roadiz\Documents\Models\DocumentInterface;
 use RZ\Roadiz\Documents\Models\FileHashInterface;
 use RZ\Roadiz\Documents\Models\FolderInterface;
@@ -23,23 +22,17 @@
  */
 abstract class AbstractDocumentFactory
 {
-    private LoggerInterface $logger;
     private ?File $file = null;
     private ?FolderInterface $folder = null;
-    private FilesystemOperator $documentsStorage;
-    private DocumentFinderInterface $documentFinder;
 
     public function __construct(
-        FilesystemOperator $documentsStorage,
-        DocumentFinderInterface $documentFinder,
-        ?LoggerInterface $logger = null,
+        protected readonly FilesystemOperator $documentsStorage,
+        protected readonly DocumentFinderInterface $documentFinder,
+        protected readonly LoggerInterface $logger,
     ) {
         if (!$documentsStorage instanceof MountManager) {
             trigger_error('Document Storage must be a MountManager to address public and private files.', E_USER_WARNING);
         }
-        $this->documentsStorage = $documentsStorage;
-        $this->documentFinder = $documentFinder;
-        $this->logger = $logger ?? new NullLogger();
     }
 
     public function getFile(): File
@@ -217,7 +210,7 @@ public function updateDocument(DocumentInterface $document): DocumentInterface
                 }
             }
 
-            $document->setFolder(\mb_substr(hash('crc32b', date('YmdHi')), 0, 12));
+            $document->setFolder(DocumentFolderGenerator::generateFolderName());
         }
 
         $document->setFilename($this->getFileName());

diff --git a/src/AverageColorResolver.php b/src/AverageColorResolver.php
@@ -6,7 +6,7 @@
 
 use Intervention\Image\Image;
 
-class AverageColorResolver
+final readonly class AverageColorResolver
 {
     public function getAverageColor(Image $image): string
     {

diff --git a/src/DocumentArchiver.php b/src/DocumentArchiver.php
@@ -14,9 +14,9 @@
 /**
  * Easily create and serve ZIP archives from your Roadiz documents.
  */
-final class DocumentArchiver
+final readonly class DocumentArchiver
 {
-    public function __construct(private readonly FilesystemOperator $documentsStorage)
+    public function __construct(private FilesystemOperator $documentsStorage)
     {
     }
 

diff --git a/src/DocumentFolderGenerator.php b/src/DocumentFolderGenerator.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RZ\Roadiz\Documents;
+
+final readonly class DocumentFolderGenerator
+{
+    /**
+     * Generate a random folder name for documents, 12 characters long.
+     */
+    public static function generateFolderName(): string
+    {
+        return \mb_substr(hash('crc32c', microtime()), 0, 12);
+    }
+}
diff --git a/src/DownscaleImageManager.php b/src/DownscaleImageManager.php
@@ -14,15 +14,15 @@
 use RZ\Roadiz\Documents\Models\DocumentInterface;
 use RZ\Roadiz\Documents\Models\FileHashInterface;
 
-final class DownscaleImageManager
+final readonly class DownscaleImageManager
 {
     public function __construct(
-        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',
+        private EntityManagerInterface $em,
+        private FilesystemOperator $documentsStorage,
+        private ImageManager $imageManager,
+        private ?LoggerInterface $logger = null,
+        private int $maxPixelSize = 0,
+        private string $rawImageSuffix = '.raw',
     ) {
     }
 

diff --git a/src/Models/DocumentInterface.php b/src/Models/DocumentInterface.php
@@ -66,6 +66,8 @@ public function getFolder(): string;
 
     /**
      * @return $this
+     *
+     * @internal You should use DocumentFactory to generate a document folder
      */
     public function setFolder(string $folder): static;
 

diff --git a/src/Models/DocumentTrait.php b/src/Models/DocumentTrait.php
@@ -5,7 +5,8 @@
 namespace RZ\Roadiz\Documents\Models;
 
 use ApiPlatform\Metadata\ApiProperty;
-use Symfony\Component\Serializer\Annotation as SymfonySerializer;
+use RZ\Roadiz\Documents\DocumentFolderGenerator;
+use Symfony\Component\Serializer\Annotation as Serializer;
 
 trait DocumentTrait
 {
@@ -29,7 +30,7 @@ trait DocumentTrait
      *
      * @internal
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     protected static array $mimeToIcon = [
         // Code
         'application/javascript' => 'code',
@@ -141,7 +142,7 @@ trait DocumentTrait
      *
      * @internal
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     protected static array $processableMimeTypes = [
         'image/png',
         'image/jpeg',
@@ -156,7 +157,7 @@ trait DocumentTrait
     /**
      * Get short type name for current document Mime type.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function getShortType(): string
     {
         if (null !== $this->getMimeType() && isset(static::$mimeToIcon[$this->getMimeType()])) {
@@ -169,7 +170,7 @@ public function getShortType(): string
     /**
      * Get short Mime type.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function getShortMimeType(): string
     {
         if (!empty($this->getMimeType())) {
@@ -184,7 +185,7 @@ public function getShortMimeType(): string
     /**
      * Is current document an image.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isImage(): bool
     {
         return 'image' === static::getShortType();
@@ -193,7 +194,7 @@ public function isImage(): bool
     /**
      * Is current document a vector SVG file.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isSvg(): bool
     {
         return 'image/svg+xml' === $this->getMimeType() || 'image/svg' === $this->getMimeType();
@@ -202,7 +203,7 @@ public function isSvg(): bool
     /**
      * Is current document a video.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isVideo(): bool
     {
         return 'video' === static::getShortType();
@@ -211,7 +212,7 @@ public function isVideo(): bool
     /**
      * Is current document an audio file.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isAudio(): bool
     {
         return 'audio' === static::getShortType();
@@ -220,21 +221,21 @@ public function isAudio(): bool
     /**
      * Is current document a PDF file.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isPdf(): bool
     {
         return 'pdf' === static::getShortType();
     }
 
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isWebp(): bool
     {
         return 'image/webp' === $this->getMimeType();
     }
 
     #[
-        SymfonySerializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
-        SymfonySerializer\SerializedName('relativePath'),
+        Serializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
+        Serializer\SerializedName('relativePath'),
     ]
     public function getRelativePath(): ?string
     {
@@ -246,8 +247,8 @@ public function getRelativePath(): ?string
     }
 
     #[
-        SymfonySerializer\Groups(['document_mount']),
-        SymfonySerializer\SerializedName('mountPath'),
+        Serializer\Groups(['document_mount']),
+        Serializer\SerializedName('mountPath'),
     ]
     public function getMountPath(): ?string
     {
@@ -262,7 +263,7 @@ public function getMountPath(): ?string
     }
 
     #[
-        SymfonySerializer\Ignore
+        Serializer\Ignore
     ]
     public function getMountFolderPath(): ?string
     {
@@ -280,20 +281,20 @@ public function getMountFolderPath(): ?string
     /**
      * Tells if current document has embed media information.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isEmbed(): bool
     {
         return !empty($this->getEmbedId()) && !empty($this->getEmbedPlatform());
     }
 
     protected function initDocumentTrait(): void
     {
-        $this->setFolder(\mb_substr(hash('crc32b', date('YmdHi')), 0, 12));
+        $this->setFolder(DocumentFolderGenerator::generateFolderName());
     }
 
     #[
-        SymfonySerializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
-        SymfonySerializer\SerializedName('processable'),
+        Serializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
+        Serializer\SerializedName('processable'),
         ApiProperty(
             description: 'Document can be processed as an image for resampling and other image operations.',
             writable: false,
@@ -305,8 +306,8 @@ public function isProcessable(): bool
     }
 
     #[
-        SymfonySerializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
-        SymfonySerializer\SerializedName('alt'),
+        Serializer\Groups(['document', 'document_display', 'nodes_sources', 'tag', 'attribute']),
+        Serializer\SerializedName('alt'),
     ]
     public function getAlternativeText(): string
     {
@@ -316,7 +317,7 @@ public function getAlternativeText(): string
     /**
      * Return false if no local file is linked to document. i.e no filename, no folder.
      */
-    #[SymfonySerializer\Ignore()]
+    #[Serializer\Ignore()]
     public function isLocal(): bool
     {
         return '' !== $this->getFilename() && '' !== $this->getFolder();

diff --git a/src/Repository/DocumentRepositoryInterface.php b/src/Repository/DocumentRepositoryInterface.php
@@ -5,9 +5,10 @@
 namespace RZ\Roadiz\Documents\Repository;
 
 use Doctrine\Persistence\ObjectRepository;
+use RZ\Roadiz\Documents\Models\DocumentInterface;
 
 /**
- * @template T of \RZ\Roadiz\Documents\Models\DocumentInterface
+ * @template T of DocumentInterface
  *
  * @template-extends ObjectRepository<T>
  *

diff --git a/src/Viewers/SvgDocumentViewer.php b/src/Viewers/SvgDocumentViewer.php
@@ -10,14 +10,8 @@
 use RZ\Roadiz\Documents\Models\DocumentInterface;
 use Symfony\Component\HttpFoundation\File\Exception\FileNotFoundException;
 
-class SvgDocumentViewer
+final class SvgDocumentViewer
 {
-    protected array $attributes;
-    protected bool $asObject = false;
-    protected string $imageUrl;
-    protected FilesystemOperator $documentsStorage;
-    protected DocumentInterface $document;
-
     /**
      * @var string[]
      */
@@ -28,22 +22,12 @@ class SvgDocumentViewer
         'class',
     ];
 
-    /**
-     * @param bool   $asObject Default false
-     * @param string $imageUrl only needed if you set $asObject to true
-     */
     public function __construct(
-        FilesystemOperator $documentsStorage,
-        DocumentInterface $document,
-        array $attributes = [],
-        bool $asObject = false,
-        string $imageUrl = '',
+        private readonly FilesystemOperator $documentsStorage,
+        private readonly DocumentInterface $document,
+        private readonly array $attributes = [],
+        private readonly bool $asObject = false,
     ) {
-        $this->imageUrl = $imageUrl;
-        $this->attributes = $attributes;
-        $this->asObject = $asObject;
-        $this->documentsStorage = $documentsStorage;
-        $this->document = $document;
     }
 
     /**
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,6 +66,8 @@ public function getFolder(): string; @@
         /**
          * @return $this
+         *
+         * @internal You should use DocumentFactory to generate a document folder
          */
         public function setFolder(string $folder): static;
@@ Expand Down @@