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