function MediaAccessControlHandler::checkAccess

Same name and namespace in other branches
  1. 9 core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler::checkAccess()
  2. 8.9.x core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler::checkAccess()
  3. 11.x core/modules/media/src/MediaAccessControlHandler.php \Drupal\media\MediaAccessControlHandler::checkAccess()

Performs access checks.

This method is supposed to be overwritten by extending classes that do their own custom access checking.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity for which to check access.

string $operation: The entity operation. Usually one of 'view', 'view label', 'update' or 'delete'.

\Drupal\Core\Session\AccountInterface $account: The user for which to check access.

Return value

\Drupal\Core\Access\AccessResultInterface The access result.

Overrides EntityAccessControlHandler::checkAccess

File

core/modules/media/src/MediaAccessControlHandler.php, line 52

Class

MediaAccessControlHandler
Defines an access control handler for media items.

Namespace

Drupal\media

Code

protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
  /** @var \Drupal\media\MediaInterface $entity */
  // Allow admin permission to override all operations.
  if ($account->hasPermission($this->entityType
    ->getAdminPermission())) {
    return AccessResult::allowed()->cachePerPermissions();
  }
  $type = $entity->bundle();
  $is_owner = $account->id() && $account->id() === $entity->getOwnerId();
  switch ($operation) {
    case 'view':
      if ($entity->isPublished()) {
        $access_result = AccessResult::allowedIf($account->hasPermission('view media'))
          ->cachePerPermissions()
          ->addCacheableDependency($entity);
        if (!$access_result->isAllowed()) {
          $access_result->setReason("The 'view media' permission is required when the media item is published.");
        }
      }
      elseif ($account->hasPermission('view own unpublished media')) {
        $access_result = AccessResult::allowedIf($is_owner)->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
        if (!$access_result->isAllowed()) {
          $access_result->setReason("The user must be the owner and the 'view own unpublished media' permission is required when the media item is unpublished.");
        }
      }
      else {
        $access_result = AccessResult::neutral()->cachePerPermissions()
          ->addCacheableDependency($entity)
          ->setReason("The user must be the owner and the 'view own unpublished media' permission is required when the media item is unpublished.");
      }
      return $access_result;
    case 'update':
      if ($account->hasPermission('edit any ' . $type . ' media')) {
        return AccessResult::allowed()->cachePerPermissions();
      }
      if ($account->hasPermission('edit own ' . $type . ' media') && $is_owner) {
        return AccessResult::allowed()->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }
      // @todo Deprecate this permission in
      // https://www.drupal.org/project/drupal/issues/2925459.
      if ($account->hasPermission('update any media')) {
        return AccessResult::allowed()->cachePerPermissions();
      }
      if ($account->hasPermission('update media') && $is_owner) {
        return AccessResult::allowed()->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }
      return AccessResult::neutral("The following permissions are required: 'update any media' OR 'update own media' OR '{$type}: edit any media' OR '{$type}: edit own media'.")->cachePerPermissions();
    case 'delete':
      if ($account->hasPermission('delete any ' . $type . ' media')) {
        return AccessResult::allowed()->cachePerPermissions();
      }
      if ($account->hasPermission('delete own ' . $type . ' media') && $is_owner) {
        return AccessResult::allowed()->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }
      // @todo Deprecate this permission in
      // https://www.drupal.org/project/drupal/issues/2925459.
      if ($account->hasPermission('delete any media')) {
        return AccessResult::allowed()->cachePerPermissions();
      }
      if ($account->hasPermission('delete media') && $is_owner) {
        return AccessResult::allowed()->cachePerPermissions()
          ->cachePerUser()
          ->addCacheableDependency($entity);
      }
      return AccessResult::neutral("The following permissions are required: 'delete any media' OR 'delete own media' OR '{$type}: delete any media' OR '{$type}: delete own media'.")->cachePerPermissions();
    case 'view all revisions':
    case 'view revision':
      if ($account->hasPermission('view any ' . $type . ' media revisions') || $account->hasPermission("view all media revisions")) {
        // Check the access to this revision and if the media passed in is not
        // the default revision then access to that too.
        $entity_access = $entity->access('view', $account, TRUE);
        if (!$entity->isDefaultRevision()) {
          $media_storage = $this->entityTypeManager
            ->getStorage($entity->getEntityTypeId());
          $entity_access->andIf($this->access($media_storage->load($entity->id()), 'view', $account, TRUE));
        }
        return AccessResult::allowed()->cachePerPermissions()
          ->andIf($entity_access);
      }
      return AccessResult::neutral()->cachePerPermissions();
    case 'revert':
      return AccessResult::allowedIfHasPermission($account, 'revert any ' . $type . ' media revisions')->cachePerPermissions()
        ->addCacheableDependency($entity);
    case 'delete revision':
      return AccessResult::allowedIfHasPermission($account, 'delete any ' . $type . ' media revisions')->cachePerPermissions()
        ->addCacheableDependency($entity);
    default:
      return AccessResult::neutral()->cachePerPermissions();
  }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.