Changeset 48397

Timestamp:

07/07/2020 06:58:32 PM (4 years ago)

Author:

desrosj

Message:

Administration: Prevent repeat emails for identical plugin or theme auto-update attempt failures.

This change adds a throttle mechanism to plugin and theme auto-update failure emails using similar logic to the email sent for a Core auto-update.

The first time a plugin or theme auto-update fails, the package and new_version will be tracked in the auto_plugin_theme_update_emails option. An email for this specific update attempt will not be resent.

However, if this update fails again and non-repeat failures or successful updates are also present, then the failure information will be included in that email (an email needs to be sent for the new events regardless).

Props johnbillion, arpitgshah, desrosj, audrasjb, pbiron, earnjam.
Fixes #50448.

Location:

trunk/src

Files:

• wp-admin/includes/class-plugin-upgrader.php (modified) (2 diffs)
• wp-admin/includes/class-theme-upgrader.php (modified) (2 diffs)
• wp-admin/includes/class-wp-automatic-updater.php (modified) (6 diffs)
• wp-admin/includes/schema.php (modified) (2 diffs)
• wp-includes/version.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-plugin-upgrader.php

@@ -248 +248 @@
         wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
 
+        // Ensure any future auto-update failures trigger a failure email by removing the last
+        // failure notification from the list when plugins update successfully.
+        $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
+
+        if ( isset( $past_failure_emails[ $plugin ] ) ) {
+            unset( $past_failure_emails[ $plugin ] );
+            update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
+        }
+
         return true;
     }
@@ -371 +380 @@
         remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );
 
+        // Ensure any future auto-update failures trigger a failure email by removing the last
+        // failure notification from the list when plugins update successfully.
+        $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
+
+        foreach ( $results as $plugin => $result ) {
+            // Maintain last failure notification when plugins failed to update manually.
+            if ( ! $result || is_wp_error( $result ) || ! isset( $past_failure_emails[ $plugin ] ) ) {
+                continue;
+            }
+
+            unset( $past_failure_emails[ $plugin ] );
+        }
+        update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
+
         return $results;
     }

trunk/src/wp-admin/includes/class-theme-upgrader.php

@@ -353 +353 @@
         wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
 
+        // Ensure any future auto-update failures trigger a failure email by removing the last
+        // failure notification from the list when themes update successfully.
+        $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
+
+        if ( isset( $past_failure_emails[ $theme ] ) ) {
+            unset( $past_failure_emails[ $theme ] );
+            update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
+        }
+
         return true;
     }
@@ -480 +489 @@
         remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_theme' ) );
 
+        // Ensure any future auto-update failures trigger a failure email by removing the last
+        // failure notification from the list when themes update successfully.
+        $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
+
+        foreach ( $results as $theme => $result ) {
+            // Maintain last failure notification when themes failed to update manually.
+            if ( ! $result || is_wp_error( $result ) || ! isset( $past_failure_emails[ $theme ] ) ) {
+                continue;
+            }
+
+            unset( $past_failure_emails[ $theme ] );
+        }
+        update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
+
         return $results;
     }

trunk/src/wp-admin/includes/class-wp-automatic-updater.php

@@ -940 +940 @@
         if ( empty( $successful_updates ) && empty( $failed_updates ) ) {
             return;
+        }
+
+        $unique_failures     = false;
+        $past_failure_emails = get_option( 'auto_plugin_theme_update_emails', array() );
+
+        // When only failures have occurred, an email should only be sent if there are unique failures.
+        // A failure is considered unique if an email has not been sent for an update attempt failure
+        // to a plugin or theme with the same new_version.
+        if ( 'fail' === $type ) {
+            foreach ( $failed_updates as $update_type => $failures ) {
+                foreach ( $failures as $failed_update ) {
+                    if ( ! isset( $past_failure_emails[ $failed_update->item->{$update_type} ] ) ) {
+                        $unique_failures = true;
+                        continue;
+                    }
+
+                    // Check that the failure represents a new failure based on the new_version.
+                    if ( version_compare( $past_failure_emails[ $failed_update->item->{$update_type} ], $failed_update->item->new_version, '<' ) ) {
+                        $unique_failures = true;
+                    }
+                }
+            }
+
+            if ( ! $unique_failures ) {
+                return;
+            }
         }
 
@@ -1018 +1044 @@
 
                 foreach ( $failed_updates['plugin'] as $item ) {
-                    $body[] = "- {$item->name}";
+                    $body[]                                     = "- {$item->name}";
+                    $past_failure_emails[ $item->item->plugin ] = $item->item->new_version;
                 }
                 $body[] = "\n";
@@ -1028 +1055 @@
 
                 foreach ( $failed_updates['theme'] as $item ) {
-                    $body[] = "- {$item->name}";
+                    $body[]                                    = "- {$item->name}";
+                    $past_failure_emails[ $item->item->theme ] = $item->item->new_version;
                 }
                 $body[] = "\n";
@@ -1044 +1072 @@
                 foreach ( $successful_updates['plugin'] as $item ) {
                     $body[] = "- {$item->name}";
+                    unset( $past_failure_emails[ $item->item->plugin ] );
                 }
                 $body[] = "\n";
@@ -1054 +1083 @@
                 foreach ( $successful_updates['theme'] as $item ) {
                     $body[] = "- {$item->name}";
+                    unset( $past_failure_emails[ $item->item->theme ] );
                 }
                 $body[] = "\n";
@@ -1109 +1139 @@
         $email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );
 
-        wp_mail( $email['to'], wp_specialchars_decode( $email['subject'] ), $email['body'], $email['headers'] );
+        $result = wp_mail( $email['to'], wp_specialchars_decode( $email['subject'] ), $email['body'], $email['headers'] );
+
+        if ( $result ) {
+            update_option( 'auto_plugin_theme_update_emails', $past_failure_emails );
+        }
     }
 

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

@@ -535 +535 @@
         'blocklist_keys'                  => '',
         'comment_previously_approved'     => 1,
+        'auto_plugin_theme_update_emails' => array(),
     );
 
@@ -553 +554 @@
 
     // Set autoload to no for these options.
-    $fat_options = array( 'moderation_keys', 'recently_edited', 'blocklist_keys', 'uninstall_plugins' );
+    $fat_options = array(
+        'moderation_keys',
+        'recently_edited',
+        'blocklist_keys',
+        'uninstall_plugins',
+        'auto_plugin_theme_update_emails',
+    );
 
     $keys             = "'" . implode( "', '", array_keys( $options ) ) . "'";

trunk/src/wp-includes/version.php

@@ -21 +21 @@
  * @global int $wp_db_version
  */
-$wp_db_version = 48121;
+$wp_db_version = 48397;
 
 /**