public function EditorFileUsageTest::testEditorEntityHooks

Tests the configurable text editor manager.

File

core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php, line 122

Class

EditorFileUsageTest

Tests tracking of file usage by the Text Editor module.

Namespace

Code

public function testEditorEntityHooks() {
  $image_paths = [
    0 => 'core/misc/druplicon.png',
    1 => 'core/misc/tree.png',
    2 => 'core/misc/help.png',
  ];
  $image_entities = [];
  foreach ($image_paths as $key => $image_path) {
    $image = File::create();
    $image
      ->setFileUri($image_path);
    $image
      ->setFilename(\Drupal::service('file_system')
      ->basename($image
      ->getFileUri()));
    $image
      ->save();
    $file_usage = $this->container
      ->get('file.usage');
    $this
      ->assertSame([], $file_usage
      ->listUsage($image), 'The image ' . $image_paths[$key] . ' has zero usages.');
    $image_entities[] = $image;
  }
  $body = [];
  $description = [];
  foreach ($image_entities as $key => $image_entity) {

    // Don't be rude, say hello.
    $body_value = '<p>Hello, world!</p>';

    // Test handling of a valid image entry.
    $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="' . $image_entity
      ->uuid() . '" />';

    // Test handling of an invalid data-entity-uuid attribute.
    $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="invalid-entity-uuid-value" />';

    // Test handling of an invalid data-entity-type attribute.
    $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="invalid-entity-type-value" data-entity-uuid="' . $image_entity
      ->uuid() . '" />';

    // Test handling of a non-existing UUID.
    $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="30aac704-ba2c-40fc-b609-9ed121aa90f4" />';
    $body[] = [
      'value' => $body_value,
      'format' => 'filtered_html',
    ];
    $description[] = [
      'value' => 'something',
      'format' => 'filtered_html',
    ];
  }

  // Test editor_entity_insert(): increment.
  $this
    ->createUser();
  $node = $node = Node::create([
    'type' => 'page',
    'title' => 'test',
    'body' => $body,
    'description' => $description,
    'uid' => 1,
  ]);
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '1',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 1 usage.');
  }

  // Test editor_entity_update(): increment, twice, by creating new revisions.
  $node
    ->setNewRevision(TRUE);
  $node
    ->save();
  $second_revision_id = $node
    ->getRevisionId();
  $node
    ->setNewRevision(TRUE);
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '3',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
  }

  // Test hook_entity_update(): decrement, by modifying the last revision:
  // remove the data-entity-type attribute from the body field.
  $original_values = [];
  for ($i = 0; $i < count($image_entities); $i++) {
    $original_value = $node->body[$i]->value;
    $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
    $node->body[$i]->value = $new_value;
    $original_values[$i] = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Test editor_entity_update(): increment again by creating a new revision:
  // read the data- attributes to the body field.
  $node
    ->setNewRevision(TRUE);
  foreach ($original_values as $key => $original_value) {
    $node->body[$key]->value = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '3',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
  }

  // Test hook_entity_update(): decrement, by modifying the last revision:
  // remove the data-entity-uuid attribute from the body field.
  foreach ($original_values as $key => $original_value) {
    $original_value = $node->body[$key]->value;
    $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
    $node->body[$key]->value = $new_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Test hook_entity_update(): increment, by modifying the last revision:
  // read the data- attributes to the body field.
  foreach ($original_values as $key => $original_value) {
    $node->body[$key]->value = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '3',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
  }

  // Test editor_entity_revision_delete(): decrement, by deleting a revision.
  $this->container
    ->get('entity_type.manager')
    ->getStorage('node')
    ->deleteRevision($second_revision_id);
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Populate both the body and summary. Because this will be the same
  // revision of the same node, it will record only one usage.
  foreach ($original_values as $key => $original_value) {
    $node->body[$key]->value = $original_value;
    $node->body[$key]->summary = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Empty out the body value, but keep the summary. The number of usages
  // should not change.
  foreach ($original_values as $key => $original_value) {
    $node->body[$key]->value = '';
    $node->body[$key]->summary = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Empty out the body and summary. The number of usages should decrease by
  // one.
  foreach ($original_values as $key => $original_value) {
    $node->body[$key]->value = '';
    $node->body[$key]->summary = '';
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '1',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 1 usage.');
  }

  // Set the field of a custom field type that is a subclass of
  // Drupal\text\Plugin\Field\FieldType\TextItemBase. The number of usages
  // should increase by one.
  foreach ($original_values as $key => $original_value) {
    $node->description[$key]->value = $original_value;
  }
  $node
    ->save();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([
      'editor' => [
        'node' => [
          1 => '2',
        ],
      ],
    ], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
  }

  // Test editor_entity_delete().
  $node
    ->delete();
  foreach ($image_entities as $key => $image_entity) {
    $this
      ->assertSame([], $file_usage
      ->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has zero usages again.');
  }
}