4 * Various core parser functions, registered in Parser::firstCallInit()
7 class CoreParserFunctions
{
8 static function register( $parser ) {
9 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
11 # Syntax for arguments (see self::setFunctionHook):
12 # "name for lookup in localized magic words array",
14 # optional SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}
15 # instead of {{#int:...}})
17 $parser->setFunctionHook( 'int', array( __CLASS__
, 'intFunction' ), SFH_NO_HASH
);
18 $parser->setFunctionHook( 'ns', array( __CLASS__
, 'ns' ), SFH_NO_HASH
);
19 $parser->setFunctionHook( 'urlencode', array( __CLASS__
, 'urlencode' ), SFH_NO_HASH
);
20 $parser->setFunctionHook( 'lcfirst', array( __CLASS__
, 'lcfirst' ), SFH_NO_HASH
);
21 $parser->setFunctionHook( 'ucfirst', array( __CLASS__
, 'ucfirst' ), SFH_NO_HASH
);
22 $parser->setFunctionHook( 'lc', array( __CLASS__
, 'lc' ), SFH_NO_HASH
);
23 $parser->setFunctionHook( 'uc', array( __CLASS__
, 'uc' ), SFH_NO_HASH
);
24 $parser->setFunctionHook( 'localurl', array( __CLASS__
, 'localurl' ), SFH_NO_HASH
);
25 $parser->setFunctionHook( 'localurle', array( __CLASS__
, 'localurle' ), SFH_NO_HASH
);
26 $parser->setFunctionHook( 'fullurl', array( __CLASS__
, 'fullurl' ), SFH_NO_HASH
);
27 $parser->setFunctionHook( 'fullurle', array( __CLASS__
, 'fullurle' ), SFH_NO_HASH
);
28 $parser->setFunctionHook( 'formatnum', array( __CLASS__
, 'formatnum' ), SFH_NO_HASH
);
29 $parser->setFunctionHook( 'grammar', array( __CLASS__
, 'grammar' ), SFH_NO_HASH
);
30 $parser->setFunctionHook( 'gender', array( __CLASS__
, 'gender' ), SFH_NO_HASH
);
31 $parser->setFunctionHook( 'plural', array( __CLASS__
, 'plural' ), SFH_NO_HASH
);
32 $parser->setFunctionHook( 'numberofpages', array( __CLASS__
, 'numberofpages' ), SFH_NO_HASH
);
33 $parser->setFunctionHook( 'numberofusers', array( __CLASS__
, 'numberofusers' ), SFH_NO_HASH
);
34 $parser->setFunctionHook( 'numberofarticles', array( __CLASS__
, 'numberofarticles' ), SFH_NO_HASH
);
35 $parser->setFunctionHook( 'numberoffiles', array( __CLASS__
, 'numberoffiles' ), SFH_NO_HASH
);
36 $parser->setFunctionHook( 'numberofadmins', array( __CLASS__
, 'numberofadmins' ), SFH_NO_HASH
);
37 $parser->setFunctionHook( 'numberingroup', array( __CLASS__
, 'numberingroup' ), SFH_NO_HASH
);
38 $parser->setFunctionHook( 'numberofedits', array( __CLASS__
, 'numberofedits' ), SFH_NO_HASH
);
39 $parser->setFunctionHook( 'numberofviews', array( __CLASS__
, 'numberofviews' ), SFH_NO_HASH
);
40 $parser->setFunctionHook( 'language', array( __CLASS__
, 'language' ), SFH_NO_HASH
);
41 $parser->setFunctionHook( 'padleft', array( __CLASS__
, 'padleft' ), SFH_NO_HASH
);
42 $parser->setFunctionHook( 'padright', array( __CLASS__
, 'padright' ), SFH_NO_HASH
);
43 $parser->setFunctionHook( 'anchorencode', array( __CLASS__
, 'anchorencode' ), SFH_NO_HASH
);
44 $parser->setFunctionHook( 'special', array( __CLASS__
, 'special' ) );
45 $parser->setFunctionHook( 'defaultsort', array( __CLASS__
, 'defaultsort' ), SFH_NO_HASH
);
46 $parser->setFunctionHook( 'filepath', array( __CLASS__
, 'filepath' ), SFH_NO_HASH
);
47 $parser->setFunctionHook( 'pagesincategory', array( __CLASS__
, 'pagesincategory' ), SFH_NO_HASH
);
48 $parser->setFunctionHook( 'pagesize', array( __CLASS__
, 'pagesize' ), SFH_NO_HASH
);
49 $parser->setFunctionHook( 'protectionlevel', array( __CLASS__
, 'protectionlevel' ), SFH_NO_HASH
);
50 $parser->setFunctionHook( 'namespace', array( __CLASS__
, 'namespace' ), SFH_NO_HASH
);
51 $parser->setFunctionHook( 'namespacee', array( __CLASS__
, 'namespacee' ), SFH_NO_HASH
);
52 $parser->setFunctionHook( 'talkspace', array( __CLASS__
, 'talkspace' ), SFH_NO_HASH
);
53 $parser->setFunctionHook( 'talkspacee', array( __CLASS__
, 'talkspacee' ), SFH_NO_HASH
);
54 $parser->setFunctionHook( 'subjectspace', array( __CLASS__
, 'subjectspace' ), SFH_NO_HASH
);
55 $parser->setFunctionHook( 'subjectspacee', array( __CLASS__
, 'subjectspacee' ), SFH_NO_HASH
);
56 $parser->setFunctionHook( 'tag', array( __CLASS__
, 'tagObj' ), SFH_OBJECT_ARGS
);
58 if ( $wgAllowDisplayTitle ) {
59 $parser->setFunctionHook( 'displaytitle', array( __CLASS__
, 'displaytitle' ), SFH_NO_HASH
);
61 if ( $wgAllowSlowParserFunctions ) {
62 $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__
, 'pagesinnamespace' ), SFH_NO_HASH
);
66 static function intFunction( $parser, $part1 = '' /*, ... */ ) {
67 if ( strval( $part1 ) !== '' ) {
68 $args = array_slice( func_get_args(), 2 );
69 $message = wfMsgGetKey( $part1, true, false, false );
70 $message = wfMsgReplaceArgs( $message, $args );
71 $message = $parser->replaceVariables( $message ); // like $wgMessageCache->transform()
74 return array( 'found' => false );
78 static function ns( $parser, $part1 = '' ) {
80 if ( intval( $part1 ) ||
$part1 == "0" ) {
81 $index = intval( $part1 );
83 $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
85 if ( $index !== false ) {
86 return $wgContLang->getFormattedNsText( $index );
88 return array( 'found' => false );
92 static function urlencode( $parser, $s = '' ) {
93 return urlencode( $s );
96 static function lcfirst( $parser, $s = '' ) {
98 return $wgContLang->lcfirst( $s );
101 static function ucfirst( $parser, $s = '' ) {
103 return $wgContLang->ucfirst( $s );
106 static function lc( $parser, $s = '' ) {
108 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
109 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
111 return $wgContLang->lc( $s );
115 static function uc( $parser, $s = '' ) {
117 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
118 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
120 return $wgContLang->uc( $s );
124 static function localurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getLocalURL', $s, $arg ); }
125 static function localurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeLocalURL', $s, $arg ); }
126 static function fullurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getFullURL', $s, $arg ); }
127 static function fullurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeFullURL', $s, $arg ); }
129 static function urlFunction( $func, $s = '', $arg = null ) {
130 $title = Title
::newFromText( $s );
131 # Due to order of execution of a lot of bits, the values might be encoded
132 # before arriving here; if that's true, then the title can't be created
133 # and the variable will fail. If we can't get a decent title from the first
134 # attempt, url-decode and try for a second.
135 if( is_null( $title ) )
136 $title = Title
::newFromUrl( urldecode( $s ) );
137 if( !is_null( $title ) ) {
138 # Convert NS_MEDIA -> NS_FILE
139 if( $title->getNamespace() == NS_MEDIA
) {
140 $title = Title
::makeTitle( NS_FILE
, $title->getDBKey() );
142 if( !is_null( $arg ) ) {
143 $text = $title->$func( $arg );
145 $text = $title->$func();
149 return array( 'found' => false );
153 static function formatNum( $parser, $num = '', $raw = null) {
154 if ( self
::israw( $raw ) ) {
155 return $parser->getFunctionLang()->parseFormattedNumber( $num );
157 return $parser->getFunctionLang()->formatNum( $num );
161 static function grammar( $parser, $case = '', $word = '' ) {
162 return $parser->getFunctionLang()->convertGrammar( $word, $case );
165 static function gender( $parser, $user ) {
166 $forms = array_slice( func_get_args(), 2);
169 $gender = User
::getDefaultOption( 'gender' );
171 // check parameter, or use $wgUser if in interface message
172 $user = User
::newFromName( $user );
174 $gender = $user->getOption( 'gender' );
175 } elseif ( $parser->mOptions
->getInterfaceMessage() ) {
177 $gender = $wgUser->getOption( 'gender' );
179 return $parser->getFunctionLang()->gender( $gender, $forms );
181 static function plural( $parser, $text = '') {
182 $forms = array_slice( func_get_args(), 2);
183 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
184 return $parser->getFunctionLang()->convertPlural( $text, $forms );
188 * Override the title of the page when viewed, provided we've been given a
189 * title which will normalise to the canonical title
191 * @param Parser $parser Parent parser
192 * @param string $text Desired title text
195 static function displaytitle( $parser, $text = '' ) {
196 global $wgRestrictDisplayTitle;
197 $text = trim( Sanitizer
::decodeCharReferences( $text ) );
199 if ( !$wgRestrictDisplayTitle ) {
200 $parser->mOutput
->setDisplayTitle( $text );
202 $title = Title
::newFromText( $text );
203 if( $title instanceof Title
&& $title->getFragment() == '' && $title->equals( $parser->mTitle
) )
204 $parser->mOutput
->setDisplayTitle( $text );
209 static function isRaw( $param ) {
212 $mwRaw =& MagicWord
::get( 'rawsuffix' );
214 if ( is_null( $param ) ) {
217 return $mwRaw->match( $param );
221 static function formatRaw( $num, $raw ) {
222 if( self
::isRaw( $raw ) ) {
226 return $wgContLang->formatNum( $num );
229 static function numberofpages( $parser, $raw = null ) {
230 return self
::formatRaw( SiteStats
::pages(), $raw );
232 static function numberofusers( $parser, $raw = null ) {
233 return self
::formatRaw( SiteStats
::users(), $raw );
235 static function numberofarticles( $parser, $raw = null ) {
236 return self
::formatRaw( SiteStats
::articles(), $raw );
238 static function numberoffiles( $parser, $raw = null ) {
239 return self
::formatRaw( SiteStats
::images(), $raw );
241 static function numberofadmins( $parser, $raw = null ) {
242 return self
::formatRaw( SiteStats
::numberingroup('sysop'), $raw );
244 static function numberofedits( $parser, $raw = null ) {
245 return self
::formatRaw( SiteStats
::edits(), $raw );
247 static function numberofviews( $parser, $raw = null ) {
248 return self
::formatRaw( SiteStats
::views(), $raw );
250 static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
251 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
253 static function numberingroup( $parser, $name = '', $raw = null) {
254 return self
::formatRaw( SiteStats
::numberingroup( strtolower( $name ) ), $raw );
259 * Given a title, return the namespace name that would be given by the
260 * corresponding magic word
262 static function namespace( $parser, $title = null ) {
263 $t = Title
::newFromText( $title );
266 return str_replace( '_', ' ', $t->getNsText() );
268 static function namespacee( $parser, $title = null ) {
269 $t = Title
::newFromText( $title );
272 return wfUrlencode( $t->getNsText() );
274 static function talkspace( $parser, $title = null ) {
275 $t = Title
::newFromText( $title );
276 if ( is_null($t) ||
!$t->canTalk() )
278 return str_replace( '_', ' ', $t->getTalkNsText() );
280 static function talkspacee( $parser, $title = null ) {
281 $t = Title
::newFromText( $title );
282 if ( is_null($t) ||
!$t->canTalk() )
284 return wfUrlencode( $t->getTalkNsText() );
286 static function subjectspace( $parser, $title = null ) {
287 $t = Title
::newFromText( $title );
290 return str_replace( '_', ' ', $t->getSubjectNsText() );
292 static function subjectspacee( $parser, $title = null ) {
293 $t = Title
::newFromText( $title );
296 return wfUrlencode( $t->getSubjectNsText() );
300 * Return the number of pages in the given category, or 0 if it's nonexis-
301 * tent. This is an expensive parser function and can't be called too many
304 static function pagesincategory( $parser, $name = '', $raw = null ) {
305 static $cache = array();
306 $category = Category
::newFromName( $name );
308 if( !is_object( $category ) ) {
310 return self
::formatRaw( 0, $raw );
313 # Normalize name for cache
314 $name = $category->getName();
317 if( isset( $cache[$name] ) ) {
318 $count = $cache[$name];
319 } elseif( $parser->incrementExpensiveFunctionCount() ) {
320 $count = $cache[$name] = (int)$category->getPageCount();
322 return self
::formatRaw( $count, $raw );
326 * Return the size of the given page, or 0 if it's nonexistent. This is an
327 * expensive parser function and can't be called too many times per page.
329 * @FIXME This doesn't work correctly on preview for getting the size of
331 * @FIXME Title::getLength() documentation claims that it adds things to
332 * the link cache, so the local cache here should be unnecessary, but in
333 * fact calling getLength() repeatedly for the same $page does seem to
334 * run one query for each call?
336 static function pagesize( $parser, $page = '', $raw = null ) {
337 static $cache = array();
338 $title = Title
::newFromText($page);
340 if( !is_object( $title ) ) {
342 return self
::formatRaw( 0, $raw );
345 # Normalize name for cache
346 $page = $title->getPrefixedText();
349 if( isset( $cache[$page] ) ) {
350 $length = $cache[$page];
351 } elseif( $parser->incrementExpensiveFunctionCount() ) {
352 $rev = Revision
::newFromTitle($title);
353 $id = $rev ?
$rev->getPage() : 0;
354 $length = $cache[$page] = $rev ?
$rev->getSize() : 0;
356 // Register dependency in templatelinks
357 $parser->mOutput
->addTemplate( $title, $id, $rev ?
$rev->getId() : 0 );
359 return self
::formatRaw( $length, $raw );
363 * Returns the requested protection level for the current page
365 static function protectionlevel( $parser, $type = '' ) {
366 $restrictions = $parser->mTitle
->getRestrictions( strtolower( $type ) );
367 # Title::getRestrictions returns an array, its possible it may have
368 # multiple values in the future
369 return implode( $restrictions, ',' );
372 static function language( $parser, $arg = '' ) {
374 $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
375 return $lang != '' ?
$lang : $arg;
379 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
381 static function pad( $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
) {
382 $lengthOfPadding = mb_strlen( $padding );
383 if ( $lengthOfPadding == 0 ) return $string;
384 if ( $length < mb_strlen( $string ) ) return $string;
386 # The remaining length to add counts down to 0 as padding is added
387 $length = min( $length, 500 ) - mb_strlen( $string );
388 # $finalPadding is just $padding repeated enough times so that
389 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
391 while ( $length > 0 ) {
392 # If $length < $lengthofPadding, truncate $padding so we get the
393 # exact length desired.
394 $finalPadding .= mb_substr( $padding, 0, $length );
395 $length -= $lengthOfPadding;
398 if ( $direction == STR_PAD_LEFT
) {
399 return $finalPadding . $string;
401 return $string . $finalPadding;
405 static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
406 return self
::pad( $string, $length, $padding, STR_PAD_LEFT
);
409 static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
410 return self
::pad( $string, $length, $padding );
413 static function anchorencode( $parser, $text ) {
414 $a = urlencode( $text );
415 $a = strtr( $a, array( '%' => '.', '+' => '_' ) );
416 # leave colons alone, however
417 $a = str_replace( '.3A', ':', $a );
421 static function special( $parser, $text ) {
422 $title = SpecialPage
::getTitleForAlias( $text );
424 return $title->getPrefixedText();
426 return wfMsgForContent( 'nosuchspecialpage' );
430 public static function defaultsort( $parser, $text ) {
431 $text = trim( $text );
432 if( strlen( $text ) == 0 )
434 $old = $parser->getCustomDefaultSort();
435 $parser->setDefaultSort( $text );
436 if( $old === false ||
$old == $text )
439 return( '<span class="error">' .
440 wfMsg( 'duplicate-defaultsort',
441 htmlspecialchars( $old ),
442 htmlspecialchars( $text ) ) .
446 public static function filepath( $parser, $name='', $option='' ) {
447 $file = wfFindFile( $name );
449 $url = $file->getFullUrl();
450 if( $option == 'nowiki' ) {
451 return array( $url, 'nowiki' => true );
460 * Parser function to extension tag adaptor
462 public static function tagObj( $parser, $frame, $args ) {
464 if ( !count( $args ) ) {
467 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
469 if ( count( $args ) ) {
470 $inner = $frame->expand( array_shift( $args ) );
475 $stripList = $parser->getStripList();
476 if ( !in_array( $tagName, $stripList ) ) {
477 return '<span class="error">' .
478 wfMsg( 'unknown_extension_tag', $tagName ) .
482 $attributes = array();
483 foreach ( $args as $arg ) {
484 $bits = $arg->splitArg();
485 if ( strval( $bits['index'] ) === '' ) {
486 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
487 $value = trim( $frame->expand( $bits['value'] ) );
488 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
489 $value = isset( $m[1] ) ?
$m[1] : '';
491 $attributes[$name] = $value;
498 'attributes' => $attributes,
499 'close' => "</$tagName>",
501 return $parser->extensionSubstitution( $params, $frame );