Add new message keys to go with r105954
[lhc/web/wiklou.git] / maintenance / language / languages.inc
index 66ebf82..06102ac 100644 (file)
@@ -2,6 +2,21 @@
 /**
  * Handle messages in the language 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
  * @ingroup MaintenanceLanguage
  */
@@ -14,13 +29,13 @@ class languages {
 
        protected $mRawMessages; # Raw list of the messages in each language
        protected $mMessages; # Messages in each language (except for English), divided to groups
+       protected $mFallback; # Fallback language in each language
        protected $mGeneralMessages; # General messages in English, divided to groups
        protected $mIgnoredMessages; # All the messages which should be exist only in the English file
        protected $mOptionalMessages; # All the messages which may be translated or not, depending on the language
 
        protected $mNamespaceNames; # Namespace names
        protected $mNamespaceAliases; # Namespace aliases
-       protected $mSkinNames; # Skin names
        protected $mMagicWords; # Magic words
        protected $mSpecialPageAliases; # Special page aliases
 
@@ -46,7 +61,7 @@ class languages {
        /**
         * Get the language list.
         *
-        * @return The language list.
+        * @return array The language list.
         */
        public function getLanguages() {
                return $this->mLanguages;
@@ -55,7 +70,7 @@ class languages {
        /**
         * Get the ignored messages list.
         *
-        * @return The ignored messages list.
+        * @return array The ignored messages list.
         */
        public function getIgnoredMessages() {
                return $this->mIgnoredMessages;
@@ -64,7 +79,7 @@ class languages {
        /**
         * Get the optional messages list.
         *
-        * @return The optional messages list.
+        * @return array The  optional messages list.
         */
        public function getOptionalMessages() {
                return $this->mOptionalMessages;
@@ -73,21 +88,21 @@ class languages {
        /**
         * Load the language file.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         */
        protected function loadFile( $code ) {
                if ( isset( $this->mRawMessages[$code] ) &&
+                       isset( $this->mFallback[$code] ) &&
                        isset( $this->mNamespaceNames[$code] ) &&
                        isset( $this->mNamespaceAliases[$code] ) &&
-                       isset( $this->mSkinNames[$code] ) &&
                        isset( $this->mMagicWords[$code] ) &&
                        isset( $this->mSpecialPageAliases[$code] ) ) {
                        return;
                }
                $this->mRawMessages[$code] = array();
+               $this->mFallback[$code] = '';
                $this->mNamespaceNames[$code] = array();
                $this->mNamespaceAliases[$code] = array();
-               $this->mSkinNames[$code] = array();
                $this->mMagicWords[$code] = array();
                $this->mSpecialPageAliases[$code] = array();
                $filename = Language::getMessagesFileName( $code );
@@ -96,15 +111,15 @@ class languages {
                        if ( isset( $messages ) ) {
                                $this->mRawMessages[$code] = $messages;
                        }
+                       if ( isset( $fallback ) ) {
+                               $this->mFallback[$code] = $fallback;
+                       }
                        if ( isset( $namespaceNames ) ) {
                                $this->mNamespaceNames[$code] = $namespaceNames;
                        }
                        if ( isset( $namespaceAliases ) ) {
                                $this->mNamespaceAliases[$code] = $namespaceAliases;
                        }
-                       if ( isset( $skinNames ) ) {
-                               $this->mSkinNames[$code] = $skinNames;
-                       }
                        if ( isset( $magicWords ) ) {
                                $this->mMagicWords[$code] = $magicWords;
                        }
@@ -122,7 +137,7 @@ class languages {
         * obsolete - messages which should not be translated, either because they do not exist, or they are ignored messages.
         * translated - messages which are either required or optional, but translated from English and needed.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         */
        private function loadMessages( $code ) {
                if ( isset( $this->mMessages[$code] ) ) {
@@ -188,9 +203,9 @@ class languages {
         * obsolete - messages which should not be translated, either because they do not exist, or they are ignored messages.
         * translated - messages which are either required or optional, but translated from English and needed.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages in this language.
+        * @return string The messages in this language.
         */
        public function getMessages( $code ) {
                $this->loadMessages( $code );
@@ -205,17 +220,29 @@ class languages {
         * ignored - messages which should not be translated to other languages.
         * translatable - messages which are either required or optional, but can be translated from English.
         *
-        * @return The general English messages.
+        * @return array The general English messages.
         */
        public function getGeneralMessages() {
                $this->loadGeneralMessages();
                return $this->mGeneralMessages;
        }
 
+       /**
+        * Get fallback language code for a specific language.
+        *
+        * @param $code string The language code.
+        *
+        * @return string Fallback code.
+        */
+       public function getFallback( $code ) {
+               $this->loadFile( $code );
+               return $this->mFallback[$code];
+       }
+
        /**
         * Get namespace names for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
         * @return Namespace names.
         */
@@ -227,7 +254,7 @@ class languages {
        /**
         * Get namespace aliases for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
         * @return Namespace aliases.
         */
@@ -236,22 +263,10 @@ class languages {
                return $this->mNamespaceAliases[$code];
        }
 
-       /**
-        * Get skin names for a specific language.
-        *
-        * @param $code The language code.
-        *
-        * @return Skin names.
-        */
-       public function getSkinNames( $code ) {
-               $this->loadFile( $code );
-               return $this->mSkinNames[$code];
-       }
-
        /**
         * Get magic words for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
         * @return Magic words.
         */
@@ -263,7 +278,7 @@ class languages {
        /**
         * Get special page aliases for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
         * @return Special page aliases.
         */
@@ -275,9 +290,9 @@ class languages {
        /**
         * Get the untranslated messages for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated messages for this language.
+        * @return array The untranslated messages for this language.
         */
        public function getUntranslatedMessages( $code ) {
                $this->loadGeneralMessages();
@@ -288,9 +303,9 @@ class languages {
        /**
         * Get the duplicate messages for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The duplicate messages for this language.
+        * @return array The duplicate messages for this language.
         */
        public function getDuplicateMessages( $code ) {
                $this->loadGeneralMessages();
@@ -307,9 +322,9 @@ class languages {
        /**
         * Get the obsolete messages for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The obsolete messages for this language.
+        * @return array The obsolete messages for this language.
         */
        public function getObsoleteMessages( $code ) {
                $this->loadGeneralMessages();
@@ -318,17 +333,17 @@ class languages {
        }
 
        /**
-        * Get the messages which do not use some variables.
+        * Get the messages whose variables do not match the original ones.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages which do not use some variables in this language.
+        * @return array The messages whose variables do not match the original ones.
         */
-       public function getMessagesWithoutVariables( $code ) {
+       public function getMessagesWithMismatchVariables( $code ) {
                $this->loadGeneralMessages();
                $this->loadMessages( $code );
                $variables = array( '\$1', '\$2', '\$3', '\$4', '\$5', '\$6', '\$7', '\$8', '\$9' );
-               $messagesWithoutVariables = array();
+               $mismatchMessages = array();
                foreach ( $this->mMessages[$code]['translated'] as $key => $value ) {
                        $missing = false;
                        foreach ( $variables as $var ) {
@@ -336,20 +351,24 @@ class languages {
                                        !preg_match( "/$var/sU", $value ) ) {
                                        $missing = true;
                                }
+                               if ( !preg_match( "/$var/sU", $this->mGeneralMessages['translatable'][$key] ) &&
+                                       preg_match( "/$var/sU", $value ) ) {
+                                       $missing = true;
+                               }
                        }
                        if ( $missing ) {
-                               $messagesWithoutVariables[$key] = $value;
+                               $mismatchMessages[$key] = $value;
                        }
                }
-               return $messagesWithoutVariables;
+               return $mismatchMessages;
        }
 
        /**
         * Get the messages which do not use plural.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages which do not use plural in this language.
+        * @return array The messages which do not use plural in this language.
         */
        public function getMessagesWithoutPlural( $code ) {
                $this->loadGeneralMessages();
@@ -366,9 +385,9 @@ class languages {
        /**
         * Get the empty messages.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The empty messages for this language.
+        * @return array The empty messages for this language.
         */
        public function getEmptyMessages( $code ) {
                $this->loadGeneralMessages();
@@ -385,9 +404,9 @@ class languages {
        /**
         * Get the messages with trailing whitespace.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages with trailing whitespace in this language.
+        * @return array The messages with trailing whitespace in this language.
         */
        public function getMessagesWithWhitespace( $code ) {
                $this->loadGeneralMessages();
@@ -404,9 +423,9 @@ class languages {
        /**
         * Get the non-XHTML messages.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The non-XHTML messages for this language.
+        * @return array The non-XHTML messages for this language.
         */
        public function getNonXHTMLMessages( $code ) {
                $this->loadGeneralMessages();
@@ -432,9 +451,9 @@ class languages {
        /**
         * Get the messages which include wrong characters.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages which include wrong characters in this language.
+        * @return array The messages which include wrong characters in this language.
         */
        public function getMessagesWithWrongChars( $code ) {
                $this->loadGeneralMessages();
@@ -469,9 +488,9 @@ class languages {
        /**
         * Get the messages which include dubious links.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages which include dubious links in this language.
+        * @return array The messages which include dubious links in this language.
         */
        public function getMessagesWithDubiousLinks( $code ) {
                $this->loadGeneralMessages();
@@ -498,9 +517,9 @@ class languages {
        /**
         * Get the messages which include unbalanced brackets.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The messages which include unbalanced brackets in this language.
+        * @return array The messages which include unbalanced brackets in this language.
         */
        public function getMessagesWithUnbalanced( $code ) {
                $this->loadGeneralMessages();
@@ -528,7 +547,7 @@ class languages {
                        if ( $a !== $b || $c !== $d ) {
                                $messages[$key] = "$a, $b, $c, $d";
                        }
-                       
+
                }
                return $messages;
        }
@@ -536,22 +555,24 @@ class languages {
        /**
         * Get the untranslated namespace names.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated namespace names in this language.
+        * @return array The untranslated namespace names in this language.
         */
        public function getUntranslatedNamespaces( $code ) {
                $this->loadFile( 'en' );
                $this->loadFile( $code );
-               return array_flip( array_diff_key( $this->mNamespaceNames['en'], $this->mNamespaceNames[$code] ) );
+               $namespacesDiff = array_diff_key( $this->mNamespaceNames['en'], $this->mNamespaceNames[$code] );
+               if ( isset( $namespacesDiff[NS_MAIN] ) ) unset( $namespacesDiff[NS_MAIN] );
+               return $namespacesDiff;
        }
 
        /**
         * Get the project talk namespace names with no $1.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The problematic project talk namespaces in this language.
+        * @return array The problematic project talk namespaces in this language.
         */
        public function getProblematicProjectTalks( $code ) {
                $this->loadFile( $code );
@@ -576,31 +597,37 @@ class languages {
        }
 
        /**
-        * Get the untranslated skin names.
+        * Get the untranslated magic words.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated skin names in this language.
+        * @return array The untranslated magic words in this language.
         */
-       public function getUntranslatedSkins( $code ) {
+       public function getUntranslatedMagicWords( $code ) {
                $this->loadFile( 'en' );
                $this->loadFile( $code );
-               return array_diff_key( $this->mSkinNames['en'], $this->mSkinNames[$code] );
+               $magicWords = array();
+               foreach ( $this->mMagicWords['en'] as $key => $value ) {
+                       if ( !isset( $this->mMagicWords[$code][$key] ) ) {
+                               $magicWords[$key] = $value[1];
+                       }
+               }
+               return $magicWords;
        }
 
        /**
-        * Get the untranslated magic words.
+        * Get the obsolete magic words.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated magic words in this language.
+        * @return array The obsolete magic words in this language.
         */
-       public function getUntranslatedMagicWords( $code ) {
+       public function getObsoleteMagicWords( $code ) {
                $this->loadFile( 'en' );
                $this->loadFile( $code );
                $magicWords = array();
-               foreach ( $this->mMagicWords['en'] as $key => $value ) {
-                       if ( !isset( $this->mMagicWords[$code][$key] ) ) {
+               foreach ( $this->mMagicWords[$code] as $key => $value ) {
+                       if ( !isset( $this->mMagicWords['en'][$key] ) ) {
                                $magicWords[$key] = $value[1];
                        }
                }
@@ -610,15 +637,19 @@ class languages {
        /**
         * Get the magic words that override the original English magic word.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The overriding magic words in this language.
+        * @return array The overriding magic words in this language.
         */
        public function getOverridingMagicWords( $code ) {
                $this->loadFile( 'en' );
                $this->loadFile( $code );
                $magicWords = array();
                foreach ( $this->mMagicWords[$code] as $key => $local ) {
+                       if ( !isset( $this->mMagicWords['en'][$key] ) ) {
+                               # Unrecognized magic word
+                               continue;
+                       }
                        $en = $this->mMagicWords['en'][$key];
                        array_shift( $local );
                        array_shift( $en );
@@ -635,15 +666,19 @@ class languages {
        /**
         * Get the magic words which do not match the case-sensitivity of the original words.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The magic words whose case does not match in this language.
+        * @return array The magic words whose case does not match in this language.
         */
        public function getCaseMismatchMagicWords( $code ) {
                $this->loadFile( 'en' );
                $this->loadFile( $code );
                $magicWords = array();
                foreach ( $this->mMagicWords[$code] as $key => $local ) {
+                       if ( !isset( $this->mMagicWords['en'][$key] ) ) {
+                               # Unrecognized magic word
+                               continue;
+                       }
                        if ( $local[0] != $this->mMagicWords['en'][$key][0] ) {
                                $magicWords[$key] = $local[0];
                        }
@@ -654,9 +689,9 @@ class languages {
        /**
         * Get the untranslated special page names.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated special page names in this language.
+        * @return array The untranslated special page names in this language.
         */
        public function getUntraslatedSpecialPages( $code ) {
                $this->loadFile( 'en' );
@@ -669,10 +704,33 @@ class languages {
                }
                return $specialPageAliases;
        }
+
+       /**
+        * Get the obsolete special page names.
+        *
+        * @param $code string The language code.
+        *
+        * @return array The obsolete special page names in this language.
+        */
+       public function getObsoleteSpecialPages( $code ) {
+               $this->loadFile( 'en' );
+               $this->loadFile( $code );
+               $specialPageAliases = array();
+               foreach ( $this->mSpecialPageAliases[$code] as $key => $value ) {
+                       if ( !isset( $this->mSpecialPageAliases['en'][$key] ) ) {
+                               $specialPageAliases[$key] = $value[0];
+                       }
+               }
+               return $specialPageAliases;
+       }
 }
 
 class extensionLanguages extends languages {
-       private $mMessageGroup; # The message group
+
+       /**
+        * @var MessageGroup
+        */
+       private $mMessageGroup;
 
        /**
         * Load the messages group.
@@ -689,7 +747,7 @@ class extensionLanguages extends languages {
        /**
         * Get the extension name.
         *
-        * @return The extension name.
+        * @return string The extension name.
         */
        public function name() {
                return $this->mMessageGroup->getLabel();
@@ -698,7 +756,7 @@ class extensionLanguages extends languages {
        /**
         * Load the language file.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         */
        protected function loadFile( $code ) {
                if( !isset( $this->mRawMessages[$code] ) ) {