# 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
+
/**
+ * @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
+ * @ingroup Cache
*/
class BagOStuff {
var $debugmode;
return true;
}
+ function keys() {
+ /* stub */
+ return array();
+ }
+
/* *** Emulated functions *** */
/* Better performance can likely be got with custom written versions */
function get_multi($keys) {
/**
* 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 get($key) {
- if(!$this->bag[$key])
+ if( !isset( $this->bag[$key] ) )
return false;
if($this->_expire($key))
return false;
}
function delete($key,$time=0) {
- if(!$this->bag[$key])
+ if( !isset( $this->bag[$key] ) )
return false;
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
*/
abstract class SqlBagOStuff extends BagOStuff {
var $table;
var $lastexpireall = 0;
- function SqlBagOStuff($tablename = 'objectcache') {
+ /**
+ * Constructor
+ *
+ * @param $tablename String: 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);
- if ( $row->exptime != $this->_maxdatetime() &&
- wfTimestamp( TS_UNIX, $row->exptime ) < time() )
+ if ( $row->exptime != $this->_maxdatetime() &&
+ wfTimestamp( TS_UNIX, $row->exptime ) < time() )
{
$this->_debug("get: key has expired, deleting");
$this->delete($key);
}
function set($key,$value,$exptime=0) {
+ if ( $this->_readonly() ) {
+ return false;
+ }
$exptime = intval($exptime);
if($exptime < 0) $exptime = 0;
if($exptime == 0) {
$exptime += time();
$exp = $this->_fromunixtime($exptime);
}
- $this->delete( $key );
+ $this->_begin();
+ $this->_query(
+ "DELETE FROM $0 WHERE keyname='$1'", $key );
$this->_doinsert($this->getTableName(), array(
'keyname' => $key,
'value' => $this->_blobencode($this->_serialize($value)),
'exptime' => $exp
));
+ $this->_commit();
return true; /* ? */
}
function delete($key,$time=0) {
+ if ( $this->_readonly() ) {
+ return false;
+ }
+ $this->_begin();
$this->_query(
"DELETE FROM $0 WHERE keyname='$1'", $key );
+ $this->_commit();
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;
}
abstract function _doinsert($table, $vals);
abstract function _doquery($sql);
+ abstract function _readonly();
+
+ function _begin() {}
+ function _commit() {}
+
function _freeresult($result) {
/* stub */
return false;
function expireall() {
/* Remove any items that have expired */
+ if ( $this->_readonly() ) {
+ return false;
+ }
$now = $this->_fromunixtime( time() );
+ $this->_begin();
$this->_query( "DELETE FROM $0 WHERE exptime < '$now'" );
+ $this->_commit();
}
function deleteall() {
/* Clear *all* items from cache table */
+ if ( $this->_readonly() ) {
+ return false;
+ }
+ $this->_begin();
$this->_query( "DELETE FROM $0" );
+ $this->_commit();
}
/**
* On typical message and page data, this can provide a 3X decrease
* in storage requirements.
*
- * @param mixed $data
+ * @param $data mixed
* @return string
*/
function _serialize( &$data ) {
/**
* Unserialize and, if necessary, decompress an object.
- * @param string $serial
+ * @param $serial string
* @return mixed
*/
function _unserialize( $serial ) {
}
/**
- * @todo document
- * @package MediaWiki
+ * Stores objects in the main database of the wiki
+ *
+ * @ingroup Cache
*/
class MediaWikiBagOStuff extends SqlBagOStuff {
var $tableInitialised = false;
+ var $lb, $db;
+ function _getDB(){
+ if ( !isset( $this->lb ) ) {
+ $this->lb = wfGetLBFactory()->newMainLB();
+ $this->db = $this->lb->getConnection( DB_MASTER );
+ $this->db->clearFlag( DBO_TRX );
+ }
+ return $this->db;
+ }
+ function _begin() {
+ $this->_getDB()->begin();
+ }
+ function _commit() {
+ $this->_getDB()->commit();
+ }
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',
- array( 'IGNORE' ) );
+ 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() {
if ( time() > 0x7fffffff ) {
}
}
function _fromunixtime($ts) {
- $dbw =& wfGetDB(DB_MASTER);
- return $dbw->timestamp($ts);
+ return $this->_getDB()->timestamp($ts);
+ }
+ /***
+ * Note -- this should *not* check wfReadOnly().
+ * Read-only mode has been repurposed from the original
+ * "nothing must write to the database" to "users should not
+ * be able to edit or alter anything user-visible".
+ *
+ * Backend bits like the object cache should continue
+ * to work in this mode, otherwise things will blow up
+ * like the message cache failing to save its state,
+ * causing long delays (bug 11533).
+ */
+ function _readonly(){
+ return false;
}
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) {
- $dbw =& wfGetDB( DB_MASTER );
- return $dbw->decodeBlob($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)
* 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
*
- * @package MediaWiki
+ * @ingroup Cache
*/
-
class APCBagOStuff extends BagOStuff {
function get($key) {
$val = apc_fetch($key);
}
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 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) {
}
}
+/**
+ * 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 $key String: 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 $key String: cache key
+ * @param $value Mixed: object to store
+ * @param $expire Int: 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 $key String: cache key
+ * @param $time Int: 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;
}
$this->mFile = "$dir/mw-cache-" . wfWikiID();
$this->mFile .= '.db';
+ wfDebug( __CLASS__.": using cache file {$this->mFile}\n" );
$this->mHandler = $handler;
}
if ( !is_string( $blob ) ) {
return array( null, 0 );
} else {
- return array(
+ return array(
unserialize( substr( $blob, 11 ) ),
intval( substr( $blob, 0, 10 ) )
);
function delete( $key, $time = 0 ) {
wfProfileIn( __METHOD__ );
+ wfDebug( __METHOD__."($key)\n" );
$handle = $this->getWriter();
if ( !$handle ) {
return false;
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