File: /home/slyfwmm/foar/wp-content/plugins/defender-security/src/component/audit/class-comment-audit.php
<?php
/**
* Handles the auditing of comment-related actions within WordPress.
*
* @package WP_Defender\Component\Audit
*/
namespace WP_Defender\Component\Audit;
use WP_Defender\Traits\User;
use WP_Defender\Model\Audit_Log;
/**
* Handles various comment-related actions and provides methods for processing and generating audit log messages.
*/
class Comment_Audit extends Audit_Event {
use User;
public const ACTION_SPAMMED = 'spammed', ACTION_UNSPAMMED = 'unspammed', ACTION_DUPLICATED = 'duplicated',
ACTION_FLOOD = 'flood', ACTION_ADDED = 'added';
public const CONTEXT_COMMENT = 'ct_comment';
/**
* Defines and returns an array of WordPress hooks that this class will handle.
* Each hook is associated with an event type, action type, and a callback method.
* The method specifies how the event is processed when the hook is triggered.
*
* @return array An associative array where each key is a WordPress hook and each value is an array detailing the
* hook configuration.
*/
public function get_hooks(): array {
return array(
'wp_insert_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_ADDED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'comment_flood_trigger' => array(
'args' => array( 'time_lastcomment', 'time_newcomment' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_FLOOD,
'context' => self::CONTEXT_COMMENT,
'text' => sprintf(
/* translators: 1: Blog name, 2: Source of action. For e.g. Hub or a logged-in user */
esc_html__( '%1$s User %2$s flooded comment', 'defender-security' ),
'{{blog_name}}',
'{{wp_user}}'
),
),
'deleted_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_DELETED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'trash_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_TRASHED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'untrash_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_RESTORED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'spam_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_SPAMMED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'unspam_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_UNSPAMMED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'transition_comment_status' => array(
'args' => array( 'new_status', 'old_status', 'comment' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_UPDATED,
'callback' => array(
self::class,
'process_comment_status_changed',
),
),
'edit_comment' => array(
'args' => array( 'comment_ID' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_UPDATED,
'callback' => array( self::class, 'process_generic_comment' ),
),
'comment_duplicate_trigger' => array(
'args' => array( 'commentdata' ),
'event_type' => Audit_Log::EVENT_TYPE_COMMENT,
'action_type' => self::ACTION_DUPLICATED,
'callback' => array(
self::class,
'process_comment_duplicate_trigger',
),
),
);
}
/**
* Provides a dictionary for mapping constant values to their respective display strings.
* This method is useful for translating coded values into human-readable text, primarily for display purposes.
*
* @return array An associative array where keys are constant identifiers and values are the translated strings.
*/
public function dictionary(): array {
return array(
self::ACTION_DUPLICATED => esc_html__( 'Duplicated', 'defender-security' ),
self::ACTION_SPAMMED => esc_html__( 'Spammed', 'defender-security' ),
self::ACTION_UNSPAMMED => esc_html__( 'Unspammed', 'defender-security' ),
self::CONTEXT_COMMENT => esc_html__( 'Comment', 'defender-security' ),
);
}
/**
* Processes the event when a duplicate comment is detected.
* This method constructs a message detailing the duplicate comment event, including information about the comment,
* the post, and the user involved.
*
* @return array An array containing the formatted message string and the post type label.
*/
public function process_comment_duplicate_trigger(): array {
$args = func_get_args();
$comment_data = $args[1]['commentdata'];
$post = get_post( $comment_data['comment_post_ID'] );
$post_type = get_post_type_object( $post->post_type );
$post_type_label = strtolower( $post_type->labels->singular_name );
$blog_name = is_multisite() ? '[' . get_bloginfo( 'name' ) . ']' : '';
$text = sprintf(
/* translators: 1: Blog name, 2: Comment author, 3: Post type, 4: Post title */
esc_html__( '%1$s User %2$s submitted a duplicate comment on %3$s "%4$s"', 'defender-security' ),
$blog_name,
is_user_logged_in() ? $this->get_user_display( get_current_user_id() ) : $comment_data['comment_author'],
$post_type_label,
$post->post_title
);
return array( $text, $post_type_label );
}
/**
* Handles changes in comment status, such as from unapproved to approved.
* This method constructs a message that details the change in status of a comment, including information about the
* comment, the post, and the user involved.
*
* @return array An array containing the formatted message string and the post type label.
*/
public function process_comment_status_changed(): array {
$args = func_get_args();
$new_stat = $args[1]['new_status'];
$old_stat = $args[1]['old_status'];
$comment = $args[1]['comment'];
$post = get_post( $comment->comment_post_ID );
$post_type = get_post_type_object( $post->post_type );
$post_type_label = strtolower( $post_type->labels->singular_name );
$blog_name = is_multisite() ? '[' . get_bloginfo( 'name' ) . ']' : '';
$text = false;
if ( 'unapproved' === $old_stat && 'approved' === $new_stat ) {
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__( '%1$s %2$s approved comment ID %3$s from %4$s, on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment->comment_ID,
$comment->comment_author,
$post_type_label,
$post->post_title
);
} elseif ( 'unapproved' === $new_stat && 'approved' === $old_stat ) {
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__( '%1$s %2$s unapproved comment ID %3$s from %4$s, on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment->comment_ID,
$comment->comment_author,
$post_type_label,
$post->post_title
);
}
return array( $text, $post_type_label );
}
/**
* Generic handler for comment-related actions such as insertion, deletion, and editing.
* This method determines the specific action taken (e.g., comment posted, deleted, trashed) and constructs a
* corresponding message.
*
* @return bool|array False if the comment data is not set or an array containing the formatted message string and
* the post type label if successful.
*/
public function process_generic_comment() {
$args = func_get_args();
$hookname = $args[0];
$comment_id = $args[1]['comment_ID'];
if ( ! isset( $args[1]['commentdata'] ) ) {
$comment = get_comment( $comment_id );
if ( empty( $comment ) ) {
return false;
}
$comment = $comment->to_array();
} else {
$comment = $args[1]['commentdata'];
if ( empty( $comment ) ) {
return false;
}
}
if ( ! isset( $args[1]['comment_approved'] ) ) {
$comment_approved = '';
} else {
$comment_approved = $args[1]['comment_approved'];
}
$post = get_post( $comment['comment_post_ID'] );
$post_type = get_post_type_object( $post->post_type );
$post_type_label = strtolower( $post_type->labels->singular_name );
$blog_name = is_multisite() ? '[' . get_bloginfo( 'name' ) . ']' : '';
switch ( $hookname ) {
case 'comment_post':
case 'wp_insert_comment':
if ( 'spam' === $comment_approved ) {
$comment_status = 'spam';
} elseif ( 1 === $comment_approved ) {
$comment_status = esc_html__( 'approved', 'defender-security' );
} else {
$comment_status = esc_html__( 'pending approval', 'defender-security' );
}
if ( 0 === (int) $comment['comment_parent'] ) {
$text = sprintf(
/* translators: 1: Blog name, 2: Comment author, 3: Post type, 4: Post title, 5: Comment status */
esc_html__( '%1$s %2$s commented on %3$s "%4$s" - comment status: %5$s', 'defender-security' ),
$blog_name,
$comment['comment_author'],
$post_type_label,
$post->post_title,
$comment_status
);
} else {
$parent_comment = get_comment( $comment['comment_parent'] );
$text = sprintf(
/* translators: 1: Blog name, 2: Comment author, 3: Parent comment author, 4: Post type, 5: Post title, 6: Comment status */
esc_html__(
"%1\$s %2\$s replied to %3\$s's comment on %4\$s \"%5\$s\" - comment status: %6\$s",
'defender-security'
),
$blog_name,
$comment['comment_author'],
$parent_comment->comment_author,
$post_type_label,
$post->post_title,
$comment_status
);
}
break;
case 'deleted_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: Comment author, 3: Parent comment author, 4: Post type, 5: Post title, 6: Comment status */
esc_html__( '%1$s %2$s deleted comment ID %3$s, comment author: %4$s on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
case 'trash_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__( '%1$s %2$s trashed comment ID %3$s, comment author: %4$s on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
case 'untrash_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__( '%1$s %2$s untrashed comment ID %3$s, comment author: %4$s on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
case 'spam_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__(
'%1$s %2$s marked comment ID %3$s, comment author: %4$s on %5$s "%6$s" as spam',
'defender-security'
),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
case 'unspam_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__(
'%1$s %2$s unmarked comment ID %3$s, comment author: %4$s on %5$s "%6$s" as spam',
'defender-security'
),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
case 'edit_comment':
$text = sprintf(
/* translators: 1: Blog name, 2: User's display name, 3: Comment ID, 4: Comment author, 5: Post type, 6: Post title */
esc_html__( '%1$s %2$s edited comment ID %3$s, comment author: %4$s on %5$s "%6$s"', 'defender-security' ),
$blog_name,
$this->get_user_display( get_current_user_id() ),
$comment_id,
$comment['comment_author'],
$post_type_label,
$post->post_title
);
break;
default:
return false;
}
return array( $text, $post_type_label );
}
}