From d686df4aa58baf2ed64c42a1b23408154b8ad6f5 Mon Sep 17 00:00:00 2001
From: Lee Rowlands <lee.rowlands@previousnext.com.au>
Date: Mon, 9 Jan 2023 09:27:50 +1000
Subject: [PATCH] Issue #1984588 by dpi, larowlan, AaronMcHale, smustgrave,
xjm, acbramley: Add Block Content revision UI
---
core/core.link_relation_types.yml | 6 +
.../Controller/VersionHistoryController.php | 9 +-
.../block_content/block_content.install | 24 ++
.../src/BlockContentAccessControlHandler.php | 46 ++-
.../src/BlockContentPermissions.php | 36 +-
.../block_content/src/Entity/BlockContent.php | 10 +-
.../BlockContentRevisionDeleteTest.php | 85 +++++
.../BlockContentRevisionRevertTest.php | 87 +++++
...BlockContentRevisionVersionHistoryTest.php | 94 +++++
.../Kernel/BlockContentAccessHandlerTest.php | 341 ++++++++++++++----
10 files changed, 650 insertions(+), 88 deletions(-)
create mode 100644 core/modules/block_content/tests/src/Functional/BlockContentRevisionDeleteTest.php
create mode 100644 core/modules/block_content/tests/src/Functional/BlockContentRevisionRevertTest.php
create mode 100644 core/modules/block_content/tests/src/Functional/BlockContentRevisionVersionHistoryTest.php
diff --git a/core/core.link_relation_types.yml b/core/core.link_relation_types.yml
index 50da734474bb..c974fbe25cb4 100644
--- a/core/core.link_relation_types.yml
+++ b/core/core.link_relation_types.yml
@@ -15,6 +15,12 @@ delete-multiple-form:
revision:
uri: https://drupal.org/link-relations/revision
description: A particular version of this resource.
+revision-revert-form:
+ uri: https://drupal.org/link-relations/revision-revert-form
+ description: A form where a particular version of this resource can be reverted.
+revision-delete-form:
+ uri: https://drupal.org/link-relations/revision-delete-form
+ description: A form where a particular version of this resource can be deleted.
create:
uri: https://drupal.org/link-relations/create
description: A REST resource URL where a resource of this type can be created.
diff --git a/core/lib/Drupal/Core/Entity/Controller/VersionHistoryController.php b/core/lib/Drupal/Core/Entity/Controller/VersionHistoryController.php
index def6fe1cde7b..8d069e5aeabc 100644
--- a/core/lib/Drupal/Core/Entity/Controller/VersionHistoryController.php
+++ b/core/lib/Drupal/Core/Entity/Controller/VersionHistoryController.php
@@ -11,6 +11,7 @@
use Drupal\Core\Entity\RevisionableStorageInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Language\LanguageManagerInterface;
+use Drupal\Core\Link;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Entity\RevisionLogInterface;
@@ -155,10 +156,10 @@ protected function getRevisionDescription(RevisionableInterface $revision): arra
$linkText = $revision->access('view label') ? $revision->label() : $this->t('- Restricted access -');
}
- $revisionViewLink = $revision->toLink($linkText, 'revision');
- $context['revision'] = $revisionViewLink->getUrl()->access()
- ? $revisionViewLink->toString()
- : (string) $revisionViewLink->getText();
+ $url = $revision->hasLinkTemplate('revision') ? $revision->toUrl('revision') : NULL;
+ $context['revision'] = $url && $url->access()
+ ? Link::fromTextAndUrl($linkText, $url)->toString()
+ : (string) $linkText;
$context['message'] = $revision instanceof RevisionLogInterface ? [
'#markup' => $revision->getRevisionLogMessage(),
'#allowed_tags' => Xss::getHtmlTagList(),
diff --git a/core/modules/block_content/block_content.install b/core/modules/block_content/block_content.install
index af22b6252740..3a9fb83b7b56 100644
--- a/core/modules/block_content/block_content.install
+++ b/core/modules/block_content/block_content.install
@@ -5,9 +5,33 @@
* Install, update and uninstall functions for the block_content module.
*/
+use Drupal\Core\Entity\Form\RevisionDeleteForm;
+use Drupal\Core\Entity\Form\RevisionRevertForm;
+use Drupal\Core\Entity\Routing\RevisionHtmlRouteProvider;
+use Drupal\Core\StringTranslation\TranslatableMarkup;
+
/**
* Implements hook_update_last_removed().
*/
function block_content_update_last_removed() {
return 8600;
}
+
+/**
+ * Update entity definition to handle revision routes.
+ */
+function block_content_update_10100(&$sandbox = NULL): TranslatableMarkup {
+ $entityDefinitionUpdateManager = \Drupal::entityDefinitionUpdateManager();
+ $definition = $entityDefinitionUpdateManager->getEntityType('block_content');
+ $routeProviders = $definition->get('route_provider');
+ $routeProviders['revision'] = RevisionHtmlRouteProvider::class;
+ $definition
+ ->setFormClass('revision-delete', RevisionDeleteForm::class)
+ ->setFormClass('revision-revert', RevisionRevertForm::class)
+ ->set('route_provider', $routeProviders)
+ ->setLinkTemplate('revision-delete-form', '/block/{block_content}/revision/{block_content_revision}/delete')
+ ->setLinkTemplate('revision-revert-form', '/block/{block_content}/revision/{block_content_revision}/revert')
+ ->setLinkTemplate('version-history', '/block/{block_content}/revisions');
+ $entityDefinitionUpdateManager->updateEntityType($definition);
+ return \t('Added revision routes to Custom block entity type.');
+}
diff --git a/core/modules/block_content/src/BlockContentAccessControlHandler.php b/core/modules/block_content/src/BlockContentAccessControlHandler.php
index 1a6a31abd08e..0f09a45689d5 100644
--- a/core/modules/block_content/src/BlockContentAccessControlHandler.php
+++ b/core/modules/block_content/src/BlockContentAccessControlHandler.php
@@ -5,6 +5,7 @@
use Drupal\block_content\Access\DependentAccessInterface;
use Drupal\block_content\Event\BlockContentGetDependencyEvent;
use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultInterface;
use Drupal\Core\Entity\EntityHandlerInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityAccessControlHandler;
@@ -54,27 +55,40 @@ public static function createInstance(ContainerInterface $container, EntityTypeI
* {@inheritdoc}
*/
protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
- // Allow view and update access to user with the 'edit any (type) block
- // content' permission or the 'administer blocks' permission.
- $edit_any_permission = 'edit any ' . $entity->bundle() . ' block content';
- if ($operation === 'view') {
- $access = AccessResult::allowedIf($entity->isPublished())
+ assert($entity instanceof BlockContentInterface);
+ $bundle = $entity->bundle();
+ $forbidIfNotDefaultAndLatest = fn (): AccessResultInterface => AccessResult::forbiddenIf($entity->isDefaultRevision() && $entity->isLatestRevision());
+ $forbidIfNotReusable = fn (): AccessResultInterface => AccessResult::forbiddenIf($entity->isReusable() === FALSE, sprintf('Block content must be reusable to use `%s` operation', $operation));
+ $access = match ($operation) {
+ // Allow view and update access to user with the 'edit any (type) block
+ // content' permission or the 'administer blocks' permission.
+ 'view' => AccessResult::allowedIf($entity->isPublished())
->orIf(AccessResult::allowedIfHasPermission($account, 'administer blocks'))
- ->orIf(AccessResult::allowedIfHasPermission($account, $edit_any_permission));
- }
- elseif ($operation === 'update') {
- $access = AccessResult::allowedIfHasPermission($account, 'administer blocks')
- ->orIf(AccessResult::allowedIfHasPermission($account, $edit_any_permission));
- }
- else {
- $access = parent::checkAccess($entity, $operation, $account);
- }
+ ->orIf(AccessResult::allowedIfHasPermission($account, 'edit any ' . $bundle . ' block content')),
+ 'update' => AccessResult::allowedIfHasPermission($account, 'administer blocks')
+ ->orIf(AccessResult::allowedIfHasPermission($account, 'edit any ' . $bundle . ' block content')),
+
+ // Revisions.
+ 'view all revisions' => AccessResult::allowedIfHasPermissions($account, [
+ 'administer blocks',
+ 'view any ' . $bundle . ' block content history',
+ ], 'OR'),
+ 'revert' => AccessResult::allowedIfHasPermissions($account, [
+ 'administer blocks',
+ 'revert any ' . $bundle . ' block content revisions',
+ ], 'OR')->orIf($forbidIfNotDefaultAndLatest())->orIf($forbidIfNotReusable()),
+ 'delete revision' => AccessResult::allowedIfHasPermissions($account, [
+ 'administer blocks',
+ 'delete any ' . $bundle . ' block content revisions',
+ ], 'OR')->orIf($forbidIfNotDefaultAndLatest())->orIf($forbidIfNotReusable()),
+
+ default => parent::checkAccess($entity, $operation, $account),
+ };
// Add the entity as a cacheable dependency because access will at least be
// determined by whether the block is reusable.
$access->addCacheableDependency($entity);
- /** @var \Drupal\block_content\BlockContentInterface $entity */
- if ($entity->isReusable() === FALSE) {
+ if ($entity->isReusable() === FALSE && $access->isForbidden() !== TRUE) {
if (!$entity instanceof DependentAccessInterface) {
throw new \LogicException("Non-reusable block entities must implement \Drupal\block_content\Access\DependentAccessInterface for access control.");
}
diff --git a/core/modules/block_content/src/BlockContentPermissions.php b/core/modules/block_content/src/BlockContentPermissions.php
index e6be17d0aad4..762379379e35 100644
--- a/core/modules/block_content/src/BlockContentPermissions.php
+++ b/core/modules/block_content/src/BlockContentPermissions.php
@@ -3,17 +3,40 @@
namespace Drupal\block_content;
use Drupal\block_content\Entity\BlockContentType;
+use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Entity\BundlePermissionHandlerTrait;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Provide dynamic permissions for blocks of different types.
*/
-class BlockContentPermissions {
+class BlockContentPermissions implements ContainerInjectionInterface {
use StringTranslationTrait;
use BundlePermissionHandlerTrait;
+ /**
+ * Constructs a BlockContentPermissions instance.
+ *
+ * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
+ * Entity type manager.
+ */
+ public function __construct(
+ protected EntityTypeManagerInterface $entityTypeManager,
+ ) {
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public static function create(ContainerInterface $container) {
+ return new static(
+ $container->get('entity_type.manager'),
+ );
+ }
+
/**
* Build permissions for each block type.
*
@@ -21,7 +44,7 @@ class BlockContentPermissions {
* The block type permissions.
*/
public function blockTypePermissions() {
- return $this->generatePermissions(BlockContentType::loadMultiple(), [$this, 'buildPermissions']);
+ return $this->generatePermissions($this->entityTypeManager->getStorage('block_content_type')->loadMultiple(), [$this, 'buildPermissions']);
}
/**
@@ -40,6 +63,15 @@ protected function buildPermissions(BlockContentType $type) {
"edit any $type_id block content" => [
'title' => $this->t('%type_name: Edit any block content', $type_params),
],
+ "view any $type_id block content history" => [
+ 'title' => $this->t('%type_name: View any block content history pages', $type_params),
+ ],
+ "revert any $type_id block content revisions" => [
+ 'title' => $this->t('%type_name: Revert any block content revisions', $type_params),
+ ],
+ "delete any $type_id block content revisions" => [
+ 'title' => $this->t('%type_name: Delete any block content revisions', $type_params),
+ ],
];
}
diff --git a/core/modules/block_content/src/Entity/BlockContent.php b/core/modules/block_content/src/Entity/BlockContent.php
index b12536d95d8f..dcbe2005b311 100644
--- a/core/modules/block_content/src/Entity/BlockContent.php
+++ b/core/modules/block_content/src/Entity/BlockContent.php
@@ -34,7 +34,12 @@
* "add" = "Drupal\block_content\BlockContentForm",
* "edit" = "Drupal\block_content\BlockContentForm",
* "delete" = "Drupal\block_content\Form\BlockContentDeleteForm",
- * "default" = "Drupal\block_content\BlockContentForm"
+ * "default" = "Drupal\block_content\BlockContentForm",
+ * "revision-delete" = \Drupal\Core\Entity\Form\RevisionDeleteForm::class,
+ * "revision-revert" = \Drupal\Core\Entity\Form\RevisionRevertForm::class,
+ * },
+ * "route_provider" = {
+ * "revision" = \Drupal\Core\Entity\Routing\RevisionHtmlRouteProvider::class,
* },
* "translation" = "Drupal\block_content\BlockContentTranslationHandler"
* },
@@ -50,6 +55,9 @@
* "edit-form" = "/block/{block_content}",
* "collection" = "/admin/structure/block/block-content",
* "create" = "/block",
+ * "revision-delete-form" = "/block/{block_content}/revision/{block_content_revision}/delete",
+ * "revision-revert-form" = "/block/{block_content}/revision/{block_content_revision}/revert",
+ * "version-history" = "/block/{block_content}/revisions",
* },
* translatable = TRUE,
* entity_keys = {
diff --git a/core/modules/block_content/tests/src/Functional/BlockContentRevisionDeleteTest.php b/core/modules/block_content/tests/src/Functional/BlockContentRevisionDeleteTest.php
new file mode 100644
index 000000000000..fb96554072e9
--- /dev/null
+++ b/core/modules/block_content/tests/src/Functional/BlockContentRevisionDeleteTest.php
@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\block_content\Functional;
+
+/**
+ * Block content revision delete form test.
+ *
+ * @group block_content
+ * @coversDefaultClass \Drupal\Core\Entity\Form\RevisionDeleteForm
+ */
+class BlockContentRevisionDeleteTest extends BlockContentTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $permissions = [
+ 'view any basic block content history',
+ 'delete any basic block content revisions',
+ ];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+ $this->drupalLogin($this->adminUser);
+ $this->drupalPlaceBlock('page_title_block');
+ }
+
+ /**
+ * Tests revision delete.
+ */
+ public function testDeleteForm(): void {
+ $entity = $this->createBlockContent(save: FALSE)
+ ->setRevisionCreationTime((new \DateTimeImmutable('11 January 2009 4pm'))->getTimestamp())
+ ->setRevisionTranslationAffected(TRUE);
+ $entity->setNewRevision();
+ $entity->save();
+ $revisionId = $entity->getRevisionId();
+
+ // Cannot delete latest revision.
+ $this->drupalGet($entity->toUrl('revision-delete-form'));
+ $this->assertSession()->statusCodeEquals(403);
+
+ // Create a new latest revision.
+ $entity
+ ->setRevisionCreationTime((new \DateTimeImmutable('11 January 2009 5pm'))->getTimestamp())
+ ->setRevisionTranslationAffected(TRUE)
+ ->setNewRevision();
+ $entity->save();
+
+ // Reload the entity.
+ $revision = \Drupal::entityTypeManager()->getStorage('block_content')
+ ->loadRevision($revisionId);
+ $this->drupalGet($revision->toUrl('revision-delete-form'));
+ $this->assertSession()->pageTextContains('Are you sure you want to delete the revision from Sun, 01/11/2009 - 16:00?');
+ $this->assertSession()->buttonExists('Delete');
+ $this->assertSession()->linkExists('Cancel');
+
+ $countRevisions = static function (): int {
+ return (int) \Drupal::entityTypeManager()->getStorage('block_content')
+ ->getQuery()
+ ->accessCheck(FALSE)
+ ->allRevisions()
+ ->count()
+ ->execute();
+ };
+
+ $count = $countRevisions();
+ $this->submitForm([], 'Delete');
+ $this->assertEquals($count - 1, $countRevisions());
+ $this->assertSession()->statusCodeEquals(200);
+ $this->assertSession()->addressEquals(sprintf('block/%s/revisions', $entity->id()));
+ $this->assertSession()->pageTextContains(sprintf('Revision from Sun, 01/11/2009 - 16:00 of basic %s has been deleted.', $entity->label()));
+ $this->assertSession()->elementsCount('css', 'table tbody tr', 1);
+ }
+
+}
diff --git a/core/modules/block_content/tests/src/Functional/BlockContentRevisionRevertTest.php b/core/modules/block_content/tests/src/Functional/BlockContentRevisionRevertTest.php
new file mode 100644
index 000000000000..48ab25c989cb
--- /dev/null
+++ b/core/modules/block_content/tests/src/Functional/BlockContentRevisionRevertTest.php
@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\block_content\Functional;
+
+/**
+ * Block content revision form test.
+ *
+ * @group block_content
+ * @coversDefaultClass \Drupal\Core\Entity\Form\RevisionRevertForm
+ */
+class BlockContentRevisionRevertTest extends BlockContentTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $permissions = [
+ 'view any basic block content history',
+ 'revert any basic block content revisions',
+ ];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+ $this->drupalLogin($this->adminUser);
+ $this->drupalPlaceBlock('page_title_block');
+ }
+
+ /**
+ * Tests revision revert.
+ */
+ public function testRevertForm(): void {
+ $entity = $this->createBlockContent(save: FALSE)
+ ->setRevisionCreationTime((new \DateTimeImmutable('11 January 2009 4pm'))->getTimestamp())
+ ->setRevisionTranslationAffected(TRUE);
+ $entity->setNewRevision();
+ $entity->save();
+ $revisionId = $entity->getRevisionId();
+
+ // Cannot revert latest revision.
+ $this->drupalGet($entity->toUrl('revision-revert-form'));
+ $this->assertSession()->statusCodeEquals(403);
+
+ // Create a new latest revision.
+ $entity
+ ->setRevisionCreationTime((new \DateTimeImmutable('11 January 2009 5pm'))->getTimestamp())
+ ->setRevisionTranslationAffected(TRUE)
+ ->setNewRevision();
+ $entity->save();
+
+ // Reload the entity.
+ $revision = \Drupal::entityTypeManager()->getStorage('block_content')
+ ->loadRevision($revisionId);
+ $this->drupalGet($revision->toUrl('revision-revert-form'));
+ $this->assertSession()->pageTextContains('Are you sure you want to revert to the revision from Sun, 01/11/2009 - 16:00?');
+ $this->assertSession()->buttonExists('Revert');
+ $this->assertSession()->linkExists('Cancel');
+
+ $countRevisions = static function (): int {
+ return (int) \Drupal::entityTypeManager()->getStorage('block_content')
+ ->getQuery()
+ ->accessCheck(FALSE)
+ ->allRevisions()
+ ->count()
+ ->execute();
+ };
+
+ $count = $countRevisions();
+ $this->submitForm([], 'Revert');
+ $this->assertEquals($count + 1, $countRevisions());
+ $this->assertSession()->statusCodeEquals(200);
+ $this->assertSession()->addressEquals(sprintf('block/%s/revisions', $entity->id()));
+ $this->assertSession()->pageTextContains(sprintf('basic %s has been reverted to the revision from Sun, 01/11/2009 - 16:00.', $entity->label()));
+ // Three rows, from the top: the newly reverted revision, the revision from
+ // 5pm, and the revision from 4pm.
+ $this->assertSession()->elementsCount('css', 'table tbody tr', 3);
+ }
+
+}
diff --git a/core/modules/block_content/tests/src/Functional/BlockContentRevisionVersionHistoryTest.php b/core/modules/block_content/tests/src/Functional/BlockContentRevisionVersionHistoryTest.php
new file mode 100644
index 000000000000..dd3fad4aac5d
--- /dev/null
+++ b/core/modules/block_content/tests/src/Functional/BlockContentRevisionVersionHistoryTest.php
@@ -0,0 +1,94 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\Tests\block_content\Functional;
+
+/**
+ * Block content version history test.
+ *
+ * @group block_content
+ * @coversDefaultClass \Drupal\Core\Entity\Controller\VersionHistoryController
+ */
+class BlockContentRevisionVersionHistoryTest extends BlockContentTestBase {
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $defaultTheme = 'stark';
+
+ /**
+ * {@inheritdoc}
+ */
+ protected $permissions = [
+ 'view any basic block content history',
+ 'revert any basic block content revisions',
+ 'delete any basic block content revisions',
+ ];
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function setUp(): void {
+ parent::setUp();
+ $this->drupalLogin($this->adminUser);
+ }
+
+ /**
+ * Tests version history page.
+ */
+ public function testVersionHistory(): void {
+ $entity = $this->createBlockContent(save: FALSE);
+
+ $entity
+ ->setInfo('first revision')
+ ->setRevisionCreationTime((new \DateTimeImmutable('1st June 2020 7am'))->getTimestamp())
+ ->setRevisionLogMessage('first revision log')
+ ->setRevisionUser($this->drupalCreateUser(name: 'first author'))
+ ->setNewRevision();
+ $entity->save();
+
+ $entity
+ ->setInfo('second revision')
+ ->setRevisionCreationTime((new \DateTimeImmutable('2nd June 2020 8am'))->getTimestamp())
+ ->setRevisionLogMessage('second revision log')
+ ->setRevisionUser($this->drupalCreateUser(name: 'second author'))
+ ->setNewRevision();
+ $entity->save();
+
+ $entity
+ ->setInfo('third revision')
+ ->setRevisionCreationTime((new \DateTimeImmutable('3rd June 2020 9am'))->getTimestamp())
+ ->setRevisionLogMessage('third revision log')
+ ->setRevisionUser($this->drupalCreateUser(name: 'third author'))
+ ->setNewRevision();
+ $entity->save();
+
+ $this->drupalGet($entity->toUrl('version-history'));
+ $this->assertSession()->elementsCount('css', 'table tbody tr', 3);
+
+ // Order is newest to oldest revision by creation order.
+ $row1 = $this->assertSession()->elementExists('css', 'table tbody tr:nth-child(1)');
+ // Latest revision does not have revert or delete revision operation.
+ $this->assertSession()->elementNotExists('named', ['link', 'Revert'], $row1);
+ $this->assertSession()->elementNotExists('named', ['link', 'Delete'], $row1);
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(1)', 'Current revision');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(1)', 'third revision log');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(1)', '06/03/2020 - 09:00 by third author');
+
+ $row2 = $this->assertSession()->elementExists('css', 'table tbody tr:nth-child(2)');
+ $this->assertSession()->elementExists('named', ['link', 'Revert'], $row2);
+ $this->assertSession()->elementExists('named', ['link', 'Delete'], $row2);
+ $this->assertSession()->elementTextNotContains('css', 'table tbody tr:nth-child(2)', 'Current revision');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(2)', 'second revision log');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(2)', '06/02/2020 - 08:00 by second author');
+
+ $row3 = $this->assertSession()->elementExists('css', 'table tbody tr:nth-child(3)');
+ $this->assertSession()->elementExists('named', ['link', 'Revert'], $row3);
+ $this->assertSession()->elementExists('named', ['link', 'Delete'], $row3);
+ $this->assertSession()->elementTextNotContains('css', 'table tbody tr:nth-child(2)', 'Current revision');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(3)', 'first revision log');
+ $this->assertSession()->elementTextContains('css', 'table tbody tr:nth-child(3)', '06/01/2020 - 07:00 by first author');
+ }
+
+}
diff --git a/core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php b/core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php
index 62f63b5f7ad4..1db8a0e220a2 100644
--- a/core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php
+++ b/core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php
@@ -6,7 +6,10 @@
use Drupal\block_content\Entity\BlockContent;
use Drupal\block_content\Entity\BlockContentType;
use Drupal\Core\Access\AccessibleInterface;
-use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultAllowed;
+use Drupal\Core\Access\AccessResultForbidden;
+use Drupal\Core\Access\AccessResultNeutral;
+use Drupal\Core\Access\AccessResultReasonInterface;
use Drupal\KernelTests\KernelTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\Entity\User;
@@ -97,11 +100,50 @@ protected function setUp(): void {
}
/**
+ * Test block content entity access.
+ *
+ * @param string $operation
+ * The entity operation to test.
+ * @param bool $published
+ * Whether the latest revision should be published.
+ * @param bool $reusable
+ * Whether the block content should be reusable. Non-reusable blocks are
+ * typically used in Layout Builder.
+ * @param array $permissions
+ * Permissions to grant to the test user.
+ * @param bool $isLatest
+ * Whether the block content should be the latest revision when checking
+ * access. If FALSE, multiple revisions will be created, and an older
+ * revision will be loaded before checking access.
+ * @param string|null $parent_access
+ * Whether the test user has access to the parent entity, valid values are
+ * class names of classes implementing AccessResultInterface. Set to NULL to
+ * assert parent will not be called.
+ * @param string $expected_access
+ * The expected access for the user and block content. Valid values are
+ * class names of classes implementing AccessResultInterface
+ * @param string|null $expected_access_message
+ * The expected access message.
+ *
* @covers ::checkAccess
*
* @dataProvider providerTestAccess
+ *
+ * @phpstan-param class-string<\Drupal\Core\Access\AccessResultInterface>|null $parent_access
+ * @phpstan-param class-string<\Drupal\Core\Access\AccessResultInterface> $expected_access
*/
- public function testAccess($operation, $published, $reusable, $permissions, $parent_access, $expected_access) {
+ public function testAccess(string $operation, bool $published, bool $reusable, array $permissions, bool $isLatest, ?string $parent_access, string $expected_access, ?string $expected_access_message = NULL) {
+ /** @var \Drupal\Core\Entity\RevisionableStorageInterface $entityStorage */
+ $entityStorage = \Drupal::entityTypeManager()->getStorage('block_content');
+
+ $loadRevisionId = NULL;
+ if (!$isLatest) {
+ // Save a historical revision, then setup for a new revision to be saved.
+ $this->blockEntity->save();
+ $loadRevisionId = $this->blockEntity->getRevisionId();
+ $this->blockEntity = $entityStorage->createRevision($this->blockEntity);
+ }
+
$published ? $this->blockEntity->setPublished() : $this->blockEntity->setUnpublished();
$reusable ? $this->blockEntity->setReusable() : $this->blockEntity->setNonReusable();
@@ -119,22 +161,9 @@ public function testAccess($operation, $published, $reusable, $permissions, $par
$user->addRole($this->role->id());
$user->save();
- if ($parent_access) {
+ if ($parent_access !== NULL) {
$parent_entity = $this->prophesize(AccessibleInterface::class);
- $expected_parent_result = NULL;
- switch ($parent_access) {
- case 'allowed':
- $expected_parent_result = AccessResult::allowed();
- break;
-
- case 'neutral':
- $expected_parent_result = AccessResult::neutral();
- break;
-
- case 'forbidden':
- $expected_parent_result = AccessResult::forbidden();
- break;
- }
+ $expected_parent_result = new ($parent_access)();
$parent_entity->access($operation, $user, TRUE)
->willReturn($expected_parent_result)
->shouldBeCalled();
@@ -144,125 +173,131 @@ public function testAccess($operation, $published, $reusable, $permissions, $par
}
$this->blockEntity->save();
- $result = $this->accessControlHandler->access($this->blockEntity, $operation, $user, TRUE);
- switch ($expected_access) {
- case 'allowed':
- $this->assertTrue($result->isAllowed());
- break;
-
- case 'forbidden':
- $this->assertTrue($result->isForbidden());
- break;
-
- case 'neutral':
- $this->assertTrue($result->isNeutral());
- break;
+ // Reload a previous revision.
+ if ($loadRevisionId !== NULL) {
+ $this->blockEntity = $entityStorage->loadRevision($loadRevisionId);
+ }
- default:
- $this->fail('Unexpected access type');
+ $result = $this->accessControlHandler->access($this->blockEntity, $operation, $user, TRUE);
+ $this->assertInstanceOf($expected_access, $result);
+ if ($expected_access_message !== NULL) {
+ $this->assertInstanceOf(AccessResultReasonInterface::class, $result);
+ $this->assertEquals($expected_access_message, $result->getReason());
}
}
/**
* Data provider for testAccess().
*/
- public function providerTestAccess() {
+ public function providerTestAccess(): array {
$cases = [
'view:published:reusable' => [
'view',
TRUE,
TRUE,
[],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:unpublished:reusable' => [
'view',
FALSE,
TRUE,
[],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
'view:unpublished:reusable:admin' => [
'view',
FALSE,
TRUE,
['administer blocks'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:unpublished:reusable:per-block-editor:basic' => [
'view',
FALSE,
TRUE,
['edit any basic block content'],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
'view:unpublished:reusable:per-block-editor:square' => [
'view',
FALSE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:published:reusable:admin' => [
'view',
TRUE,
TRUE,
['administer blocks'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:published:reusable:per-block-editor:basic' => [
'view',
TRUE,
TRUE,
['edit any basic block content'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:published:reusable:per-block-editor:square' => [
'view',
TRUE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'view:published:non_reusable' => [
'view',
TRUE,
FALSE,
[],
+ TRUE,
NULL,
- 'forbidden',
+ AccessResultForbidden::class,
],
'view:published:non_reusable:parent_allowed' => [
'view',
TRUE,
FALSE,
[],
- 'allowed',
- 'allowed',
+ TRUE,
+ AccessResultAllowed::class,
+ AccessResultAllowed::class,
],
'view:published:non_reusable:parent_neutral' => [
'view',
TRUE,
FALSE,
[],
- 'neutral',
- 'neutral',
+ TRUE,
+ AccessResultNeutral::class,
+ AccessResultNeutral::class,
],
'view:published:non_reusable:parent_forbidden' => [
'view',
TRUE,
FALSE,
[],
- 'forbidden',
- 'forbidden',
+ TRUE,
+ AccessResultForbidden::class,
+ AccessResultForbidden::class,
],
];
foreach (['update', 'delete'] as $operation) {
@@ -272,80 +307,90 @@ public function providerTestAccess() {
TRUE,
TRUE,
[],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
$operation . ':unpublished:reusable' => [
$operation,
FALSE,
TRUE,
[],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
$operation . ':unpublished:reusable:admin' => [
$operation,
FALSE,
TRUE,
['administer blocks'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
$operation . ':published:reusable:admin' => [
$operation,
TRUE,
TRUE,
['administer blocks'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
$operation . ':published:non_reusable' => [
$operation,
TRUE,
FALSE,
[],
+ TRUE,
NULL,
- 'forbidden',
+ AccessResultForbidden::class,
],
$operation . ':published:non_reusable:parent_allowed' => [
$operation,
TRUE,
FALSE,
[],
- 'allowed',
- 'neutral',
+ TRUE,
+ AccessResultAllowed::class,
+ AccessResultNeutral::class,
],
$operation . ':published:non_reusable:parent_neutral' => [
$operation,
TRUE,
FALSE,
[],
- 'neutral',
- 'neutral',
+ TRUE,
+ AccessResultNeutral::class,
+ AccessResultNeutral::class,
],
$operation . ':published:non_reusable:parent_forbidden' => [
$operation,
TRUE,
FALSE,
[],
- 'forbidden',
- 'forbidden',
+ TRUE,
+ AccessResultForbidden::class,
+ AccessResultForbidden::class,
],
$operation . ':unpublished:reusable:per-block-editor:basic' => [
$operation,
FALSE,
TRUE,
['edit any basic block content'],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
$operation . ':published:reusable:per-block-editor:basic' => [
$operation,
TRUE,
TRUE,
['edit any basic block content'],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
];
}
@@ -356,16 +401,18 @@ public function providerTestAccess() {
FALSE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
'update:published:reusable:per-block-editor:square' => [
'update',
TRUE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'allowed',
+ AccessResultAllowed::class,
],
];
@@ -375,18 +422,182 @@ public function providerTestAccess() {
FALSE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
'delete:published:reusable:per-block-editor:square' => [
'delete',
TRUE,
TRUE,
['edit any square block content'],
+ TRUE,
NULL,
- 'neutral',
+ AccessResultNeutral::class,
],
];
+
+ // View all revisions:
+ $cases['view all revisions:none'] = [
+ 'view all revisions',
+ TRUE,
+ TRUE,
+ [],
+ TRUE,
+ NULL,
+ AccessResultNeutral::class,
+ ];
+ $cases['view all revisions:administer blocks'] = [
+ 'view all revisions',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ TRUE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+ $cases['view all revisions:view bundle'] = [
+ 'view all revisions',
+ TRUE,
+ TRUE,
+ ['view any square block content history'],
+ TRUE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+
+ // Revert revisions:
+ $cases['revert:none:latest'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ [],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['revert:none:historical'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ [],
+ FALSE,
+ NULL,
+ AccessResultNeutral::class,
+ ];
+ $cases['revert:administer blocks:latest'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['revert:administer blocks:historical'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ FALSE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+ $cases['revert:revert bundle:latest'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['revert:revert bundle:historical'] = [
+ 'revert',
+ TRUE,
+ TRUE,
+ ['revert any square block content revisions'],
+ FALSE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+ $cases['revert:revert bundle:historical:non reusable'] = [
+ 'revert',
+ TRUE,
+ FALSE,
+ ['revert any square block content revisions'],
+ FALSE,
+ NULL,
+ AccessResultForbidden::class,
+ 'Block content must be reusable to use `revert` operation',
+ ];
+
+ // Delete revisions:
+ $cases['delete revision:none:latest'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ [],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['delete revision:none:historical'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ [],
+ FALSE,
+ NULL,
+ AccessResultNeutral::class,
+ ];
+ $cases['delete revision:administer blocks:latest'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['delete revision:administer blocks:historical'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ FALSE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+ $cases['delete revision:delete bundle:latest'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ ['administer blocks'],
+ TRUE,
+ NULL,
+ AccessResultForbidden::class,
+ ];
+ $cases['delete revision:delete bundle:historical'] = [
+ 'delete revision',
+ TRUE,
+ TRUE,
+ ['delete any square block content revisions'],
+ FALSE,
+ NULL,
+ AccessResultAllowed::class,
+ ];
+ $cases['delete revision:delete bundle:historical:non reusable'] = [
+ 'delete revision',
+ TRUE,
+ FALSE,
+ ['delete any square block content revisions'],
+ FALSE,
+ NULL,
+ AccessResultForbidden::class,
+ 'Block content must be reusable to use `delete revision` operation',
+ ];
+
return $cases;
}
--
GitLab