includes/cache/MessageCache.php

   1 <?php
   2 /**
   3  * Localisation messages cache.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23 use MediaWiki\MediaWikiServices;
  24 use Wikimedia\ScopedCallback;
  25 use MediaWiki\Logger\LoggerFactory;
  26 use Wikimedia\Rdbms\Database;
  27
  28 /**
  29  * MediaWiki message cache structure version.
  30  * Bump this whenever the message cache format has changed.
  31  */
  32 define( 'MSG_CACHE_VERSION', 2 );
  33
  34 /**
  35  * Cache of messages that are defined by MediaWiki namespace pages or by hooks
  36  *
  37  * Performs various MediaWiki namespace-related functions
  38  * @ingroup Cache
  39  */
  40 class MessageCache {
  41         const FOR_UPDATE = 1; // force message reload
  42
  43         /** How long to wait for memcached locks */
  44         const WAIT_SEC = 15;
  45         /** How long memcached locks last */
  46         const LOCK_TTL = 30;
  47
  48         /**
  49          * Process cache of loaded messages that are defined in MediaWiki namespace
  50          *
  51          * @var MapCacheLRU Map of (language code => key => " <MESSAGE>" or "!TOO BIG")
  52          */
  53         protected $cache;
  54
  55         /**
  56          * @var bool[] Map of (language code => boolean)
  57          */
  58         protected $cacheVolatile = [];
  59
  60         /**
  61          * Should mean that database cannot be used, but check
  62          * @var bool $mDisable
  63          */
  64         protected $mDisable;
  65
  66         /**
  67          * Lifetime for cache, used by object caching.
  68          * Set on construction, see __construct().
  69          */
  70         protected $mExpiry;
  71
  72         /**
  73          * Message cache has its own parser which it uses to transform messages
  74          * @var ParserOptions
  75          */
  76         protected $mParserOptions;
  77         /** @var Parser */
  78         protected $mParser;
  79
  80         /**
  81          * @var bool $mInParser
  82          */
  83         protected $mInParser = false;
  84
  85         /** @var WANObjectCache */
  86         protected $wanCache;
  87         /** @var BagOStuff */
  88         protected $clusterCache;
  89         /** @var BagOStuff */
  90         protected $srvCache;
  91
  92         /**
  93          * Singleton instance
  94          *
  95          * @var MessageCache $instance
  96          */
  97         private static $instance;
  98
  99         /**
 100          * Get the signleton instance of this class
 101          *
 102          * @since 1.18
 103          * @return MessageCache
 104          */
 105         public static function singleton() {
 106                 if ( self::$instance === null ) {
 107                         global $wgUseDatabaseMessages, $wgMsgCacheExpiry, $wgUseLocalMessageCache;
 108                         self::$instance = new self(
 109                                 MediaWikiServices::getInstance()->getMainWANObjectCache(),
 110                                 wfGetMessageCacheStorage(),
 111                                 $wgUseLocalMessageCache
 112                                         ? MediaWikiServices::getInstance()->getLocalServerObjectCache()
 113                                         : new EmptyBagOStuff(),
 114                                 $wgUseDatabaseMessages,
 115                                 $wgMsgCacheExpiry
 116                         );
 117                 }
 118
 119                 return self::$instance;
 120         }
 121
 122         /**
 123          * Destroy the singleton instance
 124          *
 125          * @since 1.18
 126          */
 127         public static function destroyInstance() {
 128                 self::$instance = null;
 129         }
 130
 131         /**
 132          * Normalize message key input
 133          *
 134          * @param string $key Input message key to be normalized
 135          * @return string Normalized message key
 136          */
 137         public static function normalizeKey( $key ) {
 138                 global $wgContLang;
 139
 140                 $lckey = strtr( $key, ' ', '_' );
 141                 if ( ord( $lckey ) < 128 ) {
 142                         $lckey[0] = strtolower( $lckey[0] );
 143                 } else {
 144                         $lckey = $wgContLang->lcfirst( $lckey );
 145                 }
 146
 147                 return $lckey;
 148         }
 149
 150         /**
 151          * @param WANObjectCache $wanCache
 152          * @param BagOStuff $clusterCache
 153          * @param BagOStuff $serverCache
 154          * @param bool $useDB Whether to look for message overrides (e.g. MediaWiki: pages)
 155          * @param int $expiry Lifetime for cache. @see $mExpiry.
 156          */
 157         public function __construct(
 158                 WANObjectCache $wanCache,
 159                 BagOStuff $clusterCache,
 160                 BagOStuff $serverCache,
 161                 $useDB,
 162                 $expiry
 163         ) {
 164                 $this->wanCache = $wanCache;
 165                 $this->clusterCache = $clusterCache;
 166                 $this->srvCache = $serverCache;
 167
 168                 $this->cache = new MapCacheLRU( 5 ); // limit size for sanity
 169
 170                 $this->mDisable = !$useDB;
 171                 $this->mExpiry = $expiry;
 172         }
 173
 174         /**
 175          * ParserOptions is lazy initialised.
 176          *
 177          * @return ParserOptions
 178          */
 179         function getParserOptions() {
 180                 global $wgUser;
 181
 182                 if ( !$this->mParserOptions ) {
 183                         if ( !$wgUser->isSafeToLoad() ) {
 184                                 // $wgUser isn't unstubbable yet, so don't try to get a
 185                                 // ParserOptions for it. And don't cache this ParserOptions
 186                                 // either.
 187                                 $po = ParserOptions::newFromAnon();
 188                                 $po->setAllowUnsafeRawHtml( false );
 189                                 return $po;
 190                         }
 191
 192                         $this->mParserOptions = new ParserOptions;
 193                         // Messages may take parameters that could come
 194                         // from malicious sources. As a precaution, disable
 195                         // the <html> parser tag when parsing messages.
 196                         $this->mParserOptions->setAllowUnsafeRawHtml( false );
 197                 }
 198
 199                 return $this->mParserOptions;
 200         }
 201
 202         /**
 203          * Try to load the cache from APC.
 204          *
 205          * @param string $code Optional language code, see documenation of load().
 206          * @return array|bool The cache array, or false if not in cache.
 207          */
 208         protected function getLocalCache( $code ) {
 209                 $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
 210
 211                 return $this->srvCache->get( $cacheKey );
 212         }
 213
 214         /**
 215          * Save the cache to APC.
 216          *
 217          * @param string $code
 218          * @param array $cache The cache array
 219          */
 220         protected function saveToLocalCache( $code, $cache ) {
 221                 $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
 222                 $this->srvCache->set( $cacheKey, $cache );
 223         }
 224
 225         /**
 226          * Loads messages from caches or from database in this order:
 227          * (1) local message cache (if $wgUseLocalMessageCache is enabled)
 228          * (2) memcached
 229          * (3) from the database.
 230          *
 231          * When succesfully loading from (2) or (3), all higher level caches are
 232          * updated for the newest version.
 233          *
 234          * Nothing is loaded if member variable mDisable is true, either manually
 235          * set by calling code or if message loading fails (is this possible?).
 236          *
 237          * Returns true if cache is already populated or it was succesfully populated,
 238          * or false if populating empty cache fails. Also returns true if MessageCache
 239          * is disabled.
 240          *
 241          * @param string $code Language to which load messages
 242          * @param int|null $mode Use MessageCache::FOR_UPDATE to skip process cache [optional]
 243          * @throws InvalidArgumentException
 244          * @return bool
 245          */
 246         protected function load( $code, $mode = null ) {
 247                 if ( !is_string( $code ) ) {
 248                         throw new InvalidArgumentException( "Missing language code" );
 249                 }
 250
 251                 # Don't do double loading...
 252                 if ( $this->cache->has( $code ) && $mode != self::FOR_UPDATE ) {
 253                         return true;
 254                 }
 255
 256                 # 8 lines of code just to say (once) that message cache is disabled
 257                 if ( $this->mDisable ) {
 258                         static $shownDisabled = false;
 259                         if ( !$shownDisabled ) {
 260                                 wfDebug( __METHOD__ . ": disabled\n" );
 261                                 $shownDisabled = true;
 262                         }
 263
 264                         return true;
 265                 }
 266
 267                 # Loading code starts
 268                 $success = false; # Keep track of success
 269                 $staleCache = false; # a cache array with expired data, or false if none has been loaded
 270                 $where = []; # Debug info, delayed to avoid spamming debug log too much
 271
 272                 # Hash of the contents is stored in memcache, to detect if data-center cache
 273                 # or local cache goes out of date (e.g. due to replace() on some other server)
 274                 list( $hash, $hashVolatile ) = $this->getValidationHash( $code );
 275                 $this->cacheVolatile[$code] = $hashVolatile;
 276
 277                 # Try the local cache and check against the cluster hash key...
 278                 $cache = $this->getLocalCache( $code );
 279                 if ( !$cache ) {
 280                         $where[] = 'local cache is empty';
 281                 } elseif ( !isset( $cache['HASH'] ) || $cache['HASH'] !== $hash ) {
 282                         $where[] = 'local cache has the wrong hash';
 283                         $staleCache = $cache;
 284                 } elseif ( $this->isCacheExpired( $cache ) ) {
 285                         $where[] = 'local cache is expired';
 286                         $staleCache = $cache;
 287                 } elseif ( $hashVolatile ) {
 288                         $where[] = 'local cache validation key is expired/volatile';
 289                         $staleCache = $cache;
 290                 } else {
 291                         $where[] = 'got from local cache';
 292                         $this->cache->set( $code, $cache );
 293                         $success = true;
 294                 }
 295
 296                 if ( !$success ) {
 297                         $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
 298                         # Try the global cache. If it is empty, try to acquire a lock. If
 299                         # the lock can't be acquired, wait for the other thread to finish
 300                         # and then try the global cache a second time.
 301                         for ( $failedAttempts = 0; $failedAttempts <= 1; $failedAttempts++ ) {
 302                                 if ( $hashVolatile && $staleCache ) {
 303                                         # Do not bother fetching the whole cache blob to avoid I/O.
 304                                         # Instead, just try to get the non-blocking $statusKey lock
 305                                         # below, and use the local stale value if it was not acquired.
 306                                         $where[] = 'global cache is presumed expired';
 307                                 } else {
 308                                         $cache = $this->clusterCache->get( $cacheKey );
 309                                         if ( !$cache ) {
 310                                                 $where[] = 'global cache is empty';
 311                                         } elseif ( $this->isCacheExpired( $cache ) ) {
 312                                                 $where[] = 'global cache is expired';
 313                                                 $staleCache = $cache;
 314                                         } elseif ( $hashVolatile ) {
 315                                                 # DB results are replica DB lag prone until the holdoff TTL passes.
 316                                                 # By then, updates should be reflected in loadFromDBWithLock().
 317                                                 # One thread renerates the cache while others use old values.
 318                                                 $where[] = 'global cache is expired/volatile';
 319                                                 $staleCache = $cache;
 320                                         } else {
 321                                                 $where[] = 'got from global cache';
 322                                                 $this->cache->set( $code, $cache );
 323                                                 $this->saveToCaches( $cache, 'local-only', $code );
 324                                                 $success = true;
 325                                         }
 326                                 }
 327
 328                                 if ( $success ) {
 329                                         # Done, no need to retry
 330                                         break;
 331                                 }
 332
 333                                 # We need to call loadFromDB. Limit the concurrency to one process.
 334                                 # This prevents the site from going down when the cache expires.
 335                                 # Note that the DB slam protection lock here is non-blocking.
 336                                 $loadStatus = $this->loadFromDBWithLock( $code, $where, $mode );
 337                                 if ( $loadStatus === true ) {
 338                                         $success = true;
 339                                         break;
 340                                 } elseif ( $staleCache ) {
 341                                         # Use the stale cache while some other thread constructs the new one
 342                                         $where[] = 'using stale cache';
 343                                         $this->cache->set( $code, $staleCache );
 344                                         $success = true;
 345                                         break;
 346                                 } elseif ( $failedAttempts > 0 ) {
 347                                         # Already blocked once, so avoid another lock/unlock cycle.
 348                                         # This case will typically be hit if memcached is down, or if
 349                                         # loadFromDB() takes longer than LOCK_WAIT.
 350                                         $where[] = "could not acquire status key.";
 351                                         break;
 352                                 } elseif ( $loadStatus === 'cantacquire' ) {
 353                                         # Wait for the other thread to finish, then retry. Normally,
 354                                         # the memcached get() will then yeild the other thread's result.
 355                                         $where[] = 'waited for other thread to complete';
 356                                         $this->getReentrantScopedLock( $cacheKey );
 357                                 } else {
 358                                         # Disable cache; $loadStatus is 'disabled'
 359                                         break;
 360                                 }
 361                         }
 362                 }
 363
 364                 if ( !$success ) {
 365                         $where[] = 'loading FAILED - cache is disabled';
 366                         $this->mDisable = true;
 367                         $this->cache->set( $code, null );
 368                         wfDebugLog( 'MessageCacheError', __METHOD__ . ": Failed to load $code\n" );
 369                         # This used to throw an exception, but that led to nasty side effects like
 370                         # the whole wiki being instantly down if the memcached server died
 371                 }
 372
 373                 if ( !$this->cache->has( $code ) ) { // sanity
 374                         throw new LogicException( "Process cache for '$code' should be set by now." );
 375                 }
 376
 377                 $info = implode( ', ', $where );
 378                 wfDebugLog( 'MessageCache', __METHOD__ . ": Loading $code... $info\n" );
 379
 380                 return $success;
 381         }
 382
 383         /**
 384          * @param string $code
 385          * @param array &$where List of wfDebug() comments
 386          * @param int|null $mode Use MessageCache::FOR_UPDATE to use DB_MASTER
 387          * @return bool|string True on success or one of ("cantacquire", "disabled")
 388          */
 389         protected function loadFromDBWithLock( $code, array &$where, $mode = null ) {
 390                 # If cache updates on all levels fail, give up on message overrides.
 391                 # This is to avoid easy site outages; see $saveSuccess comments below.
 392                 $statusKey = $this->clusterCache->makeKey( 'messages', $code, 'status' );
 393                 $status = $this->clusterCache->get( $statusKey );
 394                 if ( $status === 'error' ) {
 395                         $where[] = "could not load; method is still globally disabled";
 396                         return 'disabled';
 397                 }
 398
 399                 # Now let's regenerate
 400                 $where[] = 'loading from database';
 401
 402                 # Lock the cache to prevent conflicting writes.
 403                 # This lock is non-blocking so stale cache can quickly be used.
 404                 # Note that load() will call a blocking getReentrantScopedLock()
 405                 # after this if it really need to wait for any current thread.
 406                 $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
 407                 $scopedLock = $this->getReentrantScopedLock( $cacheKey, 0 );
 408                 if ( !$scopedLock ) {
 409                         $where[] = 'could not acquire main lock';
 410                         return 'cantacquire';
 411                 }
 412
 413                 $cache = $this->loadFromDB( $code, $mode );
 414                 $this->cache->set( $code, $cache );
 415                 $saveSuccess = $this->saveToCaches( $cache, 'all', $code );
 416
 417                 if ( !$saveSuccess ) {
 418                         /**
 419                          * Cache save has failed.
 420                          *
 421                          * There are two main scenarios where this could be a problem:
 422                          * - The cache is more than the maximum size (typically 1MB compressed).
 423                          * - Memcached has no space remaining in the relevant slab class. This is
 424                          *   unlikely with recent versions of memcached.
 425                          *
 426                          * Either way, if there is a local cache, nothing bad will happen. If there
 427                          * is no local cache, disabling the message cache for all requests avoids
 428                          * incurring a loadFromDB() overhead on every request, and thus saves the
 429                          * wiki from complete downtime under moderate traffic conditions.
 430                          */
 431                         if ( $this->srvCache instanceof EmptyBagOStuff ) {
 432                                 $this->clusterCache->set( $statusKey, 'error', 60 * 5 );
 433                                 $where[] = 'could not save cache, disabled globally for 5 minutes';
 434                         } else {
 435                                 $where[] = "could not save global cache";
 436                         }
 437                 }
 438
 439                 return true;
 440         }
 441
 442         /**
 443          * Loads cacheable messages from the database. Messages bigger than
 444          * $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded
 445          * on-demand from the database later.
 446          *
 447          * @param string $code Language code
 448          * @param int|null $mode Use MessageCache::FOR_UPDATE to skip process cache
 449          * @return array Loaded messages for storing in caches
 450          */
 451         protected function loadFromDB( $code, $mode = null ) {
 452                 global $wgMaxMsgCacheEntrySize, $wgLanguageCode, $wgAdaptiveMessageCache;
 453
 454                 // (T164666) The query here performs really poorly on WMF's
 455                 // contributions replicas. We don't have a way to say "any group except
 456                 // contributions", so for the moment let's specify 'api'.
 457                 // @todo: Get rid of this hack.
 458                 $dbr = wfGetDB( ( $mode == self::FOR_UPDATE ) ? DB_MASTER : DB_REPLICA, 'api' );
 459
 460                 $cache = [];
 461
 462                 # Common conditions
 463                 $conds = [
 464                         'page_is_redirect' => 0,
 465                         'page_namespace' => NS_MEDIAWIKI,
 466                 ];
 467
 468                 $mostused = [];
 469                 if ( $wgAdaptiveMessageCache && $code !== $wgLanguageCode ) {
 470                         if ( !$this->cache->has( $wgLanguageCode ) ) {
 471                                 $this->load( $wgLanguageCode );
 472                         }
 473                         $mostused = array_keys( $this->cache->get( $wgLanguageCode ) );
 474                         foreach ( $mostused as $key => $value ) {
 475                                 $mostused[$key] = "$value/$code";
 476                         }
 477                 }
 478
 479                 if ( count( $mostused ) ) {
 480                         $conds['page_title'] = $mostused;
 481                 } elseif ( $code !== $wgLanguageCode ) {
 482                         $conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), '/', $code );
 483                 } else {
 484                         # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
 485                         # other than language code.
 486                         $conds[] = 'page_title NOT' .
 487                                 $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
 488                 }
 489
 490                 # Conditions to fetch oversized pages to ignore them
 491                 $bigConds = $conds;
 492                 $bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize );
 493
 494                 # Load titles for all oversized pages in the MediaWiki namespace
 495                 $res = $dbr->select(
 496                         'page',
 497                         [ 'page_title', 'page_latest' ],
 498                         $bigConds,
 499                         __METHOD__ . "($code)-big"
 500                 );
 501                 foreach ( $res as $row ) {
 502                         $cache[$row->page_title] = '!TOO BIG';
 503                         // At least include revision ID so page changes are reflected in the hash
 504                         $cache['EXCESSIVE'][$row->page_title] = $row->page_latest;
 505                 }
 506
 507                 # Conditions to load the remaining pages with their contents
 508                 $smallConds = $conds;
 509                 $smallConds[] = 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize );
 510
 511                 $res = $dbr->select(
 512                         [ 'page', 'revision', 'text' ],
 513                         [ 'page_title', 'old_id', 'old_text', 'old_flags' ],
 514                         $smallConds,
 515                         __METHOD__ . "($code)-small",
 516                         [],
 517                         [
 518                                 'revision' => [ 'JOIN', 'page_latest=rev_id' ],
 519                                 'text' => [ 'JOIN', 'rev_text_id=old_id' ],
 520                         ]
 521                 );
 522
 523                 foreach ( $res as $row ) {
 524                         $text = Revision::getRevisionText( $row );
 525                         if ( $text === false ) {
 526                                 // Failed to fetch data; possible ES errors?
 527                                 // Store a marker to fetch on-demand as a workaround...
 528                                 // TODO Use a differnt marker
 529                                 $entry = '!TOO BIG';
 530                                 wfDebugLog(
 531                                         'MessageCache',
 532                                         __METHOD__
 533                                         . ": failed to load message page text for {$row->page_title} ($code)"
 534                                 );
 535                         } else {
 536                                 $entry = ' ' . $text;
 537                         }
 538                         $cache[$row->page_title] = $entry;
 539                 }
 540
 541                 $cache['VERSION'] = MSG_CACHE_VERSION;
 542                 ksort( $cache );
 543
 544                 # Hash for validating local cache (APC). No need to take into account
 545                 # messages larger than $wgMaxMsgCacheEntrySize, since those are only
 546                 # stored and fetched from memcache.
 547                 $cache['HASH'] = md5( serialize( $cache ) );
 548                 $cache['EXPIRY'] = wfTimestamp( TS_MW, time() + $this->mExpiry );
 549
 550                 return $cache;
 551         }
 552
 553         /**
 554          * Updates cache as necessary when message page is changed
 555          *
 556          * @param string $title Message cache key with initial uppercase letter
 557          * @param string|bool $text New contents of the page (false if deleted)
 558          */
 559         public function replace( $title, $text ) {
 560                 global $wgLanguageCode;
 561
 562                 if ( $this->mDisable ) {
 563                         return;
 564                 }
 565
 566                 list( $msg, $code ) = $this->figureMessage( $title );
 567                 if ( strpos( $title, '/' ) !== false && $code === $wgLanguageCode ) {
 568                         // Content language overrides do not use the /<code> suffix
 569                         return;
 570                 }
 571
 572                 // (a) Update the process cache with the new message text
 573                 if ( $text === false ) {
 574                         // Page deleted
 575                         $this->cache->setField( $code, $title, '!NONEXISTENT' );
 576                 } else {
 577                         // Ignore $wgMaxMsgCacheEntrySize so the process cache is up to date
 578                         $this->cache->setField( $code, $title, ' ' . $text );
 579                 }
 580
 581                 // (b) Update the shared caches in a deferred update with a fresh DB snapshot
 582                 DeferredUpdates::addCallableUpdate(
 583                         function () use ( $title, $msg, $code ) {
 584                                 global $wgContLang, $wgMaxMsgCacheEntrySize;
 585                                 // Allow one caller at a time to avoid race conditions
 586                                 $scopedLock = $this->getReentrantScopedLock(
 587                                         $this->clusterCache->makeKey( 'messages', $code )
 588                                 );
 589                                 if ( !$scopedLock ) {
 590                                         LoggerFactory::getInstance( 'MessageCache' )->error(
 591                                                 __METHOD__ . ': could not acquire lock to update {title} ({code})',
 592                                                 [ 'title' => $title, 'code' => $code ] );
 593                                         return;
 594                                 }
 595                                 // Reload messages from the database and pre-populate dc-local caches
 596                                 // as optimisation. Use the master DB to avoid race conditions.
 597                                 $cache = $this->loadFromDB( $code, self::FOR_UPDATE );
 598                                 // Check if an individual cache key should exist and update cache accordingly
 599                                 $page = WikiPage::factory( Title::makeTitle( NS_MEDIAWIKI, $title ) );
 600                                 $page->loadPageData( $page::READ_LATEST );
 601                                 $text = $this->getMessageTextFromContent( $page->getContent() );
 602                                 if ( is_string( $text ) && strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
 603                                         // Match logic of loadCachedMessagePageEntry()
 604                                         $this->wanCache->set(
 605                                                 $this->bigMessageCacheKey( $cache['HASH'], $title ),
 606                                                 ' ' . $text,
 607                                                 $this->mExpiry
 608                                         );
 609                                 }
 610                                 // Mark this cache as definitely being "latest" (non-volatile) so
 611                                 // load() calls do not try to refresh the cache with replica DB data
 612                                 $cache['LATEST'] = time();
 613                                 // Update the process cache
 614                                 $this->cache->set( $code, $cache );
 615                                 // Pre-emptively update the local datacenter cache so things like edit filter and
 616                                 // blacklist changes are reflected immediately; these often use MediaWiki: pages.
 617                                 // The datacenter handling replace() calls should be the same one handling edits
 618                                 // as they require HTTP POST.
 619                                 $this->saveToCaches( $cache, 'all', $code );
 620                                 // Release the lock now that the cache is saved
 621                                 ScopedCallback::consume( $scopedLock );
 622
 623                                 // Relay the purge. Touching this check key expires cache contents
 624                                 // and local cache (APC) validation hash across all datacenters.
 625                                 $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
 626
 627                                 // Purge the message in the message blob store
 628                                 $resourceloader = RequestContext::getMain()->getOutput()->getResourceLoader();
 629                                 $blobStore = $resourceloader->getMessageBlobStore();
 630                                 $blobStore->updateMessage( $wgContLang->lcfirst( $msg ) );
 631
 632                                 Hooks::run( 'MessageCacheReplace', [ $title, $text ] );
 633                         },
 634                         DeferredUpdates::PRESEND
 635                 );
 636         }
 637
 638         /**
 639          * Is the given cache array expired due to time passing or a version change?
 640          *
 641          * @param array $cache
 642          * @return bool
 643          */
 644         protected function isCacheExpired( $cache ) {
 645                 if ( !isset( $cache['VERSION'] ) || !isset( $cache['EXPIRY'] ) ) {
 646                         return true;
 647                 }
 648                 if ( $cache['VERSION'] != MSG_CACHE_VERSION ) {
 649                         return true;
 650                 }
 651                 if ( wfTimestampNow() >= $cache['EXPIRY'] ) {
 652                         return true;
 653                 }
 654
 655                 return false;
 656         }
 657
 658         /**
 659          * Shortcut to update caches.
 660          *
 661          * @param array $cache Cached messages with a version.
 662          * @param string $dest Either "local-only" to save to local caches only
 663          *   or "all" to save to all caches.
 664          * @param string|bool $code Language code (default: false)
 665          * @return bool
 666          */
 667         protected function saveToCaches( array $cache, $dest, $code = false ) {
 668                 if ( $dest === 'all' ) {
 669                         $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
 670                         $success = $this->clusterCache->set( $cacheKey, $cache );
 671                         $this->setValidationHash( $code, $cache );
 672                 } else {
 673                         $success = true;
 674                 }
 675
 676                 $this->saveToLocalCache( $code, $cache );
 677
 678                 return $success;
 679         }
 680
 681         /**
 682          * Get the md5 used to validate the local APC cache
 683          *
 684          * @param string $code
 685          * @return array (hash or false, bool expiry/volatility status)
 686          */
 687         protected function getValidationHash( $code ) {
 688                 $curTTL = null;
 689                 $value = $this->wanCache->get(
 690                         $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
 691                         $curTTL,
 692                         [ $this->getCheckKey( $code ) ]
 693                 );
 694
 695                 if ( $value ) {
 696                         $hash = $value['hash'];
 697                         if ( ( time() - $value['latest'] ) < WANObjectCache::TTL_MINUTE ) {
 698                                 // Cache was recently updated via replace() and should be up-to-date.
 699                                 // That method is only called in the primary datacenter and uses FOR_UPDATE.
 700                                 // Also, it is unlikely that the current datacenter is *now* secondary one.
 701                                 $expired = false;
 702                         } else {
 703                                 // See if the "check" key was bumped after the hash was generated
 704                                 $expired = ( $curTTL < 0 );
 705                         }
 706                 } else {
 707                         // No hash found at all; cache must regenerate to be safe
 708                         $hash = false;
 709                         $expired = true;
 710                 }
 711
 712                 return [ $hash, $expired ];
 713         }
 714
 715         /**
 716          * Set the md5 used to validate the local disk cache
 717          *
 718          * If $cache has a 'LATEST' UNIX timestamp key, then the hash will not
 719          * be treated as "volatile" by getValidationHash() for the next few seconds.
 720          * This is triggered when $cache is generated using FOR_UPDATE mode.
 721          *
 722          * @param string $code
 723          * @param array $cache Cached messages with a version
 724          */
 725         protected function setValidationHash( $code, array $cache ) {
 726                 $this->wanCache->set(
 727                         $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
 728                         [
 729                                 'hash' => $cache['HASH'],
 730                                 'latest' => $cache['LATEST'] ?? 0
 731                         ],
 732                         WANObjectCache::TTL_INDEFINITE
 733                 );
 734         }
 735
 736         /**
 737          * @param string $key A language message cache key that stores blobs
 738          * @param int $timeout Wait timeout in seconds
 739          * @return null|ScopedCallback
 740          */
 741         protected function getReentrantScopedLock( $key, $timeout = self::WAIT_SEC ) {
 742                 return $this->clusterCache->getScopedLock( $key, $timeout, self::LOCK_TTL, __METHOD__ );
 743         }
 744
 745         /**
 746          * Get a message from either the content language or the user language.
 747          *
 748          * First, assemble a list of languages to attempt getting the message from. This
 749          * chain begins with the requested language and its fallbacks and then continues with
 750          * the content language and its fallbacks. For each language in the chain, the following
 751          * process will occur (in this order):
 752          *  1. If a language-specific override, i.e., [[MW:msg/lang]], is available, use that.
 753          *     Note: for the content language, there is no /lang subpage.
 754          *  2. Fetch from the static CDB cache.
 755          *  3. If available, check the database for fallback language overrides.
 756          *
 757          * This process provides a number of guarantees. When changing this code, make sure all
 758          * of these guarantees are preserved.
 759          *  * If the requested language is *not* the content language, then the CDB cache for that
 760          *    specific language will take precedence over the root database page ([[MW:msg]]).
 761          *  * Fallbacks will be just that: fallbacks. A fallback language will never be reached if
 762          *    the message is available *anywhere* in the language for which it is a fallback.
 763          *
 764          * @param string $key The message key
 765          * @param bool $useDB If true, look for the message in the DB, false
 766          *   to use only the compiled l10n cache.
 767          * @param bool|string|object $langcode Code of the language to get the message for.
 768          *   - If string and a valid code, will create a standard language object
 769          *   - If string but not a valid code, will create a basic language object
 770          *   - If boolean and false, create object from the current users language
 771          *   - If boolean and true, create object from the wikis content language
 772          *   - If language object, use it as given
 773          * @param bool $isFullKey Specifies whether $key is a two part key "msg/lang".
 774          *
 775          * @throws MWException When given an invalid key
 776          * @return string|bool False if the message doesn't exist, otherwise the
 777          *   message (which can be empty)
 778          */
 779         function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
 780                 if ( is_int( $key ) ) {
 781                         // Fix numerical strings that somehow become ints
 782                         // on their way here
 783                         $key = (string)$key;
 784                 } elseif ( !is_string( $key ) ) {
 785                         throw new MWException( 'Non-string key given' );
 786                 } elseif ( $key === '' ) {
 787                         // Shortcut: the empty key is always missing
 788                         return false;
 789                 }
 790
 791                 // For full keys, get the language code from the key
 792                 $pos = strrpos( $key, '/' );
 793                 if ( $isFullKey && $pos !== false ) {
 794                         $langcode = substr( $key, $pos + 1 );
 795                         $key = substr( $key, 0, $pos );
 796                 }
 797
 798                 // Normalise title-case input (with some inlining)
 799                 $lckey = self::normalizeKey( $key );
 800
 801                 Hooks::run( 'MessageCache::get', [ &$lckey ] );
 802
 803                 // Loop through each language in the fallback list until we find something useful
 804                 $lang = wfGetLangObj( $langcode );
 805                 $message = $this->getMessageFromFallbackChain(
 806                         $lang,
 807                         $lckey,
 808                         !$this->mDisable && $useDB
 809                 );
 810
 811                 // If we still have no message, maybe the key was in fact a full key so try that
 812                 if ( $message === false ) {
 813                         $parts = explode( '/', $lckey );
 814                         // We may get calls for things that are http-urls from sidebar
 815                         // Let's not load nonexistent languages for those
 816                         // They usually have more than one slash.
 817                         if ( count( $parts ) == 2 && $parts[1] !== '' ) {
 818                                 $message = Language::getMessageFor( $parts[0], $parts[1] );
 819                                 if ( $message === null ) {
 820                                         $message = false;
 821                                 }
 822                         }
 823                 }
 824
 825                 // Post-processing if the message exists
 826                 if ( $message !== false ) {
 827                         // Fix whitespace
 828                         $message = str_replace(
 829                                 [
 830                                         # Fix for trailing whitespace, removed by textarea
 831                                         '&#32;',
 832                                         # Fix for NBSP, converted to space by firefox
 833                                         '&nbsp;',
 834                                         '&#160;',
 835                                         '&shy;'
 836                                 ],
 837                                 [
 838                                         ' ',
 839                                         "\u{00A0}",
 840                                         "\u{00A0}",
 841                                         "\u{00AD}"
 842                                 ],
 843                                 $message
 844                         );
 845                 }
 846
 847                 return $message;
 848         }
 849
 850         /**
 851          * Given a language, try and fetch messages from that language.
 852          *
 853          * Will also consider fallbacks of that language, the site language, and fallbacks for
 854          * the site language.
 855          *
 856          * @see MessageCache::get
 857          * @param Language|StubObject $lang Preferred language
 858          * @param string $lckey Lowercase key for the message (as for localisation cache)
 859          * @param bool $useDB Whether to include messages from the wiki database
 860          * @return string|bool The message, or false if not found
 861          */
 862         protected function getMessageFromFallbackChain( $lang, $lckey, $useDB ) {
 863                 global $wgContLang;
 864
 865                 $alreadyTried = [];
 866
 867                 // First try the requested language.
 868                 $message = $this->getMessageForLang( $lang, $lckey, $useDB, $alreadyTried );
 869                 if ( $message !== false ) {
 870                         return $message;
 871                 }
 872
 873                 // Now try checking the site language.
 874                 $message = $this->getMessageForLang( $wgContLang, $lckey, $useDB, $alreadyTried );
 875                 return $message;
 876         }
 877
 878         /**
 879          * Given a language, try and fetch messages from that language and its fallbacks.
 880          *
 881          * @see MessageCache::get
 882          * @param Language|StubObject $lang Preferred language
 883          * @param string $lckey Lowercase key for the message (as for localisation cache)
 884          * @param bool $useDB Whether to include messages from the wiki database
 885          * @param bool[] $alreadyTried Contains true for each language that has been tried already
 886          * @return string|bool The message, or false if not found
 887          */
 888         private function getMessageForLang( $lang, $lckey, $useDB, &$alreadyTried ) {
 889                 global $wgContLang;
 890
 891                 $langcode = $lang->getCode();
 892
 893                 // Try checking the database for the requested language
 894                 if ( $useDB ) {
 895                         $uckey = $wgContLang->ucfirst( $lckey );
 896
 897                         if ( !isset( $alreadyTried[$langcode] ) ) {
 898                                 $message = $this->getMsgFromNamespace(
 899                                         $this->getMessagePageName( $langcode, $uckey ),
 900                                         $langcode
 901                                 );
 902
 903                                 if ( $message !== false ) {
 904                                         return $message;
 905                                 }
 906                                 $alreadyTried[$langcode] = true;
 907                         }
 908                 } else {
 909                         $uckey = null;
 910                 }
 911
 912                 // Check the CDB cache
 913                 $message = $lang->getMessage( $lckey );
 914                 if ( $message !== null ) {
 915                         return $message;
 916                 }
 917
 918                 // Try checking the database for all of the fallback languages
 919                 if ( $useDB ) {
 920                         $fallbackChain = Language::getFallbacksFor( $langcode );
 921
 922                         foreach ( $fallbackChain as $code ) {
 923                                 if ( isset( $alreadyTried[$code] ) ) {
 924                                         continue;
 925                                 }
 926
 927                                 $message = $this->getMsgFromNamespace(
 928                                         $this->getMessagePageName( $code, $uckey ), $code );
 929
 930                                 if ( $message !== false ) {
 931                                         return $message;
 932                                 }
 933                                 $alreadyTried[$code] = true;
 934                         }
 935                 }
 936
 937                 return false;
 938         }
 939
 940         /**
 941          * Get the message page name for a given language
 942          *
 943          * @param string $langcode
 944          * @param string $uckey Uppercase key for the message
 945          * @return string The page name
 946          */
 947         private function getMessagePageName( $langcode, $uckey ) {
 948                 global $wgLanguageCode;
 949
 950                 if ( $langcode === $wgLanguageCode ) {
 951                         // Messages created in the content language will not have the /lang extension
 952                         return $uckey;
 953                 } else {
 954                         return "$uckey/$langcode";
 955                 }
 956         }
 957
 958         /**
 959          * Get a message from the MediaWiki namespace, with caching. The key must
 960          * first be converted to two-part lang/msg form if necessary.
 961          *
 962          * Unlike self::get(), this function doesn't resolve fallback chains, and
 963          * some callers require this behavior. LanguageConverter::parseCachedTable()
 964          * and self::get() are some examples in core.
 965          *
 966          * @param string $title Message cache key with initial uppercase letter
 967          * @param string $code Code denoting the language to try
 968          * @return string|bool The message, or false if it does not exist or on error
 969          */
 970         public function getMsgFromNamespace( $title, $code ) {
 971                 // Load all MediaWiki page definitions into cache. Note that individual keys
 972                 // already loaded into cache during this request remain in the cache, which
 973                 // includes the value of hook-defined messages.
 974                 $this->load( $code );
 975
 976                 $entry = $this->cache->getField( $code, $title );
 977                 if ( $entry !== null ) {
 978                         if ( substr( $entry, 0, 1 ) === ' ' ) {
 979                                 // The message exists and is not '!TOO BIG'
 980                                 return (string)substr( $entry, 1 );
 981                         } elseif ( $entry === '!NONEXISTENT' ) {
 982                                 return false;
 983                         }
 984                         // Fall through and try invididual message cache below
 985                 } else {
 986                         // Message does not have a MediaWiki page definition
 987                         $message = false;
 988                         Hooks::run( 'MessagesPreLoad', [ $title, &$message, $code ] );
 989                         if ( $message !== false ) {
 990                                 $this->cache->setField( $code, $title, ' ' . $message );
 991                         } else {
 992                                 $this->cache->setField( $code, $title, '!NONEXISTENT' );
 993                         }
 994
 995                         return $message;
 996                 }
 997
 998                 if ( $this->cacheVolatile[$code] ) {
 999                         $entry = false;
1000                         // Make sure that individual keys respect the WAN cache holdoff period too
1001                         LoggerFactory::getInstance( 'MessageCache' )->debug(
1002                                 __METHOD__ . ': loading volatile key \'{titleKey}\'',
1003                                 [ 'titleKey' => $title, 'code' => $code ] );
1004                 } else {
1005                         // Try the individual message cache
1006                         $entry = $this->loadCachedMessagePageEntry(
1007                                 $title,
1008                                 $code,
1009                                 $this->cache->getField( $code, 'HASH' )
1010                         );
1011                 }
1012
1013                 if ( $entry !== false && substr( $entry, 0, 1 ) === ' ' ) {
1014                         $this->cache->setField( $code, $title, $entry );
1015                         // The message exists, so make sure a string is returned
1016                         return (string)substr( $entry, 1 );
1017                 }
1018
1019                 $this->cache->setField( $code, $title, '!NONEXISTENT' );
1020
1021                 return false;
1022         }
1023
1024         /**
1025          * @param string $dbKey
1026          * @param string $code
1027          * @param string $hash
1028          * @return string Either " <MESSAGE>" or "!NONEXISTANT"
1029          */
1030         private function loadCachedMessagePageEntry( $dbKey, $code, $hash ) {
1031                 return $this->srvCache->getWithSetCallback(
1032                         $this->srvCache->makeKey( 'messages-big', $hash, $dbKey ),
1033                         IExpiringStore::TTL_MINUTE,
1034                         function () use ( $code, $dbKey, $hash ) {
1035                                 return $this->wanCache->getWithSetCallback(
1036                                         $this->bigMessageCacheKey( $hash, $dbKey ),
1037                                         $this->mExpiry,
1038                                         function ( $oldValue, &$ttl, &$setOpts ) use ( $dbKey, $code ) {
1039                                                 // Try loading the message from the database
1040                                                 $dbr = wfGetDB( DB_REPLICA );
1041                                                 $setOpts += Database::getCacheSetOptions( $dbr );
1042                                                 // Use newKnownCurrent() to avoid querying revision/user tables
1043                                                 $title = Title::makeTitle( NS_MEDIAWIKI, $dbKey );
1044                                                 $revision = Revision::newKnownCurrent( $dbr, $title );
1045                                                 if ( !$revision ) {
1046                                                         // The wiki doesn't have a local override page. Cache absence with normal TTL.
1047                                                         // When overrides are created, self::replace() takes care of the cache.
1048                                                         return '!NONEXISTENT';
1049                                                 }
1050                                                 $content = $revision->getContent();
1051                                                 if ( $content ) {
1052                                                         $message = $this->getMessageTextFromContent( $content );
1053                                                 } else {
1054                                                         LoggerFactory::getInstance( 'MessageCache' )->warning(
1055                                                                 __METHOD__ . ': failed to load page text for \'{titleKey}\'',
1056                                                                 [ 'titleKey' => $dbKey, 'code' => $code ]
1057                                                         );
1058                                                         $message = null;
1059                                                 }
1060
1061                                                 if ( !is_string( $message ) ) {
1062                                                         // Revision failed to load Content, or Content is incompatible with wikitext.
1063                                                         // Possibly a temporary loading failure.
1064                                                         $ttl = 5;
1065
1066                                                         return '!NONEXISTENT';
1067                                                 }
1068
1069                                                 return ' ' . $message;
1070                                         }
1071                                 );
1072                         }
1073                 );
1074         }
1075
1076         /**
1077          * @param string $message
1078          * @param bool $interface
1079          * @param Language|null $language
1080          * @param Title|null $title
1081          * @return string
1082          */
1083         public function transform( $message, $interface = false, $language = null, $title = null ) {
1084                 // Avoid creating parser if nothing to transform
1085                 if ( strpos( $message, '{{' ) === false ) {
1086                         return $message;
1087                 }
1088
1089                 if ( $this->mInParser ) {
1090                         return $message;
1091                 }
1092
1093                 $parser = $this->getParser();
1094                 if ( $parser ) {
1095                         $popts = $this->getParserOptions();
1096                         $popts->setInterfaceMessage( $interface );
1097                         $popts->setTargetLanguage( $language );
1098
1099                         $userlang = $popts->setUserLang( $language );
1100                         $this->mInParser = true;
1101                         $message = $parser->transformMsg( $message, $popts, $title );
1102                         $this->mInParser = false;
1103                         $popts->setUserLang( $userlang );
1104                 }
1105
1106                 return $message;
1107         }
1108
1109         /**
1110          * @return Parser
1111          */
1112         public function getParser() {
1113                 global $wgParser, $wgParserConf;
1114
1115                 if ( !$this->mParser && isset( $wgParser ) ) {
1116                         # Do some initialisation so that we don't have to do it twice
1117                         $wgParser->firstCallInit();
1118                         # Clone it and store it
1119                         $class = $wgParserConf['class'];
1120                         if ( $class == ParserDiffTest::class ) {
1121                                 # Uncloneable
1122                                 $this->mParser = new $class( $wgParserConf );
1123                         } else {
1124                                 $this->mParser = clone $wgParser;
1125                         }
1126                 }
1127
1128                 return $this->mParser;
1129         }
1130
1131         /**
1132          * @param string $text
1133          * @param Title|null $title
1134          * @param bool $linestart Whether or not this is at the start of a line
1135          * @param bool $interface Whether this is an interface message
1136          * @param Language|string|null $language Language code
1137          * @return ParserOutput|string
1138          */
1139         public function parse( $text, $title = null, $linestart = true,
1140                 $interface = false, $language = null
1141         ) {
1142                 global $wgTitle;
1143
1144                 if ( $this->mInParser ) {
1145                         return htmlspecialchars( $text );
1146                 }
1147
1148                 $parser = $this->getParser();
1149                 $popts = $this->getParserOptions();
1150                 $popts->setInterfaceMessage( $interface );
1151
1152                 if ( is_string( $language ) ) {
1153                         $language = Language::factory( $language );
1154                 }
1155                 $popts->setTargetLanguage( $language );
1156
1157                 if ( !$title || !$title instanceof Title ) {
1158                         wfDebugLog( 'GlobalTitleFail', __METHOD__ . ' called by ' .
1159                                 wfGetAllCallers( 6 ) . ' with no title set.' );
1160                         $title = $wgTitle;
1161                 }
1162                 // Sometimes $wgTitle isn't set either...
1163                 if ( !$title ) {
1164                         # It's not uncommon having a null $wgTitle in scripts. See r80898
1165                         # Create a ghost title in such case
1166                         $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/title not set in ' . __METHOD__ );
1167                 }
1168
1169                 $this->mInParser = true;
1170                 $res = $parser->parse( $text, $title, $popts, $linestart );
1171                 $this->mInParser = false;
1172
1173                 return $res;
1174         }
1175
1176         public function disable() {
1177                 $this->mDisable = true;
1178         }
1179
1180         public function enable() {
1181                 $this->mDisable = false;
1182         }
1183
1184         /**
1185          * Whether DB/cache usage is disabled for determining messages
1186          *
1187          * If so, this typically indicates either:
1188          *   - a) load() failed to find a cached copy nor query the DB
1189          *   - b) we are in a special context or error mode that cannot use the DB
1190          * If the DB is ignored, any derived HTML output or cached objects may be wrong.
1191          * To avoid long-term cache pollution, TTLs can be adjusted accordingly.
1192          *
1193          * @return bool
1194          * @since 1.27
1195          */
1196         public function isDisabled() {
1197                 return $this->mDisable;
1198         }
1199
1200         /**
1201          * Clear all stored messages in global and local cache
1202          *
1203          * Mainly used after a mass rebuild
1204          */
1205         public function clear() {
1206                 $langs = Language::fetchLanguageNames( null, 'mw' );
1207                 foreach ( array_keys( $langs ) as $code ) {
1208                         $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
1209                 }
1210                 $this->cache->clear();
1211         }
1212
1213         /**
1214          * @param string $key
1215          * @return array
1216          */
1217         public function figureMessage( $key ) {
1218                 global $wgLanguageCode;
1219
1220                 $pieces = explode( '/', $key );
1221                 if ( count( $pieces ) < 2 ) {
1222                         return [ $key, $wgLanguageCode ];
1223                 }
1224
1225                 $lang = array_pop( $pieces );
1226                 if ( !Language::fetchLanguageName( $lang, null, 'mw' ) ) {
1227                         return [ $key, $wgLanguageCode ];
1228                 }
1229
1230                 $message = implode( '/', $pieces );
1231
1232                 return [ $message, $lang ];
1233         }
1234
1235         /**
1236          * Get all message keys stored in the message cache for a given language.
1237          * If $code is the content language code, this will return all message keys
1238          * for which MediaWiki:msgkey exists. If $code is another language code, this
1239          * will ONLY return message keys for which MediaWiki:msgkey/$code exists.
1240          * @param string $code Language code
1241          * @return array Array of message keys (strings)
1242          */
1243         public function getAllMessageKeys( $code ) {
1244                 global $wgContLang;
1245
1246                 $this->load( $code );
1247                 if ( !$this->cache->has( $code ) ) {
1248                         // Apparently load() failed
1249                         return null;
1250                 }
1251                 // Remove administrative keys
1252                 $cache = $this->cache->get( $code );
1253                 unset( $cache['VERSION'] );
1254                 unset( $cache['EXPIRY'] );
1255                 unset( $cache['EXCESSIVE'] );
1256                 // Remove any !NONEXISTENT keys
1257                 $cache = array_diff( $cache, [ '!NONEXISTENT' ] );
1258
1259                 // Keys may appear with a capital first letter. lcfirst them.
1260                 return array_map( [ $wgContLang, 'lcfirst' ], array_keys( $cache ) );
1261         }
1262
1263         /**
1264          * Purge message caches when a MediaWiki: page is created, updated, or deleted
1265          *
1266          * @param Title $title Message page title
1267          * @param Content|null $content New content for edit/create, null on deletion
1268          * @since 1.29
1269          */
1270         public function updateMessageOverride( Title $title, Content $content = null ) {
1271                 global $wgContLang;
1272
1273                 $msgText = $this->getMessageTextFromContent( $content );
1274                 if ( $msgText === null ) {
1275                         $msgText = false; // treat as not existing
1276                 }
1277
1278                 $this->replace( $title->getDBkey(), $msgText );
1279
1280                 if ( $wgContLang->hasVariants() ) {
1281                         $wgContLang->updateConversionTable( $title );
1282                 }
1283         }
1284
1285         /**
1286          * @param string $code Language code
1287          * @return string WAN cache key usable as a "check key" against language page edits
1288          */
1289         public function getCheckKey( $code ) {
1290                 return $this->wanCache->makeKey( 'messages', $code );
1291         }
1292
1293         /**
1294          * @param Content|null $content Content or null if the message page does not exist
1295          * @return string|bool|null Returns false if $content is null and null on error
1296          */
1297         private function getMessageTextFromContent( Content $content = null ) {
1298                 // @TODO: could skip pseudo-messages like js/css here, based on content model
1299                 if ( $content ) {
1300                         // Message page exists...
1301                         // XXX: Is this the right way to turn a Content object into a message?
1302                         // NOTE: $content is typically either WikitextContent, JavaScriptContent or
1303                         //       CssContent. MessageContent is *not* used for storing messages, it's
1304                         //       only used for wrapping them when needed.
1305                         $msgText = $content->getWikitextForTransclusion();
1306                         if ( $msgText === false || $msgText === null ) {
1307                                 // This might be due to some kind of misconfiguration...
1308                                 $msgText = null;
1309                                 LoggerFactory::getInstance( 'MessageCache' )->warning(
1310                                         __METHOD__ . ": message content doesn't provide wikitext "
1311                                         . "(content model: " . $content->getModel() . ")" );
1312                         }
1313                 } else {
1314                         // Message page does not exist...
1315                         $msgText = false;
1316                 }
1317
1318                 return $msgText;
1319         }
1320
1321         /**
1322          * @param string $hash Hash for this version of the entire key/value overrides map
1323          * @param string $title Message cache key with initial uppercase letter
1324          * @return string
1325          */
1326         private function bigMessageCacheKey( $hash, $title ) {
1327                 return $this->wanCache->makeKey( 'messages-big', $hash, $title );
1328         }
1329 }