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( 'plural', array( __CLASS__
, 'plural' ), SFH_NO_HASH
);
31 $parser->setFunctionHook( 'numberofpages', array( __CLASS__
, 'numberofpages' ), SFH_NO_HASH
);
32 $parser->setFunctionHook( 'numberofusers', array( __CLASS__
, 'numberofusers' ), SFH_NO_HASH
);
33 $parser->setFunctionHook( 'numberofarticles', array( __CLASS__
, 'numberofarticles' ), SFH_NO_HASH
);
34 $parser->setFunctionHook( 'numberoffiles', array( __CLASS__
, 'numberoffiles' ), SFH_NO_HASH
);
35 $parser->setFunctionHook( 'numberofadmins', array( __CLASS__
, 'numberofadmins' ), SFH_NO_HASH
);
36 $parser->setFunctionHook( 'numberingroup', array( __CLASS__
, 'numberingroup' ), SFH_NO_HASH
);
37 $parser->setFunctionHook( 'numberofedits', array( __CLASS__
, 'numberofedits' ), SFH_NO_HASH
);
38 $parser->setFunctionHook( 'language', array( __CLASS__
, 'language' ), SFH_NO_HASH
);
39 $parser->setFunctionHook( 'padleft', array( __CLASS__
, 'padleft' ), SFH_NO_HASH
);
40 $parser->setFunctionHook( 'padright', array( __CLASS__
, 'padright' ), SFH_NO_HASH
);
41 $parser->setFunctionHook( 'anchorencode', array( __CLASS__
, 'anchorencode' ), SFH_NO_HASH
);
42 $parser->setFunctionHook( 'special', array( __CLASS__
, 'special' ) );
43 $parser->setFunctionHook( 'defaultsort', array( __CLASS__
, 'defaultsort' ), SFH_NO_HASH
);
44 $parser->setFunctionHook( 'filepath', array( __CLASS__
, 'filepath' ), SFH_NO_HASH
);
45 $parser->setFunctionHook( 'pagesincategory', array( __CLASS__
, 'pagesincategory' ), SFH_NO_HASH
);
46 $parser->setFunctionHook( 'pagesize', array( __CLASS__
, 'pagesize' ), SFH_NO_HASH
);
47 $parser->setFunctionHook( 'tag', array( __CLASS__
, 'tagObj' ), SFH_OBJECT_ARGS
);
49 if ( $wgAllowDisplayTitle ) {
50 $parser->setFunctionHook( 'displaytitle', array( __CLASS__
, 'displaytitle' ), SFH_NO_HASH
);
52 if ( $wgAllowSlowParserFunctions ) {
53 $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__
, 'pagesinnamespace' ), SFH_NO_HASH
);
57 static function intFunction( $parser, $part1 = '' /*, ... */ ) {
58 if ( strval( $part1 ) !== '' ) {
59 $args = array_slice( func_get_args(), 2 );
60 $message = wfMsgGetKey( $part1, true, false, false );
61 $message = wfMsgReplaceArgs( $message, $args );
62 $message = $parser->replaceVariables( $message ); // like $wgMessageCache->transform()
65 return array( 'found' => false );
69 static function ns( $parser, $part1 = '' ) {
71 if ( intval( $part1 ) ||
$part1 == "0" ) {
72 $index = intval( $part1 );
74 $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
76 if ( $index !== false ) {
77 return $wgContLang->getFormattedNsText( $index );
79 return array( 'found' => false );
83 static function urlencode( $parser, $s = '' ) {
84 return urlencode( $s );
87 static function lcfirst( $parser, $s = '' ) {
89 return $wgContLang->lcfirst( $s );
92 static function ucfirst( $parser, $s = '' ) {
94 return $wgContLang->ucfirst( $s );
97 static function lc( $parser, $s = '' ) {
99 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
100 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
102 return $wgContLang->lc( $s );
106 static function uc( $parser, $s = '' ) {
108 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
109 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
111 return $wgContLang->uc( $s );
115 static function localurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getLocalURL', $s, $arg ); }
116 static function localurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeLocalURL', $s, $arg ); }
117 static function fullurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getFullURL', $s, $arg ); }
118 static function fullurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeFullURL', $s, $arg ); }
120 static function urlFunction( $func, $s = '', $arg = null ) {
121 $title = Title
::newFromText( $s );
122 # Due to order of execution of a lot of bits, the values might be encoded
123 # before arriving here; if that's true, then the title can't be created
124 # and the variable will fail. If we can't get a decent title from the first
125 # attempt, url-decode and try for a second.
126 if( is_null( $title ) )
127 $title = Title
::newFromUrl( urldecode( $s ) );
128 if ( !is_null( $title ) ) {
129 if ( !is_null( $arg ) ) {
130 $text = $title->$func( $arg );
132 $text = $title->$func();
136 return array( 'found' => false );
140 static function formatNum( $parser, $num = '', $raw = null) {
141 if ( self
::israw( $raw ) ) {
142 return $parser->getFunctionLang()->parseFormattedNumber( $num );
144 return $parser->getFunctionLang()->formatNum( $num );
148 static function grammar( $parser, $case = '', $word = '' ) {
149 return $parser->getFunctionLang()->convertGrammar( $word, $case );
152 static function plural( $parser, $text = '') {
153 $forms = array_slice( func_get_args(), 2);
154 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
155 return $parser->getFunctionLang()->convertPlural( $text, $forms );
159 * Override the title of the page when viewed, provided we've been given a
160 * title which will normalise to the canonical title
162 * @param Parser $parser Parent parser
163 * @param string $text Desired title text
166 static function displaytitle( $parser, $text = '' ) {
167 global $wgRestrictDisplayTitle;
168 $text = trim( Sanitizer
::decodeCharReferences( $text ) );
170 if ( !$wgRestrictDisplayTitle ) {
171 $parser->mOutput
->setDisplayTitle( $text );
173 $title = Title
::newFromText( $text );
174 if( $title instanceof Title
&& $title->getFragment() == '' && $title->equals( $parser->mTitle
) )
175 $parser->mOutput
->setDisplayTitle( $text );
180 static function isRaw( $param ) {
183 $mwRaw =& MagicWord
::get( 'rawsuffix' );
185 if ( is_null( $param ) ) {
188 return $mwRaw->match( $param );
192 static function formatRaw( $num, $raw ) {
193 if( self
::isRaw( $raw ) ) {
197 return $wgContLang->formatNum( $num );
200 static function numberofpages( $parser, $raw = null ) {
201 return self
::formatRaw( SiteStats
::pages(), $raw );
203 static function numberofusers( $parser, $raw = null ) {
204 return self
::formatRaw( SiteStats
::users(), $raw );
206 static function numberofarticles( $parser, $raw = null ) {
207 return self
::formatRaw( SiteStats
::articles(), $raw );
209 static function numberoffiles( $parser, $raw = null ) {
210 return self
::formatRaw( SiteStats
::images(), $raw );
212 static function numberofadmins( $parser, $raw = null ) {
213 return self
::formatRaw( SiteStats
::numberingroup('sysop'), $raw );
215 static function numberofedits( $parser, $raw = null ) {
216 return self
::formatRaw( SiteStats
::edits(), $raw );
218 static function numberofviews( $parser, $raw = null ) {
219 return self
::formatRaw( SiteStats
::views(), $raw );
221 static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
222 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
224 static function numberingroup( $parser, $name = '', $raw = null) {
225 return self
::formatRaw( SiteStats
::numberingroup( strtolower( $name ) ), $raw );
229 * Return the number of pages in the given category, or 0 if it's nonexis-
230 * tent. This is an expensive parser function and can't be called too many
233 static function pagesincategory( $parser, $name = '', $raw = null ) {
234 static $cache = array();
235 $category = Category
::newFromName( $name );
237 if( !is_object( $category ) ) {
239 return self
::formatRaw( 0, $raw );
242 # Normalize name for cache
243 $name = $category->getName();
246 if( isset( $cache[$name] ) ) {
247 $count = $cache[$name];
248 } elseif( $parser->incrementExpensiveFunctionCount() ) {
249 $count = $cache[$name] = (int)$category->getPageCount();
251 return self
::formatRaw( $count, $raw );
255 * Return the size of the given page, or 0 if it's nonexistent. This is an
256 * expensive parser function and can't be called too many times per page.
258 * @FIXME This doesn't work correctly on preview for getting the size of
260 * @FIXME Title::getLength() documentation claims that it adds things to
261 * the link cache, so the local cache here should be unnecessary, but in
262 * fact calling getLength() repeatedly for the same $page does seem to
263 * run one query for each call?
265 static function pagesize( $parser, $page = '', $raw = null ) {
266 static $cache = array();
267 $title = Title
::newFromText($page);
269 if( !is_object( $title ) ) {
271 return self
::formatRaw( 0, $raw );
274 # Normalize name for cache
275 $page = $title->getPrefixedText();
278 if( isset( $cache[$page] ) ) {
279 $length = $cache[$page];
280 } elseif( $parser->incrementExpensiveFunctionCount() ) {
281 $length = $cache[$page] = $title->getLength();
283 // Register dependency in templatelinks
284 $id = $title->getArticleId();
285 $revid = Revision
::newFromTitle($title);
286 $parser->mOutput
->addTemplate($title, $id, $revid);
288 return self
::formatRaw( $length, $raw );
291 static function language( $parser, $arg = '' ) {
293 $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
294 return $lang != '' ?
$lang : $arg;
297 static function pad( $string = '', $length = 0, $char = 0, $direction = STR_PAD_RIGHT
) {
298 $length = min( max( $length, 0 ), 500 );
299 $char = substr( $char, 0, 1 );
300 return ( $string !== '' && (int)$length > 0 && strlen( trim( (string)$char ) ) > 0 )
301 ?
str_pad( $string, $length, (string)$char, $direction )
305 static function padleft( $parser, $string = '', $length = 0, $char = 0 ) {
306 return self
::pad( $string, $length, $char, STR_PAD_LEFT
);
309 static function padright( $parser, $string = '', $length = 0, $char = 0 ) {
310 return self
::pad( $string, $length, $char );
313 static function anchorencode( $parser, $text ) {
314 $a = urlencode( $text );
315 $a = strtr( $a, array( '%' => '.', '+' => '_' ) );
316 # leave colons alone, however
317 $a = str_replace( '.3A', ':', $a );
321 static function special( $parser, $text ) {
322 $title = SpecialPage
::getTitleForAlias( $text );
324 return $title->getPrefixedText();
326 return wfMsgForContent( 'nosuchspecialpage' );
330 public static function defaultsort( $parser, $text ) {
331 $text = trim( $text );
332 if( strlen( $text ) > 0 )
333 $parser->setDefaultSort( $text );
337 public static function filepath( $parser, $name='', $option='' ) {
338 $file = wfFindFile( $name );
340 $url = $file->getFullUrl();
341 if( $option == 'nowiki' ) {
342 return "<nowiki>$url</nowiki>";
351 * Parser function to extension tag adaptor
353 public static function tagObj( $parser, $frame, $args ) {
355 if ( !count( $args ) ) {
358 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
360 if ( count( $args ) ) {
361 $inner = $frame->expand( array_shift( $args ) );
366 $stripList = $parser->getStripList();
367 if ( !in_array( $tagName, $stripList ) ) {
368 return '<span class="error">' .
369 wfMsg( 'unknown_extension_tag', $tagName ) .
373 $attributes = array();
374 foreach ( $args as $arg ) {
375 $bits = $arg->splitArg();
376 if ( strval( $bits['index'] ) === '' ) {
377 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
378 $value = trim( $frame->expand( $bits['value'] ) );
379 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
380 $value = isset( $m[1] ) ?
$m[1] : '';
382 $attributes[$name] = $value;
389 'attributes' => $attributes,
390 'close' => "</$tagName>",
392 return $parser->extensionSubstitution( $params, $frame );