Followup r102785: fix typo in index name. Thanks to Platonides and his special page...
[lhc/web/wiklou.git] / includes / LocalisationCache.php
index b20db32..ad707dc 100644 (file)
@@ -40,6 +40,8 @@ class LocalisationCache {
 
        /**
         * The persistent store object. An instance of LCStore.
+        *
+        * @var LCStore
         */
        var $store;
 
@@ -88,6 +90,7 @@ class LocalisationCache {
                'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
                'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
                'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
+               'digitGroupingPattern'
        );
 
        /**
@@ -131,6 +134,8 @@ class LocalisationCache {
         */
        static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
 
+       var $mergeableKeys = null;
+
        /**
         * Constructor.
         * For constructor parameters, see the documentation in DefaultSettings.php
@@ -154,8 +159,16 @@ class LocalisationCache {
                                case 'db':
                                        $storeClass = 'LCStore_DB';
                                        break;
+                               case 'accel':
+                                       $storeClass = 'LCStore_Accel';
+                                       break;
                                case 'detect':
-                                       $storeClass = $wgCacheDirectory ? 'LCStore_CDB' : 'LCStore_DB';
+                                       try {
+                                               $c = wfGetCache( CACHE_ACCEL );
+                                               $storeClass = 'LCStore_Accel';
+                                       } catch( Exception $c ) {
+                                               $storeClass = $wgCacheDirectory ? 'LCStore_CDB' : 'LCStore_DB';
+                                       }
                                        break;
                                default:
                                        throw new MWException(
@@ -179,9 +192,11 @@ class LocalisationCache {
        /**
         * Returns true if the given key is mergeable, that is, if it is an associative
         * array which can be merged through a fallback sequence.
+        * @param $key
+        * @return bool
         */
        public function isMergeableKey( $key ) {
-               if ( !isset( $this->mergeableKeys ) ) {
+               if ( $this->mergeableKeys === null ) {
                        $this->mergeableKeys = array_flip( array_merge(
                                self::$mergeableMapKeys,
                                self::$mergeableListKeys,
@@ -198,6 +213,9 @@ class LocalisationCache {
         *
         * Warning: this may be slow for split items (messages), since it will
         * need to fetch all of the subitems from the cache individually.
+        * @param $code
+        * @param $key
+        * @return mixed
         */
        public function getItem( $code, $key ) {
                if ( !isset( $this->loadedItems[$code][$key] ) ) {
@@ -205,23 +223,29 @@ 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];
        }
 
        /**
         * Get a subitem, for instance a single message for a given language.
+        * @param $code
+        * @param $key
+        * @param $subkey
+        * @return null
         */
        public function getSubitem( $code, $key, $subkey ) {
-               if ( !isset( $this->loadedSubitems[$code][$key][$subkey] )
-                       && !isset( $this->loadedItems[$code][$key] ) )
-               {
+               if ( !isset( $this->loadedSubitems[$code][$key][$subkey] ) &&
+                        !isset( $this->loadedItems[$code][$key] ) ) {
                        wfProfileIn( __METHOD__.'-load' );
                        $this->loadSubitem( $code, $key, $subkey );
                        wfProfileOut( __METHOD__.'-load' );
                }
+
                if ( isset( $this->data[$code][$key][$subkey] ) ) {
                        return $this->data[$code][$key][$subkey];
                } else {
@@ -237,6 +261,9 @@ class LocalisationCache {
         *
         * Will return null if the item is not found, or false if the item is not an
         * array.
+        * @param $code
+        * @param $key
+        * @return bool|null|string
         */
        public function getSubitemList( $code, $key ) {
                if ( in_array( $key, self::$splitKeys ) ) {
@@ -253,19 +280,24 @@ class LocalisationCache {
 
        /**
         * Load an item into the cache.
+        * @param $code
+        * @param $key
         */
        protected function loadItem( $code, $key ) {
                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,30 +309,38 @@ class LocalisationCache {
                } else {
                        $this->data[$code][$key] = $this->store->get( $code, $key );
                }
+
                $this->loadedItems[$code][$key] = true;
        }
 
        /**
         * Load a subitem into the cache
+        * @param $code
+        * @param $key
+        * @param $subkey
+        * @return
         */
        protected function loadSubitem( $code, $key, $subkey ) {
                if ( !in_array( $key, self::$splitKeys ) ) {
                        $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] ) )
-               {
+               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;
@@ -316,10 +356,14 @@ class LocalisationCache {
                }
 
                $deps = $this->store->get( $code, 'deps' );
-               if ( $deps === null ) {
+               $keys = $this->store->get( $code, 'list', 'messages' );
+               $preload = $this->store->get( $code, 'preload' );
+               // Different keys may expire separately, at least in LCStore_Accel
+               if ( $deps === null || $keys === null || $preload === null ) {
                        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,16 +375,19 @@ class LocalisationCache {
                                return true;
                        }
                }
+
                return false;
        }
 
        /**
         * Initialise a language in this object. Rebuild the cache if necessary.
+        * @param $code
         */
        protected function initLanguage( $code ) {
                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
@@ -391,6 +438,8 @@ class LocalisationCache {
        /**
         * Create a fallback from one language to another, without creating a
         * complete persistent cache.
+        * @param $primaryCode
+        * @param $fallbackCode
         */
        public function initShallowFallback( $primaryCode, $fallbackCode ) {
                $this->data[$primaryCode] =& $this->data[$fallbackCode];
@@ -401,6 +450,9 @@ class LocalisationCache {
 
        /**
         * Read a PHP file containing localisation data.
+        * @param $_fileName
+        * @param $_fileType
+        * @return array
         */
        protected function readPHPFile( $_fileName, $_fileType ) {
                // Disable APC caching
@@ -415,12 +467,16 @@ class LocalisationCache {
                } else {
                        throw new MWException( __METHOD__.": Invalid file type: $_fileType" );
                }
+
                return $data;
        }
 
        /**
         * Merge two localisation values, a primary and a fallback, overwriting the
         * primary value in place.
+        * @param $key
+        * @param $value
+        * @param $fallbackValue
         */
        protected function mergeItem( $key, &$value, $fallbackValue ) {
                if ( !is_null( $value ) ) {
@@ -435,6 +491,7 @@ class LocalisationCache {
                                        if ( !empty( $value['inherit'] ) )  {
                                                $value = array_merge( $fallbackValue, $value );
                                        }
+
                                        if ( isset( $value['inherit'] ) ) {
                                                unset( $value['inherit'] );
                                        }
@@ -447,6 +504,10 @@ class LocalisationCache {
                }
        }
 
+       /**
+        * @param $value
+        * @param $fallbackValue
+        */
        protected function mergeMagicWords( &$value, $fallbackValue ) {
                foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
                        if ( !isset( $value[$magicName] ) ) {
@@ -468,6 +529,11 @@ class LocalisationCache {
         *
         * Returns true if any data from the extension array was used, false
         * otherwise.
+        * @param $codeSequence
+        * @param $key
+        * @param $value
+        * @param $fallbackValue
+        * @return bool
         */
        protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
                $used = false;
@@ -477,12 +543,14 @@ class LocalisationCache {
                                $used = true;
                        }
                }
+
                return $used;
        }
 
        /**
         * Load localisation data for a given language for both core and extensions
         * and save it to the persistent cache store and the process cache
+        * @param $code
         */
        public function recache( $code ) {
                global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
@@ -514,6 +582,7 @@ class LocalisationCache {
                        foreach ( $data as $key => $value ) {
                                $this->mergeItem( $key, $coreData[$key], $value );
                        }
+
                }
 
                # Fill in the fallback if it's not there already
@@ -526,23 +595,37 @@ class LocalisationCache {
                } 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';
                        }
 
                        # Load the fallback localisation item by item and merge it
-                       foreach ( $coreData['fallbackSequence'] as $fallback ) {
-                               $deps = array_merge( $deps, $this->getItem( $fallback, 'deps' ) );
+                       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 ) ) {
-                                               $fallbackValue = $this->getItem( $fallback, $key );
-                                               $this->mergeItem( $key, $coreData[$key], $fallbackValue );
+                                               $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
                                        }
                                }
                        }
-                       
                }
+
                $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
 
                # Load the extension localisations
@@ -553,11 +636,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 );
                        }
@@ -566,11 +651,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 );
                        }
@@ -608,6 +696,11 @@ class LocalisationCache {
                # Run hooks
                wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
 
+               if ( is_null( $allData['namespaceNames'] ) ) {
+                       throw new MWException( __METHOD__.': Localisation data failed sanity check! ' .
+                               'Check that your languages/messages/MessagesEn.php file is intact.' );
+               }
+
                # Set the preload key
                $allData['preload'] = $this->buildPreload( $allData );
 
@@ -645,12 +738,15 @@ class LocalisationCache {
         *
         * The preload item will be loaded automatically, improving performance
         * for the commonly-requested items it contains.
+        * @param $data
+        * @return array
         */
        protected function buildPreload( $data ) {
                $preload = array( 'messages' => array() );
                foreach ( self::$preloadedKeys as $key ) {
                        $preload[$key] = $data[$key];
                }
+
                foreach ( $data['preloadedMessages'] as $subkey ) {
                        if ( isset( $data['messages'][$subkey] ) ) {
                                $subitem = $data['messages'][$subkey];
@@ -659,18 +755,21 @@ class LocalisationCache {
                        }
                        $preload['messages'][$subkey] = $subitem;
                }
+
                return $preload;
        }
 
        /**
         * Unload the data for a given language from the object cache.
         * Reduces memory usage.
+        * @param $code
         */
        public function unload( $code ) {
                unset( $this->data[$code] );
                unset( $this->loadedItems[$code] );
                unset( $this->loadedSubitems[$code] );
                unset( $this->initialisedLangs[$code] );
+
                foreach ( $this->shallowFallbacks as $shallowCode => $fbCode ) {
                        if ( $fbCode === $code ) {
                                $this->unload( $shallowCode );
@@ -735,9 +834,59 @@ interface LCStore {
        /**
         * Set a key to a given value. startWrite() must be called before this
         * is called, and finishWrite() must be called afterwards.
+        * @param $key
+        * @param $value
         */
        function set( $key, $value );
+}
+
+/**
+ * LCStore implementation which uses PHP accelerator to store data.
+ * This will work if one of XCache, eAccelerator, or APC cacher is configured.
+ * (See ObjectCache.php)
+ */
+class LCStore_Accel implements LCStore {
+       var $currentLang;
+       var $keys;
+
+       public function __construct() {
+               $this->cache = wfGetCache( CACHE_ACCEL );
+       }
+
+       public function get( $code, $key ) {
+               $k = wfMemcKey( 'l10n', $code, 'k', $key );
+               $r = $this->cache->get( $k );
+               return $r === false ? null : $r;
+       }
 
+       public function startWrite( $code ) {
+               $k = wfMemcKey( 'l10n', $code, 'l' );
+               $keys = $this->cache->get( $k );
+               if ( $keys ) {
+                       foreach ( $keys as $k ) {
+                               $this->cache->delete( $k );
+                       }
+               }
+               $this->currentLang = $code;
+               $this->keys = array();
+       }
+
+       public function finishWrite() {
+               if ( $this->currentLang ) {
+                       $k = wfMemcKey( 'l10n', $this->currentLang, 'l' );
+                       $this->cache->set( $k, array_keys( $this->keys ) );
+               }
+               $this->currentLang = null;
+               $this->keys = array();
+       }
+
+       public function set( $key, $value ) {
+               if ( $this->currentLang ) {
+                       $k = wfMemcKey( 'l10n', $this->currentLang, 'k', $key );
+                       $this->keys[$k] = true;
+                       $this->cache->set( $k, $value );
+               }
+       }
 }
 
 /**
@@ -747,7 +896,12 @@ interface LCStore {
 class LCStore_DB implements LCStore {
        var $currentLang;
        var $writesDone = false;
-       var $dbw, $batch;
+
+       /**
+        * @var DatabaseBase
+        */
+       var $dbw;
+       var $batch;
        var $readOnly = false;
 
        public function get( $code, $key ) {
@@ -769,9 +923,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();
@@ -786,6 +942,7 @@ class LCStore_DB implements LCStore {
                                throw $e;
                        }
                }
+
                $this->currentLang = $code;
                $this->batch = array();
        }
@@ -794,9 +951,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;
@@ -808,13 +967,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();
@@ -839,6 +1001,7 @@ class LCStore_CDB implements LCStore {
 
        function __construct( $conf = array() ) {
                global $wgCacheDirectory;
+
                if ( isset( $conf['directory'] ) ) {
                        $this->directory = $conf['directory'];
                } else {
@@ -849,16 +1012,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;
                        }
@@ -873,10 +1039,12 @@ class LCStore_CDB implements LCStore {
                                        "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;
        }
@@ -940,16 +1108,24 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
         */
        var $maxLoadedLangs = 10;
 
+       /**
+        * @param $fileName
+        * @param $fileType
+        * @return array|mixed
+        */
        protected function readPHPFile( $fileName, $fileType ) {
                $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] );
@@ -958,18 +1134,32 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                }
        }
 
+       /**
+        * @param $code
+        * @param $key
+        * @return mixed
+        */
        public function getItem( $code, $key ) {
                unset( $this->mruLangs[$code] );
                $this->mruLangs[$code] = true;
                return parent::getItem( $code, $key );
        }
 
+       /**
+        * @param $code
+        * @param $key
+        * @param $subkey
+        * @return
+        */
        public function getSubitem( $code, $key, $subkey ) {
                unset( $this->mruLangs[$code] );
                $this->mruLangs[$code] = true;
                return parent::getSubitem( $code, $key, $subkey );
        }
 
+       /**
+        * @param $code
+        */
        public function recache( $code ) {
                parent::recache( $code );
                unset( $this->mruLangs[$code] );
@@ -977,6 +1167,9 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                $this->trimCache();
        }
 
+       /**
+        * @param $code
+        */
        public function unload( $code ) {
                unset( $this->mruLangs[$code] );
                parent::unload( $code );
@@ -993,4 +1186,4 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                        $this->unload( $code );
                }
        }
-}
+}
\ No newline at end of file