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 static function register( $parser ) {
34 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
36 # Syntax for arguments (see self::setFunctionHook):
37 # "name for lookup in localized magic words array",
39 # optional SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}}
40 # instead of {{#int:...}})
42 $parser->setFunctionHook( 'int', array( __CLASS__
, 'intFunction' ), SFH_NO_HASH
);
43 $parser->setFunctionHook( 'ns', array( __CLASS__
, 'ns' ), SFH_NO_HASH
);
44 $parser->setFunctionHook( 'nse', array( __CLASS__
, 'nse' ), SFH_NO_HASH
);
45 $parser->setFunctionHook( 'urlencode', array( __CLASS__
, 'urlencode' ), SFH_NO_HASH
);
46 $parser->setFunctionHook( 'lcfirst', array( __CLASS__
, 'lcfirst' ), SFH_NO_HASH
);
47 $parser->setFunctionHook( 'ucfirst', array( __CLASS__
, 'ucfirst' ), SFH_NO_HASH
);
48 $parser->setFunctionHook( 'lc', array( __CLASS__
, 'lc' ), SFH_NO_HASH
);
49 $parser->setFunctionHook( 'uc', array( __CLASS__
, 'uc' ), SFH_NO_HASH
);
50 $parser->setFunctionHook( 'localurl', array( __CLASS__
, 'localurl' ), SFH_NO_HASH
);
51 $parser->setFunctionHook( 'localurle', array( __CLASS__
, 'localurle' ), SFH_NO_HASH
);
52 $parser->setFunctionHook( 'fullurl', array( __CLASS__
, 'fullurl' ), SFH_NO_HASH
);
53 $parser->setFunctionHook( 'fullurle', array( __CLASS__
, 'fullurle' ), SFH_NO_HASH
);
54 $parser->setFunctionHook( 'canonicalurl', array( __CLASS__
, 'canonicalurl' ), SFH_NO_HASH
);
55 $parser->setFunctionHook( 'canonicalurle', array( __CLASS__
, 'canonicalurle' ), SFH_NO_HASH
);
56 $parser->setFunctionHook( 'formatnum', array( __CLASS__
, 'formatnum' ), SFH_NO_HASH
);
57 $parser->setFunctionHook( 'grammar', array( __CLASS__
, 'grammar' ), SFH_NO_HASH
);
58 $parser->setFunctionHook( 'gender', array( __CLASS__
, 'gender' ), SFH_NO_HASH
);
59 $parser->setFunctionHook( 'plural', array( __CLASS__
, 'plural' ), SFH_NO_HASH
);
60 $parser->setFunctionHook( 'numberofpages', array( __CLASS__
, 'numberofpages' ), SFH_NO_HASH
);
61 $parser->setFunctionHook( 'numberofusers', array( __CLASS__
, 'numberofusers' ), SFH_NO_HASH
);
62 $parser->setFunctionHook( 'numberofactiveusers', array( __CLASS__
, 'numberofactiveusers' ), SFH_NO_HASH
);
63 $parser->setFunctionHook( 'numberofarticles', array( __CLASS__
, 'numberofarticles' ), SFH_NO_HASH
);
64 $parser->setFunctionHook( 'numberoffiles', array( __CLASS__
, 'numberoffiles' ), SFH_NO_HASH
);
65 $parser->setFunctionHook( 'numberofadmins', array( __CLASS__
, 'numberofadmins' ), SFH_NO_HASH
);
66 $parser->setFunctionHook( 'numberingroup', array( __CLASS__
, 'numberingroup' ), SFH_NO_HASH
);
67 $parser->setFunctionHook( 'numberofedits', array( __CLASS__
, 'numberofedits' ), SFH_NO_HASH
);
68 $parser->setFunctionHook( 'numberofviews', array( __CLASS__
, 'numberofviews' ), SFH_NO_HASH
);
69 $parser->setFunctionHook( 'language', array( __CLASS__
, 'language' ), SFH_NO_HASH
);
70 $parser->setFunctionHook( 'padleft', array( __CLASS__
, 'padleft' ), SFH_NO_HASH
);
71 $parser->setFunctionHook( 'padright', array( __CLASS__
, 'padright' ), SFH_NO_HASH
);
72 $parser->setFunctionHook( 'anchorencode', array( __CLASS__
, 'anchorencode' ), SFH_NO_HASH
);
73 $parser->setFunctionHook( 'special', array( __CLASS__
, 'special' ) );
74 $parser->setFunctionHook( 'speciale', array( __CLASS__
, 'speciale' ) );
75 $parser->setFunctionHook( 'defaultsort', array( __CLASS__
, 'defaultsort' ), SFH_NO_HASH
);
76 $parser->setFunctionHook( 'filepath', array( __CLASS__
, 'filepath' ), SFH_NO_HASH
);
77 $parser->setFunctionHook( 'pagesincategory', array( __CLASS__
, 'pagesincategory' ), SFH_NO_HASH
);
78 $parser->setFunctionHook( 'pagesize', array( __CLASS__
, 'pagesize' ), SFH_NO_HASH
);
79 $parser->setFunctionHook( 'protectionlevel', array( __CLASS__
, 'protectionlevel' ), SFH_NO_HASH
);
80 $parser->setFunctionHook( 'namespace', array( __CLASS__
, 'mwnamespace' ), SFH_NO_HASH
);
81 $parser->setFunctionHook( 'namespacee', array( __CLASS__
, 'namespacee' ), SFH_NO_HASH
);
82 $parser->setFunctionHook( 'namespacenumber', array( __CLASS__
, 'namespacenumber' ), SFH_NO_HASH
);
83 $parser->setFunctionHook( 'talkspace', array( __CLASS__
, 'talkspace' ), SFH_NO_HASH
);
84 $parser->setFunctionHook( 'talkspacee', array( __CLASS__
, 'talkspacee' ), SFH_NO_HASH
);
85 $parser->setFunctionHook( 'subjectspace', array( __CLASS__
, 'subjectspace' ), SFH_NO_HASH
);
86 $parser->setFunctionHook( 'subjectspacee', array( __CLASS__
, 'subjectspacee' ), SFH_NO_HASH
);
87 $parser->setFunctionHook( 'pagename', array( __CLASS__
, 'pagename' ), SFH_NO_HASH
);
88 $parser->setFunctionHook( 'pagenamee', array( __CLASS__
, 'pagenamee' ), SFH_NO_HASH
);
89 $parser->setFunctionHook( 'fullpagename', array( __CLASS__
, 'fullpagename' ), SFH_NO_HASH
);
90 $parser->setFunctionHook( 'fullpagenamee', array( __CLASS__
, 'fullpagenamee' ), SFH_NO_HASH
);
91 $parser->setFunctionHook( 'basepagename', array( __CLASS__
, 'basepagename' ), SFH_NO_HASH
);
92 $parser->setFunctionHook( 'basepagenamee', array( __CLASS__
, 'basepagenamee' ), SFH_NO_HASH
);
93 $parser->setFunctionHook( 'subpagename', array( __CLASS__
, 'subpagename' ), SFH_NO_HASH
);
94 $parser->setFunctionHook( 'subpagenamee', array( __CLASS__
, 'subpagenamee' ), SFH_NO_HASH
);
95 $parser->setFunctionHook( 'talkpagename', array( __CLASS__
, 'talkpagename' ), SFH_NO_HASH
);
96 $parser->setFunctionHook( 'talkpagenamee', array( __CLASS__
, 'talkpagenamee' ), SFH_NO_HASH
);
97 $parser->setFunctionHook( 'subjectpagename', array( __CLASS__
, 'subjectpagename' ), SFH_NO_HASH
);
98 $parser->setFunctionHook( 'subjectpagenamee', array( __CLASS__
, 'subjectpagenamee' ), SFH_NO_HASH
);
99 $parser->setFunctionHook( 'tag', array( __CLASS__
, 'tagObj' ), SFH_OBJECT_ARGS
);
100 $parser->setFunctionHook( 'formatdate', array( __CLASS__
, 'formatDate' ) );
102 if ( $wgAllowDisplayTitle ) {
103 $parser->setFunctionHook( 'displaytitle', array( __CLASS__
, 'displaytitle' ), SFH_NO_HASH
);
105 if ( $wgAllowSlowParserFunctions ) {
106 $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__
, 'pagesinnamespace' ), SFH_NO_HASH
);
111 * @param $parser Parser
112 * @param string $part1
115 static function intFunction( $parser, $part1 = '' /*, ... */ ) {
116 if ( strval( $part1 ) !== '' ) {
117 $args = array_slice( func_get_args(), 2 );
118 $message = wfMessage( $part1, $args )->inLanguage( $parser->getOptions()->getUserLangObj() )->plain();
119 return array( $message, 'noparse' => false );
121 return array( 'found' => false );
126 * @param $parser Parser
128 * @param null $defaultPref
129 * @return mixed|string
131 static function formatDate( $parser, $date, $defaultPref = null ) {
132 $lang = $parser->getFunctionLang();
133 $df = DateFormatter
::getInstance( $lang );
135 $date = trim( $date );
137 $pref = $parser->getOptions()->getDateFormat();
139 // Specify a different default date format other than the the normal default
140 // iff the user has 'default' for their setting
141 if ( $pref == 'default' && $defaultPref )
142 $pref = $defaultPref;
144 $date = $df->reformat( $pref, $date, array( 'match-whole' ) );
148 static function ns( $parser, $part1 = '' ) {
150 if ( intval( $part1 ) ||
$part1 == "0" ) {
151 $index = intval( $part1 );
153 $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
155 if ( $index !== false ) {
156 return $wgContLang->getFormattedNsText( $index );
158 return array( 'found' => false );
162 static function nse( $parser, $part1 = '' ) {
163 $ret = self
::ns( $parser, $part1 );
164 if ( is_string( $ret ) ) {
165 $ret = wfUrlencode( str_replace( ' ', '_', $ret ) );
171 * urlencodes a string according to one of three patterns: (bug 22474)
173 * By default (for HTTP "query" strings), spaces are encoded as '+'.
174 * Or to encode a value for the HTTP "path", spaces are encoded as '%20'.
175 * For links to "wiki"s, or similar software, spaces are encoded as '_',
177 * @param $parser Parser object
178 * @param string $s The text to encode.
179 * @param string $arg (optional): The type of encoding.
182 static function urlencode( $parser, $s = '', $arg = null ) {
183 static $magicWords = null;
184 if ( is_null( $magicWords ) ) {
185 $magicWords = new MagicWordArray( array( 'url_path', 'url_query', 'url_wiki' ) );
187 switch( $magicWords->matchStartToEnd( $arg ) ) {
189 // Encode as though it's a wiki page, '_' for ' '.
191 $func = 'wfUrlencode';
192 $s = str_replace( ' ', '_', $s );
195 // Encode for an HTTP Path, '%20' for ' '.
197 $func = 'rawurlencode';
200 // Encode for HTTP query, '+' for ' '.
205 return $parser->markerSkipCallback( $s, $func );
208 static function lcfirst( $parser, $s = '' ) {
210 return $wgContLang->lcfirst( $s );
213 static function ucfirst( $parser, $s = '' ) {
215 return $wgContLang->ucfirst( $s );
219 * @param $parser Parser
223 static function lc( $parser, $s = '' ) {
225 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
229 * @param $parser Parser
233 static function uc( $parser, $s = '' ) {
235 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
238 static function localurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getLocalURL', $s, $arg ); }
239 static function localurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeLocalURL', $s, $arg ); }
240 static function fullurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getFullURL', $s, $arg ); }
241 static function fullurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeFullURL', $s, $arg ); }
242 static function canonicalurl( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'getCanonicalURL', $s, $arg ); }
243 static function canonicalurle( $parser, $s = '', $arg = null ) { return self
::urlFunction( 'escapeCanonicalURL', $s, $arg ); }
245 static function urlFunction( $func, $s = '', $arg = null ) {
246 $title = Title
::newFromText( $s );
247 # Due to order of execution of a lot of bits, the values might be encoded
248 # before arriving here; if that's true, then the title can't be created
249 # and the variable will fail. If we can't get a decent title from the first
250 # attempt, url-decode and try for a second.
251 if( is_null( $title ) )
252 $title = Title
::newFromURL( urldecode( $s ) );
253 if( !is_null( $title ) ) {
254 # Convert NS_MEDIA -> NS_FILE
255 if( $title->getNamespace() == NS_MEDIA
) {
256 $title = Title
::makeTitle( NS_FILE
, $title->getDBkey() );
258 if( !is_null( $arg ) ) {
259 $text = $title->$func( $arg );
261 $text = $title->$func();
265 return array( 'found' => false );
270 * @param $parser Parser
275 static function formatnum( $parser, $num = '', $arg = null ) {
276 if ( self
::matchAgainstMagicword( 'rawsuffix', $arg ) ) {
277 $func = array( $parser->getFunctionLang(), 'parseFormattedNumber' );
278 } elseif ( self
::matchAgainstMagicword( 'nocommafysuffix', $arg ) ) {
279 $func = array( $parser->getFunctionLang(), 'formatNumNoSeparators' );
281 $func = array( $parser->getFunctionLang(), 'formatNum' );
283 return $parser->markerSkipCallback( $num, $func );
287 * @param $parser Parser
288 * @param string $case
289 * @param string $word
292 static function grammar( $parser, $case = '', $word = '' ) {
293 $word = $parser->killMarkers( $word );
294 return $parser->getFunctionLang()->convertGrammar( $word, $case );
298 * @param $parser Parser
299 * @param $username string
302 static function gender( $parser, $username ) {
303 wfProfileIn( __METHOD__
);
304 $forms = array_slice( func_get_args(), 2 );
306 // Some shortcuts to avoid loading user data unnecessarily
307 if ( count( $forms ) === 0 ) {
308 wfProfileOut( __METHOD__
);
310 } elseif ( count( $forms ) === 1 ) {
311 wfProfileOut( __METHOD__
);
315 $username = trim( $username );
318 $gender = User
::getDefaultOption( 'gender' );
321 $title = Title
::newFromText( $username );
323 if ( $title && $title->getNamespace() == NS_USER
) {
324 $username = $title->getText();
327 // check parameter, or use the ParserOptions if in interface message
328 $user = User
::newFromName( $username );
330 $gender = GenderCache
::singleton()->getGenderOf( $user, __METHOD__
);
331 } elseif ( $username === '' && $parser->getOptions()->getInterfaceMessage() ) {
332 $gender = GenderCache
::singleton()->getGenderOf( $parser->getOptions()->getUser(), __METHOD__
);
334 $ret = $parser->getFunctionLang()->gender( $gender, $forms );
335 wfProfileOut( __METHOD__
);
340 * @param $parser Parser
341 * @param string $text
344 static function plural( $parser, $text = '' ) {
345 $forms = array_slice( func_get_args(), 2 );
346 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
347 settype( $text, ctype_digit( $text ) ?
'int' : 'float' );
348 return $parser->getFunctionLang()->convertPlural( $text, $forms );
352 * Override the title of the page when viewed, provided we've been given a
353 * title which will normalise to the canonical title
355 * @param $parser Parser: parent parser
356 * @param string $text desired title text
359 static function displaytitle( $parser, $text = '' ) {
360 global $wgRestrictDisplayTitle;
362 #parse a limited subset of wiki markup (just the single quote items)
363 $text = $parser->doQuotes( $text );
365 #remove stripped text (e.g. the UNIQ-QINU stuff) that was generated by tag extensions/whatever
366 $text = preg_replace( '/' . preg_quote( $parser->uniqPrefix(), '/' ) . '.*?'
367 . preg_quote( Parser
::MARKER_SUFFIX
, '/' ) . '/', '', $text );
369 #list of disallowed tags for DISPLAYTITLE
370 #these will be escaped even though they are allowed in normal wiki text
371 $bad = array( 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'blockquote', 'ol', 'ul', 'li', 'hr',
372 'table', 'tr', 'th', 'td', 'dl', 'dd', 'caption', 'p', 'ruby', 'rb', 'rt', 'rp', 'br' );
374 #only requested titles that normalize to the actual title are allowed through
375 #if $wgRestrictDisplayTitle is true (it is by default)
376 #mimic the escaping process that occurs in OutputPage::setPageTitle
377 $text = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $text, null, array(), array(), $bad ) );
378 $title = Title
::newFromText( Sanitizer
::stripAllTags( $text ) );
380 if( !$wgRestrictDisplayTitle ) {
381 $parser->mOutput
->setDisplayTitle( $text );
383 if ( $title instanceof Title
&& $title->getFragment() == '' && $title->equals( $parser->mTitle
) ) {
384 $parser->mOutput
->setDisplayTitle( $text );
392 * Matches the given value against the value of given magic word
394 * @param string $magicword magic word key
395 * @param mixed $value value to match
396 * @return boolean true on successful match
398 static private function matchAgainstMagicword( $magicword, $value ) {
399 if ( strval( $value ) === '' ) {
402 $mwObject = MagicWord
::get( $magicword );
403 return $mwObject->match( $value );
406 static function formatRaw( $num, $raw ) {
407 if( self
::matchAgainstMagicword( 'rawsuffix', $raw ) ) {
411 return $wgContLang->formatNum( $num );
414 static function numberofpages( $parser, $raw = null ) {
415 return self
::formatRaw( SiteStats
::pages(), $raw );
417 static function numberofusers( $parser, $raw = null ) {
418 return self
::formatRaw( SiteStats
::users(), $raw );
420 static function numberofactiveusers( $parser, $raw = null ) {
421 return self
::formatRaw( SiteStats
::activeUsers(), $raw );
423 static function numberofarticles( $parser, $raw = null ) {
424 return self
::formatRaw( SiteStats
::articles(), $raw );
426 static function numberoffiles( $parser, $raw = null ) {
427 return self
::formatRaw( SiteStats
::images(), $raw );
429 static function numberofadmins( $parser, $raw = null ) {
430 return self
::formatRaw( SiteStats
::numberingroup( 'sysop' ), $raw );
432 static function numberofedits( $parser, $raw = null ) {
433 return self
::formatRaw( SiteStats
::edits(), $raw );
435 static function numberofviews( $parser, $raw = null ) {
436 return self
::formatRaw( SiteStats
::views(), $raw );
438 static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
439 return self
::formatRaw( SiteStats
::pagesInNs( intval( $namespace ) ), $raw );
441 static function numberingroup( $parser, $name = '', $raw = null) {
442 return self
::formatRaw( SiteStats
::numberingroup( strtolower( $name ) ), $raw );
446 * Given a title, return the namespace name that would be given by the
447 * corresponding magic word
448 * Note: function name changed to "mwnamespace" rather than "namespace"
449 * to not break PHP 5.3
450 * @return mixed|string
452 static function mwnamespace( $parser, $title = null ) {
453 $t = Title
::newFromText( $title );
456 return str_replace( '_', ' ', $t->getNsText() );
458 static function namespacee( $parser, $title = null ) {
459 $t = Title
::newFromText( $title );
462 return wfUrlencode( $t->getNsText() );
464 static function namespacenumber( $parser, $title = null ) {
465 $t = Title
::newFromText( $title );
468 return $t->getNamespace();
470 static function talkspace( $parser, $title = null ) {
471 $t = Title
::newFromText( $title );
472 if ( is_null( $t ) ||
!$t->canTalk() )
474 return str_replace( '_', ' ', $t->getTalkNsText() );
476 static function talkspacee( $parser, $title = null ) {
477 $t = Title
::newFromText( $title );
478 if ( is_null( $t ) ||
!$t->canTalk() )
480 return wfUrlencode( $t->getTalkNsText() );
482 static function subjectspace( $parser, $title = null ) {
483 $t = Title
::newFromText( $title );
486 return str_replace( '_', ' ', $t->getSubjectNsText() );
488 static function subjectspacee( $parser, $title = null ) {
489 $t = Title
::newFromText( $title );
492 return wfUrlencode( $t->getSubjectNsText() );
496 * Functions to get and normalize pagenames, corresponding to the magic words
500 static function pagename( $parser, $title = null ) {
501 $t = Title
::newFromText( $title );
504 return wfEscapeWikiText( $t->getText() );
506 static function pagenamee( $parser, $title = null ) {
507 $t = Title
::newFromText( $title );
510 return wfEscapeWikiText( $t->getPartialURL() );
512 static function fullpagename( $parser, $title = null ) {
513 $t = Title
::newFromText( $title );
514 if ( is_null( $t ) ||
!$t->canTalk() )
516 return wfEscapeWikiText( $t->getPrefixedText() );
518 static function fullpagenamee( $parser, $title = null ) {
519 $t = Title
::newFromText( $title );
520 if ( is_null( $t ) ||
!$t->canTalk() )
522 return wfEscapeWikiText( $t->getPrefixedURL() );
524 static function subpagename( $parser, $title = null ) {
525 $t = Title
::newFromText( $title );
528 return wfEscapeWikiText( $t->getSubpageText() );
530 static function subpagenamee( $parser, $title = null ) {
531 $t = Title
::newFromText( $title );
534 return wfEscapeWikiText( $t->getSubpageUrlForm() );
536 static function basepagename( $parser, $title = null ) {
537 $t = Title
::newFromText( $title );
540 return wfEscapeWikiText( $t->getBaseText() );
542 static function basepagenamee( $parser, $title = null ) {
543 $t = Title
::newFromText( $title );
546 return wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $t->getBaseText() ) ) );
548 static function talkpagename( $parser, $title = null ) {
549 $t = Title
::newFromText( $title );
550 if ( is_null( $t ) ||
!$t->canTalk() )
552 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
554 static function talkpagenamee( $parser, $title = null ) {
555 $t = Title
::newFromText( $title );
556 if ( is_null( $t ) ||
!$t->canTalk() )
558 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedURL() );
560 static function subjectpagename( $parser, $title = null ) {
561 $t = Title
::newFromText( $title );
564 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
566 static function subjectpagenamee( $parser, $title = null ) {
567 $t = Title
::newFromText( $title );
570 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedURL() );
574 * Return the number of pages, files or subcats in the given category,
575 * or 0 if it's nonexistent. This is an expensive parser function and
576 * can't be called too many times per page.
579 static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
581 static $magicWords = null;
582 if ( is_null( $magicWords ) ) {
583 $magicWords = new MagicWordArray( array(
584 'pagesincategory_all',
585 'pagesincategory_pages',
586 'pagesincategory_subcats',
587 'pagesincategory_files'
590 static $cache = array();
592 // split the given option to its variable
593 if( self
::matchAgainstMagicword( 'rawsuffix', $arg1 ) ) {
594 //{{pagesincategory:|raw[|type]}}
596 $type = $magicWords->matchStartToEnd( $arg2 );
598 //{{pagesincategory:[|type[|raw]]}}
599 $type = $magicWords->matchStartToEnd( $arg1 );
602 if( !$type ) { //backward compatibility
603 $type = 'pagesincategory_all';
606 $title = Title
::makeTitleSafe( NS_CATEGORY
, $name );
607 if( !$title ) { # invalid title
608 return self
::formatRaw( 0, $raw );
610 $wgContLang->findVariantLink( $name, $title, true );
612 // Normalize name for cache
613 $name = $title->getDBkey();
615 if( !isset( $cache[$name] ) ) {
616 $category = Category
::newFromTitle( $title );
618 $allCount = $subcatCount = $fileCount = $pagesCount = 0;
619 if( $parser->incrementExpensiveFunctionCount() ) {
620 // $allCount is the total number of cat members,
621 // not the count of how many members are normal pages.
622 $allCount = (int)$category->getPageCount();
623 $subcatCount = (int)$category->getSubcatCount();
624 $fileCount = (int)$category->getFileCount();
625 $pagesCount = $allCount - $subcatCount - $fileCount;
627 $cache[$name]['pagesincategory_all'] = $allCount;
628 $cache[$name]['pagesincategory_pages'] = $pagesCount;
629 $cache[$name]['pagesincategory_subcats'] = $subcatCount;
630 $cache[$name]['pagesincategory_files'] = $fileCount;
633 $count = $cache[$name][$type];
634 return self
::formatRaw( $count, $raw );
638 * Return the size of the given page, or 0 if it's nonexistent. This is an
639 * expensive parser function and can't be called too many times per page.
641 * @todo FIXME: This doesn't work correctly on preview for getting the size
642 * of the current page.
643 * @todo FIXME: Title::getLength() documentation claims that it adds things
644 * to the link cache, so the local cache here should be unnecessary, but
645 * in fact calling getLength() repeatedly for the same $page does seem to
646 * run one query for each call?
647 * @todo Document parameters
649 * @param $parser Parser
650 * @param string $page TODO DOCUMENT (Default: empty string)
651 * @param $raw TODO DOCUMENT (Default: null)
654 static function pagesize( $parser, $page = '', $raw = null ) {
655 static $cache = array();
656 $title = Title
::newFromText( $page );
658 if( !is_object( $title ) ) {
660 return self
::formatRaw( 0, $raw );
663 # Normalize name for cache
664 $page = $title->getPrefixedText();
667 if( isset( $cache[$page] ) ) {
668 $length = $cache[$page];
669 } elseif( $parser->incrementExpensiveFunctionCount() ) {
670 $rev = Revision
::newFromTitle( $title, false, Revision
::READ_NORMAL
);
671 $pageID = $rev ?
$rev->getPage() : 0;
672 $revID = $rev ?
$rev->getId() : 0;
673 $length = $cache[$page] = $rev ?
$rev->getSize() : 0;
675 // Register dependency in templatelinks
676 $parser->mOutput
->addTemplate( $title, $pageID, $revID );
678 return self
::formatRaw( $length, $raw );
682 * Returns the requested protection level for the current page
684 * @param Parser $parser
685 * @param string $type
686 * @param string $title
690 static function protectionlevel( $parser, $type = '', $title = '' ) {
691 $titleObject = Title
::newFromText( $title );
692 if ( !( $titleObject instanceof Title
) ) {
693 $titleObject = $parser->mTitle
;
695 $restrictions = $titleObject->getRestrictions( strtolower( $type ) );
696 # Title::getRestrictions returns an array, its possible it may have
697 # multiple values in the future
698 return implode( $restrictions, ',' );
702 * Gives language names.
703 * @param $parser Parser
704 * @param string $code Language code (of which to get name)
705 * @param string $inLanguage Language code (in which to get name)
708 static function language( $parser, $code = '', $inLanguage = '' ) {
709 $code = strtolower( $code );
710 $inLanguage = strtolower( $inLanguage );
711 $lang = Language
::fetchLanguageName( $code, $inLanguage );
712 return $lang !== '' ?
$lang : wfBCP47( $code );
716 * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
719 static function pad( $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT
) {
720 $padding = $parser->killMarkers( $padding );
721 $lengthOfPadding = mb_strlen( $padding );
722 if ( $lengthOfPadding == 0 ) return $string;
724 # The remaining length to add counts down to 0 as padding is added
725 $length = min( $length, 500 ) - mb_strlen( $string );
726 # $finalPadding is just $padding repeated enough times so that
727 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
729 while ( $length > 0 ) {
730 # If $length < $lengthofPadding, truncate $padding so we get the
731 # exact length desired.
732 $finalPadding .= mb_substr( $padding, 0, $length );
733 $length -= $lengthOfPadding;
736 if ( $direction == STR_PAD_LEFT
) {
737 return $finalPadding . $string;
739 return $string . $finalPadding;
743 static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
744 return self
::pad( $parser, $string, $length, $padding, STR_PAD_LEFT
);
747 static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
748 return self
::pad( $parser, $string, $length, $padding );
752 * @param $parser Parser
756 static function anchorencode( $parser, $text ) {
757 $text = $parser->killMarkers( $text );
758 return (string)substr( $parser->guessSectionNameFromWikiText( $text ), 1 );
761 static function special( $parser, $text ) {
762 list( $page, $subpage ) = SpecialPageFactory
::resolveAlias( $text );
764 $title = SpecialPage
::getTitleFor( $page, $subpage );
765 return $title->getPrefixedText();
767 return wfMessage( 'nosuchspecialpage' )->inContentLanguage()->text();
771 static function speciale( $parser, $text ) {
772 return wfUrlencode( str_replace( ' ', '_', self
::special( $parser, $text ) ) );
776 * @param $parser Parser
777 * @param string $text The sortkey to use
778 * @param string $uarg Either "noreplace" or "noerror" (in en)
779 * both suppress errors, and noreplace does nothing if
780 * a default sortkey already exists.
783 public static function defaultsort( $parser, $text, $uarg = '' ) {
784 static $magicWords = null;
785 if ( is_null( $magicWords ) ) {
786 $magicWords = new MagicWordArray( array( 'defaultsort_noerror', 'defaultsort_noreplace' ) );
788 $arg = $magicWords->matchStartToEnd( $uarg );
790 $text = trim( $text );
791 if( strlen( $text ) == 0 )
793 $old = $parser->getCustomDefaultSort();
794 if ( $old === false ||
$arg !== 'defaultsort_noreplace' ) {
795 $parser->setDefaultSort( $text );
798 if( $old === false ||
$old == $text ||
$arg ) {
801 return( '<span class="error">' .
802 wfMessage( 'duplicate-defaultsort', $old, $text )->inContentLanguage()->escaped() .
807 // Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}} or {{filepath|300|nowiki}}
808 // or {{filepath|300px}}, {{filepath|200x300px}}, {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}
809 public static function filepath( $parser, $name = '', $argA = '', $argB = '' ) {
810 $file = wfFindFile( $name );
812 if( $argA == 'nowiki' ) {
813 // {{filepath: | option [| size] }}
815 $parsedWidthParam = $parser->parseWidthParam( $argB );
817 // {{filepath: [| size [|option]] }}
818 $parsedWidthParam = $parser->parseWidthParam( $argA );
819 $isNowiki = ($argB == 'nowiki');
823 $url = $file->getFullUrl();
825 // If a size is requested...
826 if ( count( $parsedWidthParam ) ) {
827 $mto = $file->transform( $parsedWidthParam );
829 if ( $mto && !$mto->isError() ) {
830 // ... change the URL to point to a thumbnail.
831 $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE
);
835 return array( $url, 'nowiki' => true );
844 * Parser function to extension tag adaptor
847 public static function tagObj( $parser, $frame, $args ) {
848 if ( !count( $args ) ) {
851 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
853 if ( count( $args ) ) {
854 $inner = $frame->expand( array_shift( $args ) );
859 $stripList = $parser->getStripList();
860 if ( !in_array( $tagName, $stripList ) ) {
861 return '<span class="error">' .
862 wfMessage( 'unknown_extension_tag', $tagName )->inContentLanguage()->text() .
866 $attributes = array();
867 foreach ( $args as $arg ) {
868 $bits = $arg->splitArg();
869 if ( strval( $bits['index'] ) === '' ) {
870 $name = trim( $frame->expand( $bits['name'], PPFrame
::STRIP_COMMENTS
) );
871 $value = trim( $frame->expand( $bits['value'] ) );
872 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
873 $value = isset( $m[1] ) ?
$m[1] : '';
875 $attributes[$name] = $value;
882 'attributes' => $attributes,
883 'close' => "</$tagName>",
885 return $parser->extensionSubstitution( $params, $frame );