3 * PHP parser that converts wiki markup to HTML.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\BadFileLookup
;
24 use MediaWiki\Config\ServiceOptions
;
25 use MediaWiki\Linker\LinkRenderer
;
26 use MediaWiki\Linker\LinkRendererFactory
;
27 use MediaWiki\Linker\LinkTarget
;
28 use MediaWiki\MediaWikiServices
;
29 use MediaWiki\Special\SpecialPageFactory
;
30 use Psr\Log\NullLogger
;
31 use Wikimedia\ScopedCallback
;
32 use Psr\Log\LoggerInterface
;
35 * @defgroup Parser Parser
39 * PHP Parser - Processes wiki markup (which uses a more user-friendly
40 * syntax, such as "[[link]]" for making links), and provides a one-way
41 * transformation of that wiki markup it into (X)HTML output / markup
42 * (which in turn the browser understands, and can display).
44 * There are seven main entry points into the Parser class:
47 * produces HTML output
48 * - Parser::preSaveTransform()
49 * produces altered wiki markup
50 * - Parser::preprocess()
51 * removes HTML comments and expands templates
52 * - Parser::cleanSig() and Parser::cleanSigInSig()
53 * cleans a signature before saving it to preferences
54 * - Parser::getSection()
55 * return the content of a section from an article for section editing
56 * - Parser::replaceSection()
57 * replaces a section by number inside an article
58 * - Parser::getPreloadText()
59 * removes <noinclude> sections and <includeonly> tags
61 * @warning $wgUser or $wgTitle or $wgRequest or $wgLang. Keep them away!
64 * $wgNamespacesWithSubpages
66 * @par Settings only within ParserOptions:
67 * $wgAllowExternalImages
68 * $wgAllowSpecialInclusion
76 * Update this version number when the ParserOutput format
77 * changes in an incompatible way, so the parser cache
78 * can automatically discard old data.
80 const VERSION
= '1.6.4';
83 * Update this version number when the output of serialiseHalfParsedText()
84 * changes in an incompatible way
86 const HALF_PARSED_VERSION
= 2;
88 # Flags for Parser::setFunctionHook
89 const SFH_NO_HASH
= 1;
90 const SFH_OBJECT_ARGS
= 2;
92 # Constants needed for external link processing
93 # Everything except bracket, space, or control characters
94 # \p{Zs} is unicode 'separator, space' category. It covers the space 0x20
95 # as well as U+3000 is IDEOGRAPHIC SPACE for T21052
96 # \x{FFFD} is the Unicode replacement character, which Preprocessor_DOM
97 # uses to replace invalid HTML characters.
98 const EXT_LINK_URL_CLASS
= '[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]';
99 # Simplified expression to match an IPv4 or IPv6 address, or
100 # at least one character of a host name (embeds EXT_LINK_URL_CLASS)
101 const EXT_LINK_ADDR
= '(?:[0-9.]+|\\[(?i:[0-9a-f:.]+)\\]|[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}])';
102 # RegExp to make image URLs (embeds IPv6 part of EXT_LINK_ADDR)
103 // phpcs:ignore Generic.Files.LineLength
104 const EXT_IMAGE_REGEX
= '/^(http:\/\/|https:\/\/)((?:\\[(?i:[0-9a-f:.]+)\\])?[^][<>"\\x00-\\x20\\x7F\p{Zs}\x{FFFD}]+)
105 \\/([A-Za-z0-9_.,~%\\-+&;#*?!=()@\\x80-\\xFF]+)\\.((?i)gif|png|jpg|jpeg)$/Sxu';
107 # Regular expression for a non-newline space
108 const SPACE_NOT_NL
= '(?:\t| |&\#0*160;|&\#[Xx]0*[Aa]0;|\p{Zs})';
110 # Flags for preprocessToDom
111 const PTD_FOR_INCLUSION
= 1;
113 # Allowed values for $this->mOutputType
114 # Parameter to startExternalParse().
115 const OT_HTML
= 1; # like parse()
116 const OT_WIKI
= 2; # like preSaveTransform()
117 const OT_PREPROCESS
= 3; # like preprocess()
119 const OT_PLAIN
= 4; # like extractSections() - portions of the original are returned unchanged.
122 * @var string Prefix and suffix for temporary replacement strings
123 * for the multipass parser.
125 * \x7f should never appear in input as it's disallowed in XML.
126 * Using it at the front also gives us a little extra robustness
127 * since it shouldn't match when butted up against identifier-like
130 * Must not consist of all title characters, or else it will change
131 * the behavior of <nowiki> in a link.
133 * Must have a character that needs escaping in attributes, otherwise
134 * someone could put a strip marker in an attribute, to get around
135 * escaping quote marks, and break out of the attribute. Thus we add
138 const MARKER_SUFFIX
= "-QINU`\"'\x7f";
139 const MARKER_PREFIX
= "\x7f'\"`UNIQ-";
141 # Markers used for wrapping the table of contents
142 const TOC_START
= '<mw:toc>';
143 const TOC_END
= '</mw:toc>';
145 /** @var int Assume that no output will later be saved this many seconds after parsing */
149 public $mTagHooks = [];
150 public $mTransparentTagHooks = [];
151 public $mFunctionHooks = [];
152 public $mFunctionSynonyms = [ 0 => [], 1 => [] ];
153 public $mFunctionTagHooks = [];
154 public $mStripList = [];
155 public $mDefaultStripList = [];
156 public $mVarCache = [];
157 public $mImageParams = [];
158 public $mImageParamsMagicArray = [];
159 public $mMarkerIndex = 0;
161 * @var bool Whether firstCallInit still needs to be called
163 public $mFirstCall = true;
165 # Initialised by initializeVariables()
168 * @var MagicWordArray
173 * @var MagicWordArray
178 * @deprecated since 1.34, there should be no need to use this
183 # Initialised in constructor
184 public $mExtLinkBracketedRegex, $mUrlProtocols;
186 # Initialized in getPreprocessor()
187 /** @var Preprocessor */
188 public $mPreprocessor;
190 # Cleared with clearState():
202 public $mIncludeCount;
204 * @var LinkHolderArray
206 public $mLinkHolders;
209 public $mIncludeSizes, $mPPNodeCount, $mGeneratedPPNodeCount, $mHighestExpansionDepth;
210 public $mDefaultSort;
211 public $mTplRedirCache, $mHeadings, $mDoubleUnderscores;
212 public $mExpensiveFunctionCount; # number of expensive parser function calls
213 public $mShowToc, $mForceTocPosition;
215 public $mTplDomCache;
220 public $mUser; # User object; only used when doing pre-save transform
223 # These are variables reset at least once per parse regardless of $clearState
231 * Since 1.34, leaving `mTitle` uninitialized or setting `mTitle` to
232 * `null` is deprecated.
237 public $mTitle; # Title context, used for self-link rendering and similar things
238 public $mOutputType; # Output type, one of the OT_xxx constants
239 public $ot; # Shortcut alias, see setOutputType()
240 public $mRevisionObject; # The revision object of the specified revision ID
241 public $mRevisionId; # ID to display in {{REVISIONID}} tags
242 public $mRevisionTimestamp; # The timestamp of the specified revision ID
243 public $mRevisionUser; # User to display in {{REVISIONUSER}} tag
244 public $mRevisionSize; # Size to display in {{REVISIONSIZE}} variable
245 public $mRevIdForTs; # The revision ID which was used to fetch the timestamp
246 public $mInputSize = false; # For {{PAGESIZE}} on current page.
249 * @var array Array with the language name of each language link (i.e. the
250 * interwiki prefix) in the key, value arbitrary. Used to avoid sending
251 * duplicate language links to the ParserOutput.
253 public $mLangLinkLanguages;
256 * @var MapCacheLRU|null
259 * A cache of the current revisions of titles. Keys are $title->getPrefixedDbKey()
261 public $currentRevisionCache;
264 * @var bool|string Recursive call protection.
265 * This variable should be treated as if it were private.
267 public $mInParse = false;
269 /** @var SectionProfiler */
270 protected $mProfiler;
275 protected $mLinkRenderer;
277 /** @var MagicWordFactory */
278 private $magicWordFactory;
283 /** @var ParserFactory */
286 /** @var SpecialPageFactory */
287 private $specialPageFactory;
290 * This is called $svcOptions instead of $options like elsewhere to avoid confusion with
291 * $mOptions, which is public and widely used, and also with the local variable $options used
292 * for ParserOptions throughout this file.
294 * @var ServiceOptions
298 /** @var LinkRendererFactory */
299 private $linkRendererFactory;
301 /** @var NamespaceInfo */
304 /** @var LoggerInterface */
307 /** @var BadFileLookup */
308 private $badFileLookup;
311 * TODO Make this a const when HHVM support is dropped (T192166)
316 public static $constructorOptions = [
317 // See $wgParserConf documentation
320 // See documentation for the corresponding config options
322 'EnableScaryTranscluding',
323 'ExtraInterlanguageLinkPrefixes',
335 'TranscludeCacheExpiry',
339 * Constructing parsers directly is deprecated! Use a ParserFactory.
341 * @param ServiceOptions|null $svcOptions
342 * @param MagicWordFactory|null $magicWordFactory
343 * @param Language|null $contLang Content language
344 * @param ParserFactory|null $factory
345 * @param string|null $urlProtocols As returned from wfUrlProtocols()
346 * @param SpecialPageFactory|null $spFactory
347 * @param LinkRendererFactory|null $linkRendererFactory
348 * @param NamespaceInfo|null $nsInfo
349 * @param LoggerInterface|null $logger
350 * @param BadFileLookup|null $badFileLookup
352 public function __construct(
354 MagicWordFactory
$magicWordFactory = null,
355 Language
$contLang = null,
356 ParserFactory
$factory = null,
357 $urlProtocols = null,
358 SpecialPageFactory
$spFactory = null,
359 $linkRendererFactory = null,
362 BadFileLookup
$badFileLookup = null
364 if ( !$svcOptions ||
is_array( $svcOptions ) ) {
365 // Pre-1.34 calling convention is the first parameter is just ParserConf, the seventh is
366 // Config, and the eighth is LinkRendererFactory.
367 $this->mConf
= (array)$svcOptions;
368 if ( empty( $this->mConf
['class'] ) ) {
369 $this->mConf
['class'] = self
::class;
371 if ( empty( $this->mConf
['preprocessorClass'] ) ) {
372 $this->mConf
['preprocessorClass'] = self
::getDefaultPreprocessorClass();
374 $this->svcOptions
= new ServiceOptions( self
::$constructorOptions,
375 $this->mConf
, func_num_args() > 6
376 ?
func_get_arg( 6 ) : MediaWikiServices
::getInstance()->getMainConfig()
378 $linkRendererFactory = func_num_args() > 7 ?
func_get_arg( 7 ) : null;
379 $nsInfo = func_num_args() > 8 ?
func_get_arg( 8 ) : null;
381 // New calling convention
382 $svcOptions->assertRequiredOptions( self
::$constructorOptions );
383 // $this->mConf is public, so we'll keep those two options there as well for
384 // compatibility until it's removed
386 'class' => $svcOptions->get( 'class' ),
387 'preprocessorClass' => $svcOptions->get( 'preprocessorClass' ),
389 $this->svcOptions
= $svcOptions;
392 $this->mUrlProtocols
= $urlProtocols ??
wfUrlProtocols();
393 $this->mExtLinkBracketedRegex
= '/\[(((?i)' . $this->mUrlProtocols
. ')' .
394 self
::EXT_LINK_ADDR
.
395 self
::EXT_LINK_URL_CLASS
. '*)\p{Zs}*([^\]\\x00-\\x08\\x0a-\\x1F\\x{FFFD}]*?)\]/Su';
397 $this->magicWordFactory
= $magicWordFactory ??
398 MediaWikiServices
::getInstance()->getMagicWordFactory();
400 $this->contLang
= $contLang ?? MediaWikiServices
::getInstance()->getContentLanguage();
402 $this->factory
= $factory ?? MediaWikiServices
::getInstance()->getParserFactory();
403 $this->specialPageFactory
= $spFactory ??
404 MediaWikiServices
::getInstance()->getSpecialPageFactory();
405 $this->linkRendererFactory
= $linkRendererFactory ??
406 MediaWikiServices
::getInstance()->getLinkRendererFactory();
407 $this->nsInfo
= $nsInfo ?? MediaWikiServices
::getInstance()->getNamespaceInfo();
408 $this->logger
= $logger ?
: new NullLogger();
409 $this->badFileLookup
= $badFileLookup ??
410 MediaWikiServices
::getInstance()->getBadFileLookup();
414 * Reduce memory usage to reduce the impact of circular references
416 public function __destruct() {
417 if ( isset( $this->mLinkHolders
) ) {
418 // @phan-suppress-next-line PhanTypeObjectUnsetDeclaredProperty
419 unset( $this->mLinkHolders
);
421 // @phan-suppress-next-line PhanTypeSuspiciousNonTraversableForeach
422 foreach ( $this as $name => $value ) {
423 unset( $this->$name );
428 * Allow extensions to clean up when the parser is cloned
430 public function __clone() {
431 $this->mInParse
= false;
433 // T58226: When you create a reference "to" an object field, that
434 // makes the object field itself be a reference too (until the other
435 // reference goes out of scope). When cloning, any field that's a
436 // reference is copied as a reference in the new object. Both of these
437 // are defined PHP5 behaviors, as inconvenient as it is for us when old
438 // hooks from PHP4 days are passing fields by reference.
439 foreach ( [ 'mStripState', 'mVarCache' ] as $k ) {
440 // Make a non-reference copy of the field, then rebind the field to
441 // reference the new copy.
447 Hooks
::run( 'ParserCloned', [ $this ] );
451 * Which class should we use for the preprocessor if not otherwise specified?
454 * @deprecated since 1.34, removing configurability of preprocessor
457 public static function getDefaultPreprocessorClass() {
458 return Preprocessor_Hash
::class;
462 * Do various kinds of initialisation on the first call of the parser
464 public function firstCallInit() {
465 if ( !$this->mFirstCall
) {
468 $this->mFirstCall
= false;
470 CoreParserFunctions
::register( $this );
471 CoreTagHooks
::register( $this );
472 $this->initializeVariables();
474 // Avoid PHP 7.1 warning from passing $this by reference
476 Hooks
::run( 'ParserFirstCallInit', [ &$parser ] );
484 public function clearState() {
485 $this->firstCallInit();
486 $this->resetOutput();
487 $this->mAutonumber
= 0;
488 $this->mIncludeCount
= [];
489 $this->mLinkHolders
= new LinkHolderArray( $this );
491 $this->mRevisionObject
= $this->mRevisionTimestamp
=
492 $this->mRevisionId
= $this->mRevisionUser
= $this->mRevisionSize
= null;
493 $this->mVarCache
= [];
495 $this->mLangLinkLanguages
= [];
496 $this->currentRevisionCache
= null;
498 $this->mStripState
= new StripState( $this );
500 # Clear these on every parse, T6549
501 $this->mTplRedirCache
= $this->mTplDomCache
= [];
503 $this->mShowToc
= true;
504 $this->mForceTocPosition
= false;
505 $this->mIncludeSizes
= [
509 $this->mPPNodeCount
= 0;
510 $this->mGeneratedPPNodeCount
= 0;
511 $this->mHighestExpansionDepth
= 0;
512 $this->mDefaultSort
= false;
513 $this->mHeadings
= [];
514 $this->mDoubleUnderscores
= [];
515 $this->mExpensiveFunctionCount
= 0;
518 if ( isset( $this->mPreprocessor
) && $this->mPreprocessor
->parser
!== $this ) {
519 $this->mPreprocessor
= null;
522 $this->mProfiler
= new SectionProfiler();
524 // Avoid PHP 7.1 warning from passing $this by reference
526 Hooks
::run( 'ParserClearState', [ &$parser ] );
530 * Reset the ParserOutput
532 public function resetOutput() {
533 $this->mOutput
= new ParserOutput
;
534 $this->mOptions
->registerWatcher( [ $this->mOutput
, 'recordOption' ] );
538 * Convert wikitext to HTML
539 * Do not call this function recursively.
541 * @param string $text Text we want to parse
542 * @param-taint $text escapes_htmlnoent
543 * @param Title $title
544 * @param ParserOptions $options
545 * @param bool $linestart
546 * @param bool $clearState
547 * @param int|null $revid ID of the revision being rendered. This is used to render
548 * REVISION* magic words. 0 means that any current revision will be used. Null means
549 * that {{REVISIONID}}/{{REVISIONUSER}} will be empty and {{REVISIONTIMESTAMP}} will
550 * use the current timestamp.
551 * @return ParserOutput A ParserOutput
552 * @return-taint escaped
554 public function parse(
555 $text, Title
$title, ParserOptions
$options,
556 $linestart = true, $clearState = true, $revid = null
559 // We use U+007F DELETE to construct strip markers, so we have to make
560 // sure that this character does not occur in the input text.
561 $text = strtr( $text, "\x7f", "?" );
562 $magicScopeVariable = $this->lock();
564 // Strip U+0000 NULL (T159174)
565 $text = str_replace( "\000", '', $text );
567 $this->startParse( $title, $options, self
::OT_HTML
, $clearState );
569 $this->currentRevisionCache
= null;
570 $this->mInputSize
= strlen( $text );
571 if ( $this->mOptions
->getEnableLimitReport() ) {
572 $this->mOutput
->resetParseStartTime();
575 $oldRevisionId = $this->mRevisionId
;
576 $oldRevisionObject = $this->mRevisionObject
;
577 $oldRevisionTimestamp = $this->mRevisionTimestamp
;
578 $oldRevisionUser = $this->mRevisionUser
;
579 $oldRevisionSize = $this->mRevisionSize
;
580 if ( $revid !== null ) {
581 $this->mRevisionId
= $revid;
582 $this->mRevisionObject
= null;
583 $this->mRevisionTimestamp
= null;
584 $this->mRevisionUser
= null;
585 $this->mRevisionSize
= null;
588 // Avoid PHP 7.1 warning from passing $this by reference
590 Hooks
::run( 'ParserBeforeStrip', [ &$parser, &$text, &$this->mStripState
] );
592 Hooks
::run( 'ParserAfterStrip', [ &$parser, &$text, &$this->mStripState
] );
593 $text = $this->internalParse( $text );
594 Hooks
::run( 'ParserAfterParse', [ &$parser, &$text, &$this->mStripState
] );
596 $text = $this->internalParseHalfParsed( $text, true, $linestart );
599 * A converted title will be provided in the output object if title and
600 * content conversion are enabled, the article text does not contain
601 * a conversion-suppressing double-underscore tag, and no
602 * {{DISPLAYTITLE:...}} is present. DISPLAYTITLE takes precedence over
603 * automatic link conversion.
605 if ( !( $options->getDisableTitleConversion()
606 ||
isset( $this->mDoubleUnderscores
['nocontentconvert'] )
607 ||
isset( $this->mDoubleUnderscores
['notitleconvert'] )
608 ||
$this->mOutput
->getDisplayTitle() !== false )
610 $convruletitle = $this->getTargetLanguage()->getConvRuleTitle();
611 if ( $convruletitle ) {
612 $this->mOutput
->setTitleText( $convruletitle );
614 $titleText = $this->getTargetLanguage()->convertTitle( $title );
615 $this->mOutput
->setTitleText( $titleText );
619 # Compute runtime adaptive expiry if set
620 $this->mOutput
->finalizeAdaptiveCacheExpiry();
622 # Warn if too many heavyweight parser functions were used
623 if ( $this->mExpensiveFunctionCount
> $this->mOptions
->getExpensiveParserFunctionLimit() ) {
624 $this->limitationWarn( 'expensive-parserfunction',
625 $this->mExpensiveFunctionCount
,
626 $this->mOptions
->getExpensiveParserFunctionLimit()
630 # Information on limits, for the benefit of users who try to skirt them
631 if ( $this->mOptions
->getEnableLimitReport() ) {
632 $text .= $this->makeLimitReport();
635 # Wrap non-interface parser output in a <div> so it can be targeted
637 $class = $this->mOptions
->getWrapOutputClass();
638 if ( $class !== false && !$this->mOptions
->getInterfaceMessage() ) {
639 $this->mOutput
->addWrapperDivClass( $class );
642 $this->mOutput
->setText( $text );
644 $this->mRevisionId
= $oldRevisionId;
645 $this->mRevisionObject
= $oldRevisionObject;
646 $this->mRevisionTimestamp
= $oldRevisionTimestamp;
647 $this->mRevisionUser
= $oldRevisionUser;
648 $this->mRevisionSize
= $oldRevisionSize;
649 $this->mInputSize
= false;
650 $this->currentRevisionCache
= null;
652 return $this->mOutput
;
656 * Set the limit report data in the current ParserOutput, and return the
657 * limit report HTML comment.
661 protected function makeLimitReport() {
662 $maxIncludeSize = $this->mOptions
->getMaxIncludeSize();
664 $cpuTime = $this->mOutput
->getTimeSinceStart( 'cpu' );
665 if ( $cpuTime !== null ) {
666 $this->mOutput
->setLimitReportData( 'limitreport-cputime',
667 sprintf( "%.3f", $cpuTime )
671 $wallTime = $this->mOutput
->getTimeSinceStart( 'wall' );
672 $this->mOutput
->setLimitReportData( 'limitreport-walltime',
673 sprintf( "%.3f", $wallTime )
676 $this->mOutput
->setLimitReportData( 'limitreport-ppvisitednodes',
677 [ $this->mPPNodeCount
, $this->mOptions
->getMaxPPNodeCount() ]
679 $this->mOutput
->setLimitReportData( 'limitreport-ppgeneratednodes',
680 [ $this->mGeneratedPPNodeCount
, $this->mOptions
->getMaxGeneratedPPNodeCount() ]
682 $this->mOutput
->setLimitReportData( 'limitreport-postexpandincludesize',
683 [ $this->mIncludeSizes
['post-expand'], $maxIncludeSize ]
685 $this->mOutput
->setLimitReportData( 'limitreport-templateargumentsize',
686 [ $this->mIncludeSizes
['arg'], $maxIncludeSize ]
688 $this->mOutput
->setLimitReportData( 'limitreport-expansiondepth',
689 [ $this->mHighestExpansionDepth
, $this->mOptions
->getMaxPPExpandDepth() ]
691 $this->mOutput
->setLimitReportData( 'limitreport-expensivefunctioncount',
692 [ $this->mExpensiveFunctionCount
, $this->mOptions
->getExpensiveParserFunctionLimit() ]
695 foreach ( $this->mStripState
->getLimitReport() as list( $key, $value ) ) {
696 $this->mOutput
->setLimitReportData( $key, $value );
699 Hooks
::run( 'ParserLimitReportPrepare', [ $this, $this->mOutput
] );
701 $limitReport = "NewPP limit report\n";
702 if ( $this->svcOptions
->get( 'ShowHostnames' ) ) {
703 $limitReport .= 'Parsed by ' . wfHostname() . "\n";
705 $limitReport .= 'Cached time: ' . $this->mOutput
->getCacheTime() . "\n";
706 $limitReport .= 'Cache expiry: ' . $this->mOutput
->getCacheExpiry() . "\n";
707 $limitReport .= 'Dynamic content: ' .
708 ( $this->mOutput
->hasDynamicContent() ?
'true' : 'false' ) .
710 $limitReport .= 'Complications: [' . implode( ', ', $this->mOutput
->getAllFlags() ) . "]\n";
712 foreach ( $this->mOutput
->getLimitReportData() as $key => $value ) {
713 if ( Hooks
::run( 'ParserLimitReportFormat',
714 [ $key, &$value, &$limitReport, false, false ]
716 $keyMsg = wfMessage( $key )->inLanguage( 'en' )->useDatabase( false );
717 $valueMsg = wfMessage( [ "$key-value-text", "$key-value" ] )
718 ->inLanguage( 'en' )->useDatabase( false );
719 if ( !$valueMsg->exists() ) {
720 $valueMsg = new RawMessage( '$1' );
722 if ( !$keyMsg->isDisabled() && !$valueMsg->isDisabled() ) {
723 $valueMsg->params( $value );
724 $limitReport .= "{$keyMsg->text()}: {$valueMsg->text()}\n";
728 // Since we're not really outputting HTML, decode the entities and
729 // then re-encode the things that need hiding inside HTML comments.
730 $limitReport = htmlspecialchars_decode( $limitReport );
732 // Sanitize for comment. Note '‐' in the replacement is U+2010,
733 // which looks much like the problematic '-'.
734 $limitReport = str_replace( [ '-', '&' ], [ '‐', '&' ], $limitReport );
735 $text = "\n<!-- \n$limitReport-->\n";
737 // Add on template profiling data in human/machine readable way
738 $dataByFunc = $this->mProfiler
->getFunctionStats();
739 uasort( $dataByFunc, function ( $a, $b ) {
740 return $b['real'] <=> $a['real']; // descending order
743 foreach ( array_slice( $dataByFunc, 0, 10 ) as $item ) {
744 $profileReport[] = sprintf( "%6.2f%% %8.3f %6d %s",
745 $item['%real'], $item['real'], $item['calls'],
746 htmlspecialchars( $item['name'] ) );
748 $text .= "<!--\nTransclusion expansion time report (%,ms,calls,template)\n";
749 $text .= implode( "\n", $profileReport ) . "\n-->\n";
751 $this->mOutput
->setLimitReportData( 'limitreport-timingprofile', $profileReport );
753 // Add other cache related metadata
754 if ( $this->svcOptions
->get( 'ShowHostnames' ) ) {
755 $this->mOutput
->setLimitReportData( 'cachereport-origin', wfHostname() );
757 $this->mOutput
->setLimitReportData( 'cachereport-timestamp',
758 $this->mOutput
->getCacheTime() );
759 $this->mOutput
->setLimitReportData( 'cachereport-ttl',
760 $this->mOutput
->getCacheExpiry() );
761 $this->mOutput
->setLimitReportData( 'cachereport-transientcontent',
762 $this->mOutput
->hasDynamicContent() );
764 if ( $this->mGeneratedPPNodeCount
> $this->mOptions
->getMaxGeneratedPPNodeCount() / 10 ) {
765 wfDebugLog( 'generated-pp-node-count', $this->mGeneratedPPNodeCount
. ' ' .
766 $this->mTitle
->getPrefixedDBkey() );
772 * Half-parse wikitext to half-parsed HTML. This recursive parser entry point
773 * can be called from an extension tag hook.
775 * The output of this function IS NOT SAFE PARSED HTML; it is "half-parsed"
776 * instead, which means that lists and links have not been fully parsed yet,
777 * and strip markers are still present.
779 * Use recursiveTagParseFully() to fully parse wikitext to output-safe HTML.
781 * Use this function if you're a parser tag hook and you want to parse
782 * wikitext before or after applying additional transformations, and you
783 * intend to *return the result as hook output*, which will cause it to go
784 * through the rest of parsing process automatically.
786 * If $frame is not provided, then template variables (e.g., {{{1}}}) within
787 * $text are not expanded
789 * @param string $text Text extension wants to have parsed
790 * @param-taint $text escapes_htmlnoent
791 * @param bool|PPFrame $frame The frame to use for expanding any template variables
792 * @return string UNSAFE half-parsed HTML
793 * @return-taint escaped
795 public function recursiveTagParse( $text, $frame = false ) {
796 // Avoid PHP 7.1 warning from passing $this by reference
798 Hooks
::run( 'ParserBeforeStrip', [ &$parser, &$text, &$this->mStripState
] );
799 Hooks
::run( 'ParserAfterStrip', [ &$parser, &$text, &$this->mStripState
] );
800 $text = $this->internalParse( $text, false, $frame );
805 * Fully parse wikitext to fully parsed HTML. This recursive parser entry
806 * point can be called from an extension tag hook.
808 * The output of this function is fully-parsed HTML that is safe for output.
809 * If you're a parser tag hook, you might want to use recursiveTagParse()
812 * If $frame is not provided, then template variables (e.g., {{{1}}}) within
813 * $text are not expanded
817 * @param string $text Text extension wants to have parsed
818 * @param-taint $text escapes_htmlnoent
819 * @param bool|PPFrame $frame The frame to use for expanding any template variables
820 * @return string Fully parsed HTML
821 * @return-taint escaped
823 public function recursiveTagParseFully( $text, $frame = false ) {
824 $text = $this->recursiveTagParse( $text, $frame );
825 $text = $this->internalParseHalfParsed( $text, false );
830 * Expand templates and variables in the text, producing valid, static wikitext.
831 * Also removes comments.
832 * Do not call this function recursively.
833 * @param string $text
834 * @param Title|null $title
835 * @param ParserOptions $options
836 * @param int|null $revid
837 * @param bool|PPFrame $frame
838 * @return mixed|string
840 public function preprocess( $text, Title
$title = null,
841 ParserOptions
$options, $revid = null, $frame = false
843 $magicScopeVariable = $this->lock();
844 $this->startParse( $title, $options, self
::OT_PREPROCESS
, true );
845 if ( $revid !== null ) {
846 $this->mRevisionId
= $revid;
848 // Avoid PHP 7.1 warning from passing $this by reference
850 Hooks
::run( 'ParserBeforeStrip', [ &$parser, &$text, &$this->mStripState
] );
851 Hooks
::run( 'ParserAfterStrip', [ &$parser, &$text, &$this->mStripState
] );
852 $text = $this->replaceVariables( $text, $frame );
853 $text = $this->mStripState
->unstripBoth( $text );
858 * Recursive parser entry point that can be called from an extension tag
861 * @param string $text Text to be expanded
862 * @param bool|PPFrame $frame The frame to use for expanding any template variables
866 public function recursivePreprocess( $text, $frame = false ) {
867 $text = $this->replaceVariables( $text, $frame );
868 $text = $this->mStripState
->unstripBoth( $text );
873 * Process the wikitext for the "?preload=" feature. (T7210)
875 * "<noinclude>", "<includeonly>" etc. are parsed as for template
876 * transclusion, comments, templates, arguments, tags hooks and parser
877 * functions are untouched.
879 * @param string $text
880 * @param Title $title
881 * @param ParserOptions $options
882 * @param array $params
885 public function getPreloadText( $text, Title
$title, ParserOptions
$options, $params = [] ) {
886 $msg = new RawMessage( $text );
887 $text = $msg->params( $params )->plain();
889 # Parser (re)initialisation
890 $magicScopeVariable = $this->lock();
891 $this->startParse( $title, $options, self
::OT_PLAIN
, true );
893 $flags = PPFrame
::NO_ARGS | PPFrame
::NO_TEMPLATES
;
894 $dom = $this->preprocessToDom( $text, self
::PTD_FOR_INCLUSION
);
895 $text = $this->getPreprocessor()->newFrame()->expand( $dom, $flags );
896 $text = $this->mStripState
->unstripBoth( $text );
901 * Set the current user.
902 * Should only be used when doing pre-save transform.
904 * @param User|null $user User object or null (to reset)
906 public function setUser( $user ) {
907 $this->mUser
= $user;
911 * Set the context title
913 * @param Title|null $t
915 public function setTitle( Title
$t = null ) {
917 $t = Title
::makeTitle( NS_SPECIAL
, 'Badtitle/Parser' );
920 if ( $t->hasFragment() ) {
921 # Strip the fragment to avoid various odd effects
922 $this->mTitle
= $t->createFragmentTarget( '' );
929 * Accessor for the Title object
931 * Since 1.34, leaving `mTitle` uninitialized as `null` is deprecated.
935 public function getTitle() : ?Title
{
936 if ( $this->mTitle
=== null ) {
937 wfDeprecated( 'Parser title should never be null', '1.34' );
939 return $this->mTitle
;
943 * Accessor/mutator for the Title object
945 * @param Title|null $x Title object or null to just get the current one
948 public function Title( Title
$x = null ) : ?Title
{
949 return wfSetVar( $this->mTitle
, $x );
953 * Set the output type
955 * @param int $ot New value
957 public function setOutputType( $ot ) {
958 $this->mOutputType
= $ot;
961 'html' => $ot == self
::OT_HTML
,
962 'wiki' => $ot == self
::OT_WIKI
,
963 'pre' => $ot == self
::OT_PREPROCESS
,
964 'plain' => $ot == self
::OT_PLAIN
,
969 * Accessor/mutator for the output type
971 * @param int|null $x New value or null to just get the current one
974 public function OutputType( $x = null ) {
975 return wfSetVar( $this->mOutputType
, $x );
979 * Get the ParserOutput object
981 * @return ParserOutput
983 public function getOutput() {
984 return $this->mOutput
;
988 * Get the ParserOptions object
990 * @return ParserOptions
992 public function getOptions() {
993 return $this->mOptions
;
997 * Accessor/mutator for the ParserOptions object
999 * @param ParserOptions|null $x New value or null to just get the current one
1000 * @return ParserOptions Current ParserOptions object
1002 public function Options( $x = null ) {
1003 return wfSetVar( $this->mOptions
, $x );
1009 public function nextLinkID() {
1010 return $this->mLinkID++
;
1016 public function setLinkID( $id ) {
1017 $this->mLinkID
= $id;
1021 * Get a language object for use in parser functions such as {{FORMATNUM:}}
1024 public function getFunctionLang() {
1025 return $this->getTargetLanguage();
1029 * Get the target language for the content being parsed. This is usually the
1030 * language that the content is in.
1034 * @throws MWException
1037 public function getTargetLanguage() {
1038 $target = $this->mOptions
->getTargetLanguage();
1040 if ( $target !== null ) {
1042 } elseif ( $this->mOptions
->getInterfaceMessage() ) {
1043 return $this->mOptions
->getUserLangObj();
1044 } elseif ( is_null( $this->mTitle
) ) {
1045 throw new MWException( __METHOD__
. ': $this->mTitle is null' );
1048 return $this->mTitle
->getPageLanguage();
1052 * Get the language object for language conversion
1053 * @deprecated since 1.32, just use getTargetLanguage()
1056 public function getConverterLanguage() {
1057 wfDeprecated( __METHOD__
, '1.32' );
1058 return $this->getTargetLanguage();
1062 * Get a User object either from $this->mUser, if set, or from the
1063 * ParserOptions object otherwise
1067 public function getUser() {
1068 if ( !is_null( $this->mUser
) ) {
1069 return $this->mUser
;
1071 return $this->mOptions
->getUser();
1075 * Get a preprocessor object
1077 * @return Preprocessor
1079 public function getPreprocessor() {
1080 if ( !isset( $this->mPreprocessor
) ) {
1081 $class = $this->svcOptions
->get( 'preprocessorClass' );
1082 $this->mPreprocessor
= new $class( $this );
1084 return $this->mPreprocessor
;
1088 * Get a LinkRenderer instance to make links with
1091 * @return LinkRenderer
1093 public function getLinkRenderer() {
1094 // XXX We make the LinkRenderer with current options and then cache it forever
1095 if ( !$this->mLinkRenderer
) {
1096 $this->mLinkRenderer
= $this->linkRendererFactory
->create();
1097 $this->mLinkRenderer
->setStubThreshold(
1098 $this->getOptions()->getStubThreshold()
1102 return $this->mLinkRenderer
;
1106 * Get the MagicWordFactory that this Parser is using
1109 * @return MagicWordFactory
1111 public function getMagicWordFactory() {
1112 return $this->magicWordFactory
;
1116 * Get the content language that this Parser is using
1121 public function getContentLanguage() {
1122 return $this->contLang
;
1126 * Replaces all occurrences of HTML-style comments and the given tags
1127 * in the text with a random marker and returns the next text. The output
1128 * parameter $matches will be an associative array filled with data in
1135 * [ 'param' => 'x' ],
1136 * '<element param="x">tag content</element>' ]
1139 * @param array $elements List of element names. Comments are always extracted.
1140 * @param string $text Source text string.
1141 * @param array &$matches Out parameter, Array: extracted tags
1142 * @return string Stripped text
1144 public static function extractTagsAndParams( $elements, $text, &$matches ) {
1149 $taglist = implode( '|', $elements );
1150 $start = "/<($taglist)(\\s+[^>]*?|\\s*?)(\/?>)|<(!--)/i";
1152 while ( $text != '' ) {
1153 $p = preg_split( $start, $text, 2, PREG_SPLIT_DELIM_CAPTURE
);
1155 if ( count( $p ) < 5 ) {
1158 if ( count( $p ) > 5 ) {
1166 list( , $element, $attributes, $close, $inside ) = $p;
1169 $marker = self
::MARKER_PREFIX
. "-$element-" . sprintf( '%08X', $n++
) . self
::MARKER_SUFFIX
;
1170 $stripped .= $marker;
1172 if ( $close === '/>' ) {
1173 # Empty element tag, <tag />
1178 if ( $element === '!--' ) {
1181 $end = "/(<\\/$element\\s*>)/i";
1183 $q = preg_split( $end, $inside, 2, PREG_SPLIT_DELIM_CAPTURE
);
1185 if ( count( $q ) < 3 ) {
1186 # No end tag -- let it run out to the end of the text.
1190 list( , $tail, $text ) = $q;
1194 $matches[$marker] = [ $element,
1196 Sanitizer
::decodeTagAttributes( $attributes ),
1197 "<$element$attributes$close$content$tail" ];
1203 * Get a list of strippable XML-like elements
1207 public function getStripList() {
1208 return $this->mStripList
;
1212 * Get the StripState
1214 * @return StripState
1216 public function getStripState() {
1217 return $this->mStripState
;
1221 * Add an item to the strip state
1222 * Returns the unique tag which must be inserted into the stripped text
1223 * The tag will be replaced with the original text in unstrip()
1225 * @param string $text
1229 public function insertStripItem( $text ) {
1230 $marker = self
::MARKER_PREFIX
. "-item-{$this->mMarkerIndex}-" . self
::MARKER_SUFFIX
;
1231 $this->mMarkerIndex++
;
1232 $this->mStripState
->addGeneral( $marker, $text );
1237 * Parse the wiki syntax used to render tables.
1240 * @param string $text
1242 * @deprecated since 1.34; should not be used outside parser class.
1244 public function doTableStuff( $text ) {
1245 wfDeprecated( __METHOD__
, '1.34' );
1246 return $this->handleTables( $text );
1250 * Parse the wiki syntax used to render tables.
1252 * @param string $text
1255 private function handleTables( $text ) {
1256 $lines = StringUtils
::explode( "\n", $text );
1258 $td_history = []; # Is currently a td tag open?
1259 $last_tag_history = []; # Save history of last lag activated (td, th or caption)
1260 $tr_history = []; # Is currently a tr tag open?
1261 $tr_attributes = []; # history of tr attributes
1262 $has_opened_tr = []; # Did this table open a <tr> element?
1263 $indent_level = 0; # indent level of the table
1265 foreach ( $lines as $outLine ) {
1266 $line = trim( $outLine );
1268 if ( $line === '' ) { # empty line, go to next line
1269 $out .= $outLine . "\n";
1273 $first_character = $line[0];
1274 $first_two = substr( $line, 0, 2 );
1277 if ( preg_match( '/^(:*)\s*\{\|(.*)$/', $line, $matches ) ) {
1278 # First check if we are starting a new table
1279 $indent_level = strlen( $matches[1] );
1281 $attributes = $this->mStripState
->unstripBoth( $matches[2] );
1282 $attributes = Sanitizer
::fixTagAttributes( $attributes, 'table' );
1284 $outLine = str_repeat( '<dl><dd>', $indent_level ) . "<table{$attributes}>";
1285 array_push( $td_history, false );
1286 array_push( $last_tag_history, '' );
1287 array_push( $tr_history, false );
1288 array_push( $tr_attributes, '' );
1289 array_push( $has_opened_tr, false );
1290 } elseif ( count( $td_history ) == 0 ) {
1291 # Don't do any of the following
1292 $out .= $outLine . "\n";
1294 } elseif ( $first_two === '|}' ) {
1295 # We are ending a table
1296 $line = '</table>' . substr( $line, 2 );
1297 $last_tag = array_pop( $last_tag_history );
1299 if ( !array_pop( $has_opened_tr ) ) {
1300 $line = "<tr><td></td></tr>{$line}";
1303 if ( array_pop( $tr_history ) ) {
1304 $line = "</tr>{$line}";
1307 if ( array_pop( $td_history ) ) {
1308 $line = "</{$last_tag}>{$line}";
1310 array_pop( $tr_attributes );
1311 if ( $indent_level > 0 ) {
1312 $outLine = rtrim( $line ) . str_repeat( '</dd></dl>', $indent_level );
1316 } elseif ( $first_two === '|-' ) {
1317 # Now we have a table row
1318 $line = preg_replace( '#^\|-+#', '', $line );
1320 # Whats after the tag is now only attributes
1321 $attributes = $this->mStripState
->unstripBoth( $line );
1322 $attributes = Sanitizer
::fixTagAttributes( $attributes, 'tr' );
1323 array_pop( $tr_attributes );
1324 array_push( $tr_attributes, $attributes );
1327 $last_tag = array_pop( $last_tag_history );
1328 array_pop( $has_opened_tr );
1329 array_push( $has_opened_tr, true );
1331 if ( array_pop( $tr_history ) ) {
1335 if ( array_pop( $td_history ) ) {
1336 $line = "</{$last_tag}>{$line}";
1340 array_push( $tr_history, false );
1341 array_push( $td_history, false );
1342 array_push( $last_tag_history, '' );
1343 } elseif ( $first_character === '|'
1344 ||
$first_character === '!'
1345 ||
$first_two === '|+'
1347 # This might be cell elements, td, th or captions
1348 if ( $first_two === '|+' ) {
1349 $first_character = '+';
1350 $line = substr( $line, 2 );
1352 $line = substr( $line, 1 );
1355 // Implies both are valid for table headings.
1356 if ( $first_character === '!' ) {
1357 $line = StringUtils
::replaceMarkup( '!!', '||', $line );
1360 # Split up multiple cells on the same line.
1361 # FIXME : This can result in improper nesting of tags processed
1362 # by earlier parser steps.
1363 $cells = explode( '||', $line );
1367 # Loop through each table cell
1368 foreach ( $cells as $cell ) {
1370 if ( $first_character !== '+' ) {
1371 $tr_after = array_pop( $tr_attributes );
1372 if ( !array_pop( $tr_history ) ) {
1373 $previous = "<tr{$tr_after}>\n";
1375 array_push( $tr_history, true );
1376 array_push( $tr_attributes, '' );
1377 array_pop( $has_opened_tr );
1378 array_push( $has_opened_tr, true );
1381 $last_tag = array_pop( $last_tag_history );
1383 if ( array_pop( $td_history ) ) {
1384 $previous = "</{$last_tag}>\n{$previous}";
1387 if ( $first_character === '|' ) {
1389 } elseif ( $first_character === '!' ) {
1391 } elseif ( $first_character === '+' ) {
1392 $last_tag = 'caption';
1397 array_push( $last_tag_history, $last_tag );
1399 # A cell could contain both parameters and data
1400 $cell_data = explode( '|', $cell, 2 );
1402 # T2553: Note that a '|' inside an invalid link should not
1403 # be mistaken as delimiting cell parameters
1404 # Bug T153140: Neither should language converter markup.
1405 if ( preg_match( '/\[\[|-\{/', $cell_data[0] ) === 1 ) {
1406 $cell = "{$previous}<{$last_tag}>" . trim( $cell );
1407 } elseif ( count( $cell_data ) == 1 ) {
1408 // Whitespace in cells is trimmed
1409 $cell = "{$previous}<{$last_tag}>" . trim( $cell_data[0] );
1411 $attributes = $this->mStripState
->unstripBoth( $cell_data[0] );
1412 $attributes = Sanitizer
::fixTagAttributes( $attributes, $last_tag );
1413 // Whitespace in cells is trimmed
1414 $cell = "{$previous}<{$last_tag}{$attributes}>" . trim( $cell_data[1] );
1418 array_push( $td_history, true );
1421 $out .= $outLine . "\n";
1424 # Closing open td, tr && table
1425 while ( count( $td_history ) > 0 ) {
1426 if ( array_pop( $td_history ) ) {
1429 if ( array_pop( $tr_history ) ) {
1432 if ( !array_pop( $has_opened_tr ) ) {
1433 $out .= "<tr><td></td></tr>\n";
1436 $out .= "</table>\n";
1439 # Remove trailing line-ending (b/c)
1440 if ( substr( $out, -1 ) === "\n" ) {
1441 $out = substr( $out, 0, -1 );
1444 # special case: don't return empty table
1445 if ( $out === "<table>\n<tr><td></td></tr>\n</table>" ) {
1453 * Helper function for parse() that transforms wiki markup into half-parsed
1454 * HTML. Only called for $mOutputType == self::OT_HTML.
1458 * @param string $text The text to parse
1459 * @param-taint $text escapes_html
1460 * @param bool $isMain Whether this is being called from the main parse() function
1461 * @param PPFrame|bool $frame A pre-processor frame
1465 public function internalParse( $text, $isMain = true, $frame = false ) {
1468 // Avoid PHP 7.1 warning from passing $this by reference
1471 # Hook to suspend the parser in this state
1472 if ( !Hooks
::run( 'ParserBeforeInternalParse', [ &$parser, &$text, &$this->mStripState
] ) ) {
1476 # if $frame is provided, then use $frame for replacing any variables
1478 # use frame depth to infer how include/noinclude tags should be handled
1479 # depth=0 means this is the top-level document; otherwise it's an included document
1480 if ( !$frame->depth
) {
1483 $flag = self
::PTD_FOR_INCLUSION
;
1485 $dom = $this->preprocessToDom( $text, $flag );
1486 $text = $frame->expand( $dom );
1488 # if $frame is not provided, then use old-style replaceVariables
1489 $text = $this->replaceVariables( $text );
1492 Hooks
::run( 'InternalParseBeforeSanitize', [ &$parser, &$text, &$this->mStripState
] );
1493 $text = Sanitizer
::removeHTMLtags(
1495 [ $this, 'attributeStripCallback' ],
1497 array_keys( $this->mTransparentTagHooks
),
1499 [ $this, 'addTrackingCategory' ]
1501 Hooks
::run( 'InternalParseBeforeLinks', [ &$parser, &$text, &$this->mStripState
] );
1503 # Tables need to come after variable replacement for things to work
1504 # properly; putting them before other transformations should keep
1505 # exciting things like link expansions from showing up in surprising
1507 $text = $this->handleTables( $text );
1509 $text = preg_replace( '/(^|\n)-----*/', '\\1<hr />', $text );
1511 $text = $this->handleDoubleUnderscore( $text );
1513 $text = $this->handleHeadings( $text );
1514 $text = $this->handleInternalLinks( $text );
1515 $text = $this->handleAllQuotes( $text );
1516 $text = $this->handleExternalLinks( $text );
1518 # handleInternalLinks may sometimes leave behind
1519 # absolute URLs, which have to be masked to hide them from handleExternalLinks
1520 $text = str_replace( self
::MARKER_PREFIX
. 'NOPARSE', '', $text );
1522 $text = $this->handleMagicLinks( $text );
1523 $text = $this->finalizeHeadings( $text, $origText, $isMain );
1529 * Helper function for parse() that transforms half-parsed HTML into fully
1532 * @param string $text
1533 * @param bool $isMain
1534 * @param bool $linestart
1537 private function internalParseHalfParsed( $text, $isMain = true, $linestart = true ) {
1538 $text = $this->mStripState
->unstripGeneral( $text );
1540 // Avoid PHP 7.1 warning from passing $this by reference
1544 Hooks
::run( 'ParserAfterUnstrip', [ &$parser, &$text ] );
1547 # Clean up special characters, only run once, next-to-last before doBlockLevels
1548 $text = Sanitizer
::armorFrenchSpaces( $text );
1550 $text = $this->doBlockLevels( $text, $linestart );
1552 $this->replaceLinkHoldersPrivate( $text );
1555 * The input doesn't get language converted if
1557 * b) Content isn't converted
1558 * c) It's a conversion table
1559 * d) it is an interface message (which is in the user language)
1561 if ( !( $this->mOptions
->getDisableContentConversion()
1562 ||
isset( $this->mDoubleUnderscores
['nocontentconvert'] ) )
1563 && !$this->mOptions
->getInterfaceMessage()
1565 # The position of the convert() call should not be changed. it
1566 # assumes that the links are all replaced and the only thing left
1567 # is the <nowiki> mark.
1568 $text = $this->getTargetLanguage()->convert( $text );
1571 $text = $this->mStripState
->unstripNoWiki( $text );
1574 Hooks
::run( 'ParserBeforeTidy', [ &$parser, &$text ] );
1577 $text = $this->replaceTransparentTags( $text );
1578 $text = $this->mStripState
->unstripGeneral( $text );
1580 $text = Sanitizer
::normalizeCharReferences( $text );
1582 if ( MWTidy
::isEnabled() ) {
1583 if ( $this->mOptions
->getTidy() ) {
1584 $text = MWTidy
::tidy( $text );
1587 # attempt to sanitize at least some nesting problems
1588 # (T4702 and quite a few others)
1589 # This code path is buggy and deprecated!
1590 wfDeprecated( 'disabling tidy', '1.33' );
1592 # ''Something [http://www.cool.com cool''] -->
1593 # <i>Something</i><a href="http://www.cool.com"..><i>cool></i></a>
1594 '/(<([bi])>)(<([bi])>)?([^<]*)(<\/?a[^<]*>)([^<]*)(<\/\\4>)?(<\/\\2>)/' =>
1595 '\\1\\3\\5\\8\\9\\6\\1\\3\\7\\8\\9',
1596 # fix up an anchor inside another anchor, only
1597 # at least for a single single nested link (T5695)
1598 '/(<a[^>]+>)([^<]*)(<a[^>]+>[^<]*)<\/a>(.*)<\/a>/' =>
1599 '\\1\\2</a>\\3</a>\\1\\4</a>',
1600 # fix div inside inline elements- doBlockLevels won't wrap a line which
1601 # contains a div, so fix it up here; replace
1602 # div with escaped text
1603 '/(<([aib]) [^>]+>)([^<]*)(<div([^>]*)>)(.*)(<\/div>)([^<]*)(<\/\\2>)/' =>
1604 '\\1\\3<div\\5>\\6</div>\\8\\9',
1605 # remove empty italic or bold tag pairs, some
1606 # introduced by rules above
1607 '/<([bi])><\/\\1>/' => '',
1610 $text = preg_replace(
1611 array_keys( $tidyregs ),
1612 array_values( $tidyregs ),
1617 Hooks
::run( 'ParserAfterTidy', [ &$parser, &$text ] );
1624 * Replace special strings like "ISBN xxx" and "RFC xxx" with
1625 * magic external links.
1629 * @param string $text
1631 * @deprecated since 1.34; should not be used outside parser class.
1633 public function doMagicLinks( $text ) {
1634 wfDeprecated( __METHOD__
, '1.34' );
1635 return $this->handleMagicLinks( $text );
1639 * Replace special strings like "ISBN xxx" and "RFC xxx" with
1640 * magic external links.
1644 * @param string $text
1648 private function handleMagicLinks( $text ) {
1649 $prots = wfUrlProtocolsWithoutProtRel();
1650 $urlChar = self
::EXT_LINK_URL_CLASS
;
1651 $addr = self
::EXT_LINK_ADDR
;
1652 $space = self
::SPACE_NOT_NL
; # non-newline space
1653 $spdash = "(?:-|$space)"; # a dash or a non-newline space
1654 $spaces = "$space++"; # possessive match of 1 or more spaces
1655 $text = preg_replace_callback(
1657 (<a[ \t\r\n>].*?</a>) | # m[1]: Skip link text
1658 (<.*?>) | # m[2]: Skip stuff inside HTML elements' . "
1659 (\b # m[3]: Free external links
1661 ($addr$urlChar*) # m[4]: Post-protocol path
1663 \b(?:RFC|PMID) $spaces # m[5]: RFC or PMID, capture number
1665 \bISBN $spaces ( # m[6]: ISBN, capture number
1666 (?: 97[89] $spdash? )? # optional 13-digit ISBN prefix
1667 (?: [0-9] $spdash? ){9} # 9 digits with opt. delimiters
1668 [0-9Xx] # check digit
1670 )!xu", [ $this, 'magicLinkCallback' ], $text );
1675 * @throws MWException
1677 * @return string HTML
1679 public function magicLinkCallback( $m ) {
1680 if ( isset( $m[1] ) && $m[1] !== '' ) {
1683 } elseif ( isset( $m[2] ) && $m[2] !== '' ) {
1686 } elseif ( isset( $m[3] ) && $m[3] !== '' ) {
1687 # Free external link
1688 return $this->makeFreeExternalLink( $m[0], strlen( $m[4] ) );
1689 } elseif ( isset( $m[5] ) && $m[5] !== '' ) {
1691 if ( substr( $m[0], 0, 3 ) === 'RFC' ) {
1692 if ( !$this->mOptions
->getMagicRFCLinks() ) {
1697 $cssClass = 'mw-magiclink-rfc';
1698 $trackingCat = 'magiclink-tracking-rfc';
1700 } elseif ( substr( $m[0], 0, 4 ) === 'PMID' ) {
1701 if ( !$this->mOptions
->getMagicPMIDLinks() ) {
1705 $urlmsg = 'pubmedurl';
1706 $cssClass = 'mw-magiclink-pmid';
1707 $trackingCat = 'magiclink-tracking-pmid';
1710 throw new MWException( __METHOD__
. ': unrecognised match type "' .
1711 substr( $m[0], 0, 20 ) . '"' );
1713 $url = wfMessage( $urlmsg, $id )->inContentLanguage()->text();
1714 $this->addTrackingCategory( $trackingCat );
1715 return Linker
::makeExternalLink( $url, "{$keyword} {$id}", true, $cssClass, [], $this->mTitle
);
1716 } elseif ( isset( $m[6] ) && $m[6] !== ''
1717 && $this->mOptions
->getMagicISBNLinks()
1721 $space = self
::SPACE_NOT_NL
; # non-newline space
1722 $isbn = preg_replace( "/$space/", ' ', $isbn );
1723 $num = strtr( $isbn, [
1728 $this->addTrackingCategory( 'magiclink-tracking-isbn' );
1729 return $this->getLinkRenderer()->makeKnownLink(
1730 SpecialPage
::getTitleFor( 'Booksources', $num ),
1733 'class' => 'internal mw-magiclink-isbn',
1734 'title' => false // suppress title attribute
1743 * Make a free external link, given a user-supplied URL
1745 * @param string $url
1746 * @param int $numPostProto
1747 * The number of characters after the protocol.
1748 * @return string HTML
1751 public function makeFreeExternalLink( $url, $numPostProto ) {
1754 # The characters '<' and '>' (which were escaped by
1755 # removeHTMLtags()) should not be included in
1756 # URLs, per RFC 2396.
1757 # Make terminate a URL as well (bug T84937)
1760 '/&(lt|gt|nbsp|#x0*(3[CcEe]|[Aa]0)|#0*(60|62|160));/',
1765 $trail = substr( $url, $m2[0][1] ) . $trail;
1766 $url = substr( $url, 0, $m2[0][1] );
1769 # Move trailing punctuation to $trail
1771 # If there is no left bracket, then consider right brackets fair game too
1772 if ( strpos( $url, '(' ) === false ) {
1776 $urlRev = strrev( $url );
1777 $numSepChars = strspn( $urlRev, $sep );
1778 # Don't break a trailing HTML entity by moving the ; into $trail
1779 # This is in hot code, so use substr_compare to avoid having to
1780 # create a new string object for the comparison
1781 if ( $numSepChars && substr_compare( $url, ";", -$numSepChars, 1 ) === 0 ) {
1782 # more optimization: instead of running preg_match with a $
1783 # anchor, which can be slow, do the match on the reversed
1784 # string starting at the desired offset.
1785 # un-reversed regexp is: /&([a-z]+|#x[\da-f]+|#\d+)$/i
1786 if ( preg_match( '/\G([a-z]+|[\da-f]+x#|\d+#)&/i', $urlRev, $m2, 0, $numSepChars ) ) {
1790 if ( $numSepChars ) {
1791 $trail = substr( $url, -$numSepChars ) . $trail;
1792 $url = substr( $url, 0, -$numSepChars );
1795 # Verify that we still have a real URL after trail removal, and
1796 # not just lone protocol
1797 if ( strlen( $trail ) >= $numPostProto ) {
1798 return $url . $trail;
1801 $url = Sanitizer
::cleanUrl( $url );
1803 # Is this an external image?
1804 $text = $this->maybeMakeExternalImage( $url );
1805 if ( $text === false ) {
1806 # Not an image, make a link
1807 $text = Linker
::makeExternalLink( $url,
1808 $this->getTargetLanguage()->getConverter()->markNoConversion( $url ),
1810 $this->getExternalLinkAttribs( $url ), $this->mTitle
);
1811 # Register it in the output object...
1812 $this->mOutput
->addExternalLink( $url );
1814 return $text . $trail;
1818 * Parse headers and return html.
1821 * @param string $text
1823 * @deprecated since 1.34; should not be used outside parser class.
1825 public function doHeadings( $text ) {
1826 wfDeprecated( __METHOD__
, '1.34' );
1827 return $this->handleHeadings( $text );
1831 * Parse headers and return html
1833 * @param string $text
1836 private function handleHeadings( $text ) {
1837 for ( $i = 6; $i >= 1; --$i ) {
1838 $h = str_repeat( '=', $i );
1839 // Trim non-newline whitespace from headings
1840 // Using \s* will break for: "==\n===\n" and parse as <h2>=</h2>
1841 $text = preg_replace( "/^(?:$h)[ \\t]*(.+?)[ \\t]*(?:$h)\\s*$/m", "<h$i>\\1</h$i>", $text );
1847 * Replace single quotes with HTML markup
1850 * @param string $text
1852 * @return string The altered text
1853 * @deprecated since 1.34; should not be used outside parser class.
1855 public function doAllQuotes( $text ) {
1856 wfDeprecated( __METHOD__
, '1.34' );
1857 return $this->handleAllQuotes( $text );
1861 * Replace single quotes with HTML markup
1863 * @param string $text
1865 * @return string The altered text
1867 private function handleAllQuotes( $text ) {
1869 $lines = StringUtils
::explode( "\n", $text );
1870 foreach ( $lines as $line ) {
1871 $outtext .= $this->doQuotes( $line ) . "\n";
1873 $outtext = substr( $outtext, 0, -1 );
1878 * Helper function for doAllQuotes()
1880 * @param string $text
1885 public function doQuotes( $text ) {
1886 $arr = preg_split( "/(''+)/", $text, -1, PREG_SPLIT_DELIM_CAPTURE
);
1887 $countarr = count( $arr );
1888 if ( $countarr == 1 ) {
1892 // First, do some preliminary work. This may shift some apostrophes from
1893 // being mark-up to being text. It also counts the number of occurrences
1894 // of bold and italics mark-ups.
1897 for ( $i = 1; $i < $countarr; $i +
= 2 ) {
1898 $thislen = strlen( $arr[$i] );
1899 // If there are ever four apostrophes, assume the first is supposed to
1900 // be text, and the remaining three constitute mark-up for bold text.
1901 // (T15227: ''''foo'''' turns into ' ''' foo ' ''')
1902 if ( $thislen == 4 ) {
1903 $arr[$i - 1] .= "'";
1906 } elseif ( $thislen > 5 ) {
1907 // If there are more than 5 apostrophes in a row, assume they're all
1908 // text except for the last 5.
1909 // (T15227: ''''''foo'''''' turns into ' ''''' foo ' ''''')
1910 $arr[$i - 1] .= str_repeat( "'", $thislen - 5 );
1914 // Count the number of occurrences of bold and italics mark-ups.
1915 if ( $thislen == 2 ) {
1917 } elseif ( $thislen == 3 ) {
1919 } elseif ( $thislen == 5 ) {
1925 // If there is an odd number of both bold and italics, it is likely
1926 // that one of the bold ones was meant to be an apostrophe followed
1927 // by italics. Which one we cannot know for certain, but it is more
1928 // likely to be one that has a single-letter word before it.
1929 if ( ( $numbold %
2 == 1 ) && ( $numitalics %
2 == 1 ) ) {
1930 $firstsingleletterword = -1;
1931 $firstmultiletterword = -1;
1933 for ( $i = 1; $i < $countarr; $i +
= 2 ) {
1934 if ( strlen( $arr[$i] ) == 3 ) {
1935 $x1 = substr( $arr[$i - 1], -1 );
1936 $x2 = substr( $arr[$i - 1], -2, 1 );
1937 if ( $x1 === ' ' ) {
1938 if ( $firstspace == -1 ) {
1941 } elseif ( $x2 === ' ' ) {
1942 $firstsingleletterword = $i;
1943 // if $firstsingleletterword is set, we don't
1944 // look at the other options, so we can bail early.
1946 } elseif ( $firstmultiletterword == -1 ) {
1947 $firstmultiletterword = $i;
1952 // If there is a single-letter word, use it!
1953 if ( $firstsingleletterword > -1 ) {
1954 $arr[$firstsingleletterword] = "''";
1955 $arr[$firstsingleletterword - 1] .= "'";
1956 } elseif ( $firstmultiletterword > -1 ) {
1957 // If not, but there's a multi-letter word, use that one.
1958 $arr[$firstmultiletterword] = "''";
1959 $arr[$firstmultiletterword - 1] .= "'";
1960 } elseif ( $firstspace > -1 ) {
1961 // ... otherwise use the first one that has neither.
1962 // (notice that it is possible for all three to be -1 if, for example,
1963 // there is only one pentuple-apostrophe in the line)
1964 $arr[$firstspace] = "''";
1965 $arr[$firstspace - 1] .= "'";
1969 // Now let's actually convert our apostrophic mush to HTML!
1974 foreach ( $arr as $r ) {
1975 if ( ( $i %
2 ) == 0 ) {
1976 if ( $state === 'both' ) {
1982 $thislen = strlen( $r );
1983 if ( $thislen == 2 ) {
1984 if ( $state === 'i' ) {
1987 } elseif ( $state === 'bi' ) {
1990 } elseif ( $state === 'ib' ) {
1991 $output .= '</b></i><b>';
1993 } elseif ( $state === 'both' ) {
1994 $output .= '<b><i>' . $buffer . '</i>';
1996 } else { // $state can be 'b' or ''
2000 } elseif ( $thislen == 3 ) {
2001 if ( $state === 'b' ) {
2004 } elseif ( $state === 'bi' ) {
2005 $output .= '</i></b><i>';
2007 } elseif ( $state === 'ib' ) {
2010 } elseif ( $state === 'both' ) {
2011 $output .= '<i><b>' . $buffer . '</b>';
2013 } else { // $state can be 'i' or ''
2017 } elseif ( $thislen == 5 ) {
2018 if ( $state === 'b' ) {
2019 $output .= '</b><i>';
2021 } elseif ( $state === 'i' ) {
2022 $output .= '</i><b>';
2024 } elseif ( $state === 'bi' ) {
2025 $output .= '</i></b>';
2027 } elseif ( $state === 'ib' ) {
2028 $output .= '</b></i>';
2030 } elseif ( $state === 'both' ) {
2031 $output .= '<i><b>' . $buffer . '</b></i>';
2033 } else { // ($state == '')
2041 // Now close all remaining tags. Notice that the order is important.
2042 if ( $state === 'b' ||
$state === 'ib' ) {
2045 if ( $state === 'i' ||
$state === 'bi' ||
$state === 'ib' ) {
2048 if ( $state === 'bi' ) {
2051 // There might be lonely ''''', so make sure we have a buffer
2052 if ( $state === 'both' && $buffer ) {
2053 $output .= '<b><i>' . $buffer . '</i></b>';
2059 * Replace external links (REL)
2061 * Note: this is all very hackish and the order of execution matters a lot.
2062 * Make sure to run tests/parser/parserTests.php if you change this code.
2066 * @param string $text
2068 * @throws MWException
2071 public function replaceExternalLinks( $text ) {
2072 wfDeprecated( __METHOD__
, '1.34' );
2073 return $this->handleExternalLinks( $text );
2077 * Replace external links (REL)
2079 * Note: this is all very hackish and the order of execution matters a lot.
2080 * Make sure to run tests/parser/parserTests.php if you change this code.
2082 * @param string $text
2083 * @throws MWException
2086 private function handleExternalLinks( $text ) {
2087 $bits = preg_split( $this->mExtLinkBracketedRegex
, $text, -1, PREG_SPLIT_DELIM_CAPTURE
);
2088 // @phan-suppress-next-line PhanTypeComparisonFromArray See phan issue #3161
2089 if ( $bits === false ) {
2090 throw new MWException( "PCRE needs to be compiled with "
2091 . "--enable-unicode-properties in order for MediaWiki to function" );
2093 $s = array_shift( $bits );
2096 while ( $i < count( $bits ) ) {
2099 $text = $bits[$i++
];
2100 $trail = $bits[$i++
];
2102 # The characters '<' and '>' (which were escaped by
2103 # removeHTMLtags()) should not be included in
2104 # URLs, per RFC 2396.
2106 if ( preg_match( '/&(lt|gt);/', $url, $m2, PREG_OFFSET_CAPTURE
) ) {
2107 $text = substr( $url, $m2[0][1] ) . ' ' . $text;
2108 $url = substr( $url, 0, $m2[0][1] );
2111 # If the link text is an image URL, replace it with an <img> tag
2112 # This happened by accident in the original parser, but some people used it extensively
2113 $img = $this->maybeMakeExternalImage( $text );
2114 if ( $img !== false ) {
2120 # Set linktype for CSS
2123 # No link text, e.g. [http://domain.tld/some.link]
2124 if ( $text == '' ) {
2126 $langObj = $this->getTargetLanguage();
2127 $text = '[' . $langObj->formatNum( ++
$this->mAutonumber
) . ']';
2128 $linktype = 'autonumber';
2130 # Have link text, e.g. [http://domain.tld/some.link text]s
2132 list( $dtrail, $trail ) = Linker
::splitTrail( $trail );
2135 // Excluding protocol-relative URLs may avoid many false positives.
2136 if ( preg_match( '/^(?:' . wfUrlProtocolsWithoutProtRel() . ')/', $text ) ) {
2137 $text = $this->getTargetLanguage()->getConverter()->markNoConversion( $text );
2140 $url = Sanitizer
::cleanUrl( $url );
2142 # Use the encoded URL
2143 # This means that users can paste URLs directly into the text
2144 # Funny characters like ö aren't valid in URLs anyway
2145 # This was changed in August 2004
2146 $s .= Linker
::makeExternalLink( $url, $text, false, $linktype,
2147 $this->getExternalLinkAttribs( $url ), $this->mTitle
) . $dtrail . $trail;
2149 # Register link in the output object.
2150 $this->mOutput
->addExternalLink( $url );
2157 * Get the rel attribute for a particular external link.
2161 * @param string|bool $url Optional URL, to extract the domain from for rel =>
2162 * nofollow if appropriate
2163 * @param LinkTarget|null $title Optional LinkTarget, for wgNoFollowNsExceptions lookups
2164 * @return string|null Rel attribute for $url
2166 public static function getExternalLinkRel( $url = false, $title = null ) {
2167 global $wgNoFollowLinks, $wgNoFollowNsExceptions, $wgNoFollowDomainExceptions;
2168 $ns = $title ?
$title->getNamespace() : false;
2169 if ( $wgNoFollowLinks && !in_array( $ns, $wgNoFollowNsExceptions )
2170 && !wfMatchesDomainList( $url, $wgNoFollowDomainExceptions )
2178 * Get an associative array of additional HTML attributes appropriate for a
2179 * particular external link. This currently may include rel => nofollow
2180 * (depending on configuration, namespace, and the URL's domain) and/or a
2181 * target attribute (depending on configuration).
2184 * @param string $url URL to extract the domain from for rel =>
2185 * nofollow if appropriate
2186 * @return array Associative array of HTML attributes
2188 public function getExternalLinkAttribs( $url ) {
2190 $rel = self
::getExternalLinkRel( $url, $this->mTitle
);
2192 $target = $this->mOptions
->getExternalLinkTarget();
2194 $attribs['target'] = $target;
2195 if ( !in_array( $target, [ '_self', '_parent', '_top' ] ) ) {
2196 // T133507. New windows can navigate parent cross-origin.
2197 // Including noreferrer due to lacking browser
2198 // support of noopener. Eventually noreferrer should be removed.
2199 if ( $rel !== '' ) {
2202 $rel .= 'noreferrer noopener';
2205 $attribs['rel'] = $rel;
2210 * Replace unusual escape codes in a URL with their equivalent characters
2212 * This generally follows the syntax defined in RFC 3986, with special
2213 * consideration for HTTP query strings.
2216 * @param string $url
2219 public static function normalizeLinkUrl( $url ) {
2220 # Test for RFC 3986 IPv6 syntax
2221 $scheme = '[a-z][a-z0-9+.-]*:';
2222 $userinfo = '(?:[a-z0-9\-._~!$&\'()*+,;=:]|%[0-9a-f]{2})*';
2223 $ipv6Host = '\\[((?:[0-9a-f:]|%3[0-A]|%[46][1-6])+)\\]';
2224 if ( preg_match( "<^(?:{$scheme})?//(?:{$userinfo}@)?{$ipv6Host}(?:[:/?#].*|)$>i", $url, $m ) &&
2225 IP
::isValid( rawurldecode( $m[1] ) )
2227 $isIPv6 = rawurldecode( $m[1] );
2232 # Make sure unsafe characters are encoded
2233 $url = preg_replace_callback( '/[\x00-\x20"<>\[\\\\\]^`{|}\x7F-\xFF]/',
2235 return rawurlencode( $m[0] );
2241 $end = strlen( $url );
2243 # Fragment part - 'fragment'
2244 $start = strpos( $url, '#' );
2245 if ( $start !== false && $start < $end ) {
2246 $ret = self
::normalizeUrlComponent(
2247 substr( $url, $start, $end - $start ), '"#%<>[\]^`{|}' ) . $ret;
2251 # Query part - 'query' minus &=+;
2252 $start = strpos( $url, '?' );
2253 if ( $start !== false && $start < $end ) {
2254 $ret = self
::normalizeUrlComponent(
2255 substr( $url, $start, $end - $start ), '"#%<>[\]^`{|}&=+;' ) . $ret;
2259 # Scheme and path part - 'pchar'
2260 # (we assume no userinfo or encoded colons in the host)
2261 $ret = self
::normalizeUrlComponent(
2262 substr( $url, 0, $end ), '"#%<>[\]^`{|}/?' ) . $ret;
2265 if ( $isIPv6 !== false ) {
2266 $ipv6Host = "%5B({$isIPv6})%5D";
2267 $ret = preg_replace(
2268 "<^((?:{$scheme})?//(?:{$userinfo}@)?){$ipv6Host}(?=[:/?#]|$)>i",
2277 private static function normalizeUrlComponent( $component, $unsafe ) {
2278 $callback = function ( $matches ) use ( $unsafe ) {
2279 $char = urldecode( $matches[0] );
2280 $ord = ord( $char );
2281 if ( $ord > 32 && $ord < 127 && strpos( $unsafe, $char ) === false ) {
2285 # Leave it escaped, but use uppercase for a-f
2286 return strtoupper( $matches[0] );
2289 return preg_replace_callback( '/%[0-9A-Fa-f]{2}/', $callback, $component );
2293 * make an image if it's allowed, either through the global
2294 * option, through the exception, or through the on-wiki whitelist
2296 * @param string $url
2300 private function maybeMakeExternalImage( $url ) {
2301 $imagesfrom = $this->mOptions
->getAllowExternalImagesFrom();
2302 $imagesexception = !empty( $imagesfrom );
2304 # $imagesfrom could be either a single string or an array of strings, parse out the latter
2305 if ( $imagesexception && is_array( $imagesfrom ) ) {
2306 $imagematch = false;
2307 foreach ( $imagesfrom as $match ) {
2308 if ( strpos( $url, $match ) === 0 ) {
2313 } elseif ( $imagesexception ) {
2314 $imagematch = ( strpos( $url, $imagesfrom ) === 0 );
2316 $imagematch = false;
2319 if ( $this->mOptions
->getAllowExternalImages()
2320 ||
( $imagesexception && $imagematch )
2322 if ( preg_match( self
::EXT_IMAGE_REGEX
, $url ) ) {
2324 $text = Linker
::makeExternalImage( $url );
2327 if ( !$text && $this->mOptions
->getEnableImageWhitelist()
2328 && preg_match( self
::EXT_IMAGE_REGEX
, $url )
2330 $whitelist = explode(
2332 wfMessage( 'external_image_whitelist' )->inContentLanguage()->text()
2335 foreach ( $whitelist as $entry ) {
2336 # Sanitize the regex fragment, make it case-insensitive, ignore blank entries/comments
2337 if ( strpos( $entry, '#' ) === 0 ||
$entry === '' ) {
2340 if ( preg_match( '/' . str_replace( '/', '\\/', $entry ) . '/i', $url ) ) {
2341 # Image matches a whitelist entry
2342 $text = Linker
::makeExternalImage( $url );
2351 * Process [[ ]] wikilinks
2353 * @param string $text
2355 * @return string Processed text
2358 * @deprecated since 1.34; should not be used outside parser class.
2360 public function replaceInternalLinks( $text ) {
2361 wfDeprecated( __METHOD__
, '1.34' );
2362 return $this->handleInternalLinks( $text );
2366 * Process [[ ]] wikilinks
2368 * @param string $text
2370 * @return string Processed text
2372 private function handleInternalLinks( $text ) {
2373 $this->mLinkHolders
->merge( $this->handleInternalLinks2( $text ) );
2378 * Process [[ ]] wikilinks (RIL)
2379 * @param string &$text
2380 * @throws MWException
2381 * @return LinkHolderArray
2384 * @deprecated since 1.34; should not be used outside parser class.
2386 public function replaceInternalLinks2( &$text ) {
2387 wfDeprecated( __METHOD__
, '1.34' );
2388 return $this->handleInternalLinks2( $text );
2392 * Process [[ ]] wikilinks (RIL)
2394 * @throws MWException
2395 * @return LinkHolderArray
2397 private function handleInternalLinks2( &$s ) {
2398 static $tc = false, $e1, $e1_img;
2399 # the % is needed to support urlencoded titles as well
2401 $tc = Title
::legalChars() . '#%';
2402 # Match a link having the form [[namespace:link|alternate]]trail
2403 $e1 = "/^([{$tc}]+)(?:\\|(.+?))?]](.*)\$/sD";
2404 # Match cases where there is no "]]", which might still be images
2405 $e1_img = "/^([{$tc}]+)\\|(.*)\$/sD";
2408 $holders = new LinkHolderArray( $this );
2410 # split the entire text string on occurrences of [[
2411 $a = StringUtils
::explode( '[[', ' ' . $s );
2412 # get the first element (all text up to first [[), and remove the space we added
2415 $line = $a->current(); # Workaround for broken ArrayIterator::next() that returns "void"
2416 $s = substr( $s, 1 );
2418 if ( is_null( $this->mTitle
) ) {
2419 throw new MWException( __METHOD__
. ": \$this->mTitle is null\n" );
2421 $nottalk = !$this->mTitle
->isTalkPage();
2423 $useLinkPrefixExtension = $this->getTargetLanguage()->linkPrefixExtension();
2425 if ( $useLinkPrefixExtension ) {
2426 # Match the end of a line for a word that's not followed by whitespace,
2427 # e.g. in the case of 'The Arab al[[Razi]]', 'al' will be matched
2428 $charset = $this->contLang
->linkPrefixCharset();
2429 $e2 = "/^((?>.*[^$charset]|))(.+)$/sDu";
2431 if ( preg_match( $e2, $s, $m ) ) {
2432 $first_prefix = $m[2];
2434 $first_prefix = false;
2440 # Some namespaces don't allow subpages
2441 $useSubpages = $this->nsInfo
->hasSubpages(
2442 $this->mTitle
->getNamespace()
2445 # Loop for each link
2446 for ( ; $line !== false && $line !== null; $a->next(), $line = $a->current() ) {
2447 # Check for excessive memory usage
2448 if ( $holders->isBig() ) {
2450 # Do the existence check, replace the link holders and clear the array
2451 $holders->replace( $s );
2455 if ( $useLinkPrefixExtension ) {
2456 if ( preg_match( $e2, $s, $m ) ) {
2457 list( , $s, $prefix ) = $m;
2462 if ( $first_prefix ) {
2463 $prefix = $first_prefix;
2464 $first_prefix = false;
2468 $might_be_img = false;
2470 if ( preg_match( $e1, $line, $m ) ) { # page with normal text or alt
2472 # If we get a ] at the beginning of $m[3] that means we have a link that's something like:
2473 # [[Image:Foo.jpg|[http://example.com desc]]] <- having three ] in a row fucks up,
2474 # the real problem is with the $e1 regex
2476 # Still some problems for cases where the ] is meant to be outside punctuation,
2477 # and no image is in sight. See T4095.
2479 && substr( $m[3], 0, 1 ) === ']'
2480 && strpos( $text, '[' ) !== false
2482 $text .= ']'; # so that handleExternalLinks($text) works later
2483 $m[3] = substr( $m[3], 1 );
2485 # fix up urlencoded title texts
2486 if ( strpos( $m[1], '%' ) !== false ) {
2487 # Should anchors '#' also be rejected?
2488 $m[1] = str_replace( [ '<', '>' ], [ '<', '>' ], rawurldecode( $m[1] ) );
2491 } elseif ( preg_match( $e1_img, $line, $m ) ) {
2492 # Invalid, but might be an image with a link in its caption
2493 $might_be_img = true;
2495 if ( strpos( $m[1], '%' ) !== false ) {
2496 $m[1] = str_replace( [ '<', '>' ], [ '<', '>' ], rawurldecode( $m[1] ) );
2499 } else { # Invalid form; output directly
2500 $s .= $prefix . '[[' . $line;
2504 $origLink = ltrim( $m[1], ' ' );
2506 # Don't allow internal links to pages containing
2507 # PROTO: where PROTO is a valid URL protocol; these
2508 # should be external links.
2509 if ( preg_match( '/^(?i:' . $this->mUrlProtocols
. ')/', $origLink ) ) {
2510 $s .= $prefix . '[[' . $line;
2514 # Make subpage if necessary
2515 if ( $useSubpages ) {
2516 $link = Linker
::normalizeSubpageLink(
2517 $this->mTitle
, $origLink, $text
2523 // \x7f isn't a default legal title char, so most likely strip
2524 // markers will force us into the "invalid form" path above. But,
2525 // just in case, let's assert that xmlish tags aren't valid in
2526 // the title position.
2527 $unstrip = $this->mStripState
->killMarkers( $link );
2528 $noMarkers = ( $unstrip === $link );
2530 $nt = $noMarkers ? Title
::newFromText( $link ) : null;
2531 if ( $nt === null ) {
2532 $s .= $prefix . '[[' . $line;
2536 $ns = $nt->getNamespace();
2537 $iw = $nt->getInterwiki();
2539 $noforce = ( substr( $origLink, 0, 1 ) !== ':' );
2541 if ( $might_be_img ) { # if this is actually an invalid link
2542 if ( $ns == NS_FILE
&& $noforce ) { # but might be an image
2545 # look at the next 'line' to see if we can close it there
2547 $next_line = $a->current();
2548 if ( $next_line === false ||
$next_line === null ) {
2551 $m = explode( ']]', $next_line, 3 );
2552 if ( count( $m ) == 3 ) {
2553 # the first ]] closes the inner link, the second the image
2555 $text .= "[[{$m[0]}]]{$m[1]}";
2558 } elseif ( count( $m ) == 2 ) {
2559 # if there's exactly one ]] that's fine, we'll keep looking
2560 $text .= "[[{$m[0]}]]{$m[1]}";
2562 # if $next_line is invalid too, we need look no further
2563 $text .= '[[' . $next_line;
2568 # we couldn't find the end of this imageLink, so output it raw
2569 # but don't ignore what might be perfectly normal links in the text we've examined
2570 $holders->merge( $this->handleInternalLinks2( $text ) );
2571 $s .= "{$prefix}[[$link|$text";
2572 # note: no $trail, because without an end, there *is* no trail
2575 } else { # it's not an image, so output it raw
2576 $s .= "{$prefix}[[$link|$text";
2577 # note: no $trail, because without an end, there *is* no trail
2582 $wasblank = ( $text == '' );
2586 # Strip off leading ':'
2587 $text = substr( $text, 1 );
2590 # T6598 madness. Handle the quotes only if they come from the alternate part
2591 # [[Lista d''e paise d''o munno]] -> <a href="...">Lista d''e paise d''o munno</a>
2592 # [[Criticism of Harry Potter|Criticism of ''Harry Potter'']]
2593 # -> <a href="Criticism of Harry Potter">Criticism of <i>Harry Potter</i></a>
2594 $text = $this->doQuotes( $text );
2597 # Link not escaped by : , create the various objects
2598 if ( $noforce && !$nt->wasLocalInterwiki() ) {
2601 $iw && $this->mOptions
->getInterwikiMagic() && $nottalk && (
2602 Language
::fetchLanguageName( $iw, null, 'mw' ) ||
2603 in_array( $iw, $this->svcOptions
->get( 'ExtraInterlanguageLinkPrefixes' ) )
2606 # T26502: filter duplicates
2607 if ( !isset( $this->mLangLinkLanguages
[$iw] ) ) {
2608 $this->mLangLinkLanguages
[$iw] = true;
2609 $this->mOutput
->addLanguageLink( $nt->getFullText() );
2613 * Strip the whitespace interwiki links produce, see T10897
2615 $s = rtrim( $s . $prefix ) . $trail; # T175416
2619 if ( $ns == NS_FILE
) {
2620 if ( !$this->badFileLookup
->isBadFile( $nt->getDBkey(), $this->mTitle
) ) {
2622 # if no parameters were passed, $text
2623 # becomes something like "File:Foo.png",
2624 # which we don't want to pass on to the
2628 # recursively parse links inside the image caption
2629 # actually, this will parse them in any other parameters, too,
2630 # but it might be hard to fix that, and it doesn't matter ATM
2631 $text = $this->handleExternalLinks( $text );
2632 $holders->merge( $this->handleInternalLinks2( $text ) );
2634 # cloak any absolute URLs inside the image markup, so handleExternalLinks() won't touch them
2635 $s .= $prefix . $this->armorLinksPrivate(
2636 $this->makeImage( $nt, $text, $holders ) ) . $trail;
2639 } elseif ( $ns == NS_CATEGORY
) {
2641 * Strip the whitespace Category links produce, see T2087
2643 $s = rtrim( $s . $prefix ) . $trail; # T2087, T87753
2646 $sortkey = $this->getDefaultSort();
2650 $sortkey = Sanitizer
::decodeCharReferences( $sortkey );
2651 $sortkey = str_replace( "\n", '', $sortkey );
2652 $sortkey = $this->getTargetLanguage()->convertCategoryKey( $sortkey );
2653 $this->mOutput
->addCategory( $nt->getDBkey(), $sortkey );
2659 # Self-link checking. For some languages, variants of the title are checked in
2660 # LinkHolderArray::doVariants() to allow batching the existence checks necessary
2661 # for linking to a different variant.
2662 if ( $ns != NS_SPECIAL
&& $nt->equals( $this->mTitle
) && !$nt->hasFragment() ) {
2663 $s .= $prefix . Linker
::makeSelfLinkObj( $nt, $text, '', $trail );
2667 # NS_MEDIA is a pseudo-namespace for linking directly to a file
2668 # @todo FIXME: Should do batch file existence checks, see comment below
2669 if ( $ns == NS_MEDIA
) {
2670 # Give extensions a chance to select the file revision for us
2673 Hooks
::run( 'BeforeParserFetchFileAndTitle',
2674 [ $this, $nt, &$options, &$descQuery ] );
2675 # Fetch and register the file (file title may be different via hooks)
2676 list( $file, $nt ) = $this->fetchFileAndTitle( $nt, $options );
2677 # Cloak with NOPARSE to avoid replacement in handleExternalLinks
2678 $s .= $prefix . $this->armorLinksPrivate(
2679 Linker
::makeMediaLinkFile( $nt, $file, $text ) ) . $trail;
2683 # Some titles, such as valid special pages or files in foreign repos, should
2684 # be shown as bluelinks even though they're not included in the page table
2685 # @todo FIXME: isAlwaysKnown() can be expensive for file links; we should really do
2686 # batch file existence checks for NS_FILE and NS_MEDIA
2687 if ( $iw == '' && $nt->isAlwaysKnown() ) {
2688 $this->mOutput
->addLink( $nt );
2689 $s .= $this->makeKnownLinkHolderPrivate( $nt, $text, $trail, $prefix );
2691 # Links will be added to the output link list after checking
2692 $s .= $holders->makeHolder( $nt, $text, [], $trail, $prefix );
2699 * Render a forced-blue link inline; protect against double expansion of
2700 * URLs if we're in a mode that prepends full URL prefixes to internal links.
2701 * Since this little disaster has to split off the trail text to avoid
2702 * breaking URLs in the following text without breaking trails on the
2703 * wiki links, it's been made into a horrible function.
2706 * @param string $text
2707 * @param string $trail
2708 * @param string $prefix
2709 * @return string HTML-wikitext mix oh yuck
2710 * @deprecated since 1.34; should not be used outside parser class.
2712 protected function makeKnownLinkHolder( $nt, $text = '', $trail = '', $prefix = '' ) {
2713 wfDeprecated( __METHOD__
, '1.34' );
2714 return $this->makeKnownLinkHolderPrivate( $nt, $text, $trail, $prefix );
2718 * Render a forced-blue link inline; protect against double expansion of
2719 * URLs if we're in a mode that prepends full URL prefixes to internal links.
2720 * Since this little disaster has to split off the trail text to avoid
2721 * breaking URLs in the following text without breaking trails on the
2722 * wiki links, it's been made into a horrible function.
2725 * @param string $text
2726 * @param string $trail
2727 * @param string $prefix
2728 * @return string HTML-wikitext mix oh yuck
2730 private function makeKnownLinkHolderPrivate( $nt, $text = '', $trail = '', $prefix = '' ) {
2731 list( $inside, $trail ) = Linker
::splitTrail( $trail );
2733 if ( $text == '' ) {
2734 $text = htmlspecialchars( $nt->getPrefixedText() );
2737 $link = $this->getLinkRenderer()->makeKnownLink(
2738 $nt, new HtmlArmor( "$prefix$text$inside" )
2741 return $this->armorLinksPrivate( $link ) . $trail;
2745 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
2746 * going to go through further parsing steps before inline URL expansion.
2748 * Not needed quite as much as it used to be since free links are a bit
2749 * more sensible these days. But bracketed links are still an issue.
2751 * @param string $text More-or-less HTML
2752 * @return string Less-or-more HTML with NOPARSE bits
2753 * @deprecated since 1.34; should not be used outside parser class.
2755 public function armorLinks( $text ) {
2756 wfDeprecated( __METHOD__
, '1.34' );
2757 return $this->armorLinksPrivate( $text );
2761 * Insert a NOPARSE hacky thing into any inline links in a chunk that's
2762 * going to go through further parsing steps before inline URL expansion.
2764 * Not needed quite as much as it used to be since free links are a bit
2765 * more sensible these days. But bracketed links are still an issue.
2767 * @param string $text More-or-less HTML
2768 * @return string Less-or-more HTML with NOPARSE bits
2770 private function armorLinksPrivate( $text ) {
2771 return preg_replace( '/\b((?i)' . $this->mUrlProtocols
. ')/',
2772 self
::MARKER_PREFIX
. "NOPARSE$1", $text );
2776 * Return true if subpage links should be expanded on this page.
2778 * @deprecated since 1.34; should not be used outside parser class.
2780 public function areSubpagesAllowed() {
2781 # Some namespaces don't allow subpages
2782 wfDeprecated( __METHOD__
, '1.34' );
2783 return $this->nsInfo
->hasSubpages( $this->mTitle
->getNamespace() );
2787 * Handle link to subpage if necessary
2789 * @param string $target The source of the link
2790 * @param string &$text The link text, modified as necessary
2791 * @return string The full name of the link
2793 * @deprecated since 1.34; should not be used outside parser class.
2795 public function maybeDoSubpageLink( $target, &$text ) {
2796 wfDeprecated( __METHOD__
, '1.34' );
2797 return Linker
::normalizeSubpageLink( $this->mTitle
, $target, $text );
2801 * Make lists from lines starting with ':', '*', '#', etc. (DBL)
2803 * @param string $text
2804 * @param bool $linestart Whether or not this is at the start of a line.
2806 * @return string The lists rendered as HTML
2808 public function doBlockLevels( $text, $linestart ) {
2809 return BlockLevelPass
::doBlockLevels( $text, $linestart );
2813 * Return value of a magic variable (like PAGENAME)
2817 * @param string $index Magic variable identifier as mapped in MagicWordFactory::$mVariableIDs
2818 * @param bool|PPFrame $frame
2820 * @throws MWException
2822 * @deprecated since 1.34; should not be used outside parser class.
2824 public function getVariableValue( $index, $frame = false ) {
2825 wfDeprecated( __METHOD__
, '1.34' );
2826 return $this->expandMagicVariable( $index, $frame );
2830 * Return value of a magic variable (like PAGENAME)
2832 * @param string $index Magic variable identifier as mapped in MagicWordFactory::$mVariableIDs
2833 * @param bool|PPFrame $frame
2835 * @throws MWException
2838 private function expandMagicVariable( $index, $frame = false ) {
2839 // XXX This function should be moved out of Parser class for
2840 // reuse by Parsoid/etc.
2841 if ( is_null( $this->mTitle
) ) {
2842 // If no title set, bad things are going to happen
2843 // later. Title should always be set since this
2844 // should only be called in the middle of a parse
2845 // operation (but the unit-tests do funky stuff)
2846 throw new MWException( __METHOD__
. ' Should only be '
2847 . ' called while parsing (no title set)' );
2850 // Avoid PHP 7.1 warning from passing $this by reference
2854 * Some of these require message or data lookups and can be
2855 * expensive to check many times.
2858 Hooks
::run( 'ParserGetVariableValueVarCache', [ &$parser, &$this->mVarCache
] ) &&
2859 isset( $this->mVarCache
[$index] )
2861 return $this->mVarCache
[$index];
2864 $ts = wfTimestamp( TS_UNIX
, $this->mOptions
->getTimestamp() );
2865 Hooks
::run( 'ParserGetVariableValueTs', [ &$parser, &$ts ] );
2867 $pageLang = $this->getFunctionLang();
2873 case 'currentmonth':
2874 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'm' ), true );
2876 case 'currentmonth1':
2877 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'n' ), true );
2879 case 'currentmonthname':
2880 $value = $pageLang->getMonthName( MWTimestamp
::getInstance( $ts )->format( 'n' ) );
2882 case 'currentmonthnamegen':
2883 $value = $pageLang->getMonthNameGen( MWTimestamp
::getInstance( $ts )->format( 'n' ) );
2885 case 'currentmonthabbrev':
2886 $value = $pageLang->getMonthAbbreviation( MWTimestamp
::getInstance( $ts )->format( 'n' ) );
2889 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'j' ), true );
2892 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'd' ), true );
2895 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'm' ), true );
2898 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'n' ), true );
2900 case 'localmonthname':
2901 $value = $pageLang->getMonthName( MWTimestamp
::getLocalInstance( $ts )->format( 'n' ) );
2903 case 'localmonthnamegen':
2904 $value = $pageLang->getMonthNameGen( MWTimestamp
::getLocalInstance( $ts )->format( 'n' ) );
2906 case 'localmonthabbrev':
2907 $value = $pageLang->getMonthAbbreviation( MWTimestamp
::getLocalInstance( $ts )->format( 'n' ) );
2910 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'j' ), true );
2913 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'd' ), true );
2916 $value = wfEscapeWikiText( $this->mTitle
->getText() );
2919 $value = wfEscapeWikiText( $this->mTitle
->getPartialURL() );
2921 case 'fullpagename':
2922 $value = wfEscapeWikiText( $this->mTitle
->getPrefixedText() );
2924 case 'fullpagenamee':
2925 $value = wfEscapeWikiText( $this->mTitle
->getPrefixedURL() );
2928 $value = wfEscapeWikiText( $this->mTitle
->getSubpageText() );
2930 case 'subpagenamee':
2931 $value = wfEscapeWikiText( $this->mTitle
->getSubpageUrlForm() );
2933 case 'rootpagename':
2934 $value = wfEscapeWikiText( $this->mTitle
->getRootText() );
2936 case 'rootpagenamee':
2937 $value = wfEscapeWikiText( wfUrlencode( str_replace(
2940 $this->mTitle
->getRootText()
2943 case 'basepagename':
2944 $value = wfEscapeWikiText( $this->mTitle
->getBaseText() );
2946 case 'basepagenamee':
2947 $value = wfEscapeWikiText( wfUrlencode( str_replace(
2950 $this->mTitle
->getBaseText()
2953 case 'talkpagename':
2954 if ( $this->mTitle
->canHaveTalkPage() ) {
2955 $talkPage = $this->mTitle
->getTalkPage();
2956 $value = wfEscapeWikiText( $talkPage->getPrefixedText() );
2961 case 'talkpagenamee':
2962 if ( $this->mTitle
->canHaveTalkPage() ) {
2963 $talkPage = $this->mTitle
->getTalkPage();
2964 $value = wfEscapeWikiText( $talkPage->getPrefixedURL() );
2969 case 'subjectpagename':
2970 $subjPage = $this->mTitle
->getSubjectPage();
2971 $value = wfEscapeWikiText( $subjPage->getPrefixedText() );
2973 case 'subjectpagenamee':
2974 $subjPage = $this->mTitle
->getSubjectPage();
2975 $value = wfEscapeWikiText( $subjPage->getPrefixedURL() );
2977 case 'pageid': // requested in T25427
2978 # Inform the edit saving system that getting the canonical output
2979 # after page insertion requires a parse that used that exact page ID
2980 $this->setOutputFlag( 'vary-page-id', '{{PAGEID}} used' );
2981 $value = $this->mTitle
->getArticleID();
2983 $value = $this->mOptions
->getSpeculativePageId();
2985 $this->mOutput
->setSpeculativePageIdUsed( $value );
2991 $this->svcOptions
->get( 'MiserMode' ) &&
2992 !$this->mOptions
->getInterfaceMessage() &&
2993 // @TODO: disallow this word on all namespaces
2994 $this->nsInfo
->isContent( $this->mTitle
->getNamespace() )
2996 // Use a stub result instead of the actual revision ID in order to avoid
2997 // double parses on page save but still allow preview detection (T137900)
2998 if ( $this->getRevisionId() ||
$this->mOptions
->getSpeculativeRevId() ) {
3001 $this->setOutputFlag( 'vary-revision-exists', '{{REVISIONID}} used' );
3005 # Inform the edit saving system that getting the canonical output after
3006 # revision insertion requires a parse that used that exact revision ID
3007 $this->setOutputFlag( 'vary-revision-id', '{{REVISIONID}} used' );
3008 $value = $this->getRevisionId();
3009 if ( $value === 0 ) {
3010 $rev = $this->getRevisionObject();
3011 $value = $rev ?
$rev->getId() : $value;
3014 $value = $this->mOptions
->getSpeculativeRevId();
3016 $this->mOutput
->setSpeculativeRevIdUsed( $value );
3022 $value = (int)$this->getRevisionTimestampSubstring( 6, 2, self
::MAX_TTS
, $index );
3024 case 'revisionday2':
3025 $value = $this->getRevisionTimestampSubstring( 6, 2, self
::MAX_TTS
, $index );
3027 case 'revisionmonth':
3028 $value = $this->getRevisionTimestampSubstring( 4, 2, self
::MAX_TTS
, $index );
3030 case 'revisionmonth1':
3031 $value = (int)$this->getRevisionTimestampSubstring( 4, 2, self
::MAX_TTS
, $index );
3033 case 'revisionyear':
3034 $value = $this->getRevisionTimestampSubstring( 0, 4, self
::MAX_TTS
, $index );
3036 case 'revisiontimestamp':
3037 $value = $this->getRevisionTimestampSubstring( 0, 14, self
::MAX_TTS
, $index );
3039 case 'revisionuser':
3040 # Inform the edit saving system that getting the canonical output after
3041 # revision insertion requires a parse that used the actual user ID
3042 $this->setOutputFlag( 'vary-user', '{{REVISIONUSER}} used' );
3043 $value = $this->getRevisionUser();
3045 case 'revisionsize':
3046 $value = $this->getRevisionSize();
3049 $value = str_replace( '_', ' ',
3050 $this->contLang
->getNsText( $this->mTitle
->getNamespace() ) );
3053 $value = wfUrlencode( $this->contLang
->getNsText( $this->mTitle
->getNamespace() ) );
3055 case 'namespacenumber':
3056 $value = $this->mTitle
->getNamespace();
3059 $value = $this->mTitle
->canHaveTalkPage()
3060 ?
str_replace( '_', ' ', $this->mTitle
->getTalkNsText() )
3064 $value = $this->mTitle
->canHaveTalkPage() ?
wfUrlencode( $this->mTitle
->getTalkNsText() ) : '';
3066 case 'subjectspace':
3067 $value = str_replace( '_', ' ', $this->mTitle
->getSubjectNsText() );
3069 case 'subjectspacee':
3070 $value = ( wfUrlencode( $this->mTitle
->getSubjectNsText() ) );
3072 case 'currentdayname':
3073 $value = $pageLang->getWeekdayName( (int)MWTimestamp
::getInstance( $ts )->format( 'w' ) +
1 );
3076 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'Y' ), true );
3079 $value = $pageLang->time( wfTimestamp( TS_MW
, $ts ), false, false );
3082 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'H' ), true );
3085 # @bug T6594 PHP5 has it zero padded, PHP4 does not, cast to
3086 # int to remove the padding
3087 $value = $pageLang->formatNum( (int)MWTimestamp
::getInstance( $ts )->format( 'W' ) );
3090 $value = $pageLang->formatNum( MWTimestamp
::getInstance( $ts )->format( 'w' ) );
3092 case 'localdayname':
3093 $value = $pageLang->getWeekdayName(
3094 (int)MWTimestamp
::getLocalInstance( $ts )->format( 'w' ) +
1
3098 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'Y' ), true );
3101 $value = $pageLang->time(
3102 MWTimestamp
::getLocalInstance( $ts )->format( 'YmdHis' ),
3108 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'H' ), true );
3111 # @bug T6594 PHP5 has it zero padded, PHP4 does not, cast to
3112 # int to remove the padding
3113 $value = $pageLang->formatNum( (int)MWTimestamp
::getLocalInstance( $ts )->format( 'W' ) );
3116 $value = $pageLang->formatNum( MWTimestamp
::getLocalInstance( $ts )->format( 'w' ) );
3118 case 'numberofarticles':
3119 $value = $pageLang->formatNum( SiteStats
::articles() );
3121 case 'numberoffiles':
3122 $value = $pageLang->formatNum( SiteStats
::images() );
3124 case 'numberofusers':
3125 $value = $pageLang->formatNum( SiteStats
::users() );
3127 case 'numberofactiveusers':
3128 $value = $pageLang->formatNum( SiteStats
::activeUsers() );
3130 case 'numberofpages':
3131 $value = $pageLang->formatNum( SiteStats
::pages() );
3133 case 'numberofadmins':
3134 $value = $pageLang->formatNum( SiteStats
::numberingroup( 'sysop' ) );
3136 case 'numberofedits':
3137 $value = $pageLang->formatNum( SiteStats
::edits() );
3139 case 'currenttimestamp':
3140 $value = wfTimestamp( TS_MW
, $ts );
3142 case 'localtimestamp':
3143 $value = MWTimestamp
::getLocalInstance( $ts )->format( 'YmdHis' );
3145 case 'currentversion':
3146 $value = SpecialVersion
::getVersion();
3149 return $this->svcOptions
->get( 'ArticlePath' );
3151 return $this->svcOptions
->get( 'Sitename' );
3153 return $this->svcOptions
->get( 'Server' );
3155 return $this->svcOptions
->get( 'ServerName' );
3157 return $this->svcOptions
->get( 'ScriptPath' );
3159 return $this->svcOptions
->get( 'StylePath' );
3160 case 'directionmark':
3161 return $pageLang->getDirMark();
3162 case 'contentlanguage':
3163 return $this->svcOptions
->get( 'LanguageCode' );
3164 case 'pagelanguage':
3165 $value = $pageLang->getCode();
3167 case 'cascadingsources':
3168 $value = CoreParserFunctions
::cascadingsources( $this );
3173 'ParserGetVariableValueSwitch',
3174 [ &$parser, &$this->mVarCache
, &$index, &$ret, &$frame ]
3181 $this->mVarCache
[$index] = $value;
3190 * @param int $mtts Max time-till-save; sets vary-revision-timestamp if result changes by then
3191 * @param string $variable Parser variable name
3194 private function getRevisionTimestampSubstring( $start, $len, $mtts, $variable ) {
3195 # Get the timezone-adjusted timestamp to be used for this revision
3196 $resNow = substr( $this->getRevisionTimestamp(), $start, $len );
3197 # Possibly set vary-revision if there is not yet an associated revision
3198 if ( !$this->getRevisionObject() ) {
3199 # Get the timezone-adjusted timestamp $mtts seconds in the future.
3200 # This future is relative to the current time and not that of the
3201 # parser options. The rendered timestamp can be compared to that
3202 # of the timestamp specified by the parser options.
3204 $this->contLang
->userAdjust( wfTimestamp( TS_MW
, time() +
$mtts ), '' ),
3209 if ( $resNow !== $resThen ) {
3210 # Inform the edit saving system that getting the canonical output after
3211 # revision insertion requires a parse that used an actual revision timestamp
3212 $this->setOutputFlag( 'vary-revision-timestamp', "$variable used" );
3220 * initialise the magic variables (like CURRENTMONTHNAME) and substitution modifiers
3223 * @deprecated since 1.34; should not be used outside parser class.
3225 public function initialiseVariables() {
3226 wfDeprecated( __METHOD__
, '1.34' );
3227 $this->initializeVariables();
3231 * Initialize the magic variables (like CURRENTMONTHNAME) and
3232 * substitution modifiers.
3234 private function initializeVariables() {
3235 $variableIDs = $this->magicWordFactory
->getVariableIDs();
3236 $substIDs = $this->magicWordFactory
->getSubstIDs();
3238 $this->mVariables
= $this->magicWordFactory
->newArray( $variableIDs );
3239 $this->mSubstWords
= $this->magicWordFactory
->newArray( $substIDs );
3243 * Preprocess some wikitext and return the document tree.
3244 * This is the ghost of replace_variables().
3246 * @param string $text The text to parse
3247 * @param int $flags Bitwise combination of:
3248 * - self::PTD_FOR_INCLUSION: Handle "<noinclude>" and "<includeonly>" as if the text is being
3249 * included. Default is to assume a direct page view.
3251 * The generated DOM tree must depend only on the input text and the flags.
3252 * The DOM tree must be the same in OT_HTML and OT_WIKI mode, to avoid a regression of T6899.
3254 * Any flag added to the $flags parameter here, or any other parameter liable to cause a
3255 * change in the DOM tree for a given text, must be passed through the section identifier
3256 * in the section edit link and thus back to extractSections().
3258 * The output of this function is currently only cached in process memory, but a persistent
3259 * cache may be implemented at a later date which takes further advantage of these strict
3260 * dependency requirements.
3264 public function preprocessToDom( $text, $flags = 0 ) {
3265 $dom = $this->getPreprocessor()->preprocessToObj( $text, $flags );
3270 * Return a three-element array: leading whitespace, string contents, trailing whitespace
3275 * @deprecated since 1.34; appears to be unused.
3277 public static function splitWhitespace( $s ) {
3278 wfDeprecated( __METHOD__
, '1.34' );
3279 $ltrimmed = ltrim( $s );
3280 $w1 = substr( $s, 0, strlen( $s ) - strlen( $ltrimmed ) );
3281 $trimmed = rtrim( $ltrimmed );
3282 $diff = strlen( $ltrimmed ) - strlen( $trimmed );
3284 $w2 = substr( $ltrimmed, -$diff );
3288 return [ $w1, $trimmed, $w2 ];
3292 * Replace magic variables, templates, and template arguments
3293 * with the appropriate text. Templates are substituted recursively,
3294 * taking care to avoid infinite loops.
3296 * Note that the substitution depends on value of $mOutputType:
3297 * self::OT_WIKI: only {{subst:}} templates
3298 * self::OT_PREPROCESS: templates but not extension tags
3299 * self::OT_HTML: all templates and extension tags
3301 * @param string $text The text to transform
3302 * @param false|PPFrame|array $frame Object describing the arguments passed to the
3303 * template. Arguments may also be provided as an associative array, as
3304 * was the usual case before MW1.12. Providing arguments this way may be
3305 * useful for extensions wishing to perform variable replacement
3307 * @param bool $argsOnly Only do argument (triple-brace) expansion, not
3308 * double-brace expansion.
3311 public function replaceVariables( $text, $frame = false, $argsOnly = false ) {
3312 # Is there any text? Also, Prevent too big inclusions!
3313 $textSize = strlen( $text );
3314 if ( $textSize < 1 ||
$textSize > $this->mOptions
->getMaxIncludeSize() ) {
3318 if ( $frame === false ) {
3319 $frame = $this->getPreprocessor()->newFrame();
3320 } elseif ( !( $frame instanceof PPFrame
) ) {
3321 $this->logger
->debug(
3322 __METHOD__
. " called using plain parameters instead of " .
3323 "a PPFrame instance. Creating custom frame."
3325 $frame = $this->getPreprocessor()->newCustomFrame( $frame );
3328 $dom = $this->preprocessToDom( $text );
3329 $flags = $argsOnly ? PPFrame
::NO_TEMPLATES
: 0;
3330 $text = $frame->expand( $dom, $flags );
3336 * Clean up argument array - refactored in 1.9 so parserfunctions can use it, too.
3338 * @param array $args
3341 * @deprecated since 1.34; appears to be unused in core.
3343 public static function createAssocArgs( $args ) {
3344 wfDeprecated( __METHOD__
, '1.34' );
3347 foreach ( $args as $arg ) {
3348 $eqpos = strpos( $arg, '=' );
3349 if ( $eqpos === false ) {
3350 $assocArgs[$index++
] = $arg;
3352 $name = trim( substr( $arg, 0, $eqpos ) );
3353 $value = trim( substr( $arg, $eqpos +
1 ) );
3354 if ( $value === false ) {
3357 if ( $name !== false ) {
3358 $assocArgs[$name] = $value;
3367 * Warn the user when a parser limitation is reached
3368 * Will warn at most once the user per limitation type
3370 * The results are shown during preview and run through the Parser (See EditPage.php)
3372 * @param string $limitationType Should be one of:
3373 * 'expensive-parserfunction' (corresponding messages:
3374 * 'expensive-parserfunction-warning',
3375 * 'expensive-parserfunction-category')
3376 * 'post-expand-template-argument' (corresponding messages:
3377 * 'post-expand-template-argument-warning',
3378 * 'post-expand-template-argument-category')
3379 * 'post-expand-template-inclusion' (corresponding messages:
3380 * 'post-expand-template-inclusion-warning',
3381 * 'post-expand-template-inclusion-category')
3382 * 'node-count-exceeded' (corresponding messages:
3383 * 'node-count-exceeded-warning',
3384 * 'node-count-exceeded-category')
3385 * 'expansion-depth-exceeded' (corresponding messages:
3386 * 'expansion-depth-exceeded-warning',
3387 * 'expansion-depth-exceeded-category')
3388 * @param string|int|null $current Current value
3389 * @param string|int|null $max Maximum allowed, when an explicit limit has been
3390 * exceeded, provide the values (optional)
3392 public function limitationWarn( $limitationType, $current = '', $max = '' ) {
3393 # does no harm if $current and $max are present but are unnecessary for the message
3394 # Not doing ->inLanguage( $this->mOptions->getUserLangObj() ), since this is shown
3395 # only during preview, and that would split the parser cache unnecessarily.
3396 $warning = wfMessage( "$limitationType-warning" )->numParams( $current, $max )
3398 $this->mOutput
->addWarning( $warning );
3399 $this->addTrackingCategory( "$limitationType-category" );
3403 * Return the text of a template, after recursively
3404 * replacing any variables or templates within the template.
3406 * @param array $piece The parts of the template
3407 * $piece['title']: the title, i.e. the part before the |
3408 * $piece['parts']: the parameter array
3409 * $piece['lineStart']: whether the brace was at the start of a line
3410 * @param PPFrame $frame The current frame, contains template arguments
3412 * @return string|array The text of the template
3415 public function braceSubstitution( $piece, $frame ) {
3418 // $text has been filled
3420 // wiki markup in $text should be escaped
3422 // $text is HTML, armour it against wikitext transformation
3424 // Force interwiki transclusion to be done in raw mode not rendered
3425 $forceRawInterwiki = false;
3426 // $text is a DOM node needing expansion in a child frame
3427 $isChildObj = false;
3428 // $text is a DOM node needing expansion in the current frame
3429 $isLocalObj = false;
3431 # Title object, where $text came from
3434 # $part1 is the bit before the first |, and must contain only title characters.
3435 # Various prefixes will be stripped from it later.
3436 $titleWithSpaces = $frame->expand( $piece['title'] );
3437 $part1 = trim( $titleWithSpaces );
3440 # Original title text preserved for various purposes
3441 $originalTitle = $part1;
3443 # $args is a list of argument nodes, starting from index 0, not including $part1
3444 # @todo FIXME: If piece['parts'] is null then the call to getLength()
3445 # below won't work b/c this $args isn't an object
3446 $args = ( $piece['parts'] == null ) ?
[] : $piece['parts'];
3448 $profileSection = null; // profile templates
3452 $substMatch = $this->mSubstWords
->matchStartAndRemove( $part1 );
3454 # Possibilities for substMatch: "subst", "safesubst" or FALSE
3455 # Decide whether to expand template or keep wikitext as-is.
3456 if ( $this->ot
['wiki'] ) {
3457 if ( $substMatch === false ) {
3458 $literal = true; # literal when in PST with no prefix
3460 $literal = false; # expand when in PST with subst: or safesubst:
3463 if ( $substMatch == 'subst' ) {
3464 $literal = true; # literal when not in PST with plain subst:
3466 $literal = false; # expand when not in PST with safesubst: or no prefix
3470 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3477 if ( !$found && $args->getLength() == 0 ) {
3478 $id = $this->mVariables
->matchStartToEnd( $part1 );
3479 if ( $id !== false ) {
3480 $text = $this->expandMagicVariable( $id, $frame );
3481 if ( $this->magicWordFactory
->getCacheTTL( $id ) > -1 ) {
3482 $this->mOutput
->updateCacheExpiry(
3483 $this->magicWordFactory
->getCacheTTL( $id ) );
3489 # MSG, MSGNW and RAW
3492 $mwMsgnw = $this->magicWordFactory
->get( 'msgnw' );
3493 if ( $mwMsgnw->matchStartAndRemove( $part1 ) ) {
3496 # Remove obsolete MSG:
3497 $mwMsg = $this->magicWordFactory
->get( 'msg' );
3498 $mwMsg->matchStartAndRemove( $part1 );
3502 $mwRaw = $this->magicWordFactory
->get( 'raw' );
3503 if ( $mwRaw->matchStartAndRemove( $part1 ) ) {
3504 $forceRawInterwiki = true;
3510 $colonPos = strpos( $part1, ':' );
3511 if ( $colonPos !== false ) {
3512 $func = substr( $part1, 0, $colonPos );
3513 $funcArgs = [ trim( substr( $part1, $colonPos +
1 ) ) ];
3514 $argsLength = $args->getLength();
3515 for ( $i = 0; $i < $argsLength; $i++
) {
3516 $funcArgs[] = $args->item( $i );
3519 $result = $this->callParserFunction( $frame, $func, $funcArgs );
3521 // Extract any forwarded flags
3522 if ( isset( $result['title'] ) ) {
3523 $title = $result['title'];
3525 if ( isset( $result['found'] ) ) {
3526 $found = $result['found'];
3528 if ( array_key_exists( 'text', $result ) ) {
3530 $text = $result['text'];
3532 if ( isset( $result['nowiki'] ) ) {
3533 $nowiki = $result['nowiki'];
3535 if ( isset( $result['isHTML'] ) ) {
3536 $isHTML = $result['isHTML'];
3538 if ( isset( $result['forceRawInterwiki'] ) ) {
3539 $forceRawInterwiki = $result['forceRawInterwiki'];
3541 if ( isset( $result['isChildObj'] ) ) {
3542 $isChildObj = $result['isChildObj'];
3544 if ( isset( $result['isLocalObj'] ) ) {
3545 $isLocalObj = $result['isLocalObj'];
3550 # Finish mangling title and then check for loops.
3551 # Set $title to a Title object and $titleText to the PDBK
3554 # Split the title into page and subpage
3556 $relative = Linker
::normalizeSubpageLink(
3557 $this->mTitle
, $part1, $subpage
3559 if ( $part1 !== $relative ) {
3561 $ns = $this->mTitle
->getNamespace();
3563 $title = Title
::newFromText( $part1, $ns );
3565 $titleText = $title->getPrefixedText();
3566 # Check for language variants if the template is not found
3567 if ( $this->getTargetLanguage()->hasVariants() && $title->getArticleID() == 0 ) {
3568 $this->getTargetLanguage()->findVariantLink( $part1, $title, true );
3570 # Do recursion depth check
3571 $limit = $this->mOptions
->getMaxTemplateDepth();
3572 if ( $frame->depth
>= $limit ) {
3574 $text = '<span class="error">'
3575 . wfMessage( 'parser-template-recursion-depth-warning' )
3576 ->numParams( $limit )->inContentLanguage()->text()
3582 # Load from database
3583 if ( !$found && $title ) {
3584 $profileSection = $this->mProfiler
->scopedProfileIn( $title->getPrefixedDBkey() );
3585 if ( !$title->isExternal() ) {
3586 if ( $title->isSpecialPage()
3587 && $this->mOptions
->getAllowSpecialInclusion()
3588 && $this->ot
['html']
3590 $specialPage = $this->specialPageFactory
->getPage( $title->getDBkey() );
3591 // Pass the template arguments as URL parameters.
3592 // "uselang" will have no effect since the Language object
3593 // is forced to the one defined in ParserOptions.
3595 $argsLength = $args->getLength();
3596 for ( $i = 0; $i < $argsLength; $i++
) {
3597 $bits = $args->item( $i )->splitArg();
3598 if ( strval( $bits['index'] ) === '' ) {
3599 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
3600 $value = trim( $frame->expand( $bits['value'] ) );
3601 $pageArgs[$name] = $value;
3605 // Create a new context to execute the special page
3606 $context = new RequestContext
;
3607 $context->setTitle( $title );
3608 $context->setRequest( new FauxRequest( $pageArgs ) );
3609 if ( $specialPage && $specialPage->maxIncludeCacheTime() === 0 ) {
3610 $context->setUser( $this->getUser() );
3612 // If this page is cached, then we better not be per user.
3613 $context->setUser( User
::newFromName( '127.0.0.1', false ) );
3615 $context->setLanguage( $this->mOptions
->getUserLangObj() );
3616 $ret = $this->specialPageFactory
->capturePath( $title, $context, $this->getLinkRenderer() );
3618 $text = $context->getOutput()->getHTML();
3619 $this->mOutput
->addOutputPageMetadata( $context->getOutput() );
3622 if ( $specialPage && $specialPage->maxIncludeCacheTime() !== false ) {
3623 $this->mOutput
->updateRuntimeAdaptiveExpiry(
3624 $specialPage->maxIncludeCacheTime()
3628 } elseif ( $this->nsInfo
->isNonincludable( $title->getNamespace() ) ) {
3629 $found = false; # access denied
3630 $this->logger
->debug(
3632 ": template inclusion denied for " . $title->getPrefixedDBkey()
3635 list( $text, $title ) = $this->getTemplateDom( $title );
3636 if ( $text !== false ) {
3642 # If the title is valid but undisplayable, make a link to it
3643 if ( !$found && ( $this->ot
['html'] ||
$this->ot
['pre'] ) ) {
3644 $text = "[[:$titleText]]";
3647 } elseif ( $title->isTrans() ) {
3648 # Interwiki transclusion
3649 if ( $this->ot
['html'] && !$forceRawInterwiki ) {
3650 $text = $this->interwikiTransclude( $title, 'render' );
3653 $text = $this->interwikiTransclude( $title, 'raw' );
3654 # Preprocess it like a template
3655 $text = $this->preprocessToDom( $text, self
::PTD_FOR_INCLUSION
);
3661 # Do infinite loop check
3662 # This has to be done after redirect resolution to avoid infinite loops via redirects
3663 if ( !$frame->loopCheck( $title ) ) {
3665 $text = '<span class="error">'
3666 . wfMessage( 'parser-template-loop-warning', $titleText )->inContentLanguage()->text()
3668 $this->addTrackingCategory( 'template-loop-category' );
3669 $this->mOutput
->addWarning( wfMessage( 'template-loop-warning',
3670 wfEscapeWikiText( $titleText ) )->text() );
3671 $this->logger
->debug( __METHOD__
. ": template loop broken at '$titleText'" );
3675 # If we haven't found text to substitute by now, we're done
3676 # Recover the source wikitext and return it
3678 $text = $frame->virtualBracketedImplode( '{{', '|', '}}', $titleWithSpaces, $args );
3679 if ( $profileSection ) {
3680 $this->mProfiler
->scopedProfileOut( $profileSection );
3682 return [ 'object' => $text ];
3685 # Expand DOM-style return values in a child frame
3686 if ( $isChildObj ) {
3687 # Clean up argument array
3688 $newFrame = $frame->newChild( $args, $title );
3691 $text = $newFrame->expand( $text, PPFrame
::RECOVER_ORIG
);
3692 } elseif ( $titleText !== false && $newFrame->isEmpty() ) {
3693 # Expansion is eligible for the empty-frame cache
3694 $text = $newFrame->cachedExpand( $titleText, $text );
3696 # Uncached expansion
3697 $text = $newFrame->expand( $text );
3700 if ( $isLocalObj && $nowiki ) {
3701 $text = $frame->expand( $text, PPFrame
::RECOVER_ORIG
);
3702 $isLocalObj = false;
3705 if ( $profileSection ) {
3706 $this->mProfiler
->scopedProfileOut( $profileSection );
3709 # Replace raw HTML by a placeholder
3711 $text = $this->insertStripItem( $text );
3712 } elseif ( $nowiki && ( $this->ot
['html'] ||
$this->ot
['pre'] ) ) {
3713 # Escape nowiki-style return values
3714 $text = wfEscapeWikiText( $text );
3715 } elseif ( is_string( $text )
3716 && !$piece['lineStart']
3717 && preg_match( '/^(?:{\\||:|;|#|\*)/', $text )
3719 # T2529: if the template begins with a table or block-level
3720 # element, it should be treated as beginning a new line.
3721 # This behavior is somewhat controversial.
3722 $text = "\n" . $text;
3725 if ( is_string( $text ) && !$this->incrementIncludeSize( 'post-expand', strlen( $text ) ) ) {
3726 # Error, oversize inclusion
3727 if ( $titleText !== false ) {
3728 # Make a working, properly escaped link if possible (T25588)
3729 $text = "[[:$titleText]]";
3731 # This will probably not be a working link, but at least it may
3732 # provide some hint of where the problem is
3733 preg_replace( '/^:/', '', $originalTitle );
3734 $text = "[[:$originalTitle]]";
3736 $text .= $this->insertStripItem( '<!-- WARNING: template omitted, '
3737 . 'post-expand include size too large -->' );
3738 $this->limitationWarn( 'post-expand-template-inclusion' );
3741 if ( $isLocalObj ) {
3742 $ret = [ 'object' => $text ];
3744 $ret = [ 'text' => $text ];
3751 * Call a parser function and return an array with text and flags.
3753 * The returned array will always contain a boolean 'found', indicating
3754 * whether the parser function was found or not. It may also contain the
3756 * text: string|object, resulting wikitext or PP DOM object
3757 * isHTML: bool, $text is HTML, armour it against wikitext transformation
3758 * isChildObj: bool, $text is a DOM node needing expansion in a child frame
3759 * isLocalObj: bool, $text is a DOM node needing expansion in the current frame
3760 * nowiki: bool, wiki markup in $text should be escaped
3763 * @param PPFrame $frame The current frame, contains template arguments
3764 * @param string $function Function name
3765 * @param array $args Arguments to the function
3766 * @throws MWException
3769 public function callParserFunction( $frame, $function, array $args = [] ) {
3770 # Case sensitive functions
3771 if ( isset( $this->mFunctionSynonyms
[1][$function] ) ) {
3772 $function = $this->mFunctionSynonyms
[1][$function];
3774 # Case insensitive functions
3775 $function = $this->contLang
->lc( $function );
3776 if ( isset( $this->mFunctionSynonyms
[0][$function] ) ) {
3777 $function = $this->mFunctionSynonyms
[0][$function];
3779 return [ 'found' => false ];
3783 list( $callback, $flags ) = $this->mFunctionHooks
[$function];
3785 // Avoid PHP 7.1 warning from passing $this by reference
3788 $allArgs = [ &$parser ];
3789 if ( $flags & self
::SFH_OBJECT_ARGS
) {
3790 # Convert arguments to PPNodes and collect for appending to $allArgs
3792 foreach ( $args as $k => $v ) {
3793 if ( $v instanceof PPNode ||
$k === 0 ) {
3796 $funcArgs[] = $this->mPreprocessor
->newPartNodeArray( [ $k => $v ] )->item( 0 );
3800 # Add a frame parameter, and pass the arguments as an array
3801 $allArgs[] = $frame;
3802 $allArgs[] = $funcArgs;
3804 # Convert arguments to plain text and append to $allArgs
3805 foreach ( $args as $k => $v ) {
3806 if ( $v instanceof PPNode
) {
3807 $allArgs[] = trim( $frame->expand( $v ) );
3808 } elseif ( is_int( $k ) && $k >= 0 ) {
3809 $allArgs[] = trim( $v );
3811 $allArgs[] = trim( "$k=$v" );
3816 $result = $callback( ...$allArgs );
3818 # The interface for function hooks allows them to return a wikitext
3819 # string or an array containing the string and any flags. This mungs
3820 # things around to match what this method should return.
3821 if ( !is_array( $result ) ) {
3827 if ( isset( $result[0] ) && !isset( $result['text'] ) ) {
3828 $result['text'] = $result[0];
3830 unset( $result[0] );
3837 $preprocessFlags = 0;
3838 if ( isset( $result['noparse'] ) ) {
3839 $noparse = $result['noparse'];
3841 if ( isset( $result['preprocessFlags'] ) ) {
3842 $preprocessFlags = $result['preprocessFlags'];
3846 $result['text'] = $this->preprocessToDom( $result['text'], $preprocessFlags );
3847 $result['isChildObj'] = true;
3854 * Get the semi-parsed DOM representation of a template with a given title,
3855 * and its redirect destination title. Cached.
3857 * @param Title $title
3861 public function getTemplateDom( $title ) {
3862 $cacheTitle = $title;
3863 $titleText = $title->getPrefixedDBkey();
3865 if ( isset( $this->mTplRedirCache
[$titleText] ) ) {
3866 list( $ns, $dbk ) = $this->mTplRedirCache
[$titleText];
3867 $title = Title
::makeTitle( $ns, $dbk );
3868 $titleText = $title->getPrefixedDBkey();
3870 if ( isset( $this->mTplDomCache
[$titleText] ) ) {
3871 return [ $this->mTplDomCache
[$titleText], $title ];
3874 # Cache miss, go to the database
3875 list( $text, $title ) = $this->fetchTemplateAndTitle( $title );
3877 if ( $text === false ) {
3878 $this->mTplDomCache
[$titleText] = false;
3879 return [ false, $title ];
3882 $dom = $this->preprocessToDom( $text, self
::PTD_FOR_INCLUSION
);
3883 $this->mTplDomCache
[$titleText] = $dom;
3885 if ( !$title->equals( $cacheTitle ) ) {
3886 $this->mTplRedirCache
[$cacheTitle->getPrefixedDBkey()] =
3887 [ $title->getNamespace(), $title->getDBkey() ];
3890 return [ $dom, $title ];
3894 * Fetch the current revision of a given title. Note that the revision
3895 * (and even the title) may not exist in the database, so everything
3896 * contributing to the output of the parser should use this method
3897 * where possible, rather than getting the revisions themselves. This
3898 * method also caches its results, so using it benefits performance.
3901 * @param Title $title
3904 public function fetchCurrentRevisionOfTitle( $title ) {
3905 $cacheKey = $title->getPrefixedDBkey();
3906 if ( !$this->currentRevisionCache
) {
3907 $this->currentRevisionCache
= new MapCacheLRU( 100 );
3909 if ( !$this->currentRevisionCache
->has( $cacheKey ) ) {
3910 $this->currentRevisionCache
->set( $cacheKey,
3911 // Defaults to Parser::statelessFetchRevision()
3912 call_user_func( $this->mOptions
->getCurrentRevisionCallback(), $title, $this )
3915 return $this->currentRevisionCache
->get( $cacheKey );
3919 * @param Title $title
3923 public function isCurrentRevisionOfTitleCached( $title ) {
3925 $this->currentRevisionCache
&&
3926 $this->currentRevisionCache
->has( $title->getPrefixedText() )
3931 * Wrapper around Revision::newFromTitle to allow passing additional parameters
3932 * without passing them on to it.
3935 * @param Title $title
3936 * @param Parser|bool $parser
3937 * @return Revision|bool False if missing
3939 public static function statelessFetchRevision( Title
$title, $parser = false ) {
3940 $rev = Revision
::newKnownCurrent( wfGetDB( DB_REPLICA
), $title );
3946 * Fetch the unparsed text of a template and register a reference to it.
3947 * @param Title $title
3948 * @return array ( string or false, Title )
3950 public function fetchTemplateAndTitle( $title ) {
3951 // Defaults to Parser::statelessFetchTemplate()
3952 $templateCb = $this->mOptions
->getTemplateCallback();
3953 $stuff = call_user_func( $templateCb, $title, $this );
3954 $rev = $stuff['revision'] ??
null;
3955 $text = $stuff['text'];
3956 if ( is_string( $stuff['text'] ) ) {
3957 // We use U+007F DELETE to distinguish strip markers from regular text
3958 $text = strtr( $text, "\x7f", "?" );
3960 $finalTitle = $stuff['finalTitle'] ??
$title;
3961 foreach ( ( $stuff['deps'] ??
[] ) as $dep ) {
3962 $this->mOutput
->addTemplate( $dep['title'], $dep['page_id'], $dep['rev_id'] );
3963 if ( $dep['title']->equals( $this->getTitle() ) && $rev instanceof Revision
) {
3964 // Self-transclusion; final result may change based on the new page version
3965 $this->setOutputFlag( 'vary-revision-sha1', 'Self transclusion' );
3966 $this->getOutput()->setRevisionUsedSha1Base36( $rev->getSha1() );
3970 return [ $text, $finalTitle ];
3974 * Fetch the unparsed text of a template and register a reference to it.
3975 * @param Title $title
3976 * @return string|bool
3978 public function fetchTemplate( $title ) {
3979 return $this->fetchTemplateAndTitle( $title )[0];
3983 * Static function to get a template
3984 * Can be overridden via ParserOptions::setTemplateCallback().
3986 * @param Title $title
3987 * @param bool|Parser $parser
3991 public static function statelessFetchTemplate( $title, $parser = false ) {
3992 $text = $skip = false;
3993 $finalTitle = $title;
3997 # Loop to fetch the article, with up to 1 redirect
3998 for ( $i = 0; $i < 2 && is_object( $title ); $i++
) {
3999 # Give extensions a chance to select the revision instead
4000 $id = false; # Assume current
4001 Hooks
::run( 'BeforeParserFetchTemplateAndtitle',
4002 [ $parser, $title, &$skip, &$id ] );
4008 'page_id' => $title->getArticleID(),
4015 $rev = Revision
::newFromId( $id );
4016 } elseif ( $parser ) {
4017 $rev = $parser->fetchCurrentRevisionOfTitle( $title );
4019 $rev = Revision
::newFromTitle( $title );
4021 $rev_id = $rev ?
$rev->getId() : 0;
4022 # If there is no current revision, there is no page
4023 if ( $id === false && !$rev ) {
4024 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
4025 $linkCache->addBadLinkObj( $title );
4030 'page_id' => $title->getArticleID(),
4033 if ( $rev && !$title->equals( $rev->getTitle() ) ) {
4034 # We fetched a rev from a different title; register it too...
4036 'title' => $rev->getTitle(),
4037 'page_id' => $rev->getPage(),
4043 $content = $rev->getContent();
4044 $text = $content ?
$content->getWikitextForTransclusion() : null;
4046 Hooks
::run( 'ParserFetchTemplate',
4047 [ $parser, $title, $rev, &$text, &$deps ] );
4049 if ( $text === false ||
$text === null ) {
4053 } elseif ( $title->getNamespace() == NS_MEDIAWIKI
) {
4054 $message = wfMessage( MediaWikiServices
::getInstance()->getContentLanguage()->
4055 lcfirst( $title->getText() ) )->inContentLanguage();
4056 if ( !$message->exists() ) {
4060 $content = $message->content();
4061 $text = $message->plain();
4069 $finalTitle = $title;
4070 $title = $content->getRedirectTarget();
4075 'finalTitle' => $finalTitle,
4081 * Fetch a file and its title and register a reference to it.
4082 * If 'broken' is a key in $options then the file will appear as a broken thumbnail.
4083 * @param Title $title
4084 * @param array $options Array of options to RepoGroup::findFile
4085 * @return array ( File or false, Title of file )
4087 public function fetchFileAndTitle( $title, $options = [] ) {
4088 $file = $this->fetchFileNoRegister( $title, $options );
4090 $time = $file ?
$file->getTimestamp() : false;
4091 $sha1 = $file ?
$file->getSha1() : false;
4092 # Register the file as a dependency...
4093 $this->mOutput
->addImage( $title->getDBkey(), $time, $sha1 );
4094 if ( $file && !$title->equals( $file->getTitle() ) ) {
4095 # Update fetched file title
4096 $title = $file->getTitle();
4097 $this->mOutput
->addImage( $title->getDBkey(), $time, $sha1 );
4099 return [ $file, $title ];
4103 * Helper function for fetchFileAndTitle.
4105 * Also useful if you need to fetch a file but not use it yet,
4106 * for example to get the file's handler.
4108 * @param Title $title
4109 * @param array $options Array of options to RepoGroup::findFile
4112 protected function fetchFileNoRegister( $title, $options = [] ) {
4113 if ( isset( $options['broken'] ) ) {
4114 $file = false; // broken thumbnail forced by hook
4115 } elseif ( isset( $options['sha1'] ) ) { // get by (sha1,timestamp)
4116 $file = RepoGroup
::singleton()->findFileFromKey( $options['sha1'], $options );
4117 } else { // get by (name,timestamp)
4118 $file = MediaWikiServices
::getInstance()->getRepoGroup()->findFile( $title, $options );
4124 * Transclude an interwiki link.
4126 * @param Title $title
4127 * @param string $action Usually one of (raw, render)
4131 public function interwikiTransclude( $title, $action ) {
4132 if ( !$this->svcOptions
->get( 'EnableScaryTranscluding' ) ) {
4133 return wfMessage( 'scarytranscludedisabled' )->inContentLanguage()->text();
4136 $url = $title->getFullURL( [ 'action' => $action ] );
4137 if ( strlen( $url ) > 1024 ) {
4138 return wfMessage( 'scarytranscludetoolong' )->inContentLanguage()->text();
4141 $wikiId = $title->getTransWikiID(); // remote wiki ID or false
4143 $fname = __METHOD__
;
4144 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
4146 $data = $cache->getWithSetCallback(
4147 $cache->makeGlobalKey(
4148 'interwiki-transclude',
4149 ( $wikiId !== false ) ?
$wikiId : 'external',
4152 $this->svcOptions
->get( 'TranscludeCacheExpiry' ),
4153 function ( $oldValue, &$ttl ) use ( $url, $fname, $cache ) {
4154 $req = MWHttpRequest
::factory( $url, [], $fname );
4156 $status = $req->execute(); // Status object
4157 if ( !$status->isOK() ) {
4158 $ttl = $cache::TTL_UNCACHEABLE
;
4159 } elseif ( $req->getResponseHeader( 'X-Database-Lagged' ) !== null ) {
4160 $ttl = min( $cache::TTL_LAGGED
, $ttl );
4164 'text' => $status->isOK() ?
$req->getContent() : null,
4165 'code' => $req->getStatus()
4169 'checkKeys' => ( $wikiId !== false )
4170 ?
[ $cache->makeGlobalKey( 'interwiki-page', $wikiId, $title->getDBkey() ) ]
4172 'pcGroup' => 'interwiki-transclude:5',
4173 'pcTTL' => $cache::TTL_PROC_LONG
4177 if ( is_string( $data['text'] ) ) {
4178 $text = $data['text'];
4179 } elseif ( $data['code'] != 200 ) {
4180 // Though we failed to fetch the content, this status is useless.
4181 $text = wfMessage( 'scarytranscludefailed-httpstatus' )
4182 ->params( $url, $data['code'] )->inContentLanguage()->text();
4184 $text = wfMessage( 'scarytranscludefailed', $url )->inContentLanguage()->text();
4191 * Triple brace replacement -- used for template arguments
4194 * @param array $piece
4195 * @param PPFrame $frame
4199 public function argSubstitution( $piece, $frame ) {
4201 $parts = $piece['parts'];
4202 $nameWithSpaces = $frame->expand( $piece['title'] );
4203 $argName = trim( $nameWithSpaces );
4205 $text = $frame->getArgument( $argName );
4206 if ( $text === false && $parts->getLength() > 0
4207 && ( $this->ot
['html']
4209 ||
( $this->ot
['wiki'] && $frame->isTemplate() )
4212 # No match in frame, use the supplied default
4213 $object = $parts->item( 0 )->getChildren();
4215 if ( !$this->incrementIncludeSize( 'arg', strlen( $text ) ) ) {
4216 $error = '<!-- WARNING: argument omitted, expansion size too large -->';
4217 $this->limitationWarn( 'post-expand-template-argument' );
4220 if ( $text === false && $object === false ) {
4222 $object = $frame->virtualBracketedImplode( '{{{', '|', '}}}', $nameWithSpaces, $parts );
4224 if ( $error !== false ) {
4227 if ( $object !== false ) {
4228 $ret = [ 'object' => $object ];
4230 $ret = [ 'text' => $text ];
4237 * Return the text to be used for a given extension tag.
4238 * This is the ghost of strip().
4240 * @param array $params Associative array of parameters:
4241 * name PPNode for the tag name
4242 * attr PPNode for unparsed text where tag attributes are thought to be
4243 * attributes Optional associative array of parsed attributes
4244 * inner Contents of extension element
4245 * noClose Original text did not have a close tag
4246 * @param PPFrame $frame
4248 * @throws MWException
4252 public function extensionSubstitution( $params, $frame ) {
4253 static $errorStr = '<span class="error">';
4254 static $errorLen = 20;
4256 $name = $frame->expand( $params['name'] );
4257 if ( substr( $name, 0, $errorLen ) === $errorStr ) {
4258 // Probably expansion depth or node count exceeded. Just punt the
4263 $attrText = !isset( $params['attr'] ) ?
null : $frame->expand( $params['attr'] );
4264 if ( substr( $attrText, 0, $errorLen ) === $errorStr ) {
4269 // We can't safely check if the expansion for $content resulted in an
4270 // error, because the content could happen to be the error string
4272 $content = !isset( $params['inner'] ) ?
null : $frame->expand( $params['inner'] );
4274 $marker = self
::MARKER_PREFIX
. "-$name-"
4275 . sprintf( '%08X', $this->mMarkerIndex++
) . self
::MARKER_SUFFIX
;
4277 $isFunctionTag = isset( $this->mFunctionTagHooks
[strtolower( $name )] ) &&
4278 ( $this->ot
['html'] ||
$this->ot
['pre'] );
4279 if ( $isFunctionTag ) {
4280 $markerType = 'none';
4282 $markerType = 'general';
4284 if ( $this->ot
['html'] ||
$isFunctionTag ) {
4285 $name = strtolower( $name );
4286 $attributes = Sanitizer
::decodeTagAttributes( $attrText );
4287 if ( isset( $params['attributes'] ) ) {
4288 $attributes +
= $params['attributes'];
4291 if ( isset( $this->mTagHooks
[$name] ) ) {
4292 $output = call_user_func_array( $this->mTagHooks
[$name],
4293 [ $content, $attributes, $this, $frame ] );
4294 } elseif ( isset( $this->mFunctionTagHooks
[$name] ) ) {
4295 list( $callback, ) = $this->mFunctionTagHooks
[$name];
4297 // Avoid PHP 7.1 warning from passing $this by reference
4299 $output = call_user_func_array( $callback, [ &$parser, $frame, $content, $attributes ] );
4301 $output = '<span class="error">Invalid tag extension name: ' .
4302 htmlspecialchars( $name ) . '</span>';
4305 if ( is_array( $output ) ) {
4308 $output = $flags[0];
4309 if ( isset( $flags['markerType'] ) ) {
4310 $markerType = $flags['markerType'];
4314 if ( is_null( $attrText ) ) {
4317 if ( isset( $params['attributes'] ) ) {
4318 foreach ( $params['attributes'] as $attrName => $attrValue ) {
4319 $attrText .= ' ' . htmlspecialchars( $attrName ) . '="' .
4320 htmlspecialchars( $attrValue ) . '"';
4323 if ( $content === null ) {
4324 $output = "<$name$attrText/>";
4326 $close = is_null( $params['close'] ) ?
'' : $frame->expand( $params['close'] );
4327 if ( substr( $close, 0, $errorLen ) === $errorStr ) {
4331 $output = "<$name$attrText>$content$close";
4335 if ( $markerType === 'none' ) {
4337 } elseif ( $markerType === 'nowiki' ) {
4338 $this->mStripState
->addNoWiki( $marker, $output );
4339 } elseif ( $markerType === 'general' ) {
4340 $this->mStripState
->addGeneral( $marker, $output );
4342 throw new MWException( __METHOD__
. ': invalid marker type' );
4348 * Increment an include size counter
4350 * @param string $type The type of expansion
4351 * @param int $size The size of the text
4352 * @return bool False if this inclusion would take it over the maximum, true otherwise
4354 public function incrementIncludeSize( $type, $size ) {
4355 if ( $this->mIncludeSizes
[$type] +
$size > $this->mOptions
->getMaxIncludeSize() ) {
4358 $this->mIncludeSizes
[$type] +
= $size;
4364 * Increment the expensive function count
4366 * @return bool False if the limit has been exceeded
4368 public function incrementExpensiveFunctionCount() {
4369 $this->mExpensiveFunctionCount++
;
4370 return $this->mExpensiveFunctionCount
<= $this->mOptions
->getExpensiveParserFunctionLimit();
4374 * Strip double-underscore items like __NOGALLERY__ and __NOTOC__
4375 * Fills $this->mDoubleUnderscores, returns the modified text
4377 * @param string $text
4379 * @deprecated since 1.34; should not be used outside parser class.
4381 public function doDoubleUnderscore( $text ) {
4382 wfDeprecated( __METHOD__
, '1.34' );
4383 return $this->handleDoubleUnderscore( $text );
4387 * Strip double-underscore items like __NOGALLERY__ and __NOTOC__
4388 * Fills $this->mDoubleUnderscores, returns the modified text
4390 * @param string $text
4393 private function handleDoubleUnderscore( $text ) {
4394 # The position of __TOC__ needs to be recorded
4395 $mw = $this->magicWordFactory
->get( 'toc' );
4396 if ( $mw->match( $text ) ) {
4397 $this->mShowToc
= true;
4398 $this->mForceTocPosition
= true;
4400 # Set a placeholder. At the end we'll fill it in with the TOC.
4401 $text = $mw->replace( '<!--MWTOC\'"-->', $text, 1 );
4403 # Only keep the first one.
4404 $text = $mw->replace( '', $text );
4407 # Now match and remove the rest of them
4408 $mwa = $this->magicWordFactory
->getDoubleUnderscoreArray();
4409 $this->mDoubleUnderscores
= $mwa->matchAndRemove( $text );
4411 if ( isset( $this->mDoubleUnderscores
['nogallery'] ) ) {
4412 $this->mOutput
->mNoGallery
= true;
4414 if ( isset( $this->mDoubleUnderscores
['notoc'] ) && !$this->mForceTocPosition
) {
4415 $this->mShowToc
= false;
4417 if ( isset( $this->mDoubleUnderscores
['hiddencat'] )
4418 && $this->mTitle
->getNamespace() == NS_CATEGORY
4420 $this->addTrackingCategory( 'hidden-category-category' );
4422 # (T10068) Allow control over whether robots index a page.
4423 # __INDEX__ always overrides __NOINDEX__, see T16899
4424 if ( isset( $this->mDoubleUnderscores
['noindex'] ) && $this->mTitle
->canUseNoindex() ) {
4425 $this->mOutput
->setIndexPolicy( 'noindex' );
4426 $this->addTrackingCategory( 'noindex-category' );
4428 if ( isset( $this->mDoubleUnderscores
['index'] ) && $this->mTitle
->canUseNoindex() ) {
4429 $this->mOutput
->setIndexPolicy( 'index' );
4430 $this->addTrackingCategory( 'index-category' );
4433 # Cache all double underscores in the database
4434 foreach ( $this->mDoubleUnderscores
as $key => $val ) {
4435 $this->mOutput
->setProperty( $key, '' );
4442 * @see ParserOutput::addTrackingCategory()
4443 * @param string $msg Message key
4444 * @return bool Whether the addition was successful
4446 public function addTrackingCategory( $msg ) {
4447 return $this->mOutput
->addTrackingCategory( $msg, $this->mTitle
);
4451 * This function accomplishes several tasks:
4452 * 1) Auto-number headings if that option is enabled
4453 * 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
4454 * 3) Add a Table of contents on the top for users who have enabled the option
4455 * 4) Auto-anchor headings
4457 * It loops through all headlines, collects the necessary data, then splits up the
4458 * string and re-inserts the newly formatted headlines.
4460 * @param string $text
4461 * @param string $origText Original, untouched wikitext
4462 * @param bool $isMain
4463 * @return mixed|string
4465 * @deprecated since 1.34; should not be used outside parser class.
4467 public function formatHeadings( $text, $origText, $isMain = true ) {
4468 wfDeprecated( __METHOD__
, '1.34' );
4469 return $this->finalizeHeadings( $text, $origText, $isMain );
4473 * This function accomplishes several tasks:
4474 * 1) Auto-number headings if that option is enabled
4475 * 2) Add an [edit] link to sections for users who have enabled the option and can edit the page
4476 * 3) Add a Table of contents on the top for users who have enabled the option
4477 * 4) Auto-anchor headings
4479 * It loops through all headlines, collects the necessary data, then splits up the
4480 * string and re-inserts the newly formatted headlines.
4482 * @param string $text
4483 * @param string $origText Original, untouched wikitext
4484 * @param bool $isMain
4485 * @return mixed|string
4487 private function finalizeHeadings( $text, $origText, $isMain = true ) {
4488 # Inhibit editsection links if requested in the page
4489 if ( isset( $this->mDoubleUnderscores
['noeditsection'] ) ) {
4490 $maybeShowEditLink = false;
4492 $maybeShowEditLink = true; /* Actual presence will depend on post-cache transforms */
4495 # Get all headlines for numbering them and adding funky stuff like [edit]
4496 # links - this is for later, but we need the number of headlines right now
4497 # NOTE: white space in headings have been trimmed in handleHeadings. They shouldn't
4498 # be trimmed here since whitespace in HTML headings is significant.
4500 $numMatches = preg_match_all(
4501 '/<H(?P<level>[1-6])(?P<attrib>.*?>)(?P<header>[\s\S]*?)<\/H[1-6] *>/i',
4506 # if there are fewer than 4 headlines in the article, do not show TOC
4507 # unless it's been explicitly enabled.
4508 $enoughToc = $this->mShowToc
&&
4509 ( ( $numMatches >= 4 ) ||
$this->mForceTocPosition
);
4511 # Allow user to stipulate that a page should have a "new section"
4512 # link added via __NEWSECTIONLINK__
4513 if ( isset( $this->mDoubleUnderscores
['newsectionlink'] ) ) {
4514 $this->mOutput
->setNewSection( true );
4517 # Allow user to remove the "new section"
4518 # link via __NONEWSECTIONLINK__
4519 if ( isset( $this->mDoubleUnderscores
['nonewsectionlink'] ) ) {
4520 $this->mOutput
->hideNewSection( true );
4523 # if the string __FORCETOC__ (not case-sensitive) occurs in the HTML,
4524 # override above conditions and always show TOC above first header
4525 if ( isset( $this->mDoubleUnderscores
['forcetoc'] ) ) {
4526 $this->mShowToc
= true;
4534 # Ugh .. the TOC should have neat indentation levels which can be
4535 # passed to the skin functions. These are determined here
4539 $sublevelCount = [];
4545 $markerRegex = self
::MARKER_PREFIX
. "-h-(\d+)-" . self
::MARKER_SUFFIX
;
4546 $baseTitleText = $this->mTitle
->getPrefixedDBkey();
4547 $oldType = $this->mOutputType
;
4548 $this->setOutputType( self
::OT_WIKI
);
4549 $frame = $this->getPreprocessor()->newFrame();
4550 $root = $this->preprocessToDom( $origText );
4551 $node = $root->getFirstChild();
4556 $headlines = $numMatches !== false ?
$matches[3] : [];
4558 $maxTocLevel = $this->svcOptions
->get( 'MaxTocLevel' );
4559 foreach ( $headlines as $headline ) {
4560 $isTemplate = false;
4562 $sectionIndex = false;
4564 $markerMatches = [];
4565 if ( preg_match( "/^$markerRegex/", $headline, $markerMatches ) ) {
4566 $serial = $markerMatches[1];
4567 list( $titleText, $sectionIndex ) = $this->mHeadings
[$serial];
4568 $isTemplate = ( $titleText != $baseTitleText );
4569 $headline = preg_replace( "/^$markerRegex\\s*/", "", $headline );
4573 $prevlevel = $level;
4575 $level = $matches[1][$headlineCount];
4577 if ( $level > $prevlevel ) {
4578 # Increase TOC level
4580 $sublevelCount[$toclevel] = 0;
4581 if ( $toclevel < $maxTocLevel ) {
4582 $prevtoclevel = $toclevel;
4583 $toc .= Linker
::tocIndent();
4586 } elseif ( $level < $prevlevel && $toclevel > 1 ) {
4587 # Decrease TOC level, find level to jump to
4589 for ( $i = $toclevel; $i > 0; $i-- ) {
4590 if ( $levelCount[$i] == $level ) {
4591 # Found last matching level
4594 } elseif ( $levelCount[$i] < $level ) {
4595 # Found first matching level below current level
4603 if ( $toclevel < $maxTocLevel ) {
4604 if ( $prevtoclevel < $maxTocLevel ) {
4605 # Unindent only if the previous toc level was shown :p
4606 $toc .= Linker
::tocUnindent( $prevtoclevel - $toclevel );
4607 $prevtoclevel = $toclevel;
4609 $toc .= Linker
::tocLineEnd();
4613 # No change in level, end TOC line
4614 if ( $toclevel < $maxTocLevel ) {
4615 $toc .= Linker
::tocLineEnd();
4619 $levelCount[$toclevel] = $level;
4621 # count number of headlines for each level
4622 $sublevelCount[$toclevel]++
;
4624 for ( $i = 1; $i <= $toclevel; $i++
) {
4625 if ( !empty( $sublevelCount[$i] ) ) {
4629 $numbering .= $this->getTargetLanguage()->formatNum( $sublevelCount[$i] );
4634 # The safe header is a version of the header text safe to use for links
4636 # Remove link placeholders by the link text.
4637 # <!--LINK number-->
4639 # link text with suffix
4640 # Do this before unstrip since link text can contain strip markers
4641 $safeHeadline = $this->replaceLinkHoldersTextPrivate( $headline );
4643 # Avoid insertion of weird stuff like <math> by expanding the relevant sections
4644 $safeHeadline = $this->mStripState
->unstripBoth( $safeHeadline );
4646 # Remove any <style> or <script> tags (T198618)
4647 $safeHeadline = preg_replace(
4648 '#<(style|script)(?: [^>]*[^>/])?>.*?</\1>#is',
4653 # Strip out HTML (first regex removes any tag not allowed)
4655 # * <sup> and <sub> (T10393)
4659 # * <span dir="rtl"> and <span dir="ltr"> (T37167)
4660 # * <s> and <strike> (T35715)
4661 # We strip any parameter from accepted tags (second regex), except dir="rtl|ltr" from <span>,
4662 # to allow setting directionality in toc items.
4663 $tocline = preg_replace(
4665 '#<(?!/?(span|sup|sub|bdi|i|b|s|strike)(?: [^>]*)?>).*?>#',
4666 '#<(/?(?:span(?: dir="(?:rtl|ltr)")?|sup|sub|bdi|i|b|s|strike))(?: .*?)?>#'
4672 # Strip '<span></span>', which is the result from the above if
4673 # <span id="foo"></span> is used to produce an additional anchor
4675 $tocline = str_replace( '<span></span>', '', $tocline );
4677 $tocline = trim( $tocline );
4679 # For the anchor, strip out HTML-y stuff period
4680 $safeHeadline = preg_replace( '/<.*?>/', '', $safeHeadline );
4681 $safeHeadline = Sanitizer
::normalizeSectionNameWhitespace( $safeHeadline );
4683 # Save headline for section edit hint before it's escaped
4684 $headlineHint = $safeHeadline;
4686 # Decode HTML entities
4687 $safeHeadline = Sanitizer
::decodeCharReferences( $safeHeadline );
4689 $safeHeadline = self
::normalizeSectionName( $safeHeadline );
4691 $fallbackHeadline = Sanitizer
::escapeIdForAttribute( $safeHeadline, Sanitizer
::ID_FALLBACK
);
4692 $linkAnchor = Sanitizer
::escapeIdForLink( $safeHeadline );
4693 $safeHeadline = Sanitizer
::escapeIdForAttribute( $safeHeadline, Sanitizer
::ID_PRIMARY
);
4694 if ( $fallbackHeadline === $safeHeadline ) {
4695 # No reason to have both (in fact, we can't)
4696 $fallbackHeadline = false;
4699 # HTML IDs must be case-insensitively unique for IE compatibility (T12721).
4700 # @todo FIXME: We may be changing them depending on the current locale.
4701 $arrayKey = strtolower( $safeHeadline );
4702 if ( $fallbackHeadline === false ) {
4703 $fallbackArrayKey = false;
4705 $fallbackArrayKey = strtolower( $fallbackHeadline );
4708 # Create the anchor for linking from the TOC to the section
4709 $anchor = $safeHeadline;
4710 $fallbackAnchor = $fallbackHeadline;
4711 if ( isset( $refers[$arrayKey] ) ) {
4712 // phpcs:ignore Generic.Formatting.DisallowMultipleStatements
4713 for ( $i = 2; isset( $refers["${arrayKey}_$i"] ); ++
$i );
4715 $linkAnchor .= "_$i";
4716 $refers["${arrayKey}_$i"] = true;
4718 $refers[$arrayKey] = true;
4720 if ( $fallbackHeadline !== false && isset( $refers[$fallbackArrayKey] ) ) {
4721 // phpcs:ignore Generic.Formatting.DisallowMultipleStatements
4722 for ( $i = 2; isset( $refers["${fallbackArrayKey}_$i"] ); ++
$i );
4723 $fallbackAnchor .= "_$i";
4724 $refers["${fallbackArrayKey}_$i"] = true;
4726 $refers[$fallbackArrayKey] = true;
4729 # Don't number the heading if it is the only one (looks silly)
4730 if ( count( $matches[3] ) > 1 && $this->mOptions
->getNumberHeadings() ) {
4731 # the two are different if the line contains a link
4732 $headline = Html
::element(
4734 [ 'class' => 'mw-headline-number' ],
4736 ) . ' ' . $headline;
4739 if ( $enoughToc && ( !isset( $maxTocLevel ) ||
$toclevel < $maxTocLevel ) ) {
4740 $toc .= Linker
::tocLine( $linkAnchor, $tocline,
4741 $numbering, $toclevel, ( $isTemplate ?
false : $sectionIndex ) );
4744 # Add the section to the section tree
4745 # Find the DOM node for this header
4746 $noOffset = ( $isTemplate ||
$sectionIndex === false );
4747 while ( $node && !$noOffset ) {
4748 if ( $node->getName() === 'h' ) {
4749 $bits = $node->splitHeading();
4750 if ( $bits['i'] == $sectionIndex ) {
4754 $byteOffset +
= mb_strlen( $this->mStripState
->unstripBoth(
4755 $frame->expand( $node, PPFrame
::RECOVER_ORIG
) ) );
4756 $node = $node->getNextSibling();
4759 'toclevel' => $toclevel,
4762 'number' => $numbering,
4763 'index' => ( $isTemplate ?
'T-' : '' ) . $sectionIndex,
4764 'fromtitle' => $titleText,
4765 'byteoffset' => ( $noOffset ?
null : $byteOffset ),
4766 'anchor' => $anchor,
4769 # give headline the correct <h#> tag
4770 if ( $maybeShowEditLink && $sectionIndex !== false ) {
4771 // Output edit section links as markers with styles that can be customized by skins
4772 if ( $isTemplate ) {
4773 # Put a T flag in the section identifier, to indicate to extractSections()
4774 # that sections inside <includeonly> should be counted.
4775 $editsectionPage = $titleText;
4776 $editsectionSection = "T-$sectionIndex";
4777 $editsectionContent = null;
4779 $editsectionPage = $this->mTitle
->getPrefixedText();
4780 $editsectionSection = $sectionIndex;
4781 $editsectionContent = $headlineHint;
4783 // We use a bit of pesudo-xml for editsection markers. The
4784 // language converter is run later on. Using a UNIQ style marker
4785 // leads to the converter screwing up the tokens when it
4786 // converts stuff. And trying to insert strip tags fails too. At
4787 // this point all real inputted tags have already been escaped,
4788 // so we don't have to worry about a user trying to input one of
4789 // these markers directly. We use a page and section attribute
4790 // to stop the language converter from converting these
4791 // important bits of data, but put the headline hint inside a
4792 // content block because the language converter is supposed to
4793 // be able to convert that piece of data.
4794 // Gets replaced with html in ParserOutput::getText
4795 $editlink = '<mw:editsection page="' . htmlspecialchars( $editsectionPage );
4796 $editlink .= '" section="' . htmlspecialchars( $editsectionSection ) . '"';
4797 if ( $editsectionContent !== null ) {
4798 $editlink .= '>' . $editsectionContent . '</mw:editsection>';
4805 $head[$headlineCount] = Linker
::makeHeadline( $level,
4806 $matches['attrib'][$headlineCount], $anchor, $headline,
4807 $editlink, $fallbackAnchor );
4812 $this->setOutputType( $oldType );
4814 # Never ever show TOC if no headers
4815 if ( $numVisible < 1 ) {
4820 if ( $prevtoclevel > 0 && $prevtoclevel < $maxTocLevel ) {
4821 $toc .= Linker
::tocUnindent( $prevtoclevel - 1 );
4823 $toc = Linker
::tocList( $toc, $this->mOptions
->getUserLangObj() );
4824 $this->mOutput
->setTOCHTML( $toc );
4825 $toc = self
::TOC_START
. $toc . self
::TOC_END
;
4829 $this->mOutput
->setSections( $tocraw );
4832 # split up and insert constructed headlines
4833 $blocks = preg_split( '/<H[1-6].*?>[\s\S]*?<\/H[1-6]>/i', $text );
4836 // build an array of document sections
4838 foreach ( $blocks as $block ) {
4839 // $head is zero-based, sections aren't.
4840 if ( empty( $head[$i - 1] ) ) {
4841 $sections[$i] = $block;
4843 $sections[$i] = $head[$i - 1] . $block;
4847 * Send a hook, one per section.
4848 * The idea here is to be able to make section-level DIVs, but to do so in a
4849 * lower-impact, more correct way than r50769
4852 * $section : the section number
4853 * &$sectionContent : ref to the content of the section
4854 * $maybeShowEditLinks : boolean describing whether this section has an edit link
4856 Hooks
::run( 'ParserSectionCreate', [ $this, $i, &$sections[$i], $maybeShowEditLink ] );
4861 if ( $enoughToc && $isMain && !$this->mForceTocPosition
) {
4862 // append the TOC at the beginning
4863 // Top anchor now in skin
4864 $sections[0] .= $toc . "\n";
4867 $full .= implode( '', $sections );
4869 if ( $this->mForceTocPosition
) {
4870 return str_replace( '<!--MWTOC\'"-->', $toc, $full );
4877 * Transform wiki markup when saving a page by doing "\r\n" -> "\n"
4878 * conversion, substituting signatures, {{subst:}} templates, etc.
4880 * @param string $text The text to transform
4881 * @param Title $title The Title object for the current article
4882 * @param User $user The User object describing the current user
4883 * @param ParserOptions $options Parsing options
4884 * @param bool $clearState Whether to clear the parser state first
4885 * @return string The altered wiki markup
4887 public function preSaveTransform( $text, Title
$title, User
$user,
4888 ParserOptions
$options, $clearState = true
4890 if ( $clearState ) {
4891 $magicScopeVariable = $this->lock();
4893 $this->startParse( $title, $options, self
::OT_WIKI
, $clearState );
4894 $this->setUser( $user );
4896 // Strip U+0000 NULL (T159174)
4897 $text = str_replace( "\000", '', $text );
4899 // We still normalize line endings for backwards-compatibility
4900 // with other code that just calls PST, but this should already
4901 // be handled in TextContent subclasses
4902 $text = TextContent
::normalizeLineEndings( $text );
4904 if ( $options->getPreSaveTransform() ) {
4905 $text = $this->pstPass2( $text, $user );
4907 $text = $this->mStripState
->unstripBoth( $text );
4909 $this->setUser( null ); # Reset
4915 * Pre-save transform helper function
4917 * @param string $text
4922 private function pstPass2( $text, $user ) {
4923 # Note: This is the timestamp saved as hardcoded wikitext to the database, we use
4924 # $this->contLang here in order to give everyone the same signature and use the default one
4925 # rather than the one selected in each user's preferences. (see also T14815)
4926 $ts = $this->mOptions
->getTimestamp();
4927 $timestamp = MWTimestamp
::getLocalInstance( $ts );
4928 $ts = $timestamp->format( 'YmdHis' );
4929 $tzMsg = $timestamp->getTimezoneMessage()->inContentLanguage()->text();
4931 $d = $this->contLang
->timeanddate( $ts, false, false ) . " ($tzMsg)";
4933 # Variable replacement
4934 # Because mOutputType is OT_WIKI, this will only process {{subst:xxx}} type tags
4935 $text = $this->replaceVariables( $text );
4937 # This works almost by chance, as the replaceVariables are done before the getUserSig(),
4938 # which may corrupt this parser instance via its wfMessage()->text() call-
4941 if ( strpos( $text, '~~~' ) !== false ) {
4942 $sigText = $this->getUserSig( $user );
4943 $text = strtr( $text, [
4945 '~~~~' => "$sigText $d",
4948 # The main two signature forms used above are time-sensitive
4949 $this->setOutputFlag( 'user-signature', 'User signature detected' );
4952 # Context links ("pipe tricks"): [[|name]] and [[name (context)|]]
4953 $tc = '[' . Title
::legalChars() . ']';
4954 $nc = '[ _0-9A-Za-z\x80-\xff-]'; # Namespaces can use non-ascii!
4956 // [[ns:page (context)|]]
4957 $p1 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\))\\|]]/";
4958 // [[ns:page(context)|]] (double-width brackets, added in r40257)
4959 $p4 = "/\[\[(:?$nc+:|:|)($tc+?)( ?($tc+))\\|]]/";
4960 // [[ns:page (context), context|]] (using either single or double-width comma)
4961 $p3 = "/\[\[(:?$nc+:|:|)($tc+?)( ?\\($tc+\\)|)((?:, |,)$tc+|)\\|]]/";
4962 // [[|page]] (reverse pipe trick: add context from page title)
4963 $p2 = "/\[\[\\|($tc+)]]/";
4965 # try $p1 first, to turn "[[A, B (C)|]]" into "[[A, B (C)|A, B]]"
4966 $text = preg_replace( $p1, '[[\\1\\2\\3|\\2]]', $text );
4967 $text = preg_replace( $p4, '[[\\1\\2\\3|\\2]]', $text );
4968 $text = preg_replace( $p3, '[[\\1\\2\\3\\4|\\2]]', $text );
4970 $t = $this->mTitle
->getText();
4972 if ( preg_match( "/^($nc+:|)$tc+?( \\($tc+\\))$/", $t, $m ) ) {
4973 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4974 } elseif ( preg_match( "/^($nc+:|)$tc+?(, $tc+|)$/", $t, $m ) && "$m[1]$m[2]" != '' ) {
4975 $text = preg_replace( $p2, "[[$m[1]\\1$m[2]|\\1]]", $text );
4977 # if there's no context, don't bother duplicating the title
4978 $text = preg_replace( $p2, '[[\\1]]', $text );
4985 * Fetch the user's signature text, if any, and normalize to
4986 * validated, ready-to-insert wikitext.
4987 * If you have pre-fetched the nickname or the fancySig option, you can
4988 * specify them here to save a database query.
4989 * Do not reuse this parser instance after calling getUserSig(),
4990 * as it may have changed.
4992 * @param User &$user
4993 * @param string|bool $nickname Nickname to use or false to use user's default nickname
4994 * @param bool|null $fancySig whether the nicknname is the complete signature
4995 * or null to use default value
4998 public function getUserSig( &$user, $nickname = false, $fancySig = null ) {
4999 $username = $user->getName();
5001 # If not given, retrieve from the user object.
5002 if ( $nickname === false ) {
5003 $nickname = $user->getOption( 'nickname' );
5006 if ( is_null( $fancySig ) ) {
5007 $fancySig = $user->getBoolOption( 'fancysig' );
5010 $nickname = $nickname == null ?
$username : $nickname;
5012 if ( mb_strlen( $nickname ) > $this->svcOptions
->get( 'MaxSigChars' ) ) {
5013 $nickname = $username;
5014 $this->logger
->debug( __METHOD__
. ": $username has overlong signature." );
5015 } elseif ( $fancySig !== false ) {
5016 # Sig. might contain markup; validate this
5017 if ( $this->validateSig( $nickname ) !== false ) {
5018 # Validated; clean up (if needed) and return it
5019 return $this->cleanSig( $nickname, true );
5021 # Failed to validate; fall back to the default
5022 $nickname = $username;
5023 $this->logger
->debug( __METHOD__
. ": $username has bad XML tags in signature." );
5027 # Make sure nickname doesnt get a sig in a sig
5028 $nickname = self
::cleanSigInSig( $nickname );
5030 # If we're still here, make it a link to the user page
5031 $userText = wfEscapeWikiText( $username );
5032 $nickText = wfEscapeWikiText( $nickname );
5033 $msgName = $user->isAnon() ?
'signature-anon' : 'signature';
5035 return wfMessage( $msgName, $userText, $nickText )->inContentLanguage()
5036 ->title( $this->getTitle() )->text();
5040 * Check that the user's signature contains no bad XML
5042 * @param string $text
5043 * @return string|bool An expanded string, or false if invalid.
5045 public function validateSig( $text ) {
5046 return Xml
::isWellFormedXmlFragment( $text ) ?
$text : false;
5050 * Clean up signature text
5052 * 1) Strip 3, 4 or 5 tildes out of signatures @see cleanSigInSig
5053 * 2) Substitute all transclusions
5055 * @param string $text
5056 * @param bool $parsing Whether we're cleaning (preferences save) or parsing
5057 * @return string Signature text
5059 public function cleanSig( $text, $parsing = false ) {
5062 $magicScopeVariable = $this->lock();
5063 $this->startParse( $wgTitle, new ParserOptions
, self
::OT_PREPROCESS
, true );
5066 # Option to disable this feature
5067 if ( !$this->mOptions
->getCleanSignatures() ) {
5071 # @todo FIXME: Regex doesn't respect extension tags or nowiki
5072 # => Move this logic to braceSubstitution()
5073 $substWord = $this->magicWordFactory
->get( 'subst' );
5074 $substRegex = '/\{\{(?!(?:' . $substWord->getBaseRegex() . '))/x' . $substWord->getRegexCase();
5075 $substText = '{{' . $substWord->getSynonym( 0 );
5077 $text = preg_replace( $substRegex, $substText, $text );
5078 $text = self
::cleanSigInSig( $text );
5079 $dom = $this->preprocessToDom( $text );
5080 $frame = $this->getPreprocessor()->newFrame();
5081 $text = $frame->expand( $dom );
5084 $text = $this->mStripState
->unstripBoth( $text );
5091 * Strip 3, 4 or 5 tildes out of signatures.
5093 * @param string $text
5094 * @return string Signature text with /~{3,5}/ removed
5096 public static function cleanSigInSig( $text ) {
5097 $text = preg_replace( '/~{3,5}/', '', $text );
5102 * Set up some variables which are usually set up in parse()
5103 * so that an external function can call some class members with confidence
5105 * @param Title|null $title
5106 * @param ParserOptions $options
5107 * @param int $outputType
5108 * @param bool $clearState
5109 * @param int|null $revId
5111 public function startExternalParse( Title
$title = null, ParserOptions
$options,
5112 $outputType, $clearState = true, $revId = null
5114 $this->startParse( $title, $options, $outputType, $clearState );
5115 if ( $revId !== null ) {
5116 $this->mRevisionId
= $revId;
5121 * @param Title|null $title
5122 * @param ParserOptions $options
5123 * @param int $outputType
5124 * @param bool $clearState
5126 private function startParse( Title
$title = null, ParserOptions
$options,
5127 $outputType, $clearState = true
5129 $this->setTitle( $title );
5130 $this->mOptions
= $options;
5131 $this->setOutputType( $outputType );
5132 if ( $clearState ) {
5133 $this->clearState();
5138 * Wrapper for preprocess()
5140 * @param string $text The text to preprocess
5141 * @param ParserOptions $options
5142 * @param Title|null $title Title object or null to use $wgTitle
5145 public function transformMsg( $text, $options, $title = null ) {
5146 static $executing = false;
5148 # Guard against infinite recursion
5159 $text = $this->preprocess( $text, $title, $options );
5166 * Create an HTML-style tag, e.g. "<yourtag>special text</yourtag>"
5167 * The callback should have the following form:
5168 * function myParserHook( $text, $params, $parser, $frame ) { ... }
5170 * Transform and return $text. Use $parser for any required context, e.g. use
5171 * $parser->getTitle() and $parser->getOptions() not $wgTitle or $wgOut->mParserOptions
5173 * Hooks may return extended information by returning an array, of which the
5174 * first numbered element (index 0) must be the return string, and all other
5175 * entries are extracted into local variables within an internal function
5176 * in the Parser class.
5178 * This interface (introduced r61913) appears to be undocumented, but
5179 * 'markerType' is used by some core tag hooks to override which strip
5180 * array their results are placed in. **Use great caution if attempting
5181 * this interface, as it is not documented and injudicious use could smash
5182 * private variables.**
5184 * @param string $tag The tag to use, e.g. 'hook' for "<hook>"
5185 * @param callable $callback The callback function (and object) to use for the tag
5186 * @throws MWException
5187 * @return callable|null The old value of the mTagHooks array associated with the hook
5189 public function setHook( $tag, callable
$callback ) {
5190 $tag = strtolower( $tag );
5191 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
5192 throw new MWException( "Invalid character {$m[0]} in setHook('$tag', ...) call" );
5194 $oldVal = $this->mTagHooks
[$tag] ??
null;
5195 $this->mTagHooks
[$tag] = $callback;
5196 if ( !in_array( $tag, $this->mStripList
) ) {
5197 $this->mStripList
[] = $tag;
5204 * As setHook(), but letting the contents be parsed.
5206 * Transparent tag hooks are like regular XML-style tag hooks, except they
5207 * operate late in the transformation sequence, on HTML instead of wikitext.
5209 * This is probably obsoleted by things dealing with parser frames?
5210 * The only extension currently using it is geoserver.
5213 * @todo better document or deprecate this
5215 * @param string $tag The tag to use, e.g. 'hook' for "<hook>"
5216 * @param callable $callback The callback function (and object) to use for the tag
5217 * @throws MWException
5218 * @return callable|null The old value of the mTagHooks array associated with the hook
5220 public function setTransparentTagHook( $tag, callable
$callback ) {
5221 $tag = strtolower( $tag );
5222 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
5223 throw new MWException( "Invalid character {$m[0]} in setTransparentHook('$tag', ...) call" );
5225 $oldVal = $this->mTransparentTagHooks
[$tag] ??
null;
5226 $this->mTransparentTagHooks
[$tag] = $callback;
5232 * Remove all tag hooks
5234 public function clearTagHooks() {
5235 $this->mTagHooks
= [];
5236 $this->mFunctionTagHooks
= [];
5237 $this->mStripList
= $this->mDefaultStripList
;
5241 * Create a function, e.g. {{sum:1|2|3}}
5242 * The callback function should have the form:
5243 * function myParserFunction( &$parser, $arg1, $arg2, $arg3 ) { ... }
5245 * Or with Parser::SFH_OBJECT_ARGS:
5246 * function myParserFunction( $parser, $frame, $args ) { ... }
5248 * The callback may either return the text result of the function, or an array with the text
5249 * in element 0, and a number of flags in the other elements. The names of the flags are
5250 * specified in the keys. Valid flags are:
5251 * found The text returned is valid, stop processing the template. This
5253 * nowiki Wiki markup in the return value should be escaped
5254 * isHTML The returned text is HTML, armour it against wikitext transformation
5256 * @param string $id The magic word ID
5257 * @param callable $callback The callback function (and object) to use
5258 * @param int $flags A combination of the following flags:
5259 * Parser::SFH_NO_HASH No leading hash, i.e. {{plural:...}} instead of {{#if:...}}
5261 * Parser::SFH_OBJECT_ARGS Pass the template arguments as PPNode objects instead of text.
5262 * This allows for conditional expansion of the parse tree, allowing you to eliminate dead
5263 * branches and thus speed up parsing. It is also possible to analyse the parse tree of
5264 * the arguments, and to control the way they are expanded.
5266 * The $frame parameter is a PPFrame. This can be used to produce expanded text from the
5267 * arguments, for instance:
5268 * $text = isset( $args[0] ) ? $frame->expand( $args[0] ) : '';
5270 * For technical reasons, $args[0] is pre-expanded and will be a string. This may change in
5271 * future versions. Please call $frame->expand() on it anyway so that your code keeps
5272 * working if/when this is changed.
5274 * If you want whitespace to be trimmed from $args, you need to do it yourself, post-
5277 * Please read the documentation in includes/parser/Preprocessor.php for more information
5278 * about the methods available in PPFrame and PPNode.
5280 * @throws MWException
5281 * @return string|callable The old callback function for this name, if any
5283 public function setFunctionHook( $id, callable
$callback, $flags = 0 ) {
5284 $oldVal = isset( $this->mFunctionHooks
[$id] ) ?
$this->mFunctionHooks
[$id][0] : null;
5285 $this->mFunctionHooks
[$id] = [ $callback, $flags ];
5287 # Add to function cache
5288 $mw = $this->magicWordFactory
->get( $id );
5290 throw new MWException( __METHOD__
. '() expecting a magic word identifier.' );
5293 $synonyms = $mw->getSynonyms();
5294 $sensitive = intval( $mw->isCaseSensitive() );
5296 foreach ( $synonyms as $syn ) {
5298 if ( !$sensitive ) {
5299 $syn = $this->contLang
->lc( $syn );
5302 if ( !( $flags & self
::SFH_NO_HASH
) ) {
5305 # Remove trailing colon
5306 if ( substr( $syn, -1, 1 ) === ':' ) {
5307 $syn = substr( $syn, 0, -1 );
5309 $this->mFunctionSynonyms
[$sensitive][$syn] = $id;
5315 * Get all registered function hook identifiers
5319 public function getFunctionHooks() {
5320 $this->firstCallInit();
5321 return array_keys( $this->mFunctionHooks
);
5325 * Create a tag function, e.g. "<test>some stuff</test>".
5326 * Unlike tag hooks, tag functions are parsed at preprocessor level.
5327 * Unlike parser functions, their content is not preprocessed.
5328 * @param string $tag
5329 * @param callable $callback
5331 * @throws MWException
5334 public function setFunctionTagHook( $tag, callable
$callback, $flags ) {
5335 $tag = strtolower( $tag );
5336 if ( preg_match( '/[<>\r\n]/', $tag, $m ) ) {
5337 throw new MWException( "Invalid character {$m[0]} in setFunctionTagHook('$tag', ...) call" );
5339 $old = $this->mFunctionTagHooks
[$tag] ??
null;
5340 $this->mFunctionTagHooks
[$tag] = [ $callback, $flags ];
5342 if ( !in_array( $tag, $this->mStripList
) ) {
5343 $this->mStripList
[] = $tag;
5350 * Replace "<!--LINK-->" link placeholders with actual links, in the buffer
5351 * Placeholders created in Linker::link()
5353 * @param string &$text
5354 * @param int $options
5355 * @deprecated since 1.34; should not be used outside parser class.
5357 public function replaceLinkHolders( &$text, $options = 0 ) {
5358 $this->replaceLinkHoldersPrivate( $text, $options );
5362 * Replace "<!--LINK-->" link placeholders with actual links, in the buffer
5363 * Placeholders created in Linker::link()
5365 * @param string &$text
5366 * @param int $options
5368 private function replaceLinkHoldersPrivate( &$text, $options = 0 ) {
5369 $this->mLinkHolders
->replace( $text );
5373 * Replace "<!--LINK-->" link placeholders with plain text of links
5374 * (not HTML-formatted).
5376 * @param string $text
5378 * @deprecated since 1.34; should not be used outside parser class.
5380 public function replaceLinkHoldersText( $text ) {
5381 wfDeprecated( __METHOD__
, '1.34' );
5382 return $this->replaceLinkHoldersTextPrivate( $text );
5386 * Replace "<!--LINK-->" link placeholders with plain text of links
5387 * (not HTML-formatted).
5389 * @param string $text
5392 private function replaceLinkHoldersTextPrivate( $text ) {
5393 return $this->mLinkHolders
->replaceText( $text );
5397 * Renders an image gallery from a text with one line per image.
5398 * text labels may be given by using |-style alternative text. E.g.
5399 * Image:one.jpg|The number "1"
5400 * Image:tree.jpg|A tree
5401 * given as text will return the HTML of a gallery with two images,
5402 * labeled 'The number "1"' and
5405 * @param string $text
5406 * @param array $params
5407 * @return string HTML
5409 public function renderImageGallery( $text, $params ) {
5411 if ( isset( $params['mode'] ) ) {
5412 $mode = $params['mode'];
5416 $ig = ImageGalleryBase
::factory( $mode );
5417 } catch ( Exception
$e ) {
5418 // If invalid type set, fallback to default.
5419 $ig = ImageGalleryBase
::factory( false );
5422 $ig->setContextTitle( $this->mTitle
);
5423 $ig->setShowBytes( false );
5424 $ig->setShowDimensions( false );
5425 $ig->setShowFilename( false );
5426 $ig->setParser( $this );
5427 $ig->setHideBadImages();
5428 $ig->setAttributes( Sanitizer
::validateTagAttributes( $params, 'ul' ) );
5430 if ( isset( $params['showfilename'] ) ) {
5431 $ig->setShowFilename( true );
5433 $ig->setShowFilename( false );
5435 if ( isset( $params['caption'] ) ) {
5436 // NOTE: We aren't passing a frame here or below. Frame info
5437 // is currently opaque to Parsoid, which acts on OT_PREPROCESS.
5438 // See T107332#4030581
5439 $caption = $this->recursiveTagParse( $params['caption'] );
5440 $ig->setCaptionHtml( $caption );
5442 if ( isset( $params['perrow'] ) ) {
5443 $ig->setPerRow( $params['perrow'] );
5445 if ( isset( $params['widths'] ) ) {
5446 $ig->setWidths( $params['widths'] );
5448 if ( isset( $params['heights'] ) ) {
5449 $ig->setHeights( $params['heights'] );
5451 $ig->setAdditionalOptions( $params );
5453 // Avoid PHP 7.1 warning from passing $this by reference
5455 Hooks
::run( 'BeforeParserrenderImageGallery', [ &$parser, &$ig ] );
5457 $lines = StringUtils
::explode( "\n", $text );
5458 foreach ( $lines as $line ) {
5459 # match lines like these:
5460 # Image:someimage.jpg|This is some image
5462 preg_match( "/^([^|]+)(\\|(.*))?$/", $line, $matches );
5464 if ( count( $matches ) == 0 ) {
5468 if ( strpos( $matches[0], '%' ) !== false ) {
5469 $matches[1] = rawurldecode( $matches[1] );
5471 $title = Title
::newFromText( $matches[1], NS_FILE
);
5472 if ( is_null( $title ) ) {
5473 # Bogus title. Ignore these so we don't bomb out later.
5477 # We need to get what handler the file uses, to figure out parameters.
5478 # Note, a hook can overide the file name, and chose an entirely different
5479 # file (which potentially could be of a different type and have different handler).
5482 Hooks
::run( 'BeforeParserFetchFileAndTitle',
5483 [ $this, $title, &$options, &$descQuery ] );
5484 # Don't register it now, as TraditionalImageGallery does that later.
5485 $file = $this->fetchFileNoRegister( $title, $options );
5486 $handler = $file ?
$file->getHandler() : false;
5489 'img_alt' => 'gallery-internal-alt',
5490 'img_link' => 'gallery-internal-link',
5493 $paramMap +
= $handler->getParamMap();
5494 // We don't want people to specify per-image widths.
5495 // Additionally the width parameter would need special casing anyhow.
5496 unset( $paramMap['img_width'] );
5499 $mwArray = $this->magicWordFactory
->newArray( array_keys( $paramMap ) );
5504 $handlerOptions = [];
5505 if ( isset( $matches[3] ) ) {
5506 // look for an |alt= definition while trying not to break existing
5507 // captions with multiple pipes (|) in it, until a more sensible grammar
5508 // is defined for images in galleries
5510 // FIXME: Doing recursiveTagParse at this stage, and the trim before
5511 // splitting on '|' is a bit odd, and different from makeImage.
5512 $matches[3] = $this->recursiveTagParse( trim( $matches[3] ) );
5513 // Protect LanguageConverter markup
5514 $parameterMatches = StringUtils
::delimiterExplode(
5515 '-{', '}-', '|', $matches[3], true /* nested */
5518 foreach ( $parameterMatches as $parameterMatch ) {
5519 list( $magicName, $match ) = $mwArray->matchVariableStartToEnd( $parameterMatch );
5521 $paramName = $paramMap[$magicName];
5523 switch ( $paramName ) {
5524 case 'gallery-internal-alt':
5525 $alt = $this->stripAltTextPrivate( $match, false );
5527 case 'gallery-internal-link':
5528 $linkValue = $this->stripAltTextPrivate( $match, false );
5529 if ( preg_match( '/^-{R|(.*)}-$/', $linkValue ) ) {
5530 // Result of LanguageConverter::markNoConversion
5531 // invoked on an external link.
5532 $linkValue = substr( $linkValue, 4, -2 );
5534 list( $type, $target ) = $this->parseLinkParameterPrivate( $linkValue );
5535 if ( $type === 'link-url' ) {
5537 $this->mOutput
->addExternalLink( $target );
5538 } elseif ( $type === 'link-title' ) {
5539 $link = $target->getLinkURL();
5540 $this->mOutput
->addLink( $target );
5544 // Must be a handler specific parameter.
5545 if ( $handler->validateParam( $paramName, $match ) ) {
5546 $handlerOptions[$paramName] = $match;
5548 // Guess not, consider it as caption.
5549 $this->logger
->debug(
5550 "$parameterMatch failed parameter validation" );
5551 $label = $parameterMatch;
5557 $label = $parameterMatch;
5562 $ig->add( $title, $label, $alt, $link, $handlerOptions );
5564 $html = $ig->toHTML();
5565 Hooks
::run( 'AfterParserFetchFileAndTitle', [ $this, $ig, &$html ] );
5570 * @param MediaHandler $handler
5572 * @deprecated since 1.34; should not be used outside parser class.
5574 public function getImageParams( $handler ) {
5575 wfDeprecated( __METHOD__
, '1.34' );
5576 return $this->getImageParamsPrivate( $handler );
5580 * @param MediaHandler $handler
5583 private function getImageParamsPrivate( $handler ) {
5585 $handlerClass = get_class( $handler );
5589 if ( !isset( $this->mImageParams
[$handlerClass] ) ) {
5590 # Initialise static lists
5591 static $internalParamNames = [
5592 'horizAlign' => [ 'left', 'right', 'center', 'none' ],
5593 'vertAlign' => [ 'baseline', 'sub', 'super', 'top', 'text-top', 'middle',
5594 'bottom', 'text-bottom' ],
5595 'frame' => [ 'thumbnail', 'manualthumb', 'framed', 'frameless',
5596 'upright', 'border', 'link', 'alt', 'class' ],
5598 static $internalParamMap;
5599 if ( !$internalParamMap ) {
5600 $internalParamMap = [];
5601 foreach ( $internalParamNames as $type => $names ) {
5602 foreach ( $names as $name ) {
5603 // For grep: img_left, img_right, img_center, img_none,
5604 // img_baseline, img_sub, img_super, img_top, img_text_top, img_middle,
5605 // img_bottom, img_text_bottom,
5606 // img_thumbnail, img_manualthumb, img_framed, img_frameless, img_upright,
5607 // img_border, img_link, img_alt, img_class
5608 $magicName = str_replace( '-', '_', "img_$name" );
5609 $internalParamMap[$magicName] = [ $type, $name ];
5614 # Add handler params
5615 $paramMap = $internalParamMap;
5617 $handlerParamMap = $handler->getParamMap();
5618 foreach ( $handlerParamMap as $magic => $paramName ) {
5619 $paramMap[$magic] = [ 'handler', $paramName ];
5622 $this->mImageParams
[$handlerClass] = $paramMap;
5623 $this->mImageParamsMagicArray
[$handlerClass] =
5624 $this->magicWordFactory
->newArray( array_keys( $paramMap ) );
5626 return [ $this->mImageParams
[$handlerClass], $this->mImageParamsMagicArray
[$handlerClass] ];
5630 * Parse image options text and use it to make an image
5632 * @param Title $title
5633 * @param string $options
5634 * @param LinkHolderArray|bool $holders
5635 * @return string HTML
5637 public function makeImage( $title, $options, $holders = false ) {
5638 # Check if the options text is of the form "options|alt text"
5640 # * thumbnail make a thumbnail with enlarge-icon and caption, alignment depends on lang
5641 # * left no resizing, just left align. label is used for alt= only
5642 # * right same, but right aligned
5643 # * none same, but not aligned
5644 # * ___px scale to ___ pixels width, no aligning. e.g. use in taxobox
5645 # * center center the image
5646 # * frame Keep original image size, no magnify-button.
5647 # * framed Same as "frame"
5648 # * frameless like 'thumb' but without a frame. Keeps user preferences for width
5649 # * upright reduce width for upright images, rounded to full __0 px
5650 # * border draw a 1px border around the image
5651 # * alt Text for HTML alt attribute (defaults to empty)
5652 # * class Set a class for img node
5653 # * link Set the target of the image link. Can be external, interwiki, or local
5654 # vertical-align values (no % or length right now):
5664 # Protect LanguageConverter markup when splitting into parts
5665 $parts = StringUtils
::delimiterExplode(
5666 '-{', '}-', '|', $options, true /* allow nesting */
5669 # Give extensions a chance to select the file revision for us
5672 Hooks
::run( 'BeforeParserFetchFileAndTitle',
5673 [ $this, $title, &$options, &$descQuery ] );
5674 # Fetch and register the file (file title may be different via hooks)
5675 list( $file, $title ) = $this->fetchFileAndTitle( $title, $options );
5678 $handler = $file ?
$file->getHandler() : false;
5680 list( $paramMap, $mwArray ) = $this->getImageParamsPrivate( $handler );
5683 $this->addTrackingCategory( 'broken-file-category' );
5686 # Process the input parameters
5688 $params = [ 'frame' => [], 'handler' => [],
5689 'horizAlign' => [], 'vertAlign' => [] ];
5690 $seenformat = false;
5691 foreach ( $parts as $part ) {
5692 $part = trim( $part );
5693 list( $magicName, $value ) = $mwArray->matchVariableStartToEnd( $part );
5695 if ( isset( $paramMap[$magicName] ) ) {
5696 list( $type, $paramName ) = $paramMap[$magicName];
5698 # Special case; width and height come in one variable together
5699 if ( $type === 'handler' && $paramName === 'width' ) {
5700 $parsedWidthParam = self
::parseWidthParam( $value );
5701 if ( isset( $parsedWidthParam['width'] ) ) {
5702 $width = $parsedWidthParam['width'];
5703 if ( $handler->validateParam( 'width', $width ) ) {
5704 $params[$type]['width'] = $width;
5708 if ( isset( $parsedWidthParam['height'] ) ) {
5709 $height = $parsedWidthParam['height'];
5710 if ( $handler->validateParam( 'height', $height ) ) {
5711 $params[$type]['height'] = $height;
5715 # else no validation -- T15436
5717 if ( $type === 'handler' ) {
5718 # Validate handler parameter
5719 $validated = $handler->validateParam( $paramName, $value );
5721 # Validate internal parameters
5722 switch ( $paramName ) {
5726 # @todo FIXME: Possibly check validity here for
5727 # manualthumb? downstream behavior seems odd with
5728 # missing manual thumbs.
5730 $value = $this->stripAltTextPrivate( $value, $holders );
5733 list( $paramName, $value ) =
5734 $this->parseLinkParameterPrivate(
5735 $this->stripAltTextPrivate( $value, $holders )
5739 if ( $paramName === 'no-link' ) {
5742 if ( ( $paramName === 'link-url' ) && $this->mOptions
->getExternalLinkTarget() ) {
5743 $params[$type]['link-target'] = $this->mOptions
->getExternalLinkTarget();
5750 // use first appearing option, discard others.
5751 $validated = !$seenformat;
5755 # Most other things appear to be empty or numeric...
5756 $validated = ( $value === false ||
is_numeric( trim( $value ) ) );
5761 $params[$type][$paramName] = $value;
5765 if ( !$validated ) {
5770 # Process alignment parameters
5771 if ( $params['horizAlign'] ) {
5772 $params['frame']['align'] = key( $params['horizAlign'] );
5774 if ( $params['vertAlign'] ) {
5775 $params['frame']['valign'] = key( $params['vertAlign'] );
5778 $params['frame']['caption'] = $caption;
5780 # Will the image be presented in a frame, with the caption below?
5781 $imageIsFramed = isset( $params['frame']['frame'] )
5782 ||
isset( $params['frame']['framed'] )
5783 ||
isset( $params['frame']['thumbnail'] )
5784 ||
isset( $params['frame']['manualthumb'] );
5786 # In the old days, [[Image:Foo|text...]] would set alt text. Later it
5787 # came to also set the caption, ordinary text after the image -- which
5788 # makes no sense, because that just repeats the text multiple times in
5789 # screen readers. It *also* came to set the title attribute.
5790 # Now that we have an alt attribute, we should not set the alt text to
5791 # equal the caption: that's worse than useless, it just repeats the
5792 # text. This is the framed/thumbnail case. If there's no caption, we
5793 # use the unnamed parameter for alt text as well, just for the time be-
5794 # ing, if the unnamed param is set and the alt param is not.
5795 # For the future, we need to figure out if we want to tweak this more,
5796 # e.g., introducing a title= parameter for the title; ignoring the un-
5797 # named parameter entirely for images without a caption; adding an ex-
5798 # plicit caption= parameter and preserving the old magic unnamed para-
5800 if ( $imageIsFramed ) { # Framed image
5801 if ( $caption === '' && !isset( $params['frame']['alt'] ) ) {
5802 # No caption or alt text, add the filename as the alt text so
5803 # that screen readers at least get some description of the image
5804 $params['frame']['alt'] = $title->getText();
5806 # Do not set $params['frame']['title'] because tooltips don't make sense
5808 } else { # Inline image
5809 if ( !isset( $params['frame']['alt'] ) ) {
5810 # No alt text, use the "caption" for the alt text
5811 if ( $caption !== '' ) {
5812 $params['frame']['alt'] = $this->stripAltTextPrivate( $caption, $holders );
5814 # No caption, fall back to using the filename for the
5816 $params['frame']['alt'] = $title->getText();
5819 # Use the "caption" for the tooltip text
5820 $params['frame']['title'] = $this->stripAltTextPrivate( $caption, $holders );
5822 $params['handler']['targetlang'] = $this->getTargetLanguage()->getCode();
5824 Hooks
::run( 'ParserMakeImageParams', [ $title, $file, &$params, $this ] );
5826 # Linker does the rest
5827 $time = $options['time'] ??
false;
5828 $ret = Linker
::makeImageLink( $this, $title, $file, $params['frame'], $params['handler'],
5829 $time, $descQuery, $this->mOptions
->getThumbSize() );
5831 # Give the handler a chance to modify the parser object
5833 $handler->parserTransformHook( $this, $file );
5840 * Parse the value of 'link' parameter in image syntax (`[[File:Foo.jpg|link=<value>]]`).
5842 * Adds an entry to appropriate link tables.
5845 * @param string $value
5846 * @return array of `[ type, target ]`, where:
5847 * - `type` is one of:
5848 * - `null`: Given value is not a valid link target, use default
5849 * - `'no-link'`: Given value is empty, do not generate a link
5850 * - `'link-url'`: Given value is a valid external link
5851 * - `'link-title'`: Given value is a valid internal link
5853 * - When `type` is `null` or `'no-link'`: `false`
5854 * - When `type` is `'link-url'`: URL string corresponding to given value
5855 * - When `type` is `'link-title'`: Title object corresponding to given value
5856 * @deprecated since 1.34; should not be used outside parser class.
5858 public function parseLinkParameter( $value ) {
5859 wfDeprecated( __METHOD__
, '1.34' );
5860 return $this->parseLinkParameterPrivate( $value );
5864 * Parse the value of 'link' parameter in image syntax (`[[File:Foo.jpg|link=<value>]]`).
5866 * Adds an entry to appropriate link tables.
5869 * @param string $value
5870 * @return array of `[ type, target ]`, where:
5871 * - `type` is one of:
5872 * - `null`: Given value is not a valid link target, use default
5873 * - `'no-link'`: Given value is empty, do not generate a link
5874 * - `'link-url'`: Given value is a valid external link
5875 * - `'link-title'`: Given value is a valid internal link
5877 * - When `type` is `null` or `'no-link'`: `false`
5878 * - When `type` is `'link-url'`: URL string corresponding to given value
5879 * - When `type` is `'link-title'`: Title object corresponding to given value
5881 private function parseLinkParameterPrivate( $value ) {
5882 $chars = self
::EXT_LINK_URL_CLASS
;
5883 $addr = self
::EXT_LINK_ADDR
;
5884 $prots = $this->mUrlProtocols
;
5887 if ( $value === '' ) {
5889 } elseif ( preg_match( "/^((?i)$prots)/", $value ) ) {
5890 if ( preg_match( "/^((?i)$prots)$addr$chars*$/u", $value, $m ) ) {
5891 $this->mOutput
->addExternalLink( $value );
5896 $linkTitle = Title
::newFromText( $value );
5898 $this->mOutput
->addLink( $linkTitle );
5899 $type = 'link-title';
5900 $target = $linkTitle;
5903 return [ $type, $target ];
5907 * @param string $caption
5908 * @param LinkHolderArray|bool $holders
5909 * @return mixed|string
5910 * @deprecated since 1.34; should not be used outside parser class.
5912 protected function stripAltText( $caption, $holders ) {
5913 wfDeprecated( __METHOD__
, '1.34' );
5914 return $this->stripAltTextPrivate( $caption, $holders );
5918 * @param string $caption
5919 * @param LinkHolderArray|bool $holders
5920 * @return mixed|string
5922 private function stripAltTextPrivate( $caption, $holders ) {
5923 # Strip bad stuff out of the title (tooltip). We can't just use
5924 # replaceLinkHoldersText() here, because if this function is called
5925 # from handleInternalLinks2(), mLinkHolders won't be up-to-date.
5927 $tooltip = $holders->replaceText( $caption );
5929 $tooltip = $this->replaceLinkHoldersTextPrivate( $caption );
5932 # make sure there are no placeholders in thumbnail attributes
5933 # that are later expanded to html- so expand them now and
5935 $tooltip = $this->mStripState
->unstripBoth( $tooltip );
5936 # Compatibility hack! In HTML certain entity references not terminated
5937 # by a semicolon are decoded (but not if we're in an attribute; that's
5938 # how link URLs get away without properly escaping & in queries).
5939 # But wikitext has always required semicolon-termination of entities,
5940 # so encode & where needed to avoid decode of semicolon-less entities.
5942 # https://www.w3.org/TR/html5/syntax.html#named-character-references
5943 # T210437 discusses moving this workaround to Sanitizer::stripAllTags.
5944 $tooltip = preg_replace( "/
5945 & # 1. entity prefix
5946 (?= # 2. followed by:
5947 (?: # a. one of the legacy semicolon-less named entities
5948 A(?:Elig|MP|acute|circ|grave|ring|tilde|uml)|
5949 C(?:OPY|cedil)|E(?:TH|acute|circ|grave|uml)|
5950 GT|I(?:acute|circ|grave|uml)|LT|Ntilde|
5951 O(?:acute|circ|grave|slash|tilde|uml)|QUOT|REG|THORN|
5952 U(?:acute|circ|grave|uml)|Yacute|
5953 a(?:acute|c(?:irc|ute)|elig|grave|mp|ring|tilde|uml)|brvbar|
5954 c(?:cedil|edil|urren)|cent(?!erdot;)|copy(?!sr;)|deg|
5955 divide(?!ontimes;)|e(?:acute|circ|grave|th|uml)|
5956 frac(?:1(?:2|4)|34)|
5957 gt(?!c(?:c|ir)|dot|lPar|quest|r(?:a(?:pprox|rr)|dot|eq(?:less|qless)|less|sim);)|
5958 i(?:acute|circ|excl|grave|quest|uml)|laquo|
5959 lt(?!c(?:c|ir)|dot|hree|imes|larr|quest|r(?:Par|i(?:e|f|));)|
5960 m(?:acr|i(?:cro|ddot))|n(?:bsp|tilde)|
5961 not(?!in(?:E|dot|v(?:a|b|c)|)|ni(?:v(?:a|b|c)|);)|
5962 o(?:acute|circ|grave|rd(?:f|m)|slash|tilde|uml)|
5963 p(?:lusmn|ound)|para(?!llel;)|quot|r(?:aquo|eg)|
5964 s(?:ect|hy|up(?:1|2|3)|zlig)|thorn|times(?!b(?:ar|)|d;)|
5965 u(?:acute|circ|grave|ml|uml)|y(?:acute|en|uml)
5967 (?:[^;]|$)) # b. and not followed by a semicolon
5968 # S = study, for efficiency
5969 /Sx", '&', $tooltip );
5970 $tooltip = Sanitizer
::stripAllTags( $tooltip );
5976 * Set a flag in the output object indicating that the content is dynamic and
5977 * shouldn't be cached.
5978 * @deprecated since 1.28; use getOutput()->updateCacheExpiry()
5980 public function disableCache() {
5981 wfDeprecated( __METHOD__
, '1.28' );
5982 $this->logger
->debug( "Parser output marked as uncacheable." );
5983 if ( !$this->mOutput
) {
5984 throw new MWException( __METHOD__
.
5985 " can only be called when actually parsing something" );
5987 $this->mOutput
->updateCacheExpiry( 0 ); // new style, for consistency
5991 * Callback from the Sanitizer for expanding items found in HTML attribute
5992 * values, so they can be safely tested and escaped.
5994 * @param string &$text
5995 * @param bool|PPFrame $frame
5998 public function attributeStripCallback( &$text, $frame = false ) {
5999 $text = $this->replaceVariables( $text, $frame );
6000 $text = $this->mStripState
->unstripBoth( $text );
6009 public function getTags() {
6010 $this->firstCallInit();
6012 array_keys( $this->mTransparentTagHooks
),
6013 array_keys( $this->mTagHooks
),
6014 array_keys( $this->mFunctionTagHooks
)
6022 public function getFunctionSynonyms() {
6023 $this->firstCallInit();
6024 return $this->mFunctionSynonyms
;
6031 public function getUrlProtocols() {
6032 return $this->mUrlProtocols
;
6036 * Replace transparent tags in $text with the values given by the callbacks.
6038 * Transparent tag hooks are like regular XML-style tag hooks, except they
6039 * operate late in the transformation sequence, on HTML instead of wikitext.
6041 * @param string $text
6045 public function replaceTransparentTags( $text ) {
6047 $elements = array_keys( $this->mTransparentTagHooks
);
6048 $text = self
::extractTagsAndParams( $elements, $text, $matches );
6051 foreach ( $matches as $marker => $data ) {
6052 list( $element, $content, $params, $tag ) = $data;
6053 $tagName = strtolower( $element );
6054 if ( isset( $this->mTransparentTagHooks
[$tagName] ) ) {
6055 $output = call_user_func_array(
6056 $this->mTransparentTagHooks
[$tagName],
6057 [ $content, $params, $this ]
6062 $replacements[$marker] = $output;
6064 return strtr( $text, $replacements );
6068 * Break wikitext input into sections, and either pull or replace
6069 * some particular section's text.
6071 * External callers should use the getSection and replaceSection methods.
6073 * @param string $text Page wikitext
6074 * @param string|int $sectionId A section identifier string of the form:
6075 * "<flag1> - <flag2> - ... - <section number>"
6077 * Currently the only recognised flag is "T", which means the target section number
6078 * was derived during a template inclusion parse, in other words this is a template
6079 * section edit link. If no flags are given, it was an ordinary section edit link.
6080 * This flag is required to avoid a section numbering mismatch when a section is
6081 * enclosed by "<includeonly>" (T8563).
6083 * The section number 0 pulls the text before the first heading; other numbers will
6084 * pull the given section along with its lower-level subsections. If the section is
6085 * not found, $mode=get will return $newtext, and $mode=replace will return $text.
6087 * Section 0 is always considered to exist, even if it only contains the empty
6088 * string. If $text is the empty string and section 0 is replaced, $newText is
6091 * @param string $mode One of "get" or "replace"
6092 * @param string $newText Replacement text for section data.
6093 * @return string For "get", the extracted section text.
6094 * for "replace", the whole page with the section replaced.
6096 private function extractSections( $text, $sectionId, $mode, $newText = '' ) {
6097 global $wgTitle; # not generally used but removes an ugly failure mode
6099 $magicScopeVariable = $this->lock();
6100 $this->startParse( $wgTitle, new ParserOptions
, self
::OT_PLAIN
, true );
6102 $frame = $this->getPreprocessor()->newFrame();
6104 # Process section extraction flags
6106 $sectionParts = explode( '-', $sectionId );
6107 $sectionIndex = array_pop( $sectionParts );
6108 foreach ( $sectionParts as $part ) {
6109 if ( $part === 'T' ) {
6110 $flags |
= self
::PTD_FOR_INCLUSION
;
6114 # Check for empty input
6115 if ( strval( $text ) === '' ) {
6116 # Only sections 0 and T-0 exist in an empty document
6117 if ( $sectionIndex == 0 ) {
6118 if ( $mode === 'get' ) {
6124 if ( $mode === 'get' ) {
6132 # Preprocess the text
6133 $root = $this->preprocessToDom( $text, $flags );
6135 # <h> nodes indicate section breaks
6136 # They can only occur at the top level, so we can find them by iterating the root's children
6137 $node = $root->getFirstChild();
6139 # Find the target section
6140 if ( $sectionIndex == 0 ) {
6141 # Section zero doesn't nest, level=big
6142 $targetLevel = 1000;
6145 if ( $node->getName() === 'h' ) {
6146 $bits = $node->splitHeading();
6147 if ( $bits['i'] == $sectionIndex ) {
6148 $targetLevel = $bits['level'];
6152 if ( $mode === 'replace' ) {
6153 $outText .= $frame->expand( $node, PPFrame
::RECOVER_ORIG
);
6155 $node = $node->getNextSibling();
6161 if ( $mode === 'get' ) {
6168 # Find the end of the section, including nested sections
6170 if ( $node->getName() === 'h' ) {
6171 $bits = $node->splitHeading();
6172 $curLevel = $bits['level'];
6173 if ( $bits['i'] != $sectionIndex && $curLevel <= $targetLevel ) {
6177 if ( $mode === 'get' ) {
6178 $outText .= $frame->expand( $node, PPFrame
::RECOVER_ORIG
);
6180 $node = $node->getNextSibling();
6183 # Write out the remainder (in replace mode only)
6184 if ( $mode === 'replace' ) {
6185 # Output the replacement text
6186 # Add two newlines on -- trailing whitespace in $newText is conventionally
6187 # stripped by the editor, so we need both newlines to restore the paragraph gap
6188 # Only add trailing whitespace if there is newText
6189 if ( $newText != "" ) {
6190 $outText .= $newText . "\n\n";
6194 $outText .= $frame->expand( $node, PPFrame
::RECOVER_ORIG
);
6195 $node = $node->getNextSibling();
6199 if ( is_string( $outText ) ) {
6200 # Re-insert stripped tags
6201 $outText = rtrim( $this->mStripState
->unstripBoth( $outText ) );
6208 * This function returns the text of a section, specified by a number ($section).
6209 * A section is text under a heading like == Heading == or \<h1\>Heading\</h1\>, or
6210 * the first section before any such heading (section 0).
6212 * If a section contains subsections, these are also returned.
6214 * @param string $text Text to look in
6215 * @param string|int $sectionId Section identifier as a number or string
6216 * (e.g. 0, 1 or 'T-1').
6217 * @param string $defaultText Default to return if section is not found
6219 * @return string Text of the requested section
6221 public function getSection( $text, $sectionId, $defaultText = '' ) {
6222 return $this->extractSections( $text, $sectionId, 'get', $defaultText );
6226 * This function returns $oldtext after the content of the section
6227 * specified by $section has been replaced with $text. If the target
6228 * section does not exist, $oldtext is returned unchanged.
6230 * @param string $oldText Former text of the article
6231 * @param string|int $sectionId Section identifier as a number or string
6232 * (e.g. 0, 1 or 'T-1').
6233 * @param string $newText Replacing text
6235 * @return string Modified text
6237 public function replaceSection( $oldText, $sectionId, $newText ) {
6238 return $this->extractSections( $oldText, $sectionId, 'replace', $newText );
6242 * Get the ID of the revision we are parsing
6244 * The return value will be either:
6245 * - a) Positive, indicating a specific revision ID (current or old)
6246 * - b) Zero, meaning the revision ID is specified by getCurrentRevisionCallback()
6247 * - c) Null, meaning the parse is for preview mode and there is no revision
6251 public function getRevisionId() {
6252 return $this->mRevisionId
;
6256 * Get the revision object for $this->mRevisionId
6258 * @return Revision|null Either a Revision object or null
6259 * @since 1.23 (public since 1.23)
6261 public function getRevisionObject() {
6262 if ( $this->mRevisionObject
) {
6263 return $this->mRevisionObject
;
6266 // NOTE: try to get the RevisionObject even if mRevisionId is null.
6267 // This is useful when parsing a revision that has not yet been saved.
6268 // However, if we get back a saved revision even though we are in
6269 // preview mode, we'll have to ignore it, see below.
6270 // NOTE: This callback may be used to inject an OLD revision that was
6271 // already loaded, so "current" is a bit of a misnomer. We can't just
6272 // skip it if mRevisionId is set.
6273 $rev = call_user_func(
6274 $this->mOptions
->getCurrentRevisionCallback(),
6279 if ( $this->mRevisionId
=== null && $rev && $rev->getId() ) {
6280 // We are in preview mode (mRevisionId is null), and the current revision callback
6281 // returned an existing revision. Ignore it and return null, it's probably the page's
6282 // current revision, which is not what we want here. Note that we do want to call the
6283 // callback to allow the unsaved revision to be injected here, e.g. for
6284 // self-transclusion previews.
6288 // If the parse is for a new revision, then the callback should have
6289 // already been set to force the object and should match mRevisionId.
6290 // If not, try to fetch by mRevisionId for sanity.
6291 if ( $this->mRevisionId
&& $rev && $rev->getId() != $this->mRevisionId
) {
6292 $rev = Revision
::newFromId( $this->mRevisionId
);
6295 $this->mRevisionObject
= $rev;
6297 return $this->mRevisionObject
;
6301 * Get the timestamp associated with the current revision, adjusted for
6302 * the default server-local timestamp
6303 * @return string TS_MW timestamp
6305 public function getRevisionTimestamp() {
6306 if ( $this->mRevisionTimestamp
!== null ) {
6307 return $this->mRevisionTimestamp
;
6310 # Use specified revision timestamp, falling back to the current timestamp
6311 $revObject = $this->getRevisionObject();
6312 $timestamp = $revObject ?
$revObject->getTimestamp() : $this->mOptions
->getTimestamp();
6313 $this->mOutput
->setRevisionTimestampUsed( $timestamp ); // unadjusted time zone
6315 # The cryptic '' timezone parameter tells to use the site-default
6316 # timezone offset instead of the user settings.
6317 # Since this value will be saved into the parser cache, served
6318 # to other users, and potentially even used inside links and such,
6319 # it needs to be consistent for all visitors.
6320 $this->mRevisionTimestamp
= $this->contLang
->userAdjust( $timestamp, '' );
6322 return $this->mRevisionTimestamp
;
6326 * Get the name of the user that edited the last revision
6328 * @return string User name
6330 public function getRevisionUser() {
6331 if ( is_null( $this->mRevisionUser
) ) {
6332 $revObject = $this->getRevisionObject();
6334 # if this template is subst: the revision id will be blank,
6335 # so just use the current user's name
6337 $this->mRevisionUser
= $revObject->getUserText();
6338 } elseif ( $this->ot
['wiki'] ||
$this->mOptions
->getIsPreview() ) {
6339 $this->mRevisionUser
= $this->getUser()->getName();
6342 return $this->mRevisionUser
;
6346 * Get the size of the revision
6348 * @return int|null Revision size
6350 public function getRevisionSize() {
6351 if ( is_null( $this->mRevisionSize
) ) {
6352 $revObject = $this->getRevisionObject();
6354 # if this variable is subst: the revision id will be blank,
6355 # so just use the parser input size, because the own substituation
6356 # will change the size.
6358 $this->mRevisionSize
= $revObject->getSize();
6360 $this->mRevisionSize
= $this->mInputSize
;
6363 return $this->mRevisionSize
;
6367 * Mutator for $mDefaultSort
6369 * @param string $sort New value
6371 public function setDefaultSort( $sort ) {
6372 $this->mDefaultSort
= $sort;
6373 $this->mOutput
->setProperty( 'defaultsort', $sort );
6377 * Accessor for $mDefaultSort
6378 * Will use the empty string if none is set.
6380 * This value is treated as a prefix, so the
6381 * empty string is equivalent to sorting by
6386 public function getDefaultSort() {
6387 if ( $this->mDefaultSort
!== false ) {
6388 return $this->mDefaultSort
;
6395 * Accessor for $mDefaultSort
6396 * Unlike getDefaultSort(), will return false if none is set
6398 * @return string|bool
6400 public function getCustomDefaultSort() {
6401 return $this->mDefaultSort
;
6404 private static function getSectionNameFromStrippedText( $text ) {
6405 $text = Sanitizer
::normalizeSectionNameWhitespace( $text );
6406 $text = Sanitizer
::decodeCharReferences( $text );
6407 $text = self
::normalizeSectionName( $text );
6411 private static function makeAnchor( $sectionName ) {
6412 return '#' . Sanitizer
::escapeIdForLink( $sectionName );
6415 private function makeLegacyAnchor( $sectionName ) {
6416 $fragmentMode = $this->svcOptions
->get( 'FragmentMode' );
6417 if ( isset( $fragmentMode[1] ) && $fragmentMode[1] === 'legacy' ) {
6418 // ForAttribute() and ForLink() are the same for legacy encoding
6419 $id = Sanitizer
::escapeIdForAttribute( $sectionName, Sanitizer
::ID_FALLBACK
);
6421 $id = Sanitizer
::escapeIdForLink( $sectionName );
6428 * Try to guess the section anchor name based on a wikitext fragment
6429 * presumably extracted from a heading, for example "Header" from
6432 * @param string $text
6433 * @return string Anchor (starting with '#')
6435 public function guessSectionNameFromWikiText( $text ) {
6436 # Strip out wikitext links(they break the anchor)
6437 $text = $this->stripSectionName( $text );
6438 $sectionName = self
::getSectionNameFromStrippedText( $text );
6439 return self
::makeAnchor( $sectionName );
6443 * Same as guessSectionNameFromWikiText(), but produces legacy anchors
6444 * instead, if possible. For use in redirects, since various versions
6445 * of Microsoft browsers interpret Location: headers as something other
6446 * than UTF-8, resulting in breakage.
6448 * @param string $text The section name
6449 * @return string Anchor (starting with '#')
6451 public function guessLegacySectionNameFromWikiText( $text ) {
6452 # Strip out wikitext links(they break the anchor)
6453 $text = $this->stripSectionName( $text );
6454 $sectionName = self
::getSectionNameFromStrippedText( $text );
6455 return $this->makeLegacyAnchor( $sectionName );
6459 * Like guessSectionNameFromWikiText(), but takes already-stripped text as input.
6460 * @param string $text Section name (plain text)
6461 * @return string Anchor (starting with '#')
6463 public static function guessSectionNameFromStrippedText( $text ) {
6464 $sectionName = self
::getSectionNameFromStrippedText( $text );
6465 return self
::makeAnchor( $sectionName );
6469 * Apply the same normalization as code making links to this section would
6471 * @param string $text
6474 private static function normalizeSectionName( $text ) {
6475 # T90902: ensure the same normalization is applied for IDs as to links
6476 /** @var MediaWikiTitleCodec $titleParser */
6477 $titleParser = MediaWikiServices
::getInstance()->getTitleParser();
6478 '@phan-var MediaWikiTitleCodec $titleParser';
6481 $parts = $titleParser->splitTitleString( "#$text" );
6482 } catch ( MalformedTitleException
$ex ) {
6485 return $parts['fragment'];
6489 * Strips a text string of wikitext for use in a section anchor
6491 * Accepts a text string and then removes all wikitext from the
6492 * string and leaves only the resultant text (i.e. the result of
6493 * [[User:WikiSysop|Sysop]] would be "Sysop" and the result of
6494 * [[User:WikiSysop]] would be "User:WikiSysop") - this is intended
6495 * to create valid section anchors by mimicing the output of the
6496 * parser when headings are parsed.
6498 * @param string $text Text string to be stripped of wikitext
6499 * for use in a Section anchor
6500 * @return string Filtered text string
6502 public function stripSectionName( $text ) {
6503 # Strip internal link markup
6504 $text = preg_replace( '/\[\[:?([^[|]+)\|([^[]+)\]\]/', '$2', $text );
6505 $text = preg_replace( '/\[\[:?([^[]+)\|?\]\]/', '$1', $text );
6507 # Strip external link markup
6508 # @todo FIXME: Not tolerant to blank link text
6509 # I.E. [https://www.mediawiki.org] will render as [1] or something depending
6510 # on how many empty links there are on the page - need to figure that out.
6511 $text = preg_replace( '/\[(?i:' . $this->mUrlProtocols
. ')([^ ]+?) ([^[]+)\]/', '$2', $text );
6513 # Parse wikitext quotes (italics & bold)
6514 $text = $this->doQuotes( $text );
6517 $text = StringUtils
::delimiterReplace( '<', '>', '', $text );
6522 * strip/replaceVariables/unstrip for preprocessor regression testing
6524 * @param string $text
6525 * @param Title $title
6526 * @param ParserOptions $options
6527 * @param int $outputType
6530 * @deprecated since 1.34; should not be used outside parser class.
6532 public function testSrvus( $text, Title
$title, ParserOptions
$options,
6533 $outputType = self
::OT_HTML
6535 wfDeprecated( __METHOD__
, '1.34' );
6536 return $this->fuzzTestSrvus( $text, $title, $options, $outputType );
6540 * Strip/replaceVariables/unstrip for preprocessor regression testing
6542 * @param string $text
6543 * @param Title $title
6544 * @param ParserOptions $options
6545 * @param int $outputType
6549 private function fuzzTestSrvus( $text, Title
$title, ParserOptions
$options,
6550 $outputType = self
::OT_HTML
6552 $magicScopeVariable = $this->lock();
6553 $this->startParse( $title, $options, $outputType, true );
6555 $text = $this->replaceVariables( $text );
6556 $text = $this->mStripState
->unstripBoth( $text );
6557 $text = Sanitizer
::removeHTMLtags( $text );
6562 * @param string $text
6563 * @param Title $title
6564 * @param ParserOptions $options
6566 * @deprecated since 1.34; should not be used outside parser class.
6568 public function testPst( $text, Title
$title, ParserOptions
$options ) {
6569 wfDeprecated( __METHOD__
, '1.34' );
6570 return $this->fuzzTestPst( $text, $title, $options );
6574 * @param string $text
6575 * @param Title $title
6576 * @param ParserOptions $options
6579 private function fuzzTestPst( $text, Title
$title, ParserOptions
$options ) {
6580 return $this->preSaveTransform( $text, $title, $options->getUser(), $options );
6584 * @param string $text
6585 * @param Title $title
6586 * @param ParserOptions $options
6588 * @deprecated since 1.34; should not be used outside parser class.
6590 public function testPreprocess( $text, Title
$title, ParserOptions
$options ) {
6591 wfDeprecated( __METHOD__
, '1.34' );
6592 return $this->fuzzTestPreprocess( $text, $title, $options );
6596 * @param string $text
6597 * @param Title $title
6598 * @param ParserOptions $options
6601 private function fuzzTestPreprocess( $text, Title
$title, ParserOptions
$options ) {
6602 return $this->fuzzTestSrvus( $text, $title, $options, self
::OT_PREPROCESS
);
6606 * Call a callback function on all regions of the given text that are not
6607 * inside strip markers, and replace those regions with the return value
6608 * of the callback. For example, with input:
6612 * This will call the callback function twice, with 'aaa' and 'bbb'. Those
6613 * two strings will be replaced with the value returned by the callback in
6617 * @param callable $callback
6621 public function markerSkipCallback( $s, $callback ) {
6624 while ( $i < strlen( $s ) ) {
6625 $markerStart = strpos( $s, self
::MARKER_PREFIX
, $i );
6626 if ( $markerStart === false ) {
6627 $out .= call_user_func( $callback, substr( $s, $i ) );
6630 $out .= call_user_func( $callback, substr( $s, $i, $markerStart - $i ) );
6631 $markerEnd = strpos( $s, self
::MARKER_SUFFIX
, $markerStart );
6632 if ( $markerEnd === false ) {
6633 $out .= substr( $s, $markerStart );
6636 $markerEnd +
= strlen( self
::MARKER_SUFFIX
);
6637 $out .= substr( $s, $markerStart, $markerEnd - $markerStart );
6646 * Remove any strip markers found in the given text.
6648 * @param string $text
6651 public function killMarkers( $text ) {
6652 return $this->mStripState
->killMarkers( $text );
6656 * Save the parser state required to convert the given half-parsed text to
6657 * HTML. "Half-parsed" in this context means the output of
6658 * recursiveTagParse() or internalParse(). This output has strip markers
6659 * from replaceVariables (extensionSubstitution() etc.), and link
6660 * placeholders from replaceLinkHolders().
6662 * Returns an array which can be serialized and stored persistently. This
6663 * array can later be loaded into another parser instance with
6664 * unserializeHalfParsedText(). The text can then be safely incorporated into
6665 * the return value of a parser hook.
6667 * @deprecated since 1.31
6668 * @param string $text
6672 public function serializeHalfParsedText( $text ) {
6673 wfDeprecated( __METHOD__
, '1.31' );
6676 'version' => self
::HALF_PARSED_VERSION
,
6677 'stripState' => $this->mStripState
->getSubState( $text ),
6678 'linkHolders' => $this->mLinkHolders
->getSubArray( $text )
6684 * Load the parser state given in the $data array, which is assumed to
6685 * have been generated by serializeHalfParsedText(). The text contents is
6686 * extracted from the array, and its markers are transformed into markers
6687 * appropriate for the current Parser instance. This transformed text is
6688 * returned, and can be safely included in the return value of a parser
6691 * If the $data array has been stored persistently, the caller should first
6692 * check whether it is still valid, by calling isValidHalfParsedText().
6694 * @deprecated since 1.31
6695 * @param array $data Serialized data
6696 * @throws MWException
6699 public function unserializeHalfParsedText( $data ) {
6700 wfDeprecated( __METHOD__
, '1.31' );
6701 if ( !isset( $data['version'] ) ||
$data['version'] != self
::HALF_PARSED_VERSION
) {
6702 throw new MWException( __METHOD__
. ': invalid version' );
6705 # First, extract the strip state.
6706 $texts = [ $data['text'] ];
6707 $texts = $this->mStripState
->merge( $data['stripState'], $texts );
6709 # Now renumber links
6710 $texts = $this->mLinkHolders
->mergeForeign( $data['linkHolders'], $texts );
6712 # Should be good to go.
6717 * Returns true if the given array, presumed to be generated by
6718 * serializeHalfParsedText(), is compatible with the current version of the
6721 * @deprecated since 1.31
6722 * @param array $data
6726 public function isValidHalfParsedText( $data ) {
6727 wfDeprecated( __METHOD__
, '1.31' );
6728 return isset( $data['version'] ) && $data['version'] == self
::HALF_PARSED_VERSION
;
6732 * Parsed a width param of imagelink like 300px or 200x300px
6734 * @param string $value
6735 * @param bool $parseHeight
6740 public static function parseWidthParam( $value, $parseHeight = true ) {
6741 $parsedWidthParam = [];
6742 if ( $value === '' ) {
6743 return $parsedWidthParam;
6746 # (T15500) In both cases (width/height and width only),
6747 # permit trailing "px" for backward compatibility.
6748 if ( $parseHeight && preg_match( '/^([0-9]*)x([0-9]*)\s*(?:px)?\s*$/', $value, $m ) ) {
6749 $width = intval( $m[1] );
6750 $height = intval( $m[2] );
6751 $parsedWidthParam['width'] = $width;
6752 $parsedWidthParam['height'] = $height;
6753 } elseif ( preg_match( '/^[0-9]*\s*(?:px)?\s*$/', $value ) ) {
6754 $width = intval( $value );
6755 $parsedWidthParam['width'] = $width;
6757 return $parsedWidthParam;
6761 * Lock the current instance of the parser.
6763 * This is meant to stop someone from calling the parser
6764 * recursively and messing up all the strip state.
6766 * @throws MWException If parser is in a parse
6767 * @return ScopedCallback The lock will be released once the return value goes out of scope.
6769 protected function lock() {
6770 if ( $this->mInParse
) {
6771 throw new MWException( "Parser state cleared while parsing. "
6772 . "Did you call Parser::parse recursively? Lock is held by: " . $this->mInParse
);
6775 // Save the backtrace when locking, so that if some code tries locking again,
6776 // we can print the lock owner's backtrace for easier debugging
6778 $this->mInParse
= $e->getTraceAsString();
6780 $recursiveCheck = new ScopedCallback( function () {
6781 $this->mInParse
= false;
6784 return $recursiveCheck;
6788 * Strip outer <p></p> tag from the HTML source of a single paragraph.
6790 * Returns original HTML if the <p/> tag has any attributes, if there's no wrapping <p/> tag,
6791 * or if there is more than one <p/> tag in the input HTML.
6793 * @param string $html
6797 public static function stripOuterParagraph( $html ) {
6799 if ( preg_match( '/^<p>(.*)\n?<\/p>\n?$/sU', $html, $m ) && strpos( $m[1], '</p>' ) === false ) {
6807 * Return this parser if it is not doing anything, otherwise
6808 * get a fresh parser. You can use this method by doing
6809 * $newParser = $oldParser->getFreshParser(), or more simply
6810 * $oldParser->getFreshParser()->parse( ... );
6811 * if you're unsure if $oldParser is safe to use.
6814 * @return Parser A parser object that is not parsing anything
6816 public function getFreshParser() {
6817 if ( $this->mInParse
) {
6818 return $this->factory
->create();
6825 * Set's up the PHP implementation of OOUI for use in this request
6826 * and instructs OutputPage to enable OOUI for itself.
6830 public function enableOOUI() {
6831 OutputPage
::setupOOUI();
6832 $this->mOutput
->setEnableOOUI( true );
6836 * @param string $flag
6837 * @param string $reason
6839 protected function setOutputFlag( $flag, $reason ) {
6840 $this->mOutput
->setFlag( $flag );
6841 $name = $this->mTitle
->getPrefixedText();
6842 $this->logger
->debug( __METHOD__
. ": set $flag flag on '$name'; $reason" );