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( 'tag', array( __CLASS__
, 'tagObj' ), SFH_OBJECT_ARGS
);
52 if ( $wgAllowDisplayTitle ) {
53 $parser->setFunctionHook( 'displaytitle', array( __CLASS__
, 'displaytitle' ), SFH_NO_HASH
);
55 if ( $wgAllowSlowParserFunctions ) {
56 $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__
, 'pagesinnamespace' ), SFH_NO_HASH
);
60 static function intFunction( $parser, $part1 = '' /*, ... */ ) {
61 if ( strval( $part1 ) !== '' ) {
62 $args = array_slice( func_get_args(), 2 );
63 $message = wfMsgGetKey( $part1, true, false, false );
64 $message = wfMsgReplaceArgs( $message, $args );
65 $message = $parser->replaceVariables( $message ); // like $wgMessageCache->transform()
68 return array( 'found' => false );
72 static function ns( $parser, $part1 = '' ) {
74 if ( intval( $part1 ) ||
$part1 == "0" ) {
75 $index = intval( $part1 );
77 $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
79 if ( $index !== false ) {
80 return $wgContLang->getFormattedNsText( $index );
82 return array( 'found' => false );
86 static function urlencode( $parser, $s = '' ) {
87 return urlencode( $s );
90 static function lcfirst( $parser, $s = '' ) {
92 return $wgContLang->lcfirst( $s );
95 static function ucfirst( $parser, $s = '' ) {
97 return $wgContLang->ucfirst( $s );
100 static function lc( $parser, $s = '' ) {
102 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
103 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
105 return $wgContLang->lc( $s );
109 static function uc( $parser, $s = '' ) {
111 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
112 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
114 return $wgContLang->uc( $s );
118 static function localurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getLocalURL', $s, $arg ); }
119 static function localurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeLocalURL', $s, $arg ); }
120 static function fullurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getFullURL', $s, $arg ); }
121 static function fullurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeFullURL', $s, $arg ); }
123 static function urlFunction( $func, $s = '', $arg = null ) {
124 $title = Title
::newFromText( $s );
125 # Due to order of execution of a lot of bits, the values might be encoded
126 # before arriving here; if that's true, then the title can't be created
127 # and the variable will fail. If we can't get a decent title from the first
128 # attempt, url-decode and try for a second.
129 if( is_null( $title ) )
130 $title = Title
::newFromUrl( urldecode( $s ) );
131 if( !is_null( $title ) ) {
132 # Convert NS_MEDIA -> NS_FILE
133 if( $title->getNamespace() == NS_MEDIA
) {
134 $title = Title
::makeTitle( NS_FILE
, $title->getDBKey() );
136 if( !is_null( $arg ) ) {
137 $text = $title->$func( $arg );
139 $text = $title->$func();
143 return array( 'found' => false );
147 static function formatNum( $parser, $num = '', $raw = null) {
148 if ( self
::israw( $raw ) ) {
149 return $parser->getFunctionLang()->parseFormattedNumber( $num );
151 return $parser->getFunctionLang()->formatNum( $num );
155 static function grammar( $parser, $case = '', $word = '' ) {
156 return $parser->getFunctionLang()->convertGrammar( $word, $case );
159 static function gender( $parser, $user ) {
160 $forms = array_slice( func_get_args(), 2);
163 $gender = User
::getDefaultOption( 'gender' );
165 // check parameter, or use $wgUser if in interface message
166 $user = User
::newFromName( $user );
168 $gender = $user->getOption( 'gender' );
169 } elseif ( $parser->mOptions
->getInterfaceMessage() ) {
171 $gender = $wgUser->getOption( 'gender' );
173 return $parser->getFunctionLang()->gender( $gender, $forms );
175 static function plural( $parser, $text = '') {
176 $forms = array_slice( func_get_args(), 2);
177 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
178 return $parser->getFunctionLang()->convertPlural( $text, $forms );
182 * Override the title of the page when viewed, provided we've been given a
183 * title which will normalise to the canonical title
185 * @param Parser $parser Parent parser
186 * @param string $text Desired title text
189 static function displaytitle( $parser, $text = '' ) {
190 global $wgRestrictDisplayTitle;
191 $text = trim( Sanitizer
::decodeCharReferences( $text ) );
193 if ( !$wgRestrictDisplayTitle ) {
194 $parser->mOutput
->setDisplayTitle( $text );
196 $title = Title
::newFromText( $text );
197 if( $title instanceof Title
&& $title->getFragment() == '' && $title->equals( $parser->mTitle
) )
198 $parser->mOutput
->setDisplayTitle( $text );
203 static function isRaw( $param ) {
206 $mwRaw =& MagicWord
::get( 'rawsuffix' );
208 if ( is_null( $param ) ) {
211 return $mwRaw->match( $param );
215 static function formatRaw( $num, $raw ) {
216 if( self
::isRaw( $raw ) ) {
220 return $wgContLang->formatNum( $num );
223 static function numberofpages( $parser, $raw = null ) {
224 return self
::formatRaw( SiteStats
::pages(), $raw );
226 static function numberofusers( $parser, $raw = null ) {
227 return self
::formatRaw( SiteStats
::users(), $raw );
229 static function numberofarticles( $parser, $raw = null ) {
230 return self
::formatRaw( SiteStats
::articles(), $raw );
232 static function numberoffiles( $parser, $raw = null ) {
233 return self
::formatRaw( SiteStats
::images(), $raw );
235 static function numberofadmins( $parser, $raw = null ) {
236 return self
::formatRaw( SiteStats
::numberingroup('sysop'), $raw );
238 static function numberofedits( $parser, $raw = null ) {
239 return self
::formatRaw( SiteStats
::edits(), $raw );
241 static function numberofviews( $parser, $raw = null ) {
242 return self
::formatRaw( SiteStats
::views(), $raw );
244 static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
245 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
247 static function numberingroup( $parser, $name = '', $raw = null) {
248 return self
::formatRaw( SiteStats
::numberingroup( strtolower( $name ) ), $raw );
252 * Return the number of pages in the given category, or 0 if it's nonexis-
253 * tent. This is an expensive parser function and can't be called too many
256 static function pagesincategory( $parser, $name = '', $raw = null ) {
257 static $cache = array();
258 $category = Category
::newFromName( $name );
260 if( !is_object( $category ) ) {
262 return self
::formatRaw( 0, $raw );
265 # Normalize name for cache
266 $name = $category->getName();
269 if( isset( $cache[$name] ) ) {
270 $count = $cache[$name];
271 } elseif( $parser->incrementExpensiveFunctionCount() ) {
272 $count = $cache[$name] = (int)$category->getPageCount();
274 return self
::formatRaw( $count, $raw );
278 * Return the size of the given page, or 0 if it's nonexistent. This is an
279 * expensive parser function and can't be called too many times per page.
281 * @FIXME This doesn't work correctly on preview for getting the size of
283 * @FIXME Title::getLength() documentation claims that it adds things to
284 * the link cache, so the local cache here should be unnecessary, but in
285 * fact calling getLength() repeatedly for the same $page does seem to
286 * run one query for each call?
288 static function pagesize( $parser, $page = '', $raw = null ) {
289 static $cache = array();
290 $title = Title
::newFromText($page);
292 if( !is_object( $title ) ) {
294 return self
::formatRaw( 0, $raw );
297 # Normalize name for cache
298 $page = $title->getPrefixedText();
301 if( isset( $cache[$page] ) ) {
302 $length = $cache[$page];
303 } elseif( $parser->incrementExpensiveFunctionCount() ) {
304 $rev = Revision
::newFromTitle($title);
305 $id = $rev ?
$rev->getPage() : 0;
306 $length = $cache[$page] = $rev ?
$rev->getSize() : 0;
308 // Register dependency in templatelinks
309 $parser->mOutput
->addTemplate( $title, $id, $rev ?
$rev->getId() : 0 );
311 return self
::formatRaw( $length, $raw );
315 * Returns the requested protection level for the current page
317 static function protectionlevel( $parser, $type = '' ) {
318 $restrictions = $parser->mTitle
->getRestrictions( strtolower( $type ) );
319 # Title::getRestrictions returns an array, its possible it may have
320 # multiple values in the future
321 return implode( $restrictions, ',' );
324 static function language( $parser, $arg = '' ) {
326 $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
327 return $lang != '' ?
$lang : $arg;
331 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
333 static function pad( $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
) {
334 $lengthOfPadding = mb_strlen( $padding );
335 if ( $lengthOfPadding == 0 ) return $string;
337 # The remaining length to add counts down to 0 as padding is added
338 $length = min( $length, 500 ) - mb_strlen( $string );
339 # $finalPadding is just $padding repeated enough times so that
340 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
342 while ( $length > 0 ) {
343 # If $length < $lengthofPadding, truncate $padding so we get the
344 # exact length desired.
345 $finalPadding .= mb_substr( $padding, 0, $length );
346 $length -= $lengthOfPadding;
349 if ( $direction == STR_PAD_LEFT
) {
350 return $finalPadding . $string;
352 return $string . $finalPadding;
356 static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
357 return self
::pad( $string, $length, $padding, STR_PAD_LEFT
);
360 static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
361 return self
::pad( $string, $length, $padding );
364 static function anchorencode( $parser, $text ) {
365 $a = urlencode( $text );
366 $a = strtr( $a, array( '%' => '.', '+' => '_' ) );
367 # leave colons alone, however
368 $a = str_replace( '.3A', ':', $a );
372 static function special( $parser, $text ) {
373 $title = SpecialPage
::getTitleForAlias( $text );
375 return $title->getPrefixedText();
377 return wfMsgForContent( 'nosuchspecialpage' );
381 public static function defaultsort( $parser, $text ) {
382 $text = trim( $text );
383 if( strlen( $text ) == 0 )
385 $old = $parser->getCustomDefaultSort();
386 $parser->setDefaultSort( $text );
387 if( $old === false ||
$old == $text )
390 return( '<span class="error">' .
391 wfMsg( 'duplicate-defaultsort',
392 htmlspecialchars( $old ),
393 htmlspecialchars( $text ) ) .
397 public static function filepath( $parser, $name='', $option='' ) {
398 $file = wfFindFile( $name );
400 $url = $file->getFullUrl();
401 if( $option == 'nowiki' ) {
402 return array( $url, 'nowiki' => true );
411 * Parser function to extension tag adaptor
413 public static function tagObj( $parser, $frame, $args ) {
415 if ( !count( $args ) ) {
418 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
420 if ( count( $args ) ) {
421 $inner = $frame->expand( array_shift( $args ) );
426 $stripList = $parser->getStripList();
427 if ( !in_array( $tagName, $stripList ) ) {
428 return '<span class="error">' .
429 wfMsg( 'unknown_extension_tag', $tagName ) .
433 $attributes = array();
434 foreach ( $args as $arg ) {
435 $bits = $arg->splitArg();
436 if ( strval( $bits['index'] ) === '' ) {
437 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
438 $value = trim( $frame->expand( $bits['value'] ) );
439 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
440 $value = isset( $m[1] ) ?
$m[1] : '';
442 $attributes[$name] = $value;
449 'attributes' => $attributes,
450 'close' => "</$tagName>",
452 return $parser->extensionSubstitution( $params, $frame );