26use Wikimedia\ScopedCallback;
82 # Flags for Parser::setFunctionHook
86 # Constants needed for external link processing
87 # Everything except bracket, space, or control characters
88 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
89 # as well as U+3000 is IDEOGRAPHIC SPACE for T21052
90 # \x{FFFD} is the Unicode replacement character, which Preprocessor_DOM
91 # uses to replace invalid HTML characters.
93 # Simplified expression to match an IPv4 or IPv6 address, or
94 # at least one character of a host name (embeds EXT_LINK_URL_CLASS)
95 const EXT_LINK_ADDR =
'(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}])';
96 # RegExp to make image URLs (embeds IPv6 part of EXT_LINK_ADDR)
98 const EXT_IMAGE_REGEX =
'/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]+)
99 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
101 # Regular expression for a non-newline space
104 # Flags for preprocessToDom
107 # Allowed values for $this->mOutputType
108 # Parameter to startExternalParse().
113 const
OT_PLAIN = 4;
# like extractSections() - portions of the original are returned unchanged.
132 const MARKER_SUFFIX =
"-QINU`\"'\x7f";
135 # Markers used for wrapping the table of contents
157 public $mFirstCall =
true;
159 # Initialised by initialiseVariables()
170 # Initialised in constructor
171 public $mConf, $mExtLinkBracketedRegex, $mUrlProtocols;
173 # Initialized in getPreprocessor()
177 # Cleared with clearState():
208 # These are variables reset at least once per parse regardless of $clearState
221 public $mRevisionObject;
# The revision object of the specified revision ID
233 public $mUniqPrefix = self::MARKER_PREFIX;
254 public $mInParse =
false;
288 $this->mConf = $conf;
290 $this->mExtLinkBracketedRegex =
'/\[(((?i)' . $this->mUrlProtocols .
')' .
291 self::EXT_LINK_ADDR .
292 self::EXT_LINK_URL_CLASS .
'*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F\\x{FFFD}]*?)\]/Su';
293 if ( isset( $conf[
'preprocessorClass'] ) ) {
294 $this->mPreprocessorClass = $conf[
'preprocessorClass'];
296 # Under HHVM Preprocessor_Hash is much faster than Preprocessor_DOM
297 $this->mPreprocessorClass = Preprocessor_Hash::class;
298 } elseif ( extension_loaded(
'domxml' ) ) {
299 # PECL extension that conflicts with the core DOM extension (T15770)
300 wfDebug(
"Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
301 $this->mPreprocessorClass = Preprocessor_Hash::class;
302 } elseif ( extension_loaded(
'dom' ) ) {
303 $this->mPreprocessorClass = Preprocessor_DOM::class;
305 $this->mPreprocessorClass = Preprocessor_Hash::class;
307 wfDebug( __CLASS__ .
": using preprocessor: {$this->mPreprocessorClass}\n" );
309 $services = MediaWikiServices::getInstance();
310 $this->magicWordFactory = $magicWordFactory ??
313 $this->contLang = $contLang ??
$services->getContentLanguage();
315 $this->factory = $factory ??
$services->getParserFactory();
316 $this->specialPageFactory = $spFactory ??
$services->getSpecialPageFactory();
323 if ( isset( $this->mLinkHolders ) ) {
324 unset( $this->mLinkHolders );
327 unset( $this->
$name );
335 $this->mInParse =
false;
343 foreach ( [
'mStripState',
'mVarCache' ]
as $k ) {
351 Hooks::run(
'ParserCloned', [ $this ] );
358 if ( !$this->mFirstCall ) {
361 $this->mFirstCall =
false;
369 Hooks::run(
'ParserFirstCallInit', [ &
$parser ] );
380 $this->mOptions->registerWatcher( [ $this->mOutput,
'recordOption' ] );
381 $this->mAutonumber = 0;
382 $this->mIncludeCount = [];
385 $this->mRevisionObject = $this->mRevisionTimestamp =
386 $this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize =
null;
387 $this->mVarCache = [];
389 $this->mLangLinkLanguages = [];
390 $this->currentRevisionCache =
null;
394 # Clear these on every parse, T6549
395 $this->mTplRedirCache = $this->mTplDomCache = [];
397 $this->mShowToc =
true;
398 $this->mForceTocPosition =
false;
399 $this->mIncludeSizes = [
403 $this->mPPNodeCount = 0;
404 $this->mGeneratedPPNodeCount = 0;
405 $this->mHighestExpansionDepth = 0;
406 $this->mDefaultSort =
false;
407 $this->mHeadings = [];
408 $this->mDoubleUnderscores = [];
409 $this->mExpensiveFunctionCount = 0;
412 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
413 $this->mPreprocessor =
null;
420 Hooks::run(
'ParserClearState', [ &
$parser ] );
439 $linestart =
true, $clearState =
true, $revid =
null
444 $text = strtr( $text,
"\x7f",
"?" );
445 $magicScopeVariable = $this->
lock();
448 $text = str_replace(
"\000",
'', $text );
452 $this->currentRevisionCache =
null;
453 $this->mInputSize = strlen( $text );
454 if ( $this->mOptions->getEnableLimitReport() ) {
455 $this->mOutput->resetParseStartTime();
458 $oldRevisionId = $this->mRevisionId;
459 $oldRevisionObject = $this->mRevisionObject;
460 $oldRevisionTimestamp = $this->mRevisionTimestamp;
461 $oldRevisionUser = $this->mRevisionUser;
462 $oldRevisionSize = $this->mRevisionSize;
463 if ( $revid !==
null ) {
464 $this->mRevisionId = $revid;
465 $this->mRevisionObject =
null;
466 $this->mRevisionTimestamp =
null;
467 $this->mRevisionUser =
null;
468 $this->mRevisionSize =
null;
473 Hooks::run(
'ParserBeforeStrip', [ &
$parser, &$text, &$this->mStripState ] );
475 Hooks::run(
'ParserAfterStrip', [ &
$parser, &$text, &$this->mStripState ] );
477 Hooks::run(
'ParserAfterParse', [ &
$parser, &$text, &$this->mStripState ] );
488 if ( !(
$options->getDisableTitleConversion()
489 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] )
490 || isset( $this->mDoubleUnderscores[
'notitleconvert'] )
491 || $this->mOutput->getDisplayTitle() !==
false )
494 if ( $convruletitle ) {
495 $this->mOutput->setTitleText( $convruletitle );
498 $this->mOutput->setTitleText( $titleText );
502 # Compute runtime adaptive expiry if set
503 $this->mOutput->finalizeAdaptiveCacheExpiry();
505 # Warn if too many heavyweight parser functions were used
506 if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
508 $this->mExpensiveFunctionCount,
509 $this->mOptions->getExpensiveParserFunctionLimit()
513 # Information on limits, for the benefit of users who try to skirt them
514 if ( $this->mOptions->getEnableLimitReport() ) {
518 # Wrap non-interface parser output in a <div> so it can be targeted
520 $class = $this->mOptions->getWrapOutputClass();
521 if ( $class !==
false && !$this->mOptions->getInterfaceMessage() ) {
522 $this->mOutput->addWrapperDivClass( $class );
525 $this->mOutput->setText( $text );
527 $this->mRevisionId = $oldRevisionId;
528 $this->mRevisionObject = $oldRevisionObject;
529 $this->mRevisionTimestamp = $oldRevisionTimestamp;
530 $this->mRevisionUser = $oldRevisionUser;
531 $this->mRevisionSize = $oldRevisionSize;
532 $this->mInputSize =
false;
533 $this->currentRevisionCache =
null;
535 return $this->mOutput;
547 $maxIncludeSize = $this->mOptions->getMaxIncludeSize();
549 $cpuTime = $this->mOutput->getTimeSinceStart(
'cpu' );
550 if ( $cpuTime !==
null ) {
551 $this->mOutput->setLimitReportData(
'limitreport-cputime',
552 sprintf(
"%.3f", $cpuTime )
556 $wallTime = $this->mOutput->getTimeSinceStart(
'wall' );
557 $this->mOutput->setLimitReportData(
'limitreport-walltime',
558 sprintf(
"%.3f", $wallTime )
561 $this->mOutput->setLimitReportData(
'limitreport-ppvisitednodes',
562 [ $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() ]
564 $this->mOutput->setLimitReportData(
'limitreport-ppgeneratednodes',
565 [ $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() ]
567 $this->mOutput->setLimitReportData(
'limitreport-postexpandincludesize',
568 [ $this->mIncludeSizes[
'post-expand'], $maxIncludeSize ]
570 $this->mOutput->setLimitReportData(
'limitreport-templateargumentsize',
571 [ $this->mIncludeSizes[
'arg'], $maxIncludeSize ]
573 $this->mOutput->setLimitReportData(
'limitreport-expansiondepth',
574 [ $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() ]
576 $this->mOutput->setLimitReportData(
'limitreport-expensivefunctioncount',
577 [ $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() ]
580 foreach ( $this->mStripState->getLimitReport()
as list( $key,
$value ) ) {
581 $this->mOutput->setLimitReportData( $key,
$value );
584 Hooks::run(
'ParserLimitReportPrepare', [ $this, $this->mOutput ] );
586 $limitReport =
"NewPP limit report\n";
588 $limitReport .=
'Parsed by ' .
wfHostname() .
"\n";
590 $limitReport .=
'Cached time: ' . $this->mOutput->getCacheTime() .
"\n";
591 $limitReport .=
'Cache expiry: ' . $this->mOutput->getCacheExpiry() .
"\n";
592 $limitReport .=
'Dynamic content: ' .
593 ( $this->mOutput->hasDynamicContent() ?
'true' :
'false' ) .
596 foreach ( $this->mOutput->getLimitReportData()
as $key =>
$value ) {
597 if ( Hooks::run(
'ParserLimitReportFormat',
598 [ $key, &
$value, &$limitReport,
false,
false ]
600 $keyMsg =
wfMessage( $key )->inLanguage(
'en' )->useDatabase(
false );
601 $valueMsg =
wfMessage( [
"$key-value-text",
"$key-value" ] )
602 ->inLanguage(
'en' )->useDatabase(
false );
603 if ( !$valueMsg->exists() ) {
606 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
607 $valueMsg->params(
$value );
608 $limitReport .=
"{$keyMsg->text()}: {$valueMsg->text()}\n";
614 $limitReport = htmlspecialchars_decode( $limitReport );
618 $limitReport = str_replace( [
'-',
'&' ], [
'‐',
'&' ], $limitReport );
619 $text =
"\n<!-- \n$limitReport-->\n";
622 $dataByFunc = $this->mProfiler->getFunctionStats();
623 uasort( $dataByFunc,
function ( $a, $b ) {
624 return $b[
'real'] <=> $a[
'real'];
627 foreach ( array_slice( $dataByFunc, 0, 10 )
as $item ) {
628 $profileReport[] = sprintf(
"%6.2f%% %8.3f %6d %s",
629 $item[
'%real'], $item[
'real'], $item[
'calls'],
630 htmlspecialchars( $item[
'name'] ) );
632 $text .=
"<!--\nTransclusion expansion time report (%,ms,calls,template)\n";
633 $text .= implode(
"\n", $profileReport ) .
"\n-->\n";
635 $this->mOutput->setLimitReportData(
'limitreport-timingprofile', $profileReport );
639 $this->mOutput->setLimitReportData(
'cachereport-origin',
wfHostname() );
641 $this->mOutput->setLimitReportData(
'cachereport-timestamp',
642 $this->mOutput->getCacheTime() );
643 $this->mOutput->setLimitReportData(
'cachereport-ttl',
644 $this->mOutput->getCacheExpiry() );
645 $this->mOutput->setLimitReportData(
'cachereport-transientcontent',
646 $this->mOutput->hasDynamicContent() );
648 if ( $this->mGeneratedPPNodeCount > $this->mOptions->getMaxGeneratedPPNodeCount() / 10 ) {
649 wfDebugLog(
'generated-pp-node-count', $this->mGeneratedPPNodeCount .
' ' .
650 $this->mTitle->getPrefixedDBkey() );
682 Hooks::run(
'ParserBeforeStrip', [ &
$parser, &$text, &$this->mStripState ] );
683 Hooks::run(
'ParserAfterStrip', [ &
$parser, &$text, &$this->mStripState ] );
727 $magicScopeVariable = $this->
lock();
729 if ( $revid !==
null ) {
730 $this->mRevisionId = $revid;
734 Hooks::run(
'ParserBeforeStrip', [ &
$parser, &$text, &$this->mStripState ] );
735 Hooks::run(
'ParserAfterStrip', [ &
$parser, &$text, &$this->mStripState ] );
737 $text = $this->mStripState->unstripBoth( $text );
752 $text = $this->mStripState->unstripBoth( $text );
771 $text = $msg->params(
$params )->plain();
773 # Parser (re)initialisation
774 $magicScopeVariable = $this->
lock();
780 $text = $this->mStripState->unstripBoth( $text );
791 $this->mUser =
$user;
801 $t = Title::newFromText(
'NO TITLE' );
804 if (
$t->hasFragment() ) {
805 # Strip the fragment to avoid various odd effects
806 $this->mTitle =
$t->createFragmentTarget(
'' );
818 return $this->mTitle;
827 public function Title( $x =
null ) {
828 return wfSetVar( $this->mTitle, $x );
837 $this->mOutputType =
$ot;
854 return wfSetVar( $this->mOutputType, $x );
863 return $this->mOutput;
872 return $this->mOptions;
882 return wfSetVar( $this->mOptions, $x );
889 return $this->mLinkID++;
896 $this->mLinkID = $id;
917 $target = $this->mOptions->getTargetLanguage();
919 if ( $target !==
null ) {
921 } elseif ( $this->mOptions->getInterfaceMessage() ) {
922 return $this->mOptions->getUserLangObj();
923 } elseif ( is_null( $this->mTitle ) ) {
924 throw new MWException( __METHOD__ .
': $this->mTitle is null' );
927 return $this->mTitle->getPageLanguage();
946 if ( !is_null( $this->mUser ) ) {
949 return $this->mOptions->getUser();
958 if ( !isset( $this->mPreprocessor ) ) {
959 $class = $this->mPreprocessorClass;
960 $this->mPreprocessor =
new $class( $this );
962 return $this->mPreprocessor;
972 if ( !$this->mLinkRenderer ) {
973 $this->mLinkRenderer = MediaWikiServices::getInstance()
974 ->getLinkRendererFactory()->create();
975 $this->mLinkRenderer->setStubThreshold(
980 return $this->mLinkRenderer;
990 return $this->magicWordFactory;
1000 return $this->contLang;
1027 $taglist = implode(
'|', $elements );
1028 $start =
"/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" .
">)|<(!--)/i";
1030 while ( $text !=
'' ) {
1031 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
1033 if ( count( $p ) < 5 ) {
1036 if ( count( $p ) > 5 ) {
1045 $attributes = $p[2];
1050 $marker = self::MARKER_PREFIX .
"-$element-" . sprintf(
'%08X', $n++ ) . self::MARKER_SUFFIX;
1051 $stripped .= $marker;
1053 if ( $close ===
'/>' ) {
1054 # Empty element tag, <tag />
1059 if ( $element ===
'!--' ) {
1062 $end =
"/(<\\/$element\\s*>)/i";
1064 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
1066 if ( count( $q ) < 3 ) {
1067 # No end tag -- let it run out to the end of the text.
1078 Sanitizer::decodeTagAttributes( $attributes ),
1079 "<$element$attributes$close$content$tail" ];
1090 return $this->mStripList;
1103 $marker = self::MARKER_PREFIX .
"-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
1104 $this->mMarkerIndex++;
1105 $this->mStripState->addGeneral( $marker, $text );
1119 $td_history = []; # Is currently a td tag open?
1120 $last_tag_history = []; # Save
history of last lag activated (td, th
or caption)
1121 $tr_history = []; # Is currently a tr tag open?
1122 $tr_attributes = []; #
history of tr attributes
1123 $has_opened_tr = []; # Did
this table open a <tr> element?
1124 $indent_level = 0; # indent level
of the
table
1127 $line = trim( $outLine );
1129 if (
$line ===
'' ) { # empty line, go to next line
1130 $out .= $outLine .
"\n";
1134 $first_character =
$line[0];
1135 $first_two = substr(
$line, 0, 2 );
1138 if ( preg_match(
'/^(:*)\s*\{\|(.*)$/',
$line,
$matches ) ) {
1139 # First check if we are starting a new table
1140 $indent_level = strlen(
$matches[1] );
1142 $attributes = $this->mStripState->unstripBoth(
$matches[2] );
1143 $attributes = Sanitizer::fixTagAttributes( $attributes,
'table' );
1145 $outLine = str_repeat(
'<dl><dd>', $indent_level ) .
"<table{$attributes}>";
1146 array_push( $td_history,
false );
1147 array_push( $last_tag_history,
'' );
1148 array_push( $tr_history,
false );
1149 array_push( $tr_attributes,
'' );
1150 array_push( $has_opened_tr,
false );
1151 } elseif ( count( $td_history ) == 0 ) {
1152 # Don't do any of the following
1153 $out .= $outLine .
"\n";
1155 } elseif ( $first_two ===
'|}' ) {
1156 # We are ending a table
1158 $last_tag = array_pop( $last_tag_history );
1160 if ( !array_pop( $has_opened_tr ) ) {
1161 $line =
"<tr><td></td></tr>{$line}";
1164 if ( array_pop( $tr_history ) ) {
1165 $line =
"</tr>{$line}";
1168 if ( array_pop( $td_history ) ) {
1169 $line =
"</{$last_tag}>{$line}";
1171 array_pop( $tr_attributes );
1172 if ( $indent_level > 0 ) {
1173 $outLine = rtrim(
$line ) . str_repeat(
'</dd></dl>', $indent_level );
1177 } elseif ( $first_two ===
'|-' ) {
1178 # Now we have a table row
1179 $line = preg_replace(
'#^\|-+#',
'',
$line );
1181 # Whats after the tag is now only attributes
1182 $attributes = $this->mStripState->unstripBoth(
$line );
1183 $attributes = Sanitizer::fixTagAttributes( $attributes,
'tr' );
1184 array_pop( $tr_attributes );
1185 array_push( $tr_attributes, $attributes );
1188 $last_tag = array_pop( $last_tag_history );
1189 array_pop( $has_opened_tr );
1190 array_push( $has_opened_tr,
true );
1192 if ( array_pop( $tr_history ) ) {
1196 if ( array_pop( $td_history ) ) {
1197 $line =
"</{$last_tag}>{$line}";
1201 array_push( $tr_history,
false );
1202 array_push( $td_history,
false );
1203 array_push( $last_tag_history,
'' );
1204 } elseif ( $first_character ===
'|'
1205 || $first_character ===
'!'
1206 || $first_two ===
'|+'
1208 # This might be cell elements, td, th or captions
1209 if ( $first_two ===
'|+' ) {
1210 $first_character =
'+';
1217 if ( $first_character ===
'!' ) {
1221 # Split up multiple cells on the same line.
1222 # FIXME : This can result in improper nesting of tags processed
1223 # by earlier parser steps.
1224 $cells = explode(
'||',
$line );
1228 # Loop through each table cell
1229 foreach ( $cells
as $cell ) {
1231 if ( $first_character !==
'+' ) {
1232 $tr_after = array_pop( $tr_attributes );
1233 if ( !array_pop( $tr_history ) ) {
1234 $previous =
"<tr{$tr_after}>\n";
1236 array_push( $tr_history,
true );
1237 array_push( $tr_attributes,
'' );
1238 array_pop( $has_opened_tr );
1239 array_push( $has_opened_tr,
true );
1242 $last_tag = array_pop( $last_tag_history );
1244 if ( array_pop( $td_history ) ) {
1245 $previous =
"</{$last_tag}>\n{$previous}";
1248 if ( $first_character ===
'|' ) {
1250 } elseif ( $first_character ===
'!' ) {
1252 } elseif ( $first_character ===
'+' ) {
1253 $last_tag =
'caption';
1258 array_push( $last_tag_history, $last_tag );
1260 # A cell could contain both parameters and data
1261 $cell_data = explode(
'|', $cell, 2 );
1263 # T2553: Note that a '|' inside an invalid link should not
1264 # be mistaken as delimiting cell parameters
1265 # Bug T153140: Neither should language converter markup.
1266 if ( preg_match(
'/\[\[|-\{/', $cell_data[0] ) === 1 ) {
1267 $cell =
"{$previous}<{$last_tag}>" . trim( $cell );
1268 } elseif ( count( $cell_data ) == 1 ) {
1270 $cell =
"{$previous}<{$last_tag}>" . trim( $cell_data[0] );
1272 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
1273 $attributes = Sanitizer::fixTagAttributes( $attributes, $last_tag );
1275 $cell =
"{$previous}<{$last_tag}{$attributes}>" . trim( $cell_data[1] );
1279 array_push( $td_history,
true );
1282 $out .= $outLine .
"\n";
1285 # Closing open td, tr && table
1286 while ( count( $td_history ) > 0 ) {
1287 if ( array_pop( $td_history ) ) {
1290 if ( array_pop( $tr_history ) ) {
1293 if ( !array_pop( $has_opened_tr ) ) {
1294 $out .=
"<tr><td></td></tr>\n";
1297 $out .=
"</table>\n";
1300 # Remove trailing line-ending (b/c)
1301 if ( substr(
$out, -1 ) ===
"\n" ) {
1305 # special case: don't return empty table
1306 if (
$out ===
"<table>\n<tr><td></td></tr>\n</table>" ) {
1332 # Hook to suspend the parser in this state
1333 if ( !Hooks::run(
'ParserBeforeInternalParse', [ &
$parser, &$text, &$this->mStripState ] ) ) {
1337 # if $frame is provided, then use $frame for replacing any variables
1339 # use frame depth to infer how include/noinclude tags should be handled
1340 # depth=0 means this is the top-level document; otherwise it's an included document
1341 if ( !$frame->depth ) {
1344 $flag = self::PTD_FOR_INCLUSION;
1347 $text = $frame->expand( $dom );
1349 # if $frame is not provided, then use old-style replaceVariables
1353 Hooks::run(
'InternalParseBeforeSanitize', [ &
$parser, &$text, &$this->mStripState ] );
1354 $text = Sanitizer::removeHTMLtags(
1356 [ $this,
'attributeStripCallback' ],
1358 array_keys( $this->mTransparentTagHooks ),
1360 [ $this,
'addTrackingCategory' ]
1362 Hooks::run(
'InternalParseBeforeLinks', [ &
$parser, &$text, &$this->mStripState ] );
1364 # Tables need to come after variable replacement for things to work
1365 # properly; putting them before other transformations should keep
1366 # exciting things like link expansions from showing up in surprising
1370 $text = preg_replace(
'/(^|\n)-----*/',
'\\1<hr />', $text );
1379 # replaceInternalLinks may sometimes leave behind
1380 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1381 $text = str_replace( self::MARKER_PREFIX .
'NOPARSE',
'', $text );
1399 $text = $this->mStripState->unstripGeneral( $text );
1405 Hooks::run(
'ParserAfterUnstrip', [ &
$parser, &$text ] );
1408 # Clean up special characters, only run once, next-to-last before doBlockLevels
1409 $text = Sanitizer::armorFrenchSpaces( $text );
1422 if ( !( $this->mOptions->getDisableContentConversion()
1423 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] ) )
1425 if ( !$this->mOptions->getInterfaceMessage() ) {
1426 # The position of the convert() call should not be changed. it
1427 # assumes that the links are all replaced and the only thing left
1428 # is the <nowiki> mark.
1433 $text = $this->mStripState->unstripNoWiki( $text );
1436 Hooks::run(
'ParserBeforeTidy', [ &
$parser, &$text ] );
1440 $text = $this->mStripState->unstripGeneral( $text );
1442 $text = Sanitizer::normalizeCharReferences( $text );
1445 if ( $this->mOptions->getTidy() ) {
1449 # attempt to sanitize at least some nesting problems
1450 # (T4702 and quite a few others)
1452 # ''Something [http:
1453 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
1454 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
1455 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
1456 # fix up an anchor inside another anchor, only
1457 # at least for a single single nested link (T5695)
1458 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
1459 '\\1\\2</a>\\3</a>\\1\\4</a>',
1460 # fix div inside inline elements- doBlockLevels won't wrap a line which
1461 # contains a div, so fix it up here; replace
1462 # div with escaped text
1463 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
1464 '\\1\\3<div\\5>\\6</div>\\8\\9',
1465 # remove empty italic or bold tag pairs, some
1466 # introduced by rules above
1467 '/<([bi])><\/\\1>/' =>
'',
1470 $text = preg_replace(
1471 array_keys( $tidyregs ),
1472 array_values( $tidyregs ),
1477 Hooks::run(
'ParserAfterTidy', [ &
$parser, &$text ] );
1496 $urlChar = self::EXT_LINK_URL_CLASS;
1497 $addr = self::EXT_LINK_ADDR;
1498 $space = self::SPACE_NOT_NL; # non-newline space
1499 $spdash =
"(?:-|$space)"; # a dash
or a non-newline space
1500 $spaces =
"$space++"; # possessive match
of 1
or more spaces
1501 $text = preg_replace_callback(
1503 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1504 (<.*?>) | # m[2]: Skip stuff inside HTML elements' .
"
1505 (\b # m[3]: Free external links
1507 ($addr$urlChar*) # m[4]: Post-protocol path
1509 \b(?:RFC|PMID) $spaces # m[5]: RFC or PMID, capture number
1511 \bISBN $spaces ( # m[6]: ISBN, capture number
1512 (?: 97[89] $spdash? )? # optional 13-digit ISBN prefix
1513 (?: [0-9] $spdash? ){9} # 9 digits with opt. delimiters
1514 [0-9Xx] # check digit
1516 )!xu", [ $this,
'magicLinkCallback' ], $text );
1526 if ( isset( $m[1] ) && $m[1] !==
'' ) {
1529 } elseif ( isset( $m[2] ) && $m[2] !==
'' ) {
1532 } elseif ( isset( $m[3] ) && $m[3] !==
'' ) {
1533 # Free external link
1535 } elseif ( isset( $m[5] ) && $m[5] !==
'' ) {
1537 if ( substr( $m[0], 0, 3 ) ===
'RFC' ) {
1538 if ( !$this->mOptions->getMagicRFCLinks() ) {
1543 $cssClass =
'mw-magiclink-rfc';
1544 $trackingCat =
'magiclink-tracking-rfc';
1546 } elseif ( substr( $m[0], 0, 4 ) ===
'PMID' ) {
1547 if ( !$this->mOptions->getMagicPMIDLinks() ) {
1551 $urlmsg =
'pubmedurl';
1552 $cssClass =
'mw-magiclink-pmid';
1553 $trackingCat =
'magiclink-tracking-pmid';
1556 throw new MWException( __METHOD__ .
': unrecognised match type "' .
1557 substr( $m[0], 0, 20 ) .
'"' );
1559 $url =
wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1562 } elseif ( isset( $m[6] ) && $m[6] !==
''
1563 && $this->mOptions->getMagicISBNLinks()
1567 $space = self::SPACE_NOT_NL; # non-newline space
1568 $isbn = preg_replace(
"/$space/",
' ', $isbn );
1569 $num = strtr( $isbn, [
1576 SpecialPage::getTitleFor(
'Booksources', $num ),
1579 'class' =>
'internal mw-magiclink-isbn',
1600 # The characters '<' and '>' (which were escaped by
1601 # removeHTMLtags()) should not be included in
1602 # URLs, per RFC 2396.
1603 # Make terminate a URL as well (bug T84937)
1606 '/&(lt|gt|nbsp|#x0*(3[CcEe]|[Aa]0)|#0*(60|62|160));/',
1611 $trail = substr( $url, $m2[0][1] ) . $trail;
1612 $url = substr( $url, 0, $m2[0][1] );
1615 # Move trailing punctuation to $trail
1617 # If there is no left bracket, then consider right brackets fair game too
1618 if ( strpos( $url,
'(' ) ===
false ) {
1622 $urlRev = strrev( $url );
1623 $numSepChars = strspn( $urlRev, $sep );
1624 # Don't break a trailing HTML entity by moving the ; into $trail
1625 # This is in hot code, so use substr_compare to avoid having to
1626 # create a new string object for the comparison
1627 if ( $numSepChars && substr_compare( $url,
";", -$numSepChars, 1 ) === 0 ) {
1628 # more optimization: instead of running preg_match with a $
1629 # anchor, which can be slow, do the match on the reversed
1630 # string starting at the desired offset.
1631 # un-reversed regexp is: /&([a-z]+|#x[\da-f]+|#\d+)$/i
1632 if ( preg_match(
'/\G([a-z]+|[\da-f]+x#|\d+#)&/i', $urlRev, $m2, 0, $numSepChars ) ) {
1636 if ( $numSepChars ) {
1637 $trail = substr( $url, -$numSepChars ) . $trail;
1638 $url = substr( $url, 0, -$numSepChars );
1641 # Verify that we still have a real URL after trail removal, and
1642 # not just lone protocol
1643 if ( strlen( $trail ) >= $numPostProto ) {
1644 return $url . $trail;
1647 $url = Sanitizer::cleanUrl( $url );
1649 # Is this an external image?
1651 if ( $text ===
false ) {
1652 # Not an image, make a link
1657 # Register it in the output object...
1658 $this->mOutput->addExternalLink( $url );
1660 return $text . $trail;
1673 for ( $i = 6; $i >= 1; --$i ) {
1674 $h = str_repeat(
'=', $i );
1677 $text = preg_replace(
"/^(?:$h)[ \\t]*(.+?)[ \\t]*(?:$h)\\s*$/m",
"<h$i>\\1</h$i>", $text );
1696 $outtext = substr( $outtext, 0, -1 );
1708 $arr = preg_split(
"/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1709 $countarr = count( $arr );
1710 if ( $countarr == 1 ) {
1719 for ( $i = 1; $i < $countarr; $i += 2 ) {
1720 $thislen = strlen( $arr[$i] );
1724 if ( $thislen == 4 ) {
1725 $arr[$i - 1] .=
"'";
1728 } elseif ( $thislen > 5 ) {
1732 $arr[$i - 1] .= str_repeat(
"'", $thislen - 5 );
1737 if ( $thislen == 2 ) {
1739 } elseif ( $thislen == 3 ) {
1741 } elseif ( $thislen == 5 ) {
1751 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
1752 $firstsingleletterword = -1;
1753 $firstmultiletterword = -1;
1755 for ( $i = 1; $i < $countarr; $i += 2 ) {
1756 if ( strlen( $arr[$i] ) == 3 ) {
1757 $x1 = substr( $arr[$i - 1], -1 );
1758 $x2 = substr( $arr[$i - 1], -2, 1 );
1759 if ( $x1 ===
' ' ) {
1760 if ( $firstspace == -1 ) {
1763 } elseif ( $x2 ===
' ' ) {
1764 $firstsingleletterword = $i;
1769 if ( $firstmultiletterword == -1 ) {
1770 $firstmultiletterword = $i;
1777 if ( $firstsingleletterword > -1 ) {
1778 $arr[$firstsingleletterword] =
"''";
1779 $arr[$firstsingleletterword - 1] .=
"'";
1780 } elseif ( $firstmultiletterword > -1 ) {
1782 $arr[$firstmultiletterword] =
"''";
1783 $arr[$firstmultiletterword - 1] .=
"'";
1784 } elseif ( $firstspace > -1 ) {
1788 $arr[$firstspace] =
"''";
1789 $arr[$firstspace - 1] .=
"'";
1798 foreach ( $arr
as $r ) {
1799 if ( ( $i % 2 ) == 0 ) {
1800 if ( $state ===
'both' ) {
1806 $thislen = strlen( $r );
1807 if ( $thislen == 2 ) {
1808 if ( $state ===
'i' ) {
1811 } elseif ( $state ===
'bi' ) {
1814 } elseif ( $state ===
'ib' ) {
1817 } elseif ( $state ===
'both' ) {
1824 } elseif ( $thislen == 3 ) {
1825 if ( $state ===
'b' ) {
1828 } elseif ( $state ===
'bi' ) {
1831 } elseif ( $state ===
'ib' ) {
1834 } elseif ( $state ===
'both' ) {
1841 } elseif ( $thislen == 5 ) {
1842 if ( $state ===
'b' ) {
1845 } elseif ( $state ===
'i' ) {
1848 } elseif ( $state ===
'bi' ) {
1851 } elseif ( $state ===
'ib' ) {
1854 } elseif ( $state ===
'both' ) {
1866 if ( $state ===
'b' || $state ===
'ib' ) {
1869 if ( $state ===
'i' || $state ===
'bi' || $state ===
'ib' ) {
1872 if ( $state ===
'bi' ) {
1876 if ( $state ===
'both' &&
$buffer ) {
1896 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1897 if ( $bits ===
false ) {
1898 throw new MWException(
"PCRE needs to be compiled with "
1899 .
"--enable-unicode-properties in order for MediaWiki to function" );
1901 $s = array_shift( $bits );
1904 while ( $i < count( $bits ) ) {
1907 $text = $bits[$i++];
1908 $trail = $bits[$i++];
1910 # The characters '<' and '>' (which were escaped by
1911 # removeHTMLtags()) should not be included in
1912 # URLs, per RFC 2396.
1914 if ( preg_match(
'/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1915 $text = substr( $url, $m2[0][1] ) .
' ' . $text;
1916 $url = substr( $url, 0, $m2[0][1] );
1919 # If the link text is an image URL, replace it with an <img> tag
1920 # This happened by accident in the original parser, but some people used it extensively
1922 if ( $img !==
false ) {
1928 # Set linktype for CSS
1931 # No link text, e.g. [http:
1932 if ( $text ==
'' ) {
1935 $text =
'[' . $langObj->formatNum( ++$this->mAutonumber ) .
']';
1936 $linktype =
'autonumber';
1938 # Have link text, e.g. [http:
1948 $url = Sanitizer::cleanUrl( $url );
1950 # Use the encoded URL
1951 # This means that users can paste URLs directly into the text
1952 # Funny characters like ö aren't valid in URLs anyway
1953 # This was changed in August 2004
1957 # Register link in the output object.
1958 $this->mOutput->addExternalLink( $url );
1996 $rel = self::getExternalLinkRel( $url, $this->mTitle );
1998 $target = $this->mOptions->getExternalLinkTarget();
2001 if ( !in_array( $target, [
'_self',
'_parent',
'_top' ] ) ) {
2005 if ( $rel !==
'' ) {
2008 $rel .=
'noreferrer noopener';
2025 # First, make sure unsafe characters are encoded
2026 $url = preg_replace_callback(
'/[\x00-\x20"<>\[\\\\\]^`{|}\x7F-\xFF]/',
2028 return rawurlencode( $m[0] );
2034 $end = strlen( $url );
2036 # Fragment part - 'fragment'
2037 $start = strpos( $url,
'#' );
2038 if ( $start !==
false && $start < $end ) {
2039 $ret = self::normalizeUrlComponent(
2040 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}' ) .
$ret;
2044 # Query part - 'query' minus &=+;
2045 $start = strpos( $url,
'?' );
2046 if ( $start !==
false && $start < $end ) {
2047 $ret = self::normalizeUrlComponent(
2048 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}&=+;' ) .
$ret;
2052 # Scheme and path part - 'pchar'
2053 # (we assume no userinfo or encoded colons in the host)
2054 $ret = self::normalizeUrlComponent(
2055 substr( $url, 0, $end ),
'"#%<>[\]^`{|}/?' ) .
$ret;
2061 $callback =
function (
$matches )
use ( $unsafe ) {
2063 $ord = ord( $char );
2064 if ( $ord > 32 && $ord < 127 && strpos( $unsafe, $char ) ===
false ) {
2068 # Leave it escaped, but use uppercase for a-f
2072 return preg_replace_callback(
'/%[0-9A-Fa-f]{2}/', $callback, $component );
2084 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
2085 $imagesexception = !empty( $imagesfrom );
2087 # $imagesfrom could be either a single string or an array of strings, parse out the latter
2088 if ( $imagesexception && is_array( $imagesfrom ) ) {
2089 $imagematch =
false;
2090 foreach ( $imagesfrom
as $match ) {
2091 if ( strpos( $url, $match ) === 0 ) {
2096 } elseif ( $imagesexception ) {
2097 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
2099 $imagematch =
false;
2102 if ( $this->mOptions->getAllowExternalImages()
2103 || ( $imagesexception && $imagematch )
2105 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
2110 if ( !$text && $this->mOptions->getEnableImageWhitelist()
2111 && preg_match( self::EXT_IMAGE_REGEX, $url )
2113 $whitelist = explode(
2115 wfMessage(
'external_image_whitelist' )->inContentLanguage()->
text()
2118 foreach ( $whitelist
as $entry ) {
2119 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
2120 if ( strpos( $entry,
'#' ) === 0 || $entry ===
'' ) {
2123 if ( preg_match(
'/' . str_replace(
'/',
'\\/', $entry ) .
'/i', $url ) ) {
2124 # Image matches a whitelist entry
2158 static $tc =
false, $e1, $e1_img;
2159 # the % is needed to support urlencoded titles as well
2161 $tc = Title::legalChars() .
'#%';
2162 # Match a link having the form [[namespace:link|alternate]]trail
2163 $e1 =
"/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
2164 # Match cases where there is no "]]", which might still be images
2165 $e1_img =
"/^([{$tc}]+)\\|(.*)\$/sD";
2170 # split the entire text string on occurrences of [[
2172 # get the first element (all text up to first [[), and remove the space we added
2175 $line = $a->current(); # Workaround
for broken ArrayIterator::next()
that returns
"void"
2176 $s = substr(
$s, 1 );
2180 if ( $useLinkPrefixExtension ) {
2181 # Match the end of a line for a word that's not followed by whitespace,
2182 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
2183 $charset = $this->contLang->linkPrefixCharset();
2184 $e2 =
"/^((?>.*[^$charset]|))(.+)$/sDu";
2187 if ( is_null( $this->mTitle ) ) {
2188 throw new MWException( __METHOD__ .
": \$this->mTitle is null\n" );
2190 $nottalk = !$this->mTitle->isTalkPage();
2192 if ( $useLinkPrefixExtension ) {
2194 if ( preg_match( $e2,
$s, $m ) ) {
2195 $first_prefix = $m[2];
2197 $first_prefix =
false;
2205 # Loop for each link
2206 for ( ;
$line !==
false &&
$line !==
null; $a->next(),
$line = $a->current() ) {
2207 # Check for excessive memory usage
2208 if ( $holders->isBig() ) {
2210 # Do the existence check, replace the link holders and clear the array
2211 $holders->replace(
$s );
2215 if ( $useLinkPrefixExtension ) {
2216 if ( preg_match( $e2,
$s, $m ) ) {
2223 if ( $first_prefix ) {
2224 $prefix = $first_prefix;
2225 $first_prefix =
false;
2229 $might_be_img =
false;
2233 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
2234 # [[Image:Foo.jpg|[http:
2235 # the real problem is with the $e1 regex
2237 # Still some problems for cases where the ] is meant to be outside punctuation,
2238 # and no image is in sight. See T4095.
2240 && substr( $m[3], 0, 1 ) ===
']'
2241 && strpos( $text,
'[' ) !==
false
2244 $m[3] = substr( $m[3], 1 );
2246 # fix up urlencoded title texts
2247 if ( strpos( $m[1],
'%' ) !==
false ) {
2248 # Should anchors '#' also be rejected?
2249 $m[1] = str_replace( [
'<',
'>' ], [
'<',
'>' ], rawurldecode( $m[1] ) );
2252 } elseif ( preg_match( $e1_img,
$line, $m ) ) {
2253 # Invalid, but might be an image with a link in its caption
2254 $might_be_img =
true;
2256 if ( strpos( $m[1],
'%' ) !==
false ) {
2257 $m[1] = str_replace( [
'<',
'>' ], [
'<',
'>' ], rawurldecode( $m[1] ) );
2260 }
else { # Invalid
form; output directly
2265 $origLink = ltrim( $m[1],
' ' );
2267 # Don't allow internal links to pages containing
2268 # PROTO: where PROTO is a valid URL protocol; these
2269 # should be external links.
2270 if ( preg_match(
'/^(?i:' . $this->mUrlProtocols .
')/', $origLink ) ) {
2275 # Make subpage if necessary
2276 if ( $useSubpages ) {
2286 $unstrip = $this->mStripState->killMarkers(
$link );
2287 $noMarkers = ( $unstrip ===
$link );
2289 $nt = $noMarkers ? Title::newFromText(
$link ) :
null;
2290 if ( $nt ===
null ) {
2295 $ns = $nt->getNamespace();
2296 $iw = $nt->getInterwiki();
2298 $noforce = ( substr( $origLink, 0, 1 ) !==
':' );
2300 if ( $might_be_img ) { #
if this is actually an invalid
link
2301 if ( $ns ==
NS_FILE && $noforce ) { # but might be an image
2304 # look at the next 'line' to see if we can close it there
2306 $next_line = $a->current();
2307 if ( $next_line ===
false || $next_line ===
null ) {
2310 $m = explode(
']]', $next_line, 3 );
2311 if ( count( $m ) == 3 ) {
2312 # the first ]] closes the inner link, the second the image
2314 $text .=
"[[{$m[0]}]]{$m[1]}";
2317 } elseif ( count( $m ) == 2 ) {
2318 # if there's exactly one ]] that's fine, we'll keep looking
2319 $text .=
"[[{$m[0]}]]{$m[1]}";
2321 # if $next_line is invalid too, we need look no further
2322 $text .=
'[[' . $next_line;
2327 # we couldn't find the end of this imageLink, so output it raw
2328 # but don't ignore what might be perfectly normal links in the text we've examined
2330 $s .=
"{$prefix}[[$link|$text";
2331 # note: no $trail, because without an end, there *is* no trail
2334 }
else { #
it's not an image, so output it raw
2335 $s .= "{$prefix}[[$link|$text";
2336 # note: no $trail, because without an end, there *is* no trail
2341 $wasblank = ( $text == '' );
2345 # Strip off leading ':
'
2346 $text = substr( $text, 1 );
2349 # T6598 madness. Handle the quotes only if they come from the alternate part
2350 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2351 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2352 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2353 $text = $this->doQuotes( $text );
2356 # Link not escaped by : , create the various objects
2357 if ( $noforce && !$nt->wasLocalInterwiki() ) {
2360 $iw && $this->mOptions->getInterwikiMagic() && $nottalk && (
2361 Language::fetchLanguageName( $iw, null, 'mw
' ) ||
2362 in_array( $iw, $wgExtraInterlanguageLinkPrefixes )
2365 # T26502: filter duplicates
2366 if ( !isset( $this->mLangLinkLanguages[$iw] ) ) {
2367 $this->mLangLinkLanguages[$iw] = true;
2368 $this->mOutput->addLanguageLink( $nt->getFullText() );
2374 $s = rtrim( $s . $prefix ) . $trail; # T175416
2378 if ( $ns == NS_FILE ) {
2379 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
2381 # if no parameters were passed, $text
2382 # becomes something like "File:Foo.png",
2383 # which we don't want to pass
on to the
2387 # recursively parse links inside the image caption
2388 # actually, this will parse them in any other parameters, too,
2389 # but it might be hard to fix that, and it doesn't matter ATM
2393 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
2395 $this->
makeImage( $nt, $text, $holders ) ) . $trail;
2402 $s = rtrim(
$s . $prefix ) . $trail; # T2087, T87753
2409 $sortkey = Sanitizer::decodeCharReferences( $sortkey );
2410 $sortkey = str_replace(
"\n",
'', $sortkey );
2412 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
2418 # Self-link checking. For some languages, variants of the title are checked in
2419 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2420 # for linking to a different variant.
2421 if ( $ns !=
NS_SPECIAL && $nt->equals( $this->mTitle ) && !$nt->hasFragment() ) {
2426 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2427 # @todo FIXME: Should do batch file existence checks, see comment below
2429 # Give extensions a chance to select the file revision for us
2433 [ $this, $nt, &
$options, &$descQuery ] );
2434 # Fetch and register the file (file title may be different via hooks)
2436 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
2442 # Some titles, such as valid special pages or files in foreign repos, should
2443 # be shown as bluelinks even though they're not included in the page table
2444 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2445 # batch file existence checks for NS_FILE and NS_MEDIA
2446 if ( $iw ==
'' && $nt->isAlwaysKnown() ) {
2447 $this->mOutput->addLink( $nt );
2450 # Links will be added to the output link list after checking
2451 $s .= $holders->makeHolder( $nt, $text, [], $trail, $prefix );
2473 if ( $text ==
'' ) {
2474 $text = htmlspecialchars( $nt->getPrefixedText() );
2477 $link = $this->getLinkRenderer()->makeKnownLink(
2478 $nt,
new HtmlArmor(
"$prefix$text$inside" )
2481 return $this->armorLinks(
$link ) . $trail;
2495 return preg_replace(
'/\b((?i)' . $this->mUrlProtocols .
')/',
2496 self::MARKER_PREFIX .
"NOPARSE$1", $text );
2504 # Some namespaces don't allow subpages
2505 return MWNamespace::hasSubpages( $this->mTitle->getNamespace() );
2547 if ( is_null( $this->mTitle ) ) {
2552 throw new MWException( __METHOD__ .
' Should only be '
2553 .
' called while parsing (no title set)' );
2563 if ( Hooks::run(
'ParserGetVariableValueVarCache', [ &
$parser, &$this->mVarCache ] ) ) {
2564 if ( isset( $this->mVarCache[$index] ) ) {
2565 return $this->mVarCache[$index];
2569 $ts =
wfTimestamp( TS_UNIX, $this->mOptions->getTimestamp() );
2570 Hooks::run(
'ParserGetVariableValueTs', [ &
$parser, &$ts ] );
2572 $pageLang = $this->getFunctionLang();
2578 case 'currentmonth':
2579 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->
format(
'm' ),
true );
2581 case 'currentmonth1':
2582 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->
format(
'n' ),
true );
2584 case 'currentmonthname':
2585 $value = $pageLang->getMonthName( MWTimestamp::getInstance( $ts )->
format(
'n' ) );
2587 case 'currentmonthnamegen':
2588 $value = $pageLang->getMonthNameGen( MWTimestamp::getInstance( $ts )->
format(
'n' ) );
2590 case 'currentmonthabbrev':
2591 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getInstance( $ts )->
format(
'n' ) );
2594 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->
format(
'j' ),
true );
2597 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->
format(
'd' ),
true );
2600 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->
format(
'm' ),
true );
2603 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->
format(
'n' ),
true );
2605 case 'localmonthname':
2606 $value = $pageLang->getMonthName( MWTimestamp::getLocalInstance( $ts )->
format(
'n' ) );
2608 case 'localmonthnamegen':
2609 $value = $pageLang->getMonthNameGen( MWTimestamp::getLocalInstance( $ts )->
format(
'n' ) );
2611 case 'localmonthabbrev':
2612 $value = $pageLang->getMonthAbbreviation( MWTimestamp::getLocalInstance( $ts )->
format(
'n' ) );
2615 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->
format(
'j' ),
true );
2618 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->
format(
'd' ),
true );
2626 case 'fullpagename':
2629 case 'fullpagenamee':
2635 case 'subpagenamee':
2638 case 'rootpagename':
2641 case 'rootpagenamee':
2645 $this->mTitle->getRootText()
2648 case 'basepagename':
2651 case 'basepagenamee':
2655 $this->mTitle->getBaseText()
2658 case 'talkpagename':
2659 if ( $this->mTitle->canHaveTalkPage() ) {
2660 $talkPage = $this->mTitle->getTalkPage();
2666 case 'talkpagenamee':
2667 if ( $this->mTitle->canHaveTalkPage() ) {
2668 $talkPage = $this->mTitle->getTalkPage();
2674 case 'subjectpagename':
2675 $subjPage = $this->mTitle->getSubjectPage();
2678 case 'subjectpagenamee':
2679 $subjPage = $this->mTitle->getSubjectPage();
2683 $pageid = $this->getTitle()->getArticleID();
2684 if ( $pageid == 0 ) {
2685 # 0 means the page doesn't exist in the database,
2686 # which means the user is previewing a new page.
2687 # The vary-revision flag must be set, because the magic word
2688 # will have a different value once the page is saved.
2689 $this->mOutput->setFlag(
'vary-revision' );
2690 wfDebug( __METHOD__ .
": {{PAGEID}} used in a new page, setting vary-revision...\n" );
2692 $value = $pageid ?:
null;
2695 # Let the edit saving system know we should parse the page
2696 # *after* a revision ID has been assigned.
2697 $this->mOutput->setFlag(
'vary-revision-id' );
2698 wfDebug( __METHOD__ .
": {{REVISIONID}} used, setting vary-revision-id...\n" );
2699 $value = $this->mRevisionId;
2702 $rev = $this->getRevisionObject();
2709 $value = $this->mOptions->getSpeculativeRevId();
2711 $this->mOutput->setSpeculativeRevIdUsed(
$value );
2716 $value = (int)$this->getRevisionTimestampSubstring( 6, 2, self::MAX_TTS, $index );
2718 case 'revisionday2':
2719 $value = $this->getRevisionTimestampSubstring( 6, 2, self::MAX_TTS, $index );
2721 case 'revisionmonth':
2722 $value = $this->getRevisionTimestampSubstring( 4, 2, self::MAX_TTS, $index );
2724 case 'revisionmonth1':
2725 $value = (int)$this->getRevisionTimestampSubstring( 4, 2, self::MAX_TTS, $index );
2727 case 'revisionyear':
2728 $value = $this->getRevisionTimestampSubstring( 0, 4, self::MAX_TTS, $index );
2730 case 'revisiontimestamp':
2731 # Let the edit saving system know we should parse the page
2732 # *after* a revision ID has been assigned. This is for null edits.
2733 $this->mOutput->setFlag(
'vary-revision' );
2734 wfDebug( __METHOD__ .
": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2735 $value = $this->getRevisionTimestamp();
2737 case 'revisionuser':
2738 # Let the edit saving system know we should parse the page
2739 # *after* a revision ID has been assigned for null edits.
2740 $this->mOutput->setFlag(
'vary-user' );
2741 wfDebug( __METHOD__ .
": {{REVISIONUSER}} used, setting vary-user...\n" );
2742 $value = $this->getRevisionUser();
2744 case 'revisionsize':
2745 $value = $this->getRevisionSize();
2748 $value = str_replace(
'_',
' ',
2749 $this->contLang->getNsText( $this->mTitle->getNamespace() ) );
2752 $value =
wfUrlencode( $this->contLang->getNsText( $this->mTitle->getNamespace() ) );
2754 case 'namespacenumber':
2755 $value = $this->mTitle->getNamespace();
2758 $value = $this->mTitle->canHaveTalkPage()
2759 ? str_replace(
'_',
' ', $this->mTitle->getTalkNsText() )
2763 $value = $this->mTitle->canHaveTalkPage() ?
wfUrlencode( $this->mTitle->getTalkNsText() ) :
'';
2765 case 'subjectspace':
2766 $value = str_replace(
'_',
' ', $this->mTitle->getSubjectNsText() );
2768 case 'subjectspacee':
2771 case 'currentdayname':
2772 $value = $pageLang->getWeekdayName( (
int)MWTimestamp::getInstance( $ts )->format(
'w' ) + 1 );
2775 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format(
'Y' ),
true );
2781 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format(
'H' ),
true );
2784 # @bug T6594 PHP5 has it zero padded, PHP4 does not, cast to
2785 # int to remove the padding
2786 $value = $pageLang->formatNum( (
int)MWTimestamp::getInstance( $ts )->format(
'W' ) );
2789 $value = $pageLang->formatNum( MWTimestamp::getInstance( $ts )->format(
'w' ) );
2791 case 'localdayname':
2792 $value = $pageLang->getWeekdayName(
2793 (
int)MWTimestamp::getLocalInstance( $ts )->format(
'w' ) + 1
2797 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format(
'Y' ),
true );
2800 $value = $pageLang->time(
2801 MWTimestamp::getLocalInstance( $ts )->format(
'YmdHis' ),
2807 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format(
'H' ),
true );
2810 # @bug T6594 PHP5 has it zero padded, PHP4 does not, cast to
2811 # int to remove the padding
2812 $value = $pageLang->formatNum( (
int)MWTimestamp::getLocalInstance( $ts )->format(
'W' ) );
2815 $value = $pageLang->formatNum( MWTimestamp::getLocalInstance( $ts )->format(
'w' ) );
2817 case 'numberofarticles':
2820 case 'numberoffiles':
2823 case 'numberofusers':
2826 case 'numberofactiveusers':
2829 case 'numberofpages':
2832 case 'numberofadmins':
2835 case 'numberofedits':
2838 case 'currenttimestamp':
2841 case 'localtimestamp':
2842 $value = MWTimestamp::getLocalInstance( $ts )->format(
'YmdHis' );
2844 case 'currentversion':
2859 case 'directionmark':
2860 return $pageLang->getDirMark();
2861 case 'contentlanguage':
2864 case 'pagelanguage':
2865 $value = $pageLang->getCode();
2867 case 'cascadingsources':
2873 'ParserGetVariableValueSwitch',
2874 [ &
$parser, &$this->mVarCache, &$index, &
$ret, &$frame ]
2881 $this->mVarCache[$index] =
$value;
2895 # Get the timezone-adjusted timestamp to be used for this revision
2896 $resNow = substr( $this->getRevisionTimestamp(), $start, $len );
2897 # Possibly set vary-revision if there is not yet an associated revision
2898 if ( !$this->getRevisionObject() ) {
2899 # Get the timezone-adjusted timestamp $mtts seconds in the future
2901 $this->contLang->userAdjust(
wfTimestamp( TS_MW, time() + $mtts ),
'' ),
2906 if ( $resNow !== $resThen ) {
2907 # Let the edit saving system know we should parse the page
2908 # *after* a revision ID has been assigned. This is for null edits.
2909 $this->mOutput->setFlag(
'vary-revision' );
2910 wfDebug( __METHOD__ .
": $variable used, setting vary-revision...\n" );
2923 $variableIDs = $this->magicWordFactory->getVariableIDs();
2924 $substIDs = $this->magicWordFactory->getSubstIDs();
2926 $this->mVariables = $this->magicWordFactory->newArray( $variableIDs );
2927 $this->mSubstWords = $this->magicWordFactory->newArray( $substIDs );
2953 $dom = $this->getPreprocessor()->preprocessToObj( $text, $flags );
2965 $ltrimmed = ltrim(
$s );
2966 $w1 = substr(
$s, 0, strlen(
$s ) - strlen( $ltrimmed ) );
2967 $trimmed = rtrim( $ltrimmed );
2968 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
2970 $w2 = substr( $ltrimmed, -$diff );
2974 return [ $w1, $trimmed, $w2 ];
2998 # Is there any text? Also, Prevent too big inclusions!
2999 $textSize = strlen( $text );
3000 if ( $textSize < 1 || $textSize > $this->mOptions->getMaxIncludeSize() ) {
3004 if ( $frame ===
false ) {
3005 $frame = $this->getPreprocessor()->newFrame();
3006 } elseif ( !( $frame instanceof
PPFrame ) ) {
3007 wfDebug( __METHOD__ .
" called using plain parameters instead of "
3008 .
"a PPFrame instance. Creating custom frame.\n" );
3009 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
3012 $dom = $this->preprocessToDom( $text );
3014 $text = $frame->expand( $dom, $flags );
3030 $eqpos = strpos( $arg,
'=' );
3031 if ( $eqpos ===
false ) {
3032 $assocArgs[$index++] = $arg;
3034 $name = trim( substr( $arg, 0, $eqpos ) );
3035 $value = trim( substr( $arg, $eqpos + 1 ) );
3036 if (
$value ===
false ) {
3039 if (
$name !==
false ) {
3075 # does no harm if $current and $max are present but are unnecessary for the message
3076 # Not doing ->inLanguage( $this->mOptions->getUserLangObj() ), since this is shown
3077 # only during preview, and that would split the parser cache unnecessarily.
3078 $warning =
wfMessage(
"$limitationType-warning" )->numParams( $current, $max )
3080 $this->mOutput->addWarning( $warning );
3081 $this->addTrackingCategory(
"$limitationType-category" );
3106 $forceRawInterwiki =
false;
3108 $isChildObj =
false;
3110 $isLocalObj =
false;
3112 # Title object, where $text came from
3115 # $part1 is the bit before the first |, and must contain only title characters.
3116 # Various prefixes will be stripped from it later.
3117 $titleWithSpaces = $frame->expand( $piece[
'title'] );
3118 $part1 = trim( $titleWithSpaces );
3121 # Original title text preserved for various purposes
3122 $originalTitle = $part1;
3124 # $args is a list of argument nodes, starting from index 0, not including $part1
3125 # @todo FIXME: If piece['parts'] is null then the call to getLength()
3126 # below won't work b/c this $args isn't an object
3127 $args = (
null == $piece[
'parts'] ) ? [] : $piece[
'parts'];
3129 $profileSection =
null;
3133 $substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
3135 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3136 # Decide whether to expand template or keep wikitext as-is.
3137 if ( $this->ot[
'wiki'] ) {
3138 if ( $substMatch ===
false ) {
3139 $literal =
true; # literal when
in PST with no prefix
3141 $literal =
false; # expand when
in PST with subst:
or safesubst:
3144 if ( $substMatch ==
'subst' ) {
3145 $literal =
true; # literal when not
in PST with
plain subst:
3147 $literal =
false; # expand when not
in PST with safesubst:
or no prefix
3151 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3158 if ( !$found &&
$args->getLength() == 0 ) {
3159 $id = $this->mVariables->matchStartToEnd( $part1 );
3160 if ( $id !==
false ) {
3161 $text = $this->getVariableValue( $id, $frame );
3162 if ( $this->magicWordFactory->getCacheTTL( $id ) > -1 ) {
3163 $this->mOutput->updateCacheExpiry(
3164 $this->magicWordFactory->getCacheTTL( $id ) );
3170 # MSG, MSGNW and RAW
3173 $mwMsgnw = $this->magicWordFactory->get(
'msgnw' );
3174 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3177 # Remove obsolete MSG:
3178 $mwMsg = $this->magicWordFactory->get(
'msg' );
3179 $mwMsg->matchStartAndRemove( $part1 );
3183 $mwRaw = $this->magicWordFactory->get(
'raw' );
3184 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3185 $forceRawInterwiki =
true;
3191 $colonPos = strpos( $part1,
':' );
3192 if ( $colonPos !==
false ) {
3193 $func = substr( $part1, 0, $colonPos );
3194 $funcArgs = [ trim( substr( $part1, $colonPos + 1 ) ) ];
3195 $argsLength =
$args->getLength();
3196 for ( $i = 0; $i < $argsLength; $i++ ) {
3197 $funcArgs[] =
$args->item( $i );
3200 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3203 if ( isset(
$result[
'title'] ) ) {
3206 if ( isset(
$result[
'found'] ) ) {
3209 if ( array_key_exists(
'text',
$result ) ) {
3213 if ( isset(
$result[
'nowiki'] ) ) {
3216 if ( isset(
$result[
'isHTML'] ) ) {
3219 if ( isset(
$result[
'forceRawInterwiki'] ) ) {
3220 $forceRawInterwiki =
$result[
'forceRawInterwiki'];
3222 if ( isset(
$result[
'isChildObj'] ) ) {
3223 $isChildObj =
$result[
'isChildObj'];
3225 if ( isset(
$result[
'isLocalObj'] ) ) {
3226 $isLocalObj =
$result[
'isLocalObj'];
3231 # Finish mangling title and then check for loops.
3232 # Set $title to a Title object and $titleText to the PDBK
3235 # Split the title into page and subpage
3237 $relative = $this->maybeDoSubpageLink( $part1, $subpage );
3238 if ( $part1 !== $relative ) {
3240 $ns = $this->mTitle->getNamespace();
3242 $title = Title::newFromText( $part1, $ns );
3244 $titleText =
$title->getPrefixedText();
3245 # Check for language variants if the template is not found
3246 if ( $this->getTargetLanguage()->hasVariants() &&
$title->getArticleID() == 0 ) {
3247 $this->getTargetLanguage()->findVariantLink( $part1,
$title,
true );
3249 # Do recursion depth check
3250 $limit = $this->mOptions->getMaxTemplateDepth();
3251 if ( $frame->depth >= $limit ) {
3253 $text =
'<span class="error">'
3254 .
wfMessage(
'parser-template-recursion-depth-warning' )
3255 ->numParams( $limit )->inContentLanguage()->text()
3261 # Load from database
3262 if ( !$found &&
$title ) {
3263 $profileSection = $this->mProfiler->scopedProfileIn(
$title->getPrefixedDBkey() );
3264 if ( !
$title->isExternal() ) {
3265 if (
$title->isSpecialPage()
3266 && $this->mOptions->getAllowSpecialInclusion()
3267 && $this->ot[
'html']
3269 $specialPage = $this->specialPageFactory->getPage(
$title->getDBkey() );
3274 $argsLength =
$args->getLength();
3275 for ( $i = 0; $i < $argsLength; $i++ ) {
3276 $bits =
$args->item( $i )->splitArg();
3277 if ( strval( $bits[
'index'] ) ===
'' ) {
3279 $value = trim( $frame->expand( $bits[
'value'] ) );
3288 if ( $specialPage && $specialPage->maxIncludeCacheTime() === 0 ) {
3289 $context->setUser( $this->getUser() );
3294 $context->setLanguage( $this->mOptions->getUserLangObj() );
3295 $ret = $this->specialPageFactory->capturePath(
$title,
$context, $this->getLinkRenderer() );
3297 $text =
$context->getOutput()->getHTML();
3298 $this->mOutput->addOutputPageMetadata(
$context->getOutput() );
3301 if ( $specialPage && $specialPage->maxIncludeCacheTime() !==
false ) {
3302 $this->mOutput->updateRuntimeAdaptiveExpiry(
3303 $specialPage->maxIncludeCacheTime()
3307 } elseif ( MWNamespace::isNonincludable(
$title->getNamespace() ) ) {
3308 $found =
false; # access denied
3309 wfDebug( __METHOD__ .
": template inclusion denied for " .
3310 $title->getPrefixedDBkey() .
"\n" );
3313 if ( $text !==
false ) {
3319 # If the title is valid but undisplayable, make a link to it
3320 if ( !$found && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3321 $text =
"[[:$titleText]]";
3324 } elseif (
$title->isTrans() ) {
3325 # Interwiki transclusion
3326 if ( $this->ot[
'html'] && !$forceRawInterwiki ) {
3327 $text = $this->interwikiTransclude(
$title,
'render' );
3330 $text = $this->interwikiTransclude(
$title,
'raw' );
3331 # Preprocess it like a template
3332 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3338 # Do infinite loop check
3339 # This has to be done after redirect resolution to avoid infinite loops via redirects
3340 if ( !$frame->loopCheck(
$title ) ) {
3342 $text =
'<span class="error">'
3343 .
wfMessage(
'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3345 $this->addTrackingCategory(
'template-loop-category' );
3346 $this->mOutput->addWarning(
wfMessage(
'template-loop-warning',
3348 wfDebug( __METHOD__ .
": template loop broken at '$titleText'\n" );
3352 # If we haven't found text to substitute by now, we're done
3353 # Recover the source wikitext and return it
3355 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3356 if ( $profileSection ) {
3357 $this->mProfiler->scopedProfileOut( $profileSection );
3359 return [
'object' => $text ];
3362 # Expand DOM-style return values in a child frame
3363 if ( $isChildObj ) {
3364 # Clean up argument array
3369 } elseif ( $titleText !==
false && $newFrame->isEmpty() ) {
3370 # Expansion is eligible for the empty-frame cache
3371 $text = $newFrame->cachedExpand( $titleText, $text );
3373 # Uncached expansion
3374 $text = $newFrame->expand( $text );
3377 if ( $isLocalObj && $nowiki ) {
3379 $isLocalObj =
false;
3382 if ( $profileSection ) {
3383 $this->mProfiler->scopedProfileOut( $profileSection );
3386 # Replace raw HTML by a placeholder
3388 $text = $this->insertStripItem( $text );
3389 } elseif ( $nowiki && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3390 # Escape nowiki-style return values
3392 } elseif ( is_string( $text )
3393 && !$piece[
'lineStart']
3394 && preg_match(
'/^(?:{\\||:|;|#|\*)/', $text )
3396 # T2529: if the template begins with a table or block-level
3397 # element, it should be treated as beginning a new line.
3398 # This behavior is somewhat controversial.
3399 $text =
"\n" . $text;
3402 if ( is_string( $text ) && !$this->incrementIncludeSize(
'post-expand', strlen( $text ) ) ) {
3403 # Error, oversize inclusion
3404 if ( $titleText !==
false ) {
3405 # Make a working, properly escaped link if possible (T25588)
3406 $text =
"[[:$titleText]]";
3408 # This will probably not be a working link, but at least it may
3409 # provide some hint of where the problem is
3410 preg_replace(
'/^:/',
'', $originalTitle );
3411 $text =
"[[:$originalTitle]]";
3413 $text .= $this->insertStripItem(
'<!-- WARNING: template omitted, '
3414 .
'post-expand include size too large -->' );
3415 $this->limitationWarn(
'post-expand-template-inclusion' );
3418 if ( $isLocalObj ) {
3419 $ret = [
'object' => $text ];
3421 $ret = [
'text' => $text ];
3447 # Case sensitive functions
3448 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
3449 $function = $this->mFunctionSynonyms[1][$function];
3451 # Case insensitive functions
3452 $function = $this->contLang->lc( $function );
3453 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
3454 $function = $this->mFunctionSynonyms[0][$function];
3456 return [
'found' =>
false ];
3460 list( $callback, $flags ) = $this->mFunctionHooks[$function];
3466 if ( $flags & self::SFH_OBJECT_ARGS ) {
3467 # Convert arguments to PPNodes and collect for appending to $allArgs
3469 foreach (
$args as $k => $v ) {
3470 if ( $v instanceof
PPNode || $k === 0 ) {
3473 $funcArgs[] = $this->mPreprocessor->newPartNodeArray( [ $k => $v ] )->item( 0 );
3477 # Add a frame parameter, and pass the arguments as an array
3478 $allArgs[] = $frame;
3479 $allArgs[] = $funcArgs;
3481 # Convert arguments to plain text and append to $allArgs
3482 foreach (
$args as $k => $v ) {
3483 if ( $v instanceof
PPNode ) {
3484 $allArgs[] = trim( $frame->expand( $v ) );
3485 } elseif ( is_int( $k ) && $k >= 0 ) {
3486 $allArgs[] = trim( $v );
3488 $allArgs[] = trim(
"$k=$v" );
3493 $result = $callback( ...$allArgs );
3495 # The interface for function hooks allows them to return a wikitext
3496 # string or an array containing the string and any flags. This mungs
3497 # things around to match what this method should return.
3514 $preprocessFlags = 0;
3515 if ( isset(
$result[
'noparse'] ) ) {
3516 $noparse =
$result[
'noparse'];
3518 if ( isset(
$result[
'preprocessFlags'] ) ) {
3519 $preprocessFlags =
$result[
'preprocessFlags'];
3523 $result[
'text'] = $this->preprocessToDom(
$result[
'text'], $preprocessFlags );
3540 $titleText =
$title->getPrefixedDBkey();
3542 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3543 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3544 $title = Title::makeTitle( $ns, $dbk );
3545 $titleText =
$title->getPrefixedDBkey();
3547 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3548 return [ $this->mTplDomCache[$titleText],
$title ];
3551 # Cache miss, go to the database
3554 if ( $text ===
false ) {
3555 $this->mTplDomCache[$titleText] =
false;
3556 return [
false,
$title ];
3559 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3560 $this->mTplDomCache[$titleText] = $dom;
3562 if ( !
$title->equals( $cacheTitle ) ) {
3563 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3582 $cacheKey =
$title->getPrefixedDBkey();
3583 if ( !$this->currentRevisionCache ) {
3584 $this->currentRevisionCache =
new MapCacheLRU( 100 );
3586 if ( !$this->currentRevisionCache->has( $cacheKey ) ) {
3587 $this->currentRevisionCache->set( $cacheKey,
3589 call_user_func( $this->mOptions->getCurrentRevisionCallback(),
$title, $this )
3592 return $this->currentRevisionCache->get( $cacheKey );
3617 $templateCb = $this->mOptions->getTemplateCallback();
3618 $stuff = call_user_func( $templateCb,
$title, $this );
3620 $text = $stuff[
'text'];
3621 if ( is_string( $stuff[
'text'] ) ) {
3622 $text = strtr( $text,
"\x7f",
"?" );
3624 $finalTitle = $stuff[
'finalTitle'] ??
$title;
3625 if ( isset( $stuff[
'deps'] ) ) {
3626 foreach ( $stuff[
'deps']
as $dep ) {
3627 $this->mOutput->addTemplate( $dep[
'title'], $dep[
'page_id'], $dep[
'rev_id'] );
3628 if ( $dep[
'title']->equals( $this->getTitle() ) ) {
3631 $this->mOutput->setFlag(
'vary-revision' );
3635 return [ $text, $finalTitle ];
3644 return $this->fetchTemplateAndTitle(
$title )[0];
3657 $text = $skip =
false;
3661 # Loop to fetch the article, with up to 1 redirect
3663 for ( $i = 0; $i < 2 && is_object(
$title ); $i++ ) {
3664 # Give extensions a chance to select the revision instead
3665 $id =
false; # Assume current
3666 Hooks::run(
'BeforeParserFetchTemplateAndtitle',
3673 'page_id' =>
$title->getArticleID(),
3686 $rev_id =
$rev ?
$rev->getId() : 0;
3687 # If there is no current revision, there is no page
3688 if ( $id ===
false && !
$rev ) {
3689 $linkCache = MediaWikiServices::getInstance()->getLinkCache();
3690 $linkCache->addBadLinkObj(
$title );
3695 'page_id' =>
$title->getArticleID(),
3696 'rev_id' => $rev_id ];
3698 # We fetched a rev from a different title; register it too...
3700 'title' =>
$rev->getTitle(),
3701 'page_id' =>
$rev->getPage(),
3702 'rev_id' => $rev_id ];
3709 Hooks::run(
'ParserFetchTemplate',
3712 if ( $text ===
false || $text ===
null ) {
3717 $message =
wfMessage( MediaWikiServices::getInstance()->getContentLanguage()->
3718 lcfirst(
$title->getText() ) )->inContentLanguage();
3719 if ( !$message->exists() ) {
3724 $text = $message->plain();
3737 'finalTitle' => $finalTitle,
3764 $time = $file ? $file->getTimestamp() :
false;
3765 $sha1 = $file ? $file->getSha1() :
false;
3766 # Register the file as a dependency...
3767 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3768 if ( $file && !
$title->equals( $file->getTitle() ) ) {
3769 # Update fetched file title
3770 $title = $file->getTitle();
3771 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3773 return [ $file,
$title ];
3787 if ( isset(
$options[
'broken'] ) ) {
3789 } elseif ( isset(
$options[
'sha1'] ) ) {
3809 return wfMessage(
'scarytranscludedisabled' )->inContentLanguage()->text();
3812 $url =
$title->getFullURL( [
'action' => $action ] );
3813 if ( strlen( $url ) > 1024 ) {
3814 return wfMessage(
'scarytranscludetoolong' )->inContentLanguage()->text();
3817 $wikiId =
$title->getTransWikiID();
3820 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
3822 $data =
$cache->getWithSetCallback(
3824 'interwiki-transclude',
3825 ( $wikiId !==
false ) ? $wikiId :
'external',
3830 $req = MWHttpRequest::factory( $url, [],
$fname );
3834 $ttl = $cache::TTL_UNCACHEABLE;
3835 } elseif (
$req->getResponseHeader(
'X-Database-Lagged' ) !==
null ) {
3836 $ttl = min( $cache::TTL_LAGGED, $ttl );
3840 'text' =>
$status->isOK() ?
$req->getContent() :
null,
3841 'code' =>
$req->getStatus()
3845 'checkKeys' => ( $wikiId !==
false )
3846 ? [
$cache->makeGlobalKey(
'interwiki-page', $wikiId,
$title->getDBkey() ) ]
3848 'pcGroup' =>
'interwiki-transclude:5',
3849 'pcTTL' => $cache::TTL_PROC_LONG
3853 if ( is_string( $data[
'text'] ) ) {
3854 $text = $data[
'text'];
3855 } elseif ( $data[
'code'] != 200 ) {
3857 $text =
wfMessage(
'scarytranscludefailed-httpstatus' )
3858 ->params( $url, $data[
'code'] )->inContentLanguage()->text();
3860 $text =
wfMessage(
'scarytranscludefailed', $url )->inContentLanguage()->text();
3877 $parts = $piece[
'parts'];
3878 $nameWithSpaces = $frame->expand( $piece[
'title'] );
3879 $argName = trim( $nameWithSpaces );
3881 $text = $frame->getArgument( $argName );
3882 if ( $text ===
false && $parts->getLength() > 0
3883 && ( $this->ot[
'html']
3885 || ( $this->ot[
'wiki'] && $frame->isTemplate() )
3888 # No match in frame, use the supplied default
3889 $object = $parts->item( 0 )->getChildren();
3891 if ( !$this->incrementIncludeSize(
'arg', strlen( $text ) ) ) {
3892 $error =
'<!-- WARNING: argument omitted, expansion size too large -->';
3893 $this->limitationWarn(
'post-expand-template-argument' );
3896 if ( $text ===
false && $object ===
false ) {
3898 $object = $frame->virtualBracketedImplode(
'{{{',
'|',
'}}}', $nameWithSpaces, $parts );
3900 if ( $error !==
false ) {
3903 if ( $object !==
false ) {
3904 $ret = [
'object' => $object ];
3906 $ret = [
'text' => $text ];
3928 static $errorStr =
'<span class="error">';
3929 static $errorLen = 20;
3932 if ( substr(
$name, 0, $errorLen ) === $errorStr ) {
3938 $attrText = !isset(
$params[
'attr'] ) ? null : $frame->expand(
$params[
'attr'] );
3939 if ( substr( $attrText, 0, $errorLen ) === $errorStr ) {
3949 $marker = self::MARKER_PREFIX .
"-$name-"
3950 . sprintf(
'%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
3952 $isFunctionTag = isset( $this->mFunctionTagHooks[strtolower(
$name )] ) &&
3953 ( $this->ot[
'html'] || $this->ot[
'pre'] );
3954 if ( $isFunctionTag ) {
3955 $markerType =
'none';
3957 $markerType =
'general';
3959 if ( $this->ot[
'html'] || $isFunctionTag ) {
3961 $attributes = Sanitizer::decodeTagAttributes( $attrText );
3962 if ( isset(
$params[
'attributes'] ) ) {
3963 $attributes = $attributes +
$params[
'attributes'];
3966 if ( isset( $this->mTagHooks[
$name] ) ) {
3967 $output = call_user_func_array( $this->mTagHooks[
$name],
3968 [
$content, $attributes, $this, $frame ] );
3969 } elseif ( isset( $this->mFunctionTagHooks[
$name] ) ) {
3970 list( $callback, ) = $this->mFunctionTagHooks[
$name];
3976 $output =
'<span class="error">Invalid tag extension name: ' .
3977 htmlspecialchars(
$name ) .
'</span>';
3984 if ( isset( $flags[
'markerType'] ) ) {
3985 $markerType = $flags[
'markerType'];
3989 if ( is_null( $attrText ) ) {
3992 if ( isset(
$params[
'attributes'] ) ) {
3993 foreach (
$params[
'attributes']
as $attrName => $attrValue ) {
3994 $attrText .=
' ' . htmlspecialchars( $attrName ) .
'="' .
3995 htmlspecialchars( $attrValue ) .
'"';
3999 $output =
"<$name$attrText/>";
4001 $close = is_null(
$params[
'close'] ) ?
'' : $frame->expand(
$params[
'close'] );
4002 if ( substr( $close, 0, $errorLen ) === $errorStr ) {
4006 $output =
"<$name$attrText>$content$close";
4010 if ( $markerType ===
'none' ) {
4012 } elseif ( $markerType ===
'nowiki' ) {
4013 $this->mStripState->addNoWiki( $marker,
$output );
4014 } elseif ( $markerType ===
'general' ) {
4015 $this->mStripState->addGeneral( $marker,
$output );
4017 throw new MWException( __METHOD__ .
': invalid marker type' );
4030 if ( $this->mIncludeSizes[
$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
4033 $this->mIncludeSizes[
$type] += $size;
4044 $this->mExpensiveFunctionCount++;
4045 return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
4057 # The position of __TOC__ needs to be recorded
4058 $mw = $this->magicWordFactory->get(
'toc' );
4059 if ( $mw->match( $text ) ) {
4060 $this->mShowToc =
true;
4061 $this->mForceTocPosition =
true;
4063 # Set a placeholder. At the end we'll fill it in with the TOC.
4064 $text = $mw->replace(
'<!--MWTOC\'"-->', $text, 1 );
4066 # Only keep the first one.
4067 $text = $mw->replace(
'', $text );
4070 # Now match and remove the rest of them
4071 $mwa = $this->magicWordFactory->getDoubleUnderscoreArray();
4072 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
4074 if ( isset( $this->mDoubleUnderscores[
'nogallery'] ) ) {
4075 $this->mOutput->mNoGallery =
true;
4077 if ( isset( $this->mDoubleUnderscores[
'notoc'] ) && !$this->mForceTocPosition ) {
4078 $this->mShowToc =
false;
4080 if ( isset( $this->mDoubleUnderscores[
'hiddencat'] )
4083 $this->addTrackingCategory(
'hidden-category-category' );
4085 # (T10068) Allow control over whether robots index a page.
4086 # __INDEX__ always overrides __NOINDEX__, see T16899
4087 if ( isset( $this->mDoubleUnderscores[
'noindex'] ) && $this->mTitle->canUseNoindex() ) {
4088 $this->mOutput->setIndexPolicy(
'noindex' );
4089 $this->addTrackingCategory(
'noindex-category' );
4091 if ( isset( $this->mDoubleUnderscores[
'index'] ) && $this->mTitle->canUseNoindex() ) {
4092 $this->mOutput->setIndexPolicy(
'index' );
4093 $this->addTrackingCategory(
'index-category' );
4096 # Cache all double underscores in the database
4097 foreach ( $this->mDoubleUnderscores
as $key => $val ) {
4098 $this->mOutput->setProperty( $key,
'' );
4110 return $this->mOutput->addTrackingCategory( $msg, $this->mTitle );
4132 # Inhibit editsection links if requested in the page
4133 if ( isset( $this->mDoubleUnderscores[
'noeditsection'] ) ) {
4134 $maybeShowEditLink =
false;
4136 $maybeShowEditLink =
true;
4139 # Get all headlines for numbering them and adding funky stuff like [edit]
4140 # links - this is for later, but we need the number of headlines right now
4141 # NOTE: white space in headings have been trimmed in doHeadings. They shouldn't
4142 # be trimmed here since whitespace in HTML headings is significant.
4144 $numMatches = preg_match_all(
4145 '/<H(?P<level>[1-6])(?P<attrib>.*?>)(?P<header>[\s\S]*?)<\/H[1-6] *>/i',
4150 # if there are fewer than 4 headlines in the article, do not show TOC
4151 # unless it's been explicitly enabled.
4152 $enoughToc = $this->mShowToc &&
4153 ( ( $numMatches >= 4 ) || $this->mForceTocPosition );
4155 # Allow user to stipulate that a page should have a "new section"
4156 # link added via __NEWSECTIONLINK__
4157 if ( isset( $this->mDoubleUnderscores[
'newsectionlink'] ) ) {
4158 $this->mOutput->setNewSection(
true );
4161 # Allow user to remove the "new section"
4162 # link via __NONEWSECTIONLINK__
4163 if ( isset( $this->mDoubleUnderscores[
'nonewsectionlink'] ) ) {
4164 $this->mOutput->hideNewSection(
true );
4167 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
4168 # override above conditions and always show TOC above first header
4169 if ( isset( $this->mDoubleUnderscores[
'forcetoc'] ) ) {
4170 $this->mShowToc =
true;
4178 # Ugh .. the TOC should have neat indentation levels which can be
4179 # passed to the skin functions. These are determined here
4183 $sublevelCount = [];
4189 $markerRegex = self::MARKER_PREFIX .
"-h-(\d+)-" . self::MARKER_SUFFIX;
4190 $baseTitleText = $this->mTitle->getPrefixedDBkey();
4191 $oldType = $this->mOutputType;
4192 $this->setOutputType( self::OT_WIKI );
4193 $frame = $this->getPreprocessor()->newFrame();
4194 $root = $this->preprocessToDom( $origText );
4195 $node = $root->getFirstChild();
4200 $headlines = $numMatches !==
false ?
$matches[3] : [];
4202 foreach ( $headlines
as $headline ) {
4203 $isTemplate =
false;
4205 $sectionIndex =
false;
4207 $markerMatches = [];
4208 if ( preg_match(
"/^$markerRegex/", $headline, $markerMatches ) ) {
4209 $serial = $markerMatches[1];
4210 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
4211 $isTemplate = ( $titleText != $baseTitleText );
4212 $headline = preg_replace(
"/^$markerRegex\\s*/",
"", $headline );
4216 $prevlevel = $level;
4218 $level =
$matches[1][$headlineCount];
4220 if ( $level > $prevlevel ) {
4221 # Increase TOC level
4223 $sublevelCount[$toclevel] = 0;
4225 $prevtoclevel = $toclevel;
4229 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4230 # Decrease TOC level, find level to jump to
4232 for ( $i = $toclevel; $i > 0; $i-- ) {
4233 if ( $levelCount[$i] == $level ) {
4234 # Found last matching level
4237 } elseif ( $levelCount[$i] < $level ) {
4238 # Found first matching level below current level
4248 # Unindent only if the previous toc level was shown :p
4250 $prevtoclevel = $toclevel;
4256 # No change in level, end TOC line
4262 $levelCount[$toclevel] = $level;
4264 # count number of headlines for each level
4265 $sublevelCount[$toclevel]++;
4267 for ( $i = 1; $i <= $toclevel; $i++ ) {
4268 if ( !empty( $sublevelCount[$i] ) ) {
4272 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4277 # The safe header is a version of the header text safe to use for links
4279 # Remove link placeholders by the link text.
4280 # <!--LINK number-->
4282 # link text with suffix
4283 # Do this before unstrip since link text can contain strip markers
4284 $safeHeadline = $this->replaceLinkHoldersText( $headline );
4286 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4287 $safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
4289 # Remove any <style> or <script> tags (T198618)
4290 $safeHeadline = preg_replace(
4291 '#<(style|script)(?: [^>]*[^>/])?>.*?</\1>#is',
4296 # Strip out HTML (first regex removes any tag not allowed)
4298 # * <sup> and <sub> (T10393)
4302 # * <span dir="rtl"> and <span dir="ltr"> (T37167)
4303 # * <s> and <strike> (T35715)
4304 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4305 # to allow setting directionality in toc items.
4306 $tocline = preg_replace(
4308 '#<(?!/?(span|sup|sub|bdi|i|b|s|strike)(?: [^>]*)?>).*?>#',
4309 '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|bdi|i|b|s|strike))(?: .*?)?>#'
4315 # Strip '<span></span>', which is the result from the above if
4316 # <span id="foo"></span> is used to produce an additional anchor
4318 $tocline = str_replace(
'<span></span>',
'', $tocline );
4320 $tocline = trim( $tocline );
4322 # For the anchor, strip out HTML-y stuff period
4323 $safeHeadline = preg_replace(
'/<.*?>/',
'', $safeHeadline );
4324 $safeHeadline = Sanitizer::normalizeSectionNameWhitespace( $safeHeadline );
4326 # Save headline for section edit hint before it's escaped
4327 $headlineHint = $safeHeadline;
4329 # Decode HTML entities
4330 $safeHeadline = Sanitizer::decodeCharReferences( $safeHeadline );
4332 $safeHeadline = self::normalizeSectionName( $safeHeadline );
4334 $fallbackHeadline = Sanitizer::escapeIdForAttribute( $safeHeadline, Sanitizer::ID_FALLBACK );
4335 $linkAnchor = Sanitizer::escapeIdForLink( $safeHeadline );
4336 $safeHeadline = Sanitizer::escapeIdForAttribute( $safeHeadline, Sanitizer::ID_PRIMARY );
4337 if ( $fallbackHeadline === $safeHeadline ) {
4338 # No reason to have both (in fact, we can't)
4339 $fallbackHeadline =
false;
4342 # HTML IDs must be case-insensitively unique for IE compatibility (T12721).
4343 # @todo FIXME: We may be changing them depending on the current locale.
4344 $arrayKey = strtolower( $safeHeadline );
4345 if ( $fallbackHeadline ===
false ) {
4346 $fallbackArrayKey =
false;
4348 $fallbackArrayKey = strtolower( $fallbackHeadline );
4351 # Create the anchor for linking from the TOC to the section
4352 $anchor = $safeHeadline;
4353 $fallbackAnchor = $fallbackHeadline;
4354 if ( isset( $refers[$arrayKey] ) ) {
4356 for ( $i = 2; isset( $refers[
"${arrayKey}_$i"] ); ++$i );
4358 $linkAnchor .=
"_$i";
4359 $refers[
"${arrayKey}_$i"] =
true;
4361 $refers[$arrayKey] =
true;
4363 if ( $fallbackHeadline !==
false && isset( $refers[$fallbackArrayKey] ) ) {
4365 for ( $i = 2; isset( $refers[
"${fallbackArrayKey}_$i"] ); ++$i );
4366 $fallbackAnchor .=
"_$i";
4367 $refers[
"${fallbackArrayKey}_$i"] =
true;
4369 $refers[$fallbackArrayKey] =
true;
4372 # Don't number the heading if it is the only one (looks silly)
4373 if ( count(
$matches[3] ) > 1 && $this->mOptions->getNumberHeadings() ) {
4374 # the two are different if the line contains a link
4375 $headline = Html::element(
4377 [
'class' =>
'mw-headline-number' ],
4379 ) .
' ' . $headline;
4384 $numbering, $toclevel, ( $isTemplate ?
false : $sectionIndex ) );
4387 # Add the section to the section tree
4388 # Find the DOM node for this header
4389 $noOffset = ( $isTemplate || $sectionIndex ===
false );
4390 while ( $node && !$noOffset ) {
4391 if ( $node->getName() ===
'h' ) {
4392 $bits = $node->splitHeading();
4393 if ( $bits[
'i'] == $sectionIndex ) {
4397 $byteOffset += mb_strlen( $this->mStripState->unstripBoth(
4399 $node = $node->getNextSibling();
4402 'toclevel' => $toclevel,
4405 'number' => $numbering,
4406 'index' => ( $isTemplate ?
'T-' :
'' ) . $sectionIndex,
4407 'fromtitle' => $titleText,
4408 'byteoffset' => ( $noOffset ?
null : $byteOffset ),
4409 'anchor' => $anchor,
4412 # give headline the correct <h#> tag
4413 if ( $maybeShowEditLink && $sectionIndex !==
false ) {
4415 if ( $isTemplate ) {
4416 # Put a T flag in the section identifier, to indicate to extractSections()
4417 # that sections inside <includeonly> should be counted.
4418 $editsectionPage = $titleText;
4419 $editsectionSection =
"T-$sectionIndex";
4420 $editsectionContent =
null;
4422 $editsectionPage = $this->mTitle->getPrefixedText();
4423 $editsectionSection = $sectionIndex;
4424 $editsectionContent = $headlineHint;
4438 $editlink =
'<mw:editsection page="' . htmlspecialchars( $editsectionPage );
4439 $editlink .=
'" section="' . htmlspecialchars( $editsectionSection ) .
'"';
4440 if ( $editsectionContent !==
null ) {
4441 $editlink .=
'>' . $editsectionContent .
'</mw:editsection>';
4449 $matches[
'attrib'][$headlineCount], $anchor, $headline,
4450 $editlink, $fallbackAnchor );
4455 $this->setOutputType( $oldType );
4457 # Never ever show TOC if no headers
4458 if ( $numVisible < 1 ) {
4467 $this->mOutput->setTOCHTML( $toc );
4468 $toc = self::TOC_START . $toc . self::TOC_END;
4472 $this->mOutput->setSections( $tocraw );
4475 # split up and insert constructed headlines
4476 $blocks = preg_split(
'/<H[1-6].*?>[\s\S]*?<\/H[1-6]>/i', $text );
4481 foreach ( $blocks
as $block ) {
4483 if ( empty( $head[$i - 1] ) ) {
4484 $sections[$i] = $block;
4486 $sections[$i] = $head[$i - 1] . $block;
4499 Hooks::run(
'ParserSectionCreate', [ $this, $i, &$sections[$i], $maybeShowEditLink ] );
4504 if ( $enoughToc && $isMain && !$this->mForceTocPosition ) {
4507 $sections[0] = $sections[0] . $toc .
"\n";
4510 $full .= implode(
'', $sections );
4512 if ( $this->mForceTocPosition ) {
4513 return str_replace(
'<!--MWTOC\'"-->', $toc, $full );
4533 if ( $clearState ) {
4534 $magicScopeVariable = $this->lock();
4536 $this->startParse(
$title,
$options, self::OT_WIKI, $clearState );
4537 $this->setUser(
$user );
4540 $text = str_replace(
"\000",
'', $text );
4545 $text = TextContent::normalizeLineEndings( $text );
4547 if (
$options->getPreSaveTransform() ) {
4548 $text = $this->pstPass2( $text,
$user );
4550 $text = $this->mStripState->unstripBoth( $text );
4552 $this->setUser(
null ); # Reset
4566 # Note: This is the timestamp saved as hardcoded wikitext to the database, we use
4567 # $this->contLang here in order to give everyone the same signature and use the default one
4568 # rather than the one selected in each user's preferences. (see also T14815)
4569 $ts = $this->mOptions->getTimestamp();
4570 $timestamp = MWTimestamp::getLocalInstance( $ts );
4571 $ts = $timestamp->format(
'YmdHis' );
4572 $tzMsg = $timestamp->getTimezoneMessage()->inContentLanguage()->text();
4574 $d = $this->contLang->timeanddate( $ts,
false,
false ) .
" ($tzMsg)";
4576 # Variable replacement
4577 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4578 $text = $this->replaceVariables( $text );
4580 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4581 # which may corrupt this parser instance via its wfMessage()->text() call-
4584 if ( strpos( $text,
'~~~' ) !==
false ) {
4585 $sigText = $this->getUserSig(
$user );
4586 $text = strtr( $text, [
4588 '~~~~' =>
"$sigText $d",
4591 # The main two signature forms used above are time-sensitive
4592 $this->mOutput->setFlag(
'user-signature' );
4595 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4596 $tc =
'[' . Title::legalChars() .
']';
4597 $nc =
'[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can
use non-ascii!
4600 $p1 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/";
4602 $p4 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?($tc+))\\|]]/";
4604 $p3 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |,)$tc+|)\\|]]/";
4606 $p2 =
"/\[\[\\|($tc+)]]/";
4608 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4609 $text = preg_replace( $p1,
'[[\\1\\2\\3|\\2]]', $text );
4610 $text = preg_replace( $p4,
'[[\\1\\2\\3|\\2]]', $text );
4611 $text = preg_replace( $p3,
'[[\\1\\2\\3\\4|\\2]]', $text );
4613 $t = $this->mTitle->getText();
4615 if ( preg_match(
"/^($nc+:|)$tc+?( \\($tc+\\))$/",
$t, $m ) ) {
4616 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4617 } elseif ( preg_match(
"/^($nc+:|)$tc+?(, $tc+|)$/",
$t, $m ) &&
"$m[1]$m[2]" !=
'' ) {
4618 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4620 # if there's no context, don't bother duplicating the title
4621 $text = preg_replace( $p2,
'[[\\1]]', $text );
4641 public function getUserSig( &$user, $nickname =
false, $fancySig =
null ) {
4646 # If not given, retrieve from the user object.
4647 if ( $nickname ===
false ) {
4648 $nickname =
$user->getOption(
'nickname' );
4651 if ( is_null( $fancySig ) ) {
4652 $fancySig =
$user->getBoolOption(
'fancysig' );
4655 $nickname = $nickname ==
null ?
$username : $nickname;
4659 wfDebug( __METHOD__ .
": $username has overlong signature.\n" );
4660 } elseif ( $fancySig !==
false ) {
4661 # Sig. might contain markup; validate this
4662 if ( $this->validateSig( $nickname ) !==
false ) {
4663 # Validated; clean up (if needed) and return it
4664 return $this->cleanSig( $nickname,
true );
4666 # Failed to validate; fall back to the default
4668 wfDebug( __METHOD__ .
": $username has bad XML tags in signature.\n" );
4672 # Make sure nickname doesnt get a sig in a sig
4673 $nickname = self::cleanSigInSig( $nickname );
4675 # If we're still here, make it a link to the user page
4678 $msgName =
$user->isAnon() ?
'signature-anon' :
'signature';
4680 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()
4681 ->title( $this->getTitle() )->text();
4691 return Xml::isWellFormedXmlFragment( $text ) ? $text :
false;
4707 $magicScopeVariable = $this->lock();
4711 # Option to disable this feature
4712 if ( !$this->mOptions->getCleanSignatures() ) {
4716 # @todo FIXME: Regex doesn't respect extension tags or nowiki
4717 # => Move this logic to braceSubstitution()
4718 $substWord = $this->magicWordFactory->get(
'subst' );
4719 $substRegex =
'/\{\{(?!(?:' . $substWord->getBaseRegex() .
'))/x' . $substWord->getRegexCase();
4720 $substText =
'{{' . $substWord->getSynonym( 0 );
4722 $text = preg_replace( $substRegex, $substText, $text );
4723 $text = self::cleanSigInSig( $text );
4724 $dom = $this->preprocessToDom( $text );
4725 $frame = $this->getPreprocessor()->newFrame();
4726 $text = $frame->expand( $dom );
4729 $text = $this->mStripState->unstripBoth( $text );
4742 $text = preg_replace(
'/~{3,5}/',
'', $text );
4756 $outputType, $clearState =
true
4768 $outputType, $clearState =
true
4770 $this->setTitle(
$title );
4772 $this->setOutputType( $outputType );
4773 if ( $clearState ) {
4774 $this->clearState();
4787 static $executing =
false;
4789 # Guard against infinite recursion
4830 public function setHook( $tag, callable $callback ) {
4831 $tag = strtolower( $tag );
4832 if ( preg_match(
'/[<>\r\n]/', $tag, $m ) ) {
4833 throw new MWException(
"Invalid character {$m[0]} in setHook('$tag', ...) call" );
4835 $oldVal = $this->mTagHooks[$tag] ??
null;
4836 $this->mTagHooks[$tag] = $callback;
4837 if ( !in_array( $tag, $this->mStripList ) ) {
4838 $this->mStripList[] = $tag;
4862 $tag = strtolower( $tag );
4863 if ( preg_match(
'/[<>\r\n]/', $tag, $m ) ) {
4864 throw new MWException(
"Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
4866 $oldVal = $this->mTransparentTagHooks[$tag] ??
null;
4867 $this->mTransparentTagHooks[$tag] = $callback;
4876 $this->mTagHooks = [];
4877 $this->mFunctionTagHooks = [];
4878 $this->mStripList = $this->mDefaultStripList;
4925 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] :
null;
4926 $this->mFunctionHooks[$id] = [ $callback, $flags ];
4928 # Add to function cache
4929 $mw = $this->magicWordFactory->get( $id );
4931 throw new MWException( __METHOD__ .
'() expecting a magic word identifier.' );
4934 $synonyms = $mw->getSynonyms();
4935 $sensitive = intval( $mw->isCaseSensitive() );
4937 foreach ( $synonyms
as $syn ) {
4939 if ( !$sensitive ) {
4940 $syn = $this->contLang->lc( $syn );
4943 if ( !( $flags & self::SFH_NO_HASH ) ) {
4946 # Remove trailing colon
4947 if ( substr( $syn, -1, 1 ) ===
':' ) {
4948 $syn = substr( $syn, 0, -1 );
4950 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
4961 $this->firstCallInit();
4962 return array_keys( $this->mFunctionHooks );
4976 $tag = strtolower( $tag );
4977 if ( preg_match(
'/[<>\r\n]/', $tag, $m ) ) {
4978 throw new MWException(
"Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
4980 $old = $this->mFunctionTagHooks[$tag] ??
null;
4981 $this->mFunctionTagHooks[$tag] = [ $callback, $flags ];
4983 if ( !in_array( $tag, $this->mStripList ) ) {
4984 $this->mStripList[] = $tag;
4998 $this->mLinkHolders->replace( $text );
5009 return $this->mLinkHolders->replaceText( $text );
5027 if ( isset(
$params[
'mode'] ) ) {
5033 }
catch ( Exception
$e ) {
5038 $ig->setContextTitle( $this->mTitle );
5039 $ig->setShowBytes(
false );
5040 $ig->setShowDimensions(
false );
5041 $ig->setShowFilename(
false );
5042 $ig->setParser( $this );
5043 $ig->setHideBadImages();
5044 $ig->setAttributes( Sanitizer::validateTagAttributes(
$params,
'ul' ) );
5046 if ( isset(
$params[
'showfilename'] ) ) {
5047 $ig->setShowFilename(
true );
5049 $ig->setShowFilename(
false );
5051 if ( isset(
$params[
'caption'] ) ) {
5052 $caption =
$params[
'caption'];
5053 $caption = htmlspecialchars( $caption );
5054 $caption = $this->replaceInternalLinks( $caption );
5055 $ig->setCaptionHtml( $caption );
5057 if ( isset(
$params[
'perrow'] ) ) {
5058 $ig->setPerRow(
$params[
'perrow'] );
5060 if ( isset(
$params[
'widths'] ) ) {
5061 $ig->setWidths(
$params[
'widths'] );
5063 if ( isset(
$params[
'heights'] ) ) {
5064 $ig->setHeights(
$params[
'heights'] );
5066 $ig->setAdditionalOptions(
$params );
5070 Hooks::run(
'BeforeParserrenderImageGallery', [ &
$parser, &$ig ] );
5074 # match lines like these:
5075 # Image:someimage.jpg|This is some image
5083 if ( strpos(
$matches[0],
'%' ) !==
false ) {
5087 if ( is_null(
$title ) ) {
5088 # Bogus title. Ignore these so we don't bomb out later.
5092 # We need to get what handler the file uses, to figure out parameters.
5093 # Note, a hook can overide the file name, and chose an entirely different
5094 # file (which potentially could be of a different type and have different handler).
5097 Hooks::run(
'BeforeParserFetchFileAndTitle',
5099 # Don't register it now, as TraditionalImageGallery does that later.
5101 $handler = $file ? $file->getHandler() :
false;
5104 'img_alt' =>
'gallery-internal-alt',
5105 'img_link' =>
'gallery-internal-link',
5108 $paramMap = $paramMap +
$handler->getParamMap();
5111 unset( $paramMap[
'img_width'] );
5114 $mwArray = $this->magicWordFactory->newArray( array_keys( $paramMap ) );
5119 $handlerOptions = [];
5133 foreach ( $parameterMatches
as $parameterMatch ) {
5134 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
5136 $paramName = $paramMap[$magicName];
5138 switch ( $paramName ) {
5139 case 'gallery-internal-alt':
5140 $alt = $this->stripAltText( $match,
false );
5142 case 'gallery-internal-link':
5143 $linkValue = strip_tags( $this->replaceLinkHoldersText( $match ) );
5144 if ( preg_match(
'/^-{R|(.*)}-$/', $linkValue ) ) {
5147 $linkValue = substr( $linkValue, 4, -2 );
5149 list(
$type, $target ) = $this->parseLinkParameter( $linkValue );
5150 if (
$type ===
'link-url' ) {
5152 $this->mOutput->addExternalLink( $target );
5153 } elseif (
$type ===
'link-title' ) {
5154 $link = $target->getLinkURL();
5155 $this->mOutput->addLink( $target );
5160 if (
$handler->validateParam( $paramName, $match ) ) {
5161 $handlerOptions[$paramName] = $match;
5164 wfDebug(
"$parameterMatch failed parameter validation\n" );
5165 $label = $parameterMatch;
5171 $label = $parameterMatch;
5176 $ig->add(
$title, $label, $alt,
$link, $handlerOptions );
5178 $html = $ig->toHTML();
5179 Hooks::run(
'AfterParserFetchFileAndTitle', [ $this, $ig, &
$html ] );
5189 $handlerClass = get_class(
$handler );
5193 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
5194 # Initialise static lists
5195 static $internalParamNames = [
5196 'horizAlign' => [
'left',
'right',
'center',
'none' ],
5197 'vertAlign' => [
'baseline',
'sub',
'super',
'top',
'text-top',
'middle',
5198 'bottom',
'text-bottom' ],
5199 'frame' => [
'thumbnail',
'manualthumb',
'framed',
'frameless',
5200 'upright',
'border',
'link',
'alt',
'class' ],
5202 static $internalParamMap;
5203 if ( !$internalParamMap ) {
5204 $internalParamMap = [];
5205 foreach ( $internalParamNames
as $type => $names ) {
5212 $magicName = str_replace(
'-',
'_',
"img_$name" );
5213 $internalParamMap[$magicName] = [
$type,
$name ];
5218 # Add handler params
5219 $paramMap = $internalParamMap;
5221 $handlerParamMap =
$handler->getParamMap();
5222 foreach ( $handlerParamMap
as $magic => $paramName ) {
5223 $paramMap[$magic] = [
'handler', $paramName ];
5226 $this->mImageParams[$handlerClass] = $paramMap;
5227 $this->mImageParamsMagicArray[$handlerClass] =
5228 $this->magicWordFactory->newArray( array_keys( $paramMap ) );
5230 return [ $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] ];
5242 # Check if the options text is of the form "options|alt text"
5244 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5245 # * left no resizing, just left align. label is used for alt= only
5246 # * right same, but right aligned
5247 # * none same, but not aligned
5248 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5249 # * center center the image
5250 # * frame Keep original image size, no magnify-button.
5251 # * framed Same as "frame"
5252 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5253 # * upright reduce width for upright images, rounded to full __0 px
5254 # * border draw a 1px border around the image
5255 # * alt Text for HTML alt attribute (defaults to empty)
5256 # * class Set a class for img node
5257 # * link Set the target of the image link. Can be external, interwiki, or local
5258 # vertical-align values (no % or length right now):
5268 # Protect LanguageConverter markup when splitting into parts
5273 # Give extensions a chance to select the file revision for us
5276 Hooks::run(
'BeforeParserFetchFileAndTitle',
5278 # Fetch and register the file (file title may be different via hooks)
5282 $handler = $file ? $file->getHandler() :
false;
5284 list( $paramMap, $mwArray ) = $this->getImageParams(
$handler );
5287 $this->addTrackingCategory(
'broken-file-category' );
5290 # Process the input parameters
5292 $params = [
'frame' => [],
'handler' => [],
5293 'horizAlign' => [],
'vertAlign' => [] ];
5294 $seenformat =
false;
5295 foreach ( $parts
as $part ) {
5296 $part = trim( $part );
5297 list( $magicName,
$value ) = $mwArray->matchVariableStartToEnd( $part );
5299 if ( isset( $paramMap[$magicName] ) ) {
5300 list(
$type, $paramName ) = $paramMap[$magicName];
5302 # Special case; width and height come in one variable together
5303 if (
$type ===
'handler' && $paramName ===
'width' ) {
5304 $parsedWidthParam = self::parseWidthParam(
$value );
5305 if ( isset( $parsedWidthParam[
'width'] ) ) {
5306 $width = $parsedWidthParam[
'width'];
5307 if (
$handler->validateParam(
'width', $width ) ) {
5312 if ( isset( $parsedWidthParam[
'height'] ) ) {
5313 $height = $parsedWidthParam[
'height'];
5314 if (
$handler->validateParam(
'height', $height ) ) {
5319 # else no validation -- T15436
5321 if (
$type ===
'handler' ) {
5322 # Validate handler parameter
5325 # Validate internal parameters
5326 switch ( $paramName ) {
5330 # @todo FIXME: Possibly check validity here for
5331 # manualthumb? downstream behavior seems odd with
5332 # missing manual thumbs.
5340 if ( $paramName ===
'no-link' ) {
5343 if ( $paramName ===
'link-url' ) {
5344 if ( $this->mOptions->getExternalLinkTarget() ) {
5345 $params[
$type][
'link-target'] = $this->mOptions->getExternalLinkTarget();
5354 $validated = !$seenformat;
5358 # Most other things appear to be empty or numeric...
5359 $validated = (
$value ===
false || is_numeric( trim(
$value ) ) );
5368 if ( !$validated ) {
5373 # Process alignment parameters
5374 if (
$params[
'horizAlign'] ) {
5381 $params[
'frame'][
'caption'] = $caption;
5383 # Will the image be presented in a frame, with the caption below?
5384 $imageIsFramed = isset(
$params[
'frame'][
'frame'] )
5385 || isset(
$params[
'frame'][
'framed'] )
5386 || isset(
$params[
'frame'][
'thumbnail'] )
5387 || isset(
$params[
'frame'][
'manualthumb'] );
5389 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5390 # came to also set the caption, ordinary text after the image -- which
5391 # makes no sense, because that just repeats the text multiple times in
5392 # screen readers. It *also* came to set the title attribute.
5393 # Now that we have an alt attribute, we should not set the alt text to
5394 # equal the caption: that's worse than useless, it just repeats the
5395 # text. This is the framed/thumbnail case. If there's no caption, we
5396 # use the unnamed parameter for alt text as well, just for the time be-
5397 # ing, if the unnamed param is set and the alt param is not.
5398 # For the future, we need to figure out if we want to tweak this more,
5399 # e.g., introducing a title= parameter for the title; ignoring the un-
5400 # named parameter entirely for images without a caption; adding an ex-
5401 # plicit caption= parameter and preserving the old magic unnamed para-
5403 if ( $imageIsFramed ) { # Framed image
5404 if ( $caption ===
'' && !isset(
$params[
'frame'][
'alt'] ) ) {
5405 # No caption or alt text, add the filename as the alt text so
5406 # that screen readers at least get some description of the image
5409 # Do not set $params['frame']['title'] because tooltips don't make sense
5411 }
else { # Inline image
5412 if ( !isset(
$params[
'frame'][
'alt'] ) ) {
5413 # No alt text, use the "caption" for the alt text
5414 if ( $caption !==
'' ) {
5415 $params[
'frame'][
'alt'] = $this->stripAltText( $caption, $holders );
5417 # No caption, fall back to using the filename for the
5422 # Use the "caption" for the tooltip text
5423 $params[
'frame'][
'title'] = $this->stripAltText( $caption, $holders );
5426 Hooks::run(
'ParserMakeImageParams', [
$title, $file, &
$params, $this ] );
5428 # Linker does the rest
5431 $time, $descQuery, $this->mOptions->getThumbSize() );
5433 # Give the handler a chance to modify the parser object
5435 $handler->parserTransformHook( $this, $file );
5459 $chars = self::EXT_LINK_URL_CLASS;
5460 $addr = self::EXT_LINK_ADDR;
5461 $prots = $this->mUrlProtocols;
5466 } elseif ( preg_match(
"/^((?i)$prots)/",
$value ) ) {
5467 if ( preg_match(
"/^((?i)$prots)$addr$chars*$/u",
$value, $m ) ) {
5468 $this->mOutput->addExternalLink(
$value );
5473 $linkTitle = Title::newFromText(
$value );
5475 $this->mOutput->addLink( $linkTitle );
5476 $type =
'link-title';
5477 $target = $linkTitle;
5480 return [
$type, $target ];
5489 # Strip bad stuff out of the title (tooltip). We can't just use
5490 # replaceLinkHoldersText() here, because if this function is called
5491 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
5493 $tooltip = $holders->replaceText( $caption );
5495 $tooltip = $this->replaceLinkHoldersText( $caption );
5498 # make sure there are no placeholders in thumbnail attributes
5499 # that are later expanded to html- so expand them now and
5501 $tooltip = $this->mStripState->unstripBoth( $tooltip );
5502 $tooltip = Sanitizer::stripAllTags( $tooltip );
5513 wfDebug(
"Parser output marked as uncacheable.\n" );
5514 if ( !$this->mOutput ) {
5516 " can only be called when actually parsing something" );
5518 $this->mOutput->updateCacheExpiry( 0 );
5530 $text = $this->replaceVariables( $text, $frame );
5531 $text = $this->mStripState->unstripBoth( $text );
5541 $this->firstCallInit();
5543 array_keys( $this->mTransparentTagHooks ),
5544 array_keys( $this->mTagHooks ),
5545 array_keys( $this->mFunctionTagHooks )
5554 $this->firstCallInit();
5555 return $this->mFunctionSynonyms;
5563 return $this->mUrlProtocols;
5578 $elements = array_keys( $this->mTransparentTagHooks );
5579 $text = self::extractTagsAndParams( $elements, $text,
$matches );
5584 $tagName = strtolower( $element );
5585 if ( isset( $this->mTransparentTagHooks[$tagName] ) ) {
5586 $output = call_user_func_array(
5587 $this->mTransparentTagHooks[$tagName],
5593 $replacements[$marker] =
$output;
5595 return strtr( $text, $replacements );
5628 global
$wgTitle; # not generally
used but removes an ugly failure mode
5630 $magicScopeVariable = $this->lock();
5633 $frame = $this->getPreprocessor()->newFrame();
5635 # Process section extraction flags
5637 $sectionParts = explode(
'-', $sectionId );
5638 $sectionIndex = array_pop( $sectionParts );
5639 foreach ( $sectionParts
as $part ) {
5640 if ( $part ===
'T' ) {
5641 $flags |= self::PTD_FOR_INCLUSION;
5645 # Check for empty input
5646 if ( strval( $text ) ===
'' ) {
5647 # Only sections 0 and T-0 exist in an empty document
5648 if ( $sectionIndex == 0 ) {
5649 if ( $mode ===
'get' ) {
5655 if ( $mode ===
'get' ) {
5663 # Preprocess the text
5664 $root = $this->preprocessToDom( $text, $flags );
5666 # <h> nodes indicate section breaks
5667 # They can only occur at the top level, so we can find them by iterating the root's children
5668 $node = $root->getFirstChild();
5670 # Find the target section
5671 if ( $sectionIndex == 0 ) {
5672 # Section zero doesn't nest, level=big
5673 $targetLevel = 1000;
5676 if ( $node->getName() ===
'h' ) {
5677 $bits = $node->splitHeading();
5678 if ( $bits[
'i'] == $sectionIndex ) {
5679 $targetLevel = $bits[
'level'];
5683 if ( $mode ===
'replace' ) {
5686 $node = $node->getNextSibling();
5692 if ( $mode ===
'get' ) {
5699 # Find the end of the section, including nested sections
5701 if ( $node->getName() ===
'h' ) {
5702 $bits = $node->splitHeading();
5703 $curLevel = $bits[
'level'];
5704 if ( $bits[
'i'] != $sectionIndex && $curLevel <= $targetLevel ) {
5708 if ( $mode ===
'get' ) {
5711 $node = $node->getNextSibling();
5714 # Write out the remainder (in replace mode only)
5715 if ( $mode ===
'replace' ) {
5716 # Output the replacement text
5717 # Add two newlines on -- trailing whitespace in $newText is conventionally
5718 # stripped by the editor, so we need both newlines to restore the paragraph gap
5719 # Only add trailing whitespace if there is newText
5720 if ( $newText !=
"" ) {
5721 $outText .= $newText .
"\n\n";
5726 $node = $node->getNextSibling();
5730 if ( is_string( $outText ) ) {
5731 # Re-insert stripped tags
5732 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
5752 public function getSection( $text, $sectionId, $defaultText =
'' ) {
5753 return $this->extractSections( $text, $sectionId,
'get', $defaultText );
5769 return $this->extractSections( $oldText, $sectionId,
'replace', $newText );
5778 return $this->mRevisionId;
5788 if ( !is_null( $this->mRevisionObject ) ) {
5789 return $this->mRevisionObject;
5799 $rev = call_user_func(
5800 $this->mOptions->getCurrentRevisionCallback(), $this->getTitle(), $this
5803 if ( $this->mRevisionId ===
null &&
$rev &&
$rev->getId() ) {
5815 if ( $this->mRevisionId &&
$rev &&
$rev->getId() != $this->mRevisionId ) {
5819 $this->mRevisionObject =
$rev;
5821 return $this->mRevisionObject;
5830 if ( is_null( $this->mRevisionTimestamp ) ) {
5831 $revObject = $this->getRevisionObject();
5832 $timestamp = $revObject ? $revObject->getTimestamp() :
wfTimestampNow();
5834 # The cryptic '' timezone parameter tells to use the site-default
5835 # timezone offset instead of the user settings.
5836 # Since this value will be saved into the parser cache, served
5837 # to other users, and potentially even used inside links and such,
5838 # it needs to be consistent for all visitors.
5839 $this->mRevisionTimestamp = $this->contLang->userAdjust( $timestamp,
'' );
5841 return $this->mRevisionTimestamp;
5850 if ( is_null( $this->mRevisionUser ) ) {
5851 $revObject = $this->getRevisionObject();
5853 # if this template is subst: the revision id will be blank,
5854 # so just use the current user's name
5856 $this->mRevisionUser = $revObject->getUserText();
5857 } elseif ( $this->ot[
'wiki'] || $this->mOptions->getIsPreview() ) {
5858 $this->mRevisionUser = $this->getUser()->getName();
5861 return $this->mRevisionUser;
5870 if ( is_null( $this->mRevisionSize ) ) {
5871 $revObject = $this->getRevisionObject();
5873 # if this variable is subst: the revision id will be blank,
5874 # so just use the parser input size, because the own substituation
5875 # will change the size.
5877 $this->mRevisionSize = $revObject->getSize();
5879 $this->mRevisionSize = $this->mInputSize;
5882 return $this->mRevisionSize;
5891 $this->mDefaultSort =
$sort;
5892 $this->mOutput->setProperty(
'defaultsort',
$sort );
5906 if ( $this->mDefaultSort !==
false ) {
5907 return $this->mDefaultSort;
5920 return $this->mDefaultSort;
5924 $text = Sanitizer::normalizeSectionNameWhitespace( $text );
5925 $text = Sanitizer::decodeCharReferences( $text );
5926 $text = self::normalizeSectionName( $text );
5931 return '#' . Sanitizer::escapeIdForLink( $sectionName );
5938 $id = Sanitizer::escapeIdForAttribute( $sectionName, Sanitizer::ID_FALLBACK );
5940 $id = Sanitizer::escapeIdForLink( $sectionName );
5955 # Strip out wikitext links(they break the anchor)
5956 $text = $this->stripSectionName( $text );
5957 $sectionName = self::getSectionNameFromStrippedText( $text );
5958 return self::makeAnchor( $sectionName );
5971 # Strip out wikitext links(they break the anchor)
5972 $text = $this->stripSectionName( $text );
5973 $sectionName = self::getSectionNameFromStrippedText( $text );
5974 return self::makeLegacyAnchor( $sectionName );
5983 $sectionName = self::getSectionNameFromStrippedText( $text );
5984 return self::makeAnchor( $sectionName );
5994 # T90902: ensure the same normalization is applied for IDs as to links
5995 $titleParser = MediaWikiServices::getInstance()->getTitleParser();
5998 $parts = $titleParser->splitTitleString(
"#$text" );
6002 return $parts[
'fragment'];
6020 # Strip internal link markup
6021 $text = preg_replace(
'/\[\[:?([^[|]+)\|([^[]+)\]\]/',
'$2', $text );
6022 $text = preg_replace(
'/\[\[:?([^[]+)\|?\]\]/',
'$1', $text );
6024 # Strip external link markup
6025 # @todo FIXME: Not tolerant to blank link text
6027 # on how many empty links there are on the page - need to figure that out.
6028 $text = preg_replace(
'/\[(?i:' . $this->mUrlProtocols .
')([^ ]+?) ([^[]+)\]/',
'$2', $text );
6030 # Parse wikitext quotes (italics & bold)
6031 $text = $this->doQuotes( $text );
6049 $outputType = self::OT_HTML
6051 $magicScopeVariable = $this->lock();
6054 $text = $this->replaceVariables( $text );
6055 $text = $this->mStripState->unstripBoth( $text );
6056 $text = Sanitizer::removeHTMLtags( $text );
6077 return $this->testSrvus( $text,
$title,
$options, self::OT_PREPROCESS );
6099 while ( $i < strlen(
$s ) ) {
6100 $markerStart = strpos(
$s, self::MARKER_PREFIX, $i );
6101 if ( $markerStart ===
false ) {
6102 $out .= call_user_func( $callback, substr(
$s, $i ) );
6105 $out .= call_user_func( $callback, substr(
$s, $i, $markerStart - $i ) );
6106 $markerEnd = strpos(
$s, self::MARKER_SUFFIX, $markerStart );
6107 if ( $markerEnd ===
false ) {
6108 $out .= substr(
$s, $markerStart );
6111 $markerEnd += strlen( self::MARKER_SUFFIX );
6112 $out .= substr(
$s, $markerStart, $markerEnd - $markerStart );
6127 return $this->mStripState->killMarkers( $text );
6151 'version' => self::HALF_PARSED_VERSION,
6152 'stripState' => $this->mStripState->getSubState( $text ),
6153 'linkHolders' => $this->mLinkHolders->getSubArray( $text )
6176 if ( !isset( $data[
'version'] ) || $data[
'version'] != self::HALF_PARSED_VERSION ) {
6177 throw new MWException( __METHOD__ .
': invalid version' );
6180 # First, extract the strip state.
6181 $texts = [ $data[
'text'] ];
6182 $texts = $this->mStripState->merge( $data[
'stripState'], $texts );
6184 # Now renumber links
6185 $texts = $this->mLinkHolders->mergeForeign( $data[
'linkHolders'], $texts );
6187 # Should be good to go.
6203 return isset( $data[
'version'] ) && $data[
'version'] == self::HALF_PARSED_VERSION;
6216 $parsedWidthParam = [];
6218 return $parsedWidthParam;
6221 # (T15500) In both cases (width/height and width only),
6222 # permit trailing "px" for backward compatibility.
6223 if ( $parseHeight && preg_match(
'/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/',
$value, $m ) ) {
6224 $width = intval( $m[1] );
6225 $height = intval( $m[2] );
6226 $parsedWidthParam[
'width'] = $width;
6227 $parsedWidthParam[
'height'] = $height;
6228 } elseif ( preg_match(
'/^[0-9]*\s*(?:px)?\s*$/',
$value ) ) {
6229 $width = intval(
$value );
6230 $parsedWidthParam[
'width'] = $width;
6232 return $parsedWidthParam;
6245 if ( $this->mInParse ) {
6246 throw new MWException(
"Parser state cleared while parsing. "
6247 .
"Did you call Parser::parse recursively? Lock is held by: " . $this->mInParse );
6253 $this->mInParse =
$e->getTraceAsString();
6255 $recursiveCheck =
new ScopedCallback(
function () {
6256 $this->mInParse =
false;
6259 return $recursiveCheck;
6274 if ( preg_match(
'/^<p>(.*)\n?<\/p>\n?$/sU',
$html, $m ) ) {
6275 if ( strpos( $m[1],
'</p>' ) ===
false ) {
6294 if ( $this->mInParse ) {
6295 return $this->factory->create();
6308 OutputPage::setupOOUI();
6309 $this->mOutput->setEnableOOUI(
true );
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
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 or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly display
If you want to remove the page from your watchlist later
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
$wgLanguageCode
Site language code.
$wgNoFollowNsExceptions
Namespaces in which $wgNoFollowLinks doesn't apply.
$wgServerName
Server name.
$wgExtraInterlanguageLinkPrefixes
List of additional interwiki prefixes that should be treated as interlanguage links (i....
$wgNoFollowLinks
If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to sear...
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgSitename
Name of the site.
$wgNoFollowDomainExceptions
If this is set to an array of domains, external links to these domain names (or any subdomains) will ...
$wgScriptPath
The path we should point to.
$wgFragmentMode
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of...
$wgTranscludeCacheExpiry
Expiry time for transcluded templates cached in object cache.
$wgMaxSigChars
Maximum number of Unicode characters in signature.
$wgEnableScaryTranscluding
Enable interwiki transcluding.
$wgStylePath
The URL path of the skins directory.
$wgServer
URL of the server.
$wgMaxTocLevel
Maximum indent level of toc.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfUrlencode( $s)
We want some things to be included as literal characters in our title URLs for prettiness,...
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfHostname()
Fetch server name for use in error reporting etc.
wfFindFile( $title, $options=[])
Find a file.
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...
wfUrlProtocols( $includeProtocolRelative=true)
Returns a regular expression of url protocols.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
wfMatchesDomainList( $url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
wfIsHHVM()
Check if we are running under HHVM.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
static doBlockLevels( $text, $lineStart)
Make lists from lines starting with ':', '*', '#', etc.
static cascadingsources( $parser, $title='')
Returns the sources of any cascading protection acting on a specified page.
static register( $parser)
static register( $parser)
WebRequest clone which takes values from a provided array.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Marks HTML that shouldn't be escaped.
static factory( $mode=false, IContextSource $context=null)
Get a new image gallery.
Internationalisation code.
static tocList( $toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
static makeMediaLinkFile(Title $title, $file, $html='')
Create a direct link to a given uploaded file.
static tocLine( $anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
static makeImageLink(Parser $parser, Title $title, $file, $frameParams=[], $handlerParams=[], $time=false, $query="", $widthOption=null)
Given parameters derived from [[Image:Foo|options...]], generate the HTML that that syntax inserts in...
static makeExternalImage( $url, $alt='')
Return the code for images which were added via external links, via Parser::maybeMakeExternalImage().
static normalizeSubpageLink( $contextTitle, $target, &$text)
static makeSelfLinkObj( $nt, $html='', $query='', $trail='', $prefix='')
Make appropriate markup for a link to the current article.
static tocIndent()
Add another level to the Table of Contents.
static splitTrail( $trail)
Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array...
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
static makeHeadline( $level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
Create a headline for content.
static tocUnindent( $level)
Finish one or more sublevels on the Table of Contents.
static tocLineEnd()
End a Table Of Contents line.
static tidy( $text)
Interface with html tidy.
Class for handling an array of magic words.
A factory that stores information about MagicWords, and creates them on demand with caching.
Handles a simple LRU key/value map with a maximum number of entries.
Factory for handling the special page list and generating SpecialPage objects.
Set options of the Parser.
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
addTrackingCategory( $msg)
getTargetLanguage()
Get the target language for the content being parsed.
getRevisionTimestamp()
Get the timestamp associated with the current revision, adjusted for the default server-local timesta...
static normalizeUrlComponent( $component, $unsafe)
bool string $mInParse
Recursive call protection.
extensionSubstitution( $params, $frame)
Return the text to be used for a given extension tag.
setDefaultSort( $sort)
Mutator for $mDefaultSort.
static stripOuterParagraph( $html)
Strip outer.
static normalizeLinkUrl( $url)
Replace unusual escape codes in a URL with their equivalent characters.
getPreloadText( $text, Title $title, ParserOptions $options, $params=[])
Process the wikitext for the "?preload=" feature.
MagicWordFactory $magicWordFactory
areSubpagesAllowed()
Return true if subpage links should be expanded on this page.
__clone()
Allow extensions to clean up when the parser is cloned.
maybeMakeExternalImage( $url)
make an image if it's allowed, either through the global option, through the exception,...
static cleanSigInSig( $text)
Strip 3, 4 or 5 tildes out of signatures.
fetchFileNoRegister( $title, $options=[])
Helper function for fetchFileAndTitle.
getMagicWordFactory()
Get the MagicWordFactory that this Parser is using.
LinkRenderer $mLinkRenderer
preprocess( $text, Title $title=null, ParserOptions $options, $revid=null, $frame=false)
Expand templates and variables in the text, producing valid, static wikitext.
renderImageGallery( $text, $params)
Renders an image gallery from a text with one line per image.
getCustomDefaultSort()
Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.
static getSectionNameFromStrippedText( $text)
stripAltText( $caption, $holders)
getOptions()
Get the ParserOptions object.
cleanSig( $text, $parsing=false)
Clean up signature text.
preSaveTransform( $text, Title $title, User $user, ParserOptions $options, $clearState=true)
Transform wiki markup when saving a page by doing "\\r\\n" -> "\\n" conversion, substituting signatur...
startParse(Title $title=null, ParserOptions $options, $outputType, $clearState=true)
getRevisionUser()
Get the name of the user that edited the last revision.
static statelessFetchRevision(Title $title, $parser=false)
Wrapper around Revision::newFromTitle to allow passing additional parameters without passing them on ...
replaceExternalLinks( $text)
Replace external links (REL)
replaceVariables( $text, $frame=false, $argsOnly=false)
Replace magic variables, templates, and template arguments with the appropriate text.
const HALF_PARSED_VERSION
Update this version number when the output of serialiseHalfParsedText() changes in an incompatible wa...
makeKnownLinkHolder( $nt, $text='', $trail='', $prefix='')
Render a forced-blue link inline; protect against double expansion of URLs if we're in a mode that pr...
armorLinks( $text)
Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further pars...
replaceInternalLinks2(&$s)
Process [[ ]] wikilinks (RIL)
setFunctionTagHook( $tag, callable $callback, $flags)
Create a tag function, e.g.
static makeLegacyAnchor( $sectionName)
static guessSectionNameFromStrippedText( $text)
Like guessSectionNameFromWikiText(), but takes already-stripped text as input.
doMagicLinks( $text)
Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.
unserializeHalfParsedText( $data)
Load the parser state given in the $data array, which is assumed to have been generated by serializeH...
limitationWarn( $limitationType, $current='', $max='')
Warn the user when a parser limitation is reached Will warn at most once the user per limitation type...
LinkHolderArray $mLinkHolders
makeImage( $title, $options, $holders=false)
Parse image options text and use it to make an image.
disableCache()
Set a flag in the output object indicating that the content is dynamic and shouldn't be cached.
pstPass2( $text, $user)
Pre-save transform helper function.
transformMsg( $text, $options, $title=null)
Wrapper for preprocess()
getRevisionSize()
Get the size of the revision.
extractSections( $text, $sectionId, $mode, $newText='')
Break wikitext input into sections, and either pull or replace some particular section's text.
stripSectionName( $text)
Strips a text string of wikitext for use in a section anchor.
static normalizeSectionName( $text)
Apply the same normalization as code making links to this section would.
makeFreeExternalLink( $url, $numPostProto)
Make a free external link, given a user-supplied URL.
recursivePreprocess( $text, $frame=false)
Recursive parser entry point that can be called from an extension tag hook.
getRevisionTimestampSubstring( $start, $len, $mtts, $variable)
getImageParams( $handler)
serializeHalfParsedText( $text)
Save the parser state required to convert the given half-parsed text to HTML.
formatHeadings( $text, $origText, $isMain=true)
This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an...
internalParseHalfParsed( $text, $isMain=true, $linestart=true)
Helper function for parse() that transforms half-parsed HTML into fully parsed HTML.
setFunctionHook( $id, callable $callback, $flags=0)
Create a function, e.g.
getTemplateDom( $title)
Get the semi-parsed DOM representation of a template with a given title, and its redirect destination...
bool $mFirstCall
Whether firstCallInit still needs to be called.
doTableStuff( $text)
parse the wiki syntax used to render tables
getTitle()
Accessor for the Title object.
static getExternalLinkRel( $url=false, $title=null)
Get the rel attribute for a particular external link.
testSrvus( $text, Title $title, ParserOptions $options, $outputType=self::OT_HTML)
strip/replaceVariables/unstrip for preprocessor regression testing
const VERSION
Update this version number when the ParserOutput format changes in an incompatible way,...
MagicWordArray $mSubstWords
replaceTransparentTags( $text)
Replace transparent tags in $text with the values given by the callbacks.
MapCacheLRU null $currentRevisionCache
getLinkRenderer()
Get a LinkRenderer instance to make links with.
static splitWhitespace( $s)
Return a three-element array: leading whitespace, string contents, trailing whitespace.
getExternalLinkAttribs( $url)
Get an associative array of additional HTML attributes appropriate for a particular external link.
setOutputType( $ot)
Set the output type.
__construct(array $conf=[], MagicWordFactory $magicWordFactory=null, Language $contLang=null, ParserFactory $factory=null, $urlProtocols=null, SpecialPageFactory $spFactory=null)
getFunctionLang()
Get a language object for use in parser functions such as {{FORMATNUM:}}.
getVariableValue( $index, $frame=false)
Return value of a magic variable (like PAGENAME)
makeLimitReport()
Set the limit report data in the current ParserOutput, and return the limit report HTML comment.
MagicWordArray $mVariables
getStripList()
Get a list of strippable XML-like elements.
setUser( $user)
Set the current user.
markerSkipCallback( $s, $callback)
Call a callback function on all regions of the given text that are not inside strip markers,...
setHook( $tag, callable $callback)
Create an HTML-style tag, e.g.
doDoubleUnderscore( $text)
Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores,...
argSubstitution( $piece, $frame)
Triple brace replacement – used for template arguments.
replaceInternalLinks( $s)
Process [[ ]] wikilinks.
array $mLangLinkLanguages
Array with the language name of each language link (i.e.
recursiveTagParse( $text, $frame=false)
Half-parse wikitext to half-parsed HTML.
string $mUniqPrefix
Deprecated accessor for the strip marker prefix.
fetchFileAndTitle( $title, $options=[])
Fetch a file and its title and register a reference to it.
getSection( $text, $sectionId, $defaultText='')
This function returns the text of a section, specified by a number ($section).
internalParse( $text, $isMain=true, $frame=false)
Helper function for parse() that transforms wiki markup into half-parsed HTML.
static extractTagsAndParams( $elements, $text, &$matches)
Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker a...
replaceSection( $oldText, $sectionId, $newText)
This function returns $oldtext after the content of the section specified by $section has been replac...
interwikiTransclude( $title, $action)
Transclude an interwiki link.
setTitle( $t)
Set the context title.
incrementIncludeSize( $type, $size)
Increment an include size counter.
maybeDoSubpageLink( $target, &$text)
Handle link to subpage if necessary.
getRevisionObject()
Get the revision object for $this->mRevisionId.
doBlockLevels( $text, $linestart)
Make lists from lines starting with ':', '*', '#', etc.
fetchTemplateAndTitle( $title)
Fetch the unparsed text of a template and register a reference to it.
getDefaultSort()
Accessor for $mDefaultSort Will use the empty string if none is set.
replaceLinkHoldersText( $text)
Replace "<!--LINK-->" link placeholders with plain text of links (not HTML-formatted).
getFunctionHooks()
Get all registered function hook identifiers.
doAllQuotes( $text)
Replace single quotes with HTML markup.
getContentLanguage()
Get the content language that this Parser is using.
Preprocessor $mPreprocessor
fetchCurrentRevisionOfTitle( $title)
Fetch the current revision of a given title.
getOutput()
Get the ParserOutput object.
Options( $x=null)
Accessor/mutator for the ParserOptions object.
Title( $x=null)
Accessor/mutator for the Title object.
recursiveTagParseFully( $text, $frame=false)
Fully parse wikitext to fully parsed HTML.
guessSectionNameFromWikiText( $text)
Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading...
clearTagHooks()
Remove all tag hooks.
replaceLinkHolders(&$text, $options=0)
Replace "<!--LINK-->" link placeholders with actual links, in the buffer Placeholders created in Link...
getRevisionId()
Get the ID of the revision we are parsing.
static parseWidthParam( $value, $parseHeight=true)
Parsed a width param of imagelink like 300px or 200x300px.
validateSig( $text)
Check that the user's signature contains no bad XML.
getPreprocessor()
Get a preprocessor object.
parseLinkParameter( $value)
Parse the value of 'link' parameter in image syntax ([[File:Foo.jpg|link=<value>]]).
guessLegacySectionNameFromWikiText( $text)
Same as guessSectionNameFromWikiText(), but produces legacy anchors instead, if possible.
OutputType( $x=null)
Accessor/mutator for the output type.
__destruct()
Reduce memory usage to reduce the impact of circular references.
fetchFile( $title, $options=[])
Fetch a file and its title and register a reference to it.
getUser()
Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise.
doQuotes( $text)
Helper function for doAllQuotes()
fetchTemplate( $title)
Fetch the unparsed text of a template and register a reference to it.
doHeadings( $text)
Parse headers and return html.
insertStripItem( $text)
Add an item to the strip state Returns the unique tag which must be inserted into the stripped text T...
setTransparentTagHook( $tag, callable $callback)
As setHook(), but letting the contents be parsed.
incrementExpensiveFunctionCount()
Increment the expensive function count.
testPreprocess( $text, Title $title, ParserOptions $options)
static makeAnchor( $sectionName)
SpecialPageFactory $specialPageFactory
firstCallInit()
Do various kinds of initialisation on the first call of the parser.
preprocessToDom( $text, $flags=0)
Preprocess some wikitext and return the document tree.
clearState()
Clear Parser state.
killMarkers( $text)
Remove any strip markers found in the given text.
enableOOUI()
Set's up the PHP implementation of OOUI for use in this request and instructs OutputPage to enable OO...
getUserSig(&$user, $nickname=false, $fancySig=null)
Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext.
braceSubstitution( $piece, $frame)
Return the text of a template, after recursively replacing any variables or templates within the temp...
attributeStripCallback(&$text, $frame=false)
Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely...
initialiseVariables()
initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers
isValidHalfParsedText( $data)
Returns true if the given array, presumed to be generated by serializeHalfParsedText(),...
lock()
Lock the current instance of the parser.
static createAssocArgs( $args)
Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
parse( $text, Title $title, ParserOptions $options, $linestart=true, $clearState=true, $revid=null)
Convert wikitext to HTML Do not call this function recursively.
testPst( $text, Title $title, ParserOptions $options)
startExternalParse(Title $title=null, ParserOptions $options, $outputType, $clearState=true)
Set up some variables which are usually set up in parse() so that an external function can call some ...
getFreshParser()
Return this parser if it is not doing anything, otherwise get a fresh parser.
callParserFunction( $frame, $function, array $args=[])
Call a parser function and return an array with text and flags.
SectionProfiler $mProfiler
getConverterLanguage()
Get the language object for language conversion.
static statelessFetchTemplate( $title, $parser=false)
Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().
Variant of the Message class.
static singleton()
Get a RepoGroup instance.
Group all the pieces relevant to the context of a request into one instance.
static newKnownCurrent(IDatabase $db, $pageIdOrTitle, $revId=0)
Load a revision based on a known page ID and current revision ID from the DB.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target.
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Custom PHP profiler for parser/DB type section names that xhprof/xdebug can't handle.
static numberingroup( $group)
Find the number of users in a given user group.
static getVersion( $flags='', $lang=null)
Return a string of the MediaWiki version with Git revision if available.
static delimiterReplace( $startDelim, $endDelim, $replace, $subject, $flags='')
Perform an operation equivalent to preg_replace() with flags.
static replaceMarkup( $search, $replace, $text)
More or less "markup-safe" str_replace() Ignores any instances of the separator inside <....
static explode( $separator, $subject)
Workalike for explode() with limited memory usage.
static delimiterExplode( $startDelim, $endDelim, $separator, $subject, $nested=false)
Explode a string, but ignore any instances of the separator inside the given start and end delimiters...
Represents a title within MediaWiki.
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their please see
For a write use something like
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 save
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
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 then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if that
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 then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
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
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 MediaWiki s design is based around catering to the lowest common denominator Although we support higher end setups as the way many things work by default is tailored toward shared hosting These defaults are unconventional from the point of view of normal(non-web) applications -- they might conflict with distributors' policies
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
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
this hook is for auditing only $req
see documentation in includes Linker php for Linker::makeImageLink or false for current used if you return false $parser
see documentation in includes Linker php for Linker::makeImageLink & $time
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc next in line in page history
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 '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). '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
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 & $options
null means default in associative array form
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message key
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
namespace and then decline to actually register it file or subcat img or subcat $title
null for the local wiki Added in
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
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 broken
you don t have to do a grep find to see where the $wgReverseTitle variable is used
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
if the prop value should be in the metadata multi language array format
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 & $ret
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "<div ...>$1</div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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 $out
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Allows to change the fields on the form that will be generated $name
this hook is for auditing only or null if authentication failed before getting that far $username
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
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 modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
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 $output
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
processing should stop and the error should be shown to the user * false
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
returning false will NOT prevent logging $e
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
There are three types of nodes:
magicword txt Magic Words are some phrases used in the wikitext They are used for two things
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
In both all secondary updates will be triggered handle like object that caches derived data representing a revision
This document provides an overview of the usage of PageUpdater and that is
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 type