Wordpress 3.5.2
[autoinstalls/wordpress.git] / wp-includes / cache.php
index f285be3a9093da1e0d9d70ccba0264eca613c00e..933c7b2ec1af9ddb05ade3dfb3ba490f8ddd27d4 100644 (file)
@@ -51,7 +51,7 @@ function wp_cache_close() {
  * @see WP_Object_Cache::decr()
  *
  * @param int|string $key The cache key to increment
- * @param int $offset The amount by which to decrement the item's value.  Default is 1.
+ * @param int $offset The amount by which to decrement the item's value. Default is 1.
  * @param string $group The group the key is in.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -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 );
 }
 
 /**
@@ -120,7 +121,7 @@ function wp_cache_get( $key, $group = '', $force = false ) {
  * @see WP_Object_Cache::incr()
  *
  * @param int|string $key The cache key to increment
- * @param int $offset The amount by which to increment the item's value.  Default is 1.
+ * @param int $offset The amount by which to increment the item's value. Default is 1.
  * @param string $group The group the key is in.
  * @return false|int False on failure, the item's new value on success.
  */
@@ -178,6 +179,21 @@ function wp_cache_set($key, $data, $group = '', $expire = 0) {
        return $wp_object_cache->set($key, $data, $group, $expire);
 }
 
+/**
+ * Switch the interal blog id.
+ *
+ * This changes the blog id used to create keys in blog specific groups.
+ *
+ * @since 3.5.0
+ *
+ * @param int $blog_id Blog ID
+ */
+function wp_cache_switch_to_blog( $blog_id ) {
+       global $wp_object_cache;
+
+       return $wp_object_cache->switch_to_blog( $blog_id );
+}
+
 /**
  * Adds a group or set of groups to the list of global groups.
  *
@@ -188,7 +204,7 @@ function wp_cache_set($key, $data, $group = '', $expire = 0) {
 function wp_cache_add_global_groups( $groups ) {
        global $wp_object_cache;
 
-       return $wp_object_cache->add_global_groups($groups);
+       return $wp_object_cache->add_global_groups( $groups );
 }
 
 /**
@@ -204,12 +220,23 @@ function wp_cache_add_non_persistent_groups( $groups ) {
 }
 
 /**
- * Reset internal cache keys and structures.  If the cache backend uses global blog or site IDs as part of its cache keys,
- * this function instructs the backend to reset those keys and perform any cleanup since blog or site IDs have changed since cache init.
+ * Reset internal cache keys and structures. If the cache backend uses global
+ * blog or site IDs as part of its cache keys, this function instructs the
+ * backend to reset those keys and perform any cleanup since blog or site IDs
+ * have changed since cache init.
+ *
+ * This function is deprecated. Use wp_cache_switch_to_blog() instead of this
+ * function when preparing the cache for a blog switch. For clearing the cache
+ * during unit tests, consider using wp_cache_init(). wp_cache_init() is not
+ * recommended outside of unit tests as the performance penality for using it is
+ * high.
  *
  * @since 2.6.0
+ * @deprecated 3.5.0
  */
 function wp_cache_reset() {
+       _deprecated_function( __FUNCTION__, '3.5' );
+
        global $wp_object_cache;
 
        return $wp_object_cache->reset();
@@ -269,10 +296,19 @@ class WP_Object_Cache {
         */
        var $global_groups = array();
 
+       /**
+        * The blog prefix to prepend to keys in non-global groups.
+        *
+        * @var int
+        * @access private
+        * @since 3.5.0
+        */
+       var $blog_prefix;
+
        /**
         * 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 +324,14 @@ 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))
+               $id = $key;
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $id = $this->blog_prefix . $key;
+
+               if ( $this->_exists( $id, $group ) )
                        return false;
 
                return $this->set($key, $data, $group, $expire);
@@ -307,8 +347,8 @@ class WP_Object_Cache {
        function add_global_groups( $groups ) {
                $groups = (array) $groups;
 
-               $this->global_groups = array_merge($this->global_groups, $groups);
-               $this->global_groups = array_unique($this->global_groups);
+               $groups = array_fill_keys( $groups, true );
+               $this->global_groups = array_merge( $this->global_groups, $groups );
        }
 
        /**
@@ -317,12 +357,18 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @param int|string $key The cache key to increment
-        * @param int $offset The amount by which to decrement the item's value.  Default is 1.
+        * @param int $offset The amount by which to decrement the item's value. Default is 1.
         * @param string $group The group the key is in.
         * @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 ( empty( $group ) )
+                       $group = 'default';
+
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -354,13 +400,16 @@ 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 ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $force && ! $this->_exists( $key, $group ) )
                        return false;
 
-               unset ($this->cache[$group][$key]);
+               unset( $this->cache[$group][$key] );
                return true;
        }
 
@@ -394,11 +443,15 @@ 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->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $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 +459,7 @@ class WP_Object_Cache {
                                return $this->cache[$group][$key];
                }
 
+               $found = false;
                $this->cache_misses += 1;
                return false;
        }
@@ -416,12 +470,18 @@ class WP_Object_Cache {
         * @since 3.3.0
         *
         * @param int|string $key The cache key to increment
-        * @param int $offset The amount by which to increment the item's value.  Default is 1.
+        * @param int $offset The amount by which to increment the item's value. Default is 1.
         * @param string $group The group the key is in.
         * @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->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $key, $group ) )
                        return false;
 
                if ( ! is_numeric( $this->cache[ $group ][ $key ] ) )
@@ -449,26 +509,33 @@ class WP_Object_Cache {
         * @param int $expire When to expire the cache contents
         * @return bool False if not exists, true if contents were replaced
         */
-       function replace($key, $data, $group = 'default', $expire = '') {
-               if (empty ($group))
+       function replace( $key, $data, $group = 'default', $expire = '' ) {
+               if ( empty( $group ) )
                        $group = 'default';
 
-               if ( false === $this->get($key, $group) )
+               $id = $key;
+               if ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $id = $this->blog_prefix . $key;
+
+               if ( ! $this->_exists( $id, $group ) )
                        return false;
 
-               return $this->set($key, $data, $group, $expire);
+               return $this->set( $key, $data, $group, $expire );
        }
 
        /**
         * Reset keys
         *
         * @since 3.0.0
+        * @deprecated 3.5.0
         */
        function reset() {
+               _deprecated_function( __FUNCTION__, '3.5', 'switch_to_blog()' );
+
                // Clear out non-global caches since the blog ID has changed.
-               foreach ( array_keys($this->cache) as $group ) {
-                       if ( !in_array($group, $this->global_groups) )
-                               unset($this->cache[$group]);
+               foreach ( array_keys( $this->cache ) as $group ) {
+                       if ( ! isset( $this->global_groups[ $group ] ) )
+                               unset( $this->cache[ $group ] );
                }
        }
 
@@ -493,13 +560,13 @@ 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 ( $this->multisite && ! isset( $this->global_groups[ $group ] ) )
+                       $key = $this->blog_prefix . $key;
 
-               if ( is_object($data) )
+               if ( is_object( $data ) )
                        $data = clone $data;
 
                $this->cache[$group][$key] = $data;
@@ -526,6 +593,31 @@ class WP_Object_Cache {
                echo '</ul>';
        }
 
+       /**
+        * Switch the interal blog id.
+        *
+        * This changes the blog id used to create keys in blog specific groups.
+        *
+        * @since 3.5.0
+        *
+        * @param int $blog_id Blog ID
+        */
+       function switch_to_blog( $blog_id ) {
+               $blog_id = (int) $blog_id;
+               $this->blog_prefix = $this->multisite ? $blog_id . ':' : '';
+       }
+
+       /**
+        * Utility function to determine whether a key exists in the cache.
+        *
+        * @since 3.4.0
+        *
+        * @access protected
+        */
+       protected function _exists( $key, $group ) {
+               return isset( $this->cache[ $group ] ) && ( isset( $this->cache[ $group ][ $key ] ) || array_key_exists( $key, $this->cache[ $group ] ) );
+       }
+
        /**
         * Sets up object properties; PHP 5 style constructor
         *
@@ -533,11 +625,17 @@ class WP_Object_Cache {
         * @return null|WP_Object_Cache If cache is disabled, returns null.
         */
        function __construct() {
+               global $blog_id;
+
+               $this->multisite = is_multisite();
+               $this->blog_prefix =  $this->multisite ? $blog_id . ':' : '';
+
+
                /**
                 * @todo This should be moved to the PHP4 style constructor, PHP5
                 * already calls __destruct()
                 */
-               register_shutdown_function(array(&$this, "__destruct"));
+               register_shutdown_function( array( $this, '__destruct' ) );
        }
 
        /**
@@ -553,4 +651,3 @@ class WP_Object_Cache {
                return true;
        }
 }
-?>