MediaWiki  master
MessageCache.php
Go to the documentation of this file.
1 <?php
27 
32 define( 'MSG_CACHE_VERSION', 2 );
33 
40 class MessageCache {
41  const FOR_UPDATE = 1; // force message reload
42 
44  const WAIT_SEC = 15;
46  const LOCK_TTL = 30;
47 
53  protected $cache;
54 
60  protected $overridable;
61 
65  protected $cacheVolatile = [];
66 
71  protected $mDisable;
72 
77  protected $mExpiry;
78 
83  protected $mParserOptions;
85  protected $mParser;
86 
90  protected $mInParser = false;
91 
93  protected $wanCache;
95  protected $clusterCache;
97  protected $srvCache;
99  protected $contLang;
100 
106  private static $instance;
107 
114  public static function singleton() {
115  if ( self::$instance === null ) {
117  $services = MediaWikiServices::getInstance();
118  self::$instance = new self(
119  $services->getMainWANObjectCache(),
121  $wgUseLocalMessageCache
122  ? $services->getLocalServerObjectCache()
123  : new EmptyBagOStuff(),
126  $services->getContentLanguage()
127  );
128  }
129 
130  return self::$instance;
131  }
132 
138  public static function destroyInstance() {
139  self::$instance = null;
140  }
141 
148  public static function normalizeKey( $key ) {
149  $lckey = strtr( $key, ' ', '_' );
150  if ( ord( $lckey ) < 128 ) {
151  $lckey[0] = strtolower( $lckey[0] );
152  } else {
153  $lckey = MediaWikiServices::getInstance()->getContentLanguage()->lcfirst( $lckey );
154  }
155 
156  return $lckey;
157  }
158 
167  public function __construct(
170  BagOStuff $serverCache,
171  $useDB,
172  $expiry,
174  ) {
175  $this->wanCache = $wanCache;
176  $this->clusterCache = $clusterCache;
177  $this->srvCache = $serverCache;
178 
179  $this->cache = new MapCacheLRU( 5 ); // limit size for sanity
180 
181  $this->mDisable = !$useDB;
182  $this->mExpiry = $expiry;
183  $this->contLang = $contLang ?? MediaWikiServices::getInstance()->getContentLanguage();
184  }
185 
191  function getParserOptions() {
192  global $wgUser;
193 
194  if ( !$this->mParserOptions ) {
195  if ( !$wgUser->isSafeToLoad() ) {
196  // $wgUser isn't unstubbable yet, so don't try to get a
197  // ParserOptions for it. And don't cache this ParserOptions
198  // either.
200  $po->setAllowUnsafeRawHtml( false );
201  $po->setTidy( true );
202  return $po;
203  }
204 
205  $this->mParserOptions = new ParserOptions;
206  // Messages may take parameters that could come
207  // from malicious sources. As a precaution, disable
208  // the <html> parser tag when parsing messages.
209  $this->mParserOptions->setAllowUnsafeRawHtml( false );
210  // For the same reason, tidy the output!
211  $this->mParserOptions->setTidy( true );
212  }
213 
214  return $this->mParserOptions;
215  }
216 
223  protected function getLocalCache( $code ) {
224  $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
225 
226  return $this->srvCache->get( $cacheKey );
227  }
228 
235  protected function saveToLocalCache( $code, $cache ) {
236  $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
237  $this->srvCache->set( $cacheKey, $cache );
238  }
239 
261  protected function load( $code, $mode = null ) {
262  if ( !is_string( $code ) ) {
263  throw new InvalidArgumentException( "Missing language code" );
264  }
265 
266  # Don't do double loading...
267  if ( $this->cache->has( $code ) && $mode != self::FOR_UPDATE ) {
268  return true;
269  }
270 
271  $this->overridable = array_flip( Language::getMessageKeysFor( $code ) );
272 
273  // T208897 array_flip can fail and return null
274  if ( is_null( $this->overridable ) ) {
275  LoggerFactory::getInstance( 'MessageCache' )->error(
276  __METHOD__ . ': $this->overridable is null',
277  [
278  'message_keys' => Language::getMessageKeysFor( $code ),
279  'code' => $code
280  ]
281  );
282  }
283 
284  # 8 lines of code just to say (once) that message cache is disabled
285  if ( $this->mDisable ) {
286  static $shownDisabled = false;
287  if ( !$shownDisabled ) {
288  wfDebug( __METHOD__ . ": disabled\n" );
289  $shownDisabled = true;
290  }
291 
292  return true;
293  }
294 
295  # Loading code starts
296  $success = false; # Keep track of success
297  $staleCache = false; # a cache array with expired data, or false if none has been loaded
298  $where = []; # Debug info, delayed to avoid spamming debug log too much
299 
300  # Hash of the contents is stored in memcache, to detect if data-center cache
301  # or local cache goes out of date (e.g. due to replace() on some other server)
302  list( $hash, $hashVolatile ) = $this->getValidationHash( $code );
303  $this->cacheVolatile[$code] = $hashVolatile;
304 
305  # Try the local cache and check against the cluster hash key...
306  $cache = $this->getLocalCache( $code );
307  if ( !$cache ) {
308  $where[] = 'local cache is empty';
309  } elseif ( !isset( $cache['HASH'] ) || $cache['HASH'] !== $hash ) {
310  $where[] = 'local cache has the wrong hash';
311  $staleCache = $cache;
312  } elseif ( $this->isCacheExpired( $cache ) ) {
313  $where[] = 'local cache is expired';
314  $staleCache = $cache;
315  } elseif ( $hashVolatile ) {
316  $where[] = 'local cache validation key is expired/volatile';
317  $staleCache = $cache;
318  } else {
319  $where[] = 'got from local cache';
320  $this->cache->set( $code, $cache );
321  $success = true;
322  }
323 
324  if ( !$success ) {
325  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
326  # Try the global cache. If it is empty, try to acquire a lock. If
327  # the lock can't be acquired, wait for the other thread to finish
328  # and then try the global cache a second time.
329  for ( $failedAttempts = 0; $failedAttempts <= 1; $failedAttempts++ ) {
330  if ( $hashVolatile && $staleCache ) {
331  # Do not bother fetching the whole cache blob to avoid I/O.
332  # Instead, just try to get the non-blocking $statusKey lock
333  # below, and use the local stale value if it was not acquired.
334  $where[] = 'global cache is presumed expired';
335  } else {
336  $cache = $this->clusterCache->get( $cacheKey );
337  if ( !$cache ) {
338  $where[] = 'global cache is empty';
339  } elseif ( $this->isCacheExpired( $cache ) ) {
340  $where[] = 'global cache is expired';
341  $staleCache = $cache;
342  } elseif ( $hashVolatile ) {
343  # DB results are replica DB lag prone until the holdoff TTL passes.
344  # By then, updates should be reflected in loadFromDBWithLock().
345  # One thread regenerates the cache while others use old values.
346  $where[] = 'global cache is expired/volatile';
347  $staleCache = $cache;
348  } else {
349  $where[] = 'got from global cache';
350  $this->cache->set( $code, $cache );
351  $this->saveToCaches( $cache, 'local-only', $code );
352  $success = true;
353  }
354  }
355 
356  if ( $success ) {
357  # Done, no need to retry
358  break;
359  }
360 
361  # We need to call loadFromDB. Limit the concurrency to one process.
362  # This prevents the site from going down when the cache expires.
363  # Note that the DB slam protection lock here is non-blocking.
364  $loadStatus = $this->loadFromDBWithLock( $code, $where, $mode );
365  if ( $loadStatus === true ) {
366  $success = true;
367  break;
368  } elseif ( $staleCache ) {
369  # Use the stale cache while some other thread constructs the new one
370  $where[] = 'using stale cache';
371  $this->cache->set( $code, $staleCache );
372  $success = true;
373  break;
374  } elseif ( $failedAttempts > 0 ) {
375  # Already blocked once, so avoid another lock/unlock cycle.
376  # This case will typically be hit if memcached is down, or if
377  # loadFromDB() takes longer than LOCK_WAIT.
378  $where[] = "could not acquire status key.";
379  break;
380  } elseif ( $loadStatus === 'cantacquire' ) {
381  # Wait for the other thread to finish, then retry. Normally,
382  # the memcached get() will then yield the other thread's result.
383  $where[] = 'waited for other thread to complete';
384  $this->getReentrantScopedLock( $cacheKey );
385  } else {
386  # Disable cache; $loadStatus is 'disabled'
387  break;
388  }
389  }
390  }
391 
392  if ( !$success ) {
393  $where[] = 'loading FAILED - cache is disabled';
394  $this->mDisable = true;
395  $this->cache->set( $code, [] );
396  wfDebugLog( 'MessageCacheError', __METHOD__ . ": Failed to load $code\n" );
397  # This used to throw an exception, but that led to nasty side effects like
398  # the whole wiki being instantly down if the memcached server died
399  }
400 
401  if ( !$this->cache->has( $code ) ) { // sanity
402  throw new LogicException( "Process cache for '$code' should be set by now." );
403  }
404 
405  $info = implode( ', ', $where );
406  wfDebugLog( 'MessageCache', __METHOD__ . ": Loading $code... $info\n" );
407 
408  return $success;
409  }
410 
417  protected function loadFromDBWithLock( $code, array &$where, $mode = null ) {
418  # If cache updates on all levels fail, give up on message overrides.
419  # This is to avoid easy site outages; see $saveSuccess comments below.
420  $statusKey = $this->clusterCache->makeKey( 'messages', $code, 'status' );
421  $status = $this->clusterCache->get( $statusKey );
422  if ( $status === 'error' ) {
423  $where[] = "could not load; method is still globally disabled";
424  return 'disabled';
425  }
426 
427  # Now let's regenerate
428  $where[] = 'loading from database';
429 
430  # Lock the cache to prevent conflicting writes.
431  # This lock is non-blocking so stale cache can quickly be used.
432  # Note that load() will call a blocking getReentrantScopedLock()
433  # after this if it really need to wait for any current thread.
434  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
435  $scopedLock = $this->getReentrantScopedLock( $cacheKey, 0 );
436  if ( !$scopedLock ) {
437  $where[] = 'could not acquire main lock';
438  return 'cantacquire';
439  }
440 
441  $cache = $this->loadFromDB( $code, $mode );
442  $this->cache->set( $code, $cache );
443  $saveSuccess = $this->saveToCaches( $cache, 'all', $code );
444 
445  if ( !$saveSuccess ) {
459  if ( $this->srvCache instanceof EmptyBagOStuff ) {
460  $this->clusterCache->set( $statusKey, 'error', 60 * 5 );
461  $where[] = 'could not save cache, disabled globally for 5 minutes';
462  } else {
463  $where[] = "could not save global cache";
464  }
465  }
466 
467  return true;
468  }
469 
479  protected function loadFromDB( $code, $mode = null ) {
481 
482  // (T164666) The query here performs really poorly on WMF's
483  // contributions replicas. We don't have a way to say "any group except
484  // contributions", so for the moment let's specify 'api'.
485  // @todo: Get rid of this hack.
486  $dbr = wfGetDB( ( $mode == self::FOR_UPDATE ) ? DB_MASTER : DB_REPLICA, 'api' );
487 
488  $cache = [];
489 
490  $mostused = []; // list of "<cased message key>/<code>"
491  if ( $wgAdaptiveMessageCache && $code !== $wgLanguageCode ) {
492  if ( !$this->cache->has( $wgLanguageCode ) ) {
493  $this->load( $wgLanguageCode );
494  }
495  $mostused = array_keys( $this->cache->get( $wgLanguageCode ) );
496  foreach ( $mostused as $key => $value ) {
497  $mostused[$key] = "$value/$code";
498  }
499  }
500 
501  // Get the list of software-defined messages in core/extensions
502  $overridable = array_flip( Language::getMessageKeysFor( $wgLanguageCode ) );
503 
504  // Common conditions
505  $conds = [
506  'page_is_redirect' => 0,
507  'page_namespace' => NS_MEDIAWIKI,
508  ];
509  if ( count( $mostused ) ) {
510  $conds['page_title'] = $mostused;
511  } elseif ( $code !== $wgLanguageCode ) {
512  $conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), '/', $code );
513  } else {
514  # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
515  # other than language code.
516  $conds[] = 'page_title NOT' .
517  $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
518  }
519 
520  // Set the stubs for oversized software-defined messages in the main cache map
521  $res = $dbr->select(
522  'page',
523  [ 'page_title', 'page_latest' ],
524  array_merge( $conds, [ 'page_len > ' . intval( $wgMaxMsgCacheEntrySize ) ] ),
525  __METHOD__ . "($code)-big"
526  );
527  foreach ( $res as $row ) {
528  $name = $this->contLang->lcfirst( $row->page_title );
529  // Include entries/stubs for all keys in $mostused in adaptive mode
530  if ( $wgAdaptiveMessageCache || $this->isMainCacheable( $name, $overridable ) ) {
531  $cache[$row->page_title] = '!TOO BIG';
532  }
533  // At least include revision ID so page changes are reflected in the hash
534  $cache['EXCESSIVE'][$row->page_title] = $row->page_latest;
535  }
536 
537  // Set the text for small software-defined messages in the main cache map
538  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
539  $revQuery = $revisionStore->getQueryInfo( [ 'page', 'user' ] );
540  $res = $dbr->select(
541  $revQuery['tables'],
542  $revQuery['fields'],
543  array_merge( $conds, [
544  'page_len <= ' . intval( $wgMaxMsgCacheEntrySize ),
545  'page_latest = rev_id' // get the latest revision only
546  ] ),
547  __METHOD__ . "($code)-small",
548  [],
549  $revQuery['joins']
550  );
551  foreach ( $res as $row ) {
552  $name = $this->contLang->lcfirst( $row->page_title );
553  // Include entries/stubs for all keys in $mostused in adaptive mode
554  if ( $wgAdaptiveMessageCache || $this->isMainCacheable( $name, $overridable ) ) {
555  try {
556  $rev = $revisionStore->newRevisionFromRow( $row );
557  $content = $rev->getContent( MediaWiki\Revision\SlotRecord::MAIN );
558  $text = $this->getMessageTextFromContent( $content );
559  } catch ( Exception $ex ) {
560  $text = false;
561  }
562 
563  if ( !is_string( $text ) ) {
564  $entry = '!ERROR';
565  wfDebugLog(
566  'MessageCache',
567  __METHOD__
568  . ": failed to load message page text for {$row->page_title} ($code)"
569  );
570  } else {
571  $entry = ' ' . $text;
572  }
573  $cache[$row->page_title] = $entry;
574  } else {
575  // T193271: cache object gets too big and slow to generate.
576  // At least include revision ID so page changes are reflected in the hash.
577  $cache['EXCESSIVE'][$row->page_title] = $row->page_latest;
578  }
579  }
580 
581  $cache['VERSION'] = MSG_CACHE_VERSION;
582  ksort( $cache );
583 
584  # Hash for validating local cache (APC). No need to take into account
585  # messages larger than $wgMaxMsgCacheEntrySize, since those are only
586  # stored and fetched from memcache.
587  $cache['HASH'] = md5( serialize( $cache ) );
588  $cache['EXPIRY'] = wfTimestamp( TS_MW, time() + $this->mExpiry );
589  unset( $cache['EXCESSIVE'] ); // only needed for hash
590 
591  return $cache;
592  }
593 
599  private function isMainCacheable( $name, array $overridable ) {
600  // Include common conversion table pages. This also avoids problems with
601  // Installer::parse() bailing out due to disallowed DB queries (T207979).
602  return ( isset( $overridable[$name] ) || strpos( $name, 'conversiontable/' ) === 0 );
603  }
604 
611  public function replace( $title, $text ) {
612  global $wgLanguageCode;
613 
614  if ( $this->mDisable ) {
615  return;
616  }
617 
618  list( $msg, $code ) = $this->figureMessage( $title );
619  if ( strpos( $title, '/' ) !== false && $code === $wgLanguageCode ) {
620  // Content language overrides do not use the /<code> suffix
621  return;
622  }
623 
624  // (a) Update the process cache with the new message text
625  if ( $text === false ) {
626  // Page deleted
627  $this->cache->setField( $code, $title, '!NONEXISTENT' );
628  } else {
629  // Ignore $wgMaxMsgCacheEntrySize so the process cache is up to date
630  $this->cache->setField( $code, $title, ' ' . $text );
631  }
632 
633  // (b) Update the shared caches in a deferred update with a fresh DB snapshot
635  new MessageCacheUpdate( $code, $title, $msg ),
637  );
638  }
639 
645  public function refreshAndReplaceInternal( $code, array $replacements ) {
647 
648  // Allow one caller at a time to avoid race conditions
649  $scopedLock = $this->getReentrantScopedLock(
650  $this->clusterCache->makeKey( 'messages', $code )
651  );
652  if ( !$scopedLock ) {
653  foreach ( $replacements as list( $title ) ) {
654  LoggerFactory::getInstance( 'MessageCache' )->error(
655  __METHOD__ . ': could not acquire lock to update {title} ({code})',
656  [ 'title' => $title, 'code' => $code ] );
657  }
658 
659  return;
660  }
661 
662  // Load the existing cache to update it in the local DC cache.
663  // The other DCs will see a hash mismatch.
664  if ( $this->load( $code, self::FOR_UPDATE ) ) {
665  $cache = $this->cache->get( $code );
666  } else {
667  // Err? Fall back to loading from the database.
668  $cache = $this->loadFromDB( $code, self::FOR_UPDATE );
669  }
670  // Check if individual cache keys should exist and update cache accordingly
671  $newTextByTitle = []; // map of (title => content)
672  $newBigTitles = []; // map of (title => latest revision ID), like EXCESSIVE in loadFromDB()
673  foreach ( $replacements as list( $title ) ) {
675  $page->loadPageData( $page::READ_LATEST );
676  $text = $this->getMessageTextFromContent( $page->getContent() );
677  // Remember the text for the blob store update later on
678  $newTextByTitle[$title] = $text;
679  // Note that if $text is false, then $cache should have a !NONEXISTANT entry
680  if ( !is_string( $text ) ) {
681  $cache[$title] = '!NONEXISTENT';
682  } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
683  $cache[$title] = '!TOO BIG';
684  $newBigTitles[$title] = $page->getLatest();
685  } else {
686  $cache[$title] = ' ' . $text;
687  }
688  }
689  // Update HASH for the new key. Incorporates various administrative keys,
690  // including the old HASH (and thereby the EXCESSIVE value from loadFromDB()
691  // and previous replace() calls), but that doesn't really matter since we
692  // only ever compare it for equality with a copy saved by saveToCaches().
693  $cache['HASH'] = md5( serialize( $cache + [ 'EXCESSIVE' => $newBigTitles ] ) );
694  // Update the too-big WAN cache entries now that we have the new HASH
695  foreach ( $newBigTitles as $title => $id ) {
696  // Match logic of loadCachedMessagePageEntry()
697  $this->wanCache->set(
698  $this->bigMessageCacheKey( $cache['HASH'], $title ),
699  ' ' . $newTextByTitle[$title],
700  $this->mExpiry
701  );
702  }
703  // Mark this cache as definitely being "latest" (non-volatile) so
704  // load() calls do not try to refresh the cache with replica DB data
705  $cache['LATEST'] = time();
706  // Update the process cache
707  $this->cache->set( $code, $cache );
708  // Pre-emptively update the local datacenter cache so things like edit filter and
709  // blacklist changes are reflected immediately; these often use MediaWiki: pages.
710  // The datacenter handling replace() calls should be the same one handling edits
711  // as they require HTTP POST.
712  $this->saveToCaches( $cache, 'all', $code );
713  // Release the lock now that the cache is saved
714  ScopedCallback::consume( $scopedLock );
715 
716  // Relay the purge. Touching this check key expires cache contents
717  // and local cache (APC) validation hash across all datacenters.
718  $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
719 
720  // Purge the messages in the message blob store and fire any hook handlers
721  $blobStore = MediaWikiServices::getInstance()->getResourceLoader()->getMessageBlobStore();
722  foreach ( $replacements as list( $title, $msg ) ) {
723  $blobStore->updateMessage( $this->contLang->lcfirst( $msg ) );
724  Hooks::run( 'MessageCacheReplace', [ $title, $newTextByTitle[$title] ] );
725  }
726  }
727 
734  protected function isCacheExpired( $cache ) {
735  if ( !isset( $cache['VERSION'] ) || !isset( $cache['EXPIRY'] ) ) {
736  return true;
737  }
738  if ( $cache['VERSION'] != MSG_CACHE_VERSION ) {
739  return true;
740  }
741  if ( wfTimestampNow() >= $cache['EXPIRY'] ) {
742  return true;
743  }
744 
745  return false;
746  }
747 
757  protected function saveToCaches( array $cache, $dest, $code = false ) {
758  if ( $dest === 'all' ) {
759  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
760  $success = $this->clusterCache->set( $cacheKey, $cache );
761  $this->setValidationHash( $code, $cache );
762  } else {
763  $success = true;
764  }
765 
766  $this->saveToLocalCache( $code, $cache );
767 
768  return $success;
769  }
770 
777  protected function getValidationHash( $code ) {
778  $curTTL = null;
779  $value = $this->wanCache->get(
780  $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
781  $curTTL,
782  [ $this->getCheckKey( $code ) ]
783  );
784 
785  if ( $value ) {
786  $hash = $value['hash'];
787  if ( ( time() - $value['latest'] ) < WANObjectCache::TTL_MINUTE ) {
788  // Cache was recently updated via replace() and should be up-to-date.
789  // That method is only called in the primary datacenter and uses FOR_UPDATE.
790  // Also, it is unlikely that the current datacenter is *now* secondary one.
791  $expired = false;
792  } else {
793  // See if the "check" key was bumped after the hash was generated
794  $expired = ( $curTTL < 0 );
795  }
796  } else {
797  // No hash found at all; cache must regenerate to be safe
798  $hash = false;
799  $expired = true;
800  }
801 
802  return [ $hash, $expired ];
803  }
804 
815  protected function setValidationHash( $code, array $cache ) {
816  $this->wanCache->set(
817  $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
818  [
819  'hash' => $cache['HASH'],
820  'latest' => $cache['LATEST'] ?? 0
821  ],
823  );
824  }
825 
831  protected function getReentrantScopedLock( $key, $timeout = self::WAIT_SEC ) {
832  return $this->clusterCache->getScopedLock( $key, $timeout, self::LOCK_TTL, __METHOD__ );
833  }
834 
868  function get( $key, $useDB = true, $langcode = true ) {
869  if ( is_int( $key ) ) {
870  // Fix numerical strings that somehow become ints
871  // on their way here
872  $key = (string)$key;
873  } elseif ( !is_string( $key ) ) {
874  throw new MWException( 'Non-string key given' );
875  } elseif ( $key === '' ) {
876  // Shortcut: the empty key is always missing
877  return false;
878  }
879 
880  // Normalise title-case input (with some inlining)
881  $lckey = self::normalizeKey( $key );
882 
883  Hooks::run( 'MessageCache::get', [ &$lckey ] );
884 
885  // Loop through each language in the fallback list until we find something useful
886  $message = $this->getMessageFromFallbackChain(
887  wfGetLangObj( $langcode ),
888  $lckey,
889  !$this->mDisable && $useDB
890  );
891 
892  // If we still have no message, maybe the key was in fact a full key so try that
893  if ( $message === false ) {
894  $parts = explode( '/', $lckey );
895  // We may get calls for things that are http-urls from sidebar
896  // Let's not load nonexistent languages for those
897  // They usually have more than one slash.
898  if ( count( $parts ) == 2 && $parts[1] !== '' ) {
899  $message = Language::getMessageFor( $parts[0], $parts[1] );
900  if ( $message === null ) {
901  $message = false;
902  }
903  }
904  }
905 
906  // Post-processing if the message exists
907  if ( $message !== false ) {
908  // Fix whitespace
909  $message = str_replace(
910  [
911  # Fix for trailing whitespace, removed by textarea
912  '&#32;',
913  # Fix for NBSP, converted to space by firefox
914  '&nbsp;',
915  '&#160;',
916  '&shy;'
917  ],
918  [
919  ' ',
920  "\u{00A0}",
921  "\u{00A0}",
922  "\u{00AD}"
923  ],
924  $message
925  );
926  }
927 
928  return $message;
929  }
930 
943  protected function getMessageFromFallbackChain( $lang, $lckey, $useDB ) {
944  $alreadyTried = [];
945 
946  // First try the requested language.
947  $message = $this->getMessageForLang( $lang, $lckey, $useDB, $alreadyTried );
948  if ( $message !== false ) {
949  return $message;
950  }
951 
952  // Now try checking the site language.
953  $message = $this->getMessageForLang( $this->contLang, $lckey, $useDB, $alreadyTried );
954  return $message;
955  }
956 
967  private function getMessageForLang( $lang, $lckey, $useDB, &$alreadyTried ) {
968  $langcode = $lang->getCode();
969 
970  // Try checking the database for the requested language
971  if ( $useDB ) {
972  $uckey = $this->contLang->ucfirst( $lckey );
973 
974  if ( !isset( $alreadyTried[$langcode] ) ) {
975  $message = $this->getMsgFromNamespace(
976  $this->getMessagePageName( $langcode, $uckey ),
977  $langcode
978  );
979  if ( $message !== false ) {
980  return $message;
981  }
982  $alreadyTried[$langcode] = true;
983  }
984  } else {
985  $uckey = null;
986  }
987 
988  // Check the CDB cache
989  $message = $lang->getMessage( $lckey );
990  if ( $message !== null ) {
991  return $message;
992  }
993 
994  // Try checking the database for all of the fallback languages
995  if ( $useDB ) {
996  $fallbackChain = Language::getFallbacksFor( $langcode );
997 
998  foreach ( $fallbackChain as $code ) {
999  if ( isset( $alreadyTried[$code] ) ) {
1000  continue;
1001  }
1002 
1003  $message = $this->getMsgFromNamespace(
1004  $this->getMessagePageName( $code, $uckey ), $code );
1005 
1006  if ( $message !== false ) {
1007  return $message;
1008  }
1009  $alreadyTried[$code] = true;
1010  }
1011  }
1012 
1013  return false;
1014  }
1015 
1023  private function getMessagePageName( $langcode, $uckey ) {
1024  global $wgLanguageCode;
1025 
1026  if ( $langcode === $wgLanguageCode ) {
1027  // Messages created in the content language will not have the /lang extension
1028  return $uckey;
1029  } else {
1030  return "$uckey/$langcode";
1031  }
1032  }
1033 
1046  public function getMsgFromNamespace( $title, $code ) {
1047  // Load all MediaWiki page definitions into cache. Note that individual keys
1048  // already loaded into cache during this request remain in the cache, which
1049  // includes the value of hook-defined messages.
1050  $this->load( $code );
1051 
1052  $entry = $this->cache->getField( $code, $title );
1053 
1054  if ( $entry !== null ) {
1055  // Message page exists as an override of a software messages
1056  if ( substr( $entry, 0, 1 ) === ' ' ) {
1057  // The message exists and is not '!TOO BIG' or '!ERROR'
1058  return (string)substr( $entry, 1 );
1059  } elseif ( $entry === '!NONEXISTENT' ) {
1060  // The text might be '-' or missing due to some data loss
1061  return false;
1062  }
1063  // Load the message page, utilizing the individual message cache.
1064  // If the page does not exist, there will be no hook handler fallbacks.
1065  $entry = $this->loadCachedMessagePageEntry(
1066  $title,
1067  $code,
1068  $this->cache->getField( $code, 'HASH' )
1069  );
1070  } else {
1071  // Message page either does not exist or does not override a software message
1072  $name = $this->contLang->lcfirst( $title );
1073  if ( !$this->isMainCacheable( $name, $this->overridable ) ) {
1074  // Message page does not override any software-defined message. A custom
1075  // message might be defined to have content or settings specific to the wiki.
1076  // Load the message page, utilizing the individual message cache as needed.
1077  $entry = $this->loadCachedMessagePageEntry(
1078  $title,
1079  $code,
1080  $this->cache->getField( $code, 'HASH' )
1081  );
1082  }
1083  if ( $entry === null || substr( $entry, 0, 1 ) !== ' ' ) {
1084  // Message does not have a MediaWiki page definition; try hook handlers
1085  $message = false;
1086  Hooks::run( 'MessagesPreLoad', [ $title, &$message, $code ] );
1087  if ( $message !== false ) {
1088  $this->cache->setField( $code, $title, ' ' . $message );
1089  } else {
1090  $this->cache->setField( $code, $title, '!NONEXISTENT' );
1091  }
1092 
1093  return $message;
1094  }
1095  }
1096 
1097  if ( $entry !== false && substr( $entry, 0, 1 ) === ' ' ) {
1098  if ( $this->cacheVolatile[$code] ) {
1099  // Make sure that individual keys respect the WAN cache holdoff period too
1100  LoggerFactory::getInstance( 'MessageCache' )->debug(
1101  __METHOD__ . ': loading volatile key \'{titleKey}\'',
1102  [ 'titleKey' => $title, 'code' => $code ] );
1103  } else {
1104  $this->cache->setField( $code, $title, $entry );
1105  }
1106  // The message exists, so make sure a string is returned
1107  return (string)substr( $entry, 1 );
1108  }
1109 
1110  $this->cache->setField( $code, $title, '!NONEXISTENT' );
1111 
1112  return false;
1113  }
1114 
1121  private function loadCachedMessagePageEntry( $dbKey, $code, $hash ) {
1122  $fname = __METHOD__;
1123  return $this->srvCache->getWithSetCallback(
1124  $this->srvCache->makeKey( 'messages-big', $hash, $dbKey ),
1126  function () use ( $code, $dbKey, $hash, $fname ) {
1127  return $this->wanCache->getWithSetCallback(
1128  $this->bigMessageCacheKey( $hash, $dbKey ),
1129  $this->mExpiry,
1130  function ( $oldValue, &$ttl, &$setOpts ) use ( $dbKey, $code, $fname ) {
1131  // Try loading the message from the database
1132  $dbr = wfGetDB( DB_REPLICA );
1133  $setOpts += Database::getCacheSetOptions( $dbr );
1134  // Use newKnownCurrent() to avoid querying revision/user tables
1135  $title = Title::makeTitle( NS_MEDIAWIKI, $dbKey );
1136  $revision = Revision::newKnownCurrent( $dbr, $title );
1137  if ( !$revision ) {
1138  // The wiki doesn't have a local override page. Cache absence with normal TTL.
1139  // When overrides are created, self::replace() takes care of the cache.
1140  return '!NONEXISTENT';
1141  }
1142  $content = $revision->getContent();
1143  if ( $content ) {
1144  $message = $this->getMessageTextFromContent( $content );
1145  } else {
1146  LoggerFactory::getInstance( 'MessageCache' )->warning(
1147  $fname . ': failed to load page text for \'{titleKey}\'',
1148  [ 'titleKey' => $dbKey, 'code' => $code ]
1149  );
1150  $message = null;
1151  }
1152 
1153  if ( !is_string( $message ) ) {
1154  // Revision failed to load Content, or Content is incompatible with wikitext.
1155  // Possibly a temporary loading failure.
1156  $ttl = 5;
1157 
1158  return '!NONEXISTENT';
1159  }
1160 
1161  return ' ' . $message;
1162  }
1163  );
1164  }
1165  );
1166  }
1167 
1175  public function transform( $message, $interface = false, $language = null, $title = null ) {
1176  // Avoid creating parser if nothing to transform
1177  if ( strpos( $message, '{{' ) === false ) {
1178  return $message;
1179  }
1180 
1181  if ( $this->mInParser ) {
1182  return $message;
1183  }
1184 
1185  $parser = $this->getParser();
1186  if ( $parser ) {
1187  $popts = $this->getParserOptions();
1188  $popts->setInterfaceMessage( $interface );
1189  $popts->setTargetLanguage( $language );
1190 
1191  $userlang = $popts->setUserLang( $language );
1192  $this->mInParser = true;
1193  $message = $parser->transformMsg( $message, $popts, $title );
1194  $this->mInParser = false;
1195  $popts->setUserLang( $userlang );
1196  }
1197 
1198  return $message;
1199  }
1200 
1204  public function getParser() {
1205  global $wgParserConf;
1206  if ( !$this->mParser ) {
1207  $parser = MediaWikiServices::getInstance()->getParser();
1208  # Do some initialisation so that we don't have to do it twice
1209  $parser->firstCallInit();
1210  # Clone it and store it
1211  $class = $wgParserConf['class'];
1212  if ( $class == ParserDiffTest::class ) {
1213  # Uncloneable
1214  $this->mParser = new $class( $wgParserConf );
1215  } else {
1216  $this->mParser = clone $parser;
1217  }
1218  }
1219 
1220  return $this->mParser;
1221  }
1222 
1231  public function parse( $text, $title = null, $linestart = true,
1232  $interface = false, $language = null
1233  ) {
1234  global $wgTitle;
1235 
1236  if ( $this->mInParser ) {
1237  return htmlspecialchars( $text );
1238  }
1239 
1240  $parser = $this->getParser();
1241  $popts = $this->getParserOptions();
1242  $popts->setInterfaceMessage( $interface );
1243 
1244  if ( is_string( $language ) ) {
1245  $language = Language::factory( $language );
1246  }
1247  $popts->setTargetLanguage( $language );
1248 
1249  if ( !$title || !$title instanceof Title ) {
1250  wfDebugLog( 'GlobalTitleFail', __METHOD__ . ' called by ' .
1251  wfGetAllCallers( 6 ) . ' with no title set.' );
1252  $title = $wgTitle;
1253  }
1254  // Sometimes $wgTitle isn't set either...
1255  if ( !$title ) {
1256  # It's not uncommon having a null $wgTitle in scripts. See r80898
1257  # Create a ghost title in such case
1258  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/title not set in ' . __METHOD__ );
1259  }
1260 
1261  $this->mInParser = true;
1262  $res = $parser->parse( $text, $title, $popts, $linestart );
1263  $this->mInParser = false;
1264 
1265  return $res;
1266  }
1267 
1268  public function disable() {
1269  $this->mDisable = true;
1270  }
1271 
1272  public function enable() {
1273  $this->mDisable = false;
1274  }
1275 
1288  public function isDisabled() {
1289  return $this->mDisable;
1290  }
1291 
1297  public function clear() {
1298  $langs = Language::fetchLanguageNames( null, 'mw' );
1299  foreach ( array_keys( $langs ) as $code ) {
1300  $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
1301  }
1302  $this->cache->clear();
1303  }
1304 
1309  public function figureMessage( $key ) {
1310  global $wgLanguageCode;
1311 
1312  $pieces = explode( '/', $key );
1313  if ( count( $pieces ) < 2 ) {
1314  return [ $key, $wgLanguageCode ];
1315  }
1316 
1317  $lang = array_pop( $pieces );
1318  if ( !Language::fetchLanguageName( $lang, null, 'mw' ) ) {
1319  return [ $key, $wgLanguageCode ];
1320  }
1321 
1322  $message = implode( '/', $pieces );
1323 
1324  return [ $message, $lang ];
1325  }
1326 
1335  public function getAllMessageKeys( $code ) {
1336  $this->load( $code );
1337  if ( !$this->cache->has( $code ) ) {
1338  // Apparently load() failed
1339  return null;
1340  }
1341  // Remove administrative keys
1342  $cache = $this->cache->get( $code );
1343  unset( $cache['VERSION'] );
1344  unset( $cache['EXPIRY'] );
1345  unset( $cache['EXCESSIVE'] );
1346  // Remove any !NONEXISTENT keys
1347  $cache = array_diff( $cache, [ '!NONEXISTENT' ] );
1348 
1349  // Keys may appear with a capital first letter. lcfirst them.
1350  return array_map( [ $this->contLang, 'lcfirst' ], array_keys( $cache ) );
1351  }
1352 
1361  $msgText = $this->getMessageTextFromContent( $content );
1362  if ( $msgText === null ) {
1363  $msgText = false; // treat as not existing
1364  }
1365 
1366  $this->replace( $title->getDBkey(), $msgText );
1367 
1368  if ( $this->contLang->hasVariants() ) {
1369  $this->contLang->updateConversionTable( $title );
1370  }
1371  }
1372 
1377  public function getCheckKey( $code ) {
1378  return $this->wanCache->makeKey( 'messages', $code );
1379  }
1380 
1386  // @TODO: could skip pseudo-messages like js/css here, based on content model
1387  if ( $content ) {
1388  // Message page exists...
1389  // XXX: Is this the right way to turn a Content object into a message?
1390  // NOTE: $content is typically either WikitextContent, JavaScriptContent or
1391  // CssContent. MessageContent is *not* used for storing messages, it's
1392  // only used for wrapping them when needed.
1393  $msgText = $content->getWikitextForTransclusion();
1394  if ( $msgText === false || $msgText === null ) {
1395  // This might be due to some kind of misconfiguration...
1396  $msgText = null;
1397  LoggerFactory::getInstance( 'MessageCache' )->warning(
1398  __METHOD__ . ": message content doesn't provide wikitext "
1399  . "(content model: " . $content->getModel() . ")" );
1400  }
1401  } else {
1402  // Message page does not exist...
1403  $msgText = false;
1404  }
1405 
1406  return $msgText;
1407  }
1408 
1414  private function bigMessageCacheKey( $hash, $title ) {
1415  return $this->wanCache->makeKey( 'messages-big', $hash, $title );
1416  }
1417 }
load( $code, $mode=null)
Loads messages from caches or from database in this order: (1) local message cache (if $wgUseLocalMes...
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
saveToCaches(array $cache, $dest, $code=false)
Shortcut to update caches.
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Definition: hooks.txt:6
loadFromDBWithLock( $code, array &$where, $mode=null)
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
const MSG_CACHE_VERSION
MediaWiki message cache structure version.
static fetchLanguageNames( $inLanguage=self::AS_AUTONYMS, $include='mw')
Get an array of language names, indexed by code.
Definition: Language.php:840
figureMessage( $key)
$success
serialize()
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
transform( $message, $interface=false, $language=null, $title=null)
get( $key, $maxAge=0.0)
Get the value for a key.
setValidationHash( $code, array $cache)
Set the md5 used to validate the local disk cache.
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
if(!isset( $args[0])) $lang
static destroyInstance()
Destroy the singleton instance.
getAllMessageKeys( $code)
Get all message keys stored in the message cache for a given language.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
bigMessageCacheKey( $hash, $title)
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
saveToLocalCache( $code, $cache)
Save the cache to APC.
$value
getMessageTextFromContent(Content $content=null)
const NS_SPECIAL
Definition: Defines.php:49
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
isMainCacheable( $name, array $overridable)
BagOStuff $clusterCache
Message cache purging and in-place update handler for specific message page changes.
A helper class for throttling authentication attempts.
loadFromDB( $code, $mode=null)
Loads cacheable messages from the database.
Parser $mParser
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
Definition: hooks.txt:1799
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
const DB_MASTER
Definition: defines.php:26
static normalizeKey( $key)
Normalize message key input.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
$wgUseLocalMessageCache
Set this to true to maintain a copy of the message cache on the local server.
getParserOptions()
ParserOptions is lazy initialised.
refreshAndReplaceInternal( $code, array $replacements)
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
getMsgFromNamespace( $title, $code)
Get a message from the MediaWiki namespace, with caching.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1982
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
$wgLanguageCode
Site language code.
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static getMessageFor( $key, $code)
Get a message for a given language.
Definition: Language.php:4585
MapCacheLRU $cache
Process cache of loaded messages that are defined in MediaWiki namespace.
$wgMaxMsgCacheEntrySize
Maximum entry size in the message cache, in bytes.
loadCachedMessagePageEntry( $dbKey, $code, $hash)
replace( $title, $text)
Updates cache as necessary when message page is changed.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2217
static getMessageKeysFor( $code)
Get all message keys for a given language.
Definition: Language.php:4597
getDBkey()
Get the main part with underscores.
Definition: Title.php:1002
static newKnownCurrent(IDatabase $db, $pageIdOrTitle, $revId=0)
Load a revision based on a known page ID and current revision ID from the DB.
Definition: Revision.php:1325
getValidationHash( $code)
Get the md5 used to validate the local APC cache.
$wgAdaptiveMessageCache
Instead of caching everything, only cache those messages which have been customised in the site conte...
$res
Definition: database.txt:21
array $overridable
Map of (lowercase message key => index) for all software defined messages.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$wgUseDatabaseMessages
Translation using MediaWiki: namespace.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
getLocalCache( $code)
Try to load the cache from APC.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
static $instance
Singleton instance.
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
bool [] $cacheVolatile
Map of (language code => boolean)
$wgParserConf
Parser configuration.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1766
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:780
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
const NS_MEDIAWIKI
Definition: Defines.php:68
static newFromAnon()
Get a ParserOptions object for an anonymous user.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
getReentrantScopedLock( $key, $timeout=self::WAIT_SEC)
const WAIT_SEC
How long to wait for memcached locks.
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
static fetchLanguageName( $code, $inLanguage=self::AS_AUTONYMS, $include=self::ALL)
Definition: Language.php:937
getMessagePageName( $langcode, $uckey)
Get the message page name for a given language.
getMessageFromFallbackChain( $lang, $lckey, $useDB)
Given a language, try and fetch messages from that language.
const FOR_UPDATE
isDisabled()
Whether DB/cache usage is disabled for determining messages.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
updateMessageOverride(Title $title, Content $content=null)
Purge message caches when a MediaWiki: page is created, updated, or deleted.
parse( $text, $title=null, $linestart=true, $interface=false, $language=null)
ParserOptions $mParserOptions
Message cache has its own parser which it uses to transform messages.
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
BagOStuff $srvCache
$mExpiry
Lifetime for cache, used by object caching.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
$wgMsgCacheExpiry
Expiry time for the message cache key.
getMessageForLang( $lang, $lckey, $useDB, &$alreadyTried)
Given a language, try and fetch messages from that language and its fallbacks.
static getFallbacksFor( $code, $mode=self::MESSAGES_FALLBACKS)
Get the ordered list of fallback languages.
Definition: Language.php:4514
$revQuery
Language $contLang
__construct(WANObjectCache $wanCache, BagOStuff $clusterCache, BagOStuff $serverCache, $useDB, $expiry, Language $contLang=null)
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same so they can t rely on Unix and must forbid reads to even standard directories like tmp lest users read each others files We cannot assume that the user has the ability to install or run any programs not written as web accessible PHP scripts Since anything that works on cheap shared hosting will work if you have shell or root access too
Definition: distributors.txt:9
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
clear()
Clear all stored messages in global and local cache.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
getCheckKey( $code)
const DB_REPLICA
Definition: defines.php:25
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:57
$mDisable
Should mean that database cannot be used, but check.
$content
Definition: pageupdater.txt:72
WANObjectCache $wanCache
const LOCK_TTL
How long memcached locks last.
static singleton()
Get the signleton instance of this class.
isCacheExpired( $cache)
Is the given cache array expired due to time passing or a version change?
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200