84 # Flags for Parser::setFunctionHook
88 # Constants needed for external link processing
89 # Everything except bracket, space, or control characters
90 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
91 # as well as U+3000 is IDEOGRAPHIC SPACE for bug 19052
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}])';
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}]+)
99 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
102 # Regular expression for a non-newline space
105 # Flags for preprocessToDom
108 # Allowed values for $this->mOutputType
109 # Parameter to startExternalParse().
114 const
OT_PLAIN = 4;
# like extractSections() - portions of the original are returned unchanged.
133 const MARKER_SUFFIX =
"-QINU`\"'\x7f";
136 # Markers used for wrapping the table of contents
154 # Initialised by initialiseVariables()
165 # Initialised in constructor
168 # Initialized in getPreprocessor()
172 # Cleared with clearState():
203 # These are variables reset at least once per parse regardless of $clearState
216 public $mRevisionObject;
# The revision object of the specified revision ID
249 public $mInParse =
false;
263 $this->mConf = $conf;
265 $this->mExtLinkBracketedRegex =
'/\[(((?i)' . $this->mUrlProtocols .
')' .
266 self::EXT_LINK_ADDR .
267 self::EXT_LINK_URL_CLASS .
'*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F]*?)\]/Su';
268 if ( isset( $conf[
'preprocessorClass'] ) ) {
269 $this->mPreprocessorClass = $conf[
'preprocessorClass'];
270 } elseif ( defined(
'HPHP_VERSION' ) ) {
271 # Preprocessor_Hash is much faster than Preprocessor_DOM under HipHop
272 $this->mPreprocessorClass =
'Preprocessor_Hash';
273 } elseif ( extension_loaded(
'domxml' ) ) {
274 # PECL extension that conflicts with the core DOM extension (bug 13770)
275 wfDebug(
"Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
276 $this->mPreprocessorClass =
'Preprocessor_Hash';
277 } elseif ( extension_loaded(
'dom' ) ) {
278 $this->mPreprocessorClass =
'Preprocessor_DOM';
280 $this->mPreprocessorClass =
'Preprocessor_Hash';
282 wfDebug( __CLASS__ .
": using preprocessor: {$this->mPreprocessorClass}\n" );
289 if ( isset( $this->mLinkHolders ) ) {
290 unset( $this->mLinkHolders );
293 unset( $this->
$name );
301 $this->mInParse =
false;
309 foreach ( [
'mStripState',
'mVarCache' ]
as $k ) {
324 if ( !$this->mFirstCall ) {
327 $this->mFirstCall =
false;
344 if ( $this->mFirstCall ) {
348 $this->mOptions->registerWatcher( [ $this->mOutput,
'recordOption' ] );
349 $this->mAutonumber = 0;
350 $this->mIncludeCount = [];
353 $this->mRevisionObject = $this->mRevisionTimestamp =
354 $this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize = null;
355 $this->mVarCache = [];
357 $this->mLangLinkLanguages = [];
358 $this->currentRevisionCache = null;
362 # Clear these on every parse, bug 4549
363 $this->mTplRedirCache = $this->mTplDomCache = [];
365 $this->mShowToc =
true;
366 $this->mForceTocPosition =
false;
367 $this->mIncludeSizes = [
371 $this->mPPNodeCount = 0;
372 $this->mGeneratedPPNodeCount = 0;
373 $this->mHighestExpansionDepth = 0;
374 $this->mDefaultSort =
false;
375 $this->mHeadings = [];
376 $this->mDoubleUnderscores = [];
377 $this->mExpensiveFunctionCount = 0;
380 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
381 $this->mPreprocessor = null;
405 $linestart =
true, $clearState =
true, $revid = null
417 $text = strtr( $text,
"\x7f",
"?" );
418 $magicScopeVariable = $this->
lock();
423 $this->currentRevisionCache = null;
424 $this->mInputSize = strlen( $text );
425 if ( $this->mOptions->getEnableLimitReport() ) {
426 $this->mOutput->resetParseStartTime();
434 if ( $revid !== null ) {
435 $this->mRevisionId = $revid;
436 $this->mRevisionObject = null;
437 $this->mRevisionTimestamp = null;
438 $this->mRevisionUser = null;
439 $this->mRevisionSize = null;
460 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] )
461 || isset( $this->mDoubleUnderscores[
'notitleconvert'] )
462 || $this->mOutput->getDisplayTitle() !==
false )
465 if ( $convruletitle ) {
466 $this->mOutput->setTitleText( $convruletitle );
469 $this->mOutput->setTitleText( $titleText );
473 # Done parsing! Compute runtime adaptive expiry if set
474 $this->mOutput->finalizeAdaptiveCacheExpiry();
476 # Warn if too many heavyweight parser functions were used
477 if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
479 $this->mExpensiveFunctionCount,
480 $this->mOptions->getExpensiveParserFunctionLimit()
484 # Information on include size limits, for the benefit of users who try to skirt them
485 if ( $this->mOptions->getEnableLimitReport() ) {
486 $max = $this->mOptions->getMaxIncludeSize();
488 $cpuTime = $this->mOutput->getTimeSinceStart(
'cpu' );
489 if ( $cpuTime !== null ) {
490 $this->mOutput->setLimitReportData(
'limitreport-cputime',
491 sprintf(
"%.3f", $cpuTime )
495 $wallTime = $this->mOutput->getTimeSinceStart(
'wall' );
496 $this->mOutput->setLimitReportData(
'limitreport-walltime',
497 sprintf(
"%.3f", $wallTime )
500 $this->mOutput->setLimitReportData(
'limitreport-ppvisitednodes',
501 [ $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() ]
503 $this->mOutput->setLimitReportData(
'limitreport-ppgeneratednodes',
504 [ $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() ]
506 $this->mOutput->setLimitReportData(
'limitreport-postexpandincludesize',
507 [ $this->mIncludeSizes[
'post-expand'], $max ]
509 $this->mOutput->setLimitReportData(
'limitreport-templateargumentsize',
510 [ $this->mIncludeSizes[
'arg'], $max ]
512 $this->mOutput->setLimitReportData(
'limitreport-expansiondepth',
513 [ $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() ]
515 $this->mOutput->setLimitReportData(
'limitreport-expensivefunctioncount',
516 [ $this->mExpensiveFunctionCount, $this->mOptions->getExpensiveParserFunctionLimit() ]
518 Hooks::run(
'ParserLimitReportPrepare', [ $this, $this->mOutput ] );
520 $limitReport =
"NewPP limit report\n";
521 if ( $wgShowHostnames ) {
522 $limitReport .=
'Parsed by ' .
wfHostname() .
"\n";
524 $limitReport .=
'Cached time: ' . $this->mOutput->getCacheTime() .
"\n";
525 $limitReport .=
'Cache expiry: ' . $this->mOutput->getCacheExpiry() .
"\n";
526 $limitReport .=
'Dynamic content: ' .
527 ( $this->mOutput->hasDynamicContent() ?
'true' :
'false' ) .
530 foreach ( $this->mOutput->getLimitReportData()
as $key =>
$value ) {
532 [ $key, &
$value, &$limitReport,
false,
false ]
534 $keyMsg =
wfMessage( $key )->inLanguage(
'en' )->useDatabase(
false );
535 $valueMsg =
wfMessage( [
"$key-value-text",
"$key-value" ] )
536 ->inLanguage(
'en' )->useDatabase(
false );
537 if ( !$valueMsg->exists() ) {
540 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
541 $valueMsg->params(
$value );
542 $limitReport .=
"{$keyMsg->text()}: {$valueMsg->text()}\n";
548 $limitReport = htmlspecialchars_decode( $limitReport );
549 Hooks::run(
'ParserLimitReport', [ $this, &$limitReport ] );
553 $limitReport = str_replace( [
'-',
'&' ], [
'‐',
'&' ], $limitReport );
554 $text .=
"\n<!-- \n$limitReport-->\n";
557 $dataByFunc = $this->mProfiler->getFunctionStats();
558 uasort( $dataByFunc,
function ( $a, $b ) {
559 return $a[
'real'] < $b[
'real'];
561 $profileReport =
"Transclusion expansion time report (%,ms,calls,template)\n";
562 foreach ( array_slice( $dataByFunc, 0, 10 )
as $item ) {
563 $profileReport .= sprintf(
"%6.2f%% %8.3f %6d - %s\n",
564 $item[
'%real'], $item[
'real'], $item[
'calls'],
565 htmlspecialchars( $item[
'name'] ) );
567 $text .=
"\n<!-- \n$profileReport-->\n";
569 if ( $this->mGeneratedPPNodeCount > $this->mOptions->getMaxGeneratedPPNodeCount() / 10 ) {
570 wfDebugLog(
'generated-pp-node-count', $this->mGeneratedPPNodeCount .
' ' .
571 $this->mTitle->getPrefixedDBkey() );
574 $this->mOutput->setText( $text );
576 $this->mRevisionId = $oldRevisionId;
577 $this->mRevisionObject = $oldRevisionObject;
578 $this->mRevisionTimestamp = $oldRevisionTimestamp;
579 $this->mRevisionUser = $oldRevisionUser;
580 $this->mRevisionSize = $oldRevisionSize;
581 $this->mInputSize =
false;
582 $this->currentRevisionCache = null;
655 $magicScopeVariable = $this->
lock();
657 if ( $revid !== null ) {
658 $this->mRevisionId = $revid;
665 $text = $this->mStripState->unstripBoth( $text );
680 $text = $this->mStripState->unstripBoth( $text );
699 $text = $msg->params(
$params )->plain();
701 # Parser (re)initialisation
702 $magicScopeVariable = $this->
lock();
708 $text = $this->mStripState->unstripBoth( $text );
730 $this->mUser =
$user;
741 return self::MARKER_PREFIX;
754 if (
$t->hasFragment() ) {
755 # Strip the fragment to avoid various odd effects
756 $this->mTitle =
$t->createFragmentTarget(
'' );
777 public function Title( $x = null ) {
778 return wfSetVar( $this->mTitle, $x );
787 $this->mOutputType =
$ot;
804 return wfSetVar( $this->mOutputType, $x );
832 return wfSetVar( $this->mOptions, $x );
839 return $this->mLinkID++;
846 $this->mLinkID = $id;
867 $target = $this->mOptions->getTargetLanguage();
869 if ( $target !== null ) {
871 } elseif ( $this->mOptions->getInterfaceMessage() ) {
872 return $this->mOptions->getUserLangObj();
873 } elseif ( is_null( $this->mTitle ) ) {
874 throw new MWException( __METHOD__ .
': $this->mTitle is null' );
877 return $this->mTitle->getPageLanguage();
895 if ( !is_null( $this->mUser ) ) {
898 return $this->mOptions->getUser();
907 if ( !isset( $this->mPreprocessor ) ) {
908 $class = $this->mPreprocessorClass;
909 $this->mPreprocessor =
new $class( $this );
921 if ( !$this->mLinkRenderer ) {
922 $this->mLinkRenderer = MediaWikiServices::getInstance()
923 ->getLinkRendererFactory()->create();
924 $this->mLinkRenderer->setStubThreshold(
954 if ( $uniq_prefix !== null ) {
955 wfDeprecated( __METHOD__ .
' called with $prefix argument',
'1.26' );
961 $taglist = implode(
'|', $elements );
962 $start =
"/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" .
">)|<(!--)/i";
964 while ( $text !=
'' ) {
965 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
967 if ( count( $p ) < 5 ) {
970 if ( count( $p ) > 5 ) {
984 $marker = self::MARKER_PREFIX .
"-$element-" . sprintf(
'%08X', $n++ ) . self::MARKER_SUFFIX;
985 $stripped .= $marker;
987 if ( $close ===
'/>' ) {
988 # Empty element tag, <tag />
993 if ( $element ===
'!--' ) {
996 $end =
"/(<\\/$element\\s*>)/i";
998 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
1000 if ( count( $q ) < 3 ) {
1001 # No end tag -- let it run out to the end of the text.
1013 "<$element$attributes$close$content$tail" ];
1037 $marker = self::MARKER_PREFIX .
"-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
1038 $this->mMarkerIndex++;
1039 $this->mStripState->addGeneral( $marker, $text );
1054 $td_history = []; # Is currently a td tag
open?
1055 $last_tag_history = []; # Save
history of last lag activated (td, th
or caption)
1056 $tr_history = []; # Is currently a tr tag
open?
1057 $tr_attributes = []; #
history of tr attributes
1058 $has_opened_tr = []; # Did
this table open a <tr> element?
1059 $indent_level = 0; # indent level
of the table
1062 $line = trim( $outLine );
1064 if (
$line ===
'' ) { # empty
line, go to next line
1065 $out .= $outLine .
"\n";
1069 $first_character =
$line[0];
1070 $first_two = substr(
$line, 0, 2 );
1073 if ( preg_match(
'/^(:*)\s*\{\|(.*)$/',
$line,
$matches ) ) {
1074 # First check if we are starting a new table
1075 $indent_level = strlen(
$matches[1] );
1077 $attributes = $this->mStripState->unstripBoth(
$matches[2] );
1080 $outLine = str_repeat(
'<dl><dd>', $indent_level ) .
"<table{$attributes}>";
1081 array_push( $td_history,
false );
1082 array_push( $last_tag_history,
'' );
1083 array_push( $tr_history,
false );
1084 array_push( $tr_attributes,
'' );
1085 array_push( $has_opened_tr,
false );
1086 } elseif ( count( $td_history ) == 0 ) {
1087 # Don't do any of the following
1088 $out .= $outLine .
"\n";
1090 } elseif ( $first_two ===
'|}' ) {
1091 # We are ending a table
1093 $last_tag = array_pop( $last_tag_history );
1095 if ( !array_pop( $has_opened_tr ) ) {
1096 $line =
"<tr><td></td></tr>{$line}";
1099 if ( array_pop( $tr_history ) ) {
1100 $line =
"</tr>{$line}";
1103 if ( array_pop( $td_history ) ) {
1104 $line =
"</{$last_tag}>{$line}";
1106 array_pop( $tr_attributes );
1107 $outLine =
$line . str_repeat(
'</dd></dl>', $indent_level );
1108 } elseif ( $first_two ===
'|-' ) {
1109 # Now we have a table row
1110 $line = preg_replace(
'#^\|-+#',
'',
$line );
1112 # Whats after the tag is now only attributes
1113 $attributes = $this->mStripState->unstripBoth(
$line );
1115 array_pop( $tr_attributes );
1116 array_push( $tr_attributes, $attributes );
1119 $last_tag = array_pop( $last_tag_history );
1120 array_pop( $has_opened_tr );
1121 array_push( $has_opened_tr,
true );
1123 if ( array_pop( $tr_history ) ) {
1127 if ( array_pop( $td_history ) ) {
1128 $line =
"</{$last_tag}>{$line}";
1132 array_push( $tr_history,
false );
1133 array_push( $td_history,
false );
1134 array_push( $last_tag_history,
'' );
1135 } elseif ( $first_character ===
'|'
1136 || $first_character ===
'!'
1137 || $first_two ===
'|+'
1139 # This might be cell elements, td, th or captions
1140 if ( $first_two ===
'|+' ) {
1141 $first_character =
'+';
1148 if ( $first_character ===
'!' ) {
1152 # Split up multiple cells on the same line.
1153 # FIXME : This can result in improper nesting of tags processed
1154 # by earlier parser steps.
1155 $cells = explode(
'||',
$line );
1159 # Loop through each table cell
1160 foreach ( $cells
as $cell ) {
1162 if ( $first_character !==
'+' ) {
1163 $tr_after = array_pop( $tr_attributes );
1164 if ( !array_pop( $tr_history ) ) {
1165 $previous =
"<tr{$tr_after}>\n";
1167 array_push( $tr_history,
true );
1168 array_push( $tr_attributes,
'' );
1169 array_pop( $has_opened_tr );
1170 array_push( $has_opened_tr,
true );
1173 $last_tag = array_pop( $last_tag_history );
1175 if ( array_pop( $td_history ) ) {
1176 $previous =
"</{$last_tag}>\n{$previous}";
1179 if ( $first_character ===
'|' ) {
1181 } elseif ( $first_character ===
'!' ) {
1183 } elseif ( $first_character ===
'+' ) {
1184 $last_tag =
'caption';
1189 array_push( $last_tag_history, $last_tag );
1191 # A cell could contain both parameters and data
1192 $cell_data = explode(
'|', $cell, 2 );
1194 # Bug 553: Note that a '|' inside an invalid link should not
1195 # be mistaken as delimiting cell parameters
1196 if ( strpos( $cell_data[0],
'[[' ) !==
false ) {
1197 $cell =
"{$previous}<{$last_tag}>{$cell}";
1198 } elseif ( count( $cell_data ) == 1 ) {
1199 $cell =
"{$previous}<{$last_tag}>{$cell_data[0]}";
1201 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
1203 $cell =
"{$previous}<{$last_tag}{$attributes}>{$cell_data[1]}";
1207 array_push( $td_history,
true );
1210 $out .= $outLine .
"\n";
1213 # Closing open td, tr && table
1214 while ( count( $td_history ) > 0 ) {
1215 if ( array_pop( $td_history ) ) {
1218 if ( array_pop( $tr_history ) ) {
1221 if ( !array_pop( $has_opened_tr ) ) {
1222 $out .=
"<tr><td></td></tr>\n";
1225 $out .=
"</table>\n";
1228 # Remove trailing line-ending (b/c)
1229 if ( substr(
$out, -1 ) ===
"\n" ) {
1233 # special case: don't return empty table
1234 if (
$out ===
"<table>\n<tr><td></td></tr>\n</table>" ) {
1260 # Hook to suspend the parser in this state
1261 if ( !
Hooks::run(
'ParserBeforeInternalParse', [ &
$parser, &$text, &$this->mStripState ] ) ) {
1265 # if $frame is provided, then use $frame for replacing any variables
1267 # use frame depth to infer how include/noinclude tags should be handled
1268 # depth=0 means this is the top-level document; otherwise it's an included document
1269 if ( !$frame->depth ) {
1275 $text = $frame->expand( $dom );
1277 # if $frame is not provided, then use old-style replaceVariables
1281 Hooks::run(
'InternalParseBeforeSanitize', [ &
$parser, &$text, &$this->mStripState ] );
1284 [ $this,
'attributeStripCallback' ],
1286 array_keys( $this->mTransparentTagHooks ),
1288 [ $this,
'addTrackingCategory' ]
1290 Hooks::run(
'InternalParseBeforeLinks', [ &
$parser, &$text, &$this->mStripState ] );
1292 # Tables need to come after variable replacement for things to work
1293 # properly; putting them before other transformations should keep
1294 # exciting things like link expansions from showing up in surprising
1298 $text = preg_replace(
'/(^|\n)-----*/',
'\\1<hr />', $text );
1307 # replaceInternalLinks may sometimes leave behind
1308 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1309 $text = str_replace( self::MARKER_PREFIX .
'NOPARSE',
'', $text );
1327 $text = $this->mStripState->unstripGeneral( $text );
1336 # Clean up special characters, only run once, next-to-last before doBlockLevels
1338 # french spaces, last one Guillemet-left
1339 # only if there is something before the space
1340 '/(.) (?=\\?|:|;|!|%|\\302\\273)/' =>
'\\1 ',
1341 # french spaces, Guillemet-right
1342 '/(\\302\\253) /' =>
'\\1 ',
1343 '/ (!\s*important)/' =>
' \\1', # Beware
of CSS magic word !important, bug #11874.
1345 $text = preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
1358 if ( !( $this->mOptions->getDisableContentConversion()
1359 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] ) )
1361 if ( !$this->mOptions->getInterfaceMessage() ) {
1362 # The position of the convert() call should not be changed. it
1363 # assumes that the links are all replaced and the only thing left
1364 # is the <nowiki> mark.
1369 $text = $this->mStripState->unstripNoWiki( $text );
1376 $text = $this->mStripState->unstripGeneral( $text );
1381 if ( $this->mOptions->getTidy() ) {
1385 # attempt to sanitize at least some nesting problems
1386 # (bug #2702 and quite a few others)
1388 # ''Something [http://www.cool.com cool''] -->
1389 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
1390 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
1391 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
1392 # fix up an anchor inside another anchor, only
1393 # at least for a single single nested link (bug 3695)
1394 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
1395 '\\1\\2</a>\\3</a>\\1\\4</a>',
1396 # fix div inside inline elements- doBlockLevels won't wrap a line which
1397 # contains a div, so fix it up here; replace
1398 # div with escaped text
1399 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
1400 '\\1\\3<div\\5>\\6</div>\\8\\9',
1401 # remove empty italic or bold tag pairs, some
1402 # introduced by rules above
1403 '/<([bi])><\/\\1>/' =>
'',
1406 $text = preg_replace(
1407 array_keys( $tidyregs ),
1408 array_values( $tidyregs ),
1432 $urlChar = self::EXT_LINK_URL_CLASS;
1433 $addr = self::EXT_LINK_ADDR;
1434 $space = self::SPACE_NOT_NL; # non-newline space
1435 $spdash =
"(?:-|$space)"; # a dash
or a non-newline space
1436 $spaces =
"$space++"; # possessive match
of 1
or more spaces
1437 $text = preg_replace_callback(
1439 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1440 (<.*?>) | # m[2]: Skip stuff inside
1441 # HTML elements' .
"
1442 (\b(?i:$prots)($addr$urlChar*)) | # m[3]: Free external links
1443 # m[4]: Post-protocol path
1444 \b(?:RFC|PMID) $spaces # m[5]: RFC or PMID, capture number
1446 \bISBN $spaces ( # m[6]: ISBN, capture number
1447 (?: 97[89] $spdash? )? # optional 13-digit ISBN prefix
1448 (?: [0-9] $spdash? ){9} # 9 digits with opt. delimiters
1449 [0-9Xx] # check digit
1451 )!xu", [ $this,
'magicLinkCallback' ], $text );
1461 if ( isset( $m[1] ) && $m[1] !==
'' ) {
1464 } elseif ( isset( $m[2] ) && $m[2] !==
'' ) {
1467 } elseif ( isset( $m[3] ) && $m[3] !==
'' ) {
1468 # Free external link
1470 } elseif ( isset( $m[5] ) && $m[5] !==
'' ) {
1472 if ( substr( $m[0], 0, 3 ) ===
'RFC' ) {
1473 if ( !$this->mOptions->getMagicRFCLinks() ) {
1478 $cssClass =
'mw-magiclink-rfc';
1479 $trackingCat =
'magiclink-tracking-rfc';
1481 } elseif ( substr( $m[0], 0, 4 ) ===
'PMID' ) {
1482 if ( !$this->mOptions->getMagicPMIDLinks() ) {
1486 $urlmsg =
'pubmedurl';
1487 $cssClass =
'mw-magiclink-pmid';
1488 $trackingCat =
'magiclink-tracking-pmid';
1491 throw new MWException( __METHOD__ .
': unrecognised match type "' .
1492 substr( $m[0], 0, 20 ) .
'"' );
1494 $url =
wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1497 } elseif ( isset( $m[6] ) && $m[6] !==
''
1498 && $this->mOptions->getMagicISBNLinks()
1502 $space = self::SPACE_NOT_NL; # non-newline space
1503 $isbn = preg_replace(
"/$space/",
' ', $isbn );
1504 $num = strtr( $isbn, [
1514 'class' =>
'internal mw-magiclink-isbn',
1535 # The characters '<' and '>' (which were escaped by
1536 # removeHTMLtags()) should not be included in
1537 # URLs, per RFC 2396.
1538 # Make terminate a URL as well (bug T84937)
1541 '/&(lt|gt|nbsp|#x0*(3[CcEe]|[Aa]0)|#0*(60|62|160));/',
1546 $trail = substr( $url, $m2[0][1] ) . $trail;
1547 $url = substr( $url, 0, $m2[0][1] );
1550 # Move trailing punctuation to $trail
1552 # If there is no left bracket, then consider right brackets fair game too
1553 if ( strpos( $url,
'(' ) ===
false ) {
1557 $urlRev = strrev( $url );
1558 $numSepChars = strspn( $urlRev, $sep );
1559 # Don't break a trailing HTML entity by moving the ; into $trail
1560 # This is in hot code, so use substr_compare to avoid having to
1561 # create a new string object for the comparison
1562 if ( $numSepChars && substr_compare( $url,
";", -$numSepChars, 1 ) === 0 ) {
1563 # more optimization: instead of running preg_match with a $
1564 # anchor, which can be slow, do the match on the reversed
1565 # string starting at the desired offset.
1566 # un-reversed regexp is: /&([a-z]+|#x[\da-f]+|#\d+)$/i
1567 if ( preg_match(
'/\G([a-z]+|[\da-f]+x#|\d+#)&/i', $urlRev, $m2, 0, $numSepChars ) ) {
1571 if ( $numSepChars ) {
1572 $trail = substr( $url, -$numSepChars ) . $trail;
1573 $url = substr( $url, 0, -$numSepChars );
1576 # Verify that we still have a real URL after trail removal, and
1577 # not just lone protocol
1578 if ( strlen( $trail ) >= $numPostProto ) {
1579 return $url . $trail;
1584 # Is this an external image?
1586 if ( $text ===
false ) {
1587 # Not an image, make a link
1592 # Register it in the output object...
1593 $this->mOutput->addExternalLink( $url );
1595 return $text . $trail;
1608 for ( $i = 6; $i >= 1; --$i ) {
1609 $h = str_repeat(
'=', $i );
1610 $text = preg_replace(
"/^$h(.+)$h\\s*$/m",
"<h$i>\\1</h$i>", $text );
1627 $outtext .= $this->
doQuotes( $line ) .
"\n";
1629 $outtext = substr( $outtext, 0, -1 );
1641 $arr = preg_split(
"/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1642 $countarr = count( $arr );
1643 if ( $countarr == 1 ) {
1652 for ( $i = 1; $i < $countarr; $i += 2 ) {
1653 $thislen = strlen( $arr[$i] );
1657 if ( $thislen == 4 ) {
1658 $arr[$i - 1] .=
"'";
1661 } elseif ( $thislen > 5 ) {
1665 $arr[$i - 1] .= str_repeat(
"'", $thislen - 5 );
1670 if ( $thislen == 2 ) {
1672 } elseif ( $thislen == 3 ) {
1674 } elseif ( $thislen == 5 ) {
1684 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
1685 $firstsingleletterword = -1;
1686 $firstmultiletterword = -1;
1688 for ( $i = 1; $i < $countarr; $i += 2 ) {
1689 if ( strlen( $arr[$i] ) == 3 ) {
1690 $x1 = substr( $arr[$i - 1], -1 );
1691 $x2 = substr( $arr[$i - 1], -2, 1 );
1692 if ( $x1 ===
' ' ) {
1693 if ( $firstspace == -1 ) {
1696 } elseif ( $x2 ===
' ' ) {
1697 $firstsingleletterword = $i;
1702 if ( $firstmultiletterword == -1 ) {
1703 $firstmultiletterword = $i;
1710 if ( $firstsingleletterword > -1 ) {
1711 $arr[$firstsingleletterword] =
"''";
1712 $arr[$firstsingleletterword - 1] .=
"'";
1713 } elseif ( $firstmultiletterword > -1 ) {
1715 $arr[$firstmultiletterword] =
"''";
1716 $arr[$firstmultiletterword - 1] .=
"'";
1717 } elseif ( $firstspace > -1 ) {
1721 $arr[$firstspace] =
"''";
1722 $arr[$firstspace - 1] .=
"'";
1731 foreach ( $arr
as $r ) {
1732 if ( ( $i % 2 ) == 0 ) {
1733 if ( $state ===
'both' ) {
1739 $thislen = strlen( $r );
1740 if ( $thislen == 2 ) {
1741 if ( $state ===
'i' ) {
1744 } elseif ( $state ===
'bi' ) {
1747 } elseif ( $state ===
'ib' ) {
1750 } elseif ( $state ===
'both' ) {
1757 } elseif ( $thislen == 3 ) {
1758 if ( $state ===
'b' ) {
1761 } elseif ( $state ===
'bi' ) {
1764 } elseif ( $state ===
'ib' ) {
1767 } elseif ( $state ===
'both' ) {
1774 } elseif ( $thislen == 5 ) {
1775 if ( $state ===
'b' ) {
1778 } elseif ( $state ===
'i' ) {
1781 } elseif ( $state ===
'bi' ) {
1784 } elseif ( $state ===
'ib' ) {
1787 } elseif ( $state ===
'both' ) {
1799 if ( $state ===
'b' || $state ===
'ib' ) {
1802 if ( $state ===
'i' || $state ===
'bi' || $state ===
'ib' ) {
1805 if ( $state ===
'bi' ) {
1809 if ( $state ===
'both' &&
$buffer ) {
1830 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1831 if ( $bits ===
false ) {
1832 throw new MWException(
"PCRE needs to be compiled with "
1833 .
"--enable-unicode-properties in order for MediaWiki to function" );
1835 $s = array_shift( $bits );
1838 while ( $i < count( $bits ) ) {
1841 $text = $bits[$i++];
1842 $trail = $bits[$i++];
1844 # The characters '<' and '>' (which were escaped by
1845 # removeHTMLtags()) should not be included in
1846 # URLs, per RFC 2396.
1848 if ( preg_match(
'/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1849 $text = substr( $url, $m2[0][1] ) .
' ' . $text;
1850 $url = substr( $url, 0, $m2[0][1] );
1853 # If the link text is an image URL, replace it with an <img> tag
1854 # This happened by accident in the original parser, but some people used it extensively
1856 if ( $img !==
false ) {
1862 # Set linktype for CSS - if URL==text, link is essentially free
1863 $linktype = ( $text === $url ) ?
'free' :
'text';
1865 # No link text, e.g. [http://domain.tld/some.link]
1866 if ( $text ==
'' ) {
1869 $text =
'[' . $langObj->formatNum( ++$this->mAutonumber ) .
']';
1870 $linktype =
'autonumber';
1872 # Have link text, e.g. [http://domain.tld/some.link text]s
1881 # Use the encoded URL
1882 # This means that users can paste URLs directly into the text
1883 # Funny characters like ö aren't valid in URLs anyway
1884 # This was changed in August 2004
1888 # Register link in the output object.
1889 $this->mOutput->addExternalLink( $url );
1905 global $wgNoFollowLinks, $wgNoFollowNsExceptions, $wgNoFollowDomainExceptions;
1907 if ( $wgNoFollowLinks && !in_array( $ns, $wgNoFollowNsExceptions )
1927 $rel = self::getExternalLinkRel( $url, $this->mTitle );
1929 $target = $this->mOptions->getExternalLinkTarget();
1932 if ( !in_array( $target, [
'_self',
'_parent',
'_top' ] ) ) {
1936 if ( $rel !==
'' ) {
1939 $rel .=
'noreferrer noopener';
1955 return self::normalizeLinkUrl( $url );
1968 # First, make sure unsafe characters are encoded
1969 $url = preg_replace_callback(
'/[\x00-\x20"<>\[\\\\\]^`{|}\x7F-\xFF]/',
1971 return rawurlencode( $m[0] );
1977 $end = strlen( $url );
1979 # Fragment part - 'fragment'
1980 $start = strpos( $url,
'#' );
1981 if ( $start !==
false && $start < $end ) {
1982 $ret = self::normalizeUrlComponent(
1983 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}' ) .
$ret;
1987 # Query part - 'query' minus &=+;
1988 $start = strpos( $url,
'?' );
1989 if ( $start !==
false && $start < $end ) {
1990 $ret = self::normalizeUrlComponent(
1991 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}&=+;' ) .
$ret;
1995 # Scheme and path part - 'pchar'
1996 # (we assume no userinfo or encoded colons in the host)
1997 $ret = self::normalizeUrlComponent(
1998 substr( $url, 0, $end ),
'"#%<>[\]^`{|}/?' ) .
$ret;
2004 $callback =
function (
$matches )
use ( $unsafe ) {
2006 $ord = ord( $char );
2007 if ( $ord > 32 && $ord < 127 && strpos( $unsafe, $char ) ===
false ) {
2011 # Leave it escaped, but use uppercase for a-f
2015 return preg_replace_callback(
'/%[0-9A-Fa-f]{2}/', $callback, $component );
2027 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
2028 $imagesexception = !empty( $imagesfrom );
2030 # $imagesfrom could be either a single string or an array of strings, parse out the latter
2031 if ( $imagesexception && is_array( $imagesfrom ) ) {
2032 $imagematch =
false;
2033 foreach ( $imagesfrom
as $match ) {
2034 if ( strpos( $url, $match ) === 0 ) {
2039 } elseif ( $imagesexception ) {
2040 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
2042 $imagematch =
false;
2045 if ( $this->mOptions->getAllowExternalImages()
2046 || ( $imagesexception && $imagematch )
2048 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
2053 if ( !$text && $this->mOptions->getEnableImageWhitelist()
2054 && preg_match( self::EXT_IMAGE_REGEX, $url )
2056 $whitelist = explode(
2058 wfMessage(
'external_image_whitelist' )->inContentLanguage()->
text()
2061 foreach ( $whitelist
as $entry ) {
2062 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
2063 if ( strpos( $entry,
'#' ) === 0 || $entry ===
'' ) {
2066 if ( preg_match(
'/' . str_replace(
'/',
'\\/', $entry ) .
'/i', $url ) ) {
2067 # Image matches a whitelist entry
2101 static $tc =
false, $e1, $e1_img;
2102 # the % is needed to support urlencoded titles as well
2105 # Match a link having the form [[namespace:link|alternate]]trail
2106 $e1 =
"/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
2107 # Match cases where there is no "]]", which might still be images
2108 $e1_img =
"/^([{$tc}]+)\\|(.*)\$/sD";
2113 # split the entire text string on occurrences of [[
2115 # get the first element (all text up to first [[), and remove the space we added
2118 $line = $a->current(); # Workaround
for broken ArrayIterator::next()
that returns
"void"
2119 $s = substr( $s, 1 );
2123 if ( $useLinkPrefixExtension ) {
2124 # Match the end of a line for a word that's not followed by whitespace,
2125 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
2127 $charset = $wgContLang->linkPrefixCharset();
2128 $e2 =
"/^((?>.*[^$charset]|))(.+)$/sDu";
2131 if ( is_null( $this->mTitle ) ) {
2132 throw new MWException( __METHOD__ .
": \$this->mTitle is null\n" );
2134 $nottalk = !$this->mTitle->isTalkPage();
2136 if ( $useLinkPrefixExtension ) {
2138 if ( preg_match( $e2, $s, $m ) ) {
2139 $first_prefix = $m[2];
2141 $first_prefix =
false;
2150 # Loop for each link
2151 for ( ;
$line !==
false &&
$line !== null; $a->next(),
$line = $a->current() ) {
2154 # Check for excessive memory usage
2155 if ( $holders->isBig() ) {
2157 # Do the existence check, replace the link holders and clear the array
2158 $holders->replace( $s );
2162 if ( $useLinkPrefixExtension ) {
2163 if ( preg_match( $e2, $s, $m ) ) {
2170 if ( $first_prefix ) {
2171 $prefix = $first_prefix;
2172 $first_prefix =
false;
2176 $might_be_img =
false;
2180 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
2181 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
2182 # the real problem is with the $e1 regex
2184 # Still some problems for cases where the ] is meant to be outside punctuation,
2185 # and no image is in sight. See bug 2095.
2187 && substr( $m[3], 0, 1 ) ===
']'
2188 && strpos( $text,
'[' ) !==
false
2191 $m[3] = substr( $m[3], 1 );
2193 # fix up urlencoded title texts
2194 if ( strpos( $m[1],
'%' ) !==
false ) {
2195 # Should anchors '#' also be rejected?
2196 $m[1] = str_replace( [
'<',
'>' ], [
'<',
'>' ], rawurldecode( $m[1] ) );
2199 } elseif ( preg_match( $e1_img,
$line, $m ) ) {
2200 # Invalid, but might be an image with a link in its caption
2201 $might_be_img =
true;
2203 if ( strpos( $m[1],
'%' ) !==
false ) {
2204 $m[1] = str_replace( [
'<',
'>' ], [
'<',
'>' ], rawurldecode( $m[1] ) );
2208 $s .= $prefix .
'[[' .
$line;
2214 # Don't allow internal links to pages containing
2215 # PROTO: where PROTO is a valid URL protocol; these
2216 # should be external links.
2217 if ( preg_match(
'/^(?i:' . $this->mUrlProtocols .
')/', $origLink ) ) {
2218 $s .= $prefix .
'[[' .
$line;
2222 # Make subpage if necessary
2223 if ( $useSubpages ) {
2229 $noforce = ( substr( $origLink, 0, 1 ) !==
':' );
2231 # Strip off leading ':'
2235 $unstrip = $this->mStripState->unstripNoWiki(
$link );
2237 if ( $nt === null ) {
2238 $s .= $prefix .
'[[' .
$line;
2242 $ns = $nt->getNamespace();
2243 $iw = $nt->getInterwiki();
2245 if ( $might_be_img ) { #
if this is actually an invalid
link
2246 if ( $ns ==
NS_FILE && $noforce ) { # but might be an image
2249 # look at the next 'line' to see if we can close it there
2251 $next_line = $a->current();
2252 if ( $next_line ===
false || $next_line === null ) {
2255 $m = explode(
']]', $next_line, 3 );
2256 if ( count( $m ) == 3 ) {
2257 # the first ]] closes the inner link, the second the image
2259 $text .=
"[[{$m[0]}]]{$m[1]}";
2262 } elseif ( count( $m ) == 2 ) {
2263 # if there's exactly one ]] that's fine, we'll keep looking
2264 $text .=
"[[{$m[0]}]]{$m[1]}";
2266 # if $next_line is invalid too, we need look no further
2267 $text .=
'[[' . $next_line;
2272 # we couldn't find the end of this imageLink, so output it raw
2273 # but don't ignore what might be perfectly normal links in the text we've examined
2275 $s .=
"{$prefix}[[$link|$text";
2276 # note: no $trail, because without an end, there *is* no trail
2279 }
else { #
it's not an image, so output it raw
2280 $s .= "{$prefix}[[$link|$text";
2281 # note: no $trail, because without an end, there *is* no trail
2286 $wasblank = ( $text == '' );
2290 # Bug 4598 madness. Handle the quotes only if they come from the alternate part
2291 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2292 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2293 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2294 $text = $this->doQuotes( $text );
2297 # Link not escaped by : , create the various objects
2298 if ( $noforce && !$nt->wasLocalInterwiki() ) {
2301 $iw && $this->mOptions->getInterwikiMagic() && $nottalk && (
2302 Language::fetchLanguageName( $iw, null, 'mw
' ) ||
2303 in_array( $iw, $wgExtraInterlanguageLinkPrefixes )
2306 # Bug 24502: filter duplicates
2307 if ( !isset( $this->mLangLinkLanguages[$iw] ) ) {
2308 $this->mLangLinkLanguages[$iw] = true;
2309 $this->mOutput->addLanguageLink( $nt->getFullText() );
2312 $s = rtrim( $s . $prefix );
2313 $s .= trim( $trail, "\n" ) == '' ? '': $prefix . $trail;
2317 if ( $ns == NS_FILE ) {
2318 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
2320 # if no parameters were passed, $text
2321 # becomes something like "File:Foo.png",
2322 # which we don't want to pass
on to
the
2326 # recursively parse links inside the image caption
2327 # actually, this will parse them in any other parameters, too,
2328 # but it might be hard to fix that, and it doesn't matter ATM
2332 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
2334 $this->
makeImage( $nt, $text, $holders ) ) . $trail;
2338 $s = rtrim( $s .
"\n" ); # bug 87
2346 $sortkey = str_replace(
"\n",
'', $sortkey );
2348 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
2353 $s .= trim( $prefix . $trail,
"\n" ) ==
'' ?
'' : $prefix . $trail;
2359 # Self-link checking. For some languages, variants of the title are checked in
2360 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2361 # for linking to a different variant.
2362 if ( $ns !=
NS_SPECIAL && $nt->equals( $this->mTitle ) && !$nt->hasFragment() ) {
2367 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2368 # @todo FIXME: Should do batch file existence checks, see comment below
2370 # Give extensions a chance to select the file revision for us
2374 [ $this, $nt, &
$options, &$descQuery ] );
2375 # Fetch and register the file (file title may be different via hooks)
2377 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
2383 # Some titles, such as valid special pages or files in foreign repos, should
2384 # be shown as bluelinks even though they're not included in the page table
2385 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2386 # batch file existence checks for NS_FILE and NS_MEDIA
2387 if ( $iw ==
'' && $nt->isAlwaysKnown() ) {
2388 $this->mOutput->addLink( $nt );
2391 # Links will be added to the output link list after checking
2392 $s .= $holders->makeHolder( $nt, $text, [], $trail, $prefix );
2414 if ( $text ==
'' ) {
2415 $text = htmlspecialchars( $nt->getPrefixedText() );
2418 $link = $this->getLinkRenderer()->makeKnownLink(
2419 $nt,
new HtmlArmor(
"$prefix$text$inside" )
2422 return $this->armorLinks(
$link ) . $trail;
2436 return preg_replace(
'/\b((?i)' . $this->mUrlProtocols .
')/',
2437 self::MARKER_PREFIX .
"NOPARSE$1", $text );
2445 # Some namespaces don't allow subpages
2488 if ( is_null( $this->mTitle ) ) {
2493 throw new MWException( __METHOD__ .
' Should only be '
2494 .
' called while parsing (no title set)' );
2504 if (
Hooks::run(
'ParserGetVariableValueVarCache', [ &
$parser, &$this->mVarCache ] ) ) {
2505 if ( isset( $this->mVarCache[$index] ) ) {
2506 return $this->mVarCache[$index];
2513 $pageLang = $this->getFunctionLang();
2519 case 'currentmonth':
2522 case 'currentmonth1':
2525 case 'currentmonthname':
2528 case 'currentmonthnamegen':
2531 case 'currentmonthabbrev':
2546 case 'localmonthname':
2549 case 'localmonthnamegen':
2552 case 'localmonthabbrev':
2567 case 'fullpagename':
2570 case 'fullpagenamee':
2576 case 'subpagenamee':
2579 case 'rootpagename':
2582 case 'rootpagenamee':
2586 $this->mTitle->getRootText()
2589 case 'basepagename':
2592 case 'basepagenamee':
2596 $this->mTitle->getBaseText()
2599 case 'talkpagename':
2600 if ( $this->mTitle->canTalk() ) {
2601 $talkPage = $this->mTitle->getTalkPage();
2607 case 'talkpagenamee':
2608 if ( $this->mTitle->canTalk() ) {
2609 $talkPage = $this->mTitle->getTalkPage();
2615 case 'subjectpagename':
2616 $subjPage = $this->mTitle->getSubjectPage();
2619 case 'subjectpagenamee':
2620 $subjPage = $this->mTitle->getSubjectPage();
2624 $pageid = $this->getTitle()->getArticleID();
2625 if ( $pageid == 0 ) {
2626 # 0 means the page doesn't exist in the database,
2627 # which means the user is previewing a new page.
2628 # The vary-revision flag must be set, because the magic word
2629 # will have a different value once the page is saved.
2630 $this->mOutput->setFlag(
'vary-revision' );
2631 wfDebug( __METHOD__ .
": {{PAGEID}} used in a new page, setting vary-revision...\n" );
2633 $value = $pageid ? $pageid : null;
2636 # Let the edit saving system know we should parse the page
2637 # *after* a revision ID has been assigned.
2638 $this->mOutput->setFlag(
'vary-revision-id' );
2639 wfDebug( __METHOD__ .
": {{REVISIONID}} used, setting vary-revision-id...\n" );
2640 $value = $this->mRevisionId;
2641 if ( !
$value && $this->mOptions->getSpeculativeRevIdCallback() ) {
2642 $value = call_user_func( $this->mOptions->getSpeculativeRevIdCallback() );
2643 $this->mOutput->setSpeculativeRevIdUsed(
$value );
2647 # Let the edit saving system know we should parse the page
2648 # *after* a revision ID has been assigned. This is for null edits.
2649 $this->mOutput->setFlag(
'vary-revision' );
2650 wfDebug( __METHOD__ .
": {{REVISIONDAY}} used, setting vary-revision...\n" );
2651 $value = intval( substr( $this->getRevisionTimestamp(), 6, 2 ) );
2653 case 'revisionday2':
2654 # Let the edit saving system know we should parse the page
2655 # *after* a revision ID has been assigned. This is for null edits.
2656 $this->mOutput->setFlag(
'vary-revision' );
2657 wfDebug( __METHOD__ .
": {{REVISIONDAY2}} used, setting vary-revision...\n" );
2658 $value = substr( $this->getRevisionTimestamp(), 6, 2 );
2660 case 'revisionmonth':
2661 # Let the edit saving system know we should parse the page
2662 # *after* a revision ID has been assigned. This is for null edits.
2663 $this->mOutput->setFlag(
'vary-revision' );
2664 wfDebug( __METHOD__ .
": {{REVISIONMONTH}} used, setting vary-revision...\n" );
2665 $value = substr( $this->getRevisionTimestamp(), 4, 2 );
2667 case 'revisionmonth1':
2668 # Let the edit saving system know we should parse the page
2669 # *after* a revision ID has been assigned. This is for null edits.
2670 $this->mOutput->setFlag(
'vary-revision' );
2671 wfDebug( __METHOD__ .
": {{REVISIONMONTH1}} used, setting vary-revision...\n" );
2672 $value = intval( substr( $this->getRevisionTimestamp(), 4, 2 ) );
2674 case 'revisionyear':
2675 # Let the edit saving system know we should parse the page
2676 # *after* a revision ID has been assigned. This is for null edits.
2677 $this->mOutput->setFlag(
'vary-revision' );
2678 wfDebug( __METHOD__ .
": {{REVISIONYEAR}} used, setting vary-revision...\n" );
2679 $value = substr( $this->getRevisionTimestamp(), 0, 4 );
2681 case 'revisiontimestamp':
2682 # Let the edit saving system know we should parse the page
2683 # *after* a revision ID has been assigned. This is for null edits.
2684 $this->mOutput->setFlag(
'vary-revision' );
2685 wfDebug( __METHOD__ .
": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2686 $value = $this->getRevisionTimestamp();
2688 case 'revisionuser':
2689 # Let the edit saving system know we should parse the page
2690 # *after* a revision ID has been assigned for null edits.
2691 $this->mOutput->setFlag(
'vary-user' );
2692 wfDebug( __METHOD__ .
": {{REVISIONUSER}} used, setting vary-user...\n" );
2693 $value = $this->getRevisionUser();
2695 case 'revisionsize':
2696 $value = $this->getRevisionSize();
2699 $value = str_replace(
'_',
' ', $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2702 $value =
wfUrlencode( $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2704 case 'namespacenumber':
2705 $value = $this->mTitle->getNamespace();
2708 $value = $this->mTitle->canTalk()
2709 ? str_replace(
'_',
' ', $this->mTitle->getTalkNsText() )
2713 $value = $this->mTitle->canTalk() ?
wfUrlencode( $this->mTitle->getTalkNsText() ) :
'';
2715 case 'subjectspace':
2716 $value = str_replace(
'_',
' ', $this->mTitle->getSubjectNsText() );
2718 case 'subjectspacee':
2721 case 'currentdayname':
2734 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2735 # int to remove the padding
2741 case 'localdayname':
2742 $value = $pageLang->getWeekdayName(
2750 $value = $pageLang->time(
2760 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2761 # int to remove the padding
2767 case 'numberofarticles':
2770 case 'numberoffiles':
2773 case 'numberofusers':
2776 case 'numberofactiveusers':
2779 case 'numberofpages':
2782 case 'numberofadmins':
2785 case 'numberofedits':
2788 case 'currenttimestamp':
2791 case 'localtimestamp':
2794 case 'currentversion':
2809 case 'directionmark':
2810 return $pageLang->getDirMark();
2811 case 'contentlanguage':
2814 case 'cascadingsources':
2820 'ParserGetVariableValueSwitch',
2821 [ &
$parser, &$this->mVarCache, &$index, &
$ret, &$frame ]
2828 $this->mVarCache[$index] =
$value;
2870 $dom = $this->getPreprocessor()->preprocessToObj( $text,
$flags );
2882 $ltrimmed = ltrim(
$s );
2883 $w1 = substr(
$s, 0, strlen(
$s ) - strlen( $ltrimmed ) );
2884 $trimmed = rtrim( $ltrimmed );
2885 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
2887 $w2 = substr( $ltrimmed, -$diff );
2891 return [ $w1, $trimmed, $w2 ];
2915 # Is there any text? Also, Prevent too big inclusions!
2916 $textSize = strlen( $text );
2917 if ( $textSize < 1 || $textSize > $this->mOptions->getMaxIncludeSize() ) {
2921 if ( $frame ===
false ) {
2922 $frame = $this->getPreprocessor()->newFrame();
2923 } elseif ( !( $frame instanceof
PPFrame ) ) {
2924 wfDebug( __METHOD__ .
" called using plain parameters instead of "
2925 .
"a PPFrame instance. Creating custom frame.\n" );
2926 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
2929 $dom = $this->preprocessToDom( $text );
2931 $text = $frame->expand( $dom,
$flags );
2947 $eqpos = strpos( $arg,
'=' );
2948 if ( $eqpos ===
false ) {
2949 $assocArgs[$index++] = $arg;
2951 $name = trim( substr( $arg, 0, $eqpos ) );
2952 $value = trim( substr( $arg, $eqpos + 1 ) );
2953 if (
$value ===
false ) {
2956 if (
$name !==
false ) {
2992 # does no harm if $current and $max are present but are unnecessary for the message
2993 # Not doing ->inLanguage( $this->mOptions->getUserLangObj() ), since this is shown
2994 # only during preview, and that would split the parser cache unnecessarily.
2995 $warning =
wfMessage(
"$limitationType-warning" )->numParams( $current, $max )
2997 $this->mOutput->addWarning( $warning );
2998 $this->addTrackingCategory(
"$limitationType-category" );
3024 $forceRawInterwiki =
false;
3026 $isChildObj =
false;
3028 $isLocalObj =
false;
3030 # Title object, where $text came from
3033 # $part1 is the bit before the first |, and must contain only title characters.
3034 # Various prefixes will be stripped from it later.
3035 $titleWithSpaces = $frame->expand( $piece[
'title'] );
3036 $part1 = trim( $titleWithSpaces );
3039 # Original title text preserved for various purposes
3040 $originalTitle = $part1;
3042 # $args is a list of argument nodes, starting from index 0, not including $part1
3043 # @todo FIXME: If piece['parts'] is null then the call to getLength()
3044 # below won't work b/c this $args isn't an object
3045 $args = ( null == $piece[
'parts'] ) ? [] : $piece[
'parts'];
3047 $profileSection = null;
3051 $substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
3053 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3054 # Decide whether to expand template or keep wikitext as-is.
3055 if ( $this->ot[
'wiki'] ) {
3056 if ( $substMatch ===
false ) {
3057 $literal =
true; # literal when
in PST with no prefix
3059 $literal =
false; # expand when
in PST with subst:
or safesubst:
3062 if ( $substMatch ==
'subst' ) {
3063 $literal =
true; # literal when
not in PST with
plain subst:
3065 $literal =
false; # expand when
not in PST with safesubst:
or no prefix
3069 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3076 if ( !$found &&
$args->getLength() == 0 ) {
3077 $id = $this->mVariables->matchStartToEnd( $part1 );
3078 if ( $id !==
false ) {
3079 $text = $this->getVariableValue( $id, $frame );
3087 # MSG, MSGNW and RAW
3091 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3094 # Remove obsolete MSG:
3096 $mwMsg->matchStartAndRemove( $part1 );
3101 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3102 $forceRawInterwiki =
true;
3108 $colonPos = strpos( $part1,
':' );
3109 if ( $colonPos !==
false ) {
3110 $func = substr( $part1, 0, $colonPos );
3111 $funcArgs = [ trim( substr( $part1, $colonPos + 1 ) ) ];
3112 $argsLength =
$args->getLength();
3113 for ( $i = 0; $i < $argsLength; $i++ ) {
3114 $funcArgs[] =
$args->item( $i );
3117 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3122 # The interface for parser functions allows for extracting
3123 # flags into the local scope. Extract any forwarded flags
3129 # Finish mangling title and then check for loops.
3130 # Set $title to a Title object and $titleText to the PDBK
3133 # Split the title into page and subpage
3135 $relative = $this->maybeDoSubpageLink( $part1, $subpage );
3136 if ( $part1 !== $relative ) {
3138 $ns = $this->mTitle->getNamespace();
3142 $titleText =
$title->getPrefixedText();
3143 # Check for language variants if the template is not found
3144 if ( $this->getConverterLanguage()->hasVariants() &&
$title->getArticleID() == 0 ) {
3145 $this->getConverterLanguage()->findVariantLink( $part1,
$title,
true );
3147 # Do recursion depth check
3148 $limit = $this->mOptions->getMaxTemplateDepth();
3149 if ( $frame->depth >=
$limit ) {
3151 $text =
'<span class="error">'
3152 .
wfMessage(
'parser-template-recursion-depth-warning' )
3153 ->numParams(
$limit )->inContentLanguage()->text()
3159 # Load from database
3160 if ( !$found &&
$title ) {
3161 $profileSection = $this->mProfiler->scopedProfileIn(
$title->getPrefixedDBkey() );
3162 if ( !
$title->isExternal() ) {
3163 if (
$title->isSpecialPage()
3164 && $this->mOptions->getAllowSpecialInclusion()
3165 && $this->ot[
'html']
3172 $argsLength =
$args->getLength();
3173 for ( $i = 0; $i < $argsLength; $i++ ) {
3174 $bits =
$args->item( $i )->splitArg();
3175 if ( strval( $bits[
'index'] ) ===
'' ) {
3177 $value = trim( $frame->expand( $bits[
'value'] ) );
3186 if ( $specialPage && $specialPage->maxIncludeCacheTime() === 0 ) {
3187 $context->setUser( $this->getUser() );
3192 $context->setLanguage( $this->mOptions->getUserLangObj() );
3196 $text =
$context->getOutput()->getHTML();
3197 $this->mOutput->addOutputPageMetadata(
$context->getOutput() );
3200 if ( $specialPage && $specialPage->maxIncludeCacheTime() !==
false ) {
3201 $this->mOutput->updateRuntimeAdaptiveExpiry(
3202 $specialPage->maxIncludeCacheTime()
3207 $found =
false; # access denied
3208 wfDebug( __METHOD__ .
": template inclusion denied for " .
3209 $title->getPrefixedDBkey() .
"\n" );
3212 if ( $text !==
false ) {
3218 # If the title is valid but undisplayable, make a link to it
3219 if ( !$found && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3220 $text =
"[[:$titleText]]";
3223 } elseif (
$title->isTrans() ) {
3224 # Interwiki transclusion
3225 if ( $this->ot[
'html'] && !$forceRawInterwiki ) {
3226 $text = $this->interwikiTransclude(
$title,
'render' );
3229 $text = $this->interwikiTransclude(
$title,
'raw' );
3230 # Preprocess it like a template
3231 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3237 # Do infinite loop check
3238 # This has to be done after redirect resolution to avoid infinite loops via redirects
3239 if ( !$frame->loopCheck(
$title ) ) {
3241 $text =
'<span class="error">'
3242 .
wfMessage(
'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3244 wfDebug( __METHOD__ .
": template loop broken at '$titleText'\n" );
3248 # If we haven't found text to substitute by now, we're done
3249 # Recover the source wikitext and return it
3251 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3252 if ( $profileSection ) {
3253 $this->mProfiler->scopedProfileOut( $profileSection );
3255 return [
'object' => $text ];
3258 # Expand DOM-style return values in a child frame
3259 if ( $isChildObj ) {
3260 # Clean up argument array
3265 } elseif ( $titleText !==
false && $newFrame->isEmpty() ) {
3266 # Expansion is eligible for the empty-frame cache
3267 $text = $newFrame->cachedExpand( $titleText, $text );
3269 # Uncached expansion
3270 $text = $newFrame->expand( $text );
3273 if ( $isLocalObj && $nowiki ) {
3275 $isLocalObj =
false;
3278 if ( $profileSection ) {
3279 $this->mProfiler->scopedProfileOut( $profileSection );
3282 # Replace raw HTML by a placeholder
3284 $text = $this->insertStripItem( $text );
3285 } elseif ( $nowiki && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3286 # Escape nowiki-style return values
3288 } elseif ( is_string( $text )
3289 && !$piece[
'lineStart']
3290 && preg_match(
'/^(?:{\\||:|;|#|\*)/', $text )
3292 # Bug 529: if the template begins with a table or block-level
3293 # element, it should be treated as beginning a new line.
3294 # This behavior is somewhat controversial.
3295 $text =
"\n" . $text;
3298 if ( is_string( $text ) && !$this->incrementIncludeSize(
'post-expand', strlen( $text ) ) ) {
3299 # Error, oversize inclusion
3300 if ( $titleText !==
false ) {
3301 # Make a working, properly escaped link if possible (bug 23588)
3302 $text =
"[[:$titleText]]";
3304 # This will probably not be a working link, but at least it may
3305 # provide some hint of where the problem is
3306 preg_replace(
'/^:/',
'', $originalTitle );
3307 $text =
"[[:$originalTitle]]";
3309 $text .= $this->insertStripItem(
'<!-- WARNING: template omitted, '
3310 .
'post-expand include size too large -->' );
3311 $this->limitationWarn(
'post-expand-template-inclusion' );
3314 if ( $isLocalObj ) {
3315 $ret = [
'object' => $text ];
3317 $ret = [
'text' => $text ];
3345 # Case sensitive functions
3346 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
3347 $function = $this->mFunctionSynonyms[1][$function];
3349 # Case insensitive functions
3350 $function = $wgContLang->lc( $function );
3351 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
3352 $function = $this->mFunctionSynonyms[0][$function];
3354 return [
'found' =>
false ];
3358 list( $callback,
$flags ) = $this->mFunctionHooks[$function];
3360 # Workaround for PHP bug 35229 and similar
3361 if ( !is_callable( $callback ) ) {
3362 throw new MWException(
"Tag hook for $function is not callable\n" );
3370 # Convert arguments to PPNodes and collect for appending to $allArgs
3372 foreach (
$args as $k => $v ) {
3373 if ( $v instanceof
PPNode || $k === 0 ) {
3376 $funcArgs[] = $this->mPreprocessor->newPartNodeArray( [ $k => $v ] )->item( 0 );
3380 # Add a frame parameter, and pass the arguments as an array
3381 $allArgs[] = $frame;
3382 $allArgs[] = $funcArgs;
3384 # Convert arguments to plain text and append to $allArgs
3385 foreach (
$args as $k => $v ) {
3386 if ( $v instanceof
PPNode ) {
3387 $allArgs[] = trim( $frame->expand( $v ) );
3388 } elseif ( is_int( $k ) && $k >= 0 ) {
3389 $allArgs[] = trim( $v );
3391 $allArgs[] = trim(
"$k=$v" );
3396 $result = call_user_func_array( $callback, $allArgs );
3398 # The interface for function hooks allows them to return a wikitext
3399 # string or an array containing the string and any flags. This mungs
3400 # things around to match what this method should return.
3417 $preprocessFlags = 0;
3418 if ( isset(
$result[
'noparse'] ) ) {
3419 $noparse =
$result[
'noparse'];
3421 if ( isset(
$result[
'preprocessFlags'] ) ) {
3422 $preprocessFlags =
$result[
'preprocessFlags'];
3426 $result[
'text'] = $this->preprocessToDom(
$result[
'text'], $preprocessFlags );
3443 $titleText =
$title->getPrefixedDBkey();
3445 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3446 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3448 $titleText =
$title->getPrefixedDBkey();
3450 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3451 return [ $this->mTplDomCache[$titleText],
$title ];
3454 # Cache miss, go to the database
3457 if ( $text ===
false ) {
3458 $this->mTplDomCache[$titleText] =
false;
3459 return [
false,
$title ];
3462 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3463 $this->mTplDomCache[$titleText] = $dom;
3465 if ( !
$title->equals( $cacheTitle ) ) {
3466 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3485 $cacheKey =
$title->getPrefixedDBkey();
3486 if ( !$this->currentRevisionCache ) {
3487 $this->currentRevisionCache =
new MapCacheLRU( 100 );
3489 if ( !$this->currentRevisionCache->has( $cacheKey ) ) {
3490 $this->currentRevisionCache->set( $cacheKey,
3492 call_user_func( $this->mOptions->getCurrentRevisionCallback(),
$title, $this )
3495 return $this->currentRevisionCache->get( $cacheKey );
3513 $rev->setTitle( $title );
3526 $templateCb = $this->mOptions->getTemplateCallback();
3527 $stuff = call_user_func( $templateCb,
$title, $this );
3529 $text = $stuff[
'text'];
3530 if ( is_string( $stuff[
'text'] ) ) {
3531 $text = strtr( $text,
"\x7f",
"?" );
3533 $finalTitle = isset( $stuff[
'finalTitle'] ) ? $stuff[
'finalTitle'] :
$title;
3534 if ( isset( $stuff[
'deps'] ) ) {
3535 foreach ( $stuff[
'deps']
as $dep ) {
3536 $this->mOutput->addTemplate( $dep[
'title'], $dep[
'page_id'], $dep[
'rev_id'] );
3537 if ( $dep[
'title']->equals( $this->getTitle() ) ) {
3540 $this->mOutput->setFlag(
'vary-revision' );
3544 return [ $text, $finalTitle ];
3553 return $this->fetchTemplateAndTitle(
$title )[0];
3566 $text = $skip =
false;
3570 # Loop to fetch the article, with up to 1 redirect
3572 for ( $i = 0; $i < 2 && is_object(
$title ); $i++ ) {
3574 # Give extensions a chance to select the revision instead
3575 $id =
false; # Assume current
3576 Hooks::run(
'BeforeParserFetchTemplateAndtitle',
3583 'page_id' =>
$title->getArticleID(),
3596 $rev_id =
$rev ?
$rev->getId() : 0;
3597 # If there is no current revision, there is no page
3598 if ( $id ===
false && !
$rev ) {
3600 $linkCache->addBadLinkObj(
$title );
3605 'page_id' =>
$title->getArticleID(),
3606 'rev_id' => $rev_id ];
3608 # We fetched a rev from a different title; register it too...
3610 'title' =>
$rev->getTitle(),
3611 'page_id' =>
$rev->getPage(),
3612 'rev_id' => $rev_id ];
3619 if ( $text ===
false || $text === null ) {
3625 $message =
wfMessage( $wgContLang->lcfirst(
$title->getText() ) )->inContentLanguage();
3626 if ( !$message->exists() ) {
3631 $text = $message->plain();
3644 'finalTitle' => $finalTitle,
3669 $time = $file ? $file->getTimestamp() :
false;
3670 $sha1 = $file ? $file->getSha1() :
false;
3671 # Register the file as a dependency...
3672 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3673 if ( $file && !
$title->equals( $file->getTitle() ) ) {
3674 # Update fetched file title
3675 $title = $file->getTitle();
3676 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3678 return [ $file,
$title ];
3692 if ( isset(
$options[
'broken'] ) ) {
3694 } elseif ( isset(
$options[
'sha1'] ) ) {
3711 global $wgEnableScaryTranscluding;
3713 if ( !$wgEnableScaryTranscluding ) {
3714 return wfMessage(
'scarytranscludedisabled' )->inContentLanguage()->text();
3717 $url =
$title->getFullURL( [
'action' => $action ] );
3719 if ( strlen( $url ) > 255 ) {
3720 return wfMessage(
'scarytranscludetoolong' )->inContentLanguage()->text();
3722 return $this->fetchScaryTemplateMaybeFromCache( $url );
3730 global $wgTranscludeCacheExpiry;
3732 $tsCond =
$dbr->timestamp( time() - $wgTranscludeCacheExpiry );
3733 $obj =
$dbr->selectRow(
'transcache', [
'tc_time',
'tc_contents' ],
3734 [
'tc_url' => $url,
"tc_time >= " .
$dbr->addQuotes( $tsCond ) ] );
3736 return $obj->tc_contents;
3742 $text =
$req->getContent();
3743 } elseif (
$req->getStatus() != 200 ) {
3745 return wfMessage(
'scarytranscludefailed-httpstatus' )
3746 ->params( $url,
$req->getStatus() )->inContentLanguage()->text();
3748 return wfMessage(
'scarytranscludefailed', $url )->inContentLanguage()->text();
3752 $dbw->replace(
'transcache', [
'tc_url' ], [
3754 'tc_time' => $dbw->timestamp( time() ),
3755 'tc_contents' => $text
3772 $parts = $piece[
'parts'];
3773 $nameWithSpaces = $frame->expand( $piece[
'title'] );
3774 $argName = trim( $nameWithSpaces );
3776 $text = $frame->getArgument( $argName );
3777 if ( $text ===
false && $parts->getLength() > 0
3778 && ( $this->ot[
'html']
3780 || ( $this->ot[
'wiki'] && $frame->isTemplate() )
3783 # No match in frame, use the supplied default
3784 $object = $parts->item( 0 )->getChildren();
3786 if ( !$this->incrementIncludeSize(
'arg', strlen( $text ) ) ) {
3787 $error =
'<!-- WARNING: argument omitted, expansion size too large -->';
3788 $this->limitationWarn(
'post-expand-template-argument' );
3791 if ( $text ===
false && $object ===
false ) {
3793 $object = $frame->virtualBracketedImplode(
'{{{',
'|',
'}}}', $nameWithSpaces, $parts );
3795 if ( $error !==
false ) {
3798 if ( $object !==
false ) {
3799 $ret = [
'object' => $object ];
3801 $ret = [
'text' => $text ];
3823 static $errorStr =
'<span class="error">';
3824 static $errorLen = 20;
3827 if ( substr(
$name, 0, $errorLen ) === $errorStr ) {
3833 $attrText = !isset(
$params[
'attr'] ) ? null : $frame->expand(
$params[
'attr'] );
3834 if ( substr( $attrText, 0, $errorLen ) === $errorStr ) {
3840 if ( substr(
$content, 0, $errorLen ) === $errorStr ) {
3845 $marker = self::MARKER_PREFIX .
"-$name-"
3846 . sprintf(
'%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
3848 $isFunctionTag = isset( $this->mFunctionTagHooks[strtolower(
$name )] ) &&
3849 ( $this->ot[
'html'] || $this->ot[
'pre'] );
3850 if ( $isFunctionTag ) {
3851 $markerType =
'none';
3853 $markerType =
'general';
3855 if ( $this->ot[
'html'] || $isFunctionTag ) {
3858 if ( isset(
$params[
'attributes'] ) ) {
3859 $attributes = $attributes +
$params[
'attributes'];
3862 if ( isset( $this->mTagHooks[
$name] ) ) {
3863 # Workaround for PHP bug 35229 and similar
3864 if ( !is_callable( $this->mTagHooks[$name] ) ) {
3865 throw new MWException(
"Tag hook for $name is not callable\n" );
3867 $output = call_user_func_array( $this->mTagHooks[$name],
3868 [
$content, $attributes, $this, $frame ] );
3869 } elseif ( isset( $this->mFunctionTagHooks[$name] ) ) {
3870 list( $callback, ) = $this->mFunctionTagHooks[
$name];
3871 if ( !is_callable( $callback ) ) {
3872 throw new MWException(
"Tag hook for $name is not callable\n" );
3879 $output =
'<span class="error">Invalid tag extension name: ' .
3880 htmlspecialchars( $name ) .
'</span>';
3884 # Extract flags to local scope (to override $markerType)
3891 if ( is_null( $attrText ) ) {
3894 if ( isset(
$params[
'attributes'] ) ) {
3895 foreach (
$params[
'attributes']
as $attrName => $attrValue ) {
3896 $attrText .=
' ' . htmlspecialchars( $attrName ) .
'="' .
3897 htmlspecialchars( $attrValue ) .
'"';
3901 $output =
"<$name$attrText/>";
3903 $close = is_null(
$params[
'close'] ) ?
'' : $frame->expand(
$params[
'close'] );
3904 if ( substr( $close, 0, $errorLen ) === $errorStr ) {
3908 $output =
"<$name$attrText>$content$close";
3912 if ( $markerType ===
'none' ) {
3914 } elseif ( $markerType ===
'nowiki' ) {
3915 $this->mStripState->addNoWiki( $marker,
$output );
3916 } elseif ( $markerType ===
'general' ) {
3917 $this->mStripState->addGeneral( $marker,
$output );
3919 throw new MWException( __METHOD__ .
': invalid marker type' );
3932 if ( $this->mIncludeSizes[
$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
3935 $this->mIncludeSizes[
$type] += $size;
3946 $this->mExpensiveFunctionCount++;
3947 return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
3960 # The position of __TOC__ needs to be recorded
3962 if ( $mw->match( $text ) ) {
3963 $this->mShowToc =
true;
3964 $this->mForceTocPosition =
true;
3966 # Set a placeholder. At the end we'll fill it in with the TOC.
3967 $text = $mw->replace(
'<!--MWTOC-->', $text, 1 );
3969 # Only keep the first one.
3970 $text = $mw->replace(
'', $text );
3973 # Now match and remove the rest of them
3975 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
3977 if ( isset( $this->mDoubleUnderscores[
'nogallery'] ) ) {
3978 $this->mOutput->mNoGallery =
true;
3980 if ( isset( $this->mDoubleUnderscores[
'notoc'] ) && !$this->mForceTocPosition ) {
3981 $this->mShowToc =
false;
3983 if ( isset( $this->mDoubleUnderscores[
'hiddencat'] )
3986 $this->addTrackingCategory(
'hidden-category-category' );
3988 # (bug 8068) Allow control over whether robots index a page.
3989 # @todo FIXME: Bug 14899: __INDEX__ always overrides __NOINDEX__ here! This
3990 # is not desirable, the last one on the page should win.
3991 if ( isset( $this->mDoubleUnderscores[
'noindex'] ) && $this->mTitle->canUseNoindex() ) {
3992 $this->mOutput->setIndexPolicy(
'noindex' );
3993 $this->addTrackingCategory(
'noindex-category' );
3995 if ( isset( $this->mDoubleUnderscores[
'index'] ) && $this->mTitle->canUseNoindex() ) {
3996 $this->mOutput->setIndexPolicy(
'index' );
3997 $this->addTrackingCategory(
'index-category' );
4000 # Cache all double underscores in the database
4001 foreach ( $this->mDoubleUnderscores
as $key => $val ) {
4002 $this->mOutput->setProperty( $key,
'' );
4014 return $this->mOutput->addTrackingCategory( $msg, $this->mTitle );
4036 # Inhibit editsection links if requested in the page
4037 if ( isset( $this->mDoubleUnderscores[
'noeditsection'] ) ) {
4038 $maybeShowEditLink = $showEditLink =
false;
4040 $maybeShowEditLink =
true;
4041 $showEditLink = $this->mOptions->getEditSection();
4043 if ( $showEditLink ) {
4044 $this->mOutput->setEditSectionTokens(
true );
4047 # Get all headlines for numbering them and adding funky stuff like [edit]
4048 # links - this is for later, but we need the number of headlines right now
4050 $numMatches = preg_match_all(
4051 '/<H(?P<level>[1-6])(?P<attrib>.*?>)\s*(?P<header>[\s\S]*?)\s*<\/H[1-6] *>/i',
4056 # if there are fewer than 4 headlines in the article, do not show TOC
4057 # unless it's been explicitly enabled.
4058 $enoughToc = $this->mShowToc &&
4059 ( ( $numMatches >= 4 ) || $this->mForceTocPosition );
4061 # Allow user to stipulate that a page should have a "new section"
4062 # link added via __NEWSECTIONLINK__
4063 if ( isset( $this->mDoubleUnderscores[
'newsectionlink'] ) ) {
4064 $this->mOutput->setNewSection(
true );
4067 # Allow user to remove the "new section"
4068 # link via __NONEWSECTIONLINK__
4069 if ( isset( $this->mDoubleUnderscores[
'nonewsectionlink'] ) ) {
4070 $this->mOutput->hideNewSection(
true );
4073 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
4074 # override above conditions and always show TOC above first header
4075 if ( isset( $this->mDoubleUnderscores[
'forcetoc'] ) ) {
4076 $this->mShowToc =
true;
4084 # Ugh .. the TOC should have neat indentation levels which can be
4085 # passed to the skin functions. These are determined here
4089 $sublevelCount = [];
4095 $markerRegex = self::MARKER_PREFIX .
"-h-(\d+)-" . self::MARKER_SUFFIX;
4096 $baseTitleText = $this->mTitle->getPrefixedDBkey();
4097 $oldType = $this->mOutputType;
4099 $frame = $this->getPreprocessor()->newFrame();
4100 $root = $this->preprocessToDom( $origText );
4101 $node = $root->getFirstChild();
4106 $headlines = $numMatches !==
false ?
$matches[3] : [];
4108 foreach ( $headlines
as $headline ) {
4109 $isTemplate =
false;
4111 $sectionIndex =
false;
4113 $markerMatches = [];
4114 if ( preg_match(
"/^$markerRegex/", $headline, $markerMatches ) ) {
4115 $serial = $markerMatches[1];
4116 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
4117 $isTemplate = ( $titleText != $baseTitleText );
4118 $headline = preg_replace(
"/^$markerRegex\\s*/",
"", $headline );
4122 $prevlevel = $level;
4124 $level =
$matches[1][$headlineCount];
4126 if ( $level > $prevlevel ) {
4127 # Increase TOC level
4129 $sublevelCount[$toclevel] = 0;
4130 if ( $toclevel < $wgMaxTocLevel ) {
4131 $prevtoclevel = $toclevel;
4135 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4136 # Decrease TOC level, find level to jump to
4138 for ( $i = $toclevel; $i > 0; $i-- ) {
4139 if ( $levelCount[$i] == $level ) {
4140 # Found last matching level
4143 } elseif ( $levelCount[$i] < $level ) {
4144 # Found first matching level below current level
4152 if ( $toclevel < $wgMaxTocLevel ) {
4153 if ( $prevtoclevel < $wgMaxTocLevel ) {
4154 # Unindent only if the previous toc level was shown :p
4156 $prevtoclevel = $toclevel;
4162 # No change in level, end TOC line
4163 if ( $toclevel < $wgMaxTocLevel ) {
4168 $levelCount[$toclevel] = $level;
4170 # count number of headlines for each level
4171 $sublevelCount[$toclevel]++;
4173 for ( $i = 1; $i <= $toclevel; $i++ ) {
4174 if ( !empty( $sublevelCount[$i] ) ) {
4178 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4183 # The safe header is a version of the header text safe to use for links
4185 # Remove link placeholders by the link text.
4186 # <!--LINK number-->
4188 # link text with suffix
4189 # Do this before unstrip since link text can contain strip markers
4190 $safeHeadline = $this->replaceLinkHoldersText( $headline );
4192 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4193 $safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
4195 # Strip out HTML (first regex removes any tag not allowed)
4197 # * <sup> and <sub> (bug 8393)
4200 # * <bdi> (bug 72884)
4201 # * <span dir="rtl"> and <span dir="ltr"> (bug 35167)
4202 # * <s> and <strike> (T35715)
4203 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4204 # to allow setting directionality in toc items.
4205 $tocline = preg_replace(
4207 '#<(?!/?(span|sup|sub|bdi|i|b|s|strike)(?: [^>]*)?>).*?>#',
4208 '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|bdi|i|b|s|strike))(?: .*?)?>#'
4214 # Strip '<span></span>', which is the result from the above if
4215 # <span id="foo"></span> is used to produce an additional anchor
4217 $tocline = str_replace(
'<span></span>',
'', $tocline );
4219 $tocline = trim( $tocline );
4221 # For the anchor, strip out HTML-y stuff period
4222 $safeHeadline = preg_replace(
'/<.*?>/',
'', $safeHeadline );
4225 # Save headline for section edit hint before it's escaped
4226 $headlineHint = $safeHeadline;
4228 if ( $wgExperimentalHtmlIds ) {
4229 # For reverse compatibility, provide an id that's
4230 # HTML4-compatible, like we used to.
4231 # It may be worth noting, academically, that it's possible for
4232 # the legacy anchor to conflict with a non-legacy headline
4233 # anchor on the page. In this case likely the "correct" thing
4234 # would be to either drop the legacy anchors or make sure
4235 # they're numbered first. However, this would require people
4236 # to type in section names like "abc_.D7.93.D7.90.D7.A4"
4237 # manually, so let's not bother worrying about it.
4239 [
'noninitial',
'legacy' ] );
4242 if ( $legacyHeadline == $safeHeadline ) {
4243 # No reason to have both (in fact, we can't)
4244 $legacyHeadline =
false;
4247 $legacyHeadline =
false;
4252 # HTML names must be case-insensitively unique (bug 10721).
4253 # This does not apply to Unicode characters per
4254 # http://www.w3.org/TR/html5/infrastructure.html#case-sensitivity-and-string-comparison
4255 # @todo FIXME: We may be changing them depending on the current locale.
4256 $arrayKey = strtolower( $safeHeadline );
4257 if ( $legacyHeadline ===
false ) {
4258 $legacyArrayKey =
false;
4260 $legacyArrayKey = strtolower( $legacyHeadline );
4263 # Create the anchor for linking from the TOC to the section
4264 $anchor = $safeHeadline;
4265 $legacyAnchor = $legacyHeadline;
4266 if ( isset( $refers[$arrayKey] ) ) {
4268 for ( $i = 2; isset( $refers[
"${arrayKey}_$i"] ); ++$i );
4271 $refers[
"${arrayKey}_$i"] =
true;
4273 $refers[$arrayKey] =
true;
4275 if ( $legacyHeadline !==
false && isset( $refers[$legacyArrayKey] ) ) {
4277 for ( $i = 2; isset( $refers[
"${legacyArrayKey}_$i"] ); ++$i );
4279 $legacyAnchor .=
"_$i";
4280 $refers[
"${legacyArrayKey}_$i"] =
true;
4282 $refers[$legacyArrayKey] =
true;
4285 # Don't number the heading if it is the only one (looks silly)
4286 if ( count(
$matches[3] ) > 1 && $this->mOptions->getNumberHeadings() ) {
4287 # the two are different if the line contains a link
4290 [
'class' =>
'mw-headline-number' ],
4292 ) .
' ' . $headline;
4295 if ( $enoughToc && ( !isset( $wgMaxTocLevel ) || $toclevel < $wgMaxTocLevel ) ) {
4297 $numbering, $toclevel, ( $isTemplate ?
false : $sectionIndex ) );
4300 # Add the section to the section tree
4301 # Find the DOM node for this header
4302 $noOffset = ( $isTemplate || $sectionIndex ===
false );
4303 while ( $node && !$noOffset ) {
4304 if ( $node->getName() ===
'h' ) {
4305 $bits = $node->splitHeading();
4306 if ( $bits[
'i'] == $sectionIndex ) {
4310 $byteOffset += mb_strlen( $this->mStripState->unstripBoth(
4312 $node = $node->getNextSibling();
4315 'toclevel' => $toclevel,
4318 'number' => $numbering,
4319 'index' => ( $isTemplate ?
'T-' :
'' ) . $sectionIndex,
4320 'fromtitle' => $titleText,
4321 'byteoffset' => ( $noOffset ? null : $byteOffset ),
4322 'anchor' => $anchor,
4325 # give headline the correct <h#> tag
4326 if ( $maybeShowEditLink && $sectionIndex !==
false ) {
4328 if ( $isTemplate ) {
4329 # Put a T flag in the section identifier, to indicate to extractSections()
4330 # that sections inside <includeonly> should be counted.
4331 $editsectionPage = $titleText;
4332 $editsectionSection =
"T-$sectionIndex";
4333 $editsectionContent = null;
4335 $editsectionPage = $this->mTitle->getPrefixedText();
4336 $editsectionSection = $sectionIndex;
4337 $editsectionContent = $headlineHint;
4351 $editlink =
'<mw:editsection page="' . htmlspecialchars( $editsectionPage );
4352 $editlink .=
'" section="' . htmlspecialchars( $editsectionSection ) .
'"';
4353 if ( $editsectionContent !== null ) {
4354 $editlink .=
'>' . $editsectionContent .
'</mw:editsection>';
4362 $matches[
'attrib'][$headlineCount], $anchor, $headline,
4363 $editlink, $legacyAnchor );
4368 $this->setOutputType( $oldType );
4370 # Never ever show TOC if no headers
4371 if ( $numVisible < 1 ) {
4376 if ( $prevtoclevel > 0 && $prevtoclevel < $wgMaxTocLevel ) {
4380 $this->mOutput->setTOCHTML( $toc );
4381 $toc = self::TOC_START . $toc . self::TOC_END;
4382 $this->mOutput->addModules(
'mediawiki.toc' );
4386 $this->mOutput->setSections( $tocraw );
4389 # split up and insert constructed headlines
4390 $blocks = preg_split(
'/<H[1-6].*?>[\s\S]*?<\/H[1-6]>/i', $text );
4395 foreach ( $blocks
as $block ) {
4397 if ( empty( $head[$i - 1] ) ) {
4398 $sections[$i] = $block;
4400 $sections[$i] = $head[$i - 1] . $block;
4413 Hooks::run(
'ParserSectionCreate', [ $this, $i, &$sections[$i], $showEditLink ] );
4418 if ( $enoughToc && $isMain && !$this->mForceTocPosition ) {
4421 $sections[0] = $sections[0] . $toc .
"\n";
4424 $full .= implode(
'', $sections );
4426 if ( $this->mForceTocPosition ) {
4427 return str_replace(
'<!--MWTOC-->', $toc, $full );
4447 if ( $clearState ) {
4448 $magicScopeVariable = $this->lock();
4450 $this->startParse( $title, $options,
self::OT_WIKI, $clearState );
4451 $this->setUser( $user );
4459 $text = $this->pstPass2( $text, $user );
4461 $text = $this->mStripState->unstripBoth( $text );
4463 $this->setUser( null ); # Reset
4479 # Note: This is the timestamp saved as hardcoded wikitext to
4480 # the database, we use $wgContLang here in order to give
4481 # everyone the same signature and use the default one rather
4482 # than the one selected in each user's preferences.
4483 # (see also bug 12815)
4484 $ts = $this->mOptions->getTimestamp();
4487 $tzMsg =
$timestamp->getTimezoneMessage()->inContentLanguage()->text();
4489 $d = $wgContLang->timeanddate( $ts,
false,
false ) .
" ($tzMsg)";
4491 # Variable replacement
4492 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4493 $text = $this->replaceVariables( $text );
4495 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4496 # which may corrupt this parser instance via its wfMessage()->text() call-
4499 $sigText = $this->getUserSig(
$user );
4500 $text = strtr( $text, [
4502 '~~~~' =>
"$sigText $d",
4506 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4508 $nc =
'[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can
use non-ascii!
4511 $p1 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/";
4513 $p4 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?($tc+))\\|]]/";
4515 $p3 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |,)$tc+|)\\|]]/";
4517 $p2 =
"/\[\[\\|($tc+)]]/";
4519 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4520 $text = preg_replace( $p1,
'[[\\1\\2\\3|\\2]]', $text );
4521 $text = preg_replace( $p4,
'[[\\1\\2\\3|\\2]]', $text );
4522 $text = preg_replace( $p3,
'[[\\1\\2\\3\\4|\\2]]', $text );
4524 $t = $this->mTitle->getText();
4526 if ( preg_match(
"/^($nc+:|)$tc+?( \\($tc+\\))$/",
$t, $m ) ) {
4527 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4528 } elseif ( preg_match(
"/^($nc+:|)$tc+?(, $tc+|)$/",
$t, $m ) &&
"$m[1]$m[2]" !=
'' ) {
4529 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4531 # if there's no context, don't bother duplicating the title
4532 $text = preg_replace( $p2,
'[[\\1]]', $text );
4557 # If not given, retrieve from the user object.
4558 if ( $nickname ===
false ) {
4559 $nickname =
$user->getOption(
'nickname' );
4562 if ( is_null( $fancySig ) ) {
4563 $fancySig =
$user->getBoolOption(
'fancysig' );
4566 $nickname = $nickname == null ?
$username : $nickname;
4568 if ( mb_strlen( $nickname ) > $wgMaxSigChars ) {
4570 wfDebug( __METHOD__ .
": $username has overlong signature.\n" );
4571 } elseif ( $fancySig !==
false ) {
4572 # Sig. might contain markup; validate this
4573 if ( $this->validateSig( $nickname ) !==
false ) {
4574 # Validated; clean up (if needed) and return it
4575 return $this->cleanSig( $nickname,
true );
4577 # Failed to validate; fall back to the default
4579 wfDebug( __METHOD__ .
": $username has bad XML tags in signature.\n" );
4583 # Make sure nickname doesnt get a sig in a sig
4584 $nickname = self::cleanSigInSig( $nickname );
4586 # If we're still here, make it a link to the user page
4589 $msgName =
$user->isAnon() ?
'signature-anon' :
'signature';
4591 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()
4592 ->title( $this->getTitle() )->text();
4618 $magicScopeVariable = $this->lock();
4622 # Option to disable this feature
4623 if ( !$this->mOptions->getCleanSignatures() ) {
4627 # @todo FIXME: Regex doesn't respect extension tags or nowiki
4628 # => Move this logic to braceSubstitution()
4630 $substRegex =
'/\{\{(?!(?:' . $substWord->getBaseRegex() .
'))/x' . $substWord->getRegexCase();
4631 $substText =
'{{' . $substWord->getSynonym( 0 );
4633 $text = preg_replace( $substRegex, $substText, $text );
4634 $text = self::cleanSigInSig( $text );
4635 $dom = $this->preprocessToDom( $text );
4636 $frame = $this->getPreprocessor()->newFrame();
4637 $text = $frame->expand( $dom );
4640 $text = $this->mStripState->unstripBoth( $text );
4653 $text = preg_replace(
'/~{3,5}/',
'', $text );
4667 $outputType, $clearState =
true
4669 $this->startParse(
$title, $options, $outputType, $clearState );
4679 $outputType, $clearState =
true
4681 $this->setTitle(
$title );
4683 $this->setOutputType( $outputType );
4684 if ( $clearState ) {
4685 $this->clearState();
4698 static $executing =
false;
4700 # Guard against infinite recursion
4743 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4744 throw new MWException(
"Invalid character {$m[0]} in setHook('$tag', ...) call" );
4746 $oldVal = isset( $this->mTagHooks[
$tag] ) ? $this->mTagHooks[
$tag] : null;
4747 $this->mTagHooks[
$tag] = $callback;
4748 if ( !in_array( $tag, $this->mStripList ) ) {
4749 $this->mStripList[] =
$tag;
4774 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4775 throw new MWException(
"Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
4777 $oldVal = isset( $this->mTransparentTagHooks[
$tag] ) ? $this->mTransparentTagHooks[
$tag] : null;
4778 $this->mTransparentTagHooks[
$tag] = $callback;
4787 $this->mTagHooks = [];
4788 $this->mFunctionTagHooks = [];
4789 $this->mStripList = $this->mDefaultStripList;
4838 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] : null;
4839 $this->mFunctionHooks[$id] = [ $callback,
$flags ];
4841 # Add to function cache
4844 throw new MWException( __METHOD__ .
'() expecting a magic word identifier.' );
4847 $synonyms = $mw->getSynonyms();
4848 $sensitive = intval( $mw->isCaseSensitive() );
4850 foreach ( $synonyms
as $syn ) {
4852 if ( !$sensitive ) {
4853 $syn = $wgContLang->lc( $syn );
4859 # Remove trailing colon
4860 if ( substr( $syn, -1, 1 ) ===
':' ) {
4861 $syn = substr( $syn, 0, -1 );
4863 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
4874 return array_keys( $this->mFunctionHooks );
4889 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4890 throw new MWException(
"Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
4892 $old = isset( $this->mFunctionTagHooks[
$tag] ) ?
4893 $this->mFunctionTagHooks[
$tag] : null;
4894 $this->mFunctionTagHooks[
$tag] = [ $callback,
$flags ];
4896 if ( !in_array( $tag, $this->mStripList ) ) {
4897 $this->mStripList[] =
$tag;
4911 $this->mLinkHolders->replace( $text );
4922 return $this->mLinkHolders->replaceText( $text );
4941 if ( isset(
$params[
'mode'] ) ) {
4952 $ig->setContextTitle( $this->mTitle );
4953 $ig->setShowBytes(
false );
4954 $ig->setShowFilename(
false );
4955 $ig->setParser( $this );
4956 $ig->setHideBadImages();
4959 if ( isset(
$params[
'showfilename'] ) ) {
4960 $ig->setShowFilename(
true );
4962 $ig->setShowFilename(
false );
4964 if ( isset(
$params[
'caption'] ) ) {
4965 $caption =
$params[
'caption'];
4966 $caption = htmlspecialchars( $caption );
4967 $caption = $this->replaceInternalLinks( $caption );
4968 $ig->setCaptionHtml( $caption );
4970 if ( isset(
$params[
'perrow'] ) ) {
4971 $ig->setPerRow(
$params[
'perrow'] );
4973 if ( isset(
$params[
'widths'] ) ) {
4974 $ig->setWidths(
$params[
'widths'] );
4976 if ( isset(
$params[
'heights'] ) ) {
4977 $ig->setHeights(
$params[
'heights'] );
4979 $ig->setAdditionalOptions(
$params );
4987 # match lines like these:
4988 # Image:someimage.jpg|This is some image
4990 preg_match(
"/^([^|]+)(\\|(.*))?$/", $line,
$matches );
4996 if ( strpos(
$matches[0],
'%' ) !==
false ) {
5000 if ( is_null(
$title ) ) {
5001 # Bogus title. Ignore these so we don't bomb out later.
5005 # We need to get what handler the file uses, to figure out parameters.
5006 # Note, a hook can overide the file name, and chose an entirely different
5007 # file (which potentially could be of a different type and have different handler).
5012 # Don't register it now, as ImageGallery does that later.
5014 $handler = $file ? $file->getHandler() :
false;
5017 'img_alt' =>
'gallery-internal-alt',
5018 'img_link' =>
'gallery-internal-link',
5021 $paramMap = $paramMap +
$handler->getParamMap();
5024 unset( $paramMap[
'img_width'] );
5032 $handlerOptions = [];
5043 foreach ( $parameterMatches
as $parameterMatch ) {
5044 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
5046 $paramName = $paramMap[$magicName];
5048 switch ( $paramName ) {
5049 case 'gallery-internal-alt':
5050 $alt = $this->stripAltText( $match,
false );
5052 case 'gallery-internal-link':
5053 $linkValue = strip_tags( $this->replaceLinkHoldersText( $match ) );
5054 $chars = self::EXT_LINK_URL_CLASS;
5055 $addr = self::EXT_LINK_ADDR;
5056 $prots = $this->mUrlProtocols;
5058 if ( preg_match(
"/^($prots)$addr$chars*$/u", $linkValue ) ) {
5060 $this->mOutput->addExternalLink(
$link );
5063 if ( $localLinkTitle !== null ) {
5064 $this->mOutput->addLink( $localLinkTitle );
5065 $link = $localLinkTitle->getLinkURL();
5071 if (
$handler->validateParam( $paramName, $match ) ) {
5072 $handlerOptions[$paramName] = $match;
5075 wfDebug(
"$parameterMatch failed parameter validation\n" );
5076 $label =
'|' . $parameterMatch;
5082 $label =
'|' . $parameterMatch;
5086 $label = substr( $label, 1 );
5089 $ig->add(
$title, $label, $alt,
$link, $handlerOptions );
5091 $html = $ig->toHTML();
5102 $handlerClass = get_class(
$handler );
5106 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
5107 # Initialise static lists
5108 static $internalParamNames = [
5109 'horizAlign' => [
'left',
'right',
'center',
'none' ],
5110 'vertAlign' => [
'baseline',
'sub',
'super',
'top',
'text-top',
'middle',
5111 'bottom',
'text-bottom' ],
5112 'frame' => [
'thumbnail',
'manualthumb',
'framed',
'frameless',
5113 'upright',
'border',
'link',
'alt',
'class' ],
5115 static $internalParamMap;
5116 if ( !$internalParamMap ) {
5117 $internalParamMap = [];
5118 foreach ( $internalParamNames
as $type => $names ) {
5120 $magicName = str_replace(
'-',
'_',
"img_$name" );
5121 $internalParamMap[$magicName] = [
$type,
$name ];
5126 # Add handler params
5127 $paramMap = $internalParamMap;
5129 $handlerParamMap =
$handler->getParamMap();
5130 foreach ( $handlerParamMap
as $magic => $paramName ) {
5131 $paramMap[$magic] = [
'handler', $paramName ];
5134 $this->mImageParams[$handlerClass] = $paramMap;
5135 $this->mImageParamsMagicArray[$handlerClass] =
new MagicWordArray( array_keys( $paramMap ) );
5137 return [ $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] ];
5149 # Check if the options text is of the form "options|alt text"
5151 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5152 # * left no resizing, just left align. label is used for alt= only
5153 # * right same, but right aligned
5154 # * none same, but not aligned
5155 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5156 # * center center the image
5157 # * frame Keep original image size, no magnify-button.
5158 # * framed Same as "frame"
5159 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5160 # * upright reduce width for upright images, rounded to full __0 px
5161 # * border draw a 1px border around the image
5162 # * alt Text for HTML alt attribute (defaults to empty)
5163 # * class Set a class for img node
5164 # * link Set the target of the image link. Can be external, interwiki, or local
5165 # vertical-align values (no % or length right now):
5177 # Give extensions a chance to select the file revision for us
5182 # Fetch and register the file (file title may be different via hooks)
5186 $handler = $file ? $file->getHandler() :
false;
5188 list( $paramMap, $mwArray ) = $this->getImageParams(
$handler );
5191 $this->addTrackingCategory(
'broken-file-category' );
5194 # Process the input parameters
5196 $params = [
'frame' => [],
'handler' => [],
5197 'horizAlign' => [],
'vertAlign' => [] ];
5198 $seenformat =
false;
5199 foreach ( $parts
as $part ) {
5200 $part = trim( $part );
5201 list( $magicName,
$value ) = $mwArray->matchVariableStartToEnd( $part );
5203 if ( isset( $paramMap[$magicName] ) ) {
5204 list(
$type, $paramName ) = $paramMap[$magicName];
5206 # Special case; width and height come in one variable together
5207 if (
$type ===
'handler' && $paramName ===
'width' ) {
5208 $parsedWidthParam = $this->parseWidthParam(
$value );
5209 if ( isset( $parsedWidthParam[
'width'] ) ) {
5210 $width = $parsedWidthParam[
'width'];
5211 if (
$handler->validateParam(
'width', $width ) ) {
5216 if ( isset( $parsedWidthParam[
'height'] ) ) {
5217 $height = $parsedWidthParam[
'height'];
5218 if (
$handler->validateParam(
'height', $height ) ) {
5223 # else no validation -- bug 13436
5225 if (
$type ===
'handler' ) {
5226 # Validate handler parameter
5229 # Validate internal parameters
5230 switch ( $paramName ) {
5234 # @todo FIXME: Possibly check validity here for
5235 # manualthumb? downstream behavior seems odd with
5236 # missing manual thumbs.
5241 $chars = self::EXT_LINK_URL_CLASS;
5242 $addr = self::EXT_LINK_ADDR;
5243 $prots = $this->mUrlProtocols;
5245 $paramName =
'no-link';
5248 } elseif ( preg_match(
"/^((?i)$prots)/",
$value ) ) {
5249 if ( preg_match(
"/^((?i)$prots)$addr$chars*$/u",
$value, $m ) ) {
5250 $paramName =
'link-url';
5251 $this->mOutput->addExternalLink(
$value );
5252 if ( $this->mOptions->getExternalLinkTarget() ) {
5253 $params[
$type][
'link-target'] = $this->mOptions->getExternalLinkTarget();
5260 $paramName =
'link-title';
5262 $this->mOutput->addLink( $linkTitle );
5271 $validated = ! $seenformat;
5275 # Most other things appear to be empty or numeric...
5276 $validated = (
$value ===
false || is_numeric( trim(
$value ) ) );
5285 if ( !$validated ) {
5290 # Process alignment parameters
5291 if (
$params[
'horizAlign'] ) {
5298 $params[
'frame'][
'caption'] = $caption;
5300 # Will the image be presented in a frame, with the caption below?
5301 $imageIsFramed = isset(
$params[
'frame'][
'frame'] )
5302 || isset(
$params[
'frame'][
'framed'] )
5303 || isset(
$params[
'frame'][
'thumbnail'] )
5304 || isset(
$params[
'frame'][
'manualthumb'] );
5306 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5307 # came to also set the caption, ordinary text after the image -- which
5308 # makes no sense, because that just repeats the text multiple times in
5309 # screen readers. It *also* came to set the title attribute.
5310 # Now that we have an alt attribute, we should not set the alt text to
5311 # equal the caption: that's worse than useless, it just repeats the
5312 # text. This is the framed/thumbnail case. If there's no caption, we
5313 # use the unnamed parameter for alt text as well, just for the time be-
5314 # ing, if the unnamed param is set and the alt param is not.
5315 # For the future, we need to figure out if we want to tweak this more,
5316 # e.g., introducing a title= parameter for the title; ignoring the un-
5317 # named parameter entirely for images without a caption; adding an ex-
5318 # plicit caption= parameter and preserving the old magic unnamed para-
5320 if ( $imageIsFramed ) { # Framed image
5321 if ( $caption ===
'' && !isset(
$params[
'frame'][
'alt'] ) ) {
5322 # No caption or alt text, add the filename as the alt text so
5323 # that screen readers at least get some description of the image
5326 # Do not set $params['frame']['title'] because tooltips don't make sense
5328 }
else { # Inline image
5329 if ( !isset(
$params[
'frame'][
'alt'] ) ) {
5330 # No alt text, use the "caption" for the alt text
5331 if ( $caption !==
'' ) {
5332 $params[
'frame'][
'alt'] = $this->stripAltText( $caption, $holders );
5334 # No caption, fall back to using the filename for the
5339 # Use the "caption" for the tooltip text
5340 $params[
'frame'][
'title'] = $this->stripAltText( $caption, $holders );
5345 # Linker does the rest
5348 $time, $descQuery, $this->mOptions->getThumbSize() );
5350 # Give the handler a chance to modify the parser object
5352 $handler->parserTransformHook( $this, $file );
5364 # Strip bad stuff out of the title (tooltip). We can't just use
5365 # replaceLinkHoldersText() here, because if this function is called
5366 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
5368 $tooltip = $holders->replaceText( $caption );
5370 $tooltip = $this->replaceLinkHoldersText( $caption );
5373 # make sure there are no placeholders in thumbnail attributes
5374 # that are later expanded to html- so expand them now and
5376 $tooltip = $this->mStripState->unstripBoth( $tooltip );
5388 wfDebug(
"Parser output marked as uncacheable.\n" );
5389 if ( !$this->mOutput ) {
5391 " can only be called when actually parsing something" );
5393 $this->mOutput->updateCacheExpiry( 0 );
5405 $text = $this->replaceVariables( $text, $frame );
5406 $text = $this->mStripState->unstripBoth( $text );
5417 array_keys( $this->mTransparentTagHooks ),
5418 array_keys( $this->mTagHooks ),
5419 array_keys( $this->mFunctionTagHooks )
5435 $elements = array_keys( $this->mTransparentTagHooks );
5436 $text = self::extractTagsAndParams( $elements, $text,
$matches );
5441 $tagName = strtolower( $element );
5442 if ( isset( $this->mTransparentTagHooks[$tagName] ) ) {
5443 $output = call_user_func_array(
5444 $this->mTransparentTagHooks[$tagName],
5450 $replacements[$marker] =
$output;
5452 return strtr( $text, $replacements );
5487 $magicScopeVariable = $this->lock();
5490 $frame = $this->getPreprocessor()->newFrame();
5492 # Process section extraction flags
5494 $sectionParts = explode(
'-', $sectionId );
5495 $sectionIndex = array_pop( $sectionParts );
5496 foreach ( $sectionParts
as $part ) {
5497 if ( $part ===
'T' ) {
5498 $flags |= self::PTD_FOR_INCLUSION;
5502 # Check for empty input
5503 if ( strval( $text ) ===
'' ) {
5504 # Only sections 0 and T-0 exist in an empty document
5505 if ( $sectionIndex == 0 ) {
5506 if ( $mode ===
'get' ) {
5512 if ( $mode ===
'get' ) {
5520 # Preprocess the text
5521 $root = $this->preprocessToDom( $text,
$flags );
5523 # <h> nodes indicate section breaks
5524 # They can only occur at the top level, so we can find them by iterating the root's children
5525 $node = $root->getFirstChild();
5527 # Find the target section
5528 if ( $sectionIndex == 0 ) {
5529 # Section zero doesn't nest, level=big
5530 $targetLevel = 1000;
5533 if ( $node->getName() ===
'h' ) {
5534 $bits = $node->splitHeading();
5535 if ( $bits[
'i'] == $sectionIndex ) {
5536 $targetLevel = $bits[
'level'];
5540 if ( $mode ===
'replace' ) {
5543 $node = $node->getNextSibling();
5549 if ( $mode ===
'get' ) {
5556 # Find the end of the section, including nested sections
5558 if ( $node->getName() ===
'h' ) {
5559 $bits = $node->splitHeading();
5560 $curLevel = $bits[
'level'];
5561 if ( $bits[
'i'] != $sectionIndex && $curLevel <= $targetLevel ) {
5565 if ( $mode ===
'get' ) {
5568 $node = $node->getNextSibling();
5571 # Write out the remainder (in replace mode only)
5572 if ( $mode ===
'replace' ) {
5573 # Output the replacement text
5574 # Add two newlines on -- trailing whitespace in $newText is conventionally
5575 # stripped by the editor, so we need both newlines to restore the paragraph gap
5576 # Only add trailing whitespace if there is newText
5577 if ( $newText !=
"" ) {
5578 $outText .= $newText .
"\n\n";
5583 $node = $node->getNextSibling();
5587 if ( is_string( $outText ) ) {
5588 # Re-insert stripped tags
5589 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
5609 public function getSection( $text, $sectionId, $defaultText =
'' ) {
5610 return $this->extractSections( $text, $sectionId,
'get', $defaultText );
5626 return $this->extractSections( $oldText, $sectionId,
'replace', $newText );
5635 return $this->mRevisionId;
5645 if ( !is_null( $this->mRevisionObject ) ) {
5646 return $this->mRevisionObject;
5648 if ( is_null( $this->mRevisionId ) ) {
5652 $rev = call_user_func(
5653 $this->mOptions->getCurrentRevisionCallback(), $this->getTitle(), $this
5656 # If the parse is for a new revision, then the callback should have
5657 # already been set to force the object and should match mRevisionId.
5658 # If not, try to fetch by mRevisionId for sanity.
5659 if (
$rev &&
$rev->getId() != $this->mRevisionId ) {
5663 $this->mRevisionObject =
$rev;
5665 return $this->mRevisionObject;
5674 if ( is_null( $this->mRevisionTimestamp ) ) {
5677 $revObject = $this->getRevisionObject();
5680 # The cryptic '' timezone parameter tells to use the site-default
5681 # timezone offset instead of the user settings.
5682 # Since this value will be saved into the parser cache, served
5683 # to other users, and potentially even used inside links and such,
5684 # it needs to be consistent for all visitors.
5685 $this->mRevisionTimestamp = $wgContLang->userAdjust(
$timestamp,
'' );
5688 return $this->mRevisionTimestamp;
5697 if ( is_null( $this->mRevisionUser ) ) {
5698 $revObject = $this->getRevisionObject();
5700 # if this template is subst: the revision id will be blank,
5701 # so just use the current user's name
5703 $this->mRevisionUser = $revObject->getUserText();
5704 } elseif ( $this->ot[
'wiki'] || $this->mOptions->getIsPreview() ) {
5705 $this->mRevisionUser = $this->getUser()->getName();
5708 return $this->mRevisionUser;
5717 if ( is_null( $this->mRevisionSize ) ) {
5718 $revObject = $this->getRevisionObject();
5720 # if this variable is subst: the revision id will be blank,
5721 # so just use the parser input size, because the own substituation
5722 # will change the size.
5724 $this->mRevisionSize = $revObject->getSize();
5726 $this->mRevisionSize = $this->mInputSize;
5729 return $this->mRevisionSize;
5738 $this->mDefaultSort =
$sort;
5739 $this->mOutput->setProperty(
'defaultsort',
$sort );
5753 if ( $this->mDefaultSort !==
false ) {
5754 return $this->mDefaultSort;
5767 return $this->mDefaultSort;
5780 # Strip out wikitext links(they break the anchor)
5781 $text = $this->stripSectionName( $text );
5795 # Strip out wikitext links(they break the anchor)
5796 $text = $this->stripSectionName( $text );
5816 # Strip internal link markup
5817 $text = preg_replace(
'/\[\[:?([^[|]+)\|([^[]+)\]\]/',
'$2', $text );
5818 $text = preg_replace(
'/\[\[:?([^[]+)\|?\]\]/',
'$1', $text );
5820 # Strip external link markup
5821 # @todo FIXME: Not tolerant to blank link text
5822 # I.E. [https://www.mediawiki.org] will render as [1] or something depending
5823 # on how many empty links there are on the page - need to figure that out.
5824 $text = preg_replace(
'/\[(?i:' . $this->mUrlProtocols .
')([^ ]+?) ([^[]+)\]/',
'$2', $text );
5826 # Parse wikitext quotes (italics & bold)
5827 $text = $this->doQuotes( $text );
5847 $magicScopeVariable = $this->lock();
5848 $this->startParse( $title, $options, $outputType,
true );
5850 $text = $this->replaceVariables( $text );
5851 $text = $this->mStripState->unstripBoth( $text );
5863 return $this->preSaveTransform( $text, $title, $options->
getUser(),
$options );
5895 while ( $i < strlen(
$s ) ) {
5896 $markerStart = strpos(
$s, self::MARKER_PREFIX, $i );
5897 if ( $markerStart ===
false ) {
5898 $out .= call_user_func( $callback, substr(
$s, $i ) );
5901 $out .= call_user_func( $callback, substr(
$s, $i, $markerStart - $i ) );
5902 $markerEnd = strpos(
$s, self::MARKER_SUFFIX, $markerStart );
5903 if ( $markerEnd ===
false ) {
5904 $out .= substr(
$s, $markerStart );
5907 $markerEnd += strlen( self::MARKER_SUFFIX );
5908 $out .= substr(
$s, $markerStart, $markerEnd - $markerStart );
5923 return $this->mStripState->killMarkers( $text );
5945 'version' => self::HALF_PARSED_VERSION,
5946 'stripState' => $this->mStripState->getSubState( $text ),
5947 'linkHolders' => $this->mLinkHolders->getSubArray( $text )
5968 if ( !isset( $data[
'version'] ) || $data[
'version'] != self::HALF_PARSED_VERSION ) {
5969 throw new MWException( __METHOD__ .
': invalid version' );
5972 # First, extract the strip state.
5973 $texts = [ $data[
'text'] ];
5974 $texts = $this->mStripState->merge( $data[
'stripState'], $texts );
5976 # Now renumber links
5977 $texts = $this->mLinkHolders->mergeForeign( $data[
'linkHolders'], $texts );
5979 # Should be good to go.
5993 return isset( $data[
'version'] ) && $data[
'version'] == self::HALF_PARSED_VERSION;
6005 $parsedWidthParam = [];
6007 return $parsedWidthParam;
6010 # (bug 13500) In both cases (width/height and width only),
6011 # permit trailing "px" for backward compatibility.
6012 if ( preg_match(
'/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/',
$value, $m ) ) {
6013 $width = intval( $m[1] );
6014 $height = intval( $m[2] );
6015 $parsedWidthParam[
'width'] = $width;
6016 $parsedWidthParam[
'height'] = $height;
6017 } elseif ( preg_match(
'/^[0-9]*\s*(?:px)?\s*$/',
$value ) ) {
6018 $width = intval(
$value );
6019 $parsedWidthParam[
'width'] = $width;
6021 return $parsedWidthParam;
6034 if ( $this->mInParse ) {
6035 throw new MWException(
"Parser state cleared while parsing. "
6036 .
"Did you call Parser::parse recursively?" );
6038 $this->mInParse =
true;
6040 $recursiveCheck =
new ScopedCallback(
function() {
6041 $this->mInParse =
false;
6044 return $recursiveCheck;
6059 if ( preg_match(
'/^<p>(.*)\n?<\/p>\n?$/sU',
$html, $m ) ) {
6060 if ( strpos( $m[1],
'</p>' ) ===
false ) {
6080 if ( $this->mInParse ) {
6081 return new $wgParserConf[
'class']( $wgParserConf );
6095 $this->mOutput->setEnableOOUI(
true );
getRevisionObject()
Get the revision object for $this->mRevisionId.
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
setTitle($t)
Set the context title.
getLatestRevID($flags=0)
What is the page_latest field for this page?
markerSkipCallback($s, $callback)
Call a callback function on all regions of the given text that are not inside strip markers...
#define the
table suitable for use with IDatabase::select()
replaceInternalLinks2(&$s)
Process [[ ]] wikilinks (RIL)
static getVariableIDs()
Get an array of parser variable IDs.
you don t have to do a grep find to see where the $wgReverseTitle variable is used
getExternalLinkAttribs($url)
Get an associative array of additional HTML attributes appropriate for a particular external link...
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
isValidHalfParsedText($data)
Returns true if the given array, presumed to be generated by serializeHalfParsedText(), is compatible with the current version of the parser.
null means default in associative array form
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
static tocLineEnd()
End a Table Of Contents line.
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
getSection($text, $sectionId, $defaultText= '')
This function returns the text of a section, specified by a number ($section).
static decodeTagAttributes($text)
Return an associative array of attribute names and values from a partial tag string.
killMarkers($text)
Remove any strip markers found in the given text.
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
static tocList($toc, $lang=false)
Wraps the TOC in a table and provides the hide/collapse javascript.
LinkRenderer $mLinkRenderer
fetchTemplateAndTitle($title)
Fetch the unparsed text of a template and register a reference to it.
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
getRevisionUser()
Get the name of the user that edited the last revision.
setFunctionTagHook($tag, $callback, $flags)
Create a tag function, e.g.
the array() calling protocol came about after MediaWiki 1.4rc1.
stripSectionName($text)
Strips a text string of wikitext for use in a section anchor.
Group all the pieces relevant to the context of a request into one instance.
getPreloadText($text, Title $title, ParserOptions $options, $params=[])
Process the wikitext for the "?preload=" feature.
validateSig($text)
Check that the user's signature contains no bad XML.
MapCacheLRU null $currentRevisionCache
getArticleID($flags=0)
Get the article ID for this Title from the link cache, adding it if necessary.
$wgSitename
Name of the site.
renderImageGallery($text, $params)
Renders an image gallery from a text with one line per image.
recursivePreprocess($text, $frame=false)
Recursive parser entry point that can be called from an extension tag hook.
replaceExternalLinks($text)
Replace external links (REL)
processing should stop and the error should be shown to the user * false
static isNonincludable($index)
It is not possible to use pages from this namespace as template?
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
static replaceUnusualEscapes($url)
Replace unusual escape codes in a URL with their equivalent characters.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
doHeadings($text)
Parse headers and return html.
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name If you don't need a full Title object...
static isWellFormedXmlFragment($text)
Check if a string is a well-formed XML fragment.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
fetchFileAndTitle($title, $options=[])
Fetch a file and its title and register a reference to it.
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server.Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use.Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves.The master writes thequery to the binlog when the transaction is committed.The slaves pollthe binlog and start executing the query as soon as it appears.They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes.Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load.MediaWiki's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database.All edits and other write operations will berefused, with an error returned to the user.This gives the slaves achance to catch up.Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order.A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests.This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it.Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in"lagged slave mode".Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode().The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time.Multi-row INSERT...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it's not practical to guarantee a low-lagenvironment.Lag will usually be less than one second, but mayoccasionally be up to 30 seconds.For scalability, it's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer.So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum.In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks.By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent.Locks willbe held from the time when the query is done until the commit.So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction.Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
initialiseVariables()
initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers ...
Set options of the Parser.
static tidy($text)
Interface with html tidy.
getFunctionHooks()
Get all registered function hook identifiers.
static fixTagAttributes($text, $element, $sorted=false)
Take a tag soup fragment listing an HTML element's attributes and normalize it to well-formed XML...
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
wfHostname()
Fetch server name for use in error reporting etc.
getFunctionLang()
Get a language object for use in parser functions such as {{FORMATNUM:}}.
argSubstitution($piece, $frame)
Triple brace replacement – used for template arguments.
testSrvus($text, Title $title, ParserOptions $options, $outputType=self::OT_HTML)
strip/replaceVariables/unstrip for preprocessor regression testing
uniqPrefix()
Accessor for mUniqPrefix.
Title($x=null)
Accessor/mutator for the Title object.
SectionProfiler $mProfiler
fetchFileNoRegister($title, $options=[])
Helper function for fetchFileAndTitle.
null for the local wiki Added in
There are three types of nodes:
clearTagHooks()
Remove all tag hooks.
static makeSelfLinkObj($nt, $html= '', $query= '', $trail= '', $prefix= '')
Make appropriate markup for a link to the current article.
clearState()
Clear Parser state.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context $revId
interwikiTransclude($title, $action)
Transclude an interwiki link.
pstPass2($text, $user)
Pre-save transform helper function.
guessLegacySectionNameFromWikiText($text)
Same as guessSectionNameFromWikiText(), but produces legacy anchors instead.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
wfUrlProtocolsWithoutProtRel()
Like wfUrlProtocols(), but excludes '//' from the protocol list.
Options($x=null)
Accessor/mutator for the ParserOptions object.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
serializeHalfParsedText($text)
Save the parser state required to convert the given half-parsed text to HTML.
replaceLinkHolders(&$text, $options=0)
Replace "" link placeholders with actual links, in the buffer Placeholders created in Link...
static statelessFetchRevision(Title $title, $parser=false)
Wrapper around Revision::newFromTitle to allow passing additional parameters without passing them on ...
doQuotes($text)
Helper function for doAllQuotes()
preprocessToDom($text, $flags=0)
Preprocess some wikitext and return the document tree.
limitationWarn($limitationType, $current= '', $max= '')
Warn the user when a parser limitation is reached Will warn at most once the user per limitation type...
wfUrlencode($s)
We want some things to be included as literal characters in our title URLs for prettiness, which urlencode encodes by default.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
static getRandomString()
Get a random string.
static stripAllTags($text)
Take a fragment of (potentially invalid) HTML and return a version with any tags removed, encoded as plain text.
when a variable name is used in a it is silently declared as a new local masking the global
doBlockLevels($text, $linestart)
Make lists from lines starting with ':', '*', '#', etc.
OutputType($x=null)
Accessor/mutator for the output type.
getLinkRenderer()
Get a LinkRenderer instance to make links with.
static newFromTitle(LinkTarget $linkTarget, $id=0, $flags=0)
Load either the current, or a specified, revision that's attached to a given link target...
getVariableValue($index, $frame=false)
Return value of a magic variable (like PAGENAME)
recursiveTagParse($text, $frame=false)
Half-parse wikitext to half-parsed HTML.
MagicWordArray $mVariables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new revision
static validateTagAttributes($attribs, $element)
Take an array of attribute names and values and normalize or discard illegal values for the given ele...
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 For a description of the see design txt $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
wfRandomString($length=32)
Get a random string containing a number of pseudo-random hex characters.
preprocess($text, Title $title=null, ParserOptions $options, $revid=null, $frame=false)
Expand templates and variables in the text, producing valid, static wikitext.
static getCacheTTL($id)
Allow external reads of TTL array.
getRevisionId()
Get the ID of the revision we are parsing.
maybeDoSubpageLink($target, &$text)
Handle link to subpage if necessary.
If you want to remove the page from your watchlist later
replaceLinkHoldersText($text)
Replace "" link placeholders with plain text of links (not HTML-formatted).
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static createAssocArgs($args)
Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
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. '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 '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!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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
static getLocalInstance($ts=false)
Get a timestamp instance in the server local timezone ($wgLocaltimezone)
static getDoubleUnderscoreArray()
Get a MagicWordArray of double-underscore entities.
static splitTrail($trail)
Split a link trail, return the "inside" portion and the remainder of the trail as a two-element array...
getTemplateDom($title)
Get the semi-parsed DOM representation of a template with a given title, and its redirect destination...
usually copyright or history_copyright This message must be in HTML not wikitext & $link
static decodeCharReferences($text)
Decode any character references, numeric or named entities, in the text and return a UTF-8 string...
cleanSig($text, $parsing=false)
Clean up signature text.
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static factory($mode=false, IContextSource $context=null)
Get a new image gallery.
$wgLanguageCode
Site language code.
Custom PHP profiler for parser/DB type section names that xhprof/xdebug can't handle.
static getPage($name)
Find the object with a given name and return it (or NULL)
$wgExtraInterlanguageLinkPrefixes
List of additional interwiki prefixes that should be treated as interlanguage links (i...
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 ...
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
addTrackingCategory($msg)
replaceInternalLinks($s)
Process [[ ]] wikilinks.
$wgStylePath
The URL path of the skins directory.
disableCache()
Set a flag in the output object indicating that the content is dynamic and shouldn't be cached...
static normalizeSectionNameWhitespace($section)
Normalizes whitespace in a section name, such as might be returned by Parser::stripSectionName(), for use in the id's that are used for section links.
internalParse($text, $isMain=true, $frame=false)
Helper function for parse() that transforms wiki markup into half-parsed HTML.
static delimiterReplace($startDelim, $endDelim, $replace, $subject, $flags= '')
Perform an operation equivalent to preg_replace() with flags.
__destruct()
Reduce memory usage to reduce the impact of circular references.
wfEscapeWikiText($text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
getRevisionTimestamp()
Get the timestamp associated with the current revision, adjusted for the default server-local timesta...
static stripOuterParagraph($html)
Strip outer.
static singleton()
Get an instance of this class.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database key
static normalizeSubpageLink($contextTitle, $target, &$text)
parseWidthParam($value)
Parsed a width param of imagelink like 300px or 200x300px.
fetchScaryTemplateMaybeFromCache($url)
fetchCurrentRevisionOfTitle($title)
Fetch the current revision of a given title.
stripAltText($caption, $holders)
doAllQuotes($text)
Replace single quotes with HTML markup.
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 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 unsetoffset-wrap String Wrap the message in html(usually something like"<
static replaceMarkup($search, $replace, $text)
More or less "markup-safe" str_replace() Ignores any instances of the separator inside <...
static normalizeUrlComponent($component, $unsafe)
const VERSION
Update this version number when the ParserOutput format changes in an incompatible way...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
setHook($tag, $callback)
Create an HTML-style tag, e.g.
Preprocessor $mPreprocessor
getPreprocessor()
Get a preprocessor object.
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
static getInstance($ts=false)
Get a timestamp instance in GMT.
static singleton()
Get a RepoGroup instance.
replaceVariables($text, $frame=false, $argsOnly=false)
Replace magic variables, templates, and template arguments with the appropriate text.
wfMatchesDomainList($url, $domains)
Check whether a given URL has a domain that occurs in a given set of domains.
getUser()
Get a User object either from $this->mUser, if set, or from the ParserOptions object otherwise...
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
incrementIncludeSize($type, $size)
Increment an include size counter.
getStripList()
Get a list of strippable XML-like elements.
startParse(Title $title=null, ParserOptions $options, $outputType, $clearState=true)
static makeHeadline($level, $attribs, $anchor, $html, $link, $fallbackAnchor=false)
Create a headline for content.
static extractTagsAndParams($elements, $text, &$matches, $uniq_prefix=null)
Replaces all occurrences of HTML-style comments and the given tags in the text with a random marker a...
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
doTableStuff($text)
parse the wiki syntax used to render tables
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getRevisionSize()
Get the size of the revision.
LinkHolderArray $mLinkHolders
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
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
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
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
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...
static capturePath(Title $title, IContextSource $context, LinkRenderer $linkRenderer=null)
Just like executePath() but will override global variables and execute the page in "inclusion" mode...
getTargetLanguage()
Get the target language for the content being parsed.
namespace and then decline to actually register it file or subcat img or subcat $title
static newKnownCurrent(IDatabase $db, $pageId, $revId)
Load a revision based on a known page ID and current revision ID from the DB.
static hasSubpages($index)
Does the namespace allow subpages?
formatHeadings($text, $origText, $isMain=true)
This function accomplishes several tasks: 1) Auto-number headings if that option is enabled 2) Add an...
getConverterLanguage()
Get the language object for language conversion.
static tocUnindent($level)
Finish one or more sublevels on the Table of Contents.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
static tocLine($anchor, $tocline, $tocnumber, $level, $sectionIndex=false)
parameter level defines if we are on an indentation level
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
magicword txt Magic Words are some phrases used in the wikitext They are used for two things
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books $tag
getUserSig(&$user, $nickname=false, $fancySig=null)
Fetch the user's signature text, if any, and normalize to validated, ready-to-insert wikitext...
const HALF_PARSED_VERSION
Update this version number when the output of serialiseHalfParsedText() changes in an incompatible wa...
firstCallInit()
Do various kinds of initialisation on the first call of the parser.
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...
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
armorLinks($text)
Insert a NOPARSE hacky thing into any inline links in a chunk that's going to go through further pars...
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
static splitWhitespace($s)
Return a three-element array: leading whitespace, string contents, trailing whitespace.
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
setOutputType($ot)
Set the output type.
Class for handling an array of magic words.
static & get($id)
Factory: creates an object representing an ID.
enableOOUI()
Set's up the PHP implementation of OOUI for use in this request and instructs OutputPage to enable OO...
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive false for true for descending in case the handler function wants to provide a converted Content object Note that $result getContentModel() must return $toModel. 'CustomEditor'$rcid is used in generating this variable which contains information about the new such as the revision s whether the revision was marked as a minor edit or not
fetchTemplate($title)
Fetch the unparsed text of a template and register a reference to it.
maybeMakeExternalImage($url)
make an image if it's allowed, either through the global option, through the exception, or through the on-wiki whitelist
areSubpagesAllowed()
Return true if subpage links should be expanded on this page.
static escapeId($id, $options=[])
Given a value, escape it so that it can be used in an id attribute and return it. ...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
static getSubstIDs()
Get an array of parser substitution modifier IDs.
transformMsg($text, $options, $title=null)
Wrapper for preprocess()
static newFromId($id, $flags=0)
Load a page revision from a given revision ID number.
wfUrlProtocols($includeProtocolRelative=true)
Returns a regular expression of url protocols.
static makeExternalLink($url, $text, $escape=true, $linktype= '', $attribs=[], $title=null)
Make an external link.
__clone()
Allow extensions to clean up when the parser is cloned.
static getExternalLinkRel($url=false, $title=null)
Get the rel attribute for a particular external link.
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
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...
this hook is for auditing only $req
this hook is for auditing only or null if authentication failed before getting that far $username
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
array $mLangLinkLanguages
Array with the language name of each language link (i.e.
replaceTransparentTags($text)
Replace transparent tags in $text with the values given by the callbacks.
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
replaceSection($oldText, $sectionId, $newText)
This function returns $oldtext after the content of the section specified by $section has been replac...
doDoubleUnderscore($text)
Strip double-underscore items like NOGALLERY and NOTOC Fills $this->mDoubleUnderscores, returns the modified text.
static removeHTMLtags($text, $processCallback=null, $args=[], $extratags=[], $removetags=[], $warnCallback=null)
Cleans up HTML, removes dangerous tags and attributes, and removes HTML comments. ...
testPreprocess($text, Title $title, ParserOptions $options)
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
MagicWordArray $mSubstWords
static normalizeCharReferences($text)
Ensure that any entities and character references are legal for XML and XHTML specifically.
callParserFunction($frame, $function, array $args=[])
Call a parser function and return an array with text and flags.
$wgScriptPath
The path we should point to.
Variant of the Message class.
getFreshParser()
Return this parser if it is not doing anything, otherwise get a fresh parser.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling but I prefer the flexibility This should also do the output encoding The system allocates a global one in $wgOut Title Represents the title of an and does all the work of translating among various forms such as plain database etc For and for historical it also represents a few features of articles that don t involve their such as access rights See also title txt Article Encapsulates access to the page table of the database The object represents a an and maintains state such as etc Revision Encapsulates individual page revision data and access to the revision text blobs storage system Higher level code should never touch text storage directly
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
lock()
Lock the current instance of the parser.
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...
static statelessFetchTemplate($title, $parser=false)
Static function to get a template Can be overridden via ParserOptions::setTemplateCallback().
I won t presume to tell you how to I m just describing the methods I chose to use for myself If you do choose to follow these it will probably be easier for you to collaborate with others on the but if you want to contribute without by all means do which work well I also use K &R brace matching style I know that s a religious issue for so if you want to use a style that puts opening braces on the next line
setFunctionHook($id, $callback, $flags=0)
Create a function, e.g.
static setupOOUI($skinName= '', $dir= 'ltr')
Helper function to setup the PHP implementation of OOUI to use in this request.
static makeMediaLinkFile(Title $title, $file, $html= '')
Create a direct link to a given uploaded file.
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired 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 inclusive $limit
getTitle()
Accessor for the Title object.
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
extractSections($text, $sectionId, $mode, $newText= '')
Break wikitext input into sections, and either pull or replace some particular section's text...
getOutput()
Get the ParserOutput object.
$wgExperimentalHtmlIds
Should we allow a broader set of characters in id attributes, per HTML5? If not, use only HTML 4-comp...
doMagicLinks($text)
Replace special strings like "ISBN xxx" and "RFC xxx" with magic external links.
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
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
static cleanSigInSig($text)
Strip 3, 4 or 5 tildes out of signatures.
setDefaultSort($sort)
Mutator for $mDefaultSort.
fetchFile($title, $options=[])
Fetch a file and its title and register a reference to it.
static tocIndent()
Add another level to the Table of Contents.
static legalChars()
Get a regex character class describing the legal characters in a link.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all.It could be easily changed to send incrementally if that becomes useful
static doBlockLevels($text, $lineStart)
Make lists from lines starting with ':', '*', '#', etc.
$wgServer
URL of the server.
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
incrementExpensiveFunctionCount()
Increment the expensive function count.
getDisableTitleConversion()
static normalizeLinkUrl($url)
Replace unusual escape codes in a URL with their equivalent characters.
insertStripItem($text)
Add an item to the strip state Returns the unique tag which must be inserted into the stripped text T...
testPst($text, Title $title, ParserOptions $options)
static factory($url, $options=null, $caller=__METHOD__)
Generate a new request object.
if(!$wgRequest->checkUrlExtension()) if(isset($_SERVER['PATH_INFO'])&&$_SERVER['PATH_INFO']!= '') if(!$wgEnableAPI) $wgTitle
static explode($separator, $subject)
Workalike for explode() with limited memory usage.
parse($text, Title $title, ParserOptions $options, $linestart=true, $clearState=true, $revid=null)
Convert wikitext to HTML Do not call this function recursively.
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 numberingroup($group)
Find the number of users in a given user group.
=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
static getVersion($flags= '', $lang=null)
Return a string of the MediaWiki version with Git revision if available.
braceSubstitution($piece, $frame)
Return the text of a template, after recursively replacing any variables or templates within the temp...
setUser($user)
Set the current user.
makeImage($title, $options, $holders=false)
Parse image options text and use it to make an image.
attributeStripCallback(&$text, $frame=false)
Callback from the Sanitizer for expanding items found in HTML attribute values, so they can be safely...
static cascadingsources($parser, $title= '')
Returns the sources of any cascading protection acting on a specified page.
getCustomDefaultSort()
Accessor for $mDefaultSort Unlike getDefaultSort(), will return false if none is set.
extensionSubstitution($params, $frame)
Return the text to be used for a given extension tag.
static normalizeLineEndings($text)
Do a "\\r\\n" -> "\\n" and "\\r" -> "\\n" transformation as well as trim trailing whitespace...
static makeExternalImage($url, $alt= '')
Return the code for images which were added via external links, via Parser::maybeMakeExternalImage()...
recursiveTagParseFully($text, $frame=false)
Fully parse wikitext to fully parsed HTML.
setTransparentTagHook($tag, $callback)
As setHook(), but letting the contents be parsed.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
wfFindFile($title, $options=[])
Find a file.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
unserializeHalfParsedText($data)
Load the parser state given in the $data array, which is assumed to have been generated by serializeH...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
static makeTitle($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
guessSectionNameFromWikiText($text)
Try to guess the section anchor name based on a wikitext fragment presumably extracted from a heading...
see documentation in includes Linker php for Linker::makeImageLink & $time
$wgServerName
Server name.
internalParseHalfParsed($text, $isMain=true, $linestart=true)
Helper function for parse() that transforms half-parsed HTML into fully parsed HTML.
if the prop value should be in the metadata multi language array format
controlled by $wgMainCacheType controlled by $wgParserCacheType controlled by $wgMessageCacheType If you set CACHE_NONE to one of the three control variable
getOptions()
Get the ParserOptions object.
getDefaultSort()
Accessor for $mDefaultSort Will use the empty string if none is set.
For a write use something like
makeFreeExternalLink($url, $numPostProto)
Make a free external link, given a user-supplied URL.
Allows to change the fields on the form that will be generated $name