includes/parser/CoreParserFunctions.php

   1 <?php
   2 /**
   3  * Parser functions provided by MediaWiki core
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Parser
  22  */
  23
  24 /**
  25  * Various core parser functions, registered in Parser::firstCallInit()
  26  * @ingroup Parser
  27  */
  28 class CoreParserFunctions {
  29         /**
  30          * @param $parser Parser
  31          * @return void
  32          */
  33         static function register( $parser ) {
  34                 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
  35
  36                 # Syntax for arguments (see self::setFunctionHook):
  37                 #  "name for lookup in localized magic words array",
  38                 #  function callback,
  39                 #  optional SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}}
  40                 #    instead of {{#int:...}})
  41
  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'       ) );
 101
 102                 if ( $wgAllowDisplayTitle ) {
 103                         $parser->setFunctionHook( 'displaytitle', array( __CLASS__, 'displaytitle' ), SFH_NO_HASH );
 104                 }
 105                 if ( $wgAllowSlowParserFunctions ) {
 106                         $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__, 'pagesinnamespace' ), SFH_NO_HASH );
 107                 }
 108         }
 109
 110         /**
 111          * @param $parser Parser
 112          * @param string $part1
 113          * @return array
 114          */
 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 );
 120                 } else {
 121                         return array( 'found' => false );
 122                 }
 123         }
 124
 125         /**
 126          * @param $parser Parser
 127          * @param  $date
 128          * @param null $defaultPref
 129          * @return mixed|string
 130          */
 131         static function formatDate( $parser, $date, $defaultPref = null ) {
 132                 $lang = $parser->getFunctionLang();
 133                 $df = DateFormatter::getInstance( $lang );
 134
 135                 $date = trim( $date );
 136
 137                 $pref = $parser->getOptions()->getDateFormat();
 138
 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;
 143
 144                 $date = $df->reformat( $pref, $date, array( 'match-whole' ) );
 145                 return $date;
 146         }
 147
 148         static function ns( $parser, $part1 = '' ) {
 149                 global $wgContLang;
 150                 if ( intval( $part1 ) || $part1 == "0" ) {
 151                         $index = intval( $part1 );
 152                 } else {
 153                         $index = $wgContLang->getNsIndex( str_replace( ' ', '_', $part1 ) );
 154                 }
 155                 if ( $index !== false ) {
 156                         return $wgContLang->getFormattedNsText( $index );
 157                 } else {
 158                         return array( 'found' => false );
 159                 }
 160         }
 161
 162         static function nse( $parser, $part1 = '' ) {
 163                 $ret = self::ns( $parser, $part1 );
 164                 if ( is_string( $ret ) ) {
 165                         $ret = wfUrlencode( str_replace( ' ', '_', $ret ) );
 166                 }
 167                 return $ret;
 168         }
 169
 170         /**
 171          * urlencodes a string according to one of three patterns: (bug 22474)
 172          *
 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 '_',
 176          *
 177          * @param $parser Parser object
 178          * @param $s String: The text to encode.
 179          * @param $arg String (optional): The type of encoding.
 180          * @return string
 181          */
 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' ) );
 186                 }
 187                 switch( $magicWords->matchStartToEnd( $arg ) ) {
 188
 189                         // Encode as though it's a wiki page, '_' for ' '.
 190                         case 'url_wiki':
 191                                 $func = 'wfUrlencode';
 192                                 $s = str_replace( ' ', '_', $s );
 193                                 break;
 194
 195                         // Encode for an HTTP Path, '%20' for ' '.
 196                         case 'url_path':
 197                                 $func = 'rawurlencode';
 198                                 break;
 199
 200                         // Encode for HTTP query, '+' for ' '.
 201                         case 'url_query':
 202                         default:
 203                                 $func = 'urlencode';
 204                 }
 205                 return $parser->markerSkipCallback( $s, $func );
 206         }
 207
 208         static function lcfirst( $parser, $s = '' ) {
 209                 global $wgContLang;
 210                 return $wgContLang->lcfirst( $s );
 211         }
 212
 213         static function ucfirst( $parser, $s = '' ) {
 214                 global $wgContLang;
 215                 return $wgContLang->ucfirst( $s );
 216         }
 217
 218         /**
 219          * @param $parser Parser
 220          * @param string $s
 221          * @return
 222          */
 223         static function lc( $parser, $s = '' ) {
 224                 global $wgContLang;
 225                 return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
 226         }
 227
 228         /**
 229          * @param $parser Parser
 230          * @param string $s
 231          * @return
 232          */
 233         static function uc( $parser, $s = '' ) {
 234                 global $wgContLang;
 235                 return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
 236         }
 237
 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 ); }
 244
 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() );
 257                         }
 258                         if( !is_null( $arg ) ) {
 259                                 $text = $title->$func( $arg );
 260                         } else {
 261                                 $text = $title->$func();
 262                         }
 263                         return $text;
 264                 } else {
 265                         return array( 'found' => false );
 266                 }
 267         }
 268
 269         /**
 270          * @param $parser Parser
 271          * @param string $num
 272          * @param null $raw
 273          * @return
 274          */
 275         static function formatnum( $parser, $num = '', $raw = null) {
 276                 if ( self::isRaw( $raw ) ) {
 277                         $func = array( $parser->getFunctionLang(), 'parseFormattedNumber' );
 278                 } else {
 279                         $func = array( $parser->getFunctionLang(), 'formatNum' );
 280                 }
 281                 return $parser->markerSkipCallback( $num, $func );
 282         }
 283
 284         /**
 285          * @param $parser Parser
 286          * @param string $case
 287          * @param string $word
 288          * @return
 289          */
 290         static function grammar( $parser, $case = '', $word = '' ) {
 291                 $word = $parser->killMarkers( $word );
 292                 return $parser->getFunctionLang()->convertGrammar( $word, $case );
 293         }
 294
 295         /**
 296          * @param $parser Parser
 297          * @param $username string
 298          * @return
 299          */
 300         static function gender( $parser, $username ) {
 301                 wfProfileIn( __METHOD__ );
 302                 $forms = array_slice( func_get_args(), 2 );
 303
 304                 // Some shortcuts to avoid loading user data unnecessarily
 305                 if ( count( $forms ) === 0 ) {
 306                         wfProfileOut( __METHOD__ );
 307                         return '';
 308                 } elseif ( count( $forms ) === 1 ) {
 309                         wfProfileOut( __METHOD__ );
 310                         return $forms[0];
 311                 }
 312
 313                 $username = trim( $username );
 314
 315                 // default
 316                 $gender = User::getDefaultOption( 'gender' );
 317
 318                 // allow prefix.
 319                 $title = Title::newFromText( $username );
 320
 321                 if ( $title && $title->getNamespace() == NS_USER ) {
 322                         $username = $title->getText();
 323                 }
 324
 325                 // check parameter, or use the ParserOptions if in interface message
 326                 $user = User::newFromName( $username );
 327                 if ( $user ) {
 328                         $gender = GenderCache::singleton()->getGenderOf( $user, __METHOD__ );
 329                 } elseif ( $username === '' && $parser->getOptions()->getInterfaceMessage() ) {
 330                         $gender = GenderCache::singleton()->getGenderOf( $parser->getOptions()->getUser(), __METHOD__ );
 331                 }
 332                 $ret = $parser->getFunctionLang()->gender( $gender, $forms );
 333                 wfProfileOut( __METHOD__ );
 334                 return $ret;
 335         }
 336
 337         /**
 338          * @param $parser Parser
 339          * @param string $text
 340          * @return
 341          */
 342         static function plural( $parser, $text = '' ) {
 343                 $forms = array_slice( func_get_args(), 2 );
 344                 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
 345                 return $parser->getFunctionLang()->convertPlural( $text, $forms );
 346         }
 347
 348         /**
 349          * Override the title of the page when viewed, provided we've been given a
 350          * title which will normalise to the canonical title
 351          *
 352          * @param $parser Parser: parent parser
 353          * @param $text String: desired title text
 354          * @return String
 355          */
 356         static function displaytitle( $parser, $text = '' ) {
 357                 global $wgRestrictDisplayTitle;
 358
 359                 #parse a limited subset of wiki markup (just the single quote items)
 360                 $text = $parser->doQuotes( $text );
 361
 362                 #remove stripped text (e.g. the UNIQ-QINU stuff) that was generated by tag extensions/whatever
 363                 $text = preg_replace( '/' . preg_quote( $parser->uniqPrefix(), '/' ) . '.*?'
 364                         . preg_quote( Parser::MARKER_SUFFIX, '/' ) . '/', '', $text );
 365
 366                 #list of disallowed tags for DISPLAYTITLE
 367                 #these will be escaped even though they are allowed in normal wiki text
 368                 $bad = array( 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'div', 'blockquote', 'ol', 'ul', 'li', 'hr',
 369                         'table', 'tr', 'th', 'td', 'dl', 'dd', 'caption', 'p', 'ruby', 'rb', 'rt', 'rp', 'br' );
 370
 371                 #only requested titles that normalize to the actual title are allowed through
 372                 #if $wgRestrictDisplayTitle is true (it is by default)
 373                 #mimic the escaping process that occurs in OutputPage::setPageTitle
 374                 $text = Sanitizer::normalizeCharReferences( Sanitizer::removeHTMLtags( $text, null, array(), array(), $bad ) );
 375                 $title = Title::newFromText( Sanitizer::stripAllTags( $text ) );
 376
 377                 if( !$wgRestrictDisplayTitle ) {
 378                         $parser->mOutput->setDisplayTitle( $text );
 379                 } else {
 380                         if ( $title instanceof Title && $title->getFragment() == '' && $title->equals( $parser->mTitle ) ) {
 381                                 $parser->mOutput->setDisplayTitle( $text );
 382                         }
 383                 }
 384
 385                 return '';
 386         }
 387
 388         static function isRaw( $param ) {
 389                 static $mwRaw;
 390                 if ( !$mwRaw ) {
 391                         $mwRaw =& MagicWord::get( 'rawsuffix' );
 392                 }
 393                 if ( is_null( $param ) ) {
 394                         return false;
 395                 } else {
 396                         return $mwRaw->match( $param );
 397                 }
 398         }
 399
 400         static function formatRaw( $num, $raw ) {
 401                 if( self::isRaw( $raw ) ) {
 402                         return $num;
 403                 } else {
 404                         global $wgContLang;
 405                         return $wgContLang->formatNum( $num );
 406                 }
 407         }
 408         static function numberofpages( $parser, $raw = null ) {
 409                 return self::formatRaw( SiteStats::pages(), $raw );
 410         }
 411         static function numberofusers( $parser, $raw = null ) {
 412                 return self::formatRaw( SiteStats::users(), $raw );
 413         }
 414         static function numberofactiveusers( $parser, $raw = null ) {
 415                 return self::formatRaw( SiteStats::activeUsers(), $raw );
 416         }
 417         static function numberofarticles( $parser, $raw = null ) {
 418                 return self::formatRaw( SiteStats::articles(), $raw );
 419         }
 420         static function numberoffiles( $parser, $raw = null ) {
 421                 return self::formatRaw( SiteStats::images(), $raw );
 422         }
 423         static function numberofadmins( $parser, $raw = null ) {
 424                 return self::formatRaw( SiteStats::numberingroup('sysop'), $raw );
 425         }
 426         static function numberofedits( $parser, $raw = null ) {
 427                 return self::formatRaw( SiteStats::edits(), $raw );
 428         }
 429         static function numberofviews( $parser, $raw = null ) {
 430                 return self::formatRaw( SiteStats::views(), $raw );
 431         }
 432         static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
 433                 return self::formatRaw( SiteStats::pagesInNs( intval( $namespace ) ), $raw );
 434         }
 435         static function numberingroup( $parser, $name = '', $raw = null) {
 436                 return self::formatRaw( SiteStats::numberingroup( strtolower( $name ) ), $raw );
 437         }
 438
 439
 440         /**
 441          * Given a title, return the namespace name that would be given by the
 442          * corresponding magic word
 443          * Note: function name changed to "mwnamespace" rather than "namespace"
 444          * to not break PHP 5.3
 445          * @return mixed|string
 446          */
 447         static function mwnamespace( $parser, $title = null ) {
 448                 $t = Title::newFromText( $title );
 449                 if ( is_null( $t ) )
 450                         return '';
 451                 return str_replace( '_', ' ', $t->getNsText() );
 452         }
 453         static function namespacee( $parser, $title = null ) {
 454                 $t = Title::newFromText( $title );
 455                 if ( is_null( $t ) )
 456                         return '';
 457                 return wfUrlencode( $t->getNsText() );
 458         }
 459         static function namespacenumber( $parser, $title = null ) {
 460                 $t = Title::newFromText( $title );
 461                 if ( is_null( $t ) )
 462                         return '';
 463                 return $t->getNamespace();
 464         }
 465         static function talkspace( $parser, $title = null ) {
 466                 $t = Title::newFromText( $title );
 467                 if ( is_null( $t ) || !$t->canTalk() )
 468                         return '';
 469                 return str_replace( '_', ' ', $t->getTalkNsText() );
 470         }
 471         static function talkspacee( $parser, $title = null ) {
 472                 $t = Title::newFromText( $title );
 473                 if ( is_null( $t ) || !$t->canTalk() )
 474                         return '';
 475                 return wfUrlencode( $t->getTalkNsText() );
 476         }
 477         static function subjectspace( $parser, $title = null ) {
 478                 $t = Title::newFromText( $title );
 479                 if ( is_null( $t ) )
 480                         return '';
 481                 return str_replace( '_', ' ', $t->getSubjectNsText() );
 482         }
 483         static function subjectspacee( $parser, $title = null ) {
 484                 $t = Title::newFromText( $title );
 485                 if ( is_null( $t ) )
 486                         return '';
 487                 return wfUrlencode( $t->getSubjectNsText() );
 488         }
 489
 490         /**
 491          * Functions to get and normalize pagenames, corresponding to the magic words
 492          * of the same names
 493          * @return String
 494          */
 495         static function pagename( $parser, $title = null ) {
 496                 $t = Title::newFromText( $title );
 497                 if ( is_null( $t ) )
 498                         return '';
 499                 return wfEscapeWikiText( $t->getText() );
 500         }
 501         static function pagenamee( $parser, $title = null ) {
 502                 $t = Title::newFromText( $title );
 503                 if ( is_null( $t ) )
 504                         return '';
 505                 return wfEscapeWikiText( $t->getPartialURL() );
 506         }
 507         static function fullpagename( $parser, $title = null ) {
 508                 $t = Title::newFromText( $title );
 509                 if ( is_null( $t ) || !$t->canTalk() )
 510                         return '';
 511                 return wfEscapeWikiText( $t->getPrefixedText() );
 512         }
 513         static function fullpagenamee( $parser, $title = null ) {
 514                 $t = Title::newFromText( $title );
 515                 if ( is_null( $t ) || !$t->canTalk() )
 516                         return '';
 517                 return wfEscapeWikiText( $t->getPrefixedURL() );
 518         }
 519         static function subpagename( $parser, $title = null ) {
 520                 $t = Title::newFromText( $title );
 521                 if ( is_null( $t ) )
 522                         return '';
 523                 return wfEscapeWikiText( $t->getSubpageText() );
 524         }
 525         static function subpagenamee( $parser, $title = null ) {
 526                 $t = Title::newFromText( $title );
 527                 if ( is_null( $t ) )
 528                         return '';
 529                 return wfEscapeWikiText( $t->getSubpageUrlForm() );
 530         }
 531         static function basepagename( $parser, $title = null ) {
 532                 $t = Title::newFromText( $title );
 533                 if ( is_null( $t ) )
 534                         return '';
 535                 return wfEscapeWikiText( $t->getBaseText() );
 536         }
 537         static function basepagenamee( $parser, $title = null ) {
 538                 $t = Title::newFromText( $title );
 539                 if ( is_null( $t ) )
 540                         return '';
 541                 return wfEscapeWikiText( wfUrlEncode( str_replace( ' ', '_', $t->getBaseText() ) ) );
 542         }
 543         static function talkpagename( $parser, $title = null ) {
 544                 $t = Title::newFromText( $title );
 545                 if ( is_null( $t ) || !$t->canTalk() )
 546                         return '';
 547                 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedText() );
 548         }
 549         static function talkpagenamee( $parser, $title = null ) {
 550                 $t = Title::newFromText( $title );
 551                 if ( is_null( $t ) || !$t->canTalk() )
 552                         return '';
 553                 return wfEscapeWikiText( $t->getTalkPage()->getPrefixedUrl() );
 554         }
 555         static function subjectpagename( $parser, $title = null ) {
 556                 $t = Title::newFromText( $title );
 557                 if ( is_null( $t ) )
 558                         return '';
 559                 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedText() );
 560         }
 561         static function subjectpagenamee( $parser, $title = null ) {
 562                 $t = Title::newFromText( $title );
 563                 if ( is_null( $t ) )
 564                         return '';
 565                 return wfEscapeWikiText( $t->getSubjectPage()->getPrefixedUrl() );
 566         }
 567
 568         /**
 569          * Return the number of pages, files or subcats in the given category,
 570          * or 0 if it's nonexistent. This is an expensive parser function and
 571          * can't be called too many times per page.
 572          * @return string
 573          */
 574         static function pagesincategory( $parser, $name = '', $arg1 = null, $arg2 = null ) {
 575                 static $magicWords = null;
 576                 if ( is_null( $magicWords ) ) {
 577                         $magicWords = new MagicWordArray( array(
 578                                 'pagesincategory_all',
 579                                 'pagesincategory_pages',
 580                                 'pagesincategory_subcats',
 581                                 'pagesincategory_files'
 582                         ) );
 583                 }
 584                 static $cache = array();
 585
 586                 // split the given option to its variable
 587                 if( self::isRaw( $arg1 ) ) {
 588                         //{{pagesincategory:|raw[|type]}}
 589                         $raw = $arg1;
 590                         $type = $magicWords->matchStartToEnd( $arg2 );
 591                 } else {
 592                         //{{pagesincategory:[|type[|raw]]}}
 593                         $type = $magicWords->matchStartToEnd( $arg1 );
 594                         $raw = $arg2;
 595                 }
 596                 if( !$type ) { //backward compatibility
 597                         $type = 'pagesincategory_all';
 598                 }
 599
 600                 $title = Title::makeTitleSafe( NS_CATEGORY, $name );
 601                 if( !$title ) { # invalid title
 602                         return self::formatRaw( 0, $raw );
 603                 }
 604
 605                 // Normalize name for cache
 606                 $name = $title->getDBkey();
 607
 608                 if( !isset( $cache[$name] ) ) {
 609                         $category = Category::newFromTitle( $title );
 610
 611                         $allCount = $subcatCount = $fileCount = $pagesCount = 0;
 612                         if( $parser->incrementExpensiveFunctionCount() ) {
 613                                 // $allCount is the total number of cat members,
 614                                 // not the count of how many members are normal pages.
 615                                 $allCount = (int)$category->getPageCount();
 616                                 $subcatCount = (int)$category->getSubcatCount();
 617                                 $fileCount = (int)$category->getFileCount();
 618                                 $pagesCount = $allCount - $subcatCount - $fileCount;
 619                         }
 620                         $cache[$name]['pagesincategory_all'] = $allCount;
 621                         $cache[$name]['pagesincategory_pages'] = $pagesCount;
 622                         $cache[$name]['pagesincategory_subcats'] = $subcatCount;
 623                         $cache[$name]['pagesincategory_files'] = $fileCount;
 624                 }
 625
 626                 $count = $cache[$name][$type];
 627                 return self::formatRaw( $count, $raw );
 628         }
 629
 630         /**
 631          * Return the size of the given page, or 0 if it's nonexistent.  This is an
 632          * expensive parser function and can't be called too many times per page.
 633          *
 634          * @todo FIXME: This doesn't work correctly on preview for getting the size
 635          *   of the current page.
 636          * @todo FIXME: Title::getLength() documentation claims that it adds things
 637          *   to the link cache, so the local cache here should be unnecessary, but
 638          *   in fact calling getLength() repeatedly for the same $page does seem to
 639          *   run one query for each call?
 640          * @todo Document parameters
 641          *
 642          * @param $parser Parser
 643          * @param $page String TODO DOCUMENT (Default: empty string)
 644          * @param $raw TODO DOCUMENT (Default: null)
 645          * @return string
 646          */
 647         static function pagesize( $parser, $page = '', $raw = null ) {
 648                 static $cache = array();
 649                 $title = Title::newFromText( $page );
 650
 651                 if( !is_object( $title ) ) {
 652                         $cache[$page] = 0;
 653                         return self::formatRaw( 0, $raw );
 654                 }
 655
 656                 # Normalize name for cache
 657                 $page = $title->getPrefixedText();
 658
 659                 $length = 0;
 660                 if( isset( $cache[$page] ) ) {
 661                         $length = $cache[$page];
 662                 } elseif( $parser->incrementExpensiveFunctionCount() ) {
 663                         $rev = Revision::newFromTitle( $title );
 664                         $id = $rev ? $rev->getPage() : 0;
 665                         $length = $cache[$page] = $rev ? $rev->getSize() : 0;
 666
 667                         // Register dependency in templatelinks
 668                         $parser->mOutput->addTemplate( $title, $id, $rev ? $rev->getId() : 0 );
 669                 }
 670                 return self::formatRaw( $length, $raw );
 671         }
 672
 673         /**
 674         * Returns the requested protection level for the current page
 675          * @return string
 676          */
 677         static function protectionlevel( $parser, $type = '' ) {
 678                 $restrictions = $parser->mTitle->getRestrictions( strtolower( $type ) );
 679                 # Title::getRestrictions returns an array, its possible it may have
 680                 # multiple values in the future
 681                 return implode( $restrictions, ',' );
 682         }
 683
 684         /**
 685          * Gives language names.
 686          * @param $parser Parser
 687          * @param $code String  Language code (of which to get name)
 688          * @param $inLanguage String  Language code (in which to get name)
 689          * @return String
 690          */
 691         static function language( $parser, $code = '', $inLanguage = '' ) {
 692                 $code = strtolower( $code );
 693                 $inLanguage = strtolower( $inLanguage );
 694                 $lang = Language::fetchLanguageName( $code, $inLanguage );
 695                 return $lang !== '' ? $lang : wfBCP47( $code );
 696         }
 697
 698         /**
 699          * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
 700          * @return string
 701          */
 702         static function pad( $parser, $string, $length, $padding = '0', $direction = STR_PAD_RIGHT ) {
 703                 $padding = $parser->killMarkers( $padding );
 704                 $lengthOfPadding = mb_strlen( $padding );
 705                 if ( $lengthOfPadding == 0 ) return $string;
 706
 707                 # The remaining length to add counts down to 0 as padding is added
 708                 $length = min( $length, 500 ) - mb_strlen( $string );
 709                 # $finalPadding is just $padding repeated enough times so that
 710                 # mb_strlen( $string ) + mb_strlen( $finalPadding ) == $length
 711                 $finalPadding = '';
 712                 while ( $length > 0 ) {
 713                         # If $length < $lengthofPadding, truncate $padding so we get the
 714                         # exact length desired.
 715                         $finalPadding .= mb_substr( $padding, 0, $length );
 716                         $length -= $lengthOfPadding;
 717                 }
 718
 719                 if ( $direction == STR_PAD_LEFT ) {
 720                         return $finalPadding . $string;
 721                 } else {
 722                         return $string . $finalPadding;
 723                 }
 724         }
 725
 726         static function padleft( $parser, $string = '', $length = 0, $padding = '0' ) {
 727                 return self::pad( $parser, $string, $length, $padding, STR_PAD_LEFT );
 728         }
 729
 730         static function padright( $parser, $string = '', $length = 0, $padding = '0' ) {
 731                 return self::pad( $parser, $string, $length, $padding );
 732         }
 733
 734         /**
 735          * @param $parser Parser
 736          * @param  $text
 737          * @return string
 738          */
 739         static function anchorencode( $parser, $text ) {
 740                 $text = $parser->killMarkers( $text );
 741                 return substr( $parser->guessSectionNameFromWikiText( $text ), 1);
 742         }
 743
 744         static function special( $parser, $text ) {
 745                 list( $page, $subpage ) = SpecialPageFactory::resolveAlias( $text );
 746                 if ( $page ) {
 747                         $title = SpecialPage::getTitleFor( $page, $subpage );
 748                         return $title->getPrefixedText();
 749                 } else {
 750                         return wfMessage( 'nosuchspecialpage' )->inContentLanguage()->text();
 751                 }
 752         }
 753
 754         static function speciale( $parser, $text ) {
 755                 return wfUrlencode( str_replace( ' ', '_', self::special( $parser, $text ) ) );
 756         }
 757
 758         /**
 759          * @param $parser Parser
 760          * @param $text String The sortkey to use
 761          * @param $uarg String Either "noreplace" or "noerror" (in en)
 762          *   both suppress errors, and noreplace does nothing if
 763          *   a default sortkey already exists.
 764          * @return string
 765          */
 766         public static function defaultsort( $parser, $text, $uarg = '' ) {
 767                 static $magicWords = null;
 768                 if ( is_null( $magicWords ) ) {
 769                         $magicWords = new MagicWordArray( array( 'defaultsort_noerror', 'defaultsort_noreplace' ) );
 770                 }
 771                 $arg = $magicWords->matchStartToEnd( $uarg );
 772
 773                 $text = trim( $text );
 774                 if( strlen( $text ) == 0 )
 775                         return '';
 776                 $old = $parser->getCustomDefaultSort();
 777                 if ( $old === false || $arg !== 'defaultsort_noreplace' ) {
 778                         $parser->setDefaultSort( $text );
 779                 }
 780
 781                 if( $old === false || $old == $text || $arg ) {
 782                         return '';
 783                 } else {
 784                         return( '<span class="error">' .
 785                                 wfMessage( 'duplicate-defaultsort', $old, $text )->inContentLanguage()->escaped() .
 786                                 '</span>' );
 787                 }
 788         }
 789
 790         // Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}} or {{filepath|300|nowiki}}
 791         // or {{filepath|300px}}, {{filepath|200x300px}}, {{filepath|nowiki|200x300px}}, {{filepath|200x300px|nowiki}}
 792         public static function filepath( $parser, $name='', $argA='', $argB='' ) {
 793                 $file = wfFindFile( $name );
 794
 795                 if( $argA == 'nowiki' ) {
 796                         // {{filepath: | option [| size] }}
 797                         $isNowiki = true;
 798                         $parsedWidthParam = $parser->parseWidthParam( $argB );
 799                 } else {
 800                         // {{filepath: [| size [|option]] }}
 801                         $parsedWidthParam = $parser->parseWidthParam( $argA );
 802                         $isNowiki = ($argB == 'nowiki');
 803                 }
 804
 805                 if ( $file ) {
 806                         $url = $file->getFullUrl();
 807
 808                         // If a size is requested...
 809                         if ( count( $parsedWidthParam ) ) {
 810                                 $mto = $file->transform( $parsedWidthParam );
 811                                 // ... and we can
 812                                 if ( $mto && !$mto->isError() ) {
 813                                         // ... change the URL to point to a thumbnail.
 814                                         $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE );
 815                                 }
 816                         }
 817                         if ( $isNowiki ) {
 818                                 return array( $url, 'nowiki' => true );
 819                         }
 820                         return $url;
 821                 } else {
 822                         return '';
 823                 }
 824         }
 825
 826         /**
 827          * Parser function to extension tag adaptor
 828          * @return string
 829          */
 830         public static function tagObj( $parser, $frame, $args ) {
 831                 if ( !count( $args ) ) {
 832                         return '';
 833                 }
 834                 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
 835
 836                 if ( count( $args ) ) {
 837                         $inner = $frame->expand( array_shift( $args ) );
 838                 } else {
 839                         $inner = null;
 840                 }
 841
 842                 $stripList = $parser->getStripList();
 843                 if ( !in_array( $tagName, $stripList ) ) {
 844                         return '<span class="error">' .
 845                                 wfMessage( 'unknown_extension_tag', $tagName )->inContentLanguage()->text() .
 846                                 '</span>';
 847                 }
 848
 849                 $attributes = array();
 850                 foreach ( $args as $arg ) {
 851                         $bits = $arg->splitArg();
 852                         if ( strval( $bits['index'] ) === '' ) {
 853                                 $name = trim( $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS ) );
 854                                 $value = trim( $frame->expand( $bits['value'] ) );
 855                                 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
 856                                         $value = isset( $m[1] ) ? $m[1] : '';
 857                                 }
 858                                 $attributes[$name] = $value;
 859                         }
 860                 }
 861
 862                 $params = array(
 863                         'name' => $tagName,
 864                         'inner' => $inner,
 865                         'attributes' => $attributes,
 866                         'close' => "</$tagName>",
 867                 );
 868                 return $parser->extensionSubstitution( $params, $frame );
 869         }
 870 }