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 
105  private $loadedLanguages = [];
106 
112  private static $instance;
113 
120  public static function singleton() {
121  if ( self::$instance === null ) {
123  $services = MediaWikiServices::getInstance();
124  self::$instance = new self(
125  $services->getMainWANObjectCache(),
127  $wgUseLocalMessageCache
128  ? $services->getLocalServerObjectCache()
129  : new EmptyBagOStuff(),
132  $services->getContentLanguage()
133  );
134  }
135 
136  return self::$instance;
137  }
138 
144  public static function destroyInstance() {
145  self::$instance = null;
146  }
147 
154  public static function normalizeKey( $key ) {
155  $lckey = strtr( $key, ' ', '_' );
156  if ( ord( $lckey ) < 128 ) {
157  $lckey[0] = strtolower( $lckey[0] );
158  } else {
159  $lckey = MediaWikiServices::getInstance()->getContentLanguage()->lcfirst( $lckey );
160  }
161 
162  return $lckey;
163  }
164 
173  public function __construct(
176  BagOStuff $serverCache,
177  $useDB,
178  $expiry,
180  ) {
181  $this->wanCache = $wanCache;
182  $this->clusterCache = $clusterCache;
183  $this->srvCache = $serverCache;
184 
185  $this->cache = new MapCacheLRU( 5 ); // limit size for sanity
186 
187  $this->mDisable = !$useDB;
188  $this->mExpiry = $expiry;
189  $this->contLang = $contLang ?? MediaWikiServices::getInstance()->getContentLanguage();
190  }
191 
197  function getParserOptions() {
198  global $wgUser;
199 
200  if ( !$this->mParserOptions ) {
201  if ( !$wgUser->isSafeToLoad() ) {
202  // $wgUser isn't unstubbable yet, so don't try to get a
203  // ParserOptions for it. And don't cache this ParserOptions
204  // either.
206  $po->setAllowUnsafeRawHtml( false );
207  $po->setTidy( true );
208  return $po;
209  }
210 
211  $this->mParserOptions = new ParserOptions;
212  // Messages may take parameters that could come
213  // from malicious sources. As a precaution, disable
214  // the <html> parser tag when parsing messages.
215  $this->mParserOptions->setAllowUnsafeRawHtml( false );
216  // For the same reason, tidy the output!
217  $this->mParserOptions->setTidy( true );
218  }
219 
220  return $this->mParserOptions;
221  }
222 
229  protected function getLocalCache( $code ) {
230  $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
231 
232  return $this->srvCache->get( $cacheKey );
233  }
234 
241  protected function saveToLocalCache( $code, $cache ) {
242  $cacheKey = $this->srvCache->makeKey( __CLASS__, $code );
243  $this->srvCache->set( $cacheKey, $cache );
244  }
245 
267  protected function load( $code, $mode = null ) {
268  if ( !is_string( $code ) ) {
269  throw new InvalidArgumentException( "Missing language code" );
270  }
271 
272  # Don't do double loading...
273  if ( isset( $this->loadedLanguages[$code] ) && $mode != self::FOR_UPDATE ) {
274  return true;
275  }
276 
277  $this->overridable = array_flip( Language::getMessageKeysFor( $code ) );
278 
279  # 8 lines of code just to say (once) that message cache is disabled
280  if ( $this->mDisable ) {
281  static $shownDisabled = false;
282  if ( !$shownDisabled ) {
283  wfDebug( __METHOD__ . ": disabled\n" );
284  $shownDisabled = true;
285  }
286 
287  return true;
288  }
289 
290  # Loading code starts
291  $success = false; # Keep track of success
292  $staleCache = false; # a cache array with expired data, or false if none has been loaded
293  $where = []; # Debug info, delayed to avoid spamming debug log too much
294 
295  # Hash of the contents is stored in memcache, to detect if data-center cache
296  # or local cache goes out of date (e.g. due to replace() on some other server)
297  list( $hash, $hashVolatile ) = $this->getValidationHash( $code );
298  $this->cacheVolatile[$code] = $hashVolatile;
299 
300  # Try the local cache and check against the cluster hash key...
301  $cache = $this->getLocalCache( $code );
302  if ( !$cache ) {
303  $where[] = 'local cache is empty';
304  } elseif ( !isset( $cache['HASH'] ) || $cache['HASH'] !== $hash ) {
305  $where[] = 'local cache has the wrong hash';
306  $staleCache = $cache;
307  } elseif ( $this->isCacheExpired( $cache ) ) {
308  $where[] = 'local cache is expired';
309  $staleCache = $cache;
310  } elseif ( $hashVolatile ) {
311  $where[] = 'local cache validation key is expired/volatile';
312  $staleCache = $cache;
313  } else {
314  $where[] = 'got from local cache';
315  $this->cache->set( $code, $cache );
316  $success = true;
317  }
318 
319  if ( !$success ) {
320  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
321  # Try the global cache. If it is empty, try to acquire a lock. If
322  # the lock can't be acquired, wait for the other thread to finish
323  # and then try the global cache a second time.
324  for ( $failedAttempts = 0; $failedAttempts <= 1; $failedAttempts++ ) {
325  if ( $hashVolatile && $staleCache ) {
326  # Do not bother fetching the whole cache blob to avoid I/O.
327  # Instead, just try to get the non-blocking $statusKey lock
328  # below, and use the local stale value if it was not acquired.
329  $where[] = 'global cache is presumed expired';
330  } else {
331  $cache = $this->clusterCache->get( $cacheKey );
332  if ( !$cache ) {
333  $where[] = 'global cache is empty';
334  } elseif ( $this->isCacheExpired( $cache ) ) {
335  $where[] = 'global cache is expired';
336  $staleCache = $cache;
337  } elseif ( $hashVolatile ) {
338  # DB results are replica DB lag prone until the holdoff TTL passes.
339  # By then, updates should be reflected in loadFromDBWithLock().
340  # One thread regenerates the cache while others use old values.
341  $where[] = 'global cache is expired/volatile';
342  $staleCache = $cache;
343  } else {
344  $where[] = 'got from global cache';
345  $this->cache->set( $code, $cache );
346  $this->saveToCaches( $cache, 'local-only', $code );
347  $success = true;
348  }
349  }
350 
351  if ( $success ) {
352  # Done, no need to retry
353  break;
354  }
355 
356  # We need to call loadFromDB. Limit the concurrency to one process.
357  # This prevents the site from going down when the cache expires.
358  # Note that the DB slam protection lock here is non-blocking.
359  $loadStatus = $this->loadFromDBWithLock( $code, $where, $mode );
360  if ( $loadStatus === true ) {
361  $success = true;
362  break;
363  } elseif ( $staleCache ) {
364  # Use the stale cache while some other thread constructs the new one
365  $where[] = 'using stale cache';
366  $this->cache->set( $code, $staleCache );
367  $success = true;
368  break;
369  } elseif ( $failedAttempts > 0 ) {
370  # Already blocked once, so avoid another lock/unlock cycle.
371  # This case will typically be hit if memcached is down, or if
372  # loadFromDB() takes longer than LOCK_WAIT.
373  $where[] = "could not acquire status key.";
374  break;
375  } elseif ( $loadStatus === 'cantacquire' ) {
376  # Wait for the other thread to finish, then retry. Normally,
377  # the memcached get() will then yield the other thread's result.
378  $where[] = 'waited for other thread to complete';
379  $this->getReentrantScopedLock( $cacheKey );
380  } else {
381  # Disable cache; $loadStatus is 'disabled'
382  break;
383  }
384  }
385  }
386 
387  if ( !$success ) {
388  $where[] = 'loading FAILED - cache is disabled';
389  $this->mDisable = true;
390  $this->cache->set( $code, [] );
391  wfDebugLog( 'MessageCacheError', __METHOD__ . ": Failed to load $code\n" );
392  # This used to throw an exception, but that led to nasty side effects like
393  # the whole wiki being instantly down if the memcached server died
394  } else {
395  # All good, just record the success
396  $this->loadedLanguages[$code] = true;
397  }
398 
399  if ( !$this->cache->has( $code ) ) { // sanity
400  throw new LogicException( "Process cache for '$code' should be set by now." );
401  }
402 
403  $info = implode( ', ', $where );
404  wfDebugLog( 'MessageCache', __METHOD__ . ": Loading $code... $info\n" );
405 
406  return $success;
407  }
408 
415  protected function loadFromDBWithLock( $code, array &$where, $mode = null ) {
416  # If cache updates on all levels fail, give up on message overrides.
417  # This is to avoid easy site outages; see $saveSuccess comments below.
418  $statusKey = $this->clusterCache->makeKey( 'messages', $code, 'status' );
419  $status = $this->clusterCache->get( $statusKey );
420  if ( $status === 'error' ) {
421  $where[] = "could not load; method is still globally disabled";
422  return 'disabled';
423  }
424 
425  # Now let's regenerate
426  $where[] = 'loading from database';
427 
428  # Lock the cache to prevent conflicting writes.
429  # This lock is non-blocking so stale cache can quickly be used.
430  # Note that load() will call a blocking getReentrantScopedLock()
431  # after this if it really need to wait for any current thread.
432  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
433  $scopedLock = $this->getReentrantScopedLock( $cacheKey, 0 );
434  if ( !$scopedLock ) {
435  $where[] = 'could not acquire main lock';
436  return 'cantacquire';
437  }
438 
439  $cache = $this->loadFromDB( $code, $mode );
440  $this->cache->set( $code, $cache );
441  $saveSuccess = $this->saveToCaches( $cache, 'all', $code );
442 
443  if ( !$saveSuccess ) {
457  if ( $this->srvCache instanceof EmptyBagOStuff ) {
458  $this->clusterCache->set( $statusKey, 'error', 60 * 5 );
459  $where[] = 'could not save cache, disabled globally for 5 minutes';
460  } else {
461  $where[] = "could not save global cache";
462  }
463  }
464 
465  return true;
466  }
467 
477  protected function loadFromDB( $code, $mode = null ) {
479 
480  // (T164666) The query here performs really poorly on WMF's
481  // contributions replicas. We don't have a way to say "any group except
482  // contributions", so for the moment let's specify 'api'.
483  // @todo: Get rid of this hack.
484  $dbr = wfGetDB( ( $mode == self::FOR_UPDATE ) ? DB_MASTER : DB_REPLICA, 'api' );
485 
486  $cache = [];
487 
488  $mostused = []; // list of "<cased message key>/<code>"
489  if ( $wgAdaptiveMessageCache && $code !== $wgLanguageCode ) {
490  if ( !$this->cache->has( $wgLanguageCode ) ) {
491  $this->load( $wgLanguageCode );
492  }
493  $mostused = array_keys( $this->cache->get( $wgLanguageCode ) );
494  foreach ( $mostused as $key => $value ) {
495  $mostused[$key] = "$value/$code";
496  }
497  }
498 
499  // Get the list of software-defined messages in core/extensions
500  $overridable = array_flip( Language::getMessageKeysFor( $wgLanguageCode ) );
501 
502  // Common conditions
503  $conds = [
504  'page_is_redirect' => 0,
505  'page_namespace' => NS_MEDIAWIKI,
506  ];
507  if ( count( $mostused ) ) {
508  $conds['page_title'] = $mostused;
509  } elseif ( $code !== $wgLanguageCode ) {
510  $conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), '/', $code );
511  } else {
512  # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
513  # other than language code.
514  $conds[] = 'page_title NOT' .
515  $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
516  }
517 
518  // Set the stubs for oversized software-defined messages in the main cache map
519  $res = $dbr->select(
520  'page',
521  [ 'page_title', 'page_latest' ],
522  array_merge( $conds, [ 'page_len > ' . intval( $wgMaxMsgCacheEntrySize ) ] ),
523  __METHOD__ . "($code)-big"
524  );
525  foreach ( $res as $row ) {
526  // Include entries/stubs for all keys in $mostused in adaptive mode
527  if ( $wgAdaptiveMessageCache || $this->isMainCacheable( $row->page_title, $overridable ) ) {
528  $cache[$row->page_title] = '!TOO BIG';
529  }
530  // At least include revision ID so page changes are reflected in the hash
531  $cache['EXCESSIVE'][$row->page_title] = $row->page_latest;
532  }
533 
534  // Set the text for small software-defined messages in the main cache map
535  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
536  $revQuery = $revisionStore->getQueryInfo( [ 'page', 'user' ] );
537  $res = $dbr->select(
538  $revQuery['tables'],
539  $revQuery['fields'],
540  array_merge( $conds, [
541  'page_len <= ' . intval( $wgMaxMsgCacheEntrySize ),
542  'page_latest = rev_id' // get the latest revision only
543  ] ),
544  __METHOD__ . "($code)-small",
545  [],
546  $revQuery['joins']
547  );
548  foreach ( $res as $row ) {
549  // Include entries/stubs for all keys in $mostused in adaptive mode
550  if ( $wgAdaptiveMessageCache || $this->isMainCacheable( $row->page_title, $overridable ) ) {
551  try {
552  $rev = $revisionStore->newRevisionFromRow( $row );
553  $content = $rev->getContent( MediaWiki\Revision\SlotRecord::MAIN );
554  $text = $this->getMessageTextFromContent( $content );
555  } catch ( Exception $ex ) {
556  $text = false;
557  }
558 
559  if ( !is_string( $text ) ) {
560  $entry = '!ERROR';
561  wfDebugLog(
562  'MessageCache',
563  __METHOD__
564  . ": failed to load message page text for {$row->page_title} ($code)"
565  );
566  } else {
567  $entry = ' ' . $text;
568  }
569  $cache[$row->page_title] = $entry;
570  } else {
571  // T193271: cache object gets too big and slow to generate.
572  // At least include revision ID so page changes are reflected in the hash.
573  $cache['EXCESSIVE'][$row->page_title] = $row->page_latest;
574  }
575  }
576 
577  $cache['VERSION'] = MSG_CACHE_VERSION;
578  ksort( $cache );
579 
580  # Hash for validating local cache (APC). No need to take into account
581  # messages larger than $wgMaxMsgCacheEntrySize, since those are only
582  # stored and fetched from memcache.
583  $cache['HASH'] = md5( serialize( $cache ) );
584  $cache['EXPIRY'] = wfTimestamp( TS_MW, time() + $this->mExpiry );
585  unset( $cache['EXCESSIVE'] ); // only needed for hash
586 
587  return $cache;
588  }
589 
595  private function isMainCacheable( $name, array $overridable ) {
596  // Convert first letter to lowercase, and strip /code suffix
597  $name = $this->contLang->lcfirst( $name );
598  $msg = preg_replace( '/\/[a-z0-9-]{2,}$/', '', $name );
599  // Include common conversion table pages. This also avoids problems with
600  // Installer::parse() bailing out due to disallowed DB queries (T207979).
601  return ( isset( $overridable[$msg] ) || strpos( $name, 'conversiontable/' ) === 0 );
602  }
603 
610  public function replace( $title, $text ) {
611  global $wgLanguageCode;
612 
613  if ( $this->mDisable ) {
614  return;
615  }
616 
617  list( $msg, $code ) = $this->figureMessage( $title );
618  if ( strpos( $title, '/' ) !== false && $code === $wgLanguageCode ) {
619  // Content language overrides do not use the /<code> suffix
620  return;
621  }
622 
623  // (a) Update the process cache with the new message text
624  if ( $text === false ) {
625  // Page deleted
626  $this->cache->setField( $code, $title, '!NONEXISTENT' );
627  } else {
628  // Ignore $wgMaxMsgCacheEntrySize so the process cache is up to date
629  $this->cache->setField( $code, $title, ' ' . $text );
630  }
631 
632  // (b) Update the shared caches in a deferred update with a fresh DB snapshot
634  new MessageCacheUpdate( $code, $title, $msg ),
636  );
637  }
638 
644  public function refreshAndReplaceInternal( $code, array $replacements ) {
646 
647  // Allow one caller at a time to avoid race conditions
648  $scopedLock = $this->getReentrantScopedLock(
649  $this->clusterCache->makeKey( 'messages', $code )
650  );
651  if ( !$scopedLock ) {
652  foreach ( $replacements as list( $title ) ) {
653  LoggerFactory::getInstance( 'MessageCache' )->error(
654  __METHOD__ . ': could not acquire lock to update {title} ({code})',
655  [ 'title' => $title, 'code' => $code ] );
656  }
657 
658  return;
659  }
660 
661  // Load the existing cache to update it in the local DC cache.
662  // The other DCs will see a hash mismatch.
663  if ( $this->load( $code, self::FOR_UPDATE ) ) {
664  $cache = $this->cache->get( $code );
665  } else {
666  // Err? Fall back to loading from the database.
667  $cache = $this->loadFromDB( $code, self::FOR_UPDATE );
668  }
669  // Check if individual cache keys should exist and update cache accordingly
670  $newTextByTitle = []; // map of (title => content)
671  $newBigTitles = []; // map of (title => latest revision ID), like EXCESSIVE in loadFromDB()
672  foreach ( $replacements as list( $title ) ) {
674  $page->loadPageData( $page::READ_LATEST );
675  $text = $this->getMessageTextFromContent( $page->getContent() );
676  // Remember the text for the blob store update later on
677  $newTextByTitle[$title] = $text;
678  // Note that if $text is false, then $cache should have a !NONEXISTANT entry
679  if ( !is_string( $text ) ) {
680  $cache[$title] = '!NONEXISTENT';
681  } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
682  $cache[$title] = '!TOO BIG';
683  $newBigTitles[$title] = $page->getLatest();
684  } else {
685  $cache[$title] = ' ' . $text;
686  }
687  }
688  // Update HASH for the new key. Incorporates various administrative keys,
689  // including the old HASH (and thereby the EXCESSIVE value from loadFromDB()
690  // and previous replace() calls), but that doesn't really matter since we
691  // only ever compare it for equality with a copy saved by saveToCaches().
692  $cache['HASH'] = md5( serialize( $cache + [ 'EXCESSIVE' => $newBigTitles ] ) );
693  // Update the too-big WAN cache entries now that we have the new HASH
694  foreach ( $newBigTitles as $title => $id ) {
695  // Match logic of loadCachedMessagePageEntry()
696  $this->wanCache->set(
697  $this->bigMessageCacheKey( $cache['HASH'], $title ),
698  ' ' . $newTextByTitle[$title],
699  $this->mExpiry
700  );
701  }
702  // Mark this cache as definitely being "latest" (non-volatile) so
703  // load() calls do not try to refresh the cache with replica DB data
704  $cache['LATEST'] = time();
705  // Update the process cache
706  $this->cache->set( $code, $cache );
707  // Pre-emptively update the local datacenter cache so things like edit filter and
708  // blacklist changes are reflected immediately; these often use MediaWiki: pages.
709  // The datacenter handling replace() calls should be the same one handling edits
710  // as they require HTTP POST.
711  $this->saveToCaches( $cache, 'all', $code );
712  // Release the lock now that the cache is saved
713  ScopedCallback::consume( $scopedLock );
714 
715  // Relay the purge. Touching this check key expires cache contents
716  // and local cache (APC) validation hash across all datacenters.
717  $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
718 
719  // Purge the messages in the message blob store and fire any hook handlers
720  $blobStore = MediaWikiServices::getInstance()->getResourceLoader()->getMessageBlobStore();
721  foreach ( $replacements as list( $title, $msg ) ) {
722  $blobStore->updateMessage( $this->contLang->lcfirst( $msg ) );
723  Hooks::run( 'MessageCacheReplace', [ $title, $newTextByTitle[$title] ] );
724  }
725  }
726 
733  protected function isCacheExpired( $cache ) {
734  if ( !isset( $cache['VERSION'] ) || !isset( $cache['EXPIRY'] ) ) {
735  return true;
736  }
737  if ( $cache['VERSION'] != MSG_CACHE_VERSION ) {
738  return true;
739  }
740  if ( wfTimestampNow() >= $cache['EXPIRY'] ) {
741  return true;
742  }
743 
744  return false;
745  }
746 
756  protected function saveToCaches( array $cache, $dest, $code = false ) {
757  if ( $dest === 'all' ) {
758  $cacheKey = $this->clusterCache->makeKey( 'messages', $code );
759  $success = $this->clusterCache->set( $cacheKey, $cache );
760  $this->setValidationHash( $code, $cache );
761  } else {
762  $success = true;
763  }
764 
765  $this->saveToLocalCache( $code, $cache );
766 
767  return $success;
768  }
769 
776  protected function getValidationHash( $code ) {
777  $curTTL = null;
778  $value = $this->wanCache->get(
779  $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
780  $curTTL,
781  [ $this->getCheckKey( $code ) ]
782  );
783 
784  if ( $value ) {
785  $hash = $value['hash'];
786  if ( ( time() - $value['latest'] ) < WANObjectCache::TTL_MINUTE ) {
787  // Cache was recently updated via replace() and should be up-to-date.
788  // That method is only called in the primary datacenter and uses FOR_UPDATE.
789  // Also, it is unlikely that the current datacenter is *now* secondary one.
790  $expired = false;
791  } else {
792  // See if the "check" key was bumped after the hash was generated
793  $expired = ( $curTTL < 0 );
794  }
795  } else {
796  // No hash found at all; cache must regenerate to be safe
797  $hash = false;
798  $expired = true;
799  }
800 
801  return [ $hash, $expired ];
802  }
803 
814  protected function setValidationHash( $code, array $cache ) {
815  $this->wanCache->set(
816  $this->wanCache->makeKey( 'messages', $code, 'hash', 'v1' ),
817  [
818  'hash' => $cache['HASH'],
819  'latest' => $cache['LATEST'] ?? 0
820  ],
822  );
823  }
824 
830  protected function getReentrantScopedLock( $key, $timeout = self::WAIT_SEC ) {
831  return $this->clusterCache->getScopedLock( $key, $timeout, self::LOCK_TTL, __METHOD__ );
832  }
833 
867  function get( $key, $useDB = true, $langcode = true ) {
868  if ( is_int( $key ) ) {
869  // Fix numerical strings that somehow become ints
870  // on their way here
871  $key = (string)$key;
872  } elseif ( !is_string( $key ) ) {
873  throw new MWException( 'Non-string key given' );
874  } elseif ( $key === '' ) {
875  // Shortcut: the empty key is always missing
876  return false;
877  }
878 
879  // Normalise title-case input (with some inlining)
880  $lckey = self::normalizeKey( $key );
881 
882  Hooks::run( 'MessageCache::get', [ &$lckey ] );
883 
884  // Loop through each language in the fallback list until we find something useful
885  $message = $this->getMessageFromFallbackChain(
886  wfGetLangObj( $langcode ),
887  $lckey,
888  !$this->mDisable && $useDB
889  );
890 
891  // If we still have no message, maybe the key was in fact a full key so try that
892  if ( $message === false ) {
893  $parts = explode( '/', $lckey );
894  // We may get calls for things that are http-urls from sidebar
895  // Let's not load nonexistent languages for those
896  // They usually have more than one slash.
897  if ( count( $parts ) == 2 && $parts[1] !== '' ) {
898  $message = Language::getMessageFor( $parts[0], $parts[1] );
899  if ( $message === null ) {
900  $message = false;
901  }
902  }
903  }
904 
905  // Post-processing if the message exists
906  if ( $message !== false ) {
907  // Fix whitespace
908  $message = str_replace(
909  [
910  # Fix for trailing whitespace, removed by textarea
911  '&#32;',
912  # Fix for NBSP, converted to space by firefox
913  '&nbsp;',
914  '&#160;',
915  '&shy;'
916  ],
917  [
918  ' ',
919  "\u{00A0}",
920  "\u{00A0}",
921  "\u{00AD}"
922  ],
923  $message
924  );
925  }
926 
927  return $message;
928  }
929 
942  protected function getMessageFromFallbackChain( $lang, $lckey, $useDB ) {
943  $alreadyTried = [];
944 
945  // First try the requested language.
946  $message = $this->getMessageForLang( $lang, $lckey, $useDB, $alreadyTried );
947  if ( $message !== false ) {
948  return $message;
949  }
950 
951  // Now try checking the site language.
952  $message = $this->getMessageForLang( $this->contLang, $lckey, $useDB, $alreadyTried );
953  return $message;
954  }
955 
966  private function getMessageForLang( $lang, $lckey, $useDB, &$alreadyTried ) {
967  $langcode = $lang->getCode();
968 
969  // Try checking the database for the requested language
970  if ( $useDB ) {
971  $uckey = $this->contLang->ucfirst( $lckey );
972 
973  if ( !isset( $alreadyTried[$langcode] ) ) {
974  $message = $this->getMsgFromNamespace(
975  $this->getMessagePageName( $langcode, $uckey ),
976  $langcode
977  );
978  if ( $message !== false ) {
979  return $message;
980  }
981  $alreadyTried[$langcode] = true;
982  }
983  } else {
984  $uckey = null;
985  }
986 
987  // Check the CDB cache
988  $message = $lang->getMessage( $lckey );
989  if ( $message !== null ) {
990  return $message;
991  }
992 
993  // Try checking the database for all of the fallback languages
994  if ( $useDB ) {
995  $fallbackChain = Language::getFallbacksFor( $langcode );
996 
997  foreach ( $fallbackChain as $code ) {
998  if ( isset( $alreadyTried[$code] ) ) {
999  continue;
1000  }
1001 
1002  $message = $this->getMsgFromNamespace(
1003  $this->getMessagePageName( $code, $uckey ), $code );
1004 
1005  if ( $message !== false ) {
1006  return $message;
1007  }
1008  $alreadyTried[$code] = true;
1009  }
1010  }
1011 
1012  return false;
1013  }
1014 
1022  private function getMessagePageName( $langcode, $uckey ) {
1023  global $wgLanguageCode;
1024 
1025  if ( $langcode === $wgLanguageCode ) {
1026  // Messages created in the content language will not have the /lang extension
1027  return $uckey;
1028  } else {
1029  return "$uckey/$langcode";
1030  }
1031  }
1032 
1045  public function getMsgFromNamespace( $title, $code ) {
1046  // Load all MediaWiki page definitions into cache. Note that individual keys
1047  // already loaded into cache during this request remain in the cache, which
1048  // includes the value of hook-defined messages.
1049  $this->load( $code );
1050 
1051  $entry = $this->cache->getField( $code, $title );
1052 
1053  if ( $entry !== null ) {
1054  // Message page exists as an override of a software messages
1055  if ( substr( $entry, 0, 1 ) === ' ' ) {
1056  // The message exists and is not '!TOO BIG' or '!ERROR'
1057  return (string)substr( $entry, 1 );
1058  } elseif ( $entry === '!NONEXISTENT' ) {
1059  // The text might be '-' or missing due to some data loss
1060  return false;
1061  }
1062  // Load the message page, utilizing the individual message cache.
1063  // If the page does not exist, there will be no hook handler fallbacks.
1064  $entry = $this->loadCachedMessagePageEntry(
1065  $title,
1066  $code,
1067  $this->cache->getField( $code, 'HASH' )
1068  );
1069  } else {
1070  // Message page either does not exist or does not override a software message
1071  if ( !$this->isMainCacheable( $title, $this->overridable ) ) {
1072  // Message page does not override any software-defined message. A custom
1073  // message might be defined to have content or settings specific to the wiki.
1074  // Load the message page, utilizing the individual message cache as needed.
1075  $entry = $this->loadCachedMessagePageEntry(
1076  $title,
1077  $code,
1078  $this->cache->getField( $code, 'HASH' )
1079  );
1080  }
1081  if ( $entry === null || substr( $entry, 0, 1 ) !== ' ' ) {
1082  // Message does not have a MediaWiki page definition; try hook handlers
1083  $message = false;
1084  Hooks::run( 'MessagesPreLoad', [ $title, &$message, $code ] );
1085  if ( $message !== false ) {
1086  $this->cache->setField( $code, $title, ' ' . $message );
1087  } else {
1088  $this->cache->setField( $code, $title, '!NONEXISTENT' );
1089  }
1090 
1091  return $message;
1092  }
1093  }
1094 
1095  if ( $entry !== false && substr( $entry, 0, 1 ) === ' ' ) {
1096  if ( $this->cacheVolatile[$code] ) {
1097  // Make sure that individual keys respect the WAN cache holdoff period too
1098  LoggerFactory::getInstance( 'MessageCache' )->debug(
1099  __METHOD__ . ': loading volatile key \'{titleKey}\'',
1100  [ 'titleKey' => $title, 'code' => $code ] );
1101  } else {
1102  $this->cache->setField( $code, $title, $entry );
1103  }
1104  // The message exists, so make sure a string is returned
1105  return (string)substr( $entry, 1 );
1106  }
1107 
1108  $this->cache->setField( $code, $title, '!NONEXISTENT' );
1109 
1110  return false;
1111  }
1112 
1119  private function loadCachedMessagePageEntry( $dbKey, $code, $hash ) {
1120  $fname = __METHOD__;
1121  return $this->srvCache->getWithSetCallback(
1122  $this->srvCache->makeKey( 'messages-big', $hash, $dbKey ),
1124  function () use ( $code, $dbKey, $hash, $fname ) {
1125  return $this->wanCache->getWithSetCallback(
1126  $this->bigMessageCacheKey( $hash, $dbKey ),
1127  $this->mExpiry,
1128  function ( $oldValue, &$ttl, &$setOpts ) use ( $dbKey, $code, $fname ) {
1129  // Try loading the message from the database
1130  $dbr = wfGetDB( DB_REPLICA );
1131  $setOpts += Database::getCacheSetOptions( $dbr );
1132  // Use newKnownCurrent() to avoid querying revision/user tables
1133  $title = Title::makeTitle( NS_MEDIAWIKI, $dbKey );
1134  $revision = Revision::newKnownCurrent( $dbr, $title );
1135  if ( !$revision ) {
1136  // The wiki doesn't have a local override page. Cache absence with normal TTL.
1137  // When overrides are created, self::replace() takes care of the cache.
1138  return '!NONEXISTENT';
1139  }
1140  $content = $revision->getContent();
1141  if ( $content ) {
1142  $message = $this->getMessageTextFromContent( $content );
1143  } else {
1144  LoggerFactory::getInstance( 'MessageCache' )->warning(
1145  $fname . ': failed to load page text for \'{titleKey}\'',
1146  [ 'titleKey' => $dbKey, 'code' => $code ]
1147  );
1148  $message = null;
1149  }
1150 
1151  if ( !is_string( $message ) ) {
1152  // Revision failed to load Content, or Content is incompatible with wikitext.
1153  // Possibly a temporary loading failure.
1154  $ttl = 5;
1155 
1156  return '!NONEXISTENT';
1157  }
1158 
1159  return ' ' . $message;
1160  }
1161  );
1162  }
1163  );
1164  }
1165 
1173  public function transform( $message, $interface = false, $language = null, $title = null ) {
1174  // Avoid creating parser if nothing to transform
1175  if ( strpos( $message, '{{' ) === false ) {
1176  return $message;
1177  }
1178 
1179  if ( $this->mInParser ) {
1180  return $message;
1181  }
1182 
1183  $parser = $this->getParser();
1184  if ( $parser ) {
1185  $popts = $this->getParserOptions();
1186  $popts->setInterfaceMessage( $interface );
1187  $popts->setTargetLanguage( $language );
1188 
1189  $userlang = $popts->setUserLang( $language );
1190  $this->mInParser = true;
1191  $message = $parser->transformMsg( $message, $popts, $title );
1192  $this->mInParser = false;
1193  $popts->setUserLang( $userlang );
1194  }
1195 
1196  return $message;
1197  }
1198 
1202  public function getParser() {
1203  global $wgParserConf;
1204  if ( !$this->mParser ) {
1205  $parser = MediaWikiServices::getInstance()->getParser();
1206  # Do some initialisation so that we don't have to do it twice
1207  $parser->firstCallInit();
1208  # Clone it and store it
1209  $class = $wgParserConf['class'];
1210  if ( $class == ParserDiffTest::class ) {
1211  # Uncloneable
1212  $this->mParser = new $class( $wgParserConf );
1213  } else {
1214  $this->mParser = clone $parser;
1215  }
1216  }
1217 
1218  return $this->mParser;
1219  }
1220 
1229  public function parse( $text, $title = null, $linestart = true,
1230  $interface = false, $language = null
1231  ) {
1232  global $wgTitle;
1233 
1234  if ( $this->mInParser ) {
1235  return htmlspecialchars( $text );
1236  }
1237 
1238  $parser = $this->getParser();
1239  $popts = $this->getParserOptions();
1240  $popts->setInterfaceMessage( $interface );
1241 
1242  if ( is_string( $language ) ) {
1243  $language = Language::factory( $language );
1244  }
1245  $popts->setTargetLanguage( $language );
1246 
1247  if ( !$title || !$title instanceof Title ) {
1248  wfDebugLog( 'GlobalTitleFail', __METHOD__ . ' called by ' .
1249  wfGetAllCallers( 6 ) . ' with no title set.' );
1250  $title = $wgTitle;
1251  }
1252  // Sometimes $wgTitle isn't set either...
1253  if ( !$title ) {
1254  # It's not uncommon having a null $wgTitle in scripts. See r80898
1255  # Create a ghost title in such case
1256  $title = Title::makeTitle( NS_SPECIAL, 'Badtitle/title not set in ' . __METHOD__ );
1257  }
1258 
1259  $this->mInParser = true;
1260  $res = $parser->parse( $text, $title, $popts, $linestart );
1261  $this->mInParser = false;
1262 
1263  return $res;
1264  }
1265 
1266  public function disable() {
1267  $this->mDisable = true;
1268  }
1269 
1270  public function enable() {
1271  $this->mDisable = false;
1272  }
1273 
1286  public function isDisabled() {
1287  return $this->mDisable;
1288  }
1289 
1295  public function clear() {
1296  $langs = Language::fetchLanguageNames( null, 'mw' );
1297  foreach ( array_keys( $langs ) as $code ) {
1298  $this->wanCache->touchCheckKey( $this->getCheckKey( $code ) );
1299  }
1300  $this->cache->clear();
1301  $this->loadedLanguages = [];
1302  }
1303 
1308  public function figureMessage( $key ) {
1309  global $wgLanguageCode;
1310 
1311  $pieces = explode( '/', $key );
1312  if ( count( $pieces ) < 2 ) {
1313  return [ $key, $wgLanguageCode ];
1314  }
1315 
1316  $lang = array_pop( $pieces );
1317  if ( !Language::fetchLanguageName( $lang, null, 'mw' ) ) {
1318  return [ $key, $wgLanguageCode ];
1319  }
1320 
1321  $message = implode( '/', $pieces );
1322 
1323  return [ $message, $lang ];
1324  }
1325 
1334  public function getAllMessageKeys( $code ) {
1335  $this->load( $code );
1336  if ( !$this->cache->has( $code ) ) {
1337  // Apparently load() failed
1338  return null;
1339  }
1340  // Remove administrative keys
1341  $cache = $this->cache->get( $code );
1342  unset( $cache['VERSION'] );
1343  unset( $cache['EXPIRY'] );
1344  unset( $cache['EXCESSIVE'] );
1345  // Remove any !NONEXISTENT keys
1346  $cache = array_diff( $cache, [ '!NONEXISTENT' ] );
1347 
1348  // Keys may appear with a capital first letter. lcfirst them.
1349  return array_map( [ $this->contLang, 'lcfirst' ], array_keys( $cache ) );
1350  }
1351 
1360  $msgText = $this->getMessageTextFromContent( $content );
1361  if ( $msgText === null ) {
1362  $msgText = false; // treat as not existing
1363  }
1364 
1365  $this->replace( $title->getDBkey(), $msgText );
1366 
1367  if ( $this->contLang->hasVariants() ) {
1368  $this->contLang->updateConversionTable( $title );
1369  }
1370  }
1371 
1376  public function getCheckKey( $code ) {
1377  return $this->wanCache->makeKey( 'messages', $code );
1378  }
1379 
1385  // @TODO: could skip pseudo-messages like js/css here, based on content model
1386  if ( $content ) {
1387  // Message page exists...
1388  // XXX: Is this the right way to turn a Content object into a message?
1389  // NOTE: $content is typically either WikitextContent, JavaScriptContent or
1390  // CssContent. MessageContent is *not* used for storing messages, it's
1391  // only used for wrapping them when needed.
1392  $msgText = $content->getWikitextForTransclusion();
1393  if ( $msgText === false || $msgText === null ) {
1394  // This might be due to some kind of misconfiguration...
1395  $msgText = null;
1396  LoggerFactory::getInstance( 'MessageCache' )->warning(
1397  __METHOD__ . ": message content doesn't provide wikitext "
1398  . "(content model: " . $content->getModel() . ")" );
1399  }
1400  } else {
1401  // Message page does not exist...
1402  $msgText = false;
1403  }
1404 
1405  return $msgText;
1406  }
1407 
1413  private function bigMessageCacheKey( $hash, $title ) {
1414  return $this->wanCache->makeKey( 'messages-big', $hash, $title );
1415  }
1416 }
load( $code, $mode=null)
Loads messages from caches or from database in this order: (1) local message cache (if $wgUseLocalMes...
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
get( $key, $maxAge=INF, $default=null)
Get the value for a key.
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)
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:1781
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:1972
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:1244
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:2205
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:1021
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:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
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.
array $loadedLanguages
Track which languages have been loaded by load().
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:1748
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:767
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:131
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:592
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