maintenance/generateJsonI18n.php

   1 <?php
   2
   3 /**
   4  * Convert a PHP messages file to a set of JSON messages files.
   5  *
   6  * Usage:
   7  *    php generateJsonI18n.php ExtensionName.i18n.php i18n/
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @ingroup Maintenance
  26  */
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 /**
  31  * Maintenance script to generate JSON i18n files from a PHP i18n file.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class GenerateJsonI18n extends Maintenance {
  36         public function __construct() {
  37                 parent::__construct();
  38                 $this->mDescription = "Build JSON messages files from a PHP messages file";
  39                 $this->addArg( 'phpfile', 'PHP file defining a $messages array', true );
  40                 $this->addArg( 'jsondir', 'Directory to write JSON files to. ' .
  41                         'Required unless <phpfile> exists and --shim-only is specified', false );
  42                 $this->addOption( 'langcode', 'Language code; only needed for converting core i18n files',
  43                         false, true );
  44                 $this->addOption( 'shim-only', 'Only create or update the backward-compatibility shim' );
  45         }
  46
  47         public function execute() {
  48                 $phpfile = $this->getArg( 0 );
  49                 $jsondir = $this->getArg( 1 );
  50
  51                 if ( $this->hasOption( 'shim-only' ) ) {
  52                         $this->shimOnly( $phpfile, $jsondir );
  53                         return;
  54                 }
  55
  56                 if ( $jsondir === null ) {
  57                         $this->error( 'Argument [jsondir] is required unless --shim-only is specified.' );
  58                         $this->maybeHelp( true );
  59                 }
  60
  61                 if ( !is_readable( $phpfile ) ) {
  62                         $this->error( "Error reading $phpfile\n", 1 );
  63                 }
  64                 include $phpfile;
  65                 $phpfileContents = file_get_contents( $phpfile );
  66
  67                 if ( !isset( $messages ) ) {
  68                         $this->error( "PHP file $phpfile does not define \$messages array\n", 1 );
  69                 }
  70
  71                 $extensionStyle = true;
  72                 if ( !isset( $messages['en'] ) || !is_array( $messages['en'] ) ) {
  73                         if ( !$this->hasOption( 'langcode' ) ) {
  74                                 $this->error( "PHP file $phpfile does not set language codes, --langcode " .
  75                                         "is required.\n", 1 );
  76                         }
  77                         $extensionStyle = false;
  78                         $langcode = $this->getOption( 'langcode' );
  79                         $messages = array( $langcode => $messages );
  80                 } elseif ( $this->hasOption( 'langcode' ) ) {
  81                         $this->output( "Warning: --langcode option set but will not be used.\n" );
  82                 }
  83
  84                 foreach ( $messages as $langcode => $langmsgs ) {
  85                         $authors = $this->getAuthorsFromComment( $this->findCommentBefore(
  86                                 $extensionStyle ? "\$messages['$langcode'] =" : '$messages =',
  87                                 $phpfileContents
  88                         ) );
  89                         // Make sure the @metadata key is the first key in the output
  90                         $langmsgs = array_merge(
  91                                 array( '@metadata' => array( 'authors' => $authors ) ),
  92                                 $langmsgs
  93                         );
  94
  95                         $jsonfile = "$jsondir/$langcode.json";
  96                         $success = file_put_contents(
  97                                 $jsonfile,
  98                                 FormatJson::encode( $langmsgs, "\t", FormatJson::ALL_OK ) . "\n"
  99                         );
 100                         if ( $success === false ) {
 101                                 $this->error( "FAILED to write $jsonfile", 1 );
 102                         }
 103                         $this->output( "$jsonfile\n" );
 104                 }
 105
 106                 if ( !$this->hasOption( 'langcode' ) ) {
 107                         $shim = $this->doShim( $jsondir );
 108                         file_put_contents( $phpfile, $shim );
 109                 }
 110
 111                 $this->output( "All done.\n" );
 112                 $this->output( "Also add \$wgMessagesDirs['YourExtension'] = __DIR__ . '/i18n';\n" );
 113         }
 114
 115         protected function shimOnly( $phpfile, $jsondir ) {
 116                 if ( file_exists( $phpfile ) ) {
 117                         if ( !is_readable( $phpfile ) ) {
 118                                 $this->error( "Error reading $phpfile\n", 1 );
 119                         }
 120
 121                         $phpfileContents = file_get_contents( $phpfile );
 122                         $m = array();
 123                         if ( !preg_match( '!"/([^"$]+)/\$csCode.json";!', $phpfileContents, $m ) ) {
 124                                 $this->error( "Cannot recognize $phpfile as a shim.\n", 1 );
 125                         }
 126
 127                         if ( $jsondir === null ) {
 128                                 $jsondir = $m[1];
 129                         }
 130
 131                         $this->output( "Updating existing shim $phpfile\n" );
 132                 } elseif ( $jsondir === null ) {
 133                         $this->error( "$phpfile does not exist.\n" .
 134                                 "Argument [jsondir] is required in order to create a new shim.\n", 1 );
 135                 } else {
 136                         $this->output( "Creating new shim $phpfile\n" );
 137                 }
 138
 139                 $shim = $this->doShim( $jsondir );
 140                 file_put_contents( $phpfile, $shim );
 141                 $this->output( "All done.\n" );
 142         }
 143
 144         protected function doShim( $jsondir ) {
 145                 $shim = <<<'PHP'
 146 <?php
 147 /**
 148  * This is a backwards-compatibility shim, generated by:
 149  * https://git.wikimedia.org/blob/mediawiki%2Fcore.git/HEAD/maintenance%2FgenerateJsonI18n.php
 150  *
 151  * Beginning with MediaWiki 1.23, translation strings are stored in json files,
 152  * and the EXTENSION.i18n.php file only exists to provide compatibility with
 153  * older releases of MediaWiki. For more information about this migration, see:
 154  * https://www.mediawiki.org/wiki/Requests_for_comment/Localisation_format
 155  *
 156  * This shim maintains compatibility back to MediaWiki 1.17.
 157  */
 158 $messages = array();
 159 if ( !function_exists( '{{FUNC}}' ) ) {
 160         function {{FUNC}}( $cache, $code, &$cachedData ) {
 161                 $codeSequence = array_merge( array( $code ), $cachedData['fallbackSequence'] );
 162                 foreach ( $codeSequence as $csCode ) {
 163                         $fileName = dirname( __FILE__ ) . "/{{OUT}}/$csCode.json";
 164                         if ( is_readable( $fileName ) ) {
 165                                 $data = FormatJson::decode( file_get_contents( $fileName ), true );
 166                                 foreach ( array_keys( $data ) as $key ) {
 167                                         if ( $key === '' || $key[0] === '@' ) {
 168                                                 unset( $data[$key] );
 169                                         }
 170                                 }
 171                                 $cachedData['messages'] = array_merge( $data, $cachedData['messages'] );
 172                         }
 173
 174                         $cachedData['deps'][] = new FileDependency( $fileName );
 175                 }
 176                 return true;
 177         }
 178
 179         $GLOBALS['wgHooks']['LocalisationCacheRecache'][] = '{{FUNC}}';
 180 }
 181
 182 PHP;
 183
 184                 $jsondir = str_replace( '\\', '/', $jsondir );
 185                 $shim = str_replace( '{{OUT}}', $jsondir, $shim );
 186                 $shim = str_replace( '{{FUNC}}', 'wfJsonI18nShim' . wfRandomString( 16 ), $shim );
 187                 return $shim;
 188         }
 189
 190         /**
 191          * Find the documentation comment immediately before a given search string
 192          * @param string $needle String to search for
 193          * @param string $haystack String to search in
 194          * @return string Substring of $haystack starting at '/**' ending right before $needle, or empty
 195          */
 196         protected function findCommentBefore( $needle, $haystack ) {
 197                 $needlePos = strpos( $haystack, $needle );
 198                 if ( $needlePos === false ) {
 199                         return '';
 200                 }
 201                 // Need to pass a negative offset to strrpos() so it'll search backwards from the
 202                 // offset
 203                 $startPos = strrpos( $haystack, '/**', $needlePos - strlen( $haystack ) );
 204                 if ( $startPos === false ) {
 205                         return '';
 206                 }
 207
 208                 return substr( $haystack, $startPos, $needlePos - $startPos );
 209         }
 210
 211         /**
 212          * Get an array of author names from a documentation comment containing @author declarations.
 213          * @param string $comment Documentation comment
 214          * @return array Array of author names (strings)
 215          */
 216         protected function getAuthorsFromComment( $comment ) {
 217                 $matches = null;
 218                 preg_match_all( '/@author (.*?)$/m', $comment, $matches );
 219                 return $matches && $matches[1] ? $matches[1] : array();
 220         }
 221 }
 222
 223 $maintClass = "GenerateJsonI18n";
 224 require_once RUN_MAINTENANCE_IF_MAIN;