X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/11be8dc178e77d0b46189bbd8e33a216a9b90942..refs/tags/wordpress-3.4:/wp-includes/cache.php diff --git a/wp-includes/cache.php b/wp-includes/cache.php index 5eef60b1..bb61249c 100644 --- a/wp-includes/cache.php +++ b/wp-includes/cache.php @@ -9,29 +9,29 @@ */ /** - * Adds data to the cache, if the cache key doesn't aleady exist. + * Adds data to the cache, if the cache key doesn't already exist. * * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::add() * - * @param int|string $key The cache ID to use for retrieval later + * @param int|string $key The cache key to use for retrieval later * @param mixed $data The data to add to the cache store - * @param string $flag The group to add the cache to + * @param string $group The group to add the cache to * @param int $expire When the cache data should be expired * @return unknown */ -function wp_cache_add($key, $data, $flag = '', $expire = 0) { +function wp_cache_add($key, $data, $group = '', $expire = 0) { global $wp_object_cache; - return $wp_object_cache->add($key, $data, $flag, $expire); + return $wp_object_cache->add($key, $data, $group, $expire); } /** * Closes the cache. * * This function has ceased to do anything since WordPress 2.5. The - * functionality was removed along with the rest of the persistant cache. This + * functionality was removed along with the rest of the persistent cache. This * does not mean that plugins can't implement this function when they need to * make sure that the cache is cleaned up after WordPress no longer needs it. * @@ -44,20 +44,38 @@ function wp_cache_close() { } /** - * Removes the cache contents matching ID and flag. + * Decrement numeric cache item's value + * + * @since 3.3.0 + * @uses $wp_object_cache Object Cache Class + * @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 string $group The group the key is in. + * @return false|int False on failure, the item's new value on success. + */ +function wp_cache_decr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->decr( $key, $offset, $group ); +} + +/** + * Removes the cache contents matching key and group. * * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::delete() * - * @param int|string $id What the contents in the cache are called - * @param string $flag Where the cache contents are grouped + * @param int|string $key What the contents in the cache are called + * @param string $group Where the cache contents are grouped * @return bool True on successful removal, false on failure */ -function wp_cache_delete($id, $flag = '') { +function wp_cache_delete($key, $group = '') { global $wp_object_cache; - return $wp_object_cache->delete($id, $flag); + return $wp_object_cache->delete($key, $group); } /** @@ -76,21 +94,41 @@ function wp_cache_flush() { } /** - * Retrieves the cache contents from the cache by ID and flag. + * Retrieves the cache contents from the cache by key and group. * * @since 2.0.0 * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::get() * - * @param int|string $id What the contents in the cache are called - * @param string $flag Where the cache contents are grouped + * @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($id, $flag = '') { +function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { + global $wp_object_cache; + + return $wp_object_cache->get( $key, $group, $force, $found ); +} + +/** + * Increment numeric cache item's value + * + * @since 3.3.0 + * @uses $wp_object_cache Object Cache Class + * @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 string $group The group the key is in. + * @return false|int False on failure, the item's new value on success. + */ +function wp_cache_incr( $key, $offset = 1, $group = '' ) { global $wp_object_cache; - return $wp_object_cache->get($id, $flag); + return $wp_object_cache->incr( $key, $offset, $group ); } /** @@ -100,7 +138,7 @@ function wp_cache_get($id, $flag = '') { * @global WP_Object_Cache $wp_object_cache WordPress Object Cache */ function wp_cache_init() { - $GLOBALS['wp_object_cache'] =& new WP_Object_Cache(); + $GLOBALS['wp_object_cache'] = new WP_Object_Cache(); } /** @@ -110,16 +148,16 @@ function wp_cache_init() { * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::replace() * - * @param int|string $id What to call the contents in the cache + * @param int|string $key What to call the contents in the cache * @param mixed $data The contents to store in the cache - * @param string $flag Where to group the cache contents + * @param string $group Where to group the cache contents * @param int $expire When to expire the cache contents - * @return bool False if cache ID and group already exists, true on success + * @return bool False if cache key and group already exist, true on success */ -function wp_cache_replace($key, $data, $flag = '', $expire = 0) { +function wp_cache_replace($key, $data, $group = '', $expire = 0) { global $wp_object_cache; - return $wp_object_cache->replace($key, $data, $flag, $expire); + return $wp_object_cache->replace($key, $data, $group, $expire); } /** @@ -129,16 +167,16 @@ function wp_cache_replace($key, $data, $flag = '', $expire = 0) { * @uses $wp_object_cache Object Cache Class * @see WP_Object_Cache::set() * - * @param int|string $id What to call the contents in the cache + * @param int|string $key What to call the contents in the cache * @param mixed $data The contents to store in the cache - * @param string $flag Where to group the cache contents + * @param string $group Where to group the cache contents * @param int $expire When to expire the cache contents - * @return bool False if cache ID and group already exists, true on success + * @return bool False if cache key and group already exist, true on success */ -function wp_cache_set($key, $data, $flag = '', $expire = 0) { +function wp_cache_set($key, $data, $group = '', $expire = 0) { global $wp_object_cache; - return $wp_object_cache->set($key, $data, $flag, $expire); + return $wp_object_cache->set($key, $data, $group, $expire); } /** @@ -149,8 +187,9 @@ function wp_cache_set($key, $data, $flag = '', $expire = 0) { * @param string|array $groups A group or an array of groups to add */ function wp_cache_add_global_groups( $groups ) { - // Default cache doesn't persist so nothing to do here. - return; + global $wp_object_cache; + + return $wp_object_cache->add_global_groups($groups); } /** @@ -165,6 +204,18 @@ function wp_cache_add_non_persistent_groups( $groups ) { return; } +/** + * 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. + * + * @since 2.6.0 + */ +function wp_cache_reset() { + global $wp_object_cache; + + return $wp_object_cache->reset(); +} + /** * WordPress Object Cache * @@ -192,15 +243,6 @@ class WP_Object_Cache { */ var $cache = array (); - /** - * Cache objects that do not exist in the cache - * - * @var array - * @access private - * @since 2.0.0 - */ - var $non_existant_objects = array (); - /** * The amount of times the cache data was already stored in the cache. * @@ -219,58 +261,107 @@ class WP_Object_Cache { */ var $cache_misses = 0; + /** + * List of global groups + * + * @var array + * @access protected + * @since 3.0.0 + */ + var $global_groups = array(); + /** * 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 existance. + * contents existence. * * @since 2.0.0 * - * @param int|string $id What to call the contents in the cache + * @param int|string $key What to call the contents in the cache * @param mixed $data The contents to store in the cache * @param string $group Where to group the cache contents * @param int $expire When to expire the cache contents - * @return bool False if cache ID and group already exists, true on success + * @return bool False if cache key and group already exist, true on success */ - function add($id, $data, $group = 'default', $expire = '') { - if (empty ($group)) + function add( $key, $data, $group = 'default', $expire = '' ) { + if ( wp_suspend_cache_addition() ) + return false; + + if ( empty( $group ) ) $group = 'default'; - if (false !== $this->get($id, $group, false)) + if ( $this->_exists($key, $group) ) + return false; + + return $this->set($key, $data, $group, $expire); + } + + /** + * Sets the list of global groups. + * + * @since 3.0.0 + * + * @param array $groups List of groups that are global. + */ + 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); + } + + /** + * Decrement numeric cache item's value + * + * @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 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 ( ! $this->_exists( $key, $group ) ) return false; - return $this->set($id, $data, $group, $expire); + if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) + $this->cache[ $group ][ $key ] = 0; + + $offset = (int) $offset; + + $this->cache[ $group ][ $key ] -= $offset; + + if ( $this->cache[ $group ][ $key ] < 0 ) + $this->cache[ $group ][ $key ] = 0; + + return $this->cache[ $group ][ $key ]; } /** - * Remove the contents of the cache ID in the group + * Remove the contents of the cache key in the group * - * If the cache ID does not exist in the group and $force parameter is set + * If the cache key does not exist in the group and $force parameter is set * to false, then nothing will happen. The $force parameter is set to false * by default. * - * On success the group and the id will be added to the - * $non_existant_objects property in the class. - * * @since 2.0.0 * - * @param int|string $id What the contents in the cache are called + * @param int|string $key What the contents in the cache are called * @param string $group Where the cache contents are grouped * @param bool $force Optional. Whether to force the unsetting of the cache - * ID in the group + * key in the group * @return bool False if the contents weren't deleted and true on success */ - function delete($id, $group = 'default', $force = false) { - if (empty ($group)) + function delete($key, $group = 'default', $force = false) { + if ( empty( $group ) ) $group = 'default'; - if (!$force && false === $this->get($id, $group, false)) + if ( ! $force && ! $this->_exists( $key, $group ) ) return false; - unset ($this->cache[$group][$id]); - $this->non_existant_objects[$group][$id] = true; + unset( $this->cache[$group][$key] ); return true; } @@ -291,69 +382,107 @@ class WP_Object_Cache { * Retrieves the cache contents, if it exists * * The contents will be first attempted to be retrieved by searching by the - * ID in the cache group. If the cache is hit (success) then the contents + * key in the cache group. If the cache is hit (success) then the contents * are returned. * - * On failure, the $non_existant_objects property is checked and if the - * cache group and ID exist in there the cache misses will not be - * incremented. If not in the nonexistant objects property, then the cache - * misses will be incremented and the cache group and ID will be added to - * the nonexistant objects. + * On failure, the number of cache misses will be incremented. * * @since 2.0.0 * - * @param int|string $id What the contents in the cache are called + * @param int|string $key What the contents in the cache are called * @param string $group Where the cache contents are grouped + * @param string $force Whether to force a refetch rather than relying on the local cache (default is false) * @return bool|mixed False on failure to retrieve contents or the cache * contents on success */ - function get($id, $group = 'default') { - if (empty ($group)) + function get( $key, $group = 'default', $force = false, &$found = null ) { + if ( empty( $group ) ) $group = 'default'; - if (isset ($this->cache[$group][$id])) { + if ( $this->_exists( $key, $group ) ) { + $found = true; $this->cache_hits += 1; - if ( is_object($this->cache[$group][$id]) ) - return wp_clone($this->cache[$group][$id]); + if ( is_object($this->cache[$group][$key]) ) + return clone $this->cache[$group][$key]; else - return $this->cache[$group][$id]; + return $this->cache[$group][$key]; } - if ( isset ($this->non_existant_objects[$group][$id]) ) - return false; - - $this->non_existant_objects[$group][$id] = true; + $found = false; $this->cache_misses += 1; return false; } + /** + * Increment numeric cache item's value + * + * @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 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 ( empty( $group ) ) + $group = 'default'; + + if ( ! $this->_exists( $key, $group ) ) + return false; + + if ( ! is_numeric( $this->cache[ $group ][ $key ] ) ) + $this->cache[ $group ][ $key ] = 0; + + $offset = (int) $offset; + + $this->cache[ $group ][ $key ] += $offset; + + if ( $this->cache[ $group ][ $key ] < 0 ) + $this->cache[ $group ][ $key ] = 0; + + return $this->cache[ $group ][ $key ]; + } + /** * Replace the contents in the cache, if contents already exist * * @since 2.0.0 * @see WP_Object_Cache::set() * - * @param int|string $id What to call the contents in the cache + * @param int|string $key What to call the contents in the cache * @param mixed $data The contents to store in the cache * @param string $group Where to group the cache contents * @param int $expire When to expire the cache contents * @return bool False if not exists, true if contents were replaced */ - function replace($id, $data, $group = 'default', $expire = '') { - if (empty ($group)) + function replace($key, $data, $group = 'default', $expire = '') { + if ( empty( $group ) ) $group = 'default'; - if (false === $this->get($id, $group, false)) + if ( ! $this->_exists( $key, $group ) ) return false; - return $this->set($id, $data, $group, $expire); + return $this->set($key, $data, $group, $expire); + } + + /** + * Reset keys + * + * @since 3.0.0 + */ + function reset() { + // 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]); + } } /** * Sets the data contents into the cache * * The cache contents is grouped by the $group parameter followed by the - * $id. This allows for duplicate ids in unique groups. Therefore, naming of + * $key. This allows for duplicate ids in unique groups. Therefore, naming of * the group should be used with care and should follow normal function * naming guidelines outside of core WordPress usage. * @@ -363,32 +492,25 @@ class WP_Object_Cache { * * @since 2.0.0 * - * @param int|string $id What to call the contents in the cache + * @param int|string $key What to call the contents in the cache * @param mixed $data The contents to store in the cache * @param string $group Where to group the cache contents * @param int $expire Not Used * @return bool Always returns true */ - function set($id, $data, $group = 'default', $expire = '') { - if (empty ($group)) + function set($key, $data, $group = 'default', $expire = '') { + if ( empty( $group ) ) $group = 'default'; - if (NULL === $data) - $data = ''; - if ( is_object($data) ) - $data = wp_clone($data); - - $this->cache[$group][$id] = $data; - - if(isset($this->non_existant_objects[$group][$id])) - unset ($this->non_existant_objects[$group][$id]); + $data = clone $data; + $this->cache[$group][$key] = $data; return true; } /** - * Echos the stats of the caching. + * Echoes the stats of the caching. * * Gives the cache hits, and cache misses. Also prints every cached group, * key and the data. @@ -400,26 +522,19 @@ class WP_Object_Cache { echo "Cache Hits: {$this->cache_hits}
"; echo "Cache Misses: {$this->cache_misses}
"; echo "

"; - + echo ''; } /** - * PHP4 constructor; Calls PHP 5 style constructor - * - * @since 2.0.0 - * - * @return WP_Object_Cache + * Utility function to determine whether a key exists in the cache. + * @access private */ - function WP_Object_Cache() { - return $this->__construct(); + protected function _exists($key, $group) { + return isset( $this->cache[$group] ) && is_array( $this->cache[$group] ) && array_key_exists( $key, $this->cache[$group] ); } /** @@ -449,4 +564,3 @@ class WP_Object_Cache { return true; } } -?>