Merge "document CASE (0th array element) for $magicWords"
[lhc/web/wiklou.git] / includes / LocalisationCache.php
index 591f973..9ce26d0 100644 (file)
@@ -1,4 +1,24 @@
 <?php
+/**
+ * Cache of the contents of localisation files.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
 
 define( 'MW_LC_VERSION', 2 );
 
@@ -163,12 +183,7 @@ class LocalisationCache {
                                        $storeClass = 'LCStore_Accel';
                                        break;
                                case 'detect':
-                                       try {
-                                               $c = wfGetCache( CACHE_ACCEL );
-                                               $storeClass = 'LCStore_Accel';
-                                       } catch( Exception $c ) {
-                                               $storeClass = $wgCacheDirectory ? 'LCStore_CDB' : 'LCStore_DB';
-                                       }
+                                       $storeClass = $wgCacheDirectory ? 'LCStore_CDB' : 'LCStore_DB';
                                        break;
                                default:
                                        throw new MWException(
@@ -196,14 +211,14 @@ class LocalisationCache {
         * @return bool
         */
        public function isMergeableKey( $key ) {
-               if ( !isset( $this->mergeableKeys ) ) {
+               if ( $this->mergeableKeys === null ) {
                        $this->mergeableKeys = array_flip( array_merge(
-                                       self::$mergeableMapKeys,
-                                       self::$mergeableListKeys,
-                                       self::$mergeableAliasListKeys,
-                                       self::$optionalMergeKeys,
-                                       self::$magicWordKeys
-                               ) );
+                               self::$mergeableMapKeys,
+                               self::$mergeableListKeys,
+                               self::$mergeableAliasListKeys,
+                               self::$optionalMergeKeys,
+                               self::$magicWordKeys
+                       ) );
                }
                return isset( $this->mergeableKeys[$key] );
        }
@@ -215,7 +230,7 @@ class LocalisationCache {
         * need to fetch all of the subitems from the cache individually.
         * @param $code
         * @param $key
-        * @return string
+        * @return mixed
         */
        public function getItem( $code, $key ) {
                if ( !isset( $this->loadedItems[$code][$key] ) ) {
@@ -348,6 +363,7 @@ class LocalisationCache {
 
        /**
         * Returns true if the cache identified by $code is missing or expired.
+        * @return bool
         */
        public function isExpired( $code ) {
                if ( $this->forceRecache && !isset( $this->recachedLangs[$code] ) ) {
@@ -357,8 +373,9 @@ class LocalisationCache {
 
                $deps = $this->store->get( $code, 'deps' );
                $keys = $this->store->get( $code, 'list', 'messages' );
-               // 'list:messages' sometimes expires separately of 'deps' in LCStore_Accel
-               if ( $deps === null || $keys === null ) {
+               $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;
                }
@@ -515,7 +532,7 @@ class LocalisationCache {
                                $oldSynonyms = array_slice( $fallbackInfo, 1 );
                                $newSynonyms = array_slice( $value[$magicName], 1 );
                                $synonyms = array_values( array_unique( array_merge(
-                                                       $newSynonyms, $oldSynonyms ) ) );
+                                       $newSynonyms, $oldSynonyms ) ) );
                                $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
                        }
                }
@@ -552,7 +569,7 @@ class LocalisationCache {
         * @param $code
         */
        public function recache( $code ) {
-               global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
+               global $wgExtensionMessagesFiles;
                wfProfileIn( __METHOD__ );
 
                if ( !$code ) {
@@ -647,22 +664,6 @@ 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 );
-                       }
-               }
-
                # Merge core data into extension data
                foreach ( $coreData as $key => $item ) {
                        $this->mergeItem( $key, $allData[$key], $item );
@@ -670,7 +671,6 @@ class LocalisationCache {
 
                # Add cache dependencies for any referenced globals
                $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
-               $deps['wgExtensionAliasesFiles'] = new GlobalDependency( 'wgExtensionAliasesFiles' );
                $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
 
                # Add dependencies to the cache entry
@@ -814,8 +814,8 @@ class LocalisationCache {
 interface LCStore {
        /**
         * Get a value.
-        * @param $code Language code
-        * @param $key Cache key
+        * @param $code string Language code
+        * @param $key string Cache key
         */
        function get( $code, $key );
 
@@ -841,7 +841,7 @@ interface LCStore {
 
 /**
  * LCStore implementation which uses PHP accelerator to store data.
- * This will work if one of XCache, eAccelerator, or APC cacher is configured.
+ * This will work if one of XCache, WinCache or APC cacher is configured.
  * (See ObjectCache.php)
  */
 class LCStore_Accel implements LCStore {
@@ -855,8 +855,7 @@ class LCStore_Accel implements LCStore {
        public function get( $code, $key ) {
                $k = wfMemcKey( 'l10n', $code, 'k', $key );
                $r = $this->cache->get( $k );
-               if ( $r === false ) return null;
-               return $r;
+               return $r === false ? null : $r;
        }
 
        public function startWrite( $code ) {
@@ -930,12 +929,12 @@ class LCStore_DB implements LCStore {
 
                $this->dbw = wfGetDB( DB_MASTER );
                try {
-                       $this->dbw->begin();
+                       $this->dbw->begin( __METHOD__ );
                        $this->dbw->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__ );
                } catch ( DBQueryError $e ) {
                        if ( $this->dbw->wasReadOnlyError() ) {
                                $this->readOnly = true;
-                               $this->dbw->rollback();
+                               $this->dbw->rollback( __METHOD__ );
                                $this->dbw->ignoreErrors( false );
                                return;
                        } else {
@@ -956,7 +955,7 @@ class LCStore_DB implements LCStore {
                        $this->dbw->insert( 'l10n_cache', $this->batch, __METHOD__ );
                }
 
-               $this->dbw->commit();
+               $this->dbw->commit( __METHOD__ );
                $this->currentLang = null;
                $this->dbw = null;
                $this->batch = array();
@@ -1137,7 +1136,7 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
        /**
         * @param $code
         * @param $key
-        * @return string
+        * @return mixed
         */
        public function getItem( $code, $key ) {
                unset( $this->mruLangs[$code] );
@@ -1186,4 +1185,4 @@ class LocalisationCache_BulkLoad extends LocalisationCache {
                        $this->unload( $code );
                }
        }
-}
\ No newline at end of file
+}