10 define( 'MSG_LOAD_TIMEOUT', 60);
11 define( 'MSG_LOCK_TIMEOUT', 10);
12 define( 'MSG_WAIT_TIMEOUT', 10);
16 * Performs various useful MediaWiki namespace-related functions
22 var $mCache, $mUseCache, $mDisable, $mExpiry;
23 var $mMemcKey, $mKeys, $mParserOptions, $mParser;
24 var $mExtensionMessages;
25 var $mInitialised = false;
27 function initialise( &$memCached, $useDB, $expiry, $memcPrefix) {
28 $fname = 'MessageCache::initialise';
29 wfProfileIn( $fname );
31 $this->mUseCache
= !is_null( $memCached );
32 $this->mMemc
= &$memCached;
33 $this->mDisable
= !$useDB;
34 $this->mExpiry
= $expiry;
35 $this->mDisableTransform
= false;
36 $this->mMemcKey
= $memcPrefix.':messages';
37 $this->mKeys
= false; # initialised on demand
38 $this->mInitialised
= true;
40 wfProfileIn( $fname.'-parseropt' );
41 $this->mParserOptions
= ParserOptions
::newFromUser( $u=NULL );
42 wfProfileOut( $fname.'-parseropt' );
43 wfProfileIn( $fname.'-parser' );
44 $this->mParser
= new Parser
;
45 wfProfileOut( $fname.'-parser' );
48 wfProfileOut( $fname );
52 * Loads messages either from memcached or the database, if not disabled
53 * On error, quietly switches to a fallback mode
54 * Returns false for a reportable error, true otherwise
57 global $wgAllMessagesEn;
59 if ( $this->mDisable
) {
60 wfDebug( "MessageCache::load(): disabled\n" );
63 $fname = 'MessageCache::load';
64 wfProfileIn( $fname );
67 if ( $this->mUseCache
) {
68 wfProfileIn( $fname.'-fromcache' );
69 $this->mCache
= $this->mMemc
->get( $this->mMemcKey
);
70 wfProfileOut( $fname.'-fromcache' );
72 # If there's nothing in memcached, load all the messages from the database
73 if ( !$this->mCache
) {
74 wfDebug( "MessageCache::load(): loading all messages\n" );
76 # Other threads don't need to load the messages if another thread is doing it.
77 $success = $this->mMemc
->set( $this->mMemcKey
, "loading", MSG_LOAD_TIMEOUT
);
79 wfProfileIn( $fname.'-load' );
81 wfProfileOut( $fname.'-load' );
83 # Keep trying if it fails, this is kind of important
84 wfProfileIn( $fname.'-save' );
85 for ( $i=0; $i<20 && !$this->mMemc
->set( $this->mMemcKey
, $this->mCache
, $this->mExpiry
); $i++
) {
86 usleep(mt_rand(500000,1500000));
88 wfProfileOut( $fname.'-save' );
90 $this->mMemc
->set( $this->mMemcKey
, 'error', 86400 );
91 wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
97 if ( !is_array( $this->mCache
) ) {
98 wfMsg( "MessageCache::load(): individual message mode\n" );
99 # If it is 'loading' or 'error', switch to individual message mode, otherwise disable
100 # Causing too much DB load, disabling -- TS
101 $this->mDisable
= true;
103 if ( $this->mCache == "loading" ) {
104 $this->mUseCache = false;
105 } elseif ( $this->mCache == "error" ) {
106 $this->mUseCache = false;
109 $this->mDisable = true;
112 $this->mCache
= false;
115 wfProfileOut( $fname );
120 * Loads all or main part of cacheable messages from the database
122 function loadFromDB() {
123 global $wgPartialMessageCache;
124 $fname = 'MessageCache::loadFromDB';
125 $dbr =& wfGetDB( DB_SLAVE
);
126 $conditions = array( 'cur_is_redirect' => 0,
127 'cur_namespace' => NS_MEDIAWIKI
);
128 if ($wgPartialMessageCache) {
129 if (is_array($wgPartialMessageCache)) {
130 $conditions['cur_title']=$wgPartialMessageCache;
132 require_once("MessageCacheHints.php");
133 $conditions['cur_title']=MessageCacheHints
::get();
136 $res = $dbr->select( 'cur',
137 array( 'cur_title', 'cur_text' ), $conditions, $fname);
139 $this->mCache
= array();
140 for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
141 $this->mCache
[$row->cur_title
] = $row->cur_text
;
144 $dbr->freeResult( $res );
148 * Not really needed anymore
151 global $wgAllMessagesEn, $wgContLang;
152 if ( !$this->mKeys
) {
153 $this->mKeys
= array();
154 foreach ( $wgAllMessagesEn as $key => $value ) {
155 array_push( $this->mKeys
, $wgContLang->ucfirst( $key ) );
164 function isCacheable( $key ) {
167 global $wgAllMessagesEn, $wgLang;
168 return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
169 array_key_exists( $key, $wgAllMessagesEn );
173 function replace( $title, $text ) {
176 if ( is_array( $this->mCache
) ) {
177 $this->mCache
[$title] = $text;
178 $this->mMemc
->set( $this->mMemcKey
, $this->mCache
, $this->mExpiry
);
185 * Represents a write lock on the messages key
188 if ( !$this->mUseCache
) {
192 $lockKey = $this->mMemcKey
. 'lock';
193 for ($i=0; $i < MSG_WAIT_TIMEOUT
&& !$this->mMemc
->add( $lockKey, 1, MSG_LOCK_TIMEOUT
); $i++
) {
197 return $i >= MSG_WAIT_TIMEOUT
;
201 if ( !$this->mUseCache
) {
205 $lockKey = $this->mMemcKey
. 'lock';
206 $this->mMemc
->delete( $lockKey );
209 function get( $key, $useDB, $forcontent=true ) {
211 global $wgContLang, $wgContLanguageCode;
213 $langcode = $wgContLanguageCode;
216 global $wgLang, $wgLanguageCode;
218 $langcode = $wgLanguageCode;
220 # If uninitialised, someone is trying to call this halfway through Setup.php
221 if ( !$this->mInitialised
) {
222 return "<$key>";
226 if ( !$this->mDisable
&& $useDB ) {
227 $title = $lang->ucfirst( $key )."/$langcode";
231 if ( $this->mUseCache
&& $this->mCache
&& array_key_exists( $title, $this->mCache
) ) {
232 $message = $this->mCache
[$title];
235 if ( !$message && $this->mUseCache
) {
236 $message = $this->mMemc
->get($this->mMemcKey
.':'.$title);
238 $this->mCache
[$title]=$message;
242 # If it wasn't in the cache, load each message from the DB individually
244 $dbr =& wfGetDB( DB_SLAVE
);
245 $result = $dbr->getArray( 'cur', array('cur_text'),
246 array( 'cur_namespace' => NS_MEDIAWIKI
, 'cur_title' => $title ),
247 'MessageCache::get' );
249 $message = $result->cur_text
;
250 if ($this->mUseCache
) {
251 $this->mCache
[$title]=$message;
252 /* individual messages may be often
253 recached until proper purge code exists
255 $this->mMemc
->set($this->mMemcKey
.':'.$title,$message,300);
260 # Try the extension array
262 $message = @$this->mExtensionMessages
[$key];
265 # Try the array in the language object
267 wfSuppressWarnings();
268 $message = $lang->getMessage( $key );
272 # Try the English array
273 if ( !$message && $langcode != 'en' ) {
274 wfSuppressWarnings();
275 $message = Language
::getMessage( $key );
281 $message = "<$key>";
285 $message = $this->transform( $message );
289 function transform( $message ) {
290 if( !$this->mDisableTransform
) {
291 if ( strstr( $message, '{{' ) !== false ) {
292 $message = $this->mParser
->transformMsg( $message, $this->mParserOptions
);
298 function disable() { $this->mDisable
= true; }
299 function enable() { $this->mDisable
= false; }
300 function disableTransform() { $this->mDisableTransform
= true; }
301 function enableTransform() { $this->mDisableTransform
= false; }
303 function addMessage( $key, $value ) {
304 $this->mExtensionMessages
[$key] = $value;
307 function addMessages( $messages ) {
308 foreach ( $messages as $key => $value ) {
309 $this->mExtensionMessages
[$key] = $value;
314 * Clear all stored messages. Mainly used after a mass rebuild.
317 if( $this->mUseCache
) {
318 $this->mMemc
->delete( $this->mMemcKey
);