DirectoryListingService

Author: tatevikg1

config/services/services.yml

@@ -272,6 +272,10 @@ services:
     autowire: true
     autoconfigure: true
 
+  PhpList\Core\Domain\Common\Upload\Service\DirectoryListingService:
+    autowire: true
+    autoconfigure: true
+
   PhpList\Core\Domain\Common\Storage\UploadStorageInterface:
     alias: PhpList\Core\Domain\Common\Storage\LocalUploadStorage
 

config/services/validators.yml

@@ -14,3 +14,7 @@ services:
   PhpList\Core\Domain\Common\Validator\UploadValidator:
     autowire: true
     autoconfigure: true
+
+  PhpList\Core\Domain\Common\Validator\UploadDirectoryValidator:
+    autowire: true
+    autoconfigure: true

public/uploads/.gitkeep

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Common\Service;
+
+use RuntimeException;
+
+class DirectoryListingService
+{
+    /**
+     * @return array<int, array{
+     *     name: string,
+     *     path: string,
+     *     size: int,
+     *     type: string,
+     *     modified: int
+     * }>
+     */
+    public function list(string $directory, string $realPath): array
+    {
+        $items = $this->readDirectory($realPath, $directory);
+
+        $files = [];
+
+        foreach ($items as $item) {
+            $entry = $this->createEntry($directory, $realPath, $item);
+
+            if ($entry !== null) {
+                $files[] = $entry;
+            }
+        }
+
+        $this->sortFiles($files);
+
+        return $files;
+    }
+
+    private function readDirectory(string $realPath, string $directory): array
+    {
+        $items = scandir($realPath);
+
+        if ($items === false) {
+            throw new RuntimeException(
+                sprintf('Unable to read directory "%s".', $directory)
+            );
+        }
+
+        return $items;
+    }
+
+    private function sortFiles(array &$files): void
+    {
+        usort(
+            $files,
+            static function (array $file1, array $file2): int {
+                if ($file1['type'] !== $file2['type']) {
+                    return $file1['type'] === 'directory' ? -1 : 1;
+                }
+
+                return strcmp($file1['name'], $file2['name']);
+            }
+        );
+    }
+
+    /**
+     * @return array{
+     *     name:string,
+     *     path:string,
+     *     size:int,
+     *     type:string,
+     *     modified:int
+     * }|null
+     */
+    private function createEntry(string $directory, string $realPath, string $item,): ?array
+    {
+        if ($item === '.' || $item === '..') {
+            return null;
+        }
+
+        $fullPath = $realPath . DIRECTORY_SEPARATOR . $item;
+
+        if (!is_file($fullPath) && !is_dir($fullPath)) {
+            return null;
+        }
+
+        $isDirectory = is_dir($fullPath);
+
+        return [
+            'name' => $item,
+            'path' => '/' . trim($directory, '/') . '/' . $item,
+            'size' => $isDirectory ? 0 : (filesize($fullPath) ?: 0),
+            'type' => $isDirectory ? 'directory' : 'file',
+            'modified' => filemtime($fullPath) ?: 0,
+        ];
+    }
+}

src/Domain/Common/Service/DirectoryListingService.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpList\Core\Domain\Common\Validator;
+
+use Symfony\Component\DependencyInjection\Attribute\Autowire;
+use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
+use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
+
+class UploadDirectoryValidator
+{
+    public function __construct(
+        #[Autowire('%kernel.project_dir%/public')]
+        private readonly string $publicPath,
+    ) {
+    }
+
+    public function validate(string $directory): string
+    {
+        $directory = trim($directory);
+
+        if ($directory === '') {
+            throw new BadRequestHttpException('Directory name cannot be empty.');
+        }
+
+        if (!preg_match('#^[A-Za-z0-9/_-]+$#', $directory)) {
+            throw new BadRequestHttpException('Invalid directory name.');
+        }
+
+        $requestedPath = $this->publicPath . '/' . ltrim($directory, '/');
+
+        $realBasePath = realpath($this->publicPath);
+        $realRequestedPath = realpath($requestedPath);
+
+        if ($realBasePath === false || $realRequestedPath === false) {
+            throw new NotFoundHttpException(sprintf('Directory "%s" not found.', $directory));
+        }
+
+        if (!str_starts_with($realRequestedPath, $realBasePath . DIRECTORY_SEPARATOR)
+            && $realRequestedPath !== $realBasePath) {
+            throw new BadRequestHttpException('Invalid directory.');
+        }
+
+        if (!is_dir($realRequestedPath)) {
+            throw new NotFoundHttpException(sprintf('Directory "%s" not found.', $directory));
+        }
+
+        return $realRequestedPath;
+    }
+}