32require_once __DIR__ .
'/Maintenance.php';
42 parent::__construct();
43 $this->
addDescription(
'Build JSON messages files from a PHP messages file' );
45 $this->
addArg(
'phpfile',
'PHP file defining a $messages array',
false );
46 $this->
addArg(
'jsondir',
'Directory to write JSON files to',
false );
47 $this->
addOption(
'extension',
'Perform default conversion on an extension',
49 $this->
addOption(
'supplementary',
'Find supplementary i18n files in subdirs and convert those',
56 $phpfile = $this->
getArg( 0 );
57 $jsondir = $this->
getArg( 1 );
58 $extension = $this->
getOption(
'extension' );
59 $convertSupplementaryI18nFiles = $this->
hasOption(
'supplementary' );
63 $this->
fatalError(
"The phpfile is already specified, conflicts with --extension." );
65 $phpfile =
"$IP/extensions/$extension/$extension.i18n.php";
69 $this->
error(
"I'm here for an argument!" );
74 if ( $convertSupplementaryI18nFiles ) {
75 if ( is_readable( $phpfile ) ) {
81 $this->
error(
"Warning: no primary i18n file was found." );
83 $this->
output(
"Searching for supplementary i18n files...\n" );
84 $dir_iterator =
new RecursiveDirectoryIterator( dirname( $phpfile ) );
85 $iterator =
new RecursiveIteratorIterator(
86 $dir_iterator, RecursiveIteratorIterator::LEAVES_ONLY );
88 foreach ( $iterator as
$path => $fileObject ) {
89 if ( fnmatch(
"*.i18n.php", $fileObject->getFilename() ) ) {
90 $this->
output(
"Converting $path.\n" );
104 $jsondir = dirname( $phpfile ) .
"/i18n";
106 if ( !is_dir( $jsondir ) ) {
107 $this->
output(
"Creating directory $jsondir.\n" );
110 $this->
fatalError(
"Could not create directory $jsondir" );
114 if ( !is_readable( $phpfile ) ) {
115 $this->
fatalError(
"Error reading $phpfile" );
119 $phpfileContents = file_get_contents( $phpfile );
122 if ( !isset( $messages ) ) {
123 $this->
fatalError(
"PHP file $phpfile does not define \$messages array" );
127 $this->
fatalError(
"PHP file $phpfile contains an empty \$messages array. " .
128 "Maybe it was already converted?" );
131 if ( !isset( $messages[
'en'] ) || !is_array( $messages[
'en'] ) ) {
132 $this->
fatalError(
"PHP file $phpfile does not set language codes" );
135 foreach ( $messages as $langcode => $langmsgs ) {
137 "\$messages['$langcode'] =",
141 $langmsgs = array_merge(
142 [
'@metadata' => [
'authors' => $authors ] ],
146 $jsonfile =
"$jsondir/$langcode.json";
149 FormatJson::encode( $langmsgs,
"\t", FormatJson::ALL_OK ) .
"\n"
152 $this->
fatalError(
"FAILED to write $jsonfile" );
154 $this->
output(
"$jsonfile\n" );
158 "All done. To complete the conversion, please do the following:\n" .
159 "* Add \$wgMessagesDirs['YourExtension'] = __DIR__ . '/i18n';\n" .
160 "* Remove \$wgExtensionMessagesFiles['YourExtension']\n" .
161 "* Delete the old PHP message file\n" .
162 "This script no longer generates backward compatibility shims! If you need\n" .
163 "compatibility with MediaWiki 1.22 and older, use the MediaWiki 1.23 version\n" .
164 "of this script instead, or create a shim manually.\n"
175 $needlePos = strpos( $haystack, $needle );
176 if ( $needlePos ===
false ) {
181 $startPos = strrpos( $haystack,
'
194 protected function getAuthorsFromComment( $comment ) {
195 return preg_match_all( '/@author (.*?)$/m
', $comment, $matches ) ? $matches[1] : [];
199// @codeCoverageIgnoreStart
200$maintClass = GenerateJsonI18n::class;
201require_once RUN_MAINTENANCE_IF_MAIN;
202// @codeCoverageIgnoreEnd
if(!defined( 'MEDIAWIKI')) if(ini_get('mbstring.func_overload')) if(!defined( 'MW_ENTRY_POINT')) global $IP
Environment checks.
Maintenance script to generate JSON i18n files from a PHP i18n file.
__construct()
Default constructor.
getAuthorsFromComment( $comment)
Get an array of author names from a documentation comment containing.
transformI18nFile( $phpfile, $jsondir=null)
findCommentBefore( $needle, $haystack)
Find the documentation comment immediately before a given search string.
execute()
Do the actual work.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
addArg( $arg, $description, $required=true, $multi=false)
Add some args that are needed.
getArg( $argId=0, $default=null)
Get an argument.
output( $out, $channel=null)
Throw some output to the user.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
hasOption( $name)
Checks to see if a particular option was set.
getOption( $name, $default=null)
Get an option, or return the default.
error( $err, $die=0)
Throw an error to the user.
maybeHelp( $force=false)
Maybe show the help.
addDescription( $text)
Set the description text.