Comments: Make admin comment dimming comment-type aware (Trac #35214, Stage 3)

src/wp-admin/includes/ajax-actions.php

@@ -926,6 +926,7 @@ function wp_ajax_delete_page( $action ) {
  * Handles dimming a comment via AJAX.
  *
  * @since 3.1.0
+ * @since 7.3.0 Moderators are checked with the `moderate_comment` meta capability.
  */
 function wp_ajax_dim_comment() {
 	$id      = isset( $_POST['id'] ) ? (int) $_POST['id'] : 0;
@@ -945,7 +946,8 @@ function wp_ajax_dim_comment() {
 		$response->send();
 	}
 
-	if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) && ! current_user_can( 'moderate_comments' ) ) {
+	// Resolves to the type's own moderation primitive, or `moderate_comments` for the default model.
+	if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) && ! current_user_can( 'moderate_comment', $comment->comment_ID ) ) {
 		wp_die( -1 );
 	}
 

tests/phpunit/tests/ajax/wpAjaxDimComment.php

@@ -25,14 +25,24 @@ class Tests_Ajax_wpAjaxDimComment extends WP_Ajax_UnitTestCase {
 	 */
 	protected $_comments = array();
 
+	/**
+	 * Post the comments are attached to.
+	 *
+	 * @var int
+	 */
+	protected int $_post_id;
+
 	/**
 	 * Sets up the test fixture.
 	 */
 	public function set_up() {
 		parent::set_up();
-		$post_id         = self::factory()->post->create();
-		$this->_comments = self::factory()->comment->create_post_comments( $post_id, 15 );
+		$this->_post_id  = self::factory()->post->create();
+		$this->_comments = self::factory()->comment->create_post_comments( $this->_post_id, 15 );
 		$this->_comments = array_map( 'get_comment', $this->_comments );
+
+		// A comment type with an independent capability model.
+		register_comment_type( 'review', array( 'capability_type' => 'review' ) );
 	}
 
 	/**
@@ -239,4 +249,182 @@ public function test_ajax_dim_comment_bad_nonce() {
 		$comment = array_pop( $this->_comments );
 		$this->_test_with_bad_nonce( $comment );
 	}
+
+	/**
+	 * Creates an unapproved comment of a given type on the shared post.
+	 *
+	 * @param string $comment_type Comment type slug.
+	 * @return int The new comment ID.
+	 */
+	private function make_comment( string $comment_type ): int {
+		return self::factory()->comment->create(
+			array(
+				'comment_post_ID'  => $this->_post_id,
+				'comment_type'     => $comment_type,
+				'comment_approved' => '0',
+			)
+		);
+	}
+
+	/**
+	 * Sets up the dim-comment request for the given comment.
+	 *
+	 * @param int $comment_id Comment to dim.
+	 */
+	private function set_up_dim_request( int $comment_id ): void {
+		$this->_clear_post_action();
+
+		$_POST['id']          = $comment_id;
+		$_POST['_ajax_nonce'] = wp_create_nonce( 'approve-comment_' . $comment_id );
+		$_POST['_total']      = 1;
+		$_POST['_per_page']   = 100;
+		$_POST['_page']       = 1;
+		$_POST['_url']        = admin_url( 'edit-comments.php' );
+	}
+
+	/**
+	 * A moderator of an independent comment type can dim its comments.
+	 *
+	 * @ticket 35214
+	 */
+	public function test_dim_review_comment_as_type_moderator_is_allowed(): void {
+		$comment_id = $this->make_comment( 'review' );
+
+		$moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$moderator->add_cap( 'moderate_reviews' );
+		wp_set_current_user( $moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		try {
+			$this->_handleAjax( 'dim-comment' );
+		} catch ( WPAjaxDieContinueException $e ) {
+			unset( $e );
+		}
+
+		// The request was authorized, so the unapproved comment was approved.
+		$this->assertSame( 'approved', wp_get_comment_status( $comment_id ) );
+	}
+
+	/**
+	 * A global moderator without the type's capabilities cannot dim its comments.
+	 *
+	 * @ticket 35214
+	 */
+	public function test_dim_review_comment_as_global_moderator_is_denied(): void {
+		$comment_id = $this->make_comment( 'review' );
+
+		$global_moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$global_moderator->add_cap( 'moderate_comments' );
+		wp_set_current_user( $global_moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		$this->expectException( 'WPAjaxDieStopException' );
+		$this->expectExceptionMessage( '-1' );
+		$this->_handleAjax( 'dim-comment' );
+	}
+
+	/**
+	 * A type moderator can also un-dim: dimming an approved comment unapproves it.
+	 *
+	 * @ticket 35214
+	 */
+	public function test_dim_approved_review_comment_as_type_moderator_unapproves_it(): void {
+		$comment_id = $this->make_comment( 'review' );
+		wp_set_comment_status( $comment_id, 'approve' );
+
+		$moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$moderator->add_cap( 'moderate_reviews' );
+		wp_set_current_user( $moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		try {
+			$this->_handleAjax( 'dim-comment' );
+		} catch ( WPAjaxDieContinueException $e ) {
+			unset( $e );
+		}
+
+		$this->assertSame( 'unapproved', wp_get_comment_status( $comment_id ) );
+	}
+
+	/**
+	 * The inverse denial: a type moderator cannot dim a default-model comment.
+	 *
+	 * @ticket 35214
+	 */
+	public function test_dim_default_comment_as_type_moderator_is_denied(): void {
+		$comment_id = $this->make_comment( 'comment' );
+
+		$moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$moderator->add_cap( 'moderate_reviews' );
+		wp_set_current_user( $moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		$this->expectException( 'WPAjaxDieStopException' );
+		$this->expectExceptionMessage( '-1' );
+		$this->_handleAjax( 'dim-comment' );
+	}
+
+	/**
+	 * A global moderator keeps full control over unregistered comment types.
+	 *
+	 * @ticket 35214
+	 */
+	public function test_dim_unregistered_type_comment_as_global_moderator_is_allowed(): void {
+		$comment_id = $this->make_comment( 'webmention' );
+
+		$global_moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$global_moderator->add_cap( 'moderate_comments' );
+		wp_set_current_user( $global_moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		try {
+			$this->_handleAjax( 'dim-comment' );
+		} catch ( WPAjaxDieContinueException $e ) {
+			unset( $e );
+		}
+
+		$this->assertSame( 'approved', wp_get_comment_status( $comment_id ) );
+	}
+
+	/**
+	 * Data provider.
+	 *
+	 * @return array<string, array{0: string}>
+	 */
+	public function data_editorial_comment_types(): array {
+		return array(
+			'note'     => array( 'note' ),
+			'reaction' => array( 'reaction' ),
+		);
+	}
+
+	/**
+	 * Notes and reactions use the default model, so a global moderator can still dim them.
+	 *
+	 * @ticket 35214
+	 *
+	 * @dataProvider data_editorial_comment_types
+	 */
+	public function test_dim_editorial_comment_as_global_moderator_is_allowed( string $comment_type ): void {
+		$comment_id = $this->make_comment( $comment_type );
+
+		$global_moderator = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+		$global_moderator->add_cap( 'moderate_comments' );
+		wp_set_current_user( $global_moderator->ID );
+
+		$this->set_up_dim_request( $comment_id );
+
+		try {
+			$this->_handleAjax( 'dim-comment' );
+		} catch ( WPAjaxDieContinueException $e ) {
+			unset( $e );
+		}
+
+		$this->assertSame( 'approved', wp_get_comment_status( $comment_id ) );
+	}
 }