includes/MessageCache.php

   1 <?php
   2 /**
   3  *
   4  * @addtogroup Cache
   5  */
   6
   7 /**
   8  *
   9  */
  10 define( 'MSG_LOAD_TIMEOUT', 60);
  11 define( 'MSG_LOCK_TIMEOUT', 10);
  12 define( 'MSG_WAIT_TIMEOUT', 10);
  13 define( 'MSG_CACHE_VERSION', 1 );
  14
  15 /**
  16  * Message cache
  17  * Performs various MediaWiki namespace-related functions
  18  *
  19  */
  20 class MessageCache {
  21         var $mCache, $mUseCache, $mDisable, $mExpiry;
  22         var $mMemcKey, $mKeys, $mParserOptions, $mParser;
  23         var $mExtensionMessages = array();
  24         var $mInitialised = false;
  25         var $mDeferred = true;
  26         var $mAllMessagesLoaded;
  27
  28         function __construct( &$memCached, $useDB, $expiry, $memcPrefix) {
  29                 wfProfileIn( __METHOD__ );
  30
  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;
  39                 $this->mParser = null;
  40
  41                 # When we first get asked for a message,
  42                 # then we'll fill up the cache. If we
  43                 # can return a cache hit, this saves
  44                 # some extra milliseconds
  45                 $this->mDeferred = true;
  46
  47                 wfProfileOut( __METHOD__ );
  48         }
  49
  50         function getParserOptions() {
  51                 if ( !$this->mParserOptions ) {
  52                         $this->mParserOptions = new ParserOptions;
  53                 }
  54                 return $this->mParserOptions;
  55         }
  56
  57         /**
  58          * Try to load the cache from a local file
  59          */
  60         function loadFromLocal( $hash ) {
  61                 global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
  62
  63                 if ( $wgLocalMessageCache === false ) {
  64                         return;
  65                 }
  66
  67                 $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
  68
  69                 wfSuppressWarnings();
  70                 $file = fopen( $filename, 'r' );
  71                 wfRestoreWarnings();
  72                 if ( !$file ) {
  73                         return;
  74                 }
  75
  76                 if ( $wgLocalMessageCacheSerialized ) {
  77                         // Check to see if the file has the hash specified
  78                         $localHash = fread( $file, 32 );
  79                         if ( $hash === $localHash ) {
  80                                 // All good, get the rest of it
  81                                 $serialized = '';
  82                                 while ( !feof( $file ) ) {
  83                                         $serialized .= fread( $file, 100000 );
  84                                 }
  85                                 $this->setCache( unserialize( $serialized ) );
  86                         }
  87                         fclose( $file );
  88                 } else {
  89                         $localHash=substr(fread($file,40),8);
  90                         fclose($file);
  91                         if ($hash!=$localHash) {
  92                                 return;
  93                         }
  94
  95                         require("$wgLocalMessageCache/messages-" . wfWikiID());
  96                         $this->setCache( $this->mCache);
  97                 }
  98         }
  99
 100         /**
 101          * Save the cache to a local file
 102          */
 103         function saveToLocal( $serialized, $hash ) {
 104                 global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
 105
 106                 if ( $wgLocalMessageCache === false ) {
 107                         return;
 108                 }
 109
 110                 $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
 111                 $oldUmask = umask( 0 );
 112                 wfMkdirParents( $wgLocalMessageCache, 0777 );
 113                 umask( $oldUmask );
 114
 115                 $file = fopen( $filename, 'w' );
 116                 if ( !$file ) {
 117                         wfDebug( "Unable to open local cache file for writing\n" );
 118                         return;
 119                 }
 120
 121                 fwrite( $file, $hash . $serialized );
 122                 fclose( $file );
 123                 @chmod( $filename, 0666 );
 124         }
 125
 126         function loadFromScript( $hash ) {
 127                 wfDeprecated( __METHOD__ );
 128                 $this->loadFromLocal( $hash );
 129         }
 130
 131         function saveToScript($array, $hash) {
 132                 global $wgLocalMessageCache;
 133                 if ( $wgLocalMessageCache === false ) {
 134                         return;
 135                 }
 136
 137                 $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
 138                 $oldUmask = umask( 0 );
 139                 wfMkdirParents( $wgLocalMessageCache, 0777 );
 140                 umask( $oldUmask );
 141                 $file = fopen( $filename.'.tmp', 'w');
 142                 fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
 143
 144                 foreach ($array as $key => $message) {
 145                         fwrite($file, "'". $this->escapeForScript($key).
 146                                 "' => '" . $this->escapeForScript($message).
 147                                 "',\n");
 148                 }
 149                 fwrite($file,");\n?>");
 150                 fclose($file);
 151                 rename($filename.'.tmp',$filename);
 152         }
 153
 154         function escapeForScript($string) {
 155                 $string = str_replace( '\\', '\\\\', $string );
 156                 $string = str_replace( '\'', '\\\'', $string );
 157                 return $string;
 158         }
 159
 160         /**
 161          * Set the cache to $cache, if it is valid. Otherwise set the cache to false.
 162          */
 163         function setCache( $cache ) {
 164                 if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) {
 165                         $this->mCache = $cache;
 166                 } else {
 167                         $this->mCache = false;
 168                 }
 169         }
 170
 171         /**
 172          * Loads messages either from memcached or the database, if not disabled
 173          * On error, quietly switches to a fallback mode
 174          * Returns false for a reportable error, true otherwise
 175          */
 176         function load() {
 177                 global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
 178
 179                 if ( $this->mDisable ) {
 180                         static $shownDisabled = false;
 181                         if ( !$shownDisabled ) {
 182                                 wfDebug( "MessageCache::load(): disabled\n" );
 183                                 $shownDisabled = true;
 184                         }
 185                         return true;
 186                 }
 187                 if ( !$this->mUseCache ) {
 188                         $this->mDeferred = false;
 189                         return true;
 190                 }
 191
 192                 $fname = 'MessageCache::load';
 193                 wfProfileIn( $fname );
 194                 $success = true;
 195
 196                 $this->mCache = false;
 197
 198                 # Try local cache
 199                 if ( $wgLocalMessageCache !== false ) {
 200                         wfProfileIn( $fname.'-fromlocal' );
 201                         $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
 202                         if ( $hash ) {
 203                                 $this->loadFromLocal( $hash );
 204                                 if ( $this->mCache ) {
 205                                         wfDebug( "MessageCache::load(): got from local cache\n" );
 206                                 }
 207                         }
 208                         wfProfileOut( $fname.'-fromlocal' );
 209                 }
 210
 211                 # Try memcached
 212                 if ( !$this->mCache ) {
 213                         wfProfileIn( $fname.'-fromcache' );
 214                         $this->setCache( $this->mMemc->get( $this->mMemcKey ) );
 215                         if ( $this->mCache ) {
 216                                 wfDebug( "MessageCache::load(): got from global cache\n" );
 217                                 # Save to local cache
 218                                 if ( $wgLocalMessageCache !== false ) {
 219                                         $serialized = serialize( $this->mCache );
 220                                         if ( !$hash ) {
 221                                                 $hash = md5( $serialized );
 222                                                 $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
 223                                         }
 224                                         if ($wgLocalMessageCacheSerialized) {
 225                                                 $this->saveToLocal( $serialized,$hash );
 226                                         } else {
 227                                                 $this->saveToScript( $this->mCache, $hash );
 228                                         }
 229                                 }
 230                         }
 231                         wfProfileOut( $fname.'-fromcache' );
 232                 }
 233
 234
 235                 # If there's nothing in memcached, load all the messages from the database
 236                 if ( !$this->mCache ) {
 237                         wfDebug( "MessageCache::load(): cache is empty\n" );
 238                         $this->lock();
 239                         # Other threads don't need to load the messages if another thread is doing it.
 240                         $success = $this->mMemc->add( $this->mMemcKey.'-status', "loading", MSG_LOAD_TIMEOUT );
 241                         if ( $success ) {
 242                                 wfProfileIn( $fname.'-load' );
 243                                 wfDebug( "MessageCache::load(): loading all messages from DB\n" );
 244                                 $this->loadFromDB();
 245                                 wfProfileOut( $fname.'-load' );
 246
 247                                 # Save in memcached
 248                                 # Keep trying if it fails, this is kind of important
 249                                 wfProfileIn( $fname.'-save' );
 250                                 for ($i=0; $i<20 &&
 251                                                    !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
 252                                          $i++ ) {
 253                                         usleep(mt_rand(500000,1500000));
 254                                 }
 255
 256                                 # Save to local cache
 257                                 if ( $wgLocalMessageCache !== false ) {
 258                                         $serialized = serialize( $this->mCache );
 259                                         $hash = md5( $serialized );
 260                                         $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
 261                                         if ($wgLocalMessageCacheSerialized) {
 262                                                 $this->saveToLocal( $serialized,$hash );
 263                                         } else {
 264                                                 $this->saveToScript( $this->mCache, $hash );
 265                                         }
 266                                 }
 267
 268                                 wfProfileOut( $fname.'-save' );
 269                                 if ( $i == 20 ) {
 270                                         $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 );
 271                                         wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
 272                                 } else {
 273                                         $this->mMemc->delete( $this->mMemcKey.'-status' );
 274                                 }
 275                         }
 276                         $this->unlock();
 277                 }
 278
 279                 if ( !is_array( $this->mCache ) ) {
 280                         wfDebug( "MessageCache::load(): unable to load cache, disabled\n" );
 281                         $this->mDisable = true;
 282                         $this->mCache = false;
 283                 }
 284                 wfProfileOut( $fname );
 285                 $this->mDeferred = false;
 286                 return $success;
 287         }
 288
 289         /**
 290          * Loads all or main part of cacheable messages from the database
 291          */
 292         function loadFromDB() {
 293                 global $wgMaxMsgCacheEntrySize;
 294
 295                 wfProfileIn( __METHOD__ );
 296                 $dbr = wfGetDB( DB_SLAVE );
 297                 $this->mCache = array();
 298
 299                 # Load titles for all oversized pages in the MediaWiki namespace
 300                 $res = $dbr->select( 'page', 'page_title',
 301                         array(
 302                                 'page_len > ' . intval( $wgMaxMsgCacheEntrySize ),
 303                                 'page_is_redirect' => 0,
 304                                 'page_namespace' => NS_MEDIAWIKI,
 305                         ),
 306                         __METHOD__ );
 307                 while ( $row = $dbr->fetchObject( $res ) ) {
 308                         $this->mCache[$row->page_title] = '!TOO BIG';
 309                 }
 310                 $dbr->freeResult( $res );
 311
 312                 # Load text for the remaining pages
 313                 $res = $dbr->select( array( 'page', 'revision', 'text' ),
 314                         array( 'page_title', 'old_text', 'old_flags' ),
 315                         array(
 316                                 'page_is_redirect' => 0,
 317                                 'page_namespace' => NS_MEDIAWIKI,
 318                                 'page_latest=rev_id',
 319                                 'rev_text_id=old_id',
 320                                 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize ) ),
 321                         __METHOD__ );
 322
 323                 for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
 324                         $this->mCache[$row->page_title] = ' ' . Revision::getRevisionText( $row );
 325                 }
 326                 $this->mCache['VERSION'] = MSG_CACHE_VERSION;
 327                 $dbr->freeResult( $res );
 328                 wfProfileOut( __METHOD__ );
 329         }
 330
 331         function replace( $title, $text ) {
 332                 global $wgLocalMessageCache, $wgLocalMessageCacheSerialized, $parserMemc;
 333                 global $wgMaxMsgCacheEntrySize;
 334
 335                 wfProfileIn( __METHOD__ );
 336                 $this->lock();
 337                 $this->load();
 338                 if ( is_array( $this->mCache ) ) {
 339                         if ( $text === false ) {
 340                                 # Article was deleted
 341                                 unset( $this->mCache[$title] );
 342                                 $this->mMemc->delete( "$this->mMemcKey:{$title}" );
 343                         } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
 344                                 $this->mCache[$title] = '!TOO BIG';
 345                                 $this->mMemc->set( "$this->mMemcKey:{$title}", ' '.$text, $this->mExpiry );
 346                         } else {
 347                                 $this->mCache[$title] = ' ' . $text;
 348                                 $this->mMemc->delete( "$this->mMemcKey:{$title}" );
 349                         }
 350                         $this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
 351
 352                         # Save to local cache
 353                         if ( $wgLocalMessageCache !== false ) {
 354                                 $serialized = serialize( $this->mCache );
 355                                 $hash = md5( $serialized );
 356                                 $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
 357                                 if ($wgLocalMessageCacheSerialized) {
 358                                         $this->saveToLocal( $serialized,$hash );
 359                                 } else {
 360                                         $this->saveToScript( $this->mCache, $hash );
 361                                 }
 362                         }
 363                 }
 364                 $this->unlock();
 365                 $parserMemc->delete(wfMemcKey('sidebar'));
 366                 wfProfileOut( __METHOD__ );
 367         }
 368
 369         /**
 370          * Returns success
 371          * Represents a write lock on the messages key
 372          */
 373         function lock() {
 374                 if ( !$this->mUseCache ) {
 375                         return true;
 376                 }
 377
 378                 $lockKey = $this->mMemcKey . 'lock';
 379                 for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
 380                         sleep(1);
 381                 }
 382
 383                 return $i >= MSG_WAIT_TIMEOUT;
 384         }
 385
 386         function unlock() {
 387                 if ( !$this->mUseCache ) {
 388                         return;
 389                 }
 390
 391                 $lockKey = $this->mMemcKey . 'lock';
 392                 $this->mMemc->delete( $lockKey );
 393         }
 394
 395         /**
 396          * Get a message from either the content language or the user language.
 397          *
 398          * @param string $key The message cache key
 399          * @param bool $useDB Get the message from the DB, false to use only the localisation
 400          * @param string $langcode Code of the language to get the message for, if
 401          *                         it is a valid code create a language for that
 402          *                         language, if it is a string but not a valid code
 403          *                         then make a basic language object, if it is a
 404          *                         false boolean then use the current users
 405          *                         language (as a fallback for the old parameter
 406          *                         functionality), or if it is a true boolean then
 407          *                         use the wikis content language (also as a
 408          *                         fallback).
 409          * @param bool $isFullKey Specifies whether $key is a two part key "lang/msg".
 410          */
 411         function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
 412                 global $wgContLanguageCode, $wgContLang, $wgLang;
 413
 414                 $validCodes = array_keys( Language::getLanguageNames() );
 415
 416                 # Identify which language to get or create a language object for.
 417                 if( $langcode === $wgContLang->getCode() ) {
 418                         # $langcode is the language code of the wikis content language object.
 419                         $lang =& $wgContLang;
 420                 } elseif( $langcode === $wgLang->getCode() ) {
 421                         # $langcode is the language code of user language object.
 422                         $lang =& $wgLang;
 423                 } elseif( in_array( $langcode, $validCodes ) ) {
 424                         # $langcode corresponds to a valid language.
 425                         $lang = Language::factory( $langcode );
 426                 } elseif( is_string( $langcode ) ) {
 427                         # $langcode is a string, but not a valid language code; use content language.
 428                         $lang =& $wgContLang;
 429                         wfDebug( 'Invalid language code passed to MessageCache::get, falling back to content language.' );
 430                 } elseif( !$langcode ) {
 431                         # $langcode is set to false, use the user language (fallback for old parameters).
 432                         $lang =& $wgLang;
 433                 } else {
 434                         # $language is set to true, use the content language (fallback for old parameters).
 435                         $lang =& $wgContLang;
 436                 }
 437
 438                 $langcode = $lang->getCode();
 439
 440                 # If uninitialised, someone is trying to call this halfway through Setup.php
 441                 if( !$this->mInitialised ) {
 442                         return '&lt;' . htmlspecialchars($key) . '&gt;';
 443                 }
 444                 # If cache initialization was deferred, start it now.
 445                 if( $this->mDeferred && !$this->mDisable && $useDB ) {
 446                         $this->load();
 447                 }
 448
 449                 $message = false;
 450
 451                 # Normalise title-case input
 452                 $lckey = $wgContLang->lcfirst( $key );
 453                 $lckey = str_replace( ' ', '_', $lckey );
 454
 455                 # Try the MediaWiki namespace
 456                 if( !$this->mDisable && $useDB ) {
 457                         $title = $wgContLang->ucfirst( $lckey );
 458                         if(!$isFullKey && ($langcode != $wgContLanguageCode) ) {
 459                                 $title .= '/' . $langcode;
 460                         }
 461                         $message = $this->getMsgFromNamespace( $title );
 462                 }
 463                 # Try the extension array
 464                 if( $message === false && isset( $this->mExtensionMessages[$langcode][$lckey] ) ) {
 465                         $message = $this->mExtensionMessages[$langcode][$lckey];
 466                 }
 467                 if ( $message === false && isset( $this->mExtensionMessages['en'][$lckey] ) ) {
 468                         $message = $this->mExtensionMessages['en'][$lckey];
 469                 }
 470
 471                 # Try the array in the language object
 472                 if( $message === false ) {
 473                         #wfDebug( "Trying language object for message $key\n" );
 474                         wfSuppressWarnings();
 475                         $message = $lang->getMessage( $lckey );
 476                         wfRestoreWarnings();
 477                         if ( is_null( $message ) ) {
 478                                 $message = false;
 479                         }
 480                 }
 481
 482                 # Try the array of another language
 483                 $pos = strrpos( $lckey, '/' );
 484                 if( $message === false && $pos !== false) {
 485                         $mkey = substr( $lckey, 0, $pos );
 486                         $code = substr( $lckey, $pos+1 );
 487                         if ( $code ) {
 488                                 $validCodes = array_keys( Language::getLanguageNames() );
 489                                 if ( in_array( $code, $validCodes ) ) {
 490                                         $message = Language::getMessageFor( $mkey, $code );
 491                                         if ( is_null( $message ) ) {
 492                                                 $message = false;
 493                                         }
 494                                 } else {
 495                                         wfDebug( __METHOD__ . ": Invalid code $code for $mkey/$code, not trying messages array\n" );
 496                                 }
 497                         }
 498                 }
 499
 500                 # Is this a custom message? Try the default language in the db...
 501                 if( ($message === false || $message === '-' ) &&
 502                         !$this->mDisable && $useDB &&
 503                         !$isFullKey && ($langcode != $wgContLanguageCode) ) {
 504                         $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ) );
 505                 }
 506
 507                 # Final fallback
 508                 if( $message === false ) {
 509                         return '&lt;' . htmlspecialchars($key) . '&gt;';
 510                 }
 511                 return $message;
 512         }
 513
 514         /**
 515          * Get a message from the MediaWiki namespace, with caching. The key must
 516          * first be converted to two-part lang/msg form if necessary.
 517          *
 518          * @param string $title Message cache key with initial uppercase letter
 519          */
 520         function getMsgFromNamespace( $title ) {
 521                 $message = false;
 522                 $type = false;
 523
 524                 # Try the cache
 525                 if( $this->mUseCache && isset( $this->mCache[$title] ) ) {
 526                         $entry = $this->mCache[$title];
 527                         $type = substr( $entry, 0, 1 );
 528                         if ( $type == ' ' ) {
 529                                 return substr( $entry, 1 );
 530                         }
 531                 }
 532
 533                 # Call message hooks, in case they are defined
 534                 wfRunHooks('MessagesPreLoad', array( $title, &$message ) );
 535                 if ( $message !== false ) {
 536                         return $message;
 537                 }
 538
 539                 # If there is no cache entry and no placeholder, it doesn't exist
 540                 if ( $type != '!' && $message === false ) {
 541                         return false;
 542                 }
 543
 544                 $memcKey = $this->mMemcKey . ':' . $title;
 545
 546                 # Try the individual message cache
 547                 if ( $this->mUseCache ) {
 548                         $entry = $this->mMemc->get( $memcKey );
 549                         if ( $entry ) {
 550                                 $type = substr( $entry, 0, 1 );
 551
 552                                 if ( $type == ' ' ) {
 553                                         $message = substr( $entry, 1 );
 554                                         $this->mCache[$title] = $entry;
 555                                         return $message;
 556                                 } elseif ( $entry == '!NONEXISTENT' ) {
 557                                         return false;
 558                                 } else {
 559                                         # Corrupt/obsolete entry, delete it
 560                                         $this->mMemc->delete( $memcKey );
 561                                 }
 562
 563                         }
 564                 }
 565
 566                 # Try loading it from the DB
 567                 $revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
 568                 if( $revision ) {
 569                         $message = $revision->getText();
 570                         if ($this->mUseCache) {
 571                                 $this->mCache[$title] = ' ' . $message;
 572                                 $this->mMemc->set( $memcKey, $message, $this->mExpiry );
 573                         }
 574                 } else {
 575                         # Negative caching
 576                         # Use some special text instead of false, because false gets converted to '' somewhere
 577                         $this->mMemc->set( $memcKey, '!NONEXISTENT', $this->mExpiry );
 578                         $this->mCache[$title] = false;
 579                 }
 580
 581                 return $message;
 582         }
 583
 584         function transform( $message, $interface = false ) {
 585                 global $wgParser;
 586                 if ( !$this->mParser && isset( $wgParser ) ) {
 587                         # Do some initialisation so that we don't have to do it twice
 588                         $wgParser->firstCallInit();
 589                         # Clone it and store it
 590                         $this->mParser = clone $wgParser;
 591                 }
 592                 if ( $this->mParser ) {
 593                         if( strpos( $message, '{{' ) !== false ) {
 594                                 $popts = $this->getParserOptions();
 595                                 $popts->setInterfaceMessage( $interface );
 596                                 $message = $this->mParser->transformMsg( $message, $popts );
 597                         }
 598                 }
 599                 return $message;
 600         }
 601
 602         function disable() { $this->mDisable = true; }
 603         function enable() { $this->mDisable = false; }
 604
 605         /** @deprecated */
 606         function disableTransform(){
 607                 wfDeprecated( __METHOD__ );
 608         }
 609         function enableTransform() {
 610                 wfDeprecated( __METHOD__ );
 611         }
 612         function setTransform( $x ) {
 613                 wfDeprecated( __METHOD__ );
 614         }
 615         function getTransform() {
 616                 wfDeprecated( __METHOD__ );
 617                 return false;
 618         }
 619
 620         /**
 621          * Add a message to the cache
 622          *
 623          * @param mixed $key
 624          * @param mixed $value
 625          * @param string $lang The messages language, English by default
 626          */
 627         function addMessage( $key, $value, $lang = 'en' ) {
 628                 $this->mExtensionMessages[$lang][$key] = $value;
 629         }
 630
 631         /**
 632          * Add an associative array of message to the cache
 633          *
 634          * @param array $messages An associative array of key => values to be added
 635          * @param string $lang The messages language, English by default
 636          */
 637         function addMessages( $messages, $lang = 'en' ) {
 638                 wfProfileIn( __METHOD__ );
 639                 if ( !is_array( $messages ) ) {
 640                         throw new MWException( __METHOD__.': Invalid message array' );
 641                 }
 642                 if ( isset( $this->mExtensionMessages[$lang] ) ) {
 643                         $this->mExtensionMessages[$lang] = $messages + $this->mExtensionMessages[$lang];
 644                 } else {
 645                         $this->mExtensionMessages[$lang] = $messages;
 646                 }
 647                 wfProfileOut( __METHOD__ );
 648         }
 649
 650         /**
 651          * Add a 2-D array of messages by lang. Useful for extensions.
 652          *
 653          * @param array $messages The array to be added
 654          */
 655         function addMessagesByLang( $messages ) {
 656                 wfProfileIn( __METHOD__ );
 657                 foreach ( $messages as $key => $value ) {
 658                         $this->addMessages( $value, $key );
 659                 }
 660                 wfProfileOut( __METHOD__ );
 661         }
 662
 663         /**
 664          * Get the extension messages for a specific language. Only English, interface
 665          * and content language are guaranteed to be loaded.
 666          *
 667          * @param string $lang The messages language, English by default
 668          */
 669         function getExtensionMessagesFor( $lang = 'en' ) {
 670                 wfProfileIn( __METHOD__ );
 671                 $messages = array();
 672                 if ( isset( $this->mExtensionMessages[$lang] ) ) {
 673                         $messages = $this->mExtensionMessages[$lang];
 674                 }
 675                 if ( $lang != 'en' ) {
 676                         $messages = $messages + $this->mExtensionMessages['en'];
 677                 }
 678                 wfProfileOut( __METHOD__ );
 679                 return $messages;
 680         }
 681
 682         /**
 683          * Clear all stored messages. Mainly used after a mass rebuild.
 684          */
 685         function clear() {
 686                 global $wgLocalMessageCache;
 687                 if( $this->mUseCache ) {
 688                         # Global cache
 689                         $this->mMemc->delete( $this->mMemcKey );
 690                         # Invalidate all local caches
 691                         $this->mMemc->delete( "{$this->mMemcKey}-hash" );
 692                 }
 693         }
 694
 695         function loadAllMessages() {
 696                 global $wgExtensionMessagesFiles;
 697                 if ( $this->mAllMessagesLoaded ) {
 698                         return;
 699                 }
 700                 $this->mAllMessagesLoaded = true;
 701
 702                 # Some extensions will load their messages when you load their class file
 703                 wfLoadAllExtensions();
 704                 # Others will respond to this hook
 705                 wfRunHooks( 'LoadAllMessages' );
 706                 # Some register their messages in $wgExtensionMessagesFiles
 707                 foreach ( $wgExtensionMessagesFiles as $name => $file ) {
 708                         if ( $file ) {
 709                                 $this->loadMessagesFile( $file );
 710                                 $wgExtensionMessagesFiles[$name] = false;
 711                         }
 712                 }
 713                 # Still others will respond to neither, they are EVIL. We sometimes need to know!
 714         }
 715
 716         /**
 717          * Load messages from a given file
 718          *
 719          * @param string $filename Filename of file to load.
 720          * @param boolean $all Whether or not to load all languages.
 721          */
 722         function loadMessagesFile( $filename, $all = false ) {
 723                 global $wgLang, $wgContLang;
 724                 $messages = $magicWords = false;
 725                 require( $filename );
 726
 727                 if( $all ) {
 728                         # Load all messages, regardless of language.
 729                         $validCodes = array_keys( Language::getLanguageNames() );
 730                         foreach( $messages as $code => $array ) {
 731                                 if( in_array( $code, $validCodes ) ) {
 732                                         $this->processMessagesArray( $messages, $code );
 733                                 }
 734                         }
 735                 } else {
 736                         # Load only languages that are usually used, and merge all
 737                         # fallbacks, except English.
 738                         $langs = array_unique( array( 'en', $wgContLang->getCode(), $wgLang->getCode() ) );
 739                         foreach( $langs as $code ) {
 740                                 $this->processMessagesArray( $messages, $code );
 741                         }
 742                 }
 743
 744                 if ( $magicWords !== false ) {
 745                         global $wgContLang;
 746                         $wgContLang->addMagicWordsByLang( $magicWords );
 747                 }
 748         }
 749
 750         /**
 751          * Process an array of messages, loading it into the message cache.
 752          *
 753          * @param array $messages Messages array.
 754          * @param string $language Language code to process.
 755          */
 756         function processMessagesArray( $messages, $language ) {
 757                 $fallbackCode = $language;
 758                 $mergedMessages = array();
 759                 do {
 760                         if ( isset($messages[$fallbackCode]) ) {
 761                                 $mergedMessages += $messages[$fallbackCode];
 762                         }
 763                         $fallbackCode = Language::getFallbackfor( $fallbackCode );
 764                 } while( $fallbackCode && $fallbackCode !== 'en' );
 765
 766                 if ( !empty($mergedMessages) )
 767                         $this->addMessages( $mergedMessages, $language );
 768         }
 769
 770 }