Changeset 7227

Timestamp:

11/29/2021 03:11:38 PM (2 weeks ago)

Author:

johnjamesjacoby

Message:

Akismet: improvements to clean-up routines, based on user feedback.

• Use correct ID column for the posts database table
• Use correct post_id column for the postmeta database table
• Reduce row limit to 1000 from 100000 to avoid lengthy table locks in active forums
• Remove usage of constant, that may be phased out eventually
• Update related code docs
• Introduce helper methods for applying dynamically named filters

In branches/2.6 for 2.6.9. Fixes #3395.

File:

• branches/2.6/src/includes/extend/akismet.php (modified) (8 diffs)

branches/2.6/src/includes/extend/akismet.php

@@ -967 +967 @@
 
     /**
-     * Deletes old spam topics & replies from the queue after 15 days
-     * (determined by `_bbp_akismet_delete_spam_interval` filter).
-     *
-     * @since 2.6.7 bbPress (r7203)
-     *
-     * @global wpdb $wpdb
-     */
-    public function delete_old_spam() {
-        global $wpdb;
+     * Get the number of rows to delete in a single clean-up query.
+     *
+     * @since 2.6.9 bbPress (r7225)
+     *
+     * @param string $filter The name of the filter to run.
+     * @return int
+     */
+    public function get_delete_limit( $filter = '' ) {
+
+        // Default filter
+        if ( empty( $filter ) ) {
+            $filter = '_bbp_akismet_delete_spam_limit';
+        }
 
         /**
-         * Determines how many posts will be deleted in each batch.
+         * Determines how many rows will be deleted in each batch.
          *
-         * @param int The default as defined by AKISMET_DELETE_LIMIT (also used
-         *            in Akismet WordPress plugin).
+         * @param int The number of rows. Default 1000.
          */
-        $delete_limit = (int) apply_filters( '_bbp_akismet_delete_spam_limit',
-            defined( 'AKISMET_DELETE_LIMIT' )
-                ? AKISMET_DELETE_LIMIT
-                : 10000
-        );
-
-        // Validate the deletion limit
-        $delete_limit = max( 1, intval( $delete_limit ) );
+        $delete_limit = (int) apply_filters( $filter, 1000 );
+
+        // Validate and return the deletion limit
+        return max( 1, $delete_limit );
+    }
+
+    /**
+     * Get the interval (in days) for spam to remain in the queue.
+     *
+     * @since 2.6.9 bbPress (r7225)
+     *
+     * @param string $filter The name of the filter to run.
+     * @return int
+     */
+    public function get_delete_interval( $filter = '' ) {
+
+        // Default filter
+        if ( empty( $filter ) ) {
+            $filter = '_bbp_akismet_delete_spam_interval';
+        }
 
         /**
@@ -996 +1011 @@
          * queue before being deleted.
          *
-         * @param int The default number of days.
+         * @param int The number of days. Default 15.
          */
-        $delete_interval = (int) apply_filters( '_bbp_akismet_delete_spam_interval', 15 );
-
-        // Validate the deletion interval
-        $delete_interval = max( 1, intval( $delete_interval ) );
+        $delete_interval = (int) apply_filters( $filter, 15 );
+
+        // Validate and return the deletion interval
+        return max( 1, $delete_interval );
+    }
+
+    /**
+     * Deletes old spam topics & replies from the queue after 15 days
+     * (determined by `_bbp_akismet_delete_spam_interval` filter)
+     * since they are not useful in the long term.
+     *
+     * @since 2.6.7 bbPress (r7203)
+     *
+     * @global wpdb $wpdb
+     */
+    public function delete_old_spam() {
+        global $wpdb;
+
+        // Get the deletion limit & interval
+        $delete_limit    = $this->get_delete_limit( '_bbp_akismet_delete_spam_limit' );
+        $delete_interval = $this->get_delete_interval( '_bbp_akismet_delete_spam_interval' );
 
         // Setup the query
@@ -1035 +1067 @@
             // Prepared as strings since id is an unsigned BIGINT, and using %
             // will constrain the value to the maximum signed BIGINT.
-            $format_string = implode( ", ", array_fill( 0, count( $spam_ids ), '%s' ) );
+            $format_string = implode( ', ', array_fill( 0, count( $spam_ids ), '%s' ) );
 
             // Run the delete queries
-            $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->posts} WHERE post_id IN ( " . $format_string . " )", $spam_ids ) );
-            $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->postmeta} WHERE post_id IN ( " . $format_string . " )", $spam_ids ) );
+            $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->posts} WHERE ID IN ( {$format_string} )", $spam_ids ) );
+            $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->postmeta} WHERE post_id IN ( {$format_string} )", $spam_ids ) );
 
             // Clean the post cache for these topics & replies
@@ -1069 +1101 @@
 
     /**
-     * Deletes `_bbp_akismet_as_submitted` meta keys after 15 days, since they
-     * are large and not useful in the long term.
+     * Deletes `_bbp_akismet_as_submitted` meta keys after 15 days
+     * (determined by `_bbp_akismet_delete_spam_meta_interval` filter)
+     * since they are large and not useful in the long term.
      *
      * @since 2.6.7 bbPress (r7203)
@@ -1079 +1112 @@
         global $wpdb;
 
-        /**
-         * Determines how many days a piece of spam will be left in the Spam
-         * queue before being deleted.
-         *
-         * @param int The default number of days.
-         */
-        $interval = (int) apply_filters( '_bbp_akismet_delete_spam_meta_interval', 15 );
-
-        // Validate the deletion interval
-        $interval = max( 1, intval( $interval ) );
+        // Get the deletion limit & interval
+        $delete_limit    = $this->get_delete_limit( '_bbp_akismet_delete_spam_meta_limit' );
+        $delete_interval = $this->get_delete_interval( '_bbp_akismet_delete_spam_meta_interval' );
 
         // Setup the query
-        $sql = "SELECT m.post_id FROM {$wpdb->postmeta} as m INNER JOIN {$wpdb->posts} as p ON m.post_id = p.id WHERE m.meta_key = '_bbp_akismet_as_submitted' AND DATE_SUB(NOW(), INTERVAL %d DAY) > p.post_date_gmt LIMIT 10000";
+        $sql = "SELECT m.post_id FROM {$wpdb->postmeta} as m INNER JOIN {$wpdb->posts} as p ON m.post_id = p.ID WHERE m.meta_key = '_bbp_akismet_as_submitted' AND DATE_SUB(NOW(), INTERVAL %d DAY) > p.post_date_gmt LIMIT %d";
 
         // Query loop of topic & reply IDs
-        while ( $spam_ids = $wpdb->get_col( $wpdb->prepare( $sql, $interval ) ) ) {
+        while ( $spam_ids = $wpdb->get_col( $wpdb->prepare( $sql, $delete_interval, $delete_limit ) ) ) {
 
             // Exit loop if no spam IDs
@@ -1135 +1161 @@
 
     /**
-     * Clears post meta that no longer has corresponding posts in the database.
+     * Clears post meta that no longer has corresponding posts in the database
+     * (determined by `_bbp_akismet_delete_spam_orphaned_limit` filter)
+     * since it is not useful in the long term.
      *
      * @since 2.6.7 bbPress (r7203)
@@ -1144 +1172 @@
         global $wpdb;
 
+        // Get the deletion limit
+        $delete_limit = $this->get_delete_limit( '_bbp_akismet_delete_spam_orphaned_limit' );
+
+        // Default last meta ID
         $last_meta_id = 0;
 
@@ -1155 +1187 @@
 
         // Setup the query
-        $sql = "SELECT m.meta_id, m.post_id, m.meta_key FROM {$wpdb->postmeta} as m LEFT JOIN {$wpdb->posts} as p ON m.post_id = p.id WHERE p.id IS NULL AND m.meta_id > %d ORDER BY m.meta_id LIMIT 1000";
+        $sql = "SELECT m.meta_id, m.post_id, m.meta_key FROM {$wpdb->postmeta} as m LEFT JOIN {$wpdb->posts} as p ON m.post_id = p.ID WHERE p.ID IS NULL AND m.meta_id > %d ORDER BY m.meta_id LIMIT %d";
 
         // Query loop of topic & reply IDs
-        while ( $spam_meta_results = $wpdb->get_results( $wpdb->prepare( $sql, $last_meta_id ) ) ) {
+        while ( $spam_meta_results = $wpdb->get_results( $wpdb->prepare( $sql, $last_meta_id, $delete_limit ) ) ) {
 
             // Exit loop if no spam IDs