10 define( 'MSG_LOAD_TIMEOUT', 60);
11 define( 'MSG_LOCK_TIMEOUT', 10);
12 define( 'MSG_WAIT_TIMEOUT', 10);
13 define( 'MSG_CACHE_VERSION', 1 );
17 * Performs various MediaWiki namespace-related functions
21 // Holds loaded messages that are defined in MediaWiki namespace.
24 var $mUseCache, $mDisable, $mExpiry;
25 var $mKeys, $mParserOptions, $mParser;
27 // Variable for tracking which variables are loaded
28 var $mLoadedLanguages = array();
30 function __construct( &$memCached, $useDB, $expiry, /*ignored*/ $memcPrefix ) {
31 $this->mUseCache = !is_null( $memCached );
32 $this->mMemc = &$memCached;
33 $this->mDisable = !$useDB;
34 $this->mExpiry = $expiry;
35 $this->mDisableTransform = false;
36 $this->mKeys = false; # initialised on demand
37 $this->mParser = null;
42 * ParserOptions is lazy initialised.
44 function getParserOptions() {
45 if ( !$this->mParserOptions ) {
46 $this->mParserOptions = new ParserOptions;
48 return $this->mParserOptions;
52 * Try to load the cache from a local file.
53 * Actual format of the file depends on the $wgLocalMessageCacheSerialized
56 * @param $hash String: the hash of contents, to check validity.
57 * @param $code Mixed: Optional language code, see documenation of load().
58 * @return false on failure.
60 function loadFromLocal( $hash, $code ) {
61 global $wgCacheDirectory, $wgLocalMessageCacheSerialized;
63 $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
65 # Check file existence
67 $file = fopen( $filename, 'r' );
70 return false; // No cache file
73 if ( $wgLocalMessageCacheSerialized ) {
74 // Check to see if the file has the hash specified
75 $localHash = fread( $file, 32 );
76 if ( $hash === $localHash ) {
77 // All good, get the rest of it
79 while ( !feof( $file ) ) {
80 $serialized .= fread( $file, 100000 );
83 return $this->setCache( unserialize( $serialized ), $code );
86 return false; // Wrong hash
89 $localHash=substr(fread($file,40),8);
91 if ($hash!=$localHash) {
92 return false; // Wrong hash
95 # Require overwrites the member variable or just shadows it?
97 return $this->setCache( $this->mCache, $code );
102 * Save the cache to a local file.
104 function saveToLocal( $serialized, $hash, $code ) {
105 global $wgCacheDirectory;
107 $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
108 wfMkdirParents( $wgCacheDirectory ); // might fail
110 wfSuppressWarnings();
111 $file = fopen( $filename, 'w' );
115 wfDebug( "Unable to open local cache file for writing\n" );
119 fwrite( $file, $hash . $serialized );
121 @chmod( $filename, 0666 );
124 function saveToScript( $array, $hash, $code ) {
125 global $wgCacheDirectory;
127 $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
128 $tempFilename = $filename . '.tmp';
129 wfMkdirParents( $wgCacheDirectory ); // might fail
131 wfSuppressWarnings();
132 $file = fopen( $tempFilename, 'w');
136 wfDebug( "Unable to open local cache file for writing\n" );
140 fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
142 foreach ($array as $key => $message) {
143 $key = $this->escapeForScript($key);
144 $messages = $this->escapeForScript($message);
145 fwrite($file, "'$key' => '$message',\n");
148 fwrite($file,");\n?>");
150 rename($tempFilename, $filename);
153 function escapeForScript($string) {
154 $string = str_replace( '\\', '\\\\', $string );
155 $string = str_replace( '\'', '\\\'', $string );
160 * Set the cache to $cache, if it is valid. Otherwise set the cache to false.
162 function setCache( $cache, $code ) {
163 if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) {
164 $this->mCache[$code] = $cache;
172 * Loads messages from caches or from database in this order:
173 * (1) local message cache (if $wgUseLocalMessageCache is enabled)
175 * (3) from the database.
177 * When succesfully loading from (2) or (3), all higher level caches are
178 * updated for the newest version.
180 * Nothing is loaded if member variable mDisabled is true, either manually
181 * set by calling code or if message loading fails (is this possible?).
183 * Returns true if cache is already populated or it was succesfully populated,
184 * or false if populating empty cache fails. Also returns true if MessageCache
187 * @param $code String: language to which load messages
189 function load( $code = false ) {
190 global $wgUseLocalMessageCache;
192 if ( !$this->mUseCache ) {
196 if( !is_string( $code ) ) {
197 # This isn't really nice, so at least make a note about it and try to
199 wfDebug( __METHOD__ . " called without providing a language code\n" );
203 # Don't do double loading...
204 if ( isset($this->mLoadedLanguages[$code]) ) return true;
206 # 8 lines of code just to say (once) that message cache is disabled
207 if ( $this->mDisable ) {
208 static $shownDisabled = false;
209 if ( !$shownDisabled ) {
210 wfDebug( __METHOD__ . ": disabled\n" );
211 $shownDisabled = true;
216 # Loading code starts
217 wfProfileIn( __METHOD__ );
218 $success = false; # Keep track of success
219 $where = array(); # Debug info, delayed to avoid spamming debug log too much
220 $cacheKey = wfMemcKey( 'messages', $code ); # Key in memc for messages
224 # Hash of the contents is stored in memcache, to detect if local cache goes
225 # out of date (due to update in other thread?)
226 if ( $wgUseLocalMessageCache ) {
227 wfProfileIn( __METHOD__ . '-fromlocal' );
229 $hash = $this->mMemc->get( wfMemcKey( 'messages', $code, 'hash' ) );
231 $success = $this->loadFromLocal( $hash, $code );
232 if ( $success ) $where[] = 'got from local cache';
234 wfProfileOut( __METHOD__ . '-fromlocal' );
238 # Fails if nothing in cache, or in the wrong version.
240 wfProfileIn( __METHOD__ . '-fromcache' );
241 $cache = $this->mMemc->get( $cacheKey );
242 $success = $this->setCache( $cache, $code );
244 $where[] = 'got from global cache';
245 $this->saveToCaches( $cache, false, $code );
247 wfProfileOut( __METHOD__ . '-fromcache' );
252 # Nothing in caches... so we need create one and store it in caches
254 $where[] = 'cache is empty';
255 $where[] = 'loading from database';
257 $this->lock($cacheKey);
259 # Limit the concurrency of loadFromDB to a single process
260 # This prevents the site from going down when the cache expires
261 $statusKey = wfMemcKey( 'messages', $code, 'status' );
262 $success = $this->mMemc->add( $statusKey, 'loading', MSG_LOAD_TIMEOUT );
264 $cache = $this->loadFromDB( $code );
265 $success = $this->setCache( $cache, $code );
268 $success = $this->saveToCaches( $cache, true, $code );
270 $this->mMemc->delete( $statusKey );
272 $this->mMemc->set( $statusKey, 'error', 60*5 );
273 wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
276 $this->unlock($cacheKey);
280 # Bad luck... this should not happen
281 $where[] = 'loading FAILED - cache is disabled';
282 $info = implode( ', ', $where );
283 wfDebug( __METHOD__ . ": Loading $code... $info\n" );
284 $this->mDisable = true;
285 $this->mCache = false;
287 # All good, just record the success
288 $info = implode( ', ', $where );
289 wfDebug( __METHOD__ . ": Loading $code... $info\n" );
290 $this->mLoadedLanguages[$code] = true;
292 wfProfileOut( __METHOD__ );
297 * Loads cacheable messages from the database. Messages bigger than
298 * $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded
299 * on-demand from the database later.
301 * @param $code Optional language code, see documenation of load().
302 * @return Array: Loaded messages for storing in caches.
304 function loadFromDB( $code = false ) {
305 wfProfileIn( __METHOD__ );
306 global $wgMaxMsgCacheEntrySize, $wgContLanguageCode;
307 $dbr = wfGetDB( DB_SLAVE );
312 'page_is_redirect' => 0,
313 'page_namespace' => NS_MEDIAWIKI,
317 # Is this fast enough. Should not matter if the filtering is done in the
318 # database or in code.
319 if ( $code !== $wgContLanguageCode ) {
320 # Messages for particular language
321 $conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), "/$code" );
323 # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
324 # other than language code.
325 $conds[] = 'page_title NOT' . $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
329 # Conditions to fetch oversized pages to ignore them
331 $bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize );
333 # Load titles for all oversized pages in the MediaWiki namespace
334 $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ );
335 while ( $row = $dbr->fetchObject( $res ) ) {
336 $cache[$row->page_title] = '!TOO BIG';
338 $dbr->freeResult( $res );
340 # Conditions to load the remaining pages with their contents
341 $smallConds = $conds;
342 $smallConds[] = 'page_latest=rev_id';
343 $smallConds[] = 'rev_text_id=old_id';
344 $smallConds[] = 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize );
346 $res = $dbr->select( array( 'page', 'revision', 'text' ),
347 array( 'page_title', 'old_text', 'old_flags' ),
348 $smallConds, __METHOD__. "($code)" );
350 for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
351 $cache[$row->page_title] = ' ' . Revision::getRevisionText( $row );
353 $dbr->freeResult( $res );
355 $cache['VERSION'] = MSG_CACHE_VERSION;
356 wfProfileOut( __METHOD__ );
361 * Updates cache as necessary when message page is changed
363 * @param $title String: name of the page changed.
364 * @param $text Mixed: new contents of the page.
366 public function replace( $title, $text ) {
367 global $wgMaxMsgCacheEntrySize;
368 wfProfileIn( __METHOD__ );
371 list( , $code ) = $this->figureMessage( $title );
373 $cacheKey = wfMemcKey( 'messages', $code );
375 $this->lock($cacheKey);
377 if ( is_array($this->mCache[$code]) ) {
378 $titleKey = wfMemcKey( 'messages', 'individual', $title );
380 if ( $text === false ) {
381 # Article was deleted
382 unset( $this->mCache[$code][$title] );
383 $this->mMemc->delete( $titleKey );
385 } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
387 $this->mCache[$code][$title] = '!TOO BIG';
388 $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
391 $this->mCache[$code][$title] = ' ' . $text;
392 $this->mMemc->delete( $titleKey );
396 $this->saveToCaches( $this->mCache[$code], true, $code );
398 $this->unlock($cacheKey);
400 // Also delete cached sidebar... just in case it is affected
402 $codes = array( $code );
403 if ( $code === 'en' ) {
404 // Delete all sidebars, like for example on action=purge on the
406 $codes = array_keys( Language::getLanguageNames() );
409 foreach ( $codes as $code ) {
410 $sidebarKey = wfMemcKey( 'sidebar', $code );
411 $parserMemc->delete( $sidebarKey );
414 wfRunHooks( "MessageCacheReplace", array( $title, $text ) );
416 wfProfileOut( __METHOD__ );
420 * Shortcut to update caches.
422 * @param $cache Array: cached messages with a version.
423 * @param $cacheKey String: Identifier for the cache.
424 * @param $memc Bool: Wether to update or not memcache.
425 * @param $code String: Language code.
426 * @return False on somekind of error.
428 protected function saveToCaches( $cache, $memc = true, $code = false ) {
429 wfProfileIn( __METHOD__ );
430 global $wgUseLocalMessageCache, $wgLocalMessageCacheSerialized;
432 $cacheKey = wfMemcKey( 'messages', $code );
435 $success = $this->mMemc->set( $cacheKey, $cache, $this->mExpiry );
440 # Save to local cache
441 if ( $wgUseLocalMessageCache ) {
442 $serialized = serialize( $cache );
443 $hash = md5( $serialized );
444 $this->mMemc->set( wfMemcKey( 'messages', $code, 'hash' ), $hash, $this->mExpiry );
445 if ($wgLocalMessageCacheSerialized) {
446 $this->saveToLocal( $serialized, $hash, $code );
448 $this->saveToScript( $cache, $hash, $code );
452 wfProfileOut( __METHOD__ );
458 * Represents a write lock on the messages key
460 function lock($key) {
461 if ( !$this->mUseCache ) {
465 $lockKey = $key . ':lock';
466 for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
470 return $i >= MSG_WAIT_TIMEOUT;
473 function unlock($key) {
474 if ( !$this->mUseCache ) {
478 $lockKey = $key . ':lock';
479 $this->mMemc->delete( $lockKey );
483 * Get a message from either the content language or the user language.
485 * @param string $key The message cache key
486 * @param bool $useDB Get the message from the DB, false to use only the localisation
487 * @param string $langcode Code of the language to get the message for, if
488 * it is a valid code create a language for that
489 * language, if it is a string but not a valid code
490 * then make a basic language object, if it is a
491 * false boolean then use the current users
492 * language (as a fallback for the old parameter
493 * functionality), or if it is a true boolean then
494 * use the wikis content language (also as a
496 * @param bool $isFullKey Specifies whether $key is a two part key "msg/lang".
498 function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
499 global $wgContLanguageCode, $wgContLang;
501 if ( strval( $key ) === '' ) {
502 # Shortcut: the empty key is always missing
506 $lang = wfGetLangObj( $langcode );
507 $langcode = $lang->getCode();
511 # Normalise title-case input (with some inlining)
512 $lckey = str_replace( ' ', '_', $key );
513 if ( ord( $key ) < 128 ) {
514 $lckey[0] = strtolower( $lckey[0] );
515 $uckey = ucfirst( $lckey );
517 $lckey = $wgContLang->lcfirst( $lckey );
518 $uckey = $wgContLang->ucfirst( $lckey );
521 # Try the MediaWiki namespace
522 if( !$this->mDisable && $useDB ) {
524 if(!$isFullKey && ( $langcode != $wgContLanguageCode ) ) {
525 $title .= '/' . $langcode;
527 $message = $this->getMsgFromNamespace( $title, $langcode );
530 # Try the array in the language object
531 if ( $message === false ) {
532 $message = $lang->getMessage( $lckey );
533 if ( is_null( $message ) ) {
538 # Try the array of another language
539 if( $message === false ) {
540 $parts = explode( '/', $lckey );
541 # We may get calls for things that are http-urls from sidebar
542 # Let's not load nonexistent languages for those
543 # They usually have more than one slash.
544 if ( count( $parts ) == 2 && $parts[1] !== '' ) {
545 $message = Language::getMessageFor( $parts[0], $parts[1] );
546 if ( is_null( $message ) ) {
552 # Is this a custom message? Try the default language in the db...
553 if( ($message === false || $message === '-' ) &&
554 !$this->mDisable && $useDB &&
555 !$isFullKey && ($langcode != $wgContLanguageCode) ) {
556 $message = $this->getMsgFromNamespace( $uckey, $wgContLanguageCode );
560 if( $message === false ) {
561 return '<' . htmlspecialchars($key) . '>';
565 $message = strtr( $message,
567 # Fix for trailing whitespace, removed by textarea
569 # Fix for NBSP, converted to space by firefox
570 ' ' => "\xc2\xa0",
577 * Get a message from the MediaWiki namespace, with caching. The key must
578 * first be converted to two-part lang/msg form if necessary.
580 * @param $title String: Message cache key with initial uppercase letter.
581 * @param $code String: code denoting the language to try.
583 function getMsgFromNamespace( $title, $code ) {
587 if ( $this->mUseCache ) {
588 $this->load( $code );
589 if (isset( $this->mCache[$code][$title] ) ) {
590 $entry = $this->mCache[$code][$title];
591 $type = substr( $entry, 0, 1 );
592 if ( $type == ' ' ) {
593 return substr( $entry, 1 );
598 # Call message hooks, in case they are defined
599 wfRunHooks('MessagesPreLoad', array( $title, &$message ) );
600 if ( $message !== false ) {
604 # If there is no cache entry and no placeholder, it doesn't exist
605 if ( $type !== '!' ) {
609 $titleKey = wfMemcKey( 'messages', 'individual', $title );
611 # Try the individual message cache
612 if ( $this->mUseCache ) {
613 $entry = $this->mMemc->get( $titleKey );
615 $type = substr( $entry, 0, 1 );
617 if ( $type === ' ' ) {
619 $message = substr( $entry, 1 );
620 $this->mCache[$code][$title] = $entry;
622 } elseif ( $entry === '!NONEXISTENT' ) {
625 # Corrupt/obsolete entry, delete it
626 $this->mMemc->delete( $titleKey );
632 # Try loading it from the DB
633 $revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
635 $message = $revision->getText();
636 if ($this->mUseCache) {
637 $this->mCache[$code][$title] = ' ' . $message;
638 $this->mMemc->set( $titleKey, ' ' . $message, $this->mExpiry );
642 # Use some special text instead of false, because false gets converted to '' somewhere
643 $this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry );
644 $this->mCache[$code][$title] = false;
649 function transform( $message, $interface = false, $language = null ) {
650 // Avoid creating parser if nothing to transform
651 if( strpos( $message, '{{' ) === false ) {
655 global $wgParser, $wgParserConf;
656 if ( !$this->mParser && isset( $wgParser ) ) {
657 # Do some initialisation so that we don't have to do it twice
658 $wgParser->firstCallInit();
659 # Clone it and store it
660 $class = $wgParserConf['class'];
661 if ( $class == 'Parser_DiffTest' ) {
663 $this->mParser = new $class( $wgParserConf );
665 $this->mParser = clone $wgParser;
667 #wfDebug( __METHOD__ . ": following contents triggered transform: $message\n" );
669 if ( $this->mParser ) {
670 $popts = $this->getParserOptions();
671 $popts->setInterfaceMessage( $interface );
672 $popts->setTargetLanguage( $language );
673 $message = $this->mParser->transformMsg( $message, $popts );
678 function disable() { $this->mDisable = true; }
679 function enable() { $this->mDisable = false; }
682 function disableTransform(){
683 wfDeprecated( __METHOD__ );
685 function enableTransform() {
686 wfDeprecated( __METHOD__ );
688 function setTransform( $x ) {
689 wfDeprecated( __METHOD__ );
691 function getTransform() {
692 wfDeprecated( __METHOD__ );
697 * Clear all stored messages. Mainly used after a mass rebuild.
700 if( $this->mUseCache ) {
701 $langs = Language::getLanguageNames( false );
702 foreach ( array_keys($langs) as $code ) {
704 $this->mMemc->delete( wfMemcKey( 'messages', $code ) );
705 # Invalidate all local caches
706 $this->mMemc->delete( wfMemcKey( 'messages', $code, 'hash' ) );
712 * Add a message to the cache
713 * @deprecated Use $wgExtensionMessagesFiles
716 * @param mixed $value
717 * @param string $lang The messages language, English by default
719 function addMessage( $key, $value, $lang = 'en' ) {
720 wfDeprecated( __METHOD__ );
721 $lc = Language::getLocalisationCache();
722 $lc->addLegacyMessages( array( $lang => array( $key => $value ) ) );
726 * Add an associative array of message to the cache
727 * @deprecated Use $wgExtensionMessagesFiles
729 * @param array $messages An associative array of key => values to be added
730 * @param string $lang The messages language, English by default
732 function addMessages( $messages, $lang = 'en' ) {
733 wfDeprecated( __METHOD__ );
734 $lc = Language::getLocalisationCache();
735 $lc->addLegacyMessages( array( $lang => $messages ) );
739 * Add a 2-D array of messages by lang. Useful for extensions.
740 * @deprecated Use $wgExtensionMessagesFiles
742 * @param array $messages The array to be added
744 function addMessagesByLang( $messages ) {
745 wfDeprecated( __METHOD__ );
746 $lc = Language::getLocalisationCache();
747 $lc->addLegacyMessages( $messages );
751 * Set a hook for addMessagesByLang()
753 function setExtensionMessagesHook( $callback ) {
754 $this->mAddMessagesHook = $callback;
760 function loadAllMessages( $lang = false ) {
766 function loadMessagesFile( $filename, $langcode = false ) {
769 public function figureMessage( $key ) {
770 global $wgContLanguageCode;
771 $pieces = explode( '/', $key );
772 if( count( $pieces ) < 2 )
773 return array( $key, $wgContLanguageCode );
775 $lang = array_pop( $pieces );
776 $validCodes = Language::getLanguageNames();
777 if( !array_key_exists( $lang, $validCodes ) )
778 return array( $key, $wgContLanguageCode );
780 $message = implode( '/', $pieces );
781 return array( $message, $lang );