class.jetpack-sync-module-comments.php
| 1 | <?php |
| 2 | |
| 3 | class Jetpack_Sync_Module_Comments extends Jetpack_Sync_Module { |
| 4 | |
| 5 | public function name() { |
| 6 | return 'comments'; |
| 7 | } |
| 8 | |
| 9 | public function get_object_by_id( $object_type, $id ) { |
| 10 | $comment_id = intval( $id ); |
| 11 | if ( $object_type === 'comment' && $comment = get_comment( $comment_id ) ) { |
| 12 | return $this->filter_comment( $comment ); |
| 13 | } |
| 14 | |
| 15 | return false; |
| 16 | } |
| 17 | |
| 18 | public function init_listeners( $callable ) { |
| 19 | add_action( 'wp_insert_comment', $callable, 10, 2 ); |
| 20 | add_action( 'deleted_comment', $callable ); |
| 21 | add_action( 'trashed_comment', $callable ); |
| 22 | add_action( 'spammed_comment', $callable ); |
| 23 | add_action( 'trashed_post_comments', $callable, 10, 2 ); |
| 24 | add_action( 'untrash_post_comments', $callable ); |
| 25 | add_action( 'comment_approved_to_unapproved', $callable ); |
| 26 | add_action( 'comment_unapproved_to_approved', $callable ); |
| 27 | add_action( 'jetpack_modified_comment_contents', $callable, 10, 2 ); |
| 28 | add_action( 'untrashed_comment', $callable, 10, 2 ); |
| 29 | add_action( 'unspammed_comment', $callable, 10, 2 ); |
| 30 | add_filter( 'wp_update_comment_data', array( $this, 'handle_comment_contents_modification' ), 10, 3 ); |
| 31 | |
| 32 | // even though it's messy, we implement these hooks because |
| 33 | // the edit_comment hook doesn't include the data |
| 34 | // so this saves us a DB read for every comment event |
| 35 | foreach ( array( '', 'trackback', 'pingback' ) as $comment_type ) { |
| 36 | foreach ( array( 'unapproved', 'approved' ) as $comment_status ) { |
| 37 | $comment_action_name = "comment_{$comment_status}_{$comment_type}"; |
| 38 | add_action( $comment_action_name, $callable, 10, 2 ); |
| 39 | } |
| 40 | } |
| 41 | |
| 42 | // listen for meta changes |
| 43 | $this->init_listeners_for_meta_type( 'comment', $callable ); |
| 44 | $this->init_meta_whitelist_handler( 'comment', array( $this, 'filter_meta' ) ); |
| 45 | } |
| 46 | |
| 47 | public function handle_comment_contents_modification( $new_comment, $old_comment, $new_comment_with_slashes ) { |
| 48 | $content_fields = array( |
| 49 | 'comment_author', |
| 50 | 'comment_author_email', |
| 51 | 'comment_author_url', |
| 52 | 'comment_content', |
| 53 | ); |
| 54 | $changes = array(); |
| 55 | foreach ( $content_fields as $field ) { |
| 56 | if ( $new_comment_with_slashes[$field] != $old_comment[$field] ) { |
| 57 | $changes[$field] = array( $new_comment[$field], $old_comment[$field] ); |
| 58 | } |
| 59 | } |
| 60 | |
| 61 | if ( ! empty( $changes ) ) { |
| 62 | /** |
| 63 | * Signals to the sync listener that this comment's contents were modified and a sync action |
| 64 | * reflecting the change(s) to the content should be sent |
| 65 | * |
| 66 | * @since 4.9.0 |
| 67 | * |
| 68 | * @param int $new_comment['comment_ID'] ID of comment whose content was modified |
| 69 | * @param mixed $changes Array of changed comment fields with before and after values |
| 70 | */ |
| 71 | do_action( 'jetpack_modified_comment_contents', $new_comment['comment_ID'], $changes ); |
| 72 | } |
| 73 | return $new_comment; |
| 74 | } |
| 75 | |
| 76 | public function init_full_sync_listeners( $callable ) { |
| 77 | add_action( 'jetpack_full_sync_comments', $callable ); // also send comments meta |
| 78 | } |
| 79 | |
| 80 | public function init_before_send() { |
| 81 | add_filter( 'jetpack_sync_before_send_wp_insert_comment', array( $this, 'expand_wp_insert_comment' ) ); |
| 82 | |
| 83 | foreach ( array( '', 'trackback', 'pingback' ) as $comment_type ) { |
| 84 | foreach ( array( 'unapproved', 'approved' ) as $comment_status ) { |
| 85 | $comment_action_name = "comment_{$comment_status}_{$comment_type}"; |
| 86 | add_filter( 'jetpack_sync_before_send_' . $comment_action_name, array( |
| 87 | $this, |
| 88 | 'expand_wp_insert_comment', |
| 89 | ) ); |
| 90 | } |
| 91 | } |
| 92 | |
| 93 | // full sync |
| 94 | add_filter( 'jetpack_sync_before_send_jetpack_full_sync_comments', array( $this, 'expand_comment_ids' ) ); |
| 95 | } |
| 96 | |
| 97 | public function enqueue_full_sync_actions( $config, $max_items_to_enqueue, $state ) { |
| 98 | global $wpdb; |
| 99 | 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 ); |
| 100 | } |
| 101 | |
| 102 | public function estimate_full_sync_actions( $config ) { |
| 103 | global $wpdb; |
| 104 | |
| 105 | $query = "SELECT count(*) FROM $wpdb->comments"; |
| 106 | |
| 107 | if ( $where_sql = $this->get_where_sql( $config ) ) { |
| 108 | $query .= ' WHERE ' . $where_sql; |
| 109 | } |
| 110 | |
| 111 | $count = $wpdb->get_var( $query ); |
| 112 | |
| 113 | return (int) ceil( $count / self::ARRAY_CHUNK_SIZE ); |
| 114 | } |
| 115 | |
| 116 | private function get_where_sql( $config ) { |
| 117 | if ( is_array( $config ) ) { |
| 118 | return 'comment_ID IN (' . implode( ',', array_map( 'intval', $config ) ) . ')'; |
| 119 | } |
| 120 | |
| 121 | return null; |
| 122 | } |
| 123 | |
| 124 | public function get_full_sync_actions() { |
| 125 | return array( 'jetpack_full_sync_comments' ); |
| 126 | } |
| 127 | |
| 128 | public function count_full_sync_actions( $action_names ) { |
| 129 | return $this->count_actions( $action_names, array( 'jetpack_full_sync_comments' ) ); |
| 130 | } |
| 131 | |
| 132 | function expand_wp_comment_status_change( $args ) { |
| 133 | return array( $args[0], $this->filter_comment( $args[1] ) ); |
| 134 | } |
| 135 | |
| 136 | function expand_wp_insert_comment( $args ) { |
| 137 | return array( $args[0], $this->filter_comment( $args[1] ) ); |
| 138 | } |
| 139 | |
| 140 | function filter_comment( $comment ) { |
| 141 | /** |
| 142 | * Filters whether to prevent sending comment data to .com |
| 143 | * |
| 144 | * Passing true to the filter will prevent the comment data from being sent |
| 145 | * to the WordPress.com. |
| 146 | * Instead we pass data that will still enable us to do a checksum against the |
| 147 | * Jetpacks data but will prevent us from displaying the data on in the API as well as |
| 148 | * other services. |
| 149 | * @since 4.2.0 |
| 150 | * |
| 151 | * @param boolean false prevent post data from bing synced to WordPress.com |
| 152 | * @param mixed $comment WP_COMMENT object |
| 153 | */ |
| 154 | if ( apply_filters( 'jetpack_sync_prevent_sending_comment_data', false, $comment ) ) { |
| 155 | $blocked_comment = new stdClass(); |
| 156 | $blocked_comment->comment_ID = $comment->comment_ID; |
| 157 | $blocked_comment->comment_date = $comment->comment_date; |
| 158 | $blocked_comment->comment_date_gmt = $comment->comment_date_gmt; |
| 159 | $blocked_comment->comment_approved = 'jetpack_sync_blocked'; |
| 160 | |
| 161 | return $blocked_comment; |
| 162 | } |
| 163 | |
| 164 | return $comment; |
| 165 | } |
| 166 | |
| 167 | // Comment Meta |
| 168 | function is_whitelisted_comment_meta( $meta_key ) { |
| 169 | return in_array( $meta_key, Jetpack_Sync_Settings::get_setting( 'comment_meta_whitelist' ) ); |
| 170 | } |
| 171 | |
| 172 | function filter_meta( $args ) { |
| 173 | return ( $this->is_whitelisted_comment_meta( $args[2] ) ? $args : false ); |
| 174 | } |
| 175 | |
| 176 | public function expand_comment_ids( $args ) { |
| 177 | $comment_ids = $args[0]; |
| 178 | $comments = get_comments( array( |
| 179 | 'include_unapproved' => true, |
| 180 | 'comment__in' => $comment_ids, |
| 181 | ) ); |
| 182 | |
| 183 | return array( |
| 184 | $comments, |
| 185 | $this->get_metadata( $comment_ids, 'comment', Jetpack_Sync_Settings::get_setting( 'comment_meta_whitelist' ) ), |
| 186 | ); |
| 187 | } |
| 188 | } |
| 189 |