269a91037b
* Added page_props backend, generic parser-driven page properties which, when changed, invalidate the cache of backlinked pages on any links table. Could be used to add overlays to images depending on their deletion status, or to add icons to articles based on category membership. * Refactored double-underscore handling in the parser. * Moved CoreParserFunctions registration to CoreParserFunctions.
314 lines
11 KiB
PHP
314 lines
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Various core parser functions, registered in Parser::firstCallInit()
|
|
* @addtogroup Parser
|
|
*/
|
|
class CoreParserFunctions {
|
|
static function register( $parser ) {
|
|
global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
|
|
|
|
# Syntax for arguments (see self::setFunctionHook):
|
|
# "name for lookup in localized magic words array",
|
|
# function callback,
|
|
# optional SFH_NO_HASH to omit the hash from calls (e.g. {{int:...}
|
|
# instead of {{#int:...}})
|
|
|
|
$parser->setFunctionHook( 'int', array( __CLASS__, 'intFunction' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'ns', array( __CLASS__, 'ns' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'urlencode', array( __CLASS__, 'urlencode' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'lcfirst', array( __CLASS__, 'lcfirst' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'ucfirst', array( __CLASS__, 'ucfirst' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'lc', array( __CLASS__, 'lc' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'uc', array( __CLASS__, 'uc' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'localurl', array( __CLASS__, 'localurl' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'localurle', array( __CLASS__, 'localurle' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'fullurl', array( __CLASS__, 'fullurl' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'fullurle', array( __CLASS__, 'fullurle' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'formatnum', array( __CLASS__, 'formatnum' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'grammar', array( __CLASS__, 'grammar' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'plural', array( __CLASS__, 'plural' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberofpages', array( __CLASS__, 'numberofpages' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberofusers', array( __CLASS__, 'numberofusers' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberofarticles', array( __CLASS__, 'numberofarticles' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberoffiles', array( __CLASS__, 'numberoffiles' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberofadmins', array( __CLASS__, 'numberofadmins' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'numberofedits', array( __CLASS__, 'numberofedits' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'language', array( __CLASS__, 'language' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'padleft', array( __CLASS__, 'padleft' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'padright', array( __CLASS__, 'padright' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'anchorencode', array( __CLASS__, 'anchorencode' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'special', array( __CLASS__, 'special' ) );
|
|
$parser->setFunctionHook( 'defaultsort', array( __CLASS__, 'defaultsort' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'filepath', array( __CLASS__, 'filepath' ), SFH_NO_HASH );
|
|
$parser->setFunctionHook( 'tag', array( __CLASS__, 'tagObj' ), SFH_OBJECT_ARGS );
|
|
|
|
if ( $wgAllowDisplayTitle ) {
|
|
$parser->setFunctionHook( 'displaytitle', array( __CLASS__, 'displaytitle' ), SFH_NO_HASH );
|
|
}
|
|
if ( $wgAllowSlowParserFunctions ) {
|
|
$parser->setFunctionHook( 'pagesinnamespace', array( __CLASS__, 'pagesinnamespace' ), SFH_NO_HASH );
|
|
}
|
|
}
|
|
|
|
static function intFunction( $parser, $part1 = '' /*, ... */ ) {
|
|
if ( strval( $part1 ) !== '' ) {
|
|
$args = array_slice( func_get_args(), 2 );
|
|
return wfMsgReal( $part1, $args, true );
|
|
} else {
|
|
return array( 'found' => false );
|
|
}
|
|
}
|
|
|
|
static function ns( $parser, $part1 = '' ) {
|
|
global $wgContLang;
|
|
$found = false;
|
|
if ( intval( $part1 ) || $part1 == "0" ) {
|
|
$text = $wgContLang->getNsText( intval( $part1 ) );
|
|
$found = true;
|
|
} else {
|
|
$param = str_replace( ' ', '_', strtolower( $part1 ) );
|
|
$index = Namespace::getCanonicalIndex( strtolower( $param ) );
|
|
if ( !is_null( $index ) ) {
|
|
$text = $wgContLang->getNsText( $index );
|
|
$found = true;
|
|
}
|
|
}
|
|
if ( $found ) {
|
|
return $text;
|
|
} else {
|
|
return array( 'found' => false );
|
|
}
|
|
}
|
|
|
|
static function urlencode( $parser, $s = '' ) {
|
|
return urlencode( $s );
|
|
}
|
|
|
|
static function lcfirst( $parser, $s = '' ) {
|
|
global $wgContLang;
|
|
return $wgContLang->lcfirst( $s );
|
|
}
|
|
|
|
static function ucfirst( $parser, $s = '' ) {
|
|
global $wgContLang;
|
|
return $wgContLang->ucfirst( $s );
|
|
}
|
|
|
|
static function lc( $parser, $s = '' ) {
|
|
global $wgContLang;
|
|
if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
|
|
return $parser->markerSkipCallback( $s, array( $wgContLang, 'lc' ) );
|
|
} else {
|
|
return $wgContLang->lc( $s );
|
|
}
|
|
}
|
|
|
|
static function uc( $parser, $s = '' ) {
|
|
global $wgContLang;
|
|
if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
|
|
return $parser->markerSkipCallback( $s, array( $wgContLang, 'uc' ) );
|
|
} else {
|
|
return $wgContLang->uc( $s );
|
|
}
|
|
}
|
|
|
|
static function localurl( $parser, $s = '', $arg = null ) { return self::urlFunction( 'getLocalURL', $s, $arg ); }
|
|
static function localurle( $parser, $s = '', $arg = null ) { return self::urlFunction( 'escapeLocalURL', $s, $arg ); }
|
|
static function fullurl( $parser, $s = '', $arg = null ) { return self::urlFunction( 'getFullURL', $s, $arg ); }
|
|
static function fullurle( $parser, $s = '', $arg = null ) { return self::urlFunction( 'escapeFullURL', $s, $arg ); }
|
|
|
|
static function urlFunction( $func, $s = '', $arg = null ) {
|
|
$title = Title::newFromText( $s );
|
|
# Due to order of execution of a lot of bits, the values might be encoded
|
|
# before arriving here; if that's true, then the title can't be created
|
|
# and the variable will fail. If we can't get a decent title from the first
|
|
# attempt, url-decode and try for a second.
|
|
if( is_null( $title ) )
|
|
$title = Title::newFromUrl( urldecode( $s ) );
|
|
if ( !is_null( $title ) ) {
|
|
if ( !is_null( $arg ) ) {
|
|
$text = $title->$func( $arg );
|
|
} else {
|
|
$text = $title->$func();
|
|
}
|
|
return $text;
|
|
} else {
|
|
return array( 'found' => false );
|
|
}
|
|
}
|
|
|
|
static function formatNum( $parser, $num = '' ) {
|
|
return $parser->getFunctionLang()->formatNum( $num );
|
|
}
|
|
|
|
static function grammar( $parser, $case = '', $word = '' ) {
|
|
return $parser->getFunctionLang()->convertGrammar( $word, $case );
|
|
}
|
|
|
|
static function plural( $parser, $text = '') {
|
|
$forms = array_slice( func_get_args(), 2);
|
|
$text = $parser->getFunctionLang()->parseFormattedNumber( $text );
|
|
return $parser->getFunctionLang()->convertPlural( $text, $forms );
|
|
}
|
|
|
|
/**
|
|
* Override the title of the page when viewed,
|
|
* provided we've been given a title which
|
|
* will normalise to the canonical title
|
|
*
|
|
* @param Parser $parser Parent parser
|
|
* @param string $text Desired title text
|
|
* @return string
|
|
*/
|
|
static function displaytitle( $parser, $text = '' ) {
|
|
$text = trim( Sanitizer::decodeCharReferences( $text ) );
|
|
$title = Title::newFromText( $text );
|
|
if( $title instanceof Title && $title->getFragment() == '' && $title->equals( $parser->mTitle ) )
|
|
$parser->mOutput->setDisplayTitle( $text );
|
|
return '';
|
|
}
|
|
|
|
static function isRaw( $param ) {
|
|
static $mwRaw;
|
|
if ( !$mwRaw ) {
|
|
$mwRaw =& MagicWord::get( 'rawsuffix' );
|
|
}
|
|
if ( is_null( $param ) ) {
|
|
return false;
|
|
} else {
|
|
return $mwRaw->match( $param );
|
|
}
|
|
}
|
|
|
|
static function statisticsFunction( $func, $raw = null ) {
|
|
if ( self::isRaw( $raw ) ) {
|
|
return call_user_func( array( 'SiteStats', $func ) );
|
|
} else {
|
|
global $wgContLang;
|
|
return $wgContLang->formatNum( call_user_func( array( 'SiteStats', $func ) ) );
|
|
}
|
|
}
|
|
|
|
static function numberofpages( $parser, $raw = null ) { return self::statisticsFunction( 'pages', $raw ); }
|
|
static function numberofusers( $parser, $raw = null ) { return self::statisticsFunction( 'users', $raw ); }
|
|
static function numberofarticles( $parser, $raw = null ) { return self::statisticsFunction( 'articles', $raw ); }
|
|
static function numberoffiles( $parser, $raw = null ) { return self::statisticsFunction( 'images', $raw ); }
|
|
static function numberofadmins( $parser, $raw = null ) { return self::statisticsFunction( 'admins', $raw ); }
|
|
static function numberofedits( $parser, $raw = null ) { return self::statisticsFunction( 'edits', $raw ); }
|
|
|
|
static function pagesinnamespace( $parser, $namespace = 0, $raw = null ) {
|
|
$count = SiteStats::pagesInNs( intval( $namespace ) );
|
|
if ( self::isRaw( $raw ) ) {
|
|
global $wgContLang;
|
|
return $wgContLang->formatNum( $count );
|
|
} else {
|
|
return $count;
|
|
}
|
|
}
|
|
|
|
static function language( $parser, $arg = '' ) {
|
|
global $wgContLang;
|
|
$lang = $wgContLang->getLanguageName( strtolower( $arg ) );
|
|
return $lang != '' ? $lang : $arg;
|
|
}
|
|
|
|
static function pad( $string = '', $length = 0, $char = 0, $direction = STR_PAD_RIGHT ) {
|
|
$length = min( max( $length, 0 ), 500 );
|
|
$char = substr( $char, 0, 1 );
|
|
return ( $string !== '' && (int)$length > 0 && strlen( trim( (string)$char ) ) > 0 )
|
|
? str_pad( $string, $length, (string)$char, $direction )
|
|
: $string;
|
|
}
|
|
|
|
static function padleft( $parser, $string = '', $length = 0, $char = 0 ) {
|
|
return self::pad( $string, $length, $char, STR_PAD_LEFT );
|
|
}
|
|
|
|
static function padright( $parser, $string = '', $length = 0, $char = 0 ) {
|
|
return self::pad( $string, $length, $char );
|
|
}
|
|
|
|
static function anchorencode( $parser, $text ) {
|
|
$a = urlencode( $text );
|
|
$a = strtr( $a, array( '%' => '.', '+' => '_' ) );
|
|
# leave colons alone, however
|
|
$a = str_replace( '.3A', ':', $a );
|
|
return $a;
|
|
}
|
|
|
|
static function special( $parser, $text ) {
|
|
$title = SpecialPage::getTitleForAlias( $text );
|
|
if ( $title ) {
|
|
return $title->getPrefixedText();
|
|
} else {
|
|
return wfMsgForContent( 'nosuchspecialpage' );
|
|
}
|
|
}
|
|
|
|
public static function defaultsort( $parser, $text ) {
|
|
$text = trim( $text );
|
|
if( strlen( $text ) > 0 )
|
|
$parser->setDefaultSort( $text );
|
|
return '';
|
|
}
|
|
|
|
public static function filepath( $parser, $name='', $option='' ) {
|
|
$file = wfFindFile( $name );
|
|
if( $file ) {
|
|
$url = $file->getFullUrl();
|
|
if( $option == 'nowiki' ) {
|
|
return "<nowiki>$url</nowiki>";
|
|
}
|
|
return $url;
|
|
} else {
|
|
return '';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Parser function to extension tag adaptor
|
|
*/
|
|
public static function tagObj( $parser, $frame, $args ) {
|
|
$xpath = false;
|
|
if ( !count( $args ) ) {
|
|
return '';
|
|
}
|
|
$tagName = strtolower( trim( $frame->expand( array_shift( $args ) ) ) );
|
|
|
|
if ( count( $args ) ) {
|
|
$inner = $frame->expand( array_shift( $args ) );
|
|
} else {
|
|
$inner = null;
|
|
}
|
|
|
|
$stripList = $parser->getStripList();
|
|
if ( !in_array( $tagName, $stripList ) ) {
|
|
return '<span class="error">' .
|
|
wfMsg( 'unknown_extension_tag', $tagName ) .
|
|
'</span>';
|
|
}
|
|
|
|
$attributes = array();
|
|
foreach ( $args as $arg ) {
|
|
$bits = $arg->splitArg();
|
|
if ( strval( $bits['index'] ) === '' ) {
|
|
$name = $frame->expand( $bits['name'], PPFrame::STRIP_COMMENTS );
|
|
$value = trim( $frame->expand( $bits['value'] ) );
|
|
if ( preg_match( '/^(?:["\'](.+)["\']|""|\'\')$/s', $value, $m ) ) {
|
|
$value = isset( $m[1] ) ? $m[1] : '';
|
|
}
|
|
$attributes[$name] = $value;
|
|
}
|
|
}
|
|
|
|
$params = array(
|
|
'name' => $tagName,
|
|
'inner' => $inner,
|
|
'attributes' => $attributes,
|
|
'close' => "</$tagName>",
|
|
);
|
|
return $parser->extensionSubstitution( $params, $frame );
|
|
}
|
|
}
|
|
|