Add BinaryFileResponse::streamsEntireFile method

iluuu1994 · iluuu1994 · commit b1fa23e91ae9 · 2020-09-23T16:20:57.000+02:00
This method will return false when the client requests only a specific range of a file. See https://github.com/symfony/psr-http-message-bridge/issues/84
diff --git a/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php b/src/Symfony/Component/HttpFoundation/BinaryFileResponse.php
@@ -356,4 +356,13 @@ public function deleteFileAfterSend($shouldDelete = true)
 
         return $this;
     }
+
+    /**
+     * Returns true if the entire file is streamed when calling sendContent().
+     * Usually this will return false when the client requests a specific range of the file with the Range header.
+     */
+    public function streamsEntireFile(): bool
+    {
+        return $this->maxlen === -1 && $this->offset === 0;
+    }
 }
diff --git a/src/Symfony/Component/HttpFoundation/CHANGELOG.md b/src/Symfony/Component/HttpFoundation/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.4.14
+------
+
+ * [BC BREAK] added `streamsEntireFile()` to `BinaryFileResponse`.
+
 4.4.0
 -----
 
diff --git a/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php b/src/Symfony/Component/HttpFoundation/Tests/BinaryFileResponseTest.php
@@ -81,7 +81,7 @@ public function testSetContentDispositionGeneratesSafeFallbackFilenameForWrongly
     /**
      * @dataProvider provideRanges
      */
-    public function testRequests($requestRange, $offset, $length, $responseRange)
+    public function testRequests($statusCode, $requestRange, $offset, $length, $responseRange, $streamsEntireFile)
     {
         $response = BinaryFileResponse::create(__DIR__.'/File/Fixtures/test.gif', 200, ['Content-Type' => 'application/octet-stream'])->setAutoEtag();
 
@@ -105,15 +105,16 @@ public function testRequests($requestRange, $offset, $length, $responseRange)
         $response->prepare($request);
         $response->sendContent();
 
-        $this->assertEquals(206, $response->getStatusCode());
+        $this->assertEquals($statusCode, $response->getStatusCode());
         $this->assertEquals($responseRange, $response->headers->get('Content-Range'));
         $this->assertSame((string) $length, $response->headers->get('Content-Length'));
+        $this->assertEquals($streamsEntireFile, $response->streamsEntireFile());
     }
 
     /**
      * @dataProvider provideRanges
      */
-    public function testRequestsWithoutEtag($requestRange, $offset, $length, $responseRange)
+    public function testRequestsWithoutEtag($statusCode, $requestRange, $offset, $length, $responseRange, $streamsEntireFile)
     {
         $response = BinaryFileResponse::create(__DIR__.'/File/Fixtures/test.gif', 200, ['Content-Type' => 'application/octet-stream']);
 
@@ -137,18 +138,21 @@ public function testRequestsWithoutEtag($requestRange, $offset, $length, $respon
         $response->prepare($request);
         $response->sendContent();
 
-        $this->assertEquals(206, $response->getStatusCode());
+        $this->assertEquals($statusCode, $response->getStatusCode());
         $this->assertEquals($responseRange, $response->headers->get('Content-Range'));
+        $this->assertEquals($streamsEntireFile, $response->streamsEntireFile());
     }
 
     public function provideRanges()
     {
         return [
-            ['bytes=1-4', 1, 4, 'bytes 1-4/35'],
-            ['bytes=-5', 30, 5, 'bytes 30-34/35'],
-            ['bytes=30-', 30, 5, 'bytes 30-34/35'],
-            ['bytes=30-30', 30, 1, 'bytes 30-30/35'],
-            ['bytes=30-34', 30, 5, 'bytes 30-34/35'],
+            [206, 'bytes=1-4', 1, 4, 'bytes 1-4/35', false],
+            [206, 'bytes=-5', 30, 5, 'bytes 30-34/35', false],
+            [206, 'bytes=30-', 30, 5, 'bytes 30-34/35', false],
+            [206, 'bytes=30-30', 30, 1, 'bytes 30-30/35', false],
+            [206, 'bytes=30-34', 30, 5, 'bytes 30-34/35', false],
+            [200, 'bytes=0-', 0, 35, null, true],
+            [200, 'bytes=0-34', 0, 35, null, true],
         ];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -356,4 +356,13 @@ public function deleteFileAfterSend($shouldDelete = true)`
`356`	`356`
`357`	`357`	`return $this;`
`358`	`358`	`}`
	`359`	`+`
	`360`	`+ /**`
	`361`	`+ * Returns true if the entire file is streamed when calling sendContent().`
	`362`	`+ * Usually this will return false when the client requests a specific range of the file with the Range header.`
	`363`	`+ */`
	`364`	`+ public function streamsEntireFile(): bool`
	`365`	`+ {`
	`366`	`+ return $this->maxlen === -1 && $this->offset === 0;`
	`367`	`+ }`
`359`	`368`	`}`