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 cacheable messages from the database
122 function loadFromDB() {
123 $fname = 'MessageCache::loadFromDB';
124 $dbr =& wfGetDB( DB_SLAVE
);
125 $res = $dbr->select( 'cur',
126 array( 'cur_title', 'cur_text' ),
127 array( 'cur_is_redirect' => 0, 'cur_namespace' => NS_MEDIAWIKI
),
131 $this->mCache
= array();
132 for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
133 $this->mCache
[$row->cur_title
] = $row->cur_text
;
136 $dbr->freeResult( $res );
140 * Not really needed anymore
143 global $wgAllMessagesEn, $wgContLang;
144 if ( !$this->mKeys
) {
145 $this->mKeys
= array();
146 foreach ( $wgAllMessagesEn as $key => $value ) {
147 array_push( $this->mKeys
, $wgContLang->ucfirst( $key ) );
156 function isCacheable( $key ) {
159 global $wgAllMessagesEn, $wgLang;
160 return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
161 array_key_exists( $key, $wgAllMessagesEn );
165 function replace( $title, $text ) {
168 if ( is_array( $this->mCache
) ) {
169 $this->mCache
[$title] = $text;
170 $this->mMemc
->set( $this->mMemcKey
, $this->mCache
, $this->mExpiry
);
177 * Represents a write lock on the messages key
180 if ( !$this->mUseCache
) {
184 $lockKey = $this->mMemcKey
. 'lock';
185 for ($i=0; $i < MSG_WAIT_TIMEOUT
&& !$this->mMemc
->add( $lockKey, 1, MSG_LOCK_TIMEOUT
); $i++
) {
189 return $i >= MSG_WAIT_TIMEOUT
;
193 if ( !$this->mUseCache
) {
197 $lockKey = $this->mMemcKey
. 'lock';
198 $this->mMemc
->delete( $lockKey );
201 function get( $key, $useDB, $forcontent=true ) {
203 global $wgContLang, $wgContLanguageCode;
205 $langcode = $wgContLanguageCode;
208 global $wgLang, $wgLanguageCode;
210 $langcode = $wgLanguageCode;
212 # If uninitialised, someone is trying to call this halfway through Setup.php
213 if ( !$this->mInitialised
) {
214 return "<$key>";
218 if ( !$this->mDisable
&& $useDB ) {
219 $title = $lang->ucfirst( $key )."/$langcode";
223 if ( $this->mUseCache
&& $this->mCache
&& array_key_exists( $title, $this->mCache
) ) {
224 $message = $this->mCache
[$title];
227 # If it wasn't in the cache, load each message from the DB individually
229 $dbr =& wfGetDB( DB_SLAVE
);
230 $result = $dbr->getArray( 'cur', array('cur_text'),
231 array( 'cur_namespace' => NS_MEDIAWIKI
, 'cur_title' => $title ),
232 'MessageCache::get' );
234 $message = $result->cur_text
;
238 # Try the extension array
240 $message = @$this->mExtensionMessages
[$key];
243 # Try the array in the language object
245 wfSuppressWarnings();
246 $message = $lang->getMessage( $key );
250 # Try the English array
251 if ( !$message && $langcode != 'en' ) {
252 wfSuppressWarnings();
253 $message = Language
::getMessage( $key );
259 $message = "<$key>";
263 $message = $this->transform( $message );
267 function transform( $message ) {
268 if( !$this->mDisableTransform
) {
269 if ( strstr( $message, '{{' ) !== false ) {
270 $message = $this->mParser
->transformMsg( $message, $this->mParserOptions
);
276 function disable() { $this->mDisable
= true; }
277 function enable() { $this->mDisable
= false; }
278 function disableTransform() { $this->mDisableTransform
= true; }
279 function enableTransform() { $this->mDisableTransform
= false; }
281 function addMessage( $key, $value ) {
282 $this->mExtensionMessages
[$key] = $value;
285 function addMessages( $messages ) {
286 foreach ( $messages as $key => $value ) {
287 $this->mExtensionMessages
[$key] = $value;
292 * Clear all stored messages. Mainly used after a mass rebuild.
295 if( $this->mUseCache
) {
296 $this->mMemc
->delete( $this->mMemcKey
);