#
# 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.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html
+
/**
+ * @defgroup Cache Cache
*
- * @package MediaWiki
+ * @file
+ * @ingroup Cache
*/
/**
- * Simple generic object store
- *
* interface is intended to be more or less compatible with
* the PHP memcached client.
*
* backends for local hash array and SQL table included:
- * $bag = new HashBagOStuff();
- * $bag = new MysqlBagOStuff($tablename); # connect to db first
+ * <code>
+ * $bag = new HashBagOStuff();
+ * $bag = new MediaWikiBagOStuff($tablename); # connect to db first
+ * </code>
*
- * @package MediaWiki
- * @abstract
+ * @ingroup Cache
*/
class BagOStuff {
var $debugmode;
- function BagOStuff() {
+ function __construct() {
$this->set_debug( false );
}
return true;
}
+ function keys() {
+ /* stub */
+ return array();
+ }
+
/* *** Emulated functions *** */
/* Better performance can likely be got with custom written versions */
function get_multi($keys) {
if($this->debugmode)
wfDebug("BagOStuff debug: $text\n");
}
+
+ /**
+ * Convert an optionally relative time to an absolute time
+ */
+ static function convertExpiry( $exptime ) {
+ if(($exptime != 0) && ($exptime < 3600*24*30)) {
+ return time() + $exptime;
+ } else {
+ return $exptime;
+ }
+ }
}
/**
* Functional versions!
- * @todo document
- * @package MediaWiki
+ * This is a test of the interface, mainly. It stores things in an associative
+ * array, which is not going to persist between program runs.
+ *
+ * @ingroup Cache
*/
class HashBagOStuff extends BagOStuff {
- /*
- This is a test of the interface, mainly. It stores
- things in an associative array, which is not going to
- persist between program runs.
- */
var $bag;
- function HashBagOStuff() {
+ function __construct() {
$this->bag = array();
}
}
function set($key,$value,$exptime=0) {
- if(($exptime != 0) && ($exptime < 3600*24*30))
- $exptime = time() + $exptime;
- $this->bag[$key] = array( $value, $exptime );
+ $this->bag[$key] = array( $value, BagOStuff::convertExpiry( $exptime ) );
}
function delete($key,$time=0) {
unset($this->bag[$key]);
return true;
}
-}
-/*
-CREATE TABLE objectcache (
- keyname char(255) binary not null default '',
- value mediumblob,
- exptime datetime,
- unique key (keyname),
- key (exptime)
-);
-*/
+ function keys() {
+ return array_keys( $this->bag );
+ }
+}
/**
- * @todo document
- * @abstract
- * @package MediaWiki
+ * Generic class to store objects in a database
+ *
+ * @ingroup Cache
*/
-class SqlBagOStuff extends BagOStuff {
+abstract class SqlBagOStuff extends BagOStuff {
var $table;
var $lastexpireall = 0;
- function SqlBagOStuff($tablename = 'objectcache') {
+ /**
+ * Constructor
+ *
+ * @param string $tablename name of the table to use
+ */
+ function __construct($tablename = 'objectcache') {
$this->table = $tablename;
}
}
if($row=$this->_fetchobject($res)) {
$this->_debug("get: retrieved data; exp time is " . $row->exptime);
- return $this->_unserialize($row->value);
+ if ( $row->exptime != $this->_maxdatetime() &&
+ wfTimestamp( TS_UNIX, $row->exptime ) < time() )
+ {
+ $this->_debug("get: key has expired, deleting");
+ $this->delete($key);
+ return false;
+ }
+ return $this->_unserialize($this->_blobdecode($row->value));
} else {
$this->_debug('get: no matching rows');
}
}
function set($key,$value,$exptime=0) {
+ if ( $this->_readonly() ) {
+ return false;
+ }
$exptime = intval($exptime);
if($exptime < 0) $exptime = 0;
if($exptime == 0) {
$exp = $this->_maxdatetime();
} else {
- if($exptime < 3600*24*30)
+ if($exptime < 3.16e8) # ~10 years
$exptime += time();
$exp = $this->_fromunixtime($exptime);
}
}
function delete($key,$time=0) {
+ if ( $this->_readonly() ) {
+ return false;
+ }
$this->_query(
"DELETE FROM $0 WHERE keyname='$1'", $key );
return true; /* ? */
}
+ function keys() {
+ $res = $this->_query( "SELECT keyname FROM $0" );
+ if(!$res) {
+ $this->_debug("keys: ** error: " . $this->_dberror($res) . " **");
+ return array();
+ }
+ $result = array();
+ while( $row = $this->_fetchobject($res) ) {
+ $result[] = $row->keyname;
+ }
+ return $result;
+ }
+
function getTableName() {
return $this->table;
}
function _blobencode($str) {
return $str;
}
- function _doinsert($table, $vals) {
- die( 'abstract function SqlBagOStuff::_doinsert() must be defined' );
- }
- function _doquery($sql) {
- die( 'abstract function SqlBagOStuff::_doquery() must be defined' );
+ function _blobdecode($str) {
+ return $str;
}
- function _fetchrow($res) {
- die( 'abstract function SqlBagOStuff::_fetchrow() must be defined' );
- }
+ abstract function _doinsert($table, $vals);
+ abstract function _doquery($sql);
+
+ abstract function _readonly();
function _freeresult($result) {
/* stub */
return 'unknown error';
}
- function _maxdatetime() {
- die( 'abstract function SqlBagOStuff::_maxdatetime() must be defined' );
- }
-
- function _fromunixtime() {
- die( 'abstract function SqlBagOStuff::_fromunixtime() must be defined' );
- }
+ abstract function _maxdatetime();
+ abstract function _fromunixtime($ts);
function garbageCollect() {
/* Ignore 99% of requests */
function expireall() {
/* Remove any items that have expired */
+ if ( $this->_readonly() ) {
+ return false;
+ }
$now = $this->_fromunixtime( time() );
$this->_query( "DELETE FROM $0 WHERE exptime < '$now'" );
}
function deleteall() {
/* Clear *all* items from cache table */
+ if ( $this->_readonly() ) {
+ return false;
+ }
$this->_query( "DELETE FROM $0" );
}
}
/**
- * @todo document
- * @package MediaWiki
+ * Stores objects in the main database of the wiki
+ *
+ * @ingroup Cache
*/
class MediaWikiBagOStuff extends SqlBagOStuff {
var $tableInitialised = false;
+ function _getDB(){
+ static $db;
+ if( !isset( $db ) )
+ $db = wfGetDB( DB_MASTER );
+ return $db;
+ }
function _doquery($sql) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->query($sql, 'MediaWikiBagOStuff::_doquery');
+ return $this->_getDB()->query( $sql, __METHOD__ );
}
function _doinsert($t, $v) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->insert($t, $v, 'MediaWikiBagOStuff::_doinsert');
+ return $this->_getDB()->insert($t, $v, __METHOD__, array( 'IGNORE' ) );
}
function _fetchobject($result) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->fetchObject($result);
+ return $this->_getDB()->fetchObject($result);
}
function _freeresult($result) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->freeResult($result);
+ return $this->_getDB()->freeResult($result);
}
function _dberror($result) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->lastError();
+ return $this->_getDB()->lastError();
}
function _maxdatetime() {
- $dbw =& wfGetDB(DB_MASTER);
- return $dbw->timestamp('9999-12-31 12:59:59');
+ if ( time() > 0x7fffffff ) {
+ return $this->_fromunixtime( 1<<62 );
+ } else {
+ return $this->_fromunixtime( 0x7fffffff );
+ }
}
function _fromunixtime($ts) {
- $dbw =& wfGetDB(DB_MASTER);
- return $dbw->timestamp($ts);
+ return $this->_getDB()->timestamp($ts);
+ }
+ function _readonly(){
+ return wfReadOnly();
}
function _strencode($s) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->strencode($s);
+ return $this->_getDB()->strencode($s);
}
function _blobencode($s) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->encodeBlob($s);
+ return $this->_getDB()->encodeBlob($s);
+ }
+ function _blobdecode($s) {
+ return $this->_getDB()->decodeBlob($s);
}
function getTableName() {
if ( !$this->tableInitialised ) {
- $dbw =& wfGetDB( DB_MASTER );
+ $dbw = $this->_getDB();
/* This is actually a hack, we should be able
to use Language classes here... or not */
if (!$dbw)
- die("Could not connect to database");
+ throw new MWException("Could not connect to database");
$this->table = $dbw->tableName( $this->table );
$this->tableInitialised = true;
}
* that Turck's serializer is faster, so a possible future extension would be
* to use it for arrays but not for objects.
*
- * @package MediaWiki
+ * @ingroup Cache
*/
class TurckBagOStuff extends BagOStuff {
function get($key) {
}
}
+/**
+ * This is a wrapper for APC's shared memory functions
+ *
+ * @ingroup Cache
+ */
+class APCBagOStuff extends BagOStuff {
+ function get($key) {
+ $val = apc_fetch($key);
+ if ( is_string( $val ) ) {
+ $val = unserialize( $val );
+ }
+ return $val;
+ }
+
+ function set($key, $value, $exptime=0) {
+ apc_store($key, serialize($value), $exptime);
+ return true;
+ }
+
+ function delete($key, $time=0) {
+ apc_delete($key);
+ return true;
+ }
+}
+
+
/**
* This is a wrapper for eAccelerator's shared memory functions.
*
* This is basically identical to the Turck MMCache version,
* mostly because eAccelerator is based on Turck MMCache.
*
- * @package MediaWiki
+ * @ingroup Cache
*/
class eAccelBagOStuff extends BagOStuff {
function get($key) {
return true;
}
}
-?>
+
+/**
+ * Wrapper for XCache object caching functions; identical interface
+ * to the APC wrapper
+ *
+ * @ingroup Cache
+ */
+class XCacheBagOStuff extends BagOStuff {
+
+ /**
+ * Get a value from the XCache object cache
+ *
+ * @param string $key Cache key
+ * @return mixed
+ */
+ public function get( $key ) {
+ $val = xcache_get( $key );
+ if( is_string( $val ) )
+ $val = unserialize( $val );
+ return $val;
+ }
+
+ /**
+ * Store a value in the XCache object cache
+ *
+ * @param string $key Cache key
+ * @param mixed $value Object to store
+ * @param int $expire Expiration time
+ * @return bool
+ */
+ public function set( $key, $value, $expire = 0 ) {
+ xcache_set( $key, serialize( $value ), $expire );
+ return true;
+ }
+
+ /**
+ * Remove a value from the XCache object cache
+ *
+ * @param string $key Cache key
+ * @param int $time Not used in this implementation
+ * @return bool
+ */
+ public function delete( $key, $time = 0 ) {
+ xcache_unset( $key );
+ return true;
+ }
+
+}
+
+/**
+ * @todo document
+ * @ingroup Cache
+ */
+class DBABagOStuff extends BagOStuff {
+ var $mHandler, $mFile, $mReader, $mWriter, $mDisabled;
+
+ function __construct( $handler = 'db3', $dir = false ) {
+ if ( $dir === false ) {
+ global $wgTmpDirectory;
+ $dir = $wgTmpDirectory;
+ }
+ $this->mFile = "$dir/mw-cache-" . wfWikiID();
+ $this->mFile .= '.db';
+ wfDebug( __CLASS__.": using cache file {$this->mFile}\n" );
+ $this->mHandler = $handler;
+ }
+
+ /**
+ * Encode value and expiry for storage
+ */
+ function encode( $value, $expiry ) {
+ # Convert to absolute time
+ $expiry = BagOStuff::convertExpiry( $expiry );
+ return sprintf( '%010u', intval( $expiry ) ) . ' ' . serialize( $value );
+ }
+
+ /**
+ * @return list containing value first and expiry second
+ */
+ function decode( $blob ) {
+ if ( !is_string( $blob ) ) {
+ return array( null, 0 );
+ } else {
+ return array(
+ unserialize( substr( $blob, 11 ) ),
+ intval( substr( $blob, 0, 10 ) )
+ );
+ }
+ }
+
+ function getReader() {
+ if ( file_exists( $this->mFile ) ) {
+ $handle = dba_open( $this->mFile, 'rl', $this->mHandler );
+ } else {
+ $handle = $this->getWriter();
+ }
+ if ( !$handle ) {
+ wfDebug( "Unable to open DBA cache file {$this->mFile}\n" );
+ }
+ return $handle;
+ }
+
+ function getWriter() {
+ $handle = dba_open( $this->mFile, 'cl', $this->mHandler );
+ if ( !$handle ) {
+ wfDebug( "Unable to open DBA cache file {$this->mFile}\n" );
+ }
+ return $handle;
+ }
+
+ function get( $key ) {
+ wfProfileIn( __METHOD__ );
+ wfDebug( __METHOD__."($key)\n" );
+ $handle = $this->getReader();
+ if ( !$handle ) {
+ return null;
+ }
+ $val = dba_fetch( $key, $handle );
+ list( $val, $expiry ) = $this->decode( $val );
+ # Must close ASAP because locks are held
+ dba_close( $handle );
+
+ if ( !is_null( $val ) && $expiry && $expiry < time() ) {
+ # Key is expired, delete it
+ $handle = $this->getWriter();
+ dba_delete( $key, $handle );
+ dba_close( $handle );
+ wfDebug( __METHOD__.": $key expired\n" );
+ $val = null;
+ }
+ wfProfileOut( __METHOD__ );
+ return $val;
+ }
+
+ function set( $key, $value, $exptime=0 ) {
+ wfProfileIn( __METHOD__ );
+ wfDebug( __METHOD__."($key)\n" );
+ $blob = $this->encode( $value, $exptime );
+ $handle = $this->getWriter();
+ if ( !$handle ) {
+ return false;
+ }
+ $ret = dba_replace( $key, $blob, $handle );
+ dba_close( $handle );
+ wfProfileOut( __METHOD__ );
+ return $ret;
+ }
+
+ function delete( $key, $time = 0 ) {
+ wfProfileIn( __METHOD__ );
+ wfDebug( __METHOD__."($key)\n" );
+ $handle = $this->getWriter();
+ if ( !$handle ) {
+ return false;
+ }
+ $ret = dba_delete( $key, $handle );
+ dba_close( $handle );
+ wfProfileOut( __METHOD__ );
+ return $ret;
+ }
+
+ function add( $key, $value, $exptime = 0 ) {
+ wfProfileIn( __METHOD__ );
+ $blob = $this->encode( $value, $exptime );
+ $handle = $this->getWriter();
+ if ( !$handle ) {
+ return false;
+ }
+ $ret = dba_insert( $key, $blob, $handle );
+ # Insert failed, check to see if it failed due to an expired key
+ if ( !$ret ) {
+ list( $value, $expiry ) = $this->decode( dba_fetch( $key, $handle ) );
+ if ( $expiry < time() ) {
+ # Yes expired, delete and try again
+ dba_delete( $key, $handle );
+ $ret = dba_insert( $key, $blob, $handle );
+ # This time if it failed then it will be handled by the caller like any other race
+ }
+ }
+
+ dba_close( $handle );
+ wfProfileOut( __METHOD__ );
+ return $ret;
+ }
+
+ function keys() {
+ $reader = $this->getReader();
+ $k1 = dba_firstkey( $reader );
+ if( !$k1 ) {
+ return array();
+ }
+ $result[] = $k1;
+ while( $key = dba_nextkey( $reader ) ) {
+ $result[] = $key;
+ }
+ return $result;
+ }
+}
dépôts / lhc / web / wiklou.git / blobdiff