Release 2.8.6 2 (#1062)

* Rework task runners
* dbcache comment updates
* dbcache/garbage-collection@blog-2 by priming the blog site

Author: cssjoe

Cache_File.php

@@ -96,27 +96,33 @@ function add( $key, &$var, $expire = 0, $group = '' ) {
 	/**
 	 * Sets data
 	 *
-	 * @param string  $key
-	 * @param mixed   $var
-	 * @param integer $expire
-	 * @param string  $group  Used to differentiate between groups of cache values
-	 * @return boolean
+	 * @param string $key        An MD5 of the DB query.
+	 * @param mixed  $content    Data to be cached.
+	 * @param int    $expiration Time to expire.  If 0, then the data will never expire.
+	 * @param string $group      Used to differentiate between groups of cache values.
+	 * @return bool
 	 */
-	function set( $key, $var, $expire = 0, $group = '' ) {
+	function set( $key, $content, $expiration = 0, $group = '' ) {
+		/**
+		 * Get the file pointer of the cache file.
+		 * The $key is transformed to a storage key (format "w3tc_INSTANCEID_HOST_BLOGID_dbcache_HASH").
+		 * The file path is in the format: CACHEDIR/db/BLOGID/GROUP/[0-9a-f]{3}/[0-9a-f]{3}/[0-9a-f]{32}.
+		 */
 		$fp = $this->fopen_write( $key, $group, 'wb' );
+
 		if ( !$fp )
 			return false;
 
 		if ( $this->_locking )
 			@flock( $fp, LOCK_EX );
 
-		if ( $expire <= 0 || $expire > W3TC_CACHE_FILE_EXPIRE_MAX )
-			$expire = W3TC_CACHE_FILE_EXPIRE_MAX;
+		if ( $expiration <= 0 || $expiration > W3TC_CACHE_FILE_EXPIRE_MAX )
+			$expiration = W3TC_CACHE_FILE_EXPIRE_MAX;
 
-		$expires_at = time() + $expire;
+		$expires_at = time() + $expiration;
 		@fputs( $fp, pack( 'L', $expires_at ) );
 		@fputs( $fp, '<?php exit; ?>' );
-		@fputs( $fp, @serialize( $var ) );
+		@fputs( $fp, @serialize( $content ) );
 		@fclose( $fp );
 
 		if ( $this->_locking )
@@ -332,16 +338,17 @@ function mtime( $key, $group = '' ) {
 	}
 
 	/**
-	 * Returns file path for key
+	 * Returns subpath for the cache file (format: [0-9a-f]{3}/[0-9a-f]{3}/[0-9a-f]{32}).
 	 *
-	 * @param string  $key
+	 * @param string $key Storage key (format: "w3tc_INSTANCEID_HOST_BLOGID_dbcache_HASH").
+	 * @param string $group Used to differentiate between groups of cache values.
 	 * @return string
 	 */
 	function _get_path( $key, $group = '' ) {
 		if ( $this->_use_wp_hash && function_exists( 'wp_hash' ) )
-			$hash = wp_hash( $key );
+			$hash = wp_hash( $key ); // Most common.
 		else
-			$hash = md5( $key );
+			$hash = md5( $key ); // Less common, but still used in some cases.
 
 		return ( $group ? $group . DIRECTORY_SEPARATOR : '' ) . sprintf( '%s/%s/%s.php', substr( $hash, 0, 3 ), substr( $hash, 3, 3 ), $hash );
 	}
@@ -463,21 +470,34 @@ public function counter_get( $key ) {
 		return $count;
 	}
 
+	/**
+	 * Open the cache file for writing and return the file pointer.
+	 *
+	 * @param string $key An MD5 of the DB query.
+	 * @param string $group Cache group.
+	 * @param string $mode File mode.  For example: 'wb' for write binary.
+	 * @return resource|false File pointer on success, false on failure.
+	 */
 	private function fopen_write( $key, $group, $mode ) {
+		// Get the storage key (format: "w3tc_INSTANCEID_HOST_BLOGID_dbcache_$key").
 		$storage_key = $this->get_item_key( $key );
 
+		// Get the subpath for the cache file (format: [0-9a-f]{3}/[0-9a-f]{3}/[0-9a-f]{32}).
 		$sub_path = $this->_get_path( $storage_key, $group );
+
+		// Ge the entire path of the cache file.
 		$path = $this->_cache_dir . DIRECTORY_SEPARATOR . $sub_path;
 
+		// Create the directory if it does not exist.
 		$dir = dirname( $path );
 
 		if ( !@is_dir( $dir ) ) {
 			if ( !Util_File::mkdir_from( $dir, dirname( W3TC_CACHE_DIR ) ) )
 				return false;
 		}
 
-		$fp = @fopen( $path, $mode );
-		return $fp;
+		// Open the cache file for writing.
+		return @fopen( $path, $mode );
 	}
 
 	/**

Generic_Plugin.php

@@ -831,12 +831,17 @@ public function post_update_tasks(): void {
 		$last_run_version = $state->get_string( 'tasks.generic.last_run_version' );
 
 		if ( empty( $last_run_version ) || \version_compare( W3TC_VERSION, $last_run_version, '>' ) ) {
-			$ran_versions = get_option( 'w3tc_post_update_tasks_ran_versions', array() );
+			$ran_versions  = get_option( 'w3tc_post_update_generic_tasks_ran_versions', array() );
+			$has_completed = false;
 
 			// Check if W3TC was updated to 2.8.6 or higher.
 			if ( \version_compare( W3TC_VERSION, '2.8.6', '>=' ) && ! in_array( '2.8.6', $ran_versions, true ) ) {
-				// Disable Object Cache if using Disk, purge the cache files, and show a notice in wp-admin.
-				if ( $this->_config->get_boolean( 'objectcache.enabled' ) && 'file' === $this->_config->get_string( 'objectcache.engine' ) ) {
+				// Disable Object Cache if using Disk, purge the cache files, and show a notice in wp-admin.  Only for main/blog ID 1.
+				if (
+					1 === get_current_blog_id() &&
+					$this->_config->get_boolean( 'objectcache.enabled' ) &&
+					'file' === $this->_config->get_string( 'objectcache.engine' )
+				) {
 					$this->_config->set( 'objectcache.enabled', false );
 					$this->_config->save();
 
@@ -849,12 +854,17 @@ public function post_update_tasks(): void {
 
 				// Mark the task as ran.
 				$ran_versions[] = '2.8.6';
-				update_option( 'w3tc_post_update_tasks_ran_versions', $ran_versions, false );
+				$has_completed  = true;
 
 				// Delete cached notices.
 				delete_option( 'w3tc_cached_notices' );
 			}
 
+			// Mark completed tasks as ran.
+			if ( $has_completed ) {
+				update_option( 'w3tc_post_update_generic_tasks_ran_versions', $ran_versions, false );
+			}
+
 			// Mark the task runner as ran for the current version.
 			$state->set( 'tasks.generic.last_run_version', W3TC_VERSION );
 			$state->save();

Generic_Plugin_Admin.php

@@ -1326,25 +1326,48 @@ public function admin_notices() {
 	public function post_update_tasks(): void {
 		// Check if W3TC was updated.
 		$state            = Dispatcher::config_state();
-		$last_run_version = $state->get_string( 'tasks.last_run_version' );
-
-		if ( empty( $last_run_version ) || version_compare( W3TC_VERSION, $last_run_version, '>' ) ) {
-			switch ( W3TC_VERSION ) {
-				case '2.8.1':
-					// Fix environment.
-					Util_Admin::fix_on_event( $this->_config, 'w3tc_plugin_updated' );
-
-					// Adjust "objectcache.file.gc".
-					if ( $this->_config->get_integer( 'objectcache.file.gc' ) === 3600 ) {
-						$this->_config->set( 'objectcache.file.gc', 600 );
-						$this->_config->save();
-					}
-					break;
-				default:
-					break;
+		$last_run_version = $state->get_string( 'tasks.admin.last_run_version' );
+
+		if ( empty( $last_run_version ) || \version_compare( W3TC_VERSION, $last_run_version, '>' ) ) {
+			$ran_versions  = get_option( 'w3tc_post_update_admin_tasks_ran_versions', array() );
+			$has_completed = false;
+
+			// Check if W3TC was updated to 2.8.1 or higher and not already run.
+			if ( \version_compare( W3TC_VERSION, '2.8.1', '>=' ) && ! in_array( '2.8.1', $ran_versions, true ) ) {
+				// Fix environment.
+				Util_Admin::fix_on_event( $this->_config, 'w3tc_plugin_updated' );
+
+				// Adjust "objectcache.file.gc".
+				if ( $this->_config->get_integer( 'objectcache.file.gc' ) === 3600 ) {
+					$this->_config->set( 'objectcache.file.gc', 600 );
+					$this->_config->save();
+				}
+
+				// Mark the task as ran.
+				$ran_versions[] = '2.8.1';
+				$has_completed  = true;
+			}
+
+			// Check if W3TC was updated to 2.8.6 or higher and not already run.
+			if ( \version_compare( W3TC_VERSION, '2.8.6', '>=' ) && ! in_array( '2.8.6', $ran_versions, true ) ) {
+				// Delete old option.
+				delete_option( 'w3tc_post_update_tasks_ran_versions' );
+
+				// Null old state key.
+				$state->set( 'tasks.last_run_version', null );
+
+				// Mark the task as ran.
+				$ran_versions[] = '2.8.6';
+				$has_completed  = true;
+			}
+
+			// Mark completed tasks as ran.
+			if ( $has_completed ) {
+				update_option( 'w3tc_post_update_admin_tasks_ran_versions', $ran_versions, false );
 			}
 
-			$state->set( 'tasks.last_run_version', W3TC_VERSION );
+			// Mark the task runner as ran for the current version.
+			$state->set( 'tasks.admin.last_run_version', W3TC_VERSION );
 			$state->save();
 		}
 	}

qa/lib/sys.js

@@ -21,6 +21,7 @@ const util      = require('util');
 const exec      = util.promisify(require('child_process').exec);
 const wp        = requireRoot('lib/wp');
 const env       = requireRoot('lib/environment');
+const w3tc      = require('./w3tc');
 
 /**
 * beforeDefault.
@@ -63,6 +64,9 @@ async function beforeDefault() {
 	const r = await exec('/share/scripts/restart-http.rb');
 	expect(r.stdout).contains('restartHttpSuccess');
 
+	// Mark generic tasks complete for "2.8.6".
+	await w3tc.w3tcMarkGenericTasksVersionsComplete('2.8.6');
+
 	global.adminPage = await browser.newPage();
 
 	adminPage.setViewport({width: 1900, height: 1000});