Issue #2716201 by Denchev, slashrsm, CTaPByK: Add configurable access denied message "Download link" field formatter.

Author: git

config/schema/file_entity.schema.yml

@@ -57,6 +57,9 @@ field.formatter.settings.file_download_link:
   type: mapping
   label: 'File download link display format settings'
   mapping:
+    access_message:
+      type: string
+      label: 'Access message'
     text:
       type: string
       label: 'Link text'

src/Plugin/Field/FieldFormatter/FileDownloadLinkFormatter.php

@@ -1,13 +1,7 @@
 <?php
 
-/**
- * @file
- *  Contains Drupal\file_entity\Plugin\Field\FieldFormatter\FileDownloadLinkFormatter
- */
-
 namespace Drupal\file_entity\Plugin\Field\FieldFormatter;
 
-
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
@@ -107,6 +101,12 @@ public static function create(ContainerInterface $container, array $configuratio
    * {@inheritdoc}
    */
   public function settingsForm(array $form, FormStateInterface $form_state) {
+    $element['access_message'] = [
+      '#type' => 'textfield',
+      '#title' => t('No access message'),
+      '#description' => t("This text is shown instead of the download link if the user doesn't have permission to download the file."),
+      '#default_value' => $this->getSetting('access_message'),
+    ];
     $element['text'] = array(
       '#type' => 'textfield',
       '#title' => t('Link text'),
@@ -132,9 +132,10 @@ public function settingsForm(array $form, FormStateInterface $form_state) {
    * {@inheritdoc}
    */
   public static function defaultSettings() {
-    return array(
+    return [
+      'access_message' => "You don't have access to download this file.",
       'text' => 'Download [file:name]',
-    ) + parent::defaultSettings();
+    ] + parent::defaultSettings();
   }
 
   /**
@@ -159,17 +160,25 @@ public function viewElements(FieldItemListInterface $items, $langcode) {
       // Set options as per anchor format described at
       // http://microformats.org/wiki/file-format-examples
       $download_url = $file->downloadUrl(array('attributes' => array('type' => $mime_type . '; length=' . $file->getSize())));
-      $elements[$delta] = array(
-        '#theme' => 'file_entity_download_link',
-        '#file' => $file,
-        '#download_link' => Link::fromTextAndUrl($link_text, $download_url),
-        '#icon' => file_icon_class($mime_type),
-        '#attributes' => $attributes,
-        '#file_size' => format_size($file->getSize()),
-      );
+      if ($file->access('download')) {
+        $elements[$delta] = [
+          '#theme' => 'file_entity_download_link',
+          '#file' => $file,
+          '#download_link' => Link::fromTextAndUrl($link_text, $download_url),
+          '#icon' => file_icon_class($mime_type),
+          '#attributes' => $attributes,
+          '#file_size' => format_size($file->getSize()),
+        ];
+      }
+      else {
+        $elements[$delta] = [
+          '#markup' => $this->getSetting('access_message'),
+        ];
+      }
       $this->renderer->addCacheableDependency($elements[$delta], $file);
     }
 
     return $elements;
   }
+
 }

src/Tests/FileEntityAccessTest.php

@@ -1,14 +1,10 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\file_entity\Tests\FileEntityAccessTest.
- */
-
 namespace Drupal\file_entity\Tests;
 
 use Drupal\file\FileInterface;
 use Drupal\file_entity\FileEntityAccessControlHandler;
+use Drupal\node\Entity\Node;
 
 /**
  * Tests the access aspects of file entity.
@@ -17,6 +13,13 @@
  */
 class FileEntityAccessTest extends FileEntityTestBase {
 
+  /**
+   * Modules to install.
+   *
+   * @var array
+   */
+  public static $modules = ['node'];
+
   /**
    * The File Entity access controller.
    *
@@ -225,4 +228,69 @@ function testFileEntityPrivateDownloadAccess() {
       }
     }
   }
+
+  /**
+   * Tests file download access.
+   */
+  public function testDownloadLinkAccess() {
+    // Create content type with image field.
+    $this->drupalCreateContentType([
+      'name' => 'Article',
+      'type' => 'article',
+    ]);
+    \Drupal::entityTypeManager()->getStorage('field_storage_config')->create([
+      'field_name' => 'image',
+      'entity_type' => 'node',
+      'type' => 'image',
+      'cardinality' => 1,
+    ])->save();
+    \Drupal::entityTypeManager()->getStorage('field_config')->create([
+      'field_name' => 'image',
+      'label' => 'Image',
+      'entity_type' => 'node',
+      'bundle' => 'article',
+    ])->save();
+    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
+    $form_display = \Drupal::entityTypeManager()->getStorage('entity_form_display')->load('node.article.default');
+    $form_display->setComponent('image', [
+      'type' => 'image_image',
+    ])->save();
+    /** @var \Drupal\Core\Entity\Display\EntityViewDisplayInterface $view_display */
+    $view_display = \Drupal::entityTypeManager()->getStorage('entity_view_display')->load('node.article.default');
+    $view_display->setComponent('image', [
+      'type' => 'file_download_link',
+    ])->save();
+
+    $account = $this->drupalCreateUser([
+      'download any image files',
+    ]);
+    $this->drupalLogin($account);
+    $image = current($this->files['image']);
+    $node = Node::create([
+      'title' => 'Title',
+      'type' => 'article',
+      'image' => [
+        'target_id' => $image->id(),
+        'alt' => 'the image alternative',
+      ],
+    ]);
+    $node->save();
+    $this->drupalGet('node/' . $node->id());
+
+    $this->assertRaw('file/' . $image->id() . '/download', 'Download link available.');
+    $this->assertLink('Download image-test.png');
+
+    $this->drupalLogout();
+    $this->drupalGet('node/' . $node->id());
+    $this->assertText("You don't have access to download this file.", 'No access message displays correctly.');
+    $view_display->setComponent('image', [
+      'type' => 'file_download_link',
+      'settings' => [
+        'access_message' => 'Another message.',
+      ],
+    ])->save();
+    $this->drupalGet('node/' . $node->id());
+    $this->assertText('Another message.', 'No access message updated.');
+  }
+
 }