<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48397] trunk/src: Administration: Prevent repeat emails for identical plugin or theme auto-update attempt failures.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48397">48397</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48397","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>desrosj</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-07 18:58:32 +0000 (Tue, 07 Jul 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/50448">#50448</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasspluginupgraderphp">trunk/src/wp-admin/includes/class-plugin-upgrader.php</a></li>
<li><a href="#trunksrcwpadminincludesclassthemeupgraderphp">trunk/src/wp-admin/includes/class-theme-upgrader.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpautomaticupdaterphp">trunk/src/wp-admin/includes/class-wp-automatic-updater.php</a></li>
<li><a href="#trunksrcwpadminincludesschemaphp">trunk/src/wp-admin/includes/schema.php</a></li>
<li><a href="#trunksrcwpincludesversionphp">trunk/src/wp-includes/version.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasspluginupgraderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-plugin-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-plugin-upgrader.php 2020-07-07 18:53:50 UTC (rev 48396)
+++ trunk/src/wp-admin/includes/class-plugin-upgrader.php 2020-07-07 18:58:32 UTC (rev 48397)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,6 +247,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Force refresh of plugin update information.
</span><span class="cx" style="display: block; padding: 0 10px"> wp_clean_plugins_cache( $parsed_args['clear_update_cache'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -370,6 +379,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Cleanup our hooks, in case something else does a upgrade on this connection.
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_plugin' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $results;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludesclassthemeupgraderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-theme-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-theme-upgrader.php 2020-07-07 18:53:50 UTC (rev 48396)
+++ trunk/src/wp-admin/includes/class-theme-upgrader.php 2020-07-07 18:58:32 UTC (rev 48397)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -352,6 +352,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_clean_themes_cache( $parsed_args['clear_update_cache'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -479,6 +488,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'upgrader_post_install', array( $this, 'current_after' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'upgrader_clear_destination', array( $this, 'delete_old_theme' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $results;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpautomaticupdaterphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-automatic-updater.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-automatic-updater.php 2020-07-07 18:53:50 UTC (rev 48396)
+++ trunk/src/wp-admin/includes/class-wp-automatic-updater.php 2020-07-07 18:58:32 UTC (rev 48397)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -941,6 +941,32 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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;
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $body = array();
</span><span class="cx" style="display: block; padding: 0 10px"> $successful_plugins = ( ! empty( $successful_updates['plugin'] ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $successful_themes = ( ! empty( $successful_updates['theme'] ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1017,7 +1043,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = __( 'These plugins failed to update:' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $failed_updates['plugin'] as $item ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $body[] = "- {$item->name}";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $body[] = "- {$item->name}";
+ $past_failure_emails[ $item->item->plugin ] = $item->item->new_version;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1027,7 +1054,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = __( 'These themes failed to update:' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $failed_updates['theme'] as $item ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $body[] = "- {$item->name}";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $body[] = "- {$item->name}";
+ $past_failure_emails[ $item->item->theme ] = $item->item->new_version;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1043,6 +1071,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $successful_updates['plugin'] as $item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "- {$item->name}";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $past_failure_emails[ $item->item->plugin ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1053,6 +1082,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // List successful updates.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $successful_updates['theme'] as $item ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "- {$item->name}";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $past_failure_emails[ $item->item->theme ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $body[] = "\n";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1108,7 +1138,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $email = apply_filters( 'auto_plugin_theme_update_email', $email, $type, $successful_updates, $failed_updates );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_mail( $email['to'], wp_specialchars_decode( $email['subject'] ), $email['body'], $email['headers'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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 );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunksrcwpadminincludesschemaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/schema.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/schema.php 2020-07-07 18:53:50 UTC (rev 48396)
+++ trunk/src/wp-admin/includes/schema.php 2020-07-07 18:58:32 UTC (rev 48397)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -534,6 +534,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> 'blocklist_keys' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'comment_previously_approved' => 1,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'auto_plugin_theme_update_emails' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // 3.3.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,7 +553,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $options = wp_parse_args( $options, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Set autoload to no for these options.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $fat_options = array( 'moderation_keys', 'recently_edited', 'blocklist_keys', 'uninstall_plugins' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fat_options = array(
+ 'moderation_keys',
+ 'recently_edited',
+ 'blocklist_keys',
+ 'uninstall_plugins',
+ 'auto_plugin_theme_update_emails',
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $keys = "'" . implode( "', '", array_keys( $options ) ) . "'";
</span><span class="cx" style="display: block; padding: 0 10px"> $existing_options = $wpdb->get_col( "SELECT option_name FROM $wpdb->options WHERE option_name in ( $keys )" ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
</span></span></pre></div>
<a id="trunksrcwpincludesversionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/version.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/version.php 2020-07-07 18:53:50 UTC (rev 48396)
+++ trunk/src/wp-includes/version.php 2020-07-07 18:58:32 UTC (rev 48397)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,7 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global int $wp_db_version
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$wp_db_version = 48121;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$wp_db_version = 48397;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Holds the TinyMCE version.
</span></span></pre>
</div>
</div>
</body>
</html>