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( 'numberofedits', array( __CLASS__
, 'numberofedits' ), SFH_NO_HASH
);
37 $parser->setFunctionHook( 'language', array( __CLASS__
, 'language' ), SFH_NO_HASH
);
38 $parser->setFunctionHook( 'padleft', array( __CLASS__
, 'padleft' ), SFH_NO_HASH
);
39 $parser->setFunctionHook( 'padright', array( __CLASS__
, 'padright' ), SFH_NO_HASH
);
40 $parser->setFunctionHook( 'anchorencode', array( __CLASS__
, 'anchorencode' ), SFH_NO_HASH
);
41 $parser->setFunctionHook( 'special', array( __CLASS__
, 'special' ) );
42 $parser->setFunctionHook( 'defaultsort', array( __CLASS__
, 'defaultsort' ), SFH_NO_HASH
);
43 $parser->setFunctionHook( 'filepath', array( __CLASS__
, 'filepath' ), SFH_NO_HASH
);
44 $parser->setFunctionHook( 'pagesincategory', array( __CLASS__
, 'pagesincategory' ), SFH_NO_HASH
);
45 $parser->setFunctionHook( 'pagesize', array( __CLASS__
, 'pagesize' ), SFH_NO_HASH
);
46 $parser->setFunctionHook( 'tag', array( __CLASS__
, 'tagObj' ), SFH_OBJECT_ARGS
);
48 if ( $wgAllowDisplayTitle ) {
49 $parser->setFunctionHook( 'displaytitle', array( __CLASS__
, 'displaytitle' ), SFH_NO_HASH
);
51 if ( $wgAllowSlowParserFunctions ) {
52 $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__
, 'pagesinnamespace' ), SFH_NO_HASH
);
56 static function intFunction( $parser, $part1 = '' /*, ... */ ) {
57 if ( strval( $part1 ) !== '' ) {
58 $args = array_slice( func_get_args(), 2 );
59 $message = wfMsgGetKey( $part1, true, false, false );
60 $message = $parser->replaceVariables( $message ); // like $wgMessageCache->transform()
61 $message = wfMsgReplaceArgs( $message, $args );
64 return array( 'found' => false );
68 static function ns( $parser, $part1 = '' ) {
71 if ( intval( $part1 ) ||
$part1 == "0" ) {
72 $text = $wgContLang->getNsText( intval( $part1 ) );
75 $param = str_replace( ' ', '_', strtolower( $part1 ) );
76 $index = MWNamespace
::getCanonicalIndex( strtolower( $param ) );
77 if ( !is_null( $index ) ) {
78 $text = $wgContLang->getNsText( $index );
85 return array( 'found' => false );
89 static function urlencode( $parser, $s = '' ) {
90 return urlencode( $s );
93 static function lcfirst( $parser, $s = '' ) {
95 return $wgContLang->lcfirst( $s );
98 static function ucfirst( $parser, $s = '' ) {
100 return $wgContLang->ucfirst( $s );
103 static function lc( $parser, $s = '' ) {
105 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
106 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
108 return $wgContLang->lc( $s );
112 static function uc( $parser, $s = '' ) {
114 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
115 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
117 return $wgContLang->uc( $s );
121 static function localurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getLocalURL', $s, $arg ); }
122 static function localurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeLocalURL', $s, $arg ); }
123 static function fullurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getFullURL', $s, $arg ); }
124 static function fullurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeFullURL', $s, $arg ); }
126 static function urlFunction( $func, $s = '', $arg = null ) {
127 $title = Title
::newFromText( $s );
128 # Due to order of execution of a lot of bits, the values might be encoded
129 # before arriving here; if that's true, then the title can't be created
130 # and the variable will fail. If we can't get a decent title from the first
131 # attempt, url-decode and try for a second.
132 if( is_null( $title ) )
133 $title = Title
::newFromUrl( urldecode( $s ) );
134 if ( !is_null( $title ) ) {
135 if ( !is_null( $arg ) ) {
136 $text = $title->$func( $arg );
138 $text = $title->$func();
142 return array( 'found' => false );
146 static function formatNum( $parser, $num = '', $raw = null) {
147 if ( self
::israw( $raw ) ) {
148 return $parser->getFunctionLang()->parseFormattedNumber( $num );
150 return $parser->getFunctionLang()->formatNum( $num );
154 static function grammar( $parser, $case = '', $word = '' ) {
155 return $parser->getFunctionLang()->convertGrammar( $word, $case );
158 static function plural( $parser, $text = '') {
159 $forms = array_slice( func_get_args(), 2);
160 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
161 return $parser->getFunctionLang()->convertPlural( $text, $forms );
165 * Override the title of the page when viewed, provided we've been given a
166 * title which will normalise to the canonical title
168 * @param Parser $parser Parent parser
169 * @param string $text Desired title text
172 static function displaytitle( $parser, $text = '' ) {
173 $text = trim( Sanitizer
::decodeCharReferences( $text ) );
174 $title = Title
::newFromText( $text );
175 if( $title instanceof Title
&& $title->getFragment() == '' && $title->equals( $parser->mTitle
) )
176 $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 pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
219 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
223 * Return the number of pages in the given category, or 0 if it's nonexis-
224 * tent. This is an expensive parser function and can't be called too many
227 static function pagesincategory( $parser, $name = '', $raw = null ) {
228 static $cache = array();
229 $category = Category
::newFromName( $name );
231 if( !is_object( $category ) ) {
233 return self
::formatRaw( 0, $raw );
236 # Normalize name for cache
237 $name = $category->getName();
240 if( isset( $cache[$name] ) ) {
241 $count = $cache[$name];
242 } elseif( $parser->incrementExpensiveFunctionCount() ) {
243 $count = $cache[$name] = (int)$category->getPageCount();
245 return self
::formatRaw( $count, $raw );
249 * Return the size of the given page, or 0 if it's nonexistent. This is an
250 * expensive parser function and can't be called too many times per page.
252 * @FIXME This doesn't work correctly on preview for getting the size of
254 * @FIXME Title::getLength() documentation claims that it adds things to
255 * the link cache, so the local cache here should be unnecessary, but in
256 * fact calling getLength() repeatedly for the same $page does seem to
257 * run one query for each call?
259 static function pagesize( $parser, $page = '', $raw = null ) {
260 static $cache = array();
261 $title = Title
::newFromText($page);
263 if( !is_object( $title ) ) {
265 return self
::formatRaw( 0, $raw );
268 # Normalize name for cache
269 $page = $title->getPrefixedText();
272 if( isset( $cache[$page] ) ) {
273 $length = $cache[$page];
274 } elseif( $parser->incrementExpensiveFunctionCount() ) {
275 $length = $cache[$page] = $title->getLength();
277 // Register dependency in templatelinks
278 $id = $title->getArticleId();
279 $revid = Revision
::newFromTitle($title);
280 $parser->mOutput
->addTemplate($title, $id, $revid);
282 return self
::formatRaw( $length, $raw );
285 static function language( $parser, $arg = '' ) {
287 $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
288 return $lang != '' ?
$lang : $arg;
291 static function pad( $string = '', $length = 0, $char = 0, $direction = STR_PAD_RIGHT
) {
292 $length = min( max( $length, 0 ), 500 );
293 $char = substr( $char, 0, 1 );
294 return ( $string !== '' && (int)$length > 0 && strlen( trim( (string)$char ) ) > 0 )
295 ?
str_pad( $string, $length, (string)$char, $direction )
299 static function padleft( $parser, $string = '', $length = 0, $char = 0 ) {
300 return self
::pad( $string, $length, $char, STR_PAD_LEFT
);
303 static function padright( $parser, $string = '', $length = 0, $char = 0 ) {
304 return self
::pad( $string, $length, $char );
307 static function anchorencode( $parser, $text ) {
308 $a = urlencode( $text );
309 $a = strtr( $a, array( '%' => '.', '+' => '_' ) );
310 # leave colons alone, however
311 $a = str_replace( '.3A', ':', $a );
315 static function special( $parser, $text ) {
316 $title = SpecialPage
::getTitleForAlias( $text );
318 return $title->getPrefixedText();
320 return wfMsgForContent( 'nosuchspecialpage' );
324 public static function defaultsort( $parser, $text ) {
325 $text = trim( $text );
326 if( strlen( $text ) > 0 )
327 $parser->setDefaultSort( $text );
331 public static function filepath( $parser, $name='', $option='' ) {
332 $file = wfFindFile( $name );
334 $url = $file->getFullUrl();
335 if( $option == 'nowiki' ) {
336 return "<nowiki>$url</nowiki>";
345 * Parser function to extension tag adaptor
347 public static function tagObj( $parser, $frame, $args ) {
349 if ( !count( $args ) ) {
352 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
354 if ( count( $args ) ) {
355 $inner = $frame->expand( array_shift( $args ) );
360 $stripList = $parser->getStripList();
361 if ( !in_array( $tagName, $stripList ) ) {
362 return '<span class="error">' .
363 wfMsg( 'unknown_extension_tag', $tagName ) .
367 $attributes = array();
368 foreach ( $args as $arg ) {
369 $bits = $arg->splitArg();
370 if ( strval( $bits['index'] ) === '' ) {
371 $name = $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
);
372 $value = trim( $frame->expand( $bits['value'] ) );
373 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
374 $value = isset( $m[1] ) ?
$m[1] : '';
376 $attributes[$name] = $value;
383 'attributes' => $attributes,
384 'close' => "</$tagName>",
386 return $parser->extensionSubstitution( $params, $frame );