includes/CoreParserFunctions.php

   1 <?php
   2
   3 /**
   4  * Various core parser functions, registered in Parser::firstCallInit()
   5  * @addtogroup Parser
   6  */
   7 class CoreParserFunctions {
   8         static function register( $parser ) {
   9                 global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
  10
  11                 # Syntax for arguments (see self::setFunctionHook):
  12                 #  "name for lookup in localized magic words array",
  13                 #  function callback,
  14                 #  optional SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}
  15                 #    instead of {{#int:...}})
  16
  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( 'tag',              array( __CLASS__, 'tagObj'           ), SFH_OBJECT_ARGS );
  45
  46                 if ( $wgAllowDisplayTitle ) {
  47                         $parser->setFunctionHook( 'displaytitle', array( __CLASS__, 'displaytitle' ), SFH_NO_HASH );
  48                 }
  49                 if ( $wgAllowSlowParserFunctions ) {
  50                         $parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__, 'pagesinnamespace' ), SFH_NO_HASH );
  51                 }
  52         }
  53
  54         static function intFunction( $parser, $part1 = '' /*, ... */ ) {
  55                 if ( strval( $part1 ) !== '' ) {
  56                         $args = array_slice( func_get_args(), 2 );
  57                         return wfMsgReal( $part1, $args, true );
  58                 } else {
  59                         return array( 'found' => false );
  60                 }
  61         }
  62
  63         static function ns( $parser, $part1 = '' ) {
  64                 global $wgContLang;
  65                 $found = false;
  66                 if ( intval( $part1 ) || $part1 == "0" ) {
  67                         $text = $wgContLang->getNsText( intval( $part1 ) );
  68                         $found = true;
  69                 } else {
  70                         $param = str_replace( ' ', '_', strtolower( $part1 ) );
  71                         $index = Namespace::getCanonicalIndex( strtolower( $param ) );
  72                         if ( !is_null( $index ) ) {
  73                                 $text = $wgContLang->getNsText( $index );
  74                                 $found = true;
  75                         }
  76                 }
  77                 if ( $found ) {
  78                         return $text;
  79                 } else {
  80                         return array( 'found' => false );
  81                 }
  82         }
  83
  84         static function urlencode( $parser, $s = '' ) {
  85                 return urlencode( $s );
  86         }
  87
  88         static function lcfirst( $parser, $s = '' ) {
  89                 global $wgContLang;
  90                 return $wgContLang->lcfirst( $s );
  91         }
  92
  93         static function ucfirst( $parser, $s = '' ) {
  94                 global $wgContLang;
  95                 return $wgContLang->ucfirst( $s );
  96         }
  97
  98         static function lc( $parser, $s = '' ) {
  99                 global $wgContLang;
 100                 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
 101                         return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
 102                 } else {
 103                         return $wgContLang->lc( $s );
 104                 }
 105         }
 106
 107         static function uc( $parser, $s = '' ) {
 108                 global $wgContLang;
 109                 if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
 110                         return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
 111                 } else {
 112                         return $wgContLang->uc( $s );
 113                 }
 114         }
 115
 116         static function localurl( $parser, $s = '', $arg = null ) { return self::urlFunction( 'getLocalURL', $s, $arg ); }
 117         static function localurle( $parser, $s = '', $arg = null ) { return self::urlFunction( 'escapeLocalURL', $s, $arg ); }
 118         static function fullurl( $parser, $s = '', $arg = null ) { return self::urlFunction( 'getFullURL', $s, $arg ); }
 119         static function fullurle( $parser, $s = '', $arg = null ) { return self::urlFunction( 'escapeFullURL', $s, $arg ); }
 120
 121         static function urlFunction( $func, $s = '', $arg = null ) {
 122                 $title = Title::newFromText( $s );
 123                 # Due to order of execution of a lot of bits, the values might be encoded
 124                 # before arriving here; if that's true, then the title can't be created
 125                 # and the variable will fail. If we can't get a decent title from the first
 126                 # attempt, url-decode and try for a second.
 127                 if( is_null( $title ) )
 128                         $title = Title::newFromUrl( urldecode( $s ) );
 129                 if ( !is_null( $title ) ) {
 130                         if ( !is_null( $arg ) ) {
 131                                 $text = $title->$func( $arg );
 132                         } else {
 133                                 $text = $title->$func();
 134                         }
 135                         return $text;
 136                 } else {
 137                         return array( 'found' => false );
 138                 }
 139         }
 140
 141         static function formatNum( $parser, $num = '', $raw = null) {
 142                 if ( self::israw( $raw ) ) {
 143                         return $parser->getFunctionLang()->parseFormattedNumber( $num );
 144                 } else {
 145                         return $parser->getFunctionLang()->formatNum( $num );
 146                 }
 147         }
 148
 149         static function grammar( $parser, $case = '', $word = '' ) {
 150                 return $parser->getFunctionLang()->convertGrammar( $word, $case );
 151         }
 152
 153         static function plural( $parser, $text = '') {
 154                 $forms = array_slice( func_get_args(), 2);
 155                 $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
 156                 return $parser->getFunctionLang()->convertPlural( $text, $forms );
 157         }
 158
 159         /**
 160          * Override the title of the page when viewed,
 161          * provided we've been given a title which
 162          * will normalise to the canonical title
 163          *
 164          * @param Parser $parser Parent parser
 165          * @param string $text Desired title text
 166          * @return string
 167          */
 168         static function displaytitle( $parser, $text = '' ) {
 169                 $text = trim( Sanitizer::decodeCharReferences( $text ) );
 170                 $title = Title::newFromText( $text );
 171                 if( $title instanceof Title && $title->getFragment() == '' && $title->equals( $parser->mTitle ) )
 172                         $parser->mOutput->setDisplayTitle( $text );
 173                 return '';
 174         }
 175
 176         static function isRaw( $param ) {
 177                 static $mwRaw;
 178                 if ( !$mwRaw ) {
 179                         $mwRaw =& MagicWord::get( 'rawsuffix' );
 180                 }
 181                 if ( is_null( $param ) ) {
 182                         return false;
 183                 } else {
 184                         return $mwRaw->match( $param );
 185                 }
 186         }
 187
 188         static function statisticsFunction( $func, $raw = null ) {
 189                 if ( self::isRaw( $raw ) ) {
 190                         return call_user_func( array( 'SiteStats', $func ) );
 191                 } else {
 192                         global $wgContLang;
 193                         return $wgContLang->formatNum( call_user_func( array( 'SiteStats', $func ) ) );
 194                 }
 195         }
 196
 197         static function numberofpages( $parser, $raw = null ) { return self::statisticsFunction( 'pages', $raw ); }
 198         static function numberofusers( $parser, $raw = null ) { return self::statisticsFunction( 'users', $raw ); }
 199         static function numberofarticles( $parser, $raw = null ) { return self::statisticsFunction( 'articles', $raw ); }
 200         static function numberoffiles( $parser, $raw = null ) { return self::statisticsFunction( 'images', $raw ); }
 201         static function numberofadmins( $parser, $raw = null ) { return self::statisticsFunction( 'admins', $raw ); }
 202         static function numberofedits( $parser, $raw = null ) { return self::statisticsFunction( 'edits', $raw ); }
 203
 204         static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
 205                 $count = SiteStats::pagesInNs( intval( $namespace ) );
 206                 if ( self::isRaw( $raw ) ) {
 207                         global $wgContLang;
 208                         return $wgContLang->formatNum( $count );
 209                 } else {
 210                         return $count;
 211                 }
 212         }
 213
 214         static function language( $parser, $arg = '' ) {
 215                 global $wgContLang;
 216                 $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
 217                 return $lang != '' ? $lang : $arg;
 218         }
 219
 220         static function pad( $string = '', $length = 0, $char = 0, $direction = STR_PAD_RIGHT ) {
 221                 $length = min( max( $length, 0 ), 500 );
 222                 $char = substr( $char, 0, 1 );
 223                 return ( $string !== '' && (int)$length > 0 && strlen( trim( (string)$char ) ) > 0 )
 224                                 ? str_pad( $string, $length, (string)$char, $direction )
 225                                 : $string;
 226         }
 227
 228         static function padleft( $parser, $string = '', $length = 0, $char = 0 ) {
 229                 return self::pad( $string, $length, $char, STR_PAD_LEFT );
 230         }
 231
 232         static function padright( $parser, $string = '', $length = 0, $char = 0 ) {
 233                 return self::pad( $string, $length, $char );
 234         }
 235
 236         static function anchorencode( $parser, $text ) {
 237                 $a = urlencode( $text );
 238                 $a = strtr( $a, array( '%' => '.', '+' => '_' ) );
 239                 # leave colons alone, however
 240                 $a = str_replace( '.3A', ':', $a );
 241                 return $a;
 242         }
 243
 244         static function special( $parser, $text ) {
 245                 $title = SpecialPage::getTitleForAlias( $text );
 246                 if ( $title ) {
 247                         return $title->getPrefixedText();
 248                 } else {
 249                         return wfMsgForContent( 'nosuchspecialpage' );
 250                 }
 251         }
 252
 253         public static function defaultsort( $parser, $text ) {
 254                 $text = trim( $text );
 255                 if( strlen( $text ) > 0 )
 256                         $parser->setDefaultSort( $text );
 257                 return '';
 258         }
 259
 260         public static function filepath( $parser, $name='', $option='' ) {
 261                 $file = wfFindFile( $name );
 262                 if( $file ) {
 263                         $url = $file->getFullUrl();
 264                         if( $option == 'nowiki' ) {
 265                                 return "<nowiki>$url</nowiki>";
 266                         }
 267                         return $url;
 268                 } else {
 269                         return '';
 270                 }
 271         }
 272
 273         /**
 274          * Parser function to extension tag adaptor
 275          */
 276         public static function tagObj( $parser, $frame, $args ) {
 277                 $xpath = false;
 278                 if ( !count( $args ) ) {
 279                         return '';
 280                 }
 281                 $tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
 282
 283                 if ( count( $args ) ) {
 284                         $inner = $frame->expand( array_shift( $args ) );
 285                 } else {
 286                         $inner = null;
 287                 }
 288
 289                 $stripList = $parser->getStripList();
 290                 if ( !in_array( $tagName, $stripList ) ) {
 291                         return '<span class="error">' .
 292                                 wfMsg( 'unknown_extension_tag', $tagName ) .
 293                                 '</span>';
 294                 }
 295
 296                 $attributes = array();
 297                 foreach ( $args as $arg ) {
 298                         $bits = $arg->splitArg();
 299                         if ( strval( $bits['index'] ) === '' ) {
 300                                 $name = $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS );
 301                                 $value = trim( $frame->expand( $bits['value'] ) );
 302                                 if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
 303                                         $value = isset( $m[1] ) ? $m[1] : '';
 304                                 }
 305                                 $attributes[$name] = $value;
 306                         }
 307                 }
 308
 309                 $params = array(
 310                         'name' => $tagName,
 311                         'inner' => $inner,
 312                         'attributes' => $attributes,
 313                         'close' => "</$tagName>",
 314                 );
 315                 return $parser->extensionSubstitution( $params, $frame );
 316         }
 317 }
 318