<?php
/**
- * Rewrite the messages array in the files languages/messages/MessagesXX.php.
+ * Rewrite the messages array in the files languages/messages/MessagesXx.php.
*
- * @addtogroup Maintenance
+ * @file
+ * @ingroup MaintenanceLanguage
+ * @defgroup MaintenanceLanguage MaintenanceLanguage
*/
require_once( dirname(__FILE__).'/../commandLine.inc' );
*
* @param $code The language code.
* @param $write Write to the messages file?
+ * @param $listUnknown List the unknown messages?
+ * @param $removeUnknown Remove the unknown messages?
+ * @param $removeDupes Remove the duplicated messages?
+ * @param $dupeMsgSource The source file intended to remove from the array.
*/
-function rebuildLanguage( $code, $write ) {
+function rebuildLanguage( $code, $write, $listUnknown, $removeUnknown, $removeDupes, $dupeMsgSource ) {
global $wgLanguages;
-
- # Get messages
$messages = $wgLanguages->getMessages( $code );
$messages = $messages['all'];
+ if ($removeDupes) {
+ $messages = removeDupes( $messages, $dupeMsgSource );
+ }
+ MessageWriter::writeMessagesToFile( $messages, $code, $write, $listUnknown, $removeUnknown );
+}
- # Rewrite messages array
- $messages = writeMessagesArray( $messages, $code == 'en' );
- $messagesText = $messages[0];
- $sortedMessages = $messages[1];
-
- # Write to the file
- $filename = Language::getMessagesFileName( $code );
- $contents = file_get_contents( $filename );
- if ( strpos( $contents, '$messages' ) !== false ) {
- $contents = explode( '$messages', $contents );
- if ( $messagesText . "\n?>\n" == '$messages' . $contents[1] ) {
- echo "Generated messages for language $code. Same to the current file.\n";
- } else {
- if ( $write ) {
- $new = $contents[0];
- $new .= $messagesText;
- $new .= "\n?>\n";
- file_put_contents( $filename, $new );
- echo "Generated and wrote messages for language $code.\n";
- } else {
- echo "Generated messages for language $code. Please run the script again (without the parameter \"dry-run\") to write the array to the file.\n";
- }
- }
- if ( isset( $sortedMessages['unknown'] ) && !empty( $sortedMessages['unknown'] ) ) {
- echo "\nThere are " . count( $sortedMessages['unknown'] ) . " unknown messages, please check them:\n";
- foreach ( $sortedMessages['unknown'] as $key => $value ) {
- echo "* " . $key . "\n";
- }
+/**
+ * Remove duplicates from a message array.
+ *
+ * @param $oldMsgArray The input message array.
+ * @param $dupeMsgSource The source file path for duplicates.
+ * @return $newMsgArray The output message array, with duplicates removed.
+ */
+function removeDupes( $oldMsgArray, $dupeMsgSource ) {
+ if (file_exists($dupeMsgSource)) {
+ include($dupeMsgSource);
+ if (!isset($dupeMessages)) {
+ echo("There are no duplicated messages in the source file provided.");
+ exit(1);
}
} else {
- echo "Generated messages for language $code. There seems to be no messages array in the file.\n";
+ echo ("The specified file $dupeMsgSource cannot be found.");
+ exit(1);
+ }
+ $newMsgArray = $oldMsgArray;
+ foreach ($oldMsgArray as $key => $value) {
+ if ( array_key_exists( $key, $dupeMessages ) ) {
+ unset($newMsgArray[$key]);
+ }
}
+ return $newMsgArray;
}
# Show help
if ( isset( $options['help'] ) ) {
- echo <<<END
+ echo <<<TEXT
Run this script to rewrite the messages array in the files languages/messages/MessagesXX.php.
Parameters:
* lang: Language code (default: the installation default language). You can also specify "all" to check all the languages.
* help: Show this help.
Options:
- * dry-run: Don't write the array to the file.
+ * dry-run: Do not write the array to the file.
+ * no-unknown: Do not list the unknown messages.
+ * remove-unknown: Remove unknown messages.
+ * remove-duplicates: Remove duplicated messages based on a PHP source file.
-END;
- exit();
+TEXT;
+ exit(1);
}
# Get the language code
$wgCode = $wgContLang->getCode();
}
-# Get the write options
+# Get the duplicate message source
+if ( isset( $options['remove-duplicates'] ) && ( strcmp( $options['remove-duplicates'], '' ) ) ) {
+ $wgDupeMessageSource = $options['remove-duplicates'];
+} else {
+ $wgDupeMessageSource = '';
+}
+
+# Get the options
$wgWriteToFile = !isset( $options['dry-run'] );
+$wgListUnknownMessages = !isset( $options['no-unknown'] );
+$wgRemoveUnknownMessages = isset( $options['remove-unknown'] );
+$wgRemoveDuplicateMessages = isset( $options['remove-duplicates'] );
# Get language objects
$wgLanguages = new languages();
# Write all the language
if ( $wgCode == 'all' ) {
foreach ( $wgLanguages->getLanguages() as $language ) {
- rebuildLanguage( $language, $wgWriteToFile );
+ rebuildLanguage( $language, $wgWriteToFile, $wgListUnknownMessages, $wgRemoveUnknownMessages, $wgRemoveDuplicateMessages, $wgDupeMessageSource );
}
} else {
- rebuildLanguage( $wgCode, $wgWriteToFile );
+ rebuildLanguage( $wgCode, $wgWriteToFile, $wgListUnknownMessages, $wgRemoveUnknownMessages, $wgRemoveDuplicateMessages, $wgDupeMessageSource );
}
-
-?>