ment_type ) { foreach ( array( 'unapproved', 'approved' ) as $comment_status ) { $comment_action_name = "comment_{$comment_status}_{$comment_type}"; add_action( $comment_action_name, $callable, 10, 2 ); add_filter( 'jetpack_sync_before_enqueue_' . $comment_action_name, array( $this, 'expand_wp_insert_comment', ) ); } } // Listen for meta changes. $this->init_listeners_for_meta_type( 'comment', $callable ); $this->init_meta_whitelist_handler( 'comment', array( $this, 'filter_meta' ) ); } /** * Handler for any comment content updates. * * @access public * * @param array $new_comment The new, processed comment data. * @param array $old_comment The old, unslashed comment data. * @param array $new_comment_with_slashes The new, raw comment data. * @return array The new, processed comment data. */ public function handle_comment_contents_modification( $new_comment, $old_comment, $new_comment_with_slashes ) { $changes = array(); $content_fields = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content', ); foreach ( $content_fields as $field ) { if ( $new_comment_with_slashes[ $field ] !== $old_comment[ $field ] ) { $changes[ $field ] = array( $new_comment[ $field ], $old_comment[ $field ] ); } } if ( ! empty( $changes ) ) { /** * Signals to the sync listener that this comment's contents were modified and a sync action * reflecting the change(s) to the content should be sent * * @since 1.6.3 * @since-jetpack 4.9.0 * * @param int $new_comment['comment_ID'] ID of comment whose content was modified * @param mixed $changes Array of changed comment fields with before and after values */ do_action( 'jetpack_modified_comment_contents', $new_comment['comment_ID'], $changes ); } return $new_comment; } /** * Initialize comments action listeners for full sync. * * @access public * * @param callable $callable Action handler callable. */ public function init_full_sync_listeners( $callable ) { add_action( 'jetpack_full_sync_comments', $callable ); // Also send comments meta. } /** * Gets a filtered list of comment types that sync can hook into. * * @access public * * @return array Defaults to [ '', 'trackback', 'pingback' ]. */ public function get_whitelisted_comment_types() { /** * Comment types present in this list will sync their status changes to WordPress.com. * * @since 1.6.3 * @since-jetpack 7.6.0 * * @param array A list of comment types. */ return apply_filters( 'jetpack_sync_whitelisted_comment_types', array( '', 'comment', 'trackback', 'pingback', 'review' ) ); } /** * Returns escaped SQL for whitelisted comment types. * Can be injected directly into a WHERE clause. * * @access public * * @return string SQL WHERE clause. */ public function get_whitelisted_comment_types_sql() { return 'comment_type IN (\'' . implode( '\', \'', array_map( 'esc_sql', $this->get_whitelisted_comment_types() ) ) . '\')'; } /** * Prevents any comment types that are not in the whitelist from being enqueued and sent to WordPress.com. * * @param array $args Arguments passed to wp_insert_comment, deleted_comment, spammed_comment, etc. * * @return bool or array $args Arguments passed to wp_insert_comment, deleted_comment, spammed_comment, etc. */ public function only_allow_white_listed_comment_types( $args ) { $comment = false; if ( isset( $args[1] ) ) { // comment object is available. $comment = $args[1]; } elseif ( is_numeric( $args[0] ) ) { // comment_id is available. $comment = get_comment( $args[0] ); } if ( isset( $comment->comment_type ) && ! in_array( $comment->comment_type, $this->get_whitelisted_comment_types(), true ) ) { return false; } return $args; } /** * Filter all blacklisted post types. * * @param array $args Hook arguments. * @return array|false Hook arguments, or false if the post type is a blacklisted one. */ public function filter_blacklisted_post_types( $args ) { $post_id = $args[0]; $posts_module = Modules::get_module( 'posts' ); '@phan-var Posts $posts_module'; if ( false !== $posts_module && ! $posts_module->is_post_type_allowed( $post_id ) ) { return false; } return $args; } /** * Prevents any comment types that are not in the whitelist from being enqueued and sent to WordPress.com. * * @param array $args Arguments passed to wp_{old_status}_to_{new_status}. * * @return bool or array $args Arguments passed to wp_{old_status}_to_{new_status} */ public function only_allow_white_listed_comment_type_transitions( $args ) { $comment = $args[0]; if ( ! in_array( $comment->comment_type, $this->get_whitelisted_comment_types(), true ) ) { return false; } return $args; } /** * Prevents any comment types that are not in the whitelist from being enqueued and sent to WordPress.com. * Also expands comment data before being enqueued. * * @param array $args Arguments passed to wp_insert_comment. * * @return false or array $args Arguments passed to wp_insert_comment or false if the comment type is a blacklisted one. */ public function filter_jetpack_sync_before_enqueue_wp_insert_comment( $args ) { if ( false === $this->only_allow_white_listed_comment_types( $args ) ) { return false; } return $this->expand_wp_insert_comment( $args ); } /** * Whether a comment type is allowed. * A comment type is allowed if it's present in the comment type whitelist. * * @param int $comment_id ID of the comment. * @return boolean Whether the comment type is allowed. */ public function is_comment_type_allowed( $comment_id ) { $comment = get_comment( $comment_id ); if ( isset( $comment->comment_type ) ) { return in_array( $comment->comment_type, $this->get_whitelisted_comment_types(), true ); } return false; } /** * Initialize the module in the sender. * * @access public */ public function init_before_send() { // Full sync. $sync_module = Modules::get_module( 'full-sync' ); if ( $sync_module instanceof Full_Sync_Immediately ) { add_filter( 'jetpack_sync_before_send_jetpack_full_sync_comments', array( $this, 'extract_comments_and_meta' ) ); } else { add_filter( 'jetpack_sync_before_send_jetpack_full_sync_comments', array( $this, 'expand_comment_ids' ) ); } } /** * Enqueue the comments actions for full sync. * * @access public * * @param array $config Full sync configuration for this sync module. * @param int $max_items_to_enqueue Maximum number of items to enqueue. * @param boolean $state True if full sync has finished enqueueing this module, false otherwise. * @return array Number of actions enqueued, and next module state. */ public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) { global $wpdb; return $this->enqueue_all_ids_as_action( 'jetpack_full_sync_comments', $wpdb->comments, 'comment_ID', $this->get_where_sql( $config ), $max_items_to_enqueue, $state ); } /** * Retrieve an estimated number of actions that will be enqueued. * * @access public * * @param array $config Full sync configuration for this sync module. * @return int Number of items yet to be enqueued. */ public function estimate_full_sync_actions( $config ) { global $wpdb; $query = "SELECT count(*) FROM $wpdb->comments"; $where_sql = $this->get_where_sql( $config ); if ( $where_sql ) { $query .= ' WHERE ' . $where_sql; } // TODO: Call $wpdb->prepare on the following query. // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching $count = (int) $wpdb->get_var( $query ); return (int) ceil( $count / self::ARRAY_CHUNK_SIZE ); } /** * Retrieve the WHERE SQL clause based on the module config. * * @access public * * @param array $config Full sync configuration for this sync module. * @return string WHERE SQL clause, or `null` if no comments are specified in the module config. */ public function get_where_sql( $config ) { $where_sql = $this->get_whitelisted_comment_types_sql(); if ( is_array( $config ) && ! empty( $config ) ) { return 'comment_ID IN (' . implode( ',', array_map( 'intval', $config ) ) . ')'; } return $where_sql; } /** * Retrieve the actions that will be sent for this module during a full sync. * * @access public * * @return array Full sync actions of this module. */ public function get_full_sync_actions() { return array( 'jetpack_full_sync_comments' ); } /** * Count all the actions that are going to be sent. * * @access public * * @param array $action_names Names of all the actions that will be sent. * @return int Number of actions. */ public function count_full_sync_actions( $action_names ) { return $this->count_actions( $action_names, array( 'jetpack_full_sync_comments' ) ); } /** * Expand the comment status change before the data is serialized and sent to the server. * * @access public * @todo This is not used currently - let's implement it. * * @param array $args The hook parameters. * @return array The expanded hook parameters. */ public function expand_wp_comment_status_change( $args ) { return array( $args[0], $this->filter_comment( $args[1] ) ); } /** * Expand the comment creation before the data is added to the Sync queue. * * @access public * * @param array $args The hook parameters. * @return array The expanded hook parameters. */ public function expand_wp_insert_comment( $args ) { return array( $args[0], $this->filter_comment( $args[1] ) ); } /** * Filter a comment object to the fields we need. * * @access public * * @param \WP_Comment $comment The unfiltered comment object. * @return \WP_Comment Filtered comment object. */ public function filter_comment( $comment ) { /** * Filters whether to prevent sending comment data to .com * * Passing true to the filter will prevent the comment data from being sent * to the WordPress.com. * Instead we pass data that will still enable us to do a checksum against the * Jetpacks data but will prevent us from displaying the data on in the API as well as * other services. * * @since 1.6.3 * @since-jetpack 4.2.0 * * @param boolean false prevent post data from bing synced to WordPress.com * @param mixed $comment WP_COMMENT object */ if ( apply_filters( 'jetpack_sync_prevent_sending_comment_data', false, $comment ) ) { $blocked_comment = new \stdClass(); $blocked_comment->comment_ID = $comment->comment_ID; $blocked_comment->comment_date = $comment->comment_date; $blocked_comment->comment_date_gmt = $comment->comment_date_gmt; $blocked_comment->comment_approved = 'jetpack_sync_blocked'; return $blocked_comment; } return $comment; } /** * Whether a certain comment meta key is whitelisted for sync. * * @access public * * @param string $meta_key Comment meta key. * @return boolean Whether the meta key is whitelisted. */ public function is_whitelisted_comment_meta( $meta_key ) { return in_array( $meta_key, Settings::get_setting( 'comment_meta_whitelist' ), true ); } /** * Handler for filtering out non-whitelisted comment meta. * * @access public * * @param array $args Hook args. * @return array|boolean False if not whitelisted, the original hook args otherwise. */ public function filter_meta( $args ) { if ( $this->is_comment_type_allowed( $args[1] ) && $this->is_whitelisted_comment_meta( $args[2] ) ) { return $args; } return false; } /** * Expand the comment IDs to comment objects and meta before being serialized and sent to the server. * * @access public * * @param array $args The hook parameters. * @return array The expanded hook parameters. */ public function expand_comment_ids( $args ) { list( $comment_ids, $previous_interval_end ) = $args; $comments = get_comments( array( 'include_unapproved' => true, 'comment__in' => $comment_ids, 'orderby' => 'comment_ID', 'order' => 'DESC', ) ); return array( $comments, $this->get_metadata( $comment_ids, 'comment', Settings::get_setting( 'comment_meta_whitelist' ) ), $previous_interval_end, ); } /** * Expand the comment IDs to comment objects and meta before being serialized and sent to the server. * * @access public * * @param array $args The hook parameters. * @return array The expanded hook parameters. */ public function extract_comments_and_meta( $args ) { list( $filtered_comments, $previous_end ) = $args; return array( $filtered_comments['objects'], $filtered_comments['meta'], $previous_end, ); } /** * Given the Module Configuration and Status return the next chunk of items to send. * This function also expands the posts and metadata and filters them based on the maximum size constraints. * * @param array $config This module Full Sync configuration. * @param array $status This module Full Sync status. * @param int $chunk_size Chunk size. * * @return array */ public function get_next_chunk( $config, $status, $chunk_size ) { $comment_ids = parent::get_next_chunk( $config, $status, $chunk_size ); // If no comment IDs were fetched, return an empty array. if ( empty( $comment_ids ) ) { return array(); } $comments = get_comments( array( 'comment__in' => $comment_ids, 'orderby' => 'comment_ID', 'order' => 'DESC', ) ); // If no comments were fetched, make sure to return the expected structure so that status is updated correctly. if ( empty( $comments ) ) { return array( 'object_ids' => $comment_ids, 'objects' => array(), 'meta' => array(), ); } // Get the comment IDs from the comments that were fetched. $fetched_comment_ids = wp_list_pluck( $comments, 'comment_ID' ); $metadata = $this->get_metadata( $fetched_comment_ids, 'comment', Settings::get_setting( 'comment_meta_whitelist' ) ); // Filter the comments and metadata based on the maximum size constraints. list( $filtered_comment_ids, $filtered_comments, $filtered_comments_metadata ) = $this->filter_objects_and_metadata_by_size( 'comment', $comments, $metadata, self::MAX_META_LENGTH, // Replace with appropriate comment meta length constant. self::MAX_SIZE_FULL_SYNC ); return array( 'object_ids' => $filtered_comment_ids, 'objects' => $filtered_comments, 'meta' => $filtered_comments_metadata, ); } }