Use __DIR__ instead of dirname( __FILE__ )
[lhc/web/wiklou.git] / maintenance / language / languages.inc
index 47373a2..b76f921 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
  */
@@ -28,13 +43,10 @@ class languages {
         * Load the list of languages: all the Messages*.php
         * files in the languages directory.
         *
-        * @param $exif Treat the EXIF messages?
+        * @param $exif bool Treat the EXIF messages?
         */
        function __construct( $exif = true ) {
-               require( dirname(__FILE__) . '/messageTypes.inc' );
-
-               global $wgIgnoredMessages, $wgOptionalMessages, $wgEXIFMessages;
-
+               require( __DIR__ . '/messageTypes.inc' );
                $this->mIgnoredMessages = $wgIgnoredMessages;
                if ( $exif ) {
                        $this->mOptionalMessages = array_merge( $wgOptionalMessages );
@@ -42,14 +54,14 @@ class languages {
                        $this->mOptionalMessages = array_merge( $wgOptionalMessages, $wgEXIFMessages );
                }
 
-               $this->mLanguages = array_keys( Language::getLanguageNames( true ) );
+               $this->mLanguages = array_keys( Language::fetchLanguageNames( null, 'mwfile' ) );
                sort( $this->mLanguages );
        }
 
        /**
         * Get the language list.
         *
-        * @return The language list.
+        * @return array The language list.
         */
        public function getLanguages() {
                return $this->mLanguages;
@@ -58,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;
@@ -67,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;
@@ -76,7 +88,7 @@ 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] ) &&
@@ -125,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] ) ) {
@@ -191,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 );
@@ -208,7 +220,7 @@ 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();
@@ -218,9 +230,9 @@ class languages {
        /**
         * Get fallback language code for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return Fallback code.
+        * @return string Fallback code.
         */
        public function getFallback( $code ) {
                $this->loadFile( $code );
@@ -230,9 +242,9 @@ class languages {
        /**
         * Get namespace names for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return Namespace names.
+        * @return array Namespace names.
         */
        public function getNamespaceNames( $code ) {
                $this->loadFile( $code );
@@ -242,9 +254,9 @@ class languages {
        /**
         * Get namespace aliases for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return Namespace aliases.
+        * @return array Namespace aliases.
         */
        public function getNamespaceAliases( $code ) {
                $this->loadFile( $code );
@@ -254,9 +266,9 @@ class languages {
        /**
         * Get magic words for a specific language.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return Magic words.
+        * @return array Magic words.
         */
        public function getMagicWords( $code ) {
                $this->loadFile( $code );
@@ -266,9 +278,9 @@ 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.
+        * @return array Special page aliases.
         */
        public function getSpecialPageAliases( $code ) {
                $this->loadFile( $code );
@@ -278,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();
@@ -291,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();
@@ -310,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();
@@ -323,9 +335,9 @@ class languages {
        /**
         * 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 whose variables do not match the original ones.
+        * @return array The messages whose variables do not match the original ones.
         */
        public function getMessagesWithMismatchVariables( $code ) {
                $this->loadGeneralMessages();
@@ -354,9 +366,9 @@ class languages {
        /**
         * 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();
@@ -373,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();
@@ -392,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();
@@ -411,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();
@@ -439,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();
@@ -476,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();
@@ -505,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();
@@ -535,7 +547,7 @@ class languages {
                        if ( $a !== $b || $c !== $d ) {
                                $messages[$key] = "$a, $b, $c, $d";
                        }
-                       
+
                }
                return $messages;
        }
@@ -543,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 );
@@ -585,9 +599,9 @@ class languages {
        /**
         * Get the untranslated magic words.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The untranslated magic words in this language.
+        * @return array The untranslated magic words in this language.
         */
        public function getUntranslatedMagicWords( $code ) {
                $this->loadFile( 'en' );
@@ -604,9 +618,9 @@ class languages {
        /**
         * Get the obsolete magic words.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The obsolete magic words in this language.
+        * @return array The obsolete magic words in this language.
         */
        public function getObsoleteMagicWords( $code ) {
                $this->loadFile( 'en' );
@@ -623,9 +637,9 @@ 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' );
@@ -652,9 +666,9 @@ 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' );
@@ -675,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' );
@@ -694,9 +708,9 @@ class languages {
        /**
         * Get the obsolete special page names.
         *
-        * @param $code The language code.
+        * @param $code string The language code.
         *
-        * @return The obsolete special page names in this language.
+        * @return array The obsolete special page names in this language.
         */
        public function getObsoleteSpecialPages( $code ) {
                $this->loadFile( 'en' );
@@ -712,11 +726,15 @@ class languages {
 }
 
 class extensionLanguages extends languages {
-       private $mMessageGroup; # The message group
+
+       /**
+        * @var MessageGroup
+        */
+       private $mMessageGroup;
 
        /**
         * Load the messages group.
-        * @param $group The messages group.
+        * @param $group MessageGroup The messages group.
         */
        function __construct( MessageGroup $group ) {
                $this->mMessageGroup = $group;
@@ -729,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();
@@ -738,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] ) ) {