X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/maintenance/language/languages.inc diff --git a/maintenance/language/languages.inc b/maintenance/language/languages.inc index c5c9f650..ad80af53 100644 --- a/maintenance/language/languages.inc +++ b/maintenance/language/languages.inc @@ -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 */ @@ -9,44 +24,56 @@ /** * @ingroup MaintenanceLanguage */ -class languages { - protected $mLanguages; # List of languages +class Languages { + /** @var array List of languages */ + protected $mLanguages; + + /** @var array Raw list of the messages in each language */ + protected $mRawMessages; + + /** @var array Messages in each language (except for English), divided to groups */ + protected $mMessages; + + /** @var array Fallback language in each language */ + protected $mFallback; - 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 + /** @var array General messages in English, divided to groups */ + protected $mGeneralMessages; - protected $mNamespaceNames; # Namespace names - protected $mNamespaceAliases; # Namespace aliases - protected $mMagicWords; # Magic words - protected $mSpecialPageAliases; # Special page aliases + /** @var array All the messages which should be exist only in the English file */ + protected $mIgnoredMessages; + + /** @var array All the messages which may be translated or not, depending on the language */ + protected $mOptionalMessages; + + /** @var array Namespace names */ + protected $mNamespaceNames; + + /** @var array Namespace aliases */ + protected $mNamespaceAliases; + + /** @var array Magic words */ + protected $mMagicWords; + + /** @var array Special page aliases */ + protected $mSpecialPageAliases; /** * Load the list of languages: all the Messages*.php * files in the languages directory. - * - * @param $exif Treat the EXIF messages? */ - function __construct( $exif = true ) { - require( dirname(__FILE__) . '/messageTypes.inc' ); - $this->mIgnoredMessages = $wgIgnoredMessages; - if ( $exif ) { - $this->mOptionalMessages = array_merge( $wgOptionalMessages ); - } else { - $this->mOptionalMessages = array_merge( $wgOptionalMessages, $wgEXIFMessages ); - } + function __construct() { + Hooks::run( 'LocalisationIgnoredOptionalMessages', + [ &$this->mIgnoredMessages, &$this->mOptionalMessages ] ); - $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; @@ -55,7 +82,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 +91,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,7 +100,7 @@ class languages { /** * Load the language file. * - * @param $code The language code. + * @param string $code The language code. */ protected function loadFile( $code ) { if ( isset( $this->mRawMessages[$code] ) && @@ -81,21 +108,26 @@ class languages { isset( $this->mNamespaceNames[$code] ) && isset( $this->mNamespaceAliases[$code] ) && isset( $this->mMagicWords[$code] ) && - isset( $this->mSpecialPageAliases[$code] ) ) { + isset( $this->mSpecialPageAliases[$code] ) + ) { return; } - $this->mRawMessages[$code] = array(); + $this->mRawMessages[$code] = []; $this->mFallback[$code] = ''; - $this->mNamespaceNames[$code] = array(); - $this->mNamespaceAliases[$code] = array(); - $this->mMagicWords[$code] = array(); - $this->mSpecialPageAliases[$code] = array(); + $this->mNamespaceNames[$code] = []; + $this->mNamespaceAliases[$code] = []; + $this->mMagicWords[$code] = []; + $this->mSpecialPageAliases[$code] = []; + + $jsonfilename = Language::getJsonMessagesFileName( $code ); + if ( file_exists( $jsonfilename ) ) { + $json = Language::getLocalisationCache()->readJSONFile( $jsonfilename ); + $this->mRawMessages[$code] = $json['messages']; + } + $filename = Language::getMessagesFileName( $code ); if ( file_exists( $filename ) ) { - require( $filename ); - if ( isset( $messages ) ) { - $this->mRawMessages[$code] = $messages; - } + require $filename; if ( isset( $fallback ) ) { $this->mFallback[$code] = $fallback; } @@ -115,14 +147,18 @@ class languages { } /** - * Load the messages for a specific language (which is not English) and divide them to groups: + * Load the messages for a specific language (which is not English) and divide them to + * groups: * all - all the messages. * required - messages which should be translated in order to get a complete translation. - * optional - messages which can be translated, the fallback translation is used if not translated. - * 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. + * optional - messages which can be translated, the fallback translation is used if not + * translated. + * 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 string $code The language code. */ private function loadMessages( $code ) { if ( isset( $this->mMessages[$code] ) ) { @@ -131,15 +167,15 @@ class languages { $this->loadFile( $code ); $this->loadGeneralMessages(); $this->mMessages[$code]['all'] = $this->mRawMessages[$code]; - $this->mMessages[$code]['required'] = array(); - $this->mMessages[$code]['optional'] = array(); - $this->mMessages[$code]['obsolete'] = array(); - $this->mMessages[$code]['translated'] = array(); + $this->mMessages[$code]['required'] = []; + $this->mMessages[$code]['optional'] = []; + $this->mMessages[$code]['obsolete'] = []; + $this->mMessages[$code]['translated'] = []; foreach ( $this->mMessages[$code]['all'] as $key => $value ) { if ( isset( $this->mGeneralMessages['required'][$key] ) ) { $this->mMessages[$code]['required'][$key] = $value; $this->mMessages[$code]['translated'][$key] = $value; - } else if ( isset( $this->mGeneralMessages['optional'][$key] ) ) { + } elseif ( isset( $this->mGeneralMessages['optional'][$key] ) ) { $this->mMessages[$code]['optional'][$key] = $value; $this->mMessages[$code]['translated'][$key] = $value; } else { @@ -151,10 +187,13 @@ class languages { /** * Load the messages for English and divide them to groups: * all - all the messages. - * required - messages which should be translated to other languages in order to get a complete translation. - * optional - messages which can be translated to other languages, but it's not required for a complete translation. + * required - messages which should be translated to other languages in order to get a + * complete translation. + * optional - messages which can be translated to other languages, but it's not required + * for a complete translation. * ignored - messages which should not be translated to other languages. - * translatable - messages which are either required or optional, but can be translated from English. + * translatable - messages which are either required or optional, but can be translated + * from English. */ private function loadGeneralMessages() { if ( isset( $this->mGeneralMessages ) ) { @@ -162,14 +201,14 @@ class languages { } $this->loadFile( 'en' ); $this->mGeneralMessages['all'] = $this->mRawMessages['en']; - $this->mGeneralMessages['required'] = array(); - $this->mGeneralMessages['optional'] = array(); - $this->mGeneralMessages['ignored'] = array(); - $this->mGeneralMessages['translatable'] = array(); + $this->mGeneralMessages['required'] = []; + $this->mGeneralMessages['optional'] = []; + $this->mGeneralMessages['ignored'] = []; + $this->mGeneralMessages['translatable'] = []; foreach ( $this->mGeneralMessages['all'] as $key => $value ) { if ( in_array( $key, $this->mIgnoredMessages ) ) { $this->mGeneralMessages['ignored'][$key] = $value; - } else if ( in_array( $key, $this->mOptionalMessages ) ) { + } elseif ( in_array( $key, $this->mOptionalMessages ) ) { $this->mGeneralMessages['optional'][$key] = $value; $this->mGeneralMessages['translatable'][$key] = $value; } else { @@ -184,160 +223,178 @@ class languages { * fallback language messages, divided to groups: * all - all the messages. * required - messages which should be translated in order to get a complete translation. - * optional - messages which can be translated, the fallback translation is used if not translated. - * 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. + * optional - messages which can be translated, the fallback translation is used if not + * translated. + * 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 string $code The language code. * - * @return The messages in this language. + * @return string The messages in this language. */ public function getMessages( $code ) { $this->loadMessages( $code ); + return $this->mMessages[$code]; } /** * Get all the general English messages, divided to groups: * all - all the messages. - * required - messages which should be translated to other languages in order to get a complete translation. - * optional - messages which can be translated to other languages, but it's not required for a complete translation. + * required - messages which should be translated to other languages in + * order to get a complete translation. + * optional - messages which can be translated to other languages, but it's + * not required for a complete translation. * ignored - messages which should not be translated to other languages. - * translatable - messages which are either required or optional, but can be translated from English. + * 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 The language code. + * @param string $code The language code. * - * @return Fallback 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 string $code The language code. * - * @return Namespace names. + * @return array Namespace names. */ public function getNamespaceNames( $code ) { $this->loadFile( $code ); + return $this->mNamespaceNames[$code]; } /** * Get namespace aliases for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return Namespace aliases. + * @return array Namespace aliases. */ public function getNamespaceAliases( $code ) { $this->loadFile( $code ); + return $this->mNamespaceAliases[$code]; } /** * Get magic words for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return Magic words. + * @return array Magic words. */ public function getMagicWords( $code ) { $this->loadFile( $code ); + return $this->mMagicWords[$code]; } /** * Get special page aliases for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return Special page aliases. + * @return array Special page aliases. */ public function getSpecialPageAliases( $code ) { $this->loadFile( $code ); + return $this->mSpecialPageAliases[$code]; } /** * Get the untranslated messages for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return The untranslated messages for this language. + * @return array The untranslated messages for this language. */ public function getUntranslatedMessages( $code ) { $this->loadGeneralMessages(); $this->loadMessages( $code ); + return array_diff_key( $this->mGeneralMessages['required'], $this->mMessages[$code]['required'] ); } /** * Get the duplicate messages for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return The duplicate messages for this language. + * @return array The duplicate messages for this language. */ public function getDuplicateMessages( $code ) { $this->loadGeneralMessages(); $this->loadMessages( $code ); - $duplicateMessages = array(); + $duplicateMessages = []; foreach ( $this->mMessages[$code]['translated'] as $key => $value ) { if ( $this->mGeneralMessages['translatable'][$key] == $value ) { $duplicateMessages[$key] = $value; } } + return $duplicateMessages; } /** * Get the obsolete messages for a specific language. * - * @param $code The language code. + * @param string $code The language code. * - * @return The obsolete messages for this language. + * @return array The obsolete messages for this language. */ public function getObsoleteMessages( $code ) { $this->loadGeneralMessages(); $this->loadMessages( $code ); + return $this->mMessages[$code]['obsolete']; } /** * Get the messages whose variables do not match the original ones. * - * @param $code The language code. + * @param string $code 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(); $this->loadMessages( $code ); - $variables = array( '\$1', '\$2', '\$3', '\$4', '\$5', '\$6', '\$7', '\$8', '\$9' ); - $mismatchMessages = array(); + $variables = [ '\$1', '\$2', '\$3', '\$4', '\$5', '\$6', '\$7', '\$8', '\$9' ]; + $mismatchMessages = []; foreach ( $this->mMessages[$code]['translated'] as $key => $value ) { $missing = false; foreach ( $variables as $var ) { if ( preg_match( "/$var/sU", $this->mGeneralMessages['translatable'][$key] ) && - !preg_match( "/$var/sU", $value ) ) { + !preg_match( "/$var/sU", $value ) + ) { $missing = true; } if ( !preg_match( "/$var/sU", $this->mGeneralMessages['translatable'][$key] ) && - preg_match( "/$var/sU", $value ) ) { + preg_match( "/$var/sU", $value ) + ) { $missing = true; } } @@ -345,105 +402,112 @@ class languages { $mismatchMessages[$key] = $value; } } + return $mismatchMessages; } /** * Get the messages which do not use plural. * - * @param $code The language code. + * @param string $code 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(); $this->loadMessages( $code ); - $messagesWithoutPlural = array(); + $messagesWithoutPlural = []; foreach ( $this->mMessages[$code]['translated'] as $key => $value ) { - if ( stripos( $this->mGeneralMessages['translatable'][$key], '{{plural:' ) !== false && stripos( $value, '{{plural:' ) === false ) { + if ( stripos( $this->mGeneralMessages['translatable'][$key], '{{plural:' ) !== false && + stripos( $value, '{{plural:' ) === false + ) { $messagesWithoutPlural[$key] = $value; } } + return $messagesWithoutPlural; } /** * Get the empty messages. * - * @param $code The language code. + * @param string $code The language code. * - * @return The empty messages for this language. + * @return array The empty messages for this language. */ public function getEmptyMessages( $code ) { $this->loadGeneralMessages(); $this->loadMessages( $code ); - $emptyMessages = array(); + $emptyMessages = []; foreach ( $this->mMessages[$code]['translated'] as $key => $value ) { if ( $value === '' || $value === '-' ) { $emptyMessages[$key] = $value; } } + return $emptyMessages; } /** * Get the messages with trailing whitespace. * - * @param $code The language code. + * @param string $code 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(); $this->loadMessages( $code ); - $messagesWithWhitespace = array(); + $messagesWithWhitespace = []; foreach ( $this->mMessages[$code]['translated'] as $key => $value ) { if ( $this->mGeneralMessages['translatable'][$key] !== '' && $value !== rtrim( $value ) ) { $messagesWithWhitespace[$key] = $value; } } + return $messagesWithWhitespace; } /** * Get the non-XHTML messages. * - * @param $code The language code. + * @param string $code 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(); $this->loadMessages( $code ); - $wrongPhrases = array( + $wrongPhrases = [ '