/mediawiki-integration/source/php/mediawiki/maintenance/language/languages.inc
PHP | 396 lines | 243 code | 21 blank | 132 comment | 42 complexity | ded10407a96db1df6687b07e9087eb2c MD5 | raw file
Possible License(s): GPL-2.0, LGPL-3.0
- <?php
- /**
- * Handle messages in the language files.
- *
- * @package MediaWiki
- * @subpackage Maintenance
- */
- require_once( 'messageTypes.inc' );
- class languages {
- private $mLanguages; # List of languages
- private $mRawMessages; # Raw list of the messages in each language
- private $mMessages; # Messages in each language (except for English), divided to groups
- private $mGeneralMessages; # General messages in English, divided to groups
- private $mIgnoredMessages; # All the messages which should be exist only in the English file
- private $mOptionalMessages; # All the messages which may be translated or not, depending on the language
- /**
- * Load the list of languages: all the Messages*.php
- * files in the languages directory.
- *
- * @param $exif Treat the EXIF messages?
- */
- function __construct( $exif = true ) {
- global $wgIgnoredMessages, $wgOptionalMessages, $wgEXIFMessages;
- $this->mIgnoredMessages = $wgIgnoredMessages;
- if ( $exif ) {
- $this->mOptionalMessages = array_merge( $wgOptionalMessages );
- } else {
- $this->mOptionalMessages = array_merge( $wgOptionalMessages, $wgEXIFMessages );
- }
- $this->mLanguages = array_keys( Language::getLanguageNames( true ) );
- sort( $this->mLanguages );
- }
- /**
- * Get the language list.
- *
- * @return The language list.
- */
- public function getLanguages() {
- return $this->mLanguages;
- }
- /**
- * Get the ignored messages list.
- *
- * @return The ignored messages list.
- */
- public function getIgnoredMessages() {
- return $this->mIgnoredMessages;
- }
- /**
- * Get the optional messages list.
- *
- * @return The optional messages list.
- */
- public function getOptionalMessages() {
- return $this->mOptionalMessages;
- }
- /**
- * Load the raw messages for a specific langauge from the messages file.
- *
- * @param $code The langauge code.
- */
- private function loadRawMessages( $code ) {
- if ( isset( $this->mRawMessages[$code] ) ) {
- return;
- }
- $filename = Language::getMessagesFileName( $code );
- if ( file_exists( $filename ) ) {
- require( $filename );
- if ( isset( $messages ) ) {
- $this->mRawMessages[$code] = $messages;
- } else {
- $this->mRawMessages[$code] = array();
- }
- } else {
- $this->mRawMessages[$code] = array();
- }
- }
- /**
- * 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 are 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.
- */
- private function loadMessages( $code ) {
- if ( isset( $this->mMessages[$code] ) ) {
- return;
- }
- $this->loadRawMessages( $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();
- 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] ) ) {
- $this->mMessages[$code]['optional'][$key] = $value;
- $this->mMessages[$code]['translated'][$key] = $value;
- } else {
- $this->mMessages[$code]['obsolete'][$key] = $value;
- }
- }
- }
- /**
- * 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.
- * ignored - messages which should not be translated to other languages.
- * translatable - messages which are either required or optional, but can be translated from English.
- */
- private function loadGeneralMessages() {
- if ( isset( $this->mGeneralMessages ) ) {
- return;
- }
- $this->loadRawMessages( 'en' );
- $this->mGeneralMessages['all'] = $this->mRawMessages['en'];
- $this->mGeneralMessages['required'] = array();
- $this->mGeneralMessages['optional'] = array();
- $this->mGeneralMessages['ignored'] = array();
- $this->mGeneralMessages['translatable'] = array();
- 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 ) ) {
- $this->mGeneralMessages['optional'][$key] = $value;
- $this->mGeneralMessages['translatable'][$key] = $value;
- } else {
- $this->mGeneralMessages['required'][$key] = $value;
- $this->mGeneralMessages['translatable'][$key] = $value;
- }
- }
- }
- /**
- * Get all the messages for a specific langauge (not English), without the
- * 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 are not exist, or they are ignored messages.
- * translated - messages which are either required or optional, but translated from English and needed.
- *
- * @param $code The langauge code.
- *
- * @return 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.
- * 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.
- */
- public function getGeneralMessages() {
- $this->loadGeneralMessages();
- return $this->mGeneralMessages;
- }
- /**
- * Get the untranslated messages for a specific language.
- *
- * @param $code The langauge code.
- *
- * @return The untranslated messages for this language.
- */
- public function getUntranslatedMessages( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $requiredGeneralMessages = array_keys( $this->mGeneralMessages['required'] );
- $requiredMessages = array_keys( $this->mMessages[$code]['required'] );
- $untranslatedMessages = array();
- foreach ( array_diff( $requiredGeneralMessages, $requiredMessages ) as $key ) {
- $untranslatedMessages[$key] = $this->mGeneralMessages['required'][$key];
- }
- return $untranslatedMessages;
- }
- /**
- * Get the duplicate messages for a specific language.
- *
- * @param $code The langauge code.
- *
- * @return The duplicate messages for this language.
- */
- public function getDuplicateMessages( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $duplicateMessages = array();
- foreach ( $this->mMessages[$code]['translated'] as $key => $value ) {
- if ( $this->mGeneralMessages['translatable'][$key] == $value ) {
- $duplicateMessages[$key] = $value;
- }
- }
- return $duplicateMessages;
- }
- /**
- * Get the messages which do not use some variables.
- *
- * @param $code The langauge code.
- *
- * @return The messages which do not use some variables in this language.
- */
- public function getMessagesWithoutVariables( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $variables = array( '\$1', '\$2', '\$3', '\$4', '\$5', '\$6', '\$7', '\$8', '\$9' );
- $messagesWithoutVariables = array();
- 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 ) ) {
- $missing = true;
- }
- }
- if ( $missing ) {
- $messagesWithoutVariables[$key] = $value;
- }
- }
- return $messagesWithoutVariables;
- }
- /**
- * Get the empty messages.
- *
- * @param $code The langauge code.
- *
- * @return The empty messages for this language.
- */
- public function getEmptyMessages( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $emptyMessages = array();
- 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 langauge code.
- *
- * @return The messages with trailing whitespace in this language.
- */
- public function getMessagesWithWhitespace( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $messagesWithWhitespace = array();
- 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 langauge code.
- *
- * @return The non-XHTML messages for this language.
- */
- public function getNonXHTMLMessages( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $wrongPhrases = array(
- '<hr *\\?>',
- '<br *\\?>',
- '<hr/>',
- '<br/>',
- );
- $wrongPhrases = '~(' . implode( '|', $wrongPhrases ) . ')~sDu';
- $nonXHTMLMessages = array();
- foreach ( $this->mMessages[$code]['translated'] as $key => $value ) {
- if ( preg_match( $wrongPhrases, $value ) ) {
- $nonXHTMLMessages[$key] = $value;
- }
- }
- return $nonXHTMLMessages;
- }
- /**
- * Get the messages which include wrong characters.
- *
- * @param $code The langauge code.
- *
- * @return The messages which include wrong characters in this language.
- */
- public function getMessagesWithWrongChars( $code ) {
- $this->loadGeneralMessages();
- $this->loadMessages( $code );
- $wrongChars = array(
- '[LRM]' => "\xE2\x80\x8E",
- '[RLM]' => "\xE2\x80\x8F",
- '[LRE]' => "\xE2\x80\xAA",
- '[RLE]' => "\xE2\x80\xAB",
- '[POP]' => "\xE2\x80\xAC",
- '[LRO]' => "\xE2\x80\xAD",
- '[RLO]' => "\xE2\x80\xAB",
- '[ZWSP]'=> "\xE2\x80\x8B",
- '[NBSP]'=> "\xC2\xA0",
- '[WJ]' => "\xE2\x81\xA0",
- '[BOM]' => "\xEF\xBB\xBF",
- '[FFFD]'=> "\xEF\xBF\xBD",
- );
- $wrongRegExp = '/(' . implode( '|', array_values( $wrongChars ) ) . ')/sDu';
- $wrongCharsMessages = array();
- foreach ( $this->mMessages[$code]['translated'] as $key => $value ) {
- if ( preg_match( $wrongRegExp, $value ) ) {
- foreach ( $wrongChars as $viewableChar => $hiddenChar ) {
- $value = str_replace( $hiddenChar, $viewableChar, $value );
- }
- $wrongCharsMessages[$key] = $value;
- }
- }
- return $wrongCharsMessages;
- }
- /**
- * Output a messages list
- *
- * @param $messages The messages list
- * @param $code The language code
- * @param $text The text to show before the list (optional)
- * @param $level The display level (optional)
- * @param $links Show links (optional)
- * @param $wikilang The langauge of the wiki to display the list in, for the links (optional)
- */
- public function outputMessagesList( $messages, $code, $text = '', $level = 2, $links = false, $wikilang = null ) {
- if ( count( $messages ) == 0 ) {
- return;
- }
- if ( $text ) {
- echo "$text\n";
- }
- if ( $level == 1 ) {
- echo "[messages are hidden]\n";
- } else {
- foreach ( $messages as $key => $value ) {
- if ( $links ) {
- $displayKey = ucfirst( $key );
- if ( !isset( $wikilang ) ) {
- global $wgContLang;
- $wikilang = $wgContLang->getCode();
- }
- if ( $code == $wikilang ) {
- $displayKey = "[[MediaWiki:$displayKey|$key]]";
- } else {
- $displayKey = "[[MediaWiki:$displayKey/$code|$key]]";
- }
- } else {
- $displayKey = $key;
- }
- if ( $level == 2 ) {
- echo "* $displayKey\n";
- } else {
- echo "* $displayKey: '$value'\n";
- }
- }
- }
- }
- }
- ?>