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.     public static function create($file = null, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
  71.     {
  72.         return new static($file, $status, $headers, $public, $contentDisposition, $autoEtag, $autoLastModified);
  73.     }
  75.     /**
  76.      * Sets the file to stream.
  77.      *
  78.      * @param \SplFileInfo|string $file               The file to stream
  79.      * @param string              $contentDisposition
  80.      * @param bool                $autoEtag
  81.      * @param bool                $autoLastModified
  82.      *
  83.      * @return $this
  84.      *
  85.      * @throws FileException
  86.      */
  87.     public function setFile($file, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
  88.     {
  89.         if (!$file instanceof File) {
  90.             if ($file instanceof \SplFileInfo) {
  91.                 $file = new File($file->getPathname());
  92.             } else {
  93.                 $file = new File((string) $file);
  94.             }
  95.         }
  97.         if (!$file->isReadable()) {
  98.             throw new FileException('File must be readable.');
  99.         }
  101.         $this->file = $file;
  103.         if ($autoEtag) {
  104.             $this->setAutoEtag();
  105.         }
  107.         if ($autoLastModified) {
  108.             $this->setAutoLastModified();
  109.         }
  111.         if ($contentDisposition) {
  112.             $this->setContentDisposition($contentDisposition);
  113.         }
  115.         return $this;
  116.     }
  118.     /**
  119.      * Gets the file.
  120.      *
  121.      * @return File The file to stream
  122.      */
  123.     public function getFile()
  124.     {
  125.         return $this->file;
  126.     }
  128.     /**
  129.      * Sets the response stream chunk size.
  130.      *
  131.      * @return $this
  132.      */
  133.     public function setChunkSize(int $chunkSize): self
  134.     {
  135.         if ($chunkSize < 1 || $chunkSize > \PHP_INT_MAX) {
  136.             throw new \LogicException('The chunk size of a BinaryFileResponse cannot be less than 1 or greater than PHP_INT_MAX.');
  137.         }
  139.         $this->chunkSize = $chunkSize;
  141.         return $this;
  142.     }
  144.     /**
  145.      * Automatically sets the Last-Modified header according the file modification date.
  146.      */
  147.     public function setAutoLastModified()
  148.     {
  149.         $this->setLastModified(\DateTime::createFromFormat('U', $this->file->getMTime()));
  151.         return $this;
  152.     }
  154.     /**
  155.      * Automatically sets the ETag header according to the checksum of the file.
  156.      */
  157.     public function setAutoEtag()
  158.     {
  159.         $this->setEtag(base64_encode(hash_file('sha256', $this->file->getPathname(), true)));
  161.         return $this;
  162.     }
  164.     /**
  165.      * Sets the Content-Disposition header with the given filename.
  166.      *
  167.      * @param string $disposition      ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
  168.      * @param string $filename         Optionally use this UTF-8 encoded filename instead of the real name of the file
  169.      * @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
  170.      *
  171.      * @return $this
  172.      */
  173.     public function setContentDisposition($disposition, $filename = '', $filenameFallback = '')
  174.     {
  175.         if ('' === $filename) {
  176.             $filename = $this->file->getFilename();
  177.         }
  179.         if ('' === $filenameFallback && (!preg_match('/^[\x20-\x7e]*$/', $filename) || str_contains($filename, '%'))) {
  180.             $encoding = mb_detect_encoding($filename, null, true) ?: '8bit';
  182.             for ($i = 0, $filenameLength = mb_strlen($filename, $encoding); $i < $filenameLength; ++$i) {
  183.                 $char = mb_substr($filename, $i, 1, $encoding);
  185.                 if ('%' === $char || \ord($char) < 32 || \ord($char) > 126) {
  186.                     $filenameFallback .= '_';
  187.                 } else {
  188.                     $filenameFallback .= $char;
  189.                 }
  190.             }
  191.         }
  193.         $dispositionHeader = $this->headers->makeDisposition($disposition, $filename, $filenameFallback);
  194.         $this->headers->set('Content-Disposition', $dispositionHeader);
  196.         return $this;
  197.     }
  199.     /**
  200.      * {@inheritdoc}
  201.      */
  202.     public function prepare(Request $request)
  203.     {
  204.         if ($this->isInformational() || $this->isEmpty()) {
  205.             parent::prepare($request);
  207.             $this->maxlen = 0;
  209.             return $this;
  210.         }
  212.         if (!$this->headers->has('Content-Type')) {
  213.             $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
  214.         }
  216.         parent::prepare($request);
  218.         $this->offset = 0;
  219.         $this->maxlen = -1;
  221.         if (false === $fileSize = $this->file->getSize()) {
  222.             return $this;
  223.         }
  224.         $this->headers->remove('Transfer-Encoding');
  225.         $this->headers->set('Content-Length', $fileSize);
  227.         if (!$this->headers->has('Accept-Ranges')) {
  228.             // Only accept ranges on safe HTTP methods
  229.             $this->headers->set('Accept-Ranges', $request->isMethodSafe() ? 'bytes' : 'none');
  230.         }
  232.         if (self::$trustXSendfileTypeHeader && $request->headers->has('X-Sendfile-Type')) {
  233.             // Use X-Sendfile, do not send any content.
  234.             $type = $request->headers->get('X-Sendfile-Type');
  235.             $path = $this->file->getRealPath();
  236.             // Fall back to scheme://path for stream wrapped locations.
  237.             if (false === $path) {
  238.                 $path = $this->file->getPathname();
  239.             }
  240.             if ('x-accel-redirect' === strtolower($type)) {
  241.                 // Do X-Accel-Mapping substitutions.
  242.                 // @link https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/#x-accel-redirect
  243.                 $parts = HeaderUtils::split($request->headers->get('X-Accel-Mapping', ''), ',=');
  244.                 foreach ($parts as $part) {
  245.                     [$pathPrefix, $location] = $part;
  246.                     if (substr($path, 0, \strlen($pathPrefix)) === $pathPrefix) {
  247.                         $path = $location.substr($path, \strlen($pathPrefix));
  248.                         // Only set X-Accel-Redirect header if a valid URI can be produced
  249.                         // as nginx does not serve arbitrary file paths.
  250.                         $this->headers->set($type, $path);
  251.                         $this->maxlen = 0;
  252.                         break;
  253.                     }
  254.                 }
  255.             } else {
  256.                 $this->headers->set($type, $path);
  257.                 $this->maxlen = 0;
  258.             }
  259.         } elseif ($request->headers->has('Range') && $request->isMethod('GET')) {
  260.             // Process the range headers.
  261.             if (!$request->headers->has('If-Range') || $this->hasValidIfRangeHeader($request->headers->get('If-Range'))) {
  262.                 $range = $request->headers->get('Range');
  264.                 if (str_starts_with($range, 'bytes=')) {
  265.                     [$start, $end] = explode('-', substr($range, 6), 2) + [0];
  267.                     $end = ('' === $end) ? $fileSize - 1 : (int) $end;
  269.                     if ('' === $start) {
  270.                         $start = $fileSize - $end;
  271.                         $end = $fileSize - 1;
  272.                     } else {
  273.                         $start = (int) $start;
  274.                     }
  276.                     if ($start <= $end) {
  277.                         $end = min($end, $fileSize - 1);
  278.                         if ($start < 0 || $start > $end) {
  279.                             $this->setStatusCode(416);
  280.                             $this->headers->set('Content-Range', sprintf('bytes */%s', $fileSize));
  281.                         } elseif ($end - $start < $fileSize - 1) {
  282.                             $this->maxlen = $end < $fileSize ? $end - $start + 1 : -1;
  283.                             $this->offset = $start;
  285.                             $this->setStatusCode(206);
  286.                             $this->headers->set('Content-Range', sprintf('bytes %s-%s/%s', $start, $end, $fileSize));
  287.                             $this->headers->set('Content-Length', $end - $start + 1);
  288.                         }
  289.                     }
  290.                 }
  291.             }
  292.         }
  294.         if ($request->isMethod('HEAD')) {
  295.             $this->maxlen = 0;
  296.         }
  298.         return $this;
  299.     }
  301.     private function hasValidIfRangeHeader(?string $header): bool
  302.     {
  303.         if ($this->getEtag() === $header) {
  304.             return true;
  305.         }
  307.         if (null === $lastModified = $this->getLastModified()) {
  308.             return false;
  309.         }
  311.         return $lastModified->format('D, d M Y H:i:s').' GMT' === $header;
  312.     }
  314.     /**
  315.      * Sends the file.
  316.      *
  317.      * {@inheritdoc}
  318.      */
  319.     public function sendContent()
  320.     {
  321.         try {
  322.             if (!$this->isSuccessful()) {
  323.                 return parent::sendContent();
  324.             }
  326.             if (0 === $this->maxlen) {
  327.                 return $this;
  328.             }
  330.             $out = fopen('php://output', 'w');
  331.             $file = fopen($this->file->getPathname(), 'r');
  333.             ignore_user_abort(true);
  335.             if (0 !== $this->offset) {
  336.                 fseek($file, $this->offset);
  337.             }
  339.             $length = $this->maxlen;
  340.             while ($length && !feof($file)) {
  341.                 $read = ($length > $this->chunkSize) ? $this->chunkSize : $length;
  342.                 $length -= $read;
  344.                 stream_copy_to_stream($file, $out, $read);
  346.                 if (connection_aborted()) {
  347.                     break;
  348.                 }
  349.             }
  351.             fclose($out);
  352.             fclose($file);
  353.         } finally {
  354.             if ($this->deleteFileAfterSend && file_exists($this->file->getPathname())) {
  355.                 unlink($this->file->getPathname());
  356.             }
  357.         }
  359.         return $this;
  360.     }
  362.     /**
  363.      * {@inheritdoc}
  364.      *
  365.      * @throws \LogicException when the content is not null
  366.      */
  367.     public function setContent($content)
  368.     {
  369.         if (null !== $content) {
  370.             throw new \LogicException('The content cannot be set on a BinaryFileResponse instance.');
  371.         }
  373.         return $this;
  374.     }
  376.     /**
  377.      * {@inheritdoc}
  378.      */
  379.     public function getContent()
  380.     {
  381.         return false;
  382.     }
  384.     /**
  385.      * Trust X-Sendfile-Type header.
  386.      */
  387.     public static function trustXSendfileTypeHeader()
  388.     {
  389.         self::$trustXSendfileTypeHeader = true;
  390.     }
  392.     /**
  393.      * If this is set to true, the file will be unlinked after the request is sent
  394.      * Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.
  395.      *
  396.      * @param bool $shouldDelete
  397.      *
  398.      * @return $this
  399.      */
  400.     public function deleteFileAfterSend($shouldDelete = true)
  401.     {
  402.         $this->deleteFileAfterSend = $shouldDelete;
  404.         return $this;
  405.     }
  406. }