/maintenance/generateJsonI18n.php
PHP | 286 lines | 230 code | 14 blank | 42 comment | 6 complexity | 070dce004fe18846d0b673039161600c MD5 | raw file
Possible License(s): Apache-2.0, MIT, GPL-2.0
- <?php
- /**
- * Convert a PHP messages file to a set of JSON messages files.
- *
- * Usage:
- * php generateJsonI18n.php ExtensionName.i18n.php i18n/
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Maintenance
- */
- require_once __DIR__ . '/Maintenance.php';
- /**
- * Maintenance script to generate JSON i18n files from a PHP i18n file.
- *
- * @ingroup Maintenance
- */
- class GenerateJsonI18n extends Maintenance {
- 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', false );
- $this->addArg( 'jsondir', 'Directory to write JSON files to', false );
- $this->addOption( 'langcode', 'Language code; only needed for converting core i18n files',
- false, true );
- $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 ( $extension ) {
- if ( $phpfile ) {
- $this->error( "The phpfile is already specified, conflicts with --extension.\n", 1 );
- }
- $phpfile = "$IP/extensions/$extension/$extension.i18n.php";
- }
- if ( !$phpfile ) {
- $this->error( "I'm here for an argument!\n" );
- $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\n", 1 );
- }
- }
- if ( $this->hasOption( 'shim-only' ) ) {
- $this->shimOnly( $phpfile, $jsondir );
- return;
- }
- if ( $jsondir === null ) {
- $this->error( 'Argument [jsondir] is required unless --shim-only is specified.' );
- $this->maybeHelp( true );
- }
- if ( !is_readable( $phpfile ) ) {
- $this->error( "Error reading $phpfile\n", 1 );
- }
- include $phpfile;
- $phpfileContents = file_get_contents( $phpfile );
- if ( !isset( $messages ) ) {
- $this->error( "PHP file $phpfile does not define \$messages array\n", 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" );
- }
- foreach ( $messages as $langcode => $langmsgs ) {
- $authors = $this->getAuthorsFromComment( $this->findCommentBefore(
- $extensionStyle ? "\$messages['$langcode'] =" : '$messages =',
- $phpfileContents
- ) );
- // Make sure the @metadata key is the first key in the output
- $langmsgs = array_merge(
- array( '@metadata' => array( 'authors' => $authors ) ),
- $langmsgs
- );
- $jsonfile = "$jsondir/$langcode.json";
- $success = file_put_contents(
- $jsonfile,
- FormatJson::encode( $langmsgs, "\t", FormatJson::ALL_OK ) . "\n"
- );
- if ( $success === false ) {
- $this->error( "FAILED to write $jsonfile", 1 );
- }
- $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;
- }
- /**
- * Find the documentation comment immediately before a given search string
- * @param string $needle String to search for
- * @param string $haystack String to search in
- * @return string Substring of $haystack starting at '/**' ending right before $needle, or empty
- */
- protected function findCommentBefore( $needle, $haystack ) {
- $needlePos = strpos( $haystack, $needle );
- if ( $needlePos === false ) {
- return '';
- }
- // Need to pass a negative offset to strrpos() so it'll search backwards from the
- // offset
- $startPos = strrpos( $haystack, '/**', $needlePos - strlen( $haystack ) );
- if ( $startPos === false ) {
- return '';
- }
- return substr( $haystack, $startPos, $needlePos - $startPos );
- }
- /**
- * Get an array of author names from a documentation comment containing @author declarations.
- * @param string $comment Documentation comment
- * @return array Array of author names (strings)
- */
- protected function getAuthorsFromComment( $comment ) {
- $matches = null;
- preg_match_all( '/@author (.*?)$/m', $comment, $matches );
- return $matches && $matches[1] ? $matches[1] : array();
- }
- }
- $maintClass = "GenerateJsonI18n";
- require_once RUN_MAINTENANCE_IF_MAIN;