Add support for Number grouping(commafy) based on CLDR number grouping patterns like...
[lhc/web/wiklou.git] / includes / LocalisationCache.php
index 36867c8..361cfa7 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 
-define( 'MW_LC_VERSION', 1 );
+define( 'MW_LC_VERSION', 2 );
 
 /**
  * Class for caching the contents of localisation files, Messages*.php
@@ -84,10 +84,11 @@ class LocalisationCache {
                'fallback', 'namespaceNames', 'bookstoreList',
                'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
                'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
-               'defaultUserOptionOverrides', 'linkTrail', 'namespaceAliases',
+               'linkTrail', 'namespaceAliases',
                'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
                'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
                'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
+               'digitGroupingPattern'
        );
 
        /**
@@ -95,8 +96,7 @@ class LocalisationCache {
         * by a fallback sequence.
         */
        static public $mergeableMapKeys = array( 'messages', 'namespaceNames',
-               'dateFormats', 'defaultUserOptionOverrides', 'imageFiles',
-               'preloadedMessages',
+               'dateFormats', 'imageFiles', 'preloadedMessages',
        );
 
        /**
@@ -130,13 +130,14 @@ class LocalisationCache {
        /**
         * Keys which are loaded automatically by initLanguage()
         */
-       static public $preloadedKeys = array( 'dateFormats', 'namespaceNames',
-               'defaultUserOptionOverrides' );
+       static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
 
        /**
         * Constructor.
         * For constructor parameters, see the documentation in DefaultSettings.php
         * for $wgLocalisationCacheConf.
+        *
+        * @param $conf Array
         */
        function __construct( $conf ) {
                global $wgCacheDirectory;
@@ -205,9 +206,11 @@ class LocalisationCache {
                        $this->loadItem( $code, $key );
                        wfProfileOut( __METHOD__.'-load' );
                }
+
                if ( $key === 'fallback' && isset( $this->shallowFallbacks[$code] ) ) {
                        return $this->shallowFallbacks[$code];
                }
+
                return $this->data[$code][$key];
        }
 
@@ -222,6 +225,7 @@ class LocalisationCache {
                        $this->loadSubitem( $code, $key, $subkey );
                        wfProfileOut( __METHOD__.'-load' );
                }
+
                if ( isset( $this->data[$code][$key][$subkey] ) ) {
                        return $this->data[$code][$key][$subkey];
                } else {
@@ -258,14 +262,17 @@ class LocalisationCache {
                if ( !isset( $this->initialisedLangs[$code] ) ) {
                        $this->initLanguage( $code );
                }
+
                // Check to see if initLanguage() loaded it for us
                if ( isset( $this->loadedItems[$code][$key] ) ) {
                        return;
                }
+
                if ( isset( $this->shallowFallbacks[$code] ) ) {
                        $this->loadItem( $this->shallowFallbacks[$code], $key );
                        return;
                }
+
                if ( in_array( $key, self::$splitKeys ) ) {
                        $subkeyList = $this->getSubitem( $code, 'list', $key );
                        foreach ( $subkeyList as $subkey ) {
@@ -277,6 +284,7 @@ class LocalisationCache {
                } else {
                        $this->data[$code][$key] = $this->store->get( $code, $key );
                }
+
                $this->loadedItems[$code][$key] = true;
        }
 
@@ -288,19 +296,23 @@ class LocalisationCache {
                        $this->loadItem( $code, $key );
                        return;
                }
+
                if ( !isset( $this->initialisedLangs[$code] ) ) {
                        $this->initLanguage( $code );
                }
+
                // Check to see if initLanguage() loaded it for us
                if ( isset( $this->loadedItems[$code][$key] )
                        || isset( $this->loadedSubitems[$code][$key][$subkey] ) )
                {
                        return;
                }
+
                if ( isset( $this->shallowFallbacks[$code] ) ) {
                        $this->loadSubitem( $this->shallowFallbacks[$code], $key, $subkey );
                        return;
                }
+
                $value = $this->store->get( $code, "$key:$subkey" );
                $this->data[$code][$key][$subkey] = $value;
                $this->loadedSubitems[$code][$key][$subkey] = true;
@@ -320,6 +332,7 @@ class LocalisationCache {
                        wfDebug( __METHOD__."($code): cache missing, need to make one\n" );
                        return true;
                }
+
                foreach ( $deps as $dep ) {
                        // Because we're unserializing stuff from cache, we
                        // could receive objects of classes that don't exist
@@ -331,6 +344,7 @@ class LocalisationCache {
                                return true;
                        }
                }
+
                return false;
        }
 
@@ -341,6 +355,7 @@ class LocalisationCache {
                if ( isset( $this->initialisedLangs[$code] ) ) {
                        return;
                }
+
                $this->initialisedLangs[$code] = true;
 
                # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
@@ -415,6 +430,7 @@ class LocalisationCache {
                } else {
                        throw new MWException( __METHOD__.": Invalid file type: $_fileType" );
                }
+
                return $data;
        }
 
@@ -435,6 +451,7 @@ class LocalisationCache {
                                        if ( !empty( $value['inherit'] ) )  {
                                                $value = array_merge( $fallbackValue, $value );
                                        }
+
                                        if ( isset( $value['inherit'] ) ) {
                                                unset( $value['inherit'] );
                                        }
@@ -477,6 +494,7 @@ class LocalisationCache {
                                $used = true;
                        }
                }
+
                return $used;
        }
 
@@ -485,7 +503,6 @@ class LocalisationCache {
         * and save it to the persistent cache store and the process cache
         */
        public function recache( $code ) {
-               static $recursionGuard = array();
                global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
                wfProfileIn( __METHOD__ );
 
@@ -515,6 +532,7 @@ class LocalisationCache {
                        foreach ( $data as $key => $value ) {
                                $this->mergeItem( $key, $coreData[$key], $value );
                        }
+
                }
 
                # Fill in the fallback if it's not there already
@@ -522,28 +540,42 @@ class LocalisationCache {
                        $coreData['fallback'] = $code === 'en' ? false : 'en';
                }
 
-               if ( $coreData['fallback'] !== false ) {
-                       # Guard against circular references
-                       if ( isset( $recursionGuard[$code] ) ) {
-                               throw new MWException( "Error: Circular fallback reference in language code $code" );
+               if ( $coreData['fallback'] === false ) {
+                       $coreData['fallbackSequence'] = array();
+               } else {
+                       $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
+                       $len = count( $coreData['fallbackSequence'] );
+
+                       # Ensure that the sequence ends at en
+                       if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
+                               $coreData['fallbackSequence'][] = 'en';
                        }
-                       $recursionGuard[$code] = true;
 
                        # Load the fallback localisation item by item and merge it
-                       $deps = array_merge( $deps, $this->getItem( $coreData['fallback'], 'deps' ) );
-                       foreach ( self::$allKeys as $key ) {
-                               if ( is_null( $coreData[$key] ) || $this->isMergeableKey( $key ) ) {
-                                       $fallbackValue = $this->getItem( $coreData['fallback'], $key );
-                                       $this->mergeItem( $key, $coreData[$key], $fallbackValue );
+                       foreach ( $coreData['fallbackSequence'] as $fbCode ) {
+                               # Load the secondary localisation from the source file to
+                               # avoid infinite cycles on cyclic fallbacks
+                               $fbFilename = Language::getMessagesFileName( $fbCode );
+
+                               if ( !file_exists( $fbFilename ) ) {
+                                       continue;
+                               }
+
+                               $deps[] = new FileDependency( $fbFilename );
+                               $fbData = $this->readPHPFile( $fbFilename, 'core' );
+
+                               foreach ( self::$allKeys as $key ) {
+                                       if ( !isset( $fbData[$key] ) ) {
+                                               continue;
+                                       }
+
+                                       if ( is_null( $coreData[$key] ) || $this->isMergeableKey( $key ) ) {
+                                               $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
+                                       }
                                }
                        }
-                       $fallbackSequence = $this->getItem( $coreData['fallback'], 'fallbackSequence' );
-                       array_unshift( $fallbackSequence, $coreData['fallback'] );
-                       $coreData['fallbackSequence'] = $fallbackSequence;
-                       unset( $recursionGuard[$code] );
-               } else {
-                       $coreData['fallbackSequence'] = array();
                }
+
                $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
 
                # Load the extension localisations
@@ -554,11 +586,13 @@ class LocalisationCache {
                foreach ( $wgExtensionMessagesFiles as $fileName ) {
                        $data = $this->readPHPFile( $fileName, 'extension' );
                        $used = false;
+
                        foreach ( $data as $key => $item ) {
                                if( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
                                        $used = true;
                                }
                        }
+
                        if ( $used ) {
                                $deps[] = new FileDependency( $fileName );
                        }
@@ -567,11 +601,14 @@ class LocalisationCache {
                # Load deprecated $wgExtensionAliasesFiles
                foreach ( $wgExtensionAliasesFiles as $fileName ) {
                        $data = $this->readPHPFile( $fileName, 'aliases' );
+
                        if ( !isset( $data['aliases'] ) ) {
                                continue;
                        }
+
                        $used = $this->mergeExtensionItem( $codeSequence, 'specialPageAliases',
                                $allData['specialPageAliases'], $data['aliases'] );
+
                        if ( $used ) {
                                $deps[] = new FileDependency( $fileName );
                        }
@@ -600,11 +637,6 @@ class LocalisationCache {
                # Decouple the reference to prevent accidental damage
                unset($page);
 
-               # Fix broken defaultUserOptionOverrides
-               if ( !is_array( $allData['defaultUserOptionOverrides'] ) ) {
-                       $allData['defaultUserOptionOverrides'] = array();
-               }
-
                # Set the list keys
                $allData['list'] = array();
                foreach ( self::$splitKeys as $key ) {
@@ -614,7 +646,7 @@ class LocalisationCache {
                # Run hooks
                wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
 
-               if ( is_null( $allData['defaultUserOptionOverrides'] ) ) {
+               if ( is_null( $allData['namespaceNames'] ) ) {
                        throw new MWException( __METHOD__.': Localisation data failed sanity check! ' .
                                'Check that your languages/messages/MessagesEn.php file is intact.' );
                }
@@ -662,6 +694,7 @@ class LocalisationCache {
                foreach ( self::$preloadedKeys as $key ) {
                        $preload[$key] = $data[$key];
                }
+
                foreach ( $data['preloadedMessages'] as $subkey ) {
                        if ( isset( $data['messages'][$subkey] ) ) {
                                $subitem = $data['messages'][$subkey];
@@ -670,6 +703,7 @@ class LocalisationCache {
                        }
                        $preload['messages'][$subkey] = $subitem;
                }
+
                return $preload;
        }
 
@@ -682,6 +716,7 @@ class LocalisationCache {
                unset( $this->loadedItems[$code] );
                unset( $this->loadedSubitems[$code] );
                unset( $this->initialisedLangs[$code] );
+
                foreach ( $this->shallowFallbacks as $shallowCode => $fbCode ) {
                        if ( $fbCode === $code ) {
                                $this->unload( $shallowCode );
@@ -748,7 +783,6 @@ interface LCStore {
         * is called, and finishWrite() must be called afterwards.
         */
        function set( $key, $value );
-
 }
 
 /**
@@ -780,9 +814,11 @@ class LCStore_DB implements LCStore {
                if ( $this->readOnly ) {
                        return;
                }
+
                if ( !$code ) {
                        throw new MWException( __METHOD__.": Invalid language \"$code\"" );
                }
+
                $this->dbw = wfGetDB( DB_MASTER );
                try {
                        $this->dbw->begin();
@@ -797,6 +833,7 @@ class LCStore_DB implements LCStore {
                                throw $e;
                        }
                }
+
                $this->currentLang = $code;
                $this->batch = array();
        }
@@ -805,9 +842,11 @@ class LCStore_DB implements LCStore {
                if ( $this->readOnly ) {
                        return;
                }
+
                if ( $this->batch ) {
                        $this->dbw->insert( 'l10n_cache', $this->batch, __METHOD__ );
                }
+
                $this->dbw->commit();
                $this->currentLang = null;
                $this->dbw = null;
@@ -819,13 +858,16 @@ class LCStore_DB implements LCStore {
                if ( $this->readOnly ) {
                        return;
                }
+
                if ( is_null( $this->currentLang ) ) {
                        throw new MWException( __CLASS__.': must call startWrite() before calling set()' );
                }
+
                $this->batch[] = array(
                        'lc_lang' => $this->currentLang,
                        'lc_key' => $key,
                        'lc_value' => serialize( $value ) );
+
                if ( count( $this->batch ) >= 100 ) {
                        $this->dbw->insert( 'l10n_cache', $this->batch, __METHOD__ );
                        $this->batch = array();
@@ -850,6 +892,7 @@ class LCStore_CDB implements LCStore {
 
        function __construct( $conf = array() ) {
                global $wgCacheDirectory;
+
                if ( isset( $conf['directory'] ) ) {
                        $this->directory = $conf['directory'];
                } else {
@@ -860,16 +903,19 @@ class LCStore_CDB implements LCStore {
        public function get( $code, $key ) {
                if ( !isset( $this->readers[$code] ) ) {
                        $fileName = $this->getFileName( $code );
+
                        if ( !file_exists( $fileName ) ) {
                                $this->readers[$code] = false;
                        } else {
                                $this->readers[$code] = CdbReader::open( $fileName );
                        }
                }
+
                if ( !$this->readers[$code] ) {
                        return null;
                } else {
                        $value = $this->readers[$code]->get( $key );
+
                        if ( $value === false ) {
                                return null;
                        }
@@ -879,15 +925,17 @@ class LCStore_CDB implements LCStore {
 
        public function startWrite( $code ) {
                if ( !file_exists( $this->directory ) ) {
-                       if ( !wfMkdirParents( $this->directory ) ) {
+                       if ( !wfMkdirParents( $this->directory, null, __METHOD__ ) ) {
                                throw new MWException( "Unable to create the localisation store " .
                                        "directory \"{$this->directory}\"" );
                        }
                }
+
                // Close reader to stop permission errors on write
                if( !empty($this->readers[$code]) ) {
                        $this->readers[$code]->close();
                }
+
                $this->writer = CdbWriter::open( $this->getFileName( $code ) );
                $this->currentLang = $code;
        }
@@ -955,12 +1003,15 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                $serialize = $fileType === 'core';
                if ( !isset( $this->fileCache[$fileName][$fileType] ) ) {
                        $data = parent::readPHPFile( $fileName, $fileType );
+
                        if ( $serialize ) {
                                $encData = serialize( $data );
                        } else {
                                $encData = $data;
                        }
+
                        $this->fileCache[$fileName][$fileType] = $encData;
+
                        return $data;
                } elseif ( $serialize ) {
                        return unserialize( $this->fileCache[$fileName][$fileType] );