27use Wikimedia\ScopedCallback;
58 'dateformat' => [ __CLASS__,
'initDateFormat' ],
59 'speculativeRevId' => [ __CLASS__,
'initSpeculativeRevId' ],
60 'speculativePageId' => [ __CLASS__,
'initSpeculativePageId' ],
69 'numberheadings' =>
true,
71 'stubthreshold' =>
true,
123 if ( !array_key_exists( $name, $this->options ) ) {
124 throw new InvalidArgumentException(
"Unknown parser option $name" );
129 return $this->options[$name];
136 if ( isset( self::$lazyOptions[$name] ) && $this->options[$name] ===
null ) {
137 $this->options[$name] = call_user_func( self::$lazyOptions[$name], $this, $name );
150 if ( !array_key_exists( $name, $this->options ) ) {
151 throw new InvalidArgumentException(
"Unknown parser option $name" );
153 $old = $this->options[$name];
154 $this->options[$name] = $value;
167 if ( !array_key_exists( $name, $this->options ) ) {
168 throw new InvalidArgumentException(
"Unknown parser option $name" );
170 return wfSetVar( $this->options[$name], $value );
182 return $this->
getOption(
'interwikiMagic' );
199 return $this->
getOption(
'allowExternalImages' );
222 return $this->
getOption(
'allowExternalImagesFrom' );
245 return $this->
getOption(
'enableImageWhitelist' );
265 return $this->
getOption(
'numberheadings' );
282 return $this->
getOption(
'allowSpecialInclusion' );
312 wfDeprecatedMsg(
'Disabling tidy is deprecated since MediaWiki 1.33',
'1.33' );
322 return $this->
getOption(
'interfaceMessage' );
339 return $this->
getOption(
'targetLanguage' );
348 return $this->
setOption(
'targetLanguage', $x );
356 return $this->
getOption(
'maxIncludeSize' );
373 return $this->
getOption(
'maxPPNodeCount' );
390 return $this->
getOption(
'maxPPExpandDepth' );
398 return $this->
getOption(
'maxTemplateDepth' );
416 return $this->
getOption(
'expensiveParserFunctionLimit' );
435 return $this->
getOption(
'removeComments' );
453 return $this->
getOption(
'enableLimitReport' );
471 return $this->
getOption(
'cleanSignatures' );
489 return $this->
getOption(
'externalLinkTarget' );
506 return $this->
getOption(
'disableContentConversion' );
523 return $this->
getOption(
'disableTitleConversion' );
557 return $this->
getOption(
'stubthreshold' );
591 return $this->
getOption(
'isSectionPreview' );
625 return $this->
getOption(
'preSaveTransform' );
651 return $popt->mUser->getDatePreference();
706 if ( is_string( $x ) ) {
707 $x = MediaWikiServices::getInstance()->getLanguageFactory()->getLanguage( $x );
719 return $this->
getOption(
'magicISBNLinks' );
728 return $this->
getOption(
'magicPMIDLinks' );
737 return $this->
getOption(
'magicRFCLinks' );
755 return $this->
getOption(
'allowUnsafeRawHtml' );
787 if ( $className ===
true ) {
788 $className =
'mw-parser-output';
790 if ( $className ===
false ) {
793 return $this->
setOption(
'wrapclass', $className );
804 $revCb = $this->
getOption(
'currentRevisionCallback' );
811 if ( $revCb === [ Parser::class,
'statelessFetchRevision' ] ) {
814 $revRecordCb = $this->
getOption(
'currentRevisionRecordCallback' );
815 if ( $revRecordCb !== [ Parser::class,
'statelessFetchRevisionRecord' ] ) {
818 $revCb =
function (
Title $title, $parser = false ) use ( $revRecordCb ) {
819 $revRecord = call_user_func(
841 $revRecordCb = $this->
getOption(
'currentRevisionRecordCallback' );
844 if ( $revRecordCb === [ Parser::class,
'statelessFetchRevisionRecord' ] ) {
847 $revCb = $this->
getOption(
'currentRevisionCallback' );
848 if ( $revCb !== [ Parser::class,
'statelessFetchRevision' ] ) {
850 $revRecordCb =
function (
Title $title, $parser = null ) use ( $revCb ) {
851 $rev = call_user_func( $revCb,
$title, $parser ??
false );
853 return $rev->getRevisionRecord();
882 return $this->
setOption(
'currentRevisionRecordCallback', $x );
890 return $this->
getOption(
'templateCallback' );
913 return $this->
getOption(
'speculativeRevId' );
927 return $this->
getOption(
'speculativePageId' );
937 $cb = $popt->
getOption(
'speculativeRevIdCallback' );
938 $id = $cb ? $cb() :
null;
951 $cb = $popt->
getOption(
'speculativePageIdCallback' );
952 $id = $cb ? $cb() :
null;
965 $this->
setOption(
'speculativeRevId',
null );
966 return $this->
setOption(
'speculativeRevIdCallback', $x );
976 $this->
setOption(
'speculativePageId',
null );
977 return $this->
setOption(
'speculativePageIdCallback', $x );
985 if ( !isset( $this->mTimestamp ) ) {
988 return $this->mTimestamp;
997 return wfSetVar( $this->mTimestamp, $x );
1011 $this->redirectTarget =
$title;
1021 return $this->redirectTarget;
1031 $this->mExtraKey .=
'!' . $key;
1039 return $this->mUser;
1049 if ( $user ===
null ) {
1051 if ( $wgUser ===
null ) {
1057 if (
$lang ===
null ) {
1074 MediaWikiServices::getInstance()->getContentLanguage() );
1135 $ret = self::newFromContext( $context );
1136 } elseif ( $context ===
'canonical' ) {
1137 $ret = self::newFromAnon();
1138 } elseif ( $context instanceof
User || $context ===
null ) {
1139 if ( $context ===
null ) {
1142 $ret =
new self( $context, $userLang );
1144 throw new InvalidArgumentException(
1145 '$context must be an IContextSource, the string "canonical", a User, or null'
1149 foreach ( self::getCanonicalOverrides() as $k => $v ) {
1150 $ret->setOption( $k, $v );
1172 if ( self::$defaults ===
null ) {
1175 'dateformat' =>
null,
1177 'interfaceMessage' =>
false,
1178 'targetLanguage' =>
null,
1179 'removeComments' =>
true,
1180 'enableLimitReport' =>
false,
1181 'preSaveTransform' =>
true,
1182 'isPreview' =>
false,
1183 'isSectionPreview' =>
false,
1184 'printable' =>
false,
1185 'allowUnsafeRawHtml' =>
true,
1186 'wrapclass' =>
'mw-parser-output',
1187 'currentRevisionCallback' => [ Parser::class,
'statelessFetchRevision' ],
1188 'currentRevisionRecordCallback' => [ Parser::class,
'statelessFetchRevisionRecord' ],
1189 'templateCallback' => [ Parser::class,
'statelessFetchTemplate' ],
1190 'speculativeRevIdCallback' =>
null,
1191 'speculativeRevId' =>
null,
1192 'speculativePageIdCallback' =>
null,
1193 'speculativePageId' =>
null,
1196 Hooks::runner()->onParserOptionsRegister(
1202 ksort( self::$inCacheKey );
1206 return self::$defaults + [
1226 'stubthreshold' => 0,
1227 'userlang' => MediaWikiServices::getInstance()->getContentLanguage(),
1255 $this->options = self::getDefaults();
1257 $this->mUser = $user;
1258 $this->options[
'numberheadings'] = $user->getOption(
'numberheadings' );
1259 $this->options[
'thumbsize'] = $user->getOption(
'thumbsize' );
1260 $this->options[
'stubthreshold'] = $user->getStubThreshold();
1261 $this->options[
'userlang'] =
$lang;
1275 $options = array_keys( $this->options );
1277 'enableLimitReport',
1286 if ( $o1 !== $o2 ) {
1292 $fields = array_keys( get_class_vars( __CLASS__ ) );
1293 $fields = array_diff( $fields, [
1300 foreach ( $fields as $field ) {
1301 if ( !is_object( $this->$field ) && $this->$field !== $other->$field ) {
1315 foreach ( self::allCacheVaryingOptions() as $option ) {
1322 if ( $o1 !== $o2 ) {
1336 $this->onAccessCallback = $callback;
1348 if ( $this->onAccessCallback ) {
1349 call_user_func( $this->onAccessCallback, $optionName );
1361 if ( self::$defaults ===
null ) {
1362 self::getDefaults();
1364 return array_keys( array_filter( self::$inCacheKey ) );
1373 if ( $value ===
true ) {
1375 } elseif ( $value ===
false ) {
1377 } elseif ( $value ===
null ) {
1379 } elseif ( $value instanceof
Language ) {
1380 return $value->getCode();
1381 } elseif ( is_array( $value ) ) {
1382 return '[' . implode(
',', array_map( [ $this,
'optionToString' ], $value ) ) .
']';
1384 return (
string)$value;
1406 $lazyOpts = array_intersect( $forOptions,
$inCacheKey, array_keys( self::$lazyOptions ) );
1407 foreach ( $lazyOpts as $k ) {
1412 $defaults = self::getCanonicalOverrides() + self::getDefaults();
1420 foreach ( array_intersect(
$inCacheKey, $forOptions ) as $option ) {
1424 $values[] =
"$option=$v";
1428 $confstr = $values ? implode(
'!', $values ) :
'canonical';
1434 MediaWikiServices::getInstance()->getContentLanguage();
1435 $converter = MediaWikiServices::getInstance()->getLanguageConverterFactory()
1436 ->getLanguageConverter(
$lang );
1437 $confstr .= $converter->getExtraHashOptions();
1441 if ( $this->mExtraKey !=
'' ) {
1442 $confstr .= $this->mExtraKey;
1447 Hooks::runner()->onPageRenderingHash( $confstr, $this->
getUser(), $forOptions );
1450 $confstr = str_replace(
' ',
'_', $confstr );
1461 $defaults = self::getCanonicalOverrides() + self::getDefaults();
1462 foreach ( $this->options as $option => $value ) {
1463 if ( empty( self::$inCacheKey[$option] ) ) {
1487 $titleToCheck, $parser =
null ) use (
$title,
$content, $user, &$oldCallback
1489 if ( $titleToCheck->equals(
$title ) ) {
1490 $revRecord = new MutableRevisionRecord( $title );
1491 $revRecord->setContent( SlotRecord::MAIN, $content );
1492 $revRecord->setUser( $user );
1493 $revRecord->setTimestamp( MWTimestamp::now( TS_MW ) );
1494 $revRecord->setPageId( $title->getArticleID() );
1495 $revRecord->setParentId( $title->getLatestRevID() );
1498 return call_user_func( $oldCallback, $titleToCheck, $parser );
1505 function ( $titleToCheck, &$exists ) use (
$title ) {
1506 if ( $titleToCheck->equals(
$title ) ) {
1511 $key = key(
$wgHooks[
'TitleExists'] );
1512 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
1513 $linkCache->clearBadLink(
$title->getPrefixedDBkey() );
1514 return new ScopedCallback(
function () use (
$title, $key, $linkCache ) {
1516 unset(
$wgHooks[
'TitleExists'][$key] );
1517 $linkCache->clearLink(
$title );
$wgMaxTemplateDepth
Maximum recursion depth for templates within templates.
$wgMaxPPNodeCount
A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand()
$wgMaxArticleSize
Maximum article size in kilobytes.
$wgEnableParserLimitReporting
Whether to include the NewPP limit report as a HTML comment.
$wgEnableImageWhitelist
If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragmen...
$wgCleanSignatures
If true, removes (by substituting) templates in signatures.
$wgRenderHashAppend
Append a configured value to the parser cache and the sitenotice key so that they can be kept separat...
$wgDisableLangConversion
Whether to enable language variant conversion.
$wgAllowSpecialInclusion
Allow special page inclusions such as {{Special:Allpages}}.
$wgAllowExternalImagesFrom
If the above is false, you can specify an exception here.
$wgHooks
Global list of hooks.
$wgInterwikiMagic
Treat language links as magic connectors, not inline links.
$wgAllowExternalImages
Whether to allow inline image pointing to other websites.
$wgEnableMagicLinks
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
$wgExternalLinkTarget
Set a default target for external links, e.g.
$wgExpensiveParserFunctionLimit
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.
$wgDisableTitleConversion
Whether to enable language variant conversion for links.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfDeprecatedMsg( $msg, $version=false, $component=false, $callerOffset=2)
Log a deprecation warning with arbitrary message text.
wfSetVar(&$dest, $source, $force=false)
Sets dest to source and returns the original value of dest If source is NULL, it just returns the val...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that $function is deprecated.
Internationalisation code See https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation for more...
Set options of the Parser.
setAllowExternalImagesFrom( $x)
External images to allow.
disableTitleConversion( $x=true)
Whether title conversion should be disabled.
setIsSectionPreview( $x)
Parsing the page for a "preview" operation on a single section?
setIsPrintable( $x)
Parsing the printable version of the page?
getRedirectTarget()
Get the previously-set redirect target.
getCurrentRevisionRecordCallback()
Callback for current revision fetching; first argument to call_user_func().
setAllowUnsafeRawHtml( $x)
If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of...
static callable[] $lazyOptions
Lazy-loaded options.
matchesForCacheKey(ParserOptions $other)
getTidy()
Use tidy to cleanup output HTML?
static initSpeculativeRevId(ParserOptions $popt)
Callback registered with ParserOptions::$lazyOptions, triggered by getSpeculativeRevId().
setIsPreview( $x)
Parsing the page for a "preview" operation?
setDateFormat( $x)
Date format index.
enableLimitReport( $x=true)
Enable limit report in an HTML comment on output.
setTidy( $x)
Use tidy to cleanup output HTML?
optionToString( $value)
Convert an option to a string value.
callable null $onAccessCallback
Function to be called when an option is accessed.
getAllowExternalImages()
Allow all external images inline?
static initDateFormat(ParserOptions $popt)
Lazy initializer for dateFormat.
setNumberHeadings( $x)
Automatically number headings?
static initSpeculativePageId(ParserOptions $popt)
Callback registered with ParserOptions::$lazyOptions, triggered by getSpeculativePageId().
matches(ParserOptions $other)
Check if these options match that of another options set.
getMaxIncludeSize()
Maximum size of template expansions, in bytes.
setStubThreshold( $x)
Thumb size preferred by the user.
setTemplateCallback( $x)
Callback for template fetching; first argument to call_user_func().
setAllowExternalImages( $x)
Allow all external images inline?
getUserLangObj()
Get the user language used by the parser for this page and split the parser cache.
setMaxIncludeSize( $x)
Maximum size of template expansions, in bytes.
static newCanonical( $context=null, $userLang=null)
Creates a "canonical" ParserOptions object.
static getCanonicalOverrides()
Get "canonical" non-default option values.
getEnableImageWhitelist()
Use the on-wiki external image whitelist?
getTargetLanguage()
Target language for the parse.
getAllowExternalImagesFrom()
External images to allow.
getCurrentRevisionCallback()
Callback for current revision fetching; first argument to call_user_func().
getIsSectionPreview()
Parsing the page for a "preview" operation on a single section?
getDisableContentConversion()
Whether content conversion should be disabled.
setInterfaceMessage( $x)
Parsing an interface message?
setTimestamp( $x)
Timestamp used for {{CURRENTDAY}} etc.
getMaxPPExpandDepth()
Maximum recursion depth in PPFrame::expand()
getExpensiveParserFunctionLimit()
Maximum number of calls per parse to expensive parser functions.
getAllowUnsafeRawHtml()
If the wiki is configured to allow raw html ($wgRawHtml = true) is it allowed in the specific case of...
getNumberHeadings()
Automatically number headings?
setCurrentRevisionCallback( $x)
Callback for current revision fetching; first argument to call_user_func().
getIsPreview()
Parsing the page for a "preview" operation?
static getDefaults()
Get default option values.
setOptionLegacy( $name, $value)
Legacy implementation.
setCurrentRevisionRecordCallback( $x)
Callback for current revision fetching; first argument to call_user_func().
getSpeculativePageId()
A guess for {{PAGEID}}, calculated using the callback provided via setSpeculativeRevPageCallback().
setMaxTemplateDepth( $x)
Maximum recursion depth for templates within templates.
setEnableImageWhitelist( $x)
Use the on-wiki external image whitelist?
getPreSaveTransform()
Transform wiki markup when saving the page?
setWrapOutputClass( $className)
CSS class to use to wrap output from Parser::parse()
User $mUser
Stored user object.
optionUsed( $optionName)
Called when an option is accessed.
setRedirectTarget( $title)
Set the redirect target.
getWrapOutputClass()
Class to use to wrap output from Parser::parse()
getIsPrintable()
Parsing the printable version of the page?
getStubThreshold()
Thumb size preferred by the user.
disableContentConversion( $x=true)
Whether content conversion should be disabled.
initialiseFromUser( $user, $lang)
Get user options.
getOption( $name)
Fetch an option and track that is was accessed.
setThumbSize( $x)
Thumb size preferred by the user.
optionsHash( $forOptions, $title=null)
Generate a hash string with the values set on these ParserOptions for the keys given in the array.
$mExtraKey
Appended to the options hash.
setAllowSpecialInclusion( $x)
Allow inclusion of special pages?
setOption( $name, $value)
Set an option, generically.
getMaxTemplateDepth()
Maximum recursion depth for templates within templates.
getAllowSpecialInclusion()
Allow inclusion of special pages?
setTargetLanguage( $x)
Target language for the parse.
string null $mTimestamp
Timestamp used for {{CURRENTDAY}} etc.
getMagicRFCLinks()
Are magic RFC links enabled?
setupFakeRevision( $title, $content, $user)
Sets a hook to force that a page exists, and sets a current revision callback to return a revision wi...
getMagicPMIDLinks()
Are magic PMID links enabled?
static array $inCacheKey
Specify options that are included in the cache key.
static newFromContext(IContextSource $context)
Get a ParserOptions object from a IContextSource object.
registerWatcher( $callback)
Registers a callback for tracking which ParserOptions which are used.
getCleanSignatures()
Clean up signature texts?
addExtraKey( $key)
Extra key that should be present in the parser cache key.
setInterwikiMagic( $x)
Specify whether to extract interlanguage links.
static newFromAnon()
Get a ParserOptions object for an anonymous user.
setUserLang( $x)
Set the user language used by the parser for this page and split the parser cache.
static newFromUser( $user)
Get a ParserOptions object from a given user.
getUserLang()
Same as getUserLangObj() but returns a string instead.
getDateFormat()
Date format index.
setExternalLinkTarget( $x)
Target attribute for external links.
array $options
Current values for all options that are relevant for caching.
getRemoveComments()
Remove HTML comments.
setRemoveComments( $x)
Remove HTML comments.
Title null $redirectTarget
If the page being parsed is a redirect, this should hold the redirect target.
getMaxPPNodeCount()
Maximum number of nodes touched by PPFrame::expand()
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
getEnableLimitReport()
Enable limit report in an HTML comment on output.
getExternalLinkTarget()
Target attribute for external links.
getMagicISBNLinks()
Are magic ISBN links enabled?
getThumbSize()
Thumb size preferred by the user.
getInterwikiMagic()
Whether to extract interlanguage links.
__construct( $user=null, $lang=null)
getTimestamp()
Timestamp used for {{CURRENTDAY}} etc.
getTemplateCallback()
Callback for template fetching; first argument to call_user_func().
getSpeculativeRevId()
A guess for {{REVISIONID}}, calculated using the callback provided via setSpeculativeRevIdCallback().
setSpeculativeRevIdCallback( $x)
Callback to generate a guess for {{REVISIONID}}.
isSafeToCache()
Test whether these options are safe to cache.
getDisableTitleConversion()
Whether title conversion should be disabled.
getInterfaceMessage()
Parsing an interface message?
static allCacheVaryingOptions()
Return all option keys that vary the options hash.
setExpensiveParserFunctionLimit( $x)
Maximum number of calls per parse to expensive parser functions.
setPreSaveTransform( $x)
Transform wiki markup when saving the page?
setMaxPPNodeCount( $x)
Maximum number of nodes touched by PPFrame::expand()
static array null $defaults
Default values for all options that are relevant for caching.
setCleanSignatures( $x)
Clean up signature texts?
setSpeculativePageIdCallback( $x)
Callback to generate a guess for {{PAGEID}}.
static unstub(&$obj)
Unstubs an object, if it is a stub object.
Represents a title within MediaWiki.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static getDefaultOption( $opt)
Get a given default option value.
Interface for objects which can provide a MediaWiki context on request.
if(!isset( $args[0])) $lang