Misc EOL w/s and spaces-instead-of-tabs fixes. One day I'll get around to nagging...
[lhc/web/wiklou.git] / languages / Language.php
index f36654d..8047bc0 100644 (file)
@@ -19,14 +19,6 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 global $wgLanguageNames;
 require_once( dirname( __FILE__ ) . '/Names.php' );
 
-global $wgInputEncoding, $wgOutputEncoding;
-
-/**
- * These are always UTF-8, they exist only for backwards compatibility
- */
-$wgInputEncoding    = 'UTF-8';
-$wgOutputEncoding      = 'UTF-8';
-
 if ( function_exists( 'mb_strtoupper' ) ) {
        mb_internal_encoding( 'UTF-8' );
 }
@@ -73,7 +65,11 @@ class Language {
         */
        var $transformData = array();
 
+       /**
+        * @var LocalisationCache
+        */
        static public $dataCache;
+
        static public $mLangObjCache = array();
 
        static public $mWeekdayMsgs = array(
@@ -154,16 +150,34 @@ class Language {
        protected static function newFromCode( $code ) {
                global $IP;
                static $recursionLevel = 0;
+
+               // Protect against path traversal below
+               if ( !Language::isValidCode( $code )
+                       || strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
+               {
+                       throw new MWException( "Invalid language code \"$code\"" );
+               }
+
+               if ( !Language::isValidBuiltInCode( $code ) ) {
+                       // It's not possible to customise this code with class files, so
+                       // just return a Language object. This is to support uselang= hacks.
+                       $lang = new Language;
+                       $lang->setCode( $code );
+                       return $lang;
+               }
+
                if ( $code == 'en' ) {
                        $class = 'Language';
                } else {
                        $class = 'Language' . str_replace( '-', '_', ucfirst( $code ) );
-                       // Preload base classes to work around APC/PHP5 bug
-                       if ( file_exists( "$IP/languages/classes/$class.deps.php" ) ) {
-                               include_once( "$IP/languages/classes/$class.deps.php" );
-                       }
-                       if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
-                               include_once( "$IP/languages/classes/$class.php" );
+                       if ( !defined( 'MW_COMPILED' ) ) {
+                               // Preload base classes to work around APC/PHP5 bug
+                               if ( file_exists( "$IP/languages/classes/$class.deps.php" ) ) {
+                                       include_once( "$IP/languages/classes/$class.deps.php" );
+                               }
+                               if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
+                                       include_once( "$IP/languages/classes/$class.php" );
+                               }
                        }
                }
 
@@ -171,7 +185,7 @@ class Language {
                        throw new MWException( "Language fallback loop detected when creating class $class\n" );
                }
 
-               if ( !class_exists( $class ) ) {
+               if ( !MWInit::classExists( $class ) ) {
                        $fallback = Language::getFallbackFor( $code );
                        ++$recursionLevel;
                        $lang = Language::newFromCode( $fallback );
@@ -183,8 +197,29 @@ class Language {
                return $lang;
        }
 
+       /**
+        * Returns true if a language code string is of a valid form, whether or
+        * not it exists. This includes codes which are used solely for
+        * customisation via the MediaWiki namespace.
+        */
+       public static function isValidCode( $code ) {
+               return
+                       strcspn( $code, ":/\\\000" ) === strlen( $code )
+                       && !preg_match( Title::getTitleInvalidRegex(), $code );
+       }
+
+       /**
+        * Returns true if a language code is of a valid form for the purposes of
+        * internal customisation of MediaWiki, via Messages*.php.
+        */
+       public static function isValidBuiltInCode( $code ) {
+               return preg_match( '/^[a-z0-9-]*$/i', $code );
+       }
+
        /**
         * Get the LocalisationCache instance
+        *
+        * @return LocalisationCache
         */
        public static function getLocalisationCache() {
                if ( is_null( self::$dataCache ) ) {
@@ -221,15 +256,6 @@ class Language {
         */
        function initContLang() { }
 
-       /**
-        * @deprecated Use User::getDefaultOptions()
-        * @return array
-        */
-       function getDefaultUserOptions() {
-               wfDeprecated( __METHOD__ );
-               return User::getDefaultOptions();
-       }
-
        function getFallbackLanguageCode() {
                if ( $this->mCode === 'en' ) {
                        return false;
@@ -324,6 +350,29 @@ class Language {
                return strtr( $ns, '_', ' ' );
        }
 
+       /**
+        * Returns gender-dependent namespace alias if available.
+        * @param $index Int: namespace index
+        * @param $gender String: gender key (male, female... )
+        * @return String
+        * @since 1.18
+        */
+       function getGenderNsText( $index, $gender ) {
+               $ns = self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
+               return isset( $ns[$index][$gender] ) ? $ns[$index][$gender] : $this->getNsText( $index );
+       }
+
+       /**
+        * Whether this language makes distinguishes genders for example in
+        * namespaces.
+        * @return bool
+        * @since 1.18
+        */
+       function needsGenderDistinction() {
+               $aliases = self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
+               return count( $aliases ) > 0;
+       }
+
        /**
         * Get a namespace key by value, case insensitive.
         * Only matches namespace names for the current language, not the
@@ -352,6 +401,14 @@ class Language {
                                        }
                                }
                        }
+
+                       $genders = self::$dataCache->getItem( $this->mCode, 'namespaceGenderAliases' );
+                       foreach ( $genders as $index => $forms ) {
+                               foreach ( $forms as $alias ) {
+                                       $aliases[$alias] = $index;
+                               }
+                       }
+
                        $this->namespaceAliases = $aliases;
                }
                return $this->namespaceAliases;
@@ -425,10 +482,6 @@ class Language {
                );
        }
 
-       function getMathNames() {
-               return self::$dataCache->getItem( $this->mCode, 'mathNames' );
-       }
-
        function getDatePreferences() {
                return self::$dataCache->getItem( $this->mCode, 'datePreferences' );
        }
@@ -472,8 +525,14 @@ class Language {
         * If $customisedOnly is true, only returns codes with a messages file
         */
        public static function getLanguageNames( $customisedOnly = false ) {
-               global $wgLanguageNames, $wgExtraLanguageNames;
-               $allNames = $wgExtraLanguageNames + $wgLanguageNames;
+               global $wgExtraLanguageNames;
+               static $coreLanguageNames;
+
+               if ( $coreLanguageNames === null ) {
+                       include( MWInit::compiledPath( 'languages/Names.php' ) );
+               }
+
+               $allNames = $wgExtraLanguageNames + $coreLanguageNames;
                if ( !$customisedOnly ) {
                        return $allNames;
                }
@@ -532,6 +591,14 @@ class Language {
                return $this->getMessageFromDB( self::$mMonthMsgs[$key - 1] );
        }
 
+       function getMonthNamesArray() {
+               $monthNames = array( '' );
+               for ( $i=1; $i < 13; $i++ ) {
+                       $monthNames[] = $this->getMonthName( $i );
+               }
+               return $monthNames;
+       }
+
        function getMonthNameGen( $key ) {
                return $this->getMessageFromDB( self::$mMonthGenMsgs[$key - 1] );
        }
@@ -540,6 +607,14 @@ class Language {
                return $this->getMessageFromDB( self::$mMonthAbbrevMsgs[$key - 1] );
        }
 
+       function getMonthAbbreviationsArray() {
+               $monthNames = array('');
+               for ( $i=1; $i < 13; $i++ ) {
+                       $monthNames[] = $this->getMonthAbbreviation( $i );
+               }
+               return $monthNames;
+       }
+
        function getWeekdayName( $key ) {
                return $this->getMessageFromDB( self::$mWeekdayMsgs[$key - 1] );
        }
@@ -1018,7 +1093,7 @@ class Language {
        private static function tsToIranian( $ts ) {
                $gy = substr( $ts, 0, 4 ) -1600;
                $gm = substr( $ts, 4, 2 ) -1;
-               $gd = substr( $ts, 6, 2 ) -1;
+               $gd = (int)substr( $ts, 6, 2 ) -1;
 
                # Days passed from the beginning (including leap years)
                $gDayNo = 365 * $gy
@@ -1568,11 +1643,11 @@ class Language {
        }
 
        function getMessage( $key ) {
-               return self::$dataCache->getSubitem( $this->getCodeForMessage(), 'messages', $key );
+               return self::$dataCache->getSubitem( $this->mCode, 'messages', $key );
        }
 
        function getAllMessages() {
-               return self::$dataCache->getItem( $this->getCodeForMessage(), 'messages' );
+               return self::$dataCache->getItem( $this->mCode, 'messages' );
        }
 
        function iconv( $in, $out, $string ) {
@@ -2071,14 +2146,20 @@ class Language {
                return self::$dataCache->getItem( $this->mCode, 'magicWords' );
        }
 
+       protected function doMagicHook() {
+               if ( $this->mMagicHookDone ) {
+                       return;
+               }
+               $this->mMagicHookDone = true;
+               wfProfileIn( 'LanguageGetMagic' );
+               wfRunHooks( 'LanguageGetMagic', array( &$this->mMagicExtensions, $this->getCode() ) );
+               wfProfileOut( 'LanguageGetMagic' );
+       }
+
        # Fill a MagicWord object with data from here
        function getMagic( $mw ) {
-               if ( !$this->mMagicHookDone ) {
-                       $this->mMagicHookDone = true;
-                       wfProfileIn( 'LanguageGetMagic' );
-                       wfRunHooks( 'LanguageGetMagic', array( &$this->mMagicExtensions, $this->getCode() ) );
-                       wfProfileOut( 'LanguageGetMagic' );
-               }
+               $this->doMagicHook();
+
                if ( isset( $this->mMagicExtensions[$mw->mId] ) ) {
                        $rawEntry = $this->mMagicExtensions[$mw->mId];
                } else {
@@ -2308,32 +2389,45 @@ class Language {
         * If $length is negative, the string will be truncated from the beginning
         *
         * @param $string String to truncate
-        * @param $length Int: maximum length (excluding ellipses)
+        * @param $length Int: maximum length (including ellipses)
         * @param $ellipsis String to append to the truncated text
+        * @param $adjustLength Boolean: Subtract length of ellipsis from $length.
+        *      $adjustLength was introduced in 1.18, before that behaved as if false.
         * @return string
         */
-       function truncate( $string, $length, $ellipsis = '...' ) {
+       function truncate( $string, $length, $ellipsis = '...', $adjustLength = true ) {
                # Use the localized ellipsis character
                if ( $ellipsis == '...' ) {
                        $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
                }
                # Check if there is no need to truncate
                if ( $length == 0 ) {
-                       return $ellipsis;
+                       return $ellipsis; // convention
                } elseif ( strlen( $string ) <= abs( $length ) ) {
-                       return $string;
+                       return $string; // no need to truncate
                }
                $stringOriginal = $string;
-               if ( $length > 0 ) {
-                       $string = substr( $string, 0, $length ); // xyz...
-                       $string = $this->removeBadCharLast( $string );
-                       $string = $string . $ellipsis;
+               # If ellipsis length is >= $length then we can't apply $adjustLength
+               if ( $adjustLength && strlen( $ellipsis ) >= abs( $length ) ) {
+                       $string = $ellipsis; // this can be slightly unexpected
+               # Otherwise, truncate and add ellipsis...
                } else {
-                       $string = substr( $string, $length ); // ...xyz
-                       $string = $this->removeBadCharFirst( $string );
-                       $string = $ellipsis . $string;
+                       $eLength = $adjustLength ? strlen( $ellipsis ) : 0;
+                       if ( $length > 0 ) {
+                               $length -= $eLength;
+                               $string = substr( $string, 0, $length ); // xyz...
+                               $string = $this->removeBadCharLast( $string );
+                               $string = $string . $ellipsis;
+                       } else {
+                               $length += $eLength;
+                               $string = substr( $string, $length ); // ...xyz
+                               $string = $this->removeBadCharFirst( $string );
+                               $string = $ellipsis . $string;
+                       }
                }
-               # Do not truncate if the ellipsis makes the string longer/equal (bug 22181)
+               # Do not truncate if the ellipsis makes the string longer/equal (bug 22181).
+               # This check is *not* redundant if $adjustLength, due to the single case where
+               # LEN($ellipsis) > ABS($limit arg); $stringOriginal could be shorter than $string.
                if ( strlen( $string ) < strlen( $stringOriginal ) ) {
                        return $string;
                } else {
@@ -2349,17 +2443,19 @@ class Language {
         * @return string
         */
        protected function removeBadCharLast( $string ) {
-               $char = ord( $string[strlen( $string ) - 1] );
-               $m = array();
-               if ( $char >= 0xc0 ) {
-                       # We got the first byte only of a multibyte char; remove it.
-                       $string = substr( $string, 0, -1 );
-               } elseif ( $char >= 0x80 &&
-                         preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
-                                                 '[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m ) )
-               {
-                       # We chopped in the middle of a character; remove it
-                       $string = $m[1];
+               if ( $string != '' ) {
+                       $char = ord( $string[strlen( $string ) - 1] );
+                       $m = array();
+                       if ( $char >= 0xc0 ) {
+                               # We got the first byte only of a multibyte char; remove it.
+                               $string = substr( $string, 0, -1 );
+                       } elseif ( $char >= 0x80 &&
+                                 preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
+                                                         '[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m ) )
+                       {
+                               # We chopped in the middle of a character; remove it
+                               $string = $m[1];
+                       }
                }
                return $string;
        }
@@ -2372,25 +2468,28 @@ class Language {
         * @return string
         */
        protected function removeBadCharFirst( $string ) {
-               $char = ord( $string[0] );
-               if ( $char >= 0x80 && $char < 0xc0 ) {
-                       # We chopped in the middle of a character; remove the whole thing
-                       $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
+               if ( $string != '' ) {
+                       $char = ord( $string[0] );
+                       if ( $char >= 0x80 && $char < 0xc0 ) {
+                               # We chopped in the middle of a character; remove the whole thing
+                               $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
+                       }
                }
                return $string;
        }
 
-       /*
+       /**
         * Truncate a string of valid HTML to a specified length in bytes,
         * appending an optional string (e.g. for ellipses), and return valid HTML
         *
         * This is only intended for styled/linked text, such as HTML with
-        * tags like <span> and <a>, were the tags are self-contained (valid HTML)
+        * tags like <span> and <a>, were the tags are self-contained (valid HTML).
+        * Also, this will not detect things like "display:none" CSS.
         *
-        * Note: tries to fix broken HTML with MWTidy
+        * Note: since 1.18 you do not need to leave extra room in $length for ellipses.
         *
         * @param string $text HTML string to truncate
-        * @param int $length (zero/positive) Maximum length (excluding ellipses)
+        * @param int $length (zero/positive) Maximum length (including ellipses)
         * @param string $ellipsis String to append to the truncated text
         * @returns string
         */
@@ -2399,22 +2498,45 @@ class Language {
                if ( $ellipsis == '...' ) {
                        $ellipsis = wfMsgExt( 'ellipsis', array( 'escapenoentities', 'language' => $this ) );
                }
-               # Check if there is no need to truncate
+               # Check if there is clearly no need to truncate
                if ( $length <= 0 ) {
-                       return $ellipsis; // no text shown, nothing to format
+                       return $ellipsis; // no text shown, nothing to format (convention)
                } elseif ( strlen( $text ) <= $length ) {
-                       return $text; // string short enough even *with* HTML
+                       return $text; // string short enough even *with* HTML (short-circuit)
                }
-               $text = MWTidy::tidy( $text ); // fix tags
+
                $displayLen = 0; // innerHTML legth so far
                $testingEllipsis = false; // checking if ellipses will make string longer/equal?
                $tagType = 0; // 0-open, 1-close
                $bracketState = 0; // 1-tag start, 2-tag name, 0-neither
                $entityState = 0; // 0-not entity, 1-entity
-               $tag = $ret = '';
+               $tag = $ret = $pRet = ''; // accumulated tag name, accumulated result string
                $openTags = array(); // open tag stack
+               $pOpenTags = array();
+
                $textLen = strlen( $text );
-               for ( $pos = 0; $pos < $textLen; ++$pos ) {
+               $neLength = max( 0, $length - strlen( $ellipsis ) ); // non-ellipsis len if truncated
+               for ( $pos = 0; true; ++$pos ) {
+                       # Consider truncation once the display length has reached the maximim.
+                       # Check that we're not in the middle of a bracket/entity...
+                       if ( $displayLen >= $neLength && $bracketState == 0 && $entityState == 0 ) {
+                               if ( !$testingEllipsis ) {
+                                       $testingEllipsis = true;
+                                       # Save where we are; we will truncate here unless there turn out to
+                                       # be so few remaining characters that truncation is not necessary.
+                                       $pOpenTags = $openTags; // save state
+                                       $pRet = $ret; // save state
+                               } elseif ( $displayLen > $length && $displayLen > strlen( $ellipsis ) ) {
+                                       # String in fact does need truncation, the truncation point was OK.
+                                       $openTags = $pOpenTags; // reload state
+                                       $ret = $this->removeBadCharLast( $pRet ); // reload state, multi-byte char fix
+                                       $ret .= $ellipsis; // add ellipsis
+                                       break;
+                               }
+                       }
+                       if ( $pos >= $textLen ) break; // extra iteration just for above checks
+
+                       # Read the next char...
                        $ch = $text[$pos];
                        $lastCh = $pos ? $text[$pos - 1] : '';
                        $ret .= $ch; // add to result string
@@ -2452,31 +2574,14 @@ class Language {
                                                $entityState = 1; // entity found, (e.g. "&#160;")
                                        } else {
                                                $displayLen++; // this char is displayed
-                                               // Add on the other display text after this...
-                                               $skipped = $this->truncate_skip(
-                                                       $ret, $text, "<>&", $pos + 1, $length - $displayLen );
+                                               // Add the next $max display text chars after this in one swoop...
+                                               $max = ( $testingEllipsis ? $length : $neLength ) - $displayLen;
+                                               $skipped = $this->truncate_skip( $ret, $text, "<>&", $pos + 1, $max );
                                                $displayLen += $skipped;
                                                $pos += $skipped;
                                        }
                                }
                        }
-                       # Consider truncation once the display length has reached the maximim.
-                       # Double-check that we're not in the middle of a bracket/entity...
-                       if ( $displayLen >= $length && $bracketState == 0 && $entityState == 0 ) {
-                               if ( !$testingEllipsis ) {
-                                       $testingEllipsis = true;
-                                       # Save where we are; we will truncate here unless
-                                       # the ellipsis actually makes the string longer.
-                                       $pOpenTags = $openTags; // save state
-                                       $pRet = $ret; // save state
-                               } elseif ( $displayLen > ( $length + strlen( $ellipsis ) ) ) {
-                                       # Ellipsis won't make string longer/equal, the truncation point was OK.
-                                       $openTags = $pOpenTags; // reload state
-                                       $ret = $this->removeBadCharLast( $pRet ); // reload state, multi-byte char fix
-                                       $ret .= $ellipsis; // add ellipsis
-                                       break;
-                               }
-                       }
                }
                if ( $displayLen == 0 ) {
                        return ''; // no text shown, nothing to format
@@ -2491,7 +2596,12 @@ class Language {
 
        // truncateHtml() helper function
        // like strcspn() but adds the skipped chars to $ret
-       private function truncate_skip( &$ret, $text, $search, $start, $len = -1 ) {
+       private function truncate_skip( &$ret, $text, $search, $start, $len = null ) {
+               if ( $len === null ) {
+                       $len = -1; // -1 means "no limit" for strcspn
+               } elseif ( $len < 0 ) {
+                       $len = 0; // sanity
+               }
                $skipCount = 0;
                if ( $start < strlen( $text ) ) {
                        $skipCount = strcspn( $text, $search, $start, $len );
@@ -2500,7 +2610,7 @@ class Language {
                return $skipCount;
        }
 
-       /*
+       /**
         * truncateHtml() helper function
         * (a) push or pop $tag from $openTags as needed
         * (b) clear $tag value
@@ -2587,7 +2697,7 @@ class Language {
 
        /**
         * Checks that convertPlural was given an array and pads it to requested
-        * amound of forms by copying the last one.
+        * amount of forms by copying the last one.
         *
         * @param $count Integer: How many forms should there be at least
         * @param $forms Array of forms given to convertPlural
@@ -2601,28 +2711,33 @@ class Language {
        }
 
        /**
-        * For translating of expiry times
-        * @param $str String: the validated block time in English
-        * @return Somehow translated block time
+        * Maybe translate block durations.  Note that this function is somewhat misnamed: it
+        * deals with translating the *duration* ("1 week", "4 days", etc), not the expiry time
+        * (which is an absolute timestamp).
+        * @param $str String: the validated block duration in English
+        * @return Somehow translated block duration
         * @see LanguageFi.php for example implementation
         */
        function translateBlockExpiry( $str ) {
-               $scBlockExpiryOptions = $this->getMessageFromDB( 'ipboptions' );
-
-               if ( $scBlockExpiryOptions == '-' ) {
-                       return $str;
-               }
-
-               foreach ( explode( ',', $scBlockExpiryOptions ) as $option ) {
-                       if ( strpos( $option, ':' ) === false ) {
-                               continue;
-                       }
-                       list( $show, $value ) = explode( ':', $option );
+               $duration = SpecialBlock::getSuggestedDurations( $this );
+               foreach( $duration as $show => $value ){
                        if ( strcmp( $str, $value ) == 0 ) {
                                return htmlspecialchars( trim( $show ) );
                        }
                }
 
+               // Since usually only infinite or indefinite is only on list, so try
+               // equivalents if still here.
+               $indefs = array( 'infinite', 'infinity', 'indefinite' );
+               if ( in_array( $str, $indefs ) ) {
+                       foreach( $indefs as $val ) {
+                               $show = array_search( $val, $duration, true );
+                               if ( $show !== false ) {
+                                       return htmlspecialchars( trim( $show ) );
+                               }
+                       }
+               }
+               // If all else fails, return the original string.
                return $str;
        }
 
@@ -2700,11 +2815,11 @@ class Language {
        function getPreferredVariant() {
                return $this->mConverter->getPreferredVariant();
        }
-       
+
        function getDefaultVariant() {
                return $this->mConverter->getDefaultVariant();
        }
-       
+
        function getURLVariant() {
                return $this->mConverter->getURLVariant();
        }
@@ -2730,7 +2845,7 @@ class Language {
         * into an array of all possible variants of the text:
         *  'variant' => text in that variant
         *
-        * @deprecated Use autoConvertToAllVariants()
+        * @deprecated since 1.17 Use autoConvertToAllVariants()
         */
        function convertLinkToAllVariants( $text ) {
                return $this->mConverter->convertLinkToAllVariants( $text );
@@ -2789,18 +2904,6 @@ class Language {
        function getCode() {
                return $this->mCode;
        }
-       
-       /**
-        * Get langcode for message
-        * Some language, like Chinese (zh, without any suffix), has multiple
-        * interface languages, we could choose a better one for user.
-        * Inherit class can override this function if necessary.
-        *
-        * @return string
-        */
-       function getCodeForMessage() {
-               return $this->getPreferredVariant();
-       }
 
        function setCode( $code ) {
                $this->mCode = $code;
@@ -2814,6 +2917,13 @@ class Language {
         * @return string $prefix . $mangledCode . $suffix
         */
        static function getFileName( $prefix = 'Language', $code, $suffix = '.php' ) {
+               // Protect against path traversal
+               if ( !Language::isValidCode( $code )
+                       || strcspn( $code, ":/\\\000" ) !== strlen( $code ) )
+               {
+                       throw new MWException( "Invalid language code \"$code\"" );
+               }
+
                return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
        }
 
@@ -2910,6 +3020,37 @@ class Language {
                return array( $wikiUpperChars, $wikiLowerChars );
        }
 
+       /**
+        * Decode an expiry (block, protection, etc) which has come from the DB
+        *
+        * @param $expiry String: Database expiry String
+        * @param $format Bool|Int true to process using language functions, or TS_ constant
+        *     to return the expiry in a given timestamp
+        * @return String
+        */
+       public function formatExpiry( $expiry, $format = true ) {
+               static $infinity, $infinityMsg;
+               if( $infinity === null ){
+                       $infinityMsg = wfMessage( 'infiniteblock' );
+                       $infinity = wfGetDB( DB_SLAVE )->getInfinity();
+               }
+
+               if ( $expiry == '' || $expiry == $infinity ) {
+                       return $format === true
+                               ? $infinityMsg
+                               : $infinity;
+               } else {
+                       return $format === true
+                               ? $this->timeanddate( $expiry )
+                               : wfTimestamp( $format, $expiry );
+               }
+       }
+
+       /**
+        * @todo Document
+        * @param  $seconds String
+        * @return string
+        */
        function formatTimePeriod( $seconds ) {
                if ( round( $seconds * 10 ) < 100 ) {
                        return $this->formatNum( sprintf( "%.1f", round( $seconds * 10 ) / 10 ) ) . $this->getMessageFromDB( 'seconds-abbrev' );