Followup r102785: fix typo in index name. Thanks to Platonides and his special page...
[lhc/web/wiklou.git] / includes / parser / CoreParserFunctions.php
index b76c798..cd5e0a5 100644 (file)
  * @ingroup Parser
  */
 class CoreParserFunctions {
+       /**
+        * @param $parser Parser
+        * @return void
+        */
        static function register( $parser ) {
                global $wgAllowDisplayTitle, $wgAllowSlowParserFunctions;
 
@@ -31,6 +35,8 @@ class CoreParserFunctions {
                $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( 'canonicalurl',     array( __CLASS__, 'canonicalurl'     ), SFH_NO_HASH );
+               $parser->setFunctionHook( 'canonicalurle',    array( __CLASS__, 'canonicalurle'    ), SFH_NO_HASH );
                $parser->setFunctionHook( 'formatnum',        array( __CLASS__, 'formatnum'        ), SFH_NO_HASH );
                $parser->setFunctionHook( 'grammar',          array( __CLASS__, 'grammar'          ), SFH_NO_HASH );
                $parser->setFunctionHook( 'gender',           array( __CLASS__, 'gender'           ), SFH_NO_HASH );
@@ -83,18 +89,27 @@ class CoreParserFunctions {
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @param string $part1
+        * @return array
+        */
        static function intFunction( $parser, $part1 = '' /*, ... */ ) {
                if ( strval( $part1 ) !== '' ) {
                        $args = array_slice( func_get_args(), 2 );
-                       $message = wfMsgGetKey( $part1, true, $parser->getOptions()->getUserLang(), false );
-                       $message = wfMsgReplaceArgs( $message, $args );
-                       $message = $parser->replaceVariables( $message ); // like MessageCache::transform()
-                       return $message;
+                       $message = wfMessage( $part1, $args )->inLanguage( $parser->getOptions()->getUserLangObj() )->plain();
+                       return array( $message, 'noparse' => false );
                } else {
                        return array( 'found' => false );
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @param  $date
+        * @param null $defaultPref
+        * @return mixed|string
+        */
        static function formatDate( $parser, $date, $defaultPref = null ) {
                $df = DateFormatter::getInstance();
 
@@ -172,6 +187,11 @@ class CoreParserFunctions {
                return $wgContLang->ucfirst( $s );
        }
 
+       /**
+        * @param $parser Parser
+        * @param string $s
+        * @return
+        */
        static function lc( $parser, $s = '' ) {
                global $wgContLang;
                if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
@@ -181,6 +201,11 @@ class CoreParserFunctions {
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @param string $s
+        * @return
+        */
        static function uc( $parser, $s = '' ) {
                global $wgContLang;
                if ( is_callable( array( $parser, 'markerSkipCallback' ) ) ) {
@@ -194,6 +219,8 @@ class CoreParserFunctions {
        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 canonicalurl( $parser, $s = '', $arg = null ) { return self::urlFunction( 'getCanonicalURL', $s, $arg ); }
+       static function canonicalurle( $parser, $s = '', $arg = null ) { return self::urlFunction( 'escapeCanonicalURL', $s, $arg ); }
 
        static function urlFunction( $func, $s = '', $arg = null ) {
                $title = Title::newFromText( $s );
@@ -219,6 +246,12 @@ class CoreParserFunctions {
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @param string $num
+        * @param null $raw
+        * @return
+        */
        static function formatNum( $parser, $num = '', $raw = null) {
                if ( self::israw( $raw ) ) {
                        return $parser->getFunctionLang()->parseFormattedNumber( $num );
@@ -227,34 +260,54 @@ class CoreParserFunctions {
                }
        }
 
+       /**
+        * @param $parser Parser
+        * @param string $case
+        * @param string $word
+        * @return
+        */
        static function grammar( $parser, $case = '', $word = '' ) {
                return $parser->getFunctionLang()->convertGrammar( $word, $case );
        }
 
-       static function gender( $parser, $user ) {
+       /**
+        * @param $parser Parser
+        * @param $username string
+        * @return
+        */
+       static function gender( $parser, $username ) {
                wfProfileIn( __METHOD__ );
                $forms = array_slice( func_get_args(), 2);
 
+               $username = trim( $username );
+
                // default
                $gender = User::getDefaultOption( 'gender' );
 
                // allow prefix.
-               $title = Title::newFromText( $user );
+               $title = Title::newFromText( $username );
 
-               if ( is_object( $title ) && $title->getNamespace() == NS_USER )
-                       $user = $title->getText();
+               if ( $title && $title->getNamespace() == NS_USER ) {
+                       $username = $title->getText();
+               }
 
                // check parameter, or use the ParserOptions if in interface message
-               $user = User::newFromName( $user );
+               $user = User::newFromName( $username );
                if ( $user ) {
                        $gender = $user->getOption( 'gender' );
-               } elseif ( $parser->getOptions()->getInterfaceMessage() ) {
+               } elseif ( $username === '' && $parser->getOptions()->getInterfaceMessage() ) {
                        $gender = $parser->getOptions()->getUser()->getOption( 'gender' );
                }
                $ret = $parser->getFunctionLang()->gender( $gender, $forms );
                wfProfileOut( __METHOD__ );
                return $ret;
        }
+
+       /**
+        * @param $parser Parser
+        * @param string $text
+        * @return
+        */
        static function plural( $parser, $text = '' ) {
                $forms = array_slice( func_get_args(), 2 );
                $text = $parser->getFunctionLang()->parseFormattedNumber( $text );
@@ -395,10 +448,11 @@ class CoreParserFunctions {
                        return '';
                return wfUrlencode( $t->getSubjectNsText() );
        }
-       /*
+
+       /**
         * Functions to get and normalize pagenames, corresponding to the magic words
         * of the same names
-       */
+        */
        static function pagename( $parser, $title = null ) {
                $t = Title::newFromText( $title );
                if ( is_null( $t ) )
@@ -502,12 +556,13 @@ class CoreParserFunctions {
         * Return the size of the given page, or 0 if it's nonexistent.  This is an
         * expensive parser function and can't be called too many times per page.
         *
-        * @todo Fixme: This doesn't work correctly on preview for getting the size
+        * @todo FIXME: This doesn't work correctly on preview for getting the size
         *   of the current page.
-        * @todo Fixme: Title::getLength() documentation claims that it adds things
+        * @todo FIXME: Title::getLength() documentation claims that it adds things
         *   to the link cache, so the local cache here should be unnecessary, but
         *   in fact calling getLength() repeatedly for the same $page does seem to
         *   run one query for each call?
+        * @param $parser Parser
         */
        static function pagesize( $parser, $page = '', $raw = null ) {
                static $cache = array();
@@ -545,15 +600,30 @@ class CoreParserFunctions {
                return implode( $restrictions, ',' );
        }
 
-       static function language( $parser, $arg = '' ) {
+       /**
+        * Gives language names.
+        * @param $parser Parser
+        * @param $code String  Language code
+        * @param $language String  Language code
+        * @return String
+        */
+       static function language( $parser, $code = '', $language = '' ) {
                global $wgContLang;
-               $lang = $wgContLang->getLanguageName( strtolower( $arg ) );
-               return $lang != '' ? $lang : $arg;
+               $code = strtolower( $code );
+               $language = strtolower( $language );
+
+               if ( $language !== '' ) {
+                       $names = Language::getTranslatedLanguageNames( $language );
+                       return isset( $names[$code] ) ? $names[$code] : wfBCP47( $code );
+               }
+
+               $lang = $wgContLang->getLanguageName( $code );
+               return $lang !== '' ? $lang : wfBCP47( $code );
        }
 
        /**
         * Unicode-safe str_pad with the restriction that $length is forced to be <= 500
-        */
+        */
        static function pad( $string, $length, $padding = '0', $direction = STR_PAD_RIGHT ) {
                $lengthOfPadding = mb_strlen( $padding );
                if ( $lengthOfPadding == 0 ) return $string;
@@ -585,12 +655,17 @@ class CoreParserFunctions {
                return self::pad( $string, $length, $padding );
        }
 
+       /**
+        * @param $parser Parser
+        * @param  $text
+        * @return string
+        */
        static function anchorencode( $parser, $text ) {
                return substr( $parser->guessSectionNameFromWikiText( $text ), 1);
        }
 
        static function special( $parser, $text ) {
-               list( $page, $subpage ) = SpecialPage::resolveAliasWithSubpage( $text );
+               list( $page, $subpage ) = SpecialPageFactory::resolveAlias( $text );
                if ( $page ) {
                        $title = SpecialPage::getTitleFor( $page, $subpage );
                        return $title;
@@ -599,20 +674,38 @@ class CoreParserFunctions {
                }
        }
 
-       public static function defaultsort( $parser, $text ) {
+       /**
+        * @param $parser Parser
+        * @param $text String The sortkey to use
+        * @param $uarg String Either "noreplace" or "noerror" (in en)
+        *   both suppress errors, and noreplace does nothing if
+        *   a default sortkey already exists.
+        * @return string
+        */
+       public static function defaultsort( $parser, $text, $uarg = '' ) {
+               static $magicWords = null;
+               if ( is_null( $magicWords ) ) {
+                       $magicWords = new MagicWordArray( array( 'defaultsort_noerror', 'defaultsort_noreplace' ) );
+               }
+               $arg = $magicWords->matchStartToEnd( $uarg );
+
                $text = trim( $text );
                if( strlen( $text ) == 0 )
                        return '';
                $old = $parser->getCustomDefaultSort();
-               $parser->setDefaultSort( $text );
-               if( $old === false || $old == $text )
+               if ( $old === false || $arg !== 'defaultsort_noreplace' ) {
+                       $parser->setDefaultSort( $text );
+               }
+
+               if( $old === false || $old == $text || $arg ) {
                        return '';
-               else
+               } else {
                        return( '<span class="error">' .
                                wfMsgForContent( 'duplicate-defaultsort',
                                                 htmlspecialchars( $old ),
                                                 htmlspecialchars( $text ) ) .
                                '</span>' );
+               }
        }
 
        // Usage {{filepath|300}}, {{filepath|nowiki}}, {{filepath|nowiki|300}} or {{filepath|300|nowiki}}
@@ -638,15 +731,15 @@ class CoreParserFunctions {
                }
 
                if ( $file ) {
-                       $url = $file->getUrl();
+                       $url = $file->getFullUrl();
 
-                       // If a size is requested...                    
+                       // If a size is requested...
                        if ( is_integer( $size ) ) {
                                $mto = $file->transform( array( 'width' => $size ) );
                                // ... and we can
                                if ( $mto && !$mto->isError() ) {
                                        // ... change the URL to point to a thumbnail.
-                                       $url = wfExpandUrl( $mto->getUrl() );
+                                       $url = wfExpandUrl( $mto->getUrl(), PROTO_RELATIVE );
                                }
                        }
                        if ( $option == 'nowiki' ) {