maintenance/language/writeMessagesArray.inc

   1 <?php
   2 /**
   3  * Write a messages array as a PHP text.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup MaintenanceLanguage
  22  */
  23
  24 /**
  25  * @ingroup MaintenanceLanguage
  26  */
  27 class MessageWriter {
  28         static $optionalComment = 'only translate this message to other languages if you have to change it';
  29         static $ignoredComment = "do not translate or duplicate this message to other languages";
  30
  31         static $messageStructure;
  32         static $blockComments;
  33         static $ignoredMessages;
  34         static $optionalMessages;
  35
  36         /**
  37          * Write a messages array as a PHP text and write it to the messages file.
  38          *
  39          * @param $messages Array: the messages array.
  40          * @param $code String: the language code.
  41          * @param $write Boolean: write to the messages file?
  42          * @param $listUnknown Boolean: list the unknown messages?
  43          * @param $removeUnknown Boolean: whether to remove unkown messages
  44          */
  45         public static function writeMessagesToFile( $messages, $code, $write, $listUnknown, $removeUnknown ) {
  46                 # Rewrite the messages array
  47                 $messages = self::writeMessagesArray( $messages, $code == 'en', false, $removeUnknown );
  48                 $messagesText = $messages[0];
  49                 $sortedMessages = $messages[1];
  50
  51                 # Write to the file
  52                 $filename = Language::getMessagesFileName( $code );
  53                 $contents = file_get_contents( $filename );
  54                 if( strpos( $contents, '$messages' ) !== false ) {
  55                         $contents = explode( '$messages', $contents );
  56                         if( $messagesText == '$messages' . $contents[1] ) {
  57                                 echo "Generated messages for language $code. Same as the current file.\n";
  58                         } else {
  59                                 if( $write ) {
  60                                         $new = $contents[0];
  61                                         $new .= $messagesText;
  62                                         file_put_contents( $filename, $new );
  63                                         echo "Generated and wrote messages for language $code.\n";
  64                                 } else {
  65                                         echo "Generated messages for language $code. Please run the script again (without the parameter \"dry-run\") to write the array to the file.\n";
  66                                 }
  67                         }
  68                         if( $listUnknown && isset( $sortedMessages['unknown'] ) && !empty( $sortedMessages['unknown'] ) ) {
  69                                 if ( $removeUnknown )
  70                                         echo "\nThe following " . count( $sortedMessages['unknown'] ) . " unknown messages have been removed:\n";
  71                                 else
  72                                         echo "\nThere are " . count( $sortedMessages['unknown'] ) . " unknown messages, please check them:\n";
  73                                 foreach( $sortedMessages['unknown'] as $key => $value ) {
  74                                         echo "* " . $key . "\n";
  75                                 }
  76                         }
  77                 } else {
  78                         echo "Generated messages for language $code. There seem to be no messages array in the file.\n";
  79                 }
  80         }
  81
  82         /**
  83          * Write a messages array as a PHP text.
  84          *
  85          * @param $messages Array: the messages array.
  86          * @param $ignoredComments Boolean: show comments about ignored and optional
  87          *                         messages? (For English.)
  88          * @param $prefix String: base path for messages.inc and messageTypes.inc files
  89          *                or false for default path (this directory)
  90          * @param $removeUnknown Boolean: whether to remove unkown messages
  91          *
  92          * @return Array of the PHP text and the sorted messages array.
  93          */
  94         public static function writeMessagesArray( $messages, $ignoredComments = false, $prefix = false, $removeUnknown = false ) {
  95                 # Load messages
  96                 $dir = $prefix ? $prefix : dirname( __FILE__ );
  97
  98                 require( $dir . '/messages.inc' );
  99                 self::$messageStructure = $wgMessageStructure;
 100                 self::$blockComments = $wgBlockComments;
 101
 102                 require( $dir . '/messageTypes.inc' );
 103                 self::$ignoredMessages = $wgIgnoredMessages;
 104                 self::$optionalMessages = $wgOptionalMessages;
 105
 106                 # Sort messages to blocks
 107                 $sortedMessages['unknown'] = $messages;
 108                 foreach( self::$messageStructure as $blockName => $block ) {
 109                         foreach( $block as $key ) {
 110                                 if( array_key_exists( $key, $sortedMessages['unknown'] ) ) {
 111                                         $sortedMessages[$blockName][$key] = $sortedMessages['unknown'][$key];
 112                                         unset( $sortedMessages['unknown'][$key] );
 113                                 }
 114                         }
 115                 }
 116
 117                 # Write all the messages
 118                 $messagesText = "\$messages = array(
 119 ";
 120                 foreach( $sortedMessages as $block => $messages ) {
 121                         # Skip if it's the block of unknown messages - handle that in the end of file
 122                         if( $block == 'unknown' ) {
 123                                 continue;
 124                         }
 125
 126                         if( $ignoredComments ) {
 127                                 $ignored = self::$ignoredMessages;
 128                                 $optional = self::$optionalMessages;
 129                         } else {
 130                                 $ignored = array();
 131                                 $optional = array();
 132                         }
 133                         $comments = self::makeComments( array_keys( $messages ), $ignored, $optional );
 134
 135                         # Write the block
 136                         $messagesText .= self::writeMessagesBlock( self::$blockComments[$block], $messages, $comments );
 137                 }
 138
 139                 # Write the unknown messages, alphabetically sorted.
 140                 # Of course, we don't have any comments for them, because they are unknown.
 141                 if ( !$removeUnknown ) {
 142                         ksort( $sortedMessages['unknown'] );
 143                         $messagesText .= self::writeMessagesBlock( 'Unknown messages', $sortedMessages['unknown'] );
 144                 }
 145                 $messagesText .= ");
 146 ";
 147                 return array( $messagesText, $sortedMessages );
 148         }
 149
 150         /**
 151          * Generates an array of comments for messages.
 152          *
 153          * @param $messages Array: key of messages.
 154          * @param $ignored Array: list of ingored message keys.
 155          * @param $optional Array: list of optional message keys.
 156          */
 157         public static function makeComments( $messages, $ignored, $optional ) {
 158                 # Comment collector
 159                 $commentArray = array();
 160
 161                 # List of keys only
 162                 foreach( $messages as $key ) {
 163                         if( in_array( $key, $ignored ) ) {
 164                                 $commentArray[$key] = ' # ' . self::$ignoredComment;
 165                         } elseif( in_array( $key, $optional ) ) {
 166                                 $commentArray[$key] = ' # ' . self::$optionalComment;
 167                         }
 168                 }
 169
 170                 return $commentArray;
 171         }
 172
 173         /**
 174          * Write a block of messages to PHP.
 175          *
 176          * @param $blockComment String: the comment of whole block.
 177          * @param $messages Array: the block messages.
 178          * @param $messageComments Array: optional comments for messages in this block.
 179          * @param $prefix String: prefix for every line, for indenting purposes.
 180          *
 181          * @return The block, formatted in PHP.
 182          */
 183         public static function writeMessagesBlock( $blockComment, $messages,
 184                 $messageComments = array(), $prefix = '' ) {
 185
 186                 $blockText = '';
 187
 188                 # Skip the block if it includes no messages
 189                 if( empty( $messages ) ) {
 190                         return '';
 191                 }
 192
 193                 # Format the block comment (if exists); check for multiple lines comments
 194                 if( !empty( $blockComment ) ) {
 195                         if( strpos( $blockComment, "\n" ) === false ) {
 196                                 $blockText .= "$prefix# $blockComment
 197 ";
 198                         } else {
 199                                 $blockText .= "$prefix/*
 200 $blockComment
 201 */
 202 ";
 203                         }
 204                 }
 205
 206                 # Get max key length
 207                 $maxKeyLength = max( array_map( 'strlen', array_keys( $messages ) ) );
 208
 209                 # Format the messages
 210                 foreach( $messages as $key => $value ) {
 211                         # Add the key name
 212                         $blockText .= "$prefix'$key'";
 213
 214                         # Add the appropriate block whitespace
 215                         $blockText .= str_repeat( ' ', $maxKeyLength - strlen( $key ) );
 216
 217                         # Refer to the value
 218                         $blockText .= ' => ';
 219
 220                         # Check for the appropriate apostrophe and add the value
 221                         # Quote \ here, because it needs always escaping
 222                         $value = addcslashes( $value, '\\' );
 223
 224                         # For readability
 225                         $single = "'";
 226                         $double = '"';
 227
 228                         if( strpos( $value, $single ) === false ) {
 229                                 # Nothing ugly, just use '
 230                                 $blockText .= $single.$value.$single;
 231                         } elseif( strpos( $value, $double ) === false && !preg_match('/\$[a-zA-Z_\x7f-\xff]/', $value) ) {
 232                                 # No "-quotes, no variables that need quoting, use "
 233                                 $blockText .= $double.$value.$double;
 234                         } else {
 235                                 # Something needs quoting, pick the quote which causes less quoting
 236                                 $quote = substr_count( $value, $double ) + substr_count( $value, '$' ) >= substr_count( $value, $single ) ? $single : $double;
 237                                 if( $quote === $double ) {
 238                                         $extra = '$';
 239                                 } else {
 240                                         $extra = '';
 241                                 }
 242                                 $blockText .= $quote . addcslashes( $value, $quote . $extra ) . $quote;
 243                         }
 244
 245                         # Comma
 246                         $blockText .= ',';
 247
 248                         # Add comments, if there is any
 249                         if( array_key_exists( $key, $messageComments ) ) {
 250                                 $blockText .= $messageComments[$key];
 251                         }
 252
 253                         # Newline
 254                         $blockText .= "
 255 ";
 256                 }
 257
 258                 # Newline to end the block
 259                 $blockText .= "
 260 ";
 261
 262                 return $blockText;
 263         }
 264 }