mirror of
https://github.com/YunoHost-Apps/mediawiki_ynh.git
synced 2024-09-03 19:46:05 +02:00
131 lines
3.6 KiB
PHP
131 lines
3.6 KiB
PHP
<?php
|
|
/**
|
|
* Per-process memory cache for storing items.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Cache
|
|
*/
|
|
|
|
/**
|
|
* Handles per process caching of items
|
|
* @ingroup Cache
|
|
*/
|
|
class ProcessCacheLRU {
|
|
/** @var Array */
|
|
protected $cache = array(); // (key => prop => value)
|
|
/** @var Array */
|
|
protected $cacheTimes = array(); // (key => prop => UNIX timestamp)
|
|
|
|
protected $maxCacheKeys; // integer; max entries
|
|
|
|
/**
|
|
* @param $maxKeys integer Maximum number of entries allowed (min 1).
|
|
* @throws MWException When $maxCacheKeys is not an int or =< 0.
|
|
*/
|
|
public function __construct( $maxKeys ) {
|
|
if ( !is_int( $maxKeys ) || $maxKeys < 1 ) {
|
|
throw new MWException( __METHOD__ . " must be given an integer and >= 1" );
|
|
}
|
|
$this->maxCacheKeys = $maxKeys;
|
|
}
|
|
|
|
/**
|
|
* Set a property field for a cache entry.
|
|
* This will prune the cache if it gets too large based on LRU.
|
|
* If the item is already set, it will be pushed to the top of the cache.
|
|
*
|
|
* @param $key string
|
|
* @param $prop string
|
|
* @param $value mixed
|
|
* @return void
|
|
*/
|
|
public function set( $key, $prop, $value ) {
|
|
if ( isset( $this->cache[$key] ) ) {
|
|
$this->ping( $key ); // push to top
|
|
} elseif ( count( $this->cache ) >= $this->maxCacheKeys ) {
|
|
reset( $this->cache );
|
|
$evictKey = key( $this->cache );
|
|
unset( $this->cache[$evictKey] );
|
|
unset( $this->cacheTimes[$evictKey] );
|
|
}
|
|
$this->cache[$key][$prop] = $value;
|
|
$this->cacheTimes[$key][$prop] = time();
|
|
}
|
|
|
|
/**
|
|
* Check if a property field exists for a cache entry.
|
|
*
|
|
* @param $key string
|
|
* @param $prop string
|
|
* @param $maxAge integer Ignore items older than this many seconds (since 1.21)
|
|
* @return bool
|
|
*/
|
|
public function has( $key, $prop, $maxAge = 0 ) {
|
|
if ( isset( $this->cache[$key][$prop] ) ) {
|
|
return ( $maxAge <= 0 || ( time() - $this->cacheTimes[$key][$prop] ) <= $maxAge );
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get a property field for a cache entry.
|
|
* This returns null if the property is not set.
|
|
* If the item is already set, it will be pushed to the top of the cache.
|
|
*
|
|
* @param $key string
|
|
* @param $prop string
|
|
* @return mixed
|
|
*/
|
|
public function get( $key, $prop ) {
|
|
if ( isset( $this->cache[$key][$prop] ) ) {
|
|
$this->ping( $key ); // push to top
|
|
return $this->cache[$key][$prop];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Clear one or several cache entries, or all cache entries
|
|
*
|
|
* @param $keys string|Array
|
|
* @return void
|
|
*/
|
|
public function clear( $keys = null ) {
|
|
if ( $keys === null ) {
|
|
$this->cache = array();
|
|
$this->cacheTimes = array();
|
|
} else {
|
|
foreach ( (array)$keys as $key ) {
|
|
unset( $this->cache[$key] );
|
|
unset( $this->cacheTimes[$key] );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Push an entry to the top of the cache
|
|
*
|
|
* @param $key string
|
|
*/
|
|
protected function ping( $key ) {
|
|
$item = $this->cache[$key];
|
|
unset( $this->cache[$key] );
|
|
$this->cache[$key] = $item;
|
|
}
|
|
}
|