Merge pull request php-curl-class#411 from zachborboa/master

Add additional resume Curl::download() tests

Author: zachborboa

tests/PHPCurlClass/ContentRangeServer.php

@@ -8,8 +8,6 @@ class ContentRangeServer
 {
     public function serve($path)
     {
-        $range = new RangeHeader($_SERVER['HTTP_RANGE']);
-
         $filesize = filesize($path);
         $fp = fopen($path, 'r');
 
@@ -19,16 +17,25 @@ public function serve($path)
             header('Accept-Ranges: bytes');
             fpassthru($fp);
         } else {
+            $range = new RangeHeader($_SERVER['HTTP_RANGE'], $path);
+
+            if (!$range->isValid()) {
+                header('HTTP/1.1 416 Requested Range Not Satisfiable');
+                header('Content-Range: ' . $range->getContentRangeHeader());
+                exit;
+            }
+
+            $length = $range->getLength();
+
             header('HTTP/1.1 206 Partial Content');
-            header('Content-Length: ' . $range->getLength($filesize));
-            header('Content-Range: ' . $range->getContentRangeHeader($filesize));
+            header('Content-Length: ' . $length);
+            header('Content-Range: ' . $range->getContentRangeHeader());
 
-            $start = $range->getFirstBytePosition($filesize);
+            $start = $range->getFirstBytePosition();
             if ($start > 0) {
                 fseek($fp, $start, SEEK_SET);
             }
 
-            $length = $range->getLength($filesize);
             $chunk_size = 4096;
             while ($length) {
                 $read = $length > $chunk_size ? $chunk_size : $length;

tests/PHPCurlClass/PHPCurlClassTest.php

@@ -692,6 +692,24 @@ public function testDownloadRange()
                 $filesize - 3,
                 $filesize - 2,
                 $filesize - 1,
+
+                // A partial temporary file having the exact same file size as the complete source file should only
+                // occur under certain circumstances (almost never). When the download successfully completed, the
+                // temporary file should have been moved to the download destination save path. However, it is possible
+                // that a larger file download was interrupted after which the source file was updated and now has the
+                // exact same file size as the partial temporary. When resuming the download, the range is now
+                // unsatisfiable as the first byte position exceeds the available range. The entire file should be
+                // downloaded again.
+                $filesize - 0,
+
+                // A partial temporary file having a larger file size than the complete source file should only occur
+                // under certain circumstances. This is possible when a download was interrupted after which the source
+                // file was updated with a smaller file. When resuming the download, the range is now unsatisfiable as
+                // the first byte position exceeds the the available range. The entire file should be downloaded again.
+                $filesize + 1,
+                $filesize + 2,
+                $filesize + 3,
+
             ) as $length) {
 
             $source = Test::TEST_URL;
@@ -749,10 +767,12 @@ public function testDownloadRange()
                 $this->assertEquals($expected_bytes_downloaded, $bytes_downloaded);
             }
             $this->assertEquals($expected_http_status_code, $curl->httpStatusCode);
-            $this->assertEquals($filesize, filesize($destination));
 
-            unlink($destination);
-            $this->assertFalse(file_exists($destination));
+            if (!$curl->error) {
+                $this->assertEquals($filesize, filesize($destination));
+                unlink($destination);
+                $this->assertFalse(file_exists($destination));
+            }
         }
 
         // Remove server file.

tests/PHPCurlClass/RangeHeader.php

@@ -6,48 +6,65 @@ class RangeHeader
 {
     private $first_byte;
     private $last_byte;
+    private $filesize;
+    private $is_valid = true;
 
-    public function __construct($http_range_header)
+    public function __construct($http_range_header, $file_path)
     {
         // Simulate basic support for the Content-Range header.
         preg_match('/bytes=(\d+)?-(\d+)?/', $http_range_header, $matches);
         $this->first_byte = isset($matches['1']) ? (int)$matches['1'] : null;
         $this->last_byte = isset($matches['2']) ? (int)$matches['2'] : null;
+
+        $this->filesize = filesize($file_path);
+
+        // Start position begins after end of file.
+        if ($this->first_byte >= $this->filesize) {
+            $this->is_valid = false;
+        }
+
+        // "If the last-byte-pos value is present, it MUST be greater than or equal to the first-byte-pos in that
+        // byte-range-spec, or the byte- range-spec is syntactically invalid."
+        if (!($this->last_byte === null) && !($this->last_byte >= $this->first_byte)) {
+            $this->is_valid = false;
+        }
     }
 
-    public function getFirstBytePosition($file_size)
+    public function getFirstBytePosition()
     {
-        $size = (int)$file_size;
-
         if ($this->first_byte === null) {
-            return $size - 1 - $this->last_byte;
+            return $this->filesize - 1 - $this->last_byte;
         }
 
         return $this->first_byte;
     }
 
-    public function getLastBytePosition($file_size)
+    public function getLastBytePosition()
     {
-        $size = (int)$file_size;
-
         if ($this->last_byte === null) {
-            return $size - 1;
+            return $this->filesize - 1;
         }
 
         return $this->last_byte;
     }
 
-    public function getLength($file_size)
+    public function getLength()
+    {
+        return $this->getLastBytePosition() - $this->getFirstBytePosition() + 1;
+    }
+
+    public function getByteRangeSpec()
     {
-        $size = (int)$file_size;
+        return $this->is_valid ? $this->getFirstBytePosition() . '-' . $this->getLastBytePosition() : '*';
+    }
 
-        return $this->getLastBytePosition($size) - $this->getFirstBytePosition($size) + 1;
+    public function getContentRangeHeader()
+    {
+        return 'bytes ' . $this->getByteRangeSpec() . '/' .  $this->filesize;
     }
 
-    public function getContentRangeHeader($file_size)
+    public function isValid()
     {
-        return
-            'bytes ' . $this->getFirstBytePosition($file_size) . '-' . $this->getLastBytePosition($file_size) . '/' .
-            $file_size;
+        return $this->is_valid;
     }
 }