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

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;
  38.     /**
  39.      * @param \SplFileInfo|string $file               The file to stream
  40.      * @param int                 $status             The response status code
  41.      * @param array               $headers            An array of response headers
  42.      * @param bool                $public             Files are public by default
  43.      * @param string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
  44.      * @param bool                $autoEtag           Whether the ETag header should be automatically set
  45.      * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
  46.      */
  47.     public function __construct($file, int $status = 200, array $headers = [], bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
  48.     {
  49.         parent::__construct(null, $status, $headers);
  51.         $this->setFile($file, $contentDisposition, $autoEtag, $autoLastModified);
  53.         if ($public) {
  54.             $this->setPublic();
  55.         }
  56.     }
  58.     /**
  59.      * @param \SplFileInfo|string $file               The file to stream
  60.      * @param int                 $status             The response status code
  61.      * @param array               $headers            An array of response headers
  62.      * @param bool                $public             Files are public by default
  63.      * @param string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
  64.      * @param bool                $autoEtag           Whether the ETag header should be automatically set
  65.      * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
  66.      *
  67.      * @return static
  68.      *
  69.      * @deprecated since Symfony 5.2, use __construct() instead.
  70.      */
  71.     public static function create($file = null, int $status = 200, array $headers = [], bool $public = true, string $contentDisposition = null, bool $autoEtag = false, bool $autoLastModified = true)
  72.     {
  73.         trigger_deprecation('symfony/http-foundation', '5.2', 'The "%s()" method is deprecated, use "new %s()" instead.', __METHOD__, static::class);
  75.         return new static($file, $status, $headers, $public, $contentDisposition, $autoEtag, $autoLastModified);
  76.     }
  78.     /**
  79.      * Sets the file to stream.
  80.      *
  81.      * @param \SplFileInfo|string $file The file to stream
  82.      *
  83.      * @return $this
  84.      *
  85.      * @throws FileException
  86.      */
  87.     public function setFile($file, string $contentDisposition = null, bool $autoEtag = false, bool $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
  122.      */
  123.     public function getFile()
  124.     {
  125.         return $this->file;
  126.     }
  128.     /**
  129.      * Automatically sets the Last-Modified header according the file modification date.
  130.      *
  131.      * @return $this
  132.      */
  133.     public function setAutoLastModified()
  134.     {
  135.         $this->setLastModified(\DateTime::createFromFormat('U', $this->file->getMTime()));
  137.         return $this;
  138.     }
  140.     /**
  141.      * Automatically sets the ETag header according to the checksum of the file.
  142.      *
  143.      * @return $this
  144.      */
  145.     public function setAutoEtag()
  146.     {
  147.         $this->setEtag(base64_encode(hash_file('sha256', $this->file->getPathname(), true)));
  149.         return $this;
  150.     }
  152.     /**
  153.      * Sets the Content-Disposition header with the given filename.
  154.      *
  155.      * @param string $disposition      ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
  156.      * @param string $filename         Optionally use this UTF-8 encoded filename instead of the real name of the file
  157.      * @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
  158.      *
  159.      * @return $this
  160.      */
  161.     public function setContentDisposition(string $disposition, string $filename = '', string $filenameFallback = '')
  162.     {
  163.         if ('' === $filename) {
  164.             $filename = $this->file->getFilename();
  165.         }
  167.         if ('' === $filenameFallback && (!preg_match('/^[\x20-\x7e]*$/', $filename) || str_contains($filename, '%'))) {
  168.             $encoding = mb_detect_encoding($filename, null, true) ?: '8bit';
  170.             for ($i = 0, $filenameLength = mb_strlen($filename, $encoding); $i < $filenameLength; ++$i) {
  171.                 $char = mb_substr($filename, $i, 1, $encoding);
  173.                 if ('%' === $char || \ord($char) < 32 || \ord($char) > 126) {
  174.                     $filenameFallback .= '_';
  175.                 } else {
  176.                     $filenameFallback .= $char;
  177.                 }
  178.             }
  179.         }
  181.         $dispositionHeader = $this->headers->makeDisposition($disposition, $filename, $filenameFallback);
  182.         $this->headers->set('Content-Disposition', $dispositionHeader);
  184.         return $this;
  185.     }
  187.     /**
  188.      * {@inheritdoc}
  189.      */
  190.     public function prepare(Request $request)
  191.     {
  192.         if (!$this->headers->has('Content-Type')) {
  193.             $this->headers->set('Content-Type', $this->file->getMimeType() ?: 'application/octet-stream');
  194.         }
  196.         if ('HTTP/1.0' !== $request->server->get('SERVER_PROTOCOL')) {
  197.             $this->setProtocolVersion('1.1');
  198.         }
  200.         $this->ensureIEOverSSLCompatibility($request);
  202.         $this->offset = 0;
  203.         $this->maxlen = -1;
  205.         if (false === $fileSize = $this->file->getSize()) {
  206.             return $this;
  207.         }
  208.         $this->headers->set('Content-Length', $fileSize);
  210.         if (!$this->headers->has('Accept-Ranges')) {
  211.             // Only accept ranges on safe HTTP methods
  212.             $this->headers->set('Accept-Ranges', $request->isMethodSafe() ? 'bytes' : 'none');
  213.         }
  215.         if (self::$trustXSendfileTypeHeader && $request->headers->has('X-Sendfile-Type')) {
  216.             // Use X-Sendfile, do not send any content.
  217.             $type = $request->headers->get('X-Sendfile-Type');
  218.             $path = $this->file->getRealPath();
  219.             // Fall back to scheme://path for stream wrapped locations.
  220.             if (false === $path) {
  221.                 $path = $this->file->getPathname();
  222.             }
  223.             if ('x-accel-redirect' === strtolower($type)) {
  224.                 // Do X-Accel-Mapping substitutions.
  225.                 // @link https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/#x-accel-redirect
  226.                 $parts = HeaderUtils::split($request->headers->get('X-Accel-Mapping', ''), ',=');
  227.                 foreach ($parts as $part) {
  228.                     [$pathPrefix, $location] = $part;
  229.                     if (substr($path, 0, \strlen($pathPrefix)) === $pathPrefix) {
  230.                         $path = $location.substr($path, \strlen($pathPrefix));
  231.                         // Only set X-Accel-Redirect header if a valid URI can be produced
  232.                         // as nginx does not serve arbitrary file paths.
  233.                         $this->headers->set($type, $path);
  234.                         $this->maxlen = 0;
  235.                         break;
  236.                     }
  237.                 }
  238.             } else {
  239.                 $this->headers->set($type, $path);
  240.                 $this->maxlen = 0;
  241.             }
  242.         } elseif ($request->headers->has('Range') && $request->isMethod('GET')) {
  243.             // Process the range headers.
  244.             if (!$request->headers->has('If-Range') || $this->hasValidIfRangeHeader($request->headers->get('If-Range'))) {
  245.                 $range = $request->headers->get('Range');
  247.                 if (str_starts_with($range, 'bytes=')) {
  248.                     [$start, $end] = explode('-', substr($range, 6), 2) + [0];
  250.                     $end = ('' === $end) ? $fileSize - 1 : (int) $end;
  252.                     if ('' === $start) {
  253.                         $start = $fileSize - $end;
  254.                         $end = $fileSize - 1;
  255.                     } else {
  256.                         $start = (int) $start;
  257.                     }
  259.                     if ($start <= $end) {
  260.                         $end = min($end, $fileSize - 1);
  261.                         if ($start < 0 || $start > $end) {
  262.                             $this->setStatusCode(416);
  263.                             $this->headers->set('Content-Range', sprintf('bytes */%s', $fileSize));
  264.                         } elseif ($end - $start < $fileSize - 1) {
  265.                             $this->maxlen = $end < $fileSize ? $end - $start + 1 : -1;
  266.                             $this->offset = $start;
  268.                             $this->setStatusCode(206);
  269.                             $this->headers->set('Content-Range', sprintf('bytes %s-%s/%s', $start, $end, $fileSize));
  270.                             $this->headers->set('Content-Length', $end - $start + 1);
  271.                         }
  272.                     }
  273.                 }
  274.             }
  275.         }
  277.         return $this;
  278.     }
  280.     private function hasValidIfRangeHeader(?string $header): bool
  281.     {
  282.         if ($this->getEtag() === $header) {
  283.             return true;
  284.         }
  286.         if (null === $lastModified = $this->getLastModified()) {
  287.             return false;
  288.         }
  290.         return $lastModified->format('D, d M Y H:i:s').' GMT' === $header;
  291.     }
  293.     /**
  294.      * {@inheritdoc}
  295.      */
  296.     public function sendContent()
  297.     {
  298.         if (!$this->isSuccessful()) {
  299.             return parent::sendContent();
  300.         }
  302.         if (0 === $this->maxlen) {
  303.             return $this;
  304.         }
  306.         $out = fopen('php://output', 'w');
  307.         $file = fopen($this->file->getPathname(), 'r');
  309.         stream_copy_to_stream($file, $out, $this->maxlen, $this->offset);
  311.         fclose($out);
  312.         fclose($file);
  314.         if ($this->deleteFileAfterSend && is_file($this->file->getPathname())) {
  315.             unlink($this->file->getPathname());
  316.         }
  318.         return $this;
  319.     }
  321.     /**
  322.      * {@inheritdoc}
  323.      *
  324.      * @throws \LogicException when the content is not null
  325.      */
  326.     public function setContent(?string $content)
  327.     {
  328.         if (null !== $content) {
  329.             throw new \LogicException('The content cannot be set on a BinaryFileResponse instance.');
  330.         }
  332.         return $this;
  333.     }
  335.     /**
  336.      * {@inheritdoc}
  337.      */
  338.     public function getContent()
  339.     {
  340.         return false;
  341.     }
  343.     /**
  344.      * Trust X-Sendfile-Type header.
  345.      */
  346.     public static function trustXSendfileTypeHeader()
  347.     {
  348.         self::$trustXSendfileTypeHeader = true;
  349.     }
  351.     /**
  352.      * If this is set to true, the file will be unlinked after the request is sent
  353.      * Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.
  354.      *
  355.      * @return $this
  356.      */
  357.     public function deleteFileAfterSend(bool $shouldDelete = true)
  358.     {
  359.         $this->deleteFileAfterSend = $shouldDelete;
  361.         return $this;
  362.     }
  363. }