Merge pull request #29 from mikehaertl/28-ignore-user-abort

Issue #28 Add ignoreUserAbort option to remove files if connection closed

Author: mikehaertl

README.md

@@ -62,3 +62,7 @@ File::$defaultHeader['X-Header'] = 'My Default';
 $file = new File('some content', '.html');
 $file->send('home.html');
 ```
+
+The `$ignoreUserAbort` option (on by default) mitigates an issue where the file
+was not deleted if the user closes the connection during a download. Try setting
+it to `false` if you experience unexpected behavior.

src/File.php

@@ -19,6 +19,13 @@ class File
      */
     public $delete = true;
 
+    /**
+     * @var bool whether to ignore if a user closed the connection so that the
+     * temporary file can still be cleaned up in that case. Default is `true`.
+     * @see https://www.php.net/manual/en/function.ignore-user-abort.php
+     */
+    public $ignoreUserAbort = true;
+
     /**
      * @var array the list of static default headers to send when `send()` is
      * called as key/value pairs.
@@ -126,6 +133,12 @@ public function send($filename = null, $contentType = null, $inline = false, $he
         }
 
         $this->sendHeaders($headers);
+
+        // #28: File not cleaned up if user aborts connection during download
+        if ($this->ignoreUserAbort) {
+            ignore_user_abort(true);
+        }
+
         readfile($this->_fileName);
     }