You are here

class MediaEntityFileRedirectController in Media Entity File Redirect 8

Class MediaEntityFileRedirectController.

Hierarchy

Expanded class hierarchy of MediaEntityFileRedirectController

File

src/Controller/MediaEntityFileRedirectController.php, line 17

Namespace

Drupal\media_entity_file_redirect\Controller
View source
class MediaEntityFileRedirectController implements ContainerInjectionInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager) {
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * Returns a redirect to file source associated with passed in media entity.
   */
  public function redirectToFile(MediaInterface $media) {

    /** @var \Drupal\media\Entity\MediaType $mediaType */
    $mediaType = $this->entityTypeManager
      ->getStorage('media_type')
      ->load($media
      ->bundle());

    // Make sure this entity uses a file source and that the download route
    // is enabled for it.
    if ($mediaType && $mediaType
      ->getSource() instanceof File && $mediaType
      ->getThirdPartySetting('media_entity_file_redirect', 'enabled', FALSE)) {

      // Now load the file and return a redirect response to the file URL.
      $fid = $media
        ->getSource()
        ->getSourceFieldValue($media);
      if ($fid) {

        /** @var \Drupal\file\FileInterface $file */
        $file = $this->entityTypeManager
          ->getStorage('file')
          ->load($fid);
        if ($file) {

          // Since file_create_url generates bubbleable cache metadata, we need
          // to capture it in a render context so we can add it to our response.
          // Otherwise we'll get a LogicException.
          // See https://drupal.stackexchange.com/questions/273579
          $context = new RenderContext();
          $url = \Drupal::service('renderer')
            ->executeInRenderContext($context, function () use ($file) {
            return file_create_url($file
              ->getFileUri());
          });
          $response = new CacheableRedirectResponse($url);
          $response
            ->addCacheableDependency($mediaType);
          $response
            ->addCacheableDependency($media);
          $response
            ->addCacheableDependency($file);

          // We also need to vary the response by site URL. Without this, if a
          // a site has multiple domains, then the first domain that accesses
          // the file will create a cache entry for the redirect using the
          // domain that was accessed. If the file is then accessed via the
          // other domain, the cache entry will be used and will attempt to
          // redirect the user to the file but using the first domain.
          // Drupal will refuse to do this redirect because it thinks you're
          // redirecting to some untrusted 3rd party domain.
          $response
            ->getCacheableMetadata()
            ->addCacheContexts([
            'url.site',
          ]);
          if (!$context
            ->isEmpty()) {
            $metadata = $context
              ->pop();
            $response
              ->addCacheableDependency($metadata);
          }
          return $response;
        }
      }
    }
    throw new NotFoundHttpException();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
MediaEntityFileRedirectController::$entityTypeManager protected property The entity type manager.
MediaEntityFileRedirectController::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
MediaEntityFileRedirectController::redirectToFile public function Returns a redirect to file source associated with passed in media entity.
MediaEntityFileRedirectController::__construct public function Constructor.