<!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>[36349] trunk/src/wp-admin: Core Upgrader: Add a locking mechanism to avoid two concurrent updates of WordPress occuring.</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 { 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/36349">36349</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/36349","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-19 05:06:46 +0000 (Tue, 19 Jan 2016)</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'>Core Upgrader: Add a locking mechanism to avoid two concurrent updates of WordPress occuring.
Fixes <a href="https://core.trac.wordpress.org/ticket/34878">#34878</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpupgraderphp">trunk/src/wp-admin/includes/class-wp-upgrader.php</a></li>
<li><a href="#trunksrcwpadminupdatecorephp">trunk/src/wp-admin/update-core.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpupgraderphp"></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-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader.php 2016-01-19 04:09:32 UTC (rev 36348)
+++ trunk/src/wp-admin/includes/class-wp-upgrader.php 2016-01-19 05:06:46 UTC (rev 36349)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -751,6 +751,64 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Create a Lock using WordPress options.
+ *
+ * @since 4.5.0
+ * @access public
+ *
+ * @param string $lock_name The name of this unique lock.
+ * @param int $release_timeout The duration in seconds to respect an existing lock. Default: 1 hour.
+ * @return bool
+ */
+ public function create_lock( $lock_name, $release_timeout = null ) {
+ global $wpdb;
+ if ( ! $release_timeout ) {
+ $release_timeout = HOUR_IN_SECONDS;
+ }
+ $lock_option = $lock_name . '.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_option, time() ) );
+
+ if ( ! $lock_result ) {
+ $lock_result = get_option( $lock_option );
+
+ // If we couldn't create a lock, and there isn't a lock, bail
+ if ( ! $lock_result ) {
+ return false;
+ }
+
+ // Check to see if the lock is still valid
+ if ( $lock_result > ( time() - $release_timeout ) ) {
+ return false;
+ }
+
+ // There must exist an expired lock, clear it and re-gain it.
+ $this->release_lock( $lock_name );
+
+ return $this->create_lock( $lock_name, $release_timeout );
+ }
+
+ // Update the lock, as by this point we've definitely got a lock, just need to fire the actions
+ update_option( $lock_option, time() );
+
+ return true;
+ }
+
+ /**
+ * Release a lock created by `WP_Upgrader::create_lock()`.
+ *
+ * @since 4.5.0
+ * @access public
+ *
+ * @param string $lock_name The name of this unique lock.
+ * @return bool
+ */
+ public function release_lock( $lock_name ) {
+ return delete_option( $lock_name . '.lock' );
+ }
+
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2168,6 +2226,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function upgrade_strings() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['up_to_date'] = __('WordPress is at the latest version.');
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->strings['locked'] = __('Another update is currently in progress.');
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->strings['no_package'] = __('Update package not available.');
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['downloading_package'] = __('Downloading update from <span class="code">%s</span>…');
</span><span class="cx" style="display: block; padding: 0 10px"> $this->strings['unpack_package'] = __('Unpacking the update…');
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2252,25 +2311,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> $to_download = 'full';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Lock to prevent multiple Core Updates occuring
+ $lock = $this->create_lock( 'core_updater', 15 * MINUTE_IN_SECONDS );
+ if ( ! $lock ) {
+ return new WP_Error( 'locked', $this->strings['locked'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $download = $this->download_package( $current->packages->$to_download );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_wp_error($download) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $download ) ) {
+ $this->release_lock( 'core_updater' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return $download;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $working_dir = $this->unpack_package( $download );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_wp_error($working_dir) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $working_dir ) ) {
+ $this->release_lock( 'core_updater' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return $working_dir;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Copy update-core.php from the new version into place.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !$wp_filesystem->copy($working_dir . '/wordpress/wp-admin/includes/update-core.php', $wp_dir . 'wp-admin/includes/update-core.php', true) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_filesystem->delete($working_dir, true);
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->release_lock( 'core_updater' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'copy_failed_for_update_core_file', __( 'The update cannot be installed because we will be unable to copy some files. This is usually due to inconsistent file permissions.' ), 'wp-admin/includes/update-core.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_filesystem->chmod($wp_dir . 'wp-admin/includes/update-core.php', FS_CHMOD_FILE);
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( ABSPATH . 'wp-admin/includes/update-core.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! function_exists( 'update_core' ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! function_exists( 'update_core' ) ) {
+ $this->release_lock( 'core_updater' );
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'copy_failed_space', $this->strings['copy_failed_space'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $result = update_core( $working_dir, $wp_dir );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2345,6 +2417,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_version_check( $stats );
</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">+ $this->release_lock( 'core_updater' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $result;
</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">@@ -2938,8 +3012,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $upgrade_result = new WP_Error( 'fs_unavailable', __( 'Could not access filesystem.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Core doesn't output this, so let's append it so we don't get confused.
</del><span class="cx" style="display: block; padding: 0 10px"> if ( 'core' == $type ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_wp_error( $upgrade_result ) && ( 'up_to_date' == $upgrade_result->get_error_code() || 'locked' == $upgrade_result->get_error_code() ) ) {
+ // These aren't actual errors, treat it as a skipped-update instead to avoid triggering the post-core update failure routines.
+ return false;
+ }
+
+ // Core doesn't output this, so let's append it so we don't get confused.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $upgrade_result ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $skin->error( __( 'Installation Failed' ), $upgrade_result );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2975,26 +3054,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_main_network() || ! is_main_site() )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $lock_name = 'auto_updater.lock';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->create_lock( 'auto_updater' ) )
+ return;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 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 );
-
- // If we couldn't create a lock, and there isn't a lock, bail
- if ( ! $lock_result )
- return;
-
- // Check to see if the lock is still valid
- if ( $lock_result > ( time() - HOUR_IN_SECONDS ) )
- 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() );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Don't automatically run these thins, as we'll handle it ourselves
</span><span class="cx" style="display: block; padding: 0 10px"> remove_action( 'upgrader_process_complete', array( 'Language_Pack_Upgrader', 'async_upgrade' ), 20 );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_action( 'upgrader_process_complete', 'wp_version_check' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3092,8 +3154,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'automatic_updates_complete', $this->update_results );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the lock
- delete_option( $lock_name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->release_lock( 'auto_updater' );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3163,7 +3224,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the issue could actually be on WordPress.org's side.) If that one fails, then email.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $send = true;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $transient_failures = array( 'incompatible_archive', 'download_failed', 'insane_distro' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $transient_failures = array( 'incompatible_archive', 'download_failed', 'insane_distro', 'locked' );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $error_code, $transient_failures ) && ! get_site_option( 'auto_core_update_failed' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_schedule_single_event( time() + HOUR_IN_SECONDS, 'wp_maybe_auto_update' );
</span><span class="cx" style="display: block; padding: 0 10px"> $send = false;
</span></span></pre></div>
<a id="trunksrcwpadminupdatecorephp"></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/update-core.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/update-core.php 2016-01-19 04:09:32 UTC (rev 36348)
+++ trunk/src/wp-admin/update-core.php 2016-01-19 05:06:46 UTC (rev 36349)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +484,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error($result) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> show_message($result);
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ('up_to_date' != $result->get_error_code() )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'up_to_date' != $result->get_error_code() && 'locked' != $result->get_error_code() )
</ins><span class="cx" style="display: block; padding: 0 10px"> show_message( __('Installation Failed') );
</span><span class="cx" style="display: block; padding: 0 10px"> echo '</div>';
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span></span></pre>
</div>
</div>
</body>
</html>