Add disk support to file sanitization and enhance error handling

Author: shaunluedeke

composer.lock

@@ -3,6 +3,8 @@
 namespace Portavice\LaravelFileSanitizer;
 
 use Illuminate\Http\UploadedFile;
+use Illuminate\Support\Facades\Storage;
+use RuntimeException;
 use SytxLabs\FileSanitizer\FileSanitizer as BaseFileSanitizer;
 
 class FileSanitizerManager
@@ -16,14 +18,47 @@ public function getSanitizer(): BaseFileSanitizer
         return $this->sanitizer;
     }
 
-    public function process(string $inputPath, ?string $outputPath = null, ?bool $sanitizeAlways = null): array
+    public function process(string $inputPath, ?string $outputPath = null, ?bool $sanitizeAlways = null, ?string $diskName = null): array
     {
-        return $this->sanitizer->process($inputPath, $outputPath, $sanitizeAlways ?? (bool) ($this->config['sanitize_always'] ?? false));
+        return $this->run($inputPath, $outputPath, $sanitizeAlways ?? (bool) ($this->config['sanitize_always'] ?? false), $diskName);
     }
 
-    public function sanitizeAlways(string $inputPath, ?string $outputPath = null): array
+    public function sanitizeAlways(string $inputPath, ?string $outputPath = null, ?string $diskName = null): array
     {
-        return method_exists($this->sanitizer, 'sanitizeAlways') ? $this->sanitizer->sanitizeAlways($inputPath, $outputPath) : $this->sanitizer->process($inputPath, $outputPath, true);
+        return $this->run($inputPath, $outputPath, true, $diskName);
+    }
+
+    protected function run(string $inputPath, ?string $outputPath, bool $sanitizeAlways, ?string $diskName): array
+    {
+        if ($diskName === null) {
+            return $sanitizeAlways && method_exists($this->sanitizer, 'sanitizeAlways') ? $this->sanitizer->sanitizeAlways($inputPath, $outputPath) : $this->sanitizer->process($inputPath, $outputPath, $sanitizeAlways);
+        }
+        $disk = Storage::disk($diskName);
+        if (! $disk->exists($inputPath)) {
+            throw new RuntimeException("Input file [{$inputPath}] was not found on disk [{$diskName}].");
+        }
+        $tmpInput = tempnam(sys_get_temp_dir(), 'fs_in_');
+        $tmpOutput = tempnam(sys_get_temp_dir(), 'fs_out_');
+        if ($tmpInput === false || $tmpOutput === false) {
+            if ($tmpInput !== false) {
+                @unlink($tmpInput);
+            }
+            if ($tmpOutput !== false) {
+                @unlink($tmpOutput);
+            }
+            throw new RuntimeException('Unable to create temporary files.');
+        }
+        try {
+            file_put_contents($tmpInput, $disk->get($inputPath));
+            $result = $sanitizeAlways && method_exists($this->sanitizer, 'sanitizeAlways') ? $this->sanitizer->sanitizeAlways($tmpInput, $tmpOutput) : $this->sanitizer->process($tmpInput, $tmpOutput, $sanitizeAlways);
+            if ($outputPath !== null && is_file($tmpOutput)) {
+                $disk->put($outputPath, file_get_contents($tmpOutput));
+            }
+            return $result;
+        } finally {
+            @unlink($tmpInput);
+            @unlink($tmpOutput);
+        }
     }
 
     public function processUploadedFile(UploadedFile $file, ?string $outputPath = null, ?bool $sanitizeAlways = null): array

src/FileSanitizerManager.php

@@ -34,10 +34,9 @@ public function boot(): void
         Validator::replacer('safe_file', fn (string $message, string $attribute): string => str_replace(':attribute', $attribute, $message ?: 'The :attribute contains unsafe content.'));
 
         if (method_exists(UploadedFile::class, 'macro')) {
-            UploadedFile::macro('sanitize', function (?string $targetPath = null, bool $sanitizeAlways = false) {
+            UploadedFile::macro('sanitize', function (?string $targetPath = null, bool $sanitizeAlways = false, ?string $diskName = null) {
                 /** @var UploadedFile $this */
                 $manager = app(FileSanitizerManager::class);
-
                 $sourcePath = $this->getRealPath();
                 if ($sourcePath === false) {
                     throw new RuntimeException('Uploaded file has no readable temporary path.');
@@ -48,21 +47,18 @@ public function boot(): void
                     if ($targetPath === false) {
                         throw new RuntimeException('Unable to create temporary file for sanitized upload.');
                     }
-
                     if ($extension !== '') {
                         $renamed = $targetPath . '.' . $extension;
-                        if (!@rename($targetPath, $renamed)) {
+                        if (! @rename($targetPath, $renamed)) {
                             throw new RuntimeException('Unable to prepare sanitized temporary file.');
                         }
                         $targetPath = $renamed;
                     }
                 }
-
-                $result = $manager->process($sourcePath, $targetPath, $sanitizeAlways);
-                $sanitizedFile = new UploadedFile($targetPath, $this->getClientOriginalName(), $this->getMimeType() ?: $this->getClientMimeType(), null, true);
+                $result = $manager->process($sourcePath, $targetPath, $sanitizeAlways, $diskName);
                 return [
                     'result' => $result,
-                    'file' => $sanitizedFile,
+                    'file' => new UploadedFile($targetPath, $this->getClientOriginalName(), $this->getMimeType() ?: $this->getClientMimeType(), null, true),
                     'path' => $targetPath,
                 ];
             });