83 # Flags for Parser::setFunctionHook
87 # Constants needed for external link processing
88 # Everything except bracket, space, or control characters
89 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
90 # as well as U+3000 is IDEOGRAPHIC SPACE for bug 19052
92 # Simplified expression to match an IPv4 or IPv6 address, or
93 # at least one character of a host name (embeds EXT_LINK_URL_CLASS)
94 const EXT_LINK_ADDR =
'(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}])';
95 # RegExp to make image URLs (embeds IPv6 part of EXT_LINK_ADDR)
97 const EXT_IMAGE_REGEX =
'/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}]+)
98 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
101 # Regular expression for a non-newline space
104 # Flags for preprocessToDom
107 # Allowed values for $this->mOutputType
108 # Parameter to startExternalParse().
113 const
OT_PLAIN = 4;
# like extractSections() - portions of the original are returned unchanged.
132 const MARKER_SUFFIX =
"-QINU`\"'\x7f";
135 # Markers used for wrapping the table of contents
153 # Initialised by initialiseVariables()
164 # Initialised in constructor
167 # Initialized in getPreprocessor()
171 # Cleared with clearState():
202 # These are variables reset at least once per parse regardless of $clearState
215 public $mRevisionObject;
# The revision object of the specified revision ID
262 $this->mConf = $conf;
264 $this->mExtLinkBracketedRegex =
'/\[(((?i)' . $this->mUrlProtocols .
')' .
265 self::EXT_LINK_ADDR .
266 self::EXT_LINK_URL_CLASS .
'*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F]*?)\]/Su';
267 if ( isset( $conf[
'preprocessorClass'] ) ) {
268 $this->mPreprocessorClass = $conf[
'preprocessorClass'];
269 } elseif ( defined(
'HPHP_VERSION' ) ) {
270 # Preprocessor_Hash is much faster than Preprocessor_DOM under HipHop
271 $this->mPreprocessorClass =
'Preprocessor_Hash';
272 } elseif ( extension_loaded(
'domxml' ) ) {
273 # PECL extension that conflicts with the core DOM extension (bug 13770)
274 wfDebug(
"Warning: you have the obsolete domxml extension for PHP. Please remove it!\n" );
275 $this->mPreprocessorClass =
'Preprocessor_Hash';
276 } elseif ( extension_loaded(
'dom' ) ) {
277 $this->mPreprocessorClass =
'Preprocessor_DOM';
279 $this->mPreprocessorClass =
'Preprocessor_Hash';
281 wfDebug( __CLASS__ .
": using preprocessor: {$this->mPreprocessorClass}\n" );
288 if ( isset( $this->mLinkHolders ) ) {
289 unset( $this->mLinkHolders );
292 unset( $this->
$name );
300 $this->mInParse =
false;
308 foreach ( [
'mStripState',
'mVarCache' ]
as $k ) {
323 if ( !$this->mFirstCall ) {
326 $this->mFirstCall =
false;
332 Hooks::run(
'ParserFirstCallInit', [ &$this ] );
341 if ( $this->mFirstCall ) {
345 $this->mOptions->registerWatcher( [ $this->mOutput,
'recordOption' ] );
346 $this->mAutonumber = 0;
347 $this->mIncludeCount = [];
350 $this->mRevisionObject = $this->mRevisionTimestamp =
351 $this->mRevisionId = $this->mRevisionUser = $this->mRevisionSize = null;
352 $this->mVarCache = [];
354 $this->mLangLinkLanguages = [];
355 $this->currentRevisionCache = null;
359 # Clear these on every parse, bug 4549
360 $this->mTplRedirCache = $this->mTplDomCache = [];
362 $this->mShowToc =
true;
363 $this->mForceTocPosition =
false;
364 $this->mIncludeSizes = [
368 $this->mPPNodeCount = 0;
369 $this->mGeneratedPPNodeCount = 0;
370 $this->mHighestExpansionDepth = 0;
371 $this->mDefaultSort =
false;
372 $this->mHeadings = [];
373 $this->mDoubleUnderscores = [];
374 $this->mExpensiveFunctionCount = 0;
377 if ( isset( $this->mPreprocessor ) && $this->mPreprocessor->parser !== $this ) {
378 $this->mPreprocessor = null;
399 $linestart =
true, $clearState =
true, $revid = null
411 $text = strtr( $text,
"\x7f",
"?" );
412 $magicScopeVariable = $this->
lock();
417 $this->currentRevisionCache = null;
418 $this->mInputSize = strlen( $text );
419 if ( $this->mOptions->getEnableLimitReport() ) {
420 $this->mOutput->resetParseStartTime();
428 if ( $revid !== null ) {
429 $this->mRevisionId = $revid;
430 $this->mRevisionObject = null;
431 $this->mRevisionTimestamp = null;
432 $this->mRevisionUser = null;
433 $this->mRevisionSize = null;
436 Hooks::run(
'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
438 Hooks::run(
'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
440 Hooks::run(
'ParserAfterParse', [ &$this, &$text, &$this->mStripState ] );
452 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] )
453 || isset( $this->mDoubleUnderscores[
'notitleconvert'] )
454 || $this->mOutput->getDisplayTitle() !==
false )
457 if ( $convruletitle ) {
458 $this->mOutput->setTitleText( $convruletitle );
461 $this->mOutput->setTitleText( $titleText );
465 if ( $this->mExpensiveFunctionCount > $this->mOptions->getExpensiveParserFunctionLimit() ) {
467 $this->mExpensiveFunctionCount,
468 $this->mOptions->getExpensiveParserFunctionLimit()
472 # Information on include size limits, for the benefit of users who try to skirt them
473 if ( $this->mOptions->getEnableLimitReport() ) {
474 $max = $this->mOptions->getMaxIncludeSize();
476 $cpuTime = $this->mOutput->getTimeSinceStart(
'cpu' );
477 if ( $cpuTime !== null ) {
478 $this->mOutput->setLimitReportData(
'limitreport-cputime',
479 sprintf(
"%.3f", $cpuTime )
483 $wallTime = $this->mOutput->getTimeSinceStart(
'wall' );
484 $this->mOutput->setLimitReportData(
'limitreport-walltime',
485 sprintf(
"%.3f", $wallTime )
488 $this->mOutput->setLimitReportData(
'limitreport-ppvisitednodes',
489 [ $this->mPPNodeCount, $this->mOptions->getMaxPPNodeCount() ]
491 $this->mOutput->setLimitReportData(
'limitreport-ppgeneratednodes',
492 [ $this->mGeneratedPPNodeCount, $this->mOptions->getMaxGeneratedPPNodeCount() ]
494 $this->mOutput->setLimitReportData(
'limitreport-postexpandincludesize',
495 [ $this->mIncludeSizes[
'post-expand'], $max ]
497 $this->mOutput->setLimitReportData(
'limitreport-templateargumentsize',
498 [ $this->mIncludeSizes[
'arg'], $max ]
500 $this->mOutput->setLimitReportData(
'limitreport-expansiondepth',
501 [ $this->mHighestExpansionDepth, $this->mOptions->getMaxPPExpandDepth() ]
503 $this->mOutput->setLimitReportData(
'limitreport-expensivefunctioncount',
504 [ $this->mExpensiveFunctionCount,
505 $this->mOptions->getExpensiveParserFunctionLimit() ]
507 Hooks::run(
'ParserLimitReportPrepare', [ $this, $this->mOutput ] );
510 Hooks::run(
'ParserLimitReport', [ $this, &$limitReport ] );
511 if ( $limitReport !=
'' ) {
514 $limitReport = str_replace( [
'-',
'&' ], [
'‐',
'&' ], $limitReport );
515 $text .=
"\n<!-- \nNewPP limit report\n$limitReport-->\n";
519 $dataByFunc = $this->mProfiler->getFunctionStats();
520 uasort( $dataByFunc,
function ( $a, $b ) {
521 return $a[
'real'] < $b[
'real'];
524 foreach ( array_slice( $dataByFunc, 0, 10 )
as $item ) {
525 $profileReport[] = sprintf(
"%6.2f%% %8.3f %6d %s",
526 $item[
'%real'], $item[
'real'], $item[
'calls'], $item[
'name'] );
528 $this->mOutput->setLimitReportData(
'limitreport-timingprofile', $profileReport );
531 if ( $wgShowHostnames ) {
532 $this->mOutput->setLimitReportData(
'cachereport-origin',
wfHostname() );
534 $this->mOutput->setLimitReportData(
'cachereport-timestamp',
535 $this->mOutput->getCacheTime() );
536 $this->mOutput->setLimitReportData(
'cachereport-ttl',
537 $this->mOutput->getCacheExpiry() );
538 $this->mOutput->setLimitReportData(
'cachereport-transientcontent',
539 $this->mOutput->hasDynamicContent() );
541 if ( $this->mGeneratedPPNodeCount
542 > $this->mOptions->getMaxGeneratedPPNodeCount() / 10
544 wfDebugLog(
'generated-pp-node-count', $this->mGeneratedPPNodeCount .
' ' .
545 $this->mTitle->getPrefixedDBkey() );
548 $this->mOutput->setText( $text );
550 $this->mRevisionId = $oldRevisionId;
551 $this->mRevisionObject = $oldRevisionObject;
552 $this->mRevisionTimestamp = $oldRevisionTimestamp;
553 $this->mRevisionUser = $oldRevisionUser;
554 $this->mRevisionSize = $oldRevisionSize;
555 $this->mInputSize =
false;
556 $this->currentRevisionCache = null;
584 Hooks::run(
'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
585 Hooks::run(
'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
627 $magicScopeVariable = $this->
lock();
629 if ( $revid !== null ) {
630 $this->mRevisionId = $revid;
632 Hooks::run(
'ParserBeforeStrip', [ &$this, &$text, &$this->mStripState ] );
633 Hooks::run(
'ParserAfterStrip', [ &$this, &$text, &$this->mStripState ] );
635 $text = $this->mStripState->unstripBoth( $text );
650 $text = $this->mStripState->unstripBoth( $text );
669 $text = $msg->params(
$params )->plain();
671 # Parser (re)initialisation
672 $magicScopeVariable = $this->
lock();
678 $text = $this->mStripState->unstripBoth( $text );
700 $this->mUser =
$user;
711 return self::MARKER_PREFIX;
724 if (
$t->hasFragment() ) {
725 # Strip the fragment to avoid various odd effects
726 $this->mTitle =
$t->createFragmentTarget(
'' );
747 public function Title( $x = null ) {
748 return wfSetVar( $this->mTitle, $x );
757 $this->mOutputType =
$ot;
774 return wfSetVar( $this->mOutputType, $x );
802 return wfSetVar( $this->mOptions, $x );
809 return $this->mLinkID++;
816 $this->mLinkID = $id;
837 $target = $this->mOptions->getTargetLanguage();
839 if ( $target !== null ) {
841 } elseif ( $this->mOptions->getInterfaceMessage() ) {
842 return $this->mOptions->getUserLangObj();
843 } elseif ( is_null( $this->mTitle ) ) {
844 throw new MWException( __METHOD__ .
': $this->mTitle is null' );
847 return $this->mTitle->getPageLanguage();
865 if ( !is_null( $this->mUser ) ) {
868 return $this->mOptions->getUser();
877 if ( !isset( $this->mPreprocessor ) ) {
878 $class = $this->mPreprocessorClass;
879 $this->mPreprocessor =
new $class( $this );
891 if ( !$this->mLinkRenderer ) {
892 $this->mLinkRenderer = MediaWikiServices::getInstance()
893 ->getLinkRendererFactory()->create();
894 $this->mLinkRenderer->setStubThreshold(
924 if ( $uniq_prefix !== null ) {
925 wfDeprecated( __METHOD__ .
' called with $prefix argument',
'1.26' );
931 $taglist = implode(
'|', $elements );
932 $start =
"/<($taglist)(\\s+[^>]*?|\\s*?)(\/?" .
">)|<(!--)/i";
934 while ( $text !=
'' ) {
935 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE );
937 if ( count( $p ) < 5 ) {
940 if ( count( $p ) > 5 ) {
954 $marker = self::MARKER_PREFIX .
"-$element-" . sprintf(
'%08X', $n++ ) . self::MARKER_SUFFIX;
955 $stripped .= $marker;
957 if ( $close ===
'/>' ) {
958 # Empty element tag, <tag />
963 if ( $element ===
'!--' ) {
966 $end =
"/(<\\/$element\\s*>)/i";
968 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE );
970 if ( count( $q ) < 3 ) {
971 # No end tag -- let it run out to the end of the text.
983 "<$element$attributes$close$content$tail" ];
1007 $marker = self::MARKER_PREFIX .
"-item-{$this->mMarkerIndex}-" . self::MARKER_SUFFIX;
1008 $this->mMarkerIndex++;
1009 $this->mStripState->addGeneral( $marker, $text );
1022 $lines = StringUtils::explode(
"\n", $text );
1024 $td_history = []; # Is currently a td tag
open?
1025 $last_tag_history = []; # Save
history of last lag activated (td, th
or caption)
1026 $tr_history = []; # Is currently a tr tag
open?
1027 $tr_attributes = []; #
history of tr attributes
1028 $has_opened_tr = []; # Did
this table open a <tr> element?
1029 $indent_level = 0; # indent level
of the table
1032 $line = trim( $outLine );
1034 if (
$line ===
'' ) { # empty
line, go to next line
1035 $out .= $outLine .
"\n";
1039 $first_character =
$line[0];
1040 $first_two = substr(
$line, 0, 2 );
1043 if ( preg_match(
'/^(:*)\s*\{\|(.*)$/',
$line,
$matches ) ) {
1044 # First check if we are starting a new table
1045 $indent_level = strlen(
$matches[1] );
1047 $attributes = $this->mStripState->unstripBoth(
$matches[2] );
1050 $outLine = str_repeat(
'<dl><dd>', $indent_level ) .
"<table{$attributes}>";
1051 array_push( $td_history,
false );
1052 array_push( $last_tag_history,
'' );
1053 array_push( $tr_history,
false );
1054 array_push( $tr_attributes,
'' );
1055 array_push( $has_opened_tr,
false );
1056 } elseif ( count( $td_history ) == 0 ) {
1057 # Don't do any of the following
1058 $out .= $outLine .
"\n";
1060 } elseif ( $first_two ===
'|}' ) {
1061 # We are ending a table
1063 $last_tag = array_pop( $last_tag_history );
1065 if ( !array_pop( $has_opened_tr ) ) {
1066 $line =
"<tr><td></td></tr>{$line}";
1069 if ( array_pop( $tr_history ) ) {
1070 $line =
"</tr>{$line}";
1073 if ( array_pop( $td_history ) ) {
1074 $line =
"</{$last_tag}>{$line}";
1076 array_pop( $tr_attributes );
1077 $outLine =
$line . str_repeat(
'</dd></dl>', $indent_level );
1078 } elseif ( $first_two ===
'|-' ) {
1079 # Now we have a table row
1080 $line = preg_replace(
'#^\|-+#',
'',
$line );
1082 # Whats after the tag is now only attributes
1083 $attributes = $this->mStripState->unstripBoth(
$line );
1085 array_pop( $tr_attributes );
1086 array_push( $tr_attributes, $attributes );
1089 $last_tag = array_pop( $last_tag_history );
1090 array_pop( $has_opened_tr );
1091 array_push( $has_opened_tr,
true );
1093 if ( array_pop( $tr_history ) ) {
1097 if ( array_pop( $td_history ) ) {
1098 $line =
"</{$last_tag}>{$line}";
1102 array_push( $tr_history,
false );
1103 array_push( $td_history,
false );
1104 array_push( $last_tag_history,
'' );
1105 } elseif ( $first_character ===
'|'
1106 || $first_character ===
'!'
1107 || $first_two ===
'|+'
1109 # This might be cell elements, td, th or captions
1110 if ( $first_two ===
'|+' ) {
1111 $first_character =
'+';
1118 if ( $first_character ===
'!' ) {
1119 $line = StringUtils::replaceMarkup(
'!!',
'||',
$line );
1122 # Split up multiple cells on the same line.
1123 # FIXME : This can result in improper nesting of tags processed
1124 # by earlier parser steps.
1125 $cells = explode(
'||',
$line );
1129 # Loop through each table cell
1130 foreach ( $cells
as $cell ) {
1132 if ( $first_character !==
'+' ) {
1133 $tr_after = array_pop( $tr_attributes );
1134 if ( !array_pop( $tr_history ) ) {
1135 $previous =
"<tr{$tr_after}>\n";
1137 array_push( $tr_history,
true );
1138 array_push( $tr_attributes,
'' );
1139 array_pop( $has_opened_tr );
1140 array_push( $has_opened_tr,
true );
1143 $last_tag = array_pop( $last_tag_history );
1145 if ( array_pop( $td_history ) ) {
1146 $previous =
"</{$last_tag}>\n{$previous}";
1149 if ( $first_character ===
'|' ) {
1151 } elseif ( $first_character ===
'!' ) {
1153 } elseif ( $first_character ===
'+' ) {
1154 $last_tag =
'caption';
1159 array_push( $last_tag_history, $last_tag );
1161 # A cell could contain both parameters and data
1162 $cell_data = explode(
'|', $cell, 2 );
1164 # Bug 553: Note that a '|' inside an invalid link should not
1165 # be mistaken as delimiting cell parameters
1166 if ( strpos( $cell_data[0],
'[[' ) !==
false ) {
1167 $cell =
"{$previous}<{$last_tag}>{$cell}";
1168 } elseif ( count( $cell_data ) == 1 ) {
1169 $cell =
"{$previous}<{$last_tag}>{$cell_data[0]}";
1171 $attributes = $this->mStripState->unstripBoth( $cell_data[0] );
1173 $cell =
"{$previous}<{$last_tag}{$attributes}>{$cell_data[1]}";
1177 array_push( $td_history,
true );
1180 $out .= $outLine .
"\n";
1183 # Closing open td, tr && table
1184 while ( count( $td_history ) > 0 ) {
1185 if ( array_pop( $td_history ) ) {
1188 if ( array_pop( $tr_history ) ) {
1191 if ( !array_pop( $has_opened_tr ) ) {
1192 $out .=
"<tr><td></td></tr>\n";
1195 $out .=
"</table>\n";
1198 # Remove trailing line-ending (b/c)
1199 if ( substr(
$out, -1 ) ===
"\n" ) {
1203 # special case: don't return empty table
1204 if (
$out ===
"<table>\n<tr><td></td></tr>\n</table>" ) {
1227 # Hook to suspend the parser in this state
1228 if ( !
Hooks::run(
'ParserBeforeInternalParse', [ &$this, &$text, &$this->mStripState ] ) ) {
1232 # if $frame is provided, then use $frame for replacing any variables
1234 # use frame depth to infer how include/noinclude tags should be handled
1235 # depth=0 means this is the top-level document; otherwise it's an included document
1236 if ( !$frame->depth ) {
1242 $text = $frame->expand( $dom );
1244 # if $frame is not provided, then use old-style replaceVariables
1248 Hooks::run(
'InternalParseBeforeSanitize', [ &$this, &$text, &$this->mStripState ] );
1251 [ &$this,
'attributeStripCallback' ],
1253 array_keys( $this->mTransparentTagHooks ),
1255 [ &$this,
'addTrackingCategory' ]
1257 Hooks::run(
'InternalParseBeforeLinks', [ &$this, &$text, &$this->mStripState ] );
1259 # Tables need to come after variable replacement for things to work
1260 # properly; putting them before other transformations should keep
1261 # exciting things like link expansions from showing up in surprising
1265 $text = preg_replace(
'/(^|\n)-----*/',
'\\1<hr />', $text );
1274 # replaceInternalLinks may sometimes leave behind
1275 # absolute URLs, which have to be masked to hide them from replaceExternalLinks
1276 $text = str_replace( self::MARKER_PREFIX .
'NOPARSE',
'', $text );
1294 $text = $this->mStripState->unstripGeneral( $text );
1297 Hooks::run(
'ParserAfterUnstrip', [ &$this, &$text ] );
1300 # Clean up special characters, only run once, next-to-last before doBlockLevels
1302 # french spaces, last one Guillemet-left
1303 # only if there is something before the space
1304 '/(.) (?=\\?|:|;|!|%|\\302\\273)/' =>
'\\1 ',
1305 # french spaces, Guillemet-right
1306 '/(\\302\\253) /' =>
'\\1 ',
1307 '/ (!\s*important)/' =>
' \\1', # Beware
of CSS magic word !important, bug #11874.
1309 $text = preg_replace( array_keys( $fixtags ), array_values( $fixtags ), $text );
1322 if ( !( $this->mOptions->getDisableContentConversion()
1323 || isset( $this->mDoubleUnderscores[
'nocontentconvert'] ) )
1325 if ( !$this->mOptions->getInterfaceMessage() ) {
1326 # The position of the convert() call should not be changed. it
1327 # assumes that the links are all replaced and the only thing left
1328 # is the <nowiki> mark.
1333 $text = $this->mStripState->unstripNoWiki( $text );
1336 Hooks::run(
'ParserBeforeTidy', [ &$this, &$text ] );
1340 $text = $this->mStripState->unstripGeneral( $text );
1345 if ( $this->mOptions->getTidy() ) {
1349 # attempt to sanitize at least some nesting problems
1350 # (bug #2702 and quite a few others)
1352 # ''Something [http://www.cool.com cool''] -->
1353 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
1354 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
1355 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
1356 # fix up an anchor inside another anchor, only
1357 # at least for a single single nested link (bug 3695)
1358 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
1359 '\\1\\2</a>\\3</a>\\1\\4</a>',
1360 # fix div inside inline elements- doBlockLevels won't wrap a line which
1361 # contains a div, so fix it up here; replace
1362 # div with escaped text
1363 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
1364 '\\1\\3<div\\5>\\6</div>\\8\\9',
1365 # remove empty italic or bold tag pairs, some
1366 # introduced by rules above
1367 '/<([bi])><\/\\1>/' =>
'',
1370 $text = preg_replace(
1371 array_keys( $tidyregs ),
1372 array_values( $tidyregs ),
1377 Hooks::run(
'ParserAfterTidy', [ &$this, &$text ] );
1396 $urlChar = self::EXT_LINK_URL_CLASS;
1397 $addr = self::EXT_LINK_ADDR;
1398 $space = self::SPACE_NOT_NL; # non-newline space
1399 $spdash =
"(?:-|$space)"; # a dash
or a non-newline space
1400 $spaces =
"$space++"; # possessive match
of 1
or more spaces
1401 $text = preg_replace_callback(
1403 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1404 (<.*?>) | # m[2]: Skip stuff inside
1405 # HTML elements' .
"
1406 (\b(?i:$prots)($addr$urlChar*)) | # m[3]: Free external links
1407 # m[4]: Post-protocol path
1408 \b(?:RFC|PMID) $spaces # m[5]: RFC or PMID, capture number
1410 \bISBN $spaces ( # m[6]: ISBN, capture number
1411 (?: 97[89] $spdash? )? # optional 13-digit ISBN prefix
1412 (?: [0-9] $spdash? ){9} # 9 digits with opt. delimiters
1413 [0-9Xx] # check digit
1415 )!xu", [ &$this,
'magicLinkCallback' ], $text );
1425 if ( isset( $m[1] ) && $m[1] !==
'' ) {
1428 } elseif ( isset( $m[2] ) && $m[2] !==
'' ) {
1431 } elseif ( isset( $m[3] ) && $m[3] !==
'' ) {
1432 # Free external link
1434 } elseif ( isset( $m[5] ) && $m[5] !==
'' ) {
1436 if ( substr( $m[0], 0, 3 ) ===
'RFC' ) {
1439 $cssClass =
'mw-magiclink-rfc';
1441 } elseif ( substr( $m[0], 0, 4 ) ===
'PMID' ) {
1443 $urlmsg =
'pubmedurl';
1444 $cssClass =
'mw-magiclink-pmid';
1447 throw new MWException( __METHOD__ .
': unrecognised match type "' .
1448 substr( $m[0], 0, 20 ) .
'"' );
1450 $url =
wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1452 } elseif ( isset( $m[6] ) && $m[6] !==
'' ) {
1455 $space = self::SPACE_NOT_NL; # non-newline space
1456 $isbn = preg_replace(
"/$space/",
' ', $isbn );
1457 $num = strtr( $isbn, [
1466 'class' =>
'internal mw-magiclink-isbn',
1487 # The characters '<' and '>' (which were escaped by
1488 # removeHTMLtags()) should not be included in
1489 # URLs, per RFC 2396.
1490 # Make terminate a URL as well (bug T84937)
1493 '/&(lt|gt|nbsp|#x0*(3[CcEe]|[Aa]0)|#0*(60|62|160));/',
1498 $trail = substr( $url, $m2[0][1] ) . $trail;
1499 $url = substr( $url, 0, $m2[0][1] );
1502 # Move trailing punctuation to $trail
1504 # If there is no left bracket, then consider right brackets fair game too
1505 if ( strpos( $url,
'(' ) ===
false ) {
1509 $urlRev = strrev( $url );
1510 $numSepChars = strspn( $urlRev, $sep );
1511 # Don't break a trailing HTML entity by moving the ; into $trail
1512 # This is in hot code, so use substr_compare to avoid having to
1513 # create a new string object for the comparison
1514 if ( $numSepChars && substr_compare( $url,
";", -$numSepChars, 1 ) === 0 ) {
1515 # more optimization: instead of running preg_match with a $
1516 # anchor, which can be slow, do the match on the reversed
1517 # string starting at the desired offset.
1518 # un-reversed regexp is: /&([a-z]+|#x[\da-f]+|#\d+)$/i
1519 if ( preg_match(
'/\G([a-z]+|[\da-f]+x#|\d+#)&/i', $urlRev, $m2, 0, $numSepChars ) ) {
1523 if ( $numSepChars ) {
1524 $trail = substr( $url, -$numSepChars ) . $trail;
1525 $url = substr( $url, 0, -$numSepChars );
1528 # Verify that we still have a real URL after trail removal, and
1529 # not just lone protocol
1530 if ( strlen( $trail ) >= $numPostProto ) {
1531 return $url . $trail;
1536 # Is this an external image?
1538 if ( $text ===
false ) {
1539 # Not an image, make a link
1544 # Register it in the output object...
1545 # Replace unnecessary URL escape codes with their equivalent characters
1546 $pasteurized = self::normalizeLinkUrl( $url );
1547 $this->mOutput->addExternalLink( $pasteurized );
1549 return $text . $trail;
1562 for ( $i = 6; $i >= 1; --$i ) {
1563 $h = str_repeat(
'=', $i );
1564 $text = preg_replace(
"/^$h(.+)$h\\s*$/m",
"<h$i>\\1</h$i>", $text );
1579 $lines = StringUtils::explode(
"\n", $text );
1581 $outtext .= $this->
doQuotes( $line ) .
"\n";
1583 $outtext = substr( $outtext, 0, -1 );
1595 $arr = preg_split(
"/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1596 $countarr = count( $arr );
1597 if ( $countarr == 1 ) {
1606 for ( $i = 1; $i < $countarr; $i += 2 ) {
1607 $thislen = strlen( $arr[$i] );
1611 if ( $thislen == 4 ) {
1612 $arr[$i - 1] .=
"'";
1615 } elseif ( $thislen > 5 ) {
1619 $arr[$i - 1] .= str_repeat(
"'", $thislen - 5 );
1624 if ( $thislen == 2 ) {
1626 } elseif ( $thislen == 3 ) {
1628 } elseif ( $thislen == 5 ) {
1638 if ( ( $numbold % 2 == 1 ) && ( $numitalics % 2 == 1 ) ) {
1639 $firstsingleletterword = -1;
1640 $firstmultiletterword = -1;
1642 for ( $i = 1; $i < $countarr; $i += 2 ) {
1643 if ( strlen( $arr[$i] ) == 3 ) {
1644 $x1 = substr( $arr[$i - 1], -1 );
1645 $x2 = substr( $arr[$i - 1], -2, 1 );
1646 if ( $x1 ===
' ' ) {
1647 if ( $firstspace == -1 ) {
1650 } elseif ( $x2 ===
' ' ) {
1651 $firstsingleletterword = $i;
1656 if ( $firstmultiletterword == -1 ) {
1657 $firstmultiletterword = $i;
1664 if ( $firstsingleletterword > -1 ) {
1665 $arr[$firstsingleletterword] =
"''";
1666 $arr[$firstsingleletterword - 1] .=
"'";
1667 } elseif ( $firstmultiletterword > -1 ) {
1669 $arr[$firstmultiletterword] =
"''";
1670 $arr[$firstmultiletterword - 1] .=
"'";
1671 } elseif ( $firstspace > -1 ) {
1675 $arr[$firstspace] =
"''";
1676 $arr[$firstspace - 1] .=
"'";
1685 foreach ( $arr
as $r ) {
1686 if ( ( $i % 2 ) == 0 ) {
1687 if ( $state ===
'both' ) {
1693 $thislen = strlen( $r );
1694 if ( $thislen == 2 ) {
1695 if ( $state ===
'i' ) {
1698 } elseif ( $state ===
'bi' ) {
1701 } elseif ( $state ===
'ib' ) {
1704 } elseif ( $state ===
'both' ) {
1711 } elseif ( $thislen == 3 ) {
1712 if ( $state ===
'b' ) {
1715 } elseif ( $state ===
'bi' ) {
1718 } elseif ( $state ===
'ib' ) {
1721 } elseif ( $state ===
'both' ) {
1728 } elseif ( $thislen == 5 ) {
1729 if ( $state ===
'b' ) {
1732 } elseif ( $state ===
'i' ) {
1735 } elseif ( $state ===
'bi' ) {
1738 } elseif ( $state ===
'ib' ) {
1741 } elseif ( $state ===
'both' ) {
1753 if ( $state ===
'b' || $state ===
'ib' ) {
1756 if ( $state ===
'i' || $state ===
'bi' || $state ===
'ib' ) {
1759 if ( $state ===
'bi' ) {
1763 if ( $state ===
'both' &&
$buffer ) {
1784 $bits = preg_split( $this->mExtLinkBracketedRegex, $text, -1, PREG_SPLIT_DELIM_CAPTURE );
1785 if ( $bits ===
false ) {
1786 throw new MWException(
"PCRE needs to be compiled with "
1787 .
"--enable-unicode-properties in order for MediaWiki to function" );
1789 $s = array_shift( $bits );
1792 while ( $i < count( $bits ) ) {
1795 $text = $bits[$i++];
1796 $trail = $bits[$i++];
1798 # The characters '<' and '>' (which were escaped by
1799 # removeHTMLtags()) should not be included in
1800 # URLs, per RFC 2396.
1802 if ( preg_match(
'/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE ) ) {
1803 $text = substr( $url, $m2[0][1] ) .
' ' . $text;
1804 $url = substr( $url, 0, $m2[0][1] );
1807 # If the link text is an image URL, replace it with an <img> tag
1808 # This happened by accident in the original parser, but some people used it extensively
1810 if ( $img !==
false ) {
1816 # Set linktype for CSS - if URL==text, link is essentially free
1817 $linktype = ( $text === $url ) ?
'free' :
'text';
1819 # No link text, e.g. [http://domain.tld/some.link]
1820 if ( $text ==
'' ) {
1823 $text =
'[' . $langObj->formatNum( ++$this->mAutonumber ) .
']';
1824 $linktype =
'autonumber';
1826 # Have link text, e.g. [http://domain.tld/some.link text]s
1835 # Use the encoded URL
1836 # This means that users can paste URLs directly into the text
1837 # Funny characters like ö aren't valid in URLs anyway
1838 # This was changed in August 2004
1842 # Register link in the output object.
1843 # Replace unnecessary URL escape codes with the referenced character
1844 # This prevents spammers from hiding links from the filters
1845 $pasteurized = self::normalizeLinkUrl( $url );
1846 $this->mOutput->addExternalLink( $pasteurized );
1864 if ( $wgNoFollowLinks && !in_array( $ns, $wgNoFollowNsExceptions )
1884 $rel = self::getExternalLinkRel( $url, $this->mTitle );
1886 $target = $this->mOptions->getExternalLinkTarget();
1889 if ( !in_array( $target, [
'_self',
'_parent',
'_top' ] ) ) {
1893 if ( $rel !==
'' ) {
1896 $rel .=
'noreferrer noopener';
1912 return self::normalizeLinkUrl( $url );
1925 # First, make sure unsafe characters are encoded
1926 $url = preg_replace_callback(
'/[\x00-\x20"<>\[\\\\\]^`{|}\x7F-\xFF]/',
1928 return rawurlencode( $m[0] );
1934 $end = strlen( $url );
1936 # Fragment part - 'fragment'
1937 $start = strpos( $url,
'#' );
1938 if ( $start !==
false && $start < $end ) {
1939 $ret = self::normalizeUrlComponent(
1940 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}' ) .
$ret;
1944 # Query part - 'query' minus &=+;
1945 $start = strpos( $url,
'?' );
1946 if ( $start !==
false && $start < $end ) {
1947 $ret = self::normalizeUrlComponent(
1948 substr( $url, $start, $end - $start ),
'"#%<>[\]^`{|}&=+;' ) .
$ret;
1952 # Scheme and path part - 'pchar'
1953 # (we assume no userinfo or encoded colons in the host)
1954 $ret = self::normalizeUrlComponent(
1955 substr( $url, 0, $end ),
'"#%<>[\]^`{|}/?' ) .
$ret;
1961 $callback =
function (
$matches )
use ( $unsafe ) {
1963 $ord = ord( $char );
1964 if ( $ord > 32 && $ord < 127 && strpos( $unsafe, $char ) ===
false ) {
1968 # Leave it escaped, but use uppercase for a-f
1972 return preg_replace_callback(
'/%[0-9A-Fa-f]{2}/', $callback, $component );
1984 $imagesfrom = $this->mOptions->getAllowExternalImagesFrom();
1985 $imagesexception = !empty( $imagesfrom );
1987 # $imagesfrom could be either a single string or an array of strings, parse out the latter
1988 if ( $imagesexception && is_array( $imagesfrom ) ) {
1989 $imagematch =
false;
1990 foreach ( $imagesfrom
as $match ) {
1991 if ( strpos( $url, $match ) === 0 ) {
1996 } elseif ( $imagesexception ) {
1997 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
1999 $imagematch =
false;
2002 if ( $this->mOptions->getAllowExternalImages()
2003 || ( $imagesexception && $imagematch )
2005 if ( preg_match( self::EXT_IMAGE_REGEX, $url ) ) {
2010 if ( !$text && $this->mOptions->getEnableImageWhitelist()
2011 && preg_match( self::EXT_IMAGE_REGEX, $url )
2013 $whitelist = explode(
2015 wfMessage(
'external_image_whitelist' )->inContentLanguage()->
text()
2018 foreach ( $whitelist
as $entry ) {
2019 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
2020 if ( strpos( $entry,
'#' ) === 0 || $entry ===
'' ) {
2023 if ( preg_match(
'/' . str_replace(
'/',
'\\/', $entry ) .
'/i', $url ) ) {
2024 # Image matches a whitelist entry
2058 static $tc =
false, $e1, $e1_img;
2059 # the % is needed to support urlencoded titles as well
2062 # Match a link having the form [[namespace:link|alternate]]trail
2063 $e1 =
"/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
2064 # Match cases where there is no "]]", which might still be images
2065 $e1_img =
"/^([{$tc}]+)\\|(.*)\$/sD";
2070 # split the entire text string on occurrences of [[
2071 $a = StringUtils::explode(
'[[',
' ' .
$s );
2072 # get the first element (all text up to first [[), and remove the space we added
2075 $line = $a->current(); # Workaround
for broken ArrayIterator::next()
that returns
"void"
2076 $s = substr( $s, 1 );
2080 if ( $useLinkPrefixExtension ) {
2081 # Match the end of a line for a word that's not followed by whitespace,
2082 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
2084 $charset = $wgContLang->linkPrefixCharset();
2085 $e2 =
"/^((?>.*[^$charset]|))(.+)$/sDu";
2088 if ( is_null( $this->mTitle ) ) {
2089 throw new MWException( __METHOD__ .
": \$this->mTitle is null\n" );
2091 $nottalk = !$this->mTitle->isTalkPage();
2093 if ( $useLinkPrefixExtension ) {
2095 if ( preg_match( $e2, $s, $m ) ) {
2096 $first_prefix = $m[2];
2098 $first_prefix =
false;
2107 # Loop for each link
2108 for ( ;
$line !==
false &&
$line !== null; $a->next(),
$line = $a->current() ) {
2111 # Check for excessive memory usage
2112 if ( $holders->isBig() ) {
2114 # Do the existence check, replace the link holders and clear the array
2115 $holders->replace( $s );
2119 if ( $useLinkPrefixExtension ) {
2120 if ( preg_match( $e2, $s, $m ) ) {
2127 if ( $first_prefix ) {
2128 $prefix = $first_prefix;
2129 $first_prefix =
false;
2133 $might_be_img =
false;
2137 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
2138 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
2139 # the real problem is with the $e1 regex
2141 # Still some problems for cases where the ] is meant to be outside punctuation,
2142 # and no image is in sight. See bug 2095.
2144 && substr( $m[3], 0, 1 ) ===
']'
2145 && strpos( $text,
'[' ) !==
false
2148 $m[3] = substr( $m[3], 1 );
2150 # fix up urlencoded title texts
2151 if ( strpos( $m[1],
'%' ) !==
false ) {
2152 # Should anchors '#' also be rejected?
2153 $m[1] = str_replace( [
'<',
'>' ], [
'<',
'>' ], rawurldecode( $m[1] ) );
2156 } elseif ( preg_match( $e1_img,
$line, $m ) ) {
2157 # Invalid, but might be an image with a link in its caption
2158 $might_be_img =
true;
2160 if ( strpos( $m[1],
'%' ) !==
false ) {
2161 $m[1] = rawurldecode( $m[1] );
2165 $s .= $prefix .
'[[' .
$line;
2171 # Don't allow internal links to pages containing
2172 # PROTO: where PROTO is a valid URL protocol; these
2173 # should be external links.
2174 if ( preg_match(
'/^(?i:' . $this->mUrlProtocols .
')/', $origLink ) ) {
2175 $s .= $prefix .
'[[' .
$line;
2179 # Make subpage if necessary
2180 if ( $useSubpages ) {
2186 $noforce = ( substr( $origLink, 0, 1 ) !==
':' );
2188 # Strip off leading ':'
2192 $unstrip = $this->mStripState->unstripNoWiki(
$link );
2194 if ( $nt === null ) {
2195 $s .= $prefix .
'[[' .
$line;
2199 $ns = $nt->getNamespace();
2200 $iw = $nt->getInterwiki();
2202 if ( $might_be_img ) { #
if this is actually an invalid
link
2203 if ( $ns ==
NS_FILE && $noforce ) { # but might be an image
2206 # look at the next 'line' to see if we can close it there
2208 $next_line = $a->current();
2209 if ( $next_line ===
false || $next_line === null ) {
2212 $m = explode(
']]', $next_line, 3 );
2213 if ( count( $m ) == 3 ) {
2214 # the first ]] closes the inner link, the second the image
2216 $text .=
"[[{$m[0]}]]{$m[1]}";
2219 } elseif ( count( $m ) == 2 ) {
2220 # if there's exactly one ]] that's fine, we'll keep looking
2221 $text .=
"[[{$m[0]}]]{$m[1]}";
2223 # if $next_line is invalid too, we need look no further
2224 $text .=
'[[' . $next_line;
2229 # we couldn't find the end of this imageLink, so output it raw
2230 # but don't ignore what might be perfectly normal links in the text we've examined
2232 $s .=
"{$prefix}[[$link|$text";
2233 # note: no $trail, because without an end, there *is* no trail
2236 }
else { #
it's not an image, so output it raw
2237 $s .= "{$prefix}[[$link|$text";
2238 # note: no $trail, because without an end, there *is* no trail
2243 $wasblank = ( $text == '' );
2247 # Bug 4598 madness. Handle the quotes only if they come from the alternate part
2248 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2249 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2250 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2251 $text = $this->doQuotes( $text );
2254 # Link not escaped by : , create the various objects
2255 if ( $noforce && !$nt->wasLocalInterwiki() ) {
2258 $iw && $this->mOptions->getInterwikiMagic() && $nottalk && (
2259 Language::fetchLanguageName( $iw, null, 'mw
' ) ||
2260 in_array( $iw, $wgExtraInterlanguageLinkPrefixes )
2263 # Bug 24502: filter duplicates
2264 if ( !isset( $this->mLangLinkLanguages[$iw] ) ) {
2265 $this->mLangLinkLanguages[$iw] = true;
2266 $this->mOutput->addLanguageLink( $nt->getFullText() );
2269 $s = rtrim( $s . $prefix );
2270 $s .= trim( $trail, "\n" ) == '' ? '': $prefix . $trail;
2274 if ( $ns == NS_FILE ) {
2275 if ( !wfIsBadImage( $nt->getDBkey(), $this->mTitle ) ) {
2277 # if no parameters were passed, $text
2278 # becomes something like "File:Foo.png",
2279 # which we don't want to pass
on to
the
2283 # recursively parse links inside the image caption
2284 # actually, this will parse them in any other parameters, too,
2285 # but it might be hard to fix that, and it doesn't matter ATM
2289 # cloak any absolute URLs inside the image markup, so replaceExternalLinks() won't touch them
2291 $this->
makeImage( $nt, $text, $holders ) ) . $trail;
2295 $s = rtrim( $s .
"\n" ); # bug 87
2303 $sortkey = str_replace(
"\n",
'', $sortkey );
2305 $this->mOutput->addCategory( $nt->getDBkey(), $sortkey );
2310 $s .= trim( $prefix . $trail,
"\n" ) ==
'' ?
'' : $prefix . $trail;
2316 # Self-link checking. For some languages, variants of the title are checked in
2317 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2318 # for linking to a different variant.
2319 if ( $ns !=
NS_SPECIAL && $nt->equals( $this->mTitle ) && !$nt->hasFragment() ) {
2324 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2325 # @todo FIXME: Should do batch file existence checks, see comment below
2327 # Give extensions a chance to select the file revision for us
2331 [ $this, $nt, &
$options, &$descQuery ] );
2332 # Fetch and register the file (file title may be different via hooks)
2334 # Cloak with NOPARSE to avoid replacement in replaceExternalLinks
2340 # Some titles, such as valid special pages or files in foreign repos, should
2341 # be shown as bluelinks even though they're not included in the page table
2342 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2343 # batch file existence checks for NS_FILE and NS_MEDIA
2344 if ( $iw ==
'' && $nt->isAlwaysKnown() ) {
2345 $this->mOutput->addLink( $nt );
2348 # Links will be added to the output link list after checking
2349 $s .= $holders->makeHolder( $nt, $text, [], $trail, $prefix );
2371 if ( $text ==
'' ) {
2372 $text = htmlspecialchars( $nt->getPrefixedText() );
2375 $link = $this->getLinkRenderer()->makeKnownLink(
2376 $nt,
new HtmlArmor(
"$prefix$text$inside" )
2379 return $this->armorLinks(
$link ) . $trail;
2393 return preg_replace(
'/\b((?i)' . $this->mUrlProtocols .
')/',
2394 self::MARKER_PREFIX .
"NOPARSE$1", $text );
2402 # Some namespaces don't allow subpages
2445 if ( is_null( $this->mTitle ) ) {
2450 throw new MWException( __METHOD__ .
' Should only be '
2451 .
' called while parsing (no title set)' );
2458 if (
Hooks::run(
'ParserGetVariableValueVarCache', [ &$this, &$this->mVarCache ] ) ) {
2459 if ( isset( $this->mVarCache[$index] ) ) {
2460 return $this->mVarCache[$index];
2465 Hooks::run(
'ParserGetVariableValueTs', [ &$this, &$ts ] );
2467 $pageLang = $this->getFunctionLang();
2473 case 'currentmonth':
2476 case 'currentmonth1':
2479 case 'currentmonthname':
2482 case 'currentmonthnamegen':
2485 case 'currentmonthabbrev':
2500 case 'localmonthname':
2503 case 'localmonthnamegen':
2506 case 'localmonthabbrev':
2521 case 'fullpagename':
2524 case 'fullpagenamee':
2530 case 'subpagenamee':
2533 case 'rootpagename':
2536 case 'rootpagenamee':
2540 $this->mTitle->getRootText()
2543 case 'basepagename':
2546 case 'basepagenamee':
2550 $this->mTitle->getBaseText()
2553 case 'talkpagename':
2554 if ( $this->mTitle->canTalk() ) {
2555 $talkPage = $this->mTitle->getTalkPage();
2561 case 'talkpagenamee':
2562 if ( $this->mTitle->canTalk() ) {
2563 $talkPage = $this->mTitle->getTalkPage();
2569 case 'subjectpagename':
2570 $subjPage = $this->mTitle->getSubjectPage();
2573 case 'subjectpagenamee':
2574 $subjPage = $this->mTitle->getSubjectPage();
2578 $pageid = $this->getTitle()->getArticleID();
2579 if ( $pageid == 0 ) {
2580 # 0 means the page doesn't exist in the database,
2581 # which means the user is previewing a new page.
2582 # The vary-revision flag must be set, because the magic word
2583 # will have a different value once the page is saved.
2584 $this->mOutput->setFlag(
'vary-revision' );
2585 wfDebug( __METHOD__ .
": {{PAGEID}} used in a new page, setting vary-revision...\n" );
2587 $value = $pageid ? $pageid : null;
2590 # Let the edit saving system know we should parse the page
2591 # *after* a revision ID has been assigned.
2592 $this->mOutput->setFlag(
'vary-revision-id' );
2593 wfDebug( __METHOD__ .
": {{REVISIONID}} used, setting vary-revision-id...\n" );
2594 $value = $this->mRevisionId;
2595 if ( !
$value && $this->mOptions->getSpeculativeRevIdCallback() ) {
2596 $value = call_user_func( $this->mOptions->getSpeculativeRevIdCallback() );
2597 $this->mOutput->setSpeculativeRevIdUsed(
$value );
2601 # Let the edit saving system know we should parse the page
2602 # *after* a revision ID has been assigned. This is for null edits.
2603 $this->mOutput->setFlag(
'vary-revision' );
2604 wfDebug( __METHOD__ .
": {{REVISIONDAY}} used, setting vary-revision...\n" );
2605 $value = intval( substr( $this->getRevisionTimestamp(), 6, 2 ) );
2607 case 'revisionday2':
2608 # Let the edit saving system know we should parse the page
2609 # *after* a revision ID has been assigned. This is for null edits.
2610 $this->mOutput->setFlag(
'vary-revision' );
2611 wfDebug( __METHOD__ .
": {{REVISIONDAY2}} used, setting vary-revision...\n" );
2612 $value = substr( $this->getRevisionTimestamp(), 6, 2 );
2614 case 'revisionmonth':
2615 # Let the edit saving system know we should parse the page
2616 # *after* a revision ID has been assigned. This is for null edits.
2617 $this->mOutput->setFlag(
'vary-revision' );
2618 wfDebug( __METHOD__ .
": {{REVISIONMONTH}} used, setting vary-revision...\n" );
2619 $value = substr( $this->getRevisionTimestamp(), 4, 2 );
2621 case 'revisionmonth1':
2622 # Let the edit saving system know we should parse the page
2623 # *after* a revision ID has been assigned. This is for null edits.
2624 $this->mOutput->setFlag(
'vary-revision' );
2625 wfDebug( __METHOD__ .
": {{REVISIONMONTH1}} used, setting vary-revision...\n" );
2626 $value = intval( substr( $this->getRevisionTimestamp(), 4, 2 ) );
2628 case 'revisionyear':
2629 # Let the edit saving system know we should parse the page
2630 # *after* a revision ID has been assigned. This is for null edits.
2631 $this->mOutput->setFlag(
'vary-revision' );
2632 wfDebug( __METHOD__ .
": {{REVISIONYEAR}} used, setting vary-revision...\n" );
2633 $value = substr( $this->getRevisionTimestamp(), 0, 4 );
2635 case 'revisiontimestamp':
2636 # Let the edit saving system know we should parse the page
2637 # *after* a revision ID has been assigned. This is for null edits.
2638 $this->mOutput->setFlag(
'vary-revision' );
2639 wfDebug( __METHOD__ .
": {{REVISIONTIMESTAMP}} used, setting vary-revision...\n" );
2640 $value = $this->getRevisionTimestamp();
2642 case 'revisionuser':
2643 # Let the edit saving system know we should parse the page
2644 # *after* a revision ID has been assigned for null edits.
2645 $this->mOutput->setFlag(
'vary-user' );
2646 wfDebug( __METHOD__ .
": {{REVISIONUSER}} used, setting vary-user...\n" );
2647 $value = $this->getRevisionUser();
2649 case 'revisionsize':
2650 $value = $this->getRevisionSize();
2653 $value = str_replace(
'_',
' ', $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2656 $value =
wfUrlencode( $wgContLang->getNsText( $this->mTitle->getNamespace() ) );
2658 case 'namespacenumber':
2659 $value = $this->mTitle->getNamespace();
2662 $value = $this->mTitle->canTalk()
2663 ? str_replace(
'_',
' ', $this->mTitle->getTalkNsText() )
2667 $value = $this->mTitle->canTalk() ?
wfUrlencode( $this->mTitle->getTalkNsText() ) :
'';
2669 case 'subjectspace':
2670 $value = str_replace(
'_',
' ', $this->mTitle->getSubjectNsText() );
2672 case 'subjectspacee':
2675 case 'currentdayname':
2688 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2689 # int to remove the padding
2695 case 'localdayname':
2696 $value = $pageLang->getWeekdayName(
2704 $value = $pageLang->time(
2714 # @bug 4594 PHP5 has it zero padded, PHP4 does not, cast to
2715 # int to remove the padding
2721 case 'numberofarticles':
2724 case 'numberoffiles':
2727 case 'numberofusers':
2730 case 'numberofactiveusers':
2733 case 'numberofpages':
2736 case 'numberofadmins':
2739 case 'numberofedits':
2742 case 'currenttimestamp':
2745 case 'localtimestamp':
2748 case 'currentversion':
2763 case 'directionmark':
2764 return $pageLang->getDirMark();
2765 case 'contentlanguage':
2768 case 'cascadingsources':
2774 'ParserGetVariableValueSwitch',
2775 [ &$this, &$this->mVarCache, &$index, &
$ret, &$frame ]
2782 $this->mVarCache[$index] =
$value;
2824 $dom = $this->getPreprocessor()->preprocessToObj( $text,
$flags );
2836 $ltrimmed = ltrim(
$s );
2837 $w1 = substr(
$s, 0, strlen(
$s ) - strlen( $ltrimmed ) );
2838 $trimmed = rtrim( $ltrimmed );
2839 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
2841 $w2 = substr( $ltrimmed, -$diff );
2845 return [ $w1, $trimmed, $w2 ];
2869 # Is there any text? Also, Prevent too big inclusions!
2870 $textSize = strlen( $text );
2871 if ( $textSize < 1 || $textSize > $this->mOptions->getMaxIncludeSize() ) {
2875 if ( $frame ===
false ) {
2876 $frame = $this->getPreprocessor()->newFrame();
2877 } elseif ( !( $frame instanceof
PPFrame ) ) {
2878 wfDebug( __METHOD__ .
" called using plain parameters instead of "
2879 .
"a PPFrame instance. Creating custom frame.\n" );
2880 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
2883 $dom = $this->preprocessToDom( $text );
2885 $text = $frame->expand( $dom,
$flags );
2901 $eqpos = strpos( $arg,
'=' );
2902 if ( $eqpos ===
false ) {
2903 $assocArgs[$index++] = $arg;
2905 $name = trim( substr( $arg, 0, $eqpos ) );
2906 $value = trim( substr( $arg, $eqpos + 1 ) );
2907 if (
$value ===
false ) {
2910 if (
$name !==
false ) {
2946 # does no harm if $current and $max are present but are unnecessary for the message
2947 # Not doing ->inLanguage( $this->mOptions->getUserLangObj() ), since this is shown
2948 # only during preview, and that would split the parser cache unnecessarily.
2949 $warning =
wfMessage(
"$limitationType-warning" )->numParams( $current, $max )
2951 $this->mOutput->addWarning( $warning );
2952 $this->addTrackingCategory(
"$limitationType-category" );
2978 $forceRawInterwiki =
false;
2980 $isChildObj =
false;
2982 $isLocalObj =
false;
2984 # Title object, where $text came from
2987 # $part1 is the bit before the first |, and must contain only title characters.
2988 # Various prefixes will be stripped from it later.
2989 $titleWithSpaces = $frame->expand( $piece[
'title'] );
2990 $part1 = trim( $titleWithSpaces );
2993 # Original title text preserved for various purposes
2994 $originalTitle = $part1;
2996 # $args is a list of argument nodes, starting from index 0, not including $part1
2997 # @todo FIXME: If piece['parts'] is null then the call to getLength()
2998 # below won't work b/c this $args isn't an object
2999 $args = ( null == $piece[
'parts'] ) ? [] : $piece[
'parts'];
3001 $profileSection = null;
3005 $substMatch = $this->mSubstWords->matchStartAndRemove( $part1 );
3007 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3008 # Decide whether to expand template or keep wikitext as-is.
3009 if ( $this->ot[
'wiki'] ) {
3010 if ( $substMatch ===
false ) {
3011 $literal =
true; # literal when
in PST with no prefix
3013 $literal =
false; # expand when
in PST with subst:
or safesubst:
3016 if ( $substMatch ==
'subst' ) {
3017 $literal =
true; # literal when not
in PST with plain subst:
3019 $literal =
false; # expand when not
in PST with safesubst:
or no prefix
3023 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3030 if ( !$found &&
$args->getLength() == 0 ) {
3031 $id = $this->mVariables->matchStartToEnd( $part1 );
3032 if ( $id !==
false ) {
3033 $text = $this->getVariableValue( $id, $frame );
3041 # MSG, MSGNW and RAW
3045 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3048 # Remove obsolete MSG:
3050 $mwMsg->matchStartAndRemove( $part1 );
3055 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3056 $forceRawInterwiki =
true;
3062 $colonPos = strpos( $part1,
':' );
3063 if ( $colonPos !==
false ) {
3064 $func = substr( $part1, 0, $colonPos );
3065 $funcArgs = [ trim( substr( $part1, $colonPos + 1 ) ) ];
3066 $argsLength =
$args->getLength();
3067 for ( $i = 0; $i < $argsLength; $i++ ) {
3068 $funcArgs[] =
$args->item( $i );
3071 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3072 }
catch ( Exception $ex ) {
3076 # The interface for parser functions allows for extracting
3077 # flags into the local scope. Extract any forwarded flags
3083 # Finish mangling title and then check for loops.
3084 # Set $title to a Title object and $titleText to the PDBK
3087 # Split the title into page and subpage
3089 $relative = $this->maybeDoSubpageLink( $part1, $subpage );
3090 if ( $part1 !== $relative ) {
3092 $ns = $this->mTitle->getNamespace();
3096 $titleText =
$title->getPrefixedText();
3097 # Check for language variants if the template is not found
3098 if ( $this->getConverterLanguage()->hasVariants() &&
$title->getArticleID() == 0 ) {
3099 $this->getConverterLanguage()->findVariantLink( $part1,
$title,
true );
3101 # Do recursion depth check
3102 $limit = $this->mOptions->getMaxTemplateDepth();
3103 if ( $frame->depth >=
$limit ) {
3105 $text =
'<span class="error">'
3106 .
wfMessage(
'parser-template-recursion-depth-warning' )
3107 ->numParams(
$limit )->inContentLanguage()->text()
3113 # Load from database
3114 if ( !$found &&
$title ) {
3115 $profileSection = $this->mProfiler->scopedProfileIn(
$title->getPrefixedDBkey() );
3116 if ( !
$title->isExternal() ) {
3117 if (
$title->isSpecialPage()
3118 && $this->mOptions->getAllowSpecialInclusion()
3119 && $this->ot[
'html']
3126 $argsLength =
$args->getLength();
3127 for ( $i = 0; $i < $argsLength; $i++ ) {
3128 $bits =
$args->item( $i )->splitArg();
3129 if ( strval( $bits[
'index'] ) ===
'' ) {
3131 $value = trim( $frame->expand( $bits[
'value'] ) );
3140 if ( $specialPage && $specialPage->maxIncludeCacheTime() === 0 ) {
3141 $context->setUser( $this->getUser() );
3146 $context->setLanguage( $this->mOptions->getUserLangObj() );
3149 $text =
$context->getOutput()->getHTML();
3150 $this->mOutput->addOutputPageMetadata(
$context->getOutput() );
3153 if ( $specialPage && $specialPage->maxIncludeCacheTime() !==
false ) {
3154 $this->mOutput->updateCacheExpiry( $specialPage->maxIncludeCacheTime() );
3158 $found =
false; # access denied
3159 wfDebug( __METHOD__ .
": template inclusion denied for " .
3160 $title->getPrefixedDBkey() .
"\n" );
3163 if ( $text !==
false ) {
3169 # If the title is valid but undisplayable, make a link to it
3170 if ( !$found && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3171 $text =
"[[:$titleText]]";
3174 } elseif (
$title->isTrans() ) {
3175 # Interwiki transclusion
3176 if ( $this->ot[
'html'] && !$forceRawInterwiki ) {
3177 $text = $this->interwikiTransclude(
$title,
'render' );
3180 $text = $this->interwikiTransclude(
$title,
'raw' );
3181 # Preprocess it like a template
3182 $text = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3188 # Do infinite loop check
3189 # This has to be done after redirect resolution to avoid infinite loops via redirects
3190 if ( !$frame->loopCheck(
$title ) ) {
3192 $text =
'<span class="error">'
3193 .
wfMessage(
'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3195 wfDebug( __METHOD__ .
": template loop broken at '$titleText'\n" );
3199 # If we haven't found text to substitute by now, we're done
3200 # Recover the source wikitext and return it
3202 $text = $frame->virtualBracketedImplode(
'{{',
'|',
'}}', $titleWithSpaces,
$args );
3203 if ( $profileSection ) {
3204 $this->mProfiler->scopedProfileOut( $profileSection );
3206 return [
'object' => $text ];
3209 # Expand DOM-style return values in a child frame
3210 if ( $isChildObj ) {
3211 # Clean up argument array
3216 } elseif ( $titleText !==
false && $newFrame->isEmpty() ) {
3217 # Expansion is eligible for the empty-frame cache
3218 $text = $newFrame->cachedExpand( $titleText, $text );
3220 # Uncached expansion
3221 $text = $newFrame->expand( $text );
3224 if ( $isLocalObj && $nowiki ) {
3226 $isLocalObj =
false;
3229 if ( $profileSection ) {
3230 $this->mProfiler->scopedProfileOut( $profileSection );
3233 # Replace raw HTML by a placeholder
3235 $text = $this->insertStripItem( $text );
3236 } elseif ( $nowiki && ( $this->ot[
'html'] || $this->ot[
'pre'] ) ) {
3237 # Escape nowiki-style return values
3239 } elseif ( is_string( $text )
3240 && !$piece[
'lineStart']
3241 && preg_match(
'/^(?:{\\||:|;|#|\*)/', $text )
3243 # Bug 529: if the template begins with a table or block-level
3244 # element, it should be treated as beginning a new line.
3245 # This behavior is somewhat controversial.
3246 $text =
"\n" . $text;
3249 if ( is_string( $text ) && !$this->incrementIncludeSize(
'post-expand', strlen( $text ) ) ) {
3250 # Error, oversize inclusion
3251 if ( $titleText !==
false ) {
3252 # Make a working, properly escaped link if possible (bug 23588)
3253 $text =
"[[:$titleText]]";
3255 # This will probably not be a working link, but at least it may
3256 # provide some hint of where the problem is
3257 preg_replace(
'/^:/',
'', $originalTitle );
3258 $text =
"[[:$originalTitle]]";
3260 $text .= $this->insertStripItem(
'<!-- WARNING: template omitted, '
3261 .
'post-expand include size too large -->' );
3262 $this->limitationWarn(
'post-expand-template-inclusion' );
3265 if ( $isLocalObj ) {
3266 $ret = [
'object' => $text ];
3268 $ret = [
'text' => $text ];
3296 # Case sensitive functions
3297 if ( isset( $this->mFunctionSynonyms[1][$function] ) ) {
3298 $function = $this->mFunctionSynonyms[1][$function];
3300 # Case insensitive functions
3301 $function = $wgContLang->lc( $function );
3302 if ( isset( $this->mFunctionSynonyms[0][$function] ) ) {
3303 $function = $this->mFunctionSynonyms[0][$function];
3305 return [
'found' =>
false ];
3309 list( $callback,
$flags ) = $this->mFunctionHooks[$function];
3311 # Workaround for PHP bug 35229 and similar
3312 if ( !is_callable( $callback ) ) {
3313 throw new MWException(
"Tag hook for $function is not callable\n" );
3316 $allArgs = [ &$this ];
3318 # Convert arguments to PPNodes and collect for appending to $allArgs
3320 foreach (
$args as $k => $v ) {
3321 if ( $v instanceof
PPNode || $k === 0 ) {
3324 $funcArgs[] = $this->mPreprocessor->newPartNodeArray( [ $k => $v ] )->item( 0 );
3328 # Add a frame parameter, and pass the arguments as an array
3329 $allArgs[] = $frame;
3330 $allArgs[] = $funcArgs;
3332 # Convert arguments to plain text and append to $allArgs
3333 foreach (
$args as $k => $v ) {
3334 if ( $v instanceof
PPNode ) {
3335 $allArgs[] = trim( $frame->expand( $v ) );
3336 } elseif ( is_int( $k ) && $k >= 0 ) {
3337 $allArgs[] = trim( $v );
3339 $allArgs[] = trim(
"$k=$v" );
3344 $result = call_user_func_array( $callback, $allArgs );
3346 # The interface for function hooks allows them to return a wikitext
3347 # string or an array containing the string and any flags. This mungs
3348 # things around to match what this method should return.
3365 $preprocessFlags = 0;
3366 if ( isset(
$result[
'noparse'] ) ) {
3367 $noparse =
$result[
'noparse'];
3369 if ( isset(
$result[
'preprocessFlags'] ) ) {
3370 $preprocessFlags =
$result[
'preprocessFlags'];
3374 $result[
'text'] = $this->preprocessToDom(
$result[
'text'], $preprocessFlags );
3391 $titleText =
$title->getPrefixedDBkey();
3393 if ( isset( $this->mTplRedirCache[$titleText] ) ) {
3394 list( $ns, $dbk ) = $this->mTplRedirCache[$titleText];
3396 $titleText =
$title->getPrefixedDBkey();
3398 if ( isset( $this->mTplDomCache[$titleText] ) ) {
3399 return [ $this->mTplDomCache[$titleText],
$title ];
3402 # Cache miss, go to the database
3405 if ( $text ===
false ) {
3406 $this->mTplDomCache[$titleText] =
false;
3407 return [
false,
$title ];
3410 $dom = $this->preprocessToDom( $text, self::PTD_FOR_INCLUSION );
3411 $this->mTplDomCache[$titleText] = $dom;
3414 $this->mTplRedirCache[$cacheTitle->getPrefixedDBkey()] =
3433 $cacheKey =
$title->getPrefixedDBkey();
3434 if ( !$this->currentRevisionCache ) {
3435 $this->currentRevisionCache =
new MapCacheLRU( 100 );
3437 if ( !$this->currentRevisionCache->has( $cacheKey ) ) {
3438 $this->currentRevisionCache->set( $cacheKey,
3440 call_user_func( $this->mOptions->getCurrentRevisionCallback(),
$title, $this )
3443 return $this->currentRevisionCache->get( $cacheKey );
3466 $templateCb = $this->mOptions->getTemplateCallback();
3467 $stuff = call_user_func( $templateCb,
$title, $this );
3469 $text = $stuff[
'text'];
3470 if ( is_string( $stuff[
'text'] ) ) {
3471 $text = strtr( $text,
"\x7f",
"?" );
3473 $finalTitle = isset( $stuff[
'finalTitle'] ) ? $stuff[
'finalTitle'] :
$title;
3474 if ( isset( $stuff[
'deps'] ) ) {
3475 foreach ( $stuff[
'deps']
as $dep ) {
3476 $this->mOutput->addTemplate( $dep[
'title'], $dep[
'page_id'], $dep[
'rev_id'] );
3477 if ( $dep[
'title']->equals( $this->getTitle() ) ) {
3480 $this->mOutput->setFlag(
'vary-revision' );
3484 return [ $text, $finalTitle ];
3493 return $this->fetchTemplateAndTitle(
$title )[0];
3506 $text = $skip =
false;
3510 # Loop to fetch the article, with up to 1 redirect
3512 for ( $i = 0; $i < 2 && is_object(
$title ); $i++ ) {
3514 # Give extensions a chance to select the revision instead
3515 $id =
false; # Assume current
3516 Hooks::run(
'BeforeParserFetchTemplateAndtitle',
3523 'page_id' =>
$title->getArticleID(),
3536 $rev_id =
$rev ?
$rev->getId() : 0;
3537 # If there is no current revision, there is no page
3538 if ( $id ===
false && !
$rev ) {
3540 $linkCache->addBadLinkObj(
$title );
3545 'page_id' =>
$title->getArticleID(),
3546 'rev_id' => $rev_id ];
3548 # We fetched a rev from a different title; register it too...
3550 'title' =>
$rev->getTitle(),
3551 'page_id' =>
$rev->getPage(),
3552 'rev_id' => $rev_id ];
3559 if ( $text ===
false || $text === null ) {
3565 $message =
wfMessage( $wgContLang->lcfirst(
$title->getText() ) )->inContentLanguage();
3566 if ( !$message->exists() ) {
3571 $text = $message->plain();
3584 'finalTitle' => $finalTitle,
3609 $time = $file ? $file->getTimestamp() :
false;
3610 $sha1 = $file ? $file->getSha1() :
false;
3611 # Register the file as a dependency...
3612 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3614 # Update fetched file title
3615 $title = $file->getTitle();
3616 $this->mOutput->addImage(
$title->getDBkey(),
$time, $sha1 );
3618 return [ $file,
$title ];
3632 if ( isset(
$options[
'broken'] ) ) {
3634 } elseif ( isset(
$options[
'sha1'] ) ) {
3653 if ( !$wgEnableScaryTranscluding ) {
3654 return wfMessage(
'scarytranscludedisabled' )->inContentLanguage()->text();
3657 $url =
$title->getFullURL( [
'action' => $action ] );
3659 if ( strlen( $url ) > 255 ) {
3660 return wfMessage(
'scarytranscludetoolong' )->inContentLanguage()->text();
3662 return $this->fetchScaryTemplateMaybeFromCache( $url );
3672 $tsCond =
$dbr->timestamp( time() - $wgTranscludeCacheExpiry );
3673 $obj =
$dbr->selectRow(
'transcache', [
'tc_time',
'tc_contents' ],
3674 [
'tc_url' => $url,
"tc_time >= " .
$dbr->addQuotes( $tsCond ) ] );
3676 return $obj->tc_contents;
3682 $text =
$req->getContent();
3683 } elseif (
$req->getStatus() != 200 ) {
3685 return wfMessage(
'scarytranscludefailed-httpstatus' )
3686 ->params( $url,
$req->getStatus() )->inContentLanguage()->text();
3688 return wfMessage(
'scarytranscludefailed', $url )->inContentLanguage()->text();
3692 $dbw->replace(
'transcache', [
'tc_url' ], [
3694 'tc_time' => $dbw->timestamp( time() ),
3695 'tc_contents' => $text
3712 $parts = $piece[
'parts'];
3713 $nameWithSpaces = $frame->expand( $piece[
'title'] );
3714 $argName = trim( $nameWithSpaces );
3716 $text = $frame->getArgument( $argName );
3717 if ( $text ===
false && $parts->getLength() > 0
3718 && ( $this->ot[
'html']
3720 || ( $this->ot[
'wiki'] && $frame->isTemplate() )
3723 # No match in frame, use the supplied default
3724 $object = $parts->item( 0 )->getChildren();
3726 if ( !$this->incrementIncludeSize(
'arg', strlen( $text ) ) ) {
3727 $error =
'<!-- WARNING: argument omitted, expansion size too large -->';
3728 $this->limitationWarn(
'post-expand-template-argument' );
3731 if ( $text ===
false && $object ===
false ) {
3733 $object = $frame->virtualBracketedImplode(
'{{{',
'|',
'}}}', $nameWithSpaces, $parts );
3735 if ( $error !==
false ) {
3738 if ( $object !==
false ) {
3739 $ret = [
'object' => $object ];
3741 $ret = [
'text' => $text ];
3764 $attrText = !isset(
$params[
'attr'] ) ? null : $frame->expand(
$params[
'attr'] );
3766 $marker = self::MARKER_PREFIX .
"-$name-"
3767 . sprintf(
'%08X', $this->mMarkerIndex++ ) . self::MARKER_SUFFIX;
3769 $isFunctionTag = isset( $this->mFunctionTagHooks[strtolower(
$name )] ) &&
3770 ( $this->ot[
'html'] || $this->ot[
'pre'] );
3771 if ( $isFunctionTag ) {
3772 $markerType =
'none';
3774 $markerType =
'general';
3776 if ( $this->ot[
'html'] || $isFunctionTag ) {
3779 if ( isset(
$params[
'attributes'] ) ) {
3780 $attributes = $attributes +
$params[
'attributes'];
3783 if ( isset( $this->mTagHooks[
$name] ) ) {
3784 # Workaround for PHP bug 35229 and similar
3785 if ( !is_callable( $this->mTagHooks[$name] ) ) {
3786 throw new MWException(
"Tag hook for $name is not callable\n" );
3788 $output = call_user_func_array( $this->mTagHooks[$name],
3789 [
$content, $attributes, $this, $frame ] );
3790 } elseif ( isset( $this->mFunctionTagHooks[$name] ) ) {
3791 list( $callback, ) = $this->mFunctionTagHooks[
$name];
3792 if ( !is_callable( $callback ) ) {
3793 throw new MWException(
"Tag hook for $name is not callable\n" );
3796 $output = call_user_func_array( $callback, [ &$this, $frame,
$content, $attributes ] );
3798 $output =
'<span class="error">Invalid tag extension name: ' .
3799 htmlspecialchars( $name ) .
'</span>';
3803 # Extract flags to local scope (to override $markerType)
3810 if ( is_null( $attrText ) ) {
3813 if ( isset(
$params[
'attributes'] ) ) {
3814 foreach (
$params[
'attributes']
as $attrName => $attrValue ) {
3815 $attrText .=
' ' . htmlspecialchars( $attrName ) .
'="' .
3816 htmlspecialchars( $attrValue ) .
'"';
3820 $output =
"<$name$attrText/>";
3822 $close = is_null(
$params[
'close'] ) ?
'' : $frame->expand(
$params[
'close'] );
3823 $output =
"<$name$attrText>$content$close";
3827 if ( $markerType ===
'none' ) {
3829 } elseif ( $markerType ===
'nowiki' ) {
3830 $this->mStripState->addNoWiki( $marker,
$output );
3831 } elseif ( $markerType ===
'general' ) {
3832 $this->mStripState->addGeneral( $marker,
$output );
3834 throw new MWException( __METHOD__ .
': invalid marker type' );
3847 if ( $this->mIncludeSizes[
$type] + $size > $this->mOptions->getMaxIncludeSize() ) {
3850 $this->mIncludeSizes[
$type] += $size;
3861 $this->mExpensiveFunctionCount++;
3862 return $this->mExpensiveFunctionCount <= $this->mOptions->getExpensiveParserFunctionLimit();
3875 # The position of __TOC__ needs to be recorded
3877 if ( $mw->match( $text ) ) {
3878 $this->mShowToc =
true;
3879 $this->mForceTocPosition =
true;
3881 # Set a placeholder. At the end we'll fill it in with the TOC.
3882 $text = $mw->replace(
'<!--MWTOC-->', $text, 1 );
3884 # Only keep the first one.
3885 $text = $mw->replace(
'', $text );
3888 # Now match and remove the rest of them
3890 $this->mDoubleUnderscores = $mwa->matchAndRemove( $text );
3892 if ( isset( $this->mDoubleUnderscores[
'nogallery'] ) ) {
3893 $this->mOutput->mNoGallery =
true;
3895 if ( isset( $this->mDoubleUnderscores[
'notoc'] ) && !$this->mForceTocPosition ) {
3896 $this->mShowToc =
false;
3898 if ( isset( $this->mDoubleUnderscores[
'hiddencat'] )
3901 $this->addTrackingCategory(
'hidden-category-category' );
3903 # (bug 8068) Allow control over whether robots index a page.
3904 # @todo FIXME: Bug 14899: __INDEX__ always overrides __NOINDEX__ here! This
3905 # is not desirable, the last one on the page should win.
3906 if ( isset( $this->mDoubleUnderscores[
'noindex'] ) && $this->mTitle->canUseNoindex() ) {
3907 $this->mOutput->setIndexPolicy(
'noindex' );
3908 $this->addTrackingCategory(
'noindex-category' );
3910 if ( isset( $this->mDoubleUnderscores[
'index'] ) && $this->mTitle->canUseNoindex() ) {
3911 $this->mOutput->setIndexPolicy(
'index' );
3912 $this->addTrackingCategory(
'index-category' );
3915 # Cache all double underscores in the database
3916 foreach ( $this->mDoubleUnderscores
as $key => $val ) {
3917 $this->mOutput->setProperty( $key,
'' );
3929 return $this->mOutput->addTrackingCategory( $msg, $this->mTitle );
3951 # Inhibit editsection links if requested in the page
3952 if ( isset( $this->mDoubleUnderscores[
'noeditsection'] ) ) {
3953 $maybeShowEditLink = $showEditLink =
false;
3955 $maybeShowEditLink =
true;
3956 $showEditLink = $this->mOptions->getEditSection();
3958 if ( $showEditLink ) {
3959 $this->mOutput->setEditSectionTokens(
true );
3962 # Get all headlines for numbering them and adding funky stuff like [edit]
3963 # links - this is for later, but we need the number of headlines right now
3965 $numMatches = preg_match_all(
3966 '/<H(?P<level>[1-6])(?P<attrib>.*?>)\s*(?P<header>[\s\S]*?)\s*<\/H[1-6] *>/i',
3971 # if there are fewer than 4 headlines in the article, do not show TOC
3972 # unless it's been explicitly enabled.
3973 $enoughToc = $this->mShowToc &&
3974 ( ( $numMatches >= 4 ) || $this->mForceTocPosition );
3976 # Allow user to stipulate that a page should have a "new section"
3977 # link added via __NEWSECTIONLINK__
3978 if ( isset( $this->mDoubleUnderscores[
'newsectionlink'] ) ) {
3979 $this->mOutput->setNewSection(
true );
3982 # Allow user to remove the "new section"
3983 # link via __NONEWSECTIONLINK__
3984 if ( isset( $this->mDoubleUnderscores[
'nonewsectionlink'] ) ) {
3985 $this->mOutput->hideNewSection(
true );
3988 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
3989 # override above conditions and always show TOC above first header
3990 if ( isset( $this->mDoubleUnderscores[
'forcetoc'] ) ) {
3991 $this->mShowToc =
true;
3999 # Ugh .. the TOC should have neat indentation levels which can be
4000 # passed to the skin functions. These are determined here
4004 $sublevelCount = [];
4010 $markerRegex = self::MARKER_PREFIX .
"-h-(\d+)-" . self::MARKER_SUFFIX;
4011 $baseTitleText = $this->mTitle->getPrefixedDBkey();
4012 $oldType = $this->mOutputType;
4014 $frame = $this->getPreprocessor()->newFrame();
4015 $root = $this->preprocessToDom( $origText );
4016 $node = $root->getFirstChild();
4021 $headlines = $numMatches !==
false ?
$matches[3] : [];
4023 foreach ( $headlines
as $headline ) {
4024 $isTemplate =
false;
4026 $sectionIndex =
false;
4028 $markerMatches = [];
4029 if ( preg_match(
"/^$markerRegex/", $headline, $markerMatches ) ) {
4030 $serial = $markerMatches[1];
4031 list( $titleText, $sectionIndex ) = $this->mHeadings[$serial];
4032 $isTemplate = ( $titleText != $baseTitleText );
4033 $headline = preg_replace(
"/^$markerRegex\\s*/",
"", $headline );
4037 $prevlevel = $level;
4039 $level =
$matches[1][$headlineCount];
4041 if ( $level > $prevlevel ) {
4042 # Increase TOC level
4044 $sublevelCount[$toclevel] = 0;
4045 if ( $toclevel < $wgMaxTocLevel ) {
4046 $prevtoclevel = $toclevel;
4050 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4051 # Decrease TOC level, find level to jump to
4053 for ( $i = $toclevel; $i > 0; $i-- ) {
4054 if ( $levelCount[$i] == $level ) {
4055 # Found last matching level
4058 } elseif ( $levelCount[$i] < $level ) {
4059 # Found first matching level below current level
4067 if ( $toclevel < $wgMaxTocLevel ) {
4068 if ( $prevtoclevel < $wgMaxTocLevel ) {
4069 # Unindent only if the previous toc level was shown :p
4071 $prevtoclevel = $toclevel;
4077 # No change in level, end TOC line
4078 if ( $toclevel < $wgMaxTocLevel ) {
4083 $levelCount[$toclevel] = $level;
4085 # count number of headlines for each level
4086 $sublevelCount[$toclevel]++;
4088 for ( $i = 1; $i <= $toclevel; $i++ ) {
4089 if ( !empty( $sublevelCount[$i] ) ) {
4093 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4098 # The safe header is a version of the header text safe to use for links
4100 # Remove link placeholders by the link text.
4101 # <!--LINK number-->
4103 # link text with suffix
4104 # Do this before unstrip since link text can contain strip markers
4105 $safeHeadline = $this->replaceLinkHoldersText( $headline );
4107 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4108 $safeHeadline = $this->mStripState->unstripBoth( $safeHeadline );
4110 # Strip out HTML (first regex removes any tag not allowed)
4112 # * <sup> and <sub> (bug 8393)
4115 # * <bdi> (bug 72884)
4116 # * <span dir="rtl"> and <span dir="ltr"> (bug 35167)
4117 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4118 # to allow setting directionality in toc items.
4119 $tocline = preg_replace(
4121 '#<(?!/?(span|sup|sub|bdi|i|b)(?: [^>]*)?>).*?>#',
4122 '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|bdi|i|b))(?: .*?)?>#'
4128 # Strip '<span></span>', which is the result from the above if
4129 # <span id="foo"></span> is used to produce an additional anchor
4131 $tocline = str_replace(
'<span></span>',
'', $tocline );
4133 $tocline = trim( $tocline );
4135 # For the anchor, strip out HTML-y stuff period
4136 $safeHeadline = preg_replace(
'/<.*?>/',
'', $safeHeadline );
4139 # Save headline for section edit hint before it's escaped
4140 $headlineHint = $safeHeadline;
4142 if ( $wgExperimentalHtmlIds ) {
4143 # For reverse compatibility, provide an id that's
4144 # HTML4-compatible, like we used to.
4145 # It may be worth noting, academically, that it's possible for
4146 # the legacy anchor to conflict with a non-legacy headline
4147 # anchor on the page. In this case likely the "correct" thing
4148 # would be to either drop the legacy anchors or make sure
4149 # they're numbered first. However, this would require people
4150 # to type in section names like "abc_.D7.93.D7.90.D7.A4"
4151 # manually, so let's not bother worrying about it.
4153 [
'noninitial',
'legacy' ] );
4156 if ( $legacyHeadline == $safeHeadline ) {
4157 # No reason to have both (in fact, we can't)
4158 $legacyHeadline =
false;
4161 $legacyHeadline =
false;
4166 # HTML names must be case-insensitively unique (bug 10721).
4167 # This does not apply to Unicode characters per
4168 # http://www.w3.org/TR/html5/infrastructure.html#case-sensitivity-and-string-comparison
4169 # @todo FIXME: We may be changing them depending on the current locale.
4170 $arrayKey = strtolower( $safeHeadline );
4171 if ( $legacyHeadline ===
false ) {
4172 $legacyArrayKey =
false;
4174 $legacyArrayKey = strtolower( $legacyHeadline );
4177 # Create the anchor for linking from the TOC to the section
4178 $anchor = $safeHeadline;
4179 $legacyAnchor = $legacyHeadline;
4180 if ( isset( $refers[$arrayKey] ) ) {
4182 for ( $i = 2; isset( $refers[
"${arrayKey}_$i"] ); ++$i );
4185 $refers[
"${arrayKey}_$i"] =
true;
4187 $refers[$arrayKey] =
true;
4189 if ( $legacyHeadline !==
false && isset( $refers[$legacyArrayKey] ) ) {
4191 for ( $i = 2; isset( $refers[
"${legacyArrayKey}_$i"] ); ++$i );
4193 $legacyAnchor .=
"_$i";
4194 $refers[
"${legacyArrayKey}_$i"] =
true;
4196 $refers[$legacyArrayKey] =
true;
4199 # Don't number the heading if it is the only one (looks silly)
4200 if ( count(
$matches[3] ) > 1 && $this->mOptions->getNumberHeadings() ) {
4201 # the two are different if the line contains a link
4204 [
'class' =>
'mw-headline-number' ],
4206 ) .
' ' . $headline;
4209 if ( $enoughToc && ( !isset( $wgMaxTocLevel ) || $toclevel < $wgMaxTocLevel ) ) {
4211 $numbering, $toclevel, ( $isTemplate ?
false : $sectionIndex ) );
4214 # Add the section to the section tree
4215 # Find the DOM node for this header
4216 $noOffset = ( $isTemplate || $sectionIndex ===
false );
4217 while ( $node && !$noOffset ) {
4218 if ( $node->getName() ===
'h' ) {
4219 $bits = $node->splitHeading();
4220 if ( $bits[
'i'] == $sectionIndex ) {
4224 $byteOffset += mb_strlen( $this->mStripState->unstripBoth(
4226 $node = $node->getNextSibling();
4229 'toclevel' => $toclevel,
4232 'number' => $numbering,
4233 'index' => ( $isTemplate ?
'T-' :
'' ) . $sectionIndex,
4234 'fromtitle' => $titleText,
4235 'byteoffset' => ( $noOffset ? null : $byteOffset ),
4236 'anchor' => $anchor,
4239 # give headline the correct <h#> tag
4240 if ( $maybeShowEditLink && $sectionIndex !==
false ) {
4242 if ( $isTemplate ) {
4243 # Put a T flag in the section identifier, to indicate to extractSections()
4244 # that sections inside <includeonly> should be counted.
4245 $editsectionPage = $titleText;
4246 $editsectionSection =
"T-$sectionIndex";
4247 $editsectionContent = null;
4249 $editsectionPage = $this->mTitle->getPrefixedText();
4250 $editsectionSection = $sectionIndex;
4251 $editsectionContent = $headlineHint;
4265 $editlink =
'<mw:editsection page="' . htmlspecialchars( $editsectionPage );
4266 $editlink .=
'" section="' . htmlspecialchars( $editsectionSection ) .
'"';
4267 if ( $editsectionContent !== null ) {
4268 $editlink .=
'>' . $editsectionContent .
'</mw:editsection>';
4276 $matches[
'attrib'][$headlineCount], $anchor, $headline,
4277 $editlink, $legacyAnchor );
4282 $this->setOutputType( $oldType );
4284 # Never ever show TOC if no headers
4285 if ( $numVisible < 1 ) {
4290 if ( $prevtoclevel > 0 && $prevtoclevel < $wgMaxTocLevel ) {
4294 $this->mOutput->setTOCHTML( $toc );
4295 $toc = self::TOC_START . $toc . self::TOC_END;
4296 $this->mOutput->addModules(
'mediawiki.toc' );
4300 $this->mOutput->setSections( $tocraw );
4303 # split up and insert constructed headlines
4304 $blocks = preg_split(
'/<H[1-6].*?>[\s\S]*?<\/H[1-6]>/i', $text );
4309 foreach ( $blocks
as $block ) {
4311 if ( empty( $head[$i - 1] ) ) {
4312 $sections[$i] = $block;
4314 $sections[$i] = $head[$i - 1] . $block;
4327 Hooks::run(
'ParserSectionCreate', [ $this, $i, &$sections[$i], $showEditLink ] );
4332 if ( $enoughToc && $isMain && !$this->mForceTocPosition ) {
4335 $sections[0] = $sections[0] . $toc .
"\n";
4338 $full .= implode(
'', $sections );
4340 if ( $this->mForceTocPosition ) {
4341 return str_replace(
'<!--MWTOC-->', $toc, $full );
4361 if ( $clearState ) {
4362 $magicScopeVariable = $this->lock();
4364 $this->startParse( $title, $options,
self::OT_WIKI, $clearState );
4365 $this->setUser( $user );
4371 $text = str_replace( array_keys( $pairs ), array_values( $pairs ), $text );
4373 $text = $this->pstPass2( $text, $user );
4375 $text = $this->mStripState->unstripBoth( $text );
4377 $this->setUser( null ); # Reset
4393 # Note: This is the timestamp saved as hardcoded wikitext to
4394 # the database, we use $wgContLang here in order to give
4395 # everyone the same signature and use the default one rather
4396 # than the one selected in each user's preferences.
4397 # (see also bug 12815)
4398 $ts = $this->mOptions->getTimestamp();
4401 $tzMsg =
$timestamp->getTimezoneMessage()->inContentLanguage()->text();
4403 $d = $wgContLang->timeanddate( $ts,
false,
false ) .
" ($tzMsg)";
4405 # Variable replacement
4406 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4407 $text = $this->replaceVariables( $text );
4409 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4410 # which may corrupt this parser instance via its wfMessage()->text() call-
4413 $sigText = $this->getUserSig(
$user );
4414 $text = strtr( $text, [
4416 '~~~~' =>
"$sigText $d",
4420 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4422 $nc =
'[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can
use non-ascii!
4425 $p1 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/";
4427 $p4 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?($tc+))\\|]]/";
4429 $p3 =
"/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |,)$tc+|)\\|]]/";
4431 $p2 =
"/\[\[\\|($tc+)]]/";
4433 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4434 $text = preg_replace( $p1,
'[[\\1\\2\\3|\\2]]', $text );
4435 $text = preg_replace( $p4,
'[[\\1\\2\\3|\\2]]', $text );
4436 $text = preg_replace( $p3,
'[[\\1\\2\\3\\4|\\2]]', $text );
4438 $t = $this->mTitle->getText();
4440 if ( preg_match(
"/^($nc+:|)$tc+?( \\($tc+\\))$/",
$t, $m ) ) {
4441 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4442 } elseif ( preg_match(
"/^($nc+:|)$tc+?(, $tc+|)$/",
$t, $m ) &&
"$m[1]$m[2]" !=
'' ) {
4443 $text = preg_replace( $p2,
"[[$m[1]\\1$m[2]|\\1]]", $text );
4445 # if there's no context, don't bother duplicating the title
4446 $text = preg_replace( $p2,
'[[\\1]]', $text );
4449 # Trim trailing whitespace
4450 $text = rtrim( $text );
4474 # If not given, retrieve from the user object.
4475 if ( $nickname ===
false ) {
4476 $nickname =
$user->getOption(
'nickname' );
4479 if ( is_null( $fancySig ) ) {
4480 $fancySig =
$user->getBoolOption(
'fancysig' );
4483 $nickname = $nickname == null ?
$username : $nickname;
4485 if ( mb_strlen( $nickname ) > $wgMaxSigChars ) {
4487 wfDebug( __METHOD__ .
": $username has overlong signature.\n" );
4488 } elseif ( $fancySig !==
false ) {
4489 # Sig. might contain markup; validate this
4490 if ( $this->validateSig( $nickname ) !==
false ) {
4491 # Validated; clean up (if needed) and return it
4492 return $this->cleanSig( $nickname,
true );
4494 # Failed to validate; fall back to the default
4496 wfDebug( __METHOD__ .
": $username has bad XML tags in signature.\n" );
4500 # Make sure nickname doesnt get a sig in a sig
4501 $nickname = self::cleanSigInSig( $nickname );
4503 # If we're still here, make it a link to the user page
4506 $msgName =
$user->isAnon() ?
'signature-anon' :
'signature';
4508 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()
4509 ->title( $this->getTitle() )->text();
4535 $magicScopeVariable = $this->lock();
4539 # Option to disable this feature
4540 if ( !$this->mOptions->getCleanSignatures() ) {
4544 # @todo FIXME: Regex doesn't respect extension tags or nowiki
4545 # => Move this logic to braceSubstitution()
4547 $substRegex =
'/\{\{(?!(?:' . $substWord->getBaseRegex() .
'))/x' . $substWord->getRegexCase();
4548 $substText =
'{{' . $substWord->getSynonym( 0 );
4550 $text = preg_replace( $substRegex, $substText, $text );
4551 $text = self::cleanSigInSig( $text );
4552 $dom = $this->preprocessToDom( $text );
4553 $frame = $this->getPreprocessor()->newFrame();
4554 $text = $frame->expand( $dom );
4557 $text = $this->mStripState->unstripBoth( $text );
4570 $text = preg_replace(
'/~{3,5}/',
'', $text );
4584 $outputType, $clearState =
true
4586 $this->startParse(
$title, $options, $outputType, $clearState );
4596 $outputType, $clearState =
true
4598 $this->setTitle(
$title );
4600 $this->setOutputType( $outputType );
4601 if ( $clearState ) {
4602 $this->clearState();
4615 static $executing =
false;
4617 # Guard against infinite recursion
4660 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4661 throw new MWException(
"Invalid character {$m[0]} in setHook('$tag', ...) call" );
4663 $oldVal = isset( $this->mTagHooks[
$tag] ) ? $this->mTagHooks[
$tag] : null;
4664 $this->mTagHooks[
$tag] = $callback;
4665 if ( !in_array( $tag, $this->mStripList ) ) {
4666 $this->mStripList[] =
$tag;
4691 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4692 throw new MWException(
"Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
4694 $oldVal = isset( $this->mTransparentTagHooks[
$tag] ) ? $this->mTransparentTagHooks[
$tag] : null;
4695 $this->mTransparentTagHooks[
$tag] = $callback;
4704 $this->mTagHooks = [];
4705 $this->mFunctionTagHooks = [];
4706 $this->mStripList = $this->mDefaultStripList;
4755 $oldVal = isset( $this->mFunctionHooks[$id] ) ? $this->mFunctionHooks[$id][0] : null;
4756 $this->mFunctionHooks[$id] = [ $callback,
$flags ];
4758 # Add to function cache
4761 throw new MWException( __METHOD__ .
'() expecting a magic word identifier.' );
4764 $synonyms = $mw->getSynonyms();
4765 $sensitive = intval( $mw->isCaseSensitive() );
4767 foreach ( $synonyms
as $syn ) {
4769 if ( !$sensitive ) {
4770 $syn = $wgContLang->lc( $syn );
4776 # Remove trailing colon
4777 if ( substr( $syn, -1, 1 ) ===
':' ) {
4778 $syn = substr( $syn, 0, -1 );
4780 $this->mFunctionSynonyms[$sensitive][$syn] = $id;
4791 return array_keys( $this->mFunctionHooks );
4806 if ( preg_match(
'/[<>\r\n]/',
$tag, $m ) ) {
4807 throw new MWException(
"Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
4809 $old = isset( $this->mFunctionTagHooks[
$tag] ) ?
4810 $this->mFunctionTagHooks[
$tag] : null;
4811 $this->mFunctionTagHooks[
$tag] = [ $callback,
$flags ];
4813 if ( !in_array( $tag, $this->mStripList ) ) {
4814 $this->mStripList[] =
$tag;
4828 $this->mLinkHolders->replace( $text );
4839 return $this->mLinkHolders->replaceText( $text );
4858 if ( isset(
$params[
'mode'] ) ) {
4864 }
catch ( Exception
$e ) {
4869 $ig->setContextTitle( $this->mTitle );
4870 $ig->setShowBytes(
false );
4871 $ig->setShowFilename(
false );
4872 $ig->setParser( $this );
4873 $ig->setHideBadImages();
4876 if ( isset(
$params[
'showfilename'] ) ) {
4877 $ig->setShowFilename(
true );
4879 $ig->setShowFilename(
false );
4881 if ( isset(
$params[
'caption'] ) ) {
4882 $caption =
$params[
'caption'];
4883 $caption = htmlspecialchars( $caption );
4884 $caption = $this->replaceInternalLinks( $caption );
4885 $ig->setCaptionHtml( $caption );
4887 if ( isset(
$params[
'perrow'] ) ) {
4888 $ig->setPerRow(
$params[
'perrow'] );
4890 if ( isset(
$params[
'widths'] ) ) {
4891 $ig->setWidths(
$params[
'widths'] );
4893 if ( isset(
$params[
'heights'] ) ) {
4894 $ig->setHeights(
$params[
'heights'] );
4896 $ig->setAdditionalOptions(
$params );
4898 Hooks::run(
'BeforeParserrenderImageGallery', [ &$this, &$ig ] );
4900 $lines = StringUtils::explode(
"\n", $text );
4902 # match lines like these:
4903 # Image:someimage.jpg|This is some image
4905 preg_match(
"/^([^|]+)(\\|(.*))?$/", $line,
$matches );
4911 if ( strpos(
$matches[0],
'%' ) !==
false ) {
4915 if ( is_null(
$title ) ) {
4916 # Bogus title. Ignore these so we don't bomb out later.
4920 # We need to get what handler the file uses, to figure out parameters.
4921 # Note, a hook can overide the file name, and chose an entirely different
4922 # file (which potentially could be of a different type and have different handler).
4927 # Don't register it now, as ImageGallery does that later.
4929 $handler = $file ? $file->getHandler() :
false;
4932 'img_alt' =>
'gallery-internal-alt',
4933 'img_link' =>
'gallery-internal-link',
4936 $paramMap = $paramMap +
$handler->getParamMap();
4939 unset( $paramMap[
'img_width'] );
4947 $handlerOptions = [];
4956 $parameterMatches = StringUtils::explode(
'|',
$matches[3] );
4958 foreach ( $parameterMatches
as $parameterMatch ) {
4959 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
4961 $paramName = $paramMap[$magicName];
4963 switch ( $paramName ) {
4964 case 'gallery-internal-alt':
4965 $alt = $this->stripAltText( $match,
false );
4967 case 'gallery-internal-link':
4968 $linkValue = strip_tags( $this->replaceLinkHoldersText( $match ) );
4969 $chars = self::EXT_LINK_URL_CLASS;
4970 $addr = self::EXT_LINK_ADDR;
4971 $prots = $this->mUrlProtocols;
4973 if ( preg_match(
"/^($prots)$addr$chars*$/u", $linkValue ) ) {
4977 if ( $localLinkTitle !== null ) {
4984 if (
$handler->validateParam( $paramName, $match ) ) {
4985 $handlerOptions[$paramName] = $match;
4988 wfDebug(
"$parameterMatch failed parameter validation\n" );
4989 $label =
'|' . $parameterMatch;
4995 $label =
'|' . $parameterMatch;
4999 $label = substr( $label, 1 );
5002 $ig->add(
$title, $label, $alt,
$link, $handlerOptions );
5004 $html = $ig->toHTML();
5015 $handlerClass = get_class(
$handler );
5019 if ( !isset( $this->mImageParams[$handlerClass] ) ) {
5020 # Initialise static lists
5021 static $internalParamNames = [
5022 'horizAlign' => [
'left',
'right',
'center',
'none' ],
5023 'vertAlign' => [
'baseline',
'sub',
'super',
'top',
'text-top',
'middle',
5024 'bottom',
'text-bottom' ],
5025 'frame' => [
'thumbnail',
'manualthumb',
'framed',
'frameless',
5026 'upright',
'border',
'link',
'alt',
'class' ],
5028 static $internalParamMap;
5029 if ( !$internalParamMap ) {
5030 $internalParamMap = [];
5031 foreach ( $internalParamNames
as $type => $names ) {
5033 $magicName = str_replace(
'-',
'_',
"img_$name" );
5034 $internalParamMap[$magicName] = [
$type,
$name ];
5039 # Add handler params
5040 $paramMap = $internalParamMap;
5042 $handlerParamMap =
$handler->getParamMap();
5043 foreach ( $handlerParamMap
as $magic => $paramName ) {
5044 $paramMap[$magic] = [
'handler', $paramName ];
5047 $this->mImageParams[$handlerClass] = $paramMap;
5048 $this->mImageParamsMagicArray[$handlerClass] =
new MagicWordArray( array_keys( $paramMap ) );
5050 return [ $this->mImageParams[$handlerClass], $this->mImageParamsMagicArray[$handlerClass] ];
5062 # Check if the options text is of the form "options|alt text"
5064 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5065 # * left no resizing, just left align. label is used for alt= only
5066 # * right same, but right aligned
5067 # * none same, but not aligned
5068 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5069 # * center center the image
5070 # * frame Keep original image size, no magnify-button.
5071 # * framed Same as "frame"
5072 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5073 # * upright reduce width for upright images, rounded to full __0 px
5074 # * border draw a 1px border around the image
5075 # * alt Text for HTML alt attribute (defaults to empty)
5076 # * class Set a class for img node
5077 # * link Set the target of the image link. Can be external, interwiki, or local
5078 # vertical-align values (no % or length right now):
5088 $parts = StringUtils::explode(
"|",
$options );
5090 # Give extensions a chance to select the file revision for us
5095 # Fetch and register the file (file title may be different via hooks)
5099 $handler = $file ? $file->getHandler() :
false;
5101 list( $paramMap, $mwArray ) = $this->getImageParams(
$handler );
5104 $this->addTrackingCategory(
'broken-file-category' );
5107 # Process the input parameters
5109 $params = [
'frame' => [],
'handler' => [],
5110 'horizAlign' => [],
'vertAlign' => [] ];
5111 $seenformat =
false;
5112 foreach ( $parts
as $part ) {
5113 $part = trim( $part );
5114 list( $magicName,
$value ) = $mwArray->matchVariableStartToEnd( $part );
5116 if ( isset( $paramMap[$magicName] ) ) {
5117 list(
$type, $paramName ) = $paramMap[$magicName];
5119 # Special case; width and height come in one variable together
5120 if (
$type ===
'handler' && $paramName ===
'width' ) {
5121 $parsedWidthParam = $this->parseWidthParam(
$value );
5122 if ( isset( $parsedWidthParam[
'width'] ) ) {
5123 $width = $parsedWidthParam[
'width'];
5124 if (
$handler->validateParam(
'width', $width ) ) {
5129 if ( isset( $parsedWidthParam[
'height'] ) ) {
5130 $height = $parsedWidthParam[
'height'];
5131 if (
$handler->validateParam(
'height', $height ) ) {
5136 # else no validation -- bug 13436
5138 if (
$type ===
'handler' ) {
5139 # Validate handler parameter
5142 # Validate internal parameters
5143 switch ( $paramName ) {
5147 # @todo FIXME: Possibly check validity here for
5148 # manualthumb? downstream behavior seems odd with
5149 # missing manual thumbs.
5154 $chars = self::EXT_LINK_URL_CLASS;
5155 $addr = self::EXT_LINK_ADDR;
5156 $prots = $this->mUrlProtocols;
5158 $paramName =
'no-link';
5161 } elseif ( preg_match(
"/^((?i)$prots)/",
$value ) ) {
5162 if ( preg_match(
"/^((?i)$prots)$addr$chars*$/u",
$value, $m ) ) {
5163 $paramName =
'link-url';
5164 $this->mOutput->addExternalLink(
$value );
5165 if ( $this->mOptions->getExternalLinkTarget() ) {
5166 $params[
$type][
'link-target'] = $this->mOptions->getExternalLinkTarget();
5173 $paramName =
'link-title';
5175 $this->mOutput->addLink( $linkTitle );
5184 $validated = ! $seenformat;
5188 # Most other things appear to be empty or numeric...
5189 $validated = (
$value ===
false || is_numeric( trim(
$value ) ) );
5198 if ( !$validated ) {
5203 # Process alignment parameters
5204 if (
$params[
'horizAlign'] ) {
5211 $params[
'frame'][
'caption'] = $caption;
5213 # Will the image be presented in a frame, with the caption below?
5214 $imageIsFramed = isset(
$params[
'frame'][
'frame'] )
5215 || isset(
$params[
'frame'][
'framed'] )
5216 || isset(
$params[
'frame'][
'thumbnail'] )
5217 || isset(
$params[
'frame'][
'manualthumb'] );
5219 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5220 # came to also set the caption, ordinary text after the image -- which
5221 # makes no sense, because that just repeats the text multiple times in
5222 # screen readers. It *also* came to set the title attribute.
5223 # Now that we have an alt attribute, we should not set the alt text to
5224 # equal the caption: that's worse than useless, it just repeats the
5225 # text. This is the framed/thumbnail case. If there's no caption, we
5226 # use the unnamed parameter for alt text as well, just for the time be-
5227 # ing, if the unnamed param is set and the alt param is not.
5228 # For the future, we need to figure out if we want to tweak this more,
5229 # e.g., introducing a title= parameter for the title; ignoring the un-
5230 # named parameter entirely for images without a caption; adding an ex-
5231 # plicit caption= parameter and preserving the old magic unnamed para-
5233 if ( $imageIsFramed ) { # Framed image
5234 if ( $caption ===
'' && !isset(
$params[
'frame'][
'alt'] ) ) {
5235 # No caption or alt text, add the filename as the alt text so
5236 # that screen readers at least get some description of the image
5239 # Do not set $params['frame']['title'] because tooltips don't make sense
5241 }
else { # Inline image
5242 if ( !isset(
$params[
'frame'][
'alt'] ) ) {
5243 # No alt text, use the "caption" for the alt text
5244 if ( $caption !==
'' ) {
5245 $params[
'frame'][
'alt'] = $this->stripAltText( $caption, $holders );
5247 # No caption, fall back to using the filename for the
5252 # Use the "caption" for the tooltip text
5253 $params[
'frame'][
'title'] = $this->stripAltText( $caption, $holders );
5258 # Linker does the rest
5261 $time, $descQuery, $this->mOptions->getThumbSize() );
5263 # Give the handler a chance to modify the parser object
5265 $handler->parserTransformHook( $this, $file );
5277 # Strip bad stuff out of the title (tooltip). We can't just use
5278 # replaceLinkHoldersText() here, because if this function is called
5279 # from replaceInternalLinks2(), mLinkHolders won't be up-to-date.
5281 $tooltip = $holders->replaceText( $caption );
5283 $tooltip = $this->replaceLinkHoldersText( $caption );
5286 # make sure there are no placeholders in thumbnail attributes
5287 # that are later expanded to html- so expand them now and
5289 $tooltip = $this->mStripState->unstripBoth( $tooltip );
5301 wfDebug(
"Parser output marked as uncacheable.\n" );
5302 if ( !$this->mOutput ) {
5304 " can only be called when actually parsing something" );
5306 $this->mOutput->updateCacheExpiry( 0 );
5318 $text = $this->replaceVariables( $text, $frame );
5319 $text = $this->mStripState->unstripBoth( $text );
5330 array_keys( $this->mTransparentTagHooks ),
5331 array_keys( $this->mTagHooks ),
5332 array_keys( $this->mFunctionTagHooks )
5348 $elements = array_keys( $this->mTransparentTagHooks );
5349 $text = self::extractTagsAndParams( $elements, $text,
$matches );
5354 $tagName = strtolower( $element );
5355 if ( isset( $this->mTransparentTagHooks[$tagName] ) ) {
5356 $output = call_user_func_array(
5357 $this->mTransparentTagHooks[$tagName],
5363 $replacements[$marker] =
$output;
5365 return strtr( $text, $replacements );
5400 $magicScopeVariable = $this->lock();
5403 $frame = $this->getPreprocessor()->newFrame();
5405 # Process section extraction flags
5407 $sectionParts = explode(
'-', $sectionId );
5408 $sectionIndex = array_pop( $sectionParts );
5409 foreach ( $sectionParts
as $part ) {
5410 if ( $part ===
'T' ) {
5411 $flags |= self::PTD_FOR_INCLUSION;
5415 # Check for empty input
5416 if ( strval( $text ) ===
'' ) {
5417 # Only sections 0 and T-0 exist in an empty document
5418 if ( $sectionIndex == 0 ) {
5419 if ( $mode ===
'get' ) {
5425 if ( $mode ===
'get' ) {
5433 # Preprocess the text
5434 $root = $this->preprocessToDom( $text,
$flags );
5436 # <h> nodes indicate section breaks
5437 # They can only occur at the top level, so we can find them by iterating the root's children
5438 $node = $root->getFirstChild();
5440 # Find the target section
5441 if ( $sectionIndex == 0 ) {
5442 # Section zero doesn't nest, level=big
5443 $targetLevel = 1000;
5446 if ( $node->getName() ===
'h' ) {
5447 $bits = $node->splitHeading();
5448 if ( $bits[
'i'] == $sectionIndex ) {
5449 $targetLevel = $bits[
'level'];
5453 if ( $mode ===
'replace' ) {
5456 $node = $node->getNextSibling();
5462 if ( $mode ===
'get' ) {
5469 # Find the end of the section, including nested sections
5471 if ( $node->getName() ===
'h' ) {
5472 $bits = $node->splitHeading();
5473 $curLevel = $bits[
'level'];
5474 if ( $bits[
'i'] != $sectionIndex && $curLevel <= $targetLevel ) {
5478 if ( $mode ===
'get' ) {
5481 $node = $node->getNextSibling();
5484 # Write out the remainder (in replace mode only)
5485 if ( $mode ===
'replace' ) {
5486 # Output the replacement text
5487 # Add two newlines on -- trailing whitespace in $newText is conventionally
5488 # stripped by the editor, so we need both newlines to restore the paragraph gap
5489 # Only add trailing whitespace if there is newText
5490 if ( $newText !=
"" ) {
5491 $outText .= $newText .
"\n\n";
5496 $node = $node->getNextSibling();
5500 if ( is_string( $outText ) ) {
5501 # Re-insert stripped tags
5502 $outText = rtrim( $this->mStripState->unstripBoth( $outText ) );
5522 public function getSection( $text, $sectionId, $defaultText =
'' ) {
5523 return $this->extractSections( $text, $sectionId,
'get', $defaultText );
5539 return $this->extractSections( $oldText, $sectionId,
'replace', $newText );
5548 return $this->mRevisionId;
5558 if ( !is_null( $this->mRevisionObject ) ) {
5559 return $this->mRevisionObject;
5561 if ( is_null( $this->mRevisionId ) ) {
5565 $rev = call_user_func(
5566 $this->mOptions->getCurrentRevisionCallback(), $this->getTitle(), $this
5569 # If the parse is for a new revision, then the callback should have
5570 # already been set to force the object and should match mRevisionId.
5571 # If not, try to fetch by mRevisionId for sanity.
5572 if (
$rev &&
$rev->getId() != $this->mRevisionId ) {
5576 $this->mRevisionObject =
$rev;
5578 return $this->mRevisionObject;
5587 if ( is_null( $this->mRevisionTimestamp ) ) {
5590 $revObject = $this->getRevisionObject();
5593 # The cryptic '' timezone parameter tells to use the site-default
5594 # timezone offset instead of the user settings.
5595 # Since this value will be saved into the parser cache, served
5596 # to other users, and potentially even used inside links and such,
5597 # it needs to be consistent for all visitors.
5598 $this->mRevisionTimestamp = $wgContLang->userAdjust(
$timestamp,
'' );
5601 return $this->mRevisionTimestamp;
5610 if ( is_null( $this->mRevisionUser ) ) {
5611 $revObject = $this->getRevisionObject();
5613 # if this template is subst: the revision id will be blank,
5614 # so just use the current user's name
5616 $this->mRevisionUser = $revObject->getUserText();
5617 } elseif ( $this->ot[
'wiki'] || $this->mOptions->getIsPreview() ) {
5618 $this->mRevisionUser = $this->getUser()->getName();
5621 return $this->mRevisionUser;
5630 if ( is_null( $this->mRevisionSize ) ) {
5631 $revObject = $this->getRevisionObject();
5633 # if this variable is subst: the revision id will be blank,
5634 # so just use the parser input size, because the own substituation
5635 # will change the size.
5637 $this->mRevisionSize = $revObject->getSize();
5639 $this->mRevisionSize = $this->mInputSize;
5642 return $this->mRevisionSize;
5651 $this->mDefaultSort =
$sort;
5652 $this->mOutput->setProperty(
'defaultsort',
$sort );
5666 if ( $this->mDefaultSort !==
false ) {
5667 return $this->mDefaultSort;
5680 return $this->mDefaultSort;
5693 # Strip out wikitext links(they break the anchor)
5694 $text = $this->stripSectionName( $text );
5708 # Strip out wikitext links(they break the anchor)
5709 $text = $this->stripSectionName( $text );
5729 # Strip internal link markup
5730 $text = preg_replace(
'/\[\[:?([^[|]+)\|([^[]+)\]\]/',
'$2', $text );
5731 $text = preg_replace(
'/\[\[:?([^[]+)\|?\]\]/',
'$1', $text );
5733 # Strip external link markup
5734 # @todo FIXME: Not tolerant to blank link text
5735 # I.E. [https://www.mediawiki.org] will render as [1] or something depending
5736 # on how many empty links there are on the page - need to figure that out.
5737 $text = preg_replace(
'/\[(?i:' . $this->mUrlProtocols .
')([^ ]+?) ([^[]+)\]/',
'$2', $text );
5739 # Parse wikitext quotes (italics & bold)
5740 $text = $this->doQuotes( $text );
5743 $text = StringUtils::delimiterReplace(
'<',
'>',
'', $text );
5760 $magicScopeVariable = $this->lock();
5761 $this->startParse( $title, $options, $outputType,
true );
5763 $text = $this->replaceVariables( $text );
5764 $text = $this->mStripState->unstripBoth( $text );
5776 return $this->preSaveTransform( $text, $title, $options->
getUser(),
$options );
5808 while ( $i < strlen(
$s ) ) {
5809 $markerStart = strpos(
$s, self::MARKER_PREFIX, $i );
5810 if ( $markerStart ===
false ) {
5811 $out .= call_user_func( $callback, substr(
$s, $i ) );
5814 $out .= call_user_func( $callback, substr(
$s, $i, $markerStart - $i ) );
5815 $markerEnd = strpos(
$s, self::MARKER_SUFFIX, $markerStart );
5816 if ( $markerEnd ===
false ) {
5817 $out .= substr(
$s, $markerStart );
5820 $markerEnd += strlen( self::MARKER_SUFFIX );
5821 $out .= substr(
$s, $markerStart, $markerEnd - $markerStart );
5836 return $this->mStripState->killMarkers( $text );
5858 'version' => self::HALF_PARSED_VERSION,
5859 'stripState' => $this->mStripState->getSubState( $text ),
5860 'linkHolders' => $this->mLinkHolders->getSubArray( $text )
5881 if ( !isset( $data[
'version'] ) || $data[
'version'] != self::HALF_PARSED_VERSION ) {
5882 throw new MWException( __METHOD__ .
': invalid version' );
5885 # First, extract the strip state.
5886 $texts = [ $data[
'text'] ];
5887 $texts = $this->mStripState->merge( $data[
'stripState'], $texts );
5889 # Now renumber links
5890 $texts = $this->mLinkHolders->mergeForeign( $data[
'linkHolders'], $texts );
5892 # Should be good to go.
5906 return isset( $data[
'version'] ) && $data[
'version'] == self::HALF_PARSED_VERSION;
5918 $parsedWidthParam = [];
5920 return $parsedWidthParam;
5923 # (bug 13500) In both cases (width/height and width only),
5924 # permit trailing "px" for backward compatibility.
5925 if ( preg_match(
'/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/',
$value, $m ) ) {
5926 $width = intval( $m[1] );
5927 $height = intval( $m[2] );
5928 $parsedWidthParam[
'width'] = $width;
5929 $parsedWidthParam[
'height'] = $height;
5930 } elseif ( preg_match(
'/^[0-9]*\s*(?:px)?\s*$/',
$value ) ) {
5931 $width = intval(
$value );
5932 $parsedWidthParam[
'width'] = $width;
5934 return $parsedWidthParam;
5947 if ( $this->mInParse ) {
5948 throw new MWException(
"Parser state cleared while parsing. "
5949 .
"Did you call Parser::parse recursively?" );
5951 $this->mInParse =
true;
5954 $this->mInParse =
false;
5957 return $recursiveCheck;
5972 if ( preg_match(
'/^<p>(.*)\n?<\/p>\n?$/sU',
$html, $m ) ) {
5973 if ( strpos( $m[1],
'</p>' ) ===
false ) {
5993 if ( $this->mInParse ) {
5994 return new $wgParserConf[
'class']( $wgParserConf );
6008 $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.
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
$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?
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.
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.
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
$wgEnableScaryTranscluding
Enable interwiki transcluding.
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.
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-->" link placeholders with actual links, in the buffer Placeholders created in Link...
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.
Represents a title within MediaWiki.
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
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.
see documentation in includes Linker php for Linker::makeImageLink & $time
maybeDoSubpageLink($target, &$text)
Handle link to subpage if necessary.
If you want to remove the page from your watchlist later
replaceLinkHoldersText($text)
Replace "<!--LINK-->" 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
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
static getLocalInstance($ts=false)
Get a timestamp instance in the server local timezone ($wgLocaltimezone)
$wgMaxSigChars
Maximum number of Unicode characters in signature.
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...
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
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.
$wgNoFollowNsExceptions
Namespaces in which $wgNoFollowLinks doesn't apply.
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)
Class for asserting that a callback happens when an dummy object leaves scope.
$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.
__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.
bool $mInParse
Recursive call protection.
Some quick notes on the file repository architecture Functionality is
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)
$wgNoFollowLinks
If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to sear...
fetchCurrentRevisionOfTitle($title)
Fetch the current revision of a given title.
stripAltText($caption, $holders)
doAllQuotes($text)
Replace single quotes with HTML markup.
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, $legacyAnchor=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
$wgNoFollowDomainExceptions
If this is set to an array of domains, external links to these domain names (or any subdomains) will ...
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
$wgTranscludeCacheExpiry
Expiry time for transcluded templates cached in transcache database table.
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.
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 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 after processing 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"<
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
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.
Handles a simple LRU key/value map with a maximum number of entries.
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
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 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.
equals(Content $that=null)
Returns true if this Content objects is conceptually equivalent to the given Content object...
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
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.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
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.
string $mUniqPrefix
Deprecated accessor for the strip marker prefix.
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
WebRequest clone which takes values from a provided array.
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...
static statelessFetchRevision($title, $parser=false)
Wrapper around Revision::newFromTitle to allow passing additional parameters without passing them on ...
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()
getLinkURL($query= '', $query2=false, $proto=false)
Get a URL that's the simplest URL that will be valid to link, locally, to the current Title...
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.
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
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
if(!$wgRequest->checkUrlExtension()) if(!$wgEnableAPI) $wgTitle
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
Marks HTML that shouldn't be escaped.
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 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...
PHP Parser - Processes wiki markup (which uses a more user-friendly syntax, such as "[[link]]" for ma...
$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.
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
Allows to change the fields on the form that will be generated $name