CommentAdminTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\comment\Functional;

use Drupal\comment\CommentInterface;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\user\RoleInterface;
use Drupal\comment\Entity\Comment;

/**
 * Tests comment approval functionality.
 *
 * @group comment
 */
class CommentAdminTest extends CommentTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests comment approval functionality through admin/content/comment.
     */
    public function testApprovalAdminInterface() : void {
        // Set anonymous comments to require approval.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => TRUE,
            'post comments' => TRUE,
            'skip comment approval' => FALSE,
        ]);
        $this->drupalLogin($this->adminUser);
        // Ensure that doesn't require contact info.
        $this->setCommentAnonymous(CommentInterface::ANONYMOUS_MAYNOT_CONTACT);
        // Test that the comments page loads correctly when there are no comments
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->pageTextContains('No comments available.');
        $this->drupalLogout();
        // Post anonymous comment without contact info.
        $subject = $this->randomMachineName();
        $body = $this->randomMachineName();
        // Set $contact to true so that it won't check for id and message.
        $this->postComment($this->node, $body, $subject, TRUE);
        $this->assertSession()
            ->pageTextContains('Your comment has been queued for review by site administrators and will be published after approval.');
        // Get unapproved comment id.
        $this->drupalLogin($this->adminUser);
        $anonymous_comment4 = $this->getUnapprovedComment($subject);
        $anonymous_comment4 = Comment::create([
            'cid' => $anonymous_comment4,
            'subject' => $subject,
            'comment_body' => $body,
            'entity_id' => $this->node
                ->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
        ]);
        $this->drupalLogout();
        $this->assertFalse($this->commentExists($anonymous_comment4), 'Anonymous comment was not published.');
        // Approve comment.
        $this->drupalLogin($this->adminUser);
        $this->performCommentOperation($anonymous_comment4, 'publish', TRUE);
        $this->drupalLogout();
        $this->drupalGet('node/' . $this->node
            ->id());
        $this->assertTrue($this->commentExists($anonymous_comment4), 'Anonymous comment visible.');
        // Post 2 anonymous comments without contact info.
        $comments[] = $this->postComment($this->node, $this->randomMachineName(), $this->randomMachineName(), TRUE);
        $comments[] = $this->postComment($this->node, $this->randomMachineName(), $this->randomMachineName(), TRUE);
        // Publish multiple comments in one operation.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/content/comment/approval');
        $this->assertSession()
            ->pageTextContains('Unapproved comments (2)');
        $edit = [
            "comments[{$comments[0]->id()}]" => 1,
            "comments[{$comments[1]->id()}]" => 1,
        ];
        $this->submitForm($edit, 'Update');
        $this->assertSession()
            ->pageTextContains('Unapproved comments (0)');
        // Delete multiple comments in one operation.
        $edit = [
            'operation' => 'delete',
            "comments[{$comments[0]->id()}]" => 1,
            "comments[{$comments[1]->id()}]" => 1,
            "comments[{$anonymous_comment4->id()}]" => 1,
        ];
        $this->submitForm($edit, 'Update');
        $this->assertSession()
            ->pageTextContains('Are you sure you want to delete these comments and all their children?');
        $this->submitForm([], 'Delete');
        $this->assertSession()
            ->pageTextContains('No comments available.');
        // Test message when no comments selected.
        $edit = [
            'operation' => 'delete',
        ];
        $this->submitForm($edit, 'Update');
        $this->assertSession()
            ->pageTextContains('Select one or more comments to perform the update on.');
        // Make sure the label of unpublished node is not visible on listing page.
        $this->drupalGet('admin/content/comment');
        $this->postComment($this->node, $this->randomMachineName());
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->pageTextContains(Html::escape($this->node
            ->label()));
        $this->node
            ->setUnpublished()
            ->save();
        $this->drupalGet('admin/content/comment');
        $this->assertSession()
            ->pageTextNotContains(Html::escape($this->node
            ->label()));
    }
    
    /**
     * Tests comment approval functionality through the node interface.
     */
    public function testApprovalNodeInterface() : void {
        // Set anonymous comments to require approval.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments' => TRUE,
            'post comments' => TRUE,
            'skip comment approval' => FALSE,
        ]);
        // Ensure that doesn't require contact info.
        $this->setCommentAnonymous(CommentInterface::ANONYMOUS_MAYNOT_CONTACT);
        // Post anonymous comment without contact info.
        $subject = $this->randomMachineName();
        $body = $this->randomMachineName();
        // Set $contact to true so that it won't check for id and message.
        $this->postComment($this->node, $body, $subject, TRUE);
        $this->assertSession()
            ->pageTextContains('Your comment has been queued for review by site administrators and will be published after approval.');
        // Get unapproved comment id.
        $this->drupalLogin($this->adminUser);
        $anonymous_comment4 = $this->getUnapprovedComment($subject);
        $anonymous_comment4 = Comment::create([
            'cid' => $anonymous_comment4,
            'subject' => $subject,
            'comment_body' => $body,
            'entity_id' => $this->node
                ->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
        ]);
        $this->drupalLogout();
        $this->assertFalse($this->commentExists($anonymous_comment4), 'Anonymous comment was not published.');
        // Ensure comments cannot be approved without a valid token.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('comment/1/approve');
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->drupalGet('comment/1/approve', [
            'query' => [
                'token' => 'forged',
            ],
        ]);
        $this->assertSession()
            ->statusCodeEquals(403);
        // Approve comment.
        $this->drupalGet('comment/1/edit');
        $this->assertSession()
            ->checkboxChecked('edit-status-0');
        $this->drupalGet('node/' . $this->node
            ->id());
        $this->clickLink('Approve');
        $this->drupalLogout();
        $this->drupalGet('node/' . $this->node
            ->id());
        $this->assertTrue($this->commentExists($anonymous_comment4), 'Anonymous comment visible.');
    }
    
    /**
     * Tests comment bundle admin.
     */
    public function testCommentAdmin() : void {
        // Login.
        $this->drupalLogin($this->adminUser);
        // Browse to comment bundle overview.
        $this->drupalGet('admin/structure/comment');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Make sure titles visible.
        $this->assertSession()
            ->pageTextContains('Comment type');
        $this->assertSession()
            ->pageTextContains('Description');
        // Make sure the description is present.
        $this->assertSession()
            ->pageTextContains('Default comment field');
        // Manage fields.
        $this->clickLink('Manage fields');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Make sure comment_body field is shown.
        $this->assertSession()
            ->pageTextContains('comment_body');
        // Rest from here on in is field_ui.
    }
    
    /**
     * Tests editing a comment as an admin.
     */
    public function testEditComment() : void {
        // Enable anonymous user comments.
        user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments',
            'post comments',
            'skip comment approval',
        ]);
        // Log in as a web user.
        $this->drupalLogin($this->webUser);
        // Post a comment.
        $comment = $this->postComment($this->node, $this->randomMachineName());
        $this->drupalLogout();
        // Post anonymous comment.
        // Ensure that we need email id before posting comment.
        $this->setCommentAnonymous(CommentInterface::ANONYMOUS_MUST_CONTACT);
        // Post comment with contact info (required).
        $author_name = $this->randomMachineName();
        $author_mail = $this->randomMachineName() . '@example.com';
        $anonymous_comment = $this->postComment($this->node, $this->randomMachineName(), $this->randomMachineName(), [
            'name' => $author_name,
            'mail' => $author_mail,
        ]);
        // Log in as an admin user.
        $this->drupalLogin($this->adminUser);
        // Make sure the comment field is not visible when
        // the comment was posted by an authenticated user.
        $this->drupalGet('comment/' . $comment->id() . '/edit');
        $this->assertSession()
            ->fieldNotExists('edit-mail');
        // Make sure the comment field is visible when
        // the comment was posted by an anonymous user.
        $this->drupalGet('comment/' . $anonymous_comment->id() . '/edit');
        $this->assertSession()
            ->fieldValueEquals('edit-mail', $anonymous_comment->getAuthorEmail());
    }
    
    /**
     * Tests commented translation deletion admin view.
     */
    public function testCommentedTranslationDeletion() : void {
        \Drupal::service('module_installer')->install([
            'language',
            'locale',
        ]);
        \Drupal::service('router.builder')->rebuildIfNeeded();
        ConfigurableLanguage::createFromLangcode('ur')->save();
        // Rebuild the container to update the default language container variable.
        $this->rebuildContainer();
        // Ensure that doesn't require contact info.
        $this->setCommentAnonymous(CommentInterface::ANONYMOUS_MAYNOT_CONTACT);
        $this->drupalLogin($this->webUser);
        $count_query = \Drupal::entityTypeManager()->getStorage('comment')
            ->getQuery()
            ->accessCheck(FALSE)
            ->count();
        $before_count = $count_query->execute();
        // Post 2 anonymous comments without contact info.
        $comment1 = $this->postComment($this->node, $this->randomMachineName(), $this->randomMachineName(), TRUE);
        $comment2 = $this->postComment($this->node, $this->randomMachineName(), $this->randomMachineName(), TRUE);
        $comment1->addTranslation('ur', [
            'subject' => 'ur ' . $comment1->label(),
        ])
            ->save();
        $comment2->addTranslation('ur', [
            'subject' => 'ur ' . $comment1->label(),
        ])
            ->save();
        $this->drupalLogout();
        $this->drupalLogin($this->adminUser);
        // Delete multiple comments in one operation.
        $edit = [
            'operation' => 'delete',
            "comments[{$comment1->id()}]" => 1,
            "comments[{$comment2->id()}]" => 1,
        ];
        $this->drupalGet('admin/content/comment');
        $this->submitForm($edit, 'Update');
        $this->assertSession()
            ->responseContains(new FormattableMarkup('@label (Original translation) - <em>The following comment translations will be deleted:</em>', [
            '@label' => $comment1->label(),
        ]));
        $this->assertSession()
            ->responseContains(new FormattableMarkup('@label (Original translation) - <em>The following comment translations will be deleted:</em>', [
            '@label' => $comment2->label(),
        ]));
        $this->assertSession()
            ->pageTextContains('English');
        $this->assertSession()
            ->pageTextContains('Urdu');
        $this->submitForm([], 'Delete');
        $after_count = $count_query->execute();
        $this->assertEquals($before_count, $after_count, 'No comment or translation found.');
    }

}