You are here

class DownloadController in Media Download 1.2.x

Same name and namespace in other branches
  1. 1.0.x src/DownloadController.php \Drupal\media_download\DownloadController
  2. 1.1.x src/DownloadController.php \Drupal\media_download\DownloadController

Adds support for direct downloads of media entities.

Copyright (C) 2021 Library Solutions, LLC (et al.).

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Hierarchy

Expanded class hierarchy of DownloadController

1 file declares its use of DownloadController
MediaTest.php in tests/src/Kernel/MediaTest.php

File

src/DownloadController.php, line 24

Namespace

Drupal\media_download
View source
class DownloadController extends ControllerBase {

  /**
   * Attempt to retrieve a file from the supplied media.
   *
   * This method will only return a file if all of the following conditions are
   * satisfied by the supplied media entity:
   *
   * 1. A source field can be determined
   * 2. The source field exists on the supplied media entity
   * 3. At least one field delta references a file that exists on disk
   *
   * @return \Drupal\file\FileInterface|null
   *   A file on success, otherwise NULL.
   *
   * @throws \RuntimeException
   *   If the supplied media entity is NULL, or has no source field.
   */
  protected function getFile(MediaInterface $media) {

    // Ensure that the source field can be determined for this media.
    if (!isset($media) || empty($source_field = $media
      ->getSource()
      ->getConfiguration()['source_field'] ?? NULL) || !$media
      ->hasField($source_field)) {
      throw new \RuntimeException("No source field available for the requested entity.");
    }

    // Attempt to locate a valid file in the source field.
    foreach ($media->{$source_field} as $item) {

      // Skip this field item if it doesn't reference a file entity.
      if (!$item->entity instanceof FileInterface) {
        continue;
      }

      // Skip this field item if the referenced file doesn't exist.
      if (!file_exists($item->entity
        ->getFileUri())) {
        continue;
      }
      return $item->entity;
    }
    return NULL;
  }

  /**
   * Download the primary file resource referenced by the supplied media entity.
   *
   * By default, an inline content disposition is used to allow the media file
   * to be viewed in the browser. If `dl=1` is passed as a query parameter, then
   * the browser will be instructed to save the file to disk.
   *
   * @param \Drupal\media\MediaInterface $media
   *   The media entity for which to initiate a file download.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   When a valid file cannot be found for the supplied media entity.
   *
   * @return \Drupal\media_download\CacheableBinaryFileResponse
   *   A cacheable binary file response.
   */
  public function save(MediaInterface $media, Request $request) {
    $cacheability = new CacheableMetadata();

    // Ensure that a file is referenced by the source field, and it exists.
    if (empty($file = $this
      ->getFile($media))) {
      throw new NotFoundHttpException("There is no file associated with the requested entity.");
    }

    // Add both the media entity and the file entity that it references as
    // cacheable dependencies for this response.
    $cacheability
      ->addCacheableDependency($file);
    $cacheability
      ->addCacheableDependency($media);

    // Since the content disposition header depends on the query string, ensure
    // that the query string is part of the cache metadata.
    $cacheability
      ->addCacheContexts([
      'url.query_args:dl',
    ]);

    // Create a new response object to download the requested file.
    $response = new CacheableBinaryFileResponse($file
      ->getFileUri());
    $response
      ->addCacheableDependency($cacheability);

    // Force a direct download if dl=1 is in the query string.
    if ($request->query
      ->get('dl') === '1') {
      $response
        ->setContentDisposition('attachment');
    }
    else {
      $response
        ->setContentDisposition('inline');
    }

    // Clear the Cache-Control header so it can be calculated automatically.
    $response->headers
      ->set('Cache-Control', '');

    // Automatically calculate the ETag and Last-Modified headers.
    $response
      ->setAutoEtag();
    $response
      ->setAutoLastModified();
    return $response;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 46
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
DownloadController::getFile protected function Attempt to retrieve a file from the supplied media.
DownloadController::save public function Download the primary file resource referenced by the supplied media entity.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.