languages/Language.php

   1 <?php
   2 /**
   3  * @defgroup Language Language
   4  *
   5  * @file
   6  * @ingroup Language
   7  */
   8
   9 if( !defined( 'MEDIAWIKI' ) ) {
  10         echo "This file is part of MediaWiki, it is not a valid entry point.\n";
  11         exit( 1 );
  12 }
  13
  14 # Read language names
  15 global $wgLanguageNames;
  16 require_once( dirname(__FILE__) . '/Names.php' ) ;
  17
  18 global $wgInputEncoding, $wgOutputEncoding;
  19
  20 /**
  21  * These are always UTF-8, they exist only for backwards compatibility
  22  */
  23 $wgInputEncoding    = "UTF-8";
  24 $wgOutputEncoding       = "UTF-8";
  25
  26 if( function_exists( 'mb_strtoupper' ) ) {
  27         mb_internal_encoding('UTF-8');
  28 }
  29
  30 /**
  31  * a fake language converter
  32  *
  33  * @ingroup Language
  34  */
  35 class FakeConverter {
  36         var $mLang;
  37         function FakeConverter($langobj) {$this->mLang = $langobj;}
  38         function convert($t, $i) {return $t;}
  39         function parserConvert($t, $p) {return $t;}
  40         function getVariants() { return array( $this->mLang->getCode() ); }
  41         function getPreferredVariant() {return $this->mLang->getCode(); }
  42         function findVariantLink(&$l, &$n, $forTemplate = false) {}
  43         function getExtraHashOptions() {return '';}
  44         function getParsedTitle() {return '';}
  45         function markNoConversion($text, $noParse=false) {return $text;}
  46         function convertCategoryKey( $key ) {return $key; }
  47         function convertLinkToAllVariants($text){ return array( $this->mLang->getCode() => $text); }
  48         function armourMath($text){ return $text; }
  49 }
  50
  51 /**
  52  * Internationalisation code
  53  * @ingroup Language
  54  */
  55 class Language {
  56         var $mConverter, $mVariants, $mCode, $mLoaded = false;
  57         var $mMagicExtensions = array(), $mMagicHookDone = false;
  58
  59         static public $mLocalisationKeys = array( 'fallback', 'namespaceNames',
  60                 'skinNames', 'mathNames',
  61                 'bookstoreList', 'magicWords', 'messages', 'rtl', 'digitTransformTable',
  62                 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
  63                 'defaultUserOptionOverrides', 'linkTrail', 'namespaceAliases',
  64                 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
  65                 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
  66                 'imageFiles'
  67         );
  68
  69         static public $mMergeableMapKeys = array( 'messages', 'namespaceNames', 'mathNames',
  70                 'dateFormats', 'defaultUserOptionOverrides', 'magicWords', 'imageFiles' );
  71
  72         static public $mMergeableListKeys = array( 'extraUserToggles' );
  73
  74         static public $mMergeableAliasListKeys = array( 'specialPageAliases' );
  75
  76         static public $mLocalisationCache = array();
  77
  78         static public $mWeekdayMsgs = array(
  79                 'sunday', 'monday', 'tuesday', 'wednesday', 'thursday',
  80                 'friday', 'saturday'
  81         );
  82
  83         static public $mWeekdayAbbrevMsgs = array(
  84                 'sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat'
  85         );
  86
  87         static public $mMonthMsgs = array(
  88                 'january', 'february', 'march', 'april', 'may_long', 'june',
  89                 'july', 'august', 'september', 'october', 'november',
  90                 'december'
  91         );
  92         static public $mMonthGenMsgs = array(
  93                 'january-gen', 'february-gen', 'march-gen', 'april-gen', 'may-gen', 'june-gen',
  94                 'july-gen', 'august-gen', 'september-gen', 'october-gen', 'november-gen',
  95                 'december-gen'
  96         );
  97         static public $mMonthAbbrevMsgs = array(
  98                 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug',
  99                 'sep', 'oct', 'nov', 'dec'
 100         );
 101
 102         static public $mIranianCalendarMonthMsgs = array(
 103                 'iranian-calendar-m1', 'iranian-calendar-m2', 'iranian-calendar-m3',
 104                 'iranian-calendar-m4', 'iranian-calendar-m5', 'iranian-calendar-m6',
 105                 'iranian-calendar-m7', 'iranian-calendar-m8', 'iranian-calendar-m9',
 106                 'iranian-calendar-m10', 'iranian-calendar-m11', 'iranian-calendar-m12'
 107         );
 108
 109         static public $mHebrewCalendarMonthMsgs = array(
 110                 'hebrew-calendar-m1', 'hebrew-calendar-m2', 'hebrew-calendar-m3',
 111                 'hebrew-calendar-m4', 'hebrew-calendar-m5', 'hebrew-calendar-m6',
 112                 'hebrew-calendar-m7', 'hebrew-calendar-m8', 'hebrew-calendar-m9',
 113                 'hebrew-calendar-m10', 'hebrew-calendar-m11', 'hebrew-calendar-m12',
 114                 'hebrew-calendar-m6a', 'hebrew-calendar-m6b'
 115         );
 116
 117         static public $mHebrewCalendarMonthGenMsgs = array(
 118                 'hebrew-calendar-m1-gen', 'hebrew-calendar-m2-gen', 'hebrew-calendar-m3-gen',
 119                 'hebrew-calendar-m4-gen', 'hebrew-calendar-m5-gen', 'hebrew-calendar-m6-gen',
 120                 'hebrew-calendar-m7-gen', 'hebrew-calendar-m8-gen', 'hebrew-calendar-m9-gen',
 121                 'hebrew-calendar-m10-gen', 'hebrew-calendar-m11-gen', 'hebrew-calendar-m12-gen',
 122                 'hebrew-calendar-m6a-gen', 'hebrew-calendar-m6b-gen'
 123         );
 124
 125         static public $mHijriCalendarMonthMsgs = array(
 126                 'hijri-calendar-m1', 'hijri-calendar-m2', 'hijri-calendar-m3',
 127                 'hijri-calendar-m4', 'hijri-calendar-m5', 'hijri-calendar-m6',
 128                 'hijri-calendar-m7', 'hijri-calendar-m8', 'hijri-calendar-m9',
 129                 'hijri-calendar-m10', 'hijri-calendar-m11', 'hijri-calendar-m12'
 130         );
 131
 132         /**
 133          * Create a language object for a given language code
 134          */
 135         static function factory( $code ) {
 136                 global $IP;
 137                 static $recursionLevel = 0;
 138
 139                 if ( $code == 'en' ) {
 140                         $class = 'Language';
 141                 } else {
 142                         $class = 'Language' . str_replace( '-', '_', ucfirst( $code ) );
 143                         // Preload base classes to work around APC/PHP5 bug
 144                         if ( file_exists( "$IP/languages/classes/$class.deps.php" ) ) {
 145                                 include_once("$IP/languages/classes/$class.deps.php");
 146                         }
 147                         if ( file_exists( "$IP/languages/classes/$class.php" ) ) {
 148                                 include_once("$IP/languages/classes/$class.php");
 149                         }
 150                 }
 151
 152                 if ( $recursionLevel > 5 ) {
 153                         throw new MWException( "Language fallback loop detected when creating class $class\n" );
 154                 }
 155
 156                 if( ! class_exists( $class ) ) {
 157                         $fallback = Language::getFallbackFor( $code );
 158                         ++$recursionLevel;
 159                         $lang = Language::factory( $fallback );
 160                         --$recursionLevel;
 161                         $lang->setCode( $code );
 162                 } else {
 163                         $lang = new $class;
 164                 }
 165
 166                 return $lang;
 167         }
 168
 169         function __construct() {
 170                 $this->mConverter = new FakeConverter($this);
 171                 // Set the code to the name of the descendant
 172                 if ( get_class( $this ) == 'Language' ) {
 173                         $this->mCode = 'en';
 174                 } else {
 175                         $this->mCode = str_replace( '_', '-', strtolower( substr( get_class( $this ), 8 ) ) );
 176                 }
 177         }
 178
 179         /**
 180          * Reduce memory usage
 181          */
 182         function __destruct() {
 183                 foreach ( $this as $name => $value ) {
 184                         unset( $this->$name );
 185                 }
 186         }
 187
 188         /**
 189          * Hook which will be called if this is the content language.
 190          * Descendants can use this to register hook functions or modify globals
 191          */
 192         function initContLang() {}
 193
 194         /**
 195          * @deprecated Use User::getDefaultOptions()
 196          * @return array
 197          */
 198         function getDefaultUserOptions() {
 199                 wfDeprecated( __METHOD__ );
 200                 return User::getDefaultOptions();
 201         }
 202
 203         function getFallbackLanguageCode() {
 204                 return self::getFallbackFor( $this->mCode );
 205         }
 206
 207         /**
 208          * Exports $wgBookstoreListEn
 209          * @return array
 210          */
 211         function getBookstoreList() {
 212                 $this->load();
 213                 return $this->bookstoreList;
 214         }
 215
 216         /**
 217          * @return array
 218          */
 219         function getNamespaces() {
 220                 $this->load();
 221                 return $this->namespaceNames;
 222         }
 223
 224         /**
 225          * A convenience function that returns the same thing as
 226          * getNamespaces() except with the array values changed to ' '
 227          * where it found '_', useful for producing output to be displayed
 228          * e.g. in <select> forms.
 229          *
 230          * @return array
 231          */
 232         function getFormattedNamespaces() {
 233                 $ns = $this->getNamespaces();
 234                 foreach($ns as $k => $v) {
 235                         $ns[$k] = strtr($v, '_', ' ');
 236                 }
 237                 return $ns;
 238         }
 239
 240         /**
 241          * Get a namespace value by key
 242          * <code>
 243          * $mw_ns = $wgContLang->getNsText( NS_MEDIAWIKI );
 244          * echo $mw_ns; // prints 'MediaWiki'
 245          * </code>
 246          *
 247          * @param $index Int: the array key of the namespace to return
 248          * @return mixed, string if the namespace value exists, otherwise false
 249          */
 250         function getNsText( $index ) {
 251                 $ns = $this->getNamespaces();
 252                 return isset( $ns[$index] ) ? $ns[$index] : false;
 253         }
 254
 255         /**
 256          * A convenience function that returns the same thing as
 257          * getNsText() except with '_' changed to ' ', useful for
 258          * producing output.
 259          *
 260          * @return array
 261          */
 262         function getFormattedNsText( $index ) {
 263                 $ns = $this->getNsText( $index );
 264                 return strtr($ns, '_', ' ');
 265         }
 266
 267         /**
 268          * A convenience function that returns the same thing as
 269          * getFormattedNsText() except with '(Main)' for zero namespace.
 270          *
 271          * @return array
 272          */
 273         function getDisplayNsText( $index ) {
 274                 if( $index == 0 ) {
 275                         return wfMsg( 'blanknamespace' );
 276                 } else {
 277                         return $this->getFormattedNsText( $index );
 278                 }
 279         }
 280
 281         /**
 282          * Get a namespace key by value, case insensitive.
 283          * Only matches namespace names for the current language, not the
 284          * canonical ones defined in Namespace.php.
 285          *
 286          * @param $text String
 287          * @return mixed An integer if $text is a valid value otherwise false
 288          */
 289         function getLocalNsIndex( $text ) {
 290                 $this->load();
 291                 $lctext = $this->lc($text);
 292                 return isset( $this->mNamespaceIds[$lctext] ) ? $this->mNamespaceIds[$lctext] : false;
 293         }
 294
 295         /**
 296          * Get a namespace key by value, case insensitive.  Canonical namespace
 297          * names override custom ones defined for the current language.
 298          *
 299          * @param $text String
 300          * @return mixed An integer if $text is a valid value otherwise false
 301          */
 302         function getNsIndex( $text ) {
 303                 $this->load();
 304                 $lctext = $this->lc($text);
 305                 if( ( $ns = MWNamespace::getCanonicalIndex( $lctext ) ) !== null ) return $ns;
 306                 return isset( $this->mNamespaceIds[$lctext] ) ? $this->mNamespaceIds[$lctext] : false;
 307         }
 308
 309         /**
 310          * short names for language variants used for language conversion links.
 311          *
 312          * @param $code String
 313          * @return string
 314          */
 315         function getVariantname( $code ) {
 316                 return $this->getMessageFromDB( "variantname-$code" );
 317         }
 318
 319         function specialPage( $name ) {
 320                 $aliases = $this->getSpecialPageAliases();
 321                 if ( isset( $aliases[$name][0] ) ) {
 322                         $name = $aliases[$name][0];
 323                 }
 324                 return $this->getNsText(NS_SPECIAL) . ':' . $name;
 325         }
 326
 327         function getQuickbarSettings() {
 328                 return array(
 329                         $this->getMessage( 'qbsettings-none' ),
 330                         $this->getMessage( 'qbsettings-fixedleft' ),
 331                         $this->getMessage( 'qbsettings-fixedright' ),
 332                         $this->getMessage( 'qbsettings-floatingleft' ),
 333                         $this->getMessage( 'qbsettings-floatingright' )
 334                 );
 335         }
 336
 337         function getSkinNames() {
 338                 $this->load();
 339                 return $this->skinNames;
 340         }
 341
 342         function getMathNames() {
 343                 $this->load();
 344                 return $this->mathNames;
 345         }
 346
 347         function getDatePreferences() {
 348                 $this->load();
 349                 return $this->datePreferences;
 350         }
 351
 352         function getDateFormats() {
 353                 $this->load();
 354                 return $this->dateFormats;
 355         }
 356
 357         function getDefaultDateFormat() {
 358                 $this->load();
 359                 return $this->defaultDateFormat;
 360         }
 361
 362         function getDatePreferenceMigrationMap() {
 363                 $this->load();
 364                 return $this->datePreferenceMigrationMap;
 365         }
 366
 367         function getImageFile( $image ) {
 368                 $this->load();
 369                 return $this->imageFiles[$image];
 370         }
 371
 372         function getDefaultUserOptionOverrides() {
 373                 $this->load();
 374                 # XXX - apparently some languageas get empty arrays, didn't get to it yet -- midom
 375                 if (is_array($this->defaultUserOptionOverrides)) {
 376                         return $this->defaultUserOptionOverrides;
 377                 } else {
 378                         return array();
 379                 }
 380         }
 381
 382         function getExtraUserToggles() {
 383                 $this->load();
 384                 return $this->extraUserToggles;
 385         }
 386
 387         function getUserToggle( $tog ) {
 388                 return $this->getMessageFromDB( "tog-$tog" );
 389         }
 390
 391         /**
 392          * Get language names, indexed by code.
 393          * If $customisedOnly is true, only returns codes with a messages file
 394          */
 395         public static function getLanguageNames( $customisedOnly = false ) {
 396                 global $wgLanguageNames, $wgExtraLanguageNames;
 397                 $allNames = $wgExtraLanguageNames + $wgLanguageNames;
 398                 if ( !$customisedOnly ) {
 399                         return $allNames;
 400                 }
 401
 402                 global $IP;
 403                 $names = array();
 404                 $dir = opendir( "$IP/languages/messages" );
 405                 while( false !== ( $file = readdir( $dir ) ) ) {
 406                         $m = array();
 407                         if( preg_match( '/Messages([A-Z][a-z_]+)\.php$/', $file, $m ) ) {
 408                                 $code = str_replace( '_', '-', strtolower( $m[1] ) );
 409                                 if ( isset( $allNames[$code] ) ) {
 410                                         $names[$code] = $allNames[$code];
 411                                 }
 412                         }
 413                 }
 414                 closedir( $dir );
 415                 return $names;
 416         }
 417
 418         /**
 419          * Ugly hack to get a message maybe from the MediaWiki namespace, if this
 420          * language object is the content or user language.
 421          */
 422         function getMessageFromDB( $msg ) {
 423                 global $wgContLang, $wgLang;
 424                 if ( $wgContLang->getCode() == $this->getCode() ) {
 425                         # Content language
 426                         return wfMsgForContent( $msg );
 427                 } elseif ( $wgLang->getCode() == $this->getCode() ) {
 428                         # User language
 429                         return wfMsg( $msg );
 430                 } else {
 431                         # Neither, get from localisation
 432                         return $this->getMessage( $msg );
 433                 }
 434         }
 435
 436         function getLanguageName( $code ) {
 437                 $names = self::getLanguageNames();
 438                 if ( !array_key_exists( $code, $names ) ) {
 439                         return '';
 440                 }
 441                 return $names[$code];
 442         }
 443
 444         function getMonthName( $key ) {
 445                 return $this->getMessageFromDB( self::$mMonthMsgs[$key-1] );
 446         }
 447
 448         function getMonthNameGen( $key ) {
 449                 return $this->getMessageFromDB( self::$mMonthGenMsgs[$key-1] );
 450         }
 451
 452         function getMonthAbbreviation( $key ) {
 453                 return $this->getMessageFromDB( self::$mMonthAbbrevMsgs[$key-1] );
 454         }
 455
 456         function getWeekdayName( $key ) {
 457                 return $this->getMessageFromDB( self::$mWeekdayMsgs[$key-1] );
 458         }
 459
 460         function getWeekdayAbbreviation( $key ) {
 461                 return $this->getMessageFromDB( self::$mWeekdayAbbrevMsgs[$key-1] );
 462         }
 463
 464         function getIranianCalendarMonthName( $key ) {
 465                 return $this->getMessageFromDB( self::$mIranianCalendarMonthMsgs[$key-1] );
 466         }
 467
 468         function getHebrewCalendarMonthName( $key ) {
 469                 return $this->getMessageFromDB( self::$mHebrewCalendarMonthMsgs[$key-1] );
 470         }
 471
 472         function getHebrewCalendarMonthNameGen( $key ) {
 473                 return $this->getMessageFromDB( self::$mHebrewCalendarMonthGenMsgs[$key-1] );
 474         }
 475
 476         function getHijriCalendarMonthName( $key ) {
 477                 return $this->getMessageFromDB( self::$mHijriCalendarMonthMsgs[$key-1] );
 478         }
 479
 480         /**
 481          * Used by date() and time() to adjust the time output.
 482          *
 483          * @param $ts Int the time in date('YmdHis') format
 484          * @param $tz Mixed: adjust the time by this amount (default false, mean we
 485          *            get user timecorrection setting)
 486          * @return int
 487          */
 488         function userAdjust( $ts, $tz = false ) {
 489                 global $wgUser, $wgLocalTZoffset;
 490
 491                 if (!$tz) {
 492                         $tz = $wgUser->getOption( 'timecorrection' );
 493                 }
 494
 495                 # minutes and hours differences:
 496                 $minDiff = 0;
 497                 $hrDiff  = 0;
 498
 499                 if ( $tz === '' ) {
 500                         # Global offset in minutes.
 501                         if( isset($wgLocalTZoffset) ) {
 502                                 if( $wgLocalTZoffset >= 0 ) {
 503                                         $hrDiff = floor($wgLocalTZoffset / 60);
 504                                 } else {
 505                                         $hrDiff = ceil($wgLocalTZoffset / 60);
 506                                 }
 507                                 $minDiff = $wgLocalTZoffset % 60;
 508                         }
 509                 } elseif ( strpos( $tz, ':' ) !== false ) {
 510                         $tzArray = explode( ':', $tz );
 511                         $hrDiff = intval($tzArray[0]);
 512                         $minDiff = intval($hrDiff < 0 ? -$tzArray[1] : $tzArray[1]);
 513                 } else {
 514                         $hrDiff = intval( $tz );
 515                 }
 516
 517                 # No difference ? Return time unchanged
 518                 if ( 0 == $hrDiff && 0 == $minDiff ) { return $ts; }
 519
 520                 wfSuppressWarnings(); // E_STRICT system time bitching
 521                 # Generate an adjusted date
 522                 $t = mktime( (
 523                   (int)substr( $ts, 8, 2) ) + $hrDiff, # Hours
 524                   (int)substr( $ts, 10, 2 ) + $minDiff, # Minutes
 525                   (int)substr( $ts, 12, 2 ), # Seconds
 526                   (int)substr( $ts, 4, 2 ), # Month
 527                   (int)substr( $ts, 6, 2 ), # Day
 528                   (int)substr( $ts, 0, 4 ) ); #Year
 529
 530                 $date = date( 'YmdHis', $t );
 531                 wfRestoreWarnings();
 532
 533                 return $date;
 534         }
 535
 536         /**
 537          * This is a workalike of PHP's date() function, but with better
 538          * internationalisation, a reduced set of format characters, and a better
 539          * escaping format.
 540          *
 541          * Supported format characters are dDjlNwzWFmMntLYyaAgGhHiscrU. See the
 542          * PHP manual for definitions. There are a number of extensions, which
 543          * start with "x":
 544          *
 545          *    xn   Do not translate digits of the next numeric format character
 546          *    xN   Toggle raw digit (xn) flag, stays set until explicitly unset
 547          *    xr   Use roman numerals for the next numeric format character
 548          *    xh   Use hebrew numerals for the next numeric format character
 549          *    xx   Literal x
 550          *    xg   Genitive month name
 551          *
 552          *    xij  j (day number) in Iranian calendar
 553          *    xiF  F (month name) in Iranian calendar
 554          *    xin  n (month number) in Iranian calendar
 555          *    xiY  Y (full year) in Iranian calendar
 556          *
 557          *    xjj  j (day number) in Hebrew calendar
 558          *    xjF  F (month name) in Hebrew calendar
 559          *    xjt  t (days in month) in Hebrew calendar
 560          *    xjx  xg (genitive month name) in Hebrew calendar
 561          *    xjn  n (month number) in Hebrew calendar
 562          *    xjY  Y (full year) in Hebrew calendar
 563          *
 564          *   xmj  j (day number) in Hijri calendar
 565          *   xmF  F (month name) in Hijri calendar
 566          *   xmn  n (month number) in Hijri calendar
 567          *   xmY  Y (full year) in Hijri calendar
 568          *
 569          *    xkY  Y (full year) in Thai solar calendar. Months and days are
 570          *                       identical to the Gregorian calendar
 571          *
 572          * Characters enclosed in double quotes will be considered literal (with
 573          * the quotes themselves removed). Unmatched quotes will be considered
 574          * literal quotes. Example:
 575          *
 576          * "The month is" F       => The month is January
 577          * i's"                   => 20'11"
 578          *
 579          * Backslash escaping is also supported.
 580          *
 581          * Input timestamp is assumed to be pre-normalized to the desired local
 582          * time zone, if any.
 583          *
 584          * @param $format String
 585          * @param $ts String: 14-character timestamp
 586          *      YYYYMMDDHHMMSS
 587          *      01234567890123
 588          */
 589         function sprintfDate( $format, $ts ) {
 590                 $s = '';
 591                 $raw = false;
 592                 $roman = false;
 593                 $hebrewNum = false;
 594                 $unix = false;
 595                 $rawToggle = false;
 596                 $iranian = false;
 597                 $hebrew = false;
 598                 $hijri = false;
 599                 $thai = false;
 600                 for ( $p = 0; $p < strlen( $format ); $p++ ) {
 601                         $num = false;
 602                         $code = $format[$p];
 603                         if ( $code == 'x' && $p < strlen( $format ) - 1 ) {
 604                                 $code .= $format[++$p];
 605                         }
 606
 607                         if ( ( $code === 'xi' || $code == 'xj' || $code == 'xk' || $code == 'xm' ) && $p < strlen( $format ) - 1 ) {
 608                                 $code .= $format[++$p];
 609                         }
 610
 611                         switch ( $code ) {
 612                                 case 'xx':
 613                                         $s .= 'x';
 614                                         break;
 615                                 case 'xn':
 616                                         $raw = true;
 617                                         break;
 618                                 case 'xN':
 619                                         $rawToggle = !$rawToggle;
 620                                         break;
 621                                 case 'xr':
 622                                         $roman = true;
 623                                         break;
 624                                 case 'xh':
 625                                         $hebrewNum = true;
 626                                         break;
 627                                 case 'xg':
 628                                         $s .= $this->getMonthNameGen( substr( $ts, 4, 2 ) );
 629                                         break;
 630                                 case 'xjx':
 631                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 632                                         $s .= $this->getHebrewCalendarMonthNameGen( $hebrew[1] );
 633                                         break;
 634                                 case 'd':
 635                                         $num = substr( $ts, 6, 2 );
 636                                         break;
 637                                 case 'D':
 638                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 639                                         $s .= $this->getWeekdayAbbreviation( gmdate( 'w', $unix ) + 1 );
 640                                         break;
 641                                 case 'j':
 642                                         $num = intval( substr( $ts, 6, 2 ) );
 643                                         break;
 644                                 case 'xij':
 645                                         if ( !$iranian ) $iranian = self::tsToIranian( $ts );
 646                                         $num = $iranian[2];
 647                                         break;
 648                                 case 'xmj':
 649                                         if ( !$hijri ) $hijri = self::tsToHijri( $ts );
 650                                         $num = $hijri[2];
 651                                         break;
 652                                 case 'xjj':
 653                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 654                                         $num = $hebrew[2];
 655                                         break;
 656                                 case 'l':
 657                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 658                                         $s .= $this->getWeekdayName( gmdate( 'w', $unix ) + 1 );
 659                                         break;
 660                                 case 'N':
 661                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 662                                         $w = gmdate( 'w', $unix );
 663                                         $num = $w ? $w : 7;
 664                                         break;
 665                                 case 'w':
 666                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 667                                         $num = gmdate( 'w', $unix );
 668                                         break;
 669                                 case 'z':
 670                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 671                                         $num = gmdate( 'z', $unix );
 672                                         break;
 673                                 case 'W':
 674                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 675                                         $num = gmdate( 'W', $unix );
 676                                         break;
 677                                 case 'F':
 678                                         $s .= $this->getMonthName( substr( $ts, 4, 2 ) );
 679                                         break;
 680                                 case 'xiF':
 681                                         if ( !$iranian ) $iranian = self::tsToIranian( $ts );
 682                                         $s .= $this->getIranianCalendarMonthName( $iranian[1] );
 683                                         break;
 684                                 case 'xmF':
 685                                         if ( !$hijri ) $hijri = self::tsToHijri( $ts );
 686                                         $s .= $this->getHijriCalendarMonthName( $hijri[1] );
 687                                         break;
 688                                 case 'xjF':
 689                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 690                                         $s .= $this->getHebrewCalendarMonthName( $hebrew[1] );
 691                                         break;
 692                                 case 'm':
 693                                         $num = substr( $ts, 4, 2 );
 694                                         break;
 695                                 case 'M':
 696                                         $s .= $this->getMonthAbbreviation( substr( $ts, 4, 2 ) );
 697                                         break;
 698                                 case 'n':
 699                                         $num = intval( substr( $ts, 4, 2 ) );
 700                                         break;
 701                                 case 'xin':
 702                                         if ( !$iranian ) $iranian = self::tsToIranian( $ts );
 703                                         $num = $iranian[1];
 704                                         break;
 705                                 case 'xmn':
 706                                         if ( !$hijri ) $hijri = self::tsToHijri ( $ts );
 707                                         $num = $hijri[1];
 708                                         break;
 709                                 case 'xjn':
 710                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 711                                         $num = $hebrew[1];
 712                                         break;
 713                                 case 't':
 714                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 715                                         $num = gmdate( 't', $unix );
 716                                         break;
 717                                 case 'xjt':
 718                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 719                                         $num = $hebrew[3];
 720                                         break;
 721                                 case 'L':
 722                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 723                                         $num = gmdate( 'L', $unix );
 724                                         break;
 725                                 case 'Y':
 726                                         $num = substr( $ts, 0, 4 );
 727                                         break;
 728                                 case 'xiY':
 729                                         if ( !$iranian ) $iranian = self::tsToIranian( $ts );
 730                                         $num = $iranian[0];
 731                                         break;
 732                                 case 'xmY':
 733                                         if ( !$hijri ) $hijri = self::tsToHijri( $ts );
 734                                         $num = $hijri[0];
 735                                         break;
 736                                 case 'xjY':
 737                                         if ( !$hebrew ) $hebrew = self::tsToHebrew( $ts );
 738                                         $num = $hebrew[0];
 739                                         break;
 740                                 case 'xkY':
 741                                         if ( !$thai ) $thai = self::tsToThai( $ts );
 742                                         $num = $thai[0];
 743                                         break;
 744                                 case 'y':
 745                                         $num = substr( $ts, 2, 2 );
 746                                         break;
 747                                 case 'a':
 748                                         $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'am' : 'pm';
 749                                         break;
 750                                 case 'A':
 751                                         $s .= intval( substr( $ts, 8, 2 ) ) < 12 ? 'AM' : 'PM';
 752                                         break;
 753                                 case 'g':
 754                                         $h = substr( $ts, 8, 2 );
 755                                         $num = $h % 12 ? $h % 12 : 12;
 756                                         break;
 757                                 case 'G':
 758                                         $num = intval( substr( $ts, 8, 2 ) );
 759                                         break;
 760                                 case 'h':
 761                                         $h = substr( $ts, 8, 2 );
 762                                         $num = sprintf( '%02d', $h % 12 ? $h % 12 : 12 );
 763                                         break;
 764                                 case 'H':
 765                                         $num = substr( $ts, 8, 2 );
 766                                         break;
 767                                 case 'i':
 768                                         $num = substr( $ts, 10, 2 );
 769                                         break;
 770                                 case 's':
 771                                         $num = substr( $ts, 12, 2 );
 772                                         break;
 773                                 case 'c':
 774                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 775                                         $s .= gmdate( 'c', $unix );
 776                                         break;
 777                                 case 'r':
 778                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 779                                         $s .= gmdate( 'r', $unix );
 780                                         break;
 781                                 case 'U':
 782                                         if ( !$unix ) $unix = wfTimestamp( TS_UNIX, $ts );
 783                                         $num = $unix;
 784                                         break;
 785                                 case '\\':
 786                                         # Backslash escaping
 787                                         if ( $p < strlen( $format ) - 1 ) {
 788                                                 $s .= $format[++$p];
 789                                         } else {
 790                                                 $s .= '\\';
 791                                         }
 792                                         break;
 793                                 case '"':
 794                                         # Quoted literal
 795                                         if ( $p < strlen( $format ) - 1 ) {
 796                                                 $endQuote = strpos( $format, '"', $p + 1 );
 797                                                 if ( $endQuote === false ) {
 798                                                         # No terminating quote, assume literal "
 799                                                         $s .= '"';
 800                                                 } else {
 801                                                         $s .= substr( $format, $p + 1, $endQuote - $p - 1 );
 802                                                         $p = $endQuote;
 803                                                 }
 804                                         } else {
 805                                                 # Quote at end of string, assume literal "
 806                                                 $s .= '"';
 807                                         }
 808                                         break;
 809                                 default:
 810                                         $s .= $format[$p];
 811                         }
 812                         if ( $num !== false ) {
 813                                 if ( $rawToggle || $raw ) {
 814                                         $s .= $num;
 815                                         $raw = false;
 816                                 } elseif ( $roman ) {
 817                                         $s .= self::romanNumeral( $num );
 818                                         $roman = false;
 819                                 } elseif( $hebrewNum ) {
 820                                         $s .= self::hebrewNumeral( $num );
 821                                         $hebrewNum = false;
 822                                 } else {
 823                                         $s .= $this->formatNum( $num, true );
 824                                 }
 825                                 $num = false;
 826                         }
 827                 }
 828                 return $s;
 829         }
 830
 831         private static $GREG_DAYS = array( 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 );
 832         private static $IRANIAN_DAYS = array( 31, 31, 31, 31, 31, 31, 30, 30, 30, 30, 30, 29 );
 833         /**
 834          * Algorithm by Roozbeh Pournader and Mohammad Toossi to convert
 835          * Gregorian dates to Iranian dates. Originally written in C, it
 836          * is released under the terms of GNU Lesser General Public
 837          * License. Conversion to PHP was performed by Niklas Laxström.
 838          *
 839          * Link: http://www.farsiweb.info/jalali/jalali.c
 840          */
 841         private static function tsToIranian( $ts ) {
 842                 $gy = substr( $ts, 0, 4 ) -1600;
 843                 $gm = substr( $ts, 4, 2 ) -1;
 844                 $gd = substr( $ts, 6, 2 ) -1;
 845
 846                 # Days passed from the beginning (including leap years)
 847                 $gDayNo = 365*$gy
 848                         + floor(($gy+3) / 4)
 849                         - floor(($gy+99) / 100)
 850                         + floor(($gy+399) / 400);
 851
 852
 853                 // Add days of the past months of this year
 854                 for( $i = 0; $i < $gm; $i++ ) {
 855                         $gDayNo += self::$GREG_DAYS[$i];
 856                 }
 857
 858                 // Leap years
 859                 if ( $gm > 1 && (($gy%4===0 && $gy%100!==0 || ($gy%400==0)))) {
 860                         $gDayNo++;
 861                 }
 862
 863                 // Days passed in current month
 864                 $gDayNo += $gd;
 865
 866                 $jDayNo = $gDayNo - 79;
 867
 868                 $jNp = floor($jDayNo / 12053);
 869                 $jDayNo %= 12053;
 870
 871                 $jy = 979 + 33*$jNp + 4*floor($jDayNo/1461);
 872                 $jDayNo %= 1461;
 873
 874                 if ( $jDayNo >= 366 ) {
 875                         $jy += floor(($jDayNo-1)/365);
 876                         $jDayNo = floor(($jDayNo-1)%365);
 877                 }
 878
 879                 for ( $i = 0; $i < 11 && $jDayNo >= self::$IRANIAN_DAYS[$i]; $i++ ) {
 880                         $jDayNo -= self::$IRANIAN_DAYS[$i];
 881                 }
 882
 883                 $jm= $i+1;
 884                 $jd= $jDayNo+1;
 885
 886                 return array($jy, $jm, $jd);
 887         }
 888         /**
 889          * Converting Gregorian dates to Hijri dates.
 890          *
 891          * Based on a PHP-Nuke block by Sharjeel which is released under GNU/GPL license
 892          *
 893          * @link http://phpnuke.org/modules.php?name=News&file=article&sid=8234&mode=thread&order=0&thold=0
 894          */
 895         private static function tsToHijri ( $ts ) {
 896                 $year = substr( $ts, 0, 4 );
 897                 $month = substr( $ts, 4, 2 );
 898                 $day = substr( $ts, 6, 2 );
 899
 900                 $zyr = $year;
 901                 $zd=$day;
 902                 $zm=$month;
 903                 $zy=$zyr;
 904
 905
 906
 907                 if (($zy>1582)||(($zy==1582)&&($zm>10))||(($zy==1582)&&($zm==10)&&($zd>14)))
 908                         {
 909
 910
 911                                     $zjd=(int)((1461*($zy + 4800 + (int)( ($zm-14) /12) ))/4) + (int)((367*($zm-2-12*((int)(($zm-14)/12))))/12)-(int)((3*(int)(( ($zy+4900+(int)(($zm-14)/12))/100)))/4)+$zd-32075;
 912                                     }
 913                  else
 914                         {
 915                                     $zjd = 367*$zy-(int)((7*($zy+5001+(int)(($zm-9)/7)))/4)+(int)((275*$zm)/9)+$zd+1729777;
 916                         }
 917
 918                 $zl=$zjd-1948440+10632;
 919                 $zn=(int)(($zl-1)/10631);
 920                 $zl=$zl-10631*$zn+354;
 921                 $zj=((int)((10985-$zl)/5316))*((int)((50*$zl)/17719))+((int)($zl/5670))*((int)((43*$zl)/15238));
 922                 $zl=$zl-((int)((30-$zj)/15))*((int)((17719*$zj)/50))-((int)($zj/16))*((int)((15238*$zj)/43))+29;
 923                 $zm=(int)((24*$zl)/709);
 924                 $zd=$zl-(int)((709*$zm)/24);
 925                 $zy=30*$zn+$zj-30;
 926
 927                 return array ($zy, $zm, $zd);
 928         }
 929
 930         /**
 931          * Converting Gregorian dates to Hebrew dates.
 932          *
 933          * Based on a JavaScript code by Abu Mami and Yisrael Hersch
 934          * (abu-mami@kaluach.net, http://www.kaluach.net), who permitted
 935          * to translate the relevant functions into PHP and release them under
 936          * GNU GPL.
 937          *
 938          * The months are counted from Tishrei = 1. In a leap year, Adar I is 13
 939          * and Adar II is 14. In a non-leap year, Adar is 6.
 940          */
 941         private static function tsToHebrew( $ts ) {
 942                 # Parse date
 943                 $year = substr( $ts, 0, 4 );
 944                 $month = substr( $ts, 4, 2 );
 945                 $day = substr( $ts, 6, 2 );
 946
 947                 # Calculate Hebrew year
 948                 $hebrewYear = $year + 3760;
 949
 950                 # Month number when September = 1, August = 12
 951                 $month += 4;
 952                 if( $month > 12 ) {
 953                         # Next year
 954                         $month -= 12;
 955                         $year++;
 956                         $hebrewYear++;
 957                 }
 958
 959                 # Calculate day of year from 1 September
 960                 $dayOfYear = $day;
 961                 for( $i = 1; $i < $month; $i++ ) {
 962                         if( $i == 6 ) {
 963                                 # February
 964                                 $dayOfYear += 28;
 965                                 # Check if the year is leap
 966                                 if( $year % 400 == 0 || ( $year % 4 == 0 && $year % 100 > 0 ) ) {
 967                                         $dayOfYear++;
 968                                 }
 969                         } elseif( $i == 8 || $i == 10 || $i == 1 || $i == 3 ) {
 970                                 $dayOfYear += 30;
 971                         } else {
 972                                 $dayOfYear += 31;
 973                         }
 974                 }
 975
 976                 # Calculate the start of the Hebrew year
 977                 $start = self::hebrewYearStart( $hebrewYear );
 978
 979                 # Calculate next year's start
 980                 if( $dayOfYear <= $start ) {
 981                         # Day is before the start of the year - it is the previous year
 982                         # Next year's start
 983                         $nextStart = $start;
 984                         # Previous year
 985                         $year--;
 986                         $hebrewYear--;
 987                         # Add days since previous year's 1 September
 988                         $dayOfYear += 365;
 989                         if( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
 990                                 # Leap year
 991                                 $dayOfYear++;
 992                         }
 993                         # Start of the new (previous) year
 994                         $start = self::hebrewYearStart( $hebrewYear );
 995                 } else {
 996                         # Next year's start
 997                         $nextStart = self::hebrewYearStart( $hebrewYear + 1 );
 998                 }
 999
1000                 # Calculate Hebrew day of year
1001                 $hebrewDayOfYear = $dayOfYear - $start;
1002
1003                 # Difference between year's days
1004                 $diff = $nextStart - $start;
1005                 # Add 12 (or 13 for leap years) days to ignore the difference between
1006                 # Hebrew and Gregorian year (353 at least vs. 365/6) - now the
1007                 # difference is only about the year type
1008                 if( ( $year % 400 == 0 ) || ( $year % 100 != 0 && $year % 4 == 0 ) ) {
1009                         $diff += 13;
1010                 } else {
1011                         $diff += 12;
1012                 }
1013
1014                 # Check the year pattern, and is leap year
1015                 # 0 means an incomplete year, 1 means a regular year, 2 means a complete year
1016                 # This is mod 30, to work on both leap years (which add 30 days of Adar I)
1017                 # and non-leap years
1018                 $yearPattern = $diff % 30;
1019                 # Check if leap year
1020                 $isLeap = $diff >= 30;
1021
1022                 # Calculate day in the month from number of day in the Hebrew year
1023                 # Don't check Adar - if the day is not in Adar, we will stop before;
1024                 # if it is in Adar, we will use it to check if it is Adar I or Adar II
1025                 $hebrewDay = $hebrewDayOfYear;
1026                 $hebrewMonth = 1;
1027                 $days = 0;
1028                 while( $hebrewMonth <= 12 ) {
1029                         # Calculate days in this month
1030                         if( $isLeap && $hebrewMonth == 6 ) {
1031                                 # Adar in a leap year
1032                                 if( $isLeap ) {
1033                                         # Leap year - has Adar I, with 30 days, and Adar II, with 29 days
1034                                         $days = 30;
1035                                         if( $hebrewDay <= $days ) {
1036                                                 # Day in Adar I
1037                                                 $hebrewMonth = 13;
1038                                         } else {
1039                                                 # Subtract the days of Adar I
1040                                                 $hebrewDay -= $days;
1041                                                 # Try Adar II
1042                                                 $days = 29;
1043                                                 if( $hebrewDay <= $days ) {
1044                                                         # Day in Adar II
1045                                                         $hebrewMonth = 14;
1046                                                 }
1047                                         }
1048                                 }
1049                         } elseif( $hebrewMonth == 2 && $yearPattern == 2 ) {
1050                                 # Cheshvan in a complete year (otherwise as the rule below)
1051                                 $days = 30;
1052                         } elseif( $hebrewMonth == 3 && $yearPattern == 0 ) {
1053                                 # Kislev in an incomplete year (otherwise as the rule below)
1054                                 $days = 29;
1055                         } else {
1056                                 # Odd months have 30 days, even have 29
1057                                 $days = 30 - ( $hebrewMonth - 1 ) % 2;
1058                         }
1059                         if( $hebrewDay <= $days ) {
1060                                 # In the current month
1061                                 break;
1062                         } else {
1063                                 # Subtract the days of the current month
1064                                 $hebrewDay -= $days;
1065                                 # Try in the next month
1066                                 $hebrewMonth++;
1067                         }
1068                 }
1069
1070                 return array( $hebrewYear, $hebrewMonth, $hebrewDay, $days );
1071         }
1072
1073         /**
1074          * This calculates the Hebrew year start, as days since 1 September.
1075          * Based on Carl Friedrich Gauss algorithm for finding Easter date.
1076          * Used for Hebrew date.
1077          */
1078         private static function hebrewYearStart( $year ) {
1079                 $a = intval( ( 12 * ( $year - 1 ) + 17 ) % 19 );
1080                 $b = intval( ( $year - 1 ) % 4 );
1081                 $m = 32.044093161144 + 1.5542417966212 * $a +  $b / 4.0 - 0.0031777940220923 * ( $year - 1 );
1082                 if( $m < 0 ) {
1083                         $m--;
1084                 }
1085                 $Mar = intval( $m );
1086                 if( $m < 0 ) {
1087                         $m++;
1088                 }
1089                 $m -= $Mar;
1090
1091                 $c = intval( ( $Mar + 3 * ( $year - 1 ) + 5 * $b + 5 ) % 7);
1092                 if( $c == 0 && $a > 11 && $m >= 0.89772376543210 ) {
1093                         $Mar++;
1094                 } else if( $c == 1 && $a > 6 && $m >= 0.63287037037037 ) {
1095                         $Mar += 2;
1096                 } else if( $c == 2 || $c == 4 || $c == 6 ) {
1097                         $Mar++;
1098                 }
1099
1100                 $Mar += intval( ( $year - 3761 ) / 100 ) - intval( ( $year - 3761 ) / 400 ) - 24;
1101                 return $Mar;
1102         }
1103
1104         /**
1105          * Algorithm to convert Gregorian dates to Thai solar dates.
1106          *
1107          * Link: http://en.wikipedia.org/wiki/Thai_solar_calendar
1108          *
1109          * @param $ts String: 14-character timestamp
1110          * @return array converted year, month, day
1111          */
1112         private static function tsToThai( $ts ) {
1113                 $gy = substr( $ts, 0, 4 );
1114                 $gm = substr( $ts, 4, 2 );
1115                 $gd = substr( $ts, 6, 2 );
1116
1117                 # Add 543 years to the Gregorian calendar
1118                 # Months and days are identical
1119                 $gy_thai = $gy + 543;
1120
1121                 return array( $gy_thai, $gm, $gd );
1122         }
1123
1124
1125         /**
1126          * Roman number formatting up to 3000
1127          */
1128         static function romanNumeral( $num ) {
1129                 static $table = array(
1130                         array( '', 'I', 'II', 'III', 'IV', 'V', 'VI', 'VII', 'VIII', 'IX', 'X' ),
1131                         array( '', 'X', 'XX', 'XXX', 'XL', 'L', 'LX', 'LXX', 'LXXX', 'XC', 'C' ),
1132                         array( '', 'C', 'CC', 'CCC', 'CD', 'D', 'DC', 'DCC', 'DCCC', 'CM', 'M' ),
1133                         array( '', 'M', 'MM', 'MMM' )
1134                 );
1135
1136                 $num = intval( $num );
1137                 if ( $num > 3000 || $num <= 0 ) {
1138                         return $num;
1139                 }
1140
1141                 $s = '';
1142                 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1143                         if ( $num >= $pow10 ) {
1144                                 $s .= $table[$i][floor($num / $pow10)];
1145                         }
1146                         $num = $num % $pow10;
1147                 }
1148                 return $s;
1149         }
1150
1151         /**
1152          * Hebrew Gematria number formatting up to 9999
1153          */
1154         static function hebrewNumeral( $num ) {
1155                 static $table = array(
1156                         array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' ),
1157                         array( '', 'י', 'כ', 'ל', 'מ', 'נ', 'ס', 'ע', 'פ', 'צ', 'ק' ),
1158                         array( '', 'ק', 'ר', 'ש', 'ת', 'תק', 'תר', 'תש', 'תת', 'תתק', 'תתר' ),
1159                         array( '', 'א', 'ב', 'ג', 'ד', 'ה', 'ו', 'ז', 'ח', 'ט', 'י' )
1160                 );
1161
1162                 $num = intval( $num );
1163                 if ( $num > 9999 || $num <= 0 ) {
1164                         return $num;
1165                 }
1166
1167                 $s = '';
1168                 for ( $pow10 = 1000, $i = 3; $i >= 0; $pow10 /= 10, $i-- ) {
1169                         if ( $num >= $pow10 ) {
1170                                 if ( $num == 15 || $num == 16 ) {
1171                                         $s .= $table[0][9] . $table[0][$num - 9];
1172                                         $num = 0;
1173                                 } else {
1174                                         $s .= $table[$i][intval( ( $num / $pow10 ) )];
1175                                         if( $pow10 == 1000 ) {
1176                                                 $s .= "'";
1177                                         }
1178                                 }
1179                         }
1180                         $num = $num % $pow10;
1181                 }
1182                 if( strlen( $s ) == 2 ) {
1183                         $str = $s . "'";
1184                 } else  {
1185                         $str = substr( $s, 0, strlen( $s ) - 2 ) . '"';
1186                         $str .= substr( $s, strlen( $s ) - 2, 2 );
1187                 }
1188                 $start = substr( $str, 0, strlen( $str ) - 2 );
1189                 $end = substr( $str, strlen( $str ) - 2 );
1190                 switch( $end ) {
1191                         case 'כ':
1192                                 $str = $start . 'ך';
1193                                 break;
1194                         case 'מ':
1195                                 $str = $start . 'ם';
1196                                 break;
1197                         case 'נ':
1198                                 $str = $start . 'ן';
1199                                 break;
1200                         case 'פ':
1201                                 $str = $start . 'ף';
1202                                 break;
1203                         case 'צ':
1204                                 $str = $start . 'ץ';
1205                                 break;
1206                 }
1207                 return $str;
1208         }
1209
1210         /**
1211          * This is meant to be used by time(), date(), and timeanddate() to get
1212          * the date preference they're supposed to use, it should be used in
1213          * all children.
1214          *
1215          *<code>
1216          * function timeanddate([...], $format = true) {
1217          *      $datePreference = $this->dateFormat($format);
1218          * [...]
1219          * }
1220          *</code>
1221          *
1222          * @param $usePrefs Mixed: if true, the user's preference is used
1223          *                         if false, the site/language default is used
1224          *                         if int/string, assumed to be a format.
1225          * @return string
1226          */
1227         function dateFormat( $usePrefs = true ) {
1228                 global $wgUser;
1229
1230                 if( is_bool( $usePrefs ) ) {
1231                         if( $usePrefs ) {
1232                                 $datePreference = $wgUser->getDatePreference();
1233                         } else {
1234                                 $options = User::getDefaultOptions();
1235                                 $datePreference = (string)$options['date'];
1236                         }
1237                 } else {
1238                         $datePreference = (string)$usePrefs;
1239                 }
1240
1241                 // return int
1242                 if( $datePreference == '' ) {
1243                         return 'default';
1244                 }
1245
1246                 return $datePreference;
1247         }
1248
1249         /**
1250          * @param $ts Mixed: the time format which needs to be turned into a
1251          *            date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1252          * @param $adj Bool: whether to adjust the time output according to the
1253          *             user configured offset ($timecorrection)
1254          * @param $format Mixed: true to use user's date format preference
1255          * @param $timecorrection String: the time offset as returned by
1256          *                        validateTimeZone() in Special:Preferences
1257          * @return string
1258          */
1259         function date( $ts, $adj = false, $format = true, $timecorrection = false ) {
1260                 $this->load();
1261                 if ( $adj ) {
1262                         $ts = $this->userAdjust( $ts, $timecorrection );
1263                 }
1264
1265                 $pref = $this->dateFormat( $format );
1266                 if( $pref == 'default' || !isset( $this->dateFormats["$pref date"] ) ) {
1267                         $pref = $this->defaultDateFormat;
1268                 }
1269                 return $this->sprintfDate( $this->dateFormats["$pref date"], $ts );
1270         }
1271
1272         /**
1273          * @param $ts Mixed: the time format which needs to be turned into a
1274          *            date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1275          * @param $adj Bool: whether to adjust the time output according to the
1276          *             user configured offset ($timecorrection)
1277          * @param $format Mixed: true to use user's date format preference
1278          * @param $timecorrection String: the time offset as returned by
1279          *                        validateTimeZone() in Special:Preferences
1280          * @return string
1281          */
1282         function time( $ts, $adj = false, $format = true, $timecorrection = false ) {
1283                 $this->load();
1284                 if ( $adj ) {
1285                         $ts = $this->userAdjust( $ts, $timecorrection );
1286                 }
1287
1288                 $pref = $this->dateFormat( $format );
1289                 if( $pref == 'default' || !isset( $this->dateFormats["$pref time"] ) ) {
1290                         $pref = $this->defaultDateFormat;
1291                 }
1292                 return $this->sprintfDate( $this->dateFormats["$pref time"], $ts );
1293         }
1294
1295         /**
1296          * @param $ts Mixed: the time format which needs to be turned into a
1297          *            date('YmdHis') format with wfTimestamp(TS_MW,$ts)
1298          * @param $adj Bool: whether to adjust the time output according to the
1299          *             user configured offset ($timecorrection)
1300          * @param $format Mixed: what format to return, if it's false output the
1301          *                default one (default true)
1302          * @param $timecorrection String: the time offset as returned by
1303          *                        validateTimeZone() in Special:Preferences
1304          * @return string
1305          */
1306         function timeanddate( $ts, $adj = false, $format = true, $timecorrection = false) {
1307                 $this->load();
1308
1309                 $ts = wfTimestamp( TS_MW, $ts );
1310
1311                 if ( $adj ) {
1312                         $ts = $this->userAdjust( $ts, $timecorrection );
1313                 }
1314
1315                 $pref = $this->dateFormat( $format );
1316                 if( $pref == 'default' || !isset( $this->dateFormats["$pref both"] ) ) {
1317                         $pref = $this->defaultDateFormat;
1318                 }
1319
1320                 return $this->sprintfDate( $this->dateFormats["$pref both"], $ts );
1321         }
1322
1323         function getMessage( $key ) {
1324                 $this->load();
1325                 return isset( $this->messages[$key] ) ? $this->messages[$key] : null;
1326         }
1327
1328         function getAllMessages() {
1329                 $this->load();
1330                 return $this->messages;
1331         }
1332
1333         function iconv( $in, $out, $string ) {
1334                 # For most languages, this is a wrapper for iconv
1335                 return iconv( $in, $out . '//IGNORE', $string );
1336         }
1337
1338         // callback functions for uc(), lc(), ucwords(), ucwordbreaks()
1339         function ucwordbreaksCallbackAscii($matches){
1340                 return $this->ucfirst($matches[1]);
1341         }
1342
1343         function ucwordbreaksCallbackMB($matches){
1344                 return mb_strtoupper($matches[0]);
1345         }
1346
1347         function ucCallback($matches){
1348                 list( $wikiUpperChars ) = self::getCaseMaps();
1349                 return strtr( $matches[1], $wikiUpperChars );
1350         }
1351
1352         function lcCallback($matches){
1353                 list( , $wikiLowerChars ) = self::getCaseMaps();
1354                 return strtr( $matches[1], $wikiLowerChars );
1355         }
1356
1357         function ucwordsCallbackMB($matches){
1358                 return mb_strtoupper($matches[0]);
1359         }
1360
1361         function ucwordsCallbackWiki($matches){
1362                 list( $wikiUpperChars ) = self::getCaseMaps();
1363                 return strtr( $matches[0], $wikiUpperChars );
1364         }
1365
1366         function ucfirst( $str ) {
1367                 if ( empty($str) ) return $str;
1368                 if ( ord($str[0]) < 128 ) return ucfirst($str);
1369                 else return self::uc($str,true); // fall back to more complex logic in case of multibyte strings
1370         }
1371
1372         function uc( $str, $first = false ) {
1373                 if ( function_exists( 'mb_strtoupper' ) ) {
1374                         if ( $first ) {
1375                                 if ( self::isMultibyte( $str ) ) {
1376                                         return mb_strtoupper( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
1377                                 } else {
1378                                         return ucfirst( $str );
1379                                 }
1380                         } else {
1381                                 return self::isMultibyte( $str ) ? mb_strtoupper( $str ) : strtoupper( $str );
1382                         }
1383                 } else {
1384                         if ( self::isMultibyte( $str ) ) {
1385                                 list( $wikiUpperChars ) = $this->getCaseMaps();
1386                                 $x = $first ? '^' : '';
1387                                 return preg_replace_callback(
1388                                         "/$x([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
1389                                         array($this,"ucCallback"),
1390                                         $str
1391                                 );
1392                         } else {
1393                                 return $first ? ucfirst( $str ) : strtoupper( $str );
1394                         }
1395                 }
1396         }
1397
1398         function lcfirst( $str ) {
1399                 if ( empty($str) ) return $str;
1400                 if ( is_string( $str ) && ord($str[0]) < 128 ) {
1401                         // editing string in place = cool
1402                         $str[0]=strtolower($str[0]);
1403                         return $str;
1404                 }
1405                 else return self::lc( $str, true );
1406         }
1407
1408         function lc( $str, $first = false ) {
1409                 if ( function_exists( 'mb_strtolower' ) )
1410                         if ( $first )
1411                                 if ( self::isMultibyte( $str ) )
1412                                         return mb_strtolower( mb_substr( $str, 0, 1 ) ) . mb_substr( $str, 1 );
1413                                 else
1414                                         return strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 );
1415                         else
1416                                 return self::isMultibyte( $str ) ? mb_strtolower( $str ) : strtolower( $str );
1417                 else
1418                         if ( self::isMultibyte( $str ) ) {
1419                                 list( , $wikiLowerChars ) = self::getCaseMaps();
1420                                 $x = $first ? '^' : '';
1421                                 return preg_replace_callback(
1422                                         "/$x([A-Z]|[\\xc0-\\xff][\\x80-\\xbf]*)/",
1423                                         array($this,"lcCallback"),
1424                                         $str
1425                                 );
1426                         } else
1427                                 return $first ? strtolower( substr( $str, 0, 1 ) ) . substr( $str, 1 ) : strtolower( $str );
1428         }
1429
1430         function isMultibyte( $str ) {
1431                 return (bool)preg_match( '/[\x80-\xff]/', $str );
1432         }
1433
1434         function ucwords($str) {
1435                 if ( self::isMultibyte( $str ) ) {
1436                         $str = self::lc($str);
1437
1438                         // regexp to find first letter in each word (i.e. after each space)
1439                         $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)| ([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
1440
1441                         // function to use to capitalize a single char
1442                         if ( function_exists( 'mb_strtoupper' ) )
1443                                 return preg_replace_callback(
1444                                         $replaceRegexp,
1445                                         array($this,"ucwordsCallbackMB"),
1446                                         $str
1447                                 );
1448                         else
1449                                 return preg_replace_callback(
1450                                         $replaceRegexp,
1451                                         array($this,"ucwordsCallbackWiki"),
1452                                         $str
1453                                 );
1454                 }
1455                 else
1456                         return ucwords( strtolower( $str ) );
1457         }
1458
1459   # capitalize words at word breaks
1460         function ucwordbreaks($str){
1461                 if (self::isMultibyte( $str ) ) {
1462                         $str = self::lc($str);
1463
1464                         // since \b doesn't work for UTF-8, we explicitely define word break chars
1465                         $breaks= "[ \-\(\)\}\{\.,\?!]";
1466
1467                         // find first letter after word break
1468                         $replaceRegexp = "/^([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)|$breaks([a-z]|[\\xc0-\\xff][\\x80-\\xbf]*)/";
1469
1470                         if ( function_exists( 'mb_strtoupper' ) )
1471                                 return preg_replace_callback(
1472                                         $replaceRegexp,
1473                                         array($this,"ucwordbreaksCallbackMB"),
1474                                         $str
1475                                 );
1476                         else
1477                                 return preg_replace_callback(
1478                                         $replaceRegexp,
1479                                         array($this,"ucwordsCallbackWiki"),
1480                                         $str
1481                                 );
1482                 }
1483                 else
1484                         return preg_replace_callback(
1485                         '/\b([\w\x80-\xff]+)\b/',
1486                         array($this,"ucwordbreaksCallbackAscii"),
1487                         $str );
1488         }
1489
1490         /**
1491          * Return a case-folded representation of $s
1492          *
1493          * This is a representation such that caseFold($s1)==caseFold($s2) if $s1
1494          * and $s2 are the same except for the case of their characters. It is not
1495          * necessary for the value returned to make sense when displayed.
1496          *
1497          * Do *not* perform any other normalisation in this function. If a caller
1498          * uses this function when it should be using a more general normalisation
1499          * function, then fix the caller.
1500          */
1501         function caseFold( $s ) {
1502                 return $this->uc( $s );
1503         }
1504
1505         function checkTitleEncoding( $s ) {
1506                 if( is_array( $s ) ) {
1507                         wfDebugDieBacktrace( 'Given array to checkTitleEncoding.' );
1508                 }
1509                 # Check for non-UTF-8 URLs
1510                 $ishigh = preg_match( '/[\x80-\xff]/', $s);
1511                 if(!$ishigh) return $s;
1512
1513                 $isutf8 = preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
1514                 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})+$/', $s );
1515                 if( $isutf8 ) return $s;
1516
1517                 return $this->iconv( $this->fallback8bitEncoding(), "utf-8", $s );
1518         }
1519
1520         function fallback8bitEncoding() {
1521                 $this->load();
1522                 return $this->fallback8bitEncoding;
1523         }
1524
1525         /**
1526          * Some languages have special punctuation to strip out
1527          * or characters which need to be converted for MySQL's
1528          * indexing to grok it correctly. Make such changes here.
1529          *
1530          * @param $string String
1531          * @return String
1532          */
1533         function stripForSearch( $string ) {
1534                 global $wgDBtype;
1535                 if ( $wgDBtype != 'mysql' ) {
1536                         return $string;
1537                 }
1538
1539                 # MySQL fulltext index doesn't grok utf-8, so we
1540                 # need to fold cases and convert to hex
1541
1542                 wfProfileIn( __METHOD__ );
1543                 if( function_exists( 'mb_strtolower' ) ) {
1544                         $out = preg_replace(
1545                                 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
1546                                 "'U8' . bin2hex( \"$1\" )",
1547                                 mb_strtolower( $string ) );
1548                 } else {
1549                         list( , $wikiLowerChars ) = self::getCaseMaps();
1550                         $out = preg_replace(
1551                                 "/([\\xc0-\\xff][\\x80-\\xbf]*)/e",
1552                                 "'U8' . bin2hex( strtr( \"\$1\", \$wikiLowerChars ) )",
1553                                 $string );
1554                 }
1555                 wfProfileOut( __METHOD__ );
1556                 return $out;
1557         }
1558
1559         function convertForSearchResult( $termsArray ) {
1560                 # some languages, e.g. Chinese, need to do a conversion
1561                 # in order for search results to be displayed correctly
1562                 return $termsArray;
1563         }
1564
1565         /**
1566          * Get the first character of a string.
1567          *
1568          * @param $s string
1569          * @return string
1570          */
1571         function firstChar( $s ) {
1572                 $matches = array();
1573                 preg_match( '/^([\x00-\x7f]|[\xc0-\xdf][\x80-\xbf]|' .
1574                 '[\xe0-\xef][\x80-\xbf]{2}|[\xf0-\xf7][\x80-\xbf]{3})/', $s, $matches);
1575
1576                 if ( isset( $matches[1] ) ) {
1577                         if ( strlen( $matches[1] ) != 3 ) {
1578                                 return $matches[1];
1579                         }
1580
1581                         // Break down Hangul syllables to grab the first jamo
1582                         $code = utf8ToCodepoint( $matches[1] );
1583                         if ( $code < 0xac00 || 0xd7a4 <= $code) {
1584                                 return $matches[1];
1585                         } elseif ( $code < 0xb098 ) {
1586                                 return "\xe3\x84\xb1";
1587                         } elseif ( $code < 0xb2e4 ) {
1588                                 return "\xe3\x84\xb4";
1589                         } elseif ( $code < 0xb77c ) {
1590                                 return "\xe3\x84\xb7";
1591                         } elseif ( $code < 0xb9c8 ) {
1592                                 return "\xe3\x84\xb9";
1593                         } elseif ( $code < 0xbc14 ) {
1594                                 return "\xe3\x85\x81";
1595                         } elseif ( $code < 0xc0ac ) {
1596                                 return "\xe3\x85\x82";
1597                         } elseif ( $code < 0xc544 ) {
1598                                 return "\xe3\x85\x85";
1599                         } elseif ( $code < 0xc790 ) {
1600                                 return "\xe3\x85\x87";
1601                         } elseif ( $code < 0xcc28 ) {
1602                                 return "\xe3\x85\x88";
1603                         } elseif ( $code < 0xce74 ) {
1604                                 return "\xe3\x85\x8a";
1605                         } elseif ( $code < 0xd0c0 ) {
1606                                 return "\xe3\x85\x8b";
1607                         } elseif ( $code < 0xd30c ) {
1608                                 return "\xe3\x85\x8c";
1609                         } elseif ( $code < 0xd558 ) {
1610                                 return "\xe3\x85\x8d";
1611                         } else {
1612                                 return "\xe3\x85\x8e";
1613                         }
1614                 } else {
1615                         return "";
1616                 }
1617         }
1618
1619         function initEncoding() {
1620                 # Some languages may have an alternate char encoding option
1621                 # (Esperanto X-coding, Japanese furigana conversion, etc)
1622                 # If this language is used as the primary content language,
1623                 # an override to the defaults can be set here on startup.
1624         }
1625
1626         function recodeForEdit( $s ) {
1627                 # For some languages we'll want to explicitly specify
1628                 # which characters make it into the edit box raw
1629                 # or are converted in some way or another.
1630                 # Note that if wgOutputEncoding is different from
1631                 # wgInputEncoding, this text will be further converted
1632                 # to wgOutputEncoding.
1633                 global $wgEditEncoding;
1634                 if( $wgEditEncoding == '' or
1635                   $wgEditEncoding == 'UTF-8' ) {
1636                         return $s;
1637                 } else {
1638                         return $this->iconv( 'UTF-8', $wgEditEncoding, $s );
1639                 }
1640         }
1641
1642         function recodeInput( $s ) {
1643                 # Take the previous into account.
1644                 global $wgEditEncoding;
1645                 if($wgEditEncoding != "") {
1646                         $enc = $wgEditEncoding;
1647                 } else {
1648                         $enc = 'UTF-8';
1649                 }
1650                 if( $enc == 'UTF-8' ) {
1651                         return $s;
1652                 } else {
1653                         return $this->iconv( $enc, 'UTF-8', $s );
1654                 }
1655         }
1656
1657         /**
1658          * For right-to-left language support
1659          *
1660          * @return bool
1661          */
1662         function isRTL() {
1663                 $this->load();
1664                 return $this->rtl;
1665         }
1666
1667         /**
1668          * A hidden direction mark (LRM or RLM), depending on the language direction
1669          *
1670          * @return string
1671          */
1672         function getDirMark() {
1673                 return $this->isRTL() ? "\xE2\x80\x8F" : "\xE2\x80\x8E";
1674         }
1675
1676         /**
1677          * An arrow, depending on the language direction
1678          *
1679          * @return string
1680          */
1681         function getArrow() {
1682                 return $this->isRTL() ? '←' : '→';
1683         }
1684
1685         /**
1686          * To allow "foo[[bar]]" to extend the link over the whole word "foobar"
1687          *
1688          * @return bool
1689          */
1690         function linkPrefixExtension() {
1691                 $this->load();
1692                 return $this->linkPrefixExtension;
1693         }
1694
1695         function &getMagicWords() {
1696                 $this->load();
1697                 return $this->magicWords;
1698         }
1699
1700         # Fill a MagicWord object with data from here
1701         function getMagic( &$mw ) {
1702                 if ( !$this->mMagicHookDone ) {
1703                         $this->mMagicHookDone = true;
1704                         wfRunHooks( 'LanguageGetMagic', array( &$this->mMagicExtensions, $this->getCode() ) );
1705                 }
1706                 if ( isset( $this->mMagicExtensions[$mw->mId] ) ) {
1707                         $rawEntry = $this->mMagicExtensions[$mw->mId];
1708                 } else {
1709                         $magicWords =& $this->getMagicWords();
1710                         if ( isset( $magicWords[$mw->mId] ) ) {
1711                                 $rawEntry = $magicWords[$mw->mId];
1712                         } else {
1713                                 # Fall back to English if local list is incomplete
1714                                 $magicWords =& Language::getMagicWords();
1715                                 if ( !isset($magicWords[$mw->mId]) ) {
1716                                         throw new MWException("Magic word '{$mw->mId}' not found" );
1717                                 }
1718                                 $rawEntry = $magicWords[$mw->mId];
1719                         }
1720                 }
1721
1722                 if( !is_array( $rawEntry ) ) {
1723                         error_log( "\"$rawEntry\" is not a valid magic thingie for \"$mw->mId\"" );
1724                 } else {
1725                         $mw->mCaseSensitive = $rawEntry[0];
1726                         $mw->mSynonyms = array_slice( $rawEntry, 1 );
1727                 }
1728         }
1729
1730         /**
1731          * Add magic words to the extension array
1732          */
1733         function addMagicWordsByLang( $newWords ) {
1734                 $code = $this->getCode();
1735                 $fallbackChain = array();
1736                 while ( $code && !in_array( $code, $fallbackChain ) ) {
1737                         $fallbackChain[] = $code;
1738                         $code = self::getFallbackFor( $code );
1739                 }
1740                 if ( !in_array( 'en', $fallbackChain ) ) {
1741                         $fallbackChain[] = 'en';
1742                 }
1743                 $fallbackChain = array_reverse( $fallbackChain );
1744                 foreach ( $fallbackChain as $code ) {
1745                         if ( isset( $newWords[$code] ) ) {
1746                                 $this->mMagicExtensions = $newWords[$code] + $this->mMagicExtensions;
1747                         }
1748                 }
1749         }
1750
1751         /**
1752          * Get special page names, as an associative array
1753          *   case folded alias => real name
1754          */
1755         function getSpecialPageAliases() {
1756                 $this->load();
1757
1758                 // Cache aliases because it may be slow to load them
1759                 if ( !isset( $this->mExtendedSpecialPageAliases ) ) {
1760
1761                         // Initialise array
1762                         $this->mExtendedSpecialPageAliases = $this->specialPageAliases;
1763
1764                         global $wgExtensionAliasesFiles;
1765                         foreach ( $wgExtensionAliasesFiles as $file ) {
1766
1767                                 // Fail fast
1768                                 if ( !file_exists($file) )
1769                                         throw new MWException( "Aliases file does not exist: $file" );
1770
1771                                 $aliases = array();
1772                                 require($file);
1773
1774                                 // Check the availability of aliases
1775                                 if ( !isset($aliases['en']) )
1776                                         throw new MWException( "Malformed aliases file: $file" );
1777
1778                                 // Merge all aliases in fallback chain
1779                                 $code = $this->getCode();
1780                                 do {
1781                                         if ( !isset($aliases[$code]) ) continue;
1782
1783                                         $aliases[$code] = $this->fixSpecialPageAliases( $aliases[$code] );
1784                                         /* Merge the aliases, THIS will break if there is special page name
1785                                         * which looks like a numerical key, thanks to PHP...
1786                                         * See the comments for wfArrayMerge in GlobalSettings.php. */
1787                                         $this->mExtendedSpecialPageAliases = array_merge_recursive(
1788                                                 $this->mExtendedSpecialPageAliases, $aliases[$code] );
1789
1790                                 } while ( $code = self::getFallbackFor( $code ) );
1791                         }
1792
1793                         wfRunHooks( 'LanguageGetSpecialPageAliases',
1794                                 array( &$this->mExtendedSpecialPageAliases, $this->getCode() ) );
1795                 }
1796
1797                 return $this->mExtendedSpecialPageAliases;
1798         }
1799
1800         /**
1801          * Function to fix special page aliases. Will convert the first letter to
1802          * upper case and spaces to underscores. Can be given a full aliases array,
1803          * in which case it will recursively fix all aliases.
1804          */
1805         public function fixSpecialPageAliases( $mixed ) {
1806                 // Work recursively until in string level
1807                 if ( is_array($mixed) ) {
1808                         $callback = array( $this, 'fixSpecialPageAliases' );
1809                         return array_map( $callback, $mixed );
1810                 }
1811                 return str_replace( ' ', '_', $this->ucfirst( $mixed ) );
1812         }
1813
1814         /**
1815          * Italic is unsuitable for some languages
1816          *
1817          * @param $text String: the text to be emphasized.
1818          * @return string
1819          */
1820         function emphasize( $text ) {
1821                 return "<em>$text</em>";
1822         }
1823
1824          /**
1825           * Normally we output all numbers in plain en_US style, that is
1826           * 293,291.235 for twohundredninetythreethousand-twohundredninetyone
1827           * point twohundredthirtyfive. However this is not sutable for all
1828           * languages, some such as Pakaran want ੨੯੩,੨੯੫.੨੩੫ and others such as
1829           * Icelandic just want to use commas instead of dots, and dots instead
1830           * of commas like "293.291,235".
1831           *
1832           * An example of this function being called:
1833           * <code>
1834           * wfMsg( 'message', $wgLang->formatNum( $num ) )
1835           * </code>
1836           *
1837           * See LanguageGu.php for the Gujarati implementation and
1838           * LanguageIs.php for the , => . and . => , implementation.
1839           *
1840           * @todo check if it's viable to use localeconv() for the decimal
1841           *       separator thing.
1842           * @param $number Mixed: the string to be formatted, should be an integer
1843           *        or a floating point number.
1844           * @param $nocommafy Bool: set to true for special numbers like dates
1845           * @return string
1846           */
1847         function formatNum( $number, $nocommafy = false ) {
1848                 global $wgTranslateNumerals;
1849                 if (!$nocommafy) {
1850                         $number = $this->commafy($number);
1851                         $s = $this->separatorTransformTable();
1852                         if (!is_null($s)) { $number = strtr($number, $s); }
1853                 }
1854
1855                 if ($wgTranslateNumerals) {
1856                         $s = $this->digitTransformTable();
1857                         if (!is_null($s)) { $number = strtr($number, $s); }
1858                 }
1859
1860                 return $number;
1861         }
1862
1863         function parseFormattedNumber( $number ) {
1864                 $s = $this->digitTransformTable();
1865                 if (!is_null($s)) { $number = strtr($number, array_flip($s)); }
1866
1867                 $s = $this->separatorTransformTable();
1868                 if (!is_null($s)) { $number = strtr($number, array_flip($s)); }
1869
1870                 $number = strtr( $number, array (',' => '') );
1871                 return $number;
1872         }
1873
1874         /**
1875          * Adds commas to a given number
1876          *
1877          * @param $_ mixed
1878          * @return string
1879          */
1880         function commafy($_) {
1881                 return strrev((string)preg_replace('/(\d{3})(?=\d)(?!\d*\.)/','$1,',strrev($_)));
1882         }
1883
1884         function digitTransformTable() {
1885                 $this->load();
1886                 return $this->digitTransformTable;
1887         }
1888
1889         function separatorTransformTable() {
1890                 $this->load();
1891                 return $this->separatorTransformTable;
1892         }
1893
1894
1895         /**
1896          * For the credit list in includes/Credits.php (action=credits)
1897          *
1898          * @param $l Array
1899          * @return string
1900          */
1901         function listToText( $l ) {
1902                 $s = '';
1903                 $m = count($l) - 1;
1904                 for ($i = $m; $i >= 0; $i--) {
1905                         if ($i == $m) {
1906                                 $s = $l[$i];
1907                         } else if ($i == $m - 1) {
1908                                 $s = $l[$i] . ' ' . $this->getMessageFromDB( 'and' ) . ' ' . $s;
1909                         } else {
1910                                 $s = $l[$i] . ', ' . $s;
1911                         }
1912                 }
1913                 return $s;
1914         }
1915
1916         /**
1917          * Take a list of strings and build a locale-friendly comma-separated
1918          * list, using the local comma-separator message.
1919          * @fixme Fix this so it can work for $wgContLang too
1920          */
1921         function commaList( $list ) {
1922                 return implode(
1923                         $list,
1924                         wfMsgExt( 'comma-separator', 'escapenoentities' ) );
1925         }
1926
1927         /**
1928          * Truncate a string to a specified length in bytes, appending an optional
1929          * string (e.g. for ellipses)
1930          *
1931          * The database offers limited byte lengths for some columns in the database;
1932          * multi-byte character sets mean we need to ensure that only whole characters
1933          * are included, otherwise broken characters can be passed to the user
1934          *
1935          * If $length is negative, the string will be truncated from the beginning
1936          *
1937          * @param $string String to truncate
1938          * @param $length Int: maximum length (excluding ellipses)
1939          * @param $ellipsis String to append to the truncated text
1940          * @return string
1941          */
1942         function truncate( $string, $length, $ellipsis = "" ) {
1943                 if( $length == 0 ) {
1944                         return $ellipsis;
1945                 }
1946                 if ( strlen( $string ) <= abs( $length ) ) {
1947                         return $string;
1948                 }
1949                 if( $length > 0 ) {
1950                         $string = substr( $string, 0, $length );
1951                         $char = ord( $string[strlen( $string ) - 1] );
1952                         $m = array();
1953                         if ($char >= 0xc0) {
1954                                 # We got the first byte only of a multibyte char; remove it.
1955                                 $string = substr( $string, 0, -1 );
1956                         } elseif( $char >= 0x80 &&
1957                                   preg_match( '/^(.*)(?:[\xe0-\xef][\x80-\xbf]|' .
1958                                               '[\xf0-\xf7][\x80-\xbf]{1,2})$/', $string, $m ) ) {
1959                             # We chopped in the middle of a character; remove it
1960                                 $string = $m[1];
1961                         }
1962                         return $string . $ellipsis;
1963                 } else {
1964                         $string = substr( $string, $length );
1965                         $char = ord( $string[0] );
1966                         if( $char >= 0x80 && $char < 0xc0 ) {
1967                                 # We chopped in the middle of a character; remove the whole thing
1968                                 $string = preg_replace( '/^[\x80-\xbf]+/', '', $string );
1969                         }
1970                         return $ellipsis . $string;
1971                 }
1972         }
1973
1974         /**
1975          * Grammatical transformations, needed for inflected languages
1976          * Invoked by putting {{grammar:case|word}} in a message
1977          *
1978          * @param $word string
1979          * @param $case string
1980          * @return string
1981          */
1982         function convertGrammar( $word, $case ) {
1983                 global $wgGrammarForms;
1984                 if ( isset($wgGrammarForms[$this->getCode()][$case][$word]) ) {
1985                         return $wgGrammarForms[$this->getCode()][$case][$word];
1986                 }
1987                 return $word;
1988         }
1989
1990         /**
1991          * Plural form transformations, needed for some languages.
1992          * For example, there are 3 form of plural in Russian and Polish,
1993          * depending on "count mod 10". See [[w:Plural]]
1994          * For English it is pretty simple.
1995          *
1996          * Invoked by putting {{plural:count|wordform1|wordform2}}
1997          * or {{plural:count|wordform1|wordform2|wordform3}}
1998          *
1999          * Example: {{plural:{{NUMBEROFARTICLES}}|article|articles}}
2000          *
2001          * @param $count Integer: non-localized number
2002          * @param $forms Array: different plural forms
2003          * @return string Correct form of plural for $count in this language
2004          */
2005         function convertPlural( $count, $forms ) {
2006                 if ( !count($forms) ) { return ''; }
2007                 $forms = $this->preConvertPlural( $forms, 2 );
2008
2009                 return ( $count == 1 ) ? $forms[0] : $forms[1];
2010         }
2011
2012         /**
2013          * Checks that convertPlural was given an array and pads it to requested
2014          * amound of forms by copying the last one.
2015          *
2016          * @param $count Integer: How many forms should there be at least
2017          * @param $forms Array of forms given to convertPlural
2018          * @return array Padded array of forms or an exception if not an array
2019          */
2020         protected function preConvertPlural( /* Array */ $forms, $count ) {
2021                 while ( count($forms) < $count ) {
2022                         $forms[] = $forms[count($forms)-1];
2023                 }
2024                 return $forms;
2025         }
2026
2027         /**
2028          * For translaing of expiry times
2029          * @param $str String: the validated block time in English
2030          * @return Somehow translated block time
2031          * @see LanguageFi.php for example implementation
2032          */
2033         function translateBlockExpiry( $str ) {
2034
2035                 $scBlockExpiryOptions = $this->getMessageFromDB( 'ipboptions' );
2036
2037                 if ( $scBlockExpiryOptions == '-') {
2038                         return $str;
2039                 }
2040
2041                 foreach (explode(',', $scBlockExpiryOptions) as $option) {
2042                         if ( strpos($option, ":") === false )
2043                                 continue;
2044                         list($show, $value) = explode(":", $option);
2045                         if ( strcmp ( $str, $value) == 0 ) {
2046                                 return htmlspecialchars( trim( $show ) );
2047                         }
2048                 }
2049
2050                 return $str;
2051         }
2052
2053         /**
2054          * languages like Chinese need to be segmented in order for the diff
2055          * to be of any use
2056          *
2057          * @param $text String
2058          * @return String
2059          */
2060         function segmentForDiff( $text ) {
2061                 return $text;
2062         }
2063
2064         /**
2065          * and unsegment to show the result
2066          *
2067          * @param $text String
2068          * @return String
2069          */
2070         function unsegmentForDiff( $text ) {
2071                 return $text;
2072         }
2073
2074         # convert text to different variants of a language.
2075         function convert( $text, $isTitle = false) {
2076                 return $this->mConverter->convert($text, $isTitle);
2077         }
2078
2079         # Convert text from within Parser
2080         function parserConvert( $text, &$parser ) {
2081                 return $this->mConverter->parserConvert( $text, $parser );
2082         }
2083
2084         # Check if this is a language with variants
2085         function hasVariants(){
2086                 return sizeof($this->getVariants())>1;
2087         }
2088
2089         # Put custom tags (e.g. -{ }-) around math to prevent conversion
2090         function armourMath($text){
2091                 return $this->mConverter->armourMath($text);
2092         }
2093
2094
2095         /**
2096          * Perform output conversion on a string, and encode for safe HTML output.
2097          * @param $text String
2098          * @param $isTitle Bool -- wtf?
2099          * @return string
2100          * @todo this should get integrated somewhere sane
2101          */
2102         function convertHtml( $text, $isTitle = false ) {
2103                 return htmlspecialchars( $this->convert( $text, $isTitle ) );
2104         }
2105
2106         function convertCategoryKey( $key ) {
2107                 return $this->mConverter->convertCategoryKey( $key );
2108         }
2109
2110         /**
2111          * get the list of variants supported by this langauge
2112          * see sample implementation in LanguageZh.php
2113          *
2114          * @return array an array of language codes
2115          */
2116         function getVariants() {
2117                 return $this->mConverter->getVariants();
2118         }
2119
2120
2121         function getPreferredVariant( $fromUser = true ) {
2122                 return $this->mConverter->getPreferredVariant( $fromUser );
2123         }
2124
2125         /**
2126          * if a language supports multiple variants, it is
2127          * possible that non-existing link in one variant
2128          * actually exists in another variant. this function
2129          * tries to find it. See e.g. LanguageZh.php
2130          *
2131          * @param $link String: the name of the link
2132          * @param $nt Mixed: the title object of the link
2133          * @return null the input parameters may be modified upon return
2134          */
2135         function findVariantLink( &$link, &$nt, $forTemplate = false ) {
2136                 $this->mConverter->findVariantLink($link, $nt, $forTemplate );
2137         }
2138
2139         /**
2140          * If a language supports multiple variants, converts text
2141          * into an array of all possible variants of the text:
2142          *  'variant' => text in that variant
2143          */
2144
2145         function convertLinkToAllVariants($text){
2146                 return $this->mConverter->convertLinkToAllVariants($text);
2147         }
2148
2149
2150         /**
2151          * returns language specific options used by User::getPageRenderHash()
2152          * for example, the preferred language variant
2153          *
2154          * @return string
2155          */
2156         function getExtraHashOptions() {
2157                 return $this->mConverter->getExtraHashOptions();
2158         }
2159
2160         /**
2161          * for languages that support multiple variants, the title of an
2162          * article may be displayed differently in different variants. this
2163          * function returns the apporiate title defined in the body of the article.
2164          *
2165          * @return string
2166          */
2167         function getParsedTitle() {
2168                 return $this->mConverter->getParsedTitle();
2169         }
2170
2171         /**
2172          * Enclose a string with the "no conversion" tag. This is used by
2173          * various functions in the Parser
2174          *
2175          * @param $text String: text to be tagged for no conversion
2176          * @param $noParse
2177          * @return string the tagged text
2178          */
2179         function markNoConversion( $text, $noParse=false ) {
2180                 return $this->mConverter->markNoConversion( $text, $noParse );
2181         }
2182
2183         /**
2184          * A regular expression to match legal word-trailing characters
2185          * which should be merged onto a link of the form [[foo]]bar.
2186          *
2187          * @return string
2188          */
2189         function linkTrail() {
2190                 $this->load();
2191                 return $this->linkTrail;
2192         }
2193
2194         function getLangObj() {
2195                 return $this;
2196         }
2197
2198         /**
2199          * Get the RFC 3066 code for this language object
2200          */
2201         function getCode() {
2202                 return $this->mCode;
2203         }
2204
2205         function setCode( $code ) {
2206                 $this->mCode = $code;
2207         }
2208
2209         static function getFileName( $prefix = 'Language', $code, $suffix = '.php' ) {
2210                 return $prefix . str_replace( '-', '_', ucfirst( $code ) ) . $suffix;
2211         }
2212
2213         static function getMessagesFileName( $code ) {
2214                 global $IP;
2215                 return self::getFileName( "$IP/languages/messages/Messages", $code, '.php' );
2216         }
2217
2218         static function getClassFileName( $code ) {
2219                 global $IP;
2220                 return self::getFileName( "$IP/languages/classes/Language", $code, '.php' );
2221         }
2222
2223         static function getLocalisationArray( $code, $disableCache = false ) {
2224                 self::loadLocalisation( $code, $disableCache );
2225                 return self::$mLocalisationCache[$code];
2226         }
2227
2228         /**
2229          * Load localisation data for a given code into the static cache
2230          *
2231          * @return array Dependencies, map of filenames to mtimes
2232          */
2233         static function loadLocalisation( $code, $disableCache = false ) {
2234                 static $recursionGuard = array();
2235                 global $wgMemc, $wgCheckSerialized;
2236
2237                 if ( !$code ) {
2238                         throw new MWException( "Invalid language code requested" );
2239                 }
2240
2241                 if ( !$disableCache ) {
2242                         # Try the per-process cache
2243                         if ( isset( self::$mLocalisationCache[$code] ) ) {
2244                                 return self::$mLocalisationCache[$code]['deps'];
2245                         }
2246
2247                         wfProfileIn( __METHOD__ );
2248
2249                         # Try the serialized directory
2250                         $cache = wfGetPrecompiledData( self::getFileName( "Messages", $code, '.ser' ) );
2251                         if ( $cache ) {
2252                                 if ( $wgCheckSerialized && self::isLocalisationOutOfDate( $cache ) ) {
2253                                         $cache = false;
2254                                         wfDebug( "Language::loadLocalisation(): precompiled data file for $code is out of date\n" );
2255                                 } else {
2256                                         self::$mLocalisationCache[$code] = $cache;
2257                                         wfDebug( "Language::loadLocalisation(): got localisation for $code from precompiled data file\n" );
2258                                         wfProfileOut( __METHOD__ );
2259                                         return self::$mLocalisationCache[$code]['deps'];
2260                                 }
2261                         }
2262
2263                         # Try the global cache
2264                         $memcKey = wfMemcKey('localisation', $code );
2265                         $fbMemcKey = wfMemcKey('fallback', $cache['fallback'] );
2266                         $cache = $wgMemc->get( $memcKey );
2267                         if ( $cache ) {
2268                                 if ( self::isLocalisationOutOfDate( $cache ) ) {
2269                                         $wgMemc->delete( $memcKey );
2270                                         $wgMemc->delete( $fbMemcKey );
2271                                         $cache = false;
2272                                         wfDebug( "Language::loadLocalisation(): localisation cache for $code had expired\n" );
2273                                 } else {
2274                                         self::$mLocalisationCache[$code] = $cache;
2275                                         wfDebug( "Language::loadLocalisation(): got localisation for $code from cache\n" );
2276                                         wfProfileOut( __METHOD__ );
2277                                         return $cache['deps'];
2278                                 }
2279                         }
2280                 } else {
2281                         wfProfileIn( __METHOD__ );
2282                 }
2283
2284                 # Default fallback, may be overridden when the messages file is included
2285                 if ( $code != 'en' ) {
2286                         $fallback = 'en';
2287                 } else {
2288                         $fallback = false;
2289                 }
2290
2291                 # Load the primary localisation from the source file
2292                 $filename = self::getMessagesFileName( $code );
2293                 if ( !file_exists( $filename ) ) {
2294                         wfDebug( "Language::loadLocalisation(): no localisation file for $code, using implicit fallback to en\n" );
2295                         $cache = compact( self::$mLocalisationKeys ); // Set correct fallback
2296                         $deps = array();
2297                 } else {
2298                         $deps = array( $filename => filemtime( $filename ) );
2299                         require( $filename );
2300                         $cache = compact( self::$mLocalisationKeys );
2301                         wfDebug( "Language::loadLocalisation(): got localisation for $code from source\n" );
2302                 }
2303
2304                 if ( !empty( $fallback ) ) {
2305                         # Load the fallback localisation, with a circular reference guard
2306                         if ( isset( $recursionGuard[$code] ) ) {
2307                                 throw new MWException( "Error: Circular fallback reference in language code $code" );
2308                         }
2309                         $recursionGuard[$code] = true;
2310                         $newDeps = self::loadLocalisation( $fallback, $disableCache );
2311                         unset( $recursionGuard[$code] );
2312
2313                         $secondary = self::$mLocalisationCache[$fallback];
2314                         $deps = array_merge( $deps, $newDeps );
2315
2316                         # Merge the fallback localisation with the current localisation
2317                         foreach ( self::$mLocalisationKeys as $key ) {
2318                                 if ( isset( $cache[$key] ) ) {
2319                                         if ( isset( $secondary[$key] ) ) {
2320                                                 if ( in_array( $key, self::$mMergeableMapKeys ) ) {
2321                                                         $cache[$key] = $cache[$key] + $secondary[$key];
2322                                                 } elseif ( in_array( $key, self::$mMergeableListKeys ) ) {
2323                                                         $cache[$key] = array_merge( $secondary[$key], $cache[$key] );
2324                                                 } elseif ( in_array( $key, self::$mMergeableAliasListKeys ) ) {
2325                                                         $cache[$key] = array_merge_recursive( $cache[$key], $secondary[$key] );
2326                                                 }
2327                                         }
2328                                 } else {
2329                                         $cache[$key] = $secondary[$key];
2330                                 }
2331                         }
2332
2333                         # Merge bookstore lists if requested
2334                         if ( !empty( $cache['bookstoreList']['inherit'] ) ) {
2335                                 $cache['bookstoreList'] = array_merge( $cache['bookstoreList'], $secondary['bookstoreList'] );
2336                         }
2337                         if ( isset( $cache['bookstoreList']['inherit'] ) ) {
2338                                 unset( $cache['bookstoreList']['inherit'] );
2339                         }
2340                 }
2341
2342                 # Add dependencies to the cache entry
2343                 $cache['deps'] = $deps;
2344
2345                 # Replace spaces with underscores in namespace names
2346                 $cache['namespaceNames'] = str_replace( ' ', '_', $cache['namespaceNames'] );
2347
2348                 # And do the same for specialpage aliases. $page is an array.
2349                 foreach ( $cache['specialPageAliases'] as &$page ) {
2350                         $page = str_replace( ' ', '_', $page );
2351                 }
2352                 # Decouple the reference to prevent accidental damage
2353                 unset($page);
2354
2355                 # Save to both caches
2356                 self::$mLocalisationCache[$code] = $cache;
2357                 if ( !$disableCache ) {
2358                         $wgMemc->set( $memcKey, $cache );
2359                         $wgMemc->set( $fbMemcKey, (string) $cache['fallback'] );
2360                 }
2361
2362                 wfProfileOut( __METHOD__ );
2363                 return $deps;
2364         }
2365
2366         /**
2367          * Test if a given localisation cache is out of date with respect to the
2368          * source Messages files. This is done automatically for the global cache
2369          * in $wgMemc, but is only done on certain occasions for the serialized
2370          * data file.
2371          *
2372          * @param $cache mixed Either a language code or a cache array
2373          */
2374         static function isLocalisationOutOfDate( $cache ) {
2375                 if ( !is_array( $cache ) ) {
2376                         self::loadLocalisation( $cache );
2377                         $cache = self::$mLocalisationCache[$cache];
2378                 }
2379                 $expired = false;
2380                 foreach ( $cache['deps'] as $file => $mtime ) {
2381                         if ( !file_exists( $file ) || filemtime( $file ) > $mtime ) {
2382                                 $expired = true;
2383                                 break;
2384                         }
2385                 }
2386                 return $expired;
2387         }
2388
2389         /**
2390          * Get the fallback for a given language
2391          */
2392         static function getFallbackFor( $code ) {
2393                 // Shortcut
2394                 if ( $code === 'en' ) return false;
2395
2396                 // Local cache
2397                 static $cache = array();
2398                 // Quick return
2399                 if ( isset($cache[$code]) ) return $cache[$code];
2400
2401                 // Try memcache
2402                 global $wgMemc;
2403                 $memcKey = wfMemcKey( 'fallback', $code );
2404                 $fbcode = $wgMemc->get( $memcKey );
2405
2406                 if ( is_string($fbcode) ) {
2407                         // False is stored as a string to detect failures in memcache properly
2408                         if ( $fbcode === '' ) $fbcode = false;
2409
2410                         // Update local cache and return
2411                         $cache[$code] = $fbcode;
2412                         return $fbcode;
2413                 }
2414
2415                 // Nothing in caches, load and and update both caches
2416                 self::loadLocalisation( $code );
2417                 $fbcode = self::$mLocalisationCache[$code]['fallback'];
2418
2419                 $cache[$code] = $fbcode;
2420                 $wgMemc->set( $memcKey, (string) $fbcode );
2421
2422                 return $fbcode;
2423         }
2424
2425         /**
2426          * Get all messages for a given language
2427          */
2428         static function getMessagesFor( $code ) {
2429                 self::loadLocalisation( $code );
2430                 return self::$mLocalisationCache[$code]['messages'];
2431         }
2432
2433         /**
2434          * Get a message for a given language
2435          */
2436         static function getMessageFor( $key, $code ) {
2437                 self::loadLocalisation( $code );
2438                 return isset( self::$mLocalisationCache[$code]['messages'][$key] ) ? self::$mLocalisationCache[$code]['messages'][$key] : null;
2439         }
2440
2441         /**
2442          * Load localisation data for this object
2443          */
2444         function load() {
2445                 if ( !$this->mLoaded ) {
2446                         self::loadLocalisation( $this->getCode() );
2447                         $cache =& self::$mLocalisationCache[$this->getCode()];
2448                         foreach ( self::$mLocalisationKeys as $key ) {
2449                                 $this->$key = $cache[$key];
2450                         }
2451                         $this->mLoaded = true;
2452
2453                         $this->fixUpSettings();
2454                 }
2455         }
2456
2457         /**
2458          * Do any necessary post-cache-load settings adjustment
2459          */
2460         function fixUpSettings() {
2461                 global $wgExtraNamespaces, $wgMetaNamespace, $wgMetaNamespaceTalk,
2462                         $wgNamespaceAliases, $wgAmericanDates;
2463                 wfProfileIn( __METHOD__ );
2464                 if ( $wgExtraNamespaces ) {
2465                         $this->namespaceNames = $wgExtraNamespaces + $this->namespaceNames;
2466                 }
2467
2468                 $this->namespaceNames[NS_PROJECT] = $wgMetaNamespace;
2469                 if ( $wgMetaNamespaceTalk ) {
2470                         $this->namespaceNames[NS_PROJECT_TALK] = $wgMetaNamespaceTalk;
2471                 } else {
2472                         $talk = $this->namespaceNames[NS_PROJECT_TALK];
2473                         $talk = str_replace( '$1', $wgMetaNamespace, $talk );
2474
2475                         # Allow grammar transformations
2476                         # Allowing full message-style parsing would make simple requests
2477                         # such as action=raw much more expensive than they need to be.
2478                         # This will hopefully cover most cases.
2479                         $talk = preg_replace_callback( '/{{grammar:(.*?)\|(.*?)}}/i',
2480                                 array( &$this, 'replaceGrammarInNamespace' ), $talk );
2481                         $talk = str_replace( ' ', '_', $talk );
2482                         $this->namespaceNames[NS_PROJECT_TALK] = $talk;
2483                 }
2484
2485                 # The above mixing may leave namespaces out of canonical order.
2486                 # Re-order by namespace ID number...
2487                 ksort( $this->namespaceNames );
2488
2489                 # Put namespace names and aliases into a hashtable.
2490                 # If this is too slow, then we should arrange it so that it is done
2491                 # before caching. The catch is that at pre-cache time, the above
2492                 # class-specific fixup hasn't been done.
2493                 $this->mNamespaceIds = array();
2494                 foreach ( $this->namespaceNames as $index => $name ) {
2495                         $this->mNamespaceIds[$this->lc($name)] = $index;
2496                 }
2497                 if ( $this->namespaceAliases ) {
2498                         foreach ( $this->namespaceAliases as $name => $index ) {
2499                                 $this->mNamespaceIds[$this->lc($name)] = $index;
2500                         }
2501                 }
2502                 if ( $wgNamespaceAliases ) {
2503                         foreach ( $wgNamespaceAliases as $name => $index ) {
2504                                 $this->mNamespaceIds[$this->lc($name)] = $index;
2505                         }
2506                 }
2507
2508                 if ( $this->defaultDateFormat == 'dmy or mdy' ) {
2509                         $this->defaultDateFormat = $wgAmericanDates ? 'mdy' : 'dmy';
2510                 }
2511                 wfProfileOut( __METHOD__ );
2512         }
2513
2514         function replaceGrammarInNamespace( $m ) {
2515                 return $this->convertGrammar( trim( $m[2] ), trim( $m[1] ) );
2516         }
2517
2518         static function getCaseMaps() {
2519                 static $wikiUpperChars, $wikiLowerChars;
2520                 if ( isset( $wikiUpperChars ) ) {
2521                         return array( $wikiUpperChars, $wikiLowerChars );
2522                 }
2523
2524                 wfProfileIn( __METHOD__ );
2525                 $arr = wfGetPrecompiledData( 'Utf8Case.ser' );
2526                 if ( $arr === false ) {
2527                         throw new MWException(
2528                                 "Utf8Case.ser is missing, please run \"make\" in the serialized directory\n" );
2529                 }
2530                 extract( $arr );
2531                 wfProfileOut( __METHOD__ );
2532                 return array( $wikiUpperChars, $wikiLowerChars );
2533         }
2534
2535         function formatTimePeriod( $seconds ) {
2536                 if ( $seconds < 10 ) {
2537                         return $this->formatNum( sprintf( "%.1f", $seconds ) ) . wfMsg( 'seconds-abbrev' );
2538                 } elseif ( $seconds < 60 ) {
2539                         return $this->formatNum( round( $seconds ) ) . wfMsg( 'seconds-abbrev' );
2540                 } elseif ( $seconds < 3600 ) {
2541                         return $this->formatNum( floor( $seconds / 60 ) ) . wfMsg( 'minutes-abbrev' ) .
2542                                 $this->formatNum( round( fmod( $seconds, 60 ) ) ) . wfMsg( 'seconds-abbrev' );
2543                 } else {
2544                         $hours = floor( $seconds / 3600 );
2545                         $minutes = floor( ( $seconds - $hours * 3600 ) / 60 );
2546                         $secondsPart = round( $seconds - $hours * 3600 - $minutes * 60 );
2547                         return $this->formatNum( $hours ) . wfMsg( 'hours-abbrev' ) .
2548                                 $this->formatNum( $minutes ) . wfMsg( 'minutes-abbrev' ) .
2549                                 $this->formatNum( $secondsPart ) . wfMsg( 'seconds-abbrev' );
2550                 }
2551         }
2552
2553         function formatBitrate( $bps ) {
2554                 $units = array( 'bps', 'kbps', 'Mbps', 'Gbps' );
2555                 if ( $bps <= 0 ) {
2556                         return $this->formatNum( $bps ) . $units[0];
2557                 }
2558                 $unitIndex = floor( log10( $bps ) / 3 );
2559                 $mantissa = $bps / pow( 1000, $unitIndex );
2560                 if ( $mantissa < 10 ) {
2561                         $mantissa = round( $mantissa, 1 );
2562                 } else {
2563                         $mantissa = round( $mantissa );
2564                 }
2565                 return $this->formatNum( $mantissa ) . $units[$unitIndex];
2566         }
2567
2568         /**
2569          * Format a size in bytes for output, using an appropriate
2570          * unit (B, KB, MB or GB) according to the magnitude in question
2571          *
2572          * @param $size Size to format
2573          * @return string Plain text (not HTML)
2574          */
2575         function formatSize( $size ) {
2576                 // For small sizes no decimal places necessary
2577                 $round = 0;
2578                 if( $size > 1024 ) {
2579                         $size = $size / 1024;
2580                         if( $size > 1024 ) {
2581                                 $size = $size / 1024;
2582                                 // For MB and bigger two decimal places are smarter
2583                                 $round = 2;
2584                                 if( $size > 1024 ) {
2585                                         $size = $size / 1024;
2586                                         $msg = 'size-gigabytes';
2587                                 } else {
2588                                         $msg = 'size-megabytes';
2589                                 }
2590                         } else {
2591                                 $msg = 'size-kilobytes';
2592                         }
2593                 } else {
2594                         $msg = 'size-bytes';
2595                 }
2596                 $size = round( $size, $round );
2597                 $text = $this->getMessageFromDB( $msg );
2598                 return str_replace( '$1', $this->formatNum( $size ), $text );
2599         }
2600 }