From 783e59e1852bb6f22be76574e7aeed88eac0c514 Mon Sep 17 00:00:00 2001
From: ryan <ryan@1a063a9b-81f0-0310-95a4-ce76da25c4cd>
Date: Fri, 2 Mar 2012 21:10:37 +0000
Subject: [PATCH] Fix NULL and FALSE in WP_Object_Cache and make
 found/not-found unambiguous. Props andy. fixes #20004

git-svn-id: http://svn.automattic.com/wordpress/trunk@20089 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/cache.php | 49 ++++++++++++++++++++++++++-----------------
 1 file changed, 30 insertions(+), 19 deletions(-)

diff --git a/wp-includes/cache.php b/wp-includes/cache.php
index 8e8c91055b..232bf735cd 100644
--- a/wp-includes/cache.php
+++ b/wp-includes/cache.php
@@ -103,13 +103,14 @@ function wp_cache_flush() {
  * @param int|string $key What the contents in the cache are called
  * @param string $group Where the cache contents are grouped
  * @param bool $force Whether to force an update of the local cache from the persistent cache (default is false)
+ * @param &bool $found Whether key was found in the cache. Disambiguates a return of false, a storable value.
  * @return bool|mixed False on failure to retrieve contents or the cache
  *		contents on success
  */
-function wp_cache_get( $key, $group = '', $force = false ) {
+function wp_cache_get( $key, $group = '', $force = false, &$found = null ) {
 	global $wp_object_cache;
 
-	return $wp_object_cache->get( $key, $group, $force );
+	return $wp_object_cache->get( $key, $group, $force, $found );
 }
 
 /**
@@ -272,7 +273,7 @@ class WP_Object_Cache {
 	/**
 	 * Adds data to the cache if it doesn't already exist.
 	 *
-	 * @uses WP_Object_Cache::get Checks to see if the cache already has data.
+	 * @uses WP_Object_Cache::_exists Checks to see if the cache already has data.
 	 * @uses WP_Object_Cache::set Sets the data after the checking the cache
 	 *		contents existence.
 	 *
@@ -288,10 +289,10 @@ class WP_Object_Cache {
 		if ( wp_suspend_cache_addition() )
 			return false;
 
-		if ( empty ($group) )
+		if ( empty( $group ) )
 			$group = 'default';
 
-		if (false !== $this->get($key, $group))
+		if ( $this->_exists($key, $group) )
 			return false;
 
 		return $this->set($key, $data, $group, $expire);
@@ -322,7 +323,7 @@ class WP_Object_Cache {
 	 * @return false|int False on failure, the item's new value on success.
 	 */
 	function decr( $key, $offset = 1, $group = 'default' ) {
-		if ( ! isset( $this->cache[ $group ][ $key ] ) )
+		if ( ! $this->_exists( $key, $group ) )
 			return false;
 
 		if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -354,13 +355,13 @@ class WP_Object_Cache {
 	 * @return bool False if the contents weren't deleted and true on success
 	 */
 	function delete($key, $group = 'default', $force = false) {
-		if (empty ($group))
+		if ( empty( $group ) )
 			$group = 'default';
 
-		if (!$force && false === $this->get($key, $group))
+		if ( ! $force && ! $this->_exists( $key, $group ) )
 			return false;
 
-		unset ($this->cache[$group][$key]);
+		unset( $this->cache[$group][$key] );
 		return true;
 	}
 
@@ -394,11 +395,12 @@ class WP_Object_Cache {
 	 * @return bool|mixed False on failure to retrieve contents or the cache
 	 *		contents on success
 	 */
-	function get( $key, $group = 'default', $force = false) {
-		if ( empty ($group) )
+	function get( $key, $group = 'default', $force = false, &$found = null ) {
+		if ( empty( $group ) )
 			$group = 'default';
 
-		if ( isset ($this->cache[$group][$key]) ) {
+		if ( $this->_exists( $key, $group ) ) {
+			$found = true;
 			$this->cache_hits += 1;
 			if ( is_object($this->cache[$group][$key]) )
 				return clone $this->cache[$group][$key];
@@ -406,6 +408,7 @@ class WP_Object_Cache {
 				return $this->cache[$group][$key];
 		}
 
+		$found = false;
 		$this->cache_misses += 1;
 		return false;
 	}
@@ -421,7 +424,10 @@ class WP_Object_Cache {
 	 * @return false|int False on failure, the item's new value on success.
 	 */
 	function incr( $key, $offset = 1, $group = 'default' ) {
-		if ( ! isset( $this->cache[ $group ][ $key ] ) )
+		if ( empty( $group ) )
+			$group = 'default';
+
+		if ( ! $this->_exists( $key, $group ) )
 			return false;
 
 		if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -450,10 +456,10 @@ class WP_Object_Cache {
 	 * @return bool False if not exists, true if contents were replaced
 	 */
 	function replace($key, $data, $group = 'default', $expire = '') {
-		if (empty ($group))
+		if ( empty( $group ) )
 			$group = 'default';
 
-		if ( false === $this->get($key, $group) )
+		if ( ! $this->_exists( $key, $group ) )
 			return false;
 
 		return $this->set($key, $data, $group, $expire);
@@ -493,12 +499,9 @@ class WP_Object_Cache {
 	 * @return bool Always returns true
 	 */
 	function set($key, $data, $group = 'default', $expire = '') {
-		if ( empty ($group) )
+		if ( empty( $group ) )
 			$group = 'default';
 
-		if ( null === $data )
-			$data = '';
-
 		if ( is_object($data) )
 			$data = clone $data;
 
@@ -526,6 +529,14 @@ class WP_Object_Cache {
 		echo '</ul>';
 	}
 
+	/**
+	 * Utility function to determine whether a key exists in the cache.
+	 * @access private
+	 */
+	protected function _exists($key, $group) {
+		return is_array( $this->cache[$group] ) && array_key_exists( $key, $this->cache[$group] );
+	}
+
 	/**
 	 * Sets up object properties; PHP 5 style constructor
 	 *