vendor/symfony/http-foundation/BinaryFileResponse.php line 52

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpFoundation;
  14. use Symfony\Component\HttpFoundation\File\Exception\FileException;
  15. use Symfony\Component\HttpFoundation\File\File;
  17. /**
  18.  * BinaryFileResponse represents an HTTP response delivering a file.
  19.  *
  20.  * @author Niklas Fiekas <niklas.fiekas@tu-clausthal.de>
  21.  * @author stealth35 <stealth35-php@live.fr>
  22.  * @author Igor Wiedler <igor@wiedler.ch>
  23.  * @author Jordan Alliot <jordan.alliot@gmail.com>
  24.  * @author Sergey Linnik <linniksa@gmail.com>
  25.  */
  26. class BinaryFileResponse extends Response
  27. {
  28.     protected static $trustXSendfileTypeHeader = false;
  30.     /**
  31.      * @var File
  32.      */
  33.     protected $file;
  34.     protected $offset = 0;
  35.     protected $maxlen = -1;
  36.     protected $deleteFileAfterSend = false;
  37.     protected $chunkSize = 8 * 1024;
  39.     /**
  40.      * @param \SplFileInfo|string $file               The file to stream
  41.      * @param int                 $status             The response status code
  42.      * @param array               $headers            An array of response headers
  43.      * @param bool                $public             Files are public by default
  44.      * @param string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
  45.      * @param bool                $autoEtag           Whether the ETag header should be automatically set
  46.      * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
  47.      */
  48.     public function __construct($file, int $status = 200, array $headers = [], bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
  49.     {
  50.         parent::__construct(null, $status, $headers);
  52.         $this->setFile($file, $contentDisposition, $autoEtag, $autoLastModified);
  54.         if ($public) {
  55.             $this->setPublic();
  56.         }
  57.     }
  59.     /**
  60.      * @param \SplFileInfo|string $file               The file to stream
  61.      * @param int                 $status             The response status code
  62.      * @param array               $headers            An array of response headers
  63.      * @param bool                $public             Files are public by default
  64.      * @param string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
  65.      * @param bool                $autoEtag           Whether the ETag header should be automatically set
  66.      * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
  67.      *
  68.      * @return static
  69.      *
  70.      * @deprecated since Symfony 5.2, use __construct() instead.
  71.      */
  72.     public static function create($file = null, int $status = 200, array $headers = [], bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
  73.     {
  74.         trigger_deprecation('symfony/http-foundation', '5.2', 'The "%s()" method is deprecated, use "new %s()" instead.', __METHOD__, static::class);
  76.         return new static($file, $status, $headers, $public, $contentDisposition, $autoEtag, $autoLastModified);
  77.     }
  79.     /**
  80.      * Sets the file to stream.
  81.      *
  82.      * @param \SplFileInfo|string $file The file to stream
  83.      *
  84.      * @return $this
  85.      *
  86.      * @throws FileException
  87.      */
  88.     public function setFile($file, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
  89.     {
  90.         if (!$file instanceof File) {
  91.             if ($file instanceof \SplFileInfo) {
  92.                 $file = new File($file->getPathname());
  93.             } else {
  94.                 $file = new File((string) $file);
  95.             }
  96.         }
  98.         if (!$file->isReadable()) {
  99.             throw new FileException('File must be readable.');
  100.         }
  102.         $this->file = $file;
  104.         if ($autoEtag) {
  105.             $this->setAutoEtag();
  106.         }
  108.         if ($autoLastModified) {
  109.             $this->setAutoLastModified();
  110.         }
  112.         if ($contentDisposition) {
  113.             $this->setContentDisposition($contentDisposition);
  114.         }
  116.         return $this;
  117.     }
  119.     /**
  120.      * Gets the file.
  121.      *
  122.      * @return File
  123.      */
  124.     public function getFile()
  125.     {
  126.         return $this->file;
  127.     }
  129.     /**
  130.      * Sets the response stream chunk size.
  131.      *
  132.      * @return $this
  133.      */
  134.     public function setChunkSize(int $chunkSize): self
  135.     {
  136.         if ($chunkSize < 1 || $chunkSize > \PHP_INT_MAX) {
  137.             throw new \LogicException('The chunk size of a BinaryFileResponse cannot be less than 1 or greater than PHP_INT_MAX.');
  138.         }
  140.         $this->chunkSize = $chunkSize;
  142.         return $this;
  143.     }
  145.     /**
  146.      * Automatically sets the Last-Modified header according the file modification date.
  147.      *
  148.      * @return $this
  149.      */
  150.     public function setAutoLastModified()
  151.     {
  152.         $this->setLastModified(\DateTime::createFromFormat('U', $this->file->getMTime()));
  154.         return $this;
  155.     }
  157.     /**
  158.      * Automatically sets the ETag header according to the checksum of the file.
  159.      *
  160.      * @return $this
  161.      */
  162.     public function setAutoEtag()
  163.     {
  164.         $this->setEtag(base64_encode(hash_file('sha256', $this->file->getPathname(), true)));
  166.         return $this;
  167.     }
  169.     /**
  170.      * Sets the Content-Disposition header with the given filename.
  171.      *
  172.      * @param string $disposition      ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
  173.      * @param string $filename         Optionally use this UTF-8 encoded filename instead of the real name of the file
  174.      * @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
  175.      *
  176.      * @return $this
  177.      */
  178.     public function setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = '')
  179.     {
  180.         if ('' === $filename) {
  181.             $filename = $this->file->getFilename();
  182.         }
  184.         if ('' === $filenameFallback && (!preg_match('/^[\x20-\x7e]*$/', $filename) || str_contains($filename, '%'))) {
  185.             $encoding = mb_detect_encoding($filename, null, true) ?: '8bit';
  187.             for ($i = 0, $filenameLength = mb_strlen($filename, $encoding); $i < $filenameLength; ++$i) {
  188.                 $char = mb_substr($filename, $i, 1, $encoding);
  190.                 if ('%' === $char || \ord($char) < 32 || \ord($char) > 126) {
  191.                     $filenameFallback .= '_';
  192.                 } else {
  193.                     $filenameFallback .= $char;
  194.                 }
  195.             }
  196.         }
  198.         $dispositionHeader = $this->headers->makeDisposition($disposition, $filename, $filenameFallback);
  199.         $this->headers->set('Content-Disposition', $dispositionHeader);
  201.         return $this;
  202.     }
  204.     /**
  205.      * {@inheritdoc}
  206.      */
  207.     public function prepare(Request $request)
  208.     {
  209.         if ($this->isInformational() || $this->isEmpty()) {
  210.             parent::prepare($request);
  212.             $this->maxlen = 0;
  214.             return $this;
  215.         }
  217.         if (!$this->headers->has('Content-Type')) {
  218.             $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
  219.         }
  221.         parent::prepare($request);
  223.         $this->offset = 0;
  224.         $this->maxlen = -1;
  226.         if (false === $fileSize = $this->file->getSize()) {
  227.             return $this;
  228.         }
  229.         $this->headers->remove('Transfer-Encoding');
  230.         $this->headers->set('Content-Length', $fileSize);
  232.         if (!$this->headers->has('Accept-Ranges')) {
  233.             // Only accept ranges on safe HTTP methods
  234.             $this->headers->set('Accept-Ranges', $request->isMethodSafe() ? 'bytes' : 'none');
  235.         }
  237.         if (self::$trustXSendfileTypeHeader && $request->headers->has('X-Sendfile-Type')) {
  238.             // Use X-Sendfile, do not send any content.
  239.             $type = $request->headers->get('X-Sendfile-Type');
  240.             $path = $this->file->getRealPath();
  241.             // Fall back to scheme://path for stream wrapped locations.
  242.             if (false === $path) {
  243.                 $path = $this->file->getPathname();
  244.             }
  245.             if ('x-accel-redirect' === strtolower($type)) {
  246.                 // Do X-Accel-Mapping substitutions.
  247.                 // @link https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/#x-accel-redirect
  248.                 $parts = HeaderUtils::split($request->headers->get('X-Accel-Mapping', ''), ',=');
  249.                 foreach ($parts as $part) {
  250.                     [$pathPrefix, $location] = $part;
  251.                     if (substr($path, 0, \strlen($pathPrefix)) === $pathPrefix) {
  252.                         $path = $location.substr($path, \strlen($pathPrefix));
  253.                         // Only set X-Accel-Redirect header if a valid URI can be produced
  254.                         // as nginx does not serve arbitrary file paths.
  255.                         $this->headers->set($type, $path);
  256.                         $this->maxlen = 0;
  257.                         break;
  258.                     }
  259.                 }
  260.             } else {
  261.                 $this->headers->set($type, $path);
  262.                 $this->maxlen = 0;
  263.             }
  264.         } elseif ($request->headers->has('Range') && $request->isMethod('GET')) {
  265.             // Process the range headers.
  266.             if (!$request->headers->has('If-Range') || $this->hasValidIfRangeHeader($request->headers->get('If-Range'))) {
  267.                 $range = $request->headers->get('Range');
  269.                 if (str_starts_with($range, 'bytes=')) {
  270.                     [$start, $end] = explode('-', substr($range, 6), 2) + [0];
  272.                     $end = ('' === $end) ? $fileSize - 1 : (int) $end;
  274.                     if ('' === $start) {
  275.                         $start = $fileSize - $end;
  276.                         $end = $fileSize - 1;
  277.                     } else {
  278.                         $start = (int) $start;
  279.                     }
  281.                     if ($start <= $end) {
  282.                         $end = min($end, $fileSize - 1);
  283.                         if ($start < 0 || $start > $end) {
  284.                             $this->setStatusCode(416);
  285.                             $this->headers->set('Content-Range', sprintf('bytes */%s', $fileSize));
  286.                         } elseif ($end - $start < $fileSize - 1) {
  287.                             $this->maxlen = $end < $fileSize ? $end - $start + 1 : -1;
  288.                             $this->offset = $start;
  290.                             $this->setStatusCode(206);
  291.                             $this->headers->set('Content-Range', sprintf('bytes %s-%s/%s', $start, $end, $fileSize));
  292.                             $this->headers->set('Content-Length', $end - $start + 1);
  293.                         }
  294.                     }
  295.                 }
  296.             }
  297.         }
  299.         if ($request->isMethod('HEAD')) {
  300.             $this->maxlen = 0;
  301.         }
  303.         return $this;
  304.     }
  306.     private function hasValidIfRangeHeader(?string $header): bool
  307.     {
  308.         if ($this->getEtag() === $header) {
  309.             return true;
  310.         }
  312.         if (null === $lastModified = $this->getLastModified()) {
  313.             return false;
  314.         }
  316.         return $lastModified->format('D, d M Y H:i:s').' GMT' === $header;
  317.     }
  319.     /**
  320.      * {@inheritdoc}
  321.      */
  322.     public function sendContent()
  323.     {
  324.         try {
  325.             if (!$this->isSuccessful()) {
  326.                 return parent::sendContent();
  327.             }
  329.             if (0 === $this->maxlen) {
  330.                 return $this;
  331.             }
  333.             $out = fopen('php://output', 'w');
  334.             $file = fopen($this->file->getPathname(), 'r');
  336.             ignore_user_abort(true);
  338.             if (0 !== $this->offset) {
  339.                 fseek($file, $this->offset);
  340.             }
  342.             $length = $this->maxlen;
  343.             while ($length && !feof($file)) {
  344.                 $read = ($length > $this->chunkSize) ? $this->chunkSize : $length;
  345.                 $length -= $read;
  347.                 stream_copy_to_stream($file, $out, $read);
  349.                 if (connection_aborted()) {
  350.                     break;
  351.                 }
  352.             }
  354.             fclose($out);
  355.             fclose($file);
  356.         } finally {
  357.             if ($this->deleteFileAfterSend && is_file($this->file->getPathname())) {
  358.                 unlink($this->file->getPathname());
  359.             }
  360.         }
  362.         return $this;
  363.     }
  365.     /**
  366.      * {@inheritdoc}
  367.      *
  368.      * @throws \LogicException when the content is not null
  369.      */
  370.     public function setContent(?string $content)
  371.     {
  372.         if (null !== $content) {
  373.             throw new \LogicException('The content cannot be set on a BinaryFileResponse instance.');
  374.         }
  376.         return $this;
  377.     }
  379.     /**
  380.      * {@inheritdoc}
  381.      */
  382.     public function getContent()
  383.     {
  384.         return false;
  385.     }
  387.     /**
  388.      * Trust X-Sendfile-Type header.
  389.      */
  390.     public static function trustXSendfileTypeHeader()
  391.     {
  392.         self::$trustXSendfileTypeHeader = true;
  393.     }
  395.     /**
  396.      * If this is set to true, the file will be unlinked after the request is sent
  397.      * Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.
  398.      *
  399.      * @return $this
  400.      */
  401.     public function deleteFileAfterSend(bool $shouldDelete = true)
  402.     {
  403.         $this->deleteFileAfterSend = $shouldDelete;
  405.         return $this;
  406.     }
  407. }