public function __construct() {
parent::__construct();
$this->mDescription = "Build JSON messages files from a PHP messages file";
- $this->addArg( 'phpfile', 'PHP file defining a $messages array', true );
- $this->addArg( 'jsondir', 'Directory to write JSON files to. ' .
- 'Required unless <phpfile> exists and --shim-only is specified', false );
- $this->addOption( 'langcode', 'Language code; only needed for converting core i18n files',
+
+ $this->addArg( 'phpfile', 'PHP file defining a $messages array', false );
+ $this->addArg( 'jsondir', 'Directory to write JSON files to', false );
+ $this->addOption( 'extension', 'Perform default conversion on an extension',
false, true );
- $this->addOption( 'shim-only', 'Only create or update the backward-compatibility shim' );
+ $this->addOption( 'supplementary', 'Find supplementary i18n files in subdirs and convert those',
+ false, false );
}
public function execute() {
+ global $IP;
+
$phpfile = $this->getArg( 0 );
$jsondir = $this->getArg( 1 );
+ $extension = $this->getOption( 'extension' );
+ $convertSupplementaryI18nFiles = $this->hasOption( 'supplementary' );
- if ( $this->hasOption( 'shim-only' ) ) {
- $this->shimOnly( $phpfile, $jsondir );
- return;
+ if ( $extension ) {
+ if ( $phpfile ) {
+ $this->error( "The phpfile is already specified, conflicts with --extension.", 1 );
+ }
+ $phpfile = "$IP/extensions/$extension/$extension.i18n.php";
}
- if ( $jsondir === null ) {
- $this->error( 'Argument [jsondir] is required unless --shim-only is specified.' );
+ if ( !$phpfile ) {
+ $this->error( "I'm here for an argument!" );
$this->maybeHelp( true );
+ // dies.
+ }
+
+ if ( $convertSupplementaryI18nFiles ) {
+ if ( is_readable( $phpfile ) ) {
+ $this->transformI18nFile( $phpfile, $jsondir );
+ } else {
+ // This is non-fatal because we might want to continue searching for
+ // i18n files in subdirs even if the extension does not include a
+ // primary i18n.php.
+ $this->error( "Warning: no primary i18n file was found." );
+ }
+ $this->output( "Searching for supplementary i18n files...\n" );
+ $dir_iterator = new RecursiveDirectoryIterator( dirname( $phpfile ) );
+ $iterator = new RecursiveIteratorIterator(
+ $dir_iterator, RecursiveIteratorIterator::LEAVES_ONLY );
+ foreach ( $iterator as $path => $fileObject ) {
+ if ( fnmatch( "*.i18n.php", $fileObject->getFilename() ) ) {
+ $this->output( "Converting $path.\n" );
+ $this->transformI18nFile( $path );
+ }
+ }
+ } else {
+ // Just convert the primary i18n file.
+ $this->transformI18nFile( $phpfile, $jsondir );
+ }
+ }
+
+ public function transformI18nFile( $phpfile, $jsondir = null ) {
+ if ( !$jsondir ) {
+ // Assume the json directory should be in the same directory as the
+ // .i18n.php file.
+ $jsondir = dirname( $phpfile ) . "/i18n";
+ }
+ if ( !is_dir( $jsondir ) ) {
+ $this->output( "Creating directory $jsondir.\n" );
+ $success = mkdir( $jsondir );
+ if ( !$success ) {
+ $this->error( "Could not create directory $jsondir", 1 );
+ }
}
if ( !is_readable( $phpfile ) ) {
- $this->error( "Error reading $phpfile\n", 1 );
+ $this->error( "Error reading $phpfile", 1 );
}
include $phpfile;
$phpfileContents = file_get_contents( $phpfile );
if ( !isset( $messages ) ) {
- $this->error( "PHP file $phpfile does not define \$messages array\n", 1 );
+ $this->error( "PHP file $phpfile does not define \$messages array", 1 );
+ }
+
+ if ( !$messages ) {
+ $this->error( "PHP file $phpfile contains an empty \$messages array. " .
+ "Maybe it was already converted?", 1 );
}
- $extensionStyle = true;
if ( !isset( $messages['en'] ) || !is_array( $messages['en'] ) ) {
- if ( !$this->hasOption( 'langcode' ) ) {
- $this->error( "PHP file $phpfile does not set language codes, --langcode " .
- "is required.\n", 1 );
- }
- $extensionStyle = false;
- $langcode = $this->getOption( 'langcode' );
- $messages = array( $langcode => $messages );
- } elseif ( $this->hasOption( 'langcode' ) ) {
- $this->output( "Warning: --langcode option set but will not be used.\n" );
+ $this->error( "PHP file $phpfile does not set language codes", 1 );
}
foreach ( $messages as $langcode => $langmsgs ) {
$authors = $this->getAuthorsFromComment( $this->findCommentBefore(
- $extensionStyle ? "\$messages['$langcode'] =" : '$messages =',
+ "\$messages['$langcode'] =",
$phpfileContents
) );
// Make sure the @metadata key is the first key in the output
$this->output( "$jsonfile\n" );
}
- if ( !$this->hasOption( 'langcode' ) ) {
- $shim = $this->doShim( $jsondir );
- file_put_contents( $phpfile, $shim );
- }
-
- $this->output( "All done.\n" );
- $this->output( "Also add \$wgMessagesDirs['YourExtension'] = __DIR__ . '/i18n';\n" );
- }
-
- protected function shimOnly( $phpfile, $jsondir ) {
- if ( file_exists( $phpfile ) ) {
- if ( !is_readable( $phpfile ) ) {
- $this->error( "Error reading $phpfile\n", 1 );
- }
-
- $phpfileContents = file_get_contents( $phpfile );
- $m = array();
- if ( !preg_match( '!"/([^"$]+)/\$csCode.json";!', $phpfileContents, $m ) ) {
- $this->error( "Cannot recognize $phpfile as a shim.\n", 1 );
- }
-
- if ( $jsondir === null ) {
- $jsondir = $m[1];
- }
-
- $this->output( "Updating existing shim $phpfile\n" );
- } elseif ( $jsondir === null ) {
- $this->error( "$phpfile does not exist.\n" .
- "Argument [jsondir] is required in order to create a new shim.\n", 1 );
- } else {
- $this->output( "Creating new shim $phpfile\n" );
- }
-
- $shim = $this->doShim( $jsondir );
- file_put_contents( $phpfile, $shim );
- $this->output( "All done.\n" );
- }
-
- protected function doShim( $jsondir ) {
- $shim = <<<'PHP'
-<?php
-/**
- * This is a backwards-compatibility shim, generated by:
- * https://git.wikimedia.org/blob/mediawiki%2Fcore.git/HEAD/maintenance%2FgenerateJsonI18n.php
- *
- * Beginning with MediaWiki 1.23, translation strings are stored in json files,
- * and the EXTENSION.i18n.php file only exists to provide compatibility with
- * older releases of MediaWiki. For more information about this migration, see:
- * https://www.mediawiki.org/wiki/Requests_for_comment/Localisation_format
- *
- * This shim maintains compatibility back to MediaWiki 1.17.
- */
-$messages = array();
-if ( !function_exists( '{{FUNC}}' ) ) {
- function {{FUNC}}( $cache, $code, &$cachedData ) {
- $codeSequence = array_merge( array( $code ), $cachedData['fallbackSequence'] );
- foreach ( $codeSequence as $csCode ) {
- $fileName = dirname( __FILE__ ) . "/{{OUT}}/$csCode.json";
- if ( is_readable( $fileName ) ) {
- $data = FormatJson::decode( file_get_contents( $fileName ), true );
- foreach ( array_keys( $data ) as $key ) {
- if ( $key === '' || $key[0] === '@' ) {
- unset( $data[$key] );
- }
- }
- $cachedData['messages'] = array_merge( $data, $cachedData['messages'] );
- }
-
- $cachedData['deps'][] = new FileDependency( $fileName );
- }
- return true;
- }
-
- $GLOBALS['wgHooks']['LocalisationCacheRecache'][] = '{{FUNC}}';
-}
-
-PHP;
-
- $jsondir = str_replace( '\\', '/', $jsondir );
- $shim = str_replace( '{{OUT}}', $jsondir, $shim );
- $shim = str_replace( '{{FUNC}}', 'wfJsonI18nShim' . wfRandomString( 16 ), $shim );
- return $shim;
+ $this->output(
+ "All done. To complete the conversion, please do the following:\n" .
+ "* Add \$wgMessagesDirs['YourExtension'] = __DIR__ . '/i18n';\n" .
+ "* Remove \$wgExtensionMessagesFiles['YourExtension']\n" .
+ "* Delete the old PHP message file\n" .
+ "This script no longer generates backward compatibility shims! If you need\n" .
+ "compatibility with MediaWiki 1.22 and older, use the MediaWiki 1.23 version\n" .
+ "of this script instead, or create a shim manually.\n"
+ );
}
/**
protected function getAuthorsFromComment( $comment ) {
$matches = null;
preg_match_all( '/@author (.*?)$/m', $comment, $matches );
+
return $matches && $matches[1] ? $matches[1] : array();
}
}
dépôts / lhc / web / wiklou.git / blobdiff