Listener for removing temporary files, which was created during uploa…

…ding (#477) * Listener for removing temporary files, which was created during uploading * cs fixes * Changelog updated * Changelog updated * Changelog updated * add files * simplify code * rename again Co-authored-by: Taylor Otwell <[email protected]>
laravel · Feb 10, 2022 · f4907e7 · f4907e7
1 parent dde0cbd
commit f4907e7
Show file tree

Hide file tree

Showing 4 changed files with 89 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## [Unreleased](https://github.com/laravel/octane/compare/v1.2.1...1.x)
 
+### Added
+
+- Listener for removing temporary files which were created during uploading _(must be enabled manually for existing applications)_ ([#477](https://github.com/laravel/octane/pull/477))
+
 ## [v1.2.1](https://github.com/laravel/octane/compare/v1.2.1...v1.2.1) - 2022-02-08
 
 ### Changed

diff --git a/config/octane.php b/config/octane.php
@@ -16,6 +16,7 @@
 use Laravel\Octane\Listeners\EnsureUploadedFilesAreValid;
 use Laravel\Octane\Listeners\EnsureUploadedFilesCanBeMoved;
 use Laravel\Octane\Listeners\FlushTemporaryContainerInstances;
+use Laravel\Octane\Listeners\FlushUploadedFiles;
 use Laravel\Octane\Listeners\ReportException;
 use Laravel\Octane\Listeners\StopWorkerIfNecessary;
 use Laravel\Octane\Octane;
@@ -78,7 +79,7 @@
         ],
 
         RequestTerminated::class => [
-            //
+            // FlushUploadedFiles::class,
         ],
 
         TaskReceived::class => [

diff --git a/src/Listeners/FlushUploadedFiles.php b/src/Listeners/FlushUploadedFiles.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Laravel\Octane\Listeners;
+
+use SplFileInfo;
+
+class FlushUploadedFiles
+{
+    /**
+     * Handle the event.
+     *
+     * @param  mixed  $event
+     * @return void
+     */
+    public function handle($event): void
+    {
+        foreach ($event->request->files->all() as $file) {
+            if (! $file instanceof SplFileInfo ||
+                ! is_string($path = $file->getRealPath())) {
+                continue;
+            }
+
+            clearstatcache(true, $path);
+
+            if (is_file($path)) {
+                unlink($path);
+            }
+        }
+    }
+}
diff --git a/tests/Listeners/FlushUploadedFilesTest.php b/tests/Listeners/FlushUploadedFilesTest.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace Laravel\Octane\Listeners;
+
+use Illuminate\Support\Str;
+use Laravel\Octane\Listeners\FlushUploadedFiles;
+use Laravel\Octane\Tests\TestCase;
+use Symfony\Component\HttpFoundation\File\UploadedFile;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @covers \Laravel\Octane\Listeners\FlushUploadedFiles
+ */
+class FlushUploadedFilesTest extends TestCase
+{
+    public function test_files_removed()
+    {
+        try {
+            [$file1path, $file2path, $file3path] = [
+                \tempnam($tmpDir = \sys_get_temp_dir(), $prefix = 'unit-'),
+                \tempnam($tmpDir, $prefix),
+                \tempnam($tmpDir, $prefix),
+            ];
+
+            ($request = Request::create('http://127.0.0.1:123/foo'))->files->add([
+                new UploadedFile($file1path, Str::random()),
+                new UploadedFile($file2path, Str::random()),
+                new UploadedFile($file3path, Str::random()),
+            ]);
+
+            $this->assertTrue(\rename($file3path, $file3newPath = $file3path.Str::random()));
+
+            $this->assertFileExists($file1path);
+            $this->assertFileExists($file2path);
+            $this->assertFileExists($file3newPath);
+
+            $event = new \stdClass();
+            $event->request = $request;
+
+            (new FlushUploadedFiles)->handle($event);
+
+            $this->assertFileDoesNotExist($file1path);
+            $this->assertFileDoesNotExist($file2path);
+            $this->assertFileExists($file3newPath); // still exists
+        } finally {
+            foreach ([$file1path, $file2path, $file3newPath] as $fileName) {
+                if (\is_file($fileName)) {
+                    \unlink($fileName);
+                }
+            }
+        }
+    }
+}