Changeset 1431102

Timestamp:

06/06/16 04:09:10 (4 months ago)

Author:

cfinke

Message:

When check_db_comment fails because of an invalid comment ID, return a WP_Error.

This way, we can tell the difference between a problem communicating with the Akismet API and just bad data being passed in. This lets us be smarter about when to interrupt a batch process if Akismet is unreachable.

Location:

akismet/trunk

Files:

• class.akismet-admin.php (modified) (1 diff)
• class.akismet-cli.php (modified) (1 diff)
• class.akismet.php (modified) (2 diffs)

akismet/trunk/class.akismet-admin.php

@@ -399 +399 @@
 
         foreach ( $moderation as $comment_id ) {
-            $is_spam = Akismet::recheck_comment( $comment_id, 'recheck_queue' );
-
-            if ( 'true' == $is_spam ) {
+            $api_response = Akismet::recheck_comment( $comment_id, 'recheck_queue' );
+
+            if ( 'true' === $api_response ) {
                 ++$result_counts['spam'];
             }
-            elseif ( 'false' == $is_spam ) {
+            elseif ( 'false' === $api_response ) {
                 ++$result_counts['ham'];
             }

akismet/trunk/class.akismet-cli.php

@@ -27 +27 @@
             if ( isset( $assoc_args['noaction'] ) ) {
                 // Check the comment, but don't reclassify it.
-                $is_spam = Akismet::check_db_comment( $comment_id, 'wp-cli' );
+                $api_response = Akismet::check_db_comment( $comment_id, 'wp-cli' );
             }
             else {
-                $is_spam = Akismet::recheck_comment( $comment_id, 'wp-cli' );
+                $api_response = Akismet::recheck_comment( $comment_id, 'wp-cli' );
             }
             
-            if ( 'true' === $is_spam ) {
+            if ( 'true' === $api_response ) {
                 WP_CLI::line( sprintf( __( "Comment #%d is spam.", 'akismet' ), $comment_id ) );
             }
-            else if ( 'false' === $is_spam ) {
+            else if ( 'false' === $api_response ) {
                 WP_CLI::line( sprintf( __( "Comment #%d is not spam.", 'akismet' ), $comment_id ) );
             }
             else {
-                WP_CLI::warning( sprintf( __( "Comment #%d could not be checked.", 'akismet' ), $comment_id ) );
+                if ( false === $api_response ) {
+                    WP_CLI::error( __( "Failed to connect to Akismet.", 'akismet' ) );
+                }
+                else if ( is_wp_error( $api_response ) ) {
+                    WP_CLI::warning( sprintf( __( "Comment #%d could not be checked.", 'akismet' ), $comment_id ) );
+                }
             }
         }

akismet/trunk/class.akismet.php

@@ -450 +450 @@
 
         $c = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->comments} WHERE comment_ID = %d", $id ), ARRAY_A );
-        if ( !$c )
-            return;
+        
+        if ( ! $c ) {
+            return new WP_Error( 'invalid-comment-id', __( 'Comment not found.', 'akismet' ) );
+        }
 
         $c['user_ip']        = $c['comment_author_IP'];
@@ -462 +464 @@
         $c['recheck_reason'] = $recheck_reason;
 
-        if ( self::is_test_mode() )
-            $c['is_test'] = 'true';
-
-        $response = self::http_post( Akismet::build_query( $c ), 'comment-check' );
-
-        return ( is_array( $response ) && ! empty( $response[1] ) ) ? $response[1] : false;
-    }
-    
-    public static function recheck_comment( $id, $recheck_reason = 'recheck_queue' ) {
-        $is_spam = self::check_db_comment( $id );
-
-        $c = get_comment( $id, ARRAY_A );
-        
-        if ( ! $c ) {
-            return false;
-        }
-
-        $c['user_ip']      = $c['comment_author_IP'];
-        $c['user_agent']   = $c['comment_agent'];
-        $c['referrer']     = '';
-        $c['blog']         = get_option( 'home' );
-        $c['blog_lang']    = get_locale();
-        $c['blog_charset'] = get_option('blog_charset');
-        $c['permalink']    = get_permalink($c['comment_post_ID']);
-
         $c['user_role'] = '';
         if ( isset( $c['user_ID'] ) )
             $c['user_role'] = Akismet::get_user_roles($c['user_ID']);
 
-        if ( Akismet::is_test_mode() )
+        if ( self::is_test_mode() )
             $c['is_test'] = 'true';
 
-        add_comment_meta( $c['comment_ID'], 'akismet_rechecking', true );
-
-        $response = Akismet::http_post( Akismet::build_query( $c ), 'comment-check' );
-
-        if ( 'true' == $response[1] ) {
-            wp_set_comment_status( $c['comment_ID'], 'spam' );
-            update_comment_meta( $c['comment_ID'], 'akismet_result', 'true' );
-            delete_comment_meta( $c['comment_ID'], 'akismet_error' );
-            delete_comment_meta( $c['comment_ID'], 'akismet_delayed_moderation_email' );
-            Akismet::update_comment_history( $c['comment_ID'], '', 'recheck-spam' );
-        } elseif ( 'false' == $response[1] ) {
-            update_comment_meta( $c['comment_ID'], 'akismet_result', 'false' );
-            delete_comment_meta( $c['comment_ID'], 'akismet_error' );
-            delete_comment_meta( $c['comment_ID'], 'akismet_delayed_moderation_email' );
-            Akismet::update_comment_history( $c['comment_ID'], '', 'recheck-ham' );
-        } else {
+        $response = self::http_post( Akismet::build_query( $c ), 'comment-check' );
+
+        if ( ! empty( $response[1] ) ) {
+            return $response[1];
+        }
+
+        return false;
+    }
+    
+    public static function recheck_comment( $id, $recheck_reason = 'recheck_queue' ) {
+        add_comment_meta( $id, 'akismet_rechecking', true );
+        
+        $api_response = self::check_db_comment( $id, $recheck_reason );
+
+        delete_comment_meta( $id, 'akismet_rechecking' );
+
+        if ( is_wp_error( $api_response ) ) {
+            // Invalid comment ID.
+        }
+        else if ( 'true' === $api_response ) {
+            wp_set_comment_status( $id, 'spam' );
+            update_comment_meta( $id, 'akismet_result', 'true' );
+            delete_comment_meta( $id, 'akismet_error' );
+            delete_comment_meta( $id, 'akismet_delayed_moderation_email' );
+            Akismet::update_comment_history( $id, '', 'recheck-spam' );
+        }
+        elseif ( 'false' === $api_response ) {
+            update_comment_meta( $id, 'akismet_result', 'false' );
+            delete_comment_meta( $id, 'akismet_error' );
+            delete_comment_meta( $id, 'akismet_delayed_moderation_email' );
+            Akismet::update_comment_history( $id, '', 'recheck-ham' );
+        }
+        else {
             // abnormal result: error
-            update_comment_meta( $c['comment_ID'], 'akismet_result', 'error' );
+            update_comment_meta( $id, 'akismet_result', 'error' );
             Akismet::update_comment_history(
-                $c['comment_ID'],
+                $id,
                 '',
                 'recheck-error',
-                array( 'response' => substr( $response[1], 0, 50 ) )
+                array( 'response' => substr( $api_response, 0, 50 ) )
             );
         }
 
-        delete_comment_meta( $c['comment_ID'], 'akismet_rechecking' );
-
-        return $response[1];
+        return $api_response;
     }