24use Wikimedia\ScopedCallback;
32define(
'MSG_CACHE_VERSION', 2 );
114 if ( self::$instance ===
null ) {
116 self::$instance =
new self(
117 MediaWikiServices::getInstance()->getMainWANObjectCache(),
120 ? MediaWikiServices::getInstance()->getLocalServerObjectCache()
136 self::$instance =
null;
148 $lckey = strtr( $key,
' ',
'_' );
149 if ( ord( $lckey ) < 128 ) {
150 $lckey[0] = strtolower( $lckey[0] );
176 $this->mDisable = !$useDB;
177 $this->mExpiry = $expiry;
188 if ( !$this->mParserOptions ) {
189 if ( !
$wgUser->isSafeToLoad() ) {
193 $po = ParserOptions::newFromAnon();
194 $po->setEditSection(
false );
195 $po->setAllowUnsafeRawHtml(
false );
196 $po->setWrapOutputClass(
false );
205 $this->mParserOptions->setAllowUnsafeRawHtml(
false );
210 $this->mParserOptions->setWrapOutputClass(
false );
223 $cacheKey = $this->srvCache->makeKey( __CLASS__,
$code );
225 return $this->srvCache->get( $cacheKey );
235 $cacheKey = $this->srvCache->makeKey( __CLASS__,
$code );
236 $this->srvCache->set( $cacheKey,
$cache );
261 if ( !is_string(
$code ) ) {
262 throw new InvalidArgumentException(
"Missing language code" );
265 # Don't do double loading...
266 if ( isset( $this->mLoadedLanguages[
$code] ) && $mode != self::FOR_UPDATE ) {
270 # 8 lines of code just to say (once) that message cache is disabled
271 if ( $this->mDisable ) {
272 static $shownDisabled =
false;
273 if ( !$shownDisabled ) {
274 wfDebug( __METHOD__ .
": disabled\n" );
275 $shownDisabled =
true;
281 # Loading code starts
283 $staleCache =
false; # a
cache array with expired
data,
or false if none has been loaded
284 $where = []; # Debug info, delayed to avoid spamming debug log
too much
286 # Hash of the contents is stored in memcache, to detect if data-center cache
287 # or local cache goes out of date (e.g. due to replace() on some other server)
289 $this->mCacheVolatile[
$code] = $hashVolatile;
291 # Try the local cache and check against the cluster hash key...
294 $where[] =
'local cache is empty';
295 } elseif ( !isset(
$cache[
'HASH'] ) ||
$cache[
'HASH'] !== $hash ) {
296 $where[] =
'local cache has the wrong hash';
299 $where[] =
'local cache is expired';
301 } elseif ( $hashVolatile ) {
302 $where[] =
'local cache validation key is expired/volatile';
305 $where[] =
'got from local cache';
311 $cacheKey = $this->clusterCache->makeKey(
'messages',
$code ); # Key
in memc
for messages
312 # Try the global cache. If it is empty, try to acquire a lock. If
313 # the lock can't be acquired, wait for the other thread to finish
314 # and then try the global cache a second time.
315 for ( $failedAttempts = 0; $failedAttempts <= 1; $failedAttempts++ ) {
316 if ( $hashVolatile && $staleCache ) {
317 # Do not bother fetching the whole cache blob to avoid I/O.
318 # Instead, just try to get the non-blocking $statusKey lock
319 # below, and use the local stale value if it was not acquired.
320 $where[] =
'global cache is presumed expired';
322 $cache = $this->clusterCache->get( $cacheKey );
324 $where[] =
'global cache is empty';
326 $where[] =
'global cache is expired';
328 } elseif ( $hashVolatile ) {
329 # DB results are replica DB lag prone until the holdoff TTL passes.
330 # By then, updates should be reflected in loadFromDBWithLock().
331 # One thread renerates the cache while others use old values.
332 $where[] =
'global cache is expired/volatile';
335 $where[] =
'got from global cache';
343 # Done, no need to retry
347 # We need to call loadFromDB. Limit the concurrency to one process.
348 # This prevents the site from going down when the cache expires.
349 # Note that the DB slam protection lock here is non-blocking.
351 if ( $loadStatus ===
true ) {
354 } elseif ( $staleCache ) {
355 # Use the stale cache while some other thread constructs the new one
356 $where[] =
'using stale cache';
357 $this->mCache[
$code] = $staleCache;
360 } elseif ( $failedAttempts > 0 ) {
361 # Already blocked once, so avoid another lock/unlock cycle.
362 # This case will typically be hit if memcached is down, or if
363 # loadFromDB() takes longer than LOCK_WAIT.
364 $where[] =
"could not acquire status key.";
366 } elseif ( $loadStatus ===
'cantacquire' ) {
367 # Wait for the other thread to finish, then retry. Normally,
368 # the memcached get() will then yeild the other thread's result.
369 $where[] =
'waited for other thread to complete';
372 # Disable cache; $loadStatus is 'disabled'
379 $where[] =
'loading FAILED - cache is disabled';
380 $this->mDisable =
true;
381 $this->mCache =
false;
382 wfDebugLog(
'MessageCacheError', __METHOD__ .
": Failed to load $code\n" );
383 # This used to throw an exception, but that led to nasty side effects like
384 # the whole wiki being instantly down if the memcached server died
386 # All good, just record the success
387 $this->mLoadedLanguages[
$code] =
true;
390 $info = implode(
', ', $where );
391 wfDebugLog(
'MessageCache', __METHOD__ .
": Loading $code... $info\n" );
403 # If cache updates on all levels fail, give up on message overrides.
404 # This is to avoid easy site outages; see $saveSuccess comments below.
405 $statusKey = $this->clusterCache->makeKey(
'messages',
$code,
'status' );
406 $status = $this->clusterCache->get( $statusKey );
408 $where[] =
"could not load; method is still globally disabled";
412 # Now let's regenerate
413 $where[] =
'loading from database';
415 # Lock the cache to prevent conflicting writes.
416 # This lock is non-blocking so stale cache can quickly be used.
417 # Note that load() will call a blocking getReentrantScopedLock()
418 # after this if it really need to wait for any current thread.
419 $cacheKey = $this->clusterCache->makeKey(
'messages',
$code );
421 if ( !$scopedLock ) {
422 $where[] =
'could not acquire main lock';
423 return 'cantacquire';
430 if ( !$saveSuccess ) {
445 $this->clusterCache->set( $statusKey,
'error', 60 * 5 );
446 $where[] =
'could not save cache, disabled globally for 5 minutes';
448 $where[] =
"could not save global cache";
477 'page_is_redirect' => 0,
484 $this->
load( $wgLanguageCode );
487 foreach ( $mostused
as $key =>
$value ) {
488 $mostused[$key] =
"$value/$code";
492 if ( count( $mostused ) ) {
493 $conds[
'page_title'] = $mostused;
495 $conds[] =
'page_title' .
$dbr->buildLike(
$dbr->anyString(),
'/',
$code );
497 # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
498 # other than language code.
499 $conds[] =
'page_title NOT' .
500 $dbr->buildLike(
$dbr->anyString(),
'/',
$dbr->anyString() );
503 # Conditions to fetch oversized pages to ignore them
507 # Load titles for all oversized pages in the MediaWiki namespace
510 [
'page_title',
'page_latest' ],
512 __METHOD__ .
"($code)-big"
514 foreach (
$res as $row ) {
515 $cache[$row->page_title] =
'!TOO BIG';
517 $cache[
'EXCESSIVE'][$row->page_title] = $row->page_latest;
520 # Conditions to load the remaining pages with their contents
521 $smallConds = $conds;
525 [
'page',
'revision',
'text' ],
526 [
'page_title',
'old_id',
'old_text',
'old_flags' ],
528 __METHOD__ .
"($code)-small",
531 'revision' => [
'JOIN',
'page_latest=rev_id' ],
532 'text' => [
'JOIN',
'rev_text_id=old_id' ],
536 foreach (
$res as $row ) {
538 if ( $text ===
false ) {
546 .
": failed to load message page text for {$row->page_title} ($code)"
549 $entry =
' ' . $text;
551 $cache[$row->page_title] = $entry;
557 # Hash for validating local cache (APC). No need to take into account
558 # messages larger than $wgMaxMsgCacheEntrySize, since those are only
559 # stored and fetched from memcache.
575 if ( $this->mDisable ) {
586 if ( $text ===
false ) {
595 DeferredUpdates::addCallableUpdate(
600 $this->clusterCache->makeKey(
'messages',
$code )
602 if ( !$scopedLock ) {
603 LoggerFactory::getInstance(
'MessageCache' )->error(
604 __METHOD__ .
': could not acquire lock to update {title} ({code})',
613 $page->loadPageData( $page::READ_LATEST );
618 $this->wanCache->set( $titleKey,
' ' . $text, $this->mExpiry );
622 $this->mCache[
$code][
'LATEST'] = time();
629 ScopedCallback::consume( $scopedLock );
633 $this->wanCache->touchCheckKey( $this->wanCache->makeKey(
'messages',
$code ) );
636 if (
$code ===
'en' ) {
638 $codes = array_keys( Language::fetchLanguageNames() );
644 $this->wanCache->delete( $this->wanCache->makeKey(
'sidebar',
$code ) );
649 $blobStore = $resourceloader->getMessageBlobStore();
650 $blobStore->updateMessage(
$wgContLang->lcfirst( $msg ) );
652 Hooks::run(
'MessageCacheReplace', [
$title, $text ] );
654 DeferredUpdates::PRESEND
665 if ( !isset(
$cache[
'VERSION'] ) || !isset(
$cache[
'EXPIRY'] ) ) {
688 if ( $dest ===
'all' ) {
689 $cacheKey = $this->clusterCache->makeKey(
'messages',
$code );
709 $value = $this->wanCache->get(
710 $this->wanCache->makeKey(
'messages',
$code,
'hash',
'v1' ),
712 [ $this->wanCache->makeKey(
'messages',
$code ) ]
717 if ( ( time() -
$value[
'latest'] ) < WANObjectCache::TTL_MINUTE ) {
724 $expired = ( $curTTL < 0 );
732 return [ $hash, $expired ];
746 $this->wanCache->set(
747 $this->wanCache->makeKey(
'messages',
$code,
'hash',
'v1' ),
750 'latest' => isset(
$cache[
'LATEST'] ) ?
$cache[
'LATEST'] : 0
752 WANObjectCache::TTL_INDEFINITE
762 return $this->clusterCache->getScopedLock( $key, $timeout, self::LOCK_TTL, __METHOD__ );
799 function get( $key, $useDB =
true, $langcode =
true, $isFullKey =
false ) {
800 if ( is_int( $key ) ) {
804 } elseif ( !is_string( $key ) ) {
806 } elseif ( $key ===
'' ) {
812 $pos = strrpos( $key,
'/' );
813 if ( $isFullKey && $pos !==
false ) {
814 $langcode = substr( $key, $pos + 1 );
815 $key = substr( $key, 0, $pos );
821 Hooks::run(
'MessageCache::get', [ &$lckey ] );
828 !$this->mDisable && $useDB
832 if ( $message ===
false ) {
833 $parts = explode(
'/', $lckey );
837 if ( count( $parts ) == 2 && $parts[1] !==
'' ) {
838 $message = Language::getMessageFor( $parts[0], $parts[1] );
839 if ( $message ===
null ) {
846 if ( $message !==
false ) {
848 $message = str_replace(
850 # Fix
for trailing whitespace, removed
by textarea
852 # Fix
for NBSP, converted to space
by firefox
889 if ( $message !==
false ) {
894 $message = $this->
getMessageForLang( $wgContLang, $lckey, $useDB, $alreadyTried );
911 $langcode =
$lang->getCode();
917 if ( !isset( $alreadyTried[ $langcode ] ) ) {
923 if ( $message !==
false ) {
926 $alreadyTried[ $langcode ] =
true;
933 $message =
$lang->getMessage( $lckey );
934 if ( $message !==
null ) {
940 $fallbackChain = Language::getFallbacksFor( $langcode );
942 foreach ( $fallbackChain
as $code ) {
943 if ( isset( $alreadyTried[
$code ] ) ) {
950 if ( $message !==
false ) {
953 $alreadyTried[
$code ] =
true;
974 return "$uckey/$langcode";
995 if ( substr( $entry, 0, 1 ) ===
' ' ) {
997 return (
string)substr( $entry, 1 );
998 } elseif ( $entry ===
'!NONEXISTENT' ) {
1000 } elseif ( $entry ===
'!TOO BIG' ) {
1006 Hooks::run(
'MessagesPreLoad', [
$title, &$message,
$code ] );
1007 if ( $message !==
false ) {
1017 if ( $this->mCacheVolatile[
$code] ) {
1020 LoggerFactory::getInstance(
'MessageCache' )->debug(
1021 __METHOD__ .
': loading volatile key \'{titleKey}\'',
1022 [
'titleKey' => $titleKey,
'code' =>
$code ] );
1025 $entry = $this->wanCache->get( $titleKey );
1028 if ( $entry !==
false ) {
1029 if ( substr( $entry, 0, 1 ) ===
' ' ) {
1032 return (
string)substr( $entry, 1 );
1033 } elseif ( $entry ===
'!NONEXISTENT' ) {
1039 $this->wanCache->delete( $titleKey );
1045 $cacheOpts = Database::getCacheSetOptions(
$dbr );
1048 if ( $titleObj->getLatestRevID() ) {
1051 $titleObj->getArticleID(),
1052 $titleObj->getLatestRevID()
1059 $content = $revision->getContent();
1062 if ( is_string( $message ) ) {
1064 $this->wanCache->set( $titleKey,
' ' . $message, $this->mExpiry, $cacheOpts );
1068 LoggerFactory::getInstance(
'MessageCache' )->warning(
1069 __METHOD__ .
': failed to load message page text for \'{titleKey}\'',
1070 [
'titleKey' => $titleKey,
'code' =>
$code ] );
1077 if ( $message ===
false ) {
1080 $this->wanCache->set( $titleKey,
'!NONEXISTENT', $this->mExpiry, $cacheOpts );
1093 function transform( $message, $interface =
false, $language =
null, $title =
null ) {
1095 if ( strpos( $message,
'{{' ) ===
false ) {
1099 if ( $this->mInParser ) {
1106 $popts->setInterfaceMessage( $interface );
1107 $popts->setTargetLanguage( $language );
1109 $userlang = $popts->setUserLang( $language );
1110 $this->mInParser =
true;
1111 $message =
$parser->transformMsg( $message, $popts,
$title );
1112 $this->mInParser =
false;
1113 $popts->setUserLang( $userlang );
1125 if ( !$this->mParser && isset(
$wgParser ) ) {
1126 # Do some initialisation so that we don't have to do it twice
1128 # Clone it and store it
1130 if ( $class ==
'ParserDiffTest' ) {
1149 public function parse( $text, $title =
null, $linestart =
true,
1150 $interface =
false, $language =
null
1154 if ( $this->mInParser ) {
1155 return htmlspecialchars( $text );
1160 $popts->setInterfaceMessage( $interface );
1162 if ( is_string( $language ) ) {
1163 $language = Language::factory( $language );
1165 $popts->setTargetLanguage( $language );
1168 wfDebugLog(
'GlobalTitleFail', __METHOD__ .
' called by ' .
1174 # It's not uncommon having a null $wgTitle in scripts. See r80898
1175 # Create a ghost title in such case
1176 $title = Title::makeTitle(
NS_SPECIAL,
'Badtitle/title not set in ' . __METHOD__ );
1179 $this->mInParser =
true;
1181 $this->mInParser =
false;
1187 $this->mDisable =
true;
1191 $this->mDisable =
false;
1214 $langs = Language::fetchLanguageNames(
null,
'mw' );
1215 foreach ( array_keys( $langs )
as $code ) {
1216 # Global and local caches
1217 $this->wanCache->touchCheckKey( $this->wanCache->makeKey(
'messages',
$code ) );
1220 $this->mLoadedLanguages = [];
1230 $pieces = explode(
'/', $key );
1231 if ( count( $pieces ) < 2 ) {
1235 $lang = array_pop( $pieces );
1236 if ( !Language::fetchLanguageName(
$lang,
null,
'mw' ) ) {
1240 $message = implode(
'/', $pieces );
1242 return [ $message,
$lang ];
1257 if ( !isset( $this->mCache[
$code] ) ) {
1263 unset(
$cache[
'VERSION'] );
1264 unset(
$cache[
'EXPIRY'] );
1265 unset(
$cache[
'EXCESSIVE'] );
1284 if ( $msgText ===
null ) {
1307 $msgText = $content->getWikitextForTransclusion();
1308 if ( $msgText ===
false || $msgText ===
null ) {
1311 LoggerFactory::getInstance(
'MessageCache' )->warning(
1312 __METHOD__ .
": message content doesn't provide wikitext "
1313 .
"(content model: " . $content->getModel() .
")" );
1329 return $this->wanCache->makeKey(
'messages-big', $hash,
$title );
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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
$wgLanguageCode
Site language code.
$wgUseLocalMessageCache
Set this to true to maintain a copy of the message cache on the local server.
$wgAdaptiveMessageCache
Instead of caching everything, only cache those messages which have been customised in the site conte...
$wgUseDatabaseMessages
Translation using MediaWiki: namespace.
$wgMaxMsgCacheEntrySize
Maximum entry size in the message cache, in bytes.
$wgParserConf
Parser configuration.
$wgMsgCacheExpiry
Expiry time for the message cache key.
wfGetLangObj( $langcode=false)
Return a Language object from $langcode.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfGetMessageCacheStorage()
Get the cache object used by the message cache.
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const MSG_CACHE_VERSION
MediaWiki message cache structure version.
if(! $wgRequest->checkUrlExtension()) if(isset($_SERVER[ 'PATH_INFO']) &&$_SERVER[ 'PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
interface is intended to be more or less compatible with the PHP memcached client.
A BagOStuff object with no objects in it.
Message cache Performs various MediaWiki namespace-related functions.
getValidationHash( $code)
Get the md5 used to validate the local APC cache.
loadFromDBWithLock( $code, array &$where, $mode=null)
const LOCK_TTL
How long memcached locks last.
loadFromDB( $code, $mode=null)
Loads cacheable messages from the database.
getMessageForLang( $lang, $lckey, $useDB, &$alreadyTried)
Given a language, try and fetch messages from that language and its fallbacks.
$mExpiry
Lifetime for cache, used by object caching.
saveToLocalCache( $code, $cache)
Save the cache to APC.
getMessagePageName( $langcode, $uckey)
Get the message page name for a given language.
static $instance
Singleton instance.
saveToCaches(array $cache, $dest, $code=false)
Shortcut to update caches.
setValidationHash( $code, array $cache)
Set the md5 used to validate the local disk cache.
bool[] $mCacheVolatile
Map of (language code => boolean)
isCacheExpired( $cache)
Is the given cache array expired due to time passing or a version change?
getMsgFromNamespace( $title, $code)
Get a message from the MediaWiki namespace, with caching.
getReentrantScopedLock( $key, $timeout=self::WAIT_SEC)
const WAIT_SEC
How long to wait for memcached locks.
$mDisable
Should mean that database cannot be used, but check.
getLocalCache( $code)
Try to load the cache from APC.
static destroyInstance()
Destroy the singleton instance.
load( $code, $mode=null)
Loads messages from caches or from database in this order: (1) local message cache (if $wgUseLocalMes...
transform( $message, $interface=false, $language=null, $title=null)
updateMessageOverride(Title $title, Content $content=null)
Purge message caches when a MediaWiki: page is created, updated, or deleted.
getMessageFromFallbackChain( $lang, $lckey, $useDB)
Given a language, try and fetch messages from that language.
$mLoadedLanguages
Variable for tracking which variables are already loaded.
isDisabled()
Whether DB/cache usage is disabled for determining messages.
getMessageTextFromContent(Content $content=null)
__construct(WANObjectCache $wanCache, BagOStuff $clusterCache, BagOStuff $srvCache, $useDB, $expiry)
clear()
Clear all stored messages.
static singleton()
Get the signleton instance of this class.
getAllMessageKeys( $code)
Get all message keys stored in the message cache for a given language.
$mCache
Process local cache of loaded messages that are defined in MediaWiki namespace.
static normalizeKey( $key)
Normalize message key input.
parse( $text, $title=null, $linestart=true, $interface=false, $language=null)
ParserOptions $mParserOptions
Message cache has its own parser which it uses to transform messages.
replace( $title, $text)
Updates cache as necessary when message page is changed.
getParserOptions()
ParserOptions is lazy initialised.
bigMessageCacheKey( $hash, $title)
Set options of the Parser.
setEditSection( $x)
Create "edit section" links?
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
static getMain()
Static methods.
static newKnownCurrent(IDatabase $db, $pageId, $revId)
Load a revision based on a known page ID and current revision ID from the DB.
static getRevisionText( $row, $prefix='old_', $wiki=false)
Get revision text associated with an old or archive row.
Represents a title within MediaWiki.
getDBkey()
Get the main part with underscores.
Multi-datacenter aware caching interface.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
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
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
I won t presume to tell you how to I m just describing the methods I chose to use for myself If you do choose to follow these it will probably be easier for you to collaborate with others on the but if you want to contribute without by all means do which work well I also use K &R brace matching style I know that s a religious issue for so if you want to use a style that puts opening braces on the next that s OK too
when a variable name is used in a it is silently declared as a new local masking the global
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
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
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead $parser
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
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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
namespace and then decline to actually register it file or subcat img or subcat $title
null for the local wiki Added in
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place replace
processing should stop and the error should be shown to the user * false
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error 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
Base interface for content objects.
you have access to all of the normal MediaWiki so you can get a DB use the cache
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy load
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN boolean columns are always mapped to as the code does not always treat the column as a and VARBINARY columns should simply be TEXT The only exception is when VARBINARY is used to store true binary data
if(!isset( $args[0])) $lang