<?php
+/**
+ *
+ * @package MediaWiki
+ */
-# Message cache
-# Performs various useful MediaWiki namespace-related functions
-
-define( "MSG_LOAD_TIMEOUT", 60);
-define( "MSG_LOCK_TIMEOUT", 10);
-define( "MSG_WAIT_TIMEOUT", 10);
+/**
+ *
+ */
+define( 'MSG_LOAD_TIMEOUT', 60);
+define( 'MSG_LOCK_TIMEOUT', 10);
+define( 'MSG_WAIT_TIMEOUT', 10);
+/**
+ * Message cache
+ * Performs various useful MediaWiki namespace-related functions
+ *
+ * @package MediaWiki
+ */
class MessageCache
{
var $mCache, $mUseCache, $mDisable, $mExpiry;
var $mInitialised = false;
function initialise( &$memCached, $useDB, $expiry, $memcPrefix ) {
- $fname = "MessageCache::initialise";
+ $fname = 'MessageCache::initialise';
wfProfileIn( $fname );
$this->mUseCache = !is_null( $memCached );
$this->mMemc = &$memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
$this->mDisableTransform = false;
- $this->mMemcKey = "$memcPrefix:messages";
+ $this->mMemcKey = $memcPrefix.':messages';
$this->mKeys = false; # initialised on demand
$this->mInitialised = true;
- wfProfileIn( "$fname-parseropt" );
+ wfProfileIn( $fname.'-parseropt' );
$this->mParserOptions = ParserOptions::newFromUser( $u=NULL );
- wfProfileIn( "$fname-parseropt" );
- wfProfileOut( "$fname-parser" );
+ wfProfileOut( $fname.'-parseropt' );
+ wfProfileIn( $fname.'-parser' );
$this->mParser = new Parser;
- wfProfileOut( "$fname-parser" );
-
+ wfProfileOut( $fname.'-parser' );
+
$this->load();
wfProfileOut( $fname );
}
- # Loads messages either from memcached or the database, if not disabled
- # On error, quietly switches to a fallback mode
- # Returns false for a reportable error, true otherwise
+ /**
+ * Loads messages either from memcached or the database, if not disabled
+ * On error, quietly switches to a fallback mode
+ * Returns false for a reportable error, true otherwise
+ */
function load() {
global $wgAllMessagesEn;
-
+
if ( $this->mDisable ) {
wfDebug( "MessageCache::load(): disabled\n" );
return true;
}
- $fname = "MessageCache::load";
+ $fname = 'MessageCache::load';
wfProfileIn( $fname );
$success = true;
-
+
if ( $this->mUseCache ) {
- wfProfileIn( "$fname-fromcache" );
+ wfProfileIn( $fname.'-fromcache' );
$this->mCache = $this->mMemc->get( $this->mMemcKey );
- wfProfileOut( "$fname-fromcache" );
-
+ wfProfileOut( $fname.'-fromcache' );
+
# If there's nothing in memcached, load all the messages from the database
if ( !$this->mCache ) {
wfDebug( "MessageCache::load(): loading all messages\n" );
# Other threads don't need to load the messages if another thread is doing it.
$success = $this->mMemc->set( $this->mMemcKey, "loading", MSG_LOAD_TIMEOUT );
if ( $success ) {
- wfProfileIn( "$fname-load" );
+ wfProfileIn( $fname.'-load' );
$this->loadFromDB();
- wfProfileOut( "$fname-load" );
+ wfProfileOut( $fname.'-load' );
# Save in memcached
# Keep trying if it fails, this is kind of important
- wfProfileIn( "$fname-save" );
+ wfProfileIn( $fname.'-save' );
for ( $i=0; $i<20 && !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry ); $i++ ) {
usleep(mt_rand(500000,1500000));
}
- wfProfileOut( "$fname-save" );
+ wfProfileOut( $fname.'-save' );
if ( $i == 20 ) {
- $this->mMemc->set( $this->mMemcKey, "error", 86400 );
+ $this->mMemc->set( $this->mMemcKey, 'error', 86400 );
wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
}
}
$this->unlock();
}
-
+
if ( !is_array( $this->mCache ) ) {
wfMsg( "MessageCache::load(): individual message mode\n" );
# If it is 'loading' or 'error', switch to individual message mode, otherwise disable
- # Causing too much DB load, disabling -- TS
+ # Causing too much DB load, disabling -- TS
$this->mDisable = true;
/*
if ( $this->mCache == "loading" ) {
return $success;
}
- # Loads all cacheable messages from the database
- function loadFromDB()
- {
- $fname = "MessageCache::loadFromDB";
+ /**
+ * Loads all cacheable messages from the database
+ */
+ function loadFromDB() {
+ $fname = 'MessageCache::loadFromDB';
$dbr =& wfGetDB( DB_SLAVE );
- $res = $dbr->select( 'cur',
- array( 'cur_title', 'cur_text' ),
+ $res = $dbr->select( 'cur',
+ array( 'cur_title', 'cur_text' ),
array( 'cur_is_redirect' => 0, 'cur_namespace' => NS_MEDIAWIKI ),
$fname
);
-
+
$this->mCache = array();
for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
$this->mCache[$row->cur_title] = $row->cur_text;
$dbr->freeResult( $res );
}
-
- # Not really needed anymore
+
+ /**
+ * Not really needed anymore
+ */
function getKeys() {
global $wgAllMessagesEn, $wgLang;
if ( !$this->mKeys ) {
}
return $this->mKeys;
}
-
- # Obsolete
+
+ /**
+ * Obsolete
+ */
function isCacheable( $key ) {
return true;
/*
global $wgAllMessagesEn, $wgLang;
- return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
+ return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
array_key_exists( $key, $wgAllMessagesEn );
*/
}
$this->unlock();
}
- # Returns success
- # Represents a write lock on the messages key
+ /**
+ * Returns success
+ * Represents a write lock on the messages key
+ */
function lock() {
if ( !$this->mUseCache ) {
return true;
}
- $lockKey = $this->mMemcKey . "lock";
+ $lockKey = $this->mMemcKey . 'lock';
for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
sleep(1);
}
-
+
return $i >= MSG_WAIT_TIMEOUT;
}
-
+
function unlock() {
if ( !$this->mUseCache ) {
return;
}
- $lockKey = $this->mMemcKey . "lock";
+ $lockKey = $this->mMemcKey . 'lock';
$this->mMemc->delete( $lockKey );
}
-
+
function get( $key, $useDB ) {
global $wgLang, $wgLanguageCode;
-
+
# If uninitialised, someone is trying to call this halfway through Setup.php
if ( !$this->mInitialised ) {
return "<$key>";
}
-
+
$message = false;
- if ( !$this->mDisable ) {
+ if ( !$this->mDisable && $useDB ) {
$title = $wgLang->ucfirst( $key );
-
+
# Try the cache
if ( $this->mUseCache && $this->mCache && array_key_exists( $title, $this->mCache ) ) {
$message = $this->mCache[$title];
}
-
+
# If it wasn't in the cache, load each message from the DB individually
- if ( !$message && $useDB) {
+ if ( !$message ) {
$dbr =& wfGetDB( DB_SLAVE );
- $result = $dbr->getArray( "cur", array("cur_text"),
- array( "cur_namespace" => NS_MEDIAWIKI, "cur_title" => $title ),
- "MessageCache::get" );
+ $result = $dbr->getArray( 'cur', array('cur_text'),
+ array( 'cur_namespace' => NS_MEDIAWIKI, 'cur_title' => $title ),
+ 'MessageCache::get' );
if ( $result ) {
$message = $result->cur_text;
}
# Try the array in $wgLang
if ( !$message ) {
+ wfSuppressWarnings();
$message = $wgLang->getMessage( $key );
- }
+ wfRestoreWarnings();
+ }
# Try the English array
- if ( !$message && $wgLanguageCode != "en" ) {
+ if ( !$message && $wgLanguageCode != 'en' ) {
+ wfSuppressWarnings();
$message = Language::getMessage( $key );
+ wfRestoreWarnings();
}
-
+
# Final fallback
if ( !$message ) {
$message = "<$key>";
}
-
+
# Replace brace tags
$message = $this->transform( $message );
return $message;
}
function transform( $message ) {
- if( !$this->mDisableTransform ) {
- if ( strstr( $message, "{{" ) !== false ) {
+ if( !$this->mDisableTransform ) {
+ if ( strstr( $message, '{{' ) !== false ) {
$message = $this->mParser->transformMsg( $message, $this->mParserOptions );
}
}
return $message;
}
-
+
function disable() { $this->mDisable = true; }
function enable() { $this->mDisable = false; }
function disableTransform() { $this->mDisableTransform = true; }
+ function enableTransform() { $this->mDisableTransform = false; }
function addMessage( $key, $value ) {
$this->mExtensionMessages[$key] = $value;
$this->mExtensionMessages[$key] = $value;
}
}
-
- # Clear all stored messages. Mainly used after a mass rebuild.
+
+ /**
+ * Clear all stored messages. Mainly used after a mass rebuild.
+ */
function clear() {
if( $this->mUseCache ) {
$this->mMemc->delete( $this->mMemcKey );
dépôts / lhc / web / wiklou.git / blobdiff