From d171b5f557b915c0a8d66d51951810bfba41f1fa Mon Sep 17 00:00:00 2001 From: Arman <407448+armanist@users.noreply.github.com> Date: Fri, 1 May 2026 21:07:25 +0400 Subject: [PATCH] [#494] Refactor UploadedFile into upload collaborators --- .../DemoWeb/src/Views/partials/footer.php.tpl | 2 +- src/Storage/UploadedFile.php | 114 ++++++------------ src/Storage/Uploads/UploadConfigProvider.php | 60 +++++++++ src/Storage/Uploads/UploadPolicy.php | 77 ++++++++++++ src/Storage/Uploads/UploadStorage.php | 44 +++++++ tests/Unit/Storage/UploadedFileTest.php | 28 ++--- .../Uploads/UploadConfigProviderTest.php | 33 +++++ .../Unit/Storage/Uploads/UploadPolicyTest.php | 48 ++++++++ .../Storage/Uploads/UploadStorageTest.php | 76 ++++++++++++ 9 files changed, 382 insertions(+), 100 deletions(-) create mode 100644 src/Storage/Uploads/UploadConfigProvider.php create mode 100644 src/Storage/Uploads/UploadPolicy.php create mode 100644 src/Storage/Uploads/UploadStorage.php create mode 100644 tests/Unit/Storage/Uploads/UploadConfigProviderTest.php create mode 100644 tests/Unit/Storage/Uploads/UploadPolicyTest.php create mode 100644 tests/Unit/Storage/Uploads/UploadStorageTest.php diff --git a/src/Module/Templates/DemoWeb/src/Views/partials/footer.php.tpl b/src/Module/Templates/DemoWeb/src/Views/partials/footer.php.tpl index d085c4a0..466c7c48 100644 --- a/src/Module/Templates/DemoWeb/src/Views/partials/footer.php.tpl +++ b/src/Module/Templates/DemoWeb/src/Views/partials/footer.php.tpl @@ -2,7 +2,7 @@
- © 2018 - + © 2018 -
diff --git a/src/Storage/UploadedFile.php b/src/Storage/UploadedFile.php index 91251f9d..ea19b689 100644 --- a/src/Storage/UploadedFile.php +++ b/src/Storage/UploadedFile.php @@ -20,18 +20,18 @@ use Quantum\Storage\Contracts\FilesystemAdapterInterface; use Quantum\Storage\Exceptions\FileSystemException; use Quantum\Storage\Exceptions\FileUploadException; -use Quantum\Loader\Exceptions\LoaderException; +use Quantum\Storage\Uploads\UploadConfigProvider; use Quantum\Config\Exceptions\ConfigException; +use Quantum\Loader\Exceptions\LoaderException; use Quantum\Lang\Exceptions\LangException; +use Quantum\Storage\Uploads\UploadStorage; use Quantum\App\Exceptions\BaseException; +use Quantum\Storage\Uploads\UploadPolicy; use Quantum\Di\Exceptions\DiException; use Gumlet\ImageResizeException; -use Quantum\Loader\Loader; -use Quantum\Loader\Setup; use ReflectionException; use Gumlet\ImageResize; use RuntimeException; -use Quantum\Di\Di; use SplFileInfo; use finfo; @@ -123,6 +123,10 @@ class UploadedFile extends SplFileInfo */ protected bool $mimeTypesOverridden = false; + private ?UploadPolicy $uploadPolicy = null; + + private ?UploadStorage $uploadStorage = null; + /** * @param array $meta */ @@ -140,7 +144,8 @@ public function __construct(array $meta) */ public function setAllowedMimeTypes(array $allowedMimeTypes, bool $merge = true): UploadedFile { - $this->setAllowedMimeTypesMap($allowedMimeTypes, $merge); + $policy = $this->getUploadPolicy(); + $merge ? $policy->merge($allowedMimeTypes) : $policy->replace($allowedMimeTypes); $this->mimeTypesOverridden = true; $this->mimeTypesLoaded = true; return $this; @@ -281,7 +286,7 @@ public function save(string $dest, bool $overwrite = false): bool throw FileUploadException::fileNotFound($this->getPathname()); } - if (!$this->allowed($this->getExtension(), $this->getMimeType())) { + if (!$this->getUploadPolicy()->isAllowed($this->getExtension(), $this->getMimeType())) { throw FileUploadException::fileTypeNotAllowed($this->getExtension()); } @@ -301,7 +306,7 @@ public function save(string $dest, bool $overwrite = false): bool } } - if (!$this->moveUploadedFile($filePath)) { + if (!$this->getUploadStorage()->store($this, $filePath, $this->remoteFileSystem)) { return false; } @@ -365,22 +370,6 @@ public function isImage(string $filePath): bool return (bool) getimagesize($filePath); } - /** - * Moves an uploaded file to a new location - */ - protected function moveUploadedFile(string $filePath): bool - { - $localFileSystem = $this->getLocalFileSystem(); - - if ($this->remoteFileSystem) { - return (bool) $this->remoteFileSystem->put($filePath, $localFileSystem->get($this->getPathname())); - } elseif ($this->isUploaded()) { - return move_uploaded_file($this->getPathname(), $filePath); - } else { - return $localFileSystem->copy($this->getPathname(), $filePath); - } - } - /** * @throws ConfigException|DiException|BaseException|ReflectionException */ @@ -413,64 +402,12 @@ private function ensureAllowedMimeTypesLoaded(): void return; } - $this->loadAllowedMimeTypesFromConfig(); + $this->getUploadPolicy()->merge( + (new UploadConfigProvider())->getAllowedMimeTypesMap() + ); $this->mimeTypesLoaded = true; } - /** - * Validates upload against allowed mime types => extensions map - */ - protected function allowed(string $extension, string $mimeType): bool - { - $extension = strtolower($extension); - $mimeType = strtolower($mimeType); - - return isset($this->allowedMimeTypes[$mimeType]) && - in_array($extension, $this->allowedMimeTypes[$mimeType], true); - } - - /** - * Loads allowed mime types from config (shared/config/uploads.php) if present. - * @throws FileUploadException|LoaderException|ConfigException|DiException|ReflectionException - */ - protected function loadAllowedMimeTypesFromConfig(): void - { - if (!config()->has('uploads')) { - if (!Di::isRegistered(Loader::class)) { - Di::register(Loader::class); - } - - $loader = Di::get(Loader::class); - $setup = new Setup('config', 'uploads'); - $loader->setup($setup); - - if (!$loader->fileExists()) { - return; - } - - config()->import($setup); - } - - $allowedMimeTypesMap = config()->get('uploads.allowed_mime_types') ?? []; - - if (!is_array($allowedMimeTypesMap)) { - throw FileUploadException::incorrectMimeTypesConfig('uploads'); - } - - if ($allowedMimeTypesMap !== []) { - $this->setAllowedMimeTypesMap($allowedMimeTypesMap); - } - } - - /** - * Sets the allowed mime types => extensions map - * @param array $allowedMimeTypes - */ - protected function setAllowedMimeTypesMap(array $allowedMimeTypes, bool $merge = true): void - { - $this->allowedMimeTypes = $merge ? array_merge_recursive($this->allowedMimeTypes, $allowedMimeTypes) : $allowedMimeTypes; - } - /** * Applies modifications on image * @param string $filePath @@ -490,4 +427,25 @@ protected function applyModifications(string $filePath) $image->save($filePath); } + + private function getUploadPolicy(): UploadPolicy + { + if (!$this->uploadPolicy) { + $this->uploadPolicy = new UploadPolicy($this->allowedMimeTypes); + } + + return $this->uploadPolicy; + } + + /** + * @throws ConfigException|DiException|BaseException|ReflectionException + */ + private function getUploadStorage(): UploadStorage + { + if (!$this->uploadStorage) { + $this->uploadStorage = new UploadStorage($this->getLocalFileSystem()); + } + + return $this->uploadStorage; + } } diff --git a/src/Storage/Uploads/UploadConfigProvider.php b/src/Storage/Uploads/UploadConfigProvider.php new file mode 100644 index 00000000..c3a8b3b8 --- /dev/null +++ b/src/Storage/Uploads/UploadConfigProvider.php @@ -0,0 +1,60 @@ + + * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) + * @link http://quantum.softberg.org/ + * @since 3.0.0 + */ + +namespace Quantum\Storage\Uploads; + +use Quantum\Storage\Exceptions\FileUploadException; +use Quantum\Loader\Exceptions\LoaderException; +use Quantum\Config\Exceptions\ConfigException; +use Quantum\Di\Exceptions\DiException; +use Quantum\Loader\Loader; +use Quantum\Loader\Setup; +use ReflectionException; +use Quantum\Di\Di; + +class UploadConfigProvider +{ + /** + * @return array> + * @throws FileUploadException|LoaderException|ConfigException|DiException|ReflectionException + */ + public function getAllowedMimeTypesMap(): array + { + if (!config()->has('uploads')) { + if (!Di::isRegistered(Loader::class)) { + Di::register(Loader::class); + } + + $loader = Di::get(Loader::class); + $setup = new Setup('config', 'uploads'); + $loader->setup($setup); + + if (!$loader->fileExists()) { + return []; + } + + config()->import($setup); + } + + $allowedMimeTypesMap = config()->get('uploads.allowed_mime_types') ?? []; + + if (!is_array($allowedMimeTypesMap)) { + throw FileUploadException::incorrectMimeTypesConfig('uploads'); + } + + return $allowedMimeTypesMap; + } +} diff --git a/src/Storage/Uploads/UploadPolicy.php b/src/Storage/Uploads/UploadPolicy.php new file mode 100644 index 00000000..8b5c3a13 --- /dev/null +++ b/src/Storage/Uploads/UploadPolicy.php @@ -0,0 +1,77 @@ + + * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) + * @link http://quantum.softberg.org/ + * @since 3.0.0 + */ + +namespace Quantum\Storage\Uploads; + +/** + * Holds upload MIME policy rules and validates extension/MIME pairs. + */ +class UploadPolicy +{ + /** + * @var array> + */ + private array $allowedMimeTypes; + + /** + * @param array|string> $allowedMimeTypes + */ + public function __construct(array $allowedMimeTypes) + { + $this->allowedMimeTypes = $this->normalize($allowedMimeTypes); + } + + /** + * @param array|string> $allowedMimeTypes + */ + public function merge(array $allowedMimeTypes): void + { + $this->allowedMimeTypes = array_merge_recursive($this->allowedMimeTypes, $this->normalize($allowedMimeTypes)); + } + + /** + * @param array|string> $allowedMimeTypes + */ + public function replace(array $allowedMimeTypes): void + { + $this->allowedMimeTypes = $this->normalize($allowedMimeTypes); + } + + public function isAllowed(string $extension, string $mimeType): bool + { + $extension = strtolower($extension); + $mimeType = strtolower($mimeType); + + return isset($this->allowedMimeTypes[$mimeType]) + && in_array($extension, $this->allowedMimeTypes[$mimeType], true); + } + + /** + * @param array|string> $allowedMimeTypes + * @return array> + */ + private function normalize(array $allowedMimeTypes): array + { + $normalized = []; + + foreach ($allowedMimeTypes as $mimeType => $extensions) { + $values = is_array($extensions) ? $extensions : [$extensions]; + $normalized[$mimeType] = array_values(array_map('strval', $values)); + } + + return $normalized; + } +} diff --git a/src/Storage/Uploads/UploadStorage.php b/src/Storage/Uploads/UploadStorage.php new file mode 100644 index 00000000..6a16ad57 --- /dev/null +++ b/src/Storage/Uploads/UploadStorage.php @@ -0,0 +1,44 @@ + + * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org) + * @link http://quantum.softberg.org/ + * @since 3.0.0 + */ + +namespace Quantum\Storage\Uploads; + +use Quantum\Storage\Contracts\LocalFilesystemAdapterInterface; +use Quantum\Storage\Contracts\FilesystemAdapterInterface; +use Quantum\Storage\UploadedFile; + +class UploadStorage +{ + private LocalFilesystemAdapterInterface $localFileSystem; + + public function __construct(LocalFilesystemAdapterInterface $localFileSystem) + { + $this->localFileSystem = $localFileSystem; + } + + public function store(UploadedFile $file, string $targetPath, ?FilesystemAdapterInterface $remoteFileSystem = null): bool + { + if ($remoteFileSystem) { + return (bool) $remoteFileSystem->put($targetPath, $this->localFileSystem->get($file->getPathname())); + } + + if ($file->isUploaded()) { + return move_uploaded_file($file->getPathname(), $targetPath); + } + + return $this->localFileSystem->copy($file->getPathname(), $targetPath); + } +} diff --git a/tests/Unit/Storage/UploadedFileTest.php b/tests/Unit/Storage/UploadedFileTest.php index 5982253c..88776398 100644 --- a/tests/Unit/Storage/UploadedFileTest.php +++ b/tests/Unit/Storage/UploadedFileTest.php @@ -10,20 +10,6 @@ use Quantum\Storage\UploadedFile; use Mockery; -class UploadedDouble extends UploadedFile -{ - public function isUploaded(): bool - { - return file_exists($this->getPathname()); - } - - protected function moveUploadedFile(string $filePath): bool - { - return copy($this->getPathname(), $filePath); - } - -} - class UploadedFileTest extends AppTestCase { private array $fileMeta; @@ -139,7 +125,7 @@ public function testUploadedFileUploadWithoutFileSent(): void public function testUploadedFileUploadAndSave(): void { - $uploadedFile = new UploadedDouble($this->fileMeta); + $uploadedFile = new UploadedFile($this->fileMeta); $this->assertInstanceOf(UploadedFile::class, $uploadedFile); @@ -153,7 +139,7 @@ public function testUploadedFileUploadNotAllowedExtensionForMimeType(): void $fileMeta = $this->fileMeta; $fileMeta['name'] = 'foo.php'; - $uploadedFile = new UploadedDouble($fileMeta); + $uploadedFile = new UploadedFile($fileMeta); $this->expectException(FileUploadException::class); $this->expectExceptionMessage('The file type `php` is not allowed.'); @@ -167,7 +153,7 @@ public function testUploadedFileUploadNotAllowedMimeType(): void $fileMeta['name'] = 'foo.jpg'; $fileMeta['tmp_name'] = base_dir() . DS . 'journal.log'; - $uploadedFile = new UploadedDouble($fileMeta); + $uploadedFile = new UploadedFile($fileMeta); $this->expectException(FileUploadException::class); $this->expectExceptionMessage('The file type `jpg` is not allowed.'); @@ -181,7 +167,7 @@ public function testUploadedFileUploadAllowedAfterSetterOverride(): void $fileMeta['name'] = 'foo.txt'; $fileMeta['tmp_name'] = base_dir() . DS . 'journal.log'; - $uploadedFile = new UploadedDouble($fileMeta); + $uploadedFile = new UploadedFile($fileMeta); $uploadedFile->setAllowedMimeTypes([ $uploadedFile->getMimeType() => ['txt'], @@ -193,7 +179,7 @@ public function testUploadedFileUploadAllowedAfterSetterOverride(): void public function testUploadedFileSaveAndTryOverwrite(): void { - $uploadedFile = new UploadedDouble($this->fileMeta); + $uploadedFile = new UploadedFile($this->fileMeta); $uploadedFile->save(base_dir()); @@ -210,7 +196,7 @@ public function testUploadedFileSaveAndTryOverwrite(): void public function testUploadedFileSaveAndOverwrite(): void { - $uploadedFile = new UploadedDouble($this->fileMeta); + $uploadedFile = new UploadedFile($this->fileMeta); $uploadedFile->save(base_dir()); @@ -221,7 +207,7 @@ public function testUploadedFileSaveAndOverwrite(): void public function testUploadedFileModifyAndSave(): void { - $uploadedFile = new UploadedDouble($this->fileMeta); + $uploadedFile = new UploadedFile($this->fileMeta); $uploadedFile->modify('crop', [100, 100]); diff --git a/tests/Unit/Storage/Uploads/UploadConfigProviderTest.php b/tests/Unit/Storage/Uploads/UploadConfigProviderTest.php new file mode 100644 index 00000000..321838df --- /dev/null +++ b/tests/Unit/Storage/Uploads/UploadConfigProviderTest.php @@ -0,0 +1,33 @@ +set('uploads', ['allowed_mime_types' => ['text/plain' => ['txt']]]); + + $provider = new UploadConfigProvider(); + $map = $provider->getAllowedMimeTypesMap(); + + $this->assertSame(['text/plain' => ['txt']], $map); + } + + public function testThrowsWhenConfiguredMimeTypesAreInvalid(): void + { + config()->set('uploads', ['allowed_mime_types' => 'invalid']); + + $provider = new UploadConfigProvider(); + + try { + $provider->getAllowedMimeTypesMap(); + $this->fail('Expected an exception for invalid uploads.allowed_mime_types config'); + } catch (\Throwable $e) { + $this->assertStringContainsString('uploads', $e->getMessage()); + } + } +} diff --git a/tests/Unit/Storage/Uploads/UploadPolicyTest.php b/tests/Unit/Storage/Uploads/UploadPolicyTest.php new file mode 100644 index 00000000..c8022776 --- /dev/null +++ b/tests/Unit/Storage/Uploads/UploadPolicyTest.php @@ -0,0 +1,48 @@ + ['jpg', 'jpeg'], + ]); + + $this->assertTrue($policy->isAllowed('jpg', 'image/jpeg')); + $this->assertFalse($policy->isAllowed('png', 'image/jpeg')); + } + + public function testMergeAddsMoreAllowedEntries(): void + { + $policy = new UploadPolicy([ + 'image/jpeg' => ['jpg'], + ]); + + $policy->merge([ + 'image/jpeg' => ['jpeg'], + 'image/png' => ['png'], + ]); + + $this->assertTrue($policy->isAllowed('jpeg', 'image/jpeg')); + $this->assertTrue($policy->isAllowed('png', 'image/png')); + } + + public function testReplaceOverridesExistingRules(): void + { + $policy = new UploadPolicy([ + 'image/jpeg' => ['jpg'], + ]); + + $policy->replace([ + 'text/plain' => ['txt'], + ]); + + $this->assertFalse($policy->isAllowed('jpg', 'image/jpeg')); + $this->assertTrue($policy->isAllowed('txt', 'text/plain')); + } +} diff --git a/tests/Unit/Storage/Uploads/UploadStorageTest.php b/tests/Unit/Storage/Uploads/UploadStorageTest.php new file mode 100644 index 00000000..bf765889 --- /dev/null +++ b/tests/Unit/Storage/Uploads/UploadStorageTest.php @@ -0,0 +1,76 @@ +sourceFile = base_dir() . DS . 'storage-source.tmp'; + $this->targetFile = base_dir() . DS . 'storage-target.tmp'; + + file_put_contents($this->sourceFile, 'hello'); + } + + public function tearDown(): void + { + if (file_exists($this->sourceFile)) { + unlink($this->sourceFile); + } + + if (file_exists($this->targetFile)) { + unlink($this->targetFile); + } + } + + public function testStoreCopiesFileWhenNotUploaded(): void + { + $storage = new UploadStorage(new LocalFileSystemAdapter()); + $uploadedFile = new UploadedFile([ + 'name' => 'source.tmp', + 'tmp_name' => $this->sourceFile, + 'error' => 0, + 'size' => 5, + 'type' => 'text/plain', + ]); + + $result = $storage->store($uploadedFile, $this->targetFile); + + $this->assertTrue($result); + $this->assertTrue(file_exists($this->targetFile)); + } + + public function testStoreUsesRemoteAdapterWhenProvided(): void + { + $storage = new UploadStorage(new LocalFileSystemAdapter()); + $uploadedFile = new UploadedFile([ + 'name' => 'source.tmp', + 'tmp_name' => $this->sourceFile, + 'error' => 0, + 'size' => 5, + 'type' => 'text/plain', + ]); + + $remote = Mockery::mock(FilesystemAdapterInterface::class); + $remote->shouldReceive('put') + ->once() + ->with($this->targetFile, 'hello') + ->andReturn(true); + + $result = $storage->store($uploadedFile, $this->targetFile, $remote); + + $this->assertTrue($result); + } +}