public function FileDownloadDownloadController::deliver in File Download 8

Generates a download.

Parameters

\Symfony\Component\HttpFoundation\Request $request: The request object.

string $scheme: The file scheme, defaults to 'private'.

\Drupal\file\Entity $fid: The file id.

Return value

\Symfony\Component\HttpFoundation\BinaryFileResponse|\Symfony\Component\HttpFoundation\Response The transferred file as response or some error response.

Throws

\Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException Thrown when the user does not have access to the file.

\Symfony\Component\HttpKernel\Exception\ServiceUnavailableHttpException Thrown when the file is still being generated.

1 string reference to 'FileDownloadDownloadController::deliver'

file_download.routing.yml in ./file_download.routing.yml

file_download.routing.yml

File

src/Controller/FileDownloadDownloadController.php, line 36

Class

FileDownloadDownloadController

Defines a controller to serve file downloads.

Namespace

Drupal\file_download\Controller

Code

public function deliver(Request $request, $scheme, $fid) {
  $file = File::load($fid);
  if (!is_object($file)) {
    throw new NotFoundHttpException();
  }
  $uri = $file
    ->getFileUri();
  $filename = $file
    ->getFilename();

  // File doesn't exist
  // This may occur if the download path is used outside of a formatter and the file path is wrong or file is gone.
  if (!file_exists($uri)) {
    throw new NotFoundHttpException();
  }
  $headers = $this
    ->moduleHandler()
    ->invokeAll('file_download', [
    $uri,
  ]);
  foreach ($headers as $result) {
    if ($result == -1) {
      throw new AccessDeniedHttpException();
    }
  }
  $mimetype = Unicode::mimeHeaderEncode($file
    ->getMimeType());
  $headers = [
    'Content-Type' => $mimetype,
    'Content-Disposition' => 'attachment; filename="' . $filename . '"',
    'Content-Length' => $file
      ->getSize(),
    'Content-Transfer-Encoding' => 'binary',
    'Pragma' => 'no-cache',
    'Cache-Control' => 'must-revalidate, post-check=0, pre-check=0',
    'Expires' => '0',
    'Accept-Ranges' => 'bytes',
  ];

  // Update file counter.
  if (\Drupal::moduleHandler()
    ->moduleExists('file_download_counter')) {
    $count_downloads = \Drupal::config('file_download_counter.settings')
      ->get('count_downloads');
    if ($count_downloads) {
      file_download_counter_increment_file($fid);
    }
  }

  // \Drupal\Core\EventSubscriber\FinishResponseSubscriber::onRespond()
  // sets response as not cacheable if the Cache-Control header is not
  // already modified. We pass in FALSE for non-private schemes for the
  // $public parameter to make sure we don't change the headers.
  return new BinaryFileResponse($uri, 200, $headers, $scheme !== 'private');
}