3 * Parser functions provided by MediaWiki core
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\MediaWikiServices
;
26 * Various core parser functions, registered in Parser::firstCallInit()
29 class CoreParserFunctions
{
31 * @param Parser $parser
34 public static function register( $parser ) {
35 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
37 # Syntax for arguments (see Parser::setFunctionHook):
38 # "name for lookup in localized magic words array",
40 # optional Parser::SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}}
41 # instead of {{#int:...}})
43 'ns', 'nse', 'urlencode', 'lcfirst', 'ucfirst', 'lc', 'uc',
44 'localurl', 'localurle', 'fullurl', 'fullurle', 'canonicalurl',
45 'canonicalurle', 'formatnum', 'grammar', 'gender', 'plural', 'bidi',
46 'numberofpages', 'numberofusers', 'numberofactiveusers',
47 'numberofarticles', 'numberoffiles', 'numberofadmins',
48 'numberingroup', 'numberofedits', 'language',
49 'padleft', 'padright', 'anchorencode', 'defaultsort', 'filepath',
50 'pagesincategory', 'pagesize', 'protectionlevel', 'protectionexpiry',
51 'namespacee', 'namespacenumber', 'talkspace', 'talkspacee',
52 'subjectspace', 'subjectspacee', 'pagename', 'pagenamee',
53 'fullpagename', 'fullpagenamee', 'rootpagename', 'rootpagenamee',
54 'basepagename', 'basepagenamee', 'subpagename', 'subpagenamee',
55 'talkpagename', 'talkpagenamee', 'subjectpagename',
56 'subjectpagenamee', 'pageid', 'revisionid', 'revisionday',
57 'revisionday2', 'revisionmonth', 'revisionmonth1', 'revisionyear',
58 'revisiontimestamp', 'revisionuser', 'cascadingsources',
60 foreach ( $noHashFunctions as $func ) {
61 $parser->setFunctionHook( $func, [ __CLASS__
, $func ], Parser
::SFH_NO_HASH
);
64 $parser->setFunctionHook(
66 [ __CLASS__
, 'mwnamespace' ],
69 $parser->setFunctionHook( 'int', [ __CLASS__
, 'intFunction' ], Parser
::SFH_NO_HASH
);
70 $parser->setFunctionHook( 'special', [ __CLASS__
, 'special' ] );
71 $parser->setFunctionHook( 'speciale', [ __CLASS__
, 'speciale' ] );
72 $parser->setFunctionHook( 'tag', [ __CLASS__
, 'tagObj' ], Parser
::SFH_OBJECT_ARGS
);
73 $parser->setFunctionHook( 'formatdate', [ __CLASS__
, 'formatDate' ] );
75 if ( $wgAllowDisplayTitle ) {
76 $parser->setFunctionHook(
78 [ __CLASS__
, 'displaytitle' ],
82 if ( $wgAllowSlowParserFunctions ) {
83 $parser->setFunctionHook(
85 [ __CLASS__
, 'pagesinnamespace' ],
92 * @param Parser $parser
93 * @param string $part1 Message key
94 * @param mixed ...$params To pass to wfMessage()
97 public static function intFunction( $parser, $part1 = '', ...$params ) {
98 if ( strval( $part1 ) !== '' ) {
99 $message = wfMessage( $part1, $params )
100 ->inLanguage( $parser->getOptions()->getUserLangObj() );
101 return [ $message->plain(), 'noparse' => false ];
103 return [ 'found' => false ];
108 * @param Parser $parser
109 * @param string $date
110 * @param string|null $defaultPref
114 public static function formatDate( $parser, $date, $defaultPref = null ) {
115 $lang = $parser->getFunctionLang();
116 $df = MediaWikiServices
::getInstance()->getDateFormatterFactory()->get( $lang );
118 $date = trim( $date );
120 $pref = $parser->getOptions()->getDateFormat();
122 // Specify a different default date format other than the normal default
123 // if the user has 'default' for their setting
124 if ( $pref == 'default' && $defaultPref ) {
125 $pref = $defaultPref;
128 $date = $df->reformat( $pref, $date, [ 'match-whole' ] );
132 public static function ns( $parser, $part1 = '' ) {
133 if ( intval( $part1 ) ||
$part1 == "0" ) {
134 $index = intval( $part1 );
136 $index = $parser->getContentLanguage()->getNsIndex( str_replace( ' ', '_', $part1 ) );
138 if ( $index !== false ) {
139 return $parser->getContentLanguage()->getFormattedNsText( $index );
141 return [ 'found' => false ];
145 public static function nse( $parser, $part1 = '' ) {
146 $ret = self
::ns( $parser, $part1 );
147 if ( is_string( $ret ) ) {
148 $ret = wfUrlencode( str_replace( ' ', '_', $ret ) );
154 * urlencodes a string according to one of three patterns: (T24474)
156 * By default (for HTTP "query" strings), spaces are encoded as '+'.
157 * Or to encode a value for the HTTP "path", spaces are encoded as '%20'.
158 * For links to "wiki"s, or similar software, spaces are encoded as '_',
160 * @param Parser $parser
161 * @param string $s The text to encode.
162 * @param string|null $arg (optional): The type of encoding.
165 public static function urlencode( $parser, $s = '', $arg = null ) {
166 static $magicWords = null;
167 if ( is_null( $magicWords ) ) {
169 $parser->getMagicWordFactory()->newArray( [ 'url_path', 'url_query', 'url_wiki' ] );
171 switch ( $magicWords->matchStartToEnd( $arg ) ) {
172 // Encode as though it's a wiki page, '_' for ' '.
174 $func = 'wfUrlencode';
175 $s = str_replace( ' ', '_', $s );
178 // Encode for an HTTP Path, '%20' for ' '.
180 $func = 'rawurlencode';
183 // Encode for HTTP query, '+' for ' '.
188 // See T105242, where the choice to kill markers and various
189 // other options were discussed.
190 return $func( $parser->killMarkers( $s ) );
193 public static function lcfirst( $parser, $s = '' ) {
194 return $parser->getContentLanguage()->lcfirst( $s );
197 public static function ucfirst( $parser, $s = '' ) {
198 return $parser->getContentLanguage()->ucfirst( $s );
202 * @param Parser $parser
206 public static function lc( $parser, $s = '' ) {
207 return $parser->markerSkipCallback( $s, [ $parser->getContentLanguage(), 'lc' ] );
211 * @param Parser $parser
215 public static function uc( $parser, $s = '' ) {
216 return $parser->markerSkipCallback( $s, [ $parser->getContentLanguage(), 'uc' ] );
219 public static function localurl( $parser, $s = '', $arg = null ) {
220 return self
::urlFunction( 'getLocalURL', $s, $arg );
223 public static function localurle( $parser, $s = '', $arg = null ) {
224 $temp = self
::urlFunction( 'getLocalURL', $s, $arg );
225 if ( !is_string( $temp ) ) {
228 return htmlspecialchars( $temp );
232 public static function fullurl( $parser, $s = '', $arg = null ) {
233 return self
::urlFunction( 'getFullURL', $s, $arg );
236 public static function fullurle( $parser, $s = '', $arg = null ) {
237 $temp = self
::urlFunction( 'getFullURL', $s, $arg );
238 if ( !is_string( $temp ) ) {
241 return htmlspecialchars( $temp );
245 public static function canonicalurl( $parser, $s = '', $arg = null ) {
246 return self
::urlFunction( 'getCanonicalURL', $s, $arg );
249 public static function canonicalurle( $parser, $s = '', $arg = null ) {
250 $temp = self
::urlFunction( 'getCanonicalURL', $s, $arg );
251 if ( !is_string( $temp ) ) {
254 return htmlspecialchars( $temp );
258 public static function urlFunction( $func, $s = '', $arg = null ) {
259 $title = Title
::newFromText( $s );
260 # Due to order of execution of a lot of bits, the values might be encoded
261 # before arriving here; if that's true, then the title can't be created
262 # and the variable will fail. If we can't get a decent title from the first
263 # attempt, url-decode and try for a second.
264 if ( is_null( $title ) ) {
265 $title = Title
::newFromURL( urldecode( $s ) );
267 if ( !is_null( $title ) ) {
268 # Convert NS_MEDIA -> NS_FILE
269 if ( $title->inNamespace( NS_MEDIA
) ) {
270 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
272 if ( !is_null( $arg ) ) {
273 $text = $title->$func( $arg );
275 $text = $title->$func();
279 return [ 'found' => false ];
284 * @param Parser $parser
286 * @param string|null $arg
289 public static function formatnum( $parser, $num = '', $arg = null ) {
290 if ( self
::matchAgainstMagicword( $parser->getMagicWordFactory(), 'rawsuffix', $arg ) ) {
291 $func = [ $parser->getFunctionLang(), 'parseFormattedNumber' ];
293 self
::matchAgainstMagicword( $parser->getMagicWordFactory(), 'nocommafysuffix', $arg )
295 $func = [ $parser->getFunctionLang(), 'formatNumNoSeparators' ];
297 $func = [ $parser->getFunctionLang(), 'formatNum' ];
299 return $parser->markerSkipCallback( $num, $func );
303 * @param Parser $parser
304 * @param string $case
305 * @param string $word
308 public static function grammar( $parser, $case = '', $word = '' ) {
309 $word = $parser->killMarkers( $word );
310 return $parser->getFunctionLang()->convertGrammar( $word, $case );
314 * @param Parser $parser
315 * @param string $username
316 * @param string ...$forms What to output for each gender
319 public static function gender( $parser, $username, ...$forms ) {
320 // Some shortcuts to avoid loading user data unnecessarily
321 if ( count( $forms ) === 0 ) {
323 } elseif ( count( $forms ) === 1 ) {
327 $username = trim( $username );
329 $gender = User
::getDefaultOption( 'gender' );
331 // allow prefix and normalize (e.g. "*foo" -> "*foo" ).
332 $title = Title
::newFromText( $username, NS_USER
);
334 if ( $title && $title->inNamespace( NS_USER
) ) {
335 $username = $title->getText();
338 // check parameter, or use the ParserOptions if in interface message
339 $user = User
::newFromName( $username );
340 $genderCache = MediaWikiServices
::getInstance()->getGenderCache();
342 $gender = $genderCache->getGenderOf( $user, __METHOD__
);
343 } elseif ( $username === '' && $parser->getOptions()->getInterfaceMessage() ) {
344 $gender = $genderCache->getGenderOf( $parser->getOptions()->getUser(), __METHOD__
);
346 $ret = $parser->getFunctionLang()->gender( $gender, $forms );
351 * @param Parser $parser
352 * @param string $text
353 * @param string ...$forms What to output for each number (singular, dual, plural, etc.)
356 public static function plural( $parser, $text = '', ...$forms ) {
357 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
358 settype( $text, ctype_digit( $text ) ?
'int' : 'float' );
359 return $parser->getFunctionLang()->convertPlural( $text, $forms );
363 * @param Parser $parser
364 * @param string $text
367 public static function bidi( $parser, $text = '' ) {
368 return $parser->getFunctionLang()->embedBidi( $text );
372 * Override the title of the page when viewed, provided we've been given a
373 * title which will normalise to the canonical title
375 * @param Parser $parser Parent parser
376 * @param string $text Desired title text
377 * @param string $uarg
380 public static function displaytitle( $parser, $text = '', $uarg = '' ) {
381 global $wgRestrictDisplayTitle;
383 static $magicWords = null;
384 if ( is_null( $magicWords ) ) {
385 $magicWords = $parser->getMagicWordFactory()->newArray(
386 [ 'displaytitle_noerror', 'displaytitle_noreplace' ] );
388 $arg = $magicWords->matchStartToEnd( $uarg );
390 // parse a limited subset of wiki markup (just the single quote items)
391 $text = $parser->doQuotes( $text );
393 // remove stripped text (e.g. the UNIQ-QINU stuff) that was generated by tag extensions/whatever
394 $text = $parser->killMarkers( $text );
396 // list of disallowed tags for DISPLAYTITLE
397 // these will be escaped even though they are allowed in normal wiki text
398 $bad = [ 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'blockquote', 'ol', 'ul', 'li', 'hr',
399 'table', 'tr', 'th', 'td', 'dl', 'dd', 'caption', 'p', 'ruby', 'rb', 'rt', 'rtc', 'rp', 'br' ];
401 // disallow some styles that could be used to bypass $wgRestrictDisplayTitle
402 if ( $wgRestrictDisplayTitle ) {
403 $htmlTagsCallback = function ( &$params ) {
404 $decoded = Sanitizer
::decodeTagAttributes( $params );
406 if ( isset( $decoded['style'] ) ) {
407 // this is called later anyway, but we need it right now for the regexes below to be safe
408 // calling it twice doesn't hurt
409 $decoded['style'] = Sanitizer
::checkCss( $decoded['style'] );
411 if ( preg_match( '/(display|user-select|visibility)\s*:/i', $decoded['style'] ) ) {
412 $decoded['style'] = '/* attempt to bypass $wgRestrictDisplayTitle */';
416 $params = Sanitizer
::safeEncodeTagAttributes( $decoded );
419 $htmlTagsCallback = null;
422 // only requested titles that normalize to the actual title are allowed through
423 // if $wgRestrictDisplayTitle is true (it is by default)
424 // mimic the escaping process that occurs in OutputPage::setPageTitle
425 $text = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags(
432 $title = Title
::newFromText( Sanitizer
::stripAllTags( $text ) );
434 if ( !$wgRestrictDisplayTitle ||
435 ( $title instanceof Title
436 && !$title->hasFragment()
437 && $title->equals( $parser->getTitle() ) )
439 $old = $parser->mOutput
->getProperty( 'displaytitle' );
440 if ( $old === false ||
$arg !== 'displaytitle_noreplace' ) {
441 $parser->mOutput
->setDisplayTitle( $text );
443 if ( $old !== false && $old !== $text && !$arg ) {
444 $converter = $parser->getTargetLanguage()->getConverter();
445 return '<span class="error">' .
446 wfMessage( 'duplicate-displaytitle',
447 // Message should be parsed, but these params should only be escaped.
448 $converter->markNoConversion( wfEscapeWikiText( $old ) ),
449 $converter->markNoConversion( wfEscapeWikiText( $text ) )
450 )->inContentLanguage()->text() .
456 $parser->getOutput()->addWarning(
457 wfMessage( 'restricted-displaytitle',
458 // Message should be parsed, but this param should only be escaped.
459 wfEscapeWikiText( $text )
462 $parser->addTrackingCategory( 'restricted-displaytitle-ignored' );
467 * Matches the given value against the value of given magic word
469 * @param MagicWordFactory $magicWordFactory A factory to get the word from, e.g., from
470 * $parser->getMagicWordFactory()
471 * @param string $magicword Magic word key
472 * @param string $value Value to match
473 * @return bool True on successful match
475 private static function matchAgainstMagicword(
476 MagicWordFactory
$magicWordFactory, $magicword, $value
478 $value = trim( strval( $value ) );
479 if ( $value === '' ) {
482 $mwObject = $magicWordFactory->get( $magicword );
483 return $mwObject->matchStartToEnd( $value );
487 * Formats a number according to a language.
489 * @param int|float $num
491 * @param Language|StubUserLang $language
492 * @param MagicWordFactory|null $magicWordFactory To evaluate $raw
495 public static function formatRaw(
496 $num, $raw, $language, MagicWordFactory
$magicWordFactory = null
498 if ( $raw !== null && !$magicWordFactory ) {
499 $magicWordFactory = MediaWikiServices
::getInstance()->getMagicWordFactory();
502 $raw !== null && self
::matchAgainstMagicword( $magicWordFactory, 'rawsuffix', $raw )
506 return $language->formatNum( $num );
510 public static function numberofpages( $parser, $raw = null ) {
511 return self
::formatRaw( SiteStats
::pages(), $raw, $parser->getFunctionLang() );
514 public static function numberofusers( $parser, $raw = null ) {
515 return self
::formatRaw( SiteStats
::users(), $raw, $parser->getFunctionLang() );
518 public static function numberofactiveusers( $parser, $raw = null ) {
519 return self
::formatRaw( SiteStats
::activeUsers(), $raw, $parser->getFunctionLang() );
522 public static function numberofarticles( $parser, $raw = null ) {
523 return self
::formatRaw( SiteStats
::articles(), $raw, $parser->getFunctionLang() );
526 public static function numberoffiles( $parser, $raw = null ) {
527 return self
::formatRaw( SiteStats
::images(), $raw, $parser->getFunctionLang() );
530 public static function numberofadmins( $parser, $raw = null ) {
531 return self
::formatRaw(
532 SiteStats
::numberingroup( 'sysop' ),
534 $parser->getFunctionLang()
538 public static function numberofedits( $parser, $raw = null ) {
539 return self
::formatRaw( SiteStats
::edits(), $raw, $parser->getFunctionLang() );
542 public static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
543 return self
::formatRaw(
544 SiteStats
::pagesInNs( intval( $namespace ) ),
546 $parser->getFunctionLang()
550 public static function numberingroup( $parser, $name = '', $raw = null ) {
551 return self
::formatRaw(
552 SiteStats
::numberingroup( strtolower( $name ) ),
554 $parser->getFunctionLang()
559 * Given a title, return the namespace name that would be given by the
560 * corresponding magic word
561 * Note: function name changed to "mwnamespace" rather than "namespace"
562 * to not break PHP 5.3
563 * @param Parser $parser
564 * @param string|null $title
565 * @return mixed|string
567 public static function mwnamespace( $parser, $title = null ) {
568 $t = Title
::newFromText( $title );
569 if ( is_null( $t ) ) {
572 return str_replace( '_', ' ', $t->getNsText() );
575 public static function namespacee( $parser, $title = null ) {
576 $t = Title
::newFromText( $title );
577 if ( is_null( $t ) ) {
580 return wfUrlencode( $t->getNsText() );
583 public static function namespacenumber( $parser, $title = null ) {
584 $t = Title
::newFromText( $title );
585 if ( is_null( $t ) ) {
588 return $t->getNamespace();
591 public static function talkspace( $parser, $title = null ) {
592 $t = Title
::newFromText( $title );
593 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
596 return str_replace( '_', ' ', $t->getTalkNsText() );
599 public static function talkspacee( $parser, $title = null ) {
600 $t = Title
::newFromText( $title );
601 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
604 return wfUrlencode( $t->getTalkNsText() );
607 public static function subjectspace( $parser, $title = null ) {
608 $t = Title
::newFromText( $title );
609 if ( is_null( $t ) ) {
612 return str_replace( '_', ' ', $t->getSubjectNsText() );
615 public static function subjectspacee( $parser, $title = null ) {
616 $t = Title
::newFromText( $title );
617 if ( is_null( $t ) ) {
620 return wfUrlencode( $t->getSubjectNsText() );
624 * Functions to get and normalize pagenames, corresponding to the magic words
626 * @param Parser $parser
627 * @param string|null $title
630 public static function pagename( $parser, $title = null ) {
631 $t = Title
::newFromText( $title );
632 if ( is_null( $t ) ) {
635 return wfEscapeWikiText( $t->getText() );
638 public static function pagenamee( $parser, $title = null ) {
639 $t = Title
::newFromText( $title );
640 if ( is_null( $t ) ) {
643 return wfEscapeWikiText( $t->getPartialURL() );
646 public static function fullpagename( $parser, $title = null ) {
647 $t = Title
::newFromText( $title );
648 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
651 return wfEscapeWikiText( $t->getPrefixedText() );
654 public static function fullpagenamee( $parser, $title = null ) {
655 $t = Title
::newFromText( $title );
656 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
659 return wfEscapeWikiText( $t->getPrefixedURL() );
662 public static function subpagename( $parser, $title = null ) {
663 $t = Title
::newFromText( $title );
664 if ( is_null( $t ) ) {
667 return wfEscapeWikiText( $t->getSubpageText() );
670 public static function subpagenamee( $parser, $title = null ) {
671 $t = Title
::newFromText( $title );
672 if ( is_null( $t ) ) {
675 return wfEscapeWikiText( $t->getSubpageUrlForm() );
678 public static function rootpagename( $parser, $title = null ) {
679 $t = Title
::newFromText( $title );
680 if ( is_null( $t ) ) {
683 return wfEscapeWikiText( $t->getRootText() );
686 public static function rootpagenamee( $parser, $title = null ) {
687 $t = Title
::newFromText( $title );
688 if ( is_null( $t ) ) {
691 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getRootText() ) ) );
694 public static function basepagename( $parser, $title = null ) {
695 $t = Title
::newFromText( $title );
696 if ( is_null( $t ) ) {
699 return wfEscapeWikiText( $t->getBaseText() );
702 public static function basepagenamee( $parser, $title = null ) {
703 $t = Title
::newFromText( $title );
704 if ( is_null( $t ) ) {
707 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getBaseText() ) ) );
710 public static function talkpagename( $parser, $title = null ) {
711 $t = Title
::newFromText( $title );
712 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
715 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
718 public static function talkpagenamee( $parser, $title = null ) {
719 $t = Title
::newFromText( $title );
720 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
723 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedURL() );
726 public static function subjectpagename( $parser, $title = null ) {
727 $t = Title
::newFromText( $title );
728 if ( is_null( $t ) ) {
731 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
734 public static function subjectpagenamee( $parser, $title = null ) {
735 $t = Title
::newFromText( $title );
736 if ( is_null( $t ) ) {
739 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedURL() );
743 * Return the number of pages, files or subcats in the given category,
744 * or 0 if it's nonexistent. This is an expensive parser function and
745 * can't be called too many times per page.
746 * @param Parser $parser
747 * @param string $name
748 * @param string|null $arg1
749 * @param string|null $arg2
752 public static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
753 static $magicWords = null;
754 if ( is_null( $magicWords ) ) {
755 $magicWords = $parser->getMagicWordFactory()->newArray( [
756 'pagesincategory_all',
757 'pagesincategory_pages',
758 'pagesincategory_subcats',
759 'pagesincategory_files'
764 // split the given option to its variable
765 if ( self
::matchAgainstMagicword( $parser->getMagicWordFactory(), 'rawsuffix', $arg1 ) ) {
766 // {{pagesincategory:|raw[|type]}}
768 $type = $magicWords->matchStartToEnd( $arg2 );
770 // {{pagesincategory:[|type[|raw]]}}
771 $type = $magicWords->matchStartToEnd( $arg1 );
774 if ( !$type ) { // backward compatibility
775 $type = 'pagesincategory_all';
778 $title = Title
::makeTitleSafe( NS_CATEGORY
, $name );
779 if ( !$title ) { # invalid title
780 return self
::formatRaw( 0, $raw, $parser->getFunctionLang() );
782 $parser->getContentLanguage()->findVariantLink( $name, $title, true );
784 // Normalize name for cache
785 $name = $title->getDBkey();
787 if ( !isset( $cache[$name] ) ) {
788 $category = Category
::newFromTitle( $title );
790 $allCount = $subcatCount = $fileCount = $pagesCount = 0;
791 if ( $parser->incrementExpensiveFunctionCount() ) {
792 // $allCount is the total number of cat members,
793 // not the count of how many members are normal pages.
794 $allCount = (int)$category->getPageCount();
795 $subcatCount = (int)$category->getSubcatCount();
796 $fileCount = (int)$category->getFileCount();
797 $pagesCount = $allCount - $subcatCount - $fileCount;
799 $cache[$name]['pagesincategory_all'] = $allCount;
800 $cache[$name]['pagesincategory_pages'] = $pagesCount;
801 $cache[$name]['pagesincategory_subcats'] = $subcatCount;
802 $cache[$name]['pagesincategory_files'] = $fileCount;
805 $count = $cache[$name][$type];
806 return self
::formatRaw( $count, $raw, $parser->getFunctionLang() );
810 * Return the size of the given page, or 0 if it's nonexistent. This is an
811 * expensive parser function and can't be called too many times per page.
813 * @param Parser $parser
814 * @param string $page Name of page to check (Default: empty string)
815 * @param string|null $raw Should number be human readable with commas or just number
818 public static function pagesize( $parser, $page = '', $raw = null ) {
819 $title = Title
::newFromText( $page );
821 if ( !is_object( $title ) ) {
822 return self
::formatRaw( 0, $raw, $parser->getFunctionLang() );
825 // fetch revision from cache/database and return the value
826 $rev = self
::getCachedRevisionObject( $parser, $title, 'vary-revision-sha1' );
827 $length = $rev ?
$rev->getSize() : 0;
828 if ( $length === null ) {
829 // We've had bugs where rev_len was not being recorded for empty pages, see T135414
832 return self
::formatRaw( $length, $raw, $parser->getFunctionLang() );
836 * Returns the requested protection level for the current page. This
837 * is an expensive parser function and can't be called too many times
838 * per page, unless the protection levels/expiries for the given title
839 * have already been retrieved
841 * @param Parser $parser
842 * @param string $type
843 * @param string $title
847 public static function protectionlevel( $parser, $type = '', $title = '' ) {
848 $titleObject = Title
::newFromText( $title ) ??
$parser->getTitle();
849 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
850 $restrictions = $titleObject->getRestrictions( strtolower( $type ) );
851 # Title::getRestrictions returns an array, its possible it may have
852 # multiple values in the future
853 return implode( ',', $restrictions );
859 * Returns the requested protection expiry for the current page. This
860 * is an expensive parser function and can't be called too many times
861 * per page, unless the protection levels/expiries for the given title
862 * have already been retrieved
864 * @param Parser $parser
865 * @param string $type
866 * @param string $title
870 public static function protectionexpiry( $parser, $type = '', $title = '' ) {
871 $titleObject = Title
::newFromText( $title ) ??
$parser->getTitle();
872 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
873 $expiry = $titleObject->getRestrictionExpiry( strtolower( $type ) );
874 // getRestrictionExpiry() returns false on invalid type; trying to
875 // match protectionlevel() function that returns empty string instead
876 if ( $expiry === false ) {
885 * Gives language names.
886 * @param Parser $parser
887 * @param string $code Language code (of which to get name)
888 * @param string $inLanguage Language code (in which to get name)
891 public static function language( $parser, $code = '', $inLanguage = '' ) {
892 $code = strtolower( $code );
893 $inLanguage = strtolower( $inLanguage );
894 $lang = Language
::fetchLanguageName( $code, $inLanguage );
895 return $lang !== '' ?
$lang : LanguageCode
::bcp47( $code );
899 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
900 * @param Parser $parser
901 * @param string $string
902 * @param string $length
903 * @param string $padding
904 * @param int $direction
907 public static function pad(
908 $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
910 $padding = $parser->killMarkers( $padding );
911 $lengthOfPadding = mb_strlen( $padding );
912 if ( $lengthOfPadding == 0 ) {
916 # The remaining length to add counts down to 0 as padding is added
917 $length = min( (int)$length, 500 ) - mb_strlen( $string );
918 if ( $length <= 0 ) {
923 # $finalPadding is just $padding repeated enough times so that
924 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
926 while ( $length > 0 ) {
927 # If $length < $lengthofPadding, truncate $padding so we get the
928 # exact length desired.
929 $finalPadding .= mb_substr( $padding, 0, $length );
930 $length -= $lengthOfPadding;
933 if ( $direction == STR_PAD_LEFT
) {
934 return $finalPadding . $string;
936 return $string . $finalPadding;
940 public static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
941 return self
::pad( $parser, $string, $length, $padding, STR_PAD_LEFT
);
944 public static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
945 return self
::pad( $parser, $string, $length, $padding );
949 * @param Parser $parser
950 * @param string $text
953 public static function anchorencode( $parser, $text ) {
954 $text = $parser->killMarkers( $text );
955 $section = (string)substr( $parser->guessSectionNameFromWikiText( $text ), 1 );
956 return Sanitizer
::safeEncodeAttribute( $section );
959 public static function special( $parser, $text ) {
960 list( $page, $subpage ) = MediaWikiServices
::getInstance()->getSpecialPageFactory()->
961 resolveAlias( $text );
963 $title = SpecialPage
::getTitleFor( $page, $subpage );
964 return $title->getPrefixedText();
966 // unknown special page, just use the given text as its title, if at all possible
967 $title = Title
::makeTitleSafe( NS_SPECIAL
, $text );
968 return $title ?
$title->getPrefixedText() : self
::special( $parser, 'Badtitle' );
972 public static function speciale( $parser, $text ) {
973 return wfUrlencode( str_replace( ' ', '_', self
::special( $parser, $text ) ) );
977 * @param Parser $parser
978 * @param string $text The sortkey to use
979 * @param string $uarg Either "noreplace" or "noerror" (in en)
980 * both suppress errors, and noreplace does nothing if
981 * a default sortkey already exists.
984 public static function defaultsort( $parser, $text, $uarg = '' ) {
985 static $magicWords = null;
986 if ( is_null( $magicWords ) ) {
987 $magicWords = $parser->getMagicWordFactory()->newArray(
988 [ 'defaultsort_noerror', 'defaultsort_noreplace' ] );
990 $arg = $magicWords->matchStartToEnd( $uarg );
992 $text = trim( $text );
993 if ( strlen( $text ) == 0 ) {
996 $old = $parser->getCustomDefaultSort();
997 if ( $old === false ||
$arg !== 'defaultsort_noreplace' ) {
998 $parser->setDefaultSort( $text );
1001 if ( $old === false ||
$old == $text ||
$arg ) {
1004 $converter = $parser->getTargetLanguage()->getConverter();
1005 return '<span class="error">' .
1006 wfMessage( 'duplicate-defaultsort',
1007 // Message should be parsed, but these params should only be escaped.
1008 $converter->markNoConversion( wfEscapeWikiText( $old ) ),
1009 $converter->markNoConversion( wfEscapeWikiText( $text ) )
1010 )->inContentLanguage()->text() .
1016 * Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}}
1017 * or {{filepath|300|nowiki}} or {{filepath|300px}}, {{filepath|200x300px}},
1018 * {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}.
1020 * @param Parser $parser
1021 * @param string $name
1022 * @param string $argA
1023 * @param string $argB
1024 * @return array|string
1026 public static function filepath( $parser, $name = '', $argA = '', $argB = '' ) {
1027 $file = MediaWikiServices
::getInstance()->getRepoGroup()->findFile( $name );
1029 if ( $argA == 'nowiki' ) {
1030 // {{filepath: | option [| size] }}
1032 $parsedWidthParam = Parser
::parseWidthParam( $argB );
1034 // {{filepath: [| size [|option]] }}
1035 $parsedWidthParam = Parser
::parseWidthParam( $argA );
1036 $isNowiki = ( $argB == 'nowiki' );
1040 $url = $file->getFullUrl();
1042 // If a size is requested...
1043 if ( count( $parsedWidthParam ) ) {
1044 $mto = $file->transform( $parsedWidthParam );
1046 if ( $mto && !$mto->isError() ) {
1047 // ... change the URL to point to a thumbnail.
1048 $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE
);
1052 return [ $url, 'nowiki' => true ];
1061 * Parser function to extension tag adaptor
1062 * @param Parser $parser
1063 * @param PPFrame $frame
1064 * @param PPNode[] $args
1067 public static function tagObj( $parser, $frame, $args ) {
1068 if ( !count( $args ) ) {
1071 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
1073 if ( count( $args ) ) {
1074 $inner = $frame->expand( array_shift( $args ) );
1080 foreach ( $args as $arg ) {
1081 $bits = $arg->splitArg();
1082 if ( strval( $bits['index'] ) === '' ) {
1083 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
1084 $value = trim( $frame->expand( $bits['value'] ) );
1085 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
1086 $value = $m[1] ??
'';
1088 $attributes[$name] = $value;
1092 $stripList = $parser->getStripList();
1093 if ( !in_array( $tagName, $stripList ) ) {
1094 // we can't handle this tag (at least not now), so just re-emit it as an ordinary tag
1096 foreach ( $attributes as $name => $value ) {
1097 $attrText .= ' ' . htmlspecialchars( $name ) . '="' . htmlspecialchars( $value ) . '"';
1099 if ( $inner === null ) {
1100 return "<$tagName$attrText/>";
1102 return "<$tagName$attrText>$inner</$tagName>";
1108 'attributes' => $attributes,
1109 'close' => "</$tagName>",
1111 return $parser->extensionSubstitution( $params, $frame );
1115 * Fetched the current revision of the given title and return this.
1116 * Will increment the expensive function count and
1117 * add a template link to get the value refreshed on changes.
1118 * For a given title, which is equal to the current parser title,
1119 * the revision object from the parser is used, when that is the current one
1121 * @param Parser $parser
1122 * @param Title $title
1123 * @param string $vary ParserOuput vary-* flag
1124 * @return Revision|null
1127 private static function getCachedRevisionObject( $parser, $title, $vary ) {
1134 $isSelfReferential = $title->equals( $parser->getTitle() );
1135 if ( $isSelfReferential ) {
1136 // Revision is for the same title that is currently being parsed. Only use the last
1137 // saved revision, regardless of Parser::getRevisionId() or fake revision injection
1138 // callbacks against the current title.
1139 $parserRevision = $parser->getRevisionObject();
1140 if ( $parserRevision && $parserRevision->isCurrent() ) {
1141 $revision = $parserRevision;
1142 wfDebug( __METHOD__
. ": used current revision, setting $vary" );
1146 $parserOutput = $parser->getOutput();
1149 !$parser->isCurrentRevisionOfTitleCached( $title ) &&
1150 !$parser->incrementExpensiveFunctionCount()
1152 return null; // not allowed
1154 // Get the current revision, ignoring Parser::getRevisionId() being null/old
1155 $revision = $parser->fetchCurrentRevisionOfTitle( $title );
1156 // Register dependency in templatelinks
1157 $parserOutput->addTemplate(
1159 $revision ?
$revision->getPage() : 0,
1160 $revision ?
$revision->getId() : 0
1164 if ( $isSelfReferential ) {
1165 // Upon page save, the result of the parser function using this might change
1166 $parserOutput->setFlag( $vary );
1167 if ( $vary === 'vary-revision-sha1' && $revision ) {
1168 $parserOutput->setRevisionUsedSha1Base36( $revision->getSha1() );
1176 * Get the pageid of a specified page
1177 * @param Parser $parser
1178 * @param string|null $title Title to get the pageid from
1179 * @return int|null|string
1182 public static function pageid( $parser, $title = null ) {
1183 $t = Title
::newFromText( $title );
1186 } elseif ( !$t->canExist() ||
$t->isExternal() ) {
1187 return 0; // e.g. special page or interwiki link
1190 $parserOutput = $parser->getOutput();
1192 if ( $t->equals( $parser->getTitle() ) ) {
1193 // Revision is for the same title that is currently being parsed.
1194 // Use the title from Parser in case a new page ID was injected into it.
1195 $parserOutput->setFlag( 'vary-page-id' );
1196 $id = $parser->getTitle()->getArticleID();
1198 $parserOutput->setSpeculativePageIdUsed( $id );
1204 // Check the link cache for the title
1205 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1206 $pdbk = $t->getPrefixedDBkey();
1207 $id = $linkCache->getGoodLinkID( $pdbk );
1208 if ( $id != 0 ||
$linkCache->isBadLink( $pdbk ) ) {
1209 $parserOutput->addLink( $t, $id );
1214 // We need to load it from the DB, so mark expensive
1215 if ( $parser->incrementExpensiveFunctionCount() ) {
1216 $id = $t->getArticleID();
1217 $parserOutput->addLink( $t, $id );
1226 * Get the id from the last revision of a specified page.
1227 * @param Parser $parser
1228 * @param string|null $title Title to get the id from
1229 * @return int|null|string
1232 public static function revisionid( $parser, $title = null ) {
1233 $t = Title
::newFromText( $title );
1234 if ( is_null( $t ) ) {
1237 // fetch revision from cache/database and return the value
1238 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-id' );
1239 return $rev ?
$rev->getId() : '';
1243 * Get the day from the last revision of a specified page.
1244 * @param Parser $parser
1245 * @param string|null $title Title to get the day from
1249 public static function revisionday( $parser, $title = null ) {
1250 $t = Title
::newFromText( $title );
1251 if ( is_null( $t ) ) {
1254 // fetch revision from cache/database and return the value
1255 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1256 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'j' ) : '';
1260 * Get the day with leading zeros from the last revision of a specified page.
1261 * @param Parser $parser
1262 * @param string|null $title Title to get the day from
1266 public static function revisionday2( $parser, $title = null ) {
1267 $t = Title
::newFromText( $title );
1268 if ( is_null( $t ) ) {
1271 // fetch revision from cache/database and return the value
1272 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1273 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'd' ) : '';
1277 * Get the month with leading zeros from the last revision of a specified page.
1278 * @param Parser $parser
1279 * @param string|null $title Title to get the month from
1283 public static function revisionmonth( $parser, $title = null ) {
1284 $t = Title
::newFromText( $title );
1285 if ( is_null( $t ) ) {
1288 // fetch revision from cache/database and return the value
1289 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1290 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'm' ) : '';
1294 * Get the month from the last revision of a specified page.
1295 * @param Parser $parser
1296 * @param string|null $title Title to get the month from
1300 public static function revisionmonth1( $parser, $title = null ) {
1301 $t = Title
::newFromText( $title );
1302 if ( is_null( $t ) ) {
1305 // fetch revision from cache/database and return the value
1306 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1307 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'n' ) : '';
1311 * Get the year from the last revision of a specified page.
1312 * @param Parser $parser
1313 * @param string|null $title Title to get the year from
1317 public static function revisionyear( $parser, $title = null ) {
1318 $t = Title
::newFromText( $title );
1319 if ( is_null( $t ) ) {
1322 // fetch revision from cache/database and return the value
1323 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1324 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'Y' ) : '';
1328 * Get the timestamp from the last revision of a specified page.
1329 * @param Parser $parser
1330 * @param string|null $title Title to get the timestamp from
1334 public static function revisiontimestamp( $parser, $title = null ) {
1335 $t = Title
::newFromText( $title );
1336 if ( is_null( $t ) ) {
1339 // fetch revision from cache/database and return the value
1340 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-revision-timestamp' );
1341 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'YmdHis' ) : '';
1345 * Get the user from the last revision of a specified page.
1346 * @param Parser $parser
1347 * @param string|null $title Title to get the user from
1351 public static function revisionuser( $parser, $title = null ) {
1352 $t = Title
::newFromText( $title );
1353 if ( is_null( $t ) ) {
1356 // fetch revision from cache/database and return the value
1357 $rev = self
::getCachedRevisionObject( $parser, $t, 'vary-user' );
1358 return $rev ?
$rev->getUserText() : '';
1362 * Returns the sources of any cascading protection acting on a specified page.
1363 * Pages will not return their own title unless they transclude themselves.
1364 * This is an expensive parser function and can't be called too many times per page,
1365 * unless cascading protection sources for the page have already been loaded.
1367 * @param Parser $parser
1368 * @param string $title
1373 public static function cascadingsources( $parser, $title = '' ) {
1374 $titleObject = Title
::newFromText( $title ) ??
$parser->getTitle();
1375 if ( $titleObject->areCascadeProtectionSourcesLoaded()
1376 ||
$parser->incrementExpensiveFunctionCount()
1379 $sources = $titleObject->getCascadeProtectionSources();
1380 foreach ( $sources[0] as $sourceTitle ) {
1381 $names[] = $sourceTitle->getPrefixedText();
1383 return implode( '|', $names );