MDL-38194 Files: Allow download of large backup files
authorsam marshall <s.marshall@open.ac.uk>
Tue, 10 Sep 2013 15:34:44 +0000 (16:34 +0100)
committersam marshall <s.marshall@open.ac.uk>
Fri, 13 Sep 2013 13:59:57 +0000 (14:59 +0100)
The PHP readfile function does not work for files more than 2GB.
This commit provides a wrapper that can be used so that files less
than 2GB are sent with readfile, and files larger than 2GB are
sent manually.

The change applies to all uses of pluginfile.php, although in
reality, backup files are probably the only ones likely to be more
than two gigabytes.

lib/filelib.php
lib/filestorage/stored_file.php
lib/upgrade.txt

index 2260e4a..3d4dd83 100644 (file)
@@ -1959,6 +1959,43 @@ function send_header_404() {
     }
 }
 
+/**
+ * The readfile function can fail when files are larger than 2GB (even on 64-bit
+ * platforms). This wrapper uses readfile for small files and custom code for
+ * large ones.
+ *
+ * @param string $path Path to file
+ * @param int $filesize Size of file (if left out, will get it automatically)
+ * @return int|bool Size read (will always be $filesize) or false if failed
+ */
+function readfile_allow_large($path, $filesize = -1) {
+    // Automatically get size if not specified.
+    if ($filesize === -1) {
+        $filesize = filesize($path);
+    }
+    if ($filesize <= 2147483647) {
+        // If the file is up to 2^31 - 1, send it normally using readfile.
+        return readfile($path);
+    } else {
+        // For large files, read and output in 64KB chunks.
+        $handle = fopen($path, 'r');
+        if ($handle === false) {
+            return false;
+        }
+        $left = $filesize;
+        while ($left > 0) {
+            $size = min($left, 65536);
+            $buffer = fread($handle, $size);
+            if ($buffer === false) {
+                return false;
+            }
+            echo $buffer;
+            $left -= $size;
+        }
+        return $filesize;
+    }
+}
+
 /**
  * Enhanced readfile() with optional acceleration.
  * @param string|stored_file $file
@@ -2081,7 +2118,7 @@ function readfile_accel($file, $mimetype, $accelerate) {
     if (is_object($file)) {
         $file->readfile();
     } else {
-        readfile($file);
+        readfile_allow_large($file, $filesize);
     }
 }
 
index d56aa52..f1e6c24 100644 (file)
@@ -409,7 +409,7 @@ class stored_file {
                 throw new file_exception('storedfilecannotread', '', $path);
             }
         }
-        readfile($path);
+        readfile_allow_large($path, $this->get_filesize());
     }
 
     /**
index 550f271..0450eb2 100644 (file)
@@ -32,6 +32,7 @@ information provided here is intended especially for developers.
   get_fast_modinfo(). Purging all caches and every core upgrade purges course modinfo cache as well.
   If function get_fast_modinfo() is called for multiple courses make sure to include field cacherev in course
   object.
+* New function readfile_allow_large() in filelib.php for use when very large files may need sending to user.
 
 DEPRECATIONS:
 Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices