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->mTitle
) )
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() );
517 public static function numberofactiveusers( $parser, $raw = null ) {
518 return self
::formatRaw( SiteStats
::activeUsers(), $raw, $parser->getFunctionLang() );
521 public static function numberofarticles( $parser, $raw = null ) {
522 return self
::formatRaw( SiteStats
::articles(), $raw, $parser->getFunctionLang() );
525 public static function numberoffiles( $parser, $raw = null ) {
526 return self
::formatRaw( SiteStats
::images(), $raw, $parser->getFunctionLang() );
529 public static function numberofadmins( $parser, $raw = null ) {
530 return self
::formatRaw(
531 SiteStats
::numberingroup( 'sysop' ),
533 $parser->getFunctionLang()
537 public static function numberofedits( $parser, $raw = null ) {
538 return self
::formatRaw( SiteStats
::edits(), $raw, $parser->getFunctionLang() );
541 public static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
542 return self
::formatRaw(
543 SiteStats
::pagesInNs( intval( $namespace ) ),
545 $parser->getFunctionLang()
548 public static function numberingroup( $parser, $name = '', $raw = null ) {
549 return self
::formatRaw(
550 SiteStats
::numberingroup( strtolower( $name ) ),
552 $parser->getFunctionLang()
557 * Given a title, return the namespace name that would be given by the
558 * corresponding magic word
559 * Note: function name changed to "mwnamespace" rather than "namespace"
560 * to not break PHP 5.3
561 * @param Parser $parser
562 * @param string|null $title
563 * @return mixed|string
565 public static function mwnamespace( $parser, $title = null ) {
566 $t = Title
::newFromText( $title );
567 if ( is_null( $t ) ) {
570 return str_replace( '_', ' ', $t->getNsText() );
572 public static function namespacee( $parser, $title = null ) {
573 $t = Title
::newFromText( $title );
574 if ( is_null( $t ) ) {
577 return wfUrlencode( $t->getNsText() );
579 public static function namespacenumber( $parser, $title = null ) {
580 $t = Title
::newFromText( $title );
581 if ( is_null( $t ) ) {
584 return $t->getNamespace();
586 public static function talkspace( $parser, $title = null ) {
587 $t = Title
::newFromText( $title );
588 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
591 return str_replace( '_', ' ', $t->getTalkNsText() );
593 public static function talkspacee( $parser, $title = null ) {
594 $t = Title
::newFromText( $title );
595 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
598 return wfUrlencode( $t->getTalkNsText() );
600 public static function subjectspace( $parser, $title = null ) {
601 $t = Title
::newFromText( $title );
602 if ( is_null( $t ) ) {
605 return str_replace( '_', ' ', $t->getSubjectNsText() );
607 public static function subjectspacee( $parser, $title = null ) {
608 $t = Title
::newFromText( $title );
609 if ( is_null( $t ) ) {
612 return wfUrlencode( $t->getSubjectNsText() );
616 * Functions to get and normalize pagenames, corresponding to the magic words
618 * @param Parser $parser
619 * @param string|null $title
622 public static function pagename( $parser, $title = null ) {
623 $t = Title
::newFromText( $title );
624 if ( is_null( $t ) ) {
627 return wfEscapeWikiText( $t->getText() );
629 public static function pagenamee( $parser, $title = null ) {
630 $t = Title
::newFromText( $title );
631 if ( is_null( $t ) ) {
634 return wfEscapeWikiText( $t->getPartialURL() );
636 public static function fullpagename( $parser, $title = null ) {
637 $t = Title
::newFromText( $title );
638 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
641 return wfEscapeWikiText( $t->getPrefixedText() );
643 public static function fullpagenamee( $parser, $title = null ) {
644 $t = Title
::newFromText( $title );
645 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
648 return wfEscapeWikiText( $t->getPrefixedURL() );
650 public static function subpagename( $parser, $title = null ) {
651 $t = Title
::newFromText( $title );
652 if ( is_null( $t ) ) {
655 return wfEscapeWikiText( $t->getSubpageText() );
657 public static function subpagenamee( $parser, $title = null ) {
658 $t = Title
::newFromText( $title );
659 if ( is_null( $t ) ) {
662 return wfEscapeWikiText( $t->getSubpageUrlForm() );
664 public static function rootpagename( $parser, $title = null ) {
665 $t = Title
::newFromText( $title );
666 if ( is_null( $t ) ) {
669 return wfEscapeWikiText( $t->getRootText() );
671 public static function rootpagenamee( $parser, $title = null ) {
672 $t = Title
::newFromText( $title );
673 if ( is_null( $t ) ) {
676 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getRootText() ) ) );
678 public static function basepagename( $parser, $title = null ) {
679 $t = Title
::newFromText( $title );
680 if ( is_null( $t ) ) {
683 return wfEscapeWikiText( $t->getBaseText() );
685 public static function basepagenamee( $parser, $title = null ) {
686 $t = Title
::newFromText( $title );
687 if ( is_null( $t ) ) {
690 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getBaseText() ) ) );
692 public static function talkpagename( $parser, $title = null ) {
693 $t = Title
::newFromText( $title );
694 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
697 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
699 public static function talkpagenamee( $parser, $title = null ) {
700 $t = Title
::newFromText( $title );
701 if ( is_null( $t ) ||
!$t->canHaveTalkPage() ) {
704 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedURL() );
706 public static function subjectpagename( $parser, $title = null ) {
707 $t = Title
::newFromText( $title );
708 if ( is_null( $t ) ) {
711 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
713 public static function subjectpagenamee( $parser, $title = null ) {
714 $t = Title
::newFromText( $title );
715 if ( is_null( $t ) ) {
718 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedURL() );
722 * Return the number of pages, files or subcats in the given category,
723 * or 0 if it's nonexistent. This is an expensive parser function and
724 * can't be called too many times per page.
725 * @param Parser $parser
726 * @param string $name
727 * @param string|null $arg1
728 * @param string|null $arg2
731 public static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
732 static $magicWords = null;
733 if ( is_null( $magicWords ) ) {
734 $magicWords = $parser->getMagicWordFactory()->newArray( [
735 'pagesincategory_all',
736 'pagesincategory_pages',
737 'pagesincategory_subcats',
738 'pagesincategory_files'
743 // split the given option to its variable
744 if ( self
::matchAgainstMagicword( $parser->getMagicWordFactory(), 'rawsuffix', $arg1 ) ) {
745 // {{pagesincategory:|raw[|type]}}
747 $type = $magicWords->matchStartToEnd( $arg2 );
749 // {{pagesincategory:[|type[|raw]]}}
750 $type = $magicWords->matchStartToEnd( $arg1 );
753 if ( !$type ) { // backward compatibility
754 $type = 'pagesincategory_all';
757 $title = Title
::makeTitleSafe( NS_CATEGORY
, $name );
758 if ( !$title ) { # invalid title
759 return self
::formatRaw( 0, $raw, $parser->getFunctionLang() );
761 $parser->getContentLanguage()->findVariantLink( $name, $title, true );
763 // Normalize name for cache
764 $name = $title->getDBkey();
766 if ( !isset( $cache[$name] ) ) {
767 $category = Category
::newFromTitle( $title );
769 $allCount = $subcatCount = $fileCount = $pagesCount = 0;
770 if ( $parser->incrementExpensiveFunctionCount() ) {
771 // $allCount is the total number of cat members,
772 // not the count of how many members are normal pages.
773 $allCount = (int)$category->getPageCount();
774 $subcatCount = (int)$category->getSubcatCount();
775 $fileCount = (int)$category->getFileCount();
776 $pagesCount = $allCount - $subcatCount - $fileCount;
778 $cache[$name]['pagesincategory_all'] = $allCount;
779 $cache[$name]['pagesincategory_pages'] = $pagesCount;
780 $cache[$name]['pagesincategory_subcats'] = $subcatCount;
781 $cache[$name]['pagesincategory_files'] = $fileCount;
784 $count = $cache[$name][$type];
785 return self
::formatRaw( $count, $raw, $parser->getFunctionLang() );
789 * Return the size of the given page, or 0 if it's nonexistent. This is an
790 * expensive parser function and can't be called too many times per page.
792 * @param Parser $parser
793 * @param string $page Name of page to check (Default: empty string)
794 * @param string|null $raw Should number be human readable with commas or just number
797 public static function pagesize( $parser, $page = '', $raw = null ) {
798 $title = Title
::newFromText( $page );
800 if ( !is_object( $title ) ) {
801 return self
::formatRaw( 0, $raw, $parser->getFunctionLang() );
804 // fetch revision from cache/database and return the value
805 $rev = self
::getCachedRevisionObject( $parser, $title );
806 $length = $rev ?
$rev->getSize() : 0;
807 if ( $length === null ) {
808 // We've had bugs where rev_len was not being recorded for empty pages, see T135414
811 return self
::formatRaw( $length, $raw, $parser->getFunctionLang() );
815 * Returns the requested protection level for the current page. This
816 * is an expensive parser function and can't be called too many times
817 * per page, unless the protection levels/expiries for the given title
818 * have already been retrieved
820 * @param Parser $parser
821 * @param string $type
822 * @param string $title
826 public static function protectionlevel( $parser, $type = '', $title = '' ) {
827 $titleObject = Title
::newFromText( $title );
828 if ( !( $titleObject instanceof Title
) ) {
829 $titleObject = $parser->mTitle
;
831 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
832 $restrictions = $titleObject->getRestrictions( strtolower( $type ) );
833 # Title::getRestrictions returns an array, its possible it may have
834 # multiple values in the future
835 return implode( ',', $restrictions );
841 * Returns the requested protection expiry for the current page. This
842 * is an expensive parser function and can't be called too many times
843 * per page, unless the protection levels/expiries for the given title
844 * have already been retrieved
846 * @param Parser $parser
847 * @param string $type
848 * @param string $title
852 public static function protectionexpiry( $parser, $type = '', $title = '' ) {
853 $titleObject = Title
::newFromText( $title );
854 if ( !( $titleObject instanceof Title
) ) {
855 $titleObject = $parser->mTitle
;
857 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
858 $expiry = $titleObject->getRestrictionExpiry( strtolower( $type ) );
859 // getRestrictionExpiry() returns false on invalid type; trying to
860 // match protectionlevel() function that returns empty string instead
861 if ( $expiry === false ) {
870 * Gives language names.
871 * @param Parser $parser
872 * @param string $code Language code (of which to get name)
873 * @param string $inLanguage Language code (in which to get name)
876 public static function language( $parser, $code = '', $inLanguage = '' ) {
877 $code = strtolower( $code );
878 $inLanguage = strtolower( $inLanguage );
879 $lang = Language
::fetchLanguageName( $code, $inLanguage );
880 return $lang !== '' ?
$lang : LanguageCode
::bcp47( $code );
884 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
885 * @param Parser $parser
886 * @param string $string
887 * @param string $length
888 * @param string $padding
889 * @param int $direction
892 public static function pad(
893 $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
895 $padding = $parser->killMarkers( $padding );
896 $lengthOfPadding = mb_strlen( $padding );
897 if ( $lengthOfPadding == 0 ) {
901 # The remaining length to add counts down to 0 as padding is added
902 $length = min( (int)$length, 500 ) - mb_strlen( $string );
903 if ( $length <= 0 ) {
908 # $finalPadding is just $padding repeated enough times so that
909 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
911 while ( $length > 0 ) {
912 # If $length < $lengthofPadding, truncate $padding so we get the
913 # exact length desired.
914 $finalPadding .= mb_substr( $padding, 0, $length );
915 $length -= $lengthOfPadding;
918 if ( $direction == STR_PAD_LEFT
) {
919 return $finalPadding . $string;
921 return $string . $finalPadding;
925 public static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
926 return self
::pad( $parser, $string, $length, $padding, STR_PAD_LEFT
);
929 public static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
930 return self
::pad( $parser, $string, $length, $padding );
934 * @param Parser $parser
935 * @param string $text
938 public static function anchorencode( $parser, $text ) {
939 $text = $parser->killMarkers( $text );
940 $section = (string)substr( $parser->guessSectionNameFromWikiText( $text ), 1 );
941 return Sanitizer
::safeEncodeAttribute( $section );
944 public static function special( $parser, $text ) {
945 list( $page, $subpage ) = MediaWikiServices
::getInstance()->getSpecialPageFactory()->
946 resolveAlias( $text );
948 $title = SpecialPage
::getTitleFor( $page, $subpage );
949 return $title->getPrefixedText();
951 // unknown special page, just use the given text as its title, if at all possible
952 $title = Title
::makeTitleSafe( NS_SPECIAL
, $text );
953 return $title ?
$title->getPrefixedText() : self
::special( $parser, 'Badtitle' );
957 public static function speciale( $parser, $text ) {
958 return wfUrlencode( str_replace( ' ', '_', self
::special( $parser, $text ) ) );
962 * @param Parser $parser
963 * @param string $text The sortkey to use
964 * @param string $uarg Either "noreplace" or "noerror" (in en)
965 * both suppress errors, and noreplace does nothing if
966 * a default sortkey already exists.
969 public static function defaultsort( $parser, $text, $uarg = '' ) {
970 static $magicWords = null;
971 if ( is_null( $magicWords ) ) {
972 $magicWords = $parser->getMagicWordFactory()->newArray(
973 [ 'defaultsort_noerror', 'defaultsort_noreplace' ] );
975 $arg = $magicWords->matchStartToEnd( $uarg );
977 $text = trim( $text );
978 if ( strlen( $text ) == 0 ) {
981 $old = $parser->getCustomDefaultSort();
982 if ( $old === false ||
$arg !== 'defaultsort_noreplace' ) {
983 $parser->setDefaultSort( $text );
986 if ( $old === false ||
$old == $text ||
$arg ) {
989 $converter = $parser->getTargetLanguage()->getConverter();
990 return '<span class="error">' .
991 wfMessage( 'duplicate-defaultsort',
992 // Message should be parsed, but these params should only be escaped.
993 $converter->markNoConversion( wfEscapeWikiText( $old ) ),
994 $converter->markNoConversion( wfEscapeWikiText( $text ) )
995 )->inContentLanguage()->text() .
1001 * Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}}
1002 * or {{filepath|300|nowiki}} or {{filepath|300px}}, {{filepath|200x300px}},
1003 * {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}.
1005 * @param Parser $parser
1006 * @param string $name
1007 * @param string $argA
1008 * @param string $argB
1009 * @return array|string
1011 public static function filepath( $parser, $name = '', $argA = '', $argB = '' ) {
1012 $file = wfFindFile( $name );
1014 if ( $argA == 'nowiki' ) {
1015 // {{filepath: | option [| size] }}
1017 $parsedWidthParam = Parser
::parseWidthParam( $argB );
1019 // {{filepath: [| size [|option]] }}
1020 $parsedWidthParam = Parser
::parseWidthParam( $argA );
1021 $isNowiki = ( $argB == 'nowiki' );
1025 $url = $file->getFullUrl();
1027 // If a size is requested...
1028 if ( count( $parsedWidthParam ) ) {
1029 $mto = $file->transform( $parsedWidthParam );
1031 if ( $mto && !$mto->isError() ) {
1032 // ... change the URL to point to a thumbnail.
1033 $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE
);
1037 return [ $url, 'nowiki' => true ];
1046 * Parser function to extension tag adaptor
1047 * @param Parser $parser
1048 * @param PPFrame $frame
1049 * @param PPNode[] $args
1052 public static function tagObj( $parser, $frame, $args ) {
1053 if ( !count( $args ) ) {
1056 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
1058 if ( count( $args ) ) {
1059 $inner = $frame->expand( array_shift( $args ) );
1065 foreach ( $args as $arg ) {
1066 $bits = $arg->splitArg();
1067 if ( strval( $bits['index'] ) === '' ) {
1068 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
1069 $value = trim( $frame->expand( $bits['value'] ) );
1070 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
1071 $value = $m[1] ??
'';
1073 $attributes[$name] = $value;
1077 $stripList = $parser->getStripList();
1078 if ( !in_array( $tagName, $stripList ) ) {
1079 // we can't handle this tag (at least not now), so just re-emit it as an ordinary tag
1081 foreach ( $attributes as $name => $value ) {
1082 $attrText .= ' ' . htmlspecialchars( $name ) . '="' . htmlspecialchars( $value ) . '"';
1084 if ( $inner === null ) {
1085 return "<$tagName$attrText/>";
1087 return "<$tagName$attrText>$inner</$tagName>";
1093 'attributes' => $attributes,
1094 'close' => "</$tagName>",
1096 return $parser->extensionSubstitution( $params, $frame );
1100 * Fetched the current revision of the given title and return this.
1101 * Will increment the expensive function count and
1102 * add a template link to get the value refreshed on changes.
1103 * For a given title, which is equal to the current parser title,
1104 * the revision object from the parser is used, when that is the current one
1106 * @param Parser $parser
1107 * @param Title $title
1111 private static function getCachedRevisionObject( $parser, $title = null ) {
1112 if ( is_null( $title ) ) {
1116 // Use the revision from the parser itself, when param is the current page
1117 // and the revision is the current one
1118 if ( $title->equals( $parser->getTitle() ) ) {
1119 $parserRev = $parser->getRevisionObject();
1120 if ( $parserRev && $parserRev->isCurrent() ) {
1121 // force reparse after edit with vary-revision flag
1122 $parser->getOutput()->setFlag( 'vary-revision' );
1123 wfDebug( __METHOD__
. ": use current revision from parser, setting vary-revision...\n" );
1128 // Normalize name for cache
1129 $page = $title->getPrefixedDBkey();
1131 if ( !( $parser->currentRevisionCache
&& $parser->currentRevisionCache
->has( $page ) )
1132 && !$parser->incrementExpensiveFunctionCount() ) {
1135 $rev = $parser->fetchCurrentRevisionOfTitle( $title );
1136 $pageID = $rev ?
$rev->getPage() : 0;
1137 $revID = $rev ?
$rev->getId() : 0;
1139 // Register dependency in templatelinks
1140 $parser->getOutput()->addTemplate( $title, $pageID, $revID );
1146 * Get the pageid of a specified page
1147 * @param Parser $parser
1148 * @param string|null $title Title to get the pageid from
1149 * @return int|null|string
1152 public static function pageid( $parser, $title = null ) {
1153 $t = Title
::newFromText( $title );
1154 if ( is_null( $t ) ) {
1157 // Use title from parser to have correct pageid after edit
1158 if ( $t->equals( $parser->getTitle() ) ) {
1159 $t = $parser->getTitle();
1160 return $t->getArticleID();
1163 // These can't have ids
1164 if ( !$t->canExist() ||
$t->isExternal() ) {
1168 // Check the link cache, maybe something already looked it up.
1169 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1170 $pdbk = $t->getPrefixedDBkey();
1171 $id = $linkCache->getGoodLinkID( $pdbk );
1173 $parser->mOutput
->addLink( $t, $id );
1176 if ( $linkCache->isBadLink( $pdbk ) ) {
1177 $parser->mOutput
->addLink( $t, 0 );
1181 // We need to load it from the DB, so mark expensive
1182 if ( $parser->incrementExpensiveFunctionCount() ) {
1183 $id = $t->getArticleID();
1184 $parser->mOutput
->addLink( $t, $id );
1191 * Get the id from the last revision of a specified page.
1192 * @param Parser $parser
1193 * @param string|null $title Title to get the id from
1194 * @return int|null|string
1197 public static function revisionid( $parser, $title = null ) {
1198 $t = Title
::newFromText( $title );
1199 if ( is_null( $t ) ) {
1202 // fetch revision from cache/database and return the value
1203 $rev = self
::getCachedRevisionObject( $parser, $t );
1204 return $rev ?
$rev->getId() : '';
1208 * Get the day from the last revision of a specified page.
1209 * @param Parser $parser
1210 * @param string|null $title Title to get the day from
1214 public static function revisionday( $parser, $title = null ) {
1215 $t = Title
::newFromText( $title );
1216 if ( is_null( $t ) ) {
1219 // fetch revision from cache/database and return the value
1220 $rev = self
::getCachedRevisionObject( $parser, $t );
1221 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'j' ) : '';
1225 * Get the day with leading zeros from the last revision of a specified page.
1226 * @param Parser $parser
1227 * @param string|null $title Title to get the day from
1231 public static function revisionday2( $parser, $title = null ) {
1232 $t = Title
::newFromText( $title );
1233 if ( is_null( $t ) ) {
1236 // fetch revision from cache/database and return the value
1237 $rev = self
::getCachedRevisionObject( $parser, $t );
1238 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'd' ) : '';
1242 * Get the month with leading zeros from the last revision of a specified page.
1243 * @param Parser $parser
1244 * @param string|null $title Title to get the month from
1248 public static function revisionmonth( $parser, $title = null ) {
1249 $t = Title
::newFromText( $title );
1250 if ( is_null( $t ) ) {
1253 // fetch revision from cache/database and return the value
1254 $rev = self
::getCachedRevisionObject( $parser, $t );
1255 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'm' ) : '';
1259 * Get the month from the last revision of a specified page.
1260 * @param Parser $parser
1261 * @param string|null $title Title to get the month from
1265 public static function revisionmonth1( $parser, $title = null ) {
1266 $t = Title
::newFromText( $title );
1267 if ( is_null( $t ) ) {
1270 // fetch revision from cache/database and return the value
1271 $rev = self
::getCachedRevisionObject( $parser, $t );
1272 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'n' ) : '';
1276 * Get the year from the last revision of a specified page.
1277 * @param Parser $parser
1278 * @param string|null $title Title to get the year from
1282 public static function revisionyear( $parser, $title = null ) {
1283 $t = Title
::newFromText( $title );
1284 if ( is_null( $t ) ) {
1287 // fetch revision from cache/database and return the value
1288 $rev = self
::getCachedRevisionObject( $parser, $t );
1289 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'Y' ) : '';
1293 * Get the timestamp from the last revision of a specified page.
1294 * @param Parser $parser
1295 * @param string|null $title Title to get the timestamp from
1299 public static function revisiontimestamp( $parser, $title = null ) {
1300 $t = Title
::newFromText( $title );
1301 if ( is_null( $t ) ) {
1304 // fetch revision from cache/database and return the value
1305 $rev = self
::getCachedRevisionObject( $parser, $t );
1306 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'YmdHis' ) : '';
1310 * Get the user from the last revision of a specified page.
1311 * @param Parser $parser
1312 * @param string|null $title Title to get the user from
1316 public static function revisionuser( $parser, $title = null ) {
1317 $t = Title
::newFromText( $title );
1318 if ( is_null( $t ) ) {
1321 // fetch revision from cache/database and return the value
1322 $rev = self
::getCachedRevisionObject( $parser, $t );
1323 return $rev ?
$rev->getUserText() : '';
1327 * Returns the sources of any cascading protection acting on a specified page.
1328 * Pages will not return their own title unless they transclude themselves.
1329 * This is an expensive parser function and can't be called too many times per page,
1330 * unless cascading protection sources for the page have already been loaded.
1332 * @param Parser $parser
1333 * @param string $title
1338 public static function cascadingsources( $parser, $title = '' ) {
1339 $titleObject = Title
::newFromText( $title );
1340 if ( !( $titleObject instanceof Title
) ) {
1341 $titleObject = $parser->mTitle
;
1343 if ( $titleObject->areCascadeProtectionSourcesLoaded()
1344 ||
$parser->incrementExpensiveFunctionCount()
1347 $sources = $titleObject->getCascadeProtectionSources();
1348 foreach ( $sources[0] as $sourceTitle ) {
1349 $names[] = $sourceTitle->getPrefixedText();
1351 return implode( '|', $names );