Changeset 47597

Timestamp:

04/17/2020 07:33:52 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Comments: Use comment instead of an empty string for the comment_type DB field value in comments table.

This is the first step to bring support for custom comment types into WordPress.

Add a scheduled upgrade routine to update the type value for existing comments, in batches of 100 at a time.

Props imath, aaroncampbell, jeremyfelt, dshanske.
Fixes #49236.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (1 diff)
• src/wp-admin/includes/schema.php (modified) (1 diff)
• src/wp-admin/includes/upgrade.php (modified) (3 diffs)
• src/wp-content/themes/twentyten/functions.php (modified) (1 diff)
• src/wp-includes/class-wp-comment-query.php (modified) (1 diff)
• src/wp-includes/class-wp-comment.php (modified) (1 diff)
• src/wp-includes/comment.php (modified) (8 diffs)
• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• src/wp-includes/version.php (modified) (1 diff)
• tests/phpunit/tests/comment-submission.php (modified) (1 diff)

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

@@ -1284 +1284 @@
         $comment_author_url   = wp_slash( $user->user_url );
         $comment_content      = trim( $_POST['content'] );
-        $comment_type         = isset( $_POST['comment_type'] ) ? trim( $_POST['comment_type'] ) : '';
+        $comment_type         = isset( $_POST['comment_type'] ) ? trim( $_POST['comment_type'] ) : 'comment';
 
         if ( current_user_can( 'unfiltered_html' ) ) {

trunk/src/wp-admin/includes/schema.php

@@ -112 +112 @@
     comment_approved varchar(20) NOT NULL default '1',
     comment_agent varchar(255) NOT NULL default '',
-    comment_type varchar(20) NOT NULL default '',
+    comment_type varchar(20) NOT NULL default 'comment',
     comment_parent bigint(20) unsigned NOT NULL default '0',
     user_id bigint(20) unsigned NOT NULL default '0',

trunk/src/wp-admin/includes/upgrade.php

@@ -284 +284 @@
                 'comment_date_gmt'     => $now_gmt,
                 'comment_content'      => $first_comment,
+                'comment_type'         => 'comment',
             )
         );
@@ -835 +836 @@
     }
 
+    if ( $wp_current_db_version < 47597 ) {
+        upgrade_550();
+    }
+
     maybe_disable_link_manager();
 
@@ -2156 +2161 @@
 
 /**
+ * Executes changes made in WordPress 5.5.0.
+ *
+ * @ignore
+ * @since 5.5.0
+ */
+function upgrade_550() {
+    update_option( 'finished_updating_comment_type', 0 );
+    wp_schedule_single_event( time() + ( 1 * MINUTE_IN_SECONDS ), 'wp_update_comment_type_batch' );
+}
+
+/**
  * Executes network-level upgrade routines.
  *

trunk/src/wp-content/themes/twentyten/functions.php

@@ -419 +419 @@
         switch ( $comment->comment_type ) :
             case '':
+            case 'comment':
                 ?>
         <li <?php comment_class(); ?> id="li-comment-<?php comment_ID(); ?>">

trunk/src/wp-includes/class-wp-comment-query.php

@@ -742 +742 @@
                     case 'comment':
                     case 'comments':
-                        $comment_types[ $operator ][] = "''";
+                        $comment_types[ $operator ][] = "'comment'";
                         break;
 

trunk/src/wp-includes/class-wp-comment.php

@@ -115 +115 @@
      *
      * @since 4.4.0
-     * @var string
-     */
-    public $comment_type = '';
+     * @since 5.5.0 Default value changed to `comment`.
+     * @var string
+     */
+    public $comment_type = 'comment';
 
     /**

trunk/src/wp-includes/comment.php

@@ -1854 +1854 @@
  *
  * @since 2.0.0
- * @since 4.4.0 Introduced `$comment_meta` argument.
+ * @since 4.4.0 Introduced the `$comment_meta` argument.
+ * @since 5.5.0 Default value for `$comment_type` argument changed to `comment`.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -1878 +1879 @@
  *     @type int        $comment_post_ID      ID of the post that relates to the comment, if any.
  *                                            Default 0.
- *     @type string     $comment_type         Comment type. Default empty.
+ *     @type string     $comment_type         Comment type. Default 'comment'.
  *     @type array      $comment_meta         Optional. Array of key/value pairs to be stored in commentmeta for the
  *                                            new comment.
@@ -1902 +1903 @@
     $comment_approved = ! isset( $data['comment_approved'] ) ? 1 : $data['comment_approved'];
     $comment_agent    = ! isset( $data['comment_agent'] ) ? '' : $data['comment_agent'];
-    $comment_type     = ! isset( $data['comment_type'] ) ? '' : $data['comment_type'];
+    $comment_type     = ! isset( $data['comment_type'] ) ? 'comment' : $data['comment_type'];
     $comment_parent   = ! isset( $data['comment_parent'] ) ? 0 : $data['comment_parent'];
 
@@ -2044 +2045 @@
  *
  * @since 1.5.0
- * @since 4.3.0 'comment_agent' and 'comment_author_IP' can be set via `$commentdata`.
+ * @since 4.3.0 Introduced the `comment_agent` and `comment_author_IP` arguments.
  * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function to
  *              return a WP_Error object instead of dying.
+ * @since 5.5.0 Introduced the `comment_type` argument.
  *
  * @see wp_insert_comment()
@@ -2061 +2063 @@
  *     @type string $comment_date_gmt     The date the comment was submitted in the GMT timezone.
  *                                        Default is `$comment_date` in the GMT timezone.
+ *     @type string $comment_type         Comment type. Default 'comment'.
  *     @type int    $comment_parent       The ID of this comment's parent, if any. Default 0.
  *     @type int    $comment_post_ID      The ID of the post that relates to the comment.
@@ -2121 +2124 @@
     if ( empty( $commentdata['comment_date_gmt'] ) ) {
         $commentdata['comment_date_gmt'] = current_time( 'mysql', 1 );
+    }
+
+    if ( empty( $commentdata['comment_type'] ) ) {
+        $commentdata['comment_type'] = 'comment';
     }
 
@@ -3349 +3356 @@
     }
 
-    $comment_type = '';
+    $comment_type = 'comment';
 
     if ( get_option( 'require_name_email' ) && ! $user->exists() ) {
@@ -3637 +3644 @@
     wp_cache_set( 'last_changed', microtime(), 'comment' );
 }
+
+/**
+ * Updates the comment type for a batch of comments.
+ *
+ * @since 5.5.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ */
+function _wp_batch_update_comment_type() {
+    global $wpdb;
+
+    $lock_name = 'update_comment_type.lock';
+
+    // Try to lock.
+    $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */", $lock_name, time() ) );
+
+    if ( ! $lock_result ) {
+        $lock_result = get_option( $lock_name );
+
+        // Bail if we were unable to create a lock, or if the existing lock is still valid.
+        if ( ! $lock_result || ( $lock_result > ( time() - HOUR_IN_SECONDS ) ) ) {
+            wp_schedule_single_event( time() + ( 5 * MINUTE_IN_SECONDS ), 'wp_update_comment_type_batch' );
+            return;
+        }
+    }
+
+    // Update the lock, as by this point we've definitely got a lock, just need to fire the actions.
+    update_option( $lock_name, time() );
+
+    // Check if there's still an empty comment type.
+    $empty_comment_type = $wpdb->get_var(
+        "SELECT comment_ID FROM $wpdb->comments
+        WHERE comment_type = ''
+        LIMIT 1"
+    );
+
+    // No empty comment type, we're done here.
+    if ( ! $empty_comment_type ) {
+        update_option( 'finished_updating_comment_type', true );
+        delete_option( $lock_name );
+        return;
+    }
+
+    // Empty comment type found? We'll need to run this script again.
+    wp_schedule_single_event( time() + ( 2 * MINUTE_IN_SECONDS ), 'wp_update_comment_type_batch' );
+
+    // Update the `comment_type` field value to be `comment` for the next 100 rows of comments.
+    $wpdb->query(
+        "UPDATE {$wpdb->comments}
+        SET comment_type = 'comment'
+        WHERE comment_type = ''
+        ORDER BY comment_ID DESC
+        LIMIT 100"
+    );
+
+    delete_option( $lock_name );
+}
+
+/**
+ * In order to avoid the _wp_batch_update_comment_type() job being accidentally removed,
+ * check that it's still scheduled while we haven't finished updating comment types.
+ *
+ * @ignore
+ * @since 5.5.0
+ */
+function _wp_check_for_scheduled_update_comment_type() {
+    if ( ! get_option( 'finished_updating_comment_type' ) && ! wp_next_scheduled( 'wp_update_comment_type_batch' ) ) {
+        wp_schedule_single_event( time() + MINUTE_IN_SECONDS, 'wp_update_comment_type_batch' );
+    }
+}

trunk/src/wp-includes/default-filters.php

@@ -439 +439 @@
 add_action( 'wp_split_shared_term_batch', '_wp_batch_split_terms' );
 
+// Comment type updates.
+add_action( 'admin_init', '_wp_check_for_scheduled_update_comment_type' );
+add_action( 'wp_update_comment_type_batch', '_wp_batch_update_comment_type' );
+
 // Email notifications.
 add_action( 'comment_post', 'wp_new_comment_notify_moderator' );

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -586 +586 @@
         }
 
-        $prepared_comment['comment_type'] = '';
+        $prepared_comment['comment_type'] = 'comment';
 
         /*

trunk/src/wp-includes/version.php

@@ -21 +21 @@
  * @global int $wp_db_version
  */
-$wp_db_version = 47018;
+$wp_db_version = 47597;
 
 /**

trunk/tests/phpunit/tests/comment-submission.php

@@ -743 +743 @@
                 'comment_author_url'   => $user->user_url,
                 'comment_content'      => $data['comment'],
-                'comment_type'         => '',
+                'comment_type'         => 'comment',
                 'comment_parent'       => '0',
                 'user_ID'              => $user->ID,