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
25 * Various core parser functions, registered in Parser::firstCallInit()
28 class CoreParserFunctions
{
30 * @param Parser $parser
33 public static function register( $parser ) {
34 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
36 # Syntax for arguments (see Parser::setFunctionHook):
37 # "name for lookup in localized magic words array",
39 # optional Parser::SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}}
40 # instead of {{#int:...}})
42 'ns', 'nse', 'urlencode', 'lcfirst', 'ucfirst', 'lc', 'uc',
43 'localurl', 'localurle', 'fullurl', 'fullurle', 'canonicalurl',
44 'canonicalurle', 'formatnum', 'grammar', 'gender', 'plural', 'bidi',
45 'numberofpages', 'numberofusers', 'numberofactiveusers',
46 'numberofarticles', 'numberoffiles', 'numberofadmins',
47 'numberingroup', 'numberofedits', 'language',
48 'padleft', 'padright', 'anchorencode', 'defaultsort', 'filepath',
49 'pagesincategory', 'pagesize', 'protectionlevel', 'protectionexpiry',
50 'namespacee', 'namespacenumber', 'talkspace', 'talkspacee',
51 'subjectspace', 'subjectspacee', 'pagename', 'pagenamee',
52 'fullpagename', 'fullpagenamee', 'rootpagename', 'rootpagenamee',
53 'basepagename', 'basepagenamee', 'subpagename', 'subpagenamee',
54 'talkpagename', 'talkpagenamee', 'subjectpagename',
55 'subjectpagenamee', 'pageid', 'revisionid', 'revisionday',
56 'revisionday2', 'revisionmonth', 'revisionmonth1', 'revisionyear',
57 'revisiontimestamp', 'revisionuser', 'cascadingsources',
59 foreach ( $noHashFunctions as $func ) {
60 $parser->setFunctionHook( $func, [ __CLASS__
, $func ], Parser
::SFH_NO_HASH
);
63 $parser->setFunctionHook(
65 [ __CLASS__
, 'mwnamespace' ],
68 $parser->setFunctionHook( 'int', [ __CLASS__
, 'intFunction' ], Parser
::SFH_NO_HASH
);
69 $parser->setFunctionHook( 'special', [ __CLASS__
, 'special' ] );
70 $parser->setFunctionHook( 'speciale', [ __CLASS__
, 'speciale' ] );
71 $parser->setFunctionHook( 'tag', [ __CLASS__
, 'tagObj' ], Parser
::SFH_OBJECT_ARGS
);
72 $parser->setFunctionHook( 'formatdate', [ __CLASS__
, 'formatDate' ] );
74 if ( $wgAllowDisplayTitle ) {
75 $parser->setFunctionHook(
77 [ __CLASS__
, 'displaytitle' ],
81 if ( $wgAllowSlowParserFunctions ) {
82 $parser->setFunctionHook(
84 [ __CLASS__
, 'pagesinnamespace' ],
91 * @param Parser $parser
92 * @param string $part1
95 public static function intFunction( $parser, $part1 = '' /*, ... */ ) {
96 if ( strval( $part1 ) !== '' ) {
97 $args = array_slice( func_get_args(), 2 );
98 $message = wfMessage( $part1, $args )
99 ->inLanguage( $parser->getOptions()->getUserLangObj() );
100 if ( !$message->exists() ) {
101 // When message does not exists, the message name is surrounded by angle
102 // and can result in a tag, therefore escape the angles
103 return $message->escaped();
105 return [ $message->plain(), 'noparse' => false ];
107 return [ 'found' => false ];
112 * @param Parser $parser
113 * @param string $date
114 * @param string $defaultPref
118 public static function formatDate( $parser, $date, $defaultPref = null ) {
119 $lang = $parser->getFunctionLang();
120 $df = DateFormatter
::getInstance( $lang );
122 $date = trim( $date );
124 $pref = $parser->getOptions()->getDateFormat();
126 // Specify a different default date format other than the normal default
127 // if the user has 'default' for their setting
128 if ( $pref == 'default' && $defaultPref ) {
129 $pref = $defaultPref;
132 $date = $df->reformat( $pref, $date, [ 'match-whole' ] );
136 public static function ns( $parser, $part1 = '' ) {
138 if ( intval( $part1 ) ||
$part1 == "0" ) {
139 $index = intval( $part1 );
141 $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
143 if ( $index !== false ) {
144 return $wgContLang->getFormattedNsText( $index );
146 return [ 'found' => false ];
150 public static function nse( $parser, $part1 = '' ) {
151 $ret = self
::ns( $parser, $part1 );
152 if ( is_string( $ret ) ) {
153 $ret = wfUrlencode( str_replace( ' ', '_', $ret ) );
159 * urlencodes a string according to one of three patterns: (bug 22474)
161 * By default (for HTTP "query" strings), spaces are encoded as '+'.
162 * Or to encode a value for the HTTP "path", spaces are encoded as '%20'.
163 * For links to "wiki"s, or similar software, spaces are encoded as '_',
165 * @param Parser $parser
166 * @param string $s The text to encode.
167 * @param string $arg (optional): The type of encoding.
170 public static function urlencode( $parser, $s = '', $arg = null ) {
171 static $magicWords = null;
172 if ( is_null( $magicWords ) ) {
173 $magicWords = new MagicWordArray( [ 'url_path', 'url_query', 'url_wiki' ] );
175 switch ( $magicWords->matchStartToEnd( $arg ) ) {
177 // Encode as though it's a wiki page, '_' for ' '.
179 $func = 'wfUrlencode';
180 $s = str_replace( ' ', '_', $s );
183 // Encode for an HTTP Path, '%20' for ' '.
185 $func = 'rawurlencode';
188 // Encode for HTTP query, '+' for ' '.
193 // See T105242, where the choice to kill markers and various
194 // other options were discussed.
195 return $func( $parser->killMarkers( $s ) );
198 public static function lcfirst( $parser, $s = '' ) {
200 return $wgContLang->lcfirst( $s );
203 public static function ucfirst( $parser, $s = '' ) {
205 return $wgContLang->ucfirst( $s );
209 * @param Parser $parser
213 public static function lc( $parser, $s = '' ) {
215 return $parser->markerSkipCallback( $s, [ $wgContLang, 'lc' ] );
219 * @param Parser $parser
223 public static function uc( $parser, $s = '' ) {
225 return $parser->markerSkipCallback( $s, [ $wgContLang, 'uc' ] );
228 public static function localurl( $parser, $s = '', $arg = null ) {
229 return self
::urlFunction( 'getLocalURL', $s, $arg );
232 public static function localurle( $parser, $s = '', $arg = null ) {
233 $temp = self
::urlFunction( 'getLocalURL', $s, $arg );
234 if ( !is_string( $temp ) ) {
237 return htmlspecialchars( $temp );
241 public static function fullurl( $parser, $s = '', $arg = null ) {
242 return self
::urlFunction( 'getFullURL', $s, $arg );
245 public static function fullurle( $parser, $s = '', $arg = null ) {
246 $temp = self
::urlFunction( 'getFullURL', $s, $arg );
247 if ( !is_string( $temp ) ) {
250 return htmlspecialchars( $temp );
254 public static function canonicalurl( $parser, $s = '', $arg = null ) {
255 return self
::urlFunction( 'getCanonicalURL', $s, $arg );
258 public static function canonicalurle( $parser, $s = '', $arg = null ) {
259 $temp = self
::urlFunction( 'getCanonicalURL', $s, $arg );
260 if ( !is_string( $temp ) ) {
263 return htmlspecialchars( $temp );
267 public static function urlFunction( $func, $s = '', $arg = null ) {
268 $title = Title
::newFromText( $s );
269 # Due to order of execution of a lot of bits, the values might be encoded
270 # before arriving here; if that's true, then the title can't be created
271 # and the variable will fail. If we can't get a decent title from the first
272 # attempt, url-decode and try for a second.
273 if ( is_null( $title ) ) {
274 $title = Title
::newFromURL( urldecode( $s ) );
276 if ( !is_null( $title ) ) {
277 # Convert NS_MEDIA -> NS_FILE
278 if ( $title->getNamespace() == NS_MEDIA
) {
279 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
281 if ( !is_null( $arg ) ) {
282 $text = $title->$func( $arg );
284 $text = $title->$func();
288 return [ 'found' => false ];
293 * @param Parser $parser
298 public static function formatnum( $parser, $num = '', $arg = null ) {
299 if ( self
::matchAgainstMagicword( 'rawsuffix', $arg ) ) {
300 $func = [ $parser->getFunctionLang(), 'parseFormattedNumber' ];
301 } elseif ( self
::matchAgainstMagicword( 'nocommafysuffix', $arg ) ) {
302 $func = [ $parser->getFunctionLang(), 'formatNumNoSeparators' ];
304 $func = [ $parser->getFunctionLang(), 'formatNum' ];
306 return $parser->markerSkipCallback( $num, $func );
310 * @param Parser $parser
311 * @param string $case
312 * @param string $word
315 public static function grammar( $parser, $case = '', $word = '' ) {
316 $word = $parser->killMarkers( $word );
317 return $parser->getFunctionLang()->convertGrammar( $word, $case );
321 * @param Parser $parser
322 * @param string $username
325 public static function gender( $parser, $username ) {
326 $forms = array_slice( func_get_args(), 2 );
328 // Some shortcuts to avoid loading user data unnecessarily
329 if ( count( $forms ) === 0 ) {
331 } elseif ( count( $forms ) === 1 ) {
335 $username = trim( $username );
338 $gender = User
::getDefaultOption( 'gender' );
341 $title = Title
::newFromText( $username );
343 if ( $title && $title->getNamespace() == NS_USER
) {
344 $username = $title->getText();
347 // check parameter, or use the ParserOptions if in interface message
348 $user = User
::newFromName( $username );
350 $gender = GenderCache
::singleton()->getGenderOf( $user, __METHOD__
);
351 } elseif ( $username === '' && $parser->getOptions()->getInterfaceMessage() ) {
352 $gender = GenderCache
::singleton()->getGenderOf( $parser->getOptions()->getUser(), __METHOD__
);
354 $ret = $parser->getFunctionLang()->gender( $gender, $forms );
359 * @param Parser $parser
360 * @param string $text
363 public static function plural( $parser, $text = '' ) {
364 $forms = array_slice( func_get_args(), 2 );
365 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
366 settype( $text, ctype_digit( $text ) ?
'int' : 'float' );
367 return $parser->getFunctionLang()->convertPlural( $text, $forms );
371 * @param Parser $parser
372 * @param string $text
375 public static function bidi( $parser, $text = '' ) {
376 return $parser->getFunctionLang()->embedBidi( $text );
380 * Override the title of the page when viewed, provided we've been given a
381 * title which will normalise to the canonical title
383 * @param Parser $parser Parent parser
384 * @param string $text Desired title text
385 * @param string $uarg
388 public static function displaytitle( $parser, $text = '', $uarg = '' ) {
389 global $wgRestrictDisplayTitle;
391 static $magicWords = null;
392 if ( is_null( $magicWords ) ) {
393 $magicWords = new MagicWordArray( [ 'displaytitle_noerror', 'displaytitle_noreplace' ] );
395 $arg = $magicWords->matchStartToEnd( $uarg );
397 // parse a limited subset of wiki markup (just the single quote items)
398 $text = $parser->doQuotes( $text );
400 // remove stripped text (e.g. the UNIQ-QINU stuff) that was generated by tag extensions/whatever
401 $text = $parser->killMarkers( $text );
403 // list of disallowed tags for DISPLAYTITLE
404 // these will be escaped even though they are allowed in normal wiki text
405 $bad = [ 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'blockquote', 'ol', 'ul', 'li', 'hr',
406 'table', 'tr', 'th', 'td', 'dl', 'dd', 'caption', 'p', 'ruby', 'rb', 'rt', 'rtc', 'rp', 'br' ];
408 // disallow some styles that could be used to bypass $wgRestrictDisplayTitle
409 if ( $wgRestrictDisplayTitle ) {
410 $htmlTagsCallback = function ( &$params ) {
411 $decoded = Sanitizer
::decodeTagAttributes( $params );
413 if ( isset( $decoded['style'] ) ) {
414 // this is called later anyway, but we need it right now for the regexes below to be safe
415 // calling it twice doesn't hurt
416 $decoded['style'] = Sanitizer
::checkCss( $decoded['style'] );
418 if ( preg_match( '/(display|user-select|visibility)\s*:/i', $decoded['style'] ) ) {
419 $decoded['style'] = '/* attempt to bypass $wgRestrictDisplayTitle */';
423 $params = Sanitizer
::safeEncodeTagAttributes( $decoded );
426 $htmlTagsCallback = null;
429 // only requested titles that normalize to the actual title are allowed through
430 // if $wgRestrictDisplayTitle is true (it is by default)
431 // mimic the escaping process that occurs in OutputPage::setPageTitle
432 $text = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags(
439 $title = Title
::newFromText( Sanitizer
::stripAllTags( $text ) );
441 if ( !$wgRestrictDisplayTitle ||
442 ( $title instanceof Title
443 && !$title->hasFragment()
444 && $title->equals( $parser->mTitle
) )
446 $old = $parser->mOutput
->getProperty( 'displaytitle' );
447 if ( $old === false ||
$arg !== 'displaytitle_noreplace' ) {
448 $parser->mOutput
->setDisplayTitle( $text );
450 if ( $old !== false && $old !== $text && !$arg ) {
451 $converter = $parser->getConverterLanguage()->getConverter();
452 return '<span class="error">' .
453 wfMessage( 'duplicate-displaytitle',
454 // Message should be parsed, but these params should only be escaped.
455 $converter->markNoConversion( wfEscapeWikiText( $old ) ),
456 $converter->markNoConversion( wfEscapeWikiText( $text ) )
457 )->inContentLanguage()->text() .
463 $parser->addTrackingCategory( 'restricted-displaytitle-ignored' );
464 $converter = $parser->getConverterLanguage()->getConverter();
465 return '<span class="error">' .
466 wfMessage( 'restricted-displaytitle',
467 // Message should be parsed, but this param should only be escaped.
468 $converter->markNoConversion( wfEscapeWikiText( $text ) )
469 )->inContentLanguage()->text() .
475 * Matches the given value against the value of given magic word
477 * @param string $magicword Magic word key
478 * @param string $value Value to match
479 * @return bool True on successful match
481 private static function matchAgainstMagicword( $magicword, $value ) {
482 $value = trim( strval( $value ) );
483 if ( $value === '' ) {
486 $mwObject = MagicWord
::get( $magicword );
487 return $mwObject->matchStartToEnd( $value );
490 public static function formatRaw( $num, $raw ) {
491 if ( self
::matchAgainstMagicword( 'rawsuffix', $raw ) ) {
495 return $wgContLang->formatNum( $num );
498 public static function numberofpages( $parser, $raw = null ) {
499 return self
::formatRaw( SiteStats
::pages(), $raw );
501 public static function numberofusers( $parser, $raw = null ) {
502 return self
::formatRaw( SiteStats
::users(), $raw );
504 public static function numberofactiveusers( $parser, $raw = null ) {
505 return self
::formatRaw( SiteStats
::activeUsers(), $raw );
507 public static function numberofarticles( $parser, $raw = null ) {
508 return self
::formatRaw( SiteStats
::articles(), $raw );
510 public static function numberoffiles( $parser, $raw = null ) {
511 return self
::formatRaw( SiteStats
::images(), $raw );
513 public static function numberofadmins( $parser, $raw = null ) {
514 return self
::formatRaw( SiteStats
::numberingroup( 'sysop' ), $raw );
516 public static function numberofedits( $parser, $raw = null ) {
517 return self
::formatRaw( SiteStats
::edits(), $raw );
519 public static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
520 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
522 public static function numberingroup( $parser, $name = '', $raw = null ) {
523 return self
::formatRaw( SiteStats
::numberingroup( strtolower( $name ) ), $raw );
527 * Given a title, return the namespace name that would be given by the
528 * corresponding magic word
529 * Note: function name changed to "mwnamespace" rather than "namespace"
530 * to not break PHP 5.3
531 * @param Parser $parser
532 * @param string $title
533 * @return mixed|string
535 public static function mwnamespace( $parser, $title = null ) {
536 $t = Title
::newFromText( $title );
537 if ( is_null( $t ) ) {
540 return str_replace( '_', ' ', $t->getNsText() );
542 public static function namespacee( $parser, $title = null ) {
543 $t = Title
::newFromText( $title );
544 if ( is_null( $t ) ) {
547 return wfUrlencode( $t->getNsText() );
549 public static function namespacenumber( $parser, $title = null ) {
550 $t = Title
::newFromText( $title );
551 if ( is_null( $t ) ) {
554 return $t->getNamespace();
556 public static function talkspace( $parser, $title = null ) {
557 $t = Title
::newFromText( $title );
558 if ( is_null( $t ) ||
!$t->canTalk() ) {
561 return str_replace( '_', ' ', $t->getTalkNsText() );
563 public static function talkspacee( $parser, $title = null ) {
564 $t = Title
::newFromText( $title );
565 if ( is_null( $t ) ||
!$t->canTalk() ) {
568 return wfUrlencode( $t->getTalkNsText() );
570 public static function subjectspace( $parser, $title = null ) {
571 $t = Title
::newFromText( $title );
572 if ( is_null( $t ) ) {
575 return str_replace( '_', ' ', $t->getSubjectNsText() );
577 public static function subjectspacee( $parser, $title = null ) {
578 $t = Title
::newFromText( $title );
579 if ( is_null( $t ) ) {
582 return wfUrlencode( $t->getSubjectNsText() );
586 * Functions to get and normalize pagenames, corresponding to the magic words
588 * @param Parser $parser
589 * @param string $title
592 public static function pagename( $parser, $title = null ) {
593 $t = Title
::newFromText( $title );
594 if ( is_null( $t ) ) {
597 return wfEscapeWikiText( $t->getText() );
599 public static function pagenamee( $parser, $title = null ) {
600 $t = Title
::newFromText( $title );
601 if ( is_null( $t ) ) {
604 return wfEscapeWikiText( $t->getPartialURL() );
606 public static function fullpagename( $parser, $title = null ) {
607 $t = Title
::newFromText( $title );
608 if ( is_null( $t ) ||
!$t->canTalk() ) {
611 return wfEscapeWikiText( $t->getPrefixedText() );
613 public static function fullpagenamee( $parser, $title = null ) {
614 $t = Title
::newFromText( $title );
615 if ( is_null( $t ) ||
!$t->canTalk() ) {
618 return wfEscapeWikiText( $t->getPrefixedURL() );
620 public static function subpagename( $parser, $title = null ) {
621 $t = Title
::newFromText( $title );
622 if ( is_null( $t ) ) {
625 return wfEscapeWikiText( $t->getSubpageText() );
627 public static function subpagenamee( $parser, $title = null ) {
628 $t = Title
::newFromText( $title );
629 if ( is_null( $t ) ) {
632 return wfEscapeWikiText( $t->getSubpageUrlForm() );
634 public static function rootpagename( $parser, $title = null ) {
635 $t = Title
::newFromText( $title );
636 if ( is_null( $t ) ) {
639 return wfEscapeWikiText( $t->getRootText() );
641 public static function rootpagenamee( $parser, $title = null ) {
642 $t = Title
::newFromText( $title );
643 if ( is_null( $t ) ) {
646 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getRootText() ) ) );
648 public static function basepagename( $parser, $title = null ) {
649 $t = Title
::newFromText( $title );
650 if ( is_null( $t ) ) {
653 return wfEscapeWikiText( $t->getBaseText() );
655 public static function basepagenamee( $parser, $title = null ) {
656 $t = Title
::newFromText( $title );
657 if ( is_null( $t ) ) {
660 return wfEscapeWikiText( wfUrlencode( str_replace( ' ', '_', $t->getBaseText() ) ) );
662 public static function talkpagename( $parser, $title = null ) {
663 $t = Title
::newFromText( $title );
664 if ( is_null( $t ) ||
!$t->canTalk() ) {
667 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
669 public static function talkpagenamee( $parser, $title = null ) {
670 $t = Title
::newFromText( $title );
671 if ( is_null( $t ) ||
!$t->canTalk() ) {
674 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedURL() );
676 public static function subjectpagename( $parser, $title = null ) {
677 $t = Title
::newFromText( $title );
678 if ( is_null( $t ) ) {
681 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
683 public static function subjectpagenamee( $parser, $title = null ) {
684 $t = Title
::newFromText( $title );
685 if ( is_null( $t ) ) {
688 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedURL() );
692 * Return the number of pages, files or subcats in the given category,
693 * or 0 if it's nonexistent. This is an expensive parser function and
694 * can't be called too many times per page.
695 * @param Parser $parser
696 * @param string $name
697 * @param string $arg1
698 * @param string $arg2
701 public static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
703 static $magicWords = null;
704 if ( is_null( $magicWords ) ) {
705 $magicWords = new MagicWordArray( [
706 'pagesincategory_all',
707 'pagesincategory_pages',
708 'pagesincategory_subcats',
709 'pagesincategory_files'
714 // split the given option to its variable
715 if ( self
::matchAgainstMagicword( 'rawsuffix', $arg1 ) ) {
716 // {{pagesincategory:|raw[|type]}}
718 $type = $magicWords->matchStartToEnd( $arg2 );
720 // {{pagesincategory:[|type[|raw]]}}
721 $type = $magicWords->matchStartToEnd( $arg1 );
724 if ( !$type ) { // backward compatibility
725 $type = 'pagesincategory_all';
728 $title = Title
::makeTitleSafe( NS_CATEGORY
, $name );
729 if ( !$title ) { # invalid title
730 return self
::formatRaw( 0, $raw );
732 $wgContLang->findVariantLink( $name, $title, true );
734 // Normalize name for cache
735 $name = $title->getDBkey();
737 if ( !isset( $cache[$name] ) ) {
738 $category = Category
::newFromTitle( $title );
740 $allCount = $subcatCount = $fileCount = $pagesCount = 0;
741 if ( $parser->incrementExpensiveFunctionCount() ) {
742 // $allCount is the total number of cat members,
743 // not the count of how many members are normal pages.
744 $allCount = (int)$category->getPageCount();
745 $subcatCount = (int)$category->getSubcatCount();
746 $fileCount = (int)$category->getFileCount();
747 $pagesCount = $allCount - $subcatCount - $fileCount;
749 $cache[$name]['pagesincategory_all'] = $allCount;
750 $cache[$name]['pagesincategory_pages'] = $pagesCount;
751 $cache[$name]['pagesincategory_subcats'] = $subcatCount;
752 $cache[$name]['pagesincategory_files'] = $fileCount;
755 $count = $cache[$name][$type];
756 return self
::formatRaw( $count, $raw );
760 * Return the size of the given page, or 0 if it's nonexistent. This is an
761 * expensive parser function and can't be called too many times per page.
763 * @param Parser $parser
764 * @param string $page Name of page to check (Default: empty string)
765 * @param string $raw Should number be human readable with commas or just number
768 public static function pagesize( $parser, $page = '', $raw = null ) {
769 $title = Title
::newFromText( $page );
771 if ( !is_object( $title ) ) {
772 return self
::formatRaw( 0, $raw );
775 // fetch revision from cache/database and return the value
776 $rev = self
::getCachedRevisionObject( $parser, $title );
777 $length = $rev ?
$rev->getSize() : 0;
778 return self
::formatRaw( $length, $raw );
782 * Returns the requested protection level for the current page. This
783 * is an expensive parser function and can't be called too many times
784 * per page, unless the protection levels/expiries for the given title
785 * have already been retrieved
787 * @param Parser $parser
788 * @param string $type
789 * @param string $title
793 public static function protectionlevel( $parser, $type = '', $title = '' ) {
794 $titleObject = Title
::newFromText( $title );
795 if ( !( $titleObject instanceof Title
) ) {
796 $titleObject = $parser->mTitle
;
798 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
799 $restrictions = $titleObject->getRestrictions( strtolower( $type ) );
800 # Title::getRestrictions returns an array, its possible it may have
801 # multiple values in the future
802 return implode( $restrictions, ',' );
808 * Returns the requested protection expiry for the current page. This
809 * is an expensive parser function and can't be called too many times
810 * per page, unless the protection levels/expiries for the given title
811 * have already been retrieved
813 * @param Parser $parser
814 * @param string $type
815 * @param string $title
819 public static function protectionexpiry( $parser, $type = '', $title = '' ) {
820 $titleObject = Title
::newFromText( $title );
821 if ( !( $titleObject instanceof Title
) ) {
822 $titleObject = $parser->mTitle
;
824 if ( $titleObject->areRestrictionsLoaded() ||
$parser->incrementExpensiveFunctionCount() ) {
825 $expiry = $titleObject->getRestrictionExpiry( strtolower( $type ) );
826 // getRestrictionExpiry() returns false on invalid type; trying to
827 // match protectionlevel() function that returns empty string instead
828 if ( $expiry === false ) {
837 * Gives language names.
838 * @param Parser $parser
839 * @param string $code Language code (of which to get name)
840 * @param string $inLanguage Language code (in which to get name)
843 public static function language( $parser, $code = '', $inLanguage = '' ) {
844 $code = strtolower( $code );
845 $inLanguage = strtolower( $inLanguage );
846 $lang = Language
::fetchLanguageName( $code, $inLanguage );
847 return $lang !== '' ?
$lang : wfBCP47( $code );
851 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
852 * @param Parser $parser
853 * @param string $string
855 * @param string $padding
856 * @param int $direction
859 public static function pad(
860 $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
862 $padding = $parser->killMarkers( $padding );
863 $lengthOfPadding = mb_strlen( $padding );
864 if ( $lengthOfPadding == 0 ) {
868 # The remaining length to add counts down to 0 as padding is added
869 $length = min( $length, 500 ) - mb_strlen( $string );
870 # $finalPadding is just $padding repeated enough times so that
871 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
873 while ( $length > 0 ) {
874 # If $length < $lengthofPadding, truncate $padding so we get the
875 # exact length desired.
876 $finalPadding .= mb_substr( $padding, 0, $length );
877 $length -= $lengthOfPadding;
880 if ( $direction == STR_PAD_LEFT
) {
881 return $finalPadding . $string;
883 return $string . $finalPadding;
887 public static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
888 return self
::pad( $parser, $string, $length, $padding, STR_PAD_LEFT
);
891 public static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
892 return self
::pad( $parser, $string, $length, $padding );
896 * @param Parser $parser
897 * @param string $text
900 public static function anchorencode( $parser, $text ) {
901 $text = $parser->killMarkers( $text );
902 return (string)substr( $parser->guessSectionNameFromWikiText( $text ), 1 );
905 public static function special( $parser, $text ) {
906 list( $page, $subpage ) = SpecialPageFactory
::resolveAlias( $text );
908 $title = SpecialPage
::getTitleFor( $page, $subpage );
909 return $title->getPrefixedText();
911 // unknown special page, just use the given text as its title, if at all possible
912 $title = Title
::makeTitleSafe( NS_SPECIAL
, $text );
913 return $title ?
$title->getPrefixedText() : self
::special( $parser, 'Badtitle' );
917 public static function speciale( $parser, $text ) {
918 return wfUrlencode( str_replace( ' ', '_', self
::special( $parser, $text ) ) );
922 * @param Parser $parser
923 * @param string $text The sortkey to use
924 * @param string $uarg Either "noreplace" or "noerror" (in en)
925 * both suppress errors, and noreplace does nothing if
926 * a default sortkey already exists.
929 public static function defaultsort( $parser, $text, $uarg = '' ) {
930 static $magicWords = null;
931 if ( is_null( $magicWords ) ) {
932 $magicWords = new MagicWordArray( [ 'defaultsort_noerror', 'defaultsort_noreplace' ] );
934 $arg = $magicWords->matchStartToEnd( $uarg );
936 $text = trim( $text );
937 if ( strlen( $text ) == 0 ) {
940 $old = $parser->getCustomDefaultSort();
941 if ( $old === false ||
$arg !== 'defaultsort_noreplace' ) {
942 $parser->setDefaultSort( $text );
945 if ( $old === false ||
$old == $text ||
$arg ) {
948 $converter = $parser->getConverterLanguage()->getConverter();
949 return '<span class="error">' .
950 wfMessage( 'duplicate-defaultsort',
951 // Message should be parsed, but these params should only be escaped.
952 $converter->markNoConversion( wfEscapeWikiText( $old ) ),
953 $converter->markNoConversion( wfEscapeWikiText( $text ) )
954 )->inContentLanguage()->text() .
960 * Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}}
961 * or {{filepath|300|nowiki}} or {{filepath|300px}}, {{filepath|200x300px}},
962 * {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}.
964 * @param Parser $parser
965 * @param string $name
966 * @param string $argA
967 * @param string $argB
968 * @return array|string
970 public static function filepath( $parser, $name = '', $argA = '', $argB = '' ) {
971 $file = wfFindFile( $name );
973 if ( $argA == 'nowiki' ) {
974 // {{filepath: | option [| size] }}
976 $parsedWidthParam = $parser->parseWidthParam( $argB );
978 // {{filepath: [| size [|option]] }}
979 $parsedWidthParam = $parser->parseWidthParam( $argA );
980 $isNowiki = ( $argB == 'nowiki' );
984 $url = $file->getFullUrl();
986 // If a size is requested...
987 if ( count( $parsedWidthParam ) ) {
988 $mto = $file->transform( $parsedWidthParam );
990 if ( $mto && !$mto->isError() ) {
991 // ... change the URL to point to a thumbnail.
992 $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE
);
996 return [ $url, 'nowiki' => true ];
1005 * Parser function to extension tag adaptor
1006 * @param Parser $parser
1007 * @param PPFrame $frame
1008 * @param PPNode[] $args
1011 public static function tagObj( $parser, $frame, $args ) {
1012 if ( !count( $args ) ) {
1015 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
1017 if ( count( $args ) ) {
1018 $inner = $frame->expand( array_shift( $args ) );
1024 foreach ( $args as $arg ) {
1025 $bits = $arg->splitArg();
1026 if ( strval( $bits['index'] ) === '' ) {
1027 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
1028 $value = trim( $frame->expand( $bits['value'] ) );
1029 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
1030 $value = isset( $m[1] ) ?
$m[1] : '';
1032 $attributes[$name] = $value;
1036 $stripList = $parser->getStripList();
1037 if ( !in_array( $tagName, $stripList ) ) {
1038 // we can't handle this tag (at least not now), so just re-emit it as an ordinary tag
1040 foreach ( $attributes as $name => $value ) {
1041 $attrText .= ' ' . htmlspecialchars( $name ) . '="' . htmlspecialchars( $value ) . '"';
1043 if ( $inner === null ) {
1044 return "<$tagName$attrText/>";
1046 return "<$tagName$attrText>$inner</$tagName>";
1052 'attributes' => $attributes,
1053 'close' => "</$tagName>",
1055 return $parser->extensionSubstitution( $params, $frame );
1059 * Fetched the current revision of the given title and return this.
1060 * Will increment the expensive function count and
1061 * add a template link to get the value refreshed on changes.
1062 * For a given title, which is equal to the current parser title,
1063 * the revision object from the parser is used, when that is the current one
1065 * @param Parser $parser
1066 * @param Title $title
1070 private static function getCachedRevisionObject( $parser, $title = null ) {
1071 if ( is_null( $title ) ) {
1075 // Use the revision from the parser itself, when param is the current page
1076 // and the revision is the current one
1077 if ( $title->equals( $parser->getTitle() ) ) {
1078 $parserRev = $parser->getRevisionObject();
1079 if ( $parserRev && $parserRev->isCurrent() ) {
1080 // force reparse after edit with vary-revision flag
1081 $parser->getOutput()->setFlag( 'vary-revision' );
1082 wfDebug( __METHOD__
. ": use current revision from parser, setting vary-revision...\n" );
1087 // Normalize name for cache
1088 $page = $title->getPrefixedDBkey();
1090 if ( !( $parser->currentRevisionCache
&& $parser->currentRevisionCache
->has( $page ) )
1091 && !$parser->incrementExpensiveFunctionCount() ) {
1094 $rev = $parser->fetchCurrentRevisionOfTitle( $title );
1095 $pageID = $rev ?
$rev->getPage() : 0;
1096 $revID = $rev ?
$rev->getId() : 0;
1098 // Register dependency in templatelinks
1099 $parser->getOutput()->addTemplate( $title, $pageID, $revID );
1105 * Get the pageid of a specified page
1106 * @param Parser $parser
1107 * @param string $title Title to get the pageid from
1108 * @return int|null|string
1111 public static function pageid( $parser, $title = null ) {
1112 $t = Title
::newFromText( $title );
1113 if ( is_null( $t ) ) {
1116 // Use title from parser to have correct pageid after edit
1117 if ( $t->equals( $parser->getTitle() ) ) {
1118 $t = $parser->getTitle();
1119 return $t->getArticleID();
1122 // These can't have ids
1123 if ( !$t->canExist() ||
$t->isExternal() ) {
1127 // Check the link cache, maybe something already looked it up.
1128 $linkCache = LinkCache
::singleton();
1129 $pdbk = $t->getPrefixedDBkey();
1130 $id = $linkCache->getGoodLinkID( $pdbk );
1132 $parser->mOutput
->addLink( $t, $id );
1135 if ( $linkCache->isBadLink( $pdbk ) ) {
1136 $parser->mOutput
->addLink( $t, 0 );
1140 // We need to load it from the DB, so mark expensive
1141 if ( $parser->incrementExpensiveFunctionCount() ) {
1142 $id = $t->getArticleID();
1143 $parser->mOutput
->addLink( $t, $id );
1150 * Get the id from the last revision of a specified page.
1151 * @param Parser $parser
1152 * @param string $title Title to get the id from
1153 * @return int|null|string
1156 public static function revisionid( $parser, $title = null ) {
1157 $t = Title
::newFromText( $title );
1158 if ( is_null( $t ) ) {
1161 // fetch revision from cache/database and return the value
1162 $rev = self
::getCachedRevisionObject( $parser, $t );
1163 return $rev ?
$rev->getId() : '';
1167 * Get the day from the last revision of a specified page.
1168 * @param Parser $parser
1169 * @param string $title Title to get the day from
1173 public static function revisionday( $parser, $title = null ) {
1174 $t = Title
::newFromText( $title );
1175 if ( is_null( $t ) ) {
1178 // fetch revision from cache/database and return the value
1179 $rev = self
::getCachedRevisionObject( $parser, $t );
1180 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'j' ) : '';
1184 * Get the day with leading zeros from the last revision of a specified page.
1185 * @param Parser $parser
1186 * @param string $title Title to get the day from
1190 public static function revisionday2( $parser, $title = null ) {
1191 $t = Title
::newFromText( $title );
1192 if ( is_null( $t ) ) {
1195 // fetch revision from cache/database and return the value
1196 $rev = self
::getCachedRevisionObject( $parser, $t );
1197 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'd' ) : '';
1201 * Get the month with leading zeros from the last revision of a specified page.
1202 * @param Parser $parser
1203 * @param string $title Title to get the month from
1207 public static function revisionmonth( $parser, $title = null ) {
1208 $t = Title
::newFromText( $title );
1209 if ( is_null( $t ) ) {
1212 // fetch revision from cache/database and return the value
1213 $rev = self
::getCachedRevisionObject( $parser, $t );
1214 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'm' ) : '';
1218 * Get the month from the last revision of a specified page.
1219 * @param Parser $parser
1220 * @param string $title Title to get the month from
1224 public static function revisionmonth1( $parser, $title = null ) {
1225 $t = Title
::newFromText( $title );
1226 if ( is_null( $t ) ) {
1229 // fetch revision from cache/database and return the value
1230 $rev = self
::getCachedRevisionObject( $parser, $t );
1231 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'n' ) : '';
1235 * Get the year from the last revision of a specified page.
1236 * @param Parser $parser
1237 * @param string $title Title to get the year from
1241 public static function revisionyear( $parser, $title = null ) {
1242 $t = Title
::newFromText( $title );
1243 if ( is_null( $t ) ) {
1246 // fetch revision from cache/database and return the value
1247 $rev = self
::getCachedRevisionObject( $parser, $t );
1248 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'Y' ) : '';
1252 * Get the timestamp from the last revision of a specified page.
1253 * @param Parser $parser
1254 * @param string $title Title to get the timestamp from
1258 public static function revisiontimestamp( $parser, $title = null ) {
1259 $t = Title
::newFromText( $title );
1260 if ( is_null( $t ) ) {
1263 // fetch revision from cache/database and return the value
1264 $rev = self
::getCachedRevisionObject( $parser, $t );
1265 return $rev ? MWTimestamp
::getLocalInstance( $rev->getTimestamp() )->format( 'YmdHis' ) : '';
1269 * Get the user from the last revision of a specified page.
1270 * @param Parser $parser
1271 * @param string $title Title to get the user from
1275 public static function revisionuser( $parser, $title = null ) {
1276 $t = Title
::newFromText( $title );
1277 if ( is_null( $t ) ) {
1280 // fetch revision from cache/database and return the value
1281 $rev = self
::getCachedRevisionObject( $parser, $t );
1282 return $rev ?
$rev->getUserText() : '';
1286 * Returns the sources of any cascading protection acting on a specified page.
1287 * Pages will not return their own title unless they transclude themselves.
1288 * This is an expensive parser function and can't be called too many times per page,
1289 * unless cascading protection sources for the page have already been loaded.
1291 * @param Parser $parser
1292 * @param string $title
1297 public static function cascadingsources( $parser, $title = '' ) {
1298 $titleObject = Title
::newFromText( $title );
1299 if ( !( $titleObject instanceof Title
) ) {
1300 $titleObject = $parser->mTitle
;
1302 if ( $titleObject->areCascadeProtectionSourcesLoaded()
1303 ||
$parser->incrementExpensiveFunctionCount()
1306 $sources = $titleObject->getCascadeProtectionSources();
1307 foreach ( $sources[0] as $sourceTitle ) {
1308 $names[] = $sourceTitle->getPrefixedText();
1310 return implode( $names, '|' );